SAMLWriter Class

Properties   Methods   Events   Config Settings   Errors  

The SAMLWriter class offers SAML message generation functions.

Class Name

SecureBlackbox_SAMLWriter

Procedural Interface

 secureblackbox_samlwriter_open();
 secureblackbox_samlwriter_close($res);
 secureblackbox_samlwriter_register_callback($res, $id, $function);
 secureblackbox_samlwriter_get_last_error($res);
 secureblackbox_samlwriter_get_last_error_code($res);
 secureblackbox_samlwriter_set($res, $id, $index, $value);
 secureblackbox_samlwriter_get($res, $id, $index);
 secureblackbox_samlwriter_do_addadviceassertion($res, $assertionindex);
 secureblackbox_samlwriter_do_addassertion($res);
 secureblackbox_samlwriter_do_clearassertion($res);
 secureblackbox_samlwriter_do_compareids($res, $id1, $id2);
 secureblackbox_samlwriter_do_config($res, $configurationstring);
 secureblackbox_samlwriter_do_createnew($res, $outputtype);
 secureblackbox_samlwriter_do_doaction($res, $actionid, $actionparams);
 secureblackbox_samlwriter_do_getidprop($res, $id, $propname);
 secureblackbox_samlwriter_do_removeadvice($res, $assertionindex);
 secureblackbox_samlwriter_do_removeadviceassertion($res, $assertionindex, $adviceassertionindex);
 secureblackbox_samlwriter_do_removeallassertions($res);
 secureblackbox_samlwriter_do_removeassertion($res, $assertionindex);
 secureblackbox_samlwriter_do_save($res);
 secureblackbox_samlwriter_do_savebytes($res);
 secureblackbox_samlwriter_do_savefile($res, $filename);

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

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

AddXMLHeader Property (SecureBlackbox_SAMLWriter Class)

Controls the inclusion of an XML header in the message.

Object Oriented Interface

public function getAddXMLHeader();


public function setAddXMLHeader($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 1 );


secureblackbox_samlwriter_set($res, 1, $value );

Default Value

false

Remarks

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

This property is not available at design time.

Data Type

Boolean

ArtifactEndpointIndex Property (SecureBlackbox_SAMLWriter Class)

An accessor to the EndpointIndex entry of the artifact.

Object Oriented Interface

public function getArtifactEndpointIndex();


public function setArtifactEndpointIndex($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 2 );


secureblackbox_samlwriter_set($res, 2, $value );

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.

This property is not available at design time.

Data Type

Integer

ArtifactMessageHandle Property (SecureBlackbox_SAMLWriter Class)

An accessor to the MessageHandle property of the artifact.

Object Oriented Interface

public function getArtifactMessageHandle();


public function setArtifactMessageHandle($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 3 );


secureblackbox_samlwriter_set($res, 3, $value );

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.

This property is not available at design time.

Data Type

Byte Array

ArtifactRemainingArtifact Property (SecureBlackbox_SAMLWriter Class)

Returns the contents of the artifact.

Object Oriented Interface

public function getArtifactRemainingArtifact();

Procedural Interface

secureblackbox_samlwriter_get($res, 4 );

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 and not available at design time.

Data Type

Byte Array

ArtifactSourceID Property (SecureBlackbox_SAMLWriter Class)

An accessor to the SourceID property of the artifact.

Object Oriented Interface

public function getArtifactSourceID();


public function setArtifactSourceID($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 5 );


secureblackbox_samlwriter_set($res, 5, $value );

Remarks

An accessor to the SourceID property of the artifact.

SourceID uniquely identifies the issuer of the artifact.

This property is not available at design time.

Data Type

Byte Array

ArtifactTypeCode Property (SecureBlackbox_SAMLWriter Class)

The TypeCode property of the artifact.

Object Oriented Interface

public function getArtifactTypeCode();


public function setArtifactTypeCode($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 6 );


secureblackbox_samlwriter_set($res, 6, $value );

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 ArtifactRemainingArtifact, ArtifactSourceID, and ArtifactMessageHandle parameters.

This property is not available at design time.

Data Type

Integer

ArtifactURI Property (SecureBlackbox_SAMLWriter Class)

An accessor to the URI property of the artifact.

Object Oriented Interface

public function getArtifactURI();


public function setArtifactURI($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 7 );


secureblackbox_samlwriter_set($res, 7, $value );

Default Value

''

Remarks

An accessor to the URI property of the artifact.

The URI property contains the origin of the artifact.

This property is not available at design time.

Data Type

String

ArtifactResolveQuery Property (SecureBlackbox_SAMLWriter Class)

Contains the artifact resolve query.

Object Oriented Interface

public function getArtifactResolveQuery();


public function setArtifactResolveQuery($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 8 );


