Docs

SecureBlackbox 2022 macOS Edition

Version 22.0 [Build 8174]

Utils Module

Properties   Methods   Events   Configuration Settings   Errors  

The Utils module provides base functionality.

Syntax

SecureBlackbox.Utils

Remarks

TBD

Property List


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

NameValuePairsTBD.

Method List


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

Base64DecodeTBD.
Base64EncodeTBD.
Base64EncodeLinesTBD.
Base64UrlDecodeTBD.
Base64UrlEncodeTBD.
BytesToStringTBD.
ConfigSets or retrieves a configuration setting.
DateToStringTBD.
DoActionPerforms an additional action.
GetLocalDNSNameTBD.
GetLocalIPTBD.
GetLocalIPsTBD.
GetRemoteIPTBD.
GetRemoteIPsTBD.
GetValueByNameTBD.
HexDecodeTBD.
HexEncodeTBD.
IndexOfNameTBD.
LoadNameValuePairsTBD.
OidToStringTBD.
SaveNameValuePairsTBD.
SetValueByNameTBD.
StringToBytesTBD.
StringToDateTBD.
StringToOidTBD.
UrlDecodeTBD.
UrlEncodeTBD.

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.

ErrorInforms about errors during cryptographic operations.
NotificationThis event notifies the application about an underlying control flow event.

Configuration Settings


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

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.

NameValuePairs Property (Utils Module)

TBD.

Syntax

public var nameValuePairs: Array<StringNameValuePair> {

get {...} }

@property (nonatomic,readwrite,assign,getter=nameValuePairCount,setter=setNameValuePairCount:) int nameValuePairCount;

- (int)nameValuePairCount;
- (void)setNameValuePairCount :(int)newNameValuePairCount;

- (NSString*)nameValuePairName:(int)nameValuePairIndex;
- (void)setNameValuePairName:(int)nameValuePairIndex :(NSString*)newNameValuePairName;

- (NSString*)nameValuePairValue:(int)nameValuePairIndex;
- (void)setNameValuePairValue:(int)nameValuePairIndex :(NSString*)newNameValuePairValue;

 

Default Value

""

Remarks

Base64Decode Method (Utils Module)

TBD.

Syntax

public func base64Decode(value: String) throws -> Data
- (NSData*)base64Decode:(NSString*)value;

Remarks

TBD

Base64Encode Method (Utils Module)

TBD.

Syntax

public func base64Encode(bytes: Data) throws -> String
- (NSString*)base64Encode:(NSData*)bytes;

Remarks

TBD

Base64EncodeLines Method (Utils Module)

TBD.

Syntax

public func base64EncodeLines(bytes: Data, lineLen: Int32) throws -> String
- (NSString*)base64EncodeLines:(NSData*)bytes :(int)lineLen;

Remarks

TBD

Base64UrlDecode Method (Utils Module)

TBD.

Syntax

public func base64UrlDecode(value: String) throws -> Data
- (NSData*)base64UrlDecode:(NSString*)value;

Remarks

TBD

Base64UrlEncode Method (Utils Module)

TBD.

Syntax

public func base64UrlEncode(bytes: Data) throws -> String
- (NSString*)base64UrlEncode:(NSData*)bytes;

Remarks

TBD

BytesToString Method (Utils Module)

TBD.

Syntax

public func bytesToString(bytes: Data) throws -> String
- (NSString*)bytesToString:(NSData*)bytes;

Remarks

TBD

Config Method (Utils 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.

DateToString Method (Utils Module)

TBD.

Syntax

public func dateToString(value: Date) throws -> String
- (NSString*)dateToString:(NSDate*)value;

Remarks

TBD

DoAction Method (Utils 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;....

GetLocalDNSName Method (Utils Module)

TBD.

Syntax

public func getLocalDNSName() throws -> String
- (NSString*)getLocalDNSName;

Remarks

TBD

GetLocalIP Method (Utils Module)

TBD.

Syntax

public func getLocalIP(iPv6: Bool) throws -> String
- (NSString*)getLocalIP:(BOOL)IPv6;

Remarks

TBD

GetLocalIPs Method (Utils Module)

TBD.

Syntax

public func getLocalIPs(iPv4: Bool, iPv6: Bool) throws -> String
- (NSString*)getLocalIPs:(BOOL)IPv4 :(BOOL)IPv6;

Remarks

TBD

GetRemoteIP Method (Utils Module)

TBD.

Syntax

public func getRemoteIP(hostName: String, iPv6: Bool) throws -> String
- (NSString*)getRemoteIP:(NSString*)hostName :(BOOL)IPv6;

Remarks

TBD

GetRemoteIPs Method (Utils Module)

TBD.

Syntax

public func getRemoteIPs(hostName: String, iPv4: Bool, iPv6: Bool) throws -> String
- (NSString*)getRemoteIPs:(NSString*)hostName :(BOOL)IPv4 :(BOOL)IPv6;

Remarks

TBD

GetValueByName Method (Utils Module)

TBD.

Syntax

public func getValueByName(name: String) throws -> String
- (NSString*)getValueByName:(NSString*)name;

Remarks

TBD

HexDecode Method (Utils Module)

TBD.

Syntax

public func hexDecode(value: String) throws -> Data
- (NSData*)hexDecode:(NSString*)value;

Remarks

TBD

HexEncode Method (Utils Module)

TBD.

Syntax

public func hexEncode(bytes: Data) throws -> String
- (NSString*)hexEncode:(NSData*)bytes;

Remarks

TBD

IndexOfName Method (Utils Module)

TBD.

Syntax

public func indexOfName(name: String) throws -> Int32
- (int)indexOfName:(NSString*)name;

Remarks

TBD

LoadNameValuePairs Method (Utils Module)

TBD.

Syntax

public func loadNameValuePairs(data: String, nameValueSeparators: String, pairSeparators: String, trimValues: Bool) throws -> Void
- (void)loadNameValuePairs:(NSString*)data :(NSString*)nameValueSeparators :(NSString*)pairSeparators :(BOOL)trimValues;

Remarks

TBD

OidToString Method (Utils Module)

TBD.

Syntax

public func oidToString(bytes: Data) throws -> String
- (NSString*)oidToString:(NSData*)bytes;

Remarks

TBD

SaveNameValuePairs Method (Utils Module)

TBD.

Syntax

public func saveNameValuePairs(nameValueSeparator: String, pairSeparator: String) throws -> String
- (NSString*)saveNameValuePairs:(NSString*)nameValueSeparator :(NSString*)pairSeparator;

Remarks

TBD

SetValueByName Method (Utils Module)

TBD.

Syntax

public func setValueByName(name: String, value: String) throws -> Int32
- (int)setValueByName:(NSString*)name :(NSString*)value;

Remarks

TBD

StringToBytes Method (Utils Module)

TBD.

Syntax

public func stringToBytes(value: String) throws -> Data
- (NSData*)stringToBytes:(NSString*)value;

Remarks

TBD

StringToDate Method (Utils Module)

TBD.

Syntax

public func stringToDate(value: String) throws -> Date
- (NSDate*)stringToDate:(NSString*)value;

Remarks

TBD

StringToOid Method (Utils Module)

TBD.

Syntax

public func stringToOid(value: String) throws -> Data
- (NSData*)stringToOid:(NSString*)value;

Remarks

TBD

UrlDecode Method (Utils Module)

TBD.

Syntax

public func urlDecode(value: String) throws -> String
- (NSString*)urlDecode:(NSString*)value;

Remarks

TBD

UrlEncode Method (Utils Module)

TBD.

Syntax

public func urlEncode(value: String) throws -> String
- (NSString*)urlEncode:(NSString*)value;

Remarks

TBD

Error Event (Utils Module)

Informs about errors during cryptographic operations.

Syntax

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

Remarks

Class fires this event if an error happens during a cryptographic operation.

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

Notification Event (Utils 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.

StringNameValuePair Type

A simple name-value pair object.

Remarks

The class represents a name-value string pair used in a variety of network components.

Fields

name
String

The name element in a (name, value) pair.

value
String

The value element in a (name, value) pair.

Constructors

public init(name: String, value: String)

Creates a name-value pair from a name and a value.

public init()

Creates an empty name-value object.

Configuration Settings (Utils 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.

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 (Utils Module)

Utils 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]