Skip to main content

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 complete the task.

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!

Metadata

Release files for peepdf-3 5.4.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for peepdf-3 5.4.1
File Size Uploaded
peepdf_3-5.4.1.tar.gz 151.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for peepdf-3 5.4.1
File Interpreter ABI Platform
peepdf_3-5.4.1-py3-none-any.whl Python 3 none any Details

Total release size: 309.4 kB

Release files / peepdf_3-5.4.1.tar.gz

Download URL peepdf_3-5.4.1.tar.gz
Size 151.4 kB
Tags Source
SHA-256 checksum
How to use checksums
03e4e36e6fddb42f036daf0c4f36345605826a3450c626feff8e7f394379c020
BLAKE2b-256 checksum
How to use checksums
313ed0be44ea5704ec56a6624893ad6a4062fc8f4958bab66a535804b038b932
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Release files / peepdf_3-5.4.1-py3-none-any.whl

Download URL peepdf_3-5.4.1-py3-none-any.whl
Size 158.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7143b00146979daaaaee043e443ed87d2d8a9ebf15209c0132a990580a3e7254
BLAKE2b-256 checksum
How to use checksums
a0ab4e5683e9dc8d717fae11b364a3c4b95284e712e750173b5413e30c60b2b0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Release history Release notifications | RSS feed

6.0.3

2 release files

6.0.2

2 release files

6.0.1

2 release files

6.0.0

2 release files

This release

5.4.1 This release

2 release files

5.4.0

2 release files

5.3.0

2 release files

5.2.0

2 release files

5.1.1

2 release files

5.1.0

2 release files

5.0.0

2 release files

4.1.0

2 release files

4.0.0

2 release files

3.0.3

2 release files

3.0.2

2 release files

3.0.1

2 release files

3.0.0

2 release files

2.3.0

2 release files

2.2.0

2 release files

2.1.0

2 release files

2.0.0

2 release files

1.0.10

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page