Docs

SecureBlackbox 2022 macOS Edition

Version 22.0 [Build 8174]

SymmetricCrypto Module

Properties   Methods   Events   Configuration Settings   Errors  

The SymmetricCrypto module supports encrypting and decrypting messages.

Syntax

SecureBlackbox.Symmetriccrypto

Remarks

SymmetricCrypto allows you to encrypt and decrypt messages.

Property List


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

AssociatedDataProvides Associated Data for AEAD algorithms.
BlockSizeThe block size of the chosen symmetric cipher.
EncryptionAlgorithmThe encryption algorithm to use for encrypting the data.
FIPSModeReserved.
HashAlgorithmThe hash algorithm to use during encryption.
InputEncodingThe encoding to apply to the input data.
KeyThe key to use for the cryptographic operation.
KeySizeReturns the cryptographic key size in bytes.
MACAlgorithmThe (H)MAC algorithm to use during encryption.
ModeSpecifies the symmetric cipher mode of operation.
NonceSpecifies the Nonce value to employ.
OutputEncodingThe encoding to apply to the output data.
PaddingThe padding type to apply to the encrypted data.
PayloadSizeSpecifies the payload size, in bytes.
StreamCipherReturns true if the selected algorithms works as a stream cipher.
TagSizeSpecifies the AEAD tag size, in bytes.

Method List


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

ConfigSets or retrieves a configuration setting.
DecryptDecrypts a buffer.
DecryptFileDecrypts a file.
DecryptFinalFinalization of decryption by blocks.
DecryptInitInitializes a per-block decryption process.
DecryptUpdateDecrypts the next block of encrypted data.
DoActionPerforms an additional action.
EncryptEncrypts a buffer.
EncryptFileEncrypts a file.
EncryptFinalFinalization of encryption by blocks.
EncryptInitInitializes a per-block encryption process.
EncryptUpdateEncrypts the next block of data.

Event List


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

ErrorReports errors during encryption or decryption.
NotificationThis event notifies the application about an underlying control flow event.
ProgressReports the data encryption/decryption progress.

Configuration Settings


