Struct cloudsso::SAMLDesktop

Properties   Methods   Events   Config Settings   Errors  

The SAMLDesktop struct provides an easy way to add SAML-based SSO to your desktop application.

Syntax

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 struct is intended for desktop applications that need to add web-based SAML SSO support. The struct 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 struct, 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 and load_identity_metadata 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

saml.RequestIdentityMetadata("https://example.com/federationmetadata/federationmetadata.xml"); string raw_document = saml.IdentityProviderMetadata.Content; //... saml.LoadIdentityMetadata(raw_document, true);

Additionally, the struct 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_port, and web_server_ssl_enabled properties can be used to provide information about the Service Provider. These are used by the struct 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 method to create a SAML Metadata Document that describes your application (the Service Provider) to the Identity Provider.

Usage: Configuring Service Provider Metadata Document

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.

Issuer

The saml_request_issuer field is required and be configured to the Entity Id that was provided to the Identity Provider. If the build_service_metadata method was used to create a metadata document that was provided to the Identity Provider, this will match the service_provider_metadata_entity_id field. The saml_request_issuer field is also used to validate the SAML response once Identity Provider responds.

Binding

The saml_request_binding field is also required and controls how the struct communicates the authentication request to the Identity Provider. This does not control how the Identity Provider responds to the request. The struct 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 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 field can be set to true to have the struct sign the SAML request using the service_provider_signing_cert certificate. f the build_service_metadata 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 property can be set have the struct 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 to start the authentication process.

Usage: Authenticate User

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 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) and the session identifier created by the Identity Provider for the Service Provider (see assertion_authn_session_index).

Assertion Attributes

Along with the assertion_subject_name_id, 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.

<Attribute Name="verified_emails"> <AttributeValue>email@test.com</AttributeValue> <AttributeValue>other@example.com</AttributeValue> </Attribute>

In this assertion attribute statement, the user has two emails that have been verified. There are two ways to get this information through the struct. 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: List<string> verified_emails = new List<string>(); 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 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: string[] verified_emails = saml.GetAssertionAttribute("verified_emails").Split(';');

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by CloudSSO. Due to this, the SAMLDesktop struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of SAMLDesktop when you have finished using the instance.

Property List

---

The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.

Config Settings

---

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

assertion_attribute_count property (SAMLDesktop Struct)

The number of records in the AssertionAttribute arrays.

Syntax

fn assertion_attribute_count(&self ) -> Result<i32, CloudSSOError> 
fn set_assertion_attribute_count(&self, value : i32) ->  Option<CloudSSOError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• assertion_attribute_content
• assertion_attribute_friendly_name
• assertion_attribute_name
• assertion_attribute_name_format
• assertion_attribute_value_count
• assertion_attribute_value_data
• assertion_attribute_value_index

The array indices start at 0 and end at assertion_attribute_count - 1.

Data Type

i32

assertion_attribute_content property (SAMLDesktop Struct)

The raw XML of the attribute.

Syntax

fn assertion_attribute_content(&self , AssertionAttributeIdx : i32) -> Result<String, CloudSSOError> 

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 AssertionAttributeIdx parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionAttributeCount property.

This property is read-only.

Data Type

String

assertion_attribute_friendly_name property (SAMLDesktop Struct)

A human-readable version of the attribute name, if provided.

Syntax

fn assertion_attribute_friendly_name(&self , AssertionAttributeIdx : i32) -> Result<String, CloudSSOError> 

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 AssertionAttributeIdx parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionAttributeCount property.

This property is read-only.

Data Type

String

assertion_attribute_name property (SAMLDesktop Struct)

The name of the attribute.

Syntax

fn assertion_attribute_name(&self , AssertionAttributeIdx : i32) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The name of the attribute. The format of the name (if provided) can be found in the assertion_name_format property.

The AssertionAttributeIdx parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionAttributeCount property.

This property is read-only.

Data Type

String

assertion_attribute_name_format property (SAMLDesktop Struct)

A URI reference to how the Name of the attribute is formatted.

Syntax

fn assertion_attribute_name_format(&self , AssertionAttributeIdx : i32) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

A URI reference to how the assertion_name of the attribute is formatted. If not set, Unspecified is used.

Some common values are:

The AssertionAttributeIdx parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionAttributeCount property.

This property is read-only.

Data Type

String

assertion_attribute_value_count property (SAMLDesktop Struct)

In cases where there are multiple values for a single attribute, this count will be updated to reflect the size of the list.

Syntax

fn assertion_attribute_value_count(&self , AssertionAttributeIdx : i32) -> Result<i32, CloudSSOError> 

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 for more information.

The AssertionAttributeIdx parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionAttributeCount property.

This property is read-only.

Data Type

i32

assertion_attribute_value_data property (SAMLDesktop Struct)

The content of the attribute value selected by ValueIndex .

Syntax

fn assertion_attribute_value_data(&self , AssertionAttributeIdx : i32) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The content of the attribute value selected by assertion_value_index.

The AssertionAttributeIdx parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionAttributeCount property.

This property is read-only.

Data Type

String

assertion_attribute_value_index property (SAMLDesktop Struct)

The index of the attribute value that should be populated in the ValueData property.

Syntax

fn assertion_attribute_value_index(&self , AssertionAttributeIdx : i32) -> Result<i32, CloudSSOError> 
fn set_assertion_attribute_value_index(&self, AssertionAttributeIdx : i32, value : i32) ->  Option<CloudSSOError> 

Default Value

0

Remarks

The index of the attribute value that should be populated in the assertion_value_data property. Valid ranges for this property are from 0 to assertion_value_count - 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

<Attribute Name="ValueName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified"> <AttributeValue>Value1</AttributeValue> <AttributeValue>Value2</AttributeValue> </Attribute>

Iterating through each value in an attribute

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 AssertionAttributeIdx parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionAttributeCount property.

Data Type

i32

assertion_authn_count property (SAMLDesktop Struct)

The number of records in the AssertionAuthn arrays.

Syntax

fn assertion_authn_count(&self ) -> Result<i32, CloudSSOError> 
fn set_assertion_authn_count(&self, value : i32) ->  Option<CloudSSOError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• assertion_authn_authenticating_authorities
• assertion_authn_content
• assertion_authn_context_class_reference
• assertion_authn_context_declaration
• assertion_authn_instant
• assertion_authn_session_expiration
• assertion_authn_session_index

The array indices start at 0 and end at assertion_authn_count - 1.

Data Type

i32

assertion_authn_authenticating_authorities property (SAMLDesktop Struct)

A semicolon-separated list of authorities involved with the current authentication context.

Syntax

fn assertion_authn_authenticating_authorities(&self , AssertionAuthnIndex : i32) -> Result<String, CloudSSOError> 

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 AssertionAuthnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionAuthnCount property.

This property is read-only.

Data Type

String

assertion_authn_content property (SAMLDesktop Struct)

The raw XML of the Authn statement.

Syntax

fn assertion_authn_content(&self , AssertionAuthnIndex : i32) -> Result<String, CloudSSOError> 

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

The AssertionAuthnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionAuthnCount property.

This property is read-only.

Data Type

String

assertion_authn_context_class_reference property (SAMLDesktop Struct)

A predefined URI reference identifying an authentication context class that describes how authentication was provided.

Syntax

fn assertion_authn_context_class_reference(&self , AssertionAuthnIndex : i32) -> Result<String, CloudSSOError> 

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 AssertionAuthnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionAuthnCount property.

This property is read-only.

Data Type

String

assertion_authn_context_declaration property (SAMLDesktop Struct)

A description or URI that describes additional information about the authentication context past the ContextClassReference .

Syntax

fn assertion_authn_context_declaration(&self , AssertionAuthnIndex : i32) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

A description or URI that describes additional information about the authentication context past the assertion_context_class_reference. This provides more detail about the authentication process when provided by the Identity Provider.

The AssertionAuthnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionAuthnCount property.

This property is read-only.

Data Type

String

assertion_authn_instant property (SAMLDesktop Struct)

The time at which the authentication took place that was used to issue the assertion.

Syntax

fn assertion_authn_instant(&self , AssertionAuthnIndex : i32) -> Result<String, CloudSSOError> 

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 AssertionAuthnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionAuthnCount property.

This property is read-only.

Data Type

String

assertion_authn_session_expiration property (SAMLDesktop Struct)

The time at which the session between the principal and Identity Provider must be considered ended.

Syntax

fn assertion_authn_session_expiration(&self , AssertionAuthnIndex : i32) -> Result<String, CloudSSOError> 

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 AssertionAuthnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionAuthnCount property.

This property is read-only.

Data Type

String

assertion_authn_session_index property (SAMLDesktop Struct)

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

fn assertion_authn_session_index(&self , AssertionAuthnIndex : i32) -> Result<String, CloudSSOError> 

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 AssertionAuthnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionAuthnCount property.

This property is read-only.

Data Type

String

assertion_content property (SAMLDesktop Struct)

The raw XML of the assertion.

Syntax

fn assertion_content(&self ) -> Result<Vec<u8>, CloudSSOError> 
fn set_assertion_content(&self, value : Vec<u8>) ->  Option<CloudSSOError> 
fn set_assertion_content_ref(&self, value : &[u8]) ->  Option<CloudSSOError> 

Default Value

""

Remarks

The raw XML of the assertion. This property can be set to provide the assertion to the struct for the parse_assertion or validate_assertion methods to parse or validate the assertion without the SAML response.

Data Type

Vec

assertion_expiration_date property (SAMLDesktop Struct)

When the parsed assertion is expired.

Syntax

fn assertion_expiration_date(&self ) -> Result<String, CloudSSOError> 

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.

Data Type

String

assertion_id property (SAMLDesktop Struct)

The unique Id of the assertion generated by the identity provider.

Syntax

fn assertion_id(&self ) -> Result<String, CloudSSOError> 

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.

Data Type

String

assertion_is_signed property (SAMLDesktop Struct)

Whether the assertion has been signed by the identity provider.

Syntax

fn assertion_is_signed(&self ) -> Result<bool, CloudSSOError> 

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.

Data Type

bool

assertion_issued_time property (SAMLDesktop Struct)

The time at which the assertion was issued by the Issuer (typically the identity provider).

Syntax

