POP3Client Module

Properties   Methods   Events   Config Settings   Errors  

The POP3Client module provides client-side functionality of the POP3 protocol for collecting E-mail messages from the server.

Syntax

SecureBlackbox.POP3Client

Remarks

Use this class to retrieve e-mail messages from a POP3 server.

You can connect to a POP3 server using either username/password or with an access token. // Connect using username/password POP3Client client = new POP3Client(); client.Username = "user"; client.Password = "password"; client.Connect("mail.domain.com", 995); client.ListMessages(); for (int i = 0; i < client.Messages.Count; i++) client.ReceiveFile(i, $"path\\{i}.eml"); client.Disconnect(); // Connect using an access token (note that the username should be the same as the one used to obtain the access token) POP3Client client = new POP3Client(); client.Username = "user"; client.AccessToken = access_token; client.Connect("pop.gmail.com", 995);

Use Command and CommandReply events to get a session log. POP3Client client = new POP3Client(); client.OnCommand += delegate (Object sender, POP3ClientCommandEventArgs e) { Console.WriteLine($"C: {e.Cmd}"); }; client.OnCommandReply += delegate (Object sender, POP3ClientCommandReplyEventArgs e) { Console.WriteLine($"S: {e.Reply}"); };

Property List

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

AccessTokenAn OAuth 2.0 access token to authenticate to the server.
BlockedCertificatesThe certificates that must be rejected as trust anchors.
ConnectionInfoReturns the details of the underlying network connection.
ExternalCryptoProvides access to external signing and DC parameters.
FIPSModeReserved.
KnownCertificatesAdditional certificates for chain validation.
KnownCRLsAdditional CRLs for chain validation.
KnownOCSPsAdditional OCSP responses for chain validation.
MessageContains an e-mail message downloaded with ReceiveMessage call.
MessagesPopulates a list of messages available on the server.
PasswordA password to authenticate to the POP3 server.
ProxyThe proxy server settings.
ServerInfoEncapsulates information about the server.
SessionLogContains the complete log of the last session.
SocketSettingsManages network connection settings.
TLSClientChainThe TLS client certificate chain.
TLSServerChainThe TLS server's certificate chain.
TLSSettingsManages TLS layer settings.
TrustedCertificatesA list of trusted certificates for chain validation.
UsernameA username to authenticate to the POP3 server.

Method List

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

ConfigSets or retrieves a configuration setting.
ConnectEstablishes connection to the POP3 server.
DeleteMessageDeletes a message from the server-side mailbox.
DisconnectCloses connection to the POP3 server.
DoActionPerforms an additional action.
ListMessagesQueries a list of messages available on the server.
PingSends a NOOP command to the POP3 server.
ReceiveBytesDownloads a message to a byte array.
ReceiveFileDownloads a message to a file.
ReceiveMessageDownloads a message.
ResetResets the module settings.
UndeleteUndeletes messages marked for deletion.

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.

AuthFailedFires when an authentication attempt has failed.
AuthStartFires when the authentication is about to be started.
AuthSucceededFires when the authentication has succeeded.
CommandReports a command sent to the server.
CommandReplyReports the receipt of a reply to a command.
CommandReplyDataReturns the data that accompanies a reply to a command.
ErrorProvides information about errors during POP3 operations.
ExternalSignHandles remote or external signing initiated by the SignExternal method or other source.
NotificationThis event notifies the application about an underlying control flow event.
ProgressReports the progress of the data transfer operation.
TLSCertNeededFires when a remote TLS party requests a client certificate.
TLSCertValidateThis event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
TLSEstablishedFires when a TLS handshake with Host successfully completes.
TLSHandshakeFires when a new TLS handshake is initiated, before the handshake commences.
TLSPSKNotifies the application about the PSK key exchange.
TLSShutdownReports the graceful closure of a TLS connection.

Config Settings

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

AuthenticationsSpecifies enabled authentication methods and their priorities.
IgnoreSystemTrustWhether trusted Windows Certificate Stores should be treated as trusted.
MaxLineLengthSpecifies maximum expected line length.
RequestUIDsSpecifies whether to request message UIDs when listing messages.
SessionLogDetailsSpecifies whether login credentials should be written to the session log.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TempPathPath for storing temporary files.
TLSExtensionsTBD.
TLSPeerExtensionsTBD.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
TolerateMinorChainIssuesWhether to tolerate minor chain issues.
UseMicrosoftCTLEnables or disables the automatic use of the Microsoft online certificate trust list.
UseSystemCertificatesEnables or disables the use of the system certificates.
ASN1UseGlobalTagCacheControls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPinsSpecifies whether CSP-level PINs should be assigned to CNG keys.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the module.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
DNSLocalSuffixThe suffix to assign for TLD names.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicyThe hardware crypto usage policy.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
HttpVersionThe HTTP version to use in any inner HTTP client modules created.
IgnoreExpiredMSCTLSigningCertWhether to tolerate the expired Windows Update signing certificate.
ListDelimiterThe delimiter character for multi-element lists.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
OldClientSideRSAFallbackSpecifies whether the SSH client should use a SHA1 fallback.
PKICacheSpecifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.
PKICachePathSpecifies the file system path where cached PKI data is stored.
ProductVersionReturns the version of the SecureBlackbox library.
ServerSSLDHKeyLengthSets the size of the TLS DHE key exchange group.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseCRLObjectCachingSpecifies whether reuse of loaded CRL objects is enabled.
UseInternalRandomSwitches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidationEnables legacy AdES validation mode.
UseOCSPResponseObjectCachingSpecifies whether reuse of loaded OCSP response objects is enabled.
UseOwnDNSResolverSpecifies whether the client modules should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculationAn internal CryptoAPI access tweak.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.
XMLRDNDescriptorName[OID]Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.
XMLRDNDescriptorPriority[OID]Specifies the priority of descriptor names associated with a specific OID.
XMLRDNDescriptorReverseOrderSpecifies whether to reverse the order of descriptors in RDN.
XMLRDNDescriptorSeparatorSpecifies the separator used between descriptors in RDN.

AccessToken Property (POP3Client Module)

An OAuth 2.0 access token to authenticate to the server.

Syntax

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


@property (nonatomic,readwrite,assign,getter=accessToken,setter=setAccessToken:) NSString* accessToken;

- (NSString*)accessToken;
- (void)setAccessToken :(NSString*)newAccessToken;

Default Value

""

Remarks

Use this property to provide the access token to be used to authenticate to the destination server.

BlockedCertificates Property (POP3Client Module)

The certificates that must be rejected as trust anchors.

Syntax

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


@property (nonatomic,readwrite,assign,getter=blockedCertCount,setter=setBlockedCertCount:) int blockedCertCount;

- (int)blockedCertCount;
- (void)setBlockedCertCount :(int)newBlockedCertCount;

- (NSData*)blockedCertBytes:(int)blockedCertIndex;

- (long long)blockedCertHandle:(int)blockedCertIndex;
- (void)setBlockedCertHandle:(int)blockedCertIndex :(long long)newBlockedCertHandle;

Default Value

""

Remarks

Use this property to provide a list of compromised or blocked certificates. Any chain containing a blocked certificate will fail validation.

ConnectionInfo Property (POP3Client Module)

Returns the details of the underlying network connection.

Syntax

public var connectionInfo: TLSConnectionInfo {
  get {...}
}


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

- (BOOL)connInfoAEADCipher;

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

- (int)connInfoChainValidationDetails;

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

- (int)connInfoChainValidationResult;

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

- (NSString*)connInfoCiphersuite;

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

- (BOOL)connInfoClientAuthenticated;

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

- (BOOL)connInfoClientAuthRequested;

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

- (BOOL)connInfoConnectionEstablished;

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

- (NSData*)connInfoConnectionID;

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

- (NSString*)connInfoDigestAlgorithm;

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

- (NSString*)connInfoEncryptionAlgorithm;

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

- (BOOL)connInfoExportable;

@property (nonatomic,readonly,assign,getter=connInfoID) long long connInfoID;

- (long long)connInfoID;

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

- (NSString*)connInfoKeyExchangeAlgorithm;

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

- (int)connInfoKeyExchangeKeyBits;

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

- (NSString*)connInfoNamedECCurve;

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

- (BOOL)connInfoPFSCipher;

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

- (NSString*)connInfoPreSharedIdentity;

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

- (NSString*)connInfoPreSharedIdentityHint;

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

- (int)connInfoPublicKeyBits;

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

- (NSString*)connInfoRemoteAddress;

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

- (int)connInfoRemotePort;

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

- (BOOL)connInfoResumedSession;

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

- (BOOL)connInfoSecureConnection;

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

- (BOOL)connInfoServerAuthenticated;

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

- (NSString*)connInfoSignatureAlgorithm;

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

- (int)connInfoSymmetricBlockSize;

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

- (int)connInfoSymmetricKeyBits;

@property (nonatomic,readonly,assign,getter=connInfoTotalBytesReceived) long long connInfoTotalBytesReceived;

- (long long)connInfoTotalBytesReceived;

@property (nonatomic,readonly,assign,getter=connInfoTotalBytesSent) long long connInfoTotalBytesSent;

- (long long)connInfoTotalBytesSent;

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

- (NSString*)connInfoValidationLog;

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

- (NSString*)connInfoVersion;

Default Value

""

Remarks

Use this property to learn about the connection setup, such as the protocol security details and amounts of data transferred each way.

ExternalCrypto Property (POP3Client Module)

Provides access to external signing and DC parameters.

Syntax

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

Reserved.

Syntax

public var fipsMode: Bool {
  get {...}
  set {...}
}


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

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

Default Value

False

Remarks

This property is reserved for future use.

KnownCertificates Property (POP3Client Module)

Additional certificates for chain validation.

Syntax

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


@property (nonatomic,readwrite,assign,getter=knownCertCount,setter=setKnownCertCount:) int knownCertCount;

- (int)knownCertCount;
- (void)setKnownCertCount :(int)newKnownCertCount;

- (NSData*)knownCertBytes:(int)knownCertIndex;

- (long long)knownCertHandle:(int)knownCertIndex;
- (void)setKnownCertHandle:(int)knownCertIndex :(long long)newKnownCertHandle;

Default Value

""

Remarks

Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the class manually.

The purpose of the certificates to be added to this collection is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows.

Do not add trust anchors or root certificates to this collection: add them to TrustedCertificates instead.

KnownCRLs Property (POP3Client Module)

Additional CRLs for chain validation.

Syntax

public var knownCRLs: Array<CRL> {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=knownCRLCount,setter=setKnownCRLCount:) int knownCRLCount;

- (int)knownCRLCount;
- (void)setKnownCRLCount :(int)newKnownCRLCount;

- (NSData*)knownCRLBytes:(int)knownCRLIndex;

