Barbican is a ReST API designed for the secure storage, provisioning and management of secrets, including in OpenStack environments.
Go to file
Zuul b6edfda344 Merge "Drop all remaining logics for certificate resources" 2024-03-08 16:18:59 +00:00
api-guide/source Drop all remaining logics for certificate resources 2024-02-27 23:33:47 +09:00
barbican Merge "Drop all remaining logics for certificate resources" 2024-03-08 16:18:59 +00:00
bin Fix python shebang 2023-10-17 16:04:36 +00:00
devstack Merge "Drop all remaining logics for certificate resources" 2024-03-08 16:18:59 +00:00
doc Prohibit certificate order resource 2024-02-22 13:16:49 +09:00
etc Drop all remaining logics for certificate resources 2024-02-27 23:33:47 +09:00
functionaltests Merge "Drop all remaining logics for certificate resources" 2024-03-08 16:18:59 +00:00
playbooks Add FIPS gate job 2021-06-10 17:59:07 -04:00
releasenotes Merge "Drop all remaining logics for certificate resources" 2024-03-08 16:18:59 +00:00
.coveragerc Simplify .coveragerc 2024-01-25 23:38:54 +09:00
.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 Update devstack plugin for Secure RBAC 2024-03-01 14:09:27 -05:00
HACKING.rst Remove six 2022-10-28 14:02:00 +02:00
LICENSE Update LICENSE 2013-03-25 11:09:25 -05:00
README.rst Migrate back to Launchpad 2023-05-15 14:22:00 +02:00
apiary.apib Replace git.openstack.org URLs with opendev.org URLs 2019-05-23 12:50:09 +08:00
bindep.txt Microversions documentation 2022-12-09 10:26:35 +01:00
requirements.txt Bump hacking 2024-01-27 22:30:46 +09:00
setup.cfg Merge "Drop all remaining logics for certificate resources" 2024-03-08 16:18:59 +00:00
setup.py Cleanup py27 support 2020-04-29 19:10:48 +02:00
test-requirements.txt Bump hacking 2024-01-27 22:30:46 +09:00
tox.ini tests: Enable SQLAlchemy 2.0 deprecation warnings 2023-07-13 09:58:57 +01: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.

To file a bug, use our bug tracker on Launchpad.

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.