-
-
Notifications
You must be signed in to change notification settings - Fork 319
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
37 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,73 +10,73 @@ Support from the community to continue maintaining and improving this module is | |
|
||
**`example`** Deno import | ||
```js | ||
import * as jose from 'https://deno.land/x/[email protected].8/index.ts' | ||
import * as jose from 'https://deno.land/x/[email protected].9/index.ts' | ||
``` | ||
|
||
### JSON Web Tokens (JWT) | ||
|
||
The `jose` module supports JSON Web Tokens (JWT) and provides functionality for signing and verifying tokens, as well as their JWT Claims Set validation. | ||
|
||
- [Signing](https://github.com/panva/jose/blob/v4.15.8/docs/classes/jwt_sign.SignJWT.md) using the `SignJWT` class | ||
- [Verification & JWT Claims Set Validation](https://github.com/panva/jose/blob/v4.15.8/docs/functions/jwt_verify.jwtVerify.md) using the `jwtVerify` function | ||
- [Using a remote JWKS](https://github.com/panva/jose/blob/v4.15.8/docs/functions/jwks_remote.createRemoteJWKSet.md) | ||
- [Using a local JWKS](https://github.com/panva/jose/blob/v4.15.8/docs/functions/jwks_local.createLocalJWKSet.md) | ||
- [Signing](https://github.com/panva/jose/blob/v4.15.9/docs/classes/jwt_sign.SignJWT.md) using the `SignJWT` class | ||
- [Verification & JWT Claims Set Validation](https://github.com/panva/jose/blob/v4.15.9/docs/functions/jwt_verify.jwtVerify.md) using the `jwtVerify` function | ||
- [Using a remote JWKS](https://github.com/panva/jose/blob/v4.15.9/docs/functions/jwks_remote.createRemoteJWKSet.md) | ||
- [Using a local JWKS](https://github.com/panva/jose/blob/v4.15.9/docs/functions/jwks_local.createLocalJWKSet.md) | ||
- Utility functions | ||
- [Decoding Token's Protected Header](https://github.com/panva/jose/blob/v4.15.8/docs/functions/util_decode_protected_header.decodeProtectedHeader.md) | ||
- [Decoding JWT Claims Set](https://github.com/panva/jose/blob/v4.15.8/docs/functions/util_decode_jwt.decodeJwt.md) prior to its validation | ||
- [Decoding Token's Protected Header](https://github.com/panva/jose/blob/v4.15.9/docs/functions/util_decode_protected_header.decodeProtectedHeader.md) | ||
- [Decoding JWT Claims Set](https://github.com/panva/jose/blob/v4.15.9/docs/functions/util_decode_jwt.decodeJwt.md) prior to its validation | ||
|
||
### Encrypted JSON Web Tokens | ||
|
||
The `jose` module supports encrypted JSON Web Tokens and provides functionality for encrypting and decrypting tokens, as well as their JWT Claims Set validation. | ||
|
||
- [Encryption](https://github.com/panva/jose/blob/v4.15.8/docs/classes/jwt_encrypt.EncryptJWT.md) using the `EncryptJWT` class | ||
- [Decryption & JWT Claims Set Validation](https://github.com/panva/jose/blob/v4.15.8/docs/functions/jwt_decrypt.jwtDecrypt.md) using the `jwtDecrypt` function | ||
- [Encryption](https://github.com/panva/jose/blob/v4.15.9/docs/classes/jwt_encrypt.EncryptJWT.md) using the `EncryptJWT` class | ||
- [Decryption & JWT Claims Set Validation](https://github.com/panva/jose/blob/v4.15.9/docs/functions/jwt_decrypt.jwtDecrypt.md) using the `jwtDecrypt` function | ||
- Utility functions | ||
- [Decoding Token's Protected Header](https://github.com/panva/jose/blob/v4.15.8/docs/functions/util_decode_protected_header.decodeProtectedHeader.md) | ||
- [Decoding Token's Protected Header](https://github.com/panva/jose/blob/v4.15.9/docs/functions/util_decode_protected_header.decodeProtectedHeader.md) | ||
|
||
### Key Utilities | ||
|
||
The `jose` module supports importing, exporting, and generating keys and secrets in various formats, including PEM formats like SPKI, X.509 certificate, and PKCS #8, as well as JSON Web Key (JWK). | ||
|
||
- Key Import Functions | ||
- [JWK Import](https://github.com/panva/jose/blob/v4.15.8/docs/functions/key_import.importJWK.md) | ||
- [Public Key Import (SPKI)](https://github.com/panva/jose/blob/v4.15.8/docs/functions/key_import.importSPKI.md) | ||
- [Public Key Import (X.509 Certificate)](https://github.com/panva/jose/blob/v4.15.8/docs/functions/key_import.importX509.md) | ||
- [Private Key Import (PKCS #8)](https://github.com/panva/jose/blob/v4.15.8/docs/functions/key_import.importPKCS8.md) | ||
- [JWK Import](https://github.com/panva/jose/blob/v4.15.9/docs/functions/key_import.importJWK.md) | ||
- [Public Key Import (SPKI)](https://github.com/panva/jose/blob/v4.15.9/docs/functions/key_import.importSPKI.md) | ||
- [Public Key Import (X.509 Certificate)](https://github.com/panva/jose/blob/v4.15.9/docs/functions/key_import.importX509.md) | ||
- [Private Key Import (PKCS #8)](https://github.com/panva/jose/blob/v4.15.9/docs/functions/key_import.importPKCS8.md) | ||
- Key and Secret Generation Functions | ||
- [Asymmetric Key Pair Generation](https://github.com/panva/jose/blob/v4.15.8/docs/functions/key_generate_key_pair.generateKeyPair.md) | ||
- [Symmetric Secret Generation](https://github.com/panva/jose/blob/v4.15.8/docs/functions/key_generate_secret.generateSecret.md) | ||
- [Asymmetric Key Pair Generation](https://github.com/panva/jose/blob/v4.15.9/docs/functions/key_generate_key_pair.generateKeyPair.md) | ||
- [Symmetric Secret Generation](https://github.com/panva/jose/blob/v4.15.9/docs/functions/key_generate_secret.generateSecret.md) | ||
- Key Export Functions | ||
- [JWK Export](https://github.com/panva/jose/blob/v4.15.8/docs/functions/key_export.exportJWK.md) | ||
- [Private Key Export](https://github.com/panva/jose/blob/v4.15.8/docs/functions/key_export.exportPKCS8.md) | ||
- [Public Key Export](https://github.com/panva/jose/blob/v4.15.8/docs/functions/key_export.exportSPKI.md) | ||
- [JWK Export](https://github.com/panva/jose/blob/v4.15.9/docs/functions/key_export.exportJWK.md) | ||
- [Private Key Export](https://github.com/panva/jose/blob/v4.15.9/docs/functions/key_export.exportPKCS8.md) | ||
- [Public Key Export](https://github.com/panva/jose/blob/v4.15.9/docs/functions/key_export.exportSPKI.md) | ||
|
||
### JSON Web Signature (JWS) | ||
|
||
The `jose` module supports signing and verification of JWS messages with arbitrary payloads in Compact, Flattened JSON, and General JSON serialization syntaxes. | ||
|
||
- Signing - [Compact](https://github.com/panva/jose/blob/v4.15.8/docs/classes/jws_compact_sign.CompactSign.md), [Flattened JSON](https://github.com/panva/jose/blob/v4.15.8/docs/classes/jws_flattened_sign.FlattenedSign.md), [General JSON](https://github.com/panva/jose/blob/v4.15.8/docs/classes/jws_general_sign.GeneralSign.md) | ||
- Verification - [Compact](https://github.com/panva/jose/blob/v4.15.8/docs/functions/jws_compact_verify.compactVerify.md), [Flattened JSON](https://github.com/panva/jose/blob/v4.15.8/docs/functions/jws_flattened_verify.flattenedVerify.md), [General JSON](https://github.com/panva/jose/blob/v4.15.8/docs/functions/jws_general_verify.generalVerify.md) | ||
- [Verify using a remote JWKS](https://github.com/panva/jose/blob/v4.15.8/docs/functions/jwks_remote.createRemoteJWKSet.md) | ||
- [Verify using a local JWKS](https://github.com/panva/jose/blob/v4.15.8/docs/functions/jwks_local.createLocalJWKSet.md) | ||
- Signing - [Compact](https://github.com/panva/jose/blob/v4.15.9/docs/classes/jws_compact_sign.CompactSign.md), [Flattened JSON](https://github.com/panva/jose/blob/v4.15.9/docs/classes/jws_flattened_sign.FlattenedSign.md), [General JSON](https://github.com/panva/jose/blob/v4.15.9/docs/classes/jws_general_sign.GeneralSign.md) | ||
- Verification - [Compact](https://github.com/panva/jose/blob/v4.15.9/docs/functions/jws_compact_verify.compactVerify.md), [Flattened JSON](https://github.com/panva/jose/blob/v4.15.9/docs/functions/jws_flattened_verify.flattenedVerify.md), [General JSON](https://github.com/panva/jose/blob/v4.15.9/docs/functions/jws_general_verify.generalVerify.md) | ||
- [Verify using a remote JWKS](https://github.com/panva/jose/blob/v4.15.9/docs/functions/jwks_remote.createRemoteJWKSet.md) | ||
- [Verify using a local JWKS](https://github.com/panva/jose/blob/v4.15.9/docs/functions/jwks_local.createLocalJWKSet.md) | ||
- Utility functions | ||
- [Decoding Token's Protected Header](https://github.com/panva/jose/blob/v4.15.8/docs/functions/util_decode_protected_header.decodeProtectedHeader.md) | ||
- [Decoding Token's Protected Header](https://github.com/panva/jose/blob/v4.15.9/docs/functions/util_decode_protected_header.decodeProtectedHeader.md) | ||
|
||
### JSON Web Encryption (JWE) | ||
|
||
The `jose` module supports encryption and decryption of JWE messages with arbitrary plaintext in Compact, Flattened JSON, and General JSON serialization syntaxes. | ||
|
||
- Encryption - [Compact](https://github.com/panva/jose/blob/v4.15.8/docs/classes/jwe_compact_encrypt.CompactEncrypt.md), [Flattened JSON](https://github.com/panva/jose/blob/v4.15.8/docs/classes/jwe_flattened_encrypt.FlattenedEncrypt.md), [General JSON](https://github.com/panva/jose/blob/v4.15.8/docs/classes/jwe_general_encrypt.GeneralEncrypt.md) | ||
- Decryption - [Compact](https://github.com/panva/jose/blob/v4.15.8/docs/functions/jwe_compact_decrypt.compactDecrypt.md), [Flattened JSON](https://github.com/panva/jose/blob/v4.15.8/docs/functions/jwe_flattened_decrypt.flattenedDecrypt.md), [General JSON](https://github.com/panva/jose/blob/v4.15.8/docs/functions/jwe_general_decrypt.generalDecrypt.md) | ||
- Encryption - [Compact](https://github.com/panva/jose/blob/v4.15.9/docs/classes/jwe_compact_encrypt.CompactEncrypt.md), [Flattened JSON](https://github.com/panva/jose/blob/v4.15.9/docs/classes/jwe_flattened_encrypt.FlattenedEncrypt.md), [General JSON](https://github.com/panva/jose/blob/v4.15.9/docs/classes/jwe_general_encrypt.GeneralEncrypt.md) | ||
- Decryption - [Compact](https://github.com/panva/jose/blob/v4.15.9/docs/functions/jwe_compact_decrypt.compactDecrypt.md), [Flattened JSON](https://github.com/panva/jose/blob/v4.15.9/docs/functions/jwe_flattened_decrypt.flattenedDecrypt.md), [General JSON](https://github.com/panva/jose/blob/v4.15.9/docs/functions/jwe_general_decrypt.generalDecrypt.md) | ||
- Utility functions | ||
- [Decoding Token's Protected Header](https://github.com/panva/jose/blob/v4.15.8/docs/functions/util_decode_protected_header.decodeProtectedHeader.md) | ||
- [Decoding Token's Protected Header](https://github.com/panva/jose/blob/v4.15.9/docs/functions/util_decode_protected_header.decodeProtectedHeader.md) | ||
|
||
### Other | ||
|
||
The following are additional features and utilities provided by the `jose` module: | ||
|
||
- [Calculating JWK Thumbprint](https://github.com/panva/jose/blob/v4.15.8/docs/functions/jwk_thumbprint.calculateJwkThumbprint.md) | ||
- [Calculating JWK Thumbprint URI](https://github.com/panva/jose/blob/v4.15.8/docs/functions/jwk_thumbprint.calculateJwkThumbprintUri.md) | ||
- [Verification using a JWK Embedded in a JWS Header](https://github.com/panva/jose/blob/v4.15.8/docs/functions/jwk_embedded.EmbeddedJWK.md) | ||
- [Unsecured JWT](https://github.com/panva/jose/blob/v4.15.8/docs/classes/jwt_unsecured.UnsecuredJWT.md) | ||
- [JOSE Errors](https://github.com/panva/jose/blob/v4.15.8/docs/modules/util_errors.md) | ||
- [Calculating JWK Thumbprint](https://github.com/panva/jose/blob/v4.15.9/docs/functions/jwk_thumbprint.calculateJwkThumbprint.md) | ||
- [Calculating JWK Thumbprint URI](https://github.com/panva/jose/blob/v4.15.9/docs/functions/jwk_thumbprint.calculateJwkThumbprintUri.md) | ||
- [Verification using a JWK Embedded in a JWS Header](https://github.com/panva/jose/blob/v4.15.9/docs/functions/jwk_embedded.EmbeddedJWK.md) | ||
- [Unsecured JWT](https://github.com/panva/jose/blob/v4.15.9/docs/classes/jwt_unsecured.UnsecuredJWT.md) | ||
- [JOSE Errors](https://github.com/panva/jose/blob/v4.15.9/docs/modules/util_errors.md) |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters