SAMLWriter Component

Properties   Methods   Events   Config Settings   Errors  

The SAMLWriter component offers SAML message generation functions

Syntax

nsoftware.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 component with short descriptions. Click on the links for further details.

Method List

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

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

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

AddXMLHeader Property (SAMLWriter Component)

Controls the inclusion of an XML header in the message.

Syntax

• C#
• VB.NET

public bool AddXMLHeader { get; set; }

Public Property AddXMLHeader As Boolean

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

Provides access to the Artifact element of the message.

Syntax

• C#
• VB.NET

public SAMLArtifact Artifact { get; set; }

Public Property Artifact As SAMLArtifact

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

Contains the artifact resolve query.

Syntax

• C#
• VB.NET

public string ArtifactResolveQuery { get; set; }

Public Property ArtifactResolveQuery As String

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

Contains a list of assertion attributes.

Syntax

• C#
• VB.NET

public SAMLAttributeList AssertionAttributes { get; }

Public Property AssertionAttributes As SAMLAttributeList

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

Contains a list of assertion conditions.

Syntax

• C#
• VB.NET

public SAMLAssertionConditionList AssertionConditions { get; }

Public Property AssertionConditions As SAMLAssertionConditionList

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

Returns the number of assertions in the message.

Syntax

• C#
• VB.NET

public int AssertionCount { get; }

Public ReadOnly Property AssertionCount As Integer

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

Contains the properties of AssertionIDRequest element.

Syntax

• C#
• VB.NET

public SAMLAssertionIDRequest AssertionIDRequest { get; }

Public ReadOnly Property AssertionIDRequest As SAMLAssertionIDRequest

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

Contains assertion information.

Syntax

• C#
• VB.NET

public SAMLAssertionInfo AssertionInfo { get; }

Public ReadOnly Property AssertionInfo As SAMLAssertionInfo

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

Specifies the assertion issuer.

Syntax

• C#
• VB.NET

public string AssertionIssuer { get; set; }

Public Property AssertionIssuer As String

Default Value

""

Remarks

Use this property to provide the assertion issuer ID.

This property is not available at design time.

AssertionStatements Property (SAMLWriter Component)

Contains assertion statements.

Syntax

• C#
• VB.NET

public SAMLAssertionStatementList AssertionStatements { get; }

Public Property AssertionStatements As SAMLAssertionStatementList

Remarks

Use this property to access or set the assertion statements.

This property is not available at design time.

AssertionSubjectConfirmations Property (SAMLWriter Component)

Provides access to assertion SubjectConfirmations list.

Syntax

• C#
• VB.NET

public SAMLSubjectConfirmationList AssertionSubjectConfirmations { get; }

Public Property AssertionSubjectConfirmations As SAMLSubjectConfirmationList

Remarks

Use this property to access the list of assertions SubjectConfirmation elements.

This property is not available at design time.

AssertionSubjectID Property (SAMLWriter Component)

Specifies the assertion subject ID.

Syntax

• C#
• VB.NET

public string AssertionSubjectID { get; set; }

Public Property AssertionSubjectID As String

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

Contains a list of attribute query attributes.

Syntax

• C#
• VB.NET

public SAMLAttributeList AttrQueryAttributes { get; }

Public Property AttrQueryAttributes As SAMLAttributeList

Remarks

Use this property to set up a list of attribute query attributes.

This property is not available at design time.

AuthnQuery Property (SAMLWriter Component)

Provides access to the AuthnQuery SAML element.

Syntax

• C#
• VB.NET

public SAMLAuthnQuery AuthnQuery { get; }

Public ReadOnly Property AuthnQuery As SAMLAuthnQuery

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

Publishes the properties of AuthnRequest element.

Syntax

• C#
• VB.NET

public SAMLAuthnRequest AuthnRequest { get; }

Public ReadOnly Property AuthnRequest As SAMLAuthnRequest

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

Contains a list of AuthnRequest conditions.

Syntax

• C#
• VB.NET

public SAMLAssertionConditionList AuthnRequestConditions { get; }

Public Property AuthnRequestConditions As SAMLAssertionConditionList

Remarks

