diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9ca390c --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.kitchen/* + diff --git a/.kitchen.yml b/.kitchen.yml new file mode 100644 index 0000000..a90c278 --- /dev/null +++ b/.kitchen.yml @@ -0,0 +1,26 @@ +--- +driver: + name: vagrant + provider: virtualbox + box: bento/debian-9.5 + +provisioner: + name: ansible_playbook + hosts: localhost + require_ansible_repo: false + require_ansible_omnibus: true + require_chef_for_busser: true + ansible_verbose: false + ansible_inventory: ./test/integration/inventory + +platforms: + - name: debian-9 + driver_config: + image: "nishiki/debian9:ansible-<%= ENV['ANSIBLE_VERSION'] ? ENV['ANSIBLE_VERSION'] : '2.7' %>" + command: /bin/systemd + volume: + - /sys/fs/cgroup:/sys/fs/cgroup:ro + security_opt: seccomp=unconfined + +suites: + - name: default diff --git a/.rubocop.yml b/.rubocop.yml new file mode 100644 index 0000000..66555b6 --- /dev/null +++ b/.rubocop.yml @@ -0,0 +1,38 @@ +--- +AllCops: + Exclude: + - db/**/* + - config/**/* + - Vagrantfile + TargetRubyVersion: 2.4 + +Naming/AccessorMethodName: + Enabled: false + +Lint/RescueWithoutErrorClass: + Enabled: false + +Metrics/LineLength: + Max: 120 +Metrics/CyclomaticComplexity: + Enabled: false +Metrics/PerceivedComplexity: + Enabled: false +Metrics/MethodLength: + Enabled: false +Metrics/BlockLength: + Enabled: false +Metrics/ClassLength: + Enabled: false +Metrics/AbcSize: + Enabled: false + +Style/NumericLiteralPrefix: + Enabled: false +Style/FrozenStringLiteralComment: + Enabled: false +Style/CommandLiteral: + Enabled: true + EnforcedStyle: percent_x +Style/Documentation: + Enabled: false diff --git a/.yamllint b/.yamllint new file mode 100644 index 0000000..5465b58 --- /dev/null +++ b/.yamllint @@ -0,0 +1,12 @@ +--- +extends: default + +ignore: | + .kitchen/* + vendor/ + +rules: + line-length: + max: 120 + level: warning + truthy: false diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..190d06e --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# CHANGELOG + +This project adheres to [Semantic Versioning](http://semver.org/). +Which is based on [Keep A Changelog](http://keepachangelog.com/) + +## [Unreleased] +- first version diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..edffe52 --- /dev/null +++ b/Gemfile @@ -0,0 +1,8 @@ +source 'https://rubygems.org' + +group :development do + gem 'kitchen-ansible' + gem 'kitchen-vagrant' + gem 'rubocop', '0.50.0' + gem 'test-kitchen' +end diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 0000000..712f92d --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,92 @@ +GEM + remote: https://rubygems.org/ + specs: + ast (2.4.0) + builder (3.2.3) + erubis (2.7.0) + ffi (1.10.0) + gssapi (1.2.0) + ffi (>= 1.0.1) + gyoku (1.3.1) + builder (>= 2.1.2) + httpclient (2.8.3) + kitchen-ansible (0.49.1) + net-ssh (>= 3) + test-kitchen (~> 1.4) + kitchen-vagrant (1.5.0) + test-kitchen (~> 1.4) + little-plugger (1.1.4) + logging (2.2.2) + little-plugger (~> 1.1) + multi_json (~> 1.10) + mixlib-install (3.11.11) + mixlib-shellout + mixlib-versioning + thor + mixlib-shellout (2.4.4) + mixlib-versioning (1.2.7) + multi_json (1.13.1) + net-scp (1.2.1) + net-ssh (>= 2.6.5) + net-ssh (4.2.0) + net-ssh-gateway (1.3.0) + net-ssh (>= 2.6.5) + nori (2.6.0) + parallel (1.14.0) + parser (2.6.0.0) + ast (~> 2.4.0) + powerpack (0.1.2) + rainbow (2.2.2) + rake + rake (12.3.2) + rubocop (0.50.0) + parallel (~> 1.10) + parser (>= 2.3.3.1, < 3.0) + powerpack (~> 0.1) + rainbow (>= 2.2.2, < 3.0) + ruby-progressbar (~> 1.7) + unicode-display_width (~> 1.0, >= 1.0.1) + ruby-progressbar (1.10.0) + rubyntlm (0.6.2) + rubyzip (1.2.2) + test-kitchen (1.24.0) + mixlib-install (~> 3.6) + mixlib-shellout (>= 1.2, < 3.0) + net-scp (~> 1.1) + net-ssh (>= 2.9, < 5.0) + net-ssh-gateway (~> 1.2) + thor (~> 0.19) + winrm (~> 2.0) + winrm-elevated (~> 1.0) + winrm-fs (~> 1.1) + thor (0.20.3) + unicode-display_width (1.5.0) + winrm (2.3.1) + builder (>= 2.1.2) + erubis (~> 2.7) + gssapi (~> 1.2) + gyoku (~> 1.0) + httpclient (~> 2.2, >= 2.2.0.2) + logging (>= 1.6.1, < 3.0) + nori (~> 2.0) + rubyntlm (~> 0.6.0, >= 0.6.1) + winrm-elevated (1.1.1) + winrm (~> 2.0) + winrm-fs (~> 1.0) + winrm-fs (1.3.2) + erubis (~> 2.7) + logging (>= 1.6.1, < 3.0) + rubyzip (~> 1.1) + winrm (~> 2.0) + +PLATFORMS + ruby + +DEPENDENCIES + kitchen-ansible + kitchen-vagrant + rubocop (= 0.50.0) + test-kitchen + +BUNDLED WITH + 1.16.0 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..afe21bd --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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 2019 Adrien Waksberg + + 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.md b/README.md new file mode 100644 index 0000000..174ff47 --- /dev/null +++ b/README.md @@ -0,0 +1,71 @@ +# Ansible role: Luks +[![Version](https://img.shields.io/badge/latest_version-0.0.0-green.svg)](https://git.yaegashi.fr/nishiki/ansible-role-luks/releases) +[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://git.yaegashi.fr/nishiki/ansible-role-luks/src/branch/master/LICENSE) + +Encrypt device with luks + +## Requirements + +* Ansible >= 2.5 +* Debian Stretch + +## Role variables + +* `luks_devices` - array with the devices to encrypt + +``` + - name: data_encrypted + device: /dev/sdx2 + mount_point: /mnt/data_decrypted + fstype: ext4 + cipher: aes-xts-plain + size: 256 + key: secret +``` + +## How to use + +``` +- hosts: data + roles: + - luks +``` + +## Development +### Test syntax with yamllint + +* install `python` and `python-pip` +* install yamllint `pip install yamllint` +* run `yamllint .` + +### Test syntax with ansible-lint + +* install `python` and `python-pip` +* install yamllint `pip install ansible-lint` +* run `ansible-lint .` + +### Tests with docker + +* install [docker](https://docs.docker.com/engine/installation/) +* install ruby +* install bundler `gem install bundler` +* install dependencies `bundle install` +* run the tests `kitchen test` + +## License + +``` +Copyright (c) 2019 Adrien Waksberg + +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/defaults/main.yml b/defaults/main.yml new file mode 100644 index 0000000..19ee2a7 --- /dev/null +++ b/defaults/main.yml @@ -0,0 +1,2 @@ +--- +luks_devices: [] diff --git a/library/luks_decrypt.py b/library/luks_decrypt.py new file mode 100644 index 0000000..01d7682 --- /dev/null +++ b/library/luks_decrypt.py @@ -0,0 +1,53 @@ +#!/usr/bin/python + +from ansible.module_utils.basic import * +import subprocess +import os + +class LuksDecrypt: + def __init__(self, name, device): + self.name = name + self.device = device + + def is_luks(self): + if subprocess.call(['cryptsetup', 'isLuks', self.device]) == 0: + return True + else: + return False + + def is_decrypted(self): + return os.path.exists('/dev/mapper/{}'.format(self.name)) + + def decrypt(self, key): + p = subprocess.Popen( + [ + 'cryptsetup', '-q', 'open', '-d', '-', self.device, self.name + ], stdin=subprocess.PIPE + ) + p.stdin.write(key) + p.communicate()[0] + p.stdin.close() + + if p.returncode != 0: + raise ValueError('Error during the decrypt of device {}'.format(self.device)) + +def main(): + fields = { + 'name': { 'type': 'str', 'required': True }, + 'device': { 'type': 'str', 'required': True }, + 'key': { 'type': 'str', 'required': True } + } + module = AnsibleModule(argument_spec=fields) + changed = False + + luks = LuksDecrypt(module.params['name'], module.params['device']) + if not luks.is_luks(): + raise ValueError('Error the device {} is not a LUKS device'.format(module.params['device'])) + elif not luks.is_decrypted(): + luks.decrypt(module.params['key']) + changed = True + + module.exit_json(changed=changed) + +if __name__ == '__main__': + main() diff --git a/library/luks_manage.py b/library/luks_manage.py new file mode 100644 index 0000000..2219a91 --- /dev/null +++ b/library/luks_manage.py @@ -0,0 +1,52 @@ +#!/usr/bin/python + +from ansible.module_utils.basic import * +import subprocess + +class LuksManage: + def __init__(self, device): + self.device = device + + def is_luks(self): + if subprocess.call(['cryptsetup', 'isLuks', self.device]) == 0: + return True + else: + return False + + def create(self, cipher, size, key): + p = subprocess.Popen( + [ + 'cryptsetup', '-q', 'luksFormat', '-c', cipher, + '-s', str(size), self.device, '-d', '-' + ], stdin=subprocess.PIPE + ) + p.stdin.write(key) + p.communicate()[0] + p.stdin.close() + + if p.returncode != 0: + raise ValueError('Error to create the luks device {}'.format(self.device)) + +def main(): + fields = { + 'device': { 'type': 'str', 'required': True }, + 'cipher': { 'type': 'str', 'default': 'aes-xts-plain' }, + 'size': { 'type': 'int', 'default': 256 }, + 'key': { 'type': 'str', 'required': True } + } + module = AnsibleModule(argument_spec=fields) + changed = False + + luks = LuksManage(module.params['device']) + if not luks.is_luks(): + luks.create( + module.params['cipher'], + module.params['size'], + module.params['key'] + ) + changed = True + + module.exit_json(changed=changed) + +if __name__ == '__main__': + main() diff --git a/tasks/main.yml b/tasks/main.yml new file mode 100644 index 0000000..67972c9 --- /dev/null +++ b/tasks/main.yml @@ -0,0 +1,49 @@ +--- +- name: install packages + package: + name: '{{ packages }}' + vars: + packages: + - cryptsetup + - util-linux + register: result + retries: 3 + delay: 1 + until: result is success + tags: luks + +- name: create luks device + luks_manage: + device: '{{ item.device }}' + cipher: '{{ item.cipher|default("aes-xts-plain") }}' + size: '{{ item.size|default(256) }}' + key: '{{ item.key }}' + loop: '{{ luks_devices }}' + no_log: true + tags: luks + +- name: decrypt luks device + luks_decrypt: + device: '{{ item.device }}' + name: '{{ item.name }}' + key: '{{ item.key }}' + loop: '{{ luks_devices }}' + no_log: true + tags: luks + +- name: format partition + filesystem: + fstype: '{{ item.fstype }}' + dev: '/dev/mapper/{{ item.name }}' + loop: '{{ luks_devices }}' + tags: luks + +- name: mount partition + mount: + src: '/dev/mapper/{{ item.name }}' + path: '{{ item.mount_point }}' + fstype: '{{ item.fstype }}' + opts: noauto + state: mounted + loop: '{{ luks_devices }}' + tags: luks diff --git a/test/integration/default/default.yml b/test/integration/default/default.yml new file mode 100644 index 0000000..83891e7 --- /dev/null +++ b/test/integration/default/default.yml @@ -0,0 +1,21 @@ +--- +- hosts: localhost + connection: local + vars: + luks_devices: + - name: data_encrypted + device: /tmp/test.img + fstype: ext4 + mount_point: /mnt/data_decrypted + key: secret + + pre_tasks: + - stat: + path: /tmp/test.img + register: st + + - command: dd if=/dev/zero of=/tmp/test.img bs=1M count=100 + when: not st.stat.exists + + roles: + - ansible-role-luks diff --git a/test/integration/default/serverspec/default_spec.rb b/test/integration/default/serverspec/default_spec.rb new file mode 100644 index 0000000..04d4007 --- /dev/null +++ b/test/integration/default/serverspec/default_spec.rb @@ -0,0 +1,25 @@ +require 'serverspec' + +set :backend, :exec + +puts +puts '================================' +puts %x(ansible --version) +puts '================================' + +%w[ + cryptsetup + util-linux +].each do |package| + describe package(package) do + it { should be_installed } + end +end + +describe file('/dev/mapper/data_encrypted') do + it { should be_block_device } +end + +describe file('/mnt/data_decrypted') do + it { should be_mounted } +end diff --git a/test/integration/inventory b/test/integration/inventory new file mode 100644 index 0000000..2fbb50c --- /dev/null +++ b/test/integration/inventory @@ -0,0 +1 @@ +localhost