carcosa

carcosa copied to clipboard

You're in the Carcosa now…

What is it?

carcosa is a tool for securely storing secrets like password in the public/private git repositories.

carcosa stores secrets (like passwords) under the tokens (e.g. names).

Tokens and secrets are encrypted via AES and it's impossible to decrypt one without another. No one can get the list of tokens without the knowledge of the master password.

How to use carcosa?

Installation

go get github.com/seletskiy/carcosa/cmd/carcosa

This will install carcosa binary in your $GOPATH.

Quickstart

To store your secrets and tokens, carcosa expects a git repository in path $HOME/.secrets/. If you do not have one already, follow these steps

git init ~/.secrets

If you wish to use some other git repository, you can specify the path using -p flag:

carcosa -A my-token -p .
# or
carcosa -A my-token -p /path/to/some/repository/

Adding Secrets

carcosa stores secrets (like passwords) under the tokens (e.g. names). Secrets can be added by using -A flag:

carcosa -A token-name-here

carcosa will then read input secret from stdin. Once you are done typing hit CTRL+D to send EOF.

This will store your secret under token token-name-here in $HOME/.secrets/ unless a custom path to repository is specified.

Listing secrets

carcosa -L

Will list all tokens after entering master password.

Note that this operation will not sync secrets before listing. If you want to sync it before, use -y flag:

carcosa -Ly

Getting secret by token

carcosa -G my-super-password

It will output contents of the secret, decrypted by master password.

Note that it will not sync with the remote repo first. If you want to, you can specify flag -y

Sync your tokens/secrets to remote

You can either set remote to your carcosa git repository, via git remote add or specify remote every time via -r flag.

carcosa -Sr git://path.to/remote.git

Note that a new added secret will be synced to the remote (if any) automatically. If you want to add a new secret locally only, use -n flag:

carcosa -An my-super-password

Then you can sync it remote any time using -S flag:

carcosa -S

Advanced usage

Caching master password

Add -c flag to every command for storing master key (encrypted too) in the read-by-you only cache file. Then, everytime you invoke carcosa with -c flag master key will be read from that file and will not be asked again.

carcosa -Lc  # enter master key once
carcosa -Lc  # use carcosa without entering master key

Using UI

Sample dmenu-based UI available at: https://github.com/deadcrew/deadfiles/blob/master/bin/carcosa-ui

By default, it will look into ~/.secrets directory and expect to find secrets repo there. Alternatively, $SECRETS_REPOSITORY can be specified as environment variable to override that location.

Before usage, master key should be cached by invoking any retrieve or store command with -c flag. Like:

carcosa -Lc