SAMLIdPServer Component

Properties Methods Events Config Settings Errors

The SAMLIdPServer class represents a SAML identity provider.

Syntax

secureblackbox.SAMLIdPServer

Remarks

The identity provider in the SAML (Security Assertion Markup Language) exchange flow represents the server that issues authentication assertions for single sign-on (SSO).

Requests received by the IdP server from known service providers (SP) are processed automatically, in accordance with known SP metadata and IdP options. If the request is correct, the client is redirected to the IdP for authentication. The authentication algorithm depends on the IdP options and may be reduced to a simple IP check, X.509 certificate authentication, or login credentials check.

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.
AllowIDPSSO	Specifies if IdP-initiated Single Sign-On (SSO) is allowed.
BaseDir	Base directory on the server.
BindingKeyHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
EncryptionCertBytes	Returns the raw certificate data in DER format.
EncryptionCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
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 IdP 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.
IdPSSOPage	Specifies the relative URL of the IdP-initiated SSO page.
IdPSSOPageTemplate	The content of the IdP-initiated SSO page.
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.
LoginAttemptsLimit	The maximum number of login attempts.
MetadataURL	The IdP'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	The listening port number.
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.
SignOnPageTemplate	Defines the default authentication template (login page).
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.
SPCount	The number of records in the SP arrays.
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 IdP server.
UserCount	The number of records in the User arrays.
UserAssociatedData	Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.
UserBasePath	Base path for this user in the server's file system.
UserCertificate	Contains the user's certificate.
UserData	Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.
UserEmail	The user's email address.
UserHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
UserHashAlgorithm	Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.
UserIncomingSpeedLimit	Specifies the incoming speed limit for this user.
UserOtpAlgorithm	The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP).
UserOTPLen	Specifies the length of the user's OTP password.
UserOtpValue	The user's time interval (TOTP) or Counter (HOTP).
UserOutgoingSpeedLimit	Specifies the outgoing speed limit for this user.
UserPassword	The user's authentication password.
UserSharedSecret	Contains the user's secret key, which is essentially a shared secret between the client and server.
UserSSHKey	Contains the user's SSH key.
Username	The registered name (login) of the user.

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.
AddSP	Registers an SP entity in SPSettings list.
AddSPService	Registers an SP service in the SPServices list.
Cleanup	Cleans up the server environment by purging expired sessions and cleaning caches.
CompleteAuth	Initiates transfer of the authentication fact (assertion) to the SP.
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 received 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 (IdP-side) and remote (SP-side) metadata can be loaded with this call.
InitiateArtifactResolve	Initiates the artifact resolution protocol.
InitiateAuth	Starts IdP-initiated SAML authentication flow.
InitiateLogout	Starts IdP-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 SP service at one of artifact receiver endpoints.
ProcessArtifactResolveRequest	Processes an artifact request received from the SP service at one of the ARS endpoints.
ProcessAttributeQuery	Processes an attribute request received from the SP service at one of the AQS endpoints.
ProcessGenericRequest	Processes a generic HTTP SAML request.
ProcessLogoutRequest	Processes logout request received from the SP service at one of the SLS endpoints.
ProcessSignOnRequest	Processes a single sign-on request received from the SP service at one of the SSO endpoints.
ProcessSignOnResponse	Processes the submission of the login form previously generated by the IdP server.
RemoveSP	Removes an SP from the list of known service providers.
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 IdP 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.
AssertionPrepared	This event fires when a new assertion has been prepared by the IdP server.
AttributeQueryReceived	Notifies the application about receipt of an AttributeQuery.
AuthnRequestReceived	The server fires this event upon receiving an AuthnRequest message from the other side.
Connect	Reports an accepted connection.
Disconnect	Fires to report a disconnected client.
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.
NewAssertion	This event reports a new assertion initiated by the IdP server.
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.
ReadAttribute	Requests an attribute 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 IdP 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	Notifies the application about the start of signature validation.
SignatureValidated	Reports the signature validation result.
SignOnPagePrepared	The server fires this event upon preparing the sign-on page.
SignOnResponseReceived	Notifies the application about the received response to the sign-on page.
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.
UserAuthVerifyCredentials	Passes user credentials to the application for verification.
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.
AssertionsOneTimeUse	Adds a one-time use condition to the assertion.
AssertionsTTL	The assertions time-to-live value.
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.
DefaultNameIDPolicyFormat	Default name ID policy format.
DefaultPassiveAuthnContextClassRef	The default passive authentication context class.
DualStack	Allows the use of ip4 and ip6 simultaneously.
HandshakeTimeout	The HTTPS handshake timeout.
HomePage	Specifies the home page resource name.
MaxIssueInstantTimeDiff	The maximum issue-instant time delta.
NotBeforeTimeout	The 'not-before' timeout to use.
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.
ServerName	Specifies the server name for the created responses.
SessionTimeout	The HTTP session timeout.
SessionTTL	The SAML session time-to-live value.
SubjectConfirmationMethod	Subject confirmation method.
TempPath	Path for storing temporary files.
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 (SAMLIdPServer Component)

Tells whether the server is active and ready to process requests.

Syntax

func (obj *SAMLIdPServer) 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

AllowIDPSSO Property (SAMLIdPServer Component)

Specifies if IdP-initiated Single Sign-On (SSO) is allowed.

Syntax

func (obj *SAMLIdPServer) AllowIDPSSO() (bool, error)
func (obj *SAMLIdPServer) SetAllowIDPSSO(value bool) error

Default Value

false

Remarks

Set this property to true to allow IdP-initiated Single Sign-Ons. Use the IdPSSOLink parameter of AddSP method to add sign-on URLs.

Data Type

bool

BaseDir Property (SAMLIdPServer Component)

Base directory on the server.

Syntax

func (obj *SAMLIdPServer) BaseDir() (string, error)
func (obj *SAMLIdPServer) SetBaseDir(value string) error

Default Value

Remarks

Use this property to specify the base directory for the SP server.

Data Type

string

BindingKeyHandle Property (SAMLIdPServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *SAMLIdPServer) BindingKeyHandle() (int64, error)
func (obj *SAMLIdPServer) SetBindingKeyHandle(value int64) error

Default Value

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

EncryptionCertBytes Property (SAMLIdPServer Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *SAMLIdPServer) EncryptionCertBytes() ([]byte, error)

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

[]byte

EncryptionCertHandle Property (SAMLIdPServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *SAMLIdPServer) EncryptionCertHandle() (int64, error)
func (obj *SAMLIdPServer) SetEncryptionCertHandle(value int64) error

Default Value

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.

Data Type

int64

ExternalCryptoAsyncDocumentID Property (SAMLIdPServer Component)

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

func (obj *SAMLIdPServer) ExternalCryptoAsyncDocumentID() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Custom parameters to be passed to the signing service (uninterpreted).

Syntax

func (obj *SAMLIdPServer) ExternalCryptoCustomParams() (string, error)
func (obj *SAMLIdPServer) SetExternalCryptoCustomParams(value string) error

Default Value

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

Data Type

string

ExternalCryptoData Property (SAMLIdPServer Component)

Additional data to be included in the async state and mirrored back by the requestor.

Syntax

func (obj *SAMLIdPServer) ExternalCryptoData() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

func (obj *SAMLIdPServer) ExternalCryptoExternalHashCalculation() (bool, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Specifies the request's signature hash algorithm.

Syntax

func (obj *SAMLIdPServer) ExternalCryptoHashAlgorithm() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The ID of the pre-shared key used for DC request authentication.

Syntax

func (obj *SAMLIdPServer) ExternalCryptoKeyID() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The pre-shared key used for DC request authentication.

Syntax

func (obj *SAMLIdPServer) ExternalCryptoKeySecret() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Specifies the asynchronous signing method.

Syntax

func (obj *SAMLIdPServer) ExternalCryptoMethod() (int32, error)
func (obj *SAMLIdPServer) SetExternalCryptoMethod(value int32) error

Possible Values

0   // PKCS1
1   // PKCS7

Default Value

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

Specifies the external cryptography mode.

Syntax

func (obj *SAMLIdPServer) ExternalCryptoMode() (int32, error)
func (obj *SAMLIdPServer) SetExternalCryptoMode(value int32) error

Possible Values

0   // Default
1   // Disabled
2   // Generic
3   // DCAuth
4   // DCAuthJSON

Default Value

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

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Syntax

func (obj *SAMLIdPServer) ExternalCryptoPublicKeyAlgorithm() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Reserved.

Syntax

func (obj *SAMLIdPServer) FIPSMode() (bool, error)
func (obj *SAMLIdPServer) SetFIPSMode(value bool) error

Default Value

false

Remarks

This property is reserved for future use.

Data Type

bool

HandshakeTimeout Property (SAMLIdPServer Component)

Specifies the handshake timeout in milliseconds.

Syntax

func (obj *SAMLIdPServer) HandshakeTimeout() (int32, error)
func (obj *SAMLIdPServer) SetHandshakeTimeout(value int32) error

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Data Type

int32

Host Property (SAMLIdPServer Component)

Specifies the host address of the IdP server.

Syntax

func (obj *SAMLIdPServer) Host() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The number of records in the IdPService arrays.

Syntax

func (obj *SAMLIdPServer) IdPServiceCount() (int32, error)

Default Value

Remarks

This property controls the size of the following arrays:

IdPServiceBindingType
IdPServiceEntityID
IdPServiceLocation
IdPServicePriority
IdPServiceService
IdPServiceServiceIndex

The array indices start at 0 and end at IdPServiceCount - 1.

This property is read-only.

Data Type

int32

IdPServiceBindingType Property (SAMLIdPServer Component)

Specifies the type of SAML binding that this endpoint accepts.

Syntax

func (obj *SAMLIdPServer) IdPServiceBindingType(IdPServiceIndex int32) (int32, error)

Possible Values

0   // None
1   // SOAP
2   // PAOS
3   // Redirect
4   // POST
5   // Artifact

Default Value

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

Represents the SAML entity ID.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The location (URL) of the endpoint.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The priority of the endpoint in relation to other endpoints with the same Location .

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The kind of the service being provided at this endpoint.

Syntax

func (obj *SAMLIdPServer) IdPServiceService(IdPServiceIndex int32) (int32, error)

Default Value

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

The index of this endpoint.

Syntax

func (obj *SAMLIdPServer) IdPServiceServiceIndex(IdPServiceIndex int32) (int32, error)

Default Value

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

The contact person or persons for the entity.

Syntax

func (obj *SAMLIdPServer) IdPContactPerson() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Contains the entity's encryption key.

Syntax

func (obj *SAMLIdPServer) IdPEncryptionKey() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Specifies the list of encryption methods supported by the entity.

Syntax

func (obj *SAMLIdPServer) IdPEncryptionMethods() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Represents the SAML entity ID.

Syntax

func (obj *SAMLIdPServer) IdPEntityID() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Adjusts secondary entity properties.

Syntax

func (obj *SAMLIdPServer) IdPFlags() (int32, error)
func (obj *SAMLIdPServer) SetIdPFlags(value int32) error

Default Value

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

Contains a local server page link that triggers SAML authentication to the SP.

Syntax

func (obj *SAMLIdPServer) IdPSSOLink() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The list of NameID formats supported by this entity.

Syntax

func (obj *SAMLIdPServer) IdPNameIDFormats() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The friendly name of the organization that maintains the entity.

Syntax

func (obj *SAMLIdPServer) IdPOrganizationDisplayName() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The language preferred by the organization.

Syntax

func (obj *SAMLIdPServer) IdPOrganizationLang() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The name of the organization that maintains the entity.

Syntax

func (obj *SAMLIdPServer) IdPOrganizationName() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The web URL of the organization that maintains the entity.

Syntax

func (obj *SAMLIdPServer) IdPOrganizationURL() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The outcome of the cryptographic signature validation.

Syntax

func (obj *SAMLIdPServer) IdPSignatureValidationResult() (int32, error)

Possible Values

0   // Valid
1   // Unknown
2   // Corrupted
3   // SignerNotFound
4   // Failure
5   // ReferenceCorrupted

Default Value

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

Specifies whether the SAML entity information is or should be signed.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Contains the certificate or key that was used to sign the settings (metadata) document.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Contains the entity's signing key.

Syntax

func (obj *SAMLIdPServer) IdPSigningKey() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Specifies the expiration time of the SAML entity information.

Syntax

func (obj *SAMLIdPServer) IdPValidUntil() (string, error)
func (obj *SAMLIdPServer) 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

IdPSSOPage Property (SAMLIdPServer Component)

Specifies the relative URL of the IdP-initiated SSO page.

Syntax

func (obj *SAMLIdPServer) IdPSSOPage() (string, error)
func (obj *SAMLIdPServer) SetIdPSSOPage(value string) error

Default Value

"/idpsso"

Remarks

Use this property to specify the address of the Single Sign-On (SSO) page initiated by this Identity Provider (IdP).

Data Type

string

IdPSSOPageTemplate Property (SAMLIdPServer Component)

The content of the IdP-initiated SSO page.

Syntax

func (obj *SAMLIdPServer) IdPSSOPageTemplate() (string, error)
func (obj *SAMLIdPServer) SetIdPSSOPageTemplate(value string) error

Default Value

Remarks

Use this property to specify the content of the Single Sign-On (SSO) page initiated by this Identity Provider (IdP).

Data Type

string

KnownCertCount Property (SAMLIdPServer Component)

The number of records in the KnownCert arrays.

Syntax

func (obj *SAMLIdPServer) KnownCertCount() (int32, error)
func (obj *SAMLIdPServer) SetKnownCertCount(value int32) error

Default Value

Remarks

This property controls the size of the following arrays:

KnownCertBytes
KnownCertHandle

The array indices start at 0 and end at KnownCertCount - 1.

Data Type

int32

KnownCertBytes Property (SAMLIdPServer Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *SAMLIdPServer) KnownCertHandle(KnownCertIndex int32) (int64, error)
func (obj *SAMLIdPServer) SetKnownCertHandle(KnownCertIndex int32, value int64) error

Default Value

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.

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

The number of records in the KnownKey arrays.

Syntax

func (obj *SAMLIdPServer) KnownKeyCount() (int32, error)
func (obj *SAMLIdPServer) SetKnownKeyCount(value int32) error

Default Value

Remarks

This property controls the size of the following arrays:

KnownKeyHandle

The array indices start at 0 and end at KnownKeyCount - 1.

Data Type

int32

KnownKeyHandle Property (SAMLIdPServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *SAMLIdPServer) KnownKeyHandle(KnownKeyIndex int32) (int64, error)
func (obj *SAMLIdPServer) SetKnownKeyHandle(KnownKeyIndex int32, value int64) error

Default Value

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.

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

LoginAttemptsLimit Property (SAMLIdPServer Component)

The maximum number of login attempts.

Syntax

func (obj *SAMLIdPServer) LoginAttemptsLimit() (int32, error)
func (obj *SAMLIdPServer) SetLoginAttemptsLimit(value int32) error

Default Value

Remarks

Use this property to set the maximum number of login attempts.

Data Type

int32

MetadataURL Property (SAMLIdPServer Component)

The IdP's metadata location.

Syntax

func (obj *SAMLIdPServer) MetadataURL() (string, error)
func (obj *SAMLIdPServer) SetMetadataURL(value string) error

Default Value

"/idp/metadata"

Remarks

This property specifies the metadata URL of this Identity Provider (IdP).

Data Type

string

MetaSigningCertBytes Property (SAMLIdPServer Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *SAMLIdPServer) MetaSigningCertBytes() ([]byte, error)

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

[]byte

MetaSigningCertHandle Property (SAMLIdPServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *SAMLIdPServer) MetaSigningCertHandle() (int64, error)
func (obj *SAMLIdPServer) SetMetaSigningCertHandle(value int64) error

Default Value

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.

Data Type

int64

OfflineMode Property (SAMLIdPServer Component)

Enables the Offline mode.

Syntax

func (obj *SAMLIdPServer) OfflineMode() (bool, error)
func (obj *SAMLIdPServer) SetOfflineMode(value bool) error

Default Value

true

Remarks

In the Offline mode the server does not open the listening port. Instead, it expects incoming requests to be routed by the application via calls to ProcessSignOnRequest, ProcessLogoutRequest, ProcessSignOnResponse, 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 requests.

Data Type

bool

PinnedClientAEADCipher Property (SAMLIdPServer Component)

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The details of a certificate chain validation outcome.

Syntax

func (obj *SAMLIdPServer) PinnedClientChainValidationDetails() (int32, error)

Default Value

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

The outcome of a certificate chain validation routine.

Syntax

func (obj *SAMLIdPServer) PinnedClientChainValidationResult() (int32, error)

Possible Values

0   // Valid
1   // ValidButUntrusted
2   // Invalid
3   // CantBeEstablished

Default Value

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

The cipher suite employed by this connection.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Specifies whether client authentication was performed during this connection.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Specifies whether client authentication was requested during this connection.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Indicates whether the connection has been established fully.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The unique identifier assigned to this connection.

Syntax

func (obj *SAMLIdPServer) PinnedClientConnectionID() ([]byte, error)

Remarks

The unique identifier assigned to this connection.

This property is read-only.

Data Type

[]byte

PinnedClientDigestAlgorithm Property (SAMLIdPServer Component)

The digest algorithm used in a TLS-enabled connection.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The symmetric encryption algorithm used in a TLS-enabled connection.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The elliptic curve used in this connection.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The client connection's unique identifier.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The key exchange algorithm used in a TLS-enabled connection.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The length of the key exchange key of a TLS-enabled connection.

Syntax

func (obj *SAMLIdPServer) PinnedClientKeyExchangeKeyBits() (int32, error)

Default Value

Remarks

The length of the key exchange key of a TLS-enabled connection.

This property is read-only.

Data Type

int32

PinnedClientPFSCipher Property (SAMLIdPServer Component)

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

A hint professed by the server to help the client select the PSK identity to use.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The length of the public key.

Syntax

func (obj *SAMLIdPServer) PinnedClientPublicKeyBits() (int32, error)

Default Value

Remarks

The length of the public key.

This property is read-only.

Data Type

int32

PinnedClientRemoteAddress Property (SAMLIdPServer Component)

The client's IP address.

Syntax

func (obj *SAMLIdPServer) PinnedClientRemoteAddress() (string, error)

Default Value

Remarks

The client's IP address.

This property is read-only.

Data Type

string

PinnedClientRemotePort Property (SAMLIdPServer Component)

The remote port of the client connection.

Syntax

func (obj *SAMLIdPServer) PinnedClientRemotePort() (int32, error)

Default Value

Remarks

The remote port of the client connection.

This property is read-only.

Data Type

int32

PinnedClientResumedSession Property (SAMLIdPServer Component)

Indicates whether a TLS-enabled connection was spawned from another TLS connection.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Indicates whether server authentication was performed during a TLS-enabled connection.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The signature algorithm used in a TLS handshake.

Syntax

func (obj *SAMLIdPServer) PinnedClientSignatureAlgorithm() (string, error)

Default Value

Remarks

The signature algorithm used in a TLS handshake.

This property is read-only.

Data Type

string

PinnedClientSymmetricBlockSize Property (SAMLIdPServer Component)

The block size of the symmetric algorithm used.

Syntax

func (obj *SAMLIdPServer) PinnedClientSymmetricBlockSize() (int32, error)

Default Value

Remarks

The block size of the symmetric algorithm used.

This property is read-only.

Data Type

int32

PinnedClientSymmetricKeyBits Property (SAMLIdPServer Component)

The key length of the symmetric algorithm used.

Syntax

func (obj *SAMLIdPServer) PinnedClientSymmetricKeyBits() (int32, error)

Default Value

Remarks

The key length of the symmetric algorithm used.

This property is read-only.

Data Type

int32

PinnedClientTotalBytesReceived Property (SAMLIdPServer Component)

The total number of bytes received over this connection.

Syntax

func (obj *SAMLIdPServer) PinnedClientTotalBytesReceived() (int64, error)

Default Value

Remarks

The total number of bytes received over this connection.

This property is read-only.

Data Type

int64

PinnedClientTotalBytesSent Property (SAMLIdPServer Component)

The total number of bytes sent over this connection.

Syntax

func (obj *SAMLIdPServer) PinnedClientTotalBytesSent() (int64, error)

Default Value

Remarks

The total number of bytes sent over this connection.

This property is read-only.

Data Type

int64

PinnedClientValidationLog Property (SAMLIdPServer Component)

Contains the server certificate's chain validation log.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Indicates the version of SSL/TLS protocol negotiated during this connection.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The number of records in the PinnedClientCert arrays.

Syntax

func (obj *SAMLIdPServer) PinnedClientCertCount() (int32, error)

Default Value

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

The array indices start at 0 and end at PinnedClientCertCount - 1.

This property is read-only.

Data Type

int32

PinnedClientCertBytes Property (SAMLIdPServer Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *SAMLIdPServer) PinnedClientCertHandle(PinnedClientCertIndex int32) (int64, error)

Default Value

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.

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

The common name of the certificate issuer (CA), typically a company name.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Specifies the public key algorithm of this certificate.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Returns the length of the public key in bits.

Syntax

func (obj *SAMLIdPServer) PinnedClientCertKeyBits(PinnedClientCertIndex int32) (int32, error)

Default Value

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

Returns a SHA1 fingerprint of the public key contained in the certificate.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

func (obj *SAMLIdPServer) PinnedClientCertKeyUsage(PinnedClientCertIndex int32) (int32, error)

Default Value

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

Contains the certificate's public key in DER format.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Returns the certificate's serial number.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer 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 *SAMLIdPServer) 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 (SAMLIdPServer Component)

