Go server for two-man rule style file encryption and decryption.
Go HTML Other
Switch branches/tags
Nothing to show
Clone or download
Permalink
Failed to load latest commit information.
client Fixing rebase of andrewbuss/decrypt_sign Mar 12, 2018
cmd/ro user/pass prompts from ro-ssh-agent are printed to stderr Mar 12, 2018
config Enable sentry reporting. (#180) Dec 8, 2016
core Renamed DecryptSign -> SSHSignWith, added tests for SSHSignWith and U… Mar 12, 2018
cryptor Fixing rebase of andrewbuss/decrypt_sign Mar 12, 2018
ecdh goimports and go vet cleanups. May 7, 2015
hipchat Send a message. Not a notification Feb 1, 2016
keycache Fix the concurrent map write error. (#177) Dec 6, 2016
msp Cleanup Go Report Card warnings Nov 9, 2016
order Cleanup Go Report Card warnings Nov 9, 2016
padding Cleanup Go Report Card warnings Nov 9, 2016
passvault Cleanup Go Report Card warnings Nov 9, 2016
persist Fixing rebase of andrewbuss/decrypt_sign Mar 12, 2018
report Enable sentry reporting. (#180) Dec 8, 2016
scripts make docker: build a docker image for redoctober (#159) Oct 7, 2016
server Fixing rebase of andrewbuss/decrypt_sign Mar 12, 2018
static Added Usages field to web interface Mar 12, 2018
symcrypt goimports and go vet cleanups. May 7, 2015
testdata RO SSH Agent Forwarding Works Mar 12, 2018
vendor Add raven-go to vendored packages. Dec 21, 2016
.dockerignore make docker: build a docker image for redoctober (#159) Oct 7, 2016
.gitignore Clean up comments and run 'go gmt' across code Nov 19, 2013
.travis.yml Fix the concurrent map write error. (#177) Dec 6, 2016
Dockerfile make docker: build a docker image for redoctober (#159) Oct 7, 2016
LICENSE.md Update License. Feb 14, 2017
Makefile make docker: build a docker image for redoctober (#159) Oct 7, 2016
README.md RO SSH Agent Forwarding Works Mar 12, 2018
generate.go Fixing rebase of andrewbuss/decrypt_sign Mar 12, 2018
redoctober.go Initial decrypt-sign support Mar 12, 2018
redoctober.service Fix the usage string, example systemd files, and README for breaking … Oct 15, 2015
redoctober.socket Add the ability to listen to systemd-provided sockets. Oct 9, 2015
redoctober_test.go Cleanup Go Report Card warnings Nov 9, 2016
static.go Added Usages field to web interface Mar 12, 2018

README.md

Red October

Red October is a software-based two-man rule style encryption and decryption server.

Building

Build StatusCoverage Status

This project requires Go 1.4 or later to compile. Verify your go version by running go version:

$ go version
go version go1.4

As with any Go program you do need to set the GOPATH environment variable accordingly. With Go set up you can download and compile sources:

$ go get github.com/cloudflare/redoctober

And run the tests:

$ go test github.com/cloudflare/redoctober...

Running

Red October is a TLS server. It requires a local file to hold the key vault, an internet address, and a certificate keypair.

First you need to acquire a TLS certificate. The simplest (and least secure) way is to skip the Certificate Authority verification and generate a self-signed TLS certificate. Read this detailed guide or, alternatively, follow these insecure commands:

$ mkdir cert
$ chmod 700 cert
## Generate private key with password "password"
$ openssl genrsa -aes128 -passout pass:password -out cert/server.pem 2048
## Remove password from private key
$ openssl rsa -passin pass:password -in cert/server.pem -out cert/server.pem
## Generate CSR (make sure the common name CN field matches your server
## address. It's set to "localhost" here.)
$ openssl req -new -key cert/server.pem -out cert/server.csr -subj '/C=US/ST=California/L=Everywhere/CN=localhost'
## Sign the CSR and create certificate
$ openssl x509 -req -days 365 -in cert/server.csr -signkey cert/server.pem -out cert/server.crt
## Clean up
$ rm cert/server.csr
$ chmod 600 cert/*

You're ready to run the server:

$ ./bin/redoctober -addr=localhost:8080 \
                   -vaultpath=diskrecord.json \
                   -certs=cert/server.crt \
                   -keys=cert/server.pem

Quick start: example webapp

At this point Red October should be serving an example webapp. Access it using your browser:

Using the API

The server exposes several JSON API endpoints. JSON of the prescribed format is POSTed and JSON is returned.

  • /create: Create the first admin account.
  • /delegate: Delegate a password to Red October
  • /create-user: Create a user
  • /modify: Modify permissions
  • /encrypt: Encrypt
  • /decrypt: Decrypt
  • /owners: List owners of an encrypted secret.
  • /summary: Display summary of the delegates
  • /password: Change password
  • /index: Optionally, the server can host a static HTML file.

Create

Create is the necessary first call to a new vault. It creates an admin account.

Example query:

$ curl --cacert cert/server.crt https://localhost:8080/create \
        -d '{"Name":"Alice","Password":"Lewis"}'
{"Status":"ok"}

Delegate

Delegate allows a user to delegate their decryption password to the server for a fixed period of time and for a fixed number of decryptions. If the user's account is not created, it creates it. Any new delegation overrides the previous delegation.

Example query:

$ curl --cacert cert/server.crt https://localhost:8080/delegate \
       -d '{"Name":"Bill","Password":"Lizard","Time":"2h34m","Uses":3}'
{"Status":"ok"}
$ curl --cacert cert/server.crt https://localhost:8080/delegate \
       -d '{"Name":"Cat","Password":"Cheshire","Time":"2h34m","Uses":3}'
{"Status":"ok"}
$ curl --cacert cert/server.crt https://localhost:8080/delegate \
       -d '{"Name":"Dodo","Password":"Dodgson","Time":"2h34m","Uses":3}'
{"Status":"ok"}

Create User

Create Users creates a new user account. Allows an optional "UserType" to be specified which controls how the record is encrypted. This can have a value of either "RSA" or "ECC" and if none is provided will default to "RSA".

Example query:

$ curl --cacert cert/server.crt https://localhost:8080/create-user \
       -d '{"Name":"Bill","Password":"Lizard","UserType":"ECC"}'
{"Status":"ok"}

Summary

Summary provides a list of the users with keys on the system, and a list of users who have currently delegated their key to the server.

Example query:

$ curl --cacert cert/server.crt https://localhost:8080/summary  \
        -d '{"Name":"Alice","Password":"Lewis"}'
{"Status":"ok",
 "Live":{
  "Bill":{"Admin":false,
          "Type":"RSA",
          "Expiry":"2013-11-26T08:42:29.65501032-08:00",
          "Uses":3},
  "Cat":{"Admin":false,
         "Type":"RSA",
         "Expiry":"2013-11-26T08:42:42.016311595-08:00",
         "Uses":3},
  "Dodo":{"Admin":false,
          "Type":"RSA",
          "Expiry":"2013-11-26T08:43:06.651429104-08:00",
          "Uses":3}
 },
 "All":{
  "Alice":{"Admin":true, "Type":"RSA"},
  "Bill":{"Admin":false, "Type":"RSA"},
  "Cat":{"Admin":false, "Type":"RSA"},
  "Dodo":{"Admin":false, "Type":"RSA"}
 }
}

Encrypt

Encrypt allows a user to encrypt a piece of data. A list of valid users is provided and a minimum number of delegated users required to decrypt. The returned data can be decrypted as long as "Minimum" number users from the set of "Owners" have delegated their keys to the server.

Example query:

$ echo "Why is a raven like a writing desk?" | openssl base64
V2h5IGlzIGEgcmF2ZW4gbGlrZSBhIHdyaXRpbmcgZGVzaz8K

$ curl --cacert cert/server.crt https://localhost:8080/encrypt  \
        -d '{"Name":"Alice","Password":"Lewis","Minimum":2, "Owners":["Alice","Bill","Cat","Dodo"],"Data":"V2h5IGlzIGEgcmF2ZW4gbGlrZSBhIHdyaXRpbmcgZGVzaz8K"}'
{"Status":"ok","Response":"eyJWZXJzaW9uIj...NSSllzPSJ9"}

Example query with a predicate:

$ curl --cacert cert/server.crt https://localhost:8080/encrypt  \
        -d '{"Name":"Alice","Password":"Lewis","Predicate":"Alice & (Bob | Carl)",
        Data":"V2h5IGlzIGEgcmF2ZW4gbGlrZSBhIHdyaXRpbmcgZGVzaz8K"}'
{"Status":"ok","Response":"eyJWZXJzaW9uIj...NSSllzPSJ9"}

The data expansion is not tied to the size of the input.

Decrypt

Decrypt allows a user to decrypt a piece of data. As long as "Minimum" number users from the set of "Owners" have delegated their keys to the server, a base64 encoded object with the clear data and the set of "Owners" whose private keys were used is returned.

Example query:

$ curl --cacert cert/server.crt https://localhost:8080/decrypt  \
        -d '{"Name":"Alice","Password":"Lewis","Data":"eyJWZXJzaW9uIj...NSSllzPSJ9"}'
{"Status":"ok","Response":"eyJEYXRhI...FuMiJdfQ=="}

If there aren't enough keys delegated you'll see:

{"Status":"need more delegated keys"}

Owners

Owners allows users to determine which delegations are needed to decrypt a piece of data.

Example query:

$ curl --cacert cert/server.crt https://localhost:8080/owners  \
        -d '{"Data":"eyJWZXJzaW9uIj...NSSllzPSJ9"}'
{"Status":"ok","Owners":["Alice","Bill","Cat","Dodo"]}

Password

Password allows a user to change their password. This password change does not require the previously encrypted files to be re-encrypted.

Example Input JSON format:

$ curl --cacert cert/server.crt https://localhost:8080/password \
       -d '{"Name":"Bill","Password":"Lizard", "NewPassword": "theLizard"}'
{"Status":"ok"}

Modify

Modify allows an admin user to change information about a given user. There are 3 commands:

  • revoke: revokes the admin status of a user
  • admin: grants admin status to a user
  • delete: removes the account of a user

Example input JSON format:

$ curl --cacert cert/server.crt https://localhost:8080/modify \
       -d '{"Name":"Alice","Password":"Lewis","ToModify":"Bill","Command":"admin"}'
{"Status":"ok"}

Purge

Purge deletes all delegates for an encryption key.

Example input JSON format:

$ curl --cacert cert/server.crt https://localhost:8080/purge \
       -d '{"Name":"Alice","Password":"Lewis"}'
{"Status":"ok"}

Order

Order creates a new order and lets other users know delegations are needed.

Example input JSON format:

$ curl --cacert server/server.crt https://localhost:8080/order \
       -d '{"Name":"Alice","Password":"Lewis","Labels": ["Blue","Red"],\
       "Duration":"1h","Uses":5,"EncryptedData":"ABCDE=="}'
{
   "Admins": [
        "Bob",
        "Eve"
    ],
    "AdminsDelegated": null,
    "Delegated": 0,
    "DurationRequested": 3.6e+12,
    "Labels": [
        "blue",
        "red"
    ],
    "Name": "Alice",
    "Num": "77da1cfd8962fb9685c15c84",
    "TimeRequested": "2016-01-25T15:58:41.961906679-08:00",
}

Orders Outstanding

Orders Outstanding will return a list of current order numbers

Example input JSON format:

$ curl --cacert server/server.crt https://localhost:8080/orderout
       -d '{"Name":"Alice","Password":"Lewis"}'
{
    "77da1cfd8962fb9685c15c84":{
        "Name":"Alice",
        "Num":"77da1cfd8962fb9685c15c84",
        "TimeRequested":"2016-01-25T15:58:41.961906679-08:00",
        "DurationRequested":3600000000000,
        "Delegated":0,"
        AdminsDelegated":null,
        "Admins":["Bob, Eve"],
        "Labels":["Blue","Red"]
    }
}

Order Information

Example input JSON format:

$ curl --cacert server/server.crt https://localhost:8080/orderinfo
       -d '{"Name":"Alice","Password":"Lewis", \
       "OrderNum":"77da1cfd8962fb9685c15c84"}'
{
    "Admins": [
        "Bob",
        "Eve"
    ],
    "AdminsDelegated": null,
    "Delegated": 0,
    "DurationRequested": 3.6e+12,
    "Labels": [
        "blue",
        "red"
    ],
    "Name": "Alice",
    "Num": "77da1cfd8962fb9685c15c84",
    "TimeRequested": "2016-01-25T15:58:41.961906679-08:00"
}

Order Cancel

Example input JSON format:

$ curl --cacert server/server.crt https://localhost:8080/orderinfo
       -d '{"Name":"Alice","Password":"Lewis", \
       "OrderNum":"77da1cfd8962fb9685c15c84"}'
{"Status":"ok"}

Web interface

You can build a web interface to manage the Red October service using the -static flag and providing a path to the HTML file you want to serve.

The index.html file in this repo provides a basic example for using all of the service's features, including encrypting and decrypting data. Data sent to the server needs to be base64 encoded. The example uses JavaScript's btoa and atob functions for string conversion. For dealing with files directly, using the HTML5 File API would be a good option.

SSH Signing Oracle

Red October can encrypt an SSH private key with a restriction that the key can be used to sign messages, but that it should not be returned as the result of a decrypt call. The ro client can use this feature to mimic an ssh-agent server which authenticates a user to a remote SSH server without ever handling the unencrypted private key directly.

Generate an ssh key without passphrase:

$ ssh-keygen -f id_ed25519 -N ""

Consign the Key to the RO Server

Encrypt with the "ssh-sign-with" usage only:

$ ro -server localhost:443 -ca server.crt \
     -minUsers 2 -owners alice,bob -usages ssh-sign-with \
     -in id_ed25519 -out id_ed25519.encrypted encrypt

Start the RO SSH Agent

Initiate a SSH agent with connection to the remote RO server:

$ ro -server localhost:443 -ca server.crt ssh-agent

2018/02/05 05:21:13 Starting Red October Secret Shell Agent
export SSH_AUTH_SOCK=/tmp/ro_ssh_267631424/roagent.sock

Connect to SSH via RO SSH Agent

On a separate terminal, run:

$ export SSH_AUTH_SOCK=/tmp/ro_ssh_267631424/roagent.sock
$ ro -in ssh_key.encrypted -pubkey ssh_key.pub ssh-add
$ ssh-add -L # list of all public keys available through ro-ssh-agent

Now, all commands that utilize ssh-agents, such as scp, git, etc., will authenticate through the red october server:

$ ssh user@hostname
$ git -T git@github.com
$ ...

SSH Agent Forwarding

Moreover, since ro-ssh-agent is compatible with the ssh-agent protocol, you can forward the ro-ssh-agent:

localhost $ ssh -A user@middle # calls local ro-ssh-agent to ask RO server for a signature
 middle   $ ssh -A user@far    # calls local ssh-agent for a signature, which forwards the
                               # request packet to the ro-ssh-agent
  far     $ echo Profit!