# SAMLWriter Class
The SAMLWriter class offers SAML message generation functions.
## Syntax
```text
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 requests, responses, assertions, and statements. You can use it as part of your SAML client or SAML server implementation for creating individual SAML entities.
SAMLReader and SAMLWriter are independent of SAML server controls that are also included in SecureBlackbox, and are aimed at scenarios that require lower-level access to SAML functionality than that provided by the server controls.
SAMLWriter can create the following kinds of SAML messages:
- AssertionIDRequest
- SubjectQuery
- AuthnQuery
- AttributeQuery
- AuthzDecisionQuery
- AuthnRequest
- ManageNameIDRequest
- LogoutRequest
- NameIDMappingRequest
- ArtifactResolve
- Response
Please find below a quick-and-dirty example of the use of SAMLWriter class for creating a signed AuthnRequest message:
```text
Samlwriter writer = new Samlwriter();
// configuring general message properties
writer.Destination = "http://destination-url.com";
writer.IssueInstant = DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ss.fffZ");
writer.Issuer = "Value=https://issuer-url.com;Format=urn:oasis:names:tc:SAML:2.0:nameid-format:entity;IDType=Issuer";
// configuring general AuthnRequest properties
writer.AuthnRequest.IsPassive = false;
writer.AuthnRequest.UseIsPassive = true;
writer.AuthnRequest.ForceAuthn = true;
writer.AuthnRequest.ProtocolBinding = "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST";
writer.AuthnRequest.AssertionConsumerServiceURL = "https://assertion-consumer-url.com";
writer.AuthnRequest.AttributeConsumingServiceIndex = 1;
writer.AuthnRequest.NameIDPolicyAllowCreate = false;
writer.AuthnRequest.NameIDPolicyFormat = "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent";
writer.AuthnRequest.ConditionsNotBefore = DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ss.fffZ");
writer.AuthnRequest.ConditionsNotOnOrAfter = DateTime.UtcNow.AddMinutes(30).ToString("yyyy-MM-ddTHH:mm:ss.fffZ");
// adjusting request conditions if required
SAMLAssertionCondition cond = new SAMLAssertionCondition();
cond.ConditionType = SAMLConditionTypes.csctOneTimeUse;
writer.AuthnRequestConditions.Add(cond);
// configuring signing properties
Certificate certificate = new Certificate("C:\\Certs\\samlCert.pfx", "password");
writer.Sign = true;
writer.SigningCertificate = certificate;
// creating the SAML entity of the required type
writer.CreateNew((int)SamlwriterOutputTypes.cstyAuthnRequest);
// adjusting low-level signature parameters
writer.Config("SigDigestMethod=http://www.w3.org/2001/04/xmlenc#sha256");
writer.Config("SigMethod=http://www.w3.org/2001/04/xmldsig-more#rsa-sha256");
// signing the request and serializing it to XML
string request = writer.Save();
```
The above code produces the following AuthnRequest:
```text
https://issuer-url.com
+xhhgXtwYN0/r9h7WAwg=
jfYeIq/z8D1tJZYbVqDMoqKpdrfGMj8/zI7gbUsJbECAr00cN34md2QG0mo4cOx7pny+5
Tht7tUzqENHqcZdmlOcZc2JcJqokVxIcLEluFiWKlNjpexkXFQKzOC1peRfTZm8SQTqtP
Cz8IknLUc6Scfml29PHmks1PxjJDteGb/+FggsZRTGZC3a05nvH3ayvHukPeHuHssx5dX
nj0quT8salR6fdx6lAJo/AnDHzcfBNyxAMn+ebk5VOOgVD1L3PayvXib/maj8aVI2I5UT
o4vmfybTWKzeS8DX9We7UV+4Xowwe647t1A912xLVub/e23A18Yf1V0PXC87kttTkA==
MIIEKDCCAxCgAwIBAgIFYA3A3gIwDQYJKoZIhvcNAQELBQAwfjELMAkGA1UEBhMCVVMxC
zAJBgNVBAgTAk5DMRQwEgYDVQQHEwtDaGFwZWwgSGlsbDEiMCAGCSqGSIb3DQEJARMTc2
FsZXNAbnNvZnR3YXJlLmNvbTEoMCYGA1UEAxMfU2VjdXJlQmxhY2tib3ggRGVtbyBDZXJ
0aWZpY2F0ZTAeFw0xNzA5MDEwMDAwMDBaFw0yMjA5MDEwMDAwMDBaMH4xCzAJBgNVBAYT
AlVTMQswCQYDVQQIEwJOQzEUMBIGA1UEBxMLQ2hhcGVsIEhpbGwxIjAgBgkqhkiG9w0BC
QETE3NhbGVzQG5zb2Z0d2FyZS5jb20xKDAmBgNVBAMTH1NlY3VyZUJsYWNrYm94IERlbW
8gQ2VydGlmaWNhdGUwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCfAVIcq9o
eoIbw56LsPjxWsX3YGkqasBQzgQymhfcDZeSvFKFis8iqArGLTUUWOaImO5t2UmjIa+4n
YP39hb9Z1r0CMy53p83oYbbZZ7qMeji0pMAufJHqKCN8t2HNWf2HE8S9UOU7R/UHdrSAN
JitBKV9lSG9f450yWoGNwt35ZCsOp0zqtCgvkEvteGsz01R5DDjOccs3QNu25K/Sf27KP
CYabS6A1ehYNY/G32qoKNJhu3DN4bWje57gBWi9WSfQ3tZUOV5q2ozaNJA78Wl4fXC6RB
CaBh0GOwXeyZoH13LJdn+lqlCSMz024ImG4yFQEENbWvE9Elku8RYTn73AgMBAAGjgaww
gakwHwYDVR0jBBgwFoAUmt/L7GI1SH36Sp8EUBxTwuzSgqMwHQYDVR0OBBYEFJrfy+xiN
Uh9+kqfBFAcU8Ls0oKjMA8GA1UdEwEB/wQFMAMBAf8wDwYDVR0PAQH/BAUDAwDuADBFBg
NVHSUEPjA8BggrBgEFBQcDAQYIKwYBBQUHAwIGCCsGAQUFBwMDBggrBgEFBQcDBAYIKwY
BBQUHAwgGCCsGAQUFBwMJMA0GCSqGSIb3DQEBCwUAA4IBAQBovHBbMsW/k/5iuLQQqsYS
ng5X2iy1W+5BRb1hz0MGnHGLqJWy1ty5+bTo6g/zvT65dXIPIexLkInEenYSy75Lthr6a
ewUcvwfl1TYXjWlMD5Nm5pM9As71+XsGSdYGXoKohbEzbT6RDByjwR+yxtatqko7e1Eg6
InNJRTRt7al/63FSPEgSCqOX6asDVDNZ83db0dOcoeaPEiDz3liE3+tYHtKXj5/qwTtYd
aqBZxdJfuCKZveEFe1DO3/ayDvIvG9Eme+rEjntErF+Cw9a8ukesvDuT49cRE9oTs3O7f
6LUbhCv5zJN+dTFr75NSdWdp4yvn3nK3i2udeMnTWK0U
```
Note that you need to set the signing certificate before calling [CreateNew](#createnew-method-samlwriter-class).
## Property List
*The following is the full list of the properties of the class with short descriptions. Click on the links for further details.*
| | |
| --- | --- |
| [Artifact](#artifact-property-samlwriter-class) | Provides access to the Artifact element of the message. |
| [ArtifactResolveQuery](#artifactresolvequery-property-samlwriter-class) | Contains the artifact resolve query. |
| [Assertion](#assertion-property-samlwriter-class) | Contains assertion information. |
| [AssertionCount](#assertioncount-property-samlwriter-class) | Returns the number of assertions in the message. |
| [Attributes](#attributes-property-samlwriter-class) | Contains a list of attributes to be added to the created object. |
| [AuthnQuery](#authnquery-property-samlwriter-class) | Provides access to the AuthnQuery SAML element. |
| [AuthnRequest](#authnrequest-property-samlwriter-class) | Publishes the properties of AuthnRequest element. |
| [AuthzDecisionQuery](#authzdecisionquery-property-samlwriter-class) | Provides access to AuthzDecisionQuery element. |
| [Binding](#binding-property-samlwriter-class) | Provides access to the binding settings. |
| [BindingKey](#bindingkey-property-samlwriter-class) | Contains a private key to sign the redirect binding requests. |
| [Conditions](#conditions-property-samlwriter-class) | Contains a list of conditions for the created SAML object. |
| [EncryptionCertificate](#encryptioncertificate-property-samlwriter-class) | Sets the encryption certificate. |
| [FIPSMode](#fipsmode-property-samlwriter-class) | Reserved. |
| [LogoutRequest](#logoutrequest-property-samlwriter-class) | Contains the properties of SAML LogoutRequest element. |
| [ManageNameIDRequest](#managenameidrequest-property-samlwriter-class) | Provides access to ManageNameIDRequest element. |
| [Message](#message-property-samlwriter-class) | Provides access to the Message element of the message. |
| [NameIDMappingRequest](#nameidmappingrequest-property-samlwriter-class) | Publishes the properties of NameIDMappingRequest entity. |
| [Profile](#profile-property-samlwriter-class) | Specifies a pre-defined profile to apply when creating the signature. |
| [References](#references-property-samlwriter-class) | Contains the References entry of the SAML AssertionIDRequest message. |
| [Response](#response-property-samlwriter-class) | Provides access to the SAML response object properties. |
| [ScopingIDPs](#scopingidps-property-samlwriter-class) | Provides access to the list of scoping IDP elements. |
| [Security](#security-property-samlwriter-class) | Provides access to the SAML security properties. |
| [SigningCertificate](#signingcertificate-property-samlwriter-class) | The certificate to be used for signing. |
| [SigningChain](#signingchain-property-samlwriter-class) | The signing certificate chain. |
| [Statements](#statements-property-samlwriter-class) | Contains a list of assertion statements. |
| [SubjectConfirmations](#subjectconfirmations-property-samlwriter-class) | Provides access to the list of subject confirmation elements. |
## Method List
*The following is the full list of the methods of the class with short descriptions. Click on the links for further details.*
| | |
| --- | --- |
| [AddAttribute](#addattribute-method-samlwriter-class) | Adds an attribute to an existing attribute statement. |
| [AddAttributeStatement](#addattributestatement-method-samlwriter-class) | Adds an attribute statement to the assertion. |
| [AddAuthnStatement](#addauthnstatement-method-samlwriter-class) | Adds an authentication statement to the assertion. |
| [AddAuthzDecisionStatement](#addauthzdecisionstatement-method-samlwriter-class) | Adds an authorization decision statement to the assertion. |
| [AddCondition](#addcondition-method-samlwriter-class) | Adds a condition to the object (assertion or authn request) being edited. |
| [AddScopingIDP](#addscopingidp-method-samlwriter-class) | Adds a scoping IDP to the object being currently edited. |
| [AddSubjectConfirmation](#addsubjectconfirmation-method-samlwriter-class) | Adds a subject confirmation to the object being edited. |
| [BeginAssertion](#beginassertion-method-samlwriter-class) | Initiates the process of creating a new assertion. |
| [CompleteAssertion](#completeassertion-method-samlwriter-class) | Adds a completed assertion to a SAML message. |
| [Config](#config-method-samlwriter-class) | Sets or retrieves a configuration setting. |
| [CreateNew](#createnew-method-samlwriter-class) | Creates a new SAML message with the given type. |
| [DoAction](#doaction-method-samlwriter-class) | Performs an additional action. |
| [FormatID](#formatid-method-samlwriter-class) | Formats a SAML ID in the form in which it can be assigned to the Issuer or Subject fields. |
| [Reset](#reset-method-samlwriter-class) | Resets the class settings. |
| [Save](#save-method-samlwriter-class) | Saves the configured message to a string. |
| [SaveBytes](#savebytes-method-samlwriter-class) | Saves the configured message to a byte array. |
| [SaveFile](#savefile-method-samlwriter-class) | Saves the configured message to a file. |
| [SaveStream](#savestream-method-samlwriter-class) | Saves the configured message to a stream. |
## Event List
*The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.*
| | |
| --- | --- |
| [Error](#error-event-samlwriter-class) | Fires to report an error condition. |
| [Notification](#notification-event-samlwriter-class) | This event notifies the application about an underlying control flow event. |
## Config Settings
*The following is a list of config settings for the class with short descriptions. Click on the links for further details.*
| | |
| --- | --- |
| [BodyOnly](#BodyOnly) | TBD. |
| [DateTimeFormat](#DateTimeFormat) | TBD. |
| [KeyDataElements](#KeyDataElements) | TBD. |
| [SAMLPrefix](#SAMLPrefix) | TBD. |
| [SAMLProtocolPrefix](#SAMLProtocolPrefix) | TBD. |
| [SigAfterIssuer](#SigAfterIssuer) | Specifies whether to insert the signature after the issuer tag in the SAML document. |
| [SigCanonicalizationMethod](#SigCanonicalizationMethod) | TBD. |
| [SigDigestMethod](#SigDigestMethod) | TBD. |
| [SigMethod](#SigMethod) | TBD. |
| [TimeZoneOffset](#TimeZoneOffset) | TBD. |
| [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. |
| [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. |
| [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| [Cookies](#Cookies) | Gets or sets local cookies for the class. |
| [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. |
| [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. |
| [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. |
| [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. |
| [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. |
| [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. |
| [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. |
| [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. |
| [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. |
| [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. |
| [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. |
| [LogDestination](#LogDestination) | Specifies the debug log destination. |
| [LogDetails](#LogDetails) | Specifies the debug log details to dump. |
| [LogFile](#LogFile) | Specifies the debug log filename. |
| [LogFilters](#LogFilters) | Specifies the debug log filters. |
| [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. |
| [LogLevel](#LogLevel) | Specifies the debug log level. |
| [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. |
| [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. |
| [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. |
| [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. |
| [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. |
| [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. |
| [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. |
| [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. |
| [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. |
| [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. |
| [Tag](#Tag) | Allows to store any custom data. |
| [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. |
| [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. |
| [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. |
| [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. |
| [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. |
| [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. |
| [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. |
| [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. |
| [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. |
| [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. |
| [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. |
| [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. |
| [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. |
# Artifact Property ([SAMLWriter](#samlwriter-class) Class)
Provides access to the Artifact element of the message.
## Syntax
```text
SecureBlackboxSAMLArtifact* GetArtifact();
int SetArtifact(SecureBlackboxSAMLArtifact* val);
```
## Remarks
Use this property to access and adjust the Artifact element of the created SAML message.
This property is not available at design time.
## Data Type
[SecureBlackboxSAMLArtifact](#samlartifact-type)
# ArtifactResolveQuery Property ([SAMLWriter](#samlwriter-class) Class)
Contains the artifact resolve query.
## Syntax
```text
ANSI (Cross Platform)
char* GetArtifactResolveQuery();int SetArtifactResolveQuery(const char* lpszArtifactResolveQuery);
Unicode (Windows)
LPWSTR GetArtifactResolveQuery();INT SetArtifactResolveQuery(LPCWSTR lpszArtifactResolveQuery);
```
## 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
# Assertion Property ([SAMLWriter](#samlwriter-class) Class)
Contains assertion information.
## Syntax
```text
SecureBlackboxSAMLAssertion* GetAssertion();
```
## Remarks
Use this property to access and/or modify the SAML assertion information.
This property is read-only and not available at design time.
## Data Type
[SecureBlackboxSAMLAssertion](#samlassertion-type)
# AssertionCount Property ([SAMLWriter](#samlwriter-class) Class)
Returns the number of assertions in the message.
## Syntax
```text
ANSI (Cross Platform)
int GetAssertionCount();
Unicode (Windows)
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
# Attributes Property ([SAMLWriter](#samlwriter-class) Class)
Contains a list of attributes to be added to the created object.
## Syntax
```text
SecureBlackboxList* GetAttributes();
int SetAttributes(SecureBlackboxList* val);
```
## Remarks
Use this property to configure the list of assertion or request attributes for the SAML message being created.
This property is not available at design time.
## Data Type
[SecureBlackboxSAMLAttribute](#samlattribute-type)
# AuthnQuery Property ([SAMLWriter](#samlwriter-class) Class)
Provides access to the AuthnQuery SAML element.
## Syntax
```text
SecureBlackboxSAMLAuthnQuery* GetAuthnQuery();
```
## Remarks
Use this property to access the details of the authentication query element.
This property is read-only and not available at design time.
## Data Type
[SecureBlackboxSAMLAuthnQuery](#samlauthnquery-type)
# AuthnRequest Property ([SAMLWriter](#samlwriter-class) Class)
Publishes the properties of AuthnRequest element.
## Syntax
```text
SecureBlackboxSAMLAuthnRequest* GetAuthnRequest();
```
## Remarks
Use this property to access the details of the authentication request element.
This property is read-only and not available at design time.
## Data Type
[SecureBlackboxSAMLAuthnRequest](#samlauthnrequest-type)
# AuthzDecisionQuery Property ([SAMLWriter](#samlwriter-class) Class)
Provides access to AuthzDecisionQuery element.
## Syntax
```text
SecureBlackboxSAMLAuthzDecisionQuery* GetAuthzDecisionQuery();
```
## Remarks
Use this property to configure the details of Authorization Decision Query element.
This property is read-only and not available at design time.
## Data Type
[SecureBlackboxSAMLAuthzDecisionQuery](#samlauthzdecisionquery-type)
# Binding Property ([SAMLWriter](#samlwriter-class) Class)
Provides access to the binding settings.
## Syntax
```text
SecureBlackboxSAMLBinding* GetBinding();
```
## Remarks
Use this property to configure the binding settings to be use for the output message.
This property is read-only and not available at design time.
## Data Type
[SecureBlackboxSAMLBinding](#samlbinding-type)
# BindingKey Property ([SAMLWriter](#samlwriter-class) Class)
Contains a private key to sign the redirect binding requests.
## Syntax
```text
SecureBlackboxCryptoKey* GetBindingKey();
int SetBindingKey(SecureBlackboxCryptoKey* val);
```
## Remarks
Use this property to set the signing key for the redirect binding object. This is used to sign the content of the redirect binding.
Note that when using the redirect binding, the outgoing SAML message must not be signed in parallel with a certificate. Any assertions may still be signed.
This property is not available at design time.
## Data Type
[SecureBlackboxCryptoKey](#cryptokey-type)
# Conditions Property ([SAMLWriter](#samlwriter-class) Class)
Contains a list of conditions for the created SAML object.
## Syntax
```text
SecureBlackboxList* GetConditions();
int SetConditions(SecureBlackboxList* val);
```
## Remarks
Use this property to tune-up assertion conditions to be included in the SAML entity being created, such as an assertion or AuthnRequest.
This property is not available at design time.
## Data Type
[SecureBlackboxSAMLCondition](#samlcondition-type)
# EncryptionCertificate Property ([SAMLWriter](#samlwriter-class) Class)
Sets the encryption certificate.
## Syntax
```text
SecureBlackboxCertificate* GetEncryptionCertificate();
int SetEncryptionCertificate(SecureBlackboxCertificate* val);
```
## Remarks
Use this property to specify the encryption certificate for encrypted requests.
This property is not available at design time.
## Data Type
[SecureBlackboxCertificate](#certificate-type)
# FIPSMode Property ([SAMLWriter](#samlwriter-class) Class)
Reserved.
## Syntax
```text
ANSI (Cross Platform)
int GetFIPSMode();int SetFIPSMode(int bFIPSMode);
Unicode (Windows)
BOOL GetFIPSMode();INT SetFIPSMode(BOOL bFIPSMode);
```
## Default Value
FALSE
## Remarks
This property is reserved for future use.
## Data Type
Boolean
# LogoutRequest Property ([SAMLWriter](#samlwriter-class) Class)
Contains the properties of SAML LogoutRequest element.
## Syntax
```text
SecureBlackboxSAMLLogoutRequest* GetLogoutRequest();
```
## Remarks
Use this property to access the settings of the LogoutRequest element.
This property is read-only and not available at design time.
## Data Type
[SecureBlackboxSAMLLogoutRequest](#samllogoutrequest-type)
# ManageNameIDRequest Property ([SAMLWriter](#samlwriter-class) Class)
Provides access to ManageNameIDRequest element.
## Syntax
```text
SecureBlackboxSAMLManageNameIDRequest* GetManageNameIDRequest();
```
## Remarks
Use this property to access the details of ManageNameIDRequest element.
This property is read-only and not available at design time.
## Data Type
[SecureBlackboxSAMLManageNameIDRequest](#samlmanagenameidrequest-type)
# Message Property ([SAMLWriter](#samlwriter-class) Class)
Provides access to the Message element of the message.
## Syntax
```text
SecureBlackboxSAMLMessage* GetMessage();
```
## Remarks
Use this property to access the core properties of the SAML message.
This property is read-only and not available at design time.
## Data Type
[SecureBlackboxSAMLMessage](#samlmessage-type)
# NameIDMappingRequest Property ([SAMLWriter](#samlwriter-class) Class)
Publishes the properties of NameIDMappingRequest entity.
## Syntax
```text
SecureBlackboxSAMLNameIDMappingRequest* GetNameIDMappingRequest();
```
## Remarks
Use this property to access the details of SAML NameIDMappingRequest entity.
This property is read-only and not available at design time.
## Data Type
[SecureBlackboxSAMLNameIDMappingRequest](#samlnameidmappingrequest-type)
# Profile Property ([SAMLWriter](#samlwriter-class) Class)
Specifies a pre-defined profile to apply when creating the signature.
## Syntax
```text
ANSI (Cross Platform)
char* GetProfile();int SetProfile(const char* lpszProfile);
Unicode (Windows)
LPWSTR GetProfile();INT SetProfile(LPCWSTR lpszProfile);
```
## 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
# References Property ([SAMLWriter](#samlwriter-class) Class)
Contains the References entry of the SAML AssertionIDRequest message.
## Syntax
```text
ANSI (Cross Platform)
char* GetReferences();int SetReferences(const char* lpszReferences);
Unicode (Windows)
LPWSTR GetReferences();INT SetReferences(LPCWSTR lpszReferences);
```
## Default Value
""
## Remarks
Use this property to read or specify the value of the References entry of the AssertionIDRequest message.
This property is not available at design time.
## Data Type
String
# Response Property ([SAMLWriter](#samlwriter-class) Class)
Provides access to the SAML response object properties.
## Syntax
```text
SecureBlackboxSAMLResponse* GetResponse();
```
## Remarks
Use this property to access the parameters of a SAML response object.
This property is read-only and not available at design time.
## Data Type
[SecureBlackboxSAMLResponse](#samlresponse-type)
# ScopingIDPs Property ([SAMLWriter](#samlwriter-class) Class)
Provides access to the list of scoping IDP elements.
## Syntax
```text
SecureBlackboxList* GetScopingIDPs();
int SetScopingIDPs(SecureBlackboxList* val);
```
## Remarks
Use this property to set up the collection of scoping IDP entry list for the prepared SAML request.
This property is not available at design time.
## Data Type
[SecureBlackboxSAMLIDPEntry](#samlidpentry-type)
# Security Property ([SAMLWriter](#samlwriter-class) Class)
Provides access to the SAML security properties.
## Syntax
```text
SecureBlackboxSAMLSecuritySettings* GetSecurity();
```
## Remarks
Use this property to access the security parameters of the edited SAML message.
This property is read-only and not available at design time.
## Data Type
[SecureBlackboxSAMLSecuritySettings](#samlsecuritysettings-type)
# SigningCertificate Property ([SAMLWriter](#samlwriter-class) Class)
The certificate to be used for signing.
## Syntax
```text
SecureBlackboxCertificate* GetSigningCertificate();
int SetSigningCertificate(SecureBlackboxCertificate* val);
```
## Remarks
Use this property to specify the certificate that shall be used for signing the data. Note that this certificate should have a private key associated with it. Use [SigningChain](#signingchain-property-samlwriter-class) to supply the rest of the certificate chain for inclusion into the signature.
This property is not available at design time.
## Data Type
[SecureBlackboxCertificate](#certificate-type)
# SigningChain Property ([SAMLWriter](#samlwriter-class) Class)
The signing certificate chain.
## Syntax
```text
SecureBlackboxList* GetSigningChain();
int SetSigningChain(SecureBlackboxList* val);
```
## Remarks
Use this property to provide the chain for the signing certificate. Use the [SigningCertificate](#signingcertificate-property-samlwriter-class) property, if it is available, to provide the signing certificate itself.
This property is not available at design time.
## Data Type
[SecureBlackboxCertificate](#certificate-type)
# Statements Property ([SAMLWriter](#samlwriter-class) Class)
Contains a list of assertion statements.
## Syntax
```text
SecureBlackboxList* GetStatements();
int SetStatements(SecureBlackboxList* val);
```
## Remarks
Use this property to access or set the list of assertion statements.
This property is not available at design time.
## Data Type
[SecureBlackboxSAMLAssertionStatement](#samlassertionstatement-type)
# SubjectConfirmations Property ([SAMLWriter](#samlwriter-class) Class)
Provides access to the list of subject confirmation elements.
## Syntax
```text
SecureBlackboxList* GetSubjectConfirmations();
int SetSubjectConfirmations(SecureBlackboxList* val);
```
## Remarks
Use this property to access the list of subject confirmation elements.
This property is not available at design time.
## Data Type
[SecureBlackboxSAMLSubjectConfirmation](#samlsubjectconfirmation-type)
# AddAttribute Method ([SAMLWriter](#samlwriter-class) Class)
Adds an attribute to an existing attribute statement.
## Syntax
```text
ANSI (Cross Platform)
int AddAttribute(const char* lpszAttributeName, const char* lpszAttributeValue, const char* lpszNameFormat, const char* lpszContentType, int iStatementIndex);
Unicode (Windows)
INT AddAttribute(LPCWSTR lpszAttributeName, LPCWSTR lpszAttributeValue, LPCWSTR lpszNameFormat, LPCWSTR lpszContentType, INT iStatementIndex);
```
## Remarks
Use this method to add an attribute to an attribute statement. The method returns the index of the newly added attribute in the statement.
Use the method parameters to provide the parameters of the new attribute:
```text
NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"
>
>test
```
Note: if *StatementIndex* is set to -1, the attribute will be added to the last attribute statement in the collection. If no attribute statements are available in the collection, one will be created automatically.
If *StatementIndex* exceeds the index of the last statement in the [Statements](#statements-property-samlwriter-class) collection, a new attribute statement will be created (even if there are other attribute statements in the list), and the attribute added to it.
If *StatementIndex* points to an existing statement but that statement is not an attribute statement, an exception will be thrown.
## Error Handling (C++)
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.
# AddAttributeStatement Method ([SAMLWriter](#samlwriter-class) Class)
Adds an attribute statement to the assertion.
## Syntax
```text
ANSI (Cross Platform)
int AddAttributeStatement();
Unicode (Windows)
INT AddAttributeStatement();
```
## Remarks
Use this method to add an attribute statement to the currently edited assertion. The method returns the index of the newly added statement in the [Statements](#statements-property-samlwriter-class) collection.
Note that a call to [AddAttribute](#addattribute-method-samlwriter-class) adds a new attribute statement behind the scenes if no attribute statements have been added by that time.
## Error Handling (C++)
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.
# AddAuthnStatement Method ([SAMLWriter](#samlwriter-class) Class)
Adds an authentication statement to the assertion.
## Syntax
```text
ANSI (Cross Platform)
int AddAuthnStatement(const char* lpszAuthnInstant, const char* lpszSessionIndex, const char* lpszNotOnOrAfter, const char* lpszClassRef);
Unicode (Windows)
INT AddAuthnStatement(LPCWSTR lpszAuthnInstant, LPCWSTR lpszSessionIndex, LPCWSTR lpszNotOnOrAfter, LPCWSTR lpszClassRef);
```
## Remarks
Use this method to add an authentication statement to the currently edited assertion. The method returns the index of the newly added statement in the [Statements](#statements-property-samlwriter-class) collection.
## Error Handling (C++)
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.
# AddAuthzDecisionStatement Method ([SAMLWriter](#samlwriter-class) Class)
Adds an authorization decision statement to the assertion.
## Syntax
```text
ANSI (Cross Platform)
int AddAuthzDecisionStatement(int iDecision, const char* lpszEvidence, const char* lpszResource, const char* lpszActions);
Unicode (Windows)
INT AddAuthzDecisionStatement(INT iDecision, LPCWSTR lpszEvidence, LPCWSTR lpszResource, LPCWSTR lpszActions);
```
## Remarks
Use this method to add an authorization decision statement to the currently edited assertion. The method returns the index of the newly added statement in the [Statements](#statements-property-samlwriter-class) collection.
## Error Handling (C++)
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.
# AddCondition Method ([SAMLWriter](#samlwriter-class) Class)
Adds a condition to the object (assertion or authn request) being edited.
## Syntax
```text
ANSI (Cross Platform)
int AddCondition(int iConditionType, const char* lpszConditionValue);
Unicode (Windows)
INT AddCondition(INT iConditionType, LPCWSTR lpszConditionValue);
```
## Remarks
Use this method to quickly add a condition to the SAML object you are creating.
## Error Handling (C++)
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.
# AddScopingIDP Method ([SAMLWriter](#samlwriter-class) Class)
Adds a scoping IDP to the object being currently edited.
## Syntax
```text
ANSI (Cross Platform)
int AddScopingIDP(const char* lpszName, const char* lpszProviderID, const char* lpszLoc);
Unicode (Windows)
INT AddScopingIDP(LPCWSTR lpszName, LPCWSTR lpszProviderID, LPCWSTR lpszLoc);
```
## Remarks
Use this method to quickly add a scoping IDP to the SAML object you are creating. The method returns the index of the new element in the [ScopingIDPs](#scopingidps-property-samlwriter-class) collection.
## Error Handling (C++)
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.
# AddSubjectConfirmation Method ([SAMLWriter](#samlwriter-class) Class)
Adds a subject confirmation to the object being edited.
## Syntax
```text
ANSI (Cross Platform)
int AddSubjectConfirmation(const char* lpszMethod, const char* lpszAddress, const char* lpszRecipient, const char* lpszInResponseTo, const char* lpszNotBefore, const char* lpszNotOnOrAfter, const char* lpszID, const char* lpszDataType, const char* lpszData);
Unicode (Windows)
INT AddSubjectConfirmation(LPCWSTR lpszMethod, LPCWSTR lpszAddress, LPCWSTR lpszRecipient, LPCWSTR lpszInResponseTo, LPCWSTR lpszNotBefore, LPCWSTR lpszNotOnOrAfter, LPCWSTR lpszID, LPCWSTR lpszDataType, LPCWSTR lpszData);
```
## Remarks
Use this method to quickly add a subject confirmation to the SAML object you are creating. The method returns the index of the new subject confirmation in the list.
## Error Handling (C++)
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.
# BeginAssertion Method ([SAMLWriter](#samlwriter-class) Class)
Initiates the process of creating a new assertion.
## Syntax
```text
ANSI (Cross Platform)
int BeginAssertion();
Unicode (Windows)
INT BeginAssertion();
```
## Remarks
This method resets the contents of all assertion-related properties and prepares the component for creating a new assertion.
Use the methods and properties of the component, such as [Assertion](#assertion-property-samlwriter-class), as well as [Statements](#statements-property-samlwriter-class) and [Attributes](#attributes-property-samlwriter-class) to prepare the new assertion. When ready, call [CompleteAssertion](#completeassertion-method-samlwriter-class) to commit the provided details to the message.
## Error Handling (C++)
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.)
# CompleteAssertion Method ([SAMLWriter](#samlwriter-class) Class)
Adds a completed assertion to a SAML message.
## Syntax
```text
ANSI (Cross Platform)
int CompleteAssertion();
Unicode (Windows)
INT CompleteAssertion();
```
## Remarks
Use this method to commit an assertion to the SAML message being created. Before calling this method, prepare the assertion by calling [BeginAssertion](#beginassertion-method-samlwriter-class) and filling in the details via the [Assertion](#assertion-property-samlwriter-class), [Attributes](#attributes-property-samlwriter-class), and [Statements](#statements-property-samlwriter-class) properties.
The method returns the index of the new assertion in the list.
## Error Handling (C++)
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.
# Config Method ([SAMLWriter](#samlwriter-class) Class)
Sets or retrieves a configuration setting.
## Syntax
```text
ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);
Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
```
## Remarks
Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-samlwriter-class) for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the Config method.
To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a [configuration setting](#config-settings-samlwriter-class), you must call *Config("PROPERTY")*. The value will be returned as a string.
## Error Handling (C++)
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](#samlwriter-class) Class)
Creates a new SAML message with the given type.
## Syntax
```text
ANSI (Cross Platform)
int CreateNew(int iContentType);
Unicode (Windows)
INT CreateNew(INT iContentType);
```
## 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)
- cstyAssertion (12)
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](#authnquery-property-samlwriter-class) property to adjust context class references or comparison settings.
## Error Handling (C++)
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](#samlwriter-class) Class)
Performs an additional action.
## Syntax
```text
ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);
Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);
```
## Remarks
DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier (case insensitive) of the action is provided in the *ActionID* parameter.
*ActionParams* contains the value of a single parameter, or a list of multiple parameters for the action in the form of *PARAM1=VALUE1;PARAM2=VALUE2;...*.
Common ActionIDs:
| | | | |
| --- | --- | --- | --- |
| Action | Parameters | Returned value | Description |
| ResetTrustedListCache | none | none | Clears the cached list of trusted lists. |
| ResetCertificateCache | none | none | Clears the cached certificates. |
| ResetCRLCache | none | none | Clears the cached CRLs. |
| ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. |
## Error Handling (C++)
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.
# FormatID Method ([SAMLWriter](#samlwriter-class) Class)
Formats a SAML ID in the form in which it can be assigned to the Issuer or Subject fields.
## Syntax
```text
ANSI (Cross Platform)
char* FormatID(const char* lpszValue, const char* lpszIDType, const char* lpszFormat, const char* lpszNameQualifier, const char* lpszSPNameQualifier, const char* lpszSPProvidedID);
Unicode (Windows)
LPWSTR FormatID(LPCWSTR lpszValue, LPCWSTR lpszIDType, LPCWSTR lpszFormat, LPCWSTR lpszNameQualifier, LPCWSTR lpszSPNameQualifier, LPCWSTR lpszSPProvidedID);
```
## Remarks
This is a utility method that simplifies formatting of SAML IDs. Pass the components of the SAML ID to this method, and assign the resulting string to the required property.
Example:
```text
// you can provide some of the values; the optional values will be omitted from the output
writer.Issuer = writer.FormatID("https://saml.mysite.com", "Issuer", "urn:oasis:names:tc:SAML:2.0:nameid-format:entity", "", "", "");
// this call will just return the bare value, with no attributes
writer.Issuer = writer.FormatID("https://saml.mysite.com", "", "", "", "", "");
```
## Error Handling (C++)
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.
# Reset Method ([SAMLWriter](#samlwriter-class) Class)
Resets the class settings.
## Syntax
```text
ANSI (Cross Platform)
int Reset();
Unicode (Windows)
INT Reset();
```
## Remarks
Reset is a generic method available in every class.
## Error Handling (C++)
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](#samlwriter-class) Class)
Saves the configured message to a string.
## Syntax
```text
ANSI (Cross Platform)
char* Save();
Unicode (Windows)
LPWSTR Save();
```
## Remarks
Use this method to save the created SAML message to a string.
## Error Handling (C++)
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](#samlwriter-class) Class)
Saves the configured message to a byte array.
## Syntax
```text
ANSI (Cross Platform)
char* SaveBytes(int *lpSize = NULL);
Unicode (Windows)
LPSTR SaveBytes(LPINT lpSize = NULL);
```
## Remarks
Use this method to save the formed SAML message to a byte array.
## Error Handling (C++)
This method returns a Byte Array value (with length *lpSize*); 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](#samlwriter-class) Class)
Saves the configured message to a file.
## Syntax
```text
ANSI (Cross Platform)
int SaveFile(const char* lpszFileName);
Unicode (Windows)
INT SaveFile(LPCWSTR lpszFileName);
```
## Remarks
Use this method to save the created SAML message to a file.
## Error Handling (C++)
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.)
# SaveStream Method ([SAMLWriter](#samlwriter-class) Class)
Saves the configured message to a stream.
## Syntax
```text
ANSI (Cross Platform)
int SaveStream(SecureBlackboxStream* sOutStream);
Unicode (Windows)
INT SaveStream(SecureBlackboxStream* sOutStream);
```
## Remarks
Use this method to save the prepared SAML message to a stream.
## Error Handling (C++)
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](#samlwriter-class) Class)
Fires to report an error condition.
## Syntax
```text
ANSI (Cross Platform)
virtual int FireError(SAMLWriterErrorEventParams *e);
typedef struct { int ErrorCode; const char *Description;
int reserved;
} SAMLWriterErrorEventParams;
Unicode (Windows)
virtual INT FireError(SAMLWriterErrorEventParams *e);
typedef struct { INT ErrorCode; LPCWSTR Description;
INT reserved;
} SAMLWriterErrorEventParams;
```
## 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](#samlwriter-class) Class)
This event notifies the application about an underlying control flow event.
## Syntax
```text
ANSI (Cross Platform)
virtual int FireNotification(SAMLWriterNotificationEventParams *e);
typedef struct { const char *EventID; const char *EventParam;
int reserved;
} SAMLWriterNotificationEventParams;
Unicode (Windows)
virtual INT FireNotification(SAMLWriterNotificationEventParams *e);
typedef struct { LPCWSTR EventID; LPCWSTR EventParam;
INT reserved;
} SAMLWriterNotificationEventParams;
```
## Remarks
The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in the *EventID* parameter. *EventParam* contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.
# Certificate Type
Encapsulates an individual X.509 certificate.
## Syntax
*SecureBlackboxCertificate* (declared in *secureblackbox.h*)
## Remarks
This type keeps and provides access to X.509 certificate details.
The following fields are available:
- [Bytes](#Certificate_f_Bytes)
- [CA](#Certificate_f_CA)
- [CAKeyID](#Certificate_f_CAKeyID)
- [CertType](#Certificate_f_CertType)
- [CRLDistributionPoints](#Certificate_f_CRLDistributionPoints)
- [Curve](#Certificate_f_Curve)
- [Fingerprint](#Certificate_f_Fingerprint)
- [FriendlyName](#Certificate_f_FriendlyName)
- [Handle](#Certificate_f_Handle)
- [HashAlgorithm](#Certificate_f_HashAlgorithm)
- [Issuer](#Certificate_f_Issuer)
- [IssuerRDN](#Certificate_f_IssuerRDN)
- [KeyAlgorithm](#Certificate_f_KeyAlgorithm)
- [KeyBits](#Certificate_f_KeyBits)
- [KeyFingerprint](#Certificate_f_KeyFingerprint)
- [KeyUsage](#Certificate_f_KeyUsage)
- [KeyValid](#Certificate_f_KeyValid)
- [OCSPLocations](#Certificate_f_OCSPLocations)
- [OCSPNoCheck](#Certificate_f_OCSPNoCheck)
- [Origin](#Certificate_f_Origin)
- [PolicyIDs](#Certificate_f_PolicyIDs)
- [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes)
- [PrivateKeyExists](#Certificate_f_PrivateKeyExists)
- [PrivateKeyExtractable](#Certificate_f_PrivateKeyExtractable)
- [PublicKeyBytes](#Certificate_f_PublicKeyBytes)
- [Qualified](#Certificate_f_Qualified)
- [QualifiedStatements](#Certificate_f_QualifiedStatements)
- [Qualifiers](#Certificate_f_Qualifiers)
- [SelfSigned](#Certificate_f_SelfSigned)
- [SerialNumber](#Certificate_f_SerialNumber)
- [SigAlgorithm](#Certificate_f_SigAlgorithm)
- [Source](#Certificate_f_Source)
- [Subject](#Certificate_f_Subject)
- [SubjectAlternativeName](#Certificate_f_SubjectAlternativeName)
- [SubjectKeyID](#Certificate_f_SubjectKeyID)
- [SubjectRDN](#Certificate_f_SubjectRDN)
- [Valid](#Certificate_f_Valid)
- [ValidFrom](#Certificate_f_ValidFrom)
- [ValidTo](#Certificate_f_ValidTo)
## Fields
**Bytes** *char* (read-only)*
*Default Value: *
Returns the raw certificate data in DER format.
**CA** *int*
*Default Value: FALSE*
Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.
Set this field when generating a new certificate to have its Basic Constraints extension generated automatically.
**CAKeyID** *char* (read-only)*
*Default Value: *
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.
This setting cannot be set when generating a certificate as it always derives from another certificate property. [CertificateManager](CertificateManager.md#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [SubjectKeyID](#Certificate_f_SubjectKeyID) setting, and for lower-level certificates, from the parent certificate's subject key ID extension.
**CertType** *int (read-only)*
*Default Value: 0*
Returns the type of the entity contained in the [Certificate](#certificate-type) object.
A [Certificate](#certificate-type) object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.
Use the [CertificateManager](CertificateManager.md#CertificateManager) class to load or create new certificate and certificate requests objects.
**CRLDistributionPoints** *char**
*Default Value: ""*
Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.
Use this field when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.
The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
**Curve** *char**
*Default Value: ""*
Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.
| | | |
| --- | --- | --- |
| SB_EC_SECP112R1 | SECP112R1 | |
| SB_EC_SECP112R2 | SECP112R2 | |
| SB_EC_SECP128R1 | SECP128R1 | |
| SB_EC_SECP128R2 | SECP128R2 | |
| SB_EC_SECP160K1 | SECP160K1 | |
| SB_EC_SECP160R1 | SECP160R1 | |
| SB_EC_SECP160R2 | SECP160R2 | |
| SB_EC_SECP192K1 | SECP192K1 | |
| SB_EC_SECP192R1 | SECP192R1 | |
| SB_EC_SECP224K1 | SECP224K1 | |
| SB_EC_SECP224R1 | SECP224R1 | |
| SB_EC_SECP256K1 | SECP256K1 | |
| SB_EC_SECP256R1 | SECP256R1 | |
| SB_EC_SECP384R1 | SECP384R1 | |
| SB_EC_SECP521R1 | SECP521R1 | |
| SB_EC_SECT113R1 | SECT113R1 | |
| SB_EC_SECT113R2 | SECT113R2 | |
| SB_EC_SECT131R1 | SECT131R1 | |
| SB_EC_SECT131R2 | SECT131R2 | |
| SB_EC_SECT163K1 | SECT163K1 | |
| SB_EC_SECT163R1 | SECT163R1 | |
| SB_EC_SECT163R2 | SECT163R2 | |
| SB_EC_SECT193R1 | SECT193R1 | |
| SB_EC_SECT193R2 | SECT193R2 | |
| SB_EC_SECT233K1 | SECT233K1 | |
| SB_EC_SECT233R1 | SECT233R1 | |
| SB_EC_SECT239K1 | SECT239K1 | |
| SB_EC_SECT283K1 | SECT283K1 | |
| SB_EC_SECT283R1 | SECT283R1 | |
| SB_EC_SECT409K1 | SECT409K1 | |
| SB_EC_SECT409R1 | SECT409R1 | |
| SB_EC_SECT571K1 | SECT571K1 | |
| SB_EC_SECT571R1 | SECT571R1 | |
| SB_EC_PRIME192V1 | PRIME192V1 | |
| SB_EC_PRIME192V2 | PRIME192V2 | |
| SB_EC_PRIME192V3 | PRIME192V3 | |
| SB_EC_PRIME239V1 | PRIME239V1 | |
| SB_EC_PRIME239V2 | PRIME239V2 | |
| SB_EC_PRIME239V3 | PRIME239V3 | |
| SB_EC_PRIME256V1 | PRIME256V1 | |
| SB_EC_C2PNB163V1 | C2PNB163V1 | |
| SB_EC_C2PNB163V2 | C2PNB163V2 | |
| SB_EC_C2PNB163V3 | C2PNB163V3 | |
| SB_EC_C2PNB176W1 | C2PNB176W1 | |
| SB_EC_C2TNB191V1 | C2TNB191V1 | |
| SB_EC_C2TNB191V2 | C2TNB191V2 | |
| SB_EC_C2TNB191V3 | C2TNB191V3 | |
| SB_EC_C2ONB191V4 | C2ONB191V4 | |
| SB_EC_C2ONB191V5 | C2ONB191V5 | |
| SB_EC_C2PNB208W1 | C2PNB208W1 | |
| SB_EC_C2TNB239V1 | C2TNB239V1 | |
| SB_EC_C2TNB239V2 | C2TNB239V2 | |
| SB_EC_C2TNB239V3 | C2TNB239V3 | |
| SB_EC_C2ONB239V4 | C2ONB239V4 | |
| SB_EC_C2ONB239V5 | C2ONB239V5 | |
| SB_EC_C2PNB272W1 | C2PNB272W1 | |
| SB_EC_C2PNB304W1 | C2PNB304W1 | |
| SB_EC_C2TNB359V1 | C2TNB359V1 | |
| SB_EC_C2PNB368W1 | C2PNB368W1 | |
| SB_EC_C2TNB431R1 | C2TNB431R1 | |
| SB_EC_NISTP192 | NISTP192 | |
| SB_EC_NISTP224 | NISTP224 | |
| SB_EC_NISTP256 | NISTP256 | |
| SB_EC_NISTP384 | NISTP384 | |
| SB_EC_NISTP521 | NISTP521 | |
| SB_EC_NISTB163 | NISTB163 | |
| SB_EC_NISTB233 | NISTB233 | |
| SB_EC_NISTB283 | NISTB283 | |
| SB_EC_NISTB409 | NISTB409 | |
| SB_EC_NISTB571 | NISTB571 | |
| SB_EC_NISTK163 | NISTK163 | |
| SB_EC_NISTK233 | NISTK233 | |
| SB_EC_NISTK283 | NISTK283 | |
| SB_EC_NISTK409 | NISTK409 | |
| SB_EC_NISTK571 | NISTK571 | |
| SB_EC_GOSTCPTEST | GOSTCPTEST | |
| SB_EC_GOSTCPA | GOSTCPA | |
| SB_EC_GOSTCPB | GOSTCPB | |
| SB_EC_GOSTCPC | GOSTCPC | |
| SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
| SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
| SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
| SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
| SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
| SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
| SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
| SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
| SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
| SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
| SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
| SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
| SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
| SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
| SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
| SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
| SB_EC_CURVE25519 | CURVE25519 | |
| SB_EC_CURVE448 | CURVE448 | |
**Fingerprint** *char* (read-only)*
*Default Value: ""*
Contains the fingerprint (a hash imprint) of this certificate.
While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.
**FriendlyName** *char* (read-only)*
*Default Value: ""*
Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.
**Handle** *int64*
*Default Value: 0*
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
```text
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```
**HashAlgorithm** *char**
*Default Value: ""*
Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use [SigAlgorithm](#Certificate_f_SigAlgorithm) to find out the hash algorithm that is part of the certificate signature.
| | | |
| --- | --- | --- |
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | |
**Issuer** *char* (read-only)*
*Default Value: ""*
The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via [IssuerRDN](#Certificate_f_IssuerRDN).
**IssuerRDN** *char**
*Default Value: ""*
A list of *Property=Value* pairs that uniquely identify the certificate issuer.
Example: */C=US/O=Nationwide CA/CN=Web Certification Authority*
**KeyAlgorithm** *char**
*Default Value: "0"*
Specifies the public key algorithm of this certificate.
| | | |
| --- | --- | --- |
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | |
| SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | |
| SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | |
| SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | |
| SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | |
| SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | |
| SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | |
| SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | |
| SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | |
| SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | |
Use the [KeyBits](#Certificate_f_KeyBits), [Curve](#Certificate_f_Curve), and [PublicKeyBytes](#Certificate_f_PublicKeyBytes) fields to get more details about the key the certificate contains.
**KeyBits** *int (read-only)*
*Default Value: 0*
Returns the length of the public key in bits.
This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the [PublicKeyBytes](#Certificate_f_PublicKeyBytes) or [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes) field would typically contain auxiliary values, and therefore be longer.
**KeyFingerprint** *char* (read-only)*
*Default Value: ""*
Returns a SHA1 fingerprint of the public key contained in the certificate.
Note that the key fingerprint is different from the certificate fingerprint accessible via the [Fingerprint](#Certificate_f_Fingerprint) field. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.
**KeyUsage** *int*
*Default Value: 0*
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
| | | |
| --- | --- | --- |
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
Set this field before generating the certificate to propagate the key usage flags to the new certificate.
**KeyValid** *int (read-only)*
*Default Value: FALSE*
Returns *True* if the certificate's key is cryptographically valid, and *False* otherwise.
**OCSPLocations** *char**
*Default Value: ""*
Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
Set this field before calling the certificate manager's [Generate](CertificateManager.md#CertificateManager_m_Generate) method to propagate it to the new certificate.
The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
**OCSPNoCheck** *int*
*Default Value: FALSE*
Accessor to the value of the certificate's ocsp-no-check extension.
**Origin** *int (read-only)*
*Default Value: 0*
Returns the location that the certificate was taken or loaded from.
**PolicyIDs** *char**
*Default Value: ""*
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
Set this field when generating a certificate to propagate the policies information to the new certificate.
The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.
**PrivateKeyBytes** *char* (read-only)*
*Default Value: *
Returns the certificate's private key in DER-encoded format. It is normal for this field to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.
**PrivateKeyExists** *int (read-only)*
*Default Value: FALSE*
Indicates whether the certificate has a usable private key associated with it. If it is set to *True*, the certificate can be used for private key operations, such as signing or decryption.
This field is independent from [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes), and can be set to *True* even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.
**PrivateKeyExtractable** *int (read-only)*
*Default Value: FALSE*
Indicates whether the private key is extractable (exportable).
**PublicKeyBytes** *char* (read-only)*
*Default Value: *
Contains the certificate's public key in DER format.
This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.
**Qualified** *int (read-only)*
*Default Value: FALSE*
Indicates whether the certificate is qualified.
This property is set to *True* if the certificate is confirmed by a Trusted List to be qualified.
**QualifiedStatements** *int*
*Default Value: 0*
Returns a simplified qualified status of the certificate.
**Qualifiers** *char* (read-only)*
*Default Value: ""*
A list of qualifiers.
Contains a comma-separated list of qualifier aliases for the certificate, for example *QCP-n-qscd,QCWithSSCD*.
**SelfSigned** *int (read-only)*
*Default Value: FALSE*
Indicates whether the certificate is self-signed (root) or signed by an external CA.
**SerialNumber** *char**
*Default Value: *
Returns the certificate's serial number.
The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.
**SigAlgorithm** *char* (read-only)*
*Default Value: ""*
Indicates the algorithm that was used by the CA to sign this certificate.
A signature algorithm typically combines hash and public key algorithms together, such as *sha256WithRSAEncryption* or *ecdsa-with-SHA256*.
**Source** *int (read-only)*
*Default Value: 0*
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
**Subject** *char* (read-only)*
*Default Value: ""*
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via [SubjectRDN](#Certificate_f_SubjectRDN).
**SubjectAlternativeName** *char**
*Default Value: ""*
Returns or sets the value of the Subject Alternative Name extension of the certificate.
Subject alternative names are used to provide additional names that are impractical to store in the main [SubjectRDN](#Certificate_f_SubjectRDN) field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.
The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.
**SubjectKeyID** *char**
*Default Value: *
Contains a unique identifier of the certificate's cryptographic key.
Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.
The [SubjectKeyID](#Certificate_f_SubjectKeyID) and [CAKeyID](#Certificate_f_CAKeyID) fields of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.
**SubjectRDN** *char**
*Default Value: ""*
A list of *Property=Value* pairs that uniquely identify the certificate holder (subject).
Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.
Example: */C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins*.
**Valid** *int (read-only)*
*Default Value: FALSE*
Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
**ValidFrom** *char**
*Default Value: ""*
The time point at which the certificate becomes valid, in UTC.
**ValidTo** *char**
*Default Value: ""*
The time point at which the certificate expires, in UTC.
## Constructors
```text
Certificate()
```
Creates a new object with default field values.
# CryptoKey Type
This container represents a cryptographic key.
## Syntax
*SecureBlackboxCryptoKey* (declared in *secureblackbox.h*)
## Remarks
This type is a universal placeholder for cryptographic keys.
Version 2026 upgrade note: granular key parameter properties (RSAModulus, EdPublic, DSSP and others) have been removed from this type and are now available via the CryptoKeyManager.GetKeyParam method.
The following fields are available:
- [Algorithm](#CryptoKey_f_Algorithm)
- [Bits](#CryptoKey_f_Bits)
- [Curve](#CryptoKey_f_Curve)
- [Exportable](#CryptoKey_f_Exportable)
- [Fingerprint](#CryptoKey_f_Fingerprint)
- [Handle](#CryptoKey_f_Handle)
- [ID](#CryptoKey_f_ID)
- [IV](#CryptoKey_f_IV)
- [Nonce](#CryptoKey_f_Nonce)
- [Private](#CryptoKey_f_Private)
- [Public](#CryptoKey_f_Public)
- [Subject](#CryptoKey_f_Subject)
- [Symmetric](#CryptoKey_f_Symmetric)
- [Valid](#CryptoKey_f_Valid)
- [Value](#CryptoKey_f_Value)
## Fields
**Algorithm** *char**
*Default Value: ""*
The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key. Public key algorithms: RSA, ECDSA, Elgamal, DH, EdDSA, ML-DSA, ML-KEM.
| | | |
| --- | --- | --- |
| SB_SYMMETRIC_ALGORITHM_RC4 | RC4 | |
| SB_SYMMETRIC_ALGORITHM_DES | DES | |
| SB_SYMMETRIC_ALGORITHM_3DES | 3DES | |
| SB_SYMMETRIC_ALGORITHM_RC2 | RC2 | |
| SB_SYMMETRIC_ALGORITHM_AES128 | AES128 | |
| SB_SYMMETRIC_ALGORITHM_AES192 | AES192 | |
| SB_SYMMETRIC_ALGORITHM_AES256 | AES256 | |
| SB_SYMMETRIC_ALGORITHM_IDENTITY | Identity | |
| SB_SYMMETRIC_ALGORITHM_BLOWFISH | Blowfish | |
| SB_SYMMETRIC_ALGORITHM_CAST128 | CAST128 | |
| SB_SYMMETRIC_ALGORITHM_IDEA | IDEA | |
| SB_SYMMETRIC_ALGORITHM_TWOFISH | Twofish | |
| SB_SYMMETRIC_ALGORITHM_TWOFISH128 | Twofish128 | |
| SB_SYMMETRIC_ALGORITHM_TWOFISH192 | Twofish192 | |
| SB_SYMMETRIC_ALGORITHM_TWOFISH256 | Twofish256 | |
| SB_SYMMETRIC_ALGORITHM_CAMELLIA | Camellia | |
| SB_SYMMETRIC_ALGORITHM_CAMELLIA128 | Camellia128 | |
| SB_SYMMETRIC_ALGORITHM_CAMELLIA192 | Camellia192 | |
| SB_SYMMETRIC_ALGORITHM_CAMELLIA256 | Camellia256 | |
| SB_SYMMETRIC_ALGORITHM_SERPENT | Serpent | |
| SB_SYMMETRIC_ALGORITHM_SERPENT128 | Serpent128 | |
| SB_SYMMETRIC_ALGORITHM_SERPENT192 | Serpent192 | |
| SB_SYMMETRIC_ALGORITHM_SERPENT256 | Serpent256 | |
| SB_SYMMETRIC_ALGORITHM_SEED | SEED | |
| SB_SYMMETRIC_ALGORITHM_RABBIT | Rabbit | |
| SB_SYMMETRIC_ALGORITHM_SYMMETRIC | Generic | |
| SB_SYMMETRIC_ALGORITHM_GOST_28147_1989 | GOST-28147-1989 | |
| SB_SYMMETRIC_ALGORITHM_CHACHA20 | ChaCha20 | |
| | | |
| --- | --- | --- |
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | |
**Bits** *int (read-only)*
*Default Value: 0*
The length of the key in bits.
**Curve** *char**
*Default Value: ""*
This property specifies the name of the curve the EC key is built on.
**Exportable** *int (read-only)*
*Default Value: FALSE*
Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
**Fingerprint** *char* (read-only)*
*Default Value: ""*
Contains the fingerprint (a hash imprint) of this key.
**Handle** *int64*
*Default Value: 0*
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
```text
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```
**ID** *char**
*Default Value: *
Provides access to a storage-specific key identifier. Key identifiers are used by cryptographic providers to refer to a particular key and/or distinguish between different keys. They are typically unique within a storage, but there is no guarantee that a particular cryptoprovider will conform to that (or will assign any key IDs at all).
**IV** *char**
*Default Value: *
The initialization vector (IV) of a symmetric key. This is normally a public part of a symmetric key, the idea of which is to introduce randomness to the encrypted data and/or serve as a first block in chaining ciphers.
**Nonce** *char**
*Default Value: *
A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.
**Private** *int (read-only)*
*Default Value: FALSE*
Returns True if the object hosts a private key, and False otherwise.
**Public** *int (read-only)*
*Default Value: FALSE*
Returns True if the object hosts a public key, and False otherwise.
**Subject** *char**
*Default Value: *
Returns the key subject. This is a cryptoprovider-dependent value, which normally aims to provide some user-friendly insight into the key owner.
**Symmetric** *int (read-only)*
*Default Value: FALSE*
Returns True if the object contains a symmetric key, and False otherwise.
**Valid** *int (read-only)*
*Default Value: FALSE*
Returns True if this key is valid. The term Valid highly depends on the kind of the key being stored. A symmetric key is considered valid if its length fits the algorithm being set. The validity of an RSA key also ensures that the RSA key elements (primes, exponents, and modulus) are consistent.
**Value** *char* (read-only)*
*Default Value: *
The byte array representation of the key value. This may not be available for non-[Exportable](#CryptoKey_f_Exportable) keys.
This property used to be called *Key* in SecureBlackbox versions 2024 and older.
## Constructors
```text
CryptoKey()
```
Creates an empty crypto key object.
# SAMLArtifact Type
Represents a SAML Artifact entity.
## Syntax
*SecureBlackboxSAMLArtifact* (declared in *secureblackbox.h*)
## Remarks
This type is a container for a SAML Artifact entity. A SAML artifact consists of a [TypeCode](#SAMLArtifact_f_TypeCode), an [EndpointIndex](#SAMLArtifact_f_EndpointIndex), and a [RemainingArtifact](#SAMLArtifact_f_RemainingArtifact), which contains the body of the artifact and varies depending on the [TypeCode](#SAMLArtifact_f_TypeCode).
The following fields are available:
- [EndpointIndex](#SAMLArtifact_f_EndpointIndex)
- [MessageHandle](#SAMLArtifact_f_MessageHandle)
- [RemainingArtifact](#SAMLArtifact_f_RemainingArtifact)
- [SourceID](#SAMLArtifact_f_SourceID)
- [TypeCode](#SAMLArtifact_f_TypeCode)
- [URI](#SAMLArtifact_f_URI)
## Fields
**EndpointIndex** *int*
*Default Value: 0*
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.
**MessageHandle** *char**
*Default Value: *
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.
**RemainingArtifact** *char* (read-only)*
*Default Value: *
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.
**SourceID** *char**
*Default Value: *
An accessor to the SourceID property of the artifact.
SourceID uniquely identifies the issuer of the artifact.
**TypeCode** *int*
*Default Value: 0*
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 [RemainingArtifact](#SAMLArtifact_f_RemainingArtifact), [SourceID](#SAMLArtifact_f_SourceID), and [MessageHandle](#SAMLArtifact_f_MessageHandle) parameters.
**URI** *char**
*Default Value: ""*
An accessor to the URI property of the artifact.
The URI property contains the origin of the artifact.
## Constructors
```text
SAMLArtifact()
```
Creates a new SAMLArtifact object.
# SAMLAssertion Type
Contains parameters of a SAML assertion.
## Syntax
*SecureBlackboxSAMLAssertion* (declared in *secureblackbox.h*)
## Remarks
Use this type to get or set general information about a SAML assertion.
The following fields are available:
- [AssertionType](#SAMLAssertion_f_AssertionType)
- [EncryptedContent](#SAMLAssertion_f_EncryptedContent)
- [ID](#SAMLAssertion_f_ID)
- [IDRef](#SAMLAssertion_f_IDRef)
- [IssueInstant](#SAMLAssertion_f_IssueInstant)
- [Issuer](#SAMLAssertion_f_Issuer)
- [ParentAssertion](#SAMLAssertion_f_ParentAssertion)
- [SignatureValidationResult](#SAMLAssertion_f_SignatureValidationResult)
- [Signed](#SAMLAssertion_f_Signed)
- [Subject](#SAMLAssertion_f_Subject)
- [URIRef](#SAMLAssertion_f_URIRef)
- [Version](#SAMLAssertion_f_Version)
## Fields
**AssertionType** *int*
*Default Value: 2*
Specifies the type of the assertion.
Use this property to check or set the type of the assertion.
**EncryptedContent** *char**
*Default Value: ""*
Represents the encrypted assertion content.
Use this property to get or set the encrypted assertion content.
**ID** *char**
*Default Value: ""*
Represents the ID of the assertion.
Use this property to read or set the unique ID of the assertion.
**IDRef** *char**
*Default Value: ""*
Represents an ID reference value.
Use this property to read or set the ID reference value for assertions of csatAssertionIDRef type.
**IssueInstant** *char**
*Default Value: ""*
Contains the assertion issuance time stamp.
Use this property to check or set the assertion issuance time.
**Issuer** *char**
*Default Value: ""*
Specifies the assertion issuer.
Use this property to provide the assertion issuer ID.
**ParentAssertion** *int*
*Default Value: -1*
Contains the index of the parent assertion in the assertion list.
This property is set to -1 for normal assertions. ParentAssertion set to a non-negative value indicates that the assertion is an advice assertion incorporated into a top-level assertion. Advice assertions are typically used by service providers to provide additional information about the SAML assertion issuing authority.
**SignatureValidationResult** *int (read-only)*
*Default Value: 0*
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
| | | |
| --- | --- | --- |
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
**Signed** *int*
*Default Value: FALSE*
Specifies whether the assertion is signed.
Use this property to establish whether the assertion is signed.
**Subject** *char**
*Default Value: ""*
Specifies the assertion subject.
Use this property to provide the assertion's subject SAML ID.
**URIRef** *char**
*Default Value: ""*
Represents an URI reference value.
Use this property to read or set the URI reference value for assertions of csatAssertionURIRef type.
**Version** *char**
*Default Value: ""*
Specifies the SAML protocol version used.
This property specifies the SAML protocol version. The default value is *2.0*.
## Constructors
```text
SAMLAssertion()
```
Creates a new SAMLAssertion object.
# SAMLAssertionStatement Type
Represents an assertion statement.
## Syntax
*SecureBlackboxSAMLAssertionStatement* (declared in *secureblackbox.h*)
## Remarks
This type is a container for an assertion statement.
The following fields are available:
- [AuthnContextAuthenticatingAuthorities](#SAMLAssertionStatement_f_AuthnContextAuthenticatingAuthorities)
- [AuthnContextChoice](#SAMLAssertionStatement_f_AuthnContextChoice)
- [AuthnContextClassRef](#SAMLAssertionStatement_f_AuthnContextClassRef)
- [AuthnContextDecl](#SAMLAssertionStatement_f_AuthnContextDecl)
- [AuthnContextDeclRef](#SAMLAssertionStatement_f_AuthnContextDeclRef)
- [AuthnInstant](#SAMLAssertionStatement_f_AuthnInstant)
- [AuthnSessionIndex](#SAMLAssertionStatement_f_AuthnSessionIndex)
- [AuthnSessionNotOnOrAfter](#SAMLAssertionStatement_f_AuthnSessionNotOnOrAfter)
- [AuthnSubjectLocalityAddress](#SAMLAssertionStatement_f_AuthnSubjectLocalityAddress)
- [AuthnSubjectLocalityDNSName](#SAMLAssertionStatement_f_AuthnSubjectLocalityDNSName)
- [AuthzActions](#SAMLAssertionStatement_f_AuthzActions)
- [AuthzDecision](#SAMLAssertionStatement_f_AuthzDecision)
- [AuthzDecisionEvidence](#SAMLAssertionStatement_f_AuthzDecisionEvidence)
- [AuthzDecisionResource](#SAMLAssertionStatement_f_AuthzDecisionResource)
- [StatementType](#SAMLAssertionStatement_f_StatementType)
## Fields
**AuthnContextAuthenticatingAuthorities** *char**
*Default Value: ""*
Contains the list of authenticating authorities.
Use this property to access the list of URIs of authenticating authorities (IdP entity IDs).
**AuthnContextChoice** *char**
*Default Value: ""*
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.
**AuthnContextClassRef** *char**
*Default Value: ""*
Indicates the authentication contexts class reference.
Use this property to get or set the authentication contexts class reference attribute.
**AuthnContextDecl** *char**
*Default Value: ""*
Specifies the authentication contexts declaration.
Use this property to access or set the declaration element of the authentication context.
**AuthnContextDeclRef** *char**
*Default Value: ""*
Specifies the authentication contexts declaration reference.
Use this property to get or set the declaration reference of the authentication context.
**AuthnInstant** *char**
*Default Value: ""*
Specifies the authentication event timestamp.
Use this property to read or set the moment in time the authentication event took place.
**AuthnSessionIndex** *char**
*Default Value: ""*
Contains the authentication session index.
Use this property to access or set the authentication session index.
**AuthnSessionNotOnOrAfter** *char**
*Default Value: ""*
Maps to the SessionNotOnOrAfter parameter of the authentication statement.
Use this property to access or set the SessionNotOnOrAfter parameter of the authentication statement.
**AuthnSubjectLocalityAddress** *char**
*Default Value: ""*
Specifies the authentication subjects address.
Use this property to specify the address parameter of the authentication subjects locality.
**AuthnSubjectLocalityDNSName** *char**
*Default Value: ""*
Maps to the authentication subjects DNS name parameter.
Use this property to access or set the authentication subjects DNS name locality parameter.
**AuthzActions** *char**
*Default Value: ""*
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.
**AuthzDecision** *int*
*Default Value: 0*
Specifies the authorization decision.
Use this property to check or set the authorization decision. This can be one of Permit, Deny, or Indeterminate.
**AuthzDecisionEvidence** *char**
*Default Value: ""*
Manages the authorization decision statement evidence parameter.
Use this property to read or set the authorization decision statement evidence parameter.
**AuthzDecisionResource** *char**
*Default Value: ""*
Specifies the authorization decision statement resource parameter.
Use this property to access or set the resource parameter of the authorization statement.
**StatementType** *int*
*Default Value: 0*
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.
## Constructors
```text
SAMLAssertionStatement()
```
Creates a new SAMLAssertionStatement object.
# SAMLAttribute Type
A container for the SAML attribute object.
## Syntax
*SecureBlackboxSAMLAttribute* (declared in *secureblackbox.h*)
## Remarks
This type is a container for the SAML attribute object.
The following fields are available:
- [FriendlyName](#SAMLAttribute_f_FriendlyName)
- [Name](#SAMLAttribute_f_Name)
- [NameFormat](#SAMLAttribute_f_NameFormat)
- [StatementIndex](#SAMLAttribute_f_StatementIndex)
- [Values](#SAMLAttribute_f_Values)
## Fields
**FriendlyName** *char**
*Default Value: ""*
Specifies the friendly name of the attribute
Use this property to access or set the friendly name of a SAML attribute (e.g. *givenName*).
**Name** *char**
*Default Value: ""*
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*).
**NameFormat** *char**
*Default Value: ""*
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*).
**StatementIndex** *int*
*Default Value: -1*
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.
**Values** *char**
*Default Value: ""*
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.
## Constructors
```text
SAMLAttribute()
```
Creates a new SAMLAttribute object.
# SAMLAuthnQuery Type
A container for AuthnQuery element.
## Syntax
*SecureBlackboxSAMLAuthnQuery* (declared in *secureblackbox.h*)
## Remarks
This type is a container for SAML AuthnQuery element, which represents an authentication event query.
The following fields are available:
- [Comparison](#SAMLAuthnQuery_f_Comparison)
- [ContextClassRefs](#SAMLAuthnQuery_f_ContextClassRefs)
- [RefType](#SAMLAuthnQuery_f_RefType)
- [SessionIndex](#SAMLAuthnQuery_f_SessionIndex)
## Fields
**Comparison** *int*
*Default Value: 0*
Specifies the authentication context comparison method.
Use this property to access or set the authentication contexts comparison method (none, exact, minimum, maximum, or better).
**ContextClassRefs** *char**
*Default Value: ""*
Specifies the context class reference.
Use this property to access or set the authentication context class reference.
**RefType** *int*
*Default Value: 0*
Specifies the context reference type.
Use this property to access or set the authentication contexts reference type (class or declaration).
**SessionIndex** *char**
*Default Value: ""*
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.
## Constructors
```text
SAMLAuthnQuery()
```
Creates a new SAMLAuthnQuery object.
# SAMLAuthnRequest Type
Represents a SAML AuthnRequest object.
## Syntax
*SecureBlackboxSAMLAuthnRequest* (declared in *secureblackbox.h*)
## Remarks
This type represents a SAML AuthnRequest object. An AuthnRequest is sent by a principal to the identity provider when it needs to request an assertion containing an authentication statement.
The following fields are available:
- [AssertionConsumerServiceIndex](#SAMLAuthnRequest_f_AssertionConsumerServiceIndex)
- [AssertionConsumerServiceURL](#SAMLAuthnRequest_f_AssertionConsumerServiceURL)
- [AttributeConsumingServiceIndex](#SAMLAuthnRequest_f_AttributeConsumingServiceIndex)
- [ContextClassRefs](#SAMLAuthnRequest_f_ContextClassRefs)
- [ContextComparison](#SAMLAuthnRequest_f_ContextComparison)
- [ContextRefType](#SAMLAuthnRequest_f_ContextRefType)
- [Flags](#SAMLAuthnRequest_f_Flags)
- [ForceAuthn](#SAMLAuthnRequest_f_ForceAuthn)
- [IsPassive](#SAMLAuthnRequest_f_IsPassive)
- [NameIDPolicyAllowCreate](#SAMLAuthnRequest_f_NameIDPolicyAllowCreate)
- [NameIDPolicyFormat](#SAMLAuthnRequest_f_NameIDPolicyFormat)
- [NameIDPolicySPNameQualifier](#SAMLAuthnRequest_f_NameIDPolicySPNameQualifier)
- [ProtocolBinding](#SAMLAuthnRequest_f_ProtocolBinding)
- [ProviderName](#SAMLAuthnRequest_f_ProviderName)
- [ScopingGetComplete](#SAMLAuthnRequest_f_ScopingGetComplete)
- [ScopingProxyCount](#SAMLAuthnRequest_f_ScopingProxyCount)
- [ScopingRequesterIDs](#SAMLAuthnRequest_f_ScopingRequesterIDs)
## Fields
**AssertionConsumerServiceIndex** *int*
*Default Value: 0*
Specifies the assertion consumer service index.
Use this property to access or set the location index to which the response has to be returned.
**AssertionConsumerServiceURL** *char**
*Default Value: ""*
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.
**AttributeConsumingServiceIndex** *int*
*Default Value: 0*
Specifies the attribute consuming service index.
Use this property to read or set the attribute consuming service index.
**ContextClassRefs** *char**
*Default Value: ""*
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.
**ContextComparison** *int*
*Default Value: 0*
Specifies the AuthnContext comparison method.
Use this property to access or set the authentication contexts comparison method (none, exact, minimum, maximum, or better).
**ContextRefType** *int*
*Default Value: 0*
Specifies the context reference type.
Use this property to get or set the context reference type (Class or Declaration).
**Flags** *int*
*Default Value: 0*
Adjusts secondary serialization properties.
Use this bit mask property to adjust how certain properties will be saved. The following flags are supported:
| | | |
| --- | --- | --- |
| arfAllowCreate | 1 | Enforces inclusion of NameIDPolicyAllowCreate element in the NameIDPolicy record |
| arfForceAuthn | 2 | Enforces inclusion of the ForceAuthn element |
| arfIsPassive | 4 | Enforces saving of IsPassive element |
**ForceAuthn** *int*
*Default Value: FALSE*
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.
**IsPassive** *int*
*Default Value: FALSE*
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.
**NameIDPolicyAllowCreate** *int*
*Default Value: FALSE*
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.
**NameIDPolicyFormat** *char**
*Default Value: ""*
Matches to the Format attribute of the NameIDPolicy element of the request.
Use this property to access or set the Format attribute of NameIDPolicy.
**NameIDPolicySPNameQualifier** *char**
*Default Value: ""*
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.
**ProtocolBinding** *char**
*Default Value: ""*
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.
**ProviderName** *char**
*Default Value: ""*
Specifies the name of the requestor.
Use this property to read or set the name of the requestor.
**ScopingGetComplete** *char**
*Default Value: ""*
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.
**ScopingProxyCount** *int*
*Default Value: 0*
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.
**ScopingRequesterIDs** *char**
*Default Value: ""*
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.
## Constructors
```text
SAMLAuthnRequest()
```
Creates a new SAMLAuthnRequest object.
# SAMLAuthzDecisionQuery Type
Represents SAML AuthzDecisionQuery element.
## Syntax
*SecureBlackboxSAMLAuthzDecisionQuery* (declared in *secureblackbox.h*)
## Remarks
This type is a container for SAML AuthzDecisionQuery type.
The following fields are available:
- [Actions](#SAMLAuthzDecisionQuery_f_Actions)
- [Resource](#SAMLAuthzDecisionQuery_f_Resource)
## Fields
**Actions** *char**
*Default Value: ""*
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.
**Resource** *char**
*Default Value: ""*
Matches the Resource element of the query.
Use this property to read or set the Resource element of the authorization decision query.
## Constructors
```text
SAMLAuthzDecisionQuery()
```
Creates a new SAMLAuthzDecisionQuery object.
# SAMLBinding Type
Contains parameters of SAML binding.
## Syntax
*SecureBlackboxSAMLBinding* (declared in *secureblackbox.h*)
## Remarks
This type is a container for properties of SAML binding mechanism.
The following fields are available:
- [BindingType](#SAMLBinding_f_BindingType)
- [Body](#SAMLBinding_f_Body)
- [Encoding](#SAMLBinding_f_Encoding)
- [ForceSign](#SAMLBinding_f_ForceSign)
- [FormTemplate](#SAMLBinding_f_FormTemplate)
- [POSTMode](#SAMLBinding_f_POSTMode)
- [RelayState](#SAMLBinding_f_RelayState)
- [SignatureAlgorithm](#SAMLBinding_f_SignatureAlgorithm)
- [SignatureValidationResult](#SAMLBinding_f_SignatureValidationResult)
- [Signed](#SAMLBinding_f_Signed)
- [URL](#SAMLBinding_f_URL)
- [VerifySignatures](#SAMLBinding_f_VerifySignatures)
## Fields
**BindingType** *int*
*Default Value: 0*
Specifies the type of SAML binding to use.
Use this property to specify the binding type to use with the request.
**Body** *char**
*Default Value: ""*
Contains the POST binding form body.
Use this property to read or set the body of the form returned by the service provider.
**Encoding** *char**
*Default Value: ""*
Specifies the message encoding.
Use this property to access or set the message encoding.
**ForceSign** *int*
*Default Value: FALSE*
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 [Sign](#SAMLBinding_f_Sign).
**FormTemplate** *char**
*Default Value: ""*
Contains the XHTML form template returned by the service provider.
Use this property to access or set the template of a POST form provided by the service provider (POST binding only).
**POSTMode** *int*
*Default Value: 0*
Specifies whether binding is applied on the server, or on the client side.
Use this property to specify whether POST binding is used on the server or client side of the communication. The default value is cspmClient.
**RelayState** *char**
*Default Value: ""*
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.
**SignatureAlgorithm** *char**
*Default Value: ""*
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.
**SignatureValidationResult** *int (read-only)*
*Default Value: 0*
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
| | | |
| --- | --- | --- |
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
**Signed** *int*
*Default Value: FALSE*
Specifies whether to sign the binding.
Use this property to enable or disable signing of generated binding entities. The SAML specification instructs that the binding should only be signed if the original XML was. This property therefore is only taken into account if the original XML was signed. With that in mind, certain service providers demand the binding to be signed at all times. Use [ForceSign](#SAMLBinding_f_ForceSign) property to enforce signatures on all binding entities.
**URL** *char**
*Default Value: ""*
Contains the URL of the request query.
Use this property to read or set the URL of the request query or POST target.
**VerifySignatures** *int*
*Default Value: TRUE*
Instructs the component whether to verify incoming signatures.
Use this property to activate or deactivate verification of signatures in incoming requests.
## Constructors
```text
SAMLBinding()
```
Creates a new SAMLBinding object.
# SAMLCondition Type
Represents a SAML condition parameter.
## Syntax
*SecureBlackboxSAMLCondition* (declared in *secureblackbox.h*)
## Remarks
This type is a container for a single Condition parameter of a SAML assertion or other type of entity.
The following fields are available:
- [Condition](#SAMLCondition_f_Condition)
- [ConditionType](#SAMLCondition_f_ConditionType)
## Fields
**Condition** *char**
*Default Value: ""*
The condition set in accordance with the [ConditionType](#SAMLCondition_f_ConditionType).
For csctAudienceRestriction conditions, read or set a list of audiences included in the restriction. Each audience is represented by an URI. Provide multiple audiences by splitting them with CRLF separators.
For csctProxyRestriction conditions, check or set the value of the proxy count restriction.
For csctNotBefore and csctNotOnOrAfter, check or set the respective date/time values.
**ConditionType** *int*
*Default Value: 0*
Specifies a type of the condition object.
Use this property to check or specify the type of the condition object. This can be either an audience restriction, a one time use limitation, or a proxy restriction.
## Constructors
```text
SAMLCondition()
```
Creates a new SAMLAssertionCondition object.
# SAMLIDPEntry Type
Represents a single identity provider information.
## Syntax
*SecureBlackboxSAMLIDPEntry* (declared in *secureblackbox.h*)
## Remarks
This type is a container of single identity provider-specific details.
The following fields are available:
- [Loc](#SAMLIDPEntry_f_Loc)
- [Name](#SAMLIDPEntry_f_Name)
- [ProviderID](#SAMLIDPEntry_f_ProviderID)
## Fields
**Loc** *char**
*Default Value: ""*
Contains the value of the Loc attribute.
Use this property to access or set the value of the Loc (location) attribute.
**Name** *char**
*Default Value: ""*
Contains the name of the IdP provider.
Use this property to retrieve or set the *Name* attribute of the IdP provider.
**ProviderID** *char**
*Default Value: ""*
Contains the provider ID.
Use this property to read or set the identity provider ID.
## Constructors
```text
SAMLIDPEntry()
```
Creates a new SAMLIDPEntry object.
# SAMLLogoutRequest Type
Represents SAML LogoutRequest element.
## Syntax
*SecureBlackboxSAMLLogoutRequest* (declared in *secureblackbox.h*)
## Remarks
This type is a container for SAML LogoutRequest element.
The following fields are available:
- [NameID](#SAMLLogoutRequest_f_NameID)
- [NotOnOrAfter](#SAMLLogoutRequest_f_NotOnOrAfter)
- [Reason](#SAMLLogoutRequest_f_Reason)
- [SessionIndexes](#SAMLLogoutRequest_f_SessionIndexes)
## Fields
**NameID** *char**
*Default Value: ""*
Contains the value of the NameID parameter.
Use this property to access or set the value of the NameID parameter of the request.
**NotOnOrAfter** *char**
*Default Value: ""*
Contains the value of the NotOnOrAfter parameter.
Use this property to access or set the value of the NotOnOrAfter parameter.
**Reason** *char**
*Default Value: ""*
Contains the value of the Reason parameter.
Use this property to read or set the value of the Reason parameter.
**SessionIndexes** *char**
*Default Value: ""*
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.
## Constructors
```text
SAMLLogoutRequest()
```
Creates a new SAMLLogoutRequest object.
# SAMLManageNameIDRequest Type
Represents a SAML ManageNameIDRequest element.
## Syntax
*SecureBlackboxSAMLManageNameIDRequest* (declared in *secureblackbox.h*)
## Remarks
This type is a container for ManageNameIDRequest element.
The following fields are available:
- [NameID](#SAMLManageNameIDRequest_f_NameID)
- [NewEncryptedID](#SAMLManageNameIDRequest_f_NewEncryptedID)
- [NewID](#SAMLManageNameIDRequest_f_NewID)
- [Terminate](#SAMLManageNameIDRequest_f_Terminate)
## Fields
**NameID** *char**
*Default Value: ""*
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.
**NewEncryptedID** *char**
*Default Value: ""*
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.
**NewID** *char**
*Default Value: ""*
Contains the value of the NewID parameter.
Use this property to access or set the NewID parameter of the request.
**Terminate** *char**
*Default Value: ""*
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.
## Constructors
```text
SAMLManageNameIDRequest()
```
Creates a new SAMLManageNameIDRequest object.
# SAMLMessage Type
Contains general parameters of a SAML message.
## Syntax
*SecureBlackboxSAMLMessage* (declared in *secureblackbox.h*)
## Remarks
Use this type to get or set general information about a SAML message.
The following fields are available:
- [Consent](#SAMLMessage_f_Consent)
- [ContentType](#SAMLMessage_f_ContentType)
- [ContentTypeString](#SAMLMessage_f_ContentTypeString)
- [Destination](#SAMLMessage_f_Destination)
- [ID](#SAMLMessage_f_ID)
- [InResponseTo](#SAMLMessage_f_InResponseTo)
- [IssueInstant](#SAMLMessage_f_IssueInstant)
- [Issuer](#SAMLMessage_f_Issuer)
- [SignatureValidationResult](#SAMLMessage_f_SignatureValidationResult)
- [Signed](#SAMLMessage_f_Signed)
- [Subject](#SAMLMessage_f_Subject)
- [Version](#SAMLMessage_f_Version)
- [XMLHeader](#SAMLMessage_f_XMLHeader)
## Fields
**Consent** *char**
*Default Value: ""*
Contains the Consent parameter of the SAML message.
Use this property to specify the Consent parameter of the SAML entity.
**ContentType** *int (read-only)*
*Default Value: 0*
Returns the SAML type of the current message.
Use this property to check the type of SAML message being created. This is the same value that was passed to CreateNew call.
Depending on the assigned type, use properties of class to tune up the parameters of the chosen message type. For example, if the content type is cstyAuthnQuery, use AuthnQuery property to adjust context class references or comparison settings.
**ContentTypeString** *char* (read-only)*
*Default Value: ""*
Returns the type of the processed message, as an original string.
Check this property to find out the content type of the data stored in the processed message. This returns a string originally included in the SAML message, which may be helpful when processing non-standard types.
Known SAML content types are:
- AssertionIDRequest
- SubjectQuery
- AuthnQuery
- AttributeQuery
- AuthzDecisionQuery
- AuthnRequest
- ManageNameIDRequest
- NameIDMappingRequest
- LogoutRequest
- ArtifactResolve
- Response
- LogoutResponse
- ArtifactResponse
- NameIDMappingResponse
**Destination** *char**
*Default Value: ""*
Contains the Destination parameter of the SAML message.
Use this property to set the Destination parameter of the created SAML object.
**ID** *char**
*Default Value: ""*
The ID of the request.
Use this property to specify the ID of the SAML request or response.
**InResponseTo** *char**
*Default Value: ""*
Contains the InResponseTo property of the SAML request.
Use this property to specify the ID of the message in response to which the current entity is provided.
**IssueInstant** *char**
*Default Value: ""*
Contains request issuance timestamp.
Set this property to specify the time moment of the request formation. Leave it empty to use the current system time.
**Issuer** *char**
*Default Value: ""*
Sets the issuer of the message.
Set this property to include the SAML ID of the issuer of the SAML message. A typical SAML ID is a string of semicolon-separated elements of one or more of the following elements:
- Format
- NameQualifier
- Value
- IDType
- SPNameQualifier
- SPProvidedID
For example,
```text
writer.Message.Issuer = "Value=https://saml.entity.org/resource;Format=urn:oasis:names:tc:SAML:2.0:nameid-format:entity;IDType=Issuer";
```
**SignatureValidationResult** *int (read-only)*
*Default Value: 0*
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
| | | |
| --- | --- | --- |
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
**Signed** *int*
*Default Value: FALSE*
Specifies whether the SAML message is or should be signed.
Check this property to find out whether the processed message was signed by the sender, or set this property to true to indicate that the created message should be signed.
**Subject** *char**
*Default Value: ""*
Gets or sets the subject of the message.
Check this property to obtain the SAML ID of the message subject.
Set this property to include the SAML ID of the issuer of the SAML message. A typical SAML ID is a string of semicolon-separated elements of one or more of the following elements:
- Format
- NameQualifier
- Value
- IDType
- SPNameQualifier
- SPProvidedID
For example,
```text
writer.Message.Subject = "Value=https://saml.entity.org/resource;Format=urn:oasis:names:tc:SAML:2.0:nameid-format:entity;IDType=Issuer";
```
**Version** *char**
*Default Value: "2.0"*
Specifies the protocol version to use for the SAML message.
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
**XMLHeader** *int*
*Default Value: FALSE*
Controls the inclusion of an XML header in the message.
Use this property to enable or disable inclusion of the XML header in the SAML message.
## Constructors
```text
SAMLMessage()
```
Creates a new SAMLMessage object.
# SAMLNameIDMappingRequest Type
Represents SAML NameIDMappingRequest element.
## Syntax
*SecureBlackboxSAMLNameIDMappingRequest* (declared in *secureblackbox.h*)
## Remarks
This type is a container for NameIDMappingRequest element.
The following fields are available:
- [NameID](#SAMLNameIDMappingRequest_f_NameID)
- [NameIDPolicyAllowCreate](#SAMLNameIDMappingRequest_f_NameIDPolicyAllowCreate)
- [NameIDPolicyFormat](#SAMLNameIDMappingRequest_f_NameIDPolicyFormat)
- [NameIDPolicySPNameQualifier](#SAMLNameIDMappingRequest_f_NameIDPolicySPNameQualifier)
- [NameIDPolicyUseAllowCreate](#SAMLNameIDMappingRequest_f_NameIDPolicyUseAllowCreate)
## Fields
**NameID** *char**
*Default Value: ""*
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.
**NameIDPolicyAllowCreate** *int*
*Default Value: FALSE*
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.
**NameIDPolicyFormat** *char**
*Default Value: ""*
Specifies the format of the NameIDPolicy element.
Use this property to set or read the value of the Format parameter of the NameIDPolicy object.
**NameIDPolicySPNameQualifier** *char**
*Default Value: ""*
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.
**NameIDPolicyUseAllowCreate** *int*
*Default Value: FALSE*
Controls inclusion of UseAllow modifier in the NameIDPolicy object.
Use this property to include or exclude the UseAllow parameter from the NameIDPolicy object.
## Constructors
```text
SAMLNameIDMappingRequest()
```
Creates a new SAMLNameIDMappingRequest object.
# SAMLResponse Type
Represents a SAML response.
## Syntax
*SecureBlackboxSAMLResponse* (declared in *secureblackbox.h*)
## Remarks
This is a container for SAML response parameters.
The following fields are available:
- [NameID](#SAMLResponse_f_NameID)
- [OptionalElement](#SAMLResponse_f_OptionalElement)
- [ResponseType](#SAMLResponse_f_ResponseType)
- [Status](#SAMLResponse_f_Status)
- [StatusCodeSubValue](#SAMLResponse_f_StatusCodeSubValue)
- [StatusCodeValue](#SAMLResponse_f_StatusCodeValue)
- [StatusDetail](#SAMLResponse_f_StatusDetail)
- [StatusMessage](#SAMLResponse_f_StatusMessage)
## Fields
**NameID** *char**
*Default Value: ""*
Contains the NameID parameter of a NameIDMapping response.
Use this property to read or set the NameID parameter of the NameIDMapping response.
**OptionalElement** *char**
*Default Value: ""*
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.
**ResponseType** *int*
*Default Value: 0*
Contains the type of the response.
Use this property to get or set the type of the SAML response.
**Status** *int*
*Default Value: 0*
Gets or sets the status of the response.
This property specifies the status code to include in the response. This property adjusts the values of the [StatusCodeValue](#SAMLResponse_f_StatusCodeValue) and other status properties.
This property is a bitwise combination of the status facility and an error code. The facility mask can be one of the following:
- 0x00000000 - Success (urn:oasis:names:tc:SAML:2.0:status:Success)
- 0x00010000 - Requester Error (urn:oasis:names:tc:SAML:2.0:status:Requester)
- 0x00020000 - Responder Error (urn:oasis:names:tc:SAML:2.0:status:Responder)
- 0x00030000 - Version Mismatch (urn:oasis:names:tc:SAML:2.0:status:VersionMismatch)
- 0x00FF0000 - Undefined or Unknown
The code assigned to the setting is saved in the response as the status given in the brackets.
The error code can take one of the following values:
- 0x00000001 - Authentication Failed (urn:oasis:names:tc:SAML:2.0:status:AuthnFailed)
- 0x00000002 - Unsupported content received within the received Attribute structure (urn:oasis:names:tc:SAML:2.0:status:InvalidAttrNameOrValue)
- 0x00000003 - The requested Name Identifier policy is not supported by the provider (urn:oasis:names:tc:SAML:2.0:status:InvalidNameIDPolicy)
- 0x00000004 - The requested Authentication Context requirements cannot be satisfied by the provider (urn:oasis:names:tc:SAML:2.0:status:NoAuthnContext)
- 0x00000005 - None of the elements in the IDP list can be resolved (urn:oasis:names:tc:SAML:2.0:status:NoAvailableIDP)
- 0x00000006 - The provider cannot authenticate the requestor passively (urn:oasis:names:tc:SAML:2.0:status:NoPassive)
- 0x00000007 - None of the requested providers in the IDP list are supported (urn:oasis:names:tc:SAML:2.0:status:NoSupportedIDP)
- 0x00000008 - The Logout request could not be passed on to other session participants (urn:oasis:names:tc:SAML:2.0:status:PartialLogout)
- 0x00000009 - Proxy count exceeded (urn:oasis:names:tc:SAML:2.0:status:ProxyCountExceeded)
- 0x0000000A - Request denied for internal reasons (urn:oasis:names:tc:SAML:2.0:status:RequestDenied)
- 0x0000000B - The request or its type is not supported by the provider (urn:oasis:names:tc:SAML:2.0:status:RequestUnsupported)
- 0x0000000C - The version of the request has been deprecated (urn:oasis:names:tc:SAML:2.0:status:RequestVersionDeprecated)
- 0x0000000D - The version of the request is too high (urn:oasis:names:tc:SAML:2.0:status:RequestVersionTooHigh)
- 0x0000000E - The version of the request is too low (urn:oasis:names:tc:SAML:2.0:status:RequestVersionTooLow)
- 0x0000000F - The resource included in the request has not been recognised (urn:oasis:names:tc:SAML:2.0:status:ResourceNotRecognized)
- 0x00000010 - The number of responses to be returned is too high for the provider to satisfy (urn:oasis:names:tc:SAML:2.0:status:TooManyResponses)
- 0x00000011 - The attribute profile is unknown to the provider (urn:oasis:names:tc:SAML:2.0:status:UnknownAttrProfile)
- 0x00000012 - The principal mentioned in the request is unknown to the provider (urn:oasis:names:tc:SAML:2.0:status:UnknownPrincipal)
- 0x00000013 - Unsupported binding type (urn:oasis:names:tc:SAML:2.0:status:UnsupportedBinding)
To return a custom error code not available via the above flags, use [StatusCodeValue](#SAMLResponse_f_StatusCodeValue) and [StatusCodeSubValue](#SAMLResponse_f_StatusCodeSubValue) properties.
**StatusCodeSubValue** *char**
*Default Value: ""*
The value of the nested StatusCode.
This property contains the value of the nested StatusCode element.
**StatusCodeValue** *char**
*Default Value: ""*
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'.
**StatusDetail** *char**
*Default Value: ""*
Contains additional information on the status of the request.
The StatusDetail element contains additional request status information.
**StatusMessage** *char**
*Default Value: ""*
Contains a status message (optional).
This property specifies the status message which may, optionally, be returned to an operator.
## Constructors
```text
SAMLResponse()
```
Creates a new SAMLResponse object.
# SAMLSecuritySettings Type
Represents SAML security settings for the message being viewed/edited.
## Syntax
*SecureBlackboxSAMLSecuritySettings* (declared in *secureblackbox.h*)
## Remarks
This type is a container for SAML security parameters.
The following fields are available:
- [CanonicalizationMethod](#SAMLSecuritySettings_f_CanonicalizationMethod)
- [DigestMethod](#SAMLSecuritySettings_f_DigestMethod)
- [EncryptionMethod](#SAMLSecuritySettings_f_EncryptionMethod)
- [Flags](#SAMLSecuritySettings_f_Flags)
- [SigMethod](#SAMLSecuritySettings_f_SigMethod)
- [SignaturePolicy](#SAMLSecuritySettings_f_SignaturePolicy)
## Fields
**CanonicalizationMethod** *char**
*Default Value: ""*
The canonicalization method to use in the signature.
The URI of the canonicalization method to use in the signature (e.g. http://www.w3.org/TR/xml-exc-c14n/)
**DigestMethod** *char**
*Default Value: ""*
The digest method to use.
The URI of the digest method to use for signing, as defined in XMLDSIG or XMLENC: http://www.w3.org/2000/09/xmldsig#sha256.
**EncryptionMethod** *char**
*Default Value: "AES256"*
The encryption method used to encrypt the assertion.
This property contains the encryption algorithm used to encrypt the XML assertion.
Supported values:
| | | |
| --- | --- | --- |
| SB_XML_ENCRYPTION_ALGORITHM_RC4 | RC4 | |
| SB_XML_ENCRYPTION_ALGORITHM_DES | DES | |
| SB_XML_ENCRYPTION_ALGORITHM_3DES | 3DEST | |
| SB_XML_ENCRYPTION_ALGORITHM_AES128 | AES128 | |
| SB_XML_ENCRYPTION_ALGORITHM_AES192 | AES192 | |
| SB_XML_ENCRYPTION_ALGORITHM_AES256 | AES256 | |
| SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA128 | Camellia128 | |
| SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA192 | Camellia192 | |
| SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA256 | Camellia256 | |
| SB_XML_ENCRYPTION_ALGORITHM_SEED | SEED | |
**Flags** *int*
*Default Value: 1*
Provides access to secondary security parameters and tweaks.
This property is a bitwise combination of zero or more flags. The following flags are currently supported: The following flags can be used with any SAML component (although they may not apply in all modes of use):
| | | |
| --- | --- | --- |
| ssfSignatureAfterIssuer | 1 | Place the Signature tag after the issuer tag in the XML document |
| ssfSignatureBeforeDescriptor | 2 | Place the Signature tag before the entity descriptor tag in the XML metadata |
| ssfKeyDataIssuerSerial | 4 | Include the IssuerSerial key data element |
| ssfKeyDataSKI | 8 | Include the SubjectKeyIdentifier key data element |
| ssfKeyDataSubjectName | 16 | Include the SubjectName key data element |
| ssfKeyDataCertificate | 32 | Include the Certificate key data element |
| ssfKeyDataCRL | 64 | Include the CRL key data element |
| ssfSignAuthnRequests | 65536 | Sign authentication requests (SP only) |
| ssfSignArtifactResolveRequests | 131072 | Sign artifact resolve requests |
| ssfSignLogoutRequests | 262144 | Sign logout requests |
| ssfSignAssertions | 524288 | Sign outgoing assertions (IdP only) |
| ssfSignResponses | 1048576 | Sign all responses (IdP only) |
| ssfEncryptAssertions | 2097152 | Encrypt generated assertions (IdP only) |
**SigMethod** *char**
*Default Value: ""*
The signature method to use.
The URI specifying the signature method to use for signing, for example http://www.w3.org/2001/04/xmldsig-more#rsa-sha256.
**SignaturePolicy** *int*
*Default Value: 0*
Specifies the signature validation policy.
Use this property to specify the signature validation policy for the component.
## Constructors
```text
SAMLSecuritySettings()
```
Creates a new SAMLSecuritySettings object.
# SAMLSubjectConfirmation Type
Represents SAML SubjectConfirmation element.
## Syntax
*SecureBlackboxSAMLSubjectConfirmation* (declared in *secureblackbox.h*)
## Remarks
This type is a container for SAML SubjectConfirmation element.
The following fields are available:
- [Address](#SAMLSubjectConfirmation_f_Address)
- [Data](#SAMLSubjectConfirmation_f_Data)
- [DataType](#SAMLSubjectConfirmation_f_DataType)
- [ID](#SAMLSubjectConfirmation_f_ID)
- [InResponseTo](#SAMLSubjectConfirmation_f_InResponseTo)
- [Method](#SAMLSubjectConfirmation_f_Method)
- [NotBefore](#SAMLSubjectConfirmation_f_NotBefore)
- [NotOnOrAfter](#SAMLSubjectConfirmation_f_NotOnOrAfter)
- [Recipient](#SAMLSubjectConfirmation_f_Recipient)
## Fields
**Address** *char**
*Default Value: ""*
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.
**Data** *char**
*Default Value: ""*
The uninterpreted value of data entry in the subject confirmation.
Use this property to read or specify the uninterpreted value of the Data entry in the subject confirmation blob.
**DataType** *char**
*Default Value: ""*
The type of data contained in the confirmation.
Use this property to read or specify the type of confirmation data included in the object.
**ID** *char**
*Default Value: ""*
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.
**InResponseTo** *char**
*Default Value: ""*
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.
**Method** *char**
*Default Value: ""*
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.
**NotBefore** *char**
*Default Value: ""*
Time moment before which the subject cannot be confirmed.
This property specifies the time before which the subject cannot be confirmed.
**NotOnOrAfter** *char**
*Default Value: ""*
Limits the time until which the subject can be confirmed.
This property specifies the time on (or after) which the subject cannot be confirmed.
**Recipient** *char**
*Default Value: ""*
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.
## Constructors
```text
SAMLSubjectConfirmation()
```
Creates a new SAMLSubjectConfirmation object.
# SecureBlackboxList Type
## Syntax
*SecureBlackboxList* (declared in *secureblackbox.h*)
## Remarks
*SecureBlackboxList* is a generic class that is used to hold a collection of objects of type *T*, where *T* is one of the custom types supported by the SAMLWriter class.
```text
int GetCount() {}
```
```text
int SetCount(int count) {}
```
```text
T* Get(int index) {}
```
```text
T* Set(int index, T* value) {}
```
| | |
| --- | --- |
| Methods | |
| GetCount | This method returns the current size of the collection. |
| SetCount | This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. |
| Get | This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified. |
| Set | This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class. |
# SecureBlackboxStream Type
## Syntax
*SecureBlackboxStream* (declared in *secureblackbox.h*)
## Remarks
The SAMLWriter class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the SecureBlackboxStream interface and pass the SAMLWriter class an instance of that concrete class.
When implementing the SecureBlackboxStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.
```text
bool CanRead() { return true; }
```
```text
bool CanSeek() { return true; }
```
```text
bool CanWrite() { return true; }
```
```text
int64 GetLength() = 0;
```
```text
void Close() {}
```
```text
int Flush() { return 0; }
```
```text
int Read(void* buffer, int count) = 0;
```
```text
int64 Seek(int64 offset, int seekOrigin) = 0;
```
```text
int Write(const void* buffer, int count) = 0;
```
| | |
| --- | --- |
| Properties | |
| CanRead | Whether the stream supports reading. |
| CanSeek | Whether the stream supports seeking. |
| CanWrite | Whether the stream supports writing. |
| Length | Gets the length of the stream, in bytes. |
| Methods | |
| Close | Closes the stream, releasing all resources currently allocated for it. This method is called automatically when a SecureBlackboxStream object is deleted. |
| Flush | Forces all data held by the stream's buffers to be written out to storage. Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0. |
| Read | Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read. Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed. |
| Seek | Sets the current position within the stream based on a particular point of origin. Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are: 0: Seek from beginning. 1: Seek from current position. 2: Seek from end. Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported. |
| Write | Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written. Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed. |
# Config Settings ([SAMLWriter](#samlwriter-class) Class)
The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [Config](#config-method-samlwriter-class) method.
### SAMLWriter Config Settings
**BodyOnly**: TBD.TBD
**DateTimeFormat**: TBD.TBD
**KeyDataElements**: TBD.TBD
**SAMLPrefix**: TBD.TBD
**SAMLProtocolPrefix**: TBD.TBD
**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.
**SigCanonicalizationMethod**: TBD.TBD
**SigDigestMethod**: TBD.TBD
**SigMethod**: TBD.TBD
**TimeZoneOffset**: TBD.TBD
### Base Config Settings
**ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it.
**AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.
**CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys.
**CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.
Supported values are:
| | | |
| --- | --- | --- |
| off | | No caching (default) |
| local | | Local caching |
| global | | Global caching |
**Cookies**: Gets or sets local cookies for the class.Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.
**DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.
**DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*.
**EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.
This setting only applies to sessions negotiated with TLS version 1.3.
**EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components.
**EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components.
**GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its *CookieCaching* property set to "global".
**HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy.
Supported Values:
| | |
| --- | --- |
| auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). |
| enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. |
| disable | Do not use hardware cryptography. |
**HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.
**HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.
**IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.
**ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.
**LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
| | | |
| --- | --- | --- |
| file | | File |
| console | | Console |
| systemlog | | System Log (supported for Android only) |
| debugger | | Debugger (supported for VCL for Windows and .Net) |
**LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.
Supported values are:
| | | |
| --- | --- | --- |
| time | | Current time |
| level | | Level |
| package | | Package name |
| module | | Module name |
| class | | Class name |
| method | | Method name |
| threadid | | Thread Id |
| contenttype | | Content type |
| content | | Content |
| all | | All details |
**LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file.
**LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
| | | |
| --- | --- | --- |
| exclude-package | | Exclude a package specified in the value |
| exclude-module | | Exclude a module specified in the value |
| exclude-class | | Exclude a class specified in the value |
| exclude-method | | Exclude a method specified in the value |
| include-package | | Include a package specified in the value |
| include-module | | Include a module specified in the value |
| include-class | | Include a class specified in the value |
| include-method | | Include a method specified in the value |
**LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
| | | |
| --- | --- | --- |
| none | | No flush (caching only) |
| immediate | | Immediate flush (real-time logging) |
| maxcount | | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
**LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
| | | |
| --- | --- | --- |
| none | | None (by default) |
| fatal | | Severe errors that cause premature termination. |
| error | | Other runtime errors or unexpected conditions. |
| warning | | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". |
| info | | Interesting runtime events (startup/shutdown). |
| debug | | Detailed information on flow of through the system. |
| trace | | More detailed information. |
**LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.
The default value of this setting is 100.
**LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:
| | | |
| --- | --- | --- |
| none | | No rotation |
| deleteolder | | Delete older entries from the cache upon reaching LogMaxEventCount |
| keepolder | | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
**MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.
**MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.
**OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.
**OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.
**PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.
Supported Values:
| | |
| --- | --- |
| certificate | Enables caching of certificates. |
| crl | Enables caching of Certificate Revocation Lists (CRLs). |
| ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. |
Example (default value):
```text
PKICache=certificate,crl,ocsp
```
In this example, the component caches certificates, CRLs, and OCSP responses.
**PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts.
The default value is an empty string - no cached PKI data is stored on disk.
Example:
```text
PKICachePath=C:\Temp\cache
```
In this example, the cached PKI data is stored in the C:\Temp\cache directory.
**ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).
**ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.
**StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*.
Supported values are:
| | | |
| --- | --- | --- |
| none | | No static DNS rules (default) |
| local | | Local static DNS rules |
| global | | Global static DNS rules |
**StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character.
**StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the class is set to "*local*", the property returns/restores the rules from/to the internal storage of the class. If *StaticDNS* of the class is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.
**Tag**: Allows to store any custom data.Use this config property to store any custom data.
**TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.
**TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).
**TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).
**UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.
**UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform.
**UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).
**UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.
**UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.
**UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores.
**UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team.
**UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.
This setting only applies to certificates originating from a Windows system store.
**UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.
**XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.
The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.
Syntax:
```text
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");
```
Where:
OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.
PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.
Alias1, Alias2, ...: Optional alternative names recognized during parsing.
Usage Examples:
Map OID 2.5.4.5 to SERIALNUMBER:
```text
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
```
Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:
```text
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");
```
**XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.
**XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).
**XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.
# Trappable Errors ([SAMLWriter](#samlwriter-class) Class)
## Error Handling (C++)
Call the *GetLastErrorCode()* method to obtain the last called method's result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.