SAMLIdPServer Module

Properties   Methods   Events   Config Settings   Errors  

The SAMLIdPServer module represents a SAML identity provider.

Syntax

SecureBlackbox.Samlidpserver

Remarks

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

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

Property List

The following is the full list of the properties of the module with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the module with short descriptions. Click on the links for further details.

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.

Config Settings

The following is a list of config settings for the module with short descriptions. Click on the links for further details.

Active Property (SAMLIdPServer Module)

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

Syntax

• Swift
• Objective-C

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.

AllowIDPSSO Property (SAMLIdPServer Module)

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

Syntax

• Swift
• Objective-C

public var allowIDPSSO: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=allowIDPSSO,setter=setAllowIDPSSO:) BOOL allowIDPSSO;

- (BOOL)allowIDPSSO;
- (void)setAllowIDPSSO :(BOOL)newAllowIDPSSO;

Default Value

False

Remarks

Set this property to true to allow IdP-initiated Single Sign-Ons. Use AddIdPSSOLink method to add sign-on URLs.

ArtifactResolutionService Property (SAMLIdPServer Module)

The location of the artifact resolution service.

Syntax

• Swift
• Objective-C

public var artifactResolutionService: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=artifactResolutionService,setter=setArtifactResolutionService:) NSString* artifactResolutionService;

- (NSString*)artifactResolutionService;
- (void)setArtifactResolutionService :(NSString*)newArtifactResolutionService;

Default Value

"/idp/ArtifactResolutionService"

Remarks

Use this property to specify the location of the artifact resolution service of this Identity Provider (IdP).

AttributeQueryService Property (SAMLIdPServer Module)

The location of the AttributeQuery service.

Syntax

• Swift
• Objective-C

public var attributeQueryService: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=attributeQueryService,setter=setAttributeQueryService:) NSString* attributeQueryService;

- (NSString*)attributeQueryService;
- (void)setAttributeQueryService :(NSString*)newAttributeQueryService;

Default Value

"/idp/AttributeQueryService"

Remarks

Use this property to specify the relative URL of the AttributeQuery service provided by this Identity Provider (IdP).

AuthFormTemplate Property (SAMLIdPServer Module)

Defines the default authentication template (login page).

Syntax

• Swift
• Objective-C

public var authFormTemplate: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=authFormTemplate,setter=setAuthFormTemplate:) NSString* authFormTemplate;

- (NSString*)authFormTemplate;
- (void)setAuthFormTemplate :(NSString*)newAuthFormTemplate;

Default Value

""

Remarks

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

ClientAuth Property (SAMLIdPServer Module)

Enables or disables certificate-based client authentication.

Syntax

• Swift
• Objective-C

public var clientAuth: SamlidpserverClientAuths {
  get {...}
  set {...}
}

public enum SamlidpserverClientAuths: Int32 {
  case ccatNoAuth = 0
  case ccatRequestCert = 1
  case ccatRequireCert = 2
}

@property (nonatomic,readwrite,assign,getter=clientAuth,setter=setClientAuth:) int clientAuth;

- (int)clientAuth;
- (void)setClientAuth :(int)newClientAuth;

Default Value

0

Remarks

Set this property to true to tune up the client authentication type: ccatNoAuth = 0; ccatRequestCert = 1; ccatRequireCert = 2;

EncryptAssertions Property (SAMLIdPServer Module)

Specifies whether to encrypt assertions included into the IdP response.

Syntax

• Swift
• Objective-C

public var encryptAssertions: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=encryptAssertions,setter=setEncryptAssertions:) BOOL encryptAssertions;

- (BOOL)encryptAssertions;
- (void)setEncryptAssertions :(BOOL)newEncryptAssertions;

Default Value

False

Remarks

Set this property to True to force the class to encrypt the assertions included into the server's response.

EncryptionCertificate Property (SAMLIdPServer Module)

The certificate used to encrypt the assertions.

Syntax

• Swift
• Objective-C

public var encryptionCertificate: Certificate {
  get {...}
  set {...}
}

@property (nonatomic,readonly,assign,getter=encryptionCertBytes) NSData* encryptionCertBytes;

- (NSData*)encryptionCertBytes;

@property (nonatomic,readwrite,assign,getter=encryptionCertHandle,setter=setEncryptionCertHandle:) long long encryptionCertHandle;

