Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding missing functionality to azure_rm_keyvaultkey #930

Merged
merged 5 commits into from
Aug 4, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 54 additions & 3 deletions plugins/modules/azure_rm_keyvaultkey.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,28 @@
description:
- Name of the keyvault key.
required: true
key_type:
description:
- The type of key to create. For valid values, see JsonWebKeyType. Possible values include EC, EC-HSM, RSA, RSA-HSM, oct
default: 'RSA'
key_size:
description:
- The key size in bits. For example 2048, 3072, or 4096 for RSA.
key_attributes:
description:
- The attributes of a key managed by the key vault service.
suboptions:
enabled:
description: bool
not_before:
description:
- not valid before date in UTC ISO format without the Z at the end
expires:
description:
- not valid after date in UTC ISO format without the Z at the end
curve:
description:
- Elliptic curve name. For valid values, see JsonWebKeyCurveName. Possible values include P-256, P-384, P-521, P-256K.
byok_file:
description:
- BYOK file.
Expand Down Expand Up @@ -86,12 +108,19 @@
from azure.keyvault.models import KeyAttributes, JsonWebKey
from azure.common.credentials import ServicePrincipalCredentials, get_cli_profile
from azure.keyvault.models.key_vault_error import KeyVaultErrorException
from datetime import datetime
from msrestazure.azure_active_directory import MSIAuthentication
from OpenSSL import crypto
except ImportError:
# This is handled in azure_rm_common
pass

key_addribute_spec = dict(
enabled=dict(type='bool', required=False),
not_before=dict(type='str', no_log=True, required=False),
expires=dict(type='str', no_log=True, required=False)
)


class AzureRMKeyVaultKey(AzureRMModuleBase):
''' Module that creates or deletes keys in Azure KeyVault '''
Expand All @@ -101,6 +130,10 @@ def __init__(self):
self.module_arg_spec = dict(
key_name=dict(type='str', required=True),
keyvault_uri=dict(type='str', no_log=True, required=True),
key_type=dict(type='str', default='RSA'),
key_size=dict(type='int'),
key_attributes=dict(type='dict', no_log=True, options=key_addribute_spec),
curve=dict(type='str'),
pem_file=dict(type='str'),
pem_password=dict(type='str', no_log=True),
byok_file=dict(type='str'),
Expand All @@ -114,6 +147,10 @@ def __init__(self):

self.key_name = None
self.keyvault_uri = None
self.key_type = None
self.key_size = None
self.key_attributes = None
self.curve = None
self.pem_file = None
self.pem_password = None
self.state = None
Expand Down Expand Up @@ -159,7 +196,8 @@ def exec_module(self, **kwargs):

# Create key
if self.state == 'present' and changed:
results['key_id'] = self.create_key(self.key_name, self.tags)
results['key_id'] = self.create_key(self.key_name, self.key_type, self.key_size, self.key_attributes,
self.curve, self.tags)
self.results['state'] = results
self.results['state']['status'] = 'Created'
# Delete key
Expand Down Expand Up @@ -223,9 +261,22 @@ def get_key(self, name, version=''):
key_id = KeyVaultId.parse_key_id(key_bundle.key.kid)
return key_id.id

def create_key(self, name, tags, kty='RSA'):
def create_key(self, name, key_type, key_size, key_attributes, curve, tags):
''' Creates a key '''
key_bundle = self.client.create_key(vault_base_url=self.keyvault_uri, key_name=name, kty=kty, tags=tags)

if key_attributes is not None:
k_enabled = key_attributes.get('enabled', True)
k_not_before = key_attributes.get('not_before', None)
k_expires = key_attributes.get('expires', None)
if k_not_before:
k_not_before = datetime.fromisoformat(k_not_before.replace('Z', '+00:00'))
if k_expires:
k_expires = datetime.fromisoformat(k_expires.replace('Z', '+00:00'))

key_attributes = KeyAttributes(k_enabled, k_not_before, k_expires)

key_bundle = self.client.create_key(vault_base_url=self.keyvault_uri, key_name=name, kty=key_type, key_size=key_size,
key_attributes=key_attributes, curve=curve, tags=tags)
key_id = KeyVaultId.parse_key_id(key_bundle.key.kid)
return key_id.id

Expand Down
102 changes: 102 additions & 0 deletions tests/integration/targets/azure_rm_keyvaultkey/tasks/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,108 @@
key_name: testkey
register: output

- name: create a kevyault key of type EC
block:
- azure_rm_keyvaultkey:
keyvault_uri: https://vault{{ rpfx }}.vault.azure.net
key_name: testkeyEC
key_type: EC
tags:
testing: test
delete: on-exit
register: output
- assert:
that: output.changed
rescue:
- azure_rm_keyvaultkey:
keyvault_uri: https://vault{{ rpfx }}.vault.azure.net
state: absent
key_name: testkeyEC

- name: delete a kevyault key of type EC
azure_rm_keyvaultkey:
keyvault_uri: https://vault{{ rpfx }}.vault.azure.net
state: absent
key_name: testkeyEC
register: output

- name: create a kevyault key of size 4096
block:
- azure_rm_keyvaultkey:
keyvault_uri: https://vault{{ rpfx }}.vault.azure.net
key_name: testkey4096
key_size: 4096
tags:
testing: test
delete: on-exit
register: output
- assert:
that: output.changed
rescue:
- azure_rm_keyvaultkey:
keyvault_uri: https://vault{{ rpfx }}.vault.azure.net
state: absent
key_name: testkey4096

- name: delete a kevyault key of size 4096
azure_rm_keyvaultkey:
keyvault_uri: https://vault{{ rpfx }}.vault.azure.net
state: absent
key_name: testkey4096
register: output

- name: create a kevyault key with P-521 curve
block:
- azure_rm_keyvaultkey:
keyvault_uri: https://vault{{ rpfx }}.vault.azure.net
key_name: testkeycurve
curve: P-521
tags:
testing: test
delete: on-exit
register: output
- assert:
that: output.changed
rescue:
- azure_rm_keyvaultkey:
keyvault_uri: https://vault{{ rpfx }}.vault.azure.net
state: absent
key_name: testkeycurve

- name: delete a kevyault key with P-521 curve
azure_rm_keyvaultkey:
keyvault_uri: https://vault{{ rpfx }}.vault.azure.net
state: absent
key_name: testkeycurve
register: output

- name: create a kevyault key with attributes
block:
- azure_rm_keyvaultkey:
keyvault_uri: https://vault{{ rpfx }}.vault.azure.net
key_name: testkeyattribute
key_attributes:
enabled: true
not_before: '2032-12-01T00:00:00Z'
tags:
testing: test
delete: on-exit
register: output
- assert:
that: output.changed
rescue:
- azure_rm_keyvaultkey:
keyvault_uri: https://vault{{ rpfx }}.vault.azure.net
state: absent
key_name: testkeyattributes

- name: delete a kevyault key with attributes
azure_rm_keyvaultkey:
keyvault_uri: https://vault{{ rpfx }}.vault.azure.net
state: absent
key_name: testkeyattribute
register: output

- assert:
that: output.changed

Expand Down