SAMLReader Class

Properties   Methods   Events   Config Settings   Errors  

The SAMLReader class offers SAML message processing functionality.

Class Name

SecureBlackbox_SAMLReader

Procedural Interface

 secureblackbox_samlreader_open();
 secureblackbox_samlreader_close($res);
 secureblackbox_samlreader_register_callback($res, $id, $function);
 secureblackbox_samlreader_get_last_error($res);
 secureblackbox_samlreader_get_last_error_code($res);
 secureblackbox_samlreader_set($res, $id, $index, $value);
 secureblackbox_samlreader_get($res, $id, $index);
 secureblackbox_samlreader_do_compareids($res, $id1, $id2);
 secureblackbox_samlreader_do_config($res, $configurationstring);
 secureblackbox_samlreader_do_doaction($res, $actionid, $actionparams);
 secureblackbox_samlreader_do_getidprop($res, $id, $propname);
 secureblackbox_samlreader_do_open($res, $input);
 secureblackbox_samlreader_do_openbytes($res, $inputbytes);
 secureblackbox_samlreader_do_openfile($res, $inputfile);
 secureblackbox_samlreader_do_pinassertion($res, $assertionindex);
 secureblackbox_samlreader_do_reset($res);

Remarks

SAMLReader provides means for processing of SAML protocol messages and extraction of their elements. Together with SAMLWriter it provides fine-grained access to the contents of SAML messages. You may consider using these classes if functionality offered by SAMLIdPServer and SAMLSPServer is too high a level for your usage scenario.

SAMLReader and SAMLWriter are independent of SAML server controls, and focus on scenarios that require lower-level access to SAML messaging.

SAMLReader can process the following types of SAML messages:

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

Pass your SAML message to Open (or OpenStream) method. Upon processing, class will populate the elements of the message in the properties, such as Message and Response. More complex elements, such as assertions, require pinning with PinAssertion method to be populated in the object properties.

The snippet below shows how to use SAMLReader to process a message of the AuthnRequest type created by the matching SAMLReader example (or by any compatible SAML endpoint). The input SAML message has the following look: <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> You can process this message and access its properties with the following code: Samlreader reader = new Samlreader(); reader.ValidateSignatures = true; reader.Open(req); Log("SAML document loaded. The message is of the " + reader.InputTypeString + " type, and was issued by " + reader.Issuer + " at " + reader.IssueInstant + "."); if (reader.InputType == SamlreaderInputTypes.cstyAuthnRequest) { Log("AuthnRequest.ConsumerServiceURL: " + reader.AuthnRequest.AssertionConsumerServiceURL); Log("AuthnRequest.ProtocolBinding: " + reader.AuthnRequest.ProtocolBinding); Log("AuthnRequest.Conditions.NotBefore: " + reader.AuthnRequest.ConditionsNotBefore); Log("AuthnRequest.Conditions.NotAfter: " + reader.AuthnRequest.ConditionsNotOnOrAfter); } if (reader.Signed) { Log("The message was signed by " + reader.SigningCertificate.SubjectRDN); Log("Signature validity: " + reader.SignatureValidationResult.ToString()); }

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.

ArtifactEndpointIndex Property (SecureBlackbox_SAMLReader Class)

An accessor to the EndpointIndex entry of the artifact.

Object Oriented Interface

public function getArtifactEndpointIndex();

Procedural Interface

secureblackbox_samlreader_get($res, 1 );

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

Data Type

Integer

ArtifactMessageHandle Property (SecureBlackbox_SAMLReader Class)

An accessor to the MessageHandle property of the artifact.

Object Oriented Interface

public function getArtifactMessageHandle();

Procedural Interface

secureblackbox_samlreader_get($res, 2 );

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

Data Type

Byte Array

ArtifactRemainingArtifact Property (SecureBlackbox_SAMLReader Class)

Returns the contents of the artifact.

Object Oriented Interface

public function getArtifactRemainingArtifact();

Procedural Interface

secureblackbox_samlreader_get($res, 3 );

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_SAMLReader Class)

An accessor to the SourceID property of the artifact.

Object Oriented Interface

public function getArtifactSourceID();

Procedural Interface

secureblackbox_samlreader_get($res, 4 );

Remarks

An accessor to the SourceID property of the artifact.

SourceID uniquely identifies the issuer of the artifact.

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

Data Type

Byte Array

ArtifactTypeCode Property (SecureBlackbox_SAMLReader Class)

The TypeCode property of the artifact.

Object Oriented Interface

public function getArtifactTypeCode();

Procedural Interface

secureblackbox_samlreader_get($res, 5 );

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

Data Type

Integer

ArtifactURI Property (SecureBlackbox_SAMLReader Class)

An accessor to the URI property of the artifact.

Object Oriented Interface

public function getArtifactURI();

Procedural Interface

secureblackbox_samlreader_get($res, 6 );

Default Value

''

Remarks

An accessor to the URI property of the artifact.

The URI property contains the origin of the artifact.

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

Data Type

String

ArtifactResolveQuery Property (SecureBlackbox_SAMLReader Class)

Returns the content of the ArtifactResolve query.

Object Oriented Interface

public function getArtifactResolveQuery();

Procedural Interface

secureblackbox_samlreader_get($res, 7 );

Default Value

''

Remarks

Check this property to access the content of the ArtifactResolve query, if the input type is set to cstyArtifactResolve.

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

Data Type

String

AssertionCount Property (SecureBlackbox_SAMLReader Class)

Returns the number of assertions in the SAML message.

Object Oriented Interface

public function getAssertionCount();

Procedural Interface

secureblackbox_samlreader_get($res, 8 );

Default Value

0

Remarks

Check this property to retrieve the number of assertions contained in the SAML message.

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

Data Type

Integer

AttributeCount Property (SecureBlackbox_SAMLReader Class)

The number of records in the Attribute arrays.

Object Oriented Interface

public function getAttributeCount();

Procedural Interface

