SAMLWriter Module
Properties Methods Events Config Settings Errors
The SAMLWriter module offers SAML message generation functions.
Syntax
SecureBlackbox.Samlwriter
Remarks
SAMLWriter provides means of serialization of SAML entities into valid SAML protocol messages. Together with SAMLReader, this class provides fine-grained access to the composition of SAML requests, responses, assertions, and statements. You can use it as part of your SAML client or SAML server implementation for creating individual SAML entities.
SAMLReader and SAMLWriter are independent of SAML server controls that are also included in SecureBlackbox, and are aimed at scenarios that require lower-level access to SAML functionality than that provided by the server controls.
SAMLWriter can create the following kinds of SAML messages:
- AssertionIDRequest
- SubjectQuery
- AuthnQuery
- AttributeQuery
- AuthzDecisionQuery
- AuthnRequest
- ManageNameIDRequest
- LogoutRequest
- NameIDMappingRequest
- ArtifactResolve
- Response
Please find below a quick-and-dirty example of the use of SAMLWriter class for creating a signed AuthnRequest message:
Samlwriter writer = new Samlwriter();
// configuring general message properties
writer.Destination = "http://destination-url.com";
writer.IssueInstant = DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ss.fffZ");
writer.Issuer = "Value=https://issuer-url.com;Format=urn:oasis:names:tc:SAML:2.0:nameid-format:entity;IDType=Issuer";
// configuring general AuthnRequest properties
writer.AuthnRequest.IsPassive = false;
writer.AuthnRequest.UseIsPassive = true;
writer.AuthnRequest.ForceAuthn = true;
writer.AuthnRequest.ProtocolBinding = "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST";
writer.AuthnRequest.AssertionConsumerServiceURL = "https://assertion-consumer-url.com";
writer.AuthnRequest.AttributeConsumingServiceIndex = 1;
writer.AuthnRequest.NameIDPolicyAllowCreate = false;
writer.AuthnRequest.NameIDPolicyFormat = "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent";
writer.AuthnRequest.ConditionsNotBefore = DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ss.fffZ");
writer.AuthnRequest.ConditionsNotOnOrAfter = DateTime.UtcNow.AddMinutes(30).ToString("yyyy-MM-ddTHH:mm:ss.fffZ");
// adjusting request conditions if required
SAMLAssertionCondition cond = new SAMLAssertionCondition();
cond.ConditionType = SAMLConditionTypes.csctOneTimeUse;
writer.AuthnRequestConditions.Add(cond);
// configuring signing properties
Certificate certificate = new Certificate("C:\\Certs\\samlCert.pfx", "password");
writer.Sign = true;
writer.SigningCertificate = certificate;
// creating the SAML entity of the required type
writer.CreateNew((int)SamlwriterOutputTypes.cstyAuthnRequest);
// adjusting low-level signature parameters
writer.Config("SigDigestMethod=http://www.w3.org/2001/04/xmlenc#sha256");
writer.Config("SigMethod=http://www.w3.org/2001/04/xmldsig-more#rsa-sha256");
// signing the request and serializing it to XML
string request = writer.Save();
The above code produces the following AuthnRequest:
<samlp:AuthnRequest
xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion" ID="53GhrzQ5f89fu214ANAR" Version="2.0"
IssueInstant="2021-12-15T10:39:31Z" Destination="http://destination-url.com" IsPassive="false"
ProtocolBinding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"
AssertionConsumerServiceURL="https://assertion-consumer-url.com" AttributeConsumingServiceIndex="1"
xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol">
<saml:Issuer Format="urn:oasis:names:tc:SAML:2.0:nameid-format:entity">https://issuer-url.com</saml:Issuer>
<ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
<ds:SignedInfo>
<ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
<ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/>
<ds:Reference URI="#53GhrzQ5f89fu214ANAR">
<ds:Transforms>
<ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/>
<ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
</ds:Transforms>
<ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/><ds:DigestValue>+xhhgXtwYN0/r9h7WAwg=</ds:DigestValue>
</ds:Reference>
</ds:SignedInfo>
<ds:SignatureValue>
jfYeIq/z8D1tJZYbVqDMoqKpdrfGMj8/zI7gbUsJbECAr00cN34md2QG0mo4cOx7pny+5
Tht7tUzqENHqcZdmlOcZc2JcJqokVxIcLEluFiWKlNjpexkXFQKzOC1peRfTZm8SQTqtP
Cz8IknLUc6Scfml29PHmks1PxjJDteGb/+FggsZRTGZC3a05nvH3ayvHukPeHuHssx5dX
nj0quT8salR6fdx6lAJo/AnDHzcfBNyxAMn+ebk5VOOgVD1L3PayvXib/maj8aVI2I5UT
o4vmfybTWKzeS8DX9We7UV+4Xowwe647t1A912xLVub/e23A18Yf1V0PXC87kttTkA==
</ds:SignatureValue>
<ds:KeyInfo>
<ds:X509Data><ds:X509Certificate>
MIIEKDCCAxCgAwIBAgIFYA3A3gIwDQYJKoZIhvcNAQELBQAwfjELMAkGA1UEBhMCVVMxC
zAJBgNVBAgTAk5DMRQwEgYDVQQHEwtDaGFwZWwgSGlsbDEiMCAGCSqGSIb3DQEJARMTc2
FsZXNAbnNvZnR3YXJlLmNvbTEoMCYGA1UEAxMfU2VjdXJlQmxhY2tib3ggRGVtbyBDZXJ
0aWZpY2F0ZTAeFw0xNzA5MDEwMDAwMDBaFw0yMjA5MDEwMDAwMDBaMH4xCzAJBgNVBAYT
AlVTMQswCQYDVQQIEwJOQzEUMBIGA1UEBxMLQ2hhcGVsIEhpbGwxIjAgBgkqhkiG9w0BC
QETE3NhbGVzQG5zb2Z0d2FyZS5jb20xKDAmBgNVBAMTH1NlY3VyZUJsYWNrYm94IERlbW
8gQ2VydGlmaWNhdGUwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCfAVIcq9o
eoIbw56LsPjxWsX3YGkqasBQzgQymhfcDZeSvFKFis8iqArGLTUUWOaImO5t2UmjIa+4n
YP39hb9Z1r0CMy53p83oYbbZZ7qMeji0pMAufJHqKCN8t2HNWf2HE8S9UOU7R/UHdrSAN
JitBKV9lSG9f450yWoGNwt35ZCsOp0zqtCgvkEvteGsz01R5DDjOccs3QNu25K/Sf27KP
CYabS6A1ehYNY/G32qoKNJhu3DN4bWje57gBWi9WSfQ3tZUOV5q2ozaNJA78Wl4fXC6RB
CaBh0GOwXeyZoH13LJdn+lqlCSMz024ImG4yFQEENbWvE9Elku8RYTn73AgMBAAGjgaww
gakwHwYDVR0jBBgwFoAUmt/L7GI1SH36Sp8EUBxTwuzSgqMwHQYDVR0OBBYEFJrfy+xiN
Uh9+kqfBFAcU8Ls0oKjMA8GA1UdEwEB/wQFMAMBAf8wDwYDVR0PAQH/BAUDAwDuADBFBg
NVHSUEPjA8BggrBgEFBQcDAQYIKwYBBQUHAwIGCCsGAQUFBwMDBggrBgEFBQcDBAYIKwY
BBQUHAwgGCCsGAQUFBwMJMA0GCSqGSIb3DQEBCwUAA4IBAQBovHBbMsW/k/5iuLQQqsYS
ng5X2iy1W+5BRb1hz0MGnHGLqJWy1ty5+bTo6g/zvT65dXIPIexLkInEenYSy75Lthr6a
ewUcvwfl1TYXjWlMD5Nm5pM9As71+XsGSdYGXoKohbEzbT6RDByjwR+yxtatqko7e1Eg6
InNJRTRt7al/63FSPEgSCqOX6asDVDNZ83db0dOcoeaPEiDz3liE3+tYHtKXj5/qwTtYd
aqBZxdJfuCKZveEFe1DO3/ayDvIvG9Eme+rEjntErF+Cw9a8ukesvDuT49cRE9oTs3O7f
6LUbhCv5zJN+dTFr75NSdWdp4yvn3nK3i2udeMnTWK0U
</ds:X509Certificate></ds:X509Data>
</ds:KeyInfo>
</ds:Signature>
<samlp:NameIDPolicy Format="urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"/>
<saml:Conditions NotBefore="2021-12-15T10:39:31Z" NotOnOrAfter="2021-12-15T11:09:31Z"><saml:OneTimeUse/></saml:Conditions>
</samlp:AuthnRequest>
Note that you need to set the signing certificate before calling CreateNew.
Property List
The following is the full list of the properties of the module with short descriptions. Click on the links for further details.
| AddXMLHeader | Controls the inclusion of an XML header in the message. |
| Artifact | Provides access to the Artifact element of the message. |
| ArtifactResolveQuery | Contains the artifact resolve query. |
| AssertionAttributes | Contains a list of assertion attributes. |
| AssertionConditions | Contains a list of assertion conditions. |
| AssertionCount | Returns the number of assertions in the message. |
| AssertionIDRequest | Contains the properties of AssertionIDRequest element. |
| AssertionInfo | Contains assertion information. |
| AssertionIssuer | Specifies the assertion issuer. |
| AssertionStatements | Contains assertion statements. |
| AssertionSubjectConfirmations | Provides access to assertion SubjectConfirmations list. |
| AssertionSubjectID | Specifies the assertion subject ID. |
| AttrQueryAttributes | Contains a list of attribute query attributes. |
| AuthnQuery | Provides access to the AuthnQuery SAML element. |
| AuthnRequest | Publishes the properties of AuthnRequest element. |
| AuthnRequestConditions | Contains a list of AuthnRequest conditions. |
| AuthnRequestScopingIDPList | Provides access to the list of scoping IDP eleements. |
| AuthzDecisionQuery | Provides access to AuthzDecisionQuery element. |
| Binding | Specifies the type of the binding to use. |
| Consent | Contains the Consent parameter of the request. |
| Destination | Contains the Destination parameter of the SAML object. |
| EncryptionCertificate | Sets the encryption certificate. |
| FIPSMode | Reserved. |
| ID | The ID of the request. |
| InResponseTo | Contains the InResponseTo property of the SAML request. |
| IssueInstant | Contains request issuance timestamp. |
| Issuer | Sets the issuer of the message. |
| LogoutRequest | Contains the properties of SAML LogoutRequest element. |
| ManageNameIDRequest | Provides access to ManageNameIDRequest element. |
| NameIDMappingRequest | Publishes the properties of NameIDMappingRequest entity. |
| OutputType | Returns the SAML type of message being created. |
| POSTBinding | Exposes the POST binding properties. |
| Profile | Specifies a pre-defined profile to apply when creating the signature. |
| RedirectBinding | Publishes the redirect binding settings. |
| RedirectBindingCertificate | Contains a certificate to sign the redirect binding. |
| Response | Provides access to the SAML response object properties. |
| SigCanonicalizationMethod | The canonicalization method to use in the signature. |
| SigDigestMethod | The digest method to use. |
| SigMethod | The signature method to use. |
| Sign | Specifies whether the created SAML message should be signed. |
| SigningCertificate | The certificate to be used for signing. |
| SigningChain | The signing certificate chain. |
| SubjectConfirmations | Provides access to the list of subject confirmation elements. |
| SubjectID | Sets the subject of the message. |
| Version | Specifies the protocol version of the SAML message. |
Method List
The following is the full list of the methods of the module with short descriptions. Click on the links for further details.
| AddAdviceAssertion | Adds an advice assertion to the message. |
| AddAssertion | Adds assertion to a SAML message. |
| ClearAssertion | Resets the contents of all assertion-related properties. |
| CompareIDs | Compares two SAML IDs. |
| Config | Sets or retrieves a configuration setting. |
| CreateNew | Creates a new SAML message with the given type. |
| DoAction | Performs an additional action. |
| GetIDProp | Returns an element of the SAML ID. |
| RemoveAdvice | Removes an advice from an assertion. |
| RemoveAdviceAssertion | Removes an advice from an assertion. |
| RemoveAllAssertions | Removes all assertions currently configured in the message. |
| RemoveAssertion | Removes an assertion from the message. |
| Save | Saves the configured message to a string. |
| SaveBytes | Saves the configured message to a byte array. |
| SaveFile | Saves the configured message to a file. |
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.
| Error | Fires to report an error condition. |
| Notification | This event notifies the application about an underlying control flow event. |
Config Settings
The following is a list of config settings for the module with short descriptions. Click on the links for further details.
| IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
| SigAfterIssuer | Specifies whether to insert the signature after the issuer tag in the SAML document. |
| TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
| UseMicrosoftCTL | Enables or disables automatic use of Microsoft online certificate trust list. |
| UseSystemCertificates | Enables or disables the use of the system certificates. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the module (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| 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. |
| 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. |
AddXMLHeader Property (SAMLWriter Module)
Controls the inclusion of an XML header in the message.
Syntax
public var addXMLHeader: Bool { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=addXMLHeader,setter=setAddXMLHeader:) BOOL addXMLHeader; - (BOOL)addXMLHeader; - (void)setAddXMLHeader :(BOOL)newAddXMLHeader;
Default Value
False
Remarks
Use this property to enable or disable inclusion of the XML header in the SAML message.
Artifact Property (SAMLWriter Module)
Provides access to the Artifact element of the message.
Syntax
public var artifact: SAMLArtifact { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=artifactEndpointIndex,setter=setArtifactEndpointIndex:) int artifactEndpointIndex; - (int)artifactEndpointIndex; - (void)setArtifactEndpointIndex :(int)newArtifactEndpointIndex; @property (nonatomic,readwrite,assign,getter=artifactMessageHandle,setter=setArtifactMessageHandle:) NSData* artifactMessageHandle; - (NSData*)artifactMessageHandle; - (void)setArtifactMessageHandle :(NSData*)newArtifactMessageHandle; @property (nonatomic,readonly,assign,getter=artifactRemainingArtifact) NSData* artifactRemainingArtifact; - (NSData*)artifactRemainingArtifact; @property (nonatomic,readwrite,assign,getter=artifactSourceID,setter=setArtifactSourceID:) NSData* artifactSourceID; - (NSData*)artifactSourceID; - (void)setArtifactSourceID :(NSData*)newArtifactSourceID; @property (nonatomic,readwrite,assign,getter=artifactTypeCode,setter=setArtifactTypeCode:) int artifactTypeCode; - (int)artifactTypeCode; - (void)setArtifactTypeCode :(int)newArtifactTypeCode; @property (nonatomic,readwrite,assign,getter=artifactURI,setter=setArtifactURI:) NSString* artifactURI; - (NSString*)artifactURI; - (void)setArtifactURI :(NSString*)newArtifactURI;
Default Value
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
ArtifactResolveQuery Property (SAMLWriter Module)
Contains the artifact resolve query.
Syntax
public var artifactResolveQuery: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=artifactResolveQuery,setter=setArtifactResolveQuery:) NSString* artifactResolveQuery; - (NSString*)artifactResolveQuery; - (void)setArtifactResolveQuery :(NSString*)newArtifactResolveQuery;
Default Value
""
Remarks
Use this property to read or set the artifact resolve query.
AssertionAttributes Property (SAMLWriter Module)
Contains a list of assertion attributes.
Syntax
public var assertionAttributes: Array<SAMLAttribute> { get {...} }
@property (nonatomic,readwrite,assign,getter=assertionAttrCount,setter=setAssertionAttrCount:) int assertionAttrCount; - (int)assertionAttrCount; - (void)setAssertionAttrCount :(int)newAssertionAttrCount; - (NSString*)assertionAttrFriendlyName:(int)assertionAttrIndex; - (void)setAssertionAttrFriendlyName:(int)assertionAttrIndex :(NSString*)newAssertionAttrFriendlyName; - (NSString*)assertionAttrName:(int)assertionAttrIndex; - (void)setAssertionAttrName:(int)assertionAttrIndex :(NSString*)newAssertionAttrName; - (NSString*)assertionAttrNameFormat:(int)assertionAttrIndex; - (void)setAssertionAttrNameFormat:(int)assertionAttrIndex :(NSString*)newAssertionAttrNameFormat; - (int)assertionAttrStatementIndex:(int)assertionAttrIndex; - (void)setAssertionAttrStatementIndex:(int)assertionAttrIndex :(int)newAssertionAttrStatementIndex; - (NSString*)assertionAttrValues:(int)assertionAttrIndex; - (void)setAssertionAttrValues:(int)assertionAttrIndex :(NSString*)newAssertionAttrValues;
Default Value
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
AssertionConditions Property (SAMLWriter Module)
Contains a list of assertion conditions.
Syntax
public var assertionConditions: Array<SAMLAssertionCondition> { get {...} }
@property (nonatomic,readwrite,assign,getter=assertionConditionCount,setter=setAssertionConditionCount:) int assertionConditionCount; - (int)assertionConditionCount; - (void)setAssertionConditionCount :(int)newAssertionConditionCount; - (NSString*)assertionConditionAudienceList:(int)assertionConditionIndex; - (void)setAssertionConditionAudienceList:(int)assertionConditionIndex :(NSString*)newAssertionConditionAudienceList; - (int)assertionConditionConditionType:(int)assertionConditionIndex; - (void)setAssertionConditionConditionType:(int)assertionConditionIndex :(int)newAssertionConditionConditionType; - (int)assertionConditionProxyRestrictionCount:(int)assertionConditionIndex; - (void)setAssertionConditionProxyRestrictionCount:(int)assertionConditionIndex :(int)newAssertionConditionProxyRestrictionCount;
Default Value
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
AssertionCount Property (SAMLWriter Module)
Returns the number of assertions in the message.
Syntax
public var assertionCount: Int32 { get {...} }
@property (nonatomic,readonly,assign,getter=assertionCount) int assertionCount; - (int)assertionCount;
Default Value
0
Remarks
This property returns the total number of assertions currently defined in the SAML message.
This property is read-only.
AssertionIDRequest Property (SAMLWriter Module)
Contains the properties of AssertionIDRequest element.
Syntax
public var assertionIDRequest: SAMLAssertionIDRequest { get {...} }
@property (nonatomic,readwrite,assign,getter=assertionIDRequestReferences,setter=setAssertionIDRequestReferences:) NSString* assertionIDRequestReferences; - (NSString*)assertionIDRequestReferences; - (void)setAssertionIDRequestReferences :(NSString*)newAssertionIDRequestReferences;
Default Value
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
AssertionInfo Property (SAMLWriter Module)
Contains assertion information.
Syntax
public var assertionInfo: SAMLAssertionInfo { get {...} }
@property (nonatomic,readwrite,assign,getter=assertionInfoAdviceAssertionCount,setter=setAssertionInfoAdviceAssertionCount:) int assertionInfoAdviceAssertionCount; - (int)assertionInfoAdviceAssertionCount; - (void)setAssertionInfoAdviceAssertionCount :(int)newAssertionInfoAdviceAssertionCount; @property (nonatomic,readwrite,assign,getter=assertionInfoAssertionType,setter=setAssertionInfoAssertionType:) int assertionInfoAssertionType; - (int)assertionInfoAssertionType; - (void)setAssertionInfoAssertionType :(int)newAssertionInfoAssertionType; @property (nonatomic,readonly,assign,getter=assertionInfoChainValidationDetails) int assertionInfoChainValidationDetails; - (int)assertionInfoChainValidationDetails; @property (nonatomic,readonly,assign,getter=assertionInfoChainValidationResult) int assertionInfoChainValidationResult; - (int)assertionInfoChainValidationResult; @property (nonatomic,readwrite,assign,getter=assertionInfoConditionsNotBefore,setter=setAssertionInfoConditionsNotBefore:) NSString* assertionInfoConditionsNotBefore; - (NSString*)assertionInfoConditionsNotBefore; - (void)setAssertionInfoConditionsNotBefore :(NSString*)newAssertionInfoConditionsNotBefore; @property (nonatomic,readwrite,assign,getter=assertionInfoConditionsNotOnOrAfter,setter=setAssertionInfoConditionsNotOnOrAfter:) NSString* assertionInfoConditionsNotOnOrAfter; - (NSString*)assertionInfoConditionsNotOnOrAfter; - (void)setAssertionInfoConditionsNotOnOrAfter :(NSString*)newAssertionInfoConditionsNotOnOrAfter; @property (nonatomic,readwrite,assign,getter=assertionInfoEncryptedContent,setter=setAssertionInfoEncryptedContent:) NSString* assertionInfoEncryptedContent; - (NSString*)assertionInfoEncryptedContent; - (void)setAssertionInfoEncryptedContent :(NSString*)newAssertionInfoEncryptedContent; @property (nonatomic,readwrite,assign,getter=assertionInfoID,setter=setAssertionInfoID:) NSString* assertionInfoID; - (NSString*)assertionInfoID; - (void)setAssertionInfoID :(NSString*)newAssertionInfoID; @property (nonatomic,readwrite,assign,getter=assertionInfoIDRef,setter=setAssertionInfoIDRef:) NSString* assertionInfoIDRef; - (NSString*)assertionInfoIDRef; - (void)setAssertionInfoIDRef :(NSString*)newAssertionInfoIDRef; @property (nonatomic,readwrite,assign,getter=assertionInfoIssueInstant,setter=setAssertionInfoIssueInstant:) NSString* assertionInfoIssueInstant; - (NSString*)assertionInfoIssueInstant; - (void)setAssertionInfoIssueInstant :(NSString*)newAssertionInfoIssueInstant; @property (nonatomic,readonly,assign,getter=assertionInfoSignatureValidationResult) int assertionInfoSignatureValidationResult; - (int)assertionInfoSignatureValidationResult; @property (nonatomic,readwrite,assign,getter=assertionInfoSigned,setter=setAssertionInfoSigned:) BOOL assertionInfoSigned; - (BOOL)assertionInfoSigned; - (void)setAssertionInfoSigned :(BOOL)newAssertionInfoSigned; @property (nonatomic,readwrite,assign,getter=assertionInfoURIRef,setter=setAssertionInfoURIRef:) NSString* assertionInfoURIRef; - (NSString*)assertionInfoURIRef; - (void)setAssertionInfoURIRef :(NSString*)newAssertionInfoURIRef; @property (nonatomic,readonly,assign,getter=assertionInfoValidationLog) NSString* assertionInfoValidationLog; - (NSString*)assertionInfoValidationLog; @property (nonatomic,readwrite,assign,getter=assertionInfoVersion,setter=setAssertionInfoVersion:) NSString* assertionInfoVersion; - (NSString*)assertionInfoVersion; - (void)setAssertionInfoVersion :(NSString*)newAssertionInfoVersion;
Default Value
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
AssertionIssuer Property (SAMLWriter Module)
Specifies the assertion issuer.
Syntax
public var assertionIssuer: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=assertionIssuer,setter=setAssertionIssuer:) NSString* assertionIssuer; - (NSString*)assertionIssuer; - (void)setAssertionIssuer :(NSString*)newAssertionIssuer;
Default Value
""
Remarks
Use this property to provide the assertion issuer ID.
AssertionStatements Property (SAMLWriter Module)
Contains assertion statements.
Syntax
public var assertionStatements: Array<SAMLAssertionStatement> { get {...} }
@property (nonatomic,readwrite,assign,getter=assertionStatementCount,setter=setAssertionStatementCount:) int assertionStatementCount; - (int)assertionStatementCount; - (void)setAssertionStatementCount :(int)newAssertionStatementCount; - (NSString*)assertionStatementAttributes:(int)assertionStatementIndex; - (void)setAssertionStatementAttributes:(int)assertionStatementIndex :(NSString*)newAssertionStatementAttributes; - (NSString*)assertionStatementAuthnContextAuthenticatingAuthorities:(int)assertionStatementIndex; - (void)setAssertionStatementAuthnContextAuthenticatingAuthorities:(int)assertionStatementIndex :(NSString*)newAssertionStatementAuthnContextAuthenticatingAuthorities; - (NSString*)assertionStatementAuthnContextChoice:(int)assertionStatementIndex; - (void)setAssertionStatementAuthnContextChoice:(int)assertionStatementIndex :(NSString*)newAssertionStatementAuthnContextChoice; - (NSString*)assertionStatementAuthnContextClassRef:(int)assertionStatementIndex; - (void)setAssertionStatementAuthnContextClassRef:(int)assertionStatementIndex :(NSString*)newAssertionStatementAuthnContextClassRef; - (NSString*)assertionStatementAuthnContextDecl:(int)assertionStatementIndex; - (void)setAssertionStatementAuthnContextDecl:(int)assertionStatementIndex :(NSString*)newAssertionStatementAuthnContextDecl; - (NSString*)assertionStatementAuthnContextDeclRef:(int)assertionStatementIndex; - (void)setAssertionStatementAuthnContextDeclRef:(int)assertionStatementIndex :(NSString*)newAssertionStatementAuthnContextDeclRef; - (NSString*)assertionStatementAuthnInstant:(int)assertionStatementIndex; - (void)setAssertionStatementAuthnInstant:(int)assertionStatementIndex :(NSString*)newAssertionStatementAuthnInstant; - (NSString*)assertionStatementAuthnSessionIndex:(int)assertionStatementIndex; - (void)setAssertionStatementAuthnSessionIndex:(int)assertionStatementIndex :(NSString*)newAssertionStatementAuthnSessionIndex; - (NSString*)assertionStatementAuthnSessionNotOnOrAfter:(int)assertionStatementIndex; - (void)setAssertionStatementAuthnSessionNotOnOrAfter:(int)assertionStatementIndex :(NSString*)newAssertionStatementAuthnSessionNotOnOrAfter; - (NSString*)assertionStatementAuthnSubjectLocalityAddress:(int)assertionStatementIndex; - (void)setAssertionStatementAuthnSubjectLocalityAddress:(int)assertionStatementIndex :(NSString*)newAssertionStatementAuthnSubjectLocalityAddress; - (NSString*)assertionStatementAuthnSubjectLocalityDNSName:(int)assertionStatementIndex; - (void)setAssertionStatementAuthnSubjectLocalityDNSName:(int)assertionStatementIndex :(NSString*)newAssertionStatementAuthnSubjectLocalityDNSName; - (NSString*)assertionStatementAuthzActions:(int)assertionStatementIndex; - (void)setAssertionStatementAuthzActions:(int)assertionStatementIndex :(NSString*)newAssertionStatementAuthzActions; - (int)assertionStatementAuthzDecision:(int)assertionStatementIndex; - (void)setAssertionStatementAuthzDecision:(int)assertionStatementIndex :(int)newAssertionStatementAuthzDecision; - (NSString*)assertionStatementAuthzDecisionEvidence:(int)assertionStatementIndex; - (void)setAssertionStatementAuthzDecisionEvidence:(int)assertionStatementIndex :(NSString*)newAssertionStatementAuthzDecisionEvidence; - (NSString*)assertionStatementAuthzDecisionResource:(int)assertionStatementIndex; - (void)setAssertionStatementAuthzDecisionResource:(int)assertionStatementIndex :(NSString*)newAssertionStatementAuthzDecisionResource; - (int)assertionStatementStatementType:(int)assertionStatementIndex; - (void)setAssertionStatementStatementType:(int)assertionStatementIndex :(int)newAssertionStatementStatementType;
Default Value
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
AssertionSubjectConfirmations Property (SAMLWriter Module)
Provides access to assertion SubjectConfirmations list.
Syntax
public var assertionSubjectConfirmations: Array<SAMLSubjectConfirmation> { get {...} }
@property (nonatomic,readwrite,assign,getter=assertionSubjectConfirmationCount,setter=setAssertionSubjectConfirmationCount:) int assertionSubjectConfirmationCount; - (int)assertionSubjectConfirmationCount; - (void)setAssertionSubjectConfirmationCount :(int)newAssertionSubjectConfirmationCount; - (NSString*)assertionSubjectConfirmationDataAddress:(int)assertionSubjectConfirmationIndex; - (void)setAssertionSubjectConfirmationDataAddress:(int)assertionSubjectConfirmationIndex :(NSString*)newAssertionSubjectConfirmationDataAddress; - (NSString*)assertionSubjectConfirmationDataInResponseTo:(int)assertionSubjectConfirmationIndex; - (void)setAssertionSubjectConfirmationDataInResponseTo:(int)assertionSubjectConfirmationIndex :(NSString*)newAssertionSubjectConfirmationDataInResponseTo; - (NSString*)assertionSubjectConfirmationDataNotBefore:(int)assertionSubjectConfirmationIndex; - (void)setAssertionSubjectConfirmationDataNotBefore:(int)assertionSubjectConfirmationIndex :(NSString*)newAssertionSubjectConfirmationDataNotBefore; - (NSString*)assertionSubjectConfirmationDataNotOnOrAfter:(int)assertionSubjectConfirmationIndex; - (void)setAssertionSubjectConfirmationDataNotOnOrAfter:(int)assertionSubjectConfirmationIndex :(NSString*)newAssertionSubjectConfirmationDataNotOnOrAfter; - (NSString*)assertionSubjectConfirmationDataRecipient:(int)assertionSubjectConfirmationIndex; - (void)setAssertionSubjectConfirmationDataRecipient:(int)assertionSubjectConfirmationIndex :(NSString*)newAssertionSubjectConfirmationDataRecipient; - (NSString*)assertionSubjectConfirmationDataType:(int)assertionSubjectConfirmationIndex; - (void)setAssertionSubjectConfirmationDataType:(int)assertionSubjectConfirmationIndex :(NSString*)newAssertionSubjectConfirmationDataType; - (NSString*)assertionSubjectConfirmationID:(int)assertionSubjectConfirmationIndex; - (void)setAssertionSubjectConfirmationID:(int)assertionSubjectConfirmationIndex :(NSString*)newAssertionSubjectConfirmationID; - (NSString*)assertionSubjectConfirmationMethod:(int)assertionSubjectConfirmationIndex; - (void)setAssertionSubjectConfirmationMethod:(int)assertionSubjectConfirmationIndex :(NSString*)newAssertionSubjectConfirmationMethod;
Default Value
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
AssertionSubjectID Property (SAMLWriter Module)
Specifies the assertion subject ID.
Syntax
public var assertionSubjectID: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=assertionSubjectID,setter=setAssertionSubjectID:) NSString* assertionSubjectID; - (NSString*)assertionSubjectID; - (void)setAssertionSubjectID :(NSString*)newAssertionSubjectID;
Default Value
""
Remarks
Use this property to provide the assertion's subject SAML ID.
AttrQueryAttributes Property (SAMLWriter Module)
Contains a list of attribute query attributes.
Syntax
public var attrQueryAttributes: Array<SAMLAttribute> { get {...} }
@property (nonatomic,readwrite,assign,getter=attrQueryAttrCount,setter=setAttrQueryAttrCount:) int attrQueryAttrCount; - (int)attrQueryAttrCount; - (void)setAttrQueryAttrCount :(int)newAttrQueryAttrCount; - (NSString*)attrQueryAttrFriendlyName:(int)attrQueryAttrIndex; - (void)setAttrQueryAttrFriendlyName:(int)attrQueryAttrIndex :(NSString*)newAttrQueryAttrFriendlyName; - (NSString*)attrQueryAttrName:(int)attrQueryAttrIndex; - (void)setAttrQueryAttrName:(int)attrQueryAttrIndex :(NSString*)newAttrQueryAttrName; - (NSString*)attrQueryAttrNameFormat:(int)attrQueryAttrIndex; - (void)setAttrQueryAttrNameFormat:(int)attrQueryAttrIndex :(NSString*)newAttrQueryAttrNameFormat; - (int)attrQueryAttrStatementIndex:(int)attrQueryAttrIndex; - (void)setAttrQueryAttrStatementIndex:(int)attrQueryAttrIndex :(int)newAttrQueryAttrStatementIndex; - (NSString*)attrQueryAttrValues:(int)attrQueryAttrIndex; - (void)setAttrQueryAttrValues:(int)attrQueryAttrIndex :(NSString*)newAttrQueryAttrValues;
Default Value
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
AuthnQuery Property (SAMLWriter Module)
Provides access to the AuthnQuery SAML element.
Syntax
public var authnQuery: SAMLAuthnQuery { get {...} }
@property (nonatomic,readwrite,assign,getter=authnQueryComparison,setter=setAuthnQueryComparison:) int authnQueryComparison; - (int)authnQueryComparison; - (void)setAuthnQueryComparison :(int)newAuthnQueryComparison; @property (nonatomic,readwrite,assign,getter=authnQueryContextClassRefs,setter=setAuthnQueryContextClassRefs:) NSString* authnQueryContextClassRefs; - (NSString*)authnQueryContextClassRefs; - (void)setAuthnQueryContextClassRefs :(NSString*)newAuthnQueryContextClassRefs; @property (nonatomic,readwrite,assign,getter=authnQueryRefType,setter=setAuthnQueryRefType:) int authnQueryRefType; - (int)authnQueryRefType; - (void)setAuthnQueryRefType :(int)newAuthnQueryRefType; @property (nonatomic,readwrite,assign,getter=authnQuerySessionIndex,setter=setAuthnQuerySessionIndex:) NSString* authnQuerySessionIndex; - (NSString*)authnQuerySessionIndex; - (void)setAuthnQuerySessionIndex :(NSString*)newAuthnQuerySessionIndex;
Default Value
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
AuthnRequest Property (SAMLWriter Module)
Publishes the properties of AuthnRequest element.
Syntax
public var authnRequest: SAMLAuthnRequest { get {...} }
@property (nonatomic,readwrite,assign,getter=authnRequestAssertionConsumerServiceIndex,setter=setAuthnRequestAssertionConsumerServiceIndex:) int authnRequestAssertionConsumerServiceIndex; - (int)authnRequestAssertionConsumerServiceIndex; - (void)setAuthnRequestAssertionConsumerServiceIndex :(int)newAuthnRequestAssertionConsumerServiceIndex; @property (nonatomic,readwrite,assign,getter=authnRequestAssertionConsumerServiceURL,setter=setAuthnRequestAssertionConsumerServiceURL:) NSString* authnRequestAssertionConsumerServiceURL; - (NSString*)authnRequestAssertionConsumerServiceURL; - (void)setAuthnRequestAssertionConsumerServiceURL :(NSString*)newAuthnRequestAssertionConsumerServiceURL; @property (nonatomic,readwrite,assign,getter=authnRequestAttributeConsumingServiceIndex,setter=setAuthnRequestAttributeConsumingServiceIndex:) int authnRequestAttributeConsumingServiceIndex; - (int)authnRequestAttributeConsumingServiceIndex; - (void)setAuthnRequestAttributeConsumingServiceIndex :(int)newAuthnRequestAttributeConsumingServiceIndex; @property (nonatomic,readwrite,assign,getter=authnRequestConditionsNotBefore,setter=setAuthnRequestConditionsNotBefore:) NSString* authnRequestConditionsNotBefore; - (NSString*)authnRequestConditionsNotBefore; - (void)setAuthnRequestConditionsNotBefore :(NSString*)newAuthnRequestConditionsNotBefore; @property (nonatomic,readwrite,assign,getter=authnRequestConditionsNotOnOrAfter,setter=setAuthnRequestConditionsNotOnOrAfter:) NSString* authnRequestConditionsNotOnOrAfter; - (NSString*)authnRequestConditionsNotOnOrAfter; - (void)setAuthnRequestConditionsNotOnOrAfter :(NSString*)newAuthnRequestConditionsNotOnOrAfter; @property (nonatomic,readwrite,assign,getter=authnRequestContextClassRefs,setter=setAuthnRequestContextClassRefs:) NSString* authnRequestContextClassRefs; - (NSString*)authnRequestContextClassRefs; - (void)setAuthnRequestContextClassRefs :(NSString*)newAuthnRequestContextClassRefs; @property (nonatomic,readwrite,assign,getter=authnRequestContextComparison,setter=setAuthnRequestContextComparison:) int authnRequestContextComparison; - (int)authnRequestContextComparison; - (void)setAuthnRequestContextComparison :(int)newAuthnRequestContextComparison; @property (nonatomic,readwrite,assign,getter=authnRequestContextRefType,setter=setAuthnRequestContextRefType:) int authnRequestContextRefType; - (int)authnRequestContextRefType; - (void)setAuthnRequestContextRefType :(int)newAuthnRequestContextRefType; @property (nonatomic,readwrite,assign,getter=authnRequestForceAuthn,setter=setAuthnRequestForceAuthn:) BOOL authnRequestForceAuthn; - (BOOL)authnRequestForceAuthn; - (void)setAuthnRequestForceAuthn :(BOOL)newAuthnRequestForceAuthn; @property (nonatomic,readwrite,assign,getter=authnRequestIsPassive,setter=setAuthnRequestIsPassive:) BOOL authnRequestIsPassive; - (BOOL)authnRequestIsPassive; - (void)setAuthnRequestIsPassive :(BOOL)newAuthnRequestIsPassive; @property (nonatomic,readwrite,assign,getter=authnRequestNameIDPolicyAllowCreate,setter=setAuthnRequestNameIDPolicyAllowCreate:) BOOL authnRequestNameIDPolicyAllowCreate; - (BOOL)authnRequestNameIDPolicyAllowCreate; - (void)setAuthnRequestNameIDPolicyAllowCreate :(BOOL)newAuthnRequestNameIDPolicyAllowCreate; @property (nonatomic,readwrite,assign,getter=authnRequestNameIDPolicyFormat,setter=setAuthnRequestNameIDPolicyFormat:) NSString* authnRequestNameIDPolicyFormat; - (NSString*)authnRequestNameIDPolicyFormat; - (void)setAuthnRequestNameIDPolicyFormat :(NSString*)newAuthnRequestNameIDPolicyFormat; @property (nonatomic,readwrite,assign,getter=authnRequestNameIDPolicySPNameQualifier,setter=setAuthnRequestNameIDPolicySPNameQualifier:) NSString* authnRequestNameIDPolicySPNameQualifier; - (NSString*)authnRequestNameIDPolicySPNameQualifier; - (void)setAuthnRequestNameIDPolicySPNameQualifier :(NSString*)newAuthnRequestNameIDPolicySPNameQualifier; @property (nonatomic,readwrite,assign,getter=authnRequestNameIDPolicyUseAllowCreate,setter=setAuthnRequestNameIDPolicyUseAllowCreate:) BOOL authnRequestNameIDPolicyUseAllowCreate; - (BOOL)authnRequestNameIDPolicyUseAllowCreate; - (void)setAuthnRequestNameIDPolicyUseAllowCreate :(BOOL)newAuthnRequestNameIDPolicyUseAllowCreate; @property (nonatomic,readwrite,assign,getter=authnRequestProtocolBinding,setter=setAuthnRequestProtocolBinding:) NSString* authnRequestProtocolBinding; - (NSString*)authnRequestProtocolBinding; - (void)setAuthnRequestProtocolBinding :(NSString*)newAuthnRequestProtocolBinding; @property (nonatomic,readwrite,assign,getter=authnRequestProviderName,setter=setAuthnRequestProviderName:) NSString* authnRequestProviderName; - (NSString*)authnRequestProviderName; - (void)setAuthnRequestProviderName :(NSString*)newAuthnRequestProviderName; @property (nonatomic,readwrite,assign,getter=authnRequestScopingIDPListGetComplete,setter=setAuthnRequestScopingIDPListGetComplete:) NSString* authnRequestScopingIDPListGetComplete; - (NSString*)authnRequestScopingIDPListGetComplete; - (void)setAuthnRequestScopingIDPListGetComplete :(NSString*)newAuthnRequestScopingIDPListGetComplete; @property (nonatomic,readwrite,assign,getter=authnRequestScopingProxyCount,setter=setAuthnRequestScopingProxyCount:) int authnRequestScopingProxyCount; - (int)authnRequestScopingProxyCount; - (void)setAuthnRequestScopingProxyCount :(int)newAuthnRequestScopingProxyCount; @property (nonatomic,readwrite,assign,getter=authnRequestScopingRequesterIDs,setter=setAuthnRequestScopingRequesterIDs:) NSString* authnRequestScopingRequesterIDs; - (NSString*)authnRequestScopingRequesterIDs; - (void)setAuthnRequestScopingRequesterIDs :(NSString*)newAuthnRequestScopingRequesterIDs; @property (nonatomic,readwrite,assign,getter=authnRequestUseForceAuthn,setter=setAuthnRequestUseForceAuthn:) BOOL authnRequestUseForceAuthn; - (BOOL)authnRequestUseForceAuthn; - (void)setAuthnRequestUseForceAuthn :(BOOL)newAuthnRequestUseForceAuthn; @property (nonatomic,readwrite,assign,getter=authnRequestUseIsPassive,setter=setAuthnRequestUseIsPassive:) BOOL authnRequestUseIsPassive; - (BOOL)authnRequestUseIsPassive; - (void)setAuthnRequestUseIsPassive :(BOOL)newAuthnRequestUseIsPassive;
Default Value
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
AuthnRequestConditions Property (SAMLWriter Module)
Contains a list of AuthnRequest conditions.
Syntax
public var authnRequestConditions: Array<SAMLAssertionCondition> { get {...} }
@property (nonatomic,readwrite,assign,getter=authnRequestConditionCount,setter=setAuthnRequestConditionCount:) int authnRequestConditionCount; - (int)authnRequestConditionCount; - (void)setAuthnRequestConditionCount :(int)newAuthnRequestConditionCount; - (NSString*)authnRequestConditionAudienceList:(int)authnRequestConditionIndex; - (void)setAuthnRequestConditionAudienceList:(int)authnRequestConditionIndex :(NSString*)newAuthnRequestConditionAudienceList; - (int)authnRequestConditionConditionType:(int)authnRequestConditionIndex; - (void)setAuthnRequestConditionConditionType:(int)authnRequestConditionIndex :(int)newAuthnRequestConditionConditionType; - (int)authnRequestConditionProxyRestrictionCount:(int)authnRequestConditionIndex; - (void)setAuthnRequestConditionProxyRestrictionCount:(int)authnRequestConditionIndex :(int)newAuthnRequestConditionProxyRestrictionCount;
Default Value
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
AuthnRequestScopingIDPList Property (SAMLWriter Module)
Provides access to the list of scoping IDP eleements.
Syntax
public var authnRequestScopingIDPList: Array<SAMLIDPEntry> { get {...} }
@property (nonatomic,readwrite,assign,getter=authnRequestScopingIDPCount,setter=setAuthnRequestScopingIDPCount:) int authnRequestScopingIDPCount; - (int)authnRequestScopingIDPCount; - (void)setAuthnRequestScopingIDPCount :(int)newAuthnRequestScopingIDPCount; - (NSString*)authnRequestScopingIDPLoc:(int)authnRequestScopingIDPIndex; - (void)setAuthnRequestScopingIDPLoc:(int)authnRequestScopingIDPIndex :(NSString*)newAuthnRequestScopingIDPLoc; - (NSString*)authnRequestScopingIDPName:(int)authnRequestScopingIDPIndex; - (void)setAuthnRequestScopingIDPName:(int)authnRequestScopingIDPIndex :(NSString*)newAuthnRequestScopingIDPName; - (NSString*)authnRequestScopingIDPProviderID:(int)authnRequestScopingIDPIndex; - (void)setAuthnRequestScopingIDPProviderID:(int)authnRequestScopingIDPIndex :(NSString*)newAuthnRequestScopingIDPProviderID;
Default Value
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
AuthzDecisionQuery Property (SAMLWriter Module)
Provides access to AuthzDecisionQuery element.
Syntax
public var authzDecisionQuery: SAMLAuthzDecisionQuery { get {...} }
@property (nonatomic,readwrite,assign,getter=authzDecisionQueryActions,setter=setAuthzDecisionQueryActions:) NSString* authzDecisionQueryActions; - (NSString*)authzDecisionQueryActions; - (void)setAuthzDecisionQueryActions :(NSString*)newAuthzDecisionQueryActions; @property (nonatomic,readwrite,assign,getter=authzDecisionQueryResource,setter=setAuthzDecisionQueryResource:) NSString* authzDecisionQueryResource; - (NSString*)authzDecisionQueryResource; - (void)setAuthzDecisionQueryResource :(NSString*)newAuthzDecisionQueryResource;
Default Value
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
Binding Property (SAMLWriter Module)
Specifies the type of the binding to use.
Syntax
public var binding: SamlwriterBindings { get {...} set {...} }
public enum SamlwriterBindings: Int32 { case csbtNone = 0 case csbtSOAP = 1 case csbtPAOS = 2 case csbtRedirect = 3 case csbtPOST = 4 case csbtArtifact = 5 }
@property (nonatomic,readwrite,assign,getter=binding,setter=setBinding:) int binding; - (int)binding; - (void)setBinding :(int)newBinding;
Default Value
0
Remarks
Use this property to specify the binding type to use with the request.
Consent Property (SAMLWriter Module)
Contains the Consent parameter of the request.
Syntax
public var consent: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=consent,setter=setConsent:) NSString* consent; - (NSString*)consent; - (void)setConsent :(NSString*)newConsent;
Default Value
""
Remarks
Use this property to specify the Consent parameter of the SAML entity.
Destination Property (SAMLWriter Module)
Contains the Destination parameter of the SAML object.
Syntax
public var destination: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=destination,setter=setDestination:) NSString* destination; - (NSString*)destination; - (void)setDestination :(NSString*)newDestination;
Default Value
""
Remarks
Use this property to set the Destination parameter of the created SAML object.
EncryptionCertificate Property (SAMLWriter Module)
Sets the encryption certificate.
Syntax
public var encryptionCertificate: Certificate { get {...} set {...} }
@property (nonatomic,readonly,assign,getter=encryptionCertBytes) NSData* encryptionCertBytes; - (NSData*)encryptionCertBytes; @property (nonatomic,readwrite,assign,getter=encryptionCertHandle,setter=setEncryptionCertHandle:) long long encryptionCertHandle; - (long long)encryptionCertHandle; - (void)setEncryptionCertHandle :(long long)newEncryptionCertHandle;
Default Value
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
FIPSMode Property (SAMLWriter 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.
ID Property (SAMLWriter Module)
The ID of the request.
Syntax
public var id: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=ID,setter=setID:) NSString* ID; - (NSString*)ID; - (void)setID :(NSString*)newID;
Default Value
""
Remarks
Use this property to specify the ID of the request.
InResponseTo Property (SAMLWriter Module)
Contains the InResponseTo property of the SAML request.
Syntax
public var inResponseTo: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=inResponseTo,setter=setInResponseTo:) NSString* inResponseTo; - (NSString*)inResponseTo; - (void)setInResponseTo :(NSString*)newInResponseTo;
Default Value
""
Remarks
Use this property to specify the ID of the message in response to which the current entity is provided.
IssueInstant Property (SAMLWriter Module)
Contains request issuance timestamp.
Syntax
public var issueInstant: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=issueInstant,setter=setIssueInstant:) NSString* issueInstant; - (NSString*)issueInstant; - (void)setIssueInstant :(NSString*)newIssueInstant;
Default Value
""
Remarks
Set this property to specify the time moment of the request formation. Leave it empty to use the current system time.
Issuer Property (SAMLWriter Module)
Sets the issuer of the message.
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
Set this property to include the SAML ID of the issuer of the SAML message. A typical SAML ID is a string of semicolon-separated elements of one or more of the following elements:
- Format
- NameQualifier
- Value
- IDType
- SPNameQualifier
- SPProvidedID
writer.Issuer = "Value=https://saml.entity.org/resource;Format=urn:oasis:names:tc:SAML:2.0:nameid-format:entity;IDType=Issuer";
LogoutRequest Property (SAMLWriter Module)
Contains the properties of SAML LogoutRequest element.
Syntax
public var logoutRequest: SAMLLogoutRequest { get {...} }
@property (nonatomic,readwrite,assign,getter=logoutRequestNameID,setter=setLogoutRequestNameID:) NSString* logoutRequestNameID; - (NSString*)logoutRequestNameID; - (void)setLogoutRequestNameID :(NSString*)newLogoutRequestNameID; @property (nonatomic,readwrite,assign,getter=logoutRequestNotOnOrAfter,setter=setLogoutRequestNotOnOrAfter:) NSString* logoutRequestNotOnOrAfter; - (NSString*)logoutRequestNotOnOrAfter; - (void)setLogoutRequestNotOnOrAfter :(NSString*)newLogoutRequestNotOnOrAfter; @property (nonatomic,readwrite,assign,getter=logoutRequestReason,setter=setLogoutRequestReason:) NSString* logoutRequestReason; - (NSString*)logoutRequestReason; - (void)setLogoutRequestReason :(NSString*)newLogoutRequestReason; @property (nonatomic,readwrite,assign,getter=logoutRequestSessionIndexes,setter=setLogoutRequestSessionIndexes:) NSString* logoutRequestSessionIndexes; - (NSString*)logoutRequestSessionIndexes; - (void)setLogoutRequestSessionIndexes :(NSString*)newLogoutRequestSessionIndexes;
Default Value
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
ManageNameIDRequest Property (SAMLWriter Module)
Provides access to ManageNameIDRequest element.
Syntax
public var manageNameIDRequest: SAMLManageNameIDRequest { get {...} }
@property (nonatomic,readwrite,assign,getter=manageNameIDRequestNameID,setter=setManageNameIDRequestNameID:) NSString* manageNameIDRequestNameID; - (NSString*)manageNameIDRequestNameID; - (void)setManageNameIDRequestNameID :(NSString*)newManageNameIDRequestNameID; @property (nonatomic,readwrite,assign,getter=manageNameIDRequestNewEncryptedID,setter=setManageNameIDRequestNewEncryptedID:) NSString* manageNameIDRequestNewEncryptedID; - (NSString*)manageNameIDRequestNewEncryptedID; - (void)setManageNameIDRequestNewEncryptedID :(NSString*)newManageNameIDRequestNewEncryptedID; @property (nonatomic,readwrite,assign,getter=manageNameIDRequestNewID,setter=setManageNameIDRequestNewID:) NSString* manageNameIDRequestNewID; - (NSString*)manageNameIDRequestNewID; - (void)setManageNameIDRequestNewID :(NSString*)newManageNameIDRequestNewID; @property (nonatomic,readwrite,assign,getter=manageNameIDRequestTerminate,setter=setManageNameIDRequestTerminate:) NSString* manageNameIDRequestTerminate; - (NSString*)manageNameIDRequestTerminate; - (void)setManageNameIDRequestTerminate :(NSString*)newManageNameIDRequestTerminate;
Default Value
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
NameIDMappingRequest Property (SAMLWriter Module)
Publishes the properties of NameIDMappingRequest entity.
Syntax
public var nameIDMappingRequest: SAMLNameIDMappingRequest { get {...} }
@property (nonatomic,readwrite,assign,getter=nameIDMappingRequestNameID,setter=setNameIDMappingRequestNameID:) NSString* nameIDMappingRequestNameID; - (NSString*)nameIDMappingRequestNameID; - (void)setNameIDMappingRequestNameID :(NSString*)newNameIDMappingRequestNameID; @property (nonatomic,readwrite,assign,getter=nameIDMappingRequestNameIDPolicyAllowCreate,setter=setNameIDMappingRequestNameIDPolicyAllowCreate:) BOOL nameIDMappingRequestNameIDPolicyAllowCreate; - (BOOL)nameIDMappingRequestNameIDPolicyAllowCreate; - (void)setNameIDMappingRequestNameIDPolicyAllowCreate :(BOOL)newNameIDMappingRequestNameIDPolicyAllowCreate; @property (nonatomic,readwrite,assign,getter=nameIDMappingRequestNameIDPolicyFormat,setter=setNameIDMappingRequestNameIDPolicyFormat:) NSString* nameIDMappingRequestNameIDPolicyFormat; - (NSString*)nameIDMappingRequestNameIDPolicyFormat; - (void)setNameIDMappingRequestNameIDPolicyFormat :(NSString*)newNameIDMappingRequestNameIDPolicyFormat; @property (nonatomic,readwrite,assign,getter=nameIDMappingRequestNameIDPolicySPNameQualifier,setter=setNameIDMappingRequestNameIDPolicySPNameQualifier:) NSString* nameIDMappingRequestNameIDPolicySPNameQualifier; - (NSString*)nameIDMappingRequestNameIDPolicySPNameQualifier; - (void)setNameIDMappingRequestNameIDPolicySPNameQualifier :(NSString*)newNameIDMappingRequestNameIDPolicySPNameQualifier; @property (nonatomic,readwrite,assign,getter=nameIDMappingRequestNameIDPolicyUseAllowCreate,setter=setNameIDMappingRequestNameIDPolicyUseAllowCreate:) BOOL nameIDMappingRequestNameIDPolicyUseAllowCreate; - (BOOL)nameIDMappingRequestNameIDPolicyUseAllowCreate; - (void)setNameIDMappingRequestNameIDPolicyUseAllowCreate :(BOOL)newNameIDMappingRequestNameIDPolicyUseAllowCreate;
Default Value
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
OutputType Property (SAMLWriter Module)
Returns the SAML type of message being created.
Syntax
public var outputType: SamlwriterOutputTypes { get {...} }
public enum SamlwriterOutputTypes: Int32 { case cstyNone = 0 case cstyAssertionIDRequest = 1 case cstySubjectQuery = 2 case cstyAuthnQuery = 3 case cstyAttributeQuery = 4 case cstyAuthzDecisionQuery = 5 case cstyAuthnRequest = 6 case cstyManageNameIDRequest = 7 case cstyLogoutRequest = 8 case cstyNameIDMappingRequest = 9 case cstyArtifactResolve = 10 case cstyResponse = 11 }
@property (nonatomic,readonly,assign,getter=outputType) int outputType; - (int)outputType;
Default Value
0
Remarks
Use this property to check the type of SAML message being created. This is the same value that was passed to CreateNew call.
Depending on the assigned type, use properties of class to tune up the parameters of the chosen message type. For example, if setting OutputType to cstyAuthnQuery, use AuthnQuery property to adjust context class references or comparison settings.
This property is read-only.
POSTBinding Property (SAMLWriter Module)
Exposes the POST binding properties.
Syntax
public var postBinding: SAMLPOSTBinding { get {...} }
@property (nonatomic,readwrite,assign,getter=POSTBindingBody,setter=setPOSTBindingBody:) NSString* POSTBindingBody; - (NSString*)POSTBindingBody; - (void)setPOSTBindingBody :(NSString*)newPOSTBindingBody; @property (nonatomic,readwrite,assign,getter=POSTBindingFormTemplate,setter=setPOSTBindingFormTemplate:) NSString* POSTBindingFormTemplate; - (NSString*)POSTBindingFormTemplate; - (void)setPOSTBindingFormTemplate :(NSString*)newPOSTBindingFormTemplate; @property (nonatomic,readwrite,assign,getter=POSTBindingMode,setter=setPOSTBindingMode:) int POSTBindingMode; - (int)POSTBindingMode; - (void)setPOSTBindingMode :(int)newPOSTBindingMode; @property (nonatomic,readwrite,assign,getter=POSTBindingRelayState,setter=setPOSTBindingRelayState:) NSString* POSTBindingRelayState; - (NSString*)POSTBindingRelayState; - (void)setPOSTBindingRelayState :(NSString*)newPOSTBindingRelayState; @property (nonatomic,readwrite,assign,getter=POSTBindingURL,setter=setPOSTBindingURL:) NSString* POSTBindingURL; - (NSString*)POSTBindingURL; - (void)setPOSTBindingURL :(NSString*)newPOSTBindingURL;
Default Value
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
Profile Property (SAMLWriter Module)
Specifies a pre-defined profile to apply when creating the signature.
Syntax
public var profile: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=profile,setter=setProfile:) NSString* profile; - (NSString*)profile; - (void)setProfile :(NSString*)newProfile;
Default Value
""
Remarks
Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.
RedirectBinding Property (SAMLWriter Module)
Publishes the redirect binding settings.
Syntax
public var redirectBinding: SAMLRedirectBinding { get {...} }
@property (nonatomic,readwrite,assign,getter=redirectBindingEncoding,setter=setRedirectBindingEncoding:) NSString* redirectBindingEncoding; - (NSString*)redirectBindingEncoding; - (void)setRedirectBindingEncoding :(NSString*)newRedirectBindingEncoding; @property (nonatomic,readwrite,assign,getter=redirectBindingForceSign,setter=setRedirectBindingForceSign:) BOOL redirectBindingForceSign; - (BOOL)redirectBindingForceSign; - (void)setRedirectBindingForceSign :(BOOL)newRedirectBindingForceSign; @property (nonatomic,readwrite,assign,getter=redirectBindingRelayState,setter=setRedirectBindingRelayState:) NSString* redirectBindingRelayState; - (NSString*)redirectBindingRelayState; - (void)setRedirectBindingRelayState :(NSString*)newRedirectBindingRelayState; @property (nonatomic,readwrite,assign,getter=redirectBindingSign,setter=setRedirectBindingSign:) BOOL redirectBindingSign; - (BOOL)redirectBindingSign; - (void)setRedirectBindingSign :(BOOL)newRedirectBindingSign; @property (nonatomic,readwrite,assign,getter=redirectBindingSignatureAlgorithm,setter=setRedirectBindingSignatureAlgorithm:) NSString* redirectBindingSignatureAlgorithm; - (NSString*)redirectBindingSignatureAlgorithm; - (void)setRedirectBindingSignatureAlgorithm :(NSString*)newRedirectBindingSignatureAlgorithm; @property (nonatomic,readwrite,assign,getter=redirectBindingURL,setter=setRedirectBindingURL:) NSString* redirectBindingURL; - (NSString*)redirectBindingURL; - (void)setRedirectBindingURL :(NSString*)newRedirectBindingURL; @property (nonatomic,readwrite,assign,getter=redirectBindingVerifySignatures,setter=setRedirectBindingVerifySignatures:) BOOL redirectBindingVerifySignatures; - (BOOL)redirectBindingVerifySignatures; - (void)setRedirectBindingVerifySignatures :(BOOL)newRedirectBindingVerifySignatures;
Default Value
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
RedirectBindingCertificate Property (SAMLWriter Module)
Contains a certificate to sign the redirect binding.
Syntax
public var redirectBindingCertificate: Certificate { get {...} set {...} }
@property (nonatomic,readonly,assign,getter=redirectBindingCertBytes) NSData* redirectBindingCertBytes; - (NSData*)redirectBindingCertBytes; @property (nonatomic,readwrite,assign,getter=redirectBindingCertHandle,setter=setRedirectBindingCertHandle:) long long redirectBindingCertHandle; - (long long)redirectBindingCertHandle; - (void)setRedirectBindingCertHandle :(long long)newRedirectBindingCertHandle;
Default Value
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
Response Property (SAMLWriter Module)
Provides access to the SAML response object properties.
Syntax
public var response: SAMLResponse { get {...} }
@property (nonatomic,readwrite,assign,getter=responseNameID,setter=setResponseNameID:) NSString* responseNameID; - (NSString*)responseNameID; - (void)setResponseNameID :(NSString*)newResponseNameID; @property (nonatomic,readwrite,assign,getter=responseOptionalElement,setter=setResponseOptionalElement:) NSString* responseOptionalElement; - (NSString*)responseOptionalElement; - (void)setResponseOptionalElement :(NSString*)newResponseOptionalElement; @property (nonatomic,readwrite,assign,getter=responseResponseType,setter=setResponseResponseType:) int responseResponseType; - (int)responseResponseType; - (void)setResponseResponseType :(int)newResponseResponseType; @property (nonatomic,readwrite,assign,getter=responseStatusCodeSubValue,setter=setResponseStatusCodeSubValue:) NSString* responseStatusCodeSubValue; - (NSString*)responseStatusCodeSubValue; - (void)setResponseStatusCodeSubValue :(NSString*)newResponseStatusCodeSubValue; @property (nonatomic,readwrite,assign,getter=responseStatusCodeValue,setter=setResponseStatusCodeValue:) NSString* responseStatusCodeValue; - (NSString*)responseStatusCodeValue; - (void)setResponseStatusCodeValue :(NSString*)newResponseStatusCodeValue; @property (nonatomic,readwrite,assign,getter=responseStatusDetail,setter=setResponseStatusDetail:) NSString* responseStatusDetail; - (NSString*)responseStatusDetail; - (void)setResponseStatusDetail :(NSString*)newResponseStatusDetail; @property (nonatomic,readwrite,assign,getter=responseStatusMessage,setter=setResponseStatusMessage:) NSString* responseStatusMessage; - (NSString*)responseStatusMessage; - (void)setResponseStatusMessage :(NSString*)newResponseStatusMessage;
Default Value
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
SigCanonicalizationMethod Property (SAMLWriter Module)
The canonicalization method to use in the signature.
Syntax
public var sigCanonicalizationMethod: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=sigCanonicalizationMethod,setter=setSigCanonicalizationMethod:) NSString* sigCanonicalizationMethod; - (NSString*)sigCanonicalizationMethod; - (void)setSigCanonicalizationMethod :(NSString*)newSigCanonicalizationMethod;
Default Value
""
Remarks
The URI of the canonicalization method to use in the signature (e.g. http://www.w3.org/TR/xml-exc-c14n/)
SigDigestMethod Property (SAMLWriter Module)
The digest method to use.
Syntax
public var sigDigestMethod: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=sigDigestMethod,setter=setSigDigestMethod:) NSString* sigDigestMethod; - (NSString*)sigDigestMethod; - (void)setSigDigestMethod :(NSString*)newSigDigestMethod;
Default Value
""
Remarks
The URI of the digest method to use for signing, as defined in XMLDSIG or XMLENC: http://www.w3.org/2000/09/xmldsig#sha256.
SigMethod Property (SAMLWriter Module)
The signature method to use.
Syntax
public var sigMethod: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=sigMethod,setter=setSigMethod:) NSString* sigMethod; - (NSString*)sigMethod; - (void)setSigMethod :(NSString*)newSigMethod;
Default Value
""
Remarks
The URI specifying the signature method to use for signing, for example http://www.w3.org/2001/04/xmldsig-more#rsa-sha256.
Sign Property (SAMLWriter Module)
Specifies whether the created SAML message should be signed.
Syntax
public var sign: Bool { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=sign,setter=setSign:) BOOL sign; - (BOOL)sign; - (void)setSign :(BOOL)newSign;
Default Value
False
Remarks
Set this property to true to indicate that you want the created message to be signed.
SigningCertificate Property (SAMLWriter Module)
The certificate to be used for signing.
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
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
SigningChain Property (SAMLWriter 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
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
SubjectConfirmations Property (SAMLWriter Module)
Provides access to the list of subject confirmation elements.
Syntax
public var subjectConfirmations: Array<SAMLSubjectConfirmation> { get {...} }
@property (nonatomic,readwrite,assign,getter=subjectConfirmationCount,setter=setSubjectConfirmationCount:) int subjectConfirmationCount; - (int)subjectConfirmationCount; - (void)setSubjectConfirmationCount :(int)newSubjectConfirmationCount; - (NSString*)subjectConfirmationDataAddress:(int)subjectConfirmationIndex; - (void)setSubjectConfirmationDataAddress:(int)subjectConfirmationIndex :(NSString*)newSubjectConfirmationDataAddress; - (NSString*)subjectConfirmationDataInResponseTo:(int)subjectConfirmationIndex; - (void)setSubjectConfirmationDataInResponseTo:(int)subjectConfirmationIndex :(NSString*)newSubjectConfirmationDataInResponseTo; - (NSString*)subjectConfirmationDataNotBefore:(int)subjectConfirmationIndex; - (void)setSubjectConfirmationDataNotBefore:(int)subjectConfirmationIndex :(NSString*)newSubjectConfirmationDataNotBefore; - (NSString*)subjectConfirmationDataNotOnOrAfter:(int)subjectConfirmationIndex; - (void)setSubjectConfirmationDataNotOnOrAfter:(int)subjectConfirmationIndex :(NSString*)newSubjectConfirmationDataNotOnOrAfter; - (NSString*)subjectConfirmationDataRecipient:(int)subjectConfirmationIndex; - (void)setSubjectConfirmationDataRecipient:(int)subjectConfirmationIndex :(NSString*)newSubjectConfirmationDataRecipient; - (NSString*)subjectConfirmationDataType:(int)subjectConfirmationIndex; - (void)setSubjectConfirmationDataType:(int)subjectConfirmationIndex :(NSString*)newSubjectConfirmationDataType; - (NSString*)subjectConfirmationID:(int)subjectConfirmationIndex; - (void)setSubjectConfirmationID:(int)subjectConfirmationIndex :(NSString*)newSubjectConfirmationID; - (NSString*)subjectConfirmationMethod:(int)subjectConfirmationIndex; - (void)setSubjectConfirmationMethod:(int)subjectConfirmationIndex :(NSString*)newSubjectConfirmationMethod;
Default Value
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
SubjectID Property (SAMLWriter Module)
Sets the subject of the message.
Syntax
public var subjectID: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=subjectID,setter=setSubjectID:) NSString* subjectID; - (NSString*)subjectID; - (void)setSubjectID :(NSString*)newSubjectID;
Default Value
""
Remarks
Use this property to set the SAML ID of the message subject.
Version Property (SAMLWriter Module)
Specifies the protocol version of the SAML message.
Syntax
public var version: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=version,setter=setVersion:) NSString* version; - (NSString*)version; - (void)setVersion :(NSString*)newVersion;
Default Value
"2.0"
Remarks
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
AddAdviceAssertion Method (SAMLWriter Module)
Adds an advice assertion to the message.
Syntax
- (int)addAdviceAssertion:(int)assertionIndex;
Remarks
Use this method to add an advice assertion to a SAML assertion message. Provide the index of the assertion via AssertionIndex parameter.
This method returns the index of the newly added advice assertion in the list.
AddAssertion Method (SAMLWriter Module)
Adds assertion to a SAML message.
Syntax
public func addAssertion() throws -> Int32
- (int)addAssertion;
Remarks
Use this method to add an assertion to the SAML message being created. The assertion details to add are taken from the components AssertionXXX properties, such as AssertionInfo AssertionStatements, or AssertionAttributes.
The method returns the index of the new assertion in the list.
ClearAssertion Method (SAMLWriter Module)
Resets the contents of all assertion-related properties.
Syntax
public func clearAssertion() throws -> Void
- (void)clearAssertion;
Remarks
Use this method to clear the contents of all assertion-related properties, such as AssertionAttributes, to clean up the assertion settings when preparing the component for adding a new assertion.
CompareIDs Method (SAMLWriter Module)
Compares two SAML IDs.
Syntax
- (BOOL)compareIDs:(NSString*)ID1 :(NSString*)ID2;
Remarks
This utility method compares two SAML identifiers for equality.
Config Method (SAMLWriter Module)
Sets or retrieves a configuration setting.
Syntax
- (NSString*)config:(NSString*)configurationString;
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
CreateNew Method (SAMLWriter Module)
Creates a new SAML message with the given type.
Syntax
Remarks
Use this method to create a new SAML message with the specified content type. The following values are supported:
- cstyNone (0)
- cstyAssertionIDRequest (1)
- cstySubjectQuery (2)
- cstyAuthnQuery (3)
- cstyAttributeQuery (4)
- cstyAuthzDecisionQuery (5)
- cstyAuthnRequest (6)
- cstyManageNameIDRequest (7)
- cstyLogoutRequest (8)
- cstyNameIDMappingRequest (9)
- cstyArtifactResolve (10)
- cstyResponse (11)
DoAction Method (SAMLWriter Module)
Performs an additional action.
Syntax
- (NSString*)doAction:(NSString*)actionID :(NSString*)actionParams;
Remarks
DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
GetIDProp Method (SAMLWriter Module)
Returns an element of the SAML ID.
Syntax
- (NSString*)getIDProp:(NSString*)ID :(NSString*)propName;
Remarks
This is a utility method that simplifies retrieval of a specific property within a SAML ID. Pass the name of the ID property to the PropName parameter, and the ID to the ID parameter.
The following ID properties are supported:
- Format
- NameQualifier
- IDType
- SPNameQualifier
- SPProvidedID
- Value
RemoveAdvice Method (SAMLWriter Module)
Removes an advice from an assertion.
Syntax
- (void)removeAdvice:(int)assertionIndex;
Remarks
Use this method to remove an advice from an assertion. Pass the assertion index via the AssertionIndex parameter.
RemoveAdviceAssertion Method (SAMLWriter Module)
Removes an advice from an assertion.
Syntax
public func removeAdviceAssertion(assertionIndex: Int32, adviceAssertionIndex: Int32) throws -> Void
- (void)removeAdviceAssertion:(int)assertionIndex :(int)adviceAssertionIndex;
Remarks
Use this method to remove an advice assertion from an assertion.
RemoveAllAssertions Method (SAMLWriter Module)
Removes all assertions currently configured in the message.
Syntax
public func removeAllAssertions() throws -> Void
- (void)removeAllAssertions;
Remarks
Use this message to remove all assertions currently set up in the SAML message.
RemoveAssertion Method (SAMLWriter Module)
Removes an assertion from the message.
Syntax
- (void)removeAssertion:(int)assertionIndex;
Remarks
Use this message to remove an assertion from a SAML message. Pass the assertion index as a parameter.
Save Method (SAMLWriter Module)
Saves the configured message to a string.
Syntax
public func save() throws -> String
- (NSString*)save;
Remarks
Use this method to save the created SAML message to a string.
SaveBytes Method (SAMLWriter Module)
Saves the configured message to a byte array.
Syntax
public func saveBytes() throws -> Data
- (NSData*)saveBytes;
Remarks
Use this method to save the formed SAML message to a byte array.
SaveFile Method (SAMLWriter Module)
Saves the configured message to a file.
Syntax
Remarks
Use this method to save the created SAML message to a file.
Error Event (SAMLWriter Module)
Fires to report an error condition.
Syntax
- (void)onError:(int)errorCode :(NSString*)description;
Remarks
Subscribe to this event to be notified about any error conditions occurring during the component's work. ErrorCode and Description provide the details of the error.
Notification Event (SAMLWriter 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.
Certificate Type
Provides details of an individual X.509 certificate.
Remarks
This type provides access to X.509 certificate details.
Fields
|
bytes Data |
Returns raw certificate data in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ca Bool |
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
caKeyID Data |
A unique identifier (fingerprint) of the CA certificate's private key. Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
crlDistributionPoints String |
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
curve String |
Specifies the elliptic curve of the EC public key.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
fingerprint Data |
Contains the fingerprint (a hash imprint) of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
friendlyName String |
Contains an associated alias (friendly name) of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
handle Int64 |
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hashAlgorithm String |
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
issuer String |
The common name of the certificate issuer (CA), typically a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
issuerRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyAlgorithm String |
Specifies the public key algorithm of this certificate.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyBits Int32 |
Returns the length of the public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyFingerprint Data |
Returns a fingerprint of the public key contained in the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyUsage Int32 |
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. This value is a bit mask of the following values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyValid Bool |
Returns True if the certificate's key is cryptographically valid, and False otherwise. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ocspLocations String |
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ocspNoCheck Bool |
Accessor to the value of the certificates ocsp-no-check extension. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
origin Int32 |
Returns the origin of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
policyIDs String |
Contains identifiers (OIDs) of the applicable certificate policies. The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
privateKeyBytes Data |
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
privateKeyExists Bool |
Indicates whether the certificate has an associated private key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
privateKeyExtractable Bool |
Indicates whether the private key is extractable |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
publicKeyBytes Data |
Contains the certificate's public key in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
qualifiedStatements QualifiedStatementsTypes |
Returns the qualified status of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
selfSigned Bool |
Indicates whether the certificate is self-signed (root) or signed by an external CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
serialNumber Data |
Returns the certificate's serial number. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
sigAlgorithm String |
Indicates the algorithm that was used by the CA to sign this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subject String |
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subjectAlternativeName String |
Returns or sets the value of the Subject Alternative Name extension of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subjectKeyID Data |
Contains a unique identifier (fingerprint) of the certificate's private key. Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subjectRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
validFrom String |
The time point at which the certificate becomes valid, in UTC. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
validTo String |
The time point at which the certificate expires, in UTC. |
Constructors
public init(stream: )
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.
SAMLArtifact Type
Represents a SAML Artifact entity.
Remarks
This type is a container for a SAML Artifact entity. A SAML artifact consists of a , an , and a , which contains the body of the artifact and varies depending on the .
Fields
|
endpointIndex Int32 |
An accessor to the EndpointIndex entry of the artifact. The EndpointIndex references a specific artifact resolution endpoint (IdP or SP) managed by the artifact issuer. |
|
messageHandle Data |
An accessor to the MessageHandle property of the artifact. A message handle is a unique reference to a SAML message that can be produced by the artifact issuer upon request. |
|
remainingArtifact Data |
Returns the contents of the artifact. Check this property to access the encoded contents of the artifact. This property is updated internally from the parameters of the artifact. |
|
sourceID Data |
An accessor to the SourceID property of the artifact. SourceID uniquely identifies the issuer of the artifact. |
|
typeCode Int32 |
The TypeCode field of the artifact. The type code artifact parameter uniquely identifies the artifact format. Currently (as per SAML 2.0) the only type code of 4 is defined. This format assumes the presence of , , and parameters. |
|
uri String |
An accessor to the URI property of the artifact. The URI property contains the origin of the artifact. |
Constructors
public init()
Creates a new SAMLArtifact object.
SAMLAssertionCondition Type
Represents a SAML assertion Condition parameter.
Remarks
This type is a container for a single Condition parameter of a SAML assertion.
Fields
|
audienceList String |
An accessor to the Audience list parameter of an audience restriction condition. Use this property to read or set a list of audiences included in the restriction. Each audience is represented by an URI. Provide multiple audiences by splitting them with CRLF separators. |
|
conditionType SAMLConditionTypes |
Specifies a type of the condition object. Use this property to check or specify a type of the condition object. This can be either an audience restriction, a one time use limitation, or a proxy restriction. |
|
proxyRestrictionCount Int32 |
An accessor to the proxy restriction count element of the condition. Use this setting to access or set the value of the proxy restriction count condition. |
Constructors
public init()
Creates a new SAMLAssertionCondition object.
SAMLAssertionIDRequest Type
Represents a SAML AssertionIDRequest object.
Remarks
This type is a container for a SAML AssertionIDRequest element. This element is used to request assertions by their IDs.
Fields
|
references String |
Contains the References entry of the SAML assertion ID request. Use this property to read or specify the value of the References entry of the Assertion ID Request. |
Constructors
public init()
Creates a new SAMLAssertionIDRequest object.
SAMLAssertionInfo Type
Contains information about a SAML assertion.
Remarks
Use this type to get general information about a SAML assertion.
Fields
|
adviceAssertionCount Int32 |
Contains the number of advice assertions. Use this property to access the number of advice assertions. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
assertionType SAMLAssertionTypes |
Specifies the type of the assertion. Use this property to check or set the type of the assertion. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
chainValidationDetails Int32 |
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||
|
chainValidationResult ChainValidities |
The outcome of a certificate chain validation routine. Available options:
Use the ValidationLog property to access the detailed validation log. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
conditionsNotBefore String |
Represents the Conditions.NotBefore assertion property. Use this property to get or set the Conditions.NotBefore property of the assertion. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
conditionsNotOnOrAfter String |
Represents the Conditions.NotOnOrAfter assertion property. Use this property to get or set the Conditions.NotOnOrAfter property of the assertion. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
encryptedContent String |
Represents the encrypted assertion content. Use this property to get or set the encrypted assertion content. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
id String |
Represents the ID of the assertion. Use this property to read or set the unique ID of the assertion. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
idRef String |
Represents an ID reference value. Use this property to read or set the ID reference value for assertions of csatAssertionIDRef type. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
issueInstant String |
Contains the assertion issuance time stamp. Use this property to check or set the assertion issuance time. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
signatureValidationResult SignatureValidities |
The outcome of the cryptographic signature validation. The following signature validity values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||
|
signed Bool |
Specifies whether the assertion is signed. Use this property to establish whether the assertion is signed. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
uriRef String |
Represents an URI reference value. Use this property to read or set the URI reference value for assertions of csatAssertionURIRef type. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
validationLog String |
Contains the signing certificate's chain validation log. This information may be very useful in investigating chain validation failures. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
version String |
Specifies the SAML protocol version used. This property specifies the SAML protocol version. The default value is 2.0. |
Constructors
public init()
Creates a new SAMLAssertionInfo object.
SAMLAssertionStatement Type
Represents an assertion statement.
Remarks
This type is a container for an assertion statement.
Fields
|
attributes String |
Contains a list of statement attribute names. Use this property to access the set of names of assertion attributes, separated by CRLF. |
|
authnContextAuthenticatingAuthorities String |
Contains the list of authenticating authorities. Use this property to access the list of URIs of authenticating authorities (IdP entity IDs). |
|
authnContextChoice String |
Specifies the authentication context choice variant. Use this property to set the authentication context choice variant. The currently supported values are v1 and v2. If this setting is left empty, the v1 variant is assumed. |
|
authnContextClassRef String |
Indicates the authentication contexts class reference. Use this property to get or set the authentication contexts class reference attribute. |
|
authnContextDecl String |
Specifies the authentication contexts declaration. Use this property to access or set the declaration element of the authentication context. |
|
authnContextDeclRef String |
Specifies the authentication contexts declaration reference. Use this property to get or set the declaration reference of the authentication context. |
|
authnInstant String |
Specifies the authentication event timestamp. Use this property to read or set the moment in time the authentication event took place. |
|
authnSessionIndex String |
Contains the authentication session index. Use this property to access or set the authentication session index. |
|
authnSessionNotOnOrAfter String |
Maps to the SessionNotOnOrAfter parameter of the authentication statement. Use this property to access or set the SessionNotOnOrAfter parameter of the authentication statement. |
|
authnSubjectLocalityAddress String |
Specifies the authentication subjects address. Use this property to specify the address parameter of the authentication subjects locality. |
|
authnSubjectLocalityDNSName String |
Maps to the authentication subjects DNS name parameter. Use this property to access or set the authentication subjects DNS name locality parameter. |
|
authzActions String |
Provides access to the list of actions of the authorization statement. Use this property to read or set the actions of the authorization statement. Actions are represented as a list of Namespace=namespace;Value=Value strings, separated with CRLFs. |
|
authzDecision SAMLDecisions |
Specifies the authorization decision. Use this property to check or set the authorization decision. This can be one of Permit, Deny, or Indeterminate. |
|
authzDecisionEvidence String |
Manages the authorization decision statement evidence parameter. Use this property to read or set the authorization decision statement evidence parameter. |
|
authzDecisionResource String |
Specifies the authorization decision statement resource parameter. Use this property to access or set the resource parameter of the authorization statement. |
|
statementType SAMLAssertionStatementTypes |
Specifies the assertion statement type. This property specifies the assertion statement type. A statement can carry an authentication assertion, an attribute assertion, or an authorization decision assertion. |
Constructors
public init()
Creates a new SAMLAssertionStatement object.
SAMLAttribute Type
A container for the SAML attribute object.
Remarks
This type is a container for the SAML attribute object.
Fields
|
friendlyName String |
Specifies the friendly name of the attribute Use this property to access or set the friendly name of a SAML attribute (e.g. givenName). |
|
name String |
Specifies the name of the attribute. Use this property to read or set the formal name of the attribute (e.g. urn:oid:2.5.4.42). |
|
nameFormat String |
Indicates the format used to reference the attribute. This property specifies the format that is used to reference the attribute (e.g. urn:oasis:names:tc:SAML:2.0:attrname-format:uri). |
|
statementIndex Int32 |
Contains the index of the statement the attribute corresponds to. Use this property to read or set the index of the statement in the statement list that this attribute corresponds to. |
|
values String |
Contains a list of attribute values. Use this property to access or set the value(s) included with the attribute. The value contains a list of strings of ContentType=contentType;Value=value format, separated with CRLF. |
Constructors
public init()
Creates a new SAMLAttribute object.
SAMLAuthnQuery Type
A container for AuthnQuery element.
Remarks
This type is a container for SAML AuthnQuery element, which represents an authentication event query.
Fields
|
comparison SAMLAuthnContextComparisons |
Specifies the authentication context comparison method. Use this property to access or set the authentication contexts comparison method (none, exact, minimum, maximum, or better). |
|
contextClassRefs String |
Specifies the context class reference. Use this property to access or set the authentication context class reference. |
|
refType SAMLAuthnRefTypes |
Specifies the context reference type. Use this property to access or set the authentication contexts reference type (class or declaration). |
|
sessionIndex String |
Specifies the index of the session to the authentication entity. Use this property to access or set the index of the session to the authentication entity. |
Constructors
public init()
Creates a new SAMLAuthnQuery object.
SAMLAuthnRequest Type
Represents a SAML AuthnRequest object.
Remarks
This type represents a SAML AuthnRequest object. An AuthnRequest is sent by a principal to the identity provider when it needs to request an assertion containing an authentication statement.
Fields
|
assertionConsumerServiceIndex Int32 |
Specifies the assertion consumer service index. Use this property to access or set the location index to which the response has to be returned. |
|
assertionConsumerServiceURL String |
Specifies the assertion consumer service URL. Use this property to access or set the URL of the location to which the response has to be returned. |
|
attributeConsumingServiceIndex Int32 |
Specifies the attribute consuming service index. Use this property to read or set the attribute consuming service index. |
|
conditionsNotBefore String |
Specifies the NotBefore condition of the request. Use this property to access or set the NotBefore condition of the request. |
|
conditionsNotOnOrAfter String |
Provides access to the NotOnOrAfter condition of the request. Use this property to access or set the NotOnOrAfter condition of the request. |
|
contextClassRefs String |
Provides access to the authentication context class references. Use this property to access or set the class references of the authentication context. This property may contain a list of CRLF-separated strings. |
|
contextComparison SAMLAuthnContextComparisons |
Specifies the AuthnContext comparison method. Use this property to access or set the authentication contexts comparison method (none, exact, minimum, maximum, or better). |
|
contextRefType SAMLAuthnRefTypes |
Specifies the context reference type. Use this property to get or set the context reference type (Class or Declaration). |
|
forceAuthn Bool |
Corresponds to the ForceAuthn parameter of the request. Use this property to check or set the ForceAuthn parameter of the request, which enforces the identity provider to re-authenticate the presenter. |
|
isPassive Bool |
Maps to the IsPassive parameter of the request. Use this property to access or set the IsPassive parameter of the authentication request. IsPassive sets out the control the identity provider and user agent have over the authenticating users UI. |
|
nameIDPolicyAllowCreate Bool |
Matches the AllowCreate attribute of NameIDPolicy element of the request. Use this property to access or set the AllowCreate attribute of NameIDPolicy, which allows or disallows the identity provider to create a new identifier when processing the authentication request. |
|
nameIDPolicyFormat String |
Matches to the Format attribute of the NameIDPolicy element of the request. Use this property to access or set the Format attribute of NameIDPolicy. |
|
nameIDPolicySPNameQualifier String |
Matches to the SP name qualifier attribute of the request. Use this property to access or set the SP name qualifier attribute of the authentication request. |
|
nameIDPolicyUseAllowCreate Bool |
Controls inclusion of AllowCreate attribute in the request. Use this property to check or specify whether the AllowCreate attribute is included in the authentication request. |
|
protocolBinding String |
Specifies the protocol binding to be requested in the authentication request. Use this property to check or set the protocol binding to be used when responding to this request. |
|
providerName String |
Specifies the name of the requestor. Use this property to read or set the name of the requestor. |
|
scopingIDPListGetComplete String |
Matches the GetComplete element of the IDPList entry of the Scoping object. Use this property to access or set the GetComplete element of the IDPList entry of the Scoping object of the authentication request. This property typically contains an URI that allows to retrieve a complete list of identity providers. |
|
scopingProxyCount Int32 |
The maximum number of proxies on the way between the requestor and the provider. Use this property to get or set the maximum number of intermediaries allowed between the requestor and the provider. |
|
scopingRequesterIDs String |
A collection of requestor IDs on whose behalf the request is being sent. Use this property to specify or read the requestor IDs, in the form of CRLF-separated strings, on whose behalf the request is being sent. |
|
useForceAuthn Bool |
Controls inclusion of ForceAuthn attribute in the request. Use this property to check or enable presence of the ForceAuthn attribute in the authentication request. Set this property to false to suppress inclusion of the attribute. |
|
useIsPassive Bool |
Controls inclusion of IsPassive attribute in the request. Use this property to check or enable presence of the IsPassive attribute in the authentication request. Set this property to false to suppress inclusion of the attribute. |
Constructors
public init()
Creates a new SAMLAuthnRequest object.
SAMLAuthzDecisionQuery Type
Represents SAML AuthzDecisionQuery element.
Remarks
This type is a container for SAML AuthzDecisionQuery type.
Fields
|
actions String |
Specifies the list of actions included in the query. Read or set this property to access the list of actions (as CRLF-separated strings) included in the query. |
|
resource String |
Matches the Resource element of the query. Use this property to read or set the Resource element of the authorization decision query. |
Constructors
public init()
Creates a new SAMLAuthzDecisionQuery object.
SAMLIDPEntry Type
Represents a single identity provider information.
Remarks
This type is a container of single identity provider-specific details.
Fields
|
loc String |
Contains the value of the Loc attribute. Use this property to access or set the value of the Loc (location) attribute. |
|
name String |
Contains the name of the IdP provider. Use this property to retrieve or set the Name attribute of the IdP provider. |
|
providerID String |
Contains the provider ID. Use this property to read or set the identity provider ID. |
Constructors
public init()
Creates a new SAMLIDPEntry object.
SAMLLogoutRequest Type
Represents SAML LogoutRequest element.
Remarks
This type is a container for SAML LogoutRequest element.
Fields
|
nameID String |
Contains the value of the NameID parameter. Use this property to access or set the value of the NameID parameter of the request. |
|
notOnOrAfter String |
Contains the value of the NotOnOrAfter parameter. Use this property to access or set the value of the NotOnOrAfter parameter. |
|
reason String |
Contains the value of the Reason parameter. Use this property to read or set the value of the Reason parameter. |
|
sessionIndexes String |
Contains the list of session indices. Use this property to access or set the list of session indices, as a CRLF-separated list of strings. |
Constructors
public init()
Creates a new SAMLLogoutRequest object.
SAMLManageNameIDRequest Type
Represents a SAML ManageNameIDRequest element.
Remarks
This type is a container for ManageNameIDRequest element.
Fields
|
nameID String |
Contains the value of the NameID parameter of the request. Use this property to read or set the value of the NameID parameter of the request. |
|
newEncryptedID String |
Contains the value of the NewEncryptedID parameter of the request. Use this property to check or set the value of the NewEncryptedID parameter of the request. |
|
newID String |
Contains the value of the NewID parameter. Use this property to access or set the NewID parameter of the request. |
|
terminate String |
Contains the value of the Terminate parameter of the request. Use this property to read or set the value of the Terminate parameter of the request. |
Constructors
public init()
Creates a new SAMLManageNameIDRequest object.
SAMLNameIDMappingRequest Type
Represents SAML NameIDMappingRequest element.
Remarks
This type is a container for NameIDMappingRequest element.
Fields
|
nameID String |
An accessor to the NameID parameter of the request. Use this property to read or set the value of the NameID parameter of the request object. |
|
nameIDPolicyAllowCreate Bool |
Contains the value of AllowCreate parameter of the NameIDPolicy object. Use this property to read or set the value of the AllowCreate parameter of the NameIDPolicy object. AllowCreate regulates whether the identity provider is given permission to create new subject identifiers. |
|
nameIDPolicyFormat String |
Specifies the format of the NameIDPolicy element. Use this property to set or read the value of the Format parameter of the NameIDPolicy object. |
|
nameIDPolicySPNameQualifier String |
Contains the SPNameQualifier parameter of the NameIDPolicy element. Use this property to specify or read the value of the SPNameQualifier parameter of the NameIDPolicy element of the request. |
|
nameIDPolicyUseAllowCreate Bool |
Controls inclusion of UseAllow modifier in the NameIDPolicy object. Use this property to include or exclude the UseAllow parameter from the NameIDPolicy object. |
Constructors
public init()
Creates a new SAMLNameIDMappingRequest object.
SAMLPOSTBinding Type
Contains the details of the POST binding.
Remarks
This type provides access to properties of POST binding.
Fields
|
body String |
Contains the form body. Use this property to read or set the body of the form returned by the service provider. |
|
formTemplate String |
Contains the XHTML form template returned by the service provider. Use this property to access or set the template of a POST form provided by the service provider. |
|
mode SAMLPOSTBindingModes |
Specifies whether binding is applied on a server, or on a client side. Use this property to specify whether binding is used on the server or client side of the communication. The default value is cspmClient. |
|
relayState String |
Contains the value of the RelayState parameter of POST binding mechanism. Use this property to read or set the value of the RelayState parameter of the POST binding. RelayState contains an uninterpreted service-provider-originating state object, which should be passed back to it with any further requests. |
|
url String |
Contains the URL of POST binding mechanism. Use this property to check or set the URL of POST binding mechanism. |
Constructors
public init()
Creates a new SAMLPOSTBinding object.
SAMLRedirectBinding Type
Contains parameters of SAML Redirect binding.
Remarks
This type is a container for properties of SAML Redirect binding mechanism.
Fields
|
encoding String |
Specifies the message encoding. Use this property to access or set the message encoding. |
|
forceSign Bool |
Enforces a signature over all outgoing messages. Use this property to enforce signing of all outgoing messages, independently of whether the original message was signed or not. See also . |
|
relayState String |
Contains the RelayState parameter of the binding. Use this property to access or set the RelayState parameter of the binding. This is an uninterpreted state string that should be passed back to the service provider with subsequent requests. |
|
sign Bool |
Specifies whether to sign generated messages. Use this property to enable or disable signing of generated binding entities. The SAML specification instructs that the binding should only be signed if the original XML was. This property therefore is only taken into account if the original XML was signed. With that in mind, certain service providers demand the binding to be signed at all times. Use property to enforce signatures on all binding entities. |
|
signatureAlgorithm String |
Contains the signature algorithm. Use this property to get or set the signature algorithm. This corresponds to the SigAlg query string parameter, and contains the URI of the signature algorithm. |
|
url String |
Contains the URL of the request query. Use this property to read or set the URL of the request query. |
|
verifySignatures Bool |
Instructs the component whether to verify incoming signatures. Use this property to activate or deactivate verification of signatures in incoming requests. |
Constructors
public init()
Creates a new SAMLRedirectBinding object.
SAMLResponse Type
Represents a SAML response.
Remarks
This is a container for SAML response parameters.
Fields
|
nameID String |
Contains the NameID parameter of a NameIDMapping response. Use this property to read or set the NameID parameter of the NameIDMapping response. |
|
optionalElement String |
An optional message element to be returned with the response. Use this property to access or set the optional XML element returned with the response. |
|
responseType SAMLResponseTypes |
Contains the type of the response. Use this property to get or set the type of the SAML response. |
|
statusCodeSubValue String |
The value of the nested StatusCode. This property contains the value of the nested StatusCode element. |
|
statusCodeValue String |
Contains the status code value. Use this property to read or set one of the status codes defined by SAML specification, such as 'urn:oasis:names:tc:SAML:2.0:status:Success' or 'urn:oasis:names:tc:SAML:2.0:status:Requester'. |
|
statusDetail String |
Contains additional information on the status of the request. The StatusDetail element contains additional request status information. |
|
statusMessage String |
Contains a status message (optional). This property specifies the status message which may, optionally, be returned to an operator. |
Constructors
public init()
Creates a new SAMLResponse object.
SAMLSubjectConfirmation Type
Represents SAML SubjectConfirmation element.
Remarks
This type is a container for SAML SubjectConfirmating element.
Fields
|
dataAddress String |
Contains the address enabled for presenting assertions. Use this property to specify the network address or location from which the subject confirmation should be issued. This optional element can be used to restrict the possibilities of an attacker to steal the assertion and present it from another IP address. |
|
dataInResponseTo String |
The ID of the SAML message in response to which the assertion is issued. This property specifies the ID of the SAML message in response to which the assertion is issued. |
|
dataNotBefore String |
Time moment before which the subject cannot be confirmed. This property specifies the time before which the subject cannot be confirmed. |
|
dataNotOnOrAfter String |
Limits the time until which the subject can be confirmed. This property specifies the time on (or after) which the subject cannot be confirmed. |
|
dataRecipient String |
The URI of the entity or the location of the resource to which the assertion should be presented. This property specifies The URI of the entity or the location of the resource to which the assertion should be presented. |
|
dataType String |
The type of data contained in the confirmation. Use this property to read or specify the type of confirmation data included in the object. |
|
id String |
The identifier of the entity which can satisfy the subject confirmation requirements. This property specifies the identifier of the entity which is expected to satisfy the subject confirmation requirements. |
|
method String |
Specifies the mechanism to be used to confirm the subject. This property contains a URI reference that identifies the mechanism to be used to confirm the subject. |
Constructors
public init()
Creates a new SAMLSubjectConfirmation object.
Config Settings (SAMLWriter 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.SAMLWriter Config Settings | ||||||||||||||||||||||||||||||
| IgnoreSystemTrust:
Whether trusted Windows Certificate Stores should be treated as trusted.Specifies whether, during chain validation, the component should respect
the trust to CA certificates as configured in the operating system.
In Windows this effectively defines whether the component should trust the
certificates residing in the Trusted Root Certification Authorities store.
If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as TrustedCertificates property) are considered trusted. |
||||||||||||||||||||||||||||||
| SigAfterIssuer: Specifies whether to insert the signature after the issuer tag in the SAML document.Use this setting to tune up the location of the signature tag in the resulting document. The default value is true. | ||||||||||||||||||||||||||||||
TolerateMinorChainIssues:
Whether to tolerate minor chain issues.This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are:
|
||||||||||||||||||||||||||||||
| UseMicrosoftCTL: Enables or disables automatic use of Microsoft online certificate trust list.Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository. | ||||||||||||||||||||||||||||||
| UseSystemCertificates: Enables or disables the use of the system certificates.Use this property to tell chain validation module automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework. | ||||||||||||||||||||||||||||||
Base Config Settings | ||||||||||||||||||||||||||||||
| CheckKeyIntegrityBeforeUse:
Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit,
but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys. |
||||||||||||||||||||||||||||||
| CookieCaching:
Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.
Supported values are:
|
||||||||||||||||||||||||||||||
| Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. | ||||||||||||||||||||||||||||||
| DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. | ||||||||||||||||||||||||||||||
| EnableClientSideSSLFFDHE:
Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower
algorithm if compared to EC DHE; enabling it may result in slower connections.
This setting only applies to sessions negotiated with TLS version 1.3. |
||||||||||||||||||||||||||||||
| GlobalCookies: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global". | ||||||||||||||||||||||||||||||
| HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. | ||||||||||||||||||||||||||||||
| LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogDetails:
Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogFile: Specifies the debug log filename.Use this property to provide a path to the log file. | ||||||||||||||||||||||||||||||
| LogFilters:
Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogMaxEventCount:
Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects,
depending on the rotation setting and/or the flush mode.
The default value of this setting is 100. |
||||||||||||||||||||||||||||||
LogRotationMode:
Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. | ||||||||||||||||||||||||||||||
| StaticDNS:
Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.
Supported values are:
|
||||||||||||||||||||||||||||||
| StaticIPAddress[domain]: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character. | ||||||||||||||||||||||||||||||
| StaticIPAddresses: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. | ||||||||||||||||||||||||||||||
| Tag: Allows to store any custom data.Use this config property to store any custom data. | ||||||||||||||||||||||||||||||
| UseOwnDNSResolver: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. | ||||||||||||||||||||||||||||||
| UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. | ||||||||||||||||||||||||||||||
| UseSystemOAEPAndPSS:
Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable.
If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations
using its own OAEP/PSS implementation.
This setting only applies to certificates originating from a Windows system store. |
||||||||||||||||||||||||||||||
| UseSystemRandom: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. |