# SAMLReader Class The SAMLReader class offers SAML message processing functionality. ## Class Name **SecureBlackbox_SAMLReader** ## Procedural Interface ```text 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](#open-method-secureblackbox_samlreader-class) (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](#pinassertion-method-secureblackbox_samlreader-class) 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](#samlreader-class) example (or by any compatible SAML endpoint). The input SAML message has the following look: ```text https://issuer-url.com +xhhgXtwYN0/r9h7WAwg= jfYeIq/z8D1tJZYbVqDMoqKpdrfGMj8/zI7gbUsJbECAr00cN34md2QG0mo4cOx7pny+5 Tht7tUzqENHqcZdmlOcZc2JcJqokVxIcLEluFiWKlNjpexkXFQKzOC1peRfTZm8SQTqtP Cz8IknLUc6Scfml29PHmks1PxjJDteGb/+FggsZRTGZC3a05nvH3ayvHukPeHuHssx5dX nj0quT8salR6fdx6lAJo/AnDHzcfBNyxAMn+ebk5VOOgVD1L3PayvXib/maj8aVI2I5UT o4vmfybTWKzeS8DX9We7UV+4Xowwe647t1A912xLVub/e23A18Yf1V0PXC87kttTkA== 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 ``` You can process this message and access its properties with the following code: ```text 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.* | | | | --- | --- | | [ArtifactEndpointIndex](#artifactendpointindex-property-secureblackbox_samlreader-class) | An accessor to the EndpointIndex entry of the artifact. | | [ArtifactMessageHandle](#artifactmessagehandle-property-secureblackbox_samlreader-class) | An accessor to the MessageHandle property of the artifact. | | [ArtifactRemainingArtifact](#artifactremainingartifact-property-secureblackbox_samlreader-class) | Returns the contents of the artifact. | | [ArtifactSourceID](#artifactsourceid-property-secureblackbox_samlreader-class) | An accessor to the SourceID property of the artifact. | | [ArtifactTypeCode](#artifacttypecode-property-secureblackbox_samlreader-class) | The TypeCode property of the artifact. | | [ArtifactURI](#artifacturi-property-secureblackbox_samlreader-class) | An accessor to the URI property of the artifact. | | [ArtifactResolveQuery](#artifactresolvequery-property-secureblackbox_samlreader-class) | Returns the content of the ArtifactResolve query. | | [AssertionCount](#assertioncount-property-secureblackbox_samlreader-class) | Returns the number of assertions in the SAML message. | | [AttributeCount](#attributecount-property-secureblackbox_samlreader-class) | The number of records in the Attribute arrays. | | [AttributeFriendlyName](#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. | | [AttributeName](#attributename-property-secureblackbox_samlreader-class) | Specifies the name of the attribute. | | [AttributeNameFormat](#attributenameformat-property-secureblackbox_samlreader-class) | Indicates the format used to reference the attribute. | | [AttributeStatementIndex](#attributestatementindex-property-secureblackbox_samlreader-class) | Contains the index of the statement the attribute corresponds to. | | [AttributeValues](#attributevalues-property-secureblackbox_samlreader-class) | Contains a list of attribute values. | | [AuthnQueryComparison](#authnquerycomparison-property-secureblackbox_samlreader-class) | Specifies the authentication context comparison method. | | [AuthnQueryContextClassRefs](#authnquerycontextclassrefs-property-secureblackbox_samlreader-class) | Specifies the context class reference. | | [AuthnQueryRefType](#authnqueryreftype-property-secureblackbox_samlreader-class) | Specifies the context reference type. | | [AuthnQuerySessionIndex](#authnquerysessionindex-property-secureblackbox_samlreader-class) | Specifies the index of the session to the authentication entity. | | [AuthnRequestAssertionConsumerServiceIndex](#authnrequestassertionconsumerserviceindex-property-secureblackbox_samlreader-class) | Specifies the assertion consumer service index. | | [AuthnRequestAssertionConsumerServiceURL](#authnrequestassertionconsumerserviceurl-property-secureblackbox_samlreader-class) | Specifies the assertion consumer service URL. | | [AuthnRequestAttributeConsumingServiceIndex](#authnrequestattributeconsumingserviceindex-property-secureblackbox_samlreader-class) | Specifies the attribute consuming service index. | | [AuthnRequestContextClassRefs](#authnrequestcontextclassrefs-property-secureblackbox_samlreader-class) | Provides access to the authentication context class references. | | [AuthnRequestContextComparison](#authnrequestcontextcomparison-property-secureblackbox_samlreader-class) | Specifies the AuthnContext comparison method. | | [AuthnRequestContextRefType](#authnrequestcontextreftype-property-secureblackbox_samlreader-class) | Specifies the context reference type. | | [AuthnRequestFlags](#authnrequestflags-property-secureblackbox_samlreader-class) | Adjusts secondary serialization properties. | | [AuthnRequestForceAuthn](#authnrequestforceauthn-property-secureblackbox_samlreader-class) | Corresponds to the ForceAuthn parameter of the request. | | [AuthnRequestIsPassive](#authnrequestispassive-property-secureblackbox_samlreader-class) | Maps to the IsPassive parameter of the request. | | [AuthnRequestNameIDPolicyAllowCreate](#authnrequestnameidpolicyallowcreate-property-secureblackbox_samlreader-class) | Matches the AllowCreate attribute of NameIDPolicy element of the request. | | [AuthnRequestNameIDPolicyFormat](#authnrequestnameidpolicyformat-property-secureblackbox_samlreader-class) | Matches to the Format attribute of the NameIDPolicy element of the request. | | [AuthnRequestNameIDPolicySPNameQualifier](#authnrequestnameidpolicyspnamequalifier-property-secureblackbox_samlreader-class) | Matches to the SP name qualifier attribute of the request. | | [AuthnRequestProtocolBinding](#authnrequestprotocolbinding-property-secureblackbox_samlreader-class) | Specifies the protocol binding to be requested in the authentication request. | | [AuthnRequestProviderName](#authnrequestprovidername-property-secureblackbox_samlreader-class) | Specifies the name of the requestor. | | [AuthnRequestScopingGetComplete](#authnrequestscopinggetcomplete-property-secureblackbox_samlreader-class) | Matches the GetComplete element of the IDPList entry of the Scoping object. | | [AuthnRequestScopingProxyCount](#authnrequestscopingproxycount-property-secureblackbox_samlreader-class) | The maximum number of proxies on the way between the requestor and the provider. | | [AuthnRequestScopingRequesterIDs](#authnrequestscopingrequesterids-property-secureblackbox_samlreader-class) | A collection of requestor IDs on whose behalf the request is being sent. | | [AuthzDecisionQueryActions](#authzdecisionqueryactions-property-secureblackbox_samlreader-class) | Specifies the list of actions included in the query. | | [AuthzDecisionQueryResource](#authzdecisionqueryresource-property-secureblackbox_samlreader-class) | Matches the Resource element of the query. | | [BindingType](#bindingtype-property-secureblackbox_samlreader-class) | Specifies the type of SAML binding to use. | | [BindingBody](#bindingbody-property-secureblackbox_samlreader-class) | Contains the POST binding form body. | | [BindingEncoding](#bindingencoding-property-secureblackbox_samlreader-class) | Specifies the message encoding. | | [BindingForceSign](#bindingforcesign-property-secureblackbox_samlreader-class) | Enforces a signature over all outgoing messages. | | [BindingFormTemplate](#bindingformtemplate-property-secureblackbox_samlreader-class) | Contains the XHTML form template returned by the service provider. | | [BindingPOSTMode](#bindingpostmode-property-secureblackbox_samlreader-class) | Specifies whether binding is applied on the server, or on the client side. | | [BindingRelayState](#bindingrelaystate-property-secureblackbox_samlreader-class) | Contains the RelayState parameter of the binding. | | [BindingSignatureAlgorithm](#bindingsignaturealgorithm-property-secureblackbox_samlreader-class) | Contains the signature algorithm. | | [BindingSignatureValidationResult](#bindingsignaturevalidationresult-property-secureblackbox_samlreader-class) | The outcome of the cryptographic signature validation. | | [BindingSigned](#bindingsigned-property-secureblackbox_samlreader-class) | Specifies whether to sign the binding. | | [BindingURL](#bindingurl-property-secureblackbox_samlreader-class) | Contains the URL of the request query. | | [BindingVerifySignatures](#bindingverifysignatures-property-secureblackbox_samlreader-class) | Instructs the class whether to verify incoming signatures. | | [BindingKeyHandle](#bindingkeyhandle-property-secureblackbox_samlreader-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [CertCount](#certcount-property-secureblackbox_samlreader-class) | The number of records in the Cert arrays. | | [CertBytes](#certbytes-property-secureblackbox_samlreader-class) | Returns the raw certificate data in DER format. | | [CertHandle](#certhandle-property-secureblackbox_samlreader-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [ConditionCount](#conditioncount-property-secureblackbox_samlreader-class) | The number of records in the Condition arrays. | | [Condition](#condition-property-secureblackbox_samlreader-class) | The condition set in accordance with the ConditionType . | | [ConditionType](#conditiontype-property-secureblackbox_samlreader-class) | Specifies a type of the condition object. | | [DecryptionCertificateBytes](#decryptioncertificatebytes-property-secureblackbox_samlreader-class) | Returns the raw certificate data in DER format. | | [DecryptionCertificateHandle](#decryptioncertificatehandle-property-secureblackbox_samlreader-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [FIPSMode](#fipsmode-property-secureblackbox_samlreader-class) | Reserved. | | [LogoutRequestNameID](#logoutrequestnameid-property-secureblackbox_samlreader-class) | Contains the value of the NameID parameter. | | [LogoutRequestNotOnOrAfter](#logoutrequestnotonorafter-property-secureblackbox_samlreader-class) | Contains the value of the NotOnOrAfter parameter. | | [LogoutRequestReason](#logoutrequestreason-property-secureblackbox_samlreader-class) | Contains the value of the Reason parameter. | | [LogoutRequestSessionIndexes](#logoutrequestsessionindexes-property-secureblackbox_samlreader-class) | Contains the list of session indices. | | [ManageNameIDRequestNameID](#managenameidrequestnameid-property-secureblackbox_samlreader-class) | Contains the value of the NameID parameter of the request. | | [ManageNameIDRequestNewEncryptedID](#managenameidrequestnewencryptedid-property-secureblackbox_samlreader-class) | Contains the value of the NewEncryptedID parameter of the request. | | [ManageNameIDRequestNewID](#managenameidrequestnewid-property-secureblackbox_samlreader-class) | Contains the value of the NewID parameter. | | [ManageNameIDRequestTerminate](#managenameidrequestterminate-property-secureblackbox_samlreader-class) | Contains the value of the Terminate parameter of the request. | | [MessageConsent](#messageconsent-property-secureblackbox_samlreader-class) | Contains the Consent parameter of the SAML message. | | [MessageContentType](#messagecontenttype-property-secureblackbox_samlreader-class) | Returns the SAML type of the current message. | | [MessageContentTypeString](#messagecontenttypestring-property-secureblackbox_samlreader-class) | Returns the type of the processed message, as an original string. | | [MessageDestination](#messagedestination-property-secureblackbox_samlreader-class) | Contains the Destination parameter of the SAML message. | | [MessageID](#messageid-property-secureblackbox_samlreader-class) | The ID of the request. | | [MessageInResponseTo](#messageinresponseto-property-secureblackbox_samlreader-class) | Contains the InResponseTo property of the SAML request. | | [MessageIssueInstant](#messageissueinstant-property-secureblackbox_samlreader-class) | Contains request issuance timestamp. | | [MessageIssuer](#messageissuer-property-secureblackbox_samlreader-class) | Sets the issuer of the message. | | [MessageSignatureValidationResult](#messagesignaturevalidationresult-property-secureblackbox_samlreader-class) | The outcome of the cryptographic signature validation. | | [MessageSigned](#messagesigned-property-secureblackbox_samlreader-class) | Specifies whether the SAML message is or should be signed. | | [MessageSubject](#messagesubject-property-secureblackbox_samlreader-class) | Gets or sets the subject of the message. | | [MessageVersion](#messageversion-property-secureblackbox_samlreader-class) | Specifies the protocol version to use for the SAML message. | | [MessageXMLHeader](#messagexmlheader-property-secureblackbox_samlreader-class) | Controls the inclusion of an XML header in the message. | | [NameIDMappingRequestNameID](#nameidmappingrequestnameid-property-secureblackbox_samlreader-class) | An accessor to the NameID parameter of the request. | | [NameIDMappingRequestNameIDPolicyAllowCreate](#nameidmappingrequestnameidpolicyallowcreate-property-secureblackbox_samlreader-class) | Contains the value of AllowCreate parameter of the NameIDPolicy object. | | [NameIDMappingRequestNameIDPolicyFormat](#nameidmappingrequestnameidpolicyformat-property-secureblackbox_samlreader-class) | Specifies the format of the NameIDPolicy element. | | [NameIDMappingRequestNameIDPolicySPNameQualifier](#nameidmappingrequestnameidpolicyspnamequalifier-property-secureblackbox_samlreader-class) | Contains the SPNameQualifier parameter of the NameIDPolicy element. | | [NameIDMappingRequestNameIDPolicyUseAllowCreate](#nameidmappingrequestnameidpolicyuseallowcreate-property-secureblackbox_samlreader-class) | Controls inclusion of UseAllow modifier in the NameIDPolicy object. | | [PinnedAssertionAssertionType](#pinnedassertionassertiontype-property-secureblackbox_samlreader-class) | Specifies the type of the assertion. | | [PinnedAssertionEncryptedContent](#pinnedassertionencryptedcontent-property-secureblackbox_samlreader-class) | Represents the encrypted assertion content. | | [PinnedAssertionID](#pinnedassertionid-property-secureblackbox_samlreader-class) | Represents the ID of the assertion. | | [PinnedAssertionIDRef](#pinnedassertionidref-property-secureblackbox_samlreader-class) | Represents an ID reference value. | | [PinnedAssertionIssueInstant](#pinnedassertionissueinstant-property-secureblackbox_samlreader-class) | Contains the assertion issuance time stamp. | | [PinnedAssertionIssuer](#pinnedassertionissuer-property-secureblackbox_samlreader-class) | Specifies the assertion issuer. | | [PinnedAssertionParentAssertion](#pinnedassertionparentassertion-property-secureblackbox_samlreader-class) | Contains the index of the parent assertion in the assertion list. | | [PinnedAssertionSignatureValidationResult](#pinnedassertionsignaturevalidationresult-property-secureblackbox_samlreader-class) | The outcome of the cryptographic signature validation. | | [PinnedAssertionSigned](#pinnedassertionsigned-property-secureblackbox_samlreader-class) | Specifies whether the assertion is signed. | | [PinnedAssertionSubject](#pinnedassertionsubject-property-secureblackbox_samlreader-class) | Specifies the assertion subject. | | [PinnedAssertionURIRef](#pinnedassertionuriref-property-secureblackbox_samlreader-class) | Represents an URI reference value. | | [PinnedAssertionVersion](#pinnedassertionversion-property-secureblackbox_samlreader-class) | Specifies the SAML protocol version used. | | [Profile](#profile-property-secureblackbox_samlreader-class) | Specifies a pre-defined profile to apply when creating the signature. | | [ProxyAddress](#proxyaddress-property-secureblackbox_samlreader-class) | The IP address of the proxy server. | | [ProxyAuthentication](#proxyauthentication-property-secureblackbox_samlreader-class) | The authentication type used by the proxy server. | | [ProxyPassword](#proxypassword-property-secureblackbox_samlreader-class) | The password to authenticate to the proxy server. | | [ProxyPort](#proxyport-property-secureblackbox_samlreader-class) | The port on the proxy server to connect to. | | [ProxyType](#proxytype-property-secureblackbox_samlreader-class) | The type of the proxy server. | | [ProxyRequestHeaders](#proxyrequestheaders-property-secureblackbox_samlreader-class) | Contains HTTP request headers for WebTunnel and HTTP proxy. | | [ProxyResponseBody](#proxyresponsebody-property-secureblackbox_samlreader-class) | Contains the HTTP or HTTPS (WebTunnel) proxy response body. | | [ProxyResponseHeaders](#proxyresponseheaders-property-secureblackbox_samlreader-class) | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. | | [ProxyUseIPv6](#proxyuseipv6-property-secureblackbox_samlreader-class) | Specifies whether IPv6 should be used when connecting through the proxy. | | [ProxyUsername](#proxyusername-property-secureblackbox_samlreader-class) | Specifies the username credential for proxy authentication. | | [References](#references-property-secureblackbox_samlreader-class) | Contains the References entry of the SAML AssertionIDRequest message. | | [ResponseNameID](#responsenameid-property-secureblackbox_samlreader-class) | Contains the NameID parameter of a NameIDMapping response. | | [ResponseOptionalElement](#responseoptionalelement-property-secureblackbox_samlreader-class) | An optional message element to be returned with the response. | | [ResponseType](#responsetype-property-secureblackbox_samlreader-class) | Contains the type of the response. | | [ResponseStatus](#responsestatus-property-secureblackbox_samlreader-class) | Gets or sets the status of the response. | | [ResponseStatusCodeSubValue](#responsestatuscodesubvalue-property-secureblackbox_samlreader-class) | The value of the nested StatusCode. | | [ResponseStatusCodeValue](#responsestatuscodevalue-property-secureblackbox_samlreader-class) | Contains the status code value. | | [ResponseStatusDetail](#responsestatusdetail-property-secureblackbox_samlreader-class) | Contains additional information on the status of the request. | | [ResponseStatusMessage](#responsestatusmessage-property-secureblackbox_samlreader-class) | Contains a status message (optional). | | [ScopingIDPCount](#scopingidpcount-property-secureblackbox_samlreader-class) | The number of records in the ScopingIDP arrays. | | [ScopingIDPLoc](#scopingidploc-property-secureblackbox_samlreader-class) | Contains the value of the Loc attribute. | | [ScopingIDPName](#scopingidpname-property-secureblackbox_samlreader-class) | Contains the name of the IdP provider. | | [ScopingIDPProviderID](#scopingidpproviderid-property-secureblackbox_samlreader-class) | Contains the provider ID. | | [SecurityCanonicalizationMethod](#securitycanonicalizationmethod-property-secureblackbox_samlreader-class) | The canonicalization method to use in the signature. | | [SecurityDigestMethod](#securitydigestmethod-property-secureblackbox_samlreader-class) | The digest method to use. | | [SecurityEncryptionMethod](#securityencryptionmethod-property-secureblackbox_samlreader-class) | The encryption method used to encrypt the assertion. | | [SecurityFlags](#securityflags-property-secureblackbox_samlreader-class) | Provides access to secondary security parameters and tweaks. | | [SecuritySigMethod](#securitysigmethod-property-secureblackbox_samlreader-class) | The signature method to use. | | [SecuritySignaturePolicy](#securitysignaturepolicy-property-secureblackbox_samlreader-class) | Specifies the signature validation policy. | | [SigningCertBytes](#signingcertbytes-property-secureblackbox_samlreader-class) | Returns the raw certificate data in DER format. | | [SigningCertCA](#signingcertca-property-secureblackbox_samlreader-class) | Indicates whether the certificate has a CA capability. | | [SigningCertCAKeyID](#signingcertcakeyid-property-secureblackbox_samlreader-class) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. | | [SigningCertCRLDistributionPoints](#signingcertcrldistributionpoints-property-secureblackbox_samlreader-class) | Contains a list of locations of CRL distribution points used to check this certificate's validity. | | [SigningCertCurve](#signingcertcurve-property-secureblackbox_samlreader-class) | Specifies the elliptic curve associated with the certificate's public key. | | [SigningCertFingerprint](#signingcertfingerprint-property-secureblackbox_samlreader-class) | Contains the fingerprint (a hash imprint) of this certificate. | | [SigningCertFriendlyName](#signingcertfriendlyname-property-secureblackbox_samlreader-class) | Contains an associated alias (friendly name) of the certificate. | | [SigningCertHandle](#signingcerthandle-property-secureblackbox_samlreader-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [SigningCertHashAlgorithm](#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). | | [SigningCertIssuer](#signingcertissuer-property-secureblackbox_samlreader-class) | The common name of the certificate issuer (CA), typically a company name. | | [SigningCertIssuerRDN](#signingcertissuerrdn-property-secureblackbox_samlreader-class) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [SigningCertKeyAlgorithm](#signingcertkeyalgorithm-property-secureblackbox_samlreader-class) | Specifies the public key algorithm of this certificate. | | [SigningCertKeyBits](#signingcertkeybits-property-secureblackbox_samlreader-class) | Returns the length of the public key in bits. | | [SigningCertKeyFingerprint](#signingcertkeyfingerprint-property-secureblackbox_samlreader-class) | Returns a SHA1 fingerprint of the public key contained in the certificate. | | [SigningCertKeyUsage](#signingcertkeyusage-property-secureblackbox_samlreader-class) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. | | [SigningCertKeyValid](#signingcertkeyvalid-property-secureblackbox_samlreader-class) | Returns True if the certificate's key is cryptographically valid, and False otherwise. | | [SigningCertOCSPLocations](#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. | | [SigningCertPolicyIDs](#signingcertpolicyids-property-secureblackbox_samlreader-class) | Contains identifiers (OIDs) of the applicable certificate policies. | | [SigningCertPublicKeyBytes](#signingcertpublickeybytes-property-secureblackbox_samlreader-class) | Contains the certificate's public key in DER format. | | [SigningCertSelfSigned](#signingcertselfsigned-property-secureblackbox_samlreader-class) | Indicates whether the certificate is self-signed (root) or signed by an external CA. | | [SigningCertSerialNumber](#signingcertserialnumber-property-secureblackbox_samlreader-class) | Returns the certificate's serial number. | | [SigningCertSigAlgorithm](#signingcertsigalgorithm-property-secureblackbox_samlreader-class) | Indicates the algorithm that was used by the CA to sign this certificate. | | [SigningCertSubject](#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. | | [SigningCertSubjectKeyID](#signingcertsubjectkeyid-property-secureblackbox_samlreader-class) | Contains a unique identifier of the certificate's cryptographic key. | | [SigningCertSubjectRDN](#signingcertsubjectrdn-property-secureblackbox_samlreader-class) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [SigningCertValidFrom](#signingcertvalidfrom-property-secureblackbox_samlreader-class) | The time point at which the certificate becomes valid, in UTC. | | [SigningCertValidTo](#signingcertvalidto-property-secureblackbox_samlreader-class) | The time point at which the certificate expires, in UTC. | | [SocketDNSMode](#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. | | [SocketDNSPort](#socketdnsport-property-secureblackbox_samlreader-class) | Specifies the port number to be used for sending queries to the DNS server. | | [SocketDNSQueryTimeout](#socketdnsquerytimeout-property-secureblackbox_samlreader-class) | The timeout (in milliseconds) for each DNS query. | | [SocketDNSServers](#socketdnsservers-property-secureblackbox_samlreader-class) | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. | | [SocketDNSTotalTimeout](#socketdnstotaltimeout-property-secureblackbox_samlreader-class) | The timeout (in milliseconds) for the whole resolution process. | | [SocketIncomingSpeedLimit](#socketincomingspeedlimit-property-secureblackbox_samlreader-class) | The maximum number of bytes to read from the socket, per second. | | [SocketLocalAddress](#socketlocaladdress-property-secureblackbox_samlreader-class) | The local network interface to bind the socket to. | | [SocketLocalPort](#socketlocalport-property-secureblackbox_samlreader-class) | The local port number to bind the socket to. | | [SocketOutgoingSpeedLimit](#socketoutgoingspeedlimit-property-secureblackbox_samlreader-class) | The maximum number of bytes to write to the socket, per second. | | [SocketTimeout](#sockettimeout-property-secureblackbox_samlreader-class) | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. | | [SocketUseIPv6](#socketuseipv6-property-secureblackbox_samlreader-class) | Enables or disables IP protocol version 6. | | [StatementCount](#statementcount-property-secureblackbox_samlreader-class) | The number of records in the Statement arrays. | | [StatementAuthnContextAuthenticatingAuthorities](#statementauthncontextauthenticatingauthorities-property-secureblackbox_samlreader-class) | Contains the list of authenticating authorities. | | [StatementAuthnContextChoice](#statementauthncontextchoice-property-secureblackbox_samlreader-class) | Specifies the authentication context choice variant. | | [StatementAuthnContextClassRef](#statementauthncontextclassref-property-secureblackbox_samlreader-class) | Indicates the authentication contexts class reference. | | [StatementAuthnContextDecl](#statementauthncontextdecl-property-secureblackbox_samlreader-class) | Specifies the authentication contexts declaration. | | [StatementAuthnContextDeclRef](#statementauthncontextdeclref-property-secureblackbox_samlreader-class) | Specifies the authentication contexts declaration reference. | | [StatementAuthnInstant](#statementauthninstant-property-secureblackbox_samlreader-class) | Specifies the authentication event timestamp. | | [StatementAuthnSessionIndex](#statementauthnsessionindex-property-secureblackbox_samlreader-class) | Contains the authentication session index. | | [StatementAuthnSessionNotOnOrAfter](#statementauthnsessionnotonorafter-property-secureblackbox_samlreader-class) | Maps to the SessionNotOnOrAfter parameter of the authentication statement. | | [StatementAuthnSubjectLocalityAddress](#statementauthnsubjectlocalityaddress-property-secureblackbox_samlreader-class) | Specifies the authentication subjects address. | | [StatementAuthnSubjectLocalityDNSName](#statementauthnsubjectlocalitydnsname-property-secureblackbox_samlreader-class) | Maps to the authentication subjects DNS name parameter. | | [StatementAuthzActions](#statementauthzactions-property-secureblackbox_samlreader-class) | Provides access to the list of actions of the authorization statement. | | [StatementAuthzDecision](#statementauthzdecision-property-secureblackbox_samlreader-class) | Specifies the authorization decision. | | [StatementAuthzDecisionEvidence](#statementauthzdecisionevidence-property-secureblackbox_samlreader-class) | Manages the authorization decision statement evidence parameter. | | [StatementAuthzDecisionResource](#statementauthzdecisionresource-property-secureblackbox_samlreader-class) | Specifies the authorization decision statement resource parameter. | | [StatementType](#statementtype-property-secureblackbox_samlreader-class) | Specifies the assertion statement type. | | [SubjectConfirmationCount](#subjectconfirmationcount-property-secureblackbox_samlreader-class) | The number of records in the SubjectConfirmation arrays. | | [SubjectConfirmationAddress](#subjectconfirmationaddress-property-secureblackbox_samlreader-class) | Contains the address enabled for presenting assertions. | | [SubjectConfirmationData](#subjectconfirmationdata-property-secureblackbox_samlreader-class) | The uninterpreted value of data entry in the subject confirmation. | | [SubjectConfirmationDataType](#subjectconfirmationdatatype-property-secureblackbox_samlreader-class) | The type of data contained in the confirmation. | | [SubjectConfirmationID](#subjectconfirmationid-property-secureblackbox_samlreader-class) | The identifier of the entity which can satisfy the subject confirmation requirements. | | [SubjectConfirmationInResponseTo](#subjectconfirmationinresponseto-property-secureblackbox_samlreader-class) | The ID of the SAML message in response to which the assertion is issued. | | [SubjectConfirmationMethod](#subjectconfirmationmethod-property-secureblackbox_samlreader-class) | Specifies the mechanism to be used to confirm the subject. | | [SubjectConfirmationNotBefore](#subjectconfirmationnotbefore-property-secureblackbox_samlreader-class) | Time moment before which the subject cannot be confirmed. | | [SubjectConfirmationNotOnOrAfter](#subjectconfirmationnotonorafter-property-secureblackbox_samlreader-class) | Limits the time until which the subject can be confirmed. | | [SubjectConfirmationRecipient](#subjectconfirmationrecipient-property-secureblackbox_samlreader-class) | The URI of the entity or the location of the resource to which the assertion should be presented. | | [TLSAutoValidateCertificates](#tlsautovalidatecertificates-property-secureblackbox_samlreader-class) | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. | | [TLSBaseConfiguration](#tlsbaseconfiguration-property-secureblackbox_samlreader-class) | Selects the base configuration for the TLS settings. | | [TLSCiphersuites](#tlsciphersuites-property-secureblackbox_samlreader-class) | A list of ciphersuites separated with commas or semicolons. | | [TLSClientAuth](#tlsclientauth-property-secureblackbox_samlreader-class) | Enables or disables certificate-based client authentication. | | [TLSExtensions](#tlsextensions-property-secureblackbox_samlreader-class) | Provides access to TLS extensions. | | [TLSForceResumeIfDestinationChanges](#tlsforceresumeifdestinationchanges-property-secureblackbox_samlreader-class) | Whether to force TLS session resumption when the destination address changes. | | [TLSGroups](#tlsgroups-property-secureblackbox_samlreader-class) | Specifies a list of key exchange groups to attempt during the TLS key exchange. | | [TLSPreSharedIdentity](#tlspresharedidentity-property-secureblackbox_samlreader-class) | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. | | [TLSPreSharedKey](#tlspresharedkey-property-secureblackbox_samlreader-class) | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. | | [TLSPreSharedKeyCiphersuite](#tlspresharedkeyciphersuite-property-secureblackbox_samlreader-class) | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. | | [TLSRenegotiationAttackPreventionMode](#tlsrenegotiationattackpreventionmode-property-secureblackbox_samlreader-class) | Selects the renegotiation attack prevention mechanism. | | [TLSRevocationCheck](#tlsrevocationcheck-property-secureblackbox_samlreader-class) | Specifies the kind(s) of revocation check to perform. | | [TLSSSLOptions](#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. | | [TLSMode](#tlsmode-property-secureblackbox_samlreader-class) | Specifies the TLS mode to use. | | [TLSUseExtendedMasterSecret](#tlsuseextendedmastersecret-property-secureblackbox_samlreader-class) | Enables the Extended Master Secret Extension, as defined in RFC 7627. | | [TLSUseSessionResumption](#tlsusesessionresumption-property-secureblackbox_samlreader-class) | Enables or disables the TLS session resumption capability. | | [TLSVersions](#tlsversions-property-secureblackbox_samlreader-class) | The SSL/TLS versions to enable by default. | | [UseBinding](#usebinding-property-secureblackbox_samlreader-class) | Enables or disables automated binding processing. | | [ValidateSignatures](#validatesignatures-property-secureblackbox_samlreader-class) | Enables or disables automated signature validation. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [CompareIDs](#compareids-method-secureblackbox_samlreader-class) | Compares two SAML IDs. | | [Config](#config-method-secureblackbox_samlreader-class) | Sets or retrieves a configuration setting. | | [DoAction](#doaction-method-secureblackbox_samlreader-class) | Performs an additional action. | | [GetIDProp](#getidprop-method-secureblackbox_samlreader-class) | Extracts a specific property from a SAML ID. | | [Open](#open-method-secureblackbox_samlreader-class) | Opens a SAML entity. | | [OpenBytes](#openbytes-method-secureblackbox_samlreader-class) | Opens a SAML entity. | | [OpenFile](#openfile-method-secureblackbox_samlreader-class) | Opens a SAML entity. | | [PinAssertion](#pinassertion-method-secureblackbox_samlreader-class) | Pins assertion by propagating it in PinnedAssertionXXX properties. | | [Reset](#reset-method-secureblackbox_samlreader-class) | Resets the class settings. | ## 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.* | | | | --- | --- | | [Encrypted](#encrypted-event-secureblackbox_samlreader-class) | Notifies the application that the assertion is encrypted and provides recipient certificate details. | | [Error](#error-event-secureblackbox_samlreader-class) | Fires to report an error condition. | | [Notification](#notification-event-secureblackbox_samlreader-class) | This event notifies the application about an underlying control flow event. | | [SignatureFound](#signaturefound-event-secureblackbox_samlreader-class) | Signifies the start of signature validation. | | [SignatureValidated](#signaturevalidated-event-secureblackbox_samlreader-class) | Reports the signature validation result. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Body](#Body) | Returns the XML of the currently processed entity. | | [EncryptionCert](#EncryptionCert) | Returns the body of the encryption certificate. | | [EncryptionSubjectRDN](#EncryptionSubjectRDN) | Returns the Subject RDN of the encryption certificate. | | [OpportunisticCertLookup](#OpportunisticCertLookup) | Enables opportunistic signing certificate lookup. | | [ValidateSignatureReferences](#ValidateSignatureReferences) | Enables or disables XML signature reference validation. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the class. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # ArtifactEndpointIndex Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) An accessor to the EndpointIndex entry of the artifact. ## Object Oriented Interface ```text public function getArtifactEndpointIndex(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) An accessor to the MessageHandle property of the artifact. ## Object Oriented Interface ```text public function getArtifactMessageHandle(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Returns the contents of the artifact. ## Object Oriented Interface ```text public function getArtifactRemainingArtifact(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) An accessor to the SourceID property of the artifact. ## Object Oriented Interface ```text public function getArtifactSourceID(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) The TypeCode property of the artifact. ## Object Oriented Interface ```text public function getArtifactTypeCode(); ``` ## Procedural Interface ```text 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](#artifactremainingartifact-property-secureblackbox_samlreader-class), [ArtifactSourceID](#artifactsourceid-property-secureblackbox_samlreader-class), and [ArtifactMessageHandle](#artifactmessagehandle-property-secureblackbox_samlreader-class) parameters. This property is read-only and not available at design time. ## Data Type Integer # ArtifactURI Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) An accessor to the URI property of the artifact. ## Object Oriented Interface ```text public function getArtifactURI(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Returns the content of the ArtifactResolve query. ## Object Oriented Interface ```text public function getArtifactResolveQuery(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Returns the number of assertions in the SAML message. ## Object Oriented Interface ```text public function getAssertionCount(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) The number of records in the Attribute arrays. ## Object Oriented Interface ```text public function getAttributeCount(); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 9 ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [AttributeFriendlyName](#attributefriendlyname-property-secureblackbox_samlreader-class) - [AttributeName](#attributename-property-secureblackbox_samlreader-class) - [AttributeNameFormat](#attributenameformat-property-secureblackbox_samlreader-class) - [AttributeStatementIndex](#attributestatementindex-property-secureblackbox_samlreader-class) - [AttributeValues](#attributevalues-property-secureblackbox_samlreader-class) 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](#samlreader-class) 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 ```text public function getAttributeFriendlyName($attributeindex); ``` ## Procedural Interface ```text 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](#attributecount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # AttributeName Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Specifies the name of the attribute. ## Object Oriented Interface ```text public function getAttributeName($attributeindex); ``` ## Procedural Interface ```text 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](#attributecount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # AttributeNameFormat Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Indicates the format used to reference the attribute. ## Object Oriented Interface ```text public function getAttributeNameFormat($attributeindex); ``` ## Procedural Interface ```text 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](#attributecount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # AttributeStatementIndex Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Contains the index of the statement the attribute corresponds to. ## Object Oriented Interface ```text public function getAttributeStatementIndex($attributeindex); ``` ## Procedural Interface ```text 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](#attributecount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type Integer # AttributeValues Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Contains a list of attribute values. ## Object Oriented Interface ```text public function getAttributeValues($attributeindex); ``` ## Procedural Interface ```text 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](#attributecount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # AuthnQueryComparison Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Specifies the authentication context comparison method. ## Object Oriented Interface ```text public function getAuthnQueryComparison(); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 15 ); ``` ## Possible Values ```text SAMLREADER_AUTHNQUERYCOMPARISON_NONE(0), SAMLREADER_AUTHNQUERYCOMPARISON_EXACT(1), SAMLREADER_AUTHNQUERYCOMPARISON_MINIMUM(2), SAMLREADER_AUTHNQUERYCOMPARISON_MAXIMUM(3), SAMLREADER_AUTHNQUERYCOMPARISON_BETTER(4) ``` ## 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](#samlreader-class) Class) Specifies the context class reference. ## Object Oriented Interface ```text public function getAuthnQueryContextClassRefs(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Specifies the context reference type. ## Object Oriented Interface ```text public function getAuthnQueryRefType(); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 17 ); ``` ## Possible Values ```text SAMLREADER_AUTHNQUERYREFTYPE_UNKNOWN(0), SAMLREADER_AUTHNQUERYREFTYPE_CLASS(1), SAMLREADER_AUTHNQUERYREFTYPE_DECL(2) ``` ## 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](#samlreader-class) Class) Specifies the index of the session to the authentication entity. ## Object Oriented Interface ```text public function getAuthnQuerySessionIndex(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Specifies the assertion consumer service index. ## Object Oriented Interface ```text public function getAuthnRequestAssertionConsumerServiceIndex(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Specifies the assertion consumer service URL. ## Object Oriented Interface ```text public function getAuthnRequestAssertionConsumerServiceURL(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Specifies the attribute consuming service index. ## Object Oriented Interface ```text public function getAuthnRequestAttributeConsumingServiceIndex(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Provides access to the authentication context class references. ## Object Oriented Interface ```text public function getAuthnRequestContextClassRefs(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Specifies the AuthnContext comparison method. ## Object Oriented Interface ```text public function getAuthnRequestContextComparison(); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 23 ); ``` ## Possible Values ```text SAMLREADER_AUTHNREQUESTCONTEXTCOMPARISON_NONE(0), SAMLREADER_AUTHNREQUESTCONTEXTCOMPARISON_EXACT(1), SAMLREADER_AUTHNREQUESTCONTEXTCOMPARISON_MINIMUM(2), SAMLREADER_AUTHNREQUESTCONTEXTCOMPARISON_MAXIMUM(3), SAMLREADER_AUTHNREQUESTCONTEXTCOMPARISON_BETTER(4) ``` ## 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](#samlreader-class) Class) Specifies the context reference type. ## Object Oriented Interface ```text public function getAuthnRequestContextRefType(); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 24 ); ``` ## Possible Values ```text SAMLREADER_AUTHNREQUESTCONTEXTREFTYPE_UNKNOWN(0), SAMLREADER_AUTHNREQUESTCONTEXTREFTYPE_CLASS(1), SAMLREADER_AUTHNREQUESTCONTEXTREFTYPE_DECL(2) ``` ## 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](#samlreader-class) Class) Adjusts secondary serialization properties. ## Object Oriented Interface ```text public function getAuthnRequestFlags(); ``` ## Procedural Interface ```text 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: | | | | | --- | --- | --- | | arfAllowCreate | 1 | Enforces inclusion of NameIDPolicyAllowCreate element in the NameIDPolicy record | | arfForceAuthn | 2 | Enforces inclusion of the ForceAuthn element | | arfIsPassive | 4 | Enforces saving of IsPassive element | This property is read-only and not available at design time. ## Data Type Integer # AuthnRequestForceAuthn Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Corresponds to the ForceAuthn parameter of the request. ## Object Oriented Interface ```text public function getAuthnRequestForceAuthn(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Maps to the IsPassive parameter of the request. ## Object Oriented Interface ```text public function getAuthnRequestIsPassive(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Matches the AllowCreate attribute of NameIDPolicy element of the request. ## Object Oriented Interface ```text public function getAuthnRequestNameIDPolicyAllowCreate(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Matches to the Format attribute of the NameIDPolicy element of the request. ## Object Oriented Interface ```text public function getAuthnRequestNameIDPolicyFormat(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Matches to the SP name qualifier attribute of the request. ## Object Oriented Interface ```text public function getAuthnRequestNameIDPolicySPNameQualifier(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Specifies the protocol binding to be requested in the authentication request. ## Object Oriented Interface ```text public function getAuthnRequestProtocolBinding(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Specifies the name of the requestor. ## Object Oriented Interface ```text public function getAuthnRequestProviderName(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Matches the GetComplete element of the IDPList entry of the Scoping object. ## Object Oriented Interface ```text public function getAuthnRequestScopingGetComplete(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) The maximum number of proxies on the way between the requestor and the provider. ## Object Oriented Interface ```text public function getAuthnRequestScopingProxyCount(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) A collection of requestor IDs on whose behalf the request is being sent. ## Object Oriented Interface ```text public function getAuthnRequestScopingRequesterIDs(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Specifies the list of actions included in the query. ## Object Oriented Interface ```text public function getAuthzDecisionQueryActions(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Matches the Resource element of the query. ## Object Oriented Interface ```text public function getAuthzDecisionQueryResource(); ``` ## Procedural Interface ```text 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 # BindingType Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Specifies the type of SAML binding to use. ## Object Oriented Interface ```text public function getBindingType(); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 38 ); ``` ## Possible Values ```text SAMLREADER_BINDINGTYPE_NONE(0), SAMLREADER_BINDINGTYPE_SOAP(1), SAMLREADER_BINDINGTYPE_PAOS(2), SAMLREADER_BINDINGTYPE_REDIRECT(3), SAMLREADER_BINDINGTYPE_POST(4), SAMLREADER_BINDINGTYPE_ARTIFACT(5) ``` ## 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](#samlreader-class) Class) Contains the POST binding form body. ## Object Oriented Interface ```text public function getBindingBody(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Specifies the message encoding. ## Object Oriented Interface ```text public function getBindingEncoding(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Enforces a signature over all outgoing messages. ## Object Oriented Interface ```text public function getBindingForceSign(); ``` ## Procedural Interface ```text 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](#SAMLReader_p_BindingSign). This property is read-only and not available at design time. ## Data Type Boolean # BindingFormTemplate Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Contains the XHTML form template returned by the service provider. ## Object Oriented Interface ```text public function getBindingFormTemplate(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Specifies whether binding is applied on the server, or on the client side. ## Object Oriented Interface ```text public function getBindingPOSTMode(); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 43 ); ``` ## Possible Values ```text SAMLREADER_BINDINGPOSTMODE_CLIENT(0), SAMLREADER_BINDINGPOSTMODE_SERVER(1) ``` ## 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](#samlreader-class) Class) Contains the RelayState parameter of the binding. ## Object Oriented Interface ```text public function getBindingRelayState(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains the signature algorithm. ## Object Oriented Interface ```text public function getBindingSignatureAlgorithm(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) The outcome of the cryptographic signature validation. ## Object Oriented Interface ```text public function getBindingSignatureValidationResult(); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 46 ); ``` ## Possible Values ```text SAMLREADER_BINDINGSIGNATUREVALIDATIONRESULT_VALID(0), SAMLREADER_BINDINGSIGNATUREVALIDATIONRESULT_UNKNOWN(1), SAMLREADER_BINDINGSIGNATUREVALIDATIONRESULT_CORRUPTED(2), SAMLREADER_BINDINGSIGNATUREVALIDATIONRESULT_SIGNER_NOT_FOUND(3), SAMLREADER_BINDINGSIGNATUREVALIDATIONRESULT_FAILURE(4), SAMLREADER_BINDINGSIGNATUREVALIDATIONRESULT_REFERENCE_CORRUPTED(5) ``` ## Default Value 0 ## Remarks The outcome of the cryptographic signature validation. The following signature validity values are supported: | | | | | --- | --- | --- | | svtValid | 0 | The signature is valid | | svtUnknown | 1 | Signature validity is unknown | | svtCorrupted | 2 | The signature is corrupted | | svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. | | svtFailure | 4 | General failure | | svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) | This property is read-only and not available at design time. ## Data Type Integer # BindingSigned Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Specifies whether to sign the binding. ## Object Oriented Interface ```text public function getBindingSigned(); ``` ## Procedural Interface ```text 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](#bindingforcesign-property-secureblackbox_samlreader-class) 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](#samlreader-class) Class) Contains the URL of the request query. ## Object Oriented Interface ```text public function getBindingURL(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Instructs the class whether to verify incoming signatures. ## Object Oriented Interface ```text public function getBindingVerifySignatures(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Object Oriented Interface ```text public function getBindingKeyHandle(); public function setBindingKeyHandle($value); ``` ## Procedural Interface ```text 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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` This property is not available at design time. ## Data Type Long64 # CertCount Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) The number of records in the Cert arrays. ## Object Oriented Interface ```text public function getCertCount(); public function setCertCount($value); ``` ## Procedural Interface ```text 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](#certbytes-property-secureblackbox_samlreader-class) - [CertHandle](#certhandle-property-secureblackbox_samlreader-class) 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](#samlreader-class) Class) Returns the raw certificate data in DER format. ## Object Oriented Interface ```text public function getCertBytes($certindex); ``` ## Procedural Interface ```text 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](#certcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type Byte Array # CertHandle Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Object Oriented Interface ```text public function getCertHandle($certindex); public function setCertHandle($certindex, $value); ``` ## Procedural Interface ```text 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. ```text 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](#certcount-property-secureblackbox_samlreader-class) property. This property is not available at design time. ## Data Type Long64 # ConditionCount Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) The number of records in the Condition arrays. ## Object Oriented Interface ```text public function getConditionCount(); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 105 ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [Condition](#condition-property-secureblackbox_samlreader-class) - [ConditionType](#conditiontype-property-secureblackbox_samlreader-class) 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 # Condition Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) The condition set in accordance with the ConditionType . ## Object Oriented Interface ```text public function getCondition($conditionindex); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 106 , $conditionindex); ``` ## Default Value '' ## Remarks The condition set in accordance with the [ConditionType](#conditiontype-property-secureblackbox_samlreader-class). 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](#conditioncount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # ConditionType Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Specifies a type of the condition object. ## Object Oriented Interface ```text public function getConditionType($conditionindex); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 107 , $conditionindex); ``` ## Possible Values ```text SAMLREADER_CONDITIONTYPE_AUDIENCE_RESTRICTION(0), SAMLREADER_CONDITIONTYPE_ONE_TIME_USE(1), SAMLREADER_CONDITIONTYPE_PROXY_RESTRICTION(2), SAMLREADER_CONDITIONTYPE_NOT_BEFORE(3), SAMLREADER_CONDITIONTYPE_NOT_ON_OR_AFTER(4) ``` ## 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](#conditioncount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type Integer # DecryptionCertificateBytes Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Returns the raw certificate data in DER format. ## Object Oriented Interface ```text public function getDecryptionCertificateBytes(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Object Oriented Interface ```text public function getDecryptionCertificateHandle(); public function setDecryptionCertificateHandle($value); ``` ## Procedural Interface ```text 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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` This property is not available at design time. ## Data Type Long64 # FIPSMode Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Reserved. ## Object Oriented Interface ```text public function getFIPSMode(); public function setFIPSMode($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains the value of the NameID parameter. ## Object Oriented Interface ```text public function getLogoutRequestNameID(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains the value of the NotOnOrAfter parameter. ## Object Oriented Interface ```text public function getLogoutRequestNotOnOrAfter(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains the value of the Reason parameter. ## Object Oriented Interface ```text public function getLogoutRequestReason(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains the list of session indices. ## Object Oriented Interface ```text public function getLogoutRequestSessionIndexes(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains the value of the NameID parameter of the request. ## Object Oriented Interface ```text public function getManageNameIDRequestNameID(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains the value of the NewEncryptedID parameter of the request. ## Object Oriented Interface ```text public function getManageNameIDRequestNewEncryptedID(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains the value of the NewID parameter. ## Object Oriented Interface ```text public function getManageNameIDRequestNewID(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains the value of the Terminate parameter of the request. ## Object Oriented Interface ```text public function getManageNameIDRequestTerminate(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains the Consent parameter of the SAML message. ## Object Oriented Interface ```text public function getMessageConsent(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Returns the SAML type of the current message. ## Object Oriented Interface ```text public function getMessageContentType(); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 157 ); ``` ## Possible Values ```text SAMLREADER_MESSAGECONTENTTYPE_NONE(0), SAMLREADER_MESSAGECONTENTTYPE_ASSERTION_IDREQUEST(1), SAMLREADER_MESSAGECONTENTTYPE_SUBJECT_QUERY(2), SAMLREADER_MESSAGECONTENTTYPE_AUTHN_QUERY(3), SAMLREADER_MESSAGECONTENTTYPE_ATTRIBUTE_QUERY(4), SAMLREADER_MESSAGECONTENTTYPE_AUTHZ_DECISION_QUERY(5), SAMLREADER_MESSAGECONTENTTYPE_AUTHN_REQUEST(6), SAMLREADER_MESSAGECONTENTTYPE_MANAGE_NAME_IDREQUEST(7), SAMLREADER_MESSAGECONTENTTYPE_LOGOUT_REQUEST(8), SAMLREADER_MESSAGECONTENTTYPE_NAME_IDMAPPING_REQUEST(9), SAMLREADER_MESSAGECONTENTTYPE_ARTIFACT_RESOLVE(10), SAMLREADER_MESSAGECONTENTTYPE_RESPONSE(11), SAMLREADER_MESSAGECONTENTTYPE_ASSERTION(12) ``` ## 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](#samlreader-class) Class) Returns the type of the processed message, as an original string. ## Object Oriented Interface ```text public function getMessageContentTypeString(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains the Destination parameter of the SAML message. ## Object Oriented Interface ```text public function getMessageDestination(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) The ID of the request. ## Object Oriented Interface ```text public function getMessageID(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains the InResponseTo property of the SAML request. ## Object Oriented Interface ```text public function getMessageInResponseTo(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains request issuance timestamp. ## Object Oriented Interface ```text public function getMessageIssueInstant(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Sets the issuer of the message. ## Object Oriented Interface ```text public function getMessageIssuer(); ``` ## Procedural Interface ```text 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, ```text 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](#samlreader-class) Class) The outcome of the cryptographic signature validation. ## Object Oriented Interface ```text public function getMessageSignatureValidationResult(); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 164 ); ``` ## Possible Values ```text SAMLREADER_MESSAGESIGNATUREVALIDATIONRESULT_VALID(0), SAMLREADER_MESSAGESIGNATUREVALIDATIONRESULT_UNKNOWN(1), SAMLREADER_MESSAGESIGNATUREVALIDATIONRESULT_CORRUPTED(2), SAMLREADER_MESSAGESIGNATUREVALIDATIONRESULT_SIGNER_NOT_FOUND(3), SAMLREADER_MESSAGESIGNATUREVALIDATIONRESULT_FAILURE(4), SAMLREADER_MESSAGESIGNATUREVALIDATIONRESULT_REFERENCE_CORRUPTED(5) ``` ## Default Value 0 ## Remarks The outcome of the cryptographic signature validation. The following signature validity values are supported: | | | | | --- | --- | --- | | svtValid | 0 | The signature is valid | | svtUnknown | 1 | Signature validity is unknown | | svtCorrupted | 2 | The signature is corrupted | | svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. | | svtFailure | 4 | General failure | | svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) | This property is read-only and not available at design time. ## Data Type Integer # MessageSigned Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Specifies whether the SAML message is or should be signed. ## Object Oriented Interface ```text public function getMessageSigned(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Gets or sets the subject of the message. ## Object Oriented Interface ```text public function getMessageSubject(); ``` ## Procedural Interface ```text 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, ```text 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](#samlreader-class) Class) Specifies the protocol version to use for the SAML message. ## Object Oriented Interface ```text public function getMessageVersion(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Controls the inclusion of an XML header in the message. ## Object Oriented Interface ```text public function getMessageXMLHeader(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) An accessor to the NameID parameter of the request. ## Object Oriented Interface ```text public function getNameIDMappingRequestNameID(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains the value of AllowCreate parameter of the NameIDPolicy object. ## Object Oriented Interface ```text public function getNameIDMappingRequestNameIDPolicyAllowCreate(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Specifies the format of the NameIDPolicy element. ## Object Oriented Interface ```text public function getNameIDMappingRequestNameIDPolicyFormat(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains the SPNameQualifier parameter of the NameIDPolicy element. ## Object Oriented Interface ```text public function getNameIDMappingRequestNameIDPolicySPNameQualifier(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Controls inclusion of UseAllow modifier in the NameIDPolicy object. ## Object Oriented Interface ```text public function getNameIDMappingRequestNameIDPolicyUseAllowCreate(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Specifies the type of the assertion. ## Object Oriented Interface ```text public function getPinnedAssertionAssertionType(); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 174 ); ``` ## Possible Values ```text SAMLREADER_PINNEDASSERTIONASSERTIONTYPE_ASSERTION_IDREF(0), SAMLREADER_PINNEDASSERTIONASSERTIONTYPE_ASSERTION_URIREF(1), SAMLREADER_PINNEDASSERTIONASSERTIONTYPE_ASSERTION(2), SAMLREADER_PINNEDASSERTIONASSERTIONTYPE_ENCRYPTED_ASSERTION(3) ``` ## 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](#samlreader-class) Class) Represents the encrypted assertion content. ## Object Oriented Interface ```text public function getPinnedAssertionEncryptedContent(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Represents the ID of the assertion. ## Object Oriented Interface ```text public function getPinnedAssertionID(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Represents an ID reference value. ## Object Oriented Interface ```text public function getPinnedAssertionIDRef(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains the assertion issuance time stamp. ## Object Oriented Interface ```text public function getPinnedAssertionIssueInstant(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Specifies the assertion issuer. ## Object Oriented Interface ```text public function getPinnedAssertionIssuer(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains the index of the parent assertion in the assertion list. ## Object Oriented Interface ```text public function getPinnedAssertionParentAssertion(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) The outcome of the cryptographic signature validation. ## Object Oriented Interface ```text public function getPinnedAssertionSignatureValidationResult(); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 181 ); ``` ## Possible Values ```text SAMLREADER_PINNEDASSERTIONSIGNATUREVALIDATIONRESULT_VALID(0), SAMLREADER_PINNEDASSERTIONSIGNATUREVALIDATIONRESULT_UNKNOWN(1), SAMLREADER_PINNEDASSERTIONSIGNATUREVALIDATIONRESULT_CORRUPTED(2), SAMLREADER_PINNEDASSERTIONSIGNATUREVALIDATIONRESULT_SIGNER_NOT_FOUND(3), SAMLREADER_PINNEDASSERTIONSIGNATUREVALIDATIONRESULT_FAILURE(4), SAMLREADER_PINNEDASSERTIONSIGNATUREVALIDATIONRESULT_REFERENCE_CORRUPTED(5) ``` ## Default Value 0 ## Remarks The outcome of the cryptographic signature validation. The following signature validity values are supported: | | | | | --- | --- | --- | | svtValid | 0 | The signature is valid | | svtUnknown | 1 | Signature validity is unknown | | svtCorrupted | 2 | The signature is corrupted | | svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. | | svtFailure | 4 | General failure | | svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) | This property is read-only and not available at design time. ## Data Type Integer # PinnedAssertionSigned Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Specifies whether the assertion is signed. ## Object Oriented Interface ```text public function getPinnedAssertionSigned(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Specifies the assertion subject. ## Object Oriented Interface ```text public function getPinnedAssertionSubject(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Represents an URI reference value. ## Object Oriented Interface ```text public function getPinnedAssertionURIRef(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Specifies the SAML protocol version used. ## Object Oriented Interface ```text public function getPinnedAssertionVersion(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Specifies a pre-defined profile to apply when creating the signature. ## Object Oriented Interface ```text public function getProfile(); public function setProfile($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) The IP address of the proxy server. ## Object Oriented Interface ```text public function getProxyAddress(); public function setProxyAddress($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) The authentication type used by the proxy server. ## Object Oriented Interface ```text public function getProxyAuthentication(); public function setProxyAuthentication($value); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 188 ); secureblackbox_samlreader_set($res, 188, $value ); ``` ## Possible Values ```text SAMLREADER_PROXYAUTHENTICATION_NO_AUTHENTICATION(0), SAMLREADER_PROXYAUTHENTICATION_BASIC(1), SAMLREADER_PROXYAUTHENTICATION_DIGEST(2), SAMLREADER_PROXYAUTHENTICATION_NTLM(3) ``` ## Default Value 0 ## Remarks The authentication type used by the proxy server. | | | | --- | --- | | patNoAuthentication | 0 | | patBasic | 1 | | patDigest | 2 | | patNTLM | 3 | ## Data Type Integer # ProxyPassword Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) The password to authenticate to the proxy server. ## Object Oriented Interface ```text public function getProxyPassword(); public function setProxyPassword($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) The port on the proxy server to connect to. ## Object Oriented Interface ```text public function getProxyPort(); public function setProxyPort($value); ``` ## Procedural Interface ```text 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 # ProxyType Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) The type of the proxy server. ## Object Oriented Interface ```text public function getProxyType(); public function setProxyType($value); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 191 ); secureblackbox_samlreader_set($res, 191, $value ); ``` ## Possible Values ```text SAMLREADER_PROXYTYPE_NONE(0), SAMLREADER_PROXYTYPE_SOCKS_4(1), SAMLREADER_PROXYTYPE_SOCKS_5(2), SAMLREADER_PROXYTYPE_WEB_TUNNEL(3), SAMLREADER_PROXYTYPE_HTTP(4) ``` ## Default Value 0 ## Remarks The type of the proxy server. | | | | --- | --- | | cptNone | 0 | | cptSocks4 | 1 | | cptSocks5 | 2 | | cptWebTunnel | 3 | | cptHTTP | 4 | ## Data Type Integer # ProxyRequestHeaders Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Contains HTTP request headers for WebTunnel and HTTP proxy. ## Object Oriented Interface ```text public function getProxyRequestHeaders(); public function setProxyRequestHeaders($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains the HTTP or HTTPS (WebTunnel) proxy response body. ## Object Oriented Interface ```text public function getProxyResponseBody(); public function setProxyResponseBody($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. ## Object Oriented Interface ```text public function getProxyResponseHeaders(); public function setProxyResponseHeaders($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Specifies whether IPv6 should be used when connecting through the proxy. ## Object Oriented Interface ```text public function getProxyUseIPv6(); public function setProxyUseIPv6($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Specifies the username credential for proxy authentication. ## Object Oriented Interface ```text public function getProxyUsername(); public function setProxyUsername($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains the References entry of the SAML AssertionIDRequest message. ## Object Oriented Interface ```text public function getReferences(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains the NameID parameter of a NameIDMapping response. ## Object Oriented Interface ```text public function getResponseNameID(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) An optional message element to be returned with the response. ## Object Oriented Interface ```text public function getResponseOptionalElement(); ``` ## Procedural Interface ```text 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 # ResponseType Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Contains the type of the response. ## Object Oriented Interface ```text public function getResponseType(); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 200 ); ``` ## Possible Values ```text SAMLREADER_RESPONSETYPE_RESPONSE(0), SAMLREADER_RESPONSETYPE_ARTIFACT_RESPONSE(1), SAMLREADER_RESPONSETYPE_NAME_IDMAPPING_RESPONSE(2), SAMLREADER_RESPONSETYPE_LOGOUT_RESPONSE(3) ``` ## 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](#samlreader-class) Class) Gets or sets the status of the response. ## Object Oriented Interface ```text public function getResponseStatus(); ``` ## Procedural Interface ```text 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](#responsestatuscodevalue-property-secureblackbox_samlreader-class) 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](#responsestatuscodevalue-property-secureblackbox_samlreader-class) and [ResponseStatusCodeSubValue](#responsestatuscodesubvalue-property-secureblackbox_samlreader-class) properties. This property is read-only and not available at design time. ## Data Type Integer # ResponseStatusCodeSubValue Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) The value of the nested StatusCode. ## Object Oriented Interface ```text public function getResponseStatusCodeSubValue(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains the status code value. ## Object Oriented Interface ```text public function getResponseStatusCodeValue(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains additional information on the status of the request. ## Object Oriented Interface ```text public function getResponseStatusDetail(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains a status message (optional). ## Object Oriented Interface ```text public function getResponseStatusMessage(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) The number of records in the ScopingIDP arrays. ## Object Oriented Interface ```text public function getScopingIDPCount(); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 206 ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [ScopingIDPLoc](#scopingidploc-property-secureblackbox_samlreader-class) - [ScopingIDPName](#scopingidpname-property-secureblackbox_samlreader-class) - [ScopingIDPProviderID](#scopingidpproviderid-property-secureblackbox_samlreader-class) 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](#samlreader-class) Class) Contains the value of the Loc attribute. ## Object Oriented Interface ```text public function getScopingIDPLoc($scopingidpindex); ``` ## Procedural Interface ```text 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](#scopingidpcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # ScopingIDPName Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Contains the name of the IdP provider. ## Object Oriented Interface ```text public function getScopingIDPName($scopingidpindex); ``` ## Procedural Interface ```text 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](#scopingidpcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # ScopingIDPProviderID Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Contains the provider ID. ## Object Oriented Interface ```text public function getScopingIDPProviderID($scopingidpindex); ``` ## Procedural Interface ```text 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](#scopingidpcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # SecurityCanonicalizationMethod Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) The canonicalization method to use in the signature. ## Object Oriented Interface ```text public function getSecurityCanonicalizationMethod(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) The digest method to use. ## Object Oriented Interface ```text public function getSecurityDigestMethod(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) The encryption method used to encrypt the assertion. ## Object Oriented Interface ```text public function getSecurityEncryptionMethod(); ``` ## Procedural Interface ```text 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: | | | | | --- | --- | --- | | SB_XML_ENCRYPTION_ALGORITHM_RC4 | RC4 | | | SB_XML_ENCRYPTION_ALGORITHM_DES | DES | | | SB_XML_ENCRYPTION_ALGORITHM_3DES | 3DEST | | | SB_XML_ENCRYPTION_ALGORITHM_AES128 | AES128 | | | SB_XML_ENCRYPTION_ALGORITHM_AES192 | AES192 | | | SB_XML_ENCRYPTION_ALGORITHM_AES256 | AES256 | | | SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA128 | Camellia128 | | | SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA192 | Camellia192 | | | SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA256 | Camellia256 | | | SB_XML_ENCRYPTION_ALGORITHM_SEED | SEED | | This property is read-only and not available at design time. ## Data Type String # SecurityFlags Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Provides access to secondary security parameters and tweaks. ## Object Oriented Interface ```text public function getSecurityFlags(); ``` ## Procedural Interface ```text 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): | | | | | --- | --- | --- | | ssfSignatureAfterIssuer | 1 | Place the Signature tag after the issuer tag in the XML document | | ssfSignatureBeforeDescriptor | 2 | Place the Signature tag before the entity descriptor tag in the XML metadata | | ssfKeyDataIssuerSerial | 4 | Include the IssuerSerial key data element | | ssfKeyDataSKI | 8 | Include the SubjectKeyIdentifier key data element | | ssfKeyDataSubjectName | 16 | Include the SubjectName key data element | | ssfKeyDataCertificate | 32 | Include the Certificate key data element | | ssfKeyDataCRL | 64 | Include the CRL key data element | | ssfSignAuthnRequests | 65536 | Sign authentication requests (SP only) | | ssfSignArtifactResolveRequests | 131072 | Sign artifact resolve requests | | ssfSignLogoutRequests | 262144 | Sign logout requests | | ssfSignAssertions | 524288 | Sign outgoing assertions (IdP only) | | ssfSignResponses | 1048576 | Sign all responses (IdP only) | | ssfEncryptAssertions | 2097152 | Encrypt generated assertions (IdP only) | This property is read-only and not available at design time. ## Data Type Integer # SecuritySigMethod Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) The signature method to use. ## Object Oriented Interface ```text public function getSecuritySigMethod(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Specifies the signature validation policy. ## Object Oriented Interface ```text public function getSecuritySignaturePolicy(); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 215 ); ``` ## Possible Values ```text SAMLREADER_SECURITYSIGNATUREPOLICY_AUTO(0), SAMLREADER_SECURITYSIGNATUREPOLICY_VALIDATE(1), SAMLREADER_SECURITYSIGNATUREPOLICY_REQUIRE(2), SAMLREADER_SECURITYSIGNATUREPOLICY_IGNORE(3) ``` ## 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](#samlreader-class) Class) Returns the raw certificate data in DER format. ## Object Oriented Interface ```text public function getSigningCertBytes(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Indicates whether the certificate has a CA capability. ## Object Oriented Interface ```text public function getSigningCertCA(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) A unique identifier (fingerprint) of the CA certificate's cryptographic key. ## Object Oriented Interface ```text public function getSigningCertCAKeyID(); ``` ## Procedural Interface ```text 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](#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [SigningCertSubjectKeyID](#signingcertsubjectkeyid-property-secureblackbox_samlreader-class) 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](#samlreader-class) Class) Contains a list of locations of CRL distribution points used to check this certificate's validity. ## Object Oriented Interface ```text public function getSigningCertCRLDistributionPoints(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Specifies the elliptic curve associated with the certificate's public key. ## Object Oriented Interface ```text public function getSigningCertCurve(); ``` ## Procedural Interface ```text 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. | | | | | --- | --- | --- | | SB_EC_SECP112R1 | SECP112R1 | | | SB_EC_SECP112R2 | SECP112R2 | | | SB_EC_SECP128R1 | SECP128R1 | | | SB_EC_SECP128R2 | SECP128R2 | | | SB_EC_SECP160K1 | SECP160K1 | | | SB_EC_SECP160R1 | SECP160R1 | | | SB_EC_SECP160R2 | SECP160R2 | | | SB_EC_SECP192K1 | SECP192K1 | | | SB_EC_SECP192R1 | SECP192R1 | | | SB_EC_SECP224K1 | SECP224K1 | | | SB_EC_SECP224R1 | SECP224R1 | | | SB_EC_SECP256K1 | SECP256K1 | | | SB_EC_SECP256R1 | SECP256R1 | | | SB_EC_SECP384R1 | SECP384R1 | | | SB_EC_SECP521R1 | SECP521R1 | | | SB_EC_SECT113R1 | SECT113R1 | | | SB_EC_SECT113R2 | SECT113R2 | | | SB_EC_SECT131R1 | SECT131R1 | | | SB_EC_SECT131R2 | SECT131R2 | | | SB_EC_SECT163K1 | SECT163K1 | | | SB_EC_SECT163R1 | SECT163R1 | | | SB_EC_SECT163R2 | SECT163R2 | | | SB_EC_SECT193R1 | SECT193R1 | | | SB_EC_SECT193R2 | SECT193R2 | | | SB_EC_SECT233K1 | SECT233K1 | | | SB_EC_SECT233R1 | SECT233R1 | | | SB_EC_SECT239K1 | SECT239K1 | | | SB_EC_SECT283K1 | SECT283K1 | | | SB_EC_SECT283R1 | SECT283R1 | | | SB_EC_SECT409K1 | SECT409K1 | | | SB_EC_SECT409R1 | SECT409R1 | | | SB_EC_SECT571K1 | SECT571K1 | | | SB_EC_SECT571R1 | SECT571R1 | | | SB_EC_PRIME192V1 | PRIME192V1 | | | SB_EC_PRIME192V2 | PRIME192V2 | | | SB_EC_PRIME192V3 | PRIME192V3 | | | SB_EC_PRIME239V1 | PRIME239V1 | | | SB_EC_PRIME239V2 | PRIME239V2 | | | SB_EC_PRIME239V3 | PRIME239V3 | | | SB_EC_PRIME256V1 | PRIME256V1 | | | SB_EC_C2PNB163V1 | C2PNB163V1 | | | SB_EC_C2PNB163V2 | C2PNB163V2 | | | SB_EC_C2PNB163V3 | C2PNB163V3 | | | SB_EC_C2PNB176W1 | C2PNB176W1 | | | SB_EC_C2TNB191V1 | C2TNB191V1 | | | SB_EC_C2TNB191V2 | C2TNB191V2 | | | SB_EC_C2TNB191V3 | C2TNB191V3 | | | SB_EC_C2ONB191V4 | C2ONB191V4 | | | SB_EC_C2ONB191V5 | C2ONB191V5 | | | SB_EC_C2PNB208W1 | C2PNB208W1 | | | SB_EC_C2TNB239V1 | C2TNB239V1 | | | SB_EC_C2TNB239V2 | C2TNB239V2 | | | SB_EC_C2TNB239V3 | C2TNB239V3 | | | SB_EC_C2ONB239V4 | C2ONB239V4 | | | SB_EC_C2ONB239V5 | C2ONB239V5 | | | SB_EC_C2PNB272W1 | C2PNB272W1 | | | SB_EC_C2PNB304W1 | C2PNB304W1 | | | SB_EC_C2TNB359V1 | C2TNB359V1 | | | SB_EC_C2PNB368W1 | C2PNB368W1 | | | SB_EC_C2TNB431R1 | C2TNB431R1 | | | SB_EC_NISTP192 | NISTP192 | | | SB_EC_NISTP224 | NISTP224 | | | SB_EC_NISTP256 | NISTP256 | | | SB_EC_NISTP384 | NISTP384 | | | SB_EC_NISTP521 | NISTP521 | | | SB_EC_NISTB163 | NISTB163 | | | SB_EC_NISTB233 | NISTB233 | | | SB_EC_NISTB283 | NISTB283 | | | SB_EC_NISTB409 | NISTB409 | | | SB_EC_NISTB571 | NISTB571 | | | SB_EC_NISTK163 | NISTK163 | | | SB_EC_NISTK233 | NISTK233 | | | SB_EC_NISTK283 | NISTK283 | | | SB_EC_NISTK409 | NISTK409 | | | SB_EC_NISTK571 | NISTK571 | | | SB_EC_GOSTCPTEST | GOSTCPTEST | | | SB_EC_GOSTCPA | GOSTCPA | | | SB_EC_GOSTCPB | GOSTCPB | | | SB_EC_GOSTCPC | GOSTCPC | | | SB_EC_GOSTCPXCHA | GOSTCPXCHA | | | SB_EC_GOSTCPXCHB | GOSTCPXCHB | | | SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | | | SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | | | SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | | | SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | | | SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | | | SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | | | SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | | | SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | | | SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | | | SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | | | SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | | | SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | | | SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | | | SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | | | SB_EC_CURVE25519 | CURVE25519 | | | SB_EC_CURVE448 | CURVE448 | | This property is read-only and not available at design time. ## Data Type String # SigningCertFingerprint Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Contains the fingerprint (a hash imprint) of this certificate. ## Object Oriented Interface ```text public function getSigningCertFingerprint(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains an associated alias (friendly name) of the certificate. ## Object Oriented Interface ```text public function getSigningCertFriendlyName(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Object Oriented Interface ```text public function getSigningCertHandle(); ``` ## Procedural Interface ```text 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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` This property is read-only and not available at design time. ## Data Type Long64 # SigningCertHashAlgorithm Property ([SecureBlackbox_SAMLReader](#samlreader-class) 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 ```text public function getSigningCertHashAlgorithm(); ``` ## Procedural Interface ```text 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](#signingcertsigalgorithm-property-secureblackbox_samlreader-class) to find out the hash algorithm that is part of the certificate signature. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | This property is read-only and not available at design time. ## Data Type String # SigningCertIssuer Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) The common name of the certificate issuer (CA), typically a company name. ## Object Oriented Interface ```text public function getSigningCertIssuer(); ``` ## Procedural Interface ```text 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](#signingcertissuerrdn-property-secureblackbox_samlreader-class). This property is read-only and not available at design time. ## Data Type String # SigningCertIssuerRDN Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) A list of Property=Value pairs that uniquely identify the certificate issuer. ## Object Oriented Interface ```text public function getSigningCertIssuerRDN(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Specifies the public key algorithm of this certificate. ## Object Oriented Interface ```text public function getSigningCertKeyAlgorithm(); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 228 ); ``` ## Default Value '0' ## Remarks Specifies the public key algorithm of this certificate. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | Use the [SigningCertKeyBits](#signingcertkeybits-property-secureblackbox_samlreader-class), [SigningCertCurve](#signingcertcurve-property-secureblackbox_samlreader-class), and [SigningCertPublicKeyBytes](#signingcertpublickeybytes-property-secureblackbox_samlreader-class) 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](#samlreader-class) Class) Returns the length of the public key in bits. ## Object Oriented Interface ```text public function getSigningCertKeyBits(); ``` ## Procedural Interface ```text 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](#signingcertpublickeybytes-property-secureblackbox_samlreader-class) or [SigningCertPrivateKeyBytes](#SAMLReader_p_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](#samlreader-class) Class) Returns a SHA1 fingerprint of the public key contained in the certificate. ## Object Oriented Interface ```text public function getSigningCertKeyFingerprint(); ``` ## Procedural Interface ```text 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](#signingcertfingerprint-property-secureblackbox_samlreader-class) property. The key fingerprint 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](#samlreader-class) Class) Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. ## Object Oriented Interface ```text public function getSigningCertKeyUsage(); ``` ## Procedural Interface ```text 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: | | | | | --- | --- | --- | | ckuUnknown | 0x00000 | Unknown key usage | | ckuDigitalSignature | 0x00001 | Digital signature | | ckuNonRepudiation | 0x00002 | Non-repudiation | | ckuKeyEncipherment | 0x00004 | Key encipherment | | ckuDataEncipherment | 0x00008 | Data encipherment | | ckuKeyAgreement | 0x00010 | Key agreement | | ckuKeyCertSign | 0x00020 | Certificate signing | | ckuCRLSign | 0x00040 | Revocation signing | | ckuEncipherOnly | 0x00080 | Encipher only | | ckuDecipherOnly | 0x00100 | Decipher only | | ckuServerAuthentication | 0x00200 | Server authentication | | ckuClientAuthentication | 0x00400 | Client authentication | | ckuCodeSigning | 0x00800 | Code signing | | ckuEmailProtection | 0x01000 | Email protection | | ckuTimeStamping | 0x02000 | Timestamping | | ckuOCSPSigning | 0x04000 | OCSP signing | | ckuSmartCardLogon | 0x08000 | Smartcard logon | | ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication | | ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC | 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](#samlreader-class) Class) Returns True if the certificate's key is cryptographically valid, and False otherwise. ## Object Oriented Interface ```text public function getSigningCertKeyValid(); ``` ## Procedural Interface ```text 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](#samlreader-class) 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 ```text public function getSigningCertOCSPLocations(); ``` ## Procedural Interface ```text 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](#CertificateManager_m_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](#samlreader-class) Class) Contains identifiers (OIDs) of the applicable certificate policies. ## Object Oriented Interface ```text public function getSigningCertPolicyIDs(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains the certificate's public key in DER format. ## Object Oriented Interface ```text public function getSigningCertPublicKeyBytes(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Indicates whether the certificate is self-signed (root) or signed by an external CA. ## Object Oriented Interface ```text public function getSigningCertSelfSigned(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Returns the certificate's serial number. ## Object Oriented Interface ```text public function getSigningCertSerialNumber(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Indicates the algorithm that was used by the CA to sign this certificate. ## Object Oriented Interface ```text public function getSigningCertSigAlgorithm(); ``` ## Procedural Interface ```text 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](#samlreader-class) 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 ```text public function getSigningCertSubject(); ``` ## Procedural Interface ```text 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](#signingcertsubjectrdn-property-secureblackbox_samlreader-class). This property is read-only and not available at design time. ## Data Type String # SigningCertSubjectKeyID Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Contains a unique identifier of the certificate's cryptographic key. ## Object Oriented Interface ```text public function getSigningCertSubjectKeyID(); ``` ## Procedural Interface ```text 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](#signingcertsubjectkeyid-property-secureblackbox_samlreader-class) and [SigningCertCAKeyID](#signingcertcakeyid-property-secureblackbox_samlreader-class) 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](#samlreader-class) Class) A list of Property=Value pairs that uniquely identify the certificate holder (subject). ## Object Oriented Interface ```text public function getSigningCertSubjectRDN(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) The time point at which the certificate becomes valid, in UTC. ## Object Oriented Interface ```text public function getSigningCertValidFrom(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) The time point at which the certificate expires, in UTC. ## Object Oriented Interface ```text public function getSigningCertValidTo(); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. ## Object Oriented Interface ```text public function getSocketDNSMode(); public function setSocketDNSMode($value); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 255 ); secureblackbox_samlreader_set($res, 255, $value ); ``` ## Possible Values ```text SAMLREADER_SOCKETDNSMODE_AUTO(0), SAMLREADER_SOCKETDNSMODE_PLATFORM(1), SAMLREADER_SOCKETDNSMODE_OWN(2), SAMLREADER_SOCKETDNSMODE_OWN_SECURE(3) ``` ## Default Value 0 ## Remarks Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system. | | | | --- | --- | | dmAuto | 0 | | dmPlatform | 1 | | dmOwn | 2 | | dmOwnSecure | 3 | ## Data Type Integer # SocketDNSPort Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Specifies the port number to be used for sending queries to the DNS server. ## Object Oriented Interface ```text public function getSocketDNSPort(); public function setSocketDNSPort($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) The timeout (in milliseconds) for each DNS query. ## Object Oriented Interface ```text public function getSocketDNSQueryTimeout(); public function setSocketDNSQueryTimeout($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) The addresses of DNS servers to use for address resolution, separated by commas or semicolons. ## Object Oriented Interface ```text public function getSocketDNSServers(); public function setSocketDNSServers($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) The timeout (in milliseconds) for the whole resolution process. ## Object Oriented Interface ```text public function getSocketDNSTotalTimeout(); public function setSocketDNSTotalTimeout($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) The maximum number of bytes to read from the socket, per second. ## Object Oriented Interface ```text public function getSocketIncomingSpeedLimit(); public function setSocketIncomingSpeedLimit($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) The local network interface to bind the socket to. ## Object Oriented Interface ```text public function getSocketLocalAddress(); public function setSocketLocalAddress($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) The local port number to bind the socket to. ## Object Oriented Interface ```text public function getSocketLocalPort(); public function setSocketLocalPort($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) The maximum number of bytes to write to the socket, per second. ## Object Oriented Interface ```text public function getSocketOutgoingSpeedLimit(); public function setSocketOutgoingSpeedLimit($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. ## Object Oriented Interface ```text public function getSocketTimeout(); public function setSocketTimeout($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Enables or disables IP protocol version 6. ## Object Oriented Interface ```text public function getSocketUseIPv6(); public function setSocketUseIPv6($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) The number of records in the Statement arrays. ## Object Oriented Interface ```text public function getStatementCount(); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 266 ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [StatementAuthnContextAuthenticatingAuthorities](#statementauthncontextauthenticatingauthorities-property-secureblackbox_samlreader-class) - [StatementAuthnContextChoice](#statementauthncontextchoice-property-secureblackbox_samlreader-class) - [StatementAuthnContextClassRef](#statementauthncontextclassref-property-secureblackbox_samlreader-class) - [StatementAuthnContextDecl](#statementauthncontextdecl-property-secureblackbox_samlreader-class) - [StatementAuthnContextDeclRef](#statementauthncontextdeclref-property-secureblackbox_samlreader-class) - [StatementAuthnInstant](#statementauthninstant-property-secureblackbox_samlreader-class) - [StatementAuthnSessionIndex](#statementauthnsessionindex-property-secureblackbox_samlreader-class) - [StatementAuthnSessionNotOnOrAfter](#statementauthnsessionnotonorafter-property-secureblackbox_samlreader-class) - [StatementAuthnSubjectLocalityAddress](#statementauthnsubjectlocalityaddress-property-secureblackbox_samlreader-class) - [StatementAuthnSubjectLocalityDNSName](#statementauthnsubjectlocalitydnsname-property-secureblackbox_samlreader-class) - [StatementAuthzActions](#statementauthzactions-property-secureblackbox_samlreader-class) - [StatementAuthzDecision](#statementauthzdecision-property-secureblackbox_samlreader-class) - [StatementAuthzDecisionEvidence](#statementauthzdecisionevidence-property-secureblackbox_samlreader-class) - [StatementAuthzDecisionResource](#statementauthzdecisionresource-property-secureblackbox_samlreader-class) - [StatementType](#statementtype-property-secureblackbox_samlreader-class) 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](#samlreader-class) Class) Contains the list of authenticating authorities. ## Object Oriented Interface ```text public function getStatementAuthnContextAuthenticatingAuthorities($statementindex); ``` ## Procedural Interface ```text 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](#statementcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # StatementAuthnContextChoice Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Specifies the authentication context choice variant. ## Object Oriented Interface ```text public function getStatementAuthnContextChoice($statementindex); ``` ## Procedural Interface ```text 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](#statementcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # StatementAuthnContextClassRef Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Indicates the authentication contexts class reference. ## Object Oriented Interface ```text public function getStatementAuthnContextClassRef($statementindex); ``` ## Procedural Interface ```text 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](#statementcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # StatementAuthnContextDecl Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Specifies the authentication contexts declaration. ## Object Oriented Interface ```text public function getStatementAuthnContextDecl($statementindex); ``` ## Procedural Interface ```text 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](#statementcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # StatementAuthnContextDeclRef Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Specifies the authentication contexts declaration reference. ## Object Oriented Interface ```text public function getStatementAuthnContextDeclRef($statementindex); ``` ## Procedural Interface ```text 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](#statementcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # StatementAuthnInstant Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Specifies the authentication event timestamp. ## Object Oriented Interface ```text public function getStatementAuthnInstant($statementindex); ``` ## Procedural Interface ```text 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](#statementcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # StatementAuthnSessionIndex Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Contains the authentication session index. ## Object Oriented Interface ```text public function getStatementAuthnSessionIndex($statementindex); ``` ## Procedural Interface ```text 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](#statementcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # StatementAuthnSessionNotOnOrAfter Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Maps to the SessionNotOnOrAfter parameter of the authentication statement. ## Object Oriented Interface ```text public function getStatementAuthnSessionNotOnOrAfter($statementindex); ``` ## Procedural Interface ```text 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](#statementcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # StatementAuthnSubjectLocalityAddress Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Specifies the authentication subjects address. ## Object Oriented Interface ```text public function getStatementAuthnSubjectLocalityAddress($statementindex); ``` ## Procedural Interface ```text 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](#statementcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # StatementAuthnSubjectLocalityDNSName Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Maps to the authentication subjects DNS name parameter. ## Object Oriented Interface ```text public function getStatementAuthnSubjectLocalityDNSName($statementindex); ``` ## Procedural Interface ```text 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](#statementcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # StatementAuthzActions Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Provides access to the list of actions of the authorization statement. ## Object Oriented Interface ```text public function getStatementAuthzActions($statementindex); ``` ## Procedural Interface ```text 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](#statementcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # StatementAuthzDecision Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Specifies the authorization decision. ## Object Oriented Interface ```text public function getStatementAuthzDecision($statementindex); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 278 , $statementindex); ``` ## Possible Values ```text SAMLREADER_STATEMENTAUTHZDECISION_PERMIT(0), SAMLREADER_STATEMENTAUTHZDECISION_DENY(1), SAMLREADER_STATEMENTAUTHZDECISION_INDETERMINATE(2) ``` ## 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](#statementcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type Integer # StatementAuthzDecisionEvidence Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Manages the authorization decision statement evidence parameter. ## Object Oriented Interface ```text public function getStatementAuthzDecisionEvidence($statementindex); ``` ## Procedural Interface ```text 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](#statementcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # StatementAuthzDecisionResource Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Specifies the authorization decision statement resource parameter. ## Object Oriented Interface ```text public function getStatementAuthzDecisionResource($statementindex); ``` ## Procedural Interface ```text 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](#statementcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # StatementType Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Specifies the assertion statement type. ## Object Oriented Interface ```text public function getStatementType($statementindex); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 281 , $statementindex); ``` ## Possible Values ```text SAMLREADER_STATEMENTTYPE_AUTHN(0), SAMLREADER_STATEMENTTYPE_ATTRIBUTE(1), SAMLREADER_STATEMENTTYPE_AUTHZ_DECISION(2) ``` ## 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](#statementcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type Integer # SubjectConfirmationCount Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) The number of records in the SubjectConfirmation arrays. ## Object Oriented Interface ```text public function getSubjectConfirmationCount(); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 282 ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [SubjectConfirmationAddress](#subjectconfirmationaddress-property-secureblackbox_samlreader-class) - [SubjectConfirmationData](#subjectconfirmationdata-property-secureblackbox_samlreader-class) - [SubjectConfirmationDataType](#subjectconfirmationdatatype-property-secureblackbox_samlreader-class) - [SubjectConfirmationID](#subjectconfirmationid-property-secureblackbox_samlreader-class) - [SubjectConfirmationInResponseTo](#subjectconfirmationinresponseto-property-secureblackbox_samlreader-class) - [SubjectConfirmationMethod](#subjectconfirmationmethod-property-secureblackbox_samlreader-class) - [SubjectConfirmationNotBefore](#subjectconfirmationnotbefore-property-secureblackbox_samlreader-class) - [SubjectConfirmationNotOnOrAfter](#subjectconfirmationnotonorafter-property-secureblackbox_samlreader-class) - [SubjectConfirmationRecipient](#subjectconfirmationrecipient-property-secureblackbox_samlreader-class) 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](#samlreader-class) Class) Contains the address enabled for presenting assertions. ## Object Oriented Interface ```text public function getSubjectConfirmationAddress($subjectconfirmationindex); ``` ## Procedural Interface ```text 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](#subjectconfirmationcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # SubjectConfirmationData Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) The uninterpreted value of data entry in the subject confirmation. ## Object Oriented Interface ```text public function getSubjectConfirmationData($subjectconfirmationindex); ``` ## Procedural Interface ```text 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](#subjectconfirmationcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # SubjectConfirmationDataType Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) The type of data contained in the confirmation. ## Object Oriented Interface ```text public function getSubjectConfirmationDataType($subjectconfirmationindex); ``` ## Procedural Interface ```text 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](#subjectconfirmationcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # SubjectConfirmationID Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) The identifier of the entity which can satisfy the subject confirmation requirements. ## Object Oriented Interface ```text public function getSubjectConfirmationID($subjectconfirmationindex); ``` ## Procedural Interface ```text 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](#subjectconfirmationcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # SubjectConfirmationInResponseTo Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) The ID of the SAML message in response to which the assertion is issued. ## Object Oriented Interface ```text public function getSubjectConfirmationInResponseTo($subjectconfirmationindex); ``` ## Procedural Interface ```text 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](#subjectconfirmationcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # SubjectConfirmationMethod Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Specifies the mechanism to be used to confirm the subject. ## Object Oriented Interface ```text public function getSubjectConfirmationMethod($subjectconfirmationindex); ``` ## Procedural Interface ```text 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](#subjectconfirmationcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # SubjectConfirmationNotBefore Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Time moment before which the subject cannot be confirmed. ## Object Oriented Interface ```text public function getSubjectConfirmationNotBefore($subjectconfirmationindex); ``` ## Procedural Interface ```text 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](#subjectconfirmationcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # SubjectConfirmationNotOnOrAfter Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Limits the time until which the subject can be confirmed. ## Object Oriented Interface ```text public function getSubjectConfirmationNotOnOrAfter($subjectconfirmationindex); ``` ## Procedural Interface ```text 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](#subjectconfirmationcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # SubjectConfirmationRecipient Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) The URI of the entity or the location of the resource to which the assertion should be presented. ## Object Oriented Interface ```text public function getSubjectConfirmationRecipient($subjectconfirmationindex); ``` ## Procedural Interface ```text 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](#subjectconfirmationcount-property-secureblackbox_samlreader-class) property. This property is read-only and not available at design time. ## Data Type String # TLSAutoValidateCertificates Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. ## Object Oriented Interface ```text public function getTLSAutoValidateCertificates(); public function setTLSAutoValidateCertificates($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Selects the base configuration for the TLS settings. ## Object Oriented Interface ```text public function getTLSBaseConfiguration(); public function setTLSBaseConfiguration($value); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 293 ); secureblackbox_samlreader_set($res, 293, $value ); ``` ## Possible Values ```text SAMLREADER_TLSBASECONFIGURATION_DEFAULT(0), SAMLREADER_TLSBASECONFIGURATION_COMPATIBLE(1), SAMLREADER_TLSBASECONFIGURATION_COMPREHENSIVE_INSECURE(2), SAMLREADER_TLSBASECONFIGURATION_HIGHLY_SECURE(3) ``` ## 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. | | | | | --- | --- | --- | | stpcDefault | 0 | | | stpcCompatible | 1 | | | stpcComprehensiveInsecure | 2 | | | stpcHighlySecure | 3 | | ## Data Type Integer # TLSCiphersuites Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) A list of ciphersuites separated with commas or semicolons. ## Object Oriented Interface ```text public function getTLSCiphersuites(); public function setTLSCiphersuites($value); ``` ## Procedural Interface ```text 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](#tlsbaseconfiguration-property-secureblackbox_samlreader-class). 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](#samlreader-class) Class) Enables or disables certificate-based client authentication. ## Object Oriented Interface ```text public function getTLSClientAuth(); public function setTLSClientAuth($value); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 295 ); secureblackbox_samlreader_set($res, 295, $value ); ``` ## Possible Values ```text SAMLREADER_TLSCLIENTAUTH_NO_AUTH(0), SAMLREADER_TLSCLIENTAUTH_REQUEST_CERT(1), SAMLREADER_TLSCLIENTAUTH_REQUIRE_CERT(2) ``` ## Default Value 0 ## Remarks Enables or disables certificate-based client authentication. Set this property to true to tune up the client authentication type: | | | | | --- | --- | --- | | ccatNoAuth | 0 | | | ccatRequestCert | 1 | | | ccatRequireCert | 2 | | ## Data Type Integer # TLSExtensions Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Provides access to TLS extensions. ## Object Oriented Interface ```text public function getTLSExtensions(); public function setTLSExtensions($value); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 296 ); secureblackbox_samlreader_set($res, 296, $value ); ``` ## Default Value '' ## Remarks Provides access to TLS extensions. ## Data Type String # TLSForceResumeIfDestinationChanges Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Whether to force TLS session resumption when the destination address changes. ## Object Oriented Interface ```text public function getTLSForceResumeIfDestinationChanges(); public function setTLSForceResumeIfDestinationChanges($value); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 297 ); secureblackbox_samlreader_set($res, 297, $value ); ``` ## Default Value false ## Remarks Whether to force TLS session resumption when the destination address changes. ## Data Type Boolean # TLSGroups Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Specifies a list of key exchange groups to attempt during the TLS key exchange. ## Object Oriented Interface ```text public function getTLSGroups(); public function setTLSGroups($value); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 298 ); secureblackbox_samlreader_set($res, 298, $value ); ``` ## Default Value '' ## Remarks Specifies a list of key exchange groups to attempt during the TLS key exchange. Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the *all* placeholder: ```text // Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048"; // Only enable the hybrid X25519/ML-KEM768 group client.TLSSettings.Groups = "-all;+x25519mlkem768"; ``` The list of groups supported by the component is provided below. All the names are case-insensitive: **Elliptic curve-based groups:** - SECT163K1 - SECT163R1 - SECT163R2 - SECT193R1 - SECT193R2 - SECT233K1 - SECT233R1 - SECT239K1 - SECT283K1 - SECT283R1 - SECT409K1 - SECT409R1 - SECT571K1 - SECT571R1 - SECP160K1 - SECP160R1 - SECP160R2 - SECP192K1 - SECP192R1 - SECP224K1 - SECP224R1 - SECP256K1 - SECP256R1 - SECP384R1 - SECP521R1 - BRAINPOOLP256R1 - BRAINPOOLP384R1 - BRAINPOOLP512R1 - X25519 - X448 **Finite field-based groups:** - FFDHE2048 - FFDHE3072 - FFDHE4096 - FFDHE6144 - FFDHE8192 **Post-Quantum and Hybrid groups:** - MLKEM512 - MLKEM768 - MLKEM1024 - SECP256R1MLKEM768 - X25519MLKEM768 - SECP384R1MLKEM1024 Note: this property was called *ECCurves* in SecureBlackbox 2024 and older. ## Data Type String # TLSPreSharedIdentity Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. ## Object Oriented Interface ```text public function getTLSPreSharedIdentity(); public function setTLSPreSharedIdentity($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. ## Object Oriented Interface ```text public function getTLSPreSharedKey(); public function setTLSPreSharedKey($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. ## Object Oriented Interface ```text public function getTLSPreSharedKeyCiphersuite(); public function setTLSPreSharedKeyCiphersuite($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Selects the renegotiation attack prevention mechanism. ## Object Oriented Interface ```text public function getTLSRenegotiationAttackPreventionMode(); public function setTLSRenegotiationAttackPreventionMode($value); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 302 ); secureblackbox_samlreader_set($res, 302, $value ); ``` ## Possible Values ```text SAMLREADER_TLSRENEGOTIATIONATTACKPREVENTIONMODE_COMPATIBLE(0), SAMLREADER_TLSRENEGOTIATIONATTACKPREVENTIONMODE_STRICT(1), SAMLREADER_TLSRENEGOTIATIONATTACKPREVENTIONMODE_AUTO(2) ``` ## Default Value 2 ## Remarks Selects the renegotiation attack prevention mechanism. The following options are available: | | | | | --- | --- | --- | | crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). | | crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. | | crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. | ## Data Type Integer # TLSRevocationCheck Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Specifies the kind(s) of revocation check to perform. ## Object Oriented Interface ```text public function getTLSRevocationCheck(); public function setTLSRevocationCheck($value); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 303 ); secureblackbox_samlreader_set($res, 303, $value ); ``` ## Possible Values ```text SAMLREADER_TLSREVOCATIONCHECK_NONE(0), SAMLREADER_TLSREVOCATIONCHECK_AUTO(1), SAMLREADER_TLSREVOCATIONCHECK_ALL_CRL(2), SAMLREADER_TLSREVOCATIONCHECK_ALL_OCSP(3), SAMLREADER_TLSREVOCATIONCHECK_ALL_CRLAND_OCSP(4), SAMLREADER_TLSREVOCATIONCHECK_ANY_CRL(5), SAMLREADER_TLSREVOCATIONCHECK_ANY_OCSP(6), SAMLREADER_TLSREVOCATIONCHECK_ANY_CRLOR_OCSP(7), SAMLREADER_TLSREVOCATIONCHECK_ANY_OCSPOR_CRL(8) ``` ## 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. | | | | | --- | --- | --- | | crcNone | 0 | No revocation checking. | | crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. | | crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. | | crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. | | crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. | | crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. | | crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. | | crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. | | crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. | 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](#samlreader-class) 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 ```text public function getTLSSSLOptions(); public function setTLSSSLOptions($value); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 304 ); secureblackbox_samlreader_set($res, 304, $value ); ``` ## Default Value 16 ## Remarks 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. It is unlikely that you will ever need to adjust it. | | cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. | | cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known | | cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only | | cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. | | cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled | | cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms | | cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks | | cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually | ## Data Type Integer # TLSMode Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Specifies the TLS mode to use. ## Object Oriented Interface ```text public function getTLSMode(); public function setTLSMode($value); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 305 ); secureblackbox_samlreader_set($res, 305, $value ); ``` ## Possible Values ```text SAMLREADER_TLSMODE_DEFAULT(0), SAMLREADER_TLSMODE_NO_TLS(1), SAMLREADER_TLSMODE_EXPLICIT_TLS(2), SAMLREADER_TLSMODE_IMPLICIT_TLS(3), SAMLREADER_TLSMODE_MIXED_TLS(4) ``` ## Default Value 0 ## Remarks Specifies the TLS mode to use. | | | | | --- | --- | --- | | smDefault | 0 | | | smNoTLS | 1 | Do not use TLS | | smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. | | smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. | | smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. | ## Data Type Integer # TLSUseExtendedMasterSecret Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Enables the Extended Master Secret Extension, as defined in RFC 7627. ## Object Oriented Interface ```text public function getTLSUseExtendedMasterSecret(); public function setTLSUseExtendedMasterSecret($value); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 306 ); secureblackbox_samlreader_set($res, 306, $value ); ``` ## Default Value true ## Remarks Enables the Extended Master Secret Extension, as defined in RFC 7627. ## Data Type Boolean # TLSUseSessionResumption Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Enables or disables the TLS session resumption capability. ## Object Oriented Interface ```text public function getTLSUseSessionResumption(); public function setTLSUseSessionResumption($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) The SSL/TLS versions to enable by default. ## Object Oriented Interface ```text public function getTLSVersions(); public function setTLSVersions($value); ``` ## Procedural Interface ```text secureblackbox_samlreader_get($res, 308 ); secureblackbox_samlreader_set($res, 308, $value ); ``` ## Default Value 48 ## Remarks The SSL/TLS versions to enable by default. | | | | | --- | --- | --- | | csbSSL2 | 0x01 | SSL 2 | | csbSSL3 | 0x02 | SSL 3 | | csbTLS1 | 0x04 | TLS 1.0 | | csbTLS11 | 0x08 | TLS 1.1 | | csbTLS12 | 0x10 | TLS 1.2 | | csbTLS13 | 0x20 | TLS 1.3 | ## Data Type Integer # UseBinding Property ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Enables or disables automated binding processing. ## Object Oriented Interface ```text public function getUseBinding(); public function setUseBinding($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Enables or disables automated signature validation. ## Object Oriented Interface ```text public function getValidateSignatures(); public function setValidateSignatures($value); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Compares two SAML IDs. ## Object Oriented Interface ```text public function doCompareIDs($id1, $id2); ``` ## Procedural Interface ```text secureblackbox_samlreader_do_compareids($res, $id1, $id2); ``` ## Remarks Use this utility function to easily compare two SAML IDs. # Config Method ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Sets or retrieves a configuration setting. ## Object Oriented Interface ```text public function doConfig($configurationstring); ``` ## Procedural Interface ```text 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](#config-settings-samlreader-class) 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](#config-settings-samlreader-class), you must call *Config("PROPERTY")*. The value will be returned as a string. # DoAction Method ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Performs an additional action. ## Object Oriented Interface ```text public function doDoAction($actionid, $actionparams); ``` ## Procedural Interface ```text 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;...*. Common ActionIDs: | | | | | | --- | --- | --- | --- | | Action | Parameters | Returned value | Description | | ResetTrustedListCache | none | none | Clears the cached list of trusted lists. | | ResetCertificateCache | none | none | Clears the cached certificates. | | ResetCRLCache | none | none | Clears the cached CRLs. | | ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. | # GetIDProp Method ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Extracts a specific property from a SAML ID. ## Object Oriented Interface ```text public function doGetIDProp($id, $propname); ``` ## Procedural Interface ```text 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](#samlreader-class) Class) Opens a SAML entity. ## Object Oriented Interface ```text public function doOpen($input); ``` ## Procedural Interface ```text secureblackbox_samlreader_do_open($res, $input); ``` ## Remarks Use this method to process a SAML entity contained in a string. # OpenBytes Method ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Opens a SAML entity. ## Object Oriented Interface ```text public function doOpenBytes($inputbytes); ``` ## Procedural Interface ```text secureblackbox_samlreader_do_openbytes($res, $inputbytes); ``` ## Remarks Use this method to process a SAML entity stored as a byte array. # OpenFile Method ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Opens a SAML entity. ## Object Oriented Interface ```text public function doOpenFile($inputfile); ``` ## Procedural Interface ```text secureblackbox_samlreader_do_openfile($res, $inputfile); ``` ## Remarks Use this method to process a SAML entity contained in a file. # PinAssertion Method ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Pins assertion by propagating it in PinnedAssertionXXX properties. ## Object Oriented Interface ```text public function doPinAssertion($assertionindex); ``` ## Procedural Interface ```text 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](#assertioncount-property-secureblackbox_samlreader-class) to obtain the number of assertions in the message. # Reset Method ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Resets the class settings. ## Object Oriented Interface ```text public function doReset(); ``` ## Procedural Interface ```text secureblackbox_samlreader_do_reset($res); ``` ## Remarks Reset is a generic method available in every class. # Encrypted Event ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Notifies the application that the assertion is encrypted and provides recipient certificate details. ## Object Oriented Interface ```text public function fireEncrypted($param); ``` ## Procedural Interface ```text secureblackbox_samlreader_register_callback($res, 1, array($this, 'fireEncrypted')); ``` ## Parameter List ```text '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](#samlreader-class) Class) Fires to report an error condition. ## Object Oriented Interface ```text public function fireError($param); ``` ## Procedural Interface ```text secureblackbox_samlreader_register_callback($res, 2, array($this, 'fireError')); ``` ## Parameter List ```text '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](#samlreader-class) Class) This event notifies the application about an underlying control flow event. ## Object Oriented Interface ```text public function fireNotification($param); ``` ## Procedural Interface ```text secureblackbox_samlreader_register_callback($res, 3, array($this, 'fireNotification')); ``` ## Parameter List ```text '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](#samlreader-class) Class) Signifies the start of signature validation. ## Object Oriented Interface ```text public function fireSignatureFound($param); ``` ## Procedural Interface ```text secureblackbox_samlreader_register_callback($res, 4, array($this, 'fireSignatureFound')); ``` ## Parameter List ```text '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. | | | | | --- | --- | --- | | sssUnknown | 0 | The scope of signature is unknown | | sssMessage | 1 | The signature covers the entire SAML message | | sssAssertion | 2 | The signature covers an assertion | | sssBinding | 3 | The signature covers the binding | 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](CertificateValidator.md#CertificateValidator) component to validate its chain. Use the *Validate* parameter to tell the reader whether it should validate the signature. # SignatureValidated Event ([SecureBlackbox_SAMLReader](#samlreader-class) Class) Reports the signature validation result. ## Object Oriented Interface ```text public function fireSignatureValidated($param); ``` ## Procedural Interface ```text secureblackbox_samlreader_register_callback($res, 5, array($this, 'fireSignatureValidated')); ``` ## Parameter List ```text '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. | | | | | --- | --- | --- | | sssUnknown | 0 | The scope of signature is unknown | | sssMessage | 1 | The signature covers the entire SAML message | | sssAssertion | 2 | The signature covers an assertion | | sssBinding | 3 | The signature covers the binding | *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: | | | | | --- | --- | --- | | svtValid | 0 | The signature is valid | | svtUnknown | 1 | Signature validity is unknown | | svtCorrupted | 2 | The signature is corrupted | | svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. | | svtFailure | 4 | General failure | | svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) | # Config Settings ([SAMLReader](#samlreader-class) 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](#config-method-secureblackbox_samlreader-class) method. ### SAMLReader Config Settings **Body**: Returns the XML of the currently processed entity.Use this read-only configuration property to retrieve the XML body of the currently processed entity. **EncryptionCert**: Returns the body of the encryption certificate.Use this property to retrieve the body of the certificate that was used to encrypt the assertion. **EncryptionSubjectRDN**: Returns the Subject RDN of the encryption certificate.Use this property to retrieve the subject RDN fields of the encryption certificate. **OpportunisticCertLookup**: Enables opportunistic signing certificate lookup.Enable this property to tell SAMLReader to try to validate the signature with every certificate provided in the Certificates collection if the signer did not include its certificate information in the signature. If at least one certificate is found to cryptographically match the signature, the signature is accepted as valid. **ValidateSignatureReferences**: Enables or disables XML signature reference validation.Set this property to false to disable signature references integrity validation. Use with care: switching off this property disables an important step of signature validation process. ### Base Config Settings **ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it. **AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it. **CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used. You can switch this property off to improve performance if your project only uses known, good private keys. **CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the class.Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. **DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. **DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*. **EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections. This setting only applies to sessions negotiated with TLS version 1.3. **EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components. **EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components. **GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its *CookieCaching* property set to "global". **HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy. Supported Values: | | | | --- | --- | | auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). | | enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. | | disable | Do not use hardware cryptography. | **HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. **HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use. **IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account. **ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence. **LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped. Supported values are: | | | | | --- | --- | --- | | file | | File | | console | | Console | | systemlog | | System Log (supported for Android only) | | debugger | | Debugger (supported for VCL for Windows and .Net) | **LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump. Supported values are: | | | | | --- | --- | --- | | time | | Current time | | level | | Level | | package | | Package name | | module | | Module name | | class | | Class name | | method | | Method name | | threadid | | Thread Id | | contenttype | | Content type | | content | | Content | | all | | All details | **LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file. **LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters. Supported filter names are: | | | | | --- | --- | --- | | exclude-package | | Exclude a package specified in the value | | exclude-module | | Exclude a module specified in the value | | exclude-class | | Exclude a class specified in the value | | exclude-method | | Exclude a method specified in the value | | include-package | | Include a package specified in the value | | include-module | | Include a module specified in the value | | include-class | | Include a class specified in the value | | include-method | | Include a method specified in the value | **LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined: | | | | | --- | --- | --- | | none | | No flush (caching only) | | immediate | | Immediate flush (real-time logging) | | maxcount | | Flush cached entries upon reaching LogMaxEventCount entries in the cache. | **LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level. Supported values are: | | | | | --- | --- | --- | | none | | None (by default) | | fatal | | Severe errors that cause premature termination. | | error | | Other runtime errors or unexpected conditions. | | warning | | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | | info | | Interesting runtime events (startup/shutdown). | | debug | | Detailed information on flow of through the system. | | trace | | More detailed information. | **LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode. The default value of this setting is 100. **LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined: | | | | | --- | --- | --- | | none | | No rotation | | deleteolder | | Delete older entries from the cache upon reaching LogMaxEventCount | | keepolder | | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) | **MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. **MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. **OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. **OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak. **PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached. Supported Values: | | | | --- | --- | | certificate | Enables caching of certificates. | | crl | Enables caching of Certificate Revocation Lists (CRLs). | | ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. | Example (default value): ```text PKICache=certificate,crl,ocsp ``` In this example, the component caches certificates, CRLs, and OCSP responses. **PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts. The default value is an empty string - no cached PKI data is stored on disk. Example: ```text PKICachePath=C:\Temp\cache ``` In this example, the cached PKI data is stored in the C:\Temp\cache directory. **ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision). **ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character. **StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the class is set to "*local*", the property returns/restores the rules from/to the internal storage of the class. If *StaticDNS* of the class is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. **Tag**: Allows to store any custom data.Use this config property to store any custom data. **TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes. **TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes). **TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute). **UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used. **UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform. **UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details). **UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used. **UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. **UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. **UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team. **UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation. This setting only applies to certificates originating from a Windows system store. **UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. **XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures. The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing. Syntax: ```text Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2"); ``` Where: OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map. PrimaryName: The main descriptor name used in the XML signature when the OID is encountered. Alias1, Alias2, ...: Optional alternative names recognized during parsing. Usage Examples: Map OID 2.5.4.5 to SERIALNUMBER: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS"); ``` **XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing. **XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1). **XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value. # Trappable Errors ([SAMLReader](#samlreader-class) Class)