https://github.com/setasign/setapdf-signer-addon-google-cloud-kms
A SetaPDF-Signer component signature module for the Google Cloud Key Management Service.
https://github.com/setasign/setapdf-signer-addon-google-cloud-kms
google-cloud-kms pdf php setapdf setapdf-signer
Last synced: about 2 months ago
JSON representation
A SetaPDF-Signer component signature module for the Google Cloud Key Management Service.
- Host: GitHub
- URL: https://github.com/setasign/setapdf-signer-addon-google-cloud-kms
- Owner: Setasign
- License: mit
- Created: 2021-01-13T15:29:05.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-22T08:06:07.000Z (10 months ago)
- Last Synced: 2025-04-11T21:08:54.130Z (about 2 months ago)
- Topics: google-cloud-kms, pdf, php, setapdf, setapdf-signer
- Language: PHP
- Homepage:
- Size: 152 KB
- Stars: 3
- 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 Google Cloud KMS.
This package offers a module for the [SetaPDF-Signer](https://www.setasign.com/signer) component that allow you to use
the [Google Cloud Key Management Service](https://cloud.google.com/kms/docs) to **digital sign PDF documents in pure PHP**.
## Requirements
This package uses the official
[Google Cloud KMS Client Libraries](https://cloud.google.com/kms/docs/reference/libraries)
to communicate with the KMS. You need appropriate credentials.
You also need an X.509 certificates related to your stored keys. To create a self-signed certificate for testing purpose
or to create a CSR for the certificate authority of your choice, you can use a tool we prepared
[here](https://github.com/Setasign/Cloud-KMS-CSR).
The 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).
## Installation
Add following to your composer.json:
```json
{
"require": {
"setasign/setapdf-signer-addon-google-cloud-kms": "^1.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).
The Setasign repository requires authentication data: You can use your credentials
of your account at [setasign.com](https://www.setasign.com) to which your licenses
are assigned. You will be asked for this during a composer run. See
[here](https://getcomposer.org/doc/articles/authentication-for-private-packages.md#http-basic)
for more options for authentication with composer.
**Follow the [instructions to authentification](https://cloud.google.com/kms/docs/reference/libraries#setting_up_authentication) on Google Cloud KMS.**
## Usage
All classes in this package are located in the namespace `setasign\SetaPDF\Signer\Module\GoogleCloudKMS`.
### 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 5 arguments:
- `$projectId` - Your project id
- `$locationId` - Your location id
- `$keyRingId` - Your key Ring id
- `$keyId` - Your key id
- `$versionId` - Your version id
- `$kmsClient` - optional; can be used for e.g. authentification through code
A simple complete signature process would look like this:
```php
$googleCloudKmsModule = new setasign\SetaPDF\Signer\Module\GoogleCloudKMS\Module(
$projectId,
$locationId,
$keyRingId,
$keyId,
$versionId
);
$cert = file_get_contents('your-cert.crt');
$googleCloudKmsModule->setCertificate($cert);
$googleCloudKmsModule->setDigest($digest);
// 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);
$signer->sign($googleCloudKmsModule);
```
Make sure that you pass the same `$digest` value as configured for the key in the KMS.
## License
This package is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).