The following is a list of configuration settings for the module 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.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the module (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
TagAllows to store any custom data.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

AssociatedData Property (SymmetricCrypto Module)

Provides Associated Data for AEAD algorithms.

Syntax

public var associatedData: Data {

get {...}
set {...} }

@property (nonatomic,readwrite,assign,getter=associatedData,setter=setAssociatedData:) NSData* associatedData;

- (NSData*)associatedData;
- (void)setAssociatedData :(NSData*)newAssociatedData;

Remarks

Use this property to set up Associated Data for AEAD encryption algorithms.

BlockSize Property (SymmetricCrypto Module)

The block size of the chosen symmetric cipher.

Syntax

public var blockSize: Int32 {

get {...} }

@property (nonatomic,readonly,assign,getter=blockSize) int blockSize;

- (int)blockSize;

Default Value

0

Remarks

This property returns the block size of the chosen symmetric cipher.

Modern symmetric algorithms typically use blocks of 16 bytes. Some older algorithms, such as DES or Blowfish, use 8-byte blocks.

This property is read-only.

EncryptionAlgorithm Property (SymmetricCrypto Module)

The encryption algorithm to use for encrypting the data.

Syntax

public var encryptionAlgorithm: String {

get {...}
set {...} }

@property (nonatomic,readwrite,assign,getter=encryptionAlgorithm,setter=setEncryptionAlgorithm:) NSString* encryptionAlgorithm;

- (NSString*)encryptionAlgorithm;
- (void)setEncryptionAlgorithm :(NSString*)newEncryptionAlgorithm;

Default Value

"AES256"

Remarks

This property specifies the base symmetric algorithm to use (e.g. AES128). Use it in conjunction with Mode to set up the complete encryption scheme (such as AES128-CBC or AES128-GCM).

SB_SYMMETRIC_ALGORITHM_RC4RC4
SB_SYMMETRIC_ALGORITHM_DESDES
SB_SYMMETRIC_ALGORITHM_3DES3DES
SB_SYMMETRIC_ALGORITHM_RC2RC2
SB_SYMMETRIC_ALGORITHM_AES128AES128
SB_SYMMETRIC_ALGORITHM_AES192AES192
SB_SYMMETRIC_ALGORITHM_AES256AES256
SB_SYMMETRIC_ALGORITHM_IDENTITYIdentity
SB_SYMMETRIC_ALGORITHM_BLOWFISHBlowfish
SB_SYMMETRIC_ALGORITHM_CAST128CAST128
SB_SYMMETRIC_ALGORITHM_IDEAIDEA
SB_SYMMETRIC_ALGORITHM_TWOFISHTwofish
SB_SYMMETRIC_ALGORITHM_TWOFISH128Twofish128
SB_SYMMETRIC_ALGORITHM_TWOFISH192Twofish192
SB_SYMMETRIC_ALGORITHM_TWOFISH256Twofish256
SB_SYMMETRIC_ALGORITHM_CAMELLIACamellia
SB_SYMMETRIC_ALGORITHM_CAMELLIA128Camellia128
SB_SYMMETRIC_ALGORITHM_CAMELLIA192Camellia192
SB_SYMMETRIC_ALGORITHM_CAMELLIA256Camellia256
SB_SYMMETRIC_ALGORITHM_SERPENTSerpent
SB_SYMMETRIC_ALGORITHM_SERPENT128Serpent128
SB_SYMMETRIC_ALGORITHM_SERPENT192Serpent192
SB_SYMMETRIC_ALGORITHM_SERPENT256Serpent256
SB_SYMMETRIC_ALGORITHM_SEEDSEED
SB_SYMMETRIC_ALGORITHM_RABBITRabbit
SB_SYMMETRIC_ALGORITHM_SYMMETRICGeneric
SB_SYMMETRIC_ALGORITHM_GOST_28147_1989GOST-28147-1989
SB_SYMMETRIC_ALGORITHM_CHACHA20ChaCha20

FIPSMode Property (SymmetricCrypto Module)

Reserved.

Syntax

public var fipsMode: Bool {

get {...}
set {...} }

@property (nonatomic,readwrite,assign,getter=FIPSMode,setter=setFIPSMode:) BOOL FIPSMode;

- (BOOL)FIPSMode;
- (void)setFIPSMode :(BOOL)newFIPSMode;

Default Value

False

Remarks

This property is reserved for future use.

HashAlgorithm Property (SymmetricCrypto Module)

The hash algorithm to use during encryption.

Syntax

public var hashAlgorithm: String {

get {...}
set {...} }

@property (nonatomic,readwrite,assign,getter=hashAlgorithm,setter=setHashAlgorithm:) NSString* hashAlgorithm;

- (NSString*)hashAlgorithm;
- (void)setHashAlgorithm :(NSString*)newHashAlgorithm;

Default Value

"SHA256"

Remarks

Use this property to provide the hash algorithm to be used with the encryption operation. This only applies to certain encryption algorithms/modes.

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

InputEncoding Property (SymmetricCrypto Module)

The encoding to apply to the input data.

Syntax

public var inputEncoding: SymmetriccryptoInputEncodings {

get {...}
set {...} }

public enum SymmetriccryptoInputEncodings: Int32 { case cetDefault = 0 case cetBinary = 1 case cetBase64 = 2 case cetCompact = 3 case cetJSON = 4 }

@property (nonatomic,readwrite,assign,getter=inputEncoding,setter=setInputEncoding:) int inputEncoding;

- (int)inputEncoding;
- (void)setInputEncoding :(int)newInputEncoding;

Default Value

0

Remarks

cetDefault0The default encoding type in current circumstances. This depends on the operation and the type of the key being used.

cetBinary1Raw binary encoding (no encoding)

cetBase642Base64 encoding (armouring)

cetCompact3JSON compact encoding

cetJSON4JSON standard encoding

Key Property (SymmetricCrypto Module)

The key to use for the cryptographic operation.

Syntax

public var key: CryptoKey {

get {...}
set {...} }

@property (nonatomic,readwrite,assign,getter=keyAlgorithm,setter=setKeyAlgorithm:) NSString* keyAlgorithm;

- (NSString*)keyAlgorithm;
- (void)setKeyAlgorithm :(NSString*)newKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=keyBits) int keyBits;

- (int)keyBits;

@property (nonatomic,readwrite,assign,getter=keyCurve,setter=setKeyCurve:) NSString* keyCurve;

- (NSString*)keyCurve;
- (void)setKeyCurve :(NSString*)newKeyCurve;

@property (nonatomic,readonly,assign,getter=keyExportable) BOOL keyExportable;

- (BOOL)keyExportable;

@property (nonatomic,readwrite,assign,getter=keyHandle,setter=setKeyHandle:) long long keyHandle;

- (long long)keyHandle;
- (void)setKeyHandle :(long long)newKeyHandle;

