Commit Graph

76 Commits

Author SHA1 Message Date
Zuul a2c3d54c82 Merge "Implement force parameter" 2023-02-17 12:51:26 +00:00
Zuul 300c60ca97 Merge "Add support for specifying Vault KV path" 2023-02-17 12:23:38 +00:00
Grzegorz Grasza 96027e9cff Implement force parameter
This change adds the force parameter to the secret delete
method. By default, a secret cannot be deleted if it
contains consumers.

This code cannot be merged without a corresponding release and
bump of version for the barbicanclient.

Co-Authored-By: Mauricio Harley <mharley@redhat.com>
Change-Id: I84fd870b1cd19975a5bb832ed6fd6d18ec56eb5a
2023-02-17 10:00:07 +00:00
Grzegorz Grasza bc6d87b969 Add secret consumers
This change adds the ability to add or remove consumers to a
managed object to allow services to indicate which object is
associated with a specific secret.  At this time, only barbican
supports consumers.

This code cannot be merged without a corresponding release and
bump of version for the barbicanclient.

Co-Authored-By: Mauricio Harley <mharley@redhat.com>
Depends-On: https://review.opendev.org/c/openstack/requirements/+/873906
Change-Id: Ic25ac329f87db5992e32ef0b2d7d4020f37b2dee
2023-02-16 13:45:16 +01:00
Scott Solkhon 370986e96e Add support for specifying Vault KV path
This commit adds support for a Vault path that is relative to
the root of the Vault KV store. This configuration is optional
and will be a noop for existing deployments.

Change-Id: If34c38c8f0a2f13ea90f564bfe5e933e5e748da4
2023-01-16 20:47:07 +00:00
LiZekun 86712360f3 remove unicode from code
Change-Id: I086d90b6f46e31582d412b8725e48cba5c21d6bc
2022-01-05 10:44:00 +08:00
Pavlo Shchelokovskyy ecf625b65c Add support for Vault Namespaces
Vault Namespaces [0] is a feature available in Vault Enterprise that
can be considered as a more advanced isolation feature on top of current
KV Mountpoint option in Castellan Vault plugin.

Passing a namespace in all request headers (including Auth) allows to organize
Vault-in-Vault style of isolation, with clients using the same simple URI path
but accessing separate sets of entities in Vault.

[0] https://www.vaultproject.io/docs/enterprise/namespaces

Change-Id: I627c20002bb2a0a1b346b57e824f87f856eca4c9
2021-10-07 12:12:51 +00:00
Mark Goddard 162039467a barbican key manager: Add support for service user
This change adds support to the Barbican key manager for configuring a
service user. This can be used to provide additional security through
the combination of a user token and a service token, with appropriate
modifications to Barbican API policy.

Use of a service user is enabled via the [barbican]
send_service_user_token option, which defaults to False. When set to
True, the service user is configured via keystoneauth options in the
barbican_service_user group.

Change-Id: I143cb57c8534a8dc0a91e6e42917dd0c134170c0
2021-06-21 12:48:03 +00:00
Takashi Kajinami bfcf4b2f69 Simplify the reference to barbican parameters
... so that we can easily identify the logics which are referring to
configuration parameters.

Change-Id: I93427a64b83f474c7c2dd45c8c200e7a3c9bc6f9
2021-02-03 23:31:56 +09:00
Takashi Kajinami 8c48341169 Allow specifying region of barbican endpoint
This change introduces a new option to define the region to which
the Barbican endpoint belongs. This is required if the deployment has
multiple regions and a single Keystone instance stores multiple
Barbican endpoints for different regions.
This change also ensures that the same interface and region are used
in endpoint detection and api version detection.

Change-Id: If2c0055d45922937e259a8f22f5879c9faa41e35
2021-02-03 12:11:09 +00:00
Sam Morrison 4a4544b8ec Don't expect barbican service name to be barbican.
It is standard practice to search for services in the catalog by
service type and interface only. Service name should be left
to deployers to choose and this could be something other than barbican.

