/** * SPDX-FileCopyrightText: (C) 2016 zyx * SPDX-License-Identifier: GPL-2.0-or-later */ #include #include #include #include #include #include #include #include #if defined(_WIN64) #define fseeko _fseeki64 #define ftello _ftelli64 #else #define fseeko fseek #define ftello ftell #endif using namespace std; using namespace PoDoFo; static void print_help(bool bOnlyUsage) { if (!bOnlyUsage) { cout << "Digitally signs existing PDF file with the given certificate and private key." << endl; } cout << endl; cout << "Usage: podofosign [arguments]" << endl; cout << "The required arguments:" << endl; cout << " -in [inputfile] ... an input file to sign; if no -out is set, updates the input file" << endl; cout << " -cert [certfile] ... a file with a PEM-encoded certificate to include in the document" << endl; cout << " -pkey [pkeyfile] ... a file with a PEM-encoded private key to sign the document with" << endl; cout << "The optional arguments:" << endl; cout << " -out [outputfile] ... an output file to save the signed document to; cannot be the same as the input file" << endl; cout << " -password [password] ... a password to unlock the private key file" << endl; cout << " -digest [name] ... a digest name to use for the signature; default is SHA512" << endl; cout << " -reason [utf8-string] ... a UTF-8 encoded string with the reason of the signature; default reason is \"I agree\"" << endl; cout << " -sigsize [size] ... how many bytes to allocate for the signature; the default is derived from the certificate and private key file size" << endl; cout << " -field-name [name] ... field name to use; defaults to 'PoDoFoSignatureFieldXXX', where XXX is the object number" << endl; cout << " -field-use-existing ... whether to use existing signature field, if such named exists; the field type should be a signature" << endl; cout << " -annot-units [mm|inch] ... set units for the annotation positions; default is mm" << endl; cout << " -annot-position [page,left,top,width,height] ... where to place the annotation" << endl; cout << " page ... a 1-based page index (integer), where '1' means the first page, '2' the second, and so on" << endl; cout << " left,top,width,height ... a rectangle (in annot-units) where to place the annotation on the page (double)" << endl; cout << " -annot-print ... use that to have the annotation printable, otherwise it's not printed (the default is not to print it)" << endl; cout << " -annot-font [size,rrggbb,name] ... sets a font for the following annot-text; default is \"5,000000,Helvetica\" in mm" << endl; cout << " size ... the font size, in annot-units" << endl; cout << " rrggbb ... the font color, where rr is for red, gg for green and bb for blue, all two-digit hexa values between 00 and ff" << endl; cout << " name ... the font name to use; if a Base14 font is recognized, then it is used, instead of embedding a new font" << endl; cout << " -annot-text [left,top,utf8-string] ... a UTF-8 encoded string to add to the annotation" << endl; cout << " left,top ... the position (in annot-units, relative to annot-position) where to place the text (double)" << endl; cout << " text ... the actual UTF-8 encoded string to add to the annotation" << endl; cout << " -annot-image [left,top,width,height,filename] ... an image to add to the annotation" << endl; cout << " left,top,width,height ... a rectangle (in annot-units) where to place the image (double), relative to annot-position" << endl; cout << " filename ... a filename of the image to add" << endl; cout << "The annotation arguments can be repeated, except of the -annot-position and -annot-print, which can appear up to once." << endl; cout << "The -annot-print, -annot-font, -annot-text and -annot-image can appear only after -annot-position." << endl; cout << "All the left,top positions are treated with 0,0 being at the left-top of the page." << endl; cout << "No drawing is done when using existing field." << endl; } static float convert_to_pdf_units(const string_view& annot_units, float value) { if (annot_units == "mm") { return 72.f * value / 25.4f; } else if (annot_units == "inch") { return 72.f * value; } else { string err = "Unknown annotation unit '"; err += annot_units; err += "'"; PODOFO_RAISE_ERROR_INFO(PdfErrorCode::InvalidEnumValue, err); } } static bool parse_annot_position(const string_view& annot_position, const string_view& annot_units, int& annot_page, double& annot_left, double& annot_top, double& annot_width, double& annot_height) { float fLeft, fTop, fWidth, fHeight; if (sscanf(annot_position.data(), "%d,%f,%f,%f,%f", &annot_page, &fLeft, &fTop, &fWidth, &fHeight) != 5) { return false; } annot_left = convert_to_pdf_units(annot_units, fLeft); annot_top = convert_to_pdf_units(annot_units, fTop); annot_width = convert_to_pdf_units(annot_units, fWidth); annot_height = convert_to_pdf_units(annot_units, fHeight); if (annot_page < 1) return false; annot_page--; return true; } static const char* skip_commas(const string_view& text, int ncommas) { if (text.empty()) { PODOFO_RAISE_ERROR(PdfErrorCode::InvalidHandle); } const char* res = text.data(); while (*res != '\0' && ncommas > 0) { if (*res == ',') ncommas--; res++; } if (ncommas > 0) { string err = "The text '"; err += text; err += "' does not conform to the specified format (no enougt commas)"; PODOFO_RAISE_ERROR_INFO(PdfErrorCode::InvalidDataType, err.c_str()); } return res; } static void draw_annotation(PdfDocument& document, PdfPainter& painter, const cspan& args, const Rect& annot_rect) { string_view annot_units = "mm"; double font_size = convert_to_pdf_units("mm", 5.0); PdfColor font_color(0.0, 0.0, 0.0); const char* font_name = "Helvetica"; bool updateFont = true; for (unsigned i = 1; i < args.size(); i++) { if (args[i] == "-annot-units") { annot_units = args[i + 1]; } else if (args[i] == "-annot-font") { float fSize; int rr, gg, bb; if (sscanf(args[i + 1].data(), "%f,%02x%02x%02x,", &fSize, &rr, &gg, &bb) != 4) { string err = "The value for -annot-font '"; err += args[i + 1]; err += "' doesn't conform to format 'size,rrggbb,name'"; PODOFO_RAISE_ERROR_INFO(PdfErrorCode::InvalidDataType, err.c_str()); } font_size = convert_to_pdf_units(annot_units, fSize); font_color = PdfColor(static_cast(rr) / 255.0, static_cast(gg) / 255.0, static_cast(bb) / 255.0); font_name = skip_commas(args[i + 1], 2); updateFont = true; } else if (args[i] == "-annot-text") { float left, top; if (sscanf(args[i + 1].data(), "%f,%f,", &left, &top) != 2) { string err = "The value for -annot-text '"; err += args[i + 1]; err += "' doesn't conform to format 'left,top,text'"; PODOFO_RAISE_ERROR_INFO(PdfErrorCode::InvalidDataType, err.c_str()); } const char* text = skip_commas(args[i + 1], 2); if (updateFont) { PdfFont* font; font = document.GetFonts().SearchFont(font_name); if (!font) { string err = "Failed to create font '"; err += font_name; err += "'"; PODOFO_RAISE_ERROR_INFO(PdfErrorCode::OutOfMemory, err.c_str()); } painter.TextState.SetFont(*font, font_size); painter.GraphicsState.SetStrokingColor(font_color); } left = convert_to_pdf_units(annot_units, left); top = convert_to_pdf_units(annot_units, top); painter.DrawTextMultiLine(text, left, 0.0, annot_rect.Width - left, annot_rect.Height - top); } else if (args[i] == "-annot-image") { float left, top, width, height; if (sscanf(args[i + 1].data(), "%f,%f,%f,%f,", &left, &top, &width, &height) != 4) { string err = "The value for -annot-image '"; err += args[i + 1]; err += "' doesn't conform to format 'left,top,width,height,filename'"; PODOFO_RAISE_ERROR_INFO(PdfErrorCode::InvalidDataType, err.c_str()); } const char* filename = skip_commas(args[i + 1], 4); left = convert_to_pdf_units(annot_units, left); top = convert_to_pdf_units(annot_units, top); width = convert_to_pdf_units(annot_units, width); height = convert_to_pdf_units(annot_units, height); auto image = document.CreateImage(); image->Load(filename); double dScaleX = left / image->GetWidth(); double dScaleY = height / image->GetHeight(); painter.DrawImage(*image, left, annot_rect.Height - top - height, dScaleX, dScaleY); } // these are the only parameters without additional value if (args[i] != "-annot-print" && args[i] != "-field-use-existing") { i++; } } } static PdfObject* find_existing_signature_field(PdfAcroForm& acroForm, const PdfString& name) { PdfObject* fields = acroForm.GetDictionary().GetKey("Fields"); if (fields) { if (fields->GetDataType() == PdfDataType::Reference) fields = acroForm.GetDocument().GetObjects().GetObject(fields->GetReference()); if (fields && fields->GetDataType() == PdfDataType::Array) { PdfArray& rArray = fields->GetArray(); PdfArray::iterator it, end = rArray.end(); for (it = rArray.begin(); it != end; it++) { // require references in the Fields array if (it->GetDataType() == PdfDataType::Reference) { PdfObject* item = acroForm.GetDocument().GetObjects().GetObject(it->GetReference()); if (item && item->GetDictionary().HasKey("T") && item->GetDictionary().GetKey("T")->GetString() == name) { // found a field with the same name const PdfObject* ft = item->GetDictionary().GetKey("FT"); if (!ft && item->GetDictionary().HasKey("Parent")) { const PdfObject* temp = item->GetDictionary().FindKey("Parent"); if (!temp) { PODOFO_RAISE_ERROR(PdfErrorCode::InvalidDataType); } ft = temp->GetDictionary().GetKey("FT"); } if (!ft) { PODOFO_RAISE_ERROR(PdfErrorCode::InvalidObject); } const PdfName fieldType = ft->GetName(); if (fieldType != "Sig") { string err = "Existing field '"; err += name.GetString(); err += "' isn't of a signature type, but '"; err += fieldType.GetString(); err += "' instead"; PODOFO_RAISE_ERROR_INFO(PdfErrorCode::InvalidName, err.c_str()); } return item; } } } } } return NULL; } #if 0 /* TODO */ static void update_default_appearance_streams(PdfAcroForm* pAcroForm) { if (!pAcroForm || !pAcroForm->GetObject()->GetDictionary().HasKey("Fields") || pAcroForm->GetObject()->GetDictionary().GetKey("Fields")->GetDataType() != PdfDataType::Array) return; PdfArray& rFields = pAcroForm->GetObject()->GetDictionary().GetKey("Fields")->GetArray(); PdfArray::iterator it, end = rFields.end(); for (it = rFields.begin(); it != end; it++) { if (it->GetDataType() == PdfDataType::Reference) { PdfObject* pObject = pAcroForm->GetDocument()->GetObjects()->GetObject(it->GetReference()); if (!pObject || pObject->GetDataType() != PdfDataType::Dictionary) continue; PdfDictionary& rFielDict = pObject->GetDictionary(); if (rFielDict.HasKey("FT") && rFielDict.GetKey("FT")->GetDataType() == PdfDataType::Name && (rFielDict.GetKey("FT")->GetName() == "Tx" || rFielDict.GetKey("FT")->GetName() == "Ch")) { PdfString rDA, rV, rDV; if (rFielDict.HasKey("V") && (rFielDict.GetKey("V")->GetDataType() == PdfDataType::String || rFielDict.GetKey("V")->GetDataType() == PdfDataType::HexString)) { rV = rFielDict.GetKey("V")->GetString(); } if (rFielDict.HasKey("DV") && (rFielDict.GetKey("DV")->GetDataType() == PdfDataType::String || rFielDict.GetKey("DV")->GetDataType() == PdfDataType::HexString)) { rDV = rFielDict.GetKey("DV")->GetString(); } if (rV.IsValid() && rV.GetCharacterLength() > 0) { rDV = rV; } if (!rDV.IsValid() || rDV.GetCharacterLength() <= 0) continue; if (rDV.GetLength() >= 2 && rDV.GetString()[0] == static_cast(0xFE) && rDV.GetString()[1] == static_cast(0xFF)) { if (rDV.GetLength() == 2) continue; } if (rFielDict.HasKey("DA") && rFielDict.GetKey("DA")->GetDataType() == PdfDataType::String) { rDA = rFielDict.GetKey("DA")->GetString(); } if (rFielDict.HasKey("AP") && rFielDict.GetKey("AP")->GetDataType() == PdfDataType::Dictionary && rFielDict.GetKey("AP")->GetDictionary().HasKey("N") && rFielDict.GetKey("AP")->GetDictionary().GetKey("N")->GetDataType() == PdfDataType::Reference) { pObject = pAcroForm->GetDocument()->GetObjects()->GetObject(rFielDict.GetKey("AP")->GetDictionary().GetKey("N")->GetReference()); if (pObject->GetDataType() == PdfDataType::Dictionary && pObject->GetDictionary().HasKey("Type") && pObject->GetDictionary().GetKey("Type")->GetDataType() == PdfDataType::Name && pObject->GetDictionary().GetKey("Type")->GetName() == "XObject") { PdfXObject xObject(pObject); PdfStream* pCanvas = xObject.GetContentsForAppending()->GetStream(); if (rFielDict.GetKey("FT")->GetName() == "Tx") { pCanvas->BeginAppend(true); PdfRefCountedBuffer rBuffer; PdfOutputDevice rOutputDevice(&rBuffer); rDV.Write(&rOutputDevice, ePdfWriteMode_Compact); ostringstream oss; oss << "/Tx BMC" << endl; oss << "BT" << endl; if (rDA.IsValid()) oss << rDA.GetString() << endl; oss << "2.0 2.0 Td" << endl; oss << rBuffer.GetBuffer() << " Tj" << endl; oss << "ET" << endl; oss << "EMC" << endl; pCanvas->Append(oss.str()); pCanvas->EndAppend(); } else if (rFielDict.GetKey("FT")->GetName() == "Ch") { } } } } } } } #endif void Main(const cspan& args) { string_view inputfile; string_view outputfile; string_view certfile; string_view pkeyfile; string_view password; string_view digest; string_view reason = "I agree"; string_view sigsizestr; string_view annot_units = "mm"; string_view annot_position; string_view field_name; int annot_page = 0; double annot_left = 0.0, annot_top = 0.0, annot_width = 0.0, annot_height = 0.0; bool annot_print = false; bool field_use_existing = false; PdfCommon::SetMaxLoggingSeverity(PdfLogSeverity::None); for (unsigned i = 1; i < args.size(); i++) { string_view* value = nullptr; if (args[i] == "-in") { value = &inputfile; } else if (args[i] == "-out") { value = &outputfile; } else if (args[i] == "-cert") { value = &certfile; } else if (args[i] == "-pkey") { value = &pkeyfile; } else if (args[i] == "-digest") { value = &digest; } else if (args[i] == "-password") { value = &password; } else if (args[i] == "-reason") { value = &reason; } else if (args[i] == "-sigsize") { value = &sigsizestr; } else if (args[i] == "-annot-units") { value = &annot_units; } else if (args[i] == "-annot-position") { if (!annot_position.empty()) { cerr << "Only one -annot-position can be specified" << endl; exit(-1); } value = &annot_position; } else if (args[i] == "-annot-print") { if (annot_position.empty()) { cerr << "Missing -annot-position argument, which should be defined before '" << args[i] << "'" << endl; exit(-2); } if (annot_print) { cerr << "Only one -annot-print can be specified" << endl; exit(-1); } annot_print = !annot_print; continue; } else if (args[i] == "-annot-font" || args[i] == "-annot-text" || args[i] == "-annot-image") { if (annot_position.empty()) { cerr << "Missing -annot-position argument, which should be defined before '" << args[i] << "'" << endl; exit(-2); } // value is left NULL, these are parsed later } else if (args[i] == "-field-name") { value = &field_name; } else if (args[i] == "-field-use-existing") { if (field_use_existing) { cerr << "Only one -field-use-existing can be specified" << endl; exit(-1); } field_use_existing = !field_use_existing; continue; } else { cerr << "Unknown argument '" << args[i] << "'" << endl; print_help(true); exit(-3); } if (i + 1 >= args.size()) { cerr << "Missing value for argument '" << args[i] << "'" << endl; print_help(true); exit(-4); } if (value) { *value = args[i + 1]; if (*value == annot_units && annot_units != "mm" && annot_units != "inch") { cerr << "Invalid -annot-units value '" << *value << "', only 'mm' and 'inch' are supported" << endl; exit(-5); } try { if (*value == annot_position && !parse_annot_position(annot_position, annot_units, annot_page, annot_left, annot_top, annot_width, annot_height)) { cerr << "Invalid -annot-position value '" << *value << "', expected format \"page,left,top,width,height\"" << endl; exit(-6); } } catch (...) { cerr << "Invalid -annot-position value '" << *value << "', expected format \"page,left,top,width,height\"" << endl; exit(-6); } } i++; } if (inputfile.empty() || certfile.empty() || pkeyfile.empty()) { if (args.size() != 1) cerr << "Not all required arguments specified." << endl; print_help(true); exit(-7); } int sigsize = -1; if (!sigsizestr.empty()) { sigsize = atoi(sigsizestr.data()); if (sigsize <= 0) { cerr << "Invalid value for signature size specified (" << sigsizestr << "), use a positive integer, please" << endl; exit(-8); } } if (!outputfile.empty() && outputfile == inputfile) { // even I told you not to do it, you still specify the same output file // as the input file. Just ignore that. outputfile = { }; } OPENSSL_init_crypto(0, NULL); PdfSignature* signature = NULL; const EVP_MD* md_digest; if (!digest.empty()) { md_digest = EVP_get_digestbyname(digest.data()); if (!md_digest) { string err = "Unknown digest '"; err += digest; err += "'"; PODOFO_RAISE_ERROR_INFO(PdfErrorCode::InvalidName, err.c_str()); } } else { md_digest = EVP_sha512(); if (!md_digest) cerr << "Cannot get SHA512 digest, using default OpenSSL digest instead." << endl; } PdfMemDocument document; document.Load(inputfile); if (!document.GetPages().GetCount()) PODOFO_RAISE_ERROR_INFO(PdfErrorCode::ValueOutOfRange, "The document has no page. Only documents with at least one page can be signed"); auto& acroForm = document.GetOrCreateAcroForm(); if (!acroForm.GetDictionary().HasKey("SigFlags") || !acroForm.GetDictionary().MustGetKey("SigFlags").IsNumber() || acroForm.GetDictionary().FindKeyAsSafe("SigFlags") != 3) { if (acroForm.GetDictionary().HasKey("SigFlags")) acroForm.GetDictionary().RemoveKey("SigFlags"); int64_t val = 3; acroForm.GetDictionary().AddKey("SigFlags", val); } if (acroForm.GetNeedAppearances()) { #if 0 /* TODO */ update_default_appearance_streams(pAcroForm); #endif acroForm.SetNeedAppearances(false); } PdfString name; PdfObject* existingSigField = NULL; if (!field_name.empty()) { name = PdfString(field_name); existingSigField = find_existing_signature_field(acroForm, name); if (existingSigField && !field_use_existing) { string err = "Signature field named '"; err += name.GetString(); err += "' already exists"; PODOFO_RAISE_ERROR_INFO(PdfErrorCode::WrongDestinationType, err.c_str()); } } else { char fldName[96]; // use bigger buffer to make sure sprintf does not overflow sprintf(fldName, "PodofoSignatureField%u", document.GetObjects().GetObjectCount()); name = PdfString(fldName); } if (existingSigField) { if (!existingSigField->GetDictionary().HasKey("P")) { string err = "Signature field named '"; err += name.GetString(); err += "' doesn't have a page reference"; PODOFO_RAISE_ERROR_INFO(PdfErrorCode::ValueOutOfRange, err.c_str()); } auto& page = document.GetPages().GetPage(existingSigField->GetDictionary().GetKey("P")->GetReference()); signature = &static_cast( static_cast(page.GetAnnotations().GetAnnot(existingSigField->GetIndirectReference())).GetField()); signature->EnsureValueObject(); } else { auto& page = document.GetPages().GetPageAt(annot_page); Rect annot_rect; if (!annot_position.empty()) { annot_rect = Rect(annot_left, page.GetMediaBox().Height - annot_top - annot_height, annot_width, annot_height); } signature = &page.CreateField(name, annot_rect); if (!annot_position.empty() && annot_print) signature->MustGetWidget().SetFlags(PdfAnnotationFlags::Print); else if (annot_position.empty() && (field_name.empty() || !field_use_existing)) signature->MustGetWidget().SetFlags(PdfAnnotationFlags::Invisible | PdfAnnotationFlags::Hidden); if (!annot_position.empty()) { Rect annotSize(0.0, 0.0, annot_rect.Width, annot_rect.Height); auto sigXObject = document.CreateXObjectForm(annotSize); PdfPainter painter; try { painter.SetCanvas(*sigXObject); /* Workaround Adobe's reader error 'Expected a dict object.' when the stream contains only one object which does Save()/Restore() on its own, like the image XObject. */ painter.Save(); painter.Restore(); draw_annotation(document, painter, args, annot_rect); signature->MustGetWidget().SetAppearanceStream(*sigXObject); } catch (...) { } painter.FinishDrawing(); } } signature->SetSignatureReason(PdfString(reason)); signature->SetSignatureDate(PdfDate()); PdfSignerCmsParams params; if (digest.length() != 0) params.Hashing = PoDoFo::ConvertTo(digest); charbuff cert; utls::ReadTo(cert, certfile); charbuff pkey; utls::ReadTo(pkey, pkeyfile); PdfSignerCms signer(cert, pkey, params); FileStreamDevice device(outputfile.empty() ? inputfile : outputfile, FileMode::Open, DeviceAccess::Write); PoDoFo::SignDocument(document, device, signer, *signature); }