fn assertion_issued_time(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The time at which the assertion was issued by the assertion_issuer (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.

Data Type

String

assertion_issuer property (SAMLDesktop Struct)

The issuer of the assertion.

Syntax

fn assertion_issuer(&self ) -> Result<String, CloudSSOError> 

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.

Data Type

String

assertion_not_before_date property (SAMLDesktop Struct)

The time at which the assertion becomes valid.

Syntax

fn assertion_not_before_date(&self ) -> Result<String, CloudSSOError> 

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.

Data Type

String

assertion_one_time_use property (SAMLDesktop Struct)

Whether the issuer only considers this information valid for this single instance.

Syntax

fn assertion_one_time_use(&self ) -> Result<bool, CloudSSOError> 

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.

Data Type

bool

assertion_subject_name_id property (SAMLDesktop Struct)

The unique name identifier for the subject of the current assertion.

Syntax

fn assertion_subject_name_id(&self ) -> Result<String, CloudSSOError> 

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 property. This represents the NameId element of the Subject element if the element is present in the assertion.

This property is read-only.

Data Type

String

assertion_subject_name_id_format property (SAMLDesktop Struct)

A URI reference to how the SubjectNameId of the element is formatted.

Syntax

fn assertion_subject_name_id_format(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

A URI reference to how the assertion_subject_name_id 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:

This property is read-only.

Data Type

String

firewall_auto_detect property (SAMLDesktop Struct)

Whether to automatically detect and use firewall system settings, if available.

Syntax

fn firewall_auto_detect(&self ) -> Result<bool, CloudSSOError> 
fn set_firewall_auto_detect(&self, value : bool) ->  Option<CloudSSOError> 

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

bool

firewall_type property (SAMLDesktop Struct)

The type of firewall to connect through.

Syntax

fn firewall_type(&self ) -> Result<i32, CloudSSOError> 
fn set_firewall_type(&self, value : i32) ->  Option<CloudSSOError> 

Possible Values

0   // None
1   // Tunnel
2   // SOCKS4
3   // SOCKS5
10   // SOCKS4A

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

i32

firewall_host property (SAMLDesktop Struct)

The name or IP address of the firewall (optional).

Syntax

fn firewall_host(&self ) -> Result<String, CloudSSOError> 
fn set_firewall_host(&self, value : &str) ->  Option<CloudSSOError> 
fn set_firewall_host_ref(&self, value : &String) ->  Option<CloudSSOError> 

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the struct fails with an error.

Data Type

String

firewall_password property (SAMLDesktop Struct)

A password if authentication is to be used when connecting through the firewall.

Syntax

fn firewall_password(&self ) -> Result<String, CloudSSOError> 
fn set_firewall_password(&self, value : &str) ->  Option<CloudSSOError> 
fn set_firewall_password_ref(&self, value : &String) ->  Option<CloudSSOError> 

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error.

Data Type

String

firewall_port property (SAMLDesktop Struct)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

fn firewall_port(&self ) -> Result<i32, CloudSSOError> 
fn set_firewall_port(&self, value : i32) ->  Option<CloudSSOError> 

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

NOTE: This property is set automatically when firewall_firewall_type is set to a valid value. See the description of the firewall_firewall_type property for details.

Data Type

i32

firewall_user property (SAMLDesktop Struct)

A username if authentication is to be used when connecting through a firewall.

Syntax

fn firewall_user(&self ) -> Result<String, CloudSSOError> 
fn set_firewall_user(&self, value : &str) ->  Option<CloudSSOError> 
fn set_firewall_user_ref(&self, value : &String) ->  Option<CloudSSOError> 

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property are used to connect and authenticate to the given Firewall. If the authentication fails, the struct fails with an error.

Data Type

String

follow_redirects property (SAMLDesktop Struct)

Determines what happens when the server issues a redirect.

Syntax

fn follow_redirects(&self ) -> Result<i32, CloudSSOError> 
fn set_follow_redirects(&self, value : i32) ->  Option<CloudSSOError> 

Possible Values

0   // Never
1   // Always
2   // SameScheme

Default Value

0

Remarks

This property determines what happens when the server issues a redirect. Normally, the struct returns an error if the server responds with an "Object Moved" message. If this property is set to frAlways (1), the new url for the object is retrieved automatically every time.

If this property is set to frSameScheme (2), the new url is retrieved automatically only if the url_scheme is the same; otherwise, the struct fails with an error.

NOTE: Following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, user and password are also reset to empty. If, however, this property is set to frAlways (1), the same credentials are used to connect to the new server.

A on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and the struct fails with an error instead.

Data Type

i32

identity_provider_encrypting_cert_effective_date property (SAMLDesktop Struct)

The date on which this certificate becomes valid.

Syntax

fn identity_provider_encrypting_cert_effective_date(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

identity_provider_encrypting_cert_expiration_date property (SAMLDesktop Struct)

The date on which the certificate expires.

Syntax

fn identity_provider_encrypting_cert_expiration_date(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

identity_provider_encrypting_cert_extended_key_usage property (SAMLDesktop Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn identity_provider_encrypting_cert_extended_key_usage(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

identity_provider_encrypting_cert_fingerprint property (SAMLDesktop Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn identity_provider_encrypting_cert_fingerprint(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

identity_provider_encrypting_cert_fingerprint_sha1 property (SAMLDesktop Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn identity_provider_encrypting_cert_fingerprint_sha1(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

identity_provider_encrypting_cert_fingerprint_sha256 property (SAMLDesktop Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn identity_provider_encrypting_cert_fingerprint_sha256(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

identity_provider_encrypting_cert_issuer property (SAMLDesktop Struct)

The issuer of the certificate.

Syntax

fn identity_provider_encrypting_cert_issuer(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

identity_provider_encrypting_cert_private_key property (SAMLDesktop Struct)

The private key of the certificate (if available).

Syntax

fn identity_provider_encrypting_cert_private_key(&self ) -> Result<String, CloudSSOError> 

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 may be available but not exportable. In this case, identity_provider_encrypting_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

identity_provider_encrypting_cert_private_key_available property (SAMLDesktop Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn identity_provider_encrypting_cert_private_key_available(&self ) -> Result<bool, CloudSSOError> 

Default Value

false

Remarks

Whether a identity_provider_encrypting_cert_private_key is available for the selected certificate. If identity_provider_encrypting_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

identity_provider_encrypting_cert_private_key_container property (SAMLDesktop Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn identity_provider_encrypting_cert_private_key_container(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The name of the identity_provider_encrypting_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

identity_provider_encrypting_cert_public_key property (SAMLDesktop Struct)

The public key of the certificate.

Syntax

fn identity_provider_encrypting_cert_public_key(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

identity_provider_encrypting_cert_public_key_algorithm property (SAMLDesktop Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn identity_provider_encrypting_cert_public_key_algorithm(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

identity_provider_encrypting_cert_public_key_length property (SAMLDesktop Struct)

The length of the certificate's public key (in bits).

Syntax

fn identity_provider_encrypting_cert_public_key_length(&self ) -> Result<i32, CloudSSOError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

identity_provider_encrypting_cert_serial_number property (SAMLDesktop Struct)

The serial number of the certificate encoded as a string.

Syntax

fn identity_provider_encrypting_cert_serial_number(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

identity_provider_encrypting_cert_signature_algorithm property (SAMLDesktop Struct)

The text description of the certificate's signature algorithm.

Syntax

fn identity_provider_encrypting_cert_signature_algorithm(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

identity_provider_encrypting_cert_store property (SAMLDesktop Struct)

The name of the certificate store for the client certificate.

Syntax

fn identity_provider_encrypting_cert_store(&self ) -> Result<Vec<u8>, CloudSSOError> 
fn set_identity_provider_encrypting_cert_store(&self, value : Vec<u8>) ->  Option<CloudSSOError> 
fn set_identity_provider_encrypting_cert_store_ref(&self, value : &[u8]) ->  Option<CloudSSOError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The identity_provider_encrypting_cert_store_type property denotes the type of the certificate store specified by identity_provider_encrypting_cert_store. If the store is password-protected, specify the password in identity_provider_encrypting_cert_store_password.

identity_provider_encrypting_cert_store is used in conjunction with the identity_provider_encrypting_cert_subject property to specify client certificates. If identity_provider_encrypting_cert_store has a value, and identity_provider_encrypting_cert_subject or identity_provider_encrypting_cert_encoded is set, a search for a certificate is initiated. Please see the identity_provider_encrypting_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

identity_provider_encrypting_cert_store_password property (SAMLDesktop Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn identity_provider_encrypting_cert_store_password(&self ) -> Result<String, CloudSSOError> 
fn set_identity_provider_encrypting_cert_store_password(&self, value : &str) ->  Option<CloudSSOError> 
fn set_identity_provider_encrypting_cert_store_password_ref(&self, value : &String) ->  Option<CloudSSOError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

identity_provider_encrypting_cert_store_type property (SAMLDesktop Struct)

The type of certificate store for this certificate.

Syntax

fn identity_provider_encrypting_cert_store_type(&self ) -> Result<i32, CloudSSOError> 
fn set_identity_provider_encrypting_cert_store_type(&self, value : i32) ->  Option<CloudSSOError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

identity_provider_encrypting_cert_subject_alt_names property (SAMLDesktop Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn identity_provider_encrypting_cert_subject_alt_names(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

identity_provider_encrypting_cert_thumbprint_md5 property (SAMLDesktop Struct)

The MD5 hash of the certificate.

Syntax

fn identity_provider_encrypting_cert_thumbprint_md5(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

identity_provider_encrypting_cert_thumbprint_sha1 property (SAMLDesktop Struct)

The SHA-1 hash of the certificate.

Syntax

fn identity_provider_encrypting_cert_thumbprint_sha1(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

identity_provider_encrypting_cert_thumbprint_sha256 property (SAMLDesktop Struct)

The SHA-256 hash of the certificate.

Syntax

fn identity_provider_encrypting_cert_thumbprint_sha256(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

identity_provider_encrypting_cert_usage property (SAMLDesktop Struct)

The text description of UsageFlags .

Syntax

fn identity_provider_encrypting_cert_usage(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The text description of identity_provider_encrypting_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

identity_provider_encrypting_cert_usage_flags property (SAMLDesktop Struct)

The flags that show intended use for the certificate.

Syntax

fn identity_provider_encrypting_cert_usage_flags(&self ) -> Result<i32, CloudSSOError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of identity_provider_encrypting_cert_usage_flags is a combination of the following flags:

Please see the identity_provider_encrypting_cert_usage property for a text representation of identity_provider_encrypting_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

identity_provider_encrypting_cert_version property (SAMLDesktop Struct)

The certificate's version number.

Syntax

fn identity_provider_encrypting_cert_version(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

identity_provider_encrypting_cert_subject property (SAMLDesktop Struct)

The subject of the certificate used for client authentication.

Syntax

fn identity_provider_encrypting_cert_subject(&self ) -> Result<String, CloudSSOError> 
fn set_identity_provider_encrypting_cert_subject(&self, value : &str) ->  Option<CloudSSOError> 
fn set_identity_provider_encrypting_cert_subject_ref(&self, value : &String) ->  Option<CloudSSOError> 

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:

If a field value contains a comma, it must be quoted.

Data Type

String

identity_provider_encrypting_cert_encoded property (SAMLDesktop Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn identity_provider_encrypting_cert_encoded(&self ) -> Result<Vec<u8>, CloudSSOError> 
fn set_identity_provider_encrypting_cert_encoded(&self, value : Vec<u8>) ->  Option<CloudSSOError> 
fn set_identity_provider_encrypting_cert_encoded_ref(&self, value : &[u8]) ->  Option<CloudSSOError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The identity_provider_encrypting_cert_store and identity_provider_encrypting_cert_subject properties also may be used to specify a certificate.

When identity_provider_encrypting_cert_encoded is set, a search is initiated in the current identity_provider_encrypting_cert_store for the private key of the certificate. If the key is found, identity_provider_encrypting_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, identity_provider_encrypting_cert_subject is set to an empty string.

Data Type

Vec

identity_provider_metadata_content property (SAMLDesktop Struct)

The raw metadata for the identity provider.

Syntax

fn identity_provider_metadata_content(&self ) -> Result<Vec<u8>, CloudSSOError> 
fn set_identity_provider_metadata_content(&self, value : Vec<u8>) ->  Option<CloudSSOError> 
fn set_identity_provider_metadata_content_ref(&self, value : &[u8]) ->  Option<CloudSSOError> 

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

Data Type

Vec

identity_provider_metadata_entity_id property (SAMLDesktop Struct)

The unique Id for the identity provider that is being described.

Syntax

fn identity_provider_metadata_entity_id(&self ) -> Result<String, CloudSSOError> 
fn set_identity_provider_metadata_entity_id(&self, value : &str) ->  Option<CloudSSOError> 
fn set_identity_provider_metadata_entity_id_ref(&self, value : &String) ->  Option<CloudSSOError> 

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.

Data Type

String

identity_provider_metadata_expiration_date property (SAMLDesktop Struct)

The expiration date of the Identity Provider description provided by the metadata document.

Syntax

fn identity_provider_metadata_expiration_date(&self ) -> Result<String, CloudSSOError> 

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.

Data Type

String

identity_provider_metadata_requests_signed_authn_requests property (SAMLDesktop Struct)

Whether the identity provider requests that authentication (Authn) requests are signed.

Syntax

fn identity_provider_metadata_requests_signed_authn_requests(&self ) -> Result<bool, CloudSSOError> 
fn set_identity_provider_metadata_requests_signed_authn_requests(&self, value : bool) ->  Option<CloudSSOError> 

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.

Data Type

bool

identity_provider_metadata_signed_metadata property (SAMLDesktop Struct)

Whether the identity provider's parsed metadata is signed.

Syntax

fn identity_provider_metadata_signed_metadata(&self ) -> Result<bool, CloudSSOError> 

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.

Data Type

bool

identity_provider_metadata_supported_attribute_profiles property (SAMLDesktop Struct)

A semicolon-separated list of attribute profiles supported by the identity provider.

Syntax

fn identity_provider_metadata_supported_attribute_profiles(&self ) -> Result<String, CloudSSOError> 

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.

Data Type

String

identity_provider_metadata_supported_attributes property (SAMLDesktop Struct)

A semicolon-separated list of attributes supported by the identity provider as presented by the Identity Provider's metadata document.

Syntax

fn identity_provider_metadata_supported_attributes(&self ) -> Result<String, CloudSSOError> 

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.

Data Type

String

identity_provider_metadata_supported_name_id_formats property (SAMLDesktop Struct)

The name identifier formats supported by the identity provider if provided by the metadata document.

Syntax

fn identity_provider_metadata_supported_name_id_formats(&self ) -> Result<String, CloudSSOError> 

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.

Data Type

String

identity_provider_signing_cert_effective_date property (SAMLDesktop Struct)

The date on which this certificate becomes valid.

Syntax

fn identity_provider_signing_cert_effective_date(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

identity_provider_signing_cert_expiration_date property (SAMLDesktop Struct)

The date on which the certificate expires.

Syntax

fn identity_provider_signing_cert_expiration_date(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

identity_provider_signing_cert_extended_key_usage property (SAMLDesktop Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn identity_provider_signing_cert_extended_key_usage(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

identity_provider_signing_cert_fingerprint property (SAMLDesktop Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn identity_provider_signing_cert_fingerprint(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

identity_provider_signing_cert_fingerprint_sha1 property (SAMLDesktop Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn identity_provider_signing_cert_fingerprint_sha1(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

identity_provider_signing_cert_fingerprint_sha256 property (SAMLDesktop Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn identity_provider_signing_cert_fingerprint_sha256(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

identity_provider_signing_cert_issuer property (SAMLDesktop Struct)

The issuer of the certificate.

Syntax

fn identity_provider_signing_cert_issuer(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

identity_provider_signing_cert_private_key property (SAMLDesktop Struct)

The private key of the certificate (if available).

Syntax

fn identity_provider_signing_cert_private_key(&self ) -> Result<String, CloudSSOError> 

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 may be available but not exportable. In this case, identity_provider_signing_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

identity_provider_signing_cert_private_key_available property (SAMLDesktop Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn identity_provider_signing_cert_private_key_available(&self ) -> Result<bool, CloudSSOError> 

Default Value

false

Remarks

Whether a identity_provider_signing_cert_private_key is available for the selected certificate. If identity_provider_signing_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

identity_provider_signing_cert_private_key_container property (SAMLDesktop Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn identity_provider_signing_cert_private_key_container(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The name of the identity_provider_signing_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

identity_provider_signing_cert_public_key property (SAMLDesktop Struct)

The public key of the certificate.

Syntax

fn identity_provider_signing_cert_public_key(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

identity_provider_signing_cert_public_key_algorithm property (SAMLDesktop Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn identity_provider_signing_cert_public_key_algorithm(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

identity_provider_signing_cert_public_key_length property (SAMLDesktop Struct)

The length of the certificate's public key (in bits).

Syntax

fn identity_provider_signing_cert_public_key_length(&self ) -> Result<i32, CloudSSOError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

identity_provider_signing_cert_serial_number property (SAMLDesktop Struct)

The serial number of the certificate encoded as a string.

Syntax

fn identity_provider_signing_cert_serial_number(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

identity_provider_signing_cert_signature_algorithm property (SAMLDesktop Struct)

The text description of the certificate's signature algorithm.

Syntax

fn identity_provider_signing_cert_signature_algorithm(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

identity_provider_signing_cert_store property (SAMLDesktop Struct)

The name of the certificate store for the client certificate.

Syntax

fn identity_provider_signing_cert_store(&self ) -> Result<Vec<u8>, CloudSSOError> 
fn set_identity_provider_signing_cert_store(&self, value : Vec<u8>) ->  Option<CloudSSOError> 
fn set_identity_provider_signing_cert_store_ref(&self, value : &[u8]) ->  Option<CloudSSOError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The identity_provider_signing_cert_store_type property denotes the type of the certificate store specified by identity_provider_signing_cert_store. If the store is password-protected, specify the password in identity_provider_signing_cert_store_password.

identity_provider_signing_cert_store is used in conjunction with the identity_provider_signing_cert_subject property to specify client certificates. If identity_provider_signing_cert_store has a value, and identity_provider_signing_cert_subject or identity_provider_signing_cert_encoded is set, a search for a certificate is initiated. Please see the identity_provider_signing_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

identity_provider_signing_cert_store_password property (SAMLDesktop Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn identity_provider_signing_cert_store_password(&self ) -> Result<String, CloudSSOError> 
fn set_identity_provider_signing_cert_store_password(&self, value : &str) ->  Option<CloudSSOError> 
fn set_identity_provider_signing_cert_store_password_ref(&self, value : &String) ->  Option<CloudSSOError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

identity_provider_signing_cert_store_type property (SAMLDesktop Struct)

The type of certificate store for this certificate.

Syntax

fn identity_provider_signing_cert_store_type(&self ) -> Result<i32, CloudSSOError> 
fn set_identity_provider_signing_cert_store_type(&self, value : i32) ->  Option<CloudSSOError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

identity_provider_signing_cert_subject_alt_names property (SAMLDesktop Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn identity_provider_signing_cert_subject_alt_names(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

identity_provider_signing_cert_thumbprint_md5 property (SAMLDesktop Struct)

The MD5 hash of the certificate.

Syntax

fn identity_provider_signing_cert_thumbprint_md5(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

identity_provider_signing_cert_thumbprint_sha1 property (SAMLDesktop Struct)

The SHA-1 hash of the certificate.

Syntax

fn identity_provider_signing_cert_thumbprint_sha1(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

identity_provider_signing_cert_thumbprint_sha256 property (SAMLDesktop Struct)

The SHA-256 hash of the certificate.

Syntax

fn identity_provider_signing_cert_thumbprint_sha256(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

identity_provider_signing_cert_usage property (SAMLDesktop Struct)

The text description of UsageFlags .

Syntax

fn identity_provider_signing_cert_usage(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The text description of identity_provider_signing_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

identity_provider_signing_cert_usage_flags property (SAMLDesktop Struct)

The flags that show intended use for the certificate.

Syntax

fn identity_provider_signing_cert_usage_flags(&self ) -> Result<i32, CloudSSOError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of identity_provider_signing_cert_usage_flags is a combination of the following flags:

Please see the identity_provider_signing_cert_usage property for a text representation of identity_provider_signing_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

identity_provider_signing_cert_version property (SAMLDesktop Struct)

The certificate's version number.

Syntax

fn identity_provider_signing_cert_version(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

identity_provider_signing_cert_subject property (SAMLDesktop Struct)

The subject of the certificate used for client authentication.

Syntax

fn identity_provider_signing_cert_subject(&self ) -> Result<String, CloudSSOError> 
fn set_identity_provider_signing_cert_subject(&self, value : &str) ->  Option<CloudSSOError> 
fn set_identity_provider_signing_cert_subject_ref(&self, value : &String) ->  Option<CloudSSOError> 

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:

If a field value contains a comma, it must be quoted.

Data Type

String

identity_provider_signing_cert_encoded property (SAMLDesktop Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn identity_provider_signing_cert_encoded(&self ) -> Result<Vec<u8>, CloudSSOError> 
fn set_identity_provider_signing_cert_encoded(&self, value : Vec<u8>) ->  Option<CloudSSOError> 
fn set_identity_provider_signing_cert_encoded_ref(&self, value : &[u8]) ->  Option<CloudSSOError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The identity_provider_signing_cert_store and identity_provider_signing_cert_subject properties also may be used to specify a certificate.

When identity_provider_signing_cert_encoded is set, a search is initiated in the current identity_provider_signing_cert_store for the private key of the certificate. If the key is found, identity_provider_signing_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, identity_provider_signing_cert_subject is set to an empty string.

Data Type

Vec

identity_provider_uri_count property (SAMLDesktop Struct)

The number of records in the IdentityProviderURI arrays.

Syntax

fn identity_provider_uri_count(&self ) -> Result<i32, CloudSSOError> 
fn set_identity_provider_uri_count(&self, value : i32) ->  Option<CloudSSOError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• identity_provider_uri_binding_ref
• identity_provider_uri_binding_type
• identity_provider_uri_index
• identity_provider_uri_is_default
• identity_provider_uri_location
• identity_provider_uri_type

The array indices start at 0 and end at identity_provider_uri_count - 1.

Data Type

i32

identity_provider_uri_binding_ref property (SAMLDesktop Struct)

The URI reference for the set BindingType .

Syntax

fn identity_provider_uri_binding_ref(&self , IdentityProviderURIIdx : i32) -> Result<String, CloudSSOError> 
fn set_identity_provider_uri_binding_ref(&self, IdentityProviderURIIdx : i32, value : &str) ->  Option<CloudSSOError> 
fn set_identity_provider_uri_binding_ref_ref(&self, IdentityProviderURIIdx : i32, value : &String) ->  Option<CloudSSOError> 

Default Value

"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"

Remarks

The URI reference for the set identity_provider_uri_binding_type. When the identity_provider_uri_binding_type 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 struct will attempt to set the identity_provider_uri_binding_type property to match. If it can't, subCustom will also be used.

When parsing a metadata document, the struct will also use the subCustom value for any binding types that are not recognized by the struct.

The IdentityProviderURIIdx parameter specifies the index of the item in the array. The size of the array is controlled by the IdentityProviderURICount property.

Data Type

String

identity_provider_uri_binding_type property (SAMLDesktop Struct)

The type of binding that is supported for this URI.

Syntax

fn identity_provider_uri_binding_type(&self , IdentityProviderURIIdx : i32) -> Result<i32, CloudSSOError> 
fn set_identity_provider_uri_binding_type(&self, IdentityProviderURIIdx : i32, value : i32) ->  Option<CloudSSOError> 

Possible Values

0   // Redirect
1   // Post
2   // Artifact
3   // Custom

Default Value

0

Remarks

The type of binding that is supported for this URI. The struct 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 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 property.

If the identity_provider_uri_binding_ref property is set, during the processing of a metadata document the struct will attempt to set this property as well with the matching value. If it can't, subCustom will be used instead.

The IdentityProviderURIIdx parameter specifies the index of the item in the array. The size of the array is controlled by the IdentityProviderURICount property.

Data Type

i32

identity_provider_uri_is_default property (SAMLDesktop Struct)

Whether this URI is the default URI that should be used for the specific URIType and BindingType combination.

Syntax

fn identity_provider_uri_is_default(&self , IdentityProviderURIIdx : i32) -> Result<bool, CloudSSOError> 
fn set_identity_provider_uri_is_default(&self, IdentityProviderURIIdx : i32, value : bool) ->  Option<CloudSSOError> 

Default Value

false

Remarks

Whether this URI is the default URI that should be used for the specific identity_provider_uriuri_type and identity_provider_uri_binding_type combination.

The IdentityProviderURIIdx parameter specifies the index of the item in the array. The size of the array is controlled by the IdentityProviderURICount property.

Data Type

bool

identity_provider_uri_location property (SAMLDesktop Struct)

The address of the URI.

Syntax

fn identity_provider_uri_location(&self , IdentityProviderURIIdx : i32) -> Result<String, CloudSSOError> 
fn set_identity_provider_uri_location(&self, IdentityProviderURIIdx : i32, value : &str) ->  Option<CloudSSOError> 
fn set_identity_provider_uri_location_ref(&self, IdentityProviderURIIdx : i32, value : &String) ->  Option<CloudSSOError> 

Default Value

""

Remarks

The address of the URI.

The IdentityProviderURIIdx parameter specifies the index of the item in the array. The size of the array is controlled by the IdentityProviderURICount property.

Data Type

String

identity_provider_uri_index property (SAMLDesktop Struct)

The index for the URI that can be optionally used if multiple URIs of the same URIType and BindingType are provided.

Syntax

fn identity_provider_uri_index(&self , IdentityProviderURIIdx : i32) -> Result<i32, CloudSSOError> 
fn set_identity_provider_uri_index(&self, IdentityProviderURIIdx : i32, value : i32) ->  Option<CloudSSOError> 

Default Value

0

Remarks

The index for the URI that can be optionally used if multiple URIs of the same identity_provider_uriuri_type and identity_provider_uri_binding_type are provided.

The IdentityProviderURIIdx parameter specifies the index of the item in the array. The size of the array is controlled by the IdentityProviderURICount property.

Data Type

i32

identity_provider_uri_type property (SAMLDesktop Struct)

The purpose of the URI.

Syntax

fn identity_provider_uri_type(&self , IdentityProviderURIIdx : i32) -> Result<i32, CloudSSOError> 
fn set_identity_provider_uri_type(&self, IdentityProviderURIIdx : i32, value : i32) ->  Option<CloudSSOError> 

Possible Values

0   // Signon
1   // Logout
2   // ACS

Default Value

0

Remarks

The purpose of the URI.

Possible values are:

The IdentityProviderURIIdx parameter specifies the index of the item in the array. The size of the array is controlled by the IdentityProviderURICount property.

Data Type

i32

proxy_auth_scheme property (SAMLDesktop Struct)

The type of authorization to perform when connecting to the proxy.

Syntax

fn proxy_auth_scheme(&self ) -> Result<i32, CloudSSOError> 
fn set_proxy_auth_scheme(&self, value : i32) ->  Option<CloudSSOError> 

Possible Values

0   // Basic
1   // Digest
2   // Proprietary
3   // None
4   // Ntlm
5   // Negotiate

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the struct will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the struct. Look at the configuration file for the struct being used to find more information about manually setting this token.

If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

Data Type

i32

proxy_auto_detect property (SAMLDesktop Struct)

Whether to automatically detect and use proxy system settings, if available.

Syntax

fn proxy_auto_detect(&self ) -> Result<bool, CloudSSOError> 
fn set_proxy_auto_detect(&self, value : bool) ->  Option<CloudSSOError> 

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

bool

proxy_password property (SAMLDesktop Struct)

A password if authentication is to be used for the proxy.

Syntax

fn proxy_password(&self ) -> Result<String, CloudSSOError> 
fn set_proxy_password(&self, value : &str) ->  Option<CloudSSOError> 
fn set_proxy_password_ref(&self, value : &String) ->  Option<CloudSSOError> 

Default Value

""

Remarks

A password if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

Data Type

String

proxy_port property (SAMLDesktop Struct)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

fn proxy_port(&self ) -> Result<i32, CloudSSOError> 
fn set_proxy_port(&self, value : i32) ->  Option<CloudSSOError> 

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

Data Type

i32

proxy_server property (SAMLDesktop Struct)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

fn proxy_server(&self ) -> Result<String, CloudSSOError> 
fn set_proxy_server(&self, value : &str) ->  Option<CloudSSOError> 
fn set_proxy_server_ref(&self, value : &String) ->  Option<CloudSSOError> 

Default Value

""

Remarks

If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

proxy_ssl property (SAMLDesktop Struct)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

fn proxy_ssl(&self ) -> Result<i32, CloudSSOError> 
fn set_proxy_ssl(&self, value : i32) ->  Option<CloudSSOError> 

Possible Values

0   // Automatic
1   // Always
2   // Never
3   // 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:

Data Type

i32

proxy_user property (SAMLDesktop Struct)

A username if authentication is to be used for the proxy.

Syntax

fn proxy_user(&self ) -> Result<String, CloudSSOError> 
fn set_proxy_user(&self, value : &str) ->  Option<CloudSSOError> 
fn set_proxy_user_ref(&self, value : &String) ->  Option<CloudSSOError> 

Default Value

""

Remarks

A username if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

Data Type

String

relay_state property (SAMLDesktop Struct)

The RelayState for a SAML request or response.

Syntax

fn relay_state(&self ) -> Result<String, CloudSSOError> 
fn set_relay_state(&self, value : &str) ->  Option<CloudSSOError> 
fn set_relay_state_ref(&self, value : &String) ->  Option<CloudSSOError> 

Default Value

""

Remarks

When set before building a request using the authenticate_user 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.

Data Type

String

return_url property (SAMLDesktop Struct)

The URL where the user (browser) returns after authenticating with the Identity Provider.

Syntax

fn return_url(&self ) -> Result<String, CloudSSOError> 
fn set_return_url(&self, value : &str) ->  Option<CloudSSOError> 
fn set_return_url_ref(&self, value : &String) ->  Option<CloudSSOError> 

Default Value

""

Remarks

Typically this property will be automatically set by the component when calling authenticate_user or build_service_metadata based on how the web_server_bindings, web_server_port, and web_server_ssl_enabled properties are configured. Additionally, the 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.

Data Type

String

saml_request_allow_create property (SAMLDesktop Struct)

This setting is only used for authentication requests.

Syntax

fn saml_request_allow_create(&self ) -> Result<bool, CloudSSOError> 
fn set_saml_request_allow_create(&self, value : bool) ->  Option<CloudSSOError> 

Default Value

false

Remarks

This setting is only used for authentication requests. It controls whether the struct 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.

Data Type

bool

saml_request_binding property (SAMLDesktop Struct)

This setting controls the binding that will be used to make the request.

Syntax

fn saml_request_binding(&self ) -> Result<i32, CloudSSOError> 
fn set_saml_request_binding(&self, value : i32) ->  Option<CloudSSOError> 

Possible Values

0   // HTTPRedirect
1   // HTTPPost

Default Value

0

Remarks

This setting controls the binding that will be used to make the request.

By default, the struct will use the sbHTTPRedirect binding which provides the SAMLRequest value through a query parameter. The sbHTTPRedirect binding will set just the saml_request_url 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 and saml_request_body properties.

Note: This setting does not control the binding of the response, just how the request will be made.

Data Type

i32

saml_request_consent property (SAMLDesktop Struct)

This setting specifies whether consent from a principal was provided when this request was sent.

Syntax

fn saml_request_consent(&self ) -> Result<i32, CloudSSOError> 
fn set_saml_request_consent(&self, value : i32) ->  Option<CloudSSOError> 

Possible Values

0   // Unspecified
1   // Obtained
2   // Prior
3   // Implicit
4   // Explicit
5   // Unavailable
6   // Inapplicable
7   // 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 configuration setting will be used instead.

Data Type

i32

saml_request_destination property (SAMLDesktop Struct)

This setting specifies a URI reference for the intended destination for the SAML request.

Syntax

fn saml_request_destination(&self ) -> Result<String, CloudSSOError> 
fn set_saml_request_destination(&self, value : &str) ->  Option<CloudSSOError> 
fn set_saml_request_destination_ref(&self, value : &String) ->  Option<CloudSSOError> 

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 struct will set this to match the endpoint selected by the struct. See saml_request_use_default_endpoint and saml_request_selected_endpoint for more information.

Data Type

String

saml_request_id property (SAMLDesktop Struct)

This setting specifies the unique Id of the SAML request.

Syntax

fn saml_request_id(&self ) -> Result<String, CloudSSOError> 
fn set_saml_request_id(&self, value : &str) ->  Option<CloudSSOError> 
fn set_saml_request_id_ref(&self, value : &String) ->  Option<CloudSSOError> 

Default Value

""

Remarks

This setting specifies the unique Id of the SAML request.

When building a SAML request using the build_authn_request or build_logout_request methods, the struct will use this value for the Id attribute in the request. If left empty before building the request, the struct 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 struct. The SAML response and assertion both have an InResponseTo attribute that needs to match this property. See saml_request_in_response_to 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 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 or build_logout_request is used to create a request, this setting

Data Type

String

saml_request_issued_time property (SAMLDesktop Struct)

This setting sets the time at which the SAML request was issued.

Syntax

fn saml_request_issued_time(&self ) -> Result<String, CloudSSOError> 
fn set_saml_request_issued_time(&self, value : &str) ->  Option<CloudSSOError> 
fn set_saml_request_issued_time_ref(&self, value : &String) ->  Option<CloudSSOError> 

Default Value

""

Remarks

This setting sets the time at which the SAML request was issued. If not set, the struct 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

Data Type

String

saml_request_issuer property (SAMLDesktop Struct)

The issuer for the SAML request.

Syntax

fn saml_request_issuer(&self ) -> Result<String, CloudSSOError> 
fn set_saml_request_issuer(&self, value : &str) ->  Option<CloudSSOError> 
fn set_saml_request_issuer_ref(&self, value : &String) ->  Option<CloudSSOError> 

Default Value

""

Remarks

The issuer for the SAML request. Typically, this should be set to the Entity Id configured for the Identity Provider.

Data Type

String

saml_request_name_id_format property (SAMLDesktop Struct)

This setting is only used for authentication requests.

Syntax

fn saml_request_name_id_format(&self ) -> Result<i32, CloudSSOError> 
fn set_saml_request_name_id_format(&self, value : i32) ->  Option<CloudSSOError> 

Possible Values

0   // Unspecified
1   // Email
2   // X509
3   // WindowsDQ
4   // Kerberos
5   // Entity
6   // Persistent
7   // Transient
8   // 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 configuration setting will be used instead.

Data Type

i32

saml_request_selected_endpoint property (SAMLDesktop Struct)

This setting only applies to Authn Requests since there can be multiple Assertion Consumer Service (ACS) endpoints per service provider.

Syntax

fn saml_request_selected_endpoint(&self ) -> Result<i32, CloudSSOError> 
fn set_saml_request_selected_endpoint(&self, value : i32) ->  Option<CloudSSOError> 

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 struct will select the the ACS endpoint depending on how saml_request_settings is configured. If saml_request_use_default_endpoint 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 is set, the struct will use that index in the request. Otherwise, the struct will select the first URI available in the service_provider_ur_is properties.

Data Type

i32

saml_request_session_index property (SAMLDesktop Struct)

This setting only applies when building SAML logout requests.

Syntax

fn saml_request_session_index(&self ) -> Result<String, CloudSSOError> 
fn set_saml_request_session_index(&self, value : &str) ->  Option<CloudSSOError> 
fn set_saml_request_session_index_ref(&self, value : &String) ->  Option<CloudSSOError> 

Default Value

""

Remarks

This setting only applies when building SAML logout requests. saml_request_session_index identifies the current session of the user that is being ended when the build_logout_request method is called. When the process_saml_response or parse_assertion methods are called, the saml_request_session_index 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.

Data Type

String

saml_request_sign_request property (SAMLDesktop Struct)

This setting controls whether the SAML request should be signed when using the BuildAuthnRequest or BuildLogoutRequest methods.

Syntax

fn saml_request_sign_request(&self ) -> Result<bool, CloudSSOError> 
fn set_saml_request_sign_request(&self, value : bool) ->  Option<CloudSSOError> 

Default Value

false

Remarks

This setting controls whether the SAML request should be signed when using the build_authn_request or build_logout_request methods. The struct will use the certificate set in the service_provider_signing_cert property to sign the request.

Data Type

bool

saml_request_use_default_endpoint property (SAMLDesktop Struct)

This setting only applies to Authn Requests since there can be multiple Assertion Consumer Service (ACS) endpoints per service provider.

Syntax

fn saml_request_use_default_endpoint(&self ) -> Result<bool, CloudSSOError> 
fn set_saml_request_use_default_endpoint(&self, value : bool) ->  Option<CloudSSOError> 

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 struct will select the the ACS endpoint depending on how saml_request_settings is configured. If saml_request_use_default_endpoint 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 is set, then the struct will use that index in the request. Otherwise, the struct will select the first URI available in the service_provider_ur_is properties.

Data Type

bool

saml_response_consent property (SAMLDesktop Struct)

Whether consent from a principal was provided when this response was sent.

Syntax

fn saml_response_consent(&self ) -> Result<String, CloudSSOError> 

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.

Data Type

String

saml_response_content property (SAMLDesktop Struct)

The full XML of the SAML response after being parsed or processed by the struct.

Syntax

fn saml_response_content(&self ) -> Result<Vec<u8>, CloudSSOError> 
fn set_saml_response_content(&self, value : Vec<u8>) ->  Option<CloudSSOError> 
fn set_saml_response_content_ref(&self, value : &[u8]) ->  Option<CloudSSOError> 

Default Value

""

Remarks

The full XML of the SAML response after being parsed or processed by the struct. Optionally, this setting can be set to provide a SAML response directly to the struct to be parsed or processed.

Data Type

Vec

saml_response_destination property (SAMLDesktop Struct)

A URI reference for the intended destination for the SAML response.

Syntax

fn saml_response_destination(&self ) -> Result<String, CloudSSOError> 

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.

Data Type

String

saml_response_id property (SAMLDesktop Struct)

The unique Id for the SAML response that was created by the Issuer .

Syntax

fn saml_response_id(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The unique Id for the SAML response that was created by the saml_response_issuer.

This property is read-only.

Data Type

String

saml_response_in_response_to property (SAMLDesktop Struct)

The Id of the SAML request that requested the Identity Provider to issue this SAML response.

Syntax

fn saml_response_in_response_to(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The Id of the SAML request that requested the Identity Provider to issue this SAML response. The struct validates this property against the original Id of the SAML request which saml_response_id should be set to.

This property is read-only.

Data Type

String

saml_response_issued_time property (SAMLDesktop Struct)

The time at which the SAML response was issued by the Issuer .

Syntax

fn saml_response_issued_time(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The time at which the SAML response was issued by the saml_response_issuer.

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.

Data Type

String

saml_response_issuer property (SAMLDesktop Struct)

The Entity Id of the issuer of the SAML response.

Syntax

fn saml_response_issuer(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The Entity Id of the issuer of the SAML response. Typically, this will be the saml_response_entity_id of the Identity Provider.

This property is read-only.

Data Type

String

saml_response_type property (SAMLDesktop Struct)

The type of SAML response that was parsed or processed.

Syntax

fn saml_response_type(&self ) -> Result<i32, CloudSSOError> 

Possible Values

0   // Unknown
1   // Authn
2   // Logout

Default Value

0

Remarks

The type of SAML response that was parsed or processed.

This property is read-only.

Data Type

i32

saml_response_signed property (SAMLDesktop Struct)

Whether the SAML response is signed.

Syntax

fn saml_response_signed(&self ) -> Result<bool, CloudSSOError> 

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.

Data Type

bool

saml_response_status_codes property (SAMLDesktop Struct)

A semicolon-separated list of status codes found in the SAML response.

Syntax

fn saml_response_status_codes(&self ) -> Result<String, CloudSSOError> 

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.

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 for more information.

This property is read-only.

Data Type

String

saml_response_status_message property (SAMLDesktop Struct)

The message that was provided in the status of the SAML response.

Syntax

fn saml_response_status_message(&self ) -> Result<String, CloudSSOError> 

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 and can be used to provide more information about the status.

This property is read-only.

Data Type

String

service_provider_metadata_authn_request_signed property (SAMLDesktop Struct)

Whether the generated metadata document will inform the identity provider that this service provider will be sending signed requests.

Syntax

fn service_provider_metadata_authn_request_signed(&self ) -> Result<bool, CloudSSOError> 
fn set_service_provider_metadata_authn_request_signed(&self, value : bool) ->  Option<CloudSSOError> 

Default Value

false

Remarks

Whether the generated metadata document will inform the identity provider that this service provider will be sending signed requests.

Data Type

bool

service_provider_metadata_content property (SAMLDesktop Struct)

The raw XML document that represents the metadata document for the configured service provider.

Syntax

fn service_provider_metadata_content(&self ) -> Result<Vec<u8>, CloudSSOError> 
fn set_service_provider_metadata_content(&self, value : Vec<u8>) ->  Option<CloudSSOError> 
fn set_service_provider_metadata_content_ref(&self, value : &[u8]) ->  Option<CloudSSOError> 

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 method is used to generate a new document.

Data Type

Vec

service_provider_metadata_entity_id property (SAMLDesktop Struct)

The Entity Id for this service provider.

Syntax

fn service_provider_metadata_entity_id(&self ) -> Result<String, CloudSSOError> 
fn set_service_provider_metadata_entity_id(&self, value : &str) ->  Option<CloudSSOError> 
fn set_service_provider_metadata_entity_id_ref(&self, value : &String) ->  Option<CloudSSOError> 

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.

Data Type

String

service_provider_metadata_signed_metadata property (SAMLDesktop Struct)

Whether the struct will sign the metadata document when it is being generated.

Syntax

fn service_provider_metadata_signed_metadata(&self ) -> Result<bool, CloudSSOError> 
fn set_service_provider_metadata_signed_metadata(&self, value : bool) ->  Option<CloudSSOError> 

Default Value

false

Remarks

Whether the struct will sign the metadata document when it is being generated. When the build_service_metadata method is used to generate the metadata document, the struct will use the service_provider_signing_cert property to sign the document.

Data Type

bool

service_provider_metadata_supported_name_id_formats property (SAMLDesktop Struct)

A semicolon-separated list of NameId formats that are supported by this service provider.

Syntax

fn service_provider_metadata_supported_name_id_formats(&self ) -> Result<String, CloudSSOError> 
fn set_service_provider_metadata_supported_name_id_formats(&self, value : &str) ->  Option<CloudSSOError> 
fn set_service_provider_metadata_supported_name_id_formats_ref(&self, value : &String) ->  Option<CloudSSOError> 

Default Value

""

Remarks

A semicolon-separated list of NameId formats that are supported by this service provider.

Some common values are:

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

Data Type

String

service_provider_metadata_want_assertions_signed property (SAMLDesktop Struct)

Whether the metadata document will inform the identity provider that this service provider wants issued assertions to be signed.

Syntax

fn service_provider_metadata_want_assertions_signed(&self ) -> Result<bool, CloudSSOError> 
fn set_service_provider_metadata_want_assertions_signed(&self, value : bool) ->  Option<CloudSSOError> 

Default Value

false

Remarks

Whether the metadata document will inform the identity provider that this service provider wants issued assertions to be signed.

Data Type

bool

service_provider_signing_cert_effective_date property (SAMLDesktop Struct)

The date on which this certificate becomes valid.

Syntax

fn service_provider_signing_cert_effective_date(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

service_provider_signing_cert_expiration_date property (SAMLDesktop Struct)

The date on which the certificate expires.

Syntax

fn service_provider_signing_cert_expiration_date(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

service_provider_signing_cert_extended_key_usage property (SAMLDesktop Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn service_provider_signing_cert_extended_key_usage(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

service_provider_signing_cert_fingerprint property (SAMLDesktop Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn service_provider_signing_cert_fingerprint(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

service_provider_signing_cert_fingerprint_sha1 property (SAMLDesktop Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn service_provider_signing_cert_fingerprint_sha1(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

service_provider_signing_cert_fingerprint_sha256 property (SAMLDesktop Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn service_provider_signing_cert_fingerprint_sha256(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

service_provider_signing_cert_issuer property (SAMLDesktop Struct)

The issuer of the certificate.

Syntax

fn service_provider_signing_cert_issuer(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

service_provider_signing_cert_private_key property (SAMLDesktop Struct)

The private key of the certificate (if available).

Syntax

fn service_provider_signing_cert_private_key(&self ) -> Result<String, CloudSSOError> 

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 may be available but not exportable. In this case, service_provider_signing_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

service_provider_signing_cert_private_key_available property (SAMLDesktop Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn service_provider_signing_cert_private_key_available(&self ) -> Result<bool, CloudSSOError> 

Default Value

false

Remarks

Whether a service_provider_signing_cert_private_key is available for the selected certificate. If service_provider_signing_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

service_provider_signing_cert_private_key_container property (SAMLDesktop Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn service_provider_signing_cert_private_key_container(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The name of the service_provider_signing_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

service_provider_signing_cert_public_key property (SAMLDesktop Struct)

The public key of the certificate.

Syntax

fn service_provider_signing_cert_public_key(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

service_provider_signing_cert_public_key_algorithm property (SAMLDesktop Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn service_provider_signing_cert_public_key_algorithm(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

service_provider_signing_cert_public_key_length property (SAMLDesktop Struct)

The length of the certificate's public key (in bits).

Syntax

fn service_provider_signing_cert_public_key_length(&self ) -> Result<i32, CloudSSOError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

service_provider_signing_cert_serial_number property (SAMLDesktop Struct)

The serial number of the certificate encoded as a string.

Syntax

fn service_provider_signing_cert_serial_number(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

service_provider_signing_cert_signature_algorithm property (SAMLDesktop Struct)

The text description of the certificate's signature algorithm.

Syntax

fn service_provider_signing_cert_signature_algorithm(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

service_provider_signing_cert_store property (SAMLDesktop Struct)

The name of the certificate store for the client certificate.

Syntax

fn service_provider_signing_cert_store(&self ) -> Result<Vec<u8>, CloudSSOError> 
fn set_service_provider_signing_cert_store(&self, value : Vec<u8>) ->  Option<CloudSSOError> 
fn set_service_provider_signing_cert_store_ref(&self, value : &[u8]) ->  Option<CloudSSOError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The service_provider_signing_cert_store_type property denotes the type of the certificate store specified by service_provider_signing_cert_store. If the store is password-protected, specify the password in service_provider_signing_cert_store_password.

service_provider_signing_cert_store is used in conjunction with the service_provider_signing_cert_subject property to specify client certificates. If service_provider_signing_cert_store has a value, and service_provider_signing_cert_subject or service_provider_signing_cert_encoded is set, a search for a certificate is initiated. Please see the service_provider_signing_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

service_provider_signing_cert_store_password property (SAMLDesktop Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn service_provider_signing_cert_store_password(&self ) -> Result<String, CloudSSOError> 
fn set_service_provider_signing_cert_store_password(&self, value : &str) ->  Option<CloudSSOError> 
fn set_service_provider_signing_cert_store_password_ref(&self, value : &String) ->  Option<CloudSSOError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

service_provider_signing_cert_store_type property (SAMLDesktop Struct)

The type of certificate store for this certificate.

Syntax

fn service_provider_signing_cert_store_type(&self ) -> Result<i32, CloudSSOError> 
fn set_service_provider_signing_cert_store_type(&self, value : i32) ->  Option<CloudSSOError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

service_provider_signing_cert_subject_alt_names property (SAMLDesktop Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn service_provider_signing_cert_subject_alt_names(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

service_provider_signing_cert_thumbprint_md5 property (SAMLDesktop Struct)

The MD5 hash of the certificate.

Syntax

fn service_provider_signing_cert_thumbprint_md5(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

service_provider_signing_cert_thumbprint_sha1 property (SAMLDesktop Struct)

The SHA-1 hash of the certificate.

Syntax

fn service_provider_signing_cert_thumbprint_sha1(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

service_provider_signing_cert_thumbprint_sha256 property (SAMLDesktop Struct)

The SHA-256 hash of the certificate.

Syntax

fn service_provider_signing_cert_thumbprint_sha256(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

service_provider_signing_cert_usage property (SAMLDesktop Struct)

The text description of UsageFlags .

Syntax

fn service_provider_signing_cert_usage(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The text description of service_provider_signing_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

service_provider_signing_cert_usage_flags property (SAMLDesktop Struct)

The flags that show intended use for the certificate.

Syntax

fn service_provider_signing_cert_usage_flags(&self ) -> Result<i32, CloudSSOError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of service_provider_signing_cert_usage_flags is a combination of the following flags:

Please see the service_provider_signing_cert_usage property for a text representation of service_provider_signing_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

service_provider_signing_cert_version property (SAMLDesktop Struct)

The certificate's version number.

Syntax

fn service_provider_signing_cert_version(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

service_provider_signing_cert_subject property (SAMLDesktop Struct)

The subject of the certificate used for client authentication.

Syntax

fn service_provider_signing_cert_subject(&self ) -> Result<String, CloudSSOError> 
fn set_service_provider_signing_cert_subject(&self, value : &str) ->  Option<CloudSSOError> 
fn set_service_provider_signing_cert_subject_ref(&self, value : &String) ->  Option<CloudSSOError> 

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:

If a field value contains a comma, it must be quoted.

Data Type

String

service_provider_signing_cert_encoded property (SAMLDesktop Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn service_provider_signing_cert_encoded(&self ) -> Result<Vec<u8>, CloudSSOError> 
fn set_service_provider_signing_cert_encoded(&self, value : Vec<u8>) ->  Option<CloudSSOError> 
fn set_service_provider_signing_cert_encoded_ref(&self, value : &[u8]) ->  Option<CloudSSOError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The service_provider_signing_cert_store and service_provider_signing_cert_subject properties also may be used to specify a certificate.

When service_provider_signing_cert_encoded is set, a search is initiated in the current service_provider_signing_cert_store for the private key of the certificate. If the key is found, service_provider_signing_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, service_provider_signing_cert_subject is set to an empty string.

Data Type

Vec

ssl_accept_server_cert_effective_date property (SAMLDesktop Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_accept_server_cert_effective_date(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_expiration_date property (SAMLDesktop Struct)

The date on which the certificate expires.

Syntax

fn ssl_accept_server_cert_expiration_date(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_extended_key_usage property (SAMLDesktop Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_accept_server_cert_extended_key_usage(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint property (SAMLDesktop Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint_sha1 property (SAMLDesktop Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint_sha1(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint_sha256 property (SAMLDesktop Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint_sha256(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_accept_server_cert_issuer property (SAMLDesktop Struct)

The issuer of the certificate.

Syntax

fn ssl_accept_server_cert_issuer(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key property (SAMLDesktop Struct)

The private key of the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key(&self ) -> Result<String, CloudSSOError> 

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 may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key_available property (SAMLDesktop Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_accept_server_cert_private_key_available(&self ) -> Result<bool, CloudSSOError> 

Default Value

false

Remarks

Whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_accept_server_cert_private_key_container property (SAMLDesktop Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key_container(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key property (SAMLDesktop Struct)

The public key of the certificate.

Syntax

fn ssl_accept_server_cert_public_key(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_algorithm property (SAMLDesktop Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_accept_server_cert_public_key_algorithm(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_length property (SAMLDesktop Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_accept_server_cert_public_key_length(&self ) -> Result<i32, CloudSSOError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_accept_server_cert_serial_number property (SAMLDesktop Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_accept_server_cert_serial_number(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_accept_server_cert_signature_algorithm property (SAMLDesktop Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_accept_server_cert_signature_algorithm(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_accept_server_cert_store property (SAMLDesktop Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_accept_server_cert_store(&self ) -> Result<Vec<u8>, CloudSSOError> 
fn set_ssl_accept_server_cert_store(&self, value : Vec<u8>) ->  Option<CloudSSOError> 
fn set_ssl_accept_server_cert_store_ref(&self, value : &[u8]) ->  Option<CloudSSOError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password-protected, specify the password in ssl_accept_server_cert_store_password.

ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

ssl_accept_server_cert_store_password property (SAMLDesktop Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_accept_server_cert_store_password(&self ) -> Result<String, CloudSSOError> 
fn set_ssl_accept_server_cert_store_password(&self, value : &str) ->  Option<CloudSSOError> 
fn set_ssl_accept_server_cert_store_password_ref(&self, value : &String) ->  Option<CloudSSOError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

ssl_accept_server_cert_store_type property (SAMLDesktop Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_accept_server_cert_store_type(&self ) -> Result<i32, CloudSSOError> 
fn set_ssl_accept_server_cert_store_type(&self, value : i32) ->  Option<CloudSSOError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

ssl_accept_server_cert_subject_alt_names property (SAMLDesktop Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_accept_server_cert_subject_alt_names(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_md5 property (SAMLDesktop Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_md5(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_sha1 property (SAMLDesktop Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha1(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_sha256 property (SAMLDesktop Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha256(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_usage property (SAMLDesktop Struct)

The text description of UsageFlags .

Syntax

fn ssl_accept_server_cert_usage(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_accept_server_cert_usage_flags property (SAMLDesktop Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_accept_server_cert_usage_flags(&self ) -> Result<i32, CloudSSOError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_accept_server_cert_version property (SAMLDesktop Struct)

The certificate's version number.

Syntax

fn ssl_accept_server_cert_version(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_accept_server_cert_subject property (SAMLDesktop Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_accept_server_cert_subject(&self ) -> Result<String, CloudSSOError> 
fn set_ssl_accept_server_cert_subject(&self, value : &str) ->  Option<CloudSSOError> 
fn set_ssl_accept_server_cert_subject_ref(&self, value : &String) ->  Option<CloudSSOError> 

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:

If a field value contains a comma, it must be quoted.

Data Type

String

ssl_accept_server_cert_encoded property (SAMLDesktop Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_accept_server_cert_encoded(&self ) -> Result<Vec<u8>, CloudSSOError> 
fn set_ssl_accept_server_cert_encoded(&self, value : Vec<u8>) ->  Option<CloudSSOError> 
fn set_ssl_accept_server_cert_encoded_ref(&self, value : &[u8]) ->  Option<CloudSSOError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

Data Type

Vec

ssl_cert_effective_date property (SAMLDesktop Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_cert_effective_date(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_expiration_date property (SAMLDesktop Struct)

The date on which the certificate expires.

Syntax

fn ssl_cert_expiration_date(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_extended_key_usage property (SAMLDesktop Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_cert_extended_key_usage(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_cert_fingerprint property (SAMLDesktop Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha1 property (SAMLDesktop Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha1(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha256 property (SAMLDesktop Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha256(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_cert_issuer property (SAMLDesktop Struct)

The issuer of the certificate.

Syntax

fn ssl_cert_issuer(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_cert_private_key property (SAMLDesktop Struct)

The private key of the certificate (if available).

Syntax

fn ssl_cert_private_key(&self ) -> Result<String, CloudSSOError> 

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 may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_cert_private_key_available property (SAMLDesktop Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_cert_private_key_available(&self ) -> Result<bool, CloudSSOError> 

Default Value

false

Remarks

Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_cert_private_key_container property (SAMLDesktop Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_cert_private_key_container(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_cert_public_key property (SAMLDesktop Struct)

The public key of the certificate.

Syntax

fn ssl_cert_public_key(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_cert_public_key_algorithm property (SAMLDesktop Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_cert_public_key_algorithm(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_cert_public_key_length property (SAMLDesktop Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_cert_public_key_length(&self ) -> Result<i32, CloudSSOError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_cert_serial_number property (SAMLDesktop Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_cert_serial_number(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_cert_signature_algorithm property (SAMLDesktop Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_cert_signature_algorithm(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_cert_store property (SAMLDesktop Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_cert_store(&self ) -> Result<Vec<u8>, CloudSSOError> 
fn set_ssl_cert_store(&self, value : Vec<u8>) ->  Option<CloudSSOError> 
fn set_ssl_cert_store_ref(&self, value : &[u8]) ->  Option<CloudSSOError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

ssl_cert_store_password property (SAMLDesktop Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_cert_store_password(&self ) -> Result<String, CloudSSOError> 
fn set_ssl_cert_store_password(&self, value : &str) ->  Option<CloudSSOError> 
fn set_ssl_cert_store_password_ref(&self, value : &String) ->  Option<CloudSSOError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

ssl_cert_store_type property (SAMLDesktop Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_cert_store_type(&self ) -> Result<i32, CloudSSOError> 
fn set_ssl_cert_store_type(&self, value : i32) ->  Option<CloudSSOError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

ssl_cert_subject_alt_names property (SAMLDesktop Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_cert_subject_alt_names(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_md5 property (SAMLDesktop Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_md5(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha1 property (SAMLDesktop Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha1(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha256 property (SAMLDesktop Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha256(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_usage property (SAMLDesktop Struct)

The text description of UsageFlags .

Syntax

fn ssl_cert_usage(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_cert_usage_flags property (SAMLDesktop Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_cert_usage_flags(&self ) -> Result<i32, CloudSSOError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_cert_version property (SAMLDesktop Struct)

The certificate's version number.

Syntax

fn ssl_cert_version(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_cert_subject property (SAMLDesktop Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_cert_subject(&self ) -> Result<String, CloudSSOError> 
fn set_ssl_cert_subject(&self, value : &str) ->  Option<CloudSSOError> 
fn set_ssl_cert_subject_ref(&self, value : &String) ->  Option<CloudSSOError> 

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:

If a field value contains a comma, it must be quoted.

Data Type

String

ssl_cert_encoded property (SAMLDesktop Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_cert_encoded(&self ) -> Result<Vec<u8>, CloudSSOError> 
fn set_ssl_cert_encoded(&self, value : Vec<u8>) ->  Option<CloudSSOError> 
fn set_ssl_cert_encoded_ref(&self, value : &[u8]) ->  Option<CloudSSOError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

Data Type

Vec

ssl_provider property (SAMLDesktop Struct)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

fn ssl_provider(&self ) -> Result<i32, CloudSSOError> 
fn set_ssl_provider(&self, value : i32) ->  Option<CloudSSOError> 

Possible Values

0   // Automatic
1   // Platform
2   // Internal

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the struct will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

Additional Notes

In most cases using the default value (Automatic) is recommended. The struct will select a provider depending on the current platform.

When Automatic is selected, on Windows, the struct will use the platform implementation. On Linux/macOS, the struct will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the struct will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

Data Type

i32

ssl_server_cert_effective_date property (SAMLDesktop Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_server_cert_effective_date(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_expiration_date property (SAMLDesktop Struct)

The date on which the certificate expires.

Syntax

fn ssl_server_cert_expiration_date(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_extended_key_usage property (SAMLDesktop Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_server_cert_extended_key_usage(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint property (SAMLDesktop Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint_sha1 property (SAMLDesktop Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint_sha1(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint_sha256 property (SAMLDesktop Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint_sha256(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_server_cert_issuer property (SAMLDesktop Struct)

The issuer of the certificate.

Syntax

fn ssl_server_cert_issuer(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_server_cert_private_key property (SAMLDesktop Struct)

The private key of the certificate (if available).

Syntax

fn ssl_server_cert_private_key(&self ) -> Result<String, CloudSSOError> 

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 may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_server_cert_private_key_available property (SAMLDesktop Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_server_cert_private_key_available(&self ) -> Result<bool, CloudSSOError> 

Default Value

false

Remarks

Whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_server_cert_private_key_container property (SAMLDesktop Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_server_cert_private_key_container(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_server_cert_public_key property (SAMLDesktop Struct)

The public key of the certificate.

Syntax

fn ssl_server_cert_public_key(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_server_cert_public_key_algorithm property (SAMLDesktop Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_server_cert_public_key_algorithm(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_server_cert_public_key_length property (SAMLDesktop Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_server_cert_public_key_length(&self ) -> Result<i32, CloudSSOError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_server_cert_serial_number property (SAMLDesktop Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_server_cert_serial_number(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_server_cert_signature_algorithm property (SAMLDesktop Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_server_cert_signature_algorithm(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_server_cert_store property (SAMLDesktop Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_server_cert_store(&self ) -> Result<Vec<u8>, CloudSSOError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password-protected, specify the password in ssl_server_cert_store_password.

ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Vec

ssl_server_cert_store_password property (SAMLDesktop Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_server_cert_store_password(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

ssl_server_cert_store_type property (SAMLDesktop Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_server_cert_store_type(&self ) -> Result<i32, CloudSSOError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

i32

ssl_server_cert_subject_alt_names property (SAMLDesktop Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_server_cert_subject_alt_names(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_md5 property (SAMLDesktop Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_md5(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_sha1 property (SAMLDesktop Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha1(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_sha256 property (SAMLDesktop Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha256(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_usage property (SAMLDesktop Struct)

The text description of UsageFlags .

Syntax

fn ssl_server_cert_usage(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_server_cert_usage_flags property (SAMLDesktop Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_server_cert_usage_flags(&self ) -> Result<i32, CloudSSOError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_server_cert_version property (SAMLDesktop Struct)

The certificate's version number.

Syntax

fn ssl_server_cert_version(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_server_cert_subject property (SAMLDesktop Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_server_cert_subject(&self ) -> Result<String, CloudSSOError> 

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:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

ssl_server_cert_encoded property (SAMLDesktop Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_server_cert_encoded(&self ) -> Result<Vec<u8>, CloudSSOError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

Data Type

Vec

timeout property (SAMLDesktop Struct)

The timeout for the struct.

Syntax

fn timeout(&self ) -> Result<i32, CloudSSOError> 
fn set_timeout(&self, value : i32) ->  Option<CloudSSOError> 

Default Value

60

Remarks

If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If timeout is set to a positive value, the struct will wait for the operation to complete before returning control.

The struct will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If timeout expires, and the operation is not yet complete, the struct fails with an error.

NOTE: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 60 seconds.

Data Type

i32

web_server_bindings property (SAMLDesktop Struct)

The supported bindings used by the embedded web server.

Syntax

fn web_server_bindings(&self ) -> Result<i32, CloudSSOError> 
fn set_web_server_bindings(&self, value : i32) ->  Option<CloudSSOError> 

Possible Values

0   // Automatic
1   // Redirect
2   // 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 struct will support both the HTTP-Redirect and HTTP-POST bindings.

Possible values are as follows:

Along with controlling the web server that is started by calling authenticate_user or start_web_server, this setting also controls the endpoints added to the Service Provider metadata document when calling build_service_metadata.

Data Type

i32

web_server_port property (SAMLDesktop Struct)

The local port on which the embedded web server listens.

Syntax

fn web_server_port(&self ) -> Result<i32, CloudSSOError> 
fn set_web_server_port(&self, value : i32) ->  Option<CloudSSOError> 

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.

Data Type

i32

web_server_ssl_cert_effective_date property (SAMLDesktop Struct)

The date on which this certificate becomes valid.

Syntax

fn web_server_ssl_cert_effective_date(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

web_server_ssl_cert_expiration_date property (SAMLDesktop Struct)

The date on which the certificate expires.

Syntax

fn web_server_ssl_cert_expiration_date(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

web_server_ssl_cert_extended_key_usage property (SAMLDesktop Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn web_server_ssl_cert_extended_key_usage(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

web_server_ssl_cert_fingerprint property (SAMLDesktop Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn web_server_ssl_cert_fingerprint(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

web_server_ssl_cert_fingerprint_sha1 property (SAMLDesktop Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn web_server_ssl_cert_fingerprint_sha1(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

web_server_ssl_cert_fingerprint_sha256 property (SAMLDesktop Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn web_server_ssl_cert_fingerprint_sha256(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

web_server_ssl_cert_issuer property (SAMLDesktop Struct)

The issuer of the certificate.

Syntax

fn web_server_ssl_cert_issuer(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

web_server_ssl_cert_private_key property (SAMLDesktop Struct)

The private key of the certificate (if available).

Syntax

fn web_server_ssl_cert_private_key(&self ) -> Result<String, CloudSSOError> 

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 may be available but not exportable. In this case, web_server_ssl_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

web_server_ssl_cert_private_key_available property (SAMLDesktop Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn web_server_ssl_cert_private_key_available(&self ) -> Result<bool, CloudSSOError> 

Default Value

false

Remarks

Whether a web_server_ssl_cert_private_key is available for the selected certificate. If web_server_ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

web_server_ssl_cert_private_key_container property (SAMLDesktop Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn web_server_ssl_cert_private_key_container(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The name of the web_server_ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

web_server_ssl_cert_public_key property (SAMLDesktop Struct)

The public key of the certificate.

Syntax

fn web_server_ssl_cert_public_key(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

web_server_ssl_cert_public_key_algorithm property (SAMLDesktop Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn web_server_ssl_cert_public_key_algorithm(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

web_server_ssl_cert_public_key_length property (SAMLDesktop Struct)

The length of the certificate's public key (in bits).

Syntax

fn web_server_ssl_cert_public_key_length(&self ) -> Result<i32, CloudSSOError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

web_server_ssl_cert_serial_number property (SAMLDesktop Struct)

The serial number of the certificate encoded as a string.

Syntax

fn web_server_ssl_cert_serial_number(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

web_server_ssl_cert_signature_algorithm property (SAMLDesktop Struct)

The text description of the certificate's signature algorithm.

Syntax

fn web_server_ssl_cert_signature_algorithm(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

web_server_ssl_cert_store property (SAMLDesktop Struct)

The name of the certificate store for the client certificate.

Syntax

fn web_server_ssl_cert_store(&self ) -> Result<Vec<u8>, CloudSSOError> 
fn set_web_server_ssl_cert_store(&self, value : Vec<u8>) ->  Option<CloudSSOError> 
fn set_web_server_ssl_cert_store_ref(&self, value : &[u8]) ->  Option<CloudSSOError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The web_server_ssl_cert_store_type property denotes the type of the certificate store specified by web_server_ssl_cert_store. If the store is password-protected, specify the password in web_server_ssl_cert_store_password.

web_server_ssl_cert_store is used in conjunction with the web_server_ssl_cert_subject property to specify client certificates. If web_server_ssl_cert_store has a value, and web_server_ssl_cert_subject or web_server_ssl_cert_encoded is set, a search for a certificate is initiated. Please see the web_server_ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

web_server_ssl_cert_store_password property (SAMLDesktop Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn web_server_ssl_cert_store_password(&self ) -> Result<String, CloudSSOError> 
fn set_web_server_ssl_cert_store_password(&self, value : &str) ->  Option<CloudSSOError> 
fn set_web_server_ssl_cert_store_password_ref(&self, value : &String) ->  Option<CloudSSOError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

web_server_ssl_cert_store_type property (SAMLDesktop Struct)

The type of certificate store for this certificate.

Syntax

fn web_server_ssl_cert_store_type(&self ) -> Result<i32, CloudSSOError> 
fn set_web_server_ssl_cert_store_type(&self, value : i32) ->  Option<CloudSSOError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

web_server_ssl_cert_subject_alt_names property (SAMLDesktop Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn web_server_ssl_cert_subject_alt_names(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

web_server_ssl_cert_thumbprint_md5 property (SAMLDesktop Struct)

The MD5 hash of the certificate.

Syntax

fn web_server_ssl_cert_thumbprint_md5(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

web_server_ssl_cert_thumbprint_sha1 property (SAMLDesktop Struct)

The SHA-1 hash of the certificate.

Syntax

fn web_server_ssl_cert_thumbprint_sha1(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

web_server_ssl_cert_thumbprint_sha256 property (SAMLDesktop Struct)

The SHA-256 hash of the certificate.

Syntax

fn web_server_ssl_cert_thumbprint_sha256(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

web_server_ssl_cert_usage property (SAMLDesktop Struct)

The text description of UsageFlags .

Syntax

fn web_server_ssl_cert_usage(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The text description of web_server_ssl_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

web_server_ssl_cert_usage_flags property (SAMLDesktop Struct)

The flags that show intended use for the certificate.

Syntax

fn web_server_ssl_cert_usage_flags(&self ) -> Result<i32, CloudSSOError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of web_server_ssl_cert_usage_flags is a combination of the following flags:

Please see the web_server_ssl_cert_usage property for a text representation of web_server_ssl_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

web_server_ssl_cert_version property (SAMLDesktop Struct)

The certificate's version number.

Syntax

fn web_server_ssl_cert_version(&self ) -> Result<String, CloudSSOError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

web_server_ssl_cert_subject property (SAMLDesktop Struct)

The subject of the certificate used for client authentication.

Syntax

fn web_server_ssl_cert_subject(&self ) -> Result<String, CloudSSOError> 
fn set_web_server_ssl_cert_subject(&self, value : &str) ->  Option<CloudSSOError> 
fn set_web_server_ssl_cert_subject_ref(&self, value : &String) ->  Option<CloudSSOError> 

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:

If a field value contains a comma, it must be quoted.

Data Type

String

web_server_ssl_cert_encoded property (SAMLDesktop Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn web_server_ssl_cert_encoded(&self ) -> Result<Vec<u8>, CloudSSOError> 
fn set_web_server_ssl_cert_encoded(&self, value : Vec<u8>) ->  Option<CloudSSOError> 
fn set_web_server_ssl_cert_encoded_ref(&self, value : &[u8]) ->  Option<CloudSSOError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The web_server_ssl_cert_store and web_server_ssl_cert_subject properties also may be used to specify a certificate.

When web_server_ssl_cert_encoded is set, a search is initiated in the current web_server_ssl_cert_store for the private key of the certificate. If the key is found, web_server_ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, web_server_ssl_cert_subject is set to an empty string.

Data Type

Vec

web_server_ssl_enabled property (SAMLDesktop Struct)

Whether the web server requires Secure Sockets Layer (SSL) connections.

Syntax

fn web_server_ssl_enabled(&self ) -> Result<bool, CloudSSOError> 
fn set_web_server_ssl_enabled(&self, value : bool) ->  Option<CloudSSOError> 

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.

Data Type

bool

authenticate_user method (SAMLDesktop Struct)

Authenticates a user to the application.

Syntax

fn authenticate_user(&self) -> Result<(), CloudSSOError>

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_port
• web_server_ssl_enabled

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 struct 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 struct 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. 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 struct, 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
• validate_saml_response
• parse_assertion
• validate_assertion

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 can be considered authenticated to this application.

build_service_metadata method (SAMLDesktop Struct)

Builds a metadata document for a service provider.

Syntax

fn build_service_metadata(&self) -> Result<(), CloudSSOError>

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_entity_id
• service_provider_metadata_signed_metadata
• service_provider_metadata_supported_name_id_formats
• service_provider_metadata_want_assertions_signed
• return_url
• service_provider_signing_cert
• web_server_bindings
• web_server_port
• web_server_ssl_enabled

The service_provider_metadata_entity_id 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, the saml_request_settings_issuer property should be set to match this value.

The WebServer* settings should be set to allow the struct 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 struct. When this method completes, the return_url property will be set with this location as well. If a specific URI needs to be set instead, set the return_url property directly.

config method (SAMLDesktop Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, CloudSSOError>

Remarks

config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

do_events method (SAMLDesktop Struct)

This method processes events from the internal message queue.

Syntax

fn do_events(&self) -> Result<(), CloudSSOError>

Remarks

When do_events is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns.

get_assertion_attribute method (SAMLDesktop Struct)

Searches for a specific assertion attribute.

Syntax

fn get_assertion_attribute(&self, attr_name : &str) ->  Result<String, CloudSSOError>

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 (SAMLDesktop Struct)

This method interrupts the current method.

Syntax

fn interrupt(&self) -> Result<(), CloudSSOError>

Remarks

If there is no method in progress, interrupt simply returns, doing nothing.

load_identity_metadata method (SAMLDesktop Struct)

Loads an identity provider's metadata document.

Syntax

fn load_identity_metadata(&self, metadata_document : &str, validate : bool) -> Result<(), CloudSSOError>

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 (SAMLDesktop Struct)

Parses an assertion.

Syntax

fn parse_assertion(&self) -> Result<(), CloudSSOError>

Remarks

This method parses the assertion found in the assertion_info property. The raw assertion that is parsed provided to the struct by setting the assertion_content 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 (SAMLDesktop Struct)

Parses a SAML response.

Syntax

fn parse_saml_response(&self) -> Result<(), CloudSSOError>

Remarks

This method parses the SAML response found in the saml_response_info property by setting the saml_response_content 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.

Additionally, if the saml_response_type is srtAuthn, the assertion_content property will be populated. See validate_assertion and parse_assertion for more information on validating and parsing the assertion.

request_identity_metadata method (SAMLDesktop Struct)

Requests an identity provider's SAML metadata document.

Syntax

fn request_identity_metadata(&self, url : &str) -> Result<(), CloudSSOError>

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 (SAMLDesktop Struct)

This method will reset the struct.

Syntax

fn reset(&self) -> Result<(), CloudSSOError>

Remarks

This method will reset the struct's properties to their default values.

start_web_server method (SAMLDesktop Struct)

Starts the embedded web server.

Syntax

fn start_web_server(&self) -> Result<(), CloudSSOError>

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 is called. You may decide, however, to start the web server manually before calling authenticate_user. When called, this method will also populate return_url with the address of the embedded server if the property is empty.

stop_web_server method (SAMLDesktop Struct)

Stops the embedded web server.

Syntax

fn stop_web_server(&self) -> Result<(), CloudSSOError>

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 is called.

validate_assertion method (SAMLDesktop Struct)

Validates an assertion.

Syntax

fn validate_assertion(&self) -> Result<(), CloudSSOError>

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 property or by first calling parse_saml_response on a SAML response that contains an assertion. Before attempting this validation, the on_assertion event provides an opportunity to configure the struct 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:

To skip certain checks, see AssertionValidationFlags.

validate_saml_response method (SAMLDesktop Struct)

Validates a SAML response.

Syntax

fn validate_saml_response(&self) -> Result<(), CloudSSOError>

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 method. Before attempting validation, the on_saml_response event provides an opportunity to configure the struct to successfully validate the SAML response.

The following checks are performed on the SAML response:

To skip certain checks, see SAMLResponseValidationFlags. Note that this method does not validate the assertion if one is found within the SAML response. See validate_assertion and parse_assertion for more information on validating and parsing the assertion.

on_error event (SAMLDesktop Struct)

Fired when information is available about errors during data delivery.

Syntax

// SAMLDesktopErrorEventArgs carries the SAMLDesktop Error event's parameters.
pub struct SAMLDesktopErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// SAMLDesktopErrorEvent defines the signature of the SAMLDesktop Error event's handler function.
pub trait SAMLDesktopErrorEvent {
  fn on_error(&self, sender : SAMLDesktop, e : &mut SAMLDesktopErrorEventArgs);
}

impl <'a> SAMLDesktop<'a> {
  pub fn on_error(&self) -> &'a dyn SAMLDesktopErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn SAMLDesktopErrorEvent);
  ...
}

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct 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 section.

on_launch_browser event (SAMLDesktop Struct)

Fires before launching a browser with the SAML request.

Syntax

// SAMLDesktopLaunchBrowserEventArgs carries the SAMLDesktop LaunchBrowser event's parameters.
pub struct SAMLDesktopLaunchBrowserEventArgs {
  fn url(&self) -> &String
  fn set_url(&self, value : &str)
  fn set_url_ref(&self, value : &String)
  fn command(&self) -> &String
  fn set_command(&self, value : &str)
  fn set_command_ref(&self, value : &String)
}

// SAMLDesktopLaunchBrowserEvent defines the signature of the SAMLDesktop LaunchBrowser event's handler function.
pub trait SAMLDesktopLaunchBrowserEvent {
  fn on_launch_browser(&self, sender : SAMLDesktop, e : &mut SAMLDesktopLaunchBrowserEventArgs);
}

impl <'a> SAMLDesktop<'a> {
  pub fn on_launch_browser(&self) -> &'a dyn SAMLDesktopLaunchBrowserEvent;
  pub fn set_on_launch_browser(&mut self, value : &'a dyn SAMLDesktopLaunchBrowserEvent);
  ...
}

Remarks

When the authenticate_user method is called, the struct will fire this event with the Command, which will be executed by the struct. 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 struct will not attempt to launch the browser and instead you will be responsible for directing the user to the authorization URL specified by the URL parameter.

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 (SAMLDesktop Struct)

Fired once for each log message.

Syntax

// SAMLDesktopLogEventArgs carries the SAMLDesktop Log event's parameters.
pub struct SAMLDesktopLogEventArgs {
  fn log_level(&self) -> i32
  fn message(&self) -> &String
  fn log_type(&self) -> &String
}

// SAMLDesktopLogEvent defines the signature of the SAMLDesktop Log event's handler function.
pub trait SAMLDesktopLogEvent {
  fn on_log(&self, sender : SAMLDesktop, e : &mut SAMLDesktopLogEventArgs);
}

impl <'a> SAMLDesktop<'a> {
  pub fn on_log(&self) -> &'a dyn SAMLDesktopLogEvent;
  pub fn set_on_log(&mut self, value : &'a dyn SAMLDesktopLogEvent);
  ...
}

Remarks

This event is fired once for each log message generated by the struct. The verbosity is controlled by the LogLevel setting.

log_level indicates the level of message. Possible values are as follows:

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 (SAMLDesktop Struct)

Fired when a redirection is received from the server.

Syntax

// SAMLDesktopRedirectEventArgs carries the SAMLDesktop Redirect event's parameters.
pub struct SAMLDesktopRedirectEventArgs {
  fn location(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// SAMLDesktopRedirectEvent defines the signature of the SAMLDesktop Redirect event's handler function.
pub trait SAMLDesktopRedirectEvent {
  fn on_redirect(&self, sender : SAMLDesktop, e : &mut SAMLDesktopRedirectEventArgs);
}

impl <'a> SAMLDesktop<'a> {
  pub fn on_redirect(&self) -> &'a dyn SAMLDesktopRedirectEvent;
  pub fn set_on_redirect(&mut self, value : &'a dyn SAMLDesktopRedirectEvent);
  ...
}

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The accept parameter is always True by default, but if you do not want to follow the redirection, accept may be set to False, in which case the struct fails with an error. location is the location to which the client is being redirected. Further control over redirection is provided in the follow_redirects property.

on_return_url event (SAMLDesktop Struct)

Fired when the user is redirected to the embedded web server.

Syntax

// SAMLDesktopReturnURLEventArgs carries the SAMLDesktop ReturnURL event's parameters.
pub struct SAMLDesktopReturnURLEventArgs {
  fn url_path(&self) -> &String
  fn query_string(&self) -> &String
  fn response_headers(&self) -> &String
  fn set_response_headers(&self, value : &str)
  fn set_response_headers_ref(&self, value : &String)
  fn response_body(&self) -> &String
  fn set_response_body(&self, value : &str)
  fn set_response_body_ref(&self, value : &String)
}

// SAMLDesktopReturnURLEvent defines the signature of the SAMLDesktop ReturnURL event's handler function.
pub trait SAMLDesktopReturnURLEvent {
  fn on_return_url(&self, sender : SAMLDesktop, e : &mut SAMLDesktopReturnURLEventArgs);
}

impl <'a> SAMLDesktop<'a> {
  pub fn on_return_url(&self) -> &'a dyn SAMLDesktopReturnURLEvent;
  pub fn set_on_return_url(&mut self, value : &'a dyn SAMLDesktopReturnURLEvent);
  ...
}

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 (SAMLDesktop Struct)

Fired after the server presents its certificate to the client.

Syntax

// SAMLDesktopSSLServerAuthenticationEventArgs carries the SAMLDesktop SSLServerAuthentication event's parameters.
pub struct SAMLDesktopSSLServerAuthenticationEventArgs {
  fn cert_encoded(&self) -> &[u8]
  fn cert_subject(&self) -> &String
  fn cert_issuer(&self) -> &String
  fn status(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// SAMLDesktopSSLServerAuthenticationEvent defines the signature of the SAMLDesktop SSLServerAuthentication event's handler function.
pub trait SAMLDesktopSSLServerAuthenticationEvent {
  fn on_ssl_server_authentication(&self, sender : SAMLDesktop, e : &mut SAMLDesktopSSLServerAuthenticationEventArgs);
}

impl <'a> SAMLDesktop<'a> {
  pub fn on_ssl_server_authentication(&self) -> &'a dyn SAMLDesktopSSLServerAuthenticationEvent;
  pub fn set_on_ssl_server_authentication(&mut self, value : &'a dyn SAMLDesktopSSLServerAuthenticationEvent);
  ...
}

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 (SAMLDesktop Struct)

Fired when secure connection progress messages are available.

Syntax

// SAMLDesktopSSLStatusEventArgs carries the SAMLDesktop SSLStatus event's parameters.
pub struct SAMLDesktopSSLStatusEventArgs {
  fn message(&self) -> &String
}

// SAMLDesktopSSLStatusEvent defines the signature of the SAMLDesktop SSLStatus event's handler function.
pub trait SAMLDesktopSSLStatusEvent {
  fn on_ssl_status(&self, sender : SAMLDesktop, e : &mut SAMLDesktopSSLStatusEventArgs);
}

impl <'a> SAMLDesktop<'a> {
  pub fn on_ssl_status(&self) -> &'a dyn SAMLDesktopSSLStatusEvent;
  pub fn set_on_ssl_status(&mut self, value : &'a dyn SAMLDesktopSSLStatusEvent);
  ...
}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Config Settings (SAMLDesktop Struct)

The struct accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

SAMLDesktop Config Settings

WebServer Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (SAMLDesktop Struct)

SAMLDesktop Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors