SAMLReader Class
Properties Methods Events Configuration 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.
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.
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 | An accessor to the EndpointIndex entry of the artifact. |
ArtifactMessageHandle | An accessor to the MessageHandle property of the artifact. |
ArtifactRemainingArtifact | Returns the contents of the artifact. |
ArtifactSourceID | An accessor to the SourceID property of the artifact. |
ArtifactTypeCode | The TypeCode property of the artifact. |
ArtifactURI | An accessor to the URI property of the artifact. |
ArtifactResolveQuery | Returns the content of the ArtifactResolve query. |
AssertionCount | Returns the number of assertions in the SAML message. |
AssertionIDRequestReferences | Contains the References entry of the SAML assertion ID request. |
AttrQueryAttrCount | The number of records in the AttrQueryAttr arrays. |
AttrQueryAttrFriendlyName | Specifies the friendly name of the attribute Use this property to access or set the friendly name of a SAML attribute (e. |
AttrQueryAttrName | Specifies the name of the attribute. |
AttrQueryAttrNameFormat | Indicates the format used to reference the attribute. |
AttrQueryAttrStatementIndex | Contains the index of the statement the attribute corresponds to. |
AttrQueryAttrValues | Contains a list of attribute values. |
AuthnQueryComparison | Specifies the authentication context comparison method. |
AuthnQueryContextClassRefs | Specifies the context class reference. |
AuthnQueryRefType | Specifies the context reference type. |
AuthnQuerySessionIndex | Specifies the index of the session to the authentication entity. |
AuthnRequestAssertionConsumerServiceIndex | Specifies the assertion consumer service index. |
AuthnRequestAssertionConsumerServiceURL | Specifies the assertion consumer service URL. |
AuthnRequestAttributeConsumingServiceIndex | Specifies the attribute consuming service index. |
AuthnRequestConditionsNotBefore | Specifies the NotBefore condition of the request. |
AuthnRequestConditionsNotOnOrAfter | Provides access to the NotOnOrAfter condition of the request. |
AuthnRequestContextClassRefs | Provides access to the authentication context class references. |
AuthnRequestContextComparison | Specifies the AuthnContext comparison method. |
AuthnRequestContextRefType | Specifies the context reference type. |
AuthnRequestForceAuthn | Corresponds to the ForceAuthn parameter of the request. |
AuthnRequestIsPassive | Maps to the IsPassive parameter of the request. |
AuthnRequestNameIDPolicyAllowCreate | Matches the AllowCreate attribute of NameIDPolicy element of the request. |
AuthnRequestNameIDPolicyFormat | Matches to the Format attribute of the NameIDPolicy element of the request. |
AuthnRequestNameIDPolicySPNameQualifier | Matches to the SP name qualifier attribute of the request. |
AuthnRequestNameIDPolicyUseAllowCreate | Controls inclusion of AllowCreate attribute in the request. |
AuthnRequestProtocolBinding | Specifies the protocol binding to be requested in the authentication request. |
AuthnRequestProviderName | Specifies the name of the requestor. |
AuthnRequestScopingIDPListGetComplete | Matches the GetComplete element of the IDPList entry of the Scoping object. |
AuthnRequestScopingProxyCount | The maximum number of proxies on the way between the requestor and the provider. |
AuthnRequestScopingRequesterIDs | A collection of requestor IDs on whose behalf the request is being sent. |
AuthnRequestUseForceAuthn | Controls inclusion of ForceAuthn attribute in the request. |
AuthnRequestUseIsPassive | Controls inclusion of IsPassive attribute in the request. |
AuthnRequestConditionCount | The number of records in the AuthnRequestCondition arrays. |
AuthnRequestConditionAudienceList | An accessor to the Audience list parameter of an audience restriction condition. |
AuthnRequestConditionConditionType | Specifies a type of the condition object. |
AuthnRequestConditionProxyRestrictionCount | An accessor to the proxy restriction count element of the condition. |
AuthnRequestScopingIDPCount | The number of records in the AuthnRequestScopingIDP arrays. |
AuthnRequestScopingIDPLoc | Contains the value of the Loc attribute. |
AuthnRequestScopingIDPName | Contains the name of the IdP provider. |
AuthnRequestScopingIDPProviderID | Contains the provider ID. |
AuthzDecisionQueryActions | Specifies the list of actions included in the query. |
AuthzDecisionQueryResource | Matches the Resource element of the query. |
Binding | Returns the SAML message binding type. |
BlockedCertCount | The number of records in the BlockedCert arrays. |
BlockedCertBytes | Returns raw certificate data in DER format. |
BlockedCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
ChainValidationDetails | The details of a certificate chain validation outcome. |
ChainValidationResult | The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result. |
Consent | Returns the Consent parameter of the SAML message. |
DecryptionCertificateBytes | Returns raw certificate data in DER format. |
DecryptionCertificateHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
Destination | Returns the Destination parameter of the SAML message. |
FIPSMode | Reserved. |
ID | Returns the ID of the processed message. |
IgnoreChainValidationErrors | Makes the class tolerant to chain validation errors. |
InputType | Returns the type of the processed message. |
InputTypeString | Returns the type of the processed message, as an original string. |
InResponseTo | Returns the in-response-to parameter of the message. |
IssueInstant | Returns the issue time of the message. |
Issuer | Returns the issuer of the message. |
KnownCertCount | The number of records in the KnownCert arrays. |
KnownCertBytes | Returns raw certificate data in DER format. |
KnownCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
KnownCRLCount | The number of records in the KnownCRL arrays. |
KnownCRLBytes | Returns raw CRL data in DER format. |
KnownCRLHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
KnownOCSPCount | The number of records in the KnownOCSP arrays. |
KnownOCSPBytes | Buffer containing raw OCSP response data. |
KnownOCSPHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
LogoutRequestNameID | Contains the value of the NameID parameter. |
LogoutRequestNotOnOrAfter | Contains the value of the NotOnOrAfter parameter. |
LogoutRequestReason | Contains the value of the Reason parameter. |
LogoutRequestSessionIndexes | Contains the list of session indices. |
ManageNameIDRequestNameID | Contains the value of the NameID parameter of the request. |
ManageNameIDRequestNewEncryptedID | Contains the value of the NewEncryptedID parameter of the request. |
ManageNameIDRequestNewID | Contains the value of the NewID parameter. |
ManageNameIDRequestTerminate | Contains the value of the Terminate parameter of the request. |
NameIDMappingRequestNameID | An accessor to the NameID parameter of the request. |
NameIDMappingRequestNameIDPolicyAllowCreate | Contains the value of AllowCreate parameter of the NameIDPolicy object. |
NameIDMappingRequestNameIDPolicyFormat | Specifies the format of the NameIDPolicy element. |
NameIDMappingRequestNameIDPolicySPNameQualifier | Contains the SPNameQualifier parameter of the NameIDPolicy element. |
NameIDMappingRequestNameIDPolicyUseAllowCreate | Controls inclusion of UseAllow modifier in the NameIDPolicy object. |
OfflineMode | Switches the class to the offline mode. |
PinnedAssertionAttrCount | The number of records in the PinnedAssertionAttr arrays. |
PinnedAssertionAttrFriendlyName | Specifies the friendly name of the attribute Use this property to access or set the friendly name of a SAML attribute (e. |
PinnedAssertionAttrName | Specifies the name of the attribute. |
PinnedAssertionAttrNameFormat | Indicates the format used to reference the attribute. |
PinnedAssertionAttrStatementIndex | Contains the index of the statement the attribute corresponds to. |
PinnedAssertionAttrValues | Contains a list of attribute values. |
PinnedAssertionConditionCount | The number of records in the PinnedAssertionCondition arrays. |
PinnedAssertionConditionAudienceList | An accessor to the Audience list parameter of an audience restriction condition. |
PinnedAssertionConditionConditionType | Specifies a type of the condition object. |
PinnedAssertionConditionProxyRestrictionCount | An accessor to the proxy restriction count element of the condition. |
PinnedAssertionInfoAdviceAssertionCount | Contains the number of advice assertions. |
PinnedAssertionInfoAssertionType | Specifies the type of the assertion. |
PinnedAssertionInfoChainValidationDetails | The details of a certificate chain validation outcome. |
PinnedAssertionInfoChainValidationResult | The outcome of a certificate chain validation routine. |
PinnedAssertionInfoConditionsNotBefore | Represents the Conditions. |
PinnedAssertionInfoConditionsNotOnOrAfter | Represents the Conditions. |
PinnedAssertionInfoEncryptedContent | Represents the encrypted assertion content. |
PinnedAssertionInfoID | Represents the ID of the assertion. |
PinnedAssertionInfoIDRef | Represents an ID reference value. |
PinnedAssertionInfoIssueInstant | Contains the assertion issuance time stamp. |
PinnedAssertionInfoSignatureValidationResult | The outcome of the cryptographic signature validation. |
PinnedAssertionInfoSigned | Specifies whether the assertion is signed. |
PinnedAssertionInfoURIRef | Represents an URI reference value. |
PinnedAssertionInfoValidationLog | Contains the signing certificate's chain validation log. |
PinnedAssertionInfoVersion | Specifies the SAML protocol version used. |
PinnedAssertionIssuer | Returns the pinned assertion issuer. |
PinnedAssertionStatementCount | The number of records in the PinnedAssertionStatement arrays. |
PinnedAssertionStatementAttributes | Contains a list of statement attribute names. |
PinnedAssertionStatementAuthnContextAuthenticatingAuthorities | Contains the list of authenticating authorities. |
PinnedAssertionStatementAuthnContextChoice | Specifies the authentication context choice variant. |
PinnedAssertionStatementAuthnContextClassRef | Indicates the authentication contexts class reference. |
PinnedAssertionStatementAuthnContextDecl | Specifies the authentication contexts declaration. |
PinnedAssertionStatementAuthnContextDeclRef | Specifies the authentication contexts declaration reference. |
PinnedAssertionStatementAuthnInstant | Specifies the authentication event timestamp. |
PinnedAssertionStatementAuthnSessionIndex | Contains the authentication session index. |
PinnedAssertionStatementAuthnSessionNotOnOrAfter | Maps to the SessionNotOnOrAfter parameter of the authentication statement. |
PinnedAssertionStatementAuthnSubjectLocalityAddress | Specifies the authentication subjects address. |
PinnedAssertionStatementAuthnSubjectLocalityDNSName | Maps to the authentication subjects DNS name parameter. |
PinnedAssertionStatementAuthzActions | Provides access to the list of actions of the authorization statement. |
PinnedAssertionStatementAuthzDecision | Specifies the authorization decision. |
PinnedAssertionStatementAuthzDecisionEvidence | Manages the authorization decision statement evidence parameter. |
PinnedAssertionStatementAuthzDecisionResource | Specifies the authorization decision statement resource parameter. |
PinnedAssertionStatementStatementType | Specifies the assertion statement type. |
PinnedAssertionSubjectConfirmationCount | The number of records in the PinnedAssertionSubjectConfirmation arrays. |
PinnedAssertionSubjectConfirmationDataAddress | Contains the address enabled for presenting assertions. |
PinnedAssertionSubjectConfirmationDataInResponseTo | The ID of the SAML message in response to which the assertion is issued. |
PinnedAssertionSubjectConfirmationDataNotBefore | Time moment before which the subject cannot be confirmed. |
PinnedAssertionSubjectConfirmationDataNotOnOrAfter | Limits the time until which the subject can be confirmed. |
PinnedAssertionSubjectConfirmationDataRecipient | The URI of the entity or the location of the resource to which the assertion should be presented. |
PinnedAssertionSubjectConfirmationDataType | The type of data contained in the confirmation. |
PinnedAssertionSubjectConfirmationID | The identifier of the entity which can satisfy the subject confirmation requirements. |
PinnedAssertionSubjectConfirmationMethod | Specifies the mechanism to be used to confirm the subject. |
PinnedAssertionSubjectID | Returns the pinned assertion subject. |
POSTBindingBody | Contains the form body. |
POSTBindingFormTemplate | Contains the XHTML form template returned by the service provider. |
POSTBindingMode | Specifies whether binding is applied on a server, or on a client side. |
POSTBindingRelayState | Contains the value of the RelayState parameter of POST binding mechanism. |
POSTBindingURL | Contains the URL of POST binding mechanism. |
Profile | Specifies a pre-defined profile to apply when creating the signature. |
ProxyAddress | The IP address of the proxy server. |
ProxyAuthentication | The authentication type used by the proxy server. |
ProxyPassword | The password to authenticate to the proxy server. |
ProxyPort | The port on the proxy server to connect to. |
ProxyProxyType | The type of the proxy server. |
ProxyRequestHeaders | Contains HTTP request headers for WebTunnel and HTTP proxy. |
ProxyResponseBody | Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
ProxyResponseHeaders | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
ProxyUseIPv6 | Specifies whether IPv6 should be used when connecting through the proxy. |
ProxyUseProxy | Enables or disables proxy-driven connection. |
ProxyUsername | Specifies the username credential for proxy authentication. |
RedirectBindingEncoding | Specifies the message encoding. |
RedirectBindingForceSign | Enforces a signature over all outgoing messages. |
RedirectBindingRelayState | Contains the RelayState parameter of the binding. |
RedirectBindingSign | Specifies whether to sign generated messages. |
RedirectBindingSignatureAlgorithm | Contains the signature algorithm. |
RedirectBindingURL | Contains the URL of the request query. |
RedirectBindingVerifySignatures | Instructs the class whether to verify incoming signatures. |
RedirectBindingCertBytes | Returns raw certificate data in DER format. |
RedirectBindingCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
ResponseNameID | Contains the NameID parameter of a NameIDMapping response. |
ResponseOptionalElement | An optional message element to be returned with the response. |
ResponseResponseType | Contains the type of the response. |
ResponseStatusCodeSubValue | The value of the nested StatusCode. |
ResponseStatusCodeValue | Contains the status code value. |
ResponseStatusDetail | Contains additional information on the status of the request. |
ResponseStatusMessage | Contains a status message (optional). |
SignatureValidationResult | Contains the signature validation result. |
Signed | Returns true it the message is signed. |
SigningCertBytes | Returns raw certificate data in DER format. |
SigningCertCA | Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
SigningCertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
SigningCertCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
SigningCertCurve | Specifies the elliptic curve of the EC public key. |
SigningCertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
SigningCertFriendlyName | Contains an associated alias (friendly name) of the certificate. |
SigningCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SigningCertHashAlgorithm | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 . |
SigningCertIssuer | The common name of the certificate issuer (CA), typically a company name. |
SigningCertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
SigningCertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
SigningCertKeyBits | Returns the length of the public key. |
SigningCertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
SigningCertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
SigningCertKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
SigningCertOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
SigningCertPolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
SigningCertPublicKeyBytes | Contains the certificate's public key in DER format. |
SigningCertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
SigningCertSerialNumber | Returns the certificate's serial number. |
SigningCertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
SigningCertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
SigningCertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
SigningCertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
SigningCertValidFrom | The time point at which the certificate becomes valid, in UTC. |
SigningCertValidTo | The time point at which the certificate expires, in UTC. |
SocketDNSMode | Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. |
SocketDNSPort | Specifies the port number to be used for sending queries to the DNS server. |
SocketDNSQueryTimeout | The timeout (in milliseconds) for each DNS query. |
SocketDNSServers | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
SocketDNSTotalTimeout | The timeout (in milliseconds) for the whole resolution process. |
SocketIncomingSpeedLimit | The maximum number of bytes to read from the socket, per second. |
SocketLocalAddress | The local network interface to bind the socket to. |
SocketLocalPort | The local port number to bind the socket to. |
SocketOutgoingSpeedLimit | The maximum number of bytes to write to the socket, per second. |
SocketTimeout | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
SocketUseIPv6 | Enables or disables IP protocol version 6. |
SubjectConfirmationCount | The number of records in the SubjectConfirmation arrays. |
SubjectConfirmationDataAddress | Contains the address enabled for presenting assertions. |
SubjectConfirmationDataInResponseTo | The ID of the SAML message in response to which the assertion is issued. |
SubjectConfirmationDataNotBefore | Time moment before which the subject cannot be confirmed. |
SubjectConfirmationDataNotOnOrAfter | Limits the time until which the subject can be confirmed. |
SubjectConfirmationDataRecipient | The URI of the entity or the location of the resource to which the assertion should be presented. |
SubjectConfirmationDataType | The type of data contained in the confirmation. |
SubjectConfirmationID | The identifier of the entity which can satisfy the subject confirmation requirements. |
SubjectConfirmationMethod | Specifies the mechanism to be used to confirm the subject. |
SubjectID | Returns the subject of the message. |
TLSAutoValidateCertificates | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
TLSBaseConfiguration | Selects the base configuration for the TLS settings. |
TLSCiphersuites | A list of ciphersuites separated with commas or semicolons. |
TLSECCurves | Defines the elliptic curves to enable. |
TLSExtensions | Provides access to TLS extensions. |
TLSForceResumeIfDestinationChanges | Whether to force TLS session resumption when the destination address changes. |
TLSPreSharedIdentity | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
TLSPreSharedKey | Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
TLSPreSharedKeyCiphersuite | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
TLSRenegotiationAttackPreventionMode | Selects renegotiation attack prevention mechanism. |
TLSRevocationCheck | Specifies the kind(s) of revocation check to perform. |
TLSSSLOptions | 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. |
TLSTLSMode | Specifies the TLS mode to use. |
TLSUseExtendedMasterSecret | Enables Extended Master Secret Extension, as defined in RFC 7627. |
TLSUseSessionResumption | Enables or disables TLS session resumption capability. |
TLSVersions | Th SSL/TLS versions to enable by default. |
TrustedCertCount | The number of records in the TrustedCert arrays. |
TrustedCertBytes | Returns raw certificate data in DER format. |
TrustedCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
UseBinding | Enables or disables automated binding processing. |
ValidateSignatures | Enables or disables automated signature validation. |
ValidationLog | Contains the complete log of the certificate validation routine. |
ValidationMoment | The time point at which chain validity is to be established. |
Version | Returns SAML content version string. |
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 | Compares two SAML IDs. |
Config | Sets or retrieves a configuration setting. |
DoAction | Performs an additional action. |
GetIDProp | Extracts a specific property from a SAML ID. |
Open | Opens a SAML entity. |
OpenBytes | Opens a SAML entity. |
OpenFile | Opens a SAML entity. |
PinAdviceAssertion | Pins advice assertion by propagating it in PinnedAssertionXXX properties. |
PinAssertion | Pins assertion by propagating it in PinnedAssertionXXX properties. |
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.
Error | Fires to report an error condition. |
Notification | This event notifies the application about an underlying control flow event. |
SignatureFound | Signifies the start of signature validation. |
SignatureValidated | Reports the signature validation result. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
UseMicrosoftCTL | Enables or disables automatic use of Microsoft online certificate trust list. |
UseSystemCertificates | Enables or disables the use of the system certificates. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only). |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
Tag | Allows to store any custom data. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
ArtifactEndpointIndex Property (SAMLReader Class)
An accessor to the EndpointIndex entry of the artifact.
Syntax
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
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
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
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
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
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
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
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
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
int GetAttrQueryAttrCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- AttrQueryAttrFriendlyName
- AttrQueryAttrName
- AttrQueryAttrNameFormat
- AttrQueryAttrStatementIndex
- AttrQueryAttrValues
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
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
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
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
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
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
int GetAuthnQueryComparison();
Possible Values
CACCT_NONE(0),
CACCT_EXACT(1),
CACCT_MINIMUM(2),
CACCT_MAXIMUM(3),
CACCT_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 (SAMLReader Class)
Specifies the context class reference.
Syntax
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
int GetAuthnQueryRefType();
Possible Values
CACRT_UNKNOWN(0),
CACRT_CLASS(1),
CACRT_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 (SAMLReader Class)
Specifies the index of the session to the authentication entity.
Syntax
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
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
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
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
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
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
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
int GetAuthnRequestContextComparison();
Possible Values
CACCT_NONE(0),
CACCT_EXACT(1),
CACCT_MINIMUM(2),
CACCT_MAXIMUM(3),
CACCT_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 (SAMLReader Class)
Specifies the context reference type.
Syntax
int GetAuthnRequestContextRefType();
Possible Values
CACRT_UNKNOWN(0),
CACRT_CLASS(1),
CACRT_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
AuthnRequestForceAuthn Property (SAMLReader Class)
Corresponds to the ForceAuthn parameter of the request.
Syntax
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
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
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
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
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
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
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
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
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
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
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
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
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
int GetAuthnRequestConditionCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- AuthnRequestConditionAudienceList
- AuthnRequestConditionConditionType
- AuthnRequestConditionProxyRestrictionCount
- AuthnRequestConditionsNotBefore
- AuthnRequestConditionsNotOnOrAfter
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
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
int GetAuthnRequestConditionConditionType(int iAuthnRequestConditionIndex);
Possible Values
CSCT_AUDIENCE_RESTRICTION(0),
CSCT_ONE_TIME_USE(1),
CSCT_PROXY_RESTRICTION(2)
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
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
int GetAuthnRequestScopingIDPCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- AuthnRequestScopingIDPListGetComplete
- AuthnRequestScopingIDPLoc
- AuthnRequestScopingIDPName
- AuthnRequestScopingIDPProviderID
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
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
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
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
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
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
int GetBinding();
Possible Values
CSBT_NONE(0),
CSBT_SOAP(1),
CSBT_PAOS(2),
CSBT_REDIRECT(3),
CSBT_POST(4),
CSBT_ARTIFACT(5)
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
int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
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 raw certificate data in DER format.
Syntax
QByteArray GetBlockedCertBytes(int iBlockedCertIndex);
Remarks
Returns 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
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.
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
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:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
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
int GetChainValidationResult();
Possible Values
CVT_VALID(0),
CVT_VALID_BUT_UNTRUSTED(1),
CVT_INVALID(2),
CVT_CANT_BE_ESTABLISHED(3)
Default Value
0
Remarks
Available options:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
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
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 raw certificate data in DER format.
Syntax
QByteArray GetDecryptionCertificateBytes();
Remarks
Returns 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
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.
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
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
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
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
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
int GetInputType();
Possible Values
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)
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
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
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
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
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
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
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 raw certificate data in DER format.
Syntax
QByteArray GetKnownCertBytes(int iKnownCertIndex);
Remarks
Returns 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
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.
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
int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
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 raw CRL data in DER format.
Syntax
QByteArray GetKnownCRLBytes(int iKnownCRLIndex);
Remarks
Returns 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
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.
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
int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
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)
Buffer containing raw OCSP response data.
Syntax
QByteArray GetKnownOCSPBytes(int iKnownOCSPIndex);
Remarks
Buffer containing 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
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.
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
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
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
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
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
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
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
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
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
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
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
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
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
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 the offline mode.
Syntax
bool GetOfflineMode();
int SetOfflineMode(bool bOfflineMode);
Default Value
false
Remarks
When working in offline mode, the component 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 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
int GetPinnedAssertionAttrCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- PinnedAssertionAttrFriendlyName
- PinnedAssertionAttrName
- PinnedAssertionAttrNameFormat
- PinnedAssertionAttrStatementIndex
- PinnedAssertionAttrValues
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
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
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
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
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
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
int GetPinnedAssertionConditionCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- PinnedAssertionConditionAudienceList
- PinnedAssertionConditionConditionType
- PinnedAssertionConditionProxyRestrictionCount
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
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
int GetPinnedAssertionConditionConditionType(int iPinnedAssertionConditionIndex);
Possible Values
CSCT_AUDIENCE_RESTRICTION(0),
CSCT_ONE_TIME_USE(1),
CSCT_PROXY_RESTRICTION(2)
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
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
Integer
PinnedAssertionInfoAdviceAssertionCount Property (SAMLReader Class)
Contains the number of advice assertions.
Syntax
int GetPinnedAssertionInfoAdviceAssertionCount();
Default Value
0
Remarks
Contains the number of advice assertions.
Use this property to access the number of advice assertions.
This property is read-only and not available at design time.
Data Type
Integer
PinnedAssertionInfoAssertionType Property (SAMLReader Class)
Specifies the type of the assertion.
Syntax
int GetPinnedAssertionInfoAssertionType();
Possible Values
CSAT_ASSERTION_IDREF(0),
CSAT_ASSERTION_URIREF(1),
CSAT_ASSERTION(2),
CSAT_ENCRYPTED_ASSERTION(3)
Default Value
0
Remarks
Specifies the type of the assertion.
Use this property to check or set the type of the assertion.
This property is read-only and not available at design time.
Data Type
Integer
PinnedAssertionInfoChainValidationDetails Property (SAMLReader Class)
The details of a certificate chain validation outcome.
Syntax
int GetPinnedAssertionInfoChainValidationDetails();
Default Value
0
Remarks
The details of a certificate chain validation outcome. They may often suggest what reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
This property is read-only and not available at design time.
Data Type
Integer
PinnedAssertionInfoChainValidationResult Property (SAMLReader Class)
The outcome of a certificate chain validation routine.
Syntax
int GetPinnedAssertionInfoChainValidationResult();
Possible Values
CVT_VALID(0),
CVT_VALID_BUT_UNTRUSTED(1),
CVT_INVALID(2),
CVT_CANT_BE_ESTABLISHED(3)
Default Value
0
Remarks
The outcome of a certificate chain validation routine.
Available options:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
This property is read-only and not available at design time.
Data Type
Integer
PinnedAssertionInfoConditionsNotBefore Property (SAMLReader Class)
Represents the Conditions.
Syntax
QString GetPinnedAssertionInfoConditionsNotBefore();
Default Value
""
Remarks
Represents the Conditions.NotBefore assertion property.
Use this property to get or set the Conditions.NotBefore property of the assertion.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionInfoConditionsNotOnOrAfter Property (SAMLReader Class)
Represents the Conditions.
Syntax
QString GetPinnedAssertionInfoConditionsNotOnOrAfter();
Default Value
""
Remarks
Represents the Conditions.NotOnOrAfter assertion property.
Use this property to get or set the Conditions.NotOnOrAfter property of the assertion.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionInfoEncryptedContent Property (SAMLReader Class)
Represents the encrypted assertion content.
Syntax
QString GetPinnedAssertionInfoEncryptedContent();
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
PinnedAssertionInfoID Property (SAMLReader Class)
Represents the ID of the assertion.
Syntax
QString GetPinnedAssertionInfoID();
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
PinnedAssertionInfoIDRef Property (SAMLReader Class)
Represents an ID reference value.
Syntax
QString GetPinnedAssertionInfoIDRef();
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
PinnedAssertionInfoIssueInstant Property (SAMLReader Class)
Contains the assertion issuance time stamp.
Syntax
QString GetPinnedAssertionInfoIssueInstant();
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
PinnedAssertionInfoSignatureValidationResult Property (SAMLReader Class)
The outcome of the cryptographic signature validation.
Syntax
int GetPinnedAssertionInfoSignatureValidationResult();
Possible Values
SVT_VALID(0),
SVT_UNKNOWN(1),
SVT_CORRUPTED(2),
SVT_SIGNER_NOT_FOUND(3),
SVT_FAILURE(4)
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 |
This property is read-only and not available at design time.
Data Type
Integer
PinnedAssertionInfoSigned Property (SAMLReader Class)
Specifies whether the assertion is signed.
Syntax
bool GetPinnedAssertionInfoSigned();
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
PinnedAssertionInfoURIRef Property (SAMLReader Class)
Represents an URI reference value.
Syntax
QString GetPinnedAssertionInfoURIRef();
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
PinnedAssertionInfoValidationLog Property (SAMLReader Class)
Contains the signing certificate's chain validation log.
Syntax
QString GetPinnedAssertionInfoValidationLog();
Default Value
""
Remarks
Contains the signing certificate's chain validation log. This information may be very useful in investigating chain validation failures.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionInfoVersion Property (SAMLReader Class)
Specifies the SAML protocol version used.
Syntax
QString GetPinnedAssertionInfoVersion();
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
PinnedAssertionIssuer Property (SAMLReader Class)
Returns the pinned assertion issuer.
Syntax
QString GetPinnedAssertionIssuer();
Default Value
""
Remarks
Check this property to access the SAML ID of the issuer of the assertion previously pinned with PinAssertion or PinAdviceAssertion method.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionStatementCount Property (SAMLReader Class)
The number of records in the PinnedAssertionStatement arrays.
Syntax
int GetPinnedAssertionStatementCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- PinnedAssertionStatementAttributes
- PinnedAssertionStatementAuthnContextAuthenticatingAuthorities
- PinnedAssertionStatementAuthnContextChoice
- PinnedAssertionStatementAuthnContextClassRef
- PinnedAssertionStatementAuthnContextDecl
- PinnedAssertionStatementAuthnContextDeclRef
- PinnedAssertionStatementAuthnInstant
- PinnedAssertionStatementAuthnSessionIndex
- PinnedAssertionStatementAuthnSessionNotOnOrAfter
- PinnedAssertionStatementAuthnSubjectLocalityAddress
- PinnedAssertionStatementAuthnSubjectLocalityDNSName
- PinnedAssertionStatementAuthzActions
- PinnedAssertionStatementAuthzDecision
- PinnedAssertionStatementAuthzDecisionEvidence
- PinnedAssertionStatementAuthzDecisionResource
- PinnedAssertionStatementStatementType
This property is read-only and not available at design time.
Data Type
Integer
PinnedAssertionStatementAttributes Property (SAMLReader Class)
Contains a list of statement attribute names.
Syntax
QString GetPinnedAssertionStatementAttributes(int iPinnedAssertionStatementIndex);
Default Value
""
Remarks
Contains a list of statement attribute names.
Use this property to access the set of names of assertion attributes, separated by CRLF.
The PinnedAssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionStatementCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionStatementAuthnContextAuthenticatingAuthorities Property (SAMLReader Class)
Contains the list of authenticating authorities.
Syntax
QString GetPinnedAssertionStatementAuthnContextAuthenticatingAuthorities(int iPinnedAssertionStatementIndex);
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 PinnedAssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionStatementCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionStatementAuthnContextChoice Property (SAMLReader Class)
Specifies the authentication context choice variant.
Syntax
QString GetPinnedAssertionStatementAuthnContextChoice(int iPinnedAssertionStatementIndex);
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 PinnedAssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionStatementCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionStatementAuthnContextClassRef Property (SAMLReader Class)
Indicates the authentication contexts class reference.
Syntax
QString GetPinnedAssertionStatementAuthnContextClassRef(int iPinnedAssertionStatementIndex);
Default Value
""
Remarks
Indicates the authentication contexts class reference.
Use this property to get or set the authentication contexts class reference attribute.
The PinnedAssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionStatementCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionStatementAuthnContextDecl Property (SAMLReader Class)
Specifies the authentication contexts declaration.
Syntax
QString GetPinnedAssertionStatementAuthnContextDecl(int iPinnedAssertionStatementIndex);
Default Value
""
Remarks
Specifies the authentication contexts declaration.
Use this property to access or set the declaration element of the authentication context.
The PinnedAssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionStatementCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionStatementAuthnContextDeclRef Property (SAMLReader Class)
Specifies the authentication contexts declaration reference.
Syntax
QString GetPinnedAssertionStatementAuthnContextDeclRef(int iPinnedAssertionStatementIndex);
Default Value
""
Remarks
Specifies the authentication contexts declaration reference.
Use this property to get or set the declaration reference of the authentication context.
The PinnedAssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionStatementCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionStatementAuthnInstant Property (SAMLReader Class)
Specifies the authentication event timestamp.
Syntax
QString GetPinnedAssertionStatementAuthnInstant(int iPinnedAssertionStatementIndex);
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 PinnedAssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionStatementCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionStatementAuthnSessionIndex Property (SAMLReader Class)
Contains the authentication session index.
Syntax
QString GetPinnedAssertionStatementAuthnSessionIndex(int iPinnedAssertionStatementIndex);
Default Value
""
Remarks
Contains the authentication session index.
Use this property to access or set the authentication session index.
The PinnedAssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionStatementCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionStatementAuthnSessionNotOnOrAfter Property (SAMLReader Class)
Maps to the SessionNotOnOrAfter parameter of the authentication statement.
Syntax
QString GetPinnedAssertionStatementAuthnSessionNotOnOrAfter(int iPinnedAssertionStatementIndex);
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 PinnedAssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionStatementCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionStatementAuthnSubjectLocalityAddress Property (SAMLReader Class)
Specifies the authentication subjects address.
Syntax
QString GetPinnedAssertionStatementAuthnSubjectLocalityAddress(int iPinnedAssertionStatementIndex);
Default Value
""
Remarks
Specifies the authentication subjects address.
Use this property to specify the address parameter of the authentication subjects locality.
The PinnedAssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionStatementCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionStatementAuthnSubjectLocalityDNSName Property (SAMLReader Class)
Maps to the authentication subjects DNS name parameter.
Syntax
QString GetPinnedAssertionStatementAuthnSubjectLocalityDNSName(int iPinnedAssertionStatementIndex);
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 PinnedAssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionStatementCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionStatementAuthzActions Property (SAMLReader Class)
Provides access to the list of actions of the authorization statement.
Syntax
QString GetPinnedAssertionStatementAuthzActions(int iPinnedAssertionStatementIndex);
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 PinnedAssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionStatementCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionStatementAuthzDecision Property (SAMLReader Class)
Specifies the authorization decision.
Syntax
int GetPinnedAssertionStatementAuthzDecision(int iPinnedAssertionStatementIndex);
Possible Values
CSADN_PERMIT(0),
CSADN_DENY(1),
CSADN_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 PinnedAssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionStatementCount property.
This property is read-only and not available at design time.
Data Type
Integer
PinnedAssertionStatementAuthzDecisionEvidence Property (SAMLReader Class)
Manages the authorization decision statement evidence parameter.
Syntax
QString GetPinnedAssertionStatementAuthzDecisionEvidence(int iPinnedAssertionStatementIndex);
Default Value
""
Remarks
Manages the authorization decision statement evidence parameter.
Use this property to read or set the authorization decision statement evidence parameter.
The PinnedAssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionStatementCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionStatementAuthzDecisionResource Property (SAMLReader Class)
Specifies the authorization decision statement resource parameter.
Syntax
QString GetPinnedAssertionStatementAuthzDecisionResource(int iPinnedAssertionStatementIndex);
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 PinnedAssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionStatementCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionStatementStatementType Property (SAMLReader Class)
Specifies the assertion statement type.
Syntax
int GetPinnedAssertionStatementStatementType(int iPinnedAssertionStatementIndex);
Possible Values
CSAST_AUTHN(0),
CSAST_ATTRIBUTE(1),
CSAST_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 PinnedAssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionStatementCount property.
This property is read-only and not available at design time.
Data Type
Integer
PinnedAssertionSubjectConfirmationCount Property (SAMLReader Class)
The number of records in the PinnedAssertionSubjectConfirmation arrays.
Syntax
int GetPinnedAssertionSubjectConfirmationCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- PinnedAssertionSubjectConfirmationDataAddress
- PinnedAssertionSubjectConfirmationDataInResponseTo
- PinnedAssertionSubjectConfirmationDataNotBefore
- PinnedAssertionSubjectConfirmationDataNotOnOrAfter
- PinnedAssertionSubjectConfirmationDataRecipient
- PinnedAssertionSubjectConfirmationDataType
- PinnedAssertionSubjectConfirmationID
- PinnedAssertionSubjectConfirmationMethod
This property is read-only and not available at design time.
Data Type
Integer
PinnedAssertionSubjectConfirmationDataAddress Property (SAMLReader Class)
Contains the address enabled for presenting assertions.
Syntax
QString GetPinnedAssertionSubjectConfirmationDataAddress(int iPinnedAssertionSubjectConfirmationIndex);
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 PinnedAssertionSubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionSubjectConfirmationCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionSubjectConfirmationDataInResponseTo Property (SAMLReader Class)
The ID of the SAML message in response to which the assertion is issued.
Syntax
QString GetPinnedAssertionSubjectConfirmationDataInResponseTo(int iPinnedAssertionSubjectConfirmationIndex);
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 PinnedAssertionSubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionSubjectConfirmationCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionSubjectConfirmationDataNotBefore Property (SAMLReader Class)
Time moment before which the subject cannot be confirmed.
Syntax
QString GetPinnedAssertionSubjectConfirmationDataNotBefore(int iPinnedAssertionSubjectConfirmationIndex);
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 PinnedAssertionSubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionSubjectConfirmationCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionSubjectConfirmationDataNotOnOrAfter Property (SAMLReader Class)
Limits the time until which the subject can be confirmed.
Syntax
QString GetPinnedAssertionSubjectConfirmationDataNotOnOrAfter(int iPinnedAssertionSubjectConfirmationIndex);
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 PinnedAssertionSubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionSubjectConfirmationCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionSubjectConfirmationDataRecipient Property (SAMLReader Class)
The URI of the entity or the location of the resource to which the assertion should be presented.
Syntax
QString GetPinnedAssertionSubjectConfirmationDataRecipient(int iPinnedAssertionSubjectConfirmationIndex);
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 PinnedAssertionSubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionSubjectConfirmationCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionSubjectConfirmationDataType Property (SAMLReader Class)
The type of data contained in the confirmation.
Syntax
QString GetPinnedAssertionSubjectConfirmationDataType(int iPinnedAssertionSubjectConfirmationIndex);
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 PinnedAssertionSubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionSubjectConfirmationCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionSubjectConfirmationID Property (SAMLReader Class)
The identifier of the entity which can satisfy the subject confirmation requirements.
Syntax
QString GetPinnedAssertionSubjectConfirmationID(int iPinnedAssertionSubjectConfirmationIndex);
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 PinnedAssertionSubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionSubjectConfirmationCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionSubjectConfirmationMethod Property (SAMLReader Class)
Specifies the mechanism to be used to confirm the subject.
Syntax
QString GetPinnedAssertionSubjectConfirmationMethod(int iPinnedAssertionSubjectConfirmationIndex);
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 PinnedAssertionSubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedAssertionSubjectConfirmationCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedAssertionSubjectID Property (SAMLReader Class)
Returns the pinned assertion subject.
Syntax
QString GetPinnedAssertionSubjectID();
Default Value
""
Remarks
Check this property to access the SAML ID of the subject of the assertion previously pinned with PinAssertion or PinAdviceAssertion method.
This property is read-only and not available at design time.
Data Type
String
POSTBindingBody Property (SAMLReader Class)
Contains the form body.
Syntax
QString GetPOSTBindingBody();
Default Value
""
Remarks
Contains the form body.
Use this property to read or set the body of the form returned by the service provider.
This property is read-only and not available at design time.
Data Type
String
POSTBindingFormTemplate Property (SAMLReader Class)
Contains the XHTML form template returned by the service provider.
Syntax
QString GetPOSTBindingFormTemplate();
Default Value
""
Remarks
Contains the XHTML form template returned by the service provider.
Use this property to access or set the template of a POST form provided by the service provider.
This property is read-only and not available at design time.
Data Type
String
POSTBindingMode Property (SAMLReader Class)
Specifies whether binding is applied on a server, or on a client side.
Syntax
int GetPOSTBindingMode();
Possible Values
CSPM_CLIENT(0),
CSPM_SERVER(1)
Default Value
0
Remarks
Specifies whether binding is applied on a server, or on a client side.
Use this property to specify whether binding is used on the server or client side of the communication. The default value is cspmClient.
This property is read-only and not available at design time.
Data Type
Integer
POSTBindingRelayState Property (SAMLReader Class)
Contains the value of the RelayState parameter of POST binding mechanism.
Syntax
QString GetPOSTBindingRelayState();
Default Value
""
Remarks
Contains the value of the RelayState parameter of POST binding mechanism.
Use this property to read or set the value of the RelayState parameter of the POST binding. RelayState contains an uninterpreted service-provider-originating state object, which should be passed back to it with any further requests.
This property is read-only and not available at design time.
Data Type
String
POSTBindingURL Property (SAMLReader Class)
Contains the URL of POST binding mechanism.
Syntax
QString GetPOSTBindingURL();
Default Value
""
Remarks
Contains the URL of POST binding mechanism.
Use this property to check or set the URL of POST binding mechanism.
This property is read-only and not available at design time.
Data Type
String
Profile Property (SAMLReader Class)
Specifies a pre-defined profile to apply when creating the signature.
Syntax
QString GetProfile();
int SetProfile(QString qsProfile);
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 (SAMLReader Class)
The IP address of the proxy server.
Syntax
QString GetProxyAddress();
int SetProxyAddress(QString qsProxyAddress);
Default Value
""
Remarks
The IP address of the proxy server.
Data Type
String
ProxyAuthentication Property (SAMLReader Class)
The authentication type used by the proxy server.
Syntax
int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication);
Possible Values
PAT_NO_AUTHENTICATION(0),
PAT_BASIC(1),
PAT_DIGEST(2),
PAT_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 (SAMLReader Class)
The password to authenticate to the proxy server.
Syntax
QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);
Default Value
""
Remarks
The password to authenticate to the proxy server.
Data Type
String
ProxyPort Property (SAMLReader Class)
The port on the proxy server to connect to.
Syntax
int GetProxyPort();
int SetProxyPort(int iProxyPort);
Default Value
0
Remarks
The port on the proxy server to connect to.
Data Type
Integer
ProxyProxyType Property (SAMLReader Class)
The type of the proxy server.
Syntax
int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType);
Possible Values
CPT_NONE(0),
CPT_SOCKS_4(1),
CPT_SOCKS_5(2),
CPT_WEB_TUNNEL(3),
CPT_HTTP(4)
Default Value
0
Remarks
The type of the proxy server.
The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.
cptNone | 0 |
cptSocks4 | 1 |
cptSocks5 | 2 |
cptWebTunnel | 3 |
cptHTTP | 4 |
Data Type
Integer
ProxyRequestHeaders Property (SAMLReader Class)
Contains HTTP request headers for WebTunnel and HTTP proxy.
Syntax
QString GetProxyRequestHeaders();
int SetProxyRequestHeaders(QString qsProxyRequestHeaders);
Default Value
""
Remarks
Contains HTTP request headers for WebTunnel and HTTP proxy.
Data Type
String
ProxyResponseBody Property (SAMLReader Class)
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
Syntax
QString GetProxyResponseBody();
int SetProxyResponseBody(QString qsProxyResponseBody);
Default Value
""
Remarks
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
Data Type
String
ProxyResponseHeaders Property (SAMLReader Class)
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
Syntax
QString GetProxyResponseHeaders();
int SetProxyResponseHeaders(QString qsProxyResponseHeaders);
Default Value
""
Remarks
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
Data Type
String
ProxyUseIPv6 Property (SAMLReader Class)
Specifies whether IPv6 should be used when connecting through the proxy.
Syntax
bool GetProxyUseIPv6();
int SetProxyUseIPv6(bool bProxyUseIPv6);
Default Value
false
Remarks
Specifies whether IPv6 should be used when connecting through the proxy.
Data Type
Boolean
ProxyUseProxy Property (SAMLReader Class)
Enables or disables proxy-driven connection.
Syntax
bool GetProxyUseProxy();
int SetProxyUseProxy(bool bProxyUseProxy);
Default Value
false
Remarks
Enables or disables proxy-driven connection.
Data Type
Boolean
ProxyUsername Property (SAMLReader Class)
Specifies the username credential for proxy authentication.
Syntax
QString GetProxyUsername();
int SetProxyUsername(QString qsProxyUsername);
Default Value
""
Remarks
Specifies the username credential for proxy authentication.
Data Type
String
RedirectBindingEncoding Property (SAMLReader Class)
Specifies the message encoding.
Syntax
QString GetRedirectBindingEncoding();
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
RedirectBindingForceSign Property (SAMLReader Class)
Enforces a signature over all outgoing messages.
Syntax
bool GetRedirectBindingForceSign();
Default Value
false
Remarks
Enforces a signature over all outgoing messages.
Use this property to enforce signing of all outgoing messages, independently of whether the original message was signed or not. See also RedirectBindingSign.
This property is read-only and not available at design time.
Data Type
Boolean
RedirectBindingRelayState Property (SAMLReader Class)
Contains the RelayState parameter of the binding.
Syntax
QString GetRedirectBindingRelayState();
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
RedirectBindingSign Property (SAMLReader Class)
Specifies whether to sign generated messages.
Syntax
bool GetRedirectBindingSign();
Default Value
false
Remarks
Specifies whether to sign generated messages.
Use this property to enable or disable signing of generated binding entities. The SAML specification instructs that the binding should only be signed if the original XML was. This property therefore is only taken into account if the original XML was signed. With that in mind, certain service providers demand the binding to be signed at all times. Use RedirectBindingForceSign property to enforce signatures on all binding entities.
This property is read-only and not available at design time.
Data Type
Boolean
RedirectBindingSignatureAlgorithm Property (SAMLReader Class)
Contains the signature algorithm.
Syntax
QString GetRedirectBindingSignatureAlgorithm();
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
RedirectBindingURL Property (SAMLReader Class)
Contains the URL of the request query.
Syntax
QString GetRedirectBindingURL();
Default Value
""
Remarks
Contains the URL of the request query.
Use this property to read or set the URL of the request query.
This property is read-only and not available at design time.
Data Type
String
RedirectBindingVerifySignatures Property (SAMLReader Class)
Instructs the class whether to verify incoming signatures.
Syntax
bool GetRedirectBindingVerifySignatures();
Default Value
false
Remarks
Instructs the component whether to verify incoming signatures.
Use this property to activate or deactivate verification of signatures in incoming requests.
This property is read-only and not available at design time.
Data Type
Boolean
RedirectBindingCertBytes Property (SAMLReader Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetRedirectBindingCertBytes();
Remarks
Returns raw certificate data in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
RedirectBindingCertHandle Property (SAMLReader Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetRedirectBindingCertHandle();
int SetRedirectBindingCertHandle(qint64 lRedirectBindingCertHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is not available at design time.
Data Type
Long64
ResponseNameID Property (SAMLReader Class)
Contains the NameID parameter of a NameIDMapping response.
Syntax
QString GetResponseNameID();
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 (SAMLReader Class)
An optional message element to be returned with the response.
Syntax
QString GetResponseOptionalElement();
Default Value
""
Remarks
An optional message element to be returned with the response.
Use this property to access or set the optional XML element returned with the response.
This property is read-only and not available at design time.
Data Type
String
ResponseResponseType Property (SAMLReader Class)
Contains the type of the response.
Syntax
int GetResponseResponseType();
Possible Values
CSRT_RESPONSE(0),
CSRT_ARTIFACT_RESPONSE(1),
CSRT_NAME_IDMAPPING_RESPONSE(2)
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
ResponseStatusCodeSubValue Property (SAMLReader Class)
The value of the nested StatusCode.
Syntax
QString GetResponseStatusCodeSubValue();
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 (SAMLReader Class)
Contains the status code value.
Syntax
QString GetResponseStatusCodeValue();
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 (SAMLReader Class)
Contains additional information on the status of the request.
Syntax
QString GetResponseStatusDetail();
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 (SAMLReader Class)
Contains a status message (optional).
Syntax
QString GetResponseStatusMessage();
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
SignatureValidationResult Property (SAMLReader Class)
Contains the signature validation result.
Syntax
int GetSignatureValidationResult();
Possible Values
XSV_VALID(0),
XSV_UNKNOWN(1),
XSV_CORRUPTED(2),
XSV_SIGNER_NOT_FOUND(3),
XSV_FAILURE(4),
XSV_REFERENCE_CORRUPTED(5)
Default Value
0
Remarks
Use this property to check the result of the most recent XML signature validation.
xsvValid | 0 | |
xsvUnknown | 1 | |
xsvCorrupted | 2 | |
xsvSignerNotFound | 3 | |
xsvFailure | 4 | |
xsvReferenceCorrupted | 5 |
This property is read-only and not available at design time.
Data Type
Integer
Signed Property (SAMLReader Class)
Returns true it the message is signed.
Syntax
bool GetSigned();
Default Value
false
Remarks
Check this property to find out whether the SAML entity is signed.
This property is read-only and not available at design time.
Data Type
Boolean
SigningCertBytes Property (SAMLReader Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetSigningCertBytes();
Remarks
Returns raw certificate data in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
SigningCertCA Property (SAMLReader Class)
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
Syntax
bool GetSigningCertCA();
Default Value
false
Remarks
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
This property is read-only and not available at design time.
Data Type
Boolean
SigningCertCAKeyID Property (SAMLReader Class)
A unique identifier (fingerprint) of the CA certificate's private key.
Syntax
QByteArray GetSigningCertCAKeyID();
Remarks
A unique identifier (fingerprint) of the CA certificate's private key.
Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.
This property is read-only and not available at design time.
Data Type
Byte Array
SigningCertCRLDistributionPoints Property (SAMLReader Class)
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
Syntax
QString GetSigningCertCRLDistributionPoints();
Default Value
""
Remarks
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
This property is read-only and not available at design time.
Data Type
String
SigningCertCurve Property (SAMLReader Class)
Specifies the elliptic curve of the EC public key.
Syntax
QString GetSigningCertCurve();
Default Value
""
Remarks
Specifies the elliptic curve of the EC public key.
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 (SAMLReader Class)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
QByteArray GetSigningCertFingerprint();
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
This property is read-only and not available at design time.
Data Type
Byte Array
SigningCertFriendlyName Property (SAMLReader Class)
Contains an associated alias (friendly name) of the certificate.
Syntax
QString GetSigningCertFriendlyName();
Default Value
""
Remarks
Contains an associated alias (friendly name) of the certificate.
This property is read-only and not available at design time.
Data Type
String
SigningCertHandle Property (SAMLReader Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetSigningCertHandle();
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is read-only and not available at design time.
Data Type
Long64
SigningCertHashAlgorithm Property (SAMLReader Class)
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 .
Syntax
QString GetSigningCertHashAlgorithm();
Default Value
""
Remarks
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
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 (SAMLReader Class)
The common name of the certificate issuer (CA), typically a company name.
Syntax
QString GetSigningCertIssuer();
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name.
This property is read-only and not available at design time.
Data Type
String
SigningCertIssuerRDN Property (SAMLReader Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
Syntax
QString GetSigningCertIssuerRDN();
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
This property is read-only and not available at design time.
Data Type
String
SigningCertKeyAlgorithm Property (SAMLReader Class)
Specifies the public key algorithm of this certificate.
Syntax
QString GetSigningCertKeyAlgorithm();
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 |
This property is read-only and not available at design time.
Data Type
String
SigningCertKeyBits Property (SAMLReader Class)
Returns the length of the public key.
Syntax
int GetSigningCertKeyBits();
Default Value
0
Remarks
Returns the length of the public key.
This property is read-only and not available at design time.
Data Type
Integer
SigningCertKeyFingerprint Property (SAMLReader Class)
Returns a fingerprint of the public key contained in the certificate.
Syntax
QByteArray GetSigningCertKeyFingerprint();
Remarks
Returns a fingerprint of the public key contained in the certificate.
This property is read-only and not available at design time.
Data Type
Byte Array
SigningCertKeyUsage Property (SAMLReader Class)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
int GetSigningCertKeyUsage();
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 |
This property is read-only and not available at design time.
Data Type
Integer
SigningCertKeyValid Property (SAMLReader Class)
Returns True if the certificate's key is cryptographically valid, and False otherwise.
Syntax
bool GetSigningCertKeyValid();
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 (SAMLReader Class)
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
Syntax
QString GetSigningCertOCSPLocations();
Default Value
""
Remarks
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
This property is read-only and not available at design time.
Data Type
String
SigningCertPolicyIDs Property (SAMLReader Class)
Contains identifiers (OIDs) of the applicable certificate policies.
Syntax
QString GetSigningCertPolicyIDs();
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.
This property is read-only and not available at design time.
Data Type
String
SigningCertPublicKeyBytes Property (SAMLReader Class)
Contains the certificate's public key in DER format.
Syntax
QByteArray GetSigningCertPublicKeyBytes();
Remarks
Contains the certificate's public key in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
SigningCertSelfSigned Property (SAMLReader Class)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
bool GetSigningCertSelfSigned();
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 (SAMLReader Class)
Returns the certificate's serial number.
Syntax
QByteArray GetSigningCertSerialNumber();
Remarks
Returns the certificate's serial number.
This property is read-only and not available at design time.
Data Type
Byte Array
SigningCertSigAlgorithm Property (SAMLReader Class)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
QString GetSigningCertSigAlgorithm();
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
This property is read-only and not available at design time.
Data Type
String
SigningCertSubject Property (SAMLReader Class)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
QString GetSigningCertSubject();
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 property is read-only and not available at design time.
Data Type
String
SigningCertSubjectKeyID Property (SAMLReader Class)
Contains a unique identifier (fingerprint) of the certificate's private key.
Syntax
QByteArray GetSigningCertSubjectKeyID();
Remarks
Contains a unique identifier (fingerprint) of the certificate's private key.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.
This property is read-only and not available at design time.
Data Type
Byte Array
SigningCertSubjectRDN Property (SAMLReader Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
Syntax
QString GetSigningCertSubjectRDN();
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
This property is read-only and not available at design time.
Data Type
String
SigningCertValidFrom Property (SAMLReader Class)
The time point at which the certificate becomes valid, in UTC.
Syntax
QString GetSigningCertValidFrom();
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 (SAMLReader Class)
The time point at which the certificate expires, in UTC.
Syntax
QString GetSigningCertValidTo();
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 (SAMLReader Class)
Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
Syntax
int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode);
Possible Values
DM_AUTO(0),
DM_PLATFORM(1),
DM_OWN(2),
DM_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 (SAMLReader Class)
Specifies the port number to be used for sending queries to the DNS server.
Syntax
int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort);
Default Value
0
Remarks
Specifies the port number to be used for sending queries to the DNS server.
Data Type
Integer
SocketDNSQueryTimeout Property (SAMLReader Class)
The timeout (in milliseconds) for each DNS query.
Syntax
int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout);
Default Value
0
Remarks
The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout.
Data Type
Integer
SocketDNSServers Property (SAMLReader Class)
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
Syntax
QString GetSocketDNSServers();
int SetSocketDNSServers(QString qsSocketDNSServers);
Default Value
""
Remarks
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
Data Type
String
SocketDNSTotalTimeout Property (SAMLReader Class)
The timeout (in milliseconds) for the whole resolution process.
Syntax
int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout);
Default Value
0
Remarks
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout.
Data Type
Integer
SocketIncomingSpeedLimit Property (SAMLReader Class)
The maximum number of bytes to read from the socket, per second.
Syntax
int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit);
Default Value
0
Remarks
The maximum number of bytes to read from the socket, per second.
Data Type
Integer
SocketLocalAddress Property (SAMLReader Class)
The local network interface to bind the socket to.
Syntax
QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress);
Default Value
""
Remarks
The local network interface to bind the socket to.
Data Type
String
SocketLocalPort Property (SAMLReader Class)
The local port number to bind the socket to.
Syntax
int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort);
Default Value
0
Remarks
The local port number to bind the socket to.
Data Type
Integer
SocketOutgoingSpeedLimit Property (SAMLReader Class)
The maximum number of bytes to write to the socket, per second.
Syntax
int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit);
Default Value
0
Remarks
The maximum number of bytes to write to the socket, per second.
Data Type
Integer
SocketTimeout Property (SAMLReader Class)
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
Syntax
int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout);
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 (SAMLReader Class)
Enables or disables IP protocol version 6.
Syntax
bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);
Default Value
false
Remarks
Enables or disables IP protocol version 6.
Data Type
Boolean
SubjectConfirmationCount Property (SAMLReader Class)
The number of records in the SubjectConfirmation arrays.
Syntax
int GetSubjectConfirmationCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- SubjectConfirmationDataAddress
- SubjectConfirmationDataInResponseTo
- SubjectConfirmationDataNotBefore
- SubjectConfirmationDataNotOnOrAfter
- SubjectConfirmationDataRecipient
- SubjectConfirmationDataType
- SubjectConfirmationID
- SubjectConfirmationMethod
This property is read-only and not available at design time.
Data Type
Integer
SubjectConfirmationDataAddress Property (SAMLReader Class)
Contains the address enabled for presenting assertions.
Syntax
QString GetSubjectConfirmationDataAddress(int iSubjectConfirmationIndex);
Default Value
""
Remarks
Contains the address enabled for presenting assertions.
Use this property to specify the network address or location from which the subject confirmation should be issued. This optional element can be used to restrict the possibilities of an attacker to steal the assertion and present it from another IP address.
The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.
This property is read-only and not available at design time.
Data Type
String
SubjectConfirmationDataInResponseTo Property (SAMLReader Class)
The ID of the SAML message in response to which the assertion is issued.
Syntax
QString GetSubjectConfirmationDataInResponseTo(int iSubjectConfirmationIndex);
Default Value
""
Remarks
The ID of the SAML message in response to which the assertion is issued.
This property specifies the ID of the SAML message in response to which the assertion is issued.
The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.
This property is read-only and not available at design time.
Data Type
String
SubjectConfirmationDataNotBefore Property (SAMLReader Class)
Time moment before which the subject cannot be confirmed.
Syntax
QString GetSubjectConfirmationDataNotBefore(int iSubjectConfirmationIndex);
Default Value
""
Remarks
Time moment before which the subject cannot be confirmed.
This property specifies the time before which the subject cannot be confirmed.
The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.
This property is read-only and not available at design time.
Data Type
String
SubjectConfirmationDataNotOnOrAfter Property (SAMLReader Class)
Limits the time until which the subject can be confirmed.
Syntax
QString GetSubjectConfirmationDataNotOnOrAfter(int iSubjectConfirmationIndex);
Default Value
""
Remarks
Limits the time until which the subject can be confirmed.
This property specifies the time on (or after) which the subject cannot be confirmed.
The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.
This property is read-only and not available at design time.
Data Type
String
SubjectConfirmationDataRecipient Property (SAMLReader Class)
The URI of the entity or the location of the resource to which the assertion should be presented.
Syntax
QString GetSubjectConfirmationDataRecipient(int iSubjectConfirmationIndex);
Default Value
""
Remarks
The URI of the entity or the location of the resource to which the assertion should be presented.
This property specifies The URI of the entity or the location of the resource to which the assertion should be presented.
The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.
This property is read-only and not available at design time.
Data Type
String
SubjectConfirmationDataType Property (SAMLReader Class)
The type of data contained in the confirmation.
Syntax
QString GetSubjectConfirmationDataType(int iSubjectConfirmationIndex);
Default Value
""
Remarks
The type of data contained in the confirmation.
Use this property to read or specify the type of confirmation data included in the object.
The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.
This property is read-only and not available at design time.
Data Type
String
SubjectConfirmationID Property (SAMLReader Class)
The identifier of the entity which can satisfy the subject confirmation requirements.
Syntax
QString GetSubjectConfirmationID(int iSubjectConfirmationIndex);
Default Value
""
Remarks
The identifier of the entity which can satisfy the subject confirmation requirements.
This property specifies the identifier of the entity which is expected to satisfy the subject confirmation requirements.
The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.
This property is read-only and not available at design time.
Data Type
String
SubjectConfirmationMethod Property (SAMLReader Class)
Specifies the mechanism to be used to confirm the subject.
Syntax
QString GetSubjectConfirmationMethod(int iSubjectConfirmationIndex);
Default Value
""
Remarks
Specifies the mechanism to be used to confirm the subject.
This property contains a URI reference that identifies the mechanism to be used to confirm the subject.
The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.
This property is read-only and not available at design time.
Data Type
String
SubjectID Property (SAMLReader Class)
Returns the subject of the message.
Syntax
QString GetSubjectID();
Default Value
""
Remarks
Check this property to obtain the SAML ID of the message subject.
This property is read-only and not available at design time.
Data Type
String
TLSAutoValidateCertificates Property (SAMLReader Class)
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Syntax
bool GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(bool bTLSAutoValidateCertificates);
Default Value
true
Remarks
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Data Type
Boolean
TLSBaseConfiguration Property (SAMLReader Class)
Selects the base configuration for the TLS settings.
Syntax
int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration);
Possible Values
STPC_DEFAULT(0),
STPC_COMPATIBLE(1),
STPC_COMPREHENSIVE_INSECURE(2),
STPC_HIGHLY_SECURE(3)
Default Value
0
Remarks
Selects the base configuration for the TLS settings. Several profiles are on offer, 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 (SAMLReader Class)
A list of ciphersuites separated with commas or semicolons.
Syntax
QString GetTLSCiphersuites();
int SetTLSCiphersuites(QString qsTLSCiphersuites);
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 that allow to blanketly enable or disable all ciphersuites at once.
Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. 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
TLSECCurves Property (SAMLReader Class)
Defines the elliptic curves to enable.
Syntax
QString GetTLSECCurves();
int SetTLSECCurves(QString qsTLSECCurves);
Default Value
""
Remarks
Defines the elliptic curves to enable.
Data Type
String
TLSExtensions Property (SAMLReader Class)
Provides access to TLS extensions.
Syntax
QString GetTLSExtensions();
int SetTLSExtensions(QString qsTLSExtensions);
Default Value
""
Remarks
Provides access to TLS extensions.
Data Type
String
TLSForceResumeIfDestinationChanges Property (SAMLReader Class)
Whether to force TLS session resumption when the destination address changes.
Syntax
bool GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(bool bTLSForceResumeIfDestinationChanges);
Default Value
false
Remarks
Whether to force TLS session resumption when the destination address changes.
Data Type
Boolean
TLSPreSharedIdentity Property (SAMLReader Class)
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Syntax
QString GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(QString qsTLSPreSharedIdentity);
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 (SAMLReader Class)
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
Syntax
QString GetTLSPreSharedKey();
int SetTLSPreSharedKey(QString qsTLSPreSharedKey);
Default Value
""
Remarks
Contains the pre-shared 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 (SAMLReader Class)
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Syntax
QString GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(QString qsTLSPreSharedKeyCiphersuite);
Default Value
""
Remarks
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Data Type
String
TLSRenegotiationAttackPreventionMode Property (SAMLReader Class)
Selects renegotiation attack prevention mechanism.
Syntax
int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode);
Possible Values
CRAPM_COMPATIBLE(0),
CRAPM_STRICT(1),
CRAPM_AUTO(2)
Default Value
0
Remarks
Selects 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 (SAMLReader Class)
Specifies the kind(s) of revocation check to perform.
Syntax
int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck);
Possible Values
CRC_NONE(0),
CRC_AUTO(1),
CRC_ALL_CRL(2),
CRC_ALL_OCSP(3),
CRC_ALL_CRLAND_OCSP(4),
CRC_ANY_CRL(5),
CRC_ANY_OCSP(6),
CRC_ANY_CRLOR_OCSP(7),
CRC_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) | Check all provided CRL endpoints for all chain certificates. |
crcAllOCSP (3) | Check all provided OCSP endpoints for all chain certificates. |
crcAllCRLAndOCSP (4) | Check all CRL and OCSP endpoints for all chain certificates. |
crcAnyCRL (5) | At least one CRL check for every certificate in the chain must succeed. |
crcAnyOCSP (6) | At least one OCSP check for every certificate in the chain must succeed. |
crcAnyCRLOrOCSP (7) | At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first. |
crcAnyOCSPOrCRL (8) | At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed. 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 faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
This property is not available at design time.
Data Type
Integer
TLSSSLOptions Property (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.
Syntax
int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions);
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 use of client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
cssloAutoAddServerNameExtension | 0x010 | Automatically add server name extension when known |
cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (not send) 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 handshake message as large batches rather than individually |
Data Type
Integer
TLSTLSMode Property (SAMLReader Class)
Specifies the TLS mode to use.
Syntax
int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode);
Possible Values
SM_DEFAULT(0),
SM_NO_TLS(1),
SM_EXPLICIT_TLS(2),
SM_IMPLICIT_TLS(3),
SM_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, allow plain data. |
Data Type
Integer
TLSUseExtendedMasterSecret Property (SAMLReader Class)
Enables Extended Master Secret Extension, as defined in RFC 7627.
Syntax
bool GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(bool bTLSUseExtendedMasterSecret);
Default Value
false
Remarks
Enables Extended Master Secret Extension, as defined in RFC 7627.
Data Type
Boolean
TLSUseSessionResumption Property (SAMLReader Class)
Enables or disables TLS session resumption capability.
Syntax
bool GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(bool bTLSUseSessionResumption);
Default Value
false
Remarks
Enables or disables TLS session resumption capability.
Data Type
Boolean
TLSVersions Property (SAMLReader Class)
Th SSL/TLS versions to enable by default.
Syntax
int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);
Default Value
16
Remarks
Th 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
TrustedCertCount Property (SAMLReader Class)
The number of records in the TrustedCert arrays.
Syntax
int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at TrustedCertCount - 1.This property is not available at design time.
Data Type
Integer
TrustedCertBytes Property (SAMLReader Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetTrustedCertBytes(int iTrustedCertIndex);
Remarks
Returns raw certificate data in DER format.
The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
TrustedCertHandle Property (SAMLReader Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetTrustedCertHandle(int iTrustedCertIndex);
int SetTrustedCertHandle(int iTrustedCertIndex, qint64 lTrustedCertHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.
This property is not available at design time.
Data Type
Long64
UseBinding Property (SAMLReader Class)
Enables or disables automated binding processing.
Syntax
bool GetUseBinding();
int SetUseBinding(bool bUseBinding);
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 POSTBinding and RedirectBinding to access the properties of specific binding types.
This property is not available at design time.
Data Type
Boolean
ValidateSignatures Property (SAMLReader Class)
Enables or disables automated signature validation.
Syntax
bool GetValidateSignatures();
int SetValidateSignatures(bool bValidateSignatures);
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
ValidationLog Property (SAMLReader Class)
Contains the complete log of the certificate validation routine.
Syntax
QString GetValidationLog();
Default Value
""
Remarks
Use this property to access the chain validation log produced by the class. The log can be very useful when investigating issues with chain validation, as it contains a step-by-step trace of the entire validation procedure.
This property is read-only and not available at design time.
Data Type
String
ValidationMoment Property (SAMLReader Class)
The time point at which chain validity is to be established.
Syntax
QString GetValidationMoment();
int SetValidationMoment(QString qsValidationMoment);
Default Value
""
Remarks
Use this property to specify the moment in time at which chain validity should be established. The time is in UTC. Leave the setting empty to stick to the current moment.
The validity of the same chain may differ depending on the time point chosen due to temporal changes in subchain validities and revocation statuses.
Data Type
String
Version Property (SAMLReader Class)
Returns SAML content version string.
Syntax
QString GetVersion();
Default Value
""
Remarks
Check this property to read the SAML content version string, such as "2.0".
This property is read-only and not available at design time.
Data Type
String
CompareIDs Method (SAMLReader Class)
Compares two SAML IDs.
Syntax
bool CompareIDs(const QString& qsID1, const QString& qsID2);
Remarks
Use this utility function to easily compare two SAML IDs.
Error Handling
This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Config Method (SAMLReader Class)
Sets or retrieves a configuration setting.
Syntax
QString Config(const QString& qsConfigurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
DoAction Method (SAMLReader Class)
Performs an additional action.
Syntax
QString DoAction(const QString& qsActionID, const QString& qsActionParams);
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 of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetIDProp Method (SAMLReader Class)
Extracts a specific property from a SAML ID.
Syntax
QString GetIDProp(const QString& qsID, const QString& qsPropName);
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
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Open Method (SAMLReader Class)
Opens a SAML entity.
Syntax
int Open(const QString& qsInput);
Remarks
Use this method to process a SAML entity contained in a string.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
OpenBytes Method (SAMLReader Class)
Opens a SAML entity.
Syntax
int OpenBytes(QByteArray qbaInputBytes);
Remarks
Use this method to process a SAML entity stored as a byte array.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
OpenFile Method (SAMLReader Class)
Opens a SAML entity.
Syntax
int OpenFile(const QString& qsInputFile);
Remarks
Use this method to process a SAML entity contained in a file.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
PinAdviceAssertion Method (SAMLReader Class)
Pins advice assertion by propagating it in PinnedAssertionXXX properties.
Syntax
int PinAdviceAssertion(int iAssertionIndex, int iAdviceAssertionIndex);
Remarks
Call this method to pin the advice assertion specified by AssertionIndex by publishing it in the selection of PinnedAssertionXXX properties, such as PinnedAssertionInfo. Use AdviceAssertionIndex to specify the advice assertion index.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
PinAssertion Method (SAMLReader Class)
Pins assertion by propagating it in PinnedAssertionXXX properties.
Syntax
int PinAssertion(int iAssertionIndex);
Remarks
Use this method to pin a SAML assertion specified by its AssertionIndex in the selection of PinnedAssertionXXX properties, such as PinnedAssertionInfo.
Check AssertionCount to obtain the number of assertions in the message.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Error Event (SAMLReader Class)
Fires to report an error condition.
Syntax
class SAMLReaderErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(SAMLReaderErrorEventParams *e);
// Or, subclass SAMLReader and override this emitter function. virtual int FireError(SAMLReaderErrorEventParams *e) {...}
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 (SAMLReader Class)
This event notifies the application about an underlying control flow event.
Syntax
class SAMLReaderNotificationEventParams { public: const QString &EventID(); const QString &EventParam(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Notification(SAMLReaderNotificationEventParams *e);
// Or, subclass SAMLReader and override this emitter function. virtual int FireNotification(SAMLReaderNotificationEventParams *e) {...}
Remarks
The class fires this event to let the application know about some event, occurrence, or milestone in the component. 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 EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
SignatureFound Event (SAMLReader Class)
Signifies the start of signature validation.
Syntax
class SAMLReaderSignatureFoundEventParams { public: const QString &IssuerRDN(); const QByteArray &SerialNumber(); const QByteArray &SubjectKeyID(); bool CertFound(); bool ValidateSignature(); void SetValidateSignature(bool bValidateSignature); bool ValidateChain(); void SetValidateChain(bool bValidateChain); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SignatureFound(SAMLReaderSignatureFoundEventParams *e);
// Or, subclass SAMLReader and override this emitter function. virtual int FireSignatureFound(SAMLReaderSignatureFoundEventParams *e) {...}
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 document or message.
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. Separate validation results are reported for each, with SignatureValidationResult and ChainValidationResult properties respectively.
Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.
SignatureValidated Event (SAMLReader Class)
Reports the signature validation result.
Syntax
class SAMLReaderSignatureValidatedEventParams { public: const QString &IssuerRDN(); const QByteArray &SerialNumber(); const QByteArray &SubjectKeyID(); int ValidationResult(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SignatureValidated(SAMLReaderSignatureValidatedEventParams *e);
// Or, subclass SAMLReader and override this emitter function. virtual int FireSignatureValidated(SAMLReaderSignatureValidatedEventParams *e) {...}
Remarks
This event is fired when the complete XML signature validation process is finished. 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:
xsvValid | 0 | |
xsvUnknown | 1 | |
xsvCorrupted | 2 | |
xsvSignerNotFound | 3 | |
xsvFailure | 4 | |
xsvReferenceCorrupted | 5 |
Configuration Settings (SAMLReader Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.SAMLReader Configuration Settings | ||||||||||||||||||||||||||||||
IgnoreSystemTrust:
Whether trusted Windows Certificate Stores should be treated as trusted.Specifies whether, during chain validation, the component should respect
the trust to CA certificates as configured in the operating system.
In Windows this effectively defines whether the component should trust the
certificates residing in the Trusted Root Certification Authorities store.
If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as TrustedCertificates property) are considered trusted. |
||||||||||||||||||||||||||||||
TolerateMinorChainIssues: Whether to tolerate minor chain issues.TBD | ||||||||||||||||||||||||||||||
UseMicrosoftCTL: Enables or disables automatic use of Microsoft online certificate trust list.Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository. | ||||||||||||||||||||||||||||||
UseSystemCertificates: Enables or disables the use of the system certificates.Use this property to tell chain validation module automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework. | ||||||||||||||||||||||||||||||
Base Configuration Settings | ||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||
Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).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. | ||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||
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". | ||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||
LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||
Tag: Allows to store any custom data.Use this config property to store any custom data. | ||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||
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. |