openstack
/
barbican
Code Issues Proposed changes
Barbican is a ReST API designed for the secure storage, provisioning and management of secrets, including in OpenStack environments.
491 Commits 11 Branches 57 Tags 39 MiB
Python 98.1%
Shell 1.8%
Go to file
Russell Bryant 571473bd87 Add .mailmap file 
Add a .mailmap file for git to use for cases where the same person has
commits with more than one name or email address.

Change-Id: I14c787ecc196b064a5d2c714d26ea1b854bb933e
 		2013-12-02 11:23:23 -05:00
barbican Add verification REST service to Barbican 2013-11-25 22:53:06 -06:00
bin Update the keystone configuration script for Barbican per Johns Hopkins team. 2013-11-05 15:06:27 -06:00
debian Add files to create worker RPM and get api/db/queue/worker nodes deployed. 2013-09-16 18:03:35 -05:00
etc Add verification REST service to Barbican 2013-11-25 22:53:06 -06:00
rpmbuild Fix automatic signing 2013-11-20 18:06:16 -06:00
tools Remove Celery and Kombu version pinning 2013-11-11 22:13:35 -06:00
.coveragerc Address issue with oslo config rejecting cli options for logging 2013-04-16 18:19:53 -05:00
.gitignore Add role based access control (RBAC) to Barbican 2013-08-20 21:30:35 -05:00
.gitreview Add .gitreviw file; Fixed pyflakes violations; Fixed pep7 violations; Fixed tox.ini config; 2013-06-27 10:07:28 -05:00
.mailmap Add .mailmap file 2013-12-02 11:23:23 -05:00
Authors Merge of previous project work into this project 2013-04-01 18:26:03 -05:00
HACKING.rst removed references to glance and substituted with barbican 2013-05-22 15:38:11 -07:00
LICENSE Merge of previous project work into this project 2013-04-01 18:26:03 -05:00
MANIFEST.in Removed README.rst in favor of README.md 2013-11-15 13:31:22 -06:00
README.md Line wrap README, revise IRC channel to #openstack-barbican 2013-11-21 10:48:47 -06:00
apiary.apib Transferring blueprint from apiary.io 2013-05-08 12:52:11 -07:00
babel.cfg Merge of previous project work into this project 2013-04-01 18:26:03 -05:00
config.py Fixed PEP8 violations 2013-04-08 19:07:17 -05:00
openstack-common.conf Add role based access control (RBAC) to Barbican 2013-08-20 21:30:35 -05:00
pylintrc Merge of previous project work into this project 2013-04-01 18:26:03 -05:00
run_tests.sh removed references to glance and substituted with barbican 2013-05-22 15:38:11 -07:00
setup.cfg Address issue with oslo config rejecting cli options for logging 2013-04-16 18:19:53 -05:00
setup.py Add a better installer for local Barbican application instances. 2013-11-04 15:25:49 -06:00
tox.ini Remove padding code and tests in the p11 plugin 2013-08-15 08:49:08 -05:00

README.md

Barbican

Barbican is a ReST API designed for the secure storage, provisioning and management of secrets. It is aimed at being useful for all environments, including large ephemeral Clouds. The project is supported by Rackspace Hosting.

Barbican is part of a set of applications that make up the CloudKeep ecosystem. The other systems are:

  • Postern - Go based agent that provides access to secrets from the Barbican API.
  • Palisade - AngularJS based web ui for the Barbican API.
  • Python-barbicanclient - A convenient Python-based library to interact with the Barbican API.

Additional documentation can be found on the Github Wiki. For questions, comments or concerns, hop on the OpenStack dev mailing list at openstack-dev@lists.openstack.org and let us know what you think, just add [barbican] to the subject. You can also join our Freenode IRC at #openstack-barbican. To file a bug, use our bug tracker on Launchpad.

Getting Started

Please visit our Getting Started wiki page for details.

Why Should You Use Barbican?

The current state of key management is atrocious. While Windows does have some decent options through the use of the Data Protection API (DPAPI) and Active Directory, Linux lacks a cohesive story around how to manage keys for application use.

Barbican was designed to solve this problem. The system was motivated by internal Rackspace needs, requirements from OpenStack and a realization that the current state of the art could use some help.

Barbican will handle many types of secrets, including:

  • Symmetric Keys - Used to perform reversible encryption of data at rest, typically using the AES algorithm set. This type of key is required to enable features like encrypted Swift containers and Cinder volumes, encrypted Cloud Backups, etc.
  • Asymmetric Keys - Asymmetric key pairs (sometimes referred to as public / private keys) are used in many scenarios where communication between untrusted parties is desired. The most common case is with SSL/TLS certificates, but also is used in solutions like SSH keys, S/MIME (mail) encryption and digital signatures.
  • Raw Secrets - Barbican stores secrets as a base64 encoded block of data (encrypted, naturally). Clients can use the API to store any secrets in any format they desire. The Postern agent is capable of presenting these secrets in various formats to ease integration.

For the symmetric and asymmetric key types, Barbican supports full lifecycle management including provisioning, expiration, reporting, etc. A plugin system allows for multiple certificate authority support (including public and private CAs).

Design Goals

  1. Provide a central secret-store capable of distributing secret / keying material to all types of deployments including ephemeral Cloud instances.
  2. Support reasonable compliance regimes through reporting and auditability.
  3. Application adoption costs should be minimal or non-existent.
  4. Build a community and ecosystem by being open-source and extensible.
  5. Improve security through sane defaults and centralized management of policies for all secrets.
  6. Out of band communication mechanism to notify and protect sensitive assets.