Skip to main content
  1. Docs
  2. Secrets & Configuration
  3. Providers
  4. Rotators
  5. passphrase

passphrase

    The passphrase rotator enables you to rotate any user-defined key in your ESC environment by generating memorable passphrases.

    If you want to generate random passwords use the password rotator

    Inputs

    PropertyTypeDescription
    separatorstringA single character used as the word separator. (default: -)
    capitalizebooleanWhether to capitalize each generated word. (default: false)
    lengthintThe number of words in the generated passphrase (3–15). (default: 5)

    Example

    The passphrase rotator can be configured for any user-defined key.

    values:
      mypassphrase:
        fn::rotate::passphrase:
          inputs:
            separator: "%"
            capitalize: true
            length: 4
    

    This configuration will generate passphrases like Mouth%Purebred%Headstone%Plausibly.

    When you open the environment, you should see output similar to the following:

    {
      "mypassphrase": {
        "current": "[secret]",
        "previous": "[secret]"
      }
    }
    

    State (Optional)

    PropertyTypeDescription
    currentstringThe most recently generated passphrase.
    previousstringThe prior generated passphrase.

    Outputs

    PropertyTypeDescription
    currentstringThe most recently generated passphrase, stored as a secret.
    previousstringThe prior generated passphrase, stored as a secret.

    Troubleshooting

    SymptomLikely causeResolution
    Rotation fails with an invalid input errorlength is outside 3–15, or separator is not a single character.Set length within range and separator to a single character, then rotate again.
    The generated passphrase is shorter or longer than expectedlength counts words, not characters.Adjust length to the desired number of words; the character count varies with the words chosen.