SecureBlackbox Lite 2020 Python Edition

Questions / Feedback?

SymmetricCrypto Class

Properties   Methods   Events   Configuration Settings   Errors  

The SymmetricCrypto class supports encrypting and decrypting messages.

Syntax

class secureblackboxlite.SymmetricCrypto

Remarks

SymmetricCrypto allows you to encrypt and decrypt messages.

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

associated_dataProvides Associated Data for AEAD algorithms.
block_sizeThe block size of the chosen symmetric cipher.
encryption_algorithmThe encryption algorithm to use for encrypting the data.
hash_algorithmThe hash algorithm to use during encryption.
input_encodingThe encoding to apply to the input data.
key_algorithmThe algorithm of the cryptographic key.
key_bitsThe length of the key in bits.
key_exportableReturns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
key_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
key_idProvides access to a storage-specific key identifier.
key_ivThe initialization vector (IV) of a symmetric key.
key_keyThe byte array representation of the key.
key_nonceA nonce value associated with a key.
key_privateReturns True if the object hosts a private key, and False otherwise.
key_publicReturns True if the object hosts a public key, and False otherwise.
key_subjectReturns the key subject.
key_symmetricReturns True if the object contains a symmetric key, and False otherwise.
key_validReturns True if this key is valid.
key_sizeReturns the cryptographic key size in bytes.
mac_algorithmThe (H)MAC algorithm to use during encryption.
modeSpecifies the symmetric cipher mode of operation.
nonceSpecifies the Nonce value to employ.
output_encodingThe encoding to apply to the output data.
paddingThe padding type to apply to the encrypted data.
payload_sizeSpecifies the payload size, in bytes.
stream_cipherReturns true if the selected algorithms works as a stream cipher.
tag_sizeSpecifies the AEAD tag size, in bytes.

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

configSets or retrieves a configuration setting.
decryptDecrypts a buffer.
decrypt_fileDecrypts a file.
decrypt_finalFinalization of decryption by blocks.
decrypt_initInitializes a per-block decryption process.
decrypt_updateDecrypts the next block of encrypted data.
encryptEncrypts a buffer.
encrypt_fileEncrypts a file.
encrypt_finalFinalization of encryption by blocks.
encrypt_initInitializes a per-block encryption process.
encrypt_updateEncrypts the next block of data.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

on_errorReports errors during encryption or decryption.
on_notificationThis event notifies the application about an underlying control flow event.
on_progressReports the data encryption/decryption progress.

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

CompressSpecifies whether the JSON output should be compressed.
CTRLittleEndianSpecifies whether the little-endian representation should be employed in CTR mode.
TempPathPath for storing temporary files.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox Lite 2020 Python Edition - Version 20.0 [Build 8166]