- (long long)knownCRLHandle:(int)knownCRLIndex;
- (void)setKnownCRLHandle:(int)knownCRLIndex :(long long)newKnownCRLHandle;

Default Value

""

Remarks

Use this property to supply additional CRLs that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated CRLs are stored separately from the signed message or document.

KnownOCSPs Property (POP3Client Module)

Additional OCSP responses for chain validation.

Syntax

public var knownOCSPs: Array<OCSPResponse> {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=knownOCSPCount,setter=setKnownOCSPCount:) int knownOCSPCount;

- (int)knownOCSPCount;
- (void)setKnownOCSPCount :(int)newKnownOCSPCount;

- (NSData*)knownOCSPBytes:(int)knownOCSPIndex;

- (long long)knownOCSPHandle:(int)knownOCSPIndex;
- (void)setKnownOCSPHandle:(int)knownOCSPIndex :(long long)newKnownOCSPHandle;

Default Value

""

Remarks

Use this property to supply additional OCSP responses that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated OCSP responses are stored separately from the signed message or document.

Message Property (POP3Client Module)

Contains an e-mail message downloaded with ReceiveMessage call.

Syntax

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


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

- (int)msgAttachmentCount;

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

- (NSString*)msgBcc;

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

- (NSString*)msgCc;

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

- (NSString*)msgComments;

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

- (NSString*)msgDate;

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

- (BOOL)msgDeliveryReceipt;

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

- (NSString*)msgFrom;

@property (nonatomic,readonly,assign,getter=msgHandle) long long msgHandle;

- (long long)msgHandle;

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

- (NSString*)msgHtmlText;

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

- (NSString*)msgID;

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

- (NSString*)msgInReplyTo;

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

- (NSString*)msgKeywords;

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

- (NSString*)msgMailer;

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

- (NSString*)msgPlainText;

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

- (int)msgPriority;

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

- (BOOL)msgReadReceipt;

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

- (NSString*)msgReferences;

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

- (NSString*)msgReplyTo;

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

- (NSString*)msgReturnPath;

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

- (NSString*)msgSender;

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

- (NSString*)msgSendTo;

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

- (NSString*)msgSubject;

Default Value

""

Remarks

Use this property to access the e-mail message that was downloaded with a preceding ReceiveMessage call.

Messages Property (POP3Client Module)

Populates a list of messages available on the server.

Syntax

public var messages: Array<POP3MessageInfo> {
  get {...}
}


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

- (int)msgInfoCount;

- (long long)msgInfoSize:(int)msgInfoIndex;

- (NSString*)msgInfoUID:(int)msgInfoIndex;

Default Value

""

Remarks

Use this property to access the details of messages after a ListMessages call.

Password Property (POP3Client Module)

A password to authenticate to the POP3 server.

Syntax

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


@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password;

- (NSString*)password;
- (void)setPassword :(NSString*)newPassword;

Default Value

""

Remarks

Use this property together with Username to provide an authentication password.

In order to use OAuth 2.0 authentication to access the POP3 server, use the AccessToken property instead.

Proxy Property (POP3Client Module)

The proxy server settings.

Syntax

public var proxy: ProxySettings {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=proxyAddress,setter=setProxyAddress:) NSString* proxyAddress;

- (NSString*)proxyAddress;
- (void)setProxyAddress :(NSString*)newProxyAddress;

@property (nonatomic,readwrite,assign,getter=proxyAuthentication,setter=setProxyAuthentication:) int proxyAuthentication;

- (int)proxyAuthentication;
- (void)setProxyAuthentication :(int)newProxyAuthentication;

@property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword;

- (NSString*)proxyPassword;
- (void)setProxyPassword :(NSString*)newProxyPassword;

@property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort;

- (int)proxyPort;
- (void)setProxyPort :(int)newProxyPort;

@property (nonatomic,readwrite,assign,getter=proxyProxyType,setter=setProxyProxyType:) int proxyProxyType;

- (int)proxyProxyType;
- (void)setProxyProxyType :(int)newProxyProxyType;

@property (nonatomic,readwrite,assign,getter=proxyRequestHeaders,setter=setProxyRequestHeaders:) NSString* proxyRequestHeaders;

- (NSString*)proxyRequestHeaders;
- (void)setProxyRequestHeaders :(NSString*)newProxyRequestHeaders;

@property (nonatomic,readwrite,assign,getter=proxyResponseBody,setter=setProxyResponseBody:) NSString* proxyResponseBody;

- (NSString*)proxyResponseBody;
- (void)setProxyResponseBody :(NSString*)newProxyResponseBody;

@property (nonatomic,readwrite,assign,getter=proxyResponseHeaders,setter=setProxyResponseHeaders:) NSString* proxyResponseHeaders;

- (NSString*)proxyResponseHeaders;
- (void)setProxyResponseHeaders :(NSString*)newProxyResponseHeaders;

@property (nonatomic,readwrite,assign,getter=proxyUseIPv6,setter=setProxyUseIPv6:) BOOL proxyUseIPv6;

- (BOOL)proxyUseIPv6;
- (void)setProxyUseIPv6 :(BOOL)newProxyUseIPv6;

@property (nonatomic,readwrite,assign,getter=proxyUsername,setter=setProxyUsername:) NSString* proxyUsername;

- (NSString*)proxyUsername;
- (void)setProxyUsername :(NSString*)newProxyUsername;

Default Value

""

Remarks

Use this property to tune up the proxy server settings.

ServerInfo Property (POP3Client Module)

Encapsulates information about the server.

Syntax

public var serverInfo: POP3ServerInfo {
  get {...}
}


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

- (BOOL)serverInfoAvailable;

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

- (int)serverInfoExpirationPeriod;

@property (nonatomic,readonly,assign,getter=serverInfoFeatures) long long serverInfoFeatures;

- (long long)serverInfoFeatures;

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

- (int)serverInfoLoginDelay;

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

- (NSString*)serverInfoServerDetails;

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

- (NSString*)serverInfoSupportedAuths;

Default Value

""

Remarks

Use this property after establishing a connection to the server to learn about the POP3 server's capabilities.

SessionLog Property (POP3Client Module)

Contains the complete log of the last session.

Syntax

public var sessionLog: String {
  get {...}
}


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

- (NSString*)sessionLog;

Default Value

""

Remarks

Use this property to access the session log produced by the class. The log can be very useful when investigating connection issues.

See the SessionLogDetails config property for the log details settings.

This property is read-only.

SocketSettings Property (POP3Client Module)

Manages network connection settings.

Syntax

public var socketSettings: SocketSettings {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=socketDNSMode,setter=setSocketDNSMode:) int socketDNSMode;

- (int)socketDNSMode;
- (void)setSocketDNSMode :(int)newSocketDNSMode;

@property (nonatomic,readwrite,assign,getter=socketDNSPort,setter=setSocketDNSPort:) int socketDNSPort;

- (int)socketDNSPort;
- (void)setSocketDNSPort :(int)newSocketDNSPort;

@property (nonatomic,readwrite,assign,getter=socketDNSQueryTimeout,setter=setSocketDNSQueryTimeout:) int socketDNSQueryTimeout;

- (int)socketDNSQueryTimeout;
- (void)setSocketDNSQueryTimeout :(int)newSocketDNSQueryTimeout;

@property (nonatomic,readwrite,assign,getter=socketDNSServers,setter=setSocketDNSServers:) NSString* socketDNSServers;

- (NSString*)socketDNSServers;
- (void)setSocketDNSServers :(NSString*)newSocketDNSServers;

@property (nonatomic,readwrite,assign,getter=socketDNSTotalTimeout,setter=setSocketDNSTotalTimeout:) int socketDNSTotalTimeout;

- (int)socketDNSTotalTimeout;
- (void)setSocketDNSTotalTimeout :(int)newSocketDNSTotalTimeout;

@property (nonatomic,readwrite,assign,getter=socketIncomingSpeedLimit,setter=setSocketIncomingSpeedLimit:) int socketIncomingSpeedLimit;

- (int)socketIncomingSpeedLimit;
- (void)setSocketIncomingSpeedLimit :(int)newSocketIncomingSpeedLimit;

@property (nonatomic,readwrite,assign,getter=socketLocalAddress,setter=setSocketLocalAddress:) NSString* socketLocalAddress;

- (NSString*)socketLocalAddress;
- (void)setSocketLocalAddress :(NSString*)newSocketLocalAddress;

@property (nonatomic,readwrite,assign,getter=socketLocalPort,setter=setSocketLocalPort:) int socketLocalPort;

- (int)socketLocalPort;
- (void)setSocketLocalPort :(int)newSocketLocalPort;

@property (nonatomic,readwrite,assign,getter=socketOutgoingSpeedLimit,setter=setSocketOutgoingSpeedLimit:) int socketOutgoingSpeedLimit;

- (int)socketOutgoingSpeedLimit;
- (void)setSocketOutgoingSpeedLimit :(int)newSocketOutgoingSpeedLimit;

@property (nonatomic,readwrite,assign,getter=socketTimeout,setter=setSocketTimeout:) int socketTimeout;

- (int)socketTimeout;
- (void)setSocketTimeout :(int)newSocketTimeout;

@property (nonatomic,readwrite,assign,getter=socketUseIPv6,setter=setSocketUseIPv6:) BOOL socketUseIPv6;

- (BOOL)socketUseIPv6;
- (void)setSocketUseIPv6 :(BOOL)newSocketUseIPv6;

Default Value

""

Remarks

Use this property to tune up network connection parameters.

TLSClientChain Property (POP3Client Module)

The TLS client certificate chain.

Syntax

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


@property (nonatomic,readwrite,assign,getter=TLSClientCertCount,setter=setTLSClientCertCount:) int TLSClientCertCount;

- (int)TLSClientCertCount;
- (void)setTLSClientCertCount :(int)newTLSClientCertCount;

- (NSData*)TLSClientCertBytes:(int)tLSClientCertIndex;

- (long long)TLSClientCertHandle:(int)tLSClientCertIndex;
- (void)setTLSClientCertHandle:(int)tLSClientCertIndex :(long long)newTLSClientCertHandle;

Default Value

""

Remarks

Assign a certificate chain to this property to enable TLS client authentication in the class. Note that the client's end-entity certificate should have a private key associated with it.

Use the CertificateStorage or CertificateManager components to import the certificate from a file, system store, or PKCS11 device.

TLSServerChain Property (POP3Client Module)

The TLS server's certificate chain.

Syntax

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


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

- (int)TLSServerCertCount;

- (NSData*)TLSServerCertBytes:(int)tLSServerCertIndex;

- (NSString*)TLSServerCertFingerprint:(int)tLSServerCertIndex;

- (long long)TLSServerCertHandle:(int)tLSServerCertIndex;

- (NSString*)TLSServerCertIssuer:(int)tLSServerCertIndex;

- (NSString*)TLSServerCertIssuerRDN:(int)tLSServerCertIndex;

