ArchiveReader Class

Properties   Methods   Events   Config Settings   Errors  

The ArchiveReader class supports inspection and extraction of files from zip, tar, gzip and bzip2 archives.

Class Name

SecureBlackbox_ArchiveReader

Procedural Interface

 secureblackbox_archivereader_open();
 secureblackbox_archivereader_close($res);
 secureblackbox_archivereader_register_callback($res, $id, $function);
 secureblackbox_archivereader_get_last_error($res);
 secureblackbox_archivereader_get_last_error_code($res);
 secureblackbox_archivereader_set($res, $id, $index, $value);
 secureblackbox_archivereader_get($res, $id, $index);
 secureblackbox_archivereader_do_close($res);
 secureblackbox_archivereader_do_config($res, $configurationstring);
 secureblackbox_archivereader_do_doaction($res, $actionid, $actionparams);
 secureblackbox_archivereader_do_extract($res, $path, $localpath, $preservefullpath);
 secureblackbox_archivereader_do_extractall($res, $outputpath, $overwriteexisting);
 secureblackbox_archivereader_do_open($res, $archivetype, $archivepath);
 secureblackbox_archivereader_do_openbytes($res, $archivetype, $archivebytes);

Remarks

ArchiveReader shows and extracts archived files.

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

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.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

ArchiveType Property (SecureBlackbox_ArchiveReader Class)

The type of the archive file.

Object Oriented Interface

public function getArchiveType();

Procedural Interface

secureblackbox_archivereader_get($res, 1 );

Default Value

0

Remarks

Use this property to learn about the type (format) of the opened archive.

This property is read-only.

Data Type

Integer

DecryptionCertCount Property (SecureBlackbox_ArchiveReader Class)

The number of records in the DecryptionCert arrays.

Object Oriented Interface

public function getDecryptionCertCount();


public function setDecryptionCertCount($value);

Procedural Interface

secureblackbox_archivereader_get($res, 2 );


