PHPackages setasign/setapdf-signer-addon-safe - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [PDF & Document Generation](/categories/documents) 4. / 5. setasign/setapdf-signer-addon-safe ActiveLibrary[PDF & Document Generation](/categories/documents) setasign/setapdf-signer-addon-safe ================================== A SetaPDF-Signer component signature module for the "Serviço de Assinatura de Faturas Eletrónicas" (SAFE) of the Portuguese State. v1.0.0(3y ago)11MITPHPPHP >=8.0 Since Nov 16Pushed 5mo ago2 watchersCompare [ Source](https://github.com/Setasign/SetaPDF-Signer-Addon-SAFE)[ Packagist](https://packagist.org/packages/setasign/setapdf-signer-addon-safe)[ Docs](https://github.com/Setasign/SetaPDF-Signer-Addon-SAFE)[ RSS](/packages/setasign-setapdf-signer-addon-safe/feed)WikiDiscussions main Synced yesterday READMEChangelog (1)Dependencies (6)Versions (2)Used By (0) SetaPDF-Signer-Addon-SAFE ========================= [](#setapdf-signer-addon-safe) This package offers a module for the SetaPDF-Signer component that allows you to use the ["Serviço de Assinatura de Faturas Eletrónicas" (SAFE)](https://www.autenticacao.gov.pt/servi%C3%A7o-de-assinatura-de-faturas-eletr%C3%B3nicas-safe-)of the Portuguese State to digital sign PDFs in pure PHP. Comments and notes on the implementation ---------------------------------------- [](#comments-and-notes-on-the-implementation) - While the documentation says that the API conforms to the CSC API we noted several differences which makes it impossible to use our existing [CSC API module](https://github.com/Setasign/SetaPDF-Signer-Addon-CSC). - As we do not understand or speak Portuguese while the official documentation is only available in Portuguese, we tried to implement the API based on an [automated translation](/docs/AMA%20-%20SAFE%20Documento%20de%20integra%C3%A7%C3%A3o-EN.pdf)and the OpenAPI Specification definitions found on the projects official [GitHub repository](https://github.com/amagovpt/doc-SAFE/tree/main/api). - We're also not able to authenticate as a Portuguese citizen and were dependent on users to provide test credentials/tokens. - The hashing algorithm is fixated to SHA256 as per documentation and the information from the /credentials/info endpoint are ignored. Requirements ------------ [](#requirements) You need to have credentials and a valid access token to the SAFE API endpoints. This package is developed and tested on PHP >= 8.0. Requirements of the [SetaPDF-Signer](https://www.setasign.com/signer)component can be found [here](https://manuals.setasign.com/setapdf-signer-manual/getting-started/#index-1). We're using [PSR-17 (HTTP Factories)](https://www.php-fig.org/psr/psr-17/) and [PSR-18 (HTTP Client)](https://www.php-fig.org/psr/psr-18/) for the requests. So you'll need an implementation of these. We recommend using Guzzle. ``` "require" : { "guzzlehttp/guzzle": "^7.0", "http-interop/http-factory-guzzle": "^1.0" } ``` Installation ------------ [](#installation) Add following to your composer.json: ``` { "require": { "setasign/setapdf-signer-addon-safe": "^1.0" }, "repositories": [ { "type": "composer", "url": "https://www.setasign.com/downloads/" } ] } ``` and execute `composer update`. You need to define the `repository` to resolve the dependency to the [SetaPDF-Signer](https://www.setasign.com/signer) component (see [here](https://getcomposer.org/doc/faqs/why-can%27t-composer-load-repositories-recursively.md) for more details). Usage ----- [](#usage) All classes in this package are located in the namespace `setasign\SetaPDF\Signer\Module\SAFE`. See the [examples/](examples/) folder for working examples. ### The `Client` class [](#the-client-class) This class is a kind of proxy class to the SAFE API. Its constructor requires the following arguments: - `$apiUri` The base url of the api e.g. `https://pprsafe.autenticacao.gov.pt` - `$basicAuthUsername` The username for HTTP Basic authentiaction - `$basicAuthPassword` The password for HTTP Basic authentiaction - `$httpClient` PSR-18 HTTP Client implementation. - `$requestFactory` PSR-17 HTTP Factory implementation. - `$streamFactory` PSR-17 HTTP Factory implementation. If you need to call an endpoint which is not covered by a proxy method, you can use the `call(string $path, ?string $accessToken = null, array $inputData = [])` method. ### The `Module` class [](#the-module-class) This is the main module for the SetaPDF-Signer which implements the [`SetaPDF_Signer_Signature_Module_ModuleInterface`](https://manuals.setasign.com/api-reference/setapdf/c/SetaPDF.Signer.Signature.Module.ModuleInterface) interface. Internally it creates PAdES conforming signatures by using the [`SetaPDF_Signer_Signature_Module_PadesProxyTrait`](https://manuals.setasign.com/api-reference/setapdf/c/SetaPDF.Signer.Signature.Module.PadesProxyTrait). Its constructor requires the following arguments: - `$accessToken` - The access token which is passed with the custom header SAFEAuthorization. - `$client` - An instance of the `Client` class. - `$credentialId` - The id of the credentials (can be received as demoed in [list-credentials.php](examples/list-credentials.php)) - `$processId` - A process id (a new Globally Unique Identifier (GUID) for each invocation). - `$clientName` - The value for the clientName field. Additionally, the module offers a `setDocumentName()` method. This method allows you to define the document name related to the hash send to the SAFE API. By default, the document name is set to "document.pdf". ### The `Batch` class [](#the-batch-class) This class allows you to digital sign several PDF files in a single signature flow. Its constructor requires the following arguments: - `$accessToken` - The access token which is passed with the custom header SAFEAuthorization. - `$client` - An instance of the `Client` class. - `$credentialId` - The id of the credentials (can be received as demoed in [list-credentials.php](examples/list-credentials.php)) - `$processId` - A process id (a new Globally Unique Identifier (GUID) for each invocation). - `$clientName` - The value for the clientName field. You can pass several files as an array to the `sign($files)` method: ``` $files = [ [ 'in' => string|SetaPDF_Core_Reader_ReaderInterface, 'out' => 'path/to/result.pdf' ] ]; ``` Additionally, the `sign()` method accepts callbacks to e.g. add individual signature appearances or signature properties. For an example see the [batch-complex.php](examples/batch-complex.php) demo. License ------- [](#license) This package is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT). ### Health Score 30 — LowBetter than 62% of packages Maintenance50 Moderate activity, may be stable Popularity3 Limited adoption so far Community8 Small or concentrated contributor base Maturity51 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Unknown Total 1 Last Release 1326d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/78b46f7020bdcd25e761812659988691e50aba9a25b2a48ea33f6137f2fc2536?d=identicon)[Setasign](/maintainers/Setasign) --- Top Contributors [![JanSlabon](https://avatars.githubusercontent.com/u/12390057?v=4)](https://github.com/JanSlabon "JanSlabon (30 commits)") --- Tags digital-signaturepadespdfphpsafesetapdf-signersignature ### Embed Badge ![Health badge](/badges/setasign-setapdf-signer-addon-safe/health.svg) ``` [![Health](https://phpackages.com/badges/setasign-setapdf-signer-addon-safe/health.svg)](https://phpackages.com/packages/setasign-setapdf-signer-addon-safe) ``` ### Alternatives [tempest/framework The PHP framework that gets out of your way. 2.2k34.4k15](/packages/tempest-framework)[cakephp/cakephp The CakePHP framework 8.9k19.5M1.8k](/packages/cakephp-cakephp)[flow-php/flow PHP ETL - Extract Transform Load - Data processing framework 85036.3k](/packages/flow-php-flow)[drupal/core-recommended Locked core dependencies; require this project INSTEAD OF drupal/core. 6942.5M421](/packages/drupal-core-recommended)[mollie/mollie-api-php Mollie API client library for PHP. Mollie is a European Payment Service provider and offers international payment methods such as Mastercard, VISA, American Express and PayPal, and local payment methods such as iDEAL, Bancontact, SOFORT Banking, SEPA direct debit, Belfius Direct Net, KBC Payment Button and various gift cards such as Podiumcadeaukaart and fashioncheque. 60216.0M85](/packages/mollie-mollie-api-php)[typo3/cms TYPO3 CMS is a free open source Content Management Framework initially created by Kasper Skaarhoj and licensed under GNU/GPL. 1.2k1.9M122](/packages/typo3-cms) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)