Barbican is a ReST API designed for the secure storage, provisioning and management of secrets, including in OpenStack environments.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Zuul b9df6336ae Merge "Don't use branch matching" 2 days ago
api-guide/source Update api-ref location 2 months ago
barbican Add SecretConsumerMetadatum model and its tests 3 weeks ago
bin Update json module to jsonutils 7 months ago
devstack Start using the f29 nodeset 1 month ago
doc PDF Documentation Build tox target 3 weeks ago
etc Use default policy in code 1 year ago
functionaltests Fix the bug of pep8 and building api-guide 2 months ago
playbooks/legacy Start using the f29 nodeset 1 month ago
releasenotes Imported Translations from Zanata 2 months ago
.coveragerc Update .coveragerc after the removal of respective directory 3 years ago
.gitignore Switch to stestr 1 year ago
.gitreview OpenDev Migration Patch 6 months ago
.mailmap Add .mailmap file 5 years ago
.stestr.conf Switch to stestr 1 year ago
.zuul.yaml Don't use branch matching 2 weeks ago
HACKING.rst Update json module to jsonutils 7 months ago
LICENSE Update LICENSE 6 years ago
README.rst Rename README.md to README.rst 2 months ago
apiary.apib Replace git.openstack.org URLs with opendev.org URLs 5 months ago
babel.cfg Merge of previous project work into this project 6 years ago
bindep.txt PDF Documentation Build tox target 3 weeks ago
lower-constraints.txt PDF Documentation Build tox target 3 weeks ago
requirements.txt Update Castellan minimum version 2 months ago
setup.cfg Merge "Rename README.md to README.rst" 2 months ago
setup.py Updated from global requirements 2 years ago
test-requirements.txt Block bandit 1.6.0 5 months ago
tox.ini PDF Documentation Build tox target 3 weeks ago

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.