ktonon/elm-jsonwebtoken/1.0.0

NOTE: this package is not compatible with Elm 0.19.1

JsonWebToken

JSON Web Token encoder and decoder.

Examples below assume the following imports

import Json.Decode
import Json.Encode
import TestHelpers
    exposing
        ( aValidToken
        , correctSecret
        , encodePayload
        , payload
        , payloadDecoder
        , wrongSecret
        )
Decoder payload
-> Secret
-> Token
-> Result (DecodeError payload) payload

Verify a token given a secret or public key.

If all goes well, you'll get a result back with the payload.

decode payloadDecoder correctSecret aValidToken
--> Ok payload

If something goes wrong, you get an error:

decode payloadDecoder correctSecret "token.should.have.three.parts"
--> Err InvalidToken

Some errors will include the payload. However, whenever there is an error the payload should not be trusted.

decode payloadDecoder wrongSecret aValidToken
--> Err <| InvalidSecret payload
encode : Alg -> (payload -> Value) -> Secret -> payload -> Token

Create and sign a token.

encode hmacSha256 encodePayload correctSecret payload
--> aValidToken


encode hmacSha512 Json.Encode.string "other secret" "some payload"
    |> (decode Json.Decode.string "other secret")
--> Ok "some payload"


encode hmacSha224 Json.Encode.int "123" 456
    |> (decode Json.Decode.int "abc")
--> Err <| InvalidSecret 456

Algorithms

HMAC SHA224 digest algorithm.

HMAC SHA256 digest algorithm.

HMAC SHA384 digest algorithm.

HMAC SHA512 digest algorithm.

Errors

type DecodeError payload
= DecodeHeaderFailed payload String
| DecodePayloadFailed String
| InvalidSecret payload
| InvalidToken

Types of errors which can occur during decoding of a token.

Types

type Alg

Type of algoirthm to use for the digest

type alias Secret =
String

String used to sign or verify a token.

  • In the case of signing, this can also be a private key.
  • In the case of verifying, this can also be a public key.
type alias Token =
String

A JSON web token.

algDecoder : Decoder Alg

Algorithm decoder.