MessageVerifier Module
Properties Methods Events Config Settings Errors
The MessageVerifier module verifies digital signatures of data stored in the PKCS#7 format.
Syntax
SecureBlackbox.Messageverifier
Remarks
PKCS#7 (Public Key Cryptography Standard #7) is a common format used to store encrypted and signed data. It is used by a variety of protocols, including S/MIME and CMS.
Property List
The following is the full list of the properties of the module with short descriptions. Click on the links for further details.
Certificates | A collection of certificates included in the electronic signature. |
ClaimedSigningTime | Returns a signature's claimed signing time. |
ContentType | A content type property of the signed message. |
DataBytes | Use this property to pass the original signed data to module in the byte array form. |
DataFile | The name of the file containing the original signed data. |
FIPSMode | Reserved. |
HashAlgorithm | Hash algorithm which was used to calculate the signature. |
InputBytes | Use this property to pass the input to module in the byte array form. |
InputFile | Path to the file containing the signed message. |
InputIsHash | Specifies whether the input source contains the hash of the data or the actual data. |
KnownCertificates | Additional certificates for chain validation. |
MACAlgorithm | Specifies the hash algorithm to be used. |
OutputBytes | Use this property to read the output the module object has produced. |
OutputFile | Path to the file to save the extracted data to. |
SignatureType | The type of the processed signature. |
SignatureValidationResult | The signature validation result. |
SignedAttributes | Custom signature attributes that are covered by the electronic signature. |
SigningCertificate | The certificate that was used to create the signature. |
Timestamp | Contains the timestamp which is being validated. |
Timestamped | Indicates whether or not the signature is timestamped. |
TSACertificate | The certificate of the Time Stamping Authority. |
UnsignedAttributes | Custom unsigned attributes included in the electronic signature. |
ValidatedSigningTime | Contains the certified signing time. |
Method List
The following is the full list of the methods of the module with short descriptions. Click on the links for further details.
CheckSignatureType | Determines the signature kind. |
Config | Sets or retrieves a configuration setting. |
DoAction | Performs an additional action. |
Verify | Verifies digitally signed data. |
VerifyDetached | Verifies a detached signature. |
Event List
The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.
Error | Information about errors during PKCS#7 message verification. |
Notification | This event notifies the application about an underlying control flow event. |
RecipientFound | Fires to report a message addressee parameters. |
SignatureFound | Signifies the start of signature validation. |
SignatureValidated | Marks the completion of the signature validation routine. |
TimestampFound | Signifies the start of a timestamp validation routine. |
TimestampValidated | Reports the completion of the timestamp validation routine. |
Config Settings
The following is a list of config settings for the module with short descriptions. Click on the links for further details.
TempPath | Path for storing temporary files. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the module (supported for HTTPClient, RESTClient and SOAPClient only). |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
Tag | Allows to store any custom data. |
UseOwnDNSResolver | Specifies whether the client modules should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
Certificates Property (MessageVerifier Module)
A collection of certificates included in the electronic signature.
Syntax
public var certificates: Array<Certificate> { get {...} }
@property (nonatomic,readonly,assign,getter=certCount) int certCount; - (int)certCount; - (NSData*)certBytes:(int)certIndex; - (BOOL)certCA:(int)certIndex; - (NSData*)certCAKeyID:(int)certIndex; - (NSString*)certCRLDistributionPoints:(int)certIndex; - (NSString*)certCurve:(int)certIndex; - (NSData*)certFingerprint:(int)certIndex; - (NSString*)certFriendlyName:(int)certIndex; - (long long)certHandle:(int)certIndex; - (NSString*)certHashAlgorithm:(int)certIndex; - (NSString*)certIssuer:(int)certIndex; - (NSString*)certIssuerRDN:(int)certIndex; - (NSString*)certKeyAlgorithm:(int)certIndex; - (int)certKeyBits:(int)certIndex; - (NSData*)certKeyFingerprint:(int)certIndex; - (int)certKeyUsage:(int)certIndex; - (BOOL)certKeyValid:(int)certIndex; - (NSString*)certOCSPLocations:(int)certIndex; - (NSString*)certPolicyIDs:(int)certIndex; - (NSData*)certPublicKeyBytes:(int)certIndex; - (BOOL)certSelfSigned:(int)certIndex; - (NSData*)certSerialNumber:(int)certIndex; - (NSString*)certSigAlgorithm:(int)certIndex; - (NSString*)certSubject:(int)certIndex; - (NSData*)certSubjectKeyID:(int)certIndex; - (NSString*)certSubjectRDN:(int)certIndex; - (NSString*)certValidFrom:(int)certIndex; - (NSString*)certValidTo:(int)certIndex;
Default Value
""
Remarks
Use this property to obtain the signing time as certified by an external timestamp. The time is in UTC.
This property is read-only.
ClaimedSigningTime Property (MessageVerifier Module)
Returns a signature's claimed signing time.
Syntax
public var claimedSigningTime: String { get {...} }
@property (nonatomic,readonly,assign,getter=claimedSigningTime) NSString* claimedSigningTime; - (NSString*)claimedSigningTime;
Default Value
""
Remarks
Use this property to get the signature creation time from the signer's computer. Note that the claimed time is not covered by the signature and may be forfeited or wrong. Use ValidatedSigningTime to obtain the signing time figure verified by a trusted timestamping authority. The time is in UTC.
This property is read-only.
ContentType Property (MessageVerifier Module)
A content type property of the signed message.
Syntax
public var contentType: String { get {...} }
@property (nonatomic,readonly,assign,getter=contentType) NSString* contentType; - (NSString*)contentType;
Default Value
""
Remarks
Use this property to check the content type property of the processed signed message.
This property is read-only.
DataBytes Property (MessageVerifier Module)
Use this property to pass the original signed data to module in the byte array form.
Syntax
public var dataBytes: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=dataBytes,setter=setDataBytes:) NSData* dataBytes; - (NSData*)dataBytes; - (void)setDataBytes :(NSData*)newDataBytes;
Remarks
When validating detached signatures, assign a byte array containing the signed data to this property.
DataFile Property (MessageVerifier Module)
The name of the file containing the original signed data.
Syntax
public var dataFile: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=dataFile,setter=setDataFile:) NSString* dataFile; - (NSString*)dataFile; - (void)setDataFile :(NSString*)newDataFile;
Default Value
""
Remarks
Use this property to provide the original data when validating detached signatures with VerifyDetached.
FIPSMode Property (MessageVerifier Module)
Reserved.
Syntax
public var fipsMode: Bool { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=FIPSMode,setter=setFIPSMode:) BOOL FIPSMode; - (BOOL)FIPSMode; - (void)setFIPSMode :(BOOL)newFIPSMode;
Default Value
False
Remarks
This property is reserved for future use.
HashAlgorithm Property (MessageVerifier Module)
Hash algorithm which was used to calculate the signature.
Syntax
public var hashAlgorithm: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=hashAlgorithm,setter=setHashAlgorithm:) NSString* hashAlgorithm; - (NSString*)hashAlgorithm; - (void)setHashAlgorithm :(NSString*)newHashAlgorithm;
Default Value
""
Remarks
Check this property after calling Verify or VerifyDetached to get the hash algorithm that was used to calculate the signature message digest.
InputBytes Property (MessageVerifier Module)
Use this property to pass the input to module in the byte array form.
Syntax
public var inputBytes: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=inputBytes,setter=setInputBytes:) NSData* inputBytes; - (NSData*)inputBytes; - (void)setInputBytes :(NSData*)newInputBytes;
Remarks
Assign a byte array containing the data to be processed to this property.
InputFile Property (MessageVerifier Module)
Path to the file containing the signed message.
Syntax
public var inputFile: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=inputFile,setter=setInputFile:) NSString* inputFile; - (NSString*)inputFile; - (void)setInputFile :(NSString*)newInputFile;
Default Value
""
Remarks
Use this property to provide a file containing the signed data, either enveloping or detached.
InputIsHash Property (MessageVerifier Module)
Specifies whether the input source contains the hash of the data or the actual data.
Syntax
public var inputIsHash: Bool { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=inputIsHash,setter=setInputIsHash:) BOOL inputIsHash; - (BOOL)inputIsHash; - (void)setInputIsHash :(BOOL)newInputIsHash;
Default Value
False
Remarks
Use this property to tell the component whether the input source contains the actual data or its hash.
KnownCertificates Property (MessageVerifier Module)
Additional certificates for chain validation.
Syntax
public var knownCertificates: Array<Certificate> { get {...} }
@property (nonatomic,readwrite,assign,getter=knownCertCount,setter=setKnownCertCount:) int knownCertCount; - (int)knownCertCount; - (void)setKnownCertCount :(int)newKnownCertCount; - (NSData*)knownCertBytes:(int)knownCertIndex; - (long long)knownCertHandle:(int)knownCertIndex; - (void)setKnownCertHandle:(int)knownCertIndex :(long long)newKnownCertHandle;
Default Value
""
Remarks
Use this property to obtain the signing time as certified by an external timestamp. The time is in UTC.
This property is read-only.
MACAlgorithm Property (MessageVerifier Module)
Specifies the hash algorithm to be used.
Syntax
public var macAlgorithm: String { get {...} }
@property (nonatomic,readonly,assign,getter=MACAlgorithm) NSString* MACAlgorithm; - (NSString*)MACAlgorithm;
Default Value
"SHA256"
Remarks
This property specifies the MAC algorithm that was used to calculate an authenticated signature.
SB_MAC_ALGORITHM_HMAC_SHA1 | SHA1 | |
SB_MAC_ALGORITHM_HMAC_SHA256 | SHA256 | |
SB_MAC_ALGORITHM_HMAC_SHA512 | SHA512 |
This property is read-only.
OutputBytes Property (MessageVerifier Module)
Use this property to read the output the module object has produced.
Syntax
public var outputBytes: Data { get {...} }
@property (nonatomic,readonly,assign,getter=outputBytes) NSData* outputBytes; - (NSData*)outputBytes;
Remarks
Read the contents of this property after the operation is completed to read the produced output. This property will only be set if OutputFile and OutputStream properties had not been assigned.
This property is read-only.
OutputFile Property (MessageVerifier Module)
Path to the file to save the extracted data to.
Syntax
public var outputFile: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=outputFile,setter=setOutputFile:) NSString* outputFile; - (NSString*)outputFile; - (void)setOutputFile :(NSString*)newOutputFile;
Default Value
""
Remarks
Use this property when validating enveloping signatures to specify the output file where the extracted message should be saved.
SignatureType Property (MessageVerifier Module)
The type of the processed signature.
Syntax
public var signatureType: MessageverifierSignatureTypes { get {...} }
public enum MessageverifierSignatureTypes: Int32 { case stUnknown = 0 case stPKCS1Detached = 1 case stPKCS7Detached = 2 case stPKCS7Enveloping = 3 case stPKCS7MACDetached = 4 case stPKCS7MACEnveloping = 5 }
@property (nonatomic,readonly,assign,getter=signatureType) int signatureType; - (int)signatureType;
Default Value
0
Remarks
Use this property to check the result of the most recent signature validation.
stUnknown | 0 | Unknown or unsupported signature types |
stPKCS1Detached | 1 | Detached PKCS#1 signature |
stPKCS7Detached | 2 | Detached PKCS#7 signature |
stPKCS7Enveloping | 3 | Enveloping PKCS#7 signature |
stPKCS7MACDetached | 4 | Detached PKCS#7 MAC signature |
stPKCS7MACEnveloping | 5 | Enveloping PKCS#7 MAC signature |
This property is read-only.
SignatureValidationResult Property (MessageVerifier Module)
The signature validation result.
Syntax
public var signatureValidationResult: MessageverifierSignatureValidationResults { get {...} }
public enum MessageverifierSignatureValidationResults: Int32 { case svtValid = 0 case svtUnknown = 1 case svtCorrupted = 2 case svtSignerNotFound = 3 case svtFailure = 4 }
@property (nonatomic,readonly,assign,getter=signatureValidationResult) int signatureValidationResult; - (int)signatureValidationResult;
Default Value
0
Remarks
Use this property to check the result of the most recent signature validation.
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 |
This property is read-only.
SignedAttributes Property (MessageVerifier Module)
Custom signature attributes that are covered by the electronic signature.
Syntax
public var signedAttributes: Array<SignatureAttribute> { get {...} }
@property (nonatomic,readonly,assign,getter=signedAttributeCount) int signedAttributeCount; - (int)signedAttributeCount; - (NSString*)signedAttributeOID:(int)signedAttributeIndex; - (NSData*)signedAttributeValue:(int)signedAttributeIndex;
Default Value
""
Remarks
Use this property to obtain the signing time as certified by an external timestamp. The time is in UTC.
This property is read-only.
SigningCertificate Property (MessageVerifier Module)
The certificate that was used to create the signature.
Syntax
public var signingCertificate: Certificate { get {...} }
@property (nonatomic,readonly,assign,getter=signingCertBytes) NSData* signingCertBytes; - (NSData*)signingCertBytes; @property (nonatomic,readonly,assign,getter=signingCertCA) BOOL signingCertCA; - (BOOL)signingCertCA; @property (nonatomic,readonly,assign,getter=signingCertCAKeyID) NSData* signingCertCAKeyID; - (NSData*)signingCertCAKeyID; @property (nonatomic,readonly,assign,getter=signingCertCRLDistributionPoints) NSString* signingCertCRLDistributionPoints; - (NSString*)signingCertCRLDistributionPoints; @property (nonatomic,readonly,assign,getter=signingCertCurve) NSString* signingCertCurve; - (NSString*)signingCertCurve; @property (nonatomic,readonly,assign,getter=signingCertFingerprint) NSData* signingCertFingerprint; - (NSData*)signingCertFingerprint; @property (nonatomic,readonly,assign,getter=signingCertFriendlyName) NSString* signingCertFriendlyName; - (NSString*)signingCertFriendlyName; @property (nonatomic,readonly,assign,getter=signingCertHandle) long long signingCertHandle; - (long long)signingCertHandle; @property (nonatomic,readonly,assign,getter=signingCertHashAlgorithm) NSString* signingCertHashAlgorithm; - (NSString*)signingCertHashAlgorithm; @property (nonatomic,readonly,assign,getter=signingCertIssuer) NSString* signingCertIssuer; - (NSString*)signingCertIssuer; @property (nonatomic,readonly,assign,getter=signingCertIssuerRDN) NSString* signingCertIssuerRDN; - (NSString*)signingCertIssuerRDN; @property (nonatomic,readonly,assign,getter=signingCertKeyAlgorithm) NSString* signingCertKeyAlgorithm; - (NSString*)signingCertKeyAlgorithm; @property (nonatomic,readonly,assign,getter=signingCertKeyBits) int signingCertKeyBits; - (int)signingCertKeyBits; @property (nonatomic,readonly,assign,getter=signingCertKeyFingerprint) NSData* signingCertKeyFingerprint; - (NSData*)signingCertKeyFingerprint; @property (nonatomic,readonly,assign,getter=signingCertKeyUsage) int signingCertKeyUsage; - (int)signingCertKeyUsage; @property (nonatomic,readonly,assign,getter=signingCertKeyValid) BOOL signingCertKeyValid; - (BOOL)signingCertKeyValid; @property (nonatomic,readonly,assign,getter=signingCertOCSPLocations) NSString* signingCertOCSPLocations; - (NSString*)signingCertOCSPLocations; @property (nonatomic,readonly,assign,getter=signingCertOCSPNoCheck) BOOL signingCertOCSPNoCheck; - (BOOL)signingCertOCSPNoCheck; @property (nonatomic,readonly,assign,getter=signingCertOrigin) int signingCertOrigin; - (int)signingCertOrigin; @property (nonatomic,readonly,assign,getter=signingCertPolicyIDs) NSString* signingCertPolicyIDs; - (NSString*)signingCertPolicyIDs; @property (nonatomic,readonly,assign,getter=signingCertPrivateKeyBytes) NSData* signingCertPrivateKeyBytes; - (NSData*)signingCertPrivateKeyBytes; @property (nonatomic,readonly,assign,getter=signingCertPrivateKeyExists) BOOL signingCertPrivateKeyExists; - (BOOL)signingCertPrivateKeyExists; @property (nonatomic,readonly,assign,getter=signingCertPrivateKeyExtractable) BOOL signingCertPrivateKeyExtractable; - (BOOL)signingCertPrivateKeyExtractable; @property (nonatomic,readonly,assign,getter=signingCertPublicKeyBytes) NSData* signingCertPublicKeyBytes; - (NSData*)signingCertPublicKeyBytes; @property (nonatomic,readonly,assign,getter=signingCertQualifiedStatements) int signingCertQualifiedStatements; - (int)signingCertQualifiedStatements; @property (nonatomic,readonly,assign,getter=signingCertSelfSigned) BOOL signingCertSelfSigned; - (BOOL)signingCertSelfSigned; @property (nonatomic,readonly,assign,getter=signingCertSerialNumber) NSData* signingCertSerialNumber; - (NSData*)signingCertSerialNumber; @property (nonatomic,readonly,assign,getter=signingCertSigAlgorithm) NSString* signingCertSigAlgorithm; - (NSString*)signingCertSigAlgorithm; @property (nonatomic,readonly,assign,getter=signingCertSubject) NSString* signingCertSubject; - (NSString*)signingCertSubject; @property (nonatomic,readonly,assign,getter=signingCertSubjectAlternativeName) NSString* signingCertSubjectAlternativeName; - (NSString*)signingCertSubjectAlternativeName; @property (nonatomic,readonly,assign,getter=signingCertSubjectKeyID) NSData* signingCertSubjectKeyID; - (NSData*)signingCertSubjectKeyID; @property (nonatomic,readonly,assign,getter=signingCertSubjectRDN) NSString* signingCertSubjectRDN; - (NSString*)signingCertSubjectRDN; @property (nonatomic,readonly,assign,getter=signingCertValidFrom) NSString* signingCertValidFrom; - (NSString*)signingCertValidFrom; @property (nonatomic,readonly,assign,getter=signingCertValidTo) NSString* signingCertValidTo; - (NSString*)signingCertValidTo;
Default Value
""
Remarks
Use this property to obtain the signing time as certified by an external timestamp. The time is in UTC.
This property is read-only.
Timestamp Property (MessageVerifier Module)
Contains the timestamp which is being validated.
Syntax
public var timestamp: TimestampInfo { get {...} }
@property (nonatomic,readonly,assign,getter=timestampAccuracy) long long timestampAccuracy; - (long long)timestampAccuracy; @property (nonatomic,readonly,assign,getter=timestampBytes) NSData* timestampBytes; - (NSData*)timestampBytes; @property (nonatomic,readonly,assign,getter=timestampCertificateIndex) int timestampCertificateIndex; - (int)timestampCertificateIndex; @property (nonatomic,readonly,assign,getter=timestampChainValidationDetails) int timestampChainValidationDetails; - (int)timestampChainValidationDetails; @property (nonatomic,readonly,assign,getter=timestampChainValidationResult) int timestampChainValidationResult; - (int)timestampChainValidationResult; @property (nonatomic,readonly,assign,getter=timestampHashAlgorithm) NSString* timestampHashAlgorithm; - (NSString*)timestampHashAlgorithm; @property (nonatomic,readonly,assign,getter=timestampSerialNumber) NSData* timestampSerialNumber; - (NSData*)timestampSerialNumber; @property (nonatomic,readonly,assign,getter=timestampSignatureIndex) int timestampSignatureIndex; - (int)timestampSignatureIndex; @property (nonatomic,readonly,assign,getter=timestampTime) NSString* timestampTime; - (NSString*)timestampTime; @property (nonatomic,readonly,assign,getter=timestampTimestampType) int timestampTimestampType; - (int)timestampTimestampType; @property (nonatomic,readonly,assign,getter=timestampTSAName) NSString* timestampTSAName; - (NSString*)timestampTSAName; @property (nonatomic,readonly,assign,getter=timestampValidationLog) NSString* timestampValidationLog; - (NSString*)timestampValidationLog; @property (nonatomic,readonly,assign,getter=timestampValidationResult) int timestampValidationResult; - (int)timestampValidationResult;
Default Value
""
Remarks
Use this property to obtain the signing time as certified by an external timestamp. The time is in UTC.
This property is read-only.
Timestamped Property (MessageVerifier Module)
Indicates whether or not the signature is timestamped.
Syntax
public var timestamped: Bool { get {...} }
@property (nonatomic,readonly,assign,getter=timestamped) BOOL timestamped; - (BOOL)timestamped;
Default Value
False
Remarks
This property returns True if the signature is timestamped, and False otherwise.
This property is read-only.
TSACertificate Property (MessageVerifier Module)
The certificate of the Time Stamping Authority.
Syntax
public var tsaCertificate: Certificate { get {...} }
@property (nonatomic,readonly,assign,getter=TSACertBytes) NSData* TSACertBytes; - (NSData*)TSACertBytes; @property (nonatomic,readonly,assign,getter=TSACertCA) BOOL TSACertCA; - (BOOL)TSACertCA; @property (nonatomic,readonly,assign,getter=TSACertCAKeyID) NSData* TSACertCAKeyID; - (NSData*)TSACertCAKeyID; @property (nonatomic,readonly,assign,getter=TSACertCRLDistributionPoints) NSString* TSACertCRLDistributionPoints; - (NSString*)TSACertCRLDistributionPoints; @property (nonatomic,readonly,assign,getter=TSACertCurve) NSString* TSACertCurve; - (NSString*)TSACertCurve; @property (nonatomic,readonly,assign,getter=TSACertFingerprint) NSData* TSACertFingerprint; - (NSData*)TSACertFingerprint; @property (nonatomic,readonly,assign,getter=TSACertFriendlyName) NSString* TSACertFriendlyName; - (NSString*)TSACertFriendlyName; @property (nonatomic,readonly,assign,getter=TSACertHandle) long long TSACertHandle; - (long long)TSACertHandle; @property (nonatomic,readonly,assign,getter=TSACertHashAlgorithm) NSString* TSACertHashAlgorithm; - (NSString*)TSACertHashAlgorithm; @property (nonatomic,readonly,assign,getter=TSACertIssuer) NSString* TSACertIssuer; - (NSString*)TSACertIssuer; @property (nonatomic,readonly,assign,getter=TSACertIssuerRDN) NSString* TSACertIssuerRDN; - (NSString*)TSACertIssuerRDN; @property (nonatomic,readonly,assign,getter=TSACertKeyAlgorithm) NSString* TSACertKeyAlgorithm; - (NSString*)TSACertKeyAlgorithm; @property (nonatomic,readonly,assign,getter=TSACertKeyBits) int TSACertKeyBits; - (int)TSACertKeyBits; @property (nonatomic,readonly,assign,getter=TSACertKeyFingerprint) NSData* TSACertKeyFingerprint; - (NSData*)TSACertKeyFingerprint; @property (nonatomic,readonly,assign,getter=TSACertKeyUsage) int TSACertKeyUsage; - (int)TSACertKeyUsage; @property (nonatomic,readonly,assign,getter=TSACertKeyValid) BOOL TSACertKeyValid; - (BOOL)TSACertKeyValid; @property (nonatomic,readonly,assign,getter=TSACertOCSPLocations) NSString* TSACertOCSPLocations; - (NSString*)TSACertOCSPLocations; @property (nonatomic,readonly,assign,getter=TSACertPolicyIDs) NSString* TSACertPolicyIDs; - (NSString*)TSACertPolicyIDs; @property (nonatomic,readonly,assign,getter=TSACertPublicKeyBytes) NSData* TSACertPublicKeyBytes; - (NSData*)TSACertPublicKeyBytes; @property (nonatomic,readonly,assign,getter=TSACertSelfSigned) BOOL TSACertSelfSigned; - (BOOL)TSACertSelfSigned; @property (nonatomic,readonly,assign,getter=TSACertSerialNumber) NSData* TSACertSerialNumber; - (NSData*)TSACertSerialNumber; @property (nonatomic,readonly,assign,getter=TSACertSigAlgorithm) NSString* TSACertSigAlgorithm; - (NSString*)TSACertSigAlgorithm; @property (nonatomic,readonly,assign,getter=TSACertSubject) NSString* TSACertSubject; - (NSString*)TSACertSubject; @property (nonatomic,readonly,assign,getter=TSACertSubjectKeyID) NSData* TSACertSubjectKeyID; - (NSData*)TSACertSubjectKeyID; @property (nonatomic,readonly,assign,getter=TSACertSubjectRDN) NSString* TSACertSubjectRDN; - (NSString*)TSACertSubjectRDN; @property (nonatomic,readonly,assign,getter=TSACertValidFrom) NSString* TSACertValidFrom; - (NSString*)TSACertValidFrom; @property (nonatomic,readonly,assign,getter=TSACertValidTo) NSString* TSACertValidTo; - (NSString*)TSACertValidTo;
Default Value
""
Remarks
Use this property to obtain the signing time as certified by an external timestamp. The time is in UTC.
This property is read-only.
UnsignedAttributes Property (MessageVerifier Module)
Custom unsigned attributes included in the electronic signature.
Syntax
public var unsignedAttributes: Array<SignatureAttribute> { get {...} }
@property (nonatomic,readonly,assign,getter=unsignedAttributeCount) int unsignedAttributeCount; - (int)unsignedAttributeCount; - (NSString*)unsignedAttributeOID:(int)unsignedAttributeIndex; - (NSData*)unsignedAttributeValue:(int)unsignedAttributeIndex;
Default Value
""
Remarks
Use this property to obtain the signing time as certified by an external timestamp. The time is in UTC.
This property is read-only.
ValidatedSigningTime Property (MessageVerifier Module)
Contains the certified signing time.
Syntax
public var validatedSigningTime: String { get {...} }
@property (nonatomic,readonly,assign,getter=validatedSigningTime) NSString* validatedSigningTime; - (NSString*)validatedSigningTime;
Default Value
""
Remarks
Use this property to obtain the signing time as certified by an external timestamp. The time is in UTC.
This property is read-only.
CheckSignatureType Method (MessageVerifier Module)
Determines the signature kind.
Syntax
public func checkSignatureType() throws -> Int32
- (int)checkSignatureType;
Remarks
Use this method to determine the kind of the signature stored in InputFile (InputStream).
stUnknown | 0 | Unknown or unsupported signature types |
stPKCS1Detached | 1 | Detached PKCS#1 signature |
stPKCS7Detached | 2 | Detached PKCS#7 signature |
stPKCS7Enveloping | 3 | Enveloping PKCS#7 signature |
stPKCS7MACDetached | 4 | Detached PKCS#7 MAC signature |
stPKCS7MACEnveloping | 5 | Enveloping PKCS#7 MAC signature |
Config Method (MessageVerifier Module)
Sets or retrieves a configuration setting.
Syntax
- (NSString*)config:(NSString*)configurationString;
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
DoAction Method (MessageVerifier Module)
Performs an additional action.
Syntax
- (NSString*)doAction:(NSString*)actionID :(NSString*)actionParams;
Remarks
DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Verify Method (MessageVerifier Module)
Verifies digitally signed data.
Syntax
public func verify() throws -> Void
- (void)verify;
Remarks
PKCS#7 and its successor, CMS, support two types of signatures: (1) enveloping signatures, where the signed data and its signature are combined in the same message, and (2) detached signatures, where the signature is stored as a separate entity. This method verifies enveloped signatures and extracts data contained in them. Use VerifyDetached to verify detached signatures.
This method expects the enveloping signature to be provided via InputFile or InputStream properties.
Note that this method only checks the integrity of the signature, i.e., that it is signed with the claimed certificate and has not been altered. It does not validate the signing certificate chain. To validate the certificate chain, either use CertificateValidator component together with MessageVerifier, or consider using CAdESVerifier component instead.
VerifyDetached Method (MessageVerifier Module)
Verifies a detached signature.
Syntax
public func verifyDetached() throws -> Void
- (void)verifyDetached;
Remarks
Use this method to verify detached signatures. Pass the signature via InputFile (or InputStream) property, and the original data via DataFile (DataStream).
Error Event (MessageVerifier Module)
Information about errors during PKCS#7 message verification.
Syntax
- (void)onError:(int)errorCode :(NSString*)description;
Remarks
The event is fired in case of exceptional conditions during message processing.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Messages section.
Notification Event (MessageVerifier Module)
This event notifies the application about an underlying control flow event.
Syntax
- (void)onNotification:(NSString*)eventID :(NSString*)eventParam;
Remarks
The class fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
RecipientFound Event (MessageVerifier Module)
Fires to report a message addressee parameters.
Syntax
- (void)onRecipientFound:(NSString*)issuerRDN :(NSData*)serialNumber :(NSData*)subjectKeyID :(BOOL)certFound;
Remarks
This event is fired for each addressee the message is encrypted for. It may fire several times in a row if the message is encrypted for more than one recipient.
The IssuerRDN, SerialNumber, and SubjectKeyID parameters to identify the recipient's certificate. CertFound indicates if the specified certificate has been located in Certificates collection. If it wasn't, you might want to look up the certificate manually, and add it to the collection inside the event handler.
SignatureFound Event (MessageVerifier Module)
Signifies the start of signature validation.
Syntax
func onSignatureFound(issuerRDN: String, serialNumber: Data, subjectKeyID: Data, certFound: Bool, validateSignature: inout Bool, validateChain: inout Bool)
- (void)onSignatureFound:(NSString*)issuerRDN :(NSData*)serialNumber :(NSData*)subjectKeyID :(BOOL)certFound :(int*)validateSignature :(int*)validateChain;
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 is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via KnownCertificates property.
Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with SignatureValidationResult and ChainValidationResult properties respectively.
Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.
SignatureValidated Event (MessageVerifier Module)
Marks the completion of the signature validation routine.
Syntax
func onSignatureValidated(issuerRDN: String, serialNumber: Data, subjectKeyID: Data, validationResult: Int32)
- (void)onSignatureValidated:(NSString*)issuerRDN :(NSData*)serialNumber :(NSData*)subjectKeyID :(int)validationResult;
Remarks
This event is fired upon the completion of the signature validation routine, and reports the respective validation result.
Use the IssuerRDN, SerialNumber, and/or SubjectKeyID parameters to identify the signing certificate.
ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a validation failure.
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 |
TimestampFound Event (MessageVerifier Module)
Signifies the start of a timestamp validation routine.
Syntax
func onTimestampFound(issuerRDN: String, serialNumber: Data, subjectKeyID: Data, certFound: Bool, validateTimestamp: inout Bool, validateChain: inout Bool)
- (void)onTimestampFound:(NSString*)issuerRDN :(NSData*)serialNumber :(NSData*)subjectKeyID :(BOOL)certFound :(int*)validateTimestamp :(int*)validateChain;
Remarks
This event fires for every timestamp identified during signature processing, and reports the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters.
The CertFound is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via KnownCertificates property.
Just like with signature validation, timestamp validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with SignatureValidationResult and ChainValidationResult properties respectively.
Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.
TimestampValidated Event (MessageVerifier Module)
Reports the completion of the timestamp validation routine.
Syntax
func onTimestampValidated(issuerRDN: String, serialNumber: Data, subjectKeyID: Data, time: String, validationResult: Int32, chainValidationResult: Int32, chainValidationDetails: Int32)
- (void)onTimestampValidated:(NSString*)issuerRDN :(NSData*)serialNumber :(NSData*)subjectKeyID :(NSString*)time :(int)validationResult :(int)chainValidationResult :(int)chainValidationDetails;
Remarks
This event is fired upon the completion of the timestamp validation routine, and reports the respective validation result.
ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a failure.
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 |
Certificate Type
Provides details of an individual X.509 certificate.
Remarks
This type provides access to X.509 certificate details.
Fields
bytes Data |
Returns raw certificate data in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ca Bool |
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
caKeyID Data |
A unique identifier (fingerprint) of the CA certificate's private key. Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
crlDistributionPoints String |
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
curve String |
Specifies the elliptic curve of the EC public key.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fingerprint Data |
Contains the fingerprint (a hash imprint) of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
friendlyName String |
Contains an associated alias (friendly name) of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
handle Int64 |
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hashAlgorithm String |
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
issuer String |
The common name of the certificate issuer (CA), typically a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
issuerRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keyAlgorithm String |
Specifies the public key algorithm of this certificate.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keyBits Int32 |
Returns the length of the public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keyFingerprint Data |
Returns a fingerprint of the public key contained in the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keyUsage Int32 |
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. This value is a bit mask of the following values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keyValid Bool |
Returns True if the certificate's key is cryptographically valid, and False otherwise. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ocspLocations String |
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ocspNoCheck Bool |
Accessor to the value of the certificates ocsp-no-check extension. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
origin Int32 |
Returns the origin of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
policyIDs String |
Contains identifiers (OIDs) of the applicable certificate policies. The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
privateKeyBytes Data |
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
privateKeyExists Bool |
Indicates whether the certificate has an associated private key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
privateKeyExtractable Bool |
Indicates whether the private key is extractable |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
publicKeyBytes Data |
Contains the certificate's public key in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
qualifiedStatements QualifiedStatementsTypes |
Returns the qualified status of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
selfSigned Bool |
Indicates whether the certificate is self-signed (root) or signed by an external CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
serialNumber Data |
Returns the certificate's serial number. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sigAlgorithm String |
Indicates the algorithm that was used by the CA to sign this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subject String |
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subjectAlternativeName String |
Returns or sets the value of the Subject Alternative Name extension of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subjectKeyID Data |
Contains a unique identifier (fingerprint) of the certificate's private key. Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subjectRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
validFrom String |
The time point at which the certificate becomes valid, in UTC. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
validTo String |
The time point at which the certificate expires, in UTC. |
Constructors
public init(stream: )
Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.
public init()
Creates a new object with default field values.
SignatureAttribute Type
Represents an attribute of a digital PKCS#7/CMS signature.
Remarks
Attributes store auxiliary information about the signed message, the signature, or the owner. Each attribute is a = pair.
Common attributes are signing time, a content type, a policy identifier, and a signature timestamp.
Fields
oid String |
The object identifier of the attribute. |
value Data |
The value of the attribute. |
Constructors
public init()
Creates a new, empty, signature attribute.
TimestampInfo Type
A container for timestamp information.
Remarks
The TimestampInfo object contains details of a third-party timestamp and the outcome of its validation.
Fields
accuracy Int64 |
This field indicates the accuracy of the included time mark, in microseconds. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bytes Data |
Returns raw timestamp data in DER format. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
certificateIndex Int32 |
Returns the index of the TSA certificate in the Certificates collection Use this property to look up the TSA certificate in the Certificates collection. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
chainValidationDetails Int32 |
The details of a certificate chain validation outcome. They may often suggest what reasons that contributed to the overall validation result. Returns a bit mask of the following options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
chainValidationResult ChainValidities |
The outcome of a certificate chain validation routine. Available options:
Use the ValidationLog property to access the detailed validation log. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hashAlgorithm String |
Returns the timestamp's hash algorithm
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
serialNumber Data |
Returns the timestamp's serial number. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
signatureIndex Int32 |
Returns the index of the owner signature, if applicable. Use this property to establish the index of the associated signature object in the signature collection. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
time String |
The time point incorporated into the timestamp. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
timestampType Int32 |
Returns the type of the timestamp. Available options:
Not all of the above timestamp types can be supported by a specific signature technology used (CAdES, PDF, XAdES). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tsaName String |
This value uniquely identifies the Timestamp Authority (TSA). This property provides information about the entity that manages the TSA. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
validationLog String |
Contains the TSA certificate chain validation log. This information is extremely useful if the timestamp validation fails. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
validationResult SignatureValidities |
Contains timestamp validation outcome. Use this property to check the result of the most recent timestamp validation.
|
Constructors
public init()
Creates a new TimestampInfo object with default field values.
Config Settings (MessageVerifier Module)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.MessageVerifier Config Settings | ||||||||||||||||||||||||||||||
TempPath: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. | ||||||||||||||||||||||||||||||
Base Config Settings | ||||||||||||||||||||||||||||||
CheckKeyIntegrityBeforeUse:
Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit,
but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys. |
||||||||||||||||||||||||||||||
CookieCaching:
Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.
Supported values are:
|
||||||||||||||||||||||||||||||
Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. | ||||||||||||||||||||||||||||||
DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. | ||||||||||||||||||||||||||||||
EnableClientSideSSLFFDHE:
Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower
algorithm if compared to EC DHE; enabling it may result in slower connections.
This setting only applies to sessions negotiated with TLS version 1.3. |
||||||||||||||||||||||||||||||
GlobalCookies: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global". | ||||||||||||||||||||||||||||||
HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. | ||||||||||||||||||||||||||||||
LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
||||||||||||||||||||||||||||||
LogDetails:
Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.
Supported values are:
|
||||||||||||||||||||||||||||||
LogFile: Specifies the debug log filename.Use this property to provide a path to the log file. | ||||||||||||||||||||||||||||||
LogFilters:
Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
LogMaxEventCount:
Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects,
depending on the rotation setting and/or the flush mode.
The default value of this setting is 100. |
||||||||||||||||||||||||||||||
LogRotationMode:
Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:
|
||||||||||||||||||||||||||||||
MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. | ||||||||||||||||||||||||||||||
Tag: Allows to store any custom data.Use this config property to store any custom data. | ||||||||||||||||||||||||||||||
UseOwnDNSResolver: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. | ||||||||||||||||||||||||||||||
UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. | ||||||||||||||||||||||||||||||
UseSystemOAEPAndPSS:
Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable.
If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations
using its own OAEP/PSS implementation.
This setting only applies to certificates originating from a Windows system store. |
||||||||||||||||||||||||||||||
UseSystemRandom: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. |
Trappable Errors (MessageVerifier Module)
MessageVerifier Errors
1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
1048578 Class is configured incorrectly (SB_ERROR_INVALID_SETUP) | |
1048579 Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE) | |
1048580 Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE) | |
1048581 Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY) | |
1048581 Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |