Tomb/extras/portable/README.md

2.7 KiB

Portable Tomb :: the crypto undertaker runs everywhere

continuous integration tests badge test coverage status for portability

⚠️ WORK IN PROGRESS 🛠️

This is the portable version of Tomb

software by Dyne.org

Purpose

Portable tomb achieves direct interoperable access to tomb volumes between:

  • GNU base Linux (Ubuntu)
  • Busybox based Linux (Alpine)
  • MS/Windows using WSL2 (Ubuntu)
  • FreeBSD (WIP using libluksde)
  • Apple/OSX using MacFUSE

After some extensive testing during 2022, adoption of Veracrypt in portable Tomb has been dropped because of unreliability and bad performance.

Portable tomb stays as an experimental branch that aims to reduce dependencies and in particular uses only the POSIX sh interpreter.

Status

Portable tomb development is in progress and tracked via issues and the portable milestone.

Features

The following features will be implemented where possible:

  • mount bind (Linux only)
  • ps / slam
  • resize (pending investigation)
  • index & search (recoll based)
  • bury / exhume

Dependencies

  • FreeBSD: fusefs-libs3 fusefs-lkl e2fsprogs util-linux libluksde
  • Linux: fuse3 util-linux
  • crossplatform Veracrypt binaries console-only

Note on Veracrypt

The way upstream developers distribute Veracrypt is far from meeting our minimalist needs, but the console-only binary once installed has a few library dependencies and is all what we need.

I setup my own build and provide binary builds of Veracrypt v1.25.9 for download on Tomb's file repository for testing purposes.

Disclaimer

Tomb is Copyright (C) 2007-2023 by the Dyne.org Foundation and developed by Jaromil.

This source code is free software; you can redistribute it and/or modify it under the terms of the GNU Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

This source code 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. Please refer to the GNU Public License for more details.

You should have received a copy of the GNU Public License along with this source code; if not, write to: Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.