- (long long)encryptionCertHandle;
- (void)setEncryptionCertHandle :(long long)newEncryptionCertHandle;

 

Default Value

""

Remarks

Use this property to provide the certificate to be used for encrypting the assertions included into the IdP responses.

The class encrypts assertions automatically if EncryptAssertions is True.

ErrorOrigin Property (SAMLIdPServer Module)

Indicates the endpoint where the error originates from.

Syntax

• Swift
• Objective-C

public var errorOrigin: SamlidpserverErrorOrigins {
  get {...}
  set {...}
}

public enum SamlidpserverErrorOrigins: Int32 {
  case eoLocal = 0
  case eoRemote = 1
}

@property (nonatomic,readwrite,assign,getter=errorOrigin,setter=setErrorOrigin:) int errorOrigin;

- (int)errorOrigin;
- (void)setErrorOrigin :(int)newErrorOrigin;

Default Value

0

Remarks

Use this property to establish whether the reported error originates from a local or remote endpoint.

ErrorSeverity Property (SAMLIdPServer Module)

The severity of the error that happened.

Syntax

• Swift
• Objective-C

public var errorSeverity: SamlidpserverErrorSeverities {
  get {...}
  set {...}
}

public enum SamlidpserverErrorSeverities: Int32 {
  case esInfo = 0
  case esWarning = 1
  case esFatal = 2
}

@property (nonatomic,readwrite,assign,getter=errorSeverity,setter=setErrorSeverity:) int errorSeverity;

- (int)errorSeverity;
- (void)setErrorSeverity :(int)newErrorSeverity;

Default Value

1

Remarks

Use this property to establish whether the error is fatal.

ExternalCrypto Property (SAMLIdPServer Module)

Provides access to external signing and DC parameters.

Syntax

• Swift
• Objective-C

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 the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

FIPSMode Property (SAMLIdPServer Module)

Reserved.

Syntax

• Swift
• Objective-C

public var fipsMode: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=FIPSMode,setter=setFIPSMode:) BOOL FIPSMode;

- (BOOL)FIPSMode;
- (void)setFIPSMode :(BOOL)newFIPSMode;

Default Value

False

Remarks

This property is reserved for future use.

Host Property (SAMLIdPServer Module)

Specifies the host address of the IdP server.

Syntax

• Swift
• Objective-C

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.

IDPSSOPage Property (SAMLIdPServer Module)

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

Syntax

• Swift
• Objective-C

public var idpssoPage: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=IDPSSOPage,setter=setIDPSSOPage:) NSString* IDPSSOPage;

- (NSString*)IDPSSOPage;
- (void)setIDPSSOPage :(NSString*)newIDPSSOPage;

Default Value

"/idpsso"

Remarks

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

IDPSSOPageContent Property (SAMLIdPServer Module)

The content of the IdP-initiated SSO page.

Syntax

• Swift
• Objective-C

public var idpssoPageContent: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=IDPSSOPageContent,setter=setIDPSSOPageContent:) NSString* IDPSSOPageContent;

- (NSString*)IDPSSOPageContent;
- (void)setIDPSSOPageContent :(NSString*)newIDPSSOPageContent;

Default Value

""

Remarks

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

LoginAttemptsLimit Property (SAMLIdPServer Module)

The maximum number of login attempts.

Syntax

• Swift
• Objective-C

public var loginAttemptsLimit: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=loginAttemptsLimit,setter=setLoginAttemptsLimit:) int loginAttemptsLimit;

- (int)loginAttemptsLimit;
- (void)setLoginAttemptsLimit :(int)newLoginAttemptsLimit;

Default Value

3

Remarks

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

MetadataURL Property (SAMLIdPServer Module)

The IdP's metadata location.

Syntax

• Swift
• Objective-C

public var metadataURL: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=metadataURL,setter=setMetadataURL:) NSString* metadataURL;

- (NSString*)metadataURL;
- (void)setMetadataURL :(NSString*)newMetadataURL;

Default Value

"/idp/metadata"

Remarks

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

MetaSigningCertificate Property (SAMLIdPServer Module)

Specifies the metadata signing certificate.

Syntax

• Swift
• Objective-C

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 IdP's metadata.