Use this property to set up the conditions of the AuthnRequest element.

This property is not available at design time.

AuthnRequestScopingIDPList Property (SAMLWriter Component)

Provides access to the list of scoping IDP eleements.

Syntax

• C#
• VB.NET

public SAMLIDPEntryList AuthnRequestScopingIDPList { get; }

Public Property AuthnRequestScopingIDPList As SAMLIDPEntryList

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

Provides access to AuthzDecisionQuery element.

Syntax

• C#
• VB.NET

public SAMLAuthzDecisionQuery AuthzDecisionQuery { get; }

Public ReadOnly Property AuthzDecisionQuery As SAMLAuthzDecisionQuery

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

Specifies the type of the binding to use.

Syntax

• C#
• VB.NET

public SamlwriterBindings Binding { get; set; }

enum SamlwriterBindings {
  csbtNone,
  csbtSOAP,
  csbtPAOS,
  csbtRedirect,
  csbtPOST,
  csbtArtifact
}

Public Property Binding As SamlwriterBindings

Enum SamlwriterBindings
  csbtNone
  csbtSOAP
  csbtPAOS
  csbtRedirect
  csbtPOST
  csbtArtifact
End Enum

Default Value

0

Remarks

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

Consent Property (SAMLWriter Component)

Contains the Consent parameter of the request.

Syntax

• C#
• VB.NET

public string Consent { get; set; }

Public Property Consent As String

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

Contains the Destination parameter of the SAML object.

Syntax

• C#
• VB.NET

public string Destination { get; set; }

Public Property Destination As String

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

Sets the encryption certificate.

Syntax

• C#
• VB.NET

public Certificate EncryptionCertificate { get; set; }

Public Property EncryptionCertificate As Certificate

Remarks

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

This property is not available at design time.

FIPSMode Property (SAMLWriter Component)

Reserved.

Syntax

• C#
• VB.NET

public bool FIPSMode { get; set; }

Public Property FIPSMode As Boolean

Default Value

False

Remarks

This property is reserved for future use.

ID Property (SAMLWriter Component)

The ID of the request.

Syntax

• C#
• VB.NET

public string ID { get; set; }

Public Property ID As String

Default Value

""

Remarks

Use this property to specify the ID of the request.

This property is not available at design time.

InResponseTo Property (SAMLWriter Component)

Contains the InResponseTo property of the SAML request.

Syntax

• C#
• VB.NET

public string InResponseTo { get; set; }

Public Property InResponseTo As String

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

Contains request issuance timestamp.

Syntax

• C#
• VB.NET

public string IssueInstant { get; set; }

Public Property IssueInstant As String

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

Sets the issuer of the message.

Syntax

• C#
• VB.NET

public string Issuer { get; set; }

Public Property Issuer As String

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

This property is not available at design time.

LogoutRequest Property (SAMLWriter Component)

Contains the properties of SAML LogoutRequest element.

Syntax

• C#
• VB.NET

public SAMLLogoutRequest LogoutRequest { get; }

Public ReadOnly Property LogoutRequest As SAMLLogoutRequest

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

Provides access to ManageNameIDRequest element.

Syntax

• C#
• VB.NET

public SAMLManageNameIDRequest ManageNameIDRequest { get; }

Public ReadOnly Property ManageNameIDRequest As SAMLManageNameIDRequest

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

Publishes the properties of NameIDMappingRequest entity.

Syntax

• C#
• VB.NET

public SAMLNameIDMappingRequest NameIDMappingRequest { get; }

Public ReadOnly Property NameIDMappingRequest As SAMLNameIDMappingRequest

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

Returns the SAML type of message being created.

Syntax

• C#
• VB.NET

public SamlwriterOutputTypes OutputType { get; }

enum SamlwriterOutputTypes {
  cstyNone,
  cstyAssertionIDRequest,
  cstySubjectQuery,
  cstyAuthnQuery,
  cstyAttributeQuery,
  cstyAuthzDecisionQuery,
  cstyAuthnRequest,
  cstyManageNameIDRequest,
  cstyLogoutRequest,
  cstyNameIDMappingRequest,
  cstyArtifactResolve,
  cstyResponse
}

