openstack/barbican
Code Issues Proposed changes
Barbican is a ReST API designed for the secure storage, provisioning and management of secrets, including in OpenStack environments.
3,292 Commits 12 Branches 62 Tags 39 MiB
Python 98.1%
Shell 1.8%
02b82e5a4c
Go to file
Andreas Jaeger 02b82e5a4c Cleanup py27 support 
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
  know about the requirement
- Remove obsolete sections from setup.cfg
- Update classifiers
- Use newer openstackdocstheme and Sphinx versions
- Cleanup */source/conf.py to remove now obsolete content.
- Remove Babel from requirements, it's not needed for running.
- Sync docs deps in tox.ini

Change-Id: Ie1fccdc777be978075e4689eda6c62578bd463e4
2020-04-29 19:10:48 +02:00
api-guide/source Cleanup py27 support 2020-04-29 19:10:48 +02:00
barbican Use unittest.mock instead of third party mock 2020-04-28 04:00:17 +00:00
bin Update json module to jsonutils 2019-03-07 07:02:48 +00:00
devstack Use Zuulv3 devstack jobs 2020-04-27 16:41:20 -05:00
doc Cleanup py27 support 2020-04-29 19:10:48 +02:00
etc Use default policy in code 2018-02-09 08:16:43 +00:00
functionaltests Use Zuulv3 devstack jobs 2020-04-27 16:41:20 -05:00
playbooks/legacy [ussuri][goal] Drop python 2.7 support and testing 2020-01-10 17:22:04 +00:00
releasenotes Cleanup py27 support 2020-04-29 19:10:48 +02: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 Add undercloud-containers to gate 2020-04-28 04:04:07 +00:00
apiary.apib Replace git.openstack.org URLs with opendev.org URLs 2019-05-23 12:50:09 +08:00
bindep.txt PDF Documentation Build tox target 2019-09-25 08:59:22 +00:00
HACKING.rst Update json module to jsonutils 2019-03-07 07:02:48 +00:00
LICENSE Update LICENSE 2013-03-25 11:09:25 -05:00
lower-constraints.txt Use unittest.mock instead of third party mock 2020-04-28 04:00:17 +00:00
README.rst Merge "Add barbican-spec link to readme.rst" 2020-04-28 20:08:18 +00:00
requirements.txt Cleanup py27 support 2020-04-29 19:10:48 +02:00
setup.cfg Cleanup py27 support 2020-04-29 19:10:48 +02:00
setup.py Cleanup py27 support 2020-04-29 19:10:48 +02:00
test-requirements.txt Use unittest.mock instead of third party mock 2020-04-28 04:00:17 +00:00
tox.ini Cleanup py27 support 2020-04-29 19:10:48 +02: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.

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

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.