origami-docspring 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bd7d27578057971751df78c314604a899a3151bf8f0aa025b064817a97967ca5
+  data.tar.gz: e4520d83ea3373cdb6057cf44bbb77b17730bf357866e08f582ff5f741347e40
+SHA512:
+  metadata.gz: 7242805e8acc6dd14a17eb738b52d89b485667086d77f93ec9245cd93c14c2a3812a90c83c30ef5ec95dfe1b5abcfa24a5083c3489ac9ba9897be451769860f1
+  data.tar.gz: b7b6a4301a9e00bd23d28886bde075849fbff44766ad4d9b2a7fb534b63040e7a6e0da2111ad73b098b4e104716a1d08f22c2b9bcc02ff0c41abf465ec74f367

data/CHANGELOG.md

@@ -0,0 +1,70 @@
+2.1.0
+-----
+* Moved pdfwalker to a separate gem
+
+2.0.0
+-----
+* Code reindented to 4 spaces.
+* Code base refactored for Ruby 2.x (requires at least 2.1).
+* Support for Crypt filters.
+* The parser now supports a lazy mode.
+* Fixed all Ruby warnings.
+* Better type propagation.
+* Use namespace refinements to protect the standard namespace.
+* PDF#each_* methods can return Enumerators.
+* Use the colorize gem for console output.
+* Faster loading of objects in pdfwalker.
+* Better handling of cross-references in pdfwalker.
+* Many bug fixes.
+
+1.2.0 (2011-09-29)
+-----
+* Support for JavaScript emulation based on V8 (requires therubyracer gem).
+
+1.1.0 (2011-09-14)
+-----
+* Support for standard security handler revision 6.
+
+1.0.2 (2011-05-25)
+-----
+* Added a Rakefile to run unit tests, build rdoc and build gem.
+* Added a Ruby shell for Origami.
+* Added a bin folder, with some useful command-line tools.
+* Can now be installed as a RubyGem.
+* AESV3 support (AES256 encryption/decryption).
+* Encryption/decryption can be achieved with or without openssl.
+* Changed PDF#encrypt prototype.
+* Support for G3 unidimensional encoding/decoding of CCITTFax filter.
+* Support for TIFF stream predictor functions.
+* Name trees lookup methods.
+* Renamed PDF#saveas to PDF#save.
+* Lot of bug fixes.
+
+beta3 (2010-08-26)
+-----
+* Faster decryption process.
+* Properly parse objects with no endobj token.
+* Image viewer in pdfwalker.
+
+beta2 (2010-04-01)
+-----
+* Support for Flash/RichMedia integration.
+* XFA forms.
+* Search feature for pdfwalker.
+* Fixed various bugs.
+
+beta1 (2009-09-15)
+-----
+* Basic support for graphics drawing as lines, colors, shading, shapes...
+* Support for numerical functions.
+* Support for date strings.
+* Added PDF#insert_page(index, page) method.
+* Added a forms widgets template.
+* Ability to delinearize documents.
+* Fixed various bugs.
+
+beta0 (2009-07-06)
+-----
+* Support for XRef streams. 
+* Support for Object streams creation. 
+* Support for PNG stream predictor functions.

data/COPYING.LESSER