Public ReadOnly Property OutputType As SamlwriterOutputTypes

Enum SamlwriterOutputTypes
  cstyNone
  cstyAssertionIDRequest
  cstySubjectQuery
  cstyAuthnQuery
  cstyAttributeQuery
  cstyAuthzDecisionQuery
  cstyAuthnRequest
  cstyManageNameIDRequest
  cstyLogoutRequest
  cstyNameIDMappingRequest
  cstyArtifactResolve
  cstyResponse
End Enum

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 component 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 Component)

Exposes the POST binding properties.

Syntax

• C#
• VB.NET

public SAMLPOSTBinding POSTBinding { get; }

Public ReadOnly Property POSTBinding As SAMLPOSTBinding

Remarks

Use this property to access the POST binding settings.

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

Profile Property (SAMLWriter Component)

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

Syntax

• C#
• VB.NET

public string Profile { get; set; }

Public Property Profile As String

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

Publishes the redirect binding settings.

Syntax

• C#
• VB.NET

public SAMLRedirectBinding RedirectBinding { get; }

Public ReadOnly Property RedirectBinding As SAMLRedirectBinding

Remarks

Use this property to access the redirect binding settings.

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

RedirectBindingCertificate Property (SAMLWriter Component)

Contains a certificate to sign the redirect binding.

Syntax

• C#
• VB.NET

public Certificate RedirectBindingCertificate { get; set; }

Public Property RedirectBindingCertificate As Certificate

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

Provides access to the SAML response object properties.

Syntax

• C#
• VB.NET

public SAMLResponse Response { get; }

Public ReadOnly Property Response As SAMLResponse

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

The canonicalization method to use in the signature.

Syntax

• C#
• VB.NET

public string SigCanonicalizationMethod { get; set; }

Public Property SigCanonicalizationMethod As String

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

The digest method to use.

Syntax

• C#
• VB.NET

public string SigDigestMethod { get; set; }

Public Property SigDigestMethod As String

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

The signature method to use.

Syntax

• C#
• VB.NET

public string SigMethod { get; set; }

Public Property SigMethod As String

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

Specifies whether the created SAML message should be signed.

Syntax

• C#
• VB.NET

public bool Sign { get; set; }

Public Property Sign As Boolean

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

The certificate to be used for signing.

Syntax

• C#
• VB.NET

public Certificate SigningCertificate { get; set; }

Public Property SigningCertificate As Certificate

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

The signing certificate chain.

Syntax

• C#
• VB.NET

public CertificateList SigningChain { get; }

Public Property SigningChain As CertificateList

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

Provides access to the list of subject confirmation elements.

Syntax

• C#
• VB.NET

public SAMLSubjectConfirmationList SubjectConfirmations { get; }

Public Property SubjectConfirmations As SAMLSubjectConfirmationList

Remarks

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

This property is not available at design time.

SubjectID Property (SAMLWriter Component)

Sets the subject of the message.

Syntax

• C#
• VB.NET

public string SubjectID { get; set; }

Public Property SubjectID As String

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

Specifies the protocol version of the SAML message.

Syntax

• C#
• VB.NET

public string Version { get; set; }

Public Property Version As String

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

Adds an advice assertion to the message.

Syntax

• C#
• VB.NET

public int AddAdviceAssertion(int assertionIndex);

Public Function AddAdviceAssertion(ByVal AssertionIndex As Integer) As Integer

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

Adds assertion to a SAML message.

Syntax

• C#
• VB.NET

public int AddAssertion();

Public Function AddAssertion() As Integer

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

Resets the contents of all assertion-related properties.

Syntax

• C#
• VB.NET

public void ClearAssertion();

Public Sub 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 Component)

Compares two SAML IDs.

Syntax

• C#
• VB.NET

public bool CompareIDs(string ID1, string ID2);

Public Function CompareIDs(ByVal ID1 As String, ByVal ID2 As String) As Boolean

Remarks

This utility method compares two SAML identifiers for equality.

Config Method (SAMLWriter Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 Component)

Creates a new SAML message with the given type.

Syntax

• C#
• VB.NET

