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.
783 Commits 12 Branches 62 Tags 39 MiB
Python 98.1%
Shell 1.8%
d15f8db597
Go to file
tsv d15f8db597 remove project-id from resource URIs 
All Barbican resources have a project-id in their URI. This helps to
correlate the resource with the specified project when no external
authentication mechanism is used. However, most Barbican deployments
would use Keystone to authenticate the API requests. With Keystone,
the project-id information is already obtained when the X-Auth-Token
header from the request is validated. This makes the project-id in the
URI redundant. This commit removes project-id from the URI.

Tests have been updated as well to not expect project-id in the URI.

Patch 3:
  removed unauthenticated-context from admin pipeline to fix
  tempest failure. version api doesn't need auth context now
Patch 4:
  refactored based on review comments
  removed the Noop policy enforcer class
Patch 5:
  rebased and fixed failing tests
  fixed issue in parsing performance_uri
Patch 6:
  updated functional tests to remove project-id from uri
  removed rbac check for versions controller
  expecting X-Project-ID to be present in request for all requests
  this needs to be fixed in the next pass when the admin paste
  pipeline is updated
Patch 7:
  fixed failing functional test
  refactoring based on review comments
Patch 8:
  rebased and fixed failing unit tests
Patch 9:
  fixed merge issue by removing keystone_id from few more lines
  and files
Patch 10:
  fixed failing functional tests (consumers)

Spec: https://review.openstack.org/#/c/100386
Client CR: https://review.openstack.org/#/c/112149
Change-Id: If54911718188eb26b7380331d0b61d70206522a5
Blueprint: https://blueprints.launchpad.net/barbican/+spec/api-remove-uri-tenant-id
2014-08-12 16:49:53 -06:00
barbican remove project-id from resource URIs 2014-08-12 16:49:53 -06:00
bin Replace hard-coded setup version setting 2014-08-11 13:36:17 -05:00
contrib/devstack Merge "Update devstack endpoint creation to include v1" 2014-07-23 16:02:30 +00:00
debian Use auth_token from keystonemiddleware 2014-07-24 11:56:19 -07:00
doc/source autodoc import error for plugin.rst 2014-08-06 13:27:15 -06:00
docs Replaced some UTF-8 characters with ASCII characters 2014-07-07 19:45:39 +02:00
etc remove project-id from resource URIs 2014-08-12 16:49:53 -06:00
functionaltests remove project-id from resource URIs 2014-08-12 16:49:53 -06:00
rpmbuild Use auth_token from keystonemiddleware 2014-07-24 11:56:19 -07:00
.coveragerc Adjust contrib location, minor adjustments 2014-02-26 15:33:30 -06:00
.gitignore Increased test coverage for app and updated .gitignore 2014-07-03 09:48:12 -05:00
.gitreview Update .gitreview file for new repo name 2014-05-23 18:14:46 -04:00
.mailmap Add .mailmap file 2013-12-02 11:23:23 -05:00
.testr.conf Add tempest tests to run in devstack gate 2014-07-25 17:03:41 -05:00
apiary.apib Transferring blueprint from apiary.io 2013-05-08 12:52:11 -07:00
babel.cfg Merge of previous project work into this project 2013-04-01 18:26:03 -05:00
config.py Fixed PEP8 violations 2013-04-08 19:07:17 -05:00
HACKING.rst removed references to glance and substituted with barbican 2013-05-22 15:38:11 -07:00
LICENSE Merge of previous project work into this project 2013-04-01 18:26:03 -05:00
MANIFEST.in Removed README.rst in favor of README.md 2013-11-15 13:31:22 -06:00
openstack-common.conf Remove oslo.uuidutils 2014-02-27 13:12:17 +08:00
pylintrc Merge of previous project work into this project 2013-04-01 18:26:03 -05:00
README.md Update the links to python-barbicanclient 2014-06-02 15:05:04 +01:00
requirements.txt Use auth_token from keystonemiddleware 2014-07-24 11:56:19 -07:00
setup.cfg Replace hard-coded setup version setting 2014-08-11 13:36:17 -05:00
setup.py Migrate to pbr 2013-12-18 11:47:13 -06:00
test-requirements.txt Add Sphinx developer documentation skeleton 2014-04-30 12:14:26 -05:00
tox.ini Merge "Set python hash seed to 0 in tox.ini" 2014-08-01 22:39:36 +00:00

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. The project is supported by Rackspace Hosting.

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

Additional documentation can be found on the Github Wiki. For questions, comments or concerns, 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 Freenode IRC at #openstack-barbican. To file a bug, use our bug tracker on Launchpad.

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. Out of band communication mechanism to notify and protect sensitive assets.