SAMLReader Class

Properties   Methods   Events   Config Settings   Errors  

The SAMLReader class offers SAML message processing functionality.

Syntax

SAMLReader

Remarks

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

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

SAMLReader can process the following types of SAML messages:

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

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

The snippet below shows how to use SAMLReader to process a message of the AuthnRequest type created by the matching SAMLReader example (or by any compatible SAML endpoint). The input SAML message has the following look:

 
 Copy
  <samlp:AuthnRequest 
    xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion" ID="53GhrzQ5f89fu214ANAR" Version="2.0" 
    IssueInstant="2021-12-15T10:39:31Z" Destination="http://destination-url.com" IsPassive="false" 
    ProtocolBinding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" 
    AssertionConsumerServiceURL="https://assertion-consumer-url.com" AttributeConsumingServiceIndex="1" 
    xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol">
    <saml:Issuer Format="urn:oasis:names:tc:SAML:2.0:nameid-format:entity">https://issuer-url.com</saml:Issuer>
    <ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
      <ds:SignedInfo>
        <ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
        <ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/>
        <ds:Reference URI="#53GhrzQ5f89fu214ANAR">
          <ds:Transforms>
            <ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/>
            <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
          </ds:Transforms>
          <ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/><ds:DigestValue>+xhhgXtwYN0/r9h7WAwg=</ds:DigestValue>
        </ds:Reference>
      </ds:SignedInfo>
      <ds:SignatureValue>
        jfYeIq/z8D1tJZYbVqDMoqKpdrfGMj8/zI7gbUsJbECAr00cN34md2QG0mo4cOx7pny+5
        Tht7tUzqENHqcZdmlOcZc2JcJqokVxIcLEluFiWKlNjpexkXFQKzOC1peRfTZm8SQTqtP
        Cz8IknLUc6Scfml29PHmks1PxjJDteGb/+FggsZRTGZC3a05nvH3ayvHukPeHuHssx5dX
        nj0quT8salR6fdx6lAJo/AnDHzcfBNyxAMn+ebk5VOOgVD1L3PayvXib/maj8aVI2I5UT
        o4vmfybTWKzeS8DX9We7UV+4Xowwe647t1A912xLVub/e23A18Yf1V0PXC87kttTkA==
      </ds:SignatureValue>
      <ds:KeyInfo>
        <ds:X509Data><ds:X509Certificate>
          MIIEKDCCAxCgAwIBAgIFYA3A3gIwDQYJKoZIhvcNAQELBQAwfjELMAkGA1UEBhMCVVMxC
          zAJBgNVBAgTAk5DMRQwEgYDVQQHEwtDaGFwZWwgSGlsbDEiMCAGCSqGSIb3DQEJARMTc2
          FsZXNAbnNvZnR3YXJlLmNvbTEoMCYGA1UEAxMfU2VjdXJlQmxhY2tib3ggRGVtbyBDZXJ
          0aWZpY2F0ZTAeFw0xNzA5MDEwMDAwMDBaFw0yMjA5MDEwMDAwMDBaMH4xCzAJBgNVBAYT
          AlVTMQswCQYDVQQIEwJOQzEUMBIGA1UEBxMLQ2hhcGVsIEhpbGwxIjAgBgkqhkiG9w0BC
          QETE3NhbGVzQG5zb2Z0d2FyZS5jb20xKDAmBgNVBAMTH1NlY3VyZUJsYWNrYm94IERlbW
          8gQ2VydGlmaWNhdGUwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCfAVIcq9o
          eoIbw56LsPjxWsX3YGkqasBQzgQymhfcDZeSvFKFis8iqArGLTUUWOaImO5t2UmjIa+4n
          YP39hb9Z1r0CMy53p83oYbbZZ7qMeji0pMAufJHqKCN8t2HNWf2HE8S9UOU7R/UHdrSAN
          JitBKV9lSG9f450yWoGNwt35ZCsOp0zqtCgvkEvteGsz01R5DDjOccs3QNu25K/Sf27KP
          CYabS6A1ehYNY/G32qoKNJhu3DN4bWje57gBWi9WSfQ3tZUOV5q2ozaNJA78Wl4fXC6RB
          CaBh0GOwXeyZoH13LJdn+lqlCSMz024ImG4yFQEENbWvE9Elku8RYTn73AgMBAAGjgaww
          gakwHwYDVR0jBBgwFoAUmt/L7GI1SH36Sp8EUBxTwuzSgqMwHQYDVR0OBBYEFJrfy+xiN
          Uh9+kqfBFAcU8Ls0oKjMA8GA1UdEwEB/wQFMAMBAf8wDwYDVR0PAQH/BAUDAwDuADBFBg
          NVHSUEPjA8BggrBgEFBQcDAQYIKwYBBQUHAwIGCCsGAQUFBwMDBggrBgEFBQcDBAYIKwY
          BBQUHAwgGCCsGAQUFBwMJMA0GCSqGSIb3DQEBCwUAA4IBAQBovHBbMsW/k/5iuLQQqsYS
          ng5X2iy1W+5BRb1hz0MGnHGLqJWy1ty5+bTo6g/zvT65dXIPIexLkInEenYSy75Lthr6a
          ewUcvwfl1TYXjWlMD5Nm5pM9As71+XsGSdYGXoKohbEzbT6RDByjwR+yxtatqko7e1Eg6
          InNJRTRt7al/63FSPEgSCqOX6asDVDNZ83db0dOcoeaPEiDz3liE3+tYHtKXj5/qwTtYd
          aqBZxdJfuCKZveEFe1DO3/ayDvIvG9Eme+rEjntErF+Cw9a8ukesvDuT49cRE9oTs3O7f
          6LUbhCv5zJN+dTFr75NSdWdp4yvn3nK3i2udeMnTWK0U
        </ds:X509Certificate></ds:X509Data>
      </ds:KeyInfo>
    </ds:Signature>
    <samlp:NameIDPolicy Format="urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"/>
    <saml:Conditions NotBefore="2021-12-15T10:39:31Z" NotOnOrAfter="2021-12-15T11:09:31Z"><saml:OneTimeUse/></saml:Conditions>
  </samlp:AuthnRequest>

 
 Copy
  Samlreader reader = new Samlreader();

  reader.ValidateSignatures = true;
  reader.Open(req);

  Log("SAML document loaded. The message is of the " + reader.InputTypeString + " type, and was issued by " + reader.Issuer + " at " + reader.IssueInstant + ".");

  if (reader.InputType == SamlreaderInputTypes.cstyAuthnRequest)
  {
      Log("AuthnRequest.ConsumerServiceURL: " + reader.AuthnRequest.AssertionConsumerServiceURL);
      Log("AuthnRequest.ProtocolBinding: " + reader.AuthnRequest.ProtocolBinding);
      Log("AuthnRequest.Conditions.NotBefore: " + reader.AuthnRequest.ConditionsNotBefore);
      Log("AuthnRequest.Conditions.NotAfter: " + reader.AuthnRequest.ConditionsNotOnOrAfter);
  }

  if (reader.Signed) 
  {
      Log("The message was signed by " + reader.SigningCertificate.SubjectRDN);
      Log("Signature validity: " + reader.SignatureValidationResult.ToString());
  }

