@panva/jose@6.0.10

Built and signed on GitHub Actions

Built and signed on GitHub Actions

Base64URL encoding and decoding utilities

Compact JWE decryption result

Recognized Compact JWE Header Parameters, any other Header Members may also be present.

Recognized Compact JWS Header Parameters, any other Header Members may also be present.

Compact JWS verification result

Shared Interface with a "crit" property for all sign, verify, encrypt and decrypt operations.

!CryptoKey is a representation of a key/secret available in all supported runtimes. In addition to the Key Import Functions you may use the !SubtleCrypto.importKey API to obtain a !CryptoKey from your existing key material.

JWE Decryption options.

JWE Encryption options.

JOSE module errors and error codes

Flattened JWE JSON Serialization Syntax decryption result

Flattened JWE JSON Serialization Syntax token.

Flattened JWS JSON Serialization Syntax token. Payload is returned as an empty string when JWS Unencoded Payload (RFC7797) is used.

Flattened JWS definition for verify function inputs, allows payload as !Uint8Array for detached signature validation.

Flattened JWS JSON Serialization Syntax verification result

General JWE JSON Serialization Syntax decryption result

General JWE JSON Serialization Syntax token.

General JWS JSON Serialization Syntax token. Payload is returned as an empty string when JWS Unencoded Payload (RFC7797) is used.

General JWS definition for verify function inputs, allows payload as !Uint8Array for detached signature validation.

General JWS JSON Serialization Syntax verification result

Generic Interface for consuming operations dynamic key resolution.

Header Parameters common to JWE and JWS

JSON Web Key Set

Recognized JWE Header Parameters, any other Header members may also be present.

Recognized JWE Key Management-related Header Parameters.

JSON Web Key (JWK). "RSA", "EC", "OKP", and "oct" key types are supported.

Convenience interface for Private EC JSON Web Keys

Convenience interface for Public EC JSON Web Keys

Convenience interface for oct JSON Web Keys

Convenience interface for Private OKP JSON Web Keys

Convenience interface for Public OKP JSON Web Keys

Convenience interface for Private RSA JSON Web Keys

Convenience interface for Public RSA JSON Web Keys

Generic JSON Web Key Parameters.

Recognized JWS Header Parameters, any other Header Members may also be present.

JWT Claims Set verification options.

Encrypted JSON Web Token (JWT) decryption result

Recognized Signed JWT Header Parameters, any other Header Members may also be present.

Recognized JWT Claims Set members, any other members may also be present.

Signed JSON Web Token (JWT) verification result

!KeyObject is a representation of a key/secret available in the Node.js runtime. You may use the Node.js runtime APIs !createPublicKey, !createPrivateKey, and !createSecretKey to obtain a !KeyObject from your existing key material.

Generic interface for JWT producing classes.

When key resolver functions are used this becomes part of successful resolves

JWS Signing options.

JWS Verification options.

In prior releases this indicated whether a Node.js-specific build was loaded, this is now fixed to "WebCryptoAPI"

Decodes a Base64URL encoded input.

Encodes an input using Base64URL with no padding.

Decodes a Base64URL encoded input.

Encodes an input using Base64URL with no padding.

Decodes the Protected Header of a JWE/JWS/JWT token utilizing any JOSE serialization.

JWE and JWS Header Parameters

An error subclass thrown when a JOSE Algorithm is not allowed per developer preference.

A generic Error that all other JOSE specific Error subclasses extend.

An error subclass thrown when a particular feature or algorithm is not supported by this implementation or JOSE in general.

An error subclass thrown when a JWE ciphertext decryption fails.

An error subclass thrown when a JWE is invalid.

An error subclass thrown when a JWK is invalid.

An error subclass thrown when a JWKS is invalid.

An error subclass thrown when multiple keys match from a JWKS.

An error subclass thrown when no keys match from a JWKS.

Timeout was reached when retrieving the JWKS response.

An error subclass thrown when a JWS is invalid.

An error subclass thrown when JWS signature verification fails.

An error subclass thrown when a JWT Claim Set member validation fails.

An error subclass thrown when a JWT is expired.

An error subclass thrown when a JWT is invalid.

An error subclass thrown when a JOSE Algorithm is not allowed per developer preference.

A generic Error that all other JOSE specific Error subclasses extend.

An error subclass thrown when a particular feature or algorithm is not supported by this implementation or JOSE in general.

An error subclass thrown when a JWE ciphertext decryption fails.

An error subclass thrown when a JWE is invalid.

An error subclass thrown when a JWK is invalid.

An error subclass thrown when a JWKS is invalid.

An error subclass thrown when multiple keys match from a JWKS.

An error subclass thrown when no keys match from a JWKS.

Timeout was reached when retrieving the JWKS response.

An error subclass thrown when a JWS is invalid.

An error subclass thrown when JWS signature verification fails.

An error subclass thrown when a JWT Claim Set member validation fails.

An error subclass thrown when a JWT is expired.

