Barbican is a ReST API designed for the secure storage, provisioning and management of secrets, including in OpenStack environments.
Go to file
Akihiro Motoki 2d2376397d Ensure doc/source/_static to fix docs gate
doc/source/_static directory is required by oslo.policy sample generator.
The recent sphinx complains if _static directory is missing.
This commit adds a placeholder file to ensure doc/source/_static directory.

Change-Id: Ied6cbc80c4b384ed45c927f2aea8e88604f457fe
2019-09-06 10:07:26 +09:00
api-guide/source Update api-ref location 2019-08-05 17:58:16 +02:00
barbican Fix py3 compatibility issue in PKCS#11 plugin 2019-08-09 12:28:42 -05:00
bin Update json module to jsonutils 2019-03-07 07:02:48 +00:00
devstack Replace git.openstack.org URLs with opendev.org URLs 2019-05-23 12:50:09 +08:00
doc Ensure doc/source/_static to fix docs gate 2019-09-06 10:07:26 +09:00
etc Use default policy in code 2018-02-09 08:16:43 +00:00
functionaltests Fix the bug of pep8 and building api-guide 2019-08-05 16:36:02 +02:00
playbooks/legacy OpenDev Migration Patch 2019-04-19 19:49:03 +00:00
releasenotes Imported Translations from Zanata 2019-08-06 08:45:38 +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 OpenDev Migration Patch 2019-04-19 19:49:03 +00: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 Merge "Add Python 3 Train unit tests" 2019-08-05 23:31:00 +00:00
HACKING.rst Update json module to jsonutils 2019-03-07 07:02:48 +00:00
LICENSE Merge of previous project work into this project 2013-04-01 18:26:03 -05:00
README.rst Rename README.md to README.rst 2019-08-05 18:02:09 +02:00
apiary.apib Replace git.openstack.org URLs with opendev.org URLs 2019-05-23 12:50:09 +08: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
lower-constraints.txt Update Castellan minimum version 2019-08-06 07:43:59 +00:00
requirements.txt Update Castellan minimum version 2019-08-06 07:43:59 +00:00
setup.cfg Merge "Rename README.md to README.rst" 2019-08-06 10:13:36 +00:00
setup.py Updated from global requirements 2017-03-06 01:07:50 +00:00
test-requirements.txt Block bandit 1.6.0 2019-05-13 15:37:57 +02:00
tox.ini Merge "Fix barbican B105 issues" 2019-08-06 08:28:26 +00:00

README.rst

Team and repository tags

image

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 <http://www.rackspace.com/>_, 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.

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, use the OpenStack-discuss mailing list at openstack-discuss@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:

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.