Core

Cipher

Encryption/helper utility.

6 public methods

Import

from Xenonix.Core import Cipher

Search this API

Filter methods, arguments, and configuration keys on this page.

Configuration

Use Config(...) with these keys where the class exposes configuration.

This object does not expose a public Config table.

Public methods

Create

Creates a new Cipher instance.

Create(Key)

Arguments

Argument	Default	Accepted values	What it does
`Key`	Required	Any valid value	Key value used by the operation.

Output

Creates a new Cipher object.

Generate

Runs the Generate operation for Cipher.

Generate(Key_Bytes=32)

Arguments

Argument	Default	Accepted values	What it does
`Key_Bytes`	`32`	Any valid value	Key Bytes value used by the operation.

Output

Returns the calculated result.

Encrypt

Runs the Encrypt operation for Cipher.

Encrypt(Data)

Arguments

Argument	Default	Accepted values	What it does
`Data`	Required	Any valid value	Dataset path or dataset definition.

Output

Returns the calculated result.

Decrypt

Runs the Decrypt operation for Cipher.

Decrypt(Data)

Arguments

Argument	Default	Accepted values	What it does
`Data`	Required	Any valid value	Dataset path or dataset definition.

Output

Returns the calculated result.

Encrypt_File

Runs the Encrypt_File operation for Cipher.

Encrypt_File(Path, Output=None)

Arguments

Argument	Default	Accepted values	What it does
`Path`	Required	Any valid value	File path used for reading or writing.
`Output`	`None`	Any valid value	Controls whether the operation returns a new object or modifies the current one.

Output

Returns True/False to indicate success.

Decrypt_File

Runs the Decrypt_File operation for Cipher.

Decrypt_File(Path, Output=None)

Arguments

Argument	Default	Accepted values	What it does
`Path`	Required	Any valid value	File path used for reading or writing.
`Output`	`None`	Any valid value	Controls whether the operation returns a new object or modifies the current one.

Output

Returns True/False to indicate success.