Contains a unique identifier of the certificate's cryptographic key.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The time point at which the certificate becomes valid, in UTC.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The time point at which the certificate expires, in UTC.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The listening port number.

Syntax

func (obj *SAMLIdPServer) Port() (int32, error)
func (obj *SAMLIdPServer) SetPort(value int32) error

Default Value

Remarks

Use this property to specify the port number on which the IdP server should listen for incoming connections. To specify server's IP address use Host.

Data Type

int32

SecurityCanonicalizationMethod Property (SAMLIdPServer Component)

The canonicalization method to use in the signature.

Syntax

func (obj *SAMLIdPServer) SecurityCanonicalizationMethod() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The digest method to use.

Syntax

func (obj *SAMLIdPServer) SecurityDigestMethod() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The encryption method used to encrypt the assertion.

Syntax

func (obj *SAMLIdPServer) SecurityEncryptionMethod() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Provides access to secondary security parameters and tweaks.

Syntax

func (obj *SAMLIdPServer) SecurityFlags() (int32, error)
func (obj *SAMLIdPServer) SetSecurityFlags(value int32) error

Default Value

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

The signature method to use.

Syntax

func (obj *SAMLIdPServer) SecuritySigMethod() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Specifies the signature validation policy.

Syntax

func (obj *SAMLIdPServer) SecuritySignaturePolicy() (int32, error)
func (obj *SAMLIdPServer) SetSecuritySignaturePolicy(value int32) error

Possible Values

0   // Auto
1   // Validate
2   // Require
3   // Ignore

Default Value

Remarks

Specifies the signature validation policy.

Use this property to specify the signature validation policy for the component.

Data Type

int32

SenderCertCount Property (SAMLIdPServer Component)

The number of records in the SenderChain arrays.

Syntax

func (obj *SAMLIdPServer) SenderCertCount() (int32, error)

Default Value

Remarks

This property controls the size of the following arrays:

SenderChainBytes
SenderChainHandle

The array indices start at 0 and end at SenderCertCount - 1.

This property is read-only.

Data Type

int32

SenderChainBytes Property (SAMLIdPServer Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *SAMLIdPServer) SenderChainHandle(SenderCertIndex int32) (int64, error)

Default Value

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.

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

Returns the raw certificate data in DER format.

Syntax

func (obj *SAMLIdPServer) SigningCertBytes() ([]byte, error)

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

[]byte

SigningCertHandle Property (SAMLIdPServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *SAMLIdPServer) SigningCertHandle() (int64, error)
func (obj *SAMLIdPServer) SetSigningCertHandle(value int64) error

Default Value

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.

Data Type

int64

SigningChainCount Property (SAMLIdPServer Component)

The number of records in the SigningChain arrays.

Syntax

func (obj *SAMLIdPServer) SigningChainCount() (int32, error)
func (obj *SAMLIdPServer) SetSigningChainCount(value int32) error

Default Value

Remarks

This property controls the size of the following arrays:

SigningChainBytes
SigningChainHandle

The array indices start at 0 and end at SigningChainCount - 1.

Data Type

int32

SigningChainBytes Property (SAMLIdPServer Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *SAMLIdPServer) SigningChainHandle(SigningChainIndex int32) (int64, error)
func (obj *SAMLIdPServer) SetSigningChainHandle(SigningChainIndex int32, value int64) error

Default Value

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.

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

SignOnPageTemplate Property (SAMLIdPServer Component)

Defines the default authentication template (login page).

Syntax

func (obj *SAMLIdPServer) SignOnPageTemplate() (string, error)
func (obj *SAMLIdPServer) SetSignOnPageTemplate(value string) error

Default Value

Remarks

This property contains the HTML code of the authentication form. You can use it to control the appearance of the login page.

Data Type

string

SocketIncomingSpeedLimit Property (SAMLIdPServer Component)

The maximum number of bytes to read from the socket, per second.

Syntax

func (obj *SAMLIdPServer) SocketIncomingSpeedLimit() (int32, error)
func (obj *SAMLIdPServer) SetSocketIncomingSpeedLimit(value int32) error

Default Value

Remarks

The maximum number of bytes to read from the socket, per second.

Data Type

int32

SocketLocalAddress Property (SAMLIdPServer Component)

The local network interface to bind the socket to.

Syntax

func (obj *SAMLIdPServer) SocketLocalAddress() (string, error)
func (obj *SAMLIdPServer) SetSocketLocalAddress(value string) error

Default Value

Remarks

The local network interface to bind the socket to.

Data Type

string

SocketLocalPort Property (SAMLIdPServer Component)

The local port number to bind the socket to.

Syntax

func (obj *SAMLIdPServer) SocketLocalPort() (int32, error)
func (obj *SAMLIdPServer) SetSocketLocalPort(value int32) error

Default Value

Remarks

The local port number to bind the socket to.

Data Type

int32

SocketOutgoingSpeedLimit Property (SAMLIdPServer Component)

The maximum number of bytes to write to the socket, per second.

Syntax

func (obj *SAMLIdPServer) SocketOutgoingSpeedLimit() (int32, error)
func (obj *SAMLIdPServer) SetSocketOutgoingSpeedLimit(value int32) error

Default Value

Remarks

The maximum number of bytes to write to the socket, per second.

Data Type

int32

SocketTimeout Property (SAMLIdPServer Component)

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

Syntax

