From 23a663fcf94cc139b1d5e86bcd28d506cab09f5c Mon Sep 17 00:00:00 2001 From: Ken Keller <104874953+mister-ken@users.noreply.github.com> Date: Fri, 13 Dec 2024 09:38:09 -0600 Subject: [PATCH] mfa login/totp (#29094) * initial commit * update mfa/totp --- website/content/docs/auth/login-mfa/index.mdx | 67 ++++++++++++++++++- 1 file changed, 66 insertions(+), 1 deletion(-) diff --git a/website/content/docs/auth/login-mfa/index.mdx b/website/content/docs/auth/login-mfa/index.mdx index 139f375d2d..dfff6f3dc4 100644 --- a/website/content/docs/auth/login-mfa/index.mdx +++ b/website/content/docs/auth/login-mfa/index.mdx @@ -232,8 +232,73 @@ $ vault write -non-interactive sys/mfa/validate -format=json @payload.json To get started with Login MFA, refer to the [Login MFA](/vault/tutorials/auth-methods/multi-factor-authentication) tutorial. +### Time-based One-time Password (TOTP) -### TOTP passcode validation rate limit +Enable a Login MFA method to enforce TOTP on the LDAP auth method. + + + + Authenticator applications are not consistent in their support of encryption algorithms. You should research the algorithms supported by your preferred authenticator app. The [Configure TOTP MFA Method documentation](/vault/api-docs/secret/identity/mfa/totp#algorithm) lists algorithms supported by the Login MFA TOTP method. Google Authenticator supports SHA256. + + + +Configure the Login MFA TOTP method and note down the resulting `method_id`. + +```shell-session +$ vault write identity/mfa/method/totp \ + generate=true \ + issuer=Vault \ + period=30 \ + key_size=30 \ + algorithm=SHA256 \ + digits=6 +``` + +Using the TOTP `method_id` and an `entity_id` from after a sucessful MFA login. Use these to generate a QR code. + +```shell-session +$ vault write -field=barcode \ + /identity/mfa/method/totp/admin-generate \ + method_id=$TOTP_METHOD_ID entity_id=$ENTITY_ID \ + | base64 -d > qr-code.png +``` + +#### Create login MFA enforcement + +Capture the LDAP auth method accessor for use in creating a Login MFA enforcement. + +```shell-session +$ vault auth list -format=json --detailed +``` + +Using the accessor from the previous step and a `method_id` apply the enforcement. + +```shell-session +$ VAULT_TOKEN=root vault write /identity/mfa/login-enforcement/adtotp \ + mfa_method_ids=$TOTP_METHOD_ID \ + auth_method_accessors=$ACCESSOR +``` + +**Successful output example:** + + + +```plaintext +Success! Data written to: identity/mfa/login-enforcement/adtotp +``` + + + +#### Login with LDAP auth method + +Logging in with MFA enforcement will resemble the following: + +```shell-session +$ vault login -method=ldap username=alice password='password!' +Enter the passphrase for methodID "01194a79-e2d9-c038-029d-79b0091cafd0" of type "totp": +``` + +#### TOTP passcode validation rate limit Rate limiting of Login MFA paths are enforced by default in Vault 1.10.1 and above. By default, Vault allows for 5 consecutive failed TOTP passcode validation.