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.
 
 
Jeremy Liu c7e824e0e7 Use http_proxy_to_wsgi middleware 6 years ago
api-guide/source Fix the typo 6 years ago
barbican Merge "Fix some typos in simple_crypto.py" 6 years ago
bin User with creator role can delete his/her own secret and container 6 years ago
devstack Remove "KEYSTONE_" URI settings for devsatck 6 years ago
doc/source Adding rest API for secret-stores resource (Part 4) 6 years ago
etc Use http_proxy_to_wsgi middleware 6 years ago
functionaltests Merge "Use Domains with Keystone v3 in functional tests" 6 years ago
install-guide/source Add Barbican Verification to Install Guide 6 years ago
releasenotes Use http_proxy_to_wsgi middleware 6 years ago
.coveragerc Add I18n-related unit tests (Part 3) 8 years ago
.gitignore Update .gitignore for pyenv 7 years ago
.gitreview Update .gitreview file for new repo name 8 years ago
.mailmap Add .mailmap file 9 years ago
.testr.conf Use testr for running functional tests and documentation 7 years ago
HACKING.rst Deduplicate HACKING.rst with docs.openstack.org/developer/hacking/ 8 years ago
LICENSE Merge of previous project work into this project 10 years ago
README.md Reworded sentence fragment in the README 7 years ago
apiary.apib Correct a typo in apiary.apib 6 years ago
babel.cfg Merge of previous project work into this project 10 years ago
pylintrc Merge of previous project work into this project 10 years ago
requirements.txt Updated from global requirements 6 years ago
setup.cfg Merge "modify the home-page info with the developer documentation" 6 years ago
setup.py Updated from global requirements 7 years ago
test-requirements.txt Updated from global requirements 6 years ago
tox.ini Support upper-constratints.txt in tox environments 6 years ago

README.md

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

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 Getting Started wiki page 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.