func (obj *SAMLIdPServer) SocketTimeout() (int32, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Enables or disables IP protocol version 6.

Syntax

func (obj *SAMLIdPServer) SocketUseIPv6() (bool, error)
func (obj *SAMLIdPServer) SetSocketUseIPv6(value bool) error

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

bool

SPServiceCount Property (SAMLIdPServer Component)

The number of records in the SPService arrays.

Syntax

func (obj *SAMLIdPServer) SPServiceCount() (int32, error)

Default Value

Remarks

This property controls the size of the following arrays:

SPServiceBindingType
SPServiceEntityID
SPServiceLocation
SPServicePriority
SPServiceService
SPServiceServiceIndex

The array indices start at 0 and end at SPServiceCount - 1.

This property is read-only.

Data Type

int32

SPServiceBindingType Property (SAMLIdPServer Component)

Specifies the type of SAML binding that this endpoint accepts.

Syntax

func (obj *SAMLIdPServer) SPServiceBindingType(SPServiceIndex int32) (int32, error)

Possible Values

0   // None
1   // SOAP
2   // PAOS
3   // Redirect
4   // POST
5   // Artifact

Default Value

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

Represents the SAML entity ID.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The location (URL) of the endpoint.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

The priority of the endpoint in relation to other endpoints with the same Location .

Syntax

func (obj *SAMLIdPServer) SPServicePriority(SPServiceIndex int32) (int32, error)

Default Value

-1

Remarks

The priority of the endpoint in relation to other endpoints with the same SPLocation.

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

The kind of the service being provided at this endpoint.

Syntax

func (obj *SAMLIdPServer) SPServiceService(SPServiceIndex int32) (int32, error)

Default Value

Remarks

The kind of the service being provided at 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

SPServiceServiceIndex Property (SAMLIdPServer Component)

The index of this endpoint.

Syntax

func (obj *SAMLIdPServer) SPServiceServiceIndex(SPServiceIndex int32) (int32, error)

Default Value

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

SPCount Property (SAMLIdPServer Component)

The number of records in the SP arrays.

Syntax

func (obj *SAMLIdPServer) SPCount() (int32, error)
func (obj *SAMLIdPServer) SetSPCount(value int32) error

Default Value

Remarks

This property controls the size of the following arrays:

SPContactPerson
SPEncryptionKey
SPEncryptionMethods
SPEntityID
SPFlags
SPIdPSSOLink
SPNameIDFormats
SPOrganizationDisplayName
SPOrganizationLang
SPOrganizationName
SPOrganizationURL
SPServiceBindingType
SPServiceEntityID
SPServiceLocation
SPServicePriority
SPServiceService
SPServiceServiceIndex
SPSignatureValidationResult
SPSigned
SPSignedWith
SPSigningKey
SPValidUntil

The array indices start at 0 and end at SPCount - 1.

Data Type

int32

SPContactPerson Property (SAMLIdPServer Component)

The contact person or persons for the entity.

Syntax

func (obj *SAMLIdPServer) SPContactPerson(SPIndex int32) (string, error)
func (obj *SAMLIdPServer) SetSPContactPerson(SPIndex int32, 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.

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

string

SPEncryptionKey Property (SAMLIdPServer Component)

Contains the entity's encryption key.

Syntax

func (obj *SAMLIdPServer) SPEncryptionKey(SPIndex int32) (string, error)
func (obj *SAMLIdPServer) SetSPEncryptionKey(SPIndex int32, value string) error

Default Value

Remarks

Contains the entity's encryption key.

Requests sent to the endpoint can be encrypted with the provided key or certificate.

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

string

SPEncryptionMethods Property (SAMLIdPServer Component)

Specifies the list of encryption methods supported by the entity.

Syntax

func (obj *SAMLIdPServer) SPEncryptionMethods(SPIndex int32) (string, error)
func (obj *SAMLIdPServer) SetSPEncryptionMethods(SPIndex int32, value string) error

Default Value

Remarks

Specifies the list of encryption methods supported by the 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

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

string

SPEntityID Property (SAMLIdPServer Component)

Represents the SAML entity ID.

Syntax

func (obj *SAMLIdPServer) SPEntityID(SPIndex int32) (string, error)
func (obj *SAMLIdPServer) SetSPEntityID(SPIndex int32, 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).

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

string

SPFlags Property (SAMLIdPServer Component)

Adjusts secondary entity properties.

Syntax

func (obj *SAMLIdPServer) SPFlags(SPIndex int32) (int32, error)
func (obj *SAMLIdPServer) SetSPFlags(SPIndex int32, value int32) error

Default Value

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.

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

int32

SPIdPSSOLink Property (SAMLIdPServer Component)

Contains a local server page link that triggers SAML authentication to the SP.

Syntax

func (obj *SAMLIdPServer) SPIdPSSOLink(SPIndex int32) (string, error)
func (obj *SAMLIdPServer) SetSPIdPSSOLink(SPIndex int32, 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.

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

string

SPNameIDFormats Property (SAMLIdPServer Component)

The list of NameID formats supported by this entity.

Syntax

func (obj *SAMLIdPServer) SPNameIDFormats(SPIndex int32) (string, error)
func (obj *SAMLIdPServer) SetSPNameIDFormats(SPIndex int32, 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

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

string

SPOrganizationDisplayName Property (SAMLIdPServer Component)

The friendly name of the organization that maintains the entity.

Syntax

func (obj *SAMLIdPServer) SPOrganizationDisplayName(SPIndex int32) (string, error)
func (obj *SAMLIdPServer) SetSPOrganizationDisplayName(SPIndex int32, 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.

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

string

SPOrganizationLang Property (SAMLIdPServer Component)

The language preferred by the organization.

Syntax

func (obj *SAMLIdPServer) SPOrganizationLang(SPIndex int32) (string, error)
func (obj *SAMLIdPServer) SetSPOrganizationLang(SPIndex int32, 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.

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

string

SPOrganizationName Property (SAMLIdPServer Component)

The name of the organization that maintains the entity.

Syntax

func (obj *SAMLIdPServer) SPOrganizationName(SPIndex int32) (string, error)
func (obj *SAMLIdPServer) SetSPOrganizationName(SPIndex int32, 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.

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

string

SPOrganizationURL Property (SAMLIdPServer Component)

The web URL of the organization that maintains the entity.

Syntax

func (obj *SAMLIdPServer) SPOrganizationURL(SPIndex int32) (string, error)
func (obj *SAMLIdPServer) SetSPOrganizationURL(SPIndex int32, 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.

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

string

SPSignatureValidationResult Property (SAMLIdPServer Component)

The outcome of the cryptographic signature validation.

Syntax

func (obj *SAMLIdPServer) SPSignatureValidationResult(SPIndex int32) (int32, error)

Possible Values

0   // Valid
1   // Unknown
2   // Corrupted
3   // SignerNotFound
4   // Failure
5   // ReferenceCorrupted

Default Value

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)

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

This property is read-only.

Data Type

int32

SPSigned Property (SAMLIdPServer Component)

Specifies whether the SAML entity information is or should be signed.

Syntax

func (obj *SAMLIdPServer) SPSigned(SPIndex int32) (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.

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

This property is read-only.

Data Type

bool

SPSignedWith Property (SAMLIdPServer Component)

Contains the certificate or key that was used to sign the settings (metadata) document.

Syntax

func (obj *SAMLIdPServer) SPSignedWith(SPIndex int32) (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 SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

This property is read-only.

Data Type

string

SPSigningKey Property (SAMLIdPServer Component)

Contains the entity's signing key.

Syntax

func (obj *SAMLIdPServer) SPSigningKey(SPIndex int32) (string, error)
func (obj *SAMLIdPServer) SetSPSigningKey(SPIndex int32, 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.

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

string

SPValidUntil Property (SAMLIdPServer Component)

Specifies the expiration time of the SAML entity information.

Syntax

func (obj *SAMLIdPServer) SPValidUntil(SPIndex int32) (string, error)
func (obj *SAMLIdPServer) SetSPValidUntil(SPIndex int32, 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.

The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.

Data Type

string

TLSServerCertCount Property (SAMLIdPServer Component)

The number of records in the TLSServerCert arrays.

Syntax

func (obj *SAMLIdPServer) TLSServerCertCount() (int32, error)
func (obj *SAMLIdPServer) SetTLSServerCertCount(value int32) error

Default Value

Remarks

This property controls the size of the following arrays:

TLSServerCertBytes
TLSServerCertHandle

The array indices start at 0 and end at TLSServerCertCount - 1.

Data Type

int32

TLSServerCertBytes Property (SAMLIdPServer Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *SAMLIdPServer) TLSServerCertHandle(TLSServerCertIndex int32) (int64, error)
func (obj *SAMLIdPServer) SetTLSServerCertHandle(TLSServerCertIndex int32, value int64) error

Default Value

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.

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

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Syntax

func (obj *SAMLIdPServer) TLSAutoValidateCertificates() (bool, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Selects the base configuration for the TLS settings.

Syntax

func (obj *SAMLIdPServer) TLSBaseConfiguration() (int32, error)
func (obj *SAMLIdPServer) SetTLSBaseConfiguration(value int32) error

Possible Values

0   // Default
1   // Compatible
2   // ComprehensiveInsecure
3   // HighlySecure

Default Value

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

A list of ciphersuites separated with commas or semicolons.

Syntax

func (obj *SAMLIdPServer) TLSCiphersuites() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Enables or disables certificate-based client authentication.

Syntax

func (obj *SAMLIdPServer) TLSClientAuth() (int32, error)
func (obj *SAMLIdPServer) SetTLSClientAuth(value int32) error

Possible Values

0   // NoAuth
1   // RequestCert
2   // RequireCert

Default Value

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

Provides access to TLS extensions.

Syntax

func (obj *SAMLIdPServer) TLSExtensions() (string, error)
func (obj *SAMLIdPServer) SetTLSExtensions(value string) error

Default Value

Remarks

Provides access to TLS extensions.

Data Type

string

TLSForceResumeIfDestinationChanges Property (SAMLIdPServer Component)

Whether to force TLS session resumption when the destination address changes.

Syntax

func (obj *SAMLIdPServer) TLSForceResumeIfDestinationChanges() (bool, error)
func (obj *SAMLIdPServer) SetTLSForceResumeIfDestinationChanges(value bool) error

Default Value

false

Remarks

Whether to force TLS session resumption when the destination address changes.

Data Type

bool

TLSGroups Property (SAMLIdPServer Component)

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Syntax

func (obj *SAMLIdPServer) TLSGroups() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

func (obj *SAMLIdPServer) TLSPreSharedIdentity() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Syntax

func (obj *SAMLIdPServer) TLSPreSharedKey() (string, error)
func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Syntax

func (obj *SAMLIdPServer) TLSPreSharedKeyCiphersuite() (string, error)
func (obj *SAMLIdPServer) SetTLSPreSharedKeyCiphersuite(value string) error

Default Value

Remarks

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Data Type

string

TLSRenegotiationAttackPreventionMode Property (SAMLIdPServer Component)

Selects the renegotiation attack prevention mechanism.

Syntax

func (obj *SAMLIdPServer) TLSRenegotiationAttackPreventionMode() (int32, error)
func (obj *SAMLIdPServer) SetTLSRenegotiationAttackPreventionMode(value int32) error

Possible Values

0   // Compatible
1   // Strict
2   // Auto

Default Value

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

Specifies the kind(s) of revocation check to perform.

Syntax

func (obj *SAMLIdPServer) TLSRevocationCheck() (int32, error)
func (obj *SAMLIdPServer) 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

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 (SAMLIdPServer 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 *SAMLIdPServer) TLSSSLOptions() (int32, error)
func (obj *SAMLIdPServer) SetTLSSSLOptions(value int32) error

Default Value

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

Specifies the TLS mode to use.

Syntax

func (obj *SAMLIdPServer) TLSMode() (int32, error)
func (obj *SAMLIdPServer) SetTLSMode(value int32) error

Possible Values

0   // Default
1   // NoTLS
2   // ExplicitTLS
3   // ImplicitTLS
4   // MixedTLS

Default Value

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

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Syntax

func (obj *SAMLIdPServer) TLSUseExtendedMasterSecret() (bool, error)
func (obj *SAMLIdPServer) SetTLSUseExtendedMasterSecret(value bool) error

Default Value

true

Remarks

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Data Type

bool

TLSUseSessionResumption Property (SAMLIdPServer Component)

Enables or disables the TLS session resumption capability.

Syntax

func (obj *SAMLIdPServer) TLSUseSessionResumption() (bool, error)
func (obj *SAMLIdPServer) SetTLSUseSessionResumption(value bool) error

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

bool

TLSVersions Property (SAMLIdPServer Component)

The SSL/TLS versions to enable by default.

Syntax

func (obj *SAMLIdPServer) TLSVersions() (int32, error)
func (obj *SAMLIdPServer) SetTLSVersions(value int32) error

Default Value

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

Specifies the base URL of this IdP server.

Syntax

func (obj *SAMLIdPServer) URL() (string, error)
func (obj *SAMLIdPServer) SetURL(value string) error

Default Value

Remarks

Use this property to set the base URL for this Identity Provider (IdP) server.

Data Type

string

UserCount Property (SAMLIdPServer Component)

The number of records in the User arrays.

Syntax

func (obj *SAMLIdPServer) UserCount() (int32, error)
func (obj *SAMLIdPServer) SetUserCount(value int32) error

Default Value

Remarks

This property controls the size of the following arrays:

UserAssociatedData
UserBasePath
UserCertificate
UserData
UserEmail
UserHandle
UserHashAlgorithm
UserIncomingSpeedLimit
Username
UserOtpAlgorithm
UserOTPLen
UserOtpValue
UserOutgoingSpeedLimit
UserPassword
UserSharedSecret
UserSSHKey

The array indices start at 0 and end at UserCount - 1.

Data Type

int32

UserAssociatedData Property (SAMLIdPServer Component)

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

Syntax

func (obj *SAMLIdPServer) UserAssociatedData(UserIndex int32) ([]byte, error)
func (obj *SAMLIdPServer) SetUserAssociatedData(UserIndex int32, value []byte) error

Remarks

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

[]byte

UserBasePath Property (SAMLIdPServer Component)

Base path for this user in the server's file system.

Syntax

func (obj *SAMLIdPServer) UserBasePath(UserIndex int32) (string, error)
func (obj *SAMLIdPServer) SetUserBasePath(UserIndex int32, value string) error

Default Value

Remarks

Base path for this user in the server's file system.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

string

UserCertificate Property (SAMLIdPServer Component)

Contains the user's certificate.

Syntax

func (obj *SAMLIdPServer) UserCertificate(UserIndex int32) ([]byte, error)
func (obj *SAMLIdPServer) SetUserCertificate(UserIndex int32, value []byte) error

Remarks

Contains the user's certificate.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

[]byte

UserData Property (SAMLIdPServer Component)

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

Syntax

func (obj *SAMLIdPServer) UserData(UserIndex int32) (string, error)
func (obj *SAMLIdPServer) SetUserData(UserIndex int32, value string) error

Default Value

Remarks

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

string

UserEmail Property (SAMLIdPServer Component)

The user's email address.

Syntax

func (obj *SAMLIdPServer) UserEmail(UserIndex int32) (string, error)
func (obj *SAMLIdPServer) SetUserEmail(UserIndex int32, value string) error

Default Value

Remarks

The user's email address.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

string

UserHandle Property (SAMLIdPServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *SAMLIdPServer) UserHandle(UserIndex int32) (int64, error)
func (obj *SAMLIdPServer) SetUserHandle(UserIndex int32, value int64) error

Default Value

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.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

int64

UserHashAlgorithm Property (SAMLIdPServer Component)

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.

Syntax

func (obj *SAMLIdPServer) UserHashAlgorithm(UserIndex int32) (string, error)
func (obj *SAMLIdPServer) SetUserHashAlgorithm(UserIndex int32, value string) error

Default Value

Remarks

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:


SB_MAC_ALGORITHM_HMAC_SHA1	`SHA1`
SB_MAC_ALGORITHM_HMAC_SHA256	`SHA256`
SB_MAC_ALGORITHM_HMAC_SHA512	`SHA512`

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

string

UserIncomingSpeedLimit Property (SAMLIdPServer Component)

Specifies the incoming speed limit for this user.

Syntax

func (obj *SAMLIdPServer) UserIncomingSpeedLimit(UserIndex int32) (int32, error)
func (obj *SAMLIdPServer) SetUserIncomingSpeedLimit(UserIndex int32, value int32) error

Default Value

Remarks

Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

int32

UserOtpAlgorithm Property (SAMLIdPServer Component)

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP).

Syntax

func (obj *SAMLIdPServer) UserOtpAlgorithm(UserIndex int32) (int32, error)
func (obj *SAMLIdPServer) SetUserOtpAlgorithm(UserIndex int32, value int32) error

Possible Values

0   // None
1   // Hmac
2   // Time

Default Value

Remarks

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.


oaHmac	`0`
oaTime	`1`

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

int32

UserOTPLen Property (SAMLIdPServer Component)

Specifies the length of the user's OTP password.

Syntax

func (obj *SAMLIdPServer) UserOTPLen(UserIndex int32) (int32, error)
func (obj *SAMLIdPServer) SetUserOTPLen(UserIndex int32, value int32) error

Default Value

Remarks

Specifies the length of the user's OTP password.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

int32

UserOtpValue Property (SAMLIdPServer Component)

The user's time interval (TOTP) or Counter (HOTP).

Syntax

func (obj *SAMLIdPServer) UserOtpValue(UserIndex int32) (int32, error)
func (obj *SAMLIdPServer) SetUserOtpValue(UserIndex int32, value int32) error

Default Value

Remarks

The user's time interval (TOTP) or Counter (HOTP).

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

int32

UserOutgoingSpeedLimit Property (SAMLIdPServer Component)

Specifies the outgoing speed limit for this user.

Syntax

func (obj *SAMLIdPServer) UserOutgoingSpeedLimit(UserIndex int32) (int32, error)
func (obj *SAMLIdPServer) SetUserOutgoingSpeedLimit(UserIndex int32, value int32) error

Default Value

Remarks

Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

int32

UserPassword Property (SAMLIdPServer Component)

The user's authentication password.

Syntax

func (obj *SAMLIdPServer) UserPassword(UserIndex int32) (string, error)
func (obj *SAMLIdPServer) SetUserPassword(UserIndex int32, value string) error

Default Value

Remarks

The user's authentication password.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

string

UserSharedSecret Property (SAMLIdPServer Component)

Contains the user's secret key, which is essentially a shared secret between the client and server.

Syntax

func (obj *SAMLIdPServer) UserSharedSecret(UserIndex int32) ([]byte, error)
func (obj *SAMLIdPServer) SetUserSharedSecret(UserIndex int32, value []byte) error

Remarks

Contains the user's secret key, which is essentially a shared secret between the client and server.

Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

[]byte

UserSSHKey Property (SAMLIdPServer Component)

Contains the user's SSH key.

Syntax

func (obj *SAMLIdPServer) UserSSHKey(UserIndex int32) ([]byte, error)
func (obj *SAMLIdPServer) SetUserSSHKey(UserIndex int32, value []byte) error

Remarks

Contains the user's SSH key.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

[]byte

Username Property (SAMLIdPServer Component)

The registered name (login) of the user.

Syntax

func (obj *SAMLIdPServer) Username(UserIndex int32) (string, error)
func (obj *SAMLIdPServer) SetUsername(UserIndex int32, value string) error

Default Value

Remarks

The registered name (login) of the user.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

string

AddIdPService Method (SAMLIdPServer Component)

Registers an IdP service in the IdPServices list.

Syntax

func (obj *SAMLIdPServer) AddIdPService(Service int32, BindingType int32, Location string, Priority int32, Index int32) error

Remarks

Use this method to add an entry to the list of services and their locations provided by the IdP.

An identity provider can provide a variety of identity services through a selection of endpoints, each supporting one or more transports (or bindings). Typical examples are a single sign-on 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 AddIdPService 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:

idp.AddIdPService(spsSingleSignOnService, csbtRedirect, "/saml/sso", -1, -1); idp.AddIdPService(spsSingleSignOnService, csbtPOST, "/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 Location parameter specifies an absolute or relative path to the service within the SAML web service:

idp.AddIdPService(spsSingleSignOnService, csbtPOST, "https://idp.identityserver/saml/sso", -1, -1); // absolute path idp.AddIdPService(spsSingleSignOnService, csbtRedirect, "/saml/sso", -1, -1); // relative path

The Priority parameter is nominal as it only specifies the relative priority of the transport in the IdP metadata. The actual transport used, among those supported, depends on the choice of the external service provider / application. 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 identity provider's own service - something that the identity provider provides. This is different to AddSPService method, which registers a foreign service provider's service - something that the identity provider should be aware of.

AddSP Method (SAMLIdPServer Component)

Registers an SP entity in SPSettings list.

Syntax

func (obj *SAMLIdPServer) AddSP(EntityID string, IdPSSOLink string) error

Remarks

This method adds an empty entry to the SPSettings list of known service providers. When registering a service provider manually (v.s. importing it from its metadata with a ImportSettings call), make sure to register all the individual SP service endpoints (assertion consumer services, single logout services, and so on) manually using the AddSPService method.

Once you have added the SP entry to the list, you can edit it using the SPSettings property.

AddSPService Method (SAMLIdPServer Component)

Registers an SP service in the SPServices list.

Syntax

func (obj *SAMLIdPServer) AddSPService(Service int32, BindingType int32, Location string, Priority int32, Index int32, EntityID string) error

Remarks

Use this method to add an entry to the list of known external SAML services and their locations.

The identity provider needs to be knowledgeable of external SP services (applications) that it provides services to. 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 SP service is available through several different transports (bindings), you will need to register each (service, transport) pair individually:

idp.AddSPService(spsAssertionConsumerService, csbtPOST, "https://app.com/saml/acs", -1, -1, "http://app.com/saml/metadata"); idp.AddSPService(spsAssertionConsumerService, csbtRedirect, "https://app.com/saml/acs", -1, -1, "http://app.com/saml/metadata");

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. This information is typically provided by the service provider.

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.

The EntityID parameter provides a unique identifier of the service provider. It is common to use the URL of the provider's metadata file as the Entity ID, although that is not a requirement.

Note that this method registers a known service - something that the identity provider should be aware of. This is different to the purpose of the AddIdPService method, which registers the identity provider's own service.

Cleanup Method (SAMLIdPServer Component)

Cleans up the server environment by purging expired sessions and cleaning caches.

Syntax

func (obj *SAMLIdPServer) 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.

CompleteAuth Method (SAMLIdPServer Component)

Initiates transfer of the authentication fact (assertion) to the SP.

Syntax

func (obj *SAMLIdPServer) CompleteAuth(ConnectionID int64, SessionID string, SPServiceIndex int32, RelayState string, Tag string) (int32, error)

Remarks

Use this method to pass a SAML assertion to a chosen SP after completion of the IdP-initiated SSO process.

Calling this method is equivalent to navigating to the SP-specific IdP link on the web server running the SAML IdP service.

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.

Config Method (SAMLIdPServer Component)

Sets or retrieves a configuration setting.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Performs an additional action.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Terminates a client connection.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Saves the SP or IdP configuration to an XML metadata file.

Syntax

func (obj *SAMLIdPServer) ExportSettings(IdP bool, Index int32) (string, error)

Remarks

Use this method to save the Identity Provider (IdP) or Service Provider (SP) configuration in the form of XML metadata. The IdP metadata file may then be transferred to identity providers (SP) to let them know about the IdP configuration.

When exporting IdP settings, adjust the identity provider configuration as required in IdPSettings object before calling this method. Assign MetaSigningCertificate to enforce signing of the metadata XML.

When exporting SP settings, provide the index of the service provider in the SPSettings list.

GetClientBuffer Method (SAMLIdPServer Component)

Acquires a piece of operation data.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Returns the value of a custom provider property.

Syntax

func (obj *SAMLIdPServer) GetProviderProperty(Name string) (string, error)

Remarks

This method, together with SetProviderProperty, provides an extensible way of managing the Identity 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 (SAMLIdPServer Component)

Returns the contents of the received HTTP request.

Syntax

func (obj *SAMLIdPServer) GetRequestBytes(ConnectionID int64, RequestFilter string) ([]byte, error)

Remarks

Use this method to get the body of the received HTTP request. Note that the body of GET and HEAD requests is empty. The method returns the requested content.

GetRequestHeader Method (SAMLIdPServer Component)

Returns a request header value.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Returns a response header value.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Returns the value of a custom session property.

Syntax

func (obj *SAMLIdPServer) GetSessionProperty(SessionID string, Name string) (string, error)

Remarks

This method, together with SetSessionProperty, provides an extensible way of managing the Identity 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 IdP sessions and can be passed to the Name parameter of this method:

AuthnContextClassRef: the authentication context Auth class.
AuthnRequestID: the AuthnRequest ID.
Binding: the binding type used.
Certificate: the certificate that signed the request (in base16 DER-encoded format).
CustomAuthFlow: whether the session uses a custom authentication flow.
Expires: the web session expiration time.
LoggedIn: whether the user associated with this session has successfully undergone the authentication procedures.
Login: the login name used by the user to authenticate themselves.
LoginAttempts: the number of login attempts available for the user.
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.
NameIDPolicyFormat: the name ID policy format.
NameIDPolicyIdentifier: the name ID policy identifier.
RelayState: the current (last) relay state entry.
ResponseLocation: the location where the response should be sent.
Session: the session ID (the same as you pass as parameter).
SessionIndex: the cross-network session index assigned to this session.
SP: the entity ID of the service provider.
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.

ImportSettings Method (SAMLIdPServer Component)

Loads the metadata required for information exchange with the identity provider. Both local (IdP-side) and remote (SP-side) metadata can be loaded with this call.

Syntax

func (obj *SAMLIdPServer) ImportSettings(Metadata string, IdP bool) error

Remarks

The Service provider (SP) may have a lot of different options and requirements for interactions with the Identity provider (IdP). 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 such file generated by the service provider.

The Metadata parameter contains metadata in the form of byte array. Set IdP parameter to true to indicate that it is the Identity Provider's own settings that are being loaded.

The loaded metadata is populated in the IdPSettings or SPSettings object (depending on the value of the IdP parameter).

InitiateArtifactResolve Method (SAMLIdPServer Component)

Initiates the artifact resolution protocol.

Syntax

func (obj *SAMLIdPServer) InitiateArtifactResolve(ConnectionID int64, SessionID string, SPServiceIndex 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 SPServiceIndex 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 (SAMLIdPServer Component)

Starts IdP-initiated SAML authentication flow.

Syntax

func (obj *SAMLIdPServer) InitiateAuth(ConnectionID int64, SessionID string, SPServiceIndex int32, Tag string) (int32, error)

Remarks

Use this method to initiate SAML authentication flow on the IdP side.


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.

Once the user has been authenticated, you can use ProcessSignOnRequest to generate SAML assertions for specific SPs.

InitiateLogout Method (SAMLIdPServer Component)

Starts IdP-initiated SAML logout flow.

Syntax

func (obj *SAMLIdPServer) InitiateLogout(ConnectionID int64, SessionID string, SPServiceIndex int32, Tag string) (int32, error)

Remarks

Use this method to initiate SAML logout flow on the IdP side. Pass the index of the logout endpoint that you want to use to the SPServiceIndex 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.

ListClients Method (SAMLIdPServer Component)

Enumerates the connected clients.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Takes a snapshot of the connection's properties.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Processes an artifact request received from the SP service at one of artifact receiver endpoints.

Syntax

func (obj *SAMLIdPServer) 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 AuthnRequestReceived.


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

Processes an artifact request received from the SP service at one of the ARS endpoints.

Syntax

func (obj *SAMLIdPServer) 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.


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.

ProcessAttributeQuery Method (SAMLIdPServer Component)

Processes an attribute request received from the SP service at one of the AQS endpoints.

Syntax

func (obj *SAMLIdPServer) ProcessAttributeQuery(ConnectionID int64, SessionID string, Request string, Tag string) (int32, error)

Remarks

Use this method to pass a SAML attribute request received at one of the AttributeQueryService endpoints.


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.

ProcessGenericRequest Method (SAMLIdPServer Component)

Processes a generic HTTP SAML request.

Syntax

func (obj *SAMLIdPServer) 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.

You can use this method with or without the OfflineMode.

ProcessLogoutRequest Method (SAMLIdPServer Component)

Processes logout request received from the SP service at one of the SLS endpoints.

Syntax

func (obj *SAMLIdPServer) 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 returned content is empty.


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.

ProcessSignOnRequest Method (SAMLIdPServer Component)

Processes a single sign-on request received from the SP service at one of the SSO endpoints.

Syntax

func (obj *SAMLIdPServer) ProcessSignOnRequest(ConnectionID int64, SessionID string, Request string, Tag string) (int32, error)

Remarks

Use this method to pass a SAML Single Sign-On request received at one of the SingleSignOnService endpoints.


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.

ProcessSignOnResponse Method (SAMLIdPServer Component)

Processes the submission of the login form previously generated by the IdP server.

Syntax

func (obj *SAMLIdPServer) ProcessSignOnResponse(ConnectionID int64, SessionID string, Response string, Tag string) (int32, error)

Remarks

Use this method to pass the login form data that was received from the user in response to the presented login form, to the IdP server. If the provided data matches the form, the credentials are passed to the application via the UserAuthVerifyCredentials event.


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.

RemoveSP Method (SAMLIdPServer Component)

Removes an SP from the list of known service providers.

Syntax

func (obj *SAMLIdPServer) RemoveSP(Index int32) error

Remarks

Use this method to remove information about a service provider from the SPSettings list. The IdP server will be unable to process any further requests from this provider once it is removed.

Reset Method (SAMLIdPServer Component)

Resets the class settings.

Syntax

func (obj *SAMLIdPServer) Reset() error

Remarks

Reset is a generic method available in every struct.

SetClientBuffer Method (SAMLIdPServer Component)

Commits a data buffer to the connection.

Syntax

func (obj *SAMLIdPServer) SetClientBuffer(ConnectionID int64, Handle string, Value []byte) error

Remarks

Use this method from your ResourceRead event handler to commit a chunk of file data to the server component.

SetProviderProperty Method (SAMLIdPServer Component)

Sets the value of a custom provider property.

Syntax

func (obj *SAMLIdPServer) SetProviderProperty(Name string, Value string) error

Remarks

This method, together with GetProviderProperty, provides an extensible way of managing the Identity 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 (SAMLIdPServer Component)

Sets a response header.

Syntax

func (obj *SAMLIdPServer) 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 (SAMLIdPServer Component)

Sets the value of a custom provider session property.

Syntax

func (obj *SAMLIdPServer) SetSessionProperty(SessionID string, Name string, Value string) error

Remarks

This method, together with GetSessionProperty, provides an extensible way of managing the Identity 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:

AuthnContextClassRef: the authentication context Auth class.
AuthnRequestID: the AuthnRequest ID.
Certificate: the certificate that signed the request (in base16 DER-encoded format).
CustomAuthFlow: whether the session uses a custom authentication flow.
Login: the login name used by the user to authenticate themselves.
LoginAttempts: the number of login attempts available for the user.
LogoutRequestID: the LogoutRequest ID.
NameID: the NameID of the user.
NameIDPolicyFormat: the name ID policy format.
NameIDPolicyIdentifier: the name ID policy identifier.
RelayState: the current (last) relay state entry.
ResponseLocation: the location where the response should be sent.
Session: the session ID (the same as you pass as parameter).
SessionIndex: the cross-network session index 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.

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 it will contain a now-unmatching In-Response-To entry.

Start Method (SAMLIdPServer Component)

Starts the IdP server.

Syntax

func (obj *SAMLIdPServer) Start() error

Remarks

Use this method to start listening for incoming connections.

Stop Method (SAMLIdPServer Component)

Stops the IdP server.

Syntax

func (obj *SAMLIdPServer) Stop() error

Remarks

Call this method to stop listening for incoming connections.

Accept Event (SAMLIdPServer Component)

Reports an incoming connection.

Syntax

// SAMLIdPServerAcceptEventArgs carries the SAMLIdPServer Accept event's parameters.
type SAMLIdPServerAcceptEventArgs struct {...}

func (args *SAMLIdPServerAcceptEventArgs) RemoteAddress() string
func (args *SAMLIdPServerAcceptEventArgs) RemotePort() int32
func (args *SAMLIdPServerAcceptEventArgs) Accept() bool
func (args *SAMLIdPServerAcceptEventArgs) SetAccept(value bool)

// SAMLIdPServerAcceptEvent defines the signature of the SAMLIdPServer Accept event's handler function.
type SAMLIdPServerAcceptEvent func(sender *SAMLIdPServer, args *SAMLIdPServerAcceptEventArgs)

func (obj *SAMLIdPServer) GetOnAcceptHandler() SAMLIdPServerAcceptEvent
func (obj *SAMLIdPServer) SetOnAcceptHandler(handlerFunc SAMLIdPServerAcceptEvent)

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

The server fires this event upon receiving an Artifact message from the other side.

Syntax

// SAMLIdPServerArtifactReceivedEventArgs carries the SAMLIdPServer ArtifactReceived event's parameters.
type SAMLIdPServerArtifactReceivedEventArgs struct {...}

func (args *SAMLIdPServerArtifactReceivedEventArgs) ConnectionID() int64
func (args *SAMLIdPServerArtifactReceivedEventArgs) SessionID() string
func (args *SAMLIdPServerArtifactReceivedEventArgs) RequestID() string
func (args *SAMLIdPServerArtifactReceivedEventArgs) SP() string
func (args *SAMLIdPServerArtifactReceivedEventArgs) Artifact() string
func (args *SAMLIdPServerArtifactReceivedEventArgs) Action() int32
func (args *SAMLIdPServerArtifactReceivedEventArgs) SetAction(value int32)

// SAMLIdPServerArtifactReceivedEvent defines the signature of the SAMLIdPServer ArtifactReceived event's handler function.
type SAMLIdPServerArtifactReceivedEvent func(sender *SAMLIdPServer, args *SAMLIdPServerArtifactReceivedEventArgs)

func (obj *SAMLIdPServer) GetOnArtifactReceivedHandler() SAMLIdPServerArtifactReceivedEvent
func (obj *SAMLIdPServer) SetOnArtifactReceivedHandler(handlerFunc SAMLIdPServerArtifactReceivedEvent)

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

This event is fired when a new artifact resolution request message has been prepared by the class.

Syntax

// SAMLIdPServerArtifactResolveRequestPreparedEventArgs carries the SAMLIdPServer ArtifactResolveRequestPrepared event's parameters.
type SAMLIdPServerArtifactResolveRequestPreparedEventArgs struct {...}

func (args *SAMLIdPServerArtifactResolveRequestPreparedEventArgs) ConnectionID() int64
func (args *SAMLIdPServerArtifactResolveRequestPreparedEventArgs) SessionID() string
func (args *SAMLIdPServerArtifactResolveRequestPreparedEventArgs) RequestID() string
func (args *SAMLIdPServerArtifactResolveRequestPreparedEventArgs) SP() string
func (args *SAMLIdPServerArtifactResolveRequestPreparedEventArgs) Artifact() string
// SAMLIdPServerArtifactResolveRequestPreparedEvent defines the signature of the SAMLIdPServer ArtifactResolveRequestPrepared event's handler function.
type SAMLIdPServerArtifactResolveRequestPreparedEvent func(sender *SAMLIdPServer, args *SAMLIdPServerArtifactResolveRequestPreparedEventArgs)

func (obj *SAMLIdPServer) GetOnArtifactResolveRequestPreparedHandler() SAMLIdPServerArtifactResolveRequestPreparedEvent
func (obj *SAMLIdPServer) SetOnArtifactResolveRequestPreparedHandler(handlerFunc SAMLIdPServerArtifactResolveRequestPreparedEvent)

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 service provider.

ArtifactResolveRequestReceived Event (SAMLIdPServer Component)

Reports receipt of ArtifactResolveRequest message.

Syntax

// SAMLIdPServerArtifactResolveRequestReceivedEventArgs carries the SAMLIdPServer ArtifactResolveRequestReceived event's parameters.
type SAMLIdPServerArtifactResolveRequestReceivedEventArgs struct {...}

func (args *SAMLIdPServerArtifactResolveRequestReceivedEventArgs) ConnectionID() int64
func (args *SAMLIdPServerArtifactResolveRequestReceivedEventArgs) SessionID() string
func (args *SAMLIdPServerArtifactResolveRequestReceivedEventArgs) RequestID() string
func (args *SAMLIdPServerArtifactResolveRequestReceivedEventArgs) SP() string
func (args *SAMLIdPServerArtifactResolveRequestReceivedEventArgs) IsEncrypted() bool
func (args *SAMLIdPServerArtifactResolveRequestReceivedEventArgs) IsSigned() bool
func (args *SAMLIdPServerArtifactResolveRequestReceivedEventArgs) Artifact() string
func (args *SAMLIdPServerArtifactResolveRequestReceivedEventArgs) Action() int32
func (args *SAMLIdPServerArtifactResolveRequestReceivedEventArgs) SetAction(value int32)

// SAMLIdPServerArtifactResolveRequestReceivedEvent defines the signature of the SAMLIdPServer ArtifactResolveRequestReceived event's handler function.
type SAMLIdPServerArtifactResolveRequestReceivedEvent func(sender *SAMLIdPServer, args *SAMLIdPServerArtifactResolveRequestReceivedEventArgs)

func (obj *SAMLIdPServer) GetOnArtifactResolveRequestReceivedHandler() SAMLIdPServerArtifactResolveRequestReceivedEvent
func (obj *SAMLIdPServer) SetOnArtifactResolveRequestReceivedHandler(handlerFunc SAMLIdPServerArtifactResolveRequestReceivedEvent)

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

AssertionPrepared Event (SAMLIdPServer Component)

This event fires when a new assertion has been prepared by the IdP server.

Syntax

// SAMLIdPServerAssertionPreparedEventArgs carries the SAMLIdPServer AssertionPrepared event's parameters.
type SAMLIdPServerAssertionPreparedEventArgs struct {...}

func (args *SAMLIdPServerAssertionPreparedEventArgs) ConnectionID() int64
func (args *SAMLIdPServerAssertionPreparedEventArgs) SessionID() string
func (args *SAMLIdPServerAssertionPreparedEventArgs) RequestID() string
func (args *SAMLIdPServerAssertionPreparedEventArgs) SP() string
func (args *SAMLIdPServerAssertionPreparedEventArgs) Body() string
func (args *SAMLIdPServerAssertionPreparedEventArgs) Auth() string
func (args *SAMLIdPServerAssertionPreparedEventArgs) NameID() string
func (args *SAMLIdPServerAssertionPreparedEventArgs) NameIDFormat() string
func (args *SAMLIdPServerAssertionPreparedEventArgs) SessionIndex() string
func (args *SAMLIdPServerAssertionPreparedEventArgs) Attributes() string
func (args *SAMLIdPServerAssertionPreparedEventArgs) ValidFrom() string
func (args *SAMLIdPServerAssertionPreparedEventArgs) ValidTo() string
// SAMLIdPServerAssertionPreparedEvent defines the signature of the SAMLIdPServer AssertionPrepared event's handler function.
type SAMLIdPServerAssertionPreparedEvent func(sender *SAMLIdPServer, args *SAMLIdPServerAssertionPreparedEventArgs)

func (obj *SAMLIdPServer) GetOnAssertionPreparedHandler() SAMLIdPServerAssertionPreparedEvent
func (obj *SAMLIdPServer) SetOnAssertionPreparedHandler(handlerFunc SAMLIdPServerAssertionPreparedEvent)

Remarks

The component fires this event when it has prepared an assertion to be sent to the SP as part of the authentication process. This event may fire from within ProcessSignOnRequest and ProcessSignOnResponse calls when working in OfflineMode, and at any time otherwise.

The RequestID parameter contains the request ID, in response to which the assertion was created. The SP parameter contains the identifier of the service provider where the assertion will be sent to. The Body parameter contains the assertion itself in XML format. The NameID parameter contains the name identifier of the authenticated user, and SessionIndex the unique session index of the new session. The ValidFrom and ValidTo parameters specify the validity period of the assertion.

AttributeQueryReceived Event (SAMLIdPServer Component)

Notifies the application about receipt of an AttributeQuery.

Syntax

// SAMLIdPServerAttributeQueryReceivedEventArgs carries the SAMLIdPServer AttributeQueryReceived event's parameters.
type SAMLIdPServerAttributeQueryReceivedEventArgs struct {...}

func (args *SAMLIdPServerAttributeQueryReceivedEventArgs) ConnectionID() int64
func (args *SAMLIdPServerAttributeQueryReceivedEventArgs) SessionID() string
func (args *SAMLIdPServerAttributeQueryReceivedEventArgs) RequestID() string
func (args *SAMLIdPServerAttributeQueryReceivedEventArgs) SP() string
func (args *SAMLIdPServerAttributeQueryReceivedEventArgs) IsEncrypted() bool
func (args *SAMLIdPServerAttributeQueryReceivedEventArgs) IsSigned() bool
func (args *SAMLIdPServerAttributeQueryReceivedEventArgs) NameID() string
func (args *SAMLIdPServerAttributeQueryReceivedEventArgs) NameIDFormat() string
func (args *SAMLIdPServerAttributeQueryReceivedEventArgs) Attributes() string
func (args *SAMLIdPServerAttributeQueryReceivedEventArgs) Action() int32
func (args *SAMLIdPServerAttributeQueryReceivedEventArgs) SetAction(value int32)

// SAMLIdPServerAttributeQueryReceivedEvent defines the signature of the SAMLIdPServer AttributeQueryReceived event's handler function.
type SAMLIdPServerAttributeQueryReceivedEvent func(sender *SAMLIdPServer, args *SAMLIdPServerAttributeQueryReceivedEventArgs)

func (obj *SAMLIdPServer) GetOnAttributeQueryReceivedHandler() SAMLIdPServerAttributeQueryReceivedEvent
func (obj *SAMLIdPServer) SetOnAttributeQueryReceivedHandler(handlerFunc SAMLIdPServerAttributeQueryReceivedEvent)

Remarks

The component fires this event to notify the application of receipt of an AttributeQuery message. The parameters of the event detail the properties included in the request. The NameID and NameIDFormat specify the subject, and the Attributes string contains a list of attributes being requested.

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 application chooses to process the request manually, the component will go ahead to fire ReadAttribute event repeatedly for each attribute in the list. The application must subscribe to the event and return the attribute parameters and values from there.

AuthnRequestReceived Event (SAMLIdPServer Component)

The server fires this event upon receiving an AuthnRequest message from the other side.

Syntax

// SAMLIdPServerAuthnRequestReceivedEventArgs carries the SAMLIdPServer AuthnRequestReceived event's parameters.
type SAMLIdPServerAuthnRequestReceivedEventArgs struct {...}

func (args *SAMLIdPServerAuthnRequestReceivedEventArgs) ConnectionID() int64
func (args *SAMLIdPServerAuthnRequestReceivedEventArgs) SessionID() string
func (args *SAMLIdPServerAuthnRequestReceivedEventArgs) RequestID() string
func (args *SAMLIdPServerAuthnRequestReceivedEventArgs) SP() string
func (args *SAMLIdPServerAuthnRequestReceivedEventArgs) IsEncrypted() bool
func (args *SAMLIdPServerAuthnRequestReceivedEventArgs) IsSigned() bool
func (args *SAMLIdPServerAuthnRequestReceivedEventArgs) NameIDFormat() string
func (args *SAMLIdPServerAuthnRequestReceivedEventArgs) SetNameIDFormat(value string)

func (args *SAMLIdPServerAuthnRequestReceivedEventArgs) ForceAuthn() bool
func (args *SAMLIdPServerAuthnRequestReceivedEventArgs) SetForceAuthn(value bool)

func (args *SAMLIdPServerAuthnRequestReceivedEventArgs) NonInteractive() bool
func (args *SAMLIdPServerAuthnRequestReceivedEventArgs) SetNonInteractive(value bool)

func (args *SAMLIdPServerAuthnRequestReceivedEventArgs) Authenticated() bool
func (args *SAMLIdPServerAuthnRequestReceivedEventArgs) SetAuthenticated(value bool)

func (args *SAMLIdPServerAuthnRequestReceivedEventArgs) Action() int32
func (args *SAMLIdPServerAuthnRequestReceivedEventArgs) SetAction(value int32)

// SAMLIdPServerAuthnRequestReceivedEvent defines the signature of the SAMLIdPServer AuthnRequestReceived event's handler function.
type SAMLIdPServerAuthnRequestReceivedEvent func(sender *SAMLIdPServer, args *SAMLIdPServerAuthnRequestReceivedEventArgs)

func (obj *SAMLIdPServer) GetOnAuthnRequestReceivedHandler() SAMLIdPServerAuthnRequestReceivedEvent
func (obj *SAMLIdPServer) SetOnAuthnRequestReceivedHandler(handlerFunc SAMLIdPServerAuthnRequestReceivedEvent)

Remarks

The event reports the details of the received AuthnRequest message. The ForceAuthn and NonInteractive parameters contain optional suggestions included in the request. The Authenticated parameter specifies whether the user has already been authenticated within this session. All the three parameters can be adjusted in the event handler to direct the authentication logic in the required direction.

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

In OfflineMode this event would typically be fired from ProcessSignOnRequest call.

Connect Event (SAMLIdPServer Component)

Reports an accepted connection.

Syntax

// SAMLIdPServerConnectEventArgs carries the SAMLIdPServer Connect event's parameters.
type SAMLIdPServerConnectEventArgs struct {...}

func (args *SAMLIdPServerConnectEventArgs) ConnectionId() int64
func (args *SAMLIdPServerConnectEventArgs) RemoteAddress() string
func (args *SAMLIdPServerConnectEventArgs) RemotePort() int32
// SAMLIdPServerConnectEvent defines the signature of the SAMLIdPServer Connect event's handler function.
type SAMLIdPServerConnectEvent func(sender *SAMLIdPServer, args *SAMLIdPServerConnectEventArgs)

func (obj *SAMLIdPServer) GetOnConnectHandler() SAMLIdPServerConnectEvent
func (obj *SAMLIdPServer) SetOnConnectHandler(handlerFunc SAMLIdPServerConnectEvent)

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

Fires to report a disconnected client.

Syntax

// SAMLIdPServerDisconnectEventArgs carries the SAMLIdPServer Disconnect event's parameters.
type SAMLIdPServerDisconnectEventArgs struct {...}

func (args *SAMLIdPServerDisconnectEventArgs) ConnectionID() int64
// SAMLIdPServerDisconnectEvent defines the signature of the SAMLIdPServer Disconnect event's handler function.
type SAMLIdPServerDisconnectEvent func(sender *SAMLIdPServer, args *SAMLIdPServerDisconnectEventArgs)

func (obj *SAMLIdPServer) GetOnDisconnectHandler() SAMLIdPServerDisconnectEvent
func (obj *SAMLIdPServer) SetOnDisconnectHandler(handlerFunc SAMLIdPServerDisconnectEvent)

Remarks

The struct fires this event when a connected client disconnects.

Error Event (SAMLIdPServer Component)

Information about errors during data delivery.

Syntax

// SAMLIdPServerErrorEventArgs carries the SAMLIdPServer Error event's parameters.
type SAMLIdPServerErrorEventArgs struct {...}

func (args *SAMLIdPServerErrorEventArgs) ConnectionID() int64
func (args *SAMLIdPServerErrorEventArgs) SessionID() string
func (args *SAMLIdPServerErrorEventArgs) ErrorCode() int32
func (args *SAMLIdPServerErrorEventArgs) Fatal() bool
func (args *SAMLIdPServerErrorEventArgs) Remote() bool
func (args *SAMLIdPServerErrorEventArgs) Description() string
// SAMLIdPServerErrorEvent defines the signature of the SAMLIdPServer Error event's handler function.
type SAMLIdPServerErrorEvent func(sender *SAMLIdPServer, args *SAMLIdPServerErrorEventArgs)

func (obj *SAMLIdPServer) GetOnErrorHandler() SAMLIdPServerErrorEvent
func (obj *SAMLIdPServer) SetOnErrorHandler(handlerFunc SAMLIdPServerErrorEvent)

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

Handles remote or external signing initiated by the server protocol.

Syntax

// SAMLIdPServerExternalSignEventArgs carries the SAMLIdPServer ExternalSign event's parameters.
type SAMLIdPServerExternalSignEventArgs struct {...}

func (args *SAMLIdPServerExternalSignEventArgs) ConnectionID() int64
func (args *SAMLIdPServerExternalSignEventArgs) OperationId() string
func (args *SAMLIdPServerExternalSignEventArgs) HashAlgorithm() string
func (args *SAMLIdPServerExternalSignEventArgs) Pars() string
func (args *SAMLIdPServerExternalSignEventArgs) Data() string
func (args *SAMLIdPServerExternalSignEventArgs) SignedData() string
func (args *SAMLIdPServerExternalSignEventArgs) SetSignedData(value string)

// SAMLIdPServerExternalSignEvent defines the signature of the SAMLIdPServer ExternalSign event's handler function.
type SAMLIdPServerExternalSignEvent func(sender *SAMLIdPServer, args *SAMLIdPServerExternalSignEventArgs)

func (obj *SAMLIdPServer) GetOnExternalSignHandler() SAMLIdPServerExternalSignEvent
func (obj *SAMLIdPServer) SetOnExternalSignHandler(handlerFunc SAMLIdPServerExternalSignEvent)

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

This event is fired when a new logout request has been prepared.

Syntax

// SAMLIdPServerLogoutRequestPreparedEventArgs carries the SAMLIdPServer LogoutRequestPrepared event's parameters.
type SAMLIdPServerLogoutRequestPreparedEventArgs struct {...}

func (args *SAMLIdPServerLogoutRequestPreparedEventArgs) ConnectionID() int64
func (args *SAMLIdPServerLogoutRequestPreparedEventArgs) SessionID() string
func (args *SAMLIdPServerLogoutRequestPreparedEventArgs) RequestID() string
func (args *SAMLIdPServerLogoutRequestPreparedEventArgs) SP() string
func (args *SAMLIdPServerLogoutRequestPreparedEventArgs) NameID() string
func (args *SAMLIdPServerLogoutRequestPreparedEventArgs) NameIDFormat() string
func (args *SAMLIdPServerLogoutRequestPreparedEventArgs) SessionIndex() string
func (args *SAMLIdPServerLogoutRequestPreparedEventArgs) RelayState() string
func (args *SAMLIdPServerLogoutRequestPreparedEventArgs) SetRelayState(value string)

// SAMLIdPServerLogoutRequestPreparedEvent defines the signature of the SAMLIdPServer LogoutRequestPrepared event's handler function.
type SAMLIdPServerLogoutRequestPreparedEvent func(sender *SAMLIdPServer, args *SAMLIdPServerLogoutRequestPreparedEventArgs)

func (obj *SAMLIdPServer) GetOnLogoutRequestPreparedHandler() SAMLIdPServerLogoutRequestPreparedEvent
func (obj *SAMLIdPServer) SetOnLogoutRequestPreparedHandler(handlerFunc SAMLIdPServerLogoutRequestPreparedEvent)

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

The class uses this event to notify the application about an incoming SAML Logout Request message.

Syntax

// SAMLIdPServerLogoutRequestReceivedEventArgs carries the SAMLIdPServer LogoutRequestReceived event's parameters.
type SAMLIdPServerLogoutRequestReceivedEventArgs struct {...}

func (args *SAMLIdPServerLogoutRequestReceivedEventArgs) ConnectionID() int64
func (args *SAMLIdPServerLogoutRequestReceivedEventArgs) SessionID() string
func (args *SAMLIdPServerLogoutRequestReceivedEventArgs) RequestID() string
func (args *SAMLIdPServerLogoutRequestReceivedEventArgs) SP() string
func (args *SAMLIdPServerLogoutRequestReceivedEventArgs) IsEncrypted() bool
func (args *SAMLIdPServerLogoutRequestReceivedEventArgs) IsSigned() bool
func (args *SAMLIdPServerLogoutRequestReceivedEventArgs) NameID() string
func (args *SAMLIdPServerLogoutRequestReceivedEventArgs) NameIDFormat() string
func (args *SAMLIdPServerLogoutRequestReceivedEventArgs) SessionIndex() string
func (args *SAMLIdPServerLogoutRequestReceivedEventArgs) Action() int32
func (args *SAMLIdPServerLogoutRequestReceivedEventArgs) SetAction(value int32)

// SAMLIdPServerLogoutRequestReceivedEvent defines the signature of the SAMLIdPServer LogoutRequestReceived event's handler function.
type SAMLIdPServerLogoutRequestReceivedEvent func(sender *SAMLIdPServer, args *SAMLIdPServerLogoutRequestReceivedEventArgs)

func (obj *SAMLIdPServer) GetOnLogoutRequestReceivedHandler() SAMLIdPServerLogoutRequestReceivedEvent
func (obj *SAMLIdPServer) SetOnLogoutRequestReceivedHandler(handlerFunc SAMLIdPServerLogoutRequestReceivedEvent)

Remarks

The SAML IdP 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 (SAMLIdPServer Component)

The class uses this event to notify the application about the Logout Response message being ready to be sent.

Syntax

// SAMLIdPServerLogoutResponsePreparedEventArgs carries the SAMLIdPServer LogoutResponsePrepared event's parameters.
type SAMLIdPServerLogoutResponsePreparedEventArgs struct {...}

func (args *SAMLIdPServerLogoutResponsePreparedEventArgs) ConnectionID() int64
func (args *SAMLIdPServerLogoutResponsePreparedEventArgs) SessionID() string
func (args *SAMLIdPServerLogoutResponsePreparedEventArgs) RequestID() string
func (args *SAMLIdPServerLogoutResponsePreparedEventArgs) SP() string
func (args *SAMLIdPServerLogoutResponsePreparedEventArgs) Body() string
func (args *SAMLIdPServerLogoutResponsePreparedEventArgs) NameID() string
func (args *SAMLIdPServerLogoutResponsePreparedEventArgs) NameIDFormat() string
func (args *SAMLIdPServerLogoutResponsePreparedEventArgs) SessionIndex() string
// SAMLIdPServerLogoutResponsePreparedEvent defines the signature of the SAMLIdPServer LogoutResponsePrepared event's handler function.
type SAMLIdPServerLogoutResponsePreparedEvent func(sender *SAMLIdPServer, args *SAMLIdPServerLogoutResponsePreparedEventArgs)

func (obj *SAMLIdPServer) GetOnLogoutResponsePreparedHandler() SAMLIdPServerLogoutResponsePreparedEvent
func (obj *SAMLIdPServer) SetOnLogoutResponsePreparedHandler(handlerFunc SAMLIdPServerLogoutResponsePreparedEvent)

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

The class uses this event to notify the application about an incoming SAML LogoutResponse message.

Syntax

// SAMLIdPServerLogoutResponseReceivedEventArgs carries the SAMLIdPServer LogoutResponseReceived event's parameters.
type SAMLIdPServerLogoutResponseReceivedEventArgs struct {...}

func (args *SAMLIdPServerLogoutResponseReceivedEventArgs) ConnectionID() int64
func (args *SAMLIdPServerLogoutResponseReceivedEventArgs) SessionID() string
func (args *SAMLIdPServerLogoutResponseReceivedEventArgs) RequestID() string
func (args *SAMLIdPServerLogoutResponseReceivedEventArgs) SP() string
func (args *SAMLIdPServerLogoutResponseReceivedEventArgs) IsEncrypted() bool
func (args *SAMLIdPServerLogoutResponseReceivedEventArgs) IsSigned() bool
func (args *SAMLIdPServerLogoutResponseReceivedEventArgs) NameID() string
func (args *SAMLIdPServerLogoutResponseReceivedEventArgs) NameIDFormat() string
func (args *SAMLIdPServerLogoutResponseReceivedEventArgs) SessionIndex() string
func (args *SAMLIdPServerLogoutResponseReceivedEventArgs) RelayState() string
func (args *SAMLIdPServerLogoutResponseReceivedEventArgs) Action() int32
func (args *SAMLIdPServerLogoutResponseReceivedEventArgs) SetAction(value int32)

// SAMLIdPServerLogoutResponseReceivedEvent defines the signature of the SAMLIdPServer LogoutResponseReceived event's handler function.
type SAMLIdPServerLogoutResponseReceivedEvent func(sender *SAMLIdPServer, args *SAMLIdPServerLogoutResponseReceivedEventArgs)

func (obj *SAMLIdPServer) GetOnLogoutResponseReceivedHandler() SAMLIdPServerLogoutResponseReceivedEvent
func (obj *SAMLIdPServer) SetOnLogoutResponseReceivedHandler(handlerFunc SAMLIdPServerLogoutResponseReceivedEvent)

Remarks

The SAML IdP 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

NewAssertion Event (SAMLIdPServer Component)

This event reports a new assertion initiated by the IdP server.

Syntax

// SAMLIdPServerNewAssertionEventArgs carries the SAMLIdPServer NewAssertion event's parameters.
type SAMLIdPServerNewAssertionEventArgs struct {...}

func (args *SAMLIdPServerNewAssertionEventArgs) ConnectionID() int64
func (args *SAMLIdPServerNewAssertionEventArgs) SessionID() string
func (args *SAMLIdPServerNewAssertionEventArgs) RequestID() string
func (args *SAMLIdPServerNewAssertionEventArgs) SP() string
func (args *SAMLIdPServerNewAssertionEventArgs) Reason() int32
func (args *SAMLIdPServerNewAssertionEventArgs) AuthInstant() string
func (args *SAMLIdPServerNewAssertionEventArgs) SetAuthInstant(value string)

func (args *SAMLIdPServerNewAssertionEventArgs) AuthContext() string
func (args *SAMLIdPServerNewAssertionEventArgs) SetAuthContext(value string)

func (args *SAMLIdPServerNewAssertionEventArgs) NameID() string
func (args *SAMLIdPServerNewAssertionEventArgs) SetNameID(value string)

func (args *SAMLIdPServerNewAssertionEventArgs) NameIDFormat() string
func (args *SAMLIdPServerNewAssertionEventArgs) SetNameIDFormat(value string)

func (args *SAMLIdPServerNewAssertionEventArgs) SessionIndex() string
func (args *SAMLIdPServerNewAssertionEventArgs) SetSessionIndex(value string)

func (args *SAMLIdPServerNewAssertionEventArgs) Attributes() string
func (args *SAMLIdPServerNewAssertionEventArgs) SetAttributes(value string)

func (args *SAMLIdPServerNewAssertionEventArgs) ValidFrom() string
func (args *SAMLIdPServerNewAssertionEventArgs) SetValidFrom(value string)

func (args *SAMLIdPServerNewAssertionEventArgs) ValidTo() string
func (args *SAMLIdPServerNewAssertionEventArgs) SetValidTo(value string)

func (args *SAMLIdPServerNewAssertionEventArgs) Sign() bool
func (args *SAMLIdPServerNewAssertionEventArgs) SetSign(value bool)

func (args *SAMLIdPServerNewAssertionEventArgs) Encrypt() bool
func (args *SAMLIdPServerNewAssertionEventArgs) SetEncrypt(value bool)

// SAMLIdPServerNewAssertionEvent defines the signature of the SAMLIdPServer NewAssertion event's handler function.
type SAMLIdPServerNewAssertionEvent func(sender *SAMLIdPServer, args *SAMLIdPServerNewAssertionEventArgs)

func (obj *SAMLIdPServer) GetOnNewAssertionHandler() SAMLIdPServerNewAssertionEvent
func (obj *SAMLIdPServer) SetOnNewAssertionHandler(handlerFunc SAMLIdPServerNewAssertionEvent)

Remarks

The component fires this event when it is about to prepare an assertion to be sent to the SP as part of the authentication or attribute request process. This event may fire from within the ProcessSignOnRequest and ProcessSignOnResponse calls when working in OfflineMode, and at any time otherwise.

The RequestID parameter contains the request ID, in response to which the assertion is being created. The SP parameter contains the identifier of the service provider where the assertion will be sent to.

The Reason parameter contains the reason for the assertion to be generated. This can be an authentication request or an attribute request being received. The AuthInstant, AuthContext, NameID, SessionIndex, Attributes, ValidFrom, and ValidTo parameters indicate the initial parameters of the new assertion. Further events, such as ReadAttribute or AssertionPrepared will be fired later on to clarify the contents of the assertion.

Notification Event (SAMLIdPServer Component)

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

Syntax

// SAMLIdPServerNotificationEventArgs carries the SAMLIdPServer Notification event's parameters.
type SAMLIdPServerNotificationEventArgs struct {...}

func (args *SAMLIdPServerNotificationEventArgs) EventID() string
func (args *SAMLIdPServerNotificationEventArgs) EventParam() string
// SAMLIdPServerNotificationEvent defines the signature of the SAMLIdPServer Notification event's handler function.
type SAMLIdPServerNotificationEvent func(sender *SAMLIdPServer, args *SAMLIdPServerNotificationEventArgs)

func (obj *SAMLIdPServer) GetOnNotificationHandler() SAMLIdPServerNotificationEvent
func (obj *SAMLIdPServer) SetOnNotificationHandler(handlerFunc SAMLIdPServerNotificationEvent)

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:


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

This event notifies the application of the completion of request or response processing.

Syntax

// SAMLIdPServerProcessingCompletedEventArgs carries the SAMLIdPServer ProcessingCompleted event's parameters.
type SAMLIdPServerProcessingCompletedEventArgs struct {...}

func (args *SAMLIdPServerProcessingCompletedEventArgs) ConnectionID() int64
func (args *SAMLIdPServerProcessingCompletedEventArgs) SessionID() string
func (args *SAMLIdPServerProcessingCompletedEventArgs) Tag() string
func (args *SAMLIdPServerProcessingCompletedEventArgs) ProcessingResult() int32
func (args *SAMLIdPServerProcessingCompletedEventArgs) Response() string
func (args *SAMLIdPServerProcessingCompletedEventArgs) Redirect() bool
// SAMLIdPServerProcessingCompletedEvent defines the signature of the SAMLIdPServer ProcessingCompleted event's handler function.
type SAMLIdPServerProcessingCompletedEvent func(sender *SAMLIdPServer, args *SAMLIdPServerProcessingCompletedEventArgs)

func (obj *SAMLIdPServer) GetOnProcessingCompletedHandler() SAMLIdPServerProcessingCompletedEvent
func (obj *SAMLIdPServer) SetOnProcessingCompletedHandler(handlerFunc SAMLIdPServerProcessingCompletedEvent)

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 ProcessSignOnRequest, ProcessSignOnResponse, 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 web page containing a login form.
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 (SAMLIdPServer Component)

Requests content identified by an artifact from the application.

Syntax

// SAMLIdPServerReadArtifactEventArgs carries the SAMLIdPServer ReadArtifact event's parameters.
type SAMLIdPServerReadArtifactEventArgs struct {...}

func (args *SAMLIdPServerReadArtifactEventArgs) ConnectionID() int64
func (args *SAMLIdPServerReadArtifactEventArgs) SessionID() string
func (args *SAMLIdPServerReadArtifactEventArgs) RequestID() string
func (args *SAMLIdPServerReadArtifactEventArgs) SP() string
func (args *SAMLIdPServerReadArtifactEventArgs) Artifact() string
func (args *SAMLIdPServerReadArtifactEventArgs) Value() string
func (args *SAMLIdPServerReadArtifactEventArgs) SetValue(value string)

func (args *SAMLIdPServerReadArtifactEventArgs) Skip() bool
func (args *SAMLIdPServerReadArtifactEventArgs) SetSkip(value bool)

// SAMLIdPServerReadArtifactEvent defines the signature of the SAMLIdPServer ReadArtifact event's handler function.
type SAMLIdPServerReadArtifactEvent func(sender *SAMLIdPServer, args *SAMLIdPServerReadArtifactEventArgs)

func (obj *SAMLIdPServer) GetOnReadArtifactHandler() SAMLIdPServerReadArtifactEvent
func (obj *SAMLIdPServer) SetOnReadArtifactHandler(handlerFunc SAMLIdPServerReadArtifactEvent)

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

ReadAttribute Event (SAMLIdPServer Component)

Requests an attribute from the application.

Syntax

// SAMLIdPServerReadAttributeEventArgs carries the SAMLIdPServer ReadAttribute event's parameters.
type SAMLIdPServerReadAttributeEventArgs struct {...}

func (args *SAMLIdPServerReadAttributeEventArgs) ConnectionID() int64
func (args *SAMLIdPServerReadAttributeEventArgs) SessionID() string
func (args *SAMLIdPServerReadAttributeEventArgs) RequestID() string
func (args *SAMLIdPServerReadAttributeEventArgs) SP() string
func (args *SAMLIdPServerReadAttributeEventArgs) NameID() string
func (args *SAMLIdPServerReadAttributeEventArgs) NameIDFormat() string
func (args *SAMLIdPServerReadAttributeEventArgs) AttrName() string
func (args *SAMLIdPServerReadAttributeEventArgs) SetAttrName(value string)

func (args *SAMLIdPServerReadAttributeEventArgs) AttrNameFormat() string
func (args *SAMLIdPServerReadAttributeEventArgs) SetAttrNameFormat(value string)

func (args *SAMLIdPServerReadAttributeEventArgs) AttrFriendlyName() string
func (args *SAMLIdPServerReadAttributeEventArgs) SetAttrFriendlyName(value string)

func (args *SAMLIdPServerReadAttributeEventArgs) Value() string
func (args *SAMLIdPServerReadAttributeEventArgs) SetValue(value string)

func (args *SAMLIdPServerReadAttributeEventArgs) Skip() bool
func (args *SAMLIdPServerReadAttributeEventArgs) SetSkip(value bool)

// SAMLIdPServerReadAttributeEvent defines the signature of the SAMLIdPServer ReadAttribute event's handler function.
type SAMLIdPServerReadAttributeEvent func(sender *SAMLIdPServer, args *SAMLIdPServerReadAttributeEventArgs)

func (obj *SAMLIdPServer) GetOnReadAttributeHandler() SAMLIdPServerReadAttributeEvent
func (obj *SAMLIdPServer) SetOnReadAttributeHandler(handlerFunc SAMLIdPServerReadAttributeEvent)

Remarks

The component fires this event to request an attribute from the application. This event can be invoked multiple times after the AttributeQueryReceived event has fired, to collect every attribute requested.

The application is expected to set the Value and, optionally, AttrNameFormat and AttrFriendlyName for every attribute requested. The AttrName matches the name requested by the remote party, but the event handler can change it too if required.

If the application has no knowledge of or does not support the AttrName attribute, it can set Skip to true to avoid sending it.

ResourceClose Event (SAMLIdPServer Component)

Tells the application that it can close the opened resource.

Syntax

// SAMLIdPServerResourceCloseEventArgs carries the SAMLIdPServer ResourceClose event's parameters.
type SAMLIdPServerResourceCloseEventArgs struct {...}

func (args *SAMLIdPServerResourceCloseEventArgs) ConnectionID() int64
func (args *SAMLIdPServerResourceCloseEventArgs) SessionID() string
func (args *SAMLIdPServerResourceCloseEventArgs) Handle() string
// SAMLIdPServerResourceCloseEvent defines the signature of the SAMLIdPServer ResourceClose event's handler function.
type SAMLIdPServerResourceCloseEvent func(sender *SAMLIdPServer, args *SAMLIdPServerResourceCloseEventArgs)

func (obj *SAMLIdPServer) GetOnResourceCloseHandler() SAMLIdPServerResourceCloseEvent
func (obj *SAMLIdPServer) SetOnResourceCloseHandler(handlerFunc SAMLIdPServerResourceCloseEvent)

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

Requests the application to open the requested resource.

Syntax

// SAMLIdPServerResourceOpenEventArgs carries the SAMLIdPServer ResourceOpen event's parameters.
type SAMLIdPServerResourceOpenEventArgs struct {...}

func (args *SAMLIdPServerResourceOpenEventArgs) ConnectionID() int64
func (args *SAMLIdPServerResourceOpenEventArgs) SessionID() string
func (args *SAMLIdPServerResourceOpenEventArgs) URL() string
func (args *SAMLIdPServerResourceOpenEventArgs) HttpMethod() string
func (args *SAMLIdPServerResourceOpenEventArgs) OperationStatus() int32
func (args *SAMLIdPServerResourceOpenEventArgs) SetOperationStatus(value int32)

func (args *SAMLIdPServerResourceOpenEventArgs) Handle() string
func (args *SAMLIdPServerResourceOpenEventArgs) SetHandle(value string)

// SAMLIdPServerResourceOpenEvent defines the signature of the SAMLIdPServer ResourceOpen event's handler function.
type SAMLIdPServerResourceOpenEvent func(sender *SAMLIdPServer, args *SAMLIdPServerResourceOpenEventArgs)

func (obj *SAMLIdPServer) GetOnResourceOpenHandler() SAMLIdPServerResourceOpenEvent
func (obj *SAMLIdPServer) SetOnResourceOpenHandler(handlerFunc SAMLIdPServerResourceOpenEvent)

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

Requests the application to read from an opened resource.

Syntax

// SAMLIdPServerResourceReadEventArgs carries the SAMLIdPServer ResourceRead event's parameters.
type SAMLIdPServerResourceReadEventArgs struct {...}

func (args *SAMLIdPServerResourceReadEventArgs) ConnectionID() int64
func (args *SAMLIdPServerResourceReadEventArgs) SessionID() string
func (args *SAMLIdPServerResourceReadEventArgs) Handle() string
func (args *SAMLIdPServerResourceReadEventArgs) Size() int32
func (args *SAMLIdPServerResourceReadEventArgs) OperationStatus() int32
func (args *SAMLIdPServerResourceReadEventArgs) SetOperationStatus(value int32)

// SAMLIdPServerResourceReadEvent defines the signature of the SAMLIdPServer ResourceRead event's handler function.
type SAMLIdPServerResourceReadEvent func(sender *SAMLIdPServer, args *SAMLIdPServerResourceReadEventArgs)

func (obj *SAMLIdPServer) GetOnResourceReadHandler() SAMLIdPServerResourceReadEvent
func (obj *SAMLIdPServer) SetOnResourceReadHandler(handlerFunc SAMLIdPServerResourceReadEvent)

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

Notifies the application that a server resource is requested.

Syntax

// SAMLIdPServerResourceRequestEventArgs carries the SAMLIdPServer ResourceRequest event's parameters.
type SAMLIdPServerResourceRequestEventArgs struct {...}

func (args *SAMLIdPServerResourceRequestEventArgs) ConnectionID() int64
func (args *SAMLIdPServerResourceRequestEventArgs) SessionID() string
func (args *SAMLIdPServerResourceRequestEventArgs) URL() string
func (args *SAMLIdPServerResourceRequestEventArgs) HttpMethod() string
func (args *SAMLIdPServerResourceRequestEventArgs) ResProtected() bool
func (args *SAMLIdPServerResourceRequestEventArgs) SetResProtected(value bool)

func (args *SAMLIdPServerResourceRequestEventArgs) ResSpecial() bool
func (args *SAMLIdPServerResourceRequestEventArgs) SetResSpecial(value bool)

func (args *SAMLIdPServerResourceRequestEventArgs) AllowWriting() bool
func (args *SAMLIdPServerResourceRequestEventArgs) SetAllowWriting(value bool)

func (args *SAMLIdPServerResourceRequestEventArgs) Action() int32
func (args *SAMLIdPServerResourceRequestEventArgs) SetAction(value int32)

// SAMLIdPServerResourceRequestEvent defines the signature of the SAMLIdPServer ResourceRequest event's handler function.
type SAMLIdPServerResourceRequestEvent func(sender *SAMLIdPServer, args *SAMLIdPServerResourceRequestEventArgs)

func (obj *SAMLIdPServer) GetOnResourceRequestHandler() SAMLIdPServerResourceRequestEvent
func (obj *SAMLIdPServer) SetOnResourceRequestHandler(handlerFunc SAMLIdPServerResourceRequestEvent)

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

This event may fire more than once for one resource if the client is forced to re-submit the request with a session cookie.

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

Requests the application to write to an opened resource.

Syntax

// SAMLIdPServerResourceWriteEventArgs carries the SAMLIdPServer ResourceWrite event's parameters.
type SAMLIdPServerResourceWriteEventArgs struct {...}

func (args *SAMLIdPServerResourceWriteEventArgs) ConnectionID() int64
func (args *SAMLIdPServerResourceWriteEventArgs) SessionID() string
func (args *SAMLIdPServerResourceWriteEventArgs) Handle() string
func (args *SAMLIdPServerResourceWriteEventArgs) OperationStatus() int32
func (args *SAMLIdPServerResourceWriteEventArgs) SetOperationStatus(value int32)

// SAMLIdPServerResourceWriteEvent defines the signature of the SAMLIdPServer ResourceWrite event's handler function.
type SAMLIdPServerResourceWriteEvent func(sender *SAMLIdPServer, args *SAMLIdPServerResourceWriteEventArgs)

func (obj *SAMLIdPServer) GetOnResourceWriteHandler() SAMLIdPServerResourceWriteEvent
func (obj *SAMLIdPServer) SetOnResourceWriteHandler(handlerFunc SAMLIdPServerResourceWriteEvent)

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

This event is fired when a SAML message has been prepared and is ready to be dispatched.

Syntax

// SAMLIdPServerSAMLMessagePreparedEventArgs carries the SAMLIdPServer SAMLMessagePrepared event's parameters.
type SAMLIdPServerSAMLMessagePreparedEventArgs struct {...}

func (args *SAMLIdPServerSAMLMessagePreparedEventArgs) ConnectionID() int64
func (args *SAMLIdPServerSAMLMessagePreparedEventArgs) SessionID() string
func (args *SAMLIdPServerSAMLMessagePreparedEventArgs) MessageID() string
func (args *SAMLIdPServerSAMLMessagePreparedEventArgs) Destination() string
func (args *SAMLIdPServerSAMLMessagePreparedEventArgs) IssueInstant() string
func (args *SAMLIdPServerSAMLMessagePreparedEventArgs) InResponseTo() string
func (args *SAMLIdPServerSAMLMessagePreparedEventArgs) RequestBody() string
func (args *SAMLIdPServerSAMLMessagePreparedEventArgs) MessageType() string
func (args *SAMLIdPServerSAMLMessagePreparedEventArgs) MessageBody() string
func (args *SAMLIdPServerSAMLMessagePreparedEventArgs) SetMessageBody(value string)

func (args *SAMLIdPServerSAMLMessagePreparedEventArgs) Success() bool
func (args *SAMLIdPServerSAMLMessagePreparedEventArgs) SetSuccess(value bool)

// SAMLIdPServerSAMLMessagePreparedEvent defines the signature of the SAMLIdPServer SAMLMessagePrepared event's handler function.
type SAMLIdPServerSAMLMessagePreparedEvent func(sender *SAMLIdPServer, args *SAMLIdPServerSAMLMessagePreparedEventArgs)

func (obj *SAMLIdPServer) GetOnSAMLMessagePreparedHandler() SAMLIdPServerSAMLMessagePreparedEvent
func (obj *SAMLIdPServer) SetOnSAMLMessagePreparedHandler(handlerFunc SAMLIdPServerSAMLMessagePreparedEvent)

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, LogoutRequest, or IdP metadata). 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 (SAMLIdPServer Component)

The server fires this event for every SAML message it receives.

Syntax

// SAMLIdPServerSAMLMessageReceivedEventArgs carries the SAMLIdPServer SAMLMessageReceived event's parameters.
type SAMLIdPServerSAMLMessageReceivedEventArgs struct {...}

func (args *SAMLIdPServerSAMLMessageReceivedEventArgs) ConnectionID() int64
func (args *SAMLIdPServerSAMLMessageReceivedEventArgs) SessionID() string
func (args *SAMLIdPServerSAMLMessageReceivedEventArgs) MessageID() string
func (args *SAMLIdPServerSAMLMessageReceivedEventArgs) Issuer() string
func (args *SAMLIdPServerSAMLMessageReceivedEventArgs) IssueInstant() string
func (args *SAMLIdPServerSAMLMessageReceivedEventArgs) InResponseTo() string
func (args *SAMLIdPServerSAMLMessageReceivedEventArgs) RequestBody() string
func (args *SAMLIdPServerSAMLMessageReceivedEventArgs) MessageType() string
func (args *SAMLIdPServerSAMLMessageReceivedEventArgs) MessageBody() string
func (args *SAMLIdPServerSAMLMessageReceivedEventArgs) IsSigned() bool
func (args *SAMLIdPServerSAMLMessageReceivedEventArgs) Action() int32
func (args *SAMLIdPServerSAMLMessageReceivedEventArgs) SetAction(value int32)

// SAMLIdPServerSAMLMessageReceivedEvent defines the signature of the SAMLIdPServer SAMLMessageReceived event's handler function.
type SAMLIdPServerSAMLMessageReceivedEvent func(sender *SAMLIdPServer, args *SAMLIdPServerSAMLMessageReceivedEventArgs)

func (obj *SAMLIdPServer) GetOnSAMLMessageReceivedHandler() SAMLIdPServerSAMLMessageReceivedEvent
func (obj *SAMLIdPServer) SetOnSAMLMessageReceivedHandler(handlerFunc SAMLIdPServerSAMLMessageReceivedEvent)

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

This event is fired when a new session has been established.

Syntax

// SAMLIdPServerSessionCreatedEventArgs carries the SAMLIdPServer SessionCreated event's parameters.
type SAMLIdPServerSessionCreatedEventArgs struct {...}

func (args *SAMLIdPServerSessionCreatedEventArgs) ConnectionID() int64
func (args *SAMLIdPServerSessionCreatedEventArgs) SessionID() string
// SAMLIdPServerSessionCreatedEvent defines the signature of the SAMLIdPServer SessionCreated event's handler function.
type SAMLIdPServerSessionCreatedEvent func(sender *SAMLIdPServer, args *SAMLIdPServerSessionCreatedEventArgs)

func (obj *SAMLIdPServer) GetOnSessionCreatedHandler() SAMLIdPServerSessionCreatedEvent
func (obj *SAMLIdPServer) SetOnSessionCreatedHandler(handlerFunc SAMLIdPServerSessionCreatedEvent)

Remarks

ConnectionID contains the identifier of the new session, SessionID specifies the ID of the new session.

SessionDestroyed Event (SAMLIdPServer Component)

This event is fired when the IdP server has closed a session.

Syntax

// SAMLIdPServerSessionDestroyedEventArgs carries the SAMLIdPServer SessionDestroyed event's parameters.
type SAMLIdPServerSessionDestroyedEventArgs struct {...}

func (args *SAMLIdPServerSessionDestroyedEventArgs) ConnectionID() int64
func (args *SAMLIdPServerSessionDestroyedEventArgs) SessionID() string
// SAMLIdPServerSessionDestroyedEvent defines the signature of the SAMLIdPServer SessionDestroyed event's handler function.
type SAMLIdPServerSessionDestroyedEvent func(sender *SAMLIdPServer, args *SAMLIdPServerSessionDestroyedEventArgs)

func (obj *SAMLIdPServer) GetOnSessionDestroyedHandler() SAMLIdPServerSessionDestroyedEvent
func (obj *SAMLIdPServer) SetOnSessionDestroyedHandler(handlerFunc SAMLIdPServerSessionDestroyedEvent)

Remarks

ConnectionID contains the identifier of the closed session.

SessionEvent Event (SAMLIdPServer Component)

Notifies the application about SAML session events.

Syntax

// SAMLIdPServerSessionEventEventArgs carries the SAMLIdPServer SessionEvent event's parameters.
type SAMLIdPServerSessionEventEventArgs struct {...}

func (args *SAMLIdPServerSessionEventEventArgs) ConnectionID() int64
func (args *SAMLIdPServerSessionEventEventArgs) SessionID() string
func (args *SAMLIdPServerSessionEventEventArgs) EventText() string
// SAMLIdPServerSessionEventEvent defines the signature of the SAMLIdPServer SessionEvent event's handler function.
type SAMLIdPServerSessionEventEvent func(sender *SAMLIdPServer, args *SAMLIdPServerSessionEventEventArgs)

func (obj *SAMLIdPServer) GetOnSessionEventHandler() SAMLIdPServerSessionEventEvent
func (obj *SAMLIdPServer) SetOnSessionEventHandler(handlerFunc SAMLIdPServerSessionEventEvent)

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
IdPSSOReceived
AuthnRequestReceived
ChallengePrepared
CredentialsReceived
ResponsePrepared
LoggedIn
LogoutRequestReceived
LogoutResponsePrepared
ArtifactResolveReceived
ArtifactResponsePrepared
AttributeQueryReceived
AttributeResponsePrepared
Finish

SessionInfoNeeded Event (SAMLIdPServer Component)

This event is fired in OfflineMode to request the session ID for the current flow.

Syntax

// SAMLIdPServerSessionInfoNeededEventArgs carries the SAMLIdPServer SessionInfoNeeded event's parameters.
type SAMLIdPServerSessionInfoNeededEventArgs struct {...}

func (args *SAMLIdPServerSessionInfoNeededEventArgs) ConnectionID() int64
func (args *SAMLIdPServerSessionInfoNeededEventArgs) SessionID() string
func (args *SAMLIdPServerSessionInfoNeededEventArgs) SetSessionID(value string)

// SAMLIdPServerSessionInfoNeededEvent defines the signature of the SAMLIdPServer SessionInfoNeeded event's handler function.
type SAMLIdPServerSessionInfoNeededEvent func(sender *SAMLIdPServer, args *SAMLIdPServerSessionInfoNeededEventArgs)

func (obj *SAMLIdPServer) GetOnSessionInfoNeededHandler() SAMLIdPServerSessionInfoNeededEvent
func (obj *SAMLIdPServer) SetOnSessionInfoNeededHandler(handlerFunc SAMLIdPServerSessionInfoNeededEvent)

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

This event fires to retrieve session state information from the application.

Syntax

// SAMLIdPServerSessionStateRetrieveEventArgs carries the SAMLIdPServer SessionStateRetrieve event's parameters.
type SAMLIdPServerSessionStateRetrieveEventArgs struct {...}

func (args *SAMLIdPServerSessionStateRetrieveEventArgs) ConnectionID() int64
func (args *SAMLIdPServerSessionStateRetrieveEventArgs) SessionID() string
func (args *SAMLIdPServerSessionStateRetrieveEventArgs) SessionState() string
func (args *SAMLIdPServerSessionStateRetrieveEventArgs) SetSessionState(value string)

// SAMLIdPServerSessionStateRetrieveEvent defines the signature of the SAMLIdPServer SessionStateRetrieve event's handler function.
type SAMLIdPServerSessionStateRetrieveEvent func(sender *SAMLIdPServer, args *SAMLIdPServerSessionStateRetrieveEventArgs)

func (obj *SAMLIdPServer) GetOnSessionStateRetrieveHandler() SAMLIdPServerSessionStateRetrieveEvent
func (obj *SAMLIdPServer) SetOnSessionStateRetrieveHandler(handlerFunc SAMLIdPServerSessionStateRetrieveEvent)

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

This event passes a session state object to the application for safekeeping.

Syntax

// SAMLIdPServerSessionStateSaveEventArgs carries the SAMLIdPServer SessionStateSave event's parameters.
type SAMLIdPServerSessionStateSaveEventArgs struct {...}

func (args *SAMLIdPServerSessionStateSaveEventArgs) ConnectionID() int64
func (args *SAMLIdPServerSessionStateSaveEventArgs) SessionID() string
func (args *SAMLIdPServerSessionStateSaveEventArgs) SessionState() string
// SAMLIdPServerSessionStateSaveEvent defines the signature of the SAMLIdPServer SessionStateSave event's handler function.
type SAMLIdPServerSessionStateSaveEvent func(sender *SAMLIdPServer, args *SAMLIdPServerSessionStateSaveEventArgs)

func (obj *SAMLIdPServer) GetOnSessionStateSaveHandler() SAMLIdPServerSessionStateSaveEvent
func (obj *SAMLIdPServer) SetOnSessionStateSaveHandler(handlerFunc SAMLIdPServerSessionStateSaveEvent)

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

Notifies the application about the start of signature validation.

Syntax

// SAMLIdPServerSignatureFoundEventArgs carries the SAMLIdPServer SignatureFound event's parameters.
type SAMLIdPServerSignatureFoundEventArgs struct {...}

func (args *SAMLIdPServerSignatureFoundEventArgs) ConnectionID() int64
func (args *SAMLIdPServerSignatureFoundEventArgs) SessionID() string
func (args *SAMLIdPServerSignatureFoundEventArgs) Scope() int32
func (args *SAMLIdPServerSignatureFoundEventArgs) Signer() string
func (args *SAMLIdPServerSignatureFoundEventArgs) TargetID() string
func (args *SAMLIdPServerSignatureFoundEventArgs) TargetType() string
func (args *SAMLIdPServerSignatureFoundEventArgs) IssuerRDN() string
func (args *SAMLIdPServerSignatureFoundEventArgs) SerialNumber() []byte
func (args *SAMLIdPServerSignatureFoundEventArgs) SubjectKeyID() []byte
func (args *SAMLIdPServerSignatureFoundEventArgs) SigMethod() string
func (args *SAMLIdPServerSignatureFoundEventArgs) DigestMethod() string
func (args *SAMLIdPServerSignatureFoundEventArgs) CertFound() bool
func (args *SAMLIdPServerSignatureFoundEventArgs) Validate() bool
func (args *SAMLIdPServerSignatureFoundEventArgs) SetValidate(value bool)

// SAMLIdPServerSignatureFoundEvent defines the signature of the SAMLIdPServer SignatureFound event's handler function.
type SAMLIdPServerSignatureFoundEvent func(sender *SAMLIdPServer, args *SAMLIdPServerSignatureFoundEventArgs)

func (obj *SAMLIdPServer) GetOnSignatureFoundHandler() SAMLIdPServerSignatureFoundEvent
func (obj *SAMLIdPServer) SetOnSignatureFoundHandler(handlerFunc SAMLIdPServerSignatureFoundEvent)

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. The TargetID and TargetType provide additional details.


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

Reports the signature validation result.

Syntax

// SAMLIdPServerSignatureValidatedEventArgs carries the SAMLIdPServer SignatureValidated event's parameters.
type SAMLIdPServerSignatureValidatedEventArgs struct {...}

func (args *SAMLIdPServerSignatureValidatedEventArgs) ConnectionID() int64
func (args *SAMLIdPServerSignatureValidatedEventArgs) SessionID() string
func (args *SAMLIdPServerSignatureValidatedEventArgs) Scope() int32
func (args *SAMLIdPServerSignatureValidatedEventArgs) Signer() string
func (args *SAMLIdPServerSignatureValidatedEventArgs) TargetID() string
func (args *SAMLIdPServerSignatureValidatedEventArgs) TargetType() string
func (args *SAMLIdPServerSignatureValidatedEventArgs) IssuerRDN() string
func (args *SAMLIdPServerSignatureValidatedEventArgs) SerialNumber() []byte
func (args *SAMLIdPServerSignatureValidatedEventArgs) SubjectKeyID() []byte
func (args *SAMLIdPServerSignatureValidatedEventArgs) SigMethod() string
func (args *SAMLIdPServerSignatureValidatedEventArgs) DigestMethod() string
func (args *SAMLIdPServerSignatureValidatedEventArgs) ValidationResult() int32
func (args *SAMLIdPServerSignatureValidatedEventArgs) SetValidationResult(value int32)

// SAMLIdPServerSignatureValidatedEvent defines the signature of the SAMLIdPServer SignatureValidated event's handler function.
type SAMLIdPServerSignatureValidatedEvent func(sender *SAMLIdPServer, args *SAMLIdPServerSignatureValidatedEventArgs)

func (obj *SAMLIdPServer) GetOnSignatureValidatedHandler() SAMLIdPServerSignatureValidatedEvent
func (obj *SAMLIdPServer) SetOnSignatureValidatedHandler(handlerFunc SAMLIdPServerSignatureValidatedEvent)

Remarks

This event is fired when the signature validation process is completed.

The Scope parameter specifies the subject of the signature. This can be the outermost SAML message or an embedded assertion. The TargetID and TargetType parameters provide the details.


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

Signing certificates are typically identified either by an (IssuerRDN, SerialNumber) pair, or via their unique SubjectKeyID. Use these parameters to look for the signing certificate if it is not available in the signature. The ValidationResult parameter specifies whether the signature is established to be valid or not. You can alter it in the event handler to override the built-in validation outcome.


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)

SignOnPagePrepared Event (SAMLIdPServer Component)

The server fires this event upon preparing the sign-on page.

Syntax

// SAMLIdPServerSignOnPagePreparedEventArgs carries the SAMLIdPServer SignOnPagePrepared event's parameters.
type SAMLIdPServerSignOnPagePreparedEventArgs struct {...}

func (args *SAMLIdPServerSignOnPagePreparedEventArgs) ConnectionID() int64
func (args *SAMLIdPServerSignOnPagePreparedEventArgs) SessionID() string
func (args *SAMLIdPServerSignOnPagePreparedEventArgs) RequestID() string
func (args *SAMLIdPServerSignOnPagePreparedEventArgs) SP() string
func (args *SAMLIdPServerSignOnPagePreparedEventArgs) Request() string
func (args *SAMLIdPServerSignOnPagePreparedEventArgs) PageData() string
func (args *SAMLIdPServerSignOnPagePreparedEventArgs) SetPageData(value string)

func (args *SAMLIdPServerSignOnPagePreparedEventArgs) Redirect() bool
func (args *SAMLIdPServerSignOnPagePreparedEventArgs) SetRedirect(value bool)

// SAMLIdPServerSignOnPagePreparedEvent defines the signature of the SAMLIdPServer SignOnPagePrepared event's handler function.
type SAMLIdPServerSignOnPagePreparedEvent func(sender *SAMLIdPServer, args *SAMLIdPServerSignOnPagePreparedEventArgs)

func (obj *SAMLIdPServer) GetOnSignOnPagePreparedHandler() SAMLIdPServerSignOnPagePreparedEvent
func (obj *SAMLIdPServer) SetOnSignOnPagePreparedHandler(handlerFunc SAMLIdPServerSignOnPagePreparedEvent)

Remarks

The IdP server fires this event to notify the application that the sign-on page (login form) has been formed and is ready to be flushed. Use SignOnPageTemplate to assign the sign-on page template.

The form body is returned via the PageData parameter. You can adjust it in the event handler as required. The Redirect parameter advises whether the form should be returned as a Location header of the HTTP response with the 302 status, or as an HTTP body of text/html type.

SignOnResponseReceived Event (SAMLIdPServer Component)

Notifies the application about the received response to the sign-on page.

Syntax

// SAMLIdPServerSignOnResponseReceivedEventArgs carries the SAMLIdPServer SignOnResponseReceived event's parameters.
type SAMLIdPServerSignOnResponseReceivedEventArgs struct {...}

func (args *SAMLIdPServerSignOnResponseReceivedEventArgs) ConnectionID() int64
func (args *SAMLIdPServerSignOnResponseReceivedEventArgs) SessionID() string
func (args *SAMLIdPServerSignOnResponseReceivedEventArgs) RequestID() string
func (args *SAMLIdPServerSignOnResponseReceivedEventArgs) ResponseData() string
func (args *SAMLIdPServerSignOnResponseReceivedEventArgs) SetResponseData(value string)

func (args *SAMLIdPServerSignOnResponseReceivedEventArgs) Action() int32
func (args *SAMLIdPServerSignOnResponseReceivedEventArgs) SetAction(value int32)

// SAMLIdPServerSignOnResponseReceivedEvent defines the signature of the SAMLIdPServer SignOnResponseReceived event's handler function.
type SAMLIdPServerSignOnResponseReceivedEvent func(sender *SAMLIdPServer, args *SAMLIdPServerSignOnResponseReceivedEventArgs)

func (obj *SAMLIdPServer) GetOnSignOnResponseReceivedHandler() SAMLIdPServerSignOnResponseReceivedEvent
func (obj *SAMLIdPServer) SetOnSignOnResponseReceivedHandler(handlerFunc SAMLIdPServerSignOnResponseReceivedEvent)

Remarks

The component uses this event to report that the login form previously generated by the component has been filled in and returned by the user. ResponseData contains the content submitted by the user (the URL-encoded form fields, or any authentication data if the custom authentication flow is used). The application that chose to use custom authentication process can use this data to authenticate the user.

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

TLSCertValidate Event (SAMLIdPServer Component)

Fires when a client certificate needs to be validated.

Syntax

// SAMLIdPServerTLSCertValidateEventArgs carries the SAMLIdPServer TLSCertValidate event's parameters.
type SAMLIdPServerTLSCertValidateEventArgs struct {...}

func (args *SAMLIdPServerTLSCertValidateEventArgs) ConnectionID() int64
func (args *SAMLIdPServerTLSCertValidateEventArgs) Accept() bool
func (args *SAMLIdPServerTLSCertValidateEventArgs) SetAccept(value bool)

// SAMLIdPServerTLSCertValidateEvent defines the signature of the SAMLIdPServer TLSCertValidate event's handler function.
type SAMLIdPServerTLSCertValidateEvent func(sender *SAMLIdPServer, args *SAMLIdPServerTLSCertValidateEventArgs)

func (obj *SAMLIdPServer) GetOnTLSCertValidateHandler() SAMLIdPServerTLSCertValidateEvent
func (obj *SAMLIdPServer) SetOnTLSCertValidateHandler(handlerFunc SAMLIdPServerTLSCertValidateEvent)

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

Reports the setup of a TLS session.

Syntax

// SAMLIdPServerTLSEstablishedEventArgs carries the SAMLIdPServer TLSEstablished event's parameters.
type SAMLIdPServerTLSEstablishedEventArgs struct {...}

func (args *SAMLIdPServerTLSEstablishedEventArgs) ConnectionID() int64
// SAMLIdPServerTLSEstablishedEvent defines the signature of the SAMLIdPServer TLSEstablished event's handler function.
type SAMLIdPServerTLSEstablishedEvent func(sender *SAMLIdPServer, args *SAMLIdPServerTLSEstablishedEventArgs)

func (obj *SAMLIdPServer) GetOnTLSEstablishedHandler() SAMLIdPServerTLSEstablishedEvent
func (obj *SAMLIdPServer) SetOnTLSEstablishedHandler(handlerFunc SAMLIdPServerTLSEstablishedEvent)

Remarks

Subscribe to this event to be notified about the setup of a TLS connection by a connected client.

TLSHandshake Event (SAMLIdPServer Component)

Fires when a newly established client connection initiates a TLS handshake.

Syntax

// SAMLIdPServerTLSHandshakeEventArgs carries the SAMLIdPServer TLSHandshake event's parameters.
type SAMLIdPServerTLSHandshakeEventArgs struct {...}

func (args *SAMLIdPServerTLSHandshakeEventArgs) ConnectionID() int64
func (args *SAMLIdPServerTLSHandshakeEventArgs) ServerName() string
func (args *SAMLIdPServerTLSHandshakeEventArgs) Abort() bool
func (args *SAMLIdPServerTLSHandshakeEventArgs) SetAbort(value bool)

// SAMLIdPServerTLSHandshakeEvent defines the signature of the SAMLIdPServer TLSHandshake event's handler function.
type SAMLIdPServerTLSHandshakeEvent func(sender *SAMLIdPServer, args *SAMLIdPServerTLSHandshakeEventArgs)

func (obj *SAMLIdPServer) GetOnTLSHandshakeHandler() SAMLIdPServerTLSHandshakeEvent
func (obj *SAMLIdPServer) SetOnTLSHandshakeHandler(handlerFunc SAMLIdPServerTLSHandshakeEvent)

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

Requests a pre-shared key for TLS-PSK.

Syntax

// SAMLIdPServerTLSPSKEventArgs carries the SAMLIdPServer TLSPSK event's parameters.
type SAMLIdPServerTLSPSKEventArgs struct {...}

func (args *SAMLIdPServerTLSPSKEventArgs) ConnectionID() int64
func (args *SAMLIdPServerTLSPSKEventArgs) Identity() string
func (args *SAMLIdPServerTLSPSKEventArgs) PSK() string
func (args *SAMLIdPServerTLSPSKEventArgs) SetPSK(value string)

func (args *SAMLIdPServerTLSPSKEventArgs) Ciphersuite() string
func (args *SAMLIdPServerTLSPSKEventArgs) SetCiphersuite(value string)

// SAMLIdPServerTLSPSKEvent defines the signature of the SAMLIdPServer TLSPSK event's handler function.
type SAMLIdPServerTLSPSKEvent func(sender *SAMLIdPServer, args *SAMLIdPServerTLSPSKEventArgs)

func (obj *SAMLIdPServer) GetOnTLSPSKHandler() SAMLIdPServerTLSPSKEvent
func (obj *SAMLIdPServer) SetOnTLSPSKHandler(handlerFunc SAMLIdPServerTLSPSKEvent)

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

Reports closure of a TLS session.

Syntax

// SAMLIdPServerTLSShutdownEventArgs carries the SAMLIdPServer TLSShutdown event's parameters.
type SAMLIdPServerTLSShutdownEventArgs struct {...}

func (args *SAMLIdPServerTLSShutdownEventArgs) ConnectionID() int64
// SAMLIdPServerTLSShutdownEvent defines the signature of the SAMLIdPServer TLSShutdown event's handler function.
type SAMLIdPServerTLSShutdownEvent func(sender *SAMLIdPServer, args *SAMLIdPServerTLSShutdownEventArgs)

func (obj *SAMLIdPServer) GetOnTLSShutdownHandler() SAMLIdPServerTLSShutdownEvent
func (obj *SAMLIdPServer) SetOnTLSShutdownHandler(handlerFunc SAMLIdPServerTLSShutdownEvent)

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

Notifies the application about the success of user authentication flow.

Syntax

// SAMLIdPServerUserAuthCompletedEventArgs carries the SAMLIdPServer UserAuthCompleted event's parameters.
type SAMLIdPServerUserAuthCompletedEventArgs struct {...}

func (args *SAMLIdPServerUserAuthCompletedEventArgs) ConnectionID() int64
func (args *SAMLIdPServerUserAuthCompletedEventArgs) SessionID() string
func (args *SAMLIdPServerUserAuthCompletedEventArgs) SP() string
func (args *SAMLIdPServerUserAuthCompletedEventArgs) Auth() string
func (args *SAMLIdPServerUserAuthCompletedEventArgs) Username() string
func (args *SAMLIdPServerUserAuthCompletedEventArgs) NameID() string
func (args *SAMLIdPServerUserAuthCompletedEventArgs) SetNameID(value string)

func (args *SAMLIdPServerUserAuthCompletedEventArgs) NameIDFormat() string
func (args *SAMLIdPServerUserAuthCompletedEventArgs) SetNameIDFormat(value string)

func (args *SAMLIdPServerUserAuthCompletedEventArgs) SessionIndex() string
func (args *SAMLIdPServerUserAuthCompletedEventArgs) SetSessionIndex(value string)

func (args *SAMLIdPServerUserAuthCompletedEventArgs) AssertionTTL() int32
func (args *SAMLIdPServerUserAuthCompletedEventArgs) SetAssertionTTL(value int32)

// SAMLIdPServerUserAuthCompletedEvent defines the signature of the SAMLIdPServer UserAuthCompleted event's handler function.
type SAMLIdPServerUserAuthCompletedEvent func(sender *SAMLIdPServer, args *SAMLIdPServerUserAuthCompletedEventArgs)

func (obj *SAMLIdPServer) GetOnUserAuthCompletedHandler() SAMLIdPServerUserAuthCompletedEvent
func (obj *SAMLIdPServer) SetOnUserAuthCompletedHandler(handlerFunc SAMLIdPServerUserAuthCompletedEvent)

Remarks

Subscribe to this event to get notified about completion of user authentication flow. The NameID, NameIDFormat, SessionIndex, and AssertionTTL parameters contain the proposed session parameters. You can alter them in your event handler as required.

UserAuthFailed Event (SAMLIdPServer Component)

Notifies the application about failure of user authentication flow.

Syntax

// SAMLIdPServerUserAuthFailedEventArgs carries the SAMLIdPServer UserAuthFailed event's parameters.
type SAMLIdPServerUserAuthFailedEventArgs struct {...}

func (args *SAMLIdPServerUserAuthFailedEventArgs) ConnectionID() int64
func (args *SAMLIdPServerUserAuthFailedEventArgs) SessionID() string
func (args *SAMLIdPServerUserAuthFailedEventArgs) SP() string
func (args *SAMLIdPServerUserAuthFailedEventArgs) Auth() string
func (args *SAMLIdPServerUserAuthFailedEventArgs) Username() string
func (args *SAMLIdPServerUserAuthFailedEventArgs) CanRetry() bool
func (args *SAMLIdPServerUserAuthFailedEventArgs) TryAgain() bool
func (args *SAMLIdPServerUserAuthFailedEventArgs) SetTryAgain(value bool)

// SAMLIdPServerUserAuthFailedEvent defines the signature of the SAMLIdPServer UserAuthFailed event's handler function.
type SAMLIdPServerUserAuthFailedEvent func(sender *SAMLIdPServer, args *SAMLIdPServerUserAuthFailedEventArgs)

func (obj *SAMLIdPServer) GetOnUserAuthFailedHandler() SAMLIdPServerUserAuthFailedEvent
func (obj *SAMLIdPServer) SetOnUserAuthFailedHandler(handlerFunc SAMLIdPServerUserAuthFailedEvent)

Remarks

The component fires this event to notify the application about failed user authentication step - for example, if a wrong password was supplied.

The CanRetry parameter indicates whether another attempt of the same type can be performed. If you would like to use that opportunity, set TryAgain to true to restart the process.

UserAuthStart Event (SAMLIdPServer Component)

Notifies the application about the start of user authentication flow.

Syntax

// SAMLIdPServerUserAuthStartEventArgs carries the SAMLIdPServer UserAuthStart event's parameters.
type SAMLIdPServerUserAuthStartEventArgs struct {...}

func (args *SAMLIdPServerUserAuthStartEventArgs) ConnectionID() int64
func (args *SAMLIdPServerUserAuthStartEventArgs) SessionID() string
func (args *SAMLIdPServerUserAuthStartEventArgs) SP() string
func (args *SAMLIdPServerUserAuthStartEventArgs) SupportedAuths() string
func (args *SAMLIdPServerUserAuthStartEventArgs) SelectedAuth() string
func (args *SAMLIdPServerUserAuthStartEventArgs) SetSelectedAuth(value string)

func (args *SAMLIdPServerUserAuthStartEventArgs) Action() int32
func (args *SAMLIdPServerUserAuthStartEventArgs) SetAction(value int32)

// SAMLIdPServerUserAuthStartEvent defines the signature of the SAMLIdPServer UserAuthStart event's handler function.
type SAMLIdPServerUserAuthStartEvent func(sender *SAMLIdPServer, args *SAMLIdPServerUserAuthStartEventArgs)

func (obj *SAMLIdPServer) GetOnUserAuthStartHandler() SAMLIdPServerUserAuthStartEvent
func (obj *SAMLIdPServer) SetOnUserAuthStartHandler(handlerFunc SAMLIdPServerUserAuthStartEvent)

Remarks

Set Action to Auto to proceed with the default sign on page based on SignOnPageTemplate, or to Custom to supply (or redirect to) your own authentication landing. The SupportedAuths parameter contains the list of authentication methods supported by the server. If you are looking to use a particular authentication method, return it to the server via SelectedAuth parameter.

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

UserAuthVerifyCredentials Event (SAMLIdPServer Component)

Passes user credentials to the application for verification.

Syntax

// SAMLIdPServerUserAuthVerifyCredentialsEventArgs carries the SAMLIdPServer UserAuthVerifyCredentials event's parameters.
type SAMLIdPServerUserAuthVerifyCredentialsEventArgs struct {...}

func (args *SAMLIdPServerUserAuthVerifyCredentialsEventArgs) ConnectionID() int64
func (args *SAMLIdPServerUserAuthVerifyCredentialsEventArgs) SessionID() string
func (args *SAMLIdPServerUserAuthVerifyCredentialsEventArgs) SP() string
func (args *SAMLIdPServerUserAuthVerifyCredentialsEventArgs) ClaimedUsername() string
func (args *SAMLIdPServerUserAuthVerifyCredentialsEventArgs) ClaimedPassword() string
func (args *SAMLIdPServerUserAuthVerifyCredentialsEventArgs) ClaimedBody() string
func (args *SAMLIdPServerUserAuthVerifyCredentialsEventArgs) Accept() bool
func (args *SAMLIdPServerUserAuthVerifyCredentialsEventArgs) SetAccept(value bool)

func (args *SAMLIdPServerUserAuthVerifyCredentialsEventArgs) Username() string
func (args *SAMLIdPServerUserAuthVerifyCredentialsEventArgs) SetUsername(value string)

// SAMLIdPServerUserAuthVerifyCredentialsEvent defines the signature of the SAMLIdPServer UserAuthVerifyCredentials event's handler function.
type SAMLIdPServerUserAuthVerifyCredentialsEvent func(sender *SAMLIdPServer, args *SAMLIdPServerUserAuthVerifyCredentialsEventArgs)

func (obj *SAMLIdPServer) GetOnUserAuthVerifyCredentialsHandler() SAMLIdPServerUserAuthVerifyCredentialsEvent
func (obj *SAMLIdPServer) SetOnUserAuthVerifyCredentialsHandler(handlerFunc SAMLIdPServerUserAuthVerifyCredentialsEvent)

Remarks

Subscribe to this event to be notified about authentication attempts and adjust the acceptance result as required. This event fires after the user credentials have been validated against the configured database, and the value of the Accept parameter reflects the outcome of the validation.

The Username and Password parameters contain the provided credentials, and the Body parameter contains the unparsed form data.

UserLogoutCompleted Event (SAMLIdPServer Component)

Notifies the application about the completion of user logout flow.

Syntax

// SAMLIdPServerUserLogoutCompletedEventArgs carries the SAMLIdPServer UserLogoutCompleted event's parameters.
type SAMLIdPServerUserLogoutCompletedEventArgs struct {...}

func (args *SAMLIdPServerUserLogoutCompletedEventArgs) ConnectionID() int64
func (args *SAMLIdPServerUserLogoutCompletedEventArgs) SessionID() string
func (args *SAMLIdPServerUserLogoutCompletedEventArgs) SP() string
func (args *SAMLIdPServerUserLogoutCompletedEventArgs) Username() string
func (args *SAMLIdPServerUserLogoutCompletedEventArgs) NameID() string
func (args *SAMLIdPServerUserLogoutCompletedEventArgs) SessionIndex() string
func (args *SAMLIdPServerUserLogoutCompletedEventArgs) Partial() bool
// SAMLIdPServerUserLogoutCompletedEvent defines the signature of the SAMLIdPServer UserLogoutCompleted event's handler function.
type SAMLIdPServerUserLogoutCompletedEvent func(sender *SAMLIdPServer, args *SAMLIdPServerUserLogoutCompletedEventArgs)

func (obj *SAMLIdPServer) GetOnUserLogoutCompletedHandler() SAMLIdPServerUserLogoutCompletedEvent
func (obj *SAMLIdPServer) SetOnUserLogoutCompletedHandler(handlerFunc SAMLIdPServerUserLogoutCompletedEvent)

Remarks

Subscribe to this event to be notified about the logout flow completion.

UserLogoutStart Event (SAMLIdPServer Component)

Notifies the application about the start of user logout flow.

Syntax

// SAMLIdPServerUserLogoutStartEventArgs carries the SAMLIdPServer UserLogoutStart event's parameters.
type SAMLIdPServerUserLogoutStartEventArgs struct {...}

func (args *SAMLIdPServerUserLogoutStartEventArgs) ConnectionID() int64
func (args *SAMLIdPServerUserLogoutStartEventArgs) SessionID() string
func (args *SAMLIdPServerUserLogoutStartEventArgs) SP() string
func (args *SAMLIdPServerUserLogoutStartEventArgs) Username() string
func (args *SAMLIdPServerUserLogoutStartEventArgs) NameID() string
func (args *SAMLIdPServerUserLogoutStartEventArgs) SessionIndex() string
func (args *SAMLIdPServerUserLogoutStartEventArgs) Secondary() bool
func (args *SAMLIdPServerUserLogoutStartEventArgs) Action() int32
func (args *SAMLIdPServerUserLogoutStartEventArgs) SetAction(value int32)

// SAMLIdPServerUserLogoutStartEvent defines the signature of the SAMLIdPServer UserLogoutStart event's handler function.
type SAMLIdPServerUserLogoutStartEvent func(sender *SAMLIdPServer, args *SAMLIdPServerUserLogoutStartEventArgs)

func (obj *SAMLIdPServer) GetOnUserLogoutStartHandler() SAMLIdPServerUserLogoutStartEvent
func (obj *SAMLIdPServer) SetOnUserLogoutStartHandler(handlerFunc SAMLIdPServerUserLogoutStartEvent)

Remarks

The component uses this event to notify the application about the start of user logout flow. The Secondary parameter indicates that the logout is initiated in response to request received from a remote party.

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

Config Settings (SAMLIdPServer 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.

SAMLIdPServer Config Settings

AllowOptionsResponseWithoutAuth: Enables unauthenticated responses to OPTIONS requests.

Set this property to true to allow the server serve OPTIONS requests without prior authentication of the client.

AssertionsOneTimeUse: Adds a one-time use condition to the assertion.

This setting instructs the server to add a one-time use condition to the assertion.

AssertionsTTL: The assertions time-to-live value.

Specifies the time-to-live value for the created assertions, in milliseconds. The default value is 60000.

AuthDigestExpire: Specifies digest expiration time for digest authentication.

Use this property to specify the digest expiration time for digest authentication, in seconds. The default setting is 20.

BoundPort: The port that was bound by the server.

Returns the port number that was bound by the server.

ContactPerson: The ContactPerson entry of the provider metadata.

Use this configuration setting to set or get the ContactPerson element of the provider metadata record.

DefaultNameIDPolicyFormat: Default name ID policy format.

Provides means to set the default name ID policy format. The default value is urn:oasis:names:tc:SAML:2.0:nameid-format:transient.

DefaultPassiveAuthnContextClassRef: The default passive authentication context class.

Use this property to specify the default passive authentication context class. The default value is urn:oasis:names:tc:SAML:2.0:ac:classes:TLSClient.

DualStack: Allows the use of ip4 and ip6 simultaneously.

This setting specifies a socket can use ip4 and ip6 simultaneously.

HandshakeTimeout: The HTTPS handshake timeout.

The HTTPS handshake timeout in milliseconds.

HomePage: Specifies the home page resource name.

Use this property to specify the home page (/) resource name.

MaxIssueInstantTimeDiff: The maximum issue-instant time delta.

This property specifies the maximum time delta for serving issue-instant requests, in milliseconds. The default value is 30000.

NotBeforeTimeout: The 'not-before' timeout to use.

Specifies the 'too-early' timeout for the requests in milliseconds. The default value is -60000.

OAuthAllowAccessByDefault: Specifies whether access to a resource is allowed by default.

Use this property to enable or disable access to a resource in case if no scopes defined or the resource doesn't match any of the user's scopes.

OAuthAutoValidateTokens: Allows to validate OAuth 2.0 access tokens automatically.

Use this property to enable or disable pre-validation of access tokens.

OAuthIntrospectionClientID: Specifies a client ID on the authentication service.

Use this property to provide a client ID for access token introspection.

OAuthIntrospectionClientSecret: Specifies a client secret on the authentication service.

Use this property to provide a client secret for access token introspection.

OAuthIntrospectionURL: Specifies the URL to be used to introspect access tokens.

Use this property to provide the URL for introspection.

OAuthTokenValidationKeys: Specifies JW keys in JSON format for validating access token signatures.

OrganizationDisplayName: The OrganizationDisplayName entry of the provider metadata.

Use this property to provide or get the OrganizationDisplayName element of the provider metadata.

OrganizationLang: The OrganizationLang key of the provider metadata.

Use this property to get or set the OrganizationLog element of the provider metadata.

OrganizationName: The OrganizationName element of the provider metadata.

This configuration property allows you to set or get the OrganizationName element of the provider metadata.

OrganizationURL: The OrganizationURL element of the provider metadata.

Use this configuration setting to set or get the OrganizationURL parameter of the provider metadata.

PortRangeFrom: The lower bound of allowed port scope to listen on.

Specifies the lowest port number the server may use if dynamic allocation is used.

PortRangeTo: The higher bound of allowed port scope to listen on.

Specifies the highest port number the server may use if dynamic allocation is used.

RequestFilter: The request string modifier.

Use this property to tune up the request string as returned by GetRequestString method. Supported filters: params (request parameters only), params[Index] or params['Name'] (a specific request parameter), parts[Index] (the contents of a particular part of a multipart message). An empty request filter makes GetRequestString return the whole body of the request.

ServerName: Specifies the server name for the created responses.

Use this property to specify the server name to be included in the generated responses.

SessionTimeout: The HTTP session timeout.

The HTTP session timeout in milliseconds.

SessionTTL: The SAML session time-to-live value.

The SAML session time-to-live value, in milliseconds. The default value is 600000 (10 minutes).

SubjectConfirmationMethod: Subject confirmation method.

Provides means to set the subject confirmation method. The default value is urn:oasis:names:tc:SAML:2.0:cm:bearer.

TempPath: Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except PDFSigner, where this limitation does not apply.

Base Config Settings

ASN1UseGlobalTagCache: Controls whether ASN.1 module should use a global object cache.

This is a performance setting. It is unlikely that you will ever need to adjust it.

AssignSystemSmartCardPins: Specifies whether CSP-level PINs should be assigned to CNG keys.

This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

CheckKeyIntegrityBeforeUse: Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching: Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the struct.

Supported values are:


off		No caching (default)
local		Local caching
global		Global caching

Cookies: Gets or sets local cookies for the struct.

Use this property to get cookies from the internal cookie storage of the struct and/or restore them back between application sessions.

DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

DNSLocalSuffix: The suffix to assign for TLD names.

Use this global setting to adjust the default suffix to assign to top-level domain names. The default is .local.

EnableClientSideSSLFFDHE: Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

EnableSSHMLKEM: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.

Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components.

EnableTLSMLKEM: Enables support for ML-KEM and hybrid groups in TLS client and server components.

Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components.

GlobalCookies: Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the structs that have its CookieCaching property set to "global".

HardwareCryptoUsePolicy: The hardware crypto usage policy.

This global setting controls the hardware cryptography usage policy.

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.

HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other structs.

HttpVersion: The HTTP version to use in any inner HTTP client components created.

Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

IgnoreExpiredMSCTLSigningCert: Whether to tolerate the expired Windows Update signing certificate.

It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

ListDelimiter: The delimiter character for multi-element lists.

Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

LogDestination: Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:


file		File
console		Console
systemlog		System Log (supported for Android only)
debugger		Debugger (supported for VCL for Windows and .Net)

LogDetails: Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:


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

LogFile: Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters: Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:


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

LogFlushMode: Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:


none		No flush (caching only)
immediate		Immediate flush (real-time logging)
maxcount		Flush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel: Specifies the debug log level.

Use this property to provide the desired debug log level.

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.

LogMaxEventCount: Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode: Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:


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)

MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

OldClientSideRSAFallback: Specifies whether the SSH client should use a SHA1 fallback.

Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

PKICache: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.

The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.

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.

PKICachePath: Specifies the file system path where cached PKI data is stored.

The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts.

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.

ProductVersion: Returns the version of the SecureBlackbox library.

This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

ServerSSLDHKeyLength: Sets the size of the TLS DHE key exchange group.

Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

StaticDNS: Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the struct. Works only if UseOwnDNSResolver is set to true.

Supported values are:


none		No static DNS rules (default)
local		Local static DNS rules
global		Global static DNS rules

StaticIPAddress[domain]: Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the struct) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character.

StaticIPAddresses: Gets or sets all the static DNS rules.

Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the struct is set to "local", the property returns/restores the rules from/to the internal storage of the struct. If StaticDNS of the struct is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

Tag: Allows to store any custom data.

Use this config property to store any custom data.

TLSSessionGroup: Specifies the group name of TLS sessions to be used for session resumption.

Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the structs.

TLSSessionLifetime: Specifies lifetime in seconds of the cached TLS session.

Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

TLSSessionPurgeInterval: Specifies how often the session cache should remove the expired TLS sessions.

Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

UseCRLObjectCaching: Specifies whether reuse of loaded CRL objects is enabled.

This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.

UseInternalRandom: Switches between SecureBlackbox-own and platform PRNGs.

Allows to switch between internal/native PRNG implementation and the one provided by the platform.

UseLegacyAdESValidation: Enables legacy AdES validation mode.

Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

UseOCSPResponseObjectCaching: Specifies whether reuse of loaded OCSP response objects is enabled.

This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.

UseOwnDNSResolver: Specifies whether the client components should use own DNS resolver.

Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemNativeSizeCalculation: An internal CryptoAPI access tweak.

This is an internal setting. Please do not use it unless instructed by the support team.

UseSystemOAEPAndPSS: Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom: Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

XMLRDNDescriptorName[OID]: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.

This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

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");

XMLRDNDescriptorPriority[OID]: Specifies the priority of descriptor names associated with a specific OID.

This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.

XMLRDNDescriptorReverseOrder: Specifies whether to reverse the order of descriptors in RDN.

Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).

XMLRDNDescriptorSeparator: Specifies the separator used between descriptors in RDN.

Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.

Trappable Errors (SAMLIdPServer Component)

SAMLIdPServer 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`)