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, and arc
, the client application implemented in HTML5 and javascript, which runs in every modern browser and it is served by arcd
itself.
Records are generated, encrypted and decrypted client side only by arc
(with AES256, using 10000 iterations for the PBKDF2 key derivation function, everything WebCrypto based ), 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 HTML editor with preview and full screen mode.
- A password field with password strength estimation and a random password generator.
- Custom lists.
- Bitcoin wallet address with auto updating balance.
- Manager for Time-based One-time Password Algorithm (TOTP) codes as per the TOTP RFC Draft. This component produces the same codes as the Google Authenticator app and can be used for 2FA.
Elements can be created (with optional expiration dates), arranged and edited using arc
and are stored on arcd
as AES256 encrypted (and compressed) raw data.
Ideally arcd
should run on a dedicated portable hardware like a Raspberry Pi Zero, for instance it is possible to simply access it via Bluetooth and a modern browser once configured btnap, but precompiled versions are available for several operating systems and architectures (including ARM, ARM64 and MIPS) therefore Arc can run on pretty much everything with a CPU, from your smartphone, your router, your Mac or your Windows computer. As a rule of thumb, the more isolated the hardware is, the better.
The idea is to use Arc as a single storage and manager for your passwords, encrypted notes, files and -all the secret things here-
.
You can find binary releases of Arc here, if instead you want to build it from source, make sure you have Go >= 1.8 installed and configured correctly, then clone this repository, install the 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
Once you either extracted the release archive or compiled it yourself, copy sample_config.json
to a new config.json
file and customize it. The most important fields to change are the username
and the password
, which is the SHA256 checksum of the authentication password you want to use, you can generate a new one with:
echo -n "your-new-password" | sha256sum
Once everything is ready, youn can finally start the arcd
server:
./arcd -config config.json -app arc
Now browse https://localhost:8443/
( or the address and port you configured ) and login with the configured credentials (make sure to add the generated HTTPS certificate as an exception in your browser).
NOTE
Other than the username and the password, during login you need to specify an additional encryption key. This second key is not used to login to the system itself but to encrypt and decrypt your records client side. You can specify different keys each time you login, as long as you remember which key you used to encrypt which record :)
This is the example configuration file you need to customize the first time.
{
"address": "127.0.0.1",
"port": 8443,
"certificate": "/some/certificate.pem",
"key": "/some/key.pem",
"username": "arc",
"password": "404fcfb394d23199f6d95f1f36bd2beb6df8564f993f44517f6015fcd16101a9",
"database": "~/arcdb",
"token_duration": 60,
"compression": true,
"scheduler": {
"enabled": true,
"period": 10,
"reports": {
"enabled": false,
"rate_limit": 60,
"filter": [ "login_ok", "login_ko", "token_ko", "update", "record_expired" ],
"to": "youremail@gmail.com",
"smtp":{
"address": "smtp.gmail.com",
"port": 587,
"username": "youremail@gmail.com",
"password": "your smtp password"
},
"pgp": {
"enabled": true,
"keys":{
"private": "~/server.key",
"public": "~/my.public.key"
}
}
}
},
"backups": {
"enabled": false,
"period": 1800,
"folder": "/some/backup/path/"
}
}
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. |
certificate | HTTPS certificate PEM file (if it does not exist, it will be automatically generated). |
key | HTTPS private key PEM file (if it does not exist, it will be automatically generated). |
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 | If true, records bigger than 1024 bytes will be asynchronously gzipped and served as compressed streams to the client. |
scheduler.enabled | Enable or disable the server events scheduler (if you disable this, bye bye notifications and records expiration). |
scheduler.period | Time in seconds between every scheduler loop. |
scheduler.reports.enabled | If true, events will be reported by email. |
scheduler.reports.rate_limit | If two events of the same type are triggered in less than this number of seconds between one each other, the newest will not be notified 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. |
scheduler.reports.pgp.enabled | If true, email notifications will be encrypted with PGP. |
scheduler.reports.pgp.keys.private | Path of the private key file to use to encrypt emails, if not found or empty it will be automatically generated by arcd . |
scheduler.reports.pgp.keys.public | Path of the PGP public key of the email notifications recipient. |
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. |
Different type of events can happen during Arc lifecycle:
login_ok
someone succesfully authenticated to the system.login_ko
someone tried to authenticate to the system with the wrong credentials.token_ko
an invalid JWT token has been used to access Arc API.update
a new version of Arc is available.record_expired
a record reached its expiration date.
If configured to do so, the server will create brief reports of such events and it will send to the user and client using three different channels:
- A notification inside the Arc web UI itself.
- A desktop notification.
- An email report to the configured address.
Email reports can be optionally encrypted by the server using PGP, in this case the user has to provide his PGP public key. A private key can also be provided, if not the server will generate a new one (4096 bits RSA) during the first boot. Since email reports might include parts of valid credentials (ie. you mistyped one character of the valid password) it is highly suggested to enable this option.
n
Create a new item ( store or record ).d
Delete the current item ( store or record ).r
Rename the current item ( store or record ).a
Add a new field to the current record.p
Pin / unpin the curret record.s
Save the current record.e
Set the expiration date for the current record.ESC
Close the current window.
You can export stores and their encrypted records to a TAR file:
./arcd -config config.json -output ~/backup.tar -export
Exported archives can be later imported with:
./arcd -config config.json -import ~/backup.tar
Generate self signed certificate in order to use Arc on HTTPS:
openssl req -new -x509 -sha256 -key key.pem -out certificate-pem -days 365
Allow the arcd
binary to bind to privileged ports without having root privileges (bind to port 443 for HTTPS without root):
sudo setcap 'cap_net_bind_service=+ep' arcd
Lines to add to /etc/rc.local
in order to make arcd start at boot (running as pi
user, configuration, logs and and ui are in the home folder):
export ARC=/home/pi/
sudo -H -u pi bash -c "$ARC/arcd -config $ARC/config.json -app $ARC/arc -log-file $ARC/arcd.log &"
Before opening an issue, please make sure it is not already part of a known bug.
Arc was made with ♥ by Simone Margaritelli and it is released under the GPL 3 license.