History

Miklos Vajna c8f7408db7 tdf#158302 fix build against system-libxml-2.12 Seen in a fedora:40 container, using --with-system-libcmis, --with-system-liblangtag and --with-system-xmlsec. Change-Id: I9d748d3dc0b70dbfdfcb6b99c9ce8440bda6f326 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/159980 Tested-by: Jenkins Reviewed-by: Miklos Vajna <vmiklos@collabora.com>		2023-11-27 16:09:13 +01:00
..
doc
inc	tdf#158302 fix build against system-libxml-2.12	2023-11-27 16:09:13 +01:00
qa	Extended loplugin:ostr: xmlsecurity	2023-11-19 20:38:12 +01:00
source	c++20: use std::erase(_if) instead of std::remove(_if)+erase (xmlsecurity)	2023-11-20 07:41:08 +01:00
test_docs
uiconfig/ui	tdf#157588 fix extended_tip	2023-11-04 04:59:13 +01:00
util
workben
AllLangMoTarget_xsc.mk
CppunitTest_qa_certext.mk
CppunitTest_xmlsecurity_dialogs_test.mk
CppunitTest_xmlsecurity_pdfsigning.mk
CppunitTest_xmlsecurity_signing.mk
CppunitTest_xmlsecurity_signing2.mk
Executable_pdfverify.mk
IwyuFilter_xmlsecurity.yaml
Library_xmlsecurity.mk
Library_xsec_xmlsec.mk
Makefile
Module_xmlsecurity.mk
README.md	Fix typo	2023-08-27 18:46:24 +02:00
UIConfig_xmlsec.mk

README.md

Document Signing

Introduction

This code provides dialogs, and infrastructure wrapping libxmlsec and gpgme that implements document signing.

For signing a document, a personal key pair is used, which consists of a private key and a public key, which is added to the document in addition to the digital signature of the document, when signing it.

The document signing can be done both for the source ODF/OOXML files and the exported PDF files. It is also possible to sign existing PDF files.

Module Contents

doc: OpenDocument workflow legacy information with some illustrations to have an idea of the workflow, for starters check doc/OpenDocumentSignatures-Workflow.odt.
inc: Headers to a subset of source files inside the module, parts like source/framework have headers inside the folder.
qa: Unit tests for signing and shell scripts for certificates creation for testing.
test_docs: Documents & certificates used for testing.
source: More on that below.
uiconfig: User interface configuration for different dialogs, it is recommended to navigate from relevant source file to the .ui file linked in the class which will be under uiconfig/ui.
util: UNO passive registration config for GPG/ NSS.

Source Primary Contents

component: Main implementation of DocumentDigitalSignatures where the interaction with security environment and certificates occur.
dialogs: Certificate & Signatures management dialogs.
- certificatechooser: Dialog that allows you to find and choose certificates or signatures for encryption.
- certificateviewer: More detailed information about each certificate.
- digitalsignaturesdialog: Main window for signatures of the documents and the start point of signing document.
framework: Various elements for verifying signatures and running security engine.
gpg: The implementation of encrypting with GPG and security environment initialization.
helper: Some helper classes that include signatures manager and the helpers for PDF signing, UriBinding, and XML signatures. It also include helper tools for XSecurityEnvironment.
xmlsec: XML, NSS, MSCrypt encryption/ signing tools, more on the low-level side of actual implementation of algorithms.

PDF Testing

To test the signed PDFs, one can use the pdfverify in this way:

./bin/run pdfverify $PWD/xmlsecurity/qa/unit/pdfsigning/data/2good.pdf

The file parameter should be an absolute path.

This is the output of pdfverify for 2good.pdf:

verifying signatures
found 2 signatures
signature #0: digest match? 1
signature #0: partial? 0
signature #1: digest match? 1
signature #1: partial? 0