MailWriter Module

Properties Methods Events Config Settings Errors

The MailWriter module composes, encrypts, and signs e-mail messages.

Syntax

SecureBlackbox.MailWriter

Remarks

Use MailWriter to compose, sign, and encrypt e-mail messages, and prepare them for sending or saving.

Preparing a very simple message and saving it to a file: MailWriter writer = new MailWriter(); writer.From.Add(new MailAddress("John Doe", "jdoe@company.com")); writer.SendTo.Add(new MailAddress("Mary Dow", "mdow@home.com")); writer.Message.Subject = "Lating to the party"; writer.Message.PlainText = "Hi Mary!\r\nStill in the office waiting for my partner.\r\nProbably I'll be late to the party for about an hour.\r\nSorry.\r\nJohn"; writer.SaveToFile("path\\message.eml");

Attaching an image and referencing it from the message text: writer.AttachImage("myimage", File.ReadAllBytes("path\\image.jpg")); writer.Attachments[0].ContentSubtype = "jpeg"; writer.Message.HtmlText = "<html><body>Message with an image<p><img src=\"cid:myimage\"></body></html>";

Signing a message with a certificate (note that the certificate should contain its private key): CertificateManager manager = new CertificateManager(); manager.ImportFromFile("path\\cert.pfx", "password"); writer.SecuritySettings.Sign = true; writer.SecuritySettings.HashAlgorithm = "SHA256"; writer.SigningCertificate = manager.Certificate; writer.SaveToFile("path\\message.eml");

Encrypting a message with one or more certificates (no private key is required): CertificateManager manager = new CertificateManager(); manager.ImportFromFile("path\\cert.cer", ""); writer.SecuritySettings.Encrypt = true; writer.SecuritySettings.EncryptionAlgorithm = "AES256"; writer.EncryptionCertificates.Add(manager.Certificate); // add more certificates if needed writer.SaveToFile("D:\\test.eml");

Property List

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


AttachEncoding	The encoding to be applied to the attachments.
Attachments	Contains a list of attachments to the message.
Bcc	The BCC header of the Message.
Cc	The CC header of the Message.
Charset	The charset to apply to Message .
EncryptionCertificates	The recipients' encryption certificates.
ExternalCrypto	Provides access to external signing and DC parameters.
FIPSMode	Reserved.
From	The From header of the Message.
HeaderEncoding	The encoding to be applied to the message header.
Mailer	The name of the software used to compose and/or send the message.
Message	The message that is currently being composed.
OtherHeaders	Provides access to secondary message headers.
Profile	Specifies a pre-defined profile to apply when creating the signature.
ReplyTo	The value of the Reply-To header field of the Message.
SecuritySettings	A container for the message's security settings.
Sender	The value of the Sender header field of the Message.
SendTo	The value of the To header field of the Message.
SigningCertificate	The certificate to be used for signing.
SigningChain	The signing certificate chain.
TextEncoding	The encoding to be applied to the message.

Method List

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


AttachBytes	Creates an attachment from a memory buffer.
AttachFile	Creates an attachment from a file.
AttachImage	Creates an image attachment from a memory buffer.
Config	Sets or retrieves a configuration setting.
CreateNew	Creates a template for a new message.
DoAction	Performs an additional action.
Reset	Resets the module settings.
SaveToBytes	Serializes the message to a byte array.
SaveToFile	Serializes the message to a file.

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.


Error	Reports information about errors during e-mail message assembling or saving.
ExternalSign	Handles remote or external signing initiated by the SignExternal method or other source.
Notification	This event notifies the application about an underlying control flow event.

Config Settings

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


BitsInKey	Key length for the block cipher used for encryption. The value should be a multiple of 8.
IncludeSigningCertificate	If true (by default), the signing certificate is included into the signature. Otherwise, it is included only if SigningChain is not empty.
TempPath	Path for storing temporary files.
ASN1UseGlobalTagCache	Controls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPins	Specifies whether CSP-level PINs should be assigned to CNG keys.
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 module.
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
DNSLocalSuffix	The suffix to assign for TLD names.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicy	The hardware crypto usage policy.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
HttpVersion	The HTTP version to use in any inner HTTP client modules created.
IgnoreExpiredMSCTLSigningCert	Whether to tolerate the expired Windows Update signing certificate.
ListDelimiter	The delimiter character for multi-element lists.
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.
OldClientSideRSAFallback	Specifies whether the SSH client should use a SHA1 fallback.
ProductVersion	Returns the version of the SecureBlackbox library.
ServerSSLDHKeyLength	Sets the size of the TLS DHE key exchange group.
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.
UseInternalRandom	Switches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidation	Enables legacy AdES validation mode.
UseOwnDNSResolver	Specifies whether the client modules should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculation	An internal CryptoAPI access tweak.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.

AttachEncoding Property (MailWriter Module)

The encoding to be applied to the attachments.

public var attachEncoding: MailWriterAttachEncodings {
  get {...}
  set {...}
}

public enum MailWriterAttachEncodings: Int32 {
  case meAuto = 0
  case me8bit = 1
  case meBase64 = 2
  case meQuotedPrintable = 3
}


@property (nonatomic,readwrite,assign,getter=attachEncoding,setter=setAttachEncoding:) int attachEncoding;

- (int)attachEncoding;
- (void)setAttachEncoding :(int)newAttachEncoding;

Default Value

Remarks

Use this property to specify the encoding method for the attached files.


meAuto	`0`
me8bit	`1`
meBase64	`2`
meQuotedPrintable	`3`

Attachments Property (MailWriter Module)

Contains a list of attachments to the message.

Syntax

Swift
Objective-C

public var attachments: Array<MailAttachment> {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=attachCount,setter=setAttachCount:) int attachCount;

- (int)attachCount;
- (void)setAttachCount :(int)newAttachCount;

- (NSString*)attachContentSubtype:(int)attachIndex;
- (void)setAttachContentSubtype:(int)attachIndex :(NSString*)newAttachContentSubtype;

- (NSString*)attachContentType:(int)attachIndex;
- (void)setAttachContentType:(int)attachIndex :(NSString*)newAttachContentType;

- (NSString*)attachCreationDate:(int)attachIndex;
- (void)setAttachCreationDate:(int)attachIndex :(NSString*)newAttachCreationDate;

- (NSData*)attachData:(int)attachIndex;
- (void)setAttachData:(int)attachIndex :(NSData*)newAttachData;

- (NSString*)attachDescription:(int)attachIndex;
- (void)setAttachDescription:(int)attachIndex :(NSString*)newAttachDescription;

- (NSString*)attachFileName:(int)attachIndex;
- (void)setAttachFileName:(int)attachIndex :(NSString*)newAttachFileName;

- (long long)attachHandle:(int)attachIndex;
- (void)setAttachHandle:(int)attachIndex :(long long)newAttachHandle;

- (NSString*)attachID:(int)attachIndex;
- (void)setAttachID:(int)attachIndex :(NSString*)newAttachID;

- (NSString*)attachModificationDate:(int)attachIndex;
- (void)setAttachModificationDate:(int)attachIndex :(NSString*)newAttachModificationDate;

- (NSString*)attachReadDate:(int)attachIndex;
- (void)setAttachReadDate:(int)attachIndex :(NSString*)newAttachReadDate;

- (long long)attachSize:(int)attachIndex;
- (void)setAttachSize:(int)attachIndex :(long long)newAttachSize;

Default Value

Remarks

Use this property to access all attachments added to the Message and tune up their properties.

Bcc Property (MailWriter Module)

The BCC header of the Message.

Syntax

Swift
Objective-C

public var bcc: Array<MailAddress> {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=bccAddrCount,setter=setBccAddrCount:) int bccAddrCount;

- (int)bccAddrCount;
- (void)setBccAddrCount :(int)newBccAddrCount;

