SAMLReader Component
Properties Methods Events Config Settings Errors
The SAMLReader component offers SAML message processing functionality
Syntax
nsoftware.SecureBlackbox.Samlreader
Remarks
SAMLReader provides means for processing of SAML protocol messages and extraction of their elements. Together with SAMLWriter it provides fine-grained access to the contents of SAML messages. You may consider using these classes if functionality offered by SAMLIdPServer and SAMLSPServer is too high a level for your usage scenario.
SAMLReader and SAMLWriter are independent of SAML server controls, and focus on scenarios that require lower-level access to SAML messaging.
SAMLReader can process the following types of SAML messages:
- AssertionIDRequest
- SubjectQuery
- AuthnQuery
- AttributeQuery
- AuthzDecisionQuery
- AuthnRequest
- ManageNameIDRequest
- LogoutRequest
- NameIDMappingRequest
- ArtifactResolve
- Response
Pass your SAML message to Open (or OpenStream) method. Upon processing, component will populate the elements of the message in the properties, such as InputType or Issuer. More complex elements, such as assertions, require pinning with PinAssertion method to be populated in the object properties.
The snippet below shows how to use SAMLReader to process a message of the AuthnRequest type created by the
matching SAMLReader example (or by any compatible SAML endpoint). The input SAML message has the following look:
<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>
You can process this message and access its properties with the following code:
Samlreader reader = new Samlreader();
reader.ValidateSignatures = true;
reader.Open(req);
Log("SAML document loaded. The message is of the " + reader.InputTypeString + " type, and was issued by " + reader.Issuer + " at " + reader.IssueInstant + ".");
if (reader.InputType == SamlreaderInputTypes.cstyAuthnRequest)
{
Log("AuthnRequest.ConsumerServiceURL: " + reader.AuthnRequest.AssertionConsumerServiceURL);
Log("AuthnRequest.ProtocolBinding: " + reader.AuthnRequest.ProtocolBinding);
Log("AuthnRequest.Conditions.NotBefore: " + reader.AuthnRequest.ConditionsNotBefore);
Log("AuthnRequest.Conditions.NotAfter: " + reader.AuthnRequest.ConditionsNotOnOrAfter);
}
if (reader.Signed)
{
Log("The message was signed by " + reader.SigningCertificate.SubjectRDN);
Log("Signature validity: " + reader.SignatureValidationResult.ToString());
}
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
Artifact | Provides access to SAML artifact object. |
ArtifactResolveQuery | Returns the content of the ArtifactResolve query. |
AssertionCount | Returns the number of assertions in the SAML message. |
AssertionIDRequest | Provides access to parameters of AssertionIDRequest element of the message. |
AttrQueryAttributes | Use this property to access the attribute query element of the message. |
AuthnQuery | Use this property to access the AuthnQuery element of the SAML message. |
AuthnRequest | Use this property to access the AuthnRequest element of the SAML message. |
AuthnRequestConditions | Provides access to the AuthnRequest condition collection. |
AuthnRequestScopingIDPList | Provides access to the AuthnRequest scoping IDP list. |
AuthzDecisionQuery | Check this property to access the AuthzDecisionQuery element of the SAML message. |
Binding | Returns the SAML message binding type. |
BlockedCertificates | The certificates that must be rejected as trust anchors. |
ChainValidationDetails | The details of a certificate chain validation outcome. |
ChainValidationResult | The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result. |
Consent | Returns the Consent parameter of the SAML message. |
DecryptionCertificate | Specifies a decryption certificate. |
Destination | Returns the Destination parameter of the SAML message. |
FIPSMode | Reserved. |
ID | Returns the ID of the processed message. |
IgnoreChainValidationErrors | Makes the component tolerant to chain validation errors. |
InputType | Returns the type of the processed message. |
InputTypeString | Returns the type of the processed message, as an original string. |
InResponseTo | Returns the in-response-to parameter of the message. |
IssueInstant | Returns the issue time of the message. |
Issuer | Returns the issuer of the message. |
KnownCertificates | Additional certificates for chain validation. |
KnownCRLs | Additional CRLs for chain validation. |
KnownOCSPs | Additional OCSP responses for chain validation. |
LogoutRequest | Use this property to access the LogoutRequest element of the SAML message. |
ManageNameIDRequest | Use this property to access the ManageNameIDRequest element of the SAML message. |
NameIDMappingRequest | Use this property to access the NameIDMappingRequest element of the SAML message. |
OfflineMode | Switches the component to offline mode. |
PinnedAssertionAttributes | Contains a list of attributes included in the pinned assertion. |
PinnedAssertionConditions | Contains a list of conditions included in the pinned assertion. |
PinnedAssertionInfo | Contains information about the pinned assertion. |
PinnedAssertionIssuer | Returns the pinned assertion issuer. |
PinnedAssertionStatements | Provides the details of statements included with the assertion. |
PinnedAssertionSubjectConfirmations | Contains the details of subject confirmations included with the assertion. |
PinnedAssertionSubjectID | Returns the pinned assertion subject. |
POSTBinding | Provides access to the details of the POST binding. |
Profile | Specifies a pre-defined profile to apply when creating the signature. |
Proxy | The proxy server settings. |
RedirectBinding | Provides the details of the Redirect binding. |
RedirectBindingCertificate | Sets the certificate for validating the signature over the redirect binding. |
Response | Use this property to access the details of the SAML response element. |
SignatureValidationResult | Contains the signature validation result. |
Signed | Returns true it the message is signed. |
SigningCertificate | The certificate of the signature creator. |
SocketSettings | Manages network connection settings. |
SubjectConfirmations | Returns a list of subject confirmations from the SubjectQuery element. |
SubjectID | Returns the subject of the message. |
TLSSettings | Manages TLS layer settings. |
TrustedCertificates | A list of trusted certificates for chain validation. |
UseBinding | Enables or disables automated binding processing. |
ValidateSignatures | Enables or disables automated signature validation. |
ValidationLog | Contains the complete log of the certificate validation routine. |
ValidationMoment | The time point at which chain validity is to be established. |
Version | Returns SAML content version string. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
CompareIDs | Compares two SAML IDs. |
Config | Sets or retrieves a configuration setting. |
DoAction | Performs an additional action. |
GetIDProp | Extracts a specific property from a SAML ID. |
Open | Opens a SAML entity. |
OpenBytes | Opens a SAML entity. |
OpenFile | Opens a SAML entity. |
OpenStream | Opens a SAML entity contained in a stream. |
PinAdviceAssertion | Pins advice assertion by propagating it in PinnedAssertionXXX properties. |
PinAssertion | Pins assertion by propagating it in PinnedAssertionXXX properties. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
Error | Fires to report an error condition. |
Notification | This event notifies the application about an underlying control flow event. |
SignatureFound | Signifies the start of signature validation. |
SignatureValidated | Reports the signature validation result. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
UseMicrosoftCTL | Enables or disables the automatic use of the 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 component. |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
StaticDNS | Specifies whether static DNS rules should be used. |
StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
StaticIPAddresses | Gets or sets all the static DNS rules. |
Tag | Allows to store any custom data. |
TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
UseOwnDNSResolver | Specifies whether the client components should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
Artifact Property (SAMLReader Component)
Provides access to SAML artifact object.
Syntax
public SAMLArtifact Artifact { get; }
Public ReadOnly Property Artifact As SAMLArtifact
Remarks
Use this property to access the parameters of the Artifact object from the SAML message.
This property is read-only and not available at design time.
Please refer to the SAMLArtifact type for a complete list of fields.ArtifactResolveQuery Property (SAMLReader Component)
Returns the content of the ArtifactResolve query.
Syntax
Default Value
""
Remarks
Check this property if InputType is set to cstyArtifactResolve to access the content of the ArtifactResolve query.
This property is read-only and not available at design time.
AssertionCount Property (SAMLReader Component)
Returns the number of assertions in the SAML message.
Syntax
Default Value
0
Remarks
Check this property to retrieve the number of assertions contained in the SAML message.
This property is read-only and not available at design time.
AssertionIDRequest Property (SAMLReader Component)
Provides access to parameters of AssertionIDRequest element of the message.
Syntax
public SAMLAssertionIDRequest AssertionIDRequest { get; }
Public ReadOnly Property AssertionIDRequest As SAMLAssertionIDRequest
Remarks
Use this property to access the parameters of AssertionIDRequest element. Check this property if InputType is returned as cstyAssertionIDRequest, which indicates that the message contains the relevant element.
This property is read-only and not available at design time.
Please refer to the SAMLAssertionIDRequest type for a complete list of fields.AttrQueryAttributes Property (SAMLReader Component)
Use this property to access the attribute query element of the message.
Syntax
public SAMLAttributeList AttrQueryAttributes { get; }
Public ReadOnly Property AttrQueryAttributes As SAMLAttributeList
Remarks
Check this property if InputType is set to cstyAttributeQuery to access the attribute query element of the message.
This property is read-only and not available at design time.
Please refer to the SAMLAttribute type for a complete list of fields.AuthnQuery Property (SAMLReader Component)
Use this property to access the AuthnQuery element of the SAML message.
Syntax
public SAMLAuthnQuery AuthnQuery { get; }
Public ReadOnly Property AuthnQuery As SAMLAuthnQuery
Remarks
Check this property if InputType is set to cstyAuthnQuery to access the parameters of the AuthnQuery element of the SAML message.
This property is read-only and not available at design time.
Please refer to the SAMLAuthnQuery type for a complete list of fields.AuthnRequest Property (SAMLReader Component)
Use this property to access the AuthnRequest element of the SAML message.
Syntax
public SAMLAuthnRequest AuthnRequest { get; }
Public ReadOnly Property AuthnRequest As SAMLAuthnRequest
Remarks
Check this property if InputType is set to cstyAuthnRequest to access the AuthnRequest element of the SAML message.
This property is read-only and not available at design time.
Please refer to the SAMLAuthnRequest type for a complete list of fields.AuthnRequestConditions Property (SAMLReader Component)
Provides access to the AuthnRequest condition collection.
Syntax
public SAMLAssertionConditionList AuthnRequestConditions { get; }
Public ReadOnly Property AuthnRequestConditions As SAMLAssertionConditionList
Remarks
Use this property if InputType is set to cstyAuthnRequest to access the collection of AuthnRequest condition objects.
This property is read-only and not available at design time.
Please refer to the SAMLAssertionCondition type for a complete list of fields.AuthnRequestScopingIDPList Property (SAMLReader Component)
Provides access to the AuthnRequest scoping IDP list.
Syntax
public SAMLIDPEntryList AuthnRequestScopingIDPList { get; }
Public ReadOnly Property AuthnRequestScopingIDPList As SAMLIDPEntryList
Remarks
Use this property if InputType is set to cstyAuthnRequest to access the scoping IDP list.
This property is read-only and not available at design time.
Please refer to the SAMLIDPEntry type for a complete list of fields.AuthzDecisionQuery Property (SAMLReader Component)
Check this property to access the AuthzDecisionQuery element of the SAML message.
Syntax
public SAMLAuthzDecisionQuery AuthzDecisionQuery { get; }
Public ReadOnly Property AuthzDecisionQuery As SAMLAuthzDecisionQuery
Remarks
Use this property if InputType is set to cstyAuthzDecisionQuery to access the AuthzDecisionQuery element.
This property is read-only and not available at design time.
Please refer to the SAMLAuthzDecisionQuery type for a complete list of fields.Binding Property (SAMLReader Component)
Returns the SAML message binding type.
Syntax
public SamlreaderBindings Binding { get; }
enum SamlreaderBindings { csbtNone, csbtSOAP, csbtPAOS, csbtRedirect, csbtPOST, csbtArtifact }
Public ReadOnly Property Binding As SamlreaderBindings
Enum SamlreaderBindings csbtNone csbtSOAP csbtPAOS csbtRedirect csbtPOST csbtArtifact End Enum
Default Value
0
Remarks
Check this property to obtain the message binding type.
This property is read-only.
BlockedCertificates Property (SAMLReader Component)
The certificates that must be rejected as trust anchors.
Syntax
public CertificateList BlockedCertificates { get; }
Public Property BlockedCertificates As CertificateList
Remarks
Use this property to provide a list of compromised or blocked certificates. Any chain containing a blocked certificate will fail validation.
This property is not available at design time.
Please refer to the Certificate type for a complete list of fields.ChainValidationDetails Property (SAMLReader Component)
The details of a certificate chain validation outcome.
Syntax
public int ChainValidationDetails { get; }
Public ReadOnly Property ChainValidationDetails As Integer
Default Value
0
Remarks
Use the value(s) returned by this property to identify the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
This property is read-only and not available at design time.
ChainValidationResult Property (SAMLReader Component)
The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result.
Syntax
public SamlreaderChainValidationResults ChainValidationResult { get; }
enum SamlreaderChainValidationResults { cvtValid, cvtValidButUntrusted, cvtInvalid, cvtCantBeEstablished }
Public ReadOnly Property ChainValidationResult As SamlreaderChainValidationResults
Enum SamlreaderChainValidationResults cvtValid cvtValidButUntrusted cvtInvalid cvtCantBeEstablished End Enum
Default Value
0
Remarks
Available options:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
This property is read-only and not available at design time.
Consent Property (SAMLReader Component)
Returns the Consent parameter of the SAML message.
Syntax
Default Value
""
Remarks
Check this property to access the value of the Consent parameter of the processed SAML message.
This property is read-only and not available at design time.
DecryptionCertificate Property (SAMLReader Component)
Specifies a decryption certificate.
Syntax
public Certificate DecryptionCertificate { get; set; }
Public Property DecryptionCertificate As Certificate
Remarks
Use this property to pass a certificate that should be used to decrypt the encrypted SAML message. The certificate must contain an associated private key.
This property is not available at design time.
Please refer to the Certificate type for a complete list of fields.Destination Property (SAMLReader Component)
Returns the Destination parameter of the SAML message.
Syntax
Default Value
""
Remarks
Check this property to access the Destination parameter of the SAML message.
This property is read-only and not available at design time.
FIPSMode Property (SAMLReader Component)
Reserved.
Syntax
Default Value
False
Remarks
This property is reserved for future use.
ID Property (SAMLReader Component)
Returns the ID of the processed message.
Syntax
Default Value
""
Remarks
Use this property to get the SAML ID value of the message.
This property is read-only and not available at design time.
IgnoreChainValidationErrors Property (SAMLReader Component)
Makes the component tolerant to chain validation errors.
Syntax
public bool IgnoreChainValidationErrors { get; set; }
Public Property IgnoreChainValidationErrors As Boolean
Default Value
False
Remarks
If this property is set to True, any errors emerging during certificate chain validation will be ignored. This setting may be handy if the purpose of validation is the creation of an LTV signature, and the validation is performed in an environment that doesn't trust the signer's certificate chain.
InputType Property (SAMLReader Component)
Returns the type of the processed message.
Syntax
public SamlreaderInputTypes InputType { get; }
enum SamlreaderInputTypes { cstyNone, cstyAssertionIDRequest, cstySubjectQuery, cstyAuthnQuery, cstyAttributeQuery, cstyAuthzDecisionQuery, cstyAuthnRequest, cstyManageNameIDRequest, cstyLogoutRequest, cstyNameIDMappingRequest, cstyArtifactResolve, cstyResponse }
Public ReadOnly Property InputType As SamlreaderInputTypes
Enum SamlreaderInputTypes cstyNone cstyAssertionIDRequest cstySubjectQuery cstyAuthnQuery cstyAttributeQuery cstyAuthzDecisionQuery cstyAuthnRequest cstyManageNameIDRequest cstyLogoutRequest cstyNameIDMappingRequest cstyArtifactResolve cstyResponse End Enum
Default Value
0
Remarks
Check this property on the early stage of message processing to find out the type of the data contained in the SAML message.
This property is read-only and not available at design time.
InputTypeString Property (SAMLReader Component)
Returns the type of the processed message, as an original string.
Syntax
Default Value
""
Remarks
Check this property to find out the content type of the data stored in the processed message. This returns a string originally included in the SAML message, which may be helpful when processing non-standard types.
Known SAML content types are:
- AssertionIDRequest
- SubjectQuery
- AuthnQuery
- AttributeQuery
- AuthzDecisionQuery
- AuthnRequest
- ManageNameIDRequest
- NameIDMappingRequest
- LogoutRequest
- ArtifactResolve
- Response
- LogoutResponse
- ArtifactResponse
- NameIDMappingResponse
This property is read-only and not available at design time.
InResponseTo Property (SAMLReader Component)
Returns the in-response-to parameter of the message.
Syntax
Default Value
""
Remarks
Check this property to obtain the In-Response-To parameter of the SAML message.
This property is read-only and not available at design time.
IssueInstant Property (SAMLReader Component)
Returns the issue time of the message.
Syntax
Default Value
""
Remarks
Check this property to obtain the issuing time of the SAML message.
This property is read-only and not available at design time.
Issuer Property (SAMLReader Component)
Returns the issuer of the message.
Syntax
Default Value
""
Remarks
Check this property to obtain the SAML ID of the issuer of the processed message.
This property is read-only and not available at design time.
KnownCertificates Property (SAMLReader Component)
Additional certificates for chain validation.
Syntax
public CertificateList KnownCertificates { get; }
Public Property KnownCertificates As CertificateList
Remarks
Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually.
The purpose of the certificates to be added to this collection is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows.
Do not add trust anchors or root certificates to this collection: add them to TrustedCertificates instead.
This property is not available at design time.
Please refer to the Certificate type for a complete list of fields.KnownCRLs Property (SAMLReader Component)
Additional CRLs for chain validation.
Syntax
Remarks
Use this property to supply additional CRLs that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated CRLs are stored separately from the signed message or document.
This property is not available at design time.
Please refer to the CRL type for a complete list of fields.KnownOCSPs Property (SAMLReader Component)
Additional OCSP responses for chain validation.
Syntax
public OCSPResponseList KnownOCSPs { get; }
Public Property KnownOCSPs As OCSPResponseList
Remarks
Use this property to supply additional OCSP responses that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated OCSP responses are stored separately from the signed message or document.
This property is not available at design time.
Please refer to the OCSPResponse type for a complete list of fields.LogoutRequest Property (SAMLReader Component)
Use this property to access the LogoutRequest element of the SAML message.
Syntax
public SAMLLogoutRequest LogoutRequest { get; }
Public ReadOnly Property LogoutRequest As SAMLLogoutRequest
Remarks
Check this property if InputType is set to cstyLogoutRequest to access the LogoutRequest element of the SAML message.
This property is read-only and not available at design time.
Please refer to the SAMLLogoutRequest type for a complete list of fields.ManageNameIDRequest Property (SAMLReader Component)
Use this property to access the ManageNameIDRequest element of the SAML message.
Syntax
public SAMLManageNameIDRequest ManageNameIDRequest { get; }
Public ReadOnly Property ManageNameIDRequest As SAMLManageNameIDRequest
Remarks
Check this property if InputType is set to cstyManageNameIDRequest to access the ManageNameIDRequest element of the SAML message.
This property is read-only and not available at design time.
Please refer to the SAMLManageNameIDRequest type for a complete list of fields.NameIDMappingRequest Property (SAMLReader Component)
Use this property to access the NameIDMappingRequest element of the SAML message.
Syntax
public SAMLNameIDMappingRequest NameIDMappingRequest { get; }
Public ReadOnly Property NameIDMappingRequest As SAMLNameIDMappingRequest
Remarks
Use this property if InputType is set to cstyNameIDMappingRequest to access the details of the NameIDMappingRequest element of the SAML message.
This property is read-only and not available at design time.
Please refer to the SAMLNameIDMappingRequest type for a complete list of fields.OfflineMode Property (SAMLReader Component)
Switches the component to offline mode.
Syntax
Default Value
False
Remarks
When working in offline mode, the component restricts itself from using any online revocation information sources, such as CRL or OCSP responders.
Offline mode may be useful if there is a need to verify the completeness of the validation information included within the signature or provided via KnownCertificates, KnownCRLs, and other related properties.
PinnedAssertionAttributes Property (SAMLReader Component)
Contains a list of attributes included in the pinned assertion.
Syntax
public SAMLAttributeList PinnedAssertionAttributes { get; }
Public ReadOnly Property PinnedAssertionAttributes As SAMLAttributeList
Remarks
Use this property to access the list of attributes included in the pinned assertion. Pin an assertion using PinAssertion or PinAdviceAssertion method.
This property is read-only and not available at design time.
Please refer to the SAMLAttribute type for a complete list of fields.PinnedAssertionConditions Property (SAMLReader Component)
Contains a list of conditions included in the pinned assertion.
Syntax
public SAMLAssertionConditionList PinnedAssertionConditions { get; }
Public ReadOnly Property PinnedAssertionConditions As SAMLAssertionConditionList
Remarks
Use this property to access the list of conditions included in the pinned assertion. Pin an assertion using PinAssertion or PinAdviceAssertion method.
This property is read-only and not available at design time.
Please refer to the SAMLAssertionCondition type for a complete list of fields.PinnedAssertionInfo Property (SAMLReader Component)
Contains information about the pinned assertion.
Syntax
public SAMLAssertionInfo PinnedAssertionInfo { get; }
Public ReadOnly Property PinnedAssertionInfo As SAMLAssertionInfo
Remarks
Check this property to access the details of the assertion pinned with PinAssertion or PinAdviceAssertion method.
This property is read-only and not available at design time.
Please refer to the SAMLAssertionInfo type for a complete list of fields.PinnedAssertionIssuer Property (SAMLReader Component)
Returns the pinned assertion issuer.
Syntax
public string PinnedAssertionIssuer { get; }
Public ReadOnly Property PinnedAssertionIssuer As String
Default Value
""
Remarks
Check this property to access the SAML ID of the issuer of the assertion previously pinned with PinAssertion or PinAdviceAssertion method.
This property is read-only and not available at design time.
PinnedAssertionStatements Property (SAMLReader Component)
Provides the details of statements included with the assertion.
Syntax
public SAMLAssertionStatementList PinnedAssertionStatements { get; }
Public ReadOnly Property PinnedAssertionStatements As SAMLAssertionStatementList
Remarks
Use this property to access the statements included in the assertion previously pinned with PinAssertion or PinAdviceAssertion method.
This property is read-only and not available at design time.
Please refer to the SAMLAssertionStatement type for a complete list of fields.PinnedAssertionSubjectConfirmations Property (SAMLReader Component)
Contains the details of subject confirmations included with the assertion.
Syntax
public SAMLSubjectConfirmationList PinnedAssertionSubjectConfirmations { get; }
Public ReadOnly Property PinnedAssertionSubjectConfirmations As SAMLSubjectConfirmationList
Remarks
Check this property to access the subject confirmations included in the assertion previously pinned with PinAssertion or PinAdviceAssertion method.
This property is read-only and not available at design time.
Please refer to the SAMLSubjectConfirmation type for a complete list of fields.PinnedAssertionSubjectID Property (SAMLReader Component)
Returns the pinned assertion subject.
Syntax
public string PinnedAssertionSubjectID { get; }
Public ReadOnly Property PinnedAssertionSubjectID As String
Default Value
""
Remarks
Check this property to access the SAML ID of the subject of the assertion previously pinned with PinAssertion or PinAdviceAssertion method.
This property is read-only and not available at design time.
POSTBinding Property (SAMLReader Component)
Provides access to the details of the POST binding.
Syntax
public SAMLPOSTBinding POSTBinding { get; }
Public ReadOnly Property POSTBinding As SAMLPOSTBinding
Remarks
Check this property to access the details of the POST binding. Use Binding property to obtain the type of binding used in the SAML message.
This property is read-only and not available at design time.
Please refer to the SAMLPOSTBinding type for a complete list of fields.Profile Property (SAMLReader Component)
Specifies a pre-defined profile to apply when creating the signature.
Syntax
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.
Proxy Property (SAMLReader Component)
The proxy server settings.
Syntax
public ProxySettings Proxy { get; }
Public ReadOnly Property Proxy As ProxySettings
Remarks
Use this property to tune up the proxy server settings.
This property is read-only.
Please refer to the ProxySettings type for a complete list of fields.RedirectBinding Property (SAMLReader Component)
Provides the details of the Redirect binding.
Syntax
public SAMLRedirectBinding RedirectBinding { get; }
Public ReadOnly Property RedirectBinding As SAMLRedirectBinding
Remarks
Use this property to get the details of the redirect binding. Check the binding type using the Binding property.
This property is read-only and not available at design time.
Please refer to the SAMLRedirectBinding type for a complete list of fields.RedirectBindingCertificate Property (SAMLReader Component)
Sets the certificate for validating the signature over the redirect binding.
Syntax
public Certificate RedirectBindingCertificate { get; set; }
Public Property RedirectBindingCertificate As Certificate
Remarks
Use this property to provide the certificate to be used for validating the redirect binding signature.
This property is not available at design time.
Please refer to the Certificate type for a complete list of fields.Response Property (SAMLReader Component)
Use this property to access the details of the SAML response element.
Syntax
public SAMLResponse Response { get; }
Public ReadOnly Property Response As SAMLResponse
Remarks
Check this property if InputType is set to cstyResponse to access the details of the SAML response element.
This property is read-only and not available at design time.
Please refer to the SAMLResponse type for a complete list of fields.SignatureValidationResult Property (SAMLReader Component)
Contains the signature validation result.
Syntax
public SamlreaderSignatureValidationResults SignatureValidationResult { get; }
enum SamlreaderSignatureValidationResults { xsvValid, xsvUnknown, xsvCorrupted, xsvSignerNotFound, xsvFailure, xsvReferenceCorrupted }
Public ReadOnly Property SignatureValidationResult As SamlreaderSignatureValidationResults
Enum SamlreaderSignatureValidationResults xsvValid xsvUnknown xsvCorrupted xsvSignerNotFound xsvFailure xsvReferenceCorrupted End Enum
Default Value
0
Remarks
Use this property to check the result of the most recent XML signature validation.
xsvValid | 0 | |
xsvUnknown | 1 | |
xsvCorrupted | 2 | |
xsvSignerNotFound | 3 | |
xsvFailure | 4 | |
xsvReferenceCorrupted | 5 |
This property is read-only and not available at design time.
Signed Property (SAMLReader Component)
Returns true it the message is signed.
Syntax
Default Value
False
Remarks
Check this property to find out whether the SAML entity is signed.
This property is read-only and not available at design time.
SigningCertificate Property (SAMLReader Component)
The certificate of the signature creator.
Syntax
public Certificate SigningCertificate { get; }
Public ReadOnly Property SigningCertificate As Certificate
Remarks
Use this property to access the certificate that was used to create the signature.
This property is read-only and not available at design time.
Please refer to the Certificate type for a complete list of fields.SocketSettings Property (SAMLReader Component)
Manages network connection settings.
Syntax
public SocketSettings SocketSettings { get; }
Public ReadOnly Property SocketSettings As SocketSettings
Remarks
Use this property to tune up network connection parameters.
This property is read-only.
Please refer to the SocketSettings type for a complete list of fields.SubjectConfirmations Property (SAMLReader Component)
Returns a list of subject confirmations from the SubjectQuery element.
Syntax
public SAMLSubjectConfirmationList SubjectConfirmations { get; }
Public ReadOnly Property SubjectConfirmations As SAMLSubjectConfirmationList
Remarks
Check this property when processing a SubjectQuery message (InputType set to cstySubjectQuery) to access the list of subject confirmations.
This property is read-only and not available at design time.
Please refer to the SAMLSubjectConfirmation type for a complete list of fields.SubjectID Property (SAMLReader Component)
Returns the subject of the message.
Syntax
Default Value
""
Remarks
Check this property to obtain the SAML ID of the message subject.
This property is read-only and not available at design time.
TLSSettings Property (SAMLReader Component)
Manages TLS layer settings.
Syntax
public TLSSettings TLSSettings { get; }
Public ReadOnly Property TLSSettings As TLSSettings
Remarks
Use this property to tune up the TLS layer parameters.
This property is read-only.
Please refer to the TLSSettings type for a complete list of fields.TrustedCertificates Property (SAMLReader Component)
A list of trusted certificates for chain validation.
Syntax
public CertificateList TrustedCertificates { get; }
Public Property TrustedCertificates As CertificateList
Remarks
Use this property to supply a list of trusted certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when root CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually.
The purpose of this certificate collection is largely the same as that of the Windows Trusted Root Certification Authorities system store.
Use this property with extreme care as it directly affects chain verifiability; a wrong certificate added to the trusted list may result in bad chains being accepted, and forfeited signatures being recognized as genuine. Only add certificates that originate from the parties that you know and trust.
This property is not available at design time.
Please refer to the Certificate type for a complete list of fields.UseBinding Property (SAMLReader Component)
Enables or disables automated binding processing.
Syntax
Default Value
False
Remarks
This property controls whether component should process any known bindings it encounters in the message automatically. If using this property, check Binding property to establish the type of the binding processed, and POSTBinding and RedirectBinding to access the properties of specific binding types.
This property is not available at design time.
ValidateSignatures Property (SAMLReader Component)
Enables or disables automated signature validation.
Syntax
Default Value
True
Remarks
Use this property to enable or disable automated signature validation by the component.
This property is not available at design time.
ValidationLog Property (SAMLReader Component)
Contains the complete log of the certificate validation routine.
Syntax
Default Value
""
Remarks
Use this property to access the chain validation log produced by the component. The log can be very useful when investigating issues with chain validation, as it contains a step-by-step trace of the entire validation procedure.
This property is read-only and not available at design time.
ValidationMoment Property (SAMLReader Component)
The time point at which chain validity is to be established.
Syntax
Default Value
""
Remarks
Use this property to specify the moment in time at which chain validity should be established. The time is in UTC. Leave the setting empty to stick to the current moment.
The validity of the same chain may differ depending on the time point chosen due to temporal changes in subchain validities and revocation statuses.
Version Property (SAMLReader Component)
Returns SAML content version string.
Syntax
Default Value
""
Remarks
Check this property to read the SAML content version string, such as "2.0".
This property is read-only and not available at design time.
CompareIDs Method (SAMLReader Component)
Compares two SAML IDs.
Syntax
Remarks
Use this utility function to easily compare two SAML IDs.
Config Method (SAMLReader Component)
Sets or retrieves a configuration setting.
Syntax
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
DoAction Method (SAMLReader Component)
Performs an additional action.
Syntax
Remarks
DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier (case insensitive) of the action is provided in the ActionID parameter.
ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
GetIDProp Method (SAMLReader Component)
Extracts a specific property from a SAML ID.
Syntax
Remarks
Use this method to recover a single ID property from a SAML ID.
PropName supports the following properties:
- Format
- NameQualifier
- IDType
- SPNameQualifier
- SPProvidedID
- Value
Open Method (SAMLReader Component)
Opens a SAML entity.
Syntax
Remarks
Use this method to process a SAML entity contained in a string.
OpenBytes Method (SAMLReader Component)
Opens a SAML entity.
Syntax
Remarks
Use this method to process a SAML entity stored as a byte array.
OpenFile Method (SAMLReader Component)
Opens a SAML entity.
Syntax
Remarks
Use this method to process a SAML entity contained in a file.
OpenStream Method (SAMLReader Component)
Opens a SAML entity contained in a stream.
Syntax
public void OpenStream(System.IO.Stream inStrm);
Public Sub OpenStream(ByVal InStrm As System.IO.Stream)
Remarks
Use this method to process a SAML entity contained in a stream.
PinAdviceAssertion Method (SAMLReader Component)
Pins advice assertion by propagating it in PinnedAssertionXXX properties.
Syntax
Remarks
Call this method to pin the advice assertion specified by AssertionIndex by publishing it in the selection of PinnedAssertionXXX properties, such as PinnedAssertionInfo. Use AdviceAssertionIndex to specify the advice assertion index.
PinAssertion Method (SAMLReader Component)
Pins assertion by propagating it in PinnedAssertionXXX properties.
Syntax
Public Sub PinAssertion(ByVal AssertionIndex As Integer)
Remarks
Use this method to pin a SAML assertion specified by its AssertionIndex in the selection of PinnedAssertionXXX properties, such as PinnedAssertionInfo.
Check AssertionCount to obtain the number of assertions in the message.
Error Event (SAMLReader Component)
Fires to report an error condition.
Syntax
public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, SamlreaderErrorEventArgs e); public class SamlreaderErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } }
Public Event OnError As OnErrorHandler Public Delegate Sub OnErrorHandler(sender As Object, e As SamlreaderErrorEventArgs) Public Class SamlreaderErrorEventArgs Inherits EventArgs Public ReadOnly Property ErrorCode As Integer Public ReadOnly Property Description As String End Class
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 (SAMLReader Component)
This event notifies the application about an underlying control flow event.
Syntax
public event OnNotificationHandler OnNotification; public delegate void OnNotificationHandler(object sender, SamlreaderNotificationEventArgs e); public class SamlreaderNotificationEventArgs : EventArgs { public string EventID { get; } public string EventParam { get; } }
Public Event OnNotification As OnNotificationHandler Public Delegate Sub OnNotificationHandler(sender As Object, e As SamlreaderNotificationEventArgs) Public Class SamlreaderNotificationEventArgs Inherits EventArgs Public ReadOnly Property EventID As String Public ReadOnly Property EventParam As String End Class
Remarks
The component 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 the 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.
SignatureFound Event (SAMLReader Component)
Signifies the start of signature validation.
Syntax
public event OnSignatureFoundHandler OnSignatureFound; public delegate void OnSignatureFoundHandler(object sender, SamlreaderSignatureFoundEventArgs e); public class SamlreaderSignatureFoundEventArgs : EventArgs { public string IssuerRDN { get; } public byte[] SerialNumber { get; } public byte[] SubjectKeyID { get; } public bool CertFound { get; } public bool ValidateSignature { get; set; } public bool ValidateChain { get; set; } }
Public Event OnSignatureFound As OnSignatureFoundHandler Public Delegate Sub OnSignatureFoundHandler(sender As Object, e As SamlreaderSignatureFoundEventArgs) Public Class SamlreaderSignatureFoundEventArgs Inherits EventArgs Public ReadOnly Property IssuerRDN As String Public ReadOnly Property SerialNumber As Byte() Public ReadOnly Property SubjectKeyID As Byte() Public ReadOnly Property CertFound As Boolean Public Property ValidateSignature As Boolean Public Property ValidateChain As Boolean End Class
Remarks
This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified document or message.
The CertFound parameter is set to True if the component has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the KnownCertificates property.
Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the SignatureValidationResult and ChainValidationResult properties respectively.
Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.
SignatureValidated Event (SAMLReader Component)
Reports the signature validation result.
Syntax
public event OnSignatureValidatedHandler OnSignatureValidated; public delegate void OnSignatureValidatedHandler(object sender, SamlreaderSignatureValidatedEventArgs e); public class SamlreaderSignatureValidatedEventArgs : EventArgs { public string IssuerRDN { get; } public byte[] SerialNumber { get; } public byte[] SubjectKeyID { get; } public int ValidationResult { get; } }
Public Event OnSignatureValidated As OnSignatureValidatedHandler Public Delegate Sub OnSignatureValidatedHandler(sender As Object, e As SamlreaderSignatureValidatedEventArgs) Public Class SamlreaderSignatureValidatedEventArgs Inherits EventArgs Public ReadOnly Property IssuerRDN As String Public ReadOnly Property SerialNumber As Byte() Public ReadOnly Property SubjectKeyID As Byte() Public ReadOnly Property ValidationResult As Integer End Class
Remarks
This event is fired when the complete XML signature validation process is finished. IssuerRDN returns the name of the signature issuer, SerialNumber identifies the signing certificate, SubjectKeyID contains the key identifier (SecureBlackbox uses SHA-1 hash algorithm output as key identifiers). Finally, ValidationResult specifies whether signature is valid or not:
xsvValid | 0 | |
xsvUnknown | 1 | |
xsvCorrupted | 2 | |
xsvSignerNotFound | 3 | |
xsvFailure | 4 | |
xsvReferenceCorrupted | 5 |
Certificate Type
Provides details of an individual X.509 certificate.
Remarks
This type provides access to X.509 certificate details.
Fields
Bytes
byte[] (read-only)
Default Value: ""
Returns the raw certificate data in DER format.
CA
bool
Default Value: False
Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).
CAKeyID
byte[] (read-only)
Default Value: ""
A unique identifier (fingerprint) of the CA certificate's private key.
Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.
CRLDistributionPoints
string
Default Value: ""
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
Curve
string
Default Value: ""
Specifies the elliptic curve of the EC public key.
SB_EC_SECP112R1 | SECP112R1 | |
SB_EC_SECP112R2 | SECP112R2 | |
SB_EC_SECP128R1 | SECP128R1 | |
SB_EC_SECP128R2 | SECP128R2 | |
SB_EC_SECP160K1 | SECP160K1 | |
SB_EC_SECP160R1 | SECP160R1 | |
SB_EC_SECP160R2 | SECP160R2 | |
SB_EC_SECP192K1 | SECP192K1 | |
SB_EC_SECP192R1 | SECP192R1 | |
SB_EC_SECP224K1 | SECP224K1 | |
SB_EC_SECP224R1 | SECP224R1 | |
SB_EC_SECP256K1 | SECP256K1 | |
SB_EC_SECP256R1 | SECP256R1 | |
SB_EC_SECP384R1 | SECP384R1 | |
SB_EC_SECP521R1 | SECP521R1 | |
SB_EC_SECT113R1 | SECT113R1 | |
SB_EC_SECT113R2 | SECT113R2 | |
SB_EC_SECT131R1 | SECT131R1 | |
SB_EC_SECT131R2 | SECT131R2 | |
SB_EC_SECT163K1 | SECT163K1 | |
SB_EC_SECT163R1 | SECT163R1 | |
SB_EC_SECT163R2 | SECT163R2 | |
SB_EC_SECT193R1 | SECT193R1 | |
SB_EC_SECT193R2 | SECT193R2 | |
SB_EC_SECT233K1 | SECT233K1 | |
SB_EC_SECT233R1 | SECT233R1 | |
SB_EC_SECT239K1 | SECT239K1 | |
SB_EC_SECT283K1 | SECT283K1 | |
SB_EC_SECT283R1 | SECT283R1 | |
SB_EC_SECT409K1 | SECT409K1 | |
SB_EC_SECT409R1 | SECT409R1 | |
SB_EC_SECT571K1 | SECT571K1 | |
SB_EC_SECT571R1 | SECT571R1 | |
SB_EC_PRIME192V1 | PRIME192V1 | |
SB_EC_PRIME192V2 | PRIME192V2 | |
SB_EC_PRIME192V3 | PRIME192V3 | |
SB_EC_PRIME239V1 | PRIME239V1 | |
SB_EC_PRIME239V2 | PRIME239V2 | |
SB_EC_PRIME239V3 | PRIME239V3 | |
SB_EC_PRIME256V1 | PRIME256V1 | |
SB_EC_C2PNB163V1 | C2PNB163V1 | |
SB_EC_C2PNB163V2 | C2PNB163V2 | |
SB_EC_C2PNB163V3 | C2PNB163V3 | |
SB_EC_C2PNB176W1 | C2PNB176W1 | |
SB_EC_C2TNB191V1 | C2TNB191V1 | |
SB_EC_C2TNB191V2 | C2TNB191V2 | |
SB_EC_C2TNB191V3 | C2TNB191V3 | |
SB_EC_C2ONB191V4 | C2ONB191V4 | |
SB_EC_C2ONB191V5 | C2ONB191V5 | |
SB_EC_C2PNB208W1 | C2PNB208W1 | |
SB_EC_C2TNB239V1 | C2TNB239V1 | |
SB_EC_C2TNB239V2 | C2TNB239V2 | |
SB_EC_C2TNB239V3 | C2TNB239V3 | |
SB_EC_C2ONB239V4 | C2ONB239V4 | |
SB_EC_C2ONB239V5 | C2ONB239V5 | |
SB_EC_C2PNB272W1 | C2PNB272W1 | |
SB_EC_C2PNB304W1 | C2PNB304W1 | |
SB_EC_C2TNB359V1 | C2TNB359V1 | |
SB_EC_C2PNB368W1 | C2PNB368W1 | |
SB_EC_C2TNB431R1 | C2TNB431R1 | |
SB_EC_NISTP192 | NISTP192 | |
SB_EC_NISTP224 | NISTP224 | |
SB_EC_NISTP256 | NISTP256 | |
SB_EC_NISTP384 | NISTP384 | |
SB_EC_NISTP521 | NISTP521 | |
SB_EC_NISTB163 | NISTB163 | |
SB_EC_NISTB233 | NISTB233 | |
SB_EC_NISTB283 | NISTB283 | |
SB_EC_NISTB409 | NISTB409 | |
SB_EC_NISTB571 | NISTB571 | |
SB_EC_NISTK163 | NISTK163 | |
SB_EC_NISTK233 | NISTK233 | |
SB_EC_NISTK283 | NISTK283 | |
SB_EC_NISTK409 | NISTK409 | |
SB_EC_NISTK571 | NISTK571 | |
SB_EC_GOSTCPTEST | GOSTCPTEST | |
SB_EC_GOSTCPA | GOSTCPA | |
SB_EC_GOSTCPB | GOSTCPB | |
SB_EC_GOSTCPC | GOSTCPC | |
SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
SB_EC_CURVE25519 | CURVE25519 | |
SB_EC_CURVE448 | CURVE448 |
Fingerprint
byte[] (read-only)
Default Value: ""
Contains the fingerprint (a hash imprint) of this certificate.
FriendlyName
string (read-only)
Default Value: ""
Contains an associated alias (friendly name) of the certificate.
HashAlgorithm
string
Default Value: ""
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
Issuer
string (read-only)
Default Value: ""
The common name of the certificate issuer (CA), typically a company name.
IssuerRDN
string
Default Value: ""
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
KeyAlgorithm
string
Default Value: "0"
Specifies the public key algorithm of this certificate.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
KeyBits
int (read-only)
Default Value: 0
Returns the length of the public key.
KeyFingerprint
byte[] (read-only)
Default Value: ""
Returns a fingerprint of the public key contained in the certificate.
KeyUsage
int
Default Value: 0
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
ckuUnknown | 0x00000 | Unknown key usage |
ckuDigitalSignature | 0x00001 | Digital signature |
ckuNonRepudiation | 0x00002 | Non-repudiation |
ckuKeyEncipherment | 0x00004 | Key encipherment |
ckuDataEncipherment | 0x00008 | Data encipherment |
ckuKeyAgreement | 0x00010 | Key agreement |
ckuKeyCertSign | 0x00020 | Certificate signing |
ckuCRLSign | 0x00040 | Revocation signing |
ckuEncipherOnly | 0x00080 | Encipher only |
ckuDecipherOnly | 0x00100 | Decipher only |
ckuServerAuthentication | 0x00200 | Server authentication |
ckuClientAuthentication | 0x00400 | Client authentication |
ckuCodeSigning | 0x00800 | Code signing |
ckuEmailProtection | 0x01000 | Email protection |
ckuTimeStamping | 0x02000 | Timestamping |
ckuOCSPSigning | 0x04000 | OCSP signing |
ckuSmartCardLogon | 0x08000 | Smartcard logon |
ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
KeyValid
bool (read-only)
Default Value: False
Returns True if the certificate's key is cryptographically valid, and False otherwise.
OCSPLocations
string
Default Value: ""
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
OCSPNoCheck
bool
Default Value: False
Accessor to the value of the certificate's ocsp-no-check extension.
Origin
int (read-only)
Default Value: 0
Returns the origin of this certificate.
PolicyIDs
string
Default Value: ""
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
PrivateKeyBytes
byte[] (read-only)
Default Value: ""
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.
PrivateKeyExists
bool (read-only)
Default Value: False
Indicates whether the certificate has an associated private key.
PrivateKeyExtractable
bool (read-only)
Default Value: False
Indicates whether the private key is extractable.
PublicKeyBytes
byte[] (read-only)
Default Value: ""
Contains the certificate's public key in DER format.
QualifiedStatements
QualifiedStatementsTypes
Default Value: 0
Returns the qualified status of the certificate.
SelfSigned
bool (read-only)
Default Value: False
Indicates whether the certificate is self-signed (root) or signed by an external CA.
SerialNumber
byte[]
Default Value: ""
Returns the certificate's serial number.
SigAlgorithm
string (read-only)
Default Value: ""
Indicates the algorithm that was used by the CA to sign this certificate.
Subject
string (read-only)
Default Value: ""
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
SubjectAlternativeName
string
Default Value: ""
Returns or sets the value of the Subject Alternative Name extension of the certificate.
SubjectKeyID
byte[]
Default Value: ""
Contains a unique identifier (fingerprint) of the certificate's private key.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.
SubjectRDN
string
Default Value: ""
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
ValidFrom
string
Default Value: ""
The time point at which the certificate becomes valid, in UTC.
ValidTo
string
Default Value: ""
The time point at which the certificate expires, in UTC.
Constructors
public Certificate(byte[] bytes, int startIndex, int count, string password);
Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer, ByVal Password As String)
Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.
Loads the X.509 certificate from a memory buffer. CertBytes is a buffer containing the raw certificate data. CertStartIndex and CertCount specify the number of bytes to be read from the buffer, respectively. KeyBytes is a buffer containing the private key data. KeyStartIndex and KeyCount specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.
public Certificate(byte[] bytes, int startIndex, int count);
Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)
Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively.
public Certificate(string path, string password);
Public Certificate(ByVal Path As String, ByVal Password As String)
Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data. Password is a password encrypting the certificate.
public Certificate(string certPath, string keyPath, string password);
Public Certificate(ByVal CertPath As String, ByVal KeyPath As String, ByVal Password As String)
Loads the X.509 certificate from a file. CertPath specifies the full path to the file containing the certificate data. KeyPath specifies the full path to the file containing the private key. Password is a password encrypting the certificate.
public Certificate(string path);
Public Certificate(ByVal Path As String)
Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.
public Certificate(System.IO.Stream stream);
Public Certificate(ByVal Stream As System.IO.Stream)
Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.
public Certificate(System.IO.Stream stream, string password);
Public Certificate(ByVal Stream As System.IO.Stream, ByVal Password As String)
Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data. Password is a password encrypting the certificate.
public Certificate(System.IO.Stream certStream, System.IO.Stream keyStream, string password);
Public Certificate(ByVal CertStream As System.IO.Stream, ByVal KeyStream As System.IO.Stream, ByVal Password As String)
Loads the X.509 certificate from a stream. CertStream is a stream containing the certificate data. KeyStream is a stream containing the private key. Password is a password encrypting the certificate.
public Certificate();
Public Certificate()
Creates a new object with default field values.
CRL Type
Represents a Certificate Revocation List.
Remarks
CRLs store information about revoked certificates, i.e., certificates that have been identified as invalid by their issuing certificate authority (CA) for any number of reasons.
Each CRL object lists certificates from a single CA and identifies them by their serial numbers. A CA may or may not publish a CRL, may publish several CRLs, or may publish the same CRL in multiple locations.
Unlike OCSP responses, CRLs only list certificates that have been revoked. They do not list certificates that are still valid.
Fields
Bytes
byte[] (read-only)
Default Value: ""
Returns the raw CRL data in DER format.
CAKeyID
byte[]
Default Value: ""
A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.
EntryCount
int (read-only)
Default Value: 0
Returns the number of certificate status entries in the CRL.
Issuer
string (read-only)
Default Value: ""
The common name of the CRL issuer (CA), typically a company name.
IssuerRDN
string (read-only)
Default Value: ""
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
Location
string (read-only)
Default Value: ""
The URL that the CRL was downloaded from.
NextUpdate
string (read-only)
Default Value: ""
The planned time and date of the next version of this CRL to be published.
SigAlgorithm
string (read-only)
Default Value: "0"
The public key algorithm that was used by the CA to sign this CRL.
TBS
byte[] (read-only)
Default Value: ""
The to-be-signed part of the CRL (the CRL without the signature part).
ThisUpdate
string (read-only)
Default Value: ""
The date and time at which this version of the CRL was published.
Constructors
Creates a CRL object from a memory buffer. Bytes is a buffer containing raw (DER) CRL data, StartIndex and Count specify the starting position and the length of the CRL data in the buffer, respectively.
Creates a CRL object by downloading it from a remote location.
public CRL(System.IO.Stream stream);
Public CRL(ByVal Stream As System.IO.Stream)
Creates a CRL object from data contained in a stream.
Creates an empty CRL object.
OCSPResponse Type
Represents a single OCSP response originating from an OCSP responder.
Remarks
OCSP is a protocol that allows verification of certificate status in real-time, and is an alternative to Certificate Revocation Lists (CRLs).
An OCSP response is a snapshot of the certificate status at a given time.
Fields
Bytes
byte[] (read-only)
Default Value: ""
A buffer containing the raw OCSP response data.
EntryCount
int (read-only)
Default Value: 0
The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status.
Issuer
string (read-only)
Default Value: ""
Indicates the issuer of this response (a CA or its authorized representative).
IssuerRDN
string (read-only)
Default Value: ""
Indicates the RDN of the issuer of this response (a CA or its authorized representative).
Location
string (read-only)
Default Value: ""
The location of the OCSP responder.
ProducedAt
string (read-only)
Default Value: ""
Specifies the time when the response was produced, in UTC.
Constructors
public OCSPResponse(byte[] bytes, int startIndex, int count);
Public OCSPResponse(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)
Initializes the response from a memory buffer. Bytes is a buffer containing raw OCSP response data, StartIndex and Count specify the starting position and the number of bytes to be read from this buffer.
public OCSPResponse(string location);
Public OCSPResponse(ByVal Location As String)
Downloads an OCSP response from a remote location.
public OCSPResponse(System.IO.Stream stream);
Public OCSPResponse(ByVal Stream As System.IO.Stream)
Initializes the response with the data from a stream.
public OCSPResponse();
Public OCSPResponse()
Creates an empty OCSP response object.
ProxySettings Type
A container for proxy server settings.
Remarks
This type exposes a collection of properties for tuning up the proxy server configuration.
Fields
Address
string
Default Value: ""
The IP address of the proxy server.
Authentication
ProxyAuthTypes
Default Value: 0
The authentication type used by the proxy server.
patNoAuthentication | 0 |
patBasic | 1 |
patDigest | 2 |
patNTLM | 3 |
Password
string
Default Value: ""
The password to authenticate to the proxy server.
Port
int
Default Value: 0
The port on the proxy server to connect to.
ProxyType
ProxyTypes
Default Value: 0
The type of the proxy server.
The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.
cptNone | 0 |
cptSocks4 | 1 |
cptSocks5 | 2 |
cptWebTunnel | 3 |
cptHTTP | 4 |
RequestHeaders
string
Default Value: ""
Contains HTTP request headers for WebTunnel and HTTP proxy.
ResponseBody
string
Default Value: ""
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
ResponseHeaders
string
Default Value: ""
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
UseIPv6
bool
Default Value: False
Specifies whether IPv6 should be used when connecting through the proxy.
UseProxy
bool
Default Value: False
Enables or disables proxy-driven connection.
Username
string
Default Value: ""
Specifies the username credential for proxy authentication.
Constructors
public ProxySettings();
Public ProxySettings()
Creates a new ProxySettings object.
SAMLArtifact Type
Represents a SAML Artifact entity.
Remarks
This type is a container for a SAML Artifact entity. A SAML artifact consists of a TypeCode, an EndpointIndex, and a RemainingArtifact, which contains the body of the artifact and varies depending on the TypeCode.
Fields
EndpointIndex
int
Default Value: 0
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
byte[]
Default Value: ""
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
byte[] (read-only)
Default Value: ""
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
byte[]
Default Value: ""
An accessor to the SourceID property of the artifact.
SourceID uniquely identifies the issuer of the artifact.
TypeCode
int
Default Value: 0
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 RemainingArtifact, SourceID, and MessageHandle parameters.
URI
string
Default Value: ""
An accessor to the URI property of the artifact.
The URI property contains the origin of the artifact.
Constructors
public SAMLArtifact();
Public SAMLArtifact()
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
Default Value: ""
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
Default Value: 0
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
int
Default Value: 0
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 SAMLAssertionCondition();
Public SAMLAssertionCondition()
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
Default Value: ""
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 SAMLAssertionIDRequest();
Public SAMLAssertionIDRequest()
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
int
Default Value: 0
Contains the number of advice assertions.
Use this property to access the number of advice assertions.
AssertionType
SAMLAssertionTypes
Default Value: 0
Specifies the type of the assertion.
Use this property to check or set the type of the assertion.
ChainValidationDetails
int (read-only)
Default Value: 0
The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
ChainValidationResult
ChainValidities (read-only)
Default Value: 0
The outcome of a certificate chain validation routine.
Available options:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
ConditionsNotBefore
string
Default Value: ""
Represents the Conditions.NotBefore assertion property.
Use this property to get or set the Conditions.NotBefore property of the assertion.
ConditionsNotOnOrAfter
string
Default Value: ""
Represents the Conditions.NotOnOrAfter assertion property.
Use this property to get or set the Conditions.NotOnOrAfter property of the assertion.
EncryptedContent
string
Default Value: ""
Represents the encrypted assertion content.
Use this property to get or set the encrypted assertion content.
ID
string
Default Value: ""
Represents the ID of the assertion.
Use this property to read or set the unique ID of the assertion.
IDRef
string
Default Value: ""
Represents an ID reference value.
Use this property to read or set the ID reference value for assertions of csatAssertionIDRef type.
IssueInstant
string
Default Value: ""
Contains the assertion issuance time stamp.
Use this property to check or set the assertion issuance time.
SignatureValidationResult
SignatureValidities (read-only)
Default Value: 0
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
Signed
bool
Default Value: False
Specifies whether the assertion is signed.
Use this property to establish whether the assertion is signed.
URIRef
string
Default Value: ""
Represents an URI reference value.
Use this property to read or set the URI reference value for assertions of csatAssertionURIRef type.
ValidationLog
string (read-only)
Default Value: ""
Contains the signing certificate's chain validation log. This information may be very useful in investigating chain validation failures.
Version
string
Default Value: ""
Specifies the SAML protocol version used.
This property specifies the SAML protocol version. The default value is 2.0.
Constructors
public SAMLAssertionInfo();
Public SAMLAssertionInfo()
Creates a new SAMLAssertionInfo object.
SAMLAssertionStatement Type
Represents an assertion statement.
Remarks
This type is a container for an assertion statement.
Fields
Attributes
string
Default Value: ""
Contains a list of statement attribute names.
Use this property to access the set of names of assertion attributes, separated by CRLF.
AuthnContextAuthenticatingAuthorities
string
Default Value: ""
Contains the list of authenticating authorities.
Use this property to access the list of URIs of authenticating authorities (IdP entity IDs).
AuthnContextChoice
string
Default Value: ""
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
Default Value: ""
Indicates the authentication contexts class reference.
Use this property to get or set the authentication contexts class reference attribute.
AuthnContextDecl
string
Default Value: ""
Specifies the authentication contexts declaration.
Use this property to access or set the declaration element of the authentication context.
AuthnContextDeclRef
string
Default Value: ""
Specifies the authentication contexts declaration reference.
Use this property to get or set the declaration reference of the authentication context.
AuthnInstant
string
Default Value: ""
Specifies the authentication event timestamp.
Use this property to read or set the moment in time the authentication event took place.
AuthnSessionIndex
string
Default Value: ""
Contains the authentication session index.
Use this property to access or set the authentication session index.
AuthnSessionNotOnOrAfter
string
Default Value: ""
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
Default Value: ""
Specifies the authentication subjects address.
Use this property to specify the address parameter of the authentication subjects locality.
AuthnSubjectLocalityDNSName
string
Default Value: ""
Maps to the authentication subjects DNS name parameter.
Use this property to access or set the authentication subjects DNS name locality parameter.
AuthzActions
string
Default Value: ""
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
Default Value: 0
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
Default Value: ""
Manages the authorization decision statement evidence parameter.
Use this property to read or set the authorization decision statement evidence parameter.
AuthzDecisionResource
string
Default Value: ""
Specifies the authorization decision statement resource parameter.
Use this property to access or set the resource parameter of the authorization statement.
StatementType
SAMLAssertionStatementTypes
Default Value: 0
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 SAMLAssertionStatement();
Public SAMLAssertionStatement()
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
Default Value: ""
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
Default Value: ""
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
Default Value: ""
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
int
Default Value: -1
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
Default Value: ""
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 SAMLAttribute();
Public SAMLAttribute()
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
Default Value: 0
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
Default Value: ""
Specifies the context class reference.
Use this property to access or set the authentication context class reference.
RefType
SAMLAuthnRefTypes
Default Value: 0
Specifies the context reference type.
Use this property to access or set the authentication contexts reference type (class or declaration).
SessionIndex
string
Default Value: ""
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 SAMLAuthnQuery();
Public SAMLAuthnQuery()
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
int
Default Value: 0
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
Default Value: ""
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
int
Default Value: 0
Specifies the attribute consuming service index.
Use this property to read or set the attribute consuming service index.
ConditionsNotBefore
string
Default Value: ""
Specifies the NotBefore condition of the request.
Use this property to access or set the NotBefore condition of the request.
ConditionsNotOnOrAfter
string
Default Value: ""
Provides access to the NotOnOrAfter condition of the request.
Use this property to access or set the NotOnOrAfter condition of the request.
ContextClassRefs
string
Default Value: ""
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
Default Value: 0
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
Default Value: 0
Specifies the context reference type.
Use this property to get or set the context reference type (Class or Declaration).
ForceAuthn
bool
Default Value: False
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
Default Value: False
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
Default Value: False
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
Default Value: ""
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
Default Value: ""
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
Default Value: False
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
Default Value: ""
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
Default Value: ""
Specifies the name of the requestor.
Use this property to read or set the name of the requestor.
ScopingIDPListGetComplete
string
Default Value: ""
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
int
Default Value: 0
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
Default Value: ""
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
Default Value: False
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
Default Value: False
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 SAMLAuthnRequest();
Public SAMLAuthnRequest()
Creates a new SAMLAuthnRequest object.
SAMLAuthzDecisionQuery Type
Represents SAML AuthzDecisionQuery element.
Remarks
This type is a container for SAML AuthzDecisionQuery type.
Fields
Actions
string
Default Value: ""
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
Default Value: ""
Matches the Resource element of the query.
Use this property to read or set the Resource element of the authorization decision query.
Constructors
public SAMLAuthzDecisionQuery();
Public SAMLAuthzDecisionQuery()
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
Default Value: ""
Contains the value of the Loc attribute.
Use this property to access or set the value of the Loc (location) attribute.
Name
string
Default Value: ""
Contains the name of the IdP provider.
Use this property to retrieve or set the Name attribute of the IdP provider.
ProviderID
string
Default Value: ""
Contains the provider ID.
Use this property to read or set the identity provider ID.
Constructors
public SAMLIDPEntry();
Public SAMLIDPEntry()
Creates a new SAMLIDPEntry object.
SAMLLogoutRequest Type
Represents SAML LogoutRequest element.
Remarks
This type is a container for SAML LogoutRequest element.
Fields
NameID
string
Default Value: ""
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
Default Value: ""
Contains the value of the NotOnOrAfter parameter.
Use this property to access or set the value of the NotOnOrAfter parameter.
Reason
string
Default Value: ""
Contains the value of the Reason parameter.
Use this property to read or set the value of the Reason parameter.
SessionIndexes
string
Default Value: ""
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 SAMLLogoutRequest();
Public SAMLLogoutRequest()
Creates a new SAMLLogoutRequest object.
SAMLManageNameIDRequest Type
Represents a SAML ManageNameIDRequest element.
Remarks
This type is a container for ManageNameIDRequest element.
Fields
NameID
string
Default Value: ""
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
Default Value: ""
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
Default Value: ""
Contains the value of the NewID parameter.
Use this property to access or set the NewID parameter of the request.
Terminate
string
Default Value: ""
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 SAMLManageNameIDRequest();
Public SAMLManageNameIDRequest()
Creates a new SAMLManageNameIDRequest object.
SAMLNameIDMappingRequest Type
Represents SAML NameIDMappingRequest element.
Remarks
This type is a container for NameIDMappingRequest element.
Fields
NameID
string
Default Value: ""
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
Default Value: False
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
Default Value: ""
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
Default Value: ""
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
Default Value: False
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 SAMLNameIDMappingRequest();
Public SAMLNameIDMappingRequest()
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
Default Value: ""
Contains the form body.
Use this property to read or set the body of the form returned by the service provider.
FormTemplate
string
Default Value: ""
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
Default Value: 0
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
Default Value: ""
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
Default Value: ""
Contains the URL of POST binding mechanism.
Use this property to check or set the URL of POST binding mechanism.
Constructors
public SAMLPOSTBinding();
Public SAMLPOSTBinding()
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
Default Value: ""
Specifies the message encoding.
Use this property to access or set the message encoding.
ForceSign
bool
Default Value: False
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 Sign.
RelayState
string
Default Value: ""
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
Default Value: False
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 ForceSign property to enforce signatures on all binding entities.
SignatureAlgorithm
string
Default Value: ""
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
Default Value: ""
Contains the URL of the request query.
Use this property to read or set the URL of the request query.
VerifySignatures
bool
Default Value: False
Instructs the component whether to verify incoming signatures.
Use this property to activate or deactivate verification of signatures in incoming requests.
Constructors
public SAMLRedirectBinding();
Public SAMLRedirectBinding()
Creates a new SAMLRedirectBinding object.
SAMLResponse Type
Represents a SAML response.
Remarks
This is a container for SAML response parameters.
Fields
NameID
string
Default Value: ""
Contains the NameID parameter of a NameIDMapping response.
Use this property to read or set the NameID parameter of the NameIDMapping response.
OptionalElement
string
Default Value: ""
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
Default Value: 0
Contains the type of the response.
Use this property to get or set the type of the SAML response.
StatusCodeSubValue
string
Default Value: ""
The value of the nested StatusCode.
This property contains the value of the nested StatusCode element.
StatusCodeValue
string
Default Value: ""
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
Default Value: ""
Contains additional information on the status of the request.
The StatusDetail element contains additional request status information.
StatusMessage
string
Default Value: ""
Contains a status message (optional).
This property specifies the status message which may, optionally, be returned to an operator.
Constructors
public SAMLResponse();
Public SAMLResponse()
Creates a new SAMLResponse object.
SAMLSubjectConfirmation Type
Represents SAML SubjectConfirmation element.
Remarks
This type is a container for SAML SubjectConfirmating element.
Fields
DataAddress
string
Default Value: ""
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
Default Value: ""
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
Default Value: ""
Time moment before which the subject cannot be confirmed.
This property specifies the time before which the subject cannot be confirmed.
DataNotOnOrAfter
string
Default Value: ""
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
Default Value: ""
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
Default Value: ""
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
Default Value: ""
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
Default Value: ""
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 SAMLSubjectConfirmation();
Public SAMLSubjectConfirmation()
Creates a new SAMLSubjectConfirmation object.
SocketSettings Type
A container for the socket settings.
Remarks
This type is a container for socket-layer parameters.
Fields
DNSMode
DNSResolveModes
Default Value: 0
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
dmAuto | 0 |
dmPlatform | 1 |
dmOwn | 2 |
dmOwnSecure | 3 |
DNSPort
int
Default Value: 0
Specifies the port number to be used for sending queries to the DNS server.
DNSQueryTimeout
int
Default Value: 0
The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.
DNSServers
string
Default Value: ""
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
DNSTotalTimeout
int
Default Value: 0
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.
IncomingSpeedLimit
int
Default Value: 0
The maximum number of bytes to read from the socket, per second.
LocalAddress
string
Default Value: ""
The local network interface to bind the socket to.
LocalPort
int
Default Value: 0
The local port number to bind the socket to.
OutgoingSpeedLimit
int
Default Value: 0
The maximum number of bytes to write to the socket, per second.
Timeout
int
Default Value: 60000
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).
UseIPv6
bool
Default Value: False
Enables or disables IP protocol version 6.
Constructors
public SocketSettings();
Public SocketSettings()
Creates a new SocketSettings object.
TLSSettings Type
A container for TLS connection settings.
Remarks
The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.
Fields
AutoValidateCertificates
bool
Default Value: True
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
BaseConfiguration
SecureTransportPredefinedConfigurations
Default Value: 0
Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.
stpcDefault | 0 | |
stpcCompatible | 1 | |
stpcComprehensiveInsecure | 2 | |
stpcHighlySecure | 3 |
Ciphersuites
string
Default Value: ""
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.
Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
- NULL_NULL_NULL
- RSA_NULL_MD5
- RSA_NULL_SHA
- RSA_RC4_MD5
- RSA_RC4_SHA
- RSA_RC2_MD5
- RSA_IDEA_MD5
- RSA_IDEA_SHA
- RSA_DES_MD5
- RSA_DES_SHA
- RSA_3DES_MD5
- RSA_3DES_SHA
- RSA_AES128_SHA
- RSA_AES256_SHA
- DH_DSS_DES_SHA
- DH_DSS_3DES_SHA
- DH_DSS_AES128_SHA
- DH_DSS_AES256_SHA
- DH_RSA_DES_SHA
- DH_RSA_3DES_SHA
- DH_RSA_AES128_SHA
- DH_RSA_AES256_SHA
- DHE_DSS_DES_SHA
- DHE_DSS_3DES_SHA
- DHE_DSS_AES128_SHA
- DHE_DSS_AES256_SHA
- DHE_RSA_DES_SHA
- DHE_RSA_3DES_SHA
- DHE_RSA_AES128_SHA
- DHE_RSA_AES256_SHA
- DH_ANON_RC4_MD5
- DH_ANON_DES_SHA
- DH_ANON_3DES_SHA
- DH_ANON_AES128_SHA
- DH_ANON_AES256_SHA
- RSA_RC2_MD5_EXPORT
- RSA_RC4_MD5_EXPORT
- RSA_DES_SHA_EXPORT
- DH_DSS_DES_SHA_EXPORT
- DH_RSA_DES_SHA_EXPORT
- DHE_DSS_DES_SHA_EXPORT
- DHE_RSA_DES_SHA_EXPORT
- DH_ANON_RC4_MD5_EXPORT
- DH_ANON_DES_SHA_EXPORT
- RSA_CAMELLIA128_SHA
- DH_DSS_CAMELLIA128_SHA
- DH_RSA_CAMELLIA128_SHA
- DHE_DSS_CAMELLIA128_SHA
- DHE_RSA_CAMELLIA128_SHA
- DH_ANON_CAMELLIA128_SHA
- RSA_CAMELLIA256_SHA
- DH_DSS_CAMELLIA256_SHA
- DH_RSA_CAMELLIA256_SHA
- DHE_DSS_CAMELLIA256_SHA
- DHE_RSA_CAMELLIA256_SHA
- DH_ANON_CAMELLIA256_SHA
- PSK_RC4_SHA
- PSK_3DES_SHA
- PSK_AES128_SHA
- PSK_AES256_SHA
- DHE_PSK_RC4_SHA
- DHE_PSK_3DES_SHA
- DHE_PSK_AES128_SHA
- DHE_PSK_AES256_SHA
- RSA_PSK_RC4_SHA
- RSA_PSK_3DES_SHA
- RSA_PSK_AES128_SHA
- RSA_PSK_AES256_SHA
- RSA_SEED_SHA
- DH_DSS_SEED_SHA
- DH_RSA_SEED_SHA
- DHE_DSS_SEED_SHA
- DHE_RSA_SEED_SHA
- DH_ANON_SEED_SHA
- SRP_SHA_3DES_SHA
- SRP_SHA_RSA_3DES_SHA
- SRP_SHA_DSS_3DES_SHA
- SRP_SHA_AES128_SHA
- SRP_SHA_RSA_AES128_SHA
- SRP_SHA_DSS_AES128_SHA
- SRP_SHA_AES256_SHA
- SRP_SHA_RSA_AES256_SHA
- SRP_SHA_DSS_AES256_SHA
- ECDH_ECDSA_NULL_SHA
- ECDH_ECDSA_RC4_SHA
- ECDH_ECDSA_3DES_SHA
- ECDH_ECDSA_AES128_SHA
- ECDH_ECDSA_AES256_SHA
- ECDHE_ECDSA_NULL_SHA
- ECDHE_ECDSA_RC4_SHA
- ECDHE_ECDSA_3DES_SHA
- ECDHE_ECDSA_AES128_SHA
- ECDHE_ECDSA_AES256_SHA
- ECDH_RSA_NULL_SHA
- ECDH_RSA_RC4_SHA
- ECDH_RSA_3DES_SHA
- ECDH_RSA_AES128_SHA
- ECDH_RSA_AES256_SHA
- ECDHE_RSA_NULL_SHA
- ECDHE_RSA_RC4_SHA
- ECDHE_RSA_3DES_SHA
- ECDHE_RSA_AES128_SHA
- ECDHE_RSA_AES256_SHA
- ECDH_ANON_NULL_SHA
- ECDH_ANON_RC4_SHA
- ECDH_ANON_3DES_SHA
- ECDH_ANON_AES128_SHA
- ECDH_ANON_AES256_SHA
- RSA_NULL_SHA256
- RSA_AES128_SHA256
- RSA_AES256_SHA256
- DH_DSS_AES128_SHA256
- DH_RSA_AES128_SHA256
- DHE_DSS_AES128_SHA256
- DHE_RSA_AES128_SHA256
- DH_DSS_AES256_SHA256
- DH_RSA_AES256_SHA256
- DHE_DSS_AES256_SHA256
- DHE_RSA_AES256_SHA256
- DH_ANON_AES128_SHA256
- DH_ANON_AES256_SHA256
- RSA_AES128_GCM_SHA256
- RSA_AES256_GCM_SHA384
- DHE_RSA_AES128_GCM_SHA256
- DHE_RSA_AES256_GCM_SHA384
- DH_RSA_AES128_GCM_SHA256
- DH_RSA_AES256_GCM_SHA384
- DHE_DSS_AES128_GCM_SHA256
- DHE_DSS_AES256_GCM_SHA384
- DH_DSS_AES128_GCM_SHA256
- DH_DSS_AES256_GCM_SHA384
- DH_ANON_AES128_GCM_SHA256
- DH_ANON_AES256_GCM_SHA384
- ECDHE_ECDSA_AES128_SHA256
- ECDHE_ECDSA_AES256_SHA384
- ECDH_ECDSA_AES128_SHA256
- ECDH_ECDSA_AES256_SHA384
- ECDHE_RSA_AES128_SHA256
- ECDHE_RSA_AES256_SHA384
- ECDH_RSA_AES128_SHA256
- ECDH_RSA_AES256_SHA384
- ECDHE_ECDSA_AES128_GCM_SHA256
- ECDHE_ECDSA_AES256_GCM_SHA384
- ECDH_ECDSA_AES128_GCM_SHA256
- ECDH_ECDSA_AES256_GCM_SHA384
- ECDHE_RSA_AES128_GCM_SHA256
- ECDHE_RSA_AES256_GCM_SHA384
- ECDH_RSA_AES128_GCM_SHA256
- ECDH_RSA_AES256_GCM_SHA384
- PSK_AES128_GCM_SHA256
- PSK_AES256_GCM_SHA384
- DHE_PSK_AES128_GCM_SHA256
- DHE_PSK_AES256_GCM_SHA384
- RSA_PSK_AES128_GCM_SHA256
- RSA_PSK_AES256_GCM_SHA384
- PSK_AES128_SHA256
- PSK_AES256_SHA384
- PSK_NULL_SHA256
- PSK_NULL_SHA384
- DHE_PSK_AES128_SHA256
- DHE_PSK_AES256_SHA384
- DHE_PSK_NULL_SHA256
- DHE_PSK_NULL_SHA384
- RSA_PSK_AES128_SHA256
- RSA_PSK_AES256_SHA384
- RSA_PSK_NULL_SHA256
- RSA_PSK_NULL_SHA384
- RSA_CAMELLIA128_SHA256
- DH_DSS_CAMELLIA128_SHA256
- DH_RSA_CAMELLIA128_SHA256
- DHE_DSS_CAMELLIA128_SHA256
- DHE_RSA_CAMELLIA128_SHA256
- DH_ANON_CAMELLIA128_SHA256
- RSA_CAMELLIA256_SHA256
- DH_DSS_CAMELLIA256_SHA256
- DH_RSA_CAMELLIA256_SHA256
- DHE_DSS_CAMELLIA256_SHA256
- DHE_RSA_CAMELLIA256_SHA256
- DH_ANON_CAMELLIA256_SHA256
- ECDHE_ECDSA_CAMELLIA128_SHA256
- ECDHE_ECDSA_CAMELLIA256_SHA384
- ECDH_ECDSA_CAMELLIA128_SHA256
- ECDH_ECDSA_CAMELLIA256_SHA384
- ECDHE_RSA_CAMELLIA128_SHA256
- ECDHE_RSA_CAMELLIA256_SHA384
- ECDH_RSA_CAMELLIA128_SHA256
- ECDH_RSA_CAMELLIA256_SHA384
- RSA_CAMELLIA128_GCM_SHA256
- RSA_CAMELLIA256_GCM_SHA384
- DHE_RSA_CAMELLIA128_GCM_SHA256
- DHE_RSA_CAMELLIA256_GCM_SHA384
- DH_RSA_CAMELLIA128_GCM_SHA256
- DH_RSA_CAMELLIA256_GCM_SHA384
- DHE_DSS_CAMELLIA128_GCM_SHA256
- DHE_DSS_CAMELLIA256_GCM_SHA384
- DH_DSS_CAMELLIA128_GCM_SHA256
- DH_DSS_CAMELLIA256_GCM_SHA384
- DH_anon_CAMELLIA128_GCM_SHA256
- DH_anon_CAMELLIA256_GCM_SHA384
- ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
- ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
- ECDH_ECDSA_CAMELLIA128_GCM_SHA256
- ECDH_ECDSA_CAMELLIA256_GCM_SHA384
- ECDHE_RSA_CAMELLIA128_GCM_SHA256
- ECDHE_RSA_CAMELLIA256_GCM_SHA384
- ECDH_RSA_CAMELLIA128_GCM_SHA256
- ECDH_RSA_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_GCM_SHA256
- PSK_CAMELLIA256_GCM_SHA384
- DHE_PSK_CAMELLIA128_GCM_SHA256
- DHE_PSK_CAMELLIA256_GCM_SHA384
- RSA_PSK_CAMELLIA128_GCM_SHA256
- RSA_PSK_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_SHA256
- PSK_CAMELLIA256_SHA384
- DHE_PSK_CAMELLIA128_SHA256
- DHE_PSK_CAMELLIA256_SHA384
- RSA_PSK_CAMELLIA128_SHA256
- RSA_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_CAMELLIA128_SHA256
- ECDHE_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_RC4_SHA
- ECDHE_PSK_3DES_SHA
- ECDHE_PSK_AES128_SHA
- ECDHE_PSK_AES256_SHA
- ECDHE_PSK_AES128_SHA256
- ECDHE_PSK_AES256_SHA384
- ECDHE_PSK_NULL_SHA
- ECDHE_PSK_NULL_SHA256
- ECDHE_PSK_NULL_SHA384
- ECDHE_RSA_CHACHA20_POLY1305_SHA256
- ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
- DHE_RSA_CHACHA20_POLY1305_SHA256
- PSK_CHACHA20_POLY1305_SHA256
- ECDHE_PSK_CHACHA20_POLY1305_SHA256
- DHE_PSK_CHACHA20_POLY1305_SHA256
- RSA_PSK_CHACHA20_POLY1305_SHA256
- AES128_GCM_SHA256
- AES256_GCM_SHA384
- CHACHA20_POLY1305_SHA256
- AES128_CCM_SHA256
- AES128_CCM8_SHA256
ECCurves
string
Default Value: ""
Defines the elliptic curves to enable.
Extensions
string
Default Value: ""
Provides access to TLS extensions.
ForceResumeIfDestinationChanges
bool
Default Value: False
Whether to force TLS session resumption when the destination address changes.
PreSharedIdentity
string
Default Value: ""
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
PreSharedKey
string
Default Value: ""
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
PreSharedKeyCiphersuite
string
Default Value: ""
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
RenegotiationAttackPreventionMode
RenegotiationAttackPreventionModes
Default Value: 0
Selects the renegotiation attack prevention mechanism.
The following options are available:
crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |
RevocationCheck
RevocationCheckKinds
Default Value: 1
Specifies the kind(s) of revocation check to perform.
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
crcNone | 0 | No revocation checking. |
crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.
There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).
This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.
Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.
SSLOptions
int
Default Value: 16
Various SSL (TLS) protocol options, set of
cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection |
cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions |
cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. |
cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known |
cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. |
cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually |
TLSMode
SSLModes
Default Value: 0
Specifies the TLS mode to use.
smDefault | 0 | |
smNoTLS | 1 | Do not use TLS |
smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. |
UseExtendedMasterSecret
bool
Default Value: False
Enables the Extended Master Secret Extension, as defined in RFC 7627.
UseSessionResumption
bool
Default Value: False
Enables or disables the TLS session resumption capability.
Versions
int
Default Value: 16
The SSL/TLS versions to enable by default.
csbSSL2 | 0x01 | SSL 2 |
csbSSL3 | 0x02 | SSL 3 |
csbTLS1 | 0x04 | TLS 1.0 |
csbTLS11 | 0x08 | TLS 1.1 |
csbTLS12 | 0x10 | TLS 1.2 |
csbTLS13 | 0x20 | TLS 1.3 |
Constructors
public TLSSettings();
Public TLSSettings()
Creates a new TLSSettings object.
Config Settings (SAMLReader Component)
The component 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 component, access to these internal properties is provided through the Config method.SAMLReader Config Settings
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 the TrustedCertificates property) are considered trusted.
- CA, revocation source, TLS key usage requirements are not mandated
- Violation of OCSP issuer requirements are ignored
- The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates)
- Basic constraints and name constraints of CA certificates are ignored
- Some weaker algorithms are tolerated
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
time | Current time | |
level | Level | |
package | Package name | |
module | Module name | |
class | Class name | |
method | Method name | |
threadid | Thread Id | |
contenttype | Content type | |
content | Content | |
all | All details |
Supported filter names are:
exclude-package | Exclude a package specified in the value | |
exclude-module | Exclude a module specified in the value | |
exclude-class | Exclude a class specified in the value | |
exclude-method | Exclude a method specified in the value | |
include-package | Include a package specified in the value | |
include-module | Include a module specified in the value | |
include-class | Include a class specified in the value | |
include-method | Include a method specified in the value |
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
none | None (by default) | |
fatal | Severe errors that cause premature termination. | |
error | Other runtime errors or unexpected conditions. | |
warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
info | Interesting runtime events (startup/shutdown). | |
debug | Detailed information on flow of through the system. | |
trace | More detailed information. |
The default value of this setting is 100.
none | No rotation | |
deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.