https://github.com/emrahcom/jwt
Create and verify JSON Web Token
https://github.com/emrahcom/jwt
deno jsr jwt typescript
Last synced: 3 months ago
JSON representation
Create and verify JSON Web Token
- Host: GitHub
- URL: https://github.com/emrahcom/jwt
- Owner: emrahcom
- License: mit
- Created: 2024-09-06T16:26:28.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-02-01T10:16:42.000Z (4 months ago)
- Last Synced: 2025-02-01T11:22:35.661Z (4 months ago)
- Topics: deno, jsr, jwt, typescript
- Language: TypeScript
- Homepage: https://jsr.io/@emrahcom/jwt
- Size: 84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JWT
Create and verify JSON Web Tokens (JSON).
## API
Please use the native
[Web Crypto API](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/generateKey)
to generate a **secure** `CryptoKey`.
```typescript
const key = await crypto.subtle.generateKey(
{ name: "HMAC", hash: "SHA-512" },
true,
["sign", "verify"],
);
```
Or to generate a **secure** `CryptoKey` using a secret.
```typescript
const secret = "MYSECRET";
const encoder = new TextEncoder();
const keyData = encoder.encode(secret);
const key = await crypto.subtle.importKey(
"raw",
keyData,
{ name: "HMAC", hash: "SHA-512" },
true,
["sign", "verify"],
);
```
### create
Takes `Header`, `Payload` and `CryptoKey` and returns the url-safe encoded
`jwt`.
```typescript
import { create } from "jsr:@emrahcom/jwt";
const jwt = await create({ alg: "HS512", typ: "JWT" }, { foo: "bar" }, key);
```
### verify
Takes `jwt`, `CryptoKey` and `VerifyOptions` and returns the `Payload` of the
`jwt` if the `jwt` is valid. Otherwise it throws an `Error`.
```typescript
import { verify } from "jsr:@emrahcom/jwt";
const payload = await verify(jwt, key); // { foo: "bar" }
```
### decode
Takes a `jwt` and returns a 3-tuple
`[header: unknown, payload: unknown, signature: Uint8Array]` if the `jwt` has a
valid _serialization_. Otherwise it throws an `Error`. This function does
**not** verify the digital signature.
```typescript
import { decode } from "jsr:@emrahcom/jwt";
const [header, payload, signature] = decode(jwt);
```
### getNumericDate
This helper function simplifies setting a
[NumericDate](https://tools.ietf.org/html/rfc7519#page-6). It takes either a
`Date` object or a `number` (in seconds) and returns the number of seconds from
1970-01-01T00:00:00Z UTC until the specified UTC date/time.
```typescript
import { getNumericDate } from "jsr:@emrahcom/jwt";
// A specific date:
const exp = getNumericDate(new Date("2025-07-01"));
// One hour from now:
const nbf = getNumericDate(60 * 60);
```
## Algorithms
The following signature and MAC algorithms have been implemented:
- HS256 (HMAC SHA-256)
- HS384 (HMAC SHA-384)
- HS512 (HMAC SHA-512)
- RS256 (RSASSA-PKCS1-v1_5 SHA-256)
- RS384 (RSASSA-PKCS1-v1_5 SHA-384)
- RS512 (RSASSA-PKCS1-v1_5 SHA-512)
- PS256 (RSASSA-PSS SHA-256)
- PS384 (RSASSA-PSS SHA-384)
- PS512 (RSASSA-PSS SHA-512)
- ES256 (ECDSA using P-256 and SHA-256)
- ES384 (ECDSA using P-384 and SHA-384)
- ES512 (ECDSA using P-521 and SHA-512) (Not supported yet!)
- none ([_Unsecured JWTs_](https://tools.ietf.org/html/rfc7519#section-6)).
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file
for details.
This project is a fork of [Zaubrik/djwt](https://github.com/Zaubrik/djwt)