@property (nonatomic,readwrite,assign,getter=keyID,setter=setKeyID:) NSData* keyID;

- (NSData*)keyID;
- (void)setKeyID :(NSData*)newKeyID;

@property (nonatomic,readwrite,assign,getter=keyIV,setter=setKeyIV:) NSData* keyIV;

- (NSData*)keyIV;
- (void)setKeyIV :(NSData*)newKeyIV;

@property (nonatomic,readonly,assign,getter=keyKey) NSData* keyKey;

- (NSData*)keyKey;

@property (nonatomic,readwrite,assign,getter=keyNonce,setter=setKeyNonce:) NSData* keyNonce;

- (NSData*)keyNonce;
- (void)setKeyNonce :(NSData*)newKeyNonce;

@property (nonatomic,readonly,assign,getter=keyPrivate) BOOL keyPrivate;

- (BOOL)keyPrivate;

@property (nonatomic,readonly,assign,getter=keyPublic) BOOL keyPublic;

- (BOOL)keyPublic;

@property (nonatomic,readwrite,assign,getter=keySubject,setter=setKeySubject:) NSData* keySubject;

- (NSData*)keySubject;
- (void)setKeySubject :(NSData*)newKeySubject;

@property (nonatomic,readonly,assign,getter=keySymmetric) BOOL keySymmetric;

- (BOOL)keySymmetric;

@property (nonatomic,readonly,assign,getter=keyValid) BOOL keyValid;

- (BOOL)keyValid;

 

Default Value

16

Remarks

Use this property to specify/customize the tag size for AEAD encryption.

KeySize Property (SymmetricCrypto Module)

Returns the cryptographic key size in bytes.

Syntax

public var keySize: Int32 {

get {...} }

@property (nonatomic,readonly,assign,getter=keySize) int keySize;

- (int)keySize;

Default Value

0

Remarks

Use this property to read the cryptographic key size. For the majority of the symmetric algorithms this is hard-coded in the algorithm itself (such as 16 bytes for AES128), but may be variable for certain exceptions, such as Blowfish or RC4.

This property is read-only.

MACAlgorithm Property (SymmetricCrypto Module)

The (H)MAC algorithm to use during encryption.

Syntax

public var macAlgorithm: String {

get {...}
set {...} }

@property (nonatomic,readwrite,assign,getter=MACAlgorithm,setter=setMACAlgorithm:) NSString* MACAlgorithm;

- (NSString*)MACAlgorithm;
- (void)setMACAlgorithm :(NSString*)newMACAlgorithm;

Default Value

""

Remarks

Use this property to configure the HMAC algorithm to use with the encryption operation. This only applies to a small subset of algorithms/modes.

SB_MAC_ALGORITHM_HMAC_SHA1SHA1
SB_MAC_ALGORITHM_HMAC_SHA256SHA256
SB_MAC_ALGORITHM_HMAC_SHA512SHA512

Mode Property (SymmetricCrypto Module)

Specifies the symmetric cipher mode of operation.

Syntax

public var mode: SymmetriccryptoModes {

get {...}
set {...} }

public enum SymmetriccryptoModes: Int32 { case scmDefault = 0 case scmECB = 1 case scmCBC = 2 case scmCTR = 3 case scmCFB8 = 4 case scmGCM = 5 case scmCCM = 6 case scmPoly1305 = 7 }

@property (nonatomic,readwrite,assign,getter=mode,setter=setMode:) int mode;

- (int)mode;
- (void)setMode :(int)newMode;

Default Value

0

Remarks

Use this property to specify the mode of operation as required by your environment. The default setting is CBC.

scmDefault0The default mode in current circumstances.

scmECB1ECB (electronic code book) mode. This is insecure, unless you know how to use it right.

scmCBC2CBC (cipher block chaining mode)

scmCTR3Counter mode

scmCFB84Cipher feedback mode

scmGCM5Galois counter mode

scmCCM6CCM mode

Nonce Property (SymmetricCrypto Module)

Specifies the Nonce value to employ.

Syntax

public var nonce: Data {

get {...}
set {...} }

@property (nonatomic,readwrite,assign,getter=nonce,setter=setNonce:) NSData* nonce;

- (NSData*)nonce;
- (void)setNonce :(NSData*)newNonce;

Remarks

Use this property to specify the Nonce value for the symmetric operation. Not every algorithm or mode uses nonce.

OutputEncoding Property (SymmetricCrypto Module)

The encoding to apply to the output data.

