Download the PHP package setasign/setapdf-signer-addon-csc without Composer

On this page you can find all versions of the php package setasign/setapdf-signer-addon-csc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package setapdf-signer-addon-csc

SetaPDF-Signer-Addon-CSC

This package offers a module for the SetaPDF-Signer component that allows you to use the Cloud Signature Consortium API for Remote Electronic Signatures and Remote Electronic Seals to digital sign PDF documents in pure PHP.

The API documentation can be found on the Cloud Signature Consortium website: https://cloudsignatureconsortium.org/resources/download-api-specifications/

At the time of writing the module is tested with the eSigner CSC API from SSL.com and the Remote Signing Service CSC API from Entrust. It currently does not support all features or variances that may appear in other API implementations.

For usage with SSL.com you can follow this integration guide to get a better understanding of how to setup a test environment and how the signature workflow works: https://www.ssl.com/guide/integration-guide-testing-remote-signing-with-esigner-csc-api/ (instead of using postman you can use this module directly and sign your PDF documents locally).

Known not implemented features

At the moment the module does not support RSA_PSS or ECDSA as signing algorithm because of missing testing options. Both are implemented but will throw an exception to get a chance for a test case. Please contact us at [email protected] so that we can work on a final implementation together.

Authentification is only supported over OAuth2. Authentification over HTTP Basic or Digest authentification is not implemented yet. An implementation of the auth/login (11.2) endpoint shouldn't require much efford. If you need this, feel free to contact us at [email protected] so that we can work on this together.

Online One-Time Password (OTP) generation mechanism is not implemented yet. You'll have to trigger the OTP generation by yourself - see API credentials/sendOTP (11.8).

Requirements

To use this package you need access to a CSC API.

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 resolve the dependency to the SetaPDF-Signer component (see here for more details).

Usage

All classes in this package are located in the namespace setasign\SetaPDF\Signer\Module\CSC.

The Client class

This class is a kind of proxy class to the CSC API. Its constructor requires the following arguments:

If you need to call an endpoint which is not covered by a proxy method, you can use the call(string $path, ?string $accessToken = null, array $inputData = []) method.

How do I get an access token?

An access token is returned by an authorization to the API service.

This was tested only by an OAuth2 authorization yet. You can to use an OAuth2 implementation such as league/oauth2-client. Sample code for this can be found in "examples/generate-token.php".

Authorization modes

Accessing a credential for remote signing requires an authorization from the user who owns it to control the signing key associated to it.

The CSC API supports multiple authorization modes. The authorization mode also defines whether the signing process must be asynchronous or not. To get this information you can call Client::credentialsInfo() and in the key "authMode" you'll find one of the following authorization modes:

For both "implicit" and "explicit" you can use the synchronous process (see examples/ltv-demo.php).

For "oauth2code" you must use the asynchronous process (see examples/demo-async.php). This will require an oauth2 implementation such as league/oauth2-client.

More about the authorization modes can be found in "8.2 Credential authorization" of the CSC API.

License

This package is open-sourced software licensed under the MIT license.


All versions of setapdf-signer-addon-csc with dependencies

PHP Build Version
Package Version
Requires php Version >=7.1
ext-json Version *
psr/http-client Version ^1.0
psr/http-factory Version ^1.0
setasign/setapdf-signer Version ^2.40
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package setasign/setapdf-signer-addon-csc contains the following files

Loading the files please wait ....