SAMLIdPServer Component
Properties Methods Events Configuration Settings Errors
The SAMLIdPServer component represents a SAML identity provider.
Syntax
TsbxSAMLIdPServer
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. |
ArtifactResolutionService | The location of the artifact resolution service. |
AttributeQueryService | The location of the AttributeQuery service. |
AuthFormTemplate | Defines the default authentication template (login page). |
EncryptAssertions | Specifies whether to encrypt assertions included into the IdP response. |
EncryptionCertificate | The certificate used to encrypt the assertions. |
ErrorOrigin | Indicates the endpoint where the error originates from. |
ErrorSeverity | The severity of the error that happened. |
ExternalCrypto | Provides access to external signing and DC parameters. |
Host | Specifies the host address of the IdP server. |
IDPSSOPage | Specifies the relative URL of the IdP-initiated SSO page. |
IDPSSOPageContent | The content of the IdP-initiated SSO page. |
LoginAttemptsLimit | The maximum number of login attempts. |
MetadataURL | The IdP's metadata location. |
MetaSigningCertificate | Specifies the metadata signing certificate. |
Port | The listening port number. |
PreferredSingleLogoutResponseBinding | Specifies the preferred single logout response binding. |
PreferredSingleSignOnResponseBinding | Specifies preferred SSO response binding. |
ServerCertificates | The server's TLS certificates. |
SignAssertions | Specifies whether the assertions included in IdP responses should be signed. |
SigningCertificate | The certificate to be used by the IdP's for signing. |
SigningChain | The signing certificate chain. |
SignMetadata | Specifies whether the IdP's metadata should be signed. |
SignResponse | Specifies whether the IdP responses should be signed. |
SingleLogoutService | The URL of the single logout service. |
SingleLogoutServiceBindings | Defines single logout service bindings. |
SingleSignOnService | The URL of the single logout service. |
SingleSignOnServiceBindings | Defines single sign-on service bindings. |
SocketSettings | Manages network connection settings. |
TLSSettings | Manages TLS layer settings. |
URL | Specifies the base URL of this IdP server. |
UseTLS | Enables or disables the secure connection requirement. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AddIdPSSOLink | Adds an SSO URL to the list. |
AddUser | Registers known user credentials. |
AddUserWithEmail | Registers known user credentials. |
ClearUsers | Clears the database of registered users. |
Config | Sets or retrieves a configuration setting. |
LoadSPMetadata | Loads the metadata required for information exchange with the service provider. |
RemoveIdPSSOLink | Removes the specified SSO link. |
RemoveSP | Removes an SP from the list of trusted service providers. |
RemoveUser | Unregister user credentials. |
SaveMetadata | Saves the IdP configuration to a metadata file. |
SaveMetadataToStream | Saves the IdP configuration to a metadata file. |
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. |
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. |
Notification | This event notifies the application about an underlying control flow event. |
SessionClosed | This event is fired when the IdP server has closed a session. |
SessionEstablished | This event is fired when a new session has been established. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
AssertionsOneTimeUse | Adds a one-time use condition to the assertion. |
AssertionsTTL | The assertions time-to-live value. |
BoundPort | The port that was bound by the server. |
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. |
MaxIssueInstantTimeDiff | The maximum issue-instant time delta. |
NotBeforeTimeout | The 'not-before' timeout to use. |
PortRangeFrom | The lower bound of allowed port scope to listen on. |
PortRangeTo | The higher bound of allowed port scope to listen on. |
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. |
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 component (supported for HTTPClient, RESTClient and SOAPClient only). |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
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. |
UseOwnDNSResolver | Specifies whether the client components should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |