OAuthClient Module
Properties Methods Events Config Settings Errors
The OAuthClient module implements interaction between the client, the resource owner (end-user), and the authorization server via OAuth 2.0 protocol.
Syntax
SecureBlackbox.Oauthclient
Remarks
OAuthClient implements interaction between the client (an application that needs access to a protected resource), the resource owner (end-user), and the authorization server via OAuth 2.0 (RFC 6749) protocol.
Property List
The following is the full list of the properties of the module with short descriptions. Click on the links for further details.
| AccessToken | Contains the access token. |
| AuthURL | Specifies the URL of the authorization server. |
| AutoRefresh | Specifies whether access token should be automatically refreshed. |
| BlockedCertificates | The certificates that must be rejected as trust anchors. |
| ClientChain | The TLS client certificate chain. |
| ClientID | Client ID of the application which needs access to the protected resource. |
| ClientSecret | Client secret of the application which needs access to the protected resource. |
| ConnectionInfo | Returns the details of the underlying network connection. |
| CustomParameters | Contains custom parameters of the authorization request. |
| ExpiresAt | The expiration time of access token. |
| ExpiresIn | Returns access token lifetime in seconds. |
| ExternalCrypto | Provides access to external signing and DC parameters. |
| FailureResponse | The web page showed to the user by the module on authorization failure. |
| FIPSMode | Reserved. |
| GrantType | Specifies which protocol flow should be used to authorize the user. |
| IDToken | Contains the ID Token parameter for JWT. |
| KeepAlivePolicy | Defines the keep-alive handling policy. |
| KnownCertificates | Additional certificates for chain validation. |
| KnownCRLs | Additional CRLs for chain validation. |
| KnownOCSPs | Additional OCSP responses for chain validation. |
| Password | The connecting user's authentication password. |
| Proxy | The proxy server settings. |
| RedirectURL | The URL where the user is redirected after authorization. |
| RefreshToken | The refresh token, to be used to automatically obtain new access token. |
| Scope | The scope of the request to be authorized. |
| ServerChain | The TLS server's certificate chain. |
| SocketSettings | Manages network connection settings. |
| State | Specifies the state parameter of the authorization request or response. |
| SuccessResponse | The web page showed to the user by the module on authorization success. |
| Timeout | Specifies waiting timeout (in milliseconds). |
| TLSSettings | Manages TLS layer settings. |
| TokenType | Returns the access token type. |
| TokenURL | Specifies the URL of the token endpoint. |
| TrustedCertificates | A list of trusted certificates for chain validation. |
| Username | The connecting user's username (login name). |
Method List
The following is the full list of the methods of the module with short descriptions. Click on the links for further details.
| Authorize | Performs user authorization and gets an access token. |
| Config | Sets or retrieves a configuration setting. |
| DoAction | Performs an additional action. |
Event List
The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.
| Error | Provides information about errors during authorization operations. |
| ExternalSign | Handles remote or external signing initiated by the SignExternal method or other source. |
| LaunchBrowser | Fires to show the login page to the end-user. |
| TLSCertNeeded | Fires when a remote TLS party requests a client certificate. |
| TLSCertValidate | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
| TLSEstablished | Fires when a TLS handshake with Host successfully completes. |
| TLSHandshake | Fires when a new TLS handshake is initiated, before the handshake commences. |
| TLSPSK | Notifies the application about the PSK key exchange. |
| TLSShutdown | Reports the graceful closure of a TLS connection. |
| Wait | Fired periodically to show how much waiting time is left. |
Config Settings
The following is a list of config settings for the module with short descriptions. Click on the links for further details.
| CacheControl | Optional value for Cache-Control HTTP header field. |
| IDToken | ID Token parameter for JWT. |
| IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
| PKCEMode | Proof Key for Code Exchange method to use. |
| TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
| UseMicrosoftCTL | Enables or disables automatic use of Microsoft online certificate trust list. |
| UseSystemCertificates | Enables or disables the use of the system certificates. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the module (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| StaticDNS | Specifies whether static DNS rules should be used. |
| StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
| StaticIPAddresses | Gets or sets all the static DNS rules. |
| Tag | Allows to store any custom data. |
| UseOwnDNSResolver | Specifies whether the client modules should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
AccessToken Property (OAuthClient Module)
Contains the access token.
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 check or set the authorization access token.
AuthURL Property (OAuthClient Module)
Specifies the URL of the authorization server.
Syntax
public var authURL: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=authURL,setter=setAuthURL:) NSString* authURL; - (NSString*)authURL; - (void)setAuthURL :(NSString*)newAuthURL;
Default Value
""
Remarks
Use this property to set the URL of the authorization server.
AutoRefresh Property (OAuthClient Module)
Specifies whether access token should be automatically refreshed.
Syntax
public var autoRefresh: Bool { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=autoRefresh,setter=setAutoRefresh:) BOOL autoRefresh; - (BOOL)autoRefresh; - (void)setAutoRefresh :(BOOL)newAutoRefresh;
Default Value
True
Remarks
Set this property to true to let the class automatically refresh AccessToken. If available, RefreshToken is used to renew access token. Otherwise the authorization process is initiated from the beginning, with user authentication and so on.
BlockedCertificates Property (OAuthClient 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
Assign the user's login name to this property. Use Password to provide the password. The Username and Password properties are used only when GrantType is oauthPasswordCredentials.
ClientChain Property (OAuthClient Module)
The TLS client certificate chain.
Syntax
public var clientChain: Array<Certificate> { get {...} }
@property (nonatomic,readwrite,assign,getter=clientCertCount,setter=setClientCertCount:) int clientCertCount; - (int)clientCertCount; - (void)setClientCertCount :(int)newClientCertCount; - (NSData*)clientCertBytes:(int)clientCertIndex; - (long long)clientCertHandle:(int)clientCertIndex; - (void)setClientCertHandle:(int)clientCertIndex :(long long)newClientCertHandle;
Default Value
""
Remarks
Assign the user's login name to this property. Use Password to provide the password. The Username and Password properties are used only when GrantType is oauthPasswordCredentials.
ClientID Property (OAuthClient Module)
Client ID of the application which needs access to the protected resource.
Syntax
public var clientID: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=clientID,setter=setClientID:) NSString* clientID; - (NSString*)clientID; - (void)setClientID :(NSString*)newClientID;
Default Value
""
Remarks
Use this property to specify the client ID of the application.
ClientSecret Property (OAuthClient Module)
Client secret of the application which needs access to the protected resource.
Syntax
public var clientSecret: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=clientSecret,setter=setClientSecret:) NSString* clientSecret; - (NSString*)clientSecret; - (void)setClientSecret :(NSString*)newClientSecret;
Default Value
""
Remarks
Use this property to specify client secret of the application.
ConnectionInfo Property (OAuthClient Module)
Returns the details of the underlying network connection.
Syntax
public var connectionInfo: ConnectionInfo { 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=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=connInfoPreSharedIdentityHint) NSString* connInfoPreSharedIdentityHint; - (NSString*)connInfoPreSharedIdentityHint; @property (nonatomic,readonly,assign,getter=connInfoPublicKeyBits) int connInfoPublicKeyBits; - (int)connInfoPublicKeyBits; @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
Assign the user's login name to this property. Use Password to provide the password. The Username and Password properties are used only when GrantType is oauthPasswordCredentials.
CustomParameters Property (OAuthClient Module)
Contains custom parameters of the authorization request.
Syntax
public var customParameters: Array<StringNameValuePair> { get {...} }
@property (nonatomic,readwrite,assign,getter=customParamCount,setter=setCustomParamCount:) int customParamCount; - (int)customParamCount; - (void)setCustomParamCount :(int)newCustomParamCount; - (NSString*)customParamsCategory:(int)customParamIndex; - (void)setCustomParamsCategory:(int)customParamIndex :(NSString*)newCustomParamsCategory; - (int)customParamsFormat:(int)customParamIndex; - (void)setCustomParamsFormat:(int)customParamIndex :(int)newCustomParamsFormat; - (NSString*)customParamsName:(int)customParamIndex; - (void)setCustomParamsName:(int)customParamIndex :(NSString*)newCustomParamsName; - (NSString*)customParamsValue:(int)customParamIndex; - (void)setCustomParamsValue:(int)customParamIndex :(NSString*)newCustomParamsValue;
Default Value
""
Remarks
Assign the user's login name to this property. Use Password to provide the password. The Username and Password properties are used only when GrantType is oauthPasswordCredentials.
ExpiresAt Property (OAuthClient Module)
The expiration time of access token.
Syntax
public var expiresAt: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=expiresAt,setter=setExpiresAt:) NSString* expiresAt; - (NSString*)expiresAt; - (void)setExpiresAt :(NSString*)newExpiresAt;
Default Value
""
Remarks
Use this property to check the expiration time of AccessToken.
ExpiresIn Property (OAuthClient Module)
Returns access token lifetime in seconds.
Syntax
public var expiresIn: Int32 { get {...} }
@property (nonatomic,readonly,assign,getter=expiresIn) int expiresIn; - (int)expiresIn;
Default Value
0
Remarks
Use this property to get the AccessToken lifetime in seconds. This value is returned by the authorization server together with the access token. To check the token's expiration moment, use ExpiresAt property.
This property is read-only.
ExternalCrypto Property (OAuthClient 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
Assign the user's login name to this property. Use Password to provide the password. The Username and Password properties are used only when GrantType is oauthPasswordCredentials.
FailureResponse Property (OAuthClient Module)
The web page showed to the user by the module on authorization failure.
Syntax
public var failureResponse: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=failureResponse,setter=setFailureResponse:) NSString* failureResponse; - (NSString*)failureResponse; - (void)setFailureResponse :(NSString*)newFailureResponse;
Default Value
""
Remarks
This property contains the html of the web page to be shown on authorization failure.
FIPSMode Property (OAuthClient 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.
GrantType Property (OAuthClient Module)
Specifies which protocol flow should be used to authorize the user.
Syntax
public var grantType: OauthclientGrantTypes { get {...} set {...} }
public enum OauthclientGrantTypes: Int32 { case ogtAuthorizationCode = 0 case ogtImplicit = 1 case ogtPasswordCredentials = 2 case ogtClientCredentials = 3 }
@property (nonatomic,readwrite,assign,getter=grantType,setter=setGrantType:) int grantType; - (int)grantType; - (void)setGrantType :(int)newGrantType;
Default Value
0
Remarks
Use this property to specify the authorization protocol to use.
| ogtAuthorizationCode | 0 | Authorization Code flow should be used (see RFC 6749 Section 1.3.1) |
| ogtImplicit | 1 | Implicit flow should be used (see RFC 6749 Section 1.3.2) |
| ogtPasswordCredentials | 2 | Resource Owner Password Credentials flow should be used (see RFC 6749 Section 1.3.3) |
| ogtClientCredentials | 3 | Client Credentials flow should be used (see RFC 6749 Section 1.3.4) |
IDToken Property (OAuthClient Module)
Contains the ID Token parameter for JWT.
Syntax
public var idToken: String { get {...} }
@property (nonatomic,readonly,assign,getter=IDToken) NSString* IDToken; - (NSString*)IDToken;
Default Value
""
Remarks
Use this property to get the id_token parameter (if any) than can be used for JWT operations.
This property is read-only.
KeepAlivePolicy Property (OAuthClient Module)
Defines the keep-alive handling policy.
Syntax
public var keepAlivePolicy: OauthclientKeepAlivePolicies { get {...} set {...} }
public enum OauthclientKeepAlivePolicies: Int32 { case ckapStandardDefined = 0 case ckapPreferKeepAlive = 1 case ckapRelyOnServer = 2 case ckapKeepAlivesDisabled = 3 }
@property (nonatomic,readwrite,assign,getter=keepAlivePolicy,setter=setKeepAlivePolicy:) int keepAlivePolicy; - (int)keepAlivePolicy; - (void)setKeepAlivePolicy :(int)newKeepAlivePolicy;
Default Value
0
Remarks
Use this property to tune-up the keep-alive mechanism as per the needs of your application.
| ckapStandardDefined | 0 | Follow the standard |
| ckapPreferKeepAlive | 1 | Always request a keep-alive connection |
| ckapRelyOnServer | 2 | Not include the "Connection" header, allowing the server to choose the keep-alive mode |
| ckapKeepAlivesDisabled | 3 | Disable keep-alives by including the "Connection: Close" header |
KnownCertificates Property (OAuthClient 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
Assign the user's login name to this property. Use Password to provide the password. The Username and Password properties are used only when GrantType is oauthPasswordCredentials.
KnownCRLs Property (OAuthClient 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
Assign the user's login name to this property. Use Password to provide the password. The Username and Password properties are used only when GrantType is oauthPasswordCredentials.
KnownOCSPs Property (OAuthClient 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
Assign the user's login name to this property. Use Password to provide the password. The Username and Password properties are used only when GrantType is oauthPasswordCredentials.
Password Property (OAuthClient Module)
The connecting user's authentication password.
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
Assign the user's authentication password to this property. Use Username for username/login. The Username and Password properties are used only when GrantType is oauthPasswordCredentials.
Proxy Property (OAuthClient 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=proxyUseProxy,setter=setProxyUseProxy:) BOOL proxyUseProxy; - (BOOL)proxyUseProxy; - (void)setProxyUseProxy :(BOOL)newProxyUseProxy; @property (nonatomic,readwrite,assign,getter=proxyUsername,setter=setProxyUsername:) NSString* proxyUsername; - (NSString*)proxyUsername; - (void)setProxyUsername :(NSString*)newProxyUsername;
Default Value
""
Remarks
Assign the user's login name to this property. Use Password to provide the password. The Username and Password properties are used only when GrantType is oauthPasswordCredentials.
RedirectURL Property (OAuthClient Module)
The URL where the user is redirected after authorization.
Syntax
public var redirectURL: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=redirectURL,setter=setRedirectURL:) NSString* redirectURL; - (NSString*)redirectURL; - (void)setRedirectURL :(NSString*)newRedirectURL;
Default Value
""
Remarks
Use this property to specify the URL on which the local HTTP server should open the listening port and wait for response from the authorization server. When the port number is explicitly specified, e.g., "http://localhost:5050/", the application has to be allowed to open a listening socket on that port.
RefreshToken Property (OAuthClient Module)
The refresh token, to be used to automatically obtain new access token.
Syntax
public var refreshToken: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=refreshToken,setter=setRefreshToken:) NSString* refreshToken; - (NSString*)refreshToken; - (void)setRefreshToken :(NSString*)newRefreshToken;
Default Value
""
Remarks
The refresh token is used to obtain new AccessToken without user authentication.
Scope Property (OAuthClient Module)
The scope of the request to be authorized.
Syntax
public var scope: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=scope,setter=setScope:) NSString* scope; - (NSString*)scope; - (void)setScope :(NSString*)newScope;
Default Value
""
Remarks
Use this property to specify the scope of the request to the protected resource.
ServerChain Property (OAuthClient Module)
The TLS server's certificate chain.
Syntax
public var serverChain: Array<Certificate> { get {...} }
@property (nonatomic,readonly,assign,getter=serverCertCount) int serverCertCount; - (int)serverCertCount; - (NSData*)serverCertBytes:(int)serverCertIndex; - (NSData*)serverCertCAKeyID:(int)serverCertIndex; - (NSData*)serverCertFingerprint:(int)serverCertIndex; - (long long)serverCertHandle:(int)serverCertIndex; - (NSString*)serverCertIssuer:(int)serverCertIndex; - (NSString*)serverCertIssuerRDN:(int)serverCertIndex; - (NSString*)serverCertKeyAlgorithm:(int)serverCertIndex; - (int)serverCertKeyBits:(int)serverCertIndex; - (NSData*)serverCertKeyFingerprint:(int)serverCertIndex; - (int)serverCertKeyUsage:(int)serverCertIndex; - (NSData*)serverCertPublicKeyBytes:(int)serverCertIndex; - (BOOL)serverCertSelfSigned:(int)serverCertIndex; - (NSData*)serverCertSerialNumber:(int)serverCertIndex; - (NSString*)serverCertSigAlgorithm:(int)serverCertIndex; - (NSString*)serverCertSubject:(int)serverCertIndex; - (NSData*)serverCertSubjectKeyID:(int)serverCertIndex; - (NSString*)serverCertSubjectRDN:(int)serverCertIndex; - (NSString*)serverCertValidFrom:(int)serverCertIndex; - (NSString*)serverCertValidTo:(int)serverCertIndex;
Default Value
""
Remarks
Assign the user's login name to this property. Use Password to provide the password. The Username and Password properties are used only when GrantType is oauthPasswordCredentials.
SocketSettings Property (OAuthClient 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
Assign the user's login name to this property. Use Password to provide the password. The Username and Password properties are used only when GrantType is oauthPasswordCredentials.
State Property (OAuthClient Module)
Specifies the state parameter of the authorization request or response.
Syntax
public var state: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=state,setter=setState:) NSString* state; - (NSString*)state; - (void)setState :(NSString*)newState;
Default Value
""
Remarks
This parameter contains an opaque value used by the client to maintain state between the request and callback. If this parameter was present in the authorization request, the server should include the same value in its response.
SuccessResponse Property (OAuthClient Module)
The web page showed to the user by the module on authorization success.
Syntax
public var successResponse: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=successResponse,setter=setSuccessResponse:) NSString* successResponse; - (NSString*)successResponse; - (void)setSuccessResponse :(NSString*)newSuccessResponse;
Default Value
""
Remarks
This property contains the html of the web page to be shown on authorization success.
Timeout Property (OAuthClient Module)
Specifies waiting timeout (in milliseconds).
Syntax
public var timeout: Int32 { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout; - (int)timeout; - (void)setTimeout :(int)newTimeout;
Default Value
120000
Remarks
This property specifies the timeout (in milliseconds) to wait for server's response.
TLSSettings Property (OAuthClient 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=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
Assign the user's login name to this property. Use Password to provide the password. The Username and Password properties are used only when GrantType is oauthPasswordCredentials.
TokenType Property (OAuthClient Module)
Returns the access token type.
Syntax
public var tokenType: String { get {...} }
@property (nonatomic,readonly,assign,getter=tokenType) NSString* tokenType; - (NSString*)tokenType;
Default Value
""
Remarks
The access token type provides a client with the information on how to use the AccessToken. The understanding of token type is the client's responsibility. Some token types are described, for instance, in RFC 6750 and OAuth-HTTP-MAC specifications.
This property is read-only.
TokenURL Property (OAuthClient Module)
Specifies the URL of the token endpoint.
Syntax
public var tokenURL: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=tokenURL,setter=setTokenURL:) NSString* tokenURL; - (NSString*)tokenURL; - (void)setTokenURL :(NSString*)newTokenURL;
Default Value
""
Remarks
The token endpoint is used by the client, which needs access to protected resource, to obtain access token from the authorization server.
TrustedCertificates Property (OAuthClient 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
Assign the user's login name to this property. Use Password to provide the password. The Username and Password properties are used only when GrantType is oauthPasswordCredentials.
Username Property (OAuthClient Module)
The connecting user's username (login name).
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
Assign the user's login name to this property. Use Password to provide the password. The Username and Password properties are used only when GrantType is oauthPasswordCredentials.
Authorize Method (OAuthClient Module)
Performs user authorization and gets an access token.
Syntax
public func authorize() throws -> Bool
- (BOOL)authorize;
Remarks
Call this method to perform user authorization and get an access token. When the user completes authorization and its data is sent to the server, OAuthClient will fire the Wait event periodically, to show how much waiting time is left. Upon successful authorization, the AccessToken and ExpiresAt properties are filled.
Returns true if the authorization was granted, and false otherwise.
Config Method (OAuthClient Module)
Sets or retrieves a configuration setting.
Syntax
- (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.
DoAction Method (OAuthClient Module)
Performs an additional action.
Syntax
- (NSString*)doAction:(NSString*)actionID :(NSString*)actionParams;
Remarks
DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Error Event (OAuthClient Module)
Provides information about errors during authorization operations.
Syntax
- (void)onError:(int)errorCode :(NSString*)description;
Remarks
This event is fired in case of exceptional conditions occured during authorization operations.
ErrorCode contains an error code and Description contains a textual description of the error.
ExternalSign Event (OAuthClient 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 component via SignedData parameter.
OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contain algorithm-dependent parameters.
The component uses base16 (hex) encoding for 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 a .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();
};
LaunchBrowser Event (OAuthClient Module)
Fires to show the login page to the end-user.
Syntax
func onLaunchBrowser(url: String, handled: inout Bool)
- (void)onLaunchBrowser:(NSString*)URL :(int*)handled;
Remarks
Subscribe to this event to respond to requests from the component to open the URL in the browser. Set Handled to true to report that the URL has been opened in the browser.
TLSCertNeeded Event (OAuthClient Module)
Fires when a remote TLS party requests a client certificate.
Syntax
- (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 (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 (OAuthClient 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 TLSServerChain property to access the certificate chain. In general case, components 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 component, and can be adjusted if needed.
TLSEstablished Event (OAuthClient 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 successful completion of a TLS handshake.
The Version, Ciphersuite, and ConnectionId parameters indicate security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.
TLSHandshake Event (OAuthClient 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 with TLSEstablished event. If the server chooses to request a client certificate, TLSCertNeeded event will also be fired.
TLSPSK Event (OAuthClient Module)
Notifies the application about the PSK key exchange.
Syntax
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 (OAuthClient 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.
Wait Event (OAuthClient Module)
Fired periodically to show how much waiting time is left.
Syntax
func onWait(timeLeft: Int32, stop: inout Bool)
- (void)onWait:(int)timeLeft :(int*)stop;
Remarks
This event is fired after authorization is started, to show how much time is left to wait for server's response. Waiting can be cancelled by setting the Stop parameter to true, which will result in authorization failure.
Certificate Type
Provides details of an individual X.509 certificate.
Remarks
This type provides access to X.509 certificate details.
Fields
|
bytes Data |
Returns raw certificate data in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ca Bool |
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
caKeyID Data |
A unique identifier (fingerprint) of the CA certificate's private key. Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
crlDistributionPoints String |
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
curve String |
Specifies the elliptic curve of the EC public key.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
fingerprint Data |
Contains the fingerprint (a hash imprint) of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
friendlyName String |
Contains an associated alias (friendly name) of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
handle Int64 |
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hashAlgorithm String |
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
issuer String |
The common name of the certificate issuer (CA), typically a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
issuerRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyAlgorithm String |
Specifies the public key algorithm of this certificate.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyBits Int32 |
Returns the length of the public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyFingerprint Data |
Returns a fingerprint of the public key contained in the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyUsage Int32 |
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:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyValid Bool |
Returns True if the certificate's key is cryptographically valid, and False otherwise. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ocspLocations String |
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ocspNoCheck Bool |
Accessor to the value of the certificates ocsp-no-check extension. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
origin Int32 |
Returns the origin of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
policyIDs String |
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. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
privateKeyBytes Data |
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
privateKeyExists Bool |
Indicates whether the certificate has an associated private key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
privateKeyExtractable Bool |
Indicates whether the private key is extractable |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
publicKeyBytes Data |
Contains the certificate's public key in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
qualifiedStatements QualifiedStatementsTypes |
Returns the qualified status of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
selfSigned Bool |
Indicates whether the certificate is self-signed (root) or signed by an external CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
serialNumber Data |
Returns the certificate's serial number. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
sigAlgorithm String |
Indicates the algorithm that was used by the CA to sign this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subject String |
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subjectAlternativeName String |
Returns or sets the value of the Subject Alternative Name extension of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subjectKeyID Data |
Contains a unique identifier (fingerprint) of the certificate's private key. Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subjectRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
validFrom String |
The time point at which the certificate becomes valid, in UTC. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
validTo String |
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.
ConnectionInfo 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.
Fields
|
aeadCipher Bool |
Indicates whether the encryption algorithm used is an AEAD cipher. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
chainValidationDetails Int32 |
The details of a certificate chain validation outcome. They may often suggest what reasons that contributed to the overall validation result. Returns a bit mask of the following options:
|
||||||||||||||||||||||||||||||||||||||||||||||||
|
chainValidationResult ChainValidities |
The outcome of a certificate chain validation routine. Available options:
Use the ValidationLog property to access the detailed validation log. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ciphersuite String |
The cipher suite employed by this connection. For TLS connections, this property returns the ciphersuite that was/is employed by the connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
clientAuthenticated Bool |
Specifies whether client authentication was performed during this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
clientAuthRequested Bool |
Specifies whether client authentication was requested during this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
connectionEstablished Bool |
Indicates whether the connection has been established fully. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
connectionID Data |
The unique identifier assigned to this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
digestAlgorithm String |
The digest algorithm used in a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
encryptionAlgorithm String |
The symmetric encryption algorithm used in a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
exportable Bool |
Indicates whether a TLS connection uses a reduced-strength exportable cipher. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
keyExchangeAlgorithm String |
The key exchange algorithm used in a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
keyExchangeKeyBits Int32 |
The length of the key exchange key of a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
namedECCurve String |
The elliptic curve used in this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
pfsCipher Bool |
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). |
||||||||||||||||||||||||||||||||||||||||||||||||
|
preSharedIdentityHint String |
A hint professed by the server to help the client select the PSK identity to use. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
publicKeyBits Int32 |
The length of the public key. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
resumedSession Bool |
Indicates whether a TLS-enabled connection was spawned from another TLS connection |
||||||||||||||||||||||||||||||||||||||||||||||||
|
secureConnection Bool |
Indicates whether TLS or SSL is enabled for this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
serverAuthenticated Bool |
Indicates whether server authentication was performed during a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
signatureAlgorithm String |
The signature algorithm used in a TLS handshake. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
symmetricBlockSize Int32 |
The block size of the symmetric algorithm used. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
symmetricKeyBits Int32 |
The key length of the symmetric algorithm used. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
totalBytesReceived Int64 |
The total number of bytes received over this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
totalBytesSent Int64 |
The total number of bytes sent over this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
validationLog String |
Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
version String |
Indicates the version of SSL/TLS protocol negotiated during this connection. |
Constructors
public init()
Creates a new ConnectionInfo object.
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.
Fields
|
bytes Data |
Returns raw CRL data in DER format. |
|
caKeyID Data |
A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL. |
|
entryCount Int32 |
Returns the number of certificate status entries in the CRL. |
|
handle Int64 |
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
|
|
issuer String |
The common name of the CRL issuer (CA), typically a company name. |
|
issuerRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. |
|
location String |
The URL that the CRL was downloaded from. |
|
nextUpdate String |
The planned time and date of the next version of this CRL to be published. |
|
sigAlgorithm String |
The public key algorithm that was used by the CA to sign this CRL. |
|
tbs Data |
The to-be-signed part of the CRL (the CRL without the signature part). |
|
thisUpdate String |
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.
Fields
|
asyncDocumentID String |
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 pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
customParams String |
Custom parameters to be passed to the signing service (uninterpreted). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
data String |
Additional data to be included in the async state and mirrored back by the requestor |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
externalHashCalculation Bool |
Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hashAlgorithm String |
Specifies the request's signature hash algorithm.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyID String |
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 extra protection layer for the protocol and diminishes the risk of 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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keySecret String |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
method AsyncSignMethods |
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup. Available options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
mode ExternalCryptoModes |
Specifies the external cryptography mode. Available options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
publicKeyAlgorithm String |
Provide public key algorithm here if the certificate is not available on the pre-signing stage.
|
Constructors
public init()
Creates a new ExternalCrypto object with default field values.
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 (CRL).
An OCSP response is a snapshot of the certificate status at a given time.
Fields
|
bytes Data |
Buffer containing raw OCSP response data. |
|
entryCount Int32 |
The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status. |
|
handle Int64 |
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
|
|
issuer String |
Indicates the issuer of this response (a CA or its authorized representative). |
|
issuerRDN String |
Indicates the RDN of the issuer of this response (a CA or its authorized representative). |
|
location String |
Location of the OCSP responder. |
|
producedAt String |
Specifies the time when the response was produced, in UTC. |
Constructors
public init()
Creates an empty OCSP response object.
ProxySettings Type
A container for proxy server settings.
Remarks
This type exposes a collection of properties for tuning up the proxy server configuration.
Fields
|
address String |
The IP address of the proxy server. |
||||||||||
|
authentication ProxyAuthTypes |
The authentication type used by the proxy server.
|
||||||||||
|
password String |
The password to authenticate to the proxy server. |
||||||||||
|
port Int32 |
The port on the proxy server to connect to. |
||||||||||
|
proxyType ProxyTypes |
The type of the proxy server. The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.
|
||||||||||
|
requestHeaders String |
Contains HTTP request headers for WebTunnel and HTTP proxy. |
||||||||||
|
responseBody String |
Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
||||||||||
|
responseHeaders String |
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
||||||||||
|
useIPv6 Bool |
Specifies whether IPv6 should be used when connecting through the proxy. |
||||||||||
|
useProxy Bool |
Enables or disables proxy-driven connection. |
||||||||||
|
username String |
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.
Fields
|
dnsMode DNSResolveModes |
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
|
||||||||
|
dnsPort Int32 |
Specifies the port number to be used for sending queries to the DNS server. |
||||||||
|
dnsQueryTimeout Int32 |
The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout. |
||||||||
|
dnsServers String |
The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
||||||||
|
dnsTotalTimeout Int32 |
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout. |
||||||||
|
incomingSpeedLimit Int32 |
The maximum number of bytes to read from the socket, per second. |
||||||||
|
localAddress String |
The local network interface to bind the socket to. |
||||||||
|
localPort Int32 |
The local port number to bind the socket to. |
||||||||
|
outgoingSpeedLimit Int32 |
The maximum number of bytes to write to the socket, per second. |
||||||||
|
timeout Int32 |
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 |
Enables or disables IP protocol version 6. |
Constructors
public init()
Creates a new SocketSettings object.
StringNameValuePair Type
A simple name-value pair object.
Remarks
The class represents a name-value string pair used in a variety of network components.
Fields
|
category String |
Specifies the string category of the contained value. This property allows to check or set the category (or type) associated with the contained value. Depending on the format used to load or save the string, the category parameter may or may not be used. For example, for ASN.1 property lists the category contains the ASN.1 tag of the contained data (OCTETSTRING, UTF8STRING, INTEGER, ...). For basic (name, value) pairs, such as HTTP headers, the category parameter is not used. |
||||||
|
format Int32 |
Specifies the format (encoding) of the value contained in the property. Use this property to check or set the format of the contained value. Remember to provide the actual value in the appropriate
format that matches this setting:
The following formats are currently supported:
|
||||||
|
name String |
The name element in a (name, value) pair. |
||||||
|
value String |
The value element in a (name, value) pair. |
Constructors
public init(name: , value: )
Creates a name-value pair from a name and a value.
public init()
Creates an empty name-value object.
TLSSettings Type
A container for TLS connection settings.
Remarks
TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.
Fields
|
autoValidateCertificates Bool |
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
|||||||||||||||||||||||||||||||||
|
baseConfiguration SecureTransportPredefinedConfigurations |
Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility.
|
|||||||||||||||||||||||||||||||||
|
ciphersuites String |
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 that allow to blanketly enable or disable all ciphersuites at once. Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. 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:
|
|||||||||||||||||||||||||||||||||
|
ecCurves String |
Defines the elliptic curves to enable. |
|||||||||||||||||||||||||||||||||
|
extensions String |
Provides access to TLS extensions. |
|||||||||||||||||||||||||||||||||
|
forceResumeIfDestinationChanges Bool |
Whether to force TLS session resumption when the destination address changes. |
|||||||||||||||||||||||||||||||||
|
preSharedIdentity String |
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
|||||||||||||||||||||||||||||||||
|
preSharedKey String |
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
|||||||||||||||||||||||||||||||||
|
preSharedKeyCiphersuite String |
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
|||||||||||||||||||||||||||||||||
|
renegotiationAttackPreventionMode RenegotiationAttackPreventionModes |
Selects renegotiation attack prevention mechanism. The following options are available:
|
|||||||||||||||||||||||||||||||||
|
revocationCheck RevocationCheckKinds |
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.
This setting controls the way the revocation checks are performed. 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 faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential. |
|||||||||||||||||||||||||||||||||
|
sslOptions Int32 |
Various SSL (TLS) protocol options, set of
|
|||||||||||||||||||||||||||||||||
|
tlsMode SSLModes |
Specifies the TLS mode to use.
|
|||||||||||||||||||||||||||||||||
|
useExtendedMasterSecret Bool |
Enables Extended Master Secret Extension, as defined in RFC 7627. |
|||||||||||||||||||||||||||||||||
|
useSessionResumption Bool |
Enables or disables TLS session resumption capability. |
|||||||||||||||||||||||||||||||||
|
versions Int32 |
Th SSL/TLS versions to enable by default.
|
Constructors
public init()
Creates a new TLSSettings object.
Config Settings (OAuthClient 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.OAuthClient Config Settings | ||||||||||||||||||||||||||||||
| CacheControl:
Optional value for Cache-Control HTTP header field.Specifies an optional value to be used in the Cache-Control header field of HTTP requests.
Recommended value: no-store,max-age=0 |
||||||||||||||||||||||||||||||
| IDToken: ID Token parameter for JWT.This read-only value returns the id_token parameter (if any) than can be used for JWT operations. | ||||||||||||||||||||||||||||||
| IgnoreSystemTrust:
Whether trusted Windows Certificate Stores should be treated as trusted.Specifies whether, during chain validation, the component should respect
the trust to CA certificates as configured in the operating system.
In Windows this effectively defines whether the component 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 TrustedCertificates property) are considered trusted. |
||||||||||||||||||||||||||||||
PKCEMode:
Proof Key for Code Exchange method to use.Specifies which PKCE method should be used (if any) if GrantType is ogtAuthorizationCode.
|
||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||
| UseMicrosoftCTL: Enables or disables automatic use of 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 chain validation module 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 | ||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
| Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. | ||||||||||||||||||||||||||||||
| DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. | ||||||||||||||||||||||||||||||
| EnableClientSideSSLFFDHE:
Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower
algorithm if compared to EC DHE; enabling it may result in slower connections.
This setting only applies to sessions negotiated with TLS version 1.3. |
||||||||||||||||||||||||||||||
| GlobalCookies: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global". | ||||||||||||||||||||||||||||||
| HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. | ||||||||||||||||||||||||||||||
| LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
| MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. | ||||||||||||||||||||||||||||||
| StaticDNS:
Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.
Supported values are:
|
||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
| UseOwnDNSResolver: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. | ||||||||||||||||||||||||||||||
| UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. | ||||||||||||||||||||||||||||||
| UseSystemOAEPAndPSS:
Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable.
If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations
using its own OAEP/PSS implementation.
This setting only applies to certificates originating from a Windows system store. |
||||||||||||||||||||||||||||||
| UseSystemRandom: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. |