Git Product home page Git Product logo

acs's Introduction

ACS -- Automatic Ciphertext Service

Turns your plaintext secret into a ciphertext encoded with a named key through the magic of vault's transit backend.

Getting started (development)

  1. Get vault up and running (ACS currently has only been tested against vault 0.6.0)

    $ vault server -dev -dev-root-token-id="your-root-token"
    
    # In another terminal
    $ export VAULT_ADDR='http://127.0.0.1:8200'
    $ vault mount transit
    $ vault write -f transit/keys/your_acs_key
  2. start tokend's metadata-server

    $ cd /path/to/tokend/ && npm run metadata-server
  3. start tokend's warden-mock

    $ cd /path/to/tokend && npm run warden-mock -- your-root-token
  4. start tokend

    $ cd /path/to/tokend && npm run dev
  5. Start ACS

    $ cd /path/to/acs && npm run dev
  6. Navigate to localhost:3000 in your browser

Configuration

You specify a configuration file at run time like this: npm start -- -c path/to/your/config.json

Here is a full example of a config.json with all of the available configuration parameters:

{
  "vault": {
    "host": "127.0.0.1",
    "port": 8200,
    "tls": false,
    "transit_key": "your_acs_key"
  },
  "tokend": {
    "host": "localhost",
    "port": 4500,
    "path": "/v1/token/default"
  },
  "log": {
    "level": "INFO",
    "json": true,
    "requests": true
  },
  "service": {
    "host": "localhost",
    "port": 3000
  }
}

acs's People

Contributors

asebastian avatar asebastian-r7 avatar camci-r7 avatar davepgreene avatar dgreene-r7 avatar fmitchell-r7 avatar pranav-r7 avatar tcheng-r7 avatar writtenhouse-r7 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

acs's Issues

Version the encrypt endpoint

To facilitate future (breaking) changes, we should version the /encrypt endpoint. It will look something like this /v1/encrypt.

Alter nconf configuration to support default values

It will be a much better user experience if we provided some default values to nconf which can be overridden by command line options (or environment variables).

Config values to be defaulted:

  • --vault:host=127.0.0.1
  • --vault:port=8200
  • --vault:ssl=false
  • --tokend:host=localhost
  • --tokend:port=4500
  • --tokend:path=/v1/token/default
  • --log:level=info

Config values to be supplied by user via command line:

  • --acs:transit_key=yourvalue

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.