Syntax

public var outputEncoding: SymmetriccryptoOutputEncodings {

get {...}
set {...} }

public enum SymmetriccryptoOutputEncodings: Int32 { case cetDefault = 0 case cetBinary = 1 case cetBase64 = 2 case cetCompact = 3 case cetJSON = 4 }

@property (nonatomic,readwrite,assign,getter=outputEncoding,setter=setOutputEncoding:) int outputEncoding;

- (int)outputEncoding;
- (void)setOutputEncoding :(int)newOutputEncoding;

Default Value

0

Remarks

cetDefault0The default encoding type in current circumstances. This depends on the operation and the type of the key being used.

cetBinary1Raw binary encoding (no encoding)

cetBase642Base64 encoding (armouring)

cetCompact3JSON compact encoding

cetJSON4JSON standard encoding

Padding Property (SymmetricCrypto Module)

The padding type to apply to the encrypted data.

Syntax

public var padding: SymmetriccryptoPaddings {

get {...}
set {...} }

public enum SymmetriccryptoPaddings: Int32 { case scpNone = 0 case scpPKCS5 = 1 case scpANSIX923 = 2 }

@property (nonatomic,readwrite,assign,getter=padding,setter=setPadding:) int padding;

- (int)padding;
- (void)setPadding :(int)newPadding;

Default Value

1

Remarks

Use this property to specify the padding type to use with the encrypted data. A padding type commonly used in modern security environments is PKCS#5.

scpNone0No padding. You might need to adjust the length of the input data to align it by the encryption block boundary.

scpPKCS51Standard PKCS5 (sometimes also referred to as PKCS7) padding

scpANSIX9232ANSI X.923 padding

PayloadSize Property (SymmetricCrypto Module)

Specifies the payload size, in bytes.

Syntax

public var payloadSize: Int32 {

get {...}
set {...} }

@property (nonatomic,readwrite,assign,getter=payloadSize,setter=setPayloadSize:) int payloadSize;

- (int)payloadSize;
- (void)setPayloadSize :(int)newPayloadSize;

Default Value

0

Remarks

Use this property to specify the size of the input data in bytes. This is only used by a subset of algorithms/modes, such as CCM.

StreamCipher Property (SymmetricCrypto Module)

Returns true if the selected algorithms works as a stream cipher.

Syntax

public var streamCipher: Bool {

get {...} }

@property (nonatomic,readonly,assign,getter=streamCipher) BOOL streamCipher;

- (BOOL)streamCipher;

Default Value

False

Remarks

This property returns true if the selected algorithm processes data as a stream (byte-by-byte), rather than block-by-block. This affects the need to use a proper padding settings.

This property is read-only.

TagSize Property (SymmetricCrypto Module)

Specifies the AEAD tag size, in bytes.

Syntax

public var tagSize: Int32 {

get {...}
set {...} }

@property (nonatomic,readwrite,assign,getter=tagSize,setter=setTagSize:) int tagSize;

- (int)tagSize;
- (void)setTagSize :(int)newTagSize;

Default Value

16

Remarks

Use this property to specify/customize the tag size for AEAD encryption.

Config Method (SymmetricCrypto Module)

Sets or retrieves a configuration setting.

Syntax

public func config(configurationString: String) throws -> String
- (NSString*)config:(NSString*)configurationString;

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Decrypt Method (SymmetricCrypto Module)

Decrypts a buffer.

Syntax

public func decrypt(buffer: Data) throws -> Data
- (NSData*)decrypt:(NSData*)buffer;

Remarks

Use this method to decrypt a byte array and get the encrypted message in another byte array.

Specify the decryption key in Key property.

DecryptFile Method (SymmetricCrypto Module)

Decrypts a file.

Syntax

public func decryptFile(sourceFile: String, destFile: String) throws -> Void
- (void)decryptFile:(NSString*)sourceFile :(NSString*)destFile;

Remarks

Use this method to decrypt an encrypted file and save the decrypted data to another file.

Specify the decryption key in Key property before calling this method.

DecryptFinal Method (SymmetricCrypto Module)

Finalization of decryption by blocks.

Syntax

public func decryptFinal() throws -> Data
- (NSData*)decryptFinal;

Remarks

Use this method to finalize of decryption by blocks.

Specify decryption key in Key property.

DecryptInit Method (SymmetricCrypto Module)

Initializes a per-block decryption process.

Syntax

public func decryptInit() throws -> Void
- (void)decryptInit;

Remarks