secureblackbox_archivereader_set($res, 2, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• DecryptionCertBytes
• DecryptionCertHandle

The array indices start at 0 and end at DecryptionCertCount - 1.

This property is not available at design time.

Data Type

Integer

DecryptionCertBytes Property (SecureBlackbox_ArchiveReader Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getDecryptionCertBytes($decryptioncertindex);

Procedural Interface

secureblackbox_archivereader_get($res, 3 , $decryptioncertindex);

Remarks

Returns the raw certificate data in DER format.

The $decryptioncertindex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptionCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

DecryptionCertHandle Property (SecureBlackbox_ArchiveReader Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getDecryptionCertHandle($decryptioncertindex);


public function setDecryptionCertHandle($decryptioncertindex, $value);

Procedural Interface

secureblackbox_archivereader_get($res, 10 , $decryptioncertindex);


secureblackbox_archivereader_set($res, 10, $value , $decryptioncertindex);

Default Value

0

Remarks

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());

The $decryptioncertindex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptionCertCount property.

This property is not available at design time.

Data Type

Long64

DecryptionPassword Property (SecureBlackbox_ArchiveReader Class)

The decryption password.

Object Oriented Interface

public function getDecryptionPassword();


public function setDecryptionPassword($value);

Procedural Interface

secureblackbox_archivereader_get($res, 37 );


secureblackbox_archivereader_set($res, 37, $value );

Default Value

''

Remarks

Use this property to provide the decryption password for the archive.

Data Type

String

FileData Property (SecureBlackbox_ArchiveReader Class)

The contents of the last extracted file.

Object Oriented Interface

public function getFileData();


public function setFileData($value);

Procedural Interface

secureblackbox_archivereader_get($res, 38 );


secureblackbox_archivereader_set($res, 38, $value );

Remarks

Use this property to get the contents of the last extracted file with DataSource set to stBuffer (2).

This property is not available at design time.

Data Type

Byte Array

FileCount Property (SecureBlackbox_ArchiveReader Class)

The number of records in the File arrays.

Object Oriented Interface

public function getFileCount();


public function setFileCount($value);

Procedural Interface

secureblackbox_archivereader_get($res, 39 );


secureblackbox_archivereader_set($res, 39, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• FileAction
• FileCompressedSize
• FileDataSource
• FileDirectory
• FileEncryptionAlgorithm
• FileEncryptionKeyLength
• FileEncryptionType
• FileFileName
• FileFolder
• FileLocalPath
• FileMTime
• FileNewFile
• FilePath
• FileSignatureCount
• FileSigned
• FileSize

The array indices start at 0 and end at FileCount - 1.

This property is not available at design time.

Data Type

Integer

FileAction Property (SecureBlackbox_ArchiveReader Class)

The action to apply to the file.

Object Oriented Interface

public function getFileAction($fileindex);


public function setFileAction($fileindex, $value);

Procedural Interface

secureblackbox_archivereader_get($res, 40 , $fileindex);


secureblackbox_archivereader_set($res, 40, $value , $fileindex);

Default Value

0

Remarks

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:

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

Integer

FileCompressedSize Property (SecureBlackbox_ArchiveReader Class)

The size of the file after compression.

Object Oriented Interface

public function getFileCompressedSize($fileindex);

Procedural Interface

secureblackbox_archivereader_get($res, 41 , $fileindex);

Default Value

0

Remarks

The size of the file after compression.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Long64

FileDataSource Property (SecureBlackbox_ArchiveReader Class)

The type of the data source for this entry.

Object Oriented Interface

public function getFileDataSource($fileindex);


public function setFileDataSource($fileindex, $value);

Procedural Interface

secureblackbox_archivereader_get($res, 42 , $fileindex);


secureblackbox_archivereader_set($res, 42, $value , $fileindex);

Default Value

0

Remarks

The type of the data source for this entry.

Use this property to control the data source for this entry.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

Integer

FileDirectory Property (SecureBlackbox_ArchiveReader Class)

Tells if the entry is a directory or a regular file.

Object Oriented Interface

public function getFileDirectory($fileindex);

Procedural Interface

secureblackbox_archivereader_get($res, 43 , $fileindex);

Default Value

false

Remarks

Tells if the entry is a directory or a regular file.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Boolean

FileEncryptionAlgorithm Property (SecureBlackbox_ArchiveReader Class)

Returns the symmetric algorithm that was used to encrypt the file.

Object Oriented Interface

public function getFileEncryptionAlgorithm($fileindex);

Procedural Interface

secureblackbox_archivereader_get($res, 44 , $fileindex);

Default Value

''

Remarks

Returns the symmetric algorithm that was used to encrypt the file.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

String

FileEncryptionKeyLength Property (SecureBlackbox_ArchiveReader Class)

Returns the length, in bits, of the encryption key.

Object Oriented Interface

public function getFileEncryptionKeyLength($fileindex);

Procedural Interface

secureblackbox_archivereader_get($res, 45 , $fileindex);

Default Value

0

Remarks

Returns the length, in bits, of the encryption key.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Integer

FileEncryptionType Property (SecureBlackbox_ArchiveReader Class)

The type of encryption applied to the file.

Object Oriented Interface

public function getFileEncryptionType($fileindex);

Procedural Interface

secureblackbox_archivereader_get($res, 46 , $fileindex);

Default Value

0

Remarks

The type of encryption applied to the file.

Use this property to find out what kind of encryption was applied to the file.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Integer

FileFileName Property (SecureBlackbox_ArchiveReader Class)

The original name of the compressed file or folder.

Object Oriented Interface

public function getFileFileName($fileindex);


public function setFileFileName($fileindex, $value);

Procedural Interface

secureblackbox_archivereader_get($res, 47 , $fileindex);


secureblackbox_archivereader_set($res, 47, $value , $fileindex);

Default Value

''

Remarks

The original name of the compressed file or folder.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

String

FileFolder Property (SecureBlackbox_ArchiveReader Class)

The containing folder of the entry.

Object Oriented Interface

public function getFileFolder($fileindex);

Procedural Interface

secureblackbox_archivereader_get($res, 48 , $fileindex);

Default Value

''

Remarks

The containing folder of the entry.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

String

FileLocalPath Property (SecureBlackbox_ArchiveReader Class)

The local path associated with this entry.

Object Oriented Interface

public function getFileLocalPath($fileindex);


public function setFileLocalPath($fileindex, $value);

Procedural Interface

secureblackbox_archivereader_get($res, 49 , $fileindex);


secureblackbox_archivereader_set($res, 49, $value , $fileindex);

Default Value

''

Remarks

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.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

String

FileMTime Property (SecureBlackbox_ArchiveReader Class)

The entry's last modification time.

Object Oriented Interface

public function getFileMTime($fileindex);


public function setFileMTime($fileindex, $value);

Procedural Interface

secureblackbox_archivereader_get($res, 50 , $fileindex);


secureblackbox_archivereader_set($res, 50, $value , $fileindex);

Default Value

''

Remarks

The entry's last modification time.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

String

FileNewFile Property (SecureBlackbox_ArchiveReader Class)

Indicates whether the entry corresponds to a file to be added to the archive.

Object Oriented Interface

public function getFileNewFile($fileindex);

Procedural Interface

secureblackbox_archivereader_get($res, 51 , $fileindex);

Default Value

false

Remarks

Indicates whether the entry corresponds to a file to be added to the archive.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Boolean

FilePath Property (SecureBlackbox_ArchiveReader Class)

The full internal path of the archived entry.

Object Oriented Interface

public function getFilePath($fileindex);

Procedural Interface

secureblackbox_archivereader_get($res, 52 , $fileindex);

Default Value

''

Remarks

The full internal path of the archived entry.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

String

FileSignatureCount Property (SecureBlackbox_ArchiveReader Class)

The number of signatures covering the entry.

Object Oriented Interface

public function getFileSignatureCount($fileindex);

Procedural Interface

secureblackbox_archivereader_get($res, 53 , $fileindex);

Default Value

0

Remarks

The number of signatures covering the entry.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Integer

FileSigned Property (SecureBlackbox_ArchiveReader Class)

Indicates whether the entry is signed.

Object Oriented Interface

public function getFileSigned($fileindex);

Procedural Interface

secureblackbox_archivereader_get($res, 54 , $fileindex);

Default Value

false

Remarks

Indicates whether the entry is signed.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Boolean

FileSize Property (SecureBlackbox_ArchiveReader Class)

The size of the file before compression.

Object Oriented Interface

public function getFileSize($fileindex);

Procedural Interface

secureblackbox_archivereader_get($res, 55 , $fileindex);

Default Value

0

Remarks

The size of the file before compression.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Long64

FIPSMode Property (SecureBlackbox_ArchiveReader Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_archivereader_get($res, 56 );


secureblackbox_archivereader_set($res, 56, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

HashAlgorithm Property (SecureBlackbox_ArchiveReader Class)

Returns the hash algorithm that was used to generate the signature.

Object Oriented Interface

public function getHashAlgorithm();

Procedural Interface

secureblackbox_archivereader_get($res, 57 );

Default Value

''

Remarks

Check this property after calling Extract to get the hash algorithm which was used to calculate the signature.

This property is read-only and not available at design time.

Data Type

String

KnownCertCount Property (SecureBlackbox_ArchiveReader Class)

The number of records in the KnownCert arrays.

Object Oriented Interface

public function getKnownCertCount();


public function setKnownCertCount($value);

Procedural Interface

secureblackbox_archivereader_get($res, 58 );


secureblackbox_archivereader_set($res, 58, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCertBytes
• KnownCertHandle

The array indices start at 0 and end at KnownCertCount - 1.

This property is not available at design time.

Data Type

Integer

KnownCertBytes Property (SecureBlackbox_ArchiveReader Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getKnownCertBytes($knowncertindex);

Procedural Interface

secureblackbox_archivereader_get($res, 59 , $knowncertindex);

Remarks

Returns the raw certificate data in DER format.

The $knowncertindex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

KnownCertHandle Property (SecureBlackbox_ArchiveReader Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getKnownCertHandle($knowncertindex);


public function setKnownCertHandle($knowncertindex, $value);

Procedural Interface

secureblackbox_archivereader_get($res, 66 , $knowncertindex);


secureblackbox_archivereader_set($res, 66, $value , $knowncertindex);

Default Value

0

Remarks

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());

The $knowncertindex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is not available at design time.

Data Type

Long64

Opened Property (SecureBlackbox_ArchiveReader Class)

Indicates if the class is in the open state.

Object Oriented Interface

public function getOpened();

Procedural Interface

secureblackbox_archivereader_get($res, 93 );

Default Value

false

Remarks

Use this property to check if the component provides access to an open archive file.

This property is read-only.

Data Type

Boolean

SignatureValidationResult Property (SecureBlackbox_ArchiveReader Class)

The signature validation result.

Object Oriented Interface

public function getSignatureValidationResult();

Procedural Interface

secureblackbox_archivereader_get($res, 94 );

Default Value

0

Remarks

Use this property to check the result of the most recent signature validation.

This property is read-only and not available at design time.

Data Type

Integer

SigningCertBytes Property (SecureBlackbox_ArchiveReader Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSigningCertBytes();

Procedural Interface

secureblackbox_archivereader_get($res, 95 );

Remarks

Returns the raw certificate data in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertCA Property (SecureBlackbox_ArchiveReader Class)

Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).

Object Oriented Interface

public function getSigningCertCA();

Procedural Interface

secureblackbox_archivereader_get($res, 96 );

Default Value

false

Remarks

Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).

This property is read-only and not available at design time.

Data Type

Boolean

SigningCertCAKeyID Property (SecureBlackbox_ArchiveReader Class)

A unique identifier (fingerprint) of the CA certificate's private key.

Object Oriented Interface

public function getSigningCertCAKeyID();

Procedural Interface

secureblackbox_archivereader_get($res, 97 );

Remarks

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.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertCRLDistributionPoints Property (SecureBlackbox_ArchiveReader Class)

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

Object Oriented Interface

public function getSigningCertCRLDistributionPoints();

Procedural Interface

secureblackbox_archivereader_get($res, 98 );

Default Value

''

Remarks

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

This property is read-only and not available at design time.

Data Type

String

SigningCertCurve Property (SecureBlackbox_ArchiveReader Class)

Specifies the elliptic curve of the EC public key.

Object Oriented Interface

public function getSigningCertCurve();

Procedural Interface

secureblackbox_archivereader_get($res, 99 );

Default Value

''

Remarks

Specifies the elliptic curve of the EC public key.

This property is read-only and not available at design time.

Data Type

String

SigningCertFingerprint Property (SecureBlackbox_ArchiveReader Class)

Contains the fingerprint (a hash imprint) of this certificate.

Object Oriented Interface

public function getSigningCertFingerprint();

Procedural Interface

secureblackbox_archivereader_get($res, 100 );

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertFriendlyName Property (SecureBlackbox_ArchiveReader Class)

Contains an associated alias (friendly name) of the certificate.

Object Oriented Interface

public function getSigningCertFriendlyName();

Procedural Interface

secureblackbox_archivereader_get($res, 101 );

Default Value

''

Remarks

Contains an associated alias (friendly name) of the certificate.

This property is read-only and not available at design time.

Data Type

String

SigningCertHandle Property (SecureBlackbox_ArchiveReader Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getSigningCertHandle();

Procedural Interface

secureblackbox_archivereader_get($res, 102 );

Default Value

0

Remarks

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());

This property is read-only and not available at design time.

Data Type

Long64

SigningCertHashAlgorithm Property (SecureBlackbox_ArchiveReader Class)

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .

Object Oriented Interface

public function getSigningCertHashAlgorithm();

Procedural Interface

secureblackbox_archivereader_get($res, 103 );

Default Value

''

Remarks

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)

This property is read-only and not available at design time.

Data Type

String

SigningCertIssuer Property (SecureBlackbox_ArchiveReader Class)

The common name of the certificate issuer (CA), typically a company name.

Object Oriented Interface

public function getSigningCertIssuer();

Procedural Interface

secureblackbox_archivereader_get($res, 104 );

Default Value

''

Remarks

The common name of the certificate issuer (CA), typically a company name.

This property is read-only and not available at design time.

Data Type

String

SigningCertIssuerRDN Property (SecureBlackbox_ArchiveReader Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

Object Oriented Interface

public function getSigningCertIssuerRDN();

Procedural Interface

secureblackbox_archivereader_get($res, 105 );

Default Value

''

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

This property is read-only and not available at design time.

Data Type

String

SigningCertKeyAlgorithm Property (SecureBlackbox_ArchiveReader Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getSigningCertKeyAlgorithm();

Procedural Interface

secureblackbox_archivereader_get($res, 106 );

Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

This property is read-only and not available at design time.

Data Type

String

SigningCertKeyBits Property (SecureBlackbox_ArchiveReader Class)

Returns the length of the public key.

Object Oriented Interface

public function getSigningCertKeyBits();

Procedural Interface

secureblackbox_archivereader_get($res, 107 );

Default Value

0

Remarks

Returns the length of the public key.

This property is read-only and not available at design time.

Data Type

Integer

SigningCertKeyFingerprint Property (SecureBlackbox_ArchiveReader Class)

Returns a fingerprint of the public key contained in the certificate.

Object Oriented Interface

public function getSigningCertKeyFingerprint();

Procedural Interface

secureblackbox_archivereader_get($res, 108 );

Remarks

Returns a fingerprint of the public key contained in the certificate.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertKeyUsage Property (SecureBlackbox_ArchiveReader Class)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Object Oriented Interface

public function getSigningCertKeyUsage();

Procedural Interface

secureblackbox_archivereader_get($res, 109 );

Default Value

0

Remarks

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:

This property is read-only and not available at design time.

Data Type

Integer

SigningCertKeyValid Property (SecureBlackbox_ArchiveReader Class)

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Object Oriented Interface

public function getSigningCertKeyValid();

Procedural Interface

secureblackbox_archivereader_get($res, 110 );

Default Value

false

Remarks

Returns True if the certificate's key is cryptographically valid, and False otherwise.

This property is read-only and not available at design time.

Data Type

Boolean

SigningCertOCSPLocations Property (SecureBlackbox_ArchiveReader Class)

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

Object Oriented Interface

public function getSigningCertOCSPLocations();

Procedural Interface

secureblackbox_archivereader_get($res, 111 );

Default Value

''

Remarks

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

This property is read-only and not available at design time.

Data Type

String

SigningCertPolicyIDs Property (SecureBlackbox_ArchiveReader Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getSigningCertPolicyIDs();

Procedural Interface

secureblackbox_archivereader_get($res, 114 );

Default Value

''

Remarks

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.

This property is read-only and not available at design time.

Data Type

String

SigningCertPublicKeyBytes Property (SecureBlackbox_ArchiveReader Class)

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getSigningCertPublicKeyBytes();

Procedural Interface

secureblackbox_archivereader_get($res, 118 );

Remarks

Contains the certificate's public key in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertSelfSigned Property (SecureBlackbox_ArchiveReader Class)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Object Oriented Interface

public function getSigningCertSelfSigned();

Procedural Interface

secureblackbox_archivereader_get($res, 120 );

Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

This property is read-only and not available at design time.

Data Type

Boolean

SigningCertSerialNumber Property (SecureBlackbox_ArchiveReader Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getSigningCertSerialNumber();

Procedural Interface

secureblackbox_archivereader_get($res, 121 );

Remarks

Returns the certificate's serial number.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertSigAlgorithm Property (SecureBlackbox_ArchiveReader Class)

Indicates the algorithm that was used by the CA to sign this certificate.

Object Oriented Interface

public function getSigningCertSigAlgorithm();

Procedural Interface

secureblackbox_archivereader_get($res, 122 );

Default Value

''

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

This property is read-only and not available at design time.

Data Type

String

SigningCertSubject Property (SecureBlackbox_ArchiveReader Class)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Object Oriented Interface

public function getSigningCertSubject();

Procedural Interface

secureblackbox_archivereader_get($res, 123 );

Default Value

''

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

This property is read-only and not available at design time.

Data Type

String

SigningCertSubjectKeyID Property (SecureBlackbox_ArchiveReader Class)

Contains a unique identifier (fingerprint) of the certificate's private key.

Object Oriented Interface

public function getSigningCertSubjectKeyID();

Procedural Interface

secureblackbox_archivereader_get($res, 125 );

Remarks

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.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertSubjectRDN Property (SecureBlackbox_ArchiveReader Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Object Oriented Interface

public function getSigningCertSubjectRDN();

Procedural Interface

secureblackbox_archivereader_get($res, 126 );

Default Value

''

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

This property is read-only and not available at design time.

Data Type

String

SigningCertValidFrom Property (SecureBlackbox_ArchiveReader Class)

The time point at which the certificate becomes valid, in UTC.

Object Oriented Interface

public function getSigningCertValidFrom();

Procedural Interface

secureblackbox_archivereader_get($res, 127 );

Default Value

''

Remarks

The time point at which the certificate becomes valid, in UTC.

This property is read-only and not available at design time.

Data Type

String

SigningCertValidTo Property (SecureBlackbox_ArchiveReader Class)

The time point at which the certificate expires, in UTC.

Object Oriented Interface

public function getSigningCertValidTo();

Procedural Interface

secureblackbox_archivereader_get($res, 128 );

Default Value

''

Remarks

The time point at which the certificate expires, in UTC.

This property is read-only and not available at design time.

Data Type

String

Close Method (SecureBlackbox_ArchiveReader Class)

Closes the current archive.

Object Oriented Interface

public function doClose();

Procedural Interface

secureblackbox_archivereader_do_close($res);

Remarks

Use this method to close the archive that is currently opened and release the associated memory. You won't be able to extract files or access the archive details after closing the archive.

Config Method (SecureBlackbox_ArchiveReader Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_archivereader_do_config($res, $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 (SecureBlackbox_ArchiveReader Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_archivereader_do_doaction($res, $actionid, $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 (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;....

Extract Method (SecureBlackbox_ArchiveReader Class)

Extracts a single file from the archive.

Object Oriented Interface

public function doExtract($path, $localpath, $preservefullpath);

Procedural Interface

secureblackbox_archivereader_do_extract($res, $path, $localpath, $preservefullpath);

Remarks

Use this method to extract a single file from the archive.

Pass the internal path to the entry in the archive via the Path parameter, and the path where to save the extracted entry via the LocalPath parameter. Set PreserveFullPath to true to enforce full-path extraction, in which case LocalPath would indicate the mount point at which the full Path needs to be rooted. If PreserveFullPath is false, the LocalPath provides the final location for the extracted file.

Use ExtractAll to extract all files at once.

ExtractAll Method (SecureBlackbox_ArchiveReader Class)

Extract all the files contained in the archive.

Object Oriented Interface

public function doExtractAll($outputpath, $overwriteexisting);

Procedural Interface

secureblackbox_archivereader_do_extractall($res, $outputpath, $overwriteexisting);

Remarks

Use this method to extract all the files contained in the archive file. Pass the path where the extracted files should be saved via the OutputPath parameter. Existing files will be overwritten if the OverwriteExisting parameter is set to true.

You can cherry-pick the files to extract, as well as choose different extraction destinations (including files at custom locations, streams, or memory buffers) by subscribing to BeforeExtractFile and AfterExtractFile events.

Use Extract to extract a single file.

Open Method (SecureBlackbox_ArchiveReader Class)

Opens an archive file.

Object Oriented Interface

public function doOpen($archivetype, $archivepath);

Procedural Interface

secureblackbox_archivereader_do_open($res, $archivetype, $archivepath);

Remarks

Call this method to open an archive file. Provide the archive type via the ArchiveType parameter, and the path via the ArchivePath parameter.

The following archive types (formats) are supported:

OpenBytes Method (SecureBlackbox_ArchiveReader Class)

Loads an archive file from a byte array.

Object Oriented Interface

public function doOpenBytes($archivetype, $archivebytes);

Procedural Interface

secureblackbox_archivereader_do_openbytes($res, $archivetype, $archivebytes);

Remarks

Call this method to load an archive file from a byte array. Provide the archive type via the ArchiveType parameter, and the byte array containing the archive data via the ArchiveBytes parameter.

The following archive types (formats) are supported:

AfterExtractFile Event (SecureBlackbox_ArchiveReader Class)

Marks the completion of extraction of an archived file.

Object Oriented Interface

public function fireAfterExtractFile($param);

Procedural Interface

secureblackbox_archivereader_register_callback($res, 1, array($this, 'fireAfterExtractFile'));

Parameter List

 'path'
 'filesize'
 'datasource'

Remarks

Subscribe to this event to get notified about the completion of extraction of an archived file.

The Path parameter specifies the internal path to the entry inside the archive. The FileSize indicates the size of the decompressed file, and the DataSource specifies the type of the destination media.

BeforeExtractFile Event (SecureBlackbox_ArchiveReader Class)

Marks the start of extraction of an archived file.

Object Oriented Interface

public function fireBeforeExtractFile($param);

Procedural Interface

secureblackbox_archivereader_register_callback($res, 2, array($this, 'fireBeforeExtractFile'));

Parameter List

 'path'
 'filesize'
 'datasource'
 'extractionpath'
 'skip'

Remarks

Subscribe to this event to be notified about the start of extraction of an archived entry. The handler of this event is a good place to tune up the destination media.

The Path parameter indicates the path to the extracted entry in the archive. The FileSize specifies the uncompressed size of the file. Set the by-reference DataSource parameter in accordance with the desired extraction media type:

If saving to a stream or buffer, use AfterExtractFile to collect the extracted data from FileStream or FileData, and dispose of any objects allocated in this event handler (such as the output stream).

Use the Skip parameter to cancel extraction of this file and proceed to the next one.

DecryptionPasswordNeeded Event (SecureBlackbox_ArchiveReader Class)

Requests a decryption password, when needed.

Object Oriented Interface

public function fireDecryptionPasswordNeeded($param);

Procedural Interface

secureblackbox_archivereader_register_callback($res, 3, array($this, 'fireDecryptionPasswordNeeded'));

Parameter List

 'passwordtarget'
 'cancel'

Remarks

Class fires this event when it needs a password to decrypt the archive. Subscribe to this event if you expect to process encrypted archives.

Inside the event handler, please assign the correct password to DecryptionPassword property, or set Cancel parameter to true to terminate the processing.

Error Event (SecureBlackbox_ArchiveReader Class)

Reports information about errors during archive processing.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_archivereader_register_callback($res, 4, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The event is fired in case of exceptional conditions during archive processing.

ErrorCode contains an error code and Description contains a textual description of the error.

Notification Event (SecureBlackbox_ArchiveReader Class)

This event notifies the application about an underlying control flow event.

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_archivereader_register_callback($res, 5, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. 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 class, the exact action it is performing, or the document being processed, one or both may be omitted.

Progress Event (SecureBlackbox_ArchiveReader Class)

Reports the progress of data extraction.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

secureblackbox_archivereader_register_callback($res, 6, array($this, 'fireProgress'));

Parameter List

 'processed'
 'total'
 'overallprocessed'
 'overalltotal'
 'cancel'

Remarks

Subscribe to this event to be notified about decompression progress.

Processed and Total report the progress of extraction of the current entry; OverallProcessed and OverallTotal report the progress of the whole operation. Set Cancel to true to stop the operation.

RecipientFound Event (SecureBlackbox_ArchiveReader Class)

Informs the application that an archive is encrypted with a digital certificate.

Object Oriented Interface

public function fireRecipientFound($param);

Procedural Interface

secureblackbox_archivereader_register_callback($res, 7, array($this, 'fireRecipientFound'));

Parameter List

 'recipienthash'
 'certfound'

Remarks

The class fires this event when processing archives encrypted with an X.509 certificate. CertFound indicates whether the matching certificate has been found in DecryptionCertificates collection.

This event is an opportunity to add the decryption certificate on a later stage if it was not known at the start of the processing.

SignatureFound Event (SecureBlackbox_ArchiveReader Class)

Signifies the start of signature validation.

Object Oriented Interface

public function fireSignatureFound($param);

Procedural Interface

secureblackbox_archivereader_register_callback($res, 8, array($this, 'fireSignatureFound'));

Parameter List

 'issuerrdn'
 'serialnumber'
 'subjectkeyid'
 'certfound'
 'validatesignature'
 '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 parameter 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 the KnownCertificates property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the and properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

Config Settings (ArchiveReader Class)

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.

ArchiveReader Config Settings

Base Config Settings

Trappable Errors (ArchiveReader Class)