Quick-Sign Portal

Introduction

The Quick-Sign Portal is very easy to install and configure; it can be integrated in an existing environment. It is a web PHP application which interacts with a mail server to permit users to send and sign documents.
We recommend to install it on a dedicated machine and not on your WebADM/OpenOTP servers. This Quick-Sign portal is using the quicksign-milter, you must first configure the Quick-Sign Milter before deploying the Quick-Sign portal.
WebADM/OpenOTP infrastructure must be already deployed and integrated with your LDAP backend. Your OpenOTP license must also support Sign option.

Installation

As indicated in the introduction, the Quick-Sign Portal needs several components to run. They are mandatory.

• Web server with PHP activated
• IMAP and SMTP server associated to a Quick-Sign server
• LDAP server
  • for authentication
  • to retrieve information to fill the signers lists, the user's personal data, etc.
• Redis server
  • to store information about unsigned transactions such as rejected, cancelled, error (Portal Redis instance)
  • to retrieve information from Quick-Sign server (Quick-Sign server Redis instance)
• WebADM server for the junction to the OpenOTP process

{{< note title="Note" >}}
Note that it is possible to use only one Redis instance : the sessions from Quick-Sign server and from Portal are different to prevent data loss.
Also, the Portal can run completely as standalone application : one server with its own mail server (independent of Company's), own LDAP (e.g. clone of the Company's).
{{</ note >}}

RHEL/CentOS through RCDevs Repository

The installation of the Quick-Sign Milter as a service is done with the following command once RCDevs repository is installed:

yum install quicksign-milter

OR

dnf install quicksign-milter

Debian/Ubuntu through RCDevs Repository

The installation of the Quick-Sign Milter as a service is done with the following command once RCDevs repository is installed:

apt install quicksign-milter

Portal tree structure

The portal is an MVC application with the below structure. Only public folder has to be reachable by users; the system administrator should configure web server according to this recommendation.
The core of the application is stored in the app folder, the public area stays in the public folder.
The only file which has to be modified is the config.ini; it is located in app/config folder.

/qsPortal
├── app
│   ├── config
│   ├── controllers
│   ├── core
│   ├── locales
│   ├── media
│   ├── models
│   ├── utility
│   └── views
└── public
    ├── css
    ├── font
    ├── img
    └── js

The users documents are stored in another folder, different from the application. It permits an easier maintenance (backup, purge, etc.).
The following tree example shows each user (IT Manager, HR, Rosy) who have 4 sub folders.

• approved : contains all the document sent by the user and signed (so approved) by someone else.
• mydocuments : we found here all the user's documents which can be sent for signature or sealing
• sealed : all the documents the user sealed (signed for his own purpose)
• signed : all the documents the user signed

All other documents (cancelled signatures, rejected signature, errors) are stored in Redis and are temporary.
As you can see, each signed/sealed document is composed of

• its original name concatenated with a base64 string
• the same pattern for an index file which contains relevant information about the signature

All these stored files can be downloaded by the user.

documents/
├── IT Manager
│   ├── approved
│   │   ├── IT charter by Rebecca.pdf_<base64String>
│   │   ├── IT charter by Rebecca.pdf_<base64String>.idx
│   │   ├── Computer workstation security agreement.pdf_<base64String>
│   │   └── Computer workstation security agreement.pdf_<base64String>.idx
│   ├── mydocuments
│   │   ├── Computer workstation security agreement.pdf
│   │   ├── IT charter.pdf
│   │   ├── IT infrastructure project.pdf
│   │   ├── IT infrastructure project (validated).pdf
│   │   └── Network architecture.pdf
│   ├── sealed
│   │   ├── Computer workstation security agreement.pdf_<base64String>
│   │   ├── Computer workstation security agreement.pdf_<base64String>.idx
│   │   ├── IT infrastructure project (validated).pdf_<base64String>
│   │   └── IT infrastructure project (validated).pdf_<base64String>.idx
│   └── signed
│       ├── Alpha server purchase Q1-2023.pdf_<base64String>
│       ├── Alpha server purchase Q1-2023.pdf_<base64String>.idx
│       ├── CEO-IT service reorganization Q3-2022.pdf_<base64String>
│       ├── CEO-IT service reorganization Q3-2022.pdf_<base64String>.idx
│       ├── Subcontractor, confidentiality agreement Q4-2022.pdf_<base64String>
│       └── Subcontractor, confidentiality agreement Q4-2022.pdf_<base64String>.idx
├── HR
│   ├── approved
│   │   ├── Appointment 2022-11-11 by Pike.pdf_<base64String>
│   │   ├── Appointment 2022-11-11 by Pike.pdf_<base64String>.idx
│   │   ├── Long term contract by Rosy.pdf_<base64String>
│   │   └── Long term contract by Rosy.pdf_<base64String>.idx
│   ├── mydocuments
│   │   ├── Appointment 2022-11-11.pdf
│   │   ├── Long term contract.txt
│   │   ├── Long term contract template.pdf
│   │   └── Reorg project.pdf
│   ├── sealed
│   │   ├── Long term contract template.pdf_<base64String>
│   │   └── Long term contract template.pdf_<base64String>.idx
│   └── signed
├── Rosy
│   ├── ...
│   ├── ...

Configuration

Please find below, the standard Portal configuration file for domain "server.com".

Standard configuration file config.ini

[Portal]
applicationFullname     = "QuickSign Portal"
applicationFlag         = "QuickSignPortal"
portalId                = "a9a9a9a9-a9a9-a9a9-a9a9-a9a9a9a9a9a9"
; Do NOT forget the ending SLASH
url_base                = "/quicksign/"
refreshArray            = false
refreshDelay            = 5
[Logging]
logFileName             = "/var/log/quicksign/quicksign-portal.log"
level = WARNING
; DEBUG
; INFO
; WARNING
; ERROR
; CRITICAL
[Documents]
; Do NOT forget the ending DS
documentsFolder         = "/var/www/quicksign/documents/"
; System credentials for documents
documentsCredentials    = "0750"
[Postfix]
name                    = "server.com"
realDomain              = "server.com"
port                    = 143
type                    = ""
security                = ""
folder                  = "INBOX"
SMTPDebug               = false
signDomain              = "sign.server.com"
sealEmail               = "seal@sign.server.com"
manager                 = "Postman"
password                = "mngPassword"
[Redis]
; Milter Redis
redisMilterHost         = "server.com"
redisMilterPort         = 6379
; Portal Redis (used for temporary status like "Error", "Rejected", etc.)
redisedFoldersHost      = "server.com"
redisedFoldersPort      = 6379
; Keep the intel inside the Portal Redis (in hours) ; this is just for Rejected, Cancelled & Error requests
keepAlive               = 120
[LDAP]
host                    = "webadm.server.com"
port                    = 389
; encryption can be none/ssl/tls
encryption              = none
timeout                 = 10
username                = "cn=admin,o=Root"
password                = "admPassword"
baseDn                  = "o=Root"
filter                  = "(objectclass=person)"
filterUser              = "(uid=%s)"
filterMail              = "(mail=%s)"
columnFirstname         = "givenname"
columnLastname          = "sn"
columnLogin             = "uid"
columnMail              = "mail"
[Media]
iconType                = "png"
iconExtension           = ".webp"
extensionSeparator      = "_"
missing                 = "_missing"

Parameters explanations