- (NSString*)bccAddrAddress:(int)bccAddrIndex;
- (void)setBccAddrAddress:(int)bccAddrIndex :(NSString*)newBccAddrAddress;

- (NSString*)bccAddrDisplayName:(int)bccAddrIndex;
- (void)setBccAddrDisplayName:(int)bccAddrIndex :(NSString*)newBccAddrDisplayName;

- (NSString*)bccAddrGroupName:(int)bccAddrIndex;
- (void)setBccAddrGroupName:(int)bccAddrIndex :(NSString*)newBccAddrGroupName;

Default Value

Remarks

The BCC header field contains the addresses of secondary recipients of the message whose addresses are not to be revealed to other recipients of the message. Mail servers remove the BCC header when processing the message and use its value for dispatching the message only.

Cc Property (MailWriter Module)

The CC header of the Message.

Syntax

Swift
Objective-C

public var cc: Array<MailAddress> {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=ccAddrCount,setter=setCcAddrCount:) int ccAddrCount;

- (int)ccAddrCount;
- (void)setCcAddrCount :(int)newCcAddrCount;

- (NSString*)ccAddrAddress:(int)ccAddrIndex;
- (void)setCcAddrAddress:(int)ccAddrIndex :(NSString*)newCcAddrAddress;

- (NSString*)ccAddrDisplayName:(int)ccAddrIndex;
- (void)setCcAddrDisplayName:(int)ccAddrIndex :(NSString*)newCcAddrDisplayName;

- (NSString*)ccAddrGroupName:(int)ccAddrIndex;
- (void)setCcAddrGroupName:(int)ccAddrIndex :(NSString*)newCcAddrGroupName;

Default Value

Remarks

The CC field contains the addresses of secondary recipients of the message.

Charset Property (MailWriter Module)

The charset to apply to Message .

Syntax

Swift
Objective-C

public var charset: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=charset,setter=setCharset:) NSString* charset;

- (NSString*)charset;
- (void)setCharset :(NSString*)newCharset;

Default Value

"utf-8"

Remarks

Use this property to specify the character set to use in the message.

EncryptionCertificates Property (MailWriter Module)

The recipients' encryption certificates.

Syntax

Swift
Objective-C

public var encryptionCertificates: Array<Certificate> {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=encryptionCertCount,setter=setEncryptionCertCount:) int encryptionCertCount;

- (int)encryptionCertCount;
- (void)setEncryptionCertCount :(int)newEncryptionCertCount;

- (NSData*)encryptionCertBytes:(int)encryptionCertIndex;

- (long long)encryptionCertHandle:(int)encryptionCertIndex;
- (void)setEncryptionCertHandle:(int)encryptionCertIndex :(long long)newEncryptionCertHandle;

Default Value

Remarks

Use this property to provide certificates to be used for message encryption.

ExternalCrypto Property (MailWriter Module)

Provides access to external signing and DC parameters.

Syntax

Swift
Objective-C

public var externalCrypto: ExternalCrypto {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=externalCryptoAsyncDocumentID,setter=setExternalCryptoAsyncDocumentID:) NSString* externalCryptoAsyncDocumentID;

- (NSString*)externalCryptoAsyncDocumentID;
- (void)setExternalCryptoAsyncDocumentID :(NSString*)newExternalCryptoAsyncDocumentID;

@property (nonatomic,readwrite,assign,getter=externalCryptoCustomParams,setter=setExternalCryptoCustomParams:) NSString* externalCryptoCustomParams;

- (NSString*)externalCryptoCustomParams;
- (void)setExternalCryptoCustomParams :(NSString*)newExternalCryptoCustomParams;

@property (nonatomic,readwrite,assign,getter=externalCryptoData,setter=setExternalCryptoData:) NSString* externalCryptoData;

- (NSString*)externalCryptoData;
- (void)setExternalCryptoData :(NSString*)newExternalCryptoData;

@property (nonatomic,readwrite,assign,getter=externalCryptoExternalHashCalculation,setter=setExternalCryptoExternalHashCalculation:) BOOL externalCryptoExternalHashCalculation;

- (BOOL)externalCryptoExternalHashCalculation;
- (void)setExternalCryptoExternalHashCalculation :(BOOL)newExternalCryptoExternalHashCalculation;

@property (nonatomic,readwrite,assign,getter=externalCryptoHashAlgorithm,setter=setExternalCryptoHashAlgorithm:) NSString* externalCryptoHashAlgorithm;

- (NSString*)externalCryptoHashAlgorithm;
- (void)setExternalCryptoHashAlgorithm :(NSString*)newExternalCryptoHashAlgorithm;

@property (nonatomic,readwrite,assign,getter=externalCryptoKeyID,setter=setExternalCryptoKeyID:) NSString* externalCryptoKeyID;

- (NSString*)externalCryptoKeyID;
- (void)setExternalCryptoKeyID :(NSString*)newExternalCryptoKeyID;

@property (nonatomic,readwrite,assign,getter=externalCryptoKeySecret,setter=setExternalCryptoKeySecret:) NSString* externalCryptoKeySecret;

- (NSString*)externalCryptoKeySecret;
- (void)setExternalCryptoKeySecret :(NSString*)newExternalCryptoKeySecret;

@property (nonatomic,readwrite,assign,getter=externalCryptoMethod,setter=setExternalCryptoMethod:) int externalCryptoMethod;

- (int)externalCryptoMethod;
- (void)setExternalCryptoMethod :(int)newExternalCryptoMethod;

@property (nonatomic,readwrite,assign,getter=externalCryptoMode,setter=setExternalCryptoMode:) int externalCryptoMode;

- (int)externalCryptoMode;
- (void)setExternalCryptoMode :(int)newExternalCryptoMode;

@property (nonatomic,readwrite,assign,getter=externalCryptoPublicKeyAlgorithm,setter=setExternalCryptoPublicKeyAlgorithm:) NSString* externalCryptoPublicKeyAlgorithm;

- (NSString*)externalCryptoPublicKeyAlgorithm;
- (void)setExternalCryptoPublicKeyAlgorithm :(NSString*)newExternalCryptoPublicKeyAlgorithm;

Default Value

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

FIPSMode Property (MailWriter Module)

Reserved.

Syntax

Swift
Objective-C

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.

From Property (MailWriter Module)

The From header of the Message.

Syntax

Swift
Objective-C

public var from: Array<MailAddress> {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=fromAddrCount,setter=setFromAddrCount:) int fromAddrCount;

- (int)fromAddrCount;
- (void)setFromAddrCount :(int)newFromAddrCount;

- (NSString*)fromAddrAddress:(int)fromAddrIndex;
- (void)setFromAddrAddress:(int)fromAddrIndex :(NSString*)newFromAddrAddress;

- (NSString*)fromAddrDisplayName:(int)fromAddrIndex;
- (void)setFromAddrDisplayName:(int)fromAddrIndex :(NSString*)newFromAddrDisplayName;

- (NSString*)fromAddrGroupName:(int)fromAddrIndex;
- (void)setFromAddrGroupName:(int)fromAddrIndex :(NSString*)newFromAddrGroupName;

Default Value

Remarks

This field contains address(es) of the message author(s). If the actual sender is not an author of the message, use Sender additionally to specify the sender.

HeaderEncoding Property (MailWriter Module)

The encoding to be applied to the message header.

Syntax

Swift
Objective-C

public var headerEncoding: MailWriterHeaderEncodings {
  get {...}
  set {...}
}

public enum MailWriterHeaderEncodings: Int32 {
  case meAuto = 0
  case me8bit = 1
  case meBase64 = 2
  case meQuotedPrintable = 3
}


@property (nonatomic,readwrite,assign,getter=headerEncoding,setter=setHeaderEncoding:) int headerEncoding;

- (int)headerEncoding;
- (void)setHeaderEncoding :(int)newHeaderEncoding;

Default Value

Remarks

