AzureKeys Module
Properties Methods Events Config Settings Errors
The AzureKeys module makes it easy to interact with keys in Azure Key Vaults.
Syntax
CloudKeys.AzureKeys
Remarks
The AzureKeys class provides an easy-to-use interface for the key-related functionality of the Azure Key Vault service. Azure Key Vault allows you to works with a few different kinds of resources, one of which is asymmetric key pairs. This class helps you to create, manage, and use said key pairs (or just "keys", for short) for cryptographic operations. To work with "secrets" instead, refer to the AzureSecrets class.
To begin, register for an Azure account and create one or more Key Vaults via the Azure Portal. Set the Vault property to the name of the vault you wish to work with.
This class requires authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property to set the appropriate fields for the chosen OAuthClientProfile and OAuthGrantType.
The component has the following defaults:
| Authorization Server URL | "https://login.microsoftonline.com/common/oauth2/v2.0/authorize" |
| Token Server URL | "https://login.microsoftonline.com/common/oauth2/v2.0/token" |
| Scopes | "offline_access https://vault.azure.net/user_impersonation" |
Additionaly, depending on how the application is registered (Ex. Single-tenant, Multi-tenant) and what OAuthGrantType is selected (Ex. Authorization Code, Password), it may be required to use the tenant ID rather than "common" in the OAuthServerAuthURL, and OAuthServerTokenURL properties. See below for examples of the modified URLs:
| Authorization Server URL | "https://login.microsoftonline.com/{TENANT_ID}/oauth2/v2.0/authorize" |
| Token Server URL | "https://login.microsoftonline.com/{TENANT_ID}/oauth2/v2.0/token" |
Application Profile
This profile encompasses the most basic grant types that OAuth supports. When this profile is set, all the requests and response handling is done by the class. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect.
To start the authentication and authorization process, the Authorize method should be called. If the authorization and authentication was successful, then the OAuthAccessToken property will be populated. Additionally, if a refresh token was provided the OAuthRefreshToken property will be populated as well. These values of the fields are for informational purposes. The class will also cache these tokens along with when the OAuthAccessToken will be expired. When a method that makes requests to the service provider is called or the Authorize method is called the class will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new OAuthAccessToken. If the Authorize method was not used and user interaction would be required, the class will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the OAuthGrantType property. To force the component to only check the access token when the Authorize method is called, the OAuthAutomaticRefresh configuration setting can be set to false.
A brief description of the supported values for the OAuthGrantType property are below. For more information, see the service documentation.
Authorization Code
When using the Authorization Code grant type, the class will use an authorization code to get an access token. For this OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, and OAuthServerTokenURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the authorization code, setting the OAuthAuthorizationCode property, from the redirect. Immediately, the class will make a request to the token server to exchange the authorization code for an access token. The token server will return an access token and possibly a refresh token. If the OAuthRefreshToken property is set, or a refresh token is cached, then the class will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.
Example:
AzureKeys azurekeys = new AzureKeys();
azurekeys.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication;
azurekeys.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode;
azurekeys.OAuth.ClientId = CLIENT_ID;
azurekeys.OAuth.ClientSecret = SECRET_ID;
azurekeys.OAuth.AuthorizationScope = "offline_access https://vault.azure.net/user_impersonation";
azurekeys.OAuth.ServerAuthURL = "https://login.microsoftonline.com/" + TENANT_ID + "/oauth2/v2.0/authorize";
azurekeys.OAuth.ServerTokenURL = "https://login.microsoftonline.com/" + TENANT_ID + "/oauth2/v2.0/token";
azurekeys.Authorize();
Implicit
Note: This grant type is considered insecure and should only be used when necessary.
When using the Implicit grant type, the class will request the authorization server to get an access token. For this OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, and OAuthServerAuthURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the access token from the redirect.
A disadvantage of the grant type is that can not use a refresh token to silently get a new access token. Most service providers offer a way to silently get a new access token. See the service documentation for specifics. This means the class will not be able to automatically get a fresh token once it expires.
Password
Note: This grant type is considered insecure and should only be used when necessary.
When using the Resource Owner Password Credentials grant type, the class will authenticate as the resource owner. This allows for the class to avoid user interaction. This grant type often has specific limitations put on it by the service provider. See the service documentation for more details.
For this OAuthGrantType the class requires OAuthPasswordGrantUsername, OAuthClientSecret, and OAuthServerTokenURL to be set. The OAuthClientSecret should be set to the password of the account instead of a typical secret. In some cases, the OAuthClientId also needs to be set. When the Authorize method is called, the component will make a request to the token server for an access token using the username and password. The token server will return an access token if the authentication was successful. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.
Web Profile
This profile is similar to setting the class to the Application profile and Authorization Code grant type except the class will not launch the browser. It is typically used in situations where there is a back-end that is supporting some front end. This profile expects that OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, OAuthServerTokenURL, and the OAuthReturnURL properties to be set. Before calling the Authorize method, the OAuthWebAuthURL property should be queried to get a URL. This URL should be used to redirect the user to the authorization page for the service provider. The redirect_uri parameter of this URL is mapped to the OAuthReturnURL property. The OAuthReturnURL property should be set to some web server that will parse the authorization code out of the query parameter from the redirect. Once the authorization code is parsed, it should be passed back to the server where it is then set to the OAuthAuthorizationCode property. Once that is set, the Authorize method can be called to exchange the authorization code for an access token and refresh token if provided. The class will then cache these values like normal and use them to make requests. If the OAuthRefreshToken field is set, or a refresh token is cached, then the Authorize method can immediately be called to make a request to the token server to get a new access token.
External OAuth Support
For complex profiles or grant types, or for more control of the flow, it is possible to perform OAuth authentication using the OAuth class or a separate process. Once complete you should have an authorization string which looks like:Bearer ACCESS_TOKEN_VALUE
Assign this value to the Authorization property before attempting any operations. Setting the Authorization property will cause the class to ignore the values set in the OAuth property.
For Example:
Oauth oauth = new Oauth();
oauth.ClientId = "CLIENT_ID";
oauth.ClientSecret = "CLIENT_SECRET";
oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize";
oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token";
oauth.AuthorizationScope = "offline_access https://vault.azure.net/user_impersonation";
oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode;
azurekeys.Authorization = oauth.GetAuthorization();
Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.
Using the Class
Keys can be created using the CreateKey method. A key's name and type (i.e., whether it is RSA or EC, and its size or curve, respectively) must be set at the time of creation, and cannot be changed later. A list of cryptographic operations that the key is valid for must also be set, but can be changed at any time using the UpdateKey. If a key with the specified name already exists, a new version of it is created; this makes it easy to "rotate" a key.
When a key will no longer be used, it can be deleted using the DeleteKey method. However, the key will only be soft-deleted; by default, Azure will permanently delete it after the waiting period configured for the vault. During this waiting period, the soft-deleted key may be recovered using RecoverKey, or permanently deleted using PurgeKey (assuming the currently-authenticated user has the permissions to do so).
azurekeys.CreateKey("mykey", "RSA_2048", "encrypt,decrypt,sign,verify,wrapKey,unwrapKey");
// ... Some time later, when the key is no longer needed ...
azurekeys.DeleteKey("mykey");
// At this point, the key is only soft-deleted. It could be recovered...
azurekeys.RecoverKey("mykey");
// ...or permanently deleted.
azurekeys.PurgeKey("mykey");
To list keys, use the ListKeys method. This method is also used to list soft-deleted keys if the GetDeleted configuration setting has been enabled first. To list a key's versions, use the ListVersions method. (You cannot list a deleted key's versions.) In all cases, the IncludeKeyDetails property can optionally be enabled to have the class attempt to retrieve the full information for each key (Azure leaves out certain fields by default when listing).
// If there are many keys to list, there may be multiple pages of results. This will
// cause all pages of results to be accumulated into the Keys collection property.
do {
azurekeys.ListKeys();
} while (!string.IsNullOrEmpty(azurekeys.KeyMarker));
// A similar thing applies to key versions as well.
do {
azurekeys.ListVersions("mykey");
} while (!string.IsNullOrEmpty(azurekeys.VersionMarker));
Depending on a key's "key ops" list, it can be used to perform different cryptographic operations. Keys with the encrypt and decrypt ops can be used in Encrypt and Decrypt operations. Keys with the sign and verify ops can be used in Sign and Verify. Finally, keys with the wrapKey and unwrapKey ops can be used in WrapKey and UnwrapKey operations (which are just like encryption and decryption, but which are intended to be used for wrapping a symmetric key, and which require different permissions to call successfully).
To perform a cryptographic operation, use InputData or InputFile to supply the input data that should be processed. All operations will output the result data to OutputData or OutputFile (except Verify; refer to its documentation for more information).
azurekeys.CreateKey("mykey", "RSA_2048", "encrypt,decrypt");
azurekeys.InputData = "Test123";
azurekeys.OutputFile = "C:/temp/enc.dat";
azurekeys.Encrypt("mykey", "RSA-OAEP-256");
azurekeys.InputFile = "C:/temp/enc.dat";
azurekeys.OutputFile = ""; // So that the data will be output to the OutputData property.
azurekeys.Decrypt("mykey", "RSA-OAEP-256");
The class also supports a variety of other functionality, including:
- Retrieval of a single key's information (including public key) with GetKeyInfo.
- Enabling and disabling keys with SetKeyEnabled.
- Tagging support using AddTag and the Tags properties.
- Secure key backup and restoration using BackupKey and RestoreKey.
- And more!
Property List
The following is the full list of the properties of the module with short descriptions. Click on the links for further details.
| Authorization | OAuth 2.0 Authorization Token. |
| Firewall | A set of properties related to firewall access. |
| Idle | The current status of the module. |
| IncludeKeyDetails | Whether to attempt to retrieve fill details when listing keys. |
| InputData | The data to process. |
| InputFile | The file whose data should be processed. |
| KeyMarker | A marker indicating what page of keys to return next. |
| Keys | A collection of keys. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| OAuth | This property holds the OAuth Settings. |
| OtherHeaders | Other headers as determined by the user (optional). |
| OutputData | The output data. |
| OutputFile | The file to which output data should be written. |
| Overwrite | Whether the output file should be overwritten if necessary. |
| ParsedHeaders | This property includes a collection of headers returned from the last request. |
| Proxy | A set of properties related to proxy access. |
| QueryParams | Additional query parameters to be included in the request. |
| SSLAcceptServerCert | Instructs the module to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to be used during Secure Sockets Layer (SSL) negotiation. |
| SSLProvider | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
| SSLServerCert | The server certificate for the last established connection. |
| Tags | A collection of tags. |
| Timeout | The timeout for the module. |
| Vault | Selects a vault for the module to interact with. |
| VersionMarker | A marker indicating what page of key versions to return next. |
Method List
The following is the full list of the methods of the module with short descriptions. Click on the links for further details.
| AddQueryParam | Adds a query parameter to the QueryParams properties. |
| AddTag | Adds an item to the Tags properties. |
| Authorize | Get the authorization string required to access the protected resource. |
| BackupKey | Backs up a key. |
| Config | Sets or retrieves a configuration setting. |
| CreateKey | Creates a new key. |
| Decrypt | Decrypts data using a key. |
| DeleteKey | Deletes a key. |
| DoEvents | This method processes events from the internal message queue. |
| Encrypt | Encrypts data using a key. |
| GetKeyInfo | Gets a key's information and public key. |
| ListKeys | Lists keys in the currently-selected vault. |
| ListVersions | Lists versions of a key. |
| PurgeKey | Permanently deletes a soft-deleted key. |
| RecoverKey | Recovers a soft-deleted key. |
| Reset | Resets the module to its initial state. |
| RestoreKey | Restores a previously backed-up key to the vault. |
| SendCustomRequest | Sends a custom request to the server. |
| SetKeyEnabled | Enables or disables a key. |
| Sign | Signs a message using a key. |
| UnwrapKey | Unwraps a symmetric key. |
| UpdateKey | Updates a key's information. |
| Verify | Verifies a digital signature using a key. |
| WrapKey | Wraps a symmetric key. |
Event List
The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.
| EndTransfer | This event fires when a document finishes transferring. |
| Error | Fired when information is available about errors during data delivery. |
| Header | Fired every time a header line comes in. |
| KeyList | Fires once for each key when listing keys. |
| Log | Fired once for each log message. |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Fired when secure connection progress messages are available. |
| StartTransfer | This event fires when a document starts transferring (after the headers). |
| TagList | Fires once for each tag returned when a key's information is retrieved. |
| Transfer | Fired while a document transfers (delivers document). |
Config Settings
The following is a list of config settings for the module with short descriptions. Click on the links for further details.
| AccumulatePages | Whether the module should accumulate subsequent pages of results when listing them. |
| APIVersion | The Azure Key Vault API version that the module conforms to. |
| CreateKeyEnabled | Whether new keys should be created in an enabled or disabled state. |
| ExpiryDate | The expiry date to send for the key. |
| GetDeleted | Whether the module should retrieve information about soft-deleted keys. |
| MaxKeys | The maximum number of results to return when listing keys. |
| MessageDigest | The message digest computed by the module during the last sign or verify operation, if any. |
| NotBeforeDate | The 'not before' date to send for the key. |
| RawRequest | Returns the data that was sent to the server. |
| RawResponse | Returns the data that was received from the server. |
| VersionId | The Id of the key version that the module should make requests against. |
| XChildCount | The number of child elements of the current element. |
| XChildName[i] | The name of the child element. |
| XChildXText[i] | The inner text of the child element. |
| XElement | The name of the current element. |
| XParent | The parent of the current element. |
| XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
| XSubTree | A snapshot of the current element in the document. |
| XText | The text of the current element. |
| OAuthAccessTokenExpiration | The lifetime of the access token. |
| OAuthAuthorizationTokenType | The type of access token returned. |
| OAuthAutomaticRefresh | Whether or not to refresh an expired access token automatically. |
| OAuthBrowserResponseTimeout | Specifies the amount of time to wait for a response from the browser. |
| OAuthIncludeEmptyRedirectURI | Whether an empty redirect_uri parameter is included in requests. |
| OAuthJWTPayload | The payload of the JWT access token if present. |
| OAuthJWTXChildCount | The number of child elements of the current element. |
| OauthJWTXChildName[i] | The name of the child element. |
| OAuthJWTXChildXText[i] | The inner text of the child element. |
| OAuthJWTXElement | The name of the current element. |
| OauthJWTXParent | The parent of the current element. |
| OAuthJWTXPath | Provides a way to point to a specific element in the returned payload of a JWT based access token. |
| OAuthJWTXSubTree | A snapshot of the current element in the document. |
| OAuthJWTXText | The text of the current element. |
| OAuthParamCount | Specifies the number of additional parameters variables to include in the request. |
| OAuthParamName[i] | Specifies the parameter name at the specified index. |
| OAuthParamValue[i] | Specifies the parameter value at the specified index. |
| OAuthPasswordGrantUsername | Used in the Resource Owner Password grant type. |
| OAuthPKCEChallengeEncoding | The PKCE code challenge method to use. |
| OAuthPKCEVerifier | The PKCE verifier used to generate the challenge. |
| OAuthResetData | Determines if the Reset method applies to the OAuth settings. |
| OAuthReUseWebServer | Determines if the same server instance is used between requests. |
| OAuthTransferredRequest | The full OAuth request last sent by the client. |
| OAuthUsePKCE | Specifies if PKCE should be used. |
| OAuthWebServerActive | Specifies and controls whether the embedded web server is active. |
| OAuthWebServerCertStore | The certificate with private key to use when SSL is enabled. |
| OAuthWebServerCertStorePassword | The certificate with private key to use when SSL is enabled. |
| OAuthWebServerCertStoreType | The certificate with private key to use when SSL is enabled. |
| OAuthWebServerCertSubject | The certificate with private key to use when SSL is enabled. |
| OAuthWebServerFailedResponse | The custom response that will be displayed to the user if authentication failed. |
| OAuthWebServerHost | The hostname used by the embedded web server displayed in the ReturnURL. |
| OAuthWebServerPort | The local port on which the embedded web server listens. |
| OAuthWebServerResponse | The custom response that will be displayed to the user. |
| OAuthWebServerSSLEnabled | Whether the web server requires SSL connections. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
| EncodeURL | If set to True the URL will be encoded by the module. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to True the module will perform a GET on the new location. |
| HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| HTTPVersion | The version of HTTP used by the module. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| LogLevel | The level of detail that is logged. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| NegotiatedHTTPVersion | The negotiated HTTP version. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| ProxyPassword | A password if authentication is to be used for the proxy. |
| ProxyPort | Port for the proxy server (default 80). |
| ProxyServer | Name or IP address of a proxy server (optional). |
| ProxyUser | A user name if authentication is to be used for the proxy. |
| SentHeaders | The full set of headers as sent by the client. |
| StatusCode | The status code of the last response from the server. |
| StatusLine | The first line of the last response from the server. |
| TransferredData | The contents of the last response from the server. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the module. |
| TransferredHeaders | The full set of headers as received from the server. |
| TransferredRequest | The full request as sent by the client. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| UseIDNs | Whether to encode hostnames to internationalized domain names. |
| UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
| UserAgent | Information about the user agent (browser). |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the module whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The port in the local host where the module binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseIPv6 | Whether to use IPv6. |
| LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCACerts | A newline separated list of CA certificates to be included when performing an SSL handshake. |
| SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
| SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
| SSLNegotiatedCipher | Returns the negotiated cipher suite. |
| SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
| SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
| SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
| SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
| SSLNegotiatedVersion | Returns the negotiated protocol version. |
| SSLSecurityFlags | Flags that control certificate verification. |
| SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| MaskSensitiveData | Whether sensitive data is masked in log messages. |
| UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
Authorization Property (AzureKeys Module)
OAuth 2.0 Authorization Token.
Syntax
public var authorization: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=authorization,setter=setAuthorization:) NSString* authorization; - (NSString*)authorization; - (void)setAuthorization :(NSString*)newAuthorization;
Default Value
""
Remarks
This class supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth class or a separate process. Once complete you should have an authorization string which looks like:
Bearer ACCESS_TOKENAssign this value to the Authorization property before attempting any operations. Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.
Firewall Property (AzureKeys Module)
A set of properties related to firewall access.
Syntax
public var firewall: Firewall { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=firewallAutoDetect,setter=setFirewallAutoDetect:) BOOL firewallAutoDetect; - (BOOL)firewallAutoDetect; - (void)setFirewallAutoDetect :(BOOL)newFirewallAutoDetect; @property (nonatomic,readwrite,assign,getter=firewallType,setter=setFirewallType:) int firewallType; - (int)firewallType; - (void)setFirewallType :(int)newFirewallType; @property (nonatomic,readwrite,assign,getter=firewallHost,setter=setFirewallHost:) NSString* firewallHost; - (NSString*)firewallHost; - (void)setFirewallHost :(NSString*)newFirewallHost; @property (nonatomic,readwrite,assign,getter=firewallPassword,setter=setFirewallPassword:) NSString* firewallPassword; - (NSString*)firewallPassword; - (void)setFirewallPassword :(NSString*)newFirewallPassword; @property (nonatomic,readwrite,assign,getter=firewallPort,setter=setFirewallPort:) int firewallPort; - (int)firewallPort; - (void)setFirewallPort :(int)newFirewallPort; @property (nonatomic,readwrite,assign,getter=firewallUser,setter=setFirewallUser:) NSString* firewallUser; - (NSString*)firewallUser; - (void)setFirewallUser :(NSString*)newFirewallUser;
Default Value
""
Remarks
This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.
Idle Property (AzureKeys Module)
The current status of the module.
Syntax
public var idle: Bool { get {...} }
@property (nonatomic,readonly,assign,getter=idle) BOOL idle; - (BOOL)idle;
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.
IncludeKeyDetails Property (AzureKeys Module)
Whether to attempt to retrieve fill details when listing keys.
Syntax
public var includeKeyDetails: Bool { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=includeKeyDetails,setter=setIncludeKeyDetails:) BOOL includeKeyDetails; - (BOOL)includeKeyDetails; - (void)setIncludeKeyDetails :(BOOL)newIncludeKeyDetails;
Default Value
False
Remarks
This property specifies whether the class should make additional requests when ListKeys or ListVersions is called in order to retrieve full information for each key. By default, Azure will omit certain fields when one of those methods is called (refer to each one's documentation for more information).
If this property is enabled, then after the initial listing is returned, the class will call GetKeyInfo internally for each key returned. For all keys for which this call is successful, the additional information will be used to populate the Keys properties. Any keys for which the GetKeyInfo call fails will not have the additional properties populated.
InputData Property (AzureKeys Module)
The data to process.
Syntax
public var inputData: String { get {...} set {...} }
public var inputDataB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=inputData,setter=setInputData:) NSString* inputData; - (NSString*)inputData; - (void)setInputData :(NSString*)newInputData; @property (nonatomic,readwrite,assign,getter=inputDataB,setter=setInputDataB:) NSData* inputDataB; - (NSData*)inputDataB; - (void)setInputDataB :(NSData*)newInputData;
Default Value
""
Remarks
This property specifies the data that should be processed in a cryptographic operation.
Input Sources & Output Destinations
The class automatically determines the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- The InputFile property
- The InputData property
The first valid input source found is used. The order in which the output properties are considered is as follows:
- The OutputFile property
- The OutputData property
InputFile Property (AzureKeys Module)
The file whose data should be processed.
Syntax
public var inputFile: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=inputFile,setter=setInputFile:) NSString* inputFile; - (NSString*)inputFile; - (void)setInputFile :(NSString*)newInputFile;
Default Value
""
Remarks
This property specifies the file whose data should be processed in a cryptographic operation. It accepts both absolute and relative file paths.
Input Sources & Output Destinations
The class automatically determines the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- The InputFile property
- The InputData property
The first valid input source found is used. The order in which the output properties are considered is as follows:
- The OutputFile property
- The OutputData property
KeyMarker Property (AzureKeys Module)
A marker indicating what page of keys to return next.
Syntax
public var keyMarker: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=keyMarker,setter=setKeyMarker:) NSString* keyMarker; - (NSString*)keyMarker; - (void)setKeyMarker :(NSString*)newKeyMarker;
Default Value
""
Remarks
This property will be populated when ListKeys is called if the results are paged and there are more pages. To list all keys, continue to call ListKeys until this property returns empty string.
Refer to ListKeys for more information.
Keys Property (AzureKeys Module)
A collection of keys.
Syntax
public var keys: Array<AzureKey> { get {...} }
@property (nonatomic,readonly,assign,getter=keyCount) int keyCount; - (int)keyCount; - (long long)keyCreationDate:(int)keyIndex; - (long long)keyDeletionDate:(int)keyIndex; - (BOOL)keyEnabled:(int)keyIndex; - (long long)keyExpiryDate:(int)keyIndex; - (NSString*)keyOps:(int)keyIndex; - (NSString*)keyType:(int)keyIndex; - (NSString*)keyName:(int)keyIndex; - (long long)keyNotBeforeDate:(int)keyIndex; - (NSString*)keyPublicKey:(int)keyIndex; - (long long)keyPurgeDate:(int)keyIndex; - (int)keyRecoverableDays:(int)keyIndex; - (NSString*)keyRecoveryLevel:(int)keyIndex; - (long long)keyUpdateDate:(int)keyIndex; - (NSString*)keyVersionId:(int)keyIndex;
Default Value
""
Remarks
This collection holds a list of AzureKey items.
Calling ListKeys, ListVersions, or GetKeyInfo will populate this collection.
LocalHost Property (AzureKeys Module)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
public var localHost: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost; - (NSString*)localHost; - (void)setLocalHost :(NSString*)newLocalHost;
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 class initiate connections (or accept in the case of server classs) 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 class 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.
OAuth Property (AzureKeys Module)
This property holds the OAuth Settings.
Syntax
public var oAuth: OAuthSettings { get {...} }
@property (nonatomic,readwrite,assign,getter=OAuthAccessToken,setter=setOAuthAccessToken:) NSString* OAuthAccessToken; - (NSString*)OAuthAccessToken; - (void)setOAuthAccessToken :(NSString*)newOAuthAccessToken; @property (nonatomic,readwrite,assign,getter=OAuthAuthorizationCode,setter=setOAuthAuthorizationCode:) NSString* OAuthAuthorizationCode; - (NSString*)OAuthAuthorizationCode; - (void)setOAuthAuthorizationCode :(NSString*)newOAuthAuthorizationCode; @property (nonatomic,readwrite,assign,getter=OAuthAuthorizationScope,setter=setOAuthAuthorizationScope:) NSString* OAuthAuthorizationScope; - (NSString*)OAuthAuthorizationScope; - (void)setOAuthAuthorizationScope :(NSString*)newOAuthAuthorizationScope; @property (nonatomic,readwrite,assign,getter=OAuthClientId,setter=setOAuthClientId:) NSString* OAuthClientId; - (NSString*)OAuthClientId; - (void)setOAuthClientId :(NSString*)newOAuthClientId; @property (nonatomic,readwrite,assign,getter=OAuthClientProfile,setter=setOAuthClientProfile:) int OAuthClientProfile; - (int)OAuthClientProfile; - (void)setOAuthClientProfile :(int)newOAuthClientProfile; @property (nonatomic,readwrite,assign,getter=OAuthClientSecret,setter=setOAuthClientSecret:) NSString* OAuthClientSecret; - (NSString*)OAuthClientSecret; - (void)setOAuthClientSecret :(NSString*)newOAuthClientSecret; @property (nonatomic,readwrite,assign,getter=OAuthGrantType,setter=setOAuthGrantType:) int OAuthGrantType; - (int)OAuthGrantType; - (void)setOAuthGrantType :(int)newOAuthGrantType; @property (nonatomic,readwrite,assign,getter=OAuthRefreshToken,setter=setOAuthRefreshToken:) NSString* OAuthRefreshToken; - (NSString*)OAuthRefreshToken; - (void)setOAuthRefreshToken :(NSString*)newOAuthRefreshToken; @property (nonatomic,readwrite,assign,getter=OAuthRequestRefreshToken,setter=setOAuthRequestRefreshToken:) BOOL OAuthRequestRefreshToken; - (BOOL)OAuthRequestRefreshToken; - (void)setOAuthRequestRefreshToken :(BOOL)newOAuthRequestRefreshToken; @property (nonatomic,readwrite,assign,getter=OAuthReturnURL,setter=setOAuthReturnURL:) NSString* OAuthReturnURL; - (NSString*)OAuthReturnURL; - (void)setOAuthReturnURL :(NSString*)newOAuthReturnURL; @property (nonatomic,readwrite,assign,getter=OAuthServerAuthURL,setter=setOAuthServerAuthURL:) NSString* OAuthServerAuthURL; - (NSString*)OAuthServerAuthURL; - (void)setOAuthServerAuthURL :(NSString*)newOAuthServerAuthURL; @property (nonatomic,readwrite,assign,getter=OAuthServerTokenURL,setter=setOAuthServerTokenURL:) NSString* OAuthServerTokenURL; - (NSString*)OAuthServerTokenURL; - (void)setOAuthServerTokenURL :(NSString*)newOAuthServerTokenURL; @property (nonatomic,readonly,assign,getter=OAuthWebAuthURL) NSString* OAuthWebAuthURL; - (NSString*)OAuthWebAuthURL;
Default Value
""
Remarks
This property is used to define the necessary fields to authenticate with the service provider. See the introduction for more information.
OtherHeaders Property (AzureKeys Module)
Other headers as determined by the user (optional).
Syntax
public var otherHeaders: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=otherHeaders,setter=setOtherHeaders:) NSString* otherHeaders; - (NSString*)otherHeaders; - (void)setOtherHeaders :(NSString*)newOtherHeaders;
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 .
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 class beyond what is provided.
OutputData Property (AzureKeys Module)
The output data.
Syntax
public var outputData: String { get {...} set {...} }
public var outputDataB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=outputData,setter=setOutputData:) NSString* outputData; - (NSString*)outputData; - (void)setOutputData :(NSString*)newOutputData; @property (nonatomic,readwrite,assign,getter=outputDataB,setter=setOutputDataB:) NSData* outputDataB; - (NSData*)outputDataB; - (void)setOutputDataB :(NSData*)newOutputData;
Default Value
""
Remarks
This property is populated with the data that was output from a successful cryptographic operation.
Note: For the Verify operation, this property functions as a secondary input property instead (along with InputData); refer to the Verify method for more information.
Input Sources & Output Destinations
The class automatically determines the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
The first valid input source found is used. The order in which the output properties are considered is as follows:
- The OutputFile property
- The OutputData property
OutputFile Property (AzureKeys Module)
The file to which output data should be written.
Syntax
public var outputFile: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=outputFile,setter=setOutputFile:) NSString* outputFile; - (NSString*)outputFile; - (void)setOutputFile :(NSString*)newOutputFile;
Default Value
""
Remarks
This property specifies the file to which data output from a successful cryptographic operation should be written.
Note: For the Verify operation, the specified file functions as a secondary input file instead (along with InputFile); refer to the Verify method for more information.
Input Sources & Output Destinations
The class automatically determines the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
The first valid input source found is used. The order in which the output properties are considered is as follows:
- The OutputFile property
- The OutputData property
Overwrite Property (AzureKeys Module)
Whether the output file should be overwritten if necessary.
Syntax
public var overwrite: Bool { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=overwrite,setter=setOverwrite:) BOOL overwrite; - (BOOL)overwrite; - (void)setOverwrite :(BOOL)newOverwrite;
Default Value
False
Remarks
This property controls whether the specified OutputFile should be overwritten if it already exists.
ParsedHeaders Property (AzureKeys Module)
This property includes a collection of headers returned from the last request.
Syntax
public var parsedHeaders: Array<Header> { get {...} }
@property (nonatomic,readonly,assign,getter=parsedHeaderCount) int parsedHeaderCount; - (int)parsedHeaderCount; - (NSString*)parsedHeaderField:(int)parsedHeaderIndex; - (NSString*)parsedHeaderValue:(int)parsedHeaderIndex;
Default Value
""
Remarks
This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.
MaxHeaders can be used to control the maximum number of headers saved.
Proxy Property (AzureKeys Module)
A set of properties related to proxy access.
Syntax
public var proxy: Proxy { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=proxyAuthScheme,setter=setProxyAuthScheme:) int proxyAuthScheme; - (int)proxyAuthScheme; - (void)setProxyAuthScheme :(int)newProxyAuthScheme; @property (nonatomic,readwrite,assign,getter=proxyAutoDetect,setter=setProxyAutoDetect:) BOOL proxyAutoDetect; - (BOOL)proxyAutoDetect; - (void)setProxyAutoDetect :(BOOL)newProxyAutoDetect; @property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword; - (NSString*)proxyPassword; - (void)setProxyPassword :(NSString*)newProxyPassword; @property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort; - (int)proxyPort; - (void)setProxyPort :(int)newProxyPort; @property (nonatomic,readwrite,assign,getter=proxyServer,setter=setProxyServer:) NSString* proxyServer; - (NSString*)proxyServer; - (void)setProxyServer :(NSString*)newProxyServer; @property (nonatomic,readwrite,assign,getter=proxySSL,setter=setProxySSL:) int proxySSL; - (int)proxySSL; - (void)setProxySSL :(int)newProxySSL; @property (nonatomic,readwrite,assign,getter=proxyUser,setter=setProxyUser:) NSString* proxyUser; - (NSString*)proxyUser; - (void)setProxyUser :(NSString*)newProxyUser;
Default Value
""
Remarks
This property contains fields describing the proxy through which the class will attempt to connect.
QueryParams Property (AzureKeys Module)
Additional query parameters to be included in the request.
Syntax
public var queryParams: Array<QueryParam> { get {...} }
@property (nonatomic,readwrite,assign,getter=queryParamCount,setter=setQueryParamCount:) int queryParamCount; - (int)queryParamCount; - (void)setQueryParamCount :(int)newQueryParamCount; - (NSString*)queryParamName:(int)queryParamIndex; - (void)setQueryParamName:(int)queryParamIndex :(NSString*)newQueryParamName; - (NSString*)queryParamValue:(int)queryParamIndex; - (void)setQueryParamValue:(int)queryParamIndex :(NSString*)newQueryParamValue;
Default Value
""
Remarks
This is a collection of query parameters that will be added to the request. Parameters can be added via the AddQueryParam method.
SSLAcceptServerCert Property (AzureKeys Module)
Instructs the module to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
public var sslAcceptServerCert: Certificate { get {...} set {...} }
@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertEffectiveDate) NSString* SSLAcceptServerCertEffectiveDate; - (NSString*)SSLAcceptServerCertEffectiveDate; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertExpirationDate) NSString* SSLAcceptServerCertExpirationDate; - (NSString*)SSLAcceptServerCertExpirationDate; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertExtendedKeyUsage) NSString* SSLAcceptServerCertExtendedKeyUsage; - (NSString*)SSLAcceptServerCertExtendedKeyUsage; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprint) NSString* SSLAcceptServerCertFingerprint; - (NSString*)SSLAcceptServerCertFingerprint; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprintSHA1) NSString* SSLAcceptServerCertFingerprintSHA1; - (NSString*)SSLAcceptServerCertFingerprintSHA1; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprintSHA256) NSString* SSLAcceptServerCertFingerprintSHA256; - (NSString*)SSLAcceptServerCertFingerprintSHA256; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertIssuer) NSString* SSLAcceptServerCertIssuer; - (NSString*)SSLAcceptServerCertIssuer; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKey) NSString* SSLAcceptServerCertPrivateKey; - (NSString*)SSLAcceptServerCertPrivateKey; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKeyAvailable) BOOL SSLAcceptServerCertPrivateKeyAvailable; - (BOOL)SSLAcceptServerCertPrivateKeyAvailable; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKeyContainer) NSString* SSLAcceptServerCertPrivateKeyContainer; - (NSString*)SSLAcceptServerCertPrivateKeyContainer; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKey) NSString* SSLAcceptServerCertPublicKey; - (NSString*)SSLAcceptServerCertPublicKey; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKeyAlgorithm) NSString* SSLAcceptServerCertPublicKeyAlgorithm; - (NSString*)SSLAcceptServerCertPublicKeyAlgorithm; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKeyLength) int SSLAcceptServerCertPublicKeyLength; - (int)SSLAcceptServerCertPublicKeyLength; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSerialNumber) NSString* SSLAcceptServerCertSerialNumber; - (NSString*)SSLAcceptServerCertSerialNumber; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSignatureAlgorithm) NSString* SSLAcceptServerCertSignatureAlgorithm; - (NSString*)SSLAcceptServerCertSignatureAlgorithm; @property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStore,setter=setSSLAcceptServerCertStore:) NSString* SSLAcceptServerCertStore; - (NSString*)SSLAcceptServerCertStore; - (void)setSSLAcceptServerCertStore :(NSString*)newSSLAcceptServerCertStore; @property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStoreB,setter=setSSLAcceptServerCertStoreB:) NSData* SSLAcceptServerCertStoreB; - (NSData*)SSLAcceptServerCertStoreB; - (void)setSSLAcceptServerCertStoreB :(NSData*)newSSLAcceptServerCertStore; @property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStorePassword,setter=setSSLAcceptServerCertStorePassword:) NSString* SSLAcceptServerCertStorePassword; - (NSString*)SSLAcceptServerCertStorePassword; - (void)setSSLAcceptServerCertStorePassword :(NSString*)newSSLAcceptServerCertStorePassword; @property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStoreType,setter=setSSLAcceptServerCertStoreType:) int SSLAcceptServerCertStoreType; - (int)SSLAcceptServerCertStoreType; - (void)setSSLAcceptServerCertStoreType :(int)newSSLAcceptServerCertStoreType; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSubjectAltNames) NSString* SSLAcceptServerCertSubjectAltNames; - (NSString*)SSLAcceptServerCertSubjectAltNames; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintMD5) NSString* SSLAcceptServerCertThumbprintMD5; - (NSString*)SSLAcceptServerCertThumbprintMD5; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintSHA1) NSString* SSLAcceptServerCertThumbprintSHA1; - (NSString*)SSLAcceptServerCertThumbprintSHA1; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintSHA256) NSString* SSLAcceptServerCertThumbprintSHA256; - (NSString*)SSLAcceptServerCertThumbprintSHA256; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertUsage) NSString* SSLAcceptServerCertUsage; - (NSString*)SSLAcceptServerCertUsage; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertUsageFlags) int SSLAcceptServerCertUsageFlags; - (int)SSLAcceptServerCertUsageFlags; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertVersion) NSString* SSLAcceptServerCertVersion; - (NSString*)SSLAcceptServerCertVersion; @property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertSubject,setter=setSSLAcceptServerCertSubject:) NSString* SSLAcceptServerCertSubject; - (NSString*)SSLAcceptServerCertSubject; - (void)setSSLAcceptServerCertSubject :(NSString*)newSSLAcceptServerCertSubject; @property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded; - (NSString*)SSLAcceptServerCertEncoded; - (void)setSSLAcceptServerCertEncoded :(NSString*)newSSLAcceptServerCertEncoded; @property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB; - (NSData*)SSLAcceptServerCertEncodedB; - (void)setSSLAcceptServerCertEncodedB :(NSData*)newSSLAcceptServerCertEncoded;
Default Value
""
Remarks
If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
SSLCert Property (AzureKeys Module)
The certificate to be used during Secure Sockets Layer (SSL) negotiation.
Syntax
public var sslCert: Certificate { get {...} set {...} }
@property (nonatomic,readonly,assign,getter=SSLCertEffectiveDate) NSString* SSLCertEffectiveDate; - (NSString*)SSLCertEffectiveDate; @property (nonatomic,readonly,assign,getter=SSLCertExpirationDate) NSString* SSLCertExpirationDate; - (NSString*)SSLCertExpirationDate; @property (nonatomic,readonly,assign,getter=SSLCertExtendedKeyUsage) NSString* SSLCertExtendedKeyUsage; - (NSString*)SSLCertExtendedKeyUsage; @property (nonatomic,readonly,assign,getter=SSLCertFingerprint) NSString* SSLCertFingerprint; - (NSString*)SSLCertFingerprint; @property (nonatomic,readonly,assign,getter=SSLCertFingerprintSHA1) NSString* SSLCertFingerprintSHA1; - (NSString*)SSLCertFingerprintSHA1; @property (nonatomic,readonly,assign,getter=SSLCertFingerprintSHA256) NSString* SSLCertFingerprintSHA256; - (NSString*)SSLCertFingerprintSHA256; @property (nonatomic,readonly,assign,getter=SSLCertIssuer) NSString* SSLCertIssuer; - (NSString*)SSLCertIssuer; @property (nonatomic,readonly,assign,getter=SSLCertPrivateKey) NSString* SSLCertPrivateKey; - (NSString*)SSLCertPrivateKey; @property (nonatomic,readonly,assign,getter=SSLCertPrivateKeyAvailable) BOOL SSLCertPrivateKeyAvailable; - (BOOL)SSLCertPrivateKeyAvailable; @property (nonatomic,readonly,assign,getter=SSLCertPrivateKeyContainer) NSString* SSLCertPrivateKeyContainer; - (NSString*)SSLCertPrivateKeyContainer; @property (nonatomic,readonly,assign,getter=SSLCertPublicKey) NSString* SSLCertPublicKey; - (NSString*)SSLCertPublicKey; @property (nonatomic,readonly,assign,getter=SSLCertPublicKeyAlgorithm) NSString* SSLCertPublicKeyAlgorithm; - (NSString*)SSLCertPublicKeyAlgorithm; @property (nonatomic,readonly,assign,getter=SSLCertPublicKeyLength) int SSLCertPublicKeyLength; - (int)SSLCertPublicKeyLength; @property (nonatomic,readonly,assign,getter=SSLCertSerialNumber) NSString* SSLCertSerialNumber; - (NSString*)SSLCertSerialNumber; @property (nonatomic,readonly,assign,getter=SSLCertSignatureAlgorithm) NSString* SSLCertSignatureAlgorithm; - (NSString*)SSLCertSignatureAlgorithm; @property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore; - (NSString*)SSLCertStore; - (void)setSSLCertStore :(NSString*)newSSLCertStore; @property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB; - (NSData*)SSLCertStoreB; - (void)setSSLCertStoreB :(NSData*)newSSLCertStore; @property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword; - (NSString*)SSLCertStorePassword; - (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword; @property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType; - (int)SSLCertStoreType; - (void)setSSLCertStoreType :(int)newSSLCertStoreType; @property (nonatomic,readonly,assign,getter=SSLCertSubjectAltNames) NSString* SSLCertSubjectAltNames; - (NSString*)SSLCertSubjectAltNames; @property (nonatomic,readonly,assign,getter=SSLCertThumbprintMD5) NSString* SSLCertThumbprintMD5; - (NSString*)SSLCertThumbprintMD5; @property (nonatomic,readonly,assign,getter=SSLCertThumbprintSHA1) NSString* SSLCertThumbprintSHA1; - (NSString*)SSLCertThumbprintSHA1; @property (nonatomic,readonly,assign,getter=SSLCertThumbprintSHA256) NSString* SSLCertThumbprintSHA256; - (NSString*)SSLCertThumbprintSHA256; @property (nonatomic,readonly,assign,getter=SSLCertUsage) NSString* SSLCertUsage; - (NSString*)SSLCertUsage; @property (nonatomic,readonly,assign,getter=SSLCertUsageFlags) int SSLCertUsageFlags; - (int)SSLCertUsageFlags; @property (nonatomic,readonly,assign,getter=SSLCertVersion) NSString* SSLCertVersion; - (NSString*)SSLCertVersion; @property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject; - (NSString*)SSLCertSubject; - (void)setSSLCertSubject :(NSString*)newSSLCertSubject; @property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded; - (NSString*)SSLCertEncoded; - (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded; @property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB; - (NSData*)SSLCertEncodedB; - (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;
Default Value
""
Remarks
This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the store and subject fields.
SSLProvider Property (AzureKeys Module)
The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
public var sslProvider: AzureKeysSSLProviders { get {...} set {...} }
public enum AzureKeysSSLProviders: Int32 { case sslpAutomatic = 0 case sslpPlatform = 1 case sslpInternal = 2 }
@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider; - (int)SSLProvider; - (void)setSSLProvider :(int)newSSLProvider;
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 class 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. |
In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.
When Automatic is selected, the platform implementation will be used by default in all cases in the macOS edition.
SSLServerCert Property (AzureKeys Module)
The server certificate for the last established connection.
Syntax
public var sslServerCert: Certificate { get {...} }
@property (nonatomic,readonly,assign,getter=SSLServerCertEffectiveDate) NSString* SSLServerCertEffectiveDate; - (NSString*)SSLServerCertEffectiveDate; @property (nonatomic,readonly,assign,getter=SSLServerCertExpirationDate) NSString* SSLServerCertExpirationDate; - (NSString*)SSLServerCertExpirationDate; @property (nonatomic,readonly,assign,getter=SSLServerCertExtendedKeyUsage) NSString* SSLServerCertExtendedKeyUsage; - (NSString*)SSLServerCertExtendedKeyUsage; @property (nonatomic,readonly,assign,getter=SSLServerCertFingerprint) NSString* SSLServerCertFingerprint; - (NSString*)SSLServerCertFingerprint; @property (nonatomic,readonly,assign,getter=SSLServerCertFingerprintSHA1) NSString* SSLServerCertFingerprintSHA1; - (NSString*)SSLServerCertFingerprintSHA1; @property (nonatomic,readonly,assign,getter=SSLServerCertFingerprintSHA256) NSString* SSLServerCertFingerprintSHA256; - (NSString*)SSLServerCertFingerprintSHA256; @property (nonatomic,readonly,assign,getter=SSLServerCertIssuer) NSString* SSLServerCertIssuer; - (NSString*)SSLServerCertIssuer; @property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKey) NSString* SSLServerCertPrivateKey; - (NSString*)SSLServerCertPrivateKey; @property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKeyAvailable) BOOL SSLServerCertPrivateKeyAvailable; - (BOOL)SSLServerCertPrivateKeyAvailable; @property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKeyContainer) NSString* SSLServerCertPrivateKeyContainer; - (NSString*)SSLServerCertPrivateKeyContainer; @property (nonatomic,readonly,assign,getter=SSLServerCertPublicKey) NSString* SSLServerCertPublicKey; - (NSString*)SSLServerCertPublicKey; @property (nonatomic,readonly,assign,getter=SSLServerCertPublicKeyAlgorithm) NSString* SSLServerCertPublicKeyAlgorithm; - (NSString*)SSLServerCertPublicKeyAlgorithm; @property (nonatomic,readonly,assign,getter=SSLServerCertPublicKeyLength) int SSLServerCertPublicKeyLength; - (int)SSLServerCertPublicKeyLength; @property (nonatomic,readonly,assign,getter=SSLServerCertSerialNumber) NSString* SSLServerCertSerialNumber; - (NSString*)SSLServerCertSerialNumber; @property (nonatomic,readonly,assign,getter=SSLServerCertSignatureAlgorithm) NSString* SSLServerCertSignatureAlgorithm; - (NSString*)SSLServerCertSignatureAlgorithm; @property (nonatomic,readonly,assign,getter=SSLServerCertStore) NSString* SSLServerCertStore; - (NSString*)SSLServerCertStore; @property (nonatomic,readonly,assign,getter=SSLServerCertStoreB) NSData* SSLServerCertStoreB; - (NSData*)SSLServerCertStoreB; @property (nonatomic,readonly,assign,getter=SSLServerCertStorePassword) NSString* SSLServerCertStorePassword; - (NSString*)SSLServerCertStorePassword; @property (nonatomic,readonly,assign,getter=SSLServerCertStoreType) int SSLServerCertStoreType; - (int)SSLServerCertStoreType; @property (nonatomic,readonly,assign,getter=SSLServerCertSubjectAltNames) NSString* SSLServerCertSubjectAltNames; - (NSString*)SSLServerCertSubjectAltNames; @property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintMD5) NSString* SSLServerCertThumbprintMD5; - (NSString*)SSLServerCertThumbprintMD5; @property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintSHA1) NSString* SSLServerCertThumbprintSHA1; - (NSString*)SSLServerCertThumbprintSHA1; @property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintSHA256) NSString* SSLServerCertThumbprintSHA256; - (NSString*)SSLServerCertThumbprintSHA256; @property (nonatomic,readonly,assign,getter=SSLServerCertUsage) NSString* SSLServerCertUsage; - (NSString*)SSLServerCertUsage; @property (nonatomic,readonly,assign,getter=SSLServerCertUsageFlags) int SSLServerCertUsageFlags; - (int)SSLServerCertUsageFlags; @property (nonatomic,readonly,assign,getter=SSLServerCertVersion) NSString* SSLServerCertVersion; - (NSString*)SSLServerCertVersion; @property (nonatomic,readonly,assign,getter=SSLServerCertSubject) NSString* SSLServerCertSubject; - (NSString*)SSLServerCertSubject; @property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded; - (NSString*)SSLServerCertEncoded; @property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB; - (NSData*)SSLServerCertEncodedB;
Default Value
""
Remarks
This property contains the server certificate for the last established connection.
SSLServerCert is reset every time a new connection is attempted.
Tags Property (AzureKeys Module)
A collection of tags.
Syntax
public var tags: Array<AzureTag> { get {...} }
@property (nonatomic,readwrite,assign,getter=tagCount,setter=setTagCount:) int tagCount; - (int)tagCount; - (void)setTagCount :(int)newTagCount; - (NSString*)tagName:(int)tagIndex; - (void)setTagName:(int)tagIndex :(NSString*)newTagName; - (NSString*)tagValue:(int)tagIndex; - (void)setTagValue:(int)tagIndex :(NSString*)newTagValue;
Default Value
""
Remarks
This collection holds a list of AzureTag items.
Calling AddTag or GetKeyInfo will populate this collection. The items in this collection are used by the CreateKey and UpdateKey methods.
Timeout Property (AzureKeys Module)
The timeout for the module.
Syntax
public var timeout: Int32 { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout; - (int)timeout; - (void)setTimeout :(int)newTimeout;
Default Value
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 class will wait for the operation to complete before returning control.
The class will use DoEvents 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 class .
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.
Vault Property (AzureKeys Module)
Selects a vault for the module to interact with.
Syntax
public var vault: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=vault,setter=setVault:) NSString* vault; - (NSString*)vault; - (void)setVault :(NSString*)newVault;
Default Value
""
Remarks
This property specifies the Azure Key Vault vault, by name, that the class should interact with.
VersionMarker Property (AzureKeys Module)
A marker indicating what page of key versions to return next.
Syntax
public var versionMarker: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=versionMarker,setter=setVersionMarker:) NSString* versionMarker; - (NSString*)versionMarker; - (void)setVersionMarker :(NSString*)newVersionMarker;
Default Value
""
Remarks
This property will be populated when ListVersions is called if the results are paged and there are more pages. To list all key versions, continue to call ListVersions until this property returns empty string.
Refer to ListVersions for more information.
AddQueryParam Method (AzureKeys Module)
Adds a query parameter to the QueryParams properties.
Syntax
- (void)addQueryParam:(NSString*)name :(NSString*)value;
Remarks
This method is used to add a query parameter to the QueryParams properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.
All specified Values will be URL encoded by the class automatically. Consult the service documentation for details on the available parameters.
AddTag Method (AzureKeys Module)
Adds an item to the Tags properties.
Syntax
- (void)addTag:(NSString*)name :(NSString*)value;
Remarks
This method adds an item to the Tags properties. Name specifies the name of the item, and Value specifies the value of the item.
Authorize Method (AzureKeys Module)
Get the authorization string required to access the protected resource.
Syntax
public func authorize() throws -> Void
- (void)authorize;
Remarks
This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the OAuthClientProfile property and the OAuthGrantType property. This method is not to be used in conjunction with the Authorization property. It should instead be used when setting the OAuth property.
For more information, see the introduction section.
BackupKey Method (AzureKeys Module)
Backs up a key.
Syntax
Remarks
This method backs up the key specified by KeyName, returning it in a protected form via the the specified OutputFile or the OutputData property.
Note that the protected key cannot be used outside of Azure Key Vault, it must be restored to another vault using the RestoreKey method in order to be used.
Config Method (AzureKeys Module)
Sets or retrieves a configuration setting.
Syntax
- (NSString*)config:(NSString*)configurationString;
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
CreateKey Method (AzureKeys Module)
Creates a new key.
Syntax
- (NSString*)createKey:(NSString*)keyName :(NSString*)keyType :(NSString*)keyOps;
Remarks
This method creates a new key with the given KeyName and KeyType. If a key with the specified KeyName already exists, a new version of it is created. The version Id of the newly-created key is returned.
The value passed for KeyName must consist solely of alphanumeric characters and hyphens (-).
The KeyType parameter specifies the type of key that should be created. Each key type has two variants, a software-based one and an HSM-based one. Possible values are shown in the first two columns of the following table:
| Software-based | HSM-based | Description |
| EC_P256 | EC_HSM_P256 | The NIST P-256 curve (SECP256R1). |
| EC_P256K | EC_HSM_P256K | The SECP256K1 curve. |
| EC_P384 | EC_HSM_P384 | The NIST P-384 curve (SECP384R1). |
| EC_P521 | EC_HSM_P521 | The NIST P-521 curve (SECP521R1). |
| RSA_2048 | RSA_HSM_2048 | 2048-bit RSA key. |
| RSA_3072 | RSA_HSM_3072 | 3072-bit RSA key. |
| RSA_4096 | RSA_HSM_4096 | 4096-bit RSA key. |
The KeyOps parameter specifies which operations the key will be valid for use with. Possible values are as follows; at least one pair of operations must be specified:
- encrypt
- decrypt
- sign
- verify
- wrapKey
- unwrapKey
If there are any items in the Tags properties, they will be applied to the newly-created key. Keys may have up to 15 tags.
The following configuration settings can also be used to send additional values when creating the key, refer to their documentation for more information:
Note: If there is already a soft-deleted key with the specified KeyName in the currently-selected Vault, then a new key cannot be created with the same name. To resolve such a situation, the soft-deleted key would need to be recovered (using RecoverKey) or permanently deleted (using PurgeKey) first.
Decrypt Method (AzureKeys Module)
Decrypts data using a key.
Syntax
- (void)decrypt:(NSString*)keyName :(NSString*)algorithm;
Remarks
This method decrypts data using the key specified by KeyName and the given Algorithm. The VersionId configuration setting can be used to target a specific key version.
The data to decrypt is taken from the the specified InputFile or the InputData property. The decrypted data is output to the the specified OutputFile or the OutputData property.
The key specified by KeyName must be an RSA key; EC keys cannot be used for encryption/decryption.
The Algorithm parameter specifies which algorithm to use to decrypt the data; it must match the algorithm used to encrypt the data previously. Possible values are:
| Algorithm | Description |
| RSA1_5 | RSAES-PKCS1-v1_5 |
| RSA-OAEP | RSAES OAEP using SHA-1 and MGF1 with SHA-1 |
| RSA-OAEP-256 | RSAES OAEP using SHA-256 and MGF1 with SHA-256 |
DeleteKey Method (AzureKeys Module)
Deletes a key.
Syntax
Remarks
This method deletes the key specified by KeyName. If there are multiple versions of the key, all of them are deleted.
Note that the key is only soft-deleted; it can be recovered during the retention period using the RecoverKey method, or permanently deleted using the PurgeKey method. The length of the retention period depends on the configuration of the currently-selected Vault, refer to the Azure Key Vault documentation for more information.
DoEvents Method (AzureKeys Module)
This method processes events from the internal message queue.
Syntax
public func doEvents() throws -> Void
- (void)doEvents;
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
Encrypt Method (AzureKeys Module)
Encrypts data using a key.
Syntax
- (void)encrypt:(NSString*)keyName :(NSString*)algorithm;
Remarks
This method encrypts data using the key specified by KeyName and the given Algorithm. The VersionId configuration setting can be used to target a specific key version.
The data to encrypt is taken from the the specified InputFile or the InputData property. The encrypted data is output to the the specified OutputFile or the OutputData property.
The key specified by KeyName must be an RSA key; EC keys cannot be used for encryption/decryption.
The Algorithm parameter specifies which algorithm to use to encrypt the data. The type of key and the selected algorithm together dictate the maximum size of the input data. Refer to the following table for possible values and maximum data sizes:
| Algorithm | Description | RSA_2048 | RSA_3072 | RSA_4096 |
| RSA1_5 | RSAES-PKCS1-v1_5 | 245 | 373 | 509 |
| RSA-OAEP | RSAES OAEP using SHA-1 and MGF1 with SHA-1 | 214 | 342 | 470 |
| RSA-OAEP-256 | RSAES OAEP using SHA-256 and MGF1 with SHA-256 | 190 | 318 | 446 |
GetKeyInfo Method (AzureKeys Module)
Gets a key's information and public key.
Syntax
Remarks
This method gets the information, including the public key, for the key specified by KeyName. The VersionId configuration setting can be used to target a specific key version. Alternatively, the GetDeleted configuration setting can be enabled to get a soft-deleted key's information (but only for the last version).
When the information is returned, the class clears the Keys properties and repopulates it properties with the key's tags. The KeyList event is also fired.
ListKeys Method (AzureKeys Module)
Lists keys in the currently-selected vault.
Syntax
public func listKeys() throws -> Void
- (void)listKeys;
Remarks
This method lists the keys in the currently-selected Vault. If the GetDeleted configuration setting is enabled, it lists the soft-deleted keys in the vault instead.
Calling this method will fire the KeyList event once for each key, and will also populate the Keys properties. However, note that by default the following properties will not be populated, since the server does not return full information for keys when listing them. The IncludeKeyDetails property can be enabled to have the class attempt to retrieve full information for each key; refer to its documentation for more information.
- KeysKeyOps
- KeysKeyType
- KeysPublicKey
- KeysVersionId
If there are still more keys available to list when this method returns, the KeyMarker property will be populated. Continue to call this method until KeyMarker is empty to accumulate all pages of results in the Keys properties.
The MaxKeys configuration setting can be used to control the maximum number of results to return at once.
ListVersions Method (AzureKeys Module)
Lists versions of a key.
Syntax
Remarks
This method lists the versions of the key specified by KeyName.
Calling this method will fire the KeyList event once for each key version, and will also populate the Keys properties. However, note that by default the following properties will not be populated, since the server does not return full information for key versions when listing them. The IncludeKeyDetails property can be enabled to have the class attempt to retrieve full information for each key version; refer to its documentation for more information.
- KeysKeyOps
- KeysKeyType
- KeysPublicKey
If there are still more key versions available to list when this method returns, the VersionMarker property will be populated. Continue to call this method until VersionMarker is empty to accumulate all pages of results in the Keys properties.
The MaxKeys configuration setting can be used to control the maximum number of results to return at once.
PurgeKey Method (AzureKeys Module)
Permanently deletes a soft-deleted key.
Syntax
Remarks
This method permanently deletes the soft-deleted key specified by KeyName.
RecoverKey Method (AzureKeys Module)
Recovers a soft-deleted key.
Syntax
Remarks
This method recovers the soft-deleted key specified by KeyName.
Reset Method (AzureKeys Module)
Resets the component to its initial state.
Syntax
public func reset() throws -> Void
- (void)reset;
Remarks
This method resets the class to its initial state.
RestoreKey Method (AzureKeys Module)
Restores a previously backed-up key to the vault.
Syntax
public func restoreKey() throws -> String
- (NSString*)restoreKey;
Remarks
This method restores a key previously backed up using BackupKey to the currently-selected Vault. The key is restored in its entirety, with all of its versions intact. However, note that the restore will fail if the key's name is already in use. The name of the restored key is returned.
The protected key data to restore is taken from the the specified InputFile or the InputData property.
Note: There are certain restrictions on which vaults a key can be restored to. In particular, a key must be restored to a vault owned by the same Azure subscription that owned its original vault, and must be restored to a vault in the same geolocation as its original vault. Refer to the Azure Key Vault documentation for more information.
SendCustomRequest Method (AzureKeys Module)
Sends a custom request to the server.
Syntax
- (void)sendCustomRequest:(NSString*)httpMethod :(NSString*)path;
Remarks
This method can be used to send arbitrary requests to the server.
Valid values for HttpMethod are:
- GET (default if empty)
- HEAD
- POST
- PUT
- PATCH
- DELETE
Path is optional, and if non-empty must be specified without a leading forward slash (/).
When this method is called, the class does the following:
- Builds a request URL, including query parameters, based on the following:
- The base URL https://{Vault}.vault.azure.net/keys, where {Vault} is Vault.
- The specified Path, if any.
- An api-version query parameter whose value is APIVersion.
- All query parameters from QueryParams.
- Adds an Authorization header with the value specified by Authorization.
- Adds any request headers from OtherHeaders.
- Adds any request body supplied via the specified InputFile or InputData.
- Sends the request to the server.
- Stores the response headers in the ParsedHeaders properties; and the response body in the specified OutputFile or OutputData.
If the response body is JSON data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.
SetKeyEnabled Method (AzureKeys Module)
Enables or disables a key.
Syntax
- (void)setKeyEnabled:(NSString*)keyName :(BOOL)enabled;
Remarks
This method enables or disables the key specified by KeyName.
Sign Method (AzureKeys Module)
Signs a message using a key.
Syntax
- (void)sign:(NSString*)keyName :(NSString*)algorithm :(BOOL)isDigest;
Remarks
This method signs a message using the key specified by KeyName and the given Algorithm. The VersionId configuration setting can be used to target a specific key version.
The message data to sign is taken from the the specified InputFile or the InputData property. The signature data is output to the the specified OutputFile or the OutputData property.
The Algorithm parameter specifies which algorithm to use to sign the data. Possible values are:
- ES256: ECDSA using P-256 and SHA-256.
- ES256K: ECDSA using P-256K and SHA-256.
- ES384: ECDSA using P-384 and SHA-384.
- ES512: ECDSA using P-521 and SHA-512.
- PS256: RSASSA-PSS using SHA-256 and MGF1 with SHA-256.
- PS384: RSASSA-PSS using SHA-384 and MGF1 with SHA-384.
- PS512: RSASSA-PSS using SHA-512 and MGF1 with SHA-512.
- RS256: RSASSA-PKCS1-v1_5 using SHA-256.
- RS384: RSASSA-PKCS1-v1_5 using SHA-384.
- RS512: RSASSA-PKCS1-v1_5 using SHA-512.
The IsDigest parameter specifies whether the message data is the original message () or a message digest (). When supplying a message digest, keep in mind that the same digest will need to be provided in order to Verify the signature later.
If IsDigest is , the class will automatically compute an appropriate message digest before the request is made. In such cases, the computed digest is made available via the MessageDigest configuration setting.
UnwrapKey Method (AzureKeys Module)
Unwraps a symmetric key.
Syntax
- (void)unwrapKey:(NSString*)keyName :(NSString*)algorithm;
Remarks
This method unwraps (i.e., decrypts) a symmetric key using the key specified by KeyName and the given Algorithm.
This method functions exactly the same way as the Decrypt method, except that it requires the keys/unwrapKey permission instead of the keys/decrypt permission. Refer to the Decrypt method's documentation for more information.
UpdateKey Method (AzureKeys Module)
Updates a key's information.
Syntax
- (void)updateKey:(NSString*)keyName :(NSString*)keyOps :(BOOL)updateTags;
Remarks
This method updates the information for the key specified by KeyName. The VersionId configuration setting can be used to target a specific key version.
The KeyOps parameter, if non-empty, must be a comma-separated list of operations that the key is valid for. If empty, the key's current operations list remains unchanged. Possible values are as follows; operations should be specified in pairs:
- encrypt
- decrypt
- sign
- verify
- wrapKey
- unwrapKey
The UpdateTags parameter determines whether the class replaces the key's current tags with the items in the Tags properties (which may be empty). Keys may have up to 15 tags.
The ExpiryDate and NotBeforeDate configuration settings may also be used to send additional values, refer to their documentation for more information.
Verify Method (AzureKeys Module)
Verifies a digital signature using a key.
Syntax
- (BOOL)verify:(NSString*)keyName :(NSString*)algorithm :(BOOL)isDigest;
Remarks
This method verifies a digital signature using the key specified by KeyName and the given Algorithm. The VersionId configuration setting can be used to target a specific key version. If the signature is successfully verified, this method returns , otherwise it returns .
The message data is taken from the the specified InputFile or the InputData property. The digital signature data is taken from the specified OutputFile or the OutputData property.
The Algorithm parameter specifies which algorithm was used to sign the data. Possible values are:
- ES256: ECDSA using P-256 and SHA-256.
- ES256K: ECDSA using P-256K and SHA-256.
- ES384: ECDSA using P-384 and SHA-384.
- ES512: ECDSA using P-521 and SHA-512.
- PS256: RSASSA-PSS using SHA-256 and MGF1 with SHA-256.
- PS384: RSASSA-PSS using SHA-384 and MGF1 with SHA-384.
- PS512: RSASSA-PSS using SHA-512 and MGF1 with SHA-512.
- RS256: RSASSA-PKCS1-v1_5 using SHA-256.
- RS384: RSASSA-PKCS1-v1_5 using SHA-384.
- RS512: RSASSA-PKCS1-v1_5 using SHA-512.
The IsDigest parameter specifies whether the message data is the original message () or a message digest (). When a message digest is supplied, keep in mind that it must be the exact same digest that was used at signing time, regardless of whether it has been recomputed.
If IsDigest is , the class will automatically compute an appropriate message digest before the request is made. In such cases, the computed digest is made available via the MessageDigest configuration setting.
WrapKey Method (AzureKeys Module)
Wraps a symmetric key.
Syntax
- (void)wrapKey:(NSString*)keyName :(NSString*)algorithm;
Remarks
This method wraps (i.e., encrypts) a symmetric key using the key specified by KeyName and the given Algorithm. The VersionId configuration setting can be used to target a specific key version.
This method functions exactly the same way as the Encrypt method, except that it requires the keys/wrapKey permission instead of the keys/encrypt permission. Refer to the Encrypt method's documentation for more information.
EndTransfer Event (AzureKeys Module)
This event fires when a document finishes transferring.
Syntax
func onEndTransfer(direction: Int32)
- (void)onEndTransfer:(int)direction;
Remarks
The EndTransfer event is fired 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 (AzureKeys Module)
Fired when information is available about errors during data delivery.
Syntax
- (void)onError:(int)errorCode :(NSString*)description;
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class .
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 section.
Header Event (AzureKeys Module)
Fired every time a header line comes in.
Syntax
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).
KeyList Event (AzureKeys Module)
Fires once for each key when listing keys.
Syntax
func onKeyList(name: String, versionId: String, keyType: String, keyOps: String, enabled: Bool, creationDate: Int64, updateDate: Int64, deletionDate: Int64, purgeDate: Int64, publicKey: String)
- (void)onKeyList:(NSString*)name :(NSString*)versionId :(NSString*)keyType :(NSString*)keyOps :(BOOL)enabled :(long long)creationDate :(long long)updateDate :(long long)deletionDate :(long long)purgeDate :(NSString*)publicKey;
Remarks
This event fires once for each key (or key version) returned when ListKeys, ListVersions, or GetKeyInfo is called. However, note that the KeyOps, KeyType, PublicKey, and (for ListKeys) VersionId parameters are not populated when one of the listing methods is called unless the IncludeKeyDetails property is enabled; refer to its documentation for more information.
Name reflects the name of the key.
VersionId reflects the Id of the key version.
KeyType reflects the key's type. Each key type has two variants, a software-based one and an HSM-based one. Possible values are shown in the first two columns of the following table:
| Software-based | HSM-based | Description |
| EC_P256 | EC_HSM_P256 | The NIST P-256 curve (SECP256R1). |
| EC_P256K | EC_HSM_P256K | The SECP256K1 curve. |
| EC_P384 | EC_HSM_P384 | The NIST P-384 curve (SECP384R1). |
| EC_P521 | EC_HSM_P521 | The NIST P-521 curve (SECP521R1). |
| RSA_2048 | RSA_HSM_2048 | 2048-bit RSA key. |
| RSA_3072 | RSA_HSM_3072 | 3072-bit RSA key. |
| RSA_4096 | RSA_HSM_4096 | 4096-bit RSA key. |
KeyOps reflects a comma-separated list of operations that the key may be used for. Possible values are:
- encrypt
- decrypt
- sign
- verify
- wrapKey
- unwrapKey
Enabled reflects whether the key is currently enabled.
CreationDate reflects the key's creation date, in seconds since the Unix epoch.
UpdateDate reflects the key's update date, in seconds since the Unix epoch.
DeletionDate reflects the key's deletion date, in seconds since the Unix epoch, or -1 if the key has not been deleted.
PurgeDate reflects the key's purge (i.e., permanent deletion) date, in seconds since the Unix epoch, or -1 if the key has not been deleted.
PublicKey reflects the key's public key, in PEM format.
Log Event (AzureKeys Module)
Fired once for each log message.
Syntax
- (void)onLog:(int)logLevel :(NSString*)message :(NSString*)logType;
Remarks
This event is fired once for each log message generated by the class. The verbosity is controlled by the 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"
SSLServerAuthentication Event (AzureKeys Module)
Fired after the server presents its certificate to the client.
Syntax
func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)
- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;
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 (AzureKeys Module)
Fired when secure connection progress messages are available.
Syntax
func onSSLStatus(message: String)
- (void)onSSLStatus:(NSString*)message;
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (AzureKeys Module)
This event fires when a document starts transferring (after the headers).
Syntax
func onStartTransfer(direction: Int32)
- (void)onStartTransfer:(int)direction;
Remarks
The StartTransfer event is fired 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.
TagList Event (AzureKeys Module)
Fires once for each tag returned when a key's information is retrieved.
Syntax
- (void)onTagList:(NSString*)keyName :(NSString*)versionId :(NSString*)name :(NSString*)value;
Remarks
This event fires once for each tag returned when GetKeyInfo is called.
KeyName reflects the name of the key.
VersionId reflects the Id of the key version.
Name reflects the name of the tag.
Value reflects the value of the tag.
Transfer Event (AzureKeys Module)
Fired while a document transfers (delivers document).
Syntax
- (void)onTransfer:(int)direction :(long long)bytesTransferred :(int)percentDone :(NSData*)text;
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.
AzureKey Type
An Azure Key Vault key.
Remarks
This type represents an Azure Key Vault key.
Fields
creationDate
Int64 (read-only)
Default Value: -1
The creation date of the key.
This property reflects the creation date of the key, in seconds since the Unix epoch.
deletionDate
Int64 (read-only)
Default Value: -1
The deletion date of the key.
This property reflects the deletion date of the key, in seconds since the Unix epoch, or -1 if the key has not been deleted.
enabled
Bool (read-only)
Default Value: False
Whether the key is enabled.
This property reflects whether the key is currently enabled.
expiryDate
Int64 (read-only)
Default Value: -1
The expiration date of the key.
This property reflects the expiration date of the key, in seconds since the Unix epoch, or -1 if the key does not expire.
A key can only be used for the Decrypt, Verify, and UnwrapKey operations after its expiry date.
keyOps
String (read-only)
Default Value: ""
The operation that the key may be used for.
This property reflects a comma-separated list of operations that they key may be used for. Possible values are:
- encrypt
- decrypt
- sign
- verify
- wrapKey
- unwrapKey
keyType
String (read-only)
Default Value: ""
The key's type.
This property reflects the key's type. Each key type has two variants, a software-based one and an HSM-based one. Possible values for this property are shown in the first two columns of the following table:
| Software-based | HSM-based | Description |
| EC_P256 | EC_HSM_P256 | The NIST P-256 curve (SECP256R1). |
| EC_P256K | EC_HSM_P256K | The SECP256K1 curve. |
| EC_P384 | EC_HSM_P384 | The NIST P-384 curve (SECP384R1). |
| EC_P521 | EC_HSM_P521 | The NIST P-521 curve (SECP521R1). |
| RSA_2048 | RSA_HSM_2048 | 2048-bit RSA key. |
| RSA_3072 | RSA_HSM_3072 | 3072-bit RSA key. |
| RSA_4096 | RSA_HSM_4096 | 4096-bit RSA key. |
name
String (read-only)
Default Value: ""
The name of the key.
This property reflects the name of the key.
notBeforeDate
Int64 (read-only)
Default Value: -1
The 'not before' date of the key.
This property reflects the "not before" date of the key, in seconds since the Unix epoch, or -1 if the key doesn't have an explicit "not before" date.
A key can only be used for the Decrypt, Verify, and UnwrapKey operations prior to its "not before" date.
publicKey
String (read-only)
Default Value: ""
The key's public key.
This property reflects the public key of the key, in PEM format.
purgeDate
Int64 (read-only)
Default Value: -1
The purge date of the key.
This property reflects the purge (i.e., permanent deletion) date of the key, in seconds since the Unix epoch, or -1 if the key has not been deleted.
recoverableDays
Int32 (read-only)
Default Value: 0
The number of days the key will be recoverable if it gets deleted.
This property reflects the number of days that the key will be recoverable for if it gets deleted.
Note that this property's value is based on the retention policy of the currently-selected Vault; it will not change after the key has actually been deleted.
recoveryLevel
String (read-only)
Default Value: ""
The key's ability to be recovered and/or purged if it gets deleted.
This property reflects the key's ability to be recovered and/or purged (i.e., permanently deleted) if it gets deleted. Possible values are as follows; please refer to this part of the Azure Key Vault documentation for more information about each one:
- CustomizedRecoverable
- CustomizedRecoverable+ProtectedSubscription
- CustomizedRecoverable+Purgeable
- Purgeable
- Recoverable
- Recoverable+ProtectedSubscription
- Recoverable+Purgeable
updateDate
Int64 (read-only)
Default Value: -1
The update date of the key.
This property reflects the update date of the key, in seconds since the Unix epoch.
versionId
String (read-only)
Default Value: ""
The version Id of the key.
This property reflects the version Id of the key.
AzureTag Type
An Azure Key Vault tag.
Remarks
This type represents an Azure Key Vault tag.
Fields
Constructors
public init()
public init(name: , value: )
Certificate Type
This is the digital certificate being used.
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
effectiveDate
String (read-only)
Default Value: ""
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.
expirationDate
String (read-only)
Default Value: ""
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.
extendedKeyUsage
String (read-only)
Default Value: ""
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
fingerprint
String (read-only)
Default Value: ""
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
fingerprintSHA1
String (read-only)
Default Value: ""
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
fingerprintSHA256
String (read-only)
Default Value: ""
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
issuer
String (read-only)
Default Value: ""
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
privateKey
String (read-only)
Default Value: ""
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The may be available but not exportable. In this case, returns an empty string.
privateKeyAvailable
Bool (read-only)
Default Value: False
Whether a is available for the selected certificate. If is True, the certificate may be used for authentication purposes (e.g., server authentication).
privateKeyContainer
String (read-only)
Default Value: ""
The name of the container for the certificate (if available). This functionality is available only on Windows platforms.
publicKey
String (read-only)
Default Value: ""
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
publicKeyAlgorithm
String (read-only)
Default Value: ""
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.
publicKeyLength
Int32 (read-only)
Default Value: 0
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
serialNumber
String (read-only)
Default Value: ""
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.
signatureAlgorithm
String (read-only)
Default Value: ""
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.
storeB
Data
Default Value: "MY"
The name of the certificate store for the client certificate.
The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in .
is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the 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).
store
String
Default Value: "MY"
The name of the certificate store for the client certificate.
The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in .
is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the 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).
storePassword
String
Default Value: ""
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
storeType
CertStoreTypes
Default Value: 0
The type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
subjectAltNames
String (read-only)
Default Value: ""
Comma-separated lists of alternative subject names for the certificate.
thumbprintMD5
String (read-only)
Default Value: ""
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.
thumbprintSHA1
String (read-only)
Default Value: ""
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.
thumbprintSHA256
String (read-only)
Default Value: ""
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.
usage
String (read-only)
Default Value: ""
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.
usageFlags
Int32 (read-only)
Default Value: 0
The flags that show intended use for the certificate. The value of 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 property for a text representation of .
This functionality currently is not available when the provider is OpenSSL.
version
String (read-only)
Default Value: ""
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
subject
String
Default Value: ""
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=support@nsoftware.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.
encodedB
Data
Default Value: ""
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate.
When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string.
encoded
String
Default Value: ""
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate.
When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string.
Constructors
public init()
Creates a instance whose properties can be set. This is useful for use with when generating new certificates.
public init(encoded: )
Parses Encoded as an X.509 public key.
public init(storeType: , store: , storePassword: , subject: )
StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.
After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public init(storeType: , store: , storePassword: , subject: )
StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.
After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
Firewall Type
The firewall the component will connect through.
Remarks
When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the .
Fields
autoDetect
Bool
Default Value: False
Whether to automatically detect and use firewall system settings, if available.
firewallType
FirewallTypes
Default Value: 0
The type of firewall to connect through. The applicable values are as follows:
host
String
Default Value: ""
The name or IP address of the firewall (optional). If a 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 class .
password
String
Default Value: ""
A password if authentication is to be used when connecting through the firewall. If is specified, the and properties are used to connect and authenticate to the given firewall. If the authentication fails, the class .
port
Int32
Default Value: 0
The Transmission Control Protocol (TCP) port for the firewall . See the description of the property for details.
Note: This property is set automatically when is set to a valid value. See the description of the property for details.
user
String
Default Value: ""
A username if authentication is to be used when connecting through a firewall. If is specified, this property and the property are used to connect and authenticate to the given Firewall. If the authentication fails, the class .
Constructors
public init()
Header Type
This is an HTTP header as it is received from the server.
Remarks
When a header is received through a Header event, it is parsed into a Header type. This type contains a , and its corresponding .
Fields
field
String
Default Value: ""
This property contains the name of the HTTP Header (this is the same case as it is delivered).
value
String
Default Value: ""
This property contains the Header contents.
Constructors
public init()
public init(field: , value: )
OAuthSettings Type
The settings to use to authenticate with the service provider.
Remarks
Used to set give the class the necessary information needed to complete OAuth authentication.
Fields
accessToken
String
Default Value: ""
The access token returned by the authorization server. This is set when the class makes a request to the token server.
authorizationCode
String
Default Value: ""
The authorization code that is exchanged for an access token. This is required to be set when the OAuthClientProfile property is set to the Web profile. Otherwise, this field is for information purposes only.
authorizationScope
String
Default Value: ""
The scope request or response parameter used during authorization.
clientId
String
Default Value: ""
The id of the client assigned when registering the application.
clientProfile
CloudOAuthClientProfiles
Default Value: 0
The type of client that is requesting authorization. See the introduction section for more information. Possible values are:
| 0 (cocpApplication - Default) | The application profile is applicable to applications that are run by the user directly. For instance a windows form application would use the application profile. To authorize your application (client) using the application profile see the introduction section. |
| 1 (cocpWeb) | The Web profile is applicable to applications that are run on the server side where the user uses the application from a web browser. To authorize your application (client) using this profile follow see the introduction section. |
clientSecret
String
Default Value: ""
The secret value for the client assigned when registering the application.
grantType
OAuthSettingsGrantTypes
Default Value: 0
The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:
| 0 (cogtAuthorizationCode - Default) | Authorization Code grant type |
| 1 (cogtImplicit) | Implicit grant type |
| 2 (cogtPassword) | Resource Owner Password Credentials grant type |
| 3 (cogtClientCredentials) | Client Credentials grant type |
refreshToken
String
Default Value: ""
Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the OAuthGrantType property is set to a grant that can use refresh tokens.
requestRefreshToken
Bool
Default Value: True
Specifies whether the class will request a refresh token during authorization. By default, this value is True.
When True, the class will automatically add the necessary scopes or parameters to obtain a refresh token. When False, this property will have no effect. If the necessary scopes or parameters are specified manually, a refresh token can still be obtained.
Note: This property is only applicable when the OAuthGrantType property is set to cogtAuthorizationCode.
returnURL
String
Default Value: ""
The URL where the user (browser) returns after authenticating. This property is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the class when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.
serverAuthURL
String
Default Value: ""
The URL of the authorization server.
serverTokenURL
String
Default Value: ""
The URL of the token server used to obtain the access token.
webAuthURL
String (read-only)
Default Value: ""
The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information.
Constructors
public init()
Proxy Type
The proxy the component will connect to.
Remarks
When connecting through a proxy, this type is used to specify different properties of the proxy, such as the and the .
Fields
authScheme
ProxyAuthSchemes
Default Value: 0
The type of authorization to perform when connecting to the proxy. This is used only when the and properties are set.
should be set to authNone (3) when no authentication is expected.
By default, is authBasic (0), and if the and properties are set, the class will attempt basic authentication.
If is set to authDigest (1), digest authentication will be attempted instead.
If is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.
If is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of and .
autoDetect
Bool
Default Value: False
Whether to automatically detect and use proxy system settings, if available. The default value is .
password
String
Default Value: ""
A password if authentication is to be used for the proxy.
If is set to Basic Authentication, the and properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If is set to Digest Authentication, the and properties are used to respond to the Digest Authentication challenge from the server.
If is set to NTLM Authentication, the and properties are used to authenticate through NTLM negotiation.
port
Int32
Default Value: 80
The Transmission Control Protocol (TCP) port for the proxy (default 80). See the description of the property for details.
server
String
Default Value: ""
If a proxy is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the property is set to the corresponding address. If the search is not successful, an error is returned.
ssl
ProxySSLTypes
Default Value: 0
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 class will use the psTunnel option. If the URL is an http URL, the class 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. |
user
String
Default Value: ""
A username if authentication is to be used for the proxy.
If is set to Basic Authentication, the and properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If is set to Digest Authentication, the and properties are used to respond to the Digest Authentication challenge from the server.
If is set to NTLM Authentication, the and properties are used to authenticate through NTLM negotiation.
Constructors
public init()
public init(server: , port: )
public init(server: , port: , user: , password: )
QueryParam Type
A query parameter to send in the request.
Remarks
This type represents a query parameter to send in the request.
Fields
name
String
Default Value: ""
The name of the query parameter.
This property specifies the name of the query parameter.
value
String
Default Value: ""
The value of the query parameter.
This property specifies the value of the query parameter. The class will automatically URL-encode this value when sending the request.
Constructors
public init()
public init(name: , value: )
Config Settings (AzureKeys Module)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.AzureKeys Config Settings
By default, this setting is enabled, allowing all pages of results to be accumulated in the appropriate collection properties.
By default, this setting is enabled, and keys are created in an enabled state.
A key can only be used for the Decrypt, Verify, and UnwrapKey operations after its expiry date.
By default, this setting is set to -1, and no expiry date is sent.
By default, this setting is disabled, and the class requests information about active keys.
If this setting is -1 (default), the server's default (25) is used. Otherwise, the setting must be set to a value greater than or equal to 1.
A key can only be used for the Decrypt, Verify, and UnwrapKey operations prior to its "not before" date.
By default, this setting is set to -1, and no "not before" date is sent.
- Decrypt
- Encrypt
- GetKeyInfo (unless GetDeleted is enabled, in which case this setting is ignored)
- Sign
- UnwrapKey
- UpdateKey
- Verify
- WrapKey
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
When XPath is set to a valid path, XElement points to the name of the element, with XText, XParent, XSubTree, XChildCount, XChildName[i], and 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 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. |
For example, assume the following XML and JSON responses.
XML:
<firstlevel>
<one>value</one>
<two>
<item>first</item>
<item>second</item>
</two>
<three>value three</three>
</firstlevel>
JSON:
{
"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.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified in the XPath configuration setting. This configuration setting is read-only.
OAuth Config Settings
| Bearer (default) | When the access token returned by the server is a Bearer type, the authorization string returned by Authorize will be in the format "Bearer access_token". This can be supplied as the value of the HTTP Authorization header. |
For example, when using the Authorization Code grant type, the OAuthRefreshToken property should be set to a valid refresh token. When using the Client Credential grant type however, the class does not need any additional properties set as it can already get a new access token without user interaction.
If set to (default) the redirect_uri will be sent in all cases. If set to the redirect_uri will only be sent if it has a value.
To parse the payload for specific claims, see OAuthJWTXPath.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
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. |
| 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 OAuthJWTXText.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
component.Config("OAuthParamCount=2");
component.Config("OAuthParamName[0]=myvar");
component.Config("OAuthParamValue[0]=myvalue");
component.Config("OAuthParamName[1]=testname");
component.Config("OAuthParamValue[1]=testvalue");
Additionally, this will also be updated to hold the parameters returned in the response.
for (int i = 0; i < int.Parse(component.Config("OAuthParamCount")); i++)
{
string name = component.Config("OAuthParamName[" + i + "]");
string value = component.Config("OAuthParamValue[" + i + "]");
}
- 1 (Plain)
- 2 (S256/SHA256 - default)
.NET
Gmail gmail = new Gmail();
gmail.Config("OAuthTransferredRequest=on");
gmail.Authorize();
Console.WriteLine(gmail.Config("OAuthTransferredRequest"));
C++
Gmail gmail;
gmail.Config("OAuthTransferredRequest=on");
gmail.Authorize();
printf("%s\r\n", gmail.Config("OAuthTransferredRequest"));
This setting can also be set to activate or deactivate the web server. Under normal circumstances, this would not be required as the class will automatically start and stop the web server when Authorize is called. In certain cases, it is required to start the webserver before calling Authorize. For example, if the OAuthReturnURL needs to be set to a relay server, then you will need to start the web server manually. Another example would be when the OAuthReUseWebServer is set to true, the server will not be automatically stopped, and this configuration setting must be set to "false" to stop the embedded web server.
The OAuthWebServerCertStoreType property specifies the type of the certificate store specified by OAuthWebServerCertStore. If the store is password protected, specify the password in OAuthWebServerCertStorePassword.
OAuthWebServerCertStore is used in conjunction with the OAuthWebServerCertSubject property in order to specify the certificate to be used during SSL.
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 OAuthWebServerSSLEnabled is set to .
Note: This is only applicable when OAuthWebServerSSLEnabled is set to .
| 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. |
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=support@nsoftware.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 OAuthWebServerSSLEnabled is set to .
The default value is localhost.
HTTP Config Settings
When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
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 if the server does not support HTTP/2.
The default value is True.
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]".
The default value is False.
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 .
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 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 instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.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 class 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 after calling a method. The 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.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is .
| 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).
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by .
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 class beyond what is provided.
.NET
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"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
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.
When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
TCPClient Config Settings
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 setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
| 0 | No firewall (default setting). |
| 1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
| 2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
| 3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
| 10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if 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 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 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.
In multihomed 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 multihomed hosts (machines with more than one IP interface).
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.
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.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
| 0 | IPv4 only |
| 1 | IPv6 only |
| 2 | IPv6 with IPv4 fallback |
SSL Config Settings
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 configuration setting has no effect if SSLProvider is set to Platform.
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). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
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 the following sequences:
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
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".
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.
If set to True, the class will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
Note: This configuration 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 configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
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 SSLProvider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include the following:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
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_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include the following:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
| TLS1.3 | 12288 (Hex 3000) |
| TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
| TLS1.1 | 768 (Hex 300) (Default - Client) |
| TLS1 | 192 (Hex C0) (Default - Client) |
| SSL3 | 48 (Hex 30) |
| SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider), please be aware of the following notes:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting is applicable only when SSLProvider is set to Internal.
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.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
| 0x00000001 | Ignore time validity status of certificate. |
| 0x00000002 | Ignore time validity status of CTL. |
| 0x00000004 | Ignore non-nested certificate times. |
| 0x00000010 | Allow unknown certificate authority. |
| 0x00000020 | Ignore wrong certificate usage. |
| 0x00000100 | Ignore unknown certificate revocation status. |
| 0x00000200 | Ignore unknown CTL signer revocation status. |
| 0x00000400 | Ignore unknown certificate authority revocation status. |
| 0x00000800 | Ignore unknown root revocation status. |
| 0x00008000 | Allow test root certificate. |
| 0x00004000 | Trust test root certificate. |
| 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class .
The format of this value is a comma-separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
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 configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only 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:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
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:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
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.
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.
Base Config Settings
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 |
| 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 |
- 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.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to tells the class to use the internal implementation instead of using the system security libraries.
This setting is set to by default on all platforms.
Trappable Errors (AzureKeys Module)
Common Errors
| 600 | A server error occurred, and/or the class was unable to process the server's response. Please refer to the error message for more information. |
| 601 | An unsupported operation or action was attempted. |
| 602 | The RawRequest or RawResponse configuration setting was queried without first setting the TransferredRequest configuration setting to ON. |
| 603 | The login credentials specified were invalid. Please refer to the error message for more information. |
| 604 | An invalid remote resource identifier (i.e., a name, path, Id, etc.) was specified. |
| 605 | An invalid index was specified. |
| 606 | An operation failed because the specified OutputFile already exists and Overwrite is . |
| 607 | An exception occurred while working with the specified InputFile or OutputFile (or the current value of one of those properties is invalid). Please refer to the error message for more information. |
| 608 | An exception occurred while working with the specified input or output stream. Please refer to the error message for more information. |
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. |
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 at this time. A connection is in progress. |
| 112 | You cannot change 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 class 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. |
SSL Errors
| 270 | Cannot load specified security library. |
| 271 | Cannot open certificate store. |
| 272 | Cannot find specified certificate. |
| 273 | Cannot acquire security credentials. |
| 274 | Cannot find certificate chain. |
| 275 | Cannot verify certificate chain. |
| 276 | Error during handshake. |
| 280 | Error verifying certificate. |
| 281 | Could not find client certificate. |
| 282 | Could not find server certificate. |
| 283 | Error encrypting data. |
| 284 | Error decrypting data. |
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). |