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.
857 Commits 11 Branches 57 Tags 39 MiB
Python 98.1%
Shell 1.8%
Go to file
John Vrbanac 39c3fb1203 Modifying testr conf to suppress output 
Testr pumps out a lot of output to the screen even
with successful tests. Other OpenStack projects
solve this by modifying their testr config to force
stdout and stderr capture similar to other testing
frameworks. For this change, I have copied how
Nova handles this.

Change-Id: Ie6fb60585a632e09fef068f768c6b6fde10017f0
 		2014-09-13 15:12:58 -05:00
barbican Merge "Move to oslotest" 2014-09-08 14:35:59 +00:00
bin Add order plugin metadata entity and logic 2014-08-22 16:38:06 -05:00
contrib/devstack Allow devstack to do git clone of barbican 2014-08-22 13:00:50 -07:00
debian Use auth_token from keystonemiddleware 2014-07-24 11:56:19 -07:00
doc/source autodoc import error for plugin.rst 2014-08-06 13:27:15 -06:00
docs Updated Create Secret request and response 2014-08-27 19:20:55 -05:00
etc Adding initial update logic for orders 2014-09-04 07:01:42 -05:00
functionaltests Move to oslotest 2014-09-04 01:53:36 -04:00
rpmbuild Install of a Barbican RPM fails due to missing keystonemiddleware 2014-08-18 12:57:38 -05: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
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 Update the links to python-barbicanclient 2014-06-02 15:05:04 +01: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 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
requirements.txt Use auth_token from keystonemiddleware 2014-07-24 11:56:19 -07:00
setup.cfg Add initial files for certificate event handling 2014-09-03 14:34:37 -05:00
setup.py Migrate to pbr 2013-12-18 11:47:13 -06:00
test-requirements.txt Move to oslotest 2014-09-04 01:53:36 -04:00
tox.ini Add a py3pep8 tox job. This will verify py3 compliant syntax 2014-08-25 10:56:03 -10: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.