OAuth ConfigurationThe class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
OAuth Configuration Settings
|AccessTokenExp: The lifetime of the access token.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.|
The type of access token returned.The applicable values include the following:
|AuthorizationURL: Specifies the URL used for authorization.Holds the URL that the user should be directed to in order to authenticate. If this value is specified the class will use this value instead of automatically calculating the value when GetAuthorization is called.|
|BrowserResponseTimeout: Specifies the amount of time to wait for a response from the browser.This setting specifies the amount of time (in seconds) the component will wait for a response from the browser in the LaunchBrowser event. The default value is 0, meaning that the component will wait indefinitely.|
The code challenge method to use (if any).This setting controls the code challenge method used (if any). If specified, Proof Key for Code Exchange (PKCE) defined by RFC 7636 will be used. The value here controls the code challenge method. Possible values are:
|DeviceUserCode: The device's user code when the ClientProfile is set to cfDevice.When ClientProfile is set to cfDevice and GetAuthorizationURL is called the class will request a device user code from the server specified by ServerAuthURL. This setting will be populated with the device user code returned by the server. Provide this value along with the URL returned by GetAuthorizationURL to the user.|
Specifies the number of additional form variables to include in the request.This setting may be used to specify additional form variables made in the request to exchange AuthorizationCode
for an access token. This is useful in cases where the OAuth server requires additional fields. This is used in
conjunction with FormVarName[i] and FormVarValue[i]. For instance:
component.Config("FormVarCount=2"); component.Config("FormVarName=myvar"); component.Config("FormVarValue=myvalue"); component.Config("FormVarName=testname"); component.Config("FormVarValue=testvalue");The value will be URL encoded by the class
|FormVarName[i]: Specifies the form variable name at the specified index.This setting specifies the form variable name at the index specified. See FormVarCount for details.|
|FormVarValue[i]: Specifies the form variable value at the specified index.This setting specifies the form variable value at the index specified. See FormVarCount for details.|
Whether an empty redirect_uri parameter is included in requests.This setting specifies whether redirect_uri is included in the request made by GetAuthorization if it is empty.
In most cases redirect_uri will contain a value and will be sent, however if ClientProfile 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 only be sent if it has a value.
|JWTAudience: The JWT audience when the ClientProfile is set to cfJWT.This setting specifies the audience that the JWT is intended for. This is required when ClientProfile is set to cfJWT. When using Google service accounts this value must be "https://www.googleapis.com/oauth2/v3/token".|
The name of the certificate store for the JWT signing certificate.The name of the certificate store for the JWT signing certificate.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
Note: This is required when ClientProfile is set to cfJWT.
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 in order to open the certificate store.
Note: This is only applicable when ClientProfile is set to cfJWT.
The type of certificate store.This specifies the type of certificate store. Possible values are:
The JWT signing certificate subject.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, Efirstname.lastname@example.org". Common fields and their meanings are displayed below.
If a field value contains a comma it must be quoted.
Note: This is required when ClientProfile is set to cfJWT.
|JWTIssuer: The JWT issuer when the ClientProfile is set to cfJWT.This setting specifies the issuer of the JWT. This is required when ClientProfile is set to cfJWT. When using Google service accounts this value is the email address of the service account.|
|JWTJSONKey: The file path of the JWT JSON Key, or a string containing its content.This 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 class will attempt to parse the values for JWTCertStore, JWTIssuer from the JSON file, as well as initializing the values for JWTCertStoreType, JWTCertStorePassword, and JWTCertSubject.|
The signature algorithm used to sign the JWT.This setting specifies the signature algorithm used to sign the JWT. Possible values are:
|JWTSubject: The subject field in the JWT.This 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're authenticating to determine if the "sub" field is applicable.|
The amount of time in seconds for which the assertion in the JWT is valid.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 only applicable when ClientProfile is set to cfJWT.
|Office365ServiceAPIVersion: The API version of the Office 365 service being discovered.This setting specifies the API version of the Office 365 service for which a search is initiated. See Office365ServiceEndpoint for details.|
|Office365ServiceCapability: The API capability of the Office 365 service being discovered.This setting specifies the capability of the Office 365 service for which a search is initiated. See Office365ServiceEndpoint for details.|
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 which can be used with the OneDrive API.
When GetAuthorization is called, if Office365ServiceAPIVersion and Office365ServiceCapability are specified the class will attempt to discover the Office 365 services for which the user has access sand find a service which matches the requirements specified in Office365ServiceAPIVersion and Office365ServiceCapability. If a service is found the class will then obtain authorization to access that service. If authorization is successful Office365ServiceEndpoint will hold the service endpoint URL to which requests should be made.
Example of OneDrive for Business:
oauth.Config("Office365ServiceCapability=MyFiles"); oauth.Config("Office365ServiceAPIVersion=v2.0"); string authString = oauth.GetAuthorization(); string endpointURL = oauth.Config("Office365ServiceEndpoint");
|PollingInterval: The interval in seconds between polling requests when the device client type is used.When ClientProfile is set to cfDevice, this determines the interval (in seconds) between polling requests made to ServerTokenURL. The default value is 5.|
|ReUseWebServer: Determines if the same server instance is used between requests.If set to true (default), the same embedded web server instance will be used for multiple requests. If set to false the embedded web server will be created and destroyed on each call to GetAuthorization|
|TokenInfoFieldCount: The number of fields in the tokeninfo service response.This setting returns the number of fields present in the tokeninfo service response. This is populated after calling ValidateToken.|
|TokenInfoFieldName[i]: The name of the tokeninfo service response field.This setting returns the name of the tokeninfo service response field specified by index i. Valid values are from 0 to TokenInfoFieldCount - 1.|
|TokenInfoFieldValue[i]: The value of the tokeninfo service response field.This setting returns the value of the tokeninfo service response field specified by index i. Valid values are from 0 to TokenInfoFieldCount - 1.|
|TokenInfoURL: The URL of the tokeninfo service.This setting specifies the URL of the tokeninfo service to which a request is made when 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 setting will post the AccessToken to the tokeninfo service specified by TokenInfoURL. This allows a token to be queried for validity and other information before use. When this setting is queried the class will immediately make a request to the server. TokenInfoFieldCount, TokenInfoFieldName[i], and TokenInfoFieldValue[i] may be used to iterate over the fields in the response.|
|WebServerFailedResponse: The custom response that will be displayed to the user if authentication failed.When GetAuthorization is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. If authentication failed, the HTML specified here will be sent to the user's browser.|
The hostname used by the embedded web server displayed in the ReturnURL.This setting specifies the hostname used by the embedded web server when ClientProfile is set to cfApplication.
This specifies the interface on which the embedded web server listens, and also the value displayed in the ReturnURL.
This should be set to the hostname only, not the full URL.
The default value is "localhost".
|WebServerResponse: The custom response that will be displayed to the user.When GetAuthorization 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 Configuration Settings
|AcceptEncoding: Used to tell the server which types of content encodings the client supports.When AllowHTTPCompression is true, the class adds an "Accept-Encoding: " header to the request being sent to the server. By default, this header's value is "gzip, deflate". This config allows you to change the value of the "Accept-Encoding" header. NOTE: The class only supports gzip and deflate decompression algorithms.|
This property enables HTTP compression for receiving data.This setting enables HTTP compression for receiving data.
When set to True (default), the class will accept compressed data. It will then uncompress the data it has received. The class will handle data compressed by both GZIP and Deflate compression algorithms.
When true, the class adds an "Accept-Encoding" header to the outgoing request. The value for this header can be controlled by the AcceptEncoding config. The default value for this header is "gzip, deflate".
The default value is True.
Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This setting controls whether HTTP/2 connections are permitted to fallback to HTTP/1.1 when the server
does not support HTTP/2. This setting is only applicable when HTTPVersion is set to "2.0".
If set to True (default) the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False the class 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 setting determines whether data is 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 only applicable when LocalFile is set. The default value is False.|
The Authorization string to be sent to the server.
If the Authorization property contains a non-empty string,
an Authorization HTTP request header is added to the
request. This header conveys Authorization information to the
This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.
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. Returns the raw number of bytes from the HTTP response data, prior to the component processing the data, whether it is chunked and/or compressed. This returns the same value as the Transfer event, by BytesTransferred.|
|ChunkSize: Specifies the chunk size in bytes when using chunked encoding.This is only applicable when UseChunkedEncoding is true. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.|
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 class.If set to True the URL passed to the class will be URL encoded. The default value is False.|
Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the class 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 class fails with an error.
Note that 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 could potentially change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server and port are different than 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 event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect 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 class fails with an error instead.
Valid options are:
|GetOn302Redirect: If set to true the class will perform a GET on the new location.The default value is false. If set to true the class 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 via 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.|
The version of HTTP used by the class.This property specifies the HTTP version used by the class. Possible values are:
When using HTTP/2 ("2.0") additional restrictions apply. Please see notes below for details.
When using HTTP/2 only secure (TLS/SSL) connections are currently supported. Attempting to use a plaintext URL with HTTP/2 will result in an error.
If the server does not support HTTP/2 the class will automatically use HTTP/1.1 instead. This is done in order to provide compatibility without the need for any additional settings. To see which version was used check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/2 is supported on Windows 8.1/Server 2012 R2 or later. If HTTP/2 is used on a version of Windows prior to these versions the class fails with an error.
Note: HTTP/2 is currently only supported on Windows.
A date determining the maximum age of the desired document.If this setting contains a non-empty 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. An example is:
Sat, 29 Oct 2017 19:43:31 GMT.
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 that not all server support persistent connections. You may
also explicitly add the Keep-Alive header to the request headers by setting OtherHeaders to 'Connection: Keep-Alive'.
If false, the connection will be closed immediately after the server response is received.
The default value for 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.|
The level of detail that is logged.This setting controls the level of detail that is logged through the Log event. Possible values are:
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 is set to any value besides frNever the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.|
|NegotiatedHTTPVersion: The negotiated HTTP version.This 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" the class will fallback to using "1.1" automatically. This setting will indicate which was used.|
Other headers as determined by the user (optional).This configuration option can be set to a string of headers to be appended to the HTTP request headers.
The headers must be of the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .
Use this configuration option with caution. If this configuration option contains invalid headers, HTTP requests may fail.
This configuration option is useful for extending the functionality of the class beyond what is provided.
|ProxyAuthorization: The authorization string to be sent to the proxy server.Similar to the Authorization config, but for proxy authorization. If this config contains a non-empty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy authorization information to the server. If ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme.|
|ProxyAuthScheme: The authorization scheme to be used for the proxy.This is the same as ProxyAuthScheme. This setting is provided for use by classs that do not directly expose Proxy properties.|
|ProxyPassword: A password if authentication is to be used for the proxy.This is the same as ProxyPassword. This setting is provided for use by classs that do not directly expose Proxy properties.|
|ProxyPort: Port for the proxy server (default 80).This is the same as ProxyPort. This setting is provided for use by classs that do not directly expose Proxy properties.|
|ProxyServer: Name or IP address of a proxy server (optional).This is the same as ProxyServer. This setting is provided for use by classs that do not directly expose Proxy properties.|
|ProxyUser: A user name if authentication is to be used for the proxy.This is the same as ProxyUser. This setting is provided for use by classs 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.|
|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 setting contains the contents of the last response from the server.|
|TransferredDataLimit: The maximum number of incoming bytes to be stored by the class.If 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 class.|
|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.|
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 config to ON before making a request to enable it. Examples are below.
Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest"));C++
HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest"));
Enables or Disables HTTP chunked encoding for transfers.
If UseChunkedEncoding is set to true, the class 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 class 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.
Whether to encode hostnames to internationalized domain names.This 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.
The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance to specify UTF-8 set CodePage to 65001. In the C++ Edition for Windows the *W version of the class must be used. For instance DNSW or HTTPW.
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.
IPPort Configuration 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 class will use Timeout for establishing a connection and transmitting/receiving data.|
|FirewallAutoDetect: Tells the class whether or not to automatically detect and use firewall system settings, if available.This is the same as FirewallAutoDetect. This setting is provided for use by classs that do not directly expose Firewall properties.|
Name or IP address of firewall (optional).If a FirewallHost is given, requested connections will be authenticated through the specified firewall
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
NOTE: This is the same as FirewallHost. This setting is provided for use by classs that do not directly expose Firewall properties.
Password to be used if authentication is to be used when connecting through the firewall.If FirewallHost is specified, the FirewallUser and FirewallPassword settings
are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
NOTE: This is the same as FirewallPassword. This setting is provided for use by classs that do not directly expose Firewall properties.
The TCP port for the FirewallHost;.Note that the FirewallPort is set automatically when FirewallType is set to a valid value.
NOTE: This is the same as FirewallPort. This setting is provided for use by classs that do not directly expose Firewall properties.
Determines the type of firewall to connect through.The appropriate values are as follows:
NOTE: This is the same as FirewallType. This setting is provided for use by classs that do not directly expose Firewall properties.
A user name if authentication is to be used connecting through a firewall.If the FirewallHost is specified, the FirewallUser and FirewallPassword
settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.
NOTE: This is the same as FirewallUser. This setting is provided for use by classs that do not directly expose Firewall properties.
The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, TCPKeepAlive will automatically be set to true.
A TCP keep-alive packet will be sent after a period of inactivity as
defined by KeepAliveTime. If no acknowledgement is received from the remote host the keep-alive packet
will be re-sent. This 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 Java or MAC.
The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, TCPKeepAlive will automatically be set to true.
By default the operating system will determine the
time a connection is idle before a 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.
Note: This value is not applicable in Java.
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), there are two scenarios for determining how long the connection will linger. The first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP protocol timeout expires.
In the second scenario, LingerTime is a positive value, the system will attempt to send pending data until the specified 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 class returns control immediately, the system could hold system resources until all pending data is 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 (by a client acknowledgment, for example), 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, to leave the socket connection linger. This value is 0 by default, which means it will use the default IP protocol timeout.|
The name of the local host through which connections are initiated or accepted.
The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the LocalHost 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 multi-homed hosts (machines with more than one IP interface).
The port in the local host where the class binds.
This must be set before a connection is
attempted. It instructs the class 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; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.
The maximum amount of data to accumulate when no EOL is found.MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL
If an EOL string is found in the input stream before 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 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 is 256 bytes. The default value is 2048 bytes.
|MaxTransferRate: The transfer rate limit in bytes per second.This 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.|
A semicolon separated list of hosts and IPs to bypass when using a proxy.This 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:
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 and KeepAliveInterval to
configure the timing of the keep-alive packets.
Note: This value is not applicable in Java.
Whether or not to delay when sending packets.
When true, the socket will send all data that is ready to send at once. When
false, the socket will send smaller buffered packets of data at small intervals.
This is known as the Nagle algorithm.
By default, this config is set to false.
Whether to use IPv6.When set to 0 (default), the class will use IPv4 exclusively.
When set to 1, the class will use IPv6 exclusively. To instruct the class 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:
SSL Configuration Settings
Controls whether SSL packets are logged when using the internal security API.When the UseInternalSecurityAPI configuration setting is True, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this setting has no effect if UseInternalSecurityAPI is False.
The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by
... (CA certificate in base64 encoding) ...
sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL.
By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
Determines if the SSL session is reused.
If set to true, the class will reuse the context if and only if the following criteria are met:
A newline separated list of CA certificate to use during SSL client authentication.This setting specifies one or more CA certificates to be included in the request when performing
SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented
when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
Whether to check the Certificate Revocation List for the server certificate.This setting specifies whether the class will check the Certificate Revocation List specified by the server certificate. If set to true the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.
When set to false (default) the CRL check will not be performed by the class.
The minimum cipher strength used for bulk encryption.
This minimum cipher strength largely dependent on the security modules installed
on the system. If the cipher strength specified is not supported,
an error will be returned when connections are initiated.
Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
The cipher suite to be used in an SSL negotiation.The enabled cipher suites to be used in SSL negotiation.
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when UseInternalSecurityAPI is False (default):
obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");Possible values when UseInternalSecurityAPI is False (default) include:
obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");Possible values when UseInternalSecurityAPI is True include:
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
Used to enable/disable the supported security protocols.Used to enable/disable the supported security protocols.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
Note: TLS 1.1 and TLS1.2 support are only available starting with Windows 7.
Note: Enabling TLS 1.3 will automatically set UseInternalSecurityAPI to True.
Whether the renegotiation_info SSL extension is supported.This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API.
This setting is true by default, but can be set to false to disable the extension.
This setting is only applicable when UseInternalSecurityAPI is set to true.
Whether the entire certificate chain is included in the SSLServerAuthentication event.This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains
the full certificate chain. By default this value is False and only the leaf certificate will be present
in the Encoded parameter of the SSLServerAuthentication event.
If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
The name of the security provider to use.
Change this setting to use security providers other than the system default.
Use this setting with caution. Disabling SSL security or pointing to the wrong provider could potentially cause serious security vulnerabilities in your application.
The special value "*" (default) picks the default SSL provider defined in the system.
Note: On Windows systems, the default SSL Provider is "Microsoft Unified Security Protocol Provider" and cannot be changed .
Flags that control certificate verification.The following flags are defined (specified in hexadecimal
notation). They can be or-ed together to exclude multiple
This functionality is currently not available when the provider is OpenSSL.
Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.This setting specifies the allowed server certificate signature algorithms when UseInternalSecurityAPI is
True and SSLEnabledProtocols is set to allow TLS 1.2.
When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.
The format of this value is a comma separated list of hash-signature combinations. For instance:
IPPort.Config("UseInternalSecurityAPI=true"); IPPort.Config("SSLEnabledProtocols=3072"); //TLS 1.2 IPPort.Config("TLS12SignatureAlgorithms=sha1-rsa,sha1-dsa,sha256-rsa,sha256-dsa");The default value for this setting is sha1-rsa,sha1-dsa,sha224-rsa,sha224-dsa,sha256-rsa,sha256-dsa,sha384-rsa,sha384-dsa,sha512-rsa,sha512-dsa.
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The supported groups for ECC.This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and UseInternalSecurityAPI is set to True, the values refer to the supported groups for ECC. The following values are supported:
The groups for which to pregenerate key shares.This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange.
The groups specified here will have key share data pregenerated locally before establishing a connection.
This can prevent an additional round trip during the handshake if the group is supported by the server.
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.
In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
The allowed certificate signature algorithms.This setting holds a comma separated list of allowed signature algorithms. Possible values are:
The supported groups for (EC)DHE key exchange.This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange.
This setting should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
Socket Configuration Settings
Determines whether timeouts are inactivity timeouts or absolute timeouts.If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds
will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.
Note: This option is not valid for 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).|
The size in bytes of the incoming 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 receiving. Increasing the value of the
InBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
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. Increasing the value of the
OutBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.