https://github.com/gaku-sei/purescript-node-jwt

Safe bindings for the Node JWT module
https://github.com/gaku-sei/purescript-node-jwt

Last synced: 19 days ago
JSON representation

Safe bindings for the Node JWT module

• Host: GitHub
• URL: https://github.com/gaku-sei/purescript-node-jwt
• Owner: gaku-sei
• Created: 2020-06-23T02:02:10.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-22T17:03:11.000Z (about 2 years ago)
• Last Synced: 2024-11-05T13:12:38.723Z (2 months ago)
• Language: PureScript
• Size: 52.7 KB
• Stars: 6
• Watchers: 3
• Forks: 3
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# purescript-node-jwt

Safe bindings for the Node [JWT](https://github.com/auth0/node-jsonwebtoken) module.

Allows to sign, decode, and verify tokens.

## Installation

```

spago install node-jwt

```

## Example

This library adheres to the [JWT RFC](https://tools.ietf.org/html/rfc7519), so in the below examples, headers is JOSE Header, and claims is, well, Claims.

### Sign

To sign a project, you'll need to provide a secret key, some headers, and some claims. The `sign` function will return an [`Aff String`](https://pursuit.purescript.org/packages/purescript-aff/5.1.2/docs/Effect.Aff#t:Aff).

```purs

sign

  (Secret "my-super-secret-key")

  defaultHeaders

  defaultClaims

```

By default, some values will be set for you: `alg` will be `HS256`, `typ` equals `JWT`, and the `iat` field will be set to the creation timestamp. You _can_ override any for the above by providing the value explicitely.

You can also provide an `unregisteredClaims` record, each values of that record must be [encodable](https://pursuit.purescript.org/packages/purescript-foreign-generic/10.0.0/docs/Foreign.Generic.Class#t:Encode):

```purs

sign

  (Secret "my-super-secret-key")

  defaultHeaders

  (defaultClaims { unregisteredClaims = Just { foo: "bar" } )

```

### Decode

If decode succeeds, it will return a `Token r Unverified` where `r` is the row type of the `unregisteredClaims` record. You can read the headers and claims as follow:

```purs

decodedHeaders :: String -> Maybe JOSEHeaders

decodedHeaders token = hush $ decode' token <#> _.headers

decodedClaims :: String -> Maybe (Claims ())

decodedClaims token = hush $ decode' token <#> _.claims

decodedClaims' :: String -> Maybe (Claims ( foo :: String ))

decodedClaims' token = hush $ decode token <#> _.claims

```

Notice that when decoding claims with some explicit unregistered claims, said claims must be of the expected type at runtime.

### Verify

If verify succeeds, it will return a `Token Verified` you can read the headers and claims this way:

```purs

verifiedHeaders :: String -> Maybe JOSEHeaders

verifiedHeaders token = hush $ verify' (Secret "my-super-secret-key") token <#> _.headers

verifiedClaims :: String -> Maybe (Claims ())

verifiedClaims token = hush $ verify' (Secret "my-super-secret-key") token <#> _.claims

verifiedClaims' :: String -> Maybe (Claims ( foo :: String ))

verifiedClaims' token = hush $ verify (Secret "my-super-secret-key") token <#> _.claims

```

## Documentation

Module documentation is [published on Pursuit](http://pursuit.purescript.org/packages/purescript-node-jwt).