Compare commits

30 Commits

Author SHA1 Message Date
a5176b5bbb Bump version, update NEWS 2020-09-06 05:16:40 +02:00
af6a937033 Go: avoid non-deterministic output
The code has even turned out simpler.
2020-09-06 05:16:40 +02:00
8913f8ba9c Add a test script to verify basic function 2020-09-06 05:16:39 +02:00
524eea9b2f Manual: fix the example
Things managed to work once but for rather arbitrary reasons.
2020-09-05 21:32:05 +02:00
3ce08d33f6 Bump version, update NEWS 2020-09-05 20:10:48 +02:00
a75f990565 Add an instructive man page 2020-09-05 20:10:47 +02:00
46fa50749f Add a --version option
And fix that --reservation was missing from the optstring.
2020-09-05 20:08:41 +02:00
796a9640d3 Make it possible to change the signature reservation 2020-09-04 18:33:12 +02:00
2d08100b58 Avoid downgrading the document's PDF version 2020-09-04 18:30:09 +02:00
1224d9be47 Return errors rather than mangle documents 2020-09-04 16:05:14 +02:00
486cafa6b4 Go: update dependencies 2020-08-12 06:15:41 +02:00
a0696cdb88 Name change 2020-08-12 06:14:03 +02:00
be8480f8af Consistency 2018-12-14 02:52:05 +01:00
f9f3171c02 Use Go modules 2018-12-01 22:43:11 +01:00
0ea296de67 Go: less API stupidity coming from the C++ heritage 2018-10-04 14:46:12 +02:00
9d2412398a Go: additional small fixes 2018-10-04 14:14:04 +02:00
62206ed344 Go: documentation cleanup 2018-10-04 13:18:37 +02:00
9ac8360979 Go: use multiple return values
The compiler has made it more obvious where we eat error messages.
2018-10-04 13:09:29 +02:00
50578fe99f Go: add Object constructors 2018-10-04 12:51:23 +02:00
eedd9a550c Go: cleanups 2018-10-04 12:11:43 +02:00
43ca0e5035 Add a Go port
It should be roughly at feature parity.
2018-10-04 01:03:45 +02:00
ad239714b0 Add comments about some potential issues
- lack of number range verification
 - lack of sanitization when serializing dicts
2018-10-03 22:47:47 +02:00
daa9cc1ed4 Mark a variable const 2018-10-03 22:47:47 +02:00
4c7853c951 Try to return the innermost error message
Improving debugging experience.
2018-10-03 22:47:46 +02:00
c77a9c052a Fix parsing of hex strings 2018-10-03 22:17:05 +02:00
54d86cf25b Fix serialization of null values 2018-10-02 23:17:46 +02:00
160f09ecc3 Fix octal escapes 2018-10-02 23:17:15 +02:00
2d3fd3317b Add NEWS 2018-08-03 20:04:33 +02:00
803b048f8c Clarify libcrypto API version in README 2018-08-03 19:58:36 +02:00
73bf4b861a Fix double fclose() 2018-07-21 23:38:25 +02:00
11 changed files with 1638 additions and 52 deletions

View File

@@ -1,4 +1,4 @@
Copyright (c) 2017, Přemysl Janouch <p@janouch.name> Copyright (c) 2017 - 2020, Přemysl Eric Janouch <p@janouch.name>
Permission to use, copy, modify, and/or distribute this software for any Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted. purpose with or without fee is hereby granted.

29
NEWS Normal file
View File

@@ -0,0 +1,29 @@
1.1.1 (2020-09-06)
* Fix a dysfunctional example in the manual
* Go: write the xref table in a deterministic order
* Add a trivial test suite, based on pdfsig from poppler-utils
1.1 (2020-09-05)
* Make it possible to change the signature reservation with an option
* Return errors rather than mangle documents in some cases,
notably with pre-existing PDF forms
* Avoid downgrading the document's PDF version to 1.6
* A few fixes for PDF parsing and serialisation
* Add an instructive man page
* Add a native Go port of the utility, also usable as a library
1.0 (2018-08-03)
* Initial release

View File