Property List

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

Method List

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

Event List

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

Config Settings

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

ArtifactEndpointIndex Property (SAMLReader Class)

An accessor to the EndpointIndex entry of the artifact.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetArtifactEndpointIndex();

Unicode (Windows)
INT GetArtifactEndpointIndex();

int secureblackbox_samlreader_getartifactendpointindex(void* lpObj);

int GetArtifactEndpointIndex();

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 (SAMLReader Class)

An accessor to the MessageHandle property of the artifact.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetArtifactMessageHandle(char* &lpArtifactMessageHandle, int &lenArtifactMessageHandle);

Unicode (Windows)
INT GetArtifactMessageHandle(LPSTR &lpArtifactMessageHandle, INT &lenArtifactMessageHandle);

int secureblackbox_samlreader_getartifactmessagehandle(void* lpObj, char** lpArtifactMessageHandle, int* lenArtifactMessageHandle);

QByteArray GetArtifactMessageHandle();

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 (SAMLReader Class)

Returns the contents of the artifact.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetArtifactRemainingArtifact(char* &lpArtifactRemainingArtifact, int &lenArtifactRemainingArtifact);

Unicode (Windows)
INT GetArtifactRemainingArtifact(LPSTR &lpArtifactRemainingArtifact, INT &lenArtifactRemainingArtifact);

int secureblackbox_samlreader_getartifactremainingartifact(void* lpObj, char** lpArtifactRemainingArtifact, int* lenArtifactRemainingArtifact);

QByteArray GetArtifactRemainingArtifact();

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 (SAMLReader Class)

An accessor to the SourceID property of the artifact.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetArtifactSourceID(char* &lpArtifactSourceID, int &lenArtifactSourceID);

Unicode (Windows)
INT GetArtifactSourceID(LPSTR &lpArtifactSourceID, INT &lenArtifactSourceID);

int secureblackbox_samlreader_getartifactsourceid(void* lpObj, char** lpArtifactSourceID, int* lenArtifactSourceID);

QByteArray GetArtifactSourceID();

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 (SAMLReader Class)

The TypeCode property of the artifact.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetArtifactTypeCode();

Unicode (Windows)
INT GetArtifactTypeCode();

int secureblackbox_samlreader_getartifacttypecode(void* lpObj);

int GetArtifactTypeCode();

Default Value

0

Remarks

The TypeCode field of the artifact.

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

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

Data Type

Integer

ArtifactURI Property (SAMLReader Class)

An accessor to the URI property of the artifact.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArtifactURI();

Unicode (Windows)
LPWSTR GetArtifactURI();

char* secureblackbox_samlreader_getartifacturi(void* lpObj);

QString GetArtifactURI();

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 (SAMLReader Class)

Returns the content of the ArtifactResolve query.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArtifactResolveQuery();

Unicode (Windows)
LPWSTR GetArtifactResolveQuery();

char* secureblackbox_samlreader_getartifactresolvequery(void* lpObj);

QString GetArtifactResolveQuery();

Default Value

""

Remarks

Check this property if InputType is set to cstyArtifactResolve to access the content of the ArtifactResolve query.

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

Data Type

String

AssertionCount Property (SAMLReader Class)

Returns the number of assertions in the SAML message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAssertionCount();

Unicode (Windows)
INT GetAssertionCount();

int secureblackbox_samlreader_getassertioncount(void* lpObj);

int GetAssertionCount();

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

AssertionIDRequestReferences Property (SAMLReader Class)

Contains the References entry of the SAML assertion ID request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionIDRequestReferences();

Unicode (Windows)
LPWSTR GetAssertionIDRequestReferences();

char* secureblackbox_samlreader_getassertionidrequestreferences(void* lpObj);

QString GetAssertionIDRequestReferences();

Default Value

""

Remarks

Contains the References entry of the SAML assertion ID request.

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

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

Data Type

String

AttrQueryAttrCount Property (SAMLReader Class)

The number of records in the AttrQueryAttr arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAttrQueryAttrCount();

Unicode (Windows)
INT GetAttrQueryAttrCount();

int secureblackbox_samlreader_getattrqueryattrcount(void* lpObj);

int GetAttrQueryAttrCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttrQueryAttrFriendlyName
• AttrQueryAttrName
• AttrQueryAttrNameFormat
• AttrQueryAttrStatementIndex
• AttrQueryAttrValues

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

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

Data Type

Integer

