https://github.com/kjur/typepki-jwt
JWT/JWS sub module for TypePKI library
https://github.com/kjur/typepki-jwt
jose jwa jwk jws jwt typepki typescript
Last synced: 3 months ago
JSON representation
JWT/JWS sub module for TypePKI library
- Host: GitHub
- URL: https://github.com/kjur/typepki-jwt
- Owner: kjur
- License: mit
- Created: 2024-05-07T16:32:33.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-21T02:08:29.000Z (over 1 year ago)
- Last Synced: 2024-05-21T22:34:02.164Z (over 1 year ago)
- Topics: jose, jwa, jwk, jws, jwt, typepki, typescript
- Language: TypeScript
- Homepage: https://kjur.github.io/typepki-jwt/
- Size: 67.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
typepki-jwt: JWT/JWS sub module for TypePKI library (Beta)
==========================================================
[TOP](https://kjur.github.io/typepki-jwt/) | [github](https://github.com/kjur/typepki-jwt) | [npm](https://www.npmjs.com/package/typepki-jwt) | [TypePKI](https://kjur.github.io/typepki/)
The 'TypePKI' library is an opensource free TypeScript PKI library which is the successor of the long lived [jsrsasign](https://kjur.github.io/jsrsasign) library.
The 'typepki-jwt' is a JWT(JSON Web Token) and JWS(JSON Web Signatures) sub module for TypePKI library.
## FEATURE
- signing and verifying JWS(JSON Web Signatures)
- verifying JWT(JSON Web Token)
- Dual CommonJS/ES module package supporting CommonJS(CJS) and ES modules
## Uasge
### signing JWS with private key
This supports asymmetric private key or shared key of CrytoKey object of W3C Crypto API for signing.
It may be useful to generate a key or import a key by using [typepki-webcrypto](https://kjur.github.io/typepki-webcrypto/) module.
```JavaScript
import { importPEM } from "typepki-webcrypto";
const prvkey = await importPEM("-----BEGIN PRIVATE...", "SHA256withRSA");
```
Now you can generate JWS signature.
```JavaScript
import { signJWS } from "typepki-jwt";
const sJWS = await signJWS("RS256", prvkey, "eyJOe...", "eyJpc...");
```
"sJWS" will be a string such like "eyJOe...".
It is even easier if you specify the PEM or HMAC key string directly instead of the CryptoKey object:
```JavaScript
const sJWS = await signJWS("RS256", "-----BEGIN PRIVATE KEY...", "eyJOe...", "eyJpc...");
```
### verifying JWS with public key
Verifying JWS will be similar way. Importing a public key first:
```JavaScript
import { importPEM } from "typepki-webcrypto";
const pubkey = await importPEM("-----BEGIN PUBLIC...", "SHA256withRSA");
```
Verifying JWS signature will be:
```JavaScript
import { verifyJWS } from "typepki-jwt";
const isValid = await verifyJWS(sJWS, pubkey, ["RS256", "RS384", "RS512"]);
```
NOTE: It is strongly recommended to specify the "acceptAlgs" optional argument such like "['RS256', 'RS384']" to prevent algorithm down grade attacks.
### verifying JWT
Verifying JWT will be similar to JWS by {@link verifyJWS}. To verify JWT you need to specify JWT acceptable parameters by {@link JWTVerifyOption}.
Whey you want to accept JWT tokens with:
- with HS256 and HS384 signature algorithms
- "http://issuer1.example.com/" or "http://issuer2.example.com/" as issuers
- verify at current time (by without verifyAt member)
JWTVerifyOption will be following
```ts
const opt: JWTVerifyOption = {
alg: ["HS256", "HS384"],
iss: ["http://issuer1.example.com/", "http://issuer2.example.com/"],
};
```
Then you can verify a JWT by {@link verifyJWT} funciton.
```ts
await verifyJWT("eyJ...", key, opt) -> true
```