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 4bb724c50e Merge "Allow users with "creator" role to edit ACLs" 22 hours ago
api-guide/source Allow secret delete by users with "creator" role 4 months ago
barbican Allow users with "creator" role to edit ACLs 1 week ago
bin Update json module to jsonutils 3 years ago
devstack Merge "Drop configure_keystone_authtoken_middleware function" 2 years ago
doc Allow secret delete by users with "creator" role 4 months ago
etc Include options for Vault secret store 2 weeks ago
functionaltests Merge "Allow secret delete by users with "creator" role" 3 months ago
playbooks Add FIPS gate job 12 months ago
releasenotes Imported Translations from Zanata 3 weeks ago
.coveragerc Update .coveragerc after the removal of respective directory 6 years ago
.gitignore Switch to stestr 4 years ago
.gitreview OpenDev Migration Patch 3 years ago
.mailmap Add .mailmap file 9 years ago
.stestr.conf Switch to stestr 4 years ago
.zuul.yaml Remove undercloud job 2 weeks ago
HACKING.rst Update json module to jsonutils 3 years ago
LICENSE Update LICENSE 9 years ago
README.rst docs: Update Freenode to OFTC 12 months ago
apiary.apib Replace git.openstack.org URLs with opendev.org URLs 3 years ago
bindep.txt Add FIPS gate job 12 months ago
requirements.txt Implement microversions, bring back secret consumers API 3 weeks ago
setup.cfg Updating python testing classifier as per Yoga testing runtime 6 months ago
setup.py Cleanup py27 support 2 years ago
test-requirements.txt Merge "Update doc8 version" 1 year ago
tox.ini Updating python testing classifier as per Yoga testing runtime 6 months 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.

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.

Future design work is tracked at https://specs.openstack.org/openstack/barbican-specs.

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 OFTC.

Client Libraries

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.

For the symmetric and asymmetric key types, Barbican supports full life cycle management including provisioning, expiration, reporting, etc.

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.