SourceSecretGenerateRules#

pydantic model phalanx.models.secrets.SourceSecretGenerateRules#

Rules for generating a secret from another secret.

Parameters:: data (Any)

Show JSON schema

{
   "title": "SourceSecretGenerateRules",
   "description": "Rules for generating a secret from another secret.",
   "type": "object",
   "properties": {
      "type": {
         "description": "Type of secret",
         "enum": [
            "bcrypt-password-hash",
            "mtime"
         ],
         "title": "Secret type",
         "type": "string"
      },
      "source": {
         "description": "Key of secret on which this secret is based. This may only be set by secrets of type ``bcrypt-password-hash`` or ``mtime``.",
         "title": "Source key",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "type",
      "source"
   ]
}

Config:

extra: str = forbid
populate_by_name: bool = True
validate_by_alias: bool = True
validate_by_name: bool = True

Fields:

source (str)
type (Literal[phalanx.models.secrets.SecretGenerateType.bcrypt_password_hash, phalanx.models.secrets.SecretGenerateType.mtime])

field source: str [Required]#: Key of secret on which this secret is based. This may only be set by secrets of type bcrypt-password-hash or mtime.

field type: Literal[<SecretGenerateType.bcrypt_password_hash: 'bcrypt-password-hash'>, <SecretGenerateType.mtime: 'mtime'>] [Required]#: Type of secret

generate(source)#

Generate a new secret following these rules.

Parameters:: source (SecretStr) – Source secret from which to generate the secret.
Returns:: New secret.
Return type:: pydantic.SecretStr

property always_generate: bool#: Whether to always generate this secret.