jose 3.17.0 → 3.20.1

package/dist/types/jwt/sign.d.ts

@@ -1,9 +1,9 @@
 import type { JWSHeaderParameters, JWTPayload, KeyLike, SignOptions } from '../types';
-import ProduceJWT from '../lib/jwt_producer';
+import { ProduceJWT } from './produce';
 declare class SignJWT extends ProduceJWT {
     private _protectedHeader;
     setProtectedHeader(protectedHeader: JWSHeaderParameters): this;
-    sign(key: KeyLike, options?: SignOptions): Promise<string>;
+    sign(key: KeyLike | Uint8Array, options?: SignOptions): Promise<string>;
 }
 export { SignJWT };
 export default SignJWT;

package/dist/types/jwt/unsecured.d.ts

@@ -1,5 +1,5 @@
 import type { JWSHeaderParameters, JWTClaimVerificationOptions, JWTPayload } from '../types';
-import ProduceJWT from '../lib/jwt_producer';
+import { ProduceJWT } from './produce';
 interface UnsecuredResult {
     payload: JWTPayload;
     header: JWSHeaderParameters;

package/dist/types/jwt/verify.d.ts

@@ -1,9 +1,10 @@
-import type { KeyLike, VerifyOptions, JWTPayload, JWTClaimVerificationOptions, JWSHeaderParameters, GetKeyFunction, FlattenedJWSInput, JWTVerifyResult } from '../types';
+import type { KeyLike, VerifyOptions, JWTPayload, JWTClaimVerificationOptions, JWSHeaderParameters, GetKeyFunction, FlattenedJWSInput, JWTVerifyResult, ResolvedKey } from '../types';
 interface JWTVerifyOptions extends VerifyOptions, JWTClaimVerificationOptions {
 }
 export interface JWTVerifyGetKey extends GetKeyFunction<JWSHeaderParameters, FlattenedJWSInput> {
 }
-declare function jwtVerify(jwt: string | Uint8Array, key: KeyLike | JWTVerifyGetKey, options?: JWTVerifyOptions): Promise<JWTVerifyResult>;
+declare function jwtVerify(jwt: string | Uint8Array, key: KeyLike | Uint8Array, options?: JWTVerifyOptions): Promise<JWTVerifyResult>;
+declare function jwtVerify(jwt: string | Uint8Array, getKey: JWTVerifyGetKey, options?: JWTVerifyOptions): Promise<JWTVerifyResult & ResolvedKey>;
 export { jwtVerify };
 export default jwtVerify;
 export type { KeyLike, JWTPayload, JWTVerifyOptions, JWSHeaderParameters, GetKeyFunction, JWTVerifyResult, };

package/dist/types/key/export.d.ts

@@ -0,0 +1,5 @@
+import type { JWK, KeyLike } from '../types';
+export declare function exportSPKI(key: KeyLike): Promise<string>;
+export declare function exportPKCS8(key: KeyLike): Promise<string>;
+export declare function exportJWK(key: KeyLike | Uint8Array): Promise<JWK>;
+export type { KeyLike, JWK };

package/dist/types/key/import.d.ts

@@ -0,0 +1,9 @@
+import type { JWK, KeyLike } from '../types';
+export interface PEMImportOptions {
+    extractable?: boolean;
+}
+export declare function importSPKI(spki: string, alg: string, options?: PEMImportOptions): Promise<KeyLike>;
+export declare function importX509(x509: string, alg: string, options?: PEMImportOptions): Promise<KeyLike>;
+export declare function importPKCS8(pkcs8: string, alg: string, options?: PEMImportOptions): Promise<KeyLike>;
+export declare function importJWK(jwk: JWK, alg?: string, octAsKeyObject?: boolean): Promise<KeyLike | Uint8Array>;
+export type { KeyLike, JWK };

package/dist/types/types.d.ts

@@ -1,7 +1,100 @@
-/// <reference lib="dom"/>
-import type { KeyObject } from 'crypto'
-export type { KeyObject }
-export type KeyLike = KeyObject | CryptoKey | Uint8Array
+/**
+ * KeyLike are runtime-specific classes representing asymmetric keys or symmetric secrets.
+ * These are instances of
+ * [CryptoKey](https://developer.mozilla.org/en-US/docs/Web/API/CryptoKey) and additionally
+ * [KeyObject](https://nodejs.org/api/crypto.html#crypto_class_keyobject)
+ * in Node.js runtime.
+ * [Uint8Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
+ * instances are also accepted as symmetric secret representation only.
+ *
+ * [jose/key/import](../modules/key_import.md#readme) functions can be used to import PEM,
+ * or JWK formatted asymmetric keys and certificates to these runtime-specific representations.
+ *
+ * In Node.js the
+ * [Buffer](https://nodejs.org/api/buffer.html#buffer_buffer) class is a subclass of Uint8Array
+ * and so Buffer can be provided for symmetric secrets as well.
+ *
+ * ---
+ *
+ * [KeyObject](https://nodejs.org/api/crypto.html#crypto_class_keyobject) is a representation of a
+ * key/secret available in the Node.js runtime.
+ * In addition to the import functions of this library you may use the
+ * runtime APIs
+ * [crypto.createPublicKey](https://nodejs.org/api/crypto.html#crypto_crypto_createpublickey_key),
+ * [crypto.createPrivateKey](https://nodejs.org/api/crypto.html#crypto_crypto_createprivatekey_key), and
+ * [crypto.createSecretKey](https://nodejs.org/api/crypto.html#crypto_crypto_createsecretkey_key_encoding)
+ * to obtain a KeyObject from your existing key material.
+ *
+ * [CryptoKey](https://developer.mozilla.org/en-US/docs/Web/API/CryptoKey) is a representation of a
+ * key/secret available in the Browser and Deno runtimes.
+ * In addition to the import functions of this library you may use the
+ * [SubtleCrypto.importKey](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey) API
+ * to obtain a CryptoKey from your existing key material.
+ *
+ * ---
+ *
+ * @example Import a PEM-encoded SPKI Public Key
+ * ```js
+ * import { importSPKI } from 'jose/key/import'
+ *
+ * const algorithm = 'ES256'
+ * const spki = `-----BEGIN PUBLIC KEY-----
+ * MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEFlHHWfLk0gLBbsLTcuCrbCqoHqmM
+ * YJepMC+Q+Dd6RBmBiA41evUsNMwLeN+PNFqib+xwi9JkJ8qhZkq8Y/IzGg==
+ * -----END PUBLIC KEY-----`
+ * const ecPublicKey = await importSPKI(spki, algorithm)
+ * ```
+ *
+ * @example Import a X.509 Certificate
+ * ```js
+ * import { importX509 } from 'jose/key/import'
+ *
+ * const algorithm = 'ES256'
+ * const x509 = `-----BEGIN CERTIFICATE-----
+ * MIIBXjCCAQSgAwIBAgIGAXvykuMKMAoGCCqGSM49BAMCMDYxNDAyBgNVBAMMK3Np
+ * QXBNOXpBdk1VaXhXVWVGaGtjZXg1NjJRRzFyQUhXaV96UlFQTVpQaG8wHhcNMjEw
+ * OTE3MDcwNTE3WhcNMjIwNzE0MDcwNTE3WjA2MTQwMgYDVQQDDCtzaUFwTTl6QXZN
+ * VWl4V1VlRmhrY2V4NTYyUUcxckFIV2lfelJRUE1aUGhvMFkwEwYHKoZIzj0CAQYI
+ * KoZIzj0DAQcDQgAE8PbPvCv5D5xBFHEZlBp/q5OEUymq7RIgWIi7tkl9aGSpYE35
+ * UH+kBKDnphJO3odpPZ5gvgKs2nwRWcrDnUjYLDAKBggqhkjOPQQDAgNIADBFAiEA
+ * 1yyMTRe66MhEXID9+uVub7woMkNYd0LhSHwKSPMUUTkCIFQGsfm1ecXOpeGOufAh
+ * v+A1QWZMuTWqYt+uh/YSRNDn
+ * -----END CERTIFICATE-----`
+ * const ecPublicKey = await importX509(x509, algorithm)
+ * ```
+ *
+ * @example Import a PEM-encoded PKCS8 Private Key
+ * ```js
+ * import { importPKCS8 } from 'jose/key/import'
+ *
+ * const algorithm = 'ES256'
+ * const pkcs8 = `-----BEGIN PRIVATE KEY-----
+ * MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgiyvo0X+VQ0yIrOaN
+ * nlrnUclopnvuuMfoc8HHly3505OhRANCAAQWUcdZ8uTSAsFuwtNy4KtsKqgeqYxg
+ * l6kwL5D4N3pEGYGIDjV69Sw0zAt43480WqJv7HCL0mQnyqFmSrxj8jMa
+ * -----END PRIVATE KEY-----`
+ * const ecPrivateKey = await importPKCS8(pkcs8, algorithm)
+ * ```
+ *
+ * @example Import a JSON Web Key (JWK)
+ * ```js
+ * import { importJWK } from 'jose/key/import'
+ *
+ * const ecPublicKey = await importJWK({
+ *   crv: 'P-256',
+ *   kty: 'EC',
+ *   x: 'ySK38C1jBdLwDsNWKzzBHqKYEE5Cgv-qjWvorUXk9fw',
+ *   y: '_LeQBw07cf5t57Iavn4j-BqJsAD1dpoz8gokd3sBsOo'
+ * }, 'ES256')
+ *
+ * const rsaPublicKey = await importJWK({
+ *   kty: 'RSA',
+ *   e: 'AQAB',
+ *   n: '12oBZRhCiZFJLcPg59LkZZ9mdhSMTKAQZYq32k_ti5SBB6jerkh-WzOMAO664r_qyLkqHUSp3u5SbXtseZEpN3XPWGKSxjsy-1JyEFTdLSYe6f9gfrmxkUF_7DTpq0gn6rntP05g2-wFW50YO7mosfdslfrTJYWHFhJALabAeYirYD7-9kqq9ebfFMF4sRRELbv9oi36As6Q9B3Qb5_C1rAzqfao_PCsf9EPsTZsVVVkA5qoIAr47lo1ipfiBPxUCCNSdvkmDTYgvvRm6ZoMjFbvOtgyts55fXKdMWv7I9HMD5HwE9uW839PWA514qhbcIsXEYSFMPMV6fnlsiZvQQ'
+ * }, 'PS256')
+ * ```
+ */
+export type KeyLike = { type: string }
 export interface JWK {
   alg?: string
   crv?: string
@@ -33,7 +126,7 @@ export interface JWK {
   [propName: string]: unknown
 }
 export interface GetKeyFunction<T, T2> {
-  (protectedHeader: T, token: T2): Promise<KeyLike>
+  (protectedHeader: T, token: T2): Promise<KeyLike | Uint8Array>
 }
 export interface FlattenedJWSInput {
   header?: JWSHeaderParameters
@@ -169,3 +262,6 @@ export interface JWTDecryptResult {
   payload: JWTPayload
   protectedHeader: JWEHeaderParameters
 }
+export interface ResolvedKey {
+  key: KeyLike | Uint8Array
+}

package/dist/types/util/errors.d.ts

@@ -53,6 +53,11 @@ export declare class JWKSMultipleMatchingKeys extends JOSEError {
     code: string;
     message: string;
 }
+export declare class JWKSTimeout extends JOSEError {
+    static code: string;
+    code: string;
+    message: string;
+}
 export declare class JWSSignatureVerificationFailed extends JOSEError {
     static code: string;
     code: string;

package/dist/types/util/generate_key_pair.d.ts

@@ -1,7 +1,7 @@
 import type { KeyLike } from '../types';
 export interface GenerateKeyPairResult {
-    privateKey: Exclude<KeyLike, Uint8Array>;
-    publicKey: Exclude<KeyLike, Uint8Array>;
+    privateKey: KeyLike;
+    publicKey: KeyLike;
 }
 export interface GenerateKeyPairOptions {
     crv?: string;

package/dist/types/util/generate_secret.d.ts

@@ -2,6 +2,6 @@ import type { KeyLike } from '../types';
 export interface GenerateSecretOptions {
     extractable?: boolean;
 }
-declare function generateSecret(alg: string, options?: GenerateSecretOptions): Promise<KeyLike>;
+declare function generateSecret(alg: string, options?: GenerateSecretOptions): Promise<KeyLike | Uint8Array>;
 export { generateSecret };
 export default generateSecret;

package/package.json

@@ -1,16 +1,15 @@
 {
   "name": "jose",
-  "version": "3.17.0",
+  "version": "3.20.1",
   "description": "Universal 'JSON Web Almost Everything' - JWA, JWS, JWE, JWT, JWK with no dependencies",
   "keywords": [
     "browser",
+    "cloudflare",
     "compact",
     "decode",
     "decrypt",
-    "detached",
     "deno",
-    "cloudflare",
-    "workers",
+    "detached",
     "ec",
     "ecdsa",
     "eddsa",
@@ -32,14 +31,19 @@
     "oct",
     "okp",
     "payload",
+    "pem",
+    "pkcs8",
     "rsa",
     "secp256k1",
     "sign",
     "signature",
+    "spki",
     "universal",
     "validate",
     "verify",
-    "webcrypto"
+    "webcrypto",
+    "workers",
+    "x509"
   ],
   "homepage": "https://github.com/panva/jose",
   "repository": "panva/jose",
@@ -155,6 +159,16 @@
       "import": "./dist/node/esm/jwt/verify.js",
       "require": "./dist/node/cjs/jwt/verify.js"
     },
+    "./key/export": {
+      "browser": "./dist/browser/key/export.js",
+      "import": "./dist/node/esm/key/export.js",
+      "require": "./dist/node/cjs/key/export.js"
+    },
+    "./key/import": {
+      "browser": "./dist/browser/key/import.js",
+      "import": "./dist/node/esm/key/import.js",
+      "require": "./dist/node/cjs/key/import.js"
+    },
     "./util/base64url": {
       "browser": "./dist/browser/util/base64url.js",
       "import": "./dist/node/esm/util/base64url.js",
@@ -198,9 +212,7 @@
     "dist/**/*.js",
     "dist/types/**/*.d.ts",
     "!dist/node/webcrypto/**/*",
-    "!dist/types/**/*.i.d.ts",
     "!dist/types/runtime/*",
-    "!dist/types/lib/*",
-    "dist/types/lib/jwt_producer.d.ts"
+    "!dist/types/lib/*"
   ]
 }