https://github.com/tecnickcom/tc-lib-pdf-encrypt
PHP library to encrypt data for PDF documents
https://github.com/tecnickcom/tc-lib-pdf-encrypt
Last synced: 6 months ago
JSON representation
PHP library to encrypt data for PDF documents
- Host: GitHub
- URL: https://github.com/tecnickcom/tc-lib-pdf-encrypt
- Owner: tecnickcom
- License: other
- Created: 2015-11-26T11:37:12.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2024-09-06T12:58:13.000Z (about 1 year ago)
- Last Synced: 2024-10-06T17:07:49.597Z (about 1 year ago)
- Language: PHP
- Size: 198 KB
- Stars: 7
- Watchers: 4
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# tc-lib-pdf-encrypt
*PHP library to encrypt data for PDF*
[](https://packagist.org/packages/tecnickcom/tc-lib-pdf-encrypt)
[](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://www.paypal.com/cgi-bin/webscr?cmd=_donations¤cy_code=GBP&business=paypal@tecnick.com&item_name=donation%20for%20tc-lib-pdf-encrypt%20project)
*Please consider supporting this project by making a donation via [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_donations¤cy_code=GBP&business=paypal@tecnick.com&item_name=donation%20for%20tc-lib-pdf-encrypt%20project)*
* **category** Library
* **package** \Com\Tecnick\Pdf\Encrypt
* **author** Nicola Asuni
* **copyright** 2011-2024 Nicola Asuni - Tecnick.com LTD
* **license** http://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
* **link** https://github.com/tecnickcom/tc-lib-pdf-encrypt
* **SRC DOC** https://tcpdf.org/docs/srcdoc/tc-lib-pdf-encrypt
## Description
PHP library to encrypt data for PDF.
The initial source code has been derived from [TCPDF]().
### OpenSSL 3
When using OpenSSL 3 some legacy providers are disabled by default.
This will trigger the following error when executing the test:
```
error:0308010C:digital envelope routines::unsupported
```
Legacy provider can be enabled by followign the instructions at: https://wiki.openssl.org/index.php/OpenSSL_3.0#Providers
```bash
sudo nano /etc/ssl/openssl.cnf
```
```bash
openssl_conf = openssl_init
[openssl_init]
providers = provider_sect
[provider_sect]
default = default_sect
legacy = legacy_sect
[default_sect]
activate = 1
[legacy_sect]
activate = 1
```
An alternative OpenSSL configuration file is provided on and set by default in the Makefile.
To overrride the custom OpenSSL configuration file set the following environment variable:
```bash
export OPENSSL_CONF=/etc/ssl/openssl.cnf
```
## Getting started
This library requires the openssl php extension.
First, you need to install all development dependencies using [Composer](https://getcomposer.org/):
```bash
$ curl -sS https://getcomposer.org/installer | php
$ mv composer.phar /usr/local/bin/composer
```
This project include a Makefile that allows you to test and build the project with simple commands.
To see all available options:
```bash
make help
```
To install all the development dependencies:
```bash
make deps
```
## Running all tests
Before committing the code, please check if it passes all tests using
```bash
make qa
```
All artifacts are generated in the target directory.
## Example
Examples are located in the `example` directory.
Start a development server (requires PHP 8.0+) using the command:
```
make server
```
and point your browser to
## Installation
Create a composer.json in your projects root-directory:
```json
{
"require": {
"tecnickcom/tc-lib-pdf-encrypt": "^2.0"
}
}
```
Or add to an existing project with:
```bash
composer require tecnickcom/tc-lib-pdf-encrypt ^2.0
```
## Packaging
This library is mainly intended to be used and included in other PHP projects using Composer.
However, since some production environments dictates the installation of any application as RPM or DEB packages,
this library includes make targets for building these packages (`make rpm` and `make deb`).
The packages are generated under the `target` directory.
When this library is installed using an RPM or DEB package, you can use it your code by including the autoloader:
```
require_once ('/usr/share/php/Com/Tecnick/Pdf/Encrypt/autoload.php');
```
## Developer(s) Contact
* Nicola Asuni