Change-Id: I9dddba1e52bbf1ee1d8227fdb45e625fdbf0a21b
2020-12-01 13:54:37 +11:00
Ivan Kolodyazhny e63d813a70 Use 'barbican_endpoint_type'config option to get endpoint from catalog
_get_barbican_endpoint now uses barbican_endpoint_type config option to
retrieve a correct endpoint from catalog.

This config option is set to 'public' by default and it's a default
value for ServiceCatalog.endpoint_data_for method. It means that the
default behaviour will be the same as before this patch.

Change-Id: Idf4061fe3e35e3c47a993a56b23c0257c92e5cc3
2020-07-31 21:48:42 +00:00
Moisés Guimarães de Medeiros 68c1eb50a0 Replaces _get_api_version with config option
This patch fixes the issue when guessing the KV API version fails.
From now on, a configuration option should be used to set vault's API
version.

Change-Id: I962b29519c189dddf9723689e6aaeed2cac3ff2c
Signed-off-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
2020-06-22 17:00:15 +02:00
Ivan Kolodyazhny 59f9380c32 Add handler for Bad Request error during Vault authentication
Vault returns Bad Request error if invalid secret ID is provided. It's
better to have such errors handled instad of generic "KeyError: 'auth'"
execption.

Change-Id: Ibc068af70de4022f544d394ec4b014443a9c16b5
2020-06-12 12:51:57 +00:00
ramboman 89f311dfbd add "verify_ssl_path" config for barbican key manager
Now we cann't use the verify_ssl if we set True, so we
add the "verify_ssl_path" config to solve it.

Closes-Bug: #1876102
Change-Id: I83bafe5b7e0c4cca67f773858007fb59d98a93a5
2020-05-06 21:31:27 +08:00
Moisés Guimarães de Medeiros 8e88919f02 Removes context "validation".
The Vault backend doesn't really care about context. Even an empty
string would suffice these checks.

Change-Id: I1c0d00675a479cf05d92cec7b69fd720a88023d3
Signed-off-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
2020-03-09 16:06:55 +01:00
Moisés Guimarães de Medeiros fd01ccc0f5 Moving common objects under KeyManager.
Both Barbican and Vault backends have this replicated code. Let's
centralize it to reduce code duplication.

Change-Id: I365a6d3031695ee369664c00a61816c77792f2e2
Signed-off-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
2020-03-09 16:06:55 +01:00
Moisés Guimarães de Medeiros 3ccf918c98 Drop use of six
nit: Certificate inherits from ManagedObject which already has
ABCMeta as metaclass.

Change-Id: I17b12980b88e306fbdc99a3e92b1fa22d8e96471
Signed-off-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
2020-03-09 11:14:16 +01:00
Moisés Guimarães de Medeiros 943150ee51 Implements KeyManager's option discovery.
The KeyManager itself should be responsible for advertising the
correct set of options for discovery, not relying on the global
option listing method to know which variable holds the options
and how are they grouped.

Change-Id: I1764c383206df835b7d654f2f776663bd6d4d25b
Signed-off-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
2020-02-21 16:33:17 +01:00
Eric Harney fcb39e5d9d Fix "is" usage with literals
This throws warnings on Python 3.8.

Change-Id: I82625d6d202b33daaa2e7f02fbfb8dc5ab59079c
2019-11-12 12:07:12 -05:00
Vladislav Kuzmin 5d93676338 Reuse existing token from RequestContext
When castellan trying to recreate trust-scoped token
from RequestContext keystone throw exception
because it's not allowed.
Starting from this commit castellan trying to
reuse existing token constructed from RequestContext
if get_auth_plugin() is available.

Change-Id: I10a12b9a2a7f796eca37dd20a280d3a4015a6903
Closes-Bug: #1827047
Depends-On: https://review.opendev.org/#/c/664558/
2019-06-13 15:44:44 +04:00
Moisés Guimarães de Medeiros 9ecd30081a Fix length usage in VaultKeyManager.create_key.
Previous code was considering length as bytes, but the API contract
considers the length param to be bits so that the considering `km`
as a VaultKeyManager, the call `km.create_key(ctx, 'AES', 256)` should
generate a 256 bit AES key and not a 2048 bit AES key instead.

