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.
2,259 Commits 11 Branches 57 Tags 39 MiB
Python 98.1%
Shell 1.8%
Go to file
OpenStack Proposal Bot d3fcaf883c barbican 2.0.0 release 
meta:version: 2.0.0
 meta:series: mitaka
 meta:release-type: release
 meta:announce: openstack-announce@lists.openstack.org
 meta:pypi: no
 meta:first: yes
 -----BEGIN PGP SIGNATURE-----
 Comment: GPGTools - http://gpgtools.org
 
 iQEcBAABAgAGBQJXBgtMAAoJEDttBqDEKEN62/AIALix+/9bco3kuWZ9DTohbjRF
 UWKeGvhOu2slstP/NzBzWV27kJ4b+qq5/D1LTL3IMRcmTCzoEoneL2uJTxVLCzBu
 wIWNthBfBu1pcSYgy7cDLjs7VOdMrJMCxs5PSY4b9FDmA94f81Yt24nOZ+wxCAfx
 YLev4T8DANBsDeZ2wsMr3MNWerzlRZMYhIZIzz29QY2XE8zX8+Wcxs8SRmJxNj4m
 vB7vh8u2k6GcYWmdmr2AWH8qxDTF26hZAjeI0t9cbHltfqKC2XBM8Z1yh2ORNBDd
 Qr3E176cBXUBiAhYYYi+Krn6F+8gq8yA3Err1tL/3mMk7D34CbxDlmMdERfIswI=
 =OzFJ
 -----END PGP SIGNATURE-----

Merge tag '2.0.0'

This is a null-merge of the 2.0.0 release tag back into the master
branch so that the 2.0.0 tag will appear in the git commit history of
the master branch. It contains no actual changes to the master branch,
regardless of how our code review system's UI represents it. Please
ask in #openstack-infra if you have any questions, and otherwise try
to merge this as quickly as possible to avoid later conflicts on the
master branch.

Change-Id: I2a2eab39318eccd851989fbebe58798d7f9fb133
 		2016-04-07 07:25:54 +00:00
api-guide/source Removes redundants 2016-03-24 14:24:14 +07:00
barbican Merge "Return 404 when a secret does not have a payload" 2016-04-04 21:47:26 +00:00
bin Delete deprecated barbican-all script 2016-02-19 22:08:22 -06:00
devstack Uses alembic migration when deploying devstack 2016-03-28 17:04:25 +00:00
doc/source Removes redundants 2016-03-24 14:24:14 +07:00
etc Add a configurable setting in barbican-functional.conf for SSL 2016-03-23 09:30:53 -05:00
functionaltests Merge "Return 404 when a secret does not have a payload" 2016-04-04 21:47:26 +00:00
releasenotes Update reno for stable/mitaka 2016-03-23 09:52:35 +00: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
pylintrc Merge of previous project work into this project 2013-04-01 18:26:03 -05:00
requirements.txt Updated from global requirements 2016-04-06 04:23:27 +00:00
setup.cfg Publishing API Guide to OpenStack site 2016-03-16 12:44:50 -07:00
setup.py Updated from global requirements 2015-09-18 20:41:35 +00:00
test-requirements.txt Updated from global requirements 2016-03-17 21:18:03 +00:00
tox.ini Fix publishing of api-guide 2016-03-21 21:23:47 +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.