Skip to content

Latest commit

 

History

History
114 lines (90 loc) · 9.22 KB

README.org

File metadata and controls

114 lines (90 loc) · 9.22 KB
Raw

README

What is this?

Overview

Entrusted is a document sanitizer tool that converts ”potentially suspicious files” into safe PDFs:

  • This is achieved by removing active content inside a “lightweight sandbox” (containerization)
  • Please note that this tool doesn’t provide absolute security guarantees

Unless you use the live CD, you MUST install either Docker or Podman prior launching the program. On Mac OS, you need more specifically Docker Desktop.

./images/screenshot.png

Youtube presentation and PDF slides about Entrusted.

Features

Key features include the following:

  • Files are processed inside a “sandbox” (disabled internet connectivity)
  • The application is multilingual (English and French translations for now)
  • Password-protected files are supported (known Office document formats and PDF files)
  • The sanitization of huge documents is frictionless
  • Optionally, OCR can be applied to PDF results (selectable and searchable text)
  • Files can be converted in batch (sequentially)
  • PDF result quality is configurable (processing speed v.s. better looking output)
  • A Web server with a user interface is available and can act as an “online service”
  • The live CD provides both enhanced security and configuration convenience

Use-cases

Do you identify yourself in one of the situations below?

  • I suspect that my computer might have been infected few times after opening documents
  • I “acquire” documents from file sharing applications or the Dark Web
  • I often need to open email attachments from unfamiliar senders
  • I download files from “potentially non-trusted websites”

Supported files

The following file types can be processed with Entrusted:

  • PDF files (.pdf)
  • Text Documents (.rtf, .doc, .docx, .odt)
  • Presentations (.ppt, .pptx, .odp)
  • Spreadsheets (.xls, .xlsx, .ods)
  • Images (.jpg, .jpeg, .gif, .png, .tif, .tiff)
  • OpenDocument Drawing Document Format (.odg)

What is available?

User interfaces

There are three user interfaces (Desktop and Command-Line, Web):

  • The graphical Desktop interface is recommended for most users
  • If you prefer the Web interface, please download the live CD for an out-of-the-box user experience:
    • You can run the live CD with tools such as QEMU, VirtualBox, Hyper-V, VmWare, Parallels, etc.
    • The Web interface can be accessed at the address http://localhost:13000
    • Replace localhost by the IP address of your virtual machine in the above-mentioned link
    • You might need to map or forward port 13000 depending on your virtualization solution network settings.

Downloads

Please visit the releases page for downloads (64-bit: amd64/x86_64 and aarch64/arm64).

  • aarch64 (i.e., arm64) builds are not yet available for Windows
  • For Linux, when in doubt, pick the glibc file, unless you’re sure about your system
  • Ignore any warnings about trusting the application under Windows or Mac OS, the binaries are not signed
    • Notes for Mac OS
    • Notes for Windows: Click “Ignore” or “Run”, if you get a warning dialog.
“System”ArtifactDescription
Linuxentrusted-<version>-linux-amd64-glibc.debDesktop and CLI clients (Debian-Like distros)
entrusted-<version>-linux-amd64-glibc.rpmDesktop and CLI clients (Redhat-Like distros)
entrusted-<version>-linux-amd64-glibc.tarArchive with all programs
entrusted-<version>-linux-amd64-musl.tarArchive with all programs (musl libc)
entrusted-<version>-linux-aarch64-glibc.debDesktop and CLI clients (Debian-Like distros)
entrusted-<version>-linux-aarch64-glibc.rpmDesktop and CLI clients (Redhat-Like distros)
entrusted-<version>-linux-aarch64-glibc.tarArchive with all programs
entrusted-<version>-linux-aarch64-musl.tarArchive with all programs (musl libc)
Mac OSentrusted-<version>-macos-amd64.dmgInstaller with the Desktop and CLI clients
entrusted-<version>-macos-amd64.zipArchive with all programs
entrusted-<version>-macos-aarch64.dmgInstaller with the Desktop and CLI clients
entrusted-<version>-macos-aarch64.zipArchive with all programs
Windowsentrusted-<version>-windows-amd64.exeInstaller with the Desktop and CLI clients
entrusted-<version>-windows-amd64.zipArchive with all programs
Live CDentrusted-<version>-livecd-amd64.isoWeb interface Live CD for virtual machines
entrusted-<version>-livecd-aarch64.isoWeb interface Live CD for virtual machines

What is required?

It is assumed that you can allocate at least 1 GB of memory for document processing.

  • Operating System: Linux, Mac OS or Windows
  • Container Runtime: Podman (Linux) or Docker (Linux, Mac OS, Windows). On Mac OS, you need more specifically Docker Desktop.

Conversions will fail if the container solution is not running or available in your “PATH settings”:

  • The tool doesn’t attempt to modify software on your machine (install or change programs)
  • The tool doesn’t attempt to manage software on your machine (start or stop services)

Few references