ORIONIS API REFERENCE

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)

Known subclasses: orionis.encrypter.Encrypter

View In Hierarchy

Define the contract for encrypter implementations.

Method decrypt Decrypt an encrypted payload using the configured cipher algorithm.
Method encrypt Encrypt plaintext using the configured cipher algorithm.
Class Variable __slots__ Declare that this class introduces no additional instance slots.
@abstractmethod
def decrypt(self, payload: str) -> str: (source)

Decrypt an encrypted payload using the configured cipher algorithm.

Parameters
payload:strBase64-encoded encrypted payload containing IV, value, tag, and cipher.
Returns
strThe decrypted plaintext as a UTF-8 string.
Raises
TypeErrorIf payload is not a string.
ValueErrorIf payload is empty or invalid.
RuntimeErrorIf decryption fails.
@abstractmethod
def encrypt(self, plaintext: str) -> str: (source)

Encrypt plaintext using the configured cipher algorithm.

Parameters
plaintext:strThe text to encrypt.
Returns
strBase64-encoded encrypted payload containing IV, value, tag, and cipher.
Raises
TypeErrorIf plaintext is not a string.
ValueErrorIf plaintext is empty or has encoding issues.
RuntimeErrorIf encryption fails.
__slots__: tuple = (source)

Declare that this class introduces no additional instance slots.