Use this property to specify the encoding to use with the message header.


meAuto	`0`
me8bit	`1`
meBase64	`2`
meQuotedPrintable	`3`

Mailer Property (MailWriter Module)

The name of the software used to compose and/or send the message.

Syntax

Swift
Objective-C

public var mailer: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=mailer,setter=setMailer:) NSString* mailer;

- (NSString*)mailer;
- (void)setMailer :(NSString*)newMailer;

Default Value

Remarks

Use this property to specify the software that was used to compose and send this message.

Message Property (MailWriter Module)

The message that is currently being composed.

Syntax

Swift
Objective-C

public var message: MailMessage {
  get {...}
  set {...}
}


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

- (int)msgAttachmentCount;

@property (nonatomic,readwrite,assign,getter=msgBcc,setter=setMsgBcc:) NSString* msgBcc;

- (NSString*)msgBcc;
- (void)setMsgBcc :(NSString*)newMsgBcc;

@property (nonatomic,readwrite,assign,getter=msgCc,setter=setMsgCc:) NSString* msgCc;

- (NSString*)msgCc;
- (void)setMsgCc :(NSString*)newMsgCc;

@property (nonatomic,readwrite,assign,getter=msgComments,setter=setMsgComments:) NSString* msgComments;

- (NSString*)msgComments;
- (void)setMsgComments :(NSString*)newMsgComments;

@property (nonatomic,readwrite,assign,getter=msgDate,setter=setMsgDate:) NSString* msgDate;

- (NSString*)msgDate;
- (void)setMsgDate :(NSString*)newMsgDate;

@property (nonatomic,readwrite,assign,getter=msgDeliveryReceipt,setter=setMsgDeliveryReceipt:) BOOL msgDeliveryReceipt;

- (BOOL)msgDeliveryReceipt;
- (void)setMsgDeliveryReceipt :(BOOL)newMsgDeliveryReceipt;

@property (nonatomic,readwrite,assign,getter=msgFrom,setter=setMsgFrom:) NSString* msgFrom;

- (NSString*)msgFrom;
- (void)setMsgFrom :(NSString*)newMsgFrom;

@property (nonatomic,readwrite,assign,getter=msgHandle,setter=setMsgHandle:) long long msgHandle;

- (long long)msgHandle;
- (void)setMsgHandle :(long long)newMsgHandle;

@property (nonatomic,readwrite,assign,getter=msgHtmlText,setter=setMsgHtmlText:) NSString* msgHtmlText;

- (NSString*)msgHtmlText;
- (void)setMsgHtmlText :(NSString*)newMsgHtmlText;

@property (nonatomic,readwrite,assign,getter=msgID,setter=setMsgID:) NSString* msgID;

- (NSString*)msgID;
- (void)setMsgID :(NSString*)newMsgID;

@property (nonatomic,readwrite,assign,getter=msgInReplyTo,setter=setMsgInReplyTo:) NSString* msgInReplyTo;

- (NSString*)msgInReplyTo;
- (void)setMsgInReplyTo :(NSString*)newMsgInReplyTo;

@property (nonatomic,readwrite,assign,getter=msgKeywords,setter=setMsgKeywords:) NSString* msgKeywords;

- (NSString*)msgKeywords;
- (void)setMsgKeywords :(NSString*)newMsgKeywords;

@property (nonatomic,readonly,assign,getter=msgMailer) NSString* msgMailer;

- (NSString*)msgMailer;

@property (nonatomic,readwrite,assign,getter=msgPlainText,setter=setMsgPlainText:) NSString* msgPlainText;

- (NSString*)msgPlainText;
- (void)setMsgPlainText :(NSString*)newMsgPlainText;

@property (nonatomic,readwrite,assign,getter=msgPriority,setter=setMsgPriority:) int msgPriority;

- (int)msgPriority;
- (void)setMsgPriority :(int)newMsgPriority;

@property (nonatomic,readwrite,assign,getter=msgReadReceipt,setter=setMsgReadReceipt:) BOOL msgReadReceipt;

- (BOOL)msgReadReceipt;
- (void)setMsgReadReceipt :(BOOL)newMsgReadReceipt;

@property (nonatomic,readwrite,assign,getter=msgReferences,setter=setMsgReferences:) NSString* msgReferences;

- (NSString*)msgReferences;
- (void)setMsgReferences :(NSString*)newMsgReferences;

@property (nonatomic,readwrite,assign,getter=msgReplyTo,setter=setMsgReplyTo:) NSString* msgReplyTo;

- (NSString*)msgReplyTo;
- (void)setMsgReplyTo :(NSString*)newMsgReplyTo;

@property (nonatomic,readwrite,assign,getter=msgReturnPath,setter=setMsgReturnPath:) NSString* msgReturnPath;

- (NSString*)msgReturnPath;
- (void)setMsgReturnPath :(NSString*)newMsgReturnPath;

@property (nonatomic,readwrite,assign,getter=msgSender,setter=setMsgSender:) NSString* msgSender;

- (NSString*)msgSender;
- (void)setMsgSender :(NSString*)newMsgSender;

@property (nonatomic,readwrite,assign,getter=msgSendTo,setter=setMsgSendTo:) NSString* msgSendTo;

- (NSString*)msgSendTo;
- (void)setMsgSendTo :(NSString*)newMsgSendTo;

@property (nonatomic,readwrite,assign,getter=msgSubject,setter=setMsgSubject:) NSString* msgSubject;

- (NSString*)msgSubject;
- (void)setMsgSubject :(NSString*)newMsgSubject;

Default Value

Remarks

This property accumulates the properties of the message that is being composed.

OtherHeaders Property (MailWriter Module)

Provides access to secondary message headers.

Syntax

Swift
Objective-C

public var otherHeaders: Array<StringNameValuePair> {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=headerFieldCount,setter=setHeaderFieldCount:) int headerFieldCount;

- (int)headerFieldCount;
- (void)setHeaderFieldCount :(int)newHeaderFieldCount;

- (NSString*)headerFieldCategory:(int)headerFieldIndex;
- (void)setHeaderFieldCategory:(int)headerFieldIndex :(NSString*)newHeaderFieldCategory;

- (int)headerFieldFormat:(int)headerFieldIndex;
- (void)setHeaderFieldFormat:(int)headerFieldIndex :(int)newHeaderFieldFormat;

- (NSString*)headerFieldName:(int)headerFieldIndex;
- (void)setHeaderFieldName:(int)headerFieldIndex :(NSString*)newHeaderFieldName;

- (NSString*)headerFieldValue:(int)headerFieldIndex;
- (void)setHeaderFieldValue:(int)headerFieldIndex :(NSString*)newHeaderFieldValue;

Default Value

Remarks

Use this property to access the headers of the message that are not available via first-level properties of the class

Profile Property (MailWriter Module)

Specifies a pre-defined profile to apply when creating the signature.

Syntax

Swift
Objective-C

public var profile: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=profile,setter=setProfile:) NSString* profile;

- (NSString*)profile;
- (void)setProfile :(NSString*)newProfile;

Default Value

Remarks

Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.

ReplyTo Property (MailWriter Module)

The value of the Reply-To header field of the Message.

Syntax

Swift
Objective-C

public var replyTo: Array<MailAddress> {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=replyToAddrCount,setter=setReplyToAddrCount:) int replyToAddrCount;

- (int)replyToAddrCount;
- (void)setReplyToAddrCount :(int)newReplyToAddrCount;

- (NSString*)replyToAddrAddress:(int)replyToAddrIndex;
- (void)setReplyToAddrAddress:(int)replyToAddrIndex :(NSString*)newReplyToAddrAddress;

- (NSString*)replyToAddrDisplayName:(int)replyToAddrIndex;
- (void)setReplyToAddrDisplayName:(int)replyToAddrIndex :(NSString*)newReplyToAddrDisplayName;

