Skip to content

Crypto

crypto

bi_sdk.crypto.aesgcm_decrypt

aesgcm_decrypt(key, value, associated_data=None)

AESGCM decryptor function.

Parameters:

Name Type Description Default
key bytes

Encryption key

required
value bytes

Value to decrypt

required
associated_data bytes

Associated data to use for decryption

None

Returns:

Type Description
bytes

Decrypted value (bytes)

bi_sdk.crypto.aesgcm_decrypt_hex

aesgcm_decrypt_hex(key, value, associated_data=None)

Decrypt a value using AESGCM and return the result as a hex string.i

Parameters:

Name Type Description Default
key bytes

Encryption key

required
value str

Value to decrypt

required
associated_data bytes

Associated data to use for decryption

None

Returns:

Type Description
str

Decrypted value (str)

bi_sdk.crypto.aesgcm_encrypt

aesgcm_encrypt(key, value, nonce=None, associated_data=None)

AESGCM encryptor function.

Parameters:

Name Type Description Default
key bytes

Encryption key

required
value bytes

Value to encrypt

required
nonce bytes

Optional nonce to use for encryption. If not provided, a random nonce will be generated.

None
associated_data list[bytes]

Associated data to use for encryption

None

Returns:

Type Description
bytes

Nonce (bytes) + Encrypted value (bytes)

bi_sdk.crypto.aesgcm_encrypt_hex

aesgcm_encrypt_hex(key, value, nonce=None, associated_data=None)

Encrypt a value using AESGCM and return the result as a hex string.

Parameters:

Name Type Description Default
key bytes

Encryption key

required
value bytes

Value to encrypt

required
nonce bytes

Optional nonce to use for encryption. If not provided, a random nonce will be generated.

None
associated_data bytes

Associated data to use for encryption

None

Returns:

Type Description
str

Encrypted value (str)

bi_sdk.crypto.decode_key

decode_key(key)

Decode a key from a hex string.

Parameters:

Name Type Description Default
key bytes

Key to decode

required

Returns:

Type Description
bytes

Decoded key (bytes)

bi_sdk.crypto.encode_key

encode_key(key)

Encode a key to a hex string.

Parameters:

Name Type Description Default
key bytes

Key to encode

required

Returns:

Type Description
bytes

Encoded key (bytes)

bi_sdk.crypto.hash_number

hash_number(key, value)

Hash a number using HMAC-SHA256.

Parameters:

Name Type Description Default
key bytes

Hashing key

required
value int

Value to hash

required

Returns:

Type Description
bytes

Hashed value (bytes)

bi_sdk.crypto.hash_word

hash_word(key, value)

Hash a word using HMAC-SHA256.

Parameters:

Name Type Description Default
key bytes

Hashing key

required
value bytes

Value to hash

required

Returns:

Type Description
bytes

Hashed value (bytes)