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,357 Commits 11 Branches 56 Tags 39 MiB
Python 98.1%
Shell 1.8%
Go to file
Douglas Mendizábal 06b4b32d20 Fix consumer name length validator 
This patch fixes a mismatch between the size of the column for a
consumer "name" in the database and the value being checked by the api
validator.

The maximum size in the database is 36 chars [1], so we must use that value
in the validator.

[1] https://opendev.org/openstack/barbican/src/branch/stable/xena/barbican/model/models.py#L826

Story: 2009672
Task: 43933

Change-Id: I76f075a94056aa65cd44fd1d7f5d4b24109b6ed1
(cherry picked from commit 31aa926175)
(cherry picked from commit 059b4a080a)
(cherry picked from commit c1204779b2)
 		2021-11-12 19:01:27 +00:00
api-guide/source Update hacking for Python3 2021-03-04 17:27:30 -06:00
barbican Fix consumer name length validator 2021-11-12 19:01:27 +00:00
bin Update json module to jsonutils 2019-03-07 07:02:48 +00:00
devstack Merge "Drop configure_keystone_authtoken_middleware function" 2020-08-25 14:26:48 +00:00
doc Use serial number or label for PKCS#11 tokens 2020-11-02 17:15:41 +00:00
etc Use default policy in code 2018-02-09 08:16:43 +00:00
functionaltests Update hacking for Python3 2021-03-04 17:27:30 -06:00
playbooks/legacy zuul: switch to the new tempest native jobs 2020-08-11 15:17:56 +02:00
releasenotes Fix consumer name length validator 2021-11-12 19:01:27 +00: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 Update .gitreview for stable/victoria 2020-09-28 17:36:14 +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 Run TripleO jobs on CentOS8 instead of CentOS7 2021-09-13 08:44:55 +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
README.rst delete invalid url in README.rst 2020-05-18 15:06:25 +08:00
apiary.apib Replace git.openstack.org URLs with opendev.org URLs 2019-05-23 12:50:09 +08:00
bindep.txt Fix dogtag functional job 2020-09-01 13:13:49 +00:00
requirements.txt Cap jsonschema 3.2.0 as the minimal version 2020-05-26 21:46:01 +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 Update hacking for Python3 2021-03-04 17:27:30 -06:00
tox.ini Update hacking for Python3 2021-03-04 17:27:30 -06: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.