added composer files and installed vendor packages. Also modified xsls to display base project
This commit is contained in:
@@ -0,0 +1,20 @@
|
||||
# Ref: https://EditorConfig.org
|
||||
|
||||
# top-most EditorConfig file
|
||||
root = true
|
||||
|
||||
# Unix-style end of lines and a blank line at the end of the file
|
||||
[*]
|
||||
indent_style = tab
|
||||
end_of_line = lf
|
||||
charset = utf-8
|
||||
trim_trailing_whitespace = true
|
||||
insert_final_newline = true
|
||||
|
||||
[*.php]
|
||||
indent_style = space
|
||||
indent_size = 4
|
||||
|
||||
[*.{js,json,scss,css,yml,vue}]
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
@@ -0,0 +1,22 @@
|
||||
# Normalize text sources to LF in the repository and on checkout everywhere.
|
||||
# Critical for a byte-level library: keeps source and fixtures byte-identical
|
||||
# across Windows/macOS/Linux checkouts regardless of core.autocrlf.
|
||||
*.php text eol=lf
|
||||
*.md text eol=lf
|
||||
*.xml text eol=lf
|
||||
*.xml.dist text eol=lf
|
||||
*.json text eol=lf
|
||||
*.toml text eol=lf
|
||||
*.yml text eol=lf
|
||||
*.yaml text eol=lf
|
||||
*.txt text eol=lf
|
||||
Makefile text eol=lf
|
||||
|
||||
# Byte-exact fixtures must never be transformed (CRLF/auto-detection off).
|
||||
test/**/*.bin -text
|
||||
*.png binary
|
||||
*.jpg binary
|
||||
*.gif binary
|
||||
*.pdf binary
|
||||
*.ttf binary
|
||||
*.otf binary
|
||||
@@ -0,0 +1,29 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
1. ...
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Logs**
|
||||
If applicable, copy the relevant logs to help explain your problem.
|
||||
|
||||
**Environment:**
|
||||
- OS:
|
||||
- PHP version:
|
||||
- Version:
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
@@ -0,0 +1,25 @@
|
||||
# Description
|
||||
|
||||
Please include a summary of the change and include relevant motivation and context.
|
||||
|
||||
...
|
||||
|
||||
|
||||
## Checklist:
|
||||
|
||||
- [ ] The `make buildall` command has been run successfully without any error or warning.
|
||||
- [ ] Any new code line is covered by unit tests and the coverage has not dropped.
|
||||
- [ ] Any new code follows the style guidelines of this project.
|
||||
- [ ] The code changes have been self-reviewed.
|
||||
- [ ] Corresponding changes to the documentation have been made.
|
||||
- [ ] The version has been updated in the VERSION file.
|
||||
|
||||
## Type of change:
|
||||
|
||||
- [ ] Bug fix (non-breaking change which fixes an issue) → The patch number in the VERSION file has been increased.
|
||||
- [ ] New feature (non-breaking change which adds functionality) → The minor number in the VERSION file has been increased.
|
||||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) → The major number in the VERSION file has been increased.
|
||||
- [ ] Automation.
|
||||
- [ ] Documentation.
|
||||
- [ ] Example.
|
||||
- [ ] Testing.
|
||||
@@ -0,0 +1,59 @@
|
||||
name: check
|
||||
|
||||
env:
|
||||
XDEBUG_MODE: coverage
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- 'main'
|
||||
pull_request:
|
||||
types: [opened, synchronize, reopened]
|
||||
branches:
|
||||
- main
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
test-php:
|
||||
name: Test on php ${{ matrix.php-version }} and ${{ matrix.os }}
|
||||
runs-on: ${{ matrix.os }}
|
||||
continue-on-error: ${{ matrix.experimental }}
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
php-version: ["8.2", "8.3", "8.4", "8.5"]
|
||||
experimental: [false]
|
||||
os: [ubuntu-latest]
|
||||
coverage-extension: [pcov]
|
||||
steps:
|
||||
- uses: actions/checkout@v7
|
||||
- name: Use php ${{ matrix.php-version }}
|
||||
uses: shivammathur/setup-php@v2
|
||||
with:
|
||||
php-version: ${{ matrix.php-version }}
|
||||
coverage: ${{ matrix.coverage-extension }}
|
||||
extensions: bcmath, curl, date, gd, hash, imagick, json, mbstring, openssl, pcre, zlib
|
||||
ini-values: display_errors=on, error_reporting=-1, zend.assertions=1
|
||||
- name: List php modules
|
||||
run: php -m
|
||||
- name: List php modules using "no php ini" mode
|
||||
run: php -m -n
|
||||
- name: Cache module
|
||||
uses: actions/cache@v6
|
||||
with:
|
||||
path: ~/.composer/cache/
|
||||
key: composer-cache
|
||||
- name: Install dependencies
|
||||
env:
|
||||
GH_TOKEN: ${{ github.token }}
|
||||
run: make deps
|
||||
- name: Run all tests
|
||||
run: make qa
|
||||
- name: Send coverage
|
||||
uses: codecov/codecov-action@v7
|
||||
with:
|
||||
flags: php-${{ matrix.php-version }}-${{ matrix.os }}
|
||||
name: php-${{ matrix.php-version }}-${{ matrix.os }}
|
||||
@@ -0,0 +1,21 @@
|
||||
**/*.bak
|
||||
**/*.tmp
|
||||
**/.#*
|
||||
**/.DS_Store
|
||||
**/._*
|
||||
**/.idea
|
||||
**/.vagrant
|
||||
**/auth.json
|
||||
**/nbproject
|
||||
**/temp.php
|
||||
**/test.php
|
||||
.phpdoc
|
||||
.phpunit.cache
|
||||
.phpunit.result.cache
|
||||
composer.lock
|
||||
ecs.php
|
||||
phpunit.xml
|
||||
rector.php
|
||||
target
|
||||
vendor
|
||||
PLAN_*
|
||||
@@ -0,0 +1 @@
|
||||
* @nicolaasuni
|
||||
@@ -0,0 +1,128 @@
|
||||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
We as members, contributors, and leaders pledge to make participation in our
|
||||
community a harassment-free experience for everyone, regardless of age, body
|
||||
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||
identity and expression, level of experience, education, socio-economic status,
|
||||
nationality, personal appearance, race, religion, or sexual identity
|
||||
and orientation.
|
||||
|
||||
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||
diverse, inclusive, and healthy community.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to a positive environment for our
|
||||
community include:
|
||||
|
||||
* Demonstrating empathy and kindness toward other people
|
||||
* Being respectful of differing opinions, viewpoints, and experiences
|
||||
* Giving and gracefully accepting constructive feedback
|
||||
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||
and learning from the experience
|
||||
* Focusing on what is best not just for us as individuals, but for the
|
||||
overall community
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
* The use of sexualized language or imagery, and sexual attention or
|
||||
advances of any kind
|
||||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or email
|
||||
address, without their explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Enforcement Responsibilities
|
||||
|
||||
Community leaders are responsible for clarifying and enforcing our standards of
|
||||
acceptable behavior and will take appropriate and fair corrective action in
|
||||
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||
or harmful.
|
||||
|
||||
Community leaders have the right and responsibility to remove, edit, or reject
|
||||
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||
decisions when appropriate.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies within all community spaces, and also applies when
|
||||
an individual is officially representing the community in public spaces.
|
||||
Examples of representing our community include using an official e-mail address,
|
||||
posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported to the community leaders responsible for enforcement at
|
||||
.
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the
|
||||
reporter of any incident.
|
||||
|
||||
## Enforcement Guidelines
|
||||
|
||||
Community leaders will follow these Community Impact Guidelines in determining
|
||||
the consequences for any action they deem in violation of this Code of Conduct:
|
||||
|
||||
### 1. Correction
|
||||
|
||||
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||
unprofessional or unwelcome in the community.
|
||||
|
||||
**Consequence**: A private, written warning from community leaders, providing
|
||||
clarity around the nature of the violation and an explanation of why the
|
||||
behavior was inappropriate. A public apology may be requested.
|
||||
|
||||
### 2. Warning
|
||||
|
||||
**Community Impact**: A violation through a single incident or series
|
||||
of actions.
|
||||
|
||||
**Consequence**: A warning with consequences for continued behavior. No
|
||||
interaction with the people involved, including unsolicited interaction with
|
||||
those enforcing the Code of Conduct, for a specified period of time. This
|
||||
includes avoiding interactions in community spaces as well as external channels
|
||||
like social media. Violating these terms may lead to a temporary or
|
||||
permanent ban.
|
||||
|
||||
### 3. Temporary Ban
|
||||
|
||||
**Community Impact**: A serious violation of community standards, including
|
||||
sustained inappropriate behavior.
|
||||
|
||||
**Consequence**: A temporary ban from any sort of interaction or public
|
||||
communication with the community for a specified period of time. No public or
|
||||
private interaction with the people involved, including unsolicited interaction
|
||||
with those enforcing the Code of Conduct, is allowed during this period.
|
||||
Violating these terms may lead to a permanent ban.
|
||||
|
||||
### 4. Permanent Ban
|
||||
|
||||
**Community Impact**: Demonstrating a pattern of violation of community
|
||||
standards, including sustained inappropriate behavior, harassment of an
|
||||
individual, or aggression toward or disparagement of classes of individuals.
|
||||
|
||||
**Consequence**: A permanent ban from any sort of public interaction within
|
||||
the community.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 2.0, available at
|
||||
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
||||
|
||||
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
||||
enforcement ladder](https://github.com/mozilla/diversity).
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
|
||||
For answers to common questions about this code of conduct, see the FAQ at
|
||||
https://www.contributor-covenant.org/faq. Translations are available at
|
||||
https://www.contributor-covenant.org/translations.
|
||||
@@ -0,0 +1,194 @@
|
||||
# Contributing to tc-lib-pdf-encrypt
|
||||
|
||||
Thank you for your interest in contributing to **tc-lib-pdf-encrypt**.
|
||||
Contributions of all kinds are welcome: bug reports, bug fixes, documentation improvements, new features, and refactors.
|
||||
|
||||
Please take a moment to read this guide before opening an issue or pull request.
|
||||
|
||||
---
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Code of Conduct](#code-of-conduct)
|
||||
- [Security Vulnerabilities](#security-vulnerabilities)
|
||||
- [Getting Started](#getting-started)
|
||||
- [Reporting a Bug](#reporting-a-bug)
|
||||
- [Submitting a Bug Fix](#submitting-a-bug-fix)
|
||||
- [Proposing a New Feature](#proposing-a-new-feature)
|
||||
- [Development Workflow](#development-workflow)
|
||||
- [Coding Standards](#coding-standards)
|
||||
- [Testing](#testing)
|
||||
- [Pull Request Guidelines](#pull-request-guidelines)
|
||||
- [Commit Message Guidelines](#commit-message-guidelines)
|
||||
|
||||
---
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating you agree to abide by its terms. Please report unacceptable behaviour to [info@tecnick.com](mailto:info@tecnick.com).
|
||||
|
||||
---
|
||||
|
||||
## Security Vulnerabilities
|
||||
|
||||
**Do not open a public GitHub issue for security vulnerabilities.**
|
||||
Please follow the [Security Policy](SECURITY.md) and report them privately.
|
||||
|
||||
---
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Requirements
|
||||
|
||||
- PHP **≥ 8.2**
|
||||
- [Composer](https://getcomposer.org/) v2
|
||||
- `make`, `git`
|
||||
- Optional: `rpmbuild` (RPM packaging), `dpkg-buildpackage` (DEB packaging)
|
||||
|
||||
### Local setup
|
||||
|
||||
```bash
|
||||
git clone https://github.com/tecnickcom/tc-lib-pdf-encrypt.git
|
||||
cd tc-lib-pdf-encrypt
|
||||
make buildall
|
||||
```
|
||||
|
||||
To verify everything is working after a change:
|
||||
|
||||
```bash
|
||||
make qa
|
||||
```
|
||||
|
||||
This runs linting, static analysis, and the full unit-test suite with coverage.
|
||||
|
||||
---
|
||||
|
||||
## Reporting a Bug
|
||||
|
||||
Before opening an issue:
|
||||
|
||||
1. **Check the [Security Policy](SECURITY.md)** — if the bug is a security vulnerability, do not file a public issue.
|
||||
2. **Search [existing issues](https://github.com/tecnickcom/tc-lib-pdf-encrypt/issues)** to avoid duplicates.
|
||||
|
||||
If no existing issue matches, [open a new one](https://github.com/tecnickcom/tc-lib-pdf-encrypt/issues/new) and include:
|
||||
|
||||
- A **clear title and description** of the problem.
|
||||
- The **library version** (`composer show tecnickcom/tc-lib-pdf-encrypt`) and PHP version.
|
||||
- A **minimal, self-contained reproduction** — a short PHP script or a failing PHPUnit test case is ideal.
|
||||
- **Expected vs. actual behaviour** — what you expected to happen and what actually happened.
|
||||
- Any relevant **stack trace or error output**.
|
||||
|
||||
The more precise and reproducible the report, the faster it can be triaged and fixed.
|
||||
|
||||
---
|
||||
|
||||
## Submitting a Bug Fix
|
||||
|
||||
1. [Fork the repository](https://github.com/tecnickcom/tc-lib-pdf-encrypt/fork) and create a branch from `main`:
|
||||
```bash
|
||||
git checkout -b fix/short-description-of-bug
|
||||
```
|
||||
2. Make your changes, following the [Coding Standards](#coding-standards) below.
|
||||
3. Add or update unit tests to cover the changes.
|
||||
4. Run the full quality-assurance suite locally and ensure it passes:
|
||||
```bash
|
||||
make qa
|
||||
```
|
||||
5. Commit your changes (see [Commit Message Guidelines](#commit-message-guidelines)).
|
||||
6. Open a pull request against `main` and fill in the PR template:
|
||||
- Describe the problem and your solution.
|
||||
- Reference the related issue number (e.g. `Fixes #123`).
|
||||
|
||||
---
|
||||
|
||||
## Proposing a New Feature
|
||||
|
||||
Before writing any code:
|
||||
|
||||
1. **Open a Feature Request** on [GitHub Issues](https://github.com/tecnickcom/tc-lib-pdf-encrypt/issues/new) describing the use case and proposed API.
|
||||
2. Wait for feedback from the maintainer. This avoids investing time in a direction that may not be accepted.
|
||||
|
||||
Once the feature is agreed upon, follow the same branch → code → test → PR workflow as for bug fixes, using a branch named `feature/short-description`.
|
||||
|
||||
---
|
||||
|
||||
## Development Workflow
|
||||
|
||||
The `Makefile` exposes all common development tasks:
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `make qa` | Run linting, static analysis, tests, and reports |
|
||||
| `make test` | Run PHPUnit with code coverage |
|
||||
| `make lint` | Check coding standards |
|
||||
| `make format` | Auto-format the code |
|
||||
| `make buildall` | Install dependencies, fix style, run QA, and build packages |
|
||||
| `make clean` | Remove `vendor/` and `target/` directories |
|
||||
| `make server` | Start the built-in PHP development server for the examples |
|
||||
|
||||
Run `make help` to see the full list of available targets.
|
||||
|
||||
---
|
||||
|
||||
## Coding Standards
|
||||
|
||||
- The codebase follows **PSR-12** for formatting.
|
||||
- Run `make format` to auto-format the code.
|
||||
- Run `make lint` to catch remaining issues.
|
||||
- All source files live under `src/`, all tests under `test/`.
|
||||
- Use strict types and explicit visibility on all class members.
|
||||
- Avoid introducing new external dependencies without prior discussion.
|
||||
|
||||
---
|
||||
|
||||
## Testing
|
||||
|
||||
Tests are written with [PHPUnit](https://phpunit.de/) and live in `test/`.
|
||||
|
||||
```bash
|
||||
# Run the full test suite with coverage
|
||||
make test
|
||||
|
||||
# Run a specific test file
|
||||
XDEBUG_MODE=coverage ./vendor/bin/phpunit test/HTMLTest.php
|
||||
```
|
||||
|
||||
Requirements for contributions:
|
||||
|
||||
- Every bug fix must be accompanied by a regression test that fails before the fix and passes after.
|
||||
- Every new feature must be accompanied by tests that cover both the happy path and edge cases.
|
||||
|
||||
Coverage reports are generated in `target/coverage/`.
|
||||
|
||||
---
|
||||
|
||||
## Pull Request Guidelines
|
||||
|
||||
- Target the `main` branch.
|
||||
- Keep PRs focused — one fix or feature per PR.
|
||||
- Ensure `make qa` passes locally before opening the PR.
|
||||
- Do not bump the version number in your PR; that is handled by the maintainer at release time.
|
||||
- Be responsive to review feedback; stale PRs may be closed after an extended period of inactivity.
|
||||
|
||||
---
|
||||
|
||||
## Commit Message Guidelines
|
||||
|
||||
Use concise, imperative-mood commit messages:
|
||||
|
||||
```
|
||||
fix: correct path traversal in font loader
|
||||
feat: add support for XYZ
|
||||
test: add regression test for #123
|
||||
docs: update CONTRIBUTING workflow
|
||||
refactor: extract text measurement into helper
|
||||
```
|
||||
|
||||
Prefix tags: `fix`, `feat`, `test`, `docs`, `refactor`, `chore`, `ci`.
|
||||
Reference issues where relevant: `fix: correct X (closes #42)`.
|
||||
|
||||
---
|
||||
|
||||
## Questions?
|
||||
|
||||
If you have a question that is not covered here, feel free to open a [GitHub Discussion](https://github.com/tecnickcom/tc-lib-pdf-encrypt/discussions) or contact the maintainer at [info@tecnick.com](mailto:info@tecnick.com).
|
||||
+862
@@ -0,0 +1,862 @@
|
||||
**********************************************************************
|
||||
* LICENSE
|
||||
*
|
||||
* SOFTWARE : tc-lib-pdf-encrypt
|
||||
* AUTHOR : Nicola Asuni <info@tecnick.com>
|
||||
* COPYRIGHT : 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
**********************************************************************
|
||||
|
||||
This is free software: you can redistribute it and/or modify it
|
||||
under the terms of the GNU Lesser General Public License as
|
||||
published by the Free Software Foundation, either version 3 of the
|
||||
License, or (at your option) any later version.
|
||||
|
||||
**********************************************************************
|
||||
**********************************************************************
|
||||
|
||||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://www.fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
|
||||
This version of the GNU Lesser General Public License incorporates
|
||||
the terms and conditions of version 3 of the GNU General Public
|
||||
License, supplemented by the additional permissions listed below.
|
||||
|
||||
0. Additional Definitions.
|
||||
|
||||
As used herein, "this License" refers to version 3 of the GNU Lesser
|
||||
General Public License, and the "GNU GPL" refers to version 3 of the GNU
|
||||
General Public License.
|
||||
|
||||
"The Library" refers to a covered work governed by this License,
|
||||
other than an Application or a Combined Work as defined below.
|
||||
|
||||
An "Application" is any work that makes use of an interface provided
|
||||
by the Library, but which is not otherwise based on the Library.
|
||||
Defining a subclass of a class defined by the Library is deemed a mode
|
||||
of using an interface provided by the Library.
|
||||
|
||||
A "Combined Work" is a work produced by combining or linking an
|
||||
Application with the Library. The particular version of the Library
|
||||
with which the Combined Work was made is also called the "Linked
|
||||
Version".
|
||||
|
||||
The "Minimal Corresponding Source" for a Combined Work means the
|
||||
Corresponding Source for the Combined Work, excluding any source code
|
||||
for portions of the Combined Work that, considered in isolation, are
|
||||
based on the Application, and not on the Linked Version.
|
||||
|
||||
The "Corresponding Application Code" for a Combined Work means the
|
||||
object code and/or source code for the Application, including any data
|
||||
and utility programs needed for reproducing the Combined Work from the
|
||||
Application, but excluding the System Libraries of the Combined Work.
|
||||
|
||||
1. Exception to Section 3 of the GNU GPL.
|
||||
|
||||
You may convey a covered work under sections 3 and 4 of this License
|
||||
without being bound by section 3 of the GNU GPL.
|
||||
|
||||
2. Conveying Modified Versions.
|
||||
|
||||
If you modify a copy of the Library, and, in your modifications, a
|
||||
facility refers to a function or data to be supplied by an Application
|
||||
that uses the facility (other than as an argument passed when the
|
||||
facility is invoked), then you may convey a copy of the modified
|
||||
version:
|
||||
|
||||
a) under this License, provided that you make a good faith effort to
|
||||
ensure that, in the event an Application does not supply the
|
||||
function or data, the facility still operates, and performs
|
||||
whatever part of its purpose remains meaningful, or
|
||||
|
||||
b) under the GNU GPL, with none of the additional permissions of
|
||||
this License applicable to that copy.
|
||||
|
||||
3. Object Code Incorporating Material from Library Header Files.
|
||||
|
||||
The object code form of an Application may incorporate material from
|
||||
a header file that is part of the Library. You may convey such object
|
||||
code under terms of your choice, provided that, if the incorporated
|
||||
material is not limited to numerical parameters, data structure
|
||||
layouts and accessors, or small macros, inline functions and templates
|
||||
(ten or fewer lines in length), you do both of the following:
|
||||
|
||||
a) Give prominent notice with each copy of the object code that the
|
||||
Library is used in it and that the Library and its use are
|
||||
covered by this License.
|
||||
|
||||
b) Accompany the object code with a copy of the GNU GPL and this license
|
||||
document.
|
||||
|
||||
4. Combined Works.
|
||||
|
||||
You may convey a Combined Work under terms of your choice that,
|
||||
taken together, effectively do not restrict modification of the
|
||||
portions of the Library contained in the Combined Work and reverse
|
||||
engineering for debugging such modifications, if you also do each of
|
||||
the following:
|
||||
|
||||
a) Give prominent notice with each copy of the Combined Work that
|
||||
the Library is used in it and that the Library and its use are
|
||||
covered by this License.
|
||||
|
||||
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
||||
document.
|
||||
|
||||
c) For a Combined Work that displays copyright notices during
|
||||
execution, include the copyright notice for the Library among
|
||||
these notices, as well as a reference directing the user to the
|
||||
copies of the GNU GPL and this license document.
|
||||
|
||||
d) Do one of the following:
|
||||
|
||||
0) Convey the Minimal Corresponding Source under the terms of this
|
||||
License, and the Corresponding Application Code in a form
|
||||
suitable for, and under terms that permit, the user to
|
||||
recombine or relink the Application with a modified version of
|
||||
the Linked Version to produce a modified Combined Work, in the
|
||||
manner specified by section 6 of the GNU GPL for conveying
|
||||
Corresponding Source.
|
||||
|
||||
1) Use a suitable shared library mechanism for linking with the
|
||||
Library. A suitable mechanism is one that (a) uses at run time
|
||||
a copy of the Library already present on the user's computer
|
||||
system, and (b) will operate properly with a modified version
|
||||
of the Library that is interface-compatible with the Linked
|
||||
Version.
|
||||
|
||||
e) Provide Installation Information, but only if you would otherwise
|
||||
be required to provide such information under section 6 of the
|
||||
GNU GPL, and only to the extent that such information is
|
||||
necessary to install and execute a modified version of the
|
||||
Combined Work produced by recombining or relinking the
|
||||
Application with a modified version of the Linked Version. (If
|
||||
you use option 4d0, the Installation Information must accompany
|
||||
the Minimal Corresponding Source and Corresponding Application
|
||||
Code. If you use option 4d1, you must provide the Installation
|
||||
Information in the manner specified by section 6 of the GNU GPL
|
||||
for conveying Corresponding Source.)
|
||||
|
||||
5. Combined Libraries.
|
||||
|
||||
You may place library facilities that are a work based on the
|
||||
Library side by side in a single library together with other library
|
||||
facilities that are not Applications and are not covered by this
|
||||
License, and convey such a combined library under terms of your
|
||||
choice, if you do both of the following:
|
||||
|
||||
a) Accompany the combined library with a copy of the same work based
|
||||
on the Library, uncombined with any other library facilities,
|
||||
conveyed under the terms of this License.
|
||||
|
||||
b) Give prominent notice with the combined library that part of it
|
||||
is a work based on the Library, and explaining where to find the
|
||||
accompanying uncombined form of the same work.
|
||||
|
||||
6. Revised Versions of the GNU Lesser General Public License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions
|
||||
of the GNU Lesser General Public License from time to time. Such new
|
||||
versions will be similar in spirit to the present version, but may
|
||||
differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Library as you received it specifies that a certain numbered version
|
||||
of the GNU Lesser General Public License "or any later version"
|
||||
applies to it, you have the option of following the terms and
|
||||
conditions either of that published version or of any later version
|
||||
published by the Free Software Foundation. If the Library as you
|
||||
received it does not specify a version number of the GNU Lesser
|
||||
General Public License, you may choose any version of the GNU Lesser
|
||||
General Public License ever published by the Free Software Foundation.
|
||||
|
||||
If the Library as you received it specifies that a proxy can decide
|
||||
whether future versions of the GNU Lesser General Public License shall
|
||||
apply, that proxy's public statement of acceptance of any version is
|
||||
permanent authorization for you to choose that version for the
|
||||
Library.
|
||||
|
||||
**********************************************************************
|
||||
**********************************************************************
|
||||
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://www.fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
|
||||
**********************************************************************
|
||||
**********************************************************************
|
||||
+285
@@ -0,0 +1,285 @@
|
||||
# makefile
|
||||
#
|
||||
# @since 2015-02-21
|
||||
# @category Library
|
||||
# @package PdfEncrypt
|
||||
# @author Nicola Asuni <info@tecnick.com>
|
||||
# @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
# @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
# @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
#
|
||||
# This file is part of tc-lib-pdf-encrypt software library.
|
||||
# ----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
SHELL=/bin/bash
|
||||
.SHELLFLAGS=-o pipefail -c
|
||||
|
||||
# Project owner
|
||||
OWNER=tecnickcom
|
||||
|
||||
# Project vendor
|
||||
VENDOR=${OWNER}
|
||||
|
||||
# Project name
|
||||
PROJECT=tc-lib-pdf-encrypt
|
||||
|
||||
# Project version
|
||||
VERSION=$(shell cat VERSION)
|
||||
|
||||
# Project release number (packaging build number)
|
||||
RELEASE=$(shell cat RELEASE)
|
||||
|
||||
# Name of RPM or DEB package
|
||||
PKGNAME=php-${OWNER}-${PROJECT}
|
||||
|
||||
# Data dir
|
||||
DATADIR=usr/share
|
||||
|
||||
# PHP home folder
|
||||
PHPHOME=${DATADIR}/php/Com/Tecnick
|
||||
|
||||
# Default installation path for code
|
||||
LIBPATH=${PHPHOME}/Pdf/Encrypt/
|
||||
|
||||
# Path for configuration files (etc/$(PKGNAME)/)
|
||||
CONFIGPATH=
|
||||
|
||||
# Default installation path for documentation
|
||||
DOCPATH=${DATADIR}/doc/$(PKGNAME)/
|
||||
|
||||
# Installation path for the code
|
||||
PATHINSTBIN=$(DESTDIR)/$(LIBPATH)
|
||||
|
||||
# Installation path for the configuration files
|
||||
PATHINSTCFG=$(DESTDIR)/$(CONFIGPATH)
|
||||
|
||||
# Installation path for documentation
|
||||
PATHINSTDOC=$(DESTDIR)/$(DOCPATH)
|
||||
|
||||
# Current directory
|
||||
CURRENTDIR=$(CURDIR)/
|
||||
|
||||
# Target directory
|
||||
TARGETDIR=target
|
||||
|
||||
# RPM Packaging path (where RPMs will be stored)
|
||||
PATHRPMPKG=$(TARGETDIR)/RPM
|
||||
|
||||
# RPM local database path (avoid host rpmdb permission issues)
|
||||
RPMDBPATH=$(PATHRPMPKG)/.rpmdb
|
||||
|
||||
# DEB Packaging path (where DEBs will be stored)
|
||||
PATHDEBPKG=$(TARGETDIR)/DEB
|
||||
|
||||
# BZ2 Packaging path (where BZ2s will be stored)
|
||||
PATHBZ2PKG=$(TARGETDIR)/BZ2
|
||||
|
||||
# sed argument for in-place substitutions
|
||||
SEDINPLACE=-i
|
||||
ifeq ($(shell uname -s),Darwin)
|
||||
SEDINPLACE=-i ''
|
||||
endif
|
||||
|
||||
# Default port number for the example server
|
||||
PORT?=8000
|
||||
|
||||
# PHP binary
|
||||
PHP=$(shell which php)
|
||||
|
||||
# Composer executable (disable APC to as a work-around of a bug)
|
||||
COMPOSER=$(PHP) -d "apc.enable_cli=0" $(shell which composer)
|
||||
|
||||
# phpDocumentor executable file
|
||||
PHPDOC=$(shell which phpDocumentor)
|
||||
|
||||
# Set default OpenSSL configuration file
|
||||
ifeq ($(OPENSSL_CONF),)
|
||||
OPENSSL_CONF=$(CURRENTDIR)openssl.cnf
|
||||
endif
|
||||
|
||||
# Mago version
|
||||
MAGOVERSION=1.43.0
|
||||
|
||||
# --- MAKE TARGETS ---
|
||||
|
||||
# Display general help about this command
|
||||
.PHONY: help
|
||||
help:
|
||||
@echo ""
|
||||
@echo "$(PROJECT) $(OPENSSL_CONF) Makefile."
|
||||
@echo "The following commands are available:"
|
||||
@echo ""
|
||||
@awk '/^## /{desc=substr($$0,4)} /^\.PHONY:/{if(NF>1) {target=$$2; if(desc) printf " make %-15s: %s\n",target,desc; desc=""}}' Makefile
|
||||
@echo ""
|
||||
@echo "To test and build everything from scratch, use the shortcut:"
|
||||
@echo " make x"
|
||||
@echo ""
|
||||
|
||||
# alias for help target
|
||||
.PHONY: all
|
||||
all: help
|
||||
|
||||
# Full build and test sequence
|
||||
.PHONY: x
|
||||
x: buildall
|
||||
|
||||
## Full build and test sequence
|
||||
.PHONY: buildall
|
||||
buildall: deps format qa bz2 rpm deb
|
||||
|
||||
## Package the library in a compressed bz2 archive
|
||||
.PHONY: bz2
|
||||
bz2:
|
||||
rm -rf "$(PATHBZ2PKG)"
|
||||
make install DESTDIR="$(PATHBZ2PKG)"
|
||||
tar -jcvf "$(PATHBZ2PKG)/$(PKGNAME)-$(VERSION)-$(RELEASE).tbz2" -C "$(PATHBZ2PKG)" "$(DATADIR)"
|
||||
|
||||
## Delete the vendor and target directories
|
||||
.PHONY: clean
|
||||
clean:
|
||||
rm -rf ./vendor "$(TARGETDIR)"
|
||||
|
||||
## Build a DEB package for Debian-like Linux distributions
|
||||
.PHONY: deb
|
||||
deb:
|
||||
rm -rf "$(PATHDEBPKG)"
|
||||
$(MAKE) install DESTDIR="$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)"
|
||||
rm -f "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/$(DOCPATH)LICENSE"
|
||||
tar -zcvf "$(PATHDEBPKG)/$(PKGNAME)_$(VERSION).orig.tar.gz" -C "$(PATHDEBPKG)/" "$(PKGNAME)-$(VERSION)"
|
||||
cp -rf ./resources/debian "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian"
|
||||
find "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/" -type f -name '*.bak' -delete
|
||||
chmod 755 "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/rules"
|
||||
find "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/" -type f -exec sed $(SEDINPLACE) "s/~#DATE#~/`date -R`/" {} \;
|
||||
find "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/" -type f -exec sed $(SEDINPLACE) "s/~#VENDOR#~/$(VENDOR)/" {} \;
|
||||
find "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/" -type f -exec sed $(SEDINPLACE) "s/~#PROJECT#~/$(PROJECT)/" {} \;
|
||||
find "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/" -type f -exec sed $(SEDINPLACE) "s/~#PKGNAME#~/$(PKGNAME)/" {} \;
|
||||
find "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/" -type f -exec sed $(SEDINPLACE) "s/~#VERSION#~/$(VERSION)/" {} \;
|
||||
find "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/" -type f -exec sed $(SEDINPLACE) "s/~#RELEASE#~/$(RELEASE)/" {} \;
|
||||
echo "$(LIBPATH)" > "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/$(PKGNAME).dirs"
|
||||
echo "$(LIBPATH)* $(LIBPATH)" > "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/install"
|
||||
echo "$(DOCPATH)" >> "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/$(PKGNAME).dirs"
|
||||
echo "$(DOCPATH)* $(DOCPATH)" >> "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/install"
|
||||
ifneq ($(strip $(CONFIGPATH)),)
|
||||
echo "$(CONFIGPATH)" >> "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/$(PKGNAME).dirs"
|
||||
echo "$(CONFIGPATH)* $(CONFIGPATH)" >> "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/install"
|
||||
endif
|
||||
echo "new-package-should-close-itp-bug" > "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/$(PKGNAME).lintian-overrides"
|
||||
cd "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)" && debuild -us -uc
|
||||
|
||||
## Clean all artifacts and download all dependencies
|
||||
.PHONY: deps
|
||||
deps: ensuretarget
|
||||
rm -rf ./vendor/*
|
||||
($(COMPOSER) install -vvv --no-interaction)
|
||||
curl --proto '=https' --tlsv1.2 --silent --show-error --fail --location https://carthage.software/mago.sh | bash -s -- --install-dir=./vendor/bin --version=$(MAGOVERSION)
|
||||
|
||||
## Generate source code documentation
|
||||
.PHONY: doc
|
||||
doc: ensuretarget
|
||||
rm -rf "$(TARGETDIR)/doc"
|
||||
$(PHPDOC) -d ./src -t "$(TARGETDIR)/doc/"
|
||||
|
||||
## Create missing target directories for test and build artifacts
|
||||
.PHONY: ensuretarget
|
||||
ensuretarget:
|
||||
mkdir -p "$(TARGETDIR)/test"
|
||||
mkdir -p "$(TARGETDIR)/report"
|
||||
mkdir -p "$(TARGETDIR)/doc"
|
||||
|
||||
## Install this application
|
||||
.PHONY: install
|
||||
install: uninstall
|
||||
mkdir -p "$(PATHINSTBIN)"
|
||||
cp -rf ./src/* "$(PATHINSTBIN)"
|
||||
cp -f ./resources/autoload.php "$(PATHINSTBIN)"
|
||||
find "$(PATHINSTBIN)" -type d -exec chmod 755 {} \;
|
||||
find "$(PATHINSTBIN)" -type f -exec chmod 644 {} \;
|
||||
mkdir -p "$(PATHINSTDOC)"
|
||||
cp -f ./LICENSE "$(PATHINSTDOC)"
|
||||
cp -f ./README.md "$(PATHINSTDOC)"
|
||||
cp -f ./VERSION "$(PATHINSTDOC)"
|
||||
cp -f ./RELEASE "$(PATHINSTDOC)"
|
||||
chmod -R 644 "$(PATHINSTDOC)"*
|
||||
ifneq ($(strip $(CONFIGPATH)),)
|
||||
mkdir -p "$(PATHINSTCFG)"
|
||||
touch -c "$(PATHINSTCFG)"*
|
||||
cp -ru "./resources/${CONFIGPATH}"* "$(PATHINSTCFG)"
|
||||
find "$(PATHINSTCFG)" -type d -exec chmod 755 {} \;
|
||||
find "$(PATHINSTCFG)" -type f -exec chmod 644 {} \;
|
||||
endif
|
||||
|
||||
## Format the source code
|
||||
.PHONY: format
|
||||
format:
|
||||
./vendor/bin/mago fmt src test
|
||||
|
||||
## Analyze and Lint the source code
|
||||
.PHONY: lint
|
||||
lint:
|
||||
./vendor/bin/mago --config ./mago.src.toml analyze src
|
||||
./vendor/bin/mago --config ./mago.test.toml analyze test
|
||||
./vendor/bin/mago --config ./mago.src.toml lint src
|
||||
./vendor/bin/mago --config ./mago.test.toml lint test
|
||||
|
||||
## Run all tests and reports
|
||||
.PHONY: qa
|
||||
qa: ensuretarget lint test report
|
||||
|
||||
## Generate various reports
|
||||
.PHONY: report
|
||||
report: ensuretarget
|
||||
./vendor/bin/pdepend --jdepend-xml="$(TARGETDIR)/report/dependencies.xml" --summary-xml="$(TARGETDIR)/report/metrics.xml" --jdepend-chart="$(TARGETDIR)/report/dependecies.svg" --overview-pyramid="$(TARGETDIR)/report/overview-pyramid.svg" --ignore=vendor ./src
|
||||
#./vendor/bartlett/php-compatinfo/bin/phpcompatinfo --no-ansi analyser:run src/ > $(TARGETDIR)/report/phpcompatinfo.txt
|
||||
|
||||
## Build the RPM package for RedHat-like Linux distributions
|
||||
.PHONY: rpm
|
||||
rpm:
|
||||
@test $(words $(CURDIR)) -eq 1 || { echo "ERROR: rpmbuild does not support spaces in the project path: $(CURDIR)"; exit 1; }
|
||||
rm -rf "$(PATHRPMPKG)"
|
||||
mkdir -p "$(RPMDBPATH)" "$(PATHRPMPKG)/tmp"
|
||||
rpmbuild \
|
||||
--define "_topdir $(CURRENTDIR)$(PATHRPMPKG)" \
|
||||
--define "_dbpath $(CURRENTDIR)$(RPMDBPATH)" \
|
||||
--define "_tmppath $(CURRENTDIR)$(PATHRPMPKG)/tmp" \
|
||||
--define "_vendor $(VENDOR)" \
|
||||
--define "_owner $(OWNER)" \
|
||||
--define "_project $(PROJECT)" \
|
||||
--define "_package $(PKGNAME)" \
|
||||
--define "_version $(VERSION)" \
|
||||
--define "_release $(RELEASE)" \
|
||||
--define "_current_directory $(CURRENTDIR)" \
|
||||
--define "_libpath /$(LIBPATH)" \
|
||||
--define "_docpath /$(DOCPATH)" \
|
||||
--define "_configpath /$(CONFIGPATH)" \
|
||||
-bb resources/rpm/rpm.spec
|
||||
|
||||
## Start the development server
|
||||
.PHONY: server
|
||||
server:
|
||||
$(PHP) -t example -S localhost:$(PORT)
|
||||
|
||||
## Tag this GIT version
|
||||
.PHONY: tag
|
||||
tag:
|
||||
git checkout main && \
|
||||
git tag -a ${VERSION} -m "Release ${VERSION}" && \
|
||||
git push origin --tags && \
|
||||
git pull
|
||||
|
||||
## Run unit tests
|
||||
.PHONY: test
|
||||
test:
|
||||
cp phpunit.xml.dist phpunit.xml
|
||||
#./vendor/bin/phpunit --migrate-configuration || true
|
||||
OPENSSL_CONF=${OPENSSL_CONF} XDEBUG_MODE=coverage ./vendor/bin/phpunit --stderr test
|
||||
|
||||
## Remove all installed files
|
||||
.PHONY: uninstall
|
||||
uninstall:
|
||||
rm -rf "$(PATHINSTBIN)"
|
||||
rm -rf "$(PATHINSTDOC)"
|
||||
|
||||
## Increase the version patch number
|
||||
.PHONY: versionup
|
||||
versionup:
|
||||
echo ${VERSION} | gawk -F. '{printf("%d.%d.%d\n",$$1,$$2,(($$3+1)));}' > VERSION
|
||||
+165
@@ -0,0 +1,165 @@
|
||||
# tc-lib-pdf-encrypt
|
||||
|
||||
> PDF encryption primitives for password protection and permission control.
|
||||
|
||||
[](https://packagist.org/packages/tecnickcom/tc-lib-pdf-encrypt)
|
||||
[](https://github.com/tecnickcom/tc-lib-pdf-encrypt/actions/workflows/check.yml)
|
||||
[](https://codecov.io/gh/tecnickcom/tc-lib-pdf-encrypt)
|
||||
[](https://packagist.org/packages/tecnickcom/tc-lib-pdf-encrypt)
|
||||
[](https://packagist.org/packages/tecnickcom/tc-lib-pdf-encrypt)
|
||||
|
||||
[](https://github.com/sponsors/tecnickcom)
|
||||
|
||||
> 💖 Part of the [tc-lib-pdf / TCPDF](https://github.com/tecnickcom/tc-lib-pdf) ecosystem (100M+ installs). [Sponsor its maintenance →](https://github.com/sponsors/tecnickcom)
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
`tc-lib-pdf-encrypt` implements core encryption routines used by PDF generation and processing stacks, including password handling and permission flags.
|
||||
|
||||
The package encapsulates PDF security mechanics behind a focused API so consuming libraries can apply encryption policies without reimplementing cryptographic details. It is built for interoperability with standard PDF readers and for clear separation between document logic and security concerns.
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| **Namespace** | `\Com\Tecnick\Pdf\Encrypt` |
|
||||
| **Author** | Nicola Asuni <info@tecnick.com> |
|
||||
| **License** | [GNU LGPL v3](https://www.gnu.org/copyleft/lesser.html) - see [LICENSE](LICENSE) |
|
||||
| **API docs** | <https://tcpdf.org/docs/srcdoc/tc-lib-pdf-encrypt> |
|
||||
| **Packagist** | <https://packagist.org/packages/tecnickcom/tc-lib-pdf-encrypt> |
|
||||
|
||||
---
|
||||
|
||||
## Security Notice
|
||||
|
||||
> **RC4 modes (0 and 1) are cryptographically broken and deprecated.**
|
||||
> RC4-40 (mode 0) and RC4-128 (mode 1) are no longer considered secure.
|
||||
> Both modes emit an `E_USER_DEPRECATED` notice at runtime.
|
||||
> **Use AES-128 (mode 2), AES-256 R5 (mode 3), or AES-256 R6 / PDF 2.0 (mode 4) for all new documents.**
|
||||
|
||||
| Mode | Algorithm | Security |
|
||||
|------|-----------|----------|
|
||||
| 0 | RC4-40 | **Broken: do not use** |
|
||||
| 1 | RC4-128 | **Broken: do not use** |
|
||||
| 2 | AES-128 | Acceptable for legacy compatibility |
|
||||
| 3 | AES-256 R5 (PDF 1.7 ext.) | Recommended |
|
||||
| 4 | AES-256 R6 (PDF 2.0 / ISO 32000-2) | Recommended (most current) |
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
|
||||
### Encryption
|
||||
- RC4 and AES variants for PDF object/string encryption (modes 0–4; see Security Notice above)
|
||||
- AES-256 R6 (PDF 2.0 / ISO 32000-2, mode 4) support with Algorithm 2.B (ISO 32000-2 §7.6.4.3.4) key derivation
|
||||
- User and owner password workflows
|
||||
- Permission flag handling for document operations
|
||||
- Optional metadata encryption control (`$encryptMetadata`)
|
||||
- Optional embedded-file stream encryption (`$encryptEmbeddedFiles`, `/EFF` dictionary entry)
|
||||
- Public-key (certificate) encryption for multiple recipients
|
||||
|
||||
### Decryption
|
||||
- Password authentication for all encryption modes (RC4-40, RC4-128, AES-128, AES-256 R5/R6)
|
||||
- Public-key (PKCS#7 / S/MIME) decryption for recipient private keys
|
||||
- Per-object key derivation for AES-128 streams
|
||||
- Round-trip `decryptString()` companion to `encryptString()`
|
||||
|
||||
### Integration
|
||||
- Designed for direct use by PDF writer and reader components
|
||||
- Helpers for PDF date formatting and hex/string transforms
|
||||
- Exception-driven error handling
|
||||
|
||||
---
|
||||
|
||||
## Requirements
|
||||
|
||||
- PHP 8.2 or later
|
||||
- Extensions: `hash`, `openssl`
|
||||
- Composer
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
composer require tecnickcom/tc-lib-pdf-encrypt
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Encrypting a string
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
require_once __DIR__ . '/vendor/autoload.php';
|
||||
|
||||
// AES-256 R6 (mode 4, recommended)
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(
|
||||
enabled: true,
|
||||
file_id: md5('unique-file-id'),
|
||||
mode: 4,
|
||||
permissions: ['print', 'copy'],
|
||||
user_pass: 'userpassword',
|
||||
owner_pass: 'ownerpassword',
|
||||
);
|
||||
|
||||
$cipher = $encrypt->encryptString('secret payload', $objectNumber = 1);
|
||||
echo bin2hex($cipher);
|
||||
```
|
||||
|
||||
### Decrypting a string
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
require_once __DIR__ . '/vendor/autoload.php';
|
||||
|
||||
// Pass the encryption dictionary produced by the Encrypt instance.
|
||||
$decrypt = new \Com\Tecnick\Pdf\Encrypt\Decrypt($encrypt->getEncryptionData());
|
||||
|
||||
if ($decrypt->authenticate('userpassword')) {
|
||||
// For AES modes the PKCS#7 padding is stripped automatically, so the
|
||||
// exact original plaintext is returned. RC4 modes are symmetric.
|
||||
$plain = $decrypt->decryptString($cipher, $objectNumber = 1);
|
||||
echo $plain;
|
||||
}
|
||||
```
|
||||
|
||||
### OpenSSL 3 Note
|
||||
|
||||
On OpenSSL 3 systems, legacy providers may be disabled by default. Enable legacy support when required by your runtime policy.
|
||||
|
||||
---
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
make deps
|
||||
make help
|
||||
make qa
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Packaging
|
||||
|
||||
```bash
|
||||
make rpm
|
||||
make deb
|
||||
```
|
||||
|
||||
For system packages, bootstrap with:
|
||||
|
||||
```php
|
||||
require_once '/usr/share/php/Com/Tecnick/Pdf/Encrypt/autoload.php';
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome. Please review [CONTRIBUTING.md](CONTRIBUTING.md), [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md), and [SECURITY.md](SECURITY.md).
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
1
|
||||
@@ -0,0 +1,62 @@
|
||||
# Security Policy
|
||||
|
||||
This document describes the security policy for **tc-lib-pdf-encrypt**.
|
||||
|
||||
---
|
||||
|
||||
## Supported Versions
|
||||
|
||||
Security fixes are applied only to the **latest stable release** on the `main` branch.
|
||||
|
||||
We strongly recommend always running the latest release.
|
||||
|
||||
---
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
**Please do not open a public GitHub issue for security vulnerabilities.**
|
||||
|
||||
If you discover a security vulnerability — or suspect one — follow responsible disclosure:
|
||||
|
||||
1. **Email** the maintainer directly at **[info@tecnick.com](mailto:info@tecnick.com)** with the subject line:
|
||||
`[SECURITY] tc-lib-pdf-encrypt – <brief description>`
|
||||
2. Include as much detail as possible (see [What to include](#what-to-include) below).
|
||||
3. You will receive an acknowledgement as soon as possible.
|
||||
4. We will work on a fix or mitigation as promptly as the complexity of the issue allows.
|
||||
|
||||
If you do not receive a timely response, please follow up by replying to the same email thread.
|
||||
|
||||
---
|
||||
|
||||
## What to Include
|
||||
|
||||
A high-quality report helps us triage and fix issues faster. Please provide:
|
||||
|
||||
- **Description** — a clear summary of the vulnerability and its potential impact.
|
||||
- **Affected component** — which class, method, or feature is involved (e.g., `HTML::render()`, font loading, image processing).
|
||||
- **Steps to reproduce** — a minimal, self-contained PHP script or unit test that demonstrates the issue.
|
||||
- **Expected vs. actual behaviour** — what you expected to happen and what actually happened.
|
||||
- **Environment** — PHP version, OS, library version (output of `composer show tecnickcom/tc-lib-pdf-encrypt`).
|
||||
- **CVE / CWE reference** (optional) — if you have already identified a relevant classification.
|
||||
- **Suggested fix** (optional) — a patch or proposed mitigation if you have one.
|
||||
|
||||
---
|
||||
|
||||
## Security Best Practices for Integrators
|
||||
|
||||
Integrators are responsible for sanitising input **before** passing it to the library. We recommend:
|
||||
|
||||
- **Validate and sanitise all user-supplied data**. Use a dedicated sanitiser when accepting content from end users.
|
||||
- **Keep dependencies up to date.** Run `composer update` regularly and monitor advisories via [Packagist Security Advisories](https://packagist.org/packages/tecnickcom/tc-lib-pdf-encrypt) or tools such as `composer audit`.
|
||||
- **Pin versions in production.** Use `composer.lock` and review changes on every update.
|
||||
|
||||
---
|
||||
|
||||
## Contact
|
||||
|
||||
| Channel | Details |
|
||||
|---------|---------|
|
||||
| Security email | [info@tecnick.com](mailto:info@tecnick.com) |
|
||||
| Project website | <https://tcpdf.org> |
|
||||
| GitHub repository | <https://github.com/tecnickcom/tc-lib-pdf-encrypt> |
|
||||
| Packagist | <https://packagist.org/packages/tecnickcom/tc-lib-pdf-encrypt> |
|
||||
@@ -0,0 +1 @@
|
||||
2.9.3
|
||||
@@ -0,0 +1,68 @@
|
||||
{
|
||||
"name": "tecnickcom/tc-lib-pdf-encrypt",
|
||||
"description": "PHP library to encrypt data for PDF",
|
||||
"type": "library",
|
||||
"homepage": "https://tcpdf.org",
|
||||
"license": "LGPL-3.0-or-later",
|
||||
"keywords": [
|
||||
"tc-lib-pdf-encrypt",
|
||||
"PDF",
|
||||
"encrypt",
|
||||
"encryption",
|
||||
"AES",
|
||||
"RC4"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Nicola Asuni",
|
||||
"email": "info@tecnick.com",
|
||||
"role": "lead"
|
||||
}
|
||||
],
|
||||
"funding": [
|
||||
{
|
||||
"type": "github",
|
||||
"url": "https://github.com/sponsors/tecnickcom"
|
||||
}
|
||||
],
|
||||
"require": {
|
||||
"php": ">=8.2",
|
||||
"ext-hash": "*",
|
||||
"ext-openssl": "*",
|
||||
"ext-pcre": "*"
|
||||
},
|
||||
"suggest": {
|
||||
"ext-posix": "Adds the process id to the random seed material"
|
||||
},
|
||||
"minimum-stability": "stable",
|
||||
"prefer-stable": true,
|
||||
"require-dev": {
|
||||
"pdepend/pdepend": "^2.16",
|
||||
"phpunit/phpunit": "^11.5 || ^12.5 || ^13.2"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Com\\Tecnick\\Pdf\\Encrypt\\": "src"
|
||||
}
|
||||
},
|
||||
"autoload-dev": {
|
||||
"psr-4": {
|
||||
"Test\\": "test"
|
||||
}
|
||||
},
|
||||
"support": {
|
||||
"issues": "https://github.com/tecnickcom/tc-lib-pdf-encrypt/issues",
|
||||
"source": "https://github.com/tecnickcom/tc-lib-pdf-encrypt"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "@php -d xdebug.mode=coverage vendor/bin/phpunit --stderr test",
|
||||
"analyse": ["@analyse:src", "@analyse:test"],
|
||||
"analyse:src": "mago --config mago.src.toml analyze src",
|
||||
"analyse:test": "mago --config mago.test.toml analyze test",
|
||||
"cs-check": ["@cs-check:src", "@cs-check:test"],
|
||||
"cs-check:src": "mago --config mago.src.toml lint src",
|
||||
"cs-check:test": "mago --config mago.test.toml lint test",
|
||||
"cs-fix": "mago fmt src test",
|
||||
"qa": ["@cs-check", "@analyse", "@test"]
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,56 @@
|
||||
#:schema https://mago.carthage.software/1.43.0/schema.json
|
||||
version = "1"
|
||||
php-version = "8.2.0"
|
||||
|
||||
[source]
|
||||
workspace = "."
|
||||
paths = ["src"]
|
||||
includes = ["vendor"]
|
||||
excludes = []
|
||||
|
||||
[source.glob]
|
||||
literal-separator = true
|
||||
|
||||
[formatter]
|
||||
print-width = 120
|
||||
tab-width = 4
|
||||
use-tabs = false
|
||||
|
||||
[linter]
|
||||
integrations = []
|
||||
|
||||
[linter.rules]
|
||||
ambiguous-function-call = { enabled = false }
|
||||
literal-named-argument = { enabled = false }
|
||||
cyclomatic-complexity = { enabled = false }
|
||||
excessive-parameter-list = { enabled = true, threshold = 10 }
|
||||
halstead = { enabled = true, effort-threshold = 7000 }
|
||||
identity-comparison = { enabled = true }
|
||||
kan-defect = { enabled = false }
|
||||
no-boolean-flag-parameter = { enabled = false }
|
||||
no-else-clause = { enabled = false }
|
||||
no-empty = { enabled = true }
|
||||
too-many-methods = { enabled = false }
|
||||
no-isset = { enabled = true, allow-array-checks = true }
|
||||
|
||||
[analyzer]
|
||||
plugins = []
|
||||
find-unused-definitions = true
|
||||
find-unused-expressions = true
|
||||
analyze-dead-code = true
|
||||
memoize-properties = true
|
||||
check-throws = true
|
||||
unchecked-exceptions = [
|
||||
"Error",
|
||||
"LogicException",
|
||||
"ReflectionException",
|
||||
]
|
||||
unchecked-exception-classes = []
|
||||
check-missing-override = true
|
||||
find-unused-parameters = true
|
||||
strict-list-index-checks = true
|
||||
strict-array-index-existence = true
|
||||
allow-array-truthy-operand = false
|
||||
no-boolean-literal-comparison = true
|
||||
check-missing-type-hints = true
|
||||
register-super-globals = true
|
||||
@@ -0,0 +1,66 @@
|
||||
#:schema https://mago.carthage.software/1.43.0/schema.json
|
||||
version = "1"
|
||||
php-version = "8.2.0"
|
||||
|
||||
[source]
|
||||
workspace = "."
|
||||
paths = ["src", "test"]
|
||||
includes = ["vendor"]
|
||||
excludes = []
|
||||
|
||||
[source.glob]
|
||||
literal-separator = true
|
||||
|
||||
[formatter]
|
||||
print-width = 120
|
||||
tab-width = 4
|
||||
use-tabs = false
|
||||
|
||||
[linter]
|
||||
integrations = ["phpunit"]
|
||||
|
||||
[linter.rules]
|
||||
ambiguous-function-call = { enabled = false }
|
||||
literal-named-argument = { enabled = false }
|
||||
assertion-style = { enabled = false }
|
||||
cyclomatic-complexity = { enabled = false }
|
||||
excessive-parameter-list = { enabled = false }
|
||||
halstead = { enabled = false, effort-threshold = 7000 }
|
||||
identity-comparison = { enabled = false }
|
||||
kan-defect = { enabled = false }
|
||||
no-boolean-flag-parameter = { enabled = false }
|
||||
no-else-clause = { enabled = false }
|
||||
no-empty = { enabled = false }
|
||||
no-empty-catch-clause = { enabled = false }
|
||||
no-isset = { enabled = false }
|
||||
readable-literal = { enabled = false }
|
||||
str-contains = { enabled = false }
|
||||
strict-assertions = { enabled = false }
|
||||
strict-behavior = { enabled = false }
|
||||
strict-types = { enabled = false }
|
||||
too-many-methods = { enabled = false }
|
||||
|
||||
[analyzer]
|
||||
plugins = []
|
||||
find-unused-definitions = true
|
||||
find-unused-expressions = true
|
||||
analyze-dead-code = true
|
||||
memoize-properties = true
|
||||
check-throws = false
|
||||
unchecked-exceptions = [
|
||||
"Error",
|
||||
"LogicException",
|
||||
"ReflectionException",
|
||||
"PHPUnit\\Framework\\Exception",
|
||||
"PHPUnit\\Framework\\ExpectationFailedException",
|
||||
"PHPUnit\\Framework\\UnknownClassOrInterfaceException",
|
||||
]
|
||||
unchecked-exception-classes = []
|
||||
check-missing-override = true
|
||||
find-unused-parameters = true
|
||||
strict-list-index-checks = true
|
||||
strict-array-index-existence = true
|
||||
allow-array-truthy-operand = false
|
||||
no-boolean-literal-comparison = true
|
||||
check-missing-type-hints = true
|
||||
register-super-globals = true
|
||||
+400
@@ -0,0 +1,400 @@
|
||||
#
|
||||
# OpenSSL example configuration file.
|
||||
# See doc/man5/config.pod for more info.
|
||||
#
|
||||
# This is mostly being used for generation of certificate requests,
|
||||
# but may be used for auto loading of providers
|
||||
|
||||
# Note that you can include other files from the main configuration
|
||||
# file using the .include directive.
|
||||
#.include filename
|
||||
|
||||
# This definition stops the following lines choking if HOME isn't
|
||||
# defined.
|
||||
HOME = .
|
||||
|
||||
# Use this in order to automatically load providers.
|
||||
openssl_conf = openssl_init
|
||||
|
||||
# Comment out the next line to ignore configuration errors
|
||||
config_diagnostics = 1
|
||||
|
||||
# Extra OBJECT IDENTIFIER info:
|
||||
# oid_file = $ENV::HOME/.oid
|
||||
oid_section = new_oids
|
||||
|
||||
# To use this configuration file with the "-extfile" option of the
|
||||
# "openssl x509" utility, name here the section containing the
|
||||
# X.509v3 extensions to use:
|
||||
# extensions =
|
||||
# (Alternatively, use a configuration file that has only
|
||||
# X.509v3 extensions in its main [= default] section.)
|
||||
|
||||
[ new_oids ]
|
||||
# We can add new OIDs in here for use by 'ca', 'req' and 'ts'.
|
||||
# Add a simple OID like this:
|
||||
# testoid1=1.2.3.4
|
||||
# Or use config file substitution like this:
|
||||
# testoid2=${testoid1}.5.6
|
||||
|
||||
# Policies used by the TSA examples.
|
||||
tsa_policy1 = 1.2.3.4.1
|
||||
tsa_policy2 = 1.2.3.4.5.6
|
||||
tsa_policy3 = 1.2.3.4.5.7
|
||||
|
||||
# For FIPS
|
||||
# Optionally include a file that is generated by the OpenSSL fipsinstall
|
||||
# application. This file contains configuration data required by the OpenSSL
|
||||
# fips provider. It contains a named section e.g. [fips_sect] which is
|
||||
# referenced from the [provider_sect] below.
|
||||
# Refer to the OpenSSL security policy for more information.
|
||||
# .include fipsmodule.cnf
|
||||
|
||||
[openssl_init]
|
||||
providers = provider_sect
|
||||
ssl_conf = ssl_sect
|
||||
|
||||
# List of providers to load
|
||||
[provider_sect]
|
||||
default = default_sect
|
||||
legacy = legacy_sect
|
||||
# The fips section name should match the section name inside the
|
||||
# included fipsmodule.cnf.
|
||||
# fips = fips_sect
|
||||
|
||||
# If no providers are activated explicitly, the default one is activated implicitly.
|
||||
# See man 7 OSSL_PROVIDER-default for more details.
|
||||
#
|
||||
# If you add a section explicitly activating any other provider(s), you most
|
||||
# probably need to explicitly activate the default provider, otherwise it
|
||||
# becomes unavailable in openssl. As a consequence applications depending on
|
||||
# OpenSSL may not work correctly which could lead to significant system
|
||||
# problems including inability to remotely access the system.
|
||||
[default_sect]
|
||||
activate = 1
|
||||
|
||||
[legacy_sect]
|
||||
activate = 1
|
||||
|
||||
####################################################################
|
||||
[ ca ]
|
||||
default_ca = CA_default # The default ca section
|
||||
|
||||
####################################################################
|
||||
[ CA_default ]
|
||||
|
||||
dir = ./demoCA # Where everything is kept
|
||||
certs = $dir/certs # Where the issued certs are kept
|
||||
crl_dir = $dir/crl # Where the issued crl are kept
|
||||
database = $dir/index.txt # database index file.
|
||||
#unique_subject = no # Set to 'no' to allow creation of
|
||||
# several certs with same subject.
|
||||
new_certs_dir = $dir/newcerts # default place for new certs.
|
||||
|
||||
certificate = $dir/cacert.pem # The CA certificate
|
||||
serial = $dir/serial # The current serial number
|
||||
crlnumber = $dir/crlnumber # the current crl number
|
||||
# must be commented out to leave a V1 CRL
|
||||
crl = $dir/crl.pem # The current CRL
|
||||
private_key = $dir/private/cakey.pem# The private key
|
||||
|
||||
x509_extensions = usr_cert # The extensions to add to the cert
|
||||
|
||||
# Comment out the following two lines for the "traditional"
|
||||
# (and highly broken) format.
|
||||
name_opt = ca_default # Subject Name options
|
||||
cert_opt = ca_default # Certificate field options
|
||||
|
||||
# Extension copying option: use with caution.
|
||||
# copy_extensions = copy
|
||||
|
||||
# Extensions to add to a CRL. Note: Netscape communicator chokes on V2 CRLs
|
||||
# so this is commented out by default to leave a V1 CRL.
|
||||
# crlnumber must also be commented out to leave a V1 CRL.
|
||||
# crl_extensions = crl_ext
|
||||
|
||||
default_days = 365 # how long to certify for
|
||||
default_crl_days= 30 # how long before next CRL
|
||||
default_md = default # use public key default MD
|
||||
preserve = no # keep passed DN ordering
|
||||
|
||||
# A few difference way of specifying how similar the request should look
|
||||
# For type CA, the listed attributes must be the same, and the optional
|
||||
# and supplied fields are just that :-)
|
||||
policy = policy_match
|
||||
|
||||
# For the CA policy
|
||||
[ policy_match ]
|
||||
countryName = match
|
||||
stateOrProvinceName = match
|
||||
organizationName = match
|
||||
organizationalUnitName = optional
|
||||
commonName = supplied
|
||||
emailAddress = optional
|
||||
|
||||
# For the 'anything' policy
|
||||
# At this point in time, you must list all acceptable 'object'
|
||||
# types.
|
||||
[ policy_anything ]
|
||||
countryName = optional
|
||||
stateOrProvinceName = optional
|
||||
localityName = optional
|
||||
organizationName = optional
|
||||
organizationalUnitName = optional
|
||||
commonName = supplied
|
||||
emailAddress = optional
|
||||
|
||||
####################################################################
|
||||
[ req ]
|
||||
default_bits = 2048
|
||||
default_keyfile = privkey.pem
|
||||
distinguished_name = req_distinguished_name
|
||||
attributes = req_attributes
|
||||
x509_extensions = v3_ca # The extensions to add to the self signed cert
|
||||
|
||||
# Passwords for private keys if not present they will be prompted for
|
||||
# input_password = secret
|
||||
# output_password = secret
|
||||
|
||||
# This sets a mask for permitted string types. There are several options.
|
||||
# default: PrintableString, T61String, BMPString.
|
||||
# pkix : PrintableString, BMPString (PKIX recommendation before 2004)
|
||||
# utf8only: only UTF8Strings (PKIX recommendation after 2004).
|
||||
# nombstr : PrintableString, T61String (no BMPStrings or UTF8Strings).
|
||||
# MASK:XXXX a literal mask value.
|
||||
# WARNING: ancient versions of Netscape crash on BMPStrings or UTF8Strings.
|
||||
string_mask = utf8only
|
||||
|
||||
# req_extensions = v3_req # The extensions to add to a certificate request
|
||||
|
||||
[ req_distinguished_name ]
|
||||
countryName = Country Name (2 letter code)
|
||||
countryName_default = AU
|
||||
countryName_min = 2
|
||||
countryName_max = 2
|
||||
|
||||
stateOrProvinceName = State or Province Name (full name)
|
||||
stateOrProvinceName_default = Some-State
|
||||
|
||||
localityName = Locality Name (eg, city)
|
||||
|
||||
0.organizationName = Organization Name (eg, company)
|
||||
0.organizationName_default = Internet Widgits Pty Ltd
|
||||
|
||||
# we can do this but it is not needed normally :-)
|
||||
#1.organizationName = Second Organization Name (eg, company)
|
||||
#1.organizationName_default = World Wide Web Pty Ltd
|
||||
|
||||
organizationalUnitName = Organizational Unit Name (eg, section)
|
||||
#organizationalUnitName_default =
|
||||
|
||||
commonName = Common Name (e.g. server FQDN or YOUR name)
|
||||
commonName_max = 64
|
||||
|
||||
emailAddress = Email Address
|
||||
emailAddress_max = 64
|
||||
|
||||
# SET-ex3 = SET extension number 3
|
||||
|
||||
[ req_attributes ]
|
||||
challengePassword = A challenge password
|
||||
challengePassword_min = 4
|
||||
challengePassword_max = 20
|
||||
|
||||
unstructuredName = An optional company name
|
||||
|
||||
[ usr_cert ]
|
||||
|
||||
# These extensions are added when 'ca' signs a request.
|
||||
|
||||
# This goes against PKIX guidelines but some CAs do it and some software
|
||||
# requires this to avoid interpreting an end user certificate as a CA.
|
||||
|
||||
basicConstraints=CA:FALSE
|
||||
|
||||
# This is typical in keyUsage for a client certificate.
|
||||
# keyUsage = nonRepudiation, digitalSignature, keyEncipherment
|
||||
|
||||
# PKIX recommendations harmless if included in all certificates.
|
||||
subjectKeyIdentifier=hash
|
||||
authorityKeyIdentifier=keyid,issuer
|
||||
|
||||
# This stuff is for subjectAltName and issuerAltname.
|
||||
# Import the email address.
|
||||
# subjectAltName=email:copy
|
||||
# An alternative to produce certificates that aren't
|
||||
# deprecated according to PKIX.
|
||||
# subjectAltName=email:move
|
||||
|
||||
# Copy subject details
|
||||
# issuerAltName=issuer:copy
|
||||
|
||||
# This is required for TSA certificates.
|
||||
# extendedKeyUsage = critical,timeStamping
|
||||
|
||||
[ v3_req ]
|
||||
|
||||
# Extensions to add to a certificate request
|
||||
|
||||
basicConstraints = CA:FALSE
|
||||
keyUsage = nonRepudiation, digitalSignature, keyEncipherment
|
||||
|
||||
[ v3_ca ]
|
||||
|
||||
|
||||
# Extensions for a typical CA
|
||||
|
||||
|
||||
# PKIX recommendation.
|
||||
|
||||
subjectKeyIdentifier=hash
|
||||
|
||||
authorityKeyIdentifier=keyid:always,issuer
|
||||
|
||||
basicConstraints = critical,CA:true
|
||||
|
||||
# Key usage: this is typical for a CA certificate. However since it will
|
||||
# prevent it being used as an test self-signed certificate it is best
|
||||
# left out by default.
|
||||
# keyUsage = cRLSign, keyCertSign
|
||||
|
||||
# Include email address in subject alt name: another PKIX recommendation
|
||||
# subjectAltName=email:copy
|
||||
# Copy issuer details
|
||||
# issuerAltName=issuer:copy
|
||||
|
||||
# DER hex encoding of an extension: beware experts only!
|
||||
# obj=DER:02:03
|
||||
# Where 'obj' is a standard or added object
|
||||
# You can even override a supported extension:
|
||||
# basicConstraints= critical, DER:30:03:01:01:FF
|
||||
|
||||
[ crl_ext ]
|
||||
|
||||
# CRL extensions.
|
||||
# Only issuerAltName and authorityKeyIdentifier make any sense in a CRL.
|
||||
|
||||
# issuerAltName=issuer:copy
|
||||
authorityKeyIdentifier=keyid:always
|
||||
|
||||
[ proxy_cert_ext ]
|
||||
# These extensions should be added when creating a proxy certificate
|
||||
|
||||
# This goes against PKIX guidelines but some CAs do it and some software
|
||||
# requires this to avoid interpreting an end user certificate as a CA.
|
||||
|
||||
basicConstraints=CA:FALSE
|
||||
|
||||
# This is typical in keyUsage for a client certificate.
|
||||
# keyUsage = nonRepudiation, digitalSignature, keyEncipherment
|
||||
|
||||
# PKIX recommendations harmless if included in all certificates.
|
||||
subjectKeyIdentifier=hash
|
||||
authorityKeyIdentifier=keyid,issuer
|
||||
|
||||
# This stuff is for subjectAltName and issuerAltname.
|
||||
# Import the email address.
|
||||
# subjectAltName=email:copy
|
||||
# An alternative to produce certificates that aren't
|
||||
# deprecated according to PKIX.
|
||||
# subjectAltName=email:move
|
||||
|
||||
# Copy subject details
|
||||
# issuerAltName=issuer:copy
|
||||
|
||||
# This really needs to be in place for it to be a proxy certificate.
|
||||
proxyCertInfo=critical,language:id-ppl-anyLanguage,pathlen:3,policy:foo
|
||||
|
||||
####################################################################
|
||||
[ tsa ]
|
||||
|
||||
default_tsa = tsa_config1 # the default TSA section
|
||||
|
||||
[ tsa_config1 ]
|
||||
|
||||
# These are used by the TSA reply generation only.
|
||||
dir = ./demoCA # TSA root directory
|
||||
serial = $dir/tsaserial # The current serial number (mandatory)
|
||||
crypto_device = builtin # OpenSSL engine to use for signing
|
||||
signer_cert = $dir/tsacert.pem # The TSA signing certificate
|
||||
# (optional)
|
||||
certs = $dir/cacert.pem # Certificate chain to include in reply
|
||||
# (optional)
|
||||
signer_key = $dir/private/tsakey.pem # The TSA private key (optional)
|
||||
signer_digest = sha256 # Signing digest to use. (Optional)
|
||||
default_policy = tsa_policy1 # Policy if request did not specify it
|
||||
# (optional)
|
||||
other_policies = tsa_policy2, tsa_policy3 # acceptable policies (optional)
|
||||
digests = sha1, sha256, sha384, sha512 # Acceptable message digests (mandatory)
|
||||
accuracy = secs:1, millisecs:500, microsecs:100 # (optional)
|
||||
clock_precision_digits = 0 # number of digits after dot. (optional)
|
||||
ordering = yes # Is ordering defined for timestamps?
|
||||
# (optional, default: no)
|
||||
tsa_name = yes # Must the TSA name be included in the reply?
|
||||
# (optional, default: no)
|
||||
ess_cert_id_chain = no # Must the ESS cert id chain be included?
|
||||
# (optional, default: no)
|
||||
ess_cert_id_alg = sha1 # algorithm to compute certificate
|
||||
# identifier (optional, default: sha1)
|
||||
|
||||
[insta] # CMP using Insta Demo CA
|
||||
# Message transfer
|
||||
server = pki.certificate.fi:8700
|
||||
# proxy = # set this as far as needed, e.g., http://192.168.1.1:8080
|
||||
# tls_use = 0
|
||||
path = pkix/
|
||||
|
||||
# Server authentication
|
||||
recipient = "/C=FI/O=Insta Demo/CN=Insta Demo CA" # or set srvcert or issuer
|
||||
ignore_keyusage = 1 # potentially needed quirk
|
||||
unprotected_errors = 1 # potentially needed quirk
|
||||
extracertsout = insta.extracerts.pem
|
||||
|
||||
# Client authentication
|
||||
ref = 3078 # user identification
|
||||
secret = pass:insta # can be used for both client and server side
|
||||
|
||||
# Generic message options
|
||||
cmd = ir # default operation, can be overridden on cmd line with, e.g., kur
|
||||
|
||||
# Certificate enrollment
|
||||
subject = "/CN=openssl-cmp-test"
|
||||
newkey = insta.priv.pem
|
||||
out_trusted = insta.ca.crt
|
||||
certout = insta.cert.pem
|
||||
|
||||
[pbm] # Password-based protection for Insta CA
|
||||
# Server and client authentication
|
||||
ref = $insta::ref # 3078
|
||||
secret = $insta::secret # pass:insta
|
||||
|
||||
[signature] # Signature-based protection for Insta CA
|
||||
# Server authentication
|
||||
trusted = insta.ca.crt # does not include keyUsage digitalSignature
|
||||
|
||||
# Client authentication
|
||||
secret = # disable PBM
|
||||
key = $insta::newkey # insta.priv.pem
|
||||
cert = $insta::certout # insta.cert.pem
|
||||
|
||||
[ir]
|
||||
cmd = ir
|
||||
|
||||
[cr]
|
||||
cmd = cr
|
||||
|
||||
[kur]
|
||||
# Certificate update
|
||||
cmd = kur
|
||||
oldcert = $insta::certout # insta.cert.pem
|
||||
|
||||
[rr]
|
||||
# Certificate revocation
|
||||
cmd = rr
|
||||
oldcert = $insta::certout # insta.cert.pem
|
||||
|
||||
[ssl_sect]
|
||||
system_default = system_default_sect
|
||||
|
||||
[system_default_sect]
|
||||
CipherString = DEFAULT:@SECLEVEL=2
|
||||
@@ -0,0 +1,15 @@
|
||||
{
|
||||
"source-providers": [
|
||||
{
|
||||
"in": "src as source",
|
||||
"exclude": "vendor",
|
||||
"name": "/\\.(php)$/"
|
||||
}
|
||||
],
|
||||
"plugins": [
|
||||
],
|
||||
"analysers": [
|
||||
],
|
||||
"services": [
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,31 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<phpunit backupGlobals="false"
|
||||
bootstrap="vendor/autoload.php"
|
||||
colors="true"
|
||||
displayDetailsOnTestsThatTriggerDeprecations="true"
|
||||
displayDetailsOnTestsThatTriggerErrors="true"
|
||||
displayDetailsOnTestsThatTriggerNotices="true"
|
||||
displayDetailsOnTestsThatTriggerWarnings="true"
|
||||
displayDetailsOnPhpunitDeprecations="true"
|
||||
processIsolation="false"
|
||||
stopOnFailure="false">
|
||||
<testsuites>
|
||||
<testsuite name="tc-lib-pdf-encrypt Test Suite">
|
||||
<directory>./test</directory>
|
||||
</testsuite>
|
||||
</testsuites>
|
||||
<source>
|
||||
<include>
|
||||
<directory suffix=".php">src</directory>
|
||||
</include>
|
||||
</source>
|
||||
<coverage>
|
||||
<report>
|
||||
<clover outputFile="target/coverage/coverage.xml"/>
|
||||
<html outputDirectory="target/coverage" lowUpperBound="50" highLowerBound="90"/>
|
||||
</report>
|
||||
</coverage>
|
||||
<logging>
|
||||
<junit outputFile="target/logs/junit.xml"/>
|
||||
</logging>
|
||||
</phpunit>
|
||||
@@ -0,0 +1,30 @@
|
||||
<?php
|
||||
/**
|
||||
* autoload.php
|
||||
*
|
||||
* Autoloader for Tecnick.com libraries
|
||||
*
|
||||
* @since 2015-03-04
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
\spl_autoload_register(
|
||||
function ($class) {
|
||||
$prefix = 'Com\\Tecnick\\';
|
||||
$len = \strlen($prefix);
|
||||
if (\strncmp($prefix, $class, $len) !== 0) {
|
||||
return;
|
||||
}
|
||||
$relative_class = \substr($class, $len);
|
||||
$file = \dirname(\dirname(__DIR__)).'/'.\str_replace('\\', '/', $relative_class).'.php';
|
||||
if (\file_exists($file)) {
|
||||
require $file;
|
||||
}
|
||||
}
|
||||
);
|
||||
@@ -0,0 +1,7 @@
|
||||
~#PKGNAME#~ (~#VERSION#~-~#RELEASE#~) UNRELEASED; urgency=low
|
||||
|
||||
* Please check the
|
||||
https://github.com/~#VENDOR#~/~#PROJECT#~
|
||||
commit history
|
||||
|
||||
-- Nicola Asuni <info@tecnick.com> ~#DATE#~
|
||||
@@ -0,0 +1,18 @@
|
||||
Source: ~#PKGNAME#~
|
||||
Maintainer: Nicola Asuni <info@tecnick.com>
|
||||
Section: php
|
||||
Priority: optional
|
||||
Build-Depends: debhelper-compat (= 13)
|
||||
Standards-Version: 4.7.2
|
||||
Rules-Requires-Root: no
|
||||
Homepage: https://github.com/~#VENDOR#~/~#PROJECT#~
|
||||
Vcs-Git: https://github.com/~#VENDOR#~/~#PROJECT#~.git
|
||||
Vcs-Browser: https://github.com/~#VENDOR#~/~#PROJECT#~
|
||||
|
||||
Package: ~#PKGNAME#~
|
||||
Provides: php-~#PROJECT#~
|
||||
Architecture: all
|
||||
Depends: php (>= 8.2.0), ${misc:Depends}
|
||||
Recommends: php-posix
|
||||
Description: PHP PDF Encrypt Library
|
||||
PHP library to encrypt data for PDF.
|
||||
@@ -0,0 +1,20 @@
|
||||
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
|
||||
Upstream-Name: ~#PROJECT#~
|
||||
Source: https://github.com/~#VENDOR#~/~#PROJECT#~
|
||||
|
||||
Files: *
|
||||
Copyright: Copyright 2001-2026 Nicola Asuni <info@tecnick.com>
|
||||
License: LGPL-3
|
||||
|
||||
License: LGPL-3
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Lesser General Public License as
|
||||
published by the Free Software Foundation, either version 3 of the
|
||||
License, or (at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/> or
|
||||
/usr/share/common-licenses/LGPL-3
|
||||
@@ -0,0 +1,3 @@
|
||||
#!/usr/bin/make -f
|
||||
%:
|
||||
dh $@
|
||||
@@ -0,0 +1 @@
|
||||
3.0 (quilt)
|
||||
@@ -0,0 +1,4 @@
|
||||
version=4
|
||||
opts=filenamemangle=s/.+\/v?(\d[\d\.]+)\.tar\.gz/~#PKGNAME#~_$1.orig.tar.gz/ \
|
||||
https://github.com/~#VENDOR#~/~#PROJECT#~/tags \
|
||||
.*/archive/refs/tags/v?(\d[\d\.]*)\.tar\.gz
|
||||
@@ -0,0 +1,46 @@
|
||||
# SPEC file
|
||||
|
||||
%global c_vendor %{_vendor}
|
||||
%global gh_owner %{_owner}
|
||||
%global gh_project %{_project}
|
||||
|
||||
Name: %{_package}
|
||||
Version: %{_version}
|
||||
Release: %{_release}%{?dist}
|
||||
Summary: PHP library to encrypt data for PDF
|
||||
|
||||
License: LGPLv3+
|
||||
URL: https://github.com/%{gh_owner}/%{gh_project}
|
||||
|
||||
BuildArch: noarch
|
||||
|
||||
Requires: php(language) >= 8.2.0
|
||||
Requires: php-date
|
||||
Requires: php-hash
|
||||
Requires: php-openssl
|
||||
Requires: php-pcre
|
||||
|
||||
Recommends: php-posix
|
||||
|
||||
Provides: php-composer(%{c_vendor}/%{gh_project}) = %{version}
|
||||
Provides: php-%{gh_project} = %{version}
|
||||
|
||||
%description
|
||||
PHP library to encrypt data for PDF
|
||||
|
||||
%build
|
||||
#(cd %{_current_directory} && make build)
|
||||
|
||||
%install
|
||||
rm -rf "%{buildroot}"
|
||||
(cd "%{_current_directory}" && make install DESTDIR="%{buildroot}")
|
||||
|
||||
%files
|
||||
%attr(-,root,root) %{_libpath}
|
||||
%attr(-,root,root) %{_docpath}
|
||||
%docdir %{_docpath}
|
||||
# Optional config files can be listed here when used by a project.
|
||||
|
||||
%changelog
|
||||
* Wed Sep 23 2026 Nicola Asuni <info@tecnick.com> 1.0.0-1
|
||||
- Initial Commit
|
||||
@@ -0,0 +1,706 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Compute.php
|
||||
*
|
||||
* @since 2008-01-02
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Pdf\Encrypt;
|
||||
|
||||
use Com\Tecnick\Pdf\Encrypt\Exception as EncException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Pdf\Encrypt\Compute
|
||||
*
|
||||
* PHP class to generate encryption data
|
||||
*
|
||||
* @since 2008-01-02
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* @SuppressWarnings("PHPMD.ExcessiveClassComplexity")
|
||||
*/
|
||||
abstract class Compute extends \Com\Tecnick\Pdf\Encrypt\Data
|
||||
{
|
||||
/**
|
||||
* Encrypt data using the specified encrypt type.
|
||||
*
|
||||
* @param int|string|false $type Encrypt type.
|
||||
* @param string $data Data string to encrypt.
|
||||
* @param string $key Encryption key.
|
||||
* @param int $objnum Object number.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function encrypt(int|string|false $type, string $data = '', string $key = '', int $objnum = 0): string
|
||||
{
|
||||
if (!$this->encryptdata['encrypted'] || $type === false) {
|
||||
return $data;
|
||||
}
|
||||
|
||||
$encoder = self::ENCMAP[$type] ?? null;
|
||||
if ($encoder === null) {
|
||||
throw new EncException('unknown encryption type: ' . $type);
|
||||
}
|
||||
|
||||
if ($key === '' && $type === $this->encryptdata['mode']) {
|
||||
if ($this->encryptdata['mode'] < 3) {
|
||||
$key = $this->getObjectKey($objnum);
|
||||
}
|
||||
|
||||
if ($this->encryptdata['mode'] >= 3) { // mode >= 3: AES-256 (R5 or R6), use the full document key
|
||||
$key = $this->encryptdata['key'];
|
||||
}
|
||||
}
|
||||
|
||||
return $this->encryptWithEncoderName($encoder, $data, $key);
|
||||
}
|
||||
|
||||
/**
|
||||
* Dispatch to a concrete encryptor class for static analyzers.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function encryptWithEncoderName(string $encoder, string $data, string $key): string
|
||||
{
|
||||
return match ($encoder) {
|
||||
'RCFourFive' => $this->encryptWithRCFourFive($data, $key),
|
||||
'RCFourSixteen' => $this->encryptWithRCFourSixteen($data, $key),
|
||||
'AESSixteen' => $this->encryptWithAESSixteen($data, $key),
|
||||
'AESThirtytwo' => $this->encryptWithAESThirtytwo($data, $key),
|
||||
'RCFour' => $this->encryptWithRCFour($data, $key),
|
||||
'AES' => $this->encryptWithAES($data, $key),
|
||||
'AESnopad' => $this->encryptWithAESnopad($data, $key),
|
||||
'MDFiveSixteen' => $this->encryptWithMDFiveSixteen($data, $key),
|
||||
'Seed' => $this->encryptSeed($data, $key),
|
||||
default => throw new EncException('unknown encryption type: ' . $encoder),
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function encryptWithRCFourFive(string $data, string $key): string
|
||||
{
|
||||
$enc = new \Com\Tecnick\Pdf\Encrypt\Type\RCFourFive();
|
||||
return $enc->encrypt($data, $key);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function encryptWithRCFourSixteen(string $data, string $key): string
|
||||
{
|
||||
$enc = new \Com\Tecnick\Pdf\Encrypt\Type\RCFourSixteen();
|
||||
return $enc->encrypt($data, $key);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function encryptWithAESSixteen(string $data, string $key): string
|
||||
{
|
||||
$enc = new \Com\Tecnick\Pdf\Encrypt\Type\AESSixteen();
|
||||
return $enc->encrypt($data, $key);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function encryptWithAESThirtytwo(string $data, string $key): string
|
||||
{
|
||||
$enc = new \Com\Tecnick\Pdf\Encrypt\Type\AESThirtytwo();
|
||||
return $enc->encrypt($data, $key);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function encryptWithRCFour(string $data, string $key): string
|
||||
{
|
||||
$enc = new \Com\Tecnick\Pdf\Encrypt\Type\RCFour();
|
||||
return $enc->encrypt($data, $key);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function encryptWithAES(string $data, string $key): string
|
||||
{
|
||||
$enc = new \Com\Tecnick\Pdf\Encrypt\Type\AES();
|
||||
return $enc->encrypt($data, $key);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function encryptWithAESnopad(string $data, string $key): string
|
||||
{
|
||||
$enc = new \Com\Tecnick\Pdf\Encrypt\Type\AESnopad();
|
||||
return $enc->encrypt($data, $key);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function encryptWithMDFiveSixteen(string $data, string $key): string
|
||||
{
|
||||
$enc = new \Com\Tecnick\Pdf\Encrypt\Type\MDFiveSixteen();
|
||||
return $enc->encrypt($data, $key);
|
||||
}
|
||||
|
||||
/**
|
||||
* Encrypt using the Seed generator and normalize random errors.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function encryptSeed(string $data, string $key): string
|
||||
{
|
||||
try {
|
||||
$enc = new \Com\Tecnick\Pdf\Encrypt\Type\Seed();
|
||||
return $enc->encrypt($data, $key);
|
||||
} catch (\Random\RandomException $e) {
|
||||
throw new EncException('Unable to generate random seed', 0, $e);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Compute encryption key depending on object number where the encrypted data is stored.
|
||||
* This is used for all strings and streams without crypt filter specifier.
|
||||
*
|
||||
* @param int $objnum Object number.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function getObjectKey(int $objnum): string
|
||||
{
|
||||
$objkey = $this->encryptdata['key'] . \pack('VXxx', $objnum);
|
||||
if ($this->encryptdata['mode'] === 2) {
|
||||
// AES-128 padding
|
||||
$objkey .= "\x73\x41\x6C\x54"; // sAlT
|
||||
}
|
||||
|
||||
$objkey = \substr($this->encrypt('MD5-16', $objkey, 'H*'), 0, (int) (($this->encryptdata['Length'] / 8) + 5));
|
||||
return \substr($objkey, 0, 16);
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert encryption P value to a string of bytes, low-order byte first.
|
||||
*
|
||||
* @param int $protection 32bit encryption permission value (P value).
|
||||
*/
|
||||
public function getEncPermissionsString(int $protection): string
|
||||
{
|
||||
$binprot = \sprintf('%032b', $protection);
|
||||
return (
|
||||
\chr((int) \bindec(\substr($binprot, 24, 8)) & 0xFF)
|
||||
. \chr((int) \bindec(\substr($binprot, 16, 8)) & 0xFF)
|
||||
. \chr((int) \bindec(\substr($binprot, 8, 8)) & 0xFF)
|
||||
. \chr((int) \bindec(\substr($binprot, 0, 8)) & 0xFF)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the permission code used on encryption (P value).
|
||||
*
|
||||
* @param array<string> $permissions The set of permissions (specify the ones you want to block).
|
||||
* @param int $mode Encryption strength: 0 = RC4-40 (deprecated); 1 = RC4-128 (deprecated);
|
||||
* 2 = AES-128; 3 = AES-256 R5; 4 = AES-256 R6 (PDF 2.0 / ISO 32000-2).
|
||||
*/
|
||||
public function getUserPermissionCode(array $permissions, int $mode = 0): int
|
||||
{
|
||||
$protection = 2_147_422_012; // 32 bit: (01111111 11111111 00001111 00111100)
|
||||
foreach ($permissions as $permission) {
|
||||
$permBit = self::PERMBITS[$permission] ?? null;
|
||||
if ($permBit === null) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($mode <= 0 && $permBit > 32) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// set only valid permissions
|
||||
if ($permBit === 2) {
|
||||
// the logic for bit 2 is inverted (cleared by default)
|
||||
$protection += $permBit;
|
||||
continue;
|
||||
}
|
||||
|
||||
$protection -= $permBit;
|
||||
}
|
||||
|
||||
return $protection;
|
||||
}
|
||||
|
||||
/**
|
||||
* Compute UE value
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function getUEValue(): string
|
||||
{
|
||||
if ($this->encryptdata['mode'] === 4) { // R6: use Algorithm 2.B
|
||||
return $this->encrypt(
|
||||
'AESnopad',
|
||||
$this->encryptdata['key'],
|
||||
$this->hash2B($this->encryptdata['user_password'], $this->encryptdata['UKS']),
|
||||
);
|
||||
}
|
||||
|
||||
return $this->encrypt(
|
||||
'AESnopad',
|
||||
$this->encryptdata['key'],
|
||||
\hash('sha256', $this->encryptdata['user_password'] . $this->encryptdata['UKS'], true),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Compute OE value
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function getOEValue(): string
|
||||
{
|
||||
if ($this->encryptdata['mode'] === 4) { // R6: use Algorithm 2.B
|
||||
return $this->encrypt(
|
||||
'AESnopad',
|
||||
$this->encryptdata['key'],
|
||||
$this->hash2B($this->encryptdata['owner_password'], $this->encryptdata['OKS'], $this->encryptdata['U']),
|
||||
);
|
||||
}
|
||||
|
||||
return $this->encrypt(
|
||||
'AESnopad',
|
||||
$this->encryptdata['key'],
|
||||
\hash(
|
||||
'sha256',
|
||||
$this->encryptdata['owner_password'] . $this->encryptdata['OKS'] . $this->encryptdata['U'],
|
||||
true,
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Compute U value
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function getUValue(): string
|
||||
{
|
||||
if ($this->encryptdata['mode'] === 0) { // RC4-40
|
||||
return $this->encrypt('RC4', self::ENCPAD, $this->encryptdata['key']);
|
||||
}
|
||||
|
||||
if ($this->encryptdata['mode'] < 3) { // RC4-128, AES-128
|
||||
$tmp = $this->encrypt('MD5-16', self::ENCPAD . $this->encryptdata['fileid'], 'H*');
|
||||
$enc = $this->encrypt('RC4', $tmp, $this->encryptdata['key']);
|
||||
$len = \strlen($tmp);
|
||||
for ($idx = 1; $idx <= 19; ++$idx) {
|
||||
$ekey = '';
|
||||
for ($jdx = 0; $jdx < $len; ++$jdx) {
|
||||
$ekey .= \chr((\ord($this->encryptdata['key'][$jdx]) ^ $idx) & 0xFF);
|
||||
}
|
||||
|
||||
$enc = $this->encrypt('RC4', $enc, $ekey);
|
||||
}
|
||||
|
||||
$enc .= \str_repeat("\x00", 16);
|
||||
return \substr($enc, 0, 32);
|
||||
}
|
||||
|
||||
// AES-256 ($this->encryptdata['mode'] >= 3)
|
||||
return $this->getUValueAes256();
|
||||
}
|
||||
|
||||
/**
|
||||
* Compute O value
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function getOValue(): string
|
||||
{
|
||||
if ($this->encryptdata['mode'] < 3) { // RC4-40, RC4-128, AES-128
|
||||
$tmp = $this->encrypt('MD5-16', $this->encryptdata['owner_password'], 'H*');
|
||||
if ($this->encryptdata['mode'] > 0) {
|
||||
for ($idx = 0; $idx < 50; ++$idx) {
|
||||
$tmp = $this->encrypt('MD5-16', $tmp, 'H*');
|
||||
}
|
||||
}
|
||||
|
||||
$owner_key = \substr($tmp, 0, (int) ($this->encryptdata['Length'] / 8));
|
||||
$enc = $this->encrypt('RC4', $this->encryptdata['user_password'], $owner_key);
|
||||
if ($this->encryptdata['mode'] > 0) {
|
||||
$len = \strlen($owner_key);
|
||||
for ($idx = 1; $idx <= 19; ++$idx) {
|
||||
$ekey = '';
|
||||
for ($jdx = 0; $jdx < $len; ++$jdx) {
|
||||
$ekey .= \chr((\ord($owner_key[$jdx]) ^ $idx) & 0xFF);
|
||||
}
|
||||
|
||||
$enc = $this->encrypt('RC4', $enc, $ekey);
|
||||
}
|
||||
}
|
||||
|
||||
return $enc;
|
||||
}
|
||||
|
||||
// AES-256 ($this->encryptdata['mode'] >= 3)
|
||||
return $this->getOValueAes256();
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate a fresh 8-byte validation salt and 8-byte key salt for AES-256
|
||||
* (R5/R6) password hashing (ISO 32000 Algorithm 8/9).
|
||||
*
|
||||
* @return array{0: string, 1: string} [validationSalt, keySalt]
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function generateAes256Salts(): array
|
||||
{
|
||||
$seed = $this->encrypt('MD5-16', $this->encrypt('seed'), 'H*');
|
||||
return [\substr($seed, 0, 8), \substr($seed, 8, 8)];
|
||||
}
|
||||
|
||||
/**
|
||||
* Compute the U value for AES-256 (R5/R6).
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function getUValueAes256(): string
|
||||
{
|
||||
[$this->encryptdata['UVS'], $this->encryptdata['UKS']] = $this->generateAes256Salts();
|
||||
$uHash = $this->encryptdata['mode'] === 4
|
||||
? $this->hash2B($this->encryptdata['user_password'], $this->encryptdata['UVS']) // R6: Algorithm 2.B
|
||||
: \hash('sha256', $this->encryptdata['user_password'] . $this->encryptdata['UVS'], true); // R5: SHA-256
|
||||
|
||||
return $uHash . $this->encryptdata['UVS'] . $this->encryptdata['UKS'];
|
||||
}
|
||||
|
||||
/**
|
||||
* Compute the O value for AES-256 (R5/R6).
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function getOValueAes256(): string
|
||||
{
|
||||
[$this->encryptdata['OVS'], $this->encryptdata['OKS']] = $this->generateAes256Salts();
|
||||
$oHash = $this->encryptdata['mode'] === 4
|
||||
? $this->hash2B($this->encryptdata['owner_password'], $this->encryptdata['OVS'], $this->encryptdata['U']) // R6
|
||||
: \hash(
|
||||
'sha256',
|
||||
$this->encryptdata['owner_password'] . $this->encryptdata['OVS'] . $this->encryptdata['U'],
|
||||
true,
|
||||
); // R5: SHA-256
|
||||
|
||||
return $oHash . $this->encryptdata['OVS'] . $this->encryptdata['OKS'];
|
||||
}
|
||||
|
||||
/**
|
||||
* Compute Algorithm 2.B hash (ISO 32000-2 / PDF 2.0) for AES-256 R6 key derivation.
|
||||
*
|
||||
* Implements the iterative SHA-256/384/512 + AES-128-CBC hash described in
|
||||
* ISO 32000-2 section 7.6.4.3.4 (Algorithm 2.B).
|
||||
*
|
||||
* @param string $password UTF-8 password (already truncated to ≤ 127 bytes).
|
||||
* @param string $salt 8-byte validation or key salt.
|
||||
* @param string $userHash 48-byte U value for owner-side calculations; empty for user-side.
|
||||
*
|
||||
* @throws EncException When the internal AES-128-CBC step fails.
|
||||
*/
|
||||
protected function hash2B(#[\SensitiveParameter] string $password, string $salt, string $userHash = ''): string
|
||||
{
|
||||
$hashK = \hash('sha256', $password . $salt, true);
|
||||
$round = 0;
|
||||
do {
|
||||
// inputBlock length is always 64 * (len(password) + 32 + len(userHash)).
|
||||
// 64 is a multiple of 16, so inputBlock is always AES-block-aligned (no padding needed).
|
||||
$inputBlock = \str_repeat($password . $hashK . $userHash, 64);
|
||||
$encrypted = \openssl_encrypt(
|
||||
$inputBlock,
|
||||
'aes-128-cbc',
|
||||
\substr($hashK, 0, 16),
|
||||
OPENSSL_RAW_DATA | OPENSSL_ZERO_PADDING,
|
||||
\substr($hashK, 16, 16),
|
||||
);
|
||||
if ($encrypted === false) {
|
||||
throw new EncException('AES-128-CBC encryption failed in hash2B');
|
||||
}
|
||||
|
||||
$sum = 0;
|
||||
for ($idx = 0; $idx < 16; ++$idx) {
|
||||
$sum += \ord($encrypted[$idx]);
|
||||
}
|
||||
|
||||
$algo = match ($sum % 3) {
|
||||
0 => 'sha256',
|
||||
1 => 'sha384',
|
||||
default => 'sha512',
|
||||
};
|
||||
$hashK = \hash($algo, $encrypted, true);
|
||||
++$round;
|
||||
$lastByte = \ord($encrypted[\strlen($encrypted) - 1]);
|
||||
} while (!($round >= 64 && $lastByte <= ($round - 32)));
|
||||
|
||||
return \substr($hashK, 0, 32);
|
||||
}
|
||||
|
||||
/**
|
||||
* Compute encryption key
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function generateEncryptionKey(): void
|
||||
{
|
||||
if ($this->encryptdata['pubkey']) {
|
||||
$this->generatePublicEncryptionKey();
|
||||
return;
|
||||
}
|
||||
|
||||
// standard mode
|
||||
$this->generateStandardEncryptionKey();
|
||||
}
|
||||
|
||||
/**
|
||||
* Compute standard encryption key
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function generateStandardEncryptionKey(): void
|
||||
{
|
||||
$keybytelen = $this->encryptdata['Length'] / 8;
|
||||
if ($this->encryptdata['mode'] >= 3) { // AES-256 (R5 or R6)
|
||||
$this->generateAes256StandardEncryptionKey((int) $keybytelen);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
$this->generateLegacyStandardEncryptionKey((int) $keybytelen);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function generateAes256StandardEncryptionKey(int $keybytelen): void
|
||||
{
|
||||
// generate 256 bit random key
|
||||
$this->encryptdata['key'] = \substr(\hash('sha256', $this->encrypt('seed'), true), 0, $keybytelen);
|
||||
// truncate passwords
|
||||
$this->encryptdata['user_password'] = \substr($this->encryptdata['user_password'], 0, 127);
|
||||
$this->encryptdata['owner_password'] = \substr($this->encryptdata['owner_password'], 0, 127);
|
||||
$this->encryptdata['U'] = $this->getUValue();
|
||||
$this->encryptdata['UE'] = $this->getUEValue();
|
||||
$this->encryptdata['O'] = $this->getOValue();
|
||||
$this->encryptdata['OE'] = $this->getOEValue();
|
||||
$this->encryptdata['P'] = $this->encryptdata['protection'];
|
||||
// Computing the encryption dictionary's Perms (permissions) value
|
||||
$perms = $this->getEncPermissionsString($this->encryptdata['protection']); // bytes 0-3
|
||||
$perms .= \chr(255) . \chr(255) . \chr(255) . \chr(255); // bytes 4-7
|
||||
$perms .= $this->encryptdata['EncryptMetadata'] ? 'T' : 'F'; // byte 8: EncryptMetadata flag
|
||||
$perms .= 'adb'; // bytes 9-11
|
||||
$perms .= \openssl_random_pseudo_bytes(4); // bytes 12-15 must be random per PDF spec
|
||||
$this->encryptdata['perms'] = $this->encrypt('AESnopad', $perms, $this->encryptdata['key']);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function generateLegacyStandardEncryptionKey(int $keybytelen): void
|
||||
{
|
||||
// RC4-40, RC4-128, AES-128
|
||||
// Pad passwords
|
||||
$this->encryptdata['user_password'] = \substr($this->encryptdata['user_password'] . self::ENCPAD, 0, 32);
|
||||
$this->encryptdata['owner_password'] = \substr($this->encryptdata['owner_password'] . self::ENCPAD, 0, 32);
|
||||
$this->encryptdata['O'] = $this->getOValue();
|
||||
// get default permissions (reverse byte order)
|
||||
$permissions = $this->getEncPermissionsString($this->encryptdata['protection']);
|
||||
// Compute encryption key
|
||||
$tmp = $this->encrypt(
|
||||
'MD5-16',
|
||||
$this->encryptdata['user_password'] . $this->encryptdata['O'] . $permissions . $this->encryptdata['fileid'],
|
||||
'H*',
|
||||
);
|
||||
if ($this->encryptdata['mode'] > 0) {
|
||||
for ($idx = 0; $idx < 50; ++$idx) {
|
||||
$tmp = $this->encrypt('MD5-16', \substr($tmp, 0, $keybytelen), 'H*');
|
||||
}
|
||||
}
|
||||
|
||||
$this->encryptdata['key'] = \substr($tmp, 0, $keybytelen);
|
||||
$this->encryptdata['U'] = $this->getUValue();
|
||||
$this->encryptdata['P'] = $this->encryptdata['protection'];
|
||||
}
|
||||
|
||||
/**
|
||||
* Compute public encryption key
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*
|
||||
* @SuppressWarnings("PHPMD.CyclomaticComplexity")
|
||||
* @SuppressWarnings("PHPMD.NPathComplexity")
|
||||
* @SuppressWarnings("PHPMD.ExcessiveMethodLength")
|
||||
*/
|
||||
protected function generatePublicEncryptionKey(): void
|
||||
{
|
||||
$keybytelen = (int) ($this->encryptdata['Length'] / 8);
|
||||
// random 20-byte seed
|
||||
$seed = \sha1($this->encrypt('seed'), true);
|
||||
$recipient_bytes = '';
|
||||
$pubkeys = $this->encryptdata['pubkeys'] ?? throw new EncException('Missing pubkeys');
|
||||
foreach ($pubkeys as $pubkey) {
|
||||
$recipient_bytes .= $this->getEncryptedRecipientBytes($pubkey, $seed);
|
||||
}
|
||||
|
||||
// calculate encryption key
|
||||
if ($this->encryptdata['mode'] >= 3) { // AES-256 (R5/R6)
|
||||
$this->encryptdata['key'] = \substr(\hash('sha256', $seed . $recipient_bytes, true), 0, $keybytelen);
|
||||
return;
|
||||
}
|
||||
|
||||
// RC4-40, RC4-128, AES-128
|
||||
$this->encryptdata['key'] = \substr(\sha1($seed . $recipient_bytes, true), 0, $keybytelen);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array{c:string,p:array<string>} $pubkey
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function getEncryptedRecipientBytes(array $pubkey, string $seed): string
|
||||
{
|
||||
// for each public certificate
|
||||
$pkprotection = $this->getUserPermissionCode($pubkey['p'], $this->encryptdata['mode']);
|
||||
|
||||
// get default permissions (reverse byte order)
|
||||
$pkpermissions = $this->getEncPermissionsString($pkprotection);
|
||||
// envelope data
|
||||
$envelope = $seed . $pkpermissions;
|
||||
|
||||
// write the envelope data to a temporary file
|
||||
$tempkeyfile = \tempnam(
|
||||
\sys_get_temp_dir(),
|
||||
'__tcpdf_key_' . \md5($this->encryptdata['fileid'] . $envelope) . '_',
|
||||
);
|
||||
if ($tempkeyfile === false) {
|
||||
throw new EncException('Unable to generate temporary key file name');
|
||||
}
|
||||
|
||||
if (\file_put_contents($tempkeyfile, $envelope) === false) {
|
||||
\unlink($tempkeyfile);
|
||||
throw new EncException('Unable to create temporary key file: ' . $tempkeyfile);
|
||||
}
|
||||
|
||||
$tempencfile = \tempnam(
|
||||
\sys_get_temp_dir(),
|
||||
'__tcpdf_enc_' . \md5($this->encryptdata['fileid'] . $envelope) . '_',
|
||||
);
|
||||
if ($tempencfile === false) {
|
||||
// The key file was already created; remove it before bailing out.
|
||||
\unlink($tempkeyfile);
|
||||
throw new EncException('Unable to generate temporary key file name');
|
||||
}
|
||||
|
||||
try {
|
||||
return $this->encryptRecipientEnvelope($pubkey, $tempkeyfile, $tempencfile);
|
||||
} finally {
|
||||
// Always remove the temporary files: $tempkeyfile holds the plaintext
|
||||
// envelope (sensitive key material) and must never be left behind.
|
||||
\unlink($tempkeyfile);
|
||||
\unlink($tempencfile);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Encrypt the envelope file to the recipient's certificate and extract the
|
||||
* resulting PKCS#7 signature bytes.
|
||||
*
|
||||
* @param array{c:string,p:array<string>} $pubkey Recipient certificate/permissions.
|
||||
* @param string $tempkeyfile Path to the plaintext envelope file.
|
||||
* @param string $tempencfile Path to the PKCS#7 output file.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function encryptRecipientEnvelope(array $pubkey, string $tempkeyfile, string $tempencfile): string
|
||||
{
|
||||
if (!\function_exists('openssl_pkcs7_encrypt')) {
|
||||
throw new EncException(
|
||||
'Unable to encrypt the file: '
|
||||
. $tempkeyfile
|
||||
. "\n"
|
||||
. 'Public-Key Security requires openssl_pkcs7_encrypt.',
|
||||
);
|
||||
}
|
||||
|
||||
$pkey = \file_get_contents($pubkey['c']);
|
||||
if ($pkey === false) {
|
||||
throw new EncException('Unable to read public key file: ' . $pubkey['c']);
|
||||
}
|
||||
|
||||
if (!\openssl_pkcs7_encrypt($tempkeyfile, $tempencfile, $pkey, [], PKCS7_BINARY)) {
|
||||
throw new EncException(
|
||||
'Unable to encrypt the file: '
|
||||
. $tempkeyfile
|
||||
. "\n"
|
||||
. 'OpenSSL error: '
|
||||
. (string) \openssl_error_string(),
|
||||
);
|
||||
}
|
||||
|
||||
// read encryption signature
|
||||
$signature = \file_get_contents($tempencfile);
|
||||
if ($signature === false) {
|
||||
throw new EncException('Unable to read signature file: ' . $tempencfile);
|
||||
}
|
||||
|
||||
$sigcontentpos = \strpos($signature, 'Content-Disposition');
|
||||
if ($sigcontentpos === false) {
|
||||
throw new EncException('Unable to find signature content');
|
||||
}
|
||||
|
||||
// extract signature
|
||||
$signature = \substr($signature, $sigcontentpos);
|
||||
|
||||
$tmparr = \explode("\n\n", $signature);
|
||||
$signature = \trim($tmparr[1] ?? '');
|
||||
unset($tmparr);
|
||||
// decode signature
|
||||
$signature = \base64_decode($signature, strict: true);
|
||||
if ($signature === false) {
|
||||
throw new EncException('Unable to decode signature: ' . $tempencfile);
|
||||
}
|
||||
|
||||
$sigarr = \unpack('H*', $signature);
|
||||
if ($sigarr === false) {
|
||||
throw new EncException('Unable to unpack signature: ' . $tempencfile);
|
||||
}
|
||||
|
||||
// convert signature to hex
|
||||
$hexsignature = (string) \current($sigarr);
|
||||
if ($hexsignature === '') {
|
||||
throw new EncException('Unable to convert signature: ' . $tempencfile);
|
||||
}
|
||||
|
||||
// store signature on recipients array
|
||||
$this->encryptdata['Recipients'][] = $hexsignature;
|
||||
|
||||
// The bytes of each item in the Recipients array of PKCS#7 objects
|
||||
// in the order in which they appear in the array
|
||||
return $signature;
|
||||
}
|
||||
}
|
||||
+195
@@ -0,0 +1,195 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Data.php
|
||||
*
|
||||
* @since 2008-01-02
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Pdf\Encrypt;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Pdf\Encrypt\Data
|
||||
*
|
||||
* Encrypt common data
|
||||
*
|
||||
* @since 2008-01-02
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*/
|
||||
abstract class Data extends \Com\Tecnick\Pdf\Encrypt\Output
|
||||
{
|
||||
/**
|
||||
* Encryption padding string.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected const ENCPAD =
|
||||
"\x28\xBF\x4E\x5E\x4E\x75\x8A\x41\x64\x00"
|
||||
. "\x4E\x56\xFF\xFA\x01\x08\x2E\x2E\x00\xB6"
|
||||
. "\xD0\x68\x3E\x80\x2F\x0C\xA9\xFE\x64\x53"
|
||||
. "\x69\x7A";
|
||||
|
||||
/**
|
||||
* Map permission modes and bits.
|
||||
*
|
||||
* @var array<string, int>
|
||||
*/
|
||||
protected const PERMBITS = [
|
||||
// bit 2 -- inverted logic: cleared by default
|
||||
// When set permits change of encryption and enables all other permissions.
|
||||
'owner' => 2,
|
||||
|
||||
// bit 3
|
||||
// Print the document.
|
||||
'print' => 4,
|
||||
|
||||
// bit 4
|
||||
// Modify the contents of the document by operations other than those controlled
|
||||
// by 'fill-forms', 'extract' and 'assemble'.
|
||||
'modify' => 8,
|
||||
|
||||
// bit 5
|
||||
// Copy or otherwise extract text and graphics from the document.
|
||||
'copy' => 16,
|
||||
|
||||
// bit 6
|
||||
// Add or modify text annotations, fill in interactive form fields, and,
|
||||
// if 'modify' is also set, create or modify interactive form fields
|
||||
// (including signature fields).
|
||||
'annot-forms' => 32,
|
||||
|
||||
// bit 9
|
||||
// Fill in existing interactive form fields (including signature fields),
|
||||
// even if 'annot-forms' is not specified.
|
||||
'fill-forms' => 256,
|
||||
|
||||
// bit 10
|
||||
// Extract text and graphics (in support of accessibility to users with
|
||||
// disabilities or for other purposes).
|
||||
'extract' => 512,
|
||||
|
||||
// bit 11
|
||||
// Assemble the document (insert, rotate, or delete pages and create bookmarks
|
||||
// or thumbnail images), even if 'modify' is not set.
|
||||
'assemble' => 1024,
|
||||
|
||||
// bit 12
|
||||
// Print the document to a representation from which a faithful digital copy of the
|
||||
// PDF content could be generated. When this is not set, printing is limited to a
|
||||
// low-level representation of the appearance, possibly of degraded quality.
|
||||
'print-high' => 2048,
|
||||
];
|
||||
|
||||
/**
|
||||
* Encryption settings.
|
||||
*
|
||||
* @var array<int, array{
|
||||
* 'V': int,
|
||||
* 'Length': int,
|
||||
* 'CF': array{
|
||||
* 'CFM': string,
|
||||
* 'Length'?: int,
|
||||
* 'AuthEvent': string,
|
||||
* },
|
||||
* 'SubFilter': string,
|
||||
* 'Recipients': array<string, string>,
|
||||
* }>
|
||||
*/
|
||||
protected const ENCRYPT_SETTINGS = [
|
||||
0 => [
|
||||
// RC4 40 bit
|
||||
'V' => 1,
|
||||
'Length' => 40,
|
||||
'CF' => [
|
||||
'CFM' => 'V2',
|
||||
'AuthEvent' => 'DocOpen',
|
||||
],
|
||||
'SubFilter' => '',
|
||||
'Recipients' => [],
|
||||
],
|
||||
1 => [
|
||||
// RC4 128 bit
|
||||
'V' => 2,
|
||||
'Length' => 128,
|
||||
'CF' => [
|
||||
'CFM' => 'V2',
|
||||
'AuthEvent' => 'DocOpen',
|
||||
],
|
||||
'SubFilter' => 'adbe.pkcs7.s4',
|
||||
'Recipients' => [],
|
||||
],
|
||||
2 => [
|
||||
// AES 128 bit
|
||||
'V' => 4,
|
||||
'Length' => 128,
|
||||
'CF' => [
|
||||
'CFM' => 'AESV2',
|
||||
'Length' => 16,
|
||||
'AuthEvent' => 'DocOpen',
|
||||
],
|
||||
'SubFilter' => 'adbe.pkcs7.s5',
|
||||
'Recipients' => [],
|
||||
],
|
||||
3 => [
|
||||
// AES 256 bit (R5, Acrobat 9 / PDF 1.7 extension)
|
||||
'V' => 5,
|
||||
'Length' => 256,
|
||||
'CF' => [
|
||||
'CFM' => 'AESV3',
|
||||
'Length' => 32,
|
||||
'AuthEvent' => 'DocOpen',
|
||||
],
|
||||
'SubFilter' => 'adbe.pkcs7.s5',
|
||||
'Recipients' => [],
|
||||
],
|
||||
4 => [
|
||||
// AES 256 bit R6 (PDF 2.0 / ISO 32000-2)
|
||||
'V' => 6,
|
||||
'Length' => 256,
|
||||
'CF' => [
|
||||
'CFM' => 'AESV3',
|
||||
'Length' => 32,
|
||||
'AuthEvent' => 'DocOpen',
|
||||
],
|
||||
'SubFilter' => 'adbe.pkcs7.s5',
|
||||
'Recipients' => [],
|
||||
],
|
||||
];
|
||||
|
||||
/**
|
||||
* Define a list of available encrypt encoders.
|
||||
*
|
||||
* @var array<int|string, string>
|
||||
*/
|
||||
protected const ENCMAP = [
|
||||
0 => 'RCFourFive', // RC4-40
|
||||
1 => 'RCFourSixteen', // RC4-128
|
||||
2 => 'AESSixteen', // AES-128
|
||||
3 => 'AESThirtytwo', // AES-256 (R5)
|
||||
4 => 'AESThirtytwo', // AES-256 (R6)
|
||||
'RC4' => 'RCFour', // RC4-40
|
||||
'RC4-40' => 'RCFourFive', // RC4-40
|
||||
'RC4-128' => 'RCFourSixteen', // RC4-128
|
||||
'AES' => 'AES', // AES-256
|
||||
'AES-128' => 'AESSixteen', // AES-128
|
||||
'AES-256' => 'AESThirtytwo', // AES-256
|
||||
'AESnopad' => 'AESnopad', // AES - no padding
|
||||
'MD5-16' => 'MDFiveSixteen', // MD5-16
|
||||
'seed' => 'Seed', // Random seed string
|
||||
];
|
||||
}
|
||||
@@ -0,0 +1,621 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Decrypt.php
|
||||
*
|
||||
* @since 2026-04-30
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Pdf\Encrypt;
|
||||
|
||||
use Com\Tecnick\Pdf\Encrypt\Type\AESnopad;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Pdf\Encrypt\Decrypt
|
||||
*
|
||||
* Authenticates a password (or private key for public-key mode) against a PDF
|
||||
* encryption dictionary and recovers the document file-encryption key.
|
||||
*
|
||||
* Usage:
|
||||
* $dec = new Decrypt($encrypt->getEncryptionData());
|
||||
* if ($dec->authenticate('userpass')) {
|
||||
* $plaintext = $dec->decryptString($ciphertext, $objnum);
|
||||
* }
|
||||
*
|
||||
* After successful authentication the derived key is stored internally and:
|
||||
* - decryptString() decrypts PDF string/stream objects.
|
||||
* - getObjectKey() returns the per-object key for AES-128 streams.
|
||||
* - getDocumentKey() returns the raw 32-byte (or shorter) file key.
|
||||
*
|
||||
* @since 2026-04-30
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* @phpstan-import-type TEncryptData from Output
|
||||
*
|
||||
* @phpstan-type TDecryptInput TEncryptData|array{
|
||||
* 'V': int,
|
||||
* 'Length': int,
|
||||
* 'O': string,
|
||||
* 'U': string,
|
||||
* 'P': int,
|
||||
* 'fileid': string,
|
||||
* 'mode': int,
|
||||
* 'OE'?: string,
|
||||
* 'UE'?: string,
|
||||
* 'EncryptMetadata'?: bool,
|
||||
* 'pubkey'?: bool,
|
||||
* 'Recipients'?: array<array-key, string>,
|
||||
* }
|
||||
*
|
||||
* @SuppressWarnings("PHPMD.ExcessiveClassComplexity")
|
||||
*/
|
||||
class Decrypt extends \Com\Tecnick\Pdf\Encrypt\Compute
|
||||
{
|
||||
/**
|
||||
* Initialise the decryptor from an encryption dictionary.
|
||||
*
|
||||
* Accepts the array returned by Encrypt::getEncryptionData() or any array
|
||||
* that satisfies the TDecryptInput shape. All fields not present in the
|
||||
* input are filled with the defaults defined in Output::$encryptdata.
|
||||
*
|
||||
* @param TDecryptInput $input Encryption dictionary fields.
|
||||
*/
|
||||
public function __construct(array $input)
|
||||
{
|
||||
$this->encryptdata['V'] = (int) $input['V'];
|
||||
$this->encryptdata['Length'] = (int) $input['Length'];
|
||||
$this->encryptdata['O'] = $input['O'];
|
||||
$this->encryptdata['U'] = $input['U'];
|
||||
$this->encryptdata['P'] = (int) $input['P'];
|
||||
$this->encryptdata['fileid'] = $input['fileid'];
|
||||
$this->encryptdata['mode'] = (int) $input['mode'];
|
||||
$this->encryptdata['EncryptMetadata'] = $input['EncryptMetadata'] ?? $this->encryptdata['EncryptMetadata'];
|
||||
$this->encryptdata['pubkey'] = $input['pubkey'] ?? $this->encryptdata['pubkey'];
|
||||
if (\array_key_exists('Recipients', $input)) {
|
||||
$this->encryptdata['Recipients'] = $input['Recipients'];
|
||||
}
|
||||
|
||||
if (\array_key_exists('OE', $input)) {
|
||||
$this->encryptdata['OE'] = $input['OE'];
|
||||
}
|
||||
|
||||
if (\array_key_exists('UE', $input)) {
|
||||
$this->encryptdata['UE'] = $input['UE'];
|
||||
}
|
||||
|
||||
// Ensure encrypt()-based primitives (RC4, MD5-16) are active for key derivation.
|
||||
$this->encryptdata['encrypted'] = true;
|
||||
// Clear the key: it must be recovered by a successful authenticate() call.
|
||||
$this->encryptdata['key'] = '';
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// Public API
|
||||
// -------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Authenticate using a password and/or private key.
|
||||
*
|
||||
* Tries the supplied string first as the user password, then as the owner
|
||||
* password. For public-key mode, $privkeyPath must be the path to a PEM
|
||||
* file containing the recipient's certificate and private key; $password is
|
||||
* ignored in that case.
|
||||
*
|
||||
* On success the derived file-encryption key is stored internally.
|
||||
*
|
||||
* @param string $password UTF-8 password to test (ignored for pubkey mode).
|
||||
* @param string $privkeyPath Path to PEM file for public-key mode.
|
||||
*
|
||||
* @return bool True when authentication succeeds.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function authenticate(#[\SensitiveParameter] string $password, string $privkeyPath = ''): bool
|
||||
{
|
||||
if ($this->encryptdata['pubkey']) {
|
||||
return $this->authenticatePublicKey($privkeyPath);
|
||||
}
|
||||
|
||||
if ($this->encryptdata['mode'] >= 3) {
|
||||
return $this->authenticatePasswordR5R6($password);
|
||||
}
|
||||
|
||||
return $this->authenticatePasswordR24($password);
|
||||
}
|
||||
|
||||
/**
|
||||
* Decrypt a PDF string or stream object.
|
||||
*
|
||||
* Must be called after a successful authenticate() call.
|
||||
*
|
||||
* For RC4 modes (0, 1) the operation is symmetric: the same method that
|
||||
* encrypts also decrypts. For AES modes (2, 3, 4) the first 16 bytes of
|
||||
* $data are the random IV; the remainder is the ciphertext. The PKCS#7
|
||||
* padding applied during encryption is stripped, so the exact original
|
||||
* plaintext is returned.
|
||||
*
|
||||
* @param string $data Encrypted string/stream data.
|
||||
* @param int $objnum PDF object number (used for per-object key derivation
|
||||
* in RC4 and AES-128 modes).
|
||||
*
|
||||
* @return string Decrypted data.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function decryptString(string $data, int $objnum = 0): string
|
||||
{
|
||||
if (!$this->encryptdata['encrypted'] || $this->encryptdata['key'] === '') {
|
||||
return $data;
|
||||
}
|
||||
|
||||
$mode = $this->encryptdata['mode'];
|
||||
|
||||
if ($mode < 2) {
|
||||
// RC4 is symmetric: the same encrypt() call decrypts.
|
||||
return $this->encrypt($mode, $data, '', $objnum);
|
||||
}
|
||||
|
||||
return $this->decryptAes($data, $objnum);
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the recovered file-encryption key.
|
||||
*
|
||||
* @return string Raw binary key (empty string before authenticate() succeeds).
|
||||
*/
|
||||
public function getDocumentKey(): string
|
||||
{
|
||||
return $this->encryptdata['key'];
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// RC4 / R2–R4 authentication (modes 0, 1, 2)
|
||||
// -------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Authenticate a password for R2–R4 (RC4-40, RC4-128, AES-128).
|
||||
*
|
||||
* First tries the password as the user password; on failure tries it as the
|
||||
* owner password.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function authenticatePasswordR24(#[\SensitiveParameter] string $password): bool
|
||||
{
|
||||
$paddedPass = \substr($password . self::ENCPAD, 0, 32);
|
||||
|
||||
if ($this->authenticateUserR24($paddedPass)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return $this->authenticateOwnerR24($password);
|
||||
}
|
||||
|
||||
/**
|
||||
* Authenticate $paddedPass as the user password for R2–R4.
|
||||
*
|
||||
* Derives a candidate encryption key from the padded password and verifies
|
||||
* it against the stored U value using Algorithm 6 (PDF spec §7.6.3.4).
|
||||
* On success the verified key remains stored in $encryptdata['key'].
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function authenticateUserR24(string $paddedPass): bool
|
||||
{
|
||||
$savedKey = $this->encryptdata['key'];
|
||||
$this->encryptdata['key'] = $this->deriveKeyR24($paddedPass);
|
||||
|
||||
$computedU = $this->getUValue();
|
||||
|
||||
if ($this->compareUserHashR24($computedU)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
$this->encryptdata['key'] = $savedKey;
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Authenticate $password as the owner password for R2–R4.
|
||||
*
|
||||
* Derives the owner key, decrypts the O entry to recover the candidate user
|
||||
* password, then delegates to authenticateUserR24.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function authenticateOwnerR24(#[\SensitiveParameter] string $password): bool
|
||||
{
|
||||
$paddedOwner = \substr($password . self::ENCPAD, 0, 32);
|
||||
$ownerKey = $this->deriveOwnerKeyR24($paddedOwner);
|
||||
$candidateUserPass = $this->decryptOToUserPass($ownerKey);
|
||||
return $this->authenticateUserR24($candidateUserPass);
|
||||
}
|
||||
|
||||
/**
|
||||
* Derive the file encryption key for R2–R4 from a 32-byte padded user password.
|
||||
*
|
||||
* Implements Algorithm 2 from PDF spec §7.6.3.3.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function deriveKeyR24(string $paddedPass): string
|
||||
{
|
||||
$keybytelen = (int) ($this->encryptdata['Length'] / 8);
|
||||
$permBytes = $this->getEncPermissionsString($this->encryptdata['P']);
|
||||
|
||||
$tmp = $this->encrypt(
|
||||
'MD5-16',
|
||||
$paddedPass . $this->encryptdata['O'] . $permBytes . $this->encryptdata['fileid'],
|
||||
);
|
||||
|
||||
if ($this->encryptdata['mode'] > 0) {
|
||||
for ($idx = 0; $idx < 50; ++$idx) {
|
||||
$tmp = $this->encrypt('MD5-16', \substr($tmp, 0, $keybytelen));
|
||||
}
|
||||
}
|
||||
|
||||
return \substr($tmp, 0, $keybytelen);
|
||||
}
|
||||
|
||||
/**
|
||||
* Compare a freshly computed U value against the stored one for R2–R4.
|
||||
*
|
||||
* R2 requires an exact 32-byte match; R3/R4 compare only the first 16 bytes.
|
||||
*/
|
||||
protected function compareUserHashR24(string $computedU): bool
|
||||
{
|
||||
if ($this->encryptdata['mode'] === 0) {
|
||||
return $computedU === $this->encryptdata['U'];
|
||||
}
|
||||
|
||||
return \substr($computedU, 0, 16) === \substr($this->encryptdata['U'], 0, 16);
|
||||
}
|
||||
|
||||
/**
|
||||
* Derive the owner key from a 32-byte padded owner password for R2–R4.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function deriveOwnerKeyR24(string $paddedOwnerPass): string
|
||||
{
|
||||
$keybytelen = (int) ($this->encryptdata['Length'] / 8);
|
||||
$tmp = $this->encrypt('MD5-16', $paddedOwnerPass);
|
||||
|
||||
if ($this->encryptdata['mode'] > 0) {
|
||||
for ($idx = 0; $idx < 50; ++$idx) {
|
||||
$tmp = $this->encrypt('MD5-16', \substr($tmp, 0, $keybytelen));
|
||||
}
|
||||
}
|
||||
|
||||
return \substr($tmp, 0, $keybytelen);
|
||||
}
|
||||
|
||||
/**
|
||||
* Decrypt the O entry using the owner key to recover the candidate user password.
|
||||
*
|
||||
* Reverses the iterative RC4 encryption applied by getOValue() in Compute.
|
||||
*
|
||||
* @SuppressWarnings("PHPMD.CyclomaticComplexity")
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function decryptOToUserPass(string $ownerKey): string
|
||||
{
|
||||
if ($this->encryptdata['mode'] === 0) {
|
||||
return $this->encrypt('RC4', $this->encryptdata['O'], $ownerKey);
|
||||
}
|
||||
|
||||
$keyLen = \strlen($ownerKey);
|
||||
$candidate = $this->encryptdata['O'];
|
||||
|
||||
for ($idx = 19; $idx >= 1; --$idx) {
|
||||
$xoredKey = '';
|
||||
for ($jdx = 0; $jdx < $keyLen; ++$jdx) {
|
||||
$xoredKey .= \chr((\ord($ownerKey[$jdx]) ^ $idx) & 0xFF);
|
||||
}
|
||||
|
||||
$candidate = $this->encrypt('RC4', $candidate, $xoredKey);
|
||||
}
|
||||
|
||||
return $this->encrypt('RC4', $candidate, $ownerKey);
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// AES-256 / R5–R6 authentication (modes 3, 4)
|
||||
// -------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Authenticate a password for R5 (mode 3) or R6 (mode 4).
|
||||
*
|
||||
* Tries the password as the user password, then as the owner password.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function authenticatePasswordR5R6(#[\SensitiveParameter] string $password): bool
|
||||
{
|
||||
if ($this->authenticateUserR5R6($password)) {
|
||||
$this->recoverKeyFromUser($password);
|
||||
return true;
|
||||
}
|
||||
|
||||
if ($this->authenticateOwnerR5R6($password)) {
|
||||
$this->recoverKeyFromOwner($password);
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify $password as the user password for R5/R6 (Algorithm 11/13).
|
||||
*
|
||||
* Computes hash(password ∥ U[32..39]) and compares to U[0..32].
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function authenticateUserR5R6(#[\SensitiveParameter] string $password): bool
|
||||
{
|
||||
$uvs = \substr($this->encryptdata['U'], 32, 8);
|
||||
$expected = \substr($this->encryptdata['U'], 0, 32);
|
||||
return $this->hashR5R6($password, $uvs) === $expected;
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify $password as the owner password for R5/R6 (Algorithm 13/15).
|
||||
*
|
||||
* Computes hash(password ∥ O[32..39] ∥ U[0..48]) and compares to O[0..32].
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function authenticateOwnerR5R6(#[\SensitiveParameter] string $password): bool
|
||||
{
|
||||
$ovs = \substr($this->encryptdata['O'], 32, 8);
|
||||
$userHash = \substr($this->encryptdata['U'], 0, 48);
|
||||
$expected = \substr($this->encryptdata['O'], 0, 32);
|
||||
return $this->hashR5R6($password, $ovs, $userHash) === $expected;
|
||||
}
|
||||
|
||||
/**
|
||||
* Recover the file encryption key using the verified user password (Algorithm 12/14).
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function recoverKeyFromUser(#[\SensitiveParameter] string $password): void
|
||||
{
|
||||
$uks = \substr($this->encryptdata['U'], 40, 8);
|
||||
$hashkey = $this->hashR5R6($password, $uks);
|
||||
$aesnopad = new AESnopad();
|
||||
$this->encryptdata['key'] = $aesnopad->decrypt($this->encryptdata['UE'], $hashkey);
|
||||
}
|
||||
|
||||
/**
|
||||
* Recover the file encryption key using the verified owner password (Algorithm 14/16).
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function recoverKeyFromOwner(#[\SensitiveParameter] string $password): void
|
||||
{
|
||||
$oks = \substr($this->encryptdata['O'], 40, 8);
|
||||
$userHash = \substr($this->encryptdata['U'], 0, 48);
|
||||
$hashkey = $this->hashR5R6($password, $oks, $userHash);
|
||||
$aesnopad = new AESnopad();
|
||||
$this->encryptdata['key'] = $aesnopad->decrypt($this->encryptdata['OE'], $hashkey);
|
||||
}
|
||||
|
||||
/**
|
||||
* Compute the R5/R6 password hash.
|
||||
*
|
||||
* R5 (mode 3): SHA-256(password ∥ salt ∥ userHash).
|
||||
* R6 (mode 4): Algorithm 2.B (ISO 32000-2 §7.6.4.3.4).
|
||||
*
|
||||
* @param string $password UTF-8 password (truncated to ≤ 127 bytes by caller).
|
||||
* @param string $salt 8-byte validation or key salt.
|
||||
* @param string $userHash 48-byte U value for owner-side; empty for user-side.
|
||||
*
|
||||
* @return string 32-byte binary hash.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function hashR5R6(#[\SensitiveParameter] string $password, string $salt, string $userHash = ''): string
|
||||
{
|
||||
if ($this->encryptdata['mode'] === 4) {
|
||||
return $this->hash2B($password, $salt, $userHash);
|
||||
}
|
||||
|
||||
return \hash('sha256', $password . $salt . $userHash, true);
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// AES stream/string decryption helper
|
||||
// -------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Decrypt an AES-encrypted PDF string or stream (modes 2, 3, 4).
|
||||
*
|
||||
* The ciphertext is prefixed with a 16-byte random IV as required by the
|
||||
* PDF specification (§7.6.3). Returns an empty string when the data is
|
||||
* shorter than the IV length.
|
||||
*
|
||||
* The string/stream ciphertext is produced with PKCS#7 block padding
|
||||
* (AESV2/AESV3 crypt filters, ISO 32000), so decryption is performed
|
||||
* WITHOUT OPENSSL_ZERO_PADDING: OpenSSL validates and strips the PKCS#7
|
||||
* padding, recovering the exact original plaintext. Returns an empty
|
||||
* string when the padding is invalid (e.g. wrong key or corrupted data).
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
protected function decryptAes(string $data, int $objnum): string
|
||||
{
|
||||
if (\strlen($data) <= AESnopad::BLOCKSIZE) {
|
||||
return '';
|
||||
}
|
||||
|
||||
$ivect = \substr($data, 0, AESnopad::BLOCKSIZE);
|
||||
$ciphertext = \substr($data, AESnopad::BLOCKSIZE);
|
||||
$mode = $this->encryptdata['mode'];
|
||||
$key = $mode < 3 ? $this->getObjectKey($objnum) : $this->encryptdata['key'];
|
||||
$cipher = $mode === 2 ? 'aes-128-cbc' : 'aes-256-cbc';
|
||||
|
||||
$dec = \openssl_decrypt($ciphertext, $cipher, $key, OPENSSL_RAW_DATA, $ivect);
|
||||
|
||||
return $dec === false ? '' : $dec;
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// Public-key mode authentication
|
||||
// -------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Authenticate using a recipient's PEM private-key file (public-key mode).
|
||||
*
|
||||
* Iterates over all Recipients entries, tries to decrypt each PKCS#7 envelope
|
||||
* with the supplied certificate/key, extracts the seed, and derives the
|
||||
* document encryption key.
|
||||
*
|
||||
* @param string $privkeyPath Path to the recipient's PEM file (cert + key).
|
||||
*
|
||||
* @return bool True when a matching recipient is found and the key is derived.
|
||||
*/
|
||||
protected function authenticatePublicKey(string $privkeyPath): bool
|
||||
{
|
||||
if ($privkeyPath === '' || !\is_readable($privkeyPath)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$certPem = \file_get_contents($privkeyPath);
|
||||
if ($certPem === false) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$seed = $this->findDecryptedRecipientSeed($certPem);
|
||||
if ($seed === null) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$this->derivePublicKey($seed);
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Iterate over all Recipients and return the 20-byte seed from the first
|
||||
* envelope that can be decrypted with $certPem, or null on failure.
|
||||
*
|
||||
* @return string|null 20-byte seed, or null when no matching recipient found.
|
||||
*/
|
||||
protected function findDecryptedRecipientSeed(string $certPem): ?string
|
||||
{
|
||||
foreach ($this->encryptdata['Recipients'] as $hexRecipient) {
|
||||
// Silence native warning noise for malformed recipient entries;
|
||||
// false is handled explicitly by the guard below.
|
||||
\set_error_handler(static fn(): bool => true);
|
||||
try {
|
||||
$derData = \hex2bin($hexRecipient);
|
||||
} finally {
|
||||
\restore_error_handler();
|
||||
}
|
||||
|
||||
if ($derData === false) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$envelope = $this->tryDecryptRecipient($derData, $certPem);
|
||||
if ($envelope !== null && \strlen($envelope) >= 24) {
|
||||
// envelope = seed (20 bytes) + permissions (4 bytes)
|
||||
return \substr($envelope, 0, 20);
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Attempt to decrypt a single DER-encoded PKCS#7 recipient envelope.
|
||||
*
|
||||
* Reconstructs the S/MIME message (as produced by openssl_pkcs7_encrypt),
|
||||
* writes it to a temporary file, calls openssl_pkcs7_decrypt with the
|
||||
* supplied certificate/key, and returns the raw decrypted bytes on success.
|
||||
*
|
||||
* @param string $derData Raw DER binary (one entry from Recipients[]).
|
||||
* @param string $certPem PEM certificate + private key of the recipient.
|
||||
*
|
||||
* @return string|null Decrypted envelope bytes, or null on failure.
|
||||
*/
|
||||
protected function tryDecryptRecipient(string $derData, string $certPem): ?string
|
||||
{
|
||||
$smime =
|
||||
"MIME-Version: 1.0\r\n"
|
||||
. 'Content-Type: application/pkcs7-mime;'
|
||||
. " smime-type=enveloped-data; name=\"smime.p7m\"\r\n"
|
||||
. "Content-Transfer-Encoding: base64\r\n\r\n"
|
||||
. \chunk_split(\base64_encode($derData));
|
||||
|
||||
$tmpIn = \tempnam(\sys_get_temp_dir(), '__tcpdf_dec_in_');
|
||||
$tmpOut = \tempnam(\sys_get_temp_dir(), '__tcpdf_dec_out_');
|
||||
|
||||
if ($tmpIn === false || $tmpOut === false) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if (\file_put_contents($tmpIn, $smime) === false) {
|
||||
return null;
|
||||
}
|
||||
|
||||
\set_error_handler(static fn(): bool => true);
|
||||
try {
|
||||
$decOk = \openssl_pkcs7_decrypt($tmpIn, $tmpOut, $certPem, $certPem);
|
||||
} finally {
|
||||
\restore_error_handler();
|
||||
}
|
||||
|
||||
$result = $decOk ? \file_get_contents($tmpOut) : null;
|
||||
|
||||
\unlink($tmpIn);
|
||||
\unlink($tmpOut);
|
||||
|
||||
return $result === false ? null : $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Derive the document encryption key from the recovered seed.
|
||||
*
|
||||
* Mirrors generatePublicEncryptionKey(): the key is SHA-256 (modes ≥ 3) or
|
||||
* SHA-1 (modes 0–2) of the seed concatenated with all Recipients' raw bytes.
|
||||
*
|
||||
* @param string $seed 20-byte random seed extracted from the recipient envelope.
|
||||
*/
|
||||
protected function derivePublicKey(string $seed): void
|
||||
{
|
||||
$keybytelen = (int) ($this->encryptdata['Length'] / 8);
|
||||
$recipientBytes = '';
|
||||
|
||||
foreach ($this->encryptdata['Recipients'] as $hexRecipient) {
|
||||
$binary = \hex2bin($hexRecipient);
|
||||
if ($binary !== false) {
|
||||
$recipientBytes .= $binary;
|
||||
}
|
||||
}
|
||||
|
||||
if ($this->encryptdata['mode'] >= 3) {
|
||||
$this->encryptdata['key'] = \substr(\hash('sha256', $seed . $recipientBytes, true), 0, $keybytelen);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
$this->encryptdata['key'] = \substr(\sha1($seed . $recipientBytes, true), 0, $keybytelen);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,335 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Encrypt.php
|
||||
*
|
||||
* @since 2008-01-02
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Pdf\Encrypt;
|
||||
|
||||
use Com\Tecnick\Pdf\Encrypt\Exception as EncException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Pdf\Encrypt\Encrypt
|
||||
*
|
||||
* PHP class for encrypting data for PDF documents
|
||||
*
|
||||
* @since 2008-01-02
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* @phpstan-import-type TEncryptData from Output
|
||||
*/
|
||||
class Encrypt extends \Com\Tecnick\Pdf\Encrypt\Compute
|
||||
{
|
||||
/**
|
||||
* Set PDF document protection (permission settings)
|
||||
*
|
||||
* NOTES: The protection against modification is for people who have the full Acrobat product.
|
||||
* If you don't set any password, the document will open as usual.
|
||||
* If you set a user password, the PDF viewer will ask for it before displaying the document.
|
||||
* The master password, if different from the user one, can be used to get full access.
|
||||
* Protecting a document requires to encrypt it, which requires long processing time and may cause timeouts.
|
||||
*
|
||||
* @param bool $enabled False if the encryption is disabled (i.e. the document is in PDF/A mode)
|
||||
* @param string $file_id File ID
|
||||
* @param int $mode Encryption strength: 0 = RC4-40 (deprecated); 1 = RC4-128 (deprecated);
|
||||
* 2 = AES-128; 3 = AES-256 R5; 4 = AES-256 R6 (PDF 2.0 / ISO 32000-2)
|
||||
* @param array<string> $permissions The set of permissions (specify the ones you want to block):
|
||||
* 'owner' // When set permits change of encryption and enables all other permissions.
|
||||
* // (inverted logic: cleared by default).
|
||||
* 'print' // Print the document.
|
||||
* 'modify' // Modify the contents of the document by operations other than those controlled
|
||||
* // by 'fill-forms', 'extract' and 'assemble'.
|
||||
* 'copy' // Copy or otherwise extract text and graphics from the document.
|
||||
* 'annot-forms' // Add or modify text annotations, fill in interactive form fields, and,
|
||||
* // if 'modify' is also set, create or modify interactive form fields
|
||||
* // (including signature fields).
|
||||
* 'fill-forms' // Fill in existing interactive form fields (including signature fields),
|
||||
* // even if 'annot-forms' is not specified.
|
||||
* 'extract' // Extract text and graphics (in support of accessibility to users with
|
||||
* // disabilities or for other purposes).
|
||||
* 'assemble' // Assemble the document (insert, rotate, or delete pages and create bookmarks
|
||||
* // or thumbnail images), even if 'modify' is not set.
|
||||
* 'print-high' // Print the document to a representation from which a faithful digital copy of the
|
||||
* // PDF content could be generated. When this is not set, printing is limited to a
|
||||
* // low-level representation of the appearance, possibly of degraded quality.
|
||||
*
|
||||
* @param string $user_pass User password. Empty by default.
|
||||
* @param string $owner_pass Owner password. If not specified, a random value is used.
|
||||
* @param ?array{array{'c':string, 'p':array<string>}} $pubkeys
|
||||
* Array of recipients containing public-key certificates ('c') and permissions ('p').
|
||||
* For example:
|
||||
* array(array('c' => 'file://../examples/data/cert/test.crt', 'p' => array('print')))
|
||||
* To create self-signed certificate:
|
||||
* openssl req -x509 -nodes -days 365000 -newkey rsa:1024 -keyout cert.pem -out cert.pem
|
||||
* To export crt to p12: openssl pkcs12 -export -in cert.pem -out cert.p12
|
||||
* To convert pfx certificate to pem: openssl pkcs12 -in cert.pfx -out cert.pem -nodes
|
||||
* @param bool $encryptMetadata When false, document metadata streams are not encrypted
|
||||
* (adds /EncryptMetadata false to the encryption dictionary).
|
||||
* Default is true (all streams, including metadata, are encrypted).
|
||||
* @param bool $encryptEmbeddedFiles When true (default), embedded file streams are encrypted
|
||||
* using the same filter as other streams (/EFF entry is added
|
||||
* for V >= 4). Set to false to leave embedded files unencrypted.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function __construct(
|
||||
bool $enabled = false,
|
||||
string $file_id = '',
|
||||
int $mode = 0,
|
||||
array $permissions = [
|
||||
'print',
|
||||
'modify',
|
||||
'copy',
|
||||
'annot-forms',
|
||||
'fill-forms',
|
||||
'extract',
|
||||
'assemble',
|
||||
'print-high',
|
||||
],
|
||||
string $user_pass = '',
|
||||
string $owner_pass = '',
|
||||
?array $pubkeys = null,
|
||||
bool $encryptMetadata = true,
|
||||
bool $encryptEmbeddedFiles = true,
|
||||
) {
|
||||
if (!$enabled) {
|
||||
return;
|
||||
}
|
||||
|
||||
$this->encryptdata['protection'] = $this->getUserPermissionCode($permissions, $mode);
|
||||
$this->setupEncryptionFilter($pubkeys, $mode);
|
||||
|
||||
if ($owner_pass === '') {
|
||||
$owner_pass = \md5($this->encrypt('seed'));
|
||||
}
|
||||
|
||||
$this->encryptdata['user_password'] = $user_pass;
|
||||
$this->encryptdata['owner_password'] = $owner_pass;
|
||||
$this->validateAndApplyMode($mode);
|
||||
$this->encryptdata['EncryptMetadata'] = $encryptMetadata;
|
||||
|
||||
// Set EFF (embedded file filter) for V >= 4 when embedded file encryption is requested
|
||||
if ($encryptEmbeddedFiles && $this->encryptdata['V'] >= 4) {
|
||||
$this->encryptdata['EFF'] = $this->encryptdata['StmF'];
|
||||
}
|
||||
|
||||
$this->encryptdata['encrypted'] = true;
|
||||
$this->encryptdata['fileid'] = $this->convertHexStringToString($file_id);
|
||||
$this->generateEncryptionKey();
|
||||
}
|
||||
|
||||
/**
|
||||
* Configure Filter, StmF, StrF entries and handle mode promotion for public-key mode.
|
||||
*
|
||||
* When $pubkeys are provided and $mode is 0 (RC4-40), mode is silently promoted to 1 (RC4-128)
|
||||
* with a deprecation notice, because public-key security requires at least 128-bit keys.
|
||||
*
|
||||
* @param ?array{array{'c':string, 'p':array<string>}} $pubkeys Recipient public-key certificates.
|
||||
* @param int $mode Encryption mode (modified by reference).
|
||||
*/
|
||||
protected function setupEncryptionFilter(?array $pubkeys, int &$mode): void
|
||||
{
|
||||
if ($pubkeys !== null && $pubkeys !== []) {
|
||||
$this->encryptdata['pubkeys'] = $pubkeys;
|
||||
if ($mode === 0) {
|
||||
// public-key Security requires at least 128 bit; upgrade silently but notify the caller
|
||||
\trigger_error(
|
||||
'Public-key encryption requires at least RC4-128; mode upgraded from 0 to 1',
|
||||
E_USER_DEPRECATED,
|
||||
);
|
||||
$mode = 1;
|
||||
}
|
||||
|
||||
// Set Public-Key filter (available are: Entrust.PPKEF, Adobe.PPKLite, Adobe.PubSec)
|
||||
$this->encryptdata['pubkey'] = true;
|
||||
$this->encryptdata['Filter'] = 'Adobe.PubSec';
|
||||
$this->encryptdata['StmF'] = 'DefaultCryptFilter';
|
||||
$this->encryptdata['StrF'] = 'DefaultCryptFilter';
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
// standard mode (password mode)
|
||||
$this->encryptdata['pubkey'] = false;
|
||||
$this->encryptdata['Filter'] = 'Standard';
|
||||
$this->encryptdata['StmF'] = 'StdCF';
|
||||
$this->encryptdata['StrF'] = 'StdCF';
|
||||
}
|
||||
|
||||
/**
|
||||
* Emit deprecation notices for broken modes and throw for invalid ones,
|
||||
* then merge ENCRYPT_SETTINGS for the resolved mode.
|
||||
*
|
||||
* @param int $mode Resolved encryption mode (0–4).
|
||||
*
|
||||
* @throws EncException When mode is outside the 0–4 range.
|
||||
*/
|
||||
protected function validateAndApplyMode(int $mode): void
|
||||
{
|
||||
if ($mode === 0 || $mode === 1) {
|
||||
\trigger_error(
|
||||
'RC4 encryption (modes 0 and 1) is deprecated and cryptographically broken; use AES (mode 2, 3, or 4)',
|
||||
E_USER_DEPRECATED,
|
||||
);
|
||||
}
|
||||
|
||||
if ($mode < 0 || $mode > 4) {
|
||||
throw new EncException('unknown encryption mode: ' . $mode);
|
||||
}
|
||||
|
||||
$this->encryptdata['mode'] = $mode;
|
||||
|
||||
$settings = self::ENCRYPT_SETTINGS[$mode] ?? throw new EncException('unknown encryption mode: ' . $mode);
|
||||
$this->encryptdata['V'] = $settings['V'];
|
||||
$this->encryptdata['Length'] = $settings['Length'];
|
||||
$this->encryptdata['CF'] = [
|
||||
'CFM' => $settings['CF']['CFM'],
|
||||
'Length' => (int) ($settings['CF']['Length'] ?? 0),
|
||||
'AuthEvent' => $settings['CF']['AuthEvent'],
|
||||
'EncryptMetadata' => $this->encryptdata['EncryptMetadata'],
|
||||
];
|
||||
// SubFilter values from ENCRYPT_SETTINGS are for public-key handlers.
|
||||
// Standard password encryption must omit SubFilter.
|
||||
$this->encryptdata['SubFilter'] = $this->encryptdata['pubkey'] ? $settings['SubFilter'] : '';
|
||||
$this->encryptdata['Recipients'] = $settings['Recipients'];
|
||||
|
||||
// Keep SubFilter and Recipients keys set from ENCRYPT_SETTINGS to preserve
|
||||
// stable array shape and avoid undefined-key access in output generation.
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the encryption data array.
|
||||
*
|
||||
* @return TEncryptData
|
||||
*/
|
||||
public function getEncryptionData(): array
|
||||
{
|
||||
return $this->encryptdata;
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert hexadecimal string to string.
|
||||
*
|
||||
* @param string $bstr Byte-string to convert.
|
||||
*/
|
||||
public function convertHexStringToString(string $bstr): string
|
||||
{
|
||||
$str = ''; // string to be returned
|
||||
$bslength = \strlen($bstr);
|
||||
if (($bslength % 2) !== 0) {
|
||||
// padding
|
||||
$bstr .= '0';
|
||||
++$bslength;
|
||||
}
|
||||
|
||||
for ($idx = 0; $idx < $bslength; $idx += 2) {
|
||||
$str .= \chr((int) \hexdec($bstr[$idx] . $bstr[$idx + 1]) & 0xFF);
|
||||
}
|
||||
|
||||
return $str;
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert string to hexadecimal string (byte string).
|
||||
*
|
||||
* @param string $str String to convert.
|
||||
*/
|
||||
public function convertStringToHexString(string $str): string
|
||||
{
|
||||
$chars = \preg_split('//', $str, -1, PREG_SPLIT_NO_EMPTY);
|
||||
if ($chars === false) {
|
||||
return '';
|
||||
}
|
||||
|
||||
$bstr = '';
|
||||
foreach ($chars as $char) {
|
||||
$bstr .= \sprintf('%02s', \dechex(\ord($char)));
|
||||
}
|
||||
|
||||
return $bstr;
|
||||
}
|
||||
|
||||
/**
|
||||
* Encode a name object.
|
||||
*
|
||||
* @param string $name Name object to encode.
|
||||
*/
|
||||
public function encodeNameObject(string $name): string
|
||||
{
|
||||
$escname = '';
|
||||
$length = \strlen($name);
|
||||
for ($idx = 0; $idx < $length; ++$idx) {
|
||||
$chr = $name[$idx];
|
||||
if (\preg_match('/[0-9a-zA-Z#_=-]/', $chr) === 1) {
|
||||
$escname .= $chr;
|
||||
continue;
|
||||
}
|
||||
|
||||
$escname .= \sprintf('#%02X', \ord($chr));
|
||||
}
|
||||
|
||||
return $escname;
|
||||
}
|
||||
|
||||
/**
|
||||
* Encrypt a string.
|
||||
*
|
||||
* @param string $str String to encrypt.
|
||||
* @param int $objnum Object ID.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function encryptString(string $str, int $objnum = 0): string
|
||||
{
|
||||
return $this->encrypt($this->encryptdata['mode'], $str, '', $objnum);
|
||||
}
|
||||
|
||||
/**
|
||||
* Format a data string for meta information.
|
||||
*
|
||||
* @param string $str Data string to escape.
|
||||
* @param int $objnum Object ID.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function escapeDataString(string $str, int $objnum = 0): string
|
||||
{
|
||||
return '(' . $this->escapeString($this->encryptString($str, $objnum)) . ')';
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a formatted date-time.
|
||||
*
|
||||
* @param int $time UTC time measured in the number of seconds since the Unix Epoch (January 1 1970 00:00:00 GMT).
|
||||
* @param int $objnum Object ID.
|
||||
*
|
||||
* @return string escaped date string.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function getFormattedDate(?int $time = null, int $objnum = 0): string
|
||||
{
|
||||
if ($time === null) {
|
||||
$time = \time(); // get current UTC time
|
||||
}
|
||||
|
||||
return $this->escapeDataString('D:' . \substr_replace(\date('YmdHisO', $time), "'", -2, 0) . "'", $objnum);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Exception.php
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Pdf\Encrypt;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*
|
||||
* Custom Exception class
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*/
|
||||
class Exception extends \Exception {}
|
||||
+306
@@ -0,0 +1,306 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Output.php
|
||||
*
|
||||
* @since 2008-01-02
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Pdf\Encrypt;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Pdf\Encrypt\Output
|
||||
*
|
||||
* PHP class for output encrypt PDF object
|
||||
*
|
||||
* @since 2008-01-02
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* @phpstan-type TEncryptData array{
|
||||
* 'CF': array{
|
||||
* 'AuthEvent': string,
|
||||
* 'CFM': string,
|
||||
* 'EncryptMetadata': bool,
|
||||
* 'Length': int,
|
||||
* },
|
||||
* 'EFF': string,
|
||||
* 'EncryptMetadata': bool,
|
||||
* 'Filter': string,
|
||||
* 'Length': int,
|
||||
* 'O': string,
|
||||
* 'OE': string,
|
||||
* 'OKS': string,
|
||||
* 'OVS': string,
|
||||
* 'P': int,
|
||||
* 'Recipients': array<string>,
|
||||
* 'StmF': string,
|
||||
* 'StrF': string,
|
||||
* 'SubFilter': string,
|
||||
* 'U': string,
|
||||
* 'UE': string,
|
||||
* 'UKS': string,
|
||||
* 'UVS': string,
|
||||
* 'V': int,
|
||||
* 'encrypted': bool,
|
||||
* 'fileid': string,
|
||||
* 'key': string,
|
||||
* 'mode': int,
|
||||
* 'objid': int,
|
||||
* 'owner_password': string,
|
||||
* 'perms': string,
|
||||
* 'protection': int,
|
||||
* 'pubkey': bool,
|
||||
* 'pubkeys'?: array{array{'c':string, 'p':array<string>}},
|
||||
* 'user_password': string,
|
||||
* }
|
||||
*/
|
||||
abstract class Output
|
||||
{
|
||||
/**
|
||||
* Encryption data
|
||||
*
|
||||
* @var TEncryptData
|
||||
*/
|
||||
protected array $encryptdata = [
|
||||
'CF' => [
|
||||
'AuthEvent' => '',
|
||||
'CFM' => '',
|
||||
'EncryptMetadata' => true,
|
||||
'Length' => 0,
|
||||
],
|
||||
'EFF' => '',
|
||||
'EncryptMetadata' => true,
|
||||
'Filter' => '',
|
||||
'Length' => 0,
|
||||
'O' => '',
|
||||
'OE' => '',
|
||||
'OKS' => '',
|
||||
'OVS' => '',
|
||||
'P' => 0,
|
||||
'Recipients' => [],
|
||||
'StmF' => '',
|
||||
'StrF' => '',
|
||||
'SubFilter' => '',
|
||||
'U' => '',
|
||||
'UE' => '',
|
||||
'UKS' => '',
|
||||
'UVS' => '',
|
||||
'V' => 0,
|
||||
'encrypted' => false,
|
||||
'fileid' => '',
|
||||
'key' => '',
|
||||
'mode' => 0,
|
||||
'objid' => 0,
|
||||
'owner_password' => '',
|
||||
'perms' => '',
|
||||
'protection' => 0,
|
||||
'pubkey' => false,
|
||||
// 'pubkeys' => [],
|
||||
'user_password' => '',
|
||||
];
|
||||
|
||||
/**
|
||||
* Escape a string: add "\" before "\", "(" and ")".
|
||||
*
|
||||
* @param string $str String to escape.
|
||||
*/
|
||||
public function escapeString(string $str): string
|
||||
{
|
||||
return \strtr($str, [
|
||||
')' => '\\)',
|
||||
'(' => '\\(',
|
||||
'\\' => '\\\\',
|
||||
\chr(13) => '\r',
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the PDF encryption block
|
||||
*
|
||||
* @param int $pon Current PDF object number
|
||||
*/
|
||||
public function getPdfEncryptionObj(int &$pon): string
|
||||
{
|
||||
$this->setMissingValues();
|
||||
$this->encryptdata['objid'] = ++$pon;
|
||||
$out =
|
||||
$this->encryptdata['objid']
|
||||
. ' 0 obj'
|
||||
. "\n"
|
||||
. '<<'
|
||||
. "\n"
|
||||
. '/Filter /'
|
||||
. $this->encryptdata['Filter']
|
||||
. "\n";
|
||||
if ($this->encryptdata['SubFilter'] !== '') {
|
||||
$out .= '/SubFilter /' . $this->encryptdata['SubFilter'] . "\n";
|
||||
}
|
||||
|
||||
// V is a code specifying the algorithm to be used in encrypting and decrypting the document
|
||||
$out .= '/V ' . $this->encryptdata['V'] . "\n";
|
||||
// The length of the encryption key, in bits. The value shall be a multiple of 8, in the range 40 to 256
|
||||
$out .= '/Length ' . $this->encryptdata['Length'] . "\n";
|
||||
if ($this->encryptdata['V'] >= 4) {
|
||||
$out .= $this->getCryptFilter();
|
||||
// The name of the crypt filter that shall be used by default when decrypting streams.
|
||||
$out .= '/StmF /' . $this->encryptdata['StmF'] . "\n";
|
||||
// The name of the crypt filter that shall be used when decrypting all strings in the document.
|
||||
$out .= '/StrF /' . $this->encryptdata['StrF'] . "\n";
|
||||
if ($this->encryptdata['EFF'] !== '') {
|
||||
// The name of the crypt filter that shall be used when encrypting embedded file streams
|
||||
// that do not have their own crypt filter specifier.
|
||||
$out .= '/EFF /' . $this->encryptdata['EFF'] . "\n";
|
||||
}
|
||||
}
|
||||
|
||||
return $out . ($this->getAdditionalEncDic() . '>>' . "\n" . 'endobj' . "\n");
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Crypt Filter section
|
||||
*
|
||||
* A dictionary whose keys shall be crypt filter names
|
||||
* and whose values shall be the corresponding crypt filter dictionaries.
|
||||
*/
|
||||
protected function getCryptFilter(): string
|
||||
{
|
||||
$out =
|
||||
'/CF <<'
|
||||
. "\n"
|
||||
. '/'
|
||||
. $this->encryptdata['StmF']
|
||||
. ' <<'
|
||||
. "\n"
|
||||
. '/Type /CryptFilter'
|
||||
. "\n"
|
||||
. '/CFM /'
|
||||
. $this->encryptdata['CF']['CFM']
|
||||
. "\n"; // The method used
|
||||
if ($this->encryptdata['pubkey']) {
|
||||
$out .= '/Recipients [';
|
||||
foreach ($this->encryptdata['Recipients'] as $rec) {
|
||||
$out .= ' <' . $rec . '>';
|
||||
}
|
||||
|
||||
$out .=
|
||||
' ]'
|
||||
. "\n"
|
||||
. '/EncryptMetadata '
|
||||
. $this->getBooleanString($this->encryptdata['CF']['EncryptMetadata'])
|
||||
. "\n";
|
||||
}
|
||||
|
||||
// The event to be used to trigger the authorization
|
||||
// that is required to access encryption keys used by this filter.
|
||||
$out .= '/AuthEvent /' . $this->encryptdata['CF']['AuthEvent'] . "\n";
|
||||
if ($this->encryptdata['CF']['Length'] !== 0) {
|
||||
// The bit length of the encryption key.
|
||||
$out .= '/Length ' . $this->encryptdata['CF']['Length'] . "\n";
|
||||
}
|
||||
|
||||
return $out . ('>>' . "\n" . '>>' . "\n");
|
||||
}
|
||||
|
||||
/**
|
||||
* get additional encryption dictionary entries for the standard security handler
|
||||
*/
|
||||
protected function getAdditionalEncDic(): string
|
||||
{
|
||||
$out = '';
|
||||
if ($this->encryptdata['pubkey']) {
|
||||
if ($this->encryptdata['V'] < 4 && $this->encryptdata['Recipients'] !== []) {
|
||||
$out .= ' /Recipients [';
|
||||
foreach ($this->encryptdata['Recipients'] as $rec) {
|
||||
$out .= ' <' . $rec . '>';
|
||||
}
|
||||
|
||||
$out .= ' ]' . "\n";
|
||||
}
|
||||
|
||||
return $out;
|
||||
}
|
||||
|
||||
$out .= '/R ';
|
||||
if ($this->encryptdata['V'] >= 5) { // AES-256 R5 or R6
|
||||
$revision = $this->encryptdata['V'] >= 6 ? '6' : '5';
|
||||
$out .=
|
||||
$revision
|
||||
. "\n"
|
||||
. '/OE ('
|
||||
. $this->escapeString($this->encryptdata['OE'])
|
||||
. ')'
|
||||
. "\n"
|
||||
. '/UE ('
|
||||
. $this->escapeString($this->encryptdata['UE'])
|
||||
. ')'
|
||||
. "\n"
|
||||
. '/Perms ('
|
||||
. $this->escapeString($this->encryptdata['perms'])
|
||||
. ')'
|
||||
. "\n";
|
||||
}
|
||||
|
||||
if ($this->encryptdata['V'] === 4) { // AES-128
|
||||
$out .= '4' . "\n";
|
||||
}
|
||||
|
||||
if ($this->encryptdata['V'] < 2) { // RC4-40
|
||||
$out .= '2' . "\n";
|
||||
}
|
||||
|
||||
if ($this->encryptdata['V'] >= 2 && $this->encryptdata['V'] < 4) { // RC4-128
|
||||
$out .= '3' . "\n";
|
||||
}
|
||||
|
||||
$out .=
|
||||
'/O ('
|
||||
. $this->escapeString($this->encryptdata['O'])
|
||||
. ')'
|
||||
. "\n"
|
||||
. '/U ('
|
||||
. $this->escapeString($this->encryptdata['U'])
|
||||
. ')'
|
||||
. "\n"
|
||||
. '/P '
|
||||
. $this->encryptdata['P']
|
||||
. "\n"
|
||||
. '/EncryptMetadata '
|
||||
. $this->getBooleanString($this->encryptdata['EncryptMetadata'])
|
||||
. "\n";
|
||||
|
||||
return $out;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return a string representation of a boolean value
|
||||
*
|
||||
* @param bool $value Value to convert
|
||||
*/
|
||||
protected function getBooleanString(bool $value): string
|
||||
{
|
||||
return $value ? 'true' : 'false';
|
||||
}
|
||||
|
||||
/**
|
||||
* Copy the EncryptMetadata flag into the crypt filter dictionary before output.
|
||||
*/
|
||||
protected function setMissingValues(): void
|
||||
{
|
||||
$this->encryptdata['CF']['EncryptMetadata'] = $this->encryptdata['EncryptMetadata'];
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,72 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* AES.php
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Pdf\Encrypt\Type;
|
||||
|
||||
use Com\Tecnick\Pdf\Encrypt\Exception as EncException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Pdf\Encrypt\Type\AES
|
||||
*
|
||||
* AES
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*/
|
||||
class AES
|
||||
{
|
||||
/**
|
||||
* Encrypt the data using OpenSSL
|
||||
*
|
||||
* @param string $data Data string to encrypt
|
||||
* @param string $key Encryption key
|
||||
* @param string $mode Cipher
|
||||
*
|
||||
* @return string encrypted text
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function encrypt(string $data, string $key, string $mode = ''): string
|
||||
{
|
||||
if ($mode === '') {
|
||||
$mode = \strlen($key) > 16 ? 'aes-256-cbc' : 'aes-128-cbc';
|
||||
}
|
||||
|
||||
$aesnopad = new AESnopad();
|
||||
$aesnopad->checkCipher($mode);
|
||||
|
||||
$len = \openssl_cipher_iv_length($mode);
|
||||
if ($len === false || $len <= 0) {
|
||||
throw new EncException('openssl_cipher_iv_length failed');
|
||||
}
|
||||
|
||||
$ivect = \openssl_random_pseudo_bytes($len);
|
||||
$enc = \openssl_encrypt($data, $mode, $key, OPENSSL_RAW_DATA, $ivect);
|
||||
|
||||
if ($enc === false) {
|
||||
throw new EncException('encryption error: ' . (string) \openssl_error_string());
|
||||
}
|
||||
|
||||
return $ivect . $enc;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,52 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* AESSixteen.php
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Pdf\Encrypt\Type;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Pdf\Encrypt\Type\AESSixteen
|
||||
*
|
||||
* AESSixteen
|
||||
* 16 bytes = 128 bit
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*/
|
||||
class AESSixteen
|
||||
{
|
||||
/**
|
||||
* Encrypt the data using OpenSSL
|
||||
*
|
||||
* @param string $data Data string to encrypt
|
||||
* @param string $key Encryption key
|
||||
*
|
||||
* @return string encrypted text
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function encrypt(string $data, string $key): string
|
||||
{
|
||||
$aes = new AES();
|
||||
return $aes->encrypt($data, $key, 'aes-128-cbc');
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,52 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* AESThirtytwo.php
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Pdf\Encrypt\Type;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Pdf\Encrypt\Type\AESThirtytwo
|
||||
*
|
||||
* AESThirtytwo
|
||||
* 32 bytes = 256 bit
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*/
|
||||
class AESThirtytwo
|
||||
{
|
||||
/**
|
||||
* Encrypt the data using OpenSSL
|
||||
*
|
||||
* @param string $data Data string to encrypt
|
||||
* @param string $key Encryption key
|
||||
*
|
||||
* @return string encrypted text
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function encrypt(string $data, string $key): string
|
||||
{
|
||||
$aes = new AES();
|
||||
return $aes->encrypt($data, $key, 'aes-256-cbc');
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,175 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* AESnopad.php
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Pdf\Encrypt\Type;
|
||||
|
||||
use Com\Tecnick\Pdf\Encrypt\Exception as EncException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Pdf\Encrypt\Type\AESnopad
|
||||
*
|
||||
* AES no-padding
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*/
|
||||
class AESnopad
|
||||
{
|
||||
/**
|
||||
* Block size (IV length):
|
||||
* \openssl_cipher_iv_length('aes-256-cbc')
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public const BLOCKSIZE = 16;
|
||||
|
||||
/**
|
||||
* Initialization Vector (16 bytes)
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public const IVECT = "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00";
|
||||
|
||||
/**
|
||||
* List of valid openssl cyphers for AES encryption.
|
||||
*
|
||||
* @var array<string>
|
||||
*/
|
||||
public const VALID_CIPHERS = [
|
||||
'aes-128-cbc',
|
||||
'aes-256-cbc',
|
||||
];
|
||||
|
||||
/**
|
||||
* Encrypt the data
|
||||
*
|
||||
* @param string $data Data string to encrypt
|
||||
* @param string $key Encryption key
|
||||
* @param string $ivect Initialization vector
|
||||
* @param string $mode Cipher
|
||||
*
|
||||
* @return string Encrypted data string.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function encrypt(
|
||||
string $data,
|
||||
string $key,
|
||||
string $ivect = self::IVECT,
|
||||
string $mode = 'aes-256-cbc',
|
||||
): string {
|
||||
$this->checkCipher($mode);
|
||||
|
||||
$enc = \openssl_encrypt(
|
||||
$this->pad($data, self::BLOCKSIZE),
|
||||
$mode,
|
||||
$this->pad($key, 2 * self::BLOCKSIZE),
|
||||
OPENSSL_RAW_DATA,
|
||||
$ivect,
|
||||
);
|
||||
|
||||
if ($enc === false) {
|
||||
throw new EncException('encryption error: ' . (string) \openssl_error_string());
|
||||
}
|
||||
|
||||
return \substr($enc, 0, -16);
|
||||
}
|
||||
|
||||
/**
|
||||
* Decrypt data that was produced by encrypt().
|
||||
*
|
||||
* encrypt() zero-pads the plaintext to 16-byte alignment, encrypts with PKCS7
|
||||
* (which appends one extra 16-byte block), then strips that trailing block.
|
||||
* This method decrypts with OPENSSL_ZERO_PADDING so no PKCS7 validation is
|
||||
* applied, recovering the zero-padded plaintext. When the original plaintext
|
||||
* length is known, the caller should strip any trailing zero bytes.
|
||||
*
|
||||
* @param string $data Encrypted data (produced by encrypt()).
|
||||
* @param string $key Encryption key.
|
||||
* @param string $ivect Initialization vector (default: 16 zero bytes).
|
||||
* @param string $mode Cipher (default: aes-256-cbc).
|
||||
*
|
||||
* @return string Decrypted data string.
|
||||
*
|
||||
* @throws EncException When decryption fails.
|
||||
*/
|
||||
public function decrypt(
|
||||
string $data,
|
||||
string $key,
|
||||
string $ivect = self::IVECT,
|
||||
string $mode = 'aes-256-cbc',
|
||||
): string {
|
||||
$this->checkCipher($mode);
|
||||
|
||||
$dec = \openssl_decrypt(
|
||||
$data,
|
||||
$mode,
|
||||
$this->pad($key, 2 * self::BLOCKSIZE),
|
||||
OPENSSL_RAW_DATA | OPENSSL_ZERO_PADDING,
|
||||
$ivect,
|
||||
);
|
||||
|
||||
if ($dec === false) {
|
||||
throw new EncException('decryption error: ' . (string) \openssl_error_string());
|
||||
}
|
||||
|
||||
return $dec;
|
||||
}
|
||||
|
||||
/**
|
||||
* Pad the input string to the specified length
|
||||
* (RFC 2898, PKCS #5: Password-Based Cryptography Specification Version 2.0)
|
||||
*
|
||||
* @param string $data Data to pad
|
||||
* @param int $length Padding length
|
||||
*
|
||||
* @return string Padded string
|
||||
*/
|
||||
protected function pad(string $data, int $length): string
|
||||
{
|
||||
$rem = \strlen($data) % $length;
|
||||
if ($rem !== 0) {
|
||||
$data .= \str_repeat("\x00", \max(0, $length - $rem));
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the cipher is valid and available.
|
||||
*
|
||||
* @param string $cipher openSSL cipher name.
|
||||
*
|
||||
* @throws EncException in case of error.
|
||||
*/
|
||||
public function checkCipher(string $cipher): void
|
||||
{
|
||||
if (!\in_array($cipher, self::VALID_CIPHERS, strict: true)) {
|
||||
throw new EncException('invalid cipher: ' . $cipher);
|
||||
}
|
||||
|
||||
if (!\in_array($cipher, \openssl_get_cipher_methods(), strict: true)) {
|
||||
throw new EncException('unavailable cipher: ' . $cipher);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,47 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* MDFiveSixteen.php
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Pdf\Encrypt\Type;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Pdf\Encrypt\Type\MDFiveSixteen
|
||||
*
|
||||
* MD5-16
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*/
|
||||
class MDFiveSixteen
|
||||
{
|
||||
/**
|
||||
* Encrypt the data
|
||||
*
|
||||
* @param string $data Data string to encrypt
|
||||
*
|
||||
* @return string encrypted text
|
||||
*/
|
||||
public function encrypt(string $data, string $_key = 'H*'): string
|
||||
{
|
||||
return \pack('H*', \md5($data));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,138 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* RCFour.php
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Pdf\Encrypt\Type;
|
||||
|
||||
use Com\Tecnick\Pdf\Encrypt\Exception as EncException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Pdf\Encrypt\Type\RCFour
|
||||
*
|
||||
* RC4 is the standard encryption algorithm used in PDF format
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*/
|
||||
class RCFour
|
||||
{
|
||||
/**
|
||||
* List of valid openssl cyphers for RC4 encryption.
|
||||
*
|
||||
* @var array<string>
|
||||
*/
|
||||
public const VALID_CIPHERS = [
|
||||
'RC4',
|
||||
'RC4-40',
|
||||
];
|
||||
|
||||
/**
|
||||
* Encrypt the data using the RC4 (Rivest Cipher 4, also known as ARC4 or ARCFOUR) algorithm.
|
||||
* RC4 is one of the standard encryption algorithm used in PDF format.
|
||||
* If possible, please use AES encryption instead as this is insecure.
|
||||
*
|
||||
* @param string $data Data string to encrypt
|
||||
* @param string $key Encryption key
|
||||
* @param string $mode Cipher
|
||||
*
|
||||
* @return string encrypted text
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function encrypt(string $data, string $key, string $mode = ''): string
|
||||
{
|
||||
if ($mode === '') {
|
||||
$mode = \strlen($key) > 5 ? 'RC4' : 'RC4-40';
|
||||
}
|
||||
|
||||
if (!\in_array($mode, self::VALID_CIPHERS, strict: true)) {
|
||||
throw new EncException('invalid cipher: ' . $mode);
|
||||
}
|
||||
|
||||
if (!\in_array($mode, \openssl_get_cipher_methods(), strict: true)) {
|
||||
return $this->rc4($data, $key);
|
||||
}
|
||||
|
||||
$enc = \openssl_encrypt($data, $mode, $key, OPENSSL_RAW_DATA | OPENSSL_ZERO_PADDING);
|
||||
if ($enc === false) {
|
||||
throw new EncException('openssl_encrypt failed');
|
||||
}
|
||||
|
||||
return $enc;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the input text encrypted using RC4 algorithm and the specified key.
|
||||
* This function is used when the openssl extension is not available.
|
||||
*
|
||||
* @param string $data Data string to encrypt
|
||||
* @param string $key Encryption key
|
||||
*
|
||||
* @return string encrypted text
|
||||
*/
|
||||
protected function rc4(string $data, string $key): string
|
||||
{
|
||||
$rc4 = $this->initRc4State($key);
|
||||
return $this->applyRc4Stream($data, $rc4);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<int, int>
|
||||
*/
|
||||
protected function initRc4State(string $key): array
|
||||
{
|
||||
$pkey = \str_repeat($key, \max(1, (int) ((256 / \strlen($key)) + 1)));
|
||||
/** @var array<int, int> $rc4 */
|
||||
$rc4 = \range(0, 255);
|
||||
$pos = 0;
|
||||
for ($idx = 0; $idx < 256; ++$idx) {
|
||||
$val = $rc4[$idx] ?? 0;
|
||||
$pos = ($pos + $val + \ord($pkey[$idx])) % 256;
|
||||
$rc4[$idx] = $rc4[$pos] ?? 0;
|
||||
$rc4[$pos] = $val;
|
||||
}
|
||||
|
||||
return $rc4;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<int, int> $rc4
|
||||
*/
|
||||
protected function applyRc4Stream(string $data, array $rc4): string
|
||||
{
|
||||
$len = \strlen($data);
|
||||
$posa = 0;
|
||||
$posb = 0;
|
||||
$out = '';
|
||||
for ($idx = 0; $idx < $len; ++$idx) {
|
||||
$posa = ($posa + 1) % 256;
|
||||
$val = $rc4[$posa] ?? 0;
|
||||
$posb = ($posb + $val) % 256;
|
||||
$rc4[$posa] = $rc4[$posb] ?? 0;
|
||||
$rc4[$posb] = $val;
|
||||
$pkey = $rc4[(($rc4[$posa] ?? 0) + ($rc4[$posb] ?? 0)) % 256] ?? 0;
|
||||
$out .= \chr((\ord($data[$idx]) ^ $pkey) & 0xFF);
|
||||
}
|
||||
|
||||
return $out;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,52 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* RCFourFive.php
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Pdf\Encrypt\Type;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Pdf\Encrypt\Type\RCFourFive
|
||||
*
|
||||
* RC4-40 is the standard encryption algorithm used in PDF format
|
||||
* The key length is 5 bytes (40 bits)
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*/
|
||||
class RCFourFive
|
||||
{
|
||||
/**
|
||||
* Encrypt the data
|
||||
*
|
||||
* @param string $data Data string to encrypt
|
||||
* @param string $key Encryption key
|
||||
*
|
||||
* @return string encrypted text
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function encrypt(string $data, string $key): string
|
||||
{
|
||||
$rcFour = new RCFour();
|
||||
return $rcFour->encrypt($data, $key, 'RC4-40');
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,52 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* RCFourSixteen.php
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Pdf\Encrypt\Type;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Pdf\Encrypt\Type\RCFourSixteen
|
||||
*
|
||||
* RC4-128 is the standard encryption algorithm used in PDF format
|
||||
* The key length is 16 bytes (128 bits)
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*/
|
||||
class RCFourSixteen
|
||||
{
|
||||
/**
|
||||
* Encrypt the data
|
||||
*
|
||||
* @param string $data Data string to encrypt
|
||||
* @param string $key Encryption key
|
||||
*
|
||||
* @return string encrypted text
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function encrypt(string $data, string $key): string
|
||||
{
|
||||
$rcFour = new RCFour();
|
||||
return $rcFour->encrypt($data, $key, 'RC4');
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,72 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Seed.php
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Pdf\Encrypt\Type;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Pdf\Encrypt\Type\Seed
|
||||
*
|
||||
* generate random seed
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*/
|
||||
class Seed
|
||||
{
|
||||
/**
|
||||
* Encrypt the data
|
||||
*
|
||||
* @param string $data Random seed data
|
||||
* @param string $key Random seed data
|
||||
* @param string $mode Default mode (openssl or raw)
|
||||
*
|
||||
* @return string seed
|
||||
*
|
||||
* @throws \Random\RandomException
|
||||
*/
|
||||
public function encrypt(string $data = '', string $key = '', string $mode = 'openssl'): string
|
||||
{
|
||||
$rnd = \uniqid(\random_int(0, \mt_getrandmax()) . microtime(true), true);
|
||||
|
||||
if (\function_exists('posix_getpid')) {
|
||||
$rnd .= \posix_getpid();
|
||||
}
|
||||
|
||||
if (
|
||||
$mode === 'openssl'
|
||||
&& \function_exists('openssl_random_pseudo_bytes')
|
||||
&& \strtoupper(\substr(PHP_OS, 0, 3)) !== 'WIN'
|
||||
) {
|
||||
// this is not used on windows systems because it is very slow for a known bug
|
||||
$rnd .= \openssl_random_pseudo_bytes(512);
|
||||
|
||||
return $rnd . $data . __DIR__ . __FILE__ . $key . \serialize($_SERVER) . microtime(true);
|
||||
}
|
||||
|
||||
for ($idx = 0; $idx < 23; ++$idx) {
|
||||
$rnd .= \uniqid('', true);
|
||||
}
|
||||
|
||||
return $rnd . $data . __DIR__ . __FILE__ . $key . \serialize($_SERVER) . microtime(true);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,417 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* DecryptTest.php
|
||||
*
|
||||
* @since 2026-04-30
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
|
||||
namespace Test;
|
||||
|
||||
use Com\Tecnick\Pdf\Encrypt\Decrypt;
|
||||
use Com\Tecnick\Pdf\Encrypt\Encrypt;
|
||||
|
||||
/**
|
||||
* Decrypt test
|
||||
*
|
||||
* Coverage notes (unreachable / untestable defensive guards):
|
||||
* - Decrypt::tryDecryptRecipient() `$tmpIn === false || $tmpOut === false`:
|
||||
* tempnam() failure requires a filesystem-level fault; cannot be reliably
|
||||
* induced in unit tests.
|
||||
* - Decrypt::tryDecryptRecipient() `file_put_contents === false`:
|
||||
* same as above.
|
||||
* - AESnopad::decrypt() `$dec === false`:
|
||||
* openssl_decrypt() cannot return false for well-formed AES-CBC ciphertext
|
||||
* with a valid key; this guard protects against hypothetical extension failures.
|
||||
* - Decrypt::decryptAes() `$dec === false` return '':
|
||||
* same reasoning; openssl_decrypt is called with correct key/iv/cipher.
|
||||
*
|
||||
* @since 2026-04-30
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*/
|
||||
class DecryptTest extends TestUtil
|
||||
{
|
||||
/** Build a Decrypt object from an Encrypt instance's encryption data. */
|
||||
private function decryptFromEncrypt(Encrypt $enc): Decrypt
|
||||
{
|
||||
return new Decrypt($enc->getEncryptionData());
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// Mode 2 (AES-128) — standard password authentication
|
||||
// -------------------------------------------------------------------------
|
||||
|
||||
public function testAuthenticateUserMode2(): void
|
||||
{
|
||||
$enc = new Encrypt(true, \md5('file'), 2, ['print'], 'userpass', 'ownerpass');
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
$this->assertTrue($dec->authenticate('userpass'));
|
||||
$this->assertNotEmpty($dec->getDocumentKey());
|
||||
}
|
||||
|
||||
public function testAuthenticateOwnerMode2(): void
|
||||
{
|
||||
$enc = new Encrypt(true, \md5('file'), 2, ['print'], 'userpass', 'ownerpass');
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
$this->assertTrue($dec->authenticate('ownerpass'));
|
||||
$this->assertNotEmpty($dec->getDocumentKey());
|
||||
}
|
||||
|
||||
public function testAuthenticateWrongPasswordMode2(): void
|
||||
{
|
||||
$enc = new Encrypt(true, \md5('file'), 2, ['print'], 'userpass', 'ownerpass');
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
$this->assertFalse($dec->authenticate('wrongpassword'));
|
||||
// Key must remain empty after failed authentication.
|
||||
$this->assertSame('', $dec->getDocumentKey());
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// Mode 3 (AES-256 R5) — standard password authentication
|
||||
// -------------------------------------------------------------------------
|
||||
|
||||
public function testAuthenticateUserMode3(): void
|
||||
{
|
||||
$enc = new Encrypt(true, \md5('file'), 3, ['print'], 'userpass', 'ownerpass');
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
$this->assertTrue($dec->authenticate('userpass'));
|
||||
$this->assertEquals(32, \strlen($dec->getDocumentKey()));
|
||||
}
|
||||
|
||||
public function testAuthenticateOwnerMode3(): void
|
||||
{
|
||||
$enc = new Encrypt(true, \md5('file'), 3, ['print'], 'userpass', 'ownerpass');
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
$this->assertTrue($dec->authenticate('ownerpass'));
|
||||
$this->assertEquals(32, \strlen($dec->getDocumentKey()));
|
||||
}
|
||||
|
||||
public function testAuthenticateWrongPasswordMode3(): void
|
||||
{
|
||||
$enc = new Encrypt(true, \md5('file'), 3, ['print'], 'userpass', 'ownerpass');
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
$this->assertFalse($dec->authenticate('wrong'));
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// Mode 4 (AES-256 R6 / PDF 2.0) — standard password authentication
|
||||
// -------------------------------------------------------------------------
|
||||
|
||||
public function testAuthenticateUserMode4(): void
|
||||
{
|
||||
$enc = new Encrypt(true, \md5('file'), 4, ['print'], 'userpass', 'ownerpass');
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
$this->assertTrue($dec->authenticate('userpass'));
|
||||
$this->assertEquals(32, \strlen($dec->getDocumentKey()));
|
||||
}
|
||||
|
||||
public function testAuthenticateOwnerMode4(): void
|
||||
{
|
||||
$enc = new Encrypt(true, \md5('file'), 4, ['print'], 'userpass', 'ownerpass');
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
$this->assertTrue($dec->authenticate('ownerpass'));
|
||||
$this->assertEquals(32, \strlen($dec->getDocumentKey()));
|
||||
}
|
||||
|
||||
public function testAuthenticateWrongPasswordMode4(): void
|
||||
{
|
||||
$enc = new Encrypt(true, \md5('file'), 4, ['print'], 'userpass', 'ownerpass');
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
$this->assertFalse($dec->authenticate('wrong'));
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// Modes 0 and 1 (RC4 — deprecated but must still authenticate correctly)
|
||||
// -------------------------------------------------------------------------
|
||||
|
||||
public function testAuthenticateUserMode0(): void
|
||||
{
|
||||
$this->bcAssertUserDeprecationMessageMatches('/RC4 encryption.*deprecated/i', function (): void {
|
||||
$enc = new Encrypt(true, \md5('file'), 0, ['print'], 'userpass', 'ownerpass');
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
$this->assertTrue($dec->authenticate('userpass'));
|
||||
$this->assertNotEmpty($dec->getDocumentKey());
|
||||
});
|
||||
}
|
||||
|
||||
public function testAuthenticateOwnerMode0(): void
|
||||
{
|
||||
$this->bcAssertUserDeprecationMessageMatches('/RC4 encryption.*deprecated/i', function (): void {
|
||||
$enc = new Encrypt(true, \md5('file'), 0, ['print'], 'userpass', 'ownerpass');
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
$this->assertTrue($dec->authenticate('ownerpass'));
|
||||
$this->assertNotEmpty($dec->getDocumentKey());
|
||||
});
|
||||
}
|
||||
|
||||
public function testAuthenticateUserMode1(): void
|
||||
{
|
||||
$this->bcAssertUserDeprecationMessageMatches('/RC4 encryption.*deprecated/i', function (): void {
|
||||
$enc = new Encrypt(true, \md5('file'), 1, ['print'], 'userpass', 'ownerpass');
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
$this->assertTrue($dec->authenticate('userpass'));
|
||||
$this->assertNotEmpty($dec->getDocumentKey());
|
||||
});
|
||||
}
|
||||
|
||||
public function testAuthenticateOwnerMode1(): void
|
||||
{
|
||||
$this->bcAssertUserDeprecationMessageMatches('/RC4 encryption.*deprecated/i', function (): void {
|
||||
$enc = new Encrypt(true, \md5('file'), 1, ['print'], 'userpass', 'ownerpass');
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
$this->assertTrue($dec->authenticate('ownerpass'));
|
||||
$this->assertNotEmpty($dec->getDocumentKey());
|
||||
});
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// decryptString round-trips
|
||||
// -------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* RC4 modes are symmetric: encrypt(encrypt(data, key)) = data.
|
||||
* The plaintext is recovered exactly (no padding).
|
||||
*/
|
||||
public function testDecryptStringRoundtripMode0(): void
|
||||
{
|
||||
$this->bcAssertUserDeprecationMessageMatches('/RC4 encryption.*deprecated/i', function (): void {
|
||||
$enc = new Encrypt(true, \md5('file'), 0, ['print'], 'alpha', 'beta');
|
||||
$plaintext = 'hello world';
|
||||
$ciphertext = $enc->encryptString($plaintext, 1);
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
$this->assertTrue($dec->authenticate('alpha'));
|
||||
$this->assertSame($plaintext, $dec->decryptString($ciphertext, 1));
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* AES-128: IV-prefixed stream; PKCS#7 padding is stripped so the exact
|
||||
* plaintext is recovered.
|
||||
*/
|
||||
public function testDecryptStringRoundtripMode2(): void
|
||||
{
|
||||
$enc = new Encrypt(true, \md5('file'), 2, ['print'], 'alpha', 'beta');
|
||||
$plaintext = 'hello world';
|
||||
$ciphertext = $enc->encryptString($plaintext, 1);
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
$this->assertTrue($dec->authenticate('alpha'));
|
||||
$this->assertSame($plaintext, $dec->decryptString($ciphertext, 1));
|
||||
}
|
||||
|
||||
/**
|
||||
* AES-256 R5: full document key used; exact plaintext recovered.
|
||||
*/
|
||||
public function testDecryptStringRoundtripMode3(): void
|
||||
{
|
||||
$enc = new Encrypt(true, \md5('file'), 3, ['print'], 'alpha', 'beta');
|
||||
$plaintext = 'hello world';
|
||||
$ciphertext = $enc->encryptString($plaintext, 1);
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
$this->assertTrue($dec->authenticate('alpha'));
|
||||
$this->assertSame($plaintext, $dec->decryptString($ciphertext, 1));
|
||||
}
|
||||
|
||||
/**
|
||||
* AES-256 R6: same as R5 but with hash2B key derivation.
|
||||
*/
|
||||
public function testDecryptStringRoundtripMode4(): void
|
||||
{
|
||||
$enc = new Encrypt(true, \md5('file'), 4, ['print'], 'alpha', 'beta');
|
||||
$plaintext = 'hello world';
|
||||
$ciphertext = $enc->encryptString($plaintext, 1);
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
$this->assertTrue($dec->authenticate('alpha'));
|
||||
$this->assertSame($plaintext, $dec->decryptString($ciphertext, 1));
|
||||
}
|
||||
|
||||
/**
|
||||
* Block-aligned plaintext (exactly 16 bytes) must round-trip exactly: the
|
||||
* PKCS#7 scheme appends a full extra padding block on encryption that must
|
||||
* be removed on decryption.
|
||||
*/
|
||||
public function testDecryptStringRoundtripBlockAligned(): void
|
||||
{
|
||||
foreach ([2, 3, 4] as $mode) {
|
||||
$enc = new Encrypt(true, \md5('file'), $mode, ['print'], 'alpha', 'beta');
|
||||
$plaintext = \str_repeat('A', 16);
|
||||
$ciphertext = $enc->encryptString($plaintext, 7);
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
$this->assertTrue($dec->authenticate('alpha'));
|
||||
$this->assertSame($plaintext, $dec->decryptString($ciphertext, 7), "mode {$mode}");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Empty plaintext must round-trip to an empty string for all AES modes.
|
||||
*/
|
||||
public function testDecryptStringRoundtripEmpty(): void
|
||||
{
|
||||
foreach ([2, 3, 4] as $mode) {
|
||||
$enc = new Encrypt(true, \md5('file'), $mode, ['print'], 'alpha', 'beta');
|
||||
$ciphertext = $enc->encryptString('', 3);
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
$this->assertTrue($dec->authenticate('alpha'));
|
||||
$this->assertSame('', $dec->decryptString($ciphertext, 3), "mode {$mode}");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Without authentication the key is empty; decryptString returns data that
|
||||
* differs from the original plaintext (garbage decrypt, not the correct value).
|
||||
*/
|
||||
public function testDecryptStringWithoutAuthProducesGarbage(): void
|
||||
{
|
||||
$enc = new Encrypt(true, \md5('file'), 3, ['print'], 'userpass', 'ownerpass');
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
// Key is cleared in constructor; without authenticate(), key is empty.
|
||||
$ciphertext = $enc->encryptString('hello world', 1);
|
||||
$result = $dec->decryptString($ciphertext, 1);
|
||||
// Without the correct key the output must differ from the plaintext.
|
||||
$this->assertStringNotContainsString('hello world', $result);
|
||||
}
|
||||
|
||||
/**
|
||||
* decryptString with too-short AES data (≤ 16 bytes) returns empty string.
|
||||
*/
|
||||
public function testDecryptStringAesTooShortData(): void
|
||||
{
|
||||
$enc = new Encrypt(true, \md5('file'), 3, ['print'], 'alpha', 'beta');
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
$this->assertTrue($dec->authenticate('alpha'));
|
||||
$this->assertSame('', $dec->decryptString(\str_repeat('x', 16), 0));
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// getDocumentKey after failed/successful authentication
|
||||
// -------------------------------------------------------------------------
|
||||
|
||||
public function testGetDocumentKeyAfterFailedAuth(): void
|
||||
{
|
||||
$enc = new Encrypt(true, \md5('file'), 3, ['print'], 'userpass', 'ownerpass');
|
||||
// Store the real key, then construct Decrypt with an overwritten empty key
|
||||
$data = $enc->getEncryptionData();
|
||||
$data['key'] = '';
|
||||
$dec = new Decrypt($data);
|
||||
$this->assertFalse($dec->authenticate('wrong'));
|
||||
$this->assertSame('', $dec->getDocumentKey());
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// Public-key mode authentication
|
||||
// -------------------------------------------------------------------------
|
||||
|
||||
public function testAuthenticatePublicKeyMode3(): void
|
||||
{
|
||||
$certPath = __DIR__ . '/data/cert.pem';
|
||||
$pubkeys = [['c' => $certPath, 'p' => ['print']]];
|
||||
$enc = new Encrypt(true, \md5('file'), 3, ['print'], '', '', $pubkeys);
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
$this->assertTrue($dec->authenticate('', $certPath));
|
||||
$this->assertEquals(32, \strlen($dec->getDocumentKey()));
|
||||
}
|
||||
|
||||
public function testAuthenticatePublicKeyMode1(): void
|
||||
{
|
||||
$this->bcRunIgnoringUserDeprecations(function (): void {
|
||||
// Mode 1 pubkey silently promotes mode 0 → 1 (covered elsewhere).
|
||||
$certPath = __DIR__ . '/data/cert.pem';
|
||||
$pubkeys = [['c' => $certPath, 'p' => ['print']]];
|
||||
$enc = new Encrypt(true, \md5('file'), 1, ['print'], '', '', $pubkeys);
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
$this->assertTrue($dec->authenticate('', $certPath));
|
||||
$this->assertNotEmpty($dec->getDocumentKey());
|
||||
});
|
||||
}
|
||||
|
||||
public function testAuthenticatePublicKeyEmptyPathReturnsFalse(): void
|
||||
{
|
||||
$certPath = __DIR__ . '/data/cert.pem';
|
||||
$pubkeys = [['c' => $certPath, 'p' => ['print']]];
|
||||
$enc = new Encrypt(true, \md5('file'), 3, ['print'], '', '', $pubkeys);
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
$this->assertFalse($dec->authenticate('', ''));
|
||||
}
|
||||
|
||||
public function testAuthenticatePublicKeyWrongKeyReturnsFalse(): void
|
||||
{
|
||||
$certPath = __DIR__ . '/data/cert.pem';
|
||||
$pubkeys = [['c' => $certPath, 'p' => ['print']]];
|
||||
$enc = new Encrypt(true, \md5('file'), 3, ['print'], '', '', $pubkeys);
|
||||
$dec = $this->decryptFromEncrypt($enc);
|
||||
// Use the test PHP file as a "wrong" key — openssl_pkcs7_decrypt will fail.
|
||||
$this->assertFalse($dec->authenticate('', __FILE__));
|
||||
}
|
||||
|
||||
/**
|
||||
* Cover the `hex2bin() === false` branch in findDecryptedRecipientSeed().
|
||||
*
|
||||
* When a Recipients entry contains non-hexadecimal characters, hex2bin()
|
||||
* returns false and the entry is skipped via `continue`. With no valid
|
||||
* entries the method returns null and authenticate() returns false.
|
||||
*/
|
||||
public function testAuthenticatePublicKeyInvalidHexRecipientReturnsFalse(): void
|
||||
{
|
||||
$certPath = __DIR__ . '/data/cert.pem';
|
||||
// Manually build an encryptdata array in pubkey mode whose Recipients
|
||||
// list contains only a string that is not valid hex (non-hex characters
|
||||
// cause hex2bin() to return false).
|
||||
$data = [
|
||||
'V' => 6,
|
||||
'Length' => 256,
|
||||
'O' => \str_repeat('x', 32),
|
||||
'U' => \str_repeat('x', 48),
|
||||
'P' => 0,
|
||||
'fileid' => \md5('test'),
|
||||
'mode' => 3,
|
||||
'pubkey' => true,
|
||||
'Recipients' => ['ZZZZINVALID!!'], // hex2bin returns false for non-hex chars
|
||||
];
|
||||
$dec = new \Com\Tecnick\Pdf\Encrypt\Decrypt($data);
|
||||
$this->assertFalse($dec->authenticate('', $certPath));
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// AESnopad::decrypt() direct tests
|
||||
// -------------------------------------------------------------------------
|
||||
|
||||
public function testAesnopadDecryptRoundtrip32Bytes(): void
|
||||
{
|
||||
$aesnopad = new \Com\Tecnick\Pdf\Encrypt\Type\AESnopad();
|
||||
$key = \str_repeat('k', 32);
|
||||
$plaintext = \str_repeat('p', 32); // exact 32-byte payload (e.g. file key)
|
||||
$ciphertext = $aesnopad->encrypt($plaintext, $key);
|
||||
$decrypted = $aesnopad->decrypt($ciphertext, $key);
|
||||
$this->assertSame($plaintext, $decrypted);
|
||||
}
|
||||
|
||||
public function testAesnopadDecryptRoundtripAes128(): void
|
||||
{
|
||||
$aesnopad = new \Com\Tecnick\Pdf\Encrypt\Type\AESnopad();
|
||||
$key = \str_repeat('k', 16);
|
||||
$plaintext = \str_repeat('p', 16);
|
||||
$ivect = \Com\Tecnick\Pdf\Encrypt\Type\AESnopad::IVECT;
|
||||
$ciphertext = $aesnopad->encrypt($plaintext, $key, $ivect, 'aes-128-cbc');
|
||||
$decrypted = $aesnopad->decrypt($ciphertext, $key, $ivect, 'aes-128-cbc');
|
||||
$this->assertSame($plaintext, $decrypted);
|
||||
}
|
||||
|
||||
public function testAesnopadDecryptInvalidCipherThrows(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Encrypt\Exception::class);
|
||||
$aesnopad = new \Com\Tecnick\Pdf\Encrypt\Type\AESnopad();
|
||||
$aesnopad->decrypt('data', 'key', \Com\Tecnick\Pdf\Encrypt\Type\AESnopad::IVECT, 'des-cbc');
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,460 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* EncryptTest.php
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
|
||||
namespace Test;
|
||||
|
||||
/**
|
||||
* Encrypt Test
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*/
|
||||
class EncryptTest extends TestUtil
|
||||
{
|
||||
// Coverage note: src/Compute.php hash2B() line ~295
|
||||
// `throw new EncException('AES-128-CBC encryption failed in hash2B')` is a defensive guard;
|
||||
// openssl_encrypt() never returns false for valid block-aligned AES-128-CBC inputs with
|
||||
// a correct 16-byte key and IV — this branch is unreachable under normal PHP/OpenSSL conditions.
|
||||
//
|
||||
// Coverage note: src/Compute.php getEncryptedRecipientBytes()
|
||||
// The `tempnam() === false` / `file_put_contents() === false` guards (and the
|
||||
// accompanying unlink() cleanup on those error paths) require a filesystem failure
|
||||
// that cannot be reliably induced in unit tests. The happy-path try/finally cleanup
|
||||
// and encryptRecipientEnvelope() are exercised by the public-key tests.
|
||||
//
|
||||
// Coverage note: src/Encrypt.php convertStringToHexString() line ~246
|
||||
// `return ''` after `preg_split('//', ...)` guards against the impossible case where
|
||||
// preg_split returns false; the regex '//\'' is always valid and never returns false.
|
||||
|
||||
public function testEncryptException(): void
|
||||
{
|
||||
$this->bcRunIgnoringUserDeprecations(function (): void {
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Encrypt\Exception::class);
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'));
|
||||
$encrypt->encrypt('WRONG');
|
||||
});
|
||||
}
|
||||
|
||||
public function testEncryptModeException(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Encrypt\Exception::class);
|
||||
new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 5);
|
||||
}
|
||||
|
||||
public function testEncryptThree(): void
|
||||
{
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 3, ['print'], 'alpha', 'beta');
|
||||
$result = $encrypt->encrypt(3, 'alpha');
|
||||
$this->assertEquals(32, \strlen($result));
|
||||
}
|
||||
|
||||
public function testEncryptWithAesEncoderName(): void
|
||||
{
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 3, ['print'], 'alpha', 'beta');
|
||||
$result = $encrypt->encrypt('AES', 'alpha', '0123456789abcdef0123456789abcdef');
|
||||
$this->assertGreaterThan(16, \strlen($result));
|
||||
}
|
||||
|
||||
public function testEncryptPubThree(): void
|
||||
{
|
||||
$pubkeys = [[
|
||||
'c' => __DIR__ . '/data/cert.pem',
|
||||
'p' => ['print'],
|
||||
]];
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 3, ['print'], 'alpha', 'beta', $pubkeys);
|
||||
$result = $encrypt->encrypt(3, 'alpha');
|
||||
$this->assertEquals(32, \strlen($result));
|
||||
}
|
||||
|
||||
public function testEncryptPubNoP(): void
|
||||
{
|
||||
$pubkeys = [[
|
||||
'c' => __DIR__ . '/data/cert.pem',
|
||||
'p' => ['print'],
|
||||
]];
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 3, ['print'], 'alpha', 'beta', $pubkeys);
|
||||
$result = $encrypt->encrypt(3, 'alpha');
|
||||
$this->assertEquals(32, \strlen($result));
|
||||
}
|
||||
|
||||
public function testEncryptPubException(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Encrypt\Exception::class);
|
||||
new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 3, ['print'], 'alpha', 'beta', [[
|
||||
'c' => __FILE__,
|
||||
'p' => ['print'],
|
||||
]]);
|
||||
}
|
||||
|
||||
public function testEncryptPubUnreadableCertificateException(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Encrypt\Exception::class);
|
||||
|
||||
\set_error_handler(static fn(): bool => true);
|
||||
try {
|
||||
new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 3, ['print'], 'alpha', 'beta', [[
|
||||
'c' => __DIR__ . '/data/does-not-exist.pem',
|
||||
'p' => ['print'],
|
||||
]]);
|
||||
} finally {
|
||||
\restore_error_handler();
|
||||
}
|
||||
}
|
||||
|
||||
public function testEncryptRc4ThroughOpenSslWhenAvailable(): void
|
||||
{
|
||||
if (!\in_array('RC4', \openssl_get_cipher_methods(), true)) {
|
||||
$this->markTestSkipped('OpenSSL RC4 cipher is not available on this runtime.');
|
||||
}
|
||||
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 3, ['print'], 'alpha', 'beta');
|
||||
$result = $encrypt->encrypt('RC4', 'alpha', '0123456789abcdef');
|
||||
$this->assertSame(5, \strlen($result));
|
||||
}
|
||||
|
||||
public function testEncryptModZeroPub(): void
|
||||
{
|
||||
$this->bcRunIgnoringUserDeprecations(function (): void {
|
||||
$pubkeys = [[
|
||||
'c' => __DIR__ . '/data/cert.pem',
|
||||
'p' => ['print'],
|
||||
]];
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(
|
||||
true,
|
||||
\md5('file_id'),
|
||||
0,
|
||||
['print'],
|
||||
'alpha',
|
||||
'beta',
|
||||
$pubkeys,
|
||||
);
|
||||
$result = $encrypt->encrypt(1, 'alpha');
|
||||
// Check for "error:0308010C:digital envelope routines::unsupported" when using OpenSSL 3.
|
||||
// \var_dump(\openssl_error_string());
|
||||
$this->assertEquals(5, \strlen($result));
|
||||
});
|
||||
}
|
||||
|
||||
/** Issue 6: RC4 mode 0 must emit a deprecation notice. */
|
||||
public function testRc4DeprecationModeZero(): void
|
||||
{
|
||||
$this->bcAssertUserDeprecationMessageMatches('/RC4 encryption.*deprecated.*cryptographically broken/i', function (): void {
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 0, ['print'], 'alpha', 'beta');
|
||||
$result = $encrypt->encrypt(0, 'alpha');
|
||||
$this->assertGreaterThan(0, \strlen($result));
|
||||
});
|
||||
}
|
||||
|
||||
/** Issue 6: RC4 mode 1 must emit a deprecation notice. */
|
||||
public function testRc4DeprecationModeOne(): void
|
||||
{
|
||||
$this->bcAssertUserDeprecationMessageMatches('/RC4 encryption.*deprecated.*cryptographically broken/i', function (): void {
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 1, ['print'], 'alpha', 'beta');
|
||||
$result = $encrypt->encrypt(1, 'alpha');
|
||||
$this->assertGreaterThan(0, \strlen($result));
|
||||
});
|
||||
}
|
||||
|
||||
/** Issue 5: mode 0 + pubkeys must emit the upgrade deprecation notice. */
|
||||
public function testPubKeyModeZeroDeprecation(): void
|
||||
{
|
||||
$this->bcAssertUserDeprecationMessageMatches('/Public-key encryption requires at least RC4-128/i', function (): void {
|
||||
$pubkeys = [[
|
||||
'c' => __DIR__ . '/data/cert.pem',
|
||||
'p' => ['print'],
|
||||
]];
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(
|
||||
true,
|
||||
\md5('file_id'),
|
||||
0,
|
||||
['print'],
|
||||
'alpha',
|
||||
'beta',
|
||||
$pubkeys,
|
||||
);
|
||||
// After promotion to mode 1, the resulting encryption data must reflect mode 1
|
||||
$data = $encrypt->getEncryptionData();
|
||||
$this->assertEquals(1, $data['mode']);
|
||||
$this->assertEquals(2, $data['V']);
|
||||
});
|
||||
}
|
||||
|
||||
/** Issue 2: AES-256 perms bytes 12-15 must be random (not 'nick'). */
|
||||
public function testPermsRandomBytes(): void
|
||||
{
|
||||
$encrypt1 = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 3, ['print'], 'alpha', 'beta');
|
||||
$encrypt2 = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 3, ['print'], 'alpha', 'beta');
|
||||
$data1 = $encrypt1->getEncryptionData();
|
||||
$data2 = $encrypt2->getEncryptionData();
|
||||
// The 16-byte AES-encrypted perms block (AESnopad strips the PKCS7 padding block)
|
||||
$this->assertEquals(16, \strlen($data1['perms']));
|
||||
$this->assertEquals(16, \strlen($data2['perms']));
|
||||
// Two independently generated perms values should almost certainly differ (random bytes 12-15)
|
||||
// Note: 1 in 2^32 chance of collision is acceptable to document rather than retry.
|
||||
$this->assertNotEquals($data1['perms'], $data2['perms'], 'perms bytes should be random each time');
|
||||
}
|
||||
|
||||
/** Issue 3: AES-256 with EncryptMetadata=false must store the flag. */
|
||||
public function testEncryptMetadataFalse(): void
|
||||
{
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(
|
||||
true,
|
||||
\md5('file_id'),
|
||||
3,
|
||||
['print'],
|
||||
'alpha',
|
||||
'beta',
|
||||
null,
|
||||
false, // encryptMetadata = false
|
||||
);
|
||||
$data = $encrypt->getEncryptionData();
|
||||
$this->assertFalse($data['EncryptMetadata']);
|
||||
}
|
||||
|
||||
/** Issue 4: AES-256 R6 (mode 4) encrypt round-trip. */
|
||||
public function testEncryptFour(): void
|
||||
{
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 4, ['print'], 'alpha', 'beta');
|
||||
$result = $encrypt->encrypt(4, 'alpha');
|
||||
$this->assertEquals(32, \strlen($result));
|
||||
}
|
||||
|
||||
/** Issue 4: AES-256 R6 (mode 4) encryptdata must have V=6 and mode=4. */
|
||||
public function testEncryptFourSettings(): void
|
||||
{
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 4, ['print'], 'alpha', 'beta');
|
||||
$data = $encrypt->getEncryptionData();
|
||||
$this->assertEquals(4, $data['mode']);
|
||||
$this->assertEquals(6, $data['V']);
|
||||
$this->assertEquals(256, $data['Length']);
|
||||
$this->assertEquals('AESV3', $data['CF']['CFM']);
|
||||
$this->assertEquals(48, \strlen($data['U']));
|
||||
$this->assertEquals(48, \strlen($data['O']));
|
||||
$this->assertEquals(32, \strlen($data['UE']));
|
||||
$this->assertEquals(32, \strlen($data['OE']));
|
||||
$this->assertEquals(16, \strlen($data['perms']));
|
||||
}
|
||||
|
||||
/** Issue 4: AES-256 R6 (mode 4) public-key encryption. */
|
||||
public function testEncryptPubFour(): void
|
||||
{
|
||||
$pubkeys = [[
|
||||
'c' => __DIR__ . '/data/cert.pem',
|
||||
'p' => ['print'],
|
||||
]];
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 4, ['print'], 'alpha', 'beta', $pubkeys);
|
||||
$result = $encrypt->encrypt(4, 'alpha');
|
||||
$this->assertEquals(32, \strlen($result));
|
||||
}
|
||||
|
||||
public function testGetEncryptionData(): void
|
||||
{
|
||||
$this->bcRunIgnoringUserDeprecations(function (): void {
|
||||
$permissions = ['print'];
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 0, $permissions, 'alpha', 'beta');
|
||||
$result = $encrypt->getEncryptionData();
|
||||
$this->assertEquals(2_147_422_008, $result['protection']);
|
||||
$this->assertEquals(1, $result['V']);
|
||||
$this->assertEquals(40, $result['Length']);
|
||||
$this->assertEquals('V2', $result['CF']['CFM']);
|
||||
});
|
||||
}
|
||||
|
||||
public function testGetObjectKey(): void
|
||||
{
|
||||
$permissions = ['print', 'modify', 'copy', 'annot-forms', 'fill-forms', 'extract', 'assemble', 'print-high'];
|
||||
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 2, $permissions, 'alpha', 'beta');
|
||||
$result = $encrypt->getObjectKey(123);
|
||||
$this->assertEquals('93879594941619c98047c404192b977d', \bin2hex($result));
|
||||
}
|
||||
|
||||
public function testGetUserPermissionCode(): void
|
||||
{
|
||||
$permissions = [
|
||||
'owner',
|
||||
'print',
|
||||
'modify',
|
||||
'copy',
|
||||
'annot-forms',
|
||||
'fill-forms',
|
||||
'extract',
|
||||
'assemble',
|
||||
'print-high',
|
||||
];
|
||||
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt();
|
||||
$result = $encrypt->getUserPermissionCode($permissions, 0);
|
||||
$this->assertEquals(2_147_421_954, $result);
|
||||
}
|
||||
|
||||
public function testGetUserPermissionCodeIgnoreInvalidPermission(): void
|
||||
{
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt();
|
||||
$result = $encrypt->getUserPermissionCode(['invalid-permission'], 0);
|
||||
$this->assertEquals(2_147_422_012, $result);
|
||||
}
|
||||
|
||||
public function testConvertHexStringToString(): void
|
||||
{
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt();
|
||||
|
||||
$result = $encrypt->convertHexStringToString('');
|
||||
$this->assertEquals('', $result);
|
||||
|
||||
$result = $encrypt->convertHexStringToString('68656c6c6f20776f726c64');
|
||||
$this->assertEquals('hello world', $result);
|
||||
|
||||
$result = $encrypt->convertHexStringToString('68656c6c6f20776f726c642');
|
||||
$this->assertEquals('hello world ', $result);
|
||||
}
|
||||
|
||||
public function testConvertStringToHexString(): void
|
||||
{
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt();
|
||||
|
||||
$result = $encrypt->convertStringToHexString('');
|
||||
$this->assertEquals('', $result);
|
||||
|
||||
$result = $encrypt->convertStringToHexString('hello world');
|
||||
$this->assertEquals('68656c6c6f20776f726c64', $result);
|
||||
}
|
||||
|
||||
public function testEncodeNameObject(): void
|
||||
{
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt();
|
||||
|
||||
$result = $encrypt->encodeNameObject('');
|
||||
$this->assertEquals('', $result);
|
||||
|
||||
$result = $encrypt->encodeNameObject('059akzAKZ#_=-');
|
||||
$this->assertEquals('059akzAKZ#_=-', $result);
|
||||
|
||||
$result = $encrypt->encodeNameObject('059[]{}+~*akzAKZ#_=-');
|
||||
$this->assertEquals('059#5B#5D#7B#7D#2B#7E#2AakzAKZ#_=-', $result);
|
||||
}
|
||||
|
||||
public function testEscapeString(): void
|
||||
{
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt();
|
||||
|
||||
$result = $encrypt->escapeString('');
|
||||
$this->assertEquals('', $result);
|
||||
|
||||
$result = $encrypt->escapeString('hello world');
|
||||
$this->assertEquals('hello world', $result);
|
||||
|
||||
$result = $encrypt->escapeString('(hello world) slash \\' . \chr(13));
|
||||
$this->assertEquals('\\(hello world\\) slash \\\\\r', $result);
|
||||
}
|
||||
|
||||
public function testEncryptStringDisabled(): void
|
||||
{
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt();
|
||||
|
||||
$result = $encrypt->encryptString('');
|
||||
$this->assertEquals('', $result);
|
||||
|
||||
$result = $encrypt->encryptString('hello world');
|
||||
$this->assertEquals('hello world', $result);
|
||||
|
||||
$result = $encrypt->encryptString('(hello world) slash \\' . \chr(13) . \chr(250));
|
||||
$this->assertEquals('(hello world) slash \\' . \chr(13) . \chr(250), $result);
|
||||
}
|
||||
|
||||
public function testEncryptStringEnabled(): void
|
||||
{
|
||||
$this->bcRunIgnoringUserDeprecations(function (): void {
|
||||
$permissions = [
|
||||
'print',
|
||||
'modify',
|
||||
'copy',
|
||||
'annot-forms',
|
||||
'fill-forms',
|
||||
'extract',
|
||||
'assemble',
|
||||
'print-high',
|
||||
];
|
||||
|
||||
$enc = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 0, $permissions, 'alpha');
|
||||
$result = $enc->encryptString('(hello world) slash \\' . \chr(13));
|
||||
$this->assertEquals('728cc693be1e4c1fb6b7e7b2a34644ad', \md5($result));
|
||||
|
||||
$enc = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 1, $permissions, 'alpha', 'beta');
|
||||
$result = $enc->encryptString('(hello world) slash \\' . \chr(13));
|
||||
$this->assertEquals('258ad774ddeec21b3b439a720df18e0d', \md5($result));
|
||||
});
|
||||
}
|
||||
|
||||
public function testEscapeDataStringDisabled(): void
|
||||
{
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt();
|
||||
|
||||
$result = $encrypt->escapeDataString('');
|
||||
$this->assertEquals('()', $result);
|
||||
|
||||
$result = $encrypt->escapeDataString('hello world');
|
||||
$this->assertEquals('(hello world)', $result);
|
||||
|
||||
$result = $encrypt->escapeDataString('(hello world) slash \\' . \chr(13));
|
||||
$this->assertEquals('(\\(hello world\\) slash \\\\\r)', $result);
|
||||
}
|
||||
|
||||
public function testEscapeDataStringEnabled(): void
|
||||
{
|
||||
$this->bcRunIgnoringUserDeprecations(function (): void {
|
||||
$permissions = [
|
||||
'print',
|
||||
'modify',
|
||||
'copy',
|
||||
'annot-forms',
|
||||
'fill-forms',
|
||||
'extract',
|
||||
'assemble',
|
||||
'print-high',
|
||||
];
|
||||
|
||||
$enc = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 0, $permissions, 'alpha');
|
||||
$result = $enc->escapeDataString('(hello world) slash \\' . \chr(13));
|
||||
$this->assertEquals('24f60765c1c07a44fc3c9b44d2f55dbc', \md5($result));
|
||||
|
||||
$enc = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 1, $permissions, 'alpha', 'beta');
|
||||
$result = $enc->escapeDataString('(hello world) slash \\' . \chr(13));
|
||||
$this->assertEquals('ebc28272f4aff661fa0b7764d791fb79', \md5($result));
|
||||
});
|
||||
}
|
||||
|
||||
public function testGetFormattedDate(): void
|
||||
{
|
||||
$permissions = ['print', 'modify', 'copy', 'annot-forms', 'fill-forms', 'extract', 'assemble', 'print-high'];
|
||||
|
||||
$enc = new \Com\Tecnick\Pdf\Encrypt\Encrypt(false);
|
||||
$result = $enc->getFormattedDate();
|
||||
$this->assertEquals('(D:', \substr($result, 0, 3));
|
||||
$this->assertEquals("+00'00')", \substr($result, -8));
|
||||
|
||||
$this->bcRunIgnoringUserDeprecations(function () use ($permissions): void {
|
||||
$enc = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 0, $permissions, 'alpha');
|
||||
$result = $enc->getFormattedDate();
|
||||
$this->assertNotEmpty($result);
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,279 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* OutputTest.php
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
|
||||
namespace Test;
|
||||
|
||||
/**
|
||||
* Output Test
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*/
|
||||
class OutputTest extends TestUtil
|
||||
{
|
||||
/** @param array<string,mixed> $data */
|
||||
protected function setRawEncryptData(OutputTestDouble $output, array $data): void
|
||||
{
|
||||
$property = new \ReflectionProperty(\Com\Tecnick\Pdf\Encrypt\Output::class, 'encryptdata');
|
||||
$property->setValue($output, $data);
|
||||
}
|
||||
|
||||
/** @return array<string,mixed> */
|
||||
protected function getRawEncryptData(OutputTestDouble $output): array
|
||||
{
|
||||
$property = new \ReflectionProperty(\Com\Tecnick\Pdf\Encrypt\Output::class, 'encryptdata');
|
||||
/** @var array<string,mixed> */
|
||||
return $property->getValue($output);
|
||||
}
|
||||
|
||||
protected function getOutputTestDouble(): OutputTestDouble
|
||||
{
|
||||
return new OutputTestDouble();
|
||||
}
|
||||
|
||||
public function testGetPdfEncryptionObjZero(): void
|
||||
{
|
||||
$this->bcRunIgnoringUserDeprecations(function (): void {
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 0, ['print'], 'alpha', 'beta');
|
||||
$pon = 122;
|
||||
$result = $encrypt->getPdfEncryptionObj($pon);
|
||||
$expected =
|
||||
'3132332030206f626a0a3c3c0a2f46696c746572202f5374616e646172640a2f5620310a2f4c656e6774682034300a2'
|
||||
. 'f5220320a2f4f20280542fa0e15496869a825cd08c633ac10675c5c02167661241f5369895d768278b1290a2f552028550539dc185'
|
||||
. 'e79d4c676f803babbdc50acf8a4427d2de5303d59e7c315b30eba290a2f5020323134373432323030380a2f456e63727970744d657'
|
||||
. '4616461746120747275650a3e3e0a656e646f626a0a';
|
||||
$this->assertEquals($expected, \bin2hex($result));
|
||||
});
|
||||
}
|
||||
|
||||
public function testGetPdfEncryptionObjOne(): void
|
||||
{
|
||||
$this->bcRunIgnoringUserDeprecations(function (): void {
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 1, ['print'], 'alpha', 'beta');
|
||||
$pon = 122;
|
||||
$result = $encrypt->getPdfEncryptionObj($pon);
|
||||
$this->assertTrue(\strlen($result) > 150);
|
||||
});
|
||||
}
|
||||
|
||||
public function testGetPdfEncryptionObjTwo(): void
|
||||
{
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 2, ['print'], 'alpha', 'beta');
|
||||
$pon = 122;
|
||||
$result = $encrypt->getPdfEncryptionObj($pon);
|
||||
$this->assertTrue(\strlen($result) > 200);
|
||||
}
|
||||
|
||||
public function testGetPdfEncryptionObjThree(): void
|
||||
{
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 3, ['print'], 'alpha', 'beta');
|
||||
$pon = 122;
|
||||
$result = $encrypt->getPdfEncryptionObj($pon);
|
||||
$this->assertTrue(\strlen($result) > 300);
|
||||
}
|
||||
|
||||
public function testGetPdfEncryptionObjThreePub(): void
|
||||
{
|
||||
$pubkeys = [[
|
||||
'c' => __DIR__ . '/data/cert.pem',
|
||||
'p' => ['print'],
|
||||
]];
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 3, ['print'], 'alpha', 'beta', $pubkeys);
|
||||
$pon = 122;
|
||||
$result = $encrypt->getPdfEncryptionObj($pon);
|
||||
$this->assertTrue(\strlen($result) > 200);
|
||||
}
|
||||
|
||||
public function testGetPdfEncryptionObjOnePub(): void
|
||||
{
|
||||
$this->bcRunIgnoringUserDeprecations(function (): void {
|
||||
$pubkeys = [[
|
||||
'c' => __DIR__ . '/data/cert.pem',
|
||||
'p' => ['print'],
|
||||
]];
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(
|
||||
true,
|
||||
\md5('file_id'),
|
||||
1,
|
||||
['print'],
|
||||
'alpha',
|
||||
'beta',
|
||||
$pubkeys,
|
||||
);
|
||||
$pon = 122;
|
||||
$result = $encrypt->getPdfEncryptionObj($pon);
|
||||
$this->assertTrue(\strlen($result) > 100);
|
||||
});
|
||||
}
|
||||
|
||||
public function testGetPdfEncryptionObjFour(): void
|
||||
{
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 4, ['print'], 'alpha', 'beta');
|
||||
$pon = 122;
|
||||
$result = $encrypt->getPdfEncryptionObj($pon);
|
||||
$this->assertTrue(\strlen($result) > 300);
|
||||
$this->assertStringContainsString('/V 6', $result);
|
||||
$this->assertStringContainsString('/R 6', $result);
|
||||
$this->assertStringContainsString('/Length 256', $result);
|
||||
}
|
||||
|
||||
/** Issue 1: EFF entry must appear for V >= 4 when embedded file encryption is enabled. */
|
||||
public function testGetPdfEncryptionObjEff(): void
|
||||
{
|
||||
// V >= 4 (mode 2 = AES-128, V=4) with embedded file encryption enabled (default)
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(
|
||||
true,
|
||||
\md5('file_id'),
|
||||
2,
|
||||
['print'],
|
||||
'alpha',
|
||||
'beta',
|
||||
null,
|
||||
true, // encryptMetadata
|
||||
true, // encryptEmbeddedFiles
|
||||
);
|
||||
$pon = 0;
|
||||
$result = $encrypt->getPdfEncryptionObj($pon);
|
||||
$this->assertStringContainsString('/EFF /StdCF', $result);
|
||||
}
|
||||
|
||||
/** Issue 1: No EFF entry when embedded file encryption is disabled. */
|
||||
public function testGetPdfEncryptionObjNoEff(): void
|
||||
{
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(
|
||||
true,
|
||||
\md5('file_id'),
|
||||
2,
|
||||
['print'],
|
||||
'alpha',
|
||||
'beta',
|
||||
null,
|
||||
true, // encryptMetadata
|
||||
false, // encryptEmbeddedFiles = false
|
||||
);
|
||||
$pon = 0;
|
||||
$result = $encrypt->getPdfEncryptionObj($pon);
|
||||
$this->assertStringNotContainsString('/EFF', $result);
|
||||
}
|
||||
|
||||
/** Issue 3: EncryptMetadata=false must appear in standard-mode output. */
|
||||
public function testGetPdfEncryptionObjEncryptMetadataFalse(): void
|
||||
{
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(
|
||||
true,
|
||||
\md5('file_id'),
|
||||
3,
|
||||
['print'],
|
||||
'alpha',
|
||||
'beta',
|
||||
null,
|
||||
false, // encryptMetadata = false
|
||||
);
|
||||
$pon = 0;
|
||||
$result = $encrypt->getPdfEncryptionObj($pon);
|
||||
$this->assertStringContainsString('/EncryptMetadata false', $result);
|
||||
}
|
||||
|
||||
/** Issue 3: EncryptMetadata=true (default) must appear as true in output. */
|
||||
public function testGetPdfEncryptionObjEncryptMetadataTrue(): void
|
||||
{
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 3, ['print'], 'alpha', 'beta');
|
||||
$pon = 0;
|
||||
$result = $encrypt->getPdfEncryptionObj($pon);
|
||||
$this->assertStringContainsString('/EncryptMetadata true', $result);
|
||||
}
|
||||
|
||||
/** Issue 4: mode 4 pubkey output must contain Recipients. */
|
||||
public function testGetPdfEncryptionObjFourPub(): void
|
||||
{
|
||||
$pubkeys = [[
|
||||
'c' => __DIR__ . '/data/cert.pem',
|
||||
'p' => ['print'],
|
||||
]];
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt(true, \md5('file_id'), 4, ['print'], 'alpha', 'beta', $pubkeys);
|
||||
$pon = 122;
|
||||
$result = $encrypt->getPdfEncryptionObj($pon);
|
||||
$this->assertTrue(\strlen($result) > 200);
|
||||
$this->assertStringContainsString('/V 6', $result);
|
||||
}
|
||||
|
||||
public function testSetMissingValuesCopiesEncryptMetadataFalseToCf(): void
|
||||
{
|
||||
$output = $this->getOutputTestDouble();
|
||||
$data = $this->getRawEncryptData($output);
|
||||
if (!isset($data['CF']) || !\is_array($data['CF'])) {
|
||||
$this->fail('Missing CF array in encryptdata');
|
||||
}
|
||||
|
||||
/** @var array<string,mixed> $cfData */
|
||||
$cfData = $data['CF'];
|
||||
$data['EncryptMetadata'] = false;
|
||||
$cfData['EncryptMetadata'] = true;
|
||||
$data['CF'] = $cfData;
|
||||
$this->setRawEncryptData($output, $data);
|
||||
|
||||
$output->callSetMissingValues();
|
||||
|
||||
$result = $this->getRawEncryptData($output);
|
||||
if (!isset($result['CF']) || !\is_array($result['CF'])) {
|
||||
$this->fail('Missing CF array in encryptdata');
|
||||
}
|
||||
|
||||
/** @var array<string,mixed> $cfData */
|
||||
$cfData = $result['CF'];
|
||||
if (!\array_key_exists('EncryptMetadata', $cfData) || !\is_bool($cfData['EncryptMetadata'])) {
|
||||
$this->fail('Missing boolean EncryptMetadata in CF array');
|
||||
}
|
||||
|
||||
$this->assertFalse($cfData['EncryptMetadata']);
|
||||
}
|
||||
|
||||
public function testSetMissingValuesCopiesEncryptMetadataTrueToCf(): void
|
||||
{
|
||||
$output = $this->getOutputTestDouble();
|
||||
$data = $this->getRawEncryptData($output);
|
||||
if (!isset($data['CF']) || !\is_array($data['CF'])) {
|
||||
$this->fail('Missing CF array in encryptdata');
|
||||
}
|
||||
|
||||
/** @var array<string,mixed> $cfData */
|
||||
$cfData = $data['CF'];
|
||||
$data['EncryptMetadata'] = true;
|
||||
$cfData['EncryptMetadata'] = false;
|
||||
$data['CF'] = $cfData;
|
||||
$this->setRawEncryptData($output, $data);
|
||||
|
||||
$output->callSetMissingValues();
|
||||
|
||||
$result = $this->getRawEncryptData($output);
|
||||
if (!isset($result['CF']) || !\is_array($result['CF'])) {
|
||||
$this->fail('Missing CF array in encryptdata');
|
||||
}
|
||||
|
||||
/** @var array<string,mixed> $cfData */
|
||||
$cfData = $result['CF'];
|
||||
if (!\array_key_exists('EncryptMetadata', $cfData) || !\is_bool($cfData['EncryptMetadata'])) {
|
||||
$this->fail('Missing boolean EncryptMetadata in CF array');
|
||||
}
|
||||
|
||||
$this->assertTrue($cfData['EncryptMetadata']);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,25 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* OutputTestDouble.php
|
||||
*
|
||||
* @since 2026-04-19
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
|
||||
namespace Test;
|
||||
|
||||
class OutputTestDouble extends \Com\Tecnick\Pdf\Encrypt\Output
|
||||
{
|
||||
public function callSetMissingValues(): void
|
||||
{
|
||||
$this->setMissingValues();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,96 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* TestUtil.php
|
||||
*
|
||||
* @since 2020-12-19
|
||||
* @category Library
|
||||
* @package file
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-file
|
||||
*
|
||||
* This file is part of tc-lib-file software library.
|
||||
*/
|
||||
|
||||
namespace Test;
|
||||
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
/**
|
||||
* Test Util
|
||||
*
|
||||
* @since 2020-12-19
|
||||
* @category Library
|
||||
* @package file
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-file
|
||||
*/
|
||||
class TestUtil extends TestCase
|
||||
{
|
||||
/**
|
||||
* @param class-string<\Throwable> $exception
|
||||
*/
|
||||
public function bcExpectException(string $exception): void
|
||||
{
|
||||
parent::expectException($exception);
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute a callback and assert that it triggers a matching user deprecation.
|
||||
*
|
||||
* @param callable():void $callback
|
||||
*/
|
||||
public function bcAssertUserDeprecationMessageMatches(string $pattern, callable $callback): void
|
||||
{
|
||||
$messages = [];
|
||||
|
||||
\set_error_handler(static function (int $errno, string $errstr) use (&$messages): bool {
|
||||
if ($errno !== E_USER_DEPRECATED) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$messages[] = $errstr;
|
||||
return true;
|
||||
});
|
||||
|
||||
try {
|
||||
$callback();
|
||||
} finally {
|
||||
\restore_error_handler();
|
||||
}
|
||||
|
||||
$this->assertNotEmpty($messages, 'Expected a user deprecation but none was triggered.');
|
||||
|
||||
foreach ($messages as $message) {
|
||||
if (\preg_match($pattern, $message) === 1) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
$this->fail(
|
||||
'User deprecation message did not match pattern ' . $pattern . '. Got: ' . \implode(' | ', $messages),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute a callback while swallowing user deprecations.
|
||||
*
|
||||
* @template T
|
||||
* @param callable():T $callback
|
||||
* @return T
|
||||
*/
|
||||
public function bcRunIgnoringUserDeprecations(callable $callback): mixed
|
||||
{
|
||||
\set_error_handler(static fn(int $errno): bool => $errno === E_USER_DEPRECATED);
|
||||
|
||||
try {
|
||||
return $callback();
|
||||
} finally {
|
||||
\restore_error_handler();
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,126 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* AESTest.php
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
|
||||
namespace Test;
|
||||
|
||||
/**
|
||||
* AES encryption Test
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*/
|
||||
class AESTest extends TestUtil
|
||||
{
|
||||
protected function getTestObject(): \Com\Tecnick\Pdf\Encrypt\Type\AES
|
||||
{
|
||||
return new \Com\Tecnick\Pdf\Encrypt\Type\AES();
|
||||
}
|
||||
|
||||
public function testEncrypt128(): void
|
||||
{
|
||||
$aes = $this->getTestObject();
|
||||
$data = 'alpha';
|
||||
$key = '0123456789abcdef'; // 16 bytes = 128 bit KEY
|
||||
|
||||
$enc_a = $aes->encrypt($data, $key);
|
||||
$enc_b = $aes->encrypt($data, $key, 'aes-128-cbc');
|
||||
$this->assertEquals(\strlen($enc_a), \strlen($enc_b));
|
||||
|
||||
$aesSixteen = new \Com\Tecnick\Pdf\Encrypt\Type\AESSixteen();
|
||||
$enc_c = $aesSixteen->encrypt($data, $key);
|
||||
$this->assertEquals(\strlen($enc_a), \strlen($enc_c));
|
||||
}
|
||||
|
||||
public function testEncrypt256(): void
|
||||
{
|
||||
$aes = $this->getTestObject();
|
||||
$data = 'alpha';
|
||||
$key = '0123456789abcdef0123456789abcdef'; // 32 bytes = 256 bit KEY
|
||||
|
||||
$enc_a = $aes->encrypt($data, $key, '');
|
||||
$enc_b = $aes->encrypt($data, $key, 'aes-256-cbc');
|
||||
$this->assertEquals(\strlen($enc_a), \strlen($enc_b));
|
||||
|
||||
$aesThirtytwo = new \Com\Tecnick\Pdf\Encrypt\Type\AESThirtytwo();
|
||||
$enc_c = $aesThirtytwo->encrypt($data, $key);
|
||||
$this->assertEquals(\strlen($enc_a), \strlen($enc_c));
|
||||
}
|
||||
|
||||
/**
|
||||
* AES::encrypt() output = 16-byte IV + PKCS#7-padded ciphertext.
|
||||
* padded_len = ceil((n + 1)/16) * 16, so aligned input gets one full block.
|
||||
* Total = padded_len + 16.
|
||||
*
|
||||
* With the old truncation bug, pad() always produced 16 bytes, so every
|
||||
* plaintext — no matter how long — produced a 32-byte output. These tests
|
||||
* verify that the output size grows correctly with the plaintext length.
|
||||
*/
|
||||
public function testEncrypt128LongData(): void
|
||||
{
|
||||
$aes = $this->getTestObject();
|
||||
$key = '0123456789abcdef'; // 16 bytes = 128 bit KEY
|
||||
|
||||
// 17 bytes → padded to 32 → 32 ciphertext + 16 IV = 48
|
||||
$enc17 = $aes->encrypt(\str_repeat('x', 17), $key, 'aes-128-cbc');
|
||||
$this->assertSame(48, \strlen($enc17));
|
||||
|
||||
// 32 bytes → padded to 48 (full PKCS#7 block) → 48 + 16 = 64
|
||||
$enc32 = $aes->encrypt(\str_repeat('x', 32), $key, 'aes-128-cbc');
|
||||
$this->assertSame(64, \strlen($enc32));
|
||||
|
||||
// 33 bytes → padded to 48 → 48 + 16 = 64
|
||||
$enc33 = $aes->encrypt(\str_repeat('x', 33), $key, 'aes-128-cbc');
|
||||
$this->assertSame(64, \strlen($enc33));
|
||||
|
||||
// Short input must produce shorter output than long input.
|
||||
$encShort = $aes->encrypt('alpha', $key, 'aes-128-cbc'); // 5 bytes → 32
|
||||
$this->assertGreaterThan(\strlen($encShort), \strlen($enc33));
|
||||
}
|
||||
|
||||
public function testEncrypt256LongData(): void
|
||||
{
|
||||
$aes = $this->getTestObject();
|
||||
$key = '0123456789abcdef0123456789abcdef'; // 32 bytes = 256 bit KEY
|
||||
|
||||
// 17 bytes → padded to 32 → 32 ciphertext + 16 IV = 48
|
||||
$enc17 = $aes->encrypt(\str_repeat('x', 17), $key, 'aes-256-cbc');
|
||||
$this->assertSame(48, \strlen($enc17));
|
||||
|
||||
// 32 bytes → padded to 48 (full PKCS#7 block) → 48 + 16 = 64
|
||||
$enc32 = $aes->encrypt(\str_repeat('x', 32), $key, 'aes-256-cbc');
|
||||
$this->assertSame(64, \strlen($enc32));
|
||||
|
||||
// 100 bytes → padded to 112 → 112 + 16 = 128
|
||||
$enc100 = $aes->encrypt(\str_repeat('x', 100), $key, 'aes-256-cbc');
|
||||
$this->assertSame(128, \strlen($enc100));
|
||||
|
||||
$aesThirtytwo = new \Com\Tecnick\Pdf\Encrypt\Type\AESThirtytwo();
|
||||
$enc100b = $aesThirtytwo->encrypt(\str_repeat('x', 100), $key);
|
||||
$this->assertSame(\strlen($enc100), \strlen($enc100b));
|
||||
}
|
||||
|
||||
public function testEncryptException(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Encrypt\Exception::class);
|
||||
$aes = $this->getTestObject();
|
||||
$aes->encrypt('alpha', '12345', 'ERROR');
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,183 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* AESnopadTest.php
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
|
||||
namespace Test;
|
||||
|
||||
use Com\Tecnick\Pdf\Encrypt\Type\AESnopad;
|
||||
|
||||
/**
|
||||
* AESnopad encryption Test
|
||||
*
|
||||
* Verifies that pad() extends data to the next multiple of BLOCKSIZE without
|
||||
* truncating, so that stream data longer than one AES block is not silently
|
||||
* discarded before encryption.
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*/
|
||||
class AESnopadTest extends TestUtil
|
||||
{
|
||||
/**
|
||||
* 32-byte key used throughout (exact multiple of BLOCKSIZE, no padding applied).
|
||||
*/
|
||||
private const KEY256 = '0123456789abcdef0123456789abcdef';
|
||||
|
||||
protected function getTestObject(): AESnopad
|
||||
{
|
||||
return new AESnopad();
|
||||
}
|
||||
|
||||
/**
|
||||
* AESnopad::encrypt() returns padded_len bytes of ciphertext (no IV prefix).
|
||||
* padded_len = ceil(n / 16) * 16, but if n % 16 == 0 then padded_len = n.
|
||||
*
|
||||
* The formula below matches that behaviour for all cases tested.
|
||||
*/
|
||||
private function expectedCiphertextLen(int $plainLen): int
|
||||
{
|
||||
$rem = $plainLen % AESnopad::BLOCKSIZE;
|
||||
return $rem === 0 ? $plainLen : $plainLen + (AESnopad::BLOCKSIZE - $rem);
|
||||
}
|
||||
|
||||
// --- output-length tests (validate pad() indirectly) ---
|
||||
|
||||
public function testEncryptOutputLenShortData(): void
|
||||
{
|
||||
// 5 bytes → padded to 16
|
||||
$enc = $this->getTestObject()->encrypt(\str_repeat('x', 5), self::KEY256);
|
||||
$this->assertSame($this->expectedCiphertextLen(5), \strlen($enc));
|
||||
}
|
||||
|
||||
public function testEncryptOutputLenExactlyOneBlock(): void
|
||||
{
|
||||
// 16 bytes → already a multiple, no extra padding → 16
|
||||
$enc = $this->getTestObject()->encrypt(\str_repeat('x', 16), self::KEY256);
|
||||
$this->assertSame($this->expectedCiphertextLen(16), \strlen($enc));
|
||||
}
|
||||
|
||||
public function testEncryptOutputLenJustOverOneBlock(): void
|
||||
{
|
||||
// 17 bytes → padded to 32
|
||||
// This test would fail with the old code (which truncated data to 16 bytes,
|
||||
// producing only 16 bytes of ciphertext regardless of input length).
|
||||
$enc = $this->getTestObject()->encrypt(\str_repeat('x', 17), self::KEY256);
|
||||
$this->assertSame($this->expectedCiphertextLen(17), \strlen($enc));
|
||||
}
|
||||
|
||||
public function testEncryptOutputLenTwoBlocks(): void
|
||||
{
|
||||
// 32 bytes → padded to 32
|
||||
$enc = $this->getTestObject()->encrypt(\str_repeat('x', 32), self::KEY256);
|
||||
$this->assertSame($this->expectedCiphertextLen(32), \strlen($enc));
|
||||
}
|
||||
|
||||
public function testEncryptOutputLenJustOverTwoBlocks(): void
|
||||
{
|
||||
// 33 bytes → padded to 48
|
||||
$enc = $this->getTestObject()->encrypt(\str_repeat('x', 33), self::KEY256);
|
||||
$this->assertSame($this->expectedCiphertextLen(33), \strlen($enc));
|
||||
}
|
||||
|
||||
public function testEncryptOutputLenLargeData(): void
|
||||
{
|
||||
// 100 bytes → padded to 112
|
||||
$enc = $this->getTestObject()->encrypt(\str_repeat('x', 100), self::KEY256);
|
||||
$this->assertSame($this->expectedCiphertextLen(100), \strlen($enc));
|
||||
}
|
||||
|
||||
/**
|
||||
* Longer input must produce longer ciphertext.
|
||||
* With the old bug, both short and long inputs produced 16-byte ciphertext.
|
||||
*/
|
||||
public function testCiphertextGrowsWithPlaintext(): void
|
||||
{
|
||||
$aesnopad = $this->getTestObject();
|
||||
$key = self::KEY256;
|
||||
|
||||
$short = $aesnopad->encrypt(\str_repeat('a', 5), $key);
|
||||
$long = $aesnopad->encrypt(\str_repeat('a', 100), $key);
|
||||
|
||||
$this->assertGreaterThan(\strlen($short), \strlen($long));
|
||||
}
|
||||
|
||||
// --- AES-128-CBC variant ---
|
||||
|
||||
public function testEncryptAes128OutputLen(): void
|
||||
{
|
||||
// 17 bytes with aes-128-cbc → padded to 32
|
||||
$enc = $this->getTestObject()->encrypt(\str_repeat('x', 17), self::KEY256, AESnopad::IVECT, 'aes-128-cbc');
|
||||
$this->assertSame($this->expectedCiphertextLen(17), \strlen($enc));
|
||||
}
|
||||
|
||||
// --- deterministic output with fixed IV ---
|
||||
|
||||
public function testEncryptDeterministicWithFixedIv(): void
|
||||
{
|
||||
$aesnopad = $this->getTestObject();
|
||||
$data = \str_repeat('x', 32);
|
||||
$key = self::KEY256;
|
||||
|
||||
$enc1 = $aesnopad->encrypt($data, $key, AESnopad::IVECT, 'aes-256-cbc');
|
||||
$enc2 = $aesnopad->encrypt($data, $key, AESnopad::IVECT, 'aes-256-cbc');
|
||||
$this->assertSame($enc1, $enc2);
|
||||
}
|
||||
|
||||
// --- exception paths ---
|
||||
|
||||
public function testCheckCipherInvalidName(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Encrypt\Exception::class);
|
||||
$this->getTestObject()->checkCipher('des-cbc');
|
||||
}
|
||||
|
||||
public function testEncryptInvalidCipher(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Encrypt\Exception::class);
|
||||
$this->getTestObject()->encrypt('data', self::KEY256, AESnopad::IVECT, 'des-cbc');
|
||||
}
|
||||
|
||||
public function testCheckCipherUnavailable(): void
|
||||
{
|
||||
$missingCipher = null;
|
||||
$available = \openssl_get_cipher_methods();
|
||||
foreach (AESnopad::VALID_CIPHERS as $cipher) {
|
||||
if (\in_array($cipher, $available, true)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$missingCipher = $cipher;
|
||||
break;
|
||||
}
|
||||
|
||||
if ($missingCipher === null) {
|
||||
$this->markTestSkipped('All AESnopad valid ciphers are available on this runtime.');
|
||||
}
|
||||
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Encrypt\Exception::class);
|
||||
$this->getTestObject()->checkCipher($missingCipher);
|
||||
}
|
||||
|
||||
public function testDecryptInvalidCiphertextLength(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Encrypt\Exception::class);
|
||||
$this->getTestObject()->decrypt('short', self::KEY256, AESnopad::IVECT, 'aes-256-cbc');
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,43 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* MDFiveSixteenTest.php
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
|
||||
namespace Test;
|
||||
|
||||
/**
|
||||
* MD5-16 encryption Test
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*/
|
||||
class MDFiveSixteenTest extends TestUtil
|
||||
{
|
||||
protected function getTestObject(): \Com\Tecnick\Pdf\Encrypt\Type\MDFiveSixteen
|
||||
{
|
||||
return new \Com\Tecnick\Pdf\Encrypt\Type\MDFiveSixteen();
|
||||
}
|
||||
|
||||
public function testEncrypt(): void
|
||||
{
|
||||
$mdFiveSixteen = $this->getTestObject();
|
||||
$result = $mdFiveSixteen->encrypt('hello');
|
||||
$this->assertEquals('5d41402abc4b2a76b9719d911017c592', \bin2hex($result));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,73 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* RCFourTest.php
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
|
||||
namespace Test;
|
||||
|
||||
/**
|
||||
* RC4 encryption Test
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*/
|
||||
class RCFourTest extends TestUtil
|
||||
{
|
||||
protected function getTestObject(): \Com\Tecnick\Pdf\Encrypt\Type\RCFour
|
||||
{
|
||||
return new \Com\Tecnick\Pdf\Encrypt\Type\RCFour();
|
||||
}
|
||||
|
||||
public function testEncrypt40(): void
|
||||
{
|
||||
$rcFour = $this->getTestObject();
|
||||
$data = 'alpha';
|
||||
$key = '12345'; // 5 bytes = 40 bit KEY
|
||||
|
||||
$enc_a = $rcFour->encrypt($data, $key, '');
|
||||
$enc_b = $rcFour->encrypt($data, $key, 'RC4-40');
|
||||
$this->assertEquals($enc_a, $enc_b);
|
||||
|
||||
$rcFourFive = new \Com\Tecnick\Pdf\Encrypt\Type\RCFourFive();
|
||||
$enc_c = $rcFourFive->encrypt($data, $key);
|
||||
$this->assertEquals($enc_a, $enc_c);
|
||||
}
|
||||
|
||||
public function testEncrypt128(): void
|
||||
{
|
||||
$rcFour = $this->getTestObject();
|
||||
$data = 'alpha';
|
||||
$key = '0123456789abcdef'; // 16 bytes = 128 bit KEY
|
||||
|
||||
$enc_a = $rcFour->encrypt($data, $key);
|
||||
$enc_b = $rcFour->encrypt($data, $key, 'RC4');
|
||||
$this->assertEquals($enc_a, $enc_b);
|
||||
|
||||
$rcFourSixteen = new \Com\Tecnick\Pdf\Encrypt\Type\RCFourSixteen();
|
||||
$enc_c = $rcFourSixteen->encrypt($data, $key);
|
||||
$this->assertEquals($enc_a, $enc_c);
|
||||
}
|
||||
|
||||
public function testEncryptException(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Encrypt\Exception::class);
|
||||
$rcFour = $this->getTestObject();
|
||||
$rcFour->encrypt('alpha', '12345', 'ERROR');
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,50 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* SeedTest.php
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*
|
||||
* This file is part of tc-lib-pdf-encrypt software library.
|
||||
*/
|
||||
|
||||
namespace Test;
|
||||
|
||||
/**
|
||||
* Seed Test
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfEncrypt
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-encrypt
|
||||
*/
|
||||
class SeedTest extends TestUtil
|
||||
{
|
||||
protected function getTestObject(): \Com\Tecnick\Pdf\Encrypt\Type\Seed
|
||||
{
|
||||
return new \Com\Tecnick\Pdf\Encrypt\Type\Seed();
|
||||
}
|
||||
|
||||
public function testEncrypt(): void
|
||||
{
|
||||
$seed = $this->getTestObject();
|
||||
$result = $seed->encrypt('hello', 'world');
|
||||
$this->assertNotEmpty($result);
|
||||
}
|
||||
|
||||
public function testEncryptRaw(): void
|
||||
{
|
||||
$seed = $this->getTestObject();
|
||||
$result = $seed->encrypt('hello', 'world', 'raw');
|
||||
$this->assertNotEmpty($result);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
-----BEGIN PRIVATE KEY-----
|
||||
MIICdQIBADANBgkqhkiG9w0BAQEFAASCAl8wggJbAgEAAoGBALtxWB+0PKdvXMih
|
||||
p8+xkg4BzMH8MDyNQNqv56mhrQ5wM1icQaoB1dXWUZj8NRPgvzkhw7xJ98P3Kka7
|
||||
mLA2qDNGh77H8aYc64pIII8Xd1iQMbHVrUqtsEec7ZCHL3U63rLeERCqu+eibQl4
|
||||
2w14bdflcMun0xHN/aJyA7sJWmInAgMBAAECgYB8dGNomYl0OpLGe98qHeK1/ifv
|
||||
3PxCGB+plAYjMT/wSDsvaICI2rMaSjTfeQXc7urIikymJg6mROQDFufoiEHgtliz
|
||||
mQeQIss6xPoBeObRBptjPBnmREnB3pP1nBngDmDQj/BwDsxbHXiZxRvQNvvKllyE
|
||||
vF0i9ZjgT+Bh1/pKoQJBAOiEFZTZxMF+Ri3VVMEhV8CkMSom4815OPg+5RhS/mwX
|
||||
X5bBG6AdLbOYgvq1iMGnjRZs9Vquk+uzmpMw+Uds8rkCQQDOX9m2t2O51/QyROIY
|
||||
obJGHp4fyAtGHH/qbyFg3L7c/LolqqDnq+26tP7+UdKXMZeGMs1FeL4crLcpJab8
|
||||
rQvfAkA7zJScVrGCrg4whXgpv4CJG/FFDQFze+TJ+6sB6X5joFNGO132fOqfEO9G
|
||||
uV91prjjdpxXeSSz7tonVuYVl5CJAkBW8xNrZEDkIBSGyXbpIddWq7e7dDErzP4n
|
||||
68KIaPkRanmTPRyl/04eB/wXcqnjgcVxiR3rUz/mHO7eqzp74vzJAkB+O8VRe350
|
||||
4I9Ut/gZmUW3IiSVT2FfZezk2XoB3X+zFKfhdhNt0i8EUwoTTI1mwy3nUyqMc/sb
|
||||
JhEpQgcZ31SP
|
||||
-----END PRIVATE KEY-----
|
||||
-----BEGIN CERTIFICATE-----
|
||||
MIICsDCCAhmgAwIBAgIUAQb8DRdrYNBU56/iGjwLAKJ3dLQwDQYJKoZIhvcNAQEL
|
||||
BQAwajELMAkGA1UEBhMCVUsxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoM
|
||||
GEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDEjMCEGCSqGSIb3DQEJARYUdGVzdEBl
|
||||
eGFtcGxlLmludmFsaWQwHhcNMjIxMjIxMTExNjA5WhcNMzIxMjE4MTExNjA5WjBq
|
||||
MQswCQYDVQQGEwJVSzETMBEGA1UECAwKU29tZS1TdGF0ZTEhMB8GA1UECgwYSW50
|
||||
ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMSMwIQYJKoZIhvcNAQkBFhR0ZXN0QGV4YW1w
|
||||
bGUuaW52YWxpZDCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAu3FYH7Q8p29c
|
||||
yKGnz7GSDgHMwfwwPI1A2q/nqaGtDnAzWJxBqgHV1dZRmPw1E+C/OSHDvEn3w/cq
|
||||
RruYsDaoM0aHvsfxphzrikggjxd3WJAxsdWtSq2wR5ztkIcvdTrest4REKq756Jt
|
||||
CXjbDXht1+Vwy6fTEc39onIDuwlaYicCAwEAAaNTMFEwHQYDVR0OBBYEFLULVT3y
|
||||
ounwqaWxwEaFOs7s0+DFMB8GA1UdIwQYMBaAFLULVT3younwqaWxwEaFOs7s0+DF
|
||||
MA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQELBQADgYEAJ8Gh0uOLLZA3UsmL
|
||||
eUxOrS19QbfNuDzfayiOuLwiMCKCY29ch/HEaKPdvUuGAbFczhnryJLsb6TYBBeP
|
||||
a4zUcyhylafqZH450awKEOxd/5ns0QoWlFeBkgVSHK/j7BP8P9LXZkjM4nLJXoAl
|
||||
M/SOSeyHUEHfE97284X8VaNPCT4=
|
||||
-----END CERTIFICATE-----
|
||||
Reference in New Issue
Block a user