secureblackbox_samlwriter_set($res, 8, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

AssertionAttrCount Property (SecureBlackbox_SAMLWriter Class)

The number of records in the AssertionAttr arrays.

Object Oriented Interface

public function getAssertionAttrCount();


public function setAssertionAttrCount($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 9 );


secureblackbox_samlwriter_set($res, 9, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AssertionAttrFriendlyName
• AssertionAttrName
• AssertionAttrNameFormat
• AssertionAttrStatementIndex
• AssertionAttrValues

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

This property is not available at design time.

Data Type

Integer

AssertionAttrFriendlyName Property (SecureBlackbox_SAMLWriter Class)

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

Object Oriented Interface

public function getAssertionAttrFriendlyName($assertionattrindex);


public function setAssertionAttrFriendlyName($assertionattrindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 10 , $assertionattrindex);


secureblackbox_samlwriter_set($res, 10, $value , $assertionattrindex);

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

This property is not available at design time.

Data Type

String

AssertionAttrName Property (SecureBlackbox_SAMLWriter Class)

Specifies the name of the attribute.

Object Oriented Interface

public function getAssertionAttrName($assertionattrindex);


public function setAssertionAttrName($assertionattrindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 11 , $assertionattrindex);


secureblackbox_samlwriter_set($res, 11, $value , $assertionattrindex);

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

This property is not available at design time.

Data Type

String

AssertionAttrNameFormat Property (SecureBlackbox_SAMLWriter Class)

Indicates the format used to reference the attribute.

Object Oriented Interface

public function getAssertionAttrNameFormat($assertionattrindex);


public function setAssertionAttrNameFormat($assertionattrindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 12 , $assertionattrindex);


secureblackbox_samlwriter_set($res, 12, $value , $assertionattrindex);

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

This property is not available at design time.

Data Type

String

AssertionAttrStatementIndex Property (SecureBlackbox_SAMLWriter Class)

Contains the index of the statement the attribute corresponds to.

Object Oriented Interface

public function getAssertionAttrStatementIndex($assertionattrindex);


public function setAssertionAttrStatementIndex($assertionattrindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 13 , $assertionattrindex);


secureblackbox_samlwriter_set($res, 13, $value , $assertionattrindex);

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

This property is not available at design time.

Data Type

Integer

AssertionAttrValues Property (SecureBlackbox_SAMLWriter Class)

Contains a list of attribute values.

Object Oriented Interface

public function getAssertionAttrValues($assertionattrindex);


public function setAssertionAttrValues($assertionattrindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 14 , $assertionattrindex);


secureblackbox_samlwriter_set($res, 14, $value , $assertionattrindex);

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

This property is not available at design time.

Data Type

String

AssertionConditionCount Property (SecureBlackbox_SAMLWriter Class)

The number of records in the AssertionCondition arrays.

Object Oriented Interface

public function getAssertionConditionCount();


public function setAssertionConditionCount($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 15 );


secureblackbox_samlwriter_set($res, 15, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AssertionConditionAudienceList
• AssertionConditionConditionType
• AssertionConditionProxyRestrictionCount

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

This property is not available at design time.

Data Type

Integer

AssertionConditionAudienceList Property (SecureBlackbox_SAMLWriter Class)

An accessor to the Audience list parameter of an audience restriction condition.

Object Oriented Interface

public function getAssertionConditionAudienceList($assertionconditionindex);


public function setAssertionConditionAudienceList($assertionconditionindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 16 , $assertionconditionindex);


secureblackbox_samlwriter_set($res, 16, $value , $assertionconditionindex);

Default Value

''

Remarks

An accessor to the Audience list parameter of an audience restriction condition.

Use this property to 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.

The $assertionconditionindex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionConditionCount property.

This property is not available at design time.

Data Type

String

AssertionConditionConditionType Property (SecureBlackbox_SAMLWriter Class)

Specifies a type of the condition object.

Object Oriented Interface

public function getAssertionConditionConditionType($assertionconditionindex);


public function setAssertionConditionConditionType($assertionconditionindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 17 , $assertionconditionindex);


secureblackbox_samlwriter_set($res, 17, $value , $assertionconditionindex);

Default Value

0

Remarks

Specifies a type of the condition object.

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

The $assertionconditionindex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionConditionCount property.

This property is not available at design time.

Data Type

Integer

AssertionConditionProxyRestrictionCount Property (SecureBlackbox_SAMLWriter Class)

An accessor to the proxy restriction count element of the condition.

Object Oriented Interface

public function getAssertionConditionProxyRestrictionCount($assertionconditionindex);


public function setAssertionConditionProxyRestrictionCount($assertionconditionindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 18 , $assertionconditionindex);


secureblackbox_samlwriter_set($res, 18, $value , $assertionconditionindex);

Default Value

0

Remarks

An accessor to the proxy restriction count element of the condition.

Use this setting to access or set the value of the proxy restriction count condition.

The $assertionconditionindex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionConditionCount property.

This property is not available at design time.

Data Type

Integer

AssertionCount Property (SecureBlackbox_SAMLWriter Class)

Returns the number of assertions in the message.

Object Oriented Interface

public function getAssertionCount();

Procedural Interface

secureblackbox_samlwriter_get($res, 19 );

Default Value

0

Remarks

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

This property is read-only and not available at design time.

Data Type

Integer

AssertionIDRequestReferences Property (SecureBlackbox_SAMLWriter Class)

Contains the References entry of the SAML assertion ID request.

Object Oriented Interface

public function getAssertionIDRequestReferences();


public function setAssertionIDRequestReferences($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 20 );


secureblackbox_samlwriter_set($res, 20, $value );

Default Value

''

Remarks

Contains the References entry of the SAML assertion ID request.

Use this property to read or specify the value of the References entry of the Assertion ID Request.

This property is not available at design time.

Data Type

String

AssertionInfoAdviceAssertionCount Property (SecureBlackbox_SAMLWriter Class)

Contains the number of advice assertions.

Object Oriented Interface

public function getAssertionInfoAdviceAssertionCount();


public function setAssertionInfoAdviceAssertionCount($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 21 );


secureblackbox_samlwriter_set($res, 21, $value );

Default Value

0

Remarks

Contains the number of advice assertions.

Use this property to access the number of advice assertions.

This property is not available at design time.

Data Type

Integer

AssertionInfoAssertionType Property (SecureBlackbox_SAMLWriter Class)

Specifies the type of the assertion.

Object Oriented Interface

public function getAssertionInfoAssertionType();


public function setAssertionInfoAssertionType($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 22 );


secureblackbox_samlwriter_set($res, 22, $value );

Default Value

0

Remarks

Specifies the type of the assertion.

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

This property is not available at design time.

Data Type

Integer

AssertionInfoChainValidationDetails Property (SecureBlackbox_SAMLWriter Class)

The details of a certificate chain validation outcome.

Object Oriented Interface

public function getAssertionInfoChainValidationDetails();

Procedural Interface

secureblackbox_samlwriter_get($res, 23 );

Default Value

0

Remarks

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

Returns a bit mask of the following options:

This property is read-only and not available at design time.

Data Type

Integer

AssertionInfoChainValidationResult Property (SecureBlackbox_SAMLWriter Class)

The outcome of a certificate chain validation routine.

Object Oriented Interface

public function getAssertionInfoChainValidationResult();

Procedural Interface

secureblackbox_samlwriter_get($res, 24 );

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

This property is read-only and not available at design time.

Data Type

Integer

AssertionInfoConditionsNotBefore Property (SecureBlackbox_SAMLWriter Class)

Represents the Conditions.

Object Oriented Interface

public function getAssertionInfoConditionsNotBefore();


public function setAssertionInfoConditionsNotBefore($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 25 );


secureblackbox_samlwriter_set($res, 25, $value );

Default Value

''

Remarks

Represents the Conditions.NotBefore assertion property.

Use this property to get or set the Conditions.NotBefore property of the assertion.

This property is not available at design time.

Data Type

String

AssertionInfoConditionsNotOnOrAfter Property (SecureBlackbox_SAMLWriter Class)

Represents the Conditions.

Object Oriented Interface

public function getAssertionInfoConditionsNotOnOrAfter();


public function setAssertionInfoConditionsNotOnOrAfter($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 26 );


secureblackbox_samlwriter_set($res, 26, $value );

Default Value

''

Remarks

Represents the Conditions.NotOnOrAfter assertion property.

Use this property to get or set the Conditions.NotOnOrAfter property of the assertion.

This property is not available at design time.

Data Type

String

AssertionInfoEncryptedContent Property (SecureBlackbox_SAMLWriter Class)

Represents the encrypted assertion content.

Object Oriented Interface

public function getAssertionInfoEncryptedContent();


public function setAssertionInfoEncryptedContent($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 27 );


secureblackbox_samlwriter_set($res, 27, $value );

Default Value

''

Remarks

Represents the encrypted assertion content.

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

This property is not available at design time.

Data Type

String

AssertionInfoID Property (SecureBlackbox_SAMLWriter Class)

Represents the ID of the assertion.

Object Oriented Interface

public function getAssertionInfoID();


public function setAssertionInfoID($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 28 );


secureblackbox_samlwriter_set($res, 28, $value );

Default Value

''

Remarks

Represents the ID of the assertion.

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

This property is not available at design time.

Data Type

String

AssertionInfoIDRef Property (SecureBlackbox_SAMLWriter Class)

Represents an ID reference value.

Object Oriented Interface

public function getAssertionInfoIDRef();


public function setAssertionInfoIDRef($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 29 );


secureblackbox_samlwriter_set($res, 29, $value );

Default Value

''

Remarks

Represents an ID reference value.

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

This property is not available at design time.

Data Type

String

AssertionInfoIssueInstant Property (SecureBlackbox_SAMLWriter Class)

Contains the assertion issuance time stamp.

Object Oriented Interface

public function getAssertionInfoIssueInstant();


public function setAssertionInfoIssueInstant($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 30 );


secureblackbox_samlwriter_set($res, 30, $value );

Default Value

''

Remarks

Contains the assertion issuance time stamp.

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

This property is not available at design time.

Data Type

String

AssertionInfoSignatureValidationResult Property (SecureBlackbox_SAMLWriter Class)

The outcome of the cryptographic signature validation.

Object Oriented Interface

public function getAssertionInfoSignatureValidationResult();

Procedural Interface

secureblackbox_samlwriter_get($res, 31 );

Default Value

0

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

This property is read-only and not available at design time.

Data Type

Integer

AssertionInfoSigned Property (SecureBlackbox_SAMLWriter Class)

Specifies whether the assertion is signed.

Object Oriented Interface

public function getAssertionInfoSigned();


public function setAssertionInfoSigned($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 32 );


secureblackbox_samlwriter_set($res, 32, $value );

Default Value

false

Remarks

Specifies whether the assertion is signed.

Use this property to establish whether the assertion is signed.

This property is not available at design time.

Data Type

Boolean

AssertionInfoURIRef Property (SecureBlackbox_SAMLWriter Class)

Represents an URI reference value.

Object Oriented Interface

public function getAssertionInfoURIRef();


public function setAssertionInfoURIRef($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 33 );


secureblackbox_samlwriter_set($res, 33, $value );

Default Value

''

Remarks

Represents an URI reference value.

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

This property is not available at design time.

Data Type

String

AssertionInfoValidationLog Property (SecureBlackbox_SAMLWriter Class)

Contains the signing certificate's chain validation log.

Object Oriented Interface

public function getAssertionInfoValidationLog();

Procedural Interface

secureblackbox_samlwriter_get($res, 34 );

Default Value

''

Remarks

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

This property is read-only and not available at design time.

Data Type

String

AssertionInfoVersion Property (SecureBlackbox_SAMLWriter Class)

Specifies the SAML protocol version used.

Object Oriented Interface

public function getAssertionInfoVersion();


public function setAssertionInfoVersion($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 35 );


secureblackbox_samlwriter_set($res, 35, $value );

Default Value

''

Remarks

Specifies the SAML protocol version used.

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

This property is not available at design time.

Data Type

String

AssertionIssuer Property (SecureBlackbox_SAMLWriter Class)

Specifies the assertion issuer.

Object Oriented Interface

public function getAssertionIssuer();


public function setAssertionIssuer($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 36 );


secureblackbox_samlwriter_set($res, 36, $value );

Default Value

''

Remarks

Use this property to provide the assertion issuer ID.

This property is not available at design time.

Data Type

String

AssertionStatementCount Property (SecureBlackbox_SAMLWriter Class)

The number of records in the AssertionStatement arrays.

Object Oriented Interface

public function getAssertionStatementCount();


public function setAssertionStatementCount($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 37 );


secureblackbox_samlwriter_set($res, 37, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AssertionStatementAttributes
• AssertionStatementAuthnContextAuthenticatingAuthorities
• AssertionStatementAuthnContextChoice
• AssertionStatementAuthnContextClassRef
• AssertionStatementAuthnContextDecl
• AssertionStatementAuthnContextDeclRef
• AssertionStatementAuthnInstant
• AssertionStatementAuthnSessionIndex
• AssertionStatementAuthnSessionNotOnOrAfter
• AssertionStatementAuthnSubjectLocalityAddress
• AssertionStatementAuthnSubjectLocalityDNSName
• AssertionStatementAuthzActions
• AssertionStatementAuthzDecision
• AssertionStatementAuthzDecisionEvidence
• AssertionStatementAuthzDecisionResource
• AssertionStatementStatementType

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

This property is not available at design time.

Data Type

Integer

AssertionStatementAttributes Property (SecureBlackbox_SAMLWriter Class)

Contains a list of statement attribute names.

Object Oriented Interface

public function getAssertionStatementAttributes($assertionstatementindex);


public function setAssertionStatementAttributes($assertionstatementindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 38 , $assertionstatementindex);


secureblackbox_samlwriter_set($res, 38, $value , $assertionstatementindex);

Default Value

''

Remarks

Contains a list of statement attribute names.

Use this property to access the set of names of assertion attributes, separated by CRLF.

The $assertionstatementindex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionStatementCount property.

This property is not available at design time.

Data Type

String

AssertionStatementAuthnContextAuthenticatingAuthorities Property (SecureBlackbox_SAMLWriter Class)

Contains the list of authenticating authorities.

Object Oriented Interface

public function getAssertionStatementAuthnContextAuthenticatingAuthorities($assertionstatementindex);


public function setAssertionStatementAuthnContextAuthenticatingAuthorities($assertionstatementindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 39 , $assertionstatementindex);


secureblackbox_samlwriter_set($res, 39, $value , $assertionstatementindex);

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

This property is not available at design time.

Data Type

String

AssertionStatementAuthnContextChoice Property (SecureBlackbox_SAMLWriter Class)

Specifies the authentication context choice variant.

Object Oriented Interface

public function getAssertionStatementAuthnContextChoice($assertionstatementindex);


public function setAssertionStatementAuthnContextChoice($assertionstatementindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 40 , $assertionstatementindex);


secureblackbox_samlwriter_set($res, 40, $value , $assertionstatementindex);

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

This property is not available at design time.

Data Type

String

AssertionStatementAuthnContextClassRef Property (SecureBlackbox_SAMLWriter Class)

Indicates the authentication contexts class reference.

Object Oriented Interface

public function getAssertionStatementAuthnContextClassRef($assertionstatementindex);


public function setAssertionStatementAuthnContextClassRef($assertionstatementindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 41 , $assertionstatementindex);


secureblackbox_samlwriter_set($res, 41, $value , $assertionstatementindex);

Default Value

''

Remarks

Indicates the authentication contexts class reference.

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

The $assertionstatementindex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionStatementCount property.

This property is not available at design time.

Data Type

String

AssertionStatementAuthnContextDecl Property (SecureBlackbox_SAMLWriter Class)

Specifies the authentication contexts declaration.

Object Oriented Interface

public function getAssertionStatementAuthnContextDecl($assertionstatementindex);


public function setAssertionStatementAuthnContextDecl($assertionstatementindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 42 , $assertionstatementindex);


secureblackbox_samlwriter_set($res, 42, $value , $assertionstatementindex);

Default Value

''

Remarks

Specifies the authentication contexts declaration.

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

The $assertionstatementindex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionStatementCount property.

This property is not available at design time.

Data Type

String

AssertionStatementAuthnContextDeclRef Property (SecureBlackbox_SAMLWriter Class)

Specifies the authentication contexts declaration reference.

Object Oriented Interface

public function getAssertionStatementAuthnContextDeclRef($assertionstatementindex);


public function setAssertionStatementAuthnContextDeclRef($assertionstatementindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 43 , $assertionstatementindex);


secureblackbox_samlwriter_set($res, 43, $value , $assertionstatementindex);

Default Value

''

Remarks

Specifies the authentication contexts declaration reference.

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

The $assertionstatementindex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionStatementCount property.

This property is not available at design time.

Data Type

String

AssertionStatementAuthnInstant Property (SecureBlackbox_SAMLWriter Class)

Specifies the authentication event timestamp.

Object Oriented Interface

public function getAssertionStatementAuthnInstant($assertionstatementindex);


public function setAssertionStatementAuthnInstant($assertionstatementindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 44 , $assertionstatementindex);


secureblackbox_samlwriter_set($res, 44, $value , $assertionstatementindex);

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

This property is not available at design time.

Data Type

String

AssertionStatementAuthnSessionIndex Property (SecureBlackbox_SAMLWriter Class)

Contains the authentication session index.

Object Oriented Interface

public function getAssertionStatementAuthnSessionIndex($assertionstatementindex);


public function setAssertionStatementAuthnSessionIndex($assertionstatementindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 45 , $assertionstatementindex);


secureblackbox_samlwriter_set($res, 45, $value , $assertionstatementindex);

Default Value

''

Remarks

Contains the authentication session index.

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

The $assertionstatementindex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionStatementCount property.

This property is not available at design time.

Data Type

String

AssertionStatementAuthnSessionNotOnOrAfter Property (SecureBlackbox_SAMLWriter Class)

Maps to the SessionNotOnOrAfter parameter of the authentication statement.

Object Oriented Interface

public function getAssertionStatementAuthnSessionNotOnOrAfter($assertionstatementindex);


public function setAssertionStatementAuthnSessionNotOnOrAfter($assertionstatementindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 46 , $assertionstatementindex);


secureblackbox_samlwriter_set($res, 46, $value , $assertionstatementindex);

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

This property is not available at design time.

Data Type

String

AssertionStatementAuthnSubjectLocalityAddress Property (SecureBlackbox_SAMLWriter Class)

Specifies the authentication subjects address.

Object Oriented Interface

public function getAssertionStatementAuthnSubjectLocalityAddress($assertionstatementindex);


public function setAssertionStatementAuthnSubjectLocalityAddress($assertionstatementindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 47 , $assertionstatementindex);


secureblackbox_samlwriter_set($res, 47, $value , $assertionstatementindex);

Default Value

''

Remarks

Specifies the authentication subjects address.

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

The $assertionstatementindex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionStatementCount property.

This property is not available at design time.

Data Type

String

AssertionStatementAuthnSubjectLocalityDNSName Property (SecureBlackbox_SAMLWriter Class)

Maps to the authentication subjects DNS name parameter.

Object Oriented Interface

public function getAssertionStatementAuthnSubjectLocalityDNSName($assertionstatementindex);


public function setAssertionStatementAuthnSubjectLocalityDNSName($assertionstatementindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 48 , $assertionstatementindex);


secureblackbox_samlwriter_set($res, 48, $value , $assertionstatementindex);

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

This property is not available at design time.

Data Type

String

AssertionStatementAuthzActions Property (SecureBlackbox_SAMLWriter Class)

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

Object Oriented Interface

public function getAssertionStatementAuthzActions($assertionstatementindex);


public function setAssertionStatementAuthzActions($assertionstatementindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 49 , $assertionstatementindex);


secureblackbox_samlwriter_set($res, 49, $value , $assertionstatementindex);

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

This property is not available at design time.

Data Type

String

AssertionStatementAuthzDecision Property (SecureBlackbox_SAMLWriter Class)

Specifies the authorization decision.

Object Oriented Interface

public function getAssertionStatementAuthzDecision($assertionstatementindex);


public function setAssertionStatementAuthzDecision($assertionstatementindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 50 , $assertionstatementindex);


secureblackbox_samlwriter_set($res, 50, $value , $assertionstatementindex);

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

This property is not available at design time.

Data Type

Integer

AssertionStatementAuthzDecisionEvidence Property (SecureBlackbox_SAMLWriter Class)

Manages the authorization decision statement evidence parameter.

Object Oriented Interface

public function getAssertionStatementAuthzDecisionEvidence($assertionstatementindex);


public function setAssertionStatementAuthzDecisionEvidence($assertionstatementindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 51 , $assertionstatementindex);


secureblackbox_samlwriter_set($res, 51, $value , $assertionstatementindex);

Default Value

''

Remarks

Manages the authorization decision statement evidence parameter.

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

The $assertionstatementindex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionStatementCount property.

This property is not available at design time.

Data Type

String

AssertionStatementAuthzDecisionResource Property (SecureBlackbox_SAMLWriter Class)

Specifies the authorization decision statement resource parameter.

Object Oriented Interface

public function getAssertionStatementAuthzDecisionResource($assertionstatementindex);


public function setAssertionStatementAuthzDecisionResource($assertionstatementindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 52 , $assertionstatementindex);


secureblackbox_samlwriter_set($res, 52, $value , $assertionstatementindex);

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

This property is not available at design time.

Data Type

String

AssertionStatementStatementType Property (SecureBlackbox_SAMLWriter Class)

Specifies the assertion statement type.

Object Oriented Interface

public function getAssertionStatementStatementType($assertionstatementindex);


public function setAssertionStatementStatementType($assertionstatementindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 53 , $assertionstatementindex);


secureblackbox_samlwriter_set($res, 53, $value , $assertionstatementindex);

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

This property is not available at design time.

Data Type

Integer

AssertionSubjectConfirmationCount Property (SecureBlackbox_SAMLWriter Class)

The number of records in the AssertionSubjectConfirmation arrays.

Object Oriented Interface

public function getAssertionSubjectConfirmationCount();


public function setAssertionSubjectConfirmationCount($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 54 );


secureblackbox_samlwriter_set($res, 54, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AssertionSubjectConfirmationDataAddress
• AssertionSubjectConfirmationDataInResponseTo
• AssertionSubjectConfirmationDataNotBefore
• AssertionSubjectConfirmationDataNotOnOrAfter
• AssertionSubjectConfirmationDataRecipient
• AssertionSubjectConfirmationDataType
• AssertionSubjectConfirmationID
• AssertionSubjectConfirmationMethod

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

This property is not available at design time.

Data Type

Integer

AssertionSubjectConfirmationDataAddress Property (SecureBlackbox_SAMLWriter Class)

Contains the address enabled for presenting assertions.

Object Oriented Interface

public function getAssertionSubjectConfirmationDataAddress($assertionsubjectconfirmationindex);


public function setAssertionSubjectConfirmationDataAddress($assertionsubjectconfirmationindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 55 , $assertionsubjectconfirmationindex);


secureblackbox_samlwriter_set($res, 55, $value , $assertionsubjectconfirmationindex);

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

This property is not available at design time.

Data Type

String

AssertionSubjectConfirmationDataInResponseTo Property (SecureBlackbox_SAMLWriter Class)

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

Object Oriented Interface

public function getAssertionSubjectConfirmationDataInResponseTo($assertionsubjectconfirmationindex);


public function setAssertionSubjectConfirmationDataInResponseTo($assertionsubjectconfirmationindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 56 , $assertionsubjectconfirmationindex);


secureblackbox_samlwriter_set($res, 56, $value , $assertionsubjectconfirmationindex);

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

This property is not available at design time.

Data Type

String

AssertionSubjectConfirmationDataNotBefore Property (SecureBlackbox_SAMLWriter Class)

Time moment before which the subject cannot be confirmed.

Object Oriented Interface

public function getAssertionSubjectConfirmationDataNotBefore($assertionsubjectconfirmationindex);


public function setAssertionSubjectConfirmationDataNotBefore($assertionsubjectconfirmationindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 57 , $assertionsubjectconfirmationindex);


secureblackbox_samlwriter_set($res, 57, $value , $assertionsubjectconfirmationindex);

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

This property is not available at design time.

Data Type

String

AssertionSubjectConfirmationDataNotOnOrAfter Property (SecureBlackbox_SAMLWriter Class)

Limits the time until which the subject can be confirmed.

Object Oriented Interface

public function getAssertionSubjectConfirmationDataNotOnOrAfter($assertionsubjectconfirmationindex);


public function setAssertionSubjectConfirmationDataNotOnOrAfter($assertionsubjectconfirmationindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 58 , $assertionsubjectconfirmationindex);


secureblackbox_samlwriter_set($res, 58, $value , $assertionsubjectconfirmationindex);

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

This property is not available at design time.

Data Type

String

AssertionSubjectConfirmationDataRecipient Property (SecureBlackbox_SAMLWriter Class)

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

Object Oriented Interface

public function getAssertionSubjectConfirmationDataRecipient($assertionsubjectconfirmationindex);


public function setAssertionSubjectConfirmationDataRecipient($assertionsubjectconfirmationindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 59 , $assertionsubjectconfirmationindex);


secureblackbox_samlwriter_set($res, 59, $value , $assertionsubjectconfirmationindex);

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

This property is not available at design time.

Data Type

String

AssertionSubjectConfirmationDataType Property (SecureBlackbox_SAMLWriter Class)

The type of data contained in the confirmation.

Object Oriented Interface

public function getAssertionSubjectConfirmationDataType($assertionsubjectconfirmationindex);


public function setAssertionSubjectConfirmationDataType($assertionsubjectconfirmationindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 60 , $assertionsubjectconfirmationindex);


secureblackbox_samlwriter_set($res, 60, $value , $assertionsubjectconfirmationindex);

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

This property is not available at design time.

Data Type

String

AssertionSubjectConfirmationID Property (SecureBlackbox_SAMLWriter Class)

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

Object Oriented Interface

public function getAssertionSubjectConfirmationID($assertionsubjectconfirmationindex);


public function setAssertionSubjectConfirmationID($assertionsubjectconfirmationindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 61 , $assertionsubjectconfirmationindex);


secureblackbox_samlwriter_set($res, 61, $value , $assertionsubjectconfirmationindex);

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

This property is not available at design time.

Data Type

String

AssertionSubjectConfirmationMethod Property (SecureBlackbox_SAMLWriter Class)

Specifies the mechanism to be used to confirm the subject.

Object Oriented Interface

public function getAssertionSubjectConfirmationMethod($assertionsubjectconfirmationindex);


public function setAssertionSubjectConfirmationMethod($assertionsubjectconfirmationindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 62 , $assertionsubjectconfirmationindex);


secureblackbox_samlwriter_set($res, 62, $value , $assertionsubjectconfirmationindex);

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

This property is not available at design time.

Data Type

String

AssertionSubjectID Property (SecureBlackbox_SAMLWriter Class)

Specifies the assertion subject ID.

Object Oriented Interface

public function getAssertionSubjectID();


public function setAssertionSubjectID($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 63 );


secureblackbox_samlwriter_set($res, 63, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

AttrQueryAttrCount Property (SecureBlackbox_SAMLWriter Class)

The number of records in the AttrQueryAttr arrays.

Object Oriented Interface

public function getAttrQueryAttrCount();


public function setAttrQueryAttrCount($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 64 );


secureblackbox_samlwriter_set($res, 64, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttrQueryAttrFriendlyName
• AttrQueryAttrName
• AttrQueryAttrNameFormat
• AttrQueryAttrStatementIndex
• AttrQueryAttrValues

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

This property is not available at design time.

Data Type

Integer

AttrQueryAttrFriendlyName Property (SecureBlackbox_SAMLWriter Class)

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

Object Oriented Interface

public function getAttrQueryAttrFriendlyName($attrqueryattrindex);


public function setAttrQueryAttrFriendlyName($attrqueryattrindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 65 , $attrqueryattrindex);


secureblackbox_samlwriter_set($res, 65, $value , $attrqueryattrindex);

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

This property is not available at design time.

Data Type

String

AttrQueryAttrName Property (SecureBlackbox_SAMLWriter Class)

Specifies the name of the attribute.

Object Oriented Interface

public function getAttrQueryAttrName($attrqueryattrindex);


public function setAttrQueryAttrName($attrqueryattrindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 66 , $attrqueryattrindex);


secureblackbox_samlwriter_set($res, 66, $value , $attrqueryattrindex);

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

This property is not available at design time.

Data Type

String

AttrQueryAttrNameFormat Property (SecureBlackbox_SAMLWriter Class)

Indicates the format used to reference the attribute.

Object Oriented Interface

public function getAttrQueryAttrNameFormat($attrqueryattrindex);


public function setAttrQueryAttrNameFormat($attrqueryattrindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 67 , $attrqueryattrindex);


secureblackbox_samlwriter_set($res, 67, $value , $attrqueryattrindex);

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

This property is not available at design time.

Data Type

String

AttrQueryAttrStatementIndex Property (SecureBlackbox_SAMLWriter Class)

Contains the index of the statement the attribute corresponds to.

Object Oriented Interface

public function getAttrQueryAttrStatementIndex($attrqueryattrindex);


public function setAttrQueryAttrStatementIndex($attrqueryattrindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 68 , $attrqueryattrindex);


secureblackbox_samlwriter_set($res, 68, $value , $attrqueryattrindex);

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

This property is not available at design time.

Data Type

Integer

AttrQueryAttrValues Property (SecureBlackbox_SAMLWriter Class)

Contains a list of attribute values.

Object Oriented Interface

public function getAttrQueryAttrValues($attrqueryattrindex);


public function setAttrQueryAttrValues($attrqueryattrindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 69 , $attrqueryattrindex);


secureblackbox_samlwriter_set($res, 69, $value , $attrqueryattrindex);

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

This property is not available at design time.

Data Type

String

AuthnQueryComparison Property (SecureBlackbox_SAMLWriter Class)

Specifies the authentication context comparison method.

Object Oriented Interface

public function getAuthnQueryComparison();


public function setAuthnQueryComparison($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 70 );


secureblackbox_samlwriter_set($res, 70, $value );

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

This property is not available at design time.

Data Type

Integer

AuthnQueryContextClassRefs Property (SecureBlackbox_SAMLWriter Class)

Specifies the context class reference.

Object Oriented Interface

public function getAuthnQueryContextClassRefs();


public function setAuthnQueryContextClassRefs($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 71 );


secureblackbox_samlwriter_set($res, 71, $value );

Default Value

''

Remarks

Specifies the context class reference.

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

This property is not available at design time.

Data Type

String

AuthnQueryRefType Property (SecureBlackbox_SAMLWriter Class)

Specifies the context reference type.

Object Oriented Interface

public function getAuthnQueryRefType();


public function setAuthnQueryRefType($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 72 );


secureblackbox_samlwriter_set($res, 72, $value );

Default Value

0

Remarks

Specifies the context reference type.

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

This property is not available at design time.

Data Type

Integer

AuthnQuerySessionIndex Property (SecureBlackbox_SAMLWriter Class)

Specifies the index of the session to the authentication entity.

Object Oriented Interface

public function getAuthnQuerySessionIndex();


public function setAuthnQuerySessionIndex($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 73 );


secureblackbox_samlwriter_set($res, 73, $value );

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.

This property is not available at design time.

Data Type

String

AuthnRequestAssertionConsumerServiceIndex Property (SecureBlackbox_SAMLWriter Class)

Specifies the assertion consumer service index.

Object Oriented Interface

public function getAuthnRequestAssertionConsumerServiceIndex();


public function setAuthnRequestAssertionConsumerServiceIndex($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 74 );


secureblackbox_samlwriter_set($res, 74, $value );

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.

This property is not available at design time.

Data Type

Integer

AuthnRequestAssertionConsumerServiceURL Property (SecureBlackbox_SAMLWriter Class)

Specifies the assertion consumer service URL.

Object Oriented Interface

public function getAuthnRequestAssertionConsumerServiceURL();


public function setAuthnRequestAssertionConsumerServiceURL($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 75 );


secureblackbox_samlwriter_set($res, 75, $value );

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.

This property is not available at design time.

Data Type

String

AuthnRequestAttributeConsumingServiceIndex Property (SecureBlackbox_SAMLWriter Class)

Specifies the attribute consuming service index.

Object Oriented Interface

public function getAuthnRequestAttributeConsumingServiceIndex();


public function setAuthnRequestAttributeConsumingServiceIndex($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 76 );


secureblackbox_samlwriter_set($res, 76, $value );

Default Value

0

Remarks

Specifies the attribute consuming service index.

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

This property is not available at design time.

Data Type

Integer

AuthnRequestConditionsNotBefore Property (SecureBlackbox_SAMLWriter Class)

Specifies the NotBefore condition of the request.

Object Oriented Interface

public function getAuthnRequestConditionsNotBefore();


public function setAuthnRequestConditionsNotBefore($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 77 );


secureblackbox_samlwriter_set($res, 77, $value );

Default Value

''

Remarks

Specifies the NotBefore condition of the request.

Use this property to access or set the NotBefore condition of the request.

This property is not available at design time.

Data Type

String

AuthnRequestConditionsNotOnOrAfter Property (SecureBlackbox_SAMLWriter Class)

Provides access to the NotOnOrAfter condition of the request.

Object Oriented Interface

public function getAuthnRequestConditionsNotOnOrAfter();


public function setAuthnRequestConditionsNotOnOrAfter($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 78 );


secureblackbox_samlwriter_set($res, 78, $value );

Default Value

''

Remarks

Provides access to the NotOnOrAfter condition of the request.

Use this property to access or set the NotOnOrAfter condition of the request.

This property is not available at design time.

Data Type

String

AuthnRequestContextClassRefs Property (SecureBlackbox_SAMLWriter Class)

Provides access to the authentication context class references.

Object Oriented Interface

public function getAuthnRequestContextClassRefs();


public function setAuthnRequestContextClassRefs($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 79 );


secureblackbox_samlwriter_set($res, 79, $value );

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.

This property is not available at design time.

Data Type

String

AuthnRequestContextComparison Property (SecureBlackbox_SAMLWriter Class)

Specifies the AuthnContext comparison method.

Object Oriented Interface

public function getAuthnRequestContextComparison();


public function setAuthnRequestContextComparison($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 80 );


secureblackbox_samlwriter_set($res, 80, $value );

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

This property is not available at design time.

Data Type

Integer

AuthnRequestContextRefType Property (SecureBlackbox_SAMLWriter Class)

Specifies the context reference type.

Object Oriented Interface

public function getAuthnRequestContextRefType();


public function setAuthnRequestContextRefType($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 81 );


secureblackbox_samlwriter_set($res, 81, $value );

Default Value

0

Remarks

Specifies the context reference type.

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

This property is not available at design time.

Data Type

Integer

AuthnRequestForceAuthn Property (SecureBlackbox_SAMLWriter Class)

Corresponds to the ForceAuthn parameter of the request.

Object Oriented Interface

public function getAuthnRequestForceAuthn();


public function setAuthnRequestForceAuthn($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 82 );


secureblackbox_samlwriter_set($res, 82, $value );

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.

This property is not available at design time.

Data Type

Boolean

AuthnRequestIsPassive Property (SecureBlackbox_SAMLWriter Class)

Maps to the IsPassive parameter of the request.

Object Oriented Interface

public function getAuthnRequestIsPassive();


public function setAuthnRequestIsPassive($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 83 );


secureblackbox_samlwriter_set($res, 83, $value );

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.

This property is not available at design time.

Data Type

Boolean

AuthnRequestNameIDPolicyAllowCreate Property (SecureBlackbox_SAMLWriter Class)

Matches the AllowCreate attribute of NameIDPolicy element of the request.

Object Oriented Interface

public function getAuthnRequestNameIDPolicyAllowCreate();


public function setAuthnRequestNameIDPolicyAllowCreate($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 84 );


secureblackbox_samlwriter_set($res, 84, $value );

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.

This property is not available at design time.

Data Type

Boolean

AuthnRequestNameIDPolicyFormat Property (SecureBlackbox_SAMLWriter Class)

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

Object Oriented Interface

public function getAuthnRequestNameIDPolicyFormat();


public function setAuthnRequestNameIDPolicyFormat($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 85 );


secureblackbox_samlwriter_set($res, 85, $value );

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.

This property is not available at design time.

Data Type

String

AuthnRequestNameIDPolicySPNameQualifier Property (SecureBlackbox_SAMLWriter Class)

Matches to the SP name qualifier attribute of the request.

Object Oriented Interface

public function getAuthnRequestNameIDPolicySPNameQualifier();


public function setAuthnRequestNameIDPolicySPNameQualifier($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 86 );


secureblackbox_samlwriter_set($res, 86, $value );

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.

This property is not available at design time.

Data Type

String

AuthnRequestNameIDPolicyUseAllowCreate Property (SecureBlackbox_SAMLWriter Class)

Controls inclusion of AllowCreate attribute in the request.

Object Oriented Interface

public function getAuthnRequestNameIDPolicyUseAllowCreate();


public function setAuthnRequestNameIDPolicyUseAllowCreate($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 87 );


secureblackbox_samlwriter_set($res, 87, $value );

Default Value

false

Remarks

Controls inclusion of AllowCreate attribute in the request.

Use this property to check or specify whether the AllowCreate attribute is included in the authentication request.

This property is not available at design time.

Data Type

Boolean

AuthnRequestProtocolBinding Property (SecureBlackbox_SAMLWriter Class)

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

Object Oriented Interface

public function getAuthnRequestProtocolBinding();


public function setAuthnRequestProtocolBinding($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 88 );


secureblackbox_samlwriter_set($res, 88, $value );

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.

This property is not available at design time.

Data Type

String

AuthnRequestProviderName Property (SecureBlackbox_SAMLWriter Class)

Specifies the name of the requestor.

Object Oriented Interface

public function getAuthnRequestProviderName();


public function setAuthnRequestProviderName($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 89 );


secureblackbox_samlwriter_set($res, 89, $value );

Default Value

''

Remarks

Specifies the name of the requestor.

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

This property is not available at design time.

Data Type

String

AuthnRequestScopingIDPListGetComplete Property (SecureBlackbox_SAMLWriter Class)

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

Object Oriented Interface

public function getAuthnRequestScopingIDPListGetComplete();


public function setAuthnRequestScopingIDPListGetComplete($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 90 );


secureblackbox_samlwriter_set($res, 90, $value );

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.

This property is not available at design time.

Data Type

String

AuthnRequestScopingProxyCount Property (SecureBlackbox_SAMLWriter Class)

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

Object Oriented Interface

public function getAuthnRequestScopingProxyCount();


public function setAuthnRequestScopingProxyCount($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 91 );


secureblackbox_samlwriter_set($res, 91, $value );

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.

This property is not available at design time.

Data Type

Integer

AuthnRequestScopingRequesterIDs Property (SecureBlackbox_SAMLWriter Class)

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

Object Oriented Interface

public function getAuthnRequestScopingRequesterIDs();


public function setAuthnRequestScopingRequesterIDs($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 92 );


secureblackbox_samlwriter_set($res, 92, $value );

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.

This property is not available at design time.

Data Type

String

AuthnRequestUseForceAuthn Property (SecureBlackbox_SAMLWriter Class)

Controls inclusion of ForceAuthn attribute in the request.

Object Oriented Interface

public function getAuthnRequestUseForceAuthn();


public function setAuthnRequestUseForceAuthn($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 93 );


secureblackbox_samlwriter_set($res, 93, $value );

Default Value

false

Remarks

Controls inclusion of ForceAuthn attribute in the request.

Use this property to check or enable presence of the ForceAuthn attribute in the authentication request. Set this property to false to suppress inclusion of the attribute.

This property is not available at design time.

Data Type

Boolean

AuthnRequestUseIsPassive Property (SecureBlackbox_SAMLWriter Class)

Controls inclusion of IsPassive attribute in the request.

Object Oriented Interface

public function getAuthnRequestUseIsPassive();


public function setAuthnRequestUseIsPassive($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 94 );


secureblackbox_samlwriter_set($res, 94, $value );

Default Value

false

Remarks

Controls inclusion of IsPassive attribute in the request.

Use this property to check or enable presence of the IsPassive attribute in the authentication request. Set this property to false to suppress inclusion of the attribute.

This property is not available at design time.

Data Type

Boolean

AuthnRequestConditionCount Property (SecureBlackbox_SAMLWriter Class)

The number of records in the AuthnRequestCondition arrays.

Object Oriented Interface

public function getAuthnRequestConditionCount();


public function setAuthnRequestConditionCount($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 95 );


secureblackbox_samlwriter_set($res, 95, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AuthnRequestConditionAudienceList
• AuthnRequestConditionConditionType
• AuthnRequestConditionProxyRestrictionCount
• AuthnRequestConditionsNotBefore
• AuthnRequestConditionsNotOnOrAfter

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

This property is not available at design time.

Data Type

Integer

AuthnRequestConditionAudienceList Property (SecureBlackbox_SAMLWriter Class)

An accessor to the Audience list parameter of an audience restriction condition.

Object Oriented Interface

public function getAuthnRequestConditionAudienceList($authnrequestconditionindex);


public function setAuthnRequestConditionAudienceList($authnrequestconditionindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 96 , $authnrequestconditionindex);


secureblackbox_samlwriter_set($res, 96, $value , $authnrequestconditionindex);

Default Value

''

Remarks

An accessor to the Audience list parameter of an audience restriction condition.

Use this property to 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.

The $authnrequestconditionindex parameter specifies the index of the item in the array. The size of the array is controlled by the AuthnRequestConditionCount property.

This property is not available at design time.

Data Type

String

AuthnRequestConditionConditionType Property (SecureBlackbox_SAMLWriter Class)

Specifies a type of the condition object.

Object Oriented Interface

public function getAuthnRequestConditionConditionType($authnrequestconditionindex);


public function setAuthnRequestConditionConditionType($authnrequestconditionindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 97 , $authnrequestconditionindex);


secureblackbox_samlwriter_set($res, 97, $value , $authnrequestconditionindex);

Default Value

0

Remarks

Specifies a type of the condition object.

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

The $authnrequestconditionindex parameter specifies the index of the item in the array. The size of the array is controlled by the AuthnRequestConditionCount property.

This property is not available at design time.

Data Type

Integer

AuthnRequestConditionProxyRestrictionCount Property (SecureBlackbox_SAMLWriter Class)

An accessor to the proxy restriction count element of the condition.

Object Oriented Interface

public function getAuthnRequestConditionProxyRestrictionCount($authnrequestconditionindex);


public function setAuthnRequestConditionProxyRestrictionCount($authnrequestconditionindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 98 , $authnrequestconditionindex);


secureblackbox_samlwriter_set($res, 98, $value , $authnrequestconditionindex);

Default Value

0

Remarks

An accessor to the proxy restriction count element of the condition.

Use this setting to access or set the value of the proxy restriction count condition.

The $authnrequestconditionindex parameter specifies the index of the item in the array. The size of the array is controlled by the AuthnRequestConditionCount property.

This property is not available at design time.

Data Type

Integer

AuthnRequestScopingIDPCount Property (SecureBlackbox_SAMLWriter Class)

The number of records in the AuthnRequestScopingIDP arrays.

Object Oriented Interface

public function getAuthnRequestScopingIDPCount();


public function setAuthnRequestScopingIDPCount($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 99 );


secureblackbox_samlwriter_set($res, 99, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AuthnRequestScopingIDPListGetComplete
• AuthnRequestScopingIDPLoc
• AuthnRequestScopingIDPName
• AuthnRequestScopingIDPProviderID

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

This property is not available at design time.

Data Type

Integer

AuthnRequestScopingIDPLoc Property (SecureBlackbox_SAMLWriter Class)

Contains the value of the Loc attribute.

Object Oriented Interface

public function getAuthnRequestScopingIDPLoc($authnrequestscopingidpindex);


public function setAuthnRequestScopingIDPLoc($authnrequestscopingidpindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 100 , $authnrequestscopingidpindex);


secureblackbox_samlwriter_set($res, 100, $value , $authnrequestscopingidpindex);

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

This property is not available at design time.

Data Type

String

AuthnRequestScopingIDPName Property (SecureBlackbox_SAMLWriter Class)

Contains the name of the IdP provider.

Object Oriented Interface

public function getAuthnRequestScopingIDPName($authnrequestscopingidpindex);


public function setAuthnRequestScopingIDPName($authnrequestscopingidpindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 101 , $authnrequestscopingidpindex);


secureblackbox_samlwriter_set($res, 101, $value , $authnrequestscopingidpindex);

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

This property is not available at design time.

Data Type

String

AuthnRequestScopingIDPProviderID Property (SecureBlackbox_SAMLWriter Class)

Contains the provider ID.

Object Oriented Interface

public function getAuthnRequestScopingIDPProviderID($authnrequestscopingidpindex);


public function setAuthnRequestScopingIDPProviderID($authnrequestscopingidpindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 102 , $authnrequestscopingidpindex);


secureblackbox_samlwriter_set($res, 102, $value , $authnrequestscopingidpindex);

Default Value

''

Remarks

Contains the provider ID.

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

The $authnrequestscopingidpindex parameter specifies the index of the item in the array. The size of the array is controlled by the AuthnRequestScopingIDPCount property.

This property is not available at design time.

Data Type

String

AuthzDecisionQueryActions Property (SecureBlackbox_SAMLWriter Class)

Specifies the list of actions included in the query.

Object Oriented Interface

public function getAuthzDecisionQueryActions();


public function setAuthzDecisionQueryActions($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 103 );


secureblackbox_samlwriter_set($res, 103, $value );

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.

This property is not available at design time.

Data Type

String

AuthzDecisionQueryResource Property (SecureBlackbox_SAMLWriter Class)

Matches the Resource element of the query.

Object Oriented Interface

public function getAuthzDecisionQueryResource();


public function setAuthzDecisionQueryResource($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 104 );


secureblackbox_samlwriter_set($res, 104, $value );

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.

This property is not available at design time.

Data Type

String

Binding Property (SecureBlackbox_SAMLWriter Class)

Specifies the type of the binding to use.

Object Oriented Interface

public function getBinding();


public function setBinding($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 105 );


secureblackbox_samlwriter_set($res, 105, $value );

Default Value

0

Remarks

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

Data Type

Integer

Consent Property (SecureBlackbox_SAMLWriter Class)

Contains the Consent parameter of the request.

Object Oriented Interface

public function getConsent();


public function setConsent($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 106 );


secureblackbox_samlwriter_set($res, 106, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

Destination Property (SecureBlackbox_SAMLWriter Class)

Contains the Destination parameter of the SAML object.

Object Oriented Interface

public function getDestination();


public function setDestination($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 107 );


secureblackbox_samlwriter_set($res, 107, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

EncryptionCertBytes Property (SecureBlackbox_SAMLWriter Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getEncryptionCertBytes();

Procedural Interface

secureblackbox_samlwriter_get($res, 108 );

Remarks

Returns the raw certificate data in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

EncryptionCertHandle Property (SecureBlackbox_SAMLWriter Class)

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

Object Oriented Interface

public function getEncryptionCertHandle();


public function setEncryptionCertHandle($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 115 );


secureblackbox_samlwriter_set($res, 115, $value );

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());

This property is not available at design time.

Data Type

Long64

FIPSMode Property (SecureBlackbox_SAMLWriter Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 142 );


secureblackbox_samlwriter_set($res, 142, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

ID Property (SecureBlackbox_SAMLWriter Class)

The ID of the request.

Object Oriented Interface

public function getID();


public function setID($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 143 );


secureblackbox_samlwriter_set($res, 143, $value );

Default Value

''

Remarks

Use this property to specify the ID of the request.

This property is not available at design time.

Data Type

String

InResponseTo Property (SecureBlackbox_SAMLWriter Class)

Contains the InResponseTo property of the SAML request.

Object Oriented Interface

public function getInResponseTo();


public function setInResponseTo($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 144 );


secureblackbox_samlwriter_set($res, 144, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

IssueInstant Property (SecureBlackbox_SAMLWriter Class)

Contains request issuance timestamp.

Object Oriented Interface

public function getIssueInstant();


public function setIssueInstant($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 145 );


secureblackbox_samlwriter_set($res, 145, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

Issuer Property (SecureBlackbox_SAMLWriter Class)

Sets the issuer of the message.

Object Oriented Interface

public function getIssuer();


public function setIssuer($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 146 );


secureblackbox_samlwriter_set($res, 146, $value );

Default Value

''

Remarks

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.Issuer = "Value=https://saml.entity.org/resource;Format=urn:oasis:names:tc:SAML:2.0:nameid-format:entity;IDType=Issuer";

This property is not available at design time.

Data Type

String

LogoutRequestNameID Property (SecureBlackbox_SAMLWriter Class)

Contains the value of the NameID parameter.

Object Oriented Interface

public function getLogoutRequestNameID();


public function setLogoutRequestNameID($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 147 );


secureblackbox_samlwriter_set($res, 147, $value );

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.

This property is not available at design time.

Data Type

String

LogoutRequestNotOnOrAfter Property (SecureBlackbox_SAMLWriter Class)

Contains the value of the NotOnOrAfter parameter.

Object Oriented Interface

public function getLogoutRequestNotOnOrAfter();


public function setLogoutRequestNotOnOrAfter($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 148 );


secureblackbox_samlwriter_set($res, 148, $value );

Default Value

''

Remarks

Contains the value of the NotOnOrAfter parameter.

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

This property is not available at design time.

Data Type

String

LogoutRequestReason Property (SecureBlackbox_SAMLWriter Class)

Contains the value of the Reason parameter.

Object Oriented Interface

public function getLogoutRequestReason();


public function setLogoutRequestReason($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 149 );


secureblackbox_samlwriter_set($res, 149, $value );

Default Value

''

Remarks

Contains the value of the Reason parameter.

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

This property is not available at design time.

Data Type

String

LogoutRequestSessionIndexes Property (SecureBlackbox_SAMLWriter Class)

Contains the list of session indices.

Object Oriented Interface

public function getLogoutRequestSessionIndexes();


public function setLogoutRequestSessionIndexes($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 150 );


secureblackbox_samlwriter_set($res, 150, $value );

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.

This property is not available at design time.

Data Type

String

ManageNameIDRequestNameID Property (SecureBlackbox_SAMLWriter Class)

Contains the value of the NameID parameter of the request.

Object Oriented Interface

public function getManageNameIDRequestNameID();


public function setManageNameIDRequestNameID($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 151 );


secureblackbox_samlwriter_set($res, 151, $value );

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.

This property is not available at design time.

Data Type

String

ManageNameIDRequestNewEncryptedID Property (SecureBlackbox_SAMLWriter Class)

Contains the value of the NewEncryptedID parameter of the request.

Object Oriented Interface

public function getManageNameIDRequestNewEncryptedID();


public function setManageNameIDRequestNewEncryptedID($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 152 );


secureblackbox_samlwriter_set($res, 152, $value );

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.

This property is not available at design time.

Data Type

String

ManageNameIDRequestNewID Property (SecureBlackbox_SAMLWriter Class)

Contains the value of the NewID parameter.

Object Oriented Interface

public function getManageNameIDRequestNewID();


public function setManageNameIDRequestNewID($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 153 );


secureblackbox_samlwriter_set($res, 153, $value );

Default Value

''

Remarks

Contains the value of the NewID parameter.

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

This property is not available at design time.

Data Type

String

ManageNameIDRequestTerminate Property (SecureBlackbox_SAMLWriter Class)

Contains the value of the Terminate parameter of the request.

Object Oriented Interface

public function getManageNameIDRequestTerminate();


public function setManageNameIDRequestTerminate($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 154 );


secureblackbox_samlwriter_set($res, 154, $value );

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.

This property is not available at design time.

Data Type

String

NameIDMappingRequestNameID Property (SecureBlackbox_SAMLWriter Class)

An accessor to the NameID parameter of the request.

Object Oriented Interface

public function getNameIDMappingRequestNameID();


public function setNameIDMappingRequestNameID($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 155 );


secureblackbox_samlwriter_set($res, 155, $value );

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.

This property is not available at design time.

Data Type

String

NameIDMappingRequestNameIDPolicyAllowCreate Property (SecureBlackbox_SAMLWriter Class)

Contains the value of AllowCreate parameter of the NameIDPolicy object.

Object Oriented Interface

public function getNameIDMappingRequestNameIDPolicyAllowCreate();


public function setNameIDMappingRequestNameIDPolicyAllowCreate($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 156 );


secureblackbox_samlwriter_set($res, 156, $value );

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.

This property is not available at design time.

Data Type

Boolean

NameIDMappingRequestNameIDPolicyFormat Property (SecureBlackbox_SAMLWriter Class)

Specifies the format of the NameIDPolicy element.

Object Oriented Interface

public function getNameIDMappingRequestNameIDPolicyFormat();


public function setNameIDMappingRequestNameIDPolicyFormat($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 157 );


secureblackbox_samlwriter_set($res, 157, $value );

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.

This property is not available at design time.

Data Type

String

NameIDMappingRequestNameIDPolicySPNameQualifier Property (SecureBlackbox_SAMLWriter Class)

Contains the SPNameQualifier parameter of the NameIDPolicy element.

Object Oriented Interface

public function getNameIDMappingRequestNameIDPolicySPNameQualifier();


public function setNameIDMappingRequestNameIDPolicySPNameQualifier($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 158 );


secureblackbox_samlwriter_set($res, 158, $value );

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.

This property is not available at design time.

Data Type

String

NameIDMappingRequestNameIDPolicyUseAllowCreate Property (SecureBlackbox_SAMLWriter Class)

Controls inclusion of UseAllow modifier in the NameIDPolicy object.

Object Oriented Interface

public function getNameIDMappingRequestNameIDPolicyUseAllowCreate();


public function setNameIDMappingRequestNameIDPolicyUseAllowCreate($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 159 );


secureblackbox_samlwriter_set($res, 159, $value );

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.

This property is not available at design time.

Data Type

Boolean

OutputType Property (SecureBlackbox_SAMLWriter Class)

Returns the SAML type of message being created.

Object Oriented Interface

public function getOutputType();

Procedural Interface

secureblackbox_samlwriter_get($res, 160 );

Default Value

0

Remarks

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

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

This property is read-only and not available at design time.

Data Type

Integer

POSTBindingBody Property (SecureBlackbox_SAMLWriter Class)

Contains the form body.

Object Oriented Interface

public function getPOSTBindingBody();


public function setPOSTBindingBody($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 161 );


secureblackbox_samlwriter_set($res, 161, $value );

Default Value

''

Remarks

Contains the form body.

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

This property is not available at design time.

Data Type

String

POSTBindingFormTemplate Property (SecureBlackbox_SAMLWriter Class)

Contains the XHTML form template returned by the service provider.

Object Oriented Interface

public function getPOSTBindingFormTemplate();


public function setPOSTBindingFormTemplate($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 162 );


secureblackbox_samlwriter_set($res, 162, $value );

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.

This property is not available at design time.

Data Type

String

POSTBindingMode Property (SecureBlackbox_SAMLWriter Class)

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

Object Oriented Interface

public function getPOSTBindingMode();


public function setPOSTBindingMode($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 163 );


secureblackbox_samlwriter_set($res, 163, $value );

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

POSTBindingRelayState Property (SecureBlackbox_SAMLWriter Class)

Contains the value of the RelayState parameter of POST binding mechanism.

Object Oriented Interface

public function getPOSTBindingRelayState();


public function setPOSTBindingRelayState($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 164 );


secureblackbox_samlwriter_set($res, 164, $value );

Default Value

''

Remarks

Contains the value of the RelayState parameter of POST binding mechanism.

Use this property to read or set the value of the RelayState parameter of the POST binding. RelayState contains an uninterpreted service-provider-originating state object, which should be passed back to it with any further requests.

This property is not available at design time.

Data Type

String

POSTBindingURL Property (SecureBlackbox_SAMLWriter Class)

Contains the URL of POST binding mechanism.

Object Oriented Interface

public function getPOSTBindingURL();


public function setPOSTBindingURL($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 165 );


secureblackbox_samlwriter_set($res, 165, $value );

Default Value

''

Remarks

Contains the URL of POST binding mechanism.

Use this property to check or set the URL of POST binding mechanism.

This property is not available at design time.

Data Type

String

Profile Property (SecureBlackbox_SAMLWriter Class)

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

Object Oriented Interface

public function getProfile();


public function setProfile($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 166 );


secureblackbox_samlwriter_set($res, 166, $value );

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

RedirectBindingEncoding Property (SecureBlackbox_SAMLWriter Class)

Specifies the message encoding.

Object Oriented Interface

public function getRedirectBindingEncoding();


public function setRedirectBindingEncoding($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 167 );


secureblackbox_samlwriter_set($res, 167, $value );

Default Value

''

Remarks

Specifies the message encoding.

Use this property to access or set the message encoding.

This property is not available at design time.

Data Type

String

RedirectBindingForceSign Property (SecureBlackbox_SAMLWriter Class)

Enforces a signature over all outgoing messages.

Object Oriented Interface

public function getRedirectBindingForceSign();


public function setRedirectBindingForceSign($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 168 );


secureblackbox_samlwriter_set($res, 168, $value );

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

This property is not available at design time.

Data Type

Boolean

RedirectBindingRelayState Property (SecureBlackbox_SAMLWriter Class)

Contains the RelayState parameter of the binding.

Object Oriented Interface

public function getRedirectBindingRelayState();


public function setRedirectBindingRelayState($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 169 );


secureblackbox_samlwriter_set($res, 169, $value );

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.

This property is not available at design time.

Data Type

String

RedirectBindingSign Property (SecureBlackbox_SAMLWriter Class)

Specifies whether to sign generated messages.

Object Oriented Interface

public function getRedirectBindingSign();


public function setRedirectBindingSign($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 170 );


secureblackbox_samlwriter_set($res, 170, $value );

Default Value

false

Remarks

Specifies whether to sign generated messages.

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 RedirectBindingForceSign property to enforce signatures on all binding entities.

This property is not available at design time.

Data Type

Boolean

RedirectBindingSignatureAlgorithm Property (SecureBlackbox_SAMLWriter Class)

Contains the signature algorithm.

Object Oriented Interface

public function getRedirectBindingSignatureAlgorithm();


public function setRedirectBindingSignatureAlgorithm($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 171 );


secureblackbox_samlwriter_set($res, 171, $value );

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.

This property is not available at design time.

Data Type

String

RedirectBindingURL Property (SecureBlackbox_SAMLWriter Class)

Contains the URL of the request query.

Object Oriented Interface

public function getRedirectBindingURL();


public function setRedirectBindingURL($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 172 );


secureblackbox_samlwriter_set($res, 172, $value );

Default Value

''

Remarks

Contains the URL of the request query.

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

This property is not available at design time.

Data Type

String

RedirectBindingVerifySignatures Property (SecureBlackbox_SAMLWriter Class)

Instructs the class whether to verify incoming signatures.

Object Oriented Interface

public function getRedirectBindingVerifySignatures();


public function setRedirectBindingVerifySignatures($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 173 );


secureblackbox_samlwriter_set($res, 173, $value );

Default Value

false

Remarks

Instructs the component whether to verify incoming signatures.

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

This property is not available at design time.

Data Type

Boolean

RedirectBindingCertBytes Property (SecureBlackbox_SAMLWriter Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getRedirectBindingCertBytes();

Procedural Interface

secureblackbox_samlwriter_get($res, 174 );

Remarks

Returns the raw certificate data in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

RedirectBindingCertHandle Property (SecureBlackbox_SAMLWriter Class)

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

Object Oriented Interface

public function getRedirectBindingCertHandle();


public function setRedirectBindingCertHandle($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 181 );


secureblackbox_samlwriter_set($res, 181, $value );

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());

This property is not available at design time.

Data Type

Long64

ResponseNameID Property (SecureBlackbox_SAMLWriter Class)

Contains the NameID parameter of a NameIDMapping response.

Object Oriented Interface

public function getResponseNameID();


public function setResponseNameID($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 208 );


secureblackbox_samlwriter_set($res, 208, $value );

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.

This property is not available at design time.

Data Type

String

ResponseOptionalElement Property (SecureBlackbox_SAMLWriter Class)

An optional message element to be returned with the response.

Object Oriented Interface

public function getResponseOptionalElement();


public function setResponseOptionalElement($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 209 );


secureblackbox_samlwriter_set($res, 209, $value );

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.

This property is not available at design time.

Data Type

String

ResponseResponseType Property (SecureBlackbox_SAMLWriter Class)

Contains the type of the response.

Object Oriented Interface

public function getResponseResponseType();


public function setResponseResponseType($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 210 );


secureblackbox_samlwriter_set($res, 210, $value );

Default Value

0

Remarks

Contains the type of the response.

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

This property is not available at design time.

Data Type

Integer

ResponseStatusCodeSubValue Property (SecureBlackbox_SAMLWriter Class)

The value of the nested StatusCode.

Object Oriented Interface

public function getResponseStatusCodeSubValue();


public function setResponseStatusCodeSubValue($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 211 );


secureblackbox_samlwriter_set($res, 211, $value );

Default Value

''

Remarks

The value of the nested StatusCode.

This property contains the value of the nested StatusCode element.

This property is not available at design time.

Data Type

String

ResponseStatusCodeValue Property (SecureBlackbox_SAMLWriter Class)

Contains the status code value.

Object Oriented Interface

public function getResponseStatusCodeValue();


public function setResponseStatusCodeValue($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 212 );


secureblackbox_samlwriter_set($res, 212, $value );

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

This property is not available at design time.

Data Type

String

ResponseStatusDetail Property (SecureBlackbox_SAMLWriter Class)

Contains additional information on the status of the request.

Object Oriented Interface

public function getResponseStatusDetail();


public function setResponseStatusDetail($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 213 );


secureblackbox_samlwriter_set($res, 213, $value );

Default Value

''

Remarks

Contains additional information on the status of the request.

The StatusDetail element contains additional request status information.

This property is not available at design time.

Data Type

String

ResponseStatusMessage Property (SecureBlackbox_SAMLWriter Class)

Contains a status message (optional).

Object Oriented Interface

public function getResponseStatusMessage();


public function setResponseStatusMessage($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 214 );


secureblackbox_samlwriter_set($res, 214, $value );

Default Value

''

Remarks

Contains a status message (optional).

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

This property is not available at design time.

Data Type

String

SigCanonicalizationMethod Property (SecureBlackbox_SAMLWriter Class)

The canonicalization method to use in the signature.

Object Oriented Interface

public function getSigCanonicalizationMethod();


public function setSigCanonicalizationMethod($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 215 );


secureblackbox_samlwriter_set($res, 215, $value );

Default Value

''

Remarks

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

Data Type

String

SigDigestMethod Property (SecureBlackbox_SAMLWriter Class)

The digest method to use.

Object Oriented Interface

public function getSigDigestMethod();


public function setSigDigestMethod($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 216 );


secureblackbox_samlwriter_set($res, 216, $value );

Default Value

''

Remarks

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

SigMethod Property (SecureBlackbox_SAMLWriter Class)

The signature method to use.

Object Oriented Interface

public function getSigMethod();


public function setSigMethod($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 217 );


secureblackbox_samlwriter_set($res, 217, $value );

Default Value

''

Remarks

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

Sign Property (SecureBlackbox_SAMLWriter Class)

Specifies whether the created SAML message should be signed.

Object Oriented Interface

public function getSign();


public function setSign($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 218 );


secureblackbox_samlwriter_set($res, 218, $value );

Default Value

false

Remarks

Set this property to true to indicate that you want the created message to be signed.

This property is not available at design time.

Data Type

Boolean

SigningCertBytes Property (SecureBlackbox_SAMLWriter Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSigningCertBytes();

Procedural Interface

secureblackbox_samlwriter_get($res, 219 );

Remarks

Returns the raw certificate data in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertHandle Property (SecureBlackbox_SAMLWriter Class)

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

Object Oriented Interface

public function getSigningCertHandle();


public function setSigningCertHandle($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 226 );


secureblackbox_samlwriter_set($res, 226, $value );

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());

This property is not available at design time.

Data Type

Long64

SigningChainCount Property (SecureBlackbox_SAMLWriter Class)

The number of records in the SigningChain arrays.

Object Oriented Interface

public function getSigningChainCount();


public function setSigningChainCount($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 253 );


secureblackbox_samlwriter_set($res, 253, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SigningChainBytes
• SigningChainHandle

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

This property is not available at design time.

Data Type

Integer

SigningChainBytes Property (SecureBlackbox_SAMLWriter Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSigningChainBytes($signingchainindex);

Procedural Interface

secureblackbox_samlwriter_get($res, 254 , $signingchainindex);

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 and not available at design time.

Data Type

Byte Array

SigningChainHandle Property (SecureBlackbox_SAMLWriter Class)

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

Object Oriented Interface

public function getSigningChainHandle($signingchainindex);


public function setSigningChainHandle($signingchainindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 261 , $signingchainindex);


secureblackbox_samlwriter_set($res, 261, $value , $signingchainindex);

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.

This property is not available at design time.

Data Type

Long64

SubjectConfirmationCount Property (SecureBlackbox_SAMLWriter Class)

The number of records in the SubjectConfirmation arrays.

Object Oriented Interface

public function getSubjectConfirmationCount();


public function setSubjectConfirmationCount($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 288 );


secureblackbox_samlwriter_set($res, 288, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SubjectConfirmationDataAddress
• SubjectConfirmationDataInResponseTo
• SubjectConfirmationDataNotBefore
• SubjectConfirmationDataNotOnOrAfter
• SubjectConfirmationDataRecipient
• SubjectConfirmationDataType
• SubjectConfirmationID
• SubjectConfirmationMethod

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

This property is not available at design time.

Data Type

Integer

SubjectConfirmationDataAddress Property (SecureBlackbox_SAMLWriter Class)

Contains the address enabled for presenting assertions.

Object Oriented Interface

public function getSubjectConfirmationDataAddress($subjectconfirmationindex);


public function setSubjectConfirmationDataAddress($subjectconfirmationindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 289 , $subjectconfirmationindex);


secureblackbox_samlwriter_set($res, 289, $value , $subjectconfirmationindex);

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.

This property is not available at design time.

Data Type

String

SubjectConfirmationDataInResponseTo Property (SecureBlackbox_SAMLWriter Class)

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

Object Oriented Interface

public function getSubjectConfirmationDataInResponseTo($subjectconfirmationindex);


public function setSubjectConfirmationDataInResponseTo($subjectconfirmationindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 290 , $subjectconfirmationindex);


secureblackbox_samlwriter_set($res, 290, $value , $subjectconfirmationindex);

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.

This property is not available at design time.

Data Type

String

SubjectConfirmationDataNotBefore Property (SecureBlackbox_SAMLWriter Class)

Time moment before which the subject cannot be confirmed.

Object Oriented Interface

public function getSubjectConfirmationDataNotBefore($subjectconfirmationindex);


public function setSubjectConfirmationDataNotBefore($subjectconfirmationindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 291 , $subjectconfirmationindex);


secureblackbox_samlwriter_set($res, 291, $value , $subjectconfirmationindex);

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.

This property is not available at design time.

Data Type

String

SubjectConfirmationDataNotOnOrAfter Property (SecureBlackbox_SAMLWriter Class)

Limits the time until which the subject can be confirmed.

Object Oriented Interface

public function getSubjectConfirmationDataNotOnOrAfter($subjectconfirmationindex);


public function setSubjectConfirmationDataNotOnOrAfter($subjectconfirmationindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 292 , $subjectconfirmationindex);


secureblackbox_samlwriter_set($res, 292, $value , $subjectconfirmationindex);

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.

This property is not available at design time.

Data Type

String

SubjectConfirmationDataRecipient Property (SecureBlackbox_SAMLWriter Class)

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

Object Oriented Interface

public function getSubjectConfirmationDataRecipient($subjectconfirmationindex);


public function setSubjectConfirmationDataRecipient($subjectconfirmationindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 293 , $subjectconfirmationindex);


secureblackbox_samlwriter_set($res, 293, $value , $subjectconfirmationindex);

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.

This property is not available at design time.

Data Type

String

SubjectConfirmationDataType Property (SecureBlackbox_SAMLWriter Class)

The type of data contained in the confirmation.

Object Oriented Interface

public function getSubjectConfirmationDataType($subjectconfirmationindex);


public function setSubjectConfirmationDataType($subjectconfirmationindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 294 , $subjectconfirmationindex);


secureblackbox_samlwriter_set($res, 294, $value , $subjectconfirmationindex);

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.

This property is not available at design time.

Data Type

String

SubjectConfirmationID Property (SecureBlackbox_SAMLWriter Class)

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

Object Oriented Interface

public function getSubjectConfirmationID($subjectconfirmationindex);


public function setSubjectConfirmationID($subjectconfirmationindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 295 , $subjectconfirmationindex);


secureblackbox_samlwriter_set($res, 295, $value , $subjectconfirmationindex);

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.

This property is not available at design time.

Data Type

String

SubjectConfirmationMethod Property (SecureBlackbox_SAMLWriter Class)

Specifies the mechanism to be used to confirm the subject.

Object Oriented Interface

public function getSubjectConfirmationMethod($subjectconfirmationindex);


public function setSubjectConfirmationMethod($subjectconfirmationindex, $value);

Procedural Interface

secureblackbox_samlwriter_get($res, 296 , $subjectconfirmationindex);


secureblackbox_samlwriter_set($res, 296, $value , $subjectconfirmationindex);

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.

This property is not available at design time.

Data Type

String

SubjectID Property (SecureBlackbox_SAMLWriter Class)

Sets the subject of the message.

Object Oriented Interface

public function getSubjectID();


public function setSubjectID($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 297 );


secureblackbox_samlwriter_set($res, 297, $value );

Default Value

''

Remarks

Use this property to set the SAML ID of the message subject.

This property is not available at design time.

Data Type

String

Version Property (SecureBlackbox_SAMLWriter Class)

Specifies the protocol version of the SAML message.

Object Oriented Interface

public function getVersion();


public function setVersion($value);

Procedural Interface

secureblackbox_samlwriter_get($res, 298 );


secureblackbox_samlwriter_set($res, 298, $value );

Default Value

'2.0'

Remarks

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.

This property is not available at design time.

Data Type

String

AddAdviceAssertion Method (SecureBlackbox_SAMLWriter Class)

Adds an advice assertion to the message.

Object Oriented Interface

public function doAddAdviceAssertion($assertionindex);

Procedural Interface

secureblackbox_samlwriter_do_addadviceassertion($res, $assertionindex);

Remarks

Use this method to add an advice assertion to a SAML assertion message. Provide the index of the assertion via AssertionIndex parameter.

This method returns the index of the newly added advice assertion in the list.

AddAssertion Method (SecureBlackbox_SAMLWriter Class)

Adds assertion to a SAML message.

Object Oriented Interface

public function doAddAssertion();

Procedural Interface

secureblackbox_samlwriter_do_addassertion($res);

Remarks

Use this method to add an assertion to the SAML message being created. The assertion details to add are taken from the components AssertionXXX properties, such as AssertionInfo AssertionStatements, or AssertionAttributes.

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

ClearAssertion Method (SecureBlackbox_SAMLWriter Class)

Resets the contents of all assertion-related properties.

Object Oriented Interface

public function doClearAssertion();

Procedural Interface

secureblackbox_samlwriter_do_clearassertion($res);

Remarks

Use this method to clear the contents of all assertion-related properties, such as AssertionAttributes, to clean up the assertion settings when preparing the component for adding a new assertion.

CompareIDs Method (SecureBlackbox_SAMLWriter Class)

Compares two SAML IDs.

Object Oriented Interface

public function doCompareIDs($id1, $id2);

Procedural Interface

secureblackbox_samlwriter_do_compareids($res, $id1, $id2);

Remarks

This utility method compares two SAML identifiers for equality.

Config Method (SecureBlackbox_SAMLWriter Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_samlwriter_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CreateNew Method (SecureBlackbox_SAMLWriter Class)

Creates a new SAML message with the given type.

Object Oriented Interface

public function doCreateNew($outputtype);

Procedural Interface

secureblackbox_samlwriter_do_createnew($res, $outputtype);

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)

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

DoAction Method (SecureBlackbox_SAMLWriter Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_samlwriter_do_doaction($res, $actionid, $actionparams);

Remarks

DoAction is a generic method available in every class. 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;....

GetIDProp Method (SecureBlackbox_SAMLWriter Class)

Returns an element of the SAML ID.

Object Oriented Interface

public function doGetIDProp($id, $propname);

Procedural Interface

secureblackbox_samlwriter_do_getidprop($res, $id, $propname);

Remarks

This is a utility method that simplifies retrieval of a specific property within a SAML ID. Pass the name of the ID property to the PropName parameter, and the ID to the ID parameter.

The following ID properties are supported:

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

RemoveAdvice Method (SecureBlackbox_SAMLWriter Class)

Removes an advice from an assertion.

Object Oriented Interface

public function doRemoveAdvice($assertionindex);

Procedural Interface

secureblackbox_samlwriter_do_removeadvice($res, $assertionindex);

Remarks

Use this method to remove an advice from an assertion. Pass the assertion index via the AssertionIndex parameter.

RemoveAdviceAssertion Method (SecureBlackbox_SAMLWriter Class)

Removes an advice from an assertion.

Object Oriented Interface

public function doRemoveAdviceAssertion($assertionindex, $adviceassertionindex);

Procedural Interface

secureblackbox_samlwriter_do_removeadviceassertion($res, $assertionindex, $adviceassertionindex);

Remarks

Use this method to remove an advice assertion from an assertion.

RemoveAllAssertions Method (SecureBlackbox_SAMLWriter Class)

Removes all assertions currently configured in the message.

Object Oriented Interface

public function doRemoveAllAssertions();

Procedural Interface

secureblackbox_samlwriter_do_removeallassertions($res);

Remarks

Use this message to remove all assertions currently set up in the SAML message.

RemoveAssertion Method (SecureBlackbox_SAMLWriter Class)

Removes an assertion from the message.

Object Oriented Interface

public function doRemoveAssertion($assertionindex);

Procedural Interface

secureblackbox_samlwriter_do_removeassertion($res, $assertionindex);

Remarks

Use this message to remove an assertion from a SAML message. Pass the assertion index as a parameter.

Save Method (SecureBlackbox_SAMLWriter Class)

Saves the configured message to a string.

Object Oriented Interface

public function doSave();

Procedural Interface

secureblackbox_samlwriter_do_save($res);

Remarks

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

SaveBytes Method (SecureBlackbox_SAMLWriter Class)

Saves the configured message to a byte array.

Object Oriented Interface

public function doSaveBytes();

Procedural Interface

secureblackbox_samlwriter_do_savebytes($res);

Remarks

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

SaveFile Method (SecureBlackbox_SAMLWriter Class)

Saves the configured message to a file.

Object Oriented Interface

public function doSaveFile($filename);

Procedural Interface

secureblackbox_samlwriter_do_savefile($res, $filename);

Remarks

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

Error Event (SecureBlackbox_SAMLWriter Class)

Fires to report an error condition.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_samlwriter_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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.

Notification Event (SecureBlackbox_SAMLWriter Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_samlwriter_register_callback($res, 2, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. 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 class, the exact action it is performing, or the document being processed, one or both may be omitted.

Config Settings (SAMLWriter Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

SAMLWriter Config Settings

Base Config Settings

Trappable Errors (SAMLWriter Class)