OfflineMode Property (SAMLIdPServer Module)

Enables the Offline mode.

Syntax

• Swift
• Objective-C

public var offlineMode: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=offlineMode,setter=setOfflineMode:) BOOL offlineMode;

- (BOOL)offlineMode;
- (void)setOfflineMode :(BOOL)newOfflineMode;

Default Value

False

Remarks

In the Offline mode the server does not open the listening port. Instead, it expects all incoming requests to be provided via the ProcessGenericRequest calls.

The Offline mode is a handy mechanism for attaching the server to external web engines, such as IIS or Tomcat. It lets you leave the HTTP matters to the engine, and only be responsible for handling the actual SAML requests.

Port Property (SAMLIdPServer Module)

The listening port number.

Syntax

• Swift
• Objective-C

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 IdP server should listen for incoming connections. To specify server's IP address use Host.

PreferredSingleLogoutResponseBinding Property (SAMLIdPServer Module)

Specifies the preferred single logout response binding.

Syntax

• Swift
• Objective-C

public var preferredSingleLogoutResponseBinding: SamlidpserverPreferredSingleLogoutResponseBindings {
  get {...}
  set {...}
}

public enum SamlidpserverPreferredSingleLogoutResponseBindings: Int32 {
  case csbtNone = 0
  case csbtSOAP = 1
  case csbtPAOS = 2
  case csbtRedirect = 3
  case csbtPOST = 4
  case csbtArtifact = 5
}

@property (nonatomic,readwrite,assign,getter=preferredSingleLogoutResponseBinding,setter=setPreferredSingleLogoutResponseBinding:) int preferredSingleLogoutResponseBinding;

- (int)preferredSingleLogoutResponseBinding;
- (void)setPreferredSingleLogoutResponseBinding :(int)newPreferredSingleLogoutResponseBinding;

Default Value

3

Remarks

This value is used by the Identity Provider (IdP) when the default binding is not specified in Service Provider's (SP) metadata file.

The binding is the mechanism of message exchange used by SAML requestors and responders.

PreferredSingleSignOnResponseBinding Property (SAMLIdPServer Module)

Specifies preferred SSO response binding.

Syntax

• Swift
• Objective-C

public var preferredSingleSignOnResponseBinding: SamlidpserverPreferredSingleSignOnResponseBindings {
  get {...}
  set {...}
}

public enum SamlidpserverPreferredSingleSignOnResponseBindings: Int32 {
  case csbtNone = 0
  case csbtSOAP = 1
  case csbtPAOS = 2
  case csbtRedirect = 3
  case csbtPOST = 4
  case csbtArtifact = 5
}

@property (nonatomic,readwrite,assign,getter=preferredSingleSignOnResponseBinding,setter=setPreferredSingleSignOnResponseBinding:) int preferredSingleSignOnResponseBinding;

- (int)preferredSingleSignOnResponseBinding;
- (void)setPreferredSingleSignOnResponseBinding :(int)newPreferredSingleSignOnResponseBinding;

Default Value

4

Remarks

This value is used by the Identity Provider (IdP) when the default binding is not specified in Service Provider's (SP) metadata file.

The binding is the mechanism of message exchange used by SAML requestors and responders.

ServerCertificates Property (SAMLIdPServer Module)

The server's TLS certificates.

Syntax

• Swift
• Objective-C

public var serverCertificates: Array<Certificate> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=serverCertCount,setter=setServerCertCount:) int serverCertCount;

- (int)serverCertCount;
- (void)setServerCertCount :(int)newServerCertCount;

- (NSData*)serverCertBytes:(int)serverCertIndex;

- (long long)serverCertHandle:(int)serverCertIndex;
- (void)setServerCertHandle:(int)serverCertIndex :(long long)newServerCertHandle;

Default Value

""

Remarks

Use this property to 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.

SigCanonicalizationMethod Property (SAMLIdPServer Module)

The canonicalization method to use in the signature.

Syntax

• Swift
• Objective-C

public var sigCanonicalizationMethod: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=sigCanonicalizationMethod,setter=setSigCanonicalizationMethod:) NSString* sigCanonicalizationMethod;

- (NSString*)sigCanonicalizationMethod;
- (void)setSigCanonicalizationMethod :(NSString*)newSigCanonicalizationMethod;

Default Value