- (NSString*)replyToAddrGroupName:(int)replyToAddrIndex;
- (void)setReplyToAddrGroupName:(int)replyToAddrIndex :(NSString*)newReplyToAddrGroupName;

Default Value

Remarks

This field contains the addresses to which the replies to this message should be sent. This field is optional. If not specified, the replies must be sent to the addresses specified in the From field.

SecuritySettings Property (MailWriter Module)

A container for the message's security settings.

Syntax

Swift
Objective-C

public var securitySettings: MailSecuritySettings {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=secSettingsClaimedSigningTime,setter=setSecSettingsClaimedSigningTime:) NSString* secSettingsClaimedSigningTime;

- (NSString*)secSettingsClaimedSigningTime;
- (void)setSecSettingsClaimedSigningTime :(NSString*)newSecSettingsClaimedSigningTime;

@property (nonatomic,readwrite,assign,getter=secSettingsEncrypt,setter=setSecSettingsEncrypt:) BOOL secSettingsEncrypt;

- (BOOL)secSettingsEncrypt;
- (void)setSecSettingsEncrypt :(BOOL)newSecSettingsEncrypt;

@property (nonatomic,readwrite,assign,getter=secSettingsEncryptionAlgorithm,setter=setSecSettingsEncryptionAlgorithm:) NSString* secSettingsEncryptionAlgorithm;

- (NSString*)secSettingsEncryptionAlgorithm;
- (void)setSecSettingsEncryptionAlgorithm :(NSString*)newSecSettingsEncryptionAlgorithm;

@property (nonatomic,readwrite,assign,getter=secSettingsHashAlgorithm,setter=setSecSettingsHashAlgorithm:) NSString* secSettingsHashAlgorithm;

- (NSString*)secSettingsHashAlgorithm;
- (void)setSecSettingsHashAlgorithm :(NSString*)newSecSettingsHashAlgorithm;

@property (nonatomic,readwrite,assign,getter=secSettingsSign,setter=setSecSettingsSign:) BOOL secSettingsSign;

- (BOOL)secSettingsSign;
- (void)setSecSettingsSign :(BOOL)newSecSettingsSign;

@property (nonatomic,readwrite,assign,getter=secSettingsSignatureFormat,setter=setSecSettingsSignatureFormat:) int secSettingsSignatureFormat;

- (int)secSettingsSignatureFormat;
- (void)setSecSettingsSignatureFormat :(int)newSecSettingsSignatureFormat;

@property (nonatomic,readwrite,assign,getter=secSettingsSignBeforeEncrypt,setter=setSecSettingsSignBeforeEncrypt:) BOOL secSettingsSignBeforeEncrypt;

- (BOOL)secSettingsSignBeforeEncrypt;
- (void)setSecSettingsSignBeforeEncrypt :(BOOL)newSecSettingsSignBeforeEncrypt;

@property (nonatomic,readwrite,assign,getter=secSettingsSignMessageHeader,setter=setSecSettingsSignMessageHeader:) BOOL secSettingsSignMessageHeader;

- (BOOL)secSettingsSignMessageHeader;
- (void)setSecSettingsSignMessageHeader :(BOOL)newSecSettingsSignMessageHeader;

Default Value

Remarks

Use this property to tune up the message's security parameters.

Sender Property (MailWriter Module)

The value of the Sender header field of the Message.

Syntax

Swift
Objective-C

public var sender: MailAddress {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=senderAddrAddress,setter=setSenderAddrAddress:) NSString* senderAddrAddress;

- (NSString*)senderAddrAddress;
- (void)setSenderAddrAddress :(NSString*)newSenderAddrAddress;

@property (nonatomic,readwrite,assign,getter=senderAddrDisplayName,setter=setSenderAddrDisplayName:) NSString* senderAddrDisplayName;

- (NSString*)senderAddrDisplayName;
- (void)setSenderAddrDisplayName :(NSString*)newSenderAddrDisplayName;

@property (nonatomic,readwrite,assign,getter=senderAddrGroupName,setter=setSenderAddrGroupName:) NSString* senderAddrGroupName;

- (NSString*)senderAddrGroupName;
- (void)setSenderAddrGroupName :(NSString*)newSenderAddrGroupName;

Default Value

Remarks

This field specifies the mailbox of the agent responsible for the actual transmission of the message.

If the originator of the message can be indicated by a single mailbox, and the author and the transmitter is the same identity, the "Sender:" field should not be used.

SendTo Property (MailWriter Module)

The value of the To header field of the Message.

Syntax

Swift
Objective-C

public var sendTo: Array<MailAddress> {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=sendToAddrCount,setter=setSendToAddrCount:) int sendToAddrCount;

- (int)sendToAddrCount;
- (void)setSendToAddrCount :(int)newSendToAddrCount;

- (NSString*)sendToAddrAddress:(int)sendToAddrIndex;
- (void)setSendToAddrAddress:(int)sendToAddrIndex :(NSString*)newSendToAddrAddress;

- (NSString*)sendToAddrDisplayName:(int)sendToAddrIndex;
- (void)setSendToAddrDisplayName:(int)sendToAddrIndex :(NSString*)newSendToAddrDisplayName;

- (NSString*)sendToAddrGroupName:(int)sendToAddrIndex;
- (void)setSendToAddrGroupName:(int)sendToAddrIndex :(NSString*)newSendToAddrGroupName;

Default Value

Remarks

This field specifies the address(es) of the primary recipient(s) of the message.

SigningCertificate Property (MailWriter Module)

The certificate to be used for signing.

Syntax

Swift
Objective-C

public var signingCertificate: Certificate {
  get {...}
  set {...}
}


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

- (NSData*)signingCertBytes;

@property (nonatomic,readwrite,assign,getter=signingCertHandle,setter=setSigningCertHandle:) long long signingCertHandle;

- (long long)signingCertHandle;
- (void)setSigningCertHandle :(long long)newSigningCertHandle;

Default Value

Remarks

Use this property to specify the certificate that shall be used for signing the data. Note that this certificate should have a private key associated with it. Use SigningChain to supply the rest of the certificate chain for inclusion into the signature.

SigningChain Property (MailWriter Module)

The signing certificate chain.

Syntax

Swift
Objective-C

public var signingChain: Array<Certificate> {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=signingChainCount,setter=setSigningChainCount:) int signingChainCount;

- (int)signingChainCount;
- (void)setSigningChainCount :(int)newSigningChainCount;

- (NSData*)signingChainBytes:(int)signingChainIndex;

- (long long)signingChainHandle:(int)signingChainIndex;
- (void)setSigningChainHandle:(int)signingChainIndex :(long long)newSigningChainHandle;

Default Value

Remarks

Use this property to provide the chain for the signing certificate. Use the SigningCertificate property, if it is available, to provide the signing certificate itself.

TextEncoding Property (MailWriter Module)

The encoding to be applied to the message.

Syntax

Swift
Objective-C

public var textEncoding: MailWriterTextEncodings {
  get {...}
  set {...}
}

public enum MailWriterTextEncodings: Int32 {
  case meAuto = 0
  case me8bit = 1
  case meBase64 = 2
  case meQuotedPrintable = 3
}


@property (nonatomic,readwrite,assign,getter=textEncoding,setter=setTextEncoding:) int textEncoding;

- (int)textEncoding;
- (void)setTextEncoding :(int)newTextEncoding;

Default Value

Remarks

Use this property to specify the encoding to use for the content of the message.


meAuto	`0`
me8bit	`1`
meBase64	`2`
meQuotedPrintable	`3`

AttachBytes Method (MailWriter Module)

Creates an attachment from a memory buffer.

Syntax

Swift
Objective-C

public func attachBytes(data: Data) throws -> Int32

- (int)attachBytes:(NSData*)data;

Remarks

Use this method to create an attachment from a memory buffer. Use Attachments property to provide further attachment details.

The method returns the index of the new attachment in the Attachments list.

