setasign / setapdf-signer-addon-azure-keyvault
A SetaPDF-Signer component signature module for the Azure KeyVault.
Installs: 5 178
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 3
Forks: 0
Open Issues: 0
Requires
- php: >=7.1
- ext-json: *
- psr/http-client: ^1.0
- psr/http-factory: ^1.0
- setasign/setapdf-signer: ^2.40
Requires (Dev)
- guzzlehttp/guzzle: ^6.5
- http-interop/http-factory-guzzle: ^1.0
- mjelamanov/psr18-guzzle: ^1.3
- phpseclib/phpseclib: ^2.0
README
This package offers a module for the SetaPDF-Signer component that allow you to use the Azure Key Vault by Microsoft 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 component can be found here.
We're using PSR-17 (HTTP Factories) and PSR-18 (HTTP Client) 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:
{ "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 component
(see here 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
- PSR-7 interfaces
- PSR-17 interfaces
- PSR-18 interfaces
- PSR-7 implementation like Guzzle PSR-7
- PSR-17 implementation like HTTP Factory for Guzzle
- PSR-18 implementation like Guzzle (version 6 requires an additional wrapper)
Make sure, that the SetaPDF-Signer component is installed and its autoloader is registered correctly.
Then simply require the src/autoload.php
file or register this package in your own PSR-4 compatible autoload implementation:
$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 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:
$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.