mirror of https://github.com/Llewellynvdm/Tomb.git
documentation update for release
long due, was ready in november 2022 and basically left unchanged at that stage, except the deprecation of veracrypt in the experimental portable branch, which is not included in the stable release.
This commit is contained in:
Jaromil
parent
58035cf14a
commit
51452e4e6a
17
AUTHORS.md
17
AUTHORS.md
|
|
@ -8,21 +8,22 @@ Tomb includes code and advices by Anathema, Boyska, Hellekin O. Wolf,
|
||||||
Daniel Rodriguez, Parazyd, Alexandre Pujol, AitorATuin, Narrat, Artur
|
Daniel Rodriguez, Parazyd, Alexandre Pujol, AitorATuin, Narrat, Artur
|
||||||
Malimonov and Chris Vogel.
|
Malimonov and Chris Vogel.
|
||||||
|
|
||||||
The 'gtomb' GUI based on Zenity is written by Parazyd.
|
The 'gtomb' GUI based on Zenity is written by Parazyd and Daniel Dias Rodrigues.
|
||||||
|
|
||||||
The Qt5 desktop tray GUI is written by Gianluca Montecchi.
|
The Qt5 desktop tray GUI is written by Gianluca Montecchi.
|
||||||
|
|
||||||
Python Tomb wrappers are contributed by Reiven and Boyska.
|
Python Tomb wrappers are contributed by Reiven and Boyska.
|
||||||
|
|
||||||
The Docker Tomb wrapper is contributed by Greg Tczap
|
The Docker Tomb wrapper is contributed by Greg Tczap and Jens Rischbieth.
|
||||||
|
|
||||||
Artwork is contributed by Jordi aka Mon Mort and Logan VanCuren.
|
Artwork is contributed by Jordi aka Mon Mort and Logan VanCuren.
|
||||||
|
|
||||||
Gettext internationalization and Spanish translation is contributed by
|
Gettext internationalization and Spanish translation is contributed by
|
||||||
Daniel Rodriguez. French translation by Hellekin and Roy Lockhart,
|
Daniel Rodriguez and Francisco Serrador. French translation by
|
||||||
Russian translation by fsLeg, German translation by Jerry Polfer,
|
Hellekin and Roy Lockhart, Russian translation by fsLeg and AHOHNMYC,
|
||||||
Italian translation by Massimiliano Augello and Swedish translation by
|
German translation by Jerry Polfer, Italian translation by
|
||||||
PLJ / Kosovoper.
|
Massimiliano Augello and Swedish translation by PLJ / Kosovoper,
|
||||||
|
general fixes contributed by Daniel Dias Rodrigues.
|
||||||
|
|
||||||
Testing, reviews and documentation contributed by Dreamer, Vlax,
|
Testing, reviews and documentation contributed by Dreamer, Vlax,
|
||||||
Shining the Translucent, Mancausoft, Asbesto Molesto, Nignux, TheJH,
|
Shining the Translucent, Mancausoft, Asbesto Molesto, Nignux, TheJH,
|
||||||
|
|
@ -31,8 +32,8 @@ Polfer, Jim Turner, Maxime Arthaud, RobertMX, mhogomchungu Mandeep
|
||||||
Bhutani, Emil Lundberg, Joel Montes de Oca, Armin Mesbah, Arusekk,
|
Bhutani, Emil Lundberg, Joel Montes de Oca, Armin Mesbah, Arusekk,
|
||||||
Stephan Schindel, Asbjørn Apeland, Victor Calvert, bjonnh, SargoDevel,
|
Stephan Schindel, Asbjørn Apeland, Victor Calvert, bjonnh, SargoDevel,
|
||||||
AitorATuin, Alexis Danizan, Sven Geuer, Greg Tczap, Aaron Janse, Mark
|
AitorATuin, Alexis Danizan, Sven Geuer, Greg Tczap, Aaron Janse, Mark
|
||||||
Mykkanen, Alexis Danizan, Steve Litt, James R, Matthieu Crapet and...
|
Mykkanen, Alexis Danizan, Steve Litt, James R, Matthieu Crapet, Selene
|
||||||
the Linux Action Show!
|
ToyKeeper, Valentin Heidelberg and... the Linux Action Show!
|
||||||
|
|
||||||
Tomb includes an implementation of the "Password-Based Key Derivation
|
Tomb includes an implementation of the "Password-Based Key Derivation
|
||||||
Function v2" based on GCrypt and written by Anthony Thyssen, with
|
Function v2" based on GCrypt and written by Anthony Thyssen, with
|
||||||
|
|
|
||||||
16
ChangeLog.md
16
ChangeLog.md
|
|
@ -1,19 +1,13 @@
|
||||||
# Tomb ChangeLog
|
# Tomb ChangeLog
|
||||||
|
|
||||||
## 3.0
|
## 2.10
|
||||||
### Nov 2022
|
### Sep 2023
|
||||||
|
|
||||||
This release adds optional support for Argon2 KDF brute-force
|
This release adds optional support for Argon2 KDF brute-force
|
||||||
protection and introduces support for doas as an alternative to sudo
|
protection and introduces support for doas as an alternative to sudo
|
||||||
for privilege escalation. It also improves support for BTRFS
|
for privilege escalation. It also improves support for BTRFS formatted
|
||||||
formatted Tombs, adds zram detection as swap memory, updates
|
Tombs, adds zram detection as swap memory, updates documentation and
|
||||||
documentation and translations and cleans up the script code. There
|
translations and cleans up the script code.
|
||||||
are no major changes nor bug fixes compared to the previous Tomb
|
|
||||||
version: the major version increase signals the beginning of a new
|
|
||||||
development course that goes beyond Linux Tomb and adds Portable Tomb
|
|
||||||
(WIP) as an alternative and more portable POSIX shell script using
|
|
||||||
Veracrypt for volume encryption.
|
|
||||||
|
|
||||||
|
|
||||||
## 2.9
|
## 2.9
|
||||||
### Jan 2021
|
### Jan 2021
|
||||||
|
|
|
||||||
16
README.md
16
README.md
|
|
@ -26,7 +26,7 @@ For the instructions on how to get started using Tomb, see [INSTALL](INSTALL.md)
|
||||||
|
|
||||||
|
|
||||||
[](https://github.com/dyne/Tomb/actions)
|
[](https://github.com/dyne/Tomb/actions)
|
||||||
[](https://github.com/dyne/Tomb/actions)
|
<!-- [](https://github.com/dyne/Tomb/actions) -->
|
||||||
|
|
||||||
# What is Tomb, the crypto undertaker?
|
# What is Tomb, the crypto undertaker?
|
||||||
|
|
||||||
|
|
@ -45,9 +45,6 @@ standard filesystem tools (GNU) and the cryptographic API of the Linux
|
||||||
kernel (cryptsetup and LUKS). It can also produce machine parsable
|
kernel (cryptsetup and LUKS). It can also produce machine parsable
|
||||||
output to facilitate its use inside graphical applications.
|
output to facilitate its use inside graphical applications.
|
||||||
|
|
||||||
Starting with the 3.0 release path, also a new [Portable Tomb](portable) script
|
|
||||||
is made available (under development) which works on more operating systems beyond Linux based, is written in POSIX shell, has less dependencies and features and is based on [Veracrypt](https://www.veracrypt.fr) instead of LUKS/cryptsetup.
|
|
||||||
|
|
||||||
# How does it work?
|
# How does it work?
|
||||||
|
|
||||||
To create a Tomb, do:
|
To create a Tomb, do:
|
||||||
|
|
@ -196,10 +193,9 @@ equivalent standards supported by the Linux kernel.
|
||||||
Tomb can be used in conjunction with some other software applications,
|
Tomb can be used in conjunction with some other software applications,
|
||||||
some are developed by Dyne.org, but some also by third parties.
|
some are developed by Dyne.org, but some also by third parties.
|
||||||
|
|
||||||
It works well inside the Windows Subsystem for Linux starting from the
|
It works well inside the Windows Subsystem for Linux (WSL2) starting
|
||||||
Windows 11 release since that supports mounting loopback volumes.
|
from the Windows 11 release since that supports mounting loopback
|
||||||
|
volumes.
|
||||||
Portable Tomb extends support to Apple/OSX systems and FreeBSD.
|
|
||||||
|
|
||||||
### Included extra applications
|
### Included extra applications
|
||||||
|
|
||||||
|
|
@ -293,8 +289,8 @@ coding style are illustrated in [doc/HACKING.txt](doc/HACKING.txt).
|
||||||
|
|
||||||
# Licensing
|
# Licensing
|
||||||
|
|
||||||
Tomb is Copyright (C) 2007-2022 by the Dyne.org Foundation and
|
Tomb is Copyright (C) 2007-2023 by the Dyne.org Foundation and
|
||||||
maintained by [Jaromil](/jaromil). More information on all
|
maintained by [Jaromil](https://github.com/jaromil). More information on all
|
||||||
the developers involved is found in the [AUTHORS](AUTHORS.md) file.
|
the developers involved is found in the [AUTHORS](AUTHORS.md) file.
|
||||||
|
|
||||||
This source code is free software; you can redistribute it and/or
|
This source code is free software; you can redistribute it and/or
|
||||||
|
|
|
||||||
|
|
@ -1,11 +1,11 @@
|
||||||
|
|
||||||
# Portable Tomb :: the crypto undertaker runs everywhere
|
# Portable Tomb :: the crypto undertaker runs everywhere
|
||||||
|
|
||||||
[](https://github.com/dyne/Tomb/actions) test coverage status for portability between Ubuntu-20 and FreeBSD-13.
|
[](https://github.com/dyne/Tomb/actions) test coverage status for portability
|
||||||
|
|
||||||
## ⚠️ WORK IN PROGRESS 🛠️
|
## ⚠️ WORK IN PROGRESS 🛠️
|
||||||
|
|
||||||
This is the portable version of [Tomb](https://github.com/dyne/tomb) using [Veracrypt](https://www.veracrypt.fr) in place of cryptsetup.
|
This is the portable version of [Tomb](https://github.com/dyne/tomb)
|
||||||
|
|
||||||
[](http://www.dyne.org)
|
[](http://www.dyne.org)
|
||||||
|
|
||||||
|
|
@ -13,12 +13,15 @@ This is the portable version of [Tomb](https://github.com/dyne/tomb) using [Vera
|
||||||
|
|
||||||
Portable tomb achieves direct **interoperable access to tomb volumes** between:
|
Portable tomb achieves direct **interoperable access to tomb volumes** between:
|
||||||
|
|
||||||
- GNU and Busybox Linux
|
- GNU base Linux (Ubuntu)
|
||||||
- MS/Windows using WSL2
|
- Busybox based Linux (Alpine)
|
||||||
- Apple/OSX using [MacFUSE](https://osxfuse.github.io/)
|
- MS/Windows using WSL2 (Ubuntu)
|
||||||
- FreeBSD
|
- FreeBSD (WIP using libluksde)
|
||||||
|
- ~~Apple/OSX using [MacFUSE](https://osxfuse.github.io/)~~
|
||||||
|
|
||||||
Portable tomb reduces dependencies and in particular uses only the **POSIX sh interpreter**.
|
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
|
# Status
|
||||||
|
|
||||||
|
|
@ -36,7 +39,7 @@ The following features will be implemented where possible:
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
- FreeBSD: `fusefs-libs3 fusefs-lkl e2fsprogs util-linux`
|
- FreeBSD: `fusefs-libs3 fusefs-lkl e2fsprogs util-linux libluksde`
|
||||||
- Linux: `fuse3 util-linux`
|
- Linux: `fuse3 util-linux`
|
||||||
- crossplatform [Veracrypt binaries](https://files.dyne.org/tomb3/third-party) console-only
|
- crossplatform [Veracrypt binaries](https://files.dyne.org/tomb3/third-party) console-only
|
||||||
|
|
||||||
|
|
@ -48,7 +51,7 @@ I setup [my own build](https://github.com/jaromil/veracrypt) and provide binary
|
||||||
|
|
||||||
# Disclaimer
|
# Disclaimer
|
||||||
|
|
||||||
Tomb is Copyright (C) 2007-2022 by the Dyne.org Foundation and
|
Tomb is Copyright (C) 2007-2023 by the Dyne.org Foundation and
|
||||||
developed by [Jaromil](https://github.com/jaromil).
|
developed by [Jaromil](https://github.com/jaromil).
|
||||||
|
|
||||||
This source code is free software; you can redistribute it and/or
|
This source code is free software; you can redistribute it and/or
|
||||||
|
|
|
||||||
4
tomb
4
tomb
|
|
@ -7,7 +7,7 @@
|
||||||
|
|
||||||
# {{{ License
|
# {{{ License
|
||||||
|
|
||||||
# Copyright (C) 2007-2022 Dyne.org Foundation
|
# Copyright (C) 2007-2023 Dyne.org Foundation
|
||||||
#
|
#
|
||||||
# Tomb is designed, written and maintained by Denis Roio <jaromil@dyne.org>
|
# Tomb is designed, written and maintained by Denis Roio <jaromil@dyne.org>
|
||||||
#
|
#
|
||||||
|
|
@ -31,7 +31,7 @@
|
||||||
# {{{ Global variables
|
# {{{ Global variables
|
||||||
|
|
||||||
typeset VERSION="2.10.0"
|
typeset VERSION="2.10.0"
|
||||||
typeset DATE="Feb/2022"
|
typeset DATE="Sep/2023"
|
||||||
typeset TOMBEXEC=$0
|
typeset TOMBEXEC=$0
|
||||||
typeset TMPDIR=${${TMPPREFIX%/*}:-/tmp}
|
typeset TMPDIR=${${TMPPREFIX%/*}:-/tmp}
|
||||||
# TODO: configure which tmp dir to use from a cli flag
|
# TODO: configure which tmp dir to use from a cli flag
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue