Authex is a simple and opinionated JWT authentication and authorization library.


Keywords
auth, authentication, authorization, elixir, jwt, phoenix, plug
License
MIT

Documentation

Authex

Build Status Authex Version

Authex is a simple JWT authentication and authorization library for Elixir.

Installation

The package can be installed by adding authex to your list of dependencies in mix.exs.

In addition, we must also add a JSON encoder/decoder. Jason is recommended. But any of these will work: jiffy, jsone, jsx, ojson, Poison.

Finally, if you wish to use any of the plug functionality, make sure to add the plug dependency.

def deps do
  [
    {:authex, "~> 1.0"},
    {:jason, "~> 1.0"},
    {:plug, "~> 1.0}
  ]
end

Documentation

See HexDocs for additional documentation.

Example

To get started, we must define our auth module:

defmodule MyApp.Auth do
  use Authex, otp_app: :my_app

  # Use the runtime init callback to dynamically set our secret.
  def init(config) do
    secret = System.get_env("AUTH_SECRET") || "secret"
    config = Keyword.put(config, :secret, secret)

    {:ok, config}
  end
end

And add it to your supervision tree:

children = [
  MyApp.Auth
]

We can then create, sign, and verify tokens:

token = MyApp.Auth.token(sub: 1, scopes: ["admin/read"])
compact_token = MyApp.Auth.sign(token)
{:ok, token} = MyApp.Auth.verify(compact_token)

Please check out the documentation for more advanced features like serializers, repositories and integration with plugs.

Features

  • Easy to integrate with almost any app.
  • Handles both authentication + authorization.
  • Compatible with umbrella apps.
  • Convert data to and from tokens via serializers.
  • Handle persistence for things like blacklists.
  • Batteries included for plug integration.