openstack
/
barbican
Code Issues Proposed changes

Rename README.md to README.rst 

This repo uses RST files everywhere, let's be consistent and write the
README using RST as well.

This also fixes a PyPI upload issue where PyPI expects RST and cannot
handle markdown (unless we tell it is markdown). The alternative
solution is https://review.opendev.org/668502.

Change-Id: If9b22f6fea2f16350ba0997d02c6aba33fafcc7d
This commit is contained in:
Andreas Jaeger 2019-08-05 17:09:10 +02:00
parent a10ccf6cf3
commit 89b31921e1
2 changed files with 52 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

93
README.md → README.rst
View File

@ -1,59 +1,63 @@
========================
Team and repository tags Team and repository tags
======================== ========================
[![Team and repository tags](https://governance.openstack.org/tc/badges/barbican.svg)](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 Barbican is a REST API designed for the secure storage, provisioning and
management of secrets. It is aimed at being useful for all environments, management of secrets. It is aimed at being useful for all environments,
including large ephemeral Clouds. including large ephemeral Clouds.
Barbican is an OpenStack project developed by the [Barbican Project Team Barbican is an OpenStack project developed by the `Barbican Project Team
](https://wiki.openstack.org/wiki/Barbican) with support from <https://wiki.openstack.org/wiki/Barbican>`_ with support from
[Rackspace Hosting](http://www.rackspace.com/), EMC, Ericsson, `Rackspace Hosting <http://www.rackspace.com/`>_, EMC, Ericsson,
Johns Hopkins University, HP, Red Hat, Cisco Systems, and many more. Johns Hopkins University, HP, Red Hat, Cisco Systems, and many more.
The full documentation can be found on the [Barbican Developer Documentation The full documentation can be found on the `Barbican Developer Documentation
Site](https://docs.openstack.org/barbican/latest/). Site <https://docs.openstack.org/barbican/latest/>`_.
If you have a technical question, you can ask it at [Ask OpenStack]( 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 <https://ask.openstack.org/en/questions/>`_ with the `barbican` tag.
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.
To file a bug, use our bug tracker on [OpenStack Storyboard]( To file a bug, use our bug tracker on `OpenStack Storyboard
https://storyboard.openstack.org/#!/project/980). <https://storyboard.openstack.org/#!/project/980>`_.
Release notes for the project can be found at( Release notes for the project can be found at
https://docs.openstack.org/releasenotes/barbican). https://docs.openstack.org/releasenotes/barbican.
For development questions or discussion, hop on the [OpenStack-dev mailing list For development questions or discussion, use the `OpenStack-discuss
](http://lists.openstack.org/pipermail/openstack-dev/) mailing list <http://lists.openstack.org/pipermail/openstack-discuss/>`_
at `openstack-dev@lists.openstack.org` and let us know what you think, just add 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 `[barbican]` to the subject. You can also join our IRC channel
`#openstack-barbican` on Freenode. `#openstack-barbican` on Freenode.
Barbican began as part of a set of applications that make up the CloudKeep Barbican began as part of a set of applications that make up the CloudKeep
ecosystem. The other systems are: 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. 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. 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. A convenient Python-based library to interact with the Barbican API.
## Getting Started Getting Started
---------------
Please visit our [Users, Developers and Operators documentation Please visit our `Users, Developers and Operators documentation
](https://docs.openstack.org/barbican/latest/) for details. <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 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 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 Barbican was designed to solve this problem. The system was motivated by
internal Rackspace needs, requirements from 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. of the art could use some help.
Barbican will handle many types of secrets, including: Barbican will handle many types of secrets, including:
* **Symmetric Keys** - Used to perform reversible encryption of data at rest, * **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 typically using the AES algorithm set. This type of key is required to enable
features like [encrypted Swift containers and Cinder features like `encrypted Swift containers and Cinder
volumes](http://www.openstack.org/software/openstack-storage/), [encrypted volumes <http://www.openstack.org/software/openstack-storage/>`_, `encrypted
Cloud Backups](http://www.rackspace.com/cloud/backup/), etc. Cloud Backups <http://www.rackspace.com/cloud/backup/>`_, etc.
* **Asymmetric Keys** - Asymmetric key pairs (sometimes referred to as [public * **Asymmetric Keys** - Asymmetric key pairs (sometimes referred to as
/ private keys](http://en.wikipedia.org/wiki/Public-key_cryptography)) are `public / private keys
used in many scenarios where communication between untrusted parties is <http://en.wikipedia.org/wiki/Public-key_cryptography>`_) are used in
desired. The most common case is with SSL/TLS certificates, but also is used many scenarios where communication between untrusted parties is
in solutions like SSH keys, S/MIME (mail) encryption and digital signatures. 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 * **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 (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 is capable of presenting these secrets in various formats to ease
integration. integration.
@ -88,15 +96,16 @@ management including provisioning, expiration, reporting, etc. A plugin system
allows for multiple certificate authority support (including public and private allows for multiple certificate authority support (including public and private
CAs). CAs).
## Design Goals Design Goals
------------
1. Provide a central secret-store capable of distributing secret / keying 1. Provide a central secret-store capable of distributing secret / keying
material to all types of deployments including ephemeral Cloud instances. material to all types of deployments including ephemeral Cloud instances.
2. Support reasonable compliance regimes through reporting and auditability. 2. Support reasonable compliance regimes through reporting and auditability.
3. Application adoption costs should be minimal or non-existent. 3. Application adoption costs should be minimal or non-existent.
4. Build a community and ecosystem by being open-source and extensible. 4. Build a community and ecosystem by being open-source and extensible.
5. Improve security through sane defaults and centralized management of 5. Improve security through sane defaults and centralized management
[policies for all of `policies for all secrets
secrets](https://github.com/cloudkeep/barbican/wiki/Policies). <https://github.com/cloudkeep/barbican/wiki/Policies>`_.
6. Provide an out of band communication mechanism to notify and protect sensitive 6. Provide an out of band communication mechanism to notify and protect sensitive
assets. assets.

2
setup.cfg
View File

@ -3,7 +3,7 @@ name = barbican
summary = OpenStack Secure Key Management summary = OpenStack Secure Key Management
description = Service for storing sensitive client information for OpenStack description = Service for storing sensitive client information for OpenStack
description-file = description-file =
README.md README.rst
author = OpenStack author = OpenStack
author-email = openstack-discuss@lists.openstack.org author-email = openstack-discuss@lists.openstack.org
home-page = https://docs.openstack.org/barbican/latest/ home-page = https://docs.openstack.org/barbican/latest/