SAMLWriter Class

Properties Methods Events Config Settings Errors

The SAMLWriter class offers SAML message generation functions.

Syntax

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

Note that you need to set the signing certificate before calling CreateNew.

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	Provides access to the Artifact element of the message.
ArtifactResolveQuery	Contains the artifact resolve query.
Assertion	Contains assertion information.
AssertionCount	Returns the number of assertions in the message.
Attributes	Contains a list of attributes to be added to the created object.
AuthnQuery	Provides access to the AuthnQuery SAML element.
AuthnRequest	Publishes the properties of AuthnRequest element.
AuthzDecisionQuery	Provides access to AuthzDecisionQuery element.
Binding	Provides access to the binding settings.
BindingKey	Contains a private key to sign the redirect binding requests.
Conditions	Contains a list of conditions for the created SAML object.
EncryptionCertificate	Sets the encryption certificate.
FIPSMode	Reserved.
LogoutRequest	Contains the properties of SAML LogoutRequest element.
ManageNameIDRequest	Provides access to ManageNameIDRequest element.
Message	Provides access to the Message element of the message.
NameIDMappingRequest	Publishes the properties of NameIDMappingRequest entity.
Profile	Specifies a pre-defined profile to apply when creating the signature.
References	Contains the References entry of the SAML AssertionIDRequest message.
Response	Provides access to the SAML response object properties.
ScopingIDPs	Provides access to the list of scoping IDP eleements.
Security	Provides access to the SAML security properties.
SigningCertificate	The certificate to be used for signing.
SigningChain	The signing certificate chain.
Statements	Contains a list of assertion statements.
SubjectConfirmations	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	Adds an attribute to an existing attribute statement.
AddAttributeStatement	Adds an attribute statement to the assertion.
AddAuthnStatement	Adds an authentication statement to the assertion.
AddAuthzDecisionStatement	Adds an authorization decision statement to the assertion.
AddCondition	Adds a condition to the object (assertion or authn request) being edited.
AddScopingIDP	Adds a scoping IDP to the object being currently edited.
AddSubjectConfirmation	Adds a subject confirmation to the object being edited.
BeginAssertion	Initiates the process of creating a new assertion.
CompleteAssertion	Adds a completed assertion to a SAML message.
Config	Sets or retrieves a configuration setting.
CreateNew	Creates a new SAML message with the given type.
DoAction	Performs an additional action.
FormatID	Formats a SAML ID in the form in which it can be assigned to the Issuer or Subject fields.
Reset	Resets the class settings.
Save	Saves the configured message to a string.
SaveBytes	Saves the configured message to a byte array.
SaveFile	Saves the configured message to a file.
SaveStream	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	Fires to report an error condition.
Notification	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	TBD.
DateTimeFormat	TBD.
KeyDataElements	TBD.
SAMLPrefix	TBD.
SAMLProtocolPrefix	TBD.
SigAfterIssuer	Specifies whether to insert the signature after the issuer tag in the SAML document.
SigCanonicalizationMethod	TBD.
SigDigestMethod	TBD.
SigMethod	TBD.
TimeZoneOffset	TBD.
ASN1UseGlobalTagCache	Controls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPins	Specifies whether CSP-level PINs should be assigned to CNG keys.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the class.
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
DNSLocalSuffix	The suffix to assign for TLD names.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicy	The hardware crypto usage policy.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
HttpVersion	The HTTP version to use in any inner HTTP client classes created.
IgnoreExpiredMSCTLSigningCert	Whether to tolerate the expired Windows Update signing certificate.
ListDelimiter	The delimiter character for multi-element lists.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
OldClientSideRSAFallback	Specifies whether the SSH client should use a SHA1 fallback.
PKICache	Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.
PKICachePath	Specifies the file system path where cached PKI data is stored.
ProductVersion	Returns the version of the SecureBlackbox library.
ServerSSLDHKeyLength	Sets the size of the TLS DHE key exchange group.
StaticDNS	Specifies whether static DNS rules should be used.
StaticIPAddress[domain]	Gets or sets an IP address for the specified domain name.
StaticIPAddresses	Gets or sets all the static DNS rules.
Tag	Allows to store any custom data.
TLSSessionGroup	Specifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetime	Specifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeInterval	Specifies how often the session cache should remove the expired TLS sessions.
UseCRLObjectCaching	Specifies whether reuse of loaded CRL objects is enabled.
UseInternalRandom	Switches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidation	Enables legacy AdES validation mode.
UseOCSPResponseObjectCaching	Specifies whether reuse of loaded OCSP response objects is enabled.
UseOwnDNSResolver	Specifies whether the client classes should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculation	An internal CryptoAPI access tweak.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.
XMLRDNDescriptorName[OID]	Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.
XMLRDNDescriptorPriority[OID]	Specifies the priority of descriptor names associated with a specific OID.
XMLRDNDescriptorReverseOrder	Specifies whether to reverse the order of descriptors in RDN.
XMLRDNDescriptorSeparator	Specifies the separator used between descriptors in RDN.