public void CreateNew(int outputType);

Public Sub CreateNew(ByVal OutputType As Integer)

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

Performs an additional action.

Syntax

• C#
• VB.NET

public string DoAction(string actionID, string actionParams);

Public Function DoAction(ByVal ActionID As String, ByVal ActionParams As String) As String

Remarks

DoAction is a generic method available in every component. 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 insencitive) 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 Component)

Returns an element of the SAML ID.

Syntax

• C#
• VB.NET

public string GetIDProp(string ID, string propName);

Public Function GetIDProp(ByVal ID As String, ByVal PropName As String) As String

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

Removes an advice from an assertion.

Syntax

• C#
• VB.NET

public void RemoveAdvice(int assertionIndex);

Public Sub RemoveAdvice(ByVal AssertionIndex As Integer)

Remarks

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

RemoveAdviceAssertion Method (SAMLWriter Component)

Removes an advice from an assertion.

Syntax

• C#
• VB.NET

public void RemoveAdviceAssertion(int assertionIndex, int adviceAssertionIndex);

Public Sub RemoveAdviceAssertion(ByVal AssertionIndex As Integer, ByVal AdviceAssertionIndex As Integer)

Remarks

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

RemoveAllAssertions Method (SAMLWriter Component)

Removes all assertions currently configured in the message.

Syntax

• C#
• VB.NET

public void RemoveAllAssertions();

Public Sub RemoveAllAssertions()

Remarks

Use this message to remove all assertions currently set up in the SAML message.

RemoveAssertion Method (SAMLWriter Component)

Removes an assertion from the message.

Syntax

• C#
• VB.NET

public void RemoveAssertion(int assertionIndex);

Public Sub RemoveAssertion(ByVal AssertionIndex As Integer)

Remarks

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

Save Method (SAMLWriter Component)

Saves the configured message to a string.

Syntax

• C#
• VB.NET

public string Save();

Public Function Save() As String

Remarks

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

SaveBytes Method (SAMLWriter Component)

Saves the configured message to a byte array.

Syntax

• C#
• VB.NET

public byte[] SaveBytes();

Public Function SaveBytes() As Byte()

Remarks

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

SaveFile Method (SAMLWriter Component)

Saves the configured message to a file.

Syntax

• C#
• VB.NET

public void SaveFile(string fileName);

Public Sub SaveFile(ByVal FileName As String)

Remarks

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

SaveStream Method (SAMLWriter Component)

Saves the configured message to a stream.

Syntax

• C#
• VB.NET

public void SaveStream(System.IO.Stream outStream);

Public Sub SaveStream(ByVal OutStream As System.IO.Stream)

Remarks

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

Error Event (SAMLWriter Component)

Fires to report an error condition.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, SamlwriterErrorEventArgs e);

public class SamlwriterErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As SamlwriterErrorEventArgs)

Public Class SamlwriterErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

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

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

Syntax

• C#
• VB.NET

public event OnNotificationHandler OnNotification;

public delegate void OnNotificationHandler(object sender, SamlwriterNotificationEventArgs e);

public class SamlwriterNotificationEventArgs : EventArgs {
  public string EventID { get; }
  public string EventParam { get; }
}

Public Event OnNotification As OnNotificationHandler

Public Delegate Sub OnNotificationHandler(sender As Object, e As SamlwriterNotificationEventArgs)

Public Class SamlwriterNotificationEventArgs Inherits EventArgs
  Public ReadOnly Property EventID As String
  Public ReadOnly Property EventParam As String
End Class

Remarks

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

• C#
• VB.NET

public Certificate(byte[] bytes, int startIndex, int count, string password);

Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer, ByVal Password As String)

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.

• C#
• VB.NET

public Certificate(byte[] certBytes, int certStartIndex, int certCount, byte[] keyBytes, int keyStartIndex, int keyCount, string password);

Public Certificate(ByVal CertBytes As Byte(), ByVal CertStartIndex As Integer, ByVal CertCount As Integer, ByVal KeyBytes As Byte(), ByVal KeyStartIndex As Integer, ByVal KeyCount As Integer, ByVal Password As String)

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.

