2023-11-20 16:05:32 +03:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "x-ua-compatible" content = "ie=edge" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2024-01-16 10:41:49 +03:00
< meta name = "generator" content = "ExDoc v0.31.1" >
2023-11-20 16:05:32 +03:00
< meta name = "project" content = "Plausible v0.0.1" >
2024-01-11 10:50:44 +03:00
2023-11-20 16:05:32 +03:00
< title > Plausible.Auth.TOTP — Plausible v0.0.1< / title >
2024-01-16 10:41:49 +03:00
< link rel = "stylesheet" href = "dist/html-elixir-FM2CSD74.css" / >
2023-11-20 16:05:32 +03:00
< script src = "dist/handlebars.runtime-NWIB6V2M.js" > < / script >
2024-01-11 10:50:44 +03:00
< script src = "dist/handlebars.templates-43PMFBC7.js" > < / script >
2024-02-23 14:36:03 +03:00
< script src = "dist/sidebar_items-4B488B2F.js" > < / script >
2023-11-20 16:05:32 +03:00
< script src = "docs_config.js" > < / script >
2024-01-16 10:41:49 +03:00
< script async src = "dist/html-L4O5OK2K.js" > < / script >
2023-11-20 16:05:32 +03:00
< / head >
< body data-type = "modules" class = "page-module" >
< script >
try {
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
if (settings.theme === 'dark' ||
((settings.theme === 'system' || settings.theme == null) & &
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
document.body.classList.add('dark')
}
} catch (error) { }
< / script >
< div class = "main" >
2024-01-16 10:41:49 +03:00
< button id = "sidebar-menu" class = "sidebar-button sidebar-toggle" aria-label = "toggle sidebar" aria-controls = "sidebar" >
2023-11-20 16:05:32 +03:00
< i class = "ri-menu-line ri-lg" title = "Collapse/expand sidebar" > < / i >
< / button >
2024-01-16 10:41:49 +03:00
< div class = "background-layer" > < / div >
2024-01-11 10:50:44 +03:00
< nav id = "sidebar" class = "sidebar" >
2023-11-20 16:05:32 +03:00
< div class = "sidebar-header" >
2024-01-11 10:50:44 +03:00
< div class = "sidebar-projectInfo" >
2023-11-20 16:05:32 +03:00
2024-01-11 10:50:44 +03:00
< a href = "readme.html" class = "sidebar-projectImage" >
< img src = "assets/logo.png" alt = "Plausible" / >
< / a >
2023-11-20 16:05:32 +03:00
2024-01-11 10:50:44 +03:00
< div >
< a href = "readme.html" class = "sidebar-projectName" translate = "no" >
2023-11-20 16:05:32 +03:00
Plausible
2024-01-11 10:50:44 +03:00
< / a >
< div class = "sidebar-projectVersion" translate = "no" >
v0.0.1
< / div >
2023-11-20 16:05:32 +03:00
< / div >
< / div >
2024-01-11 10:50:44 +03:00
< ul id = "sidebar-listNav" class = "sidebar-listNav" role = "tablist" >
< li >
< button id = "extras-list-tab-button" role = "tab" data-type = "extras" aria-controls = "extras-tab-panel" aria-selected = "true" tabindex = "0" >
Pages
< / button >
< / li >
< li >
< button id = "modules-list-tab-button" role = "tab" data-type = "modules" aria-controls = "modules-tab-panel" aria-selected = "false" tabindex = "-1" >
Modules
< / button >
< / li >
< li >
< button id = "tasks-list-tab-button" role = "tab" data-type = "tasks" aria-controls = "tasks-tab-panel" aria-selected = "false" tabindex = "-1" >
< span translate = "no" > Mix< / span > Tasks
< / button >
< / li >
2023-11-20 16:05:32 +03:00
2024-01-11 10:50:44 +03:00
< / ul >
< / div >
2023-11-20 16:05:32 +03:00
2024-01-11 10:50:44 +03:00
< div id = "extras-tab-panel" class = "sidebar-tabpanel" role = "tabpanel" aria-labelledby = "extras-list-tab-button" >
< ul id = "extras-full-list" class = "full-list" > < / ul >
< / div >
2023-11-20 16:05:32 +03:00
2024-01-11 10:50:44 +03:00
< div id = "modules-tab-panel" class = "sidebar-tabpanel" role = "tabpanel" aria-labelledby = "modules-list-tab-button" hidden >
< ul id = "modules-full-list" class = "full-list" > < / ul >
< / div >
2023-11-20 16:05:32 +03:00
2024-01-11 10:50:44 +03:00
< div id = "tasks-tab-panel" class = "sidebar-tabpanel" role = "tabpanel" aria-labelledby = "tasks-list-tab-button" hidden >
< ul id = "tasks-full-list" class = "full-list" > < / ul >
< / div >
< / nav >
2023-11-20 16:05:32 +03:00
2024-01-11 10:50:44 +03:00
< main class = "content" >
2023-11-20 16:05:32 +03:00
< output role = "status" id = "toast" > < / output >
< div class = "content-outer" >
< div id = "content" class = "content-inner" >
2024-01-11 10:50:44 +03:00
< div class = "top-search" >
< div class = "search-settings" >
< form class = "search-bar" action = "search.html" >
< label class = "search-label" >
< span class = "sr-only" > Search documentation of Plausible< / span >
< input name = "q" type = "text" class = "search-input" placeholder = "Search Documentation (press /)" autocomplete = "off" autocorrect = "off" autocapitalize = "off" spellcheck = "false" / >
< / label >
< button type = "submit" class = "search-button" aria-label = "Submit Search" >
< i class = "ri-search-2-line ri-lg" aria-hidden = "true" title = "Submit search" > < / i >
< / button >
< button type = "button" tabindex = "-1" class = "search-close-button" aria-hidden = "true" >
< i class = "ri-close-line ri-lg" title = "Cancel search" > < / i >
< / button >
< / form >
2024-01-16 10:41:49 +03:00
< div class = "autocomplete" >
< / div >
2024-01-11 10:50:44 +03:00
< button class = "icon-settings display-settings" >
< i class = "ri-settings-3-line" > < / i >
< span class = "sr-only" > Settings< / span >
< / button >
< / div >
2024-01-16 10:41:49 +03:00
2024-01-11 10:50:44 +03:00
< / div >
2023-11-20 16:05:32 +03:00
< h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/auth/totp.ex#L1" title = "View Source" class = "icon-action" rel = "help" >
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< span translate = "no" > Plausible.Auth.TOTP< / span >
< small class = "app-vsn" translate = "no" > (Plausible v0.0.1)< / small >
< / h1 >
< section id = "moduledoc" >
< p > TOTP auth context< / p > < p > Handles all the aspects of TOTP setup, management and validation for users.< / p > < h2 id = "module-setup" class = "section-heading" >
2024-01-11 10:50:44 +03:00
< a href = "#module-setup" class = "hover-link" >
2023-11-20 16:05:32 +03:00
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< / a >
2024-01-11 10:50:44 +03:00
< span class = "text" > Setup< / span >
2023-11-20 16:05:32 +03:00
< / h2 >
< p > TOTP setup is started with < a href = "#initiate/1" > < code class = "inline" > initiate/1< / code > < / a > . At this stage, a random secret
binary is generated for user and stored under < code class = "inline" > User.totp_secret< / code > . The secret
is additionally encrypted while stored in the database using < a href = "https://hexdocs.pm/cloak/1.1.2/Cloak.html" > < code class = "inline" > Cloak< / code > < / a > . The
vault for safe storage is configured in < a href = "Plausible.Auth.TOTP.Vault.html" > < code class = "inline" > Plausible.Auth.TOTP.Vault< / code > < / a > via
2024-01-11 10:50:44 +03:00
a dedicated < a href = "https://hexdocs.pm/ecto/3.11.1/Ecto.html" > < code class = "inline" > Ecto< / code > < / a > type defined in < a href = "Plausible.Auth.TOTP.EncryptedBinary.html" > < code class = "inline" > Plausible.Auth.TOTP.EncryptedBinary< / code > < / a > .
2023-11-20 16:05:32 +03:00
The function returns updated user along with TOTP URI and a readable form
of secret. Both - the URI and readable secret - are meant for exposure
in the user's setup screen. The URI should be encoded as a QR code.< / p > < p > After initiation, user is expected to confirm valid setup with < a href = "#enable/2" > < code class = "inline" > enable/2< / code > < / a > ,
providing TOTP code from their authenticator app. After code validation
2023-12-06 14:02:03 +03:00
passes successfully, the < code class = "inline" > User.totp_enabled< / code > flag is set to < code class = "inline" > true< / code > .
Finally, the user must be immediately presented with a list of recovery codes
returned by the same call of < a href = "#enable/2" > < code class = "inline" > enable/2< / code > < / a > . The codes should be presented
in copy/paste friendly form, ideally also with a print-friendly view option.< / p > < p > The < a href = "#initiate/1" > < code class = "inline" > initiate/1< / code > < / a > and < code class = "inline" > enable/1< / code > functions can be safely called multiple
2023-11-20 16:05:32 +03:00
times, allowing user to abort and restart setup up to these stages.< / p > < h2 id = "module-management" class = "section-heading" >
2024-01-11 10:50:44 +03:00
< a href = "#module-management" class = "hover-link" >
2023-11-20 16:05:32 +03:00
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< / a >
2024-01-11 10:50:44 +03:00
< span class = "text" > Management< / span >
2023-11-20 16:05:32 +03:00
< / h2 >
2023-12-06 14:02:03 +03:00
< p > The state of TOTP for a particular user can be chcecked by calling
< a href = "#enabled?/1" > < code class = "inline" > enabled?/1< / code > < / a > or < a href = "#initiated?/1" > < code class = "inline" > initiated?/1< / code > < / a > .< / p > < p > TOTP can be disabled with < a href = "#disable/2" > < code class = "inline" > disable/2< / code > < / a > . User is expected to provide their
2023-11-20 16:05:32 +03:00
current password for safety. Once disabled, all TOTP user settings are
cleared and any remaining generated recovery codes are removed. The function
can be safely run more than once.< / p > < p > If the user needs to regenerate the recovery codes outside of setup procedure,
2023-12-06 14:02:03 +03:00
they must do it via < a href = "#generate_recovery_codes/2" > < code class = "inline" > generate_recovery_codes/2< / code > < / a > , providing their current
password for safety. They must be warned that any existing recovery codes
will be invalidated.< / p > < h2 id = "module-validation" class = "section-heading" >
2024-01-11 10:50:44 +03:00
< a href = "#module-validation" class = "hover-link" >
2023-11-20 16:05:32 +03:00
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< / a >
2024-01-11 10:50:44 +03:00
< span class = "text" > Validation< / span >
2023-11-20 16:05:32 +03:00
< / h2 >
< p > After logging in, user's TOTP state must be checked with < a href = "#enabled?/1" > < code class = "inline" > enabled?/1< / code > < / a > .< / p > < p > If enabled, user must be presented with TOTP code input form accepting
6 digit characters. The code must be checked using < a href = "#validate_code/2" > < code class = "inline" > validate_code/2< / code > < / a > .< / p > < p > User must have an option to alternatively input one of their recovery
codes. Those codes must be checked with < a href = "#use_recovery_code/2" > < code class = "inline" > use_recovery_code/2< / code > < / a > .< / p > < h2 id = "module-code-validity" class = "section-heading" >
2024-01-11 10:50:44 +03:00
< a href = "#module-code-validity" class = "hover-link" >
2023-11-20 16:05:32 +03:00
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< / a >
2024-01-11 10:50:44 +03:00
< span class = "text" > Code validity< / span >
2023-11-20 16:05:32 +03:00
< / h2 >
< p > In case of TOTP codes, a grace period of 30 seconds is applied, which
allows user to use their current and previous TOTP code, assuming 30
second validity window of each. This allows user to use code that was
about to expire before the submission. Regardless of that, each TOTP
code can be used only once. Validation procedure rejects repeat use
of the same code for safety. It's done by tracking last time a TOTP
code was used successfully, stored under < code class = "inline" > User.totp_last_used_at< / code > .< / p > < p > In case of recovery codes, each code is deleted immediately after use.
2023-12-06 14:02:03 +03:00
They are strictly one-time use only.< / p > < h2 id = "module-totp-token" class = "section-heading" >
2024-01-11 10:50:44 +03:00
< a href = "#module-totp-token" class = "hover-link" >
2023-12-06 14:02:03 +03:00
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< / a >
2024-01-11 10:50:44 +03:00
< span class = "text" > TOTP Token< / span >
2023-12-06 14:02:03 +03:00
< / h2 >
< p > TOTP token is an alternate method of authenticating user session.
It's main use case is " trust this device" functionality, where user
can decide to skip 2FA verification for a particular browser session
for next N days. The token should then be stored in an encrypted,
signed cookie with a proper expiration timestamp.< / p > < p > The token should be reset each time it either fails to match
or when other credentials (like password) are reset. This should
effectively invalidate all trusted devices for a given user.< / p >
2023-11-20 16:05:32 +03:00
< / section >
< section id = "summary" class = "details-list" >
< h1 class = "section-heading" >
< a class = "hover-link" href = "#summary" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< / a >
2024-01-11 10:50:44 +03:00
< span class = "text" > Summary< / span >
2023-11-20 16:05:32 +03:00
< / h1 >
< div class = "summary-functions summary" >
< h2 >
< a href = "#functions" > Functions< / a >
< / h2 >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#disable/2" translate = "no" > disable(user, password)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#enable/3" translate = "no" > enable(user, code, opts \\ [])< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#enabled?/1" translate = "no" > enabled?(user)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
2023-11-28 17:30:36 +03:00
< a href = "#generate_recovery_codes/1" translate = "no" > generate_recovery_codes(map)< / a >
2023-11-20 16:05:32 +03:00
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
2023-11-28 17:30:36 +03:00
< a href = "#generate_recovery_codes/2" translate = "no" > generate_recovery_codes(user, password)< / a >
2023-11-20 16:05:32 +03:00
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#initiate/1" translate = "no" > initiate(user)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
2023-11-28 17:30:36 +03:00
< a href = "#initiated?/1" translate = "no" > initiated?(user)< / a >
2023-11-20 16:05:32 +03:00
< / div >
< / div >
2023-12-06 14:02:03 +03:00
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#reset_token/1" translate = "no" > reset_token(user)< / a >
< / div >
< / div >
2023-11-20 16:05:32 +03:00
< div class = "summary-row" >
< div class = "summary-signature" >
2023-11-28 17:30:36 +03:00
< a href = "#use_recovery_code/2" translate = "no" > use_recovery_code(user, code)< / a >
2023-11-20 16:05:32 +03:00
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#validate_code/3" translate = "no" > validate_code(user, code, opts \\ [])< / a >
< / div >
< / div >
< / div >
< / section >
< section id = "functions" class = "details-list" >
< h1 class = "section-heading" >
< a class = "hover-link" href = "#functions" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< / a >
2024-01-11 10:50:44 +03:00
< span class = "text" > Functions< / span >
2023-11-20 16:05:32 +03:00
< / h1 >
< div class = "functions-list" >
< section class = "detail" id = "disable/2" >
< div class = "detail-header" >
< a href = "#disable/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > disable(user, password)< / h1 >
2023-12-06 14:02:03 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/auth/totp.ex#L170" class = "icon-action" rel = "help" title = "View Source" >
2023-11-20 16:05:32 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @spec< / span > disable(< a href = "Plausible.Auth.User.html#t:t/0" > Plausible.Auth.User.t< / a > (), < a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > ()) ::
{:ok, < a href = "Plausible.Auth.User.html#t:t/0" > Plausible.Auth.User.t< / a > ()} | {:error, :invalid_password}< / pre >
< / div >
< / section >
< / section >
< section class = "detail" id = "enable/3" >
< span id = "enable/2" > < / span >
< div class = "detail-header" >
< a href = "#enable/3" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > enable(user, code, opts \\ [])< / h1 >
2023-12-06 14:02:03 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/auth/totp.ex#L130" class = "icon-action" rel = "help" title = "View Source" >
2023-11-20 16:05:32 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
2023-12-06 14:02:03 +03:00
< pre translate = "no" > < span class = "attribute" > @spec< / span > enable(< a href = "Plausible.Auth.User.html#t:t/0" > Plausible.Auth.User.t< / a > (), < a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > () | :skip_verify, < a href = "https://hexdocs.pm/elixir/Keyword.html#t:t/0" > Keyword.t< / a > ()) ::
2023-11-28 17:30:36 +03:00
{:ok, < a href = "Plausible.Auth.User.html#t:t/0" > Plausible.Auth.User.t< / a > (), %{recovery_codes: [< a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > ()]}}
| {:error, :invalid_code | :not_initiated}< / pre >
2023-11-20 16:05:32 +03:00
< / div >
< / section >
< / section >
< section class = "detail" id = "enabled?/1" >
< div class = "detail-header" >
< a href = "#enabled?/1" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > enabled?(user)< / h1 >
2023-12-06 14:02:03 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/auth/totp.ex#L92" class = "icon-action" rel = "help" title = "View Source" >
2023-11-20 16:05:32 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @spec< / span > enabled?(< a href = "Plausible.Auth.User.html#t:t/0" > Plausible.Auth.User.t< / a > ()) :: < a href = "https://hexdocs.pm/elixir/typespecs.html#built-in-types" > boolean< / a > ()< / pre >
< / div >
< / section >
< / section >
< section class = "detail" id = "generate_recovery_codes/1" >
< div class = "detail-header" >
< a href = "#generate_recovery_codes/1" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
2023-11-28 17:30:36 +03:00
< h1 class = "signature" translate = "no" > generate_recovery_codes(map)< / h1 >
2023-11-20 16:05:32 +03:00
2023-12-06 14:02:03 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/auth/totp.ex#L213" class = "icon-action" rel = "help" title = "View Source" >
2023-11-20 16:05:32 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
2023-11-28 17:30:36 +03:00
< section class = "detail" id = "generate_recovery_codes/2" >
2023-11-20 16:05:32 +03:00
< div class = "detail-header" >
2023-11-28 17:30:36 +03:00
< a href = "#generate_recovery_codes/2" class = "detail-link" title = "Link to this function" >
2023-11-20 16:05:32 +03:00
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
2023-11-28 17:30:36 +03:00
< h1 class = "signature" translate = "no" > generate_recovery_codes(user, password)< / h1 >
2023-11-20 16:05:32 +03:00
2023-12-06 14:02:03 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/auth/totp.ex#L217" class = "icon-action" rel = "help" title = "View Source" >
2023-11-20 16:05:32 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
2023-11-28 17:30:36 +03:00
< pre translate = "no" > < span class = "attribute" > @spec< / span > generate_recovery_codes(< a href = "Plausible.Auth.User.html#t:t/0" > Plausible.Auth.User.t< / a > (), < a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > ()) ::
2023-11-20 16:05:32 +03:00
{:ok, [< a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > ()]} | {:error, :invalid_password | :not_enabled}< / pre >
< / div >
< / section >
< / section >
< section class = "detail" id = "initiate/1" >
< div class = "detail-header" >
< a href = "#initiate/1" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > initiate(user)< / h1 >
2023-12-06 14:02:03 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/auth/totp.ex#L104" class = "icon-action" rel = "help" title = "View Source" >
2023-11-20 16:05:32 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @spec< / span > initiate(< a href = "Plausible.Auth.User.html#t:t/0" > Plausible.Auth.User.t< / a > ()) ::
{:ok, < a href = "Plausible.Auth.User.html#t:t/0" > Plausible.Auth.User.t< / a > (), %{totp_uri: < a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > (), secret: < a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > ()}}
| {:error, :not_verified | :already_setup}< / pre >
< / div >
< / section >
< / section >
2023-11-28 17:30:36 +03:00
< section class = "detail" id = "initiated?/1" >
2023-11-20 16:05:32 +03:00
< div class = "detail-header" >
2023-11-28 17:30:36 +03:00
< a href = "#initiated?/1" class = "detail-link" title = "Link to this function" >
2023-11-20 16:05:32 +03:00
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
2023-11-28 17:30:36 +03:00
< h1 class = "signature" translate = "no" > initiated?(user)< / h1 >
2023-11-20 16:05:32 +03:00
2023-12-06 14:02:03 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/auth/totp.ex#L97" class = "icon-action" rel = "help" title = "View Source" >
2023-11-20 16:05:32 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
2023-11-28 17:30:36 +03:00
< pre translate = "no" > < span class = "attribute" > @spec< / span > initiated?(< a href = "Plausible.Auth.User.html#t:t/0" > Plausible.Auth.User.t< / a > ()) :: < a href = "https://hexdocs.pm/elixir/typespecs.html#built-in-types" > boolean< / a > ()< / pre >
2023-11-20 16:05:32 +03:00
< / div >
2023-12-06 14:02:03 +03:00
< / section >
< / section >
< section class = "detail" id = "reset_token/1" >
< div class = "detail-header" >
< a href = "#reset_token/1" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > reset_token(user)< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/auth/totp.ex#L200" class = "icon-action" rel = "help" title = "View Source" >
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @spec< / span > reset_token(< a href = "Plausible.Auth.User.html#t:t/0" > Plausible.Auth.User.t< / a > ()) :: < a href = "Plausible.Auth.User.html#t:t/0" > Plausible.Auth.User.t< / a > ()< / pre >
< / div >
2023-11-20 16:05:32 +03:00
< / section >
< / section >
2023-11-28 17:30:36 +03:00
< section class = "detail" id = "use_recovery_code/2" >
2023-11-20 16:05:32 +03:00
< div class = "detail-header" >
2023-11-28 17:30:36 +03:00
< a href = "#use_recovery_code/2" class = "detail-link" title = "Link to this function" >
2023-11-20 16:05:32 +03:00
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
2023-11-28 17:30:36 +03:00
< h1 class = "signature" translate = "no" > use_recovery_code(user, code)< / h1 >
2023-11-20 16:05:32 +03:00
2023-12-06 14:02:03 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/auth/totp.ex#L270" class = "icon-action" rel = "help" title = "View Source" >
2023-11-20 16:05:32 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
2023-11-28 17:30:36 +03:00
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @spec< / span > use_recovery_code(< a href = "Plausible.Auth.User.html#t:t/0" > Plausible.Auth.User.t< / a > (), < a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > ()) ::
:ok | {:error, :invalid_code | :not_enabled}< / pre >
< / div >
2023-11-20 16:05:32 +03:00
< / section >
< / section >
< section class = "detail" id = "validate_code/3" >
< span id = "validate_code/2" > < / span >
< div class = "detail-header" >
< a href = "#validate_code/3" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > validate_code(user, code, opts \\ [])< / h1 >
2023-12-06 14:02:03 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/auth/totp.ex#L258" class = "icon-action" rel = "help" title = "View Source" >
2023-11-20 16:05:32 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
2023-11-28 17:30:36 +03:00
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @spec< / span > validate_code(< a href = "Plausible.Auth.User.html#t:t/0" > Plausible.Auth.User.t< / a > (), < a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > (), < a href = "https://hexdocs.pm/elixir/Keyword.html#t:t/0" > Keyword.t< / a > ()) ::
{:ok, < a href = "Plausible.Auth.User.html#t:t/0" > Plausible.Auth.User.t< / a > ()} | {:error, :invalid_code | :not_enabled}< / pre >
< / div >
2023-11-20 16:05:32 +03:00
< / section >
< / section >
< / div >
< / section >
< footer class = "footer" >
< p >
< span class = "line" >
< button class = "a-main footer-button display-quick-switch" title = "Search HexDocs packages" >
Search HexDocs
< / button >
< a href = "Plausible.epub" title = "ePub version" >
Download ePub version
< / a >
< / span >
< / p >
< p class = "built-using" >
Built using
2024-01-16 10:41:49 +03:00
< a href = "https://github.com/elixir-lang/ex_doc" title = "ExDoc" target = "_blank" rel = "help noopener" translate = "no" > ExDoc< / a > (v0.31.1) for the
2023-11-20 16:05:32 +03:00
< a href = "https://elixir-lang.org" title = "Elixir" target = "_blank" translate = "no" > Elixir programming language< / a >
< / p >
< / footer >
< / div >
< / div >
2024-01-11 10:50:44 +03:00
< / main >
2023-11-20 16:05:32 +03:00
< / div >
< script src = "https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js" > < / script >
< script > mermaid . initialize ( { startOnLoad : true } ) < / script >
< / body >
< / html >
