pdf-lite 1.0.0 → 1.0.1-alpha.2

package/docs/security/crypt-filters/aesv3/classes/AesV3CryptFilter.md

@@ -0,0 +1,275 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [security/crypt-filters/aesv3](../README.md) / AesV3CryptFilter
+
+# Class: AesV3CryptFilter
+
+AESV3 crypt filter using AES-256-CBC encryption.
+Implements 256-bit AES encryption in CBC mode for PDF content.
+This is the recommended encryption method for new documents.
+
+## Example
+
+```typescript
+const filter = new AesV3CryptFilter({
+    authEvent: 'DocOpen',
+    securityHandler,
+})
+const encrypted = await filter.encrypt(data, objectNumber, generationNumber)
+```
+
+## Extends
+
+- [`PdfCryptFilter`](../../base/classes/PdfCryptFilter.md)
+
+## Constructors
+
+### Constructor
+
+> **new AesV3CryptFilter**(`options`): `AesV3CryptFilter`
+
+Creates a new AES-256 crypt filter.
+
+#### Parameters
+
+##### options
+
+Configuration options with authentication event and security handler.
+
+###### authEvent
+
+`"DocOpen"` \| `"EFOpen"`
+
+###### securityHandler?
+
+[`PdfSecurityHandler`](../../../handlers/base/classes/PdfSecurityHandler.md)
+
+#### Returns
+
+`AesV3CryptFilter`
+
+#### Overrides
+
+[`PdfCryptFilter`](../../base/classes/PdfCryptFilter.md).[`constructor`](../../base/classes/PdfCryptFilter.md#constructor)
+
+## Properties
+
+### authEvent
+
+> **authEvent**: `"DocOpen"` \| `"EFOpen"`
+
+Authentication event trigger.
+
+#### Inherited from
+
+[`PdfCryptFilter`](../../base/classes/PdfCryptFilter.md).[`authEvent`](../../base/classes/PdfCryptFilter.md#authevent)
+
+---
+
+### cfm
+
+> **cfm**: `"None"` \| `"V2"` \| `"AESV2"` \| `"AESV3"`
+
+Crypt filter method identifier.
+
+#### Inherited from
+
+[`PdfCryptFilter`](../../base/classes/PdfCryptFilter.md).[`cfm`](../../base/classes/PdfCryptFilter.md#cfm)
+
+---
+
+### length
+
+> **length**: `number`
+
+Key length in bits.
+
+#### Inherited from
+
+[`PdfCryptFilter`](../../base/classes/PdfCryptFilter.md).[`length`](../../base/classes/PdfCryptFilter.md#length)
+
+---
+
+### securityHandler?
+
+> `protected` `optional` **securityHandler**: [`PdfSecurityHandler`](../../../handlers/base/classes/PdfSecurityHandler.md)
+
+Security handler for cryptographic operations.
+
+#### Inherited from
+
+[`PdfCryptFilter`](../../base/classes/PdfCryptFilter.md).[`securityHandler`](../../base/classes/PdfCryptFilter.md#securityhandler)
+
+## Methods
+
+### decrypt()
+
+> **decrypt**(`data`, `objectNumber?`, `generationNumber?`): `Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+Decrypts data using this crypt filter.
+
+#### Parameters
+
+##### data
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The data to decrypt.
+
+##### objectNumber?
+
+`number`
+
+The PDF object number for key derivation.
+
+##### generationNumber?
+
+`number`
+
+The PDF generation number for key derivation.
+
+#### Returns
+
+`Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+The decrypted data.
+
+#### Inherited from
+
+[`PdfCryptFilter`](../../base/classes/PdfCryptFilter.md).[`decrypt`](../../base/classes/PdfCryptFilter.md#decrypt)
+
+---
+
+### encrypt()
+
+> **encrypt**(`data`, `objectNumber?`, `generationNumber?`): `Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+Encrypts data using this crypt filter.
+
+#### Parameters
+
+##### data
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The data to encrypt.
+
+##### objectNumber?
+
+`number`
+
+The PDF object number for key derivation.
+
+##### generationNumber?
+
+`number`
+
+The PDF generation number for key derivation.
+
+#### Returns
+
+`Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+The encrypted data.
+
+#### Inherited from
+
+[`PdfCryptFilter`](../../base/classes/PdfCryptFilter.md).[`encrypt`](../../base/classes/PdfCryptFilter.md#encrypt)
+
+---
+
+### getCipher()
+
+> **getCipher**(`objectNumber?`, `generationNumber?`): `Promise`\<[`Cipher`](../../../../crypto/types/interfaces/Cipher.md)\>
+
+Gets an AES-256 cipher for encryption/decryption.
+
+#### Parameters
+
+##### objectNumber?
+
+`number`
+
+The PDF object number (unused for AESV3).
+
+##### generationNumber?
+
+`number`
+
+The PDF generation number (unused for AESV3).
+
+#### Returns
+
+`Promise`\<[`Cipher`](../../../../crypto/types/interfaces/Cipher.md)\>
+
+An AES-256 cipher instance.
+
+#### Throws
+
+Error if security handler is not set.
+
+#### Overrides
+
+[`PdfCryptFilter`](../../base/classes/PdfCryptFilter.md).[`getCipher`](../../base/classes/PdfCryptFilter.md#getcipher)
+
+---
+
+### getSecurityHandler()
+
+> **getSecurityHandler**(): [`PdfSecurityHandler`](../../../handlers/base/classes/PdfSecurityHandler.md) \| `undefined`
+
+Gets the current security handler.
+
+#### Returns
+
+[`PdfSecurityHandler`](../../../handlers/base/classes/PdfSecurityHandler.md) \| `undefined`
+
+The security handler, or undefined if not set.
+
+#### Inherited from
+
+[`PdfCryptFilter`](../../base/classes/PdfCryptFilter.md).[`getSecurityHandler`](../../base/classes/PdfCryptFilter.md#getsecurityhandler)
+
+---
+
+### setSecurityHandler()
+
+> **setSecurityHandler**(`handler`): `void`
+
+Sets the security handler for this crypt filter.
+
+#### Parameters
+
+##### handler
+
+[`PdfSecurityHandler`](../../../handlers/base/classes/PdfSecurityHandler.md)
+
+The security handler to use for key derivation.
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`PdfCryptFilter`](../../base/classes/PdfCryptFilter.md).[`setSecurityHandler`](../../base/classes/PdfCryptFilter.md#setsecurityhandler)
+
+---
+
+### toDictionary()
+
+> **toDictionary**(): [`PdfCryptFilterDictionary`](../../../types/type-aliases/PdfCryptFilterDictionary.md)
+
+Converts this crypt filter to a PDF dictionary representation.
+
+#### Returns
+
+[`PdfCryptFilterDictionary`](../../../types/type-aliases/PdfCryptFilterDictionary.md)
+
+The crypt filter dictionary.
+
+#### Inherited from
+
+[`PdfCryptFilter`](../../base/classes/PdfCryptFilter.md).[`toDictionary`](../../base/classes/PdfCryptFilter.md#todictionary)

package/docs/security/crypt-filters/base/README.md

@@ -0,0 +1,15 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / security/crypt-filters/base
+
+# security/crypt-filters/base
+
+## Classes
+
+- [PdfCryptFilter](classes/PdfCryptFilter.md)
+
+## Type Aliases
+
+- [CryptFilterOptions](type-aliases/CryptFilterOptions.md)

package/docs/security/crypt-filters/base/classes/PdfCryptFilter.md

@@ -0,0 +1,221 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [security/crypt-filters/base](../README.md) / PdfCryptFilter
+
+# Abstract Class: PdfCryptFilter
+
+Abstract base class for PDF crypt filters.
+Crypt filters define how specific types of data (strings, streams, files) are encrypted.
+
+## Example
+
+```typescript
+const filter = new AesV2CryptFilter({ authEvent: 'DocOpen' })
+filter.setSecurityHandler(securityHandler)
+const encrypted = await filter.encrypt(data, objectNumber, generationNumber)
+```
+
+## Extended by
+
+- [`AesV2CryptFilter`](../../aesv2/classes/AesV2CryptFilter.md)
+- [`AesV3CryptFilter`](../../aesv3/classes/AesV3CryptFilter.md)
+- [`IdentityCryptFilter`](../../identity/classes/IdentityCryptFilter.md)
+- [`V2CryptFilter`](../../v2/classes/V2CryptFilter.md)
+
+## Constructors
+
+### Constructor
+
+> **new PdfCryptFilter**(`options`): `PdfCryptFilter`
+
+Creates a new crypt filter with the specified options.
+
+#### Parameters
+
+##### options
+
+[`CryptFilterOptions`](../type-aliases/CryptFilterOptions.md)
+
+Configuration options for the crypt filter.
+
+#### Returns
+
+`PdfCryptFilter`
+
+## Properties
+
+### authEvent
+
+> **authEvent**: `"DocOpen"` \| `"EFOpen"`
+
+Authentication event trigger.
+
+---
+
+### cfm
+
+> **cfm**: `"None"` \| `"V2"` \| `"AESV2"` \| `"AESV3"`
+
+Crypt filter method identifier.
+
+---
+
+### length
+
+> **length**: `number`
+
+Key length in bits.
+
+---
+
+### securityHandler?
+
+> `protected` `optional` **securityHandler**: [`PdfSecurityHandler`](../../../handlers/base/classes/PdfSecurityHandler.md)
+
+Security handler for cryptographic operations.
+
+## Methods
+
+### decrypt()
+
+> **decrypt**(`data`, `objectNumber?`, `generationNumber?`): `Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+Decrypts data using this crypt filter.
+
+#### Parameters
+
+##### data
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The data to decrypt.
+
+##### objectNumber?
+
+`number`
+
+The PDF object number for key derivation.
+
+##### generationNumber?
+
+`number`
+
+The PDF generation number for key derivation.
+
+#### Returns
+
+`Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+The decrypted data.
+
+---
+
+### encrypt()
+
+> **encrypt**(`data`, `objectNumber?`, `generationNumber?`): `Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+Encrypts data using this crypt filter.
+
+#### Parameters
+
+##### data
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The data to encrypt.
+
+##### objectNumber?
+
+`number`
+
+The PDF object number for key derivation.
+
+##### generationNumber?
+
+`number`
+
+The PDF generation number for key derivation.
+
+#### Returns
+
+`Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+The encrypted data.
+
+---
+
+### getCipher()
+
+> `abstract` **getCipher**(`objectNumber?`, `generationNumber?`): `Promise`\<[`Cipher`](../../../../crypto/types/interfaces/Cipher.md)\>
+
+Gets a cipher instance for encrypting/decrypting data.
+
+#### Parameters
+
+##### objectNumber?
+
+`number`
+
+The PDF object number for key derivation.
+
+##### generationNumber?
+
+`number`
+
+The PDF generation number for key derivation.
+
+#### Returns
+
+`Promise`\<[`Cipher`](../../../../crypto/types/interfaces/Cipher.md)\>
+
+A cipher instance for encryption/decryption operations.
+
+---
+
+### getSecurityHandler()
+
+> **getSecurityHandler**(): [`PdfSecurityHandler`](../../../handlers/base/classes/PdfSecurityHandler.md) \| `undefined`
+
+Gets the current security handler.
+
+#### Returns
+
+[`PdfSecurityHandler`](../../../handlers/base/classes/PdfSecurityHandler.md) \| `undefined`
+
+The security handler, or undefined if not set.
+
+---
+
+### setSecurityHandler()
+
+> **setSecurityHandler**(`handler`): `void`
+
+Sets the security handler for this crypt filter.
+
+#### Parameters
+
+##### handler
+
+[`PdfSecurityHandler`](../../../handlers/base/classes/PdfSecurityHandler.md)
+
+The security handler to use for key derivation.
+
+#### Returns
+
+`void`
+
+---
+
+### toDictionary()
+
+> **toDictionary**(): [`PdfCryptFilterDictionary`](../../../types/type-aliases/PdfCryptFilterDictionary.md)
+
+Converts this crypt filter to a PDF dictionary representation.
+
+#### Returns
+
+[`PdfCryptFilterDictionary`](../../../types/type-aliases/PdfCryptFilterDictionary.md)
+
+The crypt filter dictionary.

package/docs/security/crypt-filters/base/type-aliases/CryptFilterOptions.md

@@ -0,0 +1,43 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [security/crypt-filters/base](../README.md) / CryptFilterOptions
+
+# Type Alias: CryptFilterOptions
+
+> **CryptFilterOptions** = `object`
+
+Configuration options for creating a crypt filter.
+
+## Properties
+
+### authEvent
+
+> **authEvent**: `"DocOpen"` \| `"EFOpen"`
+
+Event that triggers authentication: 'DocOpen' or 'EFOpen' (embedded file open).
+
+---
+
+### cfm
+
+> **cfm**: `"None"` \| `"V2"` \| `"AESV2"` \| `"AESV3"`
+
+Crypt filter method: 'None' (identity), 'V2' (RC4), 'AESV2' (AES-128), or 'AESV3' (AES-256).
+
+---
+
+### length?
+
+> `optional` **length**: `number`
+
+Key length in bits.
+
+---
+
+### securityHandler?
+
+> `optional` **securityHandler**: [`PdfSecurityHandler`](../../../handlers/base/classes/PdfSecurityHandler.md)
+
+Security handler for key derivation and encryption operations.

package/docs/security/crypt-filters/identity/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / security/crypt-filters/identity
+
+# security/crypt-filters/identity
+
+## Classes
+
+- [IdentityCryptFilter](classes/IdentityCryptFilter.md)