orionis.encrypter.contracts.IEncrypter

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

class documentation

class IEncrypter(ABC): (source)

Undocumented

Method	`decrypt`	Decrypt an encrypted payload using the configured cipher algorithm.
Method	`encrypt`	Encrypt plaintext using the configured cipher algorithm.
Class Variable	`__slots__`	Undocumented

@abstractmethod

def decrypt(self, payload: str) -> str: (source) ¶

overridden in orionis.encrypter.Encrypter

Decrypt an encrypted payload using the configured cipher algorithm.

Parameters
payload:`str`	Base64-encoded encrypted payload containing IV, value, tag, and cipher.

Returns
`str`	The decrypted plaintext as a UTF-8 string.

Raises
`TypeError`	If payload is not a string.
`ValueError`	If payload is empty or invalid.
`RuntimeError`	If decryption fails.

@abstractmethod

def encrypt(self, plaintext: str) -> str: (source) ¶

overridden in orionis.encrypter.Encrypter

Encrypt plaintext using the configured cipher algorithm.

Parameters
plaintext:`str`	The text to encrypt.

Returns
`str`	Base64-encoded encrypted payload containing IV, value, tag, and cipher.

Raises
`TypeError`	If plaintext is not a string.
`ValueError`	If plaintext is empty or has encoding issues.
`RuntimeError`	If encryption fails.

overridden in orionis.encrypter.Encrypter

Undocumented