setasign/setapdf-signer-addon-google-cloud-kms

A SetaPDF-Signer component signature module for the Google Cloud Key Management Service.

v1.0.0 2021-02-02 07:56 UTC

This package is auto-updated.

Last update: 2021-04-08 10:44:08 UTC


README

This package offers a module for the SetaPDF-Signer component that allow you to use the Google Cloud Key Management Service to digital sign PDF documents in pure PHP.

Requirements

This package uses the official Google Cloud KMS Client Libraries to communicate with the KMS. You need appropriate credentials.

You also need a 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.

The package is developed and tested on PHP >= 5.6. Requirements of the SetaPDF-Signer component can be found here.

Installation

Add following to your composer.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 component (see here for more details).

The Setasign repository requires authentication data: You can use your credentials of your account at setasign.com to which your licenses are assigned. You will be asked for this during a composer run. See here for more options for authentication with composer.

Follow the instructions to authentification on Google Cloud KMS.

Evaluation version

By default this packages depends on a licensed version of the SetaPDF-Signer component. If you want to use it with an evaluation version please use following in your composer.json:

{
    "require": {
        "setasign/setapdf-signer-addon-google-cloud-kms": "dev-evaluation"
    },
    "repositories": [
        {
            "type": "composer",
            "url": "https://www.setasign.com/downloads/"
        }
    ]
}

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 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:

$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.