Download the PHP package setasign/seta-pdf-signer-addon-global-sign-dss without Composer
On this page you can find all versions of the php package setasign/seta-pdf-signer-addon-global-sign-dss. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download setasign/seta-pdf-signer-addon-global-sign-dss
More information about setasign/seta-pdf-signer-addon-global-sign-dss
Files in setasign/seta-pdf-signer-addon-global-sign-dss
Package seta-pdf-signer-addon-global-sign-dss
Short Description A SetaPDF-Signer component signature module for the GlobalSign Digital Signing Service.
License MIT
Rated 1.50 based on 2 reviews
Informations about the package seta-pdf-signer-addon-global-sign-dss
SetaPDF-Signer component modules for the GlobalSign Digital Signing Service.
This package offers modules for the SetaPDF-Signer component that allow you to use the Cloud-based Digital Signing Service by GlobalSign to digital sign and timestamp PDF documents in pure PHP.
Requirements
To use this package you need credentials for the GlobalSign Digital Signing Service which are:
- Your private key
- Client certificate for mTLS connection to the API
- Your API key and password
See "GlobalSign-Digital-Signing-Service-Guide 1.3.pdf" (or newer) for details. Ask a GlobalSign contact for this document.
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
For >= PHP 7.2
Installation
Add following to your composer.json:
and execute composer update
. You need to define the repository
to evaluate the dependency to the
SetaPDF-Signer component (see
here for more details).
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:
Usage
All classes in this package are located in the namespace setasign\SetaPDF\Signer\Module\GlobalSign\Dss
.
The Client
class
There's a simple Client
class which wraps the REST API
into simple PHP methods. It handles the authentication, requests and responses internally.
The constructor of this class requires the following arguments:
$httpClient
PSR-18 HTTP Client implementation.$requestFactory
PSR-17 HTTP Factory implementation.$streamFactory
PSR-17 HTTP Factory implementation.$apiKey
is your API key received from GlobalSign.$apiSecret
is the secret to your API key received from GlobalSign.
A common creation could look like:
You can use this instance to e.g. query general information:
To create a digital signature you need to create a signing certificate first which can be done with the getIdentity()
method. The argument to this method can be an associative array as defined
here.
The method will return an Identity
instance which is nothing more than a data wrapper of the returned id, signing
certificate and OCSP response.
This Identity
needs to be forward to the signature module which internally passes it back to the Dss\Client\sign()
method to get the final signature. It is also possible to use this method individually (just for completion):
The SignatureModule
class
This is the main signature module which can be used with the SetaPDF-Signer component. Its constructor requires these arguments:
$signer
is the instance of the\SetaPDF_Signer
class to which the module is passed afterwards. Internally$signer->setAllowSignatureContentLengthChange(false)
is called to prohibit redundant signature requests.$client
needs to be theDss\Client
instance.$identity
aDss\Identity
instance.$module
needs to be a CMS or PAdES signature module instance. It is used internally to create the CMS container.
A simple complete signature process would look like this:
The TimestampModule
class
This module can be used to add timestamps to the digital signature or to create document level timestamps. It's constructor simply requires a Dss\Client
instance:
It doesn't requires an identity as the signature module but can be passed as it is to the \SetaPDF_Signer
instance:
or you can create a document level timestamp with it:
Information about Tests
The test suite currently only comes with functional tests, which invoke real service calls! Keep in mind that these calls are deducted from your signature contingent. You should not execute these tests in an automated environment!!
To execute the tests, you need to create a folder in the root of this package with the following file:
The credentials.php
file needs to return your credentials, certificate and private key:
License
This package is open-sourced software licensed under the MIT license.
All versions of seta-pdf-signer-addon-global-sign-dss with dependencies
ext-json Version *
psr/http-client Version ^1.0
psr/http-factory Version ^1.0
setasign/setapdf-signer Version ^2.31