- (NSString*)TLSServerCertKeyAlgorithm:(int)tLSServerCertIndex;

- (int)TLSServerCertKeyBits:(int)tLSServerCertIndex;

- (int)TLSServerCertKeyUsage:(int)tLSServerCertIndex;

- (BOOL)TLSServerCertSelfSigned:(int)tLSServerCertIndex;

- (NSData*)TLSServerCertSerialNumber:(int)tLSServerCertIndex;

- (NSString*)TLSServerCertSigAlgorithm:(int)tLSServerCertIndex;

- (NSString*)TLSServerCertSubject:(int)tLSServerCertIndex;

- (NSString*)TLSServerCertSubjectRDN:(int)tLSServerCertIndex;

- (NSString*)TLSServerCertValidFrom:(int)tLSServerCertIndex;

- (NSString*)TLSServerCertValidTo:(int)tLSServerCertIndex;

Default Value

""

Remarks

Use this property to access the certificate chain sent by the TLS server. This property is ready to read when the TLSCertValidate event is fired by the client component.

TLSSettings Property (POP3Client Module)

Manages TLS layer settings.

Syntax

public var tlsSettings: TLSSettings {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=TLSAutoValidateCertificates,setter=setTLSAutoValidateCertificates:) BOOL TLSAutoValidateCertificates;

- (BOOL)TLSAutoValidateCertificates;
- (void)setTLSAutoValidateCertificates :(BOOL)newTLSAutoValidateCertificates;

@property (nonatomic,readwrite,assign,getter=TLSBaseConfiguration,setter=setTLSBaseConfiguration:) int TLSBaseConfiguration;

- (int)TLSBaseConfiguration;
- (void)setTLSBaseConfiguration :(int)newTLSBaseConfiguration;

@property (nonatomic,readwrite,assign,getter=TLSCiphersuites,setter=setTLSCiphersuites:) NSString* TLSCiphersuites;

- (NSString*)TLSCiphersuites;
- (void)setTLSCiphersuites :(NSString*)newTLSCiphersuites;

@property (nonatomic,readwrite,assign,getter=TLSClientAuth,setter=setTLSClientAuth:) int TLSClientAuth;

- (int)TLSClientAuth;
- (void)setTLSClientAuth :(int)newTLSClientAuth;

@property (nonatomic,readwrite,assign,getter=TLSECCurves,setter=setTLSECCurves:) NSString* TLSECCurves;

- (NSString*)TLSECCurves;
- (void)setTLSECCurves :(NSString*)newTLSECCurves;

@property (nonatomic,readwrite,assign,getter=TLSExtensions,setter=setTLSExtensions:) NSString* TLSExtensions;

- (NSString*)TLSExtensions;
- (void)setTLSExtensions :(NSString*)newTLSExtensions;

@property (nonatomic,readwrite,assign,getter=TLSForceResumeIfDestinationChanges,setter=setTLSForceResumeIfDestinationChanges:) BOOL TLSForceResumeIfDestinationChanges;

- (BOOL)TLSForceResumeIfDestinationChanges;
- (void)setTLSForceResumeIfDestinationChanges :(BOOL)newTLSForceResumeIfDestinationChanges;

@property (nonatomic,readwrite,assign,getter=TLSPreSharedIdentity,setter=setTLSPreSharedIdentity:) NSString* TLSPreSharedIdentity;

- (NSString*)TLSPreSharedIdentity;
- (void)setTLSPreSharedIdentity :(NSString*)newTLSPreSharedIdentity;

@property (nonatomic,readwrite,assign,getter=TLSPreSharedKey,setter=setTLSPreSharedKey:) NSString* TLSPreSharedKey;

- (NSString*)TLSPreSharedKey;
- (void)setTLSPreSharedKey :(NSString*)newTLSPreSharedKey;

@property (nonatomic,readwrite,assign,getter=TLSPreSharedKeyCiphersuite,setter=setTLSPreSharedKeyCiphersuite:) NSString* TLSPreSharedKeyCiphersuite;

- (NSString*)TLSPreSharedKeyCiphersuite;
- (void)setTLSPreSharedKeyCiphersuite :(NSString*)newTLSPreSharedKeyCiphersuite;

@property (nonatomic,readwrite,assign,getter=TLSRenegotiationAttackPreventionMode,setter=setTLSRenegotiationAttackPreventionMode:) int TLSRenegotiationAttackPreventionMode;

- (int)TLSRenegotiationAttackPreventionMode;
- (void)setTLSRenegotiationAttackPreventionMode :(int)newTLSRenegotiationAttackPreventionMode;

@property (nonatomic,readwrite,assign,getter=TLSRevocationCheck,setter=setTLSRevocationCheck:) int TLSRevocationCheck;

- (int)TLSRevocationCheck;
- (void)setTLSRevocationCheck :(int)newTLSRevocationCheck;

@property (nonatomic,readwrite,assign,getter=TLSSSLOptions,setter=setTLSSSLOptions:) int TLSSSLOptions;

- (int)TLSSSLOptions;
- (void)setTLSSSLOptions :(int)newTLSSSLOptions;

@property (nonatomic,readwrite,assign,getter=TLSTLSMode,setter=setTLSTLSMode:) int TLSTLSMode;

- (int)TLSTLSMode;
- (void)setTLSTLSMode :(int)newTLSTLSMode;

@property (nonatomic,readwrite,assign,getter=TLSUseExtendedMasterSecret,setter=setTLSUseExtendedMasterSecret:) BOOL TLSUseExtendedMasterSecret;

- (BOOL)TLSUseExtendedMasterSecret;
- (void)setTLSUseExtendedMasterSecret :(BOOL)newTLSUseExtendedMasterSecret;

@property (nonatomic,readwrite,assign,getter=TLSUseSessionResumption,setter=setTLSUseSessionResumption:) BOOL TLSUseSessionResumption;

- (BOOL)TLSUseSessionResumption;
- (void)setTLSUseSessionResumption :(BOOL)newTLSUseSessionResumption;

@property (nonatomic,readwrite,assign,getter=TLSVersions,setter=setTLSVersions:) int TLSVersions;

- (int)TLSVersions;
- (void)setTLSVersions :(int)newTLSVersions;

Default Value

""

Remarks

Use this property to tune up the TLS layer parameters.

TrustedCertificates Property (POP3Client Module)

A list of trusted certificates for chain validation.

Syntax

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


@property (nonatomic,readwrite,assign,getter=trustedCertCount,setter=setTrustedCertCount:) int trustedCertCount;

- (int)trustedCertCount;
- (void)setTrustedCertCount :(int)newTrustedCertCount;

- (NSData*)trustedCertBytes:(int)trustedCertIndex;

- (long long)trustedCertHandle:(int)trustedCertIndex;
- (void)setTrustedCertHandle:(int)trustedCertIndex :(long long)newTrustedCertHandle;

Default Value

""

Remarks

Use this property to supply a list of trusted certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when root CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually.

The purpose of this certificate collection is largely the same as that of the Windows Trusted Root Certification Authorities system store.

Use this property with extreme care as it directly affects chain verifiability; a wrong certificate added to the trusted list may result in bad chains being accepted, and forfeited signatures being recognized as genuine. Only add certificates that originate from the parties that you know and trust.

Username Property (POP3Client Module)

A username to authenticate to the POP3 server.

Syntax

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


@property (nonatomic,readwrite,assign,getter=username,setter=setUsername:) NSString* username;

- (NSString*)username;
- (void)setUsername :(NSString*)newUsername;

Default Value

""

Remarks

Use this property together with Password to provide authentication credentials to the component.

Config Method (POP3Client Module)

Sets or retrieves a configuration setting.

Syntax

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

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

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

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

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

Connect Method (POP3Client Module)

Establishes connection to the POP3 server.

Syntax

public func connect(address: String, port: Int32) throws -> Void

- (void)connect:(NSString*)address :(int)port;

Remarks

Use this method to establish connection to a POP3 server at Address and Port.

DeleteMessage Method (POP3Client Module)

Deletes a message from the server-side mailbox.

Syntax

public func deleteMessage(index: Int32) throws -> Void

- (void)deleteMessage:(int)index;

Remarks

Call this method to delete a message from the mailbox.

Note that the message may not be deleted immediately. It is typical for POP3 servers to only mark messages for deletion upon receipt of this command, and only delete them after the connection has been gracefully closed.

If needed, messages can be "undeleted" during the same session by calling the Undelete method.

Disconnect Method (POP3Client Module)

Closes connection to the POP3 server.

Syntax

public func disconnect() throws -> Void

- (void)disconnect;

Remarks

Call this method to gracefully terminate the connection.

DoAction Method (POP3Client Module)

Performs an additional action.

Syntax

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

- (NSString*)doAction:(NSString*)actionID :(NSString*)actionParams;

Remarks

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

