Docs

SecureBlackbox 2022 Qt Edition

Version 22.0 [Build 8214]

SAMLWriter Class

Properties   Methods   Events   Configuration Settings   Errors  

The SAMLWriter class offers SAML message generation functions.

Syntax

SAMLWriter

Remarks

SAMLWriter provides means of serialization of SAML entities into valid SAML protocol messages. Together with SAMLReader, this class provides fine-grained access to the composition of SAML messages.

SAMLReader and SAMLWriter are independent of SAML server controls included in SecureBlackbox, and target scenarios which struggle to use the servers controls because of them being too high level.

Property List


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

AddXMLHeaderControls the inclusion of an XML header in the message.
ArtifactEndpointIndexAn accessor to the EndpointIndex entry of the artifact.
ArtifactMessageHandleAn accessor to the MessageHandle property of the artifact.
ArtifactRemainingArtifactReturns the contents of the artifact.
ArtifactSourceIDAn accessor to the SourceID property of the artifact.
ArtifactTypeCodeThe TypeCode property of the artifact.
ArtifactURIAn accessor to the URI property of the artifact.
ArtifactResolveQueryContains the artifact resolve query.
AssertionAttrCountThe number of records in the AssertionAttr arrays.
AssertionAttrFriendlyNameSpecifies the friendly name of the attribute Use this property to access or set the friendly name of a SAML attribute (e.
AssertionAttrNameSpecifies the name of the attribute.
AssertionAttrNameFormatIndicates the format used to reference the attribute.
AssertionAttrStatementIndexContains the index of the statement the attribute corresponds to.
AssertionAttrValuesContains a list of attribute values.
AssertionConditionCountThe number of records in the AssertionCondition arrays.
AssertionConditionAudienceListAn accessor to the Audience list parameter of an audience restriction condition.
AssertionConditionConditionTypeSpecifies a type of the condition object.
AssertionConditionProxyRestrictionCountAn accessor to the proxy restriction count element of the condition.
AssertionCountReturns the number of assertions in the message.
AssertionIDRequestReferencesContains the References entry of the SAML assertion ID request.
AssertionInfoAdviceAssertionCountContains the number of advice assertions.
AssertionInfoAssertionTypeSpecifies the type of the assertion.
AssertionInfoChainValidationDetailsThe details of a certificate chain validation outcome.
AssertionInfoChainValidationResultThe outcome of a certificate chain validation routine.
AssertionInfoConditionsNotBeforeRepresents the Conditions.
AssertionInfoConditionsNotOnOrAfterRepresents the Conditions.
AssertionInfoEncryptedContentRepresents the encrypted assertion content.
AssertionInfoIDRepresents the ID of the assertion.
AssertionInfoIDRefRepresents an ID reference value.
AssertionInfoIssueInstantContains the assertion issuance time stamp.
AssertionInfoSignatureValidationResultThe outcome of the cryptographic signature validation.
AssertionInfoSignedSpecifies whether the assertion is signed.
AssertionInfoURIRefRepresents an URI reference value.
AssertionInfoValidationLogContains the signing certificate's chain validation log.
AssertionInfoVersionSpecifies the SAML protocol version used.
AssertionIssuerSpecifies the assertion issuer.
AssertionStatementCountThe number of records in the AssertionStatement arrays.
AssertionStatementAttributesContains a list of statement attribute names.
AssertionStatementAuthnContextAuthenticatingAuthoritiesContains the list of authenticating authorities.
AssertionStatementAuthnContextChoiceSpecifies the authentication context choice variant.
AssertionStatementAuthnContextClassRefIndicates the authentication contexts class reference.
AssertionStatementAuthnContextDeclSpecifies the authentication contexts declaration.
AssertionStatementAuthnContextDeclRefSpecifies the authentication contexts declaration reference.
AssertionStatementAuthnInstantSpecifies the authentication event timestamp.
AssertionStatementAuthnSessionIndexContains the authentication session index.
AssertionStatementAuthnSessionNotOnOrAfterMaps to the SessionNotOnOrAfter parameter of the authentication statement.
AssertionStatementAuthnSubjectLocalityAddressSpecifies the authentication subjects address.
AssertionStatementAuthnSubjectLocalityDNSNameMaps to the authentication subjects DNS name parameter.
AssertionStatementAuthzActionsProvides access to the list of actions of the authorization statement.
AssertionStatementAuthzDecisionSpecifies the authorization decision.
AssertionStatementAuthzDecisionEvidenceManages the authorization decision statement evidence parameter.
AssertionStatementAuthzDecisionResourceSpecifies the authorization decision statement resource parameter.
AssertionStatementStatementTypeSpecifies the assertion statement type.
AssertionSubjectConfirmationCountThe number of records in the AssertionSubjectConfirmation arrays.
AssertionSubjectConfirmationDataAddressContains the address enabled for presenting assertions.
AssertionSubjectConfirmationDataInResponseToThe ID of the SAML message in response to which the assertion is issued.
AssertionSubjectConfirmationDataNotBeforeTime moment before which the subject cannot be confirmed.
AssertionSubjectConfirmationDataNotOnOrAfterLimits the time until which the subject can be confirmed.
AssertionSubjectConfirmationDataRecipientThe URI of the entity or the location of the resource to which the assertion should be presented.
AssertionSubjectConfirmationDataTypeThe type of data contained in the confirmation.
AssertionSubjectConfirmationIDThe identifier of the entity which can satisfy the subject confirmation requirements.
AssertionSubjectConfirmationMethodSpecifies the mechanism to be used to confirm the subject.
AssertionSubjectIDSpecifies the assertion subject ID.
AttrQueryAttrCountThe number of records in the AttrQueryAttr arrays.
AttrQueryAttrFriendlyNameSpecifies the friendly name of the attribute Use this property to access or set the friendly name of a SAML attribute (e.
AttrQueryAttrNameSpecifies the name of the attribute.
AttrQueryAttrNameFormatIndicates the format used to reference the attribute.
AttrQueryAttrStatementIndexContains the index of the statement the attribute corresponds to.
AttrQueryAttrValuesContains a list of attribute values.
AuthnQueryComparisonSpecifies the authentication context comparison method.
AuthnQueryContextClassRefsSpecifies the context class reference.
AuthnQueryRefTypeSpecifies the context reference type.
AuthnQuerySessionIndexSpecifies the index of the session to the authentication entity.
AuthnRequestAssertionConsumerServiceIndexSpecifies the assertion consumer service index.
AuthnRequestAssertionConsumerServiceURLSpecifies the assertion consumer service URL.
AuthnRequestAttributeConsumingServiceIndexSpecifies the attribute consuming service index.
AuthnRequestConditionsNotBeforeSpecifies the NotBefore condition of the request.
AuthnRequestConditionsNotOnOrAfterProvides access to the NotOnOrAfter condition of the request.
AuthnRequestContextClassRefsProvides access to the authentication context class references.
AuthnRequestContextComparisonSpecifies the AuthnContext comparison method.
AuthnRequestContextRefTypeSpecifies the context reference type.
AuthnRequestForceAuthnCorresponds to the ForceAuthn parameter of the request.
AuthnRequestIsPassiveMaps to the IsPassive parameter of the request.
AuthnRequestNameIDPolicyAllowCreateMatches the AllowCreate attribute of NameIDPolicy element of the request.
AuthnRequestNameIDPolicyFormatMatches to the Format attribute of the NameIDPolicy element of the request.
AuthnRequestNameIDPolicySPNameQualifierMatches to the SP name qualifier attribute of the request.
AuthnRequestNameIDPolicyUseAllowCreateControls inclusion of AllowCreate attribute in the request.
AuthnRequestProtocolBindingSpecifies the protocol binding to be requested in the authentication request.
AuthnRequestProviderNameSpecifies the name of the requestor.
AuthnRequestScopingIDPListGetCompleteMatches the GetComplete element of the IDPList entry of the Scoping object.
AuthnRequestScopingProxyCountThe maximum number of proxies on the way between the requestor and the provider.
AuthnRequestScopingRequesterIDsA collection of requestor IDs on whose behalf the request is being sent.
AuthnRequestUseForceAuthnControls inclusion of ForceAuthn attribute in the request.
AuthnRequestUseIsPassiveControls inclusion of IsPassive attribute in the request.
AuthnRequestConditionCountThe number of records in the AuthnRequestCondition arrays.
AuthnRequestConditionAudienceListAn accessor to the Audience list parameter of an audience restriction condition.
AuthnRequestConditionConditionTypeSpecifies a type of the condition object.
AuthnRequestConditionProxyRestrictionCountAn accessor to the proxy restriction count element of the condition.
AuthnRequestScopingIDPCountThe number of records in the AuthnRequestScopingIDP arrays.
AuthnRequestScopingIDPLocContains the value of the Loc attribute.
AuthnRequestScopingIDPNameContains the name of the IdP provider.
AuthnRequestScopingIDPProviderIDContains the provider ID.
AuthzDecisionQueryActionsSpecifies the list of actions included in the query.
AuthzDecisionQueryResourceMatches the Resource element of the query.
BindingSpecifies the type of the binding to use.
ConsentContains the Consent parameter of the request.
DestinationContains the Destination parameter of the SAML object.
EncryptionCertBytesReturns raw certificate data in DER format.
EncryptionCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
FIPSModeReserved.
IDThe ID of the request.
InResponseToContains the InResponseTo property of the SAML request.
IssueInstantContains request issuance timestamp.
IssuerSets the issuer of the message.
LogoutRequestNameIDContains the value of the NameID parameter.
LogoutRequestNotOnOrAfterContains the value of the NotOnOrAfter parameter.
LogoutRequestReasonContains the value of the Reason parameter.
LogoutRequestSessionIndexesContains the list of session indices.
ManageNameIDRequestNameIDContains the value of the NameID parameter of the request.
ManageNameIDRequestNewEncryptedIDContains the value of the NewEncryptedID parameter of the request.
ManageNameIDRequestNewIDContains the value of the NewID parameter.
ManageNameIDRequestTerminateContains the value of the Terminate parameter of the request.
NameIDMappingRequestNameIDAn accessor to the NameID parameter of the request.
NameIDMappingRequestNameIDPolicyAllowCreateContains the value of AllowCreate parameter of the NameIDPolicy object.
NameIDMappingRequestNameIDPolicyFormatSpecifies the format of the NameIDPolicy element.
NameIDMappingRequestNameIDPolicySPNameQualifierContains the SPNameQualifier parameter of the NameIDPolicy element.
NameIDMappingRequestNameIDPolicyUseAllowCreateControls inclusion of UseAllow modifier in the NameIDPolicy object.
OutputTypeReturns the SAML type of message being created.
POSTBindingBodyContains the form body.
POSTBindingFormTemplateContains the XHTML form template returned by the service provider.
POSTBindingModeSpecifies whether binding is applied on a server, or on a client side.
POSTBindingRelayStateContains the value of the RelayState parameter of POST binding mechanism.
POSTBindingURLContains the URL of POST binding mechanism.
ProfileSpecifies a pre-defined profile to apply when creating the signature.
RedirectBindingEncodingSpecifies the message encoding.
RedirectBindingForceSignEnforces a signature over all outgoing messages.
RedirectBindingRelayStateContains the RelayState parameter of the binding.
RedirectBindingSignSpecifies whether to sign generated messages.
RedirectBindingSignatureAlgorithmContains the signature algorithm.
RedirectBindingURLContains the URL of the request query.
RedirectBindingVerifySignaturesInstructs the class whether to verify incoming signatures.
RedirectBindingCertBytesReturns raw certificate data in DER format.
RedirectBindingCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
ResponseNameIDContains the NameID parameter of a NameIDMapping response.
ResponseOptionalElementAn optional message element to be returned with the response.
ResponseResponseTypeContains the type of the response.
ResponseStatusCodeSubValueThe value of the nested StatusCode.
ResponseStatusCodeValueContains the status code value.
ResponseStatusDetailContains additional information on the status of the request.
ResponseStatusMessageContains a status message (optional).
SigCanonicalizationMethodThe canonicalization method to use in the signature.
SigDigestMethodThe digest method to use.
SigMethodThe signature method to use.
SignSpecifies whether the created SAML message should be signed.
SigningCertBytesReturns raw certificate data in DER format.
SigningCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
SigningChainCountThe number of records in the SigningChain arrays.
SigningChainBytesReturns raw certificate data in DER format.
SigningChainHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
SubjectConfirmationCountThe number of records in the SubjectConfirmation arrays.
SubjectConfirmationDataAddressContains the address enabled for presenting assertions.
SubjectConfirmationDataInResponseToThe ID of the SAML message in response to which the assertion is issued.
SubjectConfirmationDataNotBeforeTime moment before which the subject cannot be confirmed.
SubjectConfirmationDataNotOnOrAfterLimits the time until which the subject can be confirmed.
SubjectConfirmationDataRecipientThe URI of the entity or the location of the resource to which the assertion should be presented.
SubjectConfirmationDataTypeThe type of data contained in the confirmation.
SubjectConfirmationIDThe identifier of the entity which can satisfy the subject confirmation requirements.
SubjectConfirmationMethodSpecifies the mechanism to be used to confirm the subject.
SubjectIDSets the subject of the message.
VersionSpecifies the protocol version of the SAML message.

Method List


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

AddAdviceAssertionAdds an advice assertion to the message.
AddAssertionAdds assertion to a SAML message.
ClearAssertionResets the contents of all assertion-related properties.
CompareIDsCompares two SAML IDs.
ConfigSets or retrieves a configuration setting.
CreateNewCreates a new SAML message with the given type.
DoActionPerforms an additional action.
GetIDPropReturns an element of the SAML ID.
RemoveAdviceRemoves an advice from an assertion.
RemoveAdviceAssertionRemoves an advice from an assertion.
RemoveAllAssertionsRemoves all assertions currently configured in the message.
RemoveAssertionRemoves an assertion from the message.
SaveSaves the configured message to a string.
SaveBytesSaves the configured message to a byte array.
SaveFileSaves the configured message to a file.

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.

ErrorFires to report an error condition.
NotificationThis event notifies the application about an underlying control flow event.

Configuration Settings


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

IgnoreSystemTrustWhether trusted Windows Certificate Stores should be treated as trusted.
SigAfterIssuerSpecifies whether to insert the signature after the issuer tag in the SAML document.
TolerateMinorChainIssuesWhether to tolerate minor chain issues.
UseMicrosoftCTLEnables or disables automatic use of Microsoft online certificate trust list.
UseSystemCertificatesEnables or disables the use of the system certificates.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
TagAllows to store any custom data.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

AddXMLHeader Property (SAMLWriter Class)

Controls the inclusion of an XML header in the message.

Syntax

bool GetAddXMLHeader();
int SetAddXMLHeader(bool bAddXMLHeader);

Default Value

false

Remarks

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

This property is not available at design time.

Data Type

Boolean

ArtifactEndpointIndex Property (SAMLWriter Class)

An accessor to the EndpointIndex entry of the artifact.

Syntax

int GetArtifactEndpointIndex();
int SetArtifactEndpointIndex(int iArtifactEndpointIndex);

Default Value

0

Remarks

An accessor to the EndpointIndex entry of the artifact.

The EndpointIndex references a specific artifact resolution endpoint (IdP or SP) managed by the artifact issuer.

This property is not available at design time.

Data Type

Integer

ArtifactMessageHandle Property (SAMLWriter Class)

An accessor to the MessageHandle property of the artifact.

Syntax

QByteArray GetArtifactMessageHandle();
int SetArtifactMessageHandle(QByteArray qbaArtifactMessageHandle);

Remarks

An accessor to the MessageHandle property of the artifact.

A message handle is a unique reference to a SAML message that can be produced by the artifact issuer upon request.

This property is not available at design time.

Data Type

Byte Array

ArtifactRemainingArtifact Property (SAMLWriter 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 (SAMLWriter Class)

An accessor to the SourceID property of the artifact.

Syntax

QByteArray GetArtifactSourceID();
int SetArtifactSourceID(QByteArray qbaArtifactSourceID);

Remarks

An accessor to the SourceID property of the artifact.

SourceID uniquely identifies the issuer of the artifact.

This property is not available at design time.

Data Type

Byte Array

ArtifactTypeCode Property (SAMLWriter Class)

The TypeCode property of the artifact.

Syntax

int GetArtifactTypeCode();
int SetArtifactTypeCode(int iArtifactTypeCode);

Default Value

0

Remarks

The TypeCode field of the artifact.

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

This property is not available at design time.

Data Type

Integer

ArtifactURI Property (SAMLWriter Class)

An accessor to the URI property of the artifact.

Syntax

QString GetArtifactURI();
int SetArtifactURI(QString qsArtifactURI);

Default Value

""

Remarks

An accessor to the URI property of the artifact.

The URI property contains the origin of the artifact.

This property is not available at design time.

Data Type

String

ArtifactResolveQuery Property (SAMLWriter Class)

Contains the artifact resolve query.

Syntax

QString GetArtifactResolveQuery();
int SetArtifactResolveQuery(QString qsArtifactResolveQuery);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

AssertionAttrCount Property (SAMLWriter Class)

The number of records in the AssertionAttr arrays.

Syntax

int GetAssertionAttrCount();
int SetAssertionAttrCount(int iAssertionAttrCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

AssertionAttrFriendlyName Property (SAMLWriter 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 GetAssertionAttrFriendlyName(int iAssertionAttrIndex);
int SetAssertionAttrFriendlyName(int iAssertionAttrIndex, QString qsAssertionAttrFriendlyName);

Default Value

""

Remarks

Specifies the friendly name of the attribute

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

The AssertionAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionAttrCount property.

This property is not available at design time.

Data Type

String

AssertionAttrName Property (SAMLWriter Class)

Specifies the name of the attribute.

Syntax

QString GetAssertionAttrName(int iAssertionAttrIndex);
int SetAssertionAttrName(int iAssertionAttrIndex, QString qsAssertionAttrName);

Default Value

""

Remarks

Specifies the name of the attribute.

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

The AssertionAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionAttrCount property.

This property is not available at design time.

Data Type

String

AssertionAttrNameFormat Property (SAMLWriter Class)

Indicates the format used to reference the attribute.

Syntax

QString GetAssertionAttrNameFormat(int iAssertionAttrIndex);
int SetAssertionAttrNameFormat(int iAssertionAttrIndex, QString qsAssertionAttrNameFormat);

Default Value

""

Remarks

Indicates the format used to reference the attribute.

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

The AssertionAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionAttrCount property.

This property is not available at design time.

Data Type

String

AssertionAttrStatementIndex Property (SAMLWriter Class)

Contains the index of the statement the attribute corresponds to.

Syntax

int GetAssertionAttrStatementIndex(int iAssertionAttrIndex);
int SetAssertionAttrStatementIndex(int iAssertionAttrIndex, int iAssertionAttrStatementIndex);

Default Value

-1

Remarks

Contains the index of the statement the attribute corresponds to.

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

The AssertionAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionAttrCount property.

This property is not available at design time.

Data Type

Integer

AssertionAttrValues Property (SAMLWriter Class)

Contains a list of attribute values.

Syntax

QString GetAssertionAttrValues(int iAssertionAttrIndex);
int SetAssertionAttrValues(int iAssertionAttrIndex, QString qsAssertionAttrValues);

Default Value

""

Remarks

Contains a list of attribute values.

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

The AssertionAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionAttrCount property.

This property is not available at design time.

Data Type

String

AssertionConditionCount Property (SAMLWriter Class)

The number of records in the AssertionCondition arrays.

Syntax

int GetAssertionConditionCount();
int SetAssertionConditionCount(int iAssertionConditionCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

AssertionConditionAudienceList Property (SAMLWriter Class)

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

Syntax

QString GetAssertionConditionAudienceList(int iAssertionConditionIndex);
int SetAssertionConditionAudienceList(int iAssertionConditionIndex, QString qsAssertionConditionAudienceList);

Default Value

""

Remarks

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

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

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

This property is not available at design time.

Data Type

String

AssertionConditionConditionType Property (SAMLWriter Class)

Specifies a type of the condition object.

Syntax

int GetAssertionConditionConditionType(int iAssertionConditionIndex);
int SetAssertionConditionConditionType(int iAssertionConditionIndex, int iAssertionConditionConditionType);

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

This property is not available at design time.

Data Type

Integer

AssertionConditionProxyRestrictionCount Property (SAMLWriter Class)

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

Syntax

int GetAssertionConditionProxyRestrictionCount(int iAssertionConditionIndex);
int SetAssertionConditionProxyRestrictionCount(int iAssertionConditionIndex, int iAssertionConditionProxyRestrictionCount);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Integer

AssertionCount Property (SAMLWriter Class)

Returns the number of assertions in the message.

Syntax

int GetAssertionCount();

Default Value

0

Remarks

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

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

Data Type

Integer

AssertionIDRequestReferences Property (SAMLWriter Class)

Contains the References entry of the SAML assertion ID request.

Syntax

QString GetAssertionIDRequestReferences();
int SetAssertionIDRequestReferences(QString qsAssertionIDRequestReferences);

Default Value

""

Remarks

Contains the References entry of the SAML assertion ID request.

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

This property is not available at design time.

Data Type

String

AssertionInfoAdviceAssertionCount Property (SAMLWriter Class)

Contains the number of advice assertions.

Syntax

int GetAssertionInfoAdviceAssertionCount();
int SetAssertionInfoAdviceAssertionCount(int iAssertionInfoAdviceAssertionCount);

Default Value

0

Remarks

Contains the number of advice assertions.

Use this property to access the number of advice assertions.

This property is not available at design time.

Data Type

Integer

AssertionInfoAssertionType Property (SAMLWriter Class)

Specifies the type of the assertion.

Syntax

int GetAssertionInfoAssertionType();
int SetAssertionInfoAssertionType(int iAssertionInfoAssertionType);

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

Data Type

Integer

AssertionInfoChainValidationDetails Property (SAMLWriter Class)

The details of a certificate chain validation outcome.

Syntax

int GetAssertionInfoChainValidationDetails();

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:

cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

cvrUnknownCA0x0020A CA certificate for one or more certificates has not been found (chain incomplete)

cvrCAUnauthorized0x0040One of the CA certificates are not authorized to act as CA

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

cvrIdentityMismatch0x0200The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate

cvrNoKeyUsage0x0400A mandatory key usage is not enabled in one of the chain certificates

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

cvrWeakAlgorithm0x4000A weak algorithm is used in one of certificates or revocation elements

cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

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

Data Type

Integer

AssertionInfoChainValidationResult Property (SAMLWriter Class)

The outcome of a certificate chain validation routine.

Syntax

int GetAssertionInfoChainValidationResult();

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:

cvtValid0The chain is valid

cvtValidButUntrusted1The chain is valid, but the root certificate is not trusted

cvtInvalid2The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)

cvtCantBeEstablished3The 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

AssertionInfoConditionsNotBefore Property (SAMLWriter Class)

Represents the Conditions.

Syntax

QString GetAssertionInfoConditionsNotBefore();
int SetAssertionInfoConditionsNotBefore(QString qsAssertionInfoConditionsNotBefore);

Default Value

""

Remarks

Represents the Conditions.NotBefore assertion property.

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

This property is not available at design time.

Data Type

String

AssertionInfoConditionsNotOnOrAfter Property (SAMLWriter Class)

Represents the Conditions.

Syntax

QString GetAssertionInfoConditionsNotOnOrAfter();
int SetAssertionInfoConditionsNotOnOrAfter(QString qsAssertionInfoConditionsNotOnOrAfter);

Default Value

""

Remarks

Represents the Conditions.NotOnOrAfter assertion property.

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

This property is not available at design time.

Data Type

String

AssertionInfoEncryptedContent Property (SAMLWriter Class)

Represents the encrypted assertion content.

Syntax

QString GetAssertionInfoEncryptedContent();
int SetAssertionInfoEncryptedContent(QString qsAssertionInfoEncryptedContent);

Default Value

""

Remarks

Represents the encrypted assertion content.

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

This property is not available at design time.

Data Type

String

AssertionInfoID Property (SAMLWriter Class)

Represents the ID of the assertion.

Syntax

QString GetAssertionInfoID();
int SetAssertionInfoID(QString qsAssertionInfoID);

Default Value

""

Remarks

Represents the ID of the assertion.

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

This property is not available at design time.

Data Type

String

AssertionInfoIDRef Property (SAMLWriter Class)

Represents an ID reference value.

Syntax

QString GetAssertionInfoIDRef();
int SetAssertionInfoIDRef(QString qsAssertionInfoIDRef);

Default Value

""

Remarks

Represents an ID reference value.

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

This property is not available at design time.

Data Type

String

AssertionInfoIssueInstant Property (SAMLWriter Class)

Contains the assertion issuance time stamp.

Syntax

QString GetAssertionInfoIssueInstant();
int SetAssertionInfoIssueInstant(QString qsAssertionInfoIssueInstant);

Default Value

""

Remarks

Contains the assertion issuance time stamp.

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

This property is not available at design time.

Data Type

String

AssertionInfoSignatureValidationResult Property (SAMLWriter Class)

The outcome of the cryptographic signature validation.

Syntax

int GetAssertionInfoSignatureValidationResult();

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:

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

svtSignerNotFound3Failed to acquire the signing certificate. The signature cannot be validated.

svtFailure4General failure

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

Data Type

Integer

AssertionInfoSigned Property (SAMLWriter Class)

Specifies whether the assertion is signed.

Syntax

bool GetAssertionInfoSigned();
int SetAssertionInfoSigned(bool bAssertionInfoSigned);

Default Value

false

Remarks

Specifies whether the assertion is signed.

Use this property to establish whether the assertion is signed.

This property is not available at design time.

Data Type

Boolean

AssertionInfoURIRef Property (SAMLWriter Class)

Represents an URI reference value.

Syntax

QString GetAssertionInfoURIRef();
int SetAssertionInfoURIRef(QString qsAssertionInfoURIRef);

Default Value

""

Remarks

Represents an URI reference value.

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

This property is not available at design time.

Data Type

String

AssertionInfoValidationLog Property (SAMLWriter Class)

Contains the signing certificate's chain validation log.

Syntax

QString GetAssertionInfoValidationLog();

Default Value

""

Remarks

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

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

Data Type

String

AssertionInfoVersion Property (SAMLWriter Class)

Specifies the SAML protocol version used.

Syntax

QString GetAssertionInfoVersion();
int SetAssertionInfoVersion(QString qsAssertionInfoVersion);

Default Value

""

Remarks

Specifies the SAML protocol version used.

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

This property is not available at design time.

Data Type

String

AssertionIssuer Property (SAMLWriter Class)

Specifies the assertion issuer.

Syntax

QString GetAssertionIssuer();
int SetAssertionIssuer(QString qsAssertionIssuer);

Default Value

""

Remarks

Use this property to provide the assertion issuer ID.

This property is not available at design time.

Data Type

String

AssertionStatementCount Property (SAMLWriter Class)

The number of records in the AssertionStatement arrays.

Syntax

int GetAssertionStatementCount();
int SetAssertionStatementCount(int iAssertionStatementCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

AssertionStatementAttributes Property (SAMLWriter Class)

Contains a list of statement attribute names.

Syntax

QString GetAssertionStatementAttributes(int iAssertionStatementIndex);
int SetAssertionStatementAttributes(int iAssertionStatementIndex, QString qsAssertionStatementAttributes);

Default Value

""

Remarks

Contains a list of statement attribute names.

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

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

This property is not available at design time.

Data Type

String

AssertionStatementAuthnContextAuthenticatingAuthorities Property (SAMLWriter Class)

Contains the list of authenticating authorities.

Syntax

QString GetAssertionStatementAuthnContextAuthenticatingAuthorities(int iAssertionStatementIndex);
int SetAssertionStatementAuthnContextAuthenticatingAuthorities(int iAssertionStatementIndex, QString qsAssertionStatementAuthnContextAuthenticatingAuthorities);

Default Value

""

Remarks

Contains the list of authenticating authorities.

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

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

This property is not available at design time.

Data Type

String

AssertionStatementAuthnContextChoice Property (SAMLWriter Class)

Specifies the authentication context choice variant.

Syntax

QString GetAssertionStatementAuthnContextChoice(int iAssertionStatementIndex);
int SetAssertionStatementAuthnContextChoice(int iAssertionStatementIndex, QString qsAssertionStatementAuthnContextChoice);

Default Value

""

Remarks

Specifies the authentication context choice variant.

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

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

This property is not available at design time.

Data Type

String

AssertionStatementAuthnContextClassRef Property (SAMLWriter Class)

Indicates the authentication contexts class reference.

Syntax

QString GetAssertionStatementAuthnContextClassRef(int iAssertionStatementIndex);
int SetAssertionStatementAuthnContextClassRef(int iAssertionStatementIndex, QString qsAssertionStatementAuthnContextClassRef);

Default Value

""

Remarks

Indicates the authentication contexts class reference.

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

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

This property is not available at design time.

Data Type

String

AssertionStatementAuthnContextDecl Property (SAMLWriter Class)

Specifies the authentication contexts declaration.

Syntax

QString GetAssertionStatementAuthnContextDecl(int iAssertionStatementIndex);
int SetAssertionStatementAuthnContextDecl(int iAssertionStatementIndex, QString qsAssertionStatementAuthnContextDecl);

Default Value

""

Remarks

Specifies the authentication contexts declaration.

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

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

This property is not available at design time.

Data Type

String

AssertionStatementAuthnContextDeclRef Property (SAMLWriter Class)

Specifies the authentication contexts declaration reference.

Syntax

QString GetAssertionStatementAuthnContextDeclRef(int iAssertionStatementIndex);
int SetAssertionStatementAuthnContextDeclRef(int iAssertionStatementIndex, QString qsAssertionStatementAuthnContextDeclRef);

Default Value

""

Remarks

Specifies the authentication contexts declaration reference.

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

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

This property is not available at design time.

Data Type

String

AssertionStatementAuthnInstant Property (SAMLWriter Class)

Specifies the authentication event timestamp.

Syntax

QString GetAssertionStatementAuthnInstant(int iAssertionStatementIndex);
int SetAssertionStatementAuthnInstant(int iAssertionStatementIndex, QString qsAssertionStatementAuthnInstant);

Default Value

""

Remarks

Specifies the authentication event timestamp.

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

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

This property is not available at design time.

Data Type

String

AssertionStatementAuthnSessionIndex Property (SAMLWriter Class)

Contains the authentication session index.

Syntax

QString GetAssertionStatementAuthnSessionIndex(int iAssertionStatementIndex);
int SetAssertionStatementAuthnSessionIndex(int iAssertionStatementIndex, QString qsAssertionStatementAuthnSessionIndex);

Default Value

""

Remarks

Contains the authentication session index.

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

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

This property is not available at design time.

Data Type

String

AssertionStatementAuthnSessionNotOnOrAfter Property (SAMLWriter Class)

Maps to the SessionNotOnOrAfter parameter of the authentication statement.

Syntax

QString GetAssertionStatementAuthnSessionNotOnOrAfter(int iAssertionStatementIndex);
int SetAssertionStatementAuthnSessionNotOnOrAfter(int iAssertionStatementIndex, QString qsAssertionStatementAuthnSessionNotOnOrAfter);

Default Value

""

Remarks

Maps to the SessionNotOnOrAfter parameter of the authentication statement.

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

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

This property is not available at design time.

Data Type

String

AssertionStatementAuthnSubjectLocalityAddress Property (SAMLWriter Class)

Specifies the authentication subjects address.

Syntax

QString GetAssertionStatementAuthnSubjectLocalityAddress(int iAssertionStatementIndex);
int SetAssertionStatementAuthnSubjectLocalityAddress(int iAssertionStatementIndex, QString qsAssertionStatementAuthnSubjectLocalityAddress);

Default Value

""

Remarks

Specifies the authentication subjects address.

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

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

This property is not available at design time.

Data Type

String

AssertionStatementAuthnSubjectLocalityDNSName Property (SAMLWriter Class)

Maps to the authentication subjects DNS name parameter.

Syntax

QString GetAssertionStatementAuthnSubjectLocalityDNSName(int iAssertionStatementIndex);
int SetAssertionStatementAuthnSubjectLocalityDNSName(int iAssertionStatementIndex, QString qsAssertionStatementAuthnSubjectLocalityDNSName);

Default Value

""

Remarks

Maps to the authentication subjects DNS name parameter.

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

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

This property is not available at design time.

Data Type

String

AssertionStatementAuthzActions Property (SAMLWriter Class)

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

Syntax

QString GetAssertionStatementAuthzActions(int iAssertionStatementIndex);
int SetAssertionStatementAuthzActions(int iAssertionStatementIndex, QString qsAssertionStatementAuthzActions);

Default Value

""

Remarks

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

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

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

This property is not available at design time.

Data Type

String

AssertionStatementAuthzDecision Property (SAMLWriter Class)

Specifies the authorization decision.

Syntax

int GetAssertionStatementAuthzDecision(int iAssertionStatementIndex);
int SetAssertionStatementAuthzDecision(int iAssertionStatementIndex, int iAssertionStatementAuthzDecision);

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

This property is not available at design time.

Data Type

Integer

AssertionStatementAuthzDecisionEvidence Property (SAMLWriter Class)

Manages the authorization decision statement evidence parameter.

Syntax

QString GetAssertionStatementAuthzDecisionEvidence(int iAssertionStatementIndex);
int SetAssertionStatementAuthzDecisionEvidence(int iAssertionStatementIndex, QString qsAssertionStatementAuthzDecisionEvidence);

Default Value

""

Remarks

Manages the authorization decision statement evidence parameter.

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

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

This property is not available at design time.

Data Type

String

AssertionStatementAuthzDecisionResource Property (SAMLWriter Class)

Specifies the authorization decision statement resource parameter.

Syntax

QString GetAssertionStatementAuthzDecisionResource(int iAssertionStatementIndex);
int SetAssertionStatementAuthzDecisionResource(int iAssertionStatementIndex, QString qsAssertionStatementAuthzDecisionResource);

Default Value

""

Remarks

Specifies the authorization decision statement resource parameter.

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

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

This property is not available at design time.

Data Type

String

AssertionStatementStatementType Property (SAMLWriter Class)

Specifies the assertion statement type.

Syntax

int GetAssertionStatementStatementType(int iAssertionStatementIndex);
int SetAssertionStatementStatementType(int iAssertionStatementIndex, int iAssertionStatementStatementType);

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

This property is not available at design time.

Data Type

Integer

AssertionSubjectConfirmationCount Property (SAMLWriter Class)

The number of records in the AssertionSubjectConfirmation arrays.

Syntax

int GetAssertionSubjectConfirmationCount();
int SetAssertionSubjectConfirmationCount(int iAssertionSubjectConfirmationCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

AssertionSubjectConfirmationDataAddress Property (SAMLWriter Class)

Contains the address enabled for presenting assertions.

Syntax

QString GetAssertionSubjectConfirmationDataAddress(int iAssertionSubjectConfirmationIndex);
int SetAssertionSubjectConfirmationDataAddress(int iAssertionSubjectConfirmationIndex, QString qsAssertionSubjectConfirmationDataAddress);

Default Value

""

Remarks

Contains the address enabled for presenting assertions.

Use this property to specify the network address or location from which the subject confirmation should be issued. This optional element can be used to restrict the possibilities of an attacker to steal the assertion and present it from another IP address.

The AssertionSubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionSubjectConfirmationCount property.

This property is not available at design time.

Data Type

String

AssertionSubjectConfirmationDataInResponseTo Property (SAMLWriter Class)

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

Syntax

QString GetAssertionSubjectConfirmationDataInResponseTo(int iAssertionSubjectConfirmationIndex);
int SetAssertionSubjectConfirmationDataInResponseTo(int iAssertionSubjectConfirmationIndex, QString qsAssertionSubjectConfirmationDataInResponseTo);

Default Value

""

Remarks

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

This property specifies the ID of the SAML message in response to which the assertion is issued.

The AssertionSubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionSubjectConfirmationCount property.

This property is not available at design time.

Data Type

String

AssertionSubjectConfirmationDataNotBefore Property (SAMLWriter Class)

Time moment before which the subject cannot be confirmed.

Syntax

QString GetAssertionSubjectConfirmationDataNotBefore(int iAssertionSubjectConfirmationIndex);
int SetAssertionSubjectConfirmationDataNotBefore(int iAssertionSubjectConfirmationIndex, QString qsAssertionSubjectConfirmationDataNotBefore);

Default Value

""

Remarks

Time moment before which the subject cannot be confirmed.

This property specifies the time before which the subject cannot be confirmed.

The AssertionSubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionSubjectConfirmationCount property.

This property is not available at design time.

Data Type

String

AssertionSubjectConfirmationDataNotOnOrAfter Property (SAMLWriter Class)

Limits the time until which the subject can be confirmed.

Syntax

QString GetAssertionSubjectConfirmationDataNotOnOrAfter(int iAssertionSubjectConfirmationIndex);
int SetAssertionSubjectConfirmationDataNotOnOrAfter(int iAssertionSubjectConfirmationIndex, QString qsAssertionSubjectConfirmationDataNotOnOrAfter);

Default Value

""

Remarks

Limits the time until which the subject can be confirmed.

This property specifies the time on (or after) which the subject cannot be confirmed.

The AssertionSubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionSubjectConfirmationCount property.

This property is not available at design time.

Data Type

String

AssertionSubjectConfirmationDataRecipient Property (SAMLWriter Class)

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

Syntax

QString GetAssertionSubjectConfirmationDataRecipient(int iAssertionSubjectConfirmationIndex);
int SetAssertionSubjectConfirmationDataRecipient(int iAssertionSubjectConfirmationIndex, QString qsAssertionSubjectConfirmationDataRecipient);

Default Value

""

Remarks

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

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

The AssertionSubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionSubjectConfirmationCount property.

This property is not available at design time.

Data Type

String

AssertionSubjectConfirmationDataType Property (SAMLWriter Class)

The type of data contained in the confirmation.

Syntax

QString GetAssertionSubjectConfirmationDataType(int iAssertionSubjectConfirmationIndex);
int SetAssertionSubjectConfirmationDataType(int iAssertionSubjectConfirmationIndex, QString qsAssertionSubjectConfirmationDataType);

Default Value

""

Remarks

The type of data contained in the confirmation.

Use this property to read or specify the type of confirmation data included in the object.

The AssertionSubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionSubjectConfirmationCount property.

This property is not available at design time.

Data Type

String

AssertionSubjectConfirmationID Property (SAMLWriter Class)

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

Syntax

QString GetAssertionSubjectConfirmationID(int iAssertionSubjectConfirmationIndex);
int SetAssertionSubjectConfirmationID(int iAssertionSubjectConfirmationIndex, QString qsAssertionSubjectConfirmationID);

Default Value

""

Remarks

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

This property specifies the identifier of the entity which is expected to satisfy the subject confirmation requirements.

The AssertionSubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionSubjectConfirmationCount property.

This property is not available at design time.

Data Type

String

AssertionSubjectConfirmationMethod Property (SAMLWriter Class)

Specifies the mechanism to be used to confirm the subject.

Syntax

QString GetAssertionSubjectConfirmationMethod(int iAssertionSubjectConfirmationIndex);
int SetAssertionSubjectConfirmationMethod(int iAssertionSubjectConfirmationIndex, QString qsAssertionSubjectConfirmationMethod);

Default Value

""

Remarks

Specifies the mechanism to be used to confirm the subject.

This property contains a URI reference that identifies the mechanism to be used to confirm the subject.

The AssertionSubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionSubjectConfirmationCount property.

This property is not available at design time.

Data Type

String

AssertionSubjectID Property (SAMLWriter Class)

Specifies the assertion subject ID.

Syntax

QString GetAssertionSubjectID();
int SetAssertionSubjectID(QString qsAssertionSubjectID);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

AttrQueryAttrCount Property (SAMLWriter Class)

The number of records in the AttrQueryAttr arrays.

Syntax

int GetAttrQueryAttrCount();
int SetAttrQueryAttrCount(int iAttrQueryAttrCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

AttrQueryAttrFriendlyName Property (SAMLWriter 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);
int SetAttrQueryAttrFriendlyName(int iAttrQueryAttrIndex, QString qsAttrQueryAttrFriendlyName);

Default Value

""

Remarks

Specifies the friendly name of the attribute

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

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

This property is not available at design time.

Data Type

String

AttrQueryAttrName Property (SAMLWriter Class)

Specifies the name of the attribute.

Syntax

QString GetAttrQueryAttrName(int iAttrQueryAttrIndex);
int SetAttrQueryAttrName(int iAttrQueryAttrIndex, QString qsAttrQueryAttrName);

Default Value

""

Remarks

Specifies the name of the attribute.

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

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

This property is not available at design time.

Data Type

String

AttrQueryAttrNameFormat Property (SAMLWriter Class)

Indicates the format used to reference the attribute.

Syntax

QString GetAttrQueryAttrNameFormat(int iAttrQueryAttrIndex);
int SetAttrQueryAttrNameFormat(int iAttrQueryAttrIndex, QString qsAttrQueryAttrNameFormat);

Default Value

""

Remarks

Indicates the format used to reference the attribute.

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

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

This property is not available at design time.

Data Type

String

AttrQueryAttrStatementIndex Property (SAMLWriter Class)

Contains the index of the statement the attribute corresponds to.

Syntax

int GetAttrQueryAttrStatementIndex(int iAttrQueryAttrIndex);
int SetAttrQueryAttrStatementIndex(int iAttrQueryAttrIndex, int iAttrQueryAttrStatementIndex);

Default Value

-1

Remarks

Contains the index of the statement the attribute corresponds to.

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

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

This property is not available at design time.

Data Type

Integer

AttrQueryAttrValues Property (SAMLWriter Class)

Contains a list of attribute values.

Syntax

QString GetAttrQueryAttrValues(int iAttrQueryAttrIndex);
int SetAttrQueryAttrValues(int iAttrQueryAttrIndex, QString qsAttrQueryAttrValues);

Default Value

""

Remarks

Contains a list of attribute values.

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

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

This property is not available at design time.

Data Type

String

AuthnQueryComparison Property (SAMLWriter Class)

Specifies the authentication context comparison method.

Syntax

int GetAuthnQueryComparison();
int SetAuthnQueryComparison(int iAuthnQueryComparison);

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

Data Type

Integer

AuthnQueryContextClassRefs Property (SAMLWriter Class)

Specifies the context class reference.

Syntax

QString GetAuthnQueryContextClassRefs();
int SetAuthnQueryContextClassRefs(QString qsAuthnQueryContextClassRefs);

Default Value

""

Remarks

Specifies the context class reference.

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

This property is not available at design time.

Data Type

String

AuthnQueryRefType Property (SAMLWriter Class)

Specifies the context reference type.

Syntax

int GetAuthnQueryRefType();
int SetAuthnQueryRefType(int iAuthnQueryRefType);

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

Data Type

Integer

AuthnQuerySessionIndex Property (SAMLWriter Class)

Specifies the index of the session to the authentication entity.

Syntax

QString GetAuthnQuerySessionIndex();
int SetAuthnQuerySessionIndex(QString qsAuthnQuerySessionIndex);

Default Value

""

Remarks

Specifies the index of the session to the authentication entity.

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

This property is not available at design time.

Data Type

String

AuthnRequestAssertionConsumerServiceIndex Property (SAMLWriter Class)

Specifies the assertion consumer service index.

Syntax

int GetAuthnRequestAssertionConsumerServiceIndex();
int SetAuthnRequestAssertionConsumerServiceIndex(int iAuthnRequestAssertionConsumerServiceIndex);

Default Value

0

Remarks

Specifies the assertion consumer service index.

Use this property to access or set the location index to which the response has to be returned.

This property is not available at design time.

Data Type

Integer

AuthnRequestAssertionConsumerServiceURL Property (SAMLWriter Class)

Specifies the assertion consumer service URL.

Syntax

QString GetAuthnRequestAssertionConsumerServiceURL();
int SetAuthnRequestAssertionConsumerServiceURL(QString qsAuthnRequestAssertionConsumerServiceURL);

Default Value

""

Remarks

Specifies the assertion consumer service URL.

Use this property to access or set the URL of the location to which the response has to be returned.

This property is not available at design time.

Data Type

String

AuthnRequestAttributeConsumingServiceIndex Property (SAMLWriter Class)

Specifies the attribute consuming service index.

Syntax

int GetAuthnRequestAttributeConsumingServiceIndex();
int SetAuthnRequestAttributeConsumingServiceIndex(int iAuthnRequestAttributeConsumingServiceIndex);

Default Value

0

Remarks

Specifies the attribute consuming service index.

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

This property is not available at design time.

Data Type

Integer

AuthnRequestConditionsNotBefore Property (SAMLWriter Class)

Specifies the NotBefore condition of the request.

Syntax

QString GetAuthnRequestConditionsNotBefore();
int SetAuthnRequestConditionsNotBefore(QString qsAuthnRequestConditionsNotBefore);

Default Value

""

Remarks

Specifies the NotBefore condition of the request.

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

This property is not available at design time.

Data Type

String

AuthnRequestConditionsNotOnOrAfter Property (SAMLWriter Class)

Provides access to the NotOnOrAfter condition of the request.

Syntax

QString GetAuthnRequestConditionsNotOnOrAfter();
int SetAuthnRequestConditionsNotOnOrAfter(QString qsAuthnRequestConditionsNotOnOrAfter);

Default Value

""

Remarks

Provides access to the NotOnOrAfter condition of the request.

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

This property is not available at design time.

Data Type

String

AuthnRequestContextClassRefs Property (SAMLWriter Class)

Provides access to the authentication context class references.

Syntax

QString GetAuthnRequestContextClassRefs();
int SetAuthnRequestContextClassRefs(QString qsAuthnRequestContextClassRefs);

Default Value

""

Remarks

Provides access to the authentication context class references.

Use this property to access or set the class references of the authentication context. This property may contain a list of CRLF-separated strings.

This property is not available at design time.

Data Type

String

AuthnRequestContextComparison Property (SAMLWriter Class)

Specifies the AuthnContext comparison method.

Syntax

int GetAuthnRequestContextComparison();
int SetAuthnRequestContextComparison(int iAuthnRequestContextComparison);

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

Data Type

Integer

AuthnRequestContextRefType Property (SAMLWriter Class)

Specifies the context reference type.

Syntax

int GetAuthnRequestContextRefType();
int SetAuthnRequestContextRefType(int iAuthnRequestContextRefType);

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

Data Type

Integer

AuthnRequestForceAuthn Property (SAMLWriter Class)

Corresponds to the ForceAuthn parameter of the request.

Syntax

bool GetAuthnRequestForceAuthn();
int SetAuthnRequestForceAuthn(bool bAuthnRequestForceAuthn);

Default Value

false

Remarks

Corresponds to the ForceAuthn parameter of the request.

Use this property to check or set the ForceAuthn parameter of the request, which enforces the identity provider to re-authenticate the presenter.

This property is not available at design time.

Data Type

Boolean

AuthnRequestIsPassive Property (SAMLWriter Class)

Maps to the IsPassive parameter of the request.

Syntax

bool GetAuthnRequestIsPassive();
int SetAuthnRequestIsPassive(bool bAuthnRequestIsPassive);

Default Value

false

Remarks

Maps to the IsPassive parameter of the request.

Use this property to access or set the IsPassive parameter of the authentication request. IsPassive sets out the control the identity provider and user agent have over the authenticating users UI.

This property is not available at design time.

Data Type

Boolean

AuthnRequestNameIDPolicyAllowCreate Property (SAMLWriter Class)

Matches the AllowCreate attribute of NameIDPolicy element of the request.

Syntax

bool GetAuthnRequestNameIDPolicyAllowCreate();
int SetAuthnRequestNameIDPolicyAllowCreate(bool bAuthnRequestNameIDPolicyAllowCreate);

Default Value

false

Remarks

Matches the AllowCreate attribute of NameIDPolicy element of the request.

Use this property to access or set the AllowCreate attribute of NameIDPolicy, which allows or disallows the identity provider to create a new identifier when processing the authentication request.

This property is not available at design time.

Data Type

Boolean

AuthnRequestNameIDPolicyFormat Property (SAMLWriter Class)

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

Syntax

QString GetAuthnRequestNameIDPolicyFormat();
int SetAuthnRequestNameIDPolicyFormat(QString qsAuthnRequestNameIDPolicyFormat);

Default Value

""

Remarks

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

Use this property to access or set the Format attribute of NameIDPolicy.

This property is not available at design time.

Data Type

String

AuthnRequestNameIDPolicySPNameQualifier Property (SAMLWriter Class)

Matches to the SP name qualifier attribute of the request.

Syntax

QString GetAuthnRequestNameIDPolicySPNameQualifier();
int SetAuthnRequestNameIDPolicySPNameQualifier(QString qsAuthnRequestNameIDPolicySPNameQualifier);

Default Value

""

Remarks

Matches to the SP name qualifier attribute of the request.

Use this property to access or set the SP name qualifier attribute of the authentication request.

This property is not available at design time.

Data Type

String

AuthnRequestNameIDPolicyUseAllowCreate Property (SAMLWriter Class)

Controls inclusion of AllowCreate attribute in the request.

Syntax

bool GetAuthnRequestNameIDPolicyUseAllowCreate();
int SetAuthnRequestNameIDPolicyUseAllowCreate(bool bAuthnRequestNameIDPolicyUseAllowCreate);

Default Value

false

Remarks

Controls inclusion of AllowCreate attribute in the request.

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

This property is not available at design time.

Data Type

Boolean

AuthnRequestProtocolBinding Property (SAMLWriter Class)

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

Syntax

QString GetAuthnRequestProtocolBinding();
int SetAuthnRequestProtocolBinding(QString qsAuthnRequestProtocolBinding);

Default Value

""

Remarks

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

Use this property to check or set the protocol binding to be used when responding to this request.

This property is not available at design time.

Data Type

String

AuthnRequestProviderName Property (SAMLWriter Class)

Specifies the name of the requestor.

Syntax

QString GetAuthnRequestProviderName();
int SetAuthnRequestProviderName(QString qsAuthnRequestProviderName);

Default Value

""

Remarks

Specifies the name of the requestor.

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

This property is not available at design time.

Data Type

String

AuthnRequestScopingIDPListGetComplete Property (SAMLWriter Class)

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

Syntax

QString GetAuthnRequestScopingIDPListGetComplete();
int SetAuthnRequestScopingIDPListGetComplete(QString qsAuthnRequestScopingIDPListGetComplete);

Default Value

""

Remarks

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

Use this property to access or set the GetComplete element of the IDPList entry of the Scoping object of the authentication request. This property typically contains an URI that allows to retrieve a complete list of identity providers.

This property is not available at design time.

Data Type

String

AuthnRequestScopingProxyCount Property (SAMLWriter Class)

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

Syntax

int GetAuthnRequestScopingProxyCount();
int SetAuthnRequestScopingProxyCount(int iAuthnRequestScopingProxyCount);

Default Value

0

Remarks

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

Use this property to get or set the maximum number of intermediaries allowed between the requestor and the provider.

This property is not available at design time.

Data Type

Integer

AuthnRequestScopingRequesterIDs Property (SAMLWriter Class)

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

Syntax

QString GetAuthnRequestScopingRequesterIDs();
int SetAuthnRequestScopingRequesterIDs(QString qsAuthnRequestScopingRequesterIDs);

Default Value

""

Remarks

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

Use this property to specify or read the requestor IDs, in the form of CRLF-separated strings, on whose behalf the request is being sent.

This property is not available at design time.

Data Type

String

AuthnRequestUseForceAuthn Property (SAMLWriter Class)

Controls inclusion of ForceAuthn attribute in the request.

Syntax

bool GetAuthnRequestUseForceAuthn();
int SetAuthnRequestUseForceAuthn(bool bAuthnRequestUseForceAuthn);

Default Value

false

Remarks

Controls inclusion of ForceAuthn attribute in the request.

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

This property is not available at design time.

Data Type

Boolean

AuthnRequestUseIsPassive Property (SAMLWriter Class)

Controls inclusion of IsPassive attribute in the request.

Syntax

bool GetAuthnRequestUseIsPassive();
int SetAuthnRequestUseIsPassive(bool bAuthnRequestUseIsPassive);

Default Value

false

Remarks

Controls inclusion of IsPassive attribute in the request.

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

This property is not available at design time.

Data Type

Boolean

AuthnRequestConditionCount Property (SAMLWriter Class)

The number of records in the AuthnRequestCondition arrays.

Syntax

int GetAuthnRequestConditionCount();
int SetAuthnRequestConditionCount(int iAuthnRequestConditionCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

AuthnRequestConditionAudienceList Property (SAMLWriter Class)

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

Syntax

QString GetAuthnRequestConditionAudienceList(int iAuthnRequestConditionIndex);
int SetAuthnRequestConditionAudienceList(int iAuthnRequestConditionIndex, QString qsAuthnRequestConditionAudienceList);

Default Value

""

Remarks

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

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

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

This property is not available at design time.

Data Type

String

AuthnRequestConditionConditionType Property (SAMLWriter Class)

Specifies a type of the condition object.

Syntax

int GetAuthnRequestConditionConditionType(int iAuthnRequestConditionIndex);
int SetAuthnRequestConditionConditionType(int iAuthnRequestConditionIndex, int iAuthnRequestConditionConditionType);

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

Data Type

Integer

AuthnRequestConditionProxyRestrictionCount Property (SAMLWriter Class)

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

Syntax

int GetAuthnRequestConditionProxyRestrictionCount(int iAuthnRequestConditionIndex);
int SetAuthnRequestConditionProxyRestrictionCount(int iAuthnRequestConditionIndex, int iAuthnRequestConditionProxyRestrictionCount);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Integer

AuthnRequestScopingIDPCount Property (SAMLWriter Class)

The number of records in the AuthnRequestScopingIDP arrays.

Syntax

int GetAuthnRequestScopingIDPCount();
int SetAuthnRequestScopingIDPCount(int iAuthnRequestScopingIDPCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

AuthnRequestScopingIDPLoc Property (SAMLWriter Class)

Contains the value of the Loc attribute.

Syntax

QString GetAuthnRequestScopingIDPLoc(int iAuthnRequestScopingIDPIndex);
int SetAuthnRequestScopingIDPLoc(int iAuthnRequestScopingIDPIndex, QString qsAuthnRequestScopingIDPLoc);

Default Value

""

Remarks

Contains the value of the Loc attribute.

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

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

This property is not available at design time.

Data Type

String

AuthnRequestScopingIDPName Property (SAMLWriter Class)

Contains the name of the IdP provider.

Syntax

QString GetAuthnRequestScopingIDPName(int iAuthnRequestScopingIDPIndex);
int SetAuthnRequestScopingIDPName(int iAuthnRequestScopingIDPIndex, QString qsAuthnRequestScopingIDPName);

Default Value

""

Remarks

Contains the name of the IdP provider.

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

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

This property is not available at design time.

Data Type

String

AuthnRequestScopingIDPProviderID Property (SAMLWriter Class)

Contains the provider ID.

Syntax

QString GetAuthnRequestScopingIDPProviderID(int iAuthnRequestScopingIDPIndex);
int SetAuthnRequestScopingIDPProviderID(int iAuthnRequestScopingIDPIndex, QString qsAuthnRequestScopingIDPProviderID);

Default Value

""

Remarks

Contains the provider ID.

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

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

This property is not available at design time.

Data Type

String

AuthzDecisionQueryActions Property (SAMLWriter Class)

Specifies the list of actions included in the query.

Syntax

QString GetAuthzDecisionQueryActions();
int SetAuthzDecisionQueryActions(QString qsAuthzDecisionQueryActions);

Default Value

""

Remarks

Specifies the list of actions included in the query.

Read or set this property to access the list of actions (as CRLF-separated strings) included in the query.

This property is not available at design time.

Data Type

String

AuthzDecisionQueryResource Property (SAMLWriter Class)

Matches the Resource element of the query.

Syntax

QString GetAuthzDecisionQueryResource();
int SetAuthzDecisionQueryResource(QString qsAuthzDecisionQueryResource);

Default Value

""

Remarks

Matches the Resource element of the query.

Use this property to read or set the Resource element of the authorization decision query.

This property is not available at design time.

Data Type

String

Binding Property (SAMLWriter Class)

Specifies the type of the binding to use.

Syntax

int GetBinding();
int SetBinding(int iBinding);

Possible Values

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

Default Value

0

Remarks

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

Data Type

Integer

Consent Property (SAMLWriter Class)

Contains the Consent parameter of the request.

Syntax

QString GetConsent();
int SetConsent(QString qsConsent);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

Destination Property (SAMLWriter Class)

Contains the Destination parameter of the SAML object.

Syntax

QString GetDestination();
int SetDestination(QString qsDestination);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

EncryptionCertBytes Property (SAMLWriter Class)

Returns raw certificate data in DER format.

Syntax

QByteArray GetEncryptionCertBytes();

Remarks

Returns raw certificate data in DER format.

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

Data Type

Byte Array

EncryptionCertHandle Property (SAMLWriter Class)

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

Syntax

qint64 GetEncryptionCertHandle();
int SetEncryptionCertHandle(qint64 lEncryptionCertHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

FIPSMode Property (SAMLWriter 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 (SAMLWriter Class)

The ID of the request.

Syntax

QString GetID();
int SetID(QString qsID);

Default Value

""

Remarks

Use this property to specify the ID of the request.

This property is not available at design time.

Data Type

String

InResponseTo Property (SAMLWriter Class)

Contains the InResponseTo property of the SAML request.

Syntax

QString GetInResponseTo();
int SetInResponseTo(QString qsInResponseTo);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

IssueInstant Property (SAMLWriter Class)

Contains request issuance timestamp.

Syntax

QString GetIssueInstant();
int SetIssueInstant(QString qsIssueInstant);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

Issuer Property (SAMLWriter Class)

Sets the issuer of the message.

Syntax

QString GetIssuer();
int SetIssuer(QString qsIssuer);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

LogoutRequestNameID Property (SAMLWriter Class)

Contains the value of the NameID parameter.

Syntax

QString GetLogoutRequestNameID();
int SetLogoutRequestNameID(QString qsLogoutRequestNameID);

Default Value

""

Remarks

Contains the value of the NameID parameter.

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

This property is not available at design time.

Data Type

String

LogoutRequestNotOnOrAfter Property (SAMLWriter Class)

Contains the value of the NotOnOrAfter parameter.

Syntax

QString GetLogoutRequestNotOnOrAfter();
int SetLogoutRequestNotOnOrAfter(QString qsLogoutRequestNotOnOrAfter);

Default Value

""

Remarks

Contains the value of the NotOnOrAfter parameter.

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

This property is not available at design time.

Data Type

String

LogoutRequestReason Property (SAMLWriter Class)

Contains the value of the Reason parameter.

Syntax

QString GetLogoutRequestReason();
int SetLogoutRequestReason(QString qsLogoutRequestReason);

Default Value

""

Remarks

Contains the value of the Reason parameter.

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

This property is not available at design time.

Data Type

String

LogoutRequestSessionIndexes Property (SAMLWriter Class)

Contains the list of session indices.

Syntax

QString GetLogoutRequestSessionIndexes();
int SetLogoutRequestSessionIndexes(QString qsLogoutRequestSessionIndexes);

Default Value

""

Remarks

Contains the list of session indices.

Use this property to access or set the list of session indices, as a CRLF-separated list of strings.

This property is not available at design time.

Data Type

String

ManageNameIDRequestNameID Property (SAMLWriter Class)

Contains the value of the NameID parameter of the request.

Syntax

QString GetManageNameIDRequestNameID();
int SetManageNameIDRequestNameID(QString qsManageNameIDRequestNameID);

Default Value

""

Remarks

Contains the value of the NameID parameter of the request.

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

This property is not available at design time.

Data Type

String

ManageNameIDRequestNewEncryptedID Property (SAMLWriter Class)

Contains the value of the NewEncryptedID parameter of the request.

Syntax

QString GetManageNameIDRequestNewEncryptedID();
int SetManageNameIDRequestNewEncryptedID(QString qsManageNameIDRequestNewEncryptedID);

Default Value

""

Remarks

Contains the value of the NewEncryptedID parameter of the request.

Use this property to check or set the value of the NewEncryptedID parameter of the request.

This property is not available at design time.

Data Type

String

ManageNameIDRequestNewID Property (SAMLWriter Class)

Contains the value of the NewID parameter.

Syntax

QString GetManageNameIDRequestNewID();
int SetManageNameIDRequestNewID(QString qsManageNameIDRequestNewID);

Default Value

""

Remarks

Contains the value of the NewID parameter.

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

This property is not available at design time.

Data Type

String

ManageNameIDRequestTerminate Property (SAMLWriter Class)

Contains the value of the Terminate parameter of the request.

Syntax

QString GetManageNameIDRequestTerminate();
int SetManageNameIDRequestTerminate(QString qsManageNameIDRequestTerminate);

Default Value

""

Remarks

Contains the value of the Terminate parameter of the request.

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

This property is not available at design time.

Data Type

String

NameIDMappingRequestNameID Property (SAMLWriter Class)

An accessor to the NameID parameter of the request.

Syntax

QString GetNameIDMappingRequestNameID();
int SetNameIDMappingRequestNameID(QString qsNameIDMappingRequestNameID);

Default Value

""

Remarks

An accessor to the NameID parameter of the request.

Use this property to read or set the value of the NameID parameter of the request object.

This property is not available at design time.

Data Type

String

NameIDMappingRequestNameIDPolicyAllowCreate Property (SAMLWriter Class)

Contains the value of AllowCreate parameter of the NameIDPolicy object.

Syntax

bool GetNameIDMappingRequestNameIDPolicyAllowCreate();
int SetNameIDMappingRequestNameIDPolicyAllowCreate(bool bNameIDMappingRequestNameIDPolicyAllowCreate);

Default Value

false

Remarks

Contains the value of AllowCreate parameter of the NameIDPolicy object.

Use this property to read or set the value of the AllowCreate parameter of the NameIDPolicy object. AllowCreate regulates whether the identity provider is given permission to create new subject identifiers.

This property is not available at design time.

Data Type

Boolean

NameIDMappingRequestNameIDPolicyFormat Property (SAMLWriter Class)

Specifies the format of the NameIDPolicy element.

Syntax

QString GetNameIDMappingRequestNameIDPolicyFormat();
int SetNameIDMappingRequestNameIDPolicyFormat(QString qsNameIDMappingRequestNameIDPolicyFormat);

Default Value

""

Remarks

Specifies the format of the NameIDPolicy element.

Use this property to set or read the value of the Format parameter of the NameIDPolicy object.

This property is not available at design time.

Data Type

String

NameIDMappingRequestNameIDPolicySPNameQualifier Property (SAMLWriter Class)

Contains the SPNameQualifier parameter of the NameIDPolicy element.

Syntax

QString GetNameIDMappingRequestNameIDPolicySPNameQualifier();
int SetNameIDMappingRequestNameIDPolicySPNameQualifier(QString qsNameIDMappingRequestNameIDPolicySPNameQualifier);

Default Value

""

Remarks

Contains the SPNameQualifier parameter of the NameIDPolicy element.

Use this property to specify or read the value of the SPNameQualifier parameter of the NameIDPolicy element of the request.

This property is not available at design time.

Data Type

String

NameIDMappingRequestNameIDPolicyUseAllowCreate Property (SAMLWriter Class)

Controls inclusion of UseAllow modifier in the NameIDPolicy object.

Syntax

bool GetNameIDMappingRequestNameIDPolicyUseAllowCreate();
int SetNameIDMappingRequestNameIDPolicyUseAllowCreate(bool bNameIDMappingRequestNameIDPolicyUseAllowCreate);

Default Value

false

Remarks

Controls inclusion of UseAllow modifier in the NameIDPolicy object.

Use this property to include or exclude the UseAllow parameter from the NameIDPolicy object.

This property is not available at design time.

Data Type

Boolean

OutputType Property (SAMLWriter Class)

Returns the SAML type of message being created.

Syntax

int GetOutputType();

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

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

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

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

Data Type

Integer

POSTBindingBody Property (SAMLWriter Class)

Contains the form body.

Syntax

QString GetPOSTBindingBody();
int SetPOSTBindingBody(QString qsPOSTBindingBody);

Default Value

""

Remarks

Contains the form body.

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

This property is not available at design time.

Data Type

String

POSTBindingFormTemplate Property (SAMLWriter Class)

Contains the XHTML form template returned by the service provider.

Syntax

QString GetPOSTBindingFormTemplate();
int SetPOSTBindingFormTemplate(QString qsPOSTBindingFormTemplate);

Default Value

""

Remarks

Contains the XHTML form template returned by the service provider.

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

This property is not available at design time.

Data Type

String

POSTBindingMode Property (SAMLWriter Class)

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

Syntax

int GetPOSTBindingMode();
int SetPOSTBindingMode(int iPOSTBindingMode);

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

Data Type

Integer

POSTBindingRelayState Property (SAMLWriter Class)

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

Syntax

QString GetPOSTBindingRelayState();
int SetPOSTBindingRelayState(QString qsPOSTBindingRelayState);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

POSTBindingURL Property (SAMLWriter Class)

Contains the URL of POST binding mechanism.

Syntax

QString GetPOSTBindingURL();
int SetPOSTBindingURL(QString qsPOSTBindingURL);

Default Value

""

Remarks

Contains the URL of POST binding mechanism.

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

This property is not available at design time.

Data Type

String

Profile Property (SAMLWriter 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

RedirectBindingEncoding Property (SAMLWriter Class)

Specifies the message encoding.

Syntax

QString GetRedirectBindingEncoding();
int SetRedirectBindingEncoding(QString qsRedirectBindingEncoding);

Default Value

""

Remarks

Specifies the message encoding.

Use this property to access or set the message encoding.

This property is not available at design time.

Data Type

String

RedirectBindingForceSign Property (SAMLWriter Class)

Enforces a signature over all outgoing messages.

Syntax

bool GetRedirectBindingForceSign();
int SetRedirectBindingForceSign(bool bRedirectBindingForceSign);

Default Value

false

Remarks

Enforces a signature over all outgoing messages.

Use this property to enforce signing of all outgoing messages, independently of whether the original message was signed or not. See also RedirectBindingSign.

This property is not available at design time.

Data Type

Boolean

RedirectBindingRelayState Property (SAMLWriter Class)

Contains the RelayState parameter of the binding.

Syntax

QString GetRedirectBindingRelayState();
int SetRedirectBindingRelayState(QString qsRedirectBindingRelayState);

Default Value

""

Remarks

Contains the RelayState parameter of the binding.

Use this property to access or set the RelayState parameter of the binding. This is an uninterpreted state string that should be passed back to the service provider with subsequent requests.

This property is not available at design time.

Data Type

String

RedirectBindingSign Property (SAMLWriter Class)

Specifies whether to sign generated messages.

Syntax

bool GetRedirectBindingSign();
int SetRedirectBindingSign(bool bRedirectBindingSign);

Default Value

false

Remarks

Specifies whether to sign generated messages.

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

This property is not available at design time.

Data Type

Boolean

RedirectBindingSignatureAlgorithm Property (SAMLWriter Class)

Contains the signature algorithm.

Syntax

QString GetRedirectBindingSignatureAlgorithm();
int SetRedirectBindingSignatureAlgorithm(QString qsRedirectBindingSignatureAlgorithm);

Default Value

""

Remarks

Contains the signature algorithm.

Use this property to get or set the signature algorithm. This corresponds to the SigAlg query string parameter, and contains the URI of the signature algorithm.

This property is not available at design time.

Data Type

String

RedirectBindingURL Property (SAMLWriter Class)

Contains the URL of the request query.

Syntax

QString GetRedirectBindingURL();
int SetRedirectBindingURL(QString qsRedirectBindingURL);

Default Value

""

Remarks

Contains the URL of the request query.

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

This property is not available at design time.

Data Type

String

RedirectBindingVerifySignatures Property (SAMLWriter Class)

Instructs the class whether to verify incoming signatures.

Syntax

bool GetRedirectBindingVerifySignatures();
int SetRedirectBindingVerifySignatures(bool bRedirectBindingVerifySignatures);

Default Value

false

Remarks

Instructs the component whether to verify incoming signatures.

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

This property is not available at design time.

Data Type

Boolean

RedirectBindingCertBytes Property (SAMLWriter 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 (SAMLWriter 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 (SAMLWriter Class)

Contains the NameID parameter of a NameIDMapping response.

Syntax

QString GetResponseNameID();
int SetResponseNameID(QString qsResponseNameID);

Default Value

""

Remarks

Contains the NameID parameter of a NameIDMapping response.

Use this property to read or set the NameID parameter of the NameIDMapping response.

This property is not available at design time.

Data Type

String

ResponseOptionalElement Property (SAMLWriter Class)

An optional message element to be returned with the response.

Syntax

QString GetResponseOptionalElement();
int SetResponseOptionalElement(QString qsResponseOptionalElement);

Default Value

""

Remarks

An optional message element to be returned with the response.

Use this property to access or set the optional XML element returned with the response.

This property is not available at design time.

Data Type

String

ResponseResponseType Property (SAMLWriter Class)

Contains the type of the response.

Syntax

int GetResponseResponseType();
int SetResponseResponseType(int iResponseResponseType);

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

Data Type

Integer

ResponseStatusCodeSubValue Property (SAMLWriter Class)

The value of the nested StatusCode.

Syntax

QString GetResponseStatusCodeSubValue();
int SetResponseStatusCodeSubValue(QString qsResponseStatusCodeSubValue);

Default Value

""

Remarks

The value of the nested StatusCode.

This property contains the value of the nested StatusCode element.

This property is not available at design time.

Data Type

String

ResponseStatusCodeValue Property (SAMLWriter Class)

Contains the status code value.

Syntax

QString GetResponseStatusCodeValue();
int SetResponseStatusCodeValue(QString qsResponseStatusCodeValue);

Default Value

""

Remarks

Contains the status code value.

Use this property to read or set one of the status codes defined by SAML specification, such as 'urn:oasis:names:tc:SAML:2.0:status:Success' or 'urn:oasis:names:tc:SAML:2.0:status:Requester'.

This property is not available at design time.

Data Type

String

ResponseStatusDetail Property (SAMLWriter Class)

Contains additional information on the status of the request.

Syntax

QString GetResponseStatusDetail();
int SetResponseStatusDetail(QString qsResponseStatusDetail);

Default Value

""

Remarks

Contains additional information on the status of the request.

The StatusDetail element contains additional request status information.

This property is not available at design time.

Data Type

String

ResponseStatusMessage Property (SAMLWriter Class)

Contains a status message (optional).

Syntax

QString GetResponseStatusMessage();
int SetResponseStatusMessage(QString qsResponseStatusMessage);

Default Value

""

Remarks

Contains a status message (optional).

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

This property is not available at design time.

Data Type

String

SigCanonicalizationMethod Property (SAMLWriter Class)

The canonicalization method to use in the signature.

Syntax

QString GetSigCanonicalizationMethod();
int SetSigCanonicalizationMethod(QString qsSigCanonicalizationMethod);

Default Value

""

Remarks

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

Data Type

String

SigDigestMethod Property (SAMLWriter Class)

The digest method to use.

Syntax

QString GetSigDigestMethod();
int SetSigDigestMethod(QString qsSigDigestMethod);

Default Value

""

Remarks

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

Data Type

String

SigMethod Property (SAMLWriter Class)

The signature method to use.

Syntax

QString GetSigMethod();
int SetSigMethod(QString qsSigMethod);

Default Value

""

Remarks

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

Data Type

String

Sign Property (SAMLWriter Class)

Specifies whether the created SAML message should be signed.

Syntax

bool GetSign();
int SetSign(bool bSign);

Default Value

false

Remarks

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

This property is not available at design time.

Data Type

Boolean

SigningCertBytes Property (SAMLWriter 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

SigningCertHandle Property (SAMLWriter Class)

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

Syntax

qint64 GetSigningCertHandle();
int SetSigningCertHandle(qint64 lSigningCertHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

SigningChainCount Property (SAMLWriter Class)

The number of records in the SigningChain arrays.

Syntax

int GetSigningChainCount();
int SetSigningChainCount(int iSigningChainCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

SigningChainBytes Property (SAMLWriter Class)

Returns raw certificate data in DER format.

Syntax

QByteArray GetSigningChainBytes(int iSigningChainIndex);

Remarks

Returns raw certificate data in DER format.

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

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

Data Type

Byte Array

SigningChainHandle Property (SAMLWriter Class)

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

Syntax

qint64 GetSigningChainHandle(int iSigningChainIndex);
int SetSigningChainHandle(int iSigningChainIndex, qint64 lSigningChainHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

This property is not available at design time.

Data Type

Long64

SubjectConfirmationCount Property (SAMLWriter Class)

The number of records in the SubjectConfirmation arrays.

Syntax

int GetSubjectConfirmationCount();
int SetSubjectConfirmationCount(int iSubjectConfirmationCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

SubjectConfirmationDataAddress Property (SAMLWriter Class)

Contains the address enabled for presenting assertions.

Syntax

QString GetSubjectConfirmationDataAddress(int iSubjectConfirmationIndex);
int SetSubjectConfirmationDataAddress(int iSubjectConfirmationIndex, QString qsSubjectConfirmationDataAddress);

Default Value

""

Remarks

Contains the address enabled for presenting assertions.

Use this property to specify the network address or location from which the subject confirmation should be issued. This optional element can be used to restrict the possibilities of an attacker to steal the assertion and present it from another IP address.

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

This property is not available at design time.

Data Type

String

SubjectConfirmationDataInResponseTo Property (SAMLWriter Class)

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

Syntax

QString GetSubjectConfirmationDataInResponseTo(int iSubjectConfirmationIndex);
int SetSubjectConfirmationDataInResponseTo(int iSubjectConfirmationIndex, QString qsSubjectConfirmationDataInResponseTo);

Default Value

""

Remarks

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

This property specifies the ID of the SAML message in response to which the assertion is issued.

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

This property is not available at design time.

Data Type

String

SubjectConfirmationDataNotBefore Property (SAMLWriter Class)

Time moment before which the subject cannot be confirmed.

Syntax

QString GetSubjectConfirmationDataNotBefore(int iSubjectConfirmationIndex);
int SetSubjectConfirmationDataNotBefore(int iSubjectConfirmationIndex, QString qsSubjectConfirmationDataNotBefore);

Default Value

""

Remarks

Time moment before which the subject cannot be confirmed.

This property specifies the time before which the subject cannot be confirmed.

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

This property is not available at design time.

Data Type

String

SubjectConfirmationDataNotOnOrAfter Property (SAMLWriter Class)

Limits the time until which the subject can be confirmed.

Syntax

QString GetSubjectConfirmationDataNotOnOrAfter(int iSubjectConfirmationIndex);
int SetSubjectConfirmationDataNotOnOrAfter(int iSubjectConfirmationIndex, QString qsSubjectConfirmationDataNotOnOrAfter);

Default Value

""

Remarks

Limits the time until which the subject can be confirmed.

This property specifies the time on (or after) which the subject cannot be confirmed.

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

This property is not available at design time.

Data Type

String

SubjectConfirmationDataRecipient Property (SAMLWriter Class)

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

Syntax

QString GetSubjectConfirmationDataRecipient(int iSubjectConfirmationIndex);
int SetSubjectConfirmationDataRecipient(int iSubjectConfirmationIndex, QString qsSubjectConfirmationDataRecipient);

Default Value

""

Remarks

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

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

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

This property is not available at design time.

Data Type

String

SubjectConfirmationDataType Property (SAMLWriter Class)

The type of data contained in the confirmation.

Syntax

QString GetSubjectConfirmationDataType(int iSubjectConfirmationIndex);
int SetSubjectConfirmationDataType(int iSubjectConfirmationIndex, QString qsSubjectConfirmationDataType);

Default Value

""

Remarks

The type of data contained in the confirmation.

Use this property to read or specify the type of confirmation data included in the object.

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

This property is not available at design time.

Data Type

String

SubjectConfirmationID Property (SAMLWriter Class)

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

Syntax

QString GetSubjectConfirmationID(int iSubjectConfirmationIndex);
int SetSubjectConfirmationID(int iSubjectConfirmationIndex, QString qsSubjectConfirmationID);

Default Value

""

Remarks

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

This property specifies the identifier of the entity which is expected to satisfy the subject confirmation requirements.

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

This property is not available at design time.

Data Type

String

SubjectConfirmationMethod Property (SAMLWriter Class)

Specifies the mechanism to be used to confirm the subject.

Syntax

QString GetSubjectConfirmationMethod(int iSubjectConfirmationIndex);
int SetSubjectConfirmationMethod(int iSubjectConfirmationIndex, QString qsSubjectConfirmationMethod);

Default Value

""

Remarks

Specifies the mechanism to be used to confirm the subject.

This property contains a URI reference that identifies the mechanism to be used to confirm the subject.

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

This property is not available at design time.

Data Type

String

SubjectID Property (SAMLWriter Class)

Sets the subject of the message.

Syntax

QString GetSubjectID();
int SetSubjectID(QString qsSubjectID);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

Version Property (SAMLWriter Class)

Specifies the protocol version of the SAML message.

Syntax

QString GetVersion();
int SetVersion(QString qsVersion);

Default Value

"2.0"

Remarks

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

This property is not available at design time.

Data Type

String

AddAdviceAssertion Method (SAMLWriter Class)

Adds an advice assertion to the message.

Syntax

int AddAdviceAssertion(int iAssertionIndex);

Remarks

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

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

Error Handling

This method returns an Integer 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.

AddAssertion Method (SAMLWriter Class)

Adds assertion to a SAML message.

Syntax

int AddAssertion();

Remarks

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

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

Error Handling

This method returns an Integer 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.

ClearAssertion Method (SAMLWriter Class)

Resets the contents of all assertion-related properties.

Syntax

int ClearAssertion();

Remarks

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

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

CompareIDs Method (SAMLWriter Class)

Compares two SAML IDs.

Syntax

bool CompareIDs(const QString& qsID1, const QString& qsID2);

Remarks

This utility method compares two SAML identifiers for equality.

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 (SAMLWriter 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.

CreateNew Method (SAMLWriter Class)

Creates a new SAML message with the given type.

Syntax

int CreateNew(int iOutputType);

Remarks

Use this method to create a new SAML message with the specified content type. The following values are supported:

  • cstyNone (0)
  • cstyAssertionIDRequest (1)
  • cstySubjectQuery (2)
  • cstyAuthnQuery (3)
  • cstyAttributeQuery (4)
  • cstyAuthzDecisionQuery (5)
  • cstyAuthnRequest (6)
  • cstyManageNameIDRequest (7)
  • cstyLogoutRequest (8)
  • cstyNameIDMappingRequest (9)
  • cstyArtifactResolve (10)
  • cstyResponse (11)
Depending on the chosen content type, use properties of class to tune up the parameters of the chosen subtype. For example, if using cstyAuthnQuery as your content type, use AuthnQuery property to adjust context class references or comparison settings.

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

DoAction Method (SAMLWriter 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 (SAMLWriter Class)

Returns an element of the SAML ID.

Syntax

QString GetIDProp(const QString& qsID, const QString& qsPropName);

Remarks

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

The following ID properties are supported:

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

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.

RemoveAdvice Method (SAMLWriter Class)

Removes an advice from an assertion.

Syntax

int RemoveAdvice(int iAssertionIndex);

Remarks

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

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

RemoveAdviceAssertion Method (SAMLWriter Class)

Removes an advice from an assertion.

Syntax

int RemoveAdviceAssertion(int iAssertionIndex, int iAdviceAssertionIndex);

Remarks

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

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

RemoveAllAssertions Method (SAMLWriter Class)

Removes all assertions currently configured in the message.

Syntax

int RemoveAllAssertions();

Remarks

Use this message to remove all assertions currently set up in the SAML 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.)

RemoveAssertion Method (SAMLWriter Class)

Removes an assertion from the message.

Syntax

int RemoveAssertion(int iAssertionIndex);

Remarks

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

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

Save Method (SAMLWriter Class)

Saves the configured message to a string.

Syntax

QString Save();

Remarks

Use this method to save the created SAML message to 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.

SaveBytes Method (SAMLWriter Class)

Saves the configured message to a byte array.

Syntax

QByteArray SaveBytes();

Remarks

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

Error Handling

This method returns a Byte Array 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.

SaveFile Method (SAMLWriter Class)

Saves the configured message to a file.

Syntax

int SaveFile(const QString& qsFileName);

Remarks

Use this method to save the created SAML message to 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.)

Error Event (SAMLWriter Class)

Fires to report an error condition.

Syntax

class SAMLWriterErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Error(SAMLWriterErrorEventParams *e);
// Or, subclass SAMLWriter and override this emitter function. virtual int FireError(SAMLWriterErrorEventParams *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 (SAMLWriter Class)

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

Syntax

class SAMLWriterNotificationEventParams {
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(SAMLWriterNotificationEventParams *e);
// Or, subclass SAMLWriter and override this emitter function. virtual int FireNotification(SAMLWriterNotificationEventParams *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.

Configuration Settings (SAMLWriter Class)

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

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

SigAfterIssuer:   Specifies whether to insert the signature after the issuer tag in the SAML document.

Use this setting to tune up the location of the signature tag in the resulting document. The default value is true.

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:

offNo caching (default)
localLocal caching (supported for HTTPClient, RESTClient and SOAPClient only)
globalGlobal caching

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:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (supported for VCL for Windows and .Net)

LogDetails:   Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll details

LogFile:   Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters:   Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

exclude-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude a method specified in the value

LogFlushMode:   Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel:   Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore detailed information.

LogMaxEventCount:   Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode:   Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength:   Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth:   Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm:   Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

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.

Trappable Errors (SAMLWriter Class)

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2022 Qt Edition - Version 22.0 [Build 8214]