ArchiveWriter Component
Properties Methods Events Config Settings Errors
The ArchiveWriter component allows compressing, updating and modifying files for zip, tar, gzip and bzip2 archives.
Syntax
TsbxArchiveWriter
Remarks
Use ArchiveWriter to compress, update, and modify files in archives.
ArchiveWriter archiveWriter = new ArchiveWriter();
archiveWriter.setEncryptionType(ArchiveWriter.aetGeneric); // the type of encryption to apply to the archive
archiveWriter.setEncryptionPassword("MyPassword"); // specifies the archive encryption password
// creates a new archive with the desired archive type as a parameter
archiveWriter.createNew(ArchiveWriter.aftZip);
// add a file to the archive, the first parameter specifies the path where the file will be saved within the
// archive, the second parameter the file that you want to add to the archive
archiveWriter.addFile("","C:\\Photos\\MyPhoto.jpeg");
// add a collection of files to the archive, first param specifies the desired mount point for the files within the archive,
// second param is the path to the files on the local system, and the last one indicates whether you want to process the
// subdirectories recursively
archiveWriter.addFiles("","C:\\Photos",true);
archiveWriter.save("C:\\MyArchives");
The following common archive formats are supported:
- ZIP (.zip)
- GZip (.gz)
- BZip2 (.bz2)
- Tar+GZip (.tar.gz)
- Tar+Bzip2 (.tar.bz2)
Working with ArchiveWriter
Work with ArchiveWriter builds on the following steps:Creating or opening the archive.
Use CreateNew to create a new archive, or one of the Open* methods (such as Open or OpenBytes) to open an existing compressed file.
Inspecting the archive contents
Use the Files collection to access information about individual files stored in the opened archive. On this stage you can adjust the individual files objects' ACTION> and DATASOURCE> properties to configure bespoke processing for specific files.
Adding files to the archive
ArchiveWriter offers the following methods that you can use to add elements to the archive:
- AddFile - adds an entry with the contents of a local file.
- AddFiles - adds a set of files from a local directory.
- AddVirtual - allocates an entry in the archive. The actual data can be provided later using PrepareFile and BeforeCompressFile events.
Updating files in the archive
You can update files already present in the archive (e.g. with newer copies) using UpdateFile and UpdateFiles methods. The Remove method lets you delete individual files from the archive.
Use DecryptionPassword property to specify a decryption password for an archive and/or a specific entry within it. If the password is required but wasn't set, or if the provided password is wrong, the component will fire the DecryptionPasswordNeeded event. This event is fired repeatedly until the correct password is provided or its Cancel parameter is returned as true.
Saving and closing the archive
Once you are finished with composing/editing the archive, call the component's Save (or SaveBytes) method to save the updated archive, and then Close to close the archive file and release the associated memory.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
ArchiveType | The type of the archive. |
CompressionAlgorithm | Specifies the compression algorithm to use when forming the ZIP archive. |
CompressionLevel | The compression level to apply to the archived data. |
DecryptionCertificates | A collection of decryption certificates. |
DecryptionPassword | The decryption password. |
EncryptionAlgorithm | Specifies the encryption algorithm to apply to the archive. |
EncryptionCertificate | The encryption certificate. |
EncryptionKeyLength | The length of the encryption key. |
EncryptionPassword | Specifies the archive encryption password. |
EncryptionType | The type of encryption to apply to the archive. |
FileData | The contents of the file being added to the archive. |
Files | Lists the contents of the archive. |
FIPSMode | Reserved. |
HashAlgorithm | Specifies the hash algorithm to be used to generate the signature. |
NewArchive | Indicates whether the archive object represents a new (rather than opened) archive. |
Opened | Indicates whether component is currently in edit mode. |
Overwrite | Whether the component should overwrite existing files. |
SigningCertificate | The certificate to be used for signing. |
SigningChain | The signing certificate chain. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AddEmptyDir | Adds an empty folder to the archive. |
AddFile | Adds a file to the archive. |
AddFiles | Adds a group of files to the archive. |
AddVirtual | Adds a file placeholder to the archive. |
Close | Closes the archive. |
Config | Sets or retrieves a configuration setting. |
CreateNew | Creates a new archive. |
DoAction | Performs an additional action. |
Open | Opens an archive file. |
OpenBytes | Loads an archive file from a byte array. |
OpenStream | Loads an archive file from a stream. |
Remove | Removes file(s) and/or folder(s) from the archive. |
Reset | Resets the component settings. |
Save | Compresses the archive and saves it to a file. |
SaveBytes | Compresses the archive and saves it to a byte array. |
SaveStream | Compresses the archive and saves it to a stream. |
UpdateFile | Updates an existing compressed entry with a fresher local version. |
UpdateFiles | Updates a selection of files in the archive. |
UpdateVirtual | Updates an entry in the archive with on-the-fly content. |
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.
ActionNeeded | Requests a decision from the application in case of a conflict. |
AfterCompressFile | Marks the completion of compression of a file. |
BeforeCompressFile | Marks the start of compression of a file. |
DecryptionPasswordNeeded | Fires when the component needs a password to decrypt the archive. |
Error | Reports information about errors during archive assembling. |
Notification | This event notifies the application about an underlying control flow event. |
PrepareFile | Fires for every file to be compressed before the compression starts. |
Progress | Reports the progress of data compression. |
RecipientFound | Signifies that the archive was found to be encrypted with a digital certificate. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
EncryptionKeyLength | Sets the length of encryption key for WinZip-type protected archives. |
FilenamesCharset | The character set to apply to archived file names. |
ForceUStar | Enables UStar extension for new TAR archives. |
IgnoreOlderFilesWhenUpdating | Tells the component to ignore older copies of files when considering them for archive updating. |
TempPath | Path for storing temporary files. |
UsePax | Enables use of PAX algorithm when creating TAR directories. |
UseUStar | Enables use of UStar variant of file name packaging when creating TAR directories. |
ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
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. |
DNSLocalSuffix | The suffix to assign for TLD names. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HardwareCryptoUsePolicy | The hardware crypto usage policy. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
HttpVersion | The HTTP version to use in any inner HTTP client components created. |
IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
ListDelimiter | The delimiter character for multi-element lists. |
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. |
OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
PKICache | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
PKICachePath | Specifies the file system path where cached PKI data is stored. |
ProductVersion | Returns the version of the SecureBlackbox library. |
ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
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. |
UseCRLObjectCaching | Specifies whether reuse of loaded CRL objects is enabled. |
UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
UseLegacyAdESValidation | Enables legacy AdES validation mode. |
UseOCSPResponseObjectCaching | Specifies whether reuse of loaded OCSP response objects is enabled. |
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. |
UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
XMLRDNDescriptorName[OID] | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
XMLRDNDescriptorPriority[OID] | Specifies the priority of descriptor names associated with a specific OID. |
XMLRDNDescriptorReverseOrder | Specifies whether to reverse the order of descriptors in RDN. |
XMLRDNDescriptorSeparator | Specifies the separator used between descriptors in RDN. |
ArchiveType Property (ArchiveWriter Component)
The type of the archive.
Syntax
property ArchiveType: TsbxArchiveTypes read get_ArchiveType;
TsbxArchiveTypes = ( aftUnknown, aftZip, aftGzip, aftBzip2, aftTar, aftTarGzip, aftTarBzip2, aftSFX );
Default Value
aftUnknown
Remarks
This property indicates the type of the opened archive.
This property is read-only.
CompressionAlgorithm Property (ArchiveWriter Component)
Specifies the compression algorithm to use when forming the ZIP archive.
Syntax
property CompressionAlgorithm: Integer read get_CompressionAlgorithm write set_CompressionAlgorithm;
Default Value
8
Remarks
Use this property to select the compression algorithm to be used when creating a ZIP archive.
A typical choice is DEFLATE, which is the default setting. Some implementations also use STORED as an alternative where no compression is required (so the resulting archive is effectively an uncompressed directory of files).
acaStored | 0 | STORED |
acaShrunk | 1 | SHRUNK |
acaReduce1 | 2 | REDUCE_1 |
acaReduce2 | 3 | REDUCE_2 |
acaReduce3 | 4 | REDUCE_3 |
acaReduce4 | 5 | REDUCE_4 |
acaImplode | 6 | IMPLODE |
acaTokenizing | 7 | Tokenizing |
acaDeflate | 8 | Deflate |
acaDeflate64 | 9 | Deflate64 |
acaTerseOld | 10 | TERSE (old) |
acaBzip2 | 12 | Bzip2 |
acaLzma | 14 | LZMA |
acaTerseNew | 18 | TERSE (new) |
acaLz77 | 19 | LZ77 |
acaWavPack | 97 | WAVPACK |
acaPPMDv1 | 98 | PPMD v1 |
acaWinzipAES | 99 | WinZIP AES |
acaUnknown | 65535 | Unknown or unsupported algorithm |
CompressionLevel Property (ArchiveWriter Component)
The compression level to apply to the archived data.
Syntax
property CompressionLevel: Integer read get_CompressionLevel write set_CompressionLevel;
Default Value
6
Remarks
Use this property to specify the compression level (1 to 9) to apply to the archived data.
DecryptionCertificates Property (ArchiveWriter Component)
A collection of decryption certificates.
Syntax
property DecryptionCertificates: TsbxCertificateList read get_DecryptionCertificates write set_DecryptionCertificates;
Remarks
Use this property to provide a collection of decryption certificates. All certificates should contain their respective private keys.
When processing an encrypted document, the component will walk through the certificate list to locate the matching decryption certificate. If no such certificate is found, it will fire RecipientFound event to request it.
This property is not available at design time.
Please refer to the Certificate type for a complete list of fields.DecryptionPassword Property (ArchiveWriter Component)
The decryption password.
Syntax
property DecryptionPassword: String read get_DecryptionPassword write set_DecryptionPassword;
Default Value
''
Remarks
Use this property to provide the decryption password. You can assign it explicitly before commencing file extraction, or provide it on the fly from DecryptionPasswordNeeded event handler.
EncryptionAlgorithm Property (ArchiveWriter Component)
Specifies the encryption algorithm to apply to the archive.
Syntax
property EncryptionAlgorithm: String read get_EncryptionAlgorithm write set_EncryptionAlgorithm;
Default Value
''
Remarks
Use this property to specify the encryption algorithm to apply to the archive.
Component supports the following algorithms: AES128, AES192, AES256, BLOWFISH, TWOFISH, 3DES, 3DES112, DES, RC2, RC4. Note that not all of them may be supported by the processing software.
EncryptionCertificate Property (ArchiveWriter Component)
The encryption certificate.
Syntax
property EncryptionCertificate: TsbxCertificate read get_EncryptionCertificate write set_EncryptionCertificate;
Remarks
Use this property to provide the encryption certificate.
This property is not available at design time.
Please refer to the Certificate type for a complete list of fields.EncryptionKeyLength Property (ArchiveWriter Component)
The length of the encryption key.
Syntax
property EncryptionKeyLength: Integer read get_EncryptionKeyLength write set_EncryptionKeyLength;
Default Value
0
Remarks
Use this setting to specify the length of the encryption key in bits. Keep the key length at zero to let the component use the default value assumed by the encryption algorithm.
EncryptionPassword Property (ArchiveWriter Component)
Specifies the archive encryption password.
Syntax
property EncryptionPassword: String read get_EncryptionPassword write set_EncryptionPassword;
Default Value
''
Remarks
Use this property to provide the password to encrypt the archive with. Use it alongside EncryptionType and EncryptionAlgorithm properties to set up the whole set of protection settings for the archive.
EncryptionType Property (ArchiveWriter Component)
The type of encryption to apply to the archive.
Syntax
property EncryptionType: TsbxEncryptionTypes read get_EncryptionType write set_EncryptionType;
TsbxEncryptionTypes = ( aetDefault, aetNoEncryption, aetGeneric, aetWinZip, aetStrong );
Default Value
aetDefault
Remarks
Specifies the encryption type for the archive.
FileData Property (ArchiveWriter Component)
The contents of the file being added to the archive.
Syntax
property FileData: TBytes read get_FileData write set_FileData;
Remarks
Assign this property with a byte array containing the contents of the file being added, if you set the corresponding entry's DataSource to fdsBuffer.
Use FileStream property, with DataSource set to fdsStream, to provide the data in a stream instead. Alternatively, use fdsFile data source to supply the file data in a disk file.
This property is not available at design time.
Files Property (ArchiveWriter Component)
Lists the contents of the archive.
Syntax
property Files: TsbxArchivedFileList read get_Files;
Remarks
This colletction property provides access to all files contained in the archive, both existing and newly added.
Use it to view or adjust properties of specific files, alter their data sources, and tune up actions to be performed on them.
This property is read-only and not available at design time.
Please refer to the ArchivedFile type for a complete list of fields.FIPSMode Property (ArchiveWriter Component)
Reserved.
Syntax
property FIPSMode: Boolean read get_FIPSMode write set_FIPSMode;
Default Value
false
Remarks
This property is reserved for future use.
HashAlgorithm Property (ArchiveWriter Component)
Specifies the hash algorithm to be used to generate the signature.
Syntax
property HashAlgorithm: String read get_HashAlgorithm write set_HashAlgorithm;
Default Value
''
Remarks
Set this property before signing the archive to specify the hash algorithm to be used to calculate the signature.
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 |
This property is not available at design time.
NewArchive Property (ArchiveWriter Component)
Indicates whether the archive object represents a new (rather than opened) archive.
Syntax
property NewArchive: Boolean read get_NewArchive;
Default Value
false
Remarks
This property is set to true if the archive is new, or to false if the component control is editing an existing archive.
NewArchive would typically be set to true after a CreateNew call, and to false after an Open call.
This property is read-only.
Opened Property (ArchiveWriter Component)
Indicates whether component is currently in edit mode.
Syntax
property Opened: Boolean read get_Opened;
Default Value
false
Remarks
This property is set to true if the archive control is in edit mode, meaning it was opened with Open or created with CreateNew call.
When an archive is opened, you can add new files to it, remove existing files, or modify encryption attributes.
This property is read-only.
Overwrite Property (ArchiveWriter Component)
Whether the component should overwrite existing files.
Syntax
property Overwrite: Boolean read get_Overwrite write set_Overwrite;
Default Value
false
Remarks
Enable this property to force overwriting of existing files.
SigningCertificate Property (ArchiveWriter Component)
The certificate to be used for signing.
Syntax
property SigningCertificate: TsbxCertificate read get_SigningCertificate write set_SigningCertificate;
Remarks
Use this property to specify the certificate that shall be used for signing the data. Note that this certificate should have a private key associated with it. Use SigningChain to supply the rest of the certificate chain for inclusion into the signature.
This property is not available at design time.
Please refer to the Certificate type for a complete list of fields.SigningChain Property (ArchiveWriter Component)
The signing certificate chain.
Syntax
property SigningChain: TsbxCertificateList read get_SigningChain write set_SigningChain;
Remarks
Use this property to provide the chain for the signing certificate. Use the SigningCertificate property, if it is available, to provide the signing certificate itself.
This property is not available at design time.
Please refer to the Certificate type for a complete list of fields.AddEmptyDir Method (ArchiveWriter Component)
Adds an empty folder to the archive.
Syntax
function AddEmptyDir(Path: String): Integer;
Remarks
Use this method to added an empty folder to the archive with an internal path of Path.
The method returns the index of the new folder entry in the Files collection.
AddFile Method (ArchiveWriter Component)
Adds a file to the archive.
Syntax
function AddFile(Path: String; LocalPath: String): Integer;
Remarks
Use this method to add a disk file to the archive. Provide the local path to the file (e.g. C:\Photos\photo.jpg) via the LocalPath parameter, and the desired path within the archive (e.g. PhotosBackup2020/photo.jpg) via the Path parameter.
AddFiles Method (ArchiveWriter Component)
Adds a group of files to the archive.
Syntax
procedure AddFiles(Folder: String; LocalPath: String; Recursive: Boolean);
Remarks
Use this method to add a collection of files to the archive.
Provide the path to the files on a local system (e.g. C:\photos) via the LocalPath parameter, and set Recursive to indicate whether you want to process the subdirectories recursively. Pass the desired mount point for the files within the archive (e.g. Backup2020/photos) via the Folder parameter.
You can use file mask wildcards in LocalPath to only select the files that match the mask.
AddVirtual Method (ArchiveWriter Component)
Adds a file placeholder to the archive.
Syntax
function AddVirtual(Path: String): Integer;
Remarks
Use this method to add a placeholder for the entry the contents of which is to be provided on the fly from a stream or buffer.
Pass the path to the entry within the archive (e.g. Reports/report2020.csv) via the Path parameter. After the entry has been added, use PrepareFile event or Files property to tune up the type of the data source (file, stream, or memory buffer). During the actual compression, provide the contents of the entry in a stream or buffer in the BeforeCompressFile event handler.
This method returns the index of the new entry in the Files collection.
Close Method (ArchiveWriter Component)
Closes the archive.
Syntax
procedure Close();
Remarks
Use this method to close the current archive and dispose of all the allocated resources.
Call this method when you are done with the archive.
Config Method (ArchiveWriter Component)
Sets or retrieves a configuration setting.
Syntax
function Config(ConfigurationString: String): String;
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.
CreateNew Method (ArchiveWriter Component)
Creates a new archive.
Syntax
procedure CreateNew(ArchiveType: Integer);
Remarks
Use this method to create a new archive file. Provide the desired archive type in the ArchiveType parameter.
The following archive types are currently supported:
aftZip (1) | The archive contains data in ZIP format. |
aftGzip (2) | The archive file contains data in GZIP format. |
aftBzip2 (3) | The archive contains BZIP2 data. |
aftTar (4) | The archive contains a .tar file. |
aftTarGzip (5) | The archive contains a .tar.gz file. |
aftTarBzip2 (6) | The archive contains data in .tar.bz2 format. |
The archive will be kept in memory until written down with Save or SaveStream method.
DoAction Method (ArchiveWriter Component)
Performs an additional action.
Syntax
function DoAction(ActionID: String; ActionParams: String): String;
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;....
Common ActionIDs:
Action | Parameters | Returned value | Description |
ResetTrustedListCache | none | none | Clears the cached list of trusted lists. |
ResetCertificateCache | none | none | Clears the cached certificates. |
ResetCRLCache | none | none | Clears the cached CRLs. |
ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. |
Open Method (ArchiveWriter Component)
Opens an archive file.
Syntax
procedure Open(ArchiveType: Integer; ArchiveName: String);
Remarks
Use this method to open an existing archive file for modification.
Provide the path to the archive file via the ArchiveName parameter, and pass the archive type in the ArchiveType parameter.
The following archive types are currently supported:
aftUnknown (0) | It was not possible to establish the type of the archive file. |
aftZip (1) | The archive contains data in ZIP format. |
aftGzip (2) | The archive file contains data in GZIP format. |
aftBzip2 (3) | The archive contains BZIP2 data. |
aftTar (4) | The archive contains a .tar file. |
aftTarGzip (5) | The archive contains a .tar.gz file. |
aftTarBzip2 (6) | The archive contains data in .tar.bz2 format. |
The archive will be kept in memory until written down with Save or SaveStream method.
OpenBytes Method (ArchiveWriter Component)
Loads an archive file from a byte array.
Syntax
procedure OpenBytes(ArchiveType: Integer; ArchiveBytes: TBytes);
Remarks
Use this method to load an existing archive file from a byte array.
Provide the archive stream via the ArchiveBytes parameter, and pass the archive type in the ArchiveType parameter.
The following archive types are currently supported:
aftUnknown (0) | It was not possible to establish the type of the archive. |
aftZip (1) | The archive contains data in ZIP format. |
aftGzip (2) | The archive file contains data in GZIP format. |
aftBzip2 (3) | The archive contains BZIP2 data. |
aftTar (4) | The archive contains a .tar file. |
aftTarGzip (5) | The archive contains a .tar.gz file. |
aftTarBzip2 (6) | The archive contains data in .tar.bz2 format. |
The archive will be kept in memory until written down with Save, SaveStream, or SaveBytes method.
OpenStream Method (ArchiveWriter Component)
Loads an archive file from a stream.
Syntax
procedure OpenStream(ArchiveType: Integer; ArchiveStream: TStream);
Remarks
Use this method to load an existing archive file from a stream.
Provide the archive stream via the ArchiveStream parameter, and pass the archive type in the ArchiveType parameter.
The following archive types are currently supported:
aftUnknown (0) | It was not possible to establish the type of the archive. |
aftZip (1) | The archive contains data in ZIP format. |
aftGzip (2) | The archive file contains data in GZIP format. |
aftBzip2 (3) | The archive contains BZIP2 data. |
aftTar (4) | The archive contains a .tar file. |
aftTarGzip (5) | The archive contains a .tar.gz file. |
aftTarBzip2 (6) | The archive contains data in .tar.bz2 format. |
The archive will be kept in memory until written down with Save or SaveStream method.
Remove Method (ArchiveWriter Component)
Removes file(s) and/or folder(s) from the archive.
Syntax
procedure Remove(Path: String);
Remarks
Use this method to remove entries from the archive. Provide an archive-local path via the Path parameter.
Path supports file masks, which makes this method quite powerful (and potentially dangerous).
Reset Method (ArchiveWriter Component)
Resets the component settings.
Syntax
procedure Reset();
Remarks
Reset is a generic method available in every component.
Save Method (ArchiveWriter Component)
Compresses the archive and saves it to a file.
Syntax
procedure Save(ArchiveName: String);
Remarks
Use this method to finalize all preparations, compress all the entries set up in Files collection, and write the created archive to ArchiveName file.
This method carries out a lot of work and fires a number of events during its execution. Before the compression process starts, PrepareFile event fires repeatedly to provide the summary of what is being included into the archive. A handler of that event is a good place to make last-minute modifications to the data sources, file names, and actions to take upon the files.
Compression of each entry is surrounded with BeforeCompressFile and AfterCompressFile "brackets". Subscribe to BeforeCompressFile to supply the file contents for entries with Buffer and Stream data sources. AfterCompressFile is a good place to release the content stream alloated in the BeforeCompressFile event handler.
Progress event fires repeatedly to report the progress of the current and whole operations. It also provides an opportunity to abort the compression process.
SaveBytes Method (ArchiveWriter Component)
Compresses the archive and saves it to a byte array.
Syntax
function SaveBytes(): TBytes;
Remarks
Use this method to finalize all preparations and compress all entries contained in the Files collection. The method returns the byte array containing the serialized archive.
You can fine-tune the compression process by providing compression details on the fly via the events component fires. See the description of the Save method for the details.
SaveStream Method (ArchiveWriter Component)
Compresses the archive and saves it to a stream.
Syntax
procedure SaveStream(ArchiveStream: TStream);
Remarks
Use this method to finalize all preparations and compress all entries contained in the Files collection to ArchiveStream.
You can fine-tune the compression process by providing compression details on the fly via the events component fires. See the description of the Save method for the details.
UpdateFile Method (ArchiveWriter Component)
Updates an existing compressed entry with a fresher local version.
Syntax
procedure UpdateFile(Path: String; LocalPath: String);
Remarks
Call this method to update the Path entry in the archive with a fresher entry at LocalPath.
UpdateFiles Method (ArchiveWriter Component)
Updates a selection of files in the archive.
Syntax
procedure UpdateFiles(Folder: String; LocalPath: String; AddMissingFiles: Boolean; RemoveMissingFiles: Boolean; Recursive: Boolean);
Remarks
This method is a powerful way to update a subset of files in the archive in accordance with a specified criteria.
Pass an archive-local name of the folder to update via the Folder parameter, and the system-local version of the same folder via the LocalPath parameter. Set AddMissingFiles and RemoveMissingFiles as needed to force inclusion of files missing from the archive, or removal of files missing locally, accordingly.
The Recursive parameter specifies whether the directory should be browsed recursively.
UpdateVirtual Method (ArchiveWriter Component)
Updates an entry in the archive with on-the-fly content.
Syntax
procedure UpdateVirtual(Path: String);
Remarks
Use this method to update content of an existing archive entry. Pass the archive-local entry path via the Path parameter. After updating the entry, tune up its DataSource property in accordance with the desired content origin. Subscribe to BeforeCompressFile to supply the actual data via FileData or FileStream properties.
ActionNeeded Event (ArchiveWriter Component)
Requests a decision from the application in case of a conflict.
Syntax
type TActionNeededEvent = procedure ( Sender: TObject; WhatFor: Integer; const EntryPath: String; const DestPath: String; const Description: String; var Action: Integer ) of Object;
property OnActionNeeded: TActionNeededEvent read FOnActionNeeded write FOnActionNeeded;
Remarks
The component fires this event to request a decision from the application when it encounters a conflict.
The WhatFor parameter can take one of the following values:
aceExtractionFailed | 4097 | File extraction failed |
aceFileAlreadyExists | 4098 | The file already exists |
aceCannotCreateFile | 4099 | Cannot create a file |
aceDirAlreadyExists | 4100 | The directory already exists |
aceFileAlreadyAdded | 4101 | The file has already been added to the archive |
aceCRCMismatch | 4102 | The calculated file or archive CRC does not match the stored CRC |
aceInvalidPassword | 4103 | The provided password is wrong |
You can control the further flow from the event handler by setting the Action parameter to one of the following values:
auaIgnore | 0 | Ignore the conflict - go ahead (overwrite etc.) |
auaAbort | 1 | Abort the operation |
auaRetry | 2 | Make another attempt |
auaSkip | 3 | Skip this item and proceed with the operation |
AfterCompressFile Event (ArchiveWriter Component)
Marks the completion of compression of a file.
Syntax
type TAfterCompressFileEvent = procedure ( Sender: TObject; const Path: String; FileSize: Int64; DataSource: Integer ) of Object;
property OnAfterCompressFile: TAfterCompressFileEvent read FOnAfterCompressFile write FOnAfterCompressFile;
Remarks
Subscribe to this event to get notified about the completion of compression of a file.
The Path parameter specifies the internal path to the entry inside the archive. The FileSize indicates the size of the file before compression, and the DataSource specifies the type of the source media.
fdsFile (0) | The data was taken from a file. |
fdsStream (1) | The data was taken from a stream assigned to FileStream property. |
fdsBuffer (2) | The file data taken from the FileData buffer. |
BeforeCompressFile Event (ArchiveWriter Component)
Marks the start of compression of a file.
Syntax
type TBeforeCompressFileEvent = procedure ( Sender: TObject; const Path: String; FileSize: Int64; DataSource: Integer ) of Object;
property OnBeforeCompressFile: TBeforeCompressFileEvent read FOnBeforeCompressFile write FOnBeforeCompressFile;
Remarks
Subscribe to this event to be notified about the start of compression of an archive entry. The handler of this event is a good place to prepare the desired data source.
The Path parameter indicates the path to the extracted entry in the archive. The FileSize specifies the size of the file before compression. Use this event handler to adjust the data source if the file is to be loaded from a stream or buffer. The DataSource parameter indicates the type of the data media:
fdsFile (0) | The data will be taken from a file indicated by the entry's LocalPath setting. You can change this path in the handler of this event. |
fdsStream (1) | The file data will be taken from a stream assigned to FileStream property. |
fdsBuffer (2) | The data will be taken from a buffer attached to the FileData property. |
Use PrepareFile event to adjust the file data source on the fly.
DecryptionPasswordNeeded Event (ArchiveWriter Component)
Fires when the component needs a password to decrypt the archive.
Syntax
type TDecryptionPasswordNeededEvent = procedure ( Sender: TObject; const PasswordTarget: String; var Cancel: Boolean ) of Object;
property OnDecryptionPasswordNeeded: TDecryptionPasswordNeededEvent read FOnDecryptionPasswordNeeded write FOnDecryptionPasswordNeeded;
Remarks
Component fires this event to request a decryption password from the application when it comes across an encrypted archive or entry.
Please assign the password to DecryptionPassword property inside the event handler, or set Cancel to true to cancel the operation. The PasswordTarget parameter references the object that is protected with the requested password.
Error Event (ArchiveWriter Component)
Reports information about errors during archive assembling.
Syntax
type TErrorEvent = procedure ( Sender: TObject; ErrorCode: Integer; const Description: String ) of Object;
property OnError: TErrorEvent read FOnError write FOnError;
Remarks
The event is fired in case of exceptional conditions during archive formation.
ErrorCode contains an error code and Description contains a textual description of the error.
Notification Event (ArchiveWriter Component)
This event notifies the application about an underlying control flow event.
Syntax
type TNotificationEvent = procedure ( Sender: TObject; const EventID: String; const EventParam: String ) of Object;
property OnNotification: TNotificationEvent read FOnNotification write FOnNotification;
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.
PrepareFile Event (ArchiveWriter Component)
Fires for every file to be compressed before the compression starts.
Syntax
type TPrepareFileEvent = procedure ( Sender: TObject; const Path: String; FileSize: Int64; var DataSource: Integer; var LocalPath: String; var Action: Integer ) of Object;
property OnPrepareFile: TPrepareFileEvent read FOnPrepareFile write FOnPrepareFile;
Remarks
Component fires this event for every file included in the Files collection before commencing the compression. This is the last opportunity for your code to adjust the action to be taken for each file and tune up the data sources appropriately.
The Path parameter contains the path to the file within the archive (such as Photos/myphoto.jpg), and the FileSize contains the size of that file before compression.
The DataSource parameter indicates the media from which the file contents is to be taken. A typical default value if fdsFile, but you can adjust the value of that parameter if you need to use an alternative source. The following options are available:
fdsFile (0) | The data will be taken from a file indicated by the LocalPath parameter. You can change this path in this event handler. |
fdsStream (1) | The file data will be taken from a stream assigned to FileStream property. |
fdsBuffer (2) | The data will be taken from a buffer attached to the FileData property. |
The Action parameter, which is also tuneable, indicates the action for component to take on the file:
atAdd (0) | Add the file to the archive |
atKeep (1) | Keep the existing file in the archive |
atUpdate (2) | Update the archived file with a fresher copy |
atDelete (3) | Delete the file from the archive |
atExtract (4) | Extract the file (extraction only) |
atSkip (5) | Skip file extraction (extraction only) |
Progress Event (ArchiveWriter Component)
Reports the progress of data compression.
Syntax
type TProgressEvent = procedure ( Sender: TObject; Processed: Int64; Total: Int64; OverallProcessed: Int64; OverallTotal: Int64; var Cancel: Boolean ) of Object;
property OnProgress: TProgressEvent read FOnProgress write FOnProgress;
Remarks
Subscribe to this event to be notified about compression progress.
Processed and Total report the progress of compression of the current entry; OverallProcessed and OverallTotal report the progress of the whole operation. Set Cancel to true to stop the operation.
RecipientFound Event (ArchiveWriter Component)
Signifies that the archive was found to be encrypted with a digital certificate.
Syntax
type TRecipientFoundEvent = procedure ( Sender: TObject; const PublicKeyHash: String; CertFound: Boolean ) of Object;
property OnRecipientFound: TRecipientFoundEvent read FOnRecipientFound write FOnRecipientFound;
Remarks
The component fires this event to notify the application that the archive was found to be encrypted with a digital certificate. The hash of the certificate's public key is provided in the PublicKeyHash parameter.
CertFound indicates whether a certificate with a matching public key hash was found in the DecryptionCertificates list. If it wasn't, you need to locate it on the system and add it to that list: component won't be able to decrypt the archive otherwise.
Please note that the certificate must have an associated private key to be capable of decryption.
ArchivedFile Type
Provides information about the compressed file.
Remarks
Use this type to access compressed file details.
Fields
Action
TsbxActions
Default Value: 0
This property contains the action to apply to the file.
Use this property to control the action that should be applied to the file during the compression or extraction. The following actions are supported:
atAdd (0) | Add the file to the archive. |
atKeep (1) | Keep the existing file in the archive. |
atUpdate (2) | Update the archived file with a fresher copy. |
atDelete (3) | Delete the file from the archive. |
atExtract (4) | Extract the file (extraction only). |
atSkip (5) | Skip file extraction (extraction only). |
Attributes
String
Default Value: ""
This property provides access to file attributes.
ZIP archives support the provision of Windows (or DOS, as it is called historically) or Unix file attributes. Use this property to provide access to the attributes or to read them out of an existing archive.
Use "dos:" or "unix:" prefixes to indicate what kind of attributes you need to include, as follows:
Writer.Files[0].Attributes = "unix:-rwxr-xr-x";
Writer.Files[1].Attributes = "unix:-r--r--r--";
Writer.Files[2].Attributes = "dos:readonly";
Writer.Files[3].Attributes = "dos:readonly;hidden"; // supported values: readonly, hidden, system, volumeLabel, directory, archive
CompressedSize
Int64 (read-only)
Default Value: 0
This property contains the size of the file after compression.
DataSource
TsbxFileDataSources
Default Value: 0
This property contains the type of data source for this entry.
Use this property to control the data source for this entry.
fdsFile (0) | The data for this entry should be taken from the file provided by LocalPath. |
fdsStream (1) | Data are going to be provided on-the-fly through the FileStream property. |
fdsBuffer (2) | Data are going to be provided on-the-fly through the FileData property. |
Directory
Boolean (read-only)
Default Value: False
This property tells if the entry is a directory or a regular file.
EncryptionAlgorithm
String (read-only)
Default Value: ""
This property returns the symmetric algorithm that was used to encrypt the file.
EncryptionKeyLength
Integer (read-only)
Default Value: 0
This property returns the length, in bits, of the encryption key.
EncryptionType
TsbxEncryptionTypes (read-only)
Default Value: 0
This property contains the type of encryption applied to the file.
Use this property to find out what kind of encryption was applied to the file.
aetDefault (0) | Default encryption (not used for already encrypted files) |
aetNoEncryption (1) | No encryption |
aetGeneric (2) | Standard ZIP encryption |
aetWinZip (3) | WinZIP-based encryption |
aetStrong (4) | Strong encryption |
FileName
String
Default Value: ""
This property specifies the original name of the compressed file or folder.
Folder
String (read-only)
Default Value: ""
This property includes the containing folder of the entry.
LocalPath
String
Default Value: ""
This property contains the local path associated with this entry.
It typically specifies the source path that the data should be taken from, or the destination it should be extracted to.
MTime
String
Default Value: ""
This property contains the entry's last modification time.
NewFile
Boolean (read-only)
Default Value: False
This property indicates whether the entry corresponds to a file to be added to the archive.
Path
String (read-only)
Default Value: ""
This property contains the full internal path of the archived entry.
SignatureCount
Integer (read-only)
Default Value: 0
This property includes the number of signatures covering the entry.
Signed
Boolean (read-only)
Default Value: False
This property indicates whether the entry is signed.
Size
Int64 (read-only)
Default Value: 0
This property specifies the size of the file before compression.
Constructors
>
constructor Create();
Creates a new ArchivedFile object.
Certificate Type
Encapsulates an individual X.509 certificate.
Remarks
This type keeps and provides access to X.509 certificate details.
Fields
Bytes
TBytes (read-only)
Default Value: ""
Returns the raw certificate data in DER format.
CA
Boolean
Default Value: False
Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.
Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.
CAKeyID
TBytes (read-only)
Default Value: ""
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.
This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the SubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.
CertType
TsbxCertTypes (read-only)
Default Value: 0
Returns the type of the entity contained in the Certificate object.
A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.
Use the CertificateManager component to load or create new certificate and certificate requests objects.
CRLDistributionPoints
String
Default Value: ""
Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.
Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.
The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
Curve
String
Default Value: ""
Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.
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
String (read-only)
Default Value: ""
Contains the fingerprint (a hash imprint) of this certificate.
While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.
FriendlyName
String (read-only)
Default Value: ""
Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.
Handle
Int64
Default Value: 0
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.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
HashAlgorithm
String
Default Value: ""
Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use SigAlgorithm to find out the hash algorithm that is part of the certificate signature.
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. This is part of a larger set of credentials available via IssuerRDN.
IssuerRDN
String
Default Value: ""
A list of Property=Value pairs that uniquely identify the certificate issuer.
Example: /C=US/O=Nationwide CA/CN=Web Certification Authority
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 |
Use the KeyBits, Curve, and PublicKeyBytes properties to get more details about the key the certificate contains.
KeyBits
Integer (read-only)
Default Value: 0
Returns the length of the public key in bits.
This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the PublicKeyBytes or PrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.
KeyFingerprint
String (read-only)
Default Value: ""
Returns a SHA1 fingerprint of the public key contained in the certificate.
Note that the key fingerprint is different from the certificate fingerprint accessible via the Fingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.
KeyUsage
Integer
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 |
Set this property before generating the certificate to propagate the key usage flags to the new certificate.
KeyValid
Boolean (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 services that can be used to check this certificate's validity in real time, as recorded by the CA.
Set this property before calling the certificate manager's Generate method to propagate it to the new certificate.
The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
OCSPNoCheck
Boolean
Default Value: False
Accessor to the value of the certificate's ocsp-no-check extension.
Origin
Integer (read-only)
Default Value: 0
Returns the location that the certificate was taken or loaded from.
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.
Set this property when generating a certificate to propagate the policies information to the new certificate.
The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.
PrivateKeyBytes
TBytes (read-only)
Default Value: ""
Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.
PrivateKeyExists
Boolean (read-only)
Default Value: False
Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.
This property is independent from PrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.
PrivateKeyExtractable
Boolean (read-only)
Default Value: False
Indicates whether the private key is extractable (exportable).
PublicKeyBytes
TBytes (read-only)
Default Value: ""
Contains the certificate's public key in DER format.
This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.
Qualified
Boolean (read-only)
Default Value: False
Indicates whether the certificate is qualified.
This property is set to True if the certificate is confirmed by a Trusted List to be qualified.
QualifiedStatements
TsbxQualifiedStatementsTypes
Default Value: 0
Returns a simplified qualified status of the certificate.
Qualifiers
String (read-only)
Default Value: ""
A list of qualifiers.
Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.
SelfSigned
Boolean (read-only)
Default Value: False
Indicates whether the certificate is self-signed (root) or signed by an external CA.
SerialNumber
TBytes
Default Value: ""
Returns the certificate's serial number.
The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.
SigAlgorithm
String (read-only)
Default Value: ""
Indicates the algorithm that was used by the CA to sign this certificate.
A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.
Source
TsbxPKISources (read-only)
Default Value: 0
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
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. This is part of a larger set of credentials available via SubjectRDN.
SubjectAlternativeName
String
Default Value: ""
Returns or sets the value of the Subject Alternative Name extension of the certificate.
Subject alternative names are used to provide additional names that are impractical to store in the main SubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.
The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.
SubjectKeyID
TBytes
Default Value: ""
Contains a unique identifier of the certificate's cryptographic key.
Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.
The SubjectKeyID and CAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.
SubjectRDN
String
Default Value: ""
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.
Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.
Valid
Boolean (read-only)
Default Value: False
Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
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
>
constructor Create();
Creates a new object with default field values.
Config Settings (ArchiveWriter 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.ArchiveWriter Config Settings
writer.Config("FilenamesCharset=cp852");
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:
certificate | Enables caching of certificates. |
crl | Enables caching of Certificate Revocation Lists (CRLs). |
ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. |
Example (default value):
PKICache=certificate,crl,ocsp
In this example, the component caches certificates, CRLs, and OCSP responses.
The default value is an empty string - no cached PKI data is stored on disk.
Example:
PKICachePath=C:\Temp\cache
In this example, the cached PKI data is stored in the C:\Temp\cache directory.
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.
The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.
Syntax:
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");
Where:
OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.
PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.
Alias1, Alias2, ...: Optional alternative names recognized during parsing.
Usage Examples:
Map OID 2.5.4.5 to SERIALNUMBER:
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");