AttachFile Method (MailWriter Module)

Creates an attachment from a file.

Syntax

Swift
Objective-C

public func attachFile(fileName: String) throws -> Int32

- (int)attachFile:(NSString*)fileName;

Remarks

Use this method to create an attachment from a file. Use Attachments property to provide further attachment details.

The method returns the index of the new attachment in the Attachments list.

AttachImage Method (MailWriter Module)

Creates an image attachment from a memory buffer.

Syntax

Swift
Objective-C

public func attachImage(id: String, data: Data) throws -> Int32

- (int)attachImage:(NSString*)ID :(NSData*)data;

Remarks

Use this method to create a picture attachment from a memory buffer. Use Attachments property to provide further attachment details.

The method returns the index of the new attachment in the Attachments list.

Config Method (MailWriter Module)

Sets or retrieves a configuration setting.

Syntax

Swift
Objective-C

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.

CreateNew Method (MailWriter Module)

Creates a template for a new message.

Syntax

Swift
Objective-C

public func createNew() throws -> Void

- (void)createNew;

Remarks

This method cleans up the current message and makes the component ready for new operation.

Use this method to create a fresh email message for further editing and saving.

DoAction Method (MailWriter Module)

Performs an additional action.

Syntax

Swift
Objective-C

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

Reset Method (MailWriter Module)

Resets the component settings.

Syntax

Swift
Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

Reset is a generic method available in every class.

SaveToBytes Method (MailWriter Module)

Serializes the message to a byte array.

Syntax

Swift
Objective-C

public func saveToBytes() throws -> Data

- (NSData*)saveToBytes;

Remarks

Use this method to assemble the message and save it to a byte array.

SaveToFile Method (MailWriter Module)

Serializes the message to a file.

Syntax

Swift
Objective-C

public func saveToFile(fileName: String) throws -> Void

- (void)saveToFile:(NSString*)fileName;

Remarks

Use this method to assemble the message and save it to a file.

Error Event (MailWriter Module)

Reports information about errors during e-mail message assembling or saving.

Syntax

Swift
Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

The event is fired in case of exceptional conditions during message processing.

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

ExternalSign Event (MailWriter Module)

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

Swift
Objective-C

func onExternalSign(operationId: String, hashAlgorithm: String, pars: String, data: String, signedData: inout String)

- (void)onExternalSign:(NSString*)operationId :(NSString*)hashAlgorithm :(NSString*)pars :(NSString*)data :(NSString**)signedData;

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the class via the SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.

The class uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

Notification Event (MailWriter Module)

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

Syntax

Swift
Objective-C

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 class. 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 class, the exact action it is performing, or the document being processed, one or both may be omitted.

Certificate Type

Encapsulates an individual X.509 certificate.

Remarks

This type keeps and provides access to X.509 certificate details.

The following fields are available:

Fields

bytes
Data (read-only)
Default Value: ""

Returns the raw certificate data in DER format.

ca
Bool
Default Value: False

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

caKeyID
Data (read-only)
Default Value: ""

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

certType
CertTypes (read-only)
Default Value: 0

Returns the type of the entity contained in the Certificate object.

A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the CertificateManager class to load or create new certificate and certificate requests objects.

crlDistributionPoints
String
Default Value: ""

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

curve
String
Default Value: ""

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.


SB_EC_SECP112R1	`SECP112R1`
SB_EC_SECP112R2	`SECP112R2`
SB_EC_SECP128R1	`SECP128R1`
SB_EC_SECP128R2	`SECP128R2`
SB_EC_SECP160K1	`SECP160K1`
SB_EC_SECP160R1	`SECP160R1`
SB_EC_SECP160R2	`SECP160R2`
SB_EC_SECP192K1	`SECP192K1`
SB_EC_SECP192R1	`SECP192R1`
SB_EC_SECP224K1	`SECP224K1`
SB_EC_SECP224R1	`SECP224R1`
SB_EC_SECP256K1	`SECP256K1`
SB_EC_SECP256R1	`SECP256R1`
SB_EC_SECP384R1	`SECP384R1`
SB_EC_SECP521R1	`SECP521R1`
SB_EC_SECT113R1	`SECT113R1`
SB_EC_SECT113R2	`SECT113R2`
SB_EC_SECT131R1	`SECT131R1`
SB_EC_SECT131R2	`SECT131R2`
SB_EC_SECT163K1	`SECT163K1`
SB_EC_SECT163R1	`SECT163R1`
SB_EC_SECT163R2	`SECT163R2`
SB_EC_SECT193R1	`SECT193R1`
SB_EC_SECT193R2	`SECT193R2`
SB_EC_SECT233K1	`SECT233K1`
SB_EC_SECT233R1	`SECT233R1`
SB_EC_SECT239K1	`SECT239K1`
SB_EC_SECT283K1	`SECT283K1`
SB_EC_SECT283R1	`SECT283R1`
SB_EC_SECT409K1	`SECT409K1`
SB_EC_SECT409R1	`SECT409R1`
SB_EC_SECT571K1	`SECT571K1`
SB_EC_SECT571R1	`SECT571R1`
SB_EC_PRIME192V1	`PRIME192V1`
SB_EC_PRIME192V2	`PRIME192V2`
SB_EC_PRIME192V3	`PRIME192V3`
SB_EC_PRIME239V1	`PRIME239V1`
SB_EC_PRIME239V2	`PRIME239V2`
SB_EC_PRIME239V3	`PRIME239V3`
SB_EC_PRIME256V1	`PRIME256V1`
SB_EC_C2PNB163V1	`C2PNB163V1`
SB_EC_C2PNB163V2	`C2PNB163V2`
SB_EC_C2PNB163V3	`C2PNB163V3`
SB_EC_C2PNB176W1	`C2PNB176W1`
SB_EC_C2TNB191V1	`C2TNB191V1`
SB_EC_C2TNB191V2	`C2TNB191V2`
SB_EC_C2TNB191V3	`C2TNB191V3`
SB_EC_C2ONB191V4	`C2ONB191V4`
SB_EC_C2ONB191V5	`C2ONB191V5`
SB_EC_C2PNB208W1	`C2PNB208W1`
SB_EC_C2TNB239V1	`C2TNB239V1`
SB_EC_C2TNB239V2	`C2TNB239V2`
SB_EC_C2TNB239V3	`C2TNB239V3`
SB_EC_C2ONB239V4	`C2ONB239V4`
SB_EC_C2ONB239V5	`C2ONB239V5`
SB_EC_C2PNB272W1	`C2PNB272W1`
SB_EC_C2PNB304W1	`C2PNB304W1`
SB_EC_C2TNB359V1	`C2TNB359V1`
SB_EC_C2PNB368W1	`C2PNB368W1`
SB_EC_C2TNB431R1	`C2TNB431R1`
SB_EC_NISTP192	`NISTP192`
SB_EC_NISTP224	`NISTP224`
SB_EC_NISTP256	`NISTP256`
SB_EC_NISTP384	`NISTP384`
SB_EC_NISTP521	`NISTP521`
SB_EC_NISTB163	`NISTB163`
SB_EC_NISTB233	`NISTB233`
SB_EC_NISTB283	`NISTB283`
SB_EC_NISTB409	`NISTB409`
SB_EC_NISTB571	`NISTB571`
SB_EC_NISTK163	`NISTK163`
SB_EC_NISTK233	`NISTK233`
SB_EC_NISTK283	`NISTK283`
SB_EC_NISTK409	`NISTK409`
SB_EC_NISTK571	`NISTK571`
SB_EC_GOSTCPTEST	`GOSTCPTEST`
SB_EC_GOSTCPA	`GOSTCPA`
SB_EC_GOSTCPB	`GOSTCPB`
SB_EC_GOSTCPC	`GOSTCPC`
SB_EC_GOSTCPXCHA	`GOSTCPXCHA`
SB_EC_GOSTCPXCHB	`GOSTCPXCHB`
SB_EC_BRAINPOOLP160R1	`BRAINPOOLP160R1`
SB_EC_BRAINPOOLP160T1	`BRAINPOOLP160T1`
SB_EC_BRAINPOOLP192R1	`BRAINPOOLP192R1`
SB_EC_BRAINPOOLP192T1	`BRAINPOOLP192T1`
SB_EC_BRAINPOOLP224R1	`BRAINPOOLP224R1`
SB_EC_BRAINPOOLP224T1	`BRAINPOOLP224T1`
SB_EC_BRAINPOOLP256R1	`BRAINPOOLP256R1`
SB_EC_BRAINPOOLP256T1	`BRAINPOOLP256T1`
SB_EC_BRAINPOOLP320R1	`BRAINPOOLP320R1`
SB_EC_BRAINPOOLP320T1	`BRAINPOOLP320T1`
SB_EC_BRAINPOOLP384R1	`BRAINPOOLP384R1`
SB_EC_BRAINPOOLP384T1	`BRAINPOOLP384T1`
SB_EC_BRAINPOOLP512R1	`BRAINPOOLP512R1`
SB_EC_BRAINPOOLP512T1	`BRAINPOOLP512T1`
SB_EC_CURVE25519	`CURVE25519`
SB_EC_CURVE448	`CURVE448`

fingerprint
String (read-only)
Default Value: ""

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

friendlyName
String (read-only)
Default Value: ""

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

handle
Int64
Default Value: 0

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

hashAlgorithm
String
Default Value: ""

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use to find out the hash algorithm that is part of the certificate signature.


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

issuer
String (read-only)
Default Value: ""

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via .

issuerRDN
String
Default Value: ""

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

keyAlgorithm
String
Default Value: "0"

Specifies the public key algorithm of this certificate.


SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION	`rsaEncryption`
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	`md2withRSAEncryption`
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	`md5withRSAEncryption`
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	`sha1withRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA	`id-dsa`
SB_CERT_ALGORITHM_ID_DSA_SHA1	`id-dsa-with-sha1`
SB_CERT_ALGORITHM_DH_PUBLIC	`dhpublicnumber`
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	`sha224WithRSAEncryption`
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	`sha256WithRSAEncryption`
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	`sha384WithRSAEncryption`
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	`sha512WithRSAEncryption`
SB_CERT_ALGORITHM_ID_RSAPSS	`id-RSASSA-PSS`
SB_CERT_ALGORITHM_ID_RSAOAEP	`id-RSAES-OAEP`
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	`ripemd160withRSA`
SB_CERT_ALGORITHM_ID_ELGAMAL	`elGamal`
SB_CERT_ALGORITHM_SHA1_ECDSA	`ecdsa-with-SHA1`
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA	`ecdsa-recommended`
SB_CERT_ALGORITHM_SHA224_ECDSA	`ecdsa-with-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA	`ecdsa-with-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA	`ecdsa-with-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA	`ecdsa-with-SHA512`
SB_CERT_ALGORITHM_EC	`id-ecPublicKey`
SB_CERT_ALGORITHM_SPECIFIED_ECDSA	`ecdsa-specified`
SB_CERT_ALGORITHM_GOST_R3410_1994	`id-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3410_2001	`id-GostR3410-2001`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994	`id-GostR3411-94-with-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001	`id-GostR3411-94-with-GostR3410-2001`
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN	`ecdsa-plain-SHA1`
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN	`ecdsa-plain-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN	`ecdsa-plain-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN	`ecdsa-plain-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN	`ecdsa-plain-SHA512`
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN	`ecdsa-plain-RIPEMD160`
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION	`whirlpoolWithRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA_SHA224	`id-dsa-with-sha224`
SB_CERT_ALGORITHM_ID_DSA_SHA256	`id-dsa-with-sha256`
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA	`id-ecdsa-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA	`id-ecdsa-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA	`id-ecdsa-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA	`id-ecdsa-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-512`
SB_CERT_ALGORITHM_ID_DSA_SHA3_224	`id-dsa-with-sha3-224`
SB_CERT_ALGORITHM_ID_DSA_SHA3_256	`id-dsa-with-sha3-256`
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA	`id-ecdsa-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA	`id-ecdsa-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA	`id-ecdsa-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA	`id-ecdsa-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA	`id-ecdsa-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA	`id-ecdsa-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA	`id-ecdsa-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA	`id-ecdsa-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b512`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224	`id-dsa-with-blake2s224`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256	`id-dsa-with-blake2s256`
SB_CERT_ALGORITHM_EDDSA_ED25519	`id-Ed25519`
SB_CERT_ALGORITHM_EDDSA_ED448	`id-Ed448`
SB_CERT_ALGORITHM_EDDSA_ED25519_PH	`id-Ed25519ph`
SB_CERT_ALGORITHM_EDDSA_ED448_PH	`id-Ed448ph`
SB_CERT_ALGORITHM_EDDSA	`id-EdDSA`
SB_CERT_ALGORITHM_EDDSA_SIGNATURE	`id-EdDSA-sig`

Use the , , and properties to get more details about the key the certificate contains.

keyBits
Int32 (read-only)
Default Value: 0

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the or property would typically contain auxiliary values, and therefore be longer.

keyFingerprint
String (read-only)
Default Value: ""

Returns a SHA1 fingerprint of the public key contained in the certificate.

Note that the key fingerprint is different from the certificate fingerprint accessible via the property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

keyUsage
Int32
Default Value: 0

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:


ckuUnknown	`0x00000`	Unknown key usage
ckuDigitalSignature	`0x00001`	Digital signature
ckuNonRepudiation	`0x00002`	Non-repudiation
ckuKeyEncipherment	`0x00004`	Key encipherment
ckuDataEncipherment	`0x00008`	Data encipherment
ckuKeyAgreement	`0x00010`	Key agreement
ckuKeyCertSign	`0x00020`	Certificate signing
ckuCRLSign	`0x00040`	Revocation signing
ckuEncipherOnly	`0x00080`	Encipher only
ckuDecipherOnly	`0x00100`	Decipher only
ckuServerAuthentication	`0x00200`	Server authentication
ckuClientAuthentication	`0x00400`	Client authentication
ckuCodeSigning	`0x00800`	Code signing
ckuEmailProtection	`0x01000`	Email protection
ckuTimeStamping	`0x02000`	Timestamping
ckuOCSPSigning	`0x04000`	OCSP signing
ckuSmartCardLogon	`0x08000`	Smartcard logon
ckuKeyPurposeClientAuth	`0x10000`	Kerberos - client authentication
ckuKeyPurposeKDC	`0x20000`	Kerberos - KDC

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

keyValid
Bool (read-only)
Default Value: False

Returns True if the certificate's key is cryptographically valid, and False otherwise.

ocspLocations
String
Default Value: ""

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this property before calling the certificate manager's Generate method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

ocspNoCheck
Bool
Default Value: False

Accessor to the value of the certificate's ocsp-no-check extension.

origin
Int32 (read-only)
Default Value: 0

Returns the location that the certificate was taken or loaded from.

policyIDs
String
Default Value: ""

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

Set this property when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

privateKeyBytes
Data (read-only)
Default Value: ""

Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

privateKeyExists
Bool (read-only)
Default Value: False

Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.

This property is independent from , and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

privateKeyExtractable
Bool (read-only)
Default Value: False

Indicates whether the private key is extractable (exportable).

publicKeyBytes
Data (read-only)
Default Value: ""

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

qualified
Bool (read-only)
Default Value: False

Indicates whether the certificate is qualified.

This property is set to True if the certificate is confirmed by a Trusted List to be qualified.

qualifiedStatements
QualifiedStatementsTypes
Default Value: 0

Returns a simplified qualified status of the certificate.

