Skip to main content

🧩 Secret types

A secret's type decides which fields it has, which of them are secret, and what Sneakers-PAM can do with it: check it against a target (the heartbeat), change it on the target (rotation), or lend it to one person at a time (check-out). Sneakers-PAM ships with the 22 types below. They're read-only: nobody can edit or delete a built-in type, but a site admin can clone one into a custom type on the admin console's Secret types page, and install the extension packs.

TypeSecret fieldsHeartbeatRotationCheck-outTakes a target
PasswordPasswordNoNoNoNo
Secure NoteNoteNoNoNoNo
Web PasswordPasswordNoNoNoNo
SSH KeyPrivate Key, PassphraseYesNoYesYes
API TokenTokenNoNoNoNo
OAuth ApplicationClient Secret, Access Token, Refresh TokenNoNoNoNo
Recovery / Backup CodesRecovery / Backup CodesNoNoNoNo
Database AccountPasswordYesYesNoYes
Password Account (SSH)PasswordNoNoNoYes
Windows Account (Local)PasswordYesYesYesYes
Windows Domain AccountPasswordYesYesYesYes
Active Directory AccountPasswordYesYesYesYes
Bank AccountAccount number, Routing number, Online passwordNoNoNoNo
Credit CardCard number, CVVNoNoNoNo
License KeyLicense keyNoNoNoNo
Combination LockCombinationNoNoNoNo
PINPINNoNoNoNo
Social Security NumberSSNNoNoNoNo
ContactEmail, PhoneNoNoNoNo
Anthropic TokenTokenNoNoNoNo
SSL/PKI CertificatePrivate KeyNoNoNoNo
GitHub AppClient Secret, Private Key (PEM), Webhook SecretNoNoNoNo
Heartbeat and rotation need a connector adapter

A type marked for heartbeat or rotation still needs an adapter in the connector for its target's protocol. LDAP, LDAPS, Kerberos and SSH work today; WinRM and SAMR are registered but report the target as unreachable, and there is no database adapter yet. Each type's page says what works.

🔤 Field kinds​

KindWhat it holds
TextPlain text, shown to anyone who can see the secret.
Password (can be generated)A secret password. The editor can generate one from the folder's password policy, and rotation changes it.
Secret value (never generated)A fixed secret, such as a key or a token: masked and revealed like a password, never generated or rotated.
Multi-line textLonger text, such as notes or a certificate. Secret only where the type marks it so.
ChoiceOne of a fixed list of options.
Yes or noA flag.

A Choice field only takes one of its type's own options: creating or editing a secret with anything else is refused, naming the field and listing the options to pick from. A value stored before this was enforced still reads back as it was; the next save on that field has to pick a valid option.

🔐 Secret and super-sensitive fields​

  • Sensitive fields are masked everywhere. Revealing or copying one is a deliberate act, written to the audit trail, and a site admin can require a fresh second factor first (security settings).
  • Super-sensitive fields (a card number and CVV, a PIN, the SSN, a certificate's private key, a bank account's numbers and online password) also show a partial mask before the whole value, and service accounts and personal tokens can't read them unless a site admin turns on Allow API access to sensitive secrets.

🔄 Changing a secret's type​

A secret can move to another type, from the staff app, with a preview of where each field goes before anything changes. No value is ever dropped: a value with no field in the new type moves to the notes, or the change is refused. A secret value only moves into a secret field, and a super-sensitive one only into a super-sensitive field. See Changing a secret's type for the steps.

These pages match the vault's built-in catalogue at commit d68f3e0e, the one v0.1.0-rc.7 ships.