openstack/castellan
Code Issues Proposed changes

Fix Vault K/V API compatibility.

Browse Source 
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>
This commit is contained in:
Moises Guimaraes de Medeiros 2018-08-22 15:59:20 +02:00
parent 99a0db50b8
commit 2d5be1ade4
1 changed files with 54 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
castellan/key_manager/vault_key_manager.py
View File

@ -93,12 +93,41 @@ class VaultKeyManager(key_manager.KeyManager):
self._verify_server = self._conf.vault.ssl_ca_crt_file or True
else:
self._verify_server = False
self._vault_kv_version = None
def _get_url(self):
if not self._vault_url.endswith('/'):
self._vault_url += '/'
return self._vault_url
def _get_api_version(self):
if self._vault_kv_version:
return self._vault_kv_version
headers = {'X-Vault-Token': self._root_token_id}
try:
resource_url = self._get_url() + 'v1/sys/internal/ui/mounts/secret'
resp = self._session.get(resource_url,
verify=self._verify_server,
headers=headers)
except requests.exceptions.Timeout as ex:
raise exception.KeyManagerError(six.text_type(ex))
except requests.exceptions.ConnectionError as ex:
raise exception.KeyManagerError(six.text_type(ex))
except Exception as ex:
raise exception.KeyManagerError(six.text_type(ex))
if resp.status_code in _EXCEPTIONS_BY_CODE:
raise exception.KeyManagerError(resp.reason)
if resp.status_code == requests.codes['forbidden']:
raise exception.Forbidden()
if resp.status_code == requests.codes['not_found']:
self._vault_kv_version = '1'
else:
self._vault_kv_version = resp.json()['data']['options']['version']
return self._vault_kv_version
def create_key_pair(self, context, algorithm, length,
expiration=None, name=None):
"""Creates an asymmetric key pair."""
@ -159,7 +188,11 @@ class VaultKeyManager(key_manager.KeyManager):
headers = {'X-Vault-Token': self._root_token_id}
try:
resource_url = self._get_url() + 'v1/secret/' + key_id
resource_url = '{}v1/secret/{}{}'.format(
self._get_url(),
'' if self._get_api_version() == '1' else 'data/',
key_id)
record = {
'type': type_value,
'value': binascii.hexlify(value.get_encoded()).decode('utf-8'),
@ -170,6 +203,9 @@ class VaultKeyManager(key_manager.KeyManager):
'name': value.name,
'created': value.created
}
if self._get_api_version() != '1':
record = {'data': record}
resp = self._session.post(resource_url,
verify=self._verify_server,
json=record,
@ -229,7 +265,11 @@ class VaultKeyManager(key_manager.KeyManager):
headers = {'X-Vault-Token': self._root_token_id}
try:
resource_url = self._get_url() + 'v1/secret/' + key_id
resource_url = '{}v1/secret/{}{}'.format(
self._get_url(),
'' if self._get_api_version() == '1' else 'data/',
key_id)
resp = self._session.get(resource_url,
verify=self._verify_server,
headers=headers)
@ -248,6 +288,9 @@ class VaultKeyManager(key_manager.KeyManager):
raise exception.ManagedObjectNotFoundError(uuid=key_id)
record = resp.json()['data']
if self._get_api_version() != '1':
record = record['data']
key = None if metadata_only else binascii.unhexlify(record['value'])
clazz = None
@ -285,7 +328,11 @@ class VaultKeyManager(key_manager.KeyManager):
headers = {'X-Vault-Token': self._root_token_id}
try:
resource_url = self._get_url() + 'v1/secret/' + key_id
resource_url = '{}v1/secret/{}{}'.format(
self._get_url(),
'' if self._get_api_version() == '1' else 'data/',
key_id)
resp = self._session.delete(resource_url,
verify=self._verify_server,
headers=headers)
@ -317,7 +364,10 @@ class VaultKeyManager(key_manager.KeyManager):
headers = {'X-Vault-Token': self._root_token_id}
try:
resource_url = self._get_url() + 'v1/secret/?list=true'
resource_url = '{}v1/secret/{}?list=true'.format(
self._get_url(),
'' if self._get_api_version() == '1' else 'metadata/')
resp = self._session.get(resource_url,
verify=self._verify_server,
headers=headers)