Closes-Bug: #1817248
Change-Id: I5815cb74394e18b6058f4c5cf69b656d7cc2c43b
Signed-off-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
2019-02-22 15:46:35 +01:00
James Page afb539f748 vault: support configuration of KV mountpoint
Support end user configuration of KV store in Vault to use for
key storage allowing more flexibility in Vault configuration.

Change-Id: I625a819c2b9b542677258de709a9c520fb86858b
Closes-Bug: 1797148
2018-10-12 10:05:50 +01:00
James Page bc7f7a4c36 vault: add AppRole support
Add support for use of AppRole's for authentication to Vault; this
feature provides a more application centric approach to managing
long term access to Vault.

The functional tests exercise this integration with a restricted
policy which only allows access to the default 'secret' backend.

Change-Id: I59dfe31adb72712c53d49f66d9ac894e43e8bbad
Closes-Bug: 1796851
2018-10-12 10:03:21 +01:00
Moises Guimaraes de Medeiros 6510f8639a Add method to wrap HashiCorp Vault HTTP API calls.
The new method handles the HTTP request for the Vault HTTP API
and does the error checking in a single place. The same code
was already in four different places in the same file.

Change-Id: I4b688d8cf994fb26f88570840523fcc0ac24faba
Signed-off-by: Moises Guimaraes de Medeiros <moguimar@redhat.com>
2018-08-28 08:33:01 +02:00
Moises Guimaraes de Medeiros 2d5be1ade4 Fix Vault K/V API compatibility.
Starting from version 0.10.0, HashiCorp Vault has a different
API for the Key/Value Secrets Engine. This fix implements both
the new API support and the fallback for the legacy one.

Fixes https://bugs.launchpad.net/castellan/+bug/1788375

Change-Id: I7fed7b5091440dae15551d83f0ee0895651e47bf
Signed-off-by: Moises Guimaraes de Medeiros <moguimar@redhat.com>
2018-08-22 16:04:11 +02:00
Ade Lee 55026461d2 Add code to generate private keys
Change-Id: I05d0cb71406769ebf8ccbd63644ae27a4da6d405
2018-07-04 13:31:32 -04:00
Ellen Batbouta 777b1cce10 Add config option for Barbican endpoint type
This change willl allow the user to specify the endpoint
type for Barbican.  The allowed values are: public, internal,
and admin.  The default value will be 'public' since this is
the current value.

Change-Id: Ic89519ed3a9c347a9fff245ec231aa575b42f1ac
Closes-bug: 1767473
2018-05-01 13:58:58 -04:00
Zuul d3446f51b0 Merge "Support handling legacy all-zeros key ID" 2017-11-28 03:31:10 +00:00
Alan Bishop aa0216d66e Include domain info when creating identity token
Include the project domain info (name and ID) when creating an identity
token that's associated with a RequestContext. This ensures the keystone
v3 auth plugin will be used whenever possible. Without the domain info,
the v2 plugin would be the only possible choice.

Closes-Bug: #1733898
Change-Id: I8b177725db71002d8eca835a7d5367d7911cf347
2017-11-22 10:51:48 -05:00
Alan Bishop fc0fc79eb6 Support handling legacy all-zeros key ID
This patch addresses a specific use case, where a user has encrypted
volumes based on the fixed_key used by Cinder's and Nova's
ConfKeyManager. The user wishes to switch to Barbican, but existing
volumes must continue to function during the migration period.

The code conditionally adds a shim around the backend KeyManager when
both of these conditions are met:

1) The configuration contains a fixed_key value. This essentially
   signals the ConfKeyManager has been in use at one time
2) The current backend is *not* the ConfKeyManager

