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,542 Commits 11 Branches 57 Tags 39 MiB
Python 98.1%
Shell 1.8%
Go to file
Andre Aranha 9c8fb8c3a9 Update secret:delete policy to allow admin to delete secret 
Currently a secret can be orphan, if the project that owns it
is deleted by an user that doesn`t have permission on the
project.[1]
The orphan secret cannot be deleted because the current rule
enforces a scoped token on that project to delete it (that
doesn't exist anymore).
To solve this issue, it's necessary to override the secret:delete
policy rule to allow the cloud admin to delete it.
The secret:get policy rule also needed to be changed because the
Python Barbican client gets the secret to check if it has
consumers before actually deleting it. This patch is making these
updates by default

[1] https://bugzilla.redhat.com/show_bug.cgi?id=1932705

Co-author: Mauricio Harley <mharley@redhat.com>
Change-Id: Id755a9efd896b900d31eca93c0136398ed1925b8
(cherry picked from commit 57d7ff378a)
(cherry picked from commit 00274b2f07)
 		2024-05-02 14:20:02 -04:00
api-guide/source Remove unnecessary unicode prefixes 2022-05-09 19:49:40 +00:00
barbican Update secret:delete policy to allow admin to delete secret 2024-05-02 14:20:02 -04:00
bin Update json module to jsonutils 2019-03-07 07:02:48 +00:00
devstack Update devstack plugin installation doc 2022-09-23 15:56:47 +00:00
doc Fix typo 2023-02-15 09:04:30 +00:00
etc Add audit middleware options to barbican.conf 2022-09-26 16:15:27 +00:00
functionaltests Merge "Remove six" 2022-11-29 12:49:48 +00:00
playbooks Add FIPS gate job 2021-06-10 17:59:07 -04:00
releasenotes Remove System scope from policy 2024-05-02 18:07:06 +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/2023.1 2023-03-01 10:50:05 +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 Remove System scope from policy 2024-05-02 18:07:06 +00: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 docs: Update Freenode to OFTC 2021-06-08 21:58:55 +08: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 Remove six 2022-10-28 14:02:00 +02:00
setup.cfg Drop python3.6/3.7 support in testing runtime 2022-05-23 10:26:10 +01:00
setup.py Cleanup py27 support 2020-04-29 19:10:48 +02:00
test-requirements.txt Merge "Update doc8 version" 2021-01-12 15:14:46 +00:00
tox.ini Fix functional tests 2023-04-20 14:47:15 +00: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 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.