vault icon indicating copy to clipboard operation
vault copied to clipboard

Duo MFA Configuration Documentation Error

Open bmendric opened this issue 2 years ago • 2 comments

Describe the bug Incorrect documentation for Duo MFA configuration

To Reproduce Steps to reproduce the behavior:

  1. Read https://www.vaultproject.io/api-docs/secret/identity/mfa/duo#parameters
  2. Attempt to configure an MFA endpoint using a username_template
  3. Read the configuration on the server and see that username_format is not defined

Expected behavior Attempting to set the username_format as part of the initial provision request actually works to set the value, therefore, this is simply a documentation problem on that page.

Looks like the documentation for the Terraform Provider is correct, though -- https://registry.terraform.io/providers/hashicorp/vault/latest/docs/resources/mfa_duo#username_format

Environment:

  • Vault Server Version (retrieve with vault status): 1.10.2
  • Vault CLI Version (retrieve with vault version): 1.10.2
  • Server Operating System/Architecture: Ubuntu 18.04 running within a Docker container

Vault server configuration file(s):

N/A

bmendric avatar May 09 '22 16:05 bmendric

The same documentation issue is present on the tutorial for PingID MFA as well. https://developer.hashicorp.com/vault/tutorials/secrets-management/multi-factor-authentication

Vault 1.11 at least gives a warning saying that username_template is an unknown parameter:

image

Vault 1.10 didn't give that warning, which made debugging why MFA wasn't working a nightmare for me because I assumed it was getting configured correctly.

leviathanbadger avatar Jul 12 '22 17:07 leviathanbadger

How does one determine what values are available in the template? Left blank, I get a strange ID created in DUO that I can't determine the source in vault.

zachfi avatar Sep 13 '22 20:09 zachfi