""

Remarks

The URI of the canonicalization method to use in the signature (e.g. http://www.w3.org/TR/xml-exc-c14n/)

SigDigestMethod Property (SAMLIdPServer Module)

The digest method to use.

Syntax

• Swift
• Objective-C

public var sigDigestMethod: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=sigDigestMethod,setter=setSigDigestMethod:) NSString* sigDigestMethod;

- (NSString*)sigDigestMethod;
- (void)setSigDigestMethod :(NSString*)newSigDigestMethod;

Default Value

""

Remarks

The URI of the digest method to use for signing, as defined in XMLDSIG or XMLENC: http://www.w3.org/2000/09/xmldsig#sha256.

SigMethod Property (SAMLIdPServer Module)

The signature method to use.

Syntax

• Swift
• Objective-C

public var sigMethod: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=sigMethod,setter=setSigMethod:) NSString* sigMethod;

- (NSString*)sigMethod;
- (void)setSigMethod :(NSString*)newSigMethod;

Default Value

""

Remarks

The URI specifying the signature method to use for signing, for example http://www.w3.org/2001/04/xmldsig-more#rsa-sha256.

SignAssertions Property (SAMLIdPServer Module)

Specifies whether the assertions included in IdP responses should be signed.

Syntax

• Swift
• Objective-C

public var signAssertions: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=signAssertions,setter=setSignAssertions:) BOOL signAssertions;

- (BOOL)signAssertions;
- (void)setSignAssertions :(BOOL)newSignAssertions;

Default Value

False

Remarks

Set this property to True to automatically sign the assertions included into the Identity Provider (IdP) responses.

SigningCertificate Property (SAMLIdPServer Module)

The certificate to be used by the IdP's for signing.

Syntax

• Swift
• Objective-C

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 specify the certificate that shall be used for signing the assertions. Note that this certificate should have a private key associated with it. Use SigningChain to supply the rest of the certificate chain for inclusion into the signature.

SigningChain Property (SAMLIdPServer Module)

The signing certificate chain.

Syntax

• Swift
• Objective-C

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 the SigningCertificate property, if it is available, to provide the signing certificate itself.

SignMetadata Property (SAMLIdPServer Module)

Specifies whether the IdP's metadata should be signed.

Syntax

• Swift
• Objective-C

public var signMetadata: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=signMetadata,setter=setSignMetadata:) BOOL signMetadata;

- (BOOL)signMetadata;
- (void)setSignMetadata :(BOOL)newSignMetadata;

Default Value

False

Remarks

Set this property to True to sign the Identity Provider's (IdP) metadata before saving it. Do not forget to assign the signing certificate to the MetaSigningCertificate property.

SignResponse Property (SAMLIdPServer Module)

Specifies whether the IdP responses should be signed.

Syntax

• Swift
• Objective-C

public var signResponse: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=signResponse,setter=setSignResponse:) BOOL signResponse;

- (BOOL)signResponse;
- (void)setSignResponse :(BOOL)newSignResponse;

Default Value

False

Remarks

Set this property to True to automatically sign the responses sent by this IdP server.

SingleLogoutService Property (SAMLIdPServer Module)

The URL of the single logout service.

Syntax

• Swift
• Objective-C

public var singleLogoutService: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=singleLogoutService,setter=setSingleLogoutService:) NSString* singleLogoutService;

- (NSString*)singleLogoutService;
- (void)setSingleLogoutService :(NSString*)newSingleLogoutService;

Default Value

"/idp/SingleLogoutService"

Remarks

This property specifies the relative URL of the single logout service.

SingleLogoutServiceBindings Property (SAMLIdPServer Module)

Defines single logout service bindings.

Syntax

• Swift
• Objective-C

public var singleLogoutServiceBindings: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=singleLogoutServiceBindings,setter=setSingleLogoutServiceBindings:) NSString* singleLogoutServiceBindings;

- (NSString*)singleLogoutServiceBindings;
- (void)setSingleLogoutServiceBindings :(NSString*)newSingleLogoutServiceBindings;

Default Value

"+Artifact,+POST,+Redirect"

Remarks

Use this property to specify the single logout service bindings.

The binding is the mechanism of message exchange used by SAML requestors and responders.

SingleSignOnService Property (SAMLIdPServer Module)

