Adds the bigip_ssl_key module (#32270)
This module's purpose is to specifically manage the ssl keys. It is essentially the key component of the bigip_ssl_certificate module. The modules were separated and the key portion deprecated from bigip_ssl_certificate in favor of this module.
This commit is contained in:
Tim Rupp
GitHub
parent
80031720d1
commit
a16db95ddb
2 changed files with 508 additions and 0 deletions
387
lib/ansible/modules/network/f5/bigip_ssl_key.py
Normal file
387
lib/ansible/modules/network/f5/bigip_ssl_key.py
Normal file
|
|
@ -0,0 +1,387 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Copyright (c) 2017 F5 Networks Inc.
|
||||
# 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
|
||||
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
module: bigip_ssl_key
|
||||
short_description: Import/Delete SSL keys from BIG-IP
|
||||
description:
|
||||
- This module will import/delete SSL keys on a BIG-IP. Keys can be imported
|
||||
from key files on the local disk, in PEM format.
|
||||
version_added: 2.5
|
||||
options:
|
||||
content:
|
||||
description:
|
||||
- Sets the contents of a key directly to the specified value. This is
|
||||
used with lookup plugins or for anything with formatting or templating.
|
||||
This must be provided when C(state) is C(present).
|
||||
aliases:
|
||||
- key_content
|
||||
state:
|
||||
description:
|
||||
- When C(present), ensures that the key is uploaded to the device. When
|
||||
C(absent), ensures that the key is removed from the device. If the key
|
||||
is currently in use, the module will not be able to remove the key.
|
||||
default: present
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
name:
|
||||
description:
|
||||
- The name of the key.
|
||||
required: True
|
||||
passphrase:
|
||||
description:
|
||||
- Passphrase on key.
|
||||
notes:
|
||||
- Requires the f5-sdk Python package on the host. This is as easy as pip
|
||||
install f5-sdk.
|
||||
- This module does not behave like other modules that you might include in
|
||||
roles where referencing files or templates first looks in the role's
|
||||
files or templates directory. To have it behave that way, use the Ansible
|
||||
file or template lookup (see Examples). The lookups behave as expected in
|
||||
a role context.
|
||||
extends_documentation_fragment: f5
|
||||
requirements:
|
||||
- f5-sdk >= 1.5.0
|
||||
- BIG-IP >= v12
|
||||
author:
|
||||
- Tim Rupp (@caphrim007)
|
||||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
- name: Use a file lookup to import key
|
||||
bigip_ssl_key:
|
||||
name: key-name
|
||||
server: lb.mydomain.com
|
||||
user: admin
|
||||
password: secret
|
||||
state: present
|
||||
content: "{{ lookup('file', '/path/to/key.key') }}"
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Delete key
|
||||
bigip_ssl_key:
|
||||
name: key-name
|
||||
server: lb.mydomain.com
|
||||
user: admin
|
||||
password: secret
|
||||
state: absent
|
||||
delegate_to: localhost
|
||||
'''
|
||||
|
||||
RETURN = r'''
|
||||
key_filename:
|
||||
description:
|
||||
- The name of the SSL certificate key. The C(key_filename) and
|
||||
C(cert_filename) will be similar to each other, however the
|
||||
C(key_filename) will have a C(.key) extension.
|
||||
returned: created
|
||||
type: string
|
||||
sample: cert1.key
|
||||
key_checksum:
|
||||
description: SHA1 checksum of the key that was provided.
|
||||
returned: changed and created
|
||||
type: string
|
||||
sample: cf23df2207d99a74fbe169e3eba035e633b65d94
|
||||
key_source_path:
|
||||
description: Path on BIG-IP where the source of the key is stored
|
||||
returned: created
|
||||
type: string
|
||||
sample: /var/config/rest/downloads/cert1.key
|
||||
'''
|
||||
|
||||
|
||||
import hashlib
|
||||
import os
|
||||
import re
|
||||
|
||||
try:
|
||||
from StringIO import StringIO
|
||||
except ImportError:
|
||||
from io import StringIO
|
||||
|
||||
from ansible.module_utils.f5_utils import AnsibleF5Client
|
||||
from ansible.module_utils.f5_utils import AnsibleF5Parameters
|
||||
from ansible.module_utils.f5_utils import HAS_F5SDK
|
||||
from ansible.module_utils.f5_utils import F5ModuleError
|
||||
|
||||
try:
|
||||
from ansible.module_utils.f5_utils import iControlUnexpectedHTTPError
|
||||
except ImportError:
|
||||
HAS_F5SDK = False
|
||||
|
||||
|
||||
class Parameters(AnsibleF5Parameters):
|
||||
download_path = '/var/config/rest/downloads'
|
||||
|
||||
api_map = {
|
||||
'sourcePath': 'key_source_path'
|
||||
}
|
||||
|
||||
updatables = ['key_source_path']
|
||||
|
||||
returnables = ['key_filename', 'key_checksum', 'key_source_path']
|
||||
|
||||
api_attributes = ['passphrase', 'sourcePath']
|
||||
|
||||
def to_return(self):
|
||||
result = {}
|
||||
try:
|
||||
for returnable in self.returnables:
|
||||
result[returnable] = getattr(self, returnable)
|
||||
result = self._filter_params(result)
|
||||
except Exception:
|
||||
pass
|
||||
return result
|
||||
|
||||
def api_params(self):
|
||||
result = {}
|
||||
for api_attribute in self.api_attributes:
|
||||
if self.api_map is not None and api_attribute in self.api_map:
|
||||
result[api_attribute] = getattr(self, self.api_map[api_attribute])
|
||||
else:
|
||||
result[api_attribute] = getattr(self, api_attribute)
|
||||
result = self._filter_params(result)
|
||||
return result
|
||||
|
||||
def _get_hash(self, content):
|
||||
k = hashlib.sha1()
|
||||
s = StringIO(content)
|
||||
while True:
|
||||
data = s.read(1024)
|
||||
if not data:
|
||||
break
|
||||
k.update(data.encode('utf-8'))
|
||||
return k.hexdigest()
|
||||
|
||||
@property
|
||||
def key_filename(self):
|
||||
fname, fext = os.path.splitext(self.name)
|
||||
if fext == '':
|
||||
return fname + '.key'
|
||||
else:
|
||||
return self.name
|
||||
|
||||
@property
|
||||
def key_checksum(self):
|
||||
if self.content is None:
|
||||
return None
|
||||
return self._get_hash(self.content)
|
||||
|
||||
@property
|
||||
def key_source_path(self):
|
||||
result = 'file://' + os.path.join(
|
||||
self.download_path,
|
||||
self.key_filename
|
||||
)
|
||||
return result
|
||||
|
||||
@property
|
||||
def checksum(self):
|
||||
if self._values['checksum'] is None:
|
||||
return None
|
||||
pattern = r'SHA1:\d+:(?P<value>[\w+]{40})'
|
||||
matches = re.match(pattern, self._values['checksum'])
|
||||
if matches:
|
||||
return matches.group('value')
|
||||
else:
|
||||
return None
|
||||
|
||||
|
||||
class ModuleManager(object):
|
||||
def __init__(self, client):
|
||||
self.client = client
|
||||
self.have = None
|
||||
self.want = Parameters(self.client.module.params)
|
||||
self.changes = Parameters()
|
||||
|
||||
def exec_module(self):
|
||||
changed = False
|
||||
result = dict()
|
||||
state = self.want.state
|
||||
|
||||
try:
|
||||
if state == "present":
|
||||
changed = self.present()
|
||||
elif state == "absent":
|
||||
changed = self.absent()
|
||||
except iControlUnexpectedHTTPError as e:
|
||||
raise F5ModuleError(str(e))
|
||||
|
||||
changes = self.changes.to_return()
|
||||
result.update(**changes)
|
||||
result.update(dict(changed=changed))
|
||||
return result
|
||||
|
||||
def _set_changed_options(self):
|
||||
changed = {}
|
||||
try:
|
||||
for key in Parameters.returnables:
|
||||
if getattr(self.want, key) is not None:
|
||||
changed[key] = getattr(self.want, key)
|
||||
if changed:
|
||||
self.changes = Parameters(changed)
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
def _update_changed_options(self):
|
||||
changed = {}
|
||||
try:
|
||||
for key in Parameters.updatables:
|
||||
if getattr(self.want, key) is not None:
|
||||
attr1 = getattr(self.want, key)
|
||||
attr2 = getattr(self.have, key)
|
||||
if attr1 != attr2:
|
||||
changed[key] = attr1
|
||||
if self.want.key_checksum != self.have.checksum:
|
||||
changed['key_checksum'] = self.want.key_checksum
|
||||
if changed:
|
||||
self.changes = Parameters(changed)
|
||||
return True
|
||||
except Exception:
|
||||
pass
|
||||
return False
|
||||
|
||||
def should_update(self):
|
||||
result = self._update_changed_options()
|
||||
if result:
|
||||
return True
|
||||
return False
|
||||
|
||||
def update_on_device(self):
|
||||
content = StringIO(self.want.content)
|
||||
self.client.api.shared.file_transfer.uploads.upload_stringio(
|
||||
content, self.want.key_filename
|
||||
)
|
||||
resource = self.client.api.tm.sys.file.ssl_keys.ssl_key.load(
|
||||
name=self.want.key_filename,
|
||||
partition=self.want.partition
|
||||
)
|
||||
resource.update()
|
||||
|
||||
def exists(self):
|
||||
result = self.client.api.tm.sys.file.ssl_keys.ssl_key.exists(
|
||||
name=self.want.key_filename,
|
||||
partition=self.want.partition
|
||||
)
|
||||
return result
|
||||
|
||||
def present(self):
|
||||
if self.exists():
|
||||
return self.update()
|
||||
else:
|
||||
return self.create()
|
||||
|
||||
def create(self):
|
||||
if self.want.content is None:
|
||||
return False
|
||||
self._set_changed_options()
|
||||
if self.client.check_mode:
|
||||
return True
|
||||
self.create_on_device()
|
||||
return True
|
||||
|
||||
def read_current_from_device(self):
|
||||
resource = self.client.api.tm.sys.file.ssl_keys.ssl_key.load(
|
||||
name=self.want.key_filename,
|
||||
partition=self.want.partition
|
||||
)
|
||||
result = resource.attrs
|
||||
return Parameters(result)
|
||||
|
||||
def update(self):
|
||||
self.have = self.read_current_from_device()
|
||||
if not self.should_update():
|
||||
return False
|
||||
if self.client.check_mode:
|
||||
return True
|
||||
self.update_on_device()
|
||||
return True
|
||||
|
||||
def create_on_device(self):
|
||||
content = StringIO(self.want.content)
|
||||
self.client.api.shared.file_transfer.uploads.upload_stringio(
|
||||
content, self.want.key_filename
|
||||
)
|
||||
self.client.api.tm.sys.file.ssl_keys.ssl_key.create(
|
||||
sourcePath=self.want.key_source_path,
|
||||
name=self.want.key_filename,
|
||||
partition=self.want.partition
|
||||
)
|
||||
|
||||
def absent(self):
|
||||
if self.exists():
|
||||
return self.remove()
|
||||
return False
|
||||
|
||||
def remove_from_device(self):
|
||||
resource = self.client.api.tm.sys.file.ssl_keys.ssl_key.load(
|
||||
name=self.want.key_filename,
|
||||
partition=self.want.partition
|
||||
)
|
||||
resource.delete()
|
||||
|
||||
def remove(self):
|
||||
if self.client.check_mode:
|
||||
return True
|
||||
self.remove_from_device()
|
||||
if self.exists():
|
||||
raise F5ModuleError("Failed to delete the key")
|
||||
return True
|
||||
|
||||
|
||||
class ArgumentSpec(object):
|
||||
def __init__(self):
|
||||
self.supports_check_mode = True
|
||||
self.argument_spec = dict(
|
||||
name=dict(
|
||||
required=True
|
||||
),
|
||||
content=dict(
|
||||
aliases=['key_content']
|
||||
),
|
||||
passphrase=dict(
|
||||
no_log=True
|
||||
),
|
||||
state=dict(
|
||||
required=False,
|
||||
default='present',
|
||||
choices=['absent', 'present']
|
||||
)
|
||||
)
|
||||
self.f5_product_name = 'bigip'
|
||||
|
||||
|
||||
def main():
|
||||
if not HAS_F5SDK:
|
||||
raise F5ModuleError("The python f5-sdk module is required")
|
||||
|
||||
spec = ArgumentSpec()
|
||||
|
||||
client = AnsibleF5Client(
|
||||
argument_spec=spec.argument_spec,
|
||||
supports_check_mode=spec.supports_check_mode,
|
||||
f5_product_name=spec.f5_product_name
|
||||
)
|
||||
|
||||
try:
|
||||
mm = ModuleManager(client)
|
||||
results = mm.exec_module()
|
||||
client.module.exit_json(**results)
|
||||
except F5ModuleError as e:
|
||||
client.module.fail_json(msg=str(e))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
121
test/units/modules/network/f5/test_bigip_ssl_key.py
Normal file
121
test/units/modules/network/f5/test_bigip_ssl_key.py
Normal file
|
|
@ -0,0 +1,121 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Copyright (c) 2017 F5 Networks Inc.
|
||||
# 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
|
||||
|
||||
import os
|
||||
import json
|
||||
import sys
|
||||
|
||||
from nose.plugins.skip import SkipTest
|
||||
if sys.version_info < (2, 7):
|
||||
raise SkipTest("F5 Ansible modules require Python >= 2.7")
|
||||
|
||||
from ansible.compat.tests import unittest
|
||||
from ansible.module_utils import basic
|
||||
from ansible.compat.tests.mock import patch, Mock
|
||||
from ansible.module_utils._text import to_bytes
|
||||
from ansible.module_utils.f5_utils import AnsibleF5Client
|
||||
|
||||
try:
|
||||
from library.bigip_ssl_key import ArgumentSpec
|
||||
from library.bigip_ssl_key import Parameters
|
||||
from library.bigip_ssl_key import ModuleManager
|
||||
from library.bigip_ssl_key import HAS_F5SDK
|
||||
from ansible.module_utils.f5_utils import iControlUnexpectedHTTPError
|
||||
except ImportError:
|
||||
try:
|
||||
from ansible.modules.network.f5.bigip_ssl_key import ArgumentSpec
|
||||
from ansible.modules.network.f5.bigip_ssl_key import Parameters
|
||||
from ansible.modules.network.f5.bigip_ssl_key import ModuleManager
|
||||
from ansible.modules.network.f5.bigip_ssl_key import HAS_F5SDK
|
||||
from ansible.module_utils.f5_utils import iControlUnexpectedHTTPError
|
||||
except ImportError:
|
||||
raise SkipTest("F5 Ansible modules require the f5-sdk Python library")
|
||||
|
||||
fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures')
|
||||
fixture_data = {}
|
||||
|
||||
|
||||
def set_module_args(args):
|
||||
args = json.dumps({'ANSIBLE_MODULE_ARGS': args})
|
||||
basic._ANSIBLE_ARGS = to_bytes(args)
|
||||
|
||||
|
||||
def load_fixture(name):
|
||||
path = os.path.join(fixture_path, name)
|
||||
|
||||
if path in fixture_data:
|
||||
return fixture_data[path]
|
||||
|
||||
with open(path) as f:
|
||||
data = f.read()
|
||||
|
||||
try:
|
||||
data = json.loads(data)
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
fixture_data[path] = data
|
||||
return data
|
||||
|
||||
|
||||
class TestParameters(unittest.TestCase):
|
||||
def test_module_parameters_key(self):
|
||||
key_content = load_fixture('create_insecure_key1.key')
|
||||
args = dict(
|
||||
content=key_content,
|
||||
name="cert1",
|
||||
partition="Common",
|
||||
state="present",
|
||||
password='password',
|
||||
server='localhost',
|
||||
user='admin'
|
||||
)
|
||||
p = Parameters(args)
|
||||
assert p.name == 'cert1'
|
||||
assert p.key_filename == 'cert1.key'
|
||||
assert '-----BEGIN RSA PRIVATE KEY-----' in p.content
|
||||
assert '-----END RSA PRIVATE KEY-----' in p.content
|
||||
assert p.key_checksum == '91bdddcf0077e2bb2a0258aae2ae3117be392e83'
|
||||
assert p.state == 'present'
|
||||
assert p.user == 'admin'
|
||||
assert p.server == 'localhost'
|
||||
assert p.password == 'password'
|
||||
assert p.partition == 'Common'
|
||||
|
||||
|
||||
@patch('ansible.module_utils.f5_utils.AnsibleF5Client._get_mgmt_root',
|
||||
return_value=True)
|
||||
class TestModuleManager(unittest.TestCase):
|
||||
|
||||
def setUp(self):
|
||||
self.spec = ArgumentSpec()
|
||||
|
||||
def test_import_key_no_key_passphrase(self, *args):
|
||||
set_module_args(dict(
|
||||
name='foo',
|
||||
content=load_fixture('cert1.key'),
|
||||
state='present',
|
||||
password='password',
|
||||
server='localhost',
|
||||
user='admin'
|
||||
))
|
||||
|
||||
client = AnsibleF5Client(
|
||||
argument_spec=self.spec.argument_spec,
|
||||
supports_check_mode=self.spec.supports_check_mode,
|
||||
f5_product_name=self.spec.f5_product_name
|
||||
)
|
||||
|
||||
# Override methods in the specific type of manager
|
||||
cm = ModuleManager(client)
|
||||
cm.exists = Mock(side_effect=[False, True])
|
||||
cm.create_on_device = Mock(return_value=True)
|
||||
|
||||
results = cm.exec_module()
|
||||
|
||||
assert results['changed'] is True
|
||||
Loading…
Reference in a new issue