https://github.com/setasign/setapdf-signer-addon-azure-keyvault
A SetaPDF-Signer component signature module for the Azure KeyVault.
https://github.com/setasign/setapdf-signer-addon-azure-keyvault
azure-keyvault digital-signature pdf php setapdf setapdf-signer signature
Last synced: 7 days ago
JSON representation
A SetaPDF-Signer component signature module for the Azure KeyVault.
- Host: GitHub
- URL: https://github.com/setasign/setapdf-signer-addon-azure-keyvault
- Owner: Setasign
- License: mit
- Created: 2020-11-18T09:24:40.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-06T13:07:19.000Z (over 1 year ago)
- Last Synced: 2025-06-06T02:49:14.309Z (11 days ago)
- Topics: azure-keyvault, digital-signature, pdf, php, setapdf, setapdf-signer, signature
- Language: PHP
- Homepage:
- Size: 121 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SetaPDF-Signer component module for the Azure Key Vault.
This package offers a module for the [SetaPDF-Signer](https://www.setasign.com/signer) component that allow you to use
the [Azure Key Vault](https://azure.microsoft.com/services/key-vault/) by
[Microsoft](https://www.microsoft.com) to **digital sign PDF documents in pure PHP**.
## Requirements
To use this package you need credentials for the Azure Key Vault Service.
This package is developed and tested on PHP >= 7.1. 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.
### For PHP 7.1
```
"require" : {
"guzzlehttp/guzzle": "^6.5",
"http-interop/http-factory-guzzle": "^1.0",
"mjelamanov/psr18-guzzle": "^1.3"
}
```
### For >= PHP 7.2
```
"require" : {
"guzzlehttp/guzzle": "^7.0",
"http-interop/http-factory-guzzle": "^1.0"
}
```
## Installation
Add following to your composer.json:
```json
{
"require": {
"setasign/setapdf-signer-addon-azure-keyvault": "^2.0"
},
"repositories": [
{
"type": "composer",
"url": "https://www.setasign.com/downloads/"
}
]
}
```
and execute `composer update`. You need to define the `repository` to evaluate 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).
### Without Composer
It's recommend to use composer otherwise you have to resolve the depency tree manually. You will require:
- [SetaPDF-Signer component](https://www.setasign.com/signer)
- [PSR-7 interfaces](https://github.com/php-fig/http-message)
- [PSR-17 interfaces](https://github.com/php-fig/http-factory)
- [PSR-18 interfaces](https://github.com/php-fig/http-client)
- PSR-7 implementation like [Guzzle PSR-7](https://github.com/guzzle/psr7)
- PSR-17 implementation like [HTTP Factory for Guzzle](https://github.com/http-interop/http-factory-guzzle)
- PSR-18 implementation like [Guzzle](https://github.com/guzzle/guzzle) (version 6 requires an [additional wrapper](https://github.com/mjelamanov/psr18-guzzle))
Make sure, that the [SetaPDF-Signer component](https://www.setasign.com/signer)
is [installed](https://manuals.setasign.com/setapdf-core-manual/installation/#index-2) and
its [autoloader is registered](https://manuals.setasign.com/setapdf-core-manual/getting-started/#index-1) correctly.
Then simply require the `src/autoload.php` file or register this package in your own PSR-4 compatible autoload implementation:
```php
$loader = new \Example\Psr4AutoloaderClass;
$loader->register();
$loader->addNamespace('setasign\SetaPDF\Signer\Module\AzureKeyVault', 'path/to/src/');
```
## Usage
All classes in this package are located in the namespace `setasign\SetaPDF\Signer\Module\AzureKeyVault`.
### The `Module` class
This is the main signature module which can be used with the [SetaPDF-Signer](https://www.setasign.com/signer)
component. Its constructor requires 6 arguments:
- `$vaultBaseUrl` The base url of your key vault.
- `$certificateName` The name of your key.
- `$certificateVersion` The version of your key.
- `$httpClient` PSR-18 HTTP Client implementation.
- `$requestFactory` PSR-17 HTTP Factory implementation.
- `$streamFactory` PSR-17 HTTP Factory implementation.
A simple complete signature process would look like this:
```php
$httpClient = new GuzzleHttp\Client([
'http_errors' => false,
//'verify' => './cacert.pem'
]);
// if you are using php 7.1
//$httpClient = new Mjelamanov\GuzzlePsr18\Client($httpClient);
$azureModule = new setasign\SetaPDF\Signer\Module\AzureKeyVault\Module(
$vaultBaseUrl,
$certificateName,
$certificateVersion,
$httpClient,
new Http\Factory\Guzzle\RequestFactory(),
new Http\Factory\Guzzle\StreamFactory()
);
$token = $azureModule->createTokenBySharedSecret($tenantId, $appClientId, $appClientSecret);
$azureModule->setAccessToken($token['accessToken']);
// the file to sign
$fileToSign = __DIR__ . '/Laboratory-Report.pdf';
// create a writer instance
$writer = new SetaPDF_Core_Writer_File('signed.pdf');
// create the document instance
$document = SetaPDF_Core_Document::loadByFilename($fileToSign, $writer);
// create the signer instance
$signer = new SetaPDF_Signer($document);
$azureModule->setSignatureAlgorithm($alg);
$signer->sign($azureModule);
```
## License
This package is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).