Artifact Property (SAMLWriter Class)

Provides access to the Artifact element of the message.

Syntax

public SAMLArtifact getArtifact();
public void setArtifact(SAMLArtifact artifact);

Remarks

Use this property to access and adjust the Artifact element of the created SAML message.

This property is not available at design time.

Please refer to the SAMLArtifact type for a complete list of fields.

ArtifactResolveQuery Property (SAMLWriter Class)

Contains the artifact resolve query.

Syntax

public String getArtifactResolveQuery();
public void setArtifactResolveQuery(String artifactResolveQuery);

Default Value

Remarks

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

This property is not available at design time.

Assertion Property (SAMLWriter Class)

Contains assertion information.

Syntax

public SAMLAssertion 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.

Please refer to the SAMLAssertion type for a complete list of fields.

AssertionCount Property (SAMLWriter Class)

Returns the number of assertions in the message.

Syntax

public int getAssertionCount();

Default Value

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.

Attributes Property (SAMLWriter Class)

Contains a list of attributes to be added to the created object.

Syntax

public SAMLAttributeList getAttributes();
public void setAttributes(SAMLAttributeList attributes);

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.

Please refer to the SAMLAttribute type for a complete list of fields.

AuthnQuery Property (SAMLWriter Class)

Provides access to the AuthnQuery SAML element.

Syntax

public SAMLAuthnQuery 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.

Please refer to the SAMLAuthnQuery type for a complete list of fields.

AuthnRequest Property (SAMLWriter Class)

Publishes the properties of AuthnRequest element.

Syntax

public SAMLAuthnRequest 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.

Please refer to the SAMLAuthnRequest type for a complete list of fields.

AuthzDecisionQuery Property (SAMLWriter Class)

Provides access to AuthzDecisionQuery element.

Syntax

public SAMLAuthzDecisionQuery 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.

Please refer to the SAMLAuthzDecisionQuery type for a complete list of fields.

Binding Property (SAMLWriter Class)

Provides access to the binding settings.

Syntax

public SAMLBinding 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.

Please refer to the SAMLBinding type for a complete list of fields.

BindingKey Property (SAMLWriter Class)

Contains a private key to sign the redirect binding requests.

Syntax

public CryptoKey getBindingKey();
public void setBindingKey(CryptoKey bindingKey);

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.

Please refer to the CryptoKey type for a complete list of fields.

Conditions Property (SAMLWriter Class)

Contains a list of conditions for the created SAML object.

Syntax

public SAMLConditionList getConditions();
public void setConditions(SAMLConditionList conditions);

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.

Please refer to the SAMLCondition type for a complete list of fields.

EncryptionCertificate Property (SAMLWriter Class)

Sets the encryption certificate.

Syntax

public Certificate getEncryptionCertificate();
public void setEncryptionCertificate(Certificate encryptionCertificate);

Remarks

Use this property to specify the encryption certificate for encrypted requests.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

FIPSMode Property (SAMLWriter Class)

Reserved.

Syntax

public boolean isFIPSMode();
public void setFIPSMode(boolean FIPSMode);

Default Value

False

Remarks

This property is reserved for future use.

LogoutRequest Property (SAMLWriter Class)

Contains the properties of SAML LogoutRequest element.

Syntax

public SAMLLogoutRequest getLogoutRequest();

Remarks

Use this property to access the settings of the LogoutRequest element.

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

Please refer to the SAMLLogoutRequest type for a complete list of fields.