An error subclass thrown when a JWT is invalid.

Decrypts a Compact JWE.

Interface for Compact JWE Decryption dynamic key resolution. No token components have been verified at the time of this function call.

The CompactEncrypt class is used to build and encrypt Compact JWE strings.

Decrypts a Flattened JWE.

Interface for Flattened JWE Decryption dynamic key resolution. No token components have been verified at the time of this function call.

The FlattenedEncrypt class is used to build and encrypt Flattened JWE objects.

Decrypts a General JWE.

Interface for General JWE Decryption dynamic key resolution. No token components have been verified at the time of this function call.

The GeneralEncrypt class is used to build and encrypt General JWE objects.

Used to build General JWE object's individual recipients.

EmbeddedJWK is an implementation of a GetKeyFunction intended to be used with the JWS/JWT verify operations whenever you need to opt-in to verify signatures with a public key embedded in the token's "jwk" (JSON Web Key) Header Parameter. It is recommended to combine this with the verify function's algorithms option to define accepted JWS "alg" (Algorithm) Header Parameter values.

Calculates a base64url-encoded JSON Web Key (JWK) Thumbprint

Calculates a JSON Web Key (JWK) Thumbprint URI

Returns a function that resolves a JWS JOSE Header to a public key object from a locally stored, or otherwise available, JSON Web Key Set.

Returns a function that resolves a JWS JOSE Header to a public key object downloaded from a remote endpoint returning a JSON Web Key Set, that is, for example, an OAuth 2.0 or OIDC jwks_uri. The JSON Web Key Set is fetched when no key matches the selection process but only as frequently as the cooldownDuration option allows to prevent abuse.

When passed to createRemoteJWKSet this allows the resolver to make use of advanced fetch configurations, HTTP Proxies, retry on network errors, etc.

See jwksCache.

See customFetch.

DANGER ZONE - This option has security implications that must be understood, assessed for applicability, and accepted before use. It is critical that the JSON Web Key Set cache only be writable by your own code.

See jwksCache.

Options for the remote JSON Web Key Set.

The CompactSign class is used to build and sign Compact JWS strings.

Verifies the signature and format of and afterwards decodes the Compact JWS.

Interface for Compact JWS Verification dynamic key resolution. No token components have been verified at the time of this function call.

The FlattenedSign class is used to build and sign Flattened JWS objects.

Verifies the signature and format of and afterwards decodes the Flattened JWS.

Interface for Flattened JWS Verification dynamic key resolution. No token components have been verified at the time of this function call.

The GeneralSign class is used to build and sign General JWS objects.

Used to build General JWS object's individual signatures.

Verifies the signature and format of and afterwards decodes the General JWS.

Interface for General JWS Verification dynamic key resolution. No token components have been verified at the time of this function call.

Decodes a signed JSON Web Token payload. This does not validate the JWT Claims Set types or values. This does not validate the JWS Signature. For a proper Signed JWT Claims Set validation and JWS signature verification use jose.jwtVerify(). For an encrypted JWT Claims Set validation and JWE decryption use jose.jwtDecrypt().

Verifies the JWT format (to be a JWE Compact format), decrypts the ciphertext, validates the JWT Claims Set.

Interface for JWT Decryption dynamic key resolution. No token components have been verified at the time of this function call.

Combination of JWE Decryption options and JWT Claims Set verification options.

The EncryptJWT class is used to build and encrypt Compact JWE formatted JSON Web Tokens.

The SignJWT class is used to build and sign Compact JWS formatted JSON Web Tokens.

The UnsecuredJWT class is a utility for dealing with { "alg": "none" } Unsecured JWTs.

Result of decoding an Unsecured JWT.

Verifies the JWT format (to be a JWS Compact format), verifies the JWS signature, validates the JWT Claims Set.

Interface for JWT Verification dynamic key resolution. No token components have been verified at the time of this function call.

Combination of JWS Verification options and JWT Claims Set verification options.

Exports a !CryptoKey, !KeyObject, or !Uint8Array to a JWK.

Exports a private !CryptoKey or !KeyObject to a PEM-encoded PKCS8 string format.

Exports a public !CryptoKey or !KeyObject to a PEM-encoded SPKI string format.

Generates a private and a public key for a given JWA algorithm identifier. This can only generate asymmetric key pairs. For symmetric secrets use the generateSecret function.

Asymmetric key pair generation function options.

Asymmetric key pair generation function result.

Generates a symmetric secret key for a given JWA algorithm identifier.

Secret generation function options.

Imports a JWK to a !CryptoKey. Either the JWK "alg" (Algorithm) Parameter, or the optional "alg" argument, must be present for asymmetric JSON Web Key imports.

Imports a PEM-encoded PKCS#8 string as a !CryptoKey.

Imports a PEM-encoded SPKI string as a !CryptoKey.

Imports the SPKI from an X.509 string certificate as a !CryptoKey.

Key Import Function options.