qualifiers
String (read-only)
Default Value: ""

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.

selfSigned
Bool (read-only)
Default Value: False

Indicates whether the certificate is self-signed (root) or signed by an external CA.

serialNumber
Data
Default Value: ""

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

sigAlgorithm
String (read-only)
Default Value: ""

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

source
PKISources (read-only)
Default Value: 0

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

subject
String (read-only)
Default Value: ""

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via .

subjectAlternativeName
String
Default Value: ""

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Subject alternative names are used to provide additional names that are impractical to store in the main field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

subjectKeyID
Data
Default Value: ""

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The and properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

subjectRDN
String
Default Value: ""

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

valid
Bool (read-only)
Default Value: False

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

validFrom
String
Default Value: ""

The time point at which the certificate becomes valid, in UTC.

validTo
String
Default Value: ""

The time point at which the certificate expires, in UTC.

Constructors

public init(stream: )

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.

public init()

Creates a new object with default field values.

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

The following fields are available:

AsyncDocumentID

CustomParams

Data

ExternalHashCalculation

Fields

asyncDocumentID
String
Default Value: ""

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

customParams
String
Default Value: ""

Custom parameters to be passed to the signing service (uninterpreted).

data
String
Default Value: ""

Additional data to be included in the async state and mirrored back by the requestor.

externalHashCalculation
Bool
Default Value: False

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.

If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

hashAlgorithm
String
Default Value: "SHA256"

Specifies the request's signature hash algorithm.


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

keyID
String
Default Value: ""

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

keySecret
String
Default Value: ""

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the topic.

method
AsyncSignMethods
Default Value: 0

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:


asmdPKCS1	`0`
asmdPKCS7	`1`

mode
ExternalCryptoModes
Default Value: 0

Specifies the external cryptography mode.

Available options:


ecmDefault	The default value (`0`)
ecmDisabled	Do not use DC or external signing (`1`)
ecmGeneric	Generic external signing with the OnExternalSign event (`2`)
ecmDCAuth	DCAuth signing (`3`)
ecmDCAuthJSON	DCAuth signing in JSON format (`4`)

publicKeyAlgorithm
String
Default Value: ""

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.


SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION	`rsaEncryption`
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	`md2withRSAEncryption`
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	`md5withRSAEncryption`
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	`sha1withRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA	`id-dsa`
SB_CERT_ALGORITHM_ID_DSA_SHA1	`id-dsa-with-sha1`
SB_CERT_ALGORITHM_DH_PUBLIC	`dhpublicnumber`
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	`sha224WithRSAEncryption`
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	`sha256WithRSAEncryption`
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	`sha384WithRSAEncryption`
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	`sha512WithRSAEncryption`
SB_CERT_ALGORITHM_ID_RSAPSS	`id-RSASSA-PSS`
SB_CERT_ALGORITHM_ID_RSAOAEP	`id-RSAES-OAEP`
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	`ripemd160withRSA`
SB_CERT_ALGORITHM_ID_ELGAMAL	`elGamal`
SB_CERT_ALGORITHM_SHA1_ECDSA	`ecdsa-with-SHA1`
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA	`ecdsa-recommended`
SB_CERT_ALGORITHM_SHA224_ECDSA	`ecdsa-with-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA	`ecdsa-with-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA	`ecdsa-with-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA	`ecdsa-with-SHA512`
SB_CERT_ALGORITHM_EC	`id-ecPublicKey`
SB_CERT_ALGORITHM_SPECIFIED_ECDSA	`ecdsa-specified`
SB_CERT_ALGORITHM_GOST_R3410_1994	`id-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3410_2001	`id-GostR3410-2001`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994	`id-GostR3411-94-with-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001	`id-GostR3411-94-with-GostR3410-2001`
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN	`ecdsa-plain-SHA1`
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN	`ecdsa-plain-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN	`ecdsa-plain-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN	`ecdsa-plain-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN	`ecdsa-plain-SHA512`
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN	`ecdsa-plain-RIPEMD160`
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION	`whirlpoolWithRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA_SHA224	`id-dsa-with-sha224`
SB_CERT_ALGORITHM_ID_DSA_SHA256	`id-dsa-with-sha256`
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA	`id-ecdsa-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA	`id-ecdsa-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA	`id-ecdsa-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA	`id-ecdsa-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-512`
SB_CERT_ALGORITHM_ID_DSA_SHA3_224	`id-dsa-with-sha3-224`
SB_CERT_ALGORITHM_ID_DSA_SHA3_256	`id-dsa-with-sha3-256`
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA	`id-ecdsa-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA	`id-ecdsa-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA	`id-ecdsa-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA	`id-ecdsa-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA	`id-ecdsa-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA	`id-ecdsa-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA	`id-ecdsa-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA	`id-ecdsa-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b512`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224	`id-dsa-with-blake2s224`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256	`id-dsa-with-blake2s256`
SB_CERT_ALGORITHM_EDDSA_ED25519	`id-Ed25519`
SB_CERT_ALGORITHM_EDDSA_ED448	`id-Ed448`
SB_CERT_ALGORITHM_EDDSA_ED25519_PH	`id-Ed25519ph`
SB_CERT_ALGORITHM_EDDSA_ED448_PH	`id-Ed448ph`
SB_CERT_ALGORITHM_EDDSA	`id-EdDSA`
SB_CERT_ALGORITHM_EDDSA_SIGNATURE	`id-EdDSA-sig`

Constructors

public init()

Creates a new ExternalCrypto object with default field values.

MailAddress Type

A container for an e-mail addressee.

Remarks

This object is a container for an e-mail identity record. A typical e-mail address consists of an RFC822 e-mail address (john@doe.com), a friendly name (John Doe), and a group name (Officers).

The following fields are available:

Address

DisplayName

GroupName

Fields

address
String
Default Value: ""

Contains the e-mail address in the form of john@doe.com.

displayName
String
Default Value: ""

Contains the friendly name of the user of this address, such as John Doe.

groupName
String
Default Value: ""

The name of the group this address belongs to.

Constructors

public init(address: )

Creates a new e-mail address object.

public init(displayName: , address: )

Creates a new e-mail address object from an address and a display name.

MailAttachment Type

Represents an attachment to an e-mail message.

Remarks

This object is a container for message attachments.

The following fields are available:

Fields

contentSubtype
String
Default Value: ""

Contains the content subtype of the attachment.

contentType
String
Default Value: ""

Contains the content type of the attachment.

creationDate
String
Default Value: ""

The creation date.

data
Data
Default Value: ""

The content of the attachment.

description_
String
Default Value: ""

Textual description of the attachment.

This property maps to the Content-Description e-mail header field. Although the field is optional, the ability to associate descriptive information with a given body is often desirable. One example is specifying the title of an image using this property.

fileName
String
Default Value: ""

Specifies the name of the attachment file.

handle
Int64
Default Value: 0

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.

id
String
Default Value: ""

Contains the attachment's unique identifier.

modificationDate
String
Default Value: ""

Specifies the date and time of the file's last modification.

readDate
String
Default Value: ""

Specifies the file's last read date.

size
Int64
Default Value: 0

The attachment's size in bytes.

Constructors

public init(contentType: )

Creates an empty mail attachment object.

MailMessage Type

Represents an e-mail message.

Remarks

This object is a container for an e-mail message.

A message consists of a header and a body. The header, in turn, consists of several header fields. The names, syntax, and expected contents of the header fields are standardized.

The message body can contain anything you like (a message may not even have a body at all).

The following fields are available:

Fields

attachmentCount
Int32 (read-only)
Default Value: 0

Returns the number of attachments in this message.

bcc
String
Default Value: ""

The contents of the BCC header field.

cc
String
Default Value: ""

The value of the CC header field.

The CC field contains the addresses of secondary recipients of the message.

comments
String
Default Value: ""

Contains additional information about the message body.

date
String
Default Value: ""

