Barbican is a ReST API designed for the secure storage, provisioning and management of secrets, including in OpenStack environments.
Go to file
Douglas Mendizábal e7a714bd1f Ignore network errors during C_Finalize
The Trustway Proteccio HSM can somtimes return a network error when
attempting to finalize the cryptoki library.

The error can prevent reinitialization because we attempt to finalize
the library before initalizing a new connection.  When a network error
occurrs, barbican gets stuck in an error loop trying to finalize the
dead connection before starting a new one.

This patch adds code to ignore the network error when finalizing to
ensure we are able to attempt to reinitialize.

Connection errors during other operations will still result in 500
errors as expected.

Change-Id: I9ac6c7bbda0f81cb26e1c589803317df1ef11f39
(cherry picked from commit 70aac1f698)
(cherry picked from commit 1b6cf81c23)
(cherry picked from commit 2792aca796)
(cherry picked from commit 238b72caca)
2021-10-18 21:16:36 +00:00
api-guide/source Update api-ref location 2019-08-05 17:58:16 +02:00
barbican Ignore network errors during C_Finalize 2021-10-18 21:16:36 +00:00
bin Update json module to jsonutils 2019-03-07 07:02:48 +00:00
devstack Fix the barbicanclient installation not from source 2019-12-04 02:06:15 +01:00
doc Use serial number or label for PKCS#11 tokens 2020-10-30 16:21:41 +00:00
etc Use default policy in code 2018-02-09 08:16:43 +00:00
functionaltests Fix stable/train gates 2020-10-29 15:22:33 -05:00
playbooks/legacy Start using the f29 nodeset 2019-09-18 12:15:53 -05:00
releasenotes Allow multiple token labels for PKCS#11 driver 2021-03-09 16:35:23 +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/train 2019-09-27 20:11: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 Use the stable/train job for octavia 2021-10-18 21:15:13 +00:00
HACKING.rst Update json module to jsonutils 2019-03-07 07:02:48 +00:00
LICENSE Merge of previous project work into this project 2013-04-01 18:26:03 -05:00
README.rst Rename README.md to README.rst 2019-08-05 18:02:09 +02:00
apiary.apib Replace git.openstack.org URLs with opendev.org URLs 2019-05-23 12:50:09 +08:00
babel.cfg Merge of previous project work into this project 2013-04-01 18:26:03 -05:00
bindep.txt Fix pep8 gate failure because of missing dependency 2017-06-08 11:37:24 +07:00
lower-constraints.txt Update Castellan minimum version 2019-08-06 07:43:59 +00:00
requirements.txt Update Castellan minimum version 2019-08-06 07:43:59 +00:00
setup.cfg Merge "Rename README.md to README.rst" 2019-08-06 10:13:36 +00:00
setup.py Updated from global requirements 2017-03-06 01:07:50 +00:00
test-requirements.txt Drop lower-constraints job to unblock gate 2021-03-08 16:09:29 -06:00
tox.ini Update TOX/UPPER_CONSTRAINTS_FILE for stable/train 2019-09-27 20:11:05 +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.

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.

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.

Barbican began as part of a set of applications that make up the CloudKeep ecosystem. The other systems are:

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