PlugHmacAuth v0.1.0 PlugHmacAuth View Source

PlugHmacAuth provides a Plug for HMAC authentication.

Link to this section Summary

Types

opts()

Functions

call(conn, opts)

Callback implementation for Plug.call/2.

fetch_token_from_header(conn, key)

Returns the first token from http request header by specific key.

gen_signature(payload, secret_key, hmac_hash_algo)

Returns signatre generated by payload and secret key.

get_payload(conn)

init(opts)

Callback implementation for Plug.init/1.

verify_payload(conn, secret_key, access_signature, hmac_hash_algo)

Link to this section Types

opts()

Specs

opts() :: [
  key_access_id: String.t(),
  key_signature: String.t(),
  hmac_hash_algo:
    :md4
    | :md5
    | :sha
    | :sha224
    | :sha256
    | :sha384
    | :sha3_224
    | :sha3_256
    | :sha3_384
    | :sha3_512
    | :sha512,
  secret_handler: module(),
  error_handler: module()
]

Link to this section Functions

call(conn, opts)

Specs

call(Plug.Conn.t(), Keyword.t()) :: Plug.Conn.t()

Callback implementation for Plug.call/2.

fetch_token_from_header(conn, key)

Specs

fetch_token_from_header(Plug.Conn.t(), binary()) ::
  {:error, :invalid_key} | {:ok, binary()}

Returns the first token from http request header by specific key.

gen_signature(payload, secret_key, hmac_hash_algo)

Specs

gen_signature(String.t(), String.t(), atom()) :: String.t()

Returns signatre generated by payload and secret key.

get_payload(conn)

Specs

get_payload(Plug.Conn.t()) :: String.t()

init(opts)

Specs

init(opts :: Keyword.t()) :: Keyword.t()

Callback implementation for Plug.init/1.

verify_payload(conn, secret_key, access_signature, hmac_hash_algo)

Specs

verify_payload(
  Plug.Conn.t(),
  String.t(),
  String.t(),
  :md4
  | :md5
  | :sha
  | :sha224
  | :sha256
  | :sha384
  | :sha3_224
  | :sha3_256
  | :sha3_384
  | :sha3_512
  | :sha512
) :: :ok | {:error, :invalid_signature}