@@ -1,28 +1,21 @@
pdf-simple-sign pdf-simple-sign
=============== ===============
:compact-option:
'pdf-simple-sign' is a simple open source PDF signer intended for documents 'pdf-simple-sign' is a simple PDF signer intended for documents produced by
generated by Cairo. As such, it currently comes with some restrictions: the Cairo library, GNU troff, ImageMagick, or similar.
* the document may not have any forms or signatures already, as they will be
overwitten
* the document may not employ cross-reference streams, or must constitute
a hybrid-reference file at least
* the document may not be newer than PDF 1.6 already, or it will get downgraded
to that version
* the signature may take at most 4 kilobytes as a compile-time limit,
which should be enough space even for one intermediate certificate
The signature is attached to the first page and has no appearance.
I don't aim to extend the functionality any further. The project is fairly I don't aim to extend the functionality any further. The project is fairly
self-contained and it should be easy to grasp and change to suit to your needs. self-contained and it should be easy to grasp and change to suit to your needs.
Documentation
-------------
See the link:pdf-simple-sign.adoc[man page] for information about usage.
The rest of this README will concern itself with externalities.
Building Building
-------- --------
Build dependencies: Meson, a C++11 compiler, pkg-config + Build dependencies: Meson, Asciidoctor, a C++11 compiler, pkg-config +
Runtime dependencies: libcrypto Runtime dependencies: libcrypto (OpenSSL 1.1 API)
$ git clone https://git.janouch.name/p/pdf-simple-sign.git $ git clone https://git.janouch.name/p/pdf-simple-sign.git
$ cd pdf-simple-sign $ cd pdf-simple-sign
@@ -30,10 +23,9 @@ Runtime dependencies: libcrypto
$ cd builddir $ cd builddir
$ ninja $ ninja
Usage In addition to the C++ version, also included is a native Go port:
-----
$ ./pdf-simple-sign document.pdf document.signed.pdf KeyAndCerts.p12 password $ go get janouch.name/pdf-simple-sign/cmd/pdf-simple-sign
Contributing and Support Contributing and Support
------------------------ ------------------------

View File

@@ -0,0 +1,76 @@
//
// Copyright (c) 2018 - 2020, Přemysl Eric Janouch <p@janouch.name>
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
// SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
// OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
// CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
//
// pdf-simple-sign is a simple PDF signer.
package main
import (
"flag"
"fmt"
"io/ioutil"
"os"
"janouch.name/pdf-simple-sign/pdf"
)
// #include <unistd.h>
import "C"
func isatty(fd uintptr) bool { return C.isatty(C.int(fd)) != 0 }
func die(status int, format string, args ...interface{}) {
msg := fmt.Sprintf(format+"\n", args...)
if isatty(os.Stderr.Fd()) {
msg = "\x1b[0;31m" + msg + "\x1b[m"
}
os.Stderr.WriteString(msg)
os.Exit(status)
}
func usage() {
die(1, "Usage: %s [-h] [-r RESERVATION] INPUT-FILENAME OUTPUT-FILENAME "+
"PKCS12-PATH PKCS12-PASS", os.Args[0])
}
var reservation = flag.Int(
"r", 4096, "signature reservation as a number of bytes")
func main() {
flag.Usage = usage
flag.Parse()
if flag.NArg() != 4 {
usage()
}
inputPath, outputPath := flag.Arg(0), flag.Arg(1)
doc, err := ioutil.ReadFile(inputPath)
if err != nil {
die(1, "%s", err)
}
p12, err := ioutil.ReadFile(flag.Arg(2))
if err != nil {
die(2, "%s", err)
}
key, certs, err := pdf.PKCS12Parse(p12, flag.Arg(3))
if err != nil {
die(3, "%s", err)
}
if doc, err = pdf.Sign(doc, key, certs, *reservation); err != nil {
die(4, "error: %s", err)
}
if err = ioutil.WriteFile(outputPath, doc, 0666); err != nil {
die(5, "%s", err)
}
}

8
go.mod Normal file
View File

@@ -0,0 +1,8 @@
module janouch.name/pdf-simple-sign
go 1.14
require (
go.mozilla.org/pkcs7 v0.0.0-20200128120323-432b2356ecb1
golang.org/x/crypto v0.0.0-20200728195943-123391ffb6de
)

13
go.sum Normal file
View File

