Skip to main content

A Python 3 tool to explore, analyse, and disassemble PDF files

Project description

peepdf-3 - peepdf for Python 3

peepdf-3 is a Python 3 tool to explore PDF files in order to find out if the file can be harmful or not. The aim of this tool is to provide all the necessary components that a security researcher could need in a PDF analysis without using 3 or 4 tools to make all the tasks.

With peepdf it's possible to see all the objects in the document showing the suspicious elements, supports all the most used filters and encodings, it can parse different versions of a file, object streams and encrypted files. With the installation of STPyV8 and Pylibemu it provides Javascript and shellcode analysis wrappers too. Apart of this it's able to create new PDF files and to modify/obfuscate existent ones.

As of version 3.0.0, peepdf-3 no longer includes pylibemu as a requirement in order to use peepdf-3 on Windows systems. However, all functionality of libemu, pylibemu, and sctest still exist, and will function on Linux systems.

PyPI - Version

Features

The main functionalities of peepdf are the following:

Analysis:

  • Decodings: hexadecimal, octal, name objects
  • More used filters
  • References in objects and where an object is referenced
  • Strings search (including streams)
  • Physical structure (offsets)
  • Logical tree structure
  • Metadata
  • Modifications between versions (changelog)
  • Compressed objects (object streams)
  • Analysis and modification of Javascript (STPyV8): unescape, replace, join
  • Shellcode analysis (Libemu python wrapper, pylibemu)
  • Variables (set command)
  • Extraction of old versions of the document
  • Easy extraction of objects, Javascript code, shellcodes (>, >>, $>, $>>)
  • Checking hashes on VirusTotal
  • Detection of common encryption methods
  • Output of XML and JSON data

Creation/Modification:

  • Basic PDF creation
  • Creation of PDF with Javascript executed wen the document is opened
  • Creation of object streams to compress objects
  • Embedded PDFs
  • Strings and names obfuscation
  • Malformed PDF output: without endobj, garbage in the header, bad header...
  • Filters modification
  • Objects modification

Ways to use peepdf:

  • Basic execution
  • Interactive console
  • Script mode
  • JSON Output
  • XML Output
  • VirusTotal analysis
  • OCR

TODO:

  • Embedded PDFs analysis
  • Improving automatic Javascript analysis
  • GUI

Related articles:

Included in:

Installation

You can install / use peepdf-3 via these methods:

  • From PyPI via pip - python3 -m pip install peepdf-3
  • From GitHub via pip and git - python3 -m pip install git+https://github.com/digitalsleuth/peepdf-3.git
  • Clone the GitHub repo, cd into the peepdf-3 folder, chmod +x peepdf.py and ./peepdf.py

Current Known Limitations

  • As of version 3.0.0, there are no limitations with the installation and usage of peepdf-3, as the hard requirement for pylibemu has been lifted. The functionality still remains for Linux systems.

Notes

  • The current maintainer of this project (Corey Forman - digitalsleuth), does not receive any funding for, and is not currently seeking any monetary contributions for this work. If you are willing to provide assistance, programming contributions, and feedback, that is always welcome.
  • As this project originated with Jose Miguel Esparza, I will continue to leave his sentiments, and PayPal link, below to acknowledge his original product.

You are free to contribute with feedback, bugs, patches, etc. Any help is welcome. Also, if you really enjoy using peepdf, you think it is worth it and you feel really generous today you can donate some bucks to the project ;) Thanks!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

peepdf_3-5.1.1.tar.gz (135.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

peepdf_3-5.1.1-py3-none-any.whl (140.8 kB view details)

Uploaded Python 3

File details

Details for the file peepdf_3-5.1.1.tar.gz.

File metadata

  • Download URL: peepdf_3-5.1.1.tar.gz
  • Upload date:
  • Size: 135.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.12

File hashes

Hashes for peepdf_3-5.1.1.tar.gz
Algorithm Hash digest
SHA256 7da998b79e7b987ece45ee3ce20a855cfa3fb66966791b8837acd9097965dd93
MD5 9c6327facc00bd58a531be93f14d84a9
BLAKE2b-256 5986fd5be40d9b190e698c561440be4eb7ba251db985c7e199177b01835a45b3

See more details on using hashes here.

File details

Details for the file peepdf_3-5.1.1-py3-none-any.whl.

File metadata

  • Download URL: peepdf_3-5.1.1-py3-none-any.whl
  • Upload date:
  • Size: 140.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.12

File hashes

Hashes for peepdf_3-5.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9a79271fcd0c6b775ca28916eaba8116221d0b434f1e4a94f0f65dfff71e63b8
MD5 cb8f4fcf802c4671d5ccf53f1e6d5fb1
BLAKE2b-256 bf4fb9ce99e5939b20653a6c00273b534fc1dde7154a366d7193b51aa2a70daa

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page