ASiCSigner Class
Properties Methods Events Configuration Settings Errors
The ASiCSigner class creates signature containers.
Class Name
SecureBlackbox_ASiCSigner
Procedural Interface
secureblackbox_asicsigner_open(); secureblackbox_asicsigner_close($res); secureblackbox_asicsigner_register_callback($res, $id, $function); secureblackbox_asicsigner_get_last_error($res); secureblackbox_asicsigner_get_last_error_code($res); secureblackbox_asicsigner_set($res, $id, $index, $value); secureblackbox_asicsigner_get($res, $id, $index); secureblackbox_asicsigner_do_config($res, $configurationstring); secureblackbox_asicsigner_do_extractasyncdata($res, $asyncreply); secureblackbox_asicsigner_do_sign($res); secureblackbox_asicsigner_do_signasyncbegin($res); secureblackbox_asicsigner_do_signasyncend($res, $asyncreply); secureblackbox_asicsigner_do_signexternal($res); secureblackbox_asicsigner_do_timestamp($res, $timestamptype); secureblackbox_asicsigner_do_upgrade($res, $tolevel);
Remarks
ASiCSigner provides functionality for creating Associated Signature Containers. ASiC containers are used to bind together signed objects and electronic signatures or timestamps.
ASiCSigner supports both ASiC-S (simple) and ASiC-E (extended) signature profiles, as well as the three types of signatures (CAdES, XAdES, and timestamps).
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
BlockedCertCount | The number of records in the BlockedCert arrays. |
BlockedCertBytes | Returns raw certificate data in DER format. |
BlockedCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
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. |
ClaimedSigningTime | The signing time from the signer's computer. |
Extended | Specifies the type of ASiC signature. |
ExternalCryptoCustomParams | Custom parameters to be passed to the signing service (uninterpreted). |
ExternalCryptoData | Additional data to be included in the async state and mirrored back by the requestor. |
ExternalCryptoExternalHashCalculation | Specifies whether the message hash is to be calculated at the external endpoint. |
ExternalCryptoHashAlgorithm | Specifies the request's signature hash algorithm. |
ExternalCryptoKeyID | The ID of the pre-shared key used for DC request authentication. |
ExternalCryptoKeySecret | The pre-shared key used for DC request authentication. |
ExternalCryptoMethod | Specifies the asynchronous signing method. |
ExternalCryptoMode | Specifies the external cryptography mode. |
ExternalCryptoPublicKeyAlgorithm | Provide public key algorithm here if the certificate is not available on the pre-signing stage. |
HashAlgorithm | The hash algorithm to be used in signature computation. |
IgnoreChainValidationErrors | Makes the class tolerant to chain validation errors. |
InputBytes | Use this property to pass the input to class in the byte array form. |
InputFile | A path to the ASiC container to process. |
KnownCertCount | The number of records in the KnownCert arrays. |
KnownCertBytes | Returns raw certificate data in DER format. |
KnownCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
KnownCRLCount | The number of records in the KnownCRL arrays. |
KnownCRLBytes | Returns raw CRL data in DER format. |
KnownCRLHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
KnownOCSPCount | The number of records in the KnownOCSP arrays. |
KnownOCSPBytes | Buffer containing raw OCSP response data. |
KnownOCSPHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
Level | Specifies the level according to which the inner AdES signature is to be composed. |
OfflineMode | Switches the class to the offline mode. |
OutputBytes | Use this property to read the output the class object has produced. |
OutputFile | The file where the signed data will be saved. |
PolicyHash | The signature policy hash value. |
PolicyHashAlgorithm | The algorithm that was used to calculate the signature policy hash. |
PolicyID | The policy ID to be included into the signature. |
PolicyURI | The signature policy URI to be included in the signature. |
Profile | Specifies a pre-defined profile to apply when creating the signature. |
ProxyAddress | The IP address of the proxy server. |
ProxyAuthentication | The authentication type used by the proxy server. |
ProxyPassword | The password to authenticate to the proxy server. |
ProxyPort | The port on the proxy server to connect to. |
ProxyProxyType | The type of the proxy server. |
ProxyRequestHeaders | Contains HTTP request headers for WebTunnel and HTTP proxy. |
ProxyResponseBody | Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
ProxyResponseHeaders | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
ProxyUseIPv6 | Specifies whether IPv6 should be used when connecting through the proxy. |
ProxyUseProxy | Enables or disables proxy-driven connection. |
ProxyUsername | Specifies the username credential for proxy authentication. |
RevocationCheck | Specifies the kind(s) of revocation check to perform. |
SignatureIndex | The index of the signature to update. |
SignatureType | Specifies the kind of signature to be created. |
SigningCertBytes | Returns raw certificate data in DER format. |
SigningCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SigningChainCount | The number of records in the SigningChain arrays. |
SigningChainBytes | Returns raw certificate data in DER format. |
SigningChainHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SocketDNSMode | Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. |
SocketDNSPort | Specifies the port number to be used for sending queries to the DNS server. |
SocketDNSQueryTimeout | The timeout (in milliseconds) for each DNS query. |
SocketDNSServers | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
SocketDNSTotalTimeout | The timeout (in milliseconds) for the whole resolution process. |
SocketIncomingSpeedLimit | The maximum number of bytes to read from the socket, per second. |
SocketLocalAddress | The local network interface to bind the socket to. |
SocketLocalPort | The local port number to bind the socket to. |
SocketOutgoingSpeedLimit | The maximum number of bytes to write to the socket, per second. |
SocketTimeout | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
SocketUseIPv6 | Enables or disables IP protocol version 6. |
SourceBytes | Use this property to pass the content to sign in the byte array form. |
SourceFiles | The files to be packed into the container. |
SourceName | Use this property to specify the name of the file being signed if passing it via the SourceBytes property. |
TimestampServer | The address of the timestamping server. |
TLSClientCertCount | The number of records in the TLSClientCert arrays. |
TLSClientCertBytes | Returns raw certificate data in DER format. |
TLSClientCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
TLSServerCertCount | The number of records in the TLSServerCert arrays. |
TLSServerCertBytes | Returns raw certificate data in DER format. |
TLSServerCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
TLSAutoValidateCertificates | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
TLSBaseConfiguration | Selects the base configuration for the TLS settings. |
TLSCiphersuites | A list of ciphersuites separated with commas or semicolons. |
TLSECCurves | Defines the elliptic curves to enable. |
TLSForceResumeIfDestinationChanges | Whether to force TLS session resumption when the destination address changes. |
TLSPreSharedIdentity | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
TLSPreSharedKey | Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
TLSPreSharedKeyCiphersuite | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
TLSRenegotiationAttackPreventionMode | Selects renegotiation attack prevention mechanism. |
TLSRevocationCheck | Specifies the kind(s) of revocation check to perform. |
TLSSSLOptions | 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. |
TLSTLSMode | Specifies the TLS mode to use. |
TLSUseExtendedMasterSecret | Enables Extended Master Secret Extension, as defined in RFC 7627. |
TLSUseSessionResumption | Enables or disables TLS session resumption capability. |
TLSVersions | Th SSL/TLS versions to enable by default. |
TrustedCertCount | The number of records in the TrustedCert arrays. |
TrustedCertBytes | Returns raw certificate data in DER format. |
TrustedCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
ValidationLog | Contains the complete log of the certificate validation routine. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
ExtractAsyncData | Extracts user data from the DC signing service response. |
Sign | Signs the chosen files and packs them into an ASiC archive. |
SignAsyncBegin | Initiates the asynchronous signing operation. |
SignAsyncEnd | Completes the asynchronous signing operation. |
SignExternal | Signs the document using an external signing facility. |
Timestamp | Use this method to add timestamp. |
Upgrade | Upgrades existing CAdES or XAdES signature to a new level. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
Error | Information about any errors that occur during signing or archiving. |
ExternalSign | Handles remote or external signing initiated by the SignExternal method or other source. |
Notification | This event notifies the application about an underlying control flow event. |
StoreCertificate | This event is fired when a certificate should be stored along with a signature. |
StoreCRL | This event is fired when a CRL should be stored along with a signature. |
StoreOCSPResponse | This event is fired when a OCSP Response should be stored along with a signature. |
TLSCertValidate | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
ASiCOptions | Specifies the ASiC options. |
AsyncDocumentID | Specifies the document ID for SignAsyncEnd() call. |
CmsOptAnnexKArchiveTimestampV2Mode | Toggles use of Annex K method of calculating validation timestamp hashes. |
CmsOptCheckATSHashIndexElements | Enables extra checks when processing ATSHashIndex attribute. |
CmsOptCompareRDNAsStrings | Enforces comparison of RDN elements as text strings, rather than their byte encodings. |
CmsOptDigitPADSSCompatibility | Enables Digit PADSS compatibility mode. |
CmsOptForceSigningCertificateV2Usage | Enforces use of signing-certificate-v2 attribute. |
CmsOptIgnoreDERReqInArchiveTimestamps | Switches off DER encoding requirement for archival timestamps. |
CmsOptImzagerMIMCompatibility | Enables Imzager MIM compatibility mode. |
CmsOptIncludeCertToAttributes | Regulates whether to include the signing certificate to the signature as the signing-certificate attribute. |
CmsOptIncludeCertToMessage | Regulates whether to include the signing certificate and its chain to the CMS. |
CmsOptInsertContentType | Regulates whether the content-type time attribute should be included in the signature structure. |
CmsOptInsertMessageDigests | Regulates whether the message-digest signed attribute should be included in the signature structure. |
CmsOptInsertSigningTime | Regulates whether the signing-time attribute should be included in the signature structure. |
CmsOptSkipEnvContentInfoOnSigArchival | Excludes hashing of enveloped content when calculating an archival timestamp. |
CmsOptUseATSHashIndexV1 | Enables use of ATSHashIndexV1 attribute. |
CmsOptUseGeneralizedTimeFormat | Enables or disables encoding of the signing-time attribute using ASN.1 GENERALIZEDTIME type. |
CmsOptUseGenericSigAlgorithmOIDs | Enables use of generic signature algorithm OIDs in the signature. |
CmsOptUsePlainContentForTimestampHashes | Makes CAdESSigner ignore ASN.1 content formatting when calculating timestamp hashes. |
ContentType | Specifies the content-type of the container. |
ForceCompleteChainValidation | Whether to check the CA certificates when the signing certificate is invalid. |
ForceCompleteChainValidationForTrusted | Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. |
GenerateMetaInfEntry | Specifies whether the directory META-INF entry should be generated. |
GracePeriod | Specifies a grace period to apply during revocation information checks. |
IgnoreChainValidationErrors | Whether to ignore any certificate chain validation issues. |
IgnoreOCSPNoCheckExtension | Whether OCSP NoCheck extension should be ignored. |
IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
ImplicitlyTrustSelfSignedCertificates | Whether to trust self-signed certificates. |
PolicyExplicitText | The explicit text of the user notice. |
PolicyUNNumbers | The noticeNumbers part of the NoticeReference CAdES or XAdES attribute. |
PolicyUNOrganization | The organization part of the NoticeReference qualifier. |
ProductionPlace | The value to store in the ProductionPlace XAdES attribute. |
PromoteLongOCSPResponses | Whether long OCSP responses are requested. |
RefHashAlgorithm | Specifies the hash algorithm for references. |
RefMimeType | Specifies the MIME type to apply to the processed file. |
TempPath | Path for storing temporary files. |
TimestampResponse | A base16-encoded timestamp response received from a TSA. |
TLSChainValidationDetails | Contains the advanced details of the TLS server certificate validation. |
TLSChainValidationResult | Contains the result of the TLS server certificate validation. |
TLSClientAuthRequested | Indicates whether the TLS server requests client authentication. |
TLSValidationLog | Contains the log of the TLS server certificate validation. |
TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
UseMicrosoftCTL | Enables or disables automatic use of Microsoft online certificate trust list. |
UseSystemCertificates | Enables or disables the use of the system certificates. |
UseUTF8Filenames | Specifies whether to use UTF-8 filenames. |
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 class (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. |
UseOwnDNSResolver | Specifies whether the client classes 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. |