From aa1e6aa1da4b5ec9fe2f39a9516ff5cb975f40b9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Douglas=20Mendiz=C3=A1bal?= Date: Fri, 4 Jan 2019 11:08:37 -0600 Subject: [PATCH] Initial commit. --- AUTHORS | 2 + LICENSE | 202 +++++++++++++++++++++++++++++++++++++++++++++++ README.rst | 9 +++ files/add_ips.py | 159 +++++++++++++++++++++++++++++++++++++ tasks/main.yaml | 102 ++++++++++++++++++++++++ tasks/rfs.yaml | 14 ++++ 6 files changed, 488 insertions(+) create mode 100644 AUTHORS create mode 100644 LICENSE create mode 100644 README.rst create mode 100644 files/add_ips.py create mode 100644 tasks/main.yaml create mode 100644 tasks/rfs.yaml diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..baf0e41 --- /dev/null +++ b/AUTHORS @@ -0,0 +1,2 @@ +Ade Lee +Douglas Mendizábal diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..c151139 --- /dev/null +++ b/README.rst @@ -0,0 +1,9 @@ +thales-hsm +========== + +A role to manage Thales Hardware Security Module (HSM) client software. + +Requirements +------------ + + - ansible >= 2.4 diff --git a/files/add_ips.py b/files/add_ips.py new file mode 100644 index 0000000..e560d54 --- /dev/null +++ b/files/add_ips.py @@ -0,0 +1,159 @@ +#!/usr/bin/python +# +# Copyright 2018 Red Hat, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +import argparse +import os +import sys + + +def write_new_conf(directory, addresses): + """Write a new Thales HSM configuration file + + This function reads a file called `config` in the given directory, + adds the given list of addresses to the [hs_clients] section and + writes the result in the `config.new` file. + + If an existing `config.new` file is found, it is backed up as + `config.new.X` where X is the next available integer starting from + zero. + + For example, given addresses=['192.168.24.10'], a new client config + entry will be added to the config file including the client delimiter + (-----) and other required options: + + syntax-version=1 + [server_settings] + + # --- snip --- + + [hs_clients] + addr=EXISTING_IP_ADDRESS + clientperm=priv + keyhash=0000000000000000000000000000000000000000 + esn= + timelimit=86400 + datalimit=8388608 + ----- + addr=192.168.24.10 + clientperm=priv + keyhash=0000000000000000000000000000000000000000 + esn= + timelimit=86400 + datalimit=8388608 + + # --- snip --- + + Although the file looks a lot like an ini, we're not able to use + configparse due to the required syntax-version declaration, + the ----- delimiters, and the reused config options for every client + entry. + + """ + # parse config file into 3 sections + before_config = list() + client_config = list() + after_config = list() + + conf = os.path.join(directory, 'config') + + with open(conf) as f: + lines = f.readlines() + + for line in lines: + if after_config: + after_config.append(line) + continue + if "[hs_clients]" in line: + client_config.append(line) + continue + if client_config: + if line.startswith('['): + after_config.append(line) + else: + client_config.append(line) + continue + before_config.append(line) + + # move trailing empty lines from client config to after config + while client_config[-1] == '\n': + after_config.insert(0, client_config.pop()) + + # list configured adresses + configured_ips = list() + for line in client_config: + if line.startswith("addr"): + configured_ips.append(line.strip('\n').split('=')[1]) + + # skip addresses that have already been configured + new_ips = list() + for addr in addresses: + if addr in configured_ips: + continue + new_ips.append(addr) + + if not new_ips: + # nothing to do + sys.exit(0) + + new_entries = list() + for addr in new_ips: + new_entries += [ + '-----\n', + 'addr={}\n'.format(addr), + 'clientperm=priv\n', + 'keyhash=0000000000000000000000000000000000000000\n', + 'esn=\n', + 'timelimit=86400\n', + 'datalimit=8388608\n', + ] + + new_conf = os.path.join(directory, 'config.new') + + if os.path.exists(new_conf): + next = 0 + while os.path.exists(os.path.join(directory, + ('config.new.' + str(next)))): + next += 1 + os.rename(new_conf, + os.path.join(directory, ('config.new.' + str(next)))) + + with open(new_conf, 'w') as f: + for line in (before_config + client_config + + new_entries + after_config): + f.write(line) + sys.exit(0) + + +if __name__ == '__main__': + parser = argparse.ArgumentParser() + parser.add_argument("--config-dir", help="Path to the directory that " + "contains the config file.") + + group = parser.add_mutually_exclusive_group(required=True) + group.add_argument("--ips", nargs="+", + help="One or more IP addresses to be added " + "to the config file.") + group.add_argument("--file", help="Path to file containing IP addresses " + "to be added to the config file.") + args = parser.parse_args() + + if args.file: + with open(args.file, 'r') as f: + ips = f.readlines() + ips = [ip.strip('\n') for ip in ips] + else: + ips = args.ips + + write_new_conf(args.config_dir, ips) diff --git a/tasks/main.yaml b/tasks/main.yaml new file mode 100644 index 0000000..5ea6c0d --- /dev/null +++ b/tasks/main.yaml @@ -0,0 +1,102 @@ +--- +- name: Create working directory + file: + path: "{{thales_client_working_dir}}" + state: directory + mode: 0755 + +- name: create thales group + group: + name: nfast + gid: "{{thales_client_gid}}" + +- name: create thales user + user: + name: nfast + uid: "{{thales_client_uid}}" + group: "{{thales_client_gid}}" + create_home: true + home: /opt/nfast + +- name: Download Thales client tarball + get_url: + url: "{{thales_client_tarball_location}}" + dest: "{{thales_client_working_dir}}/{{thales_client_tarball_name}}" + force: no + +- name: Unpack tarball to working directory + unarchive: + src: "{{thales_client_working_dir}}/{{thales_client_tarball_name}}" + dest: "{{thales_client_working_dir}}" + creates: "{{thales_client_working_dir}}/{{thales_client_path}}" + remote_src: yes + +- name: Unpack tarball to /opt/nfast + shell: | + for i in `find "{{thales_client_working_dir}}/{{thales_client_path}}" -name *.tar` ; do + tar -C / -xvf $i ; + done + args: + creates: /opt/nfast/sbin/install + +- name: run installer + shell: echo "1" | /opt/nfast/sbin/install + args: + creates: /opt/nfast/kmdata + +- name: Get the security world data + get_url: + url: "{{thales_km_data_location}}" + dest: "/root/{{thales_km_data_tarball_name}}" + force: no + +- name: remove the old km_data + file: + path: /opt/nfast/kmdata + state: absent + +- name: replace kmdata + unarchive: + src: "/root/{{thales_km_data_tarball_name}}" + dest: /opt/nfast + remote_src: yes + +- name: run anonkneti to get hash + command: /opt/nfast/bin/anonkneti "{{thales_hsm_ip_address}}" + register: anonkneti + +- name: output of anonkneti + debug: var=anonkneti.stdout_lines + +- name: create cknfastrc + copy: + dest: /opt/nfast/cknfastrc + content: | + CKNFAST_OVERRIDE_SECURITY_ASSURANCES=explicitness + force: no + +- name: create snmp.conf + copy: + dest: /opt/nfast/etc/snmp/snmp.conf + content: | + defaultPort 21161 + force: yes + +- name: enroll client to HSM + command: /opt/nfast/bin/nethsmenroll --force {{thales_hsm_ip_address}} {{anonkneti.stdout_lines[0]}} + +- name: set selinux contexts for /opt/nfast + command: restorecon -R /opt/nfast + +- name: restart hardserver + command: /opt/nfast/sbin/init.d-ncipher restart + +- name: do an enquiry to confirm connection + command: /opt/nfast/bin/enquiry + register: enquiry + +- name: enquiry result + debug: var=enquiry + +- name: set up rfs_sync + command: /opt/nfast/bin/rfs-sync --setup --no-authenticate {{thales_rfs_server_ip_address}} diff --git a/tasks/rfs.yaml b/tasks/rfs.yaml new file mode 100644 index 0000000..3ef2792 --- /dev/null +++ b/tasks/rfs.yaml @@ -0,0 +1,14 @@ +--- +# This role adds a new IP address to the RFS conf file + +- name: run script to add {{thales_client_ips}} to config.new + script: "{{role_path}}/files/add_ips.py --config-dir /opt/nfast/kmdata/{{thales_hsm_config_location}}/config --ips {{thales_client_ips}}" + +- name: push new config to the HSM and check that it was successful + shell: "/opt/nfast/bin/cfg-pushnethsm -a {{thales_hsm_ip_address}} /opt/nfast/kmdata/{{thales_hsm_config_location}}/config/config.new && sleep 5 && diff /opt/nfast/kmdata/{{thales_hsm_config_location}}/config/config /opt/nfast/kmdata/{{thales_hsm_config_location}}/config/config.new" + register: result + until: result.rc == 0 + retries: 10 + +- name: allow bootstrap server to update the RFS server + command: "/opt/nfast/bin/rfs-setup --gang-client --write-noauth {{thales_bootstrap_client_ip}}"