arc

README

Arc

Arc is a manager for your secrets made of arcd, a RESTful API server written in Go which exposes read and write primitives for encrypted records on disk

And arc, the client application implemented in html5 and javascript, which runs in every html5 enabled browser and it is served by arcd itself.

Records are generated, encrypted and decrypted client side only (Arc relies on WebCrypto for its AES256 encryption and the PRNG) by arc, which offers an intuitive management system equipped with UI widgets including:

• Simple text inputs.
• Simple text areas.
• Custom file attachments (files are encrypted client side before being uploaded as binary records).
• A markdown editor area with preview and full screen mode.
• A password field with password strength estimation and a random password generator.

Elements can be created (with optional expiration dates), arranged and edited using arc and are stored on arcd safely.

TL;DR

The idea is to use the Arc as a single manager for your passwords, encrypted notes, files and -all the secret things here- while hosting arcd yourself on some spare hardware like a Raspberry Pi (a very portable setup with a Zero W model, or an USB Armory) or a real dedicated server and accessing arc from every device with a modern browser.

Usage

Binary release

You can find binary releases of Arc here.

From source

Download, install dependencies and compile the arcd server component:

git clone https://github.com/evilsocket/arc $GOPATH/src/github.com/evilsocket/arc
cd $GOPATH/src/github.com/evilsocket/arc/arcd
make vendor_get
make

Running

Copy the sample_config.json file to a new config.json file, customize it and run the arc web application:

./arcd -config config.json -app arc

The password field is the SHA256 checksum of your password, you can generate a new one with:

echo -n "your-new-password" | sha256sum

Browse http://localhost:8080/ and login with the credentials you specified in the config.json file.

Configuration

You will find a sample_config.json file inside the arcd folder of the project, this is the example configuration you need to customize the first time.

{
    "address": "127.0.0.1",
    "port": 8080,
    "username": "arc",
    "password": "404fcfb394d23199f6d95f1f36bd2beb6df8564f993f44517f6015fcd16101a9",
    "database": "~/arcdb",
    "token_duration": 60,
    "compression": true,
    "scheduler": {
        "enabled": true,
        "period": 10,
        "reports": {
            "enabled": false,
            "filter": [ "login_ok", "login_ko", "token_ko", "record_expired" ],
            "to": "youremail@gmail.com",
            "smtp":{
                "address": "smtp.gmail.com",
                "port": 587,
                "username": "youremail@gmail.com",
                "password": "your smtp password"
            }
        }
    },
    "backups": {
        "enabled": false,
        "period": 1800,
        "folder": "/some/backup/path/"
    },
    "tls": {
        "enabled": false,
        "certificate": "/some/certificate.pem",
        "key": "/some/key.pem"
    }
}

It is necessary to change only the username and password access parameters of Arc, while the others can be left to their default values.

Configuration	Description
address	IP address to bind the arcd server to.
port	TCP to bind the arcd server to.
username	API access username.
password	API access password sha256 hash.
database	Database root directory.
token_duration	Validity in minutes of a JWT API token after it's being generated.
compression	Enable or disable records compression.
scheduler.enabled	Enable or disable the server events scheduler.
scheduler.period	Time in seconds between every scheduler loop.
scheduler.reports.enabled	If true, events will be reported by email.
scheduler.reports.filter	Which type of events to report by email.
scheduler.reports.to	Destination email address.
scheduler.reports.smtp	SMTP server information.
backups.enabled	Enable automatic backups.
backups.period	Number of seconds between one backup and the next one.
backups.folder	Destination folder for the backup file.
tls.enabled	Run arcd on HTTPS.
tls.certificate	HTTPS certificate.
tls.key	HTTPS private key.

Export and import stores.

You can export stores and their encrypted records to a JSON file:

./arcd -config config.json -output ~/backup.json -export

Exported files can be later imported with:

./arcd -config config.json -import ~/backup.json

Bugs

Before opening an issue, please make sure it is not already part of a known bug.

License

Arc was made with ♥ by Simone Margaritelli and it is released under the GPL 3 license.