SAMLSPServer Component
Properties Methods Events Config Settings Errors
The SAMLSPServer class represents a SAML service provider.
Syntax
secureblackbox.SAMLSPServer
Remarks
The Service Provider in the SAML exchange flow represents the web server that receives and accepts authentication assertions issued by the Identity Provider for single sign-on (SSO). Most commonly, an SP server is part of the application responsible for communicating with an Identity Provider to establish the authenticity of application users.
SAMLSPServer provides easy means of integrating the SAML Service Provider functionality into your application. It presents a fully-features SP endpoint with its own HTTP(S) and assertion validation engines.
Please find below a step-by-step guide on setting up your own SAML SP endpoint.
- Register the IdP metadata using the ImportSettings method.
Most IDPs let you download their metadata in XML format. The metadata file contains general
parameters of the IdP endpoint, such as its web address and algorithm requirements.
server.ImportSettings(metadataBytes, false); // contains "<?xml version="1.0"?><md:EntityDescriptor ID="ab12" ... </md:EntityDescriptor>"; - Configure the main server capabilities:
// public server endpoint (use "https://" and/or port 443 if required) server.URL = "http://sp.myapp.com"; server.Port = 80; // IdP triggers this URL to pull metadata server.MetadataURL = '/sp/metadata'; // ACS is th "main" SP endpoint that receives assertions from the IdP server.AssertionConsumerService = '/sp/AssertionConsumerService'; server.SPToIDPBinding = csbtRedirect; // the SP will use HTTP redirect to forward the browser to the IdP when required server.AssertionConsumerServiceBindings = 'POST'; // and we want the IdP to use POST to submit its assertions server.PreferredIDPToSPBinding = csbtPOST; // Single logout service setup server.SingleLogoutService = '/sp/SingleLogoutService'; server.SingleLogoutServiceBindings = 'Redirect,POST,Artifact'; server.LogoutPage = '/sp/logout'; server.RedirectOnLogoutPage = 'https://www.nsoftware.com'; // The document root of the server on the local system server.BaseDir = "D:\\Inetpub\\SAMLSP"; // Security parameters: indicating that we want to sign both // the metadata and the requests server.SignAuthnRequests = true; server.SignMetadata = true; // We need to attach certificates to be able to sign. // Assume we have loaded our signing certificate into // a CertificateManager object. server.SigningCertificate = mgr.Certificate; server.MetaSigningCertificate = mgr.Certificate; - Personalize the server:
server.Config("OrganizationName=My Organization Ltd"); server.Config("OrganizationDisplayName=My Organization Pet Supplies"); server.Config("OrganizationURL=http://myorg.com"); server.Config("SigDigestMethod=http://www.w3.org/2001/04/xmlenc#sha256"); server.Config("SigMethod=http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"); server.Config("WantAssertionsSigned=true"); - Optionally, save metadata to an XML file. This will let you send/upload it to the IdP,
so they could set your SP up. Some IdPs can download the metadata right from your SP
using the MetadataURL that you've provided above, in which case saving it to a file
is not necessary.
server.SaveMetadata("my_metadata.xml");
server.Start();
The server should now be running on the local system, listening to incoming connections on the port that you
have specified above (80). Use your browser to check if the server is responding by navigating
to the metadata URL (http://127.0.0.1:80/sp/metadata). If the server has been set up right,
you should see something like this:
Now let us actually try to use the SAML functionality. Copy an arbitrary file - for example, a recent photo of your cat - to the directory you provided earlier via the BaseDir property (D:\Inetpub\SAMLSP). Having copied the file (suppose it is called clifford.jpg), try to access it in your browser by navigating to http://127.0.0.1:80/clifford.jpg.
This is where SAML kicks in. Since you are not authenticated for the SP server yet (we have just launched it, so no one is), the server redirects your browser to the IdP endpoint for authentication. The address of the IdP is taken from the their_metadata.xml file that you have loaded at the very beginning.
Note: you can configure which resources to restrict access to using the ProtectedResources property. If ProtectedResources is empty, the server considers all the files in BaseDir and its subfolders to be protected.
It is now the IdP services turn to authenticate you. Most IdPs on this stage will present you with a login form. Yet, if you have signed in recently, the IdP may still remember you, in which case it will skip the form and proceed directly to the next step. After establishing and proving your identity, the IdP will generate an assertion, a signed proof that effectively states that the IdP knows who you are and have verified your identity rigorously. Think of the assertion as your unique pass to the resources protected by the SP. The IdP will then submit that assertion back to the SP at its AssertionConsumerService endpoint, again using your browser.
Note that the SP service knows nothing about how IdP authenticates you. All the SP is interested in is an assertion.
If the assertion is well-formed and its signature is valid, the SAML exchange completes. At this point the SP accepts the assertion and creates a session for you. You can now access the resources protected by the SP for as long as the session lasts. If this step succeeds, you should see the photo of your cat in your browser.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| Active | Tells whether the server is active and ready to process requests. |
| BaseDir | Base directory on the server. |
| BindingKeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| DecryptionCertBytes | Returns the raw certificate data in DER format. |
| DecryptionCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| ExternalCryptoAsyncDocumentID | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. |
| ExternalCryptoCustomParams | Custom parameters to be passed to the signing service (uninterpreted). |
| ExternalCryptoData | Additional data to be included in the async state and mirrored back by the requestor. |
| ExternalCryptoExternalHashCalculation | Specifies whether the message hash is to be calculated at the external endpoint. |
| ExternalCryptoHashAlgorithm | Specifies the request's signature hash algorithm. |
| ExternalCryptoKeyID | The ID of the pre-shared key used for DC request authentication. |
| ExternalCryptoKeySecret | The pre-shared key used for DC request authentication. |
| ExternalCryptoMethod | Specifies the asynchronous signing method. |
| ExternalCryptoMode | Specifies the external cryptography mode. |
| ExternalCryptoPublicKeyAlgorithm | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. |
| FIPSMode | Reserved. |
| HandshakeTimeout | Specifies the handshake timeout in milliseconds. |
| Host | Specifies the host address of the SP server. |
| IdPServiceCount | The number of records in the IdPService arrays. |
| IdPServiceBindingType | Specifies the type of SAML binding that this endpoint accepts. |
| IdPServiceEntityID | Represents the SAML entity ID. |
| IdPServiceLocation | The location (URL) of the endpoint. |
| IdPServicePriority | The priority of the endpoint in relation to other endpoints with the same Location . |
| IdPServiceService | The kind of the service being provided at this endpoint. |
| IdPServiceServiceIndex | The index of this endpoint. |
| IdPContactPerson | The contact person or persons for the entity. |
| IdPEncryptionKey | Contains the entity's encryption key. |
| IdPEncryptionMethods | Specifies the list of encryption methods supported by the entity. |
| IdPEntityID | Represents the SAML entity ID. |
| IdPFlags | Adjusts secondary entity properties. |
| IdPSSOLink | Contains a local server page link that triggers SAML authentication to the SP. |
| IdPNameIDFormats | The list of NameID formats supported by this entity. |
| IdPOrganizationDisplayName | The friendly name of the organization that maintains the entity. |
| IdPOrganizationLang | The language preferred by the organization. |
| IdPOrganizationName | The name of the organization that maintains the entity. |
| IdPOrganizationURL | The web URL of the organization that maintains the entity. |
| IdPSignatureValidationResult | The outcome of the cryptographic signature validation. |
| IdPSigned | Specifies whether the SAML entity information is or should be signed. |
| IdPSignedWith | Contains the certificate or key that was used to sign the settings (metadata) document. |
| IdPSigningKey | Contains the entity's signing key. |
| IdPValidUntil | Specifies the expiration time of the SAML entity information. |
| Issuer | Name identifier of the issuer of the SP's requests. |
| KnownCertCount | The number of records in the KnownCert arrays. |
| KnownCertBytes | Returns the raw certificate data in DER format. |
| KnownCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| KnownKeyCount | The number of records in the KnownKey arrays. |
| KnownKeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| LogoutPage | Specifies the location of the logout page. |
| MetadataURL | The SP's metadata location. |
| MetaSigningCertBytes | Returns the raw certificate data in DER format. |
| MetaSigningCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| OfflineMode | Enables the Offline mode. |
| PinnedClientAEADCipher | Indicates whether the encryption algorithm used is an AEAD cipher. |
| PinnedClientChainValidationDetails | The details of a certificate chain validation outcome. |
| PinnedClientChainValidationResult | The outcome of a certificate chain validation routine. |
| PinnedClientCiphersuite | The cipher suite employed by this connection. |
| PinnedClientClientAuthenticated | Specifies whether client authentication was performed during this connection. |
| PinnedClientClientAuthRequested | Specifies whether client authentication was requested during this connection. |
| PinnedClientConnectionEstablished | Indicates whether the connection has been established fully. |
| PinnedClientConnectionID | The unique identifier assigned to this connection. |
| PinnedClientDigestAlgorithm | The digest algorithm used in a TLS-enabled connection. |
| PinnedClientEncryptionAlgorithm | The symmetric encryption algorithm used in a TLS-enabled connection. |
| PinnedClientExportable | Indicates whether a TLS connection uses a reduced-strength exportable cipher. |
| PinnedClientGroup | The elliptic curve used in this connection. |
| PinnedClientID | The client connection's unique identifier. |
| PinnedClientKeyExchangeAlgorithm | The key exchange algorithm used in a TLS-enabled connection. |
| PinnedClientKeyExchangeKeyBits | The length of the key exchange key of a TLS-enabled connection. |
| PinnedClientPFSCipher | Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). |
| PinnedClientPreSharedIdentity | Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
| PinnedClientPreSharedIdentityHint | A hint professed by the server to help the client select the PSK identity to use. |
| PinnedClientPublicKeyBits | The length of the public key. |
| PinnedClientRemoteAddress | The client's IP address. |
| PinnedClientRemotePort | The remote port of the client connection. |
| PinnedClientResumedSession | Indicates whether a TLS-enabled connection was spawned from another TLS connection. |
| PinnedClientSecureConnection | Indicates whether TLS or SSL is enabled for this connection. |
| PinnedClientServerAuthenticated | Indicates whether server authentication was performed during a TLS-enabled connection. |
| PinnedClientSignatureAlgorithm | The signature algorithm used in a TLS handshake. |
| PinnedClientSymmetricBlockSize | The block size of the symmetric algorithm used. |
| PinnedClientSymmetricKeyBits | The key length of the symmetric algorithm used. |
| PinnedClientTotalBytesReceived | The total number of bytes received over this connection. |
| PinnedClientTotalBytesSent | The total number of bytes sent over this connection. |
| PinnedClientValidationLog | Contains the server certificate's chain validation log. |
| PinnedClientVersion | Indicates the version of SSL/TLS protocol negotiated during this connection. |
| PinnedClientCertCount | The number of records in the PinnedClientCert arrays. |
| PinnedClientCertBytes | Returns the raw certificate data in DER format. |
| PinnedClientCertCAKeyID | A unique identifier (fingerprint) of the CA certificate's cryptographic key. |
| PinnedClientCertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| PinnedClientCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| PinnedClientCertIssuer | The common name of the certificate issuer (CA), typically a company name. |
| PinnedClientCertIssuerRDN | A list of Property=Value pairs that uniquely identify the certificate issuer. |
| PinnedClientCertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
| PinnedClientCertKeyBits | Returns the length of the public key in bits. |
| PinnedClientCertKeyFingerprint | Returns a SHA1 fingerprint of the public key contained in the certificate. |
| PinnedClientCertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| PinnedClientCertPublicKeyBytes | Contains the certificate's public key in DER format. |
| PinnedClientCertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| PinnedClientCertSerialNumber | Returns the certificate's serial number. |
| PinnedClientCertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| PinnedClientCertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| PinnedClientCertSubjectKeyID | Contains a unique identifier of the certificate's cryptographic key. |
| PinnedClientCertSubjectRDN | A list of Property=Value pairs that uniquely identify the certificate holder (subject). |
| PinnedClientCertValidFrom | The time point at which the certificate becomes valid, in UTC. |
| PinnedClientCertValidTo | The time point at which the certificate expires, in UTC. |
| Port | Specifies the listening port number. |
| ProtectedResources | Specifies the list of protected resources. |
| RedirectOnLogoutPage | Specifies the location to redirect the user on logout. |
| 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. |
| SenderCertCount | The number of records in the SenderChain arrays. |
| SenderChainBytes | Returns the raw certificate data in DER format. |
| SenderChainHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| 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. |
| SocketIncomingSpeedLimit | The maximum number of bytes to read from the socket, per second. |
| SocketLocalAddress | The local network interface to bind the socket to. |
| SocketLocalPort | The local port number to bind the socket to. |
| SocketOutgoingSpeedLimit | The maximum number of bytes to write to the socket, per second. |
| SocketTimeout | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
| SocketUseIPv6 | Enables or disables IP protocol version 6. |
| SPServiceCount | The number of records in the SPService arrays. |
| SPServiceBindingType | Specifies the type of SAML binding that this endpoint accepts. |
| SPServiceEntityID | Represents the SAML entity ID. |
| SPServiceLocation | The location (URL) of the endpoint. |
| SPServicePriority | The priority of the endpoint in relation to other endpoints with the same Location . |
| SPServiceService | The kind of the service being provided at this endpoint. |
| SPServiceServiceIndex | The index of this endpoint. |
| SPContactPerson | The contact person or persons for the entity. |
| SPEncryptionKey | Contains the entity's encryption key. |
| SPEncryptionMethods | Specifies the list of encryption methods supported by the entity. |
| SPEntityID | Represents the SAML entity ID. |
| SPFlags | Adjusts secondary entity properties. |
| SPIdPSSOLink | Contains a local server page link that triggers SAML authentication to the SP. |
| SPNameIDFormats | The list of NameID formats supported by this entity. |
| SPOrganizationDisplayName | The friendly name of the organization that maintains the entity. |
| SPOrganizationLang | The language preferred by the organization. |
| SPOrganizationName | The name of the organization that maintains the entity. |
| SPOrganizationURL | The web URL of the organization that maintains the entity. |
| SPSignatureValidationResult | The outcome of the cryptographic signature validation. |
| SPSigned | Specifies whether the SAML entity information is or should be signed. |
| SPSignedWith | Contains the certificate or key that was used to sign the settings (metadata) document. |
| SPSigningKey | Contains the entity's signing key. |
| SPValidUntil | Specifies the expiration time of the SAML entity information. |
| TLSServerCertCount | The number of records in the TLSServerCert arrays. |
| TLSServerCertBytes | Returns the raw certificate data in DER format. |
| TLSServerCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| TLSAutoValidateCertificates | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
| TLSBaseConfiguration | Selects the base configuration for the TLS settings. |
| TLSCiphersuites | A list of ciphersuites separated with commas or semicolons. |
| TLSClientAuth | Enables or disables certificate-based client authentication. |
| TLSExtensions | Provides access to TLS extensions. |
| TLSForceResumeIfDestinationChanges | Whether to force TLS session resumption when the destination address changes. |
| TLSGroups | Specifies a list of key exchange groups to attempt during the TLS key exchange. |
| TLSPreSharedIdentity | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
| TLSPreSharedKey | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
| TLSPreSharedKeyCiphersuite | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
| TLSRenegotiationAttackPreventionMode | Selects the renegotiation attack prevention mechanism. |
| TLSRevocationCheck | Specifies the kind(s) of revocation check to perform. |
| TLSSSLOptions | Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size. |
| TLSMode | Specifies the TLS mode to use. |
| TLSUseExtendedMasterSecret | Enables the Extended Master Secret Extension, as defined in RFC 7627. |
| TLSUseSessionResumption | Enables or disables the TLS session resumption capability. |
| TLSVersions | The SSL/TLS versions to enable by default. |
| URL | Specifies the base URL of this SP server. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| AddIdPService | Registers an IdP service in the IdPServices list. |
| AddSPService | Registers an SP service in the SPServices list. |
| Cleanup | Cleans up the server environment by purging expired sessions and cleaning caches. |
| Config | Sets or retrieves a configuration setting. |
| DoAction | Performs an additional action. |
| DropClient | Terminates a client connection. |
| ExportSettings | Saves the SP or IdP configuration to an XML metadata file. |
| GetClientBuffer | Acquires a piece of operation data. |
| GetProviderProperty | Returns the value of a custom provider property. |
| GetRequestBytes | Returns the contents of the connected client's HTTP request. |
| GetRequestHeader | Returns a request header value. |
| GetResponseHeader | Returns a response header value. |
| GetSessionProperty | Returns the value of a custom session property. |
| ImportSettings | Loads the metadata required for information exchange with the identity provider. Both local (SP-side) and remote (IdP-side) metadata can be loaded with this call. |
| InitiateArtifactResolve | Initiates the artifact resolution protocol. |
| InitiateAttributeQuery | Initiates the attribute query. |
| InitiateAuth | Starts SP-initiated SAML authentication flow. |
| InitiateLogout | Starts SP-initiated SAML logout flow. |
| ListClients | Enumerates the connected clients. |
| PinClient | Takes a snapshot of the connection's properties. |
| ProcessArtifact | Processes an artifact request received from the IdP service at one of artifact receiver endpoints. |
| ProcessArtifactResolveRequest | Processes an artifact request received from the SP service at one of the ARS endpoints. |
| ProcessAssertion | Processes assertion received from the IdP service at one of the ACS endpoints. |
| ProcessGenericRequest | Processes a generic HTTP SAML request. |
| ProcessLogoutRequest | Processes logout request received from the IdP service at one of the SLS endpoints. |
| Reset | Resets the class settings. |
| SetClientBuffer | Commits a data buffer to the connection. |
| SetProviderProperty | Sets the value of a custom provider property. |
| SetResponseHeader | Sets a response header. |
| SetSessionProperty | Sets the value of a custom provider session property. |
| Start | Starts the SP server. |
| Stop | Stops the IdP server. |
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.
| Accept | Reports an incoming connection. |
| ArtifactReceived | The server fires this event upon receiving an Artifact message from the other side. |
| ArtifactResolveRequestPrepared | This event is fired when a new artifact resolution request message has been prepared by the class. |
| ArtifactResolveRequestReceived | Reports receipt of ArtifactResolveRequest message. |
| AssertionReceived | This event is fired when an assertion is received from the IdP. |
| AttributeQueryPrepared | Notifies the application of the preparation of an AttributeQuery. |
| AuthnRequestPrepared | This event is fired when a new authentication request message has been prepared. |
| Connect | Reports an accepted connection. |
| Disconnect | Fires to report a disconnected client. |
| Encrypted | Notifies the application that the assertion is encrypted and provides recipient certificate details. |
| Error | Information about errors during data delivery. |
| ExternalSign | Handles remote or external signing initiated by the server protocol. |
| LogoutRequestPrepared | This event is fired when a new logout request has been prepared. |
| LogoutRequestReceived | The class uses this event to notify the application about an incoming SAML Logout Request message. |
| LogoutResponsePrepared | The class uses this event to notify the application about the Logout Response message being ready to be sent. |
| LogoutResponseReceived | The class uses this event to notify the application about an incoming SAML LogoutResponse message. |
| Notification | This event notifies the application about an underlying control flow event. |
| ProcessingCompleted | This event notifies the application of the completion of request or response processing. |
| ReadArtifact | Requests content identified by an artifact from the application. |
| ResourceClose | Tells the application that it can close the opened resource. |
| ResourceOpen | Requests the application to open the requested resource. |
| ResourceRead | Requests the application to read from an opened resource. |
| ResourceRequest | Notifies the application that a server resource is requested. |
| ResourceWrite | Requests the application to write to an opened resource. |
| SAMLMessagePrepared | This event is fired when a SAML message has been prepared and is ready to be dispatched. |
| SAMLMessageReceived | The server fires this event for every SAML message it receives. |
| SessionCreated | This event is fired when a new session has been established. |
| SessionDestroyed | This event is fired when the SP server has closed a session. |
| SessionEvent | Notifies the application about SAML session events. |
| SessionInfoNeeded | This event is fired in OfflineMode to request the session ID for the current flow. |
| SessionStateRetrieve | This event fires to retrieve session state information from the application. |
| SessionStateSave | This event passes a session state object to the application for safekeeping. |
| SignatureFound | Signifies the start of signature validation. |
| SignatureValidated | Reports the signature validation result. |
| TLSCertValidate | Fires when a client certificate needs to be validated. |
| TLSEstablished | Reports the setup of a TLS session. |
| TLSHandshake | Fires when a newly established client connection initiates a TLS handshake. |
| TLSPSK | Requests a pre-shared key for TLS-PSK. |
| TLSShutdown | Reports closure of a TLS session. |
| UserAuthCompleted | Notifies the application about the success of user authentication flow. |
| UserAuthFailed | Notifies the application about failure of user authentication flow. |
| UserAuthStart | Notifies the application about the start of user authentication flow. |
| UserLogoutCompleted | Notifies the application about the completion of user logout flow. |
| UserLogoutStart | Notifies the application about the start of user logout flow. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
| AllowOptionsResponseWithoutAuth | Enables unauthenticated responses to OPTIONS requests. |
| AttributeConsumingService | TBD. |
| AuthDigestExpire | Specifies digest expiration time for digest authentication. |
| BoundPort | The port that was bound by the server. |
| ContactPerson | The ContactPerson entry of the provider metadata. |
| DualStack | Allows the use of ip4 and ip6 simultaneously. |
| HandshakeTimeout | The HTTPS handshake timeout. |
| HomePage | Specifies the home page resource name. |
| IDPAQS | TBD. |
| IDPARS | TBD. |
| IDPSLS | TBD. |
| IDPSSO | TBD. |
| MaxIssueInstantTimeDiff | The maximum issue-instant time delta. |
| OAuthAllowAccessByDefault | Specifies whether access to a resource is allowed by default. |
| OAuthAutoValidateTokens | Allows to validate OAuth 2.0 access tokens automatically. |
| OAuthIntrospectionClientID | Specifies a client ID on the authentication service. |
| OAuthIntrospectionClientSecret | Specifies a client secret on the authentication service. |
| OAuthIntrospectionURL | Specifies the URL to be used to introspect access tokens. |
| OAuthTokenValidationKeys | Specifies JW keys in JSON format for validating access token signatures. |
| OrganizationDisplayName | The OrganizationDisplayName entry of the provider metadata. |
| OrganizationLang | The OrganizationLang key of the provider metadata. |
| OrganizationName | The OrganizationName element of the provider metadata. |
| OrganizationURL | The OrganizationURL element of the provider metadata. |
| PortRangeFrom | The lower bound of allowed port scope to listen on. |
| PortRangeTo | The higher bound of allowed port scope to listen on. |
| RequestFilter | The request string modifier. |
| SAMLAction | TBD. |
| SAMLBuffer | TBD. |
| SAMLResourceProtected | TBD. |
| SAMLResourceSpecial | TBD. |
| SAMLString | TBD. |
| SendBufferSize | The network send buffer size. |
| ServerName | Specifies the server name for the created responses. |
| SessionTimeout | The HTTP session timeout. |
| SessionTTL | The SAML session time-to-live value. |
| SignatureAlgorithm | TBD. |
| TempPath | Path for storing temporary files. |
| UseZeroIndexForDefaultServices | TBD. |
| WantAssertionsSigned | 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. |
Active Property (SAMLSPServer Component)
Tells whether the server is active and ready to process requests.
Syntax
func (obj *SAMLSPServer) Active() (bool, error)
Default Value
false
Remarks
This property indicates whether the IdP server is in an active state.
This property is read-only.
Data Type
bool
BaseDir Property (SAMLSPServer Component)
Base directory on the server.
Syntax
func (obj *SAMLSPServer) BaseDir() (string, error)
func (obj *SAMLSPServer) SetBaseDir(value string) error
Default Value
""
Remarks
Use this property to specify the base directory for the SP server.
Data Type
string
BindingKeyHandle Property (SAMLSPServer Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *SAMLSPServer) BindingKeyHandle() (int64, error)
func (obj *SAMLSPServer) 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
DecryptionCertBytes Property (SAMLSPServer Component)
Returns the raw certificate data in DER format.
Syntax
func (obj *SAMLSPServer) DecryptionCertBytes() ([]byte, error)
Remarks
Returns the raw certificate data in DER format.
This property is read-only.
Data Type
[]byte
DecryptionCertHandle Property (SAMLSPServer Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *SAMLSPServer) DecryptionCertHandle() (int64, error)
func (obj *SAMLSPServer) SetDecryptionCertHandle(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
ExternalCryptoAsyncDocumentID Property (SAMLSPServer Component)
Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
Syntax
func (obj *SAMLSPServer) ExternalCryptoAsyncDocumentID() (string, error)
func (obj *SAMLSPServer) SetExternalCryptoAsyncDocumentID(value string) error
Default Value
""
Remarks
Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.
If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.
Data Type
string
ExternalCryptoCustomParams Property (SAMLSPServer Component)
Custom parameters to be passed to the signing service (uninterpreted).
Syntax
func (obj *SAMLSPServer) ExternalCryptoCustomParams() (string, error)
func (obj *SAMLSPServer) SetExternalCryptoCustomParams(value string) error
Default Value
""
Remarks
Custom parameters to be passed to the signing service (uninterpreted).
Data Type
string
ExternalCryptoData Property (SAMLSPServer Component)
Additional data to be included in the async state and mirrored back by the requestor.
Syntax
func (obj *SAMLSPServer) ExternalCryptoData() (string, error)
func (obj *SAMLSPServer) SetExternalCryptoData(value string) error
Default Value
""
Remarks
Additional data to be included in the async state and mirrored back by the requestor.
Data Type
string
ExternalCryptoExternalHashCalculation Property (SAMLSPServer Component)
Specifies whether the message hash is to be calculated at the external endpoint.
Syntax
func (obj *SAMLSPServer) ExternalCryptoExternalHashCalculation() (bool, error)
func (obj *SAMLSPServer) SetExternalCryptoExternalHashCalculation(value bool) error
Default Value
false
Remarks
Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth struct.
If set to true, the struct will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.
Data Type
bool
ExternalCryptoHashAlgorithm Property (SAMLSPServer Component)
Specifies the request's signature hash algorithm.
Syntax
func (obj *SAMLSPServer) ExternalCryptoHashAlgorithm() (string, error)
func (obj *SAMLSPServer) SetExternalCryptoHashAlgorithm(value string) error
Default Value
"SHA256"
Remarks
Specifies the request's signature hash algorithm.
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
Data Type
string
ExternalCryptoKeyID Property (SAMLSPServer Component)
The ID of the pre-shared key used for DC request authentication.
Syntax
func (obj *SAMLSPServer) ExternalCryptoKeyID() (string, error)
func (obj *SAMLSPServer) SetExternalCryptoKeyID(value string) error
Default Value
""
Remarks
The ID of the pre-shared key used for DC request authentication.
Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.
The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.
Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.
Example:
signer.ExternalCrypto.KeyID = "MainSigningKey";
signer.ExternalCrypto.KeySecret = "abcdef0123456789";
Data Type
string
ExternalCryptoKeySecret Property (SAMLSPServer Component)
The pre-shared key used for DC request authentication.
Syntax
func (obj *SAMLSPServer) ExternalCryptoKeySecret() (string, error)
func (obj *SAMLSPServer) SetExternalCryptoKeySecret(value string) error
Default Value
""
Remarks
The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.
Read more about configuring authentication in the ExternalCryptoKeyID topic.
Data Type
string
ExternalCryptoMethod Property (SAMLSPServer Component)
Specifies the asynchronous signing method.
Syntax
func (obj *SAMLSPServer) ExternalCryptoMethod() (int32, error)
func (obj *SAMLSPServer) SetExternalCryptoMethod(value int32) error
Possible Values
0 // PKCS1
1 // PKCS7
Default Value
0
Remarks
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.
Available options:
| asmdPKCS1 | 0 |
| asmdPKCS7 | 1 |
Data Type
int32
ExternalCryptoMode Property (SAMLSPServer Component)
Specifies the external cryptography mode.
Syntax
func (obj *SAMLSPServer) ExternalCryptoMode() (int32, error)
func (obj *SAMLSPServer) SetExternalCryptoMode(value int32) error
Possible Values
0 // Default
1 // Disabled
2 // Generic
3 // DCAuth
4 // DCAuthJSON
Default Value
0
Remarks
Specifies the external cryptography mode.
Available options:
| ecmDefault | The default value (0) |
| ecmDisabled | Do not use DC or external signing (1) |
| ecmGeneric | Generic external signing with the OnExternalSign event (2) |
| ecmDCAuth | DCAuth signing (3) |
| ecmDCAuthJSON | DCAuth signing in JSON format (4) |
Data Type
int32
ExternalCryptoPublicKeyAlgorithm Property (SAMLSPServer Component)
Provide the public key algorithm here if the certificate is not available on the pre-signing stage.
Syntax
func (obj *SAMLSPServer) ExternalCryptoPublicKeyAlgorithm() (string, error)
func (obj *SAMLSPServer) SetExternalCryptoPublicKeyAlgorithm(value string) error
Default Value
""
Remarks
Provide the public key algorithm here if the certificate is not available on the pre-signing stage.
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | |
| SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | |
| SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | |
| SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | |
| SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | |
| SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | |
| SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | |
| SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | |
| SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | |
| SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 |
Data Type
string
FIPSMode Property (SAMLSPServer Component)
Reserved.
Syntax
func (obj *SAMLSPServer) FIPSMode() (bool, error)
func (obj *SAMLSPServer) SetFIPSMode(value bool) error
Default Value
false
Remarks
This property is reserved for future use.
Data Type
bool
HandshakeTimeout Property (SAMLSPServer Component)
Specifies the handshake timeout in milliseconds.
Syntax
func (obj *SAMLSPServer) HandshakeTimeout() (int32, error)
func (obj *SAMLSPServer) SetHandshakeTimeout(value int32) error
Default Value
20000
Remarks
Use this property to set the TLS handshake timeout.
Data Type
int32
Host Property (SAMLSPServer Component)
Specifies the host address of the SP server.
Syntax
func (obj *SAMLSPServer) Host() (string, error)
func (obj *SAMLSPServer) SetHost(value string) error
Default Value
""
Remarks
Use this property to specify the IP address on which to listen to incoming connections. To specify the listening port number, use Port.
Data Type
string
IdPServiceCount Property (SAMLSPServer Component)
The number of records in the IdPService arrays.
Syntax
func (obj *SAMLSPServer) IdPServiceCount() (int32, error)
Default Value
0
Remarks
This property controls the size of the following arrays:
- IdPServiceBindingType
- IdPServiceEntityID
- IdPServiceLocation
- IdPServicePriority
- IdPServiceService
- IdPServiceServiceIndex
This property is read-only.
Data Type
int32
IdPServiceBindingType Property (SAMLSPServer Component)
Specifies the type of SAML binding that this endpoint accepts.
Syntax
func (obj *SAMLSPServer) IdPServiceBindingType(IdPServiceIndex int32) (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 that this endpoint accepts.
Use this property to specify the binding type to use with this endpoint.
The IdPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.
This property is read-only.
Data Type
int32
IdPServiceEntityID Property (SAMLSPServer Component)
Represents the SAML entity ID.
Syntax
func (obj *SAMLSPServer) IdPServiceEntityID(IdPServiceIndex int32) (string, error)
Default Value
""
Remarks
Represents the SAML entity ID.
Use this property to read or set the unique SAML entity ID. This is often the URI of the web endpoint (such as https://sp.myserver.com).
The IdPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.
This property is read-only.
Data Type
string
IdPServiceLocation Property (SAMLSPServer Component)
The location (URL) of the endpoint.
Syntax
func (obj *SAMLSPServer) IdPServiceLocation(IdPServiceIndex int32) (string, error)
Default Value
""
Remarks
The location (URL) of the endpoint.
The IdPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.
This property is read-only.
Data Type
string
IdPServicePriority Property (SAMLSPServer Component)
The priority of the endpoint in relation to other endpoints with the same Location .
Syntax
func (obj *SAMLSPServer) IdPServicePriority(IdPServiceIndex int32) (int32, error)
Default Value
-1
Remarks
The priority of the endpoint in relation to other endpoints with the same IdPLocation.
Indicates the relative priority of the endpoint. Use this setting to adjust priority of certain binding types before others. When composing the metadata XML, the endpoint with the highest priority gets described with a Default attribute.
Leave all priorities at -1 to omit generation of the Default attribute.
The IdPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.
This property is read-only.
Data Type
int32
IdPServiceService Property (SAMLSPServer Component)
The kind of the service being provided at this endpoint.
Syntax
func (obj *SAMLSPServer) IdPServiceService(IdPServiceIndex int32) (int32, error)
Default Value
0
Remarks
The kind of the service being provided at this endpoint.
The Service setting returns the kind of the service that is being provided at this endpoint. Typical SP services are AssertionConsumerService and ArtifactResolutionService. Typical IdP services are SingleSignOnService, SingleLogoutService, and ArtifactResolutionService.
The IdPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.
This property is read-only.
Data Type
int32
IdPServiceServiceIndex Property (SAMLSPServer Component)
The index of this endpoint.
Syntax
func (obj *SAMLSPServer) IdPServiceServiceIndex(IdPServiceIndex int32) (int32, error)
Default Value
0
Remarks
The index of this endpoint.
For endpoints that can accept requests via multiple bindings, Index is used to distinguish between individual endpoint specifiers.
The IdPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.
This property is read-only.
Data Type
int32
IdPContactPerson Property (SAMLSPServer Component)
The contact person or persons for the entity.
Syntax
func (obj *SAMLSPServer) IdPContactPerson() (string, error)
func (obj *SAMLSPServer) SetIdPContactPerson(value string) error
Default Value
""
Remarks
The contact person or persons for the entity.
SAML assumes that more than one contact person can be specified. Each line of this potentially multi-line property contains one such record.
Each record contains a semicolon-separated list of contact person parameters, for example:
Company=My Company;EmailAddress=info@company.com;TelephoneNumber=+012345678;Type=other Company=My Company;EmailAddress=info@company.com;TelephoneNumber=+012345678;Type=technical;Extension.https://spid.gov.it/saml-extensions.VATNumber=IT122345678
You can use LoadNameValuePairs and SaveNameValuePairs methods of the Utils class to process content of this property.
Data Type
string
IdPEncryptionKey Property (SAMLSPServer Component)
Contains the entity's encryption key.
Syntax
func (obj *SAMLSPServer) IdPEncryptionKey() (string, error)
func (obj *SAMLSPServer) SetIdPEncryptionKey(value string) error
Default Value
""
Remarks
Contains the entity's encryption key.
This setting returns the entity's public encryption key. In most cases this is in the form of a DER-encoded X.509 certificate. This property cannot be set in code; it is either taken from the processed metadata file (for other-party settings), or derived from the locally set EncryptionCertificate setting (for this-party settings).
Requests sent to the endpoint can be encrypted with the provided key or certificate.
Data Type
string
IdPEncryptionMethods Property (SAMLSPServer Component)
Specifies the list of encryption methods supported by the entity.
Syntax
func (obj *SAMLSPServer) IdPEncryptionMethods() (string, error)
func (obj *SAMLSPServer) SetIdPEncryptionMethods(value string) error
Default Value
""
Remarks
Specifies the list of encryption methods supported by the entity.
This setting contains a list of encryption methods, in form of XML-ENC URLs separated with newline characters, supported by the entity. These can be considered when encrypting messages destined for this entity.
Examples of algorithms supported by this property:
- http://www.w3.org/2009/xmlenc11#aes128-gcm
- http://www.w3.org/2001/04/xmlenc#aes256-cbc
Data Type
string
IdPEntityID Property (SAMLSPServer Component)
Represents the SAML entity ID.
Syntax
func (obj *SAMLSPServer) IdPEntityID() (string, error)
func (obj *SAMLSPServer) SetIdPEntityID(value string) error
Default Value
""
Remarks
Represents the SAML entity ID.
Use this property to read or set the unique SAML entity ID. This is often the URI of the web endpoint (such as https://sp.myserver.com).
Data Type
string
IdPFlags Property (SAMLSPServer Component)
Adjusts secondary entity properties.
Syntax
func (obj *SAMLSPServer) IdPFlags() (int32, error)
func (obj *SAMLSPServer) SetIdPFlags(value int32) error
Default Value
0
Remarks
Adjusts secondary entity properties.
Use this bit mask property to adjust certain secondary settings. The following flags are supported:
- 1 - sefRequireSignedRequests - the provider expects the consumers to sign requests they send in.
Data Type
int32
IdPSSOLink Property (SAMLSPServer Component)
Contains a local server page link that triggers SAML authentication to the SP.
Syntax
func (obj *SAMLSPServer) IdPSSOLink() (string, error)
func (obj *SAMLSPServer) SetIdPSSOLink(value string) error
Default Value
""
Remarks
Contains a local server page link that triggers SAML authentication to the SP.
This property specifies the web link that initiates the transfer of SAML authentication fact to the SP.
One scenario where this property can be used is triggering the assertion dispatch in IdP-initiated SSO flows. Navigating to the link will make the IdP server generate the authentication assertion (if the user had been authenticated) and forward this assertion to the respective service provider.
Data Type
string
IdPNameIDFormats Property (SAMLSPServer Component)
The list of NameID formats supported by this entity.
Syntax
func (obj *SAMLSPServer) IdPNameIDFormats() (string, error)
func (obj *SAMLSPServer) SetIdPNameIDFormats(value string) error
Default Value
""
Remarks
The list of NameID formats supported by this entity.
Use this setting to get or set the list of NameID formats supported by the entity.
Use SAML notation for the formats:
- urn:oasis:names:tc:SAML:2.0:nameid-format:transient
- urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
- urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
Data Type
string
IdPOrganizationDisplayName Property (SAMLSPServer Component)
The friendly name of the organization that maintains the entity.
Syntax
func (obj *SAMLSPServer) IdPOrganizationDisplayName() (string, error)
func (obj *SAMLSPServer) SetIdPOrganizationDisplayName(value string) error
Default Value
""
Remarks
The friendly name of the organization that maintains the entity.
Use this setting to get or set the user-friendly name of the organization that maintains the SAML entity.
Data Type
string
IdPOrganizationLang Property (SAMLSPServer Component)
The language preferred by the organization.
Syntax
func (obj *SAMLSPServer) IdPOrganizationLang() (string, error)
func (obj *SAMLSPServer) SetIdPOrganizationLang(value string) error
Default Value
""
Remarks
The language preferred by the organization.
This optional setting can be used to adjust the preferred language of the owning organization.
Data Type
string
IdPOrganizationName Property (SAMLSPServer Component)
The name of the organization that maintains the entity.
Syntax
func (obj *SAMLSPServer) IdPOrganizationName() (string, error)
func (obj *SAMLSPServer) SetIdPOrganizationName(value string) error
Default Value
""
Remarks
The name of the organization that maintains the entity.
Use this setting to get or set the name of the organization that maintains the SAML entity.
Data Type
string
IdPOrganizationURL Property (SAMLSPServer Component)
The web URL of the organization that maintains the entity.
Syntax
func (obj *SAMLSPServer) IdPOrganizationURL() (string, error)
func (obj *SAMLSPServer) SetIdPOrganizationURL(value string) error
Default Value
""
Remarks
The web URL of the organization that maintains the entity.
Use this setting to get or set the web address of the organization responsible for this SAML entity.
Data Type
string
IdPSignatureValidationResult Property (SAMLSPServer Component)
The outcome of the cryptographic signature validation.
Syntax
func (obj *SAMLSPServer) IdPSignatureValidationResult() (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
IdPSigned Property (SAMLSPServer Component)
Specifies whether the SAML entity information is or should be signed.
Syntax
func (obj *SAMLSPServer) IdPSigned() (bool, error)
Default Value
false
Remarks
Specifies whether the SAML entity information is or should be signed.
Check this property to find out whether the metadata was signed by the sender, or set this property to true to indicate that the created metadata should be signed.
This property is read-only.
Data Type
bool
IdPSignedWith Property (SAMLSPServer Component)
Contains the certificate or key that was used to sign the settings (metadata) document.
Syntax
func (obj *SAMLSPServer) IdPSignedWith() (string, error)
Default Value
""
Remarks
Contains the certificate or key that was used to sign the settings (metadata) document.
This setting returns the public part of the metadata signing key. In most cases this is in the form of a DER-encoded X.509 certificate.
The value of this property is retrieved from the metadata file when it is loaded with the ImportSettings call. If the metadata is signed, you can check the integrity of the signature using the IdPSignatureValidationResult setting.
This property is read-only.
Data Type
string
IdPSigningKey Property (SAMLSPServer Component)
Contains the entity's signing key.
Syntax
func (obj *SAMLSPServer) IdPSigningKey() (string, error)
func (obj *SAMLSPServer) SetIdPSigningKey(value string) error
Default Value
""
Remarks
Contains the entity's signing key.
This setting returns the public part of the entity's signing key. In most cases this is in the form of a PKCS#1 RSA or ECDSA key.
The signing key is used to sign message conveyed over Redirect binding. Redirect signatures are simpler than SAML message signatures and are made with raw keys rather than certificates.
Data Type
string
IdPValidUntil Property (SAMLSPServer Component)
Specifies the expiration time of the SAML entity information.
Syntax
func (obj *SAMLSPServer) IdPValidUntil() (string, error)
func (obj *SAMLSPServer) SetIdPValidUntil(value string) error
Default Value
""
Remarks
Specifies the expiration time of the SAML entity information.
This setting only makes sense when the information was loaded or is going to be saved to a metadata XML.
Data Type
string
Issuer Property (SAMLSPServer Component)
Name identifier of the issuer of the SP's requests.
Syntax
func (obj *SAMLSPServer) Issuer() (string, error)
func (obj *SAMLSPServer) SetIssuer(value string) error
Default Value
""
Remarks
Use this property to set the name identifier of this Service Provider (SP) to be used in its requests.
Data Type
string
KnownCertCount Property (SAMLSPServer Component)
The number of records in the KnownCert arrays.
Syntax
func (obj *SAMLSPServer) KnownCertCount() (int32, error)
func (obj *SAMLSPServer) SetKnownCertCount(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 KnownCertCount - 1.Data Type
int32
KnownCertBytes Property (SAMLSPServer Component)
Returns the raw certificate data in DER format.
Syntax
func (obj *SAMLSPServer) KnownCertBytes(KnownCertIndex int32) ([]byte, error)
Remarks
Returns the raw certificate data in DER format.
The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.
This property is read-only.
Data Type
[]byte
KnownCertHandle Property (SAMLSPServer Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *SAMLSPServer) KnownCertHandle(KnownCertIndex int32) (int64, error)
func (obj *SAMLSPServer) SetKnownCertHandle(KnownCertIndex 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 KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.
Data Type
int64
KnownKeyCount Property (SAMLSPServer Component)
The number of records in the KnownKey arrays.
Syntax
func (obj *SAMLSPServer) KnownKeyCount() (int32, error)
func (obj *SAMLSPServer) SetKnownKeyCount(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 KnownKeyCount - 1.Data Type
int32
KnownKeyHandle Property (SAMLSPServer Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *SAMLSPServer) KnownKeyHandle(KnownKeyIndex int32) (int64, error)
func (obj *SAMLSPServer) SetKnownKeyHandle(KnownKeyIndex 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 KnownKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownKeyCount property.
Data Type
int64
LogoutPage Property (SAMLSPServer Component)
Specifies the location of the logout page.
Syntax
func (obj *SAMLSPServer) LogoutPage() (string, error)
func (obj *SAMLSPServer) SetLogoutPage(value string) error
Default Value
"/sp/logout"
Remarks
Use this property to specify the relative URL of the logout page.
Data Type
string
MetadataURL Property (SAMLSPServer Component)
The SP's metadata location.
Syntax
func (obj *SAMLSPServer) MetadataURL() (string, error)
func (obj *SAMLSPServer) SetMetadataURL(value string) error
Default Value
"/sp/metadata"
Remarks
This property specifies the metadata URL of this Service Provider (SP).
Data Type
string
MetaSigningCertBytes Property (SAMLSPServer Component)
Returns the raw certificate data in DER format.
Syntax
func (obj *SAMLSPServer) MetaSigningCertBytes() ([]byte, error)
Remarks
Returns the raw certificate data in DER format.
This property is read-only.
Data Type
[]byte
MetaSigningCertHandle Property (SAMLSPServer Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *SAMLSPServer) MetaSigningCertHandle() (int64, error)
func (obj *SAMLSPServer) SetMetaSigningCertHandle(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
OfflineMode Property (SAMLSPServer Component)
Enables the Offline mode.
Syntax
func (obj *SAMLSPServer) OfflineMode() (bool, error)
func (obj *SAMLSPServer) SetOfflineMode(value bool) error
Default Value
true
Remarks
In the Offline mode the server does not open the listening port. Instead, it expects all incoming requests to be relayed by the application via calls to ProcessAssertion, ProcessLogoutRequest ProcessArtifactResolveRequest, and other similar methods.
The Offline mode is a handy mechanism for attaching the server to external web engines, such as IIS or Tomcat. It lets you leave the HTTP matters to the engine, and only be responsible for handling the actual SAML traffic.
Data Type
bool
PinnedClientAEADCipher Property (SAMLSPServer Component)
Indicates whether the encryption algorithm used is an AEAD cipher.
Syntax
func (obj *SAMLSPServer) PinnedClientAEADCipher() (bool, error)
Default Value
false
Remarks
Indicates whether the encryption algorithm used is an AEAD cipher.
This property is read-only.
Data Type
bool
PinnedClientChainValidationDetails Property (SAMLSPServer Component)
The details of a certificate chain validation outcome.
Syntax
func (obj *SAMLSPServer) PinnedClientChainValidationDetails() (int32, error)
Default Value
0
Remarks
The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
This property is read-only.
Data Type
int32
PinnedClientChainValidationResult Property (SAMLSPServer Component)
The outcome of a certificate chain validation routine.
Syntax
func (obj *SAMLSPServer) PinnedClientChainValidationResult() (int32, error)
Possible Values
0 // Valid
1 // ValidButUntrusted
2 // Invalid
3 // CantBeEstablished
Default Value
0
Remarks
The outcome of a certificate chain validation routine.
Available options:
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
This property is read-only.
Data Type
int32
PinnedClientCiphersuite Property (SAMLSPServer Component)
The cipher suite employed by this connection.
Syntax
func (obj *SAMLSPServer) PinnedClientCiphersuite() (string, error)
Default Value
""
Remarks
The cipher suite employed by this connection.
For TLS connections, this property returns the ciphersuite that was/is employed by the connection.
This property is read-only.
Data Type
string
PinnedClientClientAuthenticated Property (SAMLSPServer Component)
Specifies whether client authentication was performed during this connection.
Syntax
func (obj *SAMLSPServer) PinnedClientClientAuthenticated() (bool, error)
Default Value
false
Remarks
Specifies whether client authentication was performed during this connection.
This property is read-only.
Data Type
bool
PinnedClientClientAuthRequested Property (SAMLSPServer Component)
Specifies whether client authentication was requested during this connection.
Syntax
func (obj *SAMLSPServer) PinnedClientClientAuthRequested() (bool, error)
Default Value
false
Remarks
Specifies whether client authentication was requested during this connection.
This property is read-only.
Data Type
bool
PinnedClientConnectionEstablished Property (SAMLSPServer Component)
Indicates whether the connection has been established fully.
Syntax
func (obj *SAMLSPServer) PinnedClientConnectionEstablished() (bool, error)
Default Value
false
Remarks
Indicates whether the connection has been established fully.
This property is read-only.
Data Type
bool
PinnedClientConnectionID Property (SAMLSPServer Component)
The unique identifier assigned to this connection.
Syntax
func (obj *SAMLSPServer) PinnedClientConnectionID() ([]byte, error)
Remarks
The unique identifier assigned to this connection.
This property is read-only.
Data Type
[]byte
PinnedClientDigestAlgorithm Property (SAMLSPServer Component)
The digest algorithm used in a TLS-enabled connection.
Syntax
func (obj *SAMLSPServer) PinnedClientDigestAlgorithm() (string, error)
Default Value
""
Remarks
The digest algorithm used in a TLS-enabled connection.
This property is read-only.
Data Type
string
PinnedClientEncryptionAlgorithm Property (SAMLSPServer Component)
The symmetric encryption algorithm used in a TLS-enabled connection.
Syntax
func (obj *SAMLSPServer) PinnedClientEncryptionAlgorithm() (string, error)
Default Value
""
Remarks
The symmetric encryption algorithm used in a TLS-enabled connection.
This property is read-only.
Data Type
string
PinnedClientExportable Property (SAMLSPServer Component)
Indicates whether a TLS connection uses a reduced-strength exportable cipher.
Syntax
func (obj *SAMLSPServer) PinnedClientExportable() (bool, error)
Default Value
false
Remarks
Indicates whether a TLS connection uses a reduced-strength exportable cipher.
This property is read-only.
Data Type
bool
PinnedClientGroup Property (SAMLSPServer Component)
The elliptic curve used in this connection.
Syntax
func (obj *SAMLSPServer) PinnedClientGroup() (string, error)
Default Value
""
Remarks
The elliptic curve used in this connection.
This property was named NamedECCurve in SecureBlackbox 2024 and earlier versions.
This property is read-only.
Data Type
string
PinnedClientID Property (SAMLSPServer Component)
The client connection's unique identifier.
Syntax
func (obj *SAMLSPServer) PinnedClientID() (int64, error)
Default Value
-1
Remarks
The client connection's unique identifier. This value is used throughout to refer to a particular client connection.
This property is read-only.
Data Type
int64
PinnedClientKeyExchangeAlgorithm Property (SAMLSPServer Component)
The key exchange algorithm used in a TLS-enabled connection.
Syntax
func (obj *SAMLSPServer) PinnedClientKeyExchangeAlgorithm() (string, error)
Default Value
""
Remarks
The key exchange algorithm used in a TLS-enabled connection.
This property is read-only.
Data Type
string
PinnedClientKeyExchangeKeyBits Property (SAMLSPServer Component)
The length of the key exchange key of a TLS-enabled connection.
Syntax
func (obj *SAMLSPServer) PinnedClientKeyExchangeKeyBits() (int32, error)
Default Value
0
Remarks
The length of the key exchange key of a TLS-enabled connection.
This property is read-only.
Data Type
int32
PinnedClientPFSCipher Property (SAMLSPServer Component)
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
Syntax
func (obj *SAMLSPServer) PinnedClientPFSCipher() (bool, error)
Default Value
false
Remarks
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
This property is read-only.
Data Type
bool
PinnedClientPreSharedIdentity Property (SAMLSPServer Component)
Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Syntax
func (obj *SAMLSPServer) PinnedClientPreSharedIdentity() (string, error)
Default Value
""
Remarks
Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
This property is read-only.
Data Type
string
PinnedClientPreSharedIdentityHint Property (SAMLSPServer Component)
A hint professed by the server to help the client select the PSK identity to use.
Syntax
func (obj *SAMLSPServer) PinnedClientPreSharedIdentityHint() (string, error)
Default Value
""
Remarks
A hint professed by the server to help the client select the PSK identity to use.
This property is read-only.
Data Type
string
PinnedClientPublicKeyBits Property (SAMLSPServer Component)
The length of the public key.
Syntax
func (obj *SAMLSPServer) PinnedClientPublicKeyBits() (int32, error)
Default Value
0
Remarks
The length of the public key.
This property is read-only.
Data Type
int32
PinnedClientRemoteAddress Property (SAMLSPServer Component)
The client's IP address.
Syntax
func (obj *SAMLSPServer) PinnedClientRemoteAddress() (string, error)
Default Value
""
Remarks
The client's IP address.
This property is read-only.
Data Type
string
PinnedClientRemotePort Property (SAMLSPServer Component)
The remote port of the client connection.
Syntax
func (obj *SAMLSPServer) PinnedClientRemotePort() (int32, error)
Default Value
0
Remarks
The remote port of the client connection.
This property is read-only.
Data Type
int32
PinnedClientResumedSession Property (SAMLSPServer Component)
Indicates whether a TLS-enabled connection was spawned from another TLS connection.
Syntax
func (obj *SAMLSPServer) PinnedClientResumedSession() (bool, error)
Default Value
false
Remarks
Indicates whether a TLS-enabled connection was spawned from another TLS connection
This property is read-only.
Data Type
bool
PinnedClientSecureConnection Property (SAMLSPServer Component)
Indicates whether TLS or SSL is enabled for this connection.
Syntax
func (obj *SAMLSPServer) PinnedClientSecureConnection() (bool, error)
Default Value
false
Remarks
Indicates whether TLS or SSL is enabled for this connection.
This property is read-only.
Data Type
bool
PinnedClientServerAuthenticated Property (SAMLSPServer Component)
Indicates whether server authentication was performed during a TLS-enabled connection.
Syntax
func (obj *SAMLSPServer) PinnedClientServerAuthenticated() (bool, error)
Default Value
false
Remarks
Indicates whether server authentication was performed during a TLS-enabled connection.
This property is read-only.
Data Type
bool
PinnedClientSignatureAlgorithm Property (SAMLSPServer Component)
The signature algorithm used in a TLS handshake.
Syntax
func (obj *SAMLSPServer) PinnedClientSignatureAlgorithm() (string, error)
Default Value
""
Remarks
The signature algorithm used in a TLS handshake.
This property is read-only.
Data Type
string
PinnedClientSymmetricBlockSize Property (SAMLSPServer Component)
The block size of the symmetric algorithm used.
Syntax
func (obj *SAMLSPServer) PinnedClientSymmetricBlockSize() (int32, error)
Default Value
0
Remarks
The block size of the symmetric algorithm used.
This property is read-only.
Data Type
int32
PinnedClientSymmetricKeyBits Property (SAMLSPServer Component)
The key length of the symmetric algorithm used.
Syntax
func (obj *SAMLSPServer) PinnedClientSymmetricKeyBits() (int32, error)
Default Value
0
Remarks
The key length of the symmetric algorithm used.
This property is read-only.
Data Type
int32
PinnedClientTotalBytesReceived Property (SAMLSPServer Component)
The total number of bytes received over this connection.
Syntax
func (obj *SAMLSPServer) PinnedClientTotalBytesReceived() (int64, error)
Default Value
0
Remarks
The total number of bytes received over this connection.
This property is read-only.
Data Type
int64
PinnedClientTotalBytesSent Property (SAMLSPServer Component)
The total number of bytes sent over this connection.
Syntax
func (obj *SAMLSPServer) PinnedClientTotalBytesSent() (int64, error)
Default Value
0
Remarks
The total number of bytes sent over this connection.
This property is read-only.
Data Type
int64
PinnedClientValidationLog Property (SAMLSPServer Component)
Contains the server certificate's chain validation log.
Syntax
func (obj *SAMLSPServer) PinnedClientValidationLog() (string, error)
Default Value
""
Remarks
Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.
This property is read-only.
Data Type
string
PinnedClientVersion Property (SAMLSPServer Component)
Indicates the version of SSL/TLS protocol negotiated during this connection.
Syntax
func (obj *SAMLSPServer) PinnedClientVersion() (string, error)
Default Value
""
Remarks
Indicates the version of SSL/TLS protocol negotiated during this connection.
This property is read-only.
Data Type
string
PinnedClientCertCount Property (SAMLSPServer Component)
The number of records in the PinnedClientCert arrays.
Syntax
func (obj *SAMLSPServer) PinnedClientCertCount() (int32, error)
Default Value
0
Remarks
This property controls the size of the following arrays:
- PinnedClientCertBytes
- PinnedClientCertCAKeyID
- PinnedClientCertFingerprint
- PinnedClientCertHandle
- PinnedClientCertIssuer
- PinnedClientCertIssuerRDN
- PinnedClientCertKeyAlgorithm
- PinnedClientCertKeyBits
- PinnedClientCertKeyFingerprint
- PinnedClientCertKeyUsage
- PinnedClientCertPublicKeyBytes
- PinnedClientCertSelfSigned
- PinnedClientCertSerialNumber
- PinnedClientCertSigAlgorithm
- PinnedClientCertSubject
- PinnedClientCertSubjectKeyID
- PinnedClientCertSubjectRDN
- PinnedClientCertValidFrom
- PinnedClientCertValidTo
This property is read-only.
Data Type
int32
PinnedClientCertBytes Property (SAMLSPServer Component)
Returns the raw certificate data in DER format.
Syntax
func (obj *SAMLSPServer) PinnedClientCertBytes(PinnedClientCertIndex int32) ([]byte, error)
Remarks
Returns the raw certificate data in DER format.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
[]byte
PinnedClientCertCAKeyID Property (SAMLSPServer Component)
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
Syntax
func (obj *SAMLSPServer) PinnedClientCertCAKeyID(PinnedClientCertIndex int32) ([]byte, error)
Remarks
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.
This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the PinnedClientCertSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
[]byte
PinnedClientCertFingerprint Property (SAMLSPServer Component)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
func (obj *SAMLSPServer) PinnedClientCertFingerprint(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertHandle Property (SAMLSPServer Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *SAMLSPServer) PinnedClientCertHandle(PinnedClientCertIndex int32) (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 PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
int64
PinnedClientCertIssuer Property (SAMLSPServer Component)
The common name of the certificate issuer (CA), typically a company name.
Syntax
func (obj *SAMLSPServer) PinnedClientCertIssuer(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via PinnedClientCertIssuerRDN.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertIssuerRDN Property (SAMLSPServer Component)
A list of Property=Value pairs that uniquely identify the certificate issuer.
Syntax
func (obj *SAMLSPServer) PinnedClientCertIssuerRDN(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
A list of Property=Value pairs that uniquely identify the certificate issuer.
Example: /C=US/O=Nationwide CA/CN=Web Certification Authority
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertKeyAlgorithm Property (SAMLSPServer Component)
Specifies the public key algorithm of this certificate.
Syntax
func (obj *SAMLSPServer) PinnedClientCertKeyAlgorithm(PinnedClientCertIndex int32) (string, error)
Default Value
"0"
Remarks
Specifies the public key algorithm of this certificate.
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | |
| SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | |
| SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | |
| SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | |
| SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | |
| SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | |
| SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | |
| SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | |
| SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | |
| SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 |
Use the PinnedClientCertKeyBits, PinnedClientCertCurve, and PinnedClientCertPublicKeyBytes properties to get more details about the key the certificate contains.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertKeyBits Property (SAMLSPServer Component)
Returns the length of the public key in bits.
Syntax
func (obj *SAMLSPServer) PinnedClientCertKeyBits(PinnedClientCertIndex int32) (int32, error)
Default Value
0
Remarks
Returns the length of the public key in bits.
This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the PinnedClientCertPublicKeyBytes or PinnedClientCertPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
int32
PinnedClientCertKeyFingerprint Property (SAMLSPServer Component)
Returns a SHA1 fingerprint of the public key contained in the certificate.
Syntax
func (obj *SAMLSPServer) PinnedClientCertKeyFingerprint(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
Returns a SHA1 fingerprint of the public key contained in the certificate.
Note that the key fingerprint is different from the certificate fingerprint accessible via the PinnedClientCertFingerprint property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertKeyUsage Property (SAMLSPServer Component)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
func (obj *SAMLSPServer) PinnedClientCertKeyUsage(PinnedClientCertIndex int32) (int32, error)
Default Value
0
Remarks
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
Set this property before generating the certificate to propagate the key usage flags to the new certificate.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
int32
PinnedClientCertPublicKeyBytes Property (SAMLSPServer Component)
Contains the certificate's public key in DER format.
Syntax
func (obj *SAMLSPServer) PinnedClientCertPublicKeyBytes(PinnedClientCertIndex int32) ([]byte, error)
Remarks
Contains the certificate's public key in DER format.
This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
[]byte
PinnedClientCertSelfSigned Property (SAMLSPServer Component)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
func (obj *SAMLSPServer) PinnedClientCertSelfSigned(PinnedClientCertIndex int32) (bool, error)
Default Value
false
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
bool
PinnedClientCertSerialNumber Property (SAMLSPServer Component)
Returns the certificate's serial number.
Syntax
func (obj *SAMLSPServer) PinnedClientCertSerialNumber(PinnedClientCertIndex int32) ([]byte, error)
Remarks
Returns the certificate's serial number.
The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
[]byte
PinnedClientCertSigAlgorithm Property (SAMLSPServer Component)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
func (obj *SAMLSPServer) PinnedClientCertSigAlgorithm(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertSubject Property (SAMLSPServer Component)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
func (obj *SAMLSPServer) PinnedClientCertSubject(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via PinnedClientCertSubjectRDN.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertSubjectKeyID Property (SAMLSPServer Component)
Contains a unique identifier of the certificate's cryptographic key.
Syntax
func (obj *SAMLSPServer) PinnedClientCertSubjectKeyID(PinnedClientCertIndex int32) ([]byte, error)
Remarks
Contains a unique identifier of the certificate's cryptographic key.
Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.
The PinnedClientCertSubjectKeyID and PinnedClientCertCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
[]byte
PinnedClientCertSubjectRDN Property (SAMLSPServer Component)
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Syntax
func (obj *SAMLSPServer) PinnedClientCertSubjectRDN(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.
Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertValidFrom Property (SAMLSPServer Component)
The time point at which the certificate becomes valid, in UTC.
Syntax
func (obj *SAMLSPServer) PinnedClientCertValidFrom(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertValidTo Property (SAMLSPServer Component)
The time point at which the certificate expires, in UTC.
Syntax
func (obj *SAMLSPServer) PinnedClientCertValidTo(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
Port Property (SAMLSPServer Component)
Specifies the listening port number.
Syntax
func (obj *SAMLSPServer) Port() (int32, error)
func (obj *SAMLSPServer) SetPort(value int32) error
Default Value
80
Remarks
Use this property to specify the port number on which the SP server should listen for incoming connections. To specify the server's IP address use Host.
Data Type
int32
ProtectedResources Property (SAMLSPServer Component)
Specifies the list of protected resources.
Syntax
func (obj *SAMLSPServer) ProtectedResources() (string, error)
func (obj *SAMLSPServer) SetProtectedResources(value string) error
Default Value
""
Remarks
This property contains a set of relative URLs of the protected resources offered by this Service Provider (SP).
Data Type
string
RedirectOnLogoutPage Property (SAMLSPServer Component)
Specifies the location to redirect the user on logout.
Syntax
func (obj *SAMLSPServer) RedirectOnLogoutPage() (string, error)
func (obj *SAMLSPServer) SetRedirectOnLogoutPage(value string) error
Default Value
"https://nsoftware.com"
Remarks
Use this property to specify the page where to redirect the user on logout.
Data Type
string
SecurityCanonicalizationMethod Property (SAMLSPServer Component)
The canonicalization method to use in the signature.
Syntax
func (obj *SAMLSPServer) SecurityCanonicalizationMethod() (string, error)
func (obj *SAMLSPServer) 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 (SAMLSPServer Component)
The digest method to use.
Syntax
func (obj *SAMLSPServer) SecurityDigestMethod() (string, error)
func (obj *SAMLSPServer) 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 (SAMLSPServer Component)
The encryption method used to encrypt the assertion.
Syntax
func (obj *SAMLSPServer) SecurityEncryptionMethod() (string, error)
func (obj *SAMLSPServer) 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 (SAMLSPServer Component)
Provides access to secondary security parameters and tweaks.
Syntax
func (obj *SAMLSPServer) SecurityFlags() (int32, error)
func (obj *SAMLSPServer) 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 (SAMLSPServer Component)
The signature method to use.
Syntax
func (obj *SAMLSPServer) SecuritySigMethod() (string, error)
func (obj *SAMLSPServer) 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 (SAMLSPServer Component)
Specifies the signature validation policy.
Syntax
func (obj *SAMLSPServer) SecuritySignaturePolicy() (int32, error)
func (obj *SAMLSPServer) 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
SenderCertCount Property (SAMLSPServer Component)
The number of records in the SenderChain arrays.
Syntax
func (obj *SAMLSPServer) SenderCertCount() (int32, error)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at SenderCertCount - 1.This property is read-only.
Data Type
int32
SenderChainBytes Property (SAMLSPServer Component)
Returns the raw certificate data in DER format.
Syntax
func (obj *SAMLSPServer) SenderChainBytes(SenderCertIndex int32) ([]byte, error)
Remarks
Returns the raw certificate data in DER format.
The SenderCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SenderCertCount property.
This property is read-only.
Data Type
[]byte
SenderChainHandle Property (SAMLSPServer Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *SAMLSPServer) SenderChainHandle(SenderCertIndex int32) (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 SenderCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SenderCertCount property.
This property is read-only.
Data Type
int64
SigningCertBytes Property (SAMLSPServer Component)
Returns the raw certificate data in DER format.
Syntax
func (obj *SAMLSPServer) SigningCertBytes() ([]byte, error)
Remarks
Returns the raw certificate data in DER format.
This property is read-only.
Data Type
[]byte
SigningCertHandle Property (SAMLSPServer Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *SAMLSPServer) SigningCertHandle() (int64, error)
func (obj *SAMLSPServer) 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 (SAMLSPServer Component)
The number of records in the SigningChain arrays.
Syntax
func (obj *SAMLSPServer) SigningChainCount() (int32, error)
func (obj *SAMLSPServer) 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 (SAMLSPServer Component)
Returns the raw certificate data in DER format.
Syntax
func (obj *SAMLSPServer) 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 (SAMLSPServer Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *SAMLSPServer) SigningChainHandle(SigningChainIndex int32) (int64, error)
func (obj *SAMLSPServer) 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
SocketIncomingSpeedLimit Property (SAMLSPServer Component)
The maximum number of bytes to read from the socket, per second.
Syntax
func (obj *SAMLSPServer) SocketIncomingSpeedLimit() (int32, error)
func (obj *SAMLSPServer) SetSocketIncomingSpeedLimit(value int32) error
Default Value
0
Remarks
The maximum number of bytes to read from the socket, per second.
Data Type
int32
SocketLocalAddress Property (SAMLSPServer Component)
The local network interface to bind the socket to.
Syntax
func (obj *SAMLSPServer) SocketLocalAddress() (string, error)
func (obj *SAMLSPServer) SetSocketLocalAddress(value string) error
Default Value
""
Remarks
The local network interface to bind the socket to.
Data Type
string
SocketLocalPort Property (SAMLSPServer Component)
The local port number to bind the socket to.
Syntax
func (obj *SAMLSPServer) SocketLocalPort() (int32, error)
func (obj *SAMLSPServer) SetSocketLocalPort(value int32) error
Default Value
0
Remarks
The local port number to bind the socket to.
Data Type
int32
SocketOutgoingSpeedLimit Property (SAMLSPServer Component)
The maximum number of bytes to write to the socket, per second.
Syntax
func (obj *SAMLSPServer) SocketOutgoingSpeedLimit() (int32, error)
func (obj *SAMLSPServer) SetSocketOutgoingSpeedLimit(value int32) error
Default Value
0
Remarks
The maximum number of bytes to write to the socket, per second.
Data Type
int32
SocketTimeout Property (SAMLSPServer Component)
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
Syntax
func (obj *SAMLSPServer) SocketTimeout() (int32, error)
func (obj *SAMLSPServer) SetSocketTimeout(value int32) error
Default Value
60000
Remarks
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).
Data Type
int32
SocketUseIPv6 Property (SAMLSPServer Component)
Enables or disables IP protocol version 6.
Syntax
func (obj *SAMLSPServer) SocketUseIPv6() (bool, error)
func (obj *SAMLSPServer) SetSocketUseIPv6(value bool) error
Default Value
false
Remarks
Enables or disables IP protocol version 6.
Data Type
bool
SPServiceCount Property (SAMLSPServer Component)
The number of records in the SPService arrays.
Syntax
func (obj *SAMLSPServer) SPServiceCount() (int32, error)
Default Value
0
Remarks
This property controls the size of the following arrays:
- SPServiceBindingType
- SPServiceEntityID
- SPServiceLocation
- SPServicePriority
- SPServiceService
- SPServiceServiceIndex
This property is read-only.
Data Type
int32
SPServiceBindingType Property (SAMLSPServer Component)
Specifies the type of SAML binding that this endpoint accepts.
Syntax
func (obj *SAMLSPServer) SPServiceBindingType(SPServiceIndex int32) (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 that this endpoint accepts.
Use this property to specify the binding type to use with this endpoint.
The SPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.
This property is read-only.
Data Type
int32
SPServiceEntityID Property (SAMLSPServer Component)
Represents the SAML entity ID.
Syntax
func (obj *SAMLSPServer) SPServiceEntityID(SPServiceIndex int32) (string, error)
Default Value
""
Remarks
Represents the SAML entity ID.
Use this property to read or set the unique SAML entity ID. This is often the URI of the web endpoint (such as https://sp.myserver.com).
The SPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.
This property is read-only.
Data Type
string
SPServiceLocation Property (SAMLSPServer Component)
The location (URL) of the endpoint.
Syntax
func (obj *SAMLSPServer) SPServiceLocation(SPServiceIndex int32) (string, error)
Default Value
""
Remarks
The location (URL) of the endpoint.
The SPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.
This property is read-only.
Data Type
string
SPServicePriority Property (SAMLSPServer Component)
The priority of the endpoint in relation to other endpoints with the same Location .
Syntax
func (obj *SAMLSPServer) SPServicePriority(SPServiceIndex int32) (int32, error)
Default Value
-1
Remarks
The priority of the endpoint in relation to other endpoints with the same SPLocation.
Indicates the relative priority of the endpoint. Use this setting to adjust priority of certain binding types before others. When composing the metadata XML, the endpoint with the highest priority gets described with a Default attribute.
Leave all priorities at -1 to omit generation of the Default attribute.
The SPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.
This property is read-only.
Data Type
int32
SPServiceService Property (SAMLSPServer Component)
The kind of the service being provided at this endpoint.
Syntax
func (obj *SAMLSPServer) SPServiceService(SPServiceIndex int32) (int32, error)
Default Value
0
Remarks
The kind of the service being provided at this endpoint.
The Service setting returns the kind of the service that is being provided at this endpoint. Typical SP services are AssertionConsumerService and ArtifactResolutionService. Typical IdP services are SingleSignOnService, SingleLogoutService, and ArtifactResolutionService.
The SPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.
This property is read-only.
Data Type
int32
SPServiceServiceIndex Property (SAMLSPServer Component)
The index of this endpoint.
Syntax
func (obj *SAMLSPServer) SPServiceServiceIndex(SPServiceIndex int32) (int32, error)
Default Value
0
Remarks
The index of this endpoint.
For endpoints that can accept requests via multiple bindings, Index is used to distinguish between individual endpoint specifiers.
The SPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.
This property is read-only.
Data Type
int32
SPContactPerson Property (SAMLSPServer Component)
The contact person or persons for the entity.
Syntax
func (obj *SAMLSPServer) SPContactPerson() (string, error)
func (obj *SAMLSPServer) SetSPContactPerson(value string) error
Default Value
""
Remarks
The contact person or persons for the entity.
SAML assumes that more than one contact person can be specified. Each line of this potentially multi-line property contains one such record.
Each record contains a semicolon-separated list of contact person parameters, for example:
Company=My Company;EmailAddress=info@company.com;TelephoneNumber=+012345678;Type=other Company=My Company;EmailAddress=info@company.com;TelephoneNumber=+012345678;Type=technical;Extension.https://spid.gov.it/saml-extensions.VATNumber=IT122345678
You can use LoadNameValuePairs and SaveNameValuePairs methods of the Utils class to process content of this property.
Data Type
string
SPEncryptionKey Property (SAMLSPServer Component)
Contains the entity's encryption key.
Syntax
func (obj *SAMLSPServer) SPEncryptionKey() (string, error)
func (obj *SAMLSPServer) SetSPEncryptionKey(value string) error
Default Value
""
Remarks
Contains the entity's encryption key.
This setting returns the entity's public encryption key. In most cases this is in the form of a DER-encoded X.509 certificate. This property cannot be set in code; it is either taken from the processed metadata file (for other-party settings), or derived from the locally set EncryptionCertificate setting (for this-party settings).
Requests sent to the endpoint can be encrypted with the provided key or certificate.
Data Type
string
SPEncryptionMethods Property (SAMLSPServer Component)
Specifies the list of encryption methods supported by the entity.
Syntax
func (obj *SAMLSPServer) SPEncryptionMethods() (string, error)
func (obj *SAMLSPServer) SetSPEncryptionMethods(value string) error
Default Value
""
Remarks
Specifies the list of encryption methods supported by the entity.
This setting contains a list of encryption methods, in form of XML-ENC URLs separated with newline characters, supported by the entity. These can be considered when encrypting messages destined for this entity.
Examples of algorithms supported by this property:
- http://www.w3.org/2009/xmlenc11#aes128-gcm
- http://www.w3.org/2001/04/xmlenc#aes256-cbc
Data Type
string
SPEntityID Property (SAMLSPServer Component)
Represents the SAML entity ID.
Syntax
func (obj *SAMLSPServer) SPEntityID() (string, error)
func (obj *SAMLSPServer) SetSPEntityID(value string) error
Default Value
""
Remarks
Represents the SAML entity ID.
Use this property to read or set the unique SAML entity ID. This is often the URI of the web endpoint (such as https://sp.myserver.com).
Data Type
string
SPFlags Property (SAMLSPServer Component)
Adjusts secondary entity properties.
Syntax
func (obj *SAMLSPServer) SPFlags() (int32, error)
func (obj *SAMLSPServer) SetSPFlags(value int32) error
Default Value
0
Remarks
Adjusts secondary entity properties.
Use this bit mask property to adjust certain secondary settings. The following flags are supported:
- 1 - sefRequireSignedRequests - the provider expects the consumers to sign requests they send in.
Data Type
int32
SPIdPSSOLink Property (SAMLSPServer Component)
Contains a local server page link that triggers SAML authentication to the SP.
Syntax
func (obj *SAMLSPServer) SPIdPSSOLink() (string, error)
func (obj *SAMLSPServer) SetSPIdPSSOLink(value string) error
Default Value
""
Remarks
Contains a local server page link that triggers SAML authentication to the SP.
This property specifies the web link that initiates the transfer of SAML authentication fact to the SP.
One scenario where this property can be used is triggering the assertion dispatch in IdP-initiated SSO flows. Navigating to the link will make the IdP server generate the authentication assertion (if the user had been authenticated) and forward this assertion to the respective service provider.
Data Type
string
SPNameIDFormats Property (SAMLSPServer Component)
The list of NameID formats supported by this entity.
Syntax
func (obj *SAMLSPServer) SPNameIDFormats() (string, error)
func (obj *SAMLSPServer) SetSPNameIDFormats(value string) error
Default Value
""
Remarks
The list of NameID formats supported by this entity.
Use this setting to get or set the list of NameID formats supported by the entity.
Use SAML notation for the formats:
- urn:oasis:names:tc:SAML:2.0:nameid-format:transient
- urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
- urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
Data Type
string
SPOrganizationDisplayName Property (SAMLSPServer Component)
The friendly name of the organization that maintains the entity.
Syntax
func (obj *SAMLSPServer) SPOrganizationDisplayName() (string, error)
func (obj *SAMLSPServer) SetSPOrganizationDisplayName(value string) error
Default Value
""
Remarks
The friendly name of the organization that maintains the entity.
Use this setting to get or set the user-friendly name of the organization that maintains the SAML entity.
Data Type
string
SPOrganizationLang Property (SAMLSPServer Component)
The language preferred by the organization.
Syntax
func (obj *SAMLSPServer) SPOrganizationLang() (string, error)
func (obj *SAMLSPServer) SetSPOrganizationLang(value string) error
Default Value
""
Remarks
The language preferred by the organization.
This optional setting can be used to adjust the preferred language of the owning organization.
Data Type
string
SPOrganizationName Property (SAMLSPServer Component)
The name of the organization that maintains the entity.
Syntax
func (obj *SAMLSPServer) SPOrganizationName() (string, error)
func (obj *SAMLSPServer) SetSPOrganizationName(value string) error
Default Value
""
Remarks
The name of the organization that maintains the entity.
Use this setting to get or set the name of the organization that maintains the SAML entity.
Data Type
string
SPOrganizationURL Property (SAMLSPServer Component)
The web URL of the organization that maintains the entity.
Syntax
func (obj *SAMLSPServer) SPOrganizationURL() (string, error)
func (obj *SAMLSPServer) SetSPOrganizationURL(value string) error
Default Value
""
Remarks
The web URL of the organization that maintains the entity.
Use this setting to get or set the web address of the organization responsible for this SAML entity.
Data Type
string
SPSignatureValidationResult Property (SAMLSPServer Component)
The outcome of the cryptographic signature validation.
Syntax
func (obj *SAMLSPServer) SPSignatureValidationResult() (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
SPSigned Property (SAMLSPServer Component)
Specifies whether the SAML entity information is or should be signed.
Syntax
func (obj *SAMLSPServer) SPSigned() (bool, error)
Default Value
false
Remarks
Specifies whether the SAML entity information is or should be signed.
Check this property to find out whether the metadata was signed by the sender, or set this property to true to indicate that the created metadata should be signed.
This property is read-only.
Data Type
bool
SPSignedWith Property (SAMLSPServer Component)
Contains the certificate or key that was used to sign the settings (metadata) document.
Syntax
func (obj *SAMLSPServer) SPSignedWith() (string, error)
Default Value
""
Remarks
Contains the certificate or key that was used to sign the settings (metadata) document.
This setting returns the public part of the metadata signing key. In most cases this is in the form of a DER-encoded X.509 certificate.
The value of this property is retrieved from the metadata file when it is loaded with the ImportSettings call. If the metadata is signed, you can check the integrity of the signature using the SPSignatureValidationResult setting.
This property is read-only.
Data Type
string
SPSigningKey Property (SAMLSPServer Component)
Contains the entity's signing key.
Syntax
func (obj *SAMLSPServer) SPSigningKey() (string, error)
func (obj *SAMLSPServer) SetSPSigningKey(value string) error
Default Value
""
Remarks
Contains the entity's signing key.
This setting returns the public part of the entity's signing key. In most cases this is in the form of a PKCS#1 RSA or ECDSA key.
The signing key is used to sign message conveyed over Redirect binding. Redirect signatures are simpler than SAML message signatures and are made with raw keys rather than certificates.
Data Type
string
SPValidUntil Property (SAMLSPServer Component)
Specifies the expiration time of the SAML entity information.
Syntax
func (obj *SAMLSPServer) SPValidUntil() (string, error)
func (obj *SAMLSPServer) SetSPValidUntil(value string) error
Default Value
""
Remarks
Specifies the expiration time of the SAML entity information.
This setting only makes sense when the information was loaded or is going to be saved to a metadata XML.
Data Type
string
TLSServerCertCount Property (SAMLSPServer Component)
The number of records in the TLSServerCert arrays.
Syntax
func (obj *SAMLSPServer) TLSServerCertCount() (int32, error)
func (obj *SAMLSPServer) SetTLSServerCertCount(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 TLSServerCertCount - 1.Data Type
int32
TLSServerCertBytes Property (SAMLSPServer Component)
Returns the raw certificate data in DER format.
Syntax
func (obj *SAMLSPServer) TLSServerCertBytes(TLSServerCertIndex int32) ([]byte, error)
Remarks
Returns the raw certificate data in DER format.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
[]byte
TLSServerCertHandle Property (SAMLSPServer Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *SAMLSPServer) TLSServerCertHandle(TLSServerCertIndex int32) (int64, error)
func (obj *SAMLSPServer) SetTLSServerCertHandle(TLSServerCertIndex 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 TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
Data Type
int64
TLSAutoValidateCertificates Property (SAMLSPServer Component)
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Syntax
func (obj *SAMLSPServer) TLSAutoValidateCertificates() (bool, error)
func (obj *SAMLSPServer) SetTLSAutoValidateCertificates(value bool) error
Default Value
true
Remarks
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Data Type
bool
TLSBaseConfiguration Property (SAMLSPServer Component)
Selects the base configuration for the TLS settings.
Syntax
func (obj *SAMLSPServer) TLSBaseConfiguration() (int32, error)
func (obj *SAMLSPServer) SetTLSBaseConfiguration(value int32) error
Possible Values
0 // Default
1 // Compatible
2 // ComprehensiveInsecure
3 // HighlySecure
Default Value
0
Remarks
Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.
| stpcDefault | 0 | |
| stpcCompatible | 1 | |
| stpcComprehensiveInsecure | 2 | |
| stpcHighlySecure | 3 |
Data Type
int32
TLSCiphersuites Property (SAMLSPServer Component)
A list of ciphersuites separated with commas or semicolons.
Syntax
func (obj *SAMLSPServer) TLSCiphersuites() (string, error)
func (obj *SAMLSPServer) SetTLSCiphersuites(value string) error
Default Value
""
Remarks
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.
Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by TLSBaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
- NULL_NULL_NULL
- RSA_NULL_MD5
- RSA_NULL_SHA
- RSA_RC4_MD5
- RSA_RC4_SHA
- RSA_RC2_MD5
- RSA_IDEA_MD5
- RSA_IDEA_SHA
- RSA_DES_MD5
- RSA_DES_SHA
- RSA_3DES_MD5
- RSA_3DES_SHA
- RSA_AES128_SHA
- RSA_AES256_SHA
- DH_DSS_DES_SHA
- DH_DSS_3DES_SHA
- DH_DSS_AES128_SHA
- DH_DSS_AES256_SHA
- DH_RSA_DES_SHA
- DH_RSA_3DES_SHA
- DH_RSA_AES128_SHA
- DH_RSA_AES256_SHA
- DHE_DSS_DES_SHA
- DHE_DSS_3DES_SHA
- DHE_DSS_AES128_SHA
- DHE_DSS_AES256_SHA
- DHE_RSA_DES_SHA
- DHE_RSA_3DES_SHA
- DHE_RSA_AES128_SHA
- DHE_RSA_AES256_SHA
- DH_ANON_RC4_MD5
- DH_ANON_DES_SHA
- DH_ANON_3DES_SHA
- DH_ANON_AES128_SHA
- DH_ANON_AES256_SHA
- RSA_RC2_MD5_EXPORT
- RSA_RC4_MD5_EXPORT
- RSA_DES_SHA_EXPORT
- DH_DSS_DES_SHA_EXPORT
- DH_RSA_DES_SHA_EXPORT
- DHE_DSS_DES_SHA_EXPORT
- DHE_RSA_DES_SHA_EXPORT
- DH_ANON_RC4_MD5_EXPORT
- DH_ANON_DES_SHA_EXPORT
- RSA_CAMELLIA128_SHA
- DH_DSS_CAMELLIA128_SHA
- DH_RSA_CAMELLIA128_SHA
- DHE_DSS_CAMELLIA128_SHA
- DHE_RSA_CAMELLIA128_SHA
- DH_ANON_CAMELLIA128_SHA
- RSA_CAMELLIA256_SHA
- DH_DSS_CAMELLIA256_SHA
- DH_RSA_CAMELLIA256_SHA
- DHE_DSS_CAMELLIA256_SHA
- DHE_RSA_CAMELLIA256_SHA
- DH_ANON_CAMELLIA256_SHA
- PSK_RC4_SHA
- PSK_3DES_SHA
- PSK_AES128_SHA
- PSK_AES256_SHA
- DHE_PSK_RC4_SHA
- DHE_PSK_3DES_SHA
- DHE_PSK_AES128_SHA
- DHE_PSK_AES256_SHA
- RSA_PSK_RC4_SHA
- RSA_PSK_3DES_SHA
- RSA_PSK_AES128_SHA
- RSA_PSK_AES256_SHA
- RSA_SEED_SHA
- DH_DSS_SEED_SHA
- DH_RSA_SEED_SHA
- DHE_DSS_SEED_SHA
- DHE_RSA_SEED_SHA
- DH_ANON_SEED_SHA
- SRP_SHA_3DES_SHA
- SRP_SHA_RSA_3DES_SHA
- SRP_SHA_DSS_3DES_SHA
- SRP_SHA_AES128_SHA
- SRP_SHA_RSA_AES128_SHA
- SRP_SHA_DSS_AES128_SHA
- SRP_SHA_AES256_SHA
- SRP_SHA_RSA_AES256_SHA
- SRP_SHA_DSS_AES256_SHA
- ECDH_ECDSA_NULL_SHA
- ECDH_ECDSA_RC4_SHA
- ECDH_ECDSA_3DES_SHA
- ECDH_ECDSA_AES128_SHA
- ECDH_ECDSA_AES256_SHA
- ECDHE_ECDSA_NULL_SHA
- ECDHE_ECDSA_RC4_SHA
- ECDHE_ECDSA_3DES_SHA
- ECDHE_ECDSA_AES128_SHA
- ECDHE_ECDSA_AES256_SHA
- ECDH_RSA_NULL_SHA
- ECDH_RSA_RC4_SHA
- ECDH_RSA_3DES_SHA
- ECDH_RSA_AES128_SHA
- ECDH_RSA_AES256_SHA
- ECDHE_RSA_NULL_SHA
- ECDHE_RSA_RC4_SHA
- ECDHE_RSA_3DES_SHA
- ECDHE_RSA_AES128_SHA
- ECDHE_RSA_AES256_SHA
- ECDH_ANON_NULL_SHA
- ECDH_ANON_RC4_SHA
- ECDH_ANON_3DES_SHA
- ECDH_ANON_AES128_SHA
- ECDH_ANON_AES256_SHA
- RSA_NULL_SHA256
- RSA_AES128_SHA256
- RSA_AES256_SHA256
- DH_DSS_AES128_SHA256
- DH_RSA_AES128_SHA256
- DHE_DSS_AES128_SHA256
- DHE_RSA_AES128_SHA256
- DH_DSS_AES256_SHA256
- DH_RSA_AES256_SHA256
- DHE_DSS_AES256_SHA256
- DHE_RSA_AES256_SHA256
- DH_ANON_AES128_SHA256
- DH_ANON_AES256_SHA256
- RSA_AES128_GCM_SHA256
- RSA_AES256_GCM_SHA384
- DHE_RSA_AES128_GCM_SHA256
- DHE_RSA_AES256_GCM_SHA384
- DH_RSA_AES128_GCM_SHA256
- DH_RSA_AES256_GCM_SHA384
- DHE_DSS_AES128_GCM_SHA256
- DHE_DSS_AES256_GCM_SHA384
- DH_DSS_AES128_GCM_SHA256
- DH_DSS_AES256_GCM_SHA384
- DH_ANON_AES128_GCM_SHA256
- DH_ANON_AES256_GCM_SHA384
- ECDHE_ECDSA_AES128_SHA256
- ECDHE_ECDSA_AES256_SHA384
- ECDH_ECDSA_AES128_SHA256
- ECDH_ECDSA_AES256_SHA384
- ECDHE_RSA_AES128_SHA256
- ECDHE_RSA_AES256_SHA384
- ECDH_RSA_AES128_SHA256
- ECDH_RSA_AES256_SHA384
- ECDHE_ECDSA_AES128_GCM_SHA256
- ECDHE_ECDSA_AES256_GCM_SHA384
- ECDH_ECDSA_AES128_GCM_SHA256
- ECDH_ECDSA_AES256_GCM_SHA384
- ECDHE_RSA_AES128_GCM_SHA256
- ECDHE_RSA_AES256_GCM_SHA384
- ECDH_RSA_AES128_GCM_SHA256
- ECDH_RSA_AES256_GCM_SHA384
- PSK_AES128_GCM_SHA256
- PSK_AES256_GCM_SHA384
- DHE_PSK_AES128_GCM_SHA256
- DHE_PSK_AES256_GCM_SHA384
- RSA_PSK_AES128_GCM_SHA256
- RSA_PSK_AES256_GCM_SHA384
- PSK_AES128_SHA256
- PSK_AES256_SHA384
- PSK_NULL_SHA256
- PSK_NULL_SHA384
- DHE_PSK_AES128_SHA256
- DHE_PSK_AES256_SHA384
- DHE_PSK_NULL_SHA256
- DHE_PSK_NULL_SHA384
- RSA_PSK_AES128_SHA256
- RSA_PSK_AES256_SHA384
- RSA_PSK_NULL_SHA256
- RSA_PSK_NULL_SHA384
- RSA_CAMELLIA128_SHA256
- DH_DSS_CAMELLIA128_SHA256
- DH_RSA_CAMELLIA128_SHA256
- DHE_DSS_CAMELLIA128_SHA256
- DHE_RSA_CAMELLIA128_SHA256
- DH_ANON_CAMELLIA128_SHA256
- RSA_CAMELLIA256_SHA256
- DH_DSS_CAMELLIA256_SHA256
- DH_RSA_CAMELLIA256_SHA256
- DHE_DSS_CAMELLIA256_SHA256
- DHE_RSA_CAMELLIA256_SHA256
- DH_ANON_CAMELLIA256_SHA256
- ECDHE_ECDSA_CAMELLIA128_SHA256
- ECDHE_ECDSA_CAMELLIA256_SHA384
- ECDH_ECDSA_CAMELLIA128_SHA256
- ECDH_ECDSA_CAMELLIA256_SHA384
- ECDHE_RSA_CAMELLIA128_SHA256
- ECDHE_RSA_CAMELLIA256_SHA384
- ECDH_RSA_CAMELLIA128_SHA256
- ECDH_RSA_CAMELLIA256_SHA384
- RSA_CAMELLIA128_GCM_SHA256
- RSA_CAMELLIA256_GCM_SHA384
- DHE_RSA_CAMELLIA128_GCM_SHA256
- DHE_RSA_CAMELLIA256_GCM_SHA384
- DH_RSA_CAMELLIA128_GCM_SHA256
- DH_RSA_CAMELLIA256_GCM_SHA384
- DHE_DSS_CAMELLIA128_GCM_SHA256
- DHE_DSS_CAMELLIA256_GCM_SHA384
- DH_DSS_CAMELLIA128_GCM_SHA256
- DH_DSS_CAMELLIA256_GCM_SHA384
- DH_anon_CAMELLIA128_GCM_SHA256
- DH_anon_CAMELLIA256_GCM_SHA384
- ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
- ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
- ECDH_ECDSA_CAMELLIA128_GCM_SHA256
- ECDH_ECDSA_CAMELLIA256_GCM_SHA384
- ECDHE_RSA_CAMELLIA128_GCM_SHA256
- ECDHE_RSA_CAMELLIA256_GCM_SHA384
- ECDH_RSA_CAMELLIA128_GCM_SHA256
- ECDH_RSA_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_GCM_SHA256
- PSK_CAMELLIA256_GCM_SHA384
- DHE_PSK_CAMELLIA128_GCM_SHA256
- DHE_PSK_CAMELLIA256_GCM_SHA384
- RSA_PSK_CAMELLIA128_GCM_SHA256
- RSA_PSK_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_SHA256
- PSK_CAMELLIA256_SHA384
- DHE_PSK_CAMELLIA128_SHA256
- DHE_PSK_CAMELLIA256_SHA384
- RSA_PSK_CAMELLIA128_SHA256
- RSA_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_CAMELLIA128_SHA256
- ECDHE_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_RC4_SHA
- ECDHE_PSK_3DES_SHA
- ECDHE_PSK_AES128_SHA
- ECDHE_PSK_AES256_SHA
- ECDHE_PSK_AES128_SHA256
- ECDHE_PSK_AES256_SHA384
- ECDHE_PSK_NULL_SHA
- ECDHE_PSK_NULL_SHA256
- ECDHE_PSK_NULL_SHA384
- ECDHE_RSA_CHACHA20_POLY1305_SHA256
- ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
- DHE_RSA_CHACHA20_POLY1305_SHA256
- PSK_CHACHA20_POLY1305_SHA256
- ECDHE_PSK_CHACHA20_POLY1305_SHA256
- DHE_PSK_CHACHA20_POLY1305_SHA256
- RSA_PSK_CHACHA20_POLY1305_SHA256
- AES128_GCM_SHA256
- AES256_GCM_SHA384
- CHACHA20_POLY1305_SHA256
- AES128_CCM_SHA256
- AES128_CCM8_SHA256
Data Type
string
TLSClientAuth Property (SAMLSPServer Component)
Enables or disables certificate-based client authentication.
Syntax
func (obj *SAMLSPServer) TLSClientAuth() (int32, error)
func (obj *SAMLSPServer) SetTLSClientAuth(value int32) error
Possible Values
0 // NoAuth
1 // RequestCert
2 // RequireCert
Default Value
0
Remarks
Enables or disables certificate-based client authentication.
Set this property to true to tune up the client authentication type:
| ccatNoAuth | 0 | |
| ccatRequestCert | 1 | |
| ccatRequireCert | 2 |
Data Type
int32
TLSExtensions Property (SAMLSPServer Component)
Provides access to TLS extensions.
Syntax
func (obj *SAMLSPServer) TLSExtensions() (string, error)
func (obj *SAMLSPServer) SetTLSExtensions(value string) error
Default Value
""
Remarks
Provides access to TLS extensions.
Data Type
string
TLSForceResumeIfDestinationChanges Property (SAMLSPServer Component)
Whether to force TLS session resumption when the destination address changes.
Syntax
func (obj *SAMLSPServer) TLSForceResumeIfDestinationChanges() (bool, error)
func (obj *SAMLSPServer) SetTLSForceResumeIfDestinationChanges(value bool) error
Default Value
false
Remarks
Whether to force TLS session resumption when the destination address changes.
Data Type
bool
TLSGroups Property (SAMLSPServer Component)
Specifies a list of key exchange groups to attempt during the TLS key exchange.
Syntax
func (obj *SAMLSPServer) TLSGroups() (string, error)
func (obj *SAMLSPServer) SetTLSGroups(value string) error
Default Value
""
Remarks
Specifies a list of key exchange groups to attempt during the TLS key exchange.
Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the all placeholder:
// Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled
client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048";
// Only enable the hybrid X25519/ML-KEM768 group
client.TLSSettings.Groups = "-all;+x25519mlkem768";
The list of groups supported by the component is provided below. All the names are case-insensitive:
Elliptic curve-based groups:
- SECT163K1
- SECT163R1
- SECT163R2
- SECT193R1
- SECT193R2
- SECT233K1
- SECT233R1
- SECT239K1
- SECT283K1
- SECT283R1
- SECT409K1
- SECT409R1
- SECT571K1
- SECT571R1
- SECP160K1
- SECP160R1
- SECP160R2
- SECP192K1
- SECP192R1
- SECP224K1
- SECP224R1
- SECP256K1
- SECP256R1
- SECP384R1
- SECP521R1
- BRAINPOOLP256R1
- BRAINPOOLP384R1
- BRAINPOOLP512R1
- X25519
- X448
Finite field-based groups:
- FFDHE2048
- FFDHE3072
- FFDHE4096
- FFDHE6144
- FFDHE8192
Post-Quantum and Hybrid groups:
- MLKEM512
- MLKEM768
- MLKEM1024
- SECP256R1MLKEM768
- X25519MLKEM768
- SECP384R1MLKEM1024
Note: this property was called ECCurves in SecureBlackbox 2024 and older.
Data Type
string
TLSPreSharedIdentity Property (SAMLSPServer Component)
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Syntax
func (obj *SAMLSPServer) TLSPreSharedIdentity() (string, error)
func (obj *SAMLSPServer) SetTLSPreSharedIdentity(value string) error
Default Value
""
Remarks
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Data Type
string
TLSPreSharedKey Property (SAMLSPServer Component)
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
Syntax
func (obj *SAMLSPServer) TLSPreSharedKey() (string, error)
func (obj *SAMLSPServer) SetTLSPreSharedKey(value string) error
Default Value
""
Remarks
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
Data Type
string
TLSPreSharedKeyCiphersuite Property (SAMLSPServer Component)
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Syntax
func (obj *SAMLSPServer) TLSPreSharedKeyCiphersuite() (string, error)
func (obj *SAMLSPServer) SetTLSPreSharedKeyCiphersuite(value string) error
Default Value
""
Remarks
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Data Type
string
TLSRenegotiationAttackPreventionMode Property (SAMLSPServer Component)
Selects the renegotiation attack prevention mechanism.
Syntax
func (obj *SAMLSPServer) TLSRenegotiationAttackPreventionMode() (int32, error)
func (obj *SAMLSPServer) SetTLSRenegotiationAttackPreventionMode(value int32) error
Possible Values
0 // Compatible
1 // Strict
2 // Auto
Default Value
2
Remarks
Selects the renegotiation attack prevention mechanism.
The following options are available:
| crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
| crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
| crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |
Data Type
int32
TLSRevocationCheck Property (SAMLSPServer Component)
Specifies the kind(s) of revocation check to perform.
Syntax
func (obj *SAMLSPServer) TLSRevocationCheck() (int32, error)
func (obj *SAMLSPServer) SetTLSRevocationCheck(value int32) error
Possible Values
0 // None
1 // Auto
2 // AllCRL
3 // AllOCSP
4 // AllCRLAndOCSP
5 // AnyCRL
6 // AnyOCSP
7 // AnyCRLOrOCSP
8 // AnyOCSPOrCRL
Default Value
1
Remarks
Specifies the kind(s) of revocation check to perform.
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
| crcNone | 0 | No revocation checking. |
| crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
| crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
| crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
| crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
| crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
| crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
| crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
| crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.
There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).
This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
NOTE: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.
NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.
Data Type
int32
TLSSSLOptions Property (SAMLSPServer Component)
Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.
Syntax
func (obj *SAMLSPServer) TLSSSLOptions() (int32, error)
func (obj *SAMLSPServer) SetTLSSSLOptions(value int32) error
Default Value
16
Remarks
Various SSL (TLS) protocol options, set of
| cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection |
| cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions |
| cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. |
| cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
| cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known |
| cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
| cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. |
| cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
| cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
| cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
| cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually |
Data Type
int32
TLSMode Property (SAMLSPServer Component)
Specifies the TLS mode to use.
Syntax
func (obj *SAMLSPServer) TLSMode() (int32, error)
func (obj *SAMLSPServer) SetTLSMode(value int32) error
Possible Values
0 // Default
1 // NoTLS
2 // ExplicitTLS
3 // ImplicitTLS
4 // MixedTLS
Default Value
0
Remarks
Specifies the TLS mode to use.
| smDefault | 0 | |
| smNoTLS | 1 | Do not use TLS |
| smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
| smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
| smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. |
Data Type
int32
TLSUseExtendedMasterSecret Property (SAMLSPServer Component)
Enables the Extended Master Secret Extension, as defined in RFC 7627.
Syntax
func (obj *SAMLSPServer) TLSUseExtendedMasterSecret() (bool, error)
func (obj *SAMLSPServer) SetTLSUseExtendedMasterSecret(value bool) error
Default Value
true
Remarks
Enables the Extended Master Secret Extension, as defined in RFC 7627.
Data Type
bool
TLSUseSessionResumption Property (SAMLSPServer Component)
Enables or disables the TLS session resumption capability.
Syntax
func (obj *SAMLSPServer) TLSUseSessionResumption() (bool, error)
func (obj *SAMLSPServer) SetTLSUseSessionResumption(value bool) error
Default Value
false
Remarks
Enables or disables the TLS session resumption capability.
Data Type
bool
TLSVersions Property (SAMLSPServer Component)
The SSL/TLS versions to enable by default.
Syntax
func (obj *SAMLSPServer) TLSVersions() (int32, error)
func (obj *SAMLSPServer) SetTLSVersions(value int32) error
Default Value
48
Remarks
The SSL/TLS versions to enable by default.
| csbSSL2 | 0x01 | SSL 2 |
| csbSSL3 | 0x02 | SSL 3 |
| csbTLS1 | 0x04 | TLS 1.0 |
| csbTLS11 | 0x08 | TLS 1.1 |
| csbTLS12 | 0x10 | TLS 1.2 |
| csbTLS13 | 0x20 | TLS 1.3 |
Data Type
int32
URL Property (SAMLSPServer Component)
Specifies the base URL of this SP server.
Syntax
func (obj *SAMLSPServer) URL() (string, error)
func (obj *SAMLSPServer) SetURL(value string) error
Default Value
""
Remarks
Use this property to set the base URL for this Service Provider (SP) server.
Please make sure the URL you provide here aligns well with the relative endpoint resource paths, such as AssertionConsumerService or ArtifactResolutionService. The two parts (the URL and the endpoint paths) are concatenated to produce full endpoint URLs. Please double check that only one of the parts includes the slash character in it: either the endpoint paths at the beginning (the default configuration), or the base URL at the end.
Data Type
string
AddIdPService Method (SAMLSPServer Component)
Registers an IdP service in the IdPServices list.
Syntax
func (obj *SAMLSPServer) AddIdPService(Service int32, BindingType int32, Location string, Priority int32, Index int32) error
Remarks
Use this method to add an entry to the list of known external SAML services and their locations.
The service provider needs to be knowledgeable of the external IdP services that it needs to use. That information can either be provided in the form of a metadata file (see ImportSettings), or registered manually using this method.
When using this method, make sure to register all the services you expect to work with. Note that if the same IdP service is available through several different transports (bindings), you will need to register each (service, transport) pair individually:
sp.AddIdPService(spsSingleSignOnService, csbtPOST, "https://idp.identityserver/saml/sso", -1, -1);
sp.AddIdPService(spsSingleSignOnService, csbtRedirect, "https://idp.identityserver/saml/sso", -1, -1);
Use the Service parameter to specify the service to register:
| spsUnknown | 0 | The service is of unknown or unsupported type |
| spsAssertionConsumerService | 1 | The assertion consumer service (SP side only) |
| spsSingleLogoutService | 2 | The single logout service (SP or IdP sides) |
| spsArtifactResolutionService | 3 | The artifact resolution service (SP or IdP sides) |
| spsAttributeQueryService | 4 | The attribute query service (IdP side only) |
| spsSingleSignOnService | 5 | The single sign-on service (IdP side only) |
The BindingType specifies the transport type that the service being registered should use. Note that not every kind of service supports every kind of transport. It is typical for SSO and SLS services to use POST or Redirect bindings. This information is typically provided by the identity provider.
| csbtNone | 0 | TBD |
| csbtSOAP | 1 | TBD |
| csbtPAOS | 2 | TBD |
| csbtRedirect | 3 | TBD |
| csbtPOST | 4 | TBD |
| csbtArtifact | 5 | TBD |
The Location parameter specifies the absolute URL of the respective SAML web endpoint.
The Priority parameter specifies the relative priority of the transport among several identical services. The actual transport used may be different to the specified priority, as the request received from the SP (such as AuthnRequest) may explicitly request a specific transport to use.
The Index parameter specifies the index of the endpoint, which is a unique value assigned to each endpoint. Pass -1 unless you want to provide the index explicitly.
Note that this method registers a known service - something that the service provider should be aware of. This is different to the purpose of the AddSPService method, which registers the service provider's own service.
AddSPService Method (SAMLSPServer Component)
Registers an SP service in the SPServices list.
Syntax
func (obj *SAMLSPServer) AddSPService(Service int32, BindingType int32, Location string, Priority int32, Index int32) error
Remarks
Use this method to add an entry to the list of SAML services and their locations provided by the SP.
A service provider can provide a variety of SAML services through a selection of endpoints, each supporting one or more transports (or bindings). Typical examples are an assertion consumer service or a single logout service, each of which can be served independently on the same or different endpoints, via a POST or Redirect transports (or both).
Each AddSPService call registers a single service offered via a single transport. If you would like to have the same service to be available using several different transports, you need to register each combination individually, even if the service runs at the same web endpoint:
sp.AddSPService(spsAssertionConsumerService, csbtPOST, '/saml/acs', -1, 1);
sp.AddSPService(spsAssertionConsumerService, csbtRedirect, '/saml/acs', -1, 2);
Use the Service parameter to specify the service to register:
| spsUnknown | 0 | The service is of unknown or unsupported type |
| spsAssertionConsumerService | 1 | The assertion consumer service (SP side only) |
| spsSingleLogoutService | 2 | The single logout service (SP or IdP sides) |
| spsArtifactResolutionService | 3 | The artifact resolution service (SP or IdP sides) |
| spsAttributeQueryService | 4 | The attribute query service (IdP side only) |
| spsSingleSignOnService | 5 | The single sign-on service (IdP side only) |
The BindingType specifies the transport type that the service being registered should use. Note that not every kind of service supports every kind of transport. It is typical for ACS service to use POST binding (due to the size of assertions), and SLS to either use POST or Redirect.
| csbtNone | 0 | TBD |
| csbtSOAP | 1 | TBD |
| csbtPAOS | 2 | TBD |
| csbtRedirect | 3 | TBD |
| csbtPOST | 4 | TBD |
| csbtArtifact | 5 | TBD |
The Location parameter specifies an absolute or relative path to the service within the SAML web service:
sp.AddSPService(spsAssertionConsumerService, csbtPOST, 'https://app.com/saml/acs', -1, 1); // absolute path
sp.AddSPService(spsAssertionConsumerService, csbtRedirect, '/saml/acs', -1, 2); // relative path
The Priority parameter is nominal as it only specifies the relative priority of the transport in the SP metadata. The actual transport used, among those supported, depends on the choice of the external identity provider. Pass -1 to stick with the default priority.
The Index parameter specifies the index of the endpoint, which is a unique value assigned to each endpoint. Pass -1 unless you want to provide the index explicitly.
Note that this method registers the service provider's own service - something that the service provider provides. This is different to AddIdPService method, which registers a foreign identity provider's service - something that the service provider should be aware of.
Cleanup Method (SAMLSPServer Component)
Cleans up the server environment by purging expired sessions and cleaning caches.
Syntax
func (obj *SAMLSPServer) Cleanup() error
Remarks
Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches.
Config Method (SAMLSPServer Component)
Sets or retrieves a configuration setting.
Syntax
func (obj *SAMLSPServer) 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.
DoAction Method (SAMLSPServer Component)
Performs an additional action.
Syntax
func (obj *SAMLSPServer) 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. |
DropClient Method (SAMLSPServer Component)
Terminates a client connection.
Syntax
func (obj *SAMLSPServer) DropClient(ConnectionId int64, Forced bool) error
Remarks
Call this method to shut down a connected client. Forced indicates whether the connection should be closed in a graceful manner.
ExportSettings Method (SAMLSPServer Component)
Saves the SP or IdP configuration to an XML metadata file.
Syntax
func (obj *SAMLSPServer) ExportSettings(SP bool) (string, error)
Remarks
Use this method to save the Service Provider (SP) or Identity Provider (IdP) configuration in the form of XML metadata. The SP metadata file may then be transferred to identity providers (IdP) to let them know about the SP configuration.
Adjust the provider configuration as required in SPSettings or IdPSettings object before calling this method. Assign MetaSigningCertificate to enforce signing of the metadata XML.
GetClientBuffer Method (SAMLSPServer Component)
Acquires a piece of operation data.
Syntax
func (obj *SAMLSPServer) GetClientBuffer(ConnectionID int64, Handle string) ([]byte, error)
Remarks
Use this method to obtain a piece of data relevant to a transfer operation in a thread-safe way.
A typical place to call this method is inside the ResourceWrite event handler, when implementing customized file transfers.
GetProviderProperty Method (SAMLSPServer Component)
Returns the value of a custom provider property.
Syntax
func (obj *SAMLSPServer) GetProviderProperty(Name string) (string, error)
Remarks
This method, together with SetProviderProperty, provides an extensible way of managing the Service Provider's settings that are not available through the primary properties of the component. As SAML usage scenarios evolve and new providers appear, the list of supported properties can be extended.
The following properties are currently supported:
- ContactPerson
- OrganizationName
- OrganizationDisplayName
- OrganizationURL
- OrganizationLang
GetRequestBytes Method (SAMLSPServer Component)
Returns the contents of the connected client's HTTP request.
Syntax
func (obj *SAMLSPServer) GetRequestBytes(ConnectionID int64, RequestFilter string) ([]byte, error)
Remarks
Use this method to get the body of the client's HTTP request. Note that the body of GET and HEAD requests is empty. The method returns the requested content.
GetRequestHeader Method (SAMLSPServer Component)
Returns a request header value.
Syntax
func (obj *SAMLSPServer) GetRequestHeader(ConnectionId int64, HeaderName string) (string, error)
Remarks
Use this method to get the value of a request header. A good place to call this method is a request-marking event, such as GetRequest or PostRequest.
GetResponseHeader Method (SAMLSPServer Component)
Returns a response header value.
Syntax
func (obj *SAMLSPServer) GetResponseHeader(ConnectionId int64, HeaderName string) (string, error)
Remarks
Use this method to get the value of a response header. A good place to call this method is HeadersPrepared event. Call the method with empty HeaderName to get the whole response header.
GetSessionProperty Method (SAMLSPServer Component)
Returns the value of a custom session property.
Syntax
func (obj *SAMLSPServer) GetSessionProperty(SessionID string, Name string) (string, error)
Remarks
This method, together with SetSessionProperty, provides an extensible way of managing the Service Provider's session properties that are not available through the primary properties and events of the component. These methods can be called on any active browser session. Use SessionCreated and SessionDestroyed events to get notifications about session creation and disposal.
The following properties are supported for SP sessions and can be passed to the Name parameter of this method:
- Authenticated: whether the session has been authenticated with the IdP service.
- AuthnRequestID: the AuthnRequest ID.
- Expires: the web session expiration time.
- LogoutRequestID: the LogoutRequest ID.
- NameID: the NameID of the user.
- NameIDFormat: the format of the NameID of the user.
- FormattedNameID: the formatted version of the NameID.
- RelayState: the current (last) relay state entry.
- Session: the session ID (the same as you pass as parameter).
- SAMLSession: the browser cookie that corresponds to the session.
- SessionIndex: a list of cross-network session indexes assigned to this session.
- URL: the current request's URL.
- UserData: the protocol-independent user data. Use this session property to store custom information associated with the session across contexts.
- Stage: the current session stage (or epoch).
ImportSettings Method (SAMLSPServer Component)
Loads the metadata required for information exchange with the identity provider. Both local (SP-side) and remote (IdP-side) metadata can be loaded with this call.
Syntax
func (obj *SAMLSPServer) ImportSettings(Metadata string, SP bool) error
Remarks
The Identity provider (IdP) may have different options and requirements for interactions with the Service Provider (SP). Usually all these options together with X.509 certificates needed for data exchange are stored in XML metadata files. Use this method to load metadata from a file generated by an IdP.
The Metadata parameter contains metadata in the form of byte array. Set SP parameter to true to indicate that it is the Service Provider's own settings that are being loaded.
The loaded metadata is populated in the SPSettings or IdPSettings object (depending on the value of the SP parameter).
InitiateArtifactResolve Method (SAMLSPServer Component)
Initiates the artifact resolution protocol.
Syntax
func (obj *SAMLSPServer) InitiateArtifactResolve(ConnectionID int64, SessionID string, IdPServiceIndex int32, Artifact string, Tag string) (int32, error)
Remarks
Use this event to initiate the artifact resolution protocol for Artifact. Specify the desired SP service endpoint via the IdPServiceIndex parameter.
| sprUnknown | 0 | Unknown or undefined processing result |
| sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
| sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
| sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
| sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
| sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
| sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
You can use this method with or without the OfflineMode.
Note: this method is currently in development and will be available in later SecureBlackbox updates.
InitiateAttributeQuery Method (SAMLSPServer Component)
Initiates the attribute query.
Syntax
func (obj *SAMLSPServer) InitiateAttributeQuery(ConnectionID int64, SessionID string, IdPServiceIndex int32, NameID string, NameIDFormat string, Attributes string, AttrNameFormats string, AttrFriendlyNames string, Tag string) (int32, error)
Remarks
Use this event to initiate the attribute query for user NameID. Specify the desired Attributes as a list of CRLF-separated attribute names. AttrNameFormats and AttrFriendlyNames can also be provided in the same way.
Specify the IdP AQS endpoint via the IdPServiceIndex parameter.
| sprUnknown | 0 | Unknown or undefined processing result |
| sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
| sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
| sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
| sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
| sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
| sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
You can use this method with or without the OfflineMode.
Note: this method is currently in development and will be available in later SecureBlackbox updates.
InitiateAuth Method (SAMLSPServer Component)
Starts SP-initiated SAML authentication flow.
Syntax
func (obj *SAMLSPServer) InitiateAuth(ConnectionID int64, SessionID string, IdPServiceIndex int32, NameIDFormat string, RelayState string, Tag string) (int32, error)
Remarks
Use this method to initiate SAML authentication flow on the SP side. Pass the index of the single sign-on service that you want to use to the IdPServiceIndex parameter. Leave it empty to let the component pick up the best one automatically. Use RelayState to pass the callback URL to the IdP service. This will be mirrored back by the IDP in its response.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
| sprUnknown | 0 | Unknown or undefined processing result |
| sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
| sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
| sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
| sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
| sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
| sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
You can use this method with or without the OfflineMode.
InitiateLogout Method (SAMLSPServer Component)
Starts SP-initiated SAML logout flow.
Syntax
func (obj *SAMLSPServer) InitiateLogout(ConnectionID int64, SessionID string, IdPServiceIndex int32, NameID string, SessionIndex string, RelayState string, Tag string) (int32, error)
Remarks
Use this method to initiate SAML logout flow on the SP side. Pass the index of the single logout service that you want to use to the IdPServiceIndex parameter.
Use IdPServiceIndex to specify the identity provider's service that you want to use for signing out. Provide the existing SAML session details in one of the following ways:
- as an HTTP SessionID: in this case the component will try to pick the matching SAML session from its session cache.
- as a known NameID.
- as a known SAML SessionIndex.
You can use a combination of the above.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
| sprUnknown | 0 | Unknown or undefined processing result |
| sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
| sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
| sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
| sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
| sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
| sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
Use RelayState to pass a value to the IdP that you want to be mirrored back in the IdP's response. The Tag value will be similarly mirrored, but in the component's events, such as ProcessingCompleted.
You can use this method with or without the OfflineMode.
ListClients Method (SAMLSPServer Component)
Enumerates the connected clients.
Syntax
func (obj *SAMLSPServer) ListClients() (string, error)
Remarks
This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection.
PinClient Method (SAMLSPServer Component)
Takes a snapshot of the connection's properties.
Syntax
func (obj *SAMLSPServer) PinClient(ConnectionId int64) error
Remarks
Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient and PinnedClientChain properties.
ProcessArtifact Method (SAMLSPServer Component)
Processes an artifact request received from the IdP service at one of artifact receiver endpoints.
Syntax
func (obj *SAMLSPServer) ProcessArtifact(ConnectionID int64, SessionID string, Request string, Tag string) (int32, error)
Remarks
Use this method to pass a SAML artifact received at one of the artifact endpoints.
Artifact messages are typically very simple:
https://idp.server.com/sso/artifact?SAMLart=artifact
In response to the artifact received, the server initiates an artifact resolution protocol to retrieve the SAML message identified by the artifact. This will typically expose itself via an invocation of the ArtifactResolveRequestPrepared event, and, later on, of an event matching the type of the actual message received - such as AssertionReceived.
| sprUnknown | 0 | Unknown or undefined processing result |
| sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
| sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
| sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
| sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
| sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
| sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
You can use this method with or without the OfflineMode.
Note: this method is currently in development and will be available in later SecureBlackbox updates.
ProcessArtifactResolveRequest Method (SAMLSPServer Component)
Processes an artifact request received from the SP service at one of the ARS endpoints.
Syntax
func (obj *SAMLSPServer) ProcessArtifactResolveRequest(ConnectionID int64, SessionID string, Request string, Tag string) (int32, error)
Remarks
Use this method to pass a SAML artifact request received at one of the ArtifactResolutionService endpoints.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
| sprUnknown | 0 | Unknown or undefined processing result |
| sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
| sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
| sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
| sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
| sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
| sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
You can use this method with or without the OfflineMode.
Note: this method is currently in development and will be available in later SecureBlackbox updates.
ProcessAssertion Method (SAMLSPServer Component)
Processes assertion received from the IdP service at one of the ACS endpoints.
Syntax
func (obj *SAMLSPServer) ProcessAssertion(ConnectionID int64, SessionID string, Request string, Tag string) (int32, error)
Remarks
Use this method to pass a SAML assertion received at one of the AssertionConsumerService endpoints.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
| sprUnknown | 0 | Unknown or undefined processing result |
| sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
| sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
| sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
| sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
| sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
| sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
You can use this method with or without the OfflineMode.
ProcessGenericRequest Method (SAMLSPServer Component)
Processes a generic HTTP SAML request.
Syntax
func (obj *SAMLSPServer) ProcessGenericRequest(ConnectionID int64, Request []byte) ([]byte, error)
Remarks
Use this method to process a generic well-formed HTTP SAML request obtained elsewhere. This is a handy mechanism to bind the SAML processor to an external web engine.
The Request parameter is expected to contain a full HTTP request, including the HTTP method string (GET, POST) and all the headers. The generated response contains a full HTTP response that should be supplied back to the requestor. You can edit some parts of the response (for example, by adding some custom HTTP headers).
You can use this method with or without the OfflineMode.
ProcessLogoutRequest Method (SAMLSPServer Component)
Processes logout request received from the IdP service at one of the SLS endpoints.
Syntax
func (obj *SAMLSPServer) ProcessLogoutRequest(ConnectionID int64, SessionID string, Request string, Tag string) (int32, error)
Remarks
Use this method to pass a SAML logout request received at one of the SingleLogoutService endpoints.
An SLS endpoint may receive requests of two kinds: LogoutRequest and LogoutResponse. If Request contains a LogoutRequest, the content generated by this method will contain a corresponding LogoutResponse. If Request contains a LogoutResponse, the generated content is empty.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
| sprUnknown | 0 | Unknown or undefined processing result |
| sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
| sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
| sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
| sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
| sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
| sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
You can use this method with or without the OfflineMode.
Reset Method (SAMLSPServer Component)
Resets the class settings.
Syntax
func (obj *SAMLSPServer) Reset() error
Remarks
Reset is a generic method available in every struct.
SetClientBuffer Method (SAMLSPServer Component)
Commits a data buffer to the connection.
Syntax
func (obj *SAMLSPServer) SetClientBuffer(ConnectionID int64, Handle string, Value []byte) error
Remarks
Use this method from your ReadFile event handler to commit a chunk of file data to the server component.
SetProviderProperty Method (SAMLSPServer Component)
Sets the value of a custom provider property.
Syntax
func (obj *SAMLSPServer) SetProviderProperty(Name string, Value string) error
Remarks
This method, together with GetProviderProperty, provides an extensible way of managing the Service Provider's settings that are not available through the primary properties of the component. As SAML usage scenarios evolve and new providers appear, the list of supported properties can be extended.
The following properties are currently supported:
- ContactPerson
- OrganizationName
- OrganizationDisplayName
- OrganizationURL
- OrganizationLang
SetResponseHeader Method (SAMLSPServer Component)
Sets a response header.
Syntax
func (obj *SAMLSPServer) SetResponseHeader(ConnectionId int64, HeaderName string, Value string) error
Remarks
Use this method to set a response header. A good place to call this method is a request-marking event, such as GetRequest or PostRequest.
SetSessionProperty Method (SAMLSPServer Component)
Sets the value of a custom provider session property.
Syntax
func (obj *SAMLSPServer) SetSessionProperty(SessionID string, Name string, Value string) error
Remarks
This method, together with GetSessionProperty, provides an extensible way of managing the Service Provider's session settings that are not available through the primary properties and events of the component.
The following properties can be adjusted for each individual session:
- AuthnRequestID: the AuthnRequest ID.
- LogoutRequestID: the LogoutRequest ID.
- NameID: the NameID of the user.
- RelayState: the current (last) relay state entry.
- Session: the session ID (the same as you pass as parameter).
- SAMLSession: the browser cookie that corresponds to the session.
- SessionIndex: a collection of cross-network session indexes assigned to this session.
- URL: the current request's URL.
- UserData: the protocol-independent user data. Use this session property to store custom information associated with the session across contexts.
- Expires: the web session expiration time. Set it to a moment in the past to enforce immediate session expiration.
Note: setting a session property invokes a call to SessionStateSave. The component does that to update the session state kept externally.
Note: changing session properties mindlessly may break the protocol flow. For example, changing AuthnRequestID to a different value may cause the Service Provider to reject the subsequent assertion message, as the incoming assertion will contain a now-unmatching In-Response-To entry.
Start Method (SAMLSPServer Component)
Starts the SP server.
Syntax
func (obj *SAMLSPServer) Start() error
Remarks
Use this method to start listening for incoming connections.
Stop Method (SAMLSPServer Component)
Stops the IdP server.
Syntax
func (obj *SAMLSPServer) Stop() error
Remarks
Call this method to stop listening for incoming connections.
Accept Event (SAMLSPServer Component)
Reports an incoming connection.
Syntax
// SAMLSPServerAcceptEventArgs carries the SAMLSPServer Accept event's parameters.
type SAMLSPServerAcceptEventArgs struct {...}
func (args *SAMLSPServerAcceptEventArgs) RemoteAddress() string
func (args *SAMLSPServerAcceptEventArgs) RemotePort() int32
func (args *SAMLSPServerAcceptEventArgs) Accept() bool
func (args *SAMLSPServerAcceptEventArgs) SetAccept(value bool)
// SAMLSPServerAcceptEvent defines the signature of the SAMLSPServer Accept event's handler function.
type SAMLSPServerAcceptEvent func(sender *SAMLSPServer, args *SAMLSPServerAcceptEventArgs)
func (obj *SAMLSPServer) GetOnAcceptHandler() SAMLSPServerAcceptEvent
func (obj *SAMLSPServer) SetOnAcceptHandler(handlerFunc SAMLSPServerAcceptEvent)
Remarks
This event is fired when a new connection from RemoteAddress:RemotePort is ready to be accepted. Use the Accept parameter to accept or decline it.
Subscribe to Connect event to be notified of every connection that has been set up.
ArtifactReceived Event (SAMLSPServer Component)
The server fires this event upon receiving an Artifact message from the other side.
Syntax
// SAMLSPServerArtifactReceivedEventArgs carries the SAMLSPServer ArtifactReceived event's parameters.
type SAMLSPServerArtifactReceivedEventArgs struct {...}
func (args *SAMLSPServerArtifactReceivedEventArgs) ConnectionID() int64
func (args *SAMLSPServerArtifactReceivedEventArgs) SessionID() string
func (args *SAMLSPServerArtifactReceivedEventArgs) RequestID() string
func (args *SAMLSPServerArtifactReceivedEventArgs) Issuer() string
func (args *SAMLSPServerArtifactReceivedEventArgs) Artifact() string
func (args *SAMLSPServerArtifactReceivedEventArgs) Action() int32
func (args *SAMLSPServerArtifactReceivedEventArgs) SetAction(value int32)
// SAMLSPServerArtifactReceivedEvent defines the signature of the SAMLSPServer ArtifactReceived event's handler function.
type SAMLSPServerArtifactReceivedEvent func(sender *SAMLSPServer, args *SAMLSPServerArtifactReceivedEventArgs)
func (obj *SAMLSPServer) GetOnArtifactReceivedHandler() SAMLSPServerArtifactReceivedEvent
func (obj *SAMLSPServer) SetOnArtifactReceivedHandler(handlerFunc SAMLSPServerArtifactReceivedEvent)
Remarks
The Artifact message is very simple and only contains the actual artifact (an opaque string). Depending on the choice of the Action parameter, the further flow may go as following:
- fraAuto: the server will prepare an ArtifactResolve request and sent it to the other side to retrieve the artifact.
- fraCustom: the server will acknowledge the receipt of the artifact, but it is the task of your code to request the message and pass it on to the server via ProcessGenericRequest method.
- fraReject: the server will discard the artifact.
Note that you still can choose fraAuto to let the server proceed, but alter the flow as required in further events, such as ArtifactResolveRequestPrepared.
In OfflineMode this event would typically be fired from ProcessArtifact call.
ArtifactResolveRequestPrepared Event (SAMLSPServer Component)
This event is fired when a new artifact resolution request message has been prepared by the class.
Syntax
// SAMLSPServerArtifactResolveRequestPreparedEventArgs carries the SAMLSPServer ArtifactResolveRequestPrepared event's parameters.
type SAMLSPServerArtifactResolveRequestPreparedEventArgs struct {...}
func (args *SAMLSPServerArtifactResolveRequestPreparedEventArgs) ConnectionID() int64
func (args *SAMLSPServerArtifactResolveRequestPreparedEventArgs) SessionID() string
func (args *SAMLSPServerArtifactResolveRequestPreparedEventArgs) RequestID() string
func (args *SAMLSPServerArtifactResolveRequestPreparedEventArgs) Destination() string
func (args *SAMLSPServerArtifactResolveRequestPreparedEventArgs) Artifact() string
// SAMLSPServerArtifactResolveRequestPreparedEvent defines the signature of the SAMLSPServer ArtifactResolveRequestPrepared event's handler function.
type SAMLSPServerArtifactResolveRequestPreparedEvent func(sender *SAMLSPServer, args *SAMLSPServerArtifactResolveRequestPreparedEventArgs)
func (obj *SAMLSPServer) GetOnArtifactResolveRequestPreparedHandler() SAMLSPServerArtifactResolveRequestPreparedEvent
func (obj *SAMLSPServer) SetOnArtifactResolveRequestPreparedHandler(handlerFunc SAMLSPServerArtifactResolveRequestPreparedEvent)
Remarks
Subscribe to this event to be notified about preparation of artifact resolution requests. This is fired right after the resolution request has been prepared, and just before the component sends it out to the identity provider.
ArtifactResolveRequestReceived Event (SAMLSPServer Component)
Reports receipt of ArtifactResolveRequest message.
Syntax
// SAMLSPServerArtifactResolveRequestReceivedEventArgs carries the SAMLSPServer ArtifactResolveRequestReceived event's parameters.
type SAMLSPServerArtifactResolveRequestReceivedEventArgs struct {...}
func (args *SAMLSPServerArtifactResolveRequestReceivedEventArgs) ConnectionID() int64
func (args *SAMLSPServerArtifactResolveRequestReceivedEventArgs) SessionID() string
func (args *SAMLSPServerArtifactResolveRequestReceivedEventArgs) RequestID() string
func (args *SAMLSPServerArtifactResolveRequestReceivedEventArgs) Issuer() string
func (args *SAMLSPServerArtifactResolveRequestReceivedEventArgs) IsEncrypted() bool
func (args *SAMLSPServerArtifactResolveRequestReceivedEventArgs) IsSigned() bool
func (args *SAMLSPServerArtifactResolveRequestReceivedEventArgs) Artifact() string
func (args *SAMLSPServerArtifactResolveRequestReceivedEventArgs) Action() int32
func (args *SAMLSPServerArtifactResolveRequestReceivedEventArgs) SetAction(value int32)
// SAMLSPServerArtifactResolveRequestReceivedEvent defines the signature of the SAMLSPServer ArtifactResolveRequestReceived event's handler function.
type SAMLSPServerArtifactResolveRequestReceivedEvent func(sender *SAMLSPServer, args *SAMLSPServerArtifactResolveRequestReceivedEventArgs)
func (obj *SAMLSPServer) GetOnArtifactResolveRequestReceivedHandler() SAMLSPServerArtifactResolveRequestReceivedEvent
func (obj *SAMLSPServer) SetOnArtifactResolveRequestReceivedHandler(handlerFunc SAMLSPServerArtifactResolveRequestReceivedEvent)
Remarks
The component fires this event to report receipt of incoming artifact resolution request. The Artifact parameter contains the artifact identifier received.
The application can choose to accept or reject the request, or process it manually, using the Action parameter:
| fraAuto | 1 | Handle the requested action automatically by the server |
| fraCustom | 2 | Override the action using the user code logic |
| fraAbort | 3 | Abort the requested action |
AssertionReceived Event (SAMLSPServer Component)
This event is fired when an assertion is received from the IdP.
Syntax
// SAMLSPServerAssertionReceivedEventArgs carries the SAMLSPServer AssertionReceived event's parameters.
type SAMLSPServerAssertionReceivedEventArgs struct {...}
func (args *SAMLSPServerAssertionReceivedEventArgs) ConnectionID() int64
func (args *SAMLSPServerAssertionReceivedEventArgs) SessionID() string
func (args *SAMLSPServerAssertionReceivedEventArgs) RequestID() string
func (args *SAMLSPServerAssertionReceivedEventArgs) Issuer() string
func (args *SAMLSPServerAssertionReceivedEventArgs) Body() string
func (args *SAMLSPServerAssertionReceivedEventArgs) IsEncrypted() bool
func (args *SAMLSPServerAssertionReceivedEventArgs) IsSigned() bool
func (args *SAMLSPServerAssertionReceivedEventArgs) Auth() string
func (args *SAMLSPServerAssertionReceivedEventArgs) NameID() string
func (args *SAMLSPServerAssertionReceivedEventArgs) NameIDFormat() string
func (args *SAMLSPServerAssertionReceivedEventArgs) SessionIndex() string
func (args *SAMLSPServerAssertionReceivedEventArgs) Attributes() string
func (args *SAMLSPServerAssertionReceivedEventArgs) ValidFrom() string
func (args *SAMLSPServerAssertionReceivedEventArgs) ValidTo() string
func (args *SAMLSPServerAssertionReceivedEventArgs) RelayState() string
func (args *SAMLSPServerAssertionReceivedEventArgs) Action() int32
func (args *SAMLSPServerAssertionReceivedEventArgs) SetAction(value int32)
// SAMLSPServerAssertionReceivedEvent defines the signature of the SAMLSPServer AssertionReceived event's handler function.
type SAMLSPServerAssertionReceivedEvent func(sender *SAMLSPServer, args *SAMLSPServerAssertionReceivedEventArgs)
func (obj *SAMLSPServer) GetOnAssertionReceivedHandler() SAMLSPServerAssertionReceivedEvent
func (obj *SAMLSPServer) SetOnAssertionReceivedHandler(handlerFunc SAMLSPServerAssertionReceivedEvent)
Remarks
The AssertionReceived event notifies the application that an assertion has been received at the ACS endpoint. In OfflineMode this event may fire in response to a ProcessAssertion call. In online mode it can fire at any time while the server is active.
The ConnectionID and SessionID specify the IDs of the current client connection and HTTP session. The RequestID contains the ID of the original AuthnRequest message, if it was sent by the service provider. The IsEncrypted and IsSigned parameters indicate the security properties of the assertion. The NameID parameter contains the unique name identifier of the authenticated principal, and the SessionIndex contains the SAML session identifier. In rare cases SessionIndex may contain multiple indices, if the SP has more than one session at the IdP.
The application can choose to accept or reject the request, or process it manually, using the Action parameter:
| fraAuto | 1 | Handle the requested action automatically by the server |
| fraCustom | 2 | Override the action using the user code logic |
| fraAbort | 3 | Abort the requested action |
If the assertion is returned in response to this SP's AuthnRequest message, the RelayState parameter will contain the original relay state passed to the earlier InitiateAuth call.
AttributeQueryPrepared Event (SAMLSPServer Component)
Notifies the application of the preparation of an AttributeQuery.
Syntax
// SAMLSPServerAttributeQueryPreparedEventArgs carries the SAMLSPServer AttributeQueryPrepared event's parameters.
type SAMLSPServerAttributeQueryPreparedEventArgs struct {...}
func (args *SAMLSPServerAttributeQueryPreparedEventArgs) ConnectionID() int64
func (args *SAMLSPServerAttributeQueryPreparedEventArgs) SessionID() string
func (args *SAMLSPServerAttributeQueryPreparedEventArgs) RequestID() string
func (args *SAMLSPServerAttributeQueryPreparedEventArgs) Destination() string
func (args *SAMLSPServerAttributeQueryPreparedEventArgs) NameID() string
func (args *SAMLSPServerAttributeQueryPreparedEventArgs) NameIDFormat() string
func (args *SAMLSPServerAttributeQueryPreparedEventArgs) Attributes() string
// SAMLSPServerAttributeQueryPreparedEvent defines the signature of the SAMLSPServer AttributeQueryPrepared event's handler function.
type SAMLSPServerAttributeQueryPreparedEvent func(sender *SAMLSPServer, args *SAMLSPServerAttributeQueryPreparedEventArgs)
func (obj *SAMLSPServer) GetOnAttributeQueryPreparedHandler() SAMLSPServerAttributeQueryPreparedEvent
func (obj *SAMLSPServer) SetOnAttributeQueryPreparedHandler(handlerFunc SAMLSPServerAttributeQueryPreparedEvent)
Remarks
The component uses this event to notify the application of the completion of the preparation of the AttributeQuery message. The NameID and NameIDFormat parameters indicate the attribute subject, and the Attributes parameter contains a list of attributes being requested.
This event may be fired in response to a InitiateAttributeQuery call (in offline mode), or intermittently in online mode.
AuthnRequestPrepared Event (SAMLSPServer Component)
This event is fired when a new authentication request message has been prepared.
Syntax
// SAMLSPServerAuthnRequestPreparedEventArgs carries the SAMLSPServer AuthnRequestPrepared event's parameters.
type SAMLSPServerAuthnRequestPreparedEventArgs struct {...}
func (args *SAMLSPServerAuthnRequestPreparedEventArgs) ConnectionID() int64
func (args *SAMLSPServerAuthnRequestPreparedEventArgs) SessionID() string
func (args *SAMLSPServerAuthnRequestPreparedEventArgs) RequestID() string
func (args *SAMLSPServerAuthnRequestPreparedEventArgs) Destination() string
func (args *SAMLSPServerAuthnRequestPreparedEventArgs) NameIDFormat() string
func (args *SAMLSPServerAuthnRequestPreparedEventArgs) ForceAuthn() bool
func (args *SAMLSPServerAuthnRequestPreparedEventArgs) NonInteractive() bool
func (args *SAMLSPServerAuthnRequestPreparedEventArgs) RelayState() string
func (args *SAMLSPServerAuthnRequestPreparedEventArgs) SetRelayState(value string)
// SAMLSPServerAuthnRequestPreparedEvent defines the signature of the SAMLSPServer AuthnRequestPrepared event's handler function.
type SAMLSPServerAuthnRequestPreparedEvent func(sender *SAMLSPServer, args *SAMLSPServerAuthnRequestPreparedEventArgs)
func (obj *SAMLSPServer) GetOnAuthnRequestPreparedHandler() SAMLSPServerAuthnRequestPreparedEvent
func (obj *SAMLSPServer) SetOnAuthnRequestPreparedHandler(handlerFunc SAMLSPServerAuthnRequestPreparedEvent)
Remarks
Subscribe to this event to get notified about assertion requests prepared by the service provider. This event may fire from InitiateAuth method when working in OfflineMode, or at any time when working as a standalone live web server.
You can adjust the RelayState as required in the event handler to pass on a state to the IdP. The IdP will return this state back to you together with its authentication assertion.
Connect Event (SAMLSPServer Component)
Reports an accepted connection.
Syntax
// SAMLSPServerConnectEventArgs carries the SAMLSPServer Connect event's parameters.
type SAMLSPServerConnectEventArgs struct {...}
func (args *SAMLSPServerConnectEventArgs) ConnectionId() int64
func (args *SAMLSPServerConnectEventArgs) RemoteAddress() string
func (args *SAMLSPServerConnectEventArgs) RemotePort() int32
// SAMLSPServerConnectEvent defines the signature of the SAMLSPServer Connect event's handler function.
type SAMLSPServerConnectEvent func(sender *SAMLSPServer, args *SAMLSPServerConnectEventArgs)
func (obj *SAMLSPServer) GetOnConnectHandler() SAMLSPServerConnectEvent
func (obj *SAMLSPServer) SetOnConnectHandler(handlerFunc SAMLSPServerConnectEvent)
Remarks
The struct fires this event to report that a new connection has been established. ConnectionId indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as SessionClosed or SessionEstablished.
Disconnect Event (SAMLSPServer Component)
Fires to report a disconnected client.
Syntax
// SAMLSPServerDisconnectEventArgs carries the SAMLSPServer Disconnect event's parameters.
type SAMLSPServerDisconnectEventArgs struct {...}
func (args *SAMLSPServerDisconnectEventArgs) ConnectionID() int64
// SAMLSPServerDisconnectEvent defines the signature of the SAMLSPServer Disconnect event's handler function.
type SAMLSPServerDisconnectEvent func(sender *SAMLSPServer, args *SAMLSPServerDisconnectEventArgs)
func (obj *SAMLSPServer) GetOnDisconnectHandler() SAMLSPServerDisconnectEvent
func (obj *SAMLSPServer) SetOnDisconnectHandler(handlerFunc SAMLSPServerDisconnectEvent)
Remarks
The struct fires this event when a connected client disconnects.
Encrypted Event (SAMLSPServer Component)
Notifies the application that the assertion is encrypted and provides recipient certificate details.
Syntax
// SAMLSPServerEncryptedEventArgs carries the SAMLSPServer Encrypted event's parameters.
type SAMLSPServerEncryptedEventArgs struct {...}
func (args *SAMLSPServerEncryptedEventArgs) ConnectionID() int64
func (args *SAMLSPServerEncryptedEventArgs) SessionID() string
func (args *SAMLSPServerEncryptedEventArgs) RequestID() string
func (args *SAMLSPServerEncryptedEventArgs) IssuerRDN() string
func (args *SAMLSPServerEncryptedEventArgs) SerialNumber() []byte
func (args *SAMLSPServerEncryptedEventArgs) SubjectKeyID() []byte
func (args *SAMLSPServerEncryptedEventArgs) NeedCredential() bool
func (args *SAMLSPServerEncryptedEventArgs) SkipThis() bool
func (args *SAMLSPServerEncryptedEventArgs) SetSkipThis(value bool)
// SAMLSPServerEncryptedEvent defines the signature of the SAMLSPServer Encrypted event's handler function.
type SAMLSPServerEncryptedEvent func(sender *SAMLSPServer, args *SAMLSPServerEncryptedEventArgs)
func (obj *SAMLSPServer) GetOnEncryptedHandler() SAMLSPServerEncryptedEvent
func (obj *SAMLSPServer) SetOnEncryptedHandler(handlerFunc SAMLSPServerEncryptedEvent)
Remarks
The struct fires this event when processing encrypted documents to report the fact of encryption and pass certificate parameters to the user.
This event fires repeatedly for each encryption mechanism used in the document until the user provides the correct credential via the DecryptionCertificate property (depending on encryption method used), or sets SkipThis to true.
The IssuerRDN, SerialNumber, and SubjectKeyID parameters provide the details of the encryption certificate. Note that the document can be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate will invoke its own OnEncrypted event loop.
The NeedCredential parameter specifies whether the correct credential is already available to the struct or still needs to be set. One example where NeedCredential would be set to false is where it had been provided by the application prior to processing the document (e.g. by setting the DecryptionCertificate property to a known pre-defined value). If NeedCredential is set to true, you must provide the valid credential for the decryption process to succeed.
Error Event (SAMLSPServer Component)
Information about errors during data delivery.
Syntax
// SAMLSPServerErrorEventArgs carries the SAMLSPServer Error event's parameters.
type SAMLSPServerErrorEventArgs struct {...}
func (args *SAMLSPServerErrorEventArgs) ConnectionID() int64
func (args *SAMLSPServerErrorEventArgs) SessionID() string
func (args *SAMLSPServerErrorEventArgs) ErrorCode() int32
func (args *SAMLSPServerErrorEventArgs) Fatal() bool
func (args *SAMLSPServerErrorEventArgs) Remote() bool
func (args *SAMLSPServerErrorEventArgs) Description() string
// SAMLSPServerErrorEvent defines the signature of the SAMLSPServer Error event's handler function.
type SAMLSPServerErrorEvent func(sender *SAMLSPServer, args *SAMLSPServerErrorEventArgs)
func (obj *SAMLSPServer) GetOnErrorHandler() SAMLSPServerErrorEvent
func (obj *SAMLSPServer) SetOnErrorHandler(handlerFunc SAMLSPServerErrorEvent)
Remarks
The event is fired in case of exceptional conditions during message processing.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the section.
ExternalSign Event (SAMLSPServer Component)
Handles remote or external signing initiated by the server protocol.
Syntax
// SAMLSPServerExternalSignEventArgs carries the SAMLSPServer ExternalSign event's parameters.
type SAMLSPServerExternalSignEventArgs struct {...}
func (args *SAMLSPServerExternalSignEventArgs) ConnectionID() int64
func (args *SAMLSPServerExternalSignEventArgs) OperationId() string
func (args *SAMLSPServerExternalSignEventArgs) HashAlgorithm() string
func (args *SAMLSPServerExternalSignEventArgs) Pars() string
func (args *SAMLSPServerExternalSignEventArgs) Data() string
func (args *SAMLSPServerExternalSignEventArgs) SignedData() string
func (args *SAMLSPServerExternalSignEventArgs) SetSignedData(value string)
// SAMLSPServerExternalSignEvent defines the signature of the SAMLSPServer ExternalSign event's handler function.
type SAMLSPServerExternalSignEvent func(sender *SAMLSPServer, args *SAMLSPServerExternalSignEventArgs)
func (obj *SAMLSPServer) GetOnExternalSignHandler() SAMLSPServerExternalSignEvent
func (obj *SAMLSPServer) SetOnExternalSignHandler(handlerFunc SAMLSPServerExternalSignEvent)
Remarks
Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.
The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the struct via the SignedData parameter.
OperationId provides a comment about the operation and its origin. It depends on the exact struct being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.
The struct uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.
A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16
A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following:
signer.OnExternalSign += (s, e) =>
{
var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable);
var key = (RSACryptoServiceProvider)cert.PrivateKey;
var dataToSign = e.Data.FromBase16String();
var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1");
e.SignedData = signedData.ToBase16String();
};
LogoutRequestPrepared Event (SAMLSPServer Component)
This event is fired when a new logout request has been prepared.
Syntax
// SAMLSPServerLogoutRequestPreparedEventArgs carries the SAMLSPServer LogoutRequestPrepared event's parameters.
type SAMLSPServerLogoutRequestPreparedEventArgs struct {...}
func (args *SAMLSPServerLogoutRequestPreparedEventArgs) ConnectionID() int64
func (args *SAMLSPServerLogoutRequestPreparedEventArgs) SessionID() string
func (args *SAMLSPServerLogoutRequestPreparedEventArgs) RequestID() string
func (args *SAMLSPServerLogoutRequestPreparedEventArgs) Destination() string
func (args *SAMLSPServerLogoutRequestPreparedEventArgs) NameID() string
func (args *SAMLSPServerLogoutRequestPreparedEventArgs) NameIDFormat() string
func (args *SAMLSPServerLogoutRequestPreparedEventArgs) SessionIndex() string
func (args *SAMLSPServerLogoutRequestPreparedEventArgs) RelayState() string
func (args *SAMLSPServerLogoutRequestPreparedEventArgs) SetRelayState(value string)
// SAMLSPServerLogoutRequestPreparedEvent defines the signature of the SAMLSPServer LogoutRequestPrepared event's handler function.
type SAMLSPServerLogoutRequestPreparedEvent func(sender *SAMLSPServer, args *SAMLSPServerLogoutRequestPreparedEventArgs)
func (obj *SAMLSPServer) GetOnLogoutRequestPreparedHandler() SAMLSPServerLogoutRequestPreparedEvent
func (obj *SAMLSPServer) SetOnLogoutRequestPreparedHandler(handlerFunc SAMLSPServerLogoutRequestPreparedEvent)
Remarks
The component uses this event to report completion of the LogoutRequest preparation. The NameID, NameIDFormat, and SessionIndex parameters indicate the subject that is being logged out. The SP parameter references the service provider involved.
The RelayState contains the relay state value that is going to be passed with the LogoutRequest to the remote party and mirrored back (if the protocol supports it).
LogoutRequestReceived Event (SAMLSPServer Component)
The class uses this event to notify the application about an incoming SAML Logout Request message.
Syntax
// SAMLSPServerLogoutRequestReceivedEventArgs carries the SAMLSPServer LogoutRequestReceived event's parameters.
type SAMLSPServerLogoutRequestReceivedEventArgs struct {...}
func (args *SAMLSPServerLogoutRequestReceivedEventArgs) ConnectionID() int64
func (args *SAMLSPServerLogoutRequestReceivedEventArgs) SessionID() string
func (args *SAMLSPServerLogoutRequestReceivedEventArgs) RequestID() string
func (args *SAMLSPServerLogoutRequestReceivedEventArgs) Issuer() string
func (args *SAMLSPServerLogoutRequestReceivedEventArgs) IsEncrypted() bool
func (args *SAMLSPServerLogoutRequestReceivedEventArgs) IsSigned() bool
func (args *SAMLSPServerLogoutRequestReceivedEventArgs) NameID() string
func (args *SAMLSPServerLogoutRequestReceivedEventArgs) NameIDFormat() string
func (args *SAMLSPServerLogoutRequestReceivedEventArgs) SessionIndex() string
func (args *SAMLSPServerLogoutRequestReceivedEventArgs) Action() int32
func (args *SAMLSPServerLogoutRequestReceivedEventArgs) SetAction(value int32)
// SAMLSPServerLogoutRequestReceivedEvent defines the signature of the SAMLSPServer LogoutRequestReceived event's handler function.
type SAMLSPServerLogoutRequestReceivedEvent func(sender *SAMLSPServer, args *SAMLSPServerLogoutRequestReceivedEventArgs)
func (obj *SAMLSPServer) GetOnLogoutRequestReceivedHandler() SAMLSPServerLogoutRequestReceivedEvent
func (obj *SAMLSPServer) SetOnLogoutRequestReceivedHandler(handlerFunc SAMLSPServerLogoutRequestReceivedEvent)
Remarks
The SAML SP server fires this event when a SAML logout request is received at a single logout service endpoint. The NameID, NameIDFormat, and SessionIndex parameters indicate the principal that is signing out.
The application can choose to accept or reject the request, or process it manually, using the Action parameter:
| fraAuto | 1 | Handle the requested action automatically by the server |
| fraCustom | 2 | Override the action using the user code logic |
| fraAbort | 3 | Abort the requested action |
LogoutResponsePrepared Event (SAMLSPServer Component)
The class uses this event to notify the application about the Logout Response message being ready to be sent.
Syntax
// SAMLSPServerLogoutResponsePreparedEventArgs carries the SAMLSPServer LogoutResponsePrepared event's parameters.
type SAMLSPServerLogoutResponsePreparedEventArgs struct {...}
func (args *SAMLSPServerLogoutResponsePreparedEventArgs) ConnectionID() int64
func (args *SAMLSPServerLogoutResponsePreparedEventArgs) SessionID() string
func (args *SAMLSPServerLogoutResponsePreparedEventArgs) RequestID() string
func (args *SAMLSPServerLogoutResponsePreparedEventArgs) Destination() string
func (args *SAMLSPServerLogoutResponsePreparedEventArgs) Body() string
func (args *SAMLSPServerLogoutResponsePreparedEventArgs) NameID() string
func (args *SAMLSPServerLogoutResponsePreparedEventArgs) NameIDFormat() string
func (args *SAMLSPServerLogoutResponsePreparedEventArgs) SessionIndex() string
// SAMLSPServerLogoutResponsePreparedEvent defines the signature of the SAMLSPServer LogoutResponsePrepared event's handler function.
type SAMLSPServerLogoutResponsePreparedEvent func(sender *SAMLSPServer, args *SAMLSPServerLogoutResponsePreparedEventArgs)
func (obj *SAMLSPServer) GetOnLogoutResponsePreparedHandler() SAMLSPServerLogoutResponsePreparedEvent
func (obj *SAMLSPServer) SetOnLogoutResponsePreparedHandler(handlerFunc SAMLSPServerLogoutResponsePreparedEvent)
Remarks
The IdP server fires this event when it has prepared a Logout Response message and is ready to send it out to the SP.
LogoutResponseReceived Event (SAMLSPServer Component)
The class uses this event to notify the application about an incoming SAML LogoutResponse message.
Syntax
// SAMLSPServerLogoutResponseReceivedEventArgs carries the SAMLSPServer LogoutResponseReceived event's parameters.
type SAMLSPServerLogoutResponseReceivedEventArgs struct {...}
func (args *SAMLSPServerLogoutResponseReceivedEventArgs) ConnectionID() int64
func (args *SAMLSPServerLogoutResponseReceivedEventArgs) SessionID() string
func (args *SAMLSPServerLogoutResponseReceivedEventArgs) RequestID() string
func (args *SAMLSPServerLogoutResponseReceivedEventArgs) Issuer() string
func (args *SAMLSPServerLogoutResponseReceivedEventArgs) IsEncrypted() bool
func (args *SAMLSPServerLogoutResponseReceivedEventArgs) IsSigned() bool
func (args *SAMLSPServerLogoutResponseReceivedEventArgs) NameID() string
func (args *SAMLSPServerLogoutResponseReceivedEventArgs) NameIDFormat() string
func (args *SAMLSPServerLogoutResponseReceivedEventArgs) SessionIndex() string
func (args *SAMLSPServerLogoutResponseReceivedEventArgs) RelayState() string
func (args *SAMLSPServerLogoutResponseReceivedEventArgs) Action() int32
func (args *SAMLSPServerLogoutResponseReceivedEventArgs) SetAction(value int32)
// SAMLSPServerLogoutResponseReceivedEvent defines the signature of the SAMLSPServer LogoutResponseReceived event's handler function.
type SAMLSPServerLogoutResponseReceivedEvent func(sender *SAMLSPServer, args *SAMLSPServerLogoutResponseReceivedEventArgs)
func (obj *SAMLSPServer) GetOnLogoutResponseReceivedHandler() SAMLSPServerLogoutResponseReceivedEvent
func (obj *SAMLSPServer) SetOnLogoutResponseReceivedHandler(handlerFunc SAMLSPServerLogoutResponseReceivedEvent)
Remarks
The SAML SP server fires this event when a SAML logout response is received at a single logout service endpoint following the LogoutRequest sent earlier. The RelayState is a mirrored back value included in the request.
The NameID, NameIDFormat, and SessionIndex parameters indicate the principal that is signing out.
The application can choose to accept or reject the request, or process it manually, using the Action parameter:
| fraAuto | 1 | Handle the requested action automatically by the server |
| fraCustom | 2 | Override the action using the user code logic |
| fraAbort | 3 | Abort the requested action |
Notification Event (SAMLSPServer Component)
This event notifies the application about an underlying control flow event.
Syntax
// SAMLSPServerNotificationEventArgs carries the SAMLSPServer Notification event's parameters.
type SAMLSPServerNotificationEventArgs struct {...}
func (args *SAMLSPServerNotificationEventArgs) EventID() string
func (args *SAMLSPServerNotificationEventArgs) EventParam() string
// SAMLSPServerNotificationEvent defines the signature of the SAMLSPServer Notification event's handler function.
type SAMLSPServerNotificationEvent func(sender *SAMLSPServer, args *SAMLSPServerNotificationEventArgs)
func (obj *SAMLSPServer) GetOnNotificationHandler() SAMLSPServerNotificationEvent
func (obj *SAMLSPServer) SetOnNotificationHandler(handlerFunc SAMLSPServerNotificationEvent)
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.
This struct can fire this event with the following EventID values:
| SAMLResponderError | TBD |
| SAMLSessionLogout | TBD |
| ListeningStarted | Notifies the application that the server has started listening for incoming connections. |
| ListeningStopped | Notifies the application that the server has stopped listening to incoming connections. |
ProcessingCompleted Event (SAMLSPServer Component)
This event notifies the application of the completion of request or response processing.
Syntax
// SAMLSPServerProcessingCompletedEventArgs carries the SAMLSPServer ProcessingCompleted event's parameters.
type SAMLSPServerProcessingCompletedEventArgs struct {...}
func (args *SAMLSPServerProcessingCompletedEventArgs) ConnectionID() int64
func (args *SAMLSPServerProcessingCompletedEventArgs) SessionID() string
func (args *SAMLSPServerProcessingCompletedEventArgs) Tag() string
func (args *SAMLSPServerProcessingCompletedEventArgs) ProcessingResult() int32
func (args *SAMLSPServerProcessingCompletedEventArgs) Response() string
func (args *SAMLSPServerProcessingCompletedEventArgs) Redirect() bool
// SAMLSPServerProcessingCompletedEvent defines the signature of the SAMLSPServer ProcessingCompleted event's handler function.
type SAMLSPServerProcessingCompletedEvent func(sender *SAMLSPServer, args *SAMLSPServerProcessingCompletedEventArgs)
func (obj *SAMLSPServer) GetOnProcessingCompletedHandler() SAMLSPServerProcessingCompletedEvent
func (obj *SAMLSPServer) SetOnProcessingCompletedHandler(handlerFunc SAMLSPServerProcessingCompletedEvent)
Remarks
The component fires ProcessingCompleted to notify the application about completion of an earlier initiated processing operation. It is only fired in OfflineMode in response to calls such as ProcessAssertion, ProcessLogoutRequest, or similar. The main purpose of this event is to notify the application of the outcomes of the processing and return any prepared SAML entity for subsequent relay to the browser.
This event is fired strictly once for each Process* call, with the ConnectionID matching the value passed to the Process* method.
The SessionID parameter contains the identifier of the current virtual session. It may differ to the value passed to the Process* method if the session information was provided on the fly via the SessionInfoNeeded event. The ProcessingResult indicates the type of deliverable that was created during the processing (see below for possible values). The Response parameter contains the body of the deliverable. This can take one of the forms:
- a self-submitting form containing a SAML message.
- a redirect URL.
- a SOAP XML response.
- an empty string if ProcessingResult is set to sprSuccess.
The Redirect parameter indicates whether the value of Response should be passed to the browser within the 302 Location header, or as a document body.
| sprUnknown | 0 | Unknown or undefined processing result |
| sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
| sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
| sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
| sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
| sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
| sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
ReadArtifact Event (SAMLSPServer Component)
Requests content identified by an artifact from the application.
Syntax
// SAMLSPServerReadArtifactEventArgs carries the SAMLSPServer ReadArtifact event's parameters.
type SAMLSPServerReadArtifactEventArgs struct {...}
func (args *SAMLSPServerReadArtifactEventArgs) ConnectionID() int64
func (args *SAMLSPServerReadArtifactEventArgs) SessionID() string
func (args *SAMLSPServerReadArtifactEventArgs) RequestID() string
func (args *SAMLSPServerReadArtifactEventArgs) Issuer() string
func (args *SAMLSPServerReadArtifactEventArgs) Artifact() string
func (args *SAMLSPServerReadArtifactEventArgs) Value() string
func (args *SAMLSPServerReadArtifactEventArgs) SetValue(value string)
func (args *SAMLSPServerReadArtifactEventArgs) Skip() bool
func (args *SAMLSPServerReadArtifactEventArgs) SetSkip(value bool)
// SAMLSPServerReadArtifactEvent defines the signature of the SAMLSPServer ReadArtifact event's handler function.
type SAMLSPServerReadArtifactEvent func(sender *SAMLSPServer, args *SAMLSPServerReadArtifactEventArgs)
func (obj *SAMLSPServer) GetOnReadArtifactHandler() SAMLSPServerReadArtifactEvent
func (obj *SAMLSPServer) SetOnReadArtifactHandler(handlerFunc SAMLSPServerReadArtifactEvent)
Remarks
The component fires this event to request the content matching Artifact from the application. This is normally happens within the artifact resolution protocol between the SP and the IdP server.
The application must provide the requested artifact content via the Value parameter. The application can choose not to provide the artifact content (for example, if it doesn't have it) by setting Skip to true.
ResourceClose Event (SAMLSPServer Component)
Tells the application that it can close the opened resource.
Syntax
// SAMLSPServerResourceCloseEventArgs carries the SAMLSPServer ResourceClose event's parameters.
type SAMLSPServerResourceCloseEventArgs struct {...}
func (args *SAMLSPServerResourceCloseEventArgs) ConnectionID() int64
func (args *SAMLSPServerResourceCloseEventArgs) SessionID() string
func (args *SAMLSPServerResourceCloseEventArgs) Handle() string
// SAMLSPServerResourceCloseEvent defines the signature of the SAMLSPServer ResourceClose event's handler function.
type SAMLSPServerResourceCloseEvent func(sender *SAMLSPServer, args *SAMLSPServerResourceCloseEventArgs)
func (obj *SAMLSPServer) GetOnResourceCloseHandler() SAMLSPServerResourceCloseEvent
func (obj *SAMLSPServer) SetOnResourceCloseHandler(handlerFunc SAMLSPServerResourceCloseEvent)
Remarks
The struct uses this event to notify the application that it can now close the resource opened earlier in its ResourceOpen handler.
ResourceOpen Event (SAMLSPServer Component)
Requests the application to open the requested resource.
Syntax
// SAMLSPServerResourceOpenEventArgs carries the SAMLSPServer ResourceOpen event's parameters.
type SAMLSPServerResourceOpenEventArgs struct {...}
func (args *SAMLSPServerResourceOpenEventArgs) ConnectionID() int64
func (args *SAMLSPServerResourceOpenEventArgs) SessionID() string
func (args *SAMLSPServerResourceOpenEventArgs) URL() string
func (args *SAMLSPServerResourceOpenEventArgs) HttpMethod() string
func (args *SAMLSPServerResourceOpenEventArgs) OperationStatus() int32
func (args *SAMLSPServerResourceOpenEventArgs) SetOperationStatus(value int32)
func (args *SAMLSPServerResourceOpenEventArgs) Handle() string
func (args *SAMLSPServerResourceOpenEventArgs) SetHandle(value string)
// SAMLSPServerResourceOpenEvent defines the signature of the SAMLSPServer ResourceOpen event's handler function.
type SAMLSPServerResourceOpenEvent func(sender *SAMLSPServer, args *SAMLSPServerResourceOpenEventArgs)
func (obj *SAMLSPServer) GetOnResourceOpenHandler() SAMLSPServerResourceOpenEvent
func (obj *SAMLSPServer) SetOnResourceOpenHandler(handlerFunc SAMLSPServerResourceOpenEvent)
Remarks
The struct fires this event in virtualized mode if the application had returned the fraCustom modifier from the earlier ResourceRequest event call. Your code is expected to open the requested resource and be prepared to read from it in subsequent ResourceRead event calls. Check the operation status, and alter it, if needed, through the OperationStatus parameter:
| ostOk | 1 | |
| ostNoSuchFile | 2 | |
| ostAccessDenied | 3 | |
| ostWriteProtect | 4 | |
| ostUnsupported | 5 | |
| ostInvalidParameter | 6 | |
| ostEOF | 7 |
ResourceRead Event (SAMLSPServer Component)
Requests the application to read from an opened resource.
Syntax
// SAMLSPServerResourceReadEventArgs carries the SAMLSPServer ResourceRead event's parameters.
type SAMLSPServerResourceReadEventArgs struct {...}
func (args *SAMLSPServerResourceReadEventArgs) ConnectionID() int64
func (args *SAMLSPServerResourceReadEventArgs) SessionID() string
func (args *SAMLSPServerResourceReadEventArgs) Handle() string
func (args *SAMLSPServerResourceReadEventArgs) Size() int32
func (args *SAMLSPServerResourceReadEventArgs) OperationStatus() int32
func (args *SAMLSPServerResourceReadEventArgs) SetOperationStatus(value int32)
// SAMLSPServerResourceReadEvent defines the signature of the SAMLSPServer ResourceRead event's handler function.
type SAMLSPServerResourceReadEvent func(sender *SAMLSPServer, args *SAMLSPServerResourceReadEventArgs)
func (obj *SAMLSPServer) GetOnResourceReadHandler() SAMLSPServerResourceReadEvent
func (obj *SAMLSPServer) SetOnResourceReadHandler(handlerFunc SAMLSPServerResourceReadEvent)
Remarks
The struct fires this event in virtualized mode to request another chunk of data from the resource opened earlier. The handler of this event should read up to Size bytes from the object, and pass them to the component with a SetClientBuffer call.
Use the OperationStatus parameter to return the operation result back to the server. When the file has been read up to its end, set OperationStatus to ostEOF to tell the components that no more ResourceRead calls are needed.
Set OperationStatus to one of the following values:
| ostOk | 1 | |
| ostNoSuchFile | 2 | |
| ostAccessDenied | 3 | |
| ostWriteProtect | 4 | |
| ostUnsupported | 5 | |
| ostInvalidParameter | 6 | |
| ostEOF | 7 |
ResourceRequest Event (SAMLSPServer Component)
Notifies the application that a server resource is requested.
Syntax
// SAMLSPServerResourceRequestEventArgs carries the SAMLSPServer ResourceRequest event's parameters.
type SAMLSPServerResourceRequestEventArgs struct {...}
func (args *SAMLSPServerResourceRequestEventArgs) ConnectionID() int64
func (args *SAMLSPServerResourceRequestEventArgs) SessionID() string
func (args *SAMLSPServerResourceRequestEventArgs) URL() string
func (args *SAMLSPServerResourceRequestEventArgs) HttpMethod() string
func (args *SAMLSPServerResourceRequestEventArgs) ResProtected() bool
func (args *SAMLSPServerResourceRequestEventArgs) SetResProtected(value bool)
func (args *SAMLSPServerResourceRequestEventArgs) ResSpecial() bool
func (args *SAMLSPServerResourceRequestEventArgs) SetResSpecial(value bool)
func (args *SAMLSPServerResourceRequestEventArgs) AllowWriting() bool
func (args *SAMLSPServerResourceRequestEventArgs) SetAllowWriting(value bool)
func (args *SAMLSPServerResourceRequestEventArgs) Action() int32
func (args *SAMLSPServerResourceRequestEventArgs) SetAction(value int32)
// SAMLSPServerResourceRequestEvent defines the signature of the SAMLSPServer ResourceRequest event's handler function.
type SAMLSPServerResourceRequestEvent func(sender *SAMLSPServer, args *SAMLSPServerResourceRequestEventArgs)
func (obj *SAMLSPServer) GetOnResourceRequestHandler() SAMLSPServerResourceRequestEvent
func (obj *SAMLSPServer) SetOnResourceRequestHandler(handlerFunc SAMLSPServerResourceRequestEvent)
Remarks
The struct uses this event to notify the application that the connection has requested a server resource.
The URL parameter specifies the resource requested. ResProtected is set to true if the resource is protected by SAML. ResSpecial is set to true if the request is a SAML resource, such as the metadata or an Assertion Consumer Service page. ConnectionID identifies the connected client.
Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code ('virtualize' the request).
Choose Action as one of the following values:
| fraAuto | 1 | Handle the requested action automatically by the server |
| fraCustom | 2 | Override the action using the user code logic |
| fraAbort | 3 | Abort the requested action |
ResourceWrite Event (SAMLSPServer Component)
Requests the application to write to an opened resource.
Syntax
// SAMLSPServerResourceWriteEventArgs carries the SAMLSPServer ResourceWrite event's parameters.
type SAMLSPServerResourceWriteEventArgs struct {...}
func (args *SAMLSPServerResourceWriteEventArgs) ConnectionID() int64
func (args *SAMLSPServerResourceWriteEventArgs) SessionID() string
func (args *SAMLSPServerResourceWriteEventArgs) Handle() string
func (args *SAMLSPServerResourceWriteEventArgs) OperationStatus() int32
func (args *SAMLSPServerResourceWriteEventArgs) SetOperationStatus(value int32)
// SAMLSPServerResourceWriteEvent defines the signature of the SAMLSPServer ResourceWrite event's handler function.
type SAMLSPServerResourceWriteEvent func(sender *SAMLSPServer, args *SAMLSPServerResourceWriteEventArgs)
func (obj *SAMLSPServer) GetOnResourceWriteHandler() SAMLSPServerResourceWriteEvent
func (obj *SAMLSPServer) SetOnResourceWriteHandler(handlerFunc SAMLSPServerResourceWriteEvent)
Remarks
The struct fires this event in virtualized mode to pass another chunk of data to a resource opened earlier. This event is called for write-enabled requests, such as POST or PUT. The handler of this event should read the pending data using the GetClientBuffer method and write them to the opened file descriptor.
Use the OperationStatus parameter to return the operation result back to the server:
| ostOk | 1 | |
| ostNoSuchFile | 2 | |
| ostAccessDenied | 3 | |
| ostWriteProtect | 4 | |
| ostUnsupported | 5 | |
| ostInvalidParameter | 6 | |
| ostEOF | 7 |
SAMLMessagePrepared Event (SAMLSPServer Component)
This event is fired when a SAML message has been prepared and is ready to be dispatched.
Syntax
// SAMLSPServerSAMLMessagePreparedEventArgs carries the SAMLSPServer SAMLMessagePrepared event's parameters.
type SAMLSPServerSAMLMessagePreparedEventArgs struct {...}
func (args *SAMLSPServerSAMLMessagePreparedEventArgs) ConnectionID() int64
func (args *SAMLSPServerSAMLMessagePreparedEventArgs) SessionID() string
func (args *SAMLSPServerSAMLMessagePreparedEventArgs) MessageID() string
func (args *SAMLSPServerSAMLMessagePreparedEventArgs) Destination() string
func (args *SAMLSPServerSAMLMessagePreparedEventArgs) IssueInstant() string
func (args *SAMLSPServerSAMLMessagePreparedEventArgs) InResponseTo() string
func (args *SAMLSPServerSAMLMessagePreparedEventArgs) RequestBody() string
func (args *SAMLSPServerSAMLMessagePreparedEventArgs) MessageType() string
func (args *SAMLSPServerSAMLMessagePreparedEventArgs) MessageBody() string
func (args *SAMLSPServerSAMLMessagePreparedEventArgs) SetMessageBody(value string)
func (args *SAMLSPServerSAMLMessagePreparedEventArgs) RelayState() string
func (args *SAMLSPServerSAMLMessagePreparedEventArgs) SetRelayState(value string)
func (args *SAMLSPServerSAMLMessagePreparedEventArgs) Success() bool
func (args *SAMLSPServerSAMLMessagePreparedEventArgs) SetSuccess(value bool)
// SAMLSPServerSAMLMessagePreparedEvent defines the signature of the SAMLSPServer SAMLMessagePrepared event's handler function.
type SAMLSPServerSAMLMessagePreparedEvent func(sender *SAMLSPServer, args *SAMLSPServerSAMLMessagePreparedEventArgs)
func (obj *SAMLSPServer) GetOnSAMLMessagePreparedHandler() SAMLSPServerSAMLMessagePreparedEvent
func (obj *SAMLSPServer) SetOnSAMLMessagePreparedHandler(handlerFunc SAMLSPServerSAMLMessagePreparedEvent)
Remarks
Subscribe to this event to be notified about every SAML message that has been prepared by the server. This event is fired for every type of the outgoing message (e.g. SAMLResponse or LogoutRequest). The InResponseTo contains the ID of the message in response to which the current message is sent (if applicable). The RequestBody parameter contains the body of such request.
The MessageType parameter indicates the type of the message that has been prepared, such as SAMLResponse. The MessageBody contains the XML body of the message. The Success parameter indicates whether the message contains a positive statement or an error. Both the MessageBody and Success parameters are adjustable.
SAMLMessageReceived Event (SAMLSPServer Component)
The server fires this event for every SAML message it receives.
Syntax
// SAMLSPServerSAMLMessageReceivedEventArgs carries the SAMLSPServer SAMLMessageReceived event's parameters.
type SAMLSPServerSAMLMessageReceivedEventArgs struct {...}
func (args *SAMLSPServerSAMLMessageReceivedEventArgs) ConnectionID() int64
func (args *SAMLSPServerSAMLMessageReceivedEventArgs) SessionID() string
func (args *SAMLSPServerSAMLMessageReceivedEventArgs) MessageID() string
func (args *SAMLSPServerSAMLMessageReceivedEventArgs) Issuer() string
func (args *SAMLSPServerSAMLMessageReceivedEventArgs) IssueInstant() string
func (args *SAMLSPServerSAMLMessageReceivedEventArgs) InResponseTo() string
func (args *SAMLSPServerSAMLMessageReceivedEventArgs) RequestBody() string
func (args *SAMLSPServerSAMLMessageReceivedEventArgs) MessageType() string
func (args *SAMLSPServerSAMLMessageReceivedEventArgs) MessageBody() string
func (args *SAMLSPServerSAMLMessageReceivedEventArgs) IsSigned() bool
func (args *SAMLSPServerSAMLMessageReceivedEventArgs) RelayState() string
func (args *SAMLSPServerSAMLMessageReceivedEventArgs) Action() int32
func (args *SAMLSPServerSAMLMessageReceivedEventArgs) SetAction(value int32)
// SAMLSPServerSAMLMessageReceivedEvent defines the signature of the SAMLSPServer SAMLMessageReceived event's handler function.
type SAMLSPServerSAMLMessageReceivedEvent func(sender *SAMLSPServer, args *SAMLSPServerSAMLMessageReceivedEventArgs)
func (obj *SAMLSPServer) GetOnSAMLMessageReceivedHandler() SAMLSPServerSAMLMessageReceivedEvent
func (obj *SAMLSPServer) SetOnSAMLMessageReceivedHandler(handlerFunc SAMLSPServerSAMLMessageReceivedEvent)
Remarks
Subscribe to this event to be notified about incoming SAML messages.
The MessageType, MessageID, Issuer, and MessageBody parameters provide the details of the message received. The RequestBody and InResponseTo contain a reference to the request that this message is a response to (if any).
Set Action property as required to let the component know how to proceed.
| fraAuto | 1 | Handle the requested action automatically by the server |
| fraCustom | 2 | Override the action using the user code logic |
| fraAbort | 3 | Abort the requested action |
SessionCreated Event (SAMLSPServer Component)
This event is fired when a new session has been established.
Syntax
// SAMLSPServerSessionCreatedEventArgs carries the SAMLSPServer SessionCreated event's parameters.
type SAMLSPServerSessionCreatedEventArgs struct {...}
func (args *SAMLSPServerSessionCreatedEventArgs) ConnectionID() int64
func (args *SAMLSPServerSessionCreatedEventArgs) SessionID() string
// SAMLSPServerSessionCreatedEvent defines the signature of the SAMLSPServer SessionCreated event's handler function.
type SAMLSPServerSessionCreatedEvent func(sender *SAMLSPServer, args *SAMLSPServerSessionCreatedEventArgs)
func (obj *SAMLSPServer) GetOnSessionCreatedHandler() SAMLSPServerSessionCreatedEvent
func (obj *SAMLSPServer) SetOnSessionCreatedHandler(handlerFunc SAMLSPServerSessionCreatedEvent)
Remarks
ConnectionID contains the identifier of the new session, SessionID specifies the ID of the new session.
SessionDestroyed Event (SAMLSPServer Component)
This event is fired when the SP server has closed a session.
Syntax
// SAMLSPServerSessionDestroyedEventArgs carries the SAMLSPServer SessionDestroyed event's parameters.
type SAMLSPServerSessionDestroyedEventArgs struct {...}
func (args *SAMLSPServerSessionDestroyedEventArgs) ConnectionID() int64
func (args *SAMLSPServerSessionDestroyedEventArgs) SessionID() string
// SAMLSPServerSessionDestroyedEvent defines the signature of the SAMLSPServer SessionDestroyed event's handler function.
type SAMLSPServerSessionDestroyedEvent func(sender *SAMLSPServer, args *SAMLSPServerSessionDestroyedEventArgs)
func (obj *SAMLSPServer) GetOnSessionDestroyedHandler() SAMLSPServerSessionDestroyedEvent
func (obj *SAMLSPServer) SetOnSessionDestroyedHandler(handlerFunc SAMLSPServerSessionDestroyedEvent)
Remarks
ConnectionID contains the identifier of the closed session.
SessionEvent Event (SAMLSPServer Component)
Notifies the application about SAML session events.
Syntax
// SAMLSPServerSessionEventEventArgs carries the SAMLSPServer SessionEvent event's parameters.
type SAMLSPServerSessionEventEventArgs struct {...}
func (args *SAMLSPServerSessionEventEventArgs) ConnectionID() int64
func (args *SAMLSPServerSessionEventEventArgs) SessionID() string
func (args *SAMLSPServerSessionEventEventArgs) EventText() string
// SAMLSPServerSessionEventEvent defines the signature of the SAMLSPServer SessionEvent event's handler function.
type SAMLSPServerSessionEventEvent func(sender *SAMLSPServer, args *SAMLSPServerSessionEventEventArgs)
func (obj *SAMLSPServer) GetOnSessionEventHandler() SAMLSPServerSessionEventEvent
func (obj *SAMLSPServer) SetOnSessionEventHandler(handlerFunc SAMLSPServerSessionEventEvent)
Remarks
struct uses this event to notify your code about events that happen within the lifeline of a SAML session. Handling it may be useful for development, logging, and monitoring purposes.
The SessionID parameter specifies the session ID, and the EventText parameter describes the event that happened. Below are a few typical examples of what EventText you can expect to get:
- Start
- AuthnRequestPrepared
- ResponseReceived
- ResourceSupplied
- LogoutRequestPrepared
- LogoutResponseReceived
- LogoutRequestReceived
- LogoutResponsePrepared
- ArtifactResolveRequestReceived
- ArtifactResponsePrepared
- Finish
SessionInfoNeeded Event (SAMLSPServer Component)
This event is fired in OfflineMode to request the session ID for the current flow.
Syntax
// SAMLSPServerSessionInfoNeededEventArgs carries the SAMLSPServer SessionInfoNeeded event's parameters.
type SAMLSPServerSessionInfoNeededEventArgs struct {...}
func (args *SAMLSPServerSessionInfoNeededEventArgs) ConnectionID() int64
func (args *SAMLSPServerSessionInfoNeededEventArgs) SessionID() string
func (args *SAMLSPServerSessionInfoNeededEventArgs) SetSessionID(value string)
// SAMLSPServerSessionInfoNeededEvent defines the signature of the SAMLSPServer SessionInfoNeeded event's handler function.
type SAMLSPServerSessionInfoNeededEvent func(sender *SAMLSPServer, args *SAMLSPServerSessionInfoNeededEventArgs)
func (obj *SAMLSPServer) GetOnSessionInfoNeededHandler() SAMLSPServerSessionInfoNeededEvent
func (obj *SAMLSPServer) SetOnSessionInfoNeededHandler(handlerFunc SAMLSPServerSessionInfoNeededEvent)
Remarks
SAML protocol is stateful, which means that SAML services need to keep session-related information between connections. When used in online mode - where the components listen and serve connections automatically - the components can use HTTP cookies to track connecting clients and maintain the session store at the background. However, when used in offline mode, the components do not have access to the HTTP layer and live too short for the session store to survive. That is why in offline mode the components rely on the application code to keep the session information for them.
The components use a collection of Session* events to exchange session information with the application:
- SessionCreated is called when the component establishes a new session. In offline mode, the application should associate the session ID with the connected user, for example by returning it as a cookie.
- SessionStateSave : the component passes the session state to the application and expects that the application saves it somewhere to return it back to the component at its request at some point in the future. The session state is an opaque string. The application can use a hash table to store a collection of (SessionID, SessionState) pairs over the lifetime of the SAML service. The server may fire SessionStateSave multiple times for the same SessionID. If this happens, the existing SessionID entry should be overwritten with the fresh session data.
- SessionStateRetrieve : the component passes a session ID to the application and expects it to return the session state saved in the hash table earlier. The application should not delete the state from the hash table, as it may be needed again.
- SessionInfoNeeded (this event): the component expects the application to return the session ID corresponding to the connection ID back to them. This event fires, for example, if the application calls ProcessLogoutRequest but passes an empty SessionID as a parameter.
- SessionDestroyed is called when a session is destroyed. The component can remove the session from the hash table upon receiving this event.
SessionStateRetrieve Event (SAMLSPServer Component)
This event fires to retrieve session state information from the application.
Syntax
// SAMLSPServerSessionStateRetrieveEventArgs carries the SAMLSPServer SessionStateRetrieve event's parameters.
type SAMLSPServerSessionStateRetrieveEventArgs struct {...}
func (args *SAMLSPServerSessionStateRetrieveEventArgs) ConnectionID() int64
func (args *SAMLSPServerSessionStateRetrieveEventArgs) SessionID() string
func (args *SAMLSPServerSessionStateRetrieveEventArgs) SessionState() string
func (args *SAMLSPServerSessionStateRetrieveEventArgs) SetSessionState(value string)
// SAMLSPServerSessionStateRetrieveEvent defines the signature of the SAMLSPServer SessionStateRetrieve event's handler function.
type SAMLSPServerSessionStateRetrieveEvent func(sender *SAMLSPServer, args *SAMLSPServerSessionStateRetrieveEventArgs)
func (obj *SAMLSPServer) GetOnSessionStateRetrieveHandler() SAMLSPServerSessionStateRetrieveEvent
func (obj *SAMLSPServer) SetOnSessionStateRetrieveHandler(handlerFunc SAMLSPServerSessionStateRetrieveEvent)
Remarks
The component fires this event to request a session state that was previously provided to the application via the SessionStateSave call.
See the SessionInfoNeeded topic for more details about session management in offline mode.
SessionStateSave Event (SAMLSPServer Component)
This event passes a session state object to the application for safekeeping.
Syntax
// SAMLSPServerSessionStateSaveEventArgs carries the SAMLSPServer SessionStateSave event's parameters.
type SAMLSPServerSessionStateSaveEventArgs struct {...}
func (args *SAMLSPServerSessionStateSaveEventArgs) ConnectionID() int64
func (args *SAMLSPServerSessionStateSaveEventArgs) SessionID() string
func (args *SAMLSPServerSessionStateSaveEventArgs) SessionState() string
// SAMLSPServerSessionStateSaveEvent defines the signature of the SAMLSPServer SessionStateSave event's handler function.
type SAMLSPServerSessionStateSaveEvent func(sender *SAMLSPServer, args *SAMLSPServerSessionStateSaveEventArgs)
func (obj *SAMLSPServer) GetOnSessionStateSaveHandler() SAMLSPServerSessionStateSaveEvent
func (obj *SAMLSPServer) SetOnSessionStateSaveHandler(handlerFunc SAMLSPServerSessionStateSaveEvent)
Remarks
The component fires this event to pass a session state to the application. The application is expected to save the state object (which is an opaque string) in a hash table, and be ready to return it back to the component when it requests it using a SessionStateRetrieve call.
See the SessionInfoNeeded topic for more details about session management in offline mode.
SignatureFound Event (SAMLSPServer Component)
Signifies the start of signature validation.
Syntax
// SAMLSPServerSignatureFoundEventArgs carries the SAMLSPServer SignatureFound event's parameters.
type SAMLSPServerSignatureFoundEventArgs struct {...}
func (args *SAMLSPServerSignatureFoundEventArgs) ConnectionID() int64
func (args *SAMLSPServerSignatureFoundEventArgs) SessionID() string
func (args *SAMLSPServerSignatureFoundEventArgs) Scope() int32
func (args *SAMLSPServerSignatureFoundEventArgs) Signer() string
func (args *SAMLSPServerSignatureFoundEventArgs) TargetID() string
func (args *SAMLSPServerSignatureFoundEventArgs) TargetType() string
func (args *SAMLSPServerSignatureFoundEventArgs) IssuerRDN() string
func (args *SAMLSPServerSignatureFoundEventArgs) SerialNumber() []byte
func (args *SAMLSPServerSignatureFoundEventArgs) SubjectKeyID() []byte
func (args *SAMLSPServerSignatureFoundEventArgs) SigMethod() string
func (args *SAMLSPServerSignatureFoundEventArgs) DigestMethod() string
func (args *SAMLSPServerSignatureFoundEventArgs) CertFound() bool
func (args *SAMLSPServerSignatureFoundEventArgs) Validate() bool
func (args *SAMLSPServerSignatureFoundEventArgs) SetValidate(value bool)
// SAMLSPServerSignatureFoundEvent defines the signature of the SAMLSPServer SignatureFound event's handler function.
type SAMLSPServerSignatureFoundEvent func(sender *SAMLSPServer, args *SAMLSPServerSignatureFoundEventArgs)
func (obj *SAMLSPServer) GetOnSignatureFoundHandler() SAMLSPServerSignatureFoundEvent
func (obj *SAMLSPServer) SetOnSignatureFoundHandler(handlerFunc SAMLSPServerSignatureFoundEvent)
Remarks
This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified message.
The Scope parameter specifies the subject of the signature. This can be the outermost SAML message or an embedded assertion.
| sssUnknown | 0 | The scope of signature is unknown |
| sssMessage | 1 | The signature covers the entire SAML message |
| sssAssertion | 2 | The signature covers an assertion |
| sssBinding | 3 | The signature covers the binding |
The details of the reported signature are populated in the Security object. For assertion signatures, you can update the details by pinning the assertion.
The CertFound is set to True if the struct has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via KnownCertificates property.
Signature validation consists of two independent stages: cryptographic signature validation and chain validation. SAMLReader only supports signature validation. To validate the chain, grab the signing certificate from the SigningCertificate property and the associated certificates from the Certificates collection, and pass them to the CertificateValidator component to validate its chain.
Use the Validate parameter to tell the reader whether it should validate the signature.
SignatureValidated Event (SAMLSPServer Component)
Reports the signature validation result.
Syntax
// SAMLSPServerSignatureValidatedEventArgs carries the SAMLSPServer SignatureValidated event's parameters.
type SAMLSPServerSignatureValidatedEventArgs struct {...}
func (args *SAMLSPServerSignatureValidatedEventArgs) ConnectionID() int64
func (args *SAMLSPServerSignatureValidatedEventArgs) SessionID() string
func (args *SAMLSPServerSignatureValidatedEventArgs) Scope() int32
func (args *SAMLSPServerSignatureValidatedEventArgs) Signer() string
func (args *SAMLSPServerSignatureValidatedEventArgs) TargetID() string
func (args *SAMLSPServerSignatureValidatedEventArgs) TargetType() string
func (args *SAMLSPServerSignatureValidatedEventArgs) IssuerRDN() string
func (args *SAMLSPServerSignatureValidatedEventArgs) SerialNumber() []byte
func (args *SAMLSPServerSignatureValidatedEventArgs) SubjectKeyID() []byte
func (args *SAMLSPServerSignatureValidatedEventArgs) SigMethod() string
func (args *SAMLSPServerSignatureValidatedEventArgs) DigestMethod() string
func (args *SAMLSPServerSignatureValidatedEventArgs) ValidationResult() int32
func (args *SAMLSPServerSignatureValidatedEventArgs) SetValidationResult(value int32)
// SAMLSPServerSignatureValidatedEvent defines the signature of the SAMLSPServer SignatureValidated event's handler function.
type SAMLSPServerSignatureValidatedEvent func(sender *SAMLSPServer, args *SAMLSPServerSignatureValidatedEventArgs)
func (obj *SAMLSPServer) GetOnSignatureValidatedHandler() SAMLSPServerSignatureValidatedEvent
func (obj *SAMLSPServer) SetOnSignatureValidatedHandler(handlerFunc SAMLSPServerSignatureValidatedEvent)
Remarks
This event is fired when the complete XML signature validation process is finished.
The Scope parameter specifies the subject of the signature. This can be the outermost SAML message or an embedded assertion.
| sssUnknown | 0 | The scope of signature is unknown |
| sssMessage | 1 | The signature covers the entire SAML message |
| sssAssertion | 2 | The signature covers an assertion |
| sssBinding | 3 | The signature covers the binding |
| 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) |
TLSCertValidate Event (SAMLSPServer Component)
Fires when a client certificate needs to be validated.
Syntax
// SAMLSPServerTLSCertValidateEventArgs carries the SAMLSPServer TLSCertValidate event's parameters.
type SAMLSPServerTLSCertValidateEventArgs struct {...}
func (args *SAMLSPServerTLSCertValidateEventArgs) ConnectionID() int64
func (args *SAMLSPServerTLSCertValidateEventArgs) Accept() bool
func (args *SAMLSPServerTLSCertValidateEventArgs) SetAccept(value bool)
// SAMLSPServerTLSCertValidateEvent defines the signature of the SAMLSPServer TLSCertValidate event's handler function.
type SAMLSPServerTLSCertValidateEvent func(sender *SAMLSPServer, args *SAMLSPServerTLSCertValidateEventArgs)
func (obj *SAMLSPServer) GetOnTLSCertValidateHandler() SAMLSPServerTLSCertValidateEvent
func (obj *SAMLSPServer) SetOnTLSCertValidateHandler(handlerFunc SAMLSPServerTLSCertValidateEvent)
Remarks
The struct fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the Accept parameter.
TLSEstablished Event (SAMLSPServer Component)
Reports the setup of a TLS session.
Syntax
// SAMLSPServerTLSEstablishedEventArgs carries the SAMLSPServer TLSEstablished event's parameters.
type SAMLSPServerTLSEstablishedEventArgs struct {...}
func (args *SAMLSPServerTLSEstablishedEventArgs) ConnectionID() int64
// SAMLSPServerTLSEstablishedEvent defines the signature of the SAMLSPServer TLSEstablished event's handler function.
type SAMLSPServerTLSEstablishedEvent func(sender *SAMLSPServer, args *SAMLSPServerTLSEstablishedEventArgs)
func (obj *SAMLSPServer) GetOnTLSEstablishedHandler() SAMLSPServerTLSEstablishedEvent
func (obj *SAMLSPServer) SetOnTLSEstablishedHandler(handlerFunc SAMLSPServerTLSEstablishedEvent)
Remarks
Subscribe to this event to be notified about the setup of a TLS connection by a connected client.
TLSHandshake Event (SAMLSPServer Component)
Fires when a newly established client connection initiates a TLS handshake.
Syntax
// SAMLSPServerTLSHandshakeEventArgs carries the SAMLSPServer TLSHandshake event's parameters.
type SAMLSPServerTLSHandshakeEventArgs struct {...}
func (args *SAMLSPServerTLSHandshakeEventArgs) ConnectionID() int64
func (args *SAMLSPServerTLSHandshakeEventArgs) ServerName() string
func (args *SAMLSPServerTLSHandshakeEventArgs) Abort() bool
func (args *SAMLSPServerTLSHandshakeEventArgs) SetAbort(value bool)
// SAMLSPServerTLSHandshakeEvent defines the signature of the SAMLSPServer TLSHandshake event's handler function.
type SAMLSPServerTLSHandshakeEvent func(sender *SAMLSPServer, args *SAMLSPServerTLSHandshakeEventArgs)
func (obj *SAMLSPServer) GetOnTLSHandshakeHandler() SAMLSPServerTLSHandshakeEvent
func (obj *SAMLSPServer) SetOnTLSHandshakeHandler(handlerFunc SAMLSPServerTLSHandshakeEvent)
Remarks
Use this event to get notified about the initiation of the TLS handshake by the remote client. The ServerName parameter specifies the requested host from the client hello message.
TLSPSK Event (SAMLSPServer Component)
Requests a pre-shared key for TLS-PSK.
Syntax
// SAMLSPServerTLSPSKEventArgs carries the SAMLSPServer TLSPSK event's parameters.
type SAMLSPServerTLSPSKEventArgs struct {...}
func (args *SAMLSPServerTLSPSKEventArgs) ConnectionID() int64
func (args *SAMLSPServerTLSPSKEventArgs) Identity() string
func (args *SAMLSPServerTLSPSKEventArgs) PSK() string
func (args *SAMLSPServerTLSPSKEventArgs) SetPSK(value string)
func (args *SAMLSPServerTLSPSKEventArgs) Ciphersuite() string
func (args *SAMLSPServerTLSPSKEventArgs) SetCiphersuite(value string)
// SAMLSPServerTLSPSKEvent defines the signature of the SAMLSPServer TLSPSK event's handler function.
type SAMLSPServerTLSPSKEvent func(sender *SAMLSPServer, args *SAMLSPServerTLSPSKEventArgs)
func (obj *SAMLSPServer) GetOnTLSPSKHandler() SAMLSPServerTLSPSKEvent
func (obj *SAMLSPServer) SetOnTLSPSKHandler(handlerFunc SAMLSPServerTLSPSKEvent)
Remarks
The struct fires this event to report that a client has requested a TLS-PSK negotiation. ConnectionId indicates the unique connection ID that requested the PSK handshake.
Use Identity to look up for the corresponding pre-shared key in the server's database, then assign the key to the PSK parameter. If TLS 1.3 PSK is used, you will also need to assign the Ciphersuite parameter with the cipher suite associated with that identity and their key.
TLSShutdown Event (SAMLSPServer Component)
Reports closure of a TLS session.
Syntax
// SAMLSPServerTLSShutdownEventArgs carries the SAMLSPServer TLSShutdown event's parameters.
type SAMLSPServerTLSShutdownEventArgs struct {...}
func (args *SAMLSPServerTLSShutdownEventArgs) ConnectionID() int64
// SAMLSPServerTLSShutdownEvent defines the signature of the SAMLSPServer TLSShutdown event's handler function.
type SAMLSPServerTLSShutdownEvent func(sender *SAMLSPServer, args *SAMLSPServerTLSShutdownEventArgs)
func (obj *SAMLSPServer) GetOnTLSShutdownHandler() SAMLSPServerTLSShutdownEvent
func (obj *SAMLSPServer) SetOnTLSShutdownHandler(handlerFunc SAMLSPServerTLSShutdownEvent)
Remarks
The struct fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a Disconnect, which marks the closure of the underlying TCP session.
UserAuthCompleted Event (SAMLSPServer Component)
Notifies the application about the success of user authentication flow.
Syntax
// SAMLSPServerUserAuthCompletedEventArgs carries the SAMLSPServer UserAuthCompleted event's parameters.
type SAMLSPServerUserAuthCompletedEventArgs struct {...}
func (args *SAMLSPServerUserAuthCompletedEventArgs) ConnectionID() int64
func (args *SAMLSPServerUserAuthCompletedEventArgs) SessionID() string
func (args *SAMLSPServerUserAuthCompletedEventArgs) AssertionBody() string
func (args *SAMLSPServerUserAuthCompletedEventArgs) Auth() string
func (args *SAMLSPServerUserAuthCompletedEventArgs) NameID() string
func (args *SAMLSPServerUserAuthCompletedEventArgs) NameIDFormat() string
func (args *SAMLSPServerUserAuthCompletedEventArgs) SessionIndex() string
func (args *SAMLSPServerUserAuthCompletedEventArgs) ValidFrom() string
func (args *SAMLSPServerUserAuthCompletedEventArgs) ValidTo() string
func (args *SAMLSPServerUserAuthCompletedEventArgs) RelayState() string
// SAMLSPServerUserAuthCompletedEvent defines the signature of the SAMLSPServer UserAuthCompleted event's handler function.
type SAMLSPServerUserAuthCompletedEvent func(sender *SAMLSPServer, args *SAMLSPServerUserAuthCompletedEventArgs)
func (obj *SAMLSPServer) GetOnUserAuthCompletedHandler() SAMLSPServerUserAuthCompletedEvent
func (obj *SAMLSPServer) SetOnUserAuthCompletedHandler(handlerFunc SAMLSPServerUserAuthCompletedEvent)
Remarks
Subscribe to this event to get notified about completion of user authentication flow. The NameID, NameIDFormat, SessionIndex, ValidFrom, and ValidTo parameters contain the session parameters as stated in the assertion, which is provided via the AssertionBody parameter. The Auth parameter contain the authentication mechanism used.
The RelayState matches the original relay state that was used on the initiation stage of the authentication.
UserAuthFailed Event (SAMLSPServer Component)
Notifies the application about failure of user authentication flow.
Syntax
// SAMLSPServerUserAuthFailedEventArgs carries the SAMLSPServer UserAuthFailed event's parameters.
type SAMLSPServerUserAuthFailedEventArgs struct {...}
func (args *SAMLSPServerUserAuthFailedEventArgs) ConnectionID() int64
func (args *SAMLSPServerUserAuthFailedEventArgs) SessionID() string
func (args *SAMLSPServerUserAuthFailedEventArgs) RelayState() string
// SAMLSPServerUserAuthFailedEvent defines the signature of the SAMLSPServer UserAuthFailed event's handler function.
type SAMLSPServerUserAuthFailedEvent func(sender *SAMLSPServer, args *SAMLSPServerUserAuthFailedEventArgs)
func (obj *SAMLSPServer) GetOnUserAuthFailedHandler() SAMLSPServerUserAuthFailedEvent
func (obj *SAMLSPServer) SetOnUserAuthFailedHandler(handlerFunc SAMLSPServerUserAuthFailedEvent)
Remarks
The component fires this event to notify the application about failed user authentication flow. The RelayState parameter matches the one included with the AuthnRequest message.
UserAuthStart Event (SAMLSPServer Component)
Notifies the application about the start of user authentication flow.
Syntax
// SAMLSPServerUserAuthStartEventArgs carries the SAMLSPServer UserAuthStart event's parameters.
type SAMLSPServerUserAuthStartEventArgs struct {...}
func (args *SAMLSPServerUserAuthStartEventArgs) ConnectionID() int64
func (args *SAMLSPServerUserAuthStartEventArgs) SessionID() string
func (args *SAMLSPServerUserAuthStartEventArgs) IdPServiceIndex() int32
func (args *SAMLSPServerUserAuthStartEventArgs) RelayState() string
func (args *SAMLSPServerUserAuthStartEventArgs) SetRelayState(value string)
// SAMLSPServerUserAuthStartEvent defines the signature of the SAMLSPServer UserAuthStart event's handler function.
type SAMLSPServerUserAuthStartEvent func(sender *SAMLSPServer, args *SAMLSPServerUserAuthStartEventArgs)
func (obj *SAMLSPServer) GetOnUserAuthStartHandler() SAMLSPServerUserAuthStartEvent
func (obj *SAMLSPServer) SetOnUserAuthStartHandler(handlerFunc SAMLSPServerUserAuthStartEvent)
Remarks
The component invokes this event to signal the start of the user authentication flow. This happens shortly before the component proceeds to generation of AuthnRequest message.
The RelayState is an arbitrary string that will be passed to the IdP and mirrored back with the assertion. It is typically used to remember the URL of the resource or page that kicked in the SAML authentication flow.
UserLogoutCompleted Event (SAMLSPServer Component)
Notifies the application about the completion of user logout flow.
Syntax
// SAMLSPServerUserLogoutCompletedEventArgs carries the SAMLSPServer UserLogoutCompleted event's parameters.
type SAMLSPServerUserLogoutCompletedEventArgs struct {...}
func (args *SAMLSPServerUserLogoutCompletedEventArgs) ConnectionID() int64
func (args *SAMLSPServerUserLogoutCompletedEventArgs) SessionID() string
func (args *SAMLSPServerUserLogoutCompletedEventArgs) NameID() string
func (args *SAMLSPServerUserLogoutCompletedEventArgs) SessionIndex() string
func (args *SAMLSPServerUserLogoutCompletedEventArgs) RelayState() string
// SAMLSPServerUserLogoutCompletedEvent defines the signature of the SAMLSPServer UserLogoutCompleted event's handler function.
type SAMLSPServerUserLogoutCompletedEvent func(sender *SAMLSPServer, args *SAMLSPServerUserLogoutCompletedEventArgs)
func (obj *SAMLSPServer) GetOnUserLogoutCompletedHandler() SAMLSPServerUserLogoutCompletedEvent
func (obj *SAMLSPServer) SetOnUserLogoutCompletedHandler(handlerFunc SAMLSPServerUserLogoutCompletedEvent)
Remarks
Subscribe to this event to be notified about the completion of the logout flow.
UserLogoutStart Event (SAMLSPServer Component)
Notifies the application about the start of user logout flow.
Syntax
// SAMLSPServerUserLogoutStartEventArgs carries the SAMLSPServer UserLogoutStart event's parameters.
type SAMLSPServerUserLogoutStartEventArgs struct {...}
func (args *SAMLSPServerUserLogoutStartEventArgs) ConnectionID() int64
func (args *SAMLSPServerUserLogoutStartEventArgs) SessionID() string
func (args *SAMLSPServerUserLogoutStartEventArgs) IdPServiceIndex() int32
func (args *SAMLSPServerUserLogoutStartEventArgs) NameID() string
func (args *SAMLSPServerUserLogoutStartEventArgs) SessionIndex() string
func (args *SAMLSPServerUserLogoutStartEventArgs) Secondary() bool
func (args *SAMLSPServerUserLogoutStartEventArgs) RelayState() string
func (args *SAMLSPServerUserLogoutStartEventArgs) SetRelayState(value string)
// SAMLSPServerUserLogoutStartEvent defines the signature of the SAMLSPServer UserLogoutStart event's handler function.
type SAMLSPServerUserLogoutStartEvent func(sender *SAMLSPServer, args *SAMLSPServerUserLogoutStartEventArgs)
func (obj *SAMLSPServer) GetOnUserLogoutStartHandler() SAMLSPServerUserLogoutStartEvent
func (obj *SAMLSPServer) SetOnUserLogoutStartHandler(handlerFunc SAMLSPServerUserLogoutStartEvent)
Remarks
Subscribe to this event to get notified about the start of the user logout flow.
The logout process can be initiated on either the SP or IdP side. This event is fired at the earliest opportunity that this fact becomes known to the service provider: from within the InitiateLogout method, ProcessLogoutRequest method, or upon receiving a logout request at the SLS endpoint.
Independently of the timing and the stage of this event, the subsequent flow is the same: the logout protocol is initiated. The application will be notified of the completion of the protocol using the UserLogoutCompleted event. Note that the UserLogoutCompleted event may not fire if the connectivity to the IdP is lost prematurely or the IdP chooses not to respond. Due to that, it is reasonable to consider the user as logged out immediately after the current event fires.
The IdPServiceIndex parameter contains the index of the IdP service in the IdPServices collection. NameID indicates the name identifier of the user that is being logged out, and SessionIndex contain the unique SAML session identifier. The Secondary flag indicates whether the the SP is responding to IdP-initiated logout request.
The RelayState parameter is an optional SP-generated token that the IdP will return back in its LogoutResponse message. This is often set to the destination page where the browser should be redirected upon completion of the signout process.
Config Settings (SAMLSPServer 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.SAMLSPServer 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");
Trappable Errors (SAMLSPServer Component)
SAMLSPServer Errors
| 1048577 | Invalid parameter (SB_ERROR_INVALID_PARAMETER) |
| 1048578 | Invalid configuration (SB_ERROR_INVALID_SETUP) |
| 1048579 | Invalid state (SB_ERROR_INVALID_STATE) |
| 1048580 | Invalid value (SB_ERROR_INVALID_VALUE) |
| 1048581 | Private key not found (SB_ERROR_NO_PRIVATE_KEY) |
| 1048582 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |
| 1048583 | The file was not found (SB_ERROR_NO_SUCH_FILE) |
| 1048584 | Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE) |
| 1048585 | General error (SB_ERROR_GENERAL_ERROR) |
| 30408705 | Invalid binding name (SB_ERROR_SAML_INVALID_BINDING_NAME) |
| 30408706 | Invalid SAML binding type (SB_ERROR_SAML_INVALID_BINDING_TYPE) |
| 30408707 | Base directory not set (SB_ERROR_SAML_SP_BASE_DIRECTORY_NOT_SET) |
| 30408708 | Invalid parameter (SB_ERROR_SAML_INVALID_PARAM) |
| 30408709 | Invalid input data (SB_ERROR_SAML_INVALID_DATA) |
| 30408710 | Data is not loaded (SB_ERROR_SAML_NOT_LOADED) |
| 30408711 | New document is not created (SB_ERROR_SAML_NOT_CREATED) |
| 30408716 | Endpoint of unsupported type encountered or cannot find appropriate IdP service (SB_ERROR_SAML_INVALID_SERVICE) |
| 30408717 | Multiple endpoints of the same kind are not supported (SB_ERROR_SAML_MULTIPLE_ENDPOINTS_NOT_SUPPORTED) |
| 30408718 | Failed to process the request (SB_ERROR_SAML_PROCESSING_FAILED) |
| 30408719 | Session not found (SB_ERROR_SAML_SESSION_NOT_FOUND) |