Struct secureblackbox::SAMLWriter

Properties   Methods   Events   Config Settings   Errors  

The SAMLWriter struct offers SAML message generation functions.

Syntax

secureblackbox::SAMLWriter

Remarks

SAMLWriter provides means of serialization of SAML entities into valid SAML protocol messages. Together with SAMLReader, this class provides fine-grained access to the composition of SAML requests, responses, assertions, and statements. You can use it as part of your SAML client or SAML server implementation for creating individual SAML entities.

SAMLReader and SAMLWriter are independent of SAML server controls that are also included in SecureBlackbox, and are aimed at scenarios that require lower-level access to SAML functionality than that provided by the server controls.

SAMLWriter can create the following kinds of SAML messages:

• AssertionIDRequest
• SubjectQuery
• AuthnQuery
• AttributeQuery
• AuthzDecisionQuery
• AuthnRequest
• ManageNameIDRequest
• LogoutRequest
• NameIDMappingRequest
• ArtifactResolve
• Response

Please find below a quick-and-dirty example of the use of SAMLWriter class for creating a signed AuthnRequest message: Samlwriter writer = new Samlwriter(); // configuring general message properties writer.Destination = "http://destination-url.com"; writer.IssueInstant = DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ss.fffZ"); writer.Issuer = "Value=https://issuer-url.com;Format=urn:oasis:names:tc:SAML:2.0:nameid-format:entity;IDType=Issuer"; // configuring general AuthnRequest properties writer.AuthnRequest.IsPassive = false; writer.AuthnRequest.UseIsPassive = true; writer.AuthnRequest.ForceAuthn = true; writer.AuthnRequest.ProtocolBinding = "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"; writer.AuthnRequest.AssertionConsumerServiceURL = "https://assertion-consumer-url.com"; writer.AuthnRequest.AttributeConsumingServiceIndex = 1; writer.AuthnRequest.NameIDPolicyAllowCreate = false; writer.AuthnRequest.NameIDPolicyFormat = "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"; writer.AuthnRequest.ConditionsNotBefore = DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ss.fffZ"); writer.AuthnRequest.ConditionsNotOnOrAfter = DateTime.UtcNow.AddMinutes(30).ToString("yyyy-MM-ddTHH:mm:ss.fffZ"); // adjusting request conditions if required SAMLAssertionCondition cond = new SAMLAssertionCondition(); cond.ConditionType = SAMLConditionTypes.csctOneTimeUse; writer.AuthnRequestConditions.Add(cond); // configuring signing properties Certificate certificate = new Certificate("C:\\Certs\\samlCert.pfx", "password"); writer.Sign = true; writer.SigningCertificate = certificate; // creating the SAML entity of the required type writer.CreateNew((int)SamlwriterOutputTypes.cstyAuthnRequest); // adjusting low-level signature parameters writer.Config("SigDigestMethod=http://www.w3.org/2001/04/xmlenc#sha256"); writer.Config("SigMethod=http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"); // signing the request and serializing it to XML string request = writer.Save(); The above code produces the following AuthnRequest: <samlp:AuthnRequest xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion" ID="53GhrzQ5f89fu214ANAR" Version="2.0" IssueInstant="2021-12-15T10:39:31Z" Destination="http://destination-url.com" IsPassive="false" ProtocolBinding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" AssertionConsumerServiceURL="https://assertion-consumer-url.com" AttributeConsumingServiceIndex="1" xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol"> <saml:Issuer Format="urn:oasis:names:tc:SAML:2.0:nameid-format:entity">https://issuer-url.com</saml:Issuer> <ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#"> <ds:SignedInfo> <ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/> <ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/> <ds:Reference URI="#53GhrzQ5f89fu214ANAR"> <ds:Transforms> <ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/> <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/> </ds:Transforms> <ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/><ds:DigestValue>+xhhgXtwYN0/r9h7WAwg=</ds:DigestValue> </ds:Reference> </ds:SignedInfo> <ds:SignatureValue> jfYeIq/z8D1tJZYbVqDMoqKpdrfGMj8/zI7gbUsJbECAr00cN34md2QG0mo4cOx7pny+5 Tht7tUzqENHqcZdmlOcZc2JcJqokVxIcLEluFiWKlNjpexkXFQKzOC1peRfTZm8SQTqtP Cz8IknLUc6Scfml29PHmks1PxjJDteGb/+FggsZRTGZC3a05nvH3ayvHukPeHuHssx5dX nj0quT8salR6fdx6lAJo/AnDHzcfBNyxAMn+ebk5VOOgVD1L3PayvXib/maj8aVI2I5UT o4vmfybTWKzeS8DX9We7UV+4Xowwe647t1A912xLVub/e23A18Yf1V0PXC87kttTkA== </ds:SignatureValue> <ds:KeyInfo> <ds:X509Data><ds:X509Certificate> MIIEKDCCAxCgAwIBAgIFYA3A3gIwDQYJKoZIhvcNAQELBQAwfjELMAkGA1UEBhMCVVMxC zAJBgNVBAgTAk5DMRQwEgYDVQQHEwtDaGFwZWwgSGlsbDEiMCAGCSqGSIb3DQEJARMTc2 FsZXNAbnNvZnR3YXJlLmNvbTEoMCYGA1UEAxMfU2VjdXJlQmxhY2tib3ggRGVtbyBDZXJ 0aWZpY2F0ZTAeFw0xNzA5MDEwMDAwMDBaFw0yMjA5MDEwMDAwMDBaMH4xCzAJBgNVBAYT AlVTMQswCQYDVQQIEwJOQzEUMBIGA1UEBxMLQ2hhcGVsIEhpbGwxIjAgBgkqhkiG9w0BC QETE3NhbGVzQG5zb2Z0d2FyZS5jb20xKDAmBgNVBAMTH1NlY3VyZUJsYWNrYm94IERlbW 8gQ2VydGlmaWNhdGUwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCfAVIcq9o eoIbw56LsPjxWsX3YGkqasBQzgQymhfcDZeSvFKFis8iqArGLTUUWOaImO5t2UmjIa+4n YP39hb9Z1r0CMy53p83oYbbZZ7qMeji0pMAufJHqKCN8t2HNWf2HE8S9UOU7R/UHdrSAN JitBKV9lSG9f450yWoGNwt35ZCsOp0zqtCgvkEvteGsz01R5DDjOccs3QNu25K/Sf27KP CYabS6A1ehYNY/G32qoKNJhu3DN4bWje57gBWi9WSfQ3tZUOV5q2ozaNJA78Wl4fXC6RB CaBh0GOwXeyZoH13LJdn+lqlCSMz024ImG4yFQEENbWvE9Elku8RYTn73AgMBAAGjgaww gakwHwYDVR0jBBgwFoAUmt/L7GI1SH36Sp8EUBxTwuzSgqMwHQYDVR0OBBYEFJrfy+xiN Uh9+kqfBFAcU8Ls0oKjMA8GA1UdEwEB/wQFMAMBAf8wDwYDVR0PAQH/BAUDAwDuADBFBg NVHSUEPjA8BggrBgEFBQcDAQYIKwYBBQUHAwIGCCsGAQUFBwMDBggrBgEFBQcDBAYIKwY BBQUHAwgGCCsGAQUFBwMJMA0GCSqGSIb3DQEBCwUAA4IBAQBovHBbMsW/k/5iuLQQqsYS ng5X2iy1W+5BRb1hz0MGnHGLqJWy1ty5+bTo6g/zvT65dXIPIexLkInEenYSy75Lthr6a ewUcvwfl1TYXjWlMD5Nm5pM9As71+XsGSdYGXoKohbEzbT6RDByjwR+yxtatqko7e1Eg6 InNJRTRt7al/63FSPEgSCqOX6asDVDNZ83db0dOcoeaPEiDz3liE3+tYHtKXj5/qwTtYd aqBZxdJfuCKZveEFe1DO3/ayDvIvG9Eme+rEjntErF+Cw9a8ukesvDuT49cRE9oTs3O7f 6LUbhCv5zJN+dTFr75NSdWdp4yvn3nK3i2udeMnTWK0U </ds:X509Certificate></ds:X509Data> </ds:KeyInfo> </ds:Signature> <samlp:NameIDPolicy Format="urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"/> <saml:Conditions NotBefore="2021-12-15T10:39:31Z" NotOnOrAfter="2021-12-15T11:09:31Z"><saml:OneTimeUse/></saml:Conditions> </samlp:AuthnRequest>

Note that you need to set the signing certificate before calling create_new.

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 SAMLWriter struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of SAMLWriter 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.

artifact_endpoint_index property (SAMLWriter Struct)

An accessor to the EndpointIndex entry of the artifact.

Syntax