The unique identifier (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;....

Common ActionIDs:

ActionParametersReturned valueDescription
ResetTrustedListCachenonenoneClears the cached list of trusted lists.
ResetCertificateCachenonenoneClears the cached certificates.
ResetCRLCachenonenoneClears the cached CRLs.
ResetOCSPResponseCachenonenoneClears the cached OCSP responses.

ListMessages Method (POP3Client Module)

Queries a list of messages available on the server.

Syntax

public func listMessages() throws -> Void

- (void)listMessages;

Remarks

Use this method to request a list of messages currently available on the server. Use the Messages property to access the message details.

Ping Method (POP3Client Module)

Sends a NOOP command to the POP3 server.

Syntax

public func ping() throws -> Void

- (void)ping;

Remarks

This method sends a NOOP command to the server, effectively pinging the server and keeping the connection alive.

ReceiveBytes Method (POP3Client Module)

Downloads a message to a byte array.

Syntax

public func receiveBytes(index: Int32) throws -> Data

- (NSData*)receiveBytes:(int)index;

Remarks

Use this method to download a server-side message to a byte array.

ReceiveFile Method (POP3Client Module)

Downloads a message to a file.

Syntax

public func receiveFile(index: Int32, fileName: String) throws -> Void

- (void)receiveFile:(int)index :(NSString*)fileName;

Remarks

Use this method to download a server-side message to a local file.

ReceiveMessage Method (POP3Client Module)

Downloads a message.

Syntax

public func receiveMessage(index: Int32) throws -> Void

- (void)receiveMessage:(int)index;

Remarks

Use this method to download a server-side message to the Message object.

Reset Method (POP3Client Module)

Resets the component settings.

Syntax

public func reset() throws -> Void

- (void)reset;

Remarks

Reset is a generic method available in every class.

Undelete Method (POP3Client Module)

Undeletes messages marked for deletion.

Syntax

public func undelete() throws -> Void

- (void)undelete;

Remarks

This method sends an RSET command, which tells the server to undelete all previously deleted messages by removing their 'delete' marks.

Note that this method only applies to messages deleted within the same session.

AuthFailed Event (POP3Client Module)

Fires when an authentication attempt has failed.

Syntax

func onAuthFailed(auth: String, errorCode: Int32, errorMessage: String, serverReply: String, tryAgain: inout Bool)

- (void)onAuthFailed:(NSString*)auth :(int)errorCode :(NSString*)errorMessage :(NSString*)serverReply :(int*)tryAgain;

Remarks

The class fires this event when an authentication attempt has failed for some reason.

Auth reports the authentication method that has failed. You can adjust the Authentications config property to try another method.

ErrorCode contains an error code, and ErrorMessage contains an error message.

ServerReply provides the error info reported by the server. This info depends on the transport protocol and on the authentication method.

Set the TryAgain parameter to true if the class should try to authenticate again. If the parameter remains false, the authentication will fail with an exception.

AuthStart Event (POP3Client Module)

Fires when the authentication is about to be started.

Syntax

func onAuthStart(usableAuths: String)

- (void)onAuthStart:(NSString*)usableAuths;

Remarks

The class fires this event when it has established the TCP connection and is ready to proceed to the user authentication step.

The UsableAuths parameter contains a comma-separated list of the authentication methods supported by both, the client and the server.

In this event handler it's possible to update the method list in the Authentications config property according to the provided list of usable methods. The full list of the authentication methods supported by the server is available in ServerInfo.SupportedAuths.

AuthSucceeded Event (POP3Client Module)

Fires when the authentication has succeeded.

Syntax

func onAuthSucceeded(auth: String)

- (void)onAuthSucceeded:(NSString*)auth;

Remarks

The class fires this event when it has succeeded to authenticate to the server. Auth reports the authentication method that has succeeded.

Command Event (POP3Client Module)

Reports a command sent to the server.

Syntax

func onCommand(cmd: String)

- (void)onCommand:(NSString*)cmd;

Remarks

The class fires this event whenever it sends a POP3 command to the server. Use CommandReply and CommandReplyData to track the server's responses.

CommandReply Event (POP3Client Module)

Reports the receipt of a reply to a command.

Syntax

func onCommandReply(cmd: String, reply: String)

- (void)onCommandReply:(NSString*)cmd :(NSString*)reply;

Remarks

Use this event to track command replies sent in by the server. Use Command to track the commands sent out by the client, and CommandReplyData to access the reply data for commands that assume it.

CommandReplyData Event (POP3Client Module)

Returns the data that accompanies a reply to a command.

Syntax

func onCommandReplyData(cmd: String, data: String)

- (void)onCommandReplyData:(NSString*)cmd :(NSString*)data;

Remarks

Subscribe to this event to access data accompanying incoming command replies.

Error Event (POP3Client Module)

Provides information about errors during POP3 operations.

Syntax

func onError(errorCode: Int32, description: String)

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

Remarks

This event is fired in case of exceptional conditions occured during POP3 operations.

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

ExternalSign Event (POP3Client Module)

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

Syntax

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

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

Syntax

func onNotification(eventID: String, eventParam: String)

- (void)onNotification:(NSString*)eventID :(NSString*)eventParam;

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the 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.

This class can fire this event with the following EventID values:

TLSExtensions.CertificateStatusTBD
TLSExtensions.PreSharedIdentityHintTBD

Progress Event (POP3Client Module)

Reports the progress of the data transfer operation.

Syntax

func onProgress(total: Int64, current: Int64, cancel: inout Bool)

- (void)onProgress:(long long)total :(long long)current :(int*)cancel;

Remarks

The class fires this event repeatedly to report the progress of the data transfer operation.

TLSCertNeeded Event (POP3Client Module)

Fires when a remote TLS party requests a client certificate.

Syntax

func onTLSCertNeeded(host: String, caNames: String)

- (void)onTLSCertNeeded:(NSString*)host :(NSString*)CANames;

Remarks

This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.

Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.

This event is preceded by the TLSHandshake event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.

TLSCertValidate Event (POP3Client Module)

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Syntax

func onTLSCertValidate(serverHost: String, serverIP: String, accept: inout Bool)

- (void)onTLSCertValidate:(NSString*)serverHost :(NSString*)serverIP :(int*)accept;

Remarks

This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, classes may contact a number of TLS endpoints during their work, depending on their configuration.

Accept is assigned in accordance with the outcome of the internal validation check performed by the class, and can be adjusted if needed.

TLSEstablished Event (POP3Client Module)

Fires when a TLS handshake with Host successfully completes.

Syntax

func onTLSEstablished(host: String, version: String, ciphersuite: String, connectionId: Data, abort: inout Bool)

- (void)onTLSEstablished:(NSString*)host :(NSString*)version :(NSString*)ciphersuite :(NSData*)connectionId :(int*)abort;

Remarks

The class uses this event to notify the application about a successful completion of a TLS handshake.

The Version, Ciphersuite, and ConnectionId parameters indicate the security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.

TLSHandshake Event (POP3Client Module)

Fires when a new TLS handshake is initiated, before the handshake commences.

Syntax

func onTLSHandshake(host: String, abort: inout Bool)

- (void)onTLSHandshake:(NSString*)host :(int*)abort;

Remarks

The class uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed by the TLSEstablished event. If the server chooses to request a client certificate, the TLSCertNeeded event will also be fired.

TLSPSK Event (POP3Client Module)

Notifies the application about the PSK key exchange.

Syntax

func onTLSPSK(host: String, hint: String)

- (void)onTLSPSK:(NSString*)host :(NSString*)hint;

Remarks

The class fires this event to notify the application about the beginning of TLS-PSK key exchange with Host. The Hint parameter may be used by the server to identify the key or service to use. Use the PreSharedKey field of TLSSettings to provide the pre-shared key to the component.

TLSShutdown Event (POP3Client Module)

Reports the graceful closure of a TLS connection.

Syntax

func onTLSShutdown(host: String)

- (void)onTLSShutdown:(NSString*)host;

Remarks

This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.

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:
  • Bytes
  • CA
  • CAKeyID
  • CertType
  • CRLDistributionPoints
  • Curve
  • Fingerprint
  • FriendlyName
  • Handle
  • HashAlgorithm
  • Issuer
  • IssuerRDN
  • KeyAlgorithm
  • KeyBits
  • KeyFingerprint
  • KeyUsage
  • KeyValid
  • OCSPLocations
  • OCSPNoCheck
  • Origin
  • PolicyIDs
  • PrivateKeyBytes
  • PrivateKeyExists
  • PrivateKeyExtractable
  • PublicKeyBytes
  • Qualified
  • QualifiedStatements
  • Qualifiers
  • SelfSigned
  • SerialNumber
  • SigAlgorithm
  • Source
  • Subject
  • SubjectAlternativeName
  • SubjectKeyID
  • SubjectRDN
  • Valid
  • ValidFrom
  • ValidTo

    • 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_SECP112R1SECP112R1
    SB_EC_SECP112R2SECP112R2
    SB_EC_SECP128R1SECP128R1
    SB_EC_SECP128R2SECP128R2
    SB_EC_SECP160K1SECP160K1
    SB_EC_SECP160R1SECP160R1
    SB_EC_SECP160R2SECP160R2
    SB_EC_SECP192K1SECP192K1
    SB_EC_SECP192R1SECP192R1
    SB_EC_SECP224K1SECP224K1
    SB_EC_SECP224R1SECP224R1
    SB_EC_SECP256K1SECP256K1
    SB_EC_SECP256R1SECP256R1
    SB_EC_SECP384R1SECP384R1
    SB_EC_SECP521R1SECP521R1
    SB_EC_SECT113R1SECT113R1
    SB_EC_SECT113R2SECT113R2
    SB_EC_SECT131R1SECT131R1
    SB_EC_SECT131R2SECT131R2
    SB_EC_SECT163K1SECT163K1
    SB_EC_SECT163R1SECT163R1
    SB_EC_SECT163R2SECT163R2
    SB_EC_SECT193R1SECT193R1
    SB_EC_SECT193R2SECT193R2
    SB_EC_SECT233K1SECT233K1
    SB_EC_SECT233R1SECT233R1
    SB_EC_SECT239K1SECT239K1
    SB_EC_SECT283K1SECT283K1
    SB_EC_SECT283R1SECT283R1
    SB_EC_SECT409K1SECT409K1
    SB_EC_SECT409R1SECT409R1
    SB_EC_SECT571K1SECT571K1
    SB_EC_SECT571R1SECT571R1
    SB_EC_PRIME192V1PRIME192V1
    SB_EC_PRIME192V2PRIME192V2
    SB_EC_PRIME192V3PRIME192V3
    SB_EC_PRIME239V1PRIME239V1
    SB_EC_PRIME239V2PRIME239V2
    SB_EC_PRIME239V3PRIME239V3
    SB_EC_PRIME256V1PRIME256V1
    SB_EC_C2PNB163V1C2PNB163V1
    SB_EC_C2PNB163V2C2PNB163V2
    SB_EC_C2PNB163V3C2PNB163V3
    SB_EC_C2PNB176W1C2PNB176W1
    SB_EC_C2TNB191V1C2TNB191V1
    SB_EC_C2TNB191V2C2TNB191V2
    SB_EC_C2TNB191V3C2TNB191V3
    SB_EC_C2ONB191V4C2ONB191V4
    SB_EC_C2ONB191V5C2ONB191V5
    SB_EC_C2PNB208W1C2PNB208W1
    SB_EC_C2TNB239V1C2TNB239V1
    SB_EC_C2TNB239V2C2TNB239V2
    SB_EC_C2TNB239V3C2TNB239V3
    SB_EC_C2ONB239V4C2ONB239V4
    SB_EC_C2ONB239V5C2ONB239V5
    SB_EC_C2PNB272W1C2PNB272W1
    SB_EC_C2PNB304W1C2PNB304W1
    SB_EC_C2TNB359V1C2TNB359V1
    SB_EC_C2PNB368W1C2PNB368W1
    SB_EC_C2TNB431R1C2TNB431R1
    SB_EC_NISTP192NISTP192
    SB_EC_NISTP224NISTP224
    SB_EC_NISTP256NISTP256
    SB_EC_NISTP384NISTP384
    SB_EC_NISTP521NISTP521
    SB_EC_NISTB163NISTB163
    SB_EC_NISTB233NISTB233
    SB_EC_NISTB283NISTB283
    SB_EC_NISTB409NISTB409
    SB_EC_NISTB571NISTB571
    SB_EC_NISTK163NISTK163
    SB_EC_NISTK233NISTK233
    SB_EC_NISTK283NISTK283
    SB_EC_NISTK409NISTK409
    SB_EC_NISTK571NISTK571
    SB_EC_GOSTCPTESTGOSTCPTEST
    SB_EC_GOSTCPAGOSTCPA
    SB_EC_GOSTCPBGOSTCPB
    SB_EC_GOSTCPCGOSTCPC
    SB_EC_GOSTCPXCHAGOSTCPXCHA
    SB_EC_GOSTCPXCHBGOSTCPXCHB
    SB_EC_BRAINPOOLP160R1BRAINPOOLP160R1
    SB_EC_BRAINPOOLP160T1BRAINPOOLP160T1
    SB_EC_BRAINPOOLP192R1BRAINPOOLP192R1
    SB_EC_BRAINPOOLP192T1BRAINPOOLP192T1
    SB_EC_BRAINPOOLP224R1BRAINPOOLP224R1
    SB_EC_BRAINPOOLP224T1BRAINPOOLP224T1
    SB_EC_BRAINPOOLP256R1BRAINPOOLP256R1
    SB_EC_BRAINPOOLP256T1BRAINPOOLP256T1
    SB_EC_BRAINPOOLP320R1BRAINPOOLP320R1
    SB_EC_BRAINPOOLP320T1BRAINPOOLP320T1
    SB_EC_BRAINPOOLP384R1BRAINPOOLP384R1
    SB_EC_BRAINPOOLP384T1BRAINPOOLP384T1
    SB_EC_BRAINPOOLP512R1BRAINPOOLP512R1
    SB_EC_BRAINPOOLP512T1BRAINPOOLP512T1
    SB_EC_CURVE25519CURVE25519
    SB_EC_CURVE448CURVE448

    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_SHA1SHA1
    SB_HASH_ALGORITHM_SHA224SHA224
    SB_HASH_ALGORITHM_SHA256SHA256
    SB_HASH_ALGORITHM_SHA384SHA384
    SB_HASH_ALGORITHM_SHA512SHA512
    SB_HASH_ALGORITHM_MD2MD2
    SB_HASH_ALGORITHM_MD4MD4
    SB_HASH_ALGORITHM_MD5MD5
    SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
    SB_HASH_ALGORITHM_CRC32CRC32
    SB_HASH_ALGORITHM_SSL3SSL3
    SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
    SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
    SB_HASH_ALGORITHM_POLY1305POLY1305
    SB_HASH_ALGORITHM_SHA3_224SHA3_224
    SB_HASH_ALGORITHM_SHA3_256SHA3_256
    SB_HASH_ALGORITHM_SHA3_384SHA3_384
    SB_HASH_ALGORITHM_SHA3_512SHA3_512
    SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
    SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
    SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
    SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
    SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
    SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
    SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
    SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
    SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
    SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
    SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
    SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

    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_ENCRYPTIONrsaEncryption
    SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
    SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
    SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
    SB_CERT_ALGORITHM_ID_DSAid-dsa
    SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
    SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
    SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
    SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
    SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
    SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
    SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
    SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
    SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
    SB_CERT_ALGORITHM_ID_ELGAMALelGamal
    SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
    SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
    SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
    SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
    SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
    SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
    SB_CERT_ALGORITHM_ECid-ecPublicKey
    SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
    SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
    SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
    SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
    SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
    SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
    SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
    SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
    SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
    SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
    SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
    SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
    SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
    SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
    SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
    SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
    SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
    SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
    SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
    SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
    SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
    SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
    SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
    SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
    SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
    SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
    SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
    SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
    SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
    SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
    SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
    SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
    SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
    SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
    SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
    SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
    SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
    SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
    SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
    SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
    SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
    SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
    SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
    SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
    SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
    SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
    SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
    SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
    SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
    SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
    SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
    SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
    SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
    SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
    SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
    SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
    SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
    SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
    SB_CERT_ALGORITHM_EDDSAid-EdDSA
    SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-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:

    ckuUnknown0x00000Unknown key usage

    ckuDigitalSignature0x00001Digital signature

    ckuNonRepudiation0x00002Non-repudiation

    ckuKeyEncipherment0x00004Key encipherment

    ckuDataEncipherment0x00008Data encipherment

    ckuKeyAgreement0x00010Key agreement

    ckuKeyCertSign0x00020Certificate signing

    ckuCRLSign0x00040Revocation signing

    ckuEncipherOnly0x00080Encipher only

    ckuDecipherOnly0x00100Decipher only

    ckuServerAuthentication0x00200Server authentication

    ckuClientAuthentication0x00400Client authentication

    ckuCodeSigning0x00800Code signing

    ckuEmailProtection0x01000Email protection

    ckuTimeStamping0x02000Timestamping

    ckuOCSPSigning0x04000OCSP signing

    ckuSmartCardLogon0x08000Smartcard logon

    ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

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

    CRL Type

    Represents a Certificate Revocation List.

    Remarks

    CRLs store information about revoked certificates, i.e., certificates that have been identified as invalid by their issuing certificate authority (CA) for any number of reasons.

    Each CRL object lists certificates from a single CA and identifies them by their serial numbers. A CA may or may not publish a CRL, may publish several CRLs, or may publish the same CRL in multiple locations.

    Unlike OCSP responses, CRLs only list certificates that have been revoked. They do not list certificates that are still valid.

    The following fields are available:
  • Bytes
  • CAKeyID
  • EntryCount
  • Handle
  • Issuer
  • IssuerRDN
  • Location
  • NextUpdate
  • SigAlgorithm
  • Source
  • TBS
  • ThisUpdate

    • Fields

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

    Returns the raw CRL data in DER format.

    caKeyID
    Data
    Default Value: ""

    A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.

    entryCount
    Int32 (read-only)
    Default Value: 0

    Returns the number of certificate status entries in the CRL.

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

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

    The common name of the CRL issuer (CA), typically a company name.

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

    A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.

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

    The URL that the CRL was downloaded from.

    nextUpdate
    String
    Default Value: ""

    The planned time and date of the next version of this CRL to be published.

    sigAlgorithm
    String
    Default Value: "0"

    The public key algorithm that was used by the CA to sign this CRL.

    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.

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

    The to-be-signed part of the CRL (the CRL without the signature part).

    thisUpdate
    String
    Default Value: ""

    The date and time at which this version of the CRL was published.

    Constructors

    public init()

    Creates an empty CRL object.

    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
  • HashAlgorithm
  • KeyID
  • KeySecret
  • Method
  • Mode
  • PublicKeyAlgorithm

    • 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_SHA1SHA1
    SB_HASH_ALGORITHM_SHA224SHA224
    SB_HASH_ALGORITHM_SHA256SHA256
    SB_HASH_ALGORITHM_SHA384SHA384
    SB_HASH_ALGORITHM_SHA512SHA512
    SB_HASH_ALGORITHM_MD2MD2
    SB_HASH_ALGORITHM_MD4MD4
    SB_HASH_ALGORITHM_MD5MD5
    SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
    SB_HASH_ALGORITHM_CRC32CRC32
    SB_HASH_ALGORITHM_SSL3SSL3
    SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
    SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
    SB_HASH_ALGORITHM_POLY1305POLY1305
    SB_HASH_ALGORITHM_SHA3_224SHA3_224
    SB_HASH_ALGORITHM_SHA3_256SHA3_256
    SB_HASH_ALGORITHM_SHA3_384SHA3_384
    SB_HASH_ALGORITHM_SHA3_512SHA3_512
    SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
    SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
    SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
    SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
    SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
    SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
    SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
    SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
    SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
    SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
    SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
    SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

    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:

    asmdPKCS10
    asmdPKCS71

    mode
    ExternalCryptoModes
    Default Value: 0

    Specifies the external cryptography mode.

    Available options:

    ecmDefaultThe default value (0)
    ecmDisabledDo not use DC or external signing (1)
    ecmGenericGeneric external signing with the OnExternalSign event (2)
    ecmDCAuthDCAuth signing (3)
    ecmDCAuthJSONDCAuth 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_ENCRYPTIONrsaEncryption
    SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
    SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
    SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
    SB_CERT_ALGORITHM_ID_DSAid-dsa
    SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
    SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
    SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
    SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
    SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
    SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
    SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
    SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
    SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
    SB_CERT_ALGORITHM_ID_ELGAMALelGamal
    SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
    SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
    SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
    SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
    SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
    SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
    SB_CERT_ALGORITHM_ECid-ecPublicKey
    SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
    SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
    SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
    SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
    SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
    SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
    SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
    SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
    SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
    SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
    SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
    SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
    SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
    SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
    SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
    SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
    SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
    SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
    SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
    SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
    SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
    SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
    SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
    SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
    SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
    SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
    SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
    SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
    SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
    SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
    SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
    SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
    SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
    SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
    SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
    SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
    SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
    SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
    SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
    SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
    SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
    SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
    SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
    SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
    SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
    SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
    SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
    SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
    SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
    SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
    SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
    SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
    SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
    SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
    SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
    SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
    SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
    SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
    SB_CERT_ALGORITHM_EDDSAid-EdDSA
    SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

    Constructors

    public init()

    Creates a new ExternalCrypto object with default field values.

    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:
  • AttachmentCount
  • Bcc
  • Cc
  • Comments
  • Date
  • DeliveryReceipt
  • From
  • Handle
  • HtmlText
  • ID
  • InReplyTo
  • Keywords
  • Mailer
  • PlainText
  • Priority
  • ReadReceipt
  • References
  • ReplyTo
  • ReturnPath
  • Sender
  • SendTo
  • Subject

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

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

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

    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:

    mpLowest0
    mpLow1
    mpNormal2
    mpHigh3
    mpHighest4

    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.

    OCSPResponse Type

    Represents a single OCSP response originating from an OCSP responder.

    Remarks

    OCSP is a protocol that allows verification of certificate status in real-time, and is an alternative to Certificate Revocation Lists (CRLs).

    An OCSP response is a snapshot of the certificate status at a given time.

    The following fields are available:
  • Bytes
  • EntryCount
  • Handle
  • Issuer
  • IssuerRDN
  • Location
  • ProducedAt
  • SigAlgorithm
  • Source

    • Fields

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

    A buffer containing the raw OCSP response data.

    entryCount
    Int32 (read-only)
    Default Value: 0

    The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status.

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

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

    Indicates the issuer of this response (a CA or its authorized representative).

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

    Indicates the RDN of the issuer of this response (a CA or its authorized representative).

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

    The location of the OCSP responder.

    producedAt
    String
    Default Value: ""

    Specifies the time when the response was produced, in UTC.

    sigAlgorithm
    String
    Default Value: "0"

    The public key algorithm that was used by the CA to sign this OCSP response.

    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.

    Constructors

    public init()

    Creates an empty OCSP response object.

    POP3MessageInfo Type

    This type is a container for the server-side message details.

    Remarks

    Use this type to get the details of server-side messages after the list call.

    The following fields are available:
  • Size
  • UID

    • Fields

    size
    Int64 (read-only)
    Default Value: 0

    Returns the size of the message in bytes.

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

    Returns the unique ID of the mail message.

    POP3ServerInfo Type

    This object contains secondary details and capabilities of the POP3 server.

    Remarks

    Use this object to find out about extensions supported by the server.

    The following fields are available:
  • Available
  • ExpirationPeriod
  • Features
  • LoginDelay
  • ServerDetails
  • SupportedAuths

    • Fields

    available
    Bool (read-only)
    Default Value: False

    Indicates whether the details of the server capabilities are available.

    expirationPeriod
    Int32 (read-only)
    Default Value: -1

    Contains the parameter of EXPIRE capability.

    features
    Int64 (read-only)
    Default Value: 0

    Returns the list of capabilities supported by the server.

    This value is bit mask of the following values:

    popApopSupported0x0001Indicates whether the POP3 server supports the APOP command.

    popExpireSupported0x0002Indicates whether the POP3 server supports the EXPIRE extension. See the ExpirationPeriod field.

    popImplementationSupported0x0004Indicates whether the POP3 server supports the IMPLEMENTATION extension. See the ServerDetails field.

    popLoginDelaySupported0x0008Indicates whether the POP3 server supports the LOGIN-DELAY extension. See the LoginDelay field.

    popRespCodesSupported0x0010Indicates whether the POP3 server supports the RESP-CODES extension. The RESP-CODES capability indicates that any response text issued by this server which begins with an open square bracket is an extended response code.

    popSaslSupported0x0020Indicates whether the POP3 server supports SASL authentication.

    popTopSupported0x0040Indicates whether the POP3 server supports the TOP command.

    popUidlSupported0x0080Indicates whether the POP3 server supports the UIDL command.

    popUserSupported0x0100Indicates whether the POP3 server supports the USER command.

    loginDelay
    Int32 (read-only)
    Default Value: 0

    Returns the parameter of LOGIN-DELAY capability.

    The LOGIN-DELAY parameter indicates the minimum number of seconds between unsuccessful login attempts. See RFC 2449, Section 6.5 for more information.

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

    Contains the parameter of the IMPLEMENTATION capability.

    The value of this property only makes sense if is true, and popImplementationSupported is set in the value.

    The parameter to the IMPLEMENTATION capability consists of one or more tokens that identify the server. For more information see RFC 2449, Section 6.9.

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

    Contains a comma-separated list of the authentication methods supported by the server.

    Use this value to setup the Authentications config property if needed.

    ProxySettings Type

    A container for proxy server settings.

    Remarks

    This type exposes a collection of properties for tuning up the proxy server configuration.

    The following fields are available:
  • Address
  • Authentication
  • Password
  • Port
  • ProxyType
  • RequestHeaders
  • ResponseBody
  • ResponseHeaders
  • UseIPv6
  • Username

    • Fields

    address
    String
    Default Value: ""

    The IP address of the proxy server.

    authentication
    ProxyAuthTypes
    Default Value: 0

    The authentication type used by the proxy server.

    patNoAuthentication0
    patBasic1
    patDigest2
    patNTLM3

    password
    String
    Default Value: ""

    The password to authenticate to the proxy server.

    port
    Int32
    Default Value: 0

    The port on the proxy server to connect to.

    proxyType
    ProxyTypes
    Default Value: 0

    The type of the proxy server.

    cptNone0
    cptSocks41
    cptSocks52
    cptWebTunnel3
    cptHTTP4

    requestHeaders
    String
    Default Value: ""

    Contains HTTP request headers for WebTunnel and HTTP proxy.

    responseBody
    String
    Default Value: ""

    Contains the HTTP or HTTPS (WebTunnel) proxy response body.

    responseHeaders
    String
    Default Value: ""

    Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

    useIPv6
    Bool
    Default Value: False

    Specifies whether IPv6 should be used when connecting through the proxy.

    username
    String
    Default Value: ""

    Specifies the username credential for proxy authentication.

    Constructors

    public init()

    Creates a new ProxySettings object.

    SocketSettings Type

    A container for the socket settings.

    Remarks

    This type is a container for socket-layer parameters.

    The following fields are available:
  • DNSMode
  • DNSPort
  • DNSQueryTimeout
  • DNSServers
  • DNSTotalTimeout
  • IncomingSpeedLimit
  • LocalAddress
  • LocalPort
  • OutgoingSpeedLimit
  • Timeout
  • UseIPv6

    • Fields

    dnsMode
    DNSResolveModes
    Default Value: 0

    Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

    dmAuto0
    dmPlatform1
    dmOwn2
    dmOwnSecure3

    dnsPort
    Int32
    Default Value: 0

    Specifies the port number to be used for sending queries to the DNS server.

    dnsQueryTimeout
    Int32
    Default Value: 0

    The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.

    dnsServers
    String
    Default Value: ""

    The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

    dnsTotalTimeout
    Int32
    Default Value: 0

    The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.

    incomingSpeedLimit
    Int32
    Default Value: 0

    The maximum number of bytes to read from the socket, per second.

    localAddress
    String
    Default Value: ""

    The local network interface to bind the socket to.

    localPort
    Int32
    Default Value: 0

    The local port number to bind the socket to.

    outgoingSpeedLimit
    Int32
    Default Value: 0

    The maximum number of bytes to write to the socket, per second.

    timeout
    Int32
    Default Value: 60000

    The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

    If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

    useIPv6
    Bool
    Default Value: False

    Enables or disables IP protocol version 6.

    Constructors

    public init()

    Creates a new SocketSettings object.

    TLSConnectionInfo Type

    Contains information about a network connection.

    Remarks

    Use this property to check various details of the network connection. These include the total amounts of data transferred, the availability of TLS, and its parameters.

    The following fields are available:
  • AEADCipher
  • ChainValidationDetails
  • ChainValidationResult
  • Ciphersuite
  • ClientAuthenticated
  • ClientAuthRequested
  • ConnectionEstablished
  • ConnectionID
  • DigestAlgorithm
  • EncryptionAlgorithm
  • Exportable
  • ID
  • KeyExchangeAlgorithm
  • KeyExchangeKeyBits
  • NamedECCurve
  • PFSCipher
  • PreSharedIdentity
  • PreSharedIdentityHint
  • PublicKeyBits
  • RemoteAddress
  • RemotePort
  • ResumedSession
  • SecureConnection
  • ServerAuthenticated
  • SignatureAlgorithm
  • SymmetricBlockSize
  • SymmetricKeyBits
  • TotalBytesReceived
  • TotalBytesSent
  • ValidationLog
  • Version

    • Fields

    aeadCipher
    Bool (read-only)
    Default Value: False

    Indicates whether the encryption algorithm used is an AEAD cipher.

    chainValidationDetails
    Int32 (read-only)
    Default Value: 0

    The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

    Returns a bit mask of the following options:

    cvrBadData0x0001One or more certificates in the validation path are malformed

    cvrRevoked0x0002One or more certificates are revoked

    cvrNotYetValid0x0004One or more certificates are not yet valid

    cvrExpired0x0008One or more certificates are expired

    cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

    cvrUnknownCA0x0020A CA certificate for one or more certificates has not been found (chain incomplete)

    cvrCAUnauthorized0x0040One of the CA certificates are not authorized to act as CA

    cvrCRLNotVerified0x0080One or more CRLs could not be verified

    cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

    cvrIdentityMismatch0x0200The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate

    cvrNoKeyUsage0x0400A mandatory key usage is not enabled in one of the chain certificates

    cvrBlocked0x0800One or more certificates are blocked

    cvrFailure0x1000General validation failure

    cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

    cvrWeakAlgorithm0x4000A weak algorithm is used in one of certificates or revocation elements

    cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

    chainValidationResult
    ChainValidities (read-only)
    Default Value: 0

    The outcome of a certificate chain validation routine.

    Available options:

    cvtValid0The chain is valid

    cvtValidButUntrusted1The chain is valid, but the root certificate is not trusted

    cvtInvalid2The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)

    cvtCantBeEstablished3The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

    Use the ValidationLog property to access the detailed validation log.

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

    The cipher suite employed by this connection.

    For TLS connections, this property returns the ciphersuite that was/is employed by the connection.

    clientAuthenticated
    Bool (read-only)
    Default Value: False

    Specifies whether client authentication was performed during this connection.

    clientAuthRequested
    Bool (read-only)
    Default Value: False

    Specifies whether client authentication was requested during this connection.

    connectionEstablished
    Bool (read-only)
    Default Value: False

    Indicates whether the connection has been established fully.

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

    The unique identifier assigned to this connection.

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

    The digest algorithm used in a TLS-enabled connection.

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

    The symmetric encryption algorithm used in a TLS-enabled connection.

    exportable
    Bool (read-only)
    Default Value: False

    Indicates whether a TLS connection uses a reduced-strength exportable cipher.

    id
    Int64 (read-only)
    Default Value: -1

    The client connection's unique identifier. This value is used throughout to refer to a particular client connection.

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

    The key exchange algorithm used in a TLS-enabled connection.

    keyExchangeKeyBits
    Int32 (read-only)
    Default Value: 0

    The length of the key exchange key of a TLS-enabled connection.

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

    The elliptic curve used in this connection.

    pfsCipher
    Bool (read-only)
    Default Value: False

    Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

    preSharedIdentity
    String
    Default Value: ""

    Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

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

    A hint professed by the server to help the client select the PSK identity to use.

    publicKeyBits
    Int32 (read-only)
    Default Value: 0

    The length of the public key.

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

    The client's IP address.

    remotePort
    Int32 (read-only)
    Default Value: 0

    The remote port of the client connection.

    resumedSession
    Bool (read-only)
    Default Value: False

    Indicates whether a TLS-enabled connection was spawned from another TLS connection

    secureConnection
    Bool (read-only)
    Default Value: False

    Indicates whether TLS or SSL is enabled for this connection.

    serverAuthenticated
    Bool (read-only)
    Default Value: False

    Indicates whether server authentication was performed during a TLS-enabled connection.

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

    The signature algorithm used in a TLS handshake.

    symmetricBlockSize
    Int32 (read-only)
    Default Value: 0

    The block size of the symmetric algorithm used.

    symmetricKeyBits
    Int32 (read-only)
    Default Value: 0

    The key length of the symmetric algorithm used.

    totalBytesReceived
    Int64 (read-only)
    Default Value: 0

    The total number of bytes received over this connection.

    totalBytesSent
    Int64 (read-only)
    Default Value: 0

    The total number of bytes sent over this connection.

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

    Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.

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

    Indicates the version of SSL/TLS protocol negotiated during this connection.

    Constructors

    public init()

    Creates a new TLSConnectionInfo object.

    TLSSettings Type

    A container for TLS connection settings.

    Remarks

    The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.

    The following fields are available:
  • AutoValidateCertificates
  • BaseConfiguration
  • Ciphersuites
  • ClientAuth
  • ECCurves
  • Extensions
  • ForceResumeIfDestinationChanges
  • PreSharedIdentity
  • PreSharedKey
  • PreSharedKeyCiphersuite
  • RenegotiationAttackPreventionMode
  • RevocationCheck
  • SSLOptions
  • TLSMode
  • UseExtendedMasterSecret
  • UseSessionResumption
  • Versions

    • Fields

    autoValidateCertificates
    Bool
    Default Value: True

    Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

    baseConfiguration
    SecureTransportPredefinedConfigurations
    Default Value: 0

    Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.

    stpcDefault0
    stpcCompatible1
    stpcComprehensiveInsecure2
    stpcHighlySecure3

    ciphersuites
    String
    Default Value: ""

    A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.

    Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by . Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

    • NULL_NULL_NULL
    • RSA_NULL_MD5
    • RSA_NULL_SHA
    • RSA_RC4_MD5
    • RSA_RC4_SHA
    • RSA_RC2_MD5
    • RSA_IDEA_MD5
    • RSA_IDEA_SHA
    • RSA_DES_MD5
    • RSA_DES_SHA
    • RSA_3DES_MD5
    • RSA_3DES_SHA
    • RSA_AES128_SHA
    • RSA_AES256_SHA
    • DH_DSS_DES_SHA
    • DH_DSS_3DES_SHA
    • DH_DSS_AES128_SHA
    • DH_DSS_AES256_SHA
    • DH_RSA_DES_SHA
    • DH_RSA_3DES_SHA
    • DH_RSA_AES128_SHA
    • DH_RSA_AES256_SHA
    • DHE_DSS_DES_SHA
    • DHE_DSS_3DES_SHA
    • DHE_DSS_AES128_SHA
    • DHE_DSS_AES256_SHA
    • DHE_RSA_DES_SHA
    • DHE_RSA_3DES_SHA
    • DHE_RSA_AES128_SHA
    • DHE_RSA_AES256_SHA
    • DH_ANON_RC4_MD5
    • DH_ANON_DES_SHA
    • DH_ANON_3DES_SHA
    • DH_ANON_AES128_SHA
    • DH_ANON_AES256_SHA
    • RSA_RC2_MD5_EXPORT
    • RSA_RC4_MD5_EXPORT
    • RSA_DES_SHA_EXPORT
    • DH_DSS_DES_SHA_EXPORT
    • DH_RSA_DES_SHA_EXPORT
    • DHE_DSS_DES_SHA_EXPORT
    • DHE_RSA_DES_SHA_EXPORT
    • DH_ANON_RC4_MD5_EXPORT
    • DH_ANON_DES_SHA_EXPORT
    • RSA_CAMELLIA128_SHA
    • DH_DSS_CAMELLIA128_SHA
    • DH_RSA_CAMELLIA128_SHA
    • DHE_DSS_CAMELLIA128_SHA
    • DHE_RSA_CAMELLIA128_SHA
    • DH_ANON_CAMELLIA128_SHA
    • RSA_CAMELLIA256_SHA
    • DH_DSS_CAMELLIA256_SHA
    • DH_RSA_CAMELLIA256_SHA
    • DHE_DSS_CAMELLIA256_SHA
    • DHE_RSA_CAMELLIA256_SHA
    • DH_ANON_CAMELLIA256_SHA
    • PSK_RC4_SHA
    • PSK_3DES_SHA
    • PSK_AES128_SHA
    • PSK_AES256_SHA
    • DHE_PSK_RC4_SHA
    • DHE_PSK_3DES_SHA
    • DHE_PSK_AES128_SHA
    • DHE_PSK_AES256_SHA
    • RSA_PSK_RC4_SHA
    • RSA_PSK_3DES_SHA
    • RSA_PSK_AES128_SHA
    • RSA_PSK_AES256_SHA
    • RSA_SEED_SHA
    • DH_DSS_SEED_SHA
    • DH_RSA_SEED_SHA
    • DHE_DSS_SEED_SHA
    • DHE_RSA_SEED_SHA
    • DH_ANON_SEED_SHA
    • SRP_SHA_3DES_SHA
    • SRP_SHA_RSA_3DES_SHA
    • SRP_SHA_DSS_3DES_SHA
    • SRP_SHA_AES128_SHA
    • SRP_SHA_RSA_AES128_SHA
    • SRP_SHA_DSS_AES128_SHA
    • SRP_SHA_AES256_SHA
    • SRP_SHA_RSA_AES256_SHA
    • SRP_SHA_DSS_AES256_SHA
    • ECDH_ECDSA_NULL_SHA
    • ECDH_ECDSA_RC4_SHA
    • ECDH_ECDSA_3DES_SHA
    • ECDH_ECDSA_AES128_SHA
    • ECDH_ECDSA_AES256_SHA
    • ECDHE_ECDSA_NULL_SHA
    • ECDHE_ECDSA_RC4_SHA
    • ECDHE_ECDSA_3DES_SHA
    • ECDHE_ECDSA_AES128_SHA
    • ECDHE_ECDSA_AES256_SHA
    • ECDH_RSA_NULL_SHA
    • ECDH_RSA_RC4_SHA
    • ECDH_RSA_3DES_SHA
    • ECDH_RSA_AES128_SHA
    • ECDH_RSA_AES256_SHA
    • ECDHE_RSA_NULL_SHA
    • ECDHE_RSA_RC4_SHA
    • ECDHE_RSA_3DES_SHA
    • ECDHE_RSA_AES128_SHA
    • ECDHE_RSA_AES256_SHA
    • ECDH_ANON_NULL_SHA
    • ECDH_ANON_RC4_SHA
    • ECDH_ANON_3DES_SHA
    • ECDH_ANON_AES128_SHA
    • ECDH_ANON_AES256_SHA
    • RSA_NULL_SHA256
    • RSA_AES128_SHA256
    • RSA_AES256_SHA256
    • DH_DSS_AES128_SHA256
    • DH_RSA_AES128_SHA256
    • DHE_DSS_AES128_SHA256
    • DHE_RSA_AES128_SHA256
    • DH_DSS_AES256_SHA256
    • DH_RSA_AES256_SHA256
    • DHE_DSS_AES256_SHA256
    • DHE_RSA_AES256_SHA256
    • DH_ANON_AES128_SHA256
    • DH_ANON_AES256_SHA256
    • RSA_AES128_GCM_SHA256
    • RSA_AES256_GCM_SHA384
    • DHE_RSA_AES128_GCM_SHA256
    • DHE_RSA_AES256_GCM_SHA384
    • DH_RSA_AES128_GCM_SHA256
    • DH_RSA_AES256_GCM_SHA384
    • DHE_DSS_AES128_GCM_SHA256
    • DHE_DSS_AES256_GCM_SHA384
    • DH_DSS_AES128_GCM_SHA256
    • DH_DSS_AES256_GCM_SHA384
    • DH_ANON_AES128_GCM_SHA256
    • DH_ANON_AES256_GCM_SHA384
    • ECDHE_ECDSA_AES128_SHA256
    • ECDHE_ECDSA_AES256_SHA384
    • ECDH_ECDSA_AES128_SHA256
    • ECDH_ECDSA_AES256_SHA384
    • ECDHE_RSA_AES128_SHA256
    • ECDHE_RSA_AES256_SHA384
    • ECDH_RSA_AES128_SHA256
    • ECDH_RSA_AES256_SHA384
    • ECDHE_ECDSA_AES128_GCM_SHA256
    • ECDHE_ECDSA_AES256_GCM_SHA384
    • ECDH_ECDSA_AES128_GCM_SHA256
    • ECDH_ECDSA_AES256_GCM_SHA384
    • ECDHE_RSA_AES128_GCM_SHA256
    • ECDHE_RSA_AES256_GCM_SHA384
    • ECDH_RSA_AES128_GCM_SHA256
    • ECDH_RSA_AES256_GCM_SHA384
    • PSK_AES128_GCM_SHA256
    • PSK_AES256_GCM_SHA384
    • DHE_PSK_AES128_GCM_SHA256
    • DHE_PSK_AES256_GCM_SHA384
    • RSA_PSK_AES128_GCM_SHA256
    • RSA_PSK_AES256_GCM_SHA384
    • PSK_AES128_SHA256
    • PSK_AES256_SHA384
    • PSK_NULL_SHA256
    • PSK_NULL_SHA384
    • DHE_PSK_AES128_SHA256
    • DHE_PSK_AES256_SHA384
    • DHE_PSK_NULL_SHA256
    • DHE_PSK_NULL_SHA384
    • RSA_PSK_AES128_SHA256
    • RSA_PSK_AES256_SHA384
    • RSA_PSK_NULL_SHA256
    • RSA_PSK_NULL_SHA384
    • RSA_CAMELLIA128_SHA256
    • DH_DSS_CAMELLIA128_SHA256
    • DH_RSA_CAMELLIA128_SHA256
    • DHE_DSS_CAMELLIA128_SHA256
    • DHE_RSA_CAMELLIA128_SHA256
    • DH_ANON_CAMELLIA128_SHA256
    • RSA_CAMELLIA256_SHA256
    • DH_DSS_CAMELLIA256_SHA256
    • DH_RSA_CAMELLIA256_SHA256
    • DHE_DSS_CAMELLIA256_SHA256
    • DHE_RSA_CAMELLIA256_SHA256
    • DH_ANON_CAMELLIA256_SHA256
    • ECDHE_ECDSA_CAMELLIA128_SHA256
    • ECDHE_ECDSA_CAMELLIA256_SHA384
    • ECDH_ECDSA_CAMELLIA128_SHA256
    • ECDH_ECDSA_CAMELLIA256_SHA384
    • ECDHE_RSA_CAMELLIA128_SHA256
    • ECDHE_RSA_CAMELLIA256_SHA384
    • ECDH_RSA_CAMELLIA128_SHA256
    • ECDH_RSA_CAMELLIA256_SHA384
    • RSA_CAMELLIA128_GCM_SHA256
    • RSA_CAMELLIA256_GCM_SHA384
    • DHE_RSA_CAMELLIA128_GCM_SHA256
    • DHE_RSA_CAMELLIA256_GCM_SHA384
    • DH_RSA_CAMELLIA128_GCM_SHA256
    • DH_RSA_CAMELLIA256_GCM_SHA384
    • DHE_DSS_CAMELLIA128_GCM_SHA256
    • DHE_DSS_CAMELLIA256_GCM_SHA384
    • DH_DSS_CAMELLIA128_GCM_SHA256
    • DH_DSS_CAMELLIA256_GCM_SHA384
    • DH_anon_CAMELLIA128_GCM_SHA256
    • DH_anon_CAMELLIA256_GCM_SHA384
    • ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
    • ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
    • ECDH_ECDSA_CAMELLIA128_GCM_SHA256
    • ECDH_ECDSA_CAMELLIA256_GCM_SHA384
    • ECDHE_RSA_CAMELLIA128_GCM_SHA256
    • ECDHE_RSA_CAMELLIA256_GCM_SHA384
    • ECDH_RSA_CAMELLIA128_GCM_SHA256
    • ECDH_RSA_CAMELLIA256_GCM_SHA384
    • PSK_CAMELLIA128_GCM_SHA256
    • PSK_CAMELLIA256_GCM_SHA384
    • DHE_PSK_CAMELLIA128_GCM_SHA256
    • DHE_PSK_CAMELLIA256_GCM_SHA384
    • RSA_PSK_CAMELLIA128_GCM_SHA256
    • RSA_PSK_CAMELLIA256_GCM_SHA384
    • PSK_CAMELLIA128_SHA256
    • PSK_CAMELLIA256_SHA384
    • DHE_PSK_CAMELLIA128_SHA256
    • DHE_PSK_CAMELLIA256_SHA384
    • RSA_PSK_CAMELLIA128_SHA256
    • RSA_PSK_CAMELLIA256_SHA384
    • ECDHE_PSK_CAMELLIA128_SHA256
    • ECDHE_PSK_CAMELLIA256_SHA384
    • ECDHE_PSK_RC4_SHA
    • ECDHE_PSK_3DES_SHA
    • ECDHE_PSK_AES128_SHA
    • ECDHE_PSK_AES256_SHA
    • ECDHE_PSK_AES128_SHA256
    • ECDHE_PSK_AES256_SHA384
    • ECDHE_PSK_NULL_SHA
    • ECDHE_PSK_NULL_SHA256
    • ECDHE_PSK_NULL_SHA384
    • ECDHE_RSA_CHACHA20_POLY1305_SHA256
    • ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
    • DHE_RSA_CHACHA20_POLY1305_SHA256
    • PSK_CHACHA20_POLY1305_SHA256
    • ECDHE_PSK_CHACHA20_POLY1305_SHA256
    • DHE_PSK_CHACHA20_POLY1305_SHA256
    • RSA_PSK_CHACHA20_POLY1305_SHA256
    • AES128_GCM_SHA256
    • AES256_GCM_SHA384
    • CHACHA20_POLY1305_SHA256
    • AES128_CCM_SHA256
    • AES128_CCM8_SHA256

    clientAuth
    ClientAuthTypes
    Default Value: 0

    Enables or disables certificate-based client authentication.

    Set this property to true to tune up the client authentication type:

    ccatNoAuth0
    ccatRequestCert1
    ccatRequireCert2

    ecCurves
    String
    Default Value: ""

    Defines the elliptic curves to enable.

    extensions
    String
    Default Value: ""

    Provides access to TLS extensions.

    forceResumeIfDestinationChanges
    Bool
    Default Value: False

    Whether to force TLS session resumption when the destination address changes.

    preSharedIdentity
    String
    Default Value: ""

    Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

    preSharedKey
    String
    Default Value: ""

    Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

    preSharedKeyCiphersuite
    String
    Default Value: ""

    Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

    renegotiationAttackPreventionMode
    RenegotiationAttackPreventionModes
    Default Value: 2

    Selects the renegotiation attack prevention mechanism.

    The following options are available:

    crapmCompatible0TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled).
    crapmStrict1Renegotiation attack prevention is enabled and enforced.
    crapmAuto2Automatically choose whether to enable or disable renegotiation attack prevention.

    revocationCheck
    RevocationCheckKinds
    Default Value: 1

    Specifies the kind(s) of revocation check to perform.

    Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

    crcNone0No revocation checking.
    crcAuto1Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future.
    crcAllCRL2All provided CRL endpoints will be checked, and all checks must succeed.
    crcAllOCSP3All provided OCSP endpoints will be checked, and all checks must succeed.
    crcAllCRLAndOCSP4All provided CRL and OCSP endpoints will be checked, and all checks must succeed.
    crcAnyCRL5All provided CRL endpoints will be checked, and at least one check must succeed.
    crcAnyOCSP6All provided OCSP endpoints will be checked, and at least one check must succeed.
    crcAnyCRLOrOCSP7All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first.
    crcAnyOCSPOrCRL8All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first.

    This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

    There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

    This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

    Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

    Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

    sslOptions
    Int32
    Default Value: 16

    Various SSL (TLS) protocol options, set of

    cssloExpectShutdownMessage0x001Wait for the close-notify message when shutting down the connection

    cssloOpenSSLDTLSWorkaround0x002(DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions

    cssloDisableKexLengthAlignment0x004Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it.

    cssloForceUseOfClientCertHashAlg0x008Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it.

    cssloAutoAddServerNameExtension0x010Automatically add the server name extension when known

    cssloAcceptTrustedSRPPrimesOnly0x020Accept trusted SRP primes only

    cssloDisableSignatureAlgorithmsExtension0x040Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it.

    cssloIntolerateHigherProtocolVersions0x080(server option) Do not allow fallback from TLS versions higher than currently enabled

    cssloStickToPrefCertHashAlg0x100Stick to preferred certificate hash algorithms

    cssloNoImplicitTLS12Fallback0x200Disable implicit TLS 1.3 to 1.2 fallbacks

    cssloUseHandshakeBatches0x400Send the handshake message as large batches rather than individually

    tlsMode
    SSLModes
    Default Value: 0

    Specifies the TLS mode to use.

    smDefault0
    smNoTLS1Do not use TLS
    smExplicitTLS2Connect to the server without any encryption and then request an SSL session.
    smImplicitTLS3Connect to the specified port, and establish the SSL session at once.
    smMixedTLS4Connect to the specified port, and establish the SSL session at once, but allow plain data.

    useExtendedMasterSecret
    Bool
    Default Value: False

    Enables the Extended Master Secret Extension, as defined in RFC 7627.

    useSessionResumption
    Bool
    Default Value: False

    Enables or disables the TLS session resumption capability.

    versions
    Int32
    Default Value: 16

    The SSL/TLS versions to enable by default.

    csbSSL20x01SSL 2

    csbSSL30x02SSL 3

    csbTLS10x04TLS 1.0

    csbTLS110x08TLS 1.1

    csbTLS120x10TLS 1.2

    csbTLS130x20TLS 1.3

    Constructors

    public init()

    Creates a new TLSSettings object.

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

    POP3Client Config Settings

    Authentications:   Specifies enabled authentication methods and their priorities.

    Use this setting to enable or disable authentication methods and specify their priorities. The setting contains a comma-separated list of authentication methods. The first method in the list has the highest priority, and so on. The class will use the first method from the list which is supported by the server.

    Supported methods: USER, APOP, LOGIN, PLAIN, CRAM-MD5, DIGEST-MD5, NTLM, GSSAPI, XOAUTH2, SCRAM-SHA-1, SCRAM-SHA-256

    Default value: SCRAM-SHA-256,SCRAM-SHA-1,DIGEST-MD5,CRAM-MD5,APOP,PLAIN,LOGIN,USER

    IgnoreSystemTrust:   Whether trusted Windows Certificate Stores should be treated as trusted.

    Specifies whether, during chain validation, the class should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the class should trust the certificates residing in the Trusted Root Certification Authorities store.

    If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as the TrustedCertificates property) are considered trusted.

    MaxLineLength:   Specifies maximum expected line length.

    Use this setting to specify how long the expected mail line can be. Setting the very long value leads to memory increase. Default value is 10000. RFC 5322 requires that lines of up to 1000 characters long are handled correctly.

    RequestUIDs:   Specifies whether to request message UIDs when listing messages.

    Use this setting to enable or disable message UID requests.

    SessionLogDetails:   Specifies whether login credentials should be written to the session log.

    Use this setting to configure the details written to SessionLog. Possible values are:

    defaultLogin credentials are not logged.
    fullLogin credentials appeare in the SessionLog.
    noneNo SessionLog is created.
    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:

    noneNo static DNS rules (default)
    localLocal static DNS rules
    globalGlobal 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.

    TempPath:   Path for storing temporary files.

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

    TLSExtensions:   TBD.

    TBD

    TLSPeerExtensions:   TBD.

    TBD

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

    TolerateMinorChainIssues:   Whether to tolerate minor chain issues.

    This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are:

    • CA, revocation source, TLS key usage requirements are not mandated
    • Violation of OCSP issuer requirements are ignored
    • The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates)
    • Basic constraints and name constraints of CA certificates are ignored
    • Some weaker algorithms are tolerated
    UseMicrosoftCTL:   Enables or disables the automatic use of the Microsoft online certificate trust list.

    Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository.

    UseSystemCertificates:   Enables or disables the use of the system certificates.

    Use this property to tell the chain validation module to automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework.

    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:

    offNo caching (default)
    localLocal caching
    globalGlobal 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:

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

    LogDetails:   Specifies the debug log details to dump.

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

    Supported values are:

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

    LogFile:   Specifies the debug log filename.

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

    LogFilters:   Specifies the debug log filters.

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

    Supported filter names are:

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

    LogFlushMode:   Specifies the log flush mode.

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

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

    LogLevel:   Specifies the debug log level.

    Use this property to provide the desired debug log level.

    Supported values are:

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

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

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

    The default value of this setting is 100.

    LogRotationMode:   Specifies the log rotation mode.

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

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

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

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

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

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

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

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

    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.

    PKICache:   Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.

    The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.

    Supported Values:

    certificateEnables caching of certificates.
    crlEnables caching of Certificate Revocation Lists (CRLs).
    ocspEnables caching of OCSP (Online Certificate Status Protocol) responses.

    Example (default value): PKICache=certificate,crl,ocsp In this example, the component caches certificates, CRLs, and OCSP responses.

    PKICachePath:   Specifies the file system path where cached PKI data is stored.

    The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts.

    The default value is an empty string - no cached PKI data is stored on disk.

    Example: PKICachePath=C:\Temp\cache In this example, the cached PKI data is stored in the C:\Temp\cache directory.

    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:

    noneNo static DNS rules (default)
    localLocal static DNS rules
    globalGlobal 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).

    UseCRLObjectCaching:   Specifies whether reuse of loaded CRL objects is enabled.

    This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.

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

    UseOCSPResponseObjectCaching:   Specifies whether reuse of loaded OCSP response objects is enabled.

    This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.

    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.

    XMLRDNDescriptorName[OID]:   Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.

    This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

    The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.

    Syntax: Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");

    Where:

    OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.

    PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.

    Alias1, Alias2, ...: Optional alternative names recognized during parsing.

    Usage Examples:

    Map OID 2.5.4.5 to SERIALNUMBER: Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");

    Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");

    XMLRDNDescriptorPriority[OID]:   Specifies the priority of descriptor names associated with a specific OID.

    This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.

    XMLRDNDescriptorReverseOrder:   Specifies whether to reverse the order of descriptors in RDN.

    Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).

    XMLRDNDescriptorSeparator:   Specifies the separator used between descriptors in RDN.

    Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.

    Trappable Errors (POP3Client Module)

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