# OpenID Component The OpenID class is used to verify the identify of a user as well as get basic profile information. ## Syntax ```text ipworksauth.OpenID ``` ## Remarks The OpenID struct implements an OpenID Connect (OIDC) Relying Party (RP) capable of authenticating a user and retrieving user information. OIDC is a simple identity layer on top of OAuth 2.0 and re-uses much of the functionality and concepts defined by OAuth 2.0. To begin using the struct you will first need to register your application with the service you want to use. During this process you should obtain a [ClientId](#clientid-property-openid-component) and [ClientSecret](#clientsecret-property-openid-component). The following sections discuss the typical steps to verify the identity of a user and obtain profile information. ## Get the Discovery Document Many OpenID Providers (OPs) provide information via a Discovery Document. The discovery document defines information such as the endpoint URLs for authentication, tokens, and user information requests. Additionally, details about parameters such as supported authorization scopes are defined in this document. The document is found at a URL which can be fetched and parsed by calling the [GetDiscoveryDoc](#getdiscoverydoc-method-openid-component) method. The discovery document URL is typically published by an OpenID Provider (OP) and must be known before calling this method. The format of the URL is standardized and typically takes the form: *https://www.youropenidserver.com/.well-known/openid-configuration* Call [GetDiscoveryDoc](#getdiscoverydoc-method-openid-component) before calling [GetAuthorization](#getauthorization-method-openid-component) to populate the struct properties with information required to complete the authorization. The retrieved information includes endpoint URLs as well as the OpenID public certificates used to verify the signature on the ID Token. After calling this method the following properties are populated: - [ServerAuthURL](#serverauthurl-property-openid-component) - [ServerTokenURL](#servertokenurl-property-openid-component) - [ServerUserInfoURL](#serveruserinfourl-property-openid-component) - [SignerCertURL](#signercerturl-property-openid-component) The above values may be stored, and later populated from the stored values, to avoid the requirement of calling [GetDiscoveryDoc](#getdiscoverydoc-method-openid-component) on subsequent authorization requests. The following discovery document fields are populated after [GetDiscoveryDoc](#getdiscoverydoc-method-openid-component) returns: - [DiscoveryDocDetailsAuthorizationURL](#discoverydocdetailsauthorizationurl-property-openid-component) - [DiscoveryDocDetailsClaimsParamSupported](#discoverydocdetailsclaimsparamsupported-property-openid-component) - [DiscoveryDocDetailsIssuer](#discoverydocdetailsissuer-property-openid-component) - [DiscoveryDocDetailsSignerCertURL](#discoverydocdetailssignercerturl-property-openid-component) - [DiscoveryDocDetailsRegistrationURL](#discoverydocdetailsregistrationurl-property-openid-component) - [DiscoveryDocDetailsServiceDocsURL](#discoverydocdetailsservicedocsurl-property-openid-component) - [DiscoveryDocDetailsSupportedClaims](#discoverydocdetailssupportedclaims-property-openid-component) - [DiscoveryDocDetailsSupportedDisplays](#discoverydocdetailssupporteddisplays-property-openid-component) - [DiscoveryDocDetailsSupportedGrantTypes](#discoverydocdetailssupportedgranttypes-property-openid-component) - [DiscoveryDocDetailsSupportedResponseTypes](#discoverydocdetailssupportedresponsetypes-property-openid-component) - [DiscoveryDocDetailsSupportedScopes](#discoverydocdetailssupportedscopes-property-openid-component) - [DiscoveryDocDetailsTokenURL](#discoverydocdetailstokenurl-property-openid-component) - [DiscoveryDocDetailsUserInfoURL](#discoverydocdetailsuserinfourl-property-openid-component) To access values not automatically parsed by the struct the [XPath](#XPath) configuration setting may be set to retrieve a specific value. Alternatively the [RawJSON](#RawJSON) setting returns the entire JSON document which may be parsed separately. NOTE: Calling [GetDiscoveryDoc](#getdiscoverydoc-method-openid-component) is not mandatory. If server information was stored from a previous call or is otherwise known ahead of time the following properties may be set in place of calling [GetDiscoveryDoc](#getdiscoverydoc-method-openid-component): - [ServerAuthURL](#serverauthurl-property-openid-component) - [ServerTokenURL](#servertokenurl-property-openid-component) - [ServerUserInfoURL](#serveruserinfourl-property-openid-component) - [SignerCertURL](#signercerturl-property-openid-component) or SignerCert Examples of the above points: ```text openid.GetDiscoveryDoc("https://accounts.google.com/.well-known/openid-configuration"); // ... or ... openid.ServerAuthURL = "https://accounts.google.com/o/oauth2/v2/auth"; openid.ServerTokenURL = "https://oauth2.googleapis.com/token"; openid.ServerUserInfoURL = "https://openidconnect.googleapis.com/v1/userinfo"; openid.SignerCertURL = "https://www.googleapis.com/oauth2/v3/certs"; // ... or ... string rawjson = openid.Config("RawJSON"); ``` ## Get Authorization Before calling [GetAuthorization](#getauthorization-method-openid-component) the struct may be configured for one of several flows defined by the [GrantType](#granttype-property-openid-component) property. These flows determine which information is returned by the authorization server and which information (if any) is returned by the Token server. Possible values for [GrantType](#granttype-property-openid-component) are: - 0 (Authorization Code - Default) - 1 (Implicit) - 2 (Hybrid) When using *0* (Authorization Code Flow - Default), an authorization code is returned from the [ServerAuthURL](#serverauthurl-property-openid-component) and the struct automatically contacts the [ServerTokenURL](#servertokenurl-property-openid-component) and exchanges the authorization code for an ID Token and access token. When using *1* (Implicit Flow), the [ServerAuthURL](#serverauthurl-property-openid-component) returns an ID Token and access token directly. This is only recommended for implementations that are in-browser, as this potentially exposes the tokens to the end-user and user agent itself. When using *2* (Hybrid Flow), an authorization code and potentially one or more tokens are returned by the [ServerAuthURL](#serverauthurl-property-openid-component). The struct will automatically contact the [ServerTokenURL](#servertokenurl-property-openid-component) to exchange the authorization code for an ID Token and access token. When [GrantType](#granttype-property-openid-component) and any other optional settings are set as desired, call [GetAuthorization](#getauthorization-method-openid-component). [GetAuthorization](#getauthorization-method-openid-component) performs several operations automatically depending on the value of [ClientProfile](#clientprofile-property-openid-component). Please see the introduction section for the [OpenID](#openid-component) struct for a detailed overview of the typical scenarios. After authorization is complete, UserDetails will be populated with the claims parsed from the ID Token. This method also returns an authorization string. The authorization string grants access to additional resources as requested via the [AuthorizationScope](#authorizationscope-property-openid-component) property. If access to another resource was requested, then the access token returned here may be set in the Authorization property of any other struct (or passed as the value of the HTTP Authorization header). [GetUserInfo](#getuserinfo-method-openid-component) may be called after calling this method. The following properties are applicable when calling this method: - [ClientId](#clientid-property-openid-component) (required) - [ClientSecret](#clientsecret-property-openid-component) (required) - [ServerAuthURL](#serverauthurl-property-openid-component) (required - populated by [GetDiscoveryDoc](#getdiscoverydoc-method-openid-component).) - [ServerTokenURL](#servertokenurl-property-openid-component) (required - populated by [GetDiscoveryDoc](#getdiscoverydoc-method-openid-component).) - [SignerCertURL](#signercerturl-property-openid-component) (conditional - populated by [GetDiscoveryDoc](#getdiscoverydoc-method-openid-component). Required if SignerCert is not set.) - SignerCert (conditional - required if [SignerCertURL](#signercerturl-property-openid-component) is not set.) - [AuthorizationScope](#authorizationscope-property-openid-component) - [ClientProfile](#clientprofile-property-openid-component) - [GrantType](#granttype-property-openid-component) - Params - [RefreshToken](#refreshtoken-property-openid-component) - [ReturnURL](#returnurl-property-openid-component) - [State](#state-property-openid-component) - [Timeout](#timeout-property-openid-component) - [Display](#Display) - [Prompt](#Prompt) - [IdTokenHint](#IdTokenHint) - [LoginHint](#LoginHint) - [ResponseType](#ResponseType) For the default *Authorization Code* flow, GetAuthorization could work like this: ```text openid.ClientId = "client id"; openid.ClientSecret = "client secret"; openid.AuthorizationScope += " profile email"; // default value is 'openid' openid.State = "application state"; string authToken = openid.GetAuthorization(); ``` ## Get User Info When [GetAuthorization](#getauthorization-method-openid-component) returns, the UserDetails property is populated with information about the user as returned in the ID Token from the authorization server. An additional operation, [GetUserInfo](#getuserinfo-method-openid-component) may optionally be called to query the [ServerUserInfoURL](#serveruserinfourl-property-openid-component) for information about the user. Before calling the [GetUserInfo](#getuserinfo-method-openid-component) method, a successful call to [GetAuthorization](#getauthorization-method-openid-component) must be made. The access token returned by [GetAuthorization](#getauthorization-method-openid-component) is used by the OpenID provider at [ServerUserInfoURL](#serveruserinfourl-property-openid-component) to identify the user for which claims are being retrieved. When this method is called the struct requests the claims about the user from the [ServerUserInfoURL](#serveruserinfourl-property-openid-component). The resulting claims are available in the UserDetails property. Note: The [GetUserInfo](#getuserinfo-method-openid-component) method will populate the UserDetails property with the claims returned in the ID Token during the authorization process. This method may not need to be called in order to access the desired claims about the user. ```text openid.GetUserInfo(); // ... use the user info in the remainder of your application ... ``` ## Client Profile Notes The [ClientProfile](#clientprofile-property-openid-component) defines the environment in which the struct is being used, and controls how the struct behaves in order to best suit that environment. Choose the profile that is closest to the runtime environment. The following client types are currently supported by the struct: - Application (desktop application) - WebServer (server side application such as a web site) - Device (an application without browser access such as a game console) - Mobile (phone or tablet application) - Browser (javascript application) - JWT (server to server authentication using a JWT bearer token such as Google service account authentication) ## Application Profile The Application profile is applicable to applications that are run directly by the user. For instance, a Windows form application would use the Application profile. To authorize your application (client) using the Application profile, use the following steps: First, set [ClientProfile](#clientprofile-property-openid-component) to ocpApplication. This defines the profile the struct will use. Set the [ClientId](#clientid-property-openid-component), [ClientSecret](#clientsecret-property-openid-component), [ServerAuthURL](#serverauthurl-property-openid-component), and [ServerTokenURL](#servertokenurl-property-openid-component) to the values you obtained when registering your application. Second, call [GetAuthorization](#getauthorization-method-openid-component) to begin the authorization process. When [GetAuthorization](#getauthorization-method-openid-component) is called, the struct will build the URL to which the user will be directed and fire the [LaunchBrowser](#launchbrowser-event-openid-component) event. The struct will then launch the browser using the command and URL shown in the [LaunchBrowser](#launchbrowser-event-openid-component) event and await the response. The duration for which the struct will wait for a response is defined by [BrowserResponseTimeout](#BrowserResponseTimeout). Third, the user will interact with the browser to authenticate and grant access to the connecting application. The user will then be redirected back to an embedded web server that was automatically started when [GetAuthorization](#getauthorization-method-openid-component) was called. At this time, the [ReturnURL](#returnurl-event-openid-component) event will fire. This event provides an opportunity to provide a custom response to your user that they will see in their browser. Fourth, the struct will then automatically exchange the grant that was returned by the authorization server for the access token using the HTTP endpoint specified in [ServerTokenURL](#servertokenurl-property-openid-component). The authorization is now complete and the [GetAuthorization](#getauthorization-method-openid-component) method will return the authorization string. The authorization string can then be used with any of our components by simply setting the returned value to the authorization property before making a request. The following is a simple example: ```text component.ClientId = "CLIENT_ID"; component.ClientSecret = "CLIENT_ID"; component.ServerAuthURL = "https://accounts.google.com/o/oauth2/auth"; component.ServerTokenURL = "https://accounts.google.com/o/oauth2/token"; HTTP.Authorization = component.GetAuthorization(); HTTP.Get("https://www.googleapis.com/oauth2/v1/userinfo"); ``` ## Web Profile The Web profile is applicable to applications that are run on the server side when the user uses the application from a web browser. To authorize your application (client) using this profile, use the following steps: First, set [ClientProfile](#clientprofile-property-openid-component) to ocpWeb. This defines the profile the component will use. Set the [ClientId](#clientid-property-openid-component), [ClientSecret](#clientsecret-property-openid-component), [ServerAuthURL](#serverauthurl-property-openid-component), and [ServerTokenURL](#servertokenurl-property-openid-component) to the values you obtained when registering your application. Set [ReturnURL](#returnurl-property-openid-component) to the page on your site that will be the endpoint the user is redirected back to after authentication. Second, call [GetAuthorizationURL](#getauthorizationurl-method-openid-component). This will return a URL to which the user should be redirected. Redirect the user to this URL. Third, after the user authenticates and is returned to the page on your site specified by [ReturnURL](#returnurl-property-openid-component), parse the "code" query string parameter from the incoming request to get the authorization code from the authorization server. Then, set [AuthorizationCode](#authorizationcode-property-openid-component) property to the parsed value. Fourth, after [AuthorizationCode](#authorizationcode-property-openid-component) is set, call [GetAuthorization](#getauthorization-method-openid-component) to exchange the code specified in [AuthorizationCode](#authorizationcode-property-openid-component) for a token from the server specified by [ServerTokenURL](#servertokenurl-property-openid-component). [GetAuthorization](#getauthorization-method-openid-component) will then return the authorization string. The authorization string can be used with any of our components by simply setting the returned value to the authorization property before making a request. For additional details for less common profile types please see [ClientProfile](#clientprofile-property-openid-component). ## Property List *The following is the full list of the properties of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AccessToken](#accesstoken-property-openid-component) | The access token returned by the authorization server. | | [AccessTokenExp](#accesstokenexp-property-openid-component) | The lifetime of the access token. | | [AuthorizationCode](#authorizationcode-property-openid-component) | The authorization code that is exchanged for an access token. | | [AuthorizationScope](#authorizationscope-property-openid-component) | The authorization scope used during authorization. | | [ClientId](#clientid-property-openid-component) | The Id of the client assigned when registering the application. | | [ClientProfile](#clientprofile-property-openid-component) | The type of client that is requesting authorization. | | [ClientSecret](#clientsecret-property-openid-component) | The secret value for the client assigned when registering the application. | | [Connected](#connected-property-openid-component) | Whether the class is connected. | | [CookieCount](#cookiecount-property-openid-component) | The number of records in the Cookie arrays. | | [CookieDomain](#cookiedomain-property-openid-component) | The domain of a received cookie. | | [CookieExpiration](#cookieexpiration-property-openid-component) | An expiration time for the cookie (if provided by the server). | | [CookieName](#cookiename-property-openid-component) | The name of the cookie. | | [CookiePath](#cookiepath-property-openid-component) | A path name to limit the cookie to (if provided by the server). | | [CookieSecure](#cookiesecure-property-openid-component) | The security flag of the received cookie. | | [CookieValue](#cookievalue-property-openid-component) | The value of the cookie. | | [DiscoveryDocDetailsAuthorizationURL](#discoverydocdetailsauthorizationurl-property-openid-component) | The server authorization endpoint URL. | | [DiscoveryDocDetailsClaimsParamSupported](#discoverydocdetailsclaimsparamsupported-property-openid-component) | Whether the claims request parameter is supported by the Open ID provider. | | [DiscoveryDocDetailsContent](#discoverydocdetailscontent-property-openid-component) | The raw discovery document JSON. | | [DiscoveryDocDetailsIssuer](#discoverydocdetailsissuer-property-openid-component) | The issuer identifier of the OpenID provider. | | [DiscoveryDocDetailsLogoutURL](#discoverydocdetailslogouturl-property-openid-component) | The logout endpoint URL. | | [DiscoveryDocDetailsRegistrationURL](#discoverydocdetailsregistrationurl-property-openid-component) | The dynamic client registration URL. | | [DiscoveryDocDetailsServiceDocsURL](#discoverydocdetailsservicedocsurl-property-openid-component) | The URL of the human-readable service documentation. | | [DiscoveryDocDetailsSignerCertURL](#discoverydocdetailssignercerturl-property-openid-component) | The URL of the JSON Web Key Set used to verify signatures on values returned by the OpenID provider. | | [DiscoveryDocDetailsSupportedClaims](#discoverydocdetailssupportedclaims-property-openid-component) | A comma-separated list of claims that are supported by the OpenID provider. | | [DiscoveryDocDetailsSupportedDisplays](#discoverydocdetailssupporteddisplays-property-openid-component) | A comma-separated list of display values that are supported by the OpenID provider. | | [DiscoveryDocDetailsSupportedGrantTypes](#discoverydocdetailssupportedgranttypes-property-openid-component) | A comma-separated list of grant types supported by the OpenID provider. | | [DiscoveryDocDetailsSupportedResponseTypes](#discoverydocdetailssupportedresponsetypes-property-openid-component) | A comma-separated list of response types supported by the OpenID provider. | | [DiscoveryDocDetailsSupportedScopes](#discoverydocdetailssupportedscopes-property-openid-component) | A comma-separated list of scopes that are supported by the OpenID provider. | | [DiscoveryDocDetailsTokenURL](#discoverydocdetailstokenurl-property-openid-component) | The token endpoint URL. | | [DiscoveryDocDetailsUserInfoURL](#discoverydocdetailsuserinfourl-property-openid-component) | The user info endpoint URL. | | [FirewallAutoDetect](#firewallautodetect-property-openid-component) | Whether to automatically detect and use firewall system settings, if available. | | [FirewallType](#firewalltype-property-openid-component) | The type of firewall to connect through. | | [FirewallHost](#firewallhost-property-openid-component) | The name or IP address of the firewall (optional). | | [FirewallPassword](#firewallpassword-property-openid-component) | A password if authentication is to be used when connecting through the firewall. | | [FirewallPort](#firewallport-property-openid-component) | The Transmission Control Protocol (TCP) port for the firewall Host . | | [FirewallUser](#firewalluser-property-openid-component) | A username if authentication is to be used when connecting through a firewall. | | [FollowRedirects](#followredirects-property-openid-component) | Determines what happens when the server issues a redirect. | | [GrantType](#granttype-property-openid-component) | The grant type defining the authentication flow. | | [Idle](#idle-property-openid-component) | The current status of the class. | | [IdTokenAudiences](#idtokenaudiences-property-openid-component) | A comma-separated list of audiences for which the ID Token is intended. | | [IdTokenAuthTime](#idtokenauthtime-property-openid-component) | The time when the end user authenticates with the authorization server. | | [IdTokenExpTime](#idtokenexptime-property-openid-component) | The time when the ID Token expires. | | [IdTokenContent](#idtokencontent-property-openid-component) | The raw value of the ID Token. | | [IdTokenIssuedTime](#idtokenissuedtime-property-openid-component) | The time when the authentication for this ID Token occurred. | | [IdTokenIssuer](#idtokenissuer-property-openid-component) | The issuer, or authorization server, that constructed the ID Token. | | [LocalHost](#localhost-property-openid-component) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [OtherHeaders](#otherheaders-property-openid-component) | Other headers as determined by the user (optional). | | [ParamCount](#paramcount-property-openid-component) | The number of records in the Param arrays. | | [ParamName](#paramname-property-openid-component) | The name of the parameter to be used in the request or returned in the response. | | [ParamValue](#paramvalue-property-openid-component) | The value of the parameter to be used in the request or returned in the response. | | [ProxyAuthScheme](#proxyauthscheme-property-openid-component) | The type of authorization to perform when connecting to the proxy. | | [ProxyAutoDetect](#proxyautodetect-property-openid-component) | Whether to automatically detect and use proxy system settings, if available. | | [ProxyPassword](#proxypassword-property-openid-component) | A password if authentication is to be used for the proxy. | | [ProxyPort](#proxyport-property-openid-component) | The Transmission Control Protocol (TCP) port for the proxy Server (default 80). | | [ProxyServer](#proxyserver-property-openid-component) | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. | | [ProxySSL](#proxyssl-property-openid-component) | When to use a Secure Sockets Layer (SSL) for the connection to the proxy. | | [ProxyUser](#proxyuser-property-openid-component) | A username if authentication is to be used for the proxy. | | [RefreshToken](#refreshtoken-property-openid-component) | The refresh token received from or sent to the authorization server. | | [ReturnURL](#returnurl-property-openid-component) | The URL where the user (browser) returns after authenticating. | | [ServerAuthURL](#serverauthurl-property-openid-component) | The URL of the authorization server. | | [ServerTokenURL](#servertokenurl-property-openid-component) | The URL used to obtain the access token. | | [ServerUserInfoURL](#serveruserinfourl-property-openid-component) | The URL of the OpenID provider's user info endpoint. | | [SignerCertEffectiveDate](#signercerteffectivedate-property-openid-component) | The date on which this certificate becomes valid. | | [SignerCertExpirationDate](#signercertexpirationdate-property-openid-component) | The date on which the certificate expires. | | [SignerCertExtendedKeyUsage](#signercertextendedkeyusage-property-openid-component) | A comma-delimited list of extended key usage identifiers. | | [SignerCertFingerprint](#signercertfingerprint-property-openid-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SignerCertFingerprintSHA1](#signercertfingerprintsha1-property-openid-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SignerCertFingerprintSHA256](#signercertfingerprintsha256-property-openid-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SignerCertIssuer](#signercertissuer-property-openid-component) | The issuer of the certificate. | | [SignerCertPrivateKey](#signercertprivatekey-property-openid-component) | The private key of the certificate (if available). | | [SignerCertPrivateKeyAvailable](#signercertprivatekeyavailable-property-openid-component) | Whether a PrivateKey is available for the selected certificate. | | [SignerCertPrivateKeyContainer](#signercertprivatekeycontainer-property-openid-component) | The name of the PrivateKey container for the certificate (if available). | | [SignerCertPublicKey](#signercertpublickey-property-openid-component) | The public key of the certificate. | | [SignerCertPublicKeyAlgorithm](#signercertpublickeyalgorithm-property-openid-component) | The textual description of the certificate's public key algorithm. | | [SignerCertPublicKeyLength](#signercertpublickeylength-property-openid-component) | The length of the certificate's public key (in bits). | | [SignerCertSerialNumber](#signercertserialnumber-property-openid-component) | The serial number of the certificate encoded as a string. | | [SignerCertSignatureAlgorithm](#signercertsignaturealgorithm-property-openid-component) | The text description of the certificate's signature algorithm. | | [SignerCertStore](#signercertstore-property-openid-component) | The name of the certificate store for the client certificate. | | [SignerCertStorePassword](#signercertstorepassword-property-openid-component) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SignerCertStoreType](#signercertstoretype-property-openid-component) | The type of certificate store for this certificate. | | [SignerCertSubjectAltNames](#signercertsubjectaltnames-property-openid-component) | Comma-separated lists of alternative subject names for the certificate. | | [SignerCertThumbprintMD5](#signercertthumbprintmd5-property-openid-component) | The MD5 hash of the certificate. | | [SignerCertThumbprintSHA1](#signercertthumbprintsha1-property-openid-component) | The SHA-1 hash of the certificate. | | [SignerCertThumbprintSHA256](#signercertthumbprintsha256-property-openid-component) | The SHA-256 hash of the certificate. | | [SignerCertUsage](#signercertusage-property-openid-component) | The text description of UsageFlags . | | [SignerCertUsageFlags](#signercertusageflags-property-openid-component) | The flags that show intended use for the certificate. | | [SignerCertVersion](#signercertversion-property-openid-component) | The certificate's version number. | | [SignerCertSubject](#signercertsubject-property-openid-component) | The subject of the certificate used for client authentication. | | [SignerCertEncoded](#signercertencoded-property-openid-component) | The certificate (PEM/Base64 encoded). | | [SignerCertURL](#signercerturl-property-openid-component) | The URL of the OpenID provider's signing certificate. | | [SSLAcceptServerCertEffectiveDate](#sslacceptservercerteffectivedate-property-openid-component) | The date on which this certificate becomes valid. | | [SSLAcceptServerCertExpirationDate](#sslacceptservercertexpirationdate-property-openid-component) | The date on which the certificate expires. | | [SSLAcceptServerCertExtendedKeyUsage](#sslacceptservercertextendedkeyusage-property-openid-component) | A comma-delimited list of extended key usage identifiers. | | [SSLAcceptServerCertFingerprint](#sslacceptservercertfingerprint-property-openid-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SSLAcceptServerCertFingerprintSHA1](#sslacceptservercertfingerprintsha1-property-openid-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SSLAcceptServerCertFingerprintSHA256](#sslacceptservercertfingerprintsha256-property-openid-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SSLAcceptServerCertIssuer](#sslacceptservercertissuer-property-openid-component) | The issuer of the certificate. | | [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-openid-component) | The private key of the certificate (if available). | | [SSLAcceptServerCertPrivateKeyAvailable](#sslacceptservercertprivatekeyavailable-property-openid-component) | Whether a PrivateKey is available for the selected certificate. | | [SSLAcceptServerCertPrivateKeyContainer](#sslacceptservercertprivatekeycontainer-property-openid-component) | The name of the PrivateKey container for the certificate (if available). | | [SSLAcceptServerCertPublicKey](#sslacceptservercertpublickey-property-openid-component) | The public key of the certificate. | | [SSLAcceptServerCertPublicKeyAlgorithm](#sslacceptservercertpublickeyalgorithm-property-openid-component) | The textual description of the certificate's public key algorithm. | | [SSLAcceptServerCertPublicKeyLength](#sslacceptservercertpublickeylength-property-openid-component) | The length of the certificate's public key (in bits). | | [SSLAcceptServerCertSerialNumber](#sslacceptservercertserialnumber-property-openid-component) | The serial number of the certificate encoded as a string. | | [SSLAcceptServerCertSignatureAlgorithm](#sslacceptservercertsignaturealgorithm-property-openid-component) | The text description of the certificate's signature algorithm. | | [SSLAcceptServerCertStore](#sslacceptservercertstore-property-openid-component) | The name of the certificate store for the client certificate. | | [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-openid-component) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-openid-component) | The type of certificate store for this certificate. | | [SSLAcceptServerCertSubjectAltNames](#sslacceptservercertsubjectaltnames-property-openid-component) | Comma-separated lists of alternative subject names for the certificate. | | [SSLAcceptServerCertThumbprintMD5](#sslacceptservercertthumbprintmd5-property-openid-component) | The MD5 hash of the certificate. | | [SSLAcceptServerCertThumbprintSHA1](#sslacceptservercertthumbprintsha1-property-openid-component) | The SHA-1 hash of the certificate. | | [SSLAcceptServerCertThumbprintSHA256](#sslacceptservercertthumbprintsha256-property-openid-component) | The SHA-256 hash of the certificate. | | [SSLAcceptServerCertUsage](#sslacceptservercertusage-property-openid-component) | The text description of UsageFlags . | | [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-openid-component) | The flags that show intended use for the certificate. | | [SSLAcceptServerCertVersion](#sslacceptservercertversion-property-openid-component) | The certificate's version number. | | [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-openid-component) | The subject of the certificate used for client authentication. | | [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-openid-component) | The certificate (PEM/Base64 encoded). | | [SSLCertEffectiveDate](#sslcerteffectivedate-property-openid-component) | The date on which this certificate becomes valid. | | [SSLCertExpirationDate](#sslcertexpirationdate-property-openid-component) | The date on which the certificate expires. | | [SSLCertExtendedKeyUsage](#sslcertextendedkeyusage-property-openid-component) | A comma-delimited list of extended key usage identifiers. | | [SSLCertFingerprint](#sslcertfingerprint-property-openid-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SSLCertFingerprintSHA1](#sslcertfingerprintsha1-property-openid-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SSLCertFingerprintSHA256](#sslcertfingerprintsha256-property-openid-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SSLCertIssuer](#sslcertissuer-property-openid-component) | The issuer of the certificate. | | [SSLCertPrivateKey](#sslcertprivatekey-property-openid-component) | The private key of the certificate (if available). | | [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-openid-component) | Whether a PrivateKey is available for the selected certificate. | | [SSLCertPrivateKeyContainer](#sslcertprivatekeycontainer-property-openid-component) | The name of the PrivateKey container for the certificate (if available). | | [SSLCertPublicKey](#sslcertpublickey-property-openid-component) | The public key of the certificate. | | [SSLCertPublicKeyAlgorithm](#sslcertpublickeyalgorithm-property-openid-component) | The textual description of the certificate's public key algorithm. | | [SSLCertPublicKeyLength](#sslcertpublickeylength-property-openid-component) | The length of the certificate's public key (in bits). | | [SSLCertSerialNumber](#sslcertserialnumber-property-openid-component) | The serial number of the certificate encoded as a string. | | [SSLCertSignatureAlgorithm](#sslcertsignaturealgorithm-property-openid-component) | The text description of the certificate's signature algorithm. | | [SSLCertStore](#sslcertstore-property-openid-component) | The name of the certificate store for the client certificate. | | [SSLCertStorePassword](#sslcertstorepassword-property-openid-component) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SSLCertStoreType](#sslcertstoretype-property-openid-component) | The type of certificate store for this certificate. | | [SSLCertSubjectAltNames](#sslcertsubjectaltnames-property-openid-component) | Comma-separated lists of alternative subject names for the certificate. | | [SSLCertThumbprintMD5](#sslcertthumbprintmd5-property-openid-component) | The MD5 hash of the certificate. | | [SSLCertThumbprintSHA1](#sslcertthumbprintsha1-property-openid-component) | The SHA-1 hash of the certificate. | | [SSLCertThumbprintSHA256](#sslcertthumbprintsha256-property-openid-component) | The SHA-256 hash of the certificate. | | [SSLCertUsage](#sslcertusage-property-openid-component) | The text description of UsageFlags . | | [SSLCertUsageFlags](#sslcertusageflags-property-openid-component) | The flags that show intended use for the certificate. | | [SSLCertVersion](#sslcertversion-property-openid-component) | The certificate's version number. | | [SSLCertSubject](#sslcertsubject-property-openid-component) | The subject of the certificate used for client authentication. | | [SSLCertEncoded](#sslcertencoded-property-openid-component) | The certificate (PEM/Base64 encoded). | | [SSLProvider](#sslprovider-property-openid-component) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [SSLServerCertEffectiveDate](#sslservercerteffectivedate-property-openid-component) | The date on which this certificate becomes valid. | | [SSLServerCertExpirationDate](#sslservercertexpirationdate-property-openid-component) | The date on which the certificate expires. | | [SSLServerCertExtendedKeyUsage](#sslservercertextendedkeyusage-property-openid-component) | A comma-delimited list of extended key usage identifiers. | | [SSLServerCertFingerprint](#sslservercertfingerprint-property-openid-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SSLServerCertFingerprintSHA1](#sslservercertfingerprintsha1-property-openid-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SSLServerCertFingerprintSHA256](#sslservercertfingerprintsha256-property-openid-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SSLServerCertIssuer](#sslservercertissuer-property-openid-component) | The issuer of the certificate. | | [SSLServerCertPrivateKey](#sslservercertprivatekey-property-openid-component) | The private key of the certificate (if available). | | [SSLServerCertPrivateKeyAvailable](#sslservercertprivatekeyavailable-property-openid-component) | Whether a PrivateKey is available for the selected certificate. | | [SSLServerCertPrivateKeyContainer](#sslservercertprivatekeycontainer-property-openid-component) | The name of the PrivateKey container for the certificate (if available). | | [SSLServerCertPublicKey](#sslservercertpublickey-property-openid-component) | The public key of the certificate. | | [SSLServerCertPublicKeyAlgorithm](#sslservercertpublickeyalgorithm-property-openid-component) | The textual description of the certificate's public key algorithm. | | [SSLServerCertPublicKeyLength](#sslservercertpublickeylength-property-openid-component) | The length of the certificate's public key (in bits). | | [SSLServerCertSerialNumber](#sslservercertserialnumber-property-openid-component) | The serial number of the certificate encoded as a string. | | [SSLServerCertSignatureAlgorithm](#sslservercertsignaturealgorithm-property-openid-component) | The text description of the certificate's signature algorithm. | | [SSLServerCertStore](#sslservercertstore-property-openid-component) | The name of the certificate store for the client certificate. | | [SSLServerCertStorePassword](#sslservercertstorepassword-property-openid-component) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SSLServerCertStoreType](#sslservercertstoretype-property-openid-component) | The type of certificate store for this certificate. | | [SSLServerCertSubjectAltNames](#sslservercertsubjectaltnames-property-openid-component) | Comma-separated lists of alternative subject names for the certificate. | | [SSLServerCertThumbprintMD5](#sslservercertthumbprintmd5-property-openid-component) | The MD5 hash of the certificate. | | [SSLServerCertThumbprintSHA1](#sslservercertthumbprintsha1-property-openid-component) | The SHA-1 hash of the certificate. | | [SSLServerCertThumbprintSHA256](#sslservercertthumbprintsha256-property-openid-component) | The SHA-256 hash of the certificate. | | [SSLServerCertUsage](#sslservercertusage-property-openid-component) | The text description of UsageFlags . | | [SSLServerCertUsageFlags](#sslservercertusageflags-property-openid-component) | The flags that show intended use for the certificate. | | [SSLServerCertVersion](#sslservercertversion-property-openid-component) | The certificate's version number. | | [SSLServerCertSubject](#sslservercertsubject-property-openid-component) | The subject of the certificate used for client authentication. | | [SSLServerCertEncoded](#sslservercertencoded-property-openid-component) | The certificate (PEM/Base64 encoded). | | [State](#state-property-openid-component) | The opaque value used to maintain state between the request and response. | | [Timeout](#timeout-property-openid-component) | The timeout for the class. | | [TransferredData](#transferreddata-property-openid-component) | The contents of the last response from the server. | | [TransferredHeaders](#transferredheaders-property-openid-component) | The full set of headers as received from the server. | | [UsePKCE](#usepkce-property-openid-component) | Whether Proof Key for Code Exchange (PKCE) should be used. | | [UserDetailsAddrCountry](#userdetailsaddrcountry-property-openid-component) | The country name portion of the user's address. | | [UserDetailsAddrFormatted](#userdetailsaddrformatted-property-openid-component) | The full mailing address of the user, formatted for display or use on a mailing label. | | [UserDetailsAddrLocality](#userdetailsaddrlocality-property-openid-component) | The city or locality portion of the user's address. | | [UserDetailsAddrPostalCode](#userdetailsaddrpostalcode-property-openid-component) | The zip code or postal code portion of the user's address. | | [UserDetailsAddrRegion](#userdetailsaddrregion-property-openid-component) | The state, province, prefecture, or region portion of the user's address. | | [UserDetailsAddrStreetAddr](#userdetailsaddrstreetaddr-property-openid-component) | The street address portion of the user's address. | | [UserDetailsBirthday](#userdetailsbirthday-property-openid-component) | The user's birthday. | | [UserDetailsEmail](#userdetailsemail-property-openid-component) | The user's preferred email address. | | [UserDetailsEmailVerified](#userdetailsemailverified-property-openid-component) | Whether the user's email address has been verified. | | [UserDetailsFirstName](#userdetailsfirstname-property-openid-component) | The first name of the user. | | [UserDetailsGender](#userdetailsgender-property-openid-component) | The user's gender. | | [UserDetailsLastName](#userdetailslastname-property-openid-component) | The last name of the user. | | [UserDetailsLocale](#userdetailslocale-property-openid-component) | The end user's locale. | | [UserDetailsMiddleName](#userdetailsmiddlename-property-openid-component) | The middle name of the user. | | [UserDetailsName](#userdetailsname-property-openid-component) | The user's full name in displayable form including all name parts. | | [UserDetailsNickname](#userdetailsnickname-property-openid-component) | The casual name of the user. | | [UserDetailsPhoneNumber](#userdetailsphonenumber-property-openid-component) | The user's phone number. | | [UserDetailsPhoneNumberVerified](#userdetailsphonenumberverified-property-openid-component) | Whether the user's phone number has been verified. | | [UserDetailsPictureURL](#userdetailspictureurl-property-openid-component) | The URL of the user's profile picture. | | [UserDetailsPreferredUsername](#userdetailspreferredusername-property-openid-component) | The shorthand name by which the end-user wishes to be referred. | | [UserDetailsProfileURL](#userdetailsprofileurl-property-openid-component) | The URL of the user's profile page. | | [UserDetailsSubject](#userdetailssubject-property-openid-component) | The subject of the user that is being represented. | | [UserDetailsUpdatedAt](#userdetailsupdatedat-property-openid-component) | The time when the user's information was last updated. | | [UserDetailsWebsite](#userdetailswebsite-property-openid-component) | The URL of the user's website. | | [UserDetailsZoneInfo](#userdetailszoneinfo-property-openid-component) | The user's time zone. | | [WebServerPort](#webserverport-property-openid-component) | The local port on which the embedded web server listens. | | [WebServerSSLCertEffectiveDate](#webserversslcerteffectivedate-property-openid-component) | The date on which this certificate becomes valid. | | [WebServerSSLCertExpirationDate](#webserversslcertexpirationdate-property-openid-component) | The date on which the certificate expires. | | [WebServerSSLCertExtendedKeyUsage](#webserversslcertextendedkeyusage-property-openid-component) | A comma-delimited list of extended key usage identifiers. | | [WebServerSSLCertFingerprint](#webserversslcertfingerprint-property-openid-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [WebServerSSLCertFingerprintSHA1](#webserversslcertfingerprintsha1-property-openid-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [WebServerSSLCertFingerprintSHA256](#webserversslcertfingerprintsha256-property-openid-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [WebServerSSLCertIssuer](#webserversslcertissuer-property-openid-component) | The issuer of the certificate. | | [WebServerSSLCertPrivateKey](#webserversslcertprivatekey-property-openid-component) | The private key of the certificate (if available). | | [WebServerSSLCertPrivateKeyAvailable](#webserversslcertprivatekeyavailable-property-openid-component) | Whether a PrivateKey is available for the selected certificate. | | [WebServerSSLCertPrivateKeyContainer](#webserversslcertprivatekeycontainer-property-openid-component) | The name of the PrivateKey container for the certificate (if available). | | [WebServerSSLCertPublicKey](#webserversslcertpublickey-property-openid-component) | The public key of the certificate. | | [WebServerSSLCertPublicKeyAlgorithm](#webserversslcertpublickeyalgorithm-property-openid-component) | The textual description of the certificate's public key algorithm. | | [WebServerSSLCertPublicKeyLength](#webserversslcertpublickeylength-property-openid-component) | The length of the certificate's public key (in bits). | | [WebServerSSLCertSerialNumber](#webserversslcertserialnumber-property-openid-component) | The serial number of the certificate encoded as a string. | | [WebServerSSLCertSignatureAlgorithm](#webserversslcertsignaturealgorithm-property-openid-component) | The text description of the certificate's signature algorithm. | | [WebServerSSLCertStore](#webserversslcertstore-property-openid-component) | The name of the certificate store for the client certificate. | | [WebServerSSLCertStorePassword](#webserversslcertstorepassword-property-openid-component) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [WebServerSSLCertStoreType](#webserversslcertstoretype-property-openid-component) | The type of certificate store for this certificate. | | [WebServerSSLCertSubjectAltNames](#webserversslcertsubjectaltnames-property-openid-component) | Comma-separated lists of alternative subject names for the certificate. | | [WebServerSSLCertThumbprintMD5](#webserversslcertthumbprintmd5-property-openid-component) | The MD5 hash of the certificate. | | [WebServerSSLCertThumbprintSHA1](#webserversslcertthumbprintsha1-property-openid-component) | The SHA-1 hash of the certificate. | | [WebServerSSLCertThumbprintSHA256](#webserversslcertthumbprintsha256-property-openid-component) | The SHA-256 hash of the certificate. | | [WebServerSSLCertUsage](#webserversslcertusage-property-openid-component) | The text description of UsageFlags . | | [WebServerSSLCertUsageFlags](#webserversslcertusageflags-property-openid-component) | The flags that show intended use for the certificate. | | [WebServerSSLCertVersion](#webserversslcertversion-property-openid-component) | The certificate's version number. | | [WebServerSSLCertSubject](#webserversslcertsubject-property-openid-component) | The subject of the certificate used for client authentication. | | [WebServerSSLCertEncoded](#webserversslcertencoded-property-openid-component) | The certificate (PEM/Base64 encoded). | | [WebServerSSLEnabled](#webserversslenabled-property-openid-component) | Whether the web server requires Secure Sockets Layer (SSL) connections. | ## Method List *The following is the full list of the methods of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AddCookie](#addcookie-method-openid-component) | Adds a cookie and the corresponding value to the outgoing request headers. | | [AddParam](#addparam-method-openid-component) | Adds a name-value pair to the query string parameters of the outgoing request. | | [Config](#config-method-openid-component) | Sets or retrieves a configuration setting. | | [DoEvents](#doevents-method-openid-component) | This method processes events from the internal message queue. | | [GetAuthorization](#getauthorization-method-openid-component) | Gets the authorization string required to access the protected resource. | | [GetAuthorizationURL](#getauthorizationurl-method-openid-component) | Builds and returns the URL to which the user should be redirected for authorization. | | [GetDiscoveryDoc](#getdiscoverydoc-method-openid-component) | Gets the OpenID Discovery Document. | | [GetParam](#getparam-method-openid-component) | Gets a specific parameter from a query string. | | [GetUserInfo](#getuserinfo-method-openid-component) | Retrieves claims about the user. | | [Interrupt](#interrupt-method-openid-component) | This method interrupts the current method. | | [Reset](#reset-method-openid-component) | This method will reset the class. | | [StartWebServer](#startwebserver-method-openid-component) | Starts the embedded web server. | | [StopWebServer](#stopwebserver-method-openid-component) | Stops the embedded web server. | ## Event List *The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Connected](#connected-event-openid-component) | Fired immediately after a connection completes (or fails). | | [ConnectionStatus](#connectionstatus-event-openid-component) | Fired to indicate changes in the connection state. | | [Disconnected](#disconnected-event-openid-component) | Fired when a connection is closed. | | [EndTransfer](#endtransfer-event-openid-component) | Fired when a document finishes transferring. | | [Error](#error-event-openid-component) | Fired when information is available about errors during data delivery. | | [Header](#header-event-openid-component) | Fired every time a header line comes in. | | [LaunchBrowser](#launchbrowser-event-openid-component) | Fires before launching a browser with the authorization URL. | | [Log](#log-event-openid-component) | Fired once for each log message. | | [Redirect](#redirect-event-openid-component) | Fired when a redirection is received from the server. | | [ReturnURL](#returnurl-event-openid-component) | Fired when the user is redirected to the embedded web server. | | [SetCookie](#setcookie-event-openid-component) | Fired for every cookie set by the server. | | [SSLServerAuthentication](#sslserverauthentication-event-openid-component) | Fired after the server presents its certificate to the client. | | [SSLStatus](#sslstatus-event-openid-component) | Fired when secure connection progress messages are available. | | [StartTransfer](#starttransfer-event-openid-component) | Fired when a document starts transferring (after the headers). | | [Status](#status-event-openid-component) | Fired when the HTTP status line is received from the server. | | [Transfer](#transfer-event-openid-component) | Fired while a document transfers (delivers document). | ## Config Settings *The following is a list of config settings for the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Display](#Display) | The requested display options to present to the end user. | | [IdToken](#IdToken) | The raw ID Token returned after authorization. | | [IdTokenHint](#IdTokenHint) | An ID Token value to be used as a hint about the user's session. | | [IdTokenValidationFlags](#IdTokenValidationFlags) | The checks that are ignored when validating an ID Token. | | [LoginHint](#LoginHint) | The login hint sent to the authorization server. | | [Nonce](#Nonce) | The nonce value that is used to verify an ID Token. | | [Prompt](#Prompt) | The requested conditions under which the authorization server prompts for login. | | [RawJSON](#RawJSON) | A JSON string holding the last response. | | [ResponseType](#ResponseType) | The value of the response_type request parameter. | | [UseNonce](#UseNonce) | Whether the Nonce parameter is added. | | [XChildCount](#XChildCount) | The number of child elements of the current element. | | [XChildName\[i\]](#XChildName[i]) | The name of the child element. | | [XChildXText\[i\]](#XChildXText[i]) | The inner text of the child element. | | [XElement](#XElement) | The name of the current element. | | [XParent](#XParent) | The parent of the current element. | | [XPath](#XPath) | Provides a way to point to a specific element in the returned XML or JSON response. | | [XSubTree](#XSubTree) | A snapshot of the current element in the document. | | [XText](#XText) | The text of the current element. | | [AuthMethod](#AuthMethod) | Specifies how the client credentials are sent to the token server. | | [AuthorizationTokenType](#AuthorizationTokenType) | The type of access token returned. | | [DeviceGrantType](#DeviceGrantType) | The grant type to be used when the ClientProfile is set to ocpDevice. | | [DeviceUserCode](#DeviceUserCode) | The device's user code when the ClientProfile is set to ocpDevice. | | [FormVarCount](#FormVarCount) | Specifies the number of additional form variables to include in the request. | | [FormVarName\[i\]](#FormVarName[i]) | Specifies the form variable name at the specified index. | | [FormVarValue\[i\]](#FormVarValue[i]) | Specifies the form variable value at the specified index. | | [IncludeClientCredsInBody](#IncludeClientCredsInBody) | Whether to include the client credentials in the header or request body. | | [IncludeEmptyRedirectURI](#IncludeEmptyRedirectURI) | Whether an empty redirect_uri parameter is included in requests. | | [JWTAudience](#JWTAudience) | The JWT audience when the ClientProfile is set to ocpJWT. | | [JWTCertStore](#JWTCertStore) | The name of the certificate store for the JWT signing certificate. | | [JWTCertStorePassword](#JWTCertStorePassword) | The JWT signing certificate password. | | [JWTCertStoreType](#JWTCertStoreType) | The type of certificate store. | | [JWTCertSubject](#JWTCertSubject) | The JWT signing certificate subject. | | [JWTIssuer](#JWTIssuer) | The JWT issuer when the ClientProfile is set to ocpJWT. | | [JWTJSONKey](#JWTJSONKey) | The data or file path of the JWT JSON Key. | | [JWTPayload](#JWTPayload) | The payload of the JWT access token, if present. | | [JWTServiceProvider](#JWTServiceProvider) | The service provider to which authentication is being performed. | | [JWTSignatureAlgorithm](#JWTSignatureAlgorithm) | The signature algorithm used to sign the JWT. | | [JWTSubject](#JWTSubject) | The subject field in the JWT. | | [JWTValidityTime](#JWTValidityTime) | The amount of time in seconds for which the assertion in the JWT is valid. | | [JWTXChildCount](#JWTXChildCount) | The number of child elements of the current element. | | [JWTXChildName\[i\]](#JWTXChildName[i]) | The name of the child element. | | [JWTXChildXText\[i\]](#JWTXChildXText[i]) | The inner text of the child element. | | [JWTXElement](#JWTXElement) | The name of the current element. | | [JWTXParent](#JWTXParent) | The parent of the current element. | | [JWTXPath](#JWTXPath) | Points to a specific element in the returned payload of a JWT based access token. | | [JWTXSubTree](#JWTXSubTree) | A snapshot of the current element in the document. | | [JWTXText](#JWTXText) | The text of the current element. | | [Microsoft365AdminConsentError](#Microsoft365AdminConsentError) | The error message returned when the admin denies consent to the scopes. | | [Microsoft365AdminConsentErrorDesc](#Microsoft365AdminConsentErrorDesc) | The error description returned when the admin denies consent to the scopes. | | [Microsoft365AdminConsentTenant](#Microsoft365AdminConsentTenant) | The tenant ID returned after the admin consents to the scopes. | | [Office365ServiceAPIVersion](#Office365ServiceAPIVersion) | The API version of the Office 365 service being discovered. | | [Office365ServiceCapability](#Office365ServiceCapability) | The API capability of the Office 365 service being discovered. | | [Office365ServiceEndpoint](#Office365ServiceEndpoint) | The Office 365 endpoint for the service that matches the criteria specified. | | [PasswordGrantUsername](#PasswordGrantUsername) | The Username field when using the password grant type. | | [PKCEChallengeEncoding](#PKCEChallengeEncoding) | The PKCE code challenge method to use. | | [PKCEVerifier](#PKCEVerifier) | The PKCE verifier used to generate the challenge. | | [PollingInterval](#PollingInterval) | The interval in seconds between polling requests when the device client profile is used. | | [ResponseMode](#ResponseMode) | The value of the response_mode parameter. | | [TokenInfoFieldCount](#TokenInfoFieldCount) | The number of fields in the tokeninfo service response. | | [TokenInfoFieldName\[i\]](#TokenInfoFieldName[i]) | The name of the tokeninfo service response field. | | [TokenInfoFieldValue\[i\]](#TokenInfoFieldValue[i]) | The value of the tokeninfo service response field. | | [TokenInfoURL](#TokenInfoURL) | The URL of the tokeninfo service. | | [ValidateToken](#ValidateToken) | Validates the specified access token with a tokeninfo service. | | [BrowserResponseTimeout](#BrowserResponseTimeout) | Specifies the amount of time to wait for a response from the browser. | | [ResponseCompanyImage](#ResponseCompanyImage) | A URL or full path to a company logo. | | [ResponseCompanyURL](#ResponseCompanyURL) | A URL to the company website or similar resource. | | [ResponseFailureHeading](#ResponseFailureHeading) | Short header text indicating failure. | | [ResponseFailureMessage](#ResponseFailureMessage) | A description for a failed authorization. | | [ResponseHelpURL](#ResponseHelpURL) | A URL to a help page or other resource. | | [ResponseLicenseURL](#ResponseLicenseURL) | A URL to licensing terms. | | [ResponseProductImage](#ResponseProductImage) | A URL or full path to a product image. | | [ResponseProductURL](#ResponseProductURL) | A URL to a product page or similar resource. | | [ResponseSuccessHeading](#ResponseSuccessHeading) | Short header text indicating success. | | [ResponseSuccessMessage](#ResponseSuccessMessage) | A description for a successful authorization. | | [WebServerFailedResponse](#WebServerFailedResponse) | The custom response that will be displayed to the user if authentication failed. | | [WebServerHost](#WebServerHost) | The hostname used by the embedded web server displayed in the ReturnURL. | | [WebServerResponse](#WebServerResponse) | The custom response that is displayed to the user. | | [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. | | [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. | | [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. | | [Append](#Append) | Whether to append data to LocalFile. | | [Authorization](#Authorization) | The Authorization string to be sent to the server. | | [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. | | [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. | | [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. | | [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the class. | | [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. | | [GetOn302Redirect](#GetOn302Redirect) | If set to True the class will perform a GET on the new location. | | [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. | | [HTTPVersion](#HTTPVersion) | The version of HTTP used by the class. | | [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. | | [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. | | [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. | | [LogLevel](#LogLevel) | The level of detail that is logged. | | [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. | | [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. | | [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). | | [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. | | [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. | | [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. | | [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). | | [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). | | [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. | | [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. | | [StatusCode](#StatusCode) | The status code of the last response from the server. | | [StatusLine](#StatusLine) | The first line of the last response from the server. | | [TransferredData](#TransferredData) | The contents of the last response from the server. | | [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the class. | | [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. | | [TransferredRequest](#TransferredRequest) | The full request as sent by the client. | | [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. | | [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. | | [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. | | [UserAgent](#UserAgent) | Information about the user agent (browser). | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [EnableFallback](#EnableFallback) | Whether to try the other addresses the remote host resolves to when a connection attempt fails. | | [FallbackTimeout](#FallbackTimeout) | The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the class whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the class binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # AccessToken Property ([OpenID](#openid-component) Component) The access token returned by the authorization server. ## Syntax *Go Syntax* ```text func (obj *OpenID) AccessToken() (string, error)func (obj *OpenID) SetAccessToken(value string) error ``` ## Default Value "" ## Remarks This property will be populated with the access token returned by the authorization server after a call to [GetAuthorization](#getauthorization-method-openid-component). This will be the raw access token, whereas the return value from the [GetAuthorization](#getauthorization-method-openid-component) method will also include the required data so that it can be passed directly to the *Authorization* property of other components or added as the value of the authorization header in another client implementation. ## Data Type **string** # AccessTokenExp Property ([OpenID](#openid-component) Component) The lifetime of the access token. ## Syntax *Go Syntax* ```text func (obj *OpenID) AccessTokenExp() (int32, error) ``` ## Default Value 0 ## Remarks This setting holds the lifetime of the access token in seconds. For instance the value *3600* indicates that the token will expire in one hour from the time it was generated. This property is read-only. ## Data Type **int32** # AuthorizationCode Property ([OpenID](#openid-component) Component) The authorization code that is exchanged for an access token. ## Syntax *Go Syntax* ```text func (obj *OpenID) AuthorizationCode() (string, error)func (obj *OpenID) SetAuthorizationCode(value string) error ``` ## Default Value "" ## Remarks This property is used with the AuthorizationCode [GrantType](#granttype-property-openid-component). When [ClientProfile](#clientprofile-property-openid-component) is set to ocpApplication (Application flow), this property will be informational only, as the [GetAuthorization](#getauthorization-method-openid-component) method will automatically exchange this code for a token with the authorization server specified in [ServerTokenURL](#servertokenurl-property-openid-component). When [ClientProfile](#clientprofile-property-openid-component) is set to ocpWeb (Web flow), this property needs to be set to the authorization code returned from the authorization server. Typically, this value is parsed when the service redirects the user back to your website. See [ClientProfile](#clientprofile-property-openid-component) for more information. If this property is set before calling [GetAuthorization](#getauthorization-method-openid-component), the struct will not make a request to the authorization sever and instead will attempt to exchange the code with the authorization server for an access token. ## Data Type **string** # AuthorizationScope Property ([OpenID](#openid-component) Component) The authorization scope used during authorization. ## Syntax *Go Syntax* ```text func (obj *OpenID) AuthorizationScope() (string, error)func (obj *OpenID) SetAuthorizationScope(value string) error ``` ## Default Value "openid" ## Remarks This property specifies the authorization scopes sent in the authorization request. The value specified here must be a space separated list of scopes. For instance *openid profile email*. The *openid* scope is always required to be present. The default value is *openid*. After calling [GetAuthorization](#getauthorization-method-openid-component) this property will be updated with the scope sent in the response from the server and will indicate the scope that was actually granted. ## Data Type **string** # ClientId Property ([OpenID](#openid-component) Component) The Id of the client assigned when registering the application. ## Syntax *Go Syntax* ```text func (obj *OpenID) ClientId() (string, error)func (obj *OpenID) SetClientId(value string) error ``` ## Default Value "" ## Remarks This property holds the Id of the client that was assigned when initially registering the application with the authorization server. This value must be specified before calling [GetAuthorization](#getauthorization-method-openid-component) or [GetAuthorizationURL](#getauthorizationurl-method-openid-component). ## Data Type **string** # ClientProfile Property ([OpenID](#openid-component) Component) The type of client that is requesting authorization. ## Syntax *Go Syntax* ```text func (obj *OpenID) ClientProfile() (int32, error)func (obj *OpenID) SetClientProfile(value int32) error ``` ## Possible Values ```text 0 // Application1 // Web2 // Device3 // Mobile4 // JWT ``` ## Default Value 0 ## Remarks This defines the type of client that will be requesting authorization. Set this before calling [GetAuthorization](#getauthorization-method-openid-component) to inform the struct to act accordingly. Possible values are as follows: | | | | --- | --- | | 0 (ocpApplication - default) | User application, such as a Windows form application | | 1 (ocpWeb) | Server-side application, such as a website | | 2 (ocpDevice) | Device application without a browser, such as a game console | | 3 (ocpMobile) | Mobile application with browser support, such as a smart phone or tablet | | 4 (ocpJWT) | Server-to-Server authentication using a JWT Bearer Token | ## Application Profile The Application profile is applicable to applications that are run directly by the user. For instance, a Windows form application would use the Application profile. To authorize your application (client) using the Application profile, use the following steps: First, set ClientProfile to ocpApplication. This defines the profile the struct will use. Set the [ClientId](#clientid-property-openid-component), [ClientSecret](#clientsecret-property-openid-component), [ServerAuthURL](#serverauthurl-property-openid-component), and [ServerTokenURL](#servertokenurl-property-openid-component) to the values you obtained when registering your application. Second, call [GetAuthorization](#getauthorization-method-openid-component) to begin the authorization process. When [GetAuthorization](#getauthorization-method-openid-component) is called, the struct will build the URL to which the user will be directed and fire the [LaunchBrowser](#launchbrowser-event-openid-component) event. The struct will then launch the browser using the command and URL shown in the [LaunchBrowser](#launchbrowser-event-openid-component) event and await the response. The duration for which the struct will wait for a response is defined by [BrowserResponseTimeout](#BrowserResponseTimeout). Third, the user will interact with the browser to authenticate and grant access to the connecting application. The user will then be redirected back to an embedded web server that was automatically started when [GetAuthorization](#getauthorization-method-openid-component) was called. At this time, the [ReturnURL](#returnurl-event-openid-component) event will fire. This event provides an opportunity to provide a custom response to your user that they will see in their browser. Fourth, the struct will then automatically exchange the grant that was returned by the authorization server for the access token using the HTTP endpoint specified in [ServerTokenURL](#servertokenurl-property-openid-component). The authorization is now complete and the [GetAuthorization](#getauthorization-method-openid-component) method will return the authorization string. The authorization string can then be used with any of our components by simply setting the returned value to the authorization property before making a request. The following is a simple example: ```text component.ClientId = "CLIENT_ID"; component.ClientSecret = "CLIENT_ID"; component.ServerAuthURL = "https://accounts.google.com/o/oauth2/auth"; component.ServerTokenURL = "https://accounts.google.com/o/oauth2/token"; HTTP.Authorization = component.GetAuthorization(); HTTP.Get("https://www.googleapis.com/oauth2/v1/userinfo"); ``` ## Web Profile The Web profile is applicable to applications that are run on the server side when the user uses the application from a web browser. To authorize your application (client) using this profile, use the following steps: First, set ClientProfile to ocpWeb. This defines the profile the component will use. Set the [ClientId](#clientid-property-openid-component), [ClientSecret](#clientsecret-property-openid-component), [ServerAuthURL](#serverauthurl-property-openid-component), and [ServerTokenURL](#servertokenurl-property-openid-component) to the values you obtained when registering your application. Set [ReturnURL](#returnurl-property-openid-component) to the page on your site that will be the endpoint the user is redirected back to after authentication. Second, call [GetAuthorizationURL](#getauthorizationurl-method-openid-component). This will return a URL to which the user should be redirected. Redirect the user to this URL. Third, after the user authenticates and is returned to the page on your site specified by [ReturnURL](#returnurl-property-openid-component), parse the "code" query string parameter from the incoming request to get the authorization code from the authorization server. Then, set [AuthorizationCode](#authorizationcode-property-openid-component) property to the parsed value. Fourth, after [AuthorizationCode](#authorizationcode-property-openid-component) is set, call [GetAuthorization](#getauthorization-method-openid-component) to exchange the code specified in [AuthorizationCode](#authorizationcode-property-openid-component) for a token from the server specified by [ServerTokenURL](#servertokenurl-property-openid-component). [GetAuthorization](#getauthorization-method-openid-component) will then return the authorization string. The authorization string can be used with any of our components by simply setting the returned value to the authorization property before making a request. ## Device Profile The Device profile is applicable to applications that are run on devices for which a web browser cannot be used. For example, a game console would use the Device profile. To authorize your application (client) using the device client profile use the following steps: First, set ClientProfile to ocpDevice. This defines the profile the struct will use. Set the [ClientId](#clientid-property-openid-component), [ClientSecret](#clientsecret-property-openid-component), [ServerAuthURL](#serverauthurl-property-openid-component), and [ServerTokenURL](#servertokenurl-property-openid-component) to the values you obtained when registering your application. Do not set [ReturnURL](#returnurl-property-openid-component). Second, call [GetAuthorizationURL](#getauthorizationurl-method-openid-component). The struct will automatically make a request to [ServerAuthURL](#serverauthurl-property-openid-component) to obtain a user code for the device. The [GetAuthorizationURL](#getauthorizationurl-method-openid-component) method will return the URL your user must visit from another device or computer that has web browser support. The [GetAuthorizationURL](#getauthorizationurl-method-openid-component) method will also populate [DeviceUserCode](#DeviceUserCode). This device user code must be provided to the user. The user will enter the code at the URL returned by [GetAuthorizationURL](#getauthorizationurl-method-openid-component). Third, at this time, call [GetAuthorization](#getauthorization-method-openid-component). The struct will begin polling the server specified in [ServerTokenURL](#servertokenurl-property-openid-component). The polling interval is specified (in seconds) by the [PollingInterval](#PollingInterval) setting. Fourth, after the user has authenticated, the [GetAuthorization](#getauthorization-method-openid-component) method will return the authorization string. To use the authorization string with any of our components, simply pass this value to the authorization property before making the request. ## Mobile Profile The Mobile profile is applicable to applications that are run on devices for which a web browser can be used. For instance, a mobile phone or tablet would use the Mobile profile. The behavior when using this profile is very similar to the Application profile. The only difference between the Mobile and Application profiles is the way the browser is launched. When set to the Mobile profile, the [LaunchBrowser](#launchbrowser-event-openid-component) event will fire but the struct will not attempt to launch the browser automatically. The browser must be launched manually from code. This behavior is the only difference between the Mobile and Application profiles. Please read the steps for the Application profile for a more detailed look at the process. ## JWT Bearer Token (Server-to-Server) Profile The JWT (JSON Web Token) Bearer Token profile is available for server-to-server authentication. For instance this may be used by web applications to access a Google service. In this case, the application will access data on behalf of the service account, not the end user. End-user interaction is not required. First, specify [AuthorizationScope](#authorizationscope-property-openid-component) [ServerTokenURL](#servertokenurl-property-openid-component) and [JWTServiceProvider](#JWTServiceProvider). Second, specify JWT-specific values. The use of the JWT profile also requires additional configuration settings to be specified, including a certificate with private key used to sign the JWT. Either specify the [JWTJSONKey](#JWTJSONKey) configuration setting, which will parse the necessary information automatically, or manually specify the following configuration settings: - [JWTIssuer](#JWTIssuer) (required) - [JWTAudience](#JWTAudience) (required) - [JWTCertStoreType](#JWTCertStoreType) (required) - [JWTCertStore](#JWTCertStore) (required) - [JWTCertStorePassword](#JWTCertStorePassword) (required) - [JWTCertSubject](#JWTCertSubject) (required) - [JWTSubject](#JWTSubject) - [JWTValidityTime](#JWTValidityTime) - [JWTSignatureAlgorithm](#JWTSignatureAlgorithm) Additional fields may be added to the JWT using the [AddParam](#addparam-method-openid-component) method. **Example 1. Google:** ```text oauth.AuthorizationScope = "https://www.googleapis.com/auth/analytics"; oauth.ServerTokenURL = "https://www.googleapis.com/oauth2/v3/token"; oauth.ClientProfile = OauthClientProfiles.ocpJWT; oauth.Config("JWTServiceProvider=0"); oauth.Config("JWTIssuer=CLIENT_ID"); oauth.Config("JWTAudience=https://www.googleapis.com/oauth2/v3/token"); oauth.Config("JWTCertStoreType=2"); oauth.Config("JWTCertStore=C:\\MyCertificate.p12"); oauth.Config("JWTCertStorePassword=password"); oauth.Config("JWTCertSubject=*"); oauth.Config("JWTValidityTime=5400"); //in seconds string authStr = oauth.GetAuthorization(); ``` **Example 2. Microsoft:** ```text oauth.ClientId = "Client_Id"; oauth.ClientProfile = OauthClientProfiles.ocpJWT; oauth.AuthorizationScope = "https://graph.microsoft.com/.default"; oauth.ServerTokenURL = "https://login.microsoftonline.com/" + tenant_id + "/oauth2/V2.0/token"; oauth.Config("JWTServiceProvider=1"); oauth.Config("JWTIssuer=" + CLIENT_ID); oauth.Config("JWTSubject=" + CLIENT_ID); oauth.Config("JWTCertStoreType=2"); oauth.Config("JWTCertStore=C:\\MyCertificate.p12"); oauth.Config("JWTCertStorePassword=password"); oauth.Config("JWTCertSubject=*"); oauth.Config("JWTValidityTime=3600"); oauth.Config("JWTAudience=https://login.microsoftonline.com/"+ tenant_id + "/oauth2/V2.0/token"); string authStr = oauth.GetAuthorization(); ``` ## Data Type **int32** # ClientSecret Property ([OpenID](#openid-component) Component) The secret value for the client assigned when registering the application. ## Syntax *Go Syntax* ```text func (obj *OpenID) ClientSecret() (string, error)func (obj *OpenID) SetClientSecret(value string) error ``` ## Default Value "" ## Remarks This property holds the secret of the client that was assigned when initially registering the application with the authorization server. This value must be specified before calling [GetAuthorization](#getauthorization-method-openid-component) or [GetAuthorizationURL](#getauthorizationurl-method-openid-component). ## Data Type **string** # Connected Property ([OpenID](#openid-component) Component) Whether the class is connected. ## Syntax *Go Syntax* ```text func (obj *OpenID) Connected() (bool, error) ``` ## Default Value false ## Remarks This property is used to determine whether or not the struct is connected to the remote host. Use the Connect and Disconnect methods to manage the connection. This property is read-only. ## Data Type **bool** # CookieCount Property ([OpenID](#openid-component) Component) The number of records in the Cookie arrays. ## Syntax *Go Syntax* ```text func (obj *OpenID) CookieCount() (int32, error)func (obj *OpenID) SetCookieCount(value int32) error ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [CookieDomain](#cookiedomain-property-openid-component) - [CookieExpiration](#cookieexpiration-property-openid-component) - [CookieName](#cookiename-property-openid-component) - [CookiePath](#cookiepath-property-openid-component) - [CookieSecure](#cookiesecure-property-openid-component) - [CookieValue](#cookievalue-property-openid-component) The array indices start at *0* and end at *CookieCount - 1*. ## Data Type **int32** # CookieDomain Property ([OpenID](#openid-component) Component) The domain of a received cookie. ## Syntax *Go Syntax* ```text func (obj *OpenID) CookieDomain(CookieIndex int32) (string, error) ``` ## Default Value "" ## Remarks The domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by URLServer as the cookie domain. The *CookieIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CookieCount](#cookiecount-property-openid-component) property. This property is read-only. ## Data Type **string** # CookieExpiration Property ([OpenID](#openid-component) Component) An expiration time for the cookie (if provided by the server). ## Syntax *Go Syntax* ```text func (obj *OpenID) CookieExpiration(CookieIndex int32) (string, error) ``` ## Default Value "" ## Remarks An expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session. The *CookieIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CookieCount](#cookiecount-property-openid-component) property. This property is read-only. ## Data Type **string** # CookieName Property ([OpenID](#openid-component) Component) The name of the cookie. ## Syntax *Go Syntax* ```text func (obj *OpenID) CookieName(CookieIndex int32) (string, error)func (obj *OpenID) SetCookieName(CookieIndex int32, value string) error ``` ## Default Value "" ## Remarks The name of the cookie. This property, along with [CookieValue](#cookievalue-property-openid-component), stores the cookie that is to be sent to the server. The SetCookie event displays the cookies sent by the server and their properties. The *CookieIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CookieCount](#cookiecount-property-openid-component) property. ## Data Type **string** # CookiePath Property ([OpenID](#openid-component) Component) A path name to limit the cookie to (if provided by the server). ## Syntax *Go Syntax* ```text func (obj *OpenID) CookiePath(CookieIndex int32) (string, error) ``` ## Default Value "" ## Remarks A path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path property will be an empty string. The convention in this case is to use the path specified by URLPath as the cookie path. The *CookieIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CookieCount](#cookiecount-property-openid-component) property. This property is read-only. ## Data Type **string** # CookieSecure Property ([OpenID](#openid-component) Component) The security flag of the received cookie. ## Syntax *Go Syntax* ```text func (obj *OpenID) CookieSecure(CookieIndex int32) (bool, error) ``` ## Default Value false ## Remarks The security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection. The *CookieIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CookieCount](#cookiecount-property-openid-component) property. This property is read-only. ## Data Type **bool** # CookieValue Property ([OpenID](#openid-component) Component) The value of the cookie. ## Syntax *Go Syntax* ```text func (obj *OpenID) CookieValue(CookieIndex int32) (string, error)func (obj *OpenID) SetCookieValue(CookieIndex int32, value string) error ``` ## Default Value "" ## Remarks The value of the cookie. A corresponding value is associated with the cookie specified by [CookieName](#cookiename-property-openid-component). This property holds that value. The SetCookie event provides the cookies set by the server. The *CookieIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CookieCount](#cookiecount-property-openid-component) property. ## Data Type **string** # DiscoveryDocDetailsAuthorizationURL Property ([OpenID](#openid-component) Component) The server authorization endpoint URL. ## Syntax *Go Syntax* ```text func (obj *OpenID) DiscoveryDocDetailsAuthorizationURL() (string, error) ``` ## Default Value "" ## Remarks The server authorization endpoint URL. This setting corresponds to the *authorization_endpoint* parameter in the discovery document. This property is read-only. ## Data Type **string** # DiscoveryDocDetailsClaimsParamSupported Property ([OpenID](#openid-component) Component) Whether the claims request parameter is supported by the Open ID provider. ## Syntax *Go Syntax* ```text func (obj *OpenID) DiscoveryDocDetailsClaimsParamSupported() (bool, error) ``` ## Default Value false ## Remarks Whether the *claims* request parameter is supported by the Open ID provider. This setting corresponds to the *claims_parameter_supported* parameter in the discovery document. This property is read-only. ## Data Type **bool** # DiscoveryDocDetailsContent Property ([OpenID](#openid-component) Component) The raw discovery document JSON. ## Syntax *Go Syntax* ```text func (obj *OpenID) DiscoveryDocDetailsContent() (string, error) ``` ## Default Value "" ## Remarks The raw discovery document JSON. This property is read-only. ## Data Type **string** # DiscoveryDocDetailsIssuer Property ([OpenID](#openid-component) Component) The issuer identifier of the OpenID provider. ## Syntax *Go Syntax* ```text func (obj *OpenID) DiscoveryDocDetailsIssuer() (string, error) ``` ## Default Value "" ## Remarks The issuer identifier of the OpenID provider. This value is the same as the *iss* claim returned in ID Tokens issued from this provider. The value is a URL with the https scheme with no query string or fragment component. This setting corresponds to the *issuer* parameter in the discovery document. This property is read-only. ## Data Type **string** # DiscoveryDocDetailsLogoutURL Property ([OpenID](#openid-component) Component) The logout endpoint URL. ## Syntax *Go Syntax* ```text func (obj *OpenID) DiscoveryDocDetailsLogoutURL() (string, error) ``` ## Default Value "" ## Remarks The logout endpoint URL. This setting corresponds to the optional *end_session_endpoint* parameter that may be found in the discovery document. If a user is directed to this URL, they will be asked to log out of their account. This property is read-only. ## Data Type **string** # DiscoveryDocDetailsRegistrationURL Property ([OpenID](#openid-component) Component) The dynamic client registration URL. ## Syntax *Go Syntax* ```text func (obj *OpenID) DiscoveryDocDetailsRegistrationURL() (string, error) ``` ## Default Value "" ## Remarks The dynamic client registration URL. This setting corresponds to the *registration_endpoint* parameter in the discovery document. This property is read-only. ## Data Type **string** # DiscoveryDocDetailsServiceDocsURL Property ([OpenID](#openid-component) Component) The URL of the human-readable service documentation. ## Syntax *Go Syntax* ```text func (obj *OpenID) DiscoveryDocDetailsServiceDocsURL() (string, error) ``` ## Default Value "" ## Remarks The URL of the human-readable service documentation. The information at this URL is intended for developers integrating with the OpenID provider and may contain useful information. This setting corresponds to the *service_documentation* parameter in the discovery document. This property is read-only. ## Data Type **string** # DiscoveryDocDetailsSignerCertURL Property ([OpenID](#openid-component) Component) The URL of the JSON Web Key Set used to verify signatures on values returned by the OpenID provider. ## Syntax *Go Syntax* ```text func (obj *OpenID) DiscoveryDocDetailsSignerCertURL() (string, error) ``` ## Default Value "" ## Remarks The URL of the JSON Web Key Set used to verify signatures on values returned by the OpenID provider. The signer keys are automatically retrieved by the struct when the ID Token signature verification is performed. This setting corresponds to the *jwks_uri* parameter in the discovery document. This property is read-only. ## Data Type **string** # DiscoveryDocDetailsSupportedClaims Property ([OpenID](#openid-component) Component) A comma-separated list of claims that are supported by the OpenID provider. ## Syntax *Go Syntax* ```text func (obj *OpenID) DiscoveryDocDetailsSupportedClaims() (string, error) ``` ## Default Value "" ## Remarks A comma-separated list of claims that are supported by the OpenID provider. For instance: *aud,email,email_verified,exp,family_name,given_name,iat,iss,locale,name,picture,sub* This setting corresponds to the *claims_supported* parameter in the discovery document. This property is read-only. ## Data Type **string** # DiscoveryDocDetailsSupportedDisplays Property ([OpenID](#openid-component) Component) A comma-separated list of display values that are supported by the OpenID provider. ## Syntax *Go Syntax* ```text func (obj *OpenID) DiscoveryDocDetailsSupportedDisplays() (string, error) ``` ## Default Value "" ## Remarks A comma-separated list of display values that are supported by the OpenID provider. This setting corresponds to the *display_values_supported* parameter in the discovery document. This property is read-only. ## Data Type **string** # DiscoveryDocDetailsSupportedGrantTypes Property ([OpenID](#openid-component) Component) A comma-separated list of grant types supported by the OpenID provider. ## Syntax *Go Syntax* ```text func (obj *OpenID) DiscoveryDocDetailsSupportedGrantTypes() (string, error) ``` ## Default Value "" ## Remarks A comma-separated list of grant types supported by the OpenID provider. If this value is not specified by the OpenID provider, it is specified that *authorization_code* and *implicit* are supported by the OpenID provider. This setting corresponds to the *grant_types_supported* parameter in the discovery document. This property is read-only. ## Data Type **string** # DiscoveryDocDetailsSupportedResponseTypes Property ([OpenID](#openid-component) Component) A comma-separated list of response types supported by the OpenID provider. ## Syntax *Go Syntax* ```text func (obj *OpenID) DiscoveryDocDetailsSupportedResponseTypes() (string, error) ``` ## Default Value "" ## Remarks A comma-separated list of response types supported by the OpenID provider. If this value is not specified by the OpenID provider, it is defined that the OpenID provider supports (at a minimum) the *code*, *id_token*, and *token id_token* values. This setting corresponds to the *response_types_supported* parameter in the discovery document. This property is read-only. ## Data Type **string** # DiscoveryDocDetailsSupportedScopes Property ([OpenID](#openid-component) Component) A comma-separated list of scopes that are supported by the OpenID provider. ## Syntax *Go Syntax* ```text func (obj *OpenID) DiscoveryDocDetailsSupportedScopes() (string, error) ``` ## Default Value "" ## Remarks A comma-separated list of scopes that are supported by the OpenID provider. For instance: *openid,email,profile* This setting corresponds to the *scopes_supported* parameter in the discovery document. This property is read-only. ## Data Type **string** # DiscoveryDocDetailsTokenURL Property ([OpenID](#openid-component) Component) The token endpoint URL. ## Syntax *Go Syntax* ```text func (obj *OpenID) DiscoveryDocDetailsTokenURL() (string, error) ``` ## Default Value "" ## Remarks The token endpoint URL. This setting corresponds to the *token_endpoint* parameter in the discovery document. This property is read-only. ## Data Type **string** # DiscoveryDocDetailsUserInfoURL Property ([OpenID](#openid-component) Component) The user info endpoint URL. ## Syntax *Go Syntax* ```text func (obj *OpenID) DiscoveryDocDetailsUserInfoURL() (string, error) ``` ## Default Value "" ## Remarks The user info endpoint URL. This setting corresponds to the *userinfo_endpoint* parameter in the discovery document. This property is read-only. ## Data Type **string** # FirewallAutoDetect Property ([OpenID](#openid-component) Component) Whether to automatically detect and use firewall system settings, if available. ## Syntax *Go Syntax* ```text func (obj *OpenID) FirewallAutoDetect() (bool, error)func (obj *OpenID) SetFirewallAutoDetect(value bool) error ``` ## Default Value false ## Remarks Whether to automatically detect and use firewall system settings, if available. ## Data Type **bool** # FirewallType Property ([OpenID](#openid-component) Component) The type of firewall to connect through. ## Syntax *Go Syntax* ```text func (obj *OpenID) FirewallType() (int32, error)func (obj *OpenID) SetFirewallType(value int32) error ``` ## Possible Values ```text 0 // None1 // Tunnel2 // SOCKS43 // SOCKS510 // SOCKS4A ``` ## Default Value 0 ## Remarks The type of firewall to connect through. The applicable values are as follows: | | | | --- | --- | | fwNone (0) | No firewall (default setting). | | fwTunnel (1) | Connect through a tunneling proxy. [FirewallPort](#firewallport-property-openid-component) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [FirewallPort](#firewallport-property-openid-component) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [FirewallPort](#firewallport-property-openid-component) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [FirewallPort](#firewallport-property-openid-component) is set to 1080. | ## Data Type **int32** # FirewallHost Property ([OpenID](#openid-component) Component) The name or IP address of the firewall (optional). ## Syntax *Go Syntax* ```text func (obj *OpenID) FirewallHost() (string, error)func (obj *OpenID) SetFirewallHost(value string) error ``` ## Default Value "" ## Remarks The name or IP address of the firewall (optional). If a [FirewallHost](#firewallhost-property-openid-component) is given, the requested connections will be authenticated through the specified firewall when connecting. If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the struct fails with an error. ## Data Type **string** # FirewallPassword Property ([OpenID](#openid-component) Component) A password if authentication is to be used when connecting through the firewall. ## Syntax *Go Syntax* ```text func (obj *OpenID) FirewallPassword() (string, error)func (obj *OpenID) SetFirewallPassword(value string) error ``` ## Default Value "" ## Remarks A password if authentication is to be used when connecting through the firewall. If [FirewallHost](#firewallhost-property-openid-component) is specified, the [FirewallUser](#firewalluser-property-openid-component) and [FirewallPassword](#firewallpassword-property-openid-component) properties are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error. ## Data Type **string** # FirewallPort Property ([OpenID](#openid-component) Component) The Transmission Control Protocol (TCP) port for the firewall Host . ## Syntax *Go Syntax* ```text func (obj *OpenID) FirewallPort() (int32, error)func (obj *OpenID) SetFirewallPort(value int32) error ``` ## Default Value 0 ## Remarks The Transmission Control Protocol (TCP) port for the firewall [FirewallHost](#firewallhost-property-openid-component). See the description of the [FirewallHost](#firewallhost-property-openid-component) property for details. NOTE: This property is set automatically when [FirewallType](#firewalltype-property-openid-component) is set to a valid value. See the description of the [FirewallType](#firewalltype-property-openid-component) property for details. ## Data Type **int32** # FirewallUser Property ([OpenID](#openid-component) Component) A username if authentication is to be used when connecting through a firewall. ## Syntax *Go Syntax* ```text func (obj *OpenID) FirewallUser() (string, error)func (obj *OpenID) SetFirewallUser(value string) error ``` ## Default Value "" ## Remarks A username if authentication is to be used when connecting through a firewall. If [FirewallHost](#firewallhost-property-openid-component) is specified, this property and the [FirewallPassword](#firewallpassword-property-openid-component) property are used to connect and authenticate to the given [Firewall](#Type_Firewall). If the authentication fails, the struct fails with an error. ## Data Type **string** # FollowRedirects Property ([OpenID](#openid-component) Component) Determines what happens when the server issues a redirect. ## Syntax *Go Syntax* ```text func (obj *OpenID) FollowRedirects() (int32, error)func (obj *OpenID) SetFollowRedirects(value int32) error ``` ## Possible Values ```text 0 // Never1 // Always2 // SameScheme ``` ## Default Value 0 ## Remarks This property determines what happens when the server issues a redirect. Normally, the struct returns an error if the server responds with an "Object Moved" message. If this property is set to frAlways (1), the new URL for the object is retrieved automatically every time. If this property is set to frSameScheme (2), the new URL is retrieved automatically only if the URLScheme is the same; otherwise, the struct fails with an error. NOTE: Following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for *GET* or *HEAD* requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities. Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty. If, however, this property is set to frAlways (1), the same credentials are used to connect to the new server. A [Redirect](#redirect-event-openid-component) event is fired for every URL the product is redirected to. In the case of automatic redirections, the [Redirect](#redirect-event-openid-component) event is a good place to set properties related to the new connection (e.g., new authentication parameters). The default value is frNever (0). In this case, redirects are never followed, and the struct fails with an error instead. ## Data Type **int32** # GrantType Property ([OpenID](#openid-component) Component) The grant type defining the authentication flow. ## Syntax *Go Syntax* ```text func (obj *OpenID) GrantType() (int32, error)func (obj *OpenID) SetGrantType(value int32) error ``` ## Possible Values ```text 0 // AuthorizationCode1 // Implicit2 // Hybrid ``` ## Default Value 0 ## Remarks This property defines the grant type used when performing authentication. The value specified here controls the authentication flow. Possible values for GrantType are: - 0 (Authorization Code - Default) - 1 (Implicit) - 2 (Hybrid) When using *0* (Authorization Code Flow - Default), an authorization code is returned from the [ServerAuthURL](#serverauthurl-property-openid-component) and the struct automatically contacts the [ServerTokenURL](#servertokenurl-property-openid-component) and exchanges the authorization code for an ID Token and access token. When using *1* (Implicit Flow), the [ServerAuthURL](#serverauthurl-property-openid-component) returns an ID Token and access token directly. This is only recommended for implementations that are in-browser, as this potentially exposes the tokens to the end-user and user agent itself. When using *2* (Hybrid Flow), an authorization code and potentially one or more tokens are returned by the [ServerAuthURL](#serverauthurl-property-openid-component). The struct will automatically contact the [ServerTokenURL](#servertokenurl-property-openid-component) to exchange the authorization code for an ID Token and access token. **Additional Notes** The *response_type* request parameter is automatically set based on the value specified here. In some cases multiple values are acceptable and a default value is chosen automatically. To explicitly specify a *response_type* value for the chosen grant type set [ResponseType](#ResponseType) after setting this property. ## Data Type **int32** # Idle Property ([OpenID](#openid-component) Component) The current status of the class. ## Syntax *Go Syntax* ```text func (obj *OpenID) Idle() (bool, error) ``` ## Default Value true ## Remarks This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times. This property is read-only. ## Data Type **bool** # IdTokenAudiences Property ([OpenID](#openid-component) Component) A comma-separated list of audiences for which the ID Token is intended. ## Syntax *Go Syntax* ```text func (obj *OpenID) IdTokenAudiences() (string, error) ``` ## Default Value "" ## Remarks A comma-separated list of audiences for which the ID Token is intended. This property is read-only. ## Data Type **string** # IdTokenAuthTime Property ([OpenID](#openid-component) Component) The time when the end user authenticates with the authorization server. ## Syntax *Go Syntax* ```text func (obj *OpenID) IdTokenAuthTime() (int64, error) ``` ## Default Value 0 ## Remarks The time when the end user authenticates with the authorization server. The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time. This property is read-only. ## Data Type **int64** # IdTokenExpTime Property ([OpenID](#openid-component) Component) The time when the ID Token expires. ## Syntax *Go Syntax* ```text func (obj *OpenID) IdTokenExpTime() (int64, error) ``` ## Default Value 0 ## Remarks The time when the ID Token expires. The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time. This property is read-only. ## Data Type **int64** # IdTokenContent Property ([OpenID](#openid-component) Component) The raw value of the ID Token. ## Syntax *Go Syntax* ```text func (obj *OpenID) IdTokenContent() (string, error)func (obj *OpenID) SetIdTokenContent(value string) error ``` ## Default Value "" ## Remarks The raw value of the ID Token. ## Data Type **string** # IdTokenIssuedTime Property ([OpenID](#openid-component) Component) The time when the authentication for this ID Token occurred. ## Syntax *Go Syntax* ```text func (obj *OpenID) IdTokenIssuedTime() (int64, error) ``` ## Default Value 0 ## Remarks The time when the authentication for this ID Token occurred. The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time. This property is read-only. ## Data Type **int64** # IdTokenIssuer Property ([OpenID](#openid-component) Component) The issuer, or authorization server, that constructed the ID Token. ## Syntax *Go Syntax* ```text func (obj *OpenID) IdTokenIssuer() (string, error) ``` ## Default Value "" ## Remarks The issuer, or authorization server, that constructed the ID Token. This property is read-only. ## Data Type **string** # LocalHost Property ([OpenID](#openid-component) Component) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax *Go Syntax* ```text func (obj *OpenID) LocalHost() (string, error)func (obj *OpenID) SetLocalHost(value string) error ``` ## Default Value "" ## Remarks This property contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used. If the struct is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window. ## Data Type **string** # OtherHeaders Property ([OpenID](#openid-component) Component) Other headers as determined by the user (optional). ## Syntax *Go Syntax* ```text func (obj *OpenID) OtherHeaders() (string, error)func (obj *OpenID) SetOtherHeaders(value string) error ``` ## Default Value "" ## Remarks This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From. The headers must follow the format *Header: Value* as described in the HTTP specifications. Header lines should be separated by CRLF (*"\r\n"*) . Use this property with caution. If this property contains invalid headers, HTTP requests may fail. This property is useful for extending the functionality of the struct beyond what is provided. ## Data Type **string** # ParamCount Property ([OpenID](#openid-component) Component) The number of records in the Param arrays. ## Syntax *Go Syntax* ```text func (obj *OpenID) ParamCount() (int32, error)func (obj *OpenID) SetParamCount(value int32) error ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [ParamName](#paramname-property-openid-component) - [ParamValue](#paramvalue-property-openid-component) The array indices start at *0* and end at *ParamCount - 1*. ## Data Type **int32** # ParamName Property ([OpenID](#openid-component) Component) The name of the parameter to be used in the request or returned in the response. ## Syntax *Go Syntax* ```text func (obj *OpenID) ParamName(ParamIndex int32) (string, error)func (obj *OpenID) SetParamName(ParamIndex int32, value string) error ``` ## Default Value "" ## Remarks The name of the parameter to be used in the request or returned in the response. The *ParamIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ParamCount](#paramcount-property-openid-component) property. ## Data Type **string** # ParamValue Property ([OpenID](#openid-component) Component) The value of the parameter to be used in the request or returned in the response. ## Syntax *Go Syntax* ```text func (obj *OpenID) ParamValue(ParamIndex int32) (string, error)func (obj *OpenID) SetParamValue(ParamIndex int32, value string) error ``` ## Default Value "" ## Remarks The value of the parameter to be used in the request or returned in the response. When issuing a request, the struct will URL encode the value specified here. Returned values will be automatically URL decoded. The *ParamIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ParamCount](#paramcount-property-openid-component) property. ## Data Type **string** # ProxyAuthScheme Property ([OpenID](#openid-component) Component) The type of authorization to perform when connecting to the proxy. ## Syntax *Go Syntax* ```text func (obj *OpenID) ProxyAuthScheme() (int32, error)func (obj *OpenID) SetProxyAuthScheme(value int32) error ``` ## Possible Values ```text 0 // Basic1 // Digest2 // Proprietary3 // None4 // Ntlm5 // Negotiate ``` ## Default Value 0 ## Remarks The type of authorization to perform when connecting to the proxy. This is used only when the [ProxyUser](#proxyuser-property-openid-component) and [ProxyPassword](#proxypassword-property-openid-component) properties are set. [ProxyAuthScheme](#proxyauthscheme-property-openid-component) should be set to authNone (3) when no authentication is expected. By default, [ProxyAuthScheme](#proxyauthscheme-property-openid-component) is authBasic (0), and if the [ProxyUser](#proxyuser-property-openid-component) and [ProxyPassword](#proxypassword-property-openid-component) properties are set, the struct will attempt basic authentication. If [ProxyAuthScheme](#proxyauthscheme-property-openid-component) is set to authDigest (1), digest authentication will be attempted instead. If [ProxyAuthScheme](#proxyauthscheme-property-openid-component) is set to authProprietary (2), then the authorization token will not be generated by the struct. Look at the configuration file for the struct being used to find more information about manually setting this token. If [ProxyAuthScheme](#proxyauthscheme-property-openid-component) is set to authNtlm (4), NTLM authentication will be used. For security reasons, setting this property will clear the values of [ProxyUser](#proxyuser-property-openid-component) and [ProxyPassword](#proxypassword-property-openid-component). ## Data Type **int32** # ProxyAutoDetect Property ([OpenID](#openid-component) Component) Whether to automatically detect and use proxy system settings, if available. ## Syntax *Go Syntax* ```text func (obj *OpenID) ProxyAutoDetect() (bool, error)func (obj *OpenID) SetProxyAutoDetect(value bool) error ``` ## Default Value false ## Remarks Whether to automatically detect and use proxy system settings, if available. The default value is *false*. ## Data Type **bool** # ProxyPassword Property ([OpenID](#openid-component) Component) A password if authentication is to be used for the proxy. ## Syntax *Go Syntax* ```text func (obj *OpenID) ProxyPassword() (string, error)func (obj *OpenID) SetProxyPassword(value string) error ``` ## Default Value "" ## Remarks A password if authentication is to be used for the proxy. If [ProxyAuthScheme](#proxyauthscheme-property-openid-component) is set to Basic Authentication, the [ProxyUser](#proxyuser-property-openid-component) and [ProxyPassword](#proxypassword-property-openid-component) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [ProxyAuthScheme](#proxyauthscheme-property-openid-component) is set to Digest Authentication, the [ProxyUser](#proxyuser-property-openid-component) and [ProxyPassword](#proxypassword-property-openid-component) properties are used to respond to the Digest Authentication challenge from the server. If [ProxyAuthScheme](#proxyauthscheme-property-openid-component) is set to NTLM Authentication, the [ProxyUser](#proxyuser-property-openid-component) and [ProxyPassword](#proxypassword-property-openid-component) properties are used to authenticate through NTLM negotiation. ## Data Type **string** # ProxyPort Property ([OpenID](#openid-component) Component) The Transmission Control Protocol (TCP) port for the proxy Server (default 80). ## Syntax *Go Syntax* ```text func (obj *OpenID) ProxyPort() (int32, error)func (obj *OpenID) SetProxyPort(value int32) error ``` ## Default Value 80 ## Remarks The Transmission Control Protocol (TCP) port for the proxy [ProxyServer](#proxyserver-property-openid-component) (default 80). See the description of the [ProxyServer](#proxyserver-property-openid-component) property for details. ## Data Type **int32** # ProxyServer Property ([OpenID](#openid-component) Component) If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. ## Syntax *Go Syntax* ```text func (obj *OpenID) ProxyServer() (string, error)func (obj *OpenID) SetProxyServer(value string) error ``` ## Default Value "" ## Remarks If a proxy [ProxyServer](#proxyserver-property-openid-component) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the [ProxyServer](#proxyserver-property-openid-component) property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [ProxyServer](#proxyserver-property-openid-component) property is set to the corresponding address. If the search is not successful, an error is returned. ## Data Type **string** # ProxySSL Property ([OpenID](#openid-component) Component) When to use a Secure Sockets Layer (SSL) for the connection to the proxy. ## Syntax *Go Syntax* ```text func (obj *OpenID) ProxySSL() (int32, error)func (obj *OpenID) SetProxySSL(value int32) error ``` ## Possible Values ```text 0 // Automatic1 // Always2 // Never3 // Tunnel ``` ## Default Value 0 ## Remarks When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows: | | | | --- | --- | | psAutomatic (0) | Default setting. If the URL is an https URL, the struct will use the psTunnel option. If the URL is an http URL, the struct will use the psNever option. | | psAlways (1) | The connection is always SSL-enabled. | | psNever (2) | The connection is not SSL-enabled. | | psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. | ## Data Type **int32** # ProxyUser Property ([OpenID](#openid-component) Component) A username if authentication is to be used for the proxy. ## Syntax *Go Syntax* ```text func (obj *OpenID) ProxyUser() (string, error)func (obj *OpenID) SetProxyUser(value string) error ``` ## Default Value "" ## Remarks A username if authentication is to be used for the proxy. If [ProxyAuthScheme](#proxyauthscheme-property-openid-component) is set to Basic Authentication, the [ProxyUser](#proxyuser-property-openid-component) and [ProxyPassword](#proxypassword-property-openid-component) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [ProxyAuthScheme](#proxyauthscheme-property-openid-component) is set to Digest Authentication, the [ProxyUser](#proxyuser-property-openid-component) and [ProxyPassword](#proxypassword-property-openid-component) properties are used to respond to the Digest Authentication challenge from the server. If [ProxyAuthScheme](#proxyauthscheme-property-openid-component) is set to NTLM Authentication, the [ProxyUser](#proxyuser-property-openid-component) and [ProxyPassword](#proxypassword-property-openid-component) properties are used to authenticate through NTLM negotiation. ## Data Type **string** # RefreshToken Property ([OpenID](#openid-component) Component) The refresh token received from or sent to the authorization server. ## Syntax *Go Syntax* ```text func (obj *OpenID) RefreshToken() (string, error)func (obj *OpenID) SetRefreshToken(value string) error ``` ## Default Value "" ## Remarks When [GetAuthorization](#getauthorization-method-openid-component) is called, if the authorization server returns a refresh token along with the access token, this property will hold the refresh token. Save this value for later use. When your access token expires, set this property to the corresponding refresh token. Then call [GetAuthorization](#getauthorization-method-openid-component), and the struct will use this token to retrieve a new access token. The new authorization string will be returned by the [GetAuthorization](#getauthorization-method-openid-component) method. No user interaction is required when refreshing an access token. ## Data Type **string** # ReturnURL Property ([OpenID](#openid-component) Component) The URL where the user (browser) returns after authenticating. ## Syntax *Go Syntax* ```text func (obj *OpenID) ReturnURL() (string, error)func (obj *OpenID) SetReturnURL(value string) error ``` ## Default Value "" ## Remarks When [ClientProfile](#clientprofile-property-openid-component) is set to ocpApplication, this will be automatically set to the address of the local embedded web server. In that case, this property can be inspected to determine the URL where the user will be redirected, but it does not need to be set. When calling [GetAuthorizationURL](#getauthorizationurl-method-openid-component), which is common when [ClientProfile](#clientprofile-property-openid-component) is set to ocpWeb, set this property to the URL on your server where the user will be redirected after authenticating with the authorization server. This property corresponds to the *redirect_uri* query string parameter. ## Data Type **string** # ServerAuthURL Property ([OpenID](#openid-component) Component) The URL of the authorization server. ## Syntax *Go Syntax* ```text func (obj *OpenID) ServerAuthURL() (string, error)func (obj *OpenID) SetServerAuthURL(value string) error ``` ## Default Value "" ## Remarks This property specifies the URL of the authorization server used when [GetAuthorization](#getauthorization-method-openid-component) is called. This value is used when constructing the URL to which the user will be redirected to authenticate and grant access. This should be specified before calling [GetAuthorization](#getauthorization-method-openid-component). ## Data Type **string** # ServerTokenURL Property ([OpenID](#openid-component) Component) The URL used to obtain the access token. ## Syntax *Go Syntax* ```text func (obj *OpenID) ServerTokenURL() (string, error)func (obj *OpenID) SetServerTokenURL(value string) error ``` ## Default Value "" ## Remarks The property specifies the URL where the grant will be exchanged for the access token. This is typically a separate HTTP endpoint on the authorization server. This must be set before calling [GetAuthorization](#getauthorization-method-openid-component). ## Data Type **string** # ServerUserInfoURL Property ([OpenID](#openid-component) Component) The URL of the OpenID provider's user info endpoint. ## Syntax *Go Syntax* ```text func (obj *OpenID) ServerUserInfoURL() (string, error)func (obj *OpenID) SetServerUserInfoURL(value string) error ``` ## Default Value "" ## Remarks This property holds the URL of the OpenID provider's user info endpoint. This value is required when calling [GetUserInfo](#getuserinfo-method-openid-component). This property is populated when [GetDiscoveryDoc](#getdiscoverydoc-method-openid-component) is called. ## Data Type **string** # SignerCertEffectiveDate Property ([OpenID](#openid-component) Component) The date on which this certificate becomes valid. ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertEffectiveDate() (string, error) ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type **string** # SignerCertExpirationDate Property ([OpenID](#openid-component) Component) The date on which the certificate expires. ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertExpirationDate() (string, error) ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type **string** # SignerCertExtendedKeyUsage Property ([OpenID](#openid-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertExtendedKeyUsage() (string, error) ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type **string** # SignerCertFingerprint Property ([OpenID](#openid-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertFingerprint() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type **string** # SignerCertFingerprintSHA1 Property ([OpenID](#openid-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertFingerprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type **string** # SignerCertFingerprintSHA256 Property ([OpenID](#openid-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertFingerprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type **string** # SignerCertIssuer Property ([OpenID](#openid-component) Component) The issuer of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertIssuer() (string, error) ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type **string** # SignerCertPrivateKey Property ([OpenID](#openid-component) Component) The private key of the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertPrivateKey() (string, error) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SignerCertPrivateKey](#signercertprivatekey-property-openid-component) may be available but not exportable. In this case, [SignerCertPrivateKey](#signercertprivatekey-property-openid-component) returns an empty string. This property is read-only. ## Data Type **string** # SignerCertPrivateKeyAvailable Property ([OpenID](#openid-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertPrivateKeyAvailable() (bool, error) ``` ## Default Value false ## Remarks Whether a [SignerCertPrivateKey](#signercertprivatekey-property-openid-component) is available for the selected certificate. If [SignerCertPrivateKeyAvailable](#signercertprivatekeyavailable-property-openid-component) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type **bool** # SignerCertPrivateKeyContainer Property ([OpenID](#openid-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertPrivateKeyContainer() (string, error) ``` ## Default Value "" ## Remarks The name of the [SignerCertPrivateKey](#signercertprivatekey-property-openid-component) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type **string** # SignerCertPublicKey Property ([OpenID](#openid-component) Component) The public key of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertPublicKey() (string, error) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type **string** # SignerCertPublicKeyAlgorithm Property ([OpenID](#openid-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertPublicKeyAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # SignerCertPublicKeyLength Property ([OpenID](#openid-component) Component) The length of the certificate's public key (in bits). ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertPublicKeyLength() (int32, error) ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type **int32** # SignerCertSerialNumber Property ([OpenID](#openid-component) Component) The serial number of the certificate encoded as a string. ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertSerialNumber() (string, error) ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type **string** # SignerCertSignatureAlgorithm Property ([OpenID](#openid-component) Component) The text description of the certificate's signature algorithm. ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertSignatureAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # SignerCertStore Property ([OpenID](#openid-component) Component) The name of the certificate store for the client certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertStore() ([]byte, error)func (obj *OpenID) SetSignerCertStore(value []byte) error ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SignerCertStoreType](#signercertstoretype-property-openid-component) property denotes the type of the certificate store specified by [SignerCertStore](#signercertstore-property-openid-component). If the store is password-protected, specify the password in [SignerCertStorePassword](#signercertstorepassword-property-openid-component). [SignerCertStore](#signercertstore-property-openid-component) is used in conjunction with the [SignerCertSubject](#signercertsubject-property-openid-component) property to specify client certificates. If [SignerCertStore](#signercertstore-property-openid-component) has a value, and [SignerCertSubject](#signercertsubject-property-openid-component) or [SignerCertEncoded](#signercertencoded-property-openid-component) is set, a search for a certificate is initiated. Please see the [SignerCertSubject](#signercertsubject-property-openid-component) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). ## Data Type **[]byte** # SignerCertStorePassword Property ([OpenID](#openid-component) Component) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertStorePassword() (string, error)func (obj *OpenID) SetSignerCertStorePassword(value string) error ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Data Type **string** # SignerCertStoreType Property ([OpenID](#openid-component) Component) The type of certificate store for this certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertStoreType() (int32, error)func (obj *OpenID) SetSignerCertStoreType(value int32) error ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SignerCertStoreType](#signercertstoretype-property-openid-component), the full path of the PKCS#11 DLL as the [SignerCertStore](#signercertstore-property-openid-component), and the PIN as the [SignerCertStorePassword](#signercertstorepassword-property-openid-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SignerCertStore](#signercertstore-property-openid-component) and set [SignerCertStorePassword](#signercertstorepassword-property-openid-component) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type **int32** # SignerCertSubjectAltNames Property ([OpenID](#openid-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertSubjectAltNames() (string, error) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type **string** # SignerCertThumbprintMD5 Property ([OpenID](#openid-component) Component) The MD5 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertThumbprintMD5() (string, error) ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SignerCertThumbprintSHA1 Property ([OpenID](#openid-component) Component) The SHA-1 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertThumbprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SignerCertThumbprintSHA256 Property ([OpenID](#openid-component) Component) The SHA-256 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertThumbprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SignerCertUsage Property ([OpenID](#openid-component) Component) The text description of UsageFlags . ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertUsage() (string, error) ``` ## Default Value "" ## Remarks The text description of [SignerCertUsageFlags](#signercertusageflags-property-openid-component). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type **string** # SignerCertUsageFlags Property ([OpenID](#openid-component) Component) The flags that show intended use for the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertUsageFlags() (int32, error) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SignerCertUsageFlags](#signercertusageflags-property-openid-component) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [SignerCertUsage](#signercertusage-property-openid-component) property for a text representation of [SignerCertUsageFlags](#signercertusageflags-property-openid-component). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type **int32** # SignerCertVersion Property ([OpenID](#openid-component) Component) The certificate's version number. ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertVersion() (string, error) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type **string** # SignerCertSubject Property ([OpenID](#openid-component) Component) The subject of the certificate used for client authentication. ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertSubject() (string, error)func (obj *OpenID) SetSignerCertSubject(value string) error ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. ## Data Type **string** # SignerCertEncoded Property ([OpenID](#openid-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertEncoded() ([]byte, error)func (obj *OpenID) SetSignerCertEncoded(value []byte) error ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SignerCertStore](#signercertstore-property-openid-component) and [SignerCertSubject](#signercertsubject-property-openid-component) properties also may be used to specify a certificate. When [SignerCertEncoded](#signercertencoded-property-openid-component) is set, a search is initiated in the current [SignerCertStore](#signercertstore-property-openid-component) for the private key of the certificate. If the key is found, [SignerCertSubject](#signercertsubject-property-openid-component) is updated to reflect the full subject of the selected certificate; otherwise, [SignerCertSubject](#signercertsubject-property-openid-component) is set to an empty string. ## Data Type **[]byte** # SignerCertURL Property ([OpenID](#openid-component) Component) The URL of the OpenID provider's signing certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SignerCertURL() (string, error)func (obj *OpenID) SetSignerCertURL(value string) error ``` ## Default Value "" ## Remarks This property holds the URL of the OpenID provider's signing certificate. The signing certificate is used to verify the signature of the ID Token returned when calling [GetAuthorization](#getauthorization-method-openid-component). When calling [GetAuthorization](#getauthorization-method-openid-component) either SignerCertURL or SignerCert must be specified. This property is populated when [GetDiscoveryDoc](#getdiscoverydoc-method-openid-component) is called. ## Data Type **string** # SSLAcceptServerCertEffectiveDate Property ([OpenID](#openid-component) Component) The date on which this certificate becomes valid. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertEffectiveDate() (string, error) ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type **string** # SSLAcceptServerCertExpirationDate Property ([OpenID](#openid-component) Component) The date on which the certificate expires. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertExpirationDate() (string, error) ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type **string** # SSLAcceptServerCertExtendedKeyUsage Property ([OpenID](#openid-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertExtendedKeyUsage() (string, error) ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type **string** # SSLAcceptServerCertFingerprint Property ([OpenID](#openid-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertFingerprint() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type **string** # SSLAcceptServerCertFingerprintSHA1 Property ([OpenID](#openid-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertFingerprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type **string** # SSLAcceptServerCertFingerprintSHA256 Property ([OpenID](#openid-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertFingerprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type **string** # SSLAcceptServerCertIssuer Property ([OpenID](#openid-component) Component) The issuer of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertIssuer() (string, error) ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type **string** # SSLAcceptServerCertPrivateKey Property ([OpenID](#openid-component) Component) The private key of the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertPrivateKey() (string, error) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-openid-component) may be available but not exportable. In this case, [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-openid-component) returns an empty string. This property is read-only. ## Data Type **string** # SSLAcceptServerCertPrivateKeyAvailable Property ([OpenID](#openid-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertPrivateKeyAvailable() (bool, error) ``` ## Default Value false ## Remarks Whether a [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-openid-component) is available for the selected certificate. If [SSLAcceptServerCertPrivateKeyAvailable](#sslacceptservercertprivatekeyavailable-property-openid-component) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type **bool** # SSLAcceptServerCertPrivateKeyContainer Property ([OpenID](#openid-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertPrivateKeyContainer() (string, error) ``` ## Default Value "" ## Remarks The name of the [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-openid-component) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type **string** # SSLAcceptServerCertPublicKey Property ([OpenID](#openid-component) Component) The public key of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertPublicKey() (string, error) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type **string** # SSLAcceptServerCertPublicKeyAlgorithm Property ([OpenID](#openid-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertPublicKeyAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # SSLAcceptServerCertPublicKeyLength Property ([OpenID](#openid-component) Component) The length of the certificate's public key (in bits). ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertPublicKeyLength() (int32, error) ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type **int32** # SSLAcceptServerCertSerialNumber Property ([OpenID](#openid-component) Component) The serial number of the certificate encoded as a string. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertSerialNumber() (string, error) ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type **string** # SSLAcceptServerCertSignatureAlgorithm Property ([OpenID](#openid-component) Component) The text description of the certificate's signature algorithm. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertSignatureAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # SSLAcceptServerCertStore Property ([OpenID](#openid-component) Component) The name of the certificate store for the client certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertStore() ([]byte, error)func (obj *OpenID) SetSSLAcceptServerCertStore(value []byte) error ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-openid-component) property denotes the type of the certificate store specified by [SSLAcceptServerCertStore](#sslacceptservercertstore-property-openid-component). If the store is password-protected, specify the password in [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-openid-component). [SSLAcceptServerCertStore](#sslacceptservercertstore-property-openid-component) is used in conjunction with the [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-openid-component) property to specify client certificates. If [SSLAcceptServerCertStore](#sslacceptservercertstore-property-openid-component) has a value, and [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-openid-component) or [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-openid-component) is set, a search for a certificate is initiated. Please see the [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-openid-component) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). ## Data Type **[]byte** # SSLAcceptServerCertStorePassword Property ([OpenID](#openid-component) Component) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertStorePassword() (string, error)func (obj *OpenID) SetSSLAcceptServerCertStorePassword(value string) error ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Data Type **string** # SSLAcceptServerCertStoreType Property ([OpenID](#openid-component) Component) The type of certificate store for this certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertStoreType() (int32, error)func (obj *OpenID) SetSSLAcceptServerCertStoreType(value int32) error ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-openid-component), the full path of the PKCS#11 DLL as the [SSLAcceptServerCertStore](#sslacceptservercertstore-property-openid-component), and the PIN as the [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-openid-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLAcceptServerCertStore](#sslacceptservercertstore-property-openid-component) and set [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-openid-component) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type **int32** # SSLAcceptServerCertSubjectAltNames Property ([OpenID](#openid-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertSubjectAltNames() (string, error) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type **string** # SSLAcceptServerCertThumbprintMD5 Property ([OpenID](#openid-component) Component) The MD5 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertThumbprintMD5() (string, error) ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLAcceptServerCertThumbprintSHA1 Property ([OpenID](#openid-component) Component) The SHA-1 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertThumbprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLAcceptServerCertThumbprintSHA256 Property ([OpenID](#openid-component) Component) The SHA-256 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertThumbprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLAcceptServerCertUsage Property ([OpenID](#openid-component) Component) The text description of UsageFlags . ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertUsage() (string, error) ``` ## Default Value "" ## Remarks The text description of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-openid-component). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type **string** # SSLAcceptServerCertUsageFlags Property ([OpenID](#openid-component) Component) The flags that show intended use for the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertUsageFlags() (int32, error) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-openid-component) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [SSLAcceptServerCertUsage](#sslacceptservercertusage-property-openid-component) property for a text representation of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-openid-component). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type **int32** # SSLAcceptServerCertVersion Property ([OpenID](#openid-component) Component) The certificate's version number. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertVersion() (string, error) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type **string** # SSLAcceptServerCertSubject Property ([OpenID](#openid-component) Component) The subject of the certificate used for client authentication. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertSubject() (string, error)func (obj *OpenID) SetSSLAcceptServerCertSubject(value string) error ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. ## Data Type **string** # SSLAcceptServerCertEncoded Property ([OpenID](#openid-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLAcceptServerCertEncoded() ([]byte, error)func (obj *OpenID) SetSSLAcceptServerCertEncoded(value []byte) error ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLAcceptServerCertStore](#sslacceptservercertstore-property-openid-component) and [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-openid-component) properties also may be used to specify a certificate. When [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-openid-component) is set, a search is initiated in the current [SSLAcceptServerCertStore](#sslacceptservercertstore-property-openid-component) for the private key of the certificate. If the key is found, [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-openid-component) is updated to reflect the full subject of the selected certificate; otherwise, [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-openid-component) is set to an empty string. ## Data Type **[]byte** # SSLCertEffectiveDate Property ([OpenID](#openid-component) Component) The date on which this certificate becomes valid. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertEffectiveDate() (string, error) ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type **string** # SSLCertExpirationDate Property ([OpenID](#openid-component) Component) The date on which the certificate expires. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertExpirationDate() (string, error) ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type **string** # SSLCertExtendedKeyUsage Property ([OpenID](#openid-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertExtendedKeyUsage() (string, error) ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type **string** # SSLCertFingerprint Property ([OpenID](#openid-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertFingerprint() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type **string** # SSLCertFingerprintSHA1 Property ([OpenID](#openid-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertFingerprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type **string** # SSLCertFingerprintSHA256 Property ([OpenID](#openid-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertFingerprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type **string** # SSLCertIssuer Property ([OpenID](#openid-component) Component) The issuer of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertIssuer() (string, error) ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type **string** # SSLCertPrivateKey Property ([OpenID](#openid-component) Component) The private key of the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertPrivateKey() (string, error) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SSLCertPrivateKey](#sslcertprivatekey-property-openid-component) may be available but not exportable. In this case, [SSLCertPrivateKey](#sslcertprivatekey-property-openid-component) returns an empty string. This property is read-only. ## Data Type **string** # SSLCertPrivateKeyAvailable Property ([OpenID](#openid-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertPrivateKeyAvailable() (bool, error) ``` ## Default Value false ## Remarks Whether a [SSLCertPrivateKey](#sslcertprivatekey-property-openid-component) is available for the selected certificate. If [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-openid-component) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type **bool** # SSLCertPrivateKeyContainer Property ([OpenID](#openid-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertPrivateKeyContainer() (string, error) ``` ## Default Value "" ## Remarks The name of the [SSLCertPrivateKey](#sslcertprivatekey-property-openid-component) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type **string** # SSLCertPublicKey Property ([OpenID](#openid-component) Component) The public key of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertPublicKey() (string, error) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type **string** # SSLCertPublicKeyAlgorithm Property ([OpenID](#openid-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertPublicKeyAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # SSLCertPublicKeyLength Property ([OpenID](#openid-component) Component) The length of the certificate's public key (in bits). ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertPublicKeyLength() (int32, error) ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type **int32** # SSLCertSerialNumber Property ([OpenID](#openid-component) Component) The serial number of the certificate encoded as a string. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertSerialNumber() (string, error) ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type **string** # SSLCertSignatureAlgorithm Property ([OpenID](#openid-component) Component) The text description of the certificate's signature algorithm. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertSignatureAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # SSLCertStore Property ([OpenID](#openid-component) Component) The name of the certificate store for the client certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertStore() ([]byte, error)func (obj *OpenID) SetSSLCertStore(value []byte) error ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SSLCertStoreType](#sslcertstoretype-property-openid-component) property denotes the type of the certificate store specified by [SSLCertStore](#sslcertstore-property-openid-component). If the store is password-protected, specify the password in [SSLCertStorePassword](#sslcertstorepassword-property-openid-component). [SSLCertStore](#sslcertstore-property-openid-component) is used in conjunction with the [SSLCertSubject](#sslcertsubject-property-openid-component) property to specify client certificates. If [SSLCertStore](#sslcertstore-property-openid-component) has a value, and [SSLCertSubject](#sslcertsubject-property-openid-component) or [SSLCertEncoded](#sslcertencoded-property-openid-component) is set, a search for a certificate is initiated. Please see the [SSLCertSubject](#sslcertsubject-property-openid-component) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). ## Data Type **[]byte** # SSLCertStorePassword Property ([OpenID](#openid-component) Component) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertStorePassword() (string, error)func (obj *OpenID) SetSSLCertStorePassword(value string) error ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Data Type **string** # SSLCertStoreType Property ([OpenID](#openid-component) Component) The type of certificate store for this certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertStoreType() (int32, error)func (obj *OpenID) SetSSLCertStoreType(value int32) error ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLCertStoreType](#sslcertstoretype-property-openid-component), the full path of the PKCS#11 DLL as the [SSLCertStore](#sslcertstore-property-openid-component), and the PIN as the [SSLCertStorePassword](#sslcertstorepassword-property-openid-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLCertStore](#sslcertstore-property-openid-component) and set [SSLCertStorePassword](#sslcertstorepassword-property-openid-component) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type **int32** # SSLCertSubjectAltNames Property ([OpenID](#openid-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertSubjectAltNames() (string, error) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type **string** # SSLCertThumbprintMD5 Property ([OpenID](#openid-component) Component) The MD5 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertThumbprintMD5() (string, error) ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLCertThumbprintSHA1 Property ([OpenID](#openid-component) Component) The SHA-1 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertThumbprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLCertThumbprintSHA256 Property ([OpenID](#openid-component) Component) The SHA-256 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertThumbprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLCertUsage Property ([OpenID](#openid-component) Component) The text description of UsageFlags . ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertUsage() (string, error) ``` ## Default Value "" ## Remarks The text description of [SSLCertUsageFlags](#sslcertusageflags-property-openid-component). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type **string** # SSLCertUsageFlags Property ([OpenID](#openid-component) Component) The flags that show intended use for the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertUsageFlags() (int32, error) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SSLCertUsageFlags](#sslcertusageflags-property-openid-component) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [SSLCertUsage](#sslcertusage-property-openid-component) property for a text representation of [SSLCertUsageFlags](#sslcertusageflags-property-openid-component). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type **int32** # SSLCertVersion Property ([OpenID](#openid-component) Component) The certificate's version number. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertVersion() (string, error) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type **string** # SSLCertSubject Property ([OpenID](#openid-component) Component) The subject of the certificate used for client authentication. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertSubject() (string, error)func (obj *OpenID) SetSSLCertSubject(value string) error ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. ## Data Type **string** # SSLCertEncoded Property ([OpenID](#openid-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLCertEncoded() ([]byte, error)func (obj *OpenID) SetSSLCertEncoded(value []byte) error ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLCertStore](#sslcertstore-property-openid-component) and [SSLCertSubject](#sslcertsubject-property-openid-component) properties also may be used to specify a certificate. When [SSLCertEncoded](#sslcertencoded-property-openid-component) is set, a search is initiated in the current [SSLCertStore](#sslcertstore-property-openid-component) for the private key of the certificate. If the key is found, [SSLCertSubject](#sslcertsubject-property-openid-component) is updated to reflect the full subject of the selected certificate; otherwise, [SSLCertSubject](#sslcertsubject-property-openid-component) is set to an empty string. ## Data Type **[]byte** # SSLProvider Property ([OpenID](#openid-component) Component) The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLProvider() (int32, error)func (obj *OpenID) SetSSLProvider(value int32) error ``` ## Possible Values ```text 0 // Automatic1 // Platform2 // Internal ``` ## Default Value 0 ## Remarks This property specifies the SSL/TLS implementation to use. In most cases the default value of *0* (Automatic) is recommended and should not be changed. When set to *0* (Automatic), the struct will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used. Possible values are as follows: | | | | --- | --- | | 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. | | 1 (sslpPlatform) | Uses the platform/system implementation. | | 2 (sslpInternal) | Uses the internal implementation. | **Additional Notes** In most cases using the default value (Automatic) is recommended. The struct will select a provider depending on the current platform. When Automatic is selected, on Windows, the struct will use the platform implementation. On Linux/macOS, the struct will use the internal implementation. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the struct will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. ## Data Type **int32** # SSLServerCertEffectiveDate Property ([OpenID](#openid-component) Component) The date on which this certificate becomes valid. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertEffectiveDate() (string, error) ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type **string** # SSLServerCertExpirationDate Property ([OpenID](#openid-component) Component) The date on which the certificate expires. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertExpirationDate() (string, error) ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type **string** # SSLServerCertExtendedKeyUsage Property ([OpenID](#openid-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertExtendedKeyUsage() (string, error) ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type **string** # SSLServerCertFingerprint Property ([OpenID](#openid-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertFingerprint() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type **string** # SSLServerCertFingerprintSHA1 Property ([OpenID](#openid-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertFingerprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type **string** # SSLServerCertFingerprintSHA256 Property ([OpenID](#openid-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertFingerprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type **string** # SSLServerCertIssuer Property ([OpenID](#openid-component) Component) The issuer of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertIssuer() (string, error) ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type **string** # SSLServerCertPrivateKey Property ([OpenID](#openid-component) Component) The private key of the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertPrivateKey() (string, error) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SSLServerCertPrivateKey](#sslservercertprivatekey-property-openid-component) may be available but not exportable. In this case, [SSLServerCertPrivateKey](#sslservercertprivatekey-property-openid-component) returns an empty string. This property is read-only. ## Data Type **string** # SSLServerCertPrivateKeyAvailable Property ([OpenID](#openid-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertPrivateKeyAvailable() (bool, error) ``` ## Default Value false ## Remarks Whether a [SSLServerCertPrivateKey](#sslservercertprivatekey-property-openid-component) is available for the selected certificate. If [SSLServerCertPrivateKeyAvailable](#sslservercertprivatekeyavailable-property-openid-component) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type **bool** # SSLServerCertPrivateKeyContainer Property ([OpenID](#openid-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertPrivateKeyContainer() (string, error) ``` ## Default Value "" ## Remarks The name of the [SSLServerCertPrivateKey](#sslservercertprivatekey-property-openid-component) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type **string** # SSLServerCertPublicKey Property ([OpenID](#openid-component) Component) The public key of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertPublicKey() (string, error) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type **string** # SSLServerCertPublicKeyAlgorithm Property ([OpenID](#openid-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertPublicKeyAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # SSLServerCertPublicKeyLength Property ([OpenID](#openid-component) Component) The length of the certificate's public key (in bits). ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertPublicKeyLength() (int32, error) ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type **int32** # SSLServerCertSerialNumber Property ([OpenID](#openid-component) Component) The serial number of the certificate encoded as a string. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertSerialNumber() (string, error) ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type **string** # SSLServerCertSignatureAlgorithm Property ([OpenID](#openid-component) Component) The text description of the certificate's signature algorithm. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertSignatureAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # SSLServerCertStore Property ([OpenID](#openid-component) Component) The name of the certificate store for the client certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertStore() ([]byte, error) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SSLServerCertStoreType](#sslservercertstoretype-property-openid-component) property denotes the type of the certificate store specified by [SSLServerCertStore](#sslservercertstore-property-openid-component). If the store is password-protected, specify the password in [SSLServerCertStorePassword](#sslservercertstorepassword-property-openid-component). [SSLServerCertStore](#sslservercertstore-property-openid-component) is used in conjunction with the [SSLServerCertSubject](#sslservercertsubject-property-openid-component) property to specify client certificates. If [SSLServerCertStore](#sslservercertstore-property-openid-component) has a value, and [SSLServerCertSubject](#sslservercertsubject-property-openid-component) or [SSLServerCertEncoded](#sslservercertencoded-property-openid-component) is set, a search for a certificate is initiated. Please see the [SSLServerCertSubject](#sslservercertsubject-property-openid-component) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). This property is read-only. ## Data Type **[]byte** # SSLServerCertStorePassword Property ([OpenID](#openid-component) Component) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertStorePassword() (string, error) ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. This property is read-only. ## Data Type **string** # SSLServerCertStoreType Property ([OpenID](#openid-component) Component) The type of certificate store for this certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertStoreType() (int32, error) ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLServerCertStoreType](#sslservercertstoretype-property-openid-component), the full path of the PKCS#11 DLL as the [SSLServerCertStore](#sslservercertstore-property-openid-component), and the PIN as the [SSLServerCertStorePassword](#sslservercertstorepassword-property-openid-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLServerCertStore](#sslservercertstore-property-openid-component) and set [SSLServerCertStorePassword](#sslservercertstorepassword-property-openid-component) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | This property is read-only. ## Data Type **int32** # SSLServerCertSubjectAltNames Property ([OpenID](#openid-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertSubjectAltNames() (string, error) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type **string** # SSLServerCertThumbprintMD5 Property ([OpenID](#openid-component) Component) The MD5 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertThumbprintMD5() (string, error) ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLServerCertThumbprintSHA1 Property ([OpenID](#openid-component) Component) The SHA-1 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertThumbprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLServerCertThumbprintSHA256 Property ([OpenID](#openid-component) Component) The SHA-256 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertThumbprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLServerCertUsage Property ([OpenID](#openid-component) Component) The text description of UsageFlags . ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertUsage() (string, error) ``` ## Default Value "" ## Remarks The text description of [SSLServerCertUsageFlags](#sslservercertusageflags-property-openid-component). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type **string** # SSLServerCertUsageFlags Property ([OpenID](#openid-component) Component) The flags that show intended use for the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertUsageFlags() (int32, error) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SSLServerCertUsageFlags](#sslservercertusageflags-property-openid-component) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [SSLServerCertUsage](#sslservercertusage-property-openid-component) property for a text representation of [SSLServerCertUsageFlags](#sslservercertusageflags-property-openid-component). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type **int32** # SSLServerCertVersion Property ([OpenID](#openid-component) Component) The certificate's version number. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertVersion() (string, error) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type **string** # SSLServerCertSubject Property ([OpenID](#openid-component) Component) The subject of the certificate used for client authentication. ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertSubject() (string, error) ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. This property is read-only. ## Data Type **string** # SSLServerCertEncoded Property ([OpenID](#openid-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *Go Syntax* ```text func (obj *OpenID) SSLServerCertEncoded() ([]byte, error) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLServerCertStore](#sslservercertstore-property-openid-component) and [SSLServerCertSubject](#sslservercertsubject-property-openid-component) properties also may be used to specify a certificate. When [SSLServerCertEncoded](#sslservercertencoded-property-openid-component) is set, a search is initiated in the current [SSLServerCertStore](#sslservercertstore-property-openid-component) for the private key of the certificate. If the key is found, [SSLServerCertSubject](#sslservercertsubject-property-openid-component) is updated to reflect the full subject of the selected certificate; otherwise, [SSLServerCertSubject](#sslservercertsubject-property-openid-component) is set to an empty string. This property is read-only. ## Data Type **[]byte** # State Property ([OpenID](#openid-component) Component) The opaque value used to maintain state between the request and response. ## Syntax *Go Syntax* ```text func (obj *OpenID) State() (string, error)func (obj *OpenID) SetState(value string) error ``` ## Default Value "" ## Remarks This property optionally holds a string value which will be returned by the authorization server with the response. Any value may be specified here and it will be returned exactly as it was sent. This can be used to maintain state within the application, and also may be used for security purposes (for instance to prevent Cross-Site Request Forgery). The contents of this property are treated as an opaque value. When [ClientProfile](#clientprofile-property-openid-component) is set to *ocpApplication* the [ReturnURL](#returnurl-event-openid-component) event provides the *state* value returned by the authorization server. ## Data Type **string** # Timeout Property ([OpenID](#openid-component) Component) The timeout for the class. ## Syntax *Go Syntax* ```text func (obj *OpenID) Timeout() (int32, error)func (obj *OpenID) SetTimeout(value int32) error ``` ## Default Value 60 ## Remarks If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered. If Timeout is set to a positive value, the struct will wait for the operation to complete before returning control. The struct will use [DoEvents](#doevents-method-openid-component) to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive. If Timeout expires, and the operation is not yet complete, the struct fails with an error. NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received. The default value for the Timeout property is 60 seconds. ## Data Type **int32** # TransferredData Property ([OpenID](#openid-component) Component) The contents of the last response from the server. ## Syntax *Go Syntax* ```text func (obj *OpenID) TransferredData() ([]byte, error) ``` ## Default Value "" ## Remarks This property contains the contents of the last response from the server. [TransferredDataLimit](#TransferredDataLimit) controls the maximum amount of data accumulated in TransferredData (by default, there is no limit). This property is read-only. ## Data Type **[]byte** # TransferredHeaders Property ([OpenID](#openid-component) Component) The full set of headers as received from the server. ## Syntax *Go Syntax* ```text func (obj *OpenID) TransferredHeaders() (string, error) ``` ## Default Value "" ## Remarks This property returns the complete set of raw headers as received from the server. The [Header](#header-event-openid-component) event shows the individual headers as parsed by the struct. This property is read-only. ## Data Type **string** # UsePKCE Property ([OpenID](#openid-component) Component) Whether Proof Key for Code Exchange (PKCE) should be used. ## Syntax *Go Syntax* ```text func (obj *OpenID) UsePKCE() (bool, error)func (obj *OpenID) SetUsePKCE(value bool) error ``` ## Default Value false ## Remarks If specified, Proof Key for Code Exchange (PKCE) defined by RFC 7636 will be used when [GetAuthorization](#getauthorization-method-openid-component) is called. This applies when using the Authorization Code [GrantType](#granttype-property-openid-component). The [PKCEChallengeEncoding](#PKCEChallengeEncoding) configuration setting can be used to control the code challenge method that will be used. When using the ocpWeb [ClientProfile](#clientprofile-property-openid-component), the [PKCEVerifier](#PKCEVerifier) configuration setting can be used to get/set the verifier that was used to generate the challenge. See the [PKCEVerifier](#PKCEVerifier) documentation for more information. ## Data Type **bool** # UserDetailsAddrCountry Property ([OpenID](#openid-component) Component) The country name portion of the user's address. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsAddrCountry() (string, error) ``` ## Default Value "" ## Remarks The country name portion of the user's address. This property is read-only. ## Data Type **string** # UserDetailsAddrFormatted Property ([OpenID](#openid-component) Component) The full mailing address of the user, formatted for display or use on a mailing label. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsAddrFormatted() (string, error) ``` ## Default Value "" ## Remarks The full mailing address of the user, formatted for display or use on a mailing label. This value may contain multiple lines. This property is read-only. ## Data Type **string** # UserDetailsAddrLocality Property ([OpenID](#openid-component) Component) The city or locality portion of the user's address. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsAddrLocality() (string, error) ``` ## Default Value "" ## Remarks The city or locality portion of the user's address. This property is read-only. ## Data Type **string** # UserDetailsAddrPostalCode Property ([OpenID](#openid-component) Component) The zip code or postal code portion of the user's address. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsAddrPostalCode() (string, error) ``` ## Default Value "" ## Remarks The zip code or postal code portion of the user's address. This property is read-only. ## Data Type **string** # UserDetailsAddrRegion Property ([OpenID](#openid-component) Component) The state, province, prefecture, or region portion of the user's address. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsAddrRegion() (string, error) ``` ## Default Value "" ## Remarks The state, province, prefecture, or region portion of the user's address. This property is read-only. ## Data Type **string** # UserDetailsAddrStreetAddr Property ([OpenID](#openid-component) Component) The street address portion of the user's address. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsAddrStreetAddr() (string, error) ``` ## Default Value "" ## Remarks The street address portion of the user's address. This is the full street address which may include house number, street name, post office box, and multi-line extended street information. This value may contain multiple lines. This property is read-only. ## Data Type **string** # UserDetailsBirthday Property ([OpenID](#openid-component) Component) The user's birthday. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsBirthday() (string, error) ``` ## Default Value "" ## Remarks The user's birthday. The format of the value is *YYYY-MM-DD* or *YYYY*. The year may be *0000* to indicate that it was omitted. This property is read-only. ## Data Type **string** # UserDetailsEmail Property ([OpenID](#openid-component) Component) The user's preferred email address. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsEmail() (string, error) ``` ## Default Value "" ## Remarks The user's preferred email address. This property is read-only. ## Data Type **string** # UserDetailsEmailVerified Property ([OpenID](#openid-component) Component) Whether the user's email address has been verified. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsEmailVerified() (bool, error) ``` ## Default Value false ## Remarks Whether the user's email address has been verified. To be considered verified, the end-user must prove the email address was under the user's control at the time of verification. This property is read-only. ## Data Type **bool** # UserDetailsFirstName Property ([OpenID](#openid-component) Component) The first name of the user. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsFirstName() (string, error) ``` ## Default Value "" ## Remarks The first name of the user. If multiple names are present, they are space-separated. This property is read-only. ## Data Type **string** # UserDetailsGender Property ([OpenID](#openid-component) Component) The user's gender. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsGender() (string, error) ``` ## Default Value "" ## Remarks The user's gender. Defined values are *male* and *female*, but other values may also be used. This property is read-only. ## Data Type **string** # UserDetailsLastName Property ([OpenID](#openid-component) Component) The last name of the user. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsLastName() (string, error) ``` ## Default Value "" ## Remarks The last name of the user. If multiple names are present, they are space-separated. This property is read-only. ## Data Type **string** # UserDetailsLocale Property ([OpenID](#openid-component) Component) The end user's locale. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsLocale() (string, error) ``` ## Default Value "" ## Remarks The end user's locale. This is represented as a BCP47 (RFC 5646) language tag. For instance, *en-US* or *en_US*. This property is read-only. ## Data Type **string** # UserDetailsMiddleName Property ([OpenID](#openid-component) Component) The middle name of the user. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsMiddleName() (string, error) ``` ## Default Value "" ## Remarks The middle name of the user. If multiple names are present, they are space-separated. This property is read-only. ## Data Type **string** # UserDetailsName Property ([OpenID](#openid-component) Component) The user's full name in displayable form including all name parts. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsName() (string, error) ``` ## Default Value "" ## Remarks The user's full name in displayable form including all name parts. This may include titles and suffixes. This property is read-only. ## Data Type **string** # UserDetailsNickname Property ([OpenID](#openid-component) Component) The casual name of the user. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsNickname() (string, error) ``` ## Default Value "" ## Remarks The casual name of the user. This may or may not be the same as [UserDetailsFirstName](#userdetailsfirstname-property-openid-component). This property is read-only. ## Data Type **string** # UserDetailsPhoneNumber Property ([OpenID](#openid-component) Component) The user's phone number. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsPhoneNumber() (string, error) ``` ## Default Value "" ## Remarks The user's phone number. This may be in E.164 format, for instance *+1 (425) 555-1212*. If an extension is present, it may be represented according to RFC 3966. For instance: *+1 (604) 555-1234;ext=5678*. This property is read-only. ## Data Type **string** # UserDetailsPhoneNumberVerified Property ([OpenID](#openid-component) Component) Whether the user's phone number has been verified. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsPhoneNumberVerified() (bool, error) ``` ## Default Value false ## Remarks Whether the user's phone number has been verified. To be considered verified, the end-user must prove the phone number was under the user's control at the time of verification. This property is read-only. ## Data Type **bool** # UserDetailsPictureURL Property ([OpenID](#openid-component) Component) The URL of the user's profile picture. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsPictureURL() (string, error) ``` ## Default Value "" ## Remarks The URL of the user's profile picture. This property is read-only. ## Data Type **string** # UserDetailsPreferredUsername Property ([OpenID](#openid-component) Component) The shorthand name by which the end-user wishes to be referred. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsPreferredUsername() (string, error) ``` ## Default Value "" ## Remarks The shorthand name by which the end-user wishes to be referred. This property is read-only. ## Data Type **string** # UserDetailsProfileURL Property ([OpenID](#openid-component) Component) The URL of the user's profile page. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsProfileURL() (string, error) ``` ## Default Value "" ## Remarks The URL of the user's profile page. This property is read-only. ## Data Type **string** # UserDetailsSubject Property ([OpenID](#openid-component) Component) The subject of the user that is being represented. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsSubject() (string, error) ``` ## Default Value "" ## Remarks The subject of the user that is being represented. This property is set when parsed from an ID Token or after retrieving the user info. Typically this represents the user of the application. This property is read-only. ## Data Type **string** # UserDetailsUpdatedAt Property ([OpenID](#openid-component) Component) The time when the user's information was last updated. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsUpdatedAt() (int64, error) ``` ## Default Value 0 ## Remarks The time when the user's information was last updated. The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time. This property is read-only. ## Data Type **int64** # UserDetailsWebsite Property ([OpenID](#openid-component) Component) The URL of the user's website. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsWebsite() (string, error) ``` ## Default Value "" ## Remarks The URL of the user's website. This property is read-only. ## Data Type **string** # UserDetailsZoneInfo Property ([OpenID](#openid-component) Component) The user's time zone. ## Syntax *Go Syntax* ```text func (obj *OpenID) UserDetailsZoneInfo() (string, error) ``` ## Default Value "" ## Remarks The user's time zone. For instance: *America/Los_Angeles*. This property is read-only. ## Data Type **string** # WebServerPort Property ([OpenID](#openid-component) Component) The local port on which the embedded web server listens. ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerPort() (int32, error)func (obj *OpenID) SetWebServerPort(value int32) error ``` ## Default Value 0 ## Remarks This property specifies the port on which the embedded web server listens. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be returned when this setting is queried after the server has started listening. This is applicable only when using the embedded web server. ## Data Type **int32** # WebServerSSLCertEffectiveDate Property ([OpenID](#openid-component) Component) The date on which this certificate becomes valid. ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertEffectiveDate() (string, error) ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type **string** # WebServerSSLCertExpirationDate Property ([OpenID](#openid-component) Component) The date on which the certificate expires. ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertExpirationDate() (string, error) ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type **string** # WebServerSSLCertExtendedKeyUsage Property ([OpenID](#openid-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertExtendedKeyUsage() (string, error) ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type **string** # WebServerSSLCertFingerprint Property ([OpenID](#openid-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertFingerprint() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type **string** # WebServerSSLCertFingerprintSHA1 Property ([OpenID](#openid-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertFingerprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type **string** # WebServerSSLCertFingerprintSHA256 Property ([OpenID](#openid-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertFingerprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type **string** # WebServerSSLCertIssuer Property ([OpenID](#openid-component) Component) The issuer of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertIssuer() (string, error) ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type **string** # WebServerSSLCertPrivateKey Property ([OpenID](#openid-component) Component) The private key of the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertPrivateKey() (string, error) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [WebServerSSLCertPrivateKey](#webserversslcertprivatekey-property-openid-component) may be available but not exportable. In this case, [WebServerSSLCertPrivateKey](#webserversslcertprivatekey-property-openid-component) returns an empty string. This property is read-only. ## Data Type **string** # WebServerSSLCertPrivateKeyAvailable Property ([OpenID](#openid-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertPrivateKeyAvailable() (bool, error) ``` ## Default Value false ## Remarks Whether a [WebServerSSLCertPrivateKey](#webserversslcertprivatekey-property-openid-component) is available for the selected certificate. If [WebServerSSLCertPrivateKeyAvailable](#webserversslcertprivatekeyavailable-property-openid-component) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type **bool** # WebServerSSLCertPrivateKeyContainer Property ([OpenID](#openid-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertPrivateKeyContainer() (string, error) ``` ## Default Value "" ## Remarks The name of the [WebServerSSLCertPrivateKey](#webserversslcertprivatekey-property-openid-component) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type **string** # WebServerSSLCertPublicKey Property ([OpenID](#openid-component) Component) The public key of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertPublicKey() (string, error) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type **string** # WebServerSSLCertPublicKeyAlgorithm Property ([OpenID](#openid-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertPublicKeyAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # WebServerSSLCertPublicKeyLength Property ([OpenID](#openid-component) Component) The length of the certificate's public key (in bits). ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertPublicKeyLength() (int32, error) ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type **int32** # WebServerSSLCertSerialNumber Property ([OpenID](#openid-component) Component) The serial number of the certificate encoded as a string. ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertSerialNumber() (string, error) ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type **string** # WebServerSSLCertSignatureAlgorithm Property ([OpenID](#openid-component) Component) The text description of the certificate's signature algorithm. ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertSignatureAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # WebServerSSLCertStore Property ([OpenID](#openid-component) Component) The name of the certificate store for the client certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertStore() ([]byte, error)func (obj *OpenID) SetWebServerSSLCertStore(value []byte) error ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [WebServerSSLCertStoreType](#webserversslcertstoretype-property-openid-component) property denotes the type of the certificate store specified by [WebServerSSLCertStore](#webserversslcertstore-property-openid-component). If the store is password-protected, specify the password in [WebServerSSLCertStorePassword](#webserversslcertstorepassword-property-openid-component). [WebServerSSLCertStore](#webserversslcertstore-property-openid-component) is used in conjunction with the [WebServerSSLCertSubject](#webserversslcertsubject-property-openid-component) property to specify client certificates. If [WebServerSSLCertStore](#webserversslcertstore-property-openid-component) has a value, and [WebServerSSLCertSubject](#webserversslcertsubject-property-openid-component) or [WebServerSSLCertEncoded](#webserversslcertencoded-property-openid-component) is set, a search for a certificate is initiated. Please see the [WebServerSSLCertSubject](#webserversslcertsubject-property-openid-component) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). ## Data Type **[]byte** # WebServerSSLCertStorePassword Property ([OpenID](#openid-component) Component) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertStorePassword() (string, error)func (obj *OpenID) SetWebServerSSLCertStorePassword(value string) error ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Data Type **string** # WebServerSSLCertStoreType Property ([OpenID](#openid-component) Component) The type of certificate store for this certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertStoreType() (int32, error)func (obj *OpenID) SetWebServerSSLCertStoreType(value int32) error ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [WebServerSSLCertStoreType](#webserversslcertstoretype-property-openid-component), the full path of the PKCS#11 DLL as the [WebServerSSLCertStore](#webserversslcertstore-property-openid-component), and the PIN as the [WebServerSSLCertStorePassword](#webserversslcertstorepassword-property-openid-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [WebServerSSLCertStore](#webserversslcertstore-property-openid-component) and set [WebServerSSLCertStorePassword](#webserversslcertstorepassword-property-openid-component) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type **int32** # WebServerSSLCertSubjectAltNames Property ([OpenID](#openid-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertSubjectAltNames() (string, error) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type **string** # WebServerSSLCertThumbprintMD5 Property ([OpenID](#openid-component) Component) The MD5 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertThumbprintMD5() (string, error) ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # WebServerSSLCertThumbprintSHA1 Property ([OpenID](#openid-component) Component) The SHA-1 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertThumbprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # WebServerSSLCertThumbprintSHA256 Property ([OpenID](#openid-component) Component) The SHA-256 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertThumbprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # WebServerSSLCertUsage Property ([OpenID](#openid-component) Component) The text description of UsageFlags . ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertUsage() (string, error) ``` ## Default Value "" ## Remarks The text description of [WebServerSSLCertUsageFlags](#webserversslcertusageflags-property-openid-component). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type **string** # WebServerSSLCertUsageFlags Property ([OpenID](#openid-component) Component) The flags that show intended use for the certificate. ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertUsageFlags() (int32, error) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [WebServerSSLCertUsageFlags](#webserversslcertusageflags-property-openid-component) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [WebServerSSLCertUsage](#webserversslcertusage-property-openid-component) property for a text representation of [WebServerSSLCertUsageFlags](#webserversslcertusageflags-property-openid-component). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type **int32** # WebServerSSLCertVersion Property ([OpenID](#openid-component) Component) The certificate's version number. ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertVersion() (string, error) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type **string** # WebServerSSLCertSubject Property ([OpenID](#openid-component) Component) The subject of the certificate used for client authentication. ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertSubject() (string, error)func (obj *OpenID) SetWebServerSSLCertSubject(value string) error ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. ## Data Type **string** # WebServerSSLCertEncoded Property ([OpenID](#openid-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLCertEncoded() ([]byte, error)func (obj *OpenID) SetWebServerSSLCertEncoded(value []byte) error ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [WebServerSSLCertStore](#webserversslcertstore-property-openid-component) and [WebServerSSLCertSubject](#webserversslcertsubject-property-openid-component) properties also may be used to specify a certificate. When [WebServerSSLCertEncoded](#webserversslcertencoded-property-openid-component) is set, a search is initiated in the current [WebServerSSLCertStore](#webserversslcertstore-property-openid-component) for the private key of the certificate. If the key is found, [WebServerSSLCertSubject](#webserversslcertsubject-property-openid-component) is updated to reflect the full subject of the selected certificate; otherwise, [WebServerSSLCertSubject](#webserversslcertsubject-property-openid-component) is set to an empty string. ## Data Type **[]byte** # WebServerSSLEnabled Property ([OpenID](#openid-component) Component) Whether the web server requires Secure Sockets Layer (SSL) connections. ## Syntax *Go Syntax* ```text func (obj *OpenID) WebServerSSLEnabled() (bool, error)func (obj *OpenID) SetWebServerSSLEnabled(value bool) error ``` ## Default Value false ## Remarks This setting specifies whether the embedded web server uses a Secure Sockets Layer (SSL). If set to *True*, WebServerSSLCert is required and the server will accept only SSL connections. If set to *False*, only plaintext connects are supported. ## Data Type **bool** # AddCookie Method ([OpenID](#openid-component) Component) Adds a cookie and the corresponding value to the outgoing request headers. ## Syntax *Go Syntax* ```text func (obj *OpenID) AddCookie(CookieName string, CookieValue string) error ``` ## Remarks This method adds a cookie and the corresponding value to the outgoing request headers. Please refer to the Cookies property for more information on cookies and how they are managed. # AddParam Method ([OpenID](#openid-component) Component) Adds a name-value pair to the query string parameters of the outgoing request. ## Syntax *Go Syntax* ```text func (obj *OpenID) AddParam(ParamName string, ParamValue string) error ``` ## Remarks This method can be used to add query string parameters to the outgoing request. One common use for this method would be to add the *state* parameter to the request, which can be used when the [ClientProfile](#clientprofile-property-openid-component) is ocpWeb to add user-defined data. The authorization server will include the *state* parameter in the response and will be available in the post back to your server, which will allow you to maintain state in your application. # Config Method ([OpenID](#openid-component) Component) Sets or retrieves a configuration setting. ## Syntax *Go Syntax* ```text func (obj *OpenID) Config(ConfigurationString string) (string, error) ``` ## Remarks Config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-openid-component) for the struct. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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](#config-settings-openid-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # DoEvents Method ([OpenID](#openid-component) Component) This method processes events from the internal message queue. ## Syntax *Go Syntax* ```text func (obj *OpenID) DoEvents() error ``` ## Remarks When DoEvents is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns. # GetAuthorization Method ([OpenID](#openid-component) Component) Gets the authorization string required to access the protected resource. ## Syntax *Go Syntax* ```text func (obj *OpenID) GetAuthorization() (string, error) ``` ## Remarks GetAuthorization performs several operations automatically depending on the value of [ClientProfile](#clientprofile-property-openid-component). Please see the introduction section for the [OpenID](#openid-component) struct for a detailed overview of the typical scenarios. After authorization is complete, UserDetails will be populated with the claims parsed from the ID Token. This method also returns an authorization string. The authorization string grants access to additional resources as requested via the [AuthorizationScope](#authorizationscope-property-openid-component) property. If access to another resource was requested, then the access token returned here may be set in the Authorization property of any other struct (or passed as the value of the HTTP Authorization header). [GetUserInfo](#getuserinfo-method-openid-component) may be called after calling this method. The following properties are applicable when calling this method: - [ClientId](#clientid-property-openid-component) (required) - [ClientSecret](#clientsecret-property-openid-component) (required) - [ServerAuthURL](#serverauthurl-property-openid-component) (required - populated by [GetDiscoveryDoc](#getdiscoverydoc-method-openid-component).) - [ServerTokenURL](#servertokenurl-property-openid-component) (required - populated by [GetDiscoveryDoc](#getdiscoverydoc-method-openid-component).) - [SignerCertURL](#signercerturl-property-openid-component) (conditional - populated by [GetDiscoveryDoc](#getdiscoverydoc-method-openid-component). Required if SignerCert is not set.) - SignerCert (conditional - required if [SignerCertURL](#signercerturl-property-openid-component) is not set.) - [AuthorizationScope](#authorizationscope-property-openid-component) - [ClientProfile](#clientprofile-property-openid-component) - [GrantType](#granttype-property-openid-component) - Params - [RefreshToken](#refreshtoken-property-openid-component) - [ReturnURL](#returnurl-property-openid-component) - [State](#state-property-openid-component) - [Timeout](#timeout-property-openid-component) - [Display](#Display) - [Prompt](#Prompt) - [IdTokenHint](#IdTokenHint) - [LoginHint](#LoginHint) - [ResponseType](#ResponseType) # GetAuthorizationURL Method ([OpenID](#openid-component) Component) Builds and returns the URL to which the user should be redirected for authorization. ## Syntax *Go Syntax* ```text func (obj *OpenID) GetAuthorizationURL() (string, error) ``` ## Remarks When this method is called, the struct will return the URL used for authorization. The struct will not make any connections, but instead it will return the URL to you so that you may redirect the user to this location. This is useful when [ClientProfile](#clientprofile-property-openid-component) is set to ocpWeb. Before calling this method, set the following: - [ClientId](#clientid-property-openid-component) - [ClientSecret](#clientsecret-property-openid-component) - [ReturnURL](#returnurl-property-openid-component) - [AuthorizationScope](#authorizationscope-property-openid-component) (optional) # GetDiscoveryDoc Method ([OpenID](#openid-component) Component) Gets the OpenID Discovery Document. ## Syntax *Go Syntax* ```text func (obj *OpenID) GetDiscoveryDoc(URL string) error ``` ## Remarks This method gets the OpenID Connect Discovery Document specified by the *URL* parameter and parses the response. The discover document contains details about the OpenID Provider configuration including endpoint URLs, supported claims and response types, and more. The discovery document URL is typically published by an OpenID Provider (OP) and must be known before calling this method. The format of the URL is standardized and typically takes the form: *https://www.youropenidserver.com/.well-known/openid-configuration* Call GetDiscoveryDoc before calling [GetAuthorization](#getauthorization-method-openid-component) to populate the struct properties with information required to complete the authorization. The retrieved information includes endpoint URLs as well as the OpenID public certificates used to verify the signature on the ID Token. After calling this method the following properties are populated: - [ServerAuthURL](#serverauthurl-property-openid-component) - [ServerTokenURL](#servertokenurl-property-openid-component) - [ServerUserInfoURL](#serveruserinfourl-property-openid-component) - [SignerCertURL](#signercerturl-property-openid-component) The above values may be stored, and later populated from the stored values, to avoid the requirement of calling GetDiscoveryDoc on subsequent authorization requests. The following discovery document fields are populated after GetDiscoveryDoc returns: - [DiscoveryDocDetailsAuthorizationURL](#discoverydocdetailsauthorizationurl-property-openid-component) - [DiscoveryDocDetailsClaimsParamSupported](#discoverydocdetailsclaimsparamsupported-property-openid-component) - [DiscoveryDocDetailsIssuer](#discoverydocdetailsissuer-property-openid-component) - [DiscoveryDocDetailsSignerCertURL](#discoverydocdetailssignercerturl-property-openid-component) - [DiscoveryDocDetailsRegistrationURL](#discoverydocdetailsregistrationurl-property-openid-component) - [DiscoveryDocDetailsServiceDocsURL](#discoverydocdetailsservicedocsurl-property-openid-component) - [DiscoveryDocDetailsSupportedClaims](#discoverydocdetailssupportedclaims-property-openid-component) - [DiscoveryDocDetailsSupportedDisplays](#discoverydocdetailssupporteddisplays-property-openid-component) - [DiscoveryDocDetailsSupportedGrantTypes](#discoverydocdetailssupportedgranttypes-property-openid-component) - [DiscoveryDocDetailsSupportedResponseTypes](#discoverydocdetailssupportedresponsetypes-property-openid-component) - [DiscoveryDocDetailsSupportedScopes](#discoverydocdetailssupportedscopes-property-openid-component) - [DiscoveryDocDetailsTokenURL](#discoverydocdetailstokenurl-property-openid-component) - [DiscoveryDocDetailsUserInfoURL](#discoverydocdetailsuserinfourl-property-openid-component) To access values not automatically parsed by the struct the [XPath](#XPath) configuration setting may be set to retrieve a specific value. Alternatively the [RawJSON](#RawJSON) setting returns the entire JSON document which may be parsed separately. # GetParam Method ([OpenID](#openid-component) Component) Gets a specific parameter from a query string. ## Syntax *Go Syntax* ```text func (obj *OpenID) GetParam(ParamName string) (string, error) ``` ## Remarks This method can be used to get a specific parameter from a query string. For example, when using the ocpApplication profile, this method can be used in the [ReturnURL](#returnurl-event-openid-component) event to query the parameters that are returned from the authorization server. Then, it can be called after [GetAuthorization](#getauthorization-method-openid-component) completes to query the parameters that the token server responded with. ```text string authorizationString = oauth.GetAuthorization(); string stateValue = oauth.GetParam("state"); ``` # GetUserInfo Method ([OpenID](#openid-component) Component) Retrieves claims about the user. ## Syntax *Go Syntax* ```text func (obj *OpenID) GetUserInfo() error ``` ## Remarks This method retrieves claims about the user. Before calling the GetUserInfo method, a successful call to [GetAuthorization](#getauthorization-method-openid-component) must be made. The access token returned by [GetAuthorization](#getauthorization-method-openid-component) is used by the OpenID provider at [ServerUserInfoURL](#serveruserinfourl-property-openid-component) to identify the user for which claims are being retrieved. When this method is called the struct requests the claims about the user from the [ServerUserInfoURL](#serveruserinfourl-property-openid-component). The resulting claims are available in the UserDetails property. Note: The GetUserInfo method will populate the UserDetails property with the claims returned in the ID Token during the authorization process. This method may not need to be called in order to access the desired claims about the user. ```text openid.GetUserInfo(); // ... use the user info in the remainder of your application ... ``` # Interrupt Method ([OpenID](#openid-component) Component) This method interrupts the current method. ## Syntax *Go Syntax* ```text func (obj *OpenID) Interrupt() error ``` ## Remarks If there is no method in progress, Interrupt simply returns, doing nothing. # Reset Method ([OpenID](#openid-component) Component) This method will reset the class. ## Syntax *Go Syntax* ```text func (obj *OpenID) Reset() error ``` ## Remarks This method will reset the struct's properties to their default values. # StartWebServer Method ([OpenID](#openid-component) Component) Starts the embedded web server. ## Syntax *Go Syntax* ```text func (obj *OpenID) StartWebServer() error ``` ## Remarks This method starts the embedded web server. This method can be used to manually start the embedded web server. Under normal circumstances, this is not needed as the component will automatically start and stop the web server when [GetAuthorization](#getauthorization-method-openid-component) is called. You may decide, however, to start the web server manually before calling [GetAuthorization](#getauthorization-method-openid-component). When called, this method will also populate [ReturnURL](#returnurl-property-openid-component) with the address of the embedded server. # StopWebServer Method ([OpenID](#openid-component) Component) Stops the embedded web server. ## Syntax *Go Syntax* ```text func (obj *OpenID) StopWebServer() error ``` ## Remarks This method stops the embedded web server. Under normal circumstances, the web server will be stopped automatically during the authorization process when [GetAuthorization](#getauthorization-method-openid-component) is called. # Connected Event ([OpenID](#openid-component) Component) Fired immediately after a connection completes (or fails). ## Syntax *Go Syntax* ```text // OpenIDConnectedEventArgs carries the OpenID Connected event's parameters. type OpenIDConnectedEventArgs struct {...} func (args *OpenIDConnectedEventArgs) StatusCode() int32 func (args *OpenIDConnectedEventArgs) Description() string // OpenIDConnectedEvent defines the signature of the OpenID Connected event's handler function. type OpenIDConnectedEvent func(sender *OpenID, args *OpenIDConnectedEventArgs) func (obj *OpenID) GetOnConnectedHandler() OpenIDConnectedEvent func (obj *OpenID) SetOnConnectedHandler(handlerFunc OpenIDConnectedEvent) ``` ## Remarks If the connection is made normally, *StatusCode* is 0 and *Description* is "OK". If the connection fails, *StatusCode* has the error code returned by the Transmission Control Protocol (TCP)/IP stack. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the error. Please refer to the [Error Codes](#trappable-errors-openid-component) section for more information. # ConnectionStatus Event ([OpenID](#openid-component) Component) Fired to indicate changes in the connection state. ## Syntax *Go Syntax* ```text // OpenIDConnectionStatusEventArgs carries the OpenID ConnectionStatus event's parameters. type OpenIDConnectionStatusEventArgs struct {...} func (args *OpenIDConnectionStatusEventArgs) ConnectionEvent() string func (args *OpenIDConnectionStatusEventArgs) StatusCode() int32 func (args *OpenIDConnectionStatusEventArgs) Description() string // OpenIDConnectionStatusEvent defines the signature of the OpenID ConnectionStatus event's handler function. type OpenIDConnectionStatusEvent func(sender *OpenID, args *OpenIDConnectionStatusEventArgs) func (obj *OpenID) GetOnConnectionStatusHandler() OpenIDConnectionStatusEvent func (obj *OpenID) SetOnConnectionStatusHandler(handlerFunc OpenIDConnectionStatusEvent) ``` ## Remarks This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake. The *ConnectionEvent* parameter indicates the type of connection event. Values may include the following: | | | | --- | --- | | | Firewall connection complete. | | | Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). | | | Remote host connection complete. | | | Remote host disconnected. | | | SSL or S/Shell connection broken. | | | Firewall host disconnected. | *StatusCode* has the error code returned by the Transmission Control Protocol (TCP)/IP stack. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the error. # Disconnected Event ([OpenID](#openid-component) Component) Fired when a connection is closed. ## Syntax *Go Syntax* ```text // OpenIDDisconnectedEventArgs carries the OpenID Disconnected event's parameters. type OpenIDDisconnectedEventArgs struct {...} func (args *OpenIDDisconnectedEventArgs) StatusCode() int32 func (args *OpenIDDisconnectedEventArgs) Description() string // OpenIDDisconnectedEvent defines the signature of the OpenID Disconnected event's handler function. type OpenIDDisconnectedEvent func(sender *OpenID, args *OpenIDDisconnectedEventArgs) func (obj *OpenID) GetOnDisconnectedHandler() OpenIDDisconnectedEvent func (obj *OpenID) SetOnDisconnectedHandler(handlerFunc OpenIDDisconnectedEvent) ``` ## Remarks If the connection is broken normally, *StatusCode* is 0 and *Description* is "OK". If the connection is broken for any other reason, *StatusCode* has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the TCP/IP error. Please refer to the [Error Codes](#trappable-errors-openid-component) section for more information. # EndTransfer Event ([OpenID](#openid-component) Component) Fired when a document finishes transferring. ## Syntax *Go Syntax* ```text // OpenIDEndTransferEventArgs carries the OpenID EndTransfer event's parameters. type OpenIDEndTransferEventArgs struct {...} func (args *OpenIDEndTransferEventArgs) Direction() int32 // OpenIDEndTransferEvent defines the signature of the OpenID EndTransfer event's handler function. type OpenIDEndTransferEvent func(sender *OpenID, args *OpenIDEndTransferEventArgs) func (obj *OpenID) GetOnEndTransferHandler() OpenIDEndTransferEvent func (obj *OpenID) SetOnEndTransferHandler(handlerFunc OpenIDEndTransferEvent) ``` ## Remarks This event is fired first when the client finishes sending data to the server (in a *POST* or *PUT* request) and then when the document text finishes transferring from the server to the local host. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # Error Event ([OpenID](#openid-component) Component) Fired when information is available about errors during data delivery. ## Syntax *Go Syntax* ```text // OpenIDErrorEventArgs carries the OpenID Error event's parameters. type OpenIDErrorEventArgs struct {...} func (args *OpenIDErrorEventArgs) ErrorCode() int32 func (args *OpenIDErrorEventArgs) Description() string // OpenIDErrorEvent defines the signature of the OpenID Error event's handler function. type OpenIDErrorEvent func(sender *OpenID, args *OpenIDErrorEventArgs) func (obj *OpenID) GetOnErrorHandler() OpenIDErrorEvent func (obj *OpenID) SetOnErrorHandler(handlerFunc OpenIDErrorEvent) ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error. The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-openid-component) section. # Header Event ([OpenID](#openid-component) Component) Fired every time a header line comes in. ## Syntax *Go Syntax* ```text // OpenIDHeaderEventArgs carries the OpenID Header event's parameters. type OpenIDHeaderEventArgs struct {...} func (args *OpenIDHeaderEventArgs) Field() string func (args *OpenIDHeaderEventArgs) Value() string // OpenIDHeaderEvent defines the signature of the OpenID Header event's handler function. type OpenIDHeaderEvent func(sender *OpenID, args *OpenIDHeaderEventArgs) func (obj *OpenID) GetOnHeaderHandler() OpenIDHeaderEvent func (obj *OpenID) SetOnHeaderHandler(handlerFunc OpenIDHeaderEvent) ``` ## Remarks The *Field* parameter contains the name of the HTTP header (which is the same as it is delivered). The *Value* parameter contains the header contents. If the header line being retrieved is a continuation header line, then the *Field* parameter contains "" (empty string). # LaunchBrowser Event ([OpenID](#openid-component) Component) Fires before launching a browser with the authorization URL. ## Syntax *Go Syntax* ```text // OpenIDLaunchBrowserEventArgs carries the OpenID LaunchBrowser event's parameters. type OpenIDLaunchBrowserEventArgs struct {...} func (args *OpenIDLaunchBrowserEventArgs) URL() string func (args *OpenIDLaunchBrowserEventArgs) SetURL(value string) func (args *OpenIDLaunchBrowserEventArgs) Command() string func (args *OpenIDLaunchBrowserEventArgs) SetCommand(value string) // OpenIDLaunchBrowserEvent defines the signature of the OpenID LaunchBrowser event's handler function. type OpenIDLaunchBrowserEvent func(sender *OpenID, args *OpenIDLaunchBrowserEventArgs) func (obj *OpenID) GetOnLaunchBrowserHandler() OpenIDLaunchBrowserEvent func (obj *OpenID) SetOnLaunchBrowserHandler(handlerFunc OpenIDLaunchBrowserEvent) ``` ## Remarks When the [ClientProfile](#clientprofile-property-openid-component) property is set to ocpApplication and [GetAuthorization](#getauthorization-method-openid-component) is called, the struct will fire this event with the *Command*, which will be executed by the struct. The *URL* parameter will be the authorization URL that the user will be directed to authenticate. Within this event, you may override the current value of either *Command* or *URL* and provide your own value. If *Command* is set to an empty string, the struct will not attempt to launch the browser and instead you will be responsible for directing the user to the authorization URL specified by the URL parameter. If *Command* is not empty, the URL will be appended to the end. In Windows, ShellExecute is used to execute *Command*, which limits the verbs available for use in *Command* to: - edit - explore - find - open - print # Log Event ([OpenID](#openid-component) Component) Fired once for each log message. ## Syntax *Go Syntax* ```text // OpenIDLogEventArgs carries the OpenID Log event's parameters. type OpenIDLogEventArgs struct {...} func (args *OpenIDLogEventArgs) LogLevel() int32 func (args *OpenIDLogEventArgs) Message() string func (args *OpenIDLogEventArgs) LogType() string // OpenIDLogEvent defines the signature of the OpenID Log event's handler function. type OpenIDLogEvent func(sender *OpenID, args *OpenIDLogEventArgs) func (obj *OpenID) GetOnLogHandler() OpenIDLogEvent func (obj *OpenID) SetOnLogHandler(handlerFunc OpenIDLogEvent) ``` ## Remarks This event is fired once for each log message generated by the struct. The verbosity is controlled by the [LogLevel](#LogLevel) setting. *LogLevel* indicates the level of message. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). *Message* is the log entry. *LogType* identifies the type of log entry. Possible values are as follows: - "Info" - "RequestHeaders" - "ResponseHeaders" - "RequestBody" - "ResponseBody" - "ProxyRequest" - "ProxyResponse" - "FirewallRequest" - "FirewallResponse" # Redirect Event ([OpenID](#openid-component) Component) Fired when a redirection is received from the server. ## Syntax *Go Syntax* ```text // OpenIDRedirectEventArgs carries the OpenID Redirect event's parameters. type OpenIDRedirectEventArgs struct {...} func (args *OpenIDRedirectEventArgs) Location() string func (args *OpenIDRedirectEventArgs) Accept() bool func (args *OpenIDRedirectEventArgs) SetAccept(value bool) // OpenIDRedirectEvent defines the signature of the OpenID Redirect event's handler function. type OpenIDRedirectEvent func(sender *OpenID, args *OpenIDRedirectEventArgs) func (obj *OpenID) GetOnRedirectHandler() OpenIDRedirectEvent func (obj *OpenID) SetOnRedirectHandler(handlerFunc OpenIDRedirectEvent) ``` ## Remarks This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The *Accept* parameter is always True by default, but if you do not want to follow the redirection, *Accept* may be set to False, in which case the struct fails with an error. *Location* is the location to which the client is being redirected. Further control over redirection is provided in the [FollowRedirects](#followredirects-property-openid-component) property. # ReturnURL Event ([OpenID](#openid-component) Component) Fired when the user is redirected to the embedded web server. ## Syntax *Go Syntax* ```text // OpenIDReturnURLEventArgs carries the OpenID ReturnURL event's parameters. type OpenIDReturnURLEventArgs struct {...} func (args *OpenIDReturnURLEventArgs) URLPath() string func (args *OpenIDReturnURLEventArgs) QueryString() string func (args *OpenIDReturnURLEventArgs) State() string func (args *OpenIDReturnURLEventArgs) ResponseHeaders() string func (args *OpenIDReturnURLEventArgs) SetResponseHeaders(value string) func (args *OpenIDReturnURLEventArgs) ResponseBody() string func (args *OpenIDReturnURLEventArgs) SetResponseBody(value string) // OpenIDReturnURLEvent defines the signature of the OpenID ReturnURL event's handler function. type OpenIDReturnURLEvent func(sender *OpenID, args *OpenIDReturnURLEventArgs) func (obj *OpenID) GetOnReturnURLHandler() OpenIDReturnURLEvent func (obj *OpenID) SetOnReturnURLHandler(handlerFunc OpenIDReturnURLEvent) ``` ## Remarks When [ClientProfile](#clientprofile-property-openid-component) is set to ocpApplication and the embedded web server is used (default), this event will fire when the user is redirected from authorization server back to the local embedded web server. The event provides an opportunity to set the *ResponseHeaders* and *ResponseBody* and provide a custom response that the user will see in their browser. *URLPath* and *QueryString* are informational parameters that show the values sent by the authorization server. *State* holds the value of the state parameter that was originally sent with the authorization request. This may be used to maintain state between the request and response. See [State](#state-property-openid-component) for more details. # SetCookie Event ([OpenID](#openid-component) Component) Fired for every cookie set by the server. ## Syntax *Go Syntax* ```text // OpenIDSetCookieEventArgs carries the OpenID SetCookie event's parameters. type OpenIDSetCookieEventArgs struct {...} func (args *OpenIDSetCookieEventArgs) Name() string func (args *OpenIDSetCookieEventArgs) Value() string func (args *OpenIDSetCookieEventArgs) Expires() string func (args *OpenIDSetCookieEventArgs) Domain() string func (args *OpenIDSetCookieEventArgs) Path() string func (args *OpenIDSetCookieEventArgs) Secure() bool // OpenIDSetCookieEvent defines the signature of the OpenID SetCookie event's handler function. type OpenIDSetCookieEvent func(sender *OpenID, args *OpenIDSetCookieEventArgs) func (obj *OpenID) GetOnSetCookieHandler() OpenIDSetCookieEvent func (obj *OpenID) SetOnSetCookieHandler(handlerFunc OpenIDSetCookieEvent) ``` ## Remarks This event is fired for every *Set-Cookie:* header received from the HTTP server. The *Name* parameter contains the name of the cookie, with the corresponding value supplied in the *Value* parameter. The *Expires* parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the *Expires* parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session. The *Domain* parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the *Domain* parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain. The *Path* parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the *Path* parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path. The *Secure* parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection. # SSLServerAuthentication Event ([OpenID](#openid-component) Component) Fired after the server presents its certificate to the client. ## Syntax *Go Syntax* ```text // OpenIDSSLServerAuthenticationEventArgs carries the OpenID SSLServerAuthentication event's parameters. type OpenIDSSLServerAuthenticationEventArgs struct {...} func (args *OpenIDSSLServerAuthenticationEventArgs) CertEncoded() []byte func (args *OpenIDSSLServerAuthenticationEventArgs) CertSubject() string func (args *OpenIDSSLServerAuthenticationEventArgs) CertIssuer() string func (args *OpenIDSSLServerAuthenticationEventArgs) Status() string func (args *OpenIDSSLServerAuthenticationEventArgs) Accept() bool func (args *OpenIDSSLServerAuthenticationEventArgs) SetAccept(value bool) // OpenIDSSLServerAuthenticationEvent defines the signature of the OpenID SSLServerAuthentication event's handler function. type OpenIDSSLServerAuthenticationEvent func(sender *OpenID, args *OpenIDSSLServerAuthenticationEventArgs) func (obj *OpenID) GetOnSSLServerAuthenticationHandler() OpenIDSSLServerAuthenticationEvent func (obj *OpenID) SetOnSSLServerAuthenticationHandler(handlerFunc OpenIDSSLServerAuthenticationEvent) ``` ## Remarks During this event, the client can decide whether or not to continue with the connection process. The *Accept* parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue. When *Accept* is False, *Status* shows why the verification failed (otherwise, *Status* contains the string *OK*). If it is decided to continue, you can override and accept the certificate by setting the *Accept* parameter to True. # SSLStatus Event ([OpenID](#openid-component) Component) Fired when secure connection progress messages are available. ## Syntax *Go Syntax* ```text // OpenIDSSLStatusEventArgs carries the OpenID SSLStatus event's parameters. type OpenIDSSLStatusEventArgs struct {...} func (args *OpenIDSSLStatusEventArgs) Message() string // OpenIDSSLStatusEvent defines the signature of the OpenID SSLStatus event's handler function. type OpenIDSSLStatusEvent func(sender *OpenID, args *OpenIDSSLStatusEventArgs) func (obj *OpenID) GetOnSSLStatusHandler() OpenIDSSLStatusEvent func (obj *OpenID) SetOnSSLStatusHandler(handlerFunc OpenIDSSLStatusEvent) ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # StartTransfer Event ([OpenID](#openid-component) Component) Fired when a document starts transferring (after the headers). ## Syntax *Go Syntax* ```text // OpenIDStartTransferEventArgs carries the OpenID StartTransfer event's parameters. type OpenIDStartTransferEventArgs struct {...} func (args *OpenIDStartTransferEventArgs) Direction() int32 // OpenIDStartTransferEvent defines the signature of the OpenID StartTransfer event's handler function. type OpenIDStartTransferEvent func(sender *OpenID, args *OpenIDStartTransferEventArgs) func (obj *OpenID) GetOnStartTransferHandler() OpenIDStartTransferEvent func (obj *OpenID) SetOnStartTransferHandler(handlerFunc OpenIDStartTransferEvent) ``` ## Remarks This event is fired first when the client starts sending data to the server (in a *POST* or *PUT* request) and then when the document text starts transferring from the server to the local host. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # Status Event ([OpenID](#openid-component) Component) Fired when the HTTP status line is received from the server. ## Syntax *Go Syntax* ```text // OpenIDStatusEventArgs carries the OpenID Status event's parameters. type OpenIDStatusEventArgs struct {...} func (args *OpenIDStatusEventArgs) HTTPVersion() string func (args *OpenIDStatusEventArgs) StatusCode() int32 func (args *OpenIDStatusEventArgs) Description() string // OpenIDStatusEvent defines the signature of the OpenID Status event's handler function. type OpenIDStatusEvent func(sender *OpenID, args *OpenIDStatusEventArgs) func (obj *OpenID) GetOnStatusHandler() OpenIDStatusEvent func (obj *OpenID) SetOnStatusHandler(handlerFunc OpenIDStatusEvent) ``` ## Remarks *HTTPVersion* is a string containing the HTTP version string as returned from the server (e.g., "1.1"). *StatusCode* contains the HTTP status code (e.g., 200), and *Description* the associated message returned by the server (e.g., "OK"). # Transfer Event ([OpenID](#openid-component) Component) Fired while a document transfers (delivers document). ## Syntax *Go Syntax* ```text // OpenIDTransferEventArgs carries the OpenID Transfer event's parameters. type OpenIDTransferEventArgs struct {...} func (args *OpenIDTransferEventArgs) Direction() int32 func (args *OpenIDTransferEventArgs) BytesTransferred() int64 func (args *OpenIDTransferEventArgs) PercentDone() int32 func (args *OpenIDTransferEventArgs) Text() []byte // OpenIDTransferEvent defines the signature of the OpenID Transfer event's handler function. type OpenIDTransferEvent func(sender *OpenID, args *OpenIDTransferEventArgs) func (obj *OpenID) GetOnTransferHandler() OpenIDTransferEvent func (obj *OpenID) SetOnTransferHandler(handlerFunc OpenIDTransferEvent) ``` ## Remarks The *Text* parameter contains the portion of the document text being received. It is empty if data are being posted to the server. The *BytesTransferred* parameter contains the number of bytes transferred in this *Direction* since the beginning of the document text (excluding HTTP response headers). The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. The *PercentDone* parameter shows the progress of the transfer in the corresponding direction. If *PercentDone* can not be calculated the value will be -1. NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance. # Config Settings ([OpenID](#openid-component) Component) The struct 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 struct, access to these *internal properties* is provided through the [Config](#config-method-openid-component) method. ### OpenID Config Settings **Display**: The requested display options to present to the end user.This optional setting specifies the display options that the authorization server should display to the user. Possible values are: | | | | --- | --- | | page | The Authorization Server SHOULD display the authentication and consent UI consistent with a full User Agent page view. If the display parameter is not specified, this is the default display mode. | | popup | The Authorization Server SHOULD display the authentication and consent UI consistent with a popup User Agent window. The popup User Agent window should be of an appropriate size for a login-focused dialog and should not obscure the entire window that it is popping up over. | | touch | The Authorization Server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface. | | wap | The Authorization Server SHOULD display the authentication and consent UI consistent with a "feature phone" type display. | The authorization server may choose to use another method to determine how to interact with the user. **IdToken**: The raw ID Token returned after authorization.This setting returns the raw ID Token returned by the authorization server after a call to [GetAuthorization](#getauthorization-method-openid-component). This value may be used in subsequent requests as the value for the [IdTokenHint](#IdTokenHint) setting. **IdTokenHint**: An ID Token value to be used as a hint about the user's session.This setting may be specified before calling [GetAuthorization](#getauthorization-method-openid-component) to pass an ID Token as a hint about the user's current or past authenticated session. If the user identified by the ID Token present here is logged in, then the authorization server should return a positive response. If [Prompt](#Prompt) is set to *none* this value should be set. The value for this setting is the raw [IdToken](#IdToken) received from a previous authorization. **IdTokenValidationFlags**: The checks that are ignored when validating an ID Token.Informs the struct to skip certain checks when validating an ID Token. The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions: | | | | --- | --- | | 0x00000001 | Ignore the issuer (iss) claim. | | 0x00000002 | Ignore the audience (aud) claim. | | 0x00000004 | Ignore the expiration (exp) claim. | | 0x00000008 | Ignore the JWT signature. | | 0x00000010 | Ignore the "issued at" (iat) claim. | | 0x00000020 | Ignore the "not before" (nbf) claim. | | 0x00000040 | Ignore the nonce (nonce) claim. | **LoginHint**: The login hint sent to the authorization server.This setting optionally specifies an identifier of the end-user which may be used as a hint to the authorization server about the user's identity. For instance this may be the email address or phone number of a user. The authorization may or may not use the value provided. This setting corresponds to the *login_hint* request parameter. **Nonce**: The nonce value that is used to verify an ID Token.This setting provides the value of the Nonce parameter that is provided to the OpenID Provider when making a request and the value that should be used for validation when validating an ID Token. If left blank when [UseNonce](#UseNonce) is set to true, the struct will generate a new one. When validating an ID Token with the *nonce* claim, the struct will check the claim against this setting. If the instance of the struct that generated the authorization request is different than the instance of the struct that is doing the validating, then this configuration setting will need to be set again. If the struct generates the nonce value, then the application will need to save the original nonce value in a safe location specific to the user authenticating. **Prompt**: The requested conditions under which the authorization server prompts for login.This optional setting specifies the conditions under which the authorization server should prompt for login. The value specifies here is a space delimited, case sensitive list of one or more of the following values. For instance: *login consent*. Possible values are: | | | | --- | --- | | none | The Authorization Server MUST NOT display any authentication or consent user interface pages. An error is returned if an End-User is not already authenticated or the Client does not have pre-configured consent for the requested Claims or does not fulfill other conditions for processing the request. The error code will typically be login_required, interaction_required, or another code defined in Section 3.1.2.6 of the OpenID specification. This can be used as a method to check for existing authentication and/or consent. | | login | The Authorization Server SHOULD prompt the End-User for reauthentication. If it cannot reauthenticate the End-User, it MUST return an error, typically login_required. | | consent | The Authorization Server SHOULD prompt the End-User for consent before returning information to the Client. If it cannot obtain consent, it MUST return an error, typically consent_required. | | select_account | The Authorization Server SHOULD prompt the End-User to select a user account. This enables an End-User who has multiple accounts at the Authorization Server to select amongst the multiple accounts that they might have current sessions for. If it cannot obtain an account selection choice made by the End-User, it MUST return an error, typically account_selection_required. | The prompt parameter can be used to make sure that the End-User is still present for the current session or to bring attention to the request. If this parameter contains *none* with any other value, an error is returned. **RawJSON**: A JSON string holding the last response.This setting may be queried to retrieve the last response as a JSON string. The value returned by this setting depends on the most recently called method. After [GetDiscoveryDoc](#getdiscoverydoc-method-openid-component) is called this method returns the entire discovery document JSON. After [GetAuthorization](#getauthorization-method-openid-component) is called this method returns the ID Token JSON. After [GetUserInfo](#getuserinfo-method-openid-component) is called this method returns the response JSON. **ResponseType**: The value of the response_type request parameter.This setting optionally specifies the value of the *response_type* request parameter. When [GrantType](#granttype-property-openid-component) is set a value for the *response_type* is automatically chosen. If a different value is desired it may be specified here. The table below illustrates the default and possible values. | | | | | --- | --- | --- | | [GrantType](#granttype-property-openid-component) | Default value | Possible values | | 0 (Authorization Code) | code | code | | 1 (Implicit) | id_token token | id_tokenid_token token | | 2 (Hybrid) | code id_token | code id_tokencode tokencode id_token token | **UseNonce**: Whether the Nonce parameter is added.If this config is set to true, the *nonce* parameter will be added to the authorization request when [GetAuthorizationURL](#getauthorizationurl-method-openid-component) is called. In OpenID Connect, the *nonce* parameter is provided during the authorization request. Then, when the OpenID Provider issues an ID Token, they will include the *nonce* claim with the same value (similar to [State](#state-property-openid-component)). If the [Nonce](#Nonce) configuration setting is not set before calling [GetAuthorizationURL](#getauthorizationurl-method-openid-component) the struct will generate a new one and set the [Nonce](#Nonce) setting. When the struct validates an ID Token, it will check the [Nonce](#Nonce) configuration setting if a *nonce* claim is found. By default, the *nonce* claim is not required but setting this property to true will require the *nonce* claim to be present and match the [Nonce](#Nonce) configuration setting. **XChildCount**: The number of child elements of the current element.This configuration settings specifies the number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to ([XChildCount](#XChildCount) - 1). The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XChildName[i]**: The name of the child element.This configuration setting provides the name of the i-th child element of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XChildXText[i]**: The inner text of the child element.This configuration setting provides the inner text of the i-th child element of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XElement**: The name of the current element.This configuration setting provides the name of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XParent**: The parent of the current element.This configuration setting provides the parent of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XPath**: Provides a way to point to a specific element in the returned XML or JSON response.The [XPath](#XPath) setting allows you to point to specific elements in the XML or JSON response. When [XPath](#XPath) is set to a valid path, [XElement](#XElement) points to the name of the element, with [XText](#XText), [XParent](#XParent), [XSubTree](#XSubTree), [XChildCount](#XChildCount), [XChildName\[i\]](#XChildName[i]), and [XChildXText\[i\]](#XChildXText[i]) providing other properties of the element. XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the */* character, for example, */A/B/C/D*. An XPath can be absolute (i.e., it starts with */*), or it can be relative to the current [XPath](#XPath) location. The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors, which proceed it in the overall XPath string: | Accessor | Description | | --- | --- | | name | The first element with a particular name. Can be *. | | [i] | The i-th element. | | name[i] | The i-th element with a particular name. | | [last()] | The last element. | | [last()-i] | The element i before the last element. | | name[@attrname="attrvalue"] | The first element with a particular name that contains the specified attribute-value pair. Supports single and double quotes. (XML Only) | | . | The current element. | | .. | The parent element. | NOTE: XPath indices are *1-based*. For example, assume the following XML and JSON responses. XML: ```text value first second value three ``` JSON: ```text { "firstlevel": { "one": "value", "two": ["first", "second"], "three": "value three" } } ``` The following are examples of valid XPaths for these responses: | Description | XML XPath | JSON XPath | | --- | --- | --- | | Document root | / | /json | | Specific element | /firstlevel/one | /json/firstlevel/one | | i-th child | /firstlevel/two/item[2] | /json/firstlevel/two/[2] | This list is not exhaustive, but it provides a general idea of the possibilities. **XSubTree**: A snapshot of the current element in the document.This configuration setting provides the entirety of the current element (including its subelements). The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XText**: The text of the current element.This configuration setting provides the inner text of the current element. The current element is specified in the [XPath](#XPath) configuration setting. This configuration setting is read-only. ### OAuth Config Settings **AuthMethod**: Specifies how the client credentials are sent to the token server.This configuration setting specifies how the [ClientId](#clientid-property-openid-component) and [ClientSecret](#clientsecret-property-openid-component) are provided when making a request to the token server. By default (0) the [ClientId](#clientid-property-openid-component) and [ClientSecret](#clientsecret-property-openid-component) are provided to the token server through the *client_id* and *client_secret* form parameters. If set to 1, then the component will provide the [ClientId](#clientid-property-openid-component) and [ClientSecret](#clientsecret-property-openid-component) through the basic *Authorization* HTTP header. Note that this does not apply when the [GrantType](#granttype-property-openid-component) property is set to **ogtClientCredentials**, where the [IncludeClientCredsInBody](#IncludeClientCredsInBody) setting should be used instead. **AuthorizationTokenType**: The type of access token returned.Applicable values for this configuration setting include the following: | | | | --- | --- | | Bearer (default) | When the access token returned by the server is a Bearer type, the authorization string returned by [GetAuthorization](#getauthorization-method-openid-component) will be in the format "Bearer access_token". This can be supplied as the value of the HTTP authorization header. | **DeviceGrantType**: The grant type to be used when the ClientProfile is set to ocpDevice.This configuration setting is used to specify a different grant type to use for device flow. By default this is set to "http://oauth.net/grant_type/device/1.0". Another commonly used grant type is "urn:ietf:params:oauth:grant-type:device_code". **DeviceUserCode**: The device's user code when the ClientProfile is set to ocpDevice.When [ClientProfile](#clientprofile-property-openid-component) is set to ocpDevice and [GetAuthorizationURL](#getauthorizationurl-method-openid-component) is called, the struct will request a device user code from the server specified by [ServerAuthURL](#serverauthurl-property-openid-component). This configuration setting will be populated with the device user code returned by the server. Provide this value along with the URL returned by [GetAuthorizationURL](#getauthorizationurl-method-openid-component) to the user. **FormVarCount**: Specifies the number of additional form variables to include in the request.This configuration setting may be used to specify additional form variables made in the request to exchange [AuthorizationCode](#authorizationcode-property-openid-component) for an access token. This is useful in cases in which the OAuth server requires additional fields. This is used in conjunction with [FormVarName\[i\]](OAuth.md#FormVarName[i]) and [FormVarValue\[i\]](OAuth.md#FormVarValue[i]). For instance: ```text component.Config("FormVarCount=2"); component.Config("FormVarName[0]=myvar"); component.Config("FormVarValue[0]=myvalue"); component.Config("FormVarName[1]=testname"); component.Config("FormVarValue[1]=testvalue"); ``` The value will be URL encoded by the struct **FormVarName[i]**: Specifies the form variable name at the specified index.This configuration setting specifies the form variable name at the index specified. See [FormVarCount](#FormVarCount) for details. **FormVarValue[i]**: Specifies the form variable value at the specified index.This configuration setting specifies the form variable value at the index specified. See [FormVarCount](#FormVarCount) for details. **IncludeClientCredsInBody**: Whether to include the client credentials in the header or request body.This configuration setting specifies whether the [ClientId](#clientid-property-openid-component) and [ClientSecret](#clientsecret-property-openid-component) properties are included in the authorization header or the request body when a request is made by [GetAuthorization](#getauthorization-method-openid-component). This only applies to request when the [GrantType](#granttype-property-openid-component) property is set to **ogtClientCredentials**. If set to False (default), the credentials are provided through the authorization header. If set to True, the credentials are added as form entries to the request body. **IncludeEmptyRedirectURI**: Whether an empty redirect_uri parameter is included in requests.This configuration setting specifies whether *redirect_uri* is included in the request made by [GetAuthorization](#getauthorization-method-openid-component) if it is empty. In most cases, redirect_uri will contain a value and will be sent; if, however, [ClientProfile](#clientprofile-property-openid-component) is set to Mobile or Device, this will be empty. If set to True (default), the *redirect_uri* will be sent in all cases. If set to False, the *redirect_uri* will be sent only if it has a value. **JWTAudience**: The JWT audience when the ClientProfile is set to ocpJWT.This configuration setting specifies the audience that the JWT is intended for. This is required when [ClientProfile](#clientprofile-property-openid-component) is set to ocpJWT. When using Google service accounts, this value must be "https://www.googleapis.com/oauth2/v3/token". **JWTCertStore**: The name of the certificate store for the JWT signing certificate.The is the name of the certificate store for the JWT signing certificate. The [JWTCertStoreType](#JWTCertStoreType) field specifies the type of certificate store specified by [JWTCertStore](#JWTCertStore). If the store is password protected, specify the password in [JWTCertStorePassword](#JWTCertStorePassword). [JWTCertStore](#JWTCertStore) is used in conjunction with the [JWTCertSubject](#JWTCertSubject) field to specify the JWT signing certificate. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). NOTE: This is required when [ClientProfile](#clientprofile-property-openid-component) is set to ocpJWT. **JWTCertStorePassword**: The JWT signing certificate password.If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store. NOTE: This is applicable only when [ClientProfile](#clientprofile-property-openid-component) is set to ocpJWT. **JWTCertStoreType**: The type of certificate store.This configuration specifies the type of certificate store. Possible values are as follows: | | | | --- | --- | | 0 | User - This is the default for Windows. This specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 | Machine - For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 | PFXFile - The certificate store is the name of a PFX (PKCS12) file containing certificates. | | 3 | PFXBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS12) format. | | 4 | JKSFile - The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is available only in Java. | | 5 | JKSBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is available only in Java. | | 6 | PEMKeyFile - The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 | PEMKeyBlob - The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 14 | PPKFile - The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 | PPKBlob - The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 | XMLFile - The certificate store is the name of a file that contains a certificate in XML format. | | 17 | XMLBlob - The certificate store is a string that contains a certificate in XML format. | NOTE: This is required when [ClientProfile](#clientprofile-property-openid-component) is set to ocpJWT. **JWTCertSubject**: The JWT signing certificate subject.The is the subject of the JWT signing certificate. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. NOTE: This is required when [ClientProfile](#clientprofile-property-openid-component) is set to ocpJWT. **JWTIssuer**: The JWT issuer when the ClientProfile is set to ocpJWT.This configuration setting specifies the issuer of the JWT (JSON Web Token). This is required when [ClientProfile](#clientprofile-property-openid-component) is set to ocpJWT. When using Google service accounts, this value is the email address of the service account. **JWTJSONKey**: The data or file path of the JWT JSON Key.This configuration setting specifies the file path of the JWT JSON Key, or a string containing its content, provided for the service account. If this setting is specified, the struct will attempt to parse the values for [ClientId](#clientid-property-openid-component), [JWTAudience](#JWTAudience), [JWTCertStore](#JWTCertStore), [JWTIssuer](#JWTIssuer), [ServerAuthURL](#serverauthurl-property-openid-component), and [ServerTokenURL](#servertokenurl-property-openid-component) from the JSON data. It will also initialize the values for [JWTCertStoreType](#JWTCertStoreType), [JWTCertStorePassword](#JWTCertStorePassword), and [JWTCertSubject](#JWTCertSubject). **JWTPayload**: The payload of the JWT access token, if present.This configuration setting provides the payload section of a JWT access token if the access token is a JWT and the struct is able to parse out the payload section. This setting only applies to **access tokens** that are returned from a service provider after successfully authorizing and authenticating with the service. This setting is not used when setting up the struct for authentication when the [ClientProfile](#clientprofile-property-openid-component) is set to ocpJWT. To parse the payload for specific claims, see [JWTXPath](#JWTXPath). **JWTServiceProvider**: The service provider to which authentication is being performed.This configuration setting specifies the service provider that is being authenticated to. Possible values are as follows: - 0 (Google - Default) - 1 (Microsoft) NOTE: This is required when [ClientProfile](#clientprofile-property-openid-component) is set to ocpJWT. **JWTSignatureAlgorithm**: The signature algorithm used to sign the JWT.This configuration setting specifies the signature algorithm used to sign the JWT. Possible values are as follows: - RSA-SHA256 NOTE: This is applicable only when [ClientProfile](#clientprofile-property-openid-component) is set to ocpJWT. **JWTSubject**: The subject field in the JWT.This configuration setting optionally specifies the subject field in the JWT. For Google service accounts, this is the email address of the user for which the application is requesting delegated access. The meaning of this value varies from service to service. Please consult the documentation for the service to which you are authenticating to determine if the "sub" field is applicable. **JWTValidityTime**: The amount of time in seconds for which the assertion in the JWT is valid.The is the amount of time in seconds for which the assertion in the JWT is valid. The default value is 3600 (one hour). NOTE: This is applicable only when [ClientProfile](#clientprofile-property-openid-component) is set to ocpJWT. **JWTXChildCount**: The number of child elements of the current element.The number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to ([JWTXChildCount](#JWTXChildCount) - 1). The current element is specified in the [JWTXPath](#JWTXPath) configuration setting. This configuration setting is read-only. **JWTXChildName[i]**: The name of the child element.Provides the name of the i'th child element of the current element. The current element is specified in the [JWTXPath](#JWTXPath) configuration setting. This configuration setting is read-only. **JWTXChildXText[i]**: The inner text of the child element.Provides the inner text of the i'th child element of the current element. The current element is specified in the [JWTXPath](#JWTXPath) configuration setting. This configuration setting is read-only. **JWTXElement**: The name of the current element.Provides the name of the current element. The current element is specified in the [JWTXPath](#JWTXPath) configuration setting. This configuration setting is read-only. **JWTXParent**: The parent of the current element.Provides the parent of the current element. The current element is specified in the [JWTXPath](#JWTXPath) configuration setting. This configuration setting is read-only. **JWTXPath**: Points to a specific element in the returned payload of a JWT based access token.The [JWTXPath](#JWTXPath) setting allows you to point to specific claims within the payload of a JWT based access token. XPath syntax is available for the payload of JWT based access tokens if available. An XPath is a series of one or more element accessors separated by the */* character, for example: */A/B/C/D*. The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string: | Accessor | Description | | --- | --- | | name | The first element with a particular name. Can be *. | | [i] | The i-th element. | | name[i] | The i-th element with a particular name. | | [last()] | The last element. | | [last()-i] | The element i before the last element. | Here are some examples of valid XPaths and some common claims: | Description | JSON XPath | | --- | --- | | Document root | /json | | Specific element | /json/element_one | | Username Claim (Microsoft Specific) | /json/preferred_username | | Registered Application Name Claim (Microsoft Specific) | /json/app_displayname | This is not an exhaustive list by any means, but should provide a general idea of the possibilities. To get the text of the specified element, see [JWTXText](#JWTXText). **JWTXSubTree**: A snapshot of the current element in the document.Provides the entirety of the current element (including its sub-elements). The current element is specified in the [JWTXPath](#JWTXPath) configuration setting. This configuration setting is read-only. **JWTXText**: The text of the current element.Provides the inner text of the current element. The current element is specified in the [JWTXPath](#JWTXPath) configuration setting. This configuration setting is read-only. **Microsoft365AdminConsentError**: The error message returned when the admin denies consent to the scopes.When using the Microsoft365AdminConsent profile, this configuration setting will hold the error message in the event that the admin does not consent to the scope of the application. This configuration setting is read-only. **Microsoft365AdminConsentErrorDesc**: The error description returned when the admin denies consent to the scopes.When using the Microsoft365AdminConsent profile, this configuration setting will hold the description of the error message in the event that the admin does not consent to the scope of the application. This configuration setting is read-only. **Microsoft365AdminConsentTenant**: The tenant ID returned after the admin consents to the scopes.When using the Microsoft365AdminConsent profile, this configuration setting will hold the tenant Id that is returned after the admin consents to the scopes. This configuration setting is read-only. **Office365ServiceAPIVersion**: The API version of the Office 365 service being discovered.This configuration setting specifies the API version of the Office 365 service for which a search is initiated. See [Office365ServiceEndpoint](#Office365ServiceEndpoint) for details. **Office365ServiceCapability**: The API capability of the Office 365 service being discovered.This configuration setting specifies the capability of the Office 365 service for which a search is initiated. See [Office365ServiceEndpoint](#Office365ServiceEndpoint) for details. **Office365ServiceEndpoint**: The Office 365 endpoint for the service that matches the criteria specified.When obtaining authorization to access an Office 365 resource, it may be necessary to discover a list of services that match a certain criteria and then select a specific resource from that list. For instance, OneDrive for Business requires discovery of the Office 365 service that can be used with the OneDrive API. When [GetAuthorization](#getauthorization-method-openid-component) is called, if [Office365ServiceAPIVersion](#Office365ServiceAPIVersion) and [Office365ServiceCapability](#Office365ServiceCapability) are specified, the struct will attempt to discover the Office 365 services for which the user has access and find a service that matches the requirements specified in [Office365ServiceAPIVersion](#Office365ServiceAPIVersion) and [Office365ServiceCapability](#Office365ServiceCapability). If a service is found, the struct will then obtain authorization to access that service. If authorization is successful, [Office365ServiceEndpoint](#Office365ServiceEndpoint) will hold the service endpoint URL to which requests should be made. **Example. OneDrive for Business:** ```text oauth.Config("Office365ServiceCapability=MyFiles"); oauth.Config("Office365ServiceAPIVersion=v2.0"); string authString = oauth.GetAuthorization(); string endpointURL = oauth.Config("Office365ServiceEndpoint"); ``` **PasswordGrantUsername**: The Username field when using the password grant type.This configuration setting is used to set the username field when the [GrantType](#granttype-property-openid-component) is set to the password grant type and [GetAuthorization](#getauthorization-method-openid-component) is called. **PKCEChallengeEncoding**: The PKCE code challenge method to use.This configuration setting controls the PKCE code challenge method used when [UsePKCE](#usepkce-property-openid-component) is set to True. This value controls the PKCE code challenge method. Possible values are as follows: - 1 (Plain) - 2 (S256/SHA256 - default) **PKCEVerifier**: The PKCE verifier used to generate the challenge.This configuration setting when queried provides the PKCE verifier that is used to generate the PKCE challenge for the [GetAuthorization](#getauthorization-method-openid-component) and [GetAuthorizationURL](#getauthorizationurl-method-openid-component) methods when [UsePKCE](#usepkce-property-openid-component) is set to true. When using the ocpWeb [ClientProfile](#clientprofile-property-openid-component), the configuration setting can be set instead to allow the authorization request to be made from a different instance than the authentication (token) request. **PollingInterval**: The interval in seconds between polling requests when the device client profile is used.When [ClientProfile](#clientprofile-property-openid-component) is set to ocpDevice, this configuration setting determines the interval (in seconds) between polling requests made to [ServerTokenURL](#servertokenurl-property-openid-component). The default value is 5. **ResponseMode**: The value of the response_mode parameter.This configuration setting is used to set the response_mode parameter when building the authorization URL after calling [GetAuthorization](#getauthorization-method-openid-component) or [GetAuthorizationURL](#getauthorizationurl-method-openid-component). If left empty (default) the parameter will not be set in the request. This informs the authorization server to use the defaults described by the OAuth 2.0 specification. For authorization code, this will be the *query* mode. For implicit, this will typically be the *fragment* mode. Support modes are as follows: | Mode | Description | | --- | --- | | query | The response parameters are encoded in a query string when the user is redirected back to the struct. | | fragment | The response parameters are encoded in a fragment when the user is redirected back to the struct. | | form_post | The response parameters are encoded as HTML form values and posted (rather than redirected) back to the struct. This mode is an extension of the OAuth 2.0 protocol and may not be supported by the authorization server. | **TokenInfoFieldCount**: The number of fields in the tokeninfo service response.This configuration setting returns the number of fields present in the tokeninfo service response. This is populated after calling [ValidateToken](#ValidateToken). **TokenInfoFieldName[i]**: The name of the tokeninfo service response field.This configuration setting returns the name of the tokeninfo service response field specified by index *i*. Valid values are from 0 to [TokenInfoFieldCount](#TokenInfoFieldCount) -1. **TokenInfoFieldValue[i]**: The value of the tokeninfo service response field.This configuration setting returns the value of the tokeninfo service response field specified by index *i*. Valid values are from 0 to [TokenInfoFieldCount](#TokenInfoFieldCount) -1. **TokenInfoURL**: The URL of the tokeninfo service.This configuration setting specifies the URL of the tokeninfo service to which a request is made when [ValidateToken](#ValidateToken) is called. The default value is "https://www.googleapis.com/oauth2/v1/tokeninfo". **ValidateToken**: Validates the specified access token with a tokeninfo service.This configuration setting will post the [AccessToken](#accesstoken-property-openid-component) to the tokeninfo service specified by [TokenInfoURL](#TokenInfoURL). This allows a token to be queried for validity and other information before use. When this configuration setting is queried, the struct will immediately make a request to the server. [TokenInfoFieldCount](#TokenInfoFieldCount), [TokenInfoFieldName\[i\]](OAuth.md#TokenInfoFieldName[i]), and [TokenInfoFieldValue\[i\]](OAuth.md#TokenInfoFieldValue[i])] may be used to iterate over the fields in the response. ### WebServer Config Settings **BrowserResponseTimeout**: Specifies the amount of time to wait for a response from the browser.This configuration setting specifies the amount of time (in seconds) the component will wait for a response from the browser in the [LaunchBrowser](#launchbrowser-event-openid-component) event. The default value is 120. **ResponseCompanyImage**: A URL or full path to a company logo.This configuration setting specifies a URL or full path to a company logo. If set, the image will be displayed and will be a hyperlink to [ResponseCompanyURL](#ResponseCompanyURL). **ResponseCompanyURL**: A URL to the company website or similar resource.This configuration setting specifies a URL to the company website or similar resource. This is used in conjunction with [ResponseCompanyImage](#ResponseCompanyImage). **ResponseFailureHeading**: Short header text indicating failure.This configuration setting specifies short header text indicating failure. The default value is *Authorization Failed*. **ResponseFailureMessage**: A description for a failed authorization.This configuration setting specifies a description for a failed authorization. The default value is *Access to your account could not be authorized. Please check your user and connection details and try again.* **ResponseHelpURL**: A URL to a help page or other resource.This configuration setting specifies a URL to a help page or other resource. If set, a *Help* link will be displayed and point to this URL. **ResponseLicenseURL**: A URL to licensing terms.This configuration setting specifies a URL to licensing terms. If set, a *License* link will be displayed and point to this URL. **ResponseProductImage**: A URL or full path to a product image.This configuration setting specifies a URL or full path to a product image. If set, the image will be displayed and will be a hyperlink to [ResponseProductURL](#ResponseProductURL). **ResponseProductURL**: A URL to a product page or similar resource.This configuration setting specifies a URL to a product page or similar resource. This is used in conjunction with [ResponseProductImage](#ResponseProductImage). **ResponseSuccessHeading**: Short header text indicating success.This configuration setting specifies a short header text indicating success. The default value is *Authorization Successful*. **ResponseSuccessMessage**: A description for a successful authorization.This configuration setting specifies a description for a successful authorization. The default value is *Access to your account was successfully authorized. You may now close this window.* **WebServerFailedResponse**: The custom response that will be displayed to the user if authentication failed.When [GetAuthorization](#getauthorization-method-openid-component) is called, the user will be redirected to the embedded web server upon completing authentication with the authorization server. If authentication fails, the HTML specified here will be sent to the user's browser. **WebServerHost**: The hostname used by the embedded web server displayed in the ReturnURL.This configuration setting specifies the hostname used by the embedded web server when [ClientProfile](#clientprofile-property-openid-component) is set to ocpApplication. This specifies the interface on which the embedded web server listens and also the value displayed in the [ReturnURL](#returnurl-property-openid-component). This should be set to the hostname only, and not to the full URL. The default value is "localhost". **WebServerResponse**: The custom response that is displayed to the user.When [GetAuthorization](#getauthorization-method-openid-component) is called, the user will be redirected to the embedded web server upon completing authentication with the authorization server. This setting allows you to specify the HTML that will be sent to the user's browser. ### HTTP Config Settings **AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the struct adds an *Accept-Encoding* header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the *Accept-Encoding* header. NOTE: The struct only supports gzip and deflate decompression algorithms. **AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the struct will accept compressed data. It then will uncompress the data it has received. The struct will handle data compressed by both gzip and deflate compression algorithms. When True, the struct adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate". The default value is True. **AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0". If set to True (default), the struct will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the struct fails with an error if the server does not support HTTP/2. The default value is True. **Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False. **Authorization**: The Authorization string to be sent to the server.If the [Authorization](#Authorization) property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server. This property is provided so that the HTTP struct can be extended with other security schemes in addition to the authorization schemes already implemented by the struct. The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]". **BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the [Transfer](#transfer-event-openid-component) event, by [BytesTransferred](#BytesTransferred). **ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384. **CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request. The default value is False. **EncodeURL**: If set to True the URL will be encoded by the struct.If set to True, the URL passed to the struct will be URL encoded. The default value is False. **FollowRedirects**: Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the struct returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time. If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the struct fails with an error. **Note:** Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for *GET* or *HEAD* requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities. Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server. A [Redirect](#redirect-event-openid-component) event is fired for every URL the product is redirected to. In the case of automatic redirections, the [Redirect](#redirect-event-openid-component) event is a good place to set properties related to the new connection (e.g., new authentication parameters). The default value is 0 (Never). In this case, redirects are never followed, and the struct fails with an error instead. Following are the valid options: - 0 - Never - 1 - Always - 2 - Same Scheme **GetOn302Redirect**: If set to True the struct will perform a GET on the new location.The default value is False. If set to True, the struct will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again. **HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names. **HTTPVersion**: The version of HTTP used by the struct.This property specifies the HTTP version used by the struct. Possible values are as follows: - "1.0" - "1.1" (default) - "2.0" - "3.0" When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details. **HTTP/2 Notes** When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error. If the server does not support HTTP/2, the struct will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#AllowHTTPFallback) setting controls whether this behavior is allowed (default) or disallowed. **HTTP/3 Notes** HTTP/3 is supported only in .NET and Java. When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error. **IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: ```text Sat, 29 Oct 2017 19:43:31 GMT. ``` **KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *true*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *false*, the connection will be closed immediately after the server response is received. The default value for [KeepAlive](#KeepAlive) is *false*. **KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here. **LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the [Log](#log-event-openid-component) event. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). **MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When [FollowRedirects](#followredirects-property-openid-component) is set to any value other than frNever, the struct will follow redirects until this maximum number of redirect attempts are made. The default value is 20. **NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the struct will fall back to using "1.1" automatically. This setting will indicate which version was used. **OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers. The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF (*"\r\n"*) . Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail. This configuration setting is useful for extending the functionality of the struct beyond what is provided. **ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#Authorization) configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a *Proxy-Authorization* HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If [ProxyUser](#proxyuser-property-openid-component) and [ProxyPassword](#proxypassword-property-openid-component) are specified, this value is calculated using the algorithm specified by [ProxyAuthScheme](#proxyauthscheme-property-openid-component). **ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by structs that do not directly expose Proxy properties. **ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by structs that do not directly expose Proxy properties. **ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by structs that do not directly expose Proxy properties. **ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by structs that do not directly expose Proxy properties. **ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by structs that do not directly expose Proxy properties. **SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client. **StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server. **StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*. **TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server. **TransferredDataLimit**: The maximum number of incoming bytes to be stored by the struct.If [TransferredDataLimit](#TransferredDataLimit) is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the struct. **TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server. **TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request: .NET ```text Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); ``` C++ ```text HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest")); ``` **UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the struct will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the struct will not use HTTP-chunked encoding. The default value is False. NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding. **UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name). The default value is False and the hostname will always be used exactly as specified. NOTE: The [CodePage](#CodePage) setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set [CodePage](#CodePage) to *65001*. In the C++ Edition for Windows, the *W version of the class must be used. For instance, *DNSW* or *HTTPW*. **UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the struct will attempt to use the Proxy auto-config URL when establishing a connection and [ProxyAutoDetect](#proxyautodetect-property-openid-component) is set to *True*. When *True* (default), the struct will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use. **UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com". Override the default with the name and version of your software. ### TCPClient Config Settings **ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the struct will use [Timeout](#timeout-property-openid-component) for establishing a connection and transmitting/receiving data. **EnableFallback**: Whether to try the other addresses the remote host resolves to when a connection attempt fails.When set to True and RemoteHost resolves to more than one address, the struct will try the remaining addresses in turn if the connection to the first one fails, and only fails with an error once every address has been tried. The error reported is the one from the last attempt. Use [FallbackTimeout](#FallbackTimeout) to limit the total time spent. NOTE: Only addresses of the same IP version as the first one are tried, this setting does not fall back from IPv6 to IPv4. Selecting between IPv6 and IPv4 is done by [UseIPv6](#UseIPv6) when the host is resolved. This setting must be set before the connection is established. The default value for this setting is False. **FallbackTimeout**: The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled.This setting limits the total time that the struct will spend on all of the connection attempts made when [EnableFallback](#EnableFallback) is enabled. The default value is 0, in which case each attempt uses the operating system's own connection timeout. NOTE: This setting only applies when [EnableFallback](#EnableFallback) is True. It is unrelated to [ConnectionTimeout](#ConnectionTimeout), which is specified in seconds and applies to the [Connected](#connected-property-openid-component) operation as a whole. **FirewallAutoDetect**: Tells the struct whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by structs that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned. NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error. NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by structs that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the struct fails with an error. NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. **Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the struct returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. **LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-openid-component) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. If the struct is connected, the [LocalHost](#localhost-property-openid-component) setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). **LocalPort**: The port in the local host where the struct binds. This configuration setting must be set before a connection is attempted. It instructs the struct to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems. **MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string. If an EOL string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset. If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset. The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to *0* (default), the struct will use IPv4 exclusively. When set to *1*, the struct will use IPv6 exclusively. To instruct the struct to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#timeout-property-openid-component) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a struct is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the struct will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the struct to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section. # Trappable Errors ([OpenID](#openid-component) Component) ### OpenID Errors | | | | --- | --- | | 900 | Invalid discovery document. The data is not a properly formatted discovery document. | | 901 | Invalid ID Token. The ID Token could not be parsed. | | 902 | Invalid ResponseType specified. The supplied ResponseType was unrecognized. | | 903 | ID Token verification failed. | | 910 | ID Token verification failed. ID Token has expired. | | 911 | ID Token verification failed. ID Token issuer does not match expected issuer. | | 912 | ID Token verification failed. ID Token audience does not match the expected audience. | | 913 | ID Token verification failed. ID Token is missing a required claim. | | 914 | ID Token verification failed. ID Token is meant for future use. | | 915 | ID Token verification failed. ID Token has an invalid issued time. | | 920 | ID Token verification failed. Could not validate signature. | | 921 | ID Token verification failed. Could not find a valid Signer Certificate. | | 922 | ID Token verification failed. Could not find a Signer Certificate that matches ID Token Headers. | | 923 | ID Token verification failed. Could not find signature. | The class may also return one of the following error codes, which are inherited from other classes. ### HTTP Errors | | | | --- | --- | | 118 | Firewall error. The error description contains the detailed message. | | 143 | Busy executing current method. | | 151 | HTTP protocol error. The error message has the server response. | | 152 | No server specified in URL. | | 153 | Specified URLScheme is invalid. | | 155 | Range operation is not supported by server. | | 156 | Invalid cookie index (out of range). | | 301 | Interrupted. | | 302 | Cannot open AttachedFile. | The class may also return one of the following error codes, which are inherited from other classes. ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the RemotePort at this time. A connection is in progress. | | 101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. | | 102 | The RemoteHost address is invalid (0.0.0.0). | | 104 | Already connected. If you want to reconnect, close the current connection first. | | 106 | You cannot change the LocalPort at this time. A connection is in progress. | | 107 | You cannot change the [LocalHost](#localhost-property-openid-component) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | RemotePort cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the struct is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 302 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). |