Use this method to start a block-by-block decryption process.

Specify the decryption key in Key property before starting the decryption.

DecryptUpdate Method (SymmetricCrypto Module)

Decrypts the next block of encrypted data.

Syntax

public func decryptUpdate(buffer: Data) throws -> Data
- (NSData*)decryptUpdate:(NSData*)buffer;

Remarks

When using block-by-block decryption, pass every subsequent block of the encrypted message to this method until the entire message is processed. For each encrypted block the method returns a piece of decrypted data.

Please note that in general case there is no direct correspondence between the data actually contained in the encrypted block with the output of this method. The component may choose to cache a piece of the provided buffer internally if it doesn't constitute a full block of encrypted data.

Remember to call DecryptInit before calling this method to prepare the control for the decryption process.

DoAction Method (SymmetricCrypto Module)

Performs an additional action.

Syntax

public func doAction(actionID: String, actionParams: String) throws -> String
- (NSString*)doAction:(NSString*)actionID :(NSString*)actionParams;

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Encrypt Method (SymmetricCrypto Module)

Encrypts a buffer.

Syntax

public func encrypt(buffer: Data) throws -> Data
- (NSData*)encrypt:(NSData*)buffer;

Remarks

Use this method to encrypt a byte array and get the protected message in another byte array.

Specify the encryption key in Key property before calling this method.

This is a one-off encryption method. Don't use it with granular per-block methods (EncryptInit, EncryptUpdate, EncryptFinal).

EncryptFile Method (SymmetricCrypto Module)

Encrypts a file.

Syntax

public func encryptFile(sourceFile: String, destFile: String) throws -> Void
- (void)encryptFile:(NSString*)sourceFile :(NSString*)destFile;

Remarks

Use this method to encrypt a file and save the protected message in another file.

Specify the encryption key in Key property before commencing encryption.

EncryptFinal Method (SymmetricCrypto Module)

Finalization of encryption by blocks.

Syntax

public func encryptFinal() throws -> Data
- (NSData*)encryptFinal;

Remarks

Use this method to finalize of encryption by blocks.

Specify encryption key in Key property.

EncryptInit Method (SymmetricCrypto Module)

Initializes a per-block encryption process.

Syntax

public func encryptInit() throws -> Void
- (void)encryptInit;

Remarks

Use this method to initialize a block-by-block encryption process. Follow it with calls to EncryptUpdate (as many as needed), and complete the encryption with an EncryptFinal call.

Specify the encryption key in Key property before calling this method.

EncryptUpdate Method (SymmetricCrypto Module)

Encrypts the next block of data.

Syntax

public func encryptUpdate(buffer: Data) throws -> Data
- (NSData*)encryptUpdate:(NSData*)buffer;

Remarks

Use this method to encrypt the next block of data contained in Buffer.

Call this method after calling EncryptInit for as many times as needed, until the whole volume of data is processed. Having done that, call EncryptFinal to complete the encryption and get the terminating encrypted trailer.

Error Event (SymmetricCrypto Module)

Reports errors during encryption or decryption.

Syntax

func onError(errorCode: Int32, description: String)
- (void)onError:(int)errorCode :(NSString*)description;

Remarks

class fires this event in case of exceptional conditions during a cryptographic operation.

ErrorCode contains an error code and Description contains a textual description of the error.

Notification Event (SymmetricCrypto Module)

This event notifies the application about an underlying control flow event.

Syntax

func onNotification(eventID: String, eventParam: String)
- (void)onNotification:(NSString*)eventID :(NSString*)eventParam;

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

Progress Event (SymmetricCrypto Module)

Reports the data encryption/decryption progress.

Syntax

func onProgress(total: Int64, current: Int64, cancel: inout Bool)
- (void)onProgress:(long long)total :(long long)current :(int*)cancel;

Remarks

This event fires periodically during a file encrypt/decrypt operation to report its progress.

Use the Cancel parameter to terminate the encryption/decryption if needed.

CryptoKey Type

This container represents a cryptographic key.

Remarks

This type is a universal placeholder for cryptographic keys.

Fields

algorithm
String

The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key. Public key algorithms: RSA, ECDSA, Elgamal, DH.

