Bundle org.nuxeo.ecm.platform.signature.core
Documentation
-
Parent Documentation: README.md
Nuxeo Platform Signature
This is a digital signature plugin for signing PDF files. It provides multiple functionalities related to digital signing of documents, among others:
- to create user certificates and store them within the Nuxeo CAP Instance.
- to sign pdf documents
- to share/download the local root certificate used for signing all documents within the domain
Building and deploying
To see the list of all commands available for building and deploying, use the following:
$ ant usage
How to build
You can build Nuxeo Digital Signature plugin with:
$ ant build
If you want to build and launch the tests, do it with:
$ ant build-with-tests
How to deploy
Configure the build.properties files (starting from the
build.properties.sample
file to be found in the current folder), to point your Tomcat instance:$ cp build.properties.sample build.properties $ vi build.properties
You can then deploy Nuxeo Digital Signature to your Tomcat instance with:
$ ant deploy-tomcat
You can also take all generated jar files (currently 3, present in the target directories of all submodules of this project), copy them into
$NUXEO_HOME/templates/custom/bundles/
and activate the "custom" template.Project Structure
This project can be divided conceptually into 3 parts:
-
certificate generation (low-level PKI object operations, CA operations)
-
certificate persistence (storing and retrieving keystores containing certificates inside nuxeo directories)
-
pdf signing with an existing certificate
Configuration:
- Install your root keystore file in a secured directory
To do initial testing you can use the keystore specified in: ./nuxeo-platform-signature-core/src/main/resources/OSGI-INF/root-contrib.xml
- You might have to modify your server system's java encryption configuration by installing JCE Unlimited Strength Jurisdiction Policy Files needed for passwords longer than 7 characters,
Note: cryptography exportation laws differ between countries so make sure you are using adequate encryption configuration, libraries and tools.
About Nuxeo
Nuxeo dramatically improves how content-based applications are built, managed and deployed, making customers more agile, innovative and successful. Nuxeo provides a next generation, enterprise ready platform for building traditional and cutting-edge content oriented applications. Combining a powerful application development environment with SaaS-based tools and a modular architecture, the Nuxeo Platform and Products provide clear business value to some of the most recognizable brands including Verizon, Electronic Arts, Sharp, FICO, the U.S. Navy, and Boeing. Nuxeo is headquartered in New York and Paris. More information is available at www.nuxeo.com.
Requirements
Resolution Order
You can influence this order by adding "require" tags in the component declaration, to make sure it is resolved after another component. It will also impact the order in which contributions are registered on their target extension point (see "Registration Order" on contributions).
Components
- digital.signature.schema
- digital.signature.directory
- org.nuxeo.ecm.platform.signature.api.pki.RootService
- org.nuxeo.ecm.platform.signature.api.pki.CertService
- org.nuxeo.ecm.platform.signature.api.sign.SignatureService
- org.nuxeo.ecm.platform.signature.api.user.CUserService
- org.nuxeo.ecm.platform.signature.core.operations.contrib
Packages
Maven Artifact
File | nuxeo-platform-signature-core-2023.12.6.jar |
---|---|
Group Id | org.nuxeo.ecm.platform |
Artifact Id | nuxeo-platform-signature-core |
Version | 2023.12.6 |
Manifest
Manifest-Version: 1.0
Archiver-Version: Plexus Archiver
Created-By: Apache Maven 3.9.6
Built-By: root
Build-Jdk: 17.0.11
Bundle-ManifestVersion: 1
Bundle-Version: 1.0.0
Bundle-Name: Digital Signature Core
Bundle-SymbolicName: org.nuxeo.ecm.platform.signature.core;singleton:=tr
ue
Require-Bundle: org.nuxeo.ecm.core,org.nuxeo.ecm.core.api,org.nuxeo.ecm
.platform.signature.api
Nuxeo-Require: org.nuxeo.ecm.core,org.nuxeo.ecm.core.schema,org.nuxeo.ec
m.directory,org.nuxeo.ecm.directory.sql
Nuxeo-Component: OSGI-INF/schema-contrib.xml,OSGI-INF/directory-contrib.
xml,OSGI-INF/root-service-contrib.xml,OSGI-INF/cert-service-contrib.xml
,OSGI-INF/signature-service-contrib.xml,OSGI-INF/cuser-service-contrib.
xml,OSGI-INF/sign-operations-contrib.xml
Exports
- Json Export Default Json serialization
- Json Graph Json dependency graph
- Json Contribution Stats Json statistics for contributions
- CSV Contribution Stats CSV statistics for contributions
Charts
-
Raw Data: Json Contribution Stats