SymmetricCrypto Class
Properties Methods Events Configuration Settings Errors
The SymmetricCrypto class supports encrypting and decrypting messages.
Syntax
SecureBlackboxSymmetricCrypto
SecureBlackboxSymmetricCryptoSwift
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.
| - associatedData | Provides Associated Data for AEAD algorithms. |
| - blockSize | The block size of the chosen symmetric cipher. |
| - encryptionAlgorithm | The encryption algorithm to use for encrypting the data. |
| - hashAlgorithm | The hash algorithm to use during encryption. |
| - inputEncoding | The encoding to apply to the input data. |
| - keyAlgorithm | The algorithm of the cryptographic key. |
| - keyBits | The length of the key in bits. |
| - keyExportable | Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise. |
| - keyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| - keyID | Provides access to a storage-specific key identifier. |
| - keyIV | The initialization vector (IV) of a symmetric key. |
| - keyKey | The byte array representation of the key. |
| - keyNonce | A nonce value associated with a key. |
| - keyPrivate | Returns True if the object hosts a private key, and False otherwise. |
| - keyPublic | Returns True if the object hosts a public key, and False otherwise. |
| - keySubject | Returns the key subject. |
| - keySymmetric | Returns True if the object contains a symmetric key, and False otherwise. |
| - keyValid | Returns True if this key is valid. |
| - keySize | Returns the cryptographic key size in bytes. |
| - MACAlgorithm | The (H)MAC algorithm to use during encryption. |
| - mode | Specifies the symmetric cipher mode of operation. |
| - nonce | Specifies the Nonce value to employ. |
| - outputEncoding | The encoding to apply to the output data. |
| - padding | The padding type to apply to the encrypted data. |
| - payloadSize | Specifies the payload size, in bytes. |
| - streamCipher | Returns true if the selected algorithms works as a stream cipher. |
| - tagSize | Specifies 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.
| - config | Sets or retrieves a configuration setting. |
| - decrypt | Decrypts a buffer. |
| - decryptFile | Decrypts a file. |
| - decryptFinal | Finalization of decryption by blocks. |
| - decryptInit | Initializes a per-block decryption process. |
| - decryptUpdate | Decrypts the next block of encrypted data. |
| - encrypt | Encrypts a buffer. |
| - encryptFile | Encrypts a file. |
| - encryptFinal | Finalization of encryption by blocks. |
| - encryptInit | Initializes a per-block encryption process. |
| - encryptUpdate | Encrypts 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.
| - onError | Reports errors during encryption or decryption. |
| - onNotification | This event notifies the application about an underlying control flow event. |
| - onProgress | Reports 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.
| Compress | Specifies whether the JSON output should be compressed. |
| CTRLittleEndian | Specifies whether the little-endian representation should be employed in CTR mode. |
| TempPath | Path for storing temporary files. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |