openstack
/
deb-barbican
Code Issues Proposed changes
RETIRED, further work has moved to Debian project infrastructure
2,104 Commits 6 Branches 117 Tags 5 MiB
Go to file
Steve Heyman 60a77c18cb Update .gitignore for pyenv 
Add .python-version to .gitignore file so that you can use
pyenv local for barbican.

Change-Id: I2b2bb01838c2d3c8d30266a1dd2f369bf2a8572c
 		2016-02-09 10:35:47 -06:00
barbican Merge "Python 3 deprecated the logger.warn method in favor of warning" 2016-02-03 03:48:12 +00:00
bin Merge "Correct a typo." 2016-01-21 03:20:20 +00:00
devstack Update Devstack deployment and docs 2015-10-29 14:45:27 -05:00
doc/source Merge "Fix containers api doc typo" 2016-01-19 21:32:59 +00:00
etc Adding support for configuring number of async worker processes 2016-01-18 17:10:15 -08:00
functionaltests Add secret=True so passwords do not get logged 2016-01-22 12:50:59 -06:00
releasenotes Add reno for release notes management 2015-12-01 10:33:18 -05:00
.coveragerc Add I18n-related unit tests (Part 3) 2015-01-05 16:41:08 -06:00
.gitignore Update .gitignore for pyenv 2016-02-09 10:35:47 -06: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 Use testr for running functional tests and documentation 2015-09-14 11:56:48 -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
README.md Reworded sentence fragment in the README 2016-01-18 15:15:14 -06: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
bandit.yaml Add Bandit security static analysis checking via tox 2015-04-08 20:24:38 -04:00
openstack-common.conf Sync with latest oslo-incubator 2015-06-10 11:07:43 +00:00
pylintrc Merge of previous project work into this project 2013-04-01 18:26:03 -05:00
requirements.txt Updated from global requirements 2016-01-26 23:22:01 +00:00
setup.cfg Remove version from setup.cfg 2015-12-03 14:12:10 -05:00
setup.py Updated from global requirements 2015-09-18 20:41:35 +00:00
test-requirements.txt Updated from global requirements 2016-01-19 13:45:59 +00:00
tox.ini Replace None comparisons in SQLAlchemy code 2016-01-17 17:53:53 +01: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.

Barbican is an OpenStack project developed by the Barbican Project Team with support from Rackspace Hosting, EMC, Ericsson, Johns Hopkins University, HP, Red Hat, Cisco Systems, and many more.

The full documentation can be found on the Barbican Developer Documentation Site.

If you have a technical question, you can ask it at Ask OpenStack with the barbican tag, or you can send an email to the OpenStack General mailing list at openstack@lists.openstack.org with the prefix [barbican] in the subject.

To file a bug, use our bug tracker on Launchpad.

For development questions or discussion, 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 IRC channel #openstack-barbican on Freenode.

Barbican began as 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.

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. Provide an out of band communication mechanism to notify and protect sensitive assets.