fn artifact_endpoint_index(&self ) -> Result<i32, SecureBlackboxError> 
fn set_artifact_endpoint_index(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

An accessor to the EndpointIndex entry of the artifact.

The EndpointIndex references a specific artifact resolution endpoint (IdP or SP) managed by the artifact issuer.

Data Type

i32

artifact_message_handle property (SAMLWriter Struct)

An accessor to the MessageHandle property of the artifact.

Syntax

fn artifact_message_handle(&self ) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_artifact_message_handle(&self, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_artifact_message_handle_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

An accessor to the MessageHandle property of the artifact.

A message handle is a unique reference to a SAML message that can be produced by the artifact issuer upon request.

Data Type

Vec

artifact_remaining_artifact property (SAMLWriter Struct)

Returns the contents of the artifact.

Syntax

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

Remarks

Returns the contents of the artifact.

Check this property to access the encoded contents of the artifact. This property is updated internally from the parameters of the artifact.

This property is read-only.

Data Type

Vec

artifact_source_id property (SAMLWriter Struct)

An accessor to the SourceID property of the artifact.

Syntax

fn artifact_source_id(&self ) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_artifact_source_id(&self, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_artifact_source_id_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

An accessor to the SourceID property of the artifact.

SourceID uniquely identifies the issuer of the artifact.

Data Type

Vec

artifact_type_code property (SAMLWriter Struct)

The TypeCode property of the artifact.

Syntax

fn artifact_type_code(&self ) -> Result<i32, SecureBlackboxError> 
fn set_artifact_type_code(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The TypeCode field of the artifact.

The type code artifact parameter uniquely identifies the artifact format. Currently (as per SAML 2.0) the only type code of 4 is defined. This format assumes the presence of artifact_remaining_artifact, artifact_source_id, and artifact_message_handle parameters.

Data Type

i32

artifact_uri property (SAMLWriter Struct)

An accessor to the URI property of the artifact.

Syntax

fn artifact_uri(&self ) -> Result<String, SecureBlackboxError> 
fn set_artifact_uri(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_artifact_uri_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

An accessor to the URI property of the artifact.

The URI property contains the origin of the artifact.

Data Type

String

artifact_resolve_query property (SAMLWriter Struct)

Contains the artifact resolve query.

Syntax

fn artifact_resolve_query(&self ) -> Result<String, SecureBlackboxError> 
fn set_artifact_resolve_query(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_artifact_resolve_query_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to read or set the artifact resolve query.

Data Type

String

assertion_type property (SAMLWriter Struct)

Specifies the type of the assertion.

Syntax

fn assertion_type(&self ) -> Result<i32, SecureBlackboxError> 
fn set_assertion_type(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // AssertionIDRef
1   // AssertionURIRef
2   // Assertion
3   // EncryptedAssertion

Default Value

2

Remarks

Specifies the type of the assertion.

Use this property to check or set the type of the assertion.

Data Type

i32

assertion_encrypted_content property (SAMLWriter Struct)

Represents the encrypted assertion content.

Syntax

fn assertion_encrypted_content(&self ) -> Result<String, SecureBlackboxError> 
fn set_assertion_encrypted_content(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_assertion_encrypted_content_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Represents the encrypted assertion content.

Use this property to get or set the encrypted assertion content.

Data Type

String

assertion_id property (SAMLWriter Struct)

Represents the ID of the assertion.

Syntax

fn assertion_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_assertion_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_assertion_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Represents the ID of the assertion.

Use this property to read or set the unique ID of the assertion.

Data Type

String

assertion_id_ref property (SAMLWriter Struct)

Represents an ID reference value.

Syntax

fn assertion_id_ref(&self ) -> Result<String, SecureBlackboxError> 
fn set_assertion_id_ref(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_assertion_id_ref_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Represents an ID reference value.

Use this property to read or set the ID reference value for assertions of csatAssertionIDRef type.

Data Type

String

assertion_issue_instant property (SAMLWriter Struct)

Contains the assertion issuance time stamp.

Syntax

fn assertion_issue_instant(&self ) -> Result<String, SecureBlackboxError> 
fn set_assertion_issue_instant(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_assertion_issue_instant_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the assertion issuance time stamp.

Use this property to check or set the assertion issuance time.

Data Type

String

assertion_issuer property (SAMLWriter Struct)

Specifies the assertion issuer.

Syntax

fn assertion_issuer(&self ) -> Result<String, SecureBlackboxError> 
fn set_assertion_issuer(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_assertion_issuer_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the assertion issuer.

Use this property to provide the assertion issuer ID.

Data Type

String

assertion_parent_assertion property (SAMLWriter Struct)

Contains the index of the parent assertion in the assertion list.

Syntax

fn assertion_parent_assertion(&self ) -> Result<i32, SecureBlackboxError> 
fn set_assertion_parent_assertion(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

-1

Remarks

Contains the index of the parent assertion in the assertion list.

This property is set to -1 for normal assertions. ParentAssertion set to a non-negative value indicates that the assertion is an advice assertion incorporated into a top-level assertion. Advice assertions are typically used by service providers to provide additional information about the SAML assertion issuing authority.

Data Type

i32

assertion_signature_validation_result property (SAMLWriter Struct)

The outcome of the cryptographic signature validation.

Syntax

fn assertion_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

assertion_signed property (SAMLWriter Struct)

Specifies whether the assertion is signed.

Syntax

fn assertion_signed(&self ) -> Result<bool, SecureBlackboxError> 
fn set_assertion_signed(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether the assertion is signed.

Use this property to establish whether the assertion is signed.

Data Type

bool

assertion_subject property (SAMLWriter Struct)

Specifies the assertion subject.

Syntax

fn assertion_subject(&self ) -> Result<String, SecureBlackboxError> 
fn set_assertion_subject(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_assertion_subject_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the assertion subject.

Use this property to provide the assertion's subject SAML ID.

Data Type

String

assertion_uri_ref property (SAMLWriter Struct)

Represents an URI reference value.

Syntax

fn assertion_uri_ref(&self ) -> Result<String, SecureBlackboxError> 
fn set_assertion_uri_ref(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_assertion_uri_ref_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Represents an URI reference value.

Use this property to read or set the URI reference value for assertions of csatAssertionURIRef type.

Data Type

String

assertion_version property (SAMLWriter Struct)

Specifies the SAML protocol version used.

Syntax

fn assertion_version(&self ) -> Result<String, SecureBlackboxError> 
fn set_assertion_version(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_assertion_version_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the SAML protocol version used.

This property specifies the SAML protocol version. The default value is 2.0.

Data Type

String

assertion_count property (SAMLWriter Struct)

Returns the number of assertions in the message.

Syntax

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

Default Value

0

Remarks

This property returns the total number of assertions currently defined in the SAML message.

This property is read-only.

Data Type

i32

attribute_count property (SAMLWriter Struct)

The number of records in the Attribute arrays.

Syntax

fn attribute_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_attribute_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• attribute_friendly_name
• attribute_name
• attribute_name_format
• attribute_statement_index
• attribute_values

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

Data Type

i32

attribute_friendly_name property (SAMLWriter Struct)

Specifies the friendly name of the attribute Use this property to access or set the friendly name of a SAML attribute (e.

Syntax

fn attribute_friendly_name(&self , AttributeIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_attribute_friendly_name(&self, AttributeIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_attribute_friendly_name_ref(&self, AttributeIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the friendly name of the attribute

Use this property to access or set the friendly name of a SAML attribute (e.g. givenName).

The AttributeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttributeCount property.

Data Type

String

attribute_name property (SAMLWriter Struct)

Specifies the name of the attribute.

Syntax

fn attribute_name(&self , AttributeIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_attribute_name(&self, AttributeIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_attribute_name_ref(&self, AttributeIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the name of the attribute.

Use this property to read or set the formal name of the attribute (e.g. urn:oid:2.5.4.42).

The AttributeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttributeCount property.

Data Type

String

attribute_name_format property (SAMLWriter Struct)

Indicates the format used to reference the attribute.

Syntax

fn attribute_name_format(&self , AttributeIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_attribute_name_format(&self, AttributeIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_attribute_name_format_ref(&self, AttributeIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Indicates the format used to reference the attribute.

This property specifies the format that is used to reference the attribute (e.g. urn:oasis:names:tc:SAML:2.0:attrname-format:uri).

The AttributeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttributeCount property.

Data Type

String

attribute_statement_index property (SAMLWriter Struct)

Contains the index of the statement the attribute corresponds to.

Syntax

fn attribute_statement_index(&self , AttributeIndex : i32) -> Result<i32, SecureBlackboxError> 
fn set_attribute_statement_index(&self, AttributeIndex : i32, value : i32) ->  Option<SecureBlackboxError> 

Default Value

-1

Remarks

Contains the index of the statement the attribute corresponds to.

Use this property to read or set the index of the statement in the statement list that this attribute corresponds to.

The AttributeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttributeCount property.

Data Type

i32

attribute_values property (SAMLWriter Struct)

Contains a list of attribute values.

Syntax

fn attribute_values(&self , AttributeIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_attribute_values(&self, AttributeIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_attribute_values_ref(&self, AttributeIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains a list of attribute values.

Use this property to access or set the value(s) included with the attribute. The value contains a list of strings of ContentType=contentType;Value=value format, separated with CRLF.

The AttributeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttributeCount property.

Data Type

String

authn_query_comparison property (SAMLWriter Struct)

Specifies the authentication context comparison method.

Syntax

fn authn_query_comparison(&self ) -> Result<i32, SecureBlackboxError> 
fn set_authn_query_comparison(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // None
1   // Exact
2   // Minimum
3   // Maximum
4   // Better

Default Value

0

Remarks

Specifies the authentication context comparison method.

Use this property to access or set the authentication contexts comparison method (none, exact, minimum, maximum, or better).

Data Type

i32

authn_query_context_class_refs property (SAMLWriter Struct)

Specifies the context class reference.

Syntax

fn authn_query_context_class_refs(&self ) -> Result<String, SecureBlackboxError> 
fn set_authn_query_context_class_refs(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_authn_query_context_class_refs_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the context class reference.

Use this property to access or set the authentication context class reference.

Data Type

String

authn_query_ref_type property (SAMLWriter Struct)

Specifies the context reference type.

Syntax

fn authn_query_ref_type(&self ) -> Result<i32, SecureBlackboxError> 
fn set_authn_query_ref_type(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Unknown
1   // Class
2   // Decl

Default Value

0

Remarks

Specifies the context reference type.

Use this property to access or set the authentication contexts reference type (class or declaration).

Data Type

i32

authn_query_session_index property (SAMLWriter Struct)

Specifies the index of the session to the authentication entity.

Syntax

fn authn_query_session_index(&self ) -> Result<String, SecureBlackboxError> 
fn set_authn_query_session_index(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_authn_query_session_index_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the index of the session to the authentication entity.

Use this property to access or set the index of the session to the authentication entity.

Data Type

String

authn_request_assertion_consumer_service_index property (SAMLWriter Struct)

Specifies the assertion consumer service index.

Syntax

fn authn_request_assertion_consumer_service_index(&self ) -> Result<i32, SecureBlackboxError> 
fn set_authn_request_assertion_consumer_service_index(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the assertion consumer service index.

Use this property to access or set the location index to which the response has to be returned.

Data Type

i32

authn_request_assertion_consumer_service_url property (SAMLWriter Struct)

Specifies the assertion consumer service URL.

Syntax

fn authn_request_assertion_consumer_service_url(&self ) -> Result<String, SecureBlackboxError> 
fn set_authn_request_assertion_consumer_service_url(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_authn_request_assertion_consumer_service_url_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the assertion consumer service URL.

Use this property to access or set the URL of the location to which the response has to be returned.

Data Type

String

authn_request_attribute_consuming_service_index property (SAMLWriter Struct)

Specifies the attribute consuming service index.

Syntax

fn authn_request_attribute_consuming_service_index(&self ) -> Result<i32, SecureBlackboxError> 
fn set_authn_request_attribute_consuming_service_index(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the attribute consuming service index.

Use this property to read or set the attribute consuming service index.

Data Type

i32

authn_request_context_class_refs property (SAMLWriter Struct)

Provides access to the authentication context class references.

Syntax

fn authn_request_context_class_refs(&self ) -> Result<String, SecureBlackboxError> 
fn set_authn_request_context_class_refs(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_authn_request_context_class_refs_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Provides access to the authentication context class references.

Use this property to access or set the class references of the authentication context. This property may contain a list of CRLF-separated strings.

Data Type

String

authn_request_context_comparison property (SAMLWriter Struct)

Specifies the AuthnContext comparison method.

Syntax

fn authn_request_context_comparison(&self ) -> Result<i32, SecureBlackboxError> 
fn set_authn_request_context_comparison(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // None
1   // Exact
2   // Minimum
3   // Maximum
4   // Better

Default Value

0

Remarks

Specifies the AuthnContext comparison method.

Use this property to access or set the authentication contexts comparison method (none, exact, minimum, maximum, or better).

Data Type

i32

authn_request_context_ref_type property (SAMLWriter Struct)

Specifies the context reference type.

Syntax

fn authn_request_context_ref_type(&self ) -> Result<i32, SecureBlackboxError> 
fn set_authn_request_context_ref_type(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Unknown
1   // Class
2   // Decl

Default Value

0

Remarks

Specifies the context reference type.

Use this property to get or set the context reference type (Class or Declaration).

Data Type

i32

authn_request_flags property (SAMLWriter Struct)

Adjusts secondary serialization properties.

Syntax

fn authn_request_flags(&self ) -> Result<i32, SecureBlackboxError> 
fn set_authn_request_flags(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Adjusts secondary serialization properties.

Use this bit mask property to adjust how certain properties will be saved. The following flags are supported:

Data Type

i32

authn_request_force_authn property (SAMLWriter Struct)

Corresponds to the ForceAuthn parameter of the request.

Syntax

fn authn_request_force_authn(&self ) -> Result<bool, SecureBlackboxError> 
fn set_authn_request_force_authn(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Corresponds to the ForceAuthn parameter of the request.

Use this property to check or set the ForceAuthn parameter of the request, which enforces the identity provider to re-authenticate the presenter.

Data Type

bool

authn_request_is_passive property (SAMLWriter Struct)

Maps to the IsPassive parameter of the request.

Syntax

fn authn_request_is_passive(&self ) -> Result<bool, SecureBlackboxError> 
fn set_authn_request_is_passive(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Maps to the IsPassive parameter of the request.

Use this property to access or set the IsPassive parameter of the authentication request. IsPassive sets out the control the identity provider and user agent have over the authenticating users UI.

Data Type

bool

authn_request_name_id_policy_allow_create property (SAMLWriter Struct)

Matches the AllowCreate attribute of NameIDPolicy element of the request.

Syntax

fn authn_request_name_id_policy_allow_create(&self ) -> Result<bool, SecureBlackboxError> 
fn set_authn_request_name_id_policy_allow_create(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Matches the AllowCreate attribute of NameIDPolicy element of the request.

Use this property to access or set the AllowCreate attribute of NameIDPolicy, which allows or disallows the identity provider to create a new identifier when processing the authentication request.

Data Type

bool

authn_request_name_id_policy_format property (SAMLWriter Struct)

Matches to the Format attribute of the NameIDPolicy element of the request.

Syntax

fn authn_request_name_id_policy_format(&self ) -> Result<String, SecureBlackboxError> 
fn set_authn_request_name_id_policy_format(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_authn_request_name_id_policy_format_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Matches to the Format attribute of the NameIDPolicy element of the request.

Use this property to access or set the Format attribute of NameIDPolicy.

Data Type

String

authn_request_name_id_policy_sp_name_qualifier property (SAMLWriter Struct)

Matches to the SP name qualifier attribute of the request.

Syntax

fn authn_request_name_id_policy_sp_name_qualifier(&self ) -> Result<String, SecureBlackboxError> 
fn set_authn_request_name_id_policy_sp_name_qualifier(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_authn_request_name_id_policy_sp_name_qualifier_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Matches to the SP name qualifier attribute of the request.

Use this property to access or set the SP name qualifier attribute of the authentication request.

Data Type

String

authn_request_protocol_binding property (SAMLWriter Struct)

Specifies the protocol binding to be requested in the authentication request.

Syntax

fn authn_request_protocol_binding(&self ) -> Result<String, SecureBlackboxError> 
fn set_authn_request_protocol_binding(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_authn_request_protocol_binding_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the protocol binding to be requested in the authentication request.

Use this property to check or set the protocol binding to be used when responding to this request.

Data Type

String

authn_request_provider_name property (SAMLWriter Struct)

Specifies the name of the requestor.

Syntax

fn authn_request_provider_name(&self ) -> Result<String, SecureBlackboxError> 
fn set_authn_request_provider_name(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_authn_request_provider_name_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the name of the requestor.

Use this property to read or set the name of the requestor.

Data Type

String

authn_request_scoping_get_complete property (SAMLWriter Struct)

Matches the GetComplete element of the IDPList entry of the Scoping object.

Syntax

fn authn_request_scoping_get_complete(&self ) -> Result<String, SecureBlackboxError> 
fn set_authn_request_scoping_get_complete(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_authn_request_scoping_get_complete_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Matches the GetComplete element of the IDPList entry of the Scoping object.

Use this property to access or set the GetComplete element of the IDPList entry of the Scoping object of the authentication request. This property typically contains an URI that allows to retrieve a complete list of identity providers.

Data Type

String

authn_request_scoping_proxy_count property (SAMLWriter Struct)

The maximum number of proxies on the way between the requestor and the provider.

Syntax

fn authn_request_scoping_proxy_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_authn_request_scoping_proxy_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The maximum number of proxies on the way between the requestor and the provider.

Use this property to get or set the maximum number of intermediaries allowed between the requestor and the provider.

Data Type

i32

authn_request_scoping_requester_i_ds property (SAMLWriter Struct)

A collection of requestor IDs on whose behalf the request is being sent.

Syntax

fn authn_request_scoping_requester_i_ds(&self ) -> Result<String, SecureBlackboxError> 
fn set_authn_request_scoping_requester_i_ds(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_authn_request_scoping_requester_i_ds_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

A collection of requestor IDs on whose behalf the request is being sent.

Use this property to specify or read the requestor IDs, in the form of CRLF-separated strings, on whose behalf the request is being sent.

Data Type

String

authz_decision_query_actions property (SAMLWriter Struct)

Specifies the list of actions included in the query.

Syntax

fn authz_decision_query_actions(&self ) -> Result<String, SecureBlackboxError> 
fn set_authz_decision_query_actions(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_authz_decision_query_actions_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the list of actions included in the query.

Read or set this property to access the list of actions (as CRLF-separated strings) included in the query.

Data Type

String

authz_decision_query_resource property (SAMLWriter Struct)

Matches the Resource element of the query.

Syntax

fn authz_decision_query_resource(&self ) -> Result<String, SecureBlackboxError> 
fn set_authz_decision_query_resource(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_authz_decision_query_resource_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Matches the Resource element of the query.

Use this property to read or set the Resource element of the authorization decision query.

Data Type

String

binding_type property (SAMLWriter Struct)

Specifies the type of SAML binding to use.

Syntax

fn binding_type(&self ) -> Result<i32, SecureBlackboxError> 
fn set_binding_type(&self, value : i32) ->  Option<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 to use.

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

Data Type

i32

binding_body property (SAMLWriter Struct)

Contains the POST binding form body.

Syntax

fn binding_body(&self ) -> Result<String, SecureBlackboxError> 
fn set_binding_body(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_binding_body_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the POST binding form body.

Use this property to read or set the body of the form returned by the service provider.

Data Type

String

binding_encoding property (SAMLWriter Struct)

Specifies the message encoding.

Syntax

fn binding_encoding(&self ) -> Result<String, SecureBlackboxError> 
fn set_binding_encoding(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_binding_encoding_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the message encoding.

Use this property to access or set the message encoding.

Data Type

String

binding_force_sign property (SAMLWriter Struct)

Enforces a signature over all outgoing messages.

Syntax

fn binding_force_sign(&self ) -> Result<bool, SecureBlackboxError> 
fn set_binding_force_sign(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enforces a signature over all outgoing messages.

Use this property to enforce signing of all outgoing messages, independently of whether the original message was signed or not. See also binding_sign.

Data Type

bool

binding_form_template property (SAMLWriter Struct)

Contains the XHTML form template returned by the service provider.

Syntax

fn binding_form_template(&self ) -> Result<String, SecureBlackboxError> 
fn set_binding_form_template(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_binding_form_template_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the XHTML form template returned by the service provider.

Use this property to access or set the template of a POST form provided by the service provider (POST binding only).

Data Type

String

binding_post_mode property (SAMLWriter Struct)

Specifies whether binding is applied on the server, or on the client side.

Syntax

fn binding_post_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_binding_post_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Client
1   // Server

Default Value

0

Remarks

Specifies whether binding is applied on the server, or on the client side.

Use this property to specify whether POST binding is used on the server or client side of the communication. The default value is cspmClient.

Data Type

i32

binding_relay_state property (SAMLWriter Struct)

Contains the RelayState parameter of the binding.

Syntax

fn binding_relay_state(&self ) -> Result<String, SecureBlackboxError> 
fn set_binding_relay_state(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_binding_relay_state_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the RelayState parameter of the binding.

Use this property to access or set the RelayState parameter of the binding. This is an uninterpreted state string that should be passed back to the service provider with subsequent requests.

Data Type

String

binding_signature_algorithm property (SAMLWriter Struct)

Contains the signature algorithm.

Syntax

fn binding_signature_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_binding_signature_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_binding_signature_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the signature algorithm.

Use this property to get or set the signature algorithm. This corresponds to the SigAlg query string parameter, and contains the URI of the signature algorithm.

Data Type

String

binding_signature_validation_result property (SAMLWriter Struct)

The outcome of the cryptographic signature validation.

Syntax

fn binding_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

binding_signed property (SAMLWriter Struct)

Specifies whether to sign the binding.

Syntax

fn binding_signed(&self ) -> Result<bool, SecureBlackboxError> 
fn set_binding_signed(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether to sign the binding.

Use this property to enable or disable signing of generated binding entities. The SAML specification instructs that the binding should only be signed if the original XML was. This property therefore is only taken into account if the original XML was signed. With that in mind, certain service providers demand the binding to be signed at all times. Use binding_force_sign property to enforce signatures on all binding entities.

Data Type

bool

binding_url property (SAMLWriter Struct)

Contains the URL of the request query.

Syntax

fn binding_url(&self ) -> Result<String, SecureBlackboxError> 
fn set_binding_url(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_binding_url_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the URL of the request query.

Use this property to read or set the URL of the request query or POST target.

Data Type

String

binding_verify_signatures property (SAMLWriter Struct)

Instructs the struct whether to verify incoming signatures.

Syntax

fn binding_verify_signatures(&self ) -> Result<bool, SecureBlackboxError> 
fn set_binding_verify_signatures(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

true

Remarks

Instructs the component whether to verify incoming signatures.

Use this property to activate or deactivate verification of signatures in incoming requests.

Data Type

bool

binding_key_handle property (SAMLWriter 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

condition_count property (SAMLWriter Struct)

The number of records in the Condition arrays.

Syntax

fn condition_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_condition_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• condition
• condition_type

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

Data Type

i32

condition property (SAMLWriter Struct)

The condition set in accordance with the ConditionType .

Syntax

fn condition(&self , ConditionIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_condition(&self, ConditionIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_condition_ref(&self, ConditionIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The condition set in accordance with the condition_condition_type.

For csctAudienceRestriction conditions, read or set a list of audiences included in the restriction. Each audience is represented by an URI. Provide multiple audiences by splitting them with CRLF separators.

For csctProxyRestriction conditions, check or set the value of the proxy count restriction.

For csctNotBefore and csctNotOnOrAfter, check or set the respective date/time values.

The ConditionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ConditionCount property.

Data Type

String

condition_type property (SAMLWriter Struct)

Specifies a type of the condition object.

Syntax

fn condition_type(&self , ConditionIndex : i32) -> Result<i32, SecureBlackboxError> 
fn set_condition_type(&self, ConditionIndex : i32, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // AudienceRestriction
1   // OneTimeUse
2   // ProxyRestriction
3   // NotBefore
4   // NotOnOrAfter

Default Value

0

Remarks

Specifies a type of the condition object.

Use this property to check or specify the type of the condition object. This can be either an audience restriction, a one time use limitation, or a proxy restriction.

The ConditionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ConditionCount property.

Data Type

i32

encryption_cert_bytes property (SAMLWriter 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 (SAMLWriter 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

fips_mode property (SAMLWriter 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

logout_request_name_id property (SAMLWriter Struct)

Contains the value of the NameID parameter.

Syntax

fn logout_request_name_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_logout_request_name_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_logout_request_name_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the value of the NameID parameter.

Use this property to access or set the value of the NameID parameter of the request.

Data Type

String

logout_request_not_on_or_after property (SAMLWriter Struct)

Contains the value of the NotOnOrAfter parameter.

Syntax

fn logout_request_not_on_or_after(&self ) -> Result<String, SecureBlackboxError> 
fn set_logout_request_not_on_or_after(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_logout_request_not_on_or_after_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the value of the NotOnOrAfter parameter.

Use this property to access or set the value of the NotOnOrAfter parameter.

Data Type

String

logout_request_reason property (SAMLWriter Struct)

Contains the value of the Reason parameter.

Syntax

fn logout_request_reason(&self ) -> Result<String, SecureBlackboxError> 
fn set_logout_request_reason(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_logout_request_reason_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the value of the Reason parameter.

Use this property to read or set the value of the Reason parameter.

Data Type

String

logout_request_session_indexes property (SAMLWriter Struct)

Contains the list of session indices.

Syntax

fn logout_request_session_indexes(&self ) -> Result<String, SecureBlackboxError> 
fn set_logout_request_session_indexes(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_logout_request_session_indexes_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the list of session indices.

Use this property to access or set the list of session indices, as a CRLF-separated list of strings.

Data Type

String

manage_name_id_request_name_id property (SAMLWriter Struct)

Contains the value of the NameID parameter of the request.

Syntax

fn manage_name_id_request_name_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_manage_name_id_request_name_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_manage_name_id_request_name_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the value of the NameID parameter of the request.

Use this property to read or set the value of the NameID parameter of the request.

Data Type

String

manage_name_id_request_new_encrypted_id property (SAMLWriter Struct)

Contains the value of the NewEncryptedID parameter of the request.

Syntax

fn manage_name_id_request_new_encrypted_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_manage_name_id_request_new_encrypted_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_manage_name_id_request_new_encrypted_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the value of the NewEncryptedID parameter of the request.

Use this property to check or set the value of the NewEncryptedID parameter of the request.

Data Type

String

manage_name_id_request_new_id property (SAMLWriter Struct)

Contains the value of the NewID parameter.

Syntax

fn manage_name_id_request_new_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_manage_name_id_request_new_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_manage_name_id_request_new_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the value of the NewID parameter.

Use this property to access or set the NewID parameter of the request.

Data Type

String

manage_name_id_request_terminate property (SAMLWriter Struct)

Contains the value of the Terminate parameter of the request.

Syntax

fn manage_name_id_request_terminate(&self ) -> Result<String, SecureBlackboxError> 
fn set_manage_name_id_request_terminate(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_manage_name_id_request_terminate_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the value of the Terminate parameter of the request.

Use this property to read or set the value of the Terminate parameter of the request.

Data Type

String

message_consent property (SAMLWriter Struct)

Contains the Consent parameter of the SAML message.

Syntax

fn message_consent(&self ) -> Result<String, SecureBlackboxError> 
fn set_message_consent(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_message_consent_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the Consent parameter of the SAML message.

Use this property to specify the Consent parameter of the SAML entity.

Data Type

String

message_content_type property (SAMLWriter Struct)

Returns the SAML type of the current message.

Syntax

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

Possible Values

0   // None
1   // AssertionIDRequest
2   // SubjectQuery
3   // AuthnQuery
4   // AttributeQuery
5   // AuthzDecisionQuery
6   // AuthnRequest
7   // ManageNameIDRequest
8   // LogoutRequest
9   // NameIDMappingRequest
10   // ArtifactResolve
11   // Response
12   // Assertion

Default Value

0

Remarks

Returns the SAML type of the current message.

Use this property to check the type of SAML message being created. This is the same value that was passed to create_new call.

Depending on the assigned type, use properties of struct to tune up the parameters of the chosen message type. For example, if the content type is cstyAuthnQuery, use authn_query property to adjust context class references or comparison settings.

This property is read-only.

Data Type

i32

message_content_type_string property (SAMLWriter Struct)

Returns the type of the processed message, as an original string.

Syntax

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

Default Value

""

Remarks

Returns the type of the processed message, as an original string.

Check this property to find out the content type of the data stored in the processed message. This returns a string originally included in the SAML message, which may be helpful when processing non-standard types.

Known SAML content types are:

• AssertionIDRequest
• SubjectQuery
• AuthnQuery
• AttributeQuery
• AuthzDecisionQuery
• AuthnRequest
• ManageNameIDRequest
• NameIDMappingRequest
• LogoutRequest
• ArtifactResolve
• Response
• LogoutResponse
• ArtifactResponse
• NameIDMappingResponse

This property is read-only.

Data Type

String

message_destination property (SAMLWriter Struct)

Contains the Destination parameter of the SAML message.

Syntax

fn message_destination(&self ) -> Result<String, SecureBlackboxError> 
fn set_message_destination(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_message_destination_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the Destination parameter of the SAML message.

Use this property to set the Destination parameter of the created SAML object.

Data Type

String

message_id property (SAMLWriter Struct)

The ID of the request.

Syntax

fn message_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_message_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_message_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The ID of the request.

Use this property to specify the ID of the SAML request or response.

Data Type

String

message_in_response_to property (SAMLWriter Struct)

Contains the InResponseTo property of the SAML request.

Syntax

fn message_in_response_to(&self ) -> Result<String, SecureBlackboxError> 
fn set_message_in_response_to(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_message_in_response_to_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the InResponseTo property of the SAML request.

Use this property to specify the ID of the message in response to which the current entity is provided.

Data Type

String

message_issue_instant property (SAMLWriter Struct)

Contains request issuance timestamp.

Syntax

fn message_issue_instant(&self ) -> Result<String, SecureBlackboxError> 
fn set_message_issue_instant(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_message_issue_instant_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains request issuance timestamp.

Set this property to specify the time moment of the request formation. Leave it empty to use the current system time.

Data Type

String

message_issuer property (SAMLWriter Struct)

Sets the issuer of the message.

Syntax

fn message_issuer(&self ) -> Result<String, SecureBlackboxError> 
fn set_message_issuer(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_message_issuer_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Sets the issuer of the message.

Set this property to include the SAML ID of the issuer of the SAML message. A typical SAML ID is a string of semicolon-separated elements of one or more of the following elements:

• Format
• NameQualifier
• Value
• IDType
• SPNameQualifier
• SPProvidedID

For example, writer.Message.Issuer = "Value=https://saml.entity.org/resource;Format=urn:oasis:names:tc:SAML:2.0:nameid-format:entity;IDType=Issuer";

Data Type

String

message_signature_validation_result property (SAMLWriter Struct)

The outcome of the cryptographic signature validation.

Syntax

fn message_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

message_signed property (SAMLWriter Struct)

Specifies whether the SAML message is or should be signed.

Syntax

fn message_signed(&self ) -> Result<bool, SecureBlackboxError> 
fn set_message_signed(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether the SAML message is or should be signed.

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

Data Type

bool

message_subject property (SAMLWriter Struct)

Gets or sets the subject of the message.

Syntax

fn message_subject(&self ) -> Result<String, SecureBlackboxError> 
fn set_message_subject(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_message_subject_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Gets or sets the subject of the message.

Check this property to obtain the SAML ID of the message subject.

Set this property to include the SAML ID of the issuer of the SAML message. A typical SAML ID is a string of semicolon-separated elements of one or more of the following elements:

• Format
• NameQualifier
• Value
• IDType
• SPNameQualifier
• SPProvidedID

For example, writer.Message.Subject = "Value=https://saml.entity.org/resource;Format=urn:oasis:names:tc:SAML:2.0:nameid-format:entity;IDType=Issuer";

Data Type

String

message_version property (SAMLWriter Struct)

Specifies the protocol version to use for the SAML message.

Syntax

fn message_version(&self ) -> Result<String, SecureBlackboxError> 
fn set_message_version(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_message_version_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"2.0"

Remarks

Specifies the protocol version to use for the SAML message.

Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.

Data Type

String

message_xml_header property (SAMLWriter Struct)

Controls the inclusion of an XML header in the message.

Syntax

fn message_xml_header(&self ) -> Result<bool, SecureBlackboxError> 
fn set_message_xml_header(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Controls the inclusion of an XML header in the message.

Use this property to enable or disable inclusion of the XML header in the SAML message.

Data Type

bool

name_id_mapping_request_name_id property (SAMLWriter Struct)

An accessor to the NameID parameter of the request.

Syntax

fn name_id_mapping_request_name_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_name_id_mapping_request_name_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_name_id_mapping_request_name_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

An accessor to the NameID parameter of the request.

Use this property to read or set the value of the NameID parameter of the request object.

Data Type

String

name_id_mapping_request_name_id_policy_allow_create property (SAMLWriter Struct)

Contains the value of AllowCreate parameter of the NameIDPolicy object.

Syntax

fn name_id_mapping_request_name_id_policy_allow_create(&self ) -> Result<bool, SecureBlackboxError> 
fn set_name_id_mapping_request_name_id_policy_allow_create(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Contains the value of AllowCreate parameter of the NameIDPolicy object.

Use this property to read or set the value of the AllowCreate parameter of the NameIDPolicy object. AllowCreate regulates whether the identity provider is given permission to create new subject identifiers.

Data Type

bool

name_id_mapping_request_name_id_policy_format property (SAMLWriter Struct)

Specifies the format of the NameIDPolicy element.

Syntax

fn name_id_mapping_request_name_id_policy_format(&self ) -> Result<String, SecureBlackboxError> 
fn set_name_id_mapping_request_name_id_policy_format(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_name_id_mapping_request_name_id_policy_format_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the format of the NameIDPolicy element.

Use this property to set or read the value of the Format parameter of the NameIDPolicy object.

Data Type

String

name_id_mapping_request_name_id_policy_sp_name_qualifier property (SAMLWriter Struct)

Contains the SPNameQualifier parameter of the NameIDPolicy element.

Syntax

fn name_id_mapping_request_name_id_policy_sp_name_qualifier(&self ) -> Result<String, SecureBlackboxError> 
fn set_name_id_mapping_request_name_id_policy_sp_name_qualifier(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_name_id_mapping_request_name_id_policy_sp_name_qualifier_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the SPNameQualifier parameter of the NameIDPolicy element.

Use this property to specify or read the value of the SPNameQualifier parameter of the NameIDPolicy element of the request.

Data Type

String

name_id_mapping_request_name_id_policy_use_allow_create property (SAMLWriter Struct)

Controls inclusion of UseAllow modifier in the NameIDPolicy object.

Syntax

fn name_id_mapping_request_name_id_policy_use_allow_create(&self ) -> Result<bool, SecureBlackboxError> 
fn set_name_id_mapping_request_name_id_policy_use_allow_create(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Controls inclusion of UseAllow modifier in the NameIDPolicy object.

Use this property to include or exclude the UseAllow parameter from the NameIDPolicy object.

Data Type

bool

profile property (SAMLWriter Struct)

Specifies a pre-defined profile to apply when creating the signature.

Syntax

fn profile(&self ) -> Result<String, SecureBlackboxError> 
fn set_profile(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_profile_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.

Data Type

String

references property (SAMLWriter Struct)

Contains the References entry of the SAML AssertionIDRequest message.

Syntax

fn references(&self ) -> Result<String, SecureBlackboxError> 
fn set_references(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_references_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to read or specify the value of the References entry of the AssertionIDRequest message.

Data Type

String

response_name_id property (SAMLWriter Struct)

Contains the NameID parameter of a NameIDMapping response.

Syntax

fn response_name_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_response_name_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_response_name_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the NameID parameter of a NameIDMapping response.

Use this property to read or set the NameID parameter of the NameIDMapping response.

Data Type

String

response_optional_element property (SAMLWriter Struct)

An optional message element to be returned with the response.

Syntax

fn response_optional_element(&self ) -> Result<String, SecureBlackboxError> 
fn set_response_optional_element(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_response_optional_element_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

An optional message element to be returned with the response.

Use this property to access or set the optional XML element returned with the response.

Data Type

String

response_type property (SAMLWriter Struct)

Contains the type of the response.

Syntax

fn response_type(&self ) -> Result<i32, SecureBlackboxError> 
fn set_response_type(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Response
1   // ArtifactResponse
2   // NameIDMappingResponse
3   // LogoutResponse

Default Value

0

Remarks

Contains the type of the response.

Use this property to get or set the type of the SAML response.

Data Type

i32

response_status property (SAMLWriter Struct)

Gets or sets the status of the response.

Syntax

fn response_status(&self ) -> Result<i32, SecureBlackboxError> 
fn set_response_status(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Gets or sets the status of the response.

This property specifies the status code to include in the response. This property adjusts the values of the response_status_code_value and other status properties.

This property is a bitwise combination of the status facility and an error code. The facility mask can be one of the following:

• 0x00000000 - Success (urn:oasis:names:tc:SAML:2.0:status:Success)
• 0x00010000 - Requester Error (urn:oasis:names:tc:SAML:2.0:status:Requester)
• 0x00020000 - Responder Error (urn:oasis:names:tc:SAML:2.0:status:Responder)
• 0x00030000 - Version Mismatch (urn:oasis:names:tc:SAML:2.0:status:VersionMismatch)
• 0x00FF0000 - Undefined or Unknown

The code assigned to the setting is saved in the response as the status given in the brackets.

The error code can take one of the following values:

• 0x00000001 - Authentication Failed (urn:oasis:names:tc:SAML:2.0:status:AuthnFailed)
• 0x00000002 - Unsupported content received within the received Attribute structure (urn:oasis:names:tc:SAML:2.0:status:InvalidAttrNameOrValue)
• 0x00000003 - The requested Name Identifier policy is not supported by the provider (urn:oasis:names:tc:SAML:2.0:status:InvalidNameIDPolicy)
• 0x00000004 - The requested Authentication Context requirements cannot be satisfied by the provider (urn:oasis:names:tc:SAML:2.0:status:NoAuthnContext)
• 0x00000005 - None of the elements in the IDP list can be resolved (urn:oasis:names:tc:SAML:2.0:status:NoAvailableIDP)
• 0x00000006 - The provider cannot authenticate the requestor passively (urn:oasis:names:tc:SAML:2.0:status:NoPassive)
• 0x00000007 - None of the requested providers in the IDP list are supported (urn:oasis:names:tc:SAML:2.0:status:NoSupportedIDP)
• 0x00000008 - The Logout request could not be passed on to other session participants (urn:oasis:names:tc:SAML:2.0:status:PartialLogout)
• 0x00000009 - Proxy count exceeded (urn:oasis:names:tc:SAML:2.0:status:ProxyCountExceeded)
• 0x0000000A - Request denied for internal reasons (urn:oasis:names:tc:SAML:2.0:status:RequestDenied)
• 0x0000000B - The request or its type is not supported by the provider (urn:oasis:names:tc:SAML:2.0:status:RequestUnsupported)
• 0x0000000C - The version of the request has been deprecated (urn:oasis:names:tc:SAML:2.0:status:RequestVersionDeprecated)
• 0x0000000D - The version of the request is too high (urn:oasis:names:tc:SAML:2.0:status:RequestVersionTooHigh)
• 0x0000000E - The version of the request is too low (urn:oasis:names:tc:SAML:2.0:status:RequestVersionTooLow)
• 0x0000000F - The resource included in the request has not been recognised (urn:oasis:names:tc:SAML:2.0:status:ResourceNotRecognized)
• 0x00000010 - The number of responses to be returned is too high for the provider to satisfy (urn:oasis:names:tc:SAML:2.0:status:TooManyResponses)
• 0x00000011 - The attribute profile is unknown to the provider (urn:oasis:names:tc:SAML:2.0:status:UnknownAttrProfile)
• 0x00000012 - The principal mentioned in the request is unknown to the provider (urn:oasis:names:tc:SAML:2.0:status:UnknownPrincipal)
• 0x00000013 - Unsupported binding type (urn:oasis:names:tc:SAML:2.0:status:UnsupportedBinding)

To return a custom error code not available via the above flags, use response_status_code_value and response_status_code_sub_value properties.

Data Type

i32

response_status_code_sub_value property (SAMLWriter Struct)

The value of the nested StatusCode.

Syntax

fn response_status_code_sub_value(&self ) -> Result<String, SecureBlackboxError> 
fn set_response_status_code_sub_value(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_response_status_code_sub_value_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The value of the nested StatusCode.

This property contains the value of the nested StatusCode element.

Data Type

String

response_status_code_value property (SAMLWriter Struct)

Contains the status code value.

Syntax

fn response_status_code_value(&self ) -> Result<String, SecureBlackboxError> 
fn set_response_status_code_value(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_response_status_code_value_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the status code value.

Use this property to read or set one of the status codes defined by SAML specification, such as 'urn:oasis:names:tc:SAML:2.0:status:Success' or 'urn:oasis:names:tc:SAML:2.0:status:Requester'.

Data Type

String

response_status_detail property (SAMLWriter Struct)

Contains additional information on the status of the request.

Syntax

fn response_status_detail(&self ) -> Result<String, SecureBlackboxError> 
fn set_response_status_detail(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_response_status_detail_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains additional information on the status of the request.

The StatusDetail element contains additional request status information.

Data Type

String

response_status_message property (SAMLWriter Struct)

Contains a status message (optional).

Syntax

fn response_status_message(&self ) -> Result<String, SecureBlackboxError> 
fn set_response_status_message(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_response_status_message_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains a status message (optional).

This property specifies the status message which may, optionally, be returned to an operator.

Data Type

String

scoping_idp_count property (SAMLWriter Struct)

The number of records in the ScopingIDP arrays.

Syntax

fn scoping_idp_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_scoping_idp_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• scoping_idp_loc
• scoping_idp_name
• scoping_idp_provider_id

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

Data Type

i32

scoping_idp_loc property (SAMLWriter Struct)

Contains the value of the Loc attribute.

Syntax

fn scoping_idp_loc(&self , ScopingIDPIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_scoping_idp_loc(&self, ScopingIDPIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_scoping_idp_loc_ref(&self, ScopingIDPIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the value of the Loc attribute.

Use this property to access or set the value of the Loc (location) attribute.

The ScopingIDPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ScopingIDPCount property.

Data Type

String

scoping_idp_name property (SAMLWriter Struct)

Contains the name of the IdP provider.

Syntax

fn scoping_idp_name(&self , ScopingIDPIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_scoping_idp_name(&self, ScopingIDPIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_scoping_idp_name_ref(&self, ScopingIDPIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the name of the IdP provider.

Use this property to retrieve or set the Name attribute of the IdP provider.

The ScopingIDPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ScopingIDPCount property.

Data Type

String

scoping_idp_provider_id property (SAMLWriter Struct)

Contains the provider ID.

Syntax

fn scoping_idp_provider_id(&self , ScopingIDPIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_scoping_idp_provider_id(&self, ScopingIDPIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_scoping_idp_provider_id_ref(&self, ScopingIDPIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the provider ID.

Use this property to read or set the identity provider ID.

The ScopingIDPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ScopingIDPCount property.

Data Type

String

security_canonicalization_method property (SAMLWriter 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 (SAMLWriter 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 (SAMLWriter 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 (SAMLWriter 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 (SAMLWriter 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 (SAMLWriter 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

signing_cert_bytes property (SAMLWriter 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 (SAMLWriter 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 (SAMLWriter 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 (SAMLWriter 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 (SAMLWriter 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

statement_count property (SAMLWriter Struct)

The number of records in the Statement arrays.

Syntax

fn statement_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_statement_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• statement_authn_context_authenticating_authorities
• statement_authn_context_choice
• statement_authn_context_class_ref
• statement_authn_context_decl
• statement_authn_context_decl_ref
• statement_authn_instant
• statement_authn_session_index
• statement_authn_session_not_on_or_after
• statement_authn_subject_locality_address
• statement_authn_subject_locality_dns_name
• statement_authz_actions
• statement_authz_decision
• statement_authz_decision_evidence
• statement_authz_decision_resource
• statement_type

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

Data Type

i32

statement_authn_context_authenticating_authorities property (SAMLWriter Struct)

Contains the list of authenticating authorities.

Syntax

fn statement_authn_context_authenticating_authorities(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_statement_authn_context_authenticating_authorities(&self, StatementIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_statement_authn_context_authenticating_authorities_ref(&self, StatementIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the list of authenticating authorities.

Use this property to access the list of URIs of authenticating authorities (IdP entity IDs).

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

Data Type

String

statement_authn_context_choice property (SAMLWriter Struct)

Specifies the authentication context choice variant.

Syntax

fn statement_authn_context_choice(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_statement_authn_context_choice(&self, StatementIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_statement_authn_context_choice_ref(&self, StatementIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the authentication context choice variant.

Use this property to set the authentication context choice variant. The currently supported values are v1 and v2. If this setting is left empty, the v1 variant is assumed.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

Data Type

String

statement_authn_context_class_ref property (SAMLWriter Struct)

Indicates the authentication contexts class reference.

Syntax

fn statement_authn_context_class_ref(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_statement_authn_context_class_ref(&self, StatementIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_statement_authn_context_class_ref_ref(&self, StatementIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Indicates the authentication contexts class reference.

Use this property to get or set the authentication contexts class reference attribute.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

Data Type

String

statement_authn_context_decl property (SAMLWriter Struct)

Specifies the authentication contexts declaration.

Syntax

fn statement_authn_context_decl(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_statement_authn_context_decl(&self, StatementIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_statement_authn_context_decl_ref(&self, StatementIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the authentication contexts declaration.

Use this property to access or set the declaration element of the authentication context.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

Data Type

String

statement_authn_context_decl_ref property (SAMLWriter Struct)

Specifies the authentication contexts declaration reference.

Syntax

fn statement_authn_context_decl_ref(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_statement_authn_context_decl_ref(&self, StatementIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_statement_authn_context_decl_ref_ref(&self, StatementIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the authentication contexts declaration reference.

Use this property to get or set the declaration reference of the authentication context.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

Data Type

String

statement_authn_instant property (SAMLWriter Struct)

Specifies the authentication event timestamp.

Syntax

fn statement_authn_instant(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_statement_authn_instant(&self, StatementIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_statement_authn_instant_ref(&self, StatementIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the authentication event timestamp.

Use this property to read or set the moment in time the authentication event took place.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

Data Type

String

statement_authn_session_index property (SAMLWriter Struct)

Contains the authentication session index.

Syntax

fn statement_authn_session_index(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_statement_authn_session_index(&self, StatementIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_statement_authn_session_index_ref(&self, StatementIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the authentication session index.

Use this property to access or set the authentication session index.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

Data Type

String

statement_authn_session_not_on_or_after property (SAMLWriter Struct)

Maps to the SessionNotOnOrAfter parameter of the authentication statement.

Syntax

fn statement_authn_session_not_on_or_after(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_statement_authn_session_not_on_or_after(&self, StatementIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_statement_authn_session_not_on_or_after_ref(&self, StatementIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Maps to the SessionNotOnOrAfter parameter of the authentication statement.

Use this property to access or set the SessionNotOnOrAfter parameter of the authentication statement.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

Data Type

String

statement_authn_subject_locality_address property (SAMLWriter Struct)

Specifies the authentication subjects address.

Syntax

fn statement_authn_subject_locality_address(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_statement_authn_subject_locality_address(&self, StatementIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_statement_authn_subject_locality_address_ref(&self, StatementIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the authentication subjects address.

Use this property to specify the address parameter of the authentication subjects locality.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

Data Type

String

statement_authn_subject_locality_dns_name property (SAMLWriter Struct)

Maps to the authentication subjects DNS name parameter.

Syntax

fn statement_authn_subject_locality_dns_name(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_statement_authn_subject_locality_dns_name(&self, StatementIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_statement_authn_subject_locality_dns_name_ref(&self, StatementIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Maps to the authentication subjects DNS name parameter.

Use this property to access or set the authentication subjects DNS name locality parameter.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

Data Type

String

statement_authz_actions property (SAMLWriter Struct)

Provides access to the list of actions of the authorization statement.

Syntax

fn statement_authz_actions(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_statement_authz_actions(&self, StatementIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_statement_authz_actions_ref(&self, StatementIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Provides access to the list of actions of the authorization statement.

Use this property to read or set the actions of the authorization statement. Actions are represented as a list of Namespace=namespace;Value=Value strings, separated with CRLFs.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

Data Type

String

statement_authz_decision property (SAMLWriter Struct)

Specifies the authorization decision.

Syntax

fn statement_authz_decision(&self , StatementIndex : i32) -> Result<i32, SecureBlackboxError> 
fn set_statement_authz_decision(&self, StatementIndex : i32, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Permit
1   // Deny
2   // Indeterminate

Default Value

0

Remarks

Specifies the authorization decision.

Use this property to check or set the authorization decision. This can be one of Permit, Deny, or Indeterminate.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

Data Type

i32

statement_authz_decision_evidence property (SAMLWriter Struct)

Manages the authorization decision statement evidence parameter.

Syntax

fn statement_authz_decision_evidence(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_statement_authz_decision_evidence(&self, StatementIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_statement_authz_decision_evidence_ref(&self, StatementIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Manages the authorization decision statement evidence parameter.

Use this property to read or set the authorization decision statement evidence parameter.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

Data Type

String

statement_authz_decision_resource property (SAMLWriter Struct)

Specifies the authorization decision statement resource parameter.

Syntax

fn statement_authz_decision_resource(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_statement_authz_decision_resource(&self, StatementIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_statement_authz_decision_resource_ref(&self, StatementIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the authorization decision statement resource parameter.

Use this property to access or set the resource parameter of the authorization statement.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

Data Type

String

statement_type property (SAMLWriter Struct)

Specifies the assertion statement type.

Syntax

fn statement_type(&self , StatementIndex : i32) -> Result<i32, SecureBlackboxError> 
fn set_statement_type(&self, StatementIndex : i32, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Authn
1   // Attribute
2   // AuthzDecision

Default Value

0

Remarks

Specifies the assertion statement type.

This property specifies the assertion statement type. A statement can carry an authentication assertion, an attribute assertion, or an authorization decision assertion.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

Data Type

i32

subject_confirmation_count property (SAMLWriter Struct)

The number of records in the SubjectConfirmation arrays.

Syntax

fn subject_confirmation_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_subject_confirmation_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• subject_confirmation_address
• subject_confirmation_data
• subject_confirmation_data_type
• subject_confirmation_id
• subject_confirmation_in_response_to
• subject_confirmation_method
• subject_confirmation_not_before
• subject_confirmation_not_on_or_after
• subject_confirmation_recipient

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

Data Type

i32

subject_confirmation_address property (SAMLWriter Struct)

Contains the address enabled for presenting assertions.

Syntax

fn subject_confirmation_address(&self , SubjectConfirmationIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_subject_confirmation_address(&self, SubjectConfirmationIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_subject_confirmation_address_ref(&self, SubjectConfirmationIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the address enabled for presenting assertions.

Use this property to specify the network address or location from which the subject confirmation should be issued. This optional element can be used to restrict the possibilities of an attacker to steal the assertion and present it from another IP address.

The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.

Data Type

String

subject_confirmation_data property (SAMLWriter Struct)

The uninterpreted value of data entry in the subject confirmation.

Syntax

fn subject_confirmation_data(&self , SubjectConfirmationIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_subject_confirmation_data(&self, SubjectConfirmationIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_subject_confirmation_data_ref(&self, SubjectConfirmationIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The uninterpreted value of data entry in the subject confirmation.

Use this property to read or specify the uninterpreted value of the Data entry in the subject confirmation blob.

The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.

Data Type

String

subject_confirmation_data_type property (SAMLWriter Struct)

The type of data contained in the confirmation.

Syntax

fn subject_confirmation_data_type(&self , SubjectConfirmationIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_subject_confirmation_data_type(&self, SubjectConfirmationIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_subject_confirmation_data_type_ref(&self, SubjectConfirmationIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The type of data contained in the confirmation.

Use this property to read or specify the type of confirmation data included in the object.

The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.

Data Type

String

subject_confirmation_id property (SAMLWriter Struct)

The identifier of the entity which can satisfy the subject confirmation requirements.

Syntax

fn subject_confirmation_id(&self , SubjectConfirmationIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_subject_confirmation_id(&self, SubjectConfirmationIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_subject_confirmation_id_ref(&self, SubjectConfirmationIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The identifier of the entity which can satisfy the subject confirmation requirements.

This property specifies the identifier of the entity which is expected to satisfy the subject confirmation requirements.

The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.

Data Type

String

subject_confirmation_in_response_to property (SAMLWriter Struct)

The ID of the SAML message in response to which the assertion is issued.

Syntax

fn subject_confirmation_in_response_to(&self , SubjectConfirmationIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_subject_confirmation_in_response_to(&self, SubjectConfirmationIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_subject_confirmation_in_response_to_ref(&self, SubjectConfirmationIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The ID of the SAML message in response to which the assertion is issued.

This property specifies the ID of the SAML message in response to which the assertion is issued.

The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.

Data Type

String

subject_confirmation_method property (SAMLWriter Struct)

Specifies the mechanism to be used to confirm the subject.

Syntax

fn subject_confirmation_method(&self , SubjectConfirmationIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_subject_confirmation_method(&self, SubjectConfirmationIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_subject_confirmation_method_ref(&self, SubjectConfirmationIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the mechanism to be used to confirm the subject.

This property contains a URI reference that identifies the mechanism to be used to confirm the subject.

The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.

Data Type

String

subject_confirmation_not_before property (SAMLWriter Struct)

Time moment before which the subject cannot be confirmed.

Syntax

fn subject_confirmation_not_before(&self , SubjectConfirmationIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_subject_confirmation_not_before(&self, SubjectConfirmationIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_subject_confirmation_not_before_ref(&self, SubjectConfirmationIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Time moment before which the subject cannot be confirmed.

This property specifies the time before which the subject cannot be confirmed.

The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.

Data Type

String

subject_confirmation_not_on_or_after property (SAMLWriter Struct)

Limits the time until which the subject can be confirmed.

Syntax

fn subject_confirmation_not_on_or_after(&self , SubjectConfirmationIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_subject_confirmation_not_on_or_after(&self, SubjectConfirmationIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_subject_confirmation_not_on_or_after_ref(&self, SubjectConfirmationIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Limits the time until which the subject can be confirmed.

This property specifies the time on (or after) which the subject cannot be confirmed.

The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.

Data Type

String

subject_confirmation_recipient property (SAMLWriter Struct)

The URI of the entity or the location of the resource to which the assertion should be presented.

Syntax

fn subject_confirmation_recipient(&self , SubjectConfirmationIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_subject_confirmation_recipient(&self, SubjectConfirmationIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_subject_confirmation_recipient_ref(&self, SubjectConfirmationIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The URI of the entity or the location of the resource to which the assertion should be presented.

This property specifies The URI of the entity or the location of the resource to which the assertion should be presented.

The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.

Data Type

String

add_attribute method (SAMLWriter Struct)

Adds an attribute to an existing attribute statement.

Syntax

fn add_attribute(&self, attribute_name : &str, attribute_value : &str, name_format : &str, content_type : &str, statement_index : i32) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to add an attribute to an attribute statement. The method returns the index of the newly added attribute in the statement.

Use the method parameters to provide the parameters of the new attribute:

<saml:Attribute Name="uid" <!-- AttributeName --> NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" <!-- NameFormat --> > <saml:AttributeValue xsi:type="xs:string" <!-- ContentType --> >test <!-- AttributeValue --> </saml:AttributeValue> </saml:Attribute> </code>

Note: if StatementIndex is set to -1, the attribute will be added to the last attribute statement in the collection. If no attribute statements are available in the collection, one will be created automatically.

If StatementIndex exceeds the index of the last statement in the statements collection, a new attribute statement will be created (even if there are other attribute statements in the list), and the attribute added to it.

If StatementIndex points to an existing statement but that statement is not an attribute statement, an exception will be thrown.

add_attribute_statement method (SAMLWriter Struct)

Adds an attribute statement to the assertion.

Syntax

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

Remarks

Use this method to add an attribute statement to the currently edited assertion. The method returns the index of the newly added statement in the statements collection.

Note that a call to add_attribute adds a new attribute statement behind the scenes if no attribute statements have been added by that time.

add_authn_statement method (SAMLWriter Struct)

Adds an authentication statement to the assertion.

Syntax

fn add_authn_statement(&self, authn_instant : &str, session_index : &str, not_on_or_after : &str, class_ref : &str) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to add an authentication statement to the currently edited assertion. The method returns the index of the newly added statement in the statements collection.

add_authz_decision_statement method (SAMLWriter Struct)

Adds an authorization decision statement to the assertion.

Syntax

fn add_authz_decision_statement(&self, decision : i32, evidence : &str, resource : &str, actions : &str) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to add an authorization decision statement to the currently edited assertion. The method returns the index of the newly added statement in the statements collection.

add_condition method (SAMLWriter Struct)

Adds a condition to the object (assertion or authn request) being edited.

Syntax

fn add_condition(&self, condition_type : i32, condition_value : &str) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to quickly add a condition to the SAML object you are creating.

add_scoping_idp method (SAMLWriter Struct)

Adds a scoping IDP to the object being currently edited.

Syntax

fn add_scoping_idp(&self, name : &str, provider_id : &str, loc : &str) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to quickly add a scoping IDP to the SAML object you are creating. The method returns the index of the new element in the scoping_id_ps collection.

add_subject_confirmation method (SAMLWriter Struct)

Adds a subject confirmation to the object being edited.

Syntax

fn add_subject_confirmation(&self, method : &str, address : &str, recipient : &str, in_response_to : &str, not_before : &str, not_on_or_after : &str, id : &str, data_type : &str, data : &str) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to quickly add a subject confirmation to the SAML object you are creating. The method returns the index of the new subject confirmation in the list.

begin_assertion method (SAMLWriter Struct)

Initiates the process of creating a new assertion.

Syntax

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

Remarks

This method resets the contents of all assertion-related properties and prepares the component for creating a new assertion.

Use the methods and properties of the component, such as assertion, as well as statements and attributes to prepare the new assertion. When ready, call complete_assertion to commit the provided details to the message.

complete_assertion method (SAMLWriter Struct)

Adds a completed assertion to a SAML message.

Syntax

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

Remarks

Use this method to commit an assertion to the SAML message being created. Before calling this method, prepare the assertion by calling begin_assertion and filling in the details via the assertion, attributes, and statements properties.

The method returns the index of the new assertion in the list.

config method (SAMLWriter 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.

create_new method (SAMLWriter Struct)

Creates a new SAML message with the given type.

Syntax

fn create_new(&self, content_type : i32) -> Result<(), SecureBlackboxError>

Remarks

Use this method to create a new SAML message with the specified content type. The following values are supported:

• cstyNone (0)
• cstyAssertionIDRequest (1)
• cstySubjectQuery (2)
• cstyAuthnQuery (3)
• cstyAttributeQuery (4)
• cstyAuthzDecisionQuery (5)
• cstyAuthnRequest (6)
• cstyManageNameIDRequest (7)
• cstyLogoutRequest (8)
• cstyNameIDMappingRequest (9)
• cstyArtifactResolve (10)
• cstyResponse (11)
• cstyAssertion (12)

Depending on the chosen content type, use properties of struct to tune up the parameters of the chosen subtype. For example, if using cstyAuthnQuery as your content type, use authn_query property to adjust context class references or comparison settings.

do_action method (SAMLWriter 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:

format_id method (SAMLWriter Struct)

Formats a SAML ID in the form in which it can be assigned to the Issuer or Subject fields.

Syntax

fn format_id(&self, value : &str, id_type : &str, format : &str, name_qualifier : &str, sp_name_qualifier : &str, sp_provided_id : &str) ->  Result<String, SecureBlackboxError>

Remarks

This is a utility method that simplifies formatting of SAML IDs. Pass the components of the SAML ID to this method, and assign the resulting string to the required property.

Example: // you can provide some of the values; the optional values will be omitted from the output writer.Issuer = writer.FormatID("https://saml.mysite.com", "Issuer", "urn:oasis:names:tc:SAML:2.0:nameid-format:entity", "", "", ""); // this call will just return the bare value, with no attributes writer.Issuer = writer.FormatID("https://saml.mysite.com", "", "", "", "", "");

reset method (SAMLWriter Struct)

Resets the struct settings.

Syntax

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

Remarks

reset is a generic method available in every struct.

save method (SAMLWriter Struct)

Saves the configured message to a string.

Syntax

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

Remarks

Use this method to save the created SAML message to a string.

save_bytes method (SAMLWriter Struct)

Saves the configured message to a byte array.

Syntax

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

Remarks

Use this method to save the formed SAML message to a byte array.

save_file method (SAMLWriter Struct)

Saves the configured message to a file.

Syntax

fn save_file(&self, file_name : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to save the created SAML message to a file.

on_error event (SAMLWriter Struct)

Fires to report an error condition.

Syntax

// SAMLWriterErrorEventArgs carries the SAMLWriter Error event's parameters.
pub struct SAMLWriterErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

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

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

Remarks

Subscribe to this event to be notified about any error conditions occurring during the component's work. ErrorCode and Description provide the details of the error.

on_notification event (SAMLWriter Struct)

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

Syntax

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

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

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

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.

Config Settings (SAMLWriter 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.

SAMLWriter Config Settings

Base Config Settings

Trappable Errors (SAMLWriter Struct)