secureblackbox_samlreader_get($res, 9 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttributeFriendlyName
• AttributeName
• AttributeNameFormat
• AttributeStatementIndex
• AttributeValues

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

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

Data Type

Integer

AttributeFriendlyName Property (SecureBlackbox_SAMLReader 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 getAttributeFriendlyName($attributeindex);

Procedural Interface

secureblackbox_samlreader_get($res, 10 , $attributeindex);

Default Value

''

Remarks

Specifies the friendly name of the attribute

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

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

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

Data Type

String

AttributeName Property (SecureBlackbox_SAMLReader Class)

Specifies the name of the attribute.

Object Oriented Interface

public function getAttributeName($attributeindex);

Procedural Interface

secureblackbox_samlreader_get($res, 11 , $attributeindex);

Default Value

''

Remarks

Specifies the name of the attribute.

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

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

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

Data Type

String

AttributeNameFormat Property (SecureBlackbox_SAMLReader Class)

Indicates the format used to reference the attribute.

Object Oriented Interface

public function getAttributeNameFormat($attributeindex);

Procedural Interface

secureblackbox_samlreader_get($res, 12 , $attributeindex);

Default Value

''

Remarks

Indicates the format used to reference the attribute.

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

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

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

Data Type

String

AttributeStatementIndex Property (SecureBlackbox_SAMLReader Class)

Contains the index of the statement the attribute corresponds to.

Object Oriented Interface

public function getAttributeStatementIndex($attributeindex);

Procedural Interface

secureblackbox_samlreader_get($res, 13 , $attributeindex);

Default Value

-1

Remarks

Contains the index of the statement the attribute corresponds to.

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

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

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

Data Type

Integer

AttributeValues Property (SecureBlackbox_SAMLReader Class)

Contains a list of attribute values.

Object Oriented Interface

public function getAttributeValues($attributeindex);

Procedural Interface

secureblackbox_samlreader_get($res, 14 , $attributeindex);

Default Value

''

Remarks

Contains a list of attribute values.

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

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

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

Data Type

String

AuthnQueryComparison Property (SecureBlackbox_SAMLReader Class)

Specifies the authentication context comparison method.

Object Oriented Interface

public function getAuthnQueryComparison();

Procedural Interface

secureblackbox_samlreader_get($res, 15 );

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

Data Type

Integer

AuthnQueryContextClassRefs Property (SecureBlackbox_SAMLReader Class)

Specifies the context class reference.

Object Oriented Interface

public function getAuthnQueryContextClassRefs();

Procedural Interface

secureblackbox_samlreader_get($res, 16 );

Default Value

''

Remarks

Specifies the context class reference.

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

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

Data Type

String

AuthnQueryRefType Property (SecureBlackbox_SAMLReader Class)

Specifies the context reference type.

Object Oriented Interface

public function getAuthnQueryRefType();

Procedural Interface

secureblackbox_samlreader_get($res, 17 );

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

Data Type

Integer

AuthnQuerySessionIndex Property (SecureBlackbox_SAMLReader Class)

Specifies the index of the session to the authentication entity.

Object Oriented Interface

public function getAuthnQuerySessionIndex();

Procedural Interface

secureblackbox_samlreader_get($res, 18 );

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

Data Type

String

AuthnRequestAssertionConsumerServiceIndex Property (SecureBlackbox_SAMLReader Class)

Specifies the assertion consumer service index.

Object Oriented Interface

public function getAuthnRequestAssertionConsumerServiceIndex();

Procedural Interface

secureblackbox_samlreader_get($res, 19 );

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

Data Type

Integer

AuthnRequestAssertionConsumerServiceURL Property (SecureBlackbox_SAMLReader Class)

Specifies the assertion consumer service URL.

Object Oriented Interface

public function getAuthnRequestAssertionConsumerServiceURL();

Procedural Interface

secureblackbox_samlreader_get($res, 20 );

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

Data Type

String

AuthnRequestAttributeConsumingServiceIndex Property (SecureBlackbox_SAMLReader Class)

Specifies the attribute consuming service index.

Object Oriented Interface

public function getAuthnRequestAttributeConsumingServiceIndex();

Procedural Interface

secureblackbox_samlreader_get($res, 21 );

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

Data Type

Integer

AuthnRequestContextClassRefs Property (SecureBlackbox_SAMLReader Class)

Provides access to the authentication context class references.

Object Oriented Interface

public function getAuthnRequestContextClassRefs();

Procedural Interface

secureblackbox_samlreader_get($res, 22 );

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

Data Type

String

AuthnRequestContextComparison Property (SecureBlackbox_SAMLReader Class)

Specifies the AuthnContext comparison method.

Object Oriented Interface

public function getAuthnRequestContextComparison();

Procedural Interface

secureblackbox_samlreader_get($res, 23 );

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

Data Type

Integer

AuthnRequestContextRefType Property (SecureBlackbox_SAMLReader Class)

Specifies the context reference type.

Object Oriented Interface

public function getAuthnRequestContextRefType();

Procedural Interface

secureblackbox_samlreader_get($res, 24 );

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

Data Type

Integer

AuthnRequestFlags Property (SecureBlackbox_SAMLReader Class)

Adjusts secondary serialization properties.

Object Oriented Interface

public function getAuthnRequestFlags();

Procedural Interface

secureblackbox_samlreader_get($res, 25 );

Default Value

0

Remarks

Adjusts secondary serialization properties.

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

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

Data Type

Integer

AuthnRequestForceAuthn Property (SecureBlackbox_SAMLReader Class)

Corresponds to the ForceAuthn parameter of the request.

Object Oriented Interface

public function getAuthnRequestForceAuthn();

Procedural Interface

secureblackbox_samlreader_get($res, 26 );

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

Data Type

Boolean

AuthnRequestIsPassive Property (SecureBlackbox_SAMLReader Class)

Maps to the IsPassive parameter of the request.

Object Oriented Interface

public function getAuthnRequestIsPassive();

Procedural Interface

secureblackbox_samlreader_get($res, 27 );

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

Data Type

Boolean

AuthnRequestNameIDPolicyAllowCreate Property (SecureBlackbox_SAMLReader Class)

Matches the AllowCreate attribute of NameIDPolicy element of the request.

Object Oriented Interface

public function getAuthnRequestNameIDPolicyAllowCreate();

Procedural Interface

secureblackbox_samlreader_get($res, 28 );

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

Data Type

Boolean

AuthnRequestNameIDPolicyFormat Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getAuthnRequestNameIDPolicyFormat();

Procedural Interface

secureblackbox_samlreader_get($res, 29 );

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

Data Type

String

AuthnRequestNameIDPolicySPNameQualifier Property (SecureBlackbox_SAMLReader Class)

Matches to the SP name qualifier attribute of the request.

Object Oriented Interface

public function getAuthnRequestNameIDPolicySPNameQualifier();

Procedural Interface

secureblackbox_samlreader_get($res, 30 );

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

Data Type

String

AuthnRequestProtocolBinding Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getAuthnRequestProtocolBinding();

Procedural Interface

secureblackbox_samlreader_get($res, 31 );

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

Data Type

String

AuthnRequestProviderName Property (SecureBlackbox_SAMLReader Class)

Specifies the name of the requestor.

Object Oriented Interface

public function getAuthnRequestProviderName();

Procedural Interface

secureblackbox_samlreader_get($res, 32 );

Default Value

''

Remarks

Specifies the name of the requestor.

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

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

Data Type

String

AuthnRequestScopingGetComplete Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getAuthnRequestScopingGetComplete();

Procedural Interface

secureblackbox_samlreader_get($res, 33 );

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

Data Type

String

AuthnRequestScopingProxyCount Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getAuthnRequestScopingProxyCount();

Procedural Interface

secureblackbox_samlreader_get($res, 34 );

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

Data Type

Integer

AuthnRequestScopingRequesterIDs Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getAuthnRequestScopingRequesterIDs();

Procedural Interface

secureblackbox_samlreader_get($res, 35 );

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

Data Type

String

AuthzDecisionQueryActions Property (SecureBlackbox_SAMLReader Class)

Specifies the list of actions included in the query.

Object Oriented Interface

public function getAuthzDecisionQueryActions();

Procedural Interface

secureblackbox_samlreader_get($res, 36 );

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

Data Type

String

AuthzDecisionQueryResource Property (SecureBlackbox_SAMLReader Class)

Matches the Resource element of the query.

Object Oriented Interface

public function getAuthzDecisionQueryResource();

Procedural Interface

secureblackbox_samlreader_get($res, 37 );

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

Data Type

String

BindingBindingType Property (SecureBlackbox_SAMLReader Class)

Specifies the type of SAML binding to use.

Object Oriented Interface

public function getBindingBindingType();

Procedural Interface

secureblackbox_samlreader_get($res, 38 );

Default Value

0

Remarks

Specifies the type of SAML binding to use.

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

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

Data Type

Integer

BindingBody Property (SecureBlackbox_SAMLReader Class)

Contains the POST binding form body.

Object Oriented Interface

public function getBindingBody();

Procedural Interface

secureblackbox_samlreader_get($res, 39 );

Default Value

''

Remarks

Contains the POST binding form body.

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

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

Data Type

String

BindingEncoding Property (SecureBlackbox_SAMLReader Class)

Specifies the message encoding.

Object Oriented Interface

public function getBindingEncoding();

Procedural Interface

secureblackbox_samlreader_get($res, 40 );

Default Value

''

Remarks

Specifies the message encoding.

Use this property to access or set the message encoding.

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

Data Type

String

BindingForceSign Property (SecureBlackbox_SAMLReader Class)

Enforces a signature over all outgoing messages.

Object Oriented Interface

public function getBindingForceSign();

Procedural Interface

secureblackbox_samlreader_get($res, 41 );

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

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

Data Type

Boolean

BindingFormTemplate Property (SecureBlackbox_SAMLReader Class)

Contains the XHTML form template returned by the service provider.

Object Oriented Interface

public function getBindingFormTemplate();

Procedural Interface

secureblackbox_samlreader_get($res, 42 );

Default Value

''

Remarks

Contains the XHTML form template returned by the service provider.

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

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

Data Type

String

BindingPOSTMode Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getBindingPOSTMode();

Procedural Interface

secureblackbox_samlreader_get($res, 43 );

Default Value

0

Remarks

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

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

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

Data Type

Integer

BindingRelayState Property (SecureBlackbox_SAMLReader Class)

Contains the RelayState parameter of the binding.

Object Oriented Interface

public function getBindingRelayState();

Procedural Interface

secureblackbox_samlreader_get($res, 44 );

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

Data Type

String

BindingSignatureAlgorithm Property (SecureBlackbox_SAMLReader Class)

Contains the signature algorithm.

Object Oriented Interface

public function getBindingSignatureAlgorithm();

Procedural Interface

secureblackbox_samlreader_get($res, 45 );

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

Data Type

String

BindingSignatureValidationResult Property (SecureBlackbox_SAMLReader Class)

The outcome of the cryptographic signature validation.

Object Oriented Interface

public function getBindingSignatureValidationResult();

Procedural Interface

secureblackbox_samlreader_get($res, 46 );

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

BindingSigned Property (SecureBlackbox_SAMLReader Class)

Specifies whether to sign the binding.

Object Oriented Interface

public function getBindingSigned();

Procedural Interface

secureblackbox_samlreader_get($res, 47 );

Default Value

false

Remarks

Specifies whether to sign the binding.

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

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

Data Type

Boolean

BindingURL Property (SecureBlackbox_SAMLReader Class)

Contains the URL of the request query.

Object Oriented Interface

public function getBindingURL();

Procedural Interface

secureblackbox_samlreader_get($res, 48 );

Default Value

''

Remarks

Contains the URL of the request query.

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

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

Data Type

String

BindingVerifySignatures Property (SecureBlackbox_SAMLReader Class)

Instructs the class whether to verify incoming signatures.

Object Oriented Interface

public function getBindingVerifySignatures();

Procedural Interface

secureblackbox_samlreader_get($res, 49 );

Default Value

true

Remarks

Instructs the component whether to verify incoming signatures.

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

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

Data Type

Boolean

BindingKeyHandle Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getBindingKeyHandle();


public function setBindingKeyHandle($value);

Procedural Interface

secureblackbox_samlreader_get($res, 55 );


secureblackbox_samlreader_set($res, 55, $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

BindingKeyKey Property (SecureBlackbox_SAMLReader Class)

The byte array representation of the key.

Object Oriented Interface

public function getBindingKeyKey();

Procedural Interface

secureblackbox_samlreader_get($res, 58 );

Remarks

The byte array representation of the key. This may not be available for non-BindingKeyExportable keys.

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

Data Type

Byte Array

CertCount Property (SecureBlackbox_SAMLReader Class)

The number of records in the Cert arrays.

Object Oriented Interface

public function getCertCount();


public function setCertCount($value);

Procedural Interface

secureblackbox_samlreader_get($res, 65 );


secureblackbox_samlreader_set($res, 65, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• CertBytes
• CertHandle

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

This property is not available at design time.

Data Type

Integer

CertBytes Property (SecureBlackbox_SAMLReader Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getCertBytes($certindex);

Procedural Interface

secureblackbox_samlreader_get($res, 66 , $certindex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

CertHandle Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getCertHandle($certindex);


public function setCertHandle($certindex, $value);

Procedural Interface

secureblackbox_samlreader_get($res, 74 , $certindex);


secureblackbox_samlreader_set($res, 74, $value , $certindex);

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

This property is not available at design time.

Data Type

Long64

ConditionCount Property (SecureBlackbox_SAMLReader Class)

The number of records in the Condition arrays.

Object Oriented Interface

public function getConditionCount();

Procedural Interface

secureblackbox_samlreader_get($res, 105 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ConditionCondition
• ConditionConditionType

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

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

Data Type

Integer

ConditionCondition Property (SecureBlackbox_SAMLReader Class)

The condition set in accordance with the ConditionType .

Object Oriented Interface

public function getConditionCondition($conditionindex);

Procedural Interface

secureblackbox_samlreader_get($res, 106 , $conditionindex);

Default Value

''

Remarks

The condition set in accordance with the ConditionType.

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

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

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

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

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

Data Type

String

ConditionConditionType Property (SecureBlackbox_SAMLReader Class)

Specifies a type of the condition object.

Object Oriented Interface

public function getConditionConditionType($conditionindex);

Procedural Interface

secureblackbox_samlreader_get($res, 107 , $conditionindex);

Default Value

0

Remarks

Specifies a type of the condition object.

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

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

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

Data Type

Integer

DecryptionCertificateBytes Property (SecureBlackbox_SAMLReader Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getDecryptionCertificateBytes();

Procedural Interface

secureblackbox_samlreader_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

DecryptionCertificateHandle Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getDecryptionCertificateHandle();


public function setDecryptionCertificateHandle($value);

Procedural Interface

secureblackbox_samlreader_get($res, 116 );


secureblackbox_samlreader_set($res, 116, $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_SAMLReader Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_samlreader_get($res, 147 );


secureblackbox_samlreader_set($res, 147, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

LogoutRequestNameID Property (SecureBlackbox_SAMLReader Class)

Contains the value of the NameID parameter.

Object Oriented Interface

public function getLogoutRequestNameID();

Procedural Interface

secureblackbox_samlreader_get($res, 148 );

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

Data Type

String

LogoutRequestNotOnOrAfter Property (SecureBlackbox_SAMLReader Class)

Contains the value of the NotOnOrAfter parameter.

Object Oriented Interface

public function getLogoutRequestNotOnOrAfter();

Procedural Interface

secureblackbox_samlreader_get($res, 149 );

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

Data Type

String

LogoutRequestReason Property (SecureBlackbox_SAMLReader Class)

Contains the value of the Reason parameter.

Object Oriented Interface

public function getLogoutRequestReason();

Procedural Interface

secureblackbox_samlreader_get($res, 150 );

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

Data Type

String

LogoutRequestSessionIndexes Property (SecureBlackbox_SAMLReader Class)

Contains the list of session indices.

Object Oriented Interface

public function getLogoutRequestSessionIndexes();

Procedural Interface

secureblackbox_samlreader_get($res, 151 );

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

Data Type

String

ManageNameIDRequestNameID Property (SecureBlackbox_SAMLReader Class)

Contains the value of the NameID parameter of the request.

Object Oriented Interface

public function getManageNameIDRequestNameID();

Procedural Interface

secureblackbox_samlreader_get($res, 152 );

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

Data Type

String

ManageNameIDRequestNewEncryptedID Property (SecureBlackbox_SAMLReader Class)

Contains the value of the NewEncryptedID parameter of the request.

Object Oriented Interface

public function getManageNameIDRequestNewEncryptedID();

Procedural Interface

secureblackbox_samlreader_get($res, 153 );

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

Data Type

String

ManageNameIDRequestNewID Property (SecureBlackbox_SAMLReader Class)

Contains the value of the NewID parameter.

Object Oriented Interface

public function getManageNameIDRequestNewID();

Procedural Interface

secureblackbox_samlreader_get($res, 154 );

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

Data Type

String

ManageNameIDRequestTerminate Property (SecureBlackbox_SAMLReader Class)

Contains the value of the Terminate parameter of the request.

Object Oriented Interface

public function getManageNameIDRequestTerminate();

Procedural Interface

secureblackbox_samlreader_get($res, 155 );

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

Data Type

String

MessageConsent Property (SecureBlackbox_SAMLReader Class)

Contains the Consent parameter of the SAML message.

Object Oriented Interface

public function getMessageConsent();

Procedural Interface

secureblackbox_samlreader_get($res, 156 );

Default Value

''

Remarks

Contains the Consent parameter of the SAML message.

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

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

Data Type

String

MessageContentType Property (SecureBlackbox_SAMLReader Class)

Returns the SAML type of the current message.

Object Oriented Interface

public function getMessageContentType();

Procedural Interface

secureblackbox_samlreader_get($res, 157 );

Default Value

0

Remarks

Returns the SAML type of the current message.

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

Depending on the assigned type, use properties of class to tune up the parameters of the chosen message type. For example, if the content type is 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

MessageContentTypeString Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getMessageContentTypeString();

Procedural Interface

secureblackbox_samlreader_get($res, 158 );

Default Value

''

Remarks

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

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

Known SAML content types are:

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

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

Data Type

String

MessageDestination Property (SecureBlackbox_SAMLReader Class)

Contains the Destination parameter of the SAML message.

Object Oriented Interface

public function getMessageDestination();

Procedural Interface

secureblackbox_samlreader_get($res, 159 );

Default Value

''

Remarks

Contains the Destination parameter of the SAML message.

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

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

Data Type

String

MessageID Property (SecureBlackbox_SAMLReader Class)

The ID of the request.

Object Oriented Interface

public function getMessageID();

Procedural Interface

secureblackbox_samlreader_get($res, 160 );

Default Value

''

Remarks

The ID of the request.

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

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

Data Type

String

MessageInResponseTo Property (SecureBlackbox_SAMLReader Class)

Contains the InResponseTo property of the SAML request.

Object Oriented Interface

public function getMessageInResponseTo();

Procedural Interface

secureblackbox_samlreader_get($res, 161 );

Default Value

''

Remarks

Contains the InResponseTo property of the SAML request.

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

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

Data Type

String

MessageIssueInstant Property (SecureBlackbox_SAMLReader Class)

Contains request issuance timestamp.

Object Oriented Interface

public function getMessageIssueInstant();

Procedural Interface

secureblackbox_samlreader_get($res, 162 );

Default Value

''

Remarks

Contains request issuance timestamp.

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

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

Data Type

String

MessageIssuer Property (SecureBlackbox_SAMLReader Class)

Sets the issuer of the message.

Object Oriented Interface

public function getMessageIssuer();

Procedural Interface

secureblackbox_samlreader_get($res, 163 );

Default Value

''

Remarks

Sets the issuer of the message.

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

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

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

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

Data Type

String

MessageSignatureValidationResult Property (SecureBlackbox_SAMLReader Class)

The outcome of the cryptographic signature validation.

Object Oriented Interface

public function getMessageSignatureValidationResult();

Procedural Interface

secureblackbox_samlreader_get($res, 164 );

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

MessageSigned Property (SecureBlackbox_SAMLReader Class)

Specifies whether the SAML message is or should be signed.

Object Oriented Interface

public function getMessageSigned();

Procedural Interface

secureblackbox_samlreader_get($res, 165 );

Default Value

false

Remarks

Specifies whether the SAML message is or should be signed.

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

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

Data Type

Boolean

MessageSubject Property (SecureBlackbox_SAMLReader Class)

Gets or sets the subject of the message.

Object Oriented Interface

public function getMessageSubject();

Procedural Interface

secureblackbox_samlreader_get($res, 166 );

Default Value

''

Remarks

Gets or sets the subject of the message.

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

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

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

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

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

Data Type

String

MessageVersion Property (SecureBlackbox_SAMLReader Class)

Specifies the protocol version to use for the SAML message.

Object Oriented Interface

public function getMessageVersion();

Procedural Interface

secureblackbox_samlreader_get($res, 167 );

Default Value

'2.0'

Remarks

Specifies the protocol version to use for the SAML message.

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

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

Data Type

String

MessageXMLHeader Property (SecureBlackbox_SAMLReader Class)

Controls the inclusion of an XML header in the message.

Object Oriented Interface

public function getMessageXMLHeader();

Procedural Interface

secureblackbox_samlreader_get($res, 168 );

Default Value

false

Remarks

Controls the inclusion of an XML header in the message.

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

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

Data Type

Boolean

NameIDMappingRequestNameID Property (SecureBlackbox_SAMLReader Class)

An accessor to the NameID parameter of the request.

Object Oriented Interface

public function getNameIDMappingRequestNameID();

Procedural Interface

secureblackbox_samlreader_get($res, 169 );

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

Data Type

String

NameIDMappingRequestNameIDPolicyAllowCreate Property (SecureBlackbox_SAMLReader Class)

Contains the value of AllowCreate parameter of the NameIDPolicy object.

Object Oriented Interface

public function getNameIDMappingRequestNameIDPolicyAllowCreate();

Procedural Interface

secureblackbox_samlreader_get($res, 170 );

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

Data Type

Boolean

NameIDMappingRequestNameIDPolicyFormat Property (SecureBlackbox_SAMLReader Class)

Specifies the format of the NameIDPolicy element.

Object Oriented Interface

public function getNameIDMappingRequestNameIDPolicyFormat();

Procedural Interface

secureblackbox_samlreader_get($res, 171 );

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

Data Type

String

NameIDMappingRequestNameIDPolicySPNameQualifier Property (SecureBlackbox_SAMLReader Class)

Contains the SPNameQualifier parameter of the NameIDPolicy element.

Object Oriented Interface

public function getNameIDMappingRequestNameIDPolicySPNameQualifier();

Procedural Interface

secureblackbox_samlreader_get($res, 172 );

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

Data Type

String

NameIDMappingRequestNameIDPolicyUseAllowCreate Property (SecureBlackbox_SAMLReader Class)

Controls inclusion of UseAllow modifier in the NameIDPolicy object.

Object Oriented Interface

public function getNameIDMappingRequestNameIDPolicyUseAllowCreate();

Procedural Interface

secureblackbox_samlreader_get($res, 173 );

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

Data Type

Boolean

PinnedAssertionAssertionType Property (SecureBlackbox_SAMLReader Class)

Specifies the type of the assertion.

Object Oriented Interface

public function getPinnedAssertionAssertionType();

Procedural Interface

secureblackbox_samlreader_get($res, 174 );

Default Value

2

Remarks

Specifies the type of the assertion.

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

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

Data Type

Integer

PinnedAssertionEncryptedContent Property (SecureBlackbox_SAMLReader Class)

Represents the encrypted assertion content.

Object Oriented Interface

public function getPinnedAssertionEncryptedContent();

Procedural Interface

secureblackbox_samlreader_get($res, 175 );

Default Value

''

Remarks

Represents the encrypted assertion content.

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

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

Data Type

String

PinnedAssertionID Property (SecureBlackbox_SAMLReader Class)

Represents the ID of the assertion.

Object Oriented Interface

public function getPinnedAssertionID();

Procedural Interface

secureblackbox_samlreader_get($res, 176 );

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

Data Type

String

PinnedAssertionIDRef Property (SecureBlackbox_SAMLReader Class)

Represents an ID reference value.

Object Oriented Interface

public function getPinnedAssertionIDRef();

Procedural Interface

secureblackbox_samlreader_get($res, 177 );

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

Data Type

String

PinnedAssertionIssueInstant Property (SecureBlackbox_SAMLReader Class)

Contains the assertion issuance time stamp.

Object Oriented Interface

public function getPinnedAssertionIssueInstant();

Procedural Interface

secureblackbox_samlreader_get($res, 178 );

Default Value

''

Remarks

Contains the assertion issuance time stamp.

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

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

Data Type

String

PinnedAssertionIssuer Property (SecureBlackbox_SAMLReader Class)

Specifies the assertion issuer.

Object Oriented Interface

public function getPinnedAssertionIssuer();

Procedural Interface

secureblackbox_samlreader_get($res, 179 );

Default Value

''

Remarks

Specifies the assertion issuer.

Use this property to provide the assertion issuer ID.

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

Data Type

String

PinnedAssertionParentAssertion Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getPinnedAssertionParentAssertion();

Procedural Interface

secureblackbox_samlreader_get($res, 180 );

Default Value

-1

Remarks

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

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

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

Data Type

Integer

PinnedAssertionSignatureValidationResult Property (SecureBlackbox_SAMLReader Class)

The outcome of the cryptographic signature validation.

Object Oriented Interface

public function getPinnedAssertionSignatureValidationResult();

Procedural Interface

secureblackbox_samlreader_get($res, 181 );

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

PinnedAssertionSigned Property (SecureBlackbox_SAMLReader Class)

Specifies whether the assertion is signed.

Object Oriented Interface

public function getPinnedAssertionSigned();

Procedural Interface

secureblackbox_samlreader_get($res, 182 );

Default Value

false

Remarks

Specifies whether the assertion is signed.

Use this property to establish whether the assertion is signed.

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

Data Type

Boolean

PinnedAssertionSubject Property (SecureBlackbox_SAMLReader Class)

Specifies the assertion subject.

Object Oriented Interface

public function getPinnedAssertionSubject();

Procedural Interface

secureblackbox_samlreader_get($res, 183 );

Default Value

''

Remarks

Specifies the assertion subject.

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

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

Data Type

String

PinnedAssertionURIRef Property (SecureBlackbox_SAMLReader Class)

Represents an URI reference value.

Object Oriented Interface

public function getPinnedAssertionURIRef();

Procedural Interface

secureblackbox_samlreader_get($res, 184 );

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

Data Type

String

PinnedAssertionVersion Property (SecureBlackbox_SAMLReader Class)

Specifies the SAML protocol version used.

Object Oriented Interface

public function getPinnedAssertionVersion();

Procedural Interface

secureblackbox_samlreader_get($res, 185 );

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

Data Type

String

Profile Property (SecureBlackbox_SAMLReader 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_samlreader_get($res, 186 );


secureblackbox_samlreader_set($res, 186, $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

ProxyAddress Property (SecureBlackbox_SAMLReader Class)

The IP address of the proxy server.

Object Oriented Interface

public function getProxyAddress();


public function setProxyAddress($value);

Procedural Interface

secureblackbox_samlreader_get($res, 187 );


secureblackbox_samlreader_set($res, 187, $value );

Default Value

''

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (SecureBlackbox_SAMLReader Class)

The authentication type used by the proxy server.

Object Oriented Interface

public function getProxyAuthentication();


public function setProxyAuthentication($value);

Procedural Interface

secureblackbox_samlreader_get($res, 188 );


secureblackbox_samlreader_set($res, 188, $value );

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (SecureBlackbox_SAMLReader Class)

The password to authenticate to the proxy server.

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

secureblackbox_samlreader_get($res, 189 );


secureblackbox_samlreader_set($res, 189, $value );

Default Value

''

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (SecureBlackbox_SAMLReader Class)

The port on the proxy server to connect to.

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

secureblackbox_samlreader_get($res, 190 );


secureblackbox_samlreader_set($res, 190, $value );

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (SecureBlackbox_SAMLReader Class)

The type of the proxy server.

Object Oriented Interface

public function getProxyProxyType();


public function setProxyProxyType($value);

Procedural Interface

secureblackbox_samlreader_get($res, 191 );


secureblackbox_samlreader_set($res, 191, $value );

Default Value

0

Remarks

The type of the proxy server.

Data Type

Integer

ProxyRequestHeaders Property (SecureBlackbox_SAMLReader Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Object Oriented Interface

public function getProxyRequestHeaders();


public function setProxyRequestHeaders($value);

Procedural Interface

secureblackbox_samlreader_get($res, 192 );


secureblackbox_samlreader_set($res, 192, $value );

Default Value

''

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (SecureBlackbox_SAMLReader Class)

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Object Oriented Interface

public function getProxyResponseBody();


public function setProxyResponseBody($value);

Procedural Interface

secureblackbox_samlreader_get($res, 193 );


secureblackbox_samlreader_set($res, 193, $value );

Default Value

''

Remarks

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Data Type

String

ProxyResponseHeaders Property (SecureBlackbox_SAMLReader Class)

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Object Oriented Interface

public function getProxyResponseHeaders();


public function setProxyResponseHeaders($value);

Procedural Interface

secureblackbox_samlreader_get($res, 194 );


secureblackbox_samlreader_set($res, 194, $value );

Default Value

''

Remarks

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Data Type

String

ProxyUseIPv6 Property (SecureBlackbox_SAMLReader Class)

Specifies whether IPv6 should be used when connecting through the proxy.

Object Oriented Interface

public function getProxyUseIPv6();


public function setProxyUseIPv6($value);

Procedural Interface

secureblackbox_samlreader_get($res, 195 );


secureblackbox_samlreader_set($res, 195, $value );

Default Value

false

Remarks

Specifies whether IPv6 should be used when connecting through the proxy.

Data Type

Boolean

ProxyUsername Property (SecureBlackbox_SAMLReader Class)

Specifies the username credential for proxy authentication.

Object Oriented Interface

public function getProxyUsername();


public function setProxyUsername($value);

Procedural Interface

secureblackbox_samlreader_get($res, 196 );


secureblackbox_samlreader_set($res, 196, $value );

Default Value

''

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

References Property (SecureBlackbox_SAMLReader Class)

Contains the References entry of the SAML AssertionIDRequest message.

Object Oriented Interface

public function getReferences();

Procedural Interface

secureblackbox_samlreader_get($res, 197 );

Default Value

''

Remarks

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

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

Data Type

String

ResponseNameID Property (SecureBlackbox_SAMLReader Class)

Contains the NameID parameter of a NameIDMapping response.

Object Oriented Interface

public function getResponseNameID();

Procedural Interface

secureblackbox_samlreader_get($res, 198 );

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

Data Type

String

ResponseOptionalElement Property (SecureBlackbox_SAMLReader Class)

An optional message element to be returned with the response.

Object Oriented Interface

public function getResponseOptionalElement();

Procedural Interface

secureblackbox_samlreader_get($res, 199 );

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

Data Type

String

ResponseResponseType Property (SecureBlackbox_SAMLReader Class)

Contains the type of the response.

Object Oriented Interface

public function getResponseResponseType();

Procedural Interface

secureblackbox_samlreader_get($res, 200 );

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

Data Type

Integer

ResponseStatus Property (SecureBlackbox_SAMLReader Class)

Gets or sets the status of the response.

Object Oriented Interface

public function getResponseStatus();

Procedural Interface

secureblackbox_samlreader_get($res, 201 );

Default Value

0

Remarks

Gets or sets the status of the response.

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

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

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

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

The error code can take one of the following values:

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

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

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

Data Type

Integer

ResponseStatusCodeSubValue Property (SecureBlackbox_SAMLReader Class)

The value of the nested StatusCode.

Object Oriented Interface

public function getResponseStatusCodeSubValue();

Procedural Interface

secureblackbox_samlreader_get($res, 202 );

Default Value

''

Remarks

The value of the nested StatusCode.

This property contains the value of the nested StatusCode element.

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

Data Type

String

ResponseStatusCodeValue Property (SecureBlackbox_SAMLReader Class)

Contains the status code value.

Object Oriented Interface

public function getResponseStatusCodeValue();

Procedural Interface

secureblackbox_samlreader_get($res, 203 );

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

Data Type

String

ResponseStatusDetail Property (SecureBlackbox_SAMLReader Class)

Contains additional information on the status of the request.

Object Oriented Interface

public function getResponseStatusDetail();

Procedural Interface

secureblackbox_samlreader_get($res, 204 );

Default Value

''

Remarks

Contains additional information on the status of the request.

The StatusDetail element contains additional request status information.

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

Data Type

String

ResponseStatusMessage Property (SecureBlackbox_SAMLReader Class)

Contains a status message (optional).

Object Oriented Interface

public function getResponseStatusMessage();

Procedural Interface

secureblackbox_samlreader_get($res, 205 );

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

Data Type

String

ScopingIDPCount Property (SecureBlackbox_SAMLReader Class)

The number of records in the ScopingIDP arrays.

Object Oriented Interface

public function getScopingIDPCount();

Procedural Interface

secureblackbox_samlreader_get($res, 206 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ScopingIDPLoc
• ScopingIDPName
• ScopingIDPProviderID

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

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

Data Type

Integer

ScopingIDPLoc Property (SecureBlackbox_SAMLReader Class)

Contains the value of the Loc attribute.

Object Oriented Interface

public function getScopingIDPLoc($scopingidpindex);

Procedural Interface

secureblackbox_samlreader_get($res, 207 , $scopingidpindex);

Default Value

''

Remarks

Contains the value of the Loc attribute.

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

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

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

Data Type

String

ScopingIDPName Property (SecureBlackbox_SAMLReader Class)

Contains the name of the IdP provider.

Object Oriented Interface

public function getScopingIDPName($scopingidpindex);

Procedural Interface

secureblackbox_samlreader_get($res, 208 , $scopingidpindex);

Default Value

''

Remarks

Contains the name of the IdP provider.

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

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

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

Data Type

String

ScopingIDPProviderID Property (SecureBlackbox_SAMLReader Class)

Contains the provider ID.

Object Oriented Interface

public function getScopingIDPProviderID($scopingidpindex);

Procedural Interface

secureblackbox_samlreader_get($res, 209 , $scopingidpindex);

Default Value

''

Remarks

Contains the provider ID.

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

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

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

Data Type

String

SecurityCanonicalizationMethod Property (SecureBlackbox_SAMLReader Class)

The canonicalization method to use in the signature.

Object Oriented Interface

public function getSecurityCanonicalizationMethod();

Procedural Interface

secureblackbox_samlreader_get($res, 210 );

Default Value

''

Remarks

The canonicalization method to use in the signature.

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

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

Data Type

String

SecurityDigestMethod Property (SecureBlackbox_SAMLReader Class)

The digest method to use.

Object Oriented Interface

public function getSecurityDigestMethod();

Procedural Interface

secureblackbox_samlreader_get($res, 211 );

Default Value

''

Remarks

The digest method to use.

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

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

Data Type

String

SecurityEncryptionMethod Property (SecureBlackbox_SAMLReader Class)

The encryption method used to encrypt the assertion.

Object Oriented Interface

public function getSecurityEncryptionMethod();

Procedural Interface

secureblackbox_samlreader_get($res, 212 );

Default Value

'AES256'

Remarks

The encryption method used to encrypt the assertion.

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

Supported values:

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

Data Type

String

SecurityFlags Property (SecureBlackbox_SAMLReader Class)

Provides access to secondary security parameters and tweaks.

Object Oriented Interface

public function getSecurityFlags();

Procedural Interface

secureblackbox_samlreader_get($res, 213 );

Default Value

1

Remarks

Provides access to secondary security parameters and tweaks.

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

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

Data Type

Integer

SecuritySigMethod Property (SecureBlackbox_SAMLReader Class)

The signature method to use.

Object Oriented Interface

public function getSecuritySigMethod();

Procedural Interface

secureblackbox_samlreader_get($res, 214 );

Default Value

''

Remarks

The signature method to use.

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

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

Data Type

String

SecuritySignaturePolicy Property (SecureBlackbox_SAMLReader Class)

Specifies the signature validation policy.

Object Oriented Interface

public function getSecuritySignaturePolicy();

Procedural Interface

secureblackbox_samlreader_get($res, 215 );

Default Value

0

Remarks

Specifies the signature validation policy.

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

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

Data Type

Integer

SigningCertBytes Property (SecureBlackbox_SAMLReader Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSigningCertBytes();

Procedural Interface

secureblackbox_samlreader_get($res, 216 );

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

SigningCertCA Property (SecureBlackbox_SAMLReader Class)

Indicates whether the certificate has a CA capability.

Object Oriented Interface

public function getSigningCertCA();

Procedural Interface

secureblackbox_samlreader_get($res, 217 );

Default Value

false

Remarks

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

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

Data Type

Boolean

SigningCertCAKeyID Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getSigningCertCAKeyID();

Procedural Interface

secureblackbox_samlreader_get($res, 218 );

Remarks

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

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

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

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

Data Type

Byte Array

SigningCertCRLDistributionPoints Property (SecureBlackbox_SAMLReader Class)

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Object Oriented Interface

public function getSigningCertCRLDistributionPoints();

Procedural Interface

secureblackbox_samlreader_get($res, 220 );

Default Value

''

Remarks

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

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

Data Type

String

SigningCertCurve Property (SecureBlackbox_SAMLReader Class)

Specifies the elliptic curve associated with the certificate's public key.

Object Oriented Interface

public function getSigningCertCurve();

Procedural Interface

secureblackbox_samlreader_get($res, 221 );

Default Value

''

Remarks

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.

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

Data Type

String

SigningCertFingerprint Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getSigningCertFingerprint();

Procedural Interface

secureblackbox_samlreader_get($res, 222 );

Default Value

''

Remarks

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

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

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

Data Type

String

SigningCertFriendlyName Property (SecureBlackbox_SAMLReader Class)

Contains an associated alias (friendly name) of the certificate.

Object Oriented Interface

public function getSigningCertFriendlyName();

Procedural Interface

secureblackbox_samlreader_get($res, 223 );

Default Value

''

Remarks

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

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

Data Type

String

SigningCertHandle Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getSigningCertHandle();

Procedural Interface

secureblackbox_samlreader_get($res, 224 );

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

Data Type

Long64

SigningCertHashAlgorithm Property (SecureBlackbox_SAMLReader Class)

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Object Oriented Interface

public function getSigningCertHashAlgorithm();

Procedural Interface

secureblackbox_samlreader_get($res, 225 );

Default Value

''

Remarks

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use SigningCertSigAlgorithm to find out the hash algorithm that is part of the certificate signature.

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

Data Type

String

SigningCertIssuer Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getSigningCertIssuer();

Procedural Interface

secureblackbox_samlreader_get($res, 226 );

Default Value

''

Remarks

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

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

Data Type

String

SigningCertIssuerRDN Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getSigningCertIssuerRDN();

Procedural Interface

secureblackbox_samlreader_get($res, 227 );

Default Value

''

Remarks

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

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

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

Data Type

String

SigningCertKeyAlgorithm Property (SecureBlackbox_SAMLReader Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getSigningCertKeyAlgorithm();

Procedural Interface

secureblackbox_samlreader_get($res, 228 );

Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

Use the SigningCertKeyBits, SigningCertCurve, and SigningCertPublicKeyBytes properties to get more details about the key the certificate contains.

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

Data Type

String

SigningCertKeyBits Property (SecureBlackbox_SAMLReader Class)

Returns the length of the public key in bits.

Object Oriented Interface

public function getSigningCertKeyBits();

Procedural Interface

secureblackbox_samlreader_get($res, 229 );

Default Value

0

Remarks

Returns the length of the public key in bits.

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

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

Data Type

Integer

SigningCertKeyFingerprint Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getSigningCertKeyFingerprint();

Procedural Interface

secureblackbox_samlreader_get($res, 230 );

Default Value

''

Remarks

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

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

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

Data Type

String

SigningCertKeyUsage Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getSigningCertKeyUsage();

Procedural Interface

secureblackbox_samlreader_get($res, 231 );

Default Value

0

Remarks

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

This value is a bit mask of the following values:

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

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

Data Type

Integer

SigningCertKeyValid Property (SecureBlackbox_SAMLReader Class)

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Object Oriented Interface

public function getSigningCertKeyValid();

Procedural Interface

secureblackbox_samlreader_get($res, 232 );

Default Value

false

Remarks

Returns True if the certificate's key is cryptographically valid, and False otherwise.

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

Data Type

Boolean

SigningCertOCSPLocations Property (SecureBlackbox_SAMLReader Class)

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Object Oriented Interface

public function getSigningCertOCSPLocations();

Procedural Interface

secureblackbox_samlreader_get($res, 233 );

Default Value

''

Remarks

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this property before calling the certificate manager's Generate method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

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

Data Type

String

SigningCertPolicyIDs Property (SecureBlackbox_SAMLReader Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getSigningCertPolicyIDs();

Procedural Interface

secureblackbox_samlreader_get($res, 236 );

Default Value

''

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

Set this property when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

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

Data Type

String

SigningCertPublicKeyBytes Property (SecureBlackbox_SAMLReader Class)

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getSigningCertPublicKeyBytes();

Procedural Interface

secureblackbox_samlreader_get($res, 240 );

Remarks

Contains the certificate's public key in DER format.

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

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

Data Type

Byte Array

SigningCertSelfSigned Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getSigningCertSelfSigned();

Procedural Interface

secureblackbox_samlreader_get($res, 244 );

Default Value

false

Remarks

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

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

Data Type

Boolean

SigningCertSerialNumber Property (SecureBlackbox_SAMLReader Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getSigningCertSerialNumber();

Procedural Interface

secureblackbox_samlreader_get($res, 245 );

Remarks

Returns the certificate's serial number.

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

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

Data Type

Byte Array

SigningCertSigAlgorithm Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getSigningCertSigAlgorithm();

Procedural Interface

secureblackbox_samlreader_get($res, 246 );

Default Value

''

Remarks

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

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

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

Data Type

String

SigningCertSubject Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getSigningCertSubject();

Procedural Interface

secureblackbox_samlreader_get($res, 248 );

Default Value

''

Remarks

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

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

Data Type

String

SigningCertSubjectKeyID Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getSigningCertSubjectKeyID();

Procedural Interface

secureblackbox_samlreader_get($res, 250 );

Remarks

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

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

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

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

Data Type

Byte Array

SigningCertSubjectRDN Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getSigningCertSubjectRDN();

Procedural Interface

secureblackbox_samlreader_get($res, 251 );

Default Value

''

Remarks

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

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

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

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

Data Type

String

SigningCertValidFrom Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getSigningCertValidFrom();

Procedural Interface

secureblackbox_samlreader_get($res, 253 );

Default Value

''

Remarks

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

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

Data Type

String

SigningCertValidTo Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getSigningCertValidTo();

Procedural Interface

secureblackbox_samlreader_get($res, 254 );

Default Value

''

Remarks

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

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

Data Type

String

SocketDNSMode Property (SecureBlackbox_SAMLReader Class)

Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.

Object Oriented Interface

public function getSocketDNSMode();


public function setSocketDNSMode($value);

Procedural Interface

secureblackbox_samlreader_get($res, 255 );


secureblackbox_samlreader_set($res, 255, $value );

Default Value

0

Remarks

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

Data Type

Integer

SocketDNSPort Property (SecureBlackbox_SAMLReader Class)

Specifies the port number to be used for sending queries to the DNS server.

Object Oriented Interface

public function getSocketDNSPort();


public function setSocketDNSPort($value);

Procedural Interface

secureblackbox_samlreader_get($res, 256 );


secureblackbox_samlreader_set($res, 256, $value );

Default Value

0

Remarks

Specifies the port number to be used for sending queries to the DNS server.

Data Type

Integer

SocketDNSQueryTimeout Property (SecureBlackbox_SAMLReader Class)

The timeout (in milliseconds) for each DNS query.

Object Oriented Interface

public function getSocketDNSQueryTimeout();


public function setSocketDNSQueryTimeout($value);

Procedural Interface

secureblackbox_samlreader_get($res, 257 );


secureblackbox_samlreader_set($res, 257, $value );

Default Value

0

Remarks

The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.

Data Type

Integer

SocketDNSServers Property (SecureBlackbox_SAMLReader Class)

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Object Oriented Interface

public function getSocketDNSServers();


public function setSocketDNSServers($value);

Procedural Interface

secureblackbox_samlreader_get($res, 258 );


secureblackbox_samlreader_set($res, 258, $value );

Default Value

''

Remarks

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Data Type

String

SocketDNSTotalTimeout Property (SecureBlackbox_SAMLReader Class)

The timeout (in milliseconds) for the whole resolution process.

Object Oriented Interface

public function getSocketDNSTotalTimeout();


public function setSocketDNSTotalTimeout($value);

Procedural Interface

secureblackbox_samlreader_get($res, 259 );


secureblackbox_samlreader_set($res, 259, $value );

Default Value

0

Remarks

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.

Data Type

Integer

SocketIncomingSpeedLimit Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getSocketIncomingSpeedLimit();


public function setSocketIncomingSpeedLimit($value);

Procedural Interface

secureblackbox_samlreader_get($res, 260 );


secureblackbox_samlreader_set($res, 260, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (SecureBlackbox_SAMLReader Class)

The local network interface to bind the socket to.

Object Oriented Interface

public function getSocketLocalAddress();


public function setSocketLocalAddress($value);

Procedural Interface

secureblackbox_samlreader_get($res, 261 );


secureblackbox_samlreader_set($res, 261, $value );

Default Value

''

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SecureBlackbox_SAMLReader Class)

The local port number to bind the socket to.

Object Oriented Interface

public function getSocketLocalPort();


public function setSocketLocalPort($value);

Procedural Interface

secureblackbox_samlreader_get($res, 262 );


secureblackbox_samlreader_set($res, 262, $value );

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getSocketOutgoingSpeedLimit();


public function setSocketOutgoingSpeedLimit($value);

Procedural Interface

secureblackbox_samlreader_get($res, 263 );


secureblackbox_samlreader_set($res, 263, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getSocketTimeout();


public function setSocketTimeout($value);

Procedural Interface

secureblackbox_samlreader_get($res, 264 );


secureblackbox_samlreader_set($res, 264, $value );

Default Value

60000

Remarks

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

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

Data Type

Integer

SocketUseIPv6 Property (SecureBlackbox_SAMLReader Class)

Enables or disables IP protocol version 6.

Object Oriented Interface

public function getSocketUseIPv6();


public function setSocketUseIPv6($value);

Procedural Interface

secureblackbox_samlreader_get($res, 265 );


secureblackbox_samlreader_set($res, 265, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

StatementCount Property (SecureBlackbox_SAMLReader Class)

The number of records in the Statement arrays.

Object Oriented Interface

public function getStatementCount();

Procedural Interface

secureblackbox_samlreader_get($res, 266 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• StatementAuthnContextAuthenticatingAuthorities
• StatementAuthnContextChoice
• StatementAuthnContextClassRef
• StatementAuthnContextDecl
• StatementAuthnContextDeclRef
• StatementAuthnInstant
• StatementAuthnSessionIndex
• StatementAuthnSessionNotOnOrAfter
• StatementAuthnSubjectLocalityAddress
• StatementAuthnSubjectLocalityDNSName
• StatementAuthzActions
• StatementAuthzDecision
• StatementAuthzDecisionEvidence
• StatementAuthzDecisionResource
• StatementStatementType

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

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

Data Type

Integer

StatementAuthnContextAuthenticatingAuthorities Property (SecureBlackbox_SAMLReader Class)

Contains the list of authenticating authorities.

Object Oriented Interface

public function getStatementAuthnContextAuthenticatingAuthorities($statementindex);

Procedural Interface

secureblackbox_samlreader_get($res, 267 , $statementindex);

Default Value

''

Remarks

Contains the list of authenticating authorities.

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

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

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

Data Type

String

StatementAuthnContextChoice Property (SecureBlackbox_SAMLReader Class)

Specifies the authentication context choice variant.

Object Oriented Interface

public function getStatementAuthnContextChoice($statementindex);

Procedural Interface

secureblackbox_samlreader_get($res, 268 , $statementindex);

Default Value

''

Remarks

Specifies the authentication context choice variant.

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

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

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

Data Type

String

StatementAuthnContextClassRef Property (SecureBlackbox_SAMLReader Class)

Indicates the authentication contexts class reference.

Object Oriented Interface

public function getStatementAuthnContextClassRef($statementindex);

Procedural Interface

secureblackbox_samlreader_get($res, 269 , $statementindex);

Default Value

''

Remarks

Indicates the authentication contexts class reference.

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

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

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

Data Type

String

StatementAuthnContextDecl Property (SecureBlackbox_SAMLReader Class)

Specifies the authentication contexts declaration.

Object Oriented Interface

public function getStatementAuthnContextDecl($statementindex);

Procedural Interface

secureblackbox_samlreader_get($res, 270 , $statementindex);

Default Value

''

Remarks

Specifies the authentication contexts declaration.

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

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

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

Data Type

String

StatementAuthnContextDeclRef Property (SecureBlackbox_SAMLReader Class)

Specifies the authentication contexts declaration reference.

Object Oriented Interface

public function getStatementAuthnContextDeclRef($statementindex);

Procedural Interface

secureblackbox_samlreader_get($res, 271 , $statementindex);

Default Value

''

Remarks

Specifies the authentication contexts declaration reference.

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

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

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

Data Type

String

StatementAuthnInstant Property (SecureBlackbox_SAMLReader Class)

Specifies the authentication event timestamp.

Object Oriented Interface

public function getStatementAuthnInstant($statementindex);

Procedural Interface

secureblackbox_samlreader_get($res, 272 , $statementindex);

Default Value

''

Remarks

Specifies the authentication event timestamp.

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

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

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

Data Type

String

StatementAuthnSessionIndex Property (SecureBlackbox_SAMLReader Class)

Contains the authentication session index.

Object Oriented Interface

public function getStatementAuthnSessionIndex($statementindex);

Procedural Interface

secureblackbox_samlreader_get($res, 273 , $statementindex);

Default Value

''

Remarks

Contains the authentication session index.

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

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

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

Data Type

String

StatementAuthnSessionNotOnOrAfter Property (SecureBlackbox_SAMLReader Class)

Maps to the SessionNotOnOrAfter parameter of the authentication statement.

Object Oriented Interface

public function getStatementAuthnSessionNotOnOrAfter($statementindex);

Procedural Interface

secureblackbox_samlreader_get($res, 274 , $statementindex);

Default Value

''

Remarks

Maps to the SessionNotOnOrAfter parameter of the authentication statement.

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

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

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

Data Type

String

StatementAuthnSubjectLocalityAddress Property (SecureBlackbox_SAMLReader Class)

Specifies the authentication subjects address.

Object Oriented Interface

public function getStatementAuthnSubjectLocalityAddress($statementindex);

Procedural Interface

secureblackbox_samlreader_get($res, 275 , $statementindex);

Default Value

''

Remarks

Specifies the authentication subjects address.

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

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

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

Data Type

String

StatementAuthnSubjectLocalityDNSName Property (SecureBlackbox_SAMLReader Class)

Maps to the authentication subjects DNS name parameter.

Object Oriented Interface

public function getStatementAuthnSubjectLocalityDNSName($statementindex);

Procedural Interface

secureblackbox_samlreader_get($res, 276 , $statementindex);

Default Value

''

Remarks

Maps to the authentication subjects DNS name parameter.

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

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

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

Data Type

String

StatementAuthzActions Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getStatementAuthzActions($statementindex);

Procedural Interface

secureblackbox_samlreader_get($res, 277 , $statementindex);

Default Value

''

Remarks

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

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

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

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

Data Type

String

StatementAuthzDecision Property (SecureBlackbox_SAMLReader Class)

Specifies the authorization decision.

Object Oriented Interface

public function getStatementAuthzDecision($statementindex);

Procedural Interface

secureblackbox_samlreader_get($res, 278 , $statementindex);

Default Value

0

Remarks

Specifies the authorization decision.

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

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

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

Data Type

Integer

StatementAuthzDecisionEvidence Property (SecureBlackbox_SAMLReader Class)

Manages the authorization decision statement evidence parameter.

Object Oriented Interface

public function getStatementAuthzDecisionEvidence($statementindex);

Procedural Interface

secureblackbox_samlreader_get($res, 279 , $statementindex);

Default Value

''

Remarks

Manages the authorization decision statement evidence parameter.

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

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

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

Data Type

String

StatementAuthzDecisionResource Property (SecureBlackbox_SAMLReader Class)

Specifies the authorization decision statement resource parameter.

Object Oriented Interface

public function getStatementAuthzDecisionResource($statementindex);

Procedural Interface

secureblackbox_samlreader_get($res, 280 , $statementindex);

Default Value

''

Remarks

Specifies the authorization decision statement resource parameter.

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

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

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

Data Type

String

StatementStatementType Property (SecureBlackbox_SAMLReader Class)

Specifies the assertion statement type.

Object Oriented Interface

public function getStatementStatementType($statementindex);

Procedural Interface

secureblackbox_samlreader_get($res, 281 , $statementindex);

Default Value

0

Remarks

Specifies the assertion statement type.

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

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

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

Data Type

Integer

SubjectConfirmationCount Property (SecureBlackbox_SAMLReader Class)

The number of records in the SubjectConfirmation arrays.

Object Oriented Interface

public function getSubjectConfirmationCount();

Procedural Interface

secureblackbox_samlreader_get($res, 282 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SubjectConfirmationAddress
• SubjectConfirmationData
• SubjectConfirmationDataType
• SubjectConfirmationID
• SubjectConfirmationInResponseTo
• SubjectConfirmationMethod
• SubjectConfirmationNotBefore
• SubjectConfirmationNotOnOrAfter
• SubjectConfirmationRecipient

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

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

Data Type

Integer

SubjectConfirmationAddress Property (SecureBlackbox_SAMLReader Class)

Contains the address enabled for presenting assertions.

Object Oriented Interface

public function getSubjectConfirmationAddress($subjectconfirmationindex);

Procedural Interface

secureblackbox_samlreader_get($res, 283 , $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 read-only and not available at design time.

Data Type

String

SubjectConfirmationData Property (SecureBlackbox_SAMLReader Class)

The uninterpreted value of data entry in the subject confirmation.

Object Oriented Interface

public function getSubjectConfirmationData($subjectconfirmationindex);

Procedural Interface

secureblackbox_samlreader_get($res, 284 , $subjectconfirmationindex);

Default Value

''

Remarks

The uninterpreted value of data entry in the subject confirmation.

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

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

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

Data Type

String

SubjectConfirmationDataType Property (SecureBlackbox_SAMLReader Class)

The type of data contained in the confirmation.

Object Oriented Interface

public function getSubjectConfirmationDataType($subjectconfirmationindex);

Procedural Interface

secureblackbox_samlreader_get($res, 285 , $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 read-only and not available at design time.

Data Type

String

SubjectConfirmationID Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getSubjectConfirmationID($subjectconfirmationindex);

Procedural Interface

secureblackbox_samlreader_get($res, 286 , $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 read-only and not available at design time.

Data Type

String

SubjectConfirmationInResponseTo Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getSubjectConfirmationInResponseTo($subjectconfirmationindex);

Procedural Interface

secureblackbox_samlreader_get($res, 287 , $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 read-only and not available at design time.

Data Type

String

SubjectConfirmationMethod Property (SecureBlackbox_SAMLReader Class)

Specifies the mechanism to be used to confirm the subject.

Object Oriented Interface

public function getSubjectConfirmationMethod($subjectconfirmationindex);

Procedural Interface

secureblackbox_samlreader_get($res, 288 , $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 read-only and not available at design time.

Data Type

String

SubjectConfirmationNotBefore Property (SecureBlackbox_SAMLReader Class)

Time moment before which the subject cannot be confirmed.

Object Oriented Interface

public function getSubjectConfirmationNotBefore($subjectconfirmationindex);

Procedural Interface

secureblackbox_samlreader_get($res, 289 , $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 read-only and not available at design time.

Data Type

String

SubjectConfirmationNotOnOrAfter Property (SecureBlackbox_SAMLReader Class)

Limits the time until which the subject can be confirmed.

Object Oriented Interface

public function getSubjectConfirmationNotOnOrAfter($subjectconfirmationindex);

Procedural Interface

secureblackbox_samlreader_get($res, 290 , $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 read-only and not available at design time.

Data Type

String

SubjectConfirmationRecipient Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getSubjectConfirmationRecipient($subjectconfirmationindex);

Procedural Interface

secureblackbox_samlreader_get($res, 291 , $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 read-only and not available at design time.

Data Type

String

TLSAutoValidateCertificates Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getTLSAutoValidateCertificates();


public function setTLSAutoValidateCertificates($value);

Procedural Interface

secureblackbox_samlreader_get($res, 292 );


secureblackbox_samlreader_set($res, 292, $value );

Default Value

true

Remarks

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

Data Type

Boolean

TLSBaseConfiguration Property (SecureBlackbox_SAMLReader Class)

Selects the base configuration for the TLS settings.

Object Oriented Interface

public function getTLSBaseConfiguration();


public function setTLSBaseConfiguration($value);

Procedural Interface

secureblackbox_samlreader_get($res, 293 );


secureblackbox_samlreader_set($res, 293, $value );

Default Value

0

Remarks

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

Data Type

Integer

TLSCiphersuites Property (SecureBlackbox_SAMLReader Class)

A list of ciphersuites separated with commas or semicolons.

Object Oriented Interface

public function getTLSCiphersuites();


public function setTLSCiphersuites($value);

Procedural Interface

secureblackbox_samlreader_get($res, 294 );


secureblackbox_samlreader_set($res, 294, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

TLSClientAuth Property (SecureBlackbox_SAMLReader Class)

Enables or disables certificate-based client authentication.

Object Oriented Interface

public function getTLSClientAuth();


public function setTLSClientAuth($value);

Procedural Interface

secureblackbox_samlreader_get($res, 295 );


secureblackbox_samlreader_set($res, 295, $value );

Default Value

0

Remarks

Enables or disables certificate-based client authentication.

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

Data Type

Integer

TLSECCurves Property (SecureBlackbox_SAMLReader Class)

Defines the elliptic curves to enable.

Object Oriented Interface

public function getTLSECCurves();


public function setTLSECCurves($value);

Procedural Interface

secureblackbox_samlreader_get($res, 296 );


secureblackbox_samlreader_set($res, 296, $value );

Default Value

''

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SecureBlackbox_SAMLReader Class)

Provides access to TLS extensions.

Object Oriented Interface

public function getTLSExtensions();


public function setTLSExtensions($value);

Procedural Interface

secureblackbox_samlreader_get($res, 297 );


secureblackbox_samlreader_set($res, 297, $value );

Default Value

''

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getTLSForceResumeIfDestinationChanges();


public function setTLSForceResumeIfDestinationChanges($value);

Procedural Interface

secureblackbox_samlreader_get($res, 298 );


secureblackbox_samlreader_set($res, 298, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getTLSPreSharedIdentity();


public function setTLSPreSharedIdentity($value);

Procedural Interface

secureblackbox_samlreader_get($res, 299 );


secureblackbox_samlreader_set($res, 299, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

TLSPreSharedKey Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getTLSPreSharedKey();


public function setTLSPreSharedKey($value);

Procedural Interface

secureblackbox_samlreader_get($res, 300 );


secureblackbox_samlreader_set($res, 300, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

TLSPreSharedKeyCiphersuite Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getTLSPreSharedKeyCiphersuite();


public function setTLSPreSharedKeyCiphersuite($value);

Procedural Interface

secureblackbox_samlreader_get($res, 301 );


secureblackbox_samlreader_set($res, 301, $value );

Default Value

''

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SecureBlackbox_SAMLReader Class)

Selects the renegotiation attack prevention mechanism.

Object Oriented Interface

public function getTLSRenegotiationAttackPreventionMode();


public function setTLSRenegotiationAttackPreventionMode($value);

Procedural Interface

secureblackbox_samlreader_get($res, 302 );


secureblackbox_samlreader_set($res, 302, $value );

Default Value

2

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getTLSRevocationCheck();


public function setTLSRevocationCheck($value);

Procedural Interface

secureblackbox_samlreader_get($res, 303 );


secureblackbox_samlreader_set($res, 303, $value );

Default Value

1

Remarks

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

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

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

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

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

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

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

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getTLSSSLOptions();


public function setTLSSSLOptions($value);

Procedural Interface

secureblackbox_samlreader_get($res, 304 );


secureblackbox_samlreader_set($res, 304, $value );

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (SecureBlackbox_SAMLReader Class)

Specifies the TLS mode to use.

Object Oriented Interface

public function getTLSTLSMode();


public function setTLSTLSMode($value);

Procedural Interface

secureblackbox_samlreader_get($res, 305 );


secureblackbox_samlreader_set($res, 305, $value );

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SecureBlackbox_SAMLReader Class)

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

Object Oriented Interface

public function getTLSUseExtendedMasterSecret();


public function setTLSUseExtendedMasterSecret($value);

Procedural Interface

secureblackbox_samlreader_get($res, 306 );


secureblackbox_samlreader_set($res, 306, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (SecureBlackbox_SAMLReader Class)

Enables or disables the TLS session resumption capability.

Object Oriented Interface

public function getTLSUseSessionResumption();


public function setTLSUseSessionResumption($value);

Procedural Interface

secureblackbox_samlreader_get($res, 307 );


secureblackbox_samlreader_set($res, 307, $value );

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SecureBlackbox_SAMLReader Class)

The SSL/TLS versions to enable by default.

Object Oriented Interface

public function getTLSVersions();


public function setTLSVersions($value);

Procedural Interface

secureblackbox_samlreader_get($res, 308 );


secureblackbox_samlreader_set($res, 308, $value );

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

UseBinding Property (SecureBlackbox_SAMLReader Class)

Enables or disables automated binding processing.

Object Oriented Interface

public function getUseBinding();


public function setUseBinding($value);

Procedural Interface

secureblackbox_samlreader_get($res, 309 );


secureblackbox_samlreader_set($res, 309, $value );

Default Value

false

Remarks

This property controls whether class should process any known bindings it encounters in the message automatically. If using this property, check Binding property to establish the type of the binding processed, and Binding to access the properties of specific binding types.

This property is not available at design time.

Data Type

Boolean

ValidateSignatures Property (SecureBlackbox_SAMLReader Class)

Enables or disables automated signature validation.

Object Oriented Interface

public function getValidateSignatures();


public function setValidateSignatures($value);

Procedural Interface

secureblackbox_samlreader_get($res, 310 );


secureblackbox_samlreader_set($res, 310, $value );

Default Value

true

Remarks

Use this property to enable or disable automated signature validation by the component.

This property is not available at design time.

Data Type

Boolean

CompareIDs Method (SecureBlackbox_SAMLReader Class)

Compares two SAML IDs.

Object Oriented Interface

public function doCompareIDs($id1, $id2);

Procedural Interface

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

Remarks

Use this utility function to easily compare two SAML IDs.

Config Method (SecureBlackbox_SAMLReader Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

DoAction Method (SecureBlackbox_SAMLReader Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_samlreader_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_SAMLReader Class)

Extracts a specific property from a SAML ID.

Object Oriented Interface

public function doGetIDProp($id, $propname);

Procedural Interface

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

Remarks

Use this method to recover a single ID property from a SAML ID.

PropName supports the following properties:

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

Open Method (SecureBlackbox_SAMLReader Class)

Opens a SAML entity.

Object Oriented Interface

public function doOpen($input);

Procedural Interface

secureblackbox_samlreader_do_open($res, $input);

Remarks

Use this method to process a SAML entity contained in a string.

OpenBytes Method (SecureBlackbox_SAMLReader Class)

Opens a SAML entity.

Object Oriented Interface

public function doOpenBytes($inputbytes);

Procedural Interface

secureblackbox_samlreader_do_openbytes($res, $inputbytes);

Remarks

Use this method to process a SAML entity stored as a byte array.

OpenFile Method (SecureBlackbox_SAMLReader Class)

Opens a SAML entity.

Object Oriented Interface

public function doOpenFile($inputfile);

Procedural Interface

secureblackbox_samlreader_do_openfile($res, $inputfile);

Remarks

Use this method to process a SAML entity contained in a file.

PinAssertion Method (SecureBlackbox_SAMLReader Class)

Pins assertion by propagating it in PinnedAssertionXXX properties.

Object Oriented Interface

public function doPinAssertion($assertionindex);

Procedural Interface

secureblackbox_samlreader_do_pinassertion($res, $assertionindex);

Remarks

Use this method to pin a SAML assertion specified by its AssertionIndex in the selection of PinnedAssertionXXX properties, such as PinnedAssertion.

Check AssertionCount to obtain the number of assertions in the message.

Reset Method (SecureBlackbox_SAMLReader Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_samlreader_do_reset($res);

Remarks

Reset is a generic method available in every class.

Encrypted Event (SecureBlackbox_SAMLReader Class)

Notifies the application that the assertion is encrypted and provides recipient certificate details.

Object Oriented Interface

public function fireEncrypted($param);

Procedural Interface

secureblackbox_samlreader_register_callback($res, 1, array($this, 'fireEncrypted'));

Parameter List

 'issuerrdn'
 'serialnumber'
 'subjectkeyid'
 'needcredential'
 'skipthis'

Remarks

The class fires this event when processing encrypted documents to report the fact of encryption and pass certificate parameters to the user.

This event fires repeatedly for each encryption mechanism used in the document until the user provides the correct credential via the DecryptionCertificate property (depending on encryption method used), or sets SkipThis to true.

The IssuerRDN, SerialNumber, and SubjectKeyID parameters provide the details of the encryption certificate. Note that the document can be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate will invoke its own OnEncrypted event loop.

The NeedCredential parameter specifies whether the correct credential is already available to the class or still needs to be set. One example where NeedCredential would be set to false is where it had been provided by the application prior to processing the document (e.g. by setting the DecryptionCertificate property to a known pre-defined value). If NeedCredential is set to true, you must provide the valid credential for the decryption process to succeed.

Error Event (SecureBlackbox_SAMLReader Class)

Fires to report an error condition.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_samlreader_register_callback($res, 2, 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_SAMLReader Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_samlreader_register_callback($res, 3, 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.

SignatureFound Event (SecureBlackbox_SAMLReader Class)

Signifies the start of signature validation.

Object Oriented Interface

public function fireSignatureFound($param);

Procedural Interface

secureblackbox_samlreader_register_callback($res, 4, array($this, 'fireSignatureFound'));

Parameter List

 'scope'
 'issuerrdn'
 'serialnumber'
 'subjectkeyid'
 'certfound'
 'validate'

Remarks

This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified message.

The Scope parameter specifies the subject of the signature. This can be the outermost SAML message or an embedded assertion.

The details of the reported signature are populated in the Security object. For assertion signatures, you can update the details by pinning the assertion.

The CertFound is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via KnownCertificates property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. SAMLReader only supports signature validation. To validate the chain, grab the signing certificate from the SigningCertificate property and the associated certificates from the Certificates collection, and pass them to the CertificateValidator component to validate its chain.

Use the Validate parameter to tell the reader whether it should validate the signature.

SignatureValidated Event (SecureBlackbox_SAMLReader Class)

Reports the signature validation result.

Object Oriented Interface

public function fireSignatureValidated($param);

Procedural Interface

secureblackbox_samlreader_register_callback($res, 5, array($this, 'fireSignatureValidated'));

Parameter List

 'scope'
 'issuerrdn'
 'serialnumber'
 'subjectkeyid'
 'validationresult'

Remarks

This event is fired when the complete XML signature validation process is finished.

The Scope parameter specifies the subject of the signature. This can be the outermost SAML message or an embedded assertion.

IssuerRDN returns the name of the signature issuer, SerialNumber identifies the signing certificate, SubjectKeyID contains the key identifier (SecureBlackbox uses SHA-1 hash algorithm output as key identifiers). Finally, ValidationResult specifies whether signature is valid or not:

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

SAMLReader Config Settings

Base Config Settings

Trappable Errors (SAMLReader Class)