AttrQueryAttrFriendlyName Property (SAMLReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttrQueryAttrFriendlyName(int iAttrQueryAttrIndex);

Unicode (Windows)
LPWSTR GetAttrQueryAttrFriendlyName(INT iAttrQueryAttrIndex);

char* secureblackbox_samlreader_getattrqueryattrfriendlyname(void* lpObj, int attrqueryattrindex);

QString GetAttrQueryAttrFriendlyName(int iAttrQueryAttrIndex);

Default Value

""

Remarks

Specifies the friendly name of the attribute

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

The AttrQueryAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrQueryAttrCount property.

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

Data Type

String

AttrQueryAttrName Property (SAMLReader Class)

Specifies the name of the attribute.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttrQueryAttrName(int iAttrQueryAttrIndex);

Unicode (Windows)
LPWSTR GetAttrQueryAttrName(INT iAttrQueryAttrIndex);

char* secureblackbox_samlreader_getattrqueryattrname(void* lpObj, int attrqueryattrindex);

QString GetAttrQueryAttrName(int iAttrQueryAttrIndex);

Default Value

""

Remarks

Specifies the name of the attribute.

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

The AttrQueryAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrQueryAttrCount property.

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

Data Type

String

AttrQueryAttrNameFormat Property (SAMLReader Class)

Indicates the format used to reference the attribute.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttrQueryAttrNameFormat(int iAttrQueryAttrIndex);

Unicode (Windows)
LPWSTR GetAttrQueryAttrNameFormat(INT iAttrQueryAttrIndex);

char* secureblackbox_samlreader_getattrqueryattrnameformat(void* lpObj, int attrqueryattrindex);

QString GetAttrQueryAttrNameFormat(int iAttrQueryAttrIndex);

Default Value

""

Remarks

Indicates the format used to reference the attribute.

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

The AttrQueryAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrQueryAttrCount property.

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

Data Type

String

AttrQueryAttrStatementIndex Property (SAMLReader Class)

Contains the index of the statement the attribute corresponds to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAttrQueryAttrStatementIndex(int iAttrQueryAttrIndex);

Unicode (Windows)
INT GetAttrQueryAttrStatementIndex(INT iAttrQueryAttrIndex);

int secureblackbox_samlreader_getattrqueryattrstatementindex(void* lpObj, int attrqueryattrindex);

int GetAttrQueryAttrStatementIndex(int iAttrQueryAttrIndex);

Default Value

-1

Remarks

Contains the index of the statement the attribute corresponds to.

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

The AttrQueryAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrQueryAttrCount property.

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

Data Type

Integer

AttrQueryAttrValues Property (SAMLReader Class)

Contains a list of attribute values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttrQueryAttrValues(int iAttrQueryAttrIndex);

Unicode (Windows)
LPWSTR GetAttrQueryAttrValues(INT iAttrQueryAttrIndex);

char* secureblackbox_samlreader_getattrqueryattrvalues(void* lpObj, int attrqueryattrindex);

QString GetAttrQueryAttrValues(int iAttrQueryAttrIndex);

Default Value

""

Remarks

Contains a list of attribute values.

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

The AttrQueryAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrQueryAttrCount property.

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

Data Type

String

AuthnQueryComparison Property (SAMLReader Class)

Specifies the authentication context comparison method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnQueryComparison();

Unicode (Windows)
INT GetAuthnQueryComparison();

CACCT_NONE(0), 
CACCT_EXACT(1), 
CACCT_MINIMUM(2), 
CACCT_MAXIMUM(3), 
CACCT_BETTER(4)

int secureblackbox_samlreader_getauthnquerycomparison(void* lpObj);

int GetAuthnQueryComparison();

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 (SAMLReader Class)

Specifies the context class reference.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthnQueryContextClassRefs();

Unicode (Windows)
LPWSTR GetAuthnQueryContextClassRefs();

char* secureblackbox_samlreader_getauthnquerycontextclassrefs(void* lpObj);

QString GetAuthnQueryContextClassRefs();

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 (SAMLReader Class)

Specifies the context reference type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnQueryRefType();

Unicode (Windows)
INT GetAuthnQueryRefType();

CACRT_UNKNOWN(0), 
CACRT_CLASS(1), 
CACRT_DECL(2)

int secureblackbox_samlreader_getauthnqueryreftype(void* lpObj);

int GetAuthnQueryRefType();

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 (SAMLReader Class)

Specifies the index of the session to the authentication entity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthnQuerySessionIndex();

Unicode (Windows)
LPWSTR GetAuthnQuerySessionIndex();

char* secureblackbox_samlreader_getauthnquerysessionindex(void* lpObj);

QString GetAuthnQuerySessionIndex();

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 (SAMLReader Class)

Specifies the assertion consumer service index.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnRequestAssertionConsumerServiceIndex();

Unicode (Windows)
INT GetAuthnRequestAssertionConsumerServiceIndex();

int secureblackbox_samlreader_getauthnrequestassertionconsumerserviceindex(void* lpObj);

int GetAuthnRequestAssertionConsumerServiceIndex();

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 (SAMLReader Class)

Specifies the assertion consumer service URL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthnRequestAssertionConsumerServiceURL();

Unicode (Windows)
LPWSTR GetAuthnRequestAssertionConsumerServiceURL();

char* secureblackbox_samlreader_getauthnrequestassertionconsumerserviceurl(void* lpObj);

QString GetAuthnRequestAssertionConsumerServiceURL();

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 (SAMLReader Class)

Specifies the attribute consuming service index.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnRequestAttributeConsumingServiceIndex();

Unicode (Windows)
INT GetAuthnRequestAttributeConsumingServiceIndex();

int secureblackbox_samlreader_getauthnrequestattributeconsumingserviceindex(void* lpObj);

int GetAuthnRequestAttributeConsumingServiceIndex();

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

AuthnRequestConditionsNotBefore Property (SAMLReader Class)

Specifies the NotBefore condition of the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthnRequestConditionsNotBefore();

Unicode (Windows)
LPWSTR GetAuthnRequestConditionsNotBefore();

char* secureblackbox_samlreader_getauthnrequestconditionsnotbefore(void* lpObj);

QString GetAuthnRequestConditionsNotBefore();

Default Value

""

Remarks

Specifies the NotBefore condition of the request.

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

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

Data Type

String

AuthnRequestConditionsNotOnOrAfter Property (SAMLReader Class)

Provides access to the NotOnOrAfter condition of the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthnRequestConditionsNotOnOrAfter();

Unicode (Windows)
LPWSTR GetAuthnRequestConditionsNotOnOrAfter();

char* secureblackbox_samlreader_getauthnrequestconditionsnotonorafter(void* lpObj);

QString GetAuthnRequestConditionsNotOnOrAfter();

Default Value

""

Remarks

Provides access to the NotOnOrAfter condition of the request.

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

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

Data Type

String

AuthnRequestContextClassRefs Property (SAMLReader Class)

Provides access to the authentication context class references.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthnRequestContextClassRefs();

Unicode (Windows)
LPWSTR GetAuthnRequestContextClassRefs();

char* secureblackbox_samlreader_getauthnrequestcontextclassrefs(void* lpObj);

QString GetAuthnRequestContextClassRefs();

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 (SAMLReader Class)

Specifies the AuthnContext comparison method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnRequestContextComparison();

Unicode (Windows)
INT GetAuthnRequestContextComparison();

CACCT_NONE(0), 
CACCT_EXACT(1), 
CACCT_MINIMUM(2), 
CACCT_MAXIMUM(3), 
CACCT_BETTER(4)

int secureblackbox_samlreader_getauthnrequestcontextcomparison(void* lpObj);

int GetAuthnRequestContextComparison();

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 (SAMLReader Class)

Specifies the context reference type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnRequestContextRefType();

Unicode (Windows)
INT GetAuthnRequestContextRefType();

CACRT_UNKNOWN(0), 
CACRT_CLASS(1), 
CACRT_DECL(2)

int secureblackbox_samlreader_getauthnrequestcontextreftype(void* lpObj);

int GetAuthnRequestContextRefType();

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

AuthnRequestForceAuthn Property (SAMLReader Class)

Corresponds to the ForceAuthn parameter of the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnRequestForceAuthn();

Unicode (Windows)
BOOL GetAuthnRequestForceAuthn();

int secureblackbox_samlreader_getauthnrequestforceauthn(void* lpObj);

bool GetAuthnRequestForceAuthn();

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 (SAMLReader Class)

Maps to the IsPassive parameter of the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnRequestIsPassive();

Unicode (Windows)
BOOL GetAuthnRequestIsPassive();

int secureblackbox_samlreader_getauthnrequestispassive(void* lpObj);

bool GetAuthnRequestIsPassive();

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 (SAMLReader Class)

Matches the AllowCreate attribute of NameIDPolicy element of the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnRequestNameIDPolicyAllowCreate();

Unicode (Windows)
BOOL GetAuthnRequestNameIDPolicyAllowCreate();

int secureblackbox_samlreader_getauthnrequestnameidpolicyallowcreate(void* lpObj);

bool GetAuthnRequestNameIDPolicyAllowCreate();

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 (SAMLReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthnRequestNameIDPolicyFormat();

Unicode (Windows)
LPWSTR GetAuthnRequestNameIDPolicyFormat();

char* secureblackbox_samlreader_getauthnrequestnameidpolicyformat(void* lpObj);

QString GetAuthnRequestNameIDPolicyFormat();

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 (SAMLReader Class)

Matches to the SP name qualifier attribute of the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthnRequestNameIDPolicySPNameQualifier();

Unicode (Windows)
LPWSTR GetAuthnRequestNameIDPolicySPNameQualifier();

char* secureblackbox_samlreader_getauthnrequestnameidpolicyspnamequalifier(void* lpObj);

QString GetAuthnRequestNameIDPolicySPNameQualifier();

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

AuthnRequestNameIDPolicyUseAllowCreate Property (SAMLReader Class)

Controls inclusion of AllowCreate attribute in the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnRequestNameIDPolicyUseAllowCreate();

Unicode (Windows)
BOOL GetAuthnRequestNameIDPolicyUseAllowCreate();

int secureblackbox_samlreader_getauthnrequestnameidpolicyuseallowcreate(void* lpObj);

bool GetAuthnRequestNameIDPolicyUseAllowCreate();

Default Value

FALSE

Remarks

Controls inclusion of AllowCreate attribute in the request.

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

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

Data Type

Boolean

AuthnRequestProtocolBinding Property (SAMLReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthnRequestProtocolBinding();

Unicode (Windows)
LPWSTR GetAuthnRequestProtocolBinding();

char* secureblackbox_samlreader_getauthnrequestprotocolbinding(void* lpObj);

QString GetAuthnRequestProtocolBinding();

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 (SAMLReader Class)

Specifies the name of the requestor.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthnRequestProviderName();

Unicode (Windows)
LPWSTR GetAuthnRequestProviderName();

char* secureblackbox_samlreader_getauthnrequestprovidername(void* lpObj);

QString GetAuthnRequestProviderName();

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

AuthnRequestScopingIDPListGetComplete Property (SAMLReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthnRequestScopingIDPListGetComplete();

Unicode (Windows)
LPWSTR GetAuthnRequestScopingIDPListGetComplete();

char* secureblackbox_samlreader_getauthnrequestscopingidplistgetcomplete(void* lpObj);

QString GetAuthnRequestScopingIDPListGetComplete();

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 (SAMLReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnRequestScopingProxyCount();

Unicode (Windows)
INT GetAuthnRequestScopingProxyCount();

int secureblackbox_samlreader_getauthnrequestscopingproxycount(void* lpObj);

int GetAuthnRequestScopingProxyCount();

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 (SAMLReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthnRequestScopingRequesterIDs();

Unicode (Windows)
LPWSTR GetAuthnRequestScopingRequesterIDs();

char* secureblackbox_samlreader_getauthnrequestscopingrequesterids(void* lpObj);

QString GetAuthnRequestScopingRequesterIDs();

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

AuthnRequestUseForceAuthn Property (SAMLReader Class)

Controls inclusion of ForceAuthn attribute in the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnRequestUseForceAuthn();

Unicode (Windows)
BOOL GetAuthnRequestUseForceAuthn();

int secureblackbox_samlreader_getauthnrequestuseforceauthn(void* lpObj);

bool GetAuthnRequestUseForceAuthn();

Default Value

FALSE

Remarks

Controls inclusion of ForceAuthn attribute in the request.

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

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

Data Type

Boolean

AuthnRequestUseIsPassive Property (SAMLReader Class)

Controls inclusion of IsPassive attribute in the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnRequestUseIsPassive();

Unicode (Windows)
BOOL GetAuthnRequestUseIsPassive();

int secureblackbox_samlreader_getauthnrequestuseispassive(void* lpObj);

bool GetAuthnRequestUseIsPassive();

Default Value

FALSE

Remarks

Controls inclusion of IsPassive attribute in the request.

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

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

Data Type

Boolean

AuthnRequestConditionCount Property (SAMLReader Class)

The number of records in the AuthnRequestCondition arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnRequestConditionCount();

Unicode (Windows)
INT GetAuthnRequestConditionCount();

int secureblackbox_samlreader_getauthnrequestconditioncount(void* lpObj);

int GetAuthnRequestConditionCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• AuthnRequestConditionAudienceList
• AuthnRequestConditionConditionType
• AuthnRequestConditionProxyRestrictionCount
• AuthnRequestConditionsNotBefore
• AuthnRequestConditionsNotOnOrAfter

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

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

Data Type

Integer

AuthnRequestConditionAudienceList Property (SAMLReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthnRequestConditionAudienceList(int iAuthnRequestConditionIndex);

Unicode (Windows)
LPWSTR GetAuthnRequestConditionAudienceList(INT iAuthnRequestConditionIndex);

char* secureblackbox_samlreader_getauthnrequestconditionaudiencelist(void* lpObj, int authnrequestconditionindex);

QString GetAuthnRequestConditionAudienceList(int iAuthnRequestConditionIndex);

Default Value

""

Remarks

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

Use this property to read or set a list of audiences included in the restriction. Each audience is represented by an URI. Provide multiple audiences by splitting them with CRLF separators.

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

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

Data Type

String

AuthnRequestConditionConditionType Property (SAMLReader Class)

Specifies a type of the condition object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnRequestConditionConditionType(int iAuthnRequestConditionIndex);

Unicode (Windows)
INT GetAuthnRequestConditionConditionType(INT iAuthnRequestConditionIndex);

CSCT_AUDIENCE_RESTRICTION(0), 
CSCT_ONE_TIME_USE(1), 
CSCT_PROXY_RESTRICTION(2)

int secureblackbox_samlreader_getauthnrequestconditionconditiontype(void* lpObj, int authnrequestconditionindex);

int GetAuthnRequestConditionConditionType(int iAuthnRequestConditionIndex);

Default Value

0

Remarks

Specifies a type of the condition object.

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

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

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

Data Type

Integer

AuthnRequestConditionProxyRestrictionCount Property (SAMLReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnRequestConditionProxyRestrictionCount(int iAuthnRequestConditionIndex);

Unicode (Windows)
INT GetAuthnRequestConditionProxyRestrictionCount(INT iAuthnRequestConditionIndex);

int secureblackbox_samlreader_getauthnrequestconditionproxyrestrictioncount(void* lpObj, int authnrequestconditionindex);

int GetAuthnRequestConditionProxyRestrictionCount(int iAuthnRequestConditionIndex);

Default Value

0

Remarks

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

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

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

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

Data Type

Integer

AuthnRequestScopingIDPCount Property (SAMLReader Class)

The number of records in the AuthnRequestScopingIDP arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnRequestScopingIDPCount();

Unicode (Windows)
INT GetAuthnRequestScopingIDPCount();

int secureblackbox_samlreader_getauthnrequestscopingidpcount(void* lpObj);

int GetAuthnRequestScopingIDPCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• AuthnRequestScopingIDPListGetComplete
• AuthnRequestScopingIDPLoc
• AuthnRequestScopingIDPName
• AuthnRequestScopingIDPProviderID

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

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

Data Type

Integer

AuthnRequestScopingIDPLoc Property (SAMLReader Class)

Contains the value of the Loc attribute.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthnRequestScopingIDPLoc(int iAuthnRequestScopingIDPIndex);

Unicode (Windows)
LPWSTR GetAuthnRequestScopingIDPLoc(INT iAuthnRequestScopingIDPIndex);

char* secureblackbox_samlreader_getauthnrequestscopingidploc(void* lpObj, int authnrequestscopingidpindex);

QString GetAuthnRequestScopingIDPLoc(int iAuthnRequestScopingIDPIndex);

Default Value

""

Remarks

Contains the value of the Loc attribute.

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

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

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

Data Type

String

AuthnRequestScopingIDPName Property (SAMLReader Class)

Contains the name of the IdP provider.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthnRequestScopingIDPName(int iAuthnRequestScopingIDPIndex);

Unicode (Windows)
LPWSTR GetAuthnRequestScopingIDPName(INT iAuthnRequestScopingIDPIndex);

char* secureblackbox_samlreader_getauthnrequestscopingidpname(void* lpObj, int authnrequestscopingidpindex);

QString GetAuthnRequestScopingIDPName(int iAuthnRequestScopingIDPIndex);

Default Value

""

Remarks

Contains the name of the IdP provider.

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

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

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

Data Type

String

AuthnRequestScopingIDPProviderID Property (SAMLReader Class)

Contains the provider ID.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthnRequestScopingIDPProviderID(int iAuthnRequestScopingIDPIndex);

Unicode (Windows)
LPWSTR GetAuthnRequestScopingIDPProviderID(INT iAuthnRequestScopingIDPIndex);

char* secureblackbox_samlreader_getauthnrequestscopingidpproviderid(void* lpObj, int authnrequestscopingidpindex);

QString GetAuthnRequestScopingIDPProviderID(int iAuthnRequestScopingIDPIndex);

Default Value

""

Remarks

Contains the provider ID.

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

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

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

Data Type

String

AuthzDecisionQueryActions Property (SAMLReader Class)

Specifies the list of actions included in the query.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthzDecisionQueryActions();

Unicode (Windows)
LPWSTR GetAuthzDecisionQueryActions();

char* secureblackbox_samlreader_getauthzdecisionqueryactions(void* lpObj);

QString GetAuthzDecisionQueryActions();

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 (SAMLReader Class)

Matches the Resource element of the query.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthzDecisionQueryResource();

Unicode (Windows)
LPWSTR GetAuthzDecisionQueryResource();

char* secureblackbox_samlreader_getauthzdecisionqueryresource(void* lpObj);

QString GetAuthzDecisionQueryResource();

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

Binding Property (SAMLReader Class)

Returns the SAML message binding type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBinding();

Unicode (Windows)
INT GetBinding();

CSBT_NONE(0), 
CSBT_SOAP(1), 
CSBT_PAOS(2), 
CSBT_REDIRECT(3), 
CSBT_POST(4), 
CSBT_ARTIFACT(5)

int secureblackbox_samlreader_getbinding(void* lpObj);

int GetBinding();

Default Value

0

Remarks

Check this property to obtain the message binding type.

This property is read-only.

Data Type

Integer

BlockedCertCount Property (SAMLReader Class)

The number of records in the BlockedCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount);

Unicode (Windows)
INT GetBlockedCertCount();
INT SetBlockedCertCount(INT iBlockedCertCount);

int secureblackbox_samlreader_getblockedcertcount(void* lpObj);
int secureblackbox_samlreader_setblockedcertcount(void* lpObj, int iBlockedCertCount);

int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• BlockedCertBytes
• BlockedCertHandle

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

This property is not available at design time.

Data Type

Integer

BlockedCertBytes Property (SAMLReader Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBlockedCertBytes(int iBlockedCertIndex, char* &lpBlockedCertBytes, int &lenBlockedCertBytes);

Unicode (Windows)
INT GetBlockedCertBytes(INT iBlockedCertIndex, LPSTR &lpBlockedCertBytes, INT &lenBlockedCertBytes);

int secureblackbox_samlreader_getblockedcertbytes(void* lpObj, int blockedcertindex, char** lpBlockedCertBytes, int* lenBlockedCertBytes);

QByteArray GetBlockedCertBytes(int iBlockedCertIndex);

Remarks

Returns the raw certificate data in DER format.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

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

Data Type

Byte Array

BlockedCertHandle Property (SAMLReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, int64 lBlockedCertHandle);

Unicode (Windows)
LONG64 GetBlockedCertHandle(INT iBlockedCertIndex);
INT SetBlockedCertHandle(INT iBlockedCertIndex, LONG64 lBlockedCertHandle);

int64 secureblackbox_samlreader_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_samlreader_setblockedcerthandle(void* lpObj, int blockedcertindex, int64 lBlockedCertHandle);

qint64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, qint64 lBlockedCertHandle);

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.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is not available at design time.

Data Type

Long64

ChainValidationDetails Property (SAMLReader Class)

The details of a certificate chain validation outcome.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetChainValidationDetails();

Unicode (Windows)
INT GetChainValidationDetails();

int secureblackbox_samlreader_getchainvalidationdetails(void* lpObj);

int GetChainValidationDetails();

Default Value

0

Remarks

Use the value(s) returned by this property to identify the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

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

Data Type

Integer

ChainValidationResult Property (SAMLReader Class)

The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetChainValidationResult();

Unicode (Windows)
INT GetChainValidationResult();

CVT_VALID(0), 
CVT_VALID_BUT_UNTRUSTED(1), 
CVT_INVALID(2), 
CVT_CANT_BE_ESTABLISHED(3)

int secureblackbox_samlreader_getchainvalidationresult(void* lpObj);

int GetChainValidationResult();

Default Value

0

Remarks

Available options:

Use the ValidationLog property to access the detailed validation log.

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

Data Type

Integer

Consent Property (SAMLReader Class)

Returns the Consent parameter of the SAML message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConsent();

Unicode (Windows)
LPWSTR GetConsent();

char* secureblackbox_samlreader_getconsent(void* lpObj);

QString GetConsent();

Default Value

""

Remarks

Check this property to access the value of the Consent parameter of the processed SAML message.

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

Data Type

String

DecryptionCertificateBytes Property (SAMLReader Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecryptionCertificateBytes(char* &lpDecryptionCertificateBytes, int &lenDecryptionCertificateBytes);

Unicode (Windows)
INT GetDecryptionCertificateBytes(LPSTR &lpDecryptionCertificateBytes, INT &lenDecryptionCertificateBytes);

int secureblackbox_samlreader_getdecryptioncertificatebytes(void* lpObj, char** lpDecryptionCertificateBytes, int* lenDecryptionCertificateBytes);

QByteArray GetDecryptionCertificateBytes();

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 (SAMLReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetDecryptionCertificateHandle();
int SetDecryptionCertificateHandle(int64 lDecryptionCertificateHandle);

Unicode (Windows)
LONG64 GetDecryptionCertificateHandle();
INT SetDecryptionCertificateHandle(LONG64 lDecryptionCertificateHandle);

int64 secureblackbox_samlreader_getdecryptioncertificatehandle(void* lpObj);
int secureblackbox_samlreader_setdecryptioncertificatehandle(void* lpObj, int64 lDecryptionCertificateHandle);

qint64 GetDecryptionCertificateHandle();
int SetDecryptionCertificateHandle(qint64 lDecryptionCertificateHandle);

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.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

Destination Property (SAMLReader Class)

Returns the Destination parameter of the SAML message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDestination();

Unicode (Windows)
LPWSTR GetDestination();

char* secureblackbox_samlreader_getdestination(void* lpObj);

QString GetDestination();

Default Value

""

Remarks

Check this property to access the Destination parameter of the SAML message.

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

Data Type

String

FIPSMode Property (SAMLReader Class)

Reserved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);

int secureblackbox_samlreader_getfipsmode(void* lpObj);
int secureblackbox_samlreader_setfipsmode(void* lpObj, int bFIPSMode);

bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

ID Property (SAMLReader Class)

Returns the ID of the processed message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetID();

Unicode (Windows)
LPWSTR GetID();

char* secureblackbox_samlreader_getid(void* lpObj);

QString GetID();

Default Value

""

Remarks

Use this property to get the SAML ID value of the message.

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

Data Type

String

IgnoreChainValidationErrors Property (SAMLReader Class)

Makes the class tolerant to chain validation errors.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIgnoreChainValidationErrors();
int SetIgnoreChainValidationErrors(int bIgnoreChainValidationErrors);

Unicode (Windows)
BOOL GetIgnoreChainValidationErrors();
INT SetIgnoreChainValidationErrors(BOOL bIgnoreChainValidationErrors);

int secureblackbox_samlreader_getignorechainvalidationerrors(void* lpObj);
int secureblackbox_samlreader_setignorechainvalidationerrors(void* lpObj, int bIgnoreChainValidationErrors);

bool GetIgnoreChainValidationErrors();
int SetIgnoreChainValidationErrors(bool bIgnoreChainValidationErrors);

Default Value

FALSE

Remarks

If this property is set to True, any errors emerging during certificate chain validation will be ignored. This setting may be handy if the purpose of validation is the creation of an LTV signature, and the validation is performed in an environment that doesn't trust the signer's certificate chain.

Data Type

Boolean

InputType Property (SAMLReader Class)

Returns the type of the processed message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputType();

Unicode (Windows)
INT GetInputType();

CSTY_NONE(0), 
CSTY_ASSERTION_IDREQUEST(1), 
CSTY_SUBJECT_QUERY(2), 
CSTY_AUTHN_QUERY(3), 
CSTY_ATTRIBUTE_QUERY(4), 
CSTY_AUTHZ_DECISION_QUERY(5), 
CSTY_AUTHN_REQUEST(6), 
CSTY_MANAGE_NAME_IDREQUEST(7), 
CSTY_LOGOUT_REQUEST(8), 
CSTY_NAME_IDMAPPING_REQUEST(9), 
CSTY_ARTIFACT_RESOLVE(10), 
CSTY_RESPONSE(11)

int secureblackbox_samlreader_getinputtype(void* lpObj);

int GetInputType();

Default Value

0

Remarks

Check this property on the early stage of message processing to find out the type of the data contained in the SAML message.

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

Data Type

Integer

InputTypeString Property (SAMLReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInputTypeString();

Unicode (Windows)
LPWSTR GetInputTypeString();

char* secureblackbox_samlreader_getinputtypestring(void* lpObj);

QString GetInputTypeString();

Default Value

""

Remarks

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

InResponseTo Property (SAMLReader Class)

Returns the in-response-to parameter of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInResponseTo();

Unicode (Windows)
LPWSTR GetInResponseTo();

char* secureblackbox_samlreader_getinresponseto(void* lpObj);

QString GetInResponseTo();

Default Value

""

Remarks

Check this property to obtain the In-Response-To parameter of the SAML message.

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

Data Type

String

IssueInstant Property (SAMLReader Class)

Returns the issue time of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIssueInstant();

Unicode (Windows)
LPWSTR GetIssueInstant();

char* secureblackbox_samlreader_getissueinstant(void* lpObj);

QString GetIssueInstant();

Default Value

""

Remarks

Check this property to obtain the issuing time of the SAML message.

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

Data Type

String

Issuer Property (SAMLReader Class)

Returns the issuer of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIssuer();

Unicode (Windows)
LPWSTR GetIssuer();

char* secureblackbox_samlreader_getissuer(void* lpObj);

QString GetIssuer();

Default Value

""

Remarks

Check this property to obtain the SAML ID of the issuer of the processed message.

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

Data Type

String

KnownCertCount Property (SAMLReader Class)

The number of records in the KnownCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);

Unicode (Windows)
INT GetKnownCertCount();
INT SetKnownCertCount(INT iKnownCertCount);

int secureblackbox_samlreader_getknowncertcount(void* lpObj);
int secureblackbox_samlreader_setknowncertcount(void* lpObj, int iKnownCertCount);

int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCertBytes
• KnownCertHandle

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

This property is not available at design time.

Data Type

Integer

KnownCertBytes Property (SAMLReader Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownCertBytes(int iKnownCertIndex, char* &lpKnownCertBytes, int &lenKnownCertBytes);

Unicode (Windows)
INT GetKnownCertBytes(INT iKnownCertIndex, LPSTR &lpKnownCertBytes, INT &lenKnownCertBytes);

int secureblackbox_samlreader_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);

QByteArray GetKnownCertBytes(int iKnownCertIndex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

KnownCertHandle Property (SAMLReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, int64 lKnownCertHandle);

Unicode (Windows)
LONG64 GetKnownCertHandle(INT iKnownCertIndex);
INT SetKnownCertHandle(INT iKnownCertIndex, LONG64 lKnownCertHandle);

int64 secureblackbox_samlreader_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_samlreader_setknowncerthandle(void* lpObj, int knowncertindex, int64 lKnownCertHandle);

qint64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, qint64 lKnownCertHandle);

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.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

This property is not available at design time.

Data Type

Long64

KnownCRLCount Property (SAMLReader Class)

The number of records in the KnownCRL arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount);

Unicode (Windows)
INT GetKnownCRLCount();
INT SetKnownCRLCount(INT iKnownCRLCount);

int secureblackbox_samlreader_getknowncrlcount(void* lpObj);
int secureblackbox_samlreader_setknowncrlcount(void* lpObj, int iKnownCRLCount);

int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCRLBytes
• KnownCRLHandle

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

This property is not available at design time.

Data Type

Integer

KnownCRLBytes Property (SAMLReader Class)

Returns the raw CRL data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownCRLBytes(int iKnownCRLIndex, char* &lpKnownCRLBytes, int &lenKnownCRLBytes);

Unicode (Windows)
INT GetKnownCRLBytes(INT iKnownCRLIndex, LPSTR &lpKnownCRLBytes, INT &lenKnownCRLBytes);

int secureblackbox_samlreader_getknowncrlbytes(void* lpObj, int knowncrlindex, char** lpKnownCRLBytes, int* lenKnownCRLBytes);

QByteArray GetKnownCRLBytes(int iKnownCRLIndex);

Remarks

Returns the raw CRL data in DER format.

The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

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

Data Type

Byte Array

KnownCRLHandle Property (SAMLReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, int64 lKnownCRLHandle);

Unicode (Windows)
LONG64 GetKnownCRLHandle(INT iKnownCRLIndex);
INT SetKnownCRLHandle(INT iKnownCRLIndex, LONG64 lKnownCRLHandle);

int64 secureblackbox_samlreader_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_samlreader_setknowncrlhandle(void* lpObj, int knowncrlindex, int64 lKnownCRLHandle);

qint64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, qint64 lKnownCRLHandle);

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.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

This property is not available at design time.

Data Type

Long64

KnownOCSPCount Property (SAMLReader Class)

The number of records in the KnownOCSP arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount);

Unicode (Windows)
INT GetKnownOCSPCount();
INT SetKnownOCSPCount(INT iKnownOCSPCount);

int secureblackbox_samlreader_getknownocspcount(void* lpObj);
int secureblackbox_samlreader_setknownocspcount(void* lpObj, int iKnownOCSPCount);

int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownOCSPBytes
• KnownOCSPHandle

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

This property is not available at design time.

Data Type

Integer

KnownOCSPBytes Property (SAMLReader Class)

A buffer containing the raw OCSP response data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownOCSPBytes(int iKnownOCSPIndex, char* &lpKnownOCSPBytes, int &lenKnownOCSPBytes);

Unicode (Windows)
INT GetKnownOCSPBytes(INT iKnownOCSPIndex, LPSTR &lpKnownOCSPBytes, INT &lenKnownOCSPBytes);

int secureblackbox_samlreader_getknownocspbytes(void* lpObj, int knownocspindex, char** lpKnownOCSPBytes, int* lenKnownOCSPBytes);

QByteArray GetKnownOCSPBytes(int iKnownOCSPIndex);

Remarks

A buffer containing the raw OCSP response data.

The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

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

Data Type

Byte Array

KnownOCSPHandle Property (SAMLReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, int64 lKnownOCSPHandle);

Unicode (Windows)
LONG64 GetKnownOCSPHandle(INT iKnownOCSPIndex);
INT SetKnownOCSPHandle(INT iKnownOCSPIndex, LONG64 lKnownOCSPHandle);

int64 secureblackbox_samlreader_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_samlreader_setknownocsphandle(void* lpObj, int knownocspindex, int64 lKnownOCSPHandle);

qint64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, qint64 lKnownOCSPHandle);

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.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

This property is not available at design time.

Data Type

Long64

LogoutRequestNameID Property (SAMLReader Class)

Contains the value of the NameID parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLogoutRequestNameID();

Unicode (Windows)
LPWSTR GetLogoutRequestNameID();

char* secureblackbox_samlreader_getlogoutrequestnameid(void* lpObj);

QString GetLogoutRequestNameID();

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 (SAMLReader Class)

Contains the value of the NotOnOrAfter parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLogoutRequestNotOnOrAfter();

Unicode (Windows)
LPWSTR GetLogoutRequestNotOnOrAfter();

char* secureblackbox_samlreader_getlogoutrequestnotonorafter(void* lpObj);

QString GetLogoutRequestNotOnOrAfter();

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 (SAMLReader Class)

Contains the value of the Reason parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLogoutRequestReason();

Unicode (Windows)
LPWSTR GetLogoutRequestReason();

char* secureblackbox_samlreader_getlogoutrequestreason(void* lpObj);

QString GetLogoutRequestReason();

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 (SAMLReader Class)

Contains the list of session indices.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLogoutRequestSessionIndexes();

Unicode (Windows)
LPWSTR GetLogoutRequestSessionIndexes();

char* secureblackbox_samlreader_getlogoutrequestsessionindexes(void* lpObj);

QString GetLogoutRequestSessionIndexes();

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 (SAMLReader Class)

Contains the value of the NameID parameter of the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManageNameIDRequestNameID();

Unicode (Windows)
LPWSTR GetManageNameIDRequestNameID();

char* secureblackbox_samlreader_getmanagenameidrequestnameid(void* lpObj);

QString GetManageNameIDRequestNameID();

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 (SAMLReader Class)

Contains the value of the NewEncryptedID parameter of the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManageNameIDRequestNewEncryptedID();

Unicode (Windows)
LPWSTR GetManageNameIDRequestNewEncryptedID();

char* secureblackbox_samlreader_getmanagenameidrequestnewencryptedid(void* lpObj);

QString GetManageNameIDRequestNewEncryptedID();

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 (SAMLReader Class)

Contains the value of the NewID parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManageNameIDRequestNewID();

Unicode (Windows)
LPWSTR GetManageNameIDRequestNewID();

char* secureblackbox_samlreader_getmanagenameidrequestnewid(void* lpObj);

QString GetManageNameIDRequestNewID();

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 (SAMLReader Class)

Contains the value of the Terminate parameter of the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManageNameIDRequestTerminate();

Unicode (Windows)
LPWSTR GetManageNameIDRequestTerminate();

char* secureblackbox_samlreader_getmanagenameidrequestterminate(void* lpObj);

QString GetManageNameIDRequestTerminate();

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

NameIDMappingRequestNameID Property (SAMLReader Class)

An accessor to the NameID parameter of the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNameIDMappingRequestNameID();

Unicode (Windows)
LPWSTR GetNameIDMappingRequestNameID();

char* secureblackbox_samlreader_getnameidmappingrequestnameid(void* lpObj);

QString GetNameIDMappingRequestNameID();

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 (SAMLReader Class)

Contains the value of AllowCreate parameter of the NameIDPolicy object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNameIDMappingRequestNameIDPolicyAllowCreate();

Unicode (Windows)
BOOL GetNameIDMappingRequestNameIDPolicyAllowCreate();

int secureblackbox_samlreader_getnameidmappingrequestnameidpolicyallowcreate(void* lpObj);

bool GetNameIDMappingRequestNameIDPolicyAllowCreate();

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 (SAMLReader Class)

Specifies the format of the NameIDPolicy element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNameIDMappingRequestNameIDPolicyFormat();

Unicode (Windows)
LPWSTR GetNameIDMappingRequestNameIDPolicyFormat();

char* secureblackbox_samlreader_getnameidmappingrequestnameidpolicyformat(void* lpObj);

QString GetNameIDMappingRequestNameIDPolicyFormat();

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 (SAMLReader Class)

Contains the SPNameQualifier parameter of the NameIDPolicy element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNameIDMappingRequestNameIDPolicySPNameQualifier();

Unicode (Windows)
LPWSTR GetNameIDMappingRequestNameIDPolicySPNameQualifier();

char* secureblackbox_samlreader_getnameidmappingrequestnameidpolicyspnamequalifier(void* lpObj);

QString GetNameIDMappingRequestNameIDPolicySPNameQualifier();

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 (SAMLReader Class)

Controls inclusion of UseAllow modifier in the NameIDPolicy object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNameIDMappingRequestNameIDPolicyUseAllowCreate();

Unicode (Windows)
BOOL GetNameIDMappingRequestNameIDPolicyUseAllowCreate();

int secureblackbox_samlreader_getnameidmappingrequestnameidpolicyuseallowcreate(void* lpObj);

bool GetNameIDMappingRequestNameIDPolicyUseAllowCreate();

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

OfflineMode Property (SAMLReader Class)

Switches the class to offline mode.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOfflineMode();
int SetOfflineMode(int bOfflineMode);

Unicode (Windows)
BOOL GetOfflineMode();
INT SetOfflineMode(BOOL bOfflineMode);

int secureblackbox_samlreader_getofflinemode(void* lpObj);
int secureblackbox_samlreader_setofflinemode(void* lpObj, int bOfflineMode);

bool GetOfflineMode();
int SetOfflineMode(bool bOfflineMode);

Default Value

FALSE

Remarks

When working in offline mode, the class restricts itself from using any online revocation information sources, such as CRL or OCSP responders.

Offline mode may be useful if there is a need to verify the completeness of the validation information included within the signature or provided via KnownCertificates, KnownCRLs, and other related properties.

Data Type

Boolean

PinnedAssertionAttrCount Property (SAMLReader Class)

The number of records in the PinnedAssertionAttr arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedAssertionAttrCount();

Unicode (Windows)
INT GetPinnedAssertionAttrCount();

int secureblackbox_samlreader_getpinnedassertionattrcount(void* lpObj);

int GetPinnedAssertionAttrCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• PinnedAssertionAttrFriendlyName
• PinnedAssertionAttrName
• PinnedAssertionAttrNameFormat
• PinnedAssertionAttrStatementIndex
• PinnedAssertionAttrValues

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

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

Data Type

Integer

PinnedAssertionAttrFriendlyName Property (SAMLReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedAssertionAttrFriendlyName(int iPinnedAssertionAttrIndex);

Unicode (Windows)
LPWSTR GetPinnedAssertionAttrFriendlyName(INT iPinnedAssertionAttrIndex);

char* secureblackbox_samlreader_getpinnedassertionattrfriendlyname(void* lpObj, int pinnedassertionattrindex);

QString GetPinnedAssertionAttrFriendlyName(int iPinnedAssertionAttrIndex);

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

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

Data Type

String

PinnedAssertionAttrName Property (SAMLReader Class)

Specifies the name of the attribute.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedAssertionAttrName(int iPinnedAssertionAttrIndex);

Unicode (Windows)
LPWSTR GetPinnedAssertionAttrName(INT iPinnedAssertionAttrIndex);

char* secureblackbox_samlreader_getpinnedassertionattrname(void* lpObj, int pinnedassertionattrindex);

QString GetPinnedAssertionAttrName(int iPinnedAssertionAttrIndex);

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

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

Data Type

String

PinnedAssertionAttrNameFormat Property (SAMLReader Class)

Indicates the format used to reference the attribute.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedAssertionAttrNameFormat(int iPinnedAssertionAttrIndex);

Unicode (Windows)
LPWSTR GetPinnedAssertionAttrNameFormat(INT iPinnedAssertionAttrIndex);

char* secureblackbox_samlreader_getpinnedassertionattrnameformat(void* lpObj, int pinnedassertionattrindex);

QString GetPinnedAssertionAttrNameFormat(int iPinnedAssertionAttrIndex);

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

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

Data Type

String

PinnedAssertionAttrStatementIndex Property (SAMLReader Class)

Contains the index of the statement the attribute corresponds to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedAssertionAttrStatementIndex(int iPinnedAssertionAttrIndex);

Unicode (Windows)
INT GetPinnedAssertionAttrStatementIndex(INT iPinnedAssertionAttrIndex);

int secureblackbox_samlreader_getpinnedassertionattrstatementindex(void* lpObj, int pinnedassertionattrindex);

int GetPinnedAssertionAttrStatementIndex(int iPinnedAssertionAttrIndex);

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

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

Data Type

Integer

PinnedAssertionAttrValues Property (SAMLReader Class)

Contains a list of attribute values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedAssertionAttrValues(int iPinnedAssertionAttrIndex);

Unicode (Windows)
LPWSTR GetPinnedAssertionAttrValues(INT iPinnedAssertionAttrIndex);

char* secureblackbox_samlreader_getpinnedassertionattrvalues(void* lpObj, int pinnedassertionattrindex);

QString GetPinnedAssertionAttrValues(int iPinnedAssertionAttrIndex);

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

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

Data Type

String

PinnedAssertionConditionCount Property (SAMLReader Class)

The number of records in the PinnedAssertionCondition arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedAssertionConditionCount();

Unicode (Windows)
INT GetPinnedAssertionConditionCount();

int secureblackbox_samlreader_getpinnedassertionconditioncount(void* lpObj);

int GetPinnedAssertionConditionCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• PinnedAssertionConditionAudienceList
• PinnedAssertionConditionConditionType
• PinnedAssertionConditionProxyRestrictionCount

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

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

Data Type

Integer

PinnedAssertionConditionAudienceList Property (SAMLReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPinnedAssertionConditionAudienceList(int iPinnedAssertionConditionIndex);

Unicode (Windows)
LPWSTR GetPinnedAssertionConditionAudienceList(INT iPinnedAssertionConditionIndex);

char* secureblackbox_samlreader_getpinnedassertionconditionaudiencelist(void* lpObj, int pinnedassertionconditionindex);

QString GetPinnedAssertionConditionAudienceList(int iPinnedAssertionConditionIndex);

Default Value

""

Remarks

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

Use this property to read or set a list of audiences included in the restriction. Each audience is represented by an URI. Provide multiple audiences by splitting them with CRLF separators.

The PinnedAssertionConditionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionConditionCount property.

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

Data Type

String

PinnedAssertionConditionConditionType Property (SAMLReader Class)

Specifies a type of the condition object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedAssertionConditionConditionType(int iPinnedAssertionConditionIndex);

Unicode (Windows)
INT GetPinnedAssertionConditionConditionType(INT iPinnedAssertionConditionIndex);

CSCT_AUDIENCE_RESTRICTION(0), 
CSCT_ONE_TIME_USE(1), 
CSCT_PROXY_RESTRICTION(2)

int secureblackbox_samlreader_getpinnedassertionconditionconditiontype(void* lpObj, int pinnedassertionconditionindex);

int GetPinnedAssertionConditionConditionType(int iPinnedAssertionConditionIndex);

Default Value

0

Remarks

Specifies a type of the condition object.

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

The PinnedAssertionConditionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionConditionCount property.

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

Data Type

Integer

PinnedAssertionConditionProxyRestrictionCount Property (SAMLReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPinnedAssertionConditionProxyRestrictionCount(int iPinnedAssertionConditionIndex);

Unicode (Windows)
INT GetPinnedAssertionConditionProxyRestrictionCount(INT iPinnedAssertionConditionIndex);

int secureblackbox_samlreader_getpinnedassertionconditionproxyrestrictioncount(void* lpObj, int pinnedassertionconditionindex);

int GetPinnedAssertionConditionProxyRestrictionCount(int iPinnedAssertionConditionIndex);

Default Value

0

Remarks

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

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

The PinnedAssertionConditionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionConditionCount property.

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

Data Type