SB_SYMMETRIC_ALGORITHM_RC4RC4
SB_SYMMETRIC_ALGORITHM_DESDES
SB_SYMMETRIC_ALGORITHM_3DES3DES
SB_SYMMETRIC_ALGORITHM_RC2RC2
SB_SYMMETRIC_ALGORITHM_AES128AES128
SB_SYMMETRIC_ALGORITHM_AES192AES192
SB_SYMMETRIC_ALGORITHM_AES256AES256
SB_SYMMETRIC_ALGORITHM_IDENTITYIdentity
SB_SYMMETRIC_ALGORITHM_BLOWFISHBlowfish
SB_SYMMETRIC_ALGORITHM_CAST128CAST128
SB_SYMMETRIC_ALGORITHM_IDEAIDEA
SB_SYMMETRIC_ALGORITHM_TWOFISHTwofish
SB_SYMMETRIC_ALGORITHM_TWOFISH128Twofish128
SB_SYMMETRIC_ALGORITHM_TWOFISH192Twofish192
SB_SYMMETRIC_ALGORITHM_TWOFISH256Twofish256
SB_SYMMETRIC_ALGORITHM_CAMELLIACamellia
SB_SYMMETRIC_ALGORITHM_CAMELLIA128Camellia128
SB_SYMMETRIC_ALGORITHM_CAMELLIA192Camellia192
SB_SYMMETRIC_ALGORITHM_CAMELLIA256Camellia256
SB_SYMMETRIC_ALGORITHM_SERPENTSerpent
SB_SYMMETRIC_ALGORITHM_SERPENT128Serpent128
SB_SYMMETRIC_ALGORITHM_SERPENT192Serpent192
SB_SYMMETRIC_ALGORITHM_SERPENT256Serpent256
SB_SYMMETRIC_ALGORITHM_SEEDSEED
SB_SYMMETRIC_ALGORITHM_RABBITRabbit
SB_SYMMETRIC_ALGORITHM_SYMMETRICGeneric
SB_SYMMETRIC_ALGORITHM_GOST_28147_1989GOST-28147-1989
SB_SYMMETRIC_ALGORITHM_CHACHA20ChaCha20

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

bits
Int32

The length of the key in bits.

curve
String

This property specifies the name of the curve the EC key is built on.

exportable
Bool

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

handle
Int64

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

id
Data

Provides access to a storage-specific key identifier. Key identifiers are used by cryptographic providers to refer to a particular key and/or distinguish between different keys. They are typically unique within a storage, but there is no guarantee that a particular cryptoprovider will conform to that (or will assign any key IDs at all).

iv
Data

The initialization vector (IV) of a symmetric key. This is normally a public part of a symmetric key, the idea of which is to introduce randomness to the encrypted data and/or serve as a first block in chaining ciphers.

key
Data

The byte array representation of the key. This may not be available for non- keys.

nonce
Data

A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.

private_
Bool

Returns True if the object hosts a private key, and False otherwise.

public_
Bool

Returns True if the object hosts a public key, and False otherwise.

subject
Data

Returns the key subject. This is a cryptoprovider-dependent value, which normally aims to provide some user-friendly insight into the key owner.

symmetric
Bool

Returns True if the object contains a symmetric key, and False otherwise.

valid
Bool

Returns True if this key is valid. The term Valid highly depends on the kind of the key being stored. A symmetric key is considered valid if its length fits the algorithm being set. The validity of an RSA key also ensures that the RSA key elements (primes, exponents, and modulus) are consistent.

Constructors

public init()

Creates an empty crypto key object.

Configuration Settings (SymmetricCrypto Module)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

SymmetricCrypto Configuration Settings

Compress:   Specifies whether the JSON output should be compressed.

Use this configuration setting to specify that the output should be presented in the compressed form.

CTRLittleEndian:   Specifies whether the little-endian representation should be employed in CTR mode.

Use this setting to enable the little-endian representation when encrypting/decrypting in counter mode.

TempPath:   Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored.

Base Configuration Settings

CheckKeyIntegrityBeforeUse:   Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching:   Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:

offNo caching (default)
localLocal caching (supported for HTTPClient, RESTClient and SOAPClient only)
globalGlobal caching

Cookies:   Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations:   Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

EnableClientSideSSLFFDHE:   Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies:   Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global".

HttpUserAgent:   Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (supported for VCL for Windows and .Net)

LogDetails:   Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll details

LogFile:   Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters:   Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

exclude-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude a method specified in the value

LogFlushMode:   Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel:   Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore detailed information.

LogMaxEventCount:   Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode:   Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength:   Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth:   Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm:   Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

UseSharedSystemStorages:   Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemOAEPAndPSS:   Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom:   Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (SymmetricCrypto Module)

SymmetricCrypto Errors

1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2022 macOS Edition - Version 22.0 [Build 8174]