This module extends the functionality of report module to sign PDFs using a PKCS#12 certificate.
Table of contents
Installation
To install this module, you need to install Java JDK Headlees, e.g.:
apt-get install openjdk-8-jre-headless
Configuration
In order to start signing PDF documents you need to configure certificate(s) to use in your company.
- Go to
Settings > Companies > Companies > Your company
- Go to
Report configuration
tab - Click
Edit
- Add a new item in
PDF report certificates
list - Click
Create
- Set name, certificate file, password file and model
- Optionally you can set a domain and filename pattern for saving as attachment
For example, if you want to sign only customer invoices in open or paid state:
- Model:
account.invoice
- Domain:
[('type','=','out_invoice'), ('state', 'in', ('open', 'paid'))]
- Save as attachment:
(object.number or '').replace('/','_') + '.signed.pdf'
Note: Linux user that executes Odoo server process must have read access to certificate file and password file
Java Memory Settings
If you are signing large amounts of reports at the same time, or if you have a
lower worker memory size than the JVM defaults, you may need to tune the JVM
heap memory limits. Do so by adding a $JVM_ARGS
environment variable that
contains the required flags. Check out these links too:
Usage
User just prints PDF documents (only Qweb PDF reports supported) as usual, but signed PDF is automatically downloaded if this document model is configured as indicated above.
If “Save as attachment” is configured, signed PDF is saved as attachment and next time saved one is downloaded without signing again. This is appropiate when signing date is important, for example, when signing customer invoices.
You can try the signing with the demo report that is included for customers called «Test PDF certificate».
Known issues / Roadmap
- When signing multiple documents (if “Allow only one document” is disable) then “Save as attachment” is not applied and signed result is not saved as attachment.
- To have a visible signature through an image embedded in the resulting PDF.
- Add tests.
Bug Tracker
Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.
Do not contact contributors directly about support or help with technical issues.
Credits
Contributors
- Rafael Blasco
- Antonio Espinosa
- Pedro M. Baeza
- Jairo Llopis
- David Vidal
Other credits
External utilities
- iText v1.4.8: © 2000-2006, Paulo Soares, Bruno Lowagie and others - License MPL or LGPL2 - http://sourceforge.net/projects/itext
- jPdfSign: © 2006 Jan Peter Stotz - License MPL or LGPL2 (inherited from iText) - http://private.sit.fraunhofer.de/~stotz/software/jpdfsign
- Modified jPdfSign: © 2015 Antonio Espinosa - License MPL or LGPL2 (inherited from iText) - static/src/java/JPdfSign.java
Icon
Maintainers
This module is maintained by the OCA.
OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.
This module is part of the OCA/reporting-engine project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.