pdf-lite 1.0.0 → 1.0.1-alpha.2

package/docs/crypto/key-derivation/key-derivation/functions/deriveObjectKey.md

@@ -0,0 +1,50 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [crypto/key-derivation/key-derivation](../README.md) / deriveObjectKey
+
+# Function: deriveObjectKey()
+
+> **deriveObjectKey**(`mkey`, `objNumber`, `objGeneration`, `useAesSalt`): `Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+Derives an object-specific encryption key from the master key.
+Used to encrypt individual PDF objects with unique keys.
+
+## Parameters
+
+### mkey
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The master encryption key.
+
+### objNumber
+
+`number`
+
+The PDF object number.
+
+### objGeneration
+
+`number`
+
+The PDF object generation number.
+
+### useAesSalt
+
+`boolean` = `true`
+
+Whether to include the AES salt ('sAlT'). Defaults to true.
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to the derived object key.
+
+## Example
+
+```typescript
+const objectKey = await deriveObjectKey(masterKey, 5, 0)
+```

package/docs/crypto/key-derivation/key-derivation/functions/padPassword.md

@@ -0,0 +1,33 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [crypto/key-derivation/key-derivation](../README.md) / padPassword
+
+# Function: padPassword()
+
+> **padPassword**(`password`): [`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+Pads a password to exactly 32 bytes using the PDF standard padding.
+If the password is shorter than 32 bytes, it is padded with bytes from DEFAULT_PADDING.
+If the password is 32 bytes or longer, only the first 32 bytes are used.
+
+## Parameters
+
+### password
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The password to pad.
+
+## Returns
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+A 32-byte padded password.
+
+## Example
+
+```typescript
+const padded = padPassword(new Uint8Array([1, 2, 3])) // Returns 32-byte array
+```

package/docs/crypto/key-derivation/key-derivation-aes256/README.md

@@ -0,0 +1,13 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / crypto/key-derivation/key-derivation-aes256
+
+# crypto/key-derivation/key-derivation-aes256
+
+## Functions
+
+- [computeAlgorithm2bHash](functions/computeAlgorithm2bHash.md)
+- [getFileKey](functions/getFileKey.md)
+- [validatePasswordHash](functions/validatePasswordHash.md)

package/docs/crypto/key-derivation/key-derivation-aes256/functions/computeAlgorithm2bHash.md

@@ -0,0 +1,45 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [crypto/key-derivation/key-derivation-aes256](../README.md) / computeAlgorithm2bHash
+
+# Function: computeAlgorithm2bHash()
+
+> **computeAlgorithm2bHash**(`password`, `salt`, `userKey`): `Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+Computes the Algorithm 2.B hash for PDF 2.0 AES-256 encryption.
+This iterative hash algorithm uses SHA-256, SHA-384, or SHA-512 based on
+intermediate results, running for at least 64 rounds.
+
+## Parameters
+
+### password
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The user or owner password.
+
+### salt
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The 8-byte validation or key salt.
+
+### userKey
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md) = `...`
+
+The user key (required for owner password validation). Defaults to empty.
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to a 32-byte hash.
+
+## Example
+
+```typescript
+const hash = await computeAlgorithm2bHash(password, salt)
+```

package/docs/crypto/key-derivation/key-derivation-aes256/functions/getFileKey.md

@@ -0,0 +1,66 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [crypto/key-derivation/key-derivation-aes256](../README.md) / getFileKey
+
+# Function: getFileKey()
+
+> **getFileKey**(`userPassword`, `ownerPassword`, `u`, `ue`, `o`, `oe`): `Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+Retrieves the file encryption key using user or owner password.
+Tries owner password first, then falls back to user password.
+
+## Parameters
+
+### userPassword
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The user password to try.
+
+### ownerPassword
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The owner password to try.
+
+### u
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The 48-byte /U value from the encryption dictionary.
+
+### ue
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The 32-byte /UE value (encrypted user key).
+
+### o
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The 48-byte /O value from the encryption dictionary.
+
+### oe
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The 32-byte /OE value (encrypted owner key).
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to the 32-byte file encryption key.
+
+## Throws
+
+Error if both passwords are invalid.
+
+## Example
+
+```typescript
+const fileKey = await getFileKey(userPw, ownerPw, U, UE, O, OE)
+```

package/docs/crypto/key-derivation/key-derivation-aes256/functions/validatePasswordHash.md