The URL of the single logout service.

Syntax

• Swift
• Objective-C

public var singleSignOnService: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=singleSignOnService,setter=setSingleSignOnService:) NSString* singleSignOnService;

- (NSString*)singleSignOnService;
- (void)setSingleSignOnService :(NSString*)newSingleSignOnService;

Default Value

"/idp/SingleSignOnService"

Remarks

This property specifies the relative URL of the single logout (SSO) service.

SingleSignOnServiceBindings Property (SAMLIdPServer Module)

Defines single sign-on service bindings.

Syntax

• Swift
• Objective-C

public var singleSignOnServiceBindings: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=singleSignOnServiceBindings,setter=setSingleSignOnServiceBindings:) NSString* singleSignOnServiceBindings;

- (NSString*)singleSignOnServiceBindings;
- (void)setSingleSignOnServiceBindings :(NSString*)newSingleSignOnServiceBindings;

Default Value

"+Artifact,+POST,+Redirect"

Remarks

Use this property to specify the single sign-on service bindings.

The binding is the mechanism of message exchange used by SAML requestors and responders.

SocketSettings Property (SAMLIdPServer Module)

Manages network connection settings.

Syntax

• Swift
• Objective-C

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.

TLSSettings Property (SAMLIdPServer Module)

Manages TLS layer settings.

Syntax

• Swift
• Objective-C

public var tlsSettings: TLSSettings {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=TLSAutoValidateCertificates,setter=setTLSAutoValidateCertificates:) BOOL TLSAutoValidateCertificates;

- (BOOL)TLSAutoValidateCertificates;
- (void)setTLSAutoValidateCertificates :(BOOL)newTLSAutoValidateCertificates;

@property (nonatomic,readwrite,assign,getter=TLSBaseConfiguration,setter=setTLSBaseConfiguration:) int TLSBaseConfiguration;

- (int)TLSBaseConfiguration;
- (void)setTLSBaseConfiguration :(int)newTLSBaseConfiguration;

@property (nonatomic,readwrite,assign,getter=TLSCiphersuites,setter=setTLSCiphersuites:) NSString* TLSCiphersuites;

- (NSString*)TLSCiphersuites;
- (void)setTLSCiphersuites :(NSString*)newTLSCiphersuites;

@property (nonatomic,readwrite,assign,getter=TLSECCurves,setter=setTLSECCurves:) NSString* TLSECCurves;

- (NSString*)TLSECCurves;
- (void)setTLSECCurves :(NSString*)newTLSECCurves;

@property (nonatomic,readwrite,assign,getter=TLSExtensions,setter=setTLSExtensions:) NSString* TLSExtensions;

- (NSString*)TLSExtensions;
- (void)setTLSExtensions :(NSString*)newTLSExtensions;

@property (nonatomic,readwrite,assign,getter=TLSForceResumeIfDestinationChanges,setter=setTLSForceResumeIfDestinationChanges:) BOOL TLSForceResumeIfDestinationChanges;

- (BOOL)TLSForceResumeIfDestinationChanges;
- (void)setTLSForceResumeIfDestinationChanges :(BOOL)newTLSForceResumeIfDestinationChanges;

@property (nonatomic,readwrite,assign,getter=TLSPreSharedIdentity,setter=setTLSPreSharedIdentity:) NSString* TLSPreSharedIdentity;

- (NSString*)TLSPreSharedIdentity;
- (void)setTLSPreSharedIdentity :(NSString*)newTLSPreSharedIdentity;

@property (nonatomic,readwrite,assign,getter=TLSPreSharedKey,setter=setTLSPreSharedKey:) NSString* TLSPreSharedKey;

- (NSString*)TLSPreSharedKey;
- (void)setTLSPreSharedKey :(NSString*)newTLSPreSharedKey;

@property (nonatomic,readwrite,assign,getter=TLSPreSharedKeyCiphersuite,setter=setTLSPreSharedKeyCiphersuite:) NSString* TLSPreSharedKeyCiphersuite;

- (NSString*)TLSPreSharedKeyCiphersuite;
- (void)setTLSPreSharedKeyCiphersuite :(NSString*)newTLSPreSharedKeyCiphersuite;

