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.
| AddXMLHeader | Controls the inclusion of an XML header in the message. |
| Artifact | Provides access to the Artifact element of the message. |
| ArtifactResolveQuery | Contains the artifact resolve query. |
| AssertionAttributes | Contains a list of assertion attributes. |
| AssertionConditions | Contains a list of assertion conditions. |
| AssertionCount | Returns the number of assertions in the message. |
| AssertionIDRequest | Contains the properties of AssertionIDRequest element. |
| AssertionInfo | Contains assertion information. |
| AssertionIssuer | Specifies the assertion issuer. |
| AssertionStatements | Contains assertion statements. |
| AssertionSubjectConfirmations | Provides access to assertion SubjectConfirmations list. |
| AssertionSubjectID | Specifies the assertion subject ID. |
| AttrQueryAttributes | Contains a list of attribute query attributes. |
| AuthnQuery | Provides access to the AuthnQuery SAML element. |
| AuthnRequest | Publishes the properties of AuthnRequest element. |
| AuthnRequestConditions | Contains a list of AuthnRequest conditions. |
| AuthnRequestScopingIDPList | Provides access to the list of scoping IDP eleements. |
| AuthzDecisionQuery | Provides access to AuthzDecisionQuery element. |
| Binding | Specifies the type of the binding to use. |
| Consent | Contains the Consent parameter of the request. |
| Destination | Contains the Destination parameter of the SAML object. |
| EncryptionCertificate | Sets the encryption certificate. |
| FIPSMode | Reserved. |
| ID | The ID of the request. |
| InResponseTo | Contains the InResponseTo property of the SAML request. |
| IssueInstant | Contains request issuance timestamp. |
| Issuer | Sets the issuer of the message. |
| LogoutRequest | Contains the properties of SAML LogoutRequest element. |
| ManageNameIDRequest | Provides access to ManageNameIDRequest element. |
| NameIDMappingRequest | Publishes the properties of NameIDMappingRequest entity. |
| OutputType | Returns the SAML type of message being created. |
| POSTBinding | Exposes the POST binding properties. |
| Profile | Specifies a pre-defined profile to apply when creating the signature. |
| RedirectBinding | Publishes the redirect binding settings. |
| RedirectBindingCertificate | Contains a certificate to sign the redirect binding. |
| Response | Provides access to the SAML response object properties. |
| SigCanonicalizationMethod | The canonicalization method to use in the signature. |
| SigDigestMethod | The digest method to use. |
| SigMethod | The signature method to use. |
| Sign | Specifies whether the created SAML message should be signed. |
| SigningCertificate | The certificate to be used for signing. |
| SigningChain | The signing certificate chain. |
| SubjectConfirmations | Provides access to the list of subject confirmation elements. |
| SubjectID | Sets the subject of the message. |
| Version | Specifies the protocol version of the SAML message. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| AddAdviceAssertion | Adds an advice assertion to the message. |
| AddAssertion | Adds assertion to a SAML message. |
| ClearAssertion | Resets the contents of all assertion-related properties. |
| CompareIDs | Compares two SAML IDs. |
| Config | Sets or retrieves a configuration setting. |
| CreateNew | Creates a new SAML message with the given type. |
| DoAction | Performs an additional action. |
| GetIDProp | Returns an element of the SAML ID. |
| RemoveAdvice | Removes an advice from an assertion. |
| RemoveAdviceAssertion | Removes an advice from an assertion. |
| RemoveAllAssertions | Removes all assertions currently configured in the message. |
| RemoveAssertion | Removes an assertion from the message. |
| 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.
| IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
| SigAfterIssuer | Specifies whether to insert the signature after the issuer tag in the SAML document. |
| TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
| UseMicrosoftCTL | Enables or disables automatic use of Microsoft online certificate trust list. |
| UseSystemCertificates | Enables or disables the use of the system certificates. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| 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. |
| 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. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
AddXMLHeader Property (SAMLWriter Class)
Controls the inclusion of an XML header in the message.
Syntax
public boolean isAddXMLHeader(); public void setAddXMLHeader(boolean addXMLHeader);
Default Value
False
Remarks
Use this property to enable or disable inclusion of the XML header in the SAML message.
This property is not available at design time.
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.
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.
AssertionAttributes Property (SAMLWriter Class)
Contains a list of assertion attributes.
Syntax
public SAMLAttributeList getAssertionAttributes(); public void setAssertionAttributes(SAMLAttributeList assertionAttributes);
Remarks
Use this property to configure the list of assertion attributes for the new SAML message.
This property is not available at design time.
AssertionConditions Property (SAMLWriter Class)
Contains a list of assertion conditions.
Syntax
public SAMLAssertionConditionList getAssertionConditions(); public void setAssertionConditions(SAMLAssertionConditionList assertionConditions);
Remarks
Use this property to tune-up assertion conditions to be included in the message.
This property is not available at design time.
AssertionCount Property (SAMLWriter Class)
Returns the number of assertions in the message.
Syntax
public int getAssertionCount();
Default Value
0
Remarks
This property returns the total number of assertions currently defined in the SAML message.
This property is read-only and not available at design time.
AssertionIDRequest Property (SAMLWriter Class)
Contains the properties of AssertionIDRequest element.
Syntax
public SAMLAssertionIDRequest getAssertionIDRequest();
Remarks
Use this property to access the properties of AssertionIDRequest element.
This property is read-only and not available at design time.
AssertionInfo Property (SAMLWriter Class)
Contains assertion information.
Syntax
public SAMLAssertionInfo getAssertionInfo();
Remarks
Use this property to access and/or modify the SAML assertion information.
This property is read-only and not available at design time.
AssertionIssuer Property (SAMLWriter Class)
Specifies the assertion issuer.
Syntax
public String getAssertionIssuer(); public void setAssertionIssuer(String assertionIssuer);
Default Value
""
Remarks
Use this property to provide the assertion issuer ID.
This property is not available at design time.
AssertionStatements Property (SAMLWriter Class)
Contains assertion statements.
Syntax
public SAMLAssertionStatementList getAssertionStatements(); public void setAssertionStatements(SAMLAssertionStatementList assertionStatements);
Remarks
Use this property to access or set the assertion statements.
This property is not available at design time.
AssertionSubjectConfirmations Property (SAMLWriter Class)
Provides access to assertion SubjectConfirmations list.
Syntax
public SAMLSubjectConfirmationList getAssertionSubjectConfirmations(); public void setAssertionSubjectConfirmations(SAMLSubjectConfirmationList assertionSubjectConfirmations);
Remarks
Use this property to access the list of assertions SubjectConfirmation elements.
This property is not available at design time.
AssertionSubjectID Property (SAMLWriter Class)
Specifies the assertion subject ID.
Syntax
public String getAssertionSubjectID(); public void setAssertionSubjectID(String assertionSubjectID);
Default Value
""
Remarks
Use this property to provide the assertion's subject SAML ID.
This property is not available at design time.
AttrQueryAttributes Property (SAMLWriter Class)
Contains a list of attribute query attributes.
Syntax
public SAMLAttributeList getAttrQueryAttributes(); public void setAttrQueryAttributes(SAMLAttributeList attrQueryAttributes);
Remarks
Use this property to set up a list of attribute query attributes.
This property is not available at design time.
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.
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.
AuthnRequestConditions Property (SAMLWriter Class)
Contains a list of AuthnRequest conditions.
Syntax
public SAMLAssertionConditionList getAuthnRequestConditions(); public void setAuthnRequestConditions(SAMLAssertionConditionList authnRequestConditions);
Remarks
Use this property to set up the conditions of the AuthnRequest element.
This property is not available at design time.
AuthnRequestScopingIDPList Property (SAMLWriter Class)
Provides access to the list of scoping IDP eleements.
Syntax
public SAMLIDPEntryList getAuthnRequestScopingIDPList(); public void setAuthnRequestScopingIDPList(SAMLIDPEntryList authnRequestScopingIDPList);
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.
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.
Binding Property (SAMLWriter Class)
Specifies the type of the binding to use.
Syntax
public int getBinding(); public void setBinding(int binding); Enumerated values: public final static int csbtNone = 0; public final static int csbtSOAP = 1; public final static int csbtPAOS = 2; public final static int csbtRedirect = 3; public final static int csbtPOST = 4; public final static int csbtArtifact = 5;
Default Value
0
Remarks
Use this property to specify the binding type to use with the request.
Consent Property (SAMLWriter Class)
Contains the Consent parameter of the request.
Syntax
public String getConsent(); public void setConsent(String consent);
Default Value
""
Remarks
Use this property to specify the Consent parameter of the SAML entity.
This property is not available at design time.
Destination Property (SAMLWriter Class)
Contains the Destination parameter of the SAML object.
Syntax
public String getDestination(); public void setDestination(String destination);
Default Value
""
Remarks
Use this property to set the Destination parameter of the created SAML object.
This property is not available at design time.
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.
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.
ID Property (SAMLWriter Class)
The ID of the request.
Syntax
public String getID(); public void setID(String ID);
Default Value
""
Remarks
Use this property to specify the ID of the request.
This property is not available at design time.
InResponseTo Property (SAMLWriter Class)
Contains the InResponseTo property of the SAML request.
Syntax
public String getInResponseTo(); public void setInResponseTo(String inResponseTo);
Default Value
""
Remarks
Use this property to specify the ID of the message in response to which the current entity is provided.
This property is not available at design time.
IssueInstant Property (SAMLWriter Class)
Contains request issuance timestamp.
Syntax
public String getIssueInstant(); public void setIssueInstant(String issueInstant);
Default Value
""
Remarks
Set this property to specify the time moment of the request formation. Leave it empty to use the current system time.
This property is not available at design time.
Issuer Property (SAMLWriter Class)
Sets the issuer of the message.
Syntax
public String getIssuer(); public void setIssuer(String issuer);
Default Value
""
Remarks
Set this property to include the SAML ID of the issuer of the SAML message. A typical SAML ID is a string of semicolon-separated elements of one or more of the following elements:
- Format
- NameQualifier
- Value
- IDType
- SPNameQualifier
- SPProvidedID
writer.Issuer = "Value=https://saml.entity.org/resource;Format=urn:oasis:names:tc:SAML:2.0:nameid-format:entity;IDType=Issuer";
This property is not available at design time.
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.
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.
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.
OutputType Property (SAMLWriter Class)
Returns the SAML type of message being created.
Syntax
public int getOutputType(); Enumerated values: public final static int cstyNone = 0; public final static int cstyAssertionIDRequest = 1; public final static int cstySubjectQuery = 2; public final static int cstyAuthnQuery = 3; public final static int cstyAttributeQuery = 4; public final static int cstyAuthzDecisionQuery = 5; public final static int cstyAuthnRequest = 6; public final static int cstyManageNameIDRequest = 7; public final static int cstyLogoutRequest = 8; public final static int cstyNameIDMappingRequest = 9; public final static int cstyArtifactResolve = 10; public final static int cstyResponse = 11;
Default Value
0
Remarks
Use this property to check the type of SAML message being created. This is the same value that was passed to CreateNew call.
Depending on the assigned type, use properties of class to tune up the parameters of the chosen message type. For example, if setting OutputType to cstyAuthnQuery, use AuthnQuery property to adjust context class references or comparison settings.
This property is read-only and not available at design time.
POSTBinding Property (SAMLWriter Class)
Exposes the POST binding properties.
Syntax
public SAMLPOSTBinding getPOSTBinding();
Remarks
Use this property to access the POST binding settings.
This property is read-only and not available at design time.
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.
RedirectBinding Property (SAMLWriter Class)
Publishes the redirect binding settings.
Syntax
public SAMLRedirectBinding getRedirectBinding();
Remarks
Use this property to access the redirect binding settings.
This property is read-only and not available at design time.
RedirectBindingCertificate Property (SAMLWriter Class)
Contains a certificate to sign the redirect binding.
Syntax
public Certificate getRedirectBindingCertificate(); public void setRedirectBindingCertificate(Certificate redirectBindingCertificate);
Remarks
Use this property to set the signing certificate for the redirect binding object. This is different to SigningCertificate and is used to sign the content of the redirect binding.
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.
SigCanonicalizationMethod Property (SAMLWriter Class)
The canonicalization method to use in the signature.
Syntax
public String getSigCanonicalizationMethod(); public void setSigCanonicalizationMethod(String sigCanonicalizationMethod);
Default Value
""
Remarks
The URI of the canonicalization method to use in the signature (e.g. http://www.w3.org/TR/xml-exc-c14n/)
SigDigestMethod Property (SAMLWriter Class)
The digest method to use.
Syntax
public String getSigDigestMethod(); public void setSigDigestMethod(String sigDigestMethod);
Default Value
""
Remarks
The URI of the digest method to use for signing, as defined in XMLDSIG or XMLENC: http://www.w3.org/2000/09/xmldsig#sha256.
SigMethod Property (SAMLWriter Class)
The signature method to use.
Syntax
public String getSigMethod(); public void setSigMethod(String sigMethod);
Default Value
""
Remarks
The URI specifying the signature method to use for signing, for example http://www.w3.org/2001/04/xmldsig-more#rsa-sha256.
Sign Property (SAMLWriter Class)
Specifies whether the created SAML message should be signed.
Syntax
public boolean isSign(); public void setSign(boolean sign);
Default Value
False
Remarks
Set this property to true to indicate that you want the created message to be signed.
This property is not available at design time.
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.
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 SigningCertificate property, if it is available, to provide the signing certificate itself.
This property is not available at design time.
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.
SubjectID Property (SAMLWriter Class)
Sets the subject of the message.
Syntax
public String getSubjectID(); public void setSubjectID(String subjectID);
Default Value
""
Remarks
Use this property to set the SAML ID of the message subject.
This property is not available at design time.
Version Property (SAMLWriter Class)
Specifies the protocol version of the SAML message.
Syntax
public String getVersion(); public void setVersion(String version);
Default Value
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
This property is not available at design time.
AddAdviceAssertion Method (Samlwriter Class)
Adds an advice assertion to the message.
Syntax
public int addAdviceAssertion(int assertionIndex);
Remarks
Use this method to add an advice assertion to a SAML assertion message. Provide the index of the assertion via AssertionIndex parameter.
This method returns the index of the newly added advice assertion in the list.
AddAssertion Method (Samlwriter Class)
Adds assertion to a SAML message.
Syntax
public int addAssertion();
Remarks
Use this method to add an assertion to the SAML message being created. The assertion details to add are taken from the components AssertionXXX properties, such as AssertionInfo AssertionStatements, or AssertionAttributes.
The method returns the index of the new assertion in the list.
ClearAssertion Method (Samlwriter Class)
Resets the contents of all assertion-related properties.
Syntax
public void clearAssertion();
Remarks
Use this method to clear the contents of all assertion-related properties, such as AssertionAttributes, to clean up the assertion settings when preparing the component for adding a new assertion.
CompareIDs Method (Samlwriter Class)
Compares two SAML IDs.
Syntax
public boolean compareIDs(String ID1, String ID2);
Remarks
This utility method compares two SAML identifiers for equality.
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 outputType);
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)
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 of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
GetIDProp Method (Samlwriter Class)
Returns an element of the SAML ID.
Syntax
public String getIDProp(String ID, String propName);
Remarks
This is a utility method that simplifies retrieval of a specific property within a SAML ID. Pass the name of the ID property to the PropName parameter, and the ID to the ID parameter.
The following ID properties are supported:
- Format
- NameQualifier
- IDType
- SPNameQualifier
- SPProvidedID
- Value
RemoveAdvice Method (Samlwriter Class)
Removes an advice from an assertion.
Syntax
public void removeAdvice(int assertionIndex);
Remarks
Use this method to remove an advice from an assertion. Pass the assertion index via the AssertionIndex parameter.
RemoveAdviceAssertion Method (Samlwriter Class)
Removes an advice from an assertion.
Syntax
public void removeAdviceAssertion(int assertionIndex, int adviceAssertionIndex);
Remarks
Use this method to remove an advice assertion from an assertion.
RemoveAllAssertions Method (Samlwriter Class)
Removes all assertions currently configured in the message.
Syntax
public void removeAllAssertions();
Remarks
Use this message to remove all assertions currently set up in the SAML message.
RemoveAssertion Method (Samlwriter Class)
Removes an assertion from the message.
Syntax
public void removeAssertion(int assertionIndex);
Remarks
Use this message to remove an assertion from a SAML message. Pass the assertion index as a parameter.
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 component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
Certificate Type
Provides details of an individual X.509 certificate.
Remarks
This type provides access to X.509 certificate details.
Fields
|
Bytes byte[] |
Returns raw certificate data in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CA boolean |
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CAKeyID byte[] |
A unique identifier (fingerprint) of the CA certificate's private key. Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CRLDistributionPoints String |
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Curve String |
Specifies the elliptic curve of the EC public key.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Fingerprint byte[] |
Contains the fingerprint (a hash imprint) of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
FriendlyName String |
Contains an associated alias (friendly name) of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
HashAlgorithm String |
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Issuer String |
The common name of the certificate issuer (CA), typically a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
IssuerRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyAlgorithm String |
Specifies the public key algorithm of this certificate.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyBits int |
Returns the length of the public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyFingerprint byte[] |
Returns a fingerprint of the public key contained in the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyUsage int |
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:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyValid boolean |
Returns True if the certificate's key is cryptographically valid, and False otherwise. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
OCSPLocations String |
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
OCSPNoCheck boolean |
Accessor to the value of the certificates ocsp-no-check extension. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Origin int |
Returns the origin of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PolicyIDs String |
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. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PrivateKeyBytes byte[] |
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PrivateKeyExists boolean |
Indicates whether the certificate has an associated private key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PrivateKeyExtractable boolean |
Indicates whether the private key is extractable |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PublicKeyBytes byte[] |
Contains the certificate's public key in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
QualifiedStatements int |
Returns the qualified status of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SelfSigned boolean |
Indicates whether the certificate is self-signed (root) or signed by an external CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SerialNumber byte[] |
Returns the certificate's serial number. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SigAlgorithm String |
Indicates the algorithm that was used by the CA to sign this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Subject String |
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SubjectAlternativeName String |
Returns or sets the value of the Subject Alternative Name extension of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SubjectKeyID byte[] |
Contains a unique identifier (fingerprint) of the certificate's private key. Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SubjectRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ValidFrom String |
The time point at which the certificate becomes valid, in UTC. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ValidTo String |
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 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);
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.
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.
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.
Fields
|
EndpointIndex int |
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[] |
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[] |
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[] |
An accessor to the SourceID property of the artifact. SourceID uniquely identifies the issuer of the artifact. |
|
TypeCode int |
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 |
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.
SAMLAssertionCondition Type
Represents a SAML assertion Condition parameter.
Remarks
This type is a container for a single Condition parameter of a SAML assertion.
Fields
|
AudienceList String |
An accessor to the Audience list parameter of an audience restriction condition. Use this property to read or set a list of audiences included in the restriction. Each audience is represented by an URI. Provide multiple audiences by splitting them with CRLF separators. |
|
ConditionType int |
Specifies a type of the condition object. Use this property to check or specify a type of the condition object. This can be either an audience restriction, a one time use limitation, or a proxy restriction. |
|
ProxyRestrictionCount int |
An accessor to the proxy restriction count element of the condition. Use this setting to access or set the value of the proxy restriction count condition. |
Constructors
public SAMLAssertionCondition();
Creates a new SAMLAssertionCondition object.
SAMLAssertionIDRequest Type
Represents a SAML AssertionIDRequest object.
Remarks
This type is a container for a SAML AssertionIDRequest element. This element is used to request assertions by their IDs.
Fields
|
References String |
Contains the References entry of the SAML assertion ID request. Use this property to read or specify the value of the References entry of the Assertion ID Request. |
Constructors
public SAMLAssertionIDRequest();
Creates a new SAMLAssertionIDRequest object.
SAMLAssertionInfo Type
Contains information about a SAML assertion.
Remarks
Use this type to get general information about a SAML assertion.
Fields
|
AdviceAssertionCount int |
Contains the number of advice assertions. Use this property to access the number of advice assertions. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
AssertionType int |
Specifies the type of the assertion. Use this property to check or set the type of the assertion. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ChainValidationDetails int |
The details of a certificate chain validation outcome. They may often suggest what reasons that contributed to the overall validation result. Returns a bit mask of the following options:
|
||||||||||||||||||||||||||||||||||||||||||||||||
|
ChainValidationResult int |
The outcome of a certificate chain validation routine. Available options:
Use the ValidationLog property to access the detailed validation log. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ConditionsNotBefore String |
Represents the Conditions.NotBefore assertion property. Use this property to get or set the Conditions.NotBefore property of the assertion. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ConditionsNotOnOrAfter String |
Represents the Conditions.NotOnOrAfter assertion property. Use this property to get or set the Conditions.NotOnOrAfter property of the assertion. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
EncryptedContent String |
Represents the encrypted assertion content. Use this property to get or set the encrypted assertion content. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ID String |
Represents the ID of the assertion. Use this property to read or set the unique ID of the assertion. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
IDRef String |
Represents an ID reference value. Use this property to read or set the ID reference value for assertions of csatAssertionIDRef type. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
IssueInstant String |
Contains the assertion issuance time stamp. Use this property to check or set the assertion issuance time. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
SignatureValidationResult int |
The outcome of the cryptographic signature validation. The following signature validity values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||
|
Signed boolean |
Specifies whether the assertion is signed. Use this property to establish whether the assertion is signed. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
URIRef String |
Represents an URI reference value. Use this property to read or set the URI reference value for assertions of csatAssertionURIRef type. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ValidationLog String |
Contains the signing certificate's chain validation log. This information may be very useful in investigating chain validation failures. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
Version String |
Specifies the SAML protocol version used. This property specifies the SAML protocol version. The default value is 2.0. |
Constructors
public SAMLAssertionInfo();
Creates a new SAMLAssertionInfo object.
SAMLAssertionStatement Type
Represents an assertion statement.
Remarks
This type is a container for an assertion statement.
Fields
|
Attributes String |
Contains a list of statement attribute names. Use this property to access the set of names of assertion attributes, separated by CRLF. |
|
AuthnContextAuthenticatingAuthorities String |
Contains the list of authenticating authorities. Use this property to access the list of URIs of authenticating authorities (IdP entity IDs). |
|
AuthnContextChoice String |
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 |
Indicates the authentication contexts class reference. Use this property to get or set the authentication contexts class reference attribute. |
|
AuthnContextDecl String |
Specifies the authentication contexts declaration. Use this property to access or set the declaration element of the authentication context. |
|
AuthnContextDeclRef String |
Specifies the authentication contexts declaration reference. Use this property to get or set the declaration reference of the authentication context. |
|
AuthnInstant String |
Specifies the authentication event timestamp. Use this property to read or set the moment in time the authentication event took place. |
|
AuthnSessionIndex String |
Contains the authentication session index. Use this property to access or set the authentication session index. |
|
AuthnSessionNotOnOrAfter String |
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 |
Specifies the authentication subjects address. Use this property to specify the address parameter of the authentication subjects locality. |
|
AuthnSubjectLocalityDNSName String |
Maps to the authentication subjects DNS name parameter. Use this property to access or set the authentication subjects DNS name locality parameter. |
|
AuthzActions String |
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 |
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 |
Manages the authorization decision statement evidence parameter. Use this property to read or set the authorization decision statement evidence parameter. |
|
AuthzDecisionResource String |
Specifies the authorization decision statement resource parameter. Use this property to access or set the resource parameter of the authorization statement. |
|
StatementType int |
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.
Fields
|
FriendlyName String |
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 |
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 |
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 |
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 |
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.
Fields
|
Comparison int |
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 |
Specifies the context class reference. Use this property to access or set the authentication context class reference. |
|
RefType int |
Specifies the context reference type. Use this property to access or set the authentication contexts reference type (class or declaration). |
|
SessionIndex String |
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.
Fields
|
AssertionConsumerServiceIndex int |
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 |
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 |
Specifies the attribute consuming service index. Use this property to read or set the attribute consuming service index. |
|
ConditionsNotBefore String |
Specifies the NotBefore condition of the request. Use this property to access or set the NotBefore condition of the request. |
|
ConditionsNotOnOrAfter String |
Provides access to the NotOnOrAfter condition of the request. Use this property to access or set the NotOnOrAfter condition of the request. |
|
ContextClassRefs String |
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 |
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 |
Specifies the context reference type. Use this property to get or set the context reference type (Class or Declaration). |
|
ForceAuthn boolean |
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 |
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 |
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 |
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 |
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. |
|
NameIDPolicyUseAllowCreate boolean |
Controls inclusion of AllowCreate attribute in the request. Use this property to check or specify whether the AllowCreate attribute is included in the authentication request. |
|
ProtocolBinding String |
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 |
Specifies the name of the requestor. Use this property to read or set the name of the requestor. |
|
ScopingIDPListGetComplete String |
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 |
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 |
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. |
|
UseForceAuthn boolean |
Controls inclusion of ForceAuthn attribute in the request. Use this property to check or enable presence of the ForceAuthn attribute in the authentication request. Set this property to false to suppress inclusion of the attribute. |
|
UseIsPassive boolean |
Controls inclusion of IsPassive attribute in the request. Use this property to check or enable presence of the IsPassive attribute in the authentication request. Set this property to false to suppress inclusion of the attribute. |
Constructors
public SAMLAuthnRequest();
Creates a new SAMLAuthnRequest object.
SAMLAuthzDecisionQuery Type
Represents SAML AuthzDecisionQuery element.
Remarks
This type is a container for SAML AuthzDecisionQuery type.
Fields
|
Actions String |
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 |
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.
SAMLIDPEntry Type
Represents a single identity provider information.
Remarks
This type is a container of single identity provider-specific details.
Fields
|
Loc String |
Contains the value of the Loc attribute. Use this property to access or set the value of the Loc (location) attribute. |
|
Name String |
Contains the name of the IdP provider. Use this property to retrieve or set the Name attribute of the IdP provider. |
|
ProviderID String |
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.
Fields
|
NameID String |
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 |
Contains the value of the NotOnOrAfter parameter. Use this property to access or set the value of the NotOnOrAfter parameter. |
|
Reason String |
Contains the value of the Reason parameter. Use this property to read or set the value of the Reason parameter. |
|
SessionIndexes String |
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.
Fields
|
NameID String |
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 |
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 |
Contains the value of the NewID parameter. Use this property to access or set the NewID parameter of the request. |
|
Terminate String |
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.
SAMLNameIDMappingRequest Type
Represents SAML NameIDMappingRequest element.
Remarks
This type is a container for NameIDMappingRequest element.
Fields
|
NameID String |
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 |
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 |
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 |
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 |
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.
SAMLPOSTBinding Type
Contains the details of the POST binding.
Remarks
This type provides access to properties of POST binding.
Fields
|
Body String |
Contains the form body. Use this property to read or set the body of the form returned by the service provider. |
|
FormTemplate String |
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. |
|
Mode int |
Specifies whether binding is applied on a server, or on a client side. Use this property to specify whether binding is used on the server or client side of the communication. The default value is cspmClient. |
|
RelayState String |
Contains the value of the RelayState parameter of POST binding mechanism. Use this property to read or set the value of the RelayState parameter of the POST binding. RelayState contains an uninterpreted service-provider-originating state object, which should be passed back to it with any further requests. |
|
URL String |
Contains the URL of POST binding mechanism. Use this property to check or set the URL of POST binding mechanism. |
Constructors
public SAMLPOSTBinding();
Creates a new SAMLPOSTBinding object.
SAMLRedirectBinding Type
Contains parameters of SAML Redirect binding.
Remarks
This type is a container for properties of SAML Redirect binding mechanism.
Fields
|
Encoding String |
Specifies the message encoding. Use this property to access or set the message encoding. |
|
ForceSign boolean |
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. |
|
RelayState String |
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. |
|
Sign boolean |
Specifies whether to sign generated messages. Use this property to enable or disable signing of generated binding entities. The SAML specification instructs that the binding should only be signed if the original XML was. This property therefore is only taken into account if the original XML was signed. With that in mind, certain service providers demand the binding to be signed at all times. Use ForceSign property to enforce signatures on all binding entities. |
|
SignatureAlgorithm String |
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. |
|
URL String |
Contains the URL of the request query. Use this property to read or set the URL of the request query. |
|
VerifySignatures boolean |
Instructs the component whether to verify incoming signatures. Use this property to activate or deactivate verification of signatures in incoming requests. |
Constructors
public SAMLRedirectBinding();
Creates a new SAMLRedirectBinding object.
SAMLResponse Type
Represents a SAML response.
Remarks
This is a container for SAML response parameters.
Fields
|
NameID String |
Contains the NameID parameter of a NameIDMapping response. Use this property to read or set the NameID parameter of the NameIDMapping response. |
|
OptionalElement String |
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 |
Contains the type of the response. Use this property to get or set the type of the SAML response. |
|
StatusCodeSubValue String |
The value of the nested StatusCode. This property contains the value of the nested StatusCode element. |
|
StatusCodeValue String |
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 |
Contains additional information on the status of the request. The StatusDetail element contains additional request status information. |
|
StatusMessage String |
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.
SAMLSubjectConfirmation Type
Represents SAML SubjectConfirmation element.
Remarks
This type is a container for SAML SubjectConfirmating element.
Fields
|
DataAddress String |
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. |
|
DataInResponseTo String |
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. |
|
DataNotBefore String |
Time moment before which the subject cannot be confirmed. This property specifies the time before which the subject cannot be confirmed. |
|
DataNotOnOrAfter String |
Limits the time until which the subject can be confirmed. This property specifies the time on (or after) which the subject cannot be confirmed. |
|
DataRecipient String |
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. |
|
DataType String |
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 |
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. |
|
Method String |
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. |
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 | ||||||||||||||||||||||||||||||
| IgnoreSystemTrust:
Whether trusted Windows Certificate Stores should be treated as trusted.Specifies whether, during chain validation, the component should respect
the trust to CA certificates as configured in the operating system.
In Windows this effectively defines whether the component should trust the
certificates residing in the Trusted Root Certification Authorities store.
If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as TrustedCertificates property) are considered trusted. |
||||||||||||||||||||||||||||||
| SigAfterIssuer: Specifies whether to insert the signature after the issuer tag in the SAML document.Use this setting to tune up the location of the signature tag in the resulting document. The default value is true. | ||||||||||||||||||||||||||||||
TolerateMinorChainIssues:
Whether to tolerate minor chain issues.This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are:
|
||||||||||||||||||||||||||||||
| UseMicrosoftCTL: Enables or disables automatic use of Microsoft online certificate trust list.Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository. | ||||||||||||||||||||||||||||||
| UseSystemCertificates: Enables or disables the use of the system certificates.Use this property to tell chain validation module automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework. | ||||||||||||||||||||||||||||||
Base Config Settings | ||||||||||||||||||||||||||||||
| CheckKeyIntegrityBeforeUse:
Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit,
but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys. |
||||||||||||||||||||||||||||||
| CookieCaching:
Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.
Supported values are:
|
||||||||||||||||||||||||||||||
| Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. | ||||||||||||||||||||||||||||||
| DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. | ||||||||||||||||||||||||||||||
| EnableClientSideSSLFFDHE:
Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower
algorithm if compared to EC DHE; enabling it may result in slower connections.
This setting only applies to sessions negotiated with TLS version 1.3. |
||||||||||||||||||||||||||||||
| GlobalCookies: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global". | ||||||||||||||||||||||||||||||
| HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. | ||||||||||||||||||||||||||||||
| LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogDetails:
Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogFile: Specifies the debug log filename.Use this property to provide a path to the log file. | ||||||||||||||||||||||||||||||
| LogFilters:
Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogMaxEventCount:
Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects,
depending on the rotation setting and/or the flush mode.
The default value of this setting is 100. |
||||||||||||||||||||||||||||||
LogRotationMode:
Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. | ||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
| 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. |