Llewellyn/Tomb
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/Tomb.git synced 2024-11-25 22:27:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

documentation update for a new release

Browse Source
This commit is contained in:
Jaromil 2022-11-14 11:46:10 +01:00
parent 5772d39e19
commit 6e8ef0a29a
3 changed files with 40 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
AUTHORS.md
View File

@ -2,11 +2,11 @@ Cryptsetup was originally written in 2004 by Jana Saout
LUKS extensions are written in 2006 by Clemens Fruhwirth LUKS extensions are written in 2006 by Clemens Fruhwirth
Tomb is written and maintained since 2007 by Denis Roio <J@dyne.org> Tomb is written and maintained since 2007 by [Denis "Jaromil" Roio](https://jaromil.dyne.org)
Tomb includes code and advices by Anathema, Boyska, Hellekin O. Wolf, Tomb includes code and advices by Anathema, Boyska, Hellekin O. Wolf,
Daniel Rodriguez, Parazyd, Alexandre Pujol, AitorATuin, Narrat and Daniel Rodriguez, Parazyd, Alexandre Pujol, AitorATuin, Narrat, Artur
Artur Malimonov. Malimonov and Chris Vogel.
The 'gtomb' GUI based on Zenity is written by Parazyd. The 'gtomb' GUI based on Zenity is written by Parazyd.
@ -38,6 +38,5 @@ 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
fixes contributed by AitorATuin. fixes contributed by AitorATuin.
Tomb developers can be contacted via GitHub issues on Some of the Tomb developers can be contacted via [GitHub discussions](https://github.com/dyne/Tomb/discussions)
https://www.github.com/dyne/Tomb or over IRC https://irc.dyne.org or over Telegram via the [Dyne.org Chat Channel](https://t.me/dyne_chat).
channel **#dyne** (or directly over port 9999 with SSL)

15
ChangeLog.md
View File

@ -1,5 +1,20 @@
# Tomb ChangeLog # Tomb ChangeLog
## 3.0
### Nov 2022
This release adds optional support for Argon2 KDF brute-force
protection and introduces support for doas as an alternative to sudo
for priviledge escalation. It also improves support for BTRFS
formatted Tombs, adds zram detection as swap memory, updates
documentation and translations and cleans up the script code. There
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

40
README.md
View File

@ -25,15 +25,14 @@ For the instructions on how to get started using Tomb, see [INSTALL](INSTALL.md)
![tomb's logo](https://github.com/dyne/Tomb/blob/master/extras/images/monmort.png) ![tomb's logo](https://github.com/dyne/Tomb/blob/master/extras/images/monmort.png)
[![Build Status](https://travis-ci.org/dyne/Tomb.svg?branch=master)](https://travis-ci.org/dyne/Tomb) - Linux Tomb [![Build Status](https://github.com/dyne/tomb/actions/workflows/ci.yml/badge.svg)](https://github.com/dyne/Tomb/actions)
- Portable Tomb [![Build Status](https://github.com/dyne/tomb/actions/workflows/portable.yml/badge.svg)](https://github.com/dyne/Tomb/actions)
Also [watch the Tomb3 repository](/dyne/tomb3) where a complete rewrite for **fully portable Tomb3 volumes** is taking place.
# What is Tomb, the crypto undertaker? # What is Tomb, the crypto undertaker?
Tomb aims to be a free and open source system for easy encryption and Tomb is a free and open source system for easy encryption and backup
backup of personal files, written in code that is easy to review and of personal files, written in code that is easy to review and links
links well reliable GNU/Linux components. well reliable GNU/Linux components.
Tomb's ambition is to improve safety by way of: Tomb's ambition is to improve safety by way of:
@ -41,11 +40,14 @@ Tomb's ambition is to improve safety by way of:
- facilitation of good practices, i.e: key/storage physical separation - facilitation of good practices, i.e: key/storage physical separation
- adoption of a few standard and well tested implementations. - adoption of a few standard and well tested implementations.
At present, Tomb consists of a simple shell script (Zsh) using At present, Linux Tomb consists of a simple shell script (Zsh) using
standard filesystem tools (GNU) and the cryptographic API of the Linux standard filesystem tools (GNU) and the cryptographic API of the Linux
kernel (cryptsetup and LUKS). Tomb 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:
@ -120,10 +122,10 @@ or if you are in a hurry
# What is this for, exactly? # What is this for, exactly?
This tool can be used to dig .tomb files (LUKS volumes), forge keys This tool can be used to dig .tomb files, forge keys protected by a
protected by a password (GnuPG encryption) and use the keys to lock password and use the keys to lock the tombs. Tombs are like single
the tombs. Tombs are like single files whose contents are inaccessible files whose contents are inaccessible in the absence of the key they
in the absence of the key they were locked with and its password. were locked with and its password.
Once open, the tombs are just like normal folders and can contain Once open, the tombs are just like normal folders and can contain
different files, plus they offer advanced functionalities like bind different files, plus they offer advanced functionalities like bind
@ -197,6 +199,8 @@ 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 starting from the
Windows 11 release since that supports mounting loopback volumes. 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
These auxiliary applications are found in the extras/ subdirectory of These auxiliary applications are found in the extras/ subdirectory of
@ -215,15 +219,14 @@ distributed Tomb's sourcecode:
The following applications are not included in Tomb's distributed The following applications are not included in Tomb's distributed
sourcecode, but are known and tested to be compatible with Tomb: sourcecode, but are known and tested to be compatible with Tomb:
- [pass-tomb](https://github.com/roddhjav/pass-tomb) is a console based wrapper of the excellent password keeping program [pass](https://www.passwordstore.org) that helps to keep the whole tree of password encrypted inside a tomb. It is written in Bash.
- [Secrets](https://secrets.dyne.org) is a software that can be operated on-line and on-site to split a Tomb key in shares to be distributed to peers: some of them have to agree to combine back the shares in order to retrieve the key. - [Secrets](https://secrets.dyne.org) is a software that can be operated on-line and on-site to split a Tomb key in shares to be distributed to peers: some of them have to agree to combine back the shares in order to retrieve the key.
- [zuluCrypt](https://mhogomchungu.github.io/zuluCrypt/) is a graphical application to manage various types of encrypted volumes on GNU/Linux, among them also Tombs, written in C++. - [zuluCrypt](https://mhogomchungu.github.io/zuluCrypt/) is a graphical application to manage various types of encrypted volumes on GNU/Linux, among them also Tombs, written in C++.
- [Mausoleum](https://github.com/mandeep/Mausoleum) is a graphical interface to facilitate the creation and management of tombs, written in Python. - [Mausoleum](https://github.com/mandeep/Mausoleum) is a graphical interface to facilitate the creation and management of tombs, written in Python.
- [pass-tomb](https://github.com/roddhjav/pass-tomb) is a console based wrapper of the excellent password keeping program [pass](https://www.passwordstore.org) that helps to keep the whole tree of password encrypted inside a tomb. It is written in Bash.
If you are writing a project supporting Tomb volumes or wrapping Tomb, let us know! If you are writing a project supporting Tomb volumes or wrapping Tomb, let us know!
@ -288,13 +291,10 @@ If you plan to commit code into Tomb, please keep in mind this is a
minimalist tool and its code should be readable. Guidelines on the minimalist tool and its code should be readable. Guidelines on the
coding style are illustrated in [doc/HACKING.txt](doc/HACKING.txt). coding style are illustrated in [doc/HACKING.txt](doc/HACKING.txt).
Tomb's developers can be contacted using the issues on GitHub or over
IRC on https://irc.dyne.org channel **#dyne** (or direct port 9999 SSL)
# Licensing # Licensing
Tomb is Copyright (C) 2007-2021 by the Dyne.org Foundation and Tomb is Copyright (C) 2007-2022 by the Dyne.org Foundation and
maintained by Denis Roio <J@dyne.org>. More information on all maintained by [Jaromil](/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