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:

 
 Copy
  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:

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

Method List

---

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

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.

Config Settings

---

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

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.

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.

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.

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

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.

Please refer to the SAMLAssertionCondition 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

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.

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

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.

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

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.

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

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.

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

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.

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.

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.

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

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.

Please refer to the SAMLIDPEntry 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)

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.

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.

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

For example,

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

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.

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.

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.

Please refer to the SAMLPOSTBinding 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.

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.

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

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.

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

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.

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.

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.

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.

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)

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

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

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

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

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

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

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

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

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

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

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

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

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

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

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

Constructors

public SAMLManageNameIDRequest();

Creates a new SAMLManageNameIDRequest object.

SAMLNameIDMappingRequest Type

Represents SAML NameIDMappingRequest element.

Remarks

This type is a container for NameIDMappingRequest element.

Fields

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

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

Constructors

public SAMLRedirectBinding();

Creates a new SAMLRedirectBinding object.

SAMLResponse Type

Represents a SAML response.

Remarks

This is a container for SAML response parameters.

Fields

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

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

Base Config Settings

Trappable Errors (Samlwriter Class)