SAMLSPServer Module
Properties Methods Events Configuration Settings Errors
The SAMLSPServer module represents a SAML service provider.
Syntax
SecureBlackbox.Samlspserver
Remarks
The service provider in the SAML (Security Assertion Markup Language) exchange flow represents the server that receives and accepts authentication assertions issued by the Identity Provider for single sign-on (SSO).
Property List
The following is the full list of the properties of the module with short descriptions. Click on the links for further details.
| Active | Tells whether the server is active and ready to process requests. |
| ArtifactResolutionService | The location of the artifact resolution service. |
| AssertionConsumerService | The location of the Assertion Consumer Service. |
| AssertionConsumerServiceBindings | Bindings supported by the Assertion Consumer Service. |
| BaseDir | Base directory on the server. |
| ClientAuth | Enables or disables certificate-based client authentication. |
| EncryptionCertificate | The certificate to be used to decrypt 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. |
| FIPSMode | Reserved. |
| Host | Specifies the host address of the SP server. |
| Issuer | Name identifier of the issuer of the SP's requests. |
| LogoutPage | Specifies the location of the logout page. |
| MetadataURL | The SP's metadata location. |
| MetaSigningCertificate | Specifies the metadata signing certificate. |
| OfflineMode | TBD. |
| Port | Specifies the listening port number. |
| PreferredIDPToSPBinding | Specifies the preferred IdP to SP binding. |
| ProtectedResources | Specifies the list of protected resources. |
| RedirectOnLogoutPage | Specifies the location to redirect the user on logout. |
| ServerCertificates | The server's TLS certificates. |
| SigCanonicalizationMethod | The canonicalization method to use in the signature. |
| SigDigestMethod | The digest method to use. |
| SigMethod | The signature method to use. |
| SignArtifactResolveRequests | Specifies whether to sign artifact resolution requests. |
| SignAuthnRequests | Specifies whether to sign Authn requests. |
| SigningCertificate | The certificate for signing the SP requests. |
| SigningChain | The signing certificate chain. |
| SignLogoutRequests | Specifies whether to sign Logout requests. |
| SignMetadata | Specifies whether to sign the metadata. |
| SingleLogoutService | The URL of the single logout service. |
| SingleLogoutServiceBindings | Defines single logout service bindings. |
| SocketSettings | Manages network connection settings. |
| SPToIDPBinding | Specifies the IdP to SP binding to use. |
| TLSSettings | Manages TLS layer settings. |
| URL | Specifies the base URL of this SP server. |
Method List
The following is the full list of the methods of the module with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting. |
| DoAction | Performs an additional action. |
| GetProviderProperty | TBD. |
| LoadIDPMetadata | Loads the metadata required for information exchange with the identity provider. |
| ProcessGenericRequest | TBD. |
| SaveMetadata | Saves the SP configuration to a metadata file. |
| SetProviderProperty | TBD. |
| Start | Starts the SP server. |
| Stop | Stops the IdP server. |
Event List
The following is the full list of the events fired by the module 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 SP 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 module with short descriptions. Click on the links for further details.
| BoundPort | The port that was bound by the server. |
| DualStack | Allows the use of ip4 and ip6 simultaneously. |
| HandshakeTimeout | The HTTPS handshake timeout. |
| MaxIssueInstantTimeDiff | The maximum issue-instant time delta. |
| PortRangeFrom | The lower bound of allowed port scope to listen on. |
| PortRangeTo | The higher bound of allowed port scope to listen on. |
| SendBufferSize | The network send buffer size. |
| ServerName | Specifies the server name for the created responses. |
| SessionTimeout | The HTTP session timeout. |
| SessionTTL | The SAML session time-to-live value. |
| 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 module (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. |
| Tag | Allows to store any custom data. |
| 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. |
Active Property (SAMLSPServer Module)
Tells whether the server is active and ready to process requests.
Syntax
public var active: Bool {
get {...} }
@property (nonatomic,readonly,assign,getter=active) BOOL active; - (BOOL)active;
Default Value
False
Remarks
This property indicates whether the IdP server is in an active state.
This property is read-only.
ArtifactResolutionService Property (SAMLSPServer Module)
The location of the artifact resolution service.
Syntax
public var artifactResolutionService: String {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=artifactResolutionService,setter=setArtifactResolutionService:) NSString* artifactResolutionService; - (NSString*)artifactResolutionService; - (void)setArtifactResolutionService :(NSString*)newArtifactResolutionService;
Default Value
"/sp/ArtifactResolutionService"
Remarks
Use this property to specify the location of the artifact resolution service of this Service Provider (SP).
AssertionConsumerService Property (SAMLSPServer Module)
The location of the Assertion Consumer Service.
Syntax
public var assertionConsumerService: String {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=assertionConsumerService,setter=setAssertionConsumerService:) NSString* assertionConsumerService; - (NSString*)assertionConsumerService; - (void)setAssertionConsumerService :(NSString*)newAssertionConsumerService;
Default Value
"/sp/AssertionConsumerService"
Remarks
The Assertion Consumer Service (ACS) is the location that accepts SAML responses (artifacts) to establish a session based on assertions.
AssertionConsumerServiceBindings Property (SAMLSPServer Module)
Bindings supported by the Assertion Consumer Service.
Syntax
public var assertionConsumerServiceBindings: String {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=assertionConsumerServiceBindings,setter=setAssertionConsumerServiceBindings:) NSString* assertionConsumerServiceBindings; - (NSString*)assertionConsumerServiceBindings; - (void)setAssertionConsumerServiceBindings :(NSString*)newAssertionConsumerServiceBindings;
Default Value
"+Artifact,+POST,+Redirect"
Remarks
Use this property to specify the bindings for the Assertion Consumer Service (ACS) provided by this SP.
BaseDir Property (SAMLSPServer Module)
Base directory on the server.
Syntax
public var baseDir: String {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=baseDir,setter=setBaseDir:) NSString* baseDir; - (NSString*)baseDir; - (void)setBaseDir :(NSString*)newBaseDir;
Default Value
""
Remarks
Use this property to specify the base directory for the SP server.
ClientAuth Property (SAMLSPServer Module)
Enables or disables certificate-based client authentication.
Syntax
public var clientAuth: SamlspserverClientAuths {
get {...}
set {...} }
public enum SamlspserverClientAuths: Int32 { case ccatNoAuth = 0 case ccatRequestCert = 1 case ccatRequireCert = 2 }
@property (nonatomic,readwrite,assign,getter=clientAuth,setter=setClientAuth:) int clientAuth; - (int)clientAuth; - (void)setClientAuth :(int)newClientAuth;
Default Value
0
Remarks
Set this property to true to tune up the client authentication type: ccatNoAuth = 0; ccatRequestCert = 1; ccatRequireCert = 2;
EncryptionCertificate Property (SAMLSPServer Module)
The certificate to be used to decrypt assertions.
Syntax
public var encryptionCertificate: Certificate {
get {...}
set {...} }
@property (nonatomic,readonly,assign,getter=encryptionCertBytes) NSData* encryptionCertBytes; - (NSData*)encryptionCertBytes; @property (nonatomic,readwrite,assign,getter=encryptionCertHandle,setter=setEncryptionCertHandle:) long long encryptionCertHandle; - (long long)encryptionCertHandle; - (void)setEncryptionCertHandle :(long long)newEncryptionCertHandle;
Default Value
""
Remarks
Use this property to set the base URL for this Service Provider (SP) server.
ErrorOrigin Property (SAMLSPServer Module)
Indicates the endpoint where the error originates from.
Syntax
public var errorOrigin: SamlspserverErrorOrigins {
get {...}
set {...} }
public enum SamlspserverErrorOrigins: Int32 { case eoLocal = 0 case eoRemote = 1 }
@property (nonatomic,readwrite,assign,getter=errorOrigin,setter=setErrorOrigin:) int errorOrigin; - (int)errorOrigin; - (void)setErrorOrigin :(int)newErrorOrigin;
Default Value
0
Remarks
Use this property to establish whether the reported error originates from a local or remote endpoint.
| eoLocal | 0 | |
| eoRemote | 1 |
ErrorSeverity Property (SAMLSPServer Module)
The severity of the error that happened.
Syntax
public var errorSeverity: SamlspserverErrorSeverities {
get {...}
set {...} }
public enum SamlspserverErrorSeverities: Int32 { case esInfo = 0 case esWarning = 1 case esFatal = 2 }
@property (nonatomic,readwrite,assign,getter=errorSeverity,setter=setErrorSeverity:) int errorSeverity; - (int)errorSeverity; - (void)setErrorSeverity :(int)newErrorSeverity;
Default Value
1
Remarks
Use this property to establish whether the error is fatal.
| esWarning | 1 | |
| esFatal | 2 |
ExternalCrypto Property (SAMLSPServer Module)
Provides access to external signing and DC parameters.
Syntax
public var externalCrypto: ExternalCrypto {
get {...} }
@property (nonatomic,readwrite,assign,getter=externalCryptoAsyncDocumentID,setter=setExternalCryptoAsyncDocumentID:) NSString* externalCryptoAsyncDocumentID; - (NSString*)externalCryptoAsyncDocumentID; - (void)setExternalCryptoAsyncDocumentID :(NSString*)newExternalCryptoAsyncDocumentID; @property (nonatomic,readwrite,assign,getter=externalCryptoCustomParams,setter=setExternalCryptoCustomParams:) NSString* externalCryptoCustomParams; - (NSString*)externalCryptoCustomParams; - (void)setExternalCryptoCustomParams :(NSString*)newExternalCryptoCustomParams; @property (nonatomic,readwrite,assign,getter=externalCryptoData,setter=setExternalCryptoData:) NSString* externalCryptoData; - (NSString*)externalCryptoData; - (void)setExternalCryptoData :(NSString*)newExternalCryptoData; @property (nonatomic,readwrite,assign,getter=externalCryptoExternalHashCalculation,setter=setExternalCryptoExternalHashCalculation:) BOOL externalCryptoExternalHashCalculation; - (BOOL)externalCryptoExternalHashCalculation; - (void)setExternalCryptoExternalHashCalculation :(BOOL)newExternalCryptoExternalHashCalculation; @property (nonatomic,readwrite,assign,getter=externalCryptoHashAlgorithm,setter=setExternalCryptoHashAlgorithm:) NSString* externalCryptoHashAlgorithm; - (NSString*)externalCryptoHashAlgorithm; - (void)setExternalCryptoHashAlgorithm :(NSString*)newExternalCryptoHashAlgorithm; @property (nonatomic,readwrite,assign,getter=externalCryptoKeyID,setter=setExternalCryptoKeyID:) NSString* externalCryptoKeyID; - (NSString*)externalCryptoKeyID; - (void)setExternalCryptoKeyID :(NSString*)newExternalCryptoKeyID; @property (nonatomic,readwrite,assign,getter=externalCryptoKeySecret,setter=setExternalCryptoKeySecret:) NSString* externalCryptoKeySecret; - (NSString*)externalCryptoKeySecret; - (void)setExternalCryptoKeySecret :(NSString*)newExternalCryptoKeySecret; @property (nonatomic,readwrite,assign,getter=externalCryptoMethod,setter=setExternalCryptoMethod:) int externalCryptoMethod; - (int)externalCryptoMethod; - (void)setExternalCryptoMethod :(int)newExternalCryptoMethod; @property (nonatomic,readwrite,assign,getter=externalCryptoMode,setter=setExternalCryptoMode:) int externalCryptoMode; - (int)externalCryptoMode; - (void)setExternalCryptoMode :(int)newExternalCryptoMode; @property (nonatomic,readwrite,assign,getter=externalCryptoPublicKeyAlgorithm,setter=setExternalCryptoPublicKeyAlgorithm:) NSString* externalCryptoPublicKeyAlgorithm; - (NSString*)externalCryptoPublicKeyAlgorithm; - (void)setExternalCryptoPublicKeyAlgorithm :(NSString*)newExternalCryptoPublicKeyAlgorithm;
Default Value
""
Remarks
Use this property to set the base URL for this Service Provider (SP) server.
FIPSMode Property (SAMLSPServer Module)
Reserved.
Syntax
public var fipsMode: Bool {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=FIPSMode,setter=setFIPSMode:) BOOL FIPSMode; - (BOOL)FIPSMode; - (void)setFIPSMode :(BOOL)newFIPSMode;
Default Value
False
Remarks
This property is reserved for future use.
Host Property (SAMLSPServer Module)
Specifies the host address of the SP server.
Syntax
public var host: String {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=host,setter=setHost:) NSString* host; - (NSString*)host; - (void)setHost :(NSString*)newHost;
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.
Issuer Property (SAMLSPServer Module)
Name identifier of the issuer of the SP's requests.
Syntax
public var issuer: String {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=issuer,setter=setIssuer:) NSString* issuer; - (NSString*)issuer; - (void)setIssuer :(NSString*)newIssuer;
Default Value
""
Remarks
Use this property to set the name identifier of this Service Provider (SP) to be used in its requests.
LogoutPage Property (SAMLSPServer Module)
Specifies the location of the logout page.
Syntax
public var logoutPage: String {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=logoutPage,setter=setLogoutPage:) NSString* logoutPage; - (NSString*)logoutPage; - (void)setLogoutPage :(NSString*)newLogoutPage;
Default Value
"/sp/logout"
Remarks
Use this property to specify the relative URL of the logout page.
MetadataURL Property (SAMLSPServer Module)
The SP's metadata location.
Syntax
public var metadataURL: String {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=metadataURL,setter=setMetadataURL:) NSString* metadataURL; - (NSString*)metadataURL; - (void)setMetadataURL :(NSString*)newMetadataURL;
Default Value
"/sp/metadata"
Remarks
This property specifies the metadata URL of this Service Provider (SP).
MetaSigningCertificate Property (SAMLSPServer Module)
Specifies the metadata signing certificate.
Syntax
public var metaSigningCertificate: Certificate {
get {...}
set {...} }
@property (nonatomic,readonly,assign,getter=metaSigningCertBytes) NSData* metaSigningCertBytes; - (NSData*)metaSigningCertBytes; @property (nonatomic,readwrite,assign,getter=metaSigningCertHandle,setter=setMetaSigningCertHandle:) long long metaSigningCertHandle; - (long long)metaSigningCertHandle; - (void)setMetaSigningCertHandle :(long long)newMetaSigningCertHandle;
Default Value
""
Remarks
Use this property to set the base URL for this Service Provider (SP) server.
OfflineMode Property (SAMLSPServer Module)
TBD.
Syntax
public var offlineMode: Bool {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=offlineMode,setter=setOfflineMode:) BOOL offlineMode; - (BOOL)offlineMode; - (void)setOfflineMode :(BOOL)newOfflineMode;
Default Value
False
Remarks
TBD.
Port Property (SAMLSPServer Module)
Specifies the listening port number.
Syntax
public var port: Int32 {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=port,setter=setPort:) int port; - (int)port; - (void)setPort :(int)newPort;
Default Value
80
Remarks
Use this property to specify the port number on which the SP server should listen for incoming connections. To specify the server's IP address use Host.
PreferredIDPToSPBinding Property (SAMLSPServer Module)
Specifies the preferred IdP to SP binding.
Syntax
public var preferredIDPToSPBinding: SamlspserverPreferredIDPToSPBindings {
get {...}
set {...} }
public enum SamlspserverPreferredIDPToSPBindings: Int32 { case csbtNone = 0 case csbtSOAP = 1 case csbtPAOS = 2 case csbtRedirect = 3 case csbtPOST = 4 case csbtArtifact = 5 }
@property (nonatomic,readwrite,assign,getter=preferredIDPToSPBinding,setter=setPreferredIDPToSPBinding:) int preferredIDPToSPBinding; - (int)preferredIDPToSPBinding; - (void)setPreferredIDPToSPBinding :(int)newPreferredIDPToSPBinding;
Default Value
4
Remarks
Specifies the preferred binding (message exchange mechanism) used for communication with Identity Provider (IdP).
| csbtNone | 0 | |
| csbtSOAP | 1 | |
| csbtPAOS | 2 | |
| csbtRedirect | 3 | |
| csbtPOST | 4 | |
| csbtArtifact | 5 |
ProtectedResources Property (SAMLSPServer Module)
Specifies the list of protected resources.
Syntax
public var protectedResources: String {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=protectedResources,setter=setProtectedResources:) NSString* protectedResources; - (NSString*)protectedResources; - (void)setProtectedResources :(NSString*)newProtectedResources;
Default Value
""
Remarks
This property contains a set of relative URLs of the protected resources offered by this Service Provider (SP).
RedirectOnLogoutPage Property (SAMLSPServer Module)
Specifies the location to redirect the user on logout.
Syntax
public var redirectOnLogoutPage: String {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=redirectOnLogoutPage,setter=setRedirectOnLogoutPage:) NSString* redirectOnLogoutPage; - (NSString*)redirectOnLogoutPage; - (void)setRedirectOnLogoutPage :(NSString*)newRedirectOnLogoutPage;
Default Value
"https://secureblackbox.com"
Remarks
Use this property to specify the page where to redirect the user on logout.
ServerCertificates Property (SAMLSPServer Module)
The server's TLS certificates.
Syntax
public var serverCertificates: Array<Certificate> {
get {...} }
@property (nonatomic,readwrite,assign,getter=serverCertCount,setter=setServerCertCount:) int serverCertCount; - (int)serverCertCount; - (void)setServerCertCount :(int)newServerCertCount; - (NSData*)serverCertBytes:(int)serverCertIndex; - (long long)serverCertHandle:(int)serverCertIndex; - (void)setServerCertHandle:(int)serverCertIndex :(long long)newServerCertHandle;
Default Value
""
Remarks
Use this property to set the base URL for this Service Provider (SP) server.
SigCanonicalizationMethod Property (SAMLSPServer Module)
The canonicalization method to use in the signature.
Syntax
public var sigCanonicalizationMethod: String {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=sigCanonicalizationMethod,setter=setSigCanonicalizationMethod:) NSString* sigCanonicalizationMethod; - (NSString*)sigCanonicalizationMethod; - (void)setSigCanonicalizationMethod :(NSString*)newSigCanonicalizationMethod;
Default Value
""
Remarks
The URI of the canonicalization method to use in the signature (e.g. http://www.w3.org/TR/xml-exc-c14n/)
SigDigestMethod Property (SAMLSPServer Module)
The digest method to use.
Syntax
public var sigDigestMethod: String {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=sigDigestMethod,setter=setSigDigestMethod:) NSString* sigDigestMethod; - (NSString*)sigDigestMethod; - (void)setSigDigestMethod :(NSString*)newSigDigestMethod;
Default Value
""
Remarks
The URI of the digest method to use for signing, as defined in XMLDSIG or XMLENC: http://www.w3.org/2000/09/xmldsig#sha256.
SigMethod Property (SAMLSPServer Module)
The signature method to use.
Syntax
public var sigMethod: String {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=sigMethod,setter=setSigMethod:) NSString* sigMethod; - (NSString*)sigMethod; - (void)setSigMethod :(NSString*)newSigMethod;
Default Value
""
Remarks
The URI specifying the signature method to use for signing, for example http://www.w3.org/2001/04/xmldsig-more#rsa-sha256.
SignArtifactResolveRequests Property (SAMLSPServer Module)
Specifies whether to sign artifact resolution requests.
Syntax
public var signArtifactResolveRequests: Bool {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=signArtifactResolveRequests,setter=setSignArtifactResolveRequests:) BOOL signArtifactResolveRequests; - (BOOL)signArtifactResolveRequests; - (void)setSignArtifactResolveRequests :(BOOL)newSignArtifactResolveRequests;
Default Value
False
Remarks
Set this property to true to enable signing of artifact resolution requests.
SignAuthnRequests Property (SAMLSPServer Module)
Specifies whether to sign Authn requests.
Syntax
public var signAuthnRequests: Bool {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=signAuthnRequests,setter=setSignAuthnRequests:) BOOL signAuthnRequests; - (BOOL)signAuthnRequests; - (void)setSignAuthnRequests :(BOOL)newSignAuthnRequests;
Default Value
False
Remarks
Set this property to true to enable signing of Authn requests.
SigningCertificate Property (SAMLSPServer Module)
The certificate for signing the SP requests.
Syntax
public var signingCertificate: Certificate {
get {...}
set {...} }
@property (nonatomic,readonly,assign,getter=signingCertBytes) NSData* signingCertBytes; - (NSData*)signingCertBytes; @property (nonatomic,readwrite,assign,getter=signingCertHandle,setter=setSigningCertHandle:) long long signingCertHandle; - (long long)signingCertHandle; - (void)setSigningCertHandle :(long long)newSigningCertHandle;
Default Value
""
Remarks
Use this property to set the base URL for this Service Provider (SP) server.
SigningChain Property (SAMLSPServer Module)
The signing certificate chain.
Syntax
public var signingChain: Array<Certificate> {
get {...} }
@property (nonatomic,readwrite,assign,getter=signingChainCount,setter=setSigningChainCount:) int signingChainCount; - (int)signingChainCount; - (void)setSigningChainCount :(int)newSigningChainCount; - (NSData*)signingChainBytes:(int)signingChainIndex; - (long long)signingChainHandle:(int)signingChainIndex; - (void)setSigningChainHandle:(int)signingChainIndex :(long long)newSigningChainHandle;
Default Value
""
Remarks
Use this property to set the base URL for this Service Provider (SP) server.
SignLogoutRequests Property (SAMLSPServer Module)
Specifies whether to sign Logout requests.
Syntax
public var signLogoutRequests: Bool {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=signLogoutRequests,setter=setSignLogoutRequests:) BOOL signLogoutRequests; - (BOOL)signLogoutRequests; - (void)setSignLogoutRequests :(BOOL)newSignLogoutRequests;
Default Value
False
Remarks
Set this property to true to enable signing of logout requests.
SignMetadata Property (SAMLSPServer Module)
Specifies whether to sign the metadata.
Syntax
public var signMetadata: Bool {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=signMetadata,setter=setSignMetadata:) BOOL signMetadata; - (BOOL)signMetadata; - (void)setSignMetadata :(BOOL)newSignMetadata;
Default Value
False
Remarks
Set this property to True to enforce signing of the metadata before saving it. Do not forget to assign the signing certificate to the MetaSigningCertificate property.
SingleLogoutService Property (SAMLSPServer Module)
The URL of the single logout service.
Syntax
public var singleLogoutService: String {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=singleLogoutService,setter=setSingleLogoutService:) NSString* singleLogoutService; - (NSString*)singleLogoutService; - (void)setSingleLogoutService :(NSString*)newSingleLogoutService;
Default Value
"/sp/SingleLogoutService"
Remarks
Use this property to specify the relative URL of the single logout service.
SingleLogoutServiceBindings Property (SAMLSPServer Module)
Defines single logout service bindings.
Syntax
public var singleLogoutServiceBindings: String {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=singleLogoutServiceBindings,setter=setSingleLogoutServiceBindings:) NSString* singleLogoutServiceBindings; - (NSString*)singleLogoutServiceBindings; - (void)setSingleLogoutServiceBindings :(NSString*)newSingleLogoutServiceBindings;
Default Value
"+Artifact,+POST,+Redirect"
Remarks
Use this property to specify the single logout service bindings.
The binding is the mechanism of message exchange used by SAML requestors and responders.
SocketSettings Property (SAMLSPServer Module)
Manages network connection settings.
Syntax
public var socketSettings: SocketSettings {
get {...} }
@property (nonatomic,readwrite,assign,getter=socketIncomingSpeedLimit,setter=setSocketIncomingSpeedLimit:) int socketIncomingSpeedLimit; - (int)socketIncomingSpeedLimit; - (void)setSocketIncomingSpeedLimit :(int)newSocketIncomingSpeedLimit; @property (nonatomic,readwrite,assign,getter=socketLocalAddress,setter=setSocketLocalAddress:) NSString* socketLocalAddress; - (NSString*)socketLocalAddress; - (void)setSocketLocalAddress :(NSString*)newSocketLocalAddress; @property (nonatomic,readwrite,assign,getter=socketLocalPort,setter=setSocketLocalPort:) int socketLocalPort; - (int)socketLocalPort; - (void)setSocketLocalPort :(int)newSocketLocalPort; @property (nonatomic,readwrite,assign,getter=socketOutgoingSpeedLimit,setter=setSocketOutgoingSpeedLimit:) int socketOutgoingSpeedLimit; - (int)socketOutgoingSpeedLimit; - (void)setSocketOutgoingSpeedLimit :(int)newSocketOutgoingSpeedLimit; @property (nonatomic,readwrite,assign,getter=socketTimeout,setter=setSocketTimeout:) int socketTimeout; - (int)socketTimeout; - (void)setSocketTimeout :(int)newSocketTimeout; @property (nonatomic,readwrite,assign,getter=socketUseIPv6,setter=setSocketUseIPv6:) BOOL socketUseIPv6; - (BOOL)socketUseIPv6; - (void)setSocketUseIPv6 :(BOOL)newSocketUseIPv6;
Default Value
""
Remarks
Use this property to set the base URL for this Service Provider (SP) server.
SPToIDPBinding Property (SAMLSPServer Module)
Specifies the IdP to SP binding to use.
Syntax
public var spToIDPBinding: SamlspserverSPToIDPBindings {
get {...}
set {...} }
public enum SamlspserverSPToIDPBindings: Int32 { case csbtNone = 0 case csbtSOAP = 1 case csbtPAOS = 2 case csbtRedirect = 3 case csbtPOST = 4 case csbtArtifact = 5 }
@property (nonatomic,readwrite,assign,getter=SPToIDPBinding,setter=setSPToIDPBinding:) int SPToIDPBinding; - (int)SPToIDPBinding; - (void)setSPToIDPBinding :(int)newSPToIDPBinding;
Default Value
3
Remarks
Specifies the binding (message exchange mechanism) used for communication with Identity Provider (IdP) that is actually used during the session.
To specify the preferred binding, use PreferredIDPToSPBinding.
| csbtNone | 0 | |
| csbtSOAP | 1 | |
| csbtPAOS | 2 | |
| csbtRedirect | 3 | |
| csbtPOST | 4 | |
| csbtArtifact | 5 |
TLSSettings Property (SAMLSPServer Module)
Manages TLS layer settings.
Syntax
public var tlsSettings: TLSSettings {
get {...} }
@property (nonatomic,readwrite,assign,getter=TLSAutoValidateCertificates,setter=setTLSAutoValidateCertificates:) BOOL TLSAutoValidateCertificates; - (BOOL)TLSAutoValidateCertificates; - (void)setTLSAutoValidateCertificates :(BOOL)newTLSAutoValidateCertificates; @property (nonatomic,readwrite,assign,getter=TLSBaseConfiguration,setter=setTLSBaseConfiguration:) int TLSBaseConfiguration; - (int)TLSBaseConfiguration; - (void)setTLSBaseConfiguration :(int)newTLSBaseConfiguration; @property (nonatomic,readwrite,assign,getter=TLSCiphersuites,setter=setTLSCiphersuites:) NSString* TLSCiphersuites; - (NSString*)TLSCiphersuites; - (void)setTLSCiphersuites :(NSString*)newTLSCiphersuites; @property (nonatomic,readwrite,assign,getter=TLSECCurves,setter=setTLSECCurves:) NSString* TLSECCurves; - (NSString*)TLSECCurves; - (void)setTLSECCurves :(NSString*)newTLSECCurves; @property (nonatomic,readwrite,assign,getter=TLSExtensions,setter=setTLSExtensions:) NSString* TLSExtensions; - (NSString*)TLSExtensions; - (void)setTLSExtensions :(NSString*)newTLSExtensions; @property (nonatomic,readwrite,assign,getter=TLSForceResumeIfDestinationChanges,setter=setTLSForceResumeIfDestinationChanges:) BOOL TLSForceResumeIfDestinationChanges; - (BOOL)TLSForceResumeIfDestinationChanges; - (void)setTLSForceResumeIfDestinationChanges :(BOOL)newTLSForceResumeIfDestinationChanges; @property (nonatomic,readwrite,assign,getter=TLSPreSharedIdentity,setter=setTLSPreSharedIdentity:) NSString* TLSPreSharedIdentity; - (NSString*)TLSPreSharedIdentity; - (void)setTLSPreSharedIdentity :(NSString*)newTLSPreSharedIdentity; @property (nonatomic,readwrite,assign,getter=TLSPreSharedKey,setter=setTLSPreSharedKey:) NSString* TLSPreSharedKey; - (NSString*)TLSPreSharedKey; - (void)setTLSPreSharedKey :(NSString*)newTLSPreSharedKey; @property (nonatomic,readwrite,assign,getter=TLSPreSharedKeyCiphersuite,setter=setTLSPreSharedKeyCiphersuite:) NSString* TLSPreSharedKeyCiphersuite; - (NSString*)TLSPreSharedKeyCiphersuite; - (void)setTLSPreSharedKeyCiphersuite :(NSString*)newTLSPreSharedKeyCiphersuite; @property (nonatomic,readwrite,assign,getter=TLSRenegotiationAttackPreventionMode,setter=setTLSRenegotiationAttackPreventionMode:) int TLSRenegotiationAttackPreventionMode; - (int)TLSRenegotiationAttackPreventionMode; - (void)setTLSRenegotiationAttackPreventionMode :(int)newTLSRenegotiationAttackPreventionMode; @property (nonatomic,readwrite,assign,getter=TLSRevocationCheck,setter=setTLSRevocationCheck:) int TLSRevocationCheck; - (int)TLSRevocationCheck; - (void)setTLSRevocationCheck :(int)newTLSRevocationCheck; @property (nonatomic,readwrite,assign,getter=TLSSSLOptions,setter=setTLSSSLOptions:) int TLSSSLOptions; - (int)TLSSSLOptions; - (void)setTLSSSLOptions :(int)newTLSSSLOptions; @property (nonatomic,readwrite,assign,getter=TLSTLSMode,setter=setTLSTLSMode:) int TLSTLSMode; - (int)TLSTLSMode; - (void)setTLSTLSMode :(int)newTLSTLSMode; @property (nonatomic,readwrite,assign,getter=TLSUseExtendedMasterSecret,setter=setTLSUseExtendedMasterSecret:) BOOL TLSUseExtendedMasterSecret; - (BOOL)TLSUseExtendedMasterSecret; - (void)setTLSUseExtendedMasterSecret :(BOOL)newTLSUseExtendedMasterSecret; @property (nonatomic,readwrite,assign,getter=TLSUseSessionResumption,setter=setTLSUseSessionResumption:) BOOL TLSUseSessionResumption; - (BOOL)TLSUseSessionResumption; - (void)setTLSUseSessionResumption :(BOOL)newTLSUseSessionResumption; @property (nonatomic,readwrite,assign,getter=TLSVersions,setter=setTLSVersions:) int TLSVersions; - (int)TLSVersions; - (void)setTLSVersions :(int)newTLSVersions;
Default Value
""
Remarks
Use this property to set the base URL for this Service Provider (SP) server.
URL Property (SAMLSPServer Module)
Specifies the base URL of this SP server.
Syntax
public var url: String {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=URL,setter=setURL:) NSString* URL; - (NSString*)URL; - (void)setURL :(NSString*)newURL;
Default Value
""
Remarks
Use this property to set the base URL for this Service Provider (SP) server.
Config Method (SAMLSPServer Module)
Sets or retrieves a configuration setting.
Syntax
- (NSString*)config:(NSString*)configurationString;
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
DoAction Method (SAMLSPServer Module)
Performs an additional action.
Syntax
- (NSString*)doAction:(NSString*)actionID :(NSString*)actionParams;
Remarks
DoAction is a generic method available in every class. 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 of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
GetProviderProperty Method (SAMLSPServer Module)
TBD.
Syntax
- (NSString*)getProviderProperty:(NSString*)name;
Remarks
TBD
LoadIDPMetadata Method (SAMLSPServer Module)
Loads the metadata required for information exchange with the identity provider.
Syntax
- (void)loadIDPMetadata:(NSString*)fileName;
Remarks
The Identity provider (IdP) may have different options and requirements for interactions with the Service Provider (SP). Usually all these options together with X.509 certificates needed for data exchange are stored in XML metadata files. Use this method to load metadata from a file generated by an IdP.
FileName specifies the metadata file name.
ProcessGenericRequest Method (SAMLSPServer Module)
TBD.
Syntax
- (NSData*)processGenericRequest:(NSData*)request;
Remarks
TBD
SaveMetadata Method (SAMLSPServer Module)
Saves the SP configuration to a metadata file.
Syntax
Remarks
Use this method to save the Service Provider (SP) configuration in the form of XML metadata in the file specified by FileName. This file may be transferred to identity providers (IdP) to adjust their interaction processes.
SetProviderProperty Method (SAMLSPServer Module)
TBD.
Syntax
- (void)setProviderProperty:(NSString*)name :(NSString*)value;
Remarks
TBD
Start Method (SAMLSPServer Module)
Starts the SP server.
Syntax
public func start() throws -> Void
- (void)start;
Remarks
Use this method to start listening for incoming connections.
Stop Method (SAMLSPServer Module)
Stops the IdP server.
Syntax
public func stop() throws -> Void
- (void)stop;
Remarks
Call this method to stop listening for incoming connections.
Accept Event (SAMLSPServer Module)
Reports an incoming connection.
Syntax
func onAccept(remoteAddress: String, remotePort: Int32, accept: inout Bool)
- (void)onAccept:(NSString*)remoteAddress :(int)remotePort :(int*)accept;
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.
Connect Event (SAMLSPServer Module)
Reports an accepted connection.
Syntax
- (void)onConnect:(long long)connectionId :(NSString*)remoteAddress :(int)remotePort;
Remarks
The class fires this event to report that a new connection has been established. ConnectionId indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as SessionClosed or SessionEstablished.
Disconnect Event (SAMLSPServer Module)
Fires to report a disconnected client.
Syntax
func onDisconnect(connectionID: Int64)
- (void)onDisconnect:(long long)connectionID;
Remarks
The class fires this event when a connected client disconnects.
Error Event (SAMLSPServer Module)
Information about errors during data delivery.
Syntax
- (void)onError:(int)errorCode :(NSString*)description;
Remarks
The event is fired in case of exceptional conditions during message processing.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the section.
ExternalSign Event (SAMLSPServer Module)
Handles remote or external signing initiated by the server protocol.
Syntax
func onExternalSign(connectionID: Int64, operationId: String, hashAlgorithm: String, pars: String, data: String, signedData: inout String)
- (void)onExternalSign:(long long)connectionID :(NSString*)operationId :(NSString*)hashAlgorithm :(NSString*)pars :(NSString*)data :(NSString**)signedData;
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 component via SignedData parameter.
OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contain algorithm-dependent parameters.
The component uses base16 (hex) encoding for 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
Notification Event (SAMLSPServer Module)
This event notifies the application about an underlying control flow event.
Syntax
- (void)onNotification:(NSString*)eventID :(NSString*)eventParam;
Remarks
The class fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
SessionClosed Event (SAMLSPServer Module)
This event is fired when the SP server has closed a session.
Syntax
func onSessionClosed(connectionID: Int64)
- (void)onSessionClosed:(long long)connectionID;
Remarks
ConnectionID contains the identifier of the closed session.
SessionEstablished Event (SAMLSPServer Module)
This event is fired when a new session has been established.
Syntax
- (void)onSessionEstablished:(long long)connectionID :(NSString*)username;
Remarks
ConnectionID contains the identifier of the new session, Username specifies the client's address and Username.
Certificate Type
Provides details of an individual X.509 certificate.
Remarks
This type provides access to X.509 certificate details.
Fields
|
bytes Data |
Returns raw certificate data in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ca Bool |
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
caKeyID Data |
A unique identifier (fingerprint) of the CA certificate's private key. Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
crlDistributionPoints String |
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
curve String |
Specifies the elliptic curve of the EC public key.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
fingerprint Data |
Contains the fingerprint (a hash imprint) of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
friendlyName String |
Contains an associated alias (friendly name) of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
handle Int64 |
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.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hashAlgorithm String |
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
issuer String |
The common name of the certificate issuer (CA), typically a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
issuerRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyAlgorithm String |
Specifies the public key algorithm of this certificate.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyBits Int32 |
Returns the length of the public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyFingerprint Data |
Returns a fingerprint of the public key contained in the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyUsage Int32 |
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:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyValid Bool |
Returns True if the certificate's key is cryptographically valid, and False otherwise. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ocspLocations String |
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ocspNoCheck Bool |
TBD. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
origin Int32 |
Returns the origin of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
policyIDs String |
Contains identifiers (OIDs) of the applicable certificate policies. The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
privateKeyBytes Data |
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
privateKeyExists Bool |
Indicates whether the certificate has an associated private key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
privateKeyExtractable Bool |
Indicates whether the private key is extractable |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
publicKeyBytes Data |
Contains the certificate's public key in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
qualifiedStatements QualifiedStatementsTypes |
TBD |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
selfSigned Bool |
Indicates whether the certificate is self-signed (root) or signed by an external CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
serialNumber Data |
Returns the certificate's serial number. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
sigAlgorithm String |
Indicates the algorithm that was used by the CA to sign this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subject String |
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subjectAlternativeName String |
TBD. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subjectKeyID Data |
Contains a unique identifier (fingerprint) of the certificate's private key. Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subjectRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
validFrom String |
The time point at which the certificate becomes valid, in UTC. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
validTo String |
The time point at which the certificate expires, in UTC. |
Constructors
public init(stream: InputStream?)
Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.
public init()
Creates a new object with default field values.
ExternalCrypto Type
Specifies the parameters of external cryptographic calls.
Remarks
External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.
Fields
|
asyncDocumentID String |
Specifies the document ID for SignAsyncEnd() call Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. This value helps ASiCSigner 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 pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
customParams String |
Custom parameters to be passed to the signing service (uninterpreted). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
data String |
Additional data to be included in the async state and mirrored back by the requestor |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
externalHashCalculation Bool |
Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hashAlgorithm String |
Specifies the request's signature hash algorithm.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyID String |
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 extra protection layer for the protocol and diminishes the risk of private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use 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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keySecret String |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
method AsyncSignMethods |
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup. Available options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
mode ExternalCryptoModes |
Specifies the external cryptography mode. Available options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
publicKeyAlgorithm String |
Provide public key algorithm here if the certificate is not available on the pre-signing stage.
|
Constructors
public init()
Creates a new ExternalCrypto object with default field values.
SocketSettings Type
A container for the socket settings.
Remarks
This type is a container for socket-layer parameters.
Fields
|
dnsMode DNSResolveModes |
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
|
||||||||
|
dnsPort Int32 |
Specifies the port number to be used for sending queries to the DNS server. |
||||||||
|
dnsQueryTimeout Int32 |
The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout. |
||||||||
|
dnsServers String |
The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
||||||||
|
dnsTotalTimeout Int32 |
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout. |
||||||||
|
incomingSpeedLimit Int32 |
The maximum number of bytes to read from the socket, per second. |
||||||||
|
localAddress String |
The local network interface to bind the socket to. |
||||||||
|
localPort Int32 |
The local port number to bind the socket to. |
||||||||
|
outgoingSpeedLimit Int32 |
The maximum number of bytes to write to the socket, per second. |
||||||||
|
timeout Int32 |
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). |
||||||||
|
useIPv6 Bool |
Enables or disables IP protocol version 6. |
Constructors
public init()
Creates a new SocketSettings object.
TLSSettings Type
A container for TLS connection settings.
Remarks
TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.
Fields
|
autoValidateCertificates Bool |
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
|||||||||||||||||||||||||||||||||
|
baseConfiguration SecureTransportPredefinedConfigurations |
Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility.
|
|||||||||||||||||||||||||||||||||
|
ciphersuites String |
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 that allow to blanketly enable or disable all ciphersuites at once. Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. 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:
|
|||||||||||||||||||||||||||||||||
|
ecCurves String |
Defines the elliptic curves to enable. |
|||||||||||||||||||||||||||||||||
|
extensions String |
Provides access to TLS extensions. |
|||||||||||||||||||||||||||||||||
|
forceResumeIfDestinationChanges Bool |
Whether to force TLS session resumption when the destination address changes. |
|||||||||||||||||||||||||||||||||
|
preSharedIdentity String |
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
|||||||||||||||||||||||||||||||||
|
preSharedKey String |
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
|||||||||||||||||||||||||||||||||
|
preSharedKeyCiphersuite String |
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
|||||||||||||||||||||||||||||||||
|
renegotiationAttackPreventionMode RenegotiationAttackPreventionModes |
Selects renegotiation attack prevention mechanism. The following options are available:
|
|||||||||||||||||||||||||||||||||
|
revocationCheck RevocationCheckKinds |
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.
This setting controls the way the revocation checks are performed. 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 faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential. |
|||||||||||||||||||||||||||||||||
|
sslOptions Int32 |
Various SSL (TLS) protocol options, set of
|
|||||||||||||||||||||||||||||||||
|
tlsMode SSLModes |
Specifies the TLS mode to use.
|
|||||||||||||||||||||||||||||||||
|
useExtendedMasterSecret Bool |
Enables Extended Master Secret Extension, as defined in RFC 7627. |
|||||||||||||||||||||||||||||||||
|
useSessionResumption Bool |
Enables or disables TLS session resumption capability. |
|||||||||||||||||||||||||||||||||
|
versions Int32 |
Th SSL/TLS versions to enable by default.
|
Constructors
public init()
Creates a new TLSSettings object.
Configuration Settings (SAMLSPServer Module)
The class 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 class, access to these internal properties is provided through the Config method.SAMLSPServer Configuration Settings | ||||||||||||||||||||||||||||||
| BoundPort: The port that was bound by the server.Returns the port number that was bound by the server. | ||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
| SendBufferSize: The network send buffer size.Specifies the size of the output buffer. | ||||||||||||||||||||||||||||||
| 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). | ||||||||||||||||||||||||||||||
| TempPath: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. | ||||||||||||||||||||||||||||||
Base Configuration Settings | ||||||||||||||||||||||||||||||
| 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 class.
Supported values are:
|
||||||||||||||||||||||||||||||
| Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the class 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. | ||||||||||||||||||||||||||||||
| 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. |
||||||||||||||||||||||||||||||
| 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 classes that have its CookieCaching property set to "global". | ||||||||||||||||||||||||||||||
| 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 classes. | ||||||||||||||||||||||||||||||
| LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
| Tag: Allows to store any custom data.Use this config property to store any custom data. | ||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
| 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. |
Trappable Errors (SAMLSPServer Module)
SAMLSPServer Errors
| 1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
| 1048578 Class is configured incorrectly (SB_ERROR_INVALID_SETUP) | |
| 1048579 Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE) | |
| 1048580 Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE) | |
| 1048581 Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY) | |
| 1048581 Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) | |
| 30408705 Invalid binging name (SB_ERROR_SAML_INVALID_BINDING_NAME) | |
| 30408706 Invalid binding type (SB_ERROR_SAML_INVALID_BINDING_TYPE) | |
| 30408707 Base directory not set (SB_ERROR_SAML_SP_BASE_DIRECTORY_NOT_SET) |