Utils Component

Properties Methods Events Config Settings Errors

The Utils component offers a selection of popular helper methods that may be of use in a variety of scenarios.

Syntax

TsbxUtils

Remarks

If you need to resolve a hostname to an IP address, encode a string using a specific character encoding, or compose a multipart message, look no further. This is exactly what Utils is intended for.

Property List

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


MultipartPartCount	The number of records in the MultipartPart arrays.
MultipartPartContentDescription	Provides a description for the part ( Content-Description header property).
MultipartPartContentDisposition	Specifies the disposition of the part ( Content-Disposition header property).
MultipartPartContentID	Specifies the ID of the part ( Content-ID header property).
MultipartPartContentTransferEncoding	Specifies the transfer encoding for the part ( Content-Transfer-Encoding header property).
MultipartPartContentType	Specifies the content type of the part ( Content-Type header property).
MultipartPartCustomHeaders	Assign any custom HTTP headers to be added to the part header.
MultipartPartFieldName	Specifies the property name of the form part ( name parameter in Content-Disposition header property).
MultipartPartFieldValue	Specifies the property value of the form part (the part's content).
MultipartPartFilename	Specifies the filename for the form part ( filename parameter in Content-Disposition header property).
MultipartPartHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
NameValuePairCount	The number of records in the NameValuePair arrays.
NameValuePairCategory	Specifies the string category of the contained value.
NameValuePairFormat	Specifies the format (encoding) of the value contained in the Value property.
NameValuePairName	The name element in a (name, value) pair.
NameValuePairValue	The value element in a (name, value) pair.

Method List

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


AddPartFromBytes	Adds a new part to MultipartMessage from the specified byte array.
AddPartFromFile	Adds a new part to MultipartMessage from the specified file.
Base64Decode	Decodes a base64 string to a byte array.
Base64Encode	Encodes a byte array in base64.
Base64EncodeLines	Encodes the Bytes array containing binary data to a multi-line Base64.
Config	Sets or retrieves a configuration setting.
DateToString	Converts a variable of Date type to the respective string representation.
DoAction	Performs an additional action.
GetLocalDNSName	Returns the DNS name of the local system.
GetLocalIP	Returns the primary IP address of the local system.
GetLocalIPs	Returns a list of local IP addresses.
GetPartToBytes	Saves the data from the specified part to a byte array.
GetPartToFile	Saves the data from the specified part to a file.
GetRemoteIP	Gets the IP address of a remote host.
GetRemoteIPs	Resolves IP addresses available for a hostname.
GetValueByName	Returns the value from the (name, value) pair list for the requested name.
HexDecode	Decodes a hex-encoded string into a byte array.
HexEncode	Encodes a byte array to hex string.
IndexOfName	Returns the index of the (name, value) pair in the list for the requested Name.
LoadMultipartFromBytes	Loads a multipart message from the specified byte array to MultipartMessage .
LoadMultipartFromFile	Loads a multipart message from the specified file to MultipartMessage .
LoadNameValuePairs	Loads a list of (name, value) pairs from a string.
OidToString	Converts a binary-encoded ASN.1 OID to its string representation.
RemoveNameValuePair	Remove a (name, value) pair by name.
SaveMultipartContentType	Returns the value for Content-Type field.
SaveMultipartToBytes	Saves the parts contained in MultipartMessage to a byte array.
SaveMultipartToFile	Saves the parts contained in MultipartMessage to the file.
SaveNameValuePairs	Serializes the (name, value) pair list to a string.
SetValueByName	Adds or updates the (name, value) pair by a name.
StringDecode	Converts a byte array to a string using a chosen encoding.
StringEncode	Encodes a string to a byte array using a chosen character encoding.
StringToDate	Converts a date represented by a string to a respective Date object.
StringToOid	Converts string OID representation to an ASN.1 byte array.
UrlDecode	Decodes a URLEncoded string back into its original form.
UrlEncode	Encodes the provided string using URLEncode.

Event List

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


Error	Informs about errors during cryptographic operations.
Notification	This event notifies the application about an underlying control flow event.

Config Settings

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


MultipartBoundary	Returns the boundary string used to save the last multipart message.
MultipartCharset	Specifies the charset to be used to encode the field names and the filenames of the multipart message.
RelatedStart	Identifies the starting body part or root.
RelatedStartInfo	Contains additional information required for unpacking or processing of the content.
RelatedType	Contains media type/subtype of message's content.
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 component.
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.
StaticDNS	Specifies whether static DNS rules should be used.
StaticIPAddress[domain]	Gets or sets an IP address for the specified domain name.
StaticIPAddresses	Gets or sets all the static DNS rules.
Tag	Allows to store any custom data.
TLSSessionGroup	Specifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetime	Specifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeInterval	Specifies how often the session cache should remove the expired TLS sessions.
UseOwnDNSResolver	Specifies whether the client components 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.

MultipartPartCount Property (Utils Component)

The number of records in the MultipartPart arrays.

Syntax

__property int MultipartPartCount = { read=FMultipartPartCount, write=FSetMultipartPartCount };

Default Value

Remarks

This property controls the size of the following arrays:

MultipartPartContentDescription
MultipartPartContentDisposition
MultipartPartContentID
MultipartPartContentTransferEncoding
MultipartPartContentType
MultipartPartCustomHeaders
MultipartPartFieldName
MultipartPartFieldValue
MultipartPartFilename
MultipartPartHandle

The array indices start at 0 and end at MultipartPartCount - 1.

This property is not available at design time.

Data Type

Integer

MultipartPartContentDescription Property (Utils Component)

Provides a description for the part ( Content-Description header property).

Syntax

__property String MultipartPartContentDescription[int MultipartPartIndex] = { read=FMultipartPartContentDescription, write=FSetMultipartPartContentDescription };

Default Value

Remarks

Provides a description for the part (Content-Description header field)

The MultipartPartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartPartCount property.

This property is not available at design time.

Data Type

String

MultipartPartContentDisposition Property (Utils Component)

Specifies the disposition of the part ( Content-Disposition header property).

Syntax

__property String MultipartPartContentDisposition[int MultipartPartIndex] = { read=FMultipartPartContentDisposition, write=FSetMultipartPartContentDisposition };

Default Value

Remarks

Specifies the disposition of the part (Content-Disposition header field)

The MultipartPartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartPartCount property.

This property is not available at design time.

Data Type

String

MultipartPartContentID Property (Utils Component)

Specifies the ID of the part ( Content-ID header property).

Syntax

__property String MultipartPartContentID[int MultipartPartIndex] = { read=FMultipartPartContentID, write=FSetMultipartPartContentID };

Default Value

Remarks

Specifies the ID of the part (Content-ID header field)

The MultipartPartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartPartCount property.

This property is not available at design time.

Data Type

String

MultipartPartContentTransferEncoding Property (Utils Component)

Specifies the transfer encoding for the part ( Content-Transfer-Encoding header property).

Syntax

__property String MultipartPartContentTransferEncoding[int MultipartPartIndex] = { read=FMultipartPartContentTransferEncoding, write=FSetMultipartPartContentTransferEncoding };

Default Value

Remarks

Specifies the transfer encoding for the part (Content-Transfer-Encoding header field)

The MultipartPartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartPartCount property.

This property is not available at design time.

Data Type

String

MultipartPartContentType Property (Utils Component)

Specifies the content type of the part ( Content-Type header property).

Syntax

__property String MultipartPartContentType[int MultipartPartIndex] = { read=FMultipartPartContentType, write=FSetMultipartPartContentType };

Default Value

Remarks

Specifies the content type of the part (Content-Type header field)

The MultipartPartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartPartCount property.

This property is not available at design time.

Data Type

String

MultipartPartCustomHeaders Property (Utils Component)

Assign any custom HTTP headers to be added to the part header.

Syntax

__property String MultipartPartCustomHeaders[int MultipartPartIndex] = { read=FMultipartPartCustomHeaders, write=FSetMultipartPartCustomHeaders };

Default Value

Remarks

Assign any custom HTTP headers to be added to the part header.

The MultipartPartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartPartCount property.

This property is not available at design time.

Data Type

String

MultipartPartFieldName Property (Utils Component)

Specifies the property name of the form part ( name parameter in Content-Disposition header property).

Syntax

__property String MultipartPartFieldName[int MultipartPartIndex] = { read=FMultipartPartFieldName, write=FSetMultipartPartFieldName };

Default Value

Remarks

Specifies the field name of the form part (name parameter in Content-Disposition header field).

The MultipartPartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartPartCount property.

This property is not available at design time.

Data Type

String

MultipartPartFieldValue Property (Utils Component)

Specifies the property value of the form part (the part's content).

Syntax

__property String MultipartPartFieldValue[int MultipartPartIndex] = { read=FMultipartPartFieldValue, write=FSetMultipartPartFieldValue };

Default Value

Remarks

Specifies the field value of the form part (the part's content).

The MultipartPartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartPartCount property.

This property is not available at design time.

Data Type

String

MultipartPartFilename Property (Utils Component)

Specifies the filename for the form part ( filename parameter in Content-Disposition header property).

Syntax

__property String MultipartPartFilename[int MultipartPartIndex] = { read=FMultipartPartFilename, write=FSetMultipartPartFilename };

Default Value

Remarks

Specifies the filename for the form part (filename parameter in Content-Disposition header field).

The MultipartPartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartPartCount property.

This property is not available at design time.

Data Type

String

MultipartPartHandle Property (Utils Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 MultipartPartHandle[int MultipartPartIndex] = { read=FMultipartPartHandle, write=FSetMultipartPartHandle };

Default Value

Remarks

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());

The MultipartPartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartPartCount property.

This property is not available at design time.

Data Type

Long64

NameValuePairCount Property (Utils Component)

The number of records in the NameValuePair arrays.

Syntax

__property int NameValuePairCount = { read=FNameValuePairCount, write=FSetNameValuePairCount };

Default Value

Remarks

This property controls the size of the following arrays:

NameValuePairCategory
NameValuePairFormat
NameValuePairName
NameValuePairValue

The array indices start at 0 and end at NameValuePairCount - 1.

This property is not available at design time.

Data Type

Integer

NameValuePairCategory Property (Utils Component)

Specifies the string category of the contained value.

Syntax

__property String NameValuePairCategory[int NameValuePairIndex] = { read=FNameValuePairCategory, write=FSetNameValuePairCategory };

Default Value

Remarks

Specifies the string category of the contained value.

This property allows to check or set the category (or type) associated with the contained value. Depending on the format used to load or save the string, the category parameter may or may not be used.

For example, for ASN.1 property lists the category contains the ASN.1 tag of the contained data (OCTETSTRING, UTF8STRING, INTEGER, ...). For basic (name, value) pairs, such as HTTP headers, the category parameter is not used.

The NameValuePairIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NameValuePairCount property.

This property is not available at design time.

Data Type

String

NameValuePairFormat Property (Utils Component)

Specifies the format (encoding) of the value contained in the Value property.

Syntax

__property int NameValuePairFormat[int NameValuePairIndex] = { read=FNameValuePairFormat, write=FSetNameValuePairFormat };

Default Value

Remarks

Specifies the format (encoding) of the value contained in the NameValuePairValue property.

Use this property to check or set the format of the contained value. Remember to provide the actual value in the appropriate format that matches this setting: utils.NameValuePairs[0].Name = "key"; utils.NameValuePairs[0].Format = svfBinary; utils.NameValuePairs[0].Name = "0a1b2c3d4e5f6071";

The following formats are currently supported:


svfText	`0`	The property contains text
svfBinary	`1`	The property contains binary data. The Value property contains a hex encoding of it.

The NameValuePairIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NameValuePairCount property.

This property is not available at design time.

Data Type

Integer

NameValuePairName Property (Utils Component)

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

Syntax

__property String NameValuePairName[int NameValuePairIndex] = { read=FNameValuePairName, write=FSetNameValuePairName };

Default Value

Remarks

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

The NameValuePairIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NameValuePairCount property.

This property is not available at design time.

Data Type

String

NameValuePairValue Property (Utils Component)

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

Syntax

__property String NameValuePairValue[int NameValuePairIndex] = { read=FNameValuePairValue, write=FSetNameValuePairValue };

Default Value

Remarks

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

The NameValuePairIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NameValuePairCount property.

This property is not available at design time.

Data Type

String

AddPartFromBytes Method (Utils Component)

Adds a new part to MultipartMessage from the specified byte array.

Syntax

int __fastcall AddPartFromBytes(DynamicArray<Byte> Data);

Remarks

The method adds a new part to MultipartMessage list with the specified data as the part's content.

Returns the index of the added part.

AddPartFromFile Method (Utils Component)

Adds a new part to MultipartMessage from the specified file.

Syntax

int __fastcall AddPartFromFile(String Filename);

Remarks

The method adds a new part to MultipartMessage list with the specified file data as the part's content.

Returns the index of the added part.

Base64Decode Method (Utils Component)

Decodes a base64 string to a byte array.

Syntax

DynamicArray<Byte> __fastcall Base64Decode(String Value, bool UseURLEncoding);

Remarks

Use this method to decode a base64-encoded string to a byte array. The UseURLEncoding parameter specifies whether the URL-Base64 modification should be used when decoding the string. byte[] arr = utils.Base64Decode("SGVsbG8sIHdvcmxkIQ==", false);

Base64Encode Method (Utils Component)

Encodes a byte array in base64.

Syntax

String __fastcall Base64Encode(DynamicArray<Byte> Bytes, bool UseURLEncoding);

Remarks

Use this method to encode binary data contained in Bytes to a base64 string. The UseURLEncoding parameter specifies whether additional URL encoding should be applied to the resulting string (with + and / characters replaced with - and _, respectively). string encoded = utils.Base64Encode(buf, false);

Base64EncodeLines Method (Utils Component)

Encodes the Bytes array containing binary data to a multi-line Base64.

Syntax

String __fastcall Base64EncodeLines(DynamicArray<Byte> Bytes, int LineLen);

Remarks

Use this method to encode large amounts of binary data to multi-line base64 strings. Use LineLen parameter to provide the maximal length of each base64 line.

Config Method (Utils Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 Component)

Converts a variable of Date type to the respective string representation.

Syntax

String __fastcall DateToString(TDateTime Value);

Remarks

Use this method to convert a value of a platform date type to a string representation accepted by various SecureBlackbox methods and properties.

DoAction Method (Utils Component)

Performs an additional action.

Syntax

String __fastcall DoAction(String ActionID, String ActionParams);

Remarks

DoAction is a generic method available in every component. 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 (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

GetLocalDNSName Method (Utils Component)

Returns the DNS name of the local system.

Syntax

String __fastcall GetLocalDNSName();

Remarks

Use this property to get the registered DNS or network name of the local system.

GetLocalIP Method (Utils Component)

Returns the primary IP address of the local system.

Syntax

String __fastcall GetLocalIP(bool IPv6);

Remarks

Use this method to obtain the default IP address of the local system.

GetLocalIPs Method (Utils Component)

Returns a list of local IP addresses.

Syntax

String __fastcall GetLocalIPs(bool IPv4, bool IPv6);

Remarks

Use this method to request a list of all local IP addresses available in the system. Set IPv4 and IPv6 as required to filter IPv4 and IPv6 interfaces in or out respectively.

GetPartToBytes Method (Utils Component)

Saves the data from the specified part to a byte array.

Syntax

DynamicArray<Byte> __fastcall GetPartToBytes(int Index);

Remarks

Use this method to store the data of the specified part to a byte array.

Index must be greater than or equal to 0, and less than the part count.

GetPartToFile Method (Utils Component)

Saves the data from the specified part to a file.

Syntax

void __fastcall GetPartToFile(int Index, String Filename);

Remarks

Use this method to store the data of the specified part to a file.

Index must be greater than or equal to 0, and less than the part count.

GetRemoteIP Method (Utils Component)

Gets the IP address of a remote host.

Syntax

String __fastcall GetRemoteIP(String HostName, bool IPv6, int DNSMode, String DNSServers, int Timeout);

Remarks

Use this property to resolve the address of a remote host using the provided DNS settings. Set IPv6 to true to force resolution of both IPv4 and IPv6 addresses.

Use the Timeout setting to specify maximal resolution time, and the DNSServer parameter to list the addresses of DNS servers to use for address resolution. Separate individual servers in the list with commas or semicolons. If an empty server list is provided, the component will use the list of servers configured in the system.

Use one of the below DNS modes:


dmAuto	`0`
dmPlatform	`1`
dmOwn	`2`
dmOwnSecure	`3`

GetRemoteIPs Method (Utils Component)

Resolves IP addresses available for a hostname.

Syntax

String __fastcall GetRemoteIPs(String HostName, bool IPv4, bool IPv6, int DNSMode, String DNSServers, int Timeout);

Remarks

Use this method to resolve all IP addresses available for the chosen hostname using the provided DNS settings. Use the Timeout setting to specify maximal resolution time. The DNSServer parameter lists the addresses of DNS servers to use for address resolution, separated with commas or semicolons. If an empty server list is provided, the component will use the list of servers configured in the system.

Use one of the below DNS modes:


dmAuto	`0`
dmPlatform	`1`
dmOwn	`2`
dmOwnSecure	`3`

GetValueByName Method (Utils Component)

Returns the value from the (name, value) pair list for the requested name.

Syntax

String __fastcall GetValueByName(String Name);

Remarks

Use this method to obtain a matching value for the requested Name in the NameValuePairs list.

HexDecode Method (Utils Component)

Decodes a hex-encoded string into a byte array.

Syntax

DynamicArray<Byte> __fastcall HexDecode(String Value);

Remarks

Use this method to decode hex- (base16-) encoded strings to byte arrays. byte[] buf = utils.HexDecode("48656C6C6F2C20776F726C6421");

HexEncode Method (Utils Component)

Encodes a byte array to hex string.

Syntax

String __fastcall HexEncode(DynamicArray<Byte> Bytes);

Remarks

Use this method to encode a byte array, passed as Bytes, to a hex (base16) string.

IndexOfName Method (Utils Component)

Returns the index of the (name, value) pair in the list for the requested Name.

Syntax

int __fastcall IndexOfName(String Name);

Remarks

Use this method to obtain the index of the (Name, Value) object in NameValuePairs list.

LoadMultipartFromBytes Method (Utils Component)

Loads a multipart message from the specified byte array to MultipartMessage .

Syntax

void __fastcall LoadMultipartFromBytes(String ContentType, DynamicArray<Byte> Data);

Remarks

Use this method to load a multipart message from a byte array to MultipartMessage. You need to provide the content of the Content-Type header field together with the multipart body stored in the byte array.

After the data is loaded, you can get the data of each part by calling GetPartToBytes/GetPartToFile/GetPartToStream methods.

While loading data, the parts data is stored in temporary files/streams. If the TempPath config property is not empty, the parts data is stored to temporary files in that folder, otherwise the data is stored in memory streams.

LoadMultipartFromFile Method (Utils Component)

Loads a multipart message from the specified file to MultipartMessage .

Syntax

void __fastcall LoadMultipartFromFile(String ContentType, String Filename);

Remarks

Use this method to load a multipart message from a file to MultipartMessage. You need to provide the content of the Content-Type header field together with the multipart body stored in the file.

After the file is loaded, you can get the data of each part by calling GetPartToBytes/GetPartToFile/GetPartToStream methods.

LoadNameValuePairs Method (Utils Component)

Loads a list of (name, value) pairs from a string.

Syntax

void __fastcall LoadNameValuePairs(String Data, String Format, String NameValueSeparator, String PairSeparator, bool TrimValues);

Remarks

Use this method to load a list of (name, value) pairs to NameValuePairs from a string. Provide one of the known formats via Format, and optionally pass the separators using NameValueSeparator and PairSeparator parameters.

The following pre-defined pair list formats are currently supported:

rdn: a textual distinguished name encoding (/C=US/S=NC/O=Big Company)
rdnbinary: a hex-encoded DER encoding of the ASN.1 RelativeDistinguishedName object

If one of these formats is used, the separator parameters are ignored.

OidToString Method (Utils Component)

Converts a binary-encoded ASN.1 OID to its string representation.

Syntax

String __fastcall OidToString(DynamicArray<Byte> Bytes);

Remarks

Use this method to convert binary-encoded OIDs (object identifiers) to their dotted string representations. byte[] oid_bin = new byte[] { 0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x01, 0x06 }; string oid_str = utils.OidToString(oid_bin); Console.WriteLine(oid_str); // prints 2.16.840.1.101.3.4.1.6

RemoveNameValuePair Method (Utils Component)

Remove a (name, value) pair by name.

Syntax

bool __fastcall RemoveNameValuePair(String Name);

Remarks

Use this method to remove the (Name, Value) pair from the NameValuePairs list.

SaveMultipartContentType Method (Utils Component)

Returns the value for Content-Type field.

Syntax

String __fastcall SaveMultipartContentType();

Remarks

Call this method to get a value for Content-Type field after calling SaveMultipartToBytes or SaveMultipartToFile or SaveMultipartToStream.

SaveMultipartToBytes Method (Utils Component)

Saves the parts contained in MultipartMessage to a byte array.

Syntax

DynamicArray<Byte> __fastcall SaveMultipartToBytes(int MultipartMode);

Remarks

Use this method to store MultipartMessage to a temporary byte array.

Supported values for MultipartMode are:


hmmFormData	`0`	The multipart message contains form data (content type is multipart/form-data)
hmmRelated	`1`	The multipart message contains related parts (content type is multipart/related)

To send the stored data to an HTTP server, follow the steps below:

Call SaveMultipartContentType method and assign the returned value to ContentType field of RequestParameters> property
Call PostBytes> method and pass the array to it

SaveMultipartToFile Method (Utils Component)

Saves the parts contained in MultipartMessage to the file.

Syntax

void __fastcall SaveMultipartToFile(int MultipartMode, String Filename);

Remarks

Use this method to store MultipartMessage to a temporary file.

Supported values for MultipartMode are:


hmmFormData	`0`	The multipart message contains form data (content type is multipart/form-data)
hmmRelated	`1`	The multipart message contains related parts (content type is multipart/related)

Filename is the name of the target file for the multipart message.

To send the stored data to an HTTP server, follow the steps below:

Call SaveMultipartContentType method and assign the returned value to ContentType field of RequestParameters> property
Call PostFile> method and pass the filename to it

SaveNameValuePairs Method (Utils Component)

Serializes the (name, value) pair list to a string.

Syntax

String __fastcall SaveNameValuePairs(String Format, String NameValueSeparator, String PairSeparator);

Remarks

Use this method to save the contents of NameValuePairs to a string. Provide the desired format through the Format parameter, and entry separators (if required) via NameValueSeparator and PairSeparator parameters.

The following pre-defined pair list formats are currently supported:

rdn: a textual distinguished name encoding (/C=US/S=NC/O=Big Company)
rdnbinary: a hex-encoded DER encoding of the ASN.1 RelativeDistinguishedName object

If one of these formats is used, the separator parameters are ignored.

SetValueByName Method (Utils Component)

Adds or updates the (name, value) pair by a name.

Syntax

int __fastcall SetValueByName(String Name, String Value);

Remarks

This method updates the existing (Name, Value) pair with a new value, or adds a new pair if no such pair existed in NameValuePairs list.

StringDecode Method (Utils Component)

Converts a byte array to a string using a chosen encoding.

Syntax

String __fastcall StringDecode(DynamicArray<Byte> Bytes, String Encoding);

Remarks

Use this method to convert a byte array to a string using the required text encoding. The following encodings are currently supported: utf-8, utf16.

Leave Encoding empty to use the default code page configured in the system.

StringEncode Method (Utils Component)

Encodes a string to a byte array using a chosen character encoding.

Syntax

DynamicArray<Byte> __fastcall StringEncode(String Value, String Encoding);

Remarks

Use this method to convert a string to a byte array using the provided text encoding. The following encodings are currently supported: utf-8, utf16.

Leave Encoding empty to use the default code page configured in the system.

StringToDate Method (Utils Component)

Converts a date represented by a string to a respective Date object.

Syntax

TDateTime __fastcall StringToDate(String Value);

Remarks

Use this method to convert a date string that you obtained from a SecureBlackbox component property or method to a platform date object.

StringToOid Method (Utils Component)

Converts string OID representation to an ASN.1 byte array.

Syntax

DynamicArray<Byte> __fastcall StringToOid(String Value);

Remarks

Use this method to convert an OID represented with a dotted string to the respective ASN.1 representation. string oid_str = "2.16.840.1.101.3.4.1.6"; byte[] oid_buf = utils.StringToOid(oid_str);

UrlDecode Method (Utils Component)

Decodes a URLEncoded string back into its original form.

Syntax

String __fastcall UrlDecode(String Value);

Remarks

Use this method to decode the URLEncoded Value back to its original representation.

UrlEncode Method (Utils Component)

Encodes the provided string using URLEncode.

Syntax

String __fastcall UrlEncode(String Value);

Remarks

Use this method to encode Value using URL Encoding (percent encoding), as defined in RFC 3986.

Error Event (Utils Component)

Informs about errors during cryptographic operations.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TsbxUtilsErrorEventParams;
typedef void __fastcall (__closure *TsbxUtilsErrorEvent)(System::TObject* Sender, TsbxUtilsErrorEventParams *e);
__property TsbxUtilsErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

Component 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 Component)

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

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxUtilsNotificationEventParams;
typedef void __fastcall (__closure *TsbxUtilsNotificationEvent)(System::TObject* Sender, TsbxUtilsNotificationEventParams *e);
__property TsbxUtilsNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

Remarks

The component 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 the 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.

Config Settings (Utils Component)

The component 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 component, access to these internal properties is provided through the Config method.

Utils Config Settings

MultipartBoundary: Returns the boundary string used to save the last multipart message.

MultipartCharset: Specifies the charset to be used to encode the field names and the filenames of the multipart message.

RelatedStart: Identifies the starting body part or root.

Provides the starting body part or root for multipart messages transferred over HTTP.

RelatedStartInfo: Contains additional information required for unpacking or processing of the content.

Provides additional information for unpacking or processing of the content in multipart messages transferred over HTTP.

RelatedType: Contains media type/subtype of message's content.

Provides the media type/subtype of message's content in multipart messages transferred over HTTP.

TempPath: Path for storing temporary files.

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

Base Config 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 component.

Supported values are:


off		No caching (default)
local		Local caching
global		Global caching

Cookies: Gets or sets local cookies for the component.

Use this property to get cookies from the internal cookie storage of the component 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 components 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 components.

LogDestination: Specifies the debug log destination.

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

Supported values are:


file		File
console		Console
systemlog		System Log (supported for Android only)
debugger		Debugger (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:


time		Current time
level		Level
package		Package name
module		Module name
class		Class name
method		Method name
threadid		Thread Id
contenttype		Content type
content		Content
all		All 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-package		Exclude a package specified in the value
exclude-module		Exclude a module specified in the value
exclude-class		Exclude a class specified in the value
exclude-method		Exclude a method specified in the value
include-package		Include a package specified in the value
include-module		Include a module specified in the value
include-class		Include a class specified in the value
include-method		Include 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:


none		No flush (caching only)
immediate		Immediate flush (real-time logging)
maxcount		Flush 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:


none		None (by default)
fatal		Severe errors that cause premature termination.
error		Other runtime errors or unexpected conditions.
warning		Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
info		Interesting runtime events (startup/shutdown).
debug		Detailed information on flow of through the system.
trace		More 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:


none		No rotation
deleteolder		Delete older entries from the cache upon reaching LogMaxEventCount
keepolder		Keep 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.

StaticDNS: Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the component. Works only if UseOwnDNSResolver is set to true.

Supported values are:


none		No static DNS rules (default)
local		Local static DNS rules
global		Global static DNS rules

StaticIPAddress[domain]: Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the component) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.

StaticIPAddresses: Gets or sets all the static DNS rules.

Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the component is set to "local", the property returns/restores the rules from/to the internal storage of the component. If StaticDNS of the component is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

Tag: Allows to store any custom data.

Use this config property to store any custom data.

TLSSessionGroup: Specifies the group name of TLS sessions to be used for session resumption.

Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the components.

TLSSessionLifetime: Specifies lifetime in seconds of the cached TLS session.

Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

TLSSessionPurgeInterval: Specifies how often the session cache should remove the expired TLS sessions.

Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

UseOwnDNSResolver: Specifies whether the client components should use own DNS resolver.

Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

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 Component)

Utils Errors


	1048577 Invalid parameter value (`SB_ERROR_INVALID_PARAMETER`)
	1048578 Component 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`)