Commit 2cc4d532 authored by Arie Peterson's avatar Arie Peterson 🐚
Browse files

Switch new consideration docs to rst layout

parent 9c1a74ab
# Security considerations
Cryptops implements full-disk encryption for virtual private servers.
See [here](Considerations.md).
# Usage
All documentation can be found on
[the website](https://cryptops.com).
```sh
cryptops-api --root-device=DEV --crypt-name=LABEL [--notify-command=COMMAND]
```
* The `--root-device=DEV` option is mandatory. `DEV` should be the root device
of the machine, like `/dev/sda` or `/dev/xvda`.
When the root device is still unencrypted (for example when starting
cryptops-api for the first time), this should be an unpartitioned device,
with the file system spanning the whole device.
As part of the encryption process, this device will be partitioned and the
encrypted contents will be stored on the second partition, but DEV should
still point to the whole device, as before.
* The `--crypt-name=LABEL` option is mandatory. `LABEL` will be used by
cryptsetup to name the encrypted volume. This will be visible to the operating
system, as the decrypted root disk is available at `/dev/mapper/LABEL`.
* The `--notify-command=COMMAND` option is optional. The given `COMMAND` will be
run whenever cryptops-api detects that the root device needs the user to enter
their password to continue the booting process. You can use this to notify the
user of this situation.
In particular, please read the
[security considerations](https://cryptops.com/considerations.html).
# Considerations
Considerations
==============
## Possible reasons to use cryptops
Possible reasons to use Cryptops
--------------------------------
* You want to make it harder for the hoster's employees to casually view your
data.
data.
* You trust your hoster now, but you want to have an easy way to cut off their
access to your data – maybe when they change owners, or when you anticipate that
they are forced by some authority to grant access to your data.
access to your data – maybe when they change owners, or when you anticipate
that they are forced by some authority to grant access to your data.
* You want your data to be safe in case the hosters disks get stolen, or
discarded without shredding.
## Invalid reasons to use cryptops
Invalid reasons to use Cryptops
-------------------------------
* You don't trust your hoster, or you fear that they may be forced to grant
access to your data without a timely warning. If your hoster or a powerful
third party really wants to view your data, they could
* install a modified version of cryptops that doesn't really encrypt;
access to your data without a timely warning. If your hoster or a powerful
third party really wants to view your data, they could
* install a modified version of Cryptops that doesn't really encrypt;
* man-in-the-middle your first ssh connection to the server running in the
initrd, capturing your encryption password when you first enter it;
initrd, capturing your encryption password when you first enter it;
* access your decrypted data in memory while your vps is active; etc.
It is very hard to prevent someone who has physical access to your (running)
vps from reading your data, and cryptops does not pretend to do so.
vps from reading your data, and Cryptops does not pretend to do so.
## Possible reasons to not use cryptops
Possible reasons to not use Cryptops
------------------------------------
* It increases the chance of data loss: if you forget or lose your encryption
password, a single reboot of your vps (for whatever reason) renders your data
irrecoverably lost.
password, a single reboot of your vps (for whatever reason) renders your data
irrecoverably lost.
* It can increase downtime of your vps: whenever your vps reboots, you need to
become aware of this (though we have a customisable hook to notify you of this
situation), connect to the vps, and enter your encryption password; only then
can the boot process of the vps continue. All this time the service provided by
your vps is not running.
become aware of this (though we have a customisable hook to notify you of this
situation), connect to the vps, and enter your encryption password; only then
can the boot process of the vps continue. All this time the service provided
by your vps is not running.
* You may not need full-disk encryption of your vps: depending on the software
running on your vps, it could be easier to encrypt only some data directories.
On the other hand, it is easy to overlook some sensitive data stored in
configuration, cache files, temporary files, etc.
running on your vps, it could be easier to encrypt only some data directories.
On the other hand, it is easy to overlook some sensitive data stored in
configuration, cache files, temporary files, etc.
......@@ -6,7 +6,7 @@
CryptOps: Moving to a world with encrypted VPSs only
====================================================
Full disk encryption on Virtual Private Servers
Full-disk encryption on Virtual Private Servers
-----------------------------------------------
These days, data storage using the "cloud" or virtual private servers (VPSs) on
......@@ -45,8 +45,9 @@ Find the code at `<https://code.greenhost.net/open/cryptops>`_ and an example in
:maxdepth: 2
:caption: Contents:
readme.md
api_documentation.rst
considerations
usage
api_documentation
......
../README.md
\ No newline at end of file
Usage
=====
::
cryptops-api --root-device=DEV --crypt-name=LABEL [--notify-command=COMMAND]
* The ``--root-device=DEV`` option is mandatory. ``DEV`` should be the root device
of the machine, like ``/dev/sda`` or ``/dev/xvda``.
When the root device is still unencrypted (for example when starting
cryptops-api for the first time), this should be an unpartitioned device,
with the file system spanning the whole device.
As part of the encryption process, this device will be partitioned and the
encrypted contents will be stored on the second partition, but DEV should
still point to the whole device, as before.
* The ``--crypt-name=LABEL`` option is mandatory. ``LABEL`` will be used by
cryptsetup to name the encrypted volume. This will be visible to the operating
system, as the decrypted root disk is available at ``/dev/mapper/LABEL``.
* The ``--notify-command=COMMAND`` option is optional. The given ``COMMAND`` will be
run whenever cryptops-api detects that the root device needs the user to enter
their password to continue the booting process. You can use this to notify the
user of this situation.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment