| Table of Contents | ||||
|---|---|---|---|---|
|
Description
PDFSign Builder is a tool to add digital signatures to PDF files. Its REST interface allows a three-phase signature:
- Upload the document to sign and obtain a hash to be signed. After uploading the file, a hash can be obtained which must be signed by any third process
- Generate a PKCS#7 structure using the private key corresponding to the certificate informed in phase 1.
- Compose the signed document attaching the structure informed in phase 2.
Its services can be configured to respond over an HTTP or HTTPS protocol, and it is available as Docker distribution.
Service
PDFSign builder responds to the requests in a unique URL defined in its configuration file. Different configurations can be accessed using the X-Tenant header variable.
At least a general configuration must be defined so that the service can be started.
How to integrate
The following documentation can be useful if you decide to integrate it into your own project:
- PDFSign Builder Integration describes how to integrate PDFSign-Builder in your platform with two different models.
- The latest available interface documentation can be reached following this link: PDFSign Builder V2 REST interface.
- Any future version can be found in this link: Next PDFSign Builder REST Interface.
- A former (v1) REST interface can be found in this document: PDFSign Builder V1 Interface.
Example
You can test it by accessing the ACME tenant example. WebSinger was developed using this product.
Download ACME image
Step 1- Download Docker image
In order to download the images, the user must be registered in the aforesaid platform. Contact CertiSur to request access, and inform the Docker Hub profile to grant access to the docker image.
Login using a Docker Hub account:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
# docker login -u <docker hub account> Password: WARNING! Your password will be stored unencrypted in /root/.docker/config.json. Configure a credential helper to remove this warning. See https://docs.docker.com/engine/reference/commandline/login/#credentials-store Login Succeeded |
| Info | ||
|---|---|---|
| ||
You have to inform your docker hub account in order to authorize to download the package. Send an email to support@certisur.com. |
| Note | ||
|---|---|---|
| ||
It is possible to save the user’s credentials so as to login safely following the steps on this link (https://docs.docker.com/engine/reference/commandline/login/#credentials-store). |
Step 2- Pulling an image from Docker
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
# docker pull certisursa/pdf-signer-backend:latest latest: Pulling from certisursa/pdf-signer-backend a02a4930cb5d: Pull complete b5ffff9dbcda: Pull complete ... 7e5f58de12ac: Pull complete Digest: sha256:332ee89371399b7c6235465beb00fbd2071868fecee33fc14d04b87ba99b265d Status: Downloaded newer image for certisursa/pdf-signer-backend:latest docker.io/certisursa/pdf-signer-backend:latest |
Step 3- Run pdf-signer-backend docker image
To run pdf-signer-backend container you have to execute the following command line:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
# docker run -d \ -it \ -p <external_port>:8080 \ -v <pdf-signer-backend_config_folder>:/opt/pdf-signer-backend/config/ \ -v <pdf-signer-backend_log_folder>:/opt/pdf-signer-backend/logs/ \ -v <pdf-signer-backend_repository_folder>:/opt/pdf-signer-backend/file-cache/ \ pdf-signer-backend |
It is necessary to overwrite the directory where the configuration of the tenants is located. The volume configuration explained below.
Volumes
The following volumes must be mounted on the Docker image to overwrite the variables of each defined tenant.
| Source (host) example | Path (container) | Description |
|---|---|---|
| /home/opera/docker/pdf-signer-backend/config | /opt/pdf-signer-backend/config | configuration files |
| /home/opera/docker/pdf-signer-backend/log | /opt/pdf-signer-backend/logs | log files |
| /home/opera/docker/pdf-signer-backend/file-cache | /opt/pdf-signer-backend/file-cache | cache files |
Step 4- Test pdf-signer-backend
Execute the following command to run default pdf-signer-backend docker container
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
# docker run -d \ -it \ --name pdf-signer-backend \ -p 8080:8080 \ certisursa/pdf-signer-backend:latest |
Open your browser pointing to http://localhost:8080/signer/healthcheck (or the port defined by you) to access the URL where you published your PDFSign Builder installation. You'll see the following image.
| If you can see this image means that your service is running into your docker container. |
|
| Info | ||
|---|---|---|
| ||
Debbie docker image includes an ACME tenant inside. You must overwrite that definition to include your own company or project tenants. |