SecureBlackbox 2020 macOS Edition

Questions / Feedback?

OAuthClient Module

Properties   Methods   Events   Configuration Settings   Errors  

The OAuthClient component implements interaction between the client, the resource owner (end-user), and the authorization server via OAuth 2.0 protocol.

Syntax

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

AccessTokenContains the access token.
AuthURLSpecifies the URL of the authorization server.
AutoRefreshSpecifies whether access token should be automatically refreshed.
BlockedCertificatesThe certificates that must be rejected as trust anchors.
ClientChainThe TLS client certificate chain.
ClientIDClient ID of the application which needs access to the protected resource.
ClientSecretClient secret of the application which needs access to the protected resource.
ConnectionInfoReturns the details of the underlying network connection.
CustomParametersContains custom parameters of the authorization request.
ExpiresAtThe expiration time of access token.
ExpiresInReturns access token lifetime in seconds.
ExternalCryptoProvides access to external signing and DC parameters.
FailureResponseThe web page showed to the user by the component on authorization failure.
GrantTypeSpecifies which protocol flow should be used to authorize the user.
KeepAlivePolicyDefines the keep-alive handling policy.
KnownCertificatesAdditional certificates for chain validation.
KnownCRLsAdditional CRLs for chain validation.
KnownOCSPsAdditional OCSP responses for chain validation.
PasswordThe connecting user's authentication password.
ProxyThe proxy server settings.
RedirectURLThe URL where the user is redirected after authorization.
RefreshTokenThe refresh token, to be used to automatically obtain new access token.
ScopeThe scope of the request to be authorized.
ServerChainThe TLS server's certificate chain.
SocketSettingsManages network connection settings.
StateSpecifies the state parameter of the authorization request or response.
SuccessResponseThe web page showed to the user by the component on authorization success.
TimeoutSpecifies waiting timeout (in milliseconds).
TLSSettingsManages TLS layer settings.
TokenTypeReturns the access token type.
TokenURLSpecifies the URL of the token endpoint.
TrustedCertificatesA list of trusted certificates for chain validation.
UsernameThe 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.

AuthorizePerforms user authorization and gets an access token.
ConfigSets or retrieves a configuration setting.

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.

CertificateValidateFires when the server's TLS certificate has to be validated.
ErrorProvides information about errors during authorization operations.
ExternalSignHandles remote or external signing initiated by the SignExternal method or other source.
LaunchBrowserFires to show the login page to the end-user.
WaitFired periodically to show how much waiting time is left.

Configuration Settings


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

CacheControlOptional value for Cache-Control HTTP header field.
IDTokenID Token parameter for JWT.
IgnoreSystemTrustWhether trusted Windows Certificate Stores should be treated as trusted.
PKCEModeProof Key for Code Exchange method to use.
TolerateMinorChainIssuesWhether to tolerate minor chain issues.
UseMicrosoftCTLEnables or disables automatic use of Microsoft online certificate trust list.
UseSystemCertificatesEnables or disables the use of the system certificates.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolverSpecifies whether the client components should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 macOS Edition - Version 20.0 [Build 8165]