The date and time when the message entered the mail delivery system.

This field contains the date and time at which the creator of the message posted the message to the mail delivery system.

The date is returned and accepted in UTC time zone.

deliveryReceipt
Bool
Default Value: False

Enables delivery notification.

from
String
Default Value: ""

Contains the value of the From header field.

This field contains the address(es) of the message author(s). If the actual sender is not the author of the message, use to specify the sender separately.

handle
Int64
Default Value: 0

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.

htmlText
String
Default Value: ""

The HTML version of the message.

id
String
Default Value: ""

The contents of the Message-ID header field.

This field contains a unique identifier that refers to a particular version of this message.

inReplyTo
String
Default Value: ""

The value of the In-Reply-To header field.

A reply message should have the "In-Reply-To:" header field which may be used to identify the message (or messages) to which the new message is a reply.

keywords
String
Default Value: ""

The value of the Keywords header field.

This field can be used to add some important words and phrases that might be useful for the recipient.

mailer
String (read-only)
Default Value: ""

The name of the software that was used to send the message.

plainText
String
Default Value: ""

The plain text version of the message.

priority
MailPriorities
Default Value: 2

Specifies the message priority.

Available options:


mpLowest	`0`
mpLow	`1`
mpNormal	`2`
mpHigh	`3`
mpHighest	`4`

readReceipt
Bool
Default Value: False

Enables a read notification.

references
String
Default Value: ""

The value of the References header field.

A reply message should include a "References:" header field which may be used to identify the "conversation thread". If the initial message is a reply itself, the References of the reply contain combined content of its "References:", "InReplyTo:" and "MessageID:" fields, subject to their presence in the original message.

replyTo
String
Default Value: ""

The value of the Reply-To header field.

This field contains the addresses to which the replies to this message should be sent. This field is optional. If not specified, the replies must be sent to the addresses specified in the field.

returnPath
String
Default Value: ""

The value of the Return-Path header field.

This field contains the address to which this message shall be returned in case of unsuccessful delivery.

sender
String
Default Value: ""

The value of the Sender header field.

This field specifies the mailbox of the agent responsible for the actual transmission of this message. If the originator of the message can be indicated by a single mailbox and both the author and the transmitter are identical, the "Sender:" field is deemed excessive and should not be used.

sendTo
String
Default Value: ""

The value of the To header field.

This field specifies the address(es) of the primary recipient(s) of the message.

subject
String
Default Value: ""

Contains the subject field of this message.

Constructors

public init()

Creates a new empty mail message object.

MailSecuritySettings Type

Provides access to the new message security settings.

Remarks

Use this object to tune up the security setting for the created message.

The following fields are available:

Fields

claimedSigningTime
String
Default Value: ""

Specifies the signing time from the signer's computer.

Use this property to specify the signature production time. The claimed time is not covered by the signature, may be forfeited or wrong, and as such is usually taken by verifiers for informational purposes only.

encrypt
Bool
Default Value: False

Whether to encrypt the message.

encryptionAlgorithm
String
Default Value: "AES128"

Specifies the encryption algorithm to be used.


SB_SYMMETRIC_ALGORITHM_RC4	`RC4`
SB_SYMMETRIC_ALGORITHM_DES	`DES`
SB_SYMMETRIC_ALGORITHM_3DES	`3DES`
SB_SYMMETRIC_ALGORITHM_RC2	`RC2`
SB_SYMMETRIC_ALGORITHM_AES128	`AES128`
SB_SYMMETRIC_ALGORITHM_AES192	`AES192`
SB_SYMMETRIC_ALGORITHM_AES256	`AES256`
SB_SYMMETRIC_ALGORITHM_AES128_GCM	`AES128-GCM`
SB_SYMMETRIC_ALGORITHM_AES192_GCM	`AES192-GCM`
SB_SYMMETRIC_ALGORITHM_AES256_GCM	`AES256-GCM`

hashAlgorithm
String
Default Value: "SHA256"

Specifies the hash algorithm to be used.


SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`

sign
Bool
Default Value: False

Whether to sign the message.

signatureFormat
MailSignatureFormats
Default Value: 0

Specifies the signature format to use for the signed message.

Available options:


msMultipartSigned	`0`
msSignedData	`1`

signBeforeEncrypt
Bool
Default Value: True

Specifies the order of encryption and signing operations.

signMessageHeader
Bool
Default Value: False

Specifies whether to include the message header in the signature calculation.

Constructors

public init()

Creates a new MailSecuritySettings object.

StringNameValuePair Type

A simple name-value pair object.

Remarks

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

The following fields are available:

Fields

category
String
Default Value: ""

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.

format
Int32
Default Value: 0

Specifies the format (encoding) of the value contained in the 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.

name
String
Default Value: ""

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

value
String
Default Value: ""

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

Constructors

public init(name: , value: )

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

public init()

Creates an empty name-value object.

Config Settings (MailWriter 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.

MailWriter Config Settings

BitsInKey: Key length for the block cipher used for encryption. The value should be a multiple of 8.

IncludeSigningCertificate: If true (by default), the signing certificate is included into the signature. Otherwise, it is included only if SigningChain is not empty.

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

ASN1UseGlobalTagCache: Controls whether ASN.1 module should use a global object cache.

This is a performance setting. It is unlikely that you will ever need to adjust it.

AssignSystemSmartCardPins: Specifies whether CSP-level PINs should be assigned to CNG keys.

This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

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:


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

Cookies: Gets or sets local cookies for the class.

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.

DNSLocalSuffix: The suffix to assign for TLD names.

Use this global setting to adjust the default suffix to assign to top-level domain names. The default is .local.

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".

HardwareCryptoUsePolicy: The hardware crypto usage policy.

This global setting controls the hardware cryptography usage policy: auto, enable, or disable.

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.

HttpVersion: The HTTP version to use in any inner HTTP client components created.

Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

IgnoreExpiredMSCTLSigningCert: Whether to tolerate the expired Windows Update signing certificate.

It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

ListDelimiter: The delimiter character for multi-element lists.

Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

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.

OldClientSideRSAFallback: Specifies whether the SSH client should use a SHA1 fallback.

Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

ProductVersion: Returns the version of the SecureBlackbox library.

This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

ServerSSLDHKeyLength: Sets the size of the TLS DHE key exchange group.

Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

StaticDNS: Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. 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 class) 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 class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class 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 classes.

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

UseInternalRandom: Switches between SecureBlackbox-own and platform PRNGs.

Allows to switch between internal/native PRNG implementation and the one provided by the platform.

UseLegacyAdESValidation: Enables legacy AdES validation mode.

Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

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.

UseSystemNativeSizeCalculation: An internal CryptoAPI access tweak.

This is an internal setting. Please do not use it unless instructed by the support team.

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

MailWriter Errors

1048577	Invalid parameter (`SB_ERROR_INVALID_PARAMETER`)
1048578	Invalid configuration (`SB_ERROR_INVALID_SETUP`)
1048579	Invalid state (`SB_ERROR_INVALID_STATE`)
1048580	Invalid value (`SB_ERROR_INVALID_VALUE`)
1048581	Private key not found (`SB_ERROR_NO_PRIVATE_KEY`)
1048582	Cancelled by the user (`SB_ERROR_CANCELLED_BY_USER`)
1048583	The file was not found (`SB_ERROR_NO_SUCH_FILE`)
1048584	Unsupported feature or operation (`SB_ERROR_UNSUPPORTED_FEATURE`)
1048585	General error (`SB_ERROR_GENERAL_ERROR`)
22020097	Failed to assemble the mail message (`SB_ERROR_MAIL_ASSEMBLY_FAILED`)
22020098	Failed to assemble the mail message (`SB_ERROR_MAIL_PARSING_FAILED`)
22020099	No decryption certificate found (`SB_ERROR_MAIL_NO_DECRYPTION_CERTIFICATE`)