@@ -0,0 +1,52 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [crypto/key-derivation/key-derivation-aes256](../README.md) / validatePasswordHash
+
+# Function: validatePasswordHash()
+
+> **validatePasswordHash**(`password`, `key`, `extra?`): `Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+Validates a password against a stored hash using the Algorithm 2.B hash.
+
+## Parameters
+
+### password
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The password to validate.
+
+### key
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The stored key containing the hash (first 32 bytes) and validation salt (bytes 32-40).
+
+### extra?
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+Extra data for owner password validation (user key).
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to the computed hash if validation succeeds.
+
+## Throws
+
+Error if the password is invalid or salt/hash lengths are incorrect.
+
+## Example
+
+```typescript
+try {
+    await validatePasswordHash(password, storedKey)
+    console.log('Password is valid')
+} catch (e) {
+    console.log('Invalid password')
+}
+```

package/docs/crypto/key-gen/key-gen-aes256/README.md

@@ -0,0 +1,12 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / crypto/key-gen/key-gen-aes256
+
+# crypto/key-gen/key-gen-aes256
+
+## Functions
+
+- [generateOandOe](functions/generateOandOe.md)
+- [generateUandUe](functions/generateUandUe.md)

package/docs/crypto/key-gen/key-gen-aes256/functions/generateOandOe.md

@@ -0,0 +1,44 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [crypto/key-gen/key-gen-aes256](../README.md) / generateOandOe
+
+# Function: generateOandOe()
+
+> **generateOandOe**(`password`, `U`, `fileKey`): `Promise`\<\{ `O`: [`ByteArray`](../../../../types/type-aliases/ByteArray.md); `OE`: [`ByteArray`](../../../../types/type-aliases/ByteArray.md); \}\>
+
+Generates the /O and /OE values for AES-256 PDF encryption.
+These values are used to validate the owner password and decrypt the file key.
+
+## Parameters
+
+### password
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The owner password.
+
+### U
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The 48-byte /U value (required for owner key derivation).
+
+### fileKey
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The 32-byte file encryption key.
+
+## Returns
+
+`Promise`\<\{ `O`: [`ByteArray`](../../../../types/type-aliases/ByteArray.md); `OE`: [`ByteArray`](../../../../types/type-aliases/ByteArray.md); \}\>
+
+A promise that resolves to an object containing the 48-byte O and 32-byte OE values.
+
+## Example
+
+```typescript
+const { O, OE } = await generateOandOe(ownerPassword, U, fileKey)
+```

package/docs/crypto/key-gen/key-gen-aes256/functions/generateUandUe.md

@@ -0,0 +1,38 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [crypto/key-gen/key-gen-aes256](../README.md) / generateUandUe
+
+# Function: generateUandUe()
+
+> **generateUandUe**(`password`, `fileKey`): `Promise`\<\{ `U`: [`ByteArray`](../../../../types/type-aliases/ByteArray.md); `UE`: [`ByteArray`](../../../../types/type-aliases/ByteArray.md); \}\>
+
+Generates the /U and /UE values for AES-256 PDF encryption.
+These values are used to validate the user password and decrypt the file key.
+
+## Parameters
+
+### password
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The user password.
+
+### fileKey
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The 32-byte file encryption key.
+
+## Returns
+
+`Promise`\<\{ `U`: [`ByteArray`](../../../../types/type-aliases/ByteArray.md); `UE`: [`ByteArray`](../../../../types/type-aliases/ByteArray.md); \}\>
+
+A promise that resolves to an object containing the 48-byte U and 32-byte UE values.
+
+## Example
+
+```typescript
+const { U, UE } = await generateUandUe(password, fileKey)
+```

package/docs/crypto/key-gen/key-gen-rc4-128/README.md

@@ -0,0 +1,13 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / crypto/key-gen/key-gen-rc4-128
+
+# crypto/key-gen/key-gen-rc4-128
+
+## Functions
+
+- [computeOValueRc4_128](functions/computeOValueRc4_128.md)
+- [computeUValueRc4_128](functions/computeUValueRc4_128.md)
+- [decryptUserPasswordRc4_128](functions/decryptUserPasswordRc4_128.md)

package/docs/crypto/key-gen/key-gen-rc4-128/functions/computeOValueRc4_128.md

@@ -0,0 +1,38 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [crypto/key-gen/key-gen-rc4-128](../README.md) / computeOValueRc4_128
+
+# Function: computeOValueRc4_128()
+
+> **computeOValueRc4_128**(`ownerPassword`, `userPassword`): `Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+Computes the /O value for RC4-128 PDF encryption.
+The /O value is used to verify the owner password.
+
+## Parameters
+
+### ownerPassword
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The owner password.
+
+### userPassword
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The user password.
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to the 32-byte /O value.
+
+## Example
+
+```typescript
+const O = await computeOValueRc4_128(ownerPassword, userPassword)
+```

package/docs/crypto/key-gen/key-gen-rc4-128/functions/computeUValueRc4_128.md