@@ -0,0 +1,165 @@
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,115 @@
+Origami
+=====
+[![Gem Version](https://badge.fury.io/rb/origami.svg)](https://rubygems.org/gems/origami)
+[![Downloads](https://img.shields.io/gem/dt/origami.svg)](https://rubygems.org/gems/origami)
+[![Build Status](https://secure.travis-ci.org/gdelugre/origami.svg?branch=master)](https://travis-ci.org/gdelugre/origami)
+[![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
+
+Overview
+--------
+
+Origami is a framework written in pure Ruby to manipulate PDF files.
+
+It offers the possibility to parse the PDF contents, modify and save the PDF
+structure, as well as creating new documents.
+
+Origami supports some advanced features of the PDF specification:
+
+  * Compression filters with predictor functions
+  * Encryption using RC4 or AES, including the undocumented Revision 6 derivation algorithm
+  * Digital signatures and Usage Rights
+  * File attachments
+  * AcroForm and XFA forms
+  * Object streams
+
+Origami is able to parse PDF, FDF and PPKLite (Adobe certificate store) files.
+
+Requirements
+------------
+
+As of version 2, the minimal version required to run Origami is Ruby 2.1.
+
+Some optional features require additional gems:
+
+  * [therubyracer][the-ruby-racer] for JavaScript emulation of PDF scripts
+
+Quick start
+-----------
+
+First install Origami using the latest gem available:
+
+    $ gem install origami
+
+Then import Origami with:
+
+```ruby
+require 'origami'
+```
+
+To process a PDF document, you can use the ``PDF.read`` method:
+
+```ruby
+pdf = Origami::PDF.read "something.pdf"
+
+puts "This document has #{pdf.pages.size} page(s)"
+```
+
+The default behavior is to parse the entire contents of the document at once. This can be changed by passing the ``lazy`` flag to parse objects on demand.
+
+```ruby
+pdf = Origami::PDF.read "something.pdf", lazy: true
+
+pdf.each_page do |page|
+    page.each_font do |name, font|
+        # ... only parse the necessary bits
+    end
+end
+```
+
+You can also create documents directly by instanciating a new PDF object:
+
+```ruby
+pdf = Origami::PDF.new
+
+pdf.append_page
+pdf.pages.first.write "Hello", size: 30
+
+pdf.save("example.pdf")
+
+# Another way of doing it
+Origami::PDF.write("example.pdf") do |pdf|
+    pdf.append_page do |page|
+        page.write "Hello", size: 30
+    end
+end
+```
+
+Take a look at the [examples](examples) and [bin](bin) directories for some examples of advanced usage.
+
+Tools
+-----
+
+Origami comes with a set of tools to manipulate PDF documents from the command line.
+
+  * [pdfcop](bin/pdfcop): Runs some heuristic checks to detect dangerous contents.
+  * [pdfdecompress](bin/pdfdecompress): Strips compression filters out of a document.
+  * [pdfdecrypt](bin/pdfdecrypt): Removes encrypted contents from a document.
+  * [pdfencrypt](bin/pdfencrypt): Encrypts a PDF document.
+  * [pdfexplode](bin/pdfexplode): Explodes a document into several documents, each of them having one deleted resource. Useful for reduction of crash cases after a fuzzing session.
+  * [pdfextract](bin/pdfextract): Extracts binary resources of a document (images, scripts, fonts, etc.).
+  * [pdfmetadata](bin/pdfmetadata): Displays the metadata contained in a document.
+  * [pdf2ruby](bin/pdf2ruby): Converts a PDF into an Origami script rebuilding an equivalent document (experimental).
+  * [pdfsh](bin/pdfsh): An IRB shell running inside the Origami namespace.
+
+**Note**: Since version 2.1, [pdfwalker][pdfwalker-gem] has been moved to a [separate repository][pdfwalker-repo].
+
+License
+-------
+
+Origami is distributed under the [LGPL](COPYING.LESSER) license.
+
+Copyright © 2019 Guillaume Delugré.
+
+[the-ruby-racer]: https://rubygems.org/gems/therubyracer
+[pdfwalker-gem]: https://rubygems.org/gems/pdfwalker
+[pdfwalker-repo]: https://github.com/gdelugre/pdfwalker

data/bin/config/pdfcop.conf.yml

@@ -0,0 +1,236 @@
+---
+POLICY_NONE:
+
+    #
+    # General features.
+    #
+    allowParserErrors: true
+    allowAttachments: true
+    allowEncryption: true
+    allowFormCalc: true
+    allowJSAtOpening: true
+    allowJS: true
+    allowAcroForms: true
+    allowXFAForms: true
+
+    #
+    # Page annotations.
+    #
+    allowAnnotations: true
+    allow3DAnnotation: true
+    allowFileAttachmentAnnotation: true
+    allowMovieAnnotation: true
+    allowRichMediaAnnotation: true
+    allowScreenAnnotation: true
+    allowSoundAnnotation: true
+
+    #
+    # PDF Actions.
+    #
+    allowChainedActions: true
+    allowOpenAction: true
+    allowGoTo3DAction: true
+    allowGoToAction: true
+    allowGoToEAction: true
+    allowGoToRAction: true
+    allowImportDataAction: true
+    allowJSAction: true
+    allowLaunchAction: true
+    allowMovieAction: true
+    allowNamedAction: true
+    allowRenditionAction: true
+    allowRichMediaAction: true
+    allowSoundAction: true
+    allowSubmitFormAction: true
+    allowURIAction: true
+
+    #
+    # Stream filters.
+    #
+    allowASCII85Filter: true
+    allowASCIIHexFilter: true
+    allowCCITTFaxFilter: true
+    allowCryptFilter: true
+    allowDCTFilter: true
+    allowFlateFilter: true
+    allowJBIG2Filter: true
+    allowJPXFilter: true
+    allowLZWFilter: true
+    allowRunLengthFilter: true
+
+POLICY_STANDARD:
+
+    #
+    # General features.
+    #
+    allowParserErrors: false
+    allowAttachments: false
+    allowAcroForms: true
+    allowEncryption: true
+    allowFormCalc: true
+    allowJS: true
+    allowJSAtOpening: false
+    allowXFAForms: true
+
+    #
+    # Page annotations.
+    #
+    allowAnnotations: true
+    allow3DAnnotation: false
+    allowFileAttachmentAnnotation: false
+    allowMovieAnnotation: false
+    allowRichMediaAnnotation: false
+    allowScreenAnnotation: false
+    allowSoundAnnotation: false
+
+    #
+    # PDF Actions.
+    #
+    allowChainedActions: true
+    allowOpenAction: true
+    allowGoTo3DAction: false
+    allowGoToAction: true
+    allowGoToEAction: false
+    allowGoToRAction: false
+    allowImportDataAction: false
+    allowJSAction: true
+    allowLaunchAction: false
+    allowMovieAction: false
+    allowNamedAction: false
+    allowRenditionAction: false
+    allowRichMediaAction: false
+    allowSoundAction: false
+    allowSubmitFormAction: true
+    allowURIAction: true
+
+    #
+    # Stream filters.
+    #
+    allowASCII85Filter: false
+    allowASCIIHexFilter: false
+    allowCCITTFaxFilter: true
+    allowCryptFilter: true
+    allowDCTFilter: true
+    allowFlateFilter: true
+    allowJBIG2Filter: false
+    allowJPXFilter: false
+    allowLZWFilter: false
+    allowRunLengthFilter: false
+
+POLICY_STRONG:
+
+    #
+    # General features.
+    #
+    allowParserErrors: false
+    allowAttachments: false
+    allowAcroForms: false
+    allowEncryption: true
+    allowFormCalc: true
+    allowJS: false
+    allowJSAtOpening: false
+    allowXFAForms: false
+
+    #
+    # Page annotations.
+    #
+    allowAnnotations: true
+    allow3DAnnotation: false
+    allowFileAttachmentAnnotation: false
+    allowMovieAnnotation: false
+    allowRichMediaAnnotation: false
+    allowScreenAnnotation: false
+    allowSoundAnnotation: false
+
+    #
+    # PDF Actions.
+    #
+    allowChainedActions: false
+    allowOpenAction: true
+    allowGoTo3DAction: false
+    allowGoToAction: true
+    allowGoToEAction: false
+    allowGoToRAction: false
+    allowImportDataAction: false
+    allowJSAction: false
+    allowLaunchAction: false
+    allowMovieAction: false
+    allowNamedAction: false
+    allowRenditionAction: false
+    allowRichMediaAction: false
+    allowSoundAction: false
+    allowSubmitFormAction: false
+    allowURIAction: true
+
+    #
+    # Stream filters.
+    #
+    allowASCII85Filter: false
+    allowASCIIHexFilter: false
+    allowCCITTFaxFilter: false
+    allowCryptFilter: true
+    allowDCTFilter: true
+    allowFlateFilter: true
+    allowJBIG2Filter: false
+    allowJPXFilter: false
+    allowLZWFilter: false
+    allowRunLengthFilter: false
+
+POLICY_PARANOID:
+
+    #
+    # General features.
+    #
+    allowParserErrors: false
+    allowAttachments: false
+    allowAcroForms: false
+    allowEncryption: false
+    allowFormCalc: false
+    allowJS: false
+    allowJSAtOpening: false
+    allowXFAForms: false
+
+    #
+    # Page annotations.
+    #
+    allowAnnotations: true
+    allow3DAnnotation: false
+    allowFileAttachmentAnnotation: false
+    allowMovieAnnotation: false
+    allowRichMediaAnnotation: false
+    allowScreenAnnotation: false
+    allowSoundAnnotation: false
+
+    #
+    # PDF Actions.
+    #
+    allowChainedActions: false
+    allowOpenAction: false
+    allowGoTo3DAction: false
+    allowGoToAction: true
+    allowGoToEAction: false
+    allowGoToRAction: false
+    allowImportDataAction: false
+    allowJSAction: false
+    allowLaunchAction: false
+    allowMovieAction: false
+    allowNamedAction: false
+    allowRenditionAction: false
+    allowRichMediaAction: false
+    allowSoundAction: false
+    allowSubmitFormAction: false
+    allowURIAction: false
+
+    #
+    # Stream filters.
+    #
+    allowASCII85Filter: false
+    allowASCIIHexFilter: false
+    allowCCITTFaxFilter: false
+    allowCryptFilter: false
+    allowDCTFilter: true
+    allowFlateFilter: true
+    allowJBIG2Filter: false
+    allowJPXFilter: false
+    allowLZWFilter: false
+    allowRunLengthFilter: false

data/bin/pdf2pdfa

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+
+=begin
+
+= Info
+    Enforces a document to be rendered as PDF/A.
+    This will disable multimedia features and JavaScript execution in Adobe Reader.
+
+= License
+    Copyright (C) 2016  Guillaume Delugré.
+
+    Origami is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    Origami is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with Origami.  If not, see <http://www.gnu.org/licenses/>.
+
+=end
+
+begin
+    require 'origami'
+rescue LoadError
+    $: << File.join(__dir__, '../lib')
+    require 'origami'
+end
+include Origami
+
+require 'optparse'
+
+class OptParser
+    BANNER = <<USAGE
+Usage: #{$0} [<PDF-file>] [-o <output-file>]
+Enforces a document to be rendered as PDF/A.
+This will disable multimedia features and JavaScript execution in Adobe Reader.
+Bug reports or feature requests at: http://github.com/gdelugre/origami
+
+Options:
+USAGE
+
+    def self.parser(options)
+        OptionParser.new do |opts|
+            opts.banner = BANNER
+
+            opts.on("-o", "--output FILE", "Output PDF file (stdout by default)") do |o|
+                options[:output] = o
+            end
+
+            opts.on_tail("-h", "--help", "Show this message") do
+                puts opts
+                exit
+            end
+        end
+    end
+
+    def self.parse(args)
+        options =
+        {
+          output: STDOUT,
+        }
+
+        self.parser(options).parse!(args)
+
+        options
+    end
+end
+
+begin
+    @options = OptParser.parse(ARGV)
+
+    target = (ARGV.empty?) ? STDIN : ARGV.shift
+    params =
+    {
+        verbosity: Parser::VERBOSE_QUIET,
+    }
+
+    PDF.read(target, params).save(@options[:output], intent: 'PDF/A', noindent: true)
+
+rescue
+    abort "#{$!.class}: #{$!.message}"
+end