AuthShield v0.0.4 AuthShield.Credentials.TOTP View Source

Time-based One-Time Password (TOTP) is an extension of the HMAC-based One-time Password algorithm (HOTP) generating a one-time password by instead taking uniqueness from the current time.

It is usually used with mobile applications that receives the secret key and generates the code to be used in authentications.

Thi module implements an interface to deal with database transactions as inserts, updates, deletes, etc.

Link to this section Summary

Functions

check_totp?(totp, code, now \\ NaiveDateTime.utc_now())

Checks if the given TOTP code matches the generated one.

delete(totp)

Deletes a AuthShield.Credentials.Schemas.TOTP register.

delete!(totp)

Deletes a AuthShield.Credentials.Schemas.TOTP register.

get_by(filters)

Gets a AuthShield.Credentials.Schemas.TOTP register by its filters.

get_by!(filters)

Gets a AuthShield.Credentials.Schemas.TOTP register by its filters.

insert(params)

Creates a new AuthShield.Credentials.Schemas.TOTP register.

insert!(params)

Creates a new AuthShield.Credentials.Schemas.TOTP register.

list(filters \\ [])

Returns a list of AuthShield.Credentials.Schemas.TOTP by its filters

Link to this section Functions

check_totp?(totp, code, now \\ NaiveDateTime.utc_now())

check_totp?(
  totp :: AuthShield.Credentials.Schemas.TOTP.t(),
  totp_code :: String.t(),
  now :: DateTime.t()
) :: boolean()

Checks if the given TOTP code matches the generated one.

Exemples:

  # Using default timestamp
  AuthShield.Credentials.TOTP.check_pin?(totp, "332456")

  # Defining timestamp
  AuthShield.Credentials.TOTP.check_pin?(totp, "332456", ~N[2000-01-01 23:00:07])

delete(totp)

Deletes a AuthShield.Credentials.Schemas.TOTP register.

Exemples:

  AuthShield.Credentials.TOTP.delete(totp)

delete!(totp)

Deletes a AuthShield.Credentials.Schemas.TOTP register.

Similar to delete/1 but returns the struct or raises if the changeset is invalid.

get_by(filters)

Gets a AuthShield.Credentials.Schemas.TOTP register by its filters.

Exemples:

  AuthShield.Credentials.TOTP.get_by(user_id: "ecb4c67d-6380-4984-ae04-1563e885d59e")

get_by!(filters)

Gets a AuthShield.Credentials.Schemas.TOTP register by its filters.

Similar to get_by/1 but returns the struct or raises if the changeset is invalid.

insert(params)

Creates a new AuthShield.Credentials.Schemas.TOTP register.

Exemples:

  # Simple insert
  AuthShield.Credentials.TOTP.insert(%{
    user_id: ecb4c67d-6380-4984-ae04-1563e885d59e",
    email: "lucas@gmail.com"
  })

  # All parameters
  AuthShield.Credentials.TOTP.insert(%{
    user_id: ecb4c67d-6380-4984-ae04-1563e885d59e",
    email: "lucas@gmail.com",
    issuer: "MyWebpage",
    digits: 4,
    period: 60
  })

insert!(params)

Creates a new AuthShield.Credentials.Schemas.TOTP register.

Similar to insert/1 but returns the struct or raises if the changeset is invalid.

list(filters \\ [])

Returns a list of AuthShield.Credentials.Schemas.TOTP by its filters

Exemples:

  # Getting the all list
  AuthShield.Credentials.TOTP.list()

  # Filtering the list by field
  AuthShield.Credentials.TOTP.list(user_id: "ecb4c67d-6380-4984-ae04-1563e885d59e")