SAMLSPServer Module
Properties Methods Events Config Settings Errors
The SAMLSPServer module represents a SAML service provider.
Syntax
SecureBlackbox.SAMLSPServer
Remarks
The Service Provider in the SAML exchange flow represents the web server that receives and accepts authentication assertions issued by the Identity Provider for single sign-on (SSO). Most commonly, an SP server is part of the application responsible for communicating with an Identity Provider to establish the authenticity of application users.
SAMLSPServer provides easy means of integrating the SAML Service Provider functionality into your application. It presents a fully-features SP endpoint with its own HTTP(S) and assertion validation engines.
Please find below a step-by-step guide on setting up your own SAML SP endpoint.
- Register the IdP metadata using the ImportSettings method.
Most IDPs let you download their metadata in XML format. The metadata file contains general
parameters of the IdP endpoint, such as its web address and algorithm requirements.
server.ImportSettings(metadataBytes, false); // contains "<?xml version="1.0"?><md:EntityDescriptor ID="ab12" ... </md:EntityDescriptor>";
- Configure the main server capabilities:
// public server endpoint (use "https://" and/or port 443 if required) server.URL = "http://sp.myapp.com"; server.Port = 80; // IdP triggers this URL to pull metadata server.MetadataURL = '/sp/metadata'; // ACS is th "main" SP endpoint that receives assertions from the IdP server.AssertionConsumerService = '/sp/AssertionConsumerService'; server.SPToIDPBinding = csbtRedirect; // the SP will use HTTP redirect to forward the browser to the IdP when required server.AssertionConsumerServiceBindings = 'POST'; // and we want the IdP to use POST to submit its assertions server.PreferredIDPToSPBinding = csbtPOST; // Single logout service setup server.SingleLogoutService = '/sp/SingleLogoutService'; server.SingleLogoutServiceBindings = 'Redirect,POST,Artifact'; server.LogoutPage = '/sp/logout'; server.RedirectOnLogoutPage = 'https://www.nsoftware.com'; // The document root of the server on the local system server.BaseDir = "D:\\Inetpub\\SAMLSP"; // Security parameters: indicating that we want to sign both // the metadata and the requests server.SignAuthnRequests = true; server.SignMetadata = true; // We need to attach certificates to be able to sign. // Assume we have loaded our signing certificate into // a CertificateManager object. server.SigningCertificate = mgr.Certificate; server.MetaSigningCertificate = mgr.Certificate;
- Personalize the server:
server.Config("OrganizationName=My Organization Ltd"); server.Config("OrganizationDisplayName=My Organization Pet Supplies"); server.Config("OrganizationURL=http://myorg.com"); server.Config("SigDigestMethod=http://www.w3.org/2001/04/xmlenc#sha256"); server.Config("SigMethod=http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"); server.Config("WantAssertionsSigned=true");
- Optionally, save metadata to an XML file. This will let you send/upload it to the IdP,
so they could set your SP up. Some IdPs can download the metadata right from your SP
using the MetadataURL that you've provided above, in which case saving it to a file
is not necessary.
server.SaveMetadata("my_metadata.xml");
server.Start();
The server should now be running on the local system, listening to incoming connections on the port that you
have specified above (80). Use your browser to check if the server is responding by navigating
to the metadata URL (http://127.0.0.1:80/sp/metadata). If the server has been set up right,
you should see something like this:
Now let us actually try to use the SAML functionality. Copy an arbitrary file - for example, a recent photo of your cat - to the directory you provided earlier via the BaseDir property (D:\Inetpub\SAMLSP). Having copied the file (suppose it is called clifford.jpg), try to access it in your browser by navigating to http://127.0.0.1:80/clifford.jpg.
This is where SAML kicks in. Since you are not authenticated for the SP server yet (we have just launched it, so no one is), the server redirects your browser to the IdP endpoint for authentication. The address of the IdP is taken from the their_metadata.xml file that you have loaded at the very beginning.
Note: you can configure which resources to restrict access to using the ProtectedResources property. If ProtectedResources is empty, the server considers all the files in BaseDir and its subfolders to be protected.
It is now the IdP services turn to authenticate you. Most IdPs on this stage will present you with a login form. Yet, if you have signed in recently, the IdP may still remember you, in which case it will skip the form and proceed directly to the next step. After establishing and proving your identity, the IdP will generate an assertion, a signed proof that effectively states that the IdP knows who you are and have verified your identity rigorously. Think of the assertion as your unique pass to the resources protected by the SP. The IdP will then submit that assertion back to the SP at its AssertionConsumerService endpoint, again using your browser.
Note that the SP service knows nothing about how IdP authenticates you. All the SP is interested in is an assertion.
If the assertion is well-formed and its signature is valid, the SAML exchange completes. At this point the SP accepts the assertion and creates a session for you. You can now access the resources protected by the SP for as long as the session lasts. If this step succeeds, you should see the photo of your cat in your browser.
Property List
The following is the full list of the properties of the module with short descriptions. Click on the links for further details.
Active | Tells whether the server is active and ready to process requests. |
BaseDir | Base directory on the server. |
BindingKey | Contains a private key to sign the redirect binding requests. |
DecryptionCertificate | The certificate to be used to decrypt assertions. |
ExternalCrypto | Provides access to external signing and DC parameters. |
FIPSMode | Reserved. |
HandshakeTimeout | Specifies the handshake timeout in milliseconds. |
Host | Specifies the host address of the SP server. |
IdPServices | Populates a list of services supported by the IdP. |
IdPSettings | Populates a list of SAML IdP entity settings. |
Issuer | Name identifier of the issuer of the SP's requests. |
KnownCertificates | Additional certificates for chain validation. |
LogoutPage | Specifies the location of the logout page. |
MetadataURL | The SP's metadata location. |
MetaSigningCertificate | Specifies the metadata signing certificate. |
OfflineMode | Enables the Offline mode. |
PinnedClient | Populates the pinned client details. |
PinnedClientChain | Contains the certificate chain of the pinned client. |
Port | Specifies the listening port number. |
ProtectedResources | Specifies the list of protected resources. |
RedirectOnLogoutPage | Specifies the location to redirect the user on logout. |
Security | Provides access to the SAML security properties. |
SenderChain | Contains the certificate chain of the message sender. |
SigningCertificate | The certificate for signing the SP requests. |
SigningChain | The signing certificate chain. |
SocketSettings | Manages network connection settings. |
SPServices | Populates a list of services supported by the SP. |
SPSettings | Populates a list of SAML SP entity settings. |
TLSServerChain | The server's TLS certificates. |
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.
AddIdPService | Registers an IdP service in the IdPServices list. |
AddSPService | Registers an SP service in the SPServices list. |
Config | This method 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 | Obtains a pending connection buffer. |
GetProviderProperty | Returns the value of a custom provider property. |
ImportSettings | Loads the metadata required for information exchange with the identity provider. Both local (SP-side) and remote (IdP-side) metadata can be loaded with this call. |
InitiateArtifactResolve | TBD. |
InitiateAttributeQuery | TBD. |
InitiateAuth | Starts SP-initiated SAML authentication flow. |
InitiateLogout | Starts SP-initiated SAML logout flow. |
ListClients | Enumerates the connected clients. |
PinClient | Takes a snapshot of the connection's properties. |
ProcessArtifactResolveRequest | Processes an artifact request received from the SP service at one of the ARS endpoints. |
ProcessAssertion | Processes assertion received from the IdP service at one of the ACS endpoints. |
ProcessGenericRequest | Processes a generic HTTP SAML request. |
ProcessLogoutRequest | Processes logout request received from the IdP service at one of the SLS endpoints. |
Reset | Resets the module settings. |
SetClientBuffer | Commits a data buffer to the connection. |
SetProviderProperty | Sets the value of a custom provider property. |
Start | Starts the SP server. |
Stop | Stops the IdP server. |
Event List
The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.
Accept | Reports an incoming connection. |
ArtifactResolveRequestPrepared | This event is fired when a new authentication request message has been prepared. |
ArtifactResolveRequestReceived | TBD. |
AssertionReceived | This event is fired when a new assertion has been received. |
AttributeQueryPrepared | This event is fired when a new attribute query message has been prepared. |
AuthnRequestPrepared | This event is fired when a new authentication request message has been prepared. |
Connect | Reports an accepted connection. |
Disconnect | Fires to report a disconnected client. |
Encrypted | Notifies the application that the assertion is encrypted and provides recipient certificate details. |
Error | Information about errors during data delivery. |
ExternalSign | Handles remote or external signing initiated by the server protocol. |
LogoutRequestPrepared | This event is fired when a new logout request has been prepared. |
LogoutRequestReceived | TBD. |
MetadataPrepared | Passes a prepared metadata object to the application. |
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. |
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. |
SAMLMessagePrepared | The server fires this event when it is ready to submit a SAML response body. |
SAMLMessageReceived | The server fires this event upon receiving a valid SAML message. |
SessionCreated | This event is fired when a new session has been established. |
SessionDestroyed | This event is fired when the SP server has closed a session. |
SessionEvent | Notifies the application about the change of SAML session stage. |
SessionInfoNeeded | This event is fired in OfflineMode to request the session ID for the current flow. |
SessionStateRetrieve | TBD. |
SessionStateSave | TBD. |
SignatureFound | Signifies the start of signature validation. |
SignatureValidated | Reports the signature validation result. |
TLSCertValidate | Fires when a client certificate needs to be validated. |
TLSEstablished | Reports the setup of a TLS session. |
TLSHandshake | Fires when a newly established client connection initiates a TLS handshake. |
TLSPSK | Requests a pre-shared key for TLS-PSK. |
TLSShutdown | Reports closure of a TLS session. |
Config Settings
The following is a list of config settings for the module with short descriptions. Click on the links for further details.
AllowOptionsResponseWithoutAuth | Enables unauthenticated responses to OPTIONS requests. |
AuthDigestExpire | Specifies digest expiration time for digest authentication. |
BoundPort | The port that was bound by the server. |
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. |
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. |
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. |
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. |
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. |
UseOwnDNSResolver | Specifies whether the client modules 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. |
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.
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.
BindingKey Property (SAMLSPServer Module)
Contains a private key to sign the redirect binding requests.
Syntax
public var bindingKey: CryptoKey { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=bindingKeyHandle,setter=setBindingKeyHandle:) long long bindingKeyHandle; - (long long)bindingKeyHandle; - (void)setBindingKeyHandle :(long long)newBindingKeyHandle; @property (nonatomic,readonly,assign,getter=bindingKeyKey) NSData* bindingKeyKey; - (NSData*)bindingKeyKey;
Default Value
""
Remarks
Use this property to set the signing key for the redirect binding object. This is used to sign the content of the redirect binding.
Note that when using the redirect binding, the outgoing SAML message must not be signed in parallel with a certificate. Any assertions may still be signed.
DecryptionCertificate Property (SAMLSPServer Module)
The certificate to be used to decrypt assertions.
Syntax
public var decryptionCertificate: Certificate { get {...} set {...} }
@property (nonatomic,readonly,assign,getter=decryptionCertBytes) NSData* decryptionCertBytes; - (NSData*)decryptionCertBytes; @property (nonatomic,readwrite,assign,getter=decryptionCertHandle,setter=setDecryptionCertHandle:) long long decryptionCertHandle; - (long long)decryptionCertHandle; - (void)setDecryptionCertHandle :(long long)newDecryptionCertHandle;
Default Value
""
Remarks
Use this property to provide the certificate to be used for decrypting assertions included in IdP (Identity Provider) responses. This certificate should have a private key associated with it.
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 tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on OnExternalSign event) and asynchronous (based on DC protocol and DCAuth signing component).
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.
HandshakeTimeout Property (SAMLSPServer Module)
Specifies the handshake timeout in milliseconds.
Syntax
public var handshakeTimeout: Int32 { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=handshakeTimeout,setter=setHandshakeTimeout:) int handshakeTimeout; - (int)handshakeTimeout; - (void)setHandshakeTimeout :(int)newHandshakeTimeout;
Default Value
20000
Remarks
Use this property to set the TLS handshake timeout.
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.
IdPServices Property (SAMLSPServer Module)
Populates a list of services supported by the IdP.
Syntax
public var idPServices: Array<SAMLServiceInfo> { get {...} }
@property (nonatomic,readonly,assign,getter=idPServiceCount) int idPServiceCount; - (int)idPServiceCount; - (int)idPServiceBindingType:(int)idPServiceIndex; - (NSString*)idPServiceEntityID:(int)idPServiceIndex; - (NSString*)idPServiceLocation:(int)idPServiceIndex; - (int)idPServicePriority:(int)idPServiceIndex; - (int)idPServiceService:(int)idPServiceIndex; - (int)idPServiceServiceIndex:(int)idPServiceIndex;
Default Value
""
Remarks
Use this property to access the list of services supported by the IdP. In the SAMLIdPServer, this is the list of services supported by the IdP. In the SAMLSPServer, this is the list of services advertised by the remote IdP server. These can be loaded from the respective IdP's metadata or set manually via AddIdPService method.
IdPSettings Property (SAMLSPServer Module)
Populates a list of SAML IdP entity settings.
Syntax
public var idPSettings: SAMLEntity { get {...} }
@property (nonatomic,readwrite,assign,getter=idPContactPerson,setter=setIdPContactPerson:) NSString* idPContactPerson; - (NSString*)idPContactPerson; - (void)setIdPContactPerson :(NSString*)newIdPContactPerson; @property (nonatomic,readwrite,assign,getter=idPEncryptionKey,setter=setIdPEncryptionKey:) NSData* idPEncryptionKey; - (NSData*)idPEncryptionKey; - (void)setIdPEncryptionKey :(NSData*)newIdPEncryptionKey; @property (nonatomic,readwrite,assign,getter=idPEncryptionMethods,setter=setIdPEncryptionMethods:) NSString* idPEncryptionMethods; - (NSString*)idPEncryptionMethods; - (void)setIdPEncryptionMethods :(NSString*)newIdPEncryptionMethods; @property (nonatomic,readwrite,assign,getter=idPEntityID,setter=setIdPEntityID:) NSString* idPEntityID; - (NSString*)idPEntityID; - (void)setIdPEntityID :(NSString*)newIdPEntityID; @property (nonatomic,readwrite,assign,getter=idPFlags,setter=setIdPFlags:) int idPFlags; - (int)idPFlags; - (void)setIdPFlags :(int)newIdPFlags; @property (nonatomic,readwrite,assign,getter=idPNameIDFormats,setter=setIdPNameIDFormats:) NSString* idPNameIDFormats; - (NSString*)idPNameIDFormats; - (void)setIdPNameIDFormats :(NSString*)newIdPNameIDFormats; @property (nonatomic,readwrite,assign,getter=idPOrganizationDisplayName,setter=setIdPOrganizationDisplayName:) NSString* idPOrganizationDisplayName; - (NSString*)idPOrganizationDisplayName; - (void)setIdPOrganizationDisplayName :(NSString*)newIdPOrganizationDisplayName; @property (nonatomic,readwrite,assign,getter=idPOrganizationLang,setter=setIdPOrganizationLang:) NSString* idPOrganizationLang; - (NSString*)idPOrganizationLang; - (void)setIdPOrganizationLang :(NSString*)newIdPOrganizationLang; @property (nonatomic,readwrite,assign,getter=idPOrganizationName,setter=setIdPOrganizationName:) NSString* idPOrganizationName; - (NSString*)idPOrganizationName; - (void)setIdPOrganizationName :(NSString*)newIdPOrganizationName; @property (nonatomic,readwrite,assign,getter=idPOrganizationURL,setter=setIdPOrganizationURL:) NSString* idPOrganizationURL; - (NSString*)idPOrganizationURL; - (void)setIdPOrganizationURL :(NSString*)newIdPOrganizationURL; @property (nonatomic,readonly,assign,getter=idPSignatureValidationResult) int idPSignatureValidationResult; - (int)idPSignatureValidationResult; @property (nonatomic,readonly,assign,getter=idPSigned) BOOL idPSigned; - (BOOL)idPSigned; @property (nonatomic,readonly,assign,getter=idPSignedWith) NSData* idPSignedWith; - (NSData*)idPSignedWith; @property (nonatomic,readwrite,assign,getter=idPSigningKey,setter=setIdPSigningKey:) NSData* idPSigningKey; - (NSData*)idPSigningKey; - (void)setIdPSigningKey :(NSData*)newIdPSigningKey; @property (nonatomic,readwrite,assign,getter=idPValidUntil,setter=setIdPValidUntil:) NSString* idPValidUntil; - (NSString*)idPValidUntil; - (void)setIdPValidUntil :(NSString*)newIdPValidUntil;
Default Value
""
Remarks
Use this property to get or set properties of a SAML IdP entity. These properties can be adjusted manually or loaded from the respective metadata file.
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.
KnownCertificates Property (SAMLSPServer Module)
Additional certificates for chain validation.
Syntax
public var knownCertificates: Array<Certificate> { get {...} }
@property (nonatomic,readwrite,assign,getter=knownCertCount,setter=setKnownCertCount:) int knownCertCount; - (int)knownCertCount; - (void)setKnownCertCount :(int)newKnownCertCount; - (NSData*)knownCertBytes:(int)knownCertIndex; - (long long)knownCertHandle:(int)knownCertIndex; - (void)setKnownCertHandle:(int)knownCertIndex :(long long)newKnownCertHandle;
Default Value
""
Remarks
Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually.
The purpose of certificates to be added to this collection is roughly equivalent to that of Intermediate Certification Authorities system store in Windows.
Do not add trust anchors or root certificates to this collection: add them to TrustedCertificates instead.
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 specify the certificate to be used to sign the SP's metadata. This certificate should have a private key associated with it.
OfflineMode Property (SAMLSPServer Module)
Enables the Offline mode.
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
True
Remarks
In the Offline mode the server does not open the listening port. Instead, it expects all incoming requests to be relayed by the application via calls to ProcessAssertion, ProcessLogoutRequest ProcessArtifactResolveRequest, and other similar methods.
The Offline mode is a handy mechanism for attaching the server to external web engines, such as IIS or Tomcat. It lets you leave the HTTP matters to the engine, and only be responsible for handling the actual SAML traffic.
PinnedClient Property (SAMLSPServer Module)
Populates the pinned client details.
Syntax
public var pinnedClient: TLSConnectionInfo { get {...} }
@property (nonatomic,readonly,assign,getter=pinnedClientAEADCipher) BOOL pinnedClientAEADCipher; - (BOOL)pinnedClientAEADCipher; @property (nonatomic,readonly,assign,getter=pinnedClientChainValidationDetails) int pinnedClientChainValidationDetails; - (int)pinnedClientChainValidationDetails; @property (nonatomic,readonly,assign,getter=pinnedClientChainValidationResult) int pinnedClientChainValidationResult; - (int)pinnedClientChainValidationResult; @property (nonatomic,readonly,assign,getter=pinnedClientCiphersuite) NSString* pinnedClientCiphersuite; - (NSString*)pinnedClientCiphersuite; @property (nonatomic,readonly,assign,getter=pinnedClientClientAuthenticated) BOOL pinnedClientClientAuthenticated; - (BOOL)pinnedClientClientAuthenticated; @property (nonatomic,readonly,assign,getter=pinnedClientClientAuthRequested) BOOL pinnedClientClientAuthRequested; - (BOOL)pinnedClientClientAuthRequested; @property (nonatomic,readonly,assign,getter=pinnedClientConnectionEstablished) BOOL pinnedClientConnectionEstablished; - (BOOL)pinnedClientConnectionEstablished; @property (nonatomic,readonly,assign,getter=pinnedClientConnectionID) NSData* pinnedClientConnectionID; - (NSData*)pinnedClientConnectionID; @property (nonatomic,readonly,assign,getter=pinnedClientDigestAlgorithm) NSString* pinnedClientDigestAlgorithm; - (NSString*)pinnedClientDigestAlgorithm; @property (nonatomic,readonly,assign,getter=pinnedClientEncryptionAlgorithm) NSString* pinnedClientEncryptionAlgorithm; - (NSString*)pinnedClientEncryptionAlgorithm; @property (nonatomic,readonly,assign,getter=pinnedClientExportable) BOOL pinnedClientExportable; - (BOOL)pinnedClientExportable; @property (nonatomic,readonly,assign,getter=pinnedClientID) long long pinnedClientID; - (long long)pinnedClientID; @property (nonatomic,readonly,assign,getter=pinnedClientKeyExchangeAlgorithm) NSString* pinnedClientKeyExchangeAlgorithm; - (NSString*)pinnedClientKeyExchangeAlgorithm; @property (nonatomic,readonly,assign,getter=pinnedClientKeyExchangeKeyBits) int pinnedClientKeyExchangeKeyBits; - (int)pinnedClientKeyExchangeKeyBits; @property (nonatomic,readonly,assign,getter=pinnedClientNamedECCurve) NSString* pinnedClientNamedECCurve; - (NSString*)pinnedClientNamedECCurve; @property (nonatomic,readonly,assign,getter=pinnedClientPFSCipher) BOOL pinnedClientPFSCipher; - (BOOL)pinnedClientPFSCipher; @property (nonatomic,readonly,assign,getter=pinnedClientPreSharedIdentity) NSString* pinnedClientPreSharedIdentity; - (NSString*)pinnedClientPreSharedIdentity; @property (nonatomic,readonly,assign,getter=pinnedClientPreSharedIdentityHint) NSString* pinnedClientPreSharedIdentityHint; - (NSString*)pinnedClientPreSharedIdentityHint; @property (nonatomic,readonly,assign,getter=pinnedClientPublicKeyBits) int pinnedClientPublicKeyBits; - (int)pinnedClientPublicKeyBits; @property (nonatomic,readonly,assign,getter=pinnedClientRemoteAddress) NSString* pinnedClientRemoteAddress; - (NSString*)pinnedClientRemoteAddress; @property (nonatomic,readonly,assign,getter=pinnedClientRemotePort) int pinnedClientRemotePort; - (int)pinnedClientRemotePort; @property (nonatomic,readonly,assign,getter=pinnedClientResumedSession) BOOL pinnedClientResumedSession; - (BOOL)pinnedClientResumedSession; @property (nonatomic,readonly,assign,getter=pinnedClientSecureConnection) BOOL pinnedClientSecureConnection; - (BOOL)pinnedClientSecureConnection; @property (nonatomic,readonly,assign,getter=pinnedClientServerAuthenticated) BOOL pinnedClientServerAuthenticated; - (BOOL)pinnedClientServerAuthenticated; @property (nonatomic,readonly,assign,getter=pinnedClientSignatureAlgorithm) NSString* pinnedClientSignatureAlgorithm; - (NSString*)pinnedClientSignatureAlgorithm; @property (nonatomic,readonly,assign,getter=pinnedClientSymmetricBlockSize) int pinnedClientSymmetricBlockSize; - (int)pinnedClientSymmetricBlockSize; @property (nonatomic,readonly,assign,getter=pinnedClientSymmetricKeyBits) int pinnedClientSymmetricKeyBits; - (int)pinnedClientSymmetricKeyBits; @property (nonatomic,readonly,assign,getter=pinnedClientTotalBytesReceived) long long pinnedClientTotalBytesReceived; - (long long)pinnedClientTotalBytesReceived; @property (nonatomic,readonly,assign,getter=pinnedClientTotalBytesSent) long long pinnedClientTotalBytesSent; - (long long)pinnedClientTotalBytesSent; @property (nonatomic,readonly,assign,getter=pinnedClientValidationLog) NSString* pinnedClientValidationLog; - (NSString*)pinnedClientValidationLog; @property (nonatomic,readonly,assign,getter=pinnedClientVersion) NSString* pinnedClientVersion; - (NSString*)pinnedClientVersion;
Default Value
""
Remarks
Use this property to access the details of the client connection previously pinned with PinClient method.
PinnedClientChain Property (SAMLSPServer Module)
Contains the certificate chain of the pinned client.
Syntax
public var pinnedClientChain: Array<Certificate> { get {...} }
@property (nonatomic,readonly,assign,getter=pinnedClientCertCount) int pinnedClientCertCount; - (int)pinnedClientCertCount; - (NSData*)pinnedClientCertBytes:(int)pinnedClientCertIndex; - (NSData*)pinnedClientCertCAKeyID:(int)pinnedClientCertIndex; - (NSData*)pinnedClientCertFingerprint:(int)pinnedClientCertIndex; - (long long)pinnedClientCertHandle:(int)pinnedClientCertIndex; - (NSString*)pinnedClientCertIssuer:(int)pinnedClientCertIndex; - (NSString*)pinnedClientCertIssuerRDN:(int)pinnedClientCertIndex; - (NSString*)pinnedClientCertKeyAlgorithm:(int)pinnedClientCertIndex; - (int)pinnedClientCertKeyBits:(int)pinnedClientCertIndex; - (NSData*)pinnedClientCertKeyFingerprint:(int)pinnedClientCertIndex; - (int)pinnedClientCertKeyUsage:(int)pinnedClientCertIndex; - (NSData*)pinnedClientCertPublicKeyBytes:(int)pinnedClientCertIndex; - (BOOL)pinnedClientCertSelfSigned:(int)pinnedClientCertIndex; - (NSData*)pinnedClientCertSerialNumber:(int)pinnedClientCertIndex; - (NSString*)pinnedClientCertSigAlgorithm:(int)pinnedClientCertIndex; - (NSString*)pinnedClientCertSubject:(int)pinnedClientCertIndex; - (NSData*)pinnedClientCertSubjectKeyID:(int)pinnedClientCertIndex; - (NSString*)pinnedClientCertSubjectRDN:(int)pinnedClientCertIndex; - (NSString*)pinnedClientCertValidFrom:(int)pinnedClientCertIndex; - (NSString*)pinnedClientCertValidTo:(int)pinnedClientCertIndex;
Default Value
""
Remarks
Use this property to access the certificate chain of the client connection pinned previously with a PinClient call.
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.
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://nsoftware.com"
Remarks
Use this property to specify the page where to redirect the user on logout.
Security Property (SAMLSPServer Module)
Provides access to the SAML security properties.
Syntax
public var security: SAMLSecuritySettings { get {...} }
@property (nonatomic,readwrite,assign,getter=securityCanonicalizationMethod,setter=setSecurityCanonicalizationMethod:) NSString* securityCanonicalizationMethod; - (NSString*)securityCanonicalizationMethod; - (void)setSecurityCanonicalizationMethod :(NSString*)newSecurityCanonicalizationMethod; @property (nonatomic,readwrite,assign,getter=securityDigestMethod,setter=setSecurityDigestMethod:) NSString* securityDigestMethod; - (NSString*)securityDigestMethod; - (void)setSecurityDigestMethod :(NSString*)newSecurityDigestMethod; @property (nonatomic,readwrite,assign,getter=securityEncryptionMethod,setter=setSecurityEncryptionMethod:) NSString* securityEncryptionMethod; - (NSString*)securityEncryptionMethod; - (void)setSecurityEncryptionMethod :(NSString*)newSecurityEncryptionMethod; @property (nonatomic,readwrite,assign,getter=securityFlags,setter=setSecurityFlags:) int securityFlags; - (int)securityFlags; - (void)setSecurityFlags :(int)newSecurityFlags; @property (nonatomic,readwrite,assign,getter=securitySigMethod,setter=setSecuritySigMethod:) NSString* securitySigMethod; - (NSString*)securitySigMethod; - (void)setSecuritySigMethod :(NSString*)newSecuritySigMethod; @property (nonatomic,readwrite,assign,getter=securitySignaturePolicy,setter=setSecuritySignaturePolicy:) int securitySignaturePolicy; - (int)securitySignaturePolicy; - (void)setSecuritySignaturePolicy :(int)newSecuritySignaturePolicy;
Default Value
""
Remarks
Use this property to access the security parameters of the server.
SenderChain Property (SAMLSPServer Module)
Contains the certificate chain of the message sender.
Syntax
public var senderChain: Array<Certificate> { get {...} }
@property (nonatomic,readonly,assign,getter=senderCertCount) int senderCertCount; - (int)senderCertCount; - (NSData*)senderChainBytes:(int)senderCertIndex; - (long long)senderChainHandle:(int)senderCertIndex;
Default Value
""
Remarks
Use this property to access the certificate chain of the creator of the signed message or entity that is currently being processed. This property is only available from SignatureFound and SignatureValidated events.
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 designate a certificate for signing the SP requests. The provided certificate must have a private key associated with it.
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 provide the chain for the signing certificate. Use SigningCertificate property, if it is available, to provide the signing certificate itself.
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 tune up network connection parameters.
SPServices Property (SAMLSPServer Module)
Populates a list of services supported by the SP.
Syntax
public var spServices: Array<SAMLServiceInfo> { get {...} }
@property (nonatomic,readonly,assign,getter=SPServiceCount) int SPServiceCount; - (int)SPServiceCount; - (int)SPServiceBindingType:(int)sPServiceIndex; - (NSString*)SPServiceEntityID:(int)sPServiceIndex; - (NSString*)SPServiceLocation:(int)sPServiceIndex; - (int)SPServicePriority:(int)sPServiceIndex; - (int)SPServiceService:(int)sPServiceIndex; - (int)SPServiceServiceIndex:(int)sPServiceIndex;
Default Value
""
Remarks
Use this property to access the list of services supported by the SP. In the SAMLSPServer, this is the list of services supported by the SP. In the SAMLIdPServer, this is the list of services advertised by the remote SP server. These can be loaded from the respective SP's metadata or set manually via AddSPService method.
SPSettings Property (SAMLSPServer Module)
Populates a list of SAML SP entity settings.
Syntax
public var spSettings: SAMLEntity { get {...} }
@property (nonatomic,readwrite,assign,getter=SPContactPerson,setter=setSPContactPerson:) NSString* SPContactPerson; - (NSString*)SPContactPerson; - (void)setSPContactPerson :(NSString*)newSPContactPerson; @property (nonatomic,readwrite,assign,getter=SPEncryptionKey,setter=setSPEncryptionKey:) NSData* SPEncryptionKey; - (NSData*)SPEncryptionKey; - (void)setSPEncryptionKey :(NSData*)newSPEncryptionKey; @property (nonatomic,readwrite,assign,getter=SPEncryptionMethods,setter=setSPEncryptionMethods:) NSString* SPEncryptionMethods; - (NSString*)SPEncryptionMethods; - (void)setSPEncryptionMethods :(NSString*)newSPEncryptionMethods; @property (nonatomic,readwrite,assign,getter=SPEntityID,setter=setSPEntityID:) NSString* SPEntityID; - (NSString*)SPEntityID; - (void)setSPEntityID :(NSString*)newSPEntityID; @property (nonatomic,readwrite,assign,getter=SPFlags,setter=setSPFlags:) int SPFlags; - (int)SPFlags; - (void)setSPFlags :(int)newSPFlags; @property (nonatomic,readwrite,assign,getter=SPNameIDFormats,setter=setSPNameIDFormats:) NSString* SPNameIDFormats; - (NSString*)SPNameIDFormats; - (void)setSPNameIDFormats :(NSString*)newSPNameIDFormats; @property (nonatomic,readwrite,assign,getter=SPOrganizationDisplayName,setter=setSPOrganizationDisplayName:) NSString* SPOrganizationDisplayName; - (NSString*)SPOrganizationDisplayName; - (void)setSPOrganizationDisplayName :(NSString*)newSPOrganizationDisplayName; @property (nonatomic,readwrite,assign,getter=SPOrganizationLang,setter=setSPOrganizationLang:) NSString* SPOrganizationLang; - (NSString*)SPOrganizationLang; - (void)setSPOrganizationLang :(NSString*)newSPOrganizationLang; @property (nonatomic,readwrite,assign,getter=SPOrganizationName,setter=setSPOrganizationName:) NSString* SPOrganizationName; - (NSString*)SPOrganizationName; - (void)setSPOrganizationName :(NSString*)newSPOrganizationName; @property (nonatomic,readwrite,assign,getter=SPOrganizationURL,setter=setSPOrganizationURL:) NSString* SPOrganizationURL; - (NSString*)SPOrganizationURL; - (void)setSPOrganizationURL :(NSString*)newSPOrganizationURL; @property (nonatomic,readonly,assign,getter=SPSignatureValidationResult) int SPSignatureValidationResult; - (int)SPSignatureValidationResult; @property (nonatomic,readonly,assign,getter=SPSigned) BOOL SPSigned; - (BOOL)SPSigned; @property (nonatomic,readonly,assign,getter=SPSignedWith) NSData* SPSignedWith; - (NSData*)SPSignedWith; @property (nonatomic,readwrite,assign,getter=SPSigningKey,setter=setSPSigningKey:) NSData* SPSigningKey; - (NSData*)SPSigningKey; - (void)setSPSigningKey :(NSData*)newSPSigningKey; @property (nonatomic,readwrite,assign,getter=SPValidUntil,setter=setSPValidUntil:) NSString* SPValidUntil; - (NSString*)SPValidUntil; - (void)setSPValidUntil :(NSString*)newSPValidUntil;
Default Value
""
Remarks
Use this property to get or set properties of a SAML SP entity. These properties can be adjusted manually or loaded from the respective metadata file.
TLSServerChain Property (SAMLSPServer Module)
The server's TLS certificates.
Syntax
public var tlsServerChain: Array<Certificate> { get {...} }
@property (nonatomic,readwrite,assign,getter=TLSServerCertCount,setter=setTLSServerCertCount:) int TLSServerCertCount; - (int)TLSServerCertCount; - (void)setTLSServerCertCount :(int)newTLSServerCertCount; - (NSData*)TLSServerCertBytes:(int)tLSServerCertIndex; - (long long)TLSServerCertHandle:(int)tLSServerCertIndex; - (void)setTLSServerCertHandle:(int)tLSServerCertIndex :(long long)newTLSServerCertHandle;
Default Value
""
Remarks
Use this property to provide a list of TLS certificates for the server endpoint.
A TLS endpoint needs a certificate to be able to accept TLS connections. At least one of the certificates in the collection - the endpoint certificate - must have a private key associated with it.
The collection may include more than one endpoint certificate, and more than one chain. A typical usage scenario is to include two chains (ECDSA and RSA), to cater for clients with different cipher suite preferences.
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=TLSClientAuth,setter=setTLSClientAuth:) int TLSClientAuth; - (int)TLSClientAuth; - (void)setTLSClientAuth :(int)newTLSClientAuth; @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 tune up the TLS layer parameters.
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.
Please make sure the URL you provide here aligns well with the relative endpoint resource paths, such as AssertionConsumerService or ArtifactResolutionService. The two parts (the URL and the endpoint paths) are concatenated to produce full endpoint URLs. Please double check that only one of the parts includes the slash character in it: either the endpoint paths at the beginning (the default configuration), or the base URL at the end.
AddIdPService Method (SAMLSPServer Module)
Registers an IdP service in the IdPServices list.
Syntax
public func addIdPService(service: Int32, bindingType: Int32, location: String, priority: Int32, index: Int32) throws -> Void
- (void)addIdPService:(int)service :(int)bindingType :(NSString*)location :(int)priority :(int)index;
Remarks
Use this method to add an entry to the list of services and their locations provided by the IdP. TBD
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) |
AddSPService Method (SAMLSPServer Module)
Registers an SP service in the SPServices list.
Syntax
public func addSPService(service: Int32, bindingType: Int32, location: String, priority: Int32, index: Int32) throws -> Void
- (void)addSPService:(int)service :(int)bindingType :(NSString*)location :(int)priority :(int)index;
Remarks
Use this method to add an entry to the list of services and their locations provided by the SP. TBD
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) |
Config Method (SAMLSPServer Module)
This method 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 (case insencitive) 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;....
DropClient Method (SAMLSPServer Module)
Terminates a client connection.
Syntax
- (void)dropClient:(long long)connectionId :(BOOL)forced;
Remarks
Call this method to shut down a connected client. Forced indicates whether the connection should be closed in a graceful manner.
ExportSettings Method (SAMLSPServer Module)
Saves the SP or IdP configuration to an XML metadata file.
Syntax
Remarks
Use this method to save the Service Provider (SP) or Identity Provider (IdP) configuration in the form of XML metadata. The SP metadata file may then be transferred to identity providers (IdP) to let them know about the SP configuration.
Adjust the provider configuration as required in SPSettings or IdPSettings object before calling this method. Assign MetaSigningCertificate to enforce signing of the metadata XML.
GetClientBuffer Method (SAMLSPServer Module)
Obtains a pending connection buffer.
Syntax
- (NSData*)getClientBuffer:(long long)connectionID;
Remarks
Use this method to obtain a pending connection buffer from your WriteFile event handler. The connection buffer contains data that have been received from the client but has not been written to the file yet.
GetProviderProperty Method (SAMLSPServer Module)
Returns the value of a custom provider property.
Syntax
- (NSString*)getProviderProperty:(NSString*)name;
Remarks
This method, together with SetProviderProperty, provides an extensible way of managing the Service Provider's settings that are not available through the primary properties of the component. As SAML usage scenarios evolve and new providers appear, the list of supported properties can be extended.
The following properties are currently supported:
- ContactPerson
- OrganizationName
- OrganizationDisplayName
- OrganizationURL
- OrganizationLang
ImportSettings Method (SAMLSPServer Module)
Loads the metadata required for information exchange with the identity provider. Both local (SP-side) and remote (IdP-side) metadata can be loaded with this call.
Syntax
- (void)importSettings:(NSString*)metadata :(BOOL)SP;
Remarks
The Identity provider (IdP) may have different options and requirements for interactions with the Service Provider (SP). Usually all these options together with X.509 certificates needed for data exchange are stored in XML metadata files. Use this method to load metadata from a file generated by an IdP.
The Metadata parameter contains metadata in the form of byte array. Set SP parameter to true to indicate that it is the Service Provider's own settings that are being loaded.
The loaded metadata is populated in the SPSettings or IdPSettings object (depending on the value of the SP parameter).
InitiateArtifactResolve Method (SAMLSPServer Module)
TBD.
Syntax
public func initiateArtifactResolve(connectionID: Int64, sessionID: String, idPServiceIndex: Int32, artifact: String) throws -> Int32
- (int)initiateArtifactResolve:(long long)connectionID :(NSString*)sessionID :(int)idPServiceIndex :(NSString*)artifact;
Remarks
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprLoginForm | 2 | The result contains a SAML login form |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode.
InitiateAttributeQuery Method (SAMLSPServer Module)
TBD.
Syntax
public func initiateAttributeQuery(connectionID: Int64, sessionID: String, idPServiceIndex: Int32, attributes: String) throws -> Int32
- (int)initiateAttributeQuery:(long long)connectionID :(NSString*)sessionID :(int)idPServiceIndex :(NSString*)attributes;
Remarks
TBD: we may need another event (some "ClarifyAttributes") to request more details about attributes.
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprLoginForm | 2 | The result contains a SAML login form |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode.
InitiateAuth Method (SAMLSPServer Module)
Starts SP-initiated SAML authentication flow.
Syntax
public func initiateAuth(connectionID: Int64, sessionID: String, idPServiceIndex: Int32, relayState: String) throws -> Int32
- (int)initiateAuth:(long long)connectionID :(NSString*)sessionID :(int)idPServiceIndex :(NSString*)relayState;
Remarks
Use this method to initiate SAML authentication flow on the SP side. Pass the index of the single sign-on service that you want to use to the IdPServiceIndex parameter. Leave it empty to let the component pick up the best one automatically. Use RelayState to pass the callback URL to the IdP service. This will be mirrored back by the IDP in its response.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprLoginForm | 2 | The result contains a SAML login form |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode.
InitiateLogout Method (SAMLSPServer Module)
Starts SP-initiated SAML logout flow.
Syntax
public func initiateLogout(connectionID: Int64, sessionID: String, idPServiceIndex: Int32, relayState: String) throws -> Int32
- (int)initiateLogout:(long long)connectionID :(NSString*)sessionID :(int)idPServiceIndex :(NSString*)relayState;
Remarks
Use this method to initiate SAML logout flow on the SP side. Pass the index of the single logout service that you want to use to the IdPServiceIndex parameter.
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 |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprLoginForm | 2 | The result contains a SAML login form |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode. TBD
ListClients Method (SAMLSPServer Module)
Enumerates the connected clients.
Syntax
public func listClients() throws -> String
- (NSString*)listClients;
Remarks
This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection.
PinClient Method (SAMLSPServer Module)
Takes a snapshot of the connection's properties.
Syntax
- (void)pinClient:(long long)connectionId;
Remarks
Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient and PinnedClientChain properties.
ProcessArtifactResolveRequest Method (SAMLSPServer Module)
Processes an artifact request received from the SP service at one of the ARS endpoints.
Syntax
public func processArtifactResolveRequest(connectionID: Int64, sessionID: String, request: String) throws -> Int32
- (int)processArtifactResolveRequest:(long long)connectionID :(NSString*)sessionID :(NSString*)request;
Remarks
Use this method to pass a SAML artifact request received at one of the ArtifactResolutionService endpoints.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprLoginForm | 2 | The result contains a SAML login form |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode.
ProcessAssertion Method (SAMLSPServer Module)
Processes assertion received from the IdP service at one of the ACS endpoints.
Syntax
public func processAssertion(connectionID: Int64, sessionID: String, request: String) throws -> Int32
- (int)processAssertion:(long long)connectionID :(NSString*)sessionID :(NSString*)request;
Remarks
Use this method to pass a SAML assertion received at one of the AssertionConsumerService endpoints.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprLoginForm | 2 | The result contains a SAML login form |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode.
ProcessGenericRequest Method (SAMLSPServer Module)
Processes a generic HTTP SAML request.
Syntax
public func processGenericRequest(connectionID: Int64, sessionID: String, url: String, request: String) throws -> Int32
- (int)processGenericRequest:(long long)connectionID :(NSString*)sessionID :(NSString*)URL :(NSString*)request;
Remarks
Use this method to process a generic well-formed HTTP SAML request obtained elsewhere. This is a handy mechanism to bind the SAML processor to an external web engine.
The Request parameter is expected to contain a full HTTP request, including the HTTP method string (GET, POST) and all the headers. The generated response contains a full HTTP response that should be supplied back to the requestor. You can edit some parts of the response (for example, by adding some custom HTTP headers).
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 |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprLoginForm | 2 | The result contains a SAML login form |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode.
ProcessLogoutRequest Method (SAMLSPServer Module)
Processes logout request received from the IdP service at one of the SLS endpoints.
Syntax
public func processLogoutRequest(connectionID: Int64, sessionID: String, request: String) throws -> Int32
- (int)processLogoutRequest:(long long)connectionID :(NSString*)sessionID :(NSString*)request;
Remarks
Use this method to pass a SAML logout request received at one of the SingleLogoutService endpoints.
An SLS endpoint may receive requests of two kinds: LogoutRequest and LogoutResponse. If Request contains a LogoutRequest, the content generated by this method will contain a corresponding LogoutResponse. If Request contains a LogoutResponse, the generated content is empty.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprLoginForm | 2 | The result contains a SAML login form |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode.
Reset Method (SAMLSPServer Module)
Resets the component settings.
Syntax
public func reset() throws -> Void
- (void)reset;
Remarks
Reset is a generic method available in every class.
SetClientBuffer Method (SAMLSPServer Module)
Commits a data buffer to the connection.
Syntax
- (void)setClientBuffer:(long long)connectionID :(NSData*)value;
Remarks
Use this method from your ReadFile event handler to commit a chunk of file data to the server component.
SetProviderProperty Method (SAMLSPServer Module)
Sets the value of a custom provider property.
Syntax
- (void)setProviderProperty:(NSString*)name :(NSString*)value;
Remarks
This method, together with GetProviderProperty, provides an extensible way of managing the Service Provider's settings that are not available through the primary properties of the component. As SAML usage scenarios evolve and new providers appear, the list of supported properties can be extended.
The following properties are currently supported:
- ContactPerson
- OrganizationName
- OrganizationDisplayName
- OrganizationURL
- OrganizationLang
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.
ArtifactResolveRequestPrepared Event (SAMLSPServer Module)
This event is fired when a new authentication request message has been prepared.
Syntax
func onArtifactResolveRequestPrepared(connectionID: Int64, sessionID: String, requestID: String, artifact: String)
- (void)onArtifactResolveRequestPrepared:(long long)connectionID :(NSString*)sessionID :(NSString*)requestID :(NSString*)artifact;
Remarks
TBD
ArtifactResolveRequestReceived Event (SAMLSPServer Module)
TBD.
Syntax
func onArtifactResolveRequestReceived(connectionID: Int64, sessionID: String, requestID: String, isEncrypted: Bool, isSigned: Bool, artifact: String, action: inout Int32)
- (void)onArtifactResolveRequestReceived:(long long)connectionID :(NSString*)sessionID :(NSString*)requestID :(BOOL)isEncrypted :(BOOL)isSigned :(NSString*)artifact :(int*)action;
Remarks
AssertionReceived Event (SAMLSPServer Module)
This event is fired when a new assertion has been received.
Syntax
func onAssertionReceived(connectionID: Int64, sessionID: String, requestID: String, isEncrypted: Bool, isSigned: Bool, nameID: String, sessionIndex: String, action: inout Int32)
- (void)onAssertionReceived:(long long)connectionID :(NSString*)sessionID :(NSString*)requestID :(BOOL)isEncrypted :(BOOL)isSigned :(NSString*)nameID :(NSString*)sessionIndex :(int*)action;
Remarks
The AssertionReceived event notifies the application that an assertion has been received at the ACS endpoint. In OfflineMode this event may fire in response to a ProcessAssertion call. In online mode it can fire at any time while the server is active.
The ConnectionID and SessionID specify the IDs of the current client connection and HTTP session. The RequestID contains the ID of the original AuthnRequest message, if it was sent by the service provider. The IsEncrypted and IsSigned parameters indicate the security properties of the assertion. The NameID parameter contains the unique name identifier of the authenticated principal, and the SessionIndex contains the SAML session identifier. In rare cases SessionIndex may contain multiple indices, if the SP has more than one session at the IdP.
AttributeQueryPrepared Event (SAMLSPServer Module)
This event is fired when a new attribute query message has been prepared.
Syntax
func onAttributeQueryPrepared(connectionID: Int64, sessionID: String, requestID: String, attributes: String)
- (void)onAttributeQueryPrepared:(long long)connectionID :(NSString*)sessionID :(NSString*)requestID :(NSString*)attributes;
Remarks
TBD
AuthnRequestPrepared Event (SAMLSPServer Module)
This event is fired when a new authentication request message has been prepared.
Syntax
func onAuthnRequestPrepared(connectionID: Int64, sessionID: String, requestID: String, forceAuthn: Bool, nonInteractive: Bool)
- (void)onAuthnRequestPrepared:(long long)connectionID :(NSString*)sessionID :(NSString*)requestID :(BOOL)forceAuthn :(BOOL)nonInteractive;
Remarks
TBD
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.
Encrypted Event (SAMLSPServer Module)
Notifies the application that the assertion is encrypted and provides recipient certificate details.
Syntax
func onEncrypted(connectionID: Int64, sessionID: String, requestID: String, issuerRDN: String, serialNumber: Data, subjectKeyID: Data, needCredential: Bool, skipThis: inout Bool)
- (void)onEncrypted:(long long)connectionID :(NSString*)sessionID :(NSString*)requestID :(NSString*)issuerRDN :(NSData*)serialNumber :(NSData*)subjectKeyID :(BOOL)needCredential :(int*)skipThis;
Remarks
The class fires this event when processing encrypted documents to report the fact of encryption and pass certificate parameters to the user.
This event fires repeatedly for each encryption mechanism used in the document until the user provides the correct credential via the DecryptionCertificate property (depending on encryption method used), or sets SkipThis to true.
The IssuerRDN, SerialNumber, and SubjectKeyID parameters provide the details of the encryption certificate. Note that the document can be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate will invoke its own OnEncrypted event loop.
The NeedCredential parameter specifies whether the correct credential is already available to the class or still needs to be set. One example where NeedCredential would be set to false is where it had been provided by the application prior to processing the document (e.g. by setting the DecryptionCertificate property to a known pre-defined value). If NeedCredential is set to true, you must provide the valid credential for the decryption process to succeed.
Error Event (SAMLSPServer Module)
Information about errors during data delivery.
Syntax
func onError(connectionID: Int64, sessionID: String, errorCode: Int32, fatal: Bool, remote: Bool, description: String)
- (void)onError:(long long)connectionID :(NSString*)sessionID :(int)errorCode :(BOOL)fatal :(BOOL)remote :(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
A sample event handler that uses a .NET RSACryptoServiceProvider class may look like the following:
signer.OnExternalSign += (s, e) =>
{
var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable);
var key = (RSACryptoServiceProvider)cert.PrivateKey;
var dataToSign = e.Data.FromBase16String();
var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1");
e.SignedData = signedData.ToBase16String();
};
LogoutRequestPrepared Event (SAMLSPServer Module)
This event is fired when a new logout request has been prepared.
Syntax
func onLogoutRequestPrepared(connectionID: Int64, sessionID: String, requestID: String, nameID: String)
- (void)onLogoutRequestPrepared:(long long)connectionID :(NSString*)sessionID :(NSString*)requestID :(NSString*)nameID;
Remarks
TBD
LogoutRequestReceived Event (SAMLSPServer Module)
TBD.
Syntax
func onLogoutRequestReceived(connectionID: Int64, sessionID: String, requestID: String, isEncrypted: Bool, isSigned: Bool, nameID: String, action: inout Int32)
- (void)onLogoutRequestReceived:(long long)connectionID :(NSString*)sessionID :(NSString*)requestID :(BOOL)isEncrypted :(BOOL)isSigned :(NSString*)nameID :(int*)action;
Remarks
MetadataPrepared Event (SAMLSPServer Module)
Passes a prepared metadata object to the application.
Syntax
func onMetadataPrepared(connectionID: Int64, metadata: inout String)
- (void)onMetadataPrepared:(long long)connectionID :(NSString**)metadata;
Remarks
The class uses this event to notify the application about the prepared metadata object and let the user code adjust it if needed. This event may fire from within an ExportSettings call, or in response to the incoming metadata request if the server is operating in standalone mode.
The suggested metadata object is provided through the Metadata parameter. The application can adjust it as required if it needs to.
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.
ProcessingCompleted Event (SAMLSPServer Module)
This event notifies the application of the completion of request or response processing.
Syntax
func onProcessingCompleted(connectionID: Int64, sessionID: String, processingResult: Int32, response: String, redirect: Bool)
- (void)onProcessingCompleted:(long long)connectionID :(NSString*)sessionID :(int)processingResult :(NSString*)response :(BOOL)redirect;
Remarks
The component fires ProcessingCompleted to notify the application about completion of an earlier initiated processing operation. It is only fired in OfflineMode in response to calls such as ProcessAssertion, ProcessLogoutRequest, or similar. The main purpose of this event is to notify the application of the outcomes of the processing and return any prepared SAML entity for subsequent relay to the browser.
This event is fired strictly once for each Process* call, with the ConnectionID matching the value passed to the Process* method.
The SessionID parameter contains the identifier of the current virtual session. It may differ to the value passed to the Process* method if the session information was provided on the fly via the SessionInfoNeeded event. The ProcessingResult indicates the type of deliverable that was created during the processing (see below for possible values). The Response parameter contains the body of the deliverable. This can take one of the forms:
- a self-submitting form containing a SAML message.
- a redirect URL.
- a SOAP XML response.
- an empty string if ProcessingResult is set to sprSuccess.
The Redirect parameter indicates whether the value of Response should be passed to the browser within the 302 Location header, or as a document body.
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprLoginForm | 2 | The result contains a SAML login form |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
ResourceClose Event (SAMLSPServer Module)
Tells the application that it can close the opened resource.
Syntax
- (void)onResourceClose:(long long)connectionID :(NSString*)sessionID;
Remarks
The class uses this event to notify the application that it can now close the resource opened earlier in its ResourceOpen handler.
After closing the resource, set the OperationStatus according to the outcome of the operation.
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
ResourceOpen Event (SAMLSPServer Module)
Requests the application to open the requested resource.
Syntax
func onResourceOpen(connectionID: Int64, sessionID: String, url: String, operationStatus: inout Int32)
- (void)onResourceOpen:(long long)connectionID :(NSString*)sessionID :(NSString*)URL :(int*)operationStatus;
Remarks
The class fires this event in virtualized mode if the application had returned the fraCustom modifier from the earlier ResourceRequest event call. Your code is expected to open the requested resource and be prepared to read from it in subsequent ResourceRead event calls. Check the operation status, and alter it, if needed, through the OperationStatus parameter:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
ResourceRead Event (SAMLSPServer Module)
Requests the application to read from an opened resource.
Syntax
func onResourceRead(connectionID: Int64, sessionID: String, size: Int32, operationStatus: inout Int32)
- (void)onResourceRead:(long long)connectionID :(NSString*)sessionID :(int)size :(int*)operationStatus;
Remarks
The class fires this event in virtualized mode to request another chunk of data from the resource opened earlier. The handler of this event should read up to Size bytes from the object, and pass them to the component with a SetClientBuffer call.
Use the OperationStatus parameter to return the operation result back to the server. When the file has been read up to its end, set OperationStatus to ostEOF to tell the components that no more ResourceRead calls are needed.
Set OperationStatus to one of the following values:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
ResourceRequest Event (SAMLSPServer Module)
Notifies the application that a server resource is requested.
Syntax
func onResourceRequest(connectionID: Int64, sessionID: String, url: String, httpMethod: String, resProtected: inout Bool, resSpecial: inout Bool, action: inout Int32)
- (void)onResourceRequest:(long long)connectionID :(NSString*)sessionID :(NSString*)URL :(NSString*)httpMethod :(int*)resProtected :(int*)resSpecial :(int*)action;
Remarks
The class uses this event to notify the application that the connection has requested a server resource.
The URL parameter specifies the resource requested. ResProtected is set to true if the resource is protected by SAML. ResSpecial is set to true if the request is a SAML resource, such as the metadata or an Assertion Consumer Service page. ConnectionID identifies the connected client.
Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code ('virtualize' the request).
Choose Action as one of the following values:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
SAMLMessagePrepared Event (SAMLSPServer Module)
The server fires this event when it is ready to submit a SAML response body.
Syntax
func onSAMLMessagePrepared(connectionID: Int64, sessionID: String, inResponseTo: String, requestBody: String, messageType: String, messageBody: inout String, success: inout Bool)
- (void)onSAMLMessagePrepared:(long long)connectionID :(NSString*)sessionID :(NSString*)inResponseTo :(NSString*)requestBody :(NSString*)messageType :(NSString**)messageBody :(int*)success;
Remarks
Subscribe to this event to be notified about authentication requests being received. The component can fire this event from ProcessSignOnRequest and ProcessGenericRequest calls in OfflineMode, or asynchronously in online mode.
Set Action property in accordance with desired handling option. TBD TODO: we may need to include the Destination parameter
SAMLMessageReceived Event (SAMLSPServer Module)
The server fires this event upon receiving a valid SAML message.
Syntax
func onSAMLMessageReceived(connectionID: Int64, sessionID: String, messageType: String, messageID: String, issuer: String, issueInstant: String, messageBody: String, relayState: String, action: inout Int32)
- (void)onSAMLMessageReceived:(long long)connectionID :(NSString*)sessionID :(NSString*)messageType :(NSString*)messageID :(NSString*)issuer :(NSString*)issueInstant :(NSString*)messageBody :(NSString*)relayState :(int*)action;
Remarks
Subscribe to this event to be notified about SAML messages received. The component can fire this event from ProcessAssertion and ProcessGenericRequest calls in OfflineMode, or asynchronously in online mode.
Set Action property in accordance with desired handling option. TBD
SessionCreated Event (SAMLSPServer Module)
This event is fired when a new session has been established.
Syntax
- (void)onSessionCreated:(long long)connectionID :(NSString*)sessionID;
Remarks
ConnectionID contains the identifier of the new session, SessionID specifies the ID of the new session.
SessionDestroyed Event (SAMLSPServer Module)
This event is fired when the SP server has closed a session.
Syntax
- (void)onSessionDestroyed:(long long)connectionID :(NSString*)sessionID;
Remarks
ConnectionID contains the identifier of the closed session.
SessionEvent Event (SAMLSPServer Module)
Notifies the application about the change of SAML session stage.
Syntax
- (void)onSessionEvent:(long long)connectionID :(NSString*)sessionID :(NSString*)eventText;
Remarks
class uses this method to notify your code about changed SAML session stage. The Session parameter specifies the session ID. The Stage parameter can take one of the following values:
- Start
- AuthnRequestSent
- ResponseReceived
- ResourceSupplied
- LogoutRequestSent
- LogoutResponseReceived
- LogoutRequestRecv
- LogoutResponseSent
- ArtifactResolveRecv
- ArtifactResponseSent
- Finish
SessionInfoNeeded Event (SAMLSPServer Module)
This event is fired in OfflineMode to request the session ID for the current flow.
Syntax
func onSessionInfoNeeded(connectionID: Int64, sessionID: inout String)
- (void)onSessionInfoNeeded:(long long)connectionID :(NSString**)sessionID;
Remarks
TBD
SessionStateRetrieve Event (SAMLSPServer Module)
TBD.
Syntax
func onSessionStateRetrieve(connectionID: Int64, sessionID: String, sessionState: inout String)
- (void)onSessionStateRetrieve:(long long)connectionID :(NSString*)sessionID :(NSString**)sessionState;
Remarks
TBD
SessionStateSave Event (SAMLSPServer Module)
TBD.
Syntax
- (void)onSessionStateSave:(long long)connectionID :(NSString*)sessionID :(NSString*)sessionState;
Remarks
TBD
SignatureFound Event (SAMLSPServer Module)
Signifies the start of signature validation.
Syntax
func onSignatureFound(connectionID: Int64, sessionID: String, messageType: String, messageID: String, scope: Int32, issuerRDN: String, serialNumber: Data, subjectKeyID: Data, sigMethod: String, digestMethod: String, certFound: Bool, validate: inout Bool)
- (void)onSignatureFound:(long long)connectionID :(NSString*)sessionID :(NSString*)messageType :(NSString*)messageID :(int)scope :(NSString*)issuerRDN :(NSData*)serialNumber :(NSData*)subjectKeyID :(NSString*)sigMethod :(NSString*)digestMethod :(BOOL)certFound :(int*)validate;
Remarks
This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified message.
The Scope parameter specifies the subject of the signature. This can be the outermost SAML message or an embedded assertion.
sssUnknown | 0 | The scope of signature is unknown |
sssMessage | 1 | The signature covers the entire SAML message |
sssAssertion | 2 | The signature covers an assertion |
sssBinding | 3 | The signature covers the binding |
The details of the reported signature are populated in the Security object. For assertion signatures, you can update the details by pinning the assertion.
The CertFound is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via KnownCertificates property.
Signature validation consists of two independent stages: cryptographic signature validation and chain validation. SAMLReader only supports signature validation. To validate the chain, grab the signing certificate from the SigningCertificate property and the associated certificates from the Certificates collection, and pass them to the CertificateValidator component to validate its chain.
Use the Validate parameter to tell the reader whether it should validate the signature.
SignatureValidated Event (SAMLSPServer Module)
Reports the signature validation result.
Syntax
func onSignatureValidated(connectionID: Int64, sessionID: String, messageType: String, messageID: String, scope: Int32, issuerRDN: String, serialNumber: Data, subjectKeyID: Data, sigMethod: String, digestMethod: String, validationResult: inout Int32)
- (void)onSignatureValidated:(long long)connectionID :(NSString*)sessionID :(NSString*)messageType :(NSString*)messageID :(int)scope :(NSString*)issuerRDN :(NSData*)serialNumber :(NSData*)subjectKeyID :(NSString*)sigMethod :(NSString*)digestMethod :(int*)validationResult;
Remarks
This event is fired when the complete XML signature validation process is finished.
The Scope parameter specifies the subject of the signature. This can be the outermost SAML message or an embedded assertion.
sssUnknown | 0 | The scope of signature is unknown |
sssMessage | 1 | The signature covers the entire SAML message |
sssAssertion | 2 | The signature covers an assertion |
sssBinding | 3 | The signature covers the binding |
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
TLSCertValidate Event (SAMLSPServer Module)
Fires when a client certificate needs to be validated.
Syntax
func onTLSCertValidate(connectionID: Int64, accept: inout Bool)
- (void)onTLSCertValidate:(long long)connectionID :(int*)accept;
Remarks
The class fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the Accept parameter.
TLSEstablished Event (SAMLSPServer Module)
Reports the setup of a TLS session.
Syntax
func onTLSEstablished(connectionID: Int64)
- (void)onTLSEstablished:(long long)connectionID;
Remarks
Subscribe to this event to be notified about the setup of a TLS connection by a connected client.
TLSHandshake Event (SAMLSPServer Module)
Fires when a newly established client connection initiates a TLS handshake.
Syntax
func onTLSHandshake(connectionID: Int64, serverName: String, abort: inout Bool)
- (void)onTLSHandshake:(long long)connectionID :(NSString*)serverName :(int*)abort;
Remarks
Use this event to get notified about the initiation of the TLS handshake by the remote client. The ServerName parameter specifies the requested host from the client hello message.
TLSPSK Event (SAMLSPServer Module)
Requests a pre-shared key for TLS-PSK.
Syntax
func onTLSPSK(connectionID: Int64, identity: String, psk: inout String, ciphersuite: inout String)
- (void)onTLSPSK:(long long)connectionID :(NSString*)identity :(NSString**)PSK :(NSString**)ciphersuite;
Remarks
The class fires this event to report that a client has requested a TLS-PSK negotiation. ConnectionId indicates the unique connection ID that requested the PSK handshake.
Use Identity to look up for the corresponding pre-shared key in the server's database, then assign the key to the PSK parameter. If TLS 1.3 PSK is used, you will also need to assign the Ciphersuite parameter with the cipher suite associated with that identity and their key.
TLSShutdown Event (SAMLSPServer Module)
Reports closure of a TLS session.
Syntax
func onTLSShutdown(connectionID: Int64)
- (void)onTLSShutdown:(long long)connectionID;
Remarks
The class 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.
Certificate Type
Provides details of an individual X.509 certificate.
Remarks
This type provides access to X.509 certificate details.
Fields
bytes
Data (read-only)
Default Value: ""
Returns raw certificate data in DER format.
ca
Bool
Default Value: False
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
caKeyID
Data (read-only)
Default Value: ""
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.
certType
CertTypes (read-only)
Default Value: 0
Returns the type of the entity contained in the object.
crlDistributionPoints
String
Default Value: ""
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
curve
String
Default Value: ""
Specifies the elliptic curve of the EC public key.
SB_EC_SECP112R1 | SECP112R1 | |
SB_EC_SECP112R2 | SECP112R2 | |
SB_EC_SECP128R1 | SECP128R1 | |
SB_EC_SECP128R2 | SECP128R2 | |
SB_EC_SECP160K1 | SECP160K1 | |
SB_EC_SECP160R1 | SECP160R1 | |
SB_EC_SECP160R2 | SECP160R2 | |
SB_EC_SECP192K1 | SECP192K1 | |
SB_EC_SECP192R1 | SECP192R1 | |
SB_EC_SECP224K1 | SECP224K1 | |
SB_EC_SECP224R1 | SECP224R1 | |
SB_EC_SECP256K1 | SECP256K1 | |
SB_EC_SECP256R1 | SECP256R1 | |
SB_EC_SECP384R1 | SECP384R1 | |
SB_EC_SECP521R1 | SECP521R1 | |
SB_EC_SECT113R1 | SECT113R1 | |
SB_EC_SECT113R2 | SECT113R2 | |
SB_EC_SECT131R1 | SECT131R1 | |
SB_EC_SECT131R2 | SECT131R2 | |
SB_EC_SECT163K1 | SECT163K1 | |
SB_EC_SECT163R1 | SECT163R1 | |
SB_EC_SECT163R2 | SECT163R2 | |
SB_EC_SECT193R1 | SECT193R1 | |
SB_EC_SECT193R2 | SECT193R2 | |
SB_EC_SECT233K1 | SECT233K1 | |
SB_EC_SECT233R1 | SECT233R1 | |
SB_EC_SECT239K1 | SECT239K1 | |
SB_EC_SECT283K1 | SECT283K1 | |
SB_EC_SECT283R1 | SECT283R1 | |
SB_EC_SECT409K1 | SECT409K1 | |
SB_EC_SECT409R1 | SECT409R1 | |
SB_EC_SECT571K1 | SECT571K1 | |
SB_EC_SECT571R1 | SECT571R1 | |
SB_EC_PRIME192V1 | PRIME192V1 | |
SB_EC_PRIME192V2 | PRIME192V2 | |
SB_EC_PRIME192V3 | PRIME192V3 | |
SB_EC_PRIME239V1 | PRIME239V1 | |
SB_EC_PRIME239V2 | PRIME239V2 | |
SB_EC_PRIME239V3 | PRIME239V3 | |
SB_EC_PRIME256V1 | PRIME256V1 | |
SB_EC_C2PNB163V1 | C2PNB163V1 | |
SB_EC_C2PNB163V2 | C2PNB163V2 | |
SB_EC_C2PNB163V3 | C2PNB163V3 | |
SB_EC_C2PNB176W1 | C2PNB176W1 | |
SB_EC_C2TNB191V1 | C2TNB191V1 | |
SB_EC_C2TNB191V2 | C2TNB191V2 | |
SB_EC_C2TNB191V3 | C2TNB191V3 | |
SB_EC_C2ONB191V4 | C2ONB191V4 | |
SB_EC_C2ONB191V5 | C2ONB191V5 | |
SB_EC_C2PNB208W1 | C2PNB208W1 | |
SB_EC_C2TNB239V1 | C2TNB239V1 | |
SB_EC_C2TNB239V2 | C2TNB239V2 | |
SB_EC_C2TNB239V3 | C2TNB239V3 | |
SB_EC_C2ONB239V4 | C2ONB239V4 | |
SB_EC_C2ONB239V5 | C2ONB239V5 | |
SB_EC_C2PNB272W1 | C2PNB272W1 | |
SB_EC_C2PNB304W1 | C2PNB304W1 | |
SB_EC_C2TNB359V1 | C2TNB359V1 | |
SB_EC_C2PNB368W1 | C2PNB368W1 | |
SB_EC_C2TNB431R1 | C2TNB431R1 | |
SB_EC_NISTP192 | NISTP192 | |
SB_EC_NISTP224 | NISTP224 | |
SB_EC_NISTP256 | NISTP256 | |
SB_EC_NISTP384 | NISTP384 | |
SB_EC_NISTP521 | NISTP521 | |
SB_EC_NISTB163 | NISTB163 | |
SB_EC_NISTB233 | NISTB233 | |
SB_EC_NISTB283 | NISTB283 | |
SB_EC_NISTB409 | NISTB409 | |
SB_EC_NISTB571 | NISTB571 | |
SB_EC_NISTK163 | NISTK163 | |
SB_EC_NISTK233 | NISTK233 | |
SB_EC_NISTK283 | NISTK283 | |
SB_EC_NISTK409 | NISTK409 | |
SB_EC_NISTK571 | NISTK571 | |
SB_EC_GOSTCPTEST | GOSTCPTEST | |
SB_EC_GOSTCPA | GOSTCPA | |
SB_EC_GOSTCPB | GOSTCPB | |
SB_EC_GOSTCPC | GOSTCPC | |
SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
SB_EC_CURVE25519 | CURVE25519 | |
SB_EC_CURVE448 | CURVE448 |
fingerprint
Data (read-only)
Default Value: ""
Contains the fingerprint (a hash imprint) of this certificate.
friendlyName
String (read-only)
Default Value: ""
Contains an associated alias (friendly name) of the certificate.
handle
Int64
Default Value: 0
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());
hashAlgorithm
String
Default Value: ""
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
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 |
issuer
String (read-only)
Default Value: ""
The common name of the certificate issuer (CA), typically a company name.
issuerRDN
String
Default Value: ""
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
keyAlgorithm
String
Default Value: "0"
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 |
keyBits
Int32 (read-only)
Default Value: 0
Returns the length of the public key.
keyFingerprint
Data (read-only)
Default Value: ""
Returns a fingerprint of the public key contained in the certificate.
keyUsage
Int32
Default Value: 0
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 |
keyValid
Bool (read-only)
Default Value: False
Returns True if the certificate's key is cryptographically valid, and False otherwise.
ocspLocations
String
Default Value: ""
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
Default Value: False
Accessor to the value of the certificates ocsp-no-check extension.
origin
Int32 (read-only)
Default Value: 0
Returns the origin of this certificate.
policyIDs
String
Default Value: ""
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 (read-only)
Default Value: ""
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.
privateKeyExists
Bool (read-only)
Default Value: False
Indicates whether the certificate has an associated private key.
privateKeyExtractable
Bool (read-only)
Default Value: False
Indicates whether the private key is extractable
publicKeyBytes
Data (read-only)
Default Value: ""
Contains the certificate's public key in DER format.
qualified
Bool (read-only)
Default Value: False
Indicates whether the certificate is qualified.
This property is set to true if the certificate is confirmed by a TSL to be qualified.
qualifiedStatements
QualifiedStatementsTypes
Default Value: 0
Returns the qualified status of the certificate.
qualifiers
String (read-only)
Default Value: ""
A list of qualifiers.
Contains a comma-separated list of qualifiers for the certificate, for example QCP-n-qscd,QCWithSSCD.
selfSigned
Bool (read-only)
Default Value: False
Indicates whether the certificate is self-signed (root) or signed by an external CA.
serialNumber
Data
Default Value: ""
Returns the certificate's serial number.
sigAlgorithm
String (read-only)
Default Value: ""
Indicates the algorithm that was used by the CA to sign this certificate.
source
PKISources (read-only)
Default Value: 0
Returns the source of the entity contained in the object.
subject
String (read-only)
Default Value: ""
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
subjectAlternativeName
String
Default Value: ""
Returns or sets the value of the Subject Alternative Name extension of the certificate.
subjectKeyID
Data
Default Value: ""
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
Default Value: ""
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
valid
Bool (read-only)
Default Value: False
Indicates whether or not the signature on the request is valid and matches the public key contained in the request.
validFrom
String
Default Value: ""
The time point at which the certificate becomes valid, in UTC.
validTo
String
Default Value: ""
The time point at which the certificate expires, in UTC.
Constructors
public init(stream: )
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.
CryptoKey Type
This container represents a cryptographic key.
Remarks
This type is a universal placeholder for cryptographic keys.
Fields
algorithm
String
Default Value: ""
The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key. Public key algorithms: RSA, ECDSA, Elgamal, DH.
SB_SYMMETRIC_ALGORITHM_RC4 | RC4 | |
SB_SYMMETRIC_ALGORITHM_DES | DES | |
SB_SYMMETRIC_ALGORITHM_3DES | 3DES | |
SB_SYMMETRIC_ALGORITHM_RC2 | RC2 | |
SB_SYMMETRIC_ALGORITHM_AES128 | AES128 | |
SB_SYMMETRIC_ALGORITHM_AES192 | AES192 | |
SB_SYMMETRIC_ALGORITHM_AES256 | AES256 | |
SB_SYMMETRIC_ALGORITHM_IDENTITY | Identity | |
SB_SYMMETRIC_ALGORITHM_BLOWFISH | Blowfish | |
SB_SYMMETRIC_ALGORITHM_CAST128 | CAST128 | |
SB_SYMMETRIC_ALGORITHM_IDEA | IDEA | |
SB_SYMMETRIC_ALGORITHM_TWOFISH | Twofish | |
SB_SYMMETRIC_ALGORITHM_TWOFISH128 | Twofish128 | |
SB_SYMMETRIC_ALGORITHM_TWOFISH192 | Twofish192 | |
SB_SYMMETRIC_ALGORITHM_TWOFISH256 | Twofish256 | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA | Camellia | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA128 | Camellia128 | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA192 | Camellia192 | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA256 | Camellia256 | |
SB_SYMMETRIC_ALGORITHM_SERPENT | Serpent | |
SB_SYMMETRIC_ALGORITHM_SERPENT128 | Serpent128 | |
SB_SYMMETRIC_ALGORITHM_SERPENT192 | Serpent192 | |
SB_SYMMETRIC_ALGORITHM_SERPENT256 | Serpent256 | |
SB_SYMMETRIC_ALGORITHM_SEED | SEED | |
SB_SYMMETRIC_ALGORITHM_RABBIT | Rabbit | |
SB_SYMMETRIC_ALGORITHM_SYMMETRIC | Generic | |
SB_SYMMETRIC_ALGORITHM_GOST_28147_1989 | GOST-28147-1989 | |
SB_SYMMETRIC_ALGORITHM_CHACHA20 | ChaCha20 |
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 |
bits
Int32 (read-only)
Default Value: 0
The length of the key in bits.
curve
String
Default Value: ""
This property specifies the name of the curve the EC key is built on.
exportable
Bool (read-only)
Default Value: False
Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
handle
Int64
Default Value: 0
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());
id
Data
Default Value: ""
Provides access to a storage-specific key identifier. Key identifiers are used by cryptographic providers to refer to a particular key and/or distinguish between different keys. They are typically unique within a storage, but there is no guarantee that a particular cryptoprovider will conform to that (or will assign any key IDs at all).
iv
Data
Default Value: ""
The initialization vector (IV) of a symmetric key. This is normally a public part of a symmetric key, the idea of which is to introduce randomness to the encrypted data and/or serve as a first block in chaining ciphers.
key
Data (read-only)
Default Value: ""
The byte array representation of the key. This may not be available for non- keys.
nonce
Data
Default Value: ""
A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.
private_
Bool (read-only)
Default Value: False
Returns True if the object hosts a private key, and False otherwise.
public_
Bool (read-only)
Default Value: False
Returns True if the object hosts a public key, and False otherwise.
subject
Data
Default Value: ""
Returns the key subject. This is a cryptoprovider-dependent value, which normally aims to provide some user-friendly insight into the key owner.
symmetric
Bool (read-only)
Default Value: False
Returns True if the object contains a symmetric key, and False otherwise.
valid
Bool (read-only)
Default Value: False
Returns True if this key is valid. The term Valid highly depends on the kind of the key being stored. A symmetric key is considered valid if its length fits the algorithm being set. The validity of an RSA key also ensures that the RSA key elements (primes, exponents, and modulus) are consistent.
Constructors
public init()
Creates an empty crypto key object.
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
Default Value: ""
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 pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.
customParams
String
Default Value: ""
Custom parameters to be passed to the signing service (uninterpreted).
data
String
Default Value: ""
Additional data to be included in the async state and mirrored back by the requestor
externalHashCalculation
Bool
Default Value: False
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
Default Value: "SHA256"
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 |
keyID
String
Default Value: ""
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:
signer.ExternalCrypto.KeyID = "MainSigningKey";
signer.ExternalCrypto.KeySecret = "abcdef0123456789";
keySecret
String
Default Value: ""
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
Default Value: 0
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.
Available options:
asmdPKCS1 | 0 |
asmdPKCS7 | 1 |
mode
ExternalCryptoModes
Default Value: 0
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 OnExternalSign event (2) |
ecmDCAuth | DCAuth signing (3) |
ecmDCAuthJSON | DCAuth signing in JSON format (4) |
publicKeyAlgorithm
String
Default Value: ""
Provide 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 |
Constructors
public init()
Creates a new ExternalCrypto object with default field values.
SAMLEntity Type
Represents SAML entity details.
Remarks
This type is a container for SAML SP or IdP entity parameters. These are often referred to as service metadata.
Fields
contactPerson
String
Default Value: ""
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.
encryptionKey
Data
Default Value: ""
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.
encryptionMethods
String
Default Value: ""
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
entityID
String
Default Value: ""
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).
flags
Int32
Default Value: 0
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.
nameIDFormats
String
Default Value: ""
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
organizationDisplayName
String
Default Value: ""
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.
organizationLang
String
Default Value: ""
The language preferred by the organization.
This optional setting can be used to adjust the preferred language of the owning organization.
organizationName
String
Default Value: ""
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.
organizationURL
String
Default Value: ""
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.
signatureValidationResult
SignatureValidities (read-only)
Default Value: 0
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) |
signed
Bool (read-only)
Default Value: False
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.
signedWith
Data (read-only)
Default Value: ""
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 setting.
signingKey
Data
Default Value: ""
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 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 SigningCertificate setting (for this-party settings).
Messages sent by the endpoint can be signed with the provided key or certificate.
validUntil
String
Default Value: ""
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.
Constructors
public init()
Creates a new SAMLEntity object.
SAMLSecuritySettings Type
Represents SAML security settings for the message being viewed/edited.
Remarks
This type is a container for SAML security parameters.
Fields
canonicalizationMethod
String
Default Value: ""
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/)
digestMethod
String
Default Value: ""
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.
encryptionMethod
String
Default Value: "AES256"
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 |
flags
Int32
Default Value: 1
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 (0x00000001) - Signature after issuer
- ssfSignatureBeforeDescriptor (0x00000002) - Signature before descriptor
- ssfKeyDataIssuerSerial (0x00000004) - Include the IssuerSerial key data element
- ssfKeyDataSKI (0x00000008) - Include the SubjectKeyIdentifier key data element
- ssfKeyDataSubjectName (0x00000010) - Include the SubjectName key data element
- ssfKeyDataCertificate (0x00000020) - Include the Certificate key data element
- ssfKeyDataCRL (0x00000040) - Include the CRL key data element
- ssfSignAuthnRequests (0x00010000) - Sign authentication requests
- ssfSignArtifactResolveRequests (0x00020000) - Sign artifact resolve requests
- ssfSignLogoutRequests (0x00040000) - Sign logout requests
- ssfSignAssertions (0x00080000) - Sign outgoing assertions
- ssfSignResponses (0x00100000) - Sign all responses
sigMethod
String
Default Value: ""
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.
signaturePolicy
SAMLSignaturePolicies
Default Value: 0
Specifies the signature validation policy.
Use this property to specify the signature validation policy for the component.
Constructors
public init()
Creates a new SAMLSecuritySettings object.
SAMLServiceInfo Type
Represents SAML service details.
Remarks
This type is a container for SAML SP or IdP endpoint service parameters.
Fields
bindingType
SAMLBindingTypes (read-only)
Default Value: 0
Specifies the type of SAML binding that this endpoint accepts.
Use this property to specify the binding type to use with this endpoint.
entityID
String (read-only)
Default Value: ""
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).
location
String (read-only)
Default Value: ""
The location (URL) of the endpoint.
priority
Int32
Default Value: -1
The priority of the endpoint in relation to other endpoints with the same .
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.
service
Int32 (read-only)
Default Value: 0
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.
serviceIndex
Int32 (read-only)
Default Value: 0
The index of this endpoint.
For endpoints that can accept requests via multiple bindings, Index is used to distinguish between individual endpoint specifiers.
Constructors
public init()
Creates a new SAMLServiceInfo object.
SocketSettings Type
A container for the socket settings.
Remarks
This type is a container for socket-layer parameters.
Fields
dnsMode
DNSResolveModes
Default Value: 0
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
dmAuto | 0 |
dmPlatform | 1 |
dmOwn | 2 |
dmOwnSecure | 3 |
dnsPort
Int32
Default Value: 0
Specifies the port number to be used for sending queries to the DNS server.
dnsQueryTimeout
Int32
Default Value: 0
The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout.
dnsServers
String
Default Value: ""
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
dnsTotalTimeout
Int32
Default Value: 0
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout.
incomingSpeedLimit
Int32
Default Value: 0
The maximum number of bytes to read from the socket, per second.
localAddress
String
Default Value: ""
The local network interface to bind the socket to.
localPort
Int32
Default Value: 0
The local port number to bind the socket to.
outgoingSpeedLimit
Int32
Default Value: 0
The maximum number of bytes to write to the socket, per second.
timeout
Int32
Default Value: 60000
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
Default Value: False
Enables or disables IP protocol version 6.
Constructors
public init()
Creates a new SocketSettings object.
TLSConnectionInfo Type
Contains information about a network connection.
Remarks
Use this property to check various details of the network connection. These include the total amounts of data transferred, the availability of TLS, and its parameters.
Fields
aeadCipher
Bool (read-only)
Default Value: False
Indicates whether the encryption algorithm used is an AEAD cipher.
chainValidationDetails
Int32 (read-only)
Default Value: 0
The details of a certificate chain validation outcome. They may often suggest what 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 |
chainValidationResult
ChainValidities (read-only)
Default Value: 0
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.
ciphersuite
String (read-only)
Default Value: ""
The cipher suite employed by this connection.
For TLS connections, this property returns the ciphersuite that was/is employed by the connection.
clientAuthenticated
Bool (read-only)
Default Value: False
Specifies whether client authentication was performed during this connection.
clientAuthRequested
Bool (read-only)
Default Value: False
Specifies whether client authentication was requested during this connection.
connectionEstablished
Bool (read-only)
Default Value: False
Indicates whether the connection has been established fully.
connectionID
Data (read-only)
Default Value: ""
The unique identifier assigned to this connection.
digestAlgorithm
String (read-only)
Default Value: ""
The digest algorithm used in a TLS-enabled connection.
encryptionAlgorithm
String (read-only)
Default Value: ""
The symmetric encryption algorithm used in a TLS-enabled connection.
exportable
Bool (read-only)
Default Value: False
Indicates whether a TLS connection uses a reduced-strength exportable cipher.
id
Int64 (read-only)
Default Value: -1
The client connection's unique identifier. This value is used throughout to refer to a particular client connection.
keyExchangeAlgorithm
String (read-only)
Default Value: ""
The key exchange algorithm used in a TLS-enabled connection.
keyExchangeKeyBits
Int32 (read-only)
Default Value: 0
The length of the key exchange key of a TLS-enabled connection.
namedECCurve
String (read-only)
Default Value: ""
The elliptic curve used in this connection.
pfsCipher
Bool (read-only)
Default Value: False
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
preSharedIdentity
String
Default Value: ""
Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
preSharedIdentityHint
String (read-only)
Default Value: ""
A hint professed by the server to help the client select the PSK identity to use.
publicKeyBits
Int32 (read-only)
Default Value: 0
The length of the public key.
remoteAddress
String (read-only)
Default Value: ""
The client's IP address.
remotePort
Int32 (read-only)
Default Value: 0
The remote port of the client connection.
resumedSession
Bool (read-only)
Default Value: False
Indicates whether a TLS-enabled connection was spawned from another TLS connection
secureConnection
Bool (read-only)
Default Value: False
Indicates whether TLS or SSL is enabled for this connection.
serverAuthenticated
Bool (read-only)
Default Value: False
Indicates whether server authentication was performed during a TLS-enabled connection.
signatureAlgorithm
String (read-only)
Default Value: ""
The signature algorithm used in a TLS handshake.
symmetricBlockSize
Int32 (read-only)
Default Value: 0
The block size of the symmetric algorithm used.
symmetricKeyBits
Int32 (read-only)
Default Value: 0
The key length of the symmetric algorithm used.
totalBytesReceived
Int64 (read-only)
Default Value: 0
The total number of bytes received over this connection.
totalBytesSent
Int64 (read-only)
Default Value: 0
The total number of bytes sent over this connection.
validationLog
String (read-only)
Default Value: ""
Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.
version
String (read-only)
Default Value: ""
Indicates the version of SSL/TLS protocol negotiated during this connection.
Constructors
public init()
Creates a new TLSConnectionInfo 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
Default Value: True
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
baseConfiguration
SecureTransportPredefinedConfigurations
Default Value: 0
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.
stpcDefault | 0 | |
stpcCompatible | 1 | |
stpcComprehensiveInsecure | 2 | |
stpcHighlySecure | 3 |
ciphersuites
String
Default Value: ""
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:
- 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
clientAuth
ClientAuthTypes
Default Value: 0
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;
ecCurves
String
Default Value: ""
Defines the elliptic curves to enable.
extensions
String
Default Value: ""
Provides access to TLS extensions.
forceResumeIfDestinationChanges
Bool
Default Value: False
Whether to force TLS session resumption when the destination address changes.
preSharedIdentity
String
Default Value: ""
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
preSharedKey
String
Default Value: ""
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
preSharedKeyCiphersuite
String
Default Value: ""
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
renegotiationAttackPreventionMode
RenegotiationAttackPreventionModes
Default Value: 2
Selects 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. |
revocationCheck
RevocationCheckKinds
Default Value: 1
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 | Check all provided CRL endpoints for all chain certificates. |
crcAllOCSP | 3 | Check all provided OCSP endpoints for all chain certificates. |
crcAllCRLAndOCSP | 4 | Check all CRL and OCSP endpoints for all chain certificates. |
crcAnyCRL | 5 | At least one CRL check for every certificate in the chain must succeed. |
crcAnyOCSP | 6 | At least one OCSP check for every certificate in the chain must succeed. |
crcAnyCRLOrOCSP | 7 | At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first. |
crcAnyOCSPOrCRL | 8 | At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first. |
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
Default Value: 16
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 use of client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
cssloAutoAddServerNameExtension | 0x010 | Automatically add server name extension when known |
cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (not send) 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 handshake message as large batches rather than individually |
tlsMode
SSLModes
Default Value: 0
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, allow plain data. |
useExtendedMasterSecret
Bool
Default Value: False
Enables Extended Master Secret Extension, as defined in RFC 7627.
useSessionResumption
Bool
Default Value: False
Enables or disables TLS session resumption capability.
versions
Int32
Default Value: 16
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 |
Constructors
public init()
Creates a new TLSSettings object.
Config 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 Config Settings
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
time | Current time | |
level | Level | |
package | Package name | |
module | Module name | |
class | Class name | |
method | Method name | |
threadid | Thread Id | |
contenttype | Content type | |
content | Content | |
all | All details |
Supported filter names are:
exclude-package | Exclude a package specified in the value | |
exclude-module | Exclude a module specified in the value | |
exclude-class | Exclude a class specified in the value | |
exclude-method | Exclude a method specified in the value | |
include-package | Include a package specified in the value | |
include-module | Include a module specified in the value | |
include-class | Include a class specified in the value | |
include-method | Include a method specified in the value |
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
none | None (by default) | |
fatal | Severe errors that cause premature termination. | |
error | Other runtime errors or unexpected conditions. | |
warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
info | Interesting runtime events (startup/shutdown). | |
debug | Detailed information on flow of through the system. | |
trace | More detailed information. |
The default value of this setting is 100.
none | No rotation | |
deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
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) |