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.
3,076 Commits 12 Branches 60 Tags 39 MiB
Python 98.1%
Shell 1.8%
727ffb14d3
Go to file
Nguyen Van Trung 727ffb14d3 Add doc8 to pep8 check for project 
This patch adds a doc8 check of .rst files to the current pep8 check.
It includes fixes to the .rst files that didn't pass the check.

Change-Id: If9c6fbf51033cd420c605443dbb3049535024697
2018-07-30 01:56:14 +00:00
api-guide/source Add doc8 to pep8 check for project 2018-07-30 01:56:14 +00:00
api-ref/source Use openstackdocstheme 1.11 everywhere 2017-06-30 20:12:52 +02:00
barbican Fix getting secret for vault plugin 2018-07-26 22:34:16 +12:00
bin Switch to stestr 2018-07-17 09:48:31 +07:00
devstack Fix getting secret for vault plugin 2018-07-26 22:34:16 +12:00
doc Add doc8 to pep8 check for project 2018-07-30 01:56:14 +00:00
etc Use default policy in code 2018-02-09 08:16:43 +00:00
functionaltests Switch to stestr 2018-07-17 09:48:31 +07:00
playbooks/legacy Migrate to Zuul v3 2017-10-30 05:37:24 +00:00
releasenotes Merge "Fix response status for invalid routes" 2018-07-26 02:18:05 +00:00
.coveragerc Update .coveragerc after the removal of respective directory 2016-10-17 17:37:58 +05:30
.gitignore Switch to stestr 2018-07-17 09:48:31 +07: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
.stestr.conf Switch to stestr 2018-07-17 09:48:31 +07:00
.zuul.yaml Enable vault devstack functional test by default 2018-07-24 10:51:51 +12:00
apiary.apib Correct a typo in apiary.apib 2016-06-10 14:56:19 +00:00
babel.cfg Merge of previous project work into this project 2013-04-01 18:26:03 -05:00
bindep.txt Fix pep8 gate failure because of missing dependency 2017-06-08 11:37:24 +07:00
HACKING.rst Add doc8 to pep8 check for project 2018-07-30 01:56:14 +00:00
LICENSE Merge of previous project work into this project 2013-04-01 18:26:03 -05:00
lower-constraints.txt Add doc8 to pep8 check for project 2018-07-30 01:56:14 +00:00
README.md add release notes to README.rst 2018-06-20 13:21:28 +08:00
requirements.txt Initial OVO for Barbican 2018-06-05 13:21:18 +07:00
setup.cfg Update pypi url to new url 2018-07-12 14:01:28 +07:00
setup.py Updated from global requirements 2017-03-06 01:07:50 +00:00
test-requirements.txt Add doc8 to pep8 check for project 2018-07-30 01:56:14 +00:00
tox.ini Add doc8 to pep8 check for project 2018-07-30 01:56:14 +00:00

README.md

Team and repository tags

Team and repository tags

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 OpenStack Storyboard.

Release notes for the project can be found at( https://docs.openstack.org/releasenotes/barbican).

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 Users, Developers and Operators documentation 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.