ManageNameIDRequest Property (SAMLWriter Class)

Provides access to ManageNameIDRequest element.

Syntax

public SAMLManageNameIDRequest getManageNameIDRequest();

Remarks

Use this property to access the details of ManageNameIDRequest element.

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

Please refer to the SAMLManageNameIDRequest type for a complete list of fields.

Message Property (SAMLWriter Class)

Provides access to the Message element of the message.

Syntax

public SAMLMessage 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.

Please refer to the SAMLMessage type for a complete list of fields.

NameIDMappingRequest Property (SAMLWriter Class)

Publishes the properties of NameIDMappingRequest entity.

Syntax

public SAMLNameIDMappingRequest getNameIDMappingRequest();

Remarks

Use this property to access the details of SAML NameIDMappingRequest entity.

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

Please refer to the SAMLNameIDMappingRequest type for a complete list of fields.

Profile Property (SAMLWriter Class)

Specifies a pre-defined profile to apply when creating the signature.

Syntax

public String getProfile();
public void setProfile(String profile);

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.

References Property (SAMLWriter Class)

Contains the References entry of the SAML AssertionIDRequest message.

Syntax

public String getReferences();
public void setReferences(String references);

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.

Response Property (SAMLWriter Class)

Provides access to the SAML response object properties.

Syntax

public SAMLResponse 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.

Please refer to the SAMLResponse type for a complete list of fields.

ScopingIDPs Property (SAMLWriter Class)

Provides access to the list of scoping IDP eleements.

Syntax

public SAMLIDPEntryList getScopingIDPs();
public void setScopingIDPs(SAMLIDPEntryList scopingIDPs);

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.

Please refer to the SAMLIDPEntry type for a complete list of fields.

Security Property (SAMLWriter Class)

Provides access to the SAML security properties.

Syntax

public SAMLSecuritySettings 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.

Please refer to the SAMLSecuritySettings type for a complete list of fields.

SigningCertificate Property (SAMLWriter Class)

The certificate to be used for signing.

Syntax

public Certificate getSigningCertificate();
public void setSigningCertificate(Certificate signingCertificate);

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 to supply the rest of the certificate chain for inclusion into the signature.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

SigningChain Property (SAMLWriter Class)

The signing certificate chain.

Syntax

public CertificateList getSigningChain();
public void setSigningChain(CertificateList signingChain);

Remarks

Use this property to provide the chain for the signing certificate. Use the SigningCertificate property, if it is available, to provide the signing certificate itself.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

Statements Property (SAMLWriter Class)

Contains a list of assertion statements.

Syntax

public SAMLAssertionStatementList getStatements();
public void setStatements(SAMLAssertionStatementList statements);

Remarks

Use this property to access or set the list of assertion statements.

This property is not available at design time.

Please refer to the SAMLAssertionStatement type for a complete list of fields.

SubjectConfirmations Property (SAMLWriter Class)

Provides access to the list of subject confirmation elements.

Syntax

public SAMLSubjectConfirmationList getSubjectConfirmations();
public void setSubjectConfirmations(SAMLSubjectConfirmationList subjectConfirmations);

Remarks

Use this property to access the list of subject confirmation elements.

This property is not available at design time.

Please refer to the SAMLSubjectConfirmation type for a complete list of fields.

AddAttribute Method (SAMLWriter Class)

Adds an attribute to an existing attribute statement.

Syntax

public int addAttribute(String attributeName, String attributeValue, String nameFormat, String contentType, int statementIndex);

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:

<saml:Attribute Name="uid"  NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"  > <saml:AttributeValue xsi:type="xs:string"  >test  </saml:AttributeValue> </saml:Attribute> </code>

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

AddAttributeStatement Method (SAMLWriter Class)

Adds an attribute statement to the assertion.

Syntax

public 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 collection.

Note that a call to AddAttribute adds a new attribute statement behind the scenes if no attribute statements have been added by that time.

AddAuthnStatement Method (SAMLWriter Class)

Adds an authentication statement to the assertion.

Syntax

public int addAuthnStatement(String authnInstant, String sessionIndex, String notOnOrAfter, String classRef);

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

AddAuthzDecisionStatement Method (SAMLWriter Class)

Adds an authorization decision statement to the assertion.

Syntax

