1262c9b204
Reference the OpenStack hacking guide in HACKING.rst and remove duplicate entries. Add empty section as a place holder for barbican specific rules. Change-Id: Id1aecd08640fcca324bdb2028d6b3b6867a8b892 |
||
|---|---|---|
| barbican | ||
| bin | ||
| contrib/devstack | ||
| debian | ||
| doc/source | ||
| docs | ||
| etc | ||
| functionaltests | ||
| rpmbuild | ||
| .coveragerc | ||
| .gitignore | ||
| .gitreview | ||
| .mailmap | ||
| .testr.conf | ||
| HACKING.rst | ||
| LICENSE | ||
| MANIFEST.in | ||
| README.md | ||
| apiary.apib | ||
| babel.cfg | ||
| config.py | ||
| openstack-common.conf | ||
| pylintrc | ||
| requirements.txt | ||
| setup.cfg | ||
| setup.py | ||
| test-requirements.txt | ||
| tox.ini | ||
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
- Provide a central secret-store capable of distributing secret / keying material to all types of deployments including ephemeral Cloud instances.
- Support reasonable compliance regimes through reporting and auditability.
- Application adoption costs should be minimal or non-existent.
- Build a community and ecosystem by being open-source and extensible.
- Improve security through sane defaults and centralized management of policies for all secrets.
- Out of band communication mechanism to notify and protect sensitive assets.