age.recipients package

Submodules

age.recipients.base module

class age.recipients.base.Recipient

Bases: object

DECRYPTION_KEY_TYPE: Type[age.keys.base.DecryptionKey]

ENCRYPTION_KEY_TYPE: Type[age.keys.base.EncryptionKey]

TAG: str

abstract decrypt(key)

Parameters

key (DecryptionKey) –

Return type

bytes

abstract dump()

Return type

Tuple[List[str], str]

abstract classmethod generate(key, file_key)

Parameters

• key (EncryptionKey) –

• file_key (bytes) –

abstract classmethod load(args, body)

Parameters

• args (List[str]) –

• body (str) –

age.recipients.helpers module

age.recipients.helpers.decrypt_file_key(recipients, keys)

Parameters

• recipients (Collection[Recipient]) –

• keys (Collection[DecryptionKey]) –

Return type

bytes

age.recipients.helpers.generate_recipient_from_key(key, file_key)

Parameters

• key (EncryptionKey) –

• file_key (bytes) –

Return type

Recipient

age.recipients.helpers.get_recipient(type, arguments, body)

Parameters

• type (str) –

• arguments (List[str]) –

• body (str) –

Return type

Recipient

age.recipients.scrypt module

class age.recipients.scrypt.SCryptRecipient(salt, log_cost, encrypted_file_key)

Bases: age.recipients.base.Recipient

Parameters

• salt (bytes) –

• log_cost (int) –

• encrypted_file_key (bytes) –

DECRYPTION_KEY_TYPE

alias of age.keys.password.PasswordKey

ENCRYPTION_KEY_TYPE

alias of age.keys.password.PasswordKey

TAG: str = 'scrypt'

decrypt(password_key)

Parameters

password_key (DecryptionKey) –

Return type

bytes

dump()

Return type

Tuple[List[str], str]

classmethod generate(password_key, file_key)

Parameters

• password_key (EncryptionKey) –

• file_key (bytes) –

classmethod load(args, body)

Parameters

• args (List[str]) –

• body (str) –

age.recipients.ssh_ed25519 module

class age.recipients.ssh_ed25519.SSHED25519Recipient(fingerprint, derived_secret, encrypted_file_key)

Bases: age.recipients.base.Recipient

Parameters

• fingerprint (bytes) –

• derived_secret (NewType()(ECPoint, bytes)) –

• encrypted_file_key (bytes) –

DECRYPTION_KEY_TYPE

alias of age.keys.ed25519.Ed25519PrivateKey

ENCRYPTION_KEY_TYPE

alias of age.keys.ed25519.Ed25519PublicKey

TAG: str = 'ssh-ed25519'

decrypt(password_key)

Parameters

password_key (DecryptionKey) –

Return type

bytes

dump()

Return type

Tuple[List[str], str]

classmethod generate(password_key, file_key)

Parameters

• password_key (EncryptionKey) –

• file_key (bytes) –

classmethod load(args, body)

Parameters

• args (List[str]) –

• body (str) –

age.recipients.ssh_rsa module

class age.recipients.ssh_rsa.SSHRSARecipient(fingerprint, encrypted_file_key)

Bases: age.recipients.base.Recipient

Parameters

• fingerprint (bytes) –

• encrypted_file_key (bytes) –

DECRYPTION_KEY_TYPE

alias of age.keys.rsa.RSAPrivateKey

ENCRYPTION_KEY_TYPE

alias of age.keys.rsa.RSAPublicKey

TAG: str = 'ssh-rsa'

decrypt(password_key)

Parameters

password_key (DecryptionKey) –

Return type

bytes

dump()

Return type

Tuple[List[str], str]

classmethod generate(password_key, file_key)

Parameters

• password_key (EncryptionKey) –

• file_key (bytes) –

classmethod load(args, body)

Parameters

• args (List[str]) –

• body (str) –

age.recipients.x25519 module

class age.recipients.x25519.X25519Recipient(derived_secret, encrypted_file_key)

Bases: age.recipients.base.Recipient

Parameters

• derived_secret (NewType()(ECPoint, bytes)) –

• encrypted_file_key (bytes) –

DECRYPTION_KEY_TYPE

alias of age.keys.agekey.AgePrivateKey

ENCRYPTION_KEY_TYPE

alias of age.keys.agekey.AgePublicKey

TAG: str = 'X25519'

decrypt(private_key)

Parameters

private_key (DecryptionKey) –

Return type

bytes

dump()

Return type

Tuple[List[str], str]

classmethod generate(public_key, file_key)

Parameters

• public_key (EncryptionKey) –

• file_key (bytes) –

classmethod load(args, body)

Parameters

• args (List[str]) –

• body (str) –

Module contents