public int addAuthzDecisionStatement(int decision, String evidence, String resource, String actions);

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

AddCondition Method (SAMLWriter Class)

Adds a condition to the object (assertion or authn request) being edited.

Syntax

public int addCondition(int conditionType, String conditionValue);

Remarks

Use this method to quickly add a condition to the SAML object you are creating.

AddScopingIDP Method (SAMLWriter Class)

Adds a scoping IDP to the object being currently edited.

Syntax

public int addScopingIDP(String name, String providerID, String loc);

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

AddSubjectConfirmation Method (SAMLWriter Class)

Adds a subject confirmation to the object being edited.

Syntax

public int addSubjectConfirmation(String method, String address, String recipient, String inResponseTo, String notBefore, String notOnOrAfter, String ID, String dataType, String data);

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.

BeginAssertion Method (SAMLWriter Class)

Initiates the process of creating a new assertion.

Syntax

public void 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, as well as Statements and Attributes to prepare the new assertion. When ready, call CompleteAssertion to commit the provided details to the message.

CompleteAssertion Method (SAMLWriter Class)

Adds a completed assertion to a SAML message.

Syntax

public 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 and filling in the details via the Assertion, Attributes, and Statements properties.

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

Config Method (SAMLWriter Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CreateNew Method (SAMLWriter Class)

Creates a new SAML message with the given type.

Syntax

public void createNew(int contentType);

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 property to adjust context class references or comparison settings.

DoAction Method (SAMLWriter Class)

Performs an additional action.

Syntax

public String doAction(String actionID, String actionParams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Common ActionIDs:


Action	Parameters	Returned value	Description
ResetTrustedListCache	none	none	Clears the cached list of trusted lists.
ResetCertificateCache	none	none	Clears the cached certificates.
ResetCRLCache	none	none	Clears the cached CRLs.
ResetOCSPResponseCache	none	none	Clears the cached OCSP responses.

FormatID Method (SAMLWriter Class)

Formats a SAML ID in the form in which it can be assigned to the Issuer or Subject fields.

Syntax

public String formatID(String value, String IDType, String format, String nameQualifier, String SPNameQualifier, String SPProvidedID);

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: // 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", "", "", "", "", "");

Reset Method (SAMLWriter Class)

Resets the class settings.

Syntax

public void reset();

Remarks

Reset is a generic method available in every class.

Save Method (SAMLWriter Class)

Saves the configured message to a string.

Syntax

public String save();

Remarks

Use this method to save the created SAML message to a string.

SaveBytes Method (SAMLWriter Class)

Saves the configured message to a byte array.

Syntax

public byte[] saveBytes();

Remarks

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

SaveFile Method (SAMLWriter Class)

Saves the configured message to a file.

Syntax

public void saveFile(String fileName);

Remarks

Use this method to save the created SAML message to a file.

SaveStream Method (SAMLWriter Class)

Saves the configured message to a stream.

Syntax

public void saveStream(java.io.OutputStream outStream);

Remarks

Use this method to save the prepared SAML message to a stream.

Error Event (SAMLWriter Class)

Fires to report an error condition.

Syntax

public class DefaultSAMLWriterEventListener implements SAMLWriterEventListener {
  ...
  public void error(SAMLWriterErrorEvent e) {}
  ...
}

public class SAMLWriterErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

Subscribe to this event to be notified about any error conditions occurring during the component's work. ErrorCode and Description provide the details of the error.

Notification Event (SAMLWriter Class)

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

Syntax

public class DefaultSAMLWriterEventListener implements SAMLWriterEventListener {
  ...
  public void notification(SAMLWriterNotificationEvent e) {}
  ...
}

public class SAMLWriterNotificationEvent {
  public String eventID;
  public String eventParam;
}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

Certificate Type

Encapsulates an individual X.509 certificate.

Remarks

This type keeps and provides access to X.509 certificate details.

The following fields are available:

Fields

Bytes
byte[] (read-only)
Default Value: ""

Returns the raw certificate data in DER format.

CA
boolean
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
byte[] (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 generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the 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 object.

A Certificate 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 class to load or create new certificate and certificate requests objects.

CRLDistributionPoints
String
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
String
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
String (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
String (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.

HashAlgorithm
String
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 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
String (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.

IssuerRDN
String
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
String
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`

Use the KeyBits, Curve, and 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 or PrivateKeyBytes field would typically contain auxiliary values, and therefore be longer.

KeyFingerprint
String (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 field. The key fingeprint 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
boolean (read-only)
Default Value: False

Returns True if the certificate's key is cryptographically valid, and False otherwise.

OCSPLocations
String
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 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
boolean
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
String
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
byte[] (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
boolean (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, 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
boolean (read-only)
Default Value: False

Indicates whether the private key is extractable (exportable).

PublicKeyBytes
byte[] (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
boolean (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
String (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
boolean (read-only)
Default Value: False

Indicates whether the certificate is self-signed (root) or signed by an external CA.

SerialNumber
byte[]
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
String (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
String (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.

SubjectAlternativeName
String
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 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
byte[]
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 and 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
String
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
boolean (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
String
Default Value: ""

The time point at which the certificate becomes valid, in UTC.

ValidTo
String
Default Value: ""

The time point at which the certificate expires, in UTC.

Constructors

public Certificate( bytes,  startIndex,  count,  password);

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

public Certificate( certBytes,  certStartIndex,  certCount,  keyBytes,  keyStartIndex,  keyCount,  password);

Loads the X.509 certificate from a memory buffer.

CertBytes is a buffer containing the raw certificate data. CertStartIndex and CertCount specify the starting position and number of bytes to be read from the buffer, respectively.

KeyBytes is a buffer containing the private key data. KeyStartIndex and KeyCount specify the starting position and number of bytes to be read from the buffer, respectively.

Password is a password encrypting the certificate.

public Certificate( bytes,  startIndex,  count);

public Certificate( path,  password);

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data. Password is a password encrypting the certificate.

public Certificate( certPath,  keyPath,  password);

Loads the X.509 certificate from a file. CertPath specifies the full path to the file containing the certificate data. KeyPath specifies the full path to the file containing the private key. Password is a password encrypting the certificate.

public Certificate( path);

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.

public Certificate( stream);

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.

public Certificate( stream,  password);

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data. Password is a password encrypting the certificate.

public Certificate( certStream,  keyStream,  password);

Loads the X.509 certificate from a stream. CertStream is a stream containing the certificate data. KeyStream is a stream containing the private key. Password is a password encrypting the certificate.

public Certificate();

Creates a new object with default field values.

CryptoKey Type

This container represents a cryptographic key.

Remarks

This type is a universal placeholder for cryptographic keys.

The following fields are available:

Fields

Algorithm
String
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.


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
String
Default Value: ""

This property specifies the name of the curve the EC key is built on.

Exportable
boolean (read-only)
Default Value: False

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

Fingerprint
String (read-only)
Default Value: ""

Contains the fingerprint (a hash imprint) of this key.

ID
byte[]
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
byte[]
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.

Key
byte[] (read-only)
Default Value: ""

The byte array representation of the key. This may not be available for non-Exportable keys.

Nonce
byte[]
Default Value: ""

A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.

Private
boolean (read-only)
Default Value: False

Returns True if the object hosts a private key, and False otherwise.

Public
boolean (read-only)
Default Value: False

Returns True if the object hosts a public key, and False otherwise.

Subject
byte[]
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
boolean (read-only)
Default Value: False

Returns True if the object contains a symmetric key, and False otherwise.

Valid
boolean (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.

Constructors

public CryptoKey();

Creates an empty crypto key object.

SAMLArtifact Type

Represents a SAML Artifact entity.

Remarks

This type is a container for a SAML Artifact entity. A SAML artifact consists of a TypeCode, an EndpointIndex, and a RemainingArtifact, which contains the body of the artifact and varies depending on the TypeCode.

The following fields are available:

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
byte[]
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
byte[] (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
byte[]
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, SourceID, and MessageHandle parameters.

URI
String
Default Value: ""

An accessor to the URI property of the artifact.

The URI property contains the origin of the artifact.

Constructors

public SAMLArtifact();

Creates a new SAMLArtifact object.

SAMLAssertion Type

Contains parameters of a SAML assertion.

Remarks

Use this type to get or set general information about a SAML assertion.

The following fields are available:

SignatureValidationResult

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
String
Default Value: ""

Represents the encrypted assertion content.

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

ID
String
Default Value: ""

Represents the ID of the assertion.

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

IDRef
String
Default Value: ""

Represents an ID reference value.

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

IssueInstant
String
Default Value: ""

Contains the assertion issuance time stamp.

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

Issuer
String
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
boolean
Default Value: False

Specifies whether the assertion is signed.

Use this property to establish whether the assertion is signed.

Subject
String
Default Value: ""

Specifies the assertion subject.

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

URIRef
String
Default Value: ""

Represents an URI reference value.

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

Version
String
Default Value: ""

Specifies the SAML protocol version used.

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

Constructors

public SAMLAssertion();

Creates a new SAMLAssertion object.

SAMLAssertionStatement Type

Represents an assertion statement.

Remarks

This type is a container for an assertion statement.

The following fields are available:

AuthnContextAuthenticatingAuthorities

AuthnSessionNotOnOrAfter

AuthnSubjectLocalityAddress

AuthnSubjectLocalityDNSName

AuthzActions

AuthzDecision

AuthzDecisionEvidence

AuthzDecisionResource

StatementType

Fields

AuthnContextAuthenticatingAuthorities
String
Default Value: ""

Contains the list of authenticating authorities.

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

AuthnContextChoice
String
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
String
Default Value: ""

Indicates the authentication contexts class reference.

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

AuthnContextDecl
String
Default Value: ""

Specifies the authentication contexts declaration.

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

AuthnContextDeclRef
String
Default Value: ""

Specifies the authentication contexts declaration reference.

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

AuthnInstant
String
Default Value: ""

Specifies the authentication event timestamp.

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

AuthnSessionIndex
String
Default Value: ""

Contains the authentication session index.

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

AuthnSessionNotOnOrAfter
String
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
String
Default Value: ""

Specifies the authentication subjects address.

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

AuthnSubjectLocalityDNSName
String
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
String
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
String
Default Value: ""

Manages the authorization decision statement evidence parameter.

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

AuthzDecisionResource
String
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

public SAMLAssertionStatement();

Creates a new SAMLAssertionStatement object.

SAMLAttribute Type

A container for the SAML attribute object.

Remarks

This type is a container for the SAML attribute object.

The following fields are available:

Fields

FriendlyName
String
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
String
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
String
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
String
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

public SAMLAttribute();

Creates a new SAMLAttribute object.

SAMLAuthnQuery Type

A container for AuthnQuery element.

Remarks

This type is a container for SAML AuthnQuery element, which represents an authentication event query.

The following fields are available:

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
String
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
String
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

public SAMLAuthnQuery();

Creates a new SAMLAuthnQuery object.

SAMLAuthnRequest Type

Represents a SAML AuthnRequest object.

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

AssertionConsumerServiceURL

AttributeConsumingServiceIndex

NameIDPolicyAllowCreate

NameIDPolicyFormat

NameIDPolicySPNameQualifier

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
String
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
String
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
boolean
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
boolean
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
boolean
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
String
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
String
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
String
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
String
Default Value: ""

Specifies the name of the requestor.

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

ScopingGetComplete
String
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
String
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

public SAMLAuthnRequest();

Creates a new SAMLAuthnRequest object.

SAMLAuthzDecisionQuery Type

Represents SAML AuthzDecisionQuery element.

Remarks

This type is a container for SAML AuthzDecisionQuery type.

The following fields are available:

Actions

Resource

Fields

Actions
String
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
String
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

public SAMLAuthzDecisionQuery();

Creates a new SAMLAuthzDecisionQuery object.

SAMLBinding Type

Contains parameters of SAML binding.

Remarks

This type is a container for properties of SAML binding mechanism.

The following fields are available:

SignatureValidationResult

Signed

URL

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
String
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
String
Default Value: ""

Specifies the message encoding.

Use this property to access or set the message encoding.

ForceSign
boolean
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.

FormTemplate
String
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
String
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
String
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
boolean
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 property to enforce signatures on all binding entities.

URL
String
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
boolean
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

public SAMLBinding();

Creates a new SAMLBinding object.

SAMLCondition Type

Represents a SAML condition parameter.

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

ConditionType

Fields

Condition
String
Default Value: ""

The condition set in accordance with the 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

public SAMLCondition();

Creates a new SAMLAssertionCondition object.

SAMLIDPEntry Type

Represents a single identity provider information.

Remarks

This type is a container of single identity provider-specific details.

The following fields are available:

Loc

Name

ProviderID

Fields

Loc
String
Default Value: ""

Contains the value of the Loc attribute.

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

Name
String
Default Value: ""

Contains the name of the IdP provider.

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

ProviderID
String
Default Value: ""

Contains the provider ID.

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

Constructors

public SAMLIDPEntry();

Creates a new SAMLIDPEntry object.

SAMLLogoutRequest Type

Represents SAML LogoutRequest element.

Remarks

This type is a container for SAML LogoutRequest element.

The following fields are available:

Fields

NameID
String
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
String
Default Value: ""

Contains the value of the NotOnOrAfter parameter.

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

Reason
String
Default Value: ""

Contains the value of the Reason parameter.

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

SessionIndexes
String
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

public SAMLLogoutRequest();

Creates a new SAMLLogoutRequest object.

SAMLManageNameIDRequest Type

Represents a SAML ManageNameIDRequest element.

Remarks

This type is a container for ManageNameIDRequest element.

The following fields are available:

Fields

NameID
String
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
String
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
String
Default Value: ""

Contains the value of the NewID parameter.

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

Terminate
String
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

public SAMLManageNameIDRequest();

Creates a new SAMLManageNameIDRequest object.

SAMLMessage Type

Contains general parameters of a SAML message.

Remarks

Use this type to get or set general information about a SAML message.

The following fields are available:

SignatureValidationResult

Fields

Consent
String
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
String (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
String
Default Value: ""

Contains the Destination parameter of the SAML message.

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

ID
String
Default Value: ""

The ID of the request.

Use this property to specify the ID of the SAML request or response.

InResponseTo
String
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
String
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
String
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,

  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
boolean
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
String
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,

  writer.Message.Subject = "Value=https://saml.entity.org/resource;Format=urn:oasis:names:tc:SAML:2.0:nameid-format:entity;IDType=Issuer";

Version
String
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
boolean
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

public SAMLMessage();

Creates a new SAMLMessage object.

SAMLNameIDMappingRequest Type

Represents SAML NameIDMappingRequest element.

Remarks

This type is a container for NameIDMappingRequest element.

The following fields are available:

NameID

NameIDPolicyAllowCreate

NameIDPolicyFormat

NameIDPolicySPNameQualifier

NameIDPolicyUseAllowCreate

Fields

NameID
String
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
boolean
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
String
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
String
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
boolean
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

public SAMLNameIDMappingRequest();

Creates a new SAMLNameIDMappingRequest object.

SAMLResponse Type

Represents a SAML response.

Remarks

This is a container for SAML response parameters.

The following fields are available:

Fields

NameID
String
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
String
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 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 and StatusCodeSubValue properties.

StatusCodeSubValue
String
Default Value: ""

The value of the nested StatusCode.

This property contains the value of the nested StatusCode element.

StatusCodeValue
String
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
String
Default Value: ""

Contains additional information on the status of the request.

The StatusDetail element contains additional request status information.

StatusMessage
String
Default Value: ""

Contains a status message (optional).

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

Constructors

public SAMLResponse();

Creates a new SAMLResponse object.

SAMLSecuritySettings Type

Represents SAML security settings for the message being viewed/edited.

Remarks

This type is a container for SAML security parameters.

The following fields are available:

CanonicalizationMethod

Fields

CanonicalizationMethod
String
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
String
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
String
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
String
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

public SAMLSecuritySettings();

Creates a new SAMLSecuritySettings object.

SAMLSubjectConfirmation Type

Represents SAML SubjectConfirmation element.

Remarks

This type is a container for SAML SubjectConfirmating element.

The following fields are available:

Fields

Address
String
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
String
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
String
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
String
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
String
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
String
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
String
Default Value: ""

Time moment before which the subject cannot be confirmed.

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

NotOnOrAfter
String
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
String
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

public SAMLSubjectConfirmation();

Creates a new SAMLSubjectConfirmation object.

Config Settings (SAMLWriter Class)

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

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

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: auto, enable, or disable.

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): 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: 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 devided 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 chached 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: 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: Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: 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 Class)