@@ -0,0 +1,13 @@
go.mozilla.org/pkcs7 v0.0.0-20181029144607-24857c352dd8 h1:W3oGFPlHBLgXdsbPVixWFMYsuPhm81/Qww3XAgBbn/0=
go.mozilla.org/pkcs7 v0.0.0-20181029144607-24857c352dd8/go.mod h1:5fWP3IVYEMc04wC+lMJAfkmNmKAl2P1swVv8VS+URZ8=
go.mozilla.org/pkcs7 v0.0.0-20200128120323-432b2356ecb1 h1:A/5uWzF44DlIgdm/PQFwfMkW0JX+cIcQi/SwLAmZP5M=
go.mozilla.org/pkcs7 v0.0.0-20200128120323-432b2356ecb1/go.mod h1:SNgMg+EgDFwmvSmLRTNKC5fegJjB7v23qTQ0XLGUNHk=
golang.org/x/crypto v0.0.0-20181127143415-eb0de9b17e85 h1:et7+NAX3lLIk5qUCTA9QelBjGE/NkhzYw/mhnr0s7nI=
golang.org/x/crypto v0.0.0-20181127143415-eb0de9b17e85/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/crypto v0.0.0-20200728195943-123391ffb6de h1:ikNHVSjEfnvz6sxdSPCaPt572qowuyMDMJLLm3Db3ig=
golang.org/x/crypto v0.0.0-20200728195943-123391ffb6de/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=

View File

@@ -1,5 +1,23 @@
project('pdf-simple-sign', 'cpp', default_options : ['cpp_std=c++11']) project('pdf-simple-sign', 'cpp', default_options : ['cpp_std=c++11'],
version : '1.1.1')
conf = configuration_data()
conf.set('PROJECT_NAME', '"' + meson.project_name() + '"')
conf.set('PROJECT_VERSION', '"' + meson.project_version() + '"')
configure_file(output : 'config.h', configuration : conf)
cryptodep = dependency('libcrypto') cryptodep = dependency('libcrypto')
executable('pdf-simple-sign', 'pdf-simple-sign.cpp', executable('pdf-simple-sign', 'pdf-simple-sign.cpp',
install : true, install : true,
dependencies : cryptodep) dependencies : cryptodep)
asciidoctor = find_program('asciidoctor')
foreach page : ['pdf-simple-sign']
custom_target('manpage for ' + page,
input: page + '.adoc', output: page + '.1',
command: [asciidoctor, '-b', 'manpage',
'-a', 'release-version=' + meson.project_version(),
'@INPUT@', '-o', '@OUTPUT@'],
install: true,
install_dir: join_paths(get_option('mandir'), 'man1'))
endforeach

80
pdf-simple-sign.adoc Normal file
View File

@@ -0,0 +1,80 @@
pdf-simple-sign(1)
==================
:doctype: manpage
:manmanual: pdf-simple-sign Manual
:mansource: pdf-simple-sign {release-version}
Name
----
pdf-simple-sign - a simple PDF signer
Synopsis
--------
*pdf-simple-sign* [_OPTION_]... _INPUT.pdf_ _OUTPUT.pdf_ _KEY-PAIR.p12_ _PASSWORD_
Description
-----------
'pdf-simple-sign' is a simple PDF signer intended for documents produced by
the Cairo library, GNU troff, ImageMagick, or similar. As such, it currently
comes with some restrictions:
* the document may not have any forms or signatures already, as they would be
overwritten,
* the document may not employ cross-reference streams, or must constitute
a hybrid-reference file at least.
The key and certificate pair is accepted in the PKCS#12 format. The _PASSWORD_
must be supplied on the command line, and may be empty if it is not needed.
The signature is attached to the first page and has no appearance.
If signature data don't fit within the default reservation of 4 kibibytes,
you might need to adjust it using the *-r* option, or throw out any unnecessary
intermediate certificates.
Options
-------
*-r* _RESERVATION_, *--reservation*=_RESERVATION_::
Set aside _RESERVATION_ amount of bytes for the resulting signature.
Feel free to try a few values in a loop. The program itself has no
conceptions about the data, so it can't make accurate predictions.
*-h*, *--help*::
Display a help message and exit.
*-V*, *--version*::
Output version information and exit.
Examples
--------
Create a self-signed certificate, make a document containing the current date,
sign it and verify the attached signature:
$ openssl req -newkey rsa:2048 -subj /CN=Test -nodes \
-keyout key.pem -x509 -addext keyUsage=digitalSignature \
-out cert.pem 2>/dev/null
$ openssl pkcs12 -inkey key.pem -in cert.pem \
-export -passout pass: -out key-pair.p12
$ date | groff -T pdf > test.pdf
$ pdf-simple-sign test.pdf test.signed.pdf key-pair.p12 ""
$ pdfsig test.signed.pdf
Digital Signature Info of: test.signed.pdf
Signature #1:
- Signer Certificate Common Name: Test
- Signer full Distinguished Name: CN=Test
- Signing Time: Sep 05 2020 19:41:22
- Signing Hash Algorithm: SHA-256
- Signature Type: adbe.pkcs7.detached
- Signed Ranges: [0 - 6522], [14716 - 15243]
- Total document signed
- Signature Validation: Signature is Valid.
- Certificate Validation: Certificate issuer isn't Trusted.
Reporting bugs
--------------
Use https://git.janouch.name/p/pdf-simple-sign to report bugs, request features,
or submit pull requests.
See also
--------
*openssl*(1), *pdfsig*(1)