When the shim is active, a MigrationKeyManager class is dynamically
created that extends the backend's KeyManager class. The
MigrationKeyManager exists solely to override two functions:

o The KeyManager.get() function detects requests for the secret
  associated with the fixed_key, which is identified by an all-zeros
  key ID.

  - Requests for the all-zeros key ID are handled by mimicing the
    ConfKeyManager's response, which is a secret derived from the
    fixed_key.
  - Requests for any other key ID are passed on to the real backend.

o The KeyManager.delete() function is similar:

  - Requests to delete the all-zeros key ID are essentially ignored,
    just as is done by the ConfKeyManager.
  - Requests to delete any other key ID are passed on to the real
    backend.

All other KeyManager functions are not overridden, and will therefore be
handled directly by the real backend.

SecurityImpact
Change-Id: Ia5316490201c33e23a4206838d5a4fb3dd00f527
2017-11-21 09:23:09 -05:00
Davanum Srinivas a972da32a9 Vault based key manager
* Uses https://www.vaultproject.io/ to store/fetch secrets
* All we need is the URL and a Token to talk to the vault server
* tox target "functional-vault" sets up a server in development mode
  and runs functional tests
* Supports both http:// and https:// url(s)
* the https support was tested by setting up a vault server by hand
  (https://gist.github.com/dims/47674cf2c3b0a953df69246c2ea1ff78)
* create_key_pair is the only API that is not implemented

Change-Id: I6436e5841c8e77a7262b4d5aa39201b40a985255
2017-11-13 20:56:34 -05:00
Jenkins 35c2a9912e Merge "Add ID to managed objects" 2017-09-18 13:15:26 +00:00
Kaitlin Farr ffd9f484df Makes list method not abstract
Any implementations of key_manager that don't have "list"
defined (i.e. ConfKeyManager in Nova and Cinder) will not be
instantiable if they try to use a version of Castellan
that was released after "list" was added. Adds a default
implementation of "list" that returns nothing for backwards
compatibility.

Closes-Bug: #1715451
Change-Id: I1e413831163bffaed3a2580f039e242da7d303f8
2017-09-12 19:05:22 +00:00
Kaitlin Farr d8fb4f1794 Add ID to managed objects
The managed objects did not have an ID associated with them. This is most
helpful for the list command, where once you have more than one object,
it's hard to track unique identifiers for the objects.

Change-Id: Ibc48762e7c2c71659fb96826c53301bc6f55ddf7
2017-08-31 21:08:08 +00:00
Kaitlin Farr 233febb0c1 Append a forward slash to the base_url
six.moves.urllib.parse.urljoin strips everything that doesn't end
with a forward slash, so for example, if the barbican URL is
http://ip-address/key-manager, the "key-manager" part will be removed.
If the URL is http://ip-address/key-manager/, everything will be fine.

Change-Id: I1afcd7ae460633e451bc365fdb87f6e30bb3a60b
2017-08-08 18:25:56 -04:00
Davanum Srinivas 8980bf7da5 Use Stevedore for better extensions
Since all Oslo library drivers are discoverable via
stevedore, we should use stevedore in Castellan as well.
This will make it easier for folks to write their own
custom drivers. Stevedore uses setuptools entry points
for implementing the common patterns for dynamically
loading extensions.

We add [key_manager]/backend as the new option to set
the custom driver. For a while, we should support the
older values that used to be specified using
[key_manager]/apiclass.

Change-Id: I2610459839806a5591da1efa314dfa52bcfb7cda
2017-08-01 09:01:35 -04:00
Kaitlin Farr fafceee8cb Rename barbican client import
Importing the barbican client object as barbican_client and
also using barbican_client as a variable name was confusing.
Changes the import name to prevent confusion.

Change-Id: I886f045eb56683713ab75401b5ec1669ddbb072d
2017-07-28 14:14:46 -04:00
Jenkins dfce4df2f5 Merge "Fix retrieving barbican endpoint from service catalog" 2017-07-28 09:07:40 +00:00
Paul Bourke 17e8b29067 Fix retrieving barbican endpoint from service catalog
The context wrapper classes under castellan.common.credentials were
missing an auth_url property resulting in calls to get_endpoint()
failing with 'Could not determine a suitable URL for the plugin' unless
users set barbican/auth_endpoint.

Change-Id: I1be3a1e11e3f4c2170062927ad359bf679eb25d9
Closes-Bug: #1497993
2017-07-19 09:40:25 +00:00
yushangbin cf5ffc5f0a Replace LOG.warn with LOG.warning
logging.warn is deprecated in Python 3 [1].

[1] https://docs.python.org/3/library/logging.html#logging.warning

Change-Id: Iecf3ba100fb896189c8da0fc69da3f4b86345fb2
2017-07-19 15:21:16 +08:00
Kaitlin Farr 1a13c2b203 Add list capability
Adds ability to list secrets, and adds initial filtering ability. Can
filter by secret_type.

Depends-On: I583f27f91cb3c6bdb23438dff6b539407b4005ed
Depends-On: I99cd72724e11bab362bcaaeb773f33b2abfe815c
Change-Id: I245d5846aa8d3b9586bea6dc4e0b24db86c911c9
2017-07-18 09:46:59 -04:00
bhavani.cr 04874c25cb Remove log translations
Log messages are no longer being translated. This removes all use of the
_LE, _LI, and _LW translation markers to simplify logging and to avoid
confusion with new contributions.

See:
http://lists.openstack.org/pipermail/openstack-i18n/2016-November/002574.html
http://lists.openstack.org/pipermail/openstack-dev/2017-March/113365.html

Change-Id: I410ac1eaa0a3c9bfa68ec1634e74aae369dde1cf
2017-07-03 07:12:25 +00:00
Kaitlin Farr 64207e3035 Change keystone endpoint
DevStack was changed so that keystone uses uwsgi [1]. This
means we can't call keystone with the port number anymore.

1. https://review.openstack.org/#/c/456344/

Change-Id: I349b689e8030c8c2a7313b9781973952ead29c75
2017-04-19 15:38:50 -04:00
Kaitlin Farr d1d8568d2b Add ability to get only metadata
Adds the ability to retrieve only the metadata of a secret. This is
helpful in situations when the caller wants to know information about
the secret, but doesn't want to unnecessarily handle the secret data.

Change-Id: I63aec037973aad2555190ca3eb6bba765955399a
2017-02-06 12:35:14 -05:00
Kaitlin Farr f96ba10252 Remove outdated comment
The get operation supports all object types, not just symmetric keys.

Change-Id: I0fe566df3235874aac57b45f9421da72c52b74d8
2017-01-31 02:10:36 +00:00
Jenkins 53ff248f4b Merge "Add option for verifying TLS (https) requests" 2017-01-21 23:29:29 +00:00
Kaitlin Farr a6b25bb136 Add option for verifying TLS (https) requests
This new option should be used with caution, but is useful
for development environments where the certificates can't
be verified yet.

Closes-Bug: #1516793

Change-Id: I2e5433fda8dec02556a6715b8182201daf8fe9bb
2017-01-08 21:14:03 -05:00
Juan Antonio Osorio Robles 555fba7dee Use generic keystoneauth plugin identity interfaces
This allows us to use versionless endpoints for keystone in the
configuration files and furthermore, we won't depend on a specific
keystone version, as is the case today.

Change-Id: I124c0ea2d9403d6b530b33f18896c4e7bf4eabb5
Depends-On: I35f1c9dcd20017b9c442b04c142e46cad4d15eb4
2016-12-02 06:14:16 +00:00
Steve Martinelli fccb2fef4b remove obsolete oslo incubator code
as part of the openstack wide community goals, oslo
incubator code should be removed from all projects [1]

[1] https://governance.openstack.org/goals/ocata/remove-incubated-oslo-code.html

Change-Id: Ifa3564df125ed002dc1710d7a7c0e9346c34c9f1
2016-11-01 14:16:50 +00:00