@property (nonatomic,readwrite,assign,getter=TLSRenegotiationAttackPreventionMode,setter=setTLSRenegotiationAttackPreventionMode:) int TLSRenegotiationAttackPreventionMode;

- (int)TLSRenegotiationAttackPreventionMode;
- (void)setTLSRenegotiationAttackPreventionMode :(int)newTLSRenegotiationAttackPreventionMode;

@property (nonatomic,readwrite,assign,getter=TLSRevocationCheck,setter=setTLSRevocationCheck:) int TLSRevocationCheck;

- (int)TLSRevocationCheck;
- (void)setTLSRevocationCheck :(int)newTLSRevocationCheck;

@property (nonatomic,readwrite,assign,getter=TLSSSLOptions,setter=setTLSSSLOptions:) int TLSSSLOptions;

- (int)TLSSSLOptions;
- (void)setTLSSSLOptions :(int)newTLSSSLOptions;

@property (nonatomic,readwrite,assign,getter=TLSTLSMode,setter=setTLSTLSMode:) int TLSTLSMode;

- (int)TLSTLSMode;
- (void)setTLSTLSMode :(int)newTLSTLSMode;

@property (nonatomic,readwrite,assign,getter=TLSUseExtendedMasterSecret,setter=setTLSUseExtendedMasterSecret:) BOOL TLSUseExtendedMasterSecret;

- (BOOL)TLSUseExtendedMasterSecret;
- (void)setTLSUseExtendedMasterSecret :(BOOL)newTLSUseExtendedMasterSecret;

@property (nonatomic,readwrite,assign,getter=TLSUseSessionResumption,setter=setTLSUseSessionResumption:) BOOL TLSUseSessionResumption;

- (BOOL)TLSUseSessionResumption;
- (void)setTLSUseSessionResumption :(BOOL)newTLSUseSessionResumption;

@property (nonatomic,readwrite,assign,getter=TLSVersions,setter=setTLSVersions:) int TLSVersions;

- (int)TLSVersions;
- (void)setTLSVersions :(int)newTLSVersions;

 

Default Value

""

Remarks

Use this property to tune up the TLS layer parameters.

URL Property (SAMLIdPServer Module)

Specifies the base URL of this IdP server.

Syntax

• Swift
• Objective-C

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 Identity Provider (IdP) server.

AddIdPSSOLink Method (SAMLIdPServer Module)

Adds an SSO URL to the list.

Syntax

• Swift
• Objective-C

public func addIdPSSOLink(spIndex: Int32, url: String, relayState: String) throws -> Int32

- (int)addIdPSSOLink:(int)SPIndex :(NSString*)URL :(NSString*)relayState;

Remarks

Use this method to add a new single sign-on (SSO) link. The method returns the index of the new link in the internal list of SSO links.

SPIndex specifies the index of the service provider configuration, URL contains the relative URL for the SSO, and RelayState contains the value of the corresponding SAML parameter.

According to SAML 2.0 specification, the RelayState parameter may be used by the SAML binding in order to convey and preserve state information. If this parameter is present in a SAML request message, the responding party must include the same exact parameter into the response to this request.

In many applications, when using IdP-initiated single sign-on, the IdP uses RelayState to indicate to the SP the URL to which it should redirect after the successful sign-on.

AddUser Method (SAMLIdPServer Module)

Registers known user credentials.

Syntax

• Swift
• Objective-C

public func addUser(login: String, password: String) throws -> Void

- (void)addUser:(NSString*)login :(NSString*)password;

Remarks

Call this method to register a pair of known user's credentials with the server.

AddUserWithEmail Method (SAMLIdPServer Module)

Registers known user credentials.

Syntax

• Swift
• Objective-C

public func addUserWithEmail(login: String, email: String, password: String) throws -> Void

- (void)addUserWithEmail:(NSString*)login :(NSString*)email :(NSString*)password;

Remarks

Call this method to register known user's credentials with the server. In addition to Login and Password this method also associates an Email address with this user.

ClearUsers Method (SAMLIdPServer Module)

Clears the database of registered users.

Syntax

• Swift
• Objective-C

public func clearUsers() throws -> Void

- (void)clearUsers;

Remarks

Use this method to remove all stored user credential details.