• C#
• VB.NET

public Certificate(byte[] bytes, int startIndex, int count);

Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)

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.

• C#
• VB.NET

public Certificate(string path, string password);

Public Certificate(ByVal Path As String, ByVal Password As String)

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.

• C#
• VB.NET

public Certificate(string certPath, string keyPath, string password);

Public Certificate(ByVal CertPath As String, ByVal KeyPath As String, ByVal Password As String)

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.

• C#
• VB.NET

public Certificate(string path);

Public Certificate(ByVal Path As String)

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

• C#
• VB.NET

public Certificate(System.IO.Stream stream);

Public Certificate(ByVal Stream As System.IO.Stream)

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

• C#
• VB.NET

public Certificate(System.IO.Stream stream, string password);

Public Certificate(ByVal Stream As System.IO.Stream, ByVal Password As String)

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

• C#
• VB.NET

public Certificate(System.IO.Stream certStream, System.IO.Stream keyStream, string password);

Public Certificate(ByVal CertStream As System.IO.Stream, ByVal KeyStream As System.IO.Stream, ByVal Password As String)

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.

• C#
• VB.NET

public 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

• C#
• VB.NET

public SAMLArtifact();

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

• C#
• VB.NET

public SAMLAssertionCondition();

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

• C#
• VB.NET

public SAMLAssertionIDRequest();

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

• C#
• VB.NET

public SAMLAssertionInfo();

Public SAMLAssertionInfo()

Creates a new SAMLAssertionInfo object.

SAMLAssertionStatement Type

Represents an assertion statement.

Remarks

This type is a container for an assertion statement.

Fields

• C#
• VB.NET

public SAMLAssertionStatement();

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

• C#
• VB.NET

public SAMLAttribute();

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

• C#
• VB.NET

public SAMLAuthnQuery();

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

• C#
• VB.NET

public SAMLAuthnRequest();

Public SAMLAuthnRequest()

Creates a new SAMLAuthnRequest object.

SAMLAuthzDecisionQuery Type

Represents SAML AuthzDecisionQuery element.

Remarks

This type is a container for SAML AuthzDecisionQuery type.

Fields

• C#
• VB.NET

public SAMLAuthzDecisionQuery();

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

• C#
• VB.NET

public SAMLIDPEntry();

Public SAMLIDPEntry()

Creates a new SAMLIDPEntry object.

SAMLLogoutRequest Type

Represents SAML LogoutRequest element.

Remarks

This type is a container for SAML LogoutRequest element.

Fields

• C#
• VB.NET

public SAMLLogoutRequest();

Public SAMLLogoutRequest()

Creates a new SAMLLogoutRequest object.

SAMLManageNameIDRequest Type

Represents a SAML ManageNameIDRequest element.

Remarks

This type is a container for ManageNameIDRequest element.

Fields

• C#
• VB.NET

public SAMLManageNameIDRequest();

Public SAMLManageNameIDRequest()

Creates a new SAMLManageNameIDRequest object.

SAMLNameIDMappingRequest Type

Represents SAML NameIDMappingRequest element.

Remarks

This type is a container for NameIDMappingRequest element.

Fields

• C#
• VB.NET

public SAMLNameIDMappingRequest();

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

• C#
• VB.NET

public SAMLPOSTBinding();

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

• C#
• VB.NET

public SAMLRedirectBinding();

Public SAMLRedirectBinding()

Creates a new SAMLRedirectBinding object.

SAMLResponse Type

Represents a SAML response.

Remarks

This is a container for SAML response parameters.

Fields

• C#
• VB.NET

public SAMLResponse();

Public SAMLResponse()

Creates a new SAMLResponse object.

SAMLSubjectConfirmation Type

Represents SAML SubjectConfirmation element.

Remarks

This type is a container for SAML SubjectConfirmating element.

Fields

• C#
• VB.NET

public SAMLSubjectConfirmation();

Public SAMLSubjectConfirmation()

Creates a new SAMLSubjectConfirmation object.

Config Settings (SAMLWriter Component)

SAMLWriter Config Settings

Base Config Settings

Trappable Errors (SAMLWriter Component)