origami 1.2.7 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d17b0e4071c2342bd02ad39ac239edc3e185296c
-  data.tar.gz: ed34fe83604f52063e0340b06e95bce6a2f2c801
+  metadata.gz: ce1a44a58ce5b5e21a3279fda0f8195b10820eb7
+  data.tar.gz: d47ccde08ad05ece6b5008fcbbf19de9916709d9
 SHA512:
-  metadata.gz: 5332359f279fb3e88d28229f1bbd9b361aaeb84724ce3682d296d67b9d1c729c2c8da288a644add7109f7090692dcc669706e907731a308c13f635931c43dea3
-  data.tar.gz: 1fe6ceb2f9cfff14bd15018bc1c965c43ad01e96d46de67538d58c48d9d8a9c97a7dc9b520aeb9b1e2caa2d9958f3f741406a90d4f7f4ee90e9b01d0f9198e89
+  metadata.gz: 064c8a4052fb0a0b471bccb62351be31f00bd6362ed615affb31b0230c0d05b3c35819d7c69576b4c5ccfb203d3eab4187f4aad4b490003a88193c22f7ba377d
+  data.tar.gz: 8e6ee0137acfd94f3bb569f0dc6614c59e5aba05ef80a815f241a3b0309b5f8d200a7ffbe40955ac805ad4c7143c1f6709d4f014e3e8ad3afbd60fb6ab51526e

data/CHANGELOG.md

@@ -0,0 +1,66 @@
+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/README.md

@@ -0,0 +1,112 @@
+Origami
+=====
+[![Gem Version](https://badge.fury.io/rb/origami.svg)](http://rubygems.org/gems/origami)
+
+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:
+
+* [Gtk2][ruby-gtk2] for running the GUI interface
+* [therubyracer][the-ruby-racer] for JavaScript emulation of PDF scripts
+
+[ruby-gtk2]: https://rubygems.org/gems/gtk2
+[the-ruby-racer]: https://rubygems.org/gems/therubyracer
+
+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 = 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 = 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 = PDF.new
+
+pdf.append_page
+pdf.pages.first.write "Hello", size: 30
+
+pdf.save("example.pdf")
+
+# Another way of doing it
+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.
+* [pdfwalker](bin/pdfwalker): A graphical interface to dig into the contents of a PDF document.
+
+
+License
+-------
+
+Origami is distributed under the [LGPL](COPYING.LESSER) license, except for the graphical interface which is distributed under the [GPL](bin/gui/COPYING) license.
+
+Copyright © 2016 Guillaume Delugré.

data/bin/config/pdfcop.conf.yml

@@ -1,237 +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_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
+    #
+    # 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