# Overview

## Overview

DVault is designed to make protecting (encrypting) files and directories simple and secure.

When protecting a file or directory DVault uses the terms 'lock' and 'unlock' to indicate the process of protecting (locking) a file and opening (unlocking) a file.

When you lock a file or directory with DVault it creates a single self contained 'vault' file.

DVault uses a passphrase to protected files, however you only need your passphrase when opening a vault.

DVault works as a simple interactive command line tool but is also designed to be called by other scripts.

DVault supports Linux, Mac OSX and Windows. 

{% hint style="info" %}
For those interested; the gory technical details about RSA and AES are covered below.
{% endhint %}

## Sponsored by OnePub

Help support DVault by supporting [OnePub](https://onepub.dev/drive/d035745b-b7b2-4f46-8807-751e788af906), the private Dart repository. 

OnePub allows you to privately share Dart packages across your Team and with your customers..

Try it for free and publish your first private package in seconds.

| ![](https://2532444128-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MJ63zuM9PMrKarwtVH0%2Fuploads%2FvtuysY31ZC9h5IbpHgY2%2Fimage.png?alt=media\&token=861bda2a-2038-4862-a475-c64eb13d712d) | <p>Publish a private package in five commands:</p><p><mark style="color:green;"><code>dart pub global activate onepub</code></mark></p><p><mark style="color:green;"><code>onepub login</code></mark></p><p><mark style="color:green;"><code>cd \<my package></code></mark></p><p><mark style="color:green;"><code>onepub pub private</code></mark> </p><p><mark style="color:green;"><code>dart pub publish</code></mark></p> |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

### Locking a file

When you lock a file with DVault the original file is deleted and replaced with a new `.vault` file.

e.g. important.txt becomes important.txt.vault.

When you unlock a file the vault is deleted and your original file is restored.

e.g. important.txt.vault becomes important.txt

#### Initialise DVault

After installing DVault you need to run a one time initialisation process:

```
dvault init
  Enter passphrase: ******
  Confirm passphrase: ***** 
  Generating keys, this make take a couple of minutes.
  Generating: ......
  Keys saved to ~/.dvault
```

#### Lock the file

To lock a file:

```
dvault lock important.txt
  Stored and locked in important.txt.vault.
```

#### Unlock the file

```
dvault unlock important.txt.vault
  Passphrase: ****** 
  Unlocked to important.txt
```

As a `.vault` file contains the original keys the vault can be copied to any machine and provided you know the passphrase you can always unlock the file.

### Send a vault to a friend

If you want to send an vault to a friend you can create a vault using a single use passphrase which you can share with a friend.

```
dvault share important.txt
   Looks like you are going to share a vault with a friend.
   When prompted enter a passphrase that you can give to your friend.
   **** DO NOT USE YOUR NORMAL DVAULT PASSPHRASE ****
   Enter passphrase: *****
   Confirm passphrase: *****
   Stored and locked in important.txt.vault
   
   Call your friend and give them the passphase or send it to them via
   some other secure means. 
   **** DO NOT EMAIL OR TWEET THE PASSPHRASE! ****
   Email 'imporantant.txt.vault to your friend'
   
   You may also want to send them the following instruction.
   
   Please find the attached .vault file which contains the documents discussed.
   To unlock the vault you will need to download and install DVault from
   https://github.com/noojee/dvault/wiki/Shared-Vault
   The above link also contains instructions on how to unlock the vault.
   I will ring with the required passphrase shortly.
```

##

##