# SAMLDesktop Class
The SAMLDesktop class provides an easy way to add SAML-based SSO to your desktop application.
## Syntax
```text
class cloudsso.SAMLDesktop
```
## Remarks
The Security Assertion Markup Language (SAML) protocol provides a standardized way to add Single Sign-on (SSO) to applications. Service Providers (i.e., your application) using SAML-based SSO can eliminate the need to store and manage user passwords. When using SAML, the responsibility of identifying a user can be shifted to the Identity Provider.
The SAMLDesktop class is intended for desktop applications that need to add web-based SAML SSO support. The class simplifies the process by building the requests, launching the browser, receiving the response, and validating the assertion for your desktop application with a few simple method calls.
## Setup
To get started with the class, information about the Identity Provider is needed. Typically, this information is provided by a SAML Metadata Document that is either provided during the setup or requested from a URI. The [request_identity_metadata](#request_identity_metadata-method) and [load_identity_metadata](#load_identity_metadata-method) methods are both ways to populate the identity_provider_metadata, identity_provider_signing_cert, and identity_provider_ur_is properties.
**Usage: Requesting and Reloading the Identity Provider Metadata Document**
```text
saml.RequestIdentityMetadata("https://example.com/federationmetadata/federationmetadata.xml");
string raw_document = saml.IdentityProviderMetadata.Content;
//...
saml.LoadIdentityMetadata(raw_document, true);
```
Additionally, the class needs to be configured with the information about the Service Provider (i.e., your application). The service_provider_signing_cert, [web_server_bindings](#web_server_bindings-property), [web_server_port](#web_server_port-property), and [web_server_ssl_enabled](#web_server_ssl_enabled-property) properties can be used to provide information about the Service Provider. These are used by the class to build a valid SAML request and to verify the SAML response and its assertions. These settings should typically be considered constant between multiple requests.
Additionally, to easily supply this information to an Identity Provider, the service_provider_metadata property can be used with the [build_service_metadata](#build_service_metadata-method) method to create a SAML Metadata Document that describes your application (the Service Provider) to the Identity Provider.
**Usage: Configuring Service Provider Metadata Document**
```text
saml.ServiceProviderSigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*");
saml.WebServerBindings = WebServerBindings.cwbAutomatic;
saml.WebServerPort = 8888;
saml.WebServerEnabled = false;
saml.ServiceProviderMetadata.EntityId = "ServiceProviderId";
saml.ServiceProviderMetadata.AuthnRequestSigned = true;
saml.ServiceProviderMetadata.WantAssertionsSigned = true;
saml.BuildServiceMetadata();
```
## Authentication
Once the service_provider_signing_cert and *WebServer** properties are configured, the saml_request_settings property can be configured when the application is ready to make an authentication request by calling [authenticate_user](#authenticate_user-method).
**Issuer**
The [saml_request_issuer](#saml_request_issuer-property) field is **required** and be configured to the Entity Id that was provided to the Identity Provider. If the [build_service_metadata](#build_service_metadata-method) method was used to create a metadata document that was provided to the Identity Provider, this will match the [service_provider_metadata_entity_id](#service_provider_metadata_entity_id-property) field. The [saml_request_issuer](#saml_request_issuer-property) field is also used to validate the SAML response once Identity Provider responds.
**Binding**
The [saml_request_binding](#saml_request_binding-property) field is also required and controls how the class communicates the authentication request to the Identity Provider. This does **not** control how the Identity Provider responds to the request. The class supports two request bindings: *HTTP-Redirect* and *HTTP-POST*.
The *HTTP-Redirect* binding (default) sends the SAML request using an HTTP redirect and provides the parameters through a query string. Typically, this binding requires that [UseDetachedSignatures](#UseDetachedSignatures) is set to true as the signature causes the request to become to long if held within the actual request.
The *HTTP-POST* binding sends the SAML request using an HTTP form post to send the parameters through an HTTP POST instead. Internally, this is done by launching the browser to an HTML page that contains an automatic form post.
**SignRequest**
The [saml_request_sign_request](#saml_request_sign_request-property) field can be set to true to have the class sign the SAML request using the service_provider_signing_cert certificate. f the [build_service_metadata](#build_service_metadata-method) method was used to create a metadata document that was provided to the Identity Provider, the service_provider_signing_cert should be the same certificate that was set when the metadata document was built.
**RelayState**
The [relay_state](#relay_state-property) property can be set have the class send the *RelayState* parameter along with the SAML request. When the Identity Provider returns with the SAML response, it will also return a *RelayState* parameter with the same value.
Once the authentication request has been configured, call [authenticate_user](#authenticate_user-method) to start the authentication process.
**Usage: Authenticate User**
```text
saml.RequestIdentityMetadata("https://example.com/federationmetadata/federationmetadata.xml");
saml.ServiceProviderSigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*");
saml.WebServerBindings = WebServerBindings.cwbAutomatic;
saml.WebServerPort = 8888;
saml.WebServerEnabled = false;
saml.SAMLRequestSettings.Issuer = "ServiceProviderId";
saml.SAMLRequestSettings.Binding = SAMLBindings.sbHTTPRedirect;
saml.SAMLRequestSettings.SignRequest = true;
saml.RelayState = "Relay_State";
saml.AuthenticateUser;
```
## Assertions
The SAML 2.0 specification gives Identity Providers many different options for what can be included in an assertion. In the Web SSO profile, typically the assertion will contain the *Issuer*, *Signature*, *Subject*, *Conditions*, *AttributeStatement*, and *AuthnStatement*. Information found from the *Issuer*, *Signature*, *Subject*, and *Conditions* sections of the assertion can be found in the assertion_info property. Along with providing information about the assertion, these fields are also used to verify the assertion. An important field to note is the [assertion_subject_name_id](#assertion_subject_name_id-property) property. This property provides the unique identifier for the user which can be used for authorization purposes. See below for information about the *AttributeStatement* and *AuthnStatement* sections.
### Assertion Authentication Context
The *AuthnStatement* section is used by the Identity Provider to provide the Service Provider with information about its authentication session with the user. The statement is parsed to the assertion_authn_info property. Some commonly used information is how the user authenticated with the Identity Provider (see [assertion_authn_context_class_reference](#assertion_authn_context_class_reference-property)) and the session identifier created by the Identity Provider for the Service Provider (see [assertion_authn_session_index](#assertion_authn_session_index-property)).
### Assertion Attributes
Along with the [assertion_subject_name_id](#assertion_subject_name_id-property), the Identity Provider may give additional information about the user in the *AttributeStatement* section. What exactly is provided depends on how the connection between the Identity Provider and Service Provider was configured. Since there is no defined list of attributes, the assertion_attribute_info properties will be populated with each attribute found. Each attribute has a name and one or more values. For example, take the following attribute that describes a list of emails attached to the user.
```text
email@test.com
other@example.com
```
In this assertion attribute statement, the user has two emails that have been verified. There are two ways to get this information through the class. First, using the collection, the application can iterate through the collection for the attribute and then iterate through the associated values. Using this method is useful if there are multiple acceptable names for the attributes that could be accepted. For example:
```text
List verified_emails = new List();
for (int i = 0; i < saml.AssertionAttributeInfo.Count; i++) {
if (saml.AssertionAttributeInfo[i].Name == "verified_emails" || saml.AssertionAttributeInfo[i].Name == "verified_email") {
for (int j = 0; j < saml.AssertionAttributeInfo[i].ValueCount; j++) {
saml.AssertionAttributeInfo[i].ValueIndex = j;
verified_emails.Add(saml.AssertionAttributeInfo[i].ValueData);
}
}
}
```
The other option is to use the [get_assertion_attribute](#get_assertion_attribute-method) method. This method will search the assertion's attribute statement for the first attribute with a matching name. Like in the example above, if the attribute has multiple values, the method will return them in a semicolon-separated list. This method simplifies the process of searching the collection for a specific attribute if the name of the attribute is known ahead of time. For example:
```text
string[] verified_emails = saml.GetAssertionAttribute("verified_emails").Split(';');
```
## Property List
*The following is the full list of the properties of the class with short descriptions. Click on the links for further details.*
| | |
| --- | --- |
| [assertion_content](#assertion_content-property) | The raw XML of the assertion. |
| [assertion_expiration_date](#assertion_expiration_date-property) | When the parsed assertion is expired. |
| [assertion_id](#assertion_id-property) | The unique Id of the assertion generated by the identity provider. |
| [assertion_is_signed](#assertion_is_signed-property) | Whether the assertion has been signed by the identity provider. |
| [assertion_issued_time](#assertion_issued_time-property) | The time at which the assertion was issued by the Issuer (typically the identity provider). |
| [assertion_issuer](#assertion_issuer-property) | The issuer of the assertion. |
| [assertion_not_before_date](#assertion_not_before_date-property) | The time at which the assertion becomes valid. |
| [assertion_one_time_use](#assertion_one_time_use-property) | Whether the issuer only considers this information valid for this single instance. |
| [assertion_subject_name_id](#assertion_subject_name_id-property) | The unique name identifier for the subject of the current assertion. |
| [assertion_subject_name_id_format](#assertion_subject_name_id_format-property) | A URI reference to how the SubjectNameId of the element is formatted. |
| [assertion_attribute_count](#assertion_attribute_count-property) | The number of records in the AssertionAttribute arrays. |
| [assertion_attribute_content](#assertion_attribute_content-property) | The raw XML of the attribute. |
| [assertion_attribute_friendly_name](#assertion_attribute_friendly_name-property) | A human-readable version of the attribute name, if provided. |
| [assertion_attribute_name](#assertion_attribute_name-property) | The name of the attribute. |
| [assertion_attribute_name_format](#assertion_attribute_name_format-property) | A URI reference to how the Name of the attribute is formatted. |
| [assertion_attribute_value_count](#assertion_attribute_value_count-property) | In cases where there are multiple values for a single attribute, this count will be updated to reflect the size of the list. |
| [assertion_attribute_value_data](#assertion_attribute_value_data-property) | The content of the attribute value selected by ValueIndex . |
| [assertion_attribute_value_index](#assertion_attribute_value_index-property) | The index of the attribute value that should be populated in the ValueData property. |
| [assertion_authn_count](#assertion_authn_count-property) | The number of records in the AssertionAuthn arrays. |
| [assertion_authn_authenticating_authorities](#assertion_authn_authenticating_authorities-property) | A semicolon-separated list of authorities involved with the current authentication context. |
| [assertion_authn_content](#assertion_authn_content-property) | The raw XML of the Authn statement. |
| [assertion_authn_context_class_reference](#assertion_authn_context_class_reference-property) | A predefined URI reference identifying an authentication context class that describes how authentication was provided. |
| [assertion_authn_context_declaration](#assertion_authn_context_declaration-property) | A description or URI that describes additional information about the authentication context past the ContextClassReference . |
| [assertion_authn_instant](#assertion_authn_instant-property) | The time at which the authentication took place that was used to issue the assertion. |
| [assertion_authn_session_expiration](#assertion_authn_session_expiration-property) | The time at which the session between the principal and Identity Provider must be considered ended. |
| [assertion_authn_session_index](#assertion_authn_session_index-property) | The unique identifier for a particular session established between the user (principal) and the Service Provider (SP), as provided by the Identity Provider (IdP). |
| [firewall_auto_detect](#firewall_auto_detect-property) | Whether to automatically detect and use firewall system settings, if available. |
| [firewall_host](#firewall_host-property) | The name or IP address of the firewall (optional). |
| [firewall_password](#firewall_password-property) | A password if authentication is to be used when connecting through the firewall. |
| [firewall_port](#firewall_port-property) | The Transmission Control Protocol (TCP) port for the firewall Host . |
| [firewall_type](#firewall_type-property) | The type of firewall to connect through. |
| [firewall_user](#firewall_user-property) | A username if authentication is to be used when connecting through a firewall. |
| [follow_redirects](#follow_redirects-property) | Determines what happens when the server issues a redirect. |
| [identity_provider_encrypting_cert_effective_date](#identity_provider_encrypting_cert_effective_date-property) | The date on which this certificate becomes valid. |
| [identity_provider_encrypting_cert_encoded](#identity_provider_encrypting_cert_encoded-property) | The certificate (PEM/Base64 encoded). |
| [identity_provider_encrypting_cert_expiration_date](#identity_provider_encrypting_cert_expiration_date-property) | The date on which the certificate expires. |
| [identity_provider_encrypting_cert_extended_key_usage](#identity_provider_encrypting_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. |
| [identity_provider_encrypting_cert_fingerprint](#identity_provider_encrypting_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [identity_provider_encrypting_cert_fingerprint_sha1](#identity_provider_encrypting_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [identity_provider_encrypting_cert_fingerprint_sha256](#identity_provider_encrypting_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [identity_provider_encrypting_cert_issuer](#identity_provider_encrypting_cert_issuer-property) | The issuer of the certificate. |
| [identity_provider_encrypting_cert_private_key](#identity_provider_encrypting_cert_private_key-property) | The private key of the certificate (if available). |
| [identity_provider_encrypting_cert_private_key_available](#identity_provider_encrypting_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. |
| [identity_provider_encrypting_cert_private_key_container](#identity_provider_encrypting_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). |
| [identity_provider_encrypting_cert_public_key](#identity_provider_encrypting_cert_public_key-property) | The public key of the certificate. |
| [identity_provider_encrypting_cert_public_key_algorithm](#identity_provider_encrypting_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. |
| [identity_provider_encrypting_cert_public_key_length](#identity_provider_encrypting_cert_public_key_length-property) | The length of the certificate's public key (in bits). |
| [identity_provider_encrypting_cert_serial_number](#identity_provider_encrypting_cert_serial_number-property) | The serial number of the certificate encoded as a string. |
| [identity_provider_encrypting_cert_signature_algorithm](#identity_provider_encrypting_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. |
| [identity_provider_encrypting_cert_store](#identity_provider_encrypting_cert_store-property) | The name of the certificate store for the client certificate. |
| [identity_provider_encrypting_cert_store_password](#identity_provider_encrypting_cert_store_password-property) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [identity_provider_encrypting_cert_store_type](#identity_provider_encrypting_cert_store_type-property) | The type of certificate store for this certificate. |
| [identity_provider_encrypting_cert_subject](#identity_provider_encrypting_cert_subject-property) | The subject of the certificate used for client authentication. |
| [identity_provider_encrypting_cert_subject_alt_names](#identity_provider_encrypting_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. |
| [identity_provider_encrypting_cert_thumbprint_md5](#identity_provider_encrypting_cert_thumbprint_md5-property) | The MD5 hash of the certificate. |
| [identity_provider_encrypting_cert_thumbprint_sha1](#identity_provider_encrypting_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. |
| [identity_provider_encrypting_cert_thumbprint_sha256](#identity_provider_encrypting_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. |
| [identity_provider_encrypting_cert_usage](#identity_provider_encrypting_cert_usage-property) | The text description of UsageFlags . |
| [identity_provider_encrypting_cert_usage_flags](#identity_provider_encrypting_cert_usage_flags-property) | The flags that show intended use for the certificate. |
| [identity_provider_encrypting_cert_version](#identity_provider_encrypting_cert_version-property) | The certificate's version number. |
| [identity_provider_metadata_content](#identity_provider_metadata_content-property) | The raw metadata for the identity provider. |
| [identity_provider_metadata_entity_id](#identity_provider_metadata_entity_id-property) | The unique Id for the identity provider that is being described. |
| [identity_provider_metadata_expiration_date](#identity_provider_metadata_expiration_date-property) | The expiration date of the Identity Provider description provided by the metadata document. |
| [identity_provider_metadata_requests_signed_authn_requests](#identity_provider_metadata_requests_signed_authn_requests-property) | Whether the identity provider requests that authentication (Authn) requests are signed. |
| [identity_provider_metadata_signed_metadata](#identity_provider_metadata_signed_metadata-property) | Whether the identity provider's parsed metadata is signed. |
| [identity_provider_metadata_supported_attribute_profiles](#identity_provider_metadata_supported_attribute_profiles-property) | A semicolon-separated list of attribute profiles supported by the identity provider. |
| [identity_provider_metadata_supported_attributes](#identity_provider_metadata_supported_attributes-property) | A semicolon-separated list of attributes supported by the identity provider as presented by the Identity Provider's metadata document. |
| [identity_provider_metadata_supported_name_id_formats](#identity_provider_metadata_supported_name_id_formats-property) | The name identifier formats supported by the identity provider if provided by the metadata document. |
| [identity_provider_signing_cert_effective_date](#identity_provider_signing_cert_effective_date-property) | The date on which this certificate becomes valid. |
| [identity_provider_signing_cert_encoded](#identity_provider_signing_cert_encoded-property) | The certificate (PEM/Base64 encoded). |
| [identity_provider_signing_cert_expiration_date](#identity_provider_signing_cert_expiration_date-property) | The date on which the certificate expires. |
| [identity_provider_signing_cert_extended_key_usage](#identity_provider_signing_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. |
| [identity_provider_signing_cert_fingerprint](#identity_provider_signing_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [identity_provider_signing_cert_fingerprint_sha1](#identity_provider_signing_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [identity_provider_signing_cert_fingerprint_sha256](#identity_provider_signing_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [identity_provider_signing_cert_issuer](#identity_provider_signing_cert_issuer-property) | The issuer of the certificate. |
| [identity_provider_signing_cert_private_key](#identity_provider_signing_cert_private_key-property) | The private key of the certificate (if available). |
| [identity_provider_signing_cert_private_key_available](#identity_provider_signing_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. |
| [identity_provider_signing_cert_private_key_container](#identity_provider_signing_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). |
| [identity_provider_signing_cert_public_key](#identity_provider_signing_cert_public_key-property) | The public key of the certificate. |
| [identity_provider_signing_cert_public_key_algorithm](#identity_provider_signing_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. |
| [identity_provider_signing_cert_public_key_length](#identity_provider_signing_cert_public_key_length-property) | The length of the certificate's public key (in bits). |
| [identity_provider_signing_cert_serial_number](#identity_provider_signing_cert_serial_number-property) | The serial number of the certificate encoded as a string. |
| [identity_provider_signing_cert_signature_algorithm](#identity_provider_signing_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. |
| [identity_provider_signing_cert_store](#identity_provider_signing_cert_store-property) | The name of the certificate store for the client certificate. |
| [identity_provider_signing_cert_store_password](#identity_provider_signing_cert_store_password-property) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [identity_provider_signing_cert_store_type](#identity_provider_signing_cert_store_type-property) | The type of certificate store for this certificate. |
| [identity_provider_signing_cert_subject](#identity_provider_signing_cert_subject-property) | The subject of the certificate used for client authentication. |
| [identity_provider_signing_cert_subject_alt_names](#identity_provider_signing_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. |
| [identity_provider_signing_cert_thumbprint_md5](#identity_provider_signing_cert_thumbprint_md5-property) | The MD5 hash of the certificate. |
| [identity_provider_signing_cert_thumbprint_sha1](#identity_provider_signing_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. |
| [identity_provider_signing_cert_thumbprint_sha256](#identity_provider_signing_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. |
| [identity_provider_signing_cert_usage](#identity_provider_signing_cert_usage-property) | The text description of UsageFlags . |
| [identity_provider_signing_cert_usage_flags](#identity_provider_signing_cert_usage_flags-property) | The flags that show intended use for the certificate. |
| [identity_provider_signing_cert_version](#identity_provider_signing_cert_version-property) | The certificate's version number. |
| [identity_provider_uri_count](#identity_provider_uri_count-property) | The number of records in the IdentityProviderURI arrays. |
| [identity_provider_uri_binding_ref](#identity_provider_uri_binding_ref-property) | The URI reference for the set BindingType . |
| [identity_provider_uri_binding_type](#identity_provider_uri_binding_type-property) | The type of binding that is supported for this URI. |
| [identity_provider_uri_index](#identity_provider_uri_index-property) | The index for the URI that can be optionally used if multiple URIs of the same URIType and BindingType are provided. |
| [identity_provider_uri_is_default](#identity_provider_uri_is_default-property) | Whether this URI is the default URI that should be used for the specific URIType and BindingType combination. |
| [identity_provider_uri_location](#identity_provider_uri_location-property) | The address of the URI. |
| [identity_provider_uri_type](#identity_provider_uri_type-property) | The purpose of the URI. |
| [proxy_auth_scheme](#proxy_auth_scheme-property) | The type of authorization to perform when connecting to the proxy. |
| [proxy_auto_detect](#proxy_auto_detect-property) | Whether to automatically detect and use proxy system settings, if available. |
| [proxy_password](#proxy_password-property) | A password if authentication is to be used for the proxy. |
| [proxy_port](#proxy_port-property) | The Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
| [proxy_server](#proxy_server-property) | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| [proxy_ssl](#proxy_ssl-property) | When to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
| [proxy_user](#proxy_user-property) | A username if authentication is to be used for the proxy. |
| [relay_state](#relay_state-property) | The RelayState for a SAML request or response. |
| [return_url](#return_url-property) | The URL where the user (browser) returns after authenticating with the Identity Provider. |
| [saml_request_allow_create](#saml_request_allow_create-property) | This setting is only used for authentication requests. |
| [saml_request_binding](#saml_request_binding-property) | This setting controls the binding that will be used to make the request. |
| [saml_request_consent](#saml_request_consent-property) | This setting specifies whether consent from a principal was provided when this request was sent. |
| [saml_request_destination](#saml_request_destination-property) | This setting specifies a URI reference for the intended destination for the SAML request. |
| [saml_request_id](#saml_request_id-property) | This setting specifies the unique Id of the SAML request. |
| [saml_request_issued_time](#saml_request_issued_time-property) | This setting sets the time at which the SAML request was issued. |
| [saml_request_issuer](#saml_request_issuer-property) | The issuer for the SAML request. |
| [saml_request_name_id_format](#saml_request_name_id_format-property) | This setting is only used for authentication requests. |
| [saml_request_selected_endpoint](#saml_request_selected_endpoint-property) | This setting only applies to Authn Requests since there can be multiple Assertion Consumer Service (ACS) endpoints per service provider. |
| [saml_request_session_index](#saml_request_session_index-property) | This setting only applies when building SAML logout requests. |
| [saml_request_sign_request](#saml_request_sign_request-property) | This setting controls whether the SAML request should be signed when using the BuildAuthnRequest or BuildLogoutRequest methods. |
| [saml_request_use_default_endpoint](#saml_request_use_default_endpoint-property) | This setting only applies to Authn Requests since there can be multiple Assertion Consumer Service (ACS) endpoints per service provider. |
| [saml_response_consent](#saml_response_consent-property) | Whether consent from a principal was provided when this response was sent. |
| [saml_response_content](#saml_response_content-property) | The full XML of the SAML response after being parsed or processed by the class. |
| [saml_response_destination](#saml_response_destination-property) | A URI reference for the intended destination for the SAML response. |
| [saml_response_id](#saml_response_id-property) | The unique Id for the SAML response that was created by the Issuer . |
| [saml_response_in_response_to](#saml_response_in_response_to-property) | The Id of the SAML request that requested the Identity Provider to issue this SAML response. |
| [saml_response_issued_time](#saml_response_issued_time-property) | The time at which the SAML response was issued by the Issuer . |
| [saml_response_issuer](#saml_response_issuer-property) | The Entity Id of the issuer of the SAML response. |
| [saml_response_signed](#saml_response_signed-property) | Whether the SAML response is signed. |
| [saml_response_status_codes](#saml_response_status_codes-property) | A semicolon-separated list of status codes found in the SAML response. |
| [saml_response_status_message](#saml_response_status_message-property) | The message that was provided in the status of the SAML response. |
| [saml_response_type](#saml_response_type-property) | The type of SAML response that was parsed or processed. |
| [service_provider_metadata_authn_request_signed](#service_provider_metadata_authn_request_signed-property) | Whether the generated metadata document will inform the identity provider that this service provider will be sending signed requests. |
| [service_provider_metadata_content](#service_provider_metadata_content-property) | The raw XML document that represents the metadata document for the configured service provider. |
| [service_provider_metadata_entity_id](#service_provider_metadata_entity_id-property) | The Entity Id for this service provider. |
| [service_provider_metadata_signed_metadata](#service_provider_metadata_signed_metadata-property) | Whether the class will sign the metadata document when it is being generated. |
| [service_provider_metadata_supported_name_id_formats](#service_provider_metadata_supported_name_id_formats-property) | A semicolon-separated list of NameId formats that are supported by this service provider. |
| [service_provider_metadata_want_assertions_signed](#service_provider_metadata_want_assertions_signed-property) | Whether the metadata document will inform the identity provider that this service provider wants issued assertions to be signed. |
| [service_provider_signing_cert_effective_date](#service_provider_signing_cert_effective_date-property) | The date on which this certificate becomes valid. |
| [service_provider_signing_cert_encoded](#service_provider_signing_cert_encoded-property) | The certificate (PEM/Base64 encoded). |
| [service_provider_signing_cert_expiration_date](#service_provider_signing_cert_expiration_date-property) | The date on which the certificate expires. |
| [service_provider_signing_cert_extended_key_usage](#service_provider_signing_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. |
| [service_provider_signing_cert_fingerprint](#service_provider_signing_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [service_provider_signing_cert_fingerprint_sha1](#service_provider_signing_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [service_provider_signing_cert_fingerprint_sha256](#service_provider_signing_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [service_provider_signing_cert_issuer](#service_provider_signing_cert_issuer-property) | The issuer of the certificate. |
| [service_provider_signing_cert_private_key](#service_provider_signing_cert_private_key-property) | The private key of the certificate (if available). |
| [service_provider_signing_cert_private_key_available](#service_provider_signing_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. |
| [service_provider_signing_cert_private_key_container](#service_provider_signing_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). |
| [service_provider_signing_cert_public_key](#service_provider_signing_cert_public_key-property) | The public key of the certificate. |
| [service_provider_signing_cert_public_key_algorithm](#service_provider_signing_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. |
| [service_provider_signing_cert_public_key_length](#service_provider_signing_cert_public_key_length-property) | The length of the certificate's public key (in bits). |
| [service_provider_signing_cert_serial_number](#service_provider_signing_cert_serial_number-property) | The serial number of the certificate encoded as a string. |
| [service_provider_signing_cert_signature_algorithm](#service_provider_signing_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. |
| [service_provider_signing_cert_store](#service_provider_signing_cert_store-property) | The name of the certificate store for the client certificate. |
| [service_provider_signing_cert_store_password](#service_provider_signing_cert_store_password-property) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [service_provider_signing_cert_store_type](#service_provider_signing_cert_store_type-property) | The type of certificate store for this certificate. |
| [service_provider_signing_cert_subject](#service_provider_signing_cert_subject-property) | The subject of the certificate used for client authentication. |
| [service_provider_signing_cert_subject_alt_names](#service_provider_signing_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. |
| [service_provider_signing_cert_thumbprint_md5](#service_provider_signing_cert_thumbprint_md5-property) | The MD5 hash of the certificate. |
| [service_provider_signing_cert_thumbprint_sha1](#service_provider_signing_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. |
| [service_provider_signing_cert_thumbprint_sha256](#service_provider_signing_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. |
| [service_provider_signing_cert_usage](#service_provider_signing_cert_usage-property) | The text description of UsageFlags . |
| [service_provider_signing_cert_usage_flags](#service_provider_signing_cert_usage_flags-property) | The flags that show intended use for the certificate. |
| [service_provider_signing_cert_version](#service_provider_signing_cert_version-property) | The certificate's version number. |
| [ssl_accept_server_cert_effective_date](#ssl_accept_server_cert_effective_date-property) | The date on which this certificate becomes valid. |
| [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property) | The certificate (PEM/Base64 encoded). |
| [ssl_accept_server_cert_expiration_date](#ssl_accept_server_cert_expiration_date-property) | The date on which the certificate expires. |
| [ssl_accept_server_cert_extended_key_usage](#ssl_accept_server_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. |
| [ssl_accept_server_cert_fingerprint](#ssl_accept_server_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [ssl_accept_server_cert_fingerprint_sha1](#ssl_accept_server_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [ssl_accept_server_cert_fingerprint_sha256](#ssl_accept_server_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [ssl_accept_server_cert_issuer](#ssl_accept_server_cert_issuer-property) | The issuer of the certificate. |
| [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) | The private key of the certificate (if available). |
| [ssl_accept_server_cert_private_key_available](#ssl_accept_server_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. |
| [ssl_accept_server_cert_private_key_container](#ssl_accept_server_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). |
| [ssl_accept_server_cert_public_key](#ssl_accept_server_cert_public_key-property) | The public key of the certificate. |
| [ssl_accept_server_cert_public_key_algorithm](#ssl_accept_server_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. |
| [ssl_accept_server_cert_public_key_length](#ssl_accept_server_cert_public_key_length-property) | The length of the certificate's public key (in bits). |
| [ssl_accept_server_cert_serial_number](#ssl_accept_server_cert_serial_number-property) | The serial number of the certificate encoded as a string. |
| [ssl_accept_server_cert_signature_algorithm](#ssl_accept_server_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. |
| [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) | The name of the certificate store for the client certificate. |
| [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property) | The type of certificate store for this certificate. |
| [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) | The subject of the certificate used for client authentication. |
| [ssl_accept_server_cert_subject_alt_names](#ssl_accept_server_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. |
| [ssl_accept_server_cert_thumbprint_md5](#ssl_accept_server_cert_thumbprint_md5-property) | The MD5 hash of the certificate. |
| [ssl_accept_server_cert_thumbprint_sha1](#ssl_accept_server_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. |
| [ssl_accept_server_cert_thumbprint_sha256](#ssl_accept_server_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. |
| [ssl_accept_server_cert_usage](#ssl_accept_server_cert_usage-property) | The text description of UsageFlags . |
| [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property) | The flags that show intended use for the certificate. |
| [ssl_accept_server_cert_version](#ssl_accept_server_cert_version-property) | The certificate's version number. |
| [ssl_cert_effective_date](#ssl_cert_effective_date-property) | The date on which this certificate becomes valid. |
| [ssl_cert_encoded](#ssl_cert_encoded-property) | The certificate (PEM/Base64 encoded). |
| [ssl_cert_expiration_date](#ssl_cert_expiration_date-property) | The date on which the certificate expires. |
| [ssl_cert_extended_key_usage](#ssl_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. |
| [ssl_cert_fingerprint](#ssl_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [ssl_cert_fingerprint_sha1](#ssl_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [ssl_cert_fingerprint_sha256](#ssl_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [ssl_cert_issuer](#ssl_cert_issuer-property) | The issuer of the certificate. |
| [ssl_cert_private_key](#ssl_cert_private_key-property) | The private key of the certificate (if available). |
| [ssl_cert_private_key_available](#ssl_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. |
| [ssl_cert_private_key_container](#ssl_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). |
| [ssl_cert_public_key](#ssl_cert_public_key-property) | The public key of the certificate. |
| [ssl_cert_public_key_algorithm](#ssl_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. |
| [ssl_cert_public_key_length](#ssl_cert_public_key_length-property) | The length of the certificate's public key (in bits). |
| [ssl_cert_serial_number](#ssl_cert_serial_number-property) | The serial number of the certificate encoded as a string. |
| [ssl_cert_signature_algorithm](#ssl_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. |
| [ssl_cert_store](#ssl_cert_store-property) | The name of the certificate store for the client certificate. |
| [ssl_cert_store_password](#ssl_cert_store_password-property) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [ssl_cert_store_type](#ssl_cert_store_type-property) | The type of certificate store for this certificate. |
| [ssl_cert_subject](#ssl_cert_subject-property) | The subject of the certificate used for client authentication. |
| [ssl_cert_subject_alt_names](#ssl_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. |
| [ssl_cert_thumbprint_md5](#ssl_cert_thumbprint_md5-property) | The MD5 hash of the certificate. |
| [ssl_cert_thumbprint_sha1](#ssl_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. |
| [ssl_cert_thumbprint_sha256](#ssl_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. |
| [ssl_cert_usage](#ssl_cert_usage-property) | The text description of UsageFlags . |
| [ssl_cert_usage_flags](#ssl_cert_usage_flags-property) | The flags that show intended use for the certificate. |
| [ssl_cert_version](#ssl_cert_version-property) | The certificate's version number. |
| [ssl_provider](#ssl_provider-property) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
| [ssl_server_cert_effective_date](#ssl_server_cert_effective_date-property) | The date on which this certificate becomes valid. |
| [ssl_server_cert_encoded](#ssl_server_cert_encoded-property) | The certificate (PEM/Base64 encoded). |
| [ssl_server_cert_expiration_date](#ssl_server_cert_expiration_date-property) | The date on which the certificate expires. |
| [ssl_server_cert_extended_key_usage](#ssl_server_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. |
| [ssl_server_cert_fingerprint](#ssl_server_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [ssl_server_cert_fingerprint_sha1](#ssl_server_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [ssl_server_cert_fingerprint_sha256](#ssl_server_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [ssl_server_cert_issuer](#ssl_server_cert_issuer-property) | The issuer of the certificate. |
| [ssl_server_cert_private_key](#ssl_server_cert_private_key-property) | The private key of the certificate (if available). |
| [ssl_server_cert_private_key_available](#ssl_server_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. |
| [ssl_server_cert_private_key_container](#ssl_server_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). |
| [ssl_server_cert_public_key](#ssl_server_cert_public_key-property) | The public key of the certificate. |
| [ssl_server_cert_public_key_algorithm](#ssl_server_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. |
| [ssl_server_cert_public_key_length](#ssl_server_cert_public_key_length-property) | The length of the certificate's public key (in bits). |
| [ssl_server_cert_serial_number](#ssl_server_cert_serial_number-property) | The serial number of the certificate encoded as a string. |
| [ssl_server_cert_signature_algorithm](#ssl_server_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. |
| [ssl_server_cert_store](#ssl_server_cert_store-property) | The name of the certificate store for the client certificate. |
| [ssl_server_cert_store_password](#ssl_server_cert_store_password-property) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [ssl_server_cert_store_type](#ssl_server_cert_store_type-property) | The type of certificate store for this certificate. |
| [ssl_server_cert_subject](#ssl_server_cert_subject-property) | The subject of the certificate used for client authentication. |
| [ssl_server_cert_subject_alt_names](#ssl_server_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. |
| [ssl_server_cert_thumbprint_md5](#ssl_server_cert_thumbprint_md5-property) | The MD5 hash of the certificate. |
| [ssl_server_cert_thumbprint_sha1](#ssl_server_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. |
| [ssl_server_cert_thumbprint_sha256](#ssl_server_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. |
| [ssl_server_cert_usage](#ssl_server_cert_usage-property) | The text description of UsageFlags . |
| [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property) | The flags that show intended use for the certificate. |
| [ssl_server_cert_version](#ssl_server_cert_version-property) | The certificate's version number. |
| [timeout](#timeout-property) | The timeout for the class. |
| [web_server_bindings](#web_server_bindings-property) | The supported bindings used by the embedded web server. |
| [web_server_port](#web_server_port-property) | The local port on which the embedded web server listens. |
| [web_server_ssl_cert_effective_date](#web_server_ssl_cert_effective_date-property) | The date on which this certificate becomes valid. |
| [web_server_ssl_cert_encoded](#web_server_ssl_cert_encoded-property) | The certificate (PEM/Base64 encoded). |
| [web_server_ssl_cert_expiration_date](#web_server_ssl_cert_expiration_date-property) | The date on which the certificate expires. |
| [web_server_ssl_cert_extended_key_usage](#web_server_ssl_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. |
| [web_server_ssl_cert_fingerprint](#web_server_ssl_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [web_server_ssl_cert_fingerprint_sha1](#web_server_ssl_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [web_server_ssl_cert_fingerprint_sha256](#web_server_ssl_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [web_server_ssl_cert_issuer](#web_server_ssl_cert_issuer-property) | The issuer of the certificate. |
| [web_server_ssl_cert_private_key](#web_server_ssl_cert_private_key-property) | The private key of the certificate (if available). |
| [web_server_ssl_cert_private_key_available](#web_server_ssl_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. |
| [web_server_ssl_cert_private_key_container](#web_server_ssl_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). |
| [web_server_ssl_cert_public_key](#web_server_ssl_cert_public_key-property) | The public key of the certificate. |
| [web_server_ssl_cert_public_key_algorithm](#web_server_ssl_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. |
| [web_server_ssl_cert_public_key_length](#web_server_ssl_cert_public_key_length-property) | The length of the certificate's public key (in bits). |
| [web_server_ssl_cert_serial_number](#web_server_ssl_cert_serial_number-property) | The serial number of the certificate encoded as a string. |
| [web_server_ssl_cert_signature_algorithm](#web_server_ssl_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. |
| [web_server_ssl_cert_store](#web_server_ssl_cert_store-property) | The name of the certificate store for the client certificate. |
| [web_server_ssl_cert_store_password](#web_server_ssl_cert_store_password-property) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [web_server_ssl_cert_store_type](#web_server_ssl_cert_store_type-property) | The type of certificate store for this certificate. |
| [web_server_ssl_cert_subject](#web_server_ssl_cert_subject-property) | The subject of the certificate used for client authentication. |
| [web_server_ssl_cert_subject_alt_names](#web_server_ssl_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. |
| [web_server_ssl_cert_thumbprint_md5](#web_server_ssl_cert_thumbprint_md5-property) | The MD5 hash of the certificate. |
| [web_server_ssl_cert_thumbprint_sha1](#web_server_ssl_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. |
| [web_server_ssl_cert_thumbprint_sha256](#web_server_ssl_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. |
| [web_server_ssl_cert_usage](#web_server_ssl_cert_usage-property) | The text description of UsageFlags . |
| [web_server_ssl_cert_usage_flags](#web_server_ssl_cert_usage_flags-property) | The flags that show intended use for the certificate. |
| [web_server_ssl_cert_version](#web_server_ssl_cert_version-property) | The certificate's version number. |
| [web_server_ssl_enabled](#web_server_ssl_enabled-property) | Whether the web server requires Secure Sockets Layer (SSL) connections. |
## Method List
*The following is the full list of the methods of the class with short descriptions. Click on the links for further details.*
| | |
| --- | --- |
| [authenticate_user](#authenticate_user-method) | Authenticates a user to the application. |
| [build_service_metadata](#build_service_metadata-method) | Builds a metadata document for a service provider. |
| [config](#config-method) | Sets or retrieves a configuration setting. |
| [do_events](#do_events-method) | This method processes events from the internal message queue. |
| [get_assertion_attribute](#get_assertion_attribute-method) | Searches for a specific assertion attribute. |
| [interrupt](#interrupt-method) | This method interrupts the current method. |
| [load_identity_metadata](#load_identity_metadata-method) | Loads an identity provider's metadata document. |
| [parse_assertion](#parse_assertion-method) | Parses an assertion. |
| [parse_saml_response](#parse_saml_response-method) | Parses a SAML response. |
| [request_identity_metadata](#request_identity_metadata-method) | Requests an identity provider's SAML metadata document. |
| [reset](#reset-method) | This method will reset the class. |
| [start_web_server](#start_web_server-method) | Starts the embedded web server. |
| [stop_web_server](#stop_web_server-method) | Stops the embedded web server. |
| [validate_assertion](#validate_assertion-method) | Validates an assertion. |
| [validate_saml_response](#validate_saml_response-method) | Validates a SAML response. |
## Event List
*The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.*
| | |
| --- | --- |
| [on_error](#on_error-event) | Fired when information is available about errors during data delivery. |
| [on_launch_browser](#on_launch_browser-event) | Fires before launching a browser with the SAML request. |
| [on_log](#on_log-event) | Fired once for each log message. |
| [on_redirect](#on_redirect-event) | Fired when a redirection is received from the server. |
| [on_return_url](#on_return_url-event) | Fired when the user is redirected to the embedded web server. |
| [on_ssl_server_authentication](#on_ssl_server_authentication-event) | Fired after the server presents its certificate to the client. |
| [on_ssl_status](#on_ssl_status-event) | Fired when secure connection progress messages are available. |
## Config Settings
*The following is a list of config settings for the class with short descriptions. Click on the links for further details.*
| | |
| --- | --- |
| [AssertionValidationFlags](#AssertionValidationFlags) | The checks that are ignored when validating an assertion. |
| [CustomConsent](#CustomConsent) | The URI reference of a custom consent type. |
| [CustomNameIdFormat](#CustomNameIdFormat) | The URI reference of a custom NameID format type. |
| [SAMLRequestForceAuthn](#SAMLRequestForceAuthn) | Sets the ForceAuthn attribute in created SAML requests. |
| [SAMLResponseDetachedSignature](#SAMLResponseDetachedSignature) | The SAML response's detached signature. |
| [SAMLResponseDetachedSignatureAlg](#SAMLResponseDetachedSignatureAlg) | The algorithm of a SAMLResponse's detached signature. |
| [SAMLResponseValidationFlags](#SAMLResponseValidationFlags) | The checks that are ignored when validating a SAMLResponse. |
| [UseDetachedSignatures](#UseDetachedSignatures) | Whether detached signatures are used when building a SAML request. |
| [BrowserResponseTimeout](#BrowserResponseTimeout) | Specifies the amount of time to wait for a response from the browser. |
| [WebServerFailedResponse](#WebServerFailedResponse) | The custom response that will be displayed to the user if authentication failed. |
| [WebServerHost](#WebServerHost) | The hostname used by the embedded web server. |
| [WebServerResponse](#WebServerResponse) | The custom response that is displayed to the user. |
| [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. |
| [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. |
| [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
| [Append](#Append) | Whether to append data to LocalFile. |
| [Authorization](#Authorization) | The Authorization string to be sent to the server. |
| [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. |
| [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. |
| [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. |
| [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the class. |
| [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. |
| [GetOn302Redirect](#GetOn302Redirect) | If set to True the class will perform a GET on the new location. |
| [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| [HTTPVersion](#HTTPVersion) | The version of HTTP used by the class. |
| [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. |
| [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. |
| [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. |
| [LogLevel](#LogLevel) | The level of detail that is logged. |
| [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. |
| [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. |
| [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). |
| [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. |
| [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. |
| [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. |
| [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). |
| [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). |
| [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. |
| [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. |
| [StatusCode](#StatusCode) | The status code of the last response from the server. |
| [StatusLine](#StatusLine) | The first line of the last response from the server. |
| [TransferredData](#TransferredData) | The contents of the last response from the server. |
| [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the class. |
| [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. |
| [TransferredRequest](#TransferredRequest) | The full request as sent by the client. |
| [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. |
| [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. |
| [UsePlatformHTTPClient](#UsePlatformHTTPClient) | Whether or not to use the platform HTTP client. |
| [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. |
| [UserAgent](#UserAgent) | Information about the user agent (browser). |
| [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. |
| [EnableFallback](#EnableFallback) | Whether to try the other addresses the remote host resolves to when a connection attempt fails. |
| [FallbackTimeout](#FallbackTimeout) | The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled. |
| [FirewallAutoDetect](#FirewallAutoDetect) | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
| [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). |
| [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. |
| [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. |
| [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. |
| [FirewallType](#FirewallType) | Determines the type of firewall to connect through. |
| [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. |
| [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| [Linger](#Linger) | When set to True, connections are terminated gracefully. |
| [LingerTime](#LingerTime) | Time in seconds to have the connection linger. |
| [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. |
| [LocalPort](#LocalPort) | The port in the local host where the class binds. |
| [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. |
| [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. |
| [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. |
| [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. |
| [UseIPv6](#UseIPv6) | Whether to use IPv6. |
| [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. |
| [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. |
| [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. |
| [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. |
| [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. |
| [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). |
| [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. |
| [SSLCACertFilePaths](#SSLCACertFilePaths) | The paths to CA certificate files on Unix/Linux. |
| [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. |
| [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. |
| [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. |
| [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. |
| [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. |
| [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. |
| [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. |
| [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. |
| [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. |
| [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. |
| [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. |
| [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. |
| [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. |
| [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. |
| [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. |
| [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. |
| [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. |
| [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. |
| [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. |
| [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. |
| [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. |
| [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| [FirewallData](#FirewallData) | Used to send extra data to the firewall. |
| [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. |
| [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. |
| [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |
# assertion_content property
The raw XML of the assertion.
## Syntax
```text
def get_assertion_content() -> bytes: ...
def set_assertion_content(value: bytes) -> None: ...
assertion_content = property(get_assertion_content, set_assertion_content)
```
## Default Value
""
## Remarks
The raw XML of the assertion. This property can be set to provide the assertion to the class for the [parse_assertion](#SAML_m_ParseAssertion) or [validate_assertion](#SAML_m_ValidateAssertion) methods to parse or validate the assertion without the SAML response.
# assertion_expiration_date property
When the parsed assertion is expired.
## Syntax
```text
def get_assertion_expiration_date() -> str: ...
assertion_expiration_date = property(get_assertion_expiration_date, None)
```
## Default Value
""
## Remarks
When the parsed assertion is expired. If expired, a new assertion should be requested from the Identity Provider for the subject. This represents the *NotOnOrAfter* attribute of the *Conditions* element if the attribute is present in the assertion.
Time-based values are specified by the SAML specification to be in UTC in the following format: *YYYY-MM-DDTHH:mm:ss.sssZ*
This property is read-only.
# assertion_id property
The unique Id of the assertion generated by the identity provider.
## Syntax
```text
def get_assertion_id() -> str: ...
assertion_id = property(get_assertion_id, None)
```
## Default Value
""
## Remarks
The unique Id of the assertion generated by the identity provider. This is **not** an Id that is tied to a user pf the SAML response, but rather to the assertion itself.
This property is read-only.
# assertion_is_signed property
Whether the assertion has been signed by the identity provider.
## Syntax
```text
def get_assertion_is_signed() -> bool: ...
assertion_is_signed = property(get_assertion_is_signed, None)
```
## Default Value
FALSE
## Remarks
Whether the assertion has been signed by the identity provider. The signature is used to verify that the assertion has not been tampered with during transmission. Typically, the assertion is signed along with the SAML response that stores it. This is set to *True* when the *Signature* element is present in the assertion.
This property is read-only.
# assertion_issued_time property
The time at which the assertion was issued by the Issuer (typically the identity provider).
## Syntax
```text
def get_assertion_issued_time() -> str: ...
assertion_issued_time = property(get_assertion_issued_time, None)
```
## Default Value
""
## Remarks
The time at which the assertion was issued by the [assertion_issuer](#assertion_issuer-property) (typically the identity provider). This property represents the *IssueInstant* attribute of the *Assertion* element.
Time-based values are specified by the SAML specification to be in UTC in the following format: *YYYY-MM-DDTHH:mm:ss.sssZ*
This property is read-only.
# assertion_issuer property
The issuer of the assertion.
## Syntax
```text
def get_assertion_issuer() -> str: ...
assertion_issuer = property(get_assertion_issuer, None)
```
## Default Value
""
## Remarks
The issuer of the assertion. Typically, this is the same as the identity provider that provided the SAML response. The issuer of the SAML response can differ if Identity Provider is an intermediary between the service provider and the final Identity Provider. This property represents the *Issuer* element in the *Assertion* element.
This property is read-only.
# assertion_not_before_date property
The time at which the assertion becomes valid.
## Syntax
```text
def get_assertion_not_before_date() -> str: ...
assertion_not_before_date = property(get_assertion_not_before_date, None)
```
## Default Value
""
## Remarks
The time at which the assertion becomes valid. If the current time is before this property, then the assertion is not considered valid yet. This represents the *NotBefore* attribute of the *Conditions* element if the attribute is present in the assertion.
Time-based values are specified by the SAML specification to be in UTC in the following format: *YYYY-MM-DDTHH:mm:ss.sssZ*
This property is read-only.
# assertion_one_time_use property
Whether the issuer only considers this information valid for this single instance.
## Syntax
```text
def get_assertion_one_time_use() -> bool: ...
assertion_one_time_use = property(get_assertion_one_time_use, None)
```
## Default Value
FALSE
## Remarks
Whether the issuer only considers this information valid for this single instance. The information saved here typically should not be cached or saved for future use. This represents the *OneTimeUse* element of the *Conditions* element if the element is present in the assertion.
This property is read-only.
# assertion_subject_name_id property
The unique name identifier for the subject of the current assertion.
## Syntax
```text
def get_assertion_subject_name_id() -> str: ...
assertion_subject_name_id = property(get_assertion_subject_name_id, None)
```
## Default Value
""
## Remarks
The unique name identifier for the subject of the current assertion. In the SSO SAML profile, the subject is the user that is being authenticated. Since this value is unique to the user (from the Identity Provider) this value is typically used to also identify the user in an application. The format of this "name Id" can be found in the [assertion_subject_name_id_format](#assertion_subject_name_id_format-property) property. This represents the *NameId* element of the *Subject* element if the element is present in the assertion.
This property is read-only.
# assertion_subject_name_id_format property
A URI reference to how the SubjectNameId of the element is formatted.
## Syntax
```text
def get_assertion_subject_name_id_format() -> str: ...
assertion_subject_name_id_format = property(get_assertion_subject_name_id_format, None)
```
## Default Value
""
## Remarks
A URI reference to how the [assertion_subject_name_id](#assertion_subject_name_id-property) of the element is formatted. If not set, *Unspecified* is used. This represents the *Format* attribute of the *NameID* element if the attribute is present in the assertion.
Some common values are:
| | |
| --- | --- |
| urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified | Unspecified |
| urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress | Email Address |
| urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName | Windows Domain Qualified Name |
This property is read-only.
# assertion_attribute_count property
The number of records in the AssertionAttribute arrays.
## Syntax
```text
def get_assertion_attribute_count() -> int: ...
def set_assertion_attribute_count(value: int) -> None: ...
assertion_attribute_count = property(get_assertion_attribute_count, set_assertion_attribute_count)
```
## Default Value
0
## Remarks
This property controls the size of the following arrays:
- [assertion_attribute_content](#assertion_attribute_content-property)
- [assertion_attribute_friendly_name](#assertion_attribute_friendly_name-property)
- [assertion_attribute_name](#assertion_attribute_name-property)
- [assertion_attribute_name_format](#assertion_attribute_name_format-property)
- [assertion_attribute_value_count](#assertion_attribute_value_count-property)
- [assertion_attribute_value_data](#assertion_attribute_value_data-property)
- [assertion_attribute_value_index](#assertion_attribute_value_index-property)
The array indices start at *0* and end at *assertion_attribute_count - 1*.
# assertion_attribute_content property
The raw XML of the attribute.
## Syntax
```text
def get_assertion_attribute_content(assertion_attribute_idx: int) -> str: ...
```
## Default Value
""
## Remarks
The raw XML of the attribute. In cases where the content of the attribute is complex, this property can be used to do additional XML parsing.
The *assertion_attribute_idx* parameter specifies the index of the item in the array. The size of the array is controlled by the [assertion_attribute_count](#assertion_attribute_count-property) property.
This property is read-only.
# assertion_attribute_friendly_name property
A human-readable version of the attribute name, if provided.
## Syntax
```text
def get_assertion_attribute_friendly_name(assertion_attribute_idx: int) -> str: ...
```
## Default Value
""
## Remarks
A human-readable version of the attribute name, if provided. This value is intended to be used for informational and logging purposes only.
The *assertion_attribute_idx* parameter specifies the index of the item in the array. The size of the array is controlled by the [assertion_attribute_count](#assertion_attribute_count-property) property.
This property is read-only.
# assertion_attribute_name property
The name of the attribute.
## Syntax
```text
def get_assertion_attribute_name(assertion_attribute_idx: int) -> str: ...
```
## Default Value
""
## Remarks
The name of the attribute. The format of the name (if provided) can be found in the [assertion_name_format](#SAMLDesktop_p_AssertionNameFormat) property.
The *assertion_attribute_idx* parameter specifies the index of the item in the array. The size of the array is controlled by the [assertion_attribute_count](#assertion_attribute_count-property) property.
This property is read-only.
# assertion_attribute_name_format property
A URI reference to how the Name of the attribute is formatted.
## Syntax
```text
def get_assertion_attribute_name_format(assertion_attribute_idx: int) -> str: ...
```
## Default Value
""
## Remarks
A URI reference to how the [assertion_name](#SAMLDesktop_p_AssertionName) of the attribute is formatted. If not set, *Unspecified* is used.
Some common values are:
| | |
| --- | --- |
| urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified | Unspecified |
| urn:oasis:names:tc:SAML:2.0:attrname-format:uri | URI Reference |
| urn:oasis:names:tc:SAML:2.0:attrname-format:basic | Basic |
The *assertion_attribute_idx* parameter specifies the index of the item in the array. The size of the array is controlled by the [assertion_attribute_count](#assertion_attribute_count-property) property.
This property is read-only.
# assertion_attribute_value_count property
In cases where there are multiple values for a single attribute, this count will be updated to reflect the size of the list.
## Syntax
```text
def get_assertion_attribute_value_count(assertion_attribute_idx: int) -> int: ...
```
## Default Value
0
## Remarks
In cases where there are multiple values for a single attribute, this count will be updated to reflect the size of the list. If the value of the attribute is not a list, the count will be set to 1. See [assertion_value_index](#SAMLDesktop_p_AssertionValueIndex) for more information.
The *assertion_attribute_idx* parameter specifies the index of the item in the array. The size of the array is controlled by the [assertion_attribute_count](#assertion_attribute_count-property) property.
This property is read-only.
# assertion_attribute_value_data property
The content of the attribute value selected by ValueIndex .
## Syntax
```text
def get_assertion_attribute_value_data(assertion_attribute_idx: int) -> str: ...
```
## Default Value
""
## Remarks
The content of the attribute value selected by [assertion_value_index](#SAMLDesktop_p_AssertionValueIndex).
The *assertion_attribute_idx* parameter specifies the index of the item in the array. The size of the array is controlled by the [assertion_attribute_count](#assertion_attribute_count-property) property.
This property is read-only.
# assertion_attribute_value_index property
The index of the attribute value that should be populated in the ValueData property.
## Syntax
```text
def get_assertion_attribute_value_index(assertion_attribute_idx: int) -> int: ...
def set_assertion_attribute_value_index(assertion_attribute_idx: int, value: int) -> None: ...
```
## Default Value
0
## Remarks
The index of the attribute value that should be populated in the [assertion_value_data](#SAMLDesktop_p_AssertionValueData) property. Valid ranges for this property are from 0 to [assertion_value_count](#SAMLDesktop_p_AssertionValueCount) - 1. By default, this property is set to 0. In cases where there is only a singular value, that value will be at index 0. For example:
**Multi-value attribute**
```text
Value1
Value2
```
**Iterating through each value in an attribute**
```text
for (int i = 0; i < saml.AssertionAttributeInfo[0].ValueCount; i++) {
saml.AssertionAttributeInfo[0].ValueIndex = i;
string attribute_value = saml.AssertionAttributeInfo[0].ValueData;
//... the rest of the processing
}
```
The *assertion_attribute_idx* parameter specifies the index of the item in the array. The size of the array is controlled by the [assertion_attribute_count](#assertion_attribute_count-property) property.
# assertion_authn_count property
The number of records in the AssertionAuthn arrays.
## Syntax
```text
def get_assertion_authn_count() -> int: ...
def set_assertion_authn_count(value: int) -> None: ...
assertion_authn_count = property(get_assertion_authn_count, set_assertion_authn_count)
```
## Default Value
0
## Remarks
This property controls the size of the following arrays:
- [assertion_authn_authenticating_authorities](#assertion_authn_authenticating_authorities-property)
- [assertion_authn_content](#assertion_authn_content-property)
- [assertion_authn_context_class_reference](#assertion_authn_context_class_reference-property)
- [assertion_authn_context_declaration](#assertion_authn_context_declaration-property)
- [assertion_authn_instant](#assertion_authn_instant-property)
- [assertion_authn_session_expiration](#assertion_authn_session_expiration-property)
- [assertion_authn_session_index](#assertion_authn_session_index-property)
The array indices start at *0* and end at *assertion_authn_count - 1*.
# assertion_authn_authenticating_authorities property
A semicolon-separated list of authorities involved with the current authentication context.
## Syntax
```text
def get_assertion_authn_authenticating_authorities(assertion_authn_index: int) -> str: ...
```
## Default Value
""
## Remarks
A semicolon-separated list of authorities involved with the current authentication context. Typically, this list includes other parties involved with the authentication of the subject besides the issuer that issued the assertion.
The *assertion_authn_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [assertion_authn_count](#assertion_authn_count-property) property.
This property is read-only.
# assertion_authn_content property
The raw XML of the Authn statement.
## Syntax
```text
def get_assertion_authn_content(assertion_authn_index: int) -> str: ...
```
## Default Value
""
## Remarks
The raw XML of the Authn statement. Typically, this is used in cases to get additional information from the Authn statement that is not provided by the class.
The *assertion_authn_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [assertion_authn_count](#assertion_authn_count-property) property.
This property is read-only.
# assertion_authn_context_class_reference property
A predefined URI reference identifying an authentication context class that describes how authentication was provided.
## Syntax
```text
def get_assertion_authn_context_class_reference(assertion_authn_index: int) -> str: ...
```
## Default Value
""
## Remarks
A predefined URI reference identifying an authentication context class that describes how authentication was provided. For example, if the user used a password to perform authentication, this will be set to *urn:oasis:names:tc:SAML:2.0:ac:classes:Password*.
The *assertion_authn_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [assertion_authn_count](#assertion_authn_count-property) property.
This property is read-only.
# assertion_authn_context_declaration property
A description or URI that describes additional information about the authentication context past the ContextClassReference .
## Syntax
```text
def get_assertion_authn_context_declaration(assertion_authn_index: int) -> str: ...
```
## Default Value
""
## Remarks
A description or URI that describes additional information about the authentication context past the [assertion_context_class_reference](#SAMLDesktop_p_AssertionContextClassReference). This provides more detail about the authentication process when provided by the Identity Provider.
The *assertion_authn_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [assertion_authn_count](#assertion_authn_count-property) property.
This property is read-only.
# assertion_authn_instant property
The time at which the authentication took place that was used to issue the assertion.
## Syntax
```text
def get_assertion_authn_instant(assertion_authn_index: int) -> str: ...
```
## Default Value
""
## Remarks
The time at which the authentication took place that was used to issue the assertion.
Time-based values are specified by the SAML specification to be in UTC in the following format: *YYYY-MM-DDTHH:mm:ss.sssZ*
The *assertion_authn_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [assertion_authn_count](#assertion_authn_count-property) property.
This property is read-only.
# assertion_authn_session_expiration property
The time at which the session between the principal and Identity Provider must be considered ended.
## Syntax
```text
def get_assertion_authn_session_expiration(assertion_authn_index: int) -> str: ...
```
## Default Value
""
## Remarks
The time at which the session between the principal and Identity Provider must be considered ended.
Time-based values are specified by the SAML specification to be in UTC in the following format: *YYYY-MM-DDTHH:mm:ss.sssZ*
The *assertion_authn_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [assertion_authn_count](#assertion_authn_count-property) property.
This property is read-only.
# assertion_authn_session_index property
The unique identifier for a particular session established between the user (principal) and the Service Provider (SP), as provided by the Identity Provider (IdP).
## Syntax
```text
def get_assertion_authn_session_index(assertion_authn_index: int) -> str: ...
```
## Default Value
""
## Remarks
The unique identifier for a particular session established between the user (principal) and the Service Provider (SP), as provided by the Identity Provider (IdP). It is common (but not required) to use this value as the session identifier between the user and the Service Provider (your application). Additionally, it is common practice to provide the session index when performing SLO (Single Logout) if supported.
The *assertion_authn_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [assertion_authn_count](#assertion_authn_count-property) property.
This property is read-only.
# firewall_auto_detect property
Whether to automatically detect and use firewall system settings, if available.
## Syntax
```text
def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...
firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)
```
## Default Value
FALSE
## Remarks
Whether to automatically detect and use firewall system settings, if available.
# firewall_host property
The name or IP address of the firewall (optional).
## Syntax
```text
def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...
firewall_host = property(get_firewall_host, set_firewall_host)
```
## Default Value
""
## Remarks
The name or IP address of the firewall (optional). If a [firewall_host](#firewall_host-property) 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 fails with an error.
# firewall_password property
A password if authentication is to be used when connecting through the firewall.
## Syntax
```text
def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...
firewall_password = property(get_firewall_password, set_firewall_password)
```
## Default Value
""
## Remarks
A password if authentication is to be used when connecting through the firewall. If [firewall_host](#firewall_host-property) is specified, the [firewall_user](#firewall_user-property) and [firewall_password](#firewall_password-property) properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
# firewall_port property
The Transmission Control Protocol (TCP) port for the firewall Host .
## Syntax
```text
def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...
firewall_port = property(get_firewall_port, set_firewall_port)
```
## Default Value
0
## Remarks
The Transmission Control Protocol (TCP) port for the firewall [firewall_host](#firewall_host-property). See the description of the [firewall_host](#firewall_host-property) property for details.
NOTE: This property is set automatically when [firewall_type](#SAMLDesktop_p_FirewallFirewallType) is set to a valid value. See the description of the [firewall_type](#SAMLDesktop_p_FirewallFirewallType) property for details.
# firewall_type property
The type of firewall to connect through.
## Syntax
```text
def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...
firewall_type = property(get_firewall_type, set_firewall_type)
```
## Possible Values
```text
0 # None1 # Tunnel2 # SOCKS43 # SOCKS510 # SOCKS4A
```
## Default Value
0
## Remarks
The type of firewall to connect through. The applicable values are as follows:
| | |
| --- | --- |
| fwNone (0) | No firewall (default setting). |
| fwTunnel (1) | Connect through a tunneling proxy. [firewall_port](#firewall_port-property) is set to 80. |
| fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [firewall_port](#firewall_port-property) is set to 1080. |
| fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [firewall_port](#firewall_port-property) is set to 1080. |
| fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [firewall_port](#firewall_port-property) is set to 1080. |
# firewall_user property
A username if authentication is to be used when connecting through a firewall.
## Syntax
```text
def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...
firewall_user = property(get_firewall_user, set_firewall_user)
```
## Default Value
""
## Remarks
A username if authentication is to be used when connecting through a firewall. If [firewall_host](#firewall_host-property) is specified, this property and the [firewall_password](#firewall_password-property) property are used to connect and authenticate to the given [Firewall](#Type_Firewall). If the authentication fails, the class fails with an error.
# follow_redirects property
Determines what happens when the server issues a redirect.
## Syntax
```text
def get_follow_redirects() -> int: ...
def set_follow_redirects(value: int) -> None: ...
follow_redirects = property(get_follow_redirects, set_follow_redirects)
```
## Possible Values
```text
0 # Never1 # Always2 # SameScheme
```
## Default Value
0
## Remarks
This property determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to frAlways (1), the new url for the object is retrieved automatically every time.
If this property is set to frSameScheme (2), the new url is retrieved automatically only if the url_scheme is the same; otherwise, the class fails with an error.
NOTE: Following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for *GET* or *HEAD* requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server or port are different from the existing one, user and password are also reset to empty. If, however, this property is set to frAlways (1), the same credentials are used to connect to the new server.
A [on_redirect](#on_redirect-event) event is fired for every URL the product is redirected to. In the case of automatic redirections, the [on_redirect](#on_redirect-event) event is a good place to set properties related to the new connection (e.g., new authentication parameters).
The default value is frNever (0). In this case, redirects are never followed, and the class fails with an error instead.
# identity_provider_encrypting_cert_effective_date property
The date on which this certificate becomes valid.
## Syntax
```text
def get_identity_provider_encrypting_cert_effective_date() -> str: ...
identity_provider_encrypting_cert_effective_date = property(get_identity_provider_encrypting_cert_effective_date, None)
```
## Default Value
""
## Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
# identity_provider_encrypting_cert_encoded property
The certificate (PEM/Base64 encoded).
## Syntax
```text
def get_identity_provider_encrypting_cert_encoded() -> bytes: ...
def set_identity_provider_encrypting_cert_encoded(value: bytes) -> None: ...
identity_provider_encrypting_cert_encoded = property(get_identity_provider_encrypting_cert_encoded, set_identity_provider_encrypting_cert_encoded)
```
## Default Value
""
## Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [identity_provider_encrypting_cert_store](#identity_provider_encrypting_cert_store-property) and [identity_provider_encrypting_cert_subject](#identity_provider_encrypting_cert_subject-property) properties also may be used to specify a certificate.
When [identity_provider_encrypting_cert_encoded](#identity_provider_encrypting_cert_encoded-property) is set, a search is initiated in the current [identity_provider_encrypting_cert_store](#identity_provider_encrypting_cert_store-property) for the private key of the certificate. If the key is found, [identity_provider_encrypting_cert_subject](#identity_provider_encrypting_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [identity_provider_encrypting_cert_subject](#identity_provider_encrypting_cert_subject-property) is set to an empty string.
# identity_provider_encrypting_cert_expiration_date property
The date on which the certificate expires.
## Syntax
```text
def get_identity_provider_encrypting_cert_expiration_date() -> str: ...
identity_provider_encrypting_cert_expiration_date = property(get_identity_provider_encrypting_cert_expiration_date, None)
```
## Default Value
""
## Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
# identity_provider_encrypting_cert_extended_key_usage property
A comma-delimited list of extended key usage identifiers.
## Syntax
```text
def get_identity_provider_encrypting_cert_extended_key_usage() -> str: ...
identity_provider_encrypting_cert_extended_key_usage = property(get_identity_provider_encrypting_cert_extended_key_usage, None)
```
## Default Value
""
## Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
# identity_provider_encrypting_cert_fingerprint property
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
## Syntax
```text
def get_identity_provider_encrypting_cert_fingerprint() -> str: ...
identity_provider_encrypting_cert_fingerprint = property(get_identity_provider_encrypting_cert_fingerprint, None)
```
## Default Value
""
## Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02*
This property is read-only.
# identity_provider_encrypting_cert_fingerprint_sha1 property
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
## Syntax
```text
def get_identity_provider_encrypting_cert_fingerprint_sha1() -> str: ...
identity_provider_encrypting_cert_fingerprint_sha1 = property(get_identity_provider_encrypting_cert_fingerprint_sha1, None)
```
## Default Value
""
## Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84*
This property is read-only.
# identity_provider_encrypting_cert_fingerprint_sha256 property
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
## Syntax
```text
def get_identity_provider_encrypting_cert_fingerprint_sha256() -> str: ...
identity_provider_encrypting_cert_fingerprint_sha256 = property(get_identity_provider_encrypting_cert_fingerprint_sha256, None)
```
## Default Value
""
## Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53*
This property is read-only.
# identity_provider_encrypting_cert_issuer property
The issuer of the certificate.
## Syntax
```text
def get_identity_provider_encrypting_cert_issuer() -> str: ...
identity_provider_encrypting_cert_issuer = property(get_identity_provider_encrypting_cert_issuer, None)
```
## Default Value
""
## Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
# identity_provider_encrypting_cert_private_key property
The private key of the certificate (if available).
## Syntax
```text
def get_identity_provider_encrypting_cert_private_key() -> str: ...
identity_provider_encrypting_cert_private_key = property(get_identity_provider_encrypting_cert_private_key, None)
```
## Default Value
""
## Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
NOTE: The [identity_provider_encrypting_cert_private_key](#identity_provider_encrypting_cert_private_key-property) may be available but not exportable. In this case, [identity_provider_encrypting_cert_private_key](#identity_provider_encrypting_cert_private_key-property) returns an empty string.
This property is read-only.
# identity_provider_encrypting_cert_private_key_available property
Whether a PrivateKey is available for the selected certificate.
## Syntax
```text
def get_identity_provider_encrypting_cert_private_key_available() -> bool: ...
identity_provider_encrypting_cert_private_key_available = property(get_identity_provider_encrypting_cert_private_key_available, None)
```
## Default Value
FALSE
## Remarks
Whether a [identity_provider_encrypting_cert_private_key](#identity_provider_encrypting_cert_private_key-property) is available for the selected certificate. If [identity_provider_encrypting_cert_private_key_available](#identity_provider_encrypting_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
# identity_provider_encrypting_cert_private_key_container property
The name of the PrivateKey container for the certificate (if available).
## Syntax
```text
def get_identity_provider_encrypting_cert_private_key_container() -> str: ...
identity_provider_encrypting_cert_private_key_container = property(get_identity_provider_encrypting_cert_private_key_container, None)
```
## Default Value
""
## Remarks
The name of the [identity_provider_encrypting_cert_private_key](#identity_provider_encrypting_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
# identity_provider_encrypting_cert_public_key property
The public key of the certificate.
## Syntax
```text
def get_identity_provider_encrypting_cert_public_key() -> str: ...
identity_provider_encrypting_cert_public_key = property(get_identity_provider_encrypting_cert_public_key, None)
```
## Default Value
""
## Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
# identity_provider_encrypting_cert_public_key_algorithm property
The textual description of the certificate's public key algorithm.
## Syntax
```text
def get_identity_provider_encrypting_cert_public_key_algorithm() -> str: ...
identity_provider_encrypting_cert_public_key_algorithm = property(get_identity_provider_encrypting_cert_public_key_algorithm, None)
```
## Default Value
""
## Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
# identity_provider_encrypting_cert_public_key_length property
The length of the certificate's public key (in bits).
## Syntax
```text
def get_identity_provider_encrypting_cert_public_key_length() -> int: ...
identity_provider_encrypting_cert_public_key_length = property(get_identity_provider_encrypting_cert_public_key_length, None)
```
## Default Value
0
## Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
# identity_provider_encrypting_cert_serial_number property
The serial number of the certificate encoded as a string.
## Syntax
```text
def get_identity_provider_encrypting_cert_serial_number() -> str: ...
identity_provider_encrypting_cert_serial_number = property(get_identity_provider_encrypting_cert_serial_number, None)
```
## Default Value
""
## Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
# identity_provider_encrypting_cert_signature_algorithm property
The text description of the certificate's signature algorithm.
## Syntax
```text
def get_identity_provider_encrypting_cert_signature_algorithm() -> str: ...
identity_provider_encrypting_cert_signature_algorithm = property(get_identity_provider_encrypting_cert_signature_algorithm, None)
```
## Default Value
""
## Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
# identity_provider_encrypting_cert_store property
The name of the certificate store for the client certificate.
## Syntax
```text
def get_identity_provider_encrypting_cert_store() -> bytes: ...
def set_identity_provider_encrypting_cert_store(value: bytes) -> None: ...
identity_provider_encrypting_cert_store = property(get_identity_provider_encrypting_cert_store, set_identity_provider_encrypting_cert_store)
```
## Default Value
"MY"
## Remarks
The name of the certificate store for the client certificate.
The [identity_provider_encrypting_cert_store_type](#identity_provider_encrypting_cert_store_type-property) property denotes the type of the certificate store specified by [identity_provider_encrypting_cert_store](#identity_provider_encrypting_cert_store-property). If the store is password-protected, specify the password in [identity_provider_encrypting_cert_store_password](#identity_provider_encrypting_cert_store_password-property).
[identity_provider_encrypting_cert_store](#identity_provider_encrypting_cert_store-property) is used in conjunction with the [identity_provider_encrypting_cert_subject](#identity_provider_encrypting_cert_subject-property) property to specify client certificates. If [identity_provider_encrypting_cert_store](#identity_provider_encrypting_cert_store-property) has a value, and [identity_provider_encrypting_cert_subject](#identity_provider_encrypting_cert_subject-property) or [identity_provider_encrypting_cert_encoded](#identity_provider_encrypting_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [identity_provider_encrypting_cert_subject](#identity_provider_encrypting_cert_subject-property) 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).
# identity_provider_encrypting_cert_store_password property
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
## Syntax
```text
def get_identity_provider_encrypting_cert_store_password() -> str: ...
def set_identity_provider_encrypting_cert_store_password(value: str) -> None: ...
identity_provider_encrypting_cert_store_password = property(get_identity_provider_encrypting_cert_store_password, set_identity_provider_encrypting_cert_store_password)
```
## Default Value
""
## Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
# identity_provider_encrypting_cert_store_type property
The type of certificate store for this certificate.
## Syntax
```text
def get_identity_provider_encrypting_cert_store_type() -> int: ...
def set_identity_provider_encrypting_cert_store_type(value: int) -> None: ...
identity_provider_encrypting_cert_store_type = property(get_identity_provider_encrypting_cert_store_type, set_identity_provider_encrypting_cert_store_type)
```
## Possible Values
```text
0 # User1 # Machine2 # PFXFile3 # PFXBlob4 # JKSFile5 # JKSBlob6 # PEMKeyFile7 # PEMKeyBlob8 # PublicKeyFile9 # PublicKeyBlob10 # SSHPublicKeyBlob11 # P7BFile12 # P7BBlob13 # SSHPublicKeyFile14 # PPKFile15 # PPKBlob16 # XMLFile17 # XMLBlob18 # JWKFile19 # JWKBlob20 # SecurityKey21 # BCFKSFile22 # BCFKSBlob23 # PKCS1199 # Auto
```
## Default Value
0
## Remarks
The type of certificate store for this certificate.
The 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:
```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
@"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
"123456", // PIN
"CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```
```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```
| | |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [identity_provider_encrypting_cert_store_type](#identity_provider_encrypting_cert_store_type-property), the full path of the PKCS#11 DLL as the [identity_provider_encrypting_cert_store](#identity_provider_encrypting_cert_store-property), and the PIN as the [identity_provider_encrypting_cert_store_password](#identity_provider_encrypting_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [identity_provider_encrypting_cert_store](#identity_provider_encrypting_cert_store-property) and set [identity_provider_encrypting_cert_store_password](#identity_provider_encrypting_cert_store_password-property) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
# identity_provider_encrypting_cert_subject property
The subject of the certificate used for client authentication.
## Syntax
```text
def get_identity_provider_encrypting_cert_subject() -> str: ...
def set_identity_provider_encrypting_cert_subject(value: str) -> None: ...
identity_provider_encrypting_cert_subject = property(get_identity_provider_encrypting_cert_subject, set_identity_provider_encrypting_cert_subject)
```
## Default Value
""
## Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:
| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
# identity_provider_encrypting_cert_subject_alt_names property
Comma-separated lists of alternative subject names for the certificate.
## Syntax
```text
def get_identity_provider_encrypting_cert_subject_alt_names() -> str: ...
identity_provider_encrypting_cert_subject_alt_names = property(get_identity_provider_encrypting_cert_subject_alt_names, None)
```
## Default Value
""
## Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
# identity_provider_encrypting_cert_thumbprint_md5 property
The MD5 hash of the certificate.
## Syntax
```text
def get_identity_provider_encrypting_cert_thumbprint_md5() -> str: ...
identity_provider_encrypting_cert_thumbprint_md5 = property(get_identity_provider_encrypting_cert_thumbprint_md5, None)
```
## Default Value
""
## Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
# identity_provider_encrypting_cert_thumbprint_sha1 property
The SHA-1 hash of the certificate.
## Syntax
```text
def get_identity_provider_encrypting_cert_thumbprint_sha1() -> str: ...
identity_provider_encrypting_cert_thumbprint_sha1 = property(get_identity_provider_encrypting_cert_thumbprint_sha1, None)
```
## Default Value
""
## Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
# identity_provider_encrypting_cert_thumbprint_sha256 property
The SHA-256 hash of the certificate.
## Syntax
```text
def get_identity_provider_encrypting_cert_thumbprint_sha256() -> str: ...
identity_provider_encrypting_cert_thumbprint_sha256 = property(get_identity_provider_encrypting_cert_thumbprint_sha256, None)
```
## Default Value
""
## Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
# identity_provider_encrypting_cert_usage property
The text description of UsageFlags .
## Syntax
```text
def get_identity_provider_encrypting_cert_usage() -> str: ...
identity_provider_encrypting_cert_usage = property(get_identity_provider_encrypting_cert_usage, None)
```
## Default Value
""
## Remarks
The text description of [identity_provider_encrypting_cert_usage_flags](#identity_provider_encrypting_cert_usage_flags-property).
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
# identity_provider_encrypting_cert_usage_flags property
The flags that show intended use for the certificate.
## Syntax
```text
def get_identity_provider_encrypting_cert_usage_flags() -> int: ...
identity_provider_encrypting_cert_usage_flags = property(get_identity_provider_encrypting_cert_usage_flags, None)
```
## Default Value
0
## Remarks
The flags that show intended use for the certificate. The value of [identity_provider_encrypting_cert_usage_flags](#identity_provider_encrypting_cert_usage_flags-property) 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 [identity_provider_encrypting_cert_usage](#identity_provider_encrypting_cert_usage-property) property for a text representation of [identity_provider_encrypting_cert_usage_flags](#identity_provider_encrypting_cert_usage_flags-property).
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
# identity_provider_encrypting_cert_version property
The certificate's version number.
## Syntax
```text
def get_identity_provider_encrypting_cert_version() -> str: ...
identity_provider_encrypting_cert_version = property(get_identity_provider_encrypting_cert_version, None)
```
## Default Value
""
## Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
# identity_provider_metadata_content property
The raw metadata for the identity provider.
## Syntax
```text
def get_identity_provider_metadata_content() -> bytes: ...
def set_identity_provider_metadata_content(value: bytes) -> None: ...
identity_provider_metadata_content = property(get_identity_provider_metadata_content, set_identity_provider_metadata_content)
```
## Default Value
""
## Remarks
The raw metadata for the identity provider. To avoid repeated requests to the Identity Provider, this value can be saved for later to be used with the [load_identity_metadata](#SAML_m_LoadIdentityMetadata) method.
# identity_provider_metadata_entity_id property
The unique Id for the identity provider that is being described.
## Syntax
```text
def get_identity_provider_metadata_entity_id() -> str: ...
def set_identity_provider_metadata_entity_id(value: str) -> None: ...
identity_provider_metadata_entity_id = property(get_identity_provider_metadata_entity_id, set_identity_provider_metadata_entity_id)
```
## Default Value
""
## Remarks
The unique Id for the identity provider that is being described. This is used for verification purposes when verifying the issuer of an SAML response or assertion.
# identity_provider_metadata_expiration_date property
The expiration date of the Identity Provider description provided by the metadata document.
## Syntax
```text
def get_identity_provider_metadata_expiration_date() -> str: ...
identity_provider_metadata_expiration_date = property(get_identity_provider_metadata_expiration_date, None)
```
## Default Value
""
## Remarks
The expiration date of the Identity Provider description provided by the metadata document. This represents the *valid* attribute of the *IDPSSODescriptor* element if the attribute is present in the document.
This property is read-only.
# identity_provider_metadata_requests_signed_authn_requests property
Whether the identity provider requests that authentication (Authn) requests are signed.
## Syntax
```text
def get_identity_provider_metadata_requests_signed_authn_requests() -> bool: ...
def set_identity_provider_metadata_requests_signed_authn_requests(value: bool) -> None: ...
identity_provider_metadata_requests_signed_authn_requests = property(get_identity_provider_metadata_requests_signed_authn_requests, set_identity_provider_metadata_requests_signed_authn_requests)
```
## Default Value
FALSE
## Remarks
Whether the identity provider requests that authentication (Authn) requests are signed. If *True*, the SignRequest setting should be set to true before initiating authentication.
# identity_provider_metadata_signed_metadata property
Whether the identity provider's parsed metadata is signed.
## Syntax
```text
def get_identity_provider_metadata_signed_metadata() -> bool: ...
identity_provider_metadata_signed_metadata = property(get_identity_provider_metadata_signed_metadata, None)
```
## Default Value
FALSE
## Remarks
Whether the identity provider's parsed metadata is signed. This signature is used to insure that the metadata was not tampered with during transit.
This property is read-only.
# identity_provider_metadata_supported_attribute_profiles property
A semicolon-separated list of attribute profiles supported by the identity provider.
## Syntax
```text
def get_identity_provider_metadata_supported_attribute_profiles() -> str: ...
identity_provider_metadata_supported_attribute_profiles = property(get_identity_provider_metadata_supported_attribute_profiles, None)
```
## Default Value
""
## Remarks
A semicolon-separated list of attribute profiles supported by the identity provider.
Some common attribute profiles are:
- *urn:oasis:names:tc:SAML:2.0:profiles:attribute:basic*
- *urn:oasis:names:tc:SAML:2.0:profiles:attribute:X500*
- *urn:oasis:names:tc:SAML:2.0:profiles:attribute:UUID*
- *urn:oasis:names:tc:SAML:2.0:profiles:attribute:DCE*
- *urn:oasis:names:tc:SAML:2.0:profiles:attribute:XACML*
This property is read-only.
# identity_provider_metadata_supported_attributes property
A semicolon-separated list of attributes supported by the identity provider as presented by the Identity Provider's metadata document.
## Syntax
```text
def get_identity_provider_metadata_supported_attributes() -> str: ...
identity_provider_metadata_supported_attributes = property(get_identity_provider_metadata_supported_attributes, None)
```
## Default Value
""
## Remarks
A semicolon-separated list of attributes supported by the identity provider as presented by the Identity Provider's metadata document. This is a list of attributes that are explicitly supported by the Identity Provider but is not a full list of all the supported attributes. The list will contain the *Name* of each attribute found in the *IDPSSODescriptor* element.
This property is read-only.
# identity_provider_metadata_supported_name_id_formats property
The name identifier formats supported by the identity provider if provided by the metadata document.
## Syntax
```text
def get_identity_provider_metadata_supported_name_id_formats() -> str: ...
identity_provider_metadata_supported_name_id_formats = property(get_identity_provider_metadata_supported_name_id_formats, None)
```
## Default Value
""
## Remarks
The name identifier formats supported by the identity provider if provided by the metadata document. Some common values are:
- *Unspecified* - *urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified*
- *Email Address* - *urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress*
- *Windows Domain Qualified Name* - *urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName*
This property is read-only.
# identity_provider_signing_cert_effective_date property
The date on which this certificate becomes valid.
## Syntax
```text
def get_identity_provider_signing_cert_effective_date() -> str: ...
identity_provider_signing_cert_effective_date = property(get_identity_provider_signing_cert_effective_date, None)
```
## Default Value
""
## Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
# identity_provider_signing_cert_encoded property
The certificate (PEM/Base64 encoded).
## Syntax
```text
def get_identity_provider_signing_cert_encoded() -> bytes: ...
def set_identity_provider_signing_cert_encoded(value: bytes) -> None: ...
identity_provider_signing_cert_encoded = property(get_identity_provider_signing_cert_encoded, set_identity_provider_signing_cert_encoded)
```
## Default Value
""
## Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [identity_provider_signing_cert_store](#identity_provider_signing_cert_store-property) and [identity_provider_signing_cert_subject](#identity_provider_signing_cert_subject-property) properties also may be used to specify a certificate.
When [identity_provider_signing_cert_encoded](#identity_provider_signing_cert_encoded-property) is set, a search is initiated in the current [identity_provider_signing_cert_store](#identity_provider_signing_cert_store-property) for the private key of the certificate. If the key is found, [identity_provider_signing_cert_subject](#identity_provider_signing_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [identity_provider_signing_cert_subject](#identity_provider_signing_cert_subject-property) is set to an empty string.
# identity_provider_signing_cert_expiration_date property
The date on which the certificate expires.
## Syntax
```text
def get_identity_provider_signing_cert_expiration_date() -> str: ...
identity_provider_signing_cert_expiration_date = property(get_identity_provider_signing_cert_expiration_date, None)
```
## Default Value
""
## Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
# identity_provider_signing_cert_extended_key_usage property
A comma-delimited list of extended key usage identifiers.
## Syntax
```text
def get_identity_provider_signing_cert_extended_key_usage() -> str: ...
identity_provider_signing_cert_extended_key_usage = property(get_identity_provider_signing_cert_extended_key_usage, None)
```
## Default Value
""
## Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
# identity_provider_signing_cert_fingerprint property
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
## Syntax
```text
def get_identity_provider_signing_cert_fingerprint() -> str: ...
identity_provider_signing_cert_fingerprint = property(get_identity_provider_signing_cert_fingerprint, None)
```
## Default Value
""
## Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02*
This property is read-only.
# identity_provider_signing_cert_fingerprint_sha1 property
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
## Syntax
```text
def get_identity_provider_signing_cert_fingerprint_sha1() -> str: ...
identity_provider_signing_cert_fingerprint_sha1 = property(get_identity_provider_signing_cert_fingerprint_sha1, None)
```
## Default Value
""
## Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84*
This property is read-only.
# identity_provider_signing_cert_fingerprint_sha256 property
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
## Syntax
```text
def get_identity_provider_signing_cert_fingerprint_sha256() -> str: ...
identity_provider_signing_cert_fingerprint_sha256 = property(get_identity_provider_signing_cert_fingerprint_sha256, None)
```
## Default Value
""
## Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53*
This property is read-only.
# identity_provider_signing_cert_issuer property
The issuer of the certificate.
## Syntax
```text
def get_identity_provider_signing_cert_issuer() -> str: ...
identity_provider_signing_cert_issuer = property(get_identity_provider_signing_cert_issuer, None)
```
## Default Value
""
## Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
# identity_provider_signing_cert_private_key property
The private key of the certificate (if available).
## Syntax
```text
def get_identity_provider_signing_cert_private_key() -> str: ...
identity_provider_signing_cert_private_key = property(get_identity_provider_signing_cert_private_key, None)
```
## Default Value
""
## Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
NOTE: The [identity_provider_signing_cert_private_key](#identity_provider_signing_cert_private_key-property) may be available but not exportable. In this case, [identity_provider_signing_cert_private_key](#identity_provider_signing_cert_private_key-property) returns an empty string.
This property is read-only.
# identity_provider_signing_cert_private_key_available property
Whether a PrivateKey is available for the selected certificate.
## Syntax
```text
def get_identity_provider_signing_cert_private_key_available() -> bool: ...
identity_provider_signing_cert_private_key_available = property(get_identity_provider_signing_cert_private_key_available, None)
```
## Default Value
FALSE
## Remarks
Whether a [identity_provider_signing_cert_private_key](#identity_provider_signing_cert_private_key-property) is available for the selected certificate. If [identity_provider_signing_cert_private_key_available](#identity_provider_signing_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
# identity_provider_signing_cert_private_key_container property
The name of the PrivateKey container for the certificate (if available).
## Syntax
```text
def get_identity_provider_signing_cert_private_key_container() -> str: ...
identity_provider_signing_cert_private_key_container = property(get_identity_provider_signing_cert_private_key_container, None)
```
## Default Value
""
## Remarks
The name of the [identity_provider_signing_cert_private_key](#identity_provider_signing_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
# identity_provider_signing_cert_public_key property
The public key of the certificate.
## Syntax
```text
def get_identity_provider_signing_cert_public_key() -> str: ...
identity_provider_signing_cert_public_key = property(get_identity_provider_signing_cert_public_key, None)
```
## Default Value
""
## Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
# identity_provider_signing_cert_public_key_algorithm property
The textual description of the certificate's public key algorithm.
## Syntax
```text
def get_identity_provider_signing_cert_public_key_algorithm() -> str: ...
identity_provider_signing_cert_public_key_algorithm = property(get_identity_provider_signing_cert_public_key_algorithm, None)
```
## Default Value
""
## Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
# identity_provider_signing_cert_public_key_length property
The length of the certificate's public key (in bits).
## Syntax
```text
def get_identity_provider_signing_cert_public_key_length() -> int: ...
identity_provider_signing_cert_public_key_length = property(get_identity_provider_signing_cert_public_key_length, None)
```
## Default Value
0
## Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
# identity_provider_signing_cert_serial_number property
The serial number of the certificate encoded as a string.
## Syntax
```text
def get_identity_provider_signing_cert_serial_number() -> str: ...
identity_provider_signing_cert_serial_number = property(get_identity_provider_signing_cert_serial_number, None)
```
## Default Value
""
## Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
# identity_provider_signing_cert_signature_algorithm property
The text description of the certificate's signature algorithm.
## Syntax
```text
def get_identity_provider_signing_cert_signature_algorithm() -> str: ...
identity_provider_signing_cert_signature_algorithm = property(get_identity_provider_signing_cert_signature_algorithm, None)
```
## Default Value
""
## Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
# identity_provider_signing_cert_store property
The name of the certificate store for the client certificate.
## Syntax
```text
def get_identity_provider_signing_cert_store() -> bytes: ...
def set_identity_provider_signing_cert_store(value: bytes) -> None: ...
identity_provider_signing_cert_store = property(get_identity_provider_signing_cert_store, set_identity_provider_signing_cert_store)
```
## Default Value
"MY"
## Remarks
The name of the certificate store for the client certificate.
The [identity_provider_signing_cert_store_type](#identity_provider_signing_cert_store_type-property) property denotes the type of the certificate store specified by [identity_provider_signing_cert_store](#identity_provider_signing_cert_store-property). If the store is password-protected, specify the password in [identity_provider_signing_cert_store_password](#identity_provider_signing_cert_store_password-property).
[identity_provider_signing_cert_store](#identity_provider_signing_cert_store-property) is used in conjunction with the [identity_provider_signing_cert_subject](#identity_provider_signing_cert_subject-property) property to specify client certificates. If [identity_provider_signing_cert_store](#identity_provider_signing_cert_store-property) has a value, and [identity_provider_signing_cert_subject](#identity_provider_signing_cert_subject-property) or [identity_provider_signing_cert_encoded](#identity_provider_signing_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [identity_provider_signing_cert_subject](#identity_provider_signing_cert_subject-property) 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).
# identity_provider_signing_cert_store_password property
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
## Syntax
```text
def get_identity_provider_signing_cert_store_password() -> str: ...
def set_identity_provider_signing_cert_store_password(value: str) -> None: ...
identity_provider_signing_cert_store_password = property(get_identity_provider_signing_cert_store_password, set_identity_provider_signing_cert_store_password)
```
## Default Value
""
## Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
# identity_provider_signing_cert_store_type property
The type of certificate store for this certificate.
## Syntax
```text
def get_identity_provider_signing_cert_store_type() -> int: ...
def set_identity_provider_signing_cert_store_type(value: int) -> None: ...
identity_provider_signing_cert_store_type = property(get_identity_provider_signing_cert_store_type, set_identity_provider_signing_cert_store_type)
```
## Possible Values
```text
0 # User1 # Machine2 # PFXFile3 # PFXBlob4 # JKSFile5 # JKSBlob6 # PEMKeyFile7 # PEMKeyBlob8 # PublicKeyFile9 # PublicKeyBlob10 # SSHPublicKeyBlob11 # P7BFile12 # P7BBlob13 # SSHPublicKeyFile14 # PPKFile15 # PPKBlob16 # XMLFile17 # XMLBlob18 # JWKFile19 # JWKBlob20 # SecurityKey21 # BCFKSFile22 # BCFKSBlob23 # PKCS1199 # Auto
```
## Default Value
0
## Remarks
The type of certificate store for this certificate.
The 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:
```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
@"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
"123456", // PIN
"CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```
```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```
| | |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [identity_provider_signing_cert_store_type](#identity_provider_signing_cert_store_type-property), the full path of the PKCS#11 DLL as the [identity_provider_signing_cert_store](#identity_provider_signing_cert_store-property), and the PIN as the [identity_provider_signing_cert_store_password](#identity_provider_signing_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [identity_provider_signing_cert_store](#identity_provider_signing_cert_store-property) and set [identity_provider_signing_cert_store_password](#identity_provider_signing_cert_store_password-property) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
# identity_provider_signing_cert_subject property
The subject of the certificate used for client authentication.
## Syntax
```text
def get_identity_provider_signing_cert_subject() -> str: ...
def set_identity_provider_signing_cert_subject(value: str) -> None: ...
identity_provider_signing_cert_subject = property(get_identity_provider_signing_cert_subject, set_identity_provider_signing_cert_subject)
```
## Default Value
""
## Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:
| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
# identity_provider_signing_cert_subject_alt_names property
Comma-separated lists of alternative subject names for the certificate.
## Syntax
```text
def get_identity_provider_signing_cert_subject_alt_names() -> str: ...
identity_provider_signing_cert_subject_alt_names = property(get_identity_provider_signing_cert_subject_alt_names, None)
```
## Default Value
""
## Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
# identity_provider_signing_cert_thumbprint_md5 property
The MD5 hash of the certificate.
## Syntax
```text
def get_identity_provider_signing_cert_thumbprint_md5() -> str: ...
identity_provider_signing_cert_thumbprint_md5 = property(get_identity_provider_signing_cert_thumbprint_md5, None)
```
## Default Value
""
## Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
# identity_provider_signing_cert_thumbprint_sha1 property
The SHA-1 hash of the certificate.
## Syntax
```text
def get_identity_provider_signing_cert_thumbprint_sha1() -> str: ...
identity_provider_signing_cert_thumbprint_sha1 = property(get_identity_provider_signing_cert_thumbprint_sha1, None)
```
## Default Value
""
## Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
# identity_provider_signing_cert_thumbprint_sha256 property
The SHA-256 hash of the certificate.
## Syntax
```text
def get_identity_provider_signing_cert_thumbprint_sha256() -> str: ...
identity_provider_signing_cert_thumbprint_sha256 = property(get_identity_provider_signing_cert_thumbprint_sha256, None)
```
## Default Value
""
## Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
# identity_provider_signing_cert_usage property
The text description of UsageFlags .
## Syntax
```text
def get_identity_provider_signing_cert_usage() -> str: ...
identity_provider_signing_cert_usage = property(get_identity_provider_signing_cert_usage, None)
```
## Default Value
""
## Remarks
The text description of [identity_provider_signing_cert_usage_flags](#identity_provider_signing_cert_usage_flags-property).
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
# identity_provider_signing_cert_usage_flags property
The flags that show intended use for the certificate.
## Syntax
```text
def get_identity_provider_signing_cert_usage_flags() -> int: ...
identity_provider_signing_cert_usage_flags = property(get_identity_provider_signing_cert_usage_flags, None)
```
## Default Value
0
## Remarks
The flags that show intended use for the certificate. The value of [identity_provider_signing_cert_usage_flags](#identity_provider_signing_cert_usage_flags-property) 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 [identity_provider_signing_cert_usage](#identity_provider_signing_cert_usage-property) property for a text representation of [identity_provider_signing_cert_usage_flags](#identity_provider_signing_cert_usage_flags-property).
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
# identity_provider_signing_cert_version property
The certificate's version number.
## Syntax
```text
def get_identity_provider_signing_cert_version() -> str: ...
identity_provider_signing_cert_version = property(get_identity_provider_signing_cert_version, None)
```
## Default Value
""
## Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
# identity_provider_uri_count property
The number of records in the IdentityProviderURI arrays.
## Syntax
```text
def get_identity_provider_uri_count() -> int: ...
def set_identity_provider_uri_count(value: int) -> None: ...
identity_provider_uri_count = property(get_identity_provider_uri_count, set_identity_provider_uri_count)
```
## Default Value
0
## Remarks
This property controls the size of the following arrays:
- [identity_provider_uri_binding_ref](#identity_provider_uri_binding_ref-property)
- [identity_provider_uri_binding_type](#identity_provider_uri_binding_type-property)
- [identity_provider_uri_index](#identity_provider_uri_index-property)
- [identity_provider_uri_is_default](#identity_provider_uri_is_default-property)
- [identity_provider_uri_location](#identity_provider_uri_location-property)
- [identity_provider_uri_type](#identity_provider_uri_type-property)
The array indices start at *0* and end at *identity_provider_uri_count - 1*.
# identity_provider_uri_binding_ref property
The URI reference for the set BindingType .
## Syntax
```text
def get_identity_provider_uri_binding_ref(identity_provider_uri_idx: int) -> str: ...
def set_identity_provider_uri_binding_ref(identity_provider_uri_idx: int, value: str) -> None: ...
```
## Default Value
"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"
## Remarks
The URI reference for the set [identity_provider_uri_binding_type](#identity_provider_uri_binding_type-property). When the [identity_provider_uri_binding_type](#identity_provider_uri_binding_type-property) is set, this property will be updated to match. The exception is the *subCustom* value, which allows for any value to be placed in this property.
If this property is set instead, the class will attempt to set the [identity_provider_uri_binding_type](#identity_provider_uri_binding_type-property) property to match. If it can't, *subCustom* will also be used.
When parsing a metadata document, the class will also use the *subCustom* value for any binding types that are not recognized by the class.
The *identity_provider_uri_idx* parameter specifies the index of the item in the array. The size of the array is controlled by the [identity_provider_uri_count](#identity_provider_uri_count-property) property.
# identity_provider_uri_binding_type property
The type of binding that is supported for this URI.
## Syntax
```text
def get_identity_provider_uri_binding_type(identity_provider_uri_idx: int) -> int: ...
def set_identity_provider_uri_binding_type(identity_provider_uri_idx: int, value: int) -> None: ...
```
## Possible Values
```text
0 # Redirect1 # Post2 # Artifact3 # Custom
```
## Default Value
0
## Remarks
The type of binding that is supported for this URI. The class only supports using the *HTTP Redirect* and *HTTP POST* bindings. The *HTTP Artifact* and other bindings are informational, and support for them must be implemented directly.
When setting this property, the [identity_provider_uri_binding_ref](#identity_provider_uri_binding_ref-property) property will also be updated with the matching URI. The exception is the *subCustom* value, which allows for any value to be placed in the [identity_provider_uri_binding_ref](#identity_provider_uri_binding_ref-property) property.
If the [identity_provider_uri_binding_ref](#identity_provider_uri_binding_ref-property) property is set, during the processing of a metadata document the class will attempt to set this property as well with the matching value. If it can't, *subCustom* will be used instead.
| Value | Binding Name | Identifier URI |
| --- | --- | --- |
| 00 (subRedirect - default) | HTTP Redirect | urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect |
| 01 (subPost) | HTTP POST | urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST |
| 02 (subArtifact - unsupported) | HTTP Artifact | urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Artifact |
| 99 (subCustom) | Custom Format | N/A |
The *identity_provider_uri_idx* parameter specifies the index of the item in the array. The size of the array is controlled by the [identity_provider_uri_count](#identity_provider_uri_count-property) property.
# identity_provider_uri_index property
The index for the URI that can be optionally used if multiple URIs of the same URIType and BindingType are provided.
## Syntax
```text
def get_identity_provider_uri_index(identity_provider_uri_idx: int) -> int: ...
def set_identity_provider_uri_index(identity_provider_uri_idx: int, value: int) -> None: ...
```
## Default Value
0
## Remarks
The index for the URI that can be optionally used if multiple URIs of the same [identity_provider_uriuri_type](#SAMLDesktop_p_IdentityProviderURIURIType) and [identity_provider_uri_binding_type](#identity_provider_uri_binding_type-property) are provided.
The *identity_provider_uri_idx* parameter specifies the index of the item in the array. The size of the array is controlled by the [identity_provider_uri_count](#identity_provider_uri_count-property) property.
# identity_provider_uri_is_default property
Whether this URI is the default URI that should be used for the specific URIType and BindingType combination.
## Syntax
```text
def get_identity_provider_uri_is_default(identity_provider_uri_idx: int) -> bool: ...
def set_identity_provider_uri_is_default(identity_provider_uri_idx: int, value: bool) -> None: ...
```
## Default Value
FALSE
## Remarks
Whether this URI is the default URI that should be used for the specific [identity_provider_uriuri_type](#SAMLDesktop_p_IdentityProviderURIURIType) and [identity_provider_uri_binding_type](#identity_provider_uri_binding_type-property) combination.
The *identity_provider_uri_idx* parameter specifies the index of the item in the array. The size of the array is controlled by the [identity_provider_uri_count](#identity_provider_uri_count-property) property.
# identity_provider_uri_location property
The address of the URI.
## Syntax
```text
def get_identity_provider_uri_location(identity_provider_uri_idx: int) -> str: ...
def set_identity_provider_uri_location(identity_provider_uri_idx: int, value: str) -> None: ...
```
## Default Value
""
## Remarks
The address of the URI.
The *identity_provider_uri_idx* parameter specifies the index of the item in the array. The size of the array is controlled by the [identity_provider_uri_count](#identity_provider_uri_count-property) property.
# identity_provider_uri_type property
The purpose of the URI.
## Syntax
```text
def get_identity_provider_uri_type(identity_provider_uri_idx: int) -> int: ...
def set_identity_provider_uri_type(identity_provider_uri_idx: int, value: int) -> None: ...
```
## Possible Values
```text
0 # Signon1 # Logout2 # ACS
```
## Default Value
0
## Remarks
The purpose of the URI.
Possible values are:
| | | |
| --- | --- | --- |
| 0 (sutSignon - default) | Identity Provider | Single Sign-on URI |
| 1 (sutLogout) | Both | Logout URI |
| 2 (sutACS) | Service Provider | Assertion Consumer Service |
The *identity_provider_uri_idx* parameter specifies the index of the item in the array. The size of the array is controlled by the [identity_provider_uri_count](#identity_provider_uri_count-property) property.
# proxy_auth_scheme property
The type of authorization to perform when connecting to the proxy.
## Syntax
```text
def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...
proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)
```
## Possible Values
```text
0 # Basic1 # Digest2 # Proprietary3 # None4 # Ntlm5 # Negotiate
```
## Default Value
0
## Remarks
The type of authorization to perform when connecting to the proxy. This is used only when the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are set.
[proxy_auth_scheme](#proxy_auth_scheme-property) should be set to authNone (3) when no authentication is expected.
By default, [proxy_auth_scheme](#proxy_auth_scheme-property) is authBasic (0), and if the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are set, the class will attempt basic authentication.
If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to authDigest (1), digest authentication will be attempted instead.
If [proxy_auth_scheme](#proxy_auth_scheme-property) 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 [proxy_auth_scheme](#proxy_auth_scheme-property) is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property).
# proxy_auto_detect property
Whether to automatically detect and use proxy system settings, if available.
## Syntax
```text
def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...
proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)
```
## Default Value
FALSE
## Remarks
Whether to automatically detect and use proxy system settings, if available. The default value is *False*.
# proxy_password property
A password if authentication is to be used for the proxy.
## Syntax
```text
def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...
proxy_password = property(get_proxy_password, set_proxy_password)
```
## Default Value
""
## Remarks
A password if authentication is to be used for the proxy.
If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to Basic Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*.
If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to Digest Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are used to respond to the Digest Authentication challenge from the server.
If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to NTLM Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are used to authenticate through NTLM negotiation.
# proxy_port property
The Transmission Control Protocol (TCP) port for the proxy Server (default 80).
## Syntax
```text
def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...
proxy_port = property(get_proxy_port, set_proxy_port)
```
## Default Value
80
## Remarks
The Transmission Control Protocol (TCP) port for the proxy [proxy_server](#proxy_server-property) (default 80). See the description of the [proxy_server](#proxy_server-property) property for details.
# proxy_server property
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
## Syntax
```text
def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...
proxy_server = property(get_proxy_server, set_proxy_server)
```
## Default Value
""
## Remarks
If a proxy [proxy_server](#proxy_server-property) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the [proxy_server](#proxy_server-property) property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [proxy_server](#proxy_server-property) property is set to the corresponding address. If the search is not successful, an error is returned.
# proxy_ssl property
When to use a Secure Sockets Layer (SSL) for the connection to the proxy.
## Syntax
```text
def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...
proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)
```
## Possible Values
```text
0 # Automatic1 # Always2 # Never3 # Tunnel
```
## Default Value
0
## Remarks
When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
| | |
| --- | --- |
| psAutomatic (0) | Default setting. If the URL is an https URL, the 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. |
# proxy_user property
A username if authentication is to be used for the proxy.
## Syntax
```text
def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...
proxy_user = property(get_proxy_user, set_proxy_user)
```
## Default Value
""
## Remarks
A username if authentication is to be used for the proxy.
If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to Basic Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*.
If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to Digest Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are used to respond to the Digest Authentication challenge from the server.
If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to NTLM Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are used to authenticate through NTLM negotiation.
# relay_state property
The RelayState for a SAML request or response.
## Syntax
```text
def get_relay_state() -> str: ...
def set_relay_state(value: str) -> None: ...
relay_state = property(get_relay_state, set_relay_state)
```
## Default Value
""
## Remarks
When set before building a request using the [authenticate_user](#authenticate_user-method) method, this property will set the *RelayState* parameter that is provided **with** the SAML request. Any value may be specified here and it will be returned exactly as it was sent. This can be used to maintain state within the application, and also may be used for security purposes. The contents of this property are treated as an opaque value.
After receiving the response from the Identity Provider, this setting will then be set to match the *RelayState* parameter if it was provided by the Identity Provider. This does not work if the SAML response was provided directly to the methods using the saml_response_info property.
# return_url property
The URL where the user (browser) returns after authenticating with the Identity Provider.
## Syntax
```text
def get_return_url() -> str: ...
def set_return_url(value: str) -> None: ...
return_url = property(get_return_url, set_return_url)
```
## Default Value
""
## Remarks
Typically this property will be automatically set by the component when calling [authenticate_user](#authenticate_user-method) or [build_service_metadata](#build_service_metadata-method) based on how the [web_server_bindings](#web_server_bindings-property), [web_server_port](#web_server_port-property), and [web_server_ssl_enabled](#web_server_ssl_enabled-property) properties are configured. Additionally, the [WebServerHost](#WebServerHost) configuration setting can be specify the domain which is *localhost* by default. For example, some service prefer the use of *127.0.0.1*.
When manually validating a SAML response or assertion, this setting will need to be set for validation to succeeded.
Can be set to override the URL that is provided in the authenticate request or metadata if needed. For example, if using a relay server to pass information from the Identity Provider to the application, return_url should be set to the location of the relay server. The relay server should then pass the information to the embedded web server.
# saml_request_allow_create property
This setting is only used for authentication requests.
## Syntax
```text
def get_saml_request_allow_create() -> bool: ...
def set_saml_request_allow_create(value: bool) -> None: ...
saml_request_allow_create = property(get_saml_request_allow_create, set_saml_request_allow_create)
```
## Default Value
FALSE
## Remarks
This setting is **only** used for authentication requests. It controls whether the class will set the *AllowCreate* attribute in the *NameIDPolicy* element that is specific to the *AuthnRequest* element. When set to *True*, this will inform the Identity Provider that it is allowed to create a new identifier to represent the principal. When set to *False* (default), the Identity Provider should only issue an assertion if an acceptable identifier is already created.
# saml_request_binding property
This setting controls the binding that will be used to make the request.
## Syntax
```text
def get_saml_request_binding() -> int: ...
def set_saml_request_binding(value: int) -> None: ...
saml_request_binding = property(get_saml_request_binding, set_saml_request_binding)
```
## Possible Values
```text
0 # HTTPRedirect1 # HTTPPost
```
## Default Value
0
## Remarks
This setting controls the binding that will be used to make the request.
By default, the class will use the *sbHTTPRedirect* binding which provides the *SAMLRequest* value through a query parameter. The *sbHTTPRedirect* binding will set just the [saml_request_url](#SAML_p_SAMLRequestURL) property.
If set to the *sbHTTPPost* binding, the *SAMLRequest* value is provided in an HTML body that should be used to make a form post request. This will set both the [saml_request_url](#SAML_p_SAMLRequestURL) and [saml_request_body](#SAML_p_SAMLRequestBody) properties.
| Value | BindingName | Binding URI |
| --- | --- | --- |
| 0 (sbHTTPRedirect - default) | HTTP Redirect Binding | urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect |
| 1 (sbHTTPPost) | HTTP Post Binding | urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST |
**Note**: This setting does not control the binding of the response, just how the request will be made.
# saml_request_consent property
This setting specifies whether consent from a principal was provided when this request was sent.
## Syntax
```text
def get_saml_request_consent() -> int: ...
def set_saml_request_consent(value: int) -> None: ...
saml_request_consent = property(get_saml_request_consent, set_saml_request_consent)
```
## Possible Values
```text
0 # Unspecified1 # Obtained2 # Prior3 # Implicit4 # Explicit5 # Unavailable6 # Inapplicable7 # Custom
```
## Default Value
0
## Remarks
This setting specifies whether consent from a principal was provided when this request was sent. This typically is set to some URI reference that was used by the application to obtain consent from the principal (user). This setting specifically sets the Consent attribute in the *AuthnRequest* or *LogoutRequest* elements in a SAML request.
By default, the *scidUnspecified* value is used. If a format needs to be used that is not listed here, the *snidCustom* value can be used instead. When set, the [CustomConsent](#CustomConsent) configuration setting will be used instead.
| Value | Consent Id Name | Identifier URI |
| --- | --- | --- |
| 00 (scidUnspecified - default) | Unspecified | urn:oasis:names:tc:SAML:2.0:consent:unspecified |
| 01 (scidObtained) | Obtained | urn:oasis:names:tc:SAML:2.0:consent:obtained |
| 02 (scidPrior) | Prior | urn:oasis:names:tc:SAML:2.0:consent:prior |
| 03 (scidImplicit) | Implicit | urn:oasis:names:tc:SAML:2.0:consent:current-implicit |
| 04 (scidExplicit) | Explicit | urn:oasis:names:tc:SAML:2.0:consent:current-explicit |
| 05 (scidUnavailable) | Unavailable | urn:oasis:names:tc:SAML:2.0:consent:unavailable |
| 06 (scidInapplicable) | Inapplicable | urn:oasis:names:tc:SAML:2.0:consent:inapplicable |
| 99 (scidCustom) | Custom Format | N/A |
# saml_request_destination property
This setting specifies a URI reference for the intended destination for the SAML request.
## Syntax
```text
def get_saml_request_destination() -> str: ...
def set_saml_request_destination(value: str) -> None: ...
saml_request_destination = property(get_saml_request_destination, set_saml_request_destination)
```
## Default Value
""
## Remarks
This setting specifies a URI reference for the intended destination for the SAML request. This is useful to prevent malicious forwarding of responses to unintended recipients. If left blank the class will set this to match the endpoint selected by the class. See [saml_request_use_default_endpoint](#saml_request_use_default_endpoint-property) and [saml_request_selected_endpoint](#saml_request_selected_endpoint-property) for more information.
# saml_request_id property
This setting specifies the unique Id of the SAML request.
## Syntax
```text
def get_saml_request_id() -> str: ...
def set_saml_request_id(value: str) -> None: ...
saml_request_id = property(get_saml_request_id, set_saml_request_id)
```
## Default Value
""
## Remarks
This setting specifies the unique Id of the SAML request.
When building a SAML request using the [build_authn_request](#SAML_m_BuildAuthnRequest) or [build_logout_request](#SAML_m_BuildLogoutRequest) methods, the class will use this value for the *Id* attribute in the request. If left empty before building the request, the class will generate a new one.
When validating a SAML response or assertion, this property is used to provide the Id of the request to the class. The SAML response and assertion both have an *InResponseTo* attribute that needs to match this property. See [saml_request_in_response_to](#SAMLDesktop_p_SAMLRequestInResponseTo) for more information. This is important, to check to ensure that the SAML response or assertion was in response to a request that was made by this application.
Due to needing the value for validation purposes this setting, (along with the [saml_request_issuer](#SAMLWeb_p_SAMLRequestIssuer) property) should be cached in a secure location for later. This Id should match the Id of the *InResponseTo* attribute of the matching SAMLResponse . Due to this, after [build_authn_request](#SAML_m_BuildAuthnRequest) or [build_logout_request](#SAML_m_BuildLogoutRequest) is used to create a request, this setting
# saml_request_issued_time property
This setting sets the time at which the SAML request was issued.
## Syntax
```text
def get_saml_request_issued_time() -> str: ...
def set_saml_request_issued_time(value: str) -> None: ...
saml_request_issued_time = property(get_saml_request_issued_time, set_saml_request_issued_time)
```
## Default Value
""
## Remarks
This setting sets the time at which the SAML request was issued. If not set, the class will use the current time.
Time-based values are specified by the SAML specification to be in UTC in the following format: *YYYY-MM-DDTHH:mm:ss.sssZ*
# saml_request_issuer property
The issuer for the SAML request.
## Syntax
```text
def get_saml_request_issuer() -> str: ...
def set_saml_request_issuer(value: str) -> None: ...
saml_request_issuer = property(get_saml_request_issuer, set_saml_request_issuer)
```
## Default Value
""
## Remarks
The issuer for the SAML request. Typically, this should be set to the Entity Id configured for the Identity Provider.
# saml_request_name_id_format property
This setting is only used for authentication requests.
## Syntax
```text
def get_saml_request_name_id_format() -> int: ...
def set_saml_request_name_id_format(value: int) -> None: ...
saml_request_name_id_format = property(get_saml_request_name_id_format, set_saml_request_name_id_format)
```
## Possible Values
```text
0 # Unspecified1 # Email2 # X5093 # WindowsDQ4 # Kerberos5 # Entity6 # Persistent7 # Transient8 # Custom
```
## Default Value
0
## Remarks
This setting is **only** used for authentication requests. If supported by the Identity Provider, this setting can be used to tailor the name identifier for the subject in the response to an authentication request.
By default, the *snidUnspecified* format will be used, which informs the Identity Provider to use whatever name identifier format they prefer. This setting specifically sets the Format attribute in the *NameIDPolicy* element in an authentication request. If a format needs to be used that is not listed here, the *snidCustom* value can be used instead. When set, the [CustomNameIdFormat](#CustomNameIdFormat) configuration setting will be used instead.
| Value | Format Name | Format URI |
| --- | --- | --- |
| 00 (snidUnspecified - default) | Unspecified | urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified |
| 01 (snidEmail) | Email Address | urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress |
| 02 (snidX509) | X.509 Subject Name | urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName |
| 03 (snidWindowsDQ) | Windows Domain Qualified Name | urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName |
| 04 (snidKerberos) | Kerberos Principal Name | urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos |
| 05 (snidEntity) | Entity Identifier | urn:oasis:names:tc:SAML:2.0:nameid-format:entity |
| 06 (snidPersistent) | Persistent Identifier | urn:oasis:names:tc:SAML:2.0:nameid-format:persistent |
| 07 (snidTransient) | Transient Identifier | urn:oasis:names:tc:SAML:2.0:nameid-format:transient |
| 99 (snidCustom) | Custom Format | N/A |
# saml_request_selected_endpoint property
This setting only applies to Authn Requests since there can be multiple Assertion Consumer Service (ACS) endpoints per service provider.
## Syntax
```text
def get_saml_request_selected_endpoint() -> int: ...
def set_saml_request_selected_endpoint(value: int) -> None: ...
saml_request_selected_endpoint = property(get_saml_request_selected_endpoint, set_saml_request_selected_endpoint)
```
## Default Value
-1
## Remarks
This setting **only** applies to Authn Requests since there can be multiple Assertion Consumer Service (ACS) endpoints per service provider. When building an Authn Request, the class will select the the ACS endpoint depending on how [saml_request_settings](#SAML_p_SAMLRequestSettings) is configured. If [saml_request_use_default_endpoint](#SAMLWeb_p_SAMLRequestUseDefaultEndpoint) is set to *True*, the request will specify that the Identity Provider should use the URI that is configured as the default. If [saml_request_selected_endpoint](#SAMLWeb_p_SAMLRequestSelectedEndpoint) is set, the class will use that index in the request. Otherwise, the class will select the first URI available in the [service_provider_ur_is](#SAML_p_ServiceProviderURIs) properties.
# saml_request_session_index property
This setting only applies when building SAML logout requests.
## Syntax
```text
def get_saml_request_session_index() -> str: ...
def set_saml_request_session_index(value: str) -> None: ...
saml_request_session_index = property(get_saml_request_session_index, set_saml_request_session_index)
```
## Default Value
""
## Remarks
This setting **only** applies when building SAML logout requests. [saml_request_session_index](#saml_request_session_index-property) identifies the current session of the user that is being ended when the [build_logout_request](#SAML_m_BuildLogoutRequest) method is called. When the [process_saml_response](#SAML_m_ProcessSAMLResponse) or [parse_assertion](#SAML_m_ParseAssertion) methods are called, the [saml_request_session_index](#saml_request_session_index-property) property will be set to the session index from the Identity Provider. Providing the session index with the logout request will typically cause the Identity Provider to send logout requests to all participating services that are also part of the session.
# saml_request_sign_request property
This setting controls whether the SAML request should be signed when using the BuildAuthnRequest or BuildLogoutRequest methods.
## Syntax
```text
def get_saml_request_sign_request() -> bool: ...
def set_saml_request_sign_request(value: bool) -> None: ...
saml_request_sign_request = property(get_saml_request_sign_request, set_saml_request_sign_request)
```
## Default Value
FALSE
## Remarks
This setting controls whether the SAML request should be signed when using the [build_authn_request](#SAML_m_BuildAuthnRequest) or [build_logout_request](#SAML_m_BuildLogoutRequest) methods. The class will use the certificate set in the [service_provider_signing_cert](#SAML_p_ServiceProviderSigningCert) property to sign the request.
# saml_request_use_default_endpoint property
This setting only applies to Authn Requests since there can be multiple Assertion Consumer Service (ACS) endpoints per service provider.
## Syntax
```text
def get_saml_request_use_default_endpoint() -> bool: ...
def set_saml_request_use_default_endpoint(value: bool) -> None: ...
saml_request_use_default_endpoint = property(get_saml_request_use_default_endpoint, set_saml_request_use_default_endpoint)
```
## Default Value
FALSE
## Remarks
This setting **only** applies to Authn Requests since there can be multiple Assertion Consumer Service (ACS) endpoints per service provider. When multiple ACS endpoints are available, a single endpoint can be selected as the default endpoint. When building an Authn Request, the class will select the the ACS endpoint depending on how [saml_request_settings](#SAML_p_SAMLRequestSettings) is configured. If [saml_request_use_default_endpoint](#SAMLWeb_p_SAMLRequestUseDefaultEndpoint) is set to *True*, the request will specify that the Identity Provider should use the URI that is configured as the default. If [saml_request_selected_endpoint](#SAMLWeb_p_SAMLRequestSelectedEndpoint) is set, then the class will use that index in the request. Otherwise, the class will select the first URI available in the [service_provider_ur_is](#SAML_p_ServiceProviderURIs) properties.
# saml_response_consent property
Whether consent from a principal was provided when this response was sent.
## Syntax
```text
def get_saml_response_consent() -> str: ...
saml_response_consent = property(get_saml_response_consent, None)
```
## Default Value
""
## Remarks
Whether consent from a principal was provided when this response was sent. This typically is set to some URI reference that matches the method that was used by the application to obtain consent from the principal (user).
Some common URI values are:
- Unspecified - *urn:oasis:names:tc:SAML:2.0:consent:unspecified*
- Obtained - *urn:oasis:names:tc:SAML:2.0:consent:obtained*
- Prior - *urn:oasis:names:tc:SAML:2.0:consent:prior*
- Implicit - *urn:oasis:names:tc:SAML:2.0:consent:current-implicit*
- Explicit - *urn:oasis:names:tc:SAML:2.0:consent:current-explicit*
- Unavailable - *urn:oasis:names:tc:SAML:2.0:consent:unavailable*
- Inapplicable - *urn:oasis:names:tc:SAML:2.0:consent:inapplicable*
This property is read-only.
# saml_response_content property
The full XML of the SAML response after being parsed or processed by the class.
## Syntax
```text
def get_saml_response_content() -> bytes: ...
def set_saml_response_content(value: bytes) -> None: ...
saml_response_content = property(get_saml_response_content, set_saml_response_content)
```
## Default Value
""
## Remarks
The full XML of the SAML response after being parsed or processed by the class. Optionally, this setting can be set to provide a SAML response directly to the class to be parsed or processed.
# saml_response_destination property
A URI reference for the intended destination for the SAML response.
## Syntax
```text
def get_saml_response_destination() -> str: ...
saml_response_destination = property(get_saml_response_destination, None)
```
## Default Value
""
## Remarks
A URI reference for the intended destination for the SAML response. This is useful to prevent malicious forwarding of responses to unintended recipients.
This property is read-only.
# saml_response_id property
The unique Id for the SAML response that was created by the Issuer .
## Syntax
```text
def get_saml_response_id() -> str: ...
saml_response_id = property(get_saml_response_id, None)
```
## Default Value
""
## Remarks
The unique Id for the SAML response that was created by the [saml_response_issuer](#saml_response_issuer-property).
This property is read-only.
# saml_response_in_response_to property
The Id of the SAML request that requested the Identity Provider to issue this SAML response.
## Syntax
```text
def get_saml_response_in_response_to() -> str: ...
saml_response_in_response_to = property(get_saml_response_in_response_to, None)
```
## Default Value
""
## Remarks
The Id of the SAML request that requested the Identity Provider to issue this SAML response. The class validates this property against the original Id of the SAML request which [saml_response_id](#saml_response_id-property) should be set to.
This property is read-only.
# saml_response_issued_time property
The time at which the SAML response was issued by the Issuer .
## Syntax
```text
def get_saml_response_issued_time() -> str: ...
saml_response_issued_time = property(get_saml_response_issued_time, None)
```
## Default Value
""
## Remarks
The time at which the SAML response was issued by the [saml_response_issuer](#saml_response_issuer-property).
Time-based values are specified by the SAML specification to be in UTC in the following format: *YYYY-MM-DDTHH:mm:ss.sssZ*
This property is read-only.
# saml_response_issuer property
The Entity Id of the issuer of the SAML response.
## Syntax
```text
def get_saml_response_issuer() -> str: ...
saml_response_issuer = property(get_saml_response_issuer, None)
```
## Default Value
""
## Remarks
The Entity Id of the issuer of the SAML response. Typically, this will be the [saml_response_entity_id](#SAMLDesktop_p_SAMLResponseEntityId) of the Identity Provider.
This property is read-only.
# saml_response_signed property
Whether the SAML response is signed.
## Syntax
```text
def get_saml_response_signed() -> bool: ...
saml_response_signed = property(get_saml_response_signed, None)
```
## Default Value
FALSE
## Remarks
Whether the SAML response is signed. If the SAML response contains no signatures, or only the assertion is signed, then this property will be set to *False*.
This property is read-only.
# saml_response_status_codes property
A semicolon-separated list of status codes found in the SAML response.
## Syntax
```text
def get_saml_response_status_codes() -> str: ...
saml_response_status_codes = property(get_saml_response_status_codes, None)
```
## Default Value
""
## Remarks
A semicolon-separated list of status codes found in the SAML response. A compliant SAML response will always contain a top-level response with one of the following values.
| | |
| --- | --- |
| urn:oasis:names:tc:SAML:2.0:status:Success | Success |
| urn:oasis:names:tc:SAML:2.0:status:Requester | The original request could not be performed due to an issue from the requester. |
| urn:oasis:names:tc:SAML:2.0:status:Responder | The original request could not be performed due to an issue from the issuer. |
| urn:oasis:names:tc:SAML:2.0:status:VersionMismatch | The original request could not be processed due to a SAML version mismatch in the request.. |
After the top-level status code, second-level codes can also be included to provide additional information about the top-level status code. These second-level codes are also typically a URI reference like the top-level codes. For example, if the Identity Provider was unable to authenticate the user, this setting could be set to:
*urn:oasis:names:tc:SAML:2.0:status:Responder;urn:oasis:names:tc:SAML:2.0:status:AuthnFailed*
Sometimes, a message is also provided with the Status. See [saml_response_status_message](#saml_response_status_message-property) for more information.
This property is read-only.
# saml_response_status_message property
The message that was provided in the status of the SAML response.
## Syntax
```text
def get_saml_response_status_message() -> str: ...
saml_response_status_message = property(get_saml_response_status_message, None)
```
## Default Value
""
## Remarks
The message that was provided in the status of the SAML response. This property is set alongside the [saml_response_status_codes](#saml_response_status_codes-property) and can be used to provide more information about the status.
This property is read-only.
# saml_response_type property
The type of SAML response that was parsed or processed.
## Syntax
```text
def get_saml_response_type() -> int: ...
saml_response_type = property(get_saml_response_type, None)
```
## Possible Values
```text
0 # Unknown1 # Authn2 # Logout
```
## Default Value
0
## Remarks
The type of SAML response that was parsed or processed.
| | |
| --- | --- |
| 0 (srtUnknown - default) | The class was unable to determine the type of response contained in the SAML response. |
| 1 (srtAuthn) | The class found a Response in the SAML response. |
| 2 (srtLogout) | The class found a LogoutResponse in the SAML response. |
This property is read-only.
# service_provider_metadata_authn_request_signed property
Whether the generated metadata document will inform the identity provider that this service provider will be sending signed requests.
## Syntax
```text
def get_service_provider_metadata_authn_request_signed() -> bool: ...
def set_service_provider_metadata_authn_request_signed(value: bool) -> None: ...
service_provider_metadata_authn_request_signed = property(get_service_provider_metadata_authn_request_signed, set_service_provider_metadata_authn_request_signed)
```
## Default Value
FALSE
## Remarks
Whether the generated metadata document will inform the identity provider that this service provider will be sending signed requests.
# service_provider_metadata_content property
The raw XML document that represents the metadata document for the configured service provider.
## Syntax
```text
def get_service_provider_metadata_content() -> bytes: ...
def set_service_provider_metadata_content(value: bytes) -> None: ...
service_provider_metadata_content = property(get_service_provider_metadata_content, set_service_provider_metadata_content)
```
## Default Value
""
## Remarks
The raw XML document that represents the metadata document for the configured service provider. This property is populated when the [build_service_metadata](#SAML_m_BuildServiceMetadata) method is used to generate a new document.
# service_provider_metadata_entity_id property
The Entity Id for this service provider.
## Syntax
```text
def get_service_provider_metadata_entity_id() -> str: ...
def set_service_provider_metadata_entity_id(value: str) -> None: ...
service_provider_metadata_entity_id = property(get_service_provider_metadata_entity_id, set_service_provider_metadata_entity_id)
```
## Default Value
""
## Remarks
The Entity Id for this service provider. This is the unique Id that will be used by the Identity Provider and should be unique to this service provider.
# service_provider_metadata_signed_metadata property
Whether the class will sign the metadata document when it is being generated.
## Syntax
```text
def get_service_provider_metadata_signed_metadata() -> bool: ...
def set_service_provider_metadata_signed_metadata(value: bool) -> None: ...
service_provider_metadata_signed_metadata = property(get_service_provider_metadata_signed_metadata, set_service_provider_metadata_signed_metadata)
```
## Default Value
FALSE
## Remarks
Whether the class will sign the metadata document when it is being generated. When the [build_service_metadata](#SAML_m_BuildServiceMetadata) method is used to generate the metadata document, the class will use the [service_provider_signing_cert](#SAML_p_ServiceProviderSigningCert) property to sign the document.
# service_provider_metadata_supported_name_id_formats property
A semicolon-separated list of NameId formats that are supported by this service provider.
## Syntax
```text
def get_service_provider_metadata_supported_name_id_formats() -> str: ...
def set_service_provider_metadata_supported_name_id_formats(value: str) -> None: ...
service_provider_metadata_supported_name_id_formats = property(get_service_provider_metadata_supported_name_id_formats, set_service_provider_metadata_supported_name_id_formats)
```
## Default Value
""
## Remarks
A semicolon-separated list of NameId formats that are supported by this service provider.
Some common values are:
| | |
| --- | --- |
| urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified | Unspecified |
| urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress | Email Address |
| urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName | Windows Domain Qualified Name |
To support both email addresses and Windows domain qualified name, this property would be set to:
*urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress;urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName*
# service_provider_metadata_want_assertions_signed property
Whether the metadata document will inform the identity provider that this service provider wants issued assertions to be signed.
## Syntax
```text
def get_service_provider_metadata_want_assertions_signed() -> bool: ...
def set_service_provider_metadata_want_assertions_signed(value: bool) -> None: ...
service_provider_metadata_want_assertions_signed = property(get_service_provider_metadata_want_assertions_signed, set_service_provider_metadata_want_assertions_signed)
```
## Default Value
FALSE
## Remarks
Whether the metadata document will inform the identity provider that this service provider wants issued assertions to be signed.
# service_provider_signing_cert_effective_date property
The date on which this certificate becomes valid.
## Syntax
```text
def get_service_provider_signing_cert_effective_date() -> str: ...
service_provider_signing_cert_effective_date = property(get_service_provider_signing_cert_effective_date, None)
```
## Default Value
""
## Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
# service_provider_signing_cert_encoded property
The certificate (PEM/Base64 encoded).
## Syntax
```text
def get_service_provider_signing_cert_encoded() -> bytes: ...
def set_service_provider_signing_cert_encoded(value: bytes) -> None: ...
service_provider_signing_cert_encoded = property(get_service_provider_signing_cert_encoded, set_service_provider_signing_cert_encoded)
```
## Default Value
""
## Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [service_provider_signing_cert_store](#service_provider_signing_cert_store-property) and [service_provider_signing_cert_subject](#service_provider_signing_cert_subject-property) properties also may be used to specify a certificate.
When [service_provider_signing_cert_encoded](#service_provider_signing_cert_encoded-property) is set, a search is initiated in the current [service_provider_signing_cert_store](#service_provider_signing_cert_store-property) for the private key of the certificate. If the key is found, [service_provider_signing_cert_subject](#service_provider_signing_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [service_provider_signing_cert_subject](#service_provider_signing_cert_subject-property) is set to an empty string.
# service_provider_signing_cert_expiration_date property
The date on which the certificate expires.
## Syntax
```text
def get_service_provider_signing_cert_expiration_date() -> str: ...
service_provider_signing_cert_expiration_date = property(get_service_provider_signing_cert_expiration_date, None)
```
## Default Value
""
## Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
# service_provider_signing_cert_extended_key_usage property
A comma-delimited list of extended key usage identifiers.
## Syntax
```text
def get_service_provider_signing_cert_extended_key_usage() -> str: ...
service_provider_signing_cert_extended_key_usage = property(get_service_provider_signing_cert_extended_key_usage, None)
```
## Default Value
""
## Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
# service_provider_signing_cert_fingerprint property
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
## Syntax
```text
def get_service_provider_signing_cert_fingerprint() -> str: ...
service_provider_signing_cert_fingerprint = property(get_service_provider_signing_cert_fingerprint, None)
```
## Default Value
""
## Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02*
This property is read-only.
# service_provider_signing_cert_fingerprint_sha1 property
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
## Syntax
```text
def get_service_provider_signing_cert_fingerprint_sha1() -> str: ...
service_provider_signing_cert_fingerprint_sha1 = property(get_service_provider_signing_cert_fingerprint_sha1, None)
```
## Default Value
""
## Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84*
This property is read-only.
# service_provider_signing_cert_fingerprint_sha256 property
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
## Syntax
```text
def get_service_provider_signing_cert_fingerprint_sha256() -> str: ...
service_provider_signing_cert_fingerprint_sha256 = property(get_service_provider_signing_cert_fingerprint_sha256, None)
```
## Default Value
""
## Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53*
This property is read-only.
# service_provider_signing_cert_issuer property
The issuer of the certificate.
## Syntax
```text
def get_service_provider_signing_cert_issuer() -> str: ...
service_provider_signing_cert_issuer = property(get_service_provider_signing_cert_issuer, None)
```
## Default Value
""
## Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
# service_provider_signing_cert_private_key property
The private key of the certificate (if available).
## Syntax
```text
def get_service_provider_signing_cert_private_key() -> str: ...
service_provider_signing_cert_private_key = property(get_service_provider_signing_cert_private_key, None)
```
## Default Value
""
## Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
NOTE: The [service_provider_signing_cert_private_key](#service_provider_signing_cert_private_key-property) may be available but not exportable. In this case, [service_provider_signing_cert_private_key](#service_provider_signing_cert_private_key-property) returns an empty string.
This property is read-only.
# service_provider_signing_cert_private_key_available property
Whether a PrivateKey is available for the selected certificate.
## Syntax
```text
def get_service_provider_signing_cert_private_key_available() -> bool: ...
service_provider_signing_cert_private_key_available = property(get_service_provider_signing_cert_private_key_available, None)
```
## Default Value
FALSE
## Remarks
Whether a [service_provider_signing_cert_private_key](#service_provider_signing_cert_private_key-property) is available for the selected certificate. If [service_provider_signing_cert_private_key_available](#service_provider_signing_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
# service_provider_signing_cert_private_key_container property
The name of the PrivateKey container for the certificate (if available).
## Syntax
```text
def get_service_provider_signing_cert_private_key_container() -> str: ...
service_provider_signing_cert_private_key_container = property(get_service_provider_signing_cert_private_key_container, None)
```
## Default Value
""
## Remarks
The name of the [service_provider_signing_cert_private_key](#service_provider_signing_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
# service_provider_signing_cert_public_key property
The public key of the certificate.
## Syntax
```text
def get_service_provider_signing_cert_public_key() -> str: ...
service_provider_signing_cert_public_key = property(get_service_provider_signing_cert_public_key, None)
```
## Default Value
""
## Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
# service_provider_signing_cert_public_key_algorithm property
The textual description of the certificate's public key algorithm.
## Syntax
```text
def get_service_provider_signing_cert_public_key_algorithm() -> str: ...
service_provider_signing_cert_public_key_algorithm = property(get_service_provider_signing_cert_public_key_algorithm, None)
```
## Default Value
""
## Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
# service_provider_signing_cert_public_key_length property
The length of the certificate's public key (in bits).
## Syntax
```text
def get_service_provider_signing_cert_public_key_length() -> int: ...
service_provider_signing_cert_public_key_length = property(get_service_provider_signing_cert_public_key_length, None)
```
## Default Value
0
## Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
# service_provider_signing_cert_serial_number property
The serial number of the certificate encoded as a string.
## Syntax
```text
def get_service_provider_signing_cert_serial_number() -> str: ...
service_provider_signing_cert_serial_number = property(get_service_provider_signing_cert_serial_number, None)
```
## Default Value
""
## Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
# service_provider_signing_cert_signature_algorithm property
The text description of the certificate's signature algorithm.
## Syntax
```text
def get_service_provider_signing_cert_signature_algorithm() -> str: ...
service_provider_signing_cert_signature_algorithm = property(get_service_provider_signing_cert_signature_algorithm, None)
```
## Default Value
""
## Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
# service_provider_signing_cert_store property
The name of the certificate store for the client certificate.
## Syntax
```text
def get_service_provider_signing_cert_store() -> bytes: ...
def set_service_provider_signing_cert_store(value: bytes) -> None: ...
service_provider_signing_cert_store = property(get_service_provider_signing_cert_store, set_service_provider_signing_cert_store)
```
## Default Value
"MY"
## Remarks
The name of the certificate store for the client certificate.
The [service_provider_signing_cert_store_type](#service_provider_signing_cert_store_type-property) property denotes the type of the certificate store specified by [service_provider_signing_cert_store](#service_provider_signing_cert_store-property). If the store is password-protected, specify the password in [service_provider_signing_cert_store_password](#service_provider_signing_cert_store_password-property).
[service_provider_signing_cert_store](#service_provider_signing_cert_store-property) is used in conjunction with the [service_provider_signing_cert_subject](#service_provider_signing_cert_subject-property) property to specify client certificates. If [service_provider_signing_cert_store](#service_provider_signing_cert_store-property) has a value, and [service_provider_signing_cert_subject](#service_provider_signing_cert_subject-property) or [service_provider_signing_cert_encoded](#service_provider_signing_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [service_provider_signing_cert_subject](#service_provider_signing_cert_subject-property) 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).
# service_provider_signing_cert_store_password property
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
## Syntax
```text
def get_service_provider_signing_cert_store_password() -> str: ...
def set_service_provider_signing_cert_store_password(value: str) -> None: ...
service_provider_signing_cert_store_password = property(get_service_provider_signing_cert_store_password, set_service_provider_signing_cert_store_password)
```
## Default Value
""
## Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
# service_provider_signing_cert_store_type property
The type of certificate store for this certificate.
## Syntax
```text
def get_service_provider_signing_cert_store_type() -> int: ...
def set_service_provider_signing_cert_store_type(value: int) -> None: ...
service_provider_signing_cert_store_type = property(get_service_provider_signing_cert_store_type, set_service_provider_signing_cert_store_type)
```
## Possible Values
```text
0 # User1 # Machine2 # PFXFile3 # PFXBlob4 # JKSFile5 # JKSBlob6 # PEMKeyFile7 # PEMKeyBlob8 # PublicKeyFile9 # PublicKeyBlob10 # SSHPublicKeyBlob11 # P7BFile12 # P7BBlob13 # SSHPublicKeyFile14 # PPKFile15 # PPKBlob16 # XMLFile17 # XMLBlob18 # JWKFile19 # JWKBlob20 # SecurityKey21 # BCFKSFile22 # BCFKSBlob23 # PKCS1199 # Auto
```
## Default Value
0
## Remarks
The type of certificate store for this certificate.
The 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:
```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
@"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
"123456", // PIN
"CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```
```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```
| | |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [service_provider_signing_cert_store_type](#service_provider_signing_cert_store_type-property), the full path of the PKCS#11 DLL as the [service_provider_signing_cert_store](#service_provider_signing_cert_store-property), and the PIN as the [service_provider_signing_cert_store_password](#service_provider_signing_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [service_provider_signing_cert_store](#service_provider_signing_cert_store-property) and set [service_provider_signing_cert_store_password](#service_provider_signing_cert_store_password-property) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
# service_provider_signing_cert_subject property
The subject of the certificate used for client authentication.
## Syntax
```text
def get_service_provider_signing_cert_subject() -> str: ...
def set_service_provider_signing_cert_subject(value: str) -> None: ...
service_provider_signing_cert_subject = property(get_service_provider_signing_cert_subject, set_service_provider_signing_cert_subject)
```
## Default Value
""
## Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:
| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
# service_provider_signing_cert_subject_alt_names property
Comma-separated lists of alternative subject names for the certificate.
## Syntax
```text
def get_service_provider_signing_cert_subject_alt_names() -> str: ...
service_provider_signing_cert_subject_alt_names = property(get_service_provider_signing_cert_subject_alt_names, None)
```
## Default Value
""
## Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
# service_provider_signing_cert_thumbprint_md5 property
The MD5 hash of the certificate.
## Syntax
```text
def get_service_provider_signing_cert_thumbprint_md5() -> str: ...
service_provider_signing_cert_thumbprint_md5 = property(get_service_provider_signing_cert_thumbprint_md5, None)
```
## Default Value
""
## Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
# service_provider_signing_cert_thumbprint_sha1 property
The SHA-1 hash of the certificate.
## Syntax
```text
def get_service_provider_signing_cert_thumbprint_sha1() -> str: ...
service_provider_signing_cert_thumbprint_sha1 = property(get_service_provider_signing_cert_thumbprint_sha1, None)
```
## Default Value
""
## Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
# service_provider_signing_cert_thumbprint_sha256 property
The SHA-256 hash of the certificate.
## Syntax
```text
def get_service_provider_signing_cert_thumbprint_sha256() -> str: ...
service_provider_signing_cert_thumbprint_sha256 = property(get_service_provider_signing_cert_thumbprint_sha256, None)
```
## Default Value
""
## Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
# service_provider_signing_cert_usage property
The text description of UsageFlags .
## Syntax
```text
def get_service_provider_signing_cert_usage() -> str: ...
service_provider_signing_cert_usage = property(get_service_provider_signing_cert_usage, None)
```
## Default Value
""
## Remarks
The text description of [service_provider_signing_cert_usage_flags](#service_provider_signing_cert_usage_flags-property).
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
# service_provider_signing_cert_usage_flags property
The flags that show intended use for the certificate.
## Syntax
```text
def get_service_provider_signing_cert_usage_flags() -> int: ...
service_provider_signing_cert_usage_flags = property(get_service_provider_signing_cert_usage_flags, None)
```
## Default Value
0
## Remarks
The flags that show intended use for the certificate. The value of [service_provider_signing_cert_usage_flags](#service_provider_signing_cert_usage_flags-property) 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 [service_provider_signing_cert_usage](#service_provider_signing_cert_usage-property) property for a text representation of [service_provider_signing_cert_usage_flags](#service_provider_signing_cert_usage_flags-property).
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
# service_provider_signing_cert_version property
The certificate's version number.
## Syntax
```text
def get_service_provider_signing_cert_version() -> str: ...
service_provider_signing_cert_version = property(get_service_provider_signing_cert_version, None)
```
## Default Value
""
## Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
# ssl_accept_server_cert_effective_date property
The date on which this certificate becomes valid.
## Syntax
```text
def get_ssl_accept_server_cert_effective_date() -> str: ...
ssl_accept_server_cert_effective_date = property(get_ssl_accept_server_cert_effective_date, None)
```
## Default Value
""
## Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
# ssl_accept_server_cert_encoded property
The certificate (PEM/Base64 encoded).
## Syntax
```text
def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...
ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)
```
## Default Value
""
## Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) and [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) properties also may be used to specify a certificate.
When [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property) is set, a search is initiated in the current [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) for the private key of the certificate. If the key is found, [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) is set to an empty string.
# ssl_accept_server_cert_expiration_date property
The date on which the certificate expires.
## Syntax
```text
def get_ssl_accept_server_cert_expiration_date() -> str: ...
ssl_accept_server_cert_expiration_date = property(get_ssl_accept_server_cert_expiration_date, None)
```
## Default Value
""
## Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
# ssl_accept_server_cert_extended_key_usage property
A comma-delimited list of extended key usage identifiers.
## Syntax
```text
def get_ssl_accept_server_cert_extended_key_usage() -> str: ...
ssl_accept_server_cert_extended_key_usage = property(get_ssl_accept_server_cert_extended_key_usage, None)
```
## Default Value
""
## Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
# ssl_accept_server_cert_fingerprint property
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
## Syntax
```text
def get_ssl_accept_server_cert_fingerprint() -> str: ...
ssl_accept_server_cert_fingerprint = property(get_ssl_accept_server_cert_fingerprint, None)
```
## Default Value
""
## Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02*
This property is read-only.
# ssl_accept_server_cert_fingerprint_sha1 property
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
## Syntax
```text
def get_ssl_accept_server_cert_fingerprint_sha1() -> str: ...
ssl_accept_server_cert_fingerprint_sha1 = property(get_ssl_accept_server_cert_fingerprint_sha1, None)
```
## Default Value
""
## Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84*
This property is read-only.
# ssl_accept_server_cert_fingerprint_sha256 property
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
## Syntax
```text
def get_ssl_accept_server_cert_fingerprint_sha256() -> str: ...
ssl_accept_server_cert_fingerprint_sha256 = property(get_ssl_accept_server_cert_fingerprint_sha256, None)
```
## Default Value
""
## Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53*
This property is read-only.
# ssl_accept_server_cert_issuer property
The issuer of the certificate.
## Syntax
```text
def get_ssl_accept_server_cert_issuer() -> str: ...
ssl_accept_server_cert_issuer = property(get_ssl_accept_server_cert_issuer, None)
```
## Default Value
""
## Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
# ssl_accept_server_cert_private_key property
The private key of the certificate (if available).
## Syntax
```text
def get_ssl_accept_server_cert_private_key() -> str: ...
ssl_accept_server_cert_private_key = property(get_ssl_accept_server_cert_private_key, None)
```
## Default Value
""
## Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
NOTE: The [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) may be available but not exportable. In this case, [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) returns an empty string.
This property is read-only.
# ssl_accept_server_cert_private_key_available property
Whether a PrivateKey is available for the selected certificate.
## Syntax
```text
def get_ssl_accept_server_cert_private_key_available() -> bool: ...
ssl_accept_server_cert_private_key_available = property(get_ssl_accept_server_cert_private_key_available, None)
```
## Default Value
FALSE
## Remarks
Whether a [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) is available for the selected certificate. If [ssl_accept_server_cert_private_key_available](#ssl_accept_server_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
# ssl_accept_server_cert_private_key_container property
The name of the PrivateKey container for the certificate (if available).
## Syntax
```text
def get_ssl_accept_server_cert_private_key_container() -> str: ...
ssl_accept_server_cert_private_key_container = property(get_ssl_accept_server_cert_private_key_container, None)
```
## Default Value
""
## Remarks
The name of the [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
# ssl_accept_server_cert_public_key property
The public key of the certificate.
## Syntax
```text
def get_ssl_accept_server_cert_public_key() -> str: ...
ssl_accept_server_cert_public_key = property(get_ssl_accept_server_cert_public_key, None)
```
## Default Value
""
## Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
# ssl_accept_server_cert_public_key_algorithm property
The textual description of the certificate's public key algorithm.
## Syntax
```text
def get_ssl_accept_server_cert_public_key_algorithm() -> str: ...
ssl_accept_server_cert_public_key_algorithm = property(get_ssl_accept_server_cert_public_key_algorithm, None)
```
## Default Value
""
## Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
# ssl_accept_server_cert_public_key_length property
The length of the certificate's public key (in bits).
## Syntax
```text
def get_ssl_accept_server_cert_public_key_length() -> int: ...
ssl_accept_server_cert_public_key_length = property(get_ssl_accept_server_cert_public_key_length, None)
```
## Default Value
0
## Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
# ssl_accept_server_cert_serial_number property
The serial number of the certificate encoded as a string.
## Syntax
```text
def get_ssl_accept_server_cert_serial_number() -> str: ...
ssl_accept_server_cert_serial_number = property(get_ssl_accept_server_cert_serial_number, None)
```
## Default Value
""
## Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
# ssl_accept_server_cert_signature_algorithm property
The text description of the certificate's signature algorithm.
## Syntax
```text
def get_ssl_accept_server_cert_signature_algorithm() -> str: ...
ssl_accept_server_cert_signature_algorithm = property(get_ssl_accept_server_cert_signature_algorithm, None)
```
## Default Value
""
## Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
# ssl_accept_server_cert_store property
The name of the certificate store for the client certificate.
## Syntax
```text
def get_ssl_accept_server_cert_store() -> bytes: ...
def set_ssl_accept_server_cert_store(value: bytes) -> None: ...
ssl_accept_server_cert_store = property(get_ssl_accept_server_cert_store, set_ssl_accept_server_cert_store)
```
## Default Value
"MY"
## Remarks
The name of the certificate store for the client certificate.
The [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property) property denotes the type of the certificate store specified by [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property). If the store is password-protected, specify the password in [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property).
[ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) is used in conjunction with the [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) property to specify client certificates. If [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) has a value, and [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) or [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) 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).
# ssl_accept_server_cert_store_password property
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
## Syntax
```text
def get_ssl_accept_server_cert_store_password() -> str: ...
def set_ssl_accept_server_cert_store_password(value: str) -> None: ...
ssl_accept_server_cert_store_password = property(get_ssl_accept_server_cert_store_password, set_ssl_accept_server_cert_store_password)
```
## Default Value
""
## Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
# ssl_accept_server_cert_store_type property
The type of certificate store for this certificate.
## Syntax
```text
def get_ssl_accept_server_cert_store_type() -> int: ...
def set_ssl_accept_server_cert_store_type(value: int) -> None: ...
ssl_accept_server_cert_store_type = property(get_ssl_accept_server_cert_store_type, set_ssl_accept_server_cert_store_type)
```
## Possible Values
```text
0 # User1 # Machine2 # PFXFile3 # PFXBlob4 # JKSFile5 # JKSBlob6 # PEMKeyFile7 # PEMKeyBlob8 # PublicKeyFile9 # PublicKeyBlob10 # SSHPublicKeyBlob11 # P7BFile12 # P7BBlob13 # SSHPublicKeyFile14 # PPKFile15 # PPKBlob16 # XMLFile17 # XMLBlob18 # JWKFile19 # JWKBlob20 # SecurityKey21 # BCFKSFile22 # BCFKSBlob23 # PKCS1199 # Auto
```
## Default Value
0
## Remarks
The type of certificate store for this certificate.
The 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:
```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
@"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
"123456", // PIN
"CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```
```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```
| | |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property), the full path of the PKCS#11 DLL as the [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property), and the PIN as the [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) and set [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
# ssl_accept_server_cert_subject property
The subject of the certificate used for client authentication.
## Syntax
```text
def get_ssl_accept_server_cert_subject() -> str: ...
def set_ssl_accept_server_cert_subject(value: str) -> None: ...
ssl_accept_server_cert_subject = property(get_ssl_accept_server_cert_subject, set_ssl_accept_server_cert_subject)
```
## Default Value
""
## Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:
| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
# ssl_accept_server_cert_subject_alt_names property
Comma-separated lists of alternative subject names for the certificate.
## Syntax
```text
def get_ssl_accept_server_cert_subject_alt_names() -> str: ...
ssl_accept_server_cert_subject_alt_names = property(get_ssl_accept_server_cert_subject_alt_names, None)
```
## Default Value
""
## Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
# ssl_accept_server_cert_thumbprint_md5 property
The MD5 hash of the certificate.
## Syntax
```text
def get_ssl_accept_server_cert_thumbprint_md5() -> str: ...
ssl_accept_server_cert_thumbprint_md5 = property(get_ssl_accept_server_cert_thumbprint_md5, None)
```
## Default Value
""
## Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
# ssl_accept_server_cert_thumbprint_sha1 property
The SHA-1 hash of the certificate.
## Syntax
```text
def get_ssl_accept_server_cert_thumbprint_sha1() -> str: ...
ssl_accept_server_cert_thumbprint_sha1 = property(get_ssl_accept_server_cert_thumbprint_sha1, None)
```
## Default Value
""
## Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
# ssl_accept_server_cert_thumbprint_sha256 property
The SHA-256 hash of the certificate.
## Syntax
```text
def get_ssl_accept_server_cert_thumbprint_sha256() -> str: ...
ssl_accept_server_cert_thumbprint_sha256 = property(get_ssl_accept_server_cert_thumbprint_sha256, None)
```
## Default Value
""
## Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
# ssl_accept_server_cert_usage property
The text description of UsageFlags .
## Syntax
```text
def get_ssl_accept_server_cert_usage() -> str: ...
ssl_accept_server_cert_usage = property(get_ssl_accept_server_cert_usage, None)
```
## Default Value
""
## Remarks
The text description of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property).
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
# ssl_accept_server_cert_usage_flags property
The flags that show intended use for the certificate.
## Syntax
```text
def get_ssl_accept_server_cert_usage_flags() -> int: ...
ssl_accept_server_cert_usage_flags = property(get_ssl_accept_server_cert_usage_flags, None)
```
## Default Value
0
## Remarks
The flags that show intended use for the certificate. The value of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property) 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 [ssl_accept_server_cert_usage](#ssl_accept_server_cert_usage-property) property for a text representation of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property).
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
# ssl_accept_server_cert_version property
The certificate's version number.
## Syntax
```text
def get_ssl_accept_server_cert_version() -> str: ...
ssl_accept_server_cert_version = property(get_ssl_accept_server_cert_version, None)
```
## Default Value
""
## Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
# ssl_cert_effective_date property
The date on which this certificate becomes valid.
## Syntax
```text
def get_ssl_cert_effective_date() -> str: ...
ssl_cert_effective_date = property(get_ssl_cert_effective_date, None)
```
## Default Value
""
## Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
# ssl_cert_encoded property
The certificate (PEM/Base64 encoded).
## Syntax
```text
def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...
ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)
```
## Default Value
""
## Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_cert_store](#ssl_cert_store-property) and [ssl_cert_subject](#ssl_cert_subject-property) properties also may be used to specify a certificate.
When [ssl_cert_encoded](#ssl_cert_encoded-property) is set, a search is initiated in the current [ssl_cert_store](#ssl_cert_store-property) for the private key of the certificate. If the key is found, [ssl_cert_subject](#ssl_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_cert_subject](#ssl_cert_subject-property) is set to an empty string.
# ssl_cert_expiration_date property
The date on which the certificate expires.
## Syntax
```text
def get_ssl_cert_expiration_date() -> str: ...
ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None)
```
## Default Value
""
## Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
# ssl_cert_extended_key_usage property
A comma-delimited list of extended key usage identifiers.
## Syntax
```text
def get_ssl_cert_extended_key_usage() -> str: ...
ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None)
```
## Default Value
""
## Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
# ssl_cert_fingerprint property
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
## Syntax
```text
def get_ssl_cert_fingerprint() -> str: ...
ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None)
```
## Default Value
""
## Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02*
This property is read-only.
# ssl_cert_fingerprint_sha1 property
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
## Syntax
```text
def get_ssl_cert_fingerprint_sha1() -> str: ...
ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None)
```
## Default Value
""
## Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84*
This property is read-only.
# ssl_cert_fingerprint_sha256 property
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
## Syntax
```text
def get_ssl_cert_fingerprint_sha256() -> str: ...
ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None)
```
## Default Value
""
## Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53*
This property is read-only.
# ssl_cert_issuer property
The issuer of the certificate.
## Syntax
```text
def get_ssl_cert_issuer() -> str: ...
ssl_cert_issuer = property(get_ssl_cert_issuer, None)
```
## Default Value
""
## Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
# ssl_cert_private_key property
The private key of the certificate (if available).
## Syntax
```text
def get_ssl_cert_private_key() -> str: ...
ssl_cert_private_key = property(get_ssl_cert_private_key, None)
```
## Default Value
""
## Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
NOTE: The [ssl_cert_private_key](#ssl_cert_private_key-property) may be available but not exportable. In this case, [ssl_cert_private_key](#ssl_cert_private_key-property) returns an empty string.
This property is read-only.
# ssl_cert_private_key_available property
Whether a PrivateKey is available for the selected certificate.
## Syntax
```text
def get_ssl_cert_private_key_available() -> bool: ...
ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None)
```
## Default Value
FALSE
## Remarks
Whether a [ssl_cert_private_key](#ssl_cert_private_key-property) is available for the selected certificate. If [ssl_cert_private_key_available](#ssl_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
# ssl_cert_private_key_container property
The name of the PrivateKey container for the certificate (if available).
## Syntax
```text
def get_ssl_cert_private_key_container() -> str: ...
ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None)
```
## Default Value
""
## Remarks
The name of the [ssl_cert_private_key](#ssl_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
# ssl_cert_public_key property
The public key of the certificate.
## Syntax
```text
def get_ssl_cert_public_key() -> str: ...
ssl_cert_public_key = property(get_ssl_cert_public_key, None)
```
## Default Value
""
## Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
# ssl_cert_public_key_algorithm property
The textual description of the certificate's public key algorithm.
## Syntax
```text
def get_ssl_cert_public_key_algorithm() -> str: ...
ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None)
```
## Default Value
""
## Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
# ssl_cert_public_key_length property
The length of the certificate's public key (in bits).
## Syntax
```text
def get_ssl_cert_public_key_length() -> int: ...
ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None)
```
## Default Value
0
## Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
# ssl_cert_serial_number property
The serial number of the certificate encoded as a string.
## Syntax
```text
def get_ssl_cert_serial_number() -> str: ...
ssl_cert_serial_number = property(get_ssl_cert_serial_number, None)
```
## Default Value
""
## Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
# ssl_cert_signature_algorithm property
The text description of the certificate's signature algorithm.
## Syntax
```text
def get_ssl_cert_signature_algorithm() -> str: ...
ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None)
```
## Default Value
""
## Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
# ssl_cert_store property
The name of the certificate store for the client certificate.
## Syntax
```text
def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...
ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)
```
## Default Value
"MY"
## Remarks
The name of the certificate store for the client certificate.
The [ssl_cert_store_type](#ssl_cert_store_type-property) property denotes the type of the certificate store specified by [ssl_cert_store](#ssl_cert_store-property). If the store is password-protected, specify the password in [ssl_cert_store_password](#ssl_cert_store_password-property).
[ssl_cert_store](#ssl_cert_store-property) is used in conjunction with the [ssl_cert_subject](#ssl_cert_subject-property) property to specify client certificates. If [ssl_cert_store](#ssl_cert_store-property) has a value, and [ssl_cert_subject](#ssl_cert_subject-property) or [ssl_cert_encoded](#ssl_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [ssl_cert_subject](#ssl_cert_subject-property) 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).
# ssl_cert_store_password property
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
## Syntax
```text
def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...
ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)
```
## Default Value
""
## Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
# ssl_cert_store_type property
The type of certificate store for this certificate.
## Syntax
```text
def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...
ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)
```
## Possible Values
```text
0 # User1 # Machine2 # PFXFile3 # PFXBlob4 # JKSFile5 # JKSBlob6 # PEMKeyFile7 # PEMKeyBlob8 # PublicKeyFile9 # PublicKeyBlob10 # SSHPublicKeyBlob11 # P7BFile12 # P7BBlob13 # SSHPublicKeyFile14 # PPKFile15 # PPKBlob16 # XMLFile17 # XMLBlob18 # JWKFile19 # JWKBlob20 # SecurityKey21 # BCFKSFile22 # BCFKSBlob23 # PKCS1199 # Auto
```
## Default Value
0
## Remarks
The type of certificate store for this certificate.
The 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:
```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
@"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
"123456", // PIN
"CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```
```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```
| | |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_cert_store_type](#ssl_cert_store_type-property), the full path of the PKCS#11 DLL as the [ssl_cert_store](#ssl_cert_store-property), and the PIN as the [ssl_cert_store_password](#ssl_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_cert_store](#ssl_cert_store-property) and set [ssl_cert_store_password](#ssl_cert_store_password-property) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
# ssl_cert_subject property
The subject of the certificate used for client authentication.
## Syntax
```text
def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...
ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)
```
## Default Value
""
## Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:
| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
# ssl_cert_subject_alt_names property
Comma-separated lists of alternative subject names for the certificate.
## Syntax
```text
def get_ssl_cert_subject_alt_names() -> str: ...
ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None)
```
## Default Value
""
## Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
# ssl_cert_thumbprint_md5 property
The MD5 hash of the certificate.
## Syntax
```text
def get_ssl_cert_thumbprint_md5() -> str: ...
ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None)
```
## Default Value
""
## Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
# ssl_cert_thumbprint_sha1 property
The SHA-1 hash of the certificate.
## Syntax
```text
def get_ssl_cert_thumbprint_sha1() -> str: ...
ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None)
```
## Default Value
""
## Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
# ssl_cert_thumbprint_sha256 property
The SHA-256 hash of the certificate.
## Syntax
```text
def get_ssl_cert_thumbprint_sha256() -> str: ...
ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None)
```
## Default Value
""
## Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
# ssl_cert_usage property
The text description of UsageFlags .
## Syntax
```text
def get_ssl_cert_usage() -> str: ...
ssl_cert_usage = property(get_ssl_cert_usage, None)
```
## Default Value
""
## Remarks
The text description of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property).
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
# ssl_cert_usage_flags property
The flags that show intended use for the certificate.
## Syntax
```text
def get_ssl_cert_usage_flags() -> int: ...
ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None)
```
## Default Value
0
## Remarks
The flags that show intended use for the certificate. The value of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property) 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 [ssl_cert_usage](#ssl_cert_usage-property) property for a text representation of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property).
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
# ssl_cert_version property
The certificate's version number.
## Syntax
```text
def get_ssl_cert_version() -> str: ...
ssl_cert_version = property(get_ssl_cert_version, None)
```
## Default Value
""
## Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
# ssl_provider property
The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
## Syntax
```text
def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...
ssl_provider = property(get_ssl_provider, set_ssl_provider)
```
## Possible Values
```text
0 # Automatic1 # Platform2 # Internal
```
## Default Value
0
## Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of *0* (Automatic) is recommended and should not be changed. When set to *0* (Automatic), the 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. |
**Additional Notes**
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, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the class will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.
# ssl_server_cert_effective_date property
The date on which this certificate becomes valid.
## Syntax
```text
def get_ssl_server_cert_effective_date() -> str: ...
ssl_server_cert_effective_date = property(get_ssl_server_cert_effective_date, None)
```
## Default Value
""
## Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
# ssl_server_cert_encoded property
The certificate (PEM/Base64 encoded).
## Syntax
```text
def get_ssl_server_cert_encoded() -> bytes: ...
ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)
```
## Default Value
""
## Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_server_cert_store](#ssl_server_cert_store-property) and [ssl_server_cert_subject](#ssl_server_cert_subject-property) properties also may be used to specify a certificate.
When [ssl_server_cert_encoded](#ssl_server_cert_encoded-property) is set, a search is initiated in the current [ssl_server_cert_store](#ssl_server_cert_store-property) for the private key of the certificate. If the key is found, [ssl_server_cert_subject](#ssl_server_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_server_cert_subject](#ssl_server_cert_subject-property) is set to an empty string.
This property is read-only.
# ssl_server_cert_expiration_date property
The date on which the certificate expires.
## Syntax
```text
def get_ssl_server_cert_expiration_date() -> str: ...
ssl_server_cert_expiration_date = property(get_ssl_server_cert_expiration_date, None)
```
## Default Value
""
## Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
# ssl_server_cert_extended_key_usage property
A comma-delimited list of extended key usage identifiers.
## Syntax
```text
def get_ssl_server_cert_extended_key_usage() -> str: ...
ssl_server_cert_extended_key_usage = property(get_ssl_server_cert_extended_key_usage, None)
```
## Default Value
""
## Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
# ssl_server_cert_fingerprint property
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
## Syntax
```text
def get_ssl_server_cert_fingerprint() -> str: ...
ssl_server_cert_fingerprint = property(get_ssl_server_cert_fingerprint, None)
```
## Default Value
""
## Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02*
This property is read-only.
# ssl_server_cert_fingerprint_sha1 property
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
## Syntax
```text
def get_ssl_server_cert_fingerprint_sha1() -> str: ...
ssl_server_cert_fingerprint_sha1 = property(get_ssl_server_cert_fingerprint_sha1, None)
```
## Default Value
""
## Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84*
This property is read-only.
# ssl_server_cert_fingerprint_sha256 property
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
## Syntax
```text
def get_ssl_server_cert_fingerprint_sha256() -> str: ...
ssl_server_cert_fingerprint_sha256 = property(get_ssl_server_cert_fingerprint_sha256, None)
```
## Default Value
""
## Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53*
This property is read-only.
# ssl_server_cert_issuer property
The issuer of the certificate.
## Syntax
```text
def get_ssl_server_cert_issuer() -> str: ...
ssl_server_cert_issuer = property(get_ssl_server_cert_issuer, None)
```
## Default Value
""
## Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
# ssl_server_cert_private_key property
The private key of the certificate (if available).
## Syntax
```text
def get_ssl_server_cert_private_key() -> str: ...
ssl_server_cert_private_key = property(get_ssl_server_cert_private_key, None)
```
## Default Value
""
## Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
NOTE: The [ssl_server_cert_private_key](#ssl_server_cert_private_key-property) may be available but not exportable. In this case, [ssl_server_cert_private_key](#ssl_server_cert_private_key-property) returns an empty string.
This property is read-only.
# ssl_server_cert_private_key_available property
Whether a PrivateKey is available for the selected certificate.
## Syntax
```text
def get_ssl_server_cert_private_key_available() -> bool: ...
ssl_server_cert_private_key_available = property(get_ssl_server_cert_private_key_available, None)
```
## Default Value
FALSE
## Remarks
Whether a [ssl_server_cert_private_key](#ssl_server_cert_private_key-property) is available for the selected certificate. If [ssl_server_cert_private_key_available](#ssl_server_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
# ssl_server_cert_private_key_container property
The name of the PrivateKey container for the certificate (if available).
## Syntax
```text
def get_ssl_server_cert_private_key_container() -> str: ...
ssl_server_cert_private_key_container = property(get_ssl_server_cert_private_key_container, None)
```
## Default Value
""
## Remarks
The name of the [ssl_server_cert_private_key](#ssl_server_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
# ssl_server_cert_public_key property
The public key of the certificate.
## Syntax
```text
def get_ssl_server_cert_public_key() -> str: ...
ssl_server_cert_public_key = property(get_ssl_server_cert_public_key, None)
```
## Default Value
""
## Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
# ssl_server_cert_public_key_algorithm property
The textual description of the certificate's public key algorithm.
## Syntax
```text
def get_ssl_server_cert_public_key_algorithm() -> str: ...
ssl_server_cert_public_key_algorithm = property(get_ssl_server_cert_public_key_algorithm, None)
```
## Default Value
""
## Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
# ssl_server_cert_public_key_length property
The length of the certificate's public key (in bits).
## Syntax
```text
def get_ssl_server_cert_public_key_length() -> int: ...
ssl_server_cert_public_key_length = property(get_ssl_server_cert_public_key_length, None)
```
## Default Value
0
## Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
# ssl_server_cert_serial_number property
The serial number of the certificate encoded as a string.
## Syntax
```text
def get_ssl_server_cert_serial_number() -> str: ...
ssl_server_cert_serial_number = property(get_ssl_server_cert_serial_number, None)
```
## Default Value
""
## Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
# ssl_server_cert_signature_algorithm property
The text description of the certificate's signature algorithm.
## Syntax
```text
def get_ssl_server_cert_signature_algorithm() -> str: ...
ssl_server_cert_signature_algorithm = property(get_ssl_server_cert_signature_algorithm, None)
```
## Default Value
""
## Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
# ssl_server_cert_store property
The name of the certificate store for the client certificate.
## Syntax
```text
def get_ssl_server_cert_store() -> bytes: ...
ssl_server_cert_store = property(get_ssl_server_cert_store, None)
```
## Default Value
"MY"
## Remarks
The name of the certificate store for the client certificate.
The [ssl_server_cert_store_type](#ssl_server_cert_store_type-property) property denotes the type of the certificate store specified by [ssl_server_cert_store](#ssl_server_cert_store-property). If the store is password-protected, specify the password in [ssl_server_cert_store_password](#ssl_server_cert_store_password-property).
[ssl_server_cert_store](#ssl_server_cert_store-property) is used in conjunction with the [ssl_server_cert_subject](#ssl_server_cert_subject-property) property to specify client certificates. If [ssl_server_cert_store](#ssl_server_cert_store-property) has a value, and [ssl_server_cert_subject](#ssl_server_cert_subject-property) or [ssl_server_cert_encoded](#ssl_server_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [ssl_server_cert_subject](#ssl_server_cert_subject-property) property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| | |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
This property is read-only.
# ssl_server_cert_store_password property
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
## Syntax
```text
def get_ssl_server_cert_store_password() -> str: ...
ssl_server_cert_store_password = property(get_ssl_server_cert_store_password, None)
```
## Default Value
""
## Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
This property is read-only.
# ssl_server_cert_store_type property
The type of certificate store for this certificate.
## Syntax
```text
def get_ssl_server_cert_store_type() -> int: ...
ssl_server_cert_store_type = property(get_ssl_server_cert_store_type, None)
```
## Possible Values
```text
0 # User1 # Machine2 # PFXFile3 # PFXBlob4 # JKSFile5 # JKSBlob6 # PEMKeyFile7 # PEMKeyBlob8 # PublicKeyFile9 # PublicKeyBlob10 # SSHPublicKeyBlob11 # P7BFile12 # P7BBlob13 # SSHPublicKeyFile14 # PPKFile15 # PPKBlob16 # XMLFile17 # XMLBlob18 # JWKFile19 # JWKBlob20 # SecurityKey21 # BCFKSFile22 # BCFKSBlob23 # PKCS1199 # Auto
```
## Default Value
0
## Remarks
The type of certificate store for this certificate.
The 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:
```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
@"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
"123456", // PIN
"CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```
```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```
| | |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_server_cert_store_type](#ssl_server_cert_store_type-property), the full path of the PKCS#11 DLL as the [ssl_server_cert_store](#ssl_server_cert_store-property), and the PIN as the [ssl_server_cert_store_password](#ssl_server_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_server_cert_store](#ssl_server_cert_store-property) and set [ssl_server_cert_store_password](#ssl_server_cert_store_password-property) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
This property is read-only.
# ssl_server_cert_subject property
The subject of the certificate used for client authentication.
## Syntax
```text
def get_ssl_server_cert_subject() -> str: ...
ssl_server_cert_subject = property(get_ssl_server_cert_subject, None)
```
## Default Value
""
## Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:
| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
This property is read-only.
# ssl_server_cert_subject_alt_names property
Comma-separated lists of alternative subject names for the certificate.
## Syntax
```text
def get_ssl_server_cert_subject_alt_names() -> str: ...
ssl_server_cert_subject_alt_names = property(get_ssl_server_cert_subject_alt_names, None)
```
## Default Value
""
## Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
# ssl_server_cert_thumbprint_md5 property
The MD5 hash of the certificate.
## Syntax
```text
def get_ssl_server_cert_thumbprint_md5() -> str: ...
ssl_server_cert_thumbprint_md5 = property(get_ssl_server_cert_thumbprint_md5, None)
```
## Default Value
""
## Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
# ssl_server_cert_thumbprint_sha1 property
The SHA-1 hash of the certificate.
## Syntax
```text
def get_ssl_server_cert_thumbprint_sha1() -> str: ...
ssl_server_cert_thumbprint_sha1 = property(get_ssl_server_cert_thumbprint_sha1, None)
```
## Default Value
""
## Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
# ssl_server_cert_thumbprint_sha256 property
The SHA-256 hash of the certificate.
## Syntax
```text
def get_ssl_server_cert_thumbprint_sha256() -> str: ...
ssl_server_cert_thumbprint_sha256 = property(get_ssl_server_cert_thumbprint_sha256, None)
```
## Default Value
""
## Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
# ssl_server_cert_usage property
The text description of UsageFlags .
## Syntax
```text
def get_ssl_server_cert_usage() -> str: ...
ssl_server_cert_usage = property(get_ssl_server_cert_usage, None)
```
## Default Value
""
## Remarks
The text description of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property).
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
# ssl_server_cert_usage_flags property
The flags that show intended use for the certificate.
## Syntax
```text
def get_ssl_server_cert_usage_flags() -> int: ...
ssl_server_cert_usage_flags = property(get_ssl_server_cert_usage_flags, None)
```
## Default Value
0
## Remarks
The flags that show intended use for the certificate. The value of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property) 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 [ssl_server_cert_usage](#ssl_server_cert_usage-property) property for a text representation of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property).
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
# ssl_server_cert_version property
The certificate's version number.
## Syntax
```text
def get_ssl_server_cert_version() -> str: ...
ssl_server_cert_version = property(get_ssl_server_cert_version, None)
```
## Default Value
""
## Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
# timeout property
The timeout for the class.
## Syntax
```text
def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...
timeout = property(get_timeout, set_timeout)
```
## 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 [do_events](#do_events-method) 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 fails with an error.
NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.
The default value for the timeout property is 60 seconds.
# web_server_bindings property
The supported bindings used by the embedded web server.
## Syntax
```text
def get_web_server_bindings() -> int: ...
def set_web_server_bindings(value: int) -> None: ...
web_server_bindings = property(get_web_server_bindings, set_web_server_bindings)
```
## Possible Values
```text
0 # Automatic1 # Redirect2 # Post
```
## Default Value
0
## Remarks
This property specifies the supported protocol bindings to handle the SAML response from the Identity Provider. In most cases the default value of *0* (Automatic) is recommended. When set to *0* (Automatic), the class will support both the *HTTP-Redirect* and *HTTP-POST* bindings.
Possible values are as follows:
| | |
| --- | --- |
| 0 (cwbAutomatic - default) | Supports all bindings. |
| 1 (cwbRedirect) | Supports only the HTTP-Redirect binding. |
| 2 (cwbPost) | Supports only the HTTP-POST binding. |
Along with controlling the web server that is started by calling [authenticate_user](#authenticate_user-method) or [start_web_server](#start_web_server-method), this setting also controls the endpoints added to the Service Provider metadata document when calling [build_service_metadata](#build_service_metadata-method).
# web_server_port property
The local port on which the embedded web server listens.
## Syntax
```text
def get_web_server_port() -> int: ...
def set_web_server_port(value: int) -> None: ...
web_server_port = property(get_web_server_port, set_web_server_port)
```
## Default Value
0
## Remarks
This property specifies the port on which the embedded web server listens. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be returned when this setting is queried after the server has started listening.
# web_server_ssl_cert_effective_date property
The date on which this certificate becomes valid.
## Syntax
```text
def get_web_server_ssl_cert_effective_date() -> str: ...
web_server_ssl_cert_effective_date = property(get_web_server_ssl_cert_effective_date, None)
```
## Default Value
""
## Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
# web_server_ssl_cert_encoded property
The certificate (PEM/Base64 encoded).
## Syntax
```text
def get_web_server_ssl_cert_encoded() -> bytes: ...
def set_web_server_ssl_cert_encoded(value: bytes) -> None: ...
web_server_ssl_cert_encoded = property(get_web_server_ssl_cert_encoded, set_web_server_ssl_cert_encoded)
```
## Default Value
""
## Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [web_server_ssl_cert_store](#web_server_ssl_cert_store-property) and [web_server_ssl_cert_subject](#web_server_ssl_cert_subject-property) properties also may be used to specify a certificate.
When [web_server_ssl_cert_encoded](#web_server_ssl_cert_encoded-property) is set, a search is initiated in the current [web_server_ssl_cert_store](#web_server_ssl_cert_store-property) for the private key of the certificate. If the key is found, [web_server_ssl_cert_subject](#web_server_ssl_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [web_server_ssl_cert_subject](#web_server_ssl_cert_subject-property) is set to an empty string.
# web_server_ssl_cert_expiration_date property
The date on which the certificate expires.
## Syntax
```text
def get_web_server_ssl_cert_expiration_date() -> str: ...
web_server_ssl_cert_expiration_date = property(get_web_server_ssl_cert_expiration_date, None)
```
## Default Value
""
## Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
# web_server_ssl_cert_extended_key_usage property
A comma-delimited list of extended key usage identifiers.
## Syntax
```text
def get_web_server_ssl_cert_extended_key_usage() -> str: ...
web_server_ssl_cert_extended_key_usage = property(get_web_server_ssl_cert_extended_key_usage, None)
```
## Default Value
""
## Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
# web_server_ssl_cert_fingerprint property
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
## Syntax
```text
def get_web_server_ssl_cert_fingerprint() -> str: ...
web_server_ssl_cert_fingerprint = property(get_web_server_ssl_cert_fingerprint, None)
```
## Default Value
""
## Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02*
This property is read-only.
# web_server_ssl_cert_fingerprint_sha1 property
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
## Syntax
```text
def get_web_server_ssl_cert_fingerprint_sha1() -> str: ...
web_server_ssl_cert_fingerprint_sha1 = property(get_web_server_ssl_cert_fingerprint_sha1, None)
```
## Default Value
""
## Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84*
This property is read-only.
# web_server_ssl_cert_fingerprint_sha256 property
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
## Syntax
```text
def get_web_server_ssl_cert_fingerprint_sha256() -> str: ...
web_server_ssl_cert_fingerprint_sha256 = property(get_web_server_ssl_cert_fingerprint_sha256, None)
```
## Default Value
""
## Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53*
This property is read-only.
# web_server_ssl_cert_issuer property
The issuer of the certificate.
## Syntax
```text
def get_web_server_ssl_cert_issuer() -> str: ...
web_server_ssl_cert_issuer = property(get_web_server_ssl_cert_issuer, None)
```
## Default Value
""
## Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
# web_server_ssl_cert_private_key property
The private key of the certificate (if available).
## Syntax
```text
def get_web_server_ssl_cert_private_key() -> str: ...
web_server_ssl_cert_private_key = property(get_web_server_ssl_cert_private_key, None)
```
## Default Value
""
## Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
NOTE: The [web_server_ssl_cert_private_key](#web_server_ssl_cert_private_key-property) may be available but not exportable. In this case, [web_server_ssl_cert_private_key](#web_server_ssl_cert_private_key-property) returns an empty string.
This property is read-only.
# web_server_ssl_cert_private_key_available property
Whether a PrivateKey is available for the selected certificate.
## Syntax
```text
def get_web_server_ssl_cert_private_key_available() -> bool: ...
web_server_ssl_cert_private_key_available = property(get_web_server_ssl_cert_private_key_available, None)
```
## Default Value
FALSE
## Remarks
Whether a [web_server_ssl_cert_private_key](#web_server_ssl_cert_private_key-property) is available for the selected certificate. If [web_server_ssl_cert_private_key_available](#web_server_ssl_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
# web_server_ssl_cert_private_key_container property
The name of the PrivateKey container for the certificate (if available).
## Syntax
```text
def get_web_server_ssl_cert_private_key_container() -> str: ...
web_server_ssl_cert_private_key_container = property(get_web_server_ssl_cert_private_key_container, None)
```
## Default Value
""
## Remarks
The name of the [web_server_ssl_cert_private_key](#web_server_ssl_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
# web_server_ssl_cert_public_key property
The public key of the certificate.
## Syntax
```text
def get_web_server_ssl_cert_public_key() -> str: ...
web_server_ssl_cert_public_key = property(get_web_server_ssl_cert_public_key, None)
```
## Default Value
""
## Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
# web_server_ssl_cert_public_key_algorithm property
The textual description of the certificate's public key algorithm.
## Syntax
```text
def get_web_server_ssl_cert_public_key_algorithm() -> str: ...
web_server_ssl_cert_public_key_algorithm = property(get_web_server_ssl_cert_public_key_algorithm, None)
```
## Default Value
""
## Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
# web_server_ssl_cert_public_key_length property
The length of the certificate's public key (in bits).
## Syntax
```text
def get_web_server_ssl_cert_public_key_length() -> int: ...
web_server_ssl_cert_public_key_length = property(get_web_server_ssl_cert_public_key_length, None)
```
## Default Value
0
## Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
# web_server_ssl_cert_serial_number property
The serial number of the certificate encoded as a string.
## Syntax
```text
def get_web_server_ssl_cert_serial_number() -> str: ...
web_server_ssl_cert_serial_number = property(get_web_server_ssl_cert_serial_number, None)
```
## Default Value
""
## Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
# web_server_ssl_cert_signature_algorithm property
The text description of the certificate's signature algorithm.
## Syntax
```text
def get_web_server_ssl_cert_signature_algorithm() -> str: ...
web_server_ssl_cert_signature_algorithm = property(get_web_server_ssl_cert_signature_algorithm, None)
```
## Default Value
""
## Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
# web_server_ssl_cert_store property
The name of the certificate store for the client certificate.
## Syntax
```text
def get_web_server_ssl_cert_store() -> bytes: ...
def set_web_server_ssl_cert_store(value: bytes) -> None: ...
web_server_ssl_cert_store = property(get_web_server_ssl_cert_store, set_web_server_ssl_cert_store)
```
## Default Value
"MY"
## Remarks
The name of the certificate store for the client certificate.
The [web_server_ssl_cert_store_type](#web_server_ssl_cert_store_type-property) property denotes the type of the certificate store specified by [web_server_ssl_cert_store](#web_server_ssl_cert_store-property). If the store is password-protected, specify the password in [web_server_ssl_cert_store_password](#web_server_ssl_cert_store_password-property).
[web_server_ssl_cert_store](#web_server_ssl_cert_store-property) is used in conjunction with the [web_server_ssl_cert_subject](#web_server_ssl_cert_subject-property) property to specify client certificates. If [web_server_ssl_cert_store](#web_server_ssl_cert_store-property) has a value, and [web_server_ssl_cert_subject](#web_server_ssl_cert_subject-property) or [web_server_ssl_cert_encoded](#web_server_ssl_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [web_server_ssl_cert_subject](#web_server_ssl_cert_subject-property) 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).
# web_server_ssl_cert_store_password property
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
## Syntax
```text
def get_web_server_ssl_cert_store_password() -> str: ...
def set_web_server_ssl_cert_store_password(value: str) -> None: ...
web_server_ssl_cert_store_password = property(get_web_server_ssl_cert_store_password, set_web_server_ssl_cert_store_password)
```
## Default Value
""
## Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
# web_server_ssl_cert_store_type property
The type of certificate store for this certificate.
## Syntax
```text
def get_web_server_ssl_cert_store_type() -> int: ...
def set_web_server_ssl_cert_store_type(value: int) -> None: ...
web_server_ssl_cert_store_type = property(get_web_server_ssl_cert_store_type, set_web_server_ssl_cert_store_type)
```
## Possible Values
```text
0 # User1 # Machine2 # PFXFile3 # PFXBlob4 # JKSFile5 # JKSBlob6 # PEMKeyFile7 # PEMKeyBlob8 # PublicKeyFile9 # PublicKeyBlob10 # SSHPublicKeyBlob11 # P7BFile12 # P7BBlob13 # SSHPublicKeyFile14 # PPKFile15 # PPKBlob16 # XMLFile17 # XMLBlob18 # JWKFile19 # JWKBlob20 # SecurityKey21 # BCFKSFile22 # BCFKSBlob23 # PKCS1199 # Auto
```
## Default Value
0
## Remarks
The type of certificate store for this certificate.
The 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:
```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
@"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
"123456", // PIN
"CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```
```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```
| | |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [web_server_ssl_cert_store_type](#web_server_ssl_cert_store_type-property), the full path of the PKCS#11 DLL as the [web_server_ssl_cert_store](#web_server_ssl_cert_store-property), and the PIN as the [web_server_ssl_cert_store_password](#web_server_ssl_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [web_server_ssl_cert_store](#web_server_ssl_cert_store-property) and set [web_server_ssl_cert_store_password](#web_server_ssl_cert_store_password-property) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
# web_server_ssl_cert_subject property
The subject of the certificate used for client authentication.
## Syntax
```text
def get_web_server_ssl_cert_subject() -> str: ...
def set_web_server_ssl_cert_subject(value: str) -> None: ...
web_server_ssl_cert_subject = property(get_web_server_ssl_cert_subject, set_web_server_ssl_cert_subject)
```
## Default Value
""
## Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:
| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
# web_server_ssl_cert_subject_alt_names property
Comma-separated lists of alternative subject names for the certificate.
## Syntax
```text
def get_web_server_ssl_cert_subject_alt_names() -> str: ...
web_server_ssl_cert_subject_alt_names = property(get_web_server_ssl_cert_subject_alt_names, None)
```
## Default Value
""
## Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
# web_server_ssl_cert_thumbprint_md5 property
The MD5 hash of the certificate.
## Syntax
```text
def get_web_server_ssl_cert_thumbprint_md5() -> str: ...
web_server_ssl_cert_thumbprint_md5 = property(get_web_server_ssl_cert_thumbprint_md5, None)
```
## Default Value
""
## Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
# web_server_ssl_cert_thumbprint_sha1 property
The SHA-1 hash of the certificate.
## Syntax
```text
def get_web_server_ssl_cert_thumbprint_sha1() -> str: ...
web_server_ssl_cert_thumbprint_sha1 = property(get_web_server_ssl_cert_thumbprint_sha1, None)
```
## Default Value
""
## Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
# web_server_ssl_cert_thumbprint_sha256 property
The SHA-256 hash of the certificate.
## Syntax
```text
def get_web_server_ssl_cert_thumbprint_sha256() -> str: ...
web_server_ssl_cert_thumbprint_sha256 = property(get_web_server_ssl_cert_thumbprint_sha256, None)
```
## Default Value
""
## Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
# web_server_ssl_cert_usage property
The text description of UsageFlags .
## Syntax
```text
def get_web_server_ssl_cert_usage() -> str: ...
web_server_ssl_cert_usage = property(get_web_server_ssl_cert_usage, None)
```
## Default Value
""
## Remarks
The text description of [web_server_ssl_cert_usage_flags](#web_server_ssl_cert_usage_flags-property).
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
# web_server_ssl_cert_usage_flags property
The flags that show intended use for the certificate.
## Syntax
```text
def get_web_server_ssl_cert_usage_flags() -> int: ...
web_server_ssl_cert_usage_flags = property(get_web_server_ssl_cert_usage_flags, None)
```
## Default Value
0
## Remarks
The flags that show intended use for the certificate. The value of [web_server_ssl_cert_usage_flags](#web_server_ssl_cert_usage_flags-property) 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 [web_server_ssl_cert_usage](#web_server_ssl_cert_usage-property) property for a text representation of [web_server_ssl_cert_usage_flags](#web_server_ssl_cert_usage_flags-property).
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
# web_server_ssl_cert_version property
The certificate's version number.
## Syntax
```text
def get_web_server_ssl_cert_version() -> str: ...
web_server_ssl_cert_version = property(get_web_server_ssl_cert_version, None)
```
## Default Value
""
## Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
# web_server_ssl_enabled property
Whether the web server requires Secure Sockets Layer (SSL) connections.
## Syntax
```text
def get_web_server_ssl_enabled() -> bool: ...
def set_web_server_ssl_enabled(value: bool) -> None: ...
web_server_ssl_enabled = property(get_web_server_ssl_enabled, set_web_server_ssl_enabled)
```
## Default Value
FALSE
## Remarks
This setting specifies whether the embedded web server uses a Secure Sockets Layer (SSL). If set to *True*, web_server_ssl_cert is required and the server will accept only SSL connections. If set to *False*, only plaintext connects are supported.
# authenticate_user method
Authenticates a user to the application.
## Syntax
```text
def authenticate_user() -> None: ...
```
## Remarks
This method will attempt to authenticate the current user using the setting from the following properties and fields:
- identity_provider_metadata
- identity_provider_signing_cert
- identity_provider_ur_is
- saml_request_settings
- service_provider_signing_cert
- [web_server_bindings](#web_server_bindings-property)
- [web_server_port](#web_server_port-property)
- [web_server_ssl_enabled](#web_server_ssl_enabled-property)
The method will first try to launch a web browser window that directs a user to the configured Identity Provider's sign-on page. The user will then go through the authentication process with the Identity Provider, and typically provide consent to allow the service provider (your application) access to their user information. Then, the Identity Provider will return the user back to the application.
At the same time that the user is directed to the sign-on page, the class will also start an internal web server that will be listening for when the user returns. Once the user has returned, the web server will parse the information and validate it.
The method that is used to **send** the user to the sign-on page and the method that is used to return the user depends on the configuration of the Service Provider and the Identity Provider. The component supports two bindings that define different methods for communicate.
The *HTTP-Redirect* binding defines communication that happens over HTTP GET requests and provides the recipient with the information for the request or response through the query parameters. Typically, and by default, this is used when directing the user to the sign-on page. The reason it is not often used for the response from the Identity Provider is that the responses are often required which makes them too long for query parameters. If the *HTTP-Redirect* binding needs to be used with a signed request or response, it will instead use a detached signature.
The *HTTP-POST* binding defines communication that happens over HTTP POST requests and provides the recipient with the information for the request or response through a form post. Typically, this is used to receive the response from the Identity Provider. Since this binding uses a form post, there are less constraints on how long the response can be. This binding can be used to direct a user to the sign-on page if required. The class will first direct the user to an empty HTML page that will then submit a form post to the sign-on page.
Once the user has finished authenticating with the Identity Provider, they will be returned to the [return_url](#return_url-property). Typically, this will be the embedded web server started (if not already running) when authenticate_user is called. After the SAML response has been received by the class, it will parse and validate the SAML response. The results are stored in the saml_response_info property if the SAMLResponse is valid. If the authentication was successful on the Identity Provider's side, it will also parse and validate the assertion. Information about the assertion can be access by accessing the assertion_info, assertion_attribute_info, and assertion_info properties.
This method is the equivalent of using the following methods on an already saved SAML response. See each method for an in-depth review of how each step operates.
- [parse_saml_response](#parse_saml_response-method)
- [validate_saml_response](#validate_saml_response-method)
- [parse_assertion](#parse_assertion-method)
- [validate_assertion](#validate_assertion-method)
If this method completes without any exceptions, then both the SAML response and assertion are valid meaning the user that is described by the [assertion_subject_name_id](#assertion_subject_name_id-property) can be considered authenticated to this application.
# build_service_metadata method
Builds a metadata document for a service provider.
## Syntax
```text
def build_service_metadata() -> None: ...
```
## Remarks
This method uses the service_provider_metadata property to create a new federation metadata document that describes the service provider. This is typically used to provide information about the service provider to the identity provider when configuring SAML SSO.
The following fields and properties are used:
- [service_provider_metadata_authn_request_signed](#service_provider_metadata_authn_request_signed-property)
- [service_provider_metadata_entity_id](#service_provider_metadata_entity_id-property)
- [service_provider_metadata_signed_metadata](#service_provider_metadata_signed_metadata-property)
- [service_provider_metadata_supported_name_id_formats](#service_provider_metadata_supported_name_id_formats-property)
- [service_provider_metadata_want_assertions_signed](#service_provider_metadata_want_assertions_signed-property)
- [return_url](#return_url-property)
- service_provider_signing_cert
- [web_server_bindings](#web_server_bindings-property)
- [web_server_port](#web_server_port-property)
- [web_server_ssl_enabled](#web_server_ssl_enabled-property)
The [service_provider_metadata_entity_id](#service_provider_metadata_entity_id-property) field is important to keep static. The Identity Provider uses this to confirm who made the authenticate request and will need to match the configured value. When making an calling [authenticate_user](#authenticate_user-method), the saml_request_settings_issuer property should be set to match this value.
The *WebServer** settings should be set to allow the class to correctly build the assertion consumer service (ACS) endpoints that are supported by the application. The ACS endpoints are where users are returned from the Identity Provider with the SAML response that needs to be parsed and validated by the class. When this method completes, the [return_url](#return_url-property) property will be set with this location as well. If a specific URI needs to be set instead, set the [return_url](#return_url-property) property directly.
# config method
Sets or retrieves a configuration setting.
## Syntax
```text
def config(configuration_string: str) -> str: ...
```
## Remarks
config is a generic method available in every class. It is used to set and retrieve [configuration settings](#samldesktop-config-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](#samldesktop-config-settings), you must call *Config("PROPERTY")*. The value will be returned as a string.
# do_events method
This method processes events from the internal message queue.
## Syntax
```text
def do_events() -> None: ...
```
## Remarks
When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
# get_assertion_attribute method
Searches for a specific assertion attribute.
## Syntax
```text
def get_assertion_attribute(attr_name: str) -> str: ...
```
## Remarks
This method will search the current assertion_attribute_info properties for a specific attribute. The *attrName* parameter should be set to the attribute name. The method will then return the value of the attribute with the matching name. If there is more than one value, it will return the values in a semicolon-separated list.
# interrupt method
This method interrupts the current method.
## Syntax
```text
def interrupt() -> None: ...
```
## Remarks
If there is no method in progress, interrupt simply returns, doing nothing.
# load_identity_metadata method
Loads an identity provider's metadata document.
## Syntax
```text
def load_identity_metadata(metadata_document: str, validate: bool) -> None: ...
```
## Remarks
This method loads in the identity provider's metadata document that is provided through the *metadataDocument* parameter. After the document has been loaded, the identity_provider_encrypting_cert, identity_provider_metadata, identity_provider_signing_cert and identity_provider_ur_is properties will be set with the information that is available in the document. If the metadata document is signed and the *validate* parameter is *True*, the method will also validate the metadata document's signature.
# parse_assertion method
Parses an assertion.
## Syntax
```text
def parse_assertion() -> None: ...
```
## Remarks
This method parses the assertion found in the assertion_info property. The raw assertion that is parsed provided to the class by setting the [assertion_content](#assertion_content-property) property. If the method is able to successfully parse the assertion, the assertion_info property is populated along with the assertion_attribute_info and assertion_authn_info collections, once for each type of statement found in the assertion.
# parse_saml_response method
Parses a SAML response.
## Syntax
```text
def parse_saml_response() -> None: ...
```
## Remarks
This method parses the SAML response found in the saml_response_info property by setting the [saml_response_content](#saml_response_content-property) property. If the method is able to successfully parse the SAML response, the information fields in the saml_response_info property are populated.
To validate a SAML response, see [validate_saml_response](#validate_saml_response-method).
Additionally, if the [saml_response_type](#saml_response_type-property) is *srtAuthn*, the [assertion_content](#assertion_content-property) property will be populated. See [validate_assertion](#validate_assertion-method) and [parse_assertion](#parse_assertion-method) for more information on validating and parsing the assertion.
# request_identity_metadata method
Requests an identity provider's SAML metadata document.
## Syntax
```text
def request_identity_metadata(url: str) -> None: ...
```
## Remarks
This method makes an HTTP GET request to get the Identity Provider metadata document from the URL location. Once the document has been retrieved, the method will parse and validate the metadata document. After the document has been parsed, the identity_provider_encrypting_cert, identity_provider_metadata, identity_provider_signing_cert, and identity_provider_ur_is properties will be populated with the information that is available in the document.
# reset method
This method will reset the class.
## Syntax
```text
def reset() -> None: ...
```
## Remarks
This method will reset the class's properties to their default values.
# start_web_server method
Starts the embedded web server.
## Syntax
```text
def start_web_server() -> None: ...
```
## Remarks
This method starts the embedded web server. This method can be used to manually start the embedded web server. Under normal circumstances, this is not needed as the component will automatically start and stop the web server when [authenticate_user](#authenticate_user-method) is called. You may decide, however, to start the web server manually before calling [authenticate_user](#authenticate_user-method). When called, this method will also populate [return_url](#return_url-property) with the address of the embedded server if the property is empty.
# stop_web_server method
Stops the embedded web server.
## Syntax
```text
def stop_web_server() -> None: ...
```
## Remarks
This method stops the embedded web server. Under normal circumstances, the web server will be stopped automatically during the authentication process when [authenticate_user](#authenticate_user-method) is called.
# validate_assertion method
Validates an assertion.
## Syntax
```text
def validate_assertion() -> None: ...
```
## Remarks
This method validates the assertion found in the assertion_info property. If an assertion is validated properly, then the user of the application can be authenticated as the subject of the assertion. If the validation fails, then the user should not be authenticated to the application.
The assertion needs to be parsed before it can be validated. You can either be manually set via the [assertion_content](#assertion_content-property) property or by first calling [parse_saml_response](#parse_saml_response-method) on a SAML response that contains an assertion. Before attempting this validation, the on_assertion event provides an opportunity to configure the class to successfully validate the assertion. If the validation fails at any point, the method will throw an exception with the error code corresponding to the reason.
The following checks are performed on the assertion:
| Validation Check | Required Property or Field |
| --- | --- |
| Signature | identity_provider_signing_cert |
| Issuer Element | Identity Provider's [identity_provider_metadata_entity_id](#identity_provider_metadata_entity_id-property) |
| InResponseTo Attribute | [saml_request_id](#saml_request_id-property) |
| Recipient Attribute | [return_url](#return_url-property) |
| NotBefore Attribute | N/A |
| NotOnOrAfter Attribute (Expiration Date) | N/A |
| SessionNotOnOrAfter Attribute (Expiration Date) | N/A |
To skip certain checks, see [AssertionValidationFlags](#AssertionValidationFlags).
# validate_saml_response method
Validates a SAML response.
## Syntax
```text
def validate_saml_response() -> None: ...
```
## Remarks
This method validates a SAML response. If a SAML response is successfully validated and in response to an authentication request, then the assertion should be parsed and validated to finish the authentication process. If it is in response to a logout request, then the application should finish it's logout process for the user.
The SAML response must first be parsed by calling the [parse_saml_response](#parse_saml_response-method) method. Before attempting validation, the on_saml_response event provides an opportunity to configure the class to successfully validate the SAML response.
The following checks are performed on the SAML response:
| Validation Check | Required Property or Field |
| --- | --- |
| Signature (if found) | identity_provider_signing_cert |
| Issuer Element | Identity Provider's [identity_provider_metadata_entity_id](#identity_provider_metadata_entity_id-property) |
| InResponseTo Attribute | [saml_request_id](#saml_request_id-property) |
| Destination Attribute | [return_url](#return_url-property) |
| Status Element | N/A |
To skip certain checks, see [SAMLResponseValidationFlags](#SAMLResponseValidationFlags). Note that this method does not validate the assertion if one is found within the SAML response. See [validate_assertion](#validate_assertion-method) and [parse_assertion](#parse_assertion-method) for more information on validating and parsing the assertion.
# on_error event
Fired when information is available about errors during data delivery.
## Syntax
```text
class SAMLDesktopErrorEventParams(object):
@property
def error_code() -> int: ...
@property
def description() -> str: ...
# In class SAMLDesktop:
@property
def on_error() -> Callable[[SAMLDesktopErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[SAMLDesktopErrorEventParams], None]) -> None: ...
```
## Remarks
The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
The *error_code* 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](#samldesktop-errors) section.
# on_launch_browser event
Fires before launching a browser with the SAML request.
## Syntax
```text
class SAMLDesktopLaunchBrowserEventParams(object):
@property
def url() -> str: ...
@url.setter
def url(value) -> None: ...
@property
def command() -> str: ...
@command.setter
def command(value) -> None: ...
# In class SAMLDesktop:
@property
def on_launch_browser() -> Callable[[SAMLDesktopLaunchBrowserEventParams], None]: ...
@on_launch_browser.setter
def on_launch_browser(event_hook: Callable[[SAMLDesktopLaunchBrowserEventParams], None]) -> None: ...
```
## Remarks
When the [authenticate_user](#authenticate_user-method) method is called, the class will fire this event with the *Command*, which will be executed by the class. The *URL* parameter will be the URL that the user will be directed to authenticate.
Within this event, you may override the current value of either *Command* or *URL* and provide your own value. If *Command* is set to an empty string, the class will not attempt to launch the browser and instead you will be responsible for directing the user to the authorization URL specified by the URL parameter.
In Windows, ShellExecute is used to execute *Command*, which limits the verbs available for use in *Command* to:
- edit
- explore
- find
- open
- print
# on_log event
Fired once for each log message.
## Syntax
```text
class SAMLDesktopLogEventParams(object):
@property
def log_level() -> int: ...
@property
def message() -> str: ...
@property
def log_type() -> str: ...
# In class SAMLDesktop:
@property
def on_log() -> Callable[[SAMLDesktopLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[SAMLDesktopLogEventParams], None]) -> None: ...
```
## Remarks
This event is fired once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) setting.
*log_level* 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.
*log_type* identifies the type of log entry. Possible values are as follows:
- "Info"
- "RequestHeaders"
- "ResponseHeaders"
- "RequestBody"
- "ResponseBody"
- "ProxyRequest"
- "ProxyResponse"
- "FirewallRequest"
- "FirewallResponse"
# on_redirect event
Fired when a redirection is received from the server.
## Syntax
```text
class SAMLDesktopRedirectEventParams(object):
@property
def location() -> str: ...
@property
def accept() -> bool: ...
@accept.setter
def accept(value) -> None: ...
# In class SAMLDesktop:
@property
def on_redirect() -> Callable[[SAMLDesktopRedirectEventParams], None]: ...
@on_redirect.setter
def on_redirect(event_hook: Callable[[SAMLDesktopRedirectEventParams], None]) -> None: ...
```
## Remarks
This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The *accept* parameter is always True by default, but if you do not want to follow the redirection, *accept* may be set to False, in which case the class fails with an error. *location* is the location to which the client is being redirected. Further control over redirection is provided in the [follow_redirects](#follow_redirects-property) property.
# on_return_url event
Fired when the user is redirected to the embedded web server.
## Syntax
```text
class SAMLDesktopReturnURLEventParams(object):
@property
def url_path() -> str: ...
@property
def query_string() -> str: ...
@property
def response_headers() -> str: ...
@response_headers.setter
def response_headers(value) -> None: ...
@property
def response_body() -> str: ...
@response_body.setter
def response_body(value) -> None: ...
# In class SAMLDesktop:
@property
def on_return_url() -> Callable[[SAMLDesktopReturnURLEventParams], None]: ...
@on_return_url.setter
def on_return_url(event_hook: Callable[[SAMLDesktopReturnURLEventParams], None]) -> None: ...
```
## Remarks
When client_profile is set to ocpApplication and the embedded web server is used (default), this event will fire when the user is redirected from the authorization server back to the local embedded web server. The event provides an opportunity to set the *ResponseHeaders* and *ResponseBody* and to provide a custom response that the user will see in their browser.
*URLPath* and *QueryString* are informational parameters that show the values sent by the authorization server.
Additionally, the params properties will be populated. This allows the get_param method to be used to get a specific parameter returned from the authorization server when used within this event.
# on_ssl_server_authentication event
Fired after the server presents its certificate to the client.
## Syntax
```text
class SAMLDesktopSSLServerAuthenticationEventParams(object):
@property
def cert_encoded() -> bytes: ...
@property
def cert_subject() -> str: ...
@property
def cert_issuer() -> str: ...
@property
def status() -> str: ...
@property
def accept() -> bool: ...
@accept.setter
def accept(value) -> None: ...
# In class SAMLDesktop:
@property
def on_ssl_server_authentication() -> Callable[[SAMLDesktopSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[SAMLDesktopSSLServerAuthenticationEventParams], None]) -> None: ...
```
## 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.
# on_ssl_status event
Fired when secure connection progress messages are available.
## Syntax
```text
class SAMLDesktopSSLStatusEventParams(object):
@property
def message() -> str: ...
# In class SAMLDesktop:
@property
def on_ssl_status() -> Callable[[SAMLDesktopSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[SAMLDesktopSSLStatusEventParams], None]) -> None: ...
```
## Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
# SAMLDesktop Config Settings
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](#config-method) method.
### SAMLDesktop Config Settings
**AssertionValidationFlags**: The checks that are ignored when validating an assertion.This setting informs the class to skip certain checks when validating a parsed assertion. The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:
| | |
| --- | --- |
| 0x00000001 | Ignore the SubjectConfirmation element. |
| 0x00000002 | Ignore the AuthnStatement element. |
| 0x00000004 | Ignore the Issuer element. |
| 0x00000008 | Ignore the assertion's signature (does not apply to the SAMLResponse element if that is signed). |
| 0x00000010 | Ignores a mismatch between the certificates set in the class and the one found in the signature of the assertion. |
| 0x00000020 | Ignores the Conditions element. |
**CustomConsent**: The URI reference of a custom consent type.When the [saml_request_consent](#saml_request_consent-property) property is set to *scidCustom - 99*, this configuration setting can be used to set the custom URI reference to the consent type.
**CustomNameIdFormat**: The URI reference of a custom NameID format type.When the [saml_request_name_id_format](#saml_request_name_id_format-property) property is set to *snidCustom - 99*, this configuration setting can be used to set the custom URI reference to the NameID format type.
**SAMLRequestForceAuthn**: Sets the ForceAuthn attribute in created SAML requests. This configuration setting when set to false (default), the *ForceAuthn* attribute is added to authentication SAML requests. When set to true, the attribute will be set to true and the user will be forced to authenticate again with the Identity Provider if supported.
**SAMLResponseDetachedSignature**: The SAML response's detached signature.This configuration setting can be set to a detached signature of a SAML response so that it can be validated. This value should be URL decoded before providing it to the class. To set the signing algorithm, see [SAMLResponseDetachedSignatureAlg](#SAMLResponseDetachedSignatureAlg) for more information.
Particularly, when the [saml_response_content](#saml_response_content-property) property is used to provide a *SAMLResponse* element directly to the class, this configuration setting can be used to provide a detached signature. Typically this would be seen if the *HTTP-Redirect* binding was used to transmit the SAML response.
**SAMLResponseDetachedSignatureAlg**: The algorithm of a SAMLResponse's detached signature.This configuration setting can be set to the signing algorithm used to created the detached signature of a SAML response. This value should be URL decoded before providing it to the class. To set the signature value, see [SAMLResponseDetachedSignature](#SAMLResponseDetachedSignature) for more information.
**SAMLResponseValidationFlags**: The checks that are ignored when validating a SAMLResponse.This setting informs the class to skip certain checks when validating a parsed *SAMLResponse* element. The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:
| | |
| --- | --- |
| 0x00000001 | Ignore the InResponseTo attribute. |
| 0x00000002 | Ignore the destination attribute. |
| 0x00000004 | Ignore the Issuer element. |
| 0x00000008 | Ignore the SAMLResponse element's signature (does not apply to the Assertion element if signed). |
| 0x00000010 | Ignores a mismatch between the certificates set in the class and the one found in the signature of the SAMLResponse element. |
| 0x00000020 | Ignores a status that is not set to a success. |
**UseDetachedSignatures**: Whether detached signatures are used when building a SAML request.This configuration setting only applies to request made with the *HTTP-Redirect* binding. By default, it is set to *true*. When set to true, the class will sign the *SAMLRequest* element using a detached signature. When set to *false* the class will instead include the signature within the request.
### WebServer Config Settings
**BrowserResponseTimeout**: Specifies the amount of time to wait for a response from the browser.This configuration setting specifies the amount of time (in seconds) the component will wait for a response from the browser in the [on_launch_browser](#on_launch_browser-event) event. The default value is 0, meaning that the component will wait indefinitely.
**WebServerFailedResponse**: The custom response that will be displayed to the user if authentication failed.When [authenticate_user](#authenticate_user-method) is called, the user will be redirected to the embedded web server upon completing authentication with the Identity Provider. If authentication fails, the HTML specified here will be sent to the user's browser.
**WebServerHost**: The hostname used by the embedded web server.This configuration setting specifies the hostname used by the embedded web server. This specifies the interface on which the embedded web server listens and also the value displayed in the [return_url](#return_url-property). This should be set to the hostname only, and not to the full URL.
The default value is *localhost*.
**WebServerResponse**: The custom response that is displayed to the user.When [authenticate_user](#authenticate_user-method) is called, the user will be redirected to the embedded web server upon completing authentication with the Identity Provider. This setting allows you to specify the HTML that will be sent to the user's browser.
### HTTP Config Settings
**AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the class adds an *Accept-Encoding* header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the *Accept-Encoding* header. NOTE: The class only supports gzip and deflate decompression algorithms.
**AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.
When True, the class adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
**AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when http_version is set to "2.0".
If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.
The default value is True.
**Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to local_file. When set to True, downloaded data will be appended to local_file. This may be used in conjunction with range to resume a failed download. This is applicable only when local_file is set. The default value is False.
**Authorization**: The Authorization string to be sent to the server.If the [Authorization](#Authorization) property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server.
This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.
The auth_scheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time user and password are set, they are Base64 encoded, and the result is put in the authorization property in the form "Basic [encoded-user-password]".
**BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the on_transfer event, by [BytesTransferred](#BytesTransferred).
**ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.
**CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.
The default value is False.
**EncodeURL**: If set to True the URL will be encoded by the class.If set to True, the URL passed to the class will be URL encoded. The default value is False.
**FollowRedirects**: Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new url for the object is retrieved automatically every time.
If this property is set to 2 (Same Scheme), the new url is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error.
**Note:** 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 [on_redirect](#on_redirect-event) event is fired for every URL the product is redirected to. In the case of automatic redirections, the [on_redirect](#on_redirect-event) event is a good place to set properties related to the new connection (e.g., new authentication parameters).
The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
**GetOn302Redirect**: If set to True the class will perform a GET on the new location.The default value is False. If set to True, the class will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again.
**HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.
**HTTPVersion**: The version of HTTP used by the class.This property specifies the HTTP version used by the class. Possible values are as follows:
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details.
**HTTP/2 Notes**
When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.
If the server does not support HTTP/2, the 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](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#AllowHTTPFallback) setting controls whether this behavior is allowed (default) or disallowed.
**HTTP/3 Notes**
HTTP/3 is supported only in .NET and Java.
When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.
**IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
```text
Sat, 29 Oct 2017 19:43:31 GMT.
```
**KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *True*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *False*, the connection will be closed immediately after the server response is received.
The default value for [KeepAlive](#KeepAlive) is *False*.
**KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.
**LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the [on_log](#on_log-event) event. Possible values are as follows:
| | |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
**MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When [follow_redirects](#follow_redirects-property) is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.
**NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When http_version is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.
**OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers.
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF (*"\r\n"*) .
Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.
This configuration setting is useful for extending the functionality of the class beyond what is provided.
**ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#Authorization) configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a *Proxy-Authorization* HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) are specified, this value is calculated using the algorithm specified by [proxy_auth_scheme](#proxy_auth_scheme-property).
**ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties.
**ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties.
**ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by classes that do not directly expose Proxy properties.
**ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by classes that do not directly expose Proxy properties.
**ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties.
**SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client.
**StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server.
**StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*.
**TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server.
**TransferredDataLimit**: The maximum number of incoming bytes to be stored by the class.If [TransferredDataLimit](#TransferredDataLimit) is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.
**TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server.
**TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:
.NET
```text
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
```
C++
```text
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
```
**UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False.
NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
**UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).
The default value is False and the hostname will always be used exactly as specified. NOTE: The [CodePage](#CodePage) setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set [CodePage](#CodePage) to *65001*. In the C++ Edition for Windows, the *W version of the class must be used. For instance, *DNSW* or *HTTPW*.
**UsePlatformHTTPClient**: Whether or not to use the platform HTTP client.When using this configuration setting, if True, the component will use the default HTTP client for the platform (*URLConnection* in Java, *WebRequest* in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).
NOTE: This setting is applicable only to Mac/iOS editions.
**UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and [proxy_auto_detect](#proxy_auto_detect-property) is set to *True*.
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.
**UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".
Override the default with the name and version of your software.
### TCPClient Config Settings
**ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use [timeout](#timeout-property) for establishing a connection and transmitting/receiving data.
**EnableFallback**:
**FallbackTimeout**:
**FirewallAutoDetect**: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classes that do not directly expose Firewall properties.
**FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting.
If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned.
NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.
**FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting.
**FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.
**FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value.
NOTE: This configuration setting is provided for use by classes that do not directly expose Firewall properties.
**FirewallType**: Determines the type of firewall to connect through.Possible values are as follows:
| | |
| --- | --- |
| 0 | No firewall (default setting). |
| 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. |
| 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.
**FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.
NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.
**KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.
NOTE: This value is not applicable in macOS.
**KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.
**Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the 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.
**LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.
**LocalHost**: The name of the local host through which connections are initiated or accepted. The local_host setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface.
If the class is connected, the local_host setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
**LocalPort**: The port in the local host where the class binds. This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established.
local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
**MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an eol string.
If an eol string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the on_data_in event is fired with the *EOL* parameter set to True, and the buffer is reset.
If no eol is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the on_data_in event is fired with the *EOL* parameter set to False, and the buffer is reset.
The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes.
**MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.
**ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:
*www.google.com;www.example.com*
**TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets.
NOTE: This value is not applicable in Java.
**TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.
By default, this configuration setting is set to False.
**UseIPv6**: Whether to use IPv6.When set to *0* (default), the class will use IPv4 exclusively. When set to *1*, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows:
| | |
| --- | --- |
| 0 | IPv4 only |
| 1 | IPv6 only |
| 2 | IPv6 with IPv4 fallback |
**UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1.
### SSL Config Settings
**LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [ssl_provider](#ssl_provider-property) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes.
When enabled, SSL packet logs are output using the [on_ssl_status](#on_ssl_status-event) event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if [ssl_provider](#ssl_provider-property) is set to *Platform*.
**OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). 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.
**OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by 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.
**OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
**OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL.
By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
**ReuseSSLSession**: Determines if the SSL session is reused.
If set to True, the class will reuse the context if and only if the following criteria are met:
- 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.
**SSLCACertFilePaths**: The paths to CA certificate files on Unix/Linux.This configuration setting specifies the paths on disk to CA certificate files on Unix/Linux.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is as follows:
*/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem*
**SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [ssl_provider](#ssl_provider-property) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the ssl_cert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
```text
-----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-----
```
**SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the class will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.
When set to 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.
**SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the class fails with an error.
When set to 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.
**SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.
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 [on_ssl_status](#on_ssl_status-event) 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](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting.
**SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when ssl_authenticate_clients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
```text
-----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-----
```
**SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation.
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#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 [ssl_provider](#ssl_provider-property) is set to *Platform* include the following:
```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
```
Possible values when [ssl_provider](#ssl_provider-property) 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
Example values when [ssl_provider](#ssl_provider-property) is set to *Internal*include the following:
```text
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 [ssl_provider](#ssl_provider-property) 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](#SSLEnabledProtocols)), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
[SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength).
**SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols.
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 first try to use the platform TLS 1.3 implementation when the [ssl_provider](#ssl_provider-property) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.
In editions that are designed to run on Windows, [ssl_provider](#ssl_provider-property) 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](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported.
- If [SSLEnabledProtocols](#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 [ssl_provider](#ssl_provider-property) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [ssl_provider](#ssl_provider-property) needs to be set to platform.
**SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *False* by default, but it can be set to *True* to enable the extension.
This configuration setting is applicable only when [ssl_provider](#ssl_provider-property) is set to *Internal*.
**SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event) event.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event) event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
**SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.
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 [ssl_provider](#ssl_provider-property) is set to *Internal*.
**SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake.
NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
```csharp
server.Config("SSLNegotiatedCipher[connId]");
```
**SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.
NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
```csharp
server.Config("SSLNegotiatedCipherStrength[connId]");
```
**SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.
NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
```csharp
server.Config("SSLNegotiatedCipherSuite[connId]");
```
**SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.
NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
```csharp
server.Config("SSLNegotiatedKeyExchange[connId]");
```
**SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.
NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
```csharp
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
```
**SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake.
NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
```csharp
server.Config("SSLNegotiatedVersion[connId]");
```
**SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:
| | |
| --- | --- |
| 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.
**SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
```text
-----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-----
```
**TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [ssl_provider](#ssl_provider-property) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2.
When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class fails with an error.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
```csharp
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.
**TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.
The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*.
When using TLS 1.2 and [ssl_provider](#ssl_provider-property) 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)
**TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this 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"
**TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:
- "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 *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3.
**TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.
The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*
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)
- "mlkem_512" (default)
- "mlkem_768" (default)
- "mlkem_1024" (default)
- "x25519_mlkem_768" (default)
- "secp256r1_mlkem_768" (default)
Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported:
- Windows Server 2025
- Windows 11 24H2
- Windows 11 25H2
### Socket Config Settings
**AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [timeout](#timeout-property) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout.
NOTE: This option is not valid for User Datagram Protocol (UDP) ports.
**FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).
**InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.
**OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the 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
**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.
**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
| | |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |
The following is a list of valid code page identifiers for Mac OS only:
| | |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |
**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *True* to mask sensitive data. The default is *True*.
**ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.
**SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when [do_events](#do_events-method) is called, the class will wait for the amount of time specified here before returning. The default value is 20.
**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *False*, the class will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this configuration setting to *True* tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to *False* by default. On Linux/macOS, this setting is set to *True* by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.
# SAMLDesktop Errors
### SAMLDesktop Errors
| | |
| --- | --- |
| 500 | Unable to request SAML metadata document. The URL provided was invalid. |
| 550 | Unable to parse or process SAML response. The provided SAML response from the Identity Service contained invalid HTTP headers. |
| 600 | Unable to parse or process SAML response. The SAML response is missing. |
| 650 | Unable to parse or process SAML response. The HTTP-POST binding request is invalid. |
| 680 | Unable to build SAML request. The SAML request is missing an Id. |
| 681 | Unable to build SAML request. The issued time instance of the SAML response is missing. |
| 700 | SAML response verification failed. The Id of the SAML response is missing. |
| 701 | SAML response verification failed. The version attribute in the SAML response is missing or invalid. |
| 702 | SAML response verification failed. The issued time instant in the SAML response is missing. |
| 703 | SAML response verification failed. The authentication time instant in the SAML response is missing. |
| 704 | SAML response verification failed. The SAML response's signature is invalid. |
| 705 | SAML response verification failed. The certificate found in the SAML response's signature does not match the provided certificate. |
| 706 | SAML response verification failed. The SAML response is in response to a different request than the one configured. |
| 707 | SAML response verification failed. The entity Id of the SAML response issuer is different than the one configured. |
| 708 | SAML response verification failed. The SAML response is meant for a different location (URI) than the ones configured. |
| 708 | SAML response verification failed. The SAML response needs to be parsed before [validate_saml_response](#validate_saml_response-method) can be called. |
| 750 | Assertion verification failed. The method used for the subject confirmation in the assertion is invalid. |
| 751 | Assertion verification failed. The assertion is meant for future use (current time is before NotBefore element). |
| 752 | Assertion verification failed. The assertion has expired. |
| 753 | Assertion verification failed. The assertion is for a recipient different than the configured URIs. |
| 754 | Assertion verification failed. The assertion is in response to a different request than the one configured. |
| 755 | Assertion verification failed. The entity Id of the assertion issuer is different than the one configured. |
| 756 | Assertion verification failed. The linked authentication session of the assertion is expired. |
| 757 | Assertion verification failed. The signature found in the assertion is expired. |
| 758 | Assertion verification failed. Certificate found in the assertion's signature does not match the provided certificate. |
| 759 | Assertion verification failed. The recipient of the assertion (this Service Provider) does not match one of the URIs provided to the class. |
| 760 | Assertion verification failed. The assertion is missing a subject. |
| 761 | Assertion verification failed. The assertion needs to be parsed before [validate_assertion](#validate_assertion-method) can be called. |
The class may also return one of the following error codes, which are inherited from other classes.
### HTTP Errors
| | |
| --- | --- |
| 118 | Firewall error. The error description contains the detailed message. |
| 143 | Busy executing current method. |
| 151 | HTTP protocol error. The error message has the server response. |
| 152 | No server specified in url. |
| 153 | Specified url_scheme is invalid. |
| 155 | Range operation is not supported by server. |
| 156 | Invalid cookie index (out of range). |
| 301 | Interrupted. |
| 302 | Cannot open attached_file. |
The class may also return one of the following error codes, which are inherited from other classes.
### TCPClient Errors
| | |
| --- | --- |
| 100 | You cannot change the remote_port at this time. A connection is in progress. |
| 101 | You cannot change the remote_host (Server) at this time. A connection is in progress. |
| 102 | The remote_host 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 local_port at this time. A connection is in progress. |
| 107 | You cannot change the local_host at this time. A connection is in progress. |
| 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. |
| 116 | remote_port 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). |