View File

@@ -2,7 +2,7 @@
// //
// pdf-simple-sign: simple PDF signer // pdf-simple-sign: simple PDF signer
// //
// Copyright (c) 2017, Přemysl Janouch <p@janouch.name> // Copyright (c) 2017 - 2020, Přemysl Eric Janouch <p@janouch.name>
// //
// Permission to use, copy, modify, and/or distribute this software for any // Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted. // purpose with or without fee is hereby granted.
@@ -37,9 +37,12 @@
#include <openssl/x509v3.h> #include <openssl/x509v3.h>
#include <openssl/pkcs12.h> #include <openssl/pkcs12.h>
#include "config.h"
// ------------------------------------------------------------------------------------------------- // -------------------------------------------------------------------------------------------------
using uint = unsigned int; using uint = unsigned int;
using ushort = unsigned short;
static std::string concatenate(const std::vector<std::string>& v, const std::string& delim) { static std::string concatenate(const std::vector<std::string>& v, const std::string& delim) {
std::string res; std::string res;
@@ -136,12 +139,11 @@ struct pdf_lexer {
if (eat_newline(ch)) if (eat_newline(ch))
continue; continue;
std::string octal; std::string octal;
if (*p && strchr(oct_alphabet, *p)) octal += *p++; if (ch && strchr(oct_alphabet, ch)) {
if (*p && strchr(oct_alphabet, *p)) octal += *p++; octal += ch;
if (*p && strchr(oct_alphabet, *p)) octal += *p++; if (*p && strchr(oct_alphabet, *p)) octal += *p++;
if (!octal.empty()) { if (*p && strchr(oct_alphabet, *p)) octal += *p++;
value += char(std::stoi(octal, nullptr, 8)); ch = std::stoi(octal, nullptr, 8);
continue;
} }
} }
} }
@@ -162,6 +164,7 @@ struct pdf_lexer {
buf.clear(); buf.clear();
} }
} }
p++;
if (!buf.empty()) value += char(std::stoi(buf + '0', nullptr, 16)); if (!buf.empty()) value += char(std::stoi(buf + '0', nullptr, 16));
return {pdf_object::STRING, value}; return {pdf_object::STRING, value};
} }
@@ -257,7 +260,7 @@ struct pdf_lexer {
static std::string pdf_serialize(const pdf_object& o) { static std::string pdf_serialize(const pdf_object& o) {
switch (o.type) { switch (o.type) {
case pdf_object::NL: return "\n"; case pdf_object::NL: return "\n";
case pdf_object::NIL: return "nil"; case pdf_object::NIL: return "null";
case pdf_object::BOOL: return o.number ? "true" : "false"; case pdf_object::BOOL: return o.number ? "true" : "false";
case pdf_object::NUMERIC: case pdf_object::NUMERIC:
{ {
@@ -301,6 +304,7 @@ static std::string pdf_serialize(const pdf_object& o) {
{ {
std::string s; std::string s;
for (const auto i : o.dict) for (const auto i : o.dict)
// FIXME the key is also supposed to be escaped by pdf_serialize()
s += " /" + i.first + " " + pdf_serialize(i.second); s += " /" + i.first + " " + pdf_serialize(i.second);
return "<<" + s + " >>"; return "<<" + s + " >>";
} }
@@ -341,6 +345,9 @@ public:
/// Build the cross-reference table and prepare a new trailer dictionary /// Build the cross-reference table and prepare a new trailer dictionary
std::string initialize(); std::string initialize();
/// Try to extract the claimed PDF version as a positive decimal number, e.g. 17 for PDF 1.7.
/// Returns zero on failure.
int version(const pdf_object& root) const;
/// Retrieve an object by its number and generation -- may return NIL or END with an error /// Retrieve an object by its number and generation -- may return NIL or END with an error
pdf_object get(uint n, uint generation) const; pdf_object get(uint n, uint generation) const;
/// Allocate a new object number /// Allocate a new object number
@@ -353,6 +360,12 @@ public:
// ------------------------------------------------------------------------------------------------- // -------------------------------------------------------------------------------------------------
/// If the object is an error, forward its message, otherwise return err.
static std::string pdf_error(const pdf_object& o, const char* err) {
if (o.type != pdf_object::END || o.string.empty()) return err;
return o.string;
}
pdf_object pdf_updater::parse_obj(pdf_lexer& lex, std::vector<pdf_object>& stack) const { pdf_object pdf_updater::parse_obj(pdf_lexer& lex, std::vector<pdf_object>& stack) const {
if (stack.size() < 2) if (stack.size() < 2)
return {pdf_object::END, "missing object ID pair"}; return {pdf_object::END, "missing object ID pair"};
@@ -370,7 +383,7 @@ pdf_object pdf_updater::parse_obj(pdf_lexer& lex, std::vector<pdf_object>& stack
while (1) { while (1) {
auto object = parse(lex, obj.array); auto object = parse(lex, obj.array);
if (object.type == pdf_object::END) if (object.type == pdf_object::END)
return {pdf_object::END, "object doesn't end"}; return {pdf_object::END, pdf_error(object, "object doesn't end")};
if (object.type == pdf_object::KEYWORD && object.string == "endobj") if (object.type == pdf_object::KEYWORD && object.string == "endobj")
break; break;
obj.array.push_back(std::move(object)); obj.array.push_back(std::move(object));
@@ -408,7 +421,7 @@ pdf_object pdf_updater::parse(pdf_lexer& lex, std::vector<pdf_object>& stack) co
while (1) { while (1) {
auto object = parse(lex, array); auto object = parse(lex, array);
if (object.type == pdf_object::END) if (object.type == pdf_object::END)
return {pdf_object::END, "array doesn't end"}; return {pdf_object::END, pdf_error(object, "array doesn't end")};
if (object.type == pdf_object::E_ARRAY) if (object.type == pdf_object::E_ARRAY)
break; break;
array.push_back(std::move(object)); array.push_back(std::move(object));
@@ -421,7 +434,7 @@ pdf_object pdf_updater::parse(pdf_lexer& lex, std::vector<pdf_object>& stack) co
while (1) { while (1) {
auto object = parse(lex, array); auto object = parse(lex, array);
if (object.type == pdf_object::END) if (object.type == pdf_object::END)
return {pdf_object::END, "dictionary doesn't end"}; return {pdf_object::END, pdf_error(object, "dictionary doesn't end")};
if (object.type == pdf_object::E_DICT) if (object.type == pdf_object::E_DICT)
break; break;
array.push_back(std::move(object)); array.push_back(std::move(object));
@@ -459,7 +472,7 @@ std::string pdf_updater::load_xref(pdf_lexer& lex, std::set<uint>& loaded_entrie
while (1) { while (1) {
auto object = parse(lex, throwaway_stack); auto object = parse(lex, throwaway_stack);
if (object.type == pdf_object::END) if (object.type == pdf_object::END)
return "unexpected EOF while looking for the trailer"; return pdf_error(object, "unexpected EOF while looking for the trailer");
if (object.type == pdf_object::KEYWORD && object.string == "trailer") if (object.type == pdf_object::KEYWORD && object.string == "trailer")
break; break;
@@ -505,7 +518,7 @@ std::string pdf_updater::load_xref(pdf_lexer& lex, std::set<uint>& loaded_entrie
std::string pdf_updater::initialize() { std::string pdf_updater::initialize() {
// We only need to look for startxref roughly within the last kibibyte of the document // We only need to look for startxref roughly within the last kibibyte of the document
static std::regex haystack_re("[\\s\\S]*\\sstartxref\\s+(\\d+)\\s+%%EOF"); static std::regex haystack_re(R"([\s\S]*\sstartxref\s+(\d+)\s+%%EOF)");
std::string haystack = document.substr(document.length() < 1024 ? 0 : document.length() - 1024); std::string haystack = document.substr(document.length() < 1024 ? 0 : document.length() - 1024);
std::smatch m; std::smatch m;
@@ -529,7 +542,7 @@ std::string pdf_updater::initialize() {
auto trailer = parse(lex, throwaway_stack); auto trailer = parse(lex, throwaway_stack);
if (trailer.type != pdf_object::DICT) if (trailer.type != pdf_object::DICT)
return "invalid trailer dictionary"; return pdf_error(trailer, "invalid trailer dictionary");
if (loaded_xrefs.empty()) if (loaded_xrefs.empty())
this->trailer = trailer.dict; this->trailer = trailer.dict;
loaded_xrefs.insert(xref_offset); loaded_xrefs.insert(xref_offset);
@@ -537,6 +550,7 @@ std::string pdf_updater::initialize() {
const auto prev_offset = trailer.dict.find("Prev"); const auto prev_offset = trailer.dict.find("Prev");
if (prev_offset == trailer.dict.end()) if (prev_offset == trailer.dict.end())
break; break;
// FIXME we don't check for size_t over or underflow
if (!prev_offset->second.is_integer()) if (!prev_offset->second.is_integer())
return "invalid Prev offset"; return "invalid Prev offset";
xref_offset = prev_offset->second.number; xref_offset = prev_offset->second.number;
@@ -552,11 +566,30 @@ std::string pdf_updater::initialize() {
return ""; return "";
} }
int pdf_updater::version(const pdf_object& root) const {
auto version = root.dict.find("Version");
if (version != root.dict.end() && version->second.type == pdf_object::NAME) {
const auto& v = version->second.string;
if (isdigit(v[0]) && v[1] == '.' && isdigit(v[2]) && !v[3])
return (v[0] - '0') * 10 + (v[2] - '0');
}
// We only need to look for the comment roughly within the first kibibyte of the document
static std::regex version_re(R"((?:^|[\r\n])%(?:!PS-Adobe-\d\.\d )?PDF-(\d)\.(\d)[\r\n])");
std::string haystack = document.substr(0, 1024);
std::smatch m;
if (std::regex_search(haystack, m, version_re, std::regex_constants::match_default))
return std::stoul(m.str(1)) * 10 + std::stoul(m.str(2));
return 0;
}
pdf_object pdf_updater::get(uint n, uint generation) const { pdf_object pdf_updater::get(uint n, uint generation) const {
if (n >= xref_size) if (n >= xref_size)
return {pdf_object::NIL}; return {pdf_object::NIL};
auto& ref = xref[n]; const auto& ref = xref[n];
if (ref.free || ref.generation != generation || ref.offset >= document.length()) if (ref.free || ref.generation != generation || ref.offset >= document.length())
return {pdf_object::NIL}; return {pdf_object::NIL};
@@ -798,12 +831,10 @@ error:
/// streams from PDF 1.5, or at least constitutes a hybrid-reference file. The results with /// streams from PDF 1.5, or at least constitutes a hybrid-reference file. The results with
/// PDF 2.0 (2017) are currently unknown as the standard costs money. /// PDF 2.0 (2017) are currently unknown as the standard costs money.
/// ///
/// Carelessly assumes that the version of the original document is at most PDF 1.6.
///
/// https://www.adobe.com/devnet-docs/acrobatetk/tools/DigSig/Acrobat_DigitalSignatures_in_PDF.pdf /// https://www.adobe.com/devnet-docs/acrobatetk/tools/DigSig/Acrobat_DigitalSignatures_in_PDF.pdf
/// https://www.adobe.com/content/dam/acom/en/devnet/acrobat/pdfs/pdf_reference_1-7.pdf /// https://www.adobe.com/content/dam/acom/en/devnet/acrobat/pdfs/pdf_reference_1-7.pdf
/// https://www.adobe.com/content/dam/acom/en/devnet/acrobat/pdfs/PPKAppearances.pdf /// https://www.adobe.com/content/dam/acom/en/devnet/acrobat/pdfs/PPKAppearances.pdf
static std::string pdf_sign(std::string& document) { static std::string pdf_sign(std::string& document, ushort reservation) {
pdf_updater pdf(document); pdf_updater pdf(document);
auto err = pdf.initialize(); auto err = pdf.initialize();
if (!err.empty()) if (!err.empty())
@@ -827,7 +858,7 @@ static std::string pdf_sign(std::string& document) {
pdf.document.append((byterange_len = 32 /* fine for a gigabyte */), ' '); pdf.document.append((byterange_len = 32 /* fine for a gigabyte */), ' ');
pdf.document.append("\n /Contents <"); pdf.document.append("\n /Contents <");
sign_off = pdf.document.size(); sign_off = pdf.document.size();
pdf.document.append((sign_len = 8192 /* certificate, digest, encrypted digest, ... */), '0'); pdf.document.append((sign_len = reservation * 2), '0');
pdf.document.append("> >>"); pdf.document.append("> >>");
// We actually need to exclude the hexstring quotes from signing // We actually need to exclude the hexstring quotes from signing
@@ -861,15 +892,21 @@ static std::string pdf_sign(std::string& document) {
if (page.type != pdf_object::DICT) if (page.type != pdf_object::DICT)
return "invalid or unsupported page tree"; return "invalid or unsupported page tree";
// XXX assuming this won't be an indirectly referenced array
auto& annots = page.dict["Annots"]; auto& annots = page.dict["Annots"];
if (annots.type != pdf_object::ARRAY) if (annots.type != pdf_object::ARRAY) {
// TODO indirectly referenced arrays might not be that hard to support
if (annots.type != pdf_object::END)
return "unexpected Annots";
annots = {pdf_object::ARRAY}; annots = {pdf_object::ARRAY};
}
annots.array.emplace_back(pdf_object::REFERENCE, sigfield_n, 0); annots.array.emplace_back(pdf_object::REFERENCE, sigfield_n, 0);
pdf.update(page.n, [&]{ pdf.document += pdf_serialize(page); }); pdf.update(page.n, [&]{ pdf.document += pdf_serialize(page); });
// 8.6.1 Interactive Form Dictionary // 8.6.1 Interactive Form Dictionary
// XXX assuming there are no forms already, overwriting everything if (root.dict.count("AcroForm"))
return "the document already contains forms, they would be overwritten";
root.dict["AcroForm"] = {std::map<std::string, pdf_object>{ root.dict["AcroForm"] = {std::map<std::string, pdf_object>{
{"Fields", {std::vector<pdf_object>{ {"Fields", {std::vector<pdf_object>{
{pdf_object::REFERENCE, sigfield_n, 0} {pdf_object::REFERENCE, sigfield_n, 0}
@@ -878,9 +915,9 @@ static std::string pdf_sign(std::string& document) {
}}; }};
// Upgrade the document version for SHA-256 etc. // Upgrade the document version for SHA-256 etc.
// XXX assuming that it's not newer than 1.6 already -- while Cairo can't currently use a newer if (pdf.version(root) < 16)
// version that 1.5, it's not a bad idea to use cairo_pdf_surface_restrict_to_version() root.dict["Version"] = {pdf_object::NAME, "1.6"};
root.dict["Version"] = {pdf_object::NAME, "1.6"};
pdf.update(root_ref->second.n, [&]{ pdf.document += pdf_serialize(root); }); pdf.update(root_ref->second.n, [&]{ pdf.document += pdf_serialize(root); });
pdf.flush_updates(); pdf.flush_updates();
@@ -911,25 +948,39 @@ static void die(int status, const char* format, ...) {
int main(int argc, char* argv[]) { int main(int argc, char* argv[]) {
auto invocation_name = argv[0]; auto invocation_name = argv[0];
auto usage = [=]{ auto usage = [=]{
die(1, "Usage: %s [-h] INPUT-FILENAME OUTPUT-FILENAME PKCS12-PATH PKCS12-PASS", die(1, "Usage: %s [-h] [-r RESERVATION] INPUT-FILENAME OUTPUT-FILENAME PKCS12-PATH PKCS12-PASS",
invocation_name); invocation_name);
}; };
static struct option opts[] = { static struct option opts[] = {
{"help", no_argument, 0, 'h'}, {"help", no_argument, 0, 'h'},
{"version", no_argument, 0, 'V'},
{"reservation", required_argument, 0, 'r'},
{nullptr, 0, 0, 0}, {nullptr, 0, 0, 0},
}; };
// Reserved space in bytes for the certificate, digest, encrypted digest, ...
long reservation = 4096;
while (1) { while (1) {
int option_index = 0; int option_index = 0;
auto c = getopt_long(argc, const_cast<char* const*>(argv), auto c = getopt_long(argc, const_cast<char* const*>(argv),
"h", opts, &option_index); "hVr:", opts, &option_index);
if (c == -1) if (c == -1)
break; break;
char* end = nullptr;
switch (c) { switch (c) {
case 'h': usage(); break; case 'r':
default: usage(); errno = 0, reservation = strtol(optarg, &end, 10);
if (errno || *end || reservation <= 0 || reservation > USHRT_MAX)
die(1, "%s: must be a positive number", optarg);
break;
case 'V':
die(0, "%s", PROJECT_NAME " " PROJECT_VERSION);
break;
case 'h':
default:
usage();
} }
} }
@@ -956,7 +1007,7 @@ int main(int argc, char* argv[]) {
die(1, "%s: %s", input_path, strerror(errno)); die(1, "%s: %s", input_path, strerror(errno));
} }
auto err = pdf_sign(pdf_document); auto err = pdf_sign(pdf_document, ushort(reservation));
if (!err.empty()) { if (!err.empty()) {
die(2, "Error: %s", err.c_str()); die(2, "Error: %s", err.c_str());
} }
@@ -967,7 +1018,6 @@ int main(int argc, char* argv[]) {
(void) unlink(output_path); (void) unlink(output_path);
die(3, "%s: %s", output_path, strerror(errno)); die(3, "%s: %s", output_path, strerror(errno));
} }
fclose(fp);
} else { } else {
die(3, "%s: %s", output_path, strerror(errno)); die(3, "%s: %s", output_path, strerror(errno));
} }

1243
pdf/pdf.go Normal file

File diff suppressed because it is too large Load Diff

77
test.sh Executable file
View File

@@ -0,0 +1,77 @@
#!/bin/sh -e
# Test basic functionality of both versions
# Usage: ./test.sh builddir/pdf-simple-sign cmd/pdf-simple-sign/pdf-simple-sign
log() { echo "`tput sitm`-- $1`tput sgr0`"; }
die() { echo "`tput bold`-- $1`tput sgr0`"; exit 1; }
# Get rid of old test files
rm -rf tmp
mkdir tmp
# Create documents in various tools
log "Creating source documents"
inkscape --pipe --export-filename=tmp/cairo.pdf <<'EOF' 2>/dev/null || :
<svg xmlns="http://www.w3.org/2000/svg"><text x="5" y="10">Hello</text></svg>
EOF
date | tee tmp/lowriter.txt | groff -T pdf > tmp/groff.pdf || :
lowriter --convert-to pdf tmp/lowriter.txt --outdir tmp >/dev/null || :
convert rose: tmp/imagemagick.pdf || :
# Create a root CA certificate pair
log "Creating certificates"
openssl req -newkey rsa:2048 -subj "/CN=Test CA" -nodes \
-keyout tmp/ca.key.pem -x509 -out tmp/ca.cert.pem 2>/dev/null
# Create a private NSS database and insert our test CA there
rm -rf tmp/nssdir
mkdir tmp/nssdir
certutil -N --empty-password -d sql:tmp/nssdir
certutil -d sql:tmp/nssdir -A -n root -t ,C, -a -i tmp/ca.cert.pem
# Create a leaf certificate pair
cat > tmp/cert.cfg <<'EOF'
[smime]
basicConstraints = CA:FALSE
keyUsage = digitalSignature
extendedKeyUsage = emailProtection
nsCertType = email
EOF
openssl req -newkey rsa:2048 -subj "/CN=Test Leaf" -nodes \
-keyout tmp/key.pem -out tmp/cert.csr 2>/dev/null
openssl x509 -req -in tmp/cert.csr -out tmp/cert.pem \
-CA tmp/ca.cert.pem -CAkey tmp/ca.key.pem -set_serial 1 \
-extensions smime -extfile tmp/cert.cfg 2>/dev/null
openssl verify -CAfile tmp/ca.cert.pem tmp/cert.pem >/dev/null
openssl pkcs12 -inkey tmp/key.pem -in tmp/cert.pem \
-export -passout pass: -out tmp/key-pair.p12
for tool in "$@"; do
rm -f tmp/*.signed.pdf
for source in tmp/*.pdf; do
log "Testing $tool with $source"
result=${source%.pdf}.signed.pdf
$tool "$source" "$result" tmp/key-pair.p12 ""
pdfsig -nssdir sql:tmp/nssdir "$result" | grep Validation
done
log "Testing $tool for expected failures"
$tool "$result" "$source.fail.pdf" tmp/key-pair.p12 "" \
&& die "Double signing shouldn't succeed"
$tool -r 1 "$source" "$source.fail.pdf" tmp/key-pair.p12 "" \
&& die "Too low reservations shouldn't succeed"
# Our generators do not use PDF versions higher than 1.5
log "Testing $tool for version detection"
grep -q "/Version /1.6" "$result" \
|| die "Version detection seems to misbehave (no upgrade)"
sed '1s/%PDF-1../%PDF-1.7/' "$source" > "$source.alt"
$tool "$source.alt" "$result.alt" tmp/key-pair.p12 ""
grep -q "/Version /1.6" "$result.alt" \
&& die "Version detection seems to misbehave (downgraded)"
done
log "OK"