From cb41f1809795037fbf79f0ee057ca970ca248171 Mon Sep 17 00:00:00 2001 From: vincent Date: Tue, 24 Nov 2020 21:15:55 +0100 Subject: [PATCH] chisel role creation --- .travis.yml | 29 +++++++++++++++++ README.md | 38 ++++++++++++++++++++++ defaults/main.yml | 15 +++++++++ handlers/main.yml | 12 +++++++ meta/main.yml | 51 ++++++++++++++++++++++++++++++ tasks/main.yml | 49 ++++++++++++++++++++++++++++ tasks/setup-Archlinux.yml | 8 +++++ templates/chisel-server.conf.j2 | 13 ++++++++ templates/chisel-server.service.j2 | 14 ++++++++ tests/inventory | 2 ++ tests/test.yml | 5 +++ vars/Archlinux.yml | 8 +++++ vars/main.yml | 2 ++ 13 files changed, 246 insertions(+) create mode 100644 .travis.yml create mode 100644 README.md create mode 100644 defaults/main.yml create mode 100644 handlers/main.yml create mode 100644 meta/main.yml create mode 100644 tasks/main.yml create mode 100644 tasks/setup-Archlinux.yml create mode 100644 templates/chisel-server.conf.j2 create mode 100644 templates/chisel-server.service.j2 create mode 100644 tests/inventory create mode 100644 tests/test.yml create mode 100644 vars/Archlinux.yml create mode 100644 vars/main.yml diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..36bbf62 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,29 @@ +--- +language: python +python: "2.7" + +# Use the new container infrastructure +sudo: false + +# Install ansible +addons: + apt: + packages: + - python-pip + +install: + # Install ansible + - pip install ansible + + # Check ansible version + - ansible --version + + # Create ansible.cfg with correct roles_path + - printf '[defaults]\nroles_path=../' >ansible.cfg + +script: + # Basic role syntax check + - ansible-playbook tests/test.yml -i tests/inventory --syntax-check + +notifications: + webhooks: https://galaxy.ansible.com/api/v1/notifications/ \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..225dd44 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +Role Name +========= + +A brief description of the role goes here. + +Requirements +------------ + +Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required. + +Role Variables +-------------- + +A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. + +Dependencies +------------ + +A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles. + +Example Playbook +---------------- + +Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too: + + - hosts: servers + roles: + - { role: username.rolename, x: 42 } + +License +------- + +BSD + +Author Information +------------------ + +An optional section for the role authors to include contact information, or a website (HTML is not allowed). diff --git a/defaults/main.yml b/defaults/main.yml new file mode 100644 index 0000000..7b8b654 --- /dev/null +++ b/defaults/main.yml @@ -0,0 +1,15 @@ +--- +# defaults file for ansible-role-chisel + +chisel_server: false +chisel_server_enable: True +chisel_server_host: 127.0.0.1 +chisel_server_port: 8080 +chisel_server_socks5: true +chisel_server_reverse: true +chisel_server_backend: +chisel_server_auth: +#chisel_server_auth: +# user: toto +# pass: tata +chisel_server_key: \ No newline at end of file diff --git a/handlers/main.yml b/handlers/main.yml new file mode 100644 index 0000000..84ad661 --- /dev/null +++ b/handlers/main.yml @@ -0,0 +1,12 @@ +--- +# handlers file for ansible-role-chisel +- name: "restart daemon service" + service: + name: chisel-server + state: restarted + when: ansible_service_mgr == "systemd" + +- name: Reload systemd + systemd: + daemon_reload: yes + when: ansible_service_mgr == "systemd" diff --git a/meta/main.yml b/meta/main.yml new file mode 100644 index 0000000..40912fa --- /dev/null +++ b/meta/main.yml @@ -0,0 +1,51 @@ +galaxy_info: + author: VincentDcmps + description: your role description + + # If the issue tracker for your role is not on github, uncomment the + # next line and provide a value + # issue_tracker_url: http://example.com/issue/tracker + + # Choose a valid license ID from https://spdx.org - some suggested licenses: + # - BSD-3-Clause (default) + # - MIT + # - GPL-2.0-or-later + # - GPL-3.0-only + # - Apache-2.0 + # - CC-BY-4.0 + license: license (GPL-2.0-or-later, MIT, etc) + + min_ansible_version: 2.1 + + # If this a Container Enabled role, provide the minimum Ansible Container version. + # min_ansible_container_version: + + # + # Provide a list of supported platforms, and for each platform a list of versions. + # If you don't wish to enumerate all versions for a particular platform, use 'all'. + # To view available platforms and versions (or releases), visit: + # https://galaxy.ansible.com/api/v1/platforms/ + # + # platforms: + # - name: Fedora + # versions: + # - all + # - 25 + # - name: SomePlatform + # versions: + # - all + # - 1.0 + # - 7 + # - 99.99 + + galaxy_tags: [] + # List tags for your role here, one per line. A tag is a keyword that describes + # and categorizes the role. Users find roles by searching for tags. Be sure to + # remove the '[]' above, if you add tags to this list. + # + # NOTE: A tag is limited to a single word comprised of alphanumeric characters. + # Maximum 20 tags per role. + +dependencies: [] + # List your role dependencies here, one per line. Be sure to remove the '[]' above, + # if you add dependencies to this list. diff --git a/tasks/main.yml b/tasks/main.yml new file mode 100644 index 0000000..62da5f5 --- /dev/null +++ b/tasks/main.yml @@ -0,0 +1,49 @@ +--- +# tasks file for ansible-role-chisel + +# Variable setup. +- name: Include OS-specific variables. + include_vars: "{{ ansible_os_family }}.yml" + + +- include_tasks: setup-Archlinux.yml + when: ansible_os_family == 'Archlinux' + +- name: create chisel service group + group: + name: "{{chisel_group}}" + state: present + when: chisel_server == true + +- name: create chisel service user + user: + name: "{{chisel_user}}" + group: "{{chisel_group}}" + shell: /sbin/nologin + append: yes + state: present + create_home: no + when: chisel_server == true + +- name: apply chisel server config template + template: + src: chisel-server.conf.j2 + dest: "{{ chisel_config_location }}/chisel-server.conf" + notify: + - restart daemon service + when: chisel_server == true + +- name: apply chisel systemd template + template: + dest: "{{ chisel_systemd_location }}/chisel-server.service" + src: chisel-server.service.j2 + notify: + - Reload systemd + - restart daemon service + when: chisel_server == true + +- name: enable chisel server + service: + name: chisel-server # required. Name of the service. + enabled: true # not required. Whether the service should start on boot. B(At least one of state and enabled are required.) + state: started # not required. choices: reloaded;restarted;started;stopped. C(started)/C(stopped) are idempotent actions that will not run commands unless necessary. C(restarted) will always bounce the service. C(reloaded) will always reload. B(At least one of state and enabled are required.) Note that reloaded will start the service if it is not already started, even if your chosen init system wouldn't normally. diff --git a/tasks/setup-Archlinux.yml b/tasks/setup-Archlinux.yml new file mode 100644 index 0000000..1a56b04 --- /dev/null +++ b/tasks/setup-Archlinux.yml @@ -0,0 +1,8 @@ + +- name: install chisel AUR package + aur: + name: "{{chisel_package_name}}" + state: present + become: yes + become_user: "{{chisel_install_user}}" + \ No newline at end of file diff --git a/templates/chisel-server.conf.j2 b/templates/chisel-server.conf.j2 new file mode 100644 index 0000000..a79203a --- /dev/null +++ b/templates/chisel-server.conf.j2 @@ -0,0 +1,13 @@ +{% if chisel_server_host %} +HOST={{chisel_server_host}} +{% endif %} +{% if chisel_server_port %} +PORT={{chisel_server_port}} +{% endif %} +{% if chisel_server_auth %} +AUTH={{chisel_server_auth.user}}:{{chisel_server_auth.pass}} +{% endif %} +chisel_server_key +{% if chisel_server_key %} +KEY={{chisel_server_key}} +{% endif %} \ No newline at end of file diff --git a/templates/chisel-server.service.j2 b/templates/chisel-server.service.j2 new file mode 100644 index 0000000..8ac9d74 --- /dev/null +++ b/templates/chisel-server.service.j2 @@ -0,0 +1,14 @@ +[Unit] +Description=A fast TCP tunnel over HTTP +After=network-online.target + +[Service] + +Type=simple +User={{chisel_user}} +Group={{chisel_group}} +EnvironmentFile={{chisel_config_location}}/chisel-server.conf +ExecStart={{chisel_bin_location}}/chisel server {{ '--socks5' if chisel_server_socks5}} {{ '--reverse' if chisel_server_reverse}} {{ '--backend {}'.format(chisel_server_backend) if chisel_server_backend}} + +[Install] +WantedBy=multi-user.target \ No newline at end of file diff --git a/tests/inventory b/tests/inventory new file mode 100644 index 0000000..878877b --- /dev/null +++ b/tests/inventory @@ -0,0 +1,2 @@ +localhost + diff --git a/tests/test.yml b/tests/test.yml new file mode 100644 index 0000000..d94042d --- /dev/null +++ b/tests/test.yml @@ -0,0 +1,5 @@ +--- +- hosts: localhost + remote_user: root + roles: + - ansible-role-chisel diff --git a/vars/Archlinux.yml b/vars/Archlinux.yml new file mode 100644 index 0000000..6bfa6b2 --- /dev/null +++ b/vars/Archlinux.yml @@ -0,0 +1,8 @@ +--- +chisel_package_name: chisel-tunnel +chisel_user: chisel +chisel_group: chisel +chisel_config_location: /etc +chisel_systemd_location: /etc/systemd/system +chisel_install_user: aur_builder +chisel_bin_location: /usr/bin \ No newline at end of file diff --git a/vars/main.yml b/vars/main.yml new file mode 100644 index 0000000..8af22dc --- /dev/null +++ b/vars/main.yml @@ -0,0 +1,2 @@ +--- +# vars file for ansible-role-chisel