Struct secureblackbox::SAMLIdPServer

Properties   Methods   Events   Config Settings   Errors  

The SAMLIdPServer struct represents a SAML identity provider.

Syntax

secureblackbox::SAMLIdPServer

Remarks

The identity provider in the SAML (Security Assertion Markup Language) exchange flow represents the server that issues authentication assertions for single sign-on (SSO).

Requests received by the IdP server from known service providers (SP) are processed automatically, in accordance with known SP metadata and IdP options. If the request is correct, the client is redirected to the IdP for authentication. The authentication algorithm depends on the IdP options and may be reduced to a simple IP check, X.509 certificate authentication, or login credentials check.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by SecureBlackbox. Due to this, the SAMLIdPServer struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of SAMLIdPServer 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.

active property (SAMLIdPServer Struct)

Tells whether the server is active and ready to process requests.

Syntax

fn active(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

This property indicates whether the IdP server is in an active state.

This property is read-only.

Data Type

bool

allow_idpsso property (SAMLIdPServer Struct)

Specifies if IdP-initiated Single Sign-On (SSO) is allowed.

Syntax

fn allow_idpsso(&self ) -> Result<bool, SecureBlackboxError> 
fn set_allow_idpsso(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Set this property to true to allow IdP-initiated Single Sign-Ons. Use the IdPSSOLink parameter of add_sp method to add sign-on URLs.

Data Type

bool

base_dir property (SAMLIdPServer Struct)

Base directory on the server.

Syntax

fn base_dir(&self ) -> Result<String, SecureBlackboxError> 
fn set_base_dir(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_base_dir_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to specify the base directory for the SP server.

Data Type

String

binding_key_handle property (SAMLIdPServer Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn binding_key_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_binding_key_handle(&self, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

Data Type

i64

encryption_cert_bytes property (SAMLIdPServer Struct)

Returns the raw certificate data in DER format.

Syntax

fn encryption_cert_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

Vec

encryption_cert_handle property (SAMLIdPServer Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn encryption_cert_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_encryption_cert_handle(&self, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

Data Type

i64

external_crypto_async_document_id property (SAMLIdPServer Struct)

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

fn external_crypto_async_document_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_async_document_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_async_document_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

external_crypto_custom_params property (SAMLIdPServer Struct)

Custom parameters to be passed to the signing service (uninterpreted).

Syntax

fn external_crypto_custom_params(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_custom_params(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_custom_params_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

Data Type

String

external_crypto_data property (SAMLIdPServer Struct)

Additional data to be included in the async state and mirrored back by the requestor.

Syntax

fn external_crypto_data(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_data(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_data_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Additional data to be included in the async state and mirrored back by the requestor.

Data Type

String

external_crypto_external_hash_calculation property (SAMLIdPServer Struct)

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

fn external_crypto_external_hash_calculation(&self ) -> Result<bool, SecureBlackboxError> 
fn set_external_crypto_external_hash_calculation(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth struct.

If set to true, the struct will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

Data Type

bool

external_crypto_hash_algorithm property (SAMLIdPServer Struct)

Specifies the request's signature hash algorithm.

Syntax

fn external_crypto_hash_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_hash_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_hash_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

external_crypto_key_id property (SAMLIdPServer Struct)

The ID of the pre-shared key used for DC request authentication.

Syntax

fn external_crypto_key_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_key_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_key_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use external_crypto_key_secret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

external_crypto_key_secret property (SAMLIdPServer Struct)

The pre-shared key used for DC request authentication.

Syntax

fn external_crypto_key_secret(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_key_secret(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_key_secret_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the external_crypto_key_id topic.

Data Type

String

external_crypto_method property (SAMLIdPServer Struct)

Specifies the asynchronous signing method.

Syntax

fn external_crypto_method(&self ) -> Result<i32, SecureBlackboxError> 
fn set_external_crypto_method(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // PKCS1
1   // PKCS7

Default Value

0

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

Data Type

i32

external_crypto_mode property (SAMLIdPServer Struct)

Specifies the external cryptography mode.

Syntax

fn external_crypto_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_external_crypto_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // Disabled
2   // Generic
3   // DCAuth
4   // DCAuthJSON

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

Data Type

i32

external_crypto_public_key_algorithm property (SAMLIdPServer Struct)

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Syntax

fn external_crypto_public_key_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_public_key_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_public_key_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Data Type

String

fips_mode property (SAMLIdPServer Struct)

Reserved.

Syntax

fn fips_mode(&self ) -> Result<bool, SecureBlackboxError> 
fn set_fips_mode(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

This property is reserved for future use.

Data Type

bool

handshake_timeout property (SAMLIdPServer Struct)

Specifies the handshake timeout in milliseconds.

Syntax

fn handshake_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_handshake_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Data Type

i32

host property (SAMLIdPServer Struct)

Specifies the host address of the IdP server.

Syntax

fn host(&self ) -> Result<String, SecureBlackboxError> 
fn set_host(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_host_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to specify the IP address on which to listen to incoming connections. To specify the listening port number, use port.

Data Type

String

id_p_service_count property (SAMLIdPServer Struct)

The number of records in the IdPService arrays.

Syntax

fn id_p_service_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• id_p_service_binding_type
• id_p_service_entity_id
• id_p_service_location
• id_p_service_priority
• id_p_service_service
• id_p_service_service_index

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

This property is read-only.

Data Type

i32

id_p_service_binding_type property (SAMLIdPServer Struct)

Specifies the type of SAML binding that this endpoint accepts.

Syntax

fn id_p_service_binding_type(&self , IdPServiceIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // None
1   // SOAP
2   // PAOS
3   // Redirect
4   // POST
5   // Artifact

Default Value

0

Remarks

Specifies the type of SAML binding that this endpoint accepts.

Use this property to specify the binding type to use with this endpoint.

The IdPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.

This property is read-only.

Data Type

i32

id_p_service_entity_id property (SAMLIdPServer Struct)

Represents the SAML entity ID.

Syntax

fn id_p_service_entity_id(&self , IdPServiceIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Represents the SAML entity ID.

Use this property to read or set the unique SAML entity ID. This is often the URI of the web endpoint (such as https://sp.myserver.com).

The IdPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.

This property is read-only.

Data Type

String

id_p_service_location property (SAMLIdPServer Struct)

The location (URL) of the endpoint.

Syntax

fn id_p_service_location(&self , IdPServiceIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The location (URL) of the endpoint.

The IdPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.

This property is read-only.

Data Type

String

id_p_service_priority property (SAMLIdPServer Struct)

The priority of the endpoint in relation to other endpoints with the same Location .

Syntax

fn id_p_service_priority(&self , IdPServiceIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

-1

Remarks

The priority of the endpoint in relation to other endpoints with the same id_p_location.

Indicates the relative priority of the endpoint. Use this setting to adjust priority of certain binding types before others. When composing the metadata XML, the endpoint with the highest priority gets described with a Default attribute.

Leave all priorities at -1 to omit generation of the Default attribute.

The IdPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.

This property is read-only.

Data Type

i32

id_p_service_service property (SAMLIdPServer Struct)

The kind of the service being provided at this endpoint.

Syntax

fn id_p_service_service(&self , IdPServiceIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The kind of the service being provided at this endpoint.

The Service setting returns the kind of the service that is being provided at this endpoint. Typical SP services are AssertionConsumerService and ArtifactResolutionService. Typical IdP services are SingleSignOnService, SingleLogoutService, and ArtifactResolutionService.

The IdPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.

This property is read-only.

Data Type

i32

id_p_service_service_index property (SAMLIdPServer Struct)

The index of this endpoint.

Syntax

fn id_p_service_service_index(&self , IdPServiceIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The index of this endpoint.

For endpoints that can accept requests via multiple bindings, Index is used to distinguish between individual endpoint specifiers.

The IdPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.

This property is read-only.

Data Type

i32

id_p_contact_person property (SAMLIdPServer Struct)

The contact person or persons for the entity.

Syntax

fn id_p_contact_person(&self ) -> Result<String, SecureBlackboxError> 
fn set_id_p_contact_person(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_id_p_contact_person_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The contact person or persons for the entity.

SAML assumes that more than one contact person can be specified. Each line of this potentially multi-line property contains one such record.

Each record contains a semicolon-separated list of contact person parameters, for example:

Company=My Company;EmailAddress=info@company.com;TelephoneNumber=+012345678;Type=other

Company=My Company;EmailAddress=info@company.com;TelephoneNumber=+012345678;Type=technical;Extension.https://spid.gov.it/saml-extensions.VATNumber=IT122345678

You can use LoadNameValuePairs and SaveNameValuePairs methods of the Utils class to process content of this property.

Data Type

String

id_p_encryption_key property (SAMLIdPServer Struct)

Contains the entity's encryption key.

Syntax

fn id_p_encryption_key(&self ) -> Result<String, SecureBlackboxError> 
fn set_id_p_encryption_key(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_id_p_encryption_key_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the entity's encryption key.

This setting returns the entity's public encryption key. In most cases this is in the form of a DER-encoded X.509 certificate. This property cannot be set in code; it is either taken from the processed metadata file (for other-party settings), or derived from the locally set EncryptionCertificate setting (for this-party settings).

Requests sent to the endpoint can be encrypted with the provided key or certificate.

Data Type

String

id_p_encryption_methods property (SAMLIdPServer Struct)

Specifies the list of encryption methods supported by the entity.

Syntax

fn id_p_encryption_methods(&self ) -> Result<String, SecureBlackboxError> 
fn set_id_p_encryption_methods(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_id_p_encryption_methods_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the list of encryption methods supported by the entity.

This setting contains a list of encryption methods, in form of XML-ENC URLs separated with newline characters, supported by the entity. These can be considered when encrypting messages destined for this entity.

Examples of algorithms supported by this property:

• http://www.w3.org/2009/xmlenc11#aes128-gcm
• http://www.w3.org/2001/04/xmlenc#aes256-cbc

Data Type

String

id_p_entity_id property (SAMLIdPServer Struct)

Represents the SAML entity ID.

Syntax

fn id_p_entity_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_id_p_entity_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_id_p_entity_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Represents the SAML entity ID.

Use this property to read or set the unique SAML entity ID. This is often the URI of the web endpoint (such as https://sp.myserver.com).

Data Type

String

id_p_flags property (SAMLIdPServer Struct)

Adjusts secondary entity properties.

Syntax

fn id_p_flags(&self ) -> Result<i32, SecureBlackboxError> 
fn set_id_p_flags(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Adjusts secondary entity properties.

Use this bit mask property to adjust certain secondary settings. The following flags are supported:

• 1 - sefRequireSignedRequests - the provider expects the consumers to sign requests they send in.

Data Type

i32

id_psso_link property (SAMLIdPServer Struct)

Contains a local server page link that triggers SAML authentication to the SP.

Syntax

fn id_psso_link(&self ) -> Result<String, SecureBlackboxError> 
fn set_id_psso_link(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_id_psso_link_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains a local server page link that triggers SAML authentication to the SP.

This property specifies the web link that initiates the transfer of SAML authentication fact to the SP.

One scenario where this property can be used is triggering the assertion dispatch in IdP-initiated SSO flows. Navigating to the link will make the IdP server generate the authentication assertion (if the user had been authenticated) and forward this assertion to the respective service provider.

Data Type

String

id_p_name_id_formats property (SAMLIdPServer Struct)

The list of NameID formats supported by this entity.

Syntax

fn id_p_name_id_formats(&self ) -> Result<String, SecureBlackboxError> 
fn set_id_p_name_id_formats(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_id_p_name_id_formats_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The list of NameID formats supported by this entity.

Use this setting to get or set the list of NameID formats supported by the entity.

Use SAML notation for the formats:

• urn:oasis:names:tc:SAML:2.0:nameid-format:transient
• urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
• urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress

Data Type

String

id_p_organization_display_name property (SAMLIdPServer Struct)

The friendly name of the organization that maintains the entity.

Syntax

fn id_p_organization_display_name(&self ) -> Result<String, SecureBlackboxError> 
fn set_id_p_organization_display_name(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_id_p_organization_display_name_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The friendly name of the organization that maintains the entity.

Use this setting to get or set the user-friendly name of the organization that maintains the SAML entity.

Data Type

String

id_p_organization_lang property (SAMLIdPServer Struct)

The language preferred by the organization.

Syntax

fn id_p_organization_lang(&self ) -> Result<String, SecureBlackboxError> 
fn set_id_p_organization_lang(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_id_p_organization_lang_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The language preferred by the organization.

This optional setting can be used to adjust the preferred language of the owning organization.

Data Type

String

id_p_organization_name property (SAMLIdPServer Struct)

The name of the organization that maintains the entity.

Syntax

fn id_p_organization_name(&self ) -> Result<String, SecureBlackboxError> 
fn set_id_p_organization_name(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_id_p_organization_name_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The name of the organization that maintains the entity.

Use this setting to get or set the name of the organization that maintains the SAML entity.

Data Type

String

id_p_organization_url property (SAMLIdPServer Struct)

The web URL of the organization that maintains the entity.

Syntax

fn id_p_organization_url(&self ) -> Result<String, SecureBlackboxError> 
fn set_id_p_organization_url(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_id_p_organization_url_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The web URL of the organization that maintains the entity.

Use this setting to get or set the web address of the organization responsible for this SAML entity.

Data Type

String

id_p_signature_validation_result property (SAMLIdPServer Struct)

The outcome of the cryptographic signature validation.

Syntax

fn id_p_signature_validation_result(&self ) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Valid
1   // Unknown
2   // Corrupted
3   // SignerNotFound
4   // Failure
5   // ReferenceCorrupted

Default Value

0

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

This property is read-only.

Data Type

i32

id_p_signed property (SAMLIdPServer Struct)

Specifies whether the SAML entity information is or should be signed.

Syntax

fn id_p_signed(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether the SAML entity information is or should be signed.

Check this property to find out whether the metadata was signed by the sender, or set this property to true to indicate that the created metadata should be signed.

This property is read-only.

Data Type

bool

id_p_signed_with property (SAMLIdPServer Struct)

Contains the certificate or key that was used to sign the settings (metadata) document.

Syntax

fn id_p_signed_with(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the certificate or key that was used to sign the settings (metadata) document.

This setting returns the public part of the metadata signing key. In most cases this is in the form of a DER-encoded X.509 certificate.

The value of this property is retrieved from the metadata file when it is loaded with the ImportSettings call. If the metadata is signed, you can check the integrity of the signature using the id_p_signature_validation_result setting.

This property is read-only.

Data Type

String

id_p_signing_key property (SAMLIdPServer Struct)

Contains the entity's signing key.

Syntax

fn id_p_signing_key(&self ) -> Result<String, SecureBlackboxError> 
fn set_id_p_signing_key(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_id_p_signing_key_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the entity's signing key.

This setting returns the public part of the entity's signing key. In most cases this is in the form of a PKCS#1 RSA or ECDSA key.

The signing key is used to sign message conveyed over Redirect binding. Redirect signatures are simpler than SAML message signatures and are made with raw keys rather than certificates.

Data Type

String

id_p_valid_until property (SAMLIdPServer Struct)

Specifies the expiration time of the SAML entity information.

Syntax

fn id_p_valid_until(&self ) -> Result<String, SecureBlackboxError> 
fn set_id_p_valid_until(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_id_p_valid_until_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the expiration time of the SAML entity information.

This setting only makes sense when the information was loaded or is going to be saved to a metadata XML.

Data Type

String

id_psso_page property (SAMLIdPServer Struct)

Specifies the relative URL of the IdP-initiated SSO page.

Syntax

fn id_psso_page(&self ) -> Result<String, SecureBlackboxError> 
fn set_id_psso_page(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_id_psso_page_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"/idpsso"

Remarks

Use this property to specify the address of the Single Sign-On (SSO) page initiated by this Identity Provider (IdP).

Data Type

String

id_psso_page_template property (SAMLIdPServer Struct)

The content of the IdP-initiated SSO page.

Syntax

fn id_psso_page_template(&self ) -> Result<String, SecureBlackboxError> 
fn set_id_psso_page_template(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_id_psso_page_template_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to specify the content of the Single Sign-On (SSO) page initiated by this Identity Provider (IdP).

Data Type

String

known_cert_count property (SAMLIdPServer Struct)

The number of records in the KnownCert arrays.

Syntax

fn known_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_known_cert_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• known_cert_bytes
• known_cert_handle

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

Data Type

i32

known_cert_bytes property (SAMLIdPServer Struct)

Returns the raw certificate data in DER format.

Syntax

fn known_cert_bytes(&self , KnownCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

Vec

known_cert_handle property (SAMLIdPServer Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn known_cert_handle(&self , KnownCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_known_cert_handle(&self, KnownCertIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

Data Type

i64

known_key_count property (SAMLIdPServer Struct)

The number of records in the KnownKey arrays.

Syntax

fn known_key_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_known_key_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• known_key_handle

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

Data Type

i32

known_key_handle property (SAMLIdPServer Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn known_key_handle(&self , KnownKeyIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_known_key_handle(&self, KnownKeyIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownKeyCount property.

Data Type

i64

login_attempts_limit property (SAMLIdPServer Struct)

The maximum number of login attempts.

Syntax

fn login_attempts_limit(&self ) -> Result<i32, SecureBlackboxError> 
fn set_login_attempts_limit(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

3

Remarks

Use this property to set the maximum number of login attempts.

Data Type

i32

metadata_url property (SAMLIdPServer Struct)

The IdP's metadata location.

Syntax

fn metadata_url(&self ) -> Result<String, SecureBlackboxError> 
fn set_metadata_url(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_metadata_url_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"/idp/metadata"

Remarks

This property specifies the metadata URL of this Identity Provider (IdP).

Data Type

String

meta_signing_cert_bytes property (SAMLIdPServer Struct)

Returns the raw certificate data in DER format.

Syntax

fn meta_signing_cert_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

Vec

meta_signing_cert_handle property (SAMLIdPServer Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn meta_signing_cert_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_meta_signing_cert_handle(&self, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

Data Type

i64

offline_mode property (SAMLIdPServer Struct)

Enables the Offline mode.

Syntax

fn offline_mode(&self ) -> Result<bool, SecureBlackboxError> 
fn set_offline_mode(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

true

Remarks

In the Offline mode the server does not open the listening port. Instead, it expects incoming requests to be routed by the application via calls to process_sign_on_request, process_logout_request, process_sign_on_response, and other similar methods.

The Offline mode is a handy mechanism for attaching the server to external web engines, such as IIS or Tomcat. It lets you leave the HTTP matters to the engine, and only be responsible for handling the actual SAML requests.

Data Type

bool

pinned_client_aead_cipher property (SAMLIdPServer Struct)

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

fn pinned_client_aead_cipher(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

This property is read-only.

Data Type

bool

pinned_client_chain_validation_details property (SAMLIdPServer Struct)

The details of a certificate chain validation outcome.

Syntax

fn pinned_client_chain_validation_details(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

This property is read-only.

Data Type

i32

pinned_client_chain_validation_result property (SAMLIdPServer Struct)

The outcome of a certificate chain validation routine.

Syntax

fn pinned_client_chain_validation_result(&self ) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Valid
1   // ValidButUntrusted
2   // Invalid
3   // CantBeEstablished

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

This property is read-only.

Data Type

i32

pinned_client_ciphersuite property (SAMLIdPServer Struct)

The cipher suite employed by this connection.

Syntax

fn pinned_client_ciphersuite(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The cipher suite employed by this connection.

For TLS connections, this property returns the ciphersuite that was/is employed by the connection.

This property is read-only.

Data Type

String

pinned_client_client_authenticated property (SAMLIdPServer Struct)

Specifies whether client authentication was performed during this connection.

Syntax

fn pinned_client_client_authenticated(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether client authentication was performed during this connection.

This property is read-only.

Data Type

bool

pinned_client_client_auth_requested property (SAMLIdPServer Struct)

Specifies whether client authentication was requested during this connection.

Syntax

fn pinned_client_client_auth_requested(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether client authentication was requested during this connection.

This property is read-only.

Data Type

bool

pinned_client_connection_established property (SAMLIdPServer Struct)

Indicates whether the connection has been established fully.

Syntax

fn pinned_client_connection_established(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the connection has been established fully.

This property is read-only.

Data Type

bool

pinned_client_connection_id property (SAMLIdPServer Struct)

The unique identifier assigned to this connection.

Syntax

fn pinned_client_connection_id(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

The unique identifier assigned to this connection.

This property is read-only.

Data Type

Vec

pinned_client_digest_algorithm property (SAMLIdPServer Struct)

The digest algorithm used in a TLS-enabled connection.

Syntax

fn pinned_client_digest_algorithm(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The digest algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

String

pinned_client_encryption_algorithm property (SAMLIdPServer Struct)

The symmetric encryption algorithm used in a TLS-enabled connection.

Syntax

fn pinned_client_encryption_algorithm(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The symmetric encryption algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

String

pinned_client_exportable property (SAMLIdPServer Struct)

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

Syntax

fn pinned_client_exportable(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

This property is read-only.

Data Type

bool

pinned_client_group property (SAMLIdPServer Struct)

The elliptic curve used in this connection.

Syntax

fn pinned_client_group(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The elliptic curve used in this connection.

This property was named NamedECCurve in SecureBlackbox 2024 and earlier versions.

This property is read-only.

Data Type

String

pinned_client_id property (SAMLIdPServer Struct)

The client connection's unique identifier.

Syntax

fn pinned_client_id(&self ) -> Result<i64, SecureBlackboxError> 

Default Value

-1

Remarks

The client connection's unique identifier. This value is used throughout to refer to a particular client connection.

This property is read-only.

Data Type

i64

pinned_client_key_exchange_algorithm property (SAMLIdPServer Struct)

The key exchange algorithm used in a TLS-enabled connection.

Syntax

fn pinned_client_key_exchange_algorithm(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The key exchange algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

String

pinned_client_key_exchange_key_bits property (SAMLIdPServer Struct)

The length of the key exchange key of a TLS-enabled connection.

Syntax

fn pinned_client_key_exchange_key_bits(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The length of the key exchange key of a TLS-enabled connection.

This property is read-only.

Data Type

i32

pinned_client_pfs_cipher property (SAMLIdPServer Struct)

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

Syntax

fn pinned_client_pfs_cipher(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

This property is read-only.

Data Type

bool

pinned_client_pre_shared_identity property (SAMLIdPServer Struct)

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

fn pinned_client_pre_shared_identity(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

This property is read-only.

Data Type

String

pinned_client_pre_shared_identity_hint property (SAMLIdPServer Struct)

A hint professed by the server to help the client select the PSK identity to use.

Syntax

fn pinned_client_pre_shared_identity_hint(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

A hint professed by the server to help the client select the PSK identity to use.

This property is read-only.

Data Type

String

pinned_client_public_key_bits property (SAMLIdPServer Struct)

The length of the public key.

Syntax

fn pinned_client_public_key_bits(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The length of the public key.

This property is read-only.

Data Type

i32

pinned_client_remote_address property (SAMLIdPServer Struct)

The client's IP address.

Syntax

fn pinned_client_remote_address(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The client's IP address.

This property is read-only.

Data Type

String

pinned_client_remote_port property (SAMLIdPServer Struct)

The remote port of the client connection.

Syntax

fn pinned_client_remote_port(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The remote port of the client connection.

This property is read-only.

Data Type

i32

pinned_client_resumed_session property (SAMLIdPServer Struct)

Indicates whether a TLS-enabled connection was spawned from another TLS connection.

Syntax

fn pinned_client_resumed_session(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether a TLS-enabled connection was spawned from another TLS connection

This property is read-only.

Data Type

bool

pinned_client_secure_connection property (SAMLIdPServer Struct)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

fn pinned_client_secure_connection(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether TLS or SSL is enabled for this connection.

This property is read-only.

Data Type

bool

pinned_client_server_authenticated property (SAMLIdPServer Struct)

Indicates whether server authentication was performed during a TLS-enabled connection.

Syntax

fn pinned_client_server_authenticated(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether server authentication was performed during a TLS-enabled connection.

This property is read-only.

Data Type

bool

pinned_client_signature_algorithm property (SAMLIdPServer Struct)

The signature algorithm used in a TLS handshake.

Syntax

fn pinned_client_signature_algorithm(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The signature algorithm used in a TLS handshake.

This property is read-only.

Data Type

String

pinned_client_symmetric_block_size property (SAMLIdPServer Struct)

The block size of the symmetric algorithm used.

Syntax

fn pinned_client_symmetric_block_size(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The block size of the symmetric algorithm used.

This property is read-only.

Data Type

i32

pinned_client_symmetric_key_bits property (SAMLIdPServer Struct)

The key length of the symmetric algorithm used.

Syntax

fn pinned_client_symmetric_key_bits(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The key length of the symmetric algorithm used.

This property is read-only.

Data Type

i32

pinned_client_total_bytes_received property (SAMLIdPServer Struct)

The total number of bytes received over this connection.

Syntax

fn pinned_client_total_bytes_received(&self ) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

The total number of bytes received over this connection.

This property is read-only.

Data Type

i64

pinned_client_total_bytes_sent property (SAMLIdPServer Struct)

The total number of bytes sent over this connection.

Syntax

fn pinned_client_total_bytes_sent(&self ) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

The total number of bytes sent over this connection.

This property is read-only.

Data Type

i64

pinned_client_validation_log property (SAMLIdPServer Struct)

Contains the server certificate's chain validation log.

Syntax

fn pinned_client_validation_log(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.

This property is read-only.

Data Type

String

pinned_client_version property (SAMLIdPServer Struct)

Indicates the version of SSL/TLS protocol negotiated during this connection.

Syntax

fn pinned_client_version(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Indicates the version of SSL/TLS protocol negotiated during this connection.

This property is read-only.

Data Type

String

pinned_client_cert_count property (SAMLIdPServer Struct)

The number of records in the PinnedClientCert arrays.

Syntax

fn pinned_client_cert_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• pinned_client_cert_bytes
• pinned_client_cert_ca_key_id
• pinned_client_cert_fingerprint
• pinned_client_cert_handle
• pinned_client_cert_issuer
• pinned_client_cert_issuer_rdn
• pinned_client_cert_key_algorithm
• pinned_client_cert_key_bits
• pinned_client_cert_key_fingerprint
• pinned_client_cert_key_usage
• pinned_client_cert_public_key_bytes
• pinned_client_cert_self_signed
• pinned_client_cert_serial_number
• pinned_client_cert_sig_algorithm
• pinned_client_cert_subject
• pinned_client_cert_subject_key_id
• pinned_client_cert_subject_rdn
• pinned_client_cert_valid_from
• pinned_client_cert_valid_to

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

This property is read-only.

Data Type

i32

pinned_client_cert_bytes property (SAMLIdPServer Struct)

Returns the raw certificate data in DER format.

Syntax

fn pinned_client_cert_bytes(&self , PinnedClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

Vec

pinned_client_cert_ca_key_id property (SAMLIdPServer Struct)

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Syntax

fn pinned_client_cert_ca_key_id(&self , PinnedClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the pinned_client_cert_subject_key_id setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

Vec

pinned_client_cert_fingerprint property (SAMLIdPServer Struct)

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

fn pinned_client_cert_fingerprint(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_handle property (SAMLIdPServer Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn pinned_client_cert_handle(&self , PinnedClientCertIndex : i32) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

i64

pinned_client_cert_issuer property (SAMLIdPServer Struct)

The common name of the certificate issuer (CA), typically a company name.

Syntax

fn pinned_client_cert_issuer(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via pinned_client_cert_issuer_rdn.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_issuer_rdn property (SAMLIdPServer Struct)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

fn pinned_client_cert_issuer_rdn(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_key_algorithm property (SAMLIdPServer Struct)

Specifies the public key algorithm of this certificate.

Syntax

fn pinned_client_cert_key_algorithm(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the pinned_client_cert_key_bits, pinned_client_cert_curve, and pinned_client_cert_public_key_bytes properties to get more details about the key the certificate contains.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_key_bits property (SAMLIdPServer Struct)

Returns the length of the public key in bits.

Syntax

fn pinned_client_cert_key_bits(&self , PinnedClientCertIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the pinned_client_cert_public_key_bytes or pinned_client_cert_private_key_bytes property would typically contain auxiliary values, and therefore be longer.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

i32

pinned_client_cert_key_fingerprint property (SAMLIdPServer Struct)

Returns a SHA1 fingerprint of the public key contained in the certificate.

Syntax

fn pinned_client_cert_key_fingerprint(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Returns a SHA1 fingerprint of the public key contained in the certificate.

Note that the key fingerprint is different from the certificate fingerprint accessible via the pinned_client_cert_fingerprint property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_key_usage property (SAMLIdPServer Struct)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

fn pinned_client_cert_key_usage(&self , PinnedClientCertIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

i32

pinned_client_cert_public_key_bytes property (SAMLIdPServer Struct)

Contains the certificate's public key in DER format.

Syntax

fn pinned_client_cert_public_key_bytes(&self , PinnedClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

Vec

pinned_client_cert_self_signed property (SAMLIdPServer Struct)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

fn pinned_client_cert_self_signed(&self , PinnedClientCertIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

bool

pinned_client_cert_serial_number property (SAMLIdPServer Struct)

Returns the certificate's serial number.

Syntax

fn pinned_client_cert_serial_number(&self , PinnedClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

Vec

pinned_client_cert_sig_algorithm property (SAMLIdPServer Struct)

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

fn pinned_client_cert_sig_algorithm(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_subject property (SAMLIdPServer Struct)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

fn pinned_client_cert_subject(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via pinned_client_cert_subject_rdn.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_subject_key_id property (SAMLIdPServer Struct)

Contains a unique identifier of the certificate's cryptographic key.

Syntax

fn pinned_client_cert_subject_key_id(&self , PinnedClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The pinned_client_cert_subject_key_id and pinned_client_cert_ca_key_id properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

Vec

pinned_client_cert_subject_rdn property (SAMLIdPServer Struct)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

fn pinned_client_cert_subject_rdn(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_valid_from property (SAMLIdPServer Struct)

The time point at which the certificate becomes valid, in UTC.

Syntax

fn pinned_client_cert_valid_from(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The time point at which the certificate becomes valid, in UTC.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_valid_to property (SAMLIdPServer Struct)

The time point at which the certificate expires, in UTC.

Syntax

fn pinned_client_cert_valid_to(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The time point at which the certificate expires, in UTC.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

port property (SAMLIdPServer Struct)

The listening port number.

Syntax

fn port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_port(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

80

Remarks

Use this property to specify the port number on which the IdP server should listen for incoming connections. To specify server's IP address use host.

Data Type

i32

security_canonicalization_method property (SAMLIdPServer Struct)

The canonicalization method to use in the signature.

Syntax

fn security_canonicalization_method(&self ) -> Result<String, SecureBlackboxError> 
fn set_security_canonicalization_method(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_security_canonicalization_method_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The canonicalization method to use in the signature.

The URI of the canonicalization method to use in the signature (e.g. http://www.w3.org/TR/xml-exc-c14n/)

Data Type

String

security_digest_method property (SAMLIdPServer Struct)

The digest method to use.

Syntax

fn security_digest_method(&self ) -> Result<String, SecureBlackboxError> 
fn set_security_digest_method(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_security_digest_method_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The digest method to use.

The URI of the digest method to use for signing, as defined in XMLDSIG or XMLENC: http://www.w3.org/2000/09/xmldsig#sha256.

Data Type

String

security_encryption_method property (SAMLIdPServer Struct)

The encryption method used to encrypt the assertion.

Syntax

fn security_encryption_method(&self ) -> Result<String, SecureBlackboxError> 
fn set_security_encryption_method(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_security_encryption_method_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"AES256"

Remarks

The encryption method used to encrypt the assertion.

This property contains the encryption algorithm used to encrypt the XML assertion.

Supported values:

Data Type

String

security_flags property (SAMLIdPServer Struct)

Provides access to secondary security parameters and tweaks.

Syntax

fn security_flags(&self ) -> Result<i32, SecureBlackboxError> 
fn set_security_flags(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

1

Remarks

Provides access to secondary security parameters and tweaks.

This property is a bitwise combination of zero or more flags. The following flags are currently supported: The following flags can be used with any SAML component (although they may not apply in all modes of use):

Data Type

i32

security_sig_method property (SAMLIdPServer Struct)

The signature method to use.

Syntax

fn security_sig_method(&self ) -> Result<String, SecureBlackboxError> 
fn set_security_sig_method(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_security_sig_method_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The signature method to use.

The URI specifying the signature method to use for signing, for example http://www.w3.org/2001/04/xmldsig-more#rsa-sha256.

Data Type

String

security_signature_policy property (SAMLIdPServer Struct)

Specifies the signature validation policy.

Syntax

fn security_signature_policy(&self ) -> Result<i32, SecureBlackboxError> 
fn set_security_signature_policy(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Auto
1   // Validate
2   // Require
3   // Ignore

Default Value

0

Remarks

Specifies the signature validation policy.

Use this property to specify the signature validation policy for the component.

Data Type

i32

sender_cert_count property (SAMLIdPServer Struct)

The number of records in the SenderChain arrays.

Syntax

fn sender_cert_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• sender_chain_bytes
• sender_chain_handle

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

This property is read-only.

Data Type

i32

sender_chain_bytes property (SAMLIdPServer Struct)

Returns the raw certificate data in DER format.

Syntax

fn sender_chain_bytes(&self , SenderCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The SenderCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SenderCertCount property.

This property is read-only.

Data Type

Vec

sender_chain_handle property (SAMLIdPServer Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn sender_chain_handle(&self , SenderCertIndex : i32) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The SenderCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SenderCertCount property.

This property is read-only.

Data Type

i64

signing_cert_bytes property (SAMLIdPServer Struct)

Returns the raw certificate data in DER format.

Syntax

fn signing_cert_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

Vec

signing_cert_handle property (SAMLIdPServer Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn signing_cert_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_signing_cert_handle(&self, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

Data Type

i64

signing_chain_count property (SAMLIdPServer Struct)

The number of records in the SigningChain arrays.

Syntax

fn signing_chain_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_signing_chain_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• signing_chain_bytes
• signing_chain_handle

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

Data Type

i32

signing_chain_bytes property (SAMLIdPServer Struct)

Returns the raw certificate data in DER format.

Syntax

fn signing_chain_bytes(&self , SigningChainIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

This property is read-only.

Data Type

Vec

signing_chain_handle property (SAMLIdPServer Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn signing_chain_handle(&self , SigningChainIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_signing_chain_handle(&self, SigningChainIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

Data Type

i64

sign_on_page_template property (SAMLIdPServer Struct)

Defines the default authentication template (login page).

Syntax

fn sign_on_page_template(&self ) -> Result<String, SecureBlackboxError> 
fn set_sign_on_page_template(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_sign_on_page_template_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

This property contains the HTML code of the authentication form. You can use it to control the appearance of the login page.

Data Type

String

socket_incoming_speed_limit property (SAMLIdPServer Struct)

The maximum number of bytes to read from the socket, per second.

Syntax

fn socket_incoming_speed_limit(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_incoming_speed_limit(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The maximum number of bytes to read from the socket, per second.

Data Type

i32

socket_local_address property (SAMLIdPServer Struct)

The local network interface to bind the socket to.

Syntax

fn socket_local_address(&self ) -> Result<String, SecureBlackboxError> 
fn set_socket_local_address(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_socket_local_address_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

socket_local_port property (SAMLIdPServer Struct)

The local port number to bind the socket to.

Syntax

fn socket_local_port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_local_port(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

i32

socket_outgoing_speed_limit property (SAMLIdPServer Struct)

The maximum number of bytes to write to the socket, per second.

Syntax

fn socket_outgoing_speed_limit(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_outgoing_speed_limit(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The maximum number of bytes to write to the socket, per second.

Data Type

i32

socket_timeout property (SAMLIdPServer Struct)

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

Syntax

fn socket_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

60000

Remarks

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

Data Type

i32

socket_use_ipv6 property (SAMLIdPServer Struct)

Enables or disables IP protocol version 6.

Syntax

fn socket_use_ipv6(&self ) -> Result<bool, SecureBlackboxError> 
fn set_socket_use_ipv6(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

bool

sp_service_count property (SAMLIdPServer Struct)

The number of records in the SPService arrays.

Syntax

fn sp_service_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• sp_service_binding_type
• sp_service_entity_id
• sp_service_location
• sp_service_priority
• sp_service_service
• sp_service_service_index

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

This property is read-only.

Data Type

i32

sp_service_binding_type property (SAMLIdPServer Struct)

Specifies the type of SAML binding that this endpoint accepts.

Syntax

fn sp_service_binding_type(&self , SPServiceIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // None
1   // SOAP
2   // PAOS
3   // Redirect
4   // POST
5   // Artifact

Default Value

0

Remarks

Specifies the type of SAML binding that this endpoint accepts.

Use this property to specify the binding type to use with this endpoint.

The SPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.

This property is read-only.

Data Type

i32

sp_service_entity_id property (SAMLIdPServer Struct)

Represents the SAML entity ID.

Syntax

fn sp_service_entity_id(&self , SPServiceIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Represents the SAML entity ID.

Use this property to read or set the unique SAML entity ID. This is often the URI of the web endpoint (such as https://sp.myserver.com).

The SPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.

This property is read-only.

Data Type

String

sp_service_location property (SAMLIdPServer Struct)

The location (URL) of the endpoint.

Syntax

fn sp_service_location(&self , SPServiceIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The location (URL) of the endpoint.

The SPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.

This property is read-only.

Data Type

String

sp_service_priority property (SAMLIdPServer Struct)

The priority of the endpoint in relation to other endpoints with the same Location .

Syntax

fn sp_service_priority(&self , SPServiceIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

-1

Remarks

The priority of the endpoint in relation to other endpoints with the same sp_location.

Indicates the relative priority of the endpoint. Use this setting to adjust priority of certain binding types before others. When composing the metadata XML, the endpoint with the highest priority gets described with a Default attribute.

Leave all priorities at -1 to omit generation of the Default attribute.

The SPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.

This property is read-only.

Data Type

i32

sp_service_service property (SAMLIdPServer Struct)

The kind of the service being provided at this endpoint.

Syntax

fn sp_service_service(&self , SPServiceIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The kind of the service being provided at this endpoint.

The Service setting returns the kind of the service that is being provided at this endpoint. Typical SP services are AssertionConsumerService and ArtifactResolutionService. Typical IdP services are SingleSignOnService, SingleLogoutService, and ArtifactResolutionService.

The SPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.

This property is read-only.

Data Type

i32

sp_service_service_index property (SAMLIdPServer Struct)

The index of this endpoint.

Syntax

fn sp_service_service_index(&self , SPServiceIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The index of this endpoint.

For endpoints that can accept requests via multiple bindings, Index is used to distinguish between individual endpoint specifiers.

The SPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.

This property is read-only.

Data Type

i32

sp_count property (SAMLIdPServer Struct)

The number of records in the SP arrays.

Syntax

fn sp_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_sp_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• sp_contact_person
• sp_encryption_key
• sp_encryption_methods
• sp_entity_id
• sp_flags
• sp_id_psso_link
• sp_name_id_formats
• sp_organization_display_name
• sp_organization_lang
• sp_organization_name
• sp_organization_url
• sp_service_binding_type
• sp_service_entity_id
• sp_service_location
• sp_service_priority
• sp_service_service
• sp_service_service_index
• sp_signature_validation_result
• sp_signed
• sp_signed_with
• sp_signing_key
• sp_valid_until

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

Data Type

i32

sp_contact_person property (SAMLIdPServer Struct)

The contact person or persons for the entity.

Syntax

fn sp_contact_person(&self , SPIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_sp_contact_person(&self, SPIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_sp_contact_person_ref(&self, SPIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The contact person or persons for the entity.

SAML assumes that more than one contact person can be specified. Each line of this potentially multi-line property contains one such record.

Each record contains a semicolon-separated list of contact person parameters, for example:

Company=My Company;EmailAddress=info@company.com;TelephoneNumber=+012345678;Type=other

Company=My Company;EmailAddress=info@company.com;TelephoneNumber=+012345678;Type=technical;Extension.https://spid.gov.it/saml-extensions.VATNumber=IT122345678

You can use LoadNameValuePairs and SaveNameValuePairs methods of the Utils class to process content of this property.

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

String

sp_encryption_key property (SAMLIdPServer Struct)

Contains the entity's encryption key.

Syntax

fn sp_encryption_key(&self , SPIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_sp_encryption_key(&self, SPIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_sp_encryption_key_ref(&self, SPIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the entity's encryption key.

This setting returns the entity's public encryption key. In most cases this is in the form of a DER-encoded X.509 certificate. This property cannot be set in code; it is either taken from the processed metadata file (for other-party settings), or derived from the locally set EncryptionCertificate setting (for this-party settings).

Requests sent to the endpoint can be encrypted with the provided key or certificate.

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

String

sp_encryption_methods property (SAMLIdPServer Struct)

Specifies the list of encryption methods supported by the entity.

Syntax

fn sp_encryption_methods(&self , SPIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_sp_encryption_methods(&self, SPIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_sp_encryption_methods_ref(&self, SPIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the list of encryption methods supported by the entity.

This setting contains a list of encryption methods, in form of XML-ENC URLs separated with newline characters, supported by the entity. These can be considered when encrypting messages destined for this entity.

Examples of algorithms supported by this property:

• http://www.w3.org/2009/xmlenc11#aes128-gcm
• http://www.w3.org/2001/04/xmlenc#aes256-cbc

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

String

sp_entity_id property (SAMLIdPServer Struct)

Represents the SAML entity ID.

Syntax

fn sp_entity_id(&self , SPIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_sp_entity_id(&self, SPIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_sp_entity_id_ref(&self, SPIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Represents the SAML entity ID.

Use this property to read or set the unique SAML entity ID. This is often the URI of the web endpoint (such as https://sp.myserver.com).

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

String

sp_flags property (SAMLIdPServer Struct)

Adjusts secondary entity properties.

Syntax

fn sp_flags(&self , SPIndex : i32) -> Result<i32, SecureBlackboxError> 
fn set_sp_flags(&self, SPIndex : i32, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Adjusts secondary entity properties.

Use this bit mask property to adjust certain secondary settings. The following flags are supported:

• 1 - sefRequireSignedRequests - the provider expects the consumers to sign requests they send in.

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

i32

sp_id_psso_link property (SAMLIdPServer Struct)

Contains a local server page link that triggers SAML authentication to the SP.

Syntax

fn sp_id_psso_link(&self , SPIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_sp_id_psso_link(&self, SPIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_sp_id_psso_link_ref(&self, SPIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains a local server page link that triggers SAML authentication to the SP.

This property specifies the web link that initiates the transfer of SAML authentication fact to the SP.

One scenario where this property can be used is triggering the assertion dispatch in IdP-initiated SSO flows. Navigating to the link will make the IdP server generate the authentication assertion (if the user had been authenticated) and forward this assertion to the respective service provider.

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

String

sp_name_id_formats property (SAMLIdPServer Struct)

The list of NameID formats supported by this entity.

Syntax

fn sp_name_id_formats(&self , SPIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_sp_name_id_formats(&self, SPIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_sp_name_id_formats_ref(&self, SPIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The list of NameID formats supported by this entity.

Use this setting to get or set the list of NameID formats supported by the entity.

Use SAML notation for the formats:

• urn:oasis:names:tc:SAML:2.0:nameid-format:transient
• urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
• urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

String

sp_organization_display_name property (SAMLIdPServer Struct)

The friendly name of the organization that maintains the entity.

Syntax

fn sp_organization_display_name(&self , SPIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_sp_organization_display_name(&self, SPIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_sp_organization_display_name_ref(&self, SPIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The friendly name of the organization that maintains the entity.

Use this setting to get or set the user-friendly name of the organization that maintains the SAML entity.

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

String

sp_organization_lang property (SAMLIdPServer Struct)

The language preferred by the organization.

Syntax

fn sp_organization_lang(&self , SPIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_sp_organization_lang(&self, SPIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_sp_organization_lang_ref(&self, SPIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The language preferred by the organization.

This optional setting can be used to adjust the preferred language of the owning organization.

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

String

sp_organization_name property (SAMLIdPServer Struct)

The name of the organization that maintains the entity.

Syntax

fn sp_organization_name(&self , SPIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_sp_organization_name(&self, SPIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_sp_organization_name_ref(&self, SPIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The name of the organization that maintains the entity.

Use this setting to get or set the name of the organization that maintains the SAML entity.

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

String

sp_organization_url property (SAMLIdPServer Struct)

The web URL of the organization that maintains the entity.

Syntax

fn sp_organization_url(&self , SPIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_sp_organization_url(&self, SPIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_sp_organization_url_ref(&self, SPIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The web URL of the organization that maintains the entity.

Use this setting to get or set the web address of the organization responsible for this SAML entity.

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

String

sp_signature_validation_result property (SAMLIdPServer Struct)

The outcome of the cryptographic signature validation.

Syntax

fn sp_signature_validation_result(&self , SPIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Valid
1   // Unknown
2   // Corrupted
3   // SignerNotFound
4   // Failure
5   // ReferenceCorrupted

Default Value

0

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

This property is read-only.

Data Type

i32

sp_signed property (SAMLIdPServer Struct)

Specifies whether the SAML entity information is or should be signed.

Syntax

fn sp_signed(&self , SPIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether the SAML entity information is or should be signed.

Check this property to find out whether the metadata was signed by the sender, or set this property to true to indicate that the created metadata should be signed.

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

This property is read-only.

Data Type

bool

sp_signed_with property (SAMLIdPServer Struct)

Contains the certificate or key that was used to sign the settings (metadata) document.

Syntax

fn sp_signed_with(&self , SPIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the certificate or key that was used to sign the settings (metadata) document.

This setting returns the public part of the metadata signing key. In most cases this is in the form of a DER-encoded X.509 certificate.

The value of this property is retrieved from the metadata file when it is loaded with the ImportSettings call. If the metadata is signed, you can check the integrity of the signature using the sp_signature_validation_result setting.

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

This property is read-only.

Data Type

String

sp_signing_key property (SAMLIdPServer Struct)

Contains the entity's signing key.

Syntax

fn sp_signing_key(&self , SPIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_sp_signing_key(&self, SPIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_sp_signing_key_ref(&self, SPIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the entity's signing key.

This setting returns the public part of the entity's signing key. In most cases this is in the form of a PKCS#1 RSA or ECDSA key.

The signing key is used to sign message conveyed over Redirect binding. Redirect signatures are simpler than SAML message signatures and are made with raw keys rather than certificates.

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

String

sp_valid_until property (SAMLIdPServer Struct)

Specifies the expiration time of the SAML entity information.

Syntax

fn sp_valid_until(&self , SPIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_sp_valid_until(&self, SPIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_sp_valid_until_ref(&self, SPIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the expiration time of the SAML entity information.

This setting only makes sense when the information was loaded or is going to be saved to a metadata XML.

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

String

tls_server_cert_count property (SAMLIdPServer Struct)

The number of records in the TLSServerCert arrays.

Syntax

fn tls_server_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_server_cert_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• tls_server_cert_bytes
• tls_server_cert_handle

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

Data Type

i32

tls_server_cert_bytes property (SAMLIdPServer Struct)

Returns the raw certificate data in DER format.

Syntax

fn tls_server_cert_bytes(&self , TLSServerCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

Vec

tls_server_cert_handle property (SAMLIdPServer Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn tls_server_cert_handle(&self , TLSServerCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_tls_server_cert_handle(&self, TLSServerCertIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

Data Type

i64

tls_auto_validate_certificates property (SAMLIdPServer Struct)

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Syntax

fn tls_auto_validate_certificates(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_auto_validate_certificates(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

true

Remarks

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Data Type

bool

tls_base_configuration property (SAMLIdPServer Struct)

Selects the base configuration for the TLS settings.

Syntax

fn tls_base_configuration(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_base_configuration(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // Compatible
2   // ComprehensiveInsecure
3   // HighlySecure

Default Value

0

Remarks

Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.

Data Type

i32

tls_ciphersuites property (SAMLIdPServer Struct)

A list of ciphersuites separated with commas or semicolons.

Syntax

fn tls_ciphersuites(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_ciphersuites(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_ciphersuites_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by tls_base_configuration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

• NULL_NULL_NULL
• RSA_NULL_MD5
• RSA_NULL_SHA
• RSA_RC4_MD5
• RSA_RC4_SHA
• RSA_RC2_MD5
• RSA_IDEA_MD5
• RSA_IDEA_SHA
• RSA_DES_MD5
• RSA_DES_SHA
• RSA_3DES_MD5
• RSA_3DES_SHA
• RSA_AES128_SHA
• RSA_AES256_SHA
• DH_DSS_DES_SHA
• DH_DSS_3DES_SHA
• DH_DSS_AES128_SHA
• DH_DSS_AES256_SHA
• DH_RSA_DES_SHA
• DH_RSA_3DES_SHA
• DH_RSA_AES128_SHA
• DH_RSA_AES256_SHA
• DHE_DSS_DES_SHA
• DHE_DSS_3DES_SHA
• DHE_DSS_AES128_SHA
• DHE_DSS_AES256_SHA
• DHE_RSA_DES_SHA
• DHE_RSA_3DES_SHA
• DHE_RSA_AES128_SHA
• DHE_RSA_AES256_SHA
• DH_ANON_RC4_MD5
• DH_ANON_DES_SHA
• DH_ANON_3DES_SHA
• DH_ANON_AES128_SHA
• DH_ANON_AES256_SHA
• RSA_RC2_MD5_EXPORT
• RSA_RC4_MD5_EXPORT
• RSA_DES_SHA_EXPORT
• DH_DSS_DES_SHA_EXPORT
• DH_RSA_DES_SHA_EXPORT
• DHE_DSS_DES_SHA_EXPORT
• DHE_RSA_DES_SHA_EXPORT
• DH_ANON_RC4_MD5_EXPORT
• DH_ANON_DES_SHA_EXPORT
• RSA_CAMELLIA128_SHA
• DH_DSS_CAMELLIA128_SHA
• DH_RSA_CAMELLIA128_SHA
• DHE_DSS_CAMELLIA128_SHA
• DHE_RSA_CAMELLIA128_SHA
• DH_ANON_CAMELLIA128_SHA
• RSA_CAMELLIA256_SHA
• DH_DSS_CAMELLIA256_SHA
• DH_RSA_CAMELLIA256_SHA
• DHE_DSS_CAMELLIA256_SHA
• DHE_RSA_CAMELLIA256_SHA
• DH_ANON_CAMELLIA256_SHA
• PSK_RC4_SHA
• PSK_3DES_SHA
• PSK_AES128_SHA
• PSK_AES256_SHA
• DHE_PSK_RC4_SHA
• DHE_PSK_3DES_SHA
• DHE_PSK_AES128_SHA
• DHE_PSK_AES256_SHA
• RSA_PSK_RC4_SHA
• RSA_PSK_3DES_SHA
• RSA_PSK_AES128_SHA
• RSA_PSK_AES256_SHA
• RSA_SEED_SHA
• DH_DSS_SEED_SHA
• DH_RSA_SEED_SHA
• DHE_DSS_SEED_SHA
• DHE_RSA_SEED_SHA
• DH_ANON_SEED_SHA
• SRP_SHA_3DES_SHA
• SRP_SHA_RSA_3DES_SHA
• SRP_SHA_DSS_3DES_SHA
• SRP_SHA_AES128_SHA
• SRP_SHA_RSA_AES128_SHA
• SRP_SHA_DSS_AES128_SHA
• SRP_SHA_AES256_SHA
• SRP_SHA_RSA_AES256_SHA
• SRP_SHA_DSS_AES256_SHA
• ECDH_ECDSA_NULL_SHA
• ECDH_ECDSA_RC4_SHA
• ECDH_ECDSA_3DES_SHA
• ECDH_ECDSA_AES128_SHA
• ECDH_ECDSA_AES256_SHA
• ECDHE_ECDSA_NULL_SHA
• ECDHE_ECDSA_RC4_SHA
• ECDHE_ECDSA_3DES_SHA
• ECDHE_ECDSA_AES128_SHA
• ECDHE_ECDSA_AES256_SHA
• ECDH_RSA_NULL_SHA
• ECDH_RSA_RC4_SHA
• ECDH_RSA_3DES_SHA
• ECDH_RSA_AES128_SHA
• ECDH_RSA_AES256_SHA
• ECDHE_RSA_NULL_SHA
• ECDHE_RSA_RC4_SHA
• ECDHE_RSA_3DES_SHA
• ECDHE_RSA_AES128_SHA
• ECDHE_RSA_AES256_SHA
• ECDH_ANON_NULL_SHA
• ECDH_ANON_RC4_SHA
• ECDH_ANON_3DES_SHA
• ECDH_ANON_AES128_SHA
• ECDH_ANON_AES256_SHA
• RSA_NULL_SHA256
• RSA_AES128_SHA256
• RSA_AES256_SHA256
• DH_DSS_AES128_SHA256
• DH_RSA_AES128_SHA256
• DHE_DSS_AES128_SHA256
• DHE_RSA_AES128_SHA256
• DH_DSS_AES256_SHA256
• DH_RSA_AES256_SHA256
• DHE_DSS_AES256_SHA256
• DHE_RSA_AES256_SHA256
• DH_ANON_AES128_SHA256
• DH_ANON_AES256_SHA256
• RSA_AES128_GCM_SHA256
• RSA_AES256_GCM_SHA384
• DHE_RSA_AES128_GCM_SHA256
• DHE_RSA_AES256_GCM_SHA384
• DH_RSA_AES128_GCM_SHA256
• DH_RSA_AES256_GCM_SHA384
• DHE_DSS_AES128_GCM_SHA256
• DHE_DSS_AES256_GCM_SHA384
• DH_DSS_AES128_GCM_SHA256
• DH_DSS_AES256_GCM_SHA384
• DH_ANON_AES128_GCM_SHA256
• DH_ANON_AES256_GCM_SHA384
• ECDHE_ECDSA_AES128_SHA256
• ECDHE_ECDSA_AES256_SHA384
• ECDH_ECDSA_AES128_SHA256
• ECDH_ECDSA_AES256_SHA384
• ECDHE_RSA_AES128_SHA256
• ECDHE_RSA_AES256_SHA384
• ECDH_RSA_AES128_SHA256
• ECDH_RSA_AES256_SHA384
• ECDHE_ECDSA_AES128_GCM_SHA256
• ECDHE_ECDSA_AES256_GCM_SHA384
• ECDH_ECDSA_AES128_GCM_SHA256
• ECDH_ECDSA_AES256_GCM_SHA384
• ECDHE_RSA_AES128_GCM_SHA256
• ECDHE_RSA_AES256_GCM_SHA384
• ECDH_RSA_AES128_GCM_SHA256
• ECDH_RSA_AES256_GCM_SHA384
• PSK_AES128_GCM_SHA256
• PSK_AES256_GCM_SHA384
• DHE_PSK_AES128_GCM_SHA256
• DHE_PSK_AES256_GCM_SHA384
• RSA_PSK_AES128_GCM_SHA256
• RSA_PSK_AES256_GCM_SHA384
• PSK_AES128_SHA256
• PSK_AES256_SHA384
• PSK_NULL_SHA256
• PSK_NULL_SHA384
• DHE_PSK_AES128_SHA256
• DHE_PSK_AES256_SHA384
• DHE_PSK_NULL_SHA256
• DHE_PSK_NULL_SHA384
• RSA_PSK_AES128_SHA256
• RSA_PSK_AES256_SHA384
• RSA_PSK_NULL_SHA256
• RSA_PSK_NULL_SHA384
• RSA_CAMELLIA128_SHA256
• DH_DSS_CAMELLIA128_SHA256
• DH_RSA_CAMELLIA128_SHA256
• DHE_DSS_CAMELLIA128_SHA256
• DHE_RSA_CAMELLIA128_SHA256
• DH_ANON_CAMELLIA128_SHA256
• RSA_CAMELLIA256_SHA256
• DH_DSS_CAMELLIA256_SHA256
• DH_RSA_CAMELLIA256_SHA256
• DHE_DSS_CAMELLIA256_SHA256
• DHE_RSA_CAMELLIA256_SHA256
• DH_ANON_CAMELLIA256_SHA256
• ECDHE_ECDSA_CAMELLIA128_SHA256
• ECDHE_ECDSA_CAMELLIA256_SHA384
• ECDH_ECDSA_CAMELLIA128_SHA256
• ECDH_ECDSA_CAMELLIA256_SHA384
• ECDHE_RSA_CAMELLIA128_SHA256
• ECDHE_RSA_CAMELLIA256_SHA384
• ECDH_RSA_CAMELLIA128_SHA256
• ECDH_RSA_CAMELLIA256_SHA384
• RSA_CAMELLIA128_GCM_SHA256
• RSA_CAMELLIA256_GCM_SHA384
• DHE_RSA_CAMELLIA128_GCM_SHA256
• DHE_RSA_CAMELLIA256_GCM_SHA384
• DH_RSA_CAMELLIA128_GCM_SHA256
• DH_RSA_CAMELLIA256_GCM_SHA384
• DHE_DSS_CAMELLIA128_GCM_SHA256
• DHE_DSS_CAMELLIA256_GCM_SHA384
• DH_DSS_CAMELLIA128_GCM_SHA256
• DH_DSS_CAMELLIA256_GCM_SHA384
• DH_anon_CAMELLIA128_GCM_SHA256
• DH_anon_CAMELLIA256_GCM_SHA384
• ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
• ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
• ECDH_ECDSA_CAMELLIA128_GCM_SHA256
• ECDH_ECDSA_CAMELLIA256_GCM_SHA384
• ECDHE_RSA_CAMELLIA128_GCM_SHA256
• ECDHE_RSA_CAMELLIA256_GCM_SHA384
• ECDH_RSA_CAMELLIA128_GCM_SHA256
• ECDH_RSA_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_GCM_SHA256
• PSK_CAMELLIA256_GCM_SHA384
• DHE_PSK_CAMELLIA128_GCM_SHA256
• DHE_PSK_CAMELLIA256_GCM_SHA384
• RSA_PSK_CAMELLIA128_GCM_SHA256
• RSA_PSK_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_SHA256
• PSK_CAMELLIA256_SHA384
• DHE_PSK_CAMELLIA128_SHA256
• DHE_PSK_CAMELLIA256_SHA384
• RSA_PSK_CAMELLIA128_SHA256
• RSA_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_CAMELLIA128_SHA256
• ECDHE_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_RC4_SHA
• ECDHE_PSK_3DES_SHA
• ECDHE_PSK_AES128_SHA
• ECDHE_PSK_AES256_SHA
• ECDHE_PSK_AES128_SHA256
• ECDHE_PSK_AES256_SHA384
• ECDHE_PSK_NULL_SHA
• ECDHE_PSK_NULL_SHA256
• ECDHE_PSK_NULL_SHA384
• ECDHE_RSA_CHACHA20_POLY1305_SHA256
• ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
• DHE_RSA_CHACHA20_POLY1305_SHA256
• PSK_CHACHA20_POLY1305_SHA256
• ECDHE_PSK_CHACHA20_POLY1305_SHA256
• DHE_PSK_CHACHA20_POLY1305_SHA256
• RSA_PSK_CHACHA20_POLY1305_SHA256
• AES128_GCM_SHA256
• AES256_GCM_SHA384
• CHACHA20_POLY1305_SHA256
• AES128_CCM_SHA256
• AES128_CCM8_SHA256

Data Type

String

tls_client_auth property (SAMLIdPServer Struct)

Enables or disables certificate-based client authentication.

Syntax

fn tls_client_auth(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_client_auth(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // NoAuth
1   // RequestCert
2   // RequireCert

Default Value

0

Remarks

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:

Data Type

i32

tls_extensions property (SAMLIdPServer Struct)

Provides access to TLS extensions.

Syntax

fn tls_extensions(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_extensions(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_extensions_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

String

tls_force_resume_if_destination_changes property (SAMLIdPServer Struct)

Whether to force TLS session resumption when the destination address changes.

Syntax

fn tls_force_resume_if_destination_changes(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_force_resume_if_destination_changes(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Whether to force TLS session resumption when the destination address changes.

Data Type

bool

tls_groups property (SAMLIdPServer Struct)

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Syntax

fn tls_groups(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_groups(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_groups_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the all placeholder:

// Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048"; // Only enable the hybrid X25519/ML-KEM768 group client.TLSSettings.Groups = "-all;+x25519mlkem768";

The list of groups supported by the component is provided below. All the names are case-insensitive:

Elliptic curve-based groups:

• SECT163K1
• SECT163R1
• SECT163R2
• SECT193R1
• SECT193R2
• SECT233K1
• SECT233R1
• SECT239K1
• SECT283K1
• SECT283R1
• SECT409K1
• SECT409R1
• SECT571K1
• SECT571R1
• SECP160K1
• SECP160R1
• SECP160R2
• SECP192K1
• SECP192R1
• SECP224K1
• SECP224R1
• SECP256K1
• SECP256R1
• SECP384R1
• SECP521R1
• BRAINPOOLP256R1
• BRAINPOOLP384R1
• BRAINPOOLP512R1
• X25519
• X448

Finite field-based groups:

• FFDHE2048
• FFDHE3072
• FFDHE4096
• FFDHE6144
• FFDHE8192

Post-Quantum and Hybrid groups:

• MLKEM512
• MLKEM768
• MLKEM1024
• SECP256R1MLKEM768
• X25519MLKEM768
• SECP384R1MLKEM1024

Note: this property was called ECCurves in SecureBlackbox 2024 and older.

Data Type

String

tls_pre_shared_identity property (SAMLIdPServer Struct)

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

fn tls_pre_shared_identity(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_pre_shared_identity(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_pre_shared_identity_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Data Type

String

tls_pre_shared_key property (SAMLIdPServer Struct)

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Syntax

fn tls_pre_shared_key(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_pre_shared_key(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_pre_shared_key_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Data Type

String

tls_pre_shared_key_ciphersuite property (SAMLIdPServer Struct)

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Syntax

fn tls_pre_shared_key_ciphersuite(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_pre_shared_key_ciphersuite(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_pre_shared_key_ciphersuite_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Data Type

String

tls_renegotiation_attack_prevention_mode property (SAMLIdPServer Struct)

Selects the renegotiation attack prevention mechanism.

Syntax

fn tls_renegotiation_attack_prevention_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_renegotiation_attack_prevention_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Compatible
1   // Strict
2   // Auto

Default Value

2

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

i32

tls_revocation_check property (SAMLIdPServer Struct)

Specifies the kind(s) of revocation check to perform.

Syntax

fn tls_revocation_check(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_revocation_check(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // None
1   // Auto
2   // AllCRL
3   // AllOCSP
4   // AllCRLAndOCSP
5   // AnyCRL
6   // AnyOCSP
7   // AnyCRLOrOCSP
8   // AnyOCSPOrCRL

Default Value

1

Remarks

Specifies the kind(s) of revocation check to perform.

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

NOTE: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

Data Type

i32

tls_ssl_options property (SAMLIdPServer Struct)

Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.

Syntax

fn tls_ssl_options(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_ssl_options(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

i32

tls_mode property (SAMLIdPServer Struct)

Specifies the TLS mode to use.

Syntax

fn tls_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // NoTLS
2   // ExplicitTLS
3   // ImplicitTLS
4   // MixedTLS

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

i32

tls_use_extended_master_secret property (SAMLIdPServer Struct)

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Syntax

fn tls_use_extended_master_secret(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_use_extended_master_secret(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

true

Remarks

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Data Type

bool

tls_use_session_resumption property (SAMLIdPServer Struct)

Enables or disables the TLS session resumption capability.

Syntax

fn tls_use_session_resumption(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_use_session_resumption(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

bool

tls_versions property (SAMLIdPServer Struct)

The SSL/TLS versions to enable by default.

Syntax

fn tls_versions(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_versions(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

48

Remarks

The SSL/TLS versions to enable by default.

Data Type

i32

url property (SAMLIdPServer Struct)

Specifies the base URL of this IdP server.

Syntax

fn url(&self ) -> Result<String, SecureBlackboxError> 
fn set_url(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_url_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to set the base URL for this Identity Provider (IdP) server.

Data Type

String

user_count property (SAMLIdPServer Struct)

The number of records in the User arrays.

Syntax

fn user_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_user_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• user_associated_data
• user_base_path
• user_certificate
• user_data
• user_email
• user_handle
• user_hash_algorithm
• user_incoming_speed_limit
• username
• user_otp_algorithm
• user_otp_len
• user_otp_value
• user_outgoing_speed_limit
• user_password
• user_shared_secret
• user_ssh_key

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

Data Type

i32

user_associated_data property (SAMLIdPServer Struct)

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

Syntax

fn user_associated_data(&self , UserIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_user_associated_data(&self, UserIndex : i32, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_user_associated_data_ref(&self, UserIndex : i32, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

Vec

user_base_path property (SAMLIdPServer Struct)

Base path for this user in the server's file system.

Syntax

fn user_base_path(&self , UserIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_user_base_path(&self, UserIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_user_base_path_ref(&self, UserIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Base path for this user in the server's file system.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

String

user_certificate property (SAMLIdPServer Struct)

Contains the user's certificate.

Syntax

fn user_certificate(&self , UserIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_user_certificate(&self, UserIndex : i32, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_user_certificate_ref(&self, UserIndex : i32, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Contains the user's certificate.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

Vec

user_data property (SAMLIdPServer Struct)

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

Syntax

fn user_data(&self , UserIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_user_data(&self, UserIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_user_data_ref(&self, UserIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

String

user_email property (SAMLIdPServer Struct)

The user's email address.

Syntax

fn user_email(&self , UserIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_user_email(&self, UserIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_user_email_ref(&self, UserIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The user's email address.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

String

user_handle property (SAMLIdPServer Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn user_handle(&self , UserIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_user_handle(&self, UserIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

i64

user_hash_algorithm property (SAMLIdPServer Struct)

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.

Syntax

fn user_hash_algorithm(&self , UserIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_user_hash_algorithm(&self, UserIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_user_hash_algorithm_ref(&self, UserIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

String

user_incoming_speed_limit property (SAMLIdPServer Struct)

Specifies the incoming speed limit for this user.

Syntax

fn user_incoming_speed_limit(&self , UserIndex : i32) -> Result<i32, SecureBlackboxError> 
fn set_user_incoming_speed_limit(&self, UserIndex : i32, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

i32

user_otp_algorithm property (SAMLIdPServer Struct)

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP).

Syntax

fn user_otp_algorithm(&self , UserIndex : i32) -> Result<i32, SecureBlackboxError> 
fn set_user_otp_algorithm(&self, UserIndex : i32, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // None
1   // Hmac
2   // Time

Default Value

0

Remarks

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

i32

user_otp_len property (SAMLIdPServer Struct)

Specifies the length of the user's OTP password.

Syntax

fn user_otp_len(&self , UserIndex : i32) -> Result<i32, SecureBlackboxError> 
fn set_user_otp_len(&self, UserIndex : i32, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the length of the user's OTP password.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

i32

user_otp_value property (SAMLIdPServer Struct)

The user's time interval (TOTP) or Counter (HOTP).

Syntax

fn user_otp_value(&self , UserIndex : i32) -> Result<i32, SecureBlackboxError> 
fn set_user_otp_value(&self, UserIndex : i32, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The user's time interval (TOTP) or Counter (HOTP).

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

i32

user_outgoing_speed_limit property (SAMLIdPServer Struct)

Specifies the outgoing speed limit for this user.

Syntax

fn user_outgoing_speed_limit(&self , UserIndex : i32) -> Result<i32, SecureBlackboxError> 
fn set_user_outgoing_speed_limit(&self, UserIndex : i32, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

i32

user_password property (SAMLIdPServer Struct)

The user's authentication password.

Syntax

fn user_password(&self , UserIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_user_password(&self, UserIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_user_password_ref(&self, UserIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The user's authentication password.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

String

user_shared_secret property (SAMLIdPServer Struct)

Contains the user's secret key, which is essentially a shared secret between the client and server.

Syntax

fn user_shared_secret(&self , UserIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_user_shared_secret(&self, UserIndex : i32, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_user_shared_secret_ref(&self, UserIndex : i32, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Contains the user's secret key, which is essentially a shared secret between the client and server.

Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

Vec

user_ssh_key property (SAMLIdPServer Struct)

Contains the user's SSH key.

Syntax

fn user_ssh_key(&self , UserIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_user_ssh_key(&self, UserIndex : i32, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_user_ssh_key_ref(&self, UserIndex : i32, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Contains the user's SSH key.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

Vec

username property (SAMLIdPServer Struct)

The registered name (login) of the user.

Syntax

fn username(&self , UserIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_username(&self, UserIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_username_ref(&self, UserIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The registered name (login) of the user.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

String

add_id_p_service method (SAMLIdPServer Struct)

Registers an IdP service in the IdPServices list.

Syntax

fn add_id_p_service(&self, service : i32, binding_type : i32, location : &str, priority : i32, index : i32) -> Result<(), SecureBlackboxError>

Remarks

Use this method to add an entry to the list of services and their locations provided by the IdP.

An identity provider can provide a variety of identity services through a selection of endpoints, each supporting one or more transports (or bindings). Typical examples are a single sign-on or a single logout service, each of which can be served independently on the same or different endpoints, via a POST or Redirect transports (or both).

Each add_id_p_service call registers a single service offered via a single transport. If you would like to have the same service to be available using several different transports, you need to register each combination individually, even if the service runs at the same web endpoint:

idp.AddIdPService(spsSingleSignOnService, csbtRedirect, "/saml/sso", -1, -1); idp.AddIdPService(spsSingleSignOnService, csbtPOST, "/saml/sso", -1, -1);

Use the Service parameter to specify the service to register:

The BindingType specifies the transport type that the service being registered should use. Note that not every kind of service supports every kind of transport. It is typical for SSO and SLO services to support POST and Redirect bindings.

The Location parameter specifies an absolute or relative path to the service within the SAML web service:

idp.AddIdPService(spsSingleSignOnService, csbtPOST, "https://idp.identityserver/saml/sso", -1, -1); // absolute path idp.AddIdPService(spsSingleSignOnService, csbtRedirect, "/saml/sso", -1, -1); // relative path

The Priority parameter is nominal as it only specifies the relative priority of the transport in the IdP metadata. The actual transport used, among those supported, depends on the choice of the external service provider / application. Pass -1 to stick with the default priority.

The Index parameter specifies the index of the endpoint, which is a unique value assigned to each endpoint. Pass -1 unless you want to provide the index explicitly.

Note that this method registers the identity provider's own service - something that the identity provider provides. This is different to add_sp_service method, which registers a foreign service provider's service - something that the identity provider should be aware of.

add_sp method (SAMLIdPServer Struct)

Registers an SP entity in SPSettings list.

Syntax

fn add_sp(&self, entity_id : &str, id_psso_link : &str) -> Result<(), SecureBlackboxError>

Remarks

This method adds an empty entry to the sp_settings list of known service providers. When registering a service provider manually (v.s. importing it from its metadata with a import_settings call), make sure to register all the individual SP service endpoints (assertion consumer services, single logout services, and so on) manually using the add_sp_service method.

Once you have added the SP entry to the list, you can edit it using the sp_settings property.

add_sp_service method (SAMLIdPServer Struct)

Registers an SP service in the SPServices list.

Syntax

fn add_sp_service(&self, service : i32, binding_type : i32, location : &str, priority : i32, index : i32, entity_id : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to add an entry to the list of known external SAML services and their locations.

The identity provider needs to be knowledgeable of external SP services (applications) that it provides services to. That information can either be provided in the form of a metadata file (see import_settings), or registered manually using this method.

When using this method, make sure to register all the services you expect to work with. Note that if the same SP service is available through several different transports (bindings), you will need to register each (service, transport) pair individually:

idp.AddSPService(spsAssertionConsumerService, csbtPOST, "https://app.com/saml/acs", -1, -1, "http://app.com/saml/metadata"); idp.AddSPService(spsAssertionConsumerService, csbtRedirect, "https://app.com/saml/acs", -1, -1, "http://app.com/saml/metadata");

Use the Service parameter to specify the service to register:

The BindingType specifies the transport type that the service being registered should use. Note that not every kind of service supports every kind of transport. It is typical for ACS service to use POST binding (due to the size of assertions), and SLS to either use POST or Redirect. This information is typically provided by the service provider.

The Location parameter specifies the absolute URL of the respective SAML web endpoint.

The Priority parameter specifies the relative priority of the transport among several identical services. The actual transport used may be different to the specified priority, as the request received from the SP (such as AuthnRequest) may explicitly request a specific transport to use.

The Index parameter specifies the index of the endpoint, which is a unique value assigned to each endpoint. Pass -1 unless you want to provide the index explicitly.

The EntityID parameter provides a unique identifier of the service provider. It is common to use the URL of the provider's metadata file as the Entity ID, although that is not a requirement.

Note that this method registers a known service - something that the identity provider should be aware of. This is different to the purpose of the add_id_p_service method, which registers the identity provider's own service.

cleanup method (SAMLIdPServer Struct)

Cleans up the server environment by purging expired sessions and cleaning caches.

Syntax

fn cleanup(&self) -> Result<(), SecureBlackboxError>

Remarks

Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches.

complete_auth method (SAMLIdPServer Struct)

Initiates transfer of the authentication fact (assertion) to the SP.

Syntax

fn complete_auth(&self, connection_id : i64, session_id : &str, sp_service_index : i32, relay_state : &str, tag : &str) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to pass a SAML assertion to a chosen SP after completion of the IdP-initiated SSO process.

Calling this method is equivalent to navigating to the SP-specific IdP link on the web server running the SAML IdP service.

This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the on_processing_completed event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.

You can use this method with or without the offline_mode.

config method (SAMLIdPServer Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, SecureBlackboxError>

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_action method (SAMLIdPServer Struct)

Performs an additional action.

Syntax

fn do_action(&self, action_id : &str, action_params : &str) ->  Result<String, SecureBlackboxError>

Remarks

do_action is a generic method available in every struct. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Common ActionIDs:

drop_client method (SAMLIdPServer Struct)

Terminates a client connection.

Syntax

fn drop_client(&self, connection_id : i64, forced : bool) -> Result<(), SecureBlackboxError>

Remarks

Call this method to shut down a connected client. Forced indicates whether the connection should be closed in a graceful manner.

export_settings method (SAMLIdPServer Struct)

Saves the SP or IdP configuration to an XML metadata file.

Syntax

fn export_settings(&self, id_p : bool, index : i32) ->  Result<String, SecureBlackboxError>

Remarks

Use this method to save the Identity Provider (IdP) or Service Provider (SP) configuration in the form of XML metadata. The IdP metadata file may then be transferred to identity providers (SP) to let them know about the IdP configuration.

When exporting IdP settings, adjust the identity provider configuration as required in id_p_settings object before calling this method. Assign meta_signing_certificate to enforce signing of the metadata XML.

When exporting SP settings, provide the index of the service provider in the sp_settings list.

get_client_buffer method (SAMLIdPServer Struct)

Acquires a piece of operation data.

Syntax

fn get_client_buffer(&self, connection_id : i64, handle : &str) ->  Result<Vec<u8>, SecureBlackboxError>

Remarks

Use this method to obtain a piece of data relevant to a transfer operation in a thread-safe way.

A typical place to call this method is inside the on_resource_write event handler, when implementing customized file transfers.

get_provider_property method (SAMLIdPServer Struct)

Returns the value of a custom provider property.

Syntax

fn get_provider_property(&self, name : &str) ->  Result<String, SecureBlackboxError>

Remarks

This method, together with set_provider_property, provides an extensible way of managing the Identity Provider's settings that are not available through the primary properties of the component. As SAML usage scenarios evolve and new providers appear, the list of supported properties can be extended.

The following properties are currently supported:

• ContactPerson
• OrganizationName
• OrganizationDisplayName
• OrganizationURL
• OrganizationLang

get_request_bytes method (SAMLIdPServer Struct)

Returns the contents of the received HTTP request.

Syntax

fn get_request_bytes(&self, connection_id : i64, request_filter : &str) ->  Result<Vec<u8>, SecureBlackboxError>

Remarks

Use this method to get the body of the received HTTP request. Note that the body of GET and HEAD requests is empty. The method returns the requested content.

get_request_header method (SAMLIdPServer Struct)

Returns a request header value.

Syntax

fn get_request_header(&self, connection_id : i64, header_name : &str) ->  Result<String, SecureBlackboxError>

Remarks

Use this method to get the value of a request header. A good place to call this method is a request-marking event, such as on_get_request or on_post_request.

get_response_header method (SAMLIdPServer Struct)

Returns a response header value.

Syntax

fn get_response_header(&self, connection_id : i64, header_name : &str) ->  Result<String, SecureBlackboxError>

Remarks

Use this method to get the value of a response header. A good place to call this method is on_headers_prepared event. Call the method with empty HeaderName to get the whole response header.

get_session_property method (SAMLIdPServer Struct)

Returns the value of a custom session property.

Syntax

fn get_session_property(&self, session_id : &str, name : &str) ->  Result<String, SecureBlackboxError>

Remarks

This method, together with set_session_property, provides an extensible way of managing the Identity Provider's session properties that are not available through the primary properties and events of the component. These methods can be called on any active browser session. Use on_session_created and on_session_destroyed events to get notifications about session creation and disposal.

The following properties are supported for IdP sessions and can be passed to the Name parameter of this method:

• AuthnContextClassRef: the authentication context Auth class.
• AuthnRequestID: the AuthnRequest ID.
• Binding: the binding type used.
• Certificate: the certificate that signed the request (in base16 DER-encoded format).
• CustomAuthFlow: whether the session uses a custom authentication flow.
• Expires: the web session expiration time.
• LoggedIn: whether the user associated with this session has successfully undergone the authentication procedures.
• Login: the login name used by the user to authenticate themselves.
• LoginAttempts: the number of login attempts available for the user.
• LogoutRequestID: the LogoutRequest ID.
• NameID: the NameID of the user.
• NameIDFormat: the format of the NameID of the user.
• FormattedNameID: the formatted version of the NameID.
• NameIDPolicyFormat: the name ID policy format.
• NameIDPolicyIdentifier: the name ID policy identifier.
• RelayState: the current (last) relay state entry.
• ResponseLocation: the location where the response should be sent.
• Session: the session ID (the same as you pass as parameter).
• SessionIndex: the cross-network session index assigned to this session.
• SP: the entity ID of the service provider.
• URL: the current request's URL.
• UserData: the protocol-independent user data. Use this session property to store custom information associated with the session across contexts.

import_settings method (SAMLIdPServer Struct)

Loads the metadata required for information exchange with the identity provider. Both local (IdP-side) and remote (SP-side) metadata can be loaded with this call.

Syntax

fn import_settings(&self, metadata : &str, id_p : bool) -> Result<(), SecureBlackboxError>

Remarks

The Service provider (SP) may have a lot of different options and requirements for interactions with the Identity provider (IdP). Usually all these options together with X.509 certificates needed for data exchange are stored in XML metadata files. Use this method to load metadata from such file generated by the service provider.

The Metadata parameter contains metadata in the form of byte array. Set IdP parameter to true to indicate that it is the Identity Provider's own settings that are being loaded.

The loaded metadata is populated in the id_p_settings or sp_settings object (depending on the value of the IdP parameter).

initiate_artifact_resolve method (SAMLIdPServer Struct)

Initiates the artifact resolution protocol.

Syntax

fn initiate_artifact_resolve(&self, connection_id : i64, session_id : &str, sp_service_index : i32, artifact : &str, tag : &str) ->  Result<i32, SecureBlackboxError>

Remarks

Use this event to initiate the artifact resolution protocol for Artifact. Specify the desired SP service endpoint via the SPServiceIndex parameter.

You can use this method with or without the offline_mode.

Note: this method is currently in development and will be available in later SecureBlackbox updates.

initiate_auth method (SAMLIdPServer Struct)

Starts IdP-initiated SAML authentication flow.

Syntax

fn initiate_auth(&self, connection_id : i64, session_id : &str, sp_service_index : i32, tag : &str) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to initiate SAML authentication flow on the IdP side.

This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the on_processing_completed event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.

You can use this method with or without the offline_mode.

Once the user has been authenticated, you can use process_sign_on_request to generate SAML assertions for specific SPs.

initiate_logout method (SAMLIdPServer Struct)

Starts IdP-initiated SAML logout flow.

Syntax

fn initiate_logout(&self, connection_id : i64, session_id : &str, sp_service_index : i32, tag : &str) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to initiate SAML logout flow on the IdP side. Pass the index of the logout endpoint that you want to use to the SPServiceIndex parameter.

This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the on_processing_completed event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.

You can use this method with or without the offline_mode.

list_clients method (SAMLIdPServer Struct)

Enumerates the connected clients.

Syntax

fn list_clients(&self) ->  Result<String, SecureBlackboxError>

Remarks

This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection.

pin_client method (SAMLIdPServer Struct)

Takes a snapshot of the connection's properties.

Syntax

fn pin_client(&self, connection_id : i64) -> Result<(), SecureBlackboxError>

Remarks

Use this method to take a snapshot of a connected client. The captured properties are populated in pinned_client and pinned_client_chain properties.

process_artifact method (SAMLIdPServer Struct)

Processes an artifact request received from the SP service at one of artifact receiver endpoints.

Syntax

fn process_artifact(&self, connection_id : i64, session_id : &str, request : &str, tag : &str) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to pass a SAML artifact received at one of the artifact endpoints.

Artifact messages are typically very simple:

https://idp.server.com/sso/artifact?SAMLart=artifact

In response to the artifact received, the server initiates an artifact resolution protocol to retrieve the SAML message identified by the artifact. This will typically expose itself via an invocation of the on_artifact_resolve_request_prepared event, and, later on, of an event matching the type of the actual message received - such as on_authn_request_received.

You can use this method with or without the offline_mode.

Note: this method is currently in development and will be available in later SecureBlackbox updates.

process_artifact_resolve_request method (SAMLIdPServer Struct)

Processes an artifact request received from the SP service at one of the ARS endpoints.

Syntax

fn process_artifact_resolve_request(&self, connection_id : i64, session_id : &str, request : &str, tag : &str) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to pass a SAML artifact request received at one of the ArtifactResolutionService endpoints.

This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the on_processing_completed event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.

You can use this method with or without the offline_mode.

Note: this method is currently in development and will be available in later SecureBlackbox updates.

process_attribute_query method (SAMLIdPServer Struct)

Processes an attribute request received from the SP service at one of the AQS endpoints.

Syntax

fn process_attribute_query(&self, connection_id : i64, session_id : &str, request : &str, tag : &str) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to pass a SAML attribute request received at one of the AttributeQueryService endpoints.

This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the on_processing_completed event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.

You can use this method with or without the offline_mode.

Note: this method is currently in development and will be available in later SecureBlackbox updates.

process_generic_request method (SAMLIdPServer Struct)

Processes a generic HTTP SAML request.

Syntax

fn process_generic_request(&self, connection_id : i64, request : &[u8]) ->  Result<Vec<u8>, SecureBlackboxError>

Remarks

Use this method to process a generic well-formed HTTP SAML request obtained elsewhere. This is a handy mechanism to bind the SAML processor to an external web engine.

The Request parameter is expected to contain a full HTTP request, including the HTTP method string (GET, POST) and all the headers.

You can use this method with or without the offline_mode.

process_logout_request method (SAMLIdPServer Struct)

Processes logout request received from the SP service at one of the SLS endpoints.

Syntax

fn process_logout_request(&self, connection_id : i64, session_id : &str, request : &str, tag : &str) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to pass a SAML logout request received at one of the SingleLogoutService endpoints.

An SLS endpoint may receive requests of two kinds: LogoutRequest and LogoutResponse. If Request contains a LogoutRequest, the content generated by this method will contain a corresponding LogoutResponse. If Request contains a LogoutResponse, the returned content is empty.

This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the on_processing_completed event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.

You can use this method with or without the offline_mode.

process_sign_on_request method (SAMLIdPServer Struct)

Processes a single sign-on request received from the SP service at one of the SSO endpoints.

Syntax

fn process_sign_on_request(&self, connection_id : i64, session_id : &str, request : &str, tag : &str) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to pass a SAML Single Sign-On request received at one of the SingleSignOnService endpoints.

This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the on_processing_completed event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.

You can use this method with or without the offline_mode.

process_sign_on_response method (SAMLIdPServer Struct)

Processes the submission of the login form previously generated by the IdP server.

Syntax

fn process_sign_on_response(&self, connection_id : i64, session_id : &str, response : &str, tag : &str) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to pass the login form data that was received from the user in response to the presented login form, to the IdP server. If the provided data matches the form, the credentials are passed to the application via the on_user_auth_verify_credentials event.

This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the on_processing_completed event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.

You can use this method with or without the offline_mode.

remove_sp method (SAMLIdPServer Struct)

Removes an SP from the list of known service providers.

Syntax

fn remove_sp(&self, index : i32) -> Result<(), SecureBlackboxError>

Remarks

Use this method to remove information about a service provider from the sp_settings list. The IdP server will be unable to process any further requests from this provider once it is removed.

reset method (SAMLIdPServer Struct)

Resets the struct settings.

Syntax

fn reset(&self) -> Result<(), SecureBlackboxError>

Remarks

reset is a generic method available in every struct.

set_client_buffer method (SAMLIdPServer Struct)

Commits a data buffer to the connection.

Syntax

fn set_client_buffer(&self, connection_id : i64, handle : &str, value : &[u8]) -> Result<(), SecureBlackboxError>

Remarks

Use this method from your on_resource_read event handler to commit a chunk of file data to the server component.

set_provider_property method (SAMLIdPServer Struct)

Sets the value of a custom provider property.

Syntax

fn set_provider_property(&self, name : &str, value : &str) -> Result<(), SecureBlackboxError>

Remarks

This method, together with get_provider_property, provides an extensible way of managing the Identity Provider's settings that are not available through the primary properties of the component. As SAML usage scenarios evolve and new providers appear, the list of supported properties can be extended.

The following properties are currently supported:

• ContactPerson
• OrganizationName
• OrganizationDisplayName
• OrganizationURL
• OrganizationLang

set_response_header method (SAMLIdPServer Struct)

Sets a response header.

Syntax

fn set_response_header(&self, connection_id : i64, header_name : &str, value : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to set a response header. A good place to call this method is a request-marking event, such as on_get_request or on_post_request.

set_session_property method (SAMLIdPServer Struct)

Sets the value of a custom provider session property.

Syntax

fn set_session_property(&self, session_id : &str, name : &str, value : &str) -> Result<(), SecureBlackboxError>

Remarks

This method, together with get_session_property, provides an extensible way of managing the Identity Provider's session settings that are not available through the primary properties and events of the component.

The following properties can be adjusted for each individual session:

• AuthnContextClassRef: the authentication context Auth class.
• AuthnRequestID: the AuthnRequest ID.
• Certificate: the certificate that signed the request (in base16 DER-encoded format).
• CustomAuthFlow: whether the session uses a custom authentication flow.
• Login: the login name used by the user to authenticate themselves.
• LoginAttempts: the number of login attempts available for the user.
• LogoutRequestID: the LogoutRequest ID.
• NameID: the NameID of the user.
• NameIDPolicyFormat: the name ID policy format.
• NameIDPolicyIdentifier: the name ID policy identifier.
• RelayState: the current (last) relay state entry.
• ResponseLocation: the location where the response should be sent.
• Session: the session ID (the same as you pass as parameter).
• SessionIndex: the cross-network session index assigned to this session.
• URL: the current request's URL.
• UserData: the protocol-independent user data. Use this session property to store custom information associated with the session across contexts.

Note: setting a session property invokes a call to on_session_state_save. The component does that to update the session state kept externally.

Note: changing session properties mindlessly may break the protocol flow. For example, changing AuthnRequestID to a different value may cause the Service Provider to reject the subsequent assertion message, as it will contain a now-unmatching In-Response-To entry.

start method (SAMLIdPServer Struct)

Starts the IdP server.

Syntax

fn start(&self) -> Result<(), SecureBlackboxError>

Remarks

Use this method to start listening for incoming connections.

stop method (SAMLIdPServer Struct)

Stops the IdP server.

Syntax

fn stop(&self) -> Result<(), SecureBlackboxError>

Remarks

Call this method to stop listening for incoming connections.

on_accept event (SAMLIdPServer Struct)

Reports an incoming connection.

Syntax

// SAMLIdPServerAcceptEventArgs carries the SAMLIdPServer Accept event's parameters.
pub struct SAMLIdPServerAcceptEventArgs {
  fn remote_address(&self) -> &String
  fn remote_port(&self) -> i32
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// SAMLIdPServerAcceptEvent defines the signature of the SAMLIdPServer Accept event's handler function.
pub trait SAMLIdPServerAcceptEvent {
  fn on_accept(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerAcceptEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_accept(&self) -> &'a dyn SAMLIdPServerAcceptEvent;
  pub fn set_on_accept(&mut self, value : &'a dyn SAMLIdPServerAcceptEvent);
  ...
}

Remarks

This event is fired when a new connection from RemoteAddress:RemotePort is ready to be accepted. Use the Accept parameter to accept or decline it.

Subscribe to on_connect event to be notified of every connection that has been set up.

on_artifact_received event (SAMLIdPServer Struct)

The server fires this event upon receiving an Artifact message from the other side.

Syntax

// SAMLIdPServerArtifactReceivedEventArgs carries the SAMLIdPServer ArtifactReceived event's parameters.
pub struct SAMLIdPServerArtifactReceivedEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn request_id(&self) -> &String
  fn sp(&self) -> &String
  fn artifact(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SAMLIdPServerArtifactReceivedEvent defines the signature of the SAMLIdPServer ArtifactReceived event's handler function.
pub trait SAMLIdPServerArtifactReceivedEvent {
  fn on_artifact_received(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerArtifactReceivedEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_artifact_received(&self) -> &'a dyn SAMLIdPServerArtifactReceivedEvent;
  pub fn set_on_artifact_received(&mut self, value : &'a dyn SAMLIdPServerArtifactReceivedEvent);
  ...
}

Remarks

The Artifact message is very simple and only contains the actual artifact (an opaque string). Depending on the choice of the Action parameter, the further flow may go as following:

• fraAuto: the server will prepare an ArtifactResolve request and sent it to the other side to retrieve the artifact.
• fraCustom: the server will acknowledge the receipt of the artifact, but it is the task of your code to request the message and pass it on to the server via process_generic_request method.
• fraReject: the server will discard the artifact.

Note that you still can choose fraAuto to let the server proceed, but alter the flow as required in further events, such as on_artifact_resolve_request_prepared.

In offline_mode this event would typically be fired from process_artifact call.

on_artifact_resolve_request_prepared event (SAMLIdPServer Struct)

This event is fired when a new artifact resolution request message has been prepared by the struct.

Syntax

// SAMLIdPServerArtifactResolveRequestPreparedEventArgs carries the SAMLIdPServer ArtifactResolveRequestPrepared event's parameters.
pub struct SAMLIdPServerArtifactResolveRequestPreparedEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn request_id(&self) -> &String
  fn sp(&self) -> &String
  fn artifact(&self) -> &String
}

// SAMLIdPServerArtifactResolveRequestPreparedEvent defines the signature of the SAMLIdPServer ArtifactResolveRequestPrepared event's handler function.
pub trait SAMLIdPServerArtifactResolveRequestPreparedEvent {
  fn on_artifact_resolve_request_prepared(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerArtifactResolveRequestPreparedEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_artifact_resolve_request_prepared(&self) -> &'a dyn SAMLIdPServerArtifactResolveRequestPreparedEvent;
  pub fn set_on_artifact_resolve_request_prepared(&mut self, value : &'a dyn SAMLIdPServerArtifactResolveRequestPreparedEvent);
  ...
}

Remarks

Subscribe to this event to be notified about preparation of artifact resolution requests. This is fired right after the resolution request has been prepared, and just before the component sends it out to the service provider.

on_artifact_resolve_request_received event (SAMLIdPServer Struct)

Reports receipt of ArtifactResolveRequest message.

Syntax

// SAMLIdPServerArtifactResolveRequestReceivedEventArgs carries the SAMLIdPServer ArtifactResolveRequestReceived event's parameters.
pub struct SAMLIdPServerArtifactResolveRequestReceivedEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn request_id(&self) -> &String
  fn sp(&self) -> &String
  fn is_encrypted(&self) -> bool
  fn is_signed(&self) -> bool
  fn artifact(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SAMLIdPServerArtifactResolveRequestReceivedEvent defines the signature of the SAMLIdPServer ArtifactResolveRequestReceived event's handler function.
pub trait SAMLIdPServerArtifactResolveRequestReceivedEvent {
  fn on_artifact_resolve_request_received(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerArtifactResolveRequestReceivedEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_artifact_resolve_request_received(&self) -> &'a dyn SAMLIdPServerArtifactResolveRequestReceivedEvent;
  pub fn set_on_artifact_resolve_request_received(&mut self, value : &'a dyn SAMLIdPServerArtifactResolveRequestReceivedEvent);
  ...
}

Remarks

The component fires this event to report receipt of incoming artifact resolution request. The Artifact parameter contains the artifact identifier received.

The application can choose to accept or reject the request, or process it manually, using the Action parameter:

on_assertion_prepared event (SAMLIdPServer Struct)

This event fires when a new assertion has been prepared by the IdP server.

Syntax

// SAMLIdPServerAssertionPreparedEventArgs carries the SAMLIdPServer AssertionPrepared event's parameters.
pub struct SAMLIdPServerAssertionPreparedEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn request_id(&self) -> &String
  fn sp(&self) -> &String
  fn body(&self) -> &String
  fn auth(&self) -> &String
  fn name_id(&self) -> &String
  fn name_id_format(&self) -> &String
  fn session_index(&self) -> &String
  fn attributes(&self) -> &String
  fn valid_from(&self) -> &String
  fn valid_to(&self) -> &String
}

// SAMLIdPServerAssertionPreparedEvent defines the signature of the SAMLIdPServer AssertionPrepared event's handler function.
pub trait SAMLIdPServerAssertionPreparedEvent {
  fn on_assertion_prepared(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerAssertionPreparedEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_assertion_prepared(&self) -> &'a dyn SAMLIdPServerAssertionPreparedEvent;
  pub fn set_on_assertion_prepared(&mut self, value : &'a dyn SAMLIdPServerAssertionPreparedEvent);
  ...
}

Remarks

The component fires this event when it has prepared an assertion to be sent to the SP as part of the authentication process. This event may fire from within process_sign_on_request and process_sign_on_response calls when working in offline_mode, and at any time otherwise.

The RequestID parameter contains the request ID, in response to which the assertion was created. The SP parameter contains the identifier of the service provider where the assertion will be sent to. The Body parameter contains the assertion itself in XML format. The NameID parameter contains the name identifier of the authenticated user, and SessionIndex the unique session index of the new session. The ValidFrom and ValidTo parameters specify the validity period of the assertion.

on_attribute_query_received event (SAMLIdPServer Struct)

Notifies the application about receipt of an AttributeQuery.

Syntax

// SAMLIdPServerAttributeQueryReceivedEventArgs carries the SAMLIdPServer AttributeQueryReceived event's parameters.
pub struct SAMLIdPServerAttributeQueryReceivedEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn request_id(&self) -> &String
  fn sp(&self) -> &String
  fn is_encrypted(&self) -> bool
  fn is_signed(&self) -> bool
  fn name_id(&self) -> &String
  fn name_id_format(&self) -> &String
  fn attributes(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SAMLIdPServerAttributeQueryReceivedEvent defines the signature of the SAMLIdPServer AttributeQueryReceived event's handler function.
pub trait SAMLIdPServerAttributeQueryReceivedEvent {
  fn on_attribute_query_received(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerAttributeQueryReceivedEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_attribute_query_received(&self) -> &'a dyn SAMLIdPServerAttributeQueryReceivedEvent;
  pub fn set_on_attribute_query_received(&mut self, value : &'a dyn SAMLIdPServerAttributeQueryReceivedEvent);
  ...
}

Remarks

The component fires this event to notify the application of receipt of an AttributeQuery message. The parameters of the event detail the properties included in the request. The NameID and NameIDFormat specify the subject, and the Attributes string contains a list of attributes being requested.

The application can choose to accept or reject the request, or process it manually, using the Action parameter:

If the application chooses to process the request manually, the component will go ahead to fire on_read_attribute event repeatedly for each attribute in the list. The application must subscribe to the event and return the attribute parameters and values from there.

on_authn_request_received event (SAMLIdPServer Struct)

The server fires this event upon receiving an AuthnRequest message from the other side.

Syntax

// SAMLIdPServerAuthnRequestReceivedEventArgs carries the SAMLIdPServer AuthnRequestReceived event's parameters.
pub struct SAMLIdPServerAuthnRequestReceivedEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn request_id(&self) -> &String
  fn sp(&self) -> &String
  fn is_encrypted(&self) -> bool
  fn is_signed(&self) -> bool
  fn name_id_format(&self) -> &String
  fn set_name_id_format(&self, value : &str)
  fn set_name_id_format_ref(&self, value : &String)
  fn force_authn(&self) -> bool
  fn set_force_authn(&self, value : bool)
  fn non_interactive(&self) -> bool
  fn set_non_interactive(&self, value : bool)
  fn authenticated(&self) -> bool
  fn set_authenticated(&self, value : bool)
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SAMLIdPServerAuthnRequestReceivedEvent defines the signature of the SAMLIdPServer AuthnRequestReceived event's handler function.
pub trait SAMLIdPServerAuthnRequestReceivedEvent {
  fn on_authn_request_received(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerAuthnRequestReceivedEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_authn_request_received(&self) -> &'a dyn SAMLIdPServerAuthnRequestReceivedEvent;
  pub fn set_on_authn_request_received(&mut self, value : &'a dyn SAMLIdPServerAuthnRequestReceivedEvent);
  ...
}

Remarks

The event reports the details of the received AuthnRequest message. The ForceAuthn and NonInteractive parameters contain optional suggestions included in the request. The Authenticated parameter specifies whether the user has already been authenticated within this session. All the three parameters can be adjusted in the event handler to direct the authentication logic in the required direction.

The application can choose to accept or reject the request, or process it manually, using the Action parameter:

In offline_mode this event would typically be fired from process_sign_on_request call.

on_connect event (SAMLIdPServer Struct)

Reports an accepted connection.

Syntax

// SAMLIdPServerConnectEventArgs carries the SAMLIdPServer Connect event's parameters.
pub struct SAMLIdPServerConnectEventArgs {
  fn connection_id(&self) -> i64
  fn remote_address(&self) -> &String
  fn remote_port(&self) -> i32
}

// SAMLIdPServerConnectEvent defines the signature of the SAMLIdPServer Connect event's handler function.
pub trait SAMLIdPServerConnectEvent {
  fn on_connect(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerConnectEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_connect(&self) -> &'a dyn SAMLIdPServerConnectEvent;
  pub fn set_on_connect(&mut self, value : &'a dyn SAMLIdPServerConnectEvent);
  ...
}

Remarks

The struct fires this event to report that a new connection has been established. ConnectionId indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as on_session_closed or on_session_established.

on_disconnect event (SAMLIdPServer Struct)

Fires to report a disconnected client.

Syntax

// SAMLIdPServerDisconnectEventArgs carries the SAMLIdPServer Disconnect event's parameters.
pub struct SAMLIdPServerDisconnectEventArgs {
  fn connection_id(&self) -> i64
}

// SAMLIdPServerDisconnectEvent defines the signature of the SAMLIdPServer Disconnect event's handler function.
pub trait SAMLIdPServerDisconnectEvent {
  fn on_disconnect(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerDisconnectEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_disconnect(&self) -> &'a dyn SAMLIdPServerDisconnectEvent;
  pub fn set_on_disconnect(&mut self, value : &'a dyn SAMLIdPServerDisconnectEvent);
  ...
}

Remarks

The struct fires this event when a connected client disconnects.

on_error event (SAMLIdPServer Struct)

Information about errors during data delivery.

Syntax

// SAMLIdPServerErrorEventArgs carries the SAMLIdPServer Error event's parameters.
pub struct SAMLIdPServerErrorEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn error_code(&self) -> i32
  fn fatal(&self) -> bool
  fn remote(&self) -> bool
  fn description(&self) -> &String
}

// SAMLIdPServerErrorEvent defines the signature of the SAMLIdPServer Error event's handler function.
pub trait SAMLIdPServerErrorEvent {
  fn on_error(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerErrorEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_error(&self) -> &'a dyn SAMLIdPServerErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn SAMLIdPServerErrorEvent);
  ...
}

Remarks

The event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the section.

on_external_sign event (SAMLIdPServer Struct)

Handles remote or external signing initiated by the server protocol.

Syntax

// SAMLIdPServerExternalSignEventArgs carries the SAMLIdPServer ExternalSign event's parameters.
pub struct SAMLIdPServerExternalSignEventArgs {
  fn connection_id(&self) -> i64
  fn operation_id(&self) -> &String
  fn hash_algorithm(&self) -> &String
  fn pars(&self) -> &String
  fn data(&self) -> &String
  fn signed_data(&self) -> &String
  fn set_signed_data(&self, value : &str)
  fn set_signed_data_ref(&self, value : &String)
}

// SAMLIdPServerExternalSignEvent defines the signature of the SAMLIdPServer ExternalSign event's handler function.
pub trait SAMLIdPServerExternalSignEvent {
  fn on_external_sign(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerExternalSignEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_external_sign(&self) -> &'a dyn SAMLIdPServerExternalSignEvent;
  pub fn set_on_external_sign(&mut self, value : &'a dyn SAMLIdPServerExternalSignEvent);
  ...
}

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the struct via the SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact struct being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.

The struct uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

on_logout_request_prepared event (SAMLIdPServer Struct)

This event is fired when a new logout request has been prepared.

Syntax

// SAMLIdPServerLogoutRequestPreparedEventArgs carries the SAMLIdPServer LogoutRequestPrepared event's parameters.
pub struct SAMLIdPServerLogoutRequestPreparedEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn request_id(&self) -> &String
  fn sp(&self) -> &String
  fn name_id(&self) -> &String
  fn name_id_format(&self) -> &String
  fn session_index(&self) -> &String
  fn relay_state(&self) -> &String
  fn set_relay_state(&self, value : &str)
  fn set_relay_state_ref(&self, value : &String)
}

// SAMLIdPServerLogoutRequestPreparedEvent defines the signature of the SAMLIdPServer LogoutRequestPrepared event's handler function.
pub trait SAMLIdPServerLogoutRequestPreparedEvent {
  fn on_logout_request_prepared(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerLogoutRequestPreparedEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_logout_request_prepared(&self) -> &'a dyn SAMLIdPServerLogoutRequestPreparedEvent;
  pub fn set_on_logout_request_prepared(&mut self, value : &'a dyn SAMLIdPServerLogoutRequestPreparedEvent);
  ...
}

Remarks

The component uses this event to report completion of the LogoutRequest preparation. The NameID, NameIDFormat, and SessionIndex parameters indicate the subject that is being logged out. The SP parameter references the service provider involved.

The RelayState contains the relay state value that is going to be passed with the LogoutRequest to the remote party and mirrored back (if the protocol supports it).

on_logout_request_received event (SAMLIdPServer Struct)

The struct uses this event to notify the application about an incoming SAML Logout Request message.

Syntax

// SAMLIdPServerLogoutRequestReceivedEventArgs carries the SAMLIdPServer LogoutRequestReceived event's parameters.
pub struct SAMLIdPServerLogoutRequestReceivedEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn request_id(&self) -> &String
  fn sp(&self) -> &String
  fn is_encrypted(&self) -> bool
  fn is_signed(&self) -> bool
  fn name_id(&self) -> &String
  fn name_id_format(&self) -> &String
  fn session_index(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SAMLIdPServerLogoutRequestReceivedEvent defines the signature of the SAMLIdPServer LogoutRequestReceived event's handler function.
pub trait SAMLIdPServerLogoutRequestReceivedEvent {
  fn on_logout_request_received(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerLogoutRequestReceivedEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_logout_request_received(&self) -> &'a dyn SAMLIdPServerLogoutRequestReceivedEvent;
  pub fn set_on_logout_request_received(&mut self, value : &'a dyn SAMLIdPServerLogoutRequestReceivedEvent);
  ...
}

Remarks

The SAML IdP server fires this event when a SAML logout request is received at a single logout service endpoint. The NameID, NameIDFormat, and SessionIndex parameters indicate the principal that is signing out.

The application can choose to accept or reject the request, or process it manually, using the Action parameter:

on_logout_response_prepared event (SAMLIdPServer Struct)

The struct uses this event to notify the application about the Logout Response message being ready to be sent.

Syntax

// SAMLIdPServerLogoutResponsePreparedEventArgs carries the SAMLIdPServer LogoutResponsePrepared event's parameters.
pub struct SAMLIdPServerLogoutResponsePreparedEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn request_id(&self) -> &String
  fn sp(&self) -> &String
  fn body(&self) -> &String
  fn name_id(&self) -> &String
  fn name_id_format(&self) -> &String
  fn session_index(&self) -> &String
}

// SAMLIdPServerLogoutResponsePreparedEvent defines the signature of the SAMLIdPServer LogoutResponsePrepared event's handler function.
pub trait SAMLIdPServerLogoutResponsePreparedEvent {
  fn on_logout_response_prepared(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerLogoutResponsePreparedEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_logout_response_prepared(&self) -> &'a dyn SAMLIdPServerLogoutResponsePreparedEvent;
  pub fn set_on_logout_response_prepared(&mut self, value : &'a dyn SAMLIdPServerLogoutResponsePreparedEvent);
  ...
}

Remarks

The IdP server fires this event when it has prepared a Logout Response message and is ready to send it out to the SP.

on_logout_response_received event (SAMLIdPServer Struct)

The struct uses this event to notify the application about an incoming SAML LogoutResponse message.

Syntax

// SAMLIdPServerLogoutResponseReceivedEventArgs carries the SAMLIdPServer LogoutResponseReceived event's parameters.
pub struct SAMLIdPServerLogoutResponseReceivedEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn request_id(&self) -> &String
  fn sp(&self) -> &String
  fn is_encrypted(&self) -> bool
  fn is_signed(&self) -> bool
  fn name_id(&self) -> &String
  fn name_id_format(&self) -> &String
  fn session_index(&self) -> &String
  fn relay_state(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SAMLIdPServerLogoutResponseReceivedEvent defines the signature of the SAMLIdPServer LogoutResponseReceived event's handler function.
pub trait SAMLIdPServerLogoutResponseReceivedEvent {
  fn on_logout_response_received(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerLogoutResponseReceivedEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_logout_response_received(&self) -> &'a dyn SAMLIdPServerLogoutResponseReceivedEvent;
  pub fn set_on_logout_response_received(&mut self, value : &'a dyn SAMLIdPServerLogoutResponseReceivedEvent);
  ...
}

Remarks

The SAML IdP server fires this event when a SAML logout response is received at a single logout service endpoint following the LogoutRequest sent earlier. The RelayState is a mirrored back value included in the request.

The NameID, NameIDFormat, and SessionIndex parameters indicate the principal that is signing out.

The application can choose to accept or reject the request, or process it manually, using the Action parameter:

on_new_assertion event (SAMLIdPServer Struct)

This event reports a new assertion initiated by the IdP server.

Syntax

// SAMLIdPServerNewAssertionEventArgs carries the SAMLIdPServer NewAssertion event's parameters.
pub struct SAMLIdPServerNewAssertionEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn request_id(&self) -> &String
  fn sp(&self) -> &String
  fn reason(&self) -> i32
  fn auth_instant(&self) -> &String
  fn set_auth_instant(&self, value : &str)
  fn set_auth_instant_ref(&self, value : &String)
  fn auth_context(&self) -> &String
  fn set_auth_context(&self, value : &str)
  fn set_auth_context_ref(&self, value : &String)
  fn name_id(&self) -> &String
  fn set_name_id(&self, value : &str)
  fn set_name_id_ref(&self, value : &String)
  fn name_id_format(&self) -> &String
  fn set_name_id_format(&self, value : &str)
  fn set_name_id_format_ref(&self, value : &String)
  fn session_index(&self) -> &String
  fn set_session_index(&self, value : &str)
  fn set_session_index_ref(&self, value : &String)
  fn attributes(&self) -> &String
  fn set_attributes(&self, value : &str)
  fn set_attributes_ref(&self, value : &String)
  fn valid_from(&self) -> &String
  fn set_valid_from(&self, value : &str)
  fn set_valid_from_ref(&self, value : &String)
  fn valid_to(&self) -> &String
  fn set_valid_to(&self, value : &str)
  fn set_valid_to_ref(&self, value : &String)
  fn sign(&self) -> bool
  fn set_sign(&self, value : bool)
  fn encrypt(&self) -> bool
  fn set_encrypt(&self, value : bool)
}

// SAMLIdPServerNewAssertionEvent defines the signature of the SAMLIdPServer NewAssertion event's handler function.
pub trait SAMLIdPServerNewAssertionEvent {
  fn on_new_assertion(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerNewAssertionEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_new_assertion(&self) -> &'a dyn SAMLIdPServerNewAssertionEvent;
  pub fn set_on_new_assertion(&mut self, value : &'a dyn SAMLIdPServerNewAssertionEvent);
  ...
}

Remarks

The component fires this event when it is about to prepare an assertion to be sent to the SP as part of the authentication or attribute request process. This event may fire from within the process_sign_on_request and process_sign_on_response calls when working in offline_mode, and at any time otherwise.

The RequestID parameter contains the request ID, in response to which the assertion is being created. The SP parameter contains the identifier of the service provider where the assertion will be sent to.

The Reason parameter contains the reason for the assertion to be generated. This can be an authentication request or an attribute request being received. The AuthInstant, AuthContext, NameID, SessionIndex, Attributes, ValidFrom, and ValidTo parameters indicate the initial parameters of the new assertion. Further events, such as on_read_attribute or on_assertion_prepared will be fired later on to clarify the contents of the assertion.

on_notification event (SAMLIdPServer Struct)

This event notifies the application about an underlying control flow event.

Syntax

// SAMLIdPServerNotificationEventArgs carries the SAMLIdPServer Notification event's parameters.
pub struct SAMLIdPServerNotificationEventArgs {
  fn event_id(&self) -> &String
  fn event_param(&self) -> &String
}

// SAMLIdPServerNotificationEvent defines the signature of the SAMLIdPServer Notification event's handler function.
pub trait SAMLIdPServerNotificationEvent {
  fn on_notification(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerNotificationEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_notification(&self) -> &'a dyn SAMLIdPServerNotificationEvent;
  pub fn set_on_notification(&mut self, value : &'a dyn SAMLIdPServerNotificationEvent);
  ...
}

Remarks

The struct fires this event to let the application know about some event, occurrence, or milestone in the struct. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the struct, the exact action it is performing, or the document being processed, one or both may be omitted.

This struct can fire this event with the following EventID values:

on_processing_completed event (SAMLIdPServer Struct)

This event notifies the application of the completion of request or response processing.

Syntax

// SAMLIdPServerProcessingCompletedEventArgs carries the SAMLIdPServer ProcessingCompleted event's parameters.
pub struct SAMLIdPServerProcessingCompletedEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn tag(&self) -> &String
  fn processing_result(&self) -> i32
  fn response(&self) -> &String
  fn redirect(&self) -> bool
}

// SAMLIdPServerProcessingCompletedEvent defines the signature of the SAMLIdPServer ProcessingCompleted event's handler function.
pub trait SAMLIdPServerProcessingCompletedEvent {
  fn on_processing_completed(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerProcessingCompletedEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_processing_completed(&self) -> &'a dyn SAMLIdPServerProcessingCompletedEvent;
  pub fn set_on_processing_completed(&mut self, value : &'a dyn SAMLIdPServerProcessingCompletedEvent);
  ...
}

Remarks

The component fires on_processing_completed to notify the application about completion of an earlier initiated processing operation. It is only fired in offline_mode in response to calls such as process_sign_on_request, process_sign_on_response, or similar. The main purpose of this event is to notify the application of the outcomes of the processing and return any prepared SAML entity for subsequent relay to the browser.

This event is fired strictly once for each Process* call, with the ConnectionID matching the value passed to the Process* method.

The SessionID parameter contains the identifier of the current virtual session. It may differ to the value passed to the Process* method if the session information was provided on the fly via the on_session_info_needed event. The ProcessingResult indicates the type of deliverable that was created during the processing (see below for possible values). The Response parameter contains the body of the deliverable. This can take one of the forms:

• a self-submitting form containing a SAML message.
• a redirect URL.
• a web page containing a login form.
• a SOAP XML response.
• an empty string if ProcessingResult is set to sprSuccess.

The Redirect parameter indicates whether the value of Response should be passed to the browser within the 302 Location header, or as a document body.

on_read_artifact event (SAMLIdPServer Struct)

Requests content identified by an artifact from the application.

Syntax

// SAMLIdPServerReadArtifactEventArgs carries the SAMLIdPServer ReadArtifact event's parameters.
pub struct SAMLIdPServerReadArtifactEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn request_id(&self) -> &String
  fn sp(&self) -> &String
  fn artifact(&self) -> &String
  fn value(&self) -> &String
  fn set_value(&self, value : &str)
  fn set_value_ref(&self, value : &String)
  fn skip(&self) -> bool
  fn set_skip(&self, value : bool)
}

// SAMLIdPServerReadArtifactEvent defines the signature of the SAMLIdPServer ReadArtifact event's handler function.
pub trait SAMLIdPServerReadArtifactEvent {
  fn on_read_artifact(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerReadArtifactEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_read_artifact(&self) -> &'a dyn SAMLIdPServerReadArtifactEvent;
  pub fn set_on_read_artifact(&mut self, value : &'a dyn SAMLIdPServerReadArtifactEvent);
  ...
}

Remarks

The component fires this event to request the content matching Artifact from the application. This is normally happens within the artifact resolution protocol between an SP and the IdP server.

The application must provide the requested artifact content via the Value parameter. The application can choose not to provide the artifact content (for example, if it doesn't have it) by setting Skip to true.

on_read_attribute event (SAMLIdPServer Struct)

Requests an attribute from the application.

Syntax

// SAMLIdPServerReadAttributeEventArgs carries the SAMLIdPServer ReadAttribute event's parameters.
pub struct SAMLIdPServerReadAttributeEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn request_id(&self) -> &String
  fn sp(&self) -> &String
  fn name_id(&self) -> &String
  fn name_id_format(&self) -> &String
  fn attr_name(&self) -> &String
  fn set_attr_name(&self, value : &str)
  fn set_attr_name_ref(&self, value : &String)
  fn attr_name_format(&self) -> &String
  fn set_attr_name_format(&self, value : &str)
  fn set_attr_name_format_ref(&self, value : &String)
  fn attr_friendly_name(&self) -> &String
  fn set_attr_friendly_name(&self, value : &str)
  fn set_attr_friendly_name_ref(&self, value : &String)
  fn value(&self) -> &String
  fn set_value(&self, value : &str)
  fn set_value_ref(&self, value : &String)
  fn skip(&self) -> bool
  fn set_skip(&self, value : bool)
}

// SAMLIdPServerReadAttributeEvent defines the signature of the SAMLIdPServer ReadAttribute event's handler function.
pub trait SAMLIdPServerReadAttributeEvent {
  fn on_read_attribute(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerReadAttributeEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_read_attribute(&self) -> &'a dyn SAMLIdPServerReadAttributeEvent;
  pub fn set_on_read_attribute(&mut self, value : &'a dyn SAMLIdPServerReadAttributeEvent);
  ...
}

Remarks

The component fires this event to request an attribute from the application. This event can be invoked multiple times after the on_attribute_query_received event has fired, to collect every attribute requested.

The application is expected to set the Value and, optionally, AttrNameFormat and AttrFriendlyName for every attribute requested. The AttrName matches the name requested by the remote party, but the event handler can change it too if required.

If the application has no knowledge of or does not support the AttrName attribute, it can set Skip to true to avoid sending it.

on_resource_close event (SAMLIdPServer Struct)

Tells the application that it can close the opened resource.

Syntax

// SAMLIdPServerResourceCloseEventArgs carries the SAMLIdPServer ResourceClose event's parameters.
pub struct SAMLIdPServerResourceCloseEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn handle(&self) -> &String
}

// SAMLIdPServerResourceCloseEvent defines the signature of the SAMLIdPServer ResourceClose event's handler function.
pub trait SAMLIdPServerResourceCloseEvent {
  fn on_resource_close(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerResourceCloseEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_resource_close(&self) -> &'a dyn SAMLIdPServerResourceCloseEvent;
  pub fn set_on_resource_close(&mut self, value : &'a dyn SAMLIdPServerResourceCloseEvent);
  ...
}

Remarks

The struct uses this event to notify the application that it can now close the resource opened earlier in its on_resource_open handler.

on_resource_open event (SAMLIdPServer Struct)

Requests the application to open the requested resource.

Syntax

// SAMLIdPServerResourceOpenEventArgs carries the SAMLIdPServer ResourceOpen event's parameters.
pub struct SAMLIdPServerResourceOpenEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn url(&self) -> &String
  fn http_method(&self) -> &String
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
  fn handle(&self) -> &String
  fn set_handle(&self, value : &str)
  fn set_handle_ref(&self, value : &String)
}

// SAMLIdPServerResourceOpenEvent defines the signature of the SAMLIdPServer ResourceOpen event's handler function.
pub trait SAMLIdPServerResourceOpenEvent {
  fn on_resource_open(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerResourceOpenEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_resource_open(&self) -> &'a dyn SAMLIdPServerResourceOpenEvent;
  pub fn set_on_resource_open(&mut self, value : &'a dyn SAMLIdPServerResourceOpenEvent);
  ...
}

Remarks

The struct fires this event in virtualized mode if the application had returned the fraCustom modifier from the earlier on_resource_request event call. Your code is expected to open the requested resource and be prepared to read from it in subsequent on_resource_read event calls. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

on_resource_read event (SAMLIdPServer Struct)

Requests the application to read from an opened resource.

Syntax

// SAMLIdPServerResourceReadEventArgs carries the SAMLIdPServer ResourceRead event's parameters.
pub struct SAMLIdPServerResourceReadEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn handle(&self) -> &String
  fn size(&self) -> i32
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// SAMLIdPServerResourceReadEvent defines the signature of the SAMLIdPServer ResourceRead event's handler function.
pub trait SAMLIdPServerResourceReadEvent {
  fn on_resource_read(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerResourceReadEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_resource_read(&self) -> &'a dyn SAMLIdPServerResourceReadEvent;
  pub fn set_on_resource_read(&mut self, value : &'a dyn SAMLIdPServerResourceReadEvent);
  ...
}

Remarks

The struct fires this event in virtualized mode to request another chunk of data from the resource opened earlier. The handler of this event should read up to Size bytes from the object, and pass them to the component with a set_client_buffer call.

Use the OperationStatus parameter to return the operation result back to the server. When the file has been read up to its end, set OperationStatus to ostEOF to tell the components that no more on_resource_read calls are needed.

Set OperationStatus to one of the following values:

on_resource_request event (SAMLIdPServer Struct)

Notifies the application that a server resource is requested.

Syntax

// SAMLIdPServerResourceRequestEventArgs carries the SAMLIdPServer ResourceRequest event's parameters.
pub struct SAMLIdPServerResourceRequestEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn url(&self) -> &String
  fn http_method(&self) -> &String
  fn res_protected(&self) -> bool
  fn set_res_protected(&self, value : bool)
  fn res_special(&self) -> bool
  fn set_res_special(&self, value : bool)
  fn allow_writing(&self) -> bool
  fn set_allow_writing(&self, value : bool)
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SAMLIdPServerResourceRequestEvent defines the signature of the SAMLIdPServer ResourceRequest event's handler function.
pub trait SAMLIdPServerResourceRequestEvent {
  fn on_resource_request(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerResourceRequestEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_resource_request(&self) -> &'a dyn SAMLIdPServerResourceRequestEvent;
  pub fn set_on_resource_request(&mut self, value : &'a dyn SAMLIdPServerResourceRequestEvent);
  ...
}

Remarks

The struct uses this event to notify the application that the connection has requested a server resource.

The URL parameter specifies the resource requested. ResProtected is set to true if the resource is protected by SAML. ResSpecial is set to true if the request is a SAML resource, such as the metadata or an Assertion Consumer Service page. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code ('virtualize' the request).

This event may fire more than once for one resource if the client is forced to re-submit the request with a session cookie.

Choose Action as one of the following values:

on_resource_write event (SAMLIdPServer Struct)

Requests the application to write to an opened resource.

Syntax

// SAMLIdPServerResourceWriteEventArgs carries the SAMLIdPServer ResourceWrite event's parameters.
pub struct SAMLIdPServerResourceWriteEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn handle(&self) -> &String
  fn operation_status(&self) -> i32
  fn set_operation_status(&self, value : i32)
}

// SAMLIdPServerResourceWriteEvent defines the signature of the SAMLIdPServer ResourceWrite event's handler function.
pub trait SAMLIdPServerResourceWriteEvent {
  fn on_resource_write(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerResourceWriteEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_resource_write(&self) -> &'a dyn SAMLIdPServerResourceWriteEvent;
  pub fn set_on_resource_write(&mut self, value : &'a dyn SAMLIdPServerResourceWriteEvent);
  ...
}

Remarks

The struct fires this event in virtualized mode to pass another chunk of data to a resource opened earlier. This event is called for write-enabled requests, such as POST or PUT. The handler of this event should read the pending data using the get_client_buffer method and write them to the opened file descriptor.

Use the OperationStatus parameter to return the operation result back to the server:

on_saml_message_prepared event (SAMLIdPServer Struct)

This event is fired when a SAML message has been prepared and is ready to be dispatched.

Syntax

// SAMLIdPServerSAMLMessagePreparedEventArgs carries the SAMLIdPServer SAMLMessagePrepared event's parameters.
pub struct SAMLIdPServerSAMLMessagePreparedEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn message_id(&self) -> &String
  fn destination(&self) -> &String
  fn issue_instant(&self) -> &String
  fn in_response_to(&self) -> &String
  fn request_body(&self) -> &String
  fn message_type(&self) -> &String
  fn message_body(&self) -> &String
  fn set_message_body(&self, value : &str)
  fn set_message_body_ref(&self, value : &String)
  fn success(&self) -> bool
  fn set_success(&self, value : bool)
}

// SAMLIdPServerSAMLMessagePreparedEvent defines the signature of the SAMLIdPServer SAMLMessagePrepared event's handler function.
pub trait SAMLIdPServerSAMLMessagePreparedEvent {
  fn on_saml_message_prepared(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerSAMLMessagePreparedEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_saml_message_prepared(&self) -> &'a dyn SAMLIdPServerSAMLMessagePreparedEvent;
  pub fn set_on_saml_message_prepared(&mut self, value : &'a dyn SAMLIdPServerSAMLMessagePreparedEvent);
  ...
}

Remarks

Subscribe to this event to be notified about every SAML message that has been prepared by the server. This event is fired for every type of the outgoing message (e.g. SAMLResponse, LogoutRequest, or IdP metadata). The InResponseTo contains the ID of the message in response to which the current message is sent (if applicable). The RequestBody parameter contains the body of such request.

The MessageType parameter indicates the type of the message that has been prepared, such as SAMLResponse. The MessageBody contains the XML body of the message. The Success parameter indicates whether the message contains a positive statement or an error. Both the MessageBody and Success parameters are adjustable.

on_saml_message_received event (SAMLIdPServer Struct)

The server fires this event for every SAML message it receives.

Syntax

// SAMLIdPServerSAMLMessageReceivedEventArgs carries the SAMLIdPServer SAMLMessageReceived event's parameters.
pub struct SAMLIdPServerSAMLMessageReceivedEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn message_id(&self) -> &String
  fn issuer(&self) -> &String
  fn issue_instant(&self) -> &String
  fn in_response_to(&self) -> &String
  fn request_body(&self) -> &String
  fn message_type(&self) -> &String
  fn message_body(&self) -> &String
  fn is_signed(&self) -> bool
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SAMLIdPServerSAMLMessageReceivedEvent defines the signature of the SAMLIdPServer SAMLMessageReceived event's handler function.
pub trait SAMLIdPServerSAMLMessageReceivedEvent {
  fn on_saml_message_received(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerSAMLMessageReceivedEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_saml_message_received(&self) -> &'a dyn SAMLIdPServerSAMLMessageReceivedEvent;
  pub fn set_on_saml_message_received(&mut self, value : &'a dyn SAMLIdPServerSAMLMessageReceivedEvent);
  ...
}

Remarks

Subscribe to this event to be notified about incoming SAML messages.

The MessageType, MessageID, Issuer, and MessageBody parameters provide the details of the message received. The RequestBody and InResponseTo contain a reference to the request that this message is a response to (if any).

Set Action property as required to let the component know how to proceed.

on_session_created event (SAMLIdPServer Struct)

This event is fired when a new session has been established.

Syntax

// SAMLIdPServerSessionCreatedEventArgs carries the SAMLIdPServer SessionCreated event's parameters.
pub struct SAMLIdPServerSessionCreatedEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
}

// SAMLIdPServerSessionCreatedEvent defines the signature of the SAMLIdPServer SessionCreated event's handler function.
pub trait SAMLIdPServerSessionCreatedEvent {
  fn on_session_created(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerSessionCreatedEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_session_created(&self) -> &'a dyn SAMLIdPServerSessionCreatedEvent;
  pub fn set_on_session_created(&mut self, value : &'a dyn SAMLIdPServerSessionCreatedEvent);
  ...
}

Remarks

ConnectionID contains the identifier of the new session, SessionID specifies the ID of the new session.

on_session_destroyed event (SAMLIdPServer Struct)

This event is fired when the IdP server has closed a session.

Syntax

// SAMLIdPServerSessionDestroyedEventArgs carries the SAMLIdPServer SessionDestroyed event's parameters.
pub struct SAMLIdPServerSessionDestroyedEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
}

// SAMLIdPServerSessionDestroyedEvent defines the signature of the SAMLIdPServer SessionDestroyed event's handler function.
pub trait SAMLIdPServerSessionDestroyedEvent {
  fn on_session_destroyed(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerSessionDestroyedEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_session_destroyed(&self) -> &'a dyn SAMLIdPServerSessionDestroyedEvent;
  pub fn set_on_session_destroyed(&mut self, value : &'a dyn SAMLIdPServerSessionDestroyedEvent);
  ...
}

Remarks

ConnectionID contains the identifier of the closed session.

on_session_event event (SAMLIdPServer Struct)

Notifies the application about SAML session events.

Syntax

// SAMLIdPServerSessionEventEventArgs carries the SAMLIdPServer SessionEvent event's parameters.
pub struct SAMLIdPServerSessionEventEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn event_text(&self) -> &String
}

// SAMLIdPServerSessionEventEvent defines the signature of the SAMLIdPServer SessionEvent event's handler function.
pub trait SAMLIdPServerSessionEventEvent {
  fn on_session_event(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerSessionEventEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_session_event(&self) -> &'a dyn SAMLIdPServerSessionEventEvent;
  pub fn set_on_session_event(&mut self, value : &'a dyn SAMLIdPServerSessionEventEvent);
  ...
}

Remarks

struct uses this event to notify your code about events that happen within the lifeline of a SAML session. Handling it may be useful for development, logging, and monitoring purposes.

The SessionID parameter specifies the session ID, and the EventText parameter describes the event that happened. Below are a few typical examples of what EventText you can expect to get:

• Start
• IdPSSOReceived
• AuthnRequestReceived
• ChallengePrepared
• CredentialsReceived
• ResponsePrepared
• LoggedIn
• LogoutRequestReceived
• LogoutResponsePrepared
• ArtifactResolveReceived
• ArtifactResponsePrepared
• AttributeQueryReceived
• AttributeResponsePrepared
• Finish

on_session_info_needed event (SAMLIdPServer Struct)

This event is fired in OfflineMode to request the session ID for the current flow.

Syntax

// SAMLIdPServerSessionInfoNeededEventArgs carries the SAMLIdPServer SessionInfoNeeded event's parameters.
pub struct SAMLIdPServerSessionInfoNeededEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn set_session_id(&self, value : &str)
  fn set_session_id_ref(&self, value : &String)
}

// SAMLIdPServerSessionInfoNeededEvent defines the signature of the SAMLIdPServer SessionInfoNeeded event's handler function.
pub trait SAMLIdPServerSessionInfoNeededEvent {
  fn on_session_info_needed(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerSessionInfoNeededEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_session_info_needed(&self) -> &'a dyn SAMLIdPServerSessionInfoNeededEvent;
  pub fn set_on_session_info_needed(&mut self, value : &'a dyn SAMLIdPServerSessionInfoNeededEvent);
  ...
}

Remarks

SAML protocol is stateful, which means that SAML services need to keep session-related information between connections. When used in online mode - where the components listen and serve connections automatically - the components can use HTTP cookies to track connecting clients and maintain the session store at the background. However, when used in offline mode, the components do not have access to the HTTP layer and live too short for the session store to survive. That is why in offline mode the components rely on the application code to keep the session information for them.

The components use a collection of Session* events to exchange session information with the application:

• on_session_created is called when the component establishes a new session. In offline mode, the application should associate the session ID with the connected user, for example by returning it as a cookie.
• on_session_state_save : the component passes the session state to the application and expects that the application saves it somewhere to return it back to the component at its request at some point in the future. The session state is an opaque string. The application can use a hash table to store a collection of (SessionID, SessionState) pairs over the lifetime of the SAML service. The server may fire on_session_state_save multiple times for the same SessionID. If this happens, the existing SessionID entry should be overwritten with the fresh session data.
• on_session_state_retrieve : the component passes a session ID to the application and expects it to return the session state saved in the hash table earlier. The application should not delete the state from the hash table, as it may be needed again.
• on_session_info_needed (this event): the component expects the application to return the session ID corresponding to the connection ID back to them. This event fires, for example, if the application calls process_logout_request but passes an empty SessionID as a parameter.
• on_session_destroyed is called when a session is destroyed. The component can remove the session from the hash table upon receiving this event.

on_session_state_retrieve event (SAMLIdPServer Struct)

This event fires to retrieve session state information from the application.

Syntax

// SAMLIdPServerSessionStateRetrieveEventArgs carries the SAMLIdPServer SessionStateRetrieve event's parameters.
pub struct SAMLIdPServerSessionStateRetrieveEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn session_state(&self) -> &String
  fn set_session_state(&self, value : &str)
  fn set_session_state_ref(&self, value : &String)
}

// SAMLIdPServerSessionStateRetrieveEvent defines the signature of the SAMLIdPServer SessionStateRetrieve event's handler function.
pub trait SAMLIdPServerSessionStateRetrieveEvent {
  fn on_session_state_retrieve(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerSessionStateRetrieveEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_session_state_retrieve(&self) -> &'a dyn SAMLIdPServerSessionStateRetrieveEvent;
  pub fn set_on_session_state_retrieve(&mut self, value : &'a dyn SAMLIdPServerSessionStateRetrieveEvent);
  ...
}

Remarks

The component fires this event to request a session state that was previously provided to the application via the on_session_state_save call.

See the on_session_info_needed topic for more details about session management in offline mode.

on_session_state_save event (SAMLIdPServer Struct)

This event passes a session state object to the application for safekeeping.

Syntax

// SAMLIdPServerSessionStateSaveEventArgs carries the SAMLIdPServer SessionStateSave event's parameters.
pub struct SAMLIdPServerSessionStateSaveEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn session_state(&self) -> &String
}

// SAMLIdPServerSessionStateSaveEvent defines the signature of the SAMLIdPServer SessionStateSave event's handler function.
pub trait SAMLIdPServerSessionStateSaveEvent {
  fn on_session_state_save(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerSessionStateSaveEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_session_state_save(&self) -> &'a dyn SAMLIdPServerSessionStateSaveEvent;
  pub fn set_on_session_state_save(&mut self, value : &'a dyn SAMLIdPServerSessionStateSaveEvent);
  ...
}

Remarks

The component fires this event to pass a session state to the application. The application is expected to save the state object (which is an opaque string) in a hash table, and be ready to return it back to the component when it requests it using a on_session_state_retrieve call.

See the on_session_info_needed topic for more details about session management in offline mode.

on_signature_found event (SAMLIdPServer Struct)

Notifies the application about the start of signature validation.

Syntax

// SAMLIdPServerSignatureFoundEventArgs carries the SAMLIdPServer SignatureFound event's parameters.
pub struct SAMLIdPServerSignatureFoundEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn scope(&self) -> i32
  fn signer(&self) -> &String
  fn target_id(&self) -> &String
  fn target_type(&self) -> &String
  fn issuer_rdn(&self) -> &String
  fn serial_number(&self) -> &[u8]
  fn subject_key_id(&self) -> &[u8]
  fn sig_method(&self) -> &String
  fn digest_method(&self) -> &String
  fn cert_found(&self) -> bool
  fn validate(&self) -> bool
  fn set_validate(&self, value : bool)
}

// SAMLIdPServerSignatureFoundEvent defines the signature of the SAMLIdPServer SignatureFound event's handler function.
pub trait SAMLIdPServerSignatureFoundEvent {
  fn on_signature_found(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerSignatureFoundEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_signature_found(&self) -> &'a dyn SAMLIdPServerSignatureFoundEvent;
  pub fn set_on_signature_found(&mut self, value : &'a dyn SAMLIdPServerSignatureFoundEvent);
  ...
}

Remarks

This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified message.

The Scope parameter specifies the subject of the signature. This can be the outermost SAML message or an embedded assertion. The TargetID and TargetType provide additional details.

The details of the reported signature are populated in the security object. For assertion signatures, you can update the details by pinning the assertion.

The CertFound is set to True if the struct has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via KnownCertificates property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. SAMLReader only supports signature validation. To validate the chain, grab the signing certificate from the signing_certificate property and the associated certificates from the certificates collection, and pass them to the CertificateValidator component to validate its chain.

Use the Validate parameter to tell the reader whether it should validate the signature.

on_signature_validated event (SAMLIdPServer Struct)

Reports the signature validation result.

Syntax

// SAMLIdPServerSignatureValidatedEventArgs carries the SAMLIdPServer SignatureValidated event's parameters.
pub struct SAMLIdPServerSignatureValidatedEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn scope(&self) -> i32
  fn signer(&self) -> &String
  fn target_id(&self) -> &String
  fn target_type(&self) -> &String
  fn issuer_rdn(&self) -> &String
  fn serial_number(&self) -> &[u8]
  fn subject_key_id(&self) -> &[u8]
  fn sig_method(&self) -> &String
  fn digest_method(&self) -> &String
  fn validation_result(&self) -> i32
  fn set_validation_result(&self, value : i32)
}

// SAMLIdPServerSignatureValidatedEvent defines the signature of the SAMLIdPServer SignatureValidated event's handler function.
pub trait SAMLIdPServerSignatureValidatedEvent {
  fn on_signature_validated(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerSignatureValidatedEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_signature_validated(&self) -> &'a dyn SAMLIdPServerSignatureValidatedEvent;
  pub fn set_on_signature_validated(&mut self, value : &'a dyn SAMLIdPServerSignatureValidatedEvent);
  ...
}

Remarks

This event is fired when the signature validation process is completed.

The Scope parameter specifies the subject of the signature. This can be the outermost SAML message or an embedded assertion. The TargetID and TargetType parameters provide the details.

Signing certificates are typically identified either by an (IssuerRDN, SerialNumber) pair, or via their unique SubjectKeyID. Use these parameters to look for the signing certificate if it is not available in the signature. The ValidationResult parameter specifies whether the signature is established to be valid or not. You can alter it in the event handler to override the built-in validation outcome.

on_sign_on_page_prepared event (SAMLIdPServer Struct)

The server fires this event upon preparing the sign-on page.

Syntax

// SAMLIdPServerSignOnPagePreparedEventArgs carries the SAMLIdPServer SignOnPagePrepared event's parameters.
pub struct SAMLIdPServerSignOnPagePreparedEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn request_id(&self) -> &String
  fn sp(&self) -> &String
  fn request(&self) -> &String
  fn page_data(&self) -> &String
  fn set_page_data(&self, value : &str)
  fn set_page_data_ref(&self, value : &String)
  fn redirect(&self) -> bool
  fn set_redirect(&self, value : bool)
}

// SAMLIdPServerSignOnPagePreparedEvent defines the signature of the SAMLIdPServer SignOnPagePrepared event's handler function.
pub trait SAMLIdPServerSignOnPagePreparedEvent {
  fn on_sign_on_page_prepared(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerSignOnPagePreparedEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_sign_on_page_prepared(&self) -> &'a dyn SAMLIdPServerSignOnPagePreparedEvent;
  pub fn set_on_sign_on_page_prepared(&mut self, value : &'a dyn SAMLIdPServerSignOnPagePreparedEvent);
  ...
}

Remarks

The IdP server fires this event to notify the application that the sign-on page (login form) has been formed and is ready to be flushed. Use sign_on_page_template to assign the sign-on page template.

The form body is returned via the PageData parameter. You can adjust it in the event handler as required. The Redirect parameter advises whether the form should be returned as a Location header of the HTTP response with the 302 status, or as an HTTP body of text/html type.

on_sign_on_response_received event (SAMLIdPServer Struct)

Notifies the application about the received response to the sign-on page.

Syntax

// SAMLIdPServerSignOnResponseReceivedEventArgs carries the SAMLIdPServer SignOnResponseReceived event's parameters.
pub struct SAMLIdPServerSignOnResponseReceivedEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn request_id(&self) -> &String
  fn response_data(&self) -> &String
  fn set_response_data(&self, value : &str)
  fn set_response_data_ref(&self, value : &String)
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SAMLIdPServerSignOnResponseReceivedEvent defines the signature of the SAMLIdPServer SignOnResponseReceived event's handler function.
pub trait SAMLIdPServerSignOnResponseReceivedEvent {
  fn on_sign_on_response_received(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerSignOnResponseReceivedEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_sign_on_response_received(&self) -> &'a dyn SAMLIdPServerSignOnResponseReceivedEvent;
  pub fn set_on_sign_on_response_received(&mut self, value : &'a dyn SAMLIdPServerSignOnResponseReceivedEvent);
  ...
}

Remarks

The component uses this event to report that the login form previously generated by the component has been filled in and returned by the user. ResponseData contains the content submitted by the user (the URL-encoded form fields, or any authentication data if the custom authentication flow is used). The application that chose to use custom authentication process can use this data to authenticate the user.

The application can choose to accept or reject the request, or process it manually, using the Action parameter:

on_tls_cert_validate event (SAMLIdPServer Struct)

Fires when a client certificate needs to be validated.

Syntax

// SAMLIdPServerTLSCertValidateEventArgs carries the SAMLIdPServer TLSCertValidate event's parameters.
pub struct SAMLIdPServerTLSCertValidateEventArgs {
  fn connection_id(&self) -> i64
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// SAMLIdPServerTLSCertValidateEvent defines the signature of the SAMLIdPServer TLSCertValidate event's handler function.
pub trait SAMLIdPServerTLSCertValidateEvent {
  fn on_tls_cert_validate(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerTLSCertValidateEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_tls_cert_validate(&self) -> &'a dyn SAMLIdPServerTLSCertValidateEvent;
  pub fn set_on_tls_cert_validate(&mut self, value : &'a dyn SAMLIdPServerTLSCertValidateEvent);
  ...
}

Remarks

The struct fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the Accept parameter.

on_tls_established event (SAMLIdPServer Struct)

Reports the setup of a TLS session.

Syntax

// SAMLIdPServerTLSEstablishedEventArgs carries the SAMLIdPServer TLSEstablished event's parameters.
pub struct SAMLIdPServerTLSEstablishedEventArgs {
  fn connection_id(&self) -> i64
}

// SAMLIdPServerTLSEstablishedEvent defines the signature of the SAMLIdPServer TLSEstablished event's handler function.
pub trait SAMLIdPServerTLSEstablishedEvent {
  fn on_tls_established(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerTLSEstablishedEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_tls_established(&self) -> &'a dyn SAMLIdPServerTLSEstablishedEvent;
  pub fn set_on_tls_established(&mut self, value : &'a dyn SAMLIdPServerTLSEstablishedEvent);
  ...
}

Remarks

Subscribe to this event to be notified about the setup of a TLS connection by a connected client.

on_tls_handshake event (SAMLIdPServer Struct)

Fires when a newly established client connection initiates a TLS handshake.

Syntax

// SAMLIdPServerTLSHandshakeEventArgs carries the SAMLIdPServer TLSHandshake event's parameters.
pub struct SAMLIdPServerTLSHandshakeEventArgs {
  fn connection_id(&self) -> i64
  fn server_name(&self) -> &String
  fn abort(&self) -> bool
  fn set_abort(&self, value : bool)
}

// SAMLIdPServerTLSHandshakeEvent defines the signature of the SAMLIdPServer TLSHandshake event's handler function.
pub trait SAMLIdPServerTLSHandshakeEvent {
  fn on_tls_handshake(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerTLSHandshakeEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_tls_handshake(&self) -> &'a dyn SAMLIdPServerTLSHandshakeEvent;
  pub fn set_on_tls_handshake(&mut self, value : &'a dyn SAMLIdPServerTLSHandshakeEvent);
  ...
}

Remarks

Use this event to get notified about the initiation of the TLS handshake by the remote client. The ServerName parameter specifies the requested host from the client hello message.

on_tls_psk event (SAMLIdPServer Struct)

Requests a pre-shared key for TLS-PSK.

Syntax

// SAMLIdPServerTLSPSKEventArgs carries the SAMLIdPServer TLSPSK event's parameters.
pub struct SAMLIdPServerTLSPSKEventArgs {
  fn connection_id(&self) -> i64
  fn identity(&self) -> &String
  fn psk(&self) -> &String
  fn set_psk(&self, value : &str)
  fn set_psk_ref(&self, value : &String)
  fn ciphersuite(&self) -> &String
  fn set_ciphersuite(&self, value : &str)
  fn set_ciphersuite_ref(&self, value : &String)
}

// SAMLIdPServerTLSPSKEvent defines the signature of the SAMLIdPServer TLSPSK event's handler function.
pub trait SAMLIdPServerTLSPSKEvent {
  fn on_tls_psk(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerTLSPSKEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_tls_psk(&self) -> &'a dyn SAMLIdPServerTLSPSKEvent;
  pub fn set_on_tls_psk(&mut self, value : &'a dyn SAMLIdPServerTLSPSKEvent);
  ...
}

Remarks

The struct fires this event to report that a client has requested a TLS-PSK negotiation. ConnectionId indicates the unique connection ID that requested the PSK handshake.

Use Identity to look up for the corresponding pre-shared key in the server's database, then assign the key to the PSK parameter. If TLS 1.3 PSK is used, you will also need to assign the Ciphersuite parameter with the cipher suite associated with that identity and their key.

on_tls_shutdown event (SAMLIdPServer Struct)

Reports closure of a TLS session.

Syntax

// SAMLIdPServerTLSShutdownEventArgs carries the SAMLIdPServer TLSShutdown event's parameters.
pub struct SAMLIdPServerTLSShutdownEventArgs {
  fn connection_id(&self) -> i64
}

// SAMLIdPServerTLSShutdownEvent defines the signature of the SAMLIdPServer TLSShutdown event's handler function.
pub trait SAMLIdPServerTLSShutdownEvent {
  fn on_tls_shutdown(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerTLSShutdownEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_tls_shutdown(&self) -> &'a dyn SAMLIdPServerTLSShutdownEvent;
  pub fn set_on_tls_shutdown(&mut self, value : &'a dyn SAMLIdPServerTLSShutdownEvent);
  ...
}

Remarks

The struct fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a on_disconnect, which marks the closure of the underlying TCP session.

on_user_auth_completed event (SAMLIdPServer Struct)

Notifies the application about the success of user authentication flow.

Syntax

// SAMLIdPServerUserAuthCompletedEventArgs carries the SAMLIdPServer UserAuthCompleted event's parameters.
pub struct SAMLIdPServerUserAuthCompletedEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn sp(&self) -> &String
  fn auth(&self) -> &String
  fn username(&self) -> &String
  fn name_id(&self) -> &String
  fn set_name_id(&self, value : &str)
  fn set_name_id_ref(&self, value : &String)
  fn name_id_format(&self) -> &String
  fn set_name_id_format(&self, value : &str)
  fn set_name_id_format_ref(&self, value : &String)
  fn session_index(&self) -> &String
  fn set_session_index(&self, value : &str)
  fn set_session_index_ref(&self, value : &String)
  fn assertion_ttl(&self) -> i32
  fn set_assertion_ttl(&self, value : i32)
}

// SAMLIdPServerUserAuthCompletedEvent defines the signature of the SAMLIdPServer UserAuthCompleted event's handler function.
pub trait SAMLIdPServerUserAuthCompletedEvent {
  fn on_user_auth_completed(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerUserAuthCompletedEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_user_auth_completed(&self) -> &'a dyn SAMLIdPServerUserAuthCompletedEvent;
  pub fn set_on_user_auth_completed(&mut self, value : &'a dyn SAMLIdPServerUserAuthCompletedEvent);
  ...
}

Remarks

Subscribe to this event to get notified about completion of user authentication flow. The NameID, NameIDFormat, SessionIndex, and AssertionTTL parameters contain the proposed session parameters. You can alter them in your event handler as required.

on_user_auth_failed event (SAMLIdPServer Struct)

Notifies the application about failure of user authentication flow.

Syntax

// SAMLIdPServerUserAuthFailedEventArgs carries the SAMLIdPServer UserAuthFailed event's parameters.
pub struct SAMLIdPServerUserAuthFailedEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn sp(&self) -> &String
  fn auth(&self) -> &String
  fn username(&self) -> &String
  fn can_retry(&self) -> bool
  fn try_again(&self) -> bool
  fn set_try_again(&self, value : bool)
}

// SAMLIdPServerUserAuthFailedEvent defines the signature of the SAMLIdPServer UserAuthFailed event's handler function.
pub trait SAMLIdPServerUserAuthFailedEvent {
  fn on_user_auth_failed(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerUserAuthFailedEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_user_auth_failed(&self) -> &'a dyn SAMLIdPServerUserAuthFailedEvent;
  pub fn set_on_user_auth_failed(&mut self, value : &'a dyn SAMLIdPServerUserAuthFailedEvent);
  ...
}

Remarks

The component fires this event to notify the application about failed user authentication step - for example, if a wrong password was supplied.

The CanRetry parameter indicates whether another attempt of the same type can be performed. If you would like to use that opportunity, set TryAgain to true to restart the process.

on_user_auth_start event (SAMLIdPServer Struct)

Notifies the application about the start of user authentication flow.

Syntax

// SAMLIdPServerUserAuthStartEventArgs carries the SAMLIdPServer UserAuthStart event's parameters.
pub struct SAMLIdPServerUserAuthStartEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn sp(&self) -> &String
  fn supported_auths(&self) -> &String
  fn selected_auth(&self) -> &String
  fn set_selected_auth(&self, value : &str)
  fn set_selected_auth_ref(&self, value : &String)
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SAMLIdPServerUserAuthStartEvent defines the signature of the SAMLIdPServer UserAuthStart event's handler function.
pub trait SAMLIdPServerUserAuthStartEvent {
  fn on_user_auth_start(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerUserAuthStartEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_user_auth_start(&self) -> &'a dyn SAMLIdPServerUserAuthStartEvent;
  pub fn set_on_user_auth_start(&mut self, value : &'a dyn SAMLIdPServerUserAuthStartEvent);
  ...
}

Remarks

Set Action to Auto to proceed with the default sign on page based on sign_on_page_template, or to Custom to supply (or redirect to) your own authentication landing. The SupportedAuths parameter contains the list of authentication methods supported by the server. If you are looking to use a particular authentication method, return it to the server via SelectedAuth parameter.

The application can choose to accept or reject the request, or process it manually, using the Action parameter:

on_user_auth_verify_credentials event (SAMLIdPServer Struct)

Passes user credentials to the application for verification.

Syntax

// SAMLIdPServerUserAuthVerifyCredentialsEventArgs carries the SAMLIdPServer UserAuthVerifyCredentials event's parameters.
pub struct SAMLIdPServerUserAuthVerifyCredentialsEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn sp(&self) -> &String
  fn claimed_username(&self) -> &String
  fn claimed_password(&self) -> &String
  fn claimed_body(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
  fn username(&self) -> &String
  fn set_username(&self, value : &str)
  fn set_username_ref(&self, value : &String)
}

// SAMLIdPServerUserAuthVerifyCredentialsEvent defines the signature of the SAMLIdPServer UserAuthVerifyCredentials event's handler function.
pub trait SAMLIdPServerUserAuthVerifyCredentialsEvent {
  fn on_user_auth_verify_credentials(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerUserAuthVerifyCredentialsEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_user_auth_verify_credentials(&self) -> &'a dyn SAMLIdPServerUserAuthVerifyCredentialsEvent;
  pub fn set_on_user_auth_verify_credentials(&mut self, value : &'a dyn SAMLIdPServerUserAuthVerifyCredentialsEvent);
  ...
}

Remarks

Subscribe to this event to be notified about authentication attempts and adjust the acceptance result as required. This event fires after the user credentials have been validated against the configured database, and the value of the Accept parameter reflects the outcome of the validation.

The Username and Password parameters contain the provided credentials, and the Body parameter contains the unparsed form data.

on_user_logout_completed event (SAMLIdPServer Struct)

Notifies the application about the completion of user logout flow.

Syntax

// SAMLIdPServerUserLogoutCompletedEventArgs carries the SAMLIdPServer UserLogoutCompleted event's parameters.
pub struct SAMLIdPServerUserLogoutCompletedEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn sp(&self) -> &String
  fn username(&self) -> &String
  fn name_id(&self) -> &String
  fn session_index(&self) -> &String
  fn partial(&self) -> bool
}

// SAMLIdPServerUserLogoutCompletedEvent defines the signature of the SAMLIdPServer UserLogoutCompleted event's handler function.
pub trait SAMLIdPServerUserLogoutCompletedEvent {
  fn on_user_logout_completed(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerUserLogoutCompletedEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_user_logout_completed(&self) -> &'a dyn SAMLIdPServerUserLogoutCompletedEvent;
  pub fn set_on_user_logout_completed(&mut self, value : &'a dyn SAMLIdPServerUserLogoutCompletedEvent);
  ...
}

Remarks

Subscribe to this event to be notified about the logout flow completion.

on_user_logout_start event (SAMLIdPServer Struct)

Notifies the application about the start of user logout flow.

Syntax

// SAMLIdPServerUserLogoutStartEventArgs carries the SAMLIdPServer UserLogoutStart event's parameters.
pub struct SAMLIdPServerUserLogoutStartEventArgs {
  fn connection_id(&self) -> i64
  fn session_id(&self) -> &String
  fn sp(&self) -> &String
  fn username(&self) -> &String
  fn name_id(&self) -> &String
  fn session_index(&self) -> &String
  fn secondary(&self) -> bool
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// SAMLIdPServerUserLogoutStartEvent defines the signature of the SAMLIdPServer UserLogoutStart event's handler function.
pub trait SAMLIdPServerUserLogoutStartEvent {
  fn on_user_logout_start(&self, sender : SAMLIdPServer, e : &mut SAMLIdPServerUserLogoutStartEventArgs);
}

impl <'a> SAMLIdPServer<'a> {
  pub fn on_user_logout_start(&self) -> &'a dyn SAMLIdPServerUserLogoutStartEvent;
  pub fn set_on_user_logout_start(&mut self, value : &'a dyn SAMLIdPServerUserLogoutStartEvent);
  ...
}

Remarks

The component uses this event to notify the application about the start of user logout flow. The Secondary parameter indicates that the logout is initiated in response to request received from a remote party.

The application can choose to accept or reject the request, or process it manually, using the Action parameter:

Config Settings (SAMLIdPServer 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.

SAMLIdPServer Config Settings

Base Config Settings

Trappable Errors (SAMLIdPServer Struct)

SAMLIdPServer Errors