Merge "Rename README.md to README.rst"
This commit is contained in:
Zuul
Gerrit Code Review
commit
ecb5565bd9
@ -1,59 +1,63 @@
|
||||
========================
|
||||
Team and repository tags
|
||||
========================
|
||||
|
||||
[](https://governance.openstack.org/tc/reference/tags/index.html)
|
||||
|
||||
<!-- Change things from this point on -->
|
||||
.. image:: https://governance.openstack.org/tc/badges/barbican.svg
|
||||
:target: https://governance.openstack.org/tc/reference/tags/index.html
|
||||
|
||||
# Barbican
|
||||
.. Change things from this point on
|
||||
|
||||
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
|
||||
](https://wiki.openstack.org/wiki/Barbican) with support from
|
||||
[Rackspace Hosting](http://www.rackspace.com/), EMC, Ericsson,
|
||||
Barbican is an OpenStack project developed by the `Barbican Project Team
|
||||
<https://wiki.openstack.org/wiki/Barbican>`_ 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](https://docs.openstack.org/barbican/latest/).
|
||||
The full documentation can be found on the `Barbican Developer Documentation
|
||||
Site <https://docs.openstack.org/barbican/latest/>`_.
|
||||
|
||||
If you have a technical question, you can ask it at [Ask OpenStack](
|
||||
https://ask.openstack.org/en/questions/) with the `barbican` tag, or you can
|
||||
send an email to the [OpenStack General mailing list](
|
||||
http://lists.openstack.org/pipermail/openstack/) at
|
||||
`openstack@lists.openstack.org` with the prefix `[barbican]` in the
|
||||
subject.
|
||||
If you have a technical question, you can ask it at `Ask OpenStack
|
||||
<https://ask.openstack.org/en/questions/>`_ with the `barbican` tag.
|
||||
|
||||
To file a bug, use our bug tracker on [OpenStack Storyboard](
|
||||
https://storyboard.openstack.org/#!/project/980).
|
||||
To file a bug, use our bug tracker on `OpenStack Storyboard
|
||||
<https://storyboard.openstack.org/#!/project/980>`_.
|
||||
|
||||
Release notes for the project can be found at(
|
||||
https://docs.openstack.org/releasenotes/barbican).
|
||||
Release notes for the project can be found at
|
||||
https://docs.openstack.org/releasenotes/barbican.
|
||||
|
||||
For development questions or discussion, hop on the [OpenStack-dev mailing list
|
||||
](http://lists.openstack.org/pipermail/openstack-dev/)
|
||||
at `openstack-dev@lists.openstack.org` and let us know what you think, just add
|
||||
For development questions or discussion, use the `OpenStack-discuss
|
||||
mailing list <http://lists.openstack.org/pipermail/openstack-discuss/>`_
|
||||
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:
|
||||
|
||||
* [Postern](https://github.com/cloudkeep/postern) - Go based agent that
|
||||
* `Postern <https://github.com/cloudkeep/postern>_` - Go based agent that
|
||||
provides access to secrets from the Barbican API.
|
||||
* [Palisade](https://github.com/cloudkeep/palisade) - AngularJS based web ui
|
||||
* `Palisade <https://github.com/cloudkeep/palisade>`_ - AngularJS based web ui
|
||||
for the Barbican API.
|
||||
* [Python-barbicanclient](https://github.com/openstack/python-barbicanclient) -
|
||||
* `Python-barbicanclient
|
||||
<https://github.com/openstack/python-barbicanclient>`_ -
|
||||
A convenient Python-based library to interact with the Barbican API.
|
||||
|
||||
## Getting Started
|
||||
Getting Started
|
||||
---------------
|
||||
|
||||
Please visit our [Users, Developers and Operators documentation
|
||||
](https://docs.openstack.org/barbican/latest/) for details.
|
||||
Please visit our `Users, Developers and Operators documentation
|
||||
<https://docs.openstack.org/barbican/latest/>`_ for details.
|
||||
|
||||
## Why Should You Use Barbican?
|
||||
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
|
||||
@ -62,24 +66,28 @@ application use.
|
||||
|
||||
Barbican was designed to solve this problem. The system was motivated by
|
||||
internal Rackspace needs, requirements from
|
||||
[OpenStack](http://www.openstack.org/) and a realization that the current state
|
||||
`OpenStack <http://www.openstack.org/>`_ 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](http://www.openstack.org/software/openstack-storage/), [encrypted
|
||||
Cloud Backups](http://www.rackspace.com/cloud/backup/), etc.
|
||||
* **Asymmetric Keys** - Asymmetric key pairs (sometimes referred to as [public
|
||||
/ private keys](http://en.wikipedia.org/wiki/Public-key_cryptography)) 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.
|
||||
features like `encrypted Swift containers and Cinder
|
||||
volumes <http://www.openstack.org/software/openstack-storage/>`_, `encrypted
|
||||
Cloud Backups <http://www.rackspace.com/cloud/backup/>`_, etc.
|
||||
* **Asymmetric Keys** - Asymmetric key pairs (sometimes referred to as
|
||||
`public / private keys
|
||||
<http://en.wikipedia.org/wiki/Public-key_cryptography>`_) 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](https://github.com/cloudkeep/postern) agent
|
||||
format they desire. The `Postern
|
||||
<https://github.com/cloudkeep/postern>`_ agent
|
||||
is capable of presenting these secrets in various formats to ease
|
||||
integration.
|
||||
|
||||
@ -88,15 +96,16 @@ management including provisioning, expiration, reporting, etc. A plugin system
|
||||
allows for multiple certificate authority support (including public and private
|
||||
CAs).
|
||||
|
||||
## Design Goals
|
||||
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](https://github.com/cloudkeep/barbican/wiki/Policies).
|
||||
5. Improve security through sane defaults and centralized management
|
||||
of `policies for all secrets
|
||||
<https://github.com/cloudkeep/barbican/wiki/Policies>`_.
|
||||
6. Provide an out of band communication mechanism to notify and protect sensitive
|
||||
assets.
|
||||
@ -3,7 +3,7 @@ name = barbican
|
||||
summary = OpenStack Secure Key Management
|
||||
description = Service for storing sensitive client information for OpenStack
|
||||
description-file =
|
||||
README.md
|
||||
README.rst
|
||||
author = OpenStack
|
||||
author-email = openstack-discuss@lists.openstack.org
|
||||
home-page = https://docs.openstack.org/barbican/latest/
|
||||
|
||||
Loading…
Reference in New Issue
Block a user