@@ -0,0 +1,62 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [crypto/key-gen/key-gen-rc4-128](../README.md) / computeUValueRc4_128
+
+# Function: computeUValueRc4_128()
+
+> **computeUValueRc4_128**(`userPassword`, `oValue`, `permissions`, `id`, `encryptMetadata`, `revision?`): `Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+Computes the /U value for RC4-128 PDF encryption.
+The /U value is used to verify the user password.
+
+## Parameters
+
+### userPassword
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The user password.
+
+### oValue
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The /O value.
+
+### permissions
+
+`number`
+
+The /P value (permissions flags).
+
+### id
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The first element of the /ID array.
+
+### encryptMetadata
+
+`boolean`
+
+Whether to encrypt metadata.
+
+### revision?
+
+`number`
+
+The encryption revision number.
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to the 32-byte /U value.
+
+## Example
+
+```typescript
+const U = await computeUValueRc4_128(userPassword, O, permissions, fileId, true)
+```

package/docs/crypto/key-gen/key-gen-rc4-128/functions/decryptUserPasswordRc4_128.md

@@ -0,0 +1,38 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [crypto/key-gen/key-gen-rc4-128](../README.md) / decryptUserPasswordRc4_128
+
+# Function: decryptUserPasswordRc4_128()
+
+> **decryptUserPasswordRc4_128**(`ownerPw`, `ownerKey`): `Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+Decrypts the user password from the /O value using RC4-128.
+Used to recover the user password when the owner password is known.
+
+## Parameters
+
+### ownerPw
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The owner password.
+
+### ownerKey
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The /O value from the encryption dictionary.
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to the decrypted user password (with padding removed).
+
+## Example
+
+```typescript
+const userPassword = await decryptUserPasswordRc4_128(ownerPw, O)
+```

package/docs/crypto/key-gen/key-gen-rc4-40/README.md

@@ -0,0 +1,14 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / crypto/key-gen/key-gen-rc4-40
+
+# crypto/key-gen/key-gen-rc4-40
+
+## Functions
+
+- [computeEncryptionKeyRc4_40](functions/computeEncryptionKeyRc4_40.md)
+- [computeORc4_40](functions/computeORc4_40.md)
+- [computeURc4_40](functions/computeURc4_40.md)
+- [decryptUserPasswordRc4_40](functions/decryptUserPasswordRc4_40.md)

package/docs/crypto/key-gen/key-gen-rc4-40/functions/computeEncryptionKeyRc4_40.md

@@ -0,0 +1,49 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [crypto/key-gen/key-gen-rc4-40](../README.md) / computeEncryptionKeyRc4_40
+
+# Function: computeEncryptionKeyRc4_40()
+
+> **computeEncryptionKeyRc4_40**(`userPw`, `oValue`, `permissions`, `fileId`): `Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+Computes the 40-bit encryption key for RC4-40 PDF encryption.
+
+## Parameters
+
+### userPw
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The user password.
+
+### oValue
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The /O value.
+
+### permissions
+
+`number`
+
+The /P value (permissions flags).
+
+### fileId
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The first element of the /ID array.
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to the 5-byte (40-bit) encryption key.
+
+## Example
+
+```typescript
+const key = await computeEncryptionKeyRc4_40(userPw, O, permissions, fileId)
+```

package/docs/crypto/key-gen/key-gen-rc4-40/functions/computeORc4_40.md

@@ -0,0 +1,38 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [crypto/key-gen/key-gen-rc4-40](../README.md) / computeORc4_40
+
+# Function: computeORc4_40()
+
+> **computeORc4_40**(`ownerPw`, `userPw`): `Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+Computes the /O value for RC4-40 PDF encryption.
+The /O value is used to verify the owner password.
+
+## Parameters
+
+### ownerPw
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The owner password.
+
+### userPw
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The user password.
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to the 32-byte /O value.
+
+## Example
+
+```typescript
+const O = await computeORc4_40(ownerPassword, userPassword)
+```

package/docs/crypto/key-gen/key-gen-rc4-40/functions/computeURc4_40.md

@@ -0,0 +1,50 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [crypto/key-gen/key-gen-rc4-40](../README.md) / computeURc4_40
+
+# Function: computeURc4_40()
+
+> **computeURc4_40**(`userPw`, `oValue`, `permissions`, `fileId`): `Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+Computes the /U value for RC4-40 PDF encryption.
+The /U value is used to verify the user password.
+
+## Parameters
+
+### userPw
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The user password.
+
+### oValue
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The /O value.
+
+### permissions
+
+`number`
+
+The /P value (permissions flags).
+
+### fileId
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The first element of the /ID array.
+
+## Returns
+
+`Promise`\<[`ByteArray`](../../../../types/type-aliases/ByteArray.md)\>
+
+A promise that resolves to the 32-byte /U value.
+
+## Example
+
+```typescript
+const U = await computeURc4_40(userPassword, O, permissions, fileId)
+```