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

feat: Add expiry information for keyvaultsecrets #660

Merged
merged 1 commit into from
Dec 2, 2021
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
30 changes: 27 additions & 3 deletions plugins/modules/azure_rm_keyvaultsecret.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

from __future__ import absolute_import, division, print_function

__metaclass__ = type


Expand Down Expand Up @@ -31,6 +32,14 @@
secret_value:
description:
- Secret to be secured by keyvault.
secret_expiry:
description:
- Optional expiry datetime for secret
type: str
secret_valid_from:
description:
- Optional valid-from datetime for secret
type: str
state:
description:
- Assert the state of the subnet. Use C(present) to create or update a secret and C(absent) to delete a secret .
Expand Down Expand Up @@ -86,6 +95,8 @@
from azure.common.credentials import ServicePrincipalCredentials
from azure.keyvault.models.key_vault_error import KeyVaultErrorException
from msrestazure.azure_active_directory import MSIAuthentication
import dateutil.parser
from azure.keyvault.models.secret_attributes import SecretAttributes
except ImportError:
# This is handled in azure_rm_common
pass
Expand All @@ -99,6 +110,8 @@ def __init__(self):
self.module_arg_spec = dict(
secret_name=dict(type='str', required=True),
secret_value=dict(type='str', no_log=True),
secret_valid_from=dict(type='str', no_log=True),
secret_expiry=dict(type='str', no_log=True),
keyvault_uri=dict(type='str', no_log=True, required=True),
state=dict(type='str', default='present', choices=['present', 'absent']),
content_type=dict(type='str')
Expand All @@ -115,6 +128,8 @@ def __init__(self):

self.secret_name = None
self.secret_value = None
self.secret_valid_from = None
self.secret_expiry = None
self.keyvault_uri = None
self.state = None
self.data_creds = None
Expand Down Expand Up @@ -155,10 +170,18 @@ def exec_module(self, **kwargs):
self.results['changed'] = changed
self.results['state'] = results

valid_from = self.secret_valid_from
if isinstance(valid_from, str) and len(valid_from) > 0:
valid_from = dateutil.parser.parse(valid_from)

expiry = self.secret_expiry
if isinstance(expiry, str) and len(expiry) > 0:
expiry = dateutil.parser.parse(expiry)

if not self.check_mode:
# Create secret
if self.state == 'present' and changed:
results['secret_id'] = self.create_update_secret(self.secret_name, self.secret_value, self.tags, self.content_type)
results['secret_id'] = self.create_update_secret(self.secret_name, self.secret_value, self.tags, self.content_type, valid_from, expiry)
self.results['state'] = results
self.results['state']['status'] = 'Created'
# Delete secret
Expand Down Expand Up @@ -214,9 +237,10 @@ def get_secret(self, name, version=''):
return dict(secret_id=secret_id.id, secret_value=secret_bundle.value)
return None

def create_update_secret(self, name, secret, tags, content_type):
def create_update_secret(self, name, secret, tags, content_type, valid_from, expiry):
''' Creates/Updates a secret '''
secret_bundle = self.client.set_secret(self.keyvault_uri, name, secret, tags=tags, content_type=content_type)
secret_attributes = SecretAttributes(expires=expiry, not_before=valid_from)
secret_bundle = self.client.set_secret(self.keyvault_uri, name, secret, tags=tags, content_type=content_type, secret_attributes=secret_attributes)
secret_id = KeyVaultId.parse_secret_id(secret_bundle.id)
return secret_id.id

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@
secret_name: testsecret
secret_value: 'mysecret'
content_type: 'Content Type Secret'
secret_valid_from: 2000-01-02T010203Z
secret_expiry: 2030-03-04T040506Z
tags:
testing: test
delete: on-exit
Expand All @@ -77,7 +79,11 @@
- facts['secrets'][0]['secret']
- facts['secrets'][0]['tags']
- facts['secrets'][0]['version']
- facts['secrets'][0]['attributes']['expires']
- facts['secrets'][0]['attributes']['not_before']
- facts['secrets'][0]['content_type'] == 'Content Type Secret'
- facts['secrets'][0]['attributes']['expires'] == "2030-03-04T04:05:06+00:00"
- facts['secrets'][0]['attributes']['not_before'] == "2000-01-02T01:02:03+00:00"

- name: delete a kevyault secret
azure_rm_keyvaultsecret:
Expand Down