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.
963 Commits 12 Branches 62 Tags 39 MiB
Python 98.1%
Shell 1.8%
c96f505061
Go to file
Donald Stufft c96f505061 Port the Dependency Adding/Updating docs to Sphinx 
Change-Id: I7bc18428d7f5025e3be4ce50e9a1cbd8d57a1227
2014-11-03 10:33:03 -05:00
barbican Merge "Removing new_name argument from test_wrapper" 2014-10-31 15:34:55 +00:00
bin Remove extraneous vim editor configuration comments 2014-10-08 23:03:03 +02:00
contrib/devstack Allow devstack to do git clone of barbican 2014-08-22 13:00:50 -07:00
debian Adding keystone notification listener support 2014-10-07 16:09:09 -07:00
doc/source Port the Dependency Adding/Updating docs to Sphinx 2014-11-03 10:33:03 -05:00
docs Add missing \n at the end of file 2014-10-09 22:11:23 +02:00
etc Adding keystone notification listener support 2014-10-07 16:09:09 -07:00
functionaltests Added first round of functional tests for secrets 2014-10-30 16:45:45 -05:00
rpmbuild Adding keystone notification listener support 2014-10-07 16:09:09 -07:00
.coveragerc Adjust contrib location, minor adjustments 2014-02-26 15:33:30 -06:00
.gitignore Increased test coverage for app and updated .gitignore 2014-07-03 09:48:12 -05:00
.gitreview Update .gitreview file for new repo name 2014-05-23 18:14:46 -04:00
.mailmap Add .mailmap file 2013-12-02 11:23:23 -05:00
.testr.conf Modifying testr conf to suppress output 2014-09-13 15:12:58 -05:00
apiary.apib Add missing \n at the end of file 2014-10-09 22:11:23 +02: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
HACKING.rst Deduplicate HACKING.rst with docs.openstack.org/developer/hacking/ 2014-09-24 14:35:44 -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
openstack-common.conf Remove oslo.uuidutils 2014-02-27 13:12:17 +08:00
pylintrc Merge of previous project work into this project 2013-04-01 18:26:03 -05:00
README.md Update the links to python-barbicanclient 2014-06-02 15:05:04 +01:00
requirements.txt sync global requirements now that pecan 0.8 is out 2014-10-28 10:45:03 -05:00
setup.cfg Adding keystone notification listener support 2014-10-07 16:09:09 -07:00
setup.py Update to the latest global requirements versions 2014-10-06 10:53:48 -05:00
test-requirements.txt sync global requirements now that pecan 0.8 is out 2014-10-28 10:45:03 -05:00
tox.ini add new diffcover target for a future non-voting gate job 2014-10-29 14:04:55 -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 life cycle 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.