TanTan
2a69b23b47
Dev Build / cleanup (push) Canceled after 0s
Dev Build / typecheck (push) Canceled after 0s
Dev Build / build (linux-arm64, ubuntu-24.04-arm, linux-arm64) (push) Canceled after 0s
Dev Build / build (linux-x64, ubuntu-latest, linux-x64) (push) Canceled after 0s
Dev Build / build (win-x64, windows-latest, win32-x64) (push) Canceled after 0s
Dev Build / dispatch-dev-docker (push) Canceled after 0s
84 lines
3.6 KiB
Plaintext
84 lines
3.6 KiB
Plaintext
/**
|
|
* Cryptographic key import functions
|
|
*
|
|
* @module
|
|
*/
|
|
import type * as types from '../types.d.ts';
|
|
/** Key Import Function options. */
|
|
export interface KeyImportOptions {
|
|
/**
|
|
* The value to use as {@link !SubtleCrypto.importKey} `extractable` argument. Default is false for
|
|
* private keys, true otherwise.
|
|
*/
|
|
extractable?: boolean;
|
|
}
|
|
/**
|
|
* Imports a PEM-encoded SPKI string as a {@link !CryptoKey}.
|
|
*
|
|
* > [!NOTE]\
|
|
* > The OID id-RSASSA-PSS (1.2.840.113549.1.1.10) is not supported in
|
|
* > {@link https://w3c.github.io/webcrypto/ Web Cryptography API}, use the OID rsaEncryption
|
|
* > (1.2.840.113549.1.1.1) instead for all RSA algorithms.
|
|
*
|
|
* This function is exported (as a named export) from the main `'jose'` module entry point as well
|
|
* as from its subpath export `'jose/key/import'`.
|
|
*
|
|
* @param spki PEM-encoded SPKI string
|
|
* @param alg JSON Web Algorithm identifier to be used with the imported key. See
|
|
* {@link https://github.com/panva/jose/issues/210 Algorithm Key Requirements}.
|
|
*/
|
|
export declare function importSPKI(spki: string, alg: string, options?: KeyImportOptions): Promise<types.CryptoKey>;
|
|
/**
|
|
* Imports the SPKI from an X.509 string certificate as a {@link !CryptoKey}.
|
|
*
|
|
* > [!NOTE]\
|
|
* > The OID id-RSASSA-PSS (1.2.840.113549.1.1.10) is not supported in
|
|
* > {@link https://w3c.github.io/webcrypto/ Web Cryptography API}, use the OID rsaEncryption
|
|
* > (1.2.840.113549.1.1.1) instead for all RSA algorithms.
|
|
*
|
|
* This function is exported (as a named export) from the main `'jose'` module entry point as well
|
|
* as from its subpath export `'jose/key/import'`.
|
|
*
|
|
* @param x509 X.509 certificate string
|
|
* @param alg JSON Web Algorithm identifier to be used with the imported key. See
|
|
* {@link https://github.com/panva/jose/issues/210 Algorithm Key Requirements}.
|
|
*/
|
|
export declare function importX509(x509: string, alg: string, options?: KeyImportOptions): Promise<types.CryptoKey>;
|
|
/**
|
|
* Imports a PEM-encoded PKCS#8 string as a {@link !CryptoKey}.
|
|
*
|
|
* > [!NOTE]\
|
|
* > The OID id-RSASSA-PSS (1.2.840.113549.1.1.10) is not supported in
|
|
* > {@link https://w3c.github.io/webcrypto/ Web Cryptography API}, use the OID rsaEncryption
|
|
* > (1.2.840.113549.1.1.1) instead for all RSA algorithms.
|
|
*
|
|
* This function is exported (as a named export) from the main `'jose'` module entry point as well
|
|
* as from its subpath export `'jose/key/import'`.
|
|
*
|
|
* @param pkcs8 PEM-encoded PKCS#8 string
|
|
* @param alg JSON Web Algorithm identifier to be used with the imported key. See
|
|
* {@link https://github.com/panva/jose/issues/210 Algorithm Key Requirements}.
|
|
*/
|
|
export declare function importPKCS8(pkcs8: string, alg: string, options?: KeyImportOptions): Promise<types.CryptoKey>;
|
|
/**
|
|
* Imports a JWK to a {@link !CryptoKey}. Either the JWK "alg" (Algorithm) Parameter, or the optional
|
|
* "alg" argument, must be present for asymmetric JSON Web Key imports.
|
|
*
|
|
* > [!NOTE]\
|
|
* > The JSON Web Key parameters "use", "key_ops", and "ext" are also used in the {@link !CryptoKey}
|
|
* > import process.
|
|
*
|
|
* > [!NOTE]\
|
|
* > Symmetric JSON Web Keys (i.e. `kty: "oct"`) yield back an {@link !Uint8Array} instead of a
|
|
* > {@link !CryptoKey}.
|
|
*
|
|
* This function is exported (as a named export) from the main `'jose'` module entry point as well
|
|
* as from its subpath export `'jose/key/import'`.
|
|
*
|
|
* @param jwk JSON Web Key.
|
|
* @param alg JSON Web Algorithm identifier to be used with the imported key. Default is the "alg"
|
|
* property on the JWK. See
|
|
* {@link https://github.com/panva/jose/issues/210 Algorithm Key Requirements}.
|
|
*/
|
|
export declare function importJWK(jwk: types.JWK, alg?: string, options?: KeyImportOptions): Promise<types.CryptoKey | Uint8Array>;
|