SAMLWriter Component
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 component with short descriptions. Click on the links for further details.
| ArtifactEndpointIndex | An accessor to the EndpointIndex entry of the artifact. |
| ArtifactMessageHandle | An accessor to the MessageHandle property of the artifact. |
| ArtifactRemainingArtifact | Returns the contents of the artifact. |
| ArtifactSourceID | An accessor to the SourceID property of the artifact. |
| ArtifactTypeCode | The TypeCode property of the artifact. |
| ArtifactURI | An accessor to the URI property of the artifact. |
| ArtifactResolveQuery | Contains the artifact resolve query. |
| AssertionType | Specifies the type of the assertion. |
| AssertionEncryptedContent | Represents the encrypted assertion content. |
| AssertionID | Represents the ID of the assertion. |
| AssertionIDRef | Represents an ID reference value. |
| AssertionIssueInstant | Contains the assertion issuance time stamp. |
| AssertionIssuer | Specifies the assertion issuer. |
| AssertionParentAssertion | Contains the index of the parent assertion in the assertion list. |
| AssertionSignatureValidationResult | The outcome of the cryptographic signature validation. |
| AssertionSigned | Specifies whether the assertion is signed. |
| AssertionSubject | Specifies the assertion subject. |
| AssertionURIRef | Represents an URI reference value. |
| AssertionVersion | Specifies the SAML protocol version used. |
| AssertionCount | Returns the number of assertions in the message. |
| AttributeCount | The number of records in the Attribute arrays. |
| AttributeFriendlyName | Specifies the friendly name of the attribute Use this property to access or set the friendly name of a SAML attribute (e. |
| AttributeName | Specifies the name of the attribute. |
| AttributeNameFormat | Indicates the format used to reference the attribute. |
| AttributeStatementIndex | Contains the index of the statement the attribute corresponds to. |
| AttributeValues | Contains a list of attribute values. |
| AuthnQueryComparison | Specifies the authentication context comparison method. |
| AuthnQueryContextClassRefs | Specifies the context class reference. |
| AuthnQueryRefType | Specifies the context reference type. |
| AuthnQuerySessionIndex | Specifies the index of the session to the authentication entity. |
| AuthnRequestAssertionConsumerServiceIndex | Specifies the assertion consumer service index. |
| AuthnRequestAssertionConsumerServiceURL | Specifies the assertion consumer service URL. |
| AuthnRequestAttributeConsumingServiceIndex | Specifies the attribute consuming service index. |
| AuthnRequestContextClassRefs | Provides access to the authentication context class references. |
| AuthnRequestContextComparison | Specifies the AuthnContext comparison method. |
| AuthnRequestContextRefType | Specifies the context reference type. |
| AuthnRequestFlags | Adjusts secondary serialization properties. |
| AuthnRequestForceAuthn | Corresponds to the ForceAuthn parameter of the request. |
| AuthnRequestIsPassive | Maps to the IsPassive parameter of the request. |
| AuthnRequestNameIDPolicyAllowCreate | Matches the AllowCreate attribute of NameIDPolicy element of the request. |
| AuthnRequestNameIDPolicyFormat | Matches to the Format attribute of the NameIDPolicy element of the request. |
| AuthnRequestNameIDPolicySPNameQualifier | Matches to the SP name qualifier attribute of the request. |
| AuthnRequestProtocolBinding | Specifies the protocol binding to be requested in the authentication request. |
| AuthnRequestProviderName | Specifies the name of the requestor. |
| AuthnRequestScopingGetComplete | Matches the GetComplete element of the IDPList entry of the Scoping object. |
| AuthnRequestScopingProxyCount | The maximum number of proxies on the way between the requestor and the provider. |
| AuthnRequestScopingRequesterIDs | A collection of requestor IDs on whose behalf the request is being sent. |
| AuthzDecisionQueryActions | Specifies the list of actions included in the query. |
| AuthzDecisionQueryResource | Matches the Resource element of the query. |
| BindingType | Specifies the type of SAML binding to use. |
| BindingBody | Contains the POST binding form body. |
| BindingEncoding | Specifies the message encoding. |
| BindingForceSign | Enforces a signature over all outgoing messages. |
| BindingFormTemplate | Contains the XHTML form template returned by the service provider. |
| BindingPOSTMode | Specifies whether binding is applied on the server, or on the client side. |
| BindingRelayState | Contains the RelayState parameter of the binding. |
| BindingSignatureAlgorithm | Contains the signature algorithm. |
| BindingSignatureValidationResult | The outcome of the cryptographic signature validation. |
| BindingSigned | Specifies whether to sign the binding. |
| BindingURL | Contains the URL of the request query. |
| BindingVerifySignatures | Instructs the class whether to verify incoming signatures. |
| BindingKeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| ConditionCount | The number of records in the Condition arrays. |
| Condition | The condition set in accordance with the ConditionType . |
| ConditionType | Specifies a type of the condition object. |
| EncryptionCertBytes | Returns the raw certificate data in DER format. |
| EncryptionCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| FIPSMode | Reserved. |
| LogoutRequestNameID | Contains the value of the NameID parameter. |
| LogoutRequestNotOnOrAfter | Contains the value of the NotOnOrAfter parameter. |
| LogoutRequestReason | Contains the value of the Reason parameter. |
| LogoutRequestSessionIndexes | Contains the list of session indices. |
| ManageNameIDRequestNameID | Contains the value of the NameID parameter of the request. |
| ManageNameIDRequestNewEncryptedID | Contains the value of the NewEncryptedID parameter of the request. |
| ManageNameIDRequestNewID | Contains the value of the NewID parameter. |
| ManageNameIDRequestTerminate | Contains the value of the Terminate parameter of the request. |
| MessageConsent | Contains the Consent parameter of the SAML message. |
| MessageContentType | Returns the SAML type of the current message. |
| MessageContentTypeString | Returns the type of the processed message, as an original string. |
| MessageDestination | Contains the Destination parameter of the SAML message. |
| MessageID | The ID of the request. |
| MessageInResponseTo | Contains the InResponseTo property of the SAML request. |
| MessageIssueInstant | Contains request issuance timestamp. |
| MessageIssuer | Sets the issuer of the message. |
| MessageSignatureValidationResult | The outcome of the cryptographic signature validation. |
| MessageSigned | Specifies whether the SAML message is or should be signed. |
| MessageSubject | Gets or sets the subject of the message. |
| MessageVersion | Specifies the protocol version to use for the SAML message. |
| MessageXMLHeader | Controls the inclusion of an XML header in the message. |
| NameIDMappingRequestNameID | An accessor to the NameID parameter of the request. |
| NameIDMappingRequestNameIDPolicyAllowCreate | Contains the value of AllowCreate parameter of the NameIDPolicy object. |
| NameIDMappingRequestNameIDPolicyFormat | Specifies the format of the NameIDPolicy element. |
| NameIDMappingRequestNameIDPolicySPNameQualifier | Contains the SPNameQualifier parameter of the NameIDPolicy element. |
| NameIDMappingRequestNameIDPolicyUseAllowCreate | Controls inclusion of UseAllow modifier in the NameIDPolicy object. |
| Profile | Specifies a pre-defined profile to apply when creating the signature. |
| References | Contains the References entry of the SAML AssertionIDRequest message. |
| ResponseNameID | Contains the NameID parameter of a NameIDMapping response. |
| ResponseOptionalElement | An optional message element to be returned with the response. |
| ResponseType | Contains the type of the response. |
| ResponseStatus | Gets or sets the status of the response. |
| ResponseStatusCodeSubValue | The value of the nested StatusCode. |
| ResponseStatusCodeValue | Contains the status code value. |
| ResponseStatusDetail | Contains additional information on the status of the request. |
| ResponseStatusMessage | Contains a status message (optional). |
| ScopingIDPCount | The number of records in the ScopingIDP arrays. |
| ScopingIDPLoc | Contains the value of the Loc attribute. |
| ScopingIDPName | Contains the name of the IdP provider. |
| ScopingIDPProviderID | Contains the provider ID. |
| SecurityCanonicalizationMethod | The canonicalization method to use in the signature. |
| SecurityDigestMethod | The digest method to use. |
| SecurityEncryptionMethod | The encryption method used to encrypt the assertion. |
| SecurityFlags | Provides access to secondary security parameters and tweaks. |
| SecuritySigMethod | The signature method to use. |
| SecuritySignaturePolicy | Specifies the signature validation policy. |
| SigningCertBytes | Returns the raw certificate data in DER format. |
| SigningCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| SigningChainCount | The number of records in the SigningChain arrays. |
| SigningChainBytes | Returns the raw certificate data in DER format. |
| SigningChainHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| StatementCount | The number of records in the Statement arrays. |
| StatementAuthnContextAuthenticatingAuthorities | Contains the list of authenticating authorities. |
| StatementAuthnContextChoice | Specifies the authentication context choice variant. |
| StatementAuthnContextClassRef | Indicates the authentication contexts class reference. |
| StatementAuthnContextDecl | Specifies the authentication contexts declaration. |
| StatementAuthnContextDeclRef | Specifies the authentication contexts declaration reference. |
| StatementAuthnInstant | Specifies the authentication event timestamp. |
| StatementAuthnSessionIndex | Contains the authentication session index. |
| StatementAuthnSessionNotOnOrAfter | Maps to the SessionNotOnOrAfter parameter of the authentication statement. |
| StatementAuthnSubjectLocalityAddress | Specifies the authentication subjects address. |
| StatementAuthnSubjectLocalityDNSName | Maps to the authentication subjects DNS name parameter. |
| StatementAuthzActions | Provides access to the list of actions of the authorization statement. |
| StatementAuthzDecision | Specifies the authorization decision. |
| StatementAuthzDecisionEvidence | Manages the authorization decision statement evidence parameter. |
| StatementAuthzDecisionResource | Specifies the authorization decision statement resource parameter. |
| StatementType | Specifies the assertion statement type. |
| SubjectConfirmationCount | The number of records in the SubjectConfirmation arrays. |
| SubjectConfirmationAddress | Contains the address enabled for presenting assertions. |
| SubjectConfirmationData | The uninterpreted value of data entry in the subject confirmation. |
| SubjectConfirmationDataType | The type of data contained in the confirmation. |
| SubjectConfirmationID | The identifier of the entity which can satisfy the subject confirmation requirements. |
| SubjectConfirmationInResponseTo | The ID of the SAML message in response to which the assertion is issued. |
| SubjectConfirmationMethod | Specifies the mechanism to be used to confirm the subject. |
| SubjectConfirmationNotBefore | Time moment before which the subject cannot be confirmed. |
| SubjectConfirmationNotOnOrAfter | Limits the time until which the subject can be confirmed. |
| SubjectConfirmationRecipient | The URI of the entity or the location of the resource to which the assertion should be presented. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| AddAttribute | Adds an attribute to an existing attribute statement. |
| AddAttributeStatement | Adds an attribute statement to the assertion. |
| AddAuthnStatement | Adds an authentication statement to the assertion. |
| AddAuthzDecisionStatement | Adds an authorization decision statement to the assertion. |
| AddCondition | Adds a condition to the object (assertion or authn request) being edited. |
| AddScopingIDP | Adds a scoping IDP to the object being currently edited. |
| AddSubjectConfirmation | Adds a subject confirmation to the object being edited. |
| BeginAssertion | Initiates the process of creating a new assertion. |
| CompleteAssertion | Adds a completed assertion to a SAML message. |
| Config | Sets or retrieves a configuration setting. |
| CreateNew | Creates a new SAML message with the given type. |
| DoAction | Performs an additional action. |
| FormatID | Formats a SAML ID in the form in which it can be assigned to the Issuer or Subject fields. |
| Reset | Resets the class settings. |
| Save | Saves the configured message to a string. |
| SaveBytes | Saves the configured message to a byte array. |
| SaveFile | Saves the configured message to a file. |
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.
| 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 component with short descriptions. Click on the links for further details.
| BodyOnly | TBD. |
| DateTimeFormat | TBD. |
| KeyDataElements | TBD. |
| SAMLPrefix | TBD. |
| SAMLProtocolPrefix | TBD. |
| SigAfterIssuer | Specifies whether to insert the signature after the issuer tag in the SAML document. |
| SigCanonicalizationMethod | TBD. |
| SigDigestMethod | TBD. |
| SigMethod | TBD. |
| TimeZoneOffset | TBD. |
| ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
| AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the class. |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| DNSLocalSuffix | The suffix to assign for TLD names. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| EnableSSHMLKEM | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. |
| EnableTLSMLKEM | Enables support for ML-KEM and hybrid groups in TLS client and server classes. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HardwareCryptoUsePolicy | The hardware crypto usage policy. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| HttpVersion | The HTTP version to use in any inner HTTP client classes created. |
| IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
| ListDelimiter | The delimiter character for multi-element lists. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
| PKICache | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| PKICachePath | Specifies the file system path where cached PKI data is stored. |
| ProductVersion | Returns the version of the SecureBlackbox library. |
| ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
| StaticDNS | Specifies whether static DNS rules should be used. |
| StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
| StaticIPAddresses | Gets or sets all the static DNS rules. |
| Tag | Allows to store any custom data. |
| TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
| TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
| TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
| UseCRLObjectCaching | Specifies whether reuse of loaded CRL objects is enabled. |
| UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
| UseLegacyAdESValidation | Enables legacy AdES validation mode. |
| UseOCSPResponseObjectCaching | Specifies whether reuse of loaded OCSP response objects is enabled. |
| UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
| XMLRDNDescriptorName[OID] | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| XMLRDNDescriptorPriority[OID] | Specifies the priority of descriptor names associated with a specific OID. |
| XMLRDNDescriptorReverseOrder | Specifies whether to reverse the order of descriptors in RDN. |
| XMLRDNDescriptorSeparator | Specifies the separator used between descriptors in RDN. |
ArtifactEndpointIndex Property (SAMLWriter Component)
An accessor to the EndpointIndex entry of the artifact.
Syntax
func (obj *SAMLWriter) ArtifactEndpointIndex() (int32, error)
func (obj *SAMLWriter) SetArtifactEndpointIndex(value int32) error
Default Value
0
Remarks
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.
Data Type
int32
ArtifactMessageHandle Property (SAMLWriter Component)
An accessor to the MessageHandle property of the artifact.
Syntax
func (obj *SAMLWriter) ArtifactMessageHandle() ([]byte, error)
func (obj *SAMLWriter) SetArtifactMessageHandle(value []byte) error
Remarks
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.
Data Type
[]byte
ArtifactRemainingArtifact Property (SAMLWriter Component)
Returns the contents of the artifact.
Syntax
func (obj *SAMLWriter) ArtifactRemainingArtifact() ([]byte, error)
Remarks
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.
This property is read-only.
Data Type
[]byte
ArtifactSourceID Property (SAMLWriter Component)
An accessor to the SourceID property of the artifact.
Syntax
func (obj *SAMLWriter) ArtifactSourceID() ([]byte, error)
func (obj *SAMLWriter) SetArtifactSourceID(value []byte) error
Remarks
An accessor to the SourceID property of the artifact.
SourceID uniquely identifies the issuer of the artifact.
Data Type
[]byte
ArtifactTypeCode Property (SAMLWriter Component)
The TypeCode property of the artifact.
Syntax
func (obj *SAMLWriter) ArtifactTypeCode() (int32, error)
func (obj *SAMLWriter) SetArtifactTypeCode(value int32) error
Default Value
0
Remarks
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 ArtifactRemainingArtifact, ArtifactSourceID, and ArtifactMessageHandle parameters.
Data Type
int32
ArtifactURI Property (SAMLWriter Component)
An accessor to the URI property of the artifact.
Syntax
func (obj *SAMLWriter) ArtifactURI() (string, error)
func (obj *SAMLWriter) SetArtifactURI(value string) error
Default Value
""
Remarks
An accessor to the URI property of the artifact.
The URI property contains the origin of the artifact.
Data Type
string
ArtifactResolveQuery Property (SAMLWriter Component)
Contains the artifact resolve query.
Syntax
func (obj *SAMLWriter) ArtifactResolveQuery() (string, error)
func (obj *SAMLWriter) SetArtifactResolveQuery(value string) error
Default Value
""
Remarks
Use this property to read or set the artifact resolve query.
Data Type
string
AssertionType Property (SAMLWriter Component)
Specifies the type of the assertion.
Syntax
func (obj *SAMLWriter) AssertionType() (int32, error)
func (obj *SAMLWriter) SetAssertionType(value int32) error
Possible Values
0 // AssertionIDRef
1 // AssertionURIRef
2 // Assertion
3 // EncryptedAssertion
Default Value
2
Remarks
Specifies the type of the assertion.
Use this property to check or set the type of the assertion.
Data Type
int32
AssertionEncryptedContent Property (SAMLWriter Component)
Represents the encrypted assertion content.
Syntax
func (obj *SAMLWriter) AssertionEncryptedContent() (string, error)
func (obj *SAMLWriter) SetAssertionEncryptedContent(value string) error
Default Value
""
Remarks
Represents the encrypted assertion content.
Use this property to get or set the encrypted assertion content.
Data Type
string
AssertionID Property (SAMLWriter Component)
Represents the ID of the assertion.
Syntax
func (obj *SAMLWriter) AssertionID() (string, error)
func (obj *SAMLWriter) SetAssertionID(value string) error
Default Value
""
Remarks
Represents the ID of the assertion.
Use this property to read or set the unique ID of the assertion.
Data Type
string
AssertionIDRef Property (SAMLWriter Component)
Represents an ID reference value.
Syntax
func (obj *SAMLWriter) AssertionIDRef() (string, error)
func (obj *SAMLWriter) SetAssertionIDRef(value string) error
Default Value
""
Remarks
Represents an ID reference value.
Use this property to read or set the ID reference value for assertions of csatAssertionIDRef type.
Data Type
string
AssertionIssueInstant Property (SAMLWriter Component)
Contains the assertion issuance time stamp.
Syntax
func (obj *SAMLWriter) AssertionIssueInstant() (string, error)
func (obj *SAMLWriter) SetAssertionIssueInstant(value string) error
Default Value
""
Remarks
Contains the assertion issuance time stamp.
Use this property to check or set the assertion issuance time.
Data Type
string
AssertionIssuer Property (SAMLWriter Component)
Specifies the assertion issuer.
Syntax
func (obj *SAMLWriter) AssertionIssuer() (string, error)
func (obj *SAMLWriter) SetAssertionIssuer(value string) error
Default Value
""
Remarks
Specifies the assertion issuer.
Use this property to provide the assertion issuer ID.
Data Type
string
AssertionParentAssertion Property (SAMLWriter Component)
Contains the index of the parent assertion in the assertion list.
Syntax
func (obj *SAMLWriter) AssertionParentAssertion() (int32, error)
func (obj *SAMLWriter) SetAssertionParentAssertion(value int32) error
Default Value
-1
Remarks
Contains the index of the parent assertion in the assertion list.
This property is set to -1 for normal assertions. ParentAssertion set to a non-negative value indicates that the assertion is an advice assertion incorporated into a top-level assertion. Advice assertions are typically used by service providers to provide additional information about the SAML assertion issuing authority.
Data Type
int32
AssertionSignatureValidationResult Property (SAMLWriter Component)
The outcome of the cryptographic signature validation.
Syntax
func (obj *SAMLWriter) AssertionSignatureValidationResult() (int32, error)
Possible Values
0 // Valid
1 // Unknown
2 // Corrupted
3 // SignerNotFound
4 // Failure
5 // ReferenceCorrupted
Default Value
0
Remarks
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
This property is read-only.
Data Type
int32
AssertionSigned Property (SAMLWriter Component)
Specifies whether the assertion is signed.
Syntax
func (obj *SAMLWriter) AssertionSigned() (bool, error)
func (obj *SAMLWriter) SetAssertionSigned(value bool) error
Default Value
false
Remarks
Specifies whether the assertion is signed.
Use this property to establish whether the assertion is signed.
Data Type
bool
AssertionSubject Property (SAMLWriter Component)
Specifies the assertion subject.
Syntax
func (obj *SAMLWriter) AssertionSubject() (string, error)
func (obj *SAMLWriter) SetAssertionSubject(value string) error
Default Value
""
Remarks
Specifies the assertion subject.
Use this property to provide the assertion's subject SAML ID.
Data Type
string
AssertionURIRef Property (SAMLWriter Component)
Represents an URI reference value.
Syntax
func (obj *SAMLWriter) AssertionURIRef() (string, error)
func (obj *SAMLWriter) SetAssertionURIRef(value string) error
Default Value
""
Remarks
Represents an URI reference value.
Use this property to read or set the URI reference value for assertions of csatAssertionURIRef type.
Data Type
string
AssertionVersion Property (SAMLWriter Component)
Specifies the SAML protocol version used.
Syntax
func (obj *SAMLWriter) AssertionVersion() (string, error)
func (obj *SAMLWriter) SetAssertionVersion(value string) error
Default Value
""
Remarks
Specifies the SAML protocol version used.
This property specifies the SAML protocol version. The default value is 2.0.
Data Type
string
AssertionCount Property (SAMLWriter Component)
Returns the number of assertions in the message.
Syntax
func (obj *SAMLWriter) AssertionCount() (int32, error)
Default Value
0
Remarks
This property returns the total number of assertions currently defined in the SAML message.
This property is read-only.
Data Type
int32
AttributeCount Property (SAMLWriter Component)
The number of records in the Attribute arrays.
Syntax
func (obj *SAMLWriter) AttributeCount() (int32, error)
func (obj *SAMLWriter) SetAttributeCount(value int32) error
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at AttributeCount - 1.Data Type
int32
AttributeFriendlyName Property (SAMLWriter Component)
Specifies the friendly name of the attribute Use this property to access or set the friendly name of a SAML attribute (e.
Syntax
func (obj *SAMLWriter) AttributeFriendlyName(AttributeIndex int32) (string, error)
func (obj *SAMLWriter) SetAttributeFriendlyName(AttributeIndex int32, value string) error
Default Value
""
Remarks
Specifies the friendly name of the attribute
Use this property to access or set the friendly name of a SAML attribute (e.g. givenName).
The AttributeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttributeCount property.
Data Type
string
AttributeName Property (SAMLWriter Component)
Specifies the name of the attribute.
Syntax
func (obj *SAMLWriter) AttributeName(AttributeIndex int32) (string, error)
func (obj *SAMLWriter) SetAttributeName(AttributeIndex int32, value string) error
Default Value
""
Remarks
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).
The AttributeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttributeCount property.
Data Type
string
AttributeNameFormat Property (SAMLWriter Component)
Indicates the format used to reference the attribute.
Syntax
func (obj *SAMLWriter) AttributeNameFormat(AttributeIndex int32) (string, error)
func (obj *SAMLWriter) SetAttributeNameFormat(AttributeIndex int32, value string) error
Default Value
""
Remarks
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).
The AttributeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttributeCount property.
Data Type
string
AttributeStatementIndex Property (SAMLWriter Component)
Contains the index of the statement the attribute corresponds to.
Syntax
func (obj *SAMLWriter) AttributeStatementIndex(AttributeIndex int32) (int32, error)
func (obj *SAMLWriter) SetAttributeStatementIndex(AttributeIndex int32, value int32) error
Default Value
-1
Remarks
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.
The AttributeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttributeCount property.
Data Type
int32
AttributeValues Property (SAMLWriter Component)
Contains a list of attribute values.
Syntax
func (obj *SAMLWriter) AttributeValues(AttributeIndex int32) (string, error)
func (obj *SAMLWriter) SetAttributeValues(AttributeIndex int32, value string) error
Default Value
""
Remarks
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.
The AttributeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttributeCount property.
Data Type
string
AuthnQueryComparison Property (SAMLWriter Component)
Specifies the authentication context comparison method.
Syntax
func (obj *SAMLWriter) AuthnQueryComparison() (int32, error)
func (obj *SAMLWriter) SetAuthnQueryComparison(value int32) error
Possible Values
0 // None
1 // Exact
2 // Minimum
3 // Maximum
4 // Better
Default Value
0
Remarks
Specifies the authentication context comparison method.
Use this property to access or set the authentication contexts comparison method (none, exact, minimum, maximum, or better).
Data Type
int32
AuthnQueryContextClassRefs Property (SAMLWriter Component)
Specifies the context class reference.
Syntax
func (obj *SAMLWriter) AuthnQueryContextClassRefs() (string, error)
func (obj *SAMLWriter) SetAuthnQueryContextClassRefs(value string) error
Default Value
""
Remarks
Specifies the context class reference.
Use this property to access or set the authentication context class reference.
Data Type
string
AuthnQueryRefType Property (SAMLWriter Component)
Specifies the context reference type.
Syntax
func (obj *SAMLWriter) AuthnQueryRefType() (int32, error)
func (obj *SAMLWriter) SetAuthnQueryRefType(value int32) error
Possible Values
0 // Unknown
1 // Class
2 // Decl
Default Value
0
Remarks
Specifies the context reference type.
Use this property to access or set the authentication contexts reference type (class or declaration).
Data Type
int32
AuthnQuerySessionIndex Property (SAMLWriter Component)
Specifies the index of the session to the authentication entity.
Syntax
func (obj *SAMLWriter) AuthnQuerySessionIndex() (string, error)
func (obj *SAMLWriter) SetAuthnQuerySessionIndex(value string) error
Default Value
""
Remarks
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.
Data Type
string
AuthnRequestAssertionConsumerServiceIndex Property (SAMLWriter Component)
Specifies the assertion consumer service index.
Syntax
func (obj *SAMLWriter) AuthnRequestAssertionConsumerServiceIndex() (int32, error)
func (obj *SAMLWriter) SetAuthnRequestAssertionConsumerServiceIndex(value int32) error
Default Value
0
Remarks
Specifies the assertion consumer service index.
Use this property to access or set the location index to which the response has to be returned.
Data Type
int32
AuthnRequestAssertionConsumerServiceURL Property (SAMLWriter Component)
Specifies the assertion consumer service URL.
Syntax
func (obj *SAMLWriter) AuthnRequestAssertionConsumerServiceURL() (string, error)
func (obj *SAMLWriter) SetAuthnRequestAssertionConsumerServiceURL(value string) error
Default Value
""
Remarks
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.
Data Type
string
AuthnRequestAttributeConsumingServiceIndex Property (SAMLWriter Component)
Specifies the attribute consuming service index.
Syntax
func (obj *SAMLWriter) AuthnRequestAttributeConsumingServiceIndex() (int32, error)
func (obj *SAMLWriter) SetAuthnRequestAttributeConsumingServiceIndex(value int32) error
Default Value
0
Remarks
Specifies the attribute consuming service index.
Use this property to read or set the attribute consuming service index.
Data Type
int32
AuthnRequestContextClassRefs Property (SAMLWriter Component)
Provides access to the authentication context class references.
Syntax
func (obj *SAMLWriter) AuthnRequestContextClassRefs() (string, error)
func (obj *SAMLWriter) SetAuthnRequestContextClassRefs(value string) error
Default Value
""
Remarks
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.
Data Type
string
AuthnRequestContextComparison Property (SAMLWriter Component)
Specifies the AuthnContext comparison method.
Syntax
func (obj *SAMLWriter) AuthnRequestContextComparison() (int32, error)
func (obj *SAMLWriter) SetAuthnRequestContextComparison(value int32) error
Possible Values
0 // None
1 // Exact
2 // Minimum
3 // Maximum
4 // Better
Default Value
0
Remarks
Specifies the AuthnContext comparison method.
Use this property to access or set the authentication contexts comparison method (none, exact, minimum, maximum, or better).
Data Type
int32
AuthnRequestContextRefType Property (SAMLWriter Component)
Specifies the context reference type.
Syntax
func (obj *SAMLWriter) AuthnRequestContextRefType() (int32, error)
func (obj *SAMLWriter) SetAuthnRequestContextRefType(value int32) error
Possible Values
0 // Unknown
1 // Class
2 // Decl
Default Value
0
Remarks
Specifies the context reference type.
Use this property to get or set the context reference type (Class or Declaration).
Data Type
int32
AuthnRequestFlags Property (SAMLWriter Component)
Adjusts secondary serialization properties.
Syntax
func (obj *SAMLWriter) AuthnRequestFlags() (int32, error)
func (obj *SAMLWriter) SetAuthnRequestFlags(value int32) error
Default Value
0
Remarks
Adjusts secondary serialization properties.
Use this bit mask property to adjust how certain properties will be saved. The following flags are supported:
| arfAllowCreate | 1 | Enforces inclusion of NameIDPolicyAllowCreate element in the NameIDPolicy record |
| arfForceAuthn | 2 | Enforces inclusion of the ForceAuthn element |
| arfIsPassive | 4 | Enforces saving of IsPassive element |
Data Type
int32
AuthnRequestForceAuthn Property (SAMLWriter Component)
Corresponds to the ForceAuthn parameter of the request.
Syntax
func (obj *SAMLWriter) AuthnRequestForceAuthn() (bool, error)
func (obj *SAMLWriter) SetAuthnRequestForceAuthn(value bool) error
Default Value
false
Remarks
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.
Data Type
bool
AuthnRequestIsPassive Property (SAMLWriter Component)
Maps to the IsPassive parameter of the request.
Syntax
func (obj *SAMLWriter) AuthnRequestIsPassive() (bool, error)
func (obj *SAMLWriter) SetAuthnRequestIsPassive(value bool) error
Default Value
false
Remarks
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.
Data Type
bool
AuthnRequestNameIDPolicyAllowCreate Property (SAMLWriter Component)
Matches the AllowCreate attribute of NameIDPolicy element of the request.
Syntax
func (obj *SAMLWriter) AuthnRequestNameIDPolicyAllowCreate() (bool, error)
func (obj *SAMLWriter) SetAuthnRequestNameIDPolicyAllowCreate(value bool) error
Default Value
false
Remarks
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.
Data Type
bool
AuthnRequestNameIDPolicyFormat Property (SAMLWriter Component)
Matches to the Format attribute of the NameIDPolicy element of the request.
Syntax
func (obj *SAMLWriter) AuthnRequestNameIDPolicyFormat() (string, error)
func (obj *SAMLWriter) SetAuthnRequestNameIDPolicyFormat(value string) error
Default Value
""
Remarks
Matches to the Format attribute of the NameIDPolicy element of the request.
Use this property to access or set the Format attribute of NameIDPolicy.
Data Type
string
AuthnRequestNameIDPolicySPNameQualifier Property (SAMLWriter Component)
Matches to the SP name qualifier attribute of the request.
Syntax
func (obj *SAMLWriter) AuthnRequestNameIDPolicySPNameQualifier() (string, error)
func (obj *SAMLWriter) SetAuthnRequestNameIDPolicySPNameQualifier(value string) error
Default Value
""
Remarks
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.
Data Type
string
AuthnRequestProtocolBinding Property (SAMLWriter Component)
Specifies the protocol binding to be requested in the authentication request.
Syntax
func (obj *SAMLWriter) AuthnRequestProtocolBinding() (string, error)
func (obj *SAMLWriter) SetAuthnRequestProtocolBinding(value string) error
Default Value
""
Remarks
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.
Data Type
string
AuthnRequestProviderName Property (SAMLWriter Component)
Specifies the name of the requestor.
Syntax
func (obj *SAMLWriter) AuthnRequestProviderName() (string, error)
func (obj *SAMLWriter) SetAuthnRequestProviderName(value string) error
Default Value
""
Remarks
Specifies the name of the requestor.
Use this property to read or set the name of the requestor.
Data Type
string
AuthnRequestScopingGetComplete Property (SAMLWriter Component)
Matches the GetComplete element of the IDPList entry of the Scoping object.
Syntax
func (obj *SAMLWriter) AuthnRequestScopingGetComplete() (string, error)
func (obj *SAMLWriter) SetAuthnRequestScopingGetComplete(value string) error
Default Value
""
Remarks
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.
Data Type
string
AuthnRequestScopingProxyCount Property (SAMLWriter Component)
The maximum number of proxies on the way between the requestor and the provider.
Syntax
func (obj *SAMLWriter) AuthnRequestScopingProxyCount() (int32, error)
func (obj *SAMLWriter) SetAuthnRequestScopingProxyCount(value int32) error
Default Value
0
Remarks
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.
Data Type
int32
AuthnRequestScopingRequesterIDs Property (SAMLWriter Component)
A collection of requestor IDs on whose behalf the request is being sent.
Syntax
func (obj *SAMLWriter) AuthnRequestScopingRequesterIDs() (string, error)
func (obj *SAMLWriter) SetAuthnRequestScopingRequesterIDs(value string) error
Default Value
""
Remarks
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.
Data Type
string
AuthzDecisionQueryActions Property (SAMLWriter Component)
Specifies the list of actions included in the query.
Syntax
func (obj *SAMLWriter) AuthzDecisionQueryActions() (string, error)
func (obj *SAMLWriter) SetAuthzDecisionQueryActions(value string) error
Default Value
""
Remarks
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.
Data Type
string
AuthzDecisionQueryResource Property (SAMLWriter Component)
Matches the Resource element of the query.
Syntax
func (obj *SAMLWriter) AuthzDecisionQueryResource() (string, error)
func (obj *SAMLWriter) SetAuthzDecisionQueryResource(value string) error
Default Value
""
Remarks
Matches the Resource element of the query.
Use this property to read or set the Resource element of the authorization decision query.
Data Type
string
BindingType Property (SAMLWriter Component)
Specifies the type of SAML binding to use.
Syntax
func (obj *SAMLWriter) BindingType() (int32, error)
func (obj *SAMLWriter) SetBindingType(value int32) error
Possible Values
0 // None
1 // SOAP
2 // PAOS
3 // Redirect
4 // POST
5 // Artifact
Default Value
0
Remarks
Specifies the type of SAML binding to use.
Use this property to specify the binding type to use with the request.
Data Type
int32
BindingBody Property (SAMLWriter Component)
Contains the POST binding form body.
Syntax
func (obj *SAMLWriter) BindingBody() (string, error)
func (obj *SAMLWriter) SetBindingBody(value string) error
Default Value
""
Remarks
Contains the POST binding form body.
Use this property to read or set the body of the form returned by the service provider.
Data Type
string
BindingEncoding Property (SAMLWriter Component)
Specifies the message encoding.
Syntax
func (obj *SAMLWriter) BindingEncoding() (string, error)
func (obj *SAMLWriter) SetBindingEncoding(value string) error
Default Value
""
Remarks
Specifies the message encoding.
Use this property to access or set the message encoding.
Data Type
string
BindingForceSign Property (SAMLWriter Component)
Enforces a signature over all outgoing messages.
Syntax
func (obj *SAMLWriter) BindingForceSign() (bool, error)
func (obj *SAMLWriter) SetBindingForceSign(value bool) error
Default Value
false
Remarks
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 BindingSign.
Data Type
bool
BindingFormTemplate Property (SAMLWriter Component)
Contains the XHTML form template returned by the service provider.
Syntax
func (obj *SAMLWriter) BindingFormTemplate() (string, error)
func (obj *SAMLWriter) SetBindingFormTemplate(value string) error
Default Value
""
Remarks
Contains the XHTML form template returned by the service provider.
Use this property to access or set the template of a POST form provided by the service provider (POST binding only).
Data Type
string
BindingPOSTMode Property (SAMLWriter Component)
Specifies whether binding is applied on the server, or on the client side.
Syntax
func (obj *SAMLWriter) BindingPOSTMode() (int32, error)
func (obj *SAMLWriter) SetBindingPOSTMode(value int32) error
Possible Values
0 // Client
1 // Server
Default Value
0
Remarks
Specifies whether binding is applied on the server, or on the client side.
Use this property to specify whether POST binding is used on the server or client side of the communication. The default value is cspmClient.
Data Type
int32
BindingRelayState Property (SAMLWriter Component)
Contains the RelayState parameter of the binding.
Syntax
func (obj *SAMLWriter) BindingRelayState() (string, error)
func (obj *SAMLWriter) SetBindingRelayState(value string) error
Default Value
""
Remarks
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.
Data Type
string
BindingSignatureAlgorithm Property (SAMLWriter Component)
Contains the signature algorithm.
Syntax
func (obj *SAMLWriter) BindingSignatureAlgorithm() (string, error)
func (obj *SAMLWriter) SetBindingSignatureAlgorithm(value string) error
Default Value
""
Remarks
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.
Data Type
string
BindingSignatureValidationResult Property (SAMLWriter Component)
The outcome of the cryptographic signature validation.
Syntax
func (obj *SAMLWriter) BindingSignatureValidationResult() (int32, error)
Possible Values
0 // Valid
1 // Unknown
2 // Corrupted
3 // SignerNotFound
4 // Failure
5 // ReferenceCorrupted
Default Value
0
Remarks
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
This property is read-only.
Data Type
int32
BindingSigned Property (SAMLWriter Component)
Specifies whether to sign the binding.
Syntax
func (obj *SAMLWriter) BindingSigned() (bool, error)
func (obj *SAMLWriter) SetBindingSigned(value bool) error
Default Value
false
Remarks
Specifies whether to sign the binding.
Use this property to enable or disable signing of generated binding entities. The SAML specification instructs that the binding should only be signed if the original XML was. This property therefore is only taken into account if the original XML was signed. With that in mind, certain service providers demand the binding to be signed at all times. Use BindingForceSign property to enforce signatures on all binding entities.
Data Type
bool
BindingURL Property (SAMLWriter Component)
Contains the URL of the request query.
Syntax
func (obj *SAMLWriter) BindingURL() (string, error)
func (obj *SAMLWriter) SetBindingURL(value string) error
Default Value
""
Remarks
Contains the URL of the request query.
Use this property to read or set the URL of the request query or POST target.
Data Type
string
BindingVerifySignatures Property (SAMLWriter Component)
Instructs the class whether to verify incoming signatures.
Syntax
func (obj *SAMLWriter) BindingVerifySignatures() (bool, error)
func (obj *SAMLWriter) SetBindingVerifySignatures(value bool) error
Default Value
true
Remarks
Instructs the component whether to verify incoming signatures.
Use this property to activate or deactivate verification of signatures in incoming requests.
Data Type
bool
BindingKeyHandle Property (SAMLWriter Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *SAMLWriter) BindingKeyHandle() (int64, error)
func (obj *SAMLWriter) SetBindingKeyHandle(value int64) error
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
Data Type
int64
ConditionCount Property (SAMLWriter Component)
The number of records in the Condition arrays.
Syntax
func (obj *SAMLWriter) ConditionCount() (int32, error)
func (obj *SAMLWriter) SetConditionCount(value int32) error
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ConditionCount - 1.Data Type
int32
Condition Property (SAMLWriter Component)
The condition set in accordance with the ConditionType .
Syntax
func (obj *SAMLWriter) Condition(ConditionIndex int32) (string, error)
func (obj *SAMLWriter) SetCondition(ConditionIndex int32, value string) error
Default Value
""
Remarks
The condition set in accordance with the ConditionType.
For csctAudienceRestriction conditions, read or set a list of audiences included in the restriction. Each audience is represented by an URI. Provide multiple audiences by splitting them with CRLF separators.
For csctProxyRestriction conditions, check or set the value of the proxy count restriction.
For csctNotBefore and csctNotOnOrAfter, check or set the respective date/time values.
The ConditionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ConditionCount property.
Data Type
string
ConditionType Property (SAMLWriter Component)
Specifies a type of the condition object.
Syntax
func (obj *SAMLWriter) ConditionType(ConditionIndex int32) (int32, error)
func (obj *SAMLWriter) SetConditionType(ConditionIndex int32, value int32) error
Possible Values
0 // AudienceRestriction
1 // OneTimeUse
2 // ProxyRestriction
3 // NotBefore
4 // NotOnOrAfter
Default Value
0
Remarks
Specifies a type of the condition object.
Use this property to check or specify the type of the condition object. This can be either an audience restriction, a one time use limitation, or a proxy restriction.
The ConditionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ConditionCount property.
Data Type
int32
EncryptionCertBytes Property (SAMLWriter Component)
Returns the raw certificate data in DER format.
Syntax
func (obj *SAMLWriter) EncryptionCertBytes() ([]byte, error)
Remarks
Returns the raw certificate data in DER format.
This property is read-only.
Data Type
[]byte
EncryptionCertHandle Property (SAMLWriter Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *SAMLWriter) EncryptionCertHandle() (int64, error)
func (obj *SAMLWriter) SetEncryptionCertHandle(value int64) error
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
Data Type
int64
FIPSMode Property (SAMLWriter Component)
Reserved.
Syntax
func (obj *SAMLWriter) FIPSMode() (bool, error)
func (obj *SAMLWriter) SetFIPSMode(value bool) error
Default Value
false
Remarks
This property is reserved for future use.
Data Type
bool
LogoutRequestNameID Property (SAMLWriter Component)
Contains the value of the NameID parameter.
Syntax
func (obj *SAMLWriter) LogoutRequestNameID() (string, error)
func (obj *SAMLWriter) SetLogoutRequestNameID(value string) error
Default Value
""
Remarks
Contains the value of the NameID parameter.
Use this property to access or set the value of the NameID parameter of the request.
Data Type
string
LogoutRequestNotOnOrAfter Property (SAMLWriter Component)
Contains the value of the NotOnOrAfter parameter.
Syntax
func (obj *SAMLWriter) LogoutRequestNotOnOrAfter() (string, error)
func (obj *SAMLWriter) SetLogoutRequestNotOnOrAfter(value string) error
Default Value
""
Remarks
Contains the value of the NotOnOrAfter parameter.
Use this property to access or set the value of the NotOnOrAfter parameter.
Data Type
string
LogoutRequestReason Property (SAMLWriter Component)
Contains the value of the Reason parameter.
Syntax
func (obj *SAMLWriter) LogoutRequestReason() (string, error)
func (obj *SAMLWriter) SetLogoutRequestReason(value string) error
Default Value
""
Remarks
Contains the value of the Reason parameter.
Use this property to read or set the value of the Reason parameter.
Data Type
string
LogoutRequestSessionIndexes Property (SAMLWriter Component)
Contains the list of session indices.
Syntax
func (obj *SAMLWriter) LogoutRequestSessionIndexes() (string, error)
func (obj *SAMLWriter) SetLogoutRequestSessionIndexes(value string) error
Default Value
""
Remarks
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.
Data Type
string
ManageNameIDRequestNameID Property (SAMLWriter Component)
Contains the value of the NameID parameter of the request.
Syntax
func (obj *SAMLWriter) ManageNameIDRequestNameID() (string, error)
func (obj *SAMLWriter) SetManageNameIDRequestNameID(value string) error
Default Value
""
Remarks
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.
Data Type
string
ManageNameIDRequestNewEncryptedID Property (SAMLWriter Component)
Contains the value of the NewEncryptedID parameter of the request.
Syntax
func (obj *SAMLWriter) ManageNameIDRequestNewEncryptedID() (string, error)
func (obj *SAMLWriter) SetManageNameIDRequestNewEncryptedID(value string) error
Default Value
""
Remarks
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.
Data Type
string
ManageNameIDRequestNewID Property (SAMLWriter Component)
Contains the value of the NewID parameter.
Syntax
func (obj *SAMLWriter) ManageNameIDRequestNewID() (string, error)
func (obj *SAMLWriter) SetManageNameIDRequestNewID(value string) error
Default Value
""
Remarks
Contains the value of the NewID parameter.
Use this property to access or set the NewID parameter of the request.
Data Type
string
ManageNameIDRequestTerminate Property (SAMLWriter Component)
Contains the value of the Terminate parameter of the request.
Syntax
func (obj *SAMLWriter) ManageNameIDRequestTerminate() (string, error)
func (obj *SAMLWriter) SetManageNameIDRequestTerminate(value string) error
Default Value
""
Remarks
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.
Data Type
string
MessageConsent Property (SAMLWriter Component)
Contains the Consent parameter of the SAML message.
Syntax
func (obj *SAMLWriter) MessageConsent() (string, error)
func (obj *SAMLWriter) SetMessageConsent(value string) error
Default Value
""
Remarks
Contains the Consent parameter of the SAML message.
Use this property to specify the Consent parameter of the SAML entity.
Data Type
string
MessageContentType Property (SAMLWriter Component)
Returns the SAML type of the current message.
Syntax
func (obj *SAMLWriter) MessageContentType() (int32, error)
Possible Values
0 // None
1 // AssertionIDRequest
2 // SubjectQuery
3 // AuthnQuery
4 // AttributeQuery
5 // AuthzDecisionQuery
6 // AuthnRequest
7 // ManageNameIDRequest
8 // LogoutRequest
9 // NameIDMappingRequest
10 // ArtifactResolve
11 // Response
12 // Assertion
Default Value
0
Remarks
Returns the SAML type of the current message.
Use this property to check the type of SAML message being created. This is the same value that was passed to CreateNew call.
Depending on the assigned type, use properties of struct to tune up the parameters of the chosen message type. For example, if the content type is cstyAuthnQuery, use AuthnQuery property to adjust context class references or comparison settings.
This property is read-only.
Data Type
int32
MessageContentTypeString Property (SAMLWriter Component)
Returns the type of the processed message, as an original string.
Syntax
func (obj *SAMLWriter) MessageContentTypeString() (string, error)
Default Value
""
Remarks
Returns the type of the processed message, as an original string.
Check this property to find out the content type of the data stored in the processed message. This returns a string originally included in the SAML message, which may be helpful when processing non-standard types.
Known SAML content types are:
- AssertionIDRequest
- SubjectQuery
- AuthnQuery
- AttributeQuery
- AuthzDecisionQuery
- AuthnRequest
- ManageNameIDRequest
- NameIDMappingRequest
- LogoutRequest
- ArtifactResolve
- Response
- LogoutResponse
- ArtifactResponse
- NameIDMappingResponse
This property is read-only.
Data Type
string
MessageDestination Property (SAMLWriter Component)
Contains the Destination parameter of the SAML message.
Syntax
func (obj *SAMLWriter) MessageDestination() (string, error)
func (obj *SAMLWriter) SetMessageDestination(value string) error
Default Value
""
Remarks
Contains the Destination parameter of the SAML message.
Use this property to set the Destination parameter of the created SAML object.
Data Type
string
MessageID Property (SAMLWriter Component)
The ID of the request.
Syntax
func (obj *SAMLWriter) MessageID() (string, error)
func (obj *SAMLWriter) SetMessageID(value string) error
Default Value
""
Remarks
The ID of the request.
Use this property to specify the ID of the SAML request or response.
Data Type
string
MessageInResponseTo Property (SAMLWriter Component)
Contains the InResponseTo property of the SAML request.
Syntax
func (obj *SAMLWriter) MessageInResponseTo() (string, error)
func (obj *SAMLWriter) SetMessageInResponseTo(value string) error
Default Value
""
Remarks
Contains the InResponseTo property of the SAML request.
Use this property to specify the ID of the message in response to which the current entity is provided.
Data Type
string
MessageIssueInstant Property (SAMLWriter Component)
Contains request issuance timestamp.
Syntax
func (obj *SAMLWriter) MessageIssueInstant() (string, error)
func (obj *SAMLWriter) SetMessageIssueInstant(value string) error
Default Value
""
Remarks
Contains request issuance timestamp.
Set this property to specify the time moment of the request formation. Leave it empty to use the current system time.
Data Type
string
MessageIssuer Property (SAMLWriter Component)
Sets the issuer of the message.
Syntax
func (obj *SAMLWriter) MessageIssuer() (string, error)
func (obj *SAMLWriter) SetMessageIssuer(value string) error
Default Value
""
Remarks
Sets the issuer of the message.
Set this property to include the SAML ID of the issuer of the SAML message. A typical SAML ID is a string of semicolon-separated elements of one or more of the following elements:
- Format
- NameQualifier
- Value
- IDType
- SPNameQualifier
- SPProvidedID
writer.Message.Issuer = "Value=https://saml.entity.org/resource;Format=urn:oasis:names:tc:SAML:2.0:nameid-format:entity;IDType=Issuer";
Data Type
string
MessageSignatureValidationResult Property (SAMLWriter Component)
The outcome of the cryptographic signature validation.
Syntax
func (obj *SAMLWriter) MessageSignatureValidationResult() (int32, error)
Possible Values
0 // Valid
1 // Unknown
2 // Corrupted
3 // SignerNotFound
4 // Failure
5 // ReferenceCorrupted
Default Value
0
Remarks
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
This property is read-only.
Data Type
int32
MessageSigned Property (SAMLWriter Component)
Specifies whether the SAML message is or should be signed.
Syntax
func (obj *SAMLWriter) MessageSigned() (bool, error)
func (obj *SAMLWriter) SetMessageSigned(value bool) error
Default Value
false
Remarks
Specifies whether the SAML message is or should be signed.
Check this property to find out whether the processed message was signed by the sender, or set this property to true to indicate that the created message should be signed.
Data Type
bool
MessageSubject Property (SAMLWriter Component)
Gets or sets the subject of the message.
Syntax
func (obj *SAMLWriter) MessageSubject() (string, error)
func (obj *SAMLWriter) SetMessageSubject(value string) error
Default Value
""
Remarks
Gets or sets the subject of the message.
Check this property to obtain the SAML ID of the message subject.
Set this property to include the SAML ID of the issuer of the SAML message. A typical SAML ID is a string of semicolon-separated elements of one or more of the following elements:
- Format
- NameQualifier
- Value
- IDType
- SPNameQualifier
- SPProvidedID
writer.Message.Subject = "Value=https://saml.entity.org/resource;Format=urn:oasis:names:tc:SAML:2.0:nameid-format:entity;IDType=Issuer";
Data Type
string
MessageVersion Property (SAMLWriter Component)
Specifies the protocol version to use for the SAML message.
Syntax
func (obj *SAMLWriter) MessageVersion() (string, error)
func (obj *SAMLWriter) SetMessageVersion(value string) error
Default Value
"2.0"
Remarks
Specifies the protocol version to use for the SAML message.
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
Data Type
string
MessageXMLHeader Property (SAMLWriter Component)
Controls the inclusion of an XML header in the message.
Syntax
func (obj *SAMLWriter) MessageXMLHeader() (bool, error)
func (obj *SAMLWriter) SetMessageXMLHeader(value bool) error
Default Value
false
Remarks
Controls the inclusion of an XML header in the message.
Use this property to enable or disable inclusion of the XML header in the SAML message.
Data Type
bool
NameIDMappingRequestNameID Property (SAMLWriter Component)
An accessor to the NameID parameter of the request.
Syntax
func (obj *SAMLWriter) NameIDMappingRequestNameID() (string, error)
func (obj *SAMLWriter) SetNameIDMappingRequestNameID(value string) error
Default Value
""
Remarks
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.
Data Type
string
NameIDMappingRequestNameIDPolicyAllowCreate Property (SAMLWriter Component)
Contains the value of AllowCreate parameter of the NameIDPolicy object.
Syntax
func (obj *SAMLWriter) NameIDMappingRequestNameIDPolicyAllowCreate() (bool, error)
func (obj *SAMLWriter) SetNameIDMappingRequestNameIDPolicyAllowCreate(value bool) error
Default Value
false
Remarks
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.
Data Type
bool
NameIDMappingRequestNameIDPolicyFormat Property (SAMLWriter Component)
Specifies the format of the NameIDPolicy element.
Syntax
func (obj *SAMLWriter) NameIDMappingRequestNameIDPolicyFormat() (string, error)
func (obj *SAMLWriter) SetNameIDMappingRequestNameIDPolicyFormat(value string) error
Default Value
""
Remarks
Specifies the format of the NameIDPolicy element.
Use this property to set or read the value of the Format parameter of the NameIDPolicy object.
Data Type
string
NameIDMappingRequestNameIDPolicySPNameQualifier Property (SAMLWriter Component)
Contains the SPNameQualifier parameter of the NameIDPolicy element.
Syntax
func (obj *SAMLWriter) NameIDMappingRequestNameIDPolicySPNameQualifier() (string, error)
func (obj *SAMLWriter) SetNameIDMappingRequestNameIDPolicySPNameQualifier(value string) error
Default Value
""
Remarks
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.
Data Type
string
NameIDMappingRequestNameIDPolicyUseAllowCreate Property (SAMLWriter Component)
Controls inclusion of UseAllow modifier in the NameIDPolicy object.
Syntax
func (obj *SAMLWriter) NameIDMappingRequestNameIDPolicyUseAllowCreate() (bool, error)
func (obj *SAMLWriter) SetNameIDMappingRequestNameIDPolicyUseAllowCreate(value bool) error
Default Value
false
Remarks
Controls inclusion of UseAllow modifier in the NameIDPolicy object.
Use this property to include or exclude the UseAllow parameter from the NameIDPolicy object.
Data Type
bool
Profile Property (SAMLWriter Component)
Specifies a pre-defined profile to apply when creating the signature.
Syntax
func (obj *SAMLWriter) Profile() (string, error)
func (obj *SAMLWriter) SetProfile(value string) error
Default Value
""
Remarks
Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.
Data Type
string
References Property (SAMLWriter Component)
Contains the References entry of the SAML AssertionIDRequest message.
Syntax
func (obj *SAMLWriter) References() (string, error)
func (obj *SAMLWriter) SetReferences(value string) error
Default Value
""
Remarks
Use this property to read or specify the value of the References entry of the AssertionIDRequest message.
Data Type
string
ResponseNameID Property (SAMLWriter Component)
Contains the NameID parameter of a NameIDMapping response.
Syntax
func (obj *SAMLWriter) ResponseNameID() (string, error)
func (obj *SAMLWriter) SetResponseNameID(value string) error
Default Value
""
Remarks
Contains the NameID parameter of a NameIDMapping response.
Use this property to read or set the NameID parameter of the NameIDMapping response.
Data Type
string
ResponseOptionalElement Property (SAMLWriter Component)
An optional message element to be returned with the response.
Syntax
func (obj *SAMLWriter) ResponseOptionalElement() (string, error)
func (obj *SAMLWriter) SetResponseOptionalElement(value string) error
Default Value
""
Remarks
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.
Data Type
string
ResponseType Property (SAMLWriter Component)
Contains the type of the response.
Syntax
func (obj *SAMLWriter) ResponseType() (int32, error)
func (obj *SAMLWriter) SetResponseType(value int32) error
Possible Values
0 // Response
1 // ArtifactResponse
2 // NameIDMappingResponse
3 // LogoutResponse
Default Value
0
Remarks
Contains the type of the response.
Use this property to get or set the type of the SAML response.
Data Type
int32
ResponseStatus Property (SAMLWriter Component)
Gets or sets the status of the response.
Syntax
func (obj *SAMLWriter) ResponseStatus() (int32, error)
func (obj *SAMLWriter) SetResponseStatus(value int32) error
Default Value
0
Remarks
Gets or sets the status of the response.
This property specifies the status code to include in the response. This property adjusts the values of the ResponseStatusCodeValue and other status properties.
This property is a bitwise combination of the status facility and an error code. The facility mask can be one of the following:
- 0x00000000 - Success (urn:oasis:names:tc:SAML:2.0:status:Success)
- 0x00010000 - Requester Error (urn:oasis:names:tc:SAML:2.0:status:Requester)
- 0x00020000 - Responder Error (urn:oasis:names:tc:SAML:2.0:status:Responder)
- 0x00030000 - Version Mismatch (urn:oasis:names:tc:SAML:2.0:status:VersionMismatch)
- 0x00FF0000 - Undefined or Unknown
The code assigned to the setting is saved in the response as the status given in the brackets.
The error code can take one of the following values:
- 0x00000001 - Authentication Failed (urn:oasis:names:tc:SAML:2.0:status:AuthnFailed)
- 0x00000002 - Unsupported content received within the received Attribute structure (urn:oasis:names:tc:SAML:2.0:status:InvalidAttrNameOrValue)
- 0x00000003 - The requested Name Identifier policy is not supported by the provider (urn:oasis:names:tc:SAML:2.0:status:InvalidNameIDPolicy)
- 0x00000004 - The requested Authentication Context requirements cannot be satisfied by the provider (urn:oasis:names:tc:SAML:2.0:status:NoAuthnContext)
- 0x00000005 - None of the elements in the IDP list can be resolved (urn:oasis:names:tc:SAML:2.0:status:NoAvailableIDP)
- 0x00000006 - The provider cannot authenticate the requestor passively (urn:oasis:names:tc:SAML:2.0:status:NoPassive)
- 0x00000007 - None of the requested providers in the IDP list are supported (urn:oasis:names:tc:SAML:2.0:status:NoSupportedIDP)
- 0x00000008 - The Logout request could not be passed on to other session participants (urn:oasis:names:tc:SAML:2.0:status:PartialLogout)
- 0x00000009 - Proxy count exceeded (urn:oasis:names:tc:SAML:2.0:status:ProxyCountExceeded)
- 0x0000000A - Request denied for internal reasons (urn:oasis:names:tc:SAML:2.0:status:RequestDenied)
- 0x0000000B - The request or its type is not supported by the provider (urn:oasis:names:tc:SAML:2.0:status:RequestUnsupported)
- 0x0000000C - The version of the request has been deprecated (urn:oasis:names:tc:SAML:2.0:status:RequestVersionDeprecated)
- 0x0000000D - The version of the request is too high (urn:oasis:names:tc:SAML:2.0:status:RequestVersionTooHigh)
- 0x0000000E - The version of the request is too low (urn:oasis:names:tc:SAML:2.0:status:RequestVersionTooLow)
- 0x0000000F - The resource included in the request has not been recognised (urn:oasis:names:tc:SAML:2.0:status:ResourceNotRecognized)
- 0x00000010 - The number of responses to be returned is too high for the provider to satisfy (urn:oasis:names:tc:SAML:2.0:status:TooManyResponses)
- 0x00000011 - The attribute profile is unknown to the provider (urn:oasis:names:tc:SAML:2.0:status:UnknownAttrProfile)
- 0x00000012 - The principal mentioned in the request is unknown to the provider (urn:oasis:names:tc:SAML:2.0:status:UnknownPrincipal)
- 0x00000013 - Unsupported binding type (urn:oasis:names:tc:SAML:2.0:status:UnsupportedBinding)
To return a custom error code not available via the above flags, use ResponseStatusCodeValue and ResponseStatusCodeSubValue properties.
Data Type
int32
ResponseStatusCodeSubValue Property (SAMLWriter Component)
The value of the nested StatusCode.
Syntax
func (obj *SAMLWriter) ResponseStatusCodeSubValue() (string, error)
func (obj *SAMLWriter) SetResponseStatusCodeSubValue(value string) error
Default Value
""
Remarks
The value of the nested StatusCode.
This property contains the value of the nested StatusCode element.
Data Type
string
ResponseStatusCodeValue Property (SAMLWriter Component)
Contains the status code value.
Syntax
func (obj *SAMLWriter) ResponseStatusCodeValue() (string, error)
func (obj *SAMLWriter) SetResponseStatusCodeValue(value string) error
Default Value
""
Remarks
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'.
Data Type
string
ResponseStatusDetail Property (SAMLWriter Component)
Contains additional information on the status of the request.
Syntax
func (obj *SAMLWriter) ResponseStatusDetail() (string, error)
func (obj *SAMLWriter) SetResponseStatusDetail(value string) error
Default Value
""
Remarks
Contains additional information on the status of the request.
The StatusDetail element contains additional request status information.
Data Type
string
ResponseStatusMessage Property (SAMLWriter Component)
Contains a status message (optional).
Syntax
func (obj *SAMLWriter) ResponseStatusMessage() (string, error)
func (obj *SAMLWriter) SetResponseStatusMessage(value string) error
Default Value
""
Remarks
Contains a status message (optional).
This property specifies the status message which may, optionally, be returned to an operator.
Data Type
string
ScopingIDPCount Property (SAMLWriter Component)
The number of records in the ScopingIDP arrays.
Syntax
func (obj *SAMLWriter) ScopingIDPCount() (int32, error)
func (obj *SAMLWriter) SetScopingIDPCount(value int32) error
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ScopingIDPCount - 1.Data Type
int32
ScopingIDPLoc Property (SAMLWriter Component)
Contains the value of the Loc attribute.
Syntax
func (obj *SAMLWriter) ScopingIDPLoc(ScopingIDPIndex int32) (string, error)
func (obj *SAMLWriter) SetScopingIDPLoc(ScopingIDPIndex int32, value string) error
Default Value
""
Remarks
Contains the value of the Loc attribute.
Use this property to access or set the value of the Loc (location) attribute.
The ScopingIDPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ScopingIDPCount property.
Data Type
string
ScopingIDPName Property (SAMLWriter Component)
Contains the name of the IdP provider.
Syntax
func (obj *SAMLWriter) ScopingIDPName(ScopingIDPIndex int32) (string, error)
func (obj *SAMLWriter) SetScopingIDPName(ScopingIDPIndex int32, value string) error
Default Value
""
Remarks
Contains the name of the IdP provider.
Use this property to retrieve or set the Name attribute of the IdP provider.
The ScopingIDPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ScopingIDPCount property.
Data Type
string
ScopingIDPProviderID Property (SAMLWriter Component)
Contains the provider ID.
Syntax
func (obj *SAMLWriter) ScopingIDPProviderID(ScopingIDPIndex int32) (string, error)
func (obj *SAMLWriter) SetScopingIDPProviderID(ScopingIDPIndex int32, value string) error
Default Value
""
Remarks
Contains the provider ID.
Use this property to read or set the identity provider ID.
The ScopingIDPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ScopingIDPCount property.
Data Type
string
SecurityCanonicalizationMethod Property (SAMLWriter Component)
The canonicalization method to use in the signature.
Syntax
func (obj *SAMLWriter) SecurityCanonicalizationMethod() (string, error)
func (obj *SAMLWriter) SetSecurityCanonicalizationMethod(value string) error
Default Value
""
Remarks
The canonicalization method to use in the signature.
The URI of the canonicalization method to use in the signature (e.g. http://www.w3.org/TR/xml-exc-c14n/)
Data Type
string
SecurityDigestMethod Property (SAMLWriter Component)
The digest method to use.
Syntax
func (obj *SAMLWriter) SecurityDigestMethod() (string, error)
func (obj *SAMLWriter) SetSecurityDigestMethod(value string) error
Default Value
""
Remarks
The digest method to use.
The URI of the digest method to use for signing, as defined in XMLDSIG or XMLENC: http://www.w3.org/2000/09/xmldsig#sha256.
Data Type
string
SecurityEncryptionMethod Property (SAMLWriter Component)
The encryption method used to encrypt the assertion.
Syntax
func (obj *SAMLWriter) SecurityEncryptionMethod() (string, error)
func (obj *SAMLWriter) SetSecurityEncryptionMethod(value string) error
Default Value
"AES256"
Remarks
The encryption method used to encrypt the assertion.
This property contains the encryption algorithm used to encrypt the XML assertion.
Supported values:
| SB_XML_ENCRYPTION_ALGORITHM_RC4 | RC4 | |
| SB_XML_ENCRYPTION_ALGORITHM_DES | DES | |
| SB_XML_ENCRYPTION_ALGORITHM_3DES | 3DEST | |
| SB_XML_ENCRYPTION_ALGORITHM_AES128 | AES128 | |
| SB_XML_ENCRYPTION_ALGORITHM_AES192 | AES192 | |
| SB_XML_ENCRYPTION_ALGORITHM_AES256 | AES256 | |
| SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA128 | Camellia128 | |
| SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA192 | Camellia192 | |
| SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA256 | Camellia256 | |
| SB_XML_ENCRYPTION_ALGORITHM_SEED | SEED |
Data Type
string
SecurityFlags Property (SAMLWriter Component)
Provides access to secondary security parameters and tweaks.
Syntax
func (obj *SAMLWriter) SecurityFlags() (int32, error)
func (obj *SAMLWriter) SetSecurityFlags(value int32) error
Default Value
1
Remarks
Provides access to secondary security parameters and tweaks.
This property is a bitwise combination of zero or more flags. The following flags are currently supported: The following flags can be used with any SAML component (although they may not apply in all modes of use):
| ssfSignatureAfterIssuer | 1 | Place the Signature tag after the issuer tag in the XML document |
| ssfSignatureBeforeDescriptor | 2 | Place the Signature tag before the entity descriptor tag in the XML metadata |
| ssfKeyDataIssuerSerial | 4 | Include the IssuerSerial key data element |
| ssfKeyDataSKI | 8 | Include the SubjectKeyIdentifier key data element |
| ssfKeyDataSubjectName | 16 | Include the SubjectName key data element |
| ssfKeyDataCertificate | 32 | Include the Certificate key data element |
| ssfKeyDataCRL | 64 | Include the CRL key data element |
| ssfSignAuthnRequests | 65536 | Sign authentication requests (SP only) |
| ssfSignArtifactResolveRequests | 131072 | Sign artifact resolve requests |
| ssfSignLogoutRequests | 262144 | Sign logout requests |
| ssfSignAssertions | 524288 | Sign outgoing assertions (IdP only) |
| ssfSignResponses | 1048576 | Sign all responses (IdP only) |
| ssfEncryptAssertions | 2097152 | Encrypt generated assertions (IdP only) |
Data Type
int32
SecuritySigMethod Property (SAMLWriter Component)
The signature method to use.
Syntax
func (obj *SAMLWriter) SecuritySigMethod() (string, error)
func (obj *SAMLWriter) SetSecuritySigMethod(value string) error
Default Value
""
Remarks
The signature method to use.
The URI specifying the signature method to use for signing, for example http://www.w3.org/2001/04/xmldsig-more#rsa-sha256.
Data Type
string
SecuritySignaturePolicy Property (SAMLWriter Component)
Specifies the signature validation policy.
Syntax
func (obj *SAMLWriter) SecuritySignaturePolicy() (int32, error)
func (obj *SAMLWriter) SetSecuritySignaturePolicy(value int32) error
Possible Values
0 // Auto
1 // Validate
2 // Require
3 // Ignore
Default Value
0
Remarks
Specifies the signature validation policy.
Use this property to specify the signature validation policy for the component.
Data Type
int32
SigningCertBytes Property (SAMLWriter Component)
Returns the raw certificate data in DER format.
Syntax
func (obj *SAMLWriter) SigningCertBytes() ([]byte, error)
Remarks
Returns the raw certificate data in DER format.
This property is read-only.
Data Type
[]byte
SigningCertHandle Property (SAMLWriter Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *SAMLWriter) SigningCertHandle() (int64, error)
func (obj *SAMLWriter) SetSigningCertHandle(value int64) error
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
Data Type
int64
SigningChainCount Property (SAMLWriter Component)
The number of records in the SigningChain arrays.
Syntax
func (obj *SAMLWriter) SigningChainCount() (int32, error)
func (obj *SAMLWriter) SetSigningChainCount(value int32) error
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at SigningChainCount - 1.Data Type
int32
SigningChainBytes Property (SAMLWriter Component)
Returns the raw certificate data in DER format.
Syntax
func (obj *SAMLWriter) SigningChainBytes(SigningChainIndex int32) ([]byte, error)
Remarks
Returns the raw certificate data in DER format.
The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.
This property is read-only.
Data Type
[]byte
SigningChainHandle Property (SAMLWriter Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *SAMLWriter) SigningChainHandle(SigningChainIndex int32) (int64, error)
func (obj *SAMLWriter) SetSigningChainHandle(SigningChainIndex int32, value int64) error
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.
Data Type
int64
StatementCount Property (SAMLWriter Component)
The number of records in the Statement arrays.
Syntax
func (obj *SAMLWriter) StatementCount() (int32, error)
func (obj *SAMLWriter) SetStatementCount(value int32) error
Default Value
0
Remarks
This property controls the size of the following arrays:
- StatementAuthnContextAuthenticatingAuthorities
- StatementAuthnContextChoice
- StatementAuthnContextClassRef
- StatementAuthnContextDecl
- StatementAuthnContextDeclRef
- StatementAuthnInstant
- StatementAuthnSessionIndex
- StatementAuthnSessionNotOnOrAfter
- StatementAuthnSubjectLocalityAddress
- StatementAuthnSubjectLocalityDNSName
- StatementAuthzActions
- StatementAuthzDecision
- StatementAuthzDecisionEvidence
- StatementAuthzDecisionResource
- StatementType
Data Type
int32
StatementAuthnContextAuthenticatingAuthorities Property (SAMLWriter Component)
Contains the list of authenticating authorities.
Syntax
func (obj *SAMLWriter) StatementAuthnContextAuthenticatingAuthorities(StatementIndex int32) (string, error)
func (obj *SAMLWriter) SetStatementAuthnContextAuthenticatingAuthorities(StatementIndex int32, value string) error
Default Value
""
Remarks
Contains the list of authenticating authorities.
Use this property to access the list of URIs of authenticating authorities (IdP entity IDs).
The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.
Data Type
string
StatementAuthnContextChoice Property (SAMLWriter Component)
Specifies the authentication context choice variant.
Syntax
func (obj *SAMLWriter) StatementAuthnContextChoice(StatementIndex int32) (string, error)
func (obj *SAMLWriter) SetStatementAuthnContextChoice(StatementIndex int32, value string) error
Default Value
""
Remarks
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.
The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.
Data Type
string
StatementAuthnContextClassRef Property (SAMLWriter Component)
Indicates the authentication contexts class reference.
Syntax
func (obj *SAMLWriter) StatementAuthnContextClassRef(StatementIndex int32) (string, error)
func (obj *SAMLWriter) SetStatementAuthnContextClassRef(StatementIndex int32, value string) error
Default Value
""
Remarks
Indicates the authentication contexts class reference.
Use this property to get or set the authentication contexts class reference attribute.
The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.
Data Type
string
StatementAuthnContextDecl Property (SAMLWriter Component)
Specifies the authentication contexts declaration.
Syntax
func (obj *SAMLWriter) StatementAuthnContextDecl(StatementIndex int32) (string, error)
func (obj *SAMLWriter) SetStatementAuthnContextDecl(StatementIndex int32, value string) error
Default Value
""
Remarks
Specifies the authentication contexts declaration.
Use this property to access or set the declaration element of the authentication context.
The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.
Data Type
string
StatementAuthnContextDeclRef Property (SAMLWriter Component)
Specifies the authentication contexts declaration reference.
Syntax
func (obj *SAMLWriter) StatementAuthnContextDeclRef(StatementIndex int32) (string, error)
func (obj *SAMLWriter) SetStatementAuthnContextDeclRef(StatementIndex int32, value string) error
Default Value
""
Remarks
Specifies the authentication contexts declaration reference.
Use this property to get or set the declaration reference of the authentication context.
The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.
Data Type
string
StatementAuthnInstant Property (SAMLWriter Component)
Specifies the authentication event timestamp.
Syntax
func (obj *SAMLWriter) StatementAuthnInstant(StatementIndex int32) (string, error)
func (obj *SAMLWriter) SetStatementAuthnInstant(StatementIndex int32, value string) error
Default Value
""
Remarks
Specifies the authentication event timestamp.
Use this property to read or set the moment in time the authentication event took place.
The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.
Data Type
string
StatementAuthnSessionIndex Property (SAMLWriter Component)
Contains the authentication session index.
Syntax
func (obj *SAMLWriter) StatementAuthnSessionIndex(StatementIndex int32) (string, error)
func (obj *SAMLWriter) SetStatementAuthnSessionIndex(StatementIndex int32, value string) error
Default Value
""
Remarks
Contains the authentication session index.
Use this property to access or set the authentication session index.
The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.
Data Type
string
StatementAuthnSessionNotOnOrAfter Property (SAMLWriter Component)
Maps to the SessionNotOnOrAfter parameter of the authentication statement.
Syntax
func (obj *SAMLWriter) StatementAuthnSessionNotOnOrAfter(StatementIndex int32) (string, error)
func (obj *SAMLWriter) SetStatementAuthnSessionNotOnOrAfter(StatementIndex int32, value string) error
Default Value
""
Remarks
Maps to the SessionNotOnOrAfter parameter of the authentication statement.
Use this property to access or set the SessionNotOnOrAfter parameter of the authentication statement.
The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.
Data Type
string
StatementAuthnSubjectLocalityAddress Property (SAMLWriter Component)
Specifies the authentication subjects address.
Syntax
func (obj *SAMLWriter) StatementAuthnSubjectLocalityAddress(StatementIndex int32) (string, error)
func (obj *SAMLWriter) SetStatementAuthnSubjectLocalityAddress(StatementIndex int32, value string) error
Default Value
""
Remarks
Specifies the authentication subjects address.
Use this property to specify the address parameter of the authentication subjects locality.
The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.
Data Type
string
StatementAuthnSubjectLocalityDNSName Property (SAMLWriter Component)
Maps to the authentication subjects DNS name parameter.
Syntax
func (obj *SAMLWriter) StatementAuthnSubjectLocalityDNSName(StatementIndex int32) (string, error)
func (obj *SAMLWriter) SetStatementAuthnSubjectLocalityDNSName(StatementIndex int32, value string) error
Default Value
""
Remarks
Maps to the authentication subjects DNS name parameter.
Use this property to access or set the authentication subjects DNS name locality parameter.
The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.
Data Type
string
StatementAuthzActions Property (SAMLWriter Component)
Provides access to the list of actions of the authorization statement.
Syntax
func (obj *SAMLWriter) StatementAuthzActions(StatementIndex int32) (string, error)
func (obj *SAMLWriter) SetStatementAuthzActions(StatementIndex int32, value string) error
Default Value
""
Remarks
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.
The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.
Data Type
string
StatementAuthzDecision Property (SAMLWriter Component)
Specifies the authorization decision.
Syntax
func (obj *SAMLWriter) StatementAuthzDecision(StatementIndex int32) (int32, error)
func (obj *SAMLWriter) SetStatementAuthzDecision(StatementIndex int32, value int32) error
Possible Values
0 // Permit
1 // Deny
2 // Indeterminate
Default Value
0
Remarks
Specifies the authorization decision.
Use this property to check or set the authorization decision. This can be one of Permit, Deny, or Indeterminate.
The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.
Data Type
int32
StatementAuthzDecisionEvidence Property (SAMLWriter Component)
Manages the authorization decision statement evidence parameter.
Syntax
func (obj *SAMLWriter) StatementAuthzDecisionEvidence(StatementIndex int32) (string, error)
func (obj *SAMLWriter) SetStatementAuthzDecisionEvidence(StatementIndex int32, value string) error
Default Value
""
Remarks
Manages the authorization decision statement evidence parameter.
Use this property to read or set the authorization decision statement evidence parameter.
The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.
Data Type
string
StatementAuthzDecisionResource Property (SAMLWriter Component)
Specifies the authorization decision statement resource parameter.
Syntax
func (obj *SAMLWriter) StatementAuthzDecisionResource(StatementIndex int32) (string, error)
func (obj *SAMLWriter) SetStatementAuthzDecisionResource(StatementIndex int32, value string) error
Default Value
""
Remarks
Specifies the authorization decision statement resource parameter.
Use this property to access or set the resource parameter of the authorization statement.
The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.
Data Type
string
StatementType Property (SAMLWriter Component)
Specifies the assertion statement type.
Syntax
func (obj *SAMLWriter) StatementType(StatementIndex int32) (int32, error)
func (obj *SAMLWriter) SetStatementType(StatementIndex int32, value int32) error
Possible Values
0 // Authn
1 // Attribute
2 // AuthzDecision
Default Value
0
Remarks
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.
The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.
Data Type
int32
SubjectConfirmationCount Property (SAMLWriter Component)
The number of records in the SubjectConfirmation arrays.
Syntax
func (obj *SAMLWriter) SubjectConfirmationCount() (int32, error)
func (obj *SAMLWriter) SetSubjectConfirmationCount(value int32) error
Default Value
0
Remarks
This property controls the size of the following arrays:
- SubjectConfirmationAddress
- SubjectConfirmationData
- SubjectConfirmationDataType
- SubjectConfirmationID
- SubjectConfirmationInResponseTo
- SubjectConfirmationMethod
- SubjectConfirmationNotBefore
- SubjectConfirmationNotOnOrAfter
- SubjectConfirmationRecipient
Data Type
int32
SubjectConfirmationAddress Property (SAMLWriter Component)
Contains the address enabled for presenting assertions.
Syntax
func (obj *SAMLWriter) SubjectConfirmationAddress(SubjectConfirmationIndex int32) (string, error)
func (obj *SAMLWriter) SetSubjectConfirmationAddress(SubjectConfirmationIndex int32, value string) error
Default Value
""
Remarks
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.
The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.
Data Type
string
SubjectConfirmationData Property (SAMLWriter Component)
The uninterpreted value of data entry in the subject confirmation.
Syntax
func (obj *SAMLWriter) SubjectConfirmationData(SubjectConfirmationIndex int32) (string, error)
func (obj *SAMLWriter) SetSubjectConfirmationData(SubjectConfirmationIndex int32, value string) error
Default Value
""
Remarks
The uninterpreted value of data entry in the subject confirmation.
Use this property to read or specify the uninterpreted value of the Data entry in the subject confirmation blob.
The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.
Data Type
string
SubjectConfirmationDataType Property (SAMLWriter Component)
The type of data contained in the confirmation.
Syntax
func (obj *SAMLWriter) SubjectConfirmationDataType(SubjectConfirmationIndex int32) (string, error)
func (obj *SAMLWriter) SetSubjectConfirmationDataType(SubjectConfirmationIndex int32, value string) error
Default Value
""
Remarks
The type of data contained in the confirmation.
Use this property to read or specify the type of confirmation data included in the object.
The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.
Data Type
string
SubjectConfirmationID Property (SAMLWriter Component)
The identifier of the entity which can satisfy the subject confirmation requirements.
Syntax
func (obj *SAMLWriter) SubjectConfirmationID(SubjectConfirmationIndex int32) (string, error)
func (obj *SAMLWriter) SetSubjectConfirmationID(SubjectConfirmationIndex int32, value string) error
Default Value
""
Remarks
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.
The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.
Data Type
string
SubjectConfirmationInResponseTo Property (SAMLWriter Component)
The ID of the SAML message in response to which the assertion is issued.
Syntax
func (obj *SAMLWriter) SubjectConfirmationInResponseTo(SubjectConfirmationIndex int32) (string, error)
func (obj *SAMLWriter) SetSubjectConfirmationInResponseTo(SubjectConfirmationIndex int32, value string) error
Default Value
""
Remarks
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.
The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.
Data Type
string
SubjectConfirmationMethod Property (SAMLWriter Component)
Specifies the mechanism to be used to confirm the subject.
Syntax
func (obj *SAMLWriter) SubjectConfirmationMethod(SubjectConfirmationIndex int32) (string, error)
func (obj *SAMLWriter) SetSubjectConfirmationMethod(SubjectConfirmationIndex int32, value string) error
Default Value
""
Remarks
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.
The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.
Data Type
string
SubjectConfirmationNotBefore Property (SAMLWriter Component)
Time moment before which the subject cannot be confirmed.
Syntax
func (obj *SAMLWriter) SubjectConfirmationNotBefore(SubjectConfirmationIndex int32) (string, error)
func (obj *SAMLWriter) SetSubjectConfirmationNotBefore(SubjectConfirmationIndex int32, value string) error
Default Value
""
Remarks
Time moment before which the subject cannot be confirmed.
This property specifies the time before which the subject cannot be confirmed.
The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.
Data Type
string
SubjectConfirmationNotOnOrAfter Property (SAMLWriter Component)
Limits the time until which the subject can be confirmed.
Syntax
func (obj *SAMLWriter) SubjectConfirmationNotOnOrAfter(SubjectConfirmationIndex int32) (string, error)
func (obj *SAMLWriter) SetSubjectConfirmationNotOnOrAfter(SubjectConfirmationIndex int32, value string) error
Default Value
""
Remarks
Limits the time until which the subject can be confirmed.
This property specifies the time on (or after) which the subject cannot be confirmed.
The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.
Data Type
string
SubjectConfirmationRecipient Property (SAMLWriter Component)
The URI of the entity or the location of the resource to which the assertion should be presented.
Syntax
func (obj *SAMLWriter) SubjectConfirmationRecipient(SubjectConfirmationIndex int32) (string, error)
func (obj *SAMLWriter) SetSubjectConfirmationRecipient(SubjectConfirmationIndex int32, value string) error
Default Value
""
Remarks
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.
The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.
Data Type
string
AddAttribute Method (SAMLWriter Component)
Adds an attribute to an existing attribute statement.
Syntax
func (obj *SAMLWriter) AddAttribute(AttributeName string, AttributeValue string, NameFormat string, ContentType string, StatementIndex int32) (int32, error)
Remarks
Use this method to add an attribute to an attribute statement. The method returns the index of the newly added attribute in the statement.
Use the method parameters to provide the parameters of the new attribute:
<saml:Attribute
Name="uid" <!-- AttributeName -->
NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" <!-- NameFormat -->
>
<saml:AttributeValue xsi:type="xs:string" <!-- ContentType --> >test <!-- AttributeValue --> </saml:AttributeValue>
</saml:Attribute>
</code>
Note: if StatementIndex is set to -1, the attribute will be added to the last attribute statement in the collection. If no attribute statements are available in the collection, one will be created automatically.
If StatementIndex exceeds the index of the last statement in the Statements collection, a new attribute statement will be created (even if there are other attribute statements in the list), and the attribute added to it.
If StatementIndex points to an existing statement but that statement is not an attribute statement, an exception will be thrown.
AddAttributeStatement Method (SAMLWriter Component)
Adds an attribute statement to the assertion.
Syntax
func (obj *SAMLWriter) AddAttributeStatement() (int32, error)
Remarks
Use this method to add an attribute statement to the currently edited assertion. The method returns the index of the newly added statement in the Statements collection.
Note that a call to AddAttribute adds a new attribute statement behind the scenes if no attribute statements have been added by that time.
AddAuthnStatement Method (SAMLWriter Component)
Adds an authentication statement to the assertion.
Syntax
func (obj *SAMLWriter) AddAuthnStatement(AuthnInstant string, SessionIndex string, NotOnOrAfter string, ClassRef string) (int32, error)
Remarks
Use this method to add an authentication statement to the currently edited assertion. The method returns the index of the newly added statement in the Statements collection.
AddAuthzDecisionStatement Method (SAMLWriter Component)
Adds an authorization decision statement to the assertion.
Syntax
func (obj *SAMLWriter) AddAuthzDecisionStatement(Decision int32, Evidence string, Resource string, Actions string) (int32, error)
Remarks
Use this method to add an authorization decision statement to the currently edited assertion. The method returns the index of the newly added statement in the Statements collection.
AddCondition Method (SAMLWriter Component)
Adds a condition to the object (assertion or authn request) being edited.
Syntax
func (obj *SAMLWriter) AddCondition(ConditionType int32, ConditionValue string) (int32, error)
Remarks
Use this method to quickly add a condition to the SAML object you are creating.
AddScopingIDP Method (SAMLWriter Component)
Adds a scoping IDP to the object being currently edited.
Syntax
func (obj *SAMLWriter) AddScopingIDP(Name string, ProviderID string, Loc string) (int32, error)
Remarks
Use this method to quickly add a scoping IDP to the SAML object you are creating. The method returns the index of the new element in the ScopingIDPs collection.
AddSubjectConfirmation Method (SAMLWriter Component)
Adds a subject confirmation to the object being edited.
Syntax
func (obj *SAMLWriter) AddSubjectConfirmation(Method string, Address string, Recipient string, InResponseTo string, NotBefore string, NotOnOrAfter string, ID string, DataType string, Data string) (int32, error)
Remarks
Use this method to quickly add a subject confirmation to the SAML object you are creating. The method returns the index of the new subject confirmation in the list.
BeginAssertion Method (SAMLWriter Component)
Initiates the process of creating a new assertion.
Syntax
func (obj *SAMLWriter) BeginAssertion() error
Remarks
This method resets the contents of all assertion-related properties and prepares the component for creating a new assertion.
Use the methods and properties of the component, such as Assertion, as well as Statements and Attributes to prepare the new assertion. When ready, call CompleteAssertion to commit the provided details to the message.
CompleteAssertion Method (SAMLWriter Component)
Adds a completed assertion to a SAML message.
Syntax
func (obj *SAMLWriter) CompleteAssertion() (int32, error)
Remarks
Use this method to commit an assertion to the SAML message being created. Before calling this method, prepare the assertion by calling BeginAssertion and filling in the details via the Assertion, Attributes, and Statements properties.
The method returns the index of the new assertion in the list.
Config Method (SAMLWriter Component)
Sets or retrieves a configuration setting.
Syntax
func (obj *SAMLWriter) Config(ConfigurationString string) (string, error)
Remarks
Config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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
func (obj *SAMLWriter) CreateNew(ContentType int32) error
Remarks
Use this method to create a new SAML message with the specified content type. The following values are supported:
- cstyNone (0)
- cstyAssertionIDRequest (1)
- cstySubjectQuery (2)
- cstyAuthnQuery (3)
- cstyAttributeQuery (4)
- cstyAuthzDecisionQuery (5)
- cstyAuthnRequest (6)
- cstyManageNameIDRequest (7)
- cstyLogoutRequest (8)
- cstyNameIDMappingRequest (9)
- cstyArtifactResolve (10)
- cstyResponse (11)
- cstyAssertion (12)
DoAction Method (SAMLWriter Component)
Performs an additional action.
Syntax
func (obj *SAMLWriter) DoAction(ActionID string, ActionParams string) (string, error)
Remarks
DoAction is a generic method available in every struct. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier (case insensitive) of the action is provided in the ActionID parameter.
ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Common ActionIDs:
| Action | Parameters | Returned value | Description |
| ResetTrustedListCache | none | none | Clears the cached list of trusted lists. |
| ResetCertificateCache | none | none | Clears the cached certificates. |
| ResetCRLCache | none | none | Clears the cached CRLs. |
| ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. |
FormatID Method (SAMLWriter Component)
Formats a SAML ID in the form in which it can be assigned to the Issuer or Subject fields.
Syntax
func (obj *SAMLWriter) FormatID(Value string, IDType string, Format string, NameQualifier string, SPNameQualifier string, SPProvidedID string) (string, error)
Remarks
This is a utility method that simplifies formatting of SAML IDs. Pass the components of the SAML ID to this method, and assign the resulting string to the required property.
Example:
// you can provide some of the values; the optional values will be omitted from the output
writer.Issuer = writer.FormatID("https://saml.mysite.com", "Issuer", "urn:oasis:names:tc:SAML:2.0:nameid-format:entity", "", "", "");
// this call will just return the bare value, with no attributes
writer.Issuer = writer.FormatID("https://saml.mysite.com", "", "", "", "", "");
Reset Method (SAMLWriter Component)
Resets the class settings.
Syntax
func (obj *SAMLWriter) Reset() error
Remarks
Reset is a generic method available in every struct.
Save Method (SAMLWriter Component)
Saves the configured message to a string.
Syntax
func (obj *SAMLWriter) Save() (string, error)
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
func (obj *SAMLWriter) SaveBytes() ([]byte, error)
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
func (obj *SAMLWriter) SaveFile(FileName string) error
Remarks
Use this method to save the created SAML message to a file.
Error Event (SAMLWriter Component)
Fires to report an error condition.
Syntax
// SAMLWriterErrorEventArgs carries the SAMLWriter Error event's parameters.
type SAMLWriterErrorEventArgs struct {...}
func (args *SAMLWriterErrorEventArgs) ErrorCode() int32
func (args *SAMLWriterErrorEventArgs) Description() string
// SAMLWriterErrorEvent defines the signature of the SAMLWriter Error event's handler function.
type SAMLWriterErrorEvent func(sender *SAMLWriter, args *SAMLWriterErrorEventArgs)
func (obj *SAMLWriter) GetOnErrorHandler() SAMLWriterErrorEvent
func (obj *SAMLWriter) SetOnErrorHandler(handlerFunc SAMLWriterErrorEvent)
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
// SAMLWriterNotificationEventArgs carries the SAMLWriter Notification event's parameters.
type SAMLWriterNotificationEventArgs struct {...}
func (args *SAMLWriterNotificationEventArgs) EventID() string
func (args *SAMLWriterNotificationEventArgs) EventParam() string
// SAMLWriterNotificationEvent defines the signature of the SAMLWriter Notification event's handler function.
type SAMLWriterNotificationEvent func(sender *SAMLWriter, args *SAMLWriterNotificationEventArgs)
func (obj *SAMLWriter) GetOnNotificationHandler() SAMLWriterNotificationEvent
func (obj *SAMLWriter) SetOnNotificationHandler(handlerFunc SAMLWriterNotificationEvent)
Remarks
The struct fires this event to let the application know about some event, occurrence, or milestone in the struct. 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 struct, the exact action it is performing, or the document being processed, one or both may be omitted.
Config Settings (SAMLWriter Component)
The struct 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 struct, access to these internal properties is provided through the Config method.SAMLWriter Config Settings
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
| off | No caching (default) | |
| local | Local caching | |
| global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported Values:
| auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). |
| enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. |
| disable | Do not use hardware cryptography. |
Supported values are:
| file | File | |
| console | Console | |
| systemlog | System Log (supported for Android only) | |
| debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
| time | Current time | |
| level | Level | |
| package | Package name | |
| module | Module name | |
| class | Class name | |
| method | Method name | |
| threadid | Thread Id | |
| contenttype | Content type | |
| content | Content | |
| all | All details |
Supported filter names are:
| exclude-package | Exclude a package specified in the value | |
| exclude-module | Exclude a module specified in the value | |
| exclude-class | Exclude a class specified in the value | |
| exclude-method | Exclude a method specified in the value | |
| include-package | Include a package specified in the value | |
| include-module | Include a module specified in the value | |
| include-class | Include a class specified in the value | |
| include-method | Include a method specified in the value |
| none | No flush (caching only) | |
| immediate | Immediate flush (real-time logging) | |
| maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
| none | None (by default) | |
| fatal | Severe errors that cause premature termination. | |
| error | Other runtime errors or unexpected conditions. | |
| warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
| info | Interesting runtime events (startup/shutdown). | |
| debug | Detailed information on flow of through the system. | |
| trace | More detailed information. |
The default value of this setting is 100.
| none | No rotation | |
| deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
| keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported Values:
| certificate | Enables caching of certificates. |
| crl | Enables caching of Certificate Revocation Lists (CRLs). |
| ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. |
Example (default value):
PKICache=certificate,crl,ocsp
In this example, the component caches certificates, CRLs, and OCSP responses.
The default value is an empty string - no cached PKI data is stored on disk.
Example:
PKICachePath=C:\Temp\cache
In this example, the cached PKI data is stored in the C:\Temp\cache directory.
Supported values are:
| none | No static DNS rules (default) | |
| local | Local static DNS rules | |
| global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.
Syntax:
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");
Where:
OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.
PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.
Alias1, Alias2, ...: Optional alternative names recognized during parsing.
Usage Examples:
Map OID 2.5.4.5 to SERIALNUMBER:
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");