Config Method (SAMLIdPServer Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

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

Performs an additional action.

Syntax

• Swift
• Objective-C

public func doAction(actionID: String, actionParams: String) throws -> String

- (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 insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

GetProviderProperty Method (SAMLIdPServer Module)

Returns the value of a custom provider property.

Syntax

• Swift
• Objective-C

public func getProviderProperty(name: String) throws -> String

- (NSString*)getProviderProperty:(NSString*)name;

Remarks

This method, together with SetProviderProperty, provides an extensible way of managing the Identity Provider's settings that are not available through the primary properties of the component. As SAML usage scenarios evolve and new providers appear, the list of supported properties can be extended.

The following properties are currently supported:

• ContactPerson
• OrganizationName
• OrganizationDisplayName
• OrganizationURL
• OrganizationLang

LoadSPMetadata Method (SAMLIdPServer Module)

Loads the metadata required for information exchange with the service provider.

Syntax

• Swift
• Objective-C

public func loadSPMetadata(fileName: String) throws -> Int32

- (int)loadSPMetadata:(NSString*)fileName;

Remarks

The Service provider (SP) may have a lot of different options and requirements for interactions with the Identity provider (IdP). Usually all these options together with X.509 certificates needed for data exchange are stored in XML metadata files. Use this method to load metadata from such file generated by the service provider.

FileName specifies the metadata file name.

ProcessGenericRequest Method (SAMLIdPServer Module)

Processes a generic HTTP SAML request.

Syntax

• Swift
• Objective-C

public func processGenericRequest(request: Data) throws -> Data

- (NSData*)processGenericRequest:(NSData*)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 returned value contains a full HTTP response that should be supplied back to the requestor. You can edit some parts of the response (for example, by adding some custom HTTP headers).

You can use this method with or without the OfflineMode.

RemoveIdPSSOLink Method (SAMLIdPServer Module)

Removes the specified SSO link.

Syntax

• Swift
• Objective-C

public func removeIdPSSOLink(index: Int32) throws -> Void

- (void)removeIdPSSOLink:(int)index;

Remarks

Multiple URLs may be used on an IdP to initiate the single sign-on (SSO) session. You can add new links using AddIdPSSOLink, and remove ones that are no longer needed with RemoveIdPSSOLink.

RemoveSP Method (SAMLIdPServer Module)

Removes an SP from the list of trusted service providers.

Syntax

• Swift
• Objective-C

public func removeSP(index: Int32) throws -> Void

- (void)removeSP:(int)index;

Remarks

Use this method to remove information about a service provider from the server.

RemoveUser Method (SAMLIdPServer Module)

Unregister user credentials.

Syntax

• Swift
• Objective-C

public func removeUser(login: String) throws -> Void

- (void)removeUser:(NSString*)login;

Remarks

Use this method to 'forget' the credentials of the user specified by the Login.

SaveMetadata Method (SAMLIdPServer Module)

Saves the IdP configuration to a metadata file.

Syntax

• Swift
• Objective-C

public func saveMetadata(fileName: String) throws -> Void

- (void)saveMetadata:(NSString*)fileName;

Remarks

Use this method to save the Identity Provider (IdP) configuration in the form of XML metadata in the file specified by FileName. This file may be transferred to service providers (SP) to adjust their interaction processes.

SetProviderProperty Method (SAMLIdPServer Module)

Sets the value of a custom provider property.

Syntax

• Swift
• Objective-C

public func setProviderProperty(name: String, value: String) throws -> Void

- (void)setProviderProperty:(NSString*)name :(NSString*)value;

Remarks

This method, together with GetProviderProperty, provides an extensible way of managing the Identity Provider's settings that are not available through the primary properties of the component. As SAML usage scenarios evolve and new providers appear, the list of supported properties can be extended.

The following properties are currently supported:

• ContactPerson
• OrganizationName
• OrganizationDisplayName
• OrganizationURL
• OrganizationLang

Start Method (SAMLIdPServer Module)

Starts the IdP server.

Syntax

• Swift
• Objective-C

public func start() throws -> Void

- (void)start;

Remarks

Use this method to start listening for incoming connections.

Stop Method (SAMLIdPServer Module)

Stops the IdP server.

Syntax

• Swift
• Objective-C

public func stop() throws -> Void

- (void)stop;

Remarks

Call this method to stop listening for incoming connections.

Accept Event (SAMLIdPServer Module)

Reports an incoming connection.

Syntax

• Swift
• Objective-C

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.

AssertionCreated Event (SAMLIdPServer Module)

Notifies the application about the creation of a new assertion.

Syntax

• Swift
• Objective-C

func onAssertionCreated(connectionID: Int64, assertionOrigin: Int32, assertionType: String, content: inout String)

- (void)onAssertionCreated:(long long)connectionID :(int)assertionOrigin :(NSString*)assertionType :(NSString**)content;

Remarks

Use this event to track the creation of a new SAML assertion (upon request from the browser or the SP).

The ConnectionID identifies the connection that requested the assertion. AssertionOrigin and AssertionType specify the type of assertion that was prepared and its disposition, and Content contains the body of the assertion. You can alter the body if required, but please keep in mind that changes may invalidate signed assertions.

AssertionReceived Event (SAMLIdPServer Module)

Notifies the application about the receipt of an assertion.

Syntax

• Swift
• Objective-C

func onAssertionReceived(connectionID: Int64, assertionOrigin: Int32, content: inout String)

- (void)onAssertionReceived:(long long)connectionID :(int)assertionOrigin :(NSString**)content;

Remarks

Use this event to track the receipt of a SAML assertion from the remote party.

The ConnectionID identifies the connection that requested the assertion. AssertionOrigin specifies the disposition of the assertion, and Content contains its body. You can alter the body if required, but please keep in mind that changes may invalidate signed assertions.

Connect Event (SAMLIdPServer Module)

Reports an accepted connection.

Syntax

• Swift
• Objective-C

func onConnect(connectionId: Int64, remoteAddress: String, remotePort: Int32)

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

Fires to report a disconnected client.

Syntax

• Swift
• Objective-C

func onDisconnect(connectionID: Int64)

- (void)onDisconnect:(long long)connectionID;

Remarks

The class fires this event when a connected client disconnects.

Error Event (SAMLIdPServer Module)

Information about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

The event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the section.

ExternalSign Event (SAMLIdPServer Module)

Handles remote or external signing initiated by the server protocol.

Syntax

• Swift
• Objective-C

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 class via the SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.

The class uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

MetadataRequest Event (SAMLIdPServer Module)

Notifies the application about the metadata request.

Syntax

• Swift
• Objective-C

func onMetadataRequest(connectionID: Int64, metadata: inout String)

- (void)onMetadataRequest:(long long)connectionID :(NSString**)metadata;

Remarks

The class uses this event to notify the application about an incoming metadata request. The suggested metadata text is provided through the Metadata parameter. The application can adjust it as required if it needs to.

Notification Event (SAMLIdPServer Module)

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

Syntax

• Swift
• Objective-C

func onNotification(eventID: String, eventParam: String)

- (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 class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

SessionClosed Event (SAMLIdPServer Module)

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

Syntax

• Swift
• Objective-C

func onSessionClosed(connectionID: Int64)

- (void)onSessionClosed:(long long)connectionID;

Remarks

ConnectionID contains the identifier of the closed session.

SessionEstablished Event (SAMLIdPServer Module)

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

Syntax

• Swift
• Objective-C

func onSessionEstablished(connectionID: Int64, username: String)

- (void)onSessionEstablished:(long long)connectionID :(NSString*)username;

Remarks

ConnectionID contains the identifier of the new session, Username specifies the client's address and Username.

VerifyCredentials Event (SAMLIdPServer Module)

Passes user credentials to the application for verification.

Syntax

• Swift
• Objective-C

func onVerifyCredentials(connectionID: Int64, username: String, password: String, body: String, accept: inout Bool)

- (void)onVerifyCredentials:(long long)connectionID :(NSString*)username :(NSString*)password :(NSString*)body :(int*)accept;

Remarks

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

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

Certificate Type

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

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.

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

Constructors

public init()

Creates a new ExternalCrypto object with default field values.

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

Constructors

public init()

Creates a new SocketSettings object.

TLSSettings Type

A container for TLS connection settings.

Remarks

The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.

Fields

Constructors

public init()

Creates a new TLSSettings object.

Config Settings (SAMLIdPServer Module)

SAMLIdPServer Config Settings

Base Config Settings

Trappable Errors (SAMLIdPServer Module)

SAMLIdPServer Errors