├── mtk-password ├── tests │ ├── inventory │ └── test.yml ├── defaults │ └── main.yml ├── handlers │ └── main.yml ├── vars │ └── main.yml ├── tasks │ └── main.yml ├── README.md └── meta │ └── main.yml ├── mtk-ssh-keys ├── tests │ ├── inventory │ └── test.yml ├── defaults │ └── main.yml ├── handlers │ └── main.yml ├── vars │ └── main.yml ├── tasks │ └── main.yml ├── README.md ├── meta │ └── main.yml └── library │ └── ftp │ ├── README.md │ ├── ftp.py │ └── LICENSE ├── mtk-dude-backup ├── tests │ ├── inventory │ └── test.yml ├── vars │ └── vars.yml ├── defaults │ └── main.yml ├── tasks │ └── main.yml ├── README.md └── library │ └── ftp │ ├── README.md │ ├── ftp.py │ └── LICENSE ├── mtk-ros-upgrade ├── tests │ ├── inventory │ └── test.yml ├── defaults │ └── main.yml ├── handlers │ └── main.yml ├── vars │ └── main.yml ├── tasks │ └── main.yml ├── README.md └── meta │ └── main.yml ├── mtk-firmware-upgrade ├── tests │ ├── inventory │ └── test.yml ├── defaults │ └── main.yml ├── handlers │ └── main.yml ├── vars │ └── main.yml ├── README.md ├── tasks │ └── main.yml └── meta │ └── main.yml ├── upgrade-mtk-firmware.yml ├── mtk-wlan2-ani.yml ├── backup-dude.yml ├── mtk-wlan2-power.yml ├── upgrade-mtk-routeros.yml ├── mtk-switch-interface-desc.yml ├── mtk-wlan2-tuning.yml ├── mtk-probe-tshoot-screen-api.yml ├── mtk-probe-tshoot-screen.yml ├── README.md ├── mtk-probe-tshoot-file.yml ├── mtk-probe-tshoot-notification-api.yml ├── mtk-probe-tshoot-notification-api-col.yml ├── mtk-probe-tshoot-notification-api-newcol.yml └── LICENSE /mtk-password/tests/inventory: -------------------------------------------------------------------------------- 1 | localhost 2 | 3 | -------------------------------------------------------------------------------- /mtk-ssh-keys/tests/inventory: -------------------------------------------------------------------------------- 1 | localhost 2 | 3 | -------------------------------------------------------------------------------- /mtk-dude-backup/tests/inventory: -------------------------------------------------------------------------------- 1 | localhost 2 | 3 | -------------------------------------------------------------------------------- /mtk-ros-upgrade/tests/inventory: -------------------------------------------------------------------------------- 1 | localhost 2 | 3 | -------------------------------------------------------------------------------- /mtk-firmware-upgrade/tests/inventory: -------------------------------------------------------------------------------- 1 | localhost 2 | 3 | -------------------------------------------------------------------------------- /mtk-dude-backup/vars/vars.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # vars for mtk-dude-backup 3 | -------------------------------------------------------------------------------- /mtk-password/defaults/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # defaults file for mtk-password -------------------------------------------------------------------------------- /mtk-password/handlers/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # handlers file for mtk-password -------------------------------------------------------------------------------- /mtk-ssh-keys/defaults/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # defaults file for mtk-ssh-keys -------------------------------------------------------------------------------- /mtk-ssh-keys/handlers/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # handlers file for mtk-ssh-keys -------------------------------------------------------------------------------- /mtk-ros-upgrade/defaults/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # defaults file for mtk-ros-upgrade -------------------------------------------------------------------------------- /mtk-ros-upgrade/handlers/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # handlers file for mtk-ros-upgrade -------------------------------------------------------------------------------- /mtk-firmware-upgrade/defaults/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # defaults file for mtk-firmware-upgrade -------------------------------------------------------------------------------- /mtk-firmware-upgrade/handlers/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # handlers file for mtk-firmware-upgrade -------------------------------------------------------------------------------- /mtk-password/tests/test.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: localhost 3 | remote_user: root 4 | roles: 5 | - mtk-password -------------------------------------------------------------------------------- /mtk-ssh-keys/tests/test.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: localhost 3 | remote_user: root 4 | roles: 5 | - mtk-ssh-keys -------------------------------------------------------------------------------- /mtk-dude-backup/tests/test.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: localhost 3 | remote_user: root 4 | roles: 5 | - mtk-dude-backup -------------------------------------------------------------------------------- /mtk-ros-upgrade/tests/test.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: localhost 3 | remote_user: root 4 | roles: 5 | - mtk-ros-upgrade -------------------------------------------------------------------------------- /mtk-firmware-upgrade/tests/test.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: localhost 3 | remote_user: root 4 | roles: 5 | - mtk-firmware-upgrade -------------------------------------------------------------------------------- /mtk-ssh-keys/vars/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # vars file for mtk-ssh-keys 3 | ansible_connection: network_cli 4 | ansible_network_os: routeros 5 | -------------------------------------------------------------------------------- /mtk-firmware-upgrade/vars/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # vars file for mtk-firmware-upgrade 3 | ansible_connection: network_cli 4 | ansible_network_os: routeros -------------------------------------------------------------------------------- /mtk-password/vars/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # vars file for mtk-password 3 | # usr_name: admin 4 | # pword: admin 5 | ansible_connection: network_cli 6 | ansible_network_os: routeros 7 | -------------------------------------------------------------------------------- /mtk-ros-upgrade/vars/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # vars file for mtk-ros-upgrade 3 | ansible_command_timeout: 120 4 | ansible_connection: network_cli 5 | ansible_network_os: routeros 6 | -------------------------------------------------------------------------------- /mtk-password/tasks/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Find and set the user password with supplied info 3 | routeros_command: 4 | commands: 5 | - "/user set [/user find where name={{ usr_name }}] password={{ pword }}" 6 | -------------------------------------------------------------------------------- /upgrade-mtk-firmware.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Check routerboard firmware and upgrade if needed 3 | hosts: r1 4 | gather_facts: false 5 | vars: 6 | ansible_ssh_user: ansible 7 | 8 | roles: 9 | - mtk-firmware-upgrade 10 | -------------------------------------------------------------------------------- /mtk-wlan2-ani.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Enable wlan2 ANI 3 | connection: network_cli 4 | gather_facts: false 5 | hosts: lab_mikrotiks 6 | tasks: 7 | 8 | - name: Enable wlan2 ANI 9 | routeros_command: 10 | commands: /interface wireless set [ find default-name=wlan2 ] adaptive-noise-immunity=ap-and-client-mode 11 | -------------------------------------------------------------------------------- /backup-dude.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Backup MikroTik Dude Server via FTP 3 | hosts: dude 4 | gather_facts: no 5 | strategy: free 6 | vars: 7 | # I recommend setting the timeout to two minutes or even longer depending on how long it takes the device to pull the file. 8 | ansible_command_timeout: 120 9 | ansible_ssh_user: ansible 10 | 11 | roles: 12 | - mtk-dude-backup 13 | -------------------------------------------------------------------------------- /mtk-wlan2-power.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Change wlan2 radio power 3 | connection: network_cli 4 | gather_facts: false 5 | hosts: lab_mikrotiks 6 | tasks: 7 | 8 | - name: Change wlan2 radio power 9 | routeros_command: 10 | commands: /interface wireless set [ find default-name=wlan2 ] antenna-gain=15 frequency-mode=regulatory-domain installation=indoor distance=indoor 11 | -------------------------------------------------------------------------------- /upgrade-mtk-routeros.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Check ROS and upgrade if needed 3 | hosts: r1 4 | gather_facts: no 5 | strategy: free 6 | vars: 7 | # I recommend setting the timeout to two minutes or even longer depending on how long it takes the device to pull the file. 8 | ansible_command_timeout: 120 9 | ansible_ssh_user: ansible 10 | 11 | roles: 12 | - mtk-ros-upgrade 13 | -------------------------------------------------------------------------------- /mtk-dude-backup/defaults/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # defaults file for mtk-dude-backup 3 | # what to name the backup file 4 | bup_file: home-dude 5 | #increase the timeout for larger dude directories 6 | ansible_command_timeout: 120 7 | #ftp username/password details 8 | ftp_user: ftp 9 | ftp_pass: ftp 10 | #where to save the file on the local server 11 | ftp_dest: /dude_backups/ 12 | 13 | ansible_connection: network_cli 14 | ansible_network_os: routeros 15 | -------------------------------------------------------------------------------- /mtk-dude-backup/tasks/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # tasks file for mtk-dude-backup 3 | - name: Issue the backup database command 4 | routeros_command: 5 | commands: 6 | - "/dude export-db backup-file={{ bup_file }}" 7 | 8 | - name: New FTP file off the router 9 | get_url: 10 | url: "ftp://{{ ftp_user }}:{{ ftp_pass }}@{{ inventory_hostname }}:21/{{ bup_file }}" 11 | dest: "{{ ftp_dest }}" 12 | delegate_to: localhost 13 | 14 | - name: Delete the backup file on the router 15 | routeros_command: 16 | commands: 17 | - "/file remove [/file find name={{ bup_file }}]" 18 | -------------------------------------------------------------------------------- /mtk-ros-upgrade/tasks/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # tasks file for mtk-ros-upgrade 3 | - name: Check version - populates the fields 4 | routeros_command: 5 | commands: 6 | - /system package update check-for-updates 7 | - name: Check if an update is needed 8 | routeros_command: 9 | commands: 10 | - "[:put ([/system package update check-for-updates])]" 11 | register: output 12 | # - name: print variable 13 | # debug: 14 | # msg: "{{ output }}" 15 | - name: Run upgrade if new version is available 16 | routeros_command: 17 | commands: 18 | - /system package update install 19 | when: output.stdout is search('available') 20 | 21 | -------------------------------------------------------------------------------- /mtk-switch-interface-desc.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Check neighbor tables and then update the interface comments with room names 3 | connection: network_cli 4 | gather_facts: false 5 | hosts: cheatham_idf_switches 6 | vars: 7 | # ansible_command_timeout: 120 8 | 9 | tasks: 10 | 11 | - name: Run the command to set interface descriptions 12 | routeros_command: 13 | commands: 14 | # note that I'm looking for ether interfaces. The CPEs I have in the rooms are in the format Room100. 15 | - :local cpes [/ip neighbor print detail as-value where interface~"ether" and identity~"Room"]; :foreach cpe in=$cpes do={/interface set [/interface find name=[:pick ($cpe->"interface") 0 [:find ($cpe->"interface") "b"]]] comment=($cpe->"identity");} 16 | -------------------------------------------------------------------------------- /mtk-firmware-upgrade/README.md: -------------------------------------------------------------------------------- 1 | Role Name 2 | ========= 3 | 4 | When a new version of ROS is installed on a mikrotik device it will also include a new routerboard firmware. This firmware isn't installed by default, though. 5 | This role will check if the device has a newer firmware version available and if it is it will mark it for upgrade, then reboot the device. 6 | 7 | Requirements 8 | ------------ 9 | 10 | NA 11 | 12 | Role Variables 13 | -------------- 14 | 15 | NA 16 | 17 | Dependencies 18 | ------------ 19 | 20 | NA 21 | 22 | Example Playbook 23 | ---------------- 24 | 25 | --- 26 | - name: Check routerboard firmware and upgrade if needed 27 | hosts: mtk1 28 | gather_facts: no 29 | strategy: free 30 | 31 | roles: 32 | - mtk-firmware-upgrade 33 | 34 | License 35 | ------- 36 | 37 | BSD 38 | 39 | Author Information 40 | ------------------ 41 | 42 | Greg Sowell 2020 - GregSowell.com / TheBrothersWISP.com 43 | -------------------------------------------------------------------------------- /mtk-ros-upgrade/README.md: -------------------------------------------------------------------------------- 1 | Role Name 2 | ========= 3 | 4 | This role will check if an upgrade is available for a mikrotik device. If it is, it will download the update, mark it for install, and then reboot the device. 5 | 6 | Requirements 7 | ------------ 8 | 9 | NA 10 | 11 | Role Variables 12 | -------------- 13 | 14 | Timeout is currently set to 2 minutes in the variable file. 15 | 16 | Dependencies 17 | ------------ 18 | 19 | NA 20 | 21 | Example Playbook 22 | ---------------- 23 | 24 | --- 25 | - name: Check ROS and upgrade if needed 26 | hosts: mtk1 27 | gather_facts: no 28 | strategy: free 29 | vars: 30 | # I recommend setting the timeout to two minutes or even longer depending on how long it takes the device to pull the file. 31 | ansible_command_timeout: 120 32 | 33 | roles: 34 | - mtk-ros-upgrade 35 | 36 | License 37 | ------- 38 | 39 | BSD 40 | 41 | Author Information 42 | ------------------ 43 | 44 | Greg Sowell 2020 - GregSowell.com / TheBrothersWISP.com 45 | -------------------------------------------------------------------------------- /mtk-dude-backup/README.md: -------------------------------------------------------------------------------- 1 | Role Name 2 | ========= 3 | 4 | This performs a database backup of a router based dude server via FTP. 5 | 6 | Role Variables 7 | -------------- 8 | 9 | # what to name the backup file 10 | bup_file: home-dude 11 | #increase the timeout for larger dude directories 12 | ansible_command_timeout: 120 13 | #ftp username/password details 14 | ftp_user: ftp 15 | ftp_pass: ftp 16 | #where to save the file on the local server 17 | ftp_dest: /etc/ansible/backups/ 18 | 19 | Dependencies 20 | ------------ 21 | 22 | This utilizes the FTP module found here: https://github.com/melmorabity/ansible-ftp 23 | 24 | Example Playbook 25 | ---------------- 26 | 27 | - hosts: My_Dude 28 | roles: 29 | - role: mtk-dude-backup 30 | bup_file: home-dude 31 | ansible_command_timeout: 120 32 | ftp_user: ftp 33 | ftp_pass: ftp 34 | ftp_dest: /etc/ansible/backups/ 35 | 36 | License 37 | ------- 38 | 39 | BSD 40 | 41 | Author Information 42 | ------------------ 43 | 44 | Greg Sowell - GregSowell.com - TheBrothersWISP.com 45 | -------------------------------------------------------------------------------- /mtk-wlan2-tuning.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: wlan2 radio tuning 3 | connection: network_cli 4 | gather_facts: false 5 | hosts: lab_mikrotiks 6 | tasks: 7 | 8 | - name: wlan2 radio disable wps/enable ANI 9 | routeros_command: 10 | commands: /interface wireless set [ find default-name=wlan2 ] wps-mode=disabled adaptive-noise-immunity=ap-and-client-mode 11 | 12 | - name: wlan2 radio rate-set 13 | routeros_command: 14 | commands: /interface wireless set [ find default-name=wlan2 ] rate-set=configured 15 | 16 | - name: wlan2 radio basic rates 17 | routeros_command: 18 | commands: /interface wireless set [ find default-name=wlan2 ] basic-rates-a/g=12Mbps 19 | 20 | - name: wlan2 radio supported rates 21 | routeros_command: 22 | commands: /interface wireless set [ find default-name=wlan2 ] supported-rates-a/g="12Mbps,18Mbps,24Mbps,36Mbps,48Mbps,54Mbps" 23 | 24 | - name: wlan2 radio band, distance, protocol 25 | routeros_command: 26 | commands: /interface wireless set [ find default-name=wlan2 ] band=5ghz-n/ac distance=indoors wireless-protocol=802.11 27 | -------------------------------------------------------------------------------- /mtk-ssh-keys/tasks/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # tasks file for mtk-ssh-keys 3 | - name: generate the keypair 4 | openssh_keypair: 5 | # path: /etc/ansible/greg_id_ssh_rsa 6 | path: ~/.ssh/id_rsa 7 | type: rsa 8 | 9 | - name: do the ftp transfer 10 | local_action: 11 | module: ftp 12 | host: "{{ hostvars[inventory_hostname].ansible_ssh_host }}" 13 | user: "{{ hostvars[inventory_hostname].ansible_user }}" 14 | password: "{{ hostvars[inventory_hostname].ansible_password }}" 15 | # src: /etc/ansible/greg_id_ssh_rsa.pub 16 | src: ~/.ssh/id_rsa.pub 17 | dest: /greg_id_ssh_rsa.pub 18 | direction: push 19 | 20 | - name: create the ssh user on the mikrotik router 21 | routeros_command: 22 | commands: "/user add group=full password=tacos1234 name={{ remote_ssh_user }}" 23 | 24 | - name: install the key in the routers 25 | routeros_command: 26 | commands: "user ssh import public-key-file=greg_id_ssh_rsa.pub user={{ remote_ssh_user }}" 27 | 28 | # you can use this to test 29 | # ssh -l admin-ssh 192.168.88.109 ":put \"hello\"" 30 | # ssh -l admin-ssh -i /etc/ansible/greg_id_ssh_rsa 192.168.88.109 ":put \"hello\"" -------------------------------------------------------------------------------- /mtk-firmware-upgrade/tasks/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # tasks file for mtk-firmware-upgrade 3 | - name: Get Firmware 4 | routeros_command: 5 | commands: /system routerboard print 6 | register: output 7 | 8 | - name: Get Upgrade Firmware Line 9 | set_fact: 10 | upgrade: "{{ item | replace('upgrade-firmware: ', '') | trim }}" 11 | when: "'upgrade-firmware:' in item" 12 | loop: "{{ output.stdout_lines[0] }}" 13 | 14 | - name: Get Current Firmware Line 15 | set_fact: 16 | current: "{{ item | replace('current-firmware: ', '') | trim }}" 17 | when: "'current-firmware:' in item" 18 | loop: "{{ output.stdout_lines[0] }}" 19 | 20 | # - debug: 21 | # var: upgrade 22 | # - debug: 23 | # var: current 24 | 25 | - name: Upgrade RB firmware if needed 26 | routeros_command: 27 | commands: ":execute {/system rou up;delay 1;quit}" 28 | when: current is version_compare(upgrade, '<') 29 | # when: current != upgrade 30 | 31 | - name: Reboot the router 32 | routeros_command: 33 | commands: ":execute {/system reboot;delay 1;quit}" 34 | when: current is version_compare(upgrade, '<') 35 | # when: current != upgrade 36 | -------------------------------------------------------------------------------- /mtk-ssh-keys/README.md: -------------------------------------------------------------------------------- 1 | Role Name 2 | ========= 3 | 4 | This generates an RSA key on the ansible server. It will then FTP(FTP needs to be enabled on the router) the public key to the MTK device. 5 | It will then create a specific user(unless it already exists) and then import the key for them. 6 | 7 | Requirements 8 | ------------ 9 | 10 | NA 11 | 12 | Role Variables 13 | -------------- 14 | 15 | remote_ssh_user = This is the username that will be created/updated with the key. 16 | 17 | Dependencies 18 | ------------ 19 | 20 | FTP module is required, but is included in the role. 21 | # https://github.com/melmorabity/ansible-ftp is the ansible module used 22 | 23 | Example Playbook 24 | ---------------- 25 | 26 | Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too: 27 | 28 | - hosts: servers 29 | roles: 30 | - { role: username.rolename, x: 42 } 31 | --- 32 | - name: create and install RSA key on routers 33 | hosts: mtk1 34 | gather_facts: false 35 | 36 | vars: 37 | # This is the user on the Mikrotik that will be created/have the key applied to. 38 | remote_ssh_user: admin-ssh 39 | 40 | roles: 41 | - mtk-ssh-keys 42 | 43 | License 44 | ------- 45 | 46 | BSD 47 | 48 | Author Information 49 | ------------------ 50 | 51 | Greg Sowell 2020 - GregSowell.com TheBrothersWISP.com 52 | -------------------------------------------------------------------------------- /mtk-password/README.md: -------------------------------------------------------------------------------- 1 | Role Name 2 | ========= 3 | 4 | This role reaches out to remote mikrotik routers and updates the specified user name with the supplied password. 5 | The combo can be supplied with prompting or directly. 6 | 7 | Requirements 8 | ------------ 9 | 10 | NA 11 | 12 | Role Variables 13 | -------------- 14 | 15 | usr_name = username on the Mikrotik to be changed 16 | pword = new password to be used 17 | 18 | Dependencies 19 | ------------ 20 | 21 | NA 22 | 23 | Example Playbook 24 | ---------------- 25 | 26 | ## Example 1 propts for username and password 27 | 28 | --- 29 | - name: Utilize role to change Mikrotik passwords 30 | hosts: mtk1 31 | gather_facts: false 32 | 33 | vars_prompt: 34 | - name: usr_name 35 | prompt: "what is the username?" 36 | private: no 37 | 38 | - name: pword 39 | prompt: "what is the new password" 40 | confirm: yes 41 | 42 | 43 | roles: 44 | - mtk-password 45 | 46 | ## Example 2 specifies username and password 47 | 48 | --- 49 | - name: Utilize role to change Mikrotik passwords 50 | hosts: mtk1 51 | gather_facts: false 52 | 53 | vars: 54 | usr_name: testUser 55 | pword: testPassword 56 | 57 | roles: 58 | - mtk-password 59 | 60 | 61 | License 62 | ------- 63 | 64 | BSD 65 | 66 | Author Information 67 | ------------------ 68 | 69 | Greg Sowell 2020 - GregSowell.com TheBrothersWISP.com 70 | -------------------------------------------------------------------------------- /mtk-password/meta/main.yml: -------------------------------------------------------------------------------- 1 | galaxy_info: 2 | author: your name 3 | description: your role description 4 | company: your company (optional) 5 | 6 | # If the issue tracker for your role is not on github, uncomment the 7 | # next line and provide a value 8 | # issue_tracker_url: http://example.com/issue/tracker 9 | 10 | # Choose a valid license ID from https://spdx.org - some suggested licenses: 11 | # - BSD-3-Clause (default) 12 | # - MIT 13 | # - GPL-2.0-or-later 14 | # - GPL-3.0-only 15 | # - Apache-2.0 16 | # - CC-BY-4.0 17 | license: license (GPL-2.0-or-later, MIT, etc) 18 | 19 | min_ansible_version: 2.9 20 | 21 | # If this a Container Enabled role, provide the minimum Ansible Container version. 22 | # min_ansible_container_version: 23 | 24 | # 25 | # Provide a list of supported platforms, and for each platform a list of versions. 26 | # If you don't wish to enumerate all versions for a particular platform, use 'all'. 27 | # To view available platforms and versions (or releases), visit: 28 | # https://galaxy.ansible.com/api/v1/platforms/ 29 | # 30 | # platforms: 31 | # - name: Fedora 32 | # versions: 33 | # - all 34 | # - 25 35 | # - name: SomePlatform 36 | # versions: 37 | # - all 38 | # - 1.0 39 | # - 7 40 | # - 99.99 41 | 42 | galaxy_tags: [] 43 | # List tags for your role here, one per line. A tag is a keyword that describes 44 | # and categorizes the role. Users find roles by searching for tags. Be sure to 45 | # remove the '[]' above, if you add tags to this list. 46 | # 47 | # NOTE: A tag is limited to a single word comprised of alphanumeric characters. 48 | # Maximum 20 tags per role. 49 | 50 | dependencies: [] 51 | # List your role dependencies here, one per line. Be sure to remove the '[]' above, 52 | # if you add dependencies to this list. 53 | -------------------------------------------------------------------------------- /mtk-ssh-keys/meta/main.yml: -------------------------------------------------------------------------------- 1 | galaxy_info: 2 | author: your name 3 | description: your role description 4 | company: your company (optional) 5 | 6 | # If the issue tracker for your role is not on github, uncomment the 7 | # next line and provide a value 8 | # issue_tracker_url: http://example.com/issue/tracker 9 | 10 | # Choose a valid license ID from https://spdx.org - some suggested licenses: 11 | # - BSD-3-Clause (default) 12 | # - MIT 13 | # - GPL-2.0-or-later 14 | # - GPL-3.0-only 15 | # - Apache-2.0 16 | # - CC-BY-4.0 17 | license: license (GPL-2.0-or-later, MIT, etc) 18 | 19 | min_ansible_version: 2.9 20 | 21 | # If this a Container Enabled role, provide the minimum Ansible Container version. 22 | # min_ansible_container_version: 23 | 24 | # 25 | # Provide a list of supported platforms, and for each platform a list of versions. 26 | # If you don't wish to enumerate all versions for a particular platform, use 'all'. 27 | # To view available platforms and versions (or releases), visit: 28 | # https://galaxy.ansible.com/api/v1/platforms/ 29 | # 30 | # platforms: 31 | # - name: Fedora 32 | # versions: 33 | # - all 34 | # - 25 35 | # - name: SomePlatform 36 | # versions: 37 | # - all 38 | # - 1.0 39 | # - 7 40 | # - 99.99 41 | 42 | galaxy_tags: [] 43 | # List tags for your role here, one per line. A tag is a keyword that describes 44 | # and categorizes the role. Users find roles by searching for tags. Be sure to 45 | # remove the '[]' above, if you add tags to this list. 46 | # 47 | # NOTE: A tag is limited to a single word comprised of alphanumeric characters. 48 | # Maximum 20 tags per role. 49 | 50 | dependencies: [] 51 | # List your role dependencies here, one per line. Be sure to remove the '[]' above, 52 | # if you add dependencies to this list. 53 | -------------------------------------------------------------------------------- /mtk-ros-upgrade/meta/main.yml: -------------------------------------------------------------------------------- 1 | galaxy_info: 2 | author: your name 3 | description: your role description 4 | company: your company (optional) 5 | 6 | # If the issue tracker for your role is not on github, uncomment the 7 | # next line and provide a value 8 | # issue_tracker_url: http://example.com/issue/tracker 9 | 10 | # Choose a valid license ID from https://spdx.org - some suggested licenses: 11 | # - BSD-3-Clause (default) 12 | # - MIT 13 | # - GPL-2.0-or-later 14 | # - GPL-3.0-only 15 | # - Apache-2.0 16 | # - CC-BY-4.0 17 | license: license (GPL-2.0-or-later, MIT, etc) 18 | 19 | min_ansible_version: 2.9 20 | 21 | # If this a Container Enabled role, provide the minimum Ansible Container version. 22 | # min_ansible_container_version: 23 | 24 | # 25 | # Provide a list of supported platforms, and for each platform a list of versions. 26 | # If you don't wish to enumerate all versions for a particular platform, use 'all'. 27 | # To view available platforms and versions (or releases), visit: 28 | # https://galaxy.ansible.com/api/v1/platforms/ 29 | # 30 | # platforms: 31 | # - name: Fedora 32 | # versions: 33 | # - all 34 | # - 25 35 | # - name: SomePlatform 36 | # versions: 37 | # - all 38 | # - 1.0 39 | # - 7 40 | # - 99.99 41 | 42 | galaxy_tags: [] 43 | # List tags for your role here, one per line. A tag is a keyword that describes 44 | # and categorizes the role. Users find roles by searching for tags. Be sure to 45 | # remove the '[]' above, if you add tags to this list. 46 | # 47 | # NOTE: A tag is limited to a single word comprised of alphanumeric characters. 48 | # Maximum 20 tags per role. 49 | 50 | dependencies: [] 51 | # List your role dependencies here, one per line. Be sure to remove the '[]' above, 52 | # if you add dependencies to this list. 53 | -------------------------------------------------------------------------------- /mtk-firmware-upgrade/meta/main.yml: -------------------------------------------------------------------------------- 1 | galaxy_info: 2 | author: your name 3 | description: your role description 4 | company: your company (optional) 5 | 6 | # If the issue tracker for your role is not on github, uncomment the 7 | # next line and provide a value 8 | # issue_tracker_url: http://example.com/issue/tracker 9 | 10 | # Choose a valid license ID from https://spdx.org - some suggested licenses: 11 | # - BSD-3-Clause (default) 12 | # - MIT 13 | # - GPL-2.0-or-later 14 | # - GPL-3.0-only 15 | # - Apache-2.0 16 | # - CC-BY-4.0 17 | license: license (GPL-2.0-or-later, MIT, etc) 18 | 19 | min_ansible_version: 2.9 20 | 21 | # If this a Container Enabled role, provide the minimum Ansible Container version. 22 | # min_ansible_container_version: 23 | 24 | # 25 | # Provide a list of supported platforms, and for each platform a list of versions. 26 | # If you don't wish to enumerate all versions for a particular platform, use 'all'. 27 | # To view available platforms and versions (or releases), visit: 28 | # https://galaxy.ansible.com/api/v1/platforms/ 29 | # 30 | # platforms: 31 | # - name: Fedora 32 | # versions: 33 | # - all 34 | # - 25 35 | # - name: SomePlatform 36 | # versions: 37 | # - all 38 | # - 1.0 39 | # - 7 40 | # - 99.99 41 | 42 | galaxy_tags: [] 43 | # List tags for your role here, one per line. A tag is a keyword that describes 44 | # and categorizes the role. Users find roles by searching for tags. Be sure to 45 | # remove the '[]' above, if you add tags to this list. 46 | # 47 | # NOTE: A tag is limited to a single word comprised of alphanumeric characters. 48 | # Maximum 20 tags per role. 49 | 50 | dependencies: [] 51 | # List your role dependencies here, one per line. Be sure to remove the '[]' above, 52 | # if you add dependencies to this list. 53 | -------------------------------------------------------------------------------- /mtk-probe-tshoot-screen-api.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Reach out to remote probes and troubleshoot routing 3 | hosts: all 4 | gather_facts: no 5 | vars: 6 | ansible_command_timeout: 120 7 | # destIP: 8.8.8.8 8 | destIP: 1.1.1.1 9 | srcIP: 0.0.0.0 10 | tasks: 11 | 12 | - name: Ping Destination 13 | routeros_command: 14 | commands: 15 | - "/ping count=10 {{ destIP }}" 16 | register: pings 17 | 18 | # - name: Print out results of pings 19 | # debug: 20 | # msg: "{{ pings }}" 21 | 22 | - name: Ping Source 23 | routeros_command: 24 | commands: 25 | - "/ping count=10 {{ srcIP }}" 26 | register: pings_source 27 | when: srcIP != "0.0.0.0" 28 | 29 | - name: Traceroute Destinations 30 | routeros_command: 31 | commands: 32 | - "/tool traceroute count=1 {{ destIP }}" 33 | register: traces 34 | 35 | - name: Traceroute source 36 | routeros_command: 37 | commands: 38 | - "/tool traceroute count=1 {{ srcIP }}" 39 | register: traces_source 40 | when: srcIP != "0.0.0.0" 41 | 42 | - name: display output for no source 43 | debug: 44 | msg: 45 | - "##################{{ inventory_hostname }}##################" 46 | - "===pings===" 47 | - "{{ pings.stdout_lines }}" 48 | - "===traces===" 49 | - "{{ traces.stdout_lines }}" 50 | when: srcIP == "0.0.0.0" 51 | 52 | - name: display output with source 53 | debug: 54 | msg: 55 | - "##################{{ inventory_hostname }}##################" 56 | - "===pings to destination===" 57 | - "{{ pings.stdout_lines }}" 58 | - "===traces to destination===" 59 | - "{{ traces.stdout_lines }}" 60 | - "===pings to source===" 61 | - "{{ pings_source.stdout_lines }}" 62 | - "===traces to source===" 63 | - "{{ traces_source.stdout_lines }}" 64 | when: srcIP != "0.0.0.0" 65 | -------------------------------------------------------------------------------- /mtk-probe-tshoot-screen.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Reach out to remote probes and troubleshoot routing 3 | hosts: all 4 | gather_facts: no 5 | vars: 6 | ansible_command_timeout: 120 7 | # destIP: 8.8.8.8 8 | destIP: "{{ dest_ip }}" 9 | # srcIP: 0.0.0.0 10 | srcIP: "{{ src_ip }}" 11 | tasks: 12 | 13 | - name: Ping Destination 14 | routeros_command: 15 | commands: 16 | - "/ping count=10 {{ destIP }}" 17 | register: pings 18 | 19 | # - name: Print out results of pings 20 | # debug: 21 | # msg: "{{ pings }}" 22 | 23 | - name: Ping Source 24 | routeros_command: 25 | commands: 26 | - "/ping count=10 {{ srcIP }}" 27 | register: pings_source 28 | when: srcIP != "0.0.0.0" 29 | 30 | - name: Traceroute Destinations 31 | routeros_command: 32 | commands: 33 | - "/tool traceroute count=1 {{ destIP }}" 34 | register: traces 35 | 36 | - name: Traceroute source 37 | routeros_command: 38 | commands: 39 | - "/tool traceroute count=1 {{ srcIP }}" 40 | register: traces_source 41 | when: srcIP != "0.0.0.0" 42 | 43 | - name: display output for no source 44 | debug: 45 | msg: 46 | - "##################{{ inventory_hostname }}##################" 47 | - "===pings===" 48 | - "{{ pings.stdout_lines }}" 49 | - "===traces===" 50 | - "{{ traces.stdout_lines }}" 51 | when: srcIP == "0.0.0.0" 52 | 53 | - name: display output with source 54 | debug: 55 | msg: 56 | - "##################{{ inventory_hostname }}##################" 57 | - "===pings to destination===" 58 | - "{{ pings.stdout_lines }}" 59 | - "===traces to destination===" 60 | - "{{ traces.stdout_lines }}" 61 | - "===pings to source===" 62 | - "{{ pings_source.stdout_lines }}" 63 | - "===traces to source===" 64 | - "{{ traces_source.stdout_lines }}" 65 | when: srcIP != "0.0.0.0" 66 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ansible-mikrotik 2 |

Ansible Roles

3 | mtk-ros-upgrade is a role that when used will check that ROS is updated and if not will get the router upgraded
4 | !
5 | mtk-firmware-upgrade is a role that when used will upgrade the firware on a Mikrotik
6 | !
7 | mtk-ssh-keys is a role that when used will create an RSA keypair on the Ansible host, and install the public key on a MTK device
8 | !
9 | mtk-password is a role that when used will update the password for a supplied user
10 | !
11 | mtk-dude-backup is a role that will backup the database on a router based dude install and FTP it off

12 |

Ansible Playbooks



13 | mtk-wlan2-ani enables adaptive noise immunity on wlan2(usually the 5ghz radio)
14 | !
15 | mtk-wlan2-power drastically lowers power on wlan2 by setting its dBi on the interface artificially high and setting it to indoor
16 | !
17 | mtk-wlan2-tuning enables a whole host of tweaks for the wlan2 radio
18 | !
19 | mtk-switch-interface-desc loops through a switch looking at the neighbor table. It filters the table by type ether for copper
20 | interfaces. It also looks for devices that start with "Room" as their identity. I set the CPEs in the rooms to be named Room101,
21 | Room205, etc. So adjust the filters as you need. It then loops through each neighbor entry and updates the physical interface
22 | description so that it's easy to see which device is connected to which switch port.
23 | !
24 | mtk-probe-tshoot-file.yml - Connects to test probes and pings/traceroutes for a destination IP, then saves it into a single file.
25 | If you also specify a source address it will ping/trace to that also and add it to the file.
26 | !
27 | mtk-probe-tshoot-screen.yml - Connects to test probes and pings/traceroutes for a destination IP, then displays it to the screen.
28 | If you also specify a source address it will ping/trace to that also and add it the screen display.
29 | !
30 | mtk-probe-tshoot-notification-api.yml - Connects to test probes and pings/traceroutes for a destination IP, then displays it to the screen.
31 | If you also specify a source address it will ping/trace to that also and then send the info either via email or slack. This is picked via the "send_xxx" variable. By setting send_slack: True it will attempt to send slack(other options are send_email or send_snow). I'm using this with tower and passing destIP over via extra vars. While calling this with the tower API be sure to set extra_variables to "prompt on run" otherwise the playbook won't accept variables sent via extra_vars.
32 | -------------------------------------------------------------------------------- /mtk-probe-tshoot-file.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Reach out to remote probes and troubleshoot routing 3 | hosts: tshoot_probes 4 | gather_facts: no 5 | vars: 6 | ansible_command_timeout: 120 7 | destIP: 8.8.8.8 8 | srcIP: 0.0.0.0 9 | tasks: 10 | 11 | 12 | - name: Ping Destination 13 | routeros_command: 14 | commands: 15 | - "/ping count=10 {{ destIP }}" 16 | register: pings 17 | 18 | # - name: Print out results of pings 19 | # debug: 20 | # msg: "{{ pings }}" 21 | 22 | - name: Ping Source 23 | routeros_command: 24 | commands: 25 | - "/ping count=10 {{ srcIP }}" 26 | register: pings_source 27 | when: srcIP != "0.0.0.0" 28 | 29 | - name: Traceroute Destinations 30 | routeros_command: 31 | commands: 32 | - "/tool traceroute count=1 {{ destIP }}" 33 | register: traces 34 | 35 | - name: Traceroute source 36 | routeros_command: 37 | commands: 38 | - "/tool traceroute count=1 {{ srcIP }}" 39 | register: traces_source 40 | when: srcIP != "0.0.0.0" 41 | 42 | - name: setup time variable 43 | set_fact: time="{{ lookup('pipe','date \"+%Y-%m-%d-%H-%M\"') }}" 44 | run_once: true 45 | 46 | - name: Recursively remove temp directory 47 | file: 48 | path: /etc/ansible/temp 49 | state: absent 50 | become: yes 51 | run_once: yes 52 | 53 | - name: Create temp directory 54 | file: 55 | path: /etc/ansible/temp 56 | state: directory 57 | mode: '0755' 58 | become: yes 59 | run_once: yes 60 | 61 | - name: Create tshoot directory if it doesn't exist 62 | file: 63 | path: /etc/ansible/tshoot 64 | state: directory 65 | mode: '0755' 66 | become: yes 67 | run_once: yes 68 | 69 | - name: save output to file for no source 70 | connection: local 71 | copy: 72 | content: "##################{{ inventory_hostname }}##################\n===pings===\n{{ pings.stdout|join('\n') }}\n===traces===\n{{ traces.stdout|join('\n') }}\n\n" 73 | dest: "/etc/ansible/temp/{{ inventory_hostname }}_info.txt" 74 | when: srcIP == "0.0.0.0" 75 | 76 | - name: save output to file with source 77 | connection: local 78 | copy: 79 | content: "##################{{ inventory_hostname }}##################\n===pings destination===\n{{ pings.stdout|join('\n') }}\n===traces destination===\n{{ traces.stdout|join('\n') }}\n===pings source===\n{{ pings_source.stdout|join('\n') }}\n===traces source===\n{{ traces_source.stdout|join('\n') }}\n\n" 80 | dest: "/etc/ansible/temp/{{ inventory_hostname }}_info.txt" 81 | when: srcIP != "0.0.0.0" 82 | 83 | - name: Assemble the individual outputs into a single file 84 | assemble: 85 | src: /etc/ansible/temp 86 | dest: "/etc/ansible/tshoot/{{ destIP }}-{{ time }}.txt" 87 | run_once: yes 88 | -------------------------------------------------------------------------------- /mtk-dude-backup/library/ftp/README.md: -------------------------------------------------------------------------------- 1 | # ftp 2 | 3 | Transfers files and directories from or to ftp servers. 4 | 5 | ## Synopsis 6 | 7 | Transfers files and directories from or to FTP servers 8 | 9 | ## Options 10 | 11 | | parameter | required | default | choices | comments | 12 | |-----------|----------|---------|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 13 | | src | yes | | | Path on the source host that will be synchronized to the destination. | 14 | | direction | no | push | | Specify the direction of the synchronization. In push mode the localhost or delegate is the source; In pull mode the remote FTP server is the source. | 15 | | protocol | no | ftp | | FTP protocol to use. | 16 | | retries | no | 3 | | Specifies the number of retries the upload should by tried before it is considered failed. | 17 | | dest | yes | | | Path on the destination host that will be synchronized from the source. | 18 | | interval | no | 1 | | Configures the interval in seconds to wait between retries of the upload. | 19 | | host | yes | | | FTP server. | 20 | | ftp_mode | no | passive | | FTP mode. | 21 | | user | no | | | The username used to authenticate with. | 22 | | timeout | no | | | Timeout in seconds for FTP request. | 23 | | password | no | | | The password used to authenticate with. | 24 | | backup | no | False | | Create a remote backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. | 25 | | port | no | 21 | | FTP port. | 26 | | tmp_dest | no | | | Absolute path of where temporary file is downloaded to. Defaults to `TMPDIR`, `TEMP` or `TMP` env variables or a platform specific value (https://docs.python.org/2/library/tempfile.html#tempfile.tempdir). | 27 | | others | no | | | All arguments accepted by the file module also work when direction is pull. | 28 | 29 | ## Examples 30 | 31 | ``` 32 | # Upload a local file to a remote FTP server 33 | - local_action: 34 | module: ftp 35 | host: my.ftp.server.net 36 | user: myuser 37 | password: mypassword 38 | src: /tmp/myfile.txt 39 | dest: /dest 40 | direction: push 41 | 42 | # Download a directory from a remote FTP server 43 | - local_action: 44 | module: ftp 45 | host: my.ftp.server.net 46 | user: myuser 47 | password: mypassword 48 | src: /backups 49 | dest: /var/backups/ 50 | direction: pull 51 | ``` 52 | -------------------------------------------------------------------------------- /mtk-ssh-keys/library/ftp/README.md: -------------------------------------------------------------------------------- 1 | # ftp 2 | 3 | Transfers files and directories from or to ftp servers. 4 | 5 | ## Synopsis 6 | 7 | Transfers files and directories from or to FTP servers 8 | 9 | ## Options 10 | 11 | | parameter | required | default | choices | comments | 12 | |-----------|----------|---------|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 13 | | src | yes | | | Path on the source host that will be synchronized to the destination. | 14 | | direction | no | push | | Specify the direction of the synchronization. In push mode the localhost or delegate is the source; In pull mode the remote FTP server is the source. | 15 | | protocol | no | ftp | | FTP protocol to use. | 16 | | retries | no | 3 | | Specifies the number of retries the upload should by tried before it is considered failed. | 17 | | dest | yes | | | Path on the destination host that will be synchronized from the source. | 18 | | interval | no | 1 | | Configures the interval in seconds to wait between retries of the upload. | 19 | | host | yes | | | FTP server. | 20 | | ftp_mode | no | passive | | FTP mode. | 21 | | user | no | | | The username used to authenticate with. | 22 | | timeout | no | | | Timeout in seconds for FTP request. | 23 | | password | no | | | The password used to authenticate with. | 24 | | backup | no | False | | Create a remote backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. | 25 | | port | no | 21 | | FTP port. | 26 | | tmp_dest | no | | | Absolute path of where temporary file is downloaded to. Defaults to `TMPDIR`, `TEMP` or `TMP` env variables or a platform specific value (https://docs.python.org/2/library/tempfile.html#tempfile.tempdir). | 27 | | others | no | | | All arguments accepted by the file module also work when direction is pull. | 28 | 29 | ## Examples 30 | 31 | ``` 32 | # Upload a local file to a remote FTP server 33 | - local_action: 34 | module: ftp 35 | host: my.ftp.server.net 36 | user: myuser 37 | password: mypassword 38 | src: /tmp/myfile.txt 39 | dest: /dest 40 | direction: push 41 | 42 | # Download a directory from a remote FTP server 43 | - local_action: 44 | module: ftp 45 | host: my.ftp.server.net 46 | user: myuser 47 | password: mypassword 48 | src: /backups 49 | dest: /var/backups/ 50 | direction: pull 51 | ``` 52 | -------------------------------------------------------------------------------- /mtk-probe-tshoot-notification-api.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Reach out to remote probes and troubleshoot routing 3 | hosts: all 4 | gather_facts: no 5 | vars: 6 | ansible_command_timeout: 120 7 | destIP: 1.1.1.1 8 | srcIP: 0.0.0.0 9 | 10 | send_slack: True 11 | send_email: False 12 | send_snow: False 13 | 14 | email_host: smtp.gmail.com 15 | email_port: 587 16 | email_to: Greg Sowell 17 | email_subject: Ansible-report 18 | # email_user: gmailuseraccount@gmail.com 19 | # email_pword: password-for-gmail-account 20 | 21 | slack_channel: '#ansible' 22 | # slack_token: thisis/thetoken/givenbyslackwebhook 23 | 24 | # snow_username: admin 25 | # snow_password: mysnowpword 26 | # snow_instance: dev99999 27 | # snow_caller_id: Abel Tuter 28 | snow_caller_id: System Administrator 29 | 30 | tasks: 31 | 32 | - name: Ping Destination 33 | routeros_command: 34 | commands: 35 | - "/ping count=10 {{ destIP }}" 36 | register: pings 37 | 38 | - name: Ping Source 39 | routeros_command: 40 | commands: 41 | - "/ping count=10 {{ srcIP }}" 42 | register: pings_source 43 | when: srcIP != "0.0.0.0" 44 | 45 | - name: Traceroute Destinations 46 | routeros_command: 47 | commands: 48 | - "/tool traceroute count=1 {{ destIP }}" 49 | register: traces 50 | 51 | - name: Traceroute source 52 | routeros_command: 53 | commands: 54 | - "/tool traceroute count=1 {{ srcIP }}" 55 | register: traces_source 56 | when: srcIP != "0.0.0.0" 57 | 58 | - name: display output for no source 59 | set_fact: 60 | send_msg: "##################Testing to {{ destIP }}##################\n##################{{ inventory_hostname }}##################\n===pings===\n{{ pings.stdout|join('\n') }}\n===traces===\n{{ traces.stdout|join('\n') }}\n\n" 61 | when: srcIP == "0.0.0.0" 62 | 63 | - name: display output with source 64 | set_fact: 65 | send_msg: "##################Testing to {{ destIP }}##################\n##################{{ inventory_hostname }}##################\n===pings destination===\n{{ pings.stdout|join('\n') }}\n===traces destination===\n{{ traces.stdout|join('\n') }}\n===pings source===\n{{ pings_source.stdout|join('\n') }}\n===traces source===\n{{ traces_source.stdout|join('\n') }}\n\n" 66 | when: srcIP != "0.0.0.0" 67 | 68 | - name: create SNOW incident 69 | when: send_snow 70 | run_once: True 71 | ignore_errors: True 72 | block: 73 | - name: Create an incident 74 | snow_record: 75 | username: "{{ snow_username }}" 76 | password: "{{ snow_password }}" 77 | instance: "{{ snow_instance }}" 78 | state: present 79 | data: 80 | short_description: "Zab-Tower - Device Down - {{ destIP }}" 81 | # description: Something here useful 82 | caller_id: "{{ snow_caller_id }}" 83 | severity: 3 84 | priority: 5 85 | register: new_incident 86 | 87 | - set_fact: 88 | ticket_number: "{{ new_incident.record.number }}" 89 | 90 | - name: debug new_incident 91 | when: ticket_number is defined 92 | run_once: True 93 | debug: 94 | msg: "Ticket Number is: {{ ticket_number | default('None')}}" 95 | 96 | 97 | - name: create SNOW incident 98 | when: send_snow 99 | ignore_errors: True 100 | block: 101 | - name: Add pings 102 | snow_record: 103 | username: "{{ snow_username }}" 104 | password: "{{ snow_password }}" 105 | instance: "{{ snow_instance }}" 106 | state: present 107 | number: "{{ ticket_number }}" 108 | data: 109 | comments: "##################{{ inventory_hostname }}##################\n===pings===\n{{ pings.stdout|join('\n') }}\n" 110 | 111 | - name: Add traces 112 | snow_record: 113 | username: "{{ snow_username }}" 114 | password: "{{ snow_password }}" 115 | instance: "{{ snow_instance }}" 116 | state: present 117 | number: "{{ ticket_number }}" 118 | data: 119 | comments: "##################{{ inventory_hostname }}##################\n===traces===\n{{ traces.stdout|join('\n') }}\n" 120 | 121 | 122 | - name: send message through slack 123 | when: send_slack 124 | slack: 125 | token: "{{ slack_token }}" 126 | # msg: | 127 | # "SNOW ticket {{ new_incident.record.number | default('None')}}" 128 | # "{{ send_msg }}" 129 | attachments: 130 | - text: "{{ send_msg }}" 131 | title: "SNOW ticket {{ new_incident.record.number | default('None')}}" 132 | title_link: "https://{{ snow_instance }}.service-now.com/nav_to.do?uri=incident.do?sysparm_query=number={{ new_incident.record.number | default('None')}}" 133 | channel: "{{ slack_channel }}" 134 | # thread_id: 1539917263.000100 135 | parse: 'none' 136 | delegate_to: localhost 137 | 138 | - name: Sending an e-mail using Gmail SMTP servers 139 | when: send_email 140 | mail: 141 | host: "{{ email_host }}" 142 | port: "{{ email_port }}" 143 | username: "{{ email_user }}" 144 | password: "{{ email_pword }}" 145 | to: "{{ email_to }}" 146 | subject: "{{ email_subject }}" 147 | # body: "{{ send_msg }}" 148 | body: | 149 | "SNOW ticket https://{{ snow_instance }}.service-now.com/nav_to.do?uri=incident.do?sysparm_query=number={{ new_incident.record.number | default('None')}}" 150 | "{{ send_msg }}" 151 | delegate_to: localhost 152 | -------------------------------------------------------------------------------- /mtk-probe-tshoot-notification-api-col.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Reach out to remote probes and troubleshoot routing 3 | hosts: all 4 | gather_facts: no 5 | vars: 6 | ansible_command_timeout: 120 7 | destIP: 1.1.1.1 8 | srcIP: 0.0.0.0 9 | 10 | send_slack: True 11 | send_email: False 12 | send_snow: False 13 | 14 | email_host: smtp.gmail.com 15 | email_port: 587 16 | email_to: Greg Sowell 17 | email_subject: Ansible-report 18 | # email_user: gmailuseraccount@gmail.com 19 | # email_pword: password-for-gmail-account 20 | 21 | slack_channel: '#ansible' 22 | # slack_token: thisis/thetoken/givenbyslackwebhook 23 | 24 | # snow_username: admin 25 | # snow_password: mysnowpword 26 | # snow_instance: dev99999 27 | # snow_caller_id: Abel Tuter 28 | snow_caller_id: System Administrator 29 | 30 | tasks: 31 | 32 | - name: Ping Destination 33 | community.routeros.command: 34 | commands: 35 | - "/ping count=10 {{ destIP }}" 36 | register: pings 37 | 38 | - name: Ping Source 39 | community.routeros.command: 40 | commands: 41 | - "/ping count=10 {{ srcIP }}" 42 | register: pings_source 43 | when: srcIP != "0.0.0.0" 44 | 45 | - name: Traceroute Destinations 46 | community.routeros.command: 47 | commands: 48 | - "/tool traceroute count=1 {{ destIP }}" 49 | register: traces 50 | 51 | - name: Traceroute source 52 | community.routeros.command: 53 | commands: 54 | - "/tool traceroute count=1 {{ srcIP }}" 55 | register: traces_source 56 | when: srcIP != "0.0.0.0" 57 | 58 | - name: display output for no source 59 | ansible.builtin.set_fact: 60 | send_msg: "##################Testing to {{ destIP }}##################\n##################{{ inventory_hostname }}##################\n===pings===\n{{ pings.stdout|join('\n') }}\n===traces===\n{{ traces.stdout|join('\n') }}\n\n" 61 | when: srcIP == "0.0.0.0" 62 | 63 | - name: display output with source 64 | ansible.builtin.set_fact: 65 | send_msg: "##################Testing to {{ destIP }}##################\n##################{{ inventory_hostname }}##################\n===pings destination===\n{{ pings.stdout|join('\n') }}\n===traces destination===\n{{ traces.stdout|join('\n') }}\n===pings source===\n{{ pings_source.stdout|join('\n') }}\n===traces source===\n{{ traces_source.stdout|join('\n') }}\n\n" 66 | when: srcIP != "0.0.0.0" 67 | 68 | - name: create SNOW incident 69 | when: send_snow 70 | run_once: True 71 | ignore_errors: True 72 | block: 73 | - name: Create an incident 74 | servicenow.itsm.snow_record: 75 | username: "{{ snow_username }}" 76 | password: "{{ snow_password }}" 77 | instance: "{{ snow_instance }}" 78 | state: present 79 | data: 80 | short_description: "Zab-Tower - Device Down - {{ destIP }}" 81 | # description: Something here useful 82 | caller_id: "{{ snow_caller_id }}" 83 | severity: 3 84 | priority: 5 85 | register: new_incident 86 | 87 | - ansible.builtin.set_fact: 88 | ticket_number: "{{ new_incident.record.number }}" 89 | 90 | - name: debug new_incident 91 | when: ticket_number is defined 92 | run_once: True 93 | ansible.builtin.debug: 94 | msg: "Ticket Number is: {{ ticket_number | default('None')}}" 95 | 96 | 97 | - name: create SNOW incident 98 | when: send_snow 99 | ignore_errors: True 100 | block: 101 | - name: Add pings 102 | servicenow.itsm.snow_record: 103 | username: "{{ snow_username }}" 104 | password: "{{ snow_password }}" 105 | instance: "{{ snow_instance }}" 106 | state: present 107 | number: "{{ ticket_number }}" 108 | data: 109 | comments: "##################{{ inventory_hostname }}##################\n===pings===\n{{ pings.stdout|join('\n') }}\n" 110 | 111 | - name: Add traces 112 | servicenow.itsm.snow_record: 113 | username: "{{ snow_username }}" 114 | password: "{{ snow_password }}" 115 | instance: "{{ snow_instance }}" 116 | state: present 117 | number: "{{ ticket_number }}" 118 | data: 119 | comments: "##################{{ inventory_hostname }}##################\n===traces===\n{{ traces.stdout|join('\n') }}\n" 120 | 121 | 122 | - name: send message through slack 123 | when: send_slack 124 | community.general.slack: 125 | token: "{{ slack_token }}" 126 | # msg: | 127 | # "SNOW ticket {{ new_incident.record.number | default('None')}}" 128 | # "{{ send_msg }}" 129 | attachments: 130 | - text: "{{ send_msg }}" 131 | title: "SNOW ticket {{ new_incident.record.number | default('None')}}" 132 | title_link: "https://{{ snow_instance }}.service-now.com/nav_to.do?uri=incident.do?sysparm_query=number={{ new_incident.record.number | default('None')}}" 133 | channel: "{{ slack_channel }}" 134 | # thread_id: 1539917263.000100 135 | parse: 'none' 136 | delegate_to: localhost 137 | 138 | - name: Sending an e-mail using Gmail SMTP servers 139 | when: send_email 140 | community.general.mail: 141 | host: "{{ email_host }}" 142 | port: "{{ email_port }}" 143 | username: "{{ email_user }}" 144 | password: "{{ email_pword }}" 145 | to: "{{ email_to }}" 146 | subject: "{{ email_subject }}" 147 | # body: "{{ send_msg }}" 148 | body: | 149 | "SNOW ticket https://{{ snow_instance }}.service-now.com/nav_to.do?uri=incident.do?sysparm_query=number={{ new_incident.record.number | default('None')}}" 150 | "{{ send_msg }}" 151 | delegate_to: localhost 152 | -------------------------------------------------------------------------------- /mtk-probe-tshoot-notification-api-newcol.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Reach out to remote probes and troubleshoot routing 3 | hosts: all 4 | gather_facts: no 5 | vars: 6 | ansible_command_timeout: 120 7 | destIP: 1.1.1.1 8 | srcIP: 0.0.0.0 9 | 10 | send_slack: True 11 | send_email: False 12 | send_snow: False 13 | 14 | email_host: smtp.gmail.com 15 | email_port: 587 16 | email_to: Greg Sowell 17 | email_subject: Ansible-report 18 | # email_user: gmailuseraccount@gmail.com 19 | # email_pword: password-for-gmail-account 20 | 21 | slack_channel: '#ansible' 22 | # slack_token: thisis/thetoken/givenbyslackwebhook 23 | 24 | # snow_username: admin 25 | # snow_password: mysnowpword 26 | # snow_instance: dev99999 27 | # snow_caller_id: Abel Tuter 28 | snow_caller_id: System Administrator 29 | 30 | tasks: 31 | 32 | - name: Ping Destination 33 | community.routeros.command: 34 | commands: 35 | - "/ping count=10 {{ destIP }}" 36 | register: pings 37 | 38 | - name: Ping Source 39 | community.routeros.command: 40 | commands: 41 | - "/ping count=10 {{ srcIP }}" 42 | register: pings_source 43 | when: srcIP != "0.0.0.0" 44 | 45 | - name: Traceroute Destinations 46 | community.routeros.command: 47 | commands: 48 | - "/tool traceroute count=1 {{ destIP }}" 49 | register: traces 50 | 51 | - name: Traceroute source 52 | community.routeros.command: 53 | commands: 54 | - "/tool traceroute count=1 {{ srcIP }}" 55 | register: traces_source 56 | when: srcIP != "0.0.0.0" 57 | 58 | - name: display output for no source 59 | ansible.builtin.set_fact: 60 | send_msg: "##################Testing to {{ destIP }}##################\n##################{{ inventory_hostname }}##################\n===pings===\n{{ pings.stdout|join('\n') | regex_replace('\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n','') }}\n===traces===\n{{ traces.stdout|join('\n') | regex_replace('\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n','') }}\n\n" 61 | when: srcIP == "0.0.0.0" 62 | 63 | - name: display output with source 64 | ansible.builtin.set_fact: 65 | send_msg: "##################Testing to {{ destIP }}##################\n##################{{ inventory_hostname }}##################\n===pings destination===\n{{ pings.stdout|join('\n') | regex_replace('\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n','') }}\n===traces destination===\n{{ traces.stdout|join('\n') | regex_replace('\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n','')}}\n===pings source===\n{{ pings_source.stdout|join('\n') | regex_replace('\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n','') }}\n===traces source===\n{{ traces_source.stdout|join('\n') | regex_replace('\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n','') }}\n\n" 66 | when: srcIP != "0.0.0.0" 67 | 68 | - name: create SNOW incident 69 | when: send_snow 70 | run_once: True 71 | ignore_errors: True 72 | block: 73 | - name: Create an incident 74 | servicenow.servicenow.snow_record: 75 | username: "{{ snow_username }}" 76 | password: "{{ snow_password }}" 77 | instance: "{{ snow_instance }}" 78 | state: present 79 | data: 80 | short_description: "Zab-Tower - Device Down - {{ destIP }}" 81 | # description: Something here useful 82 | caller_id: "{{ snow_caller_id }}" 83 | severity: 3 84 | priority: 5 85 | register: new_incident 86 | 87 | - ansible.builtin.set_fact: 88 | ticket_number: "{{ new_incident.record.number }}" 89 | 90 | - name: debug new_incident 91 | when: ticket_number is defined 92 | run_once: True 93 | ansible.builtin.debug: 94 | msg: "Ticket Number is: {{ ticket_number | default('None')}}" 95 | 96 | 97 | - name: create SNOW incident 98 | when: send_snow 99 | ignore_errors: True 100 | block: 101 | - name: Add pings 102 | servicenow.servicenow.snow_record: 103 | username: "{{ snow_username }}" 104 | password: "{{ snow_password }}" 105 | instance: "{{ snow_instance }}" 106 | state: present 107 | number: "{{ ticket_number }}" 108 | data: 109 | comments: "##################{{ inventory_hostname }}##################\n===pings===\n{{ pings.stdout|join('\n') | regex_replace('\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n','') }}\n" 110 | 111 | - name: Add traces 112 | servicenow.servicenow.snow_record: 113 | username: "{{ snow_username }}" 114 | password: "{{ snow_password }}" 115 | instance: "{{ snow_instance }}" 116 | state: present 117 | number: "{{ ticket_number }}" 118 | data: 119 | comments: "##################{{ inventory_hostname }}##################\n===traces===\n{{ traces.stdout|join('\n') | regex_replace('\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n','') }}\n" 120 | 121 | 122 | - name: send message through slack 123 | when: send_slack 124 | community.general.slack: 125 | token: "{{ slack_token }}" 126 | # msg: | 127 | # "SNOW ticket {{ new_incident.record.number | default('None')}}" 128 | # "{{ send_msg }}" 129 | attachments: 130 | - text: "{{ send_msg }}" 131 | title: "SNOW ticket {{ new_incident.record.number | default('None')}}" 132 | title_link: "https://{{ snow_instance }}.service-now.com/nav_to.do?uri=incident.do?sysparm_query=number={{ new_incident.record.number | default('None')}}" 133 | channel: "{{ slack_channel }}" 134 | # thread_id: 1539917263.000100 135 | parse: 'none' 136 | delegate_to: localhost 137 | 138 | - name: Sending an e-mail using Gmail SMTP servers 139 | when: send_email 140 | community.general.mail: 141 | host: "{{ email_host }}" 142 | port: "{{ email_port }}" 143 | username: "{{ email_user }}" 144 | password: "{{ email_pword }}" 145 | to: "{{ email_to }}" 146 | subject: "{{ email_subject }}" 147 | # body: "{{ send_msg }}" 148 | body: | 149 | "SNOW ticket https://{{ snow_instance }}.service-now.com/nav_to.do?uri=incident.do?sysparm_query=number={{ new_incident.record.number | default('None')}}" 150 | "{{ send_msg }}" 151 | delegate_to: localhost 152 | -------------------------------------------------------------------------------- /mtk-ssh-keys/library/ftp/ftp.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: utf-8 -*- 3 | 4 | # Copyright © 2018-2019 Mohamed El Morabity 5 | # 6 | # This program is free software: you can redistribute it and/or modify it under 7 | # the terms of the GNU General Public License as published by the Free Software 8 | # Foundation, either version 3 of the License, or (at your option) any later 9 | # version. 10 | # 11 | # This program is distributed in the hope that it will be useful, but WITHOUT 12 | # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 13 | # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 14 | # details. 15 | # 16 | # You should have received a copy of the GNU General Public License along with 17 | # this program. If not, see . 18 | 19 | 20 | import contextlib 21 | from enum import Enum 22 | import ftplib 23 | import hashlib 24 | import os 25 | import tempfile 26 | import time 27 | 28 | from ansible.module_utils._text import to_native 29 | from ansible.module_utils.basic import AnsibleModule 30 | from ansible.utils.path import makedirs_safe 31 | 32 | 33 | DOCUMENTATION = """ 34 | --- 35 | module: ftp 36 | author: Mohamed El Morabity 37 | short_description: Transfers files and directories from or to FTP servers 38 | description: 39 | - Transfers files and directories from or to FTP servers. 40 | options: 41 | host: 42 | description: 43 | - FTP server. 44 | required: True 45 | port: 46 | description: 47 | - FTP port. 48 | type: int 49 | required: False 50 | default: 21 51 | user: 52 | description: 53 | - The username used to authenticate with. 54 | required: False 55 | default: null 56 | password: 57 | description: 58 | - The password used to authenticate with. 59 | required: False 60 | default: null 61 | src: 62 | description: 63 | - Path on the source host that will be synchronized to the destination. 64 | type: path 65 | required: true 66 | dest: 67 | description: 68 | - Path on the destination host that will be synchronized from the source. 69 | type: path 70 | required: true 71 | protocol: 72 | description: 73 | - FTP protocol to use. 74 | type: string 75 | required: False 76 | choices: 77 | - ftp 78 | - ftps 79 | default: ftp 80 | direction: 81 | description: 82 | - Specify the direction of the synchronization. In push mode the localhost or delegate is the source; In pull mode the remote FTP server is the source. 83 | type: string 84 | required: False 85 | choices: 86 | - push 87 | - pull 88 | default: push 89 | ftp_mode: 90 | description: 91 | - FTP mode. 92 | type: string 93 | required: False 94 | choices: 95 | - passive 96 | - active 97 | default: passive 98 | timeout: 99 | description: 100 | - Timeout in seconds for FTP request. 101 | type: int 102 | required: False 103 | backup: 104 | description: 105 | - Create a remote backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. 106 | type: bool 107 | required: False 108 | default: False 109 | retries: 110 | description: 111 | - Specifies the number of retries the upload should by tried before it is considered failed. 112 | type: int 113 | required: False 114 | default: 3 115 | interval: 116 | description: 117 | - Configures the interval in seconds to wait between retries of the upload. 118 | type: int 119 | required: False 120 | default: 1 121 | tmp_dest: 122 | description: 123 | - Absolute path of where temporary file is downloaded to. 124 | - Defaults to C(TMPDIR), C(TEMP) or C(TMP) env variables or a platform specific value. 125 | - U(https://docs.python.org/2/library/tempfile.html#tempfile.tempdir). 126 | type: string 127 | required: False 128 | others: 129 | description: 130 | - All arguments accepted by the file module also work when direction is pull. 131 | required: False 132 | """ 133 | 134 | EXAMPLES = """ 135 | # Upload a local file to a remote FTP server 136 | - local_action: 137 | module: ftp 138 | host: my.ftp.server.net 139 | user: myuser 140 | password: mypassword 141 | src: /tmp/myfile.txt 142 | dest: /dest 143 | direction: push 144 | 145 | # Download a directory from a remote FTP server 146 | - local_action: 147 | module: ftp 148 | host: my.ftp.server.net 149 | user: myuser 150 | password: mypassword 151 | src: /backups 152 | dest: /var/backups/ 153 | direction: pull 154 | """ 155 | 156 | 157 | def _ftp_retry(function): 158 | """Decorator to retry FTP commands in the case of a connection failure.""" 159 | 160 | def wrapper(module, *args, **kwargs): 161 | retries = module.params["retries"] 162 | interval = module.params["interval"] 163 | 164 | for _ in range(retries): 165 | try: 166 | return function(module, *args, **kwargs) 167 | except ftplib.all_errors: 168 | time.sleep(interval) 169 | return function(module, *args, **kwargs) 170 | 171 | return wrapper 172 | 173 | 174 | class _FTPPathStatus(Enum): 175 | """Enumeration for FTP path types.""" 176 | 177 | IS_DIR = 1 178 | IS_FILE = 2 179 | NOT_EXISTS = 3 180 | 181 | 182 | @_ftp_retry 183 | def _ftp_check_path(module, session, path): 184 | """Check whether a remote path on the FTP server is a file, a directory or 185 | doesn't exist.""" 186 | 187 | try: 188 | content = session.nlst(path) 189 | # Filter out current and parent directory 190 | content = [p for p in content if not p.endswith(("/.", "/.."))] 191 | if len(content) != 1: 192 | return (_FTPPathStatus.IS_DIR, content) 193 | if content[0] == path: 194 | return (_FTPPathStatus.IS_FILE, None) 195 | return (_FTPPathStatus.IS_DIR, content) 196 | except ftplib.all_errors as ex: 197 | code = ex.args[0][:3] 198 | if code not in ("450", "550"): 199 | raise ex 200 | return (_FTPPathStatus.NOT_EXISTS, None) 201 | 202 | 203 | @_ftp_retry 204 | def _ftp_compare_files(module, session, local_path, remote_path): 205 | """Check whether a local file and a remote one on a FTP server are 206 | identical.""" 207 | 208 | # Get local file MD5 hash 209 | local_path_hash = module.md5(local_path) 210 | 211 | # Get remote file MD5 hash 212 | md5 = hashlib.md5() 213 | session.retrbinary("RETR {}".format(remote_path), md5.update) 214 | remote_path_hash = md5.hexdigest() 215 | 216 | return local_path_hash == remote_path_hash 217 | 218 | 219 | @_ftp_retry 220 | def _ftp_mkdir(module, session, path): 221 | """Create directory (and its parents) on remote FTP server.""" 222 | 223 | sub_dirs = path.split("/") 224 | current_dir = "" 225 | for dir_ in sub_dirs: 226 | if not dir_: 227 | continue 228 | current_dir += "/{}".format(dir_) 229 | try: 230 | session.mkd(current_dir) 231 | except ftplib.error_perm as ex: 232 | code = ex.args[0][:3] 233 | # Directory already exists 234 | if code != "550": 235 | raise ex 236 | 237 | 238 | @_ftp_retry 239 | def _ftp_backup_file(module, session, path): 240 | """Create a remote backup file.""" 241 | 242 | # Note: don't use colons in backup suffix filename (MS doesn't support it) 243 | ext = time.strftime("%Y-%m-%d@%H.%M.%S~", time.localtime(time.time())) 244 | backup_path = "{}.{}.{}".format(path, os.getpid(), ext) 245 | session.rename(path, backup_path) 246 | 247 | return backup_path 248 | 249 | 250 | @_ftp_retry 251 | def _ftp_upload_file(module, session, src, dest): 252 | """Upload a local file to a FTP server.""" 253 | 254 | # Upload file 255 | with open(src, "rb") as src_object: 256 | session.storbinary("STOR {}".format(dest), src_object) 257 | 258 | 259 | @_ftp_retry 260 | def _ftp_download_file(module, session, src, dest): 261 | """Download a remote file from a FTP server.""" 262 | 263 | # Upload file 264 | with open(dest, "wb") as dest_object: 265 | session.retrbinary("RETR {}".format(src), dest_object.write) 266 | 267 | 268 | def _ftp_upload(module, session, src, dest, top_dir=True): 269 | """Upload a local file or directory to a FTP server.""" 270 | 271 | dest_is_dir = dest.strip().endswith("/") 272 | src = os.path.normpath(src) 273 | dest = os.path.normpath(dest) 274 | 275 | results = {} 276 | results["src"] = src 277 | results["dest"] = dest 278 | 279 | if not os.path.exists(src): 280 | module.fail_json(msg="Source {} does not exist".format(src)) 281 | if not os.access(src, os.R_OK): 282 | module.fail_json(msg="Source {} is not readable".format(src)) 283 | if not os.path.isfile(src) and not os.path.isdir(src): 284 | module.fail_json( 285 | msg="Source {} is not a regular file or a directory".format(src) 286 | ) 287 | 288 | try: 289 | dest_status, _ = _ftp_check_path(module, session, dest) 290 | except ftplib.all_errors as ex: 291 | module.fail_json( 292 | msg="Unable to get status for destination {}: {}".format( 293 | dest, to_native(ex) 294 | ) 295 | ) 296 | 297 | dest_exists = dest_status != _FTPPathStatus.NOT_EXISTS 298 | results["changed"] = not dest_exists 299 | dest_is_dir |= dest_status == _FTPPathStatus.IS_DIR or os.path.isdir(src) 300 | 301 | if os.path.isdir(src) and dest_status == _FTPPathStatus.IS_FILE: 302 | module.fail_json( 303 | msg="Destination {} is a file whereas source {} is a " 304 | "directory".format(dest, src) 305 | ) 306 | 307 | # Create remote parent directories 308 | if not dest_exists: 309 | dest_dir = dest if dest_is_dir else "/".join(dest.split("/")[:-1]) 310 | 311 | try: 312 | _ftp_mkdir(module, session, dest_dir) 313 | except ftplib.all_errors as ex: 314 | module.fail_json( 315 | msg="Unable to create destination directory {}: {}".format( 316 | dest, to_native(ex) 317 | ) 318 | ) 319 | 320 | # Manage recursive upload 321 | if os.path.isdir(src): 322 | if dest_exists and top_dir: 323 | dest += "/{}".format(os.path.basename(src)) 324 | 325 | for path in os.listdir(src): 326 | path_src = os.path.join(src, path) 327 | path_dest = path_src.replace(src, dest, 1).replace( 328 | os.path.sep, "/" 329 | ) 330 | path_results = _ftp_upload( 331 | module, session, path_src, path_dest, False 332 | ) 333 | results["changed"] |= path_results["changed"] 334 | return results 335 | 336 | if dest_is_dir: 337 | dest += "/{}".format(os.path.basename(src)) 338 | # Get status for destination file 339 | try: 340 | dest_status, _ = _ftp_check_path(module, session, dest) 341 | except ftplib.all_errors as ex: 342 | module.fail_json( 343 | msg="Unable to get status for destination {}: {}".format( 344 | dest, to_native(ex) 345 | ) 346 | ) 347 | dest_exists = dest_status != _FTPPathStatus.NOT_EXISTS 348 | 349 | results["changed"] |= not dest_exists or not _ftp_compare_files( 350 | module, session, src, dest 351 | ) 352 | 353 | if results["changed"]: 354 | try: 355 | if module.params["backup"] and dest_exists: 356 | results["backup_file"] = _ftp_backup_file( 357 | module, session, dest 358 | ) 359 | except ftplib.all_errors as ex: 360 | module.fail_json( 361 | msg="Unable to backup destination {}: {}".format( 362 | dest, to_native(ex) 363 | ) 364 | ) 365 | 366 | try: 367 | _ftp_upload_file(module, session, src, dest) 368 | except ftplib.all_errors as ex: 369 | module.fail_json( 370 | msg="Unable to upload source {} to destination {}: {}".format( 371 | src, dest, to_native(ex) 372 | ) 373 | ) 374 | 375 | return results 376 | 377 | 378 | def _ftp_download(module, session, src, dest, top_dir=True): 379 | """Download a remote file or directory from a FTP server.""" 380 | 381 | dest_is_dir = dest.endswith("/") 382 | 383 | src = os.path.normpath(src) 384 | dest = os.path.normpath(dest) 385 | 386 | results = {} 387 | results["src"] = src 388 | results["dest"] = dest 389 | 390 | dest_exists = os.path.exists(dest) 391 | 392 | try: 393 | src_status, src_content = _ftp_check_path(module, session, src) 394 | except ftplib.all_errors as ex: 395 | module.fail_json( 396 | msg="Unable to get status for source {}: {}".format( 397 | src, to_native(ex) 398 | ) 399 | ) 400 | 401 | if src_status == _FTPPathStatus.NOT_EXISTS: 402 | module.fail_json(msg="Source {} does not exist".format(src)) 403 | 404 | dest_is_dir |= src_status == _FTPPathStatus.IS_DIR or os.path.isdir(dest) 405 | if dest_exists: 406 | if not os.access(dest, os.W_OK): 407 | module.fail_json(msg="Destination {} is not writable".format(dest)) 408 | if not dest_is_dir and not os.path.isfile(dest): 409 | module.fail_json( 410 | msg="Destination {} is not a regular file or a " 411 | "directory".format(dest) 412 | ) 413 | 414 | if dest_exists and not dest_is_dir and src_status == _FTPPathStatus.IS_DIR: 415 | module.fail_json( 416 | msg="Source {} is a directory whereas destination {} is not a " 417 | "directory".format(dest, src) 418 | ) 419 | 420 | results["changed"] = not dest_exists 421 | 422 | # Create local parent directories 423 | if not dest_exists: 424 | dest_dir = dest if dest_is_dir else os.path.dirname(dest) 425 | makedirs_safe(dest_dir, mode=module.params["directory_mode"]) 426 | 427 | # Manage recursive download 428 | if src_status == _FTPPathStatus.IS_DIR: 429 | if dest_exists and top_dir: 430 | dest = os.path.join(dest, src.split("/")[-1]) 431 | 432 | for path in src_content: 433 | path_dest = path.replace(src, dest, 1).replace("/", os.path.sep) 434 | path_results = _ftp_download( 435 | module, session, path, path_dest, False 436 | ) 437 | results["changed"] |= path_results["changed"] 438 | return results 439 | 440 | if dest_is_dir: 441 | dest = os.path.join(dest, os.path.basename(src)) 442 | dest_exists = os.path.exists(dest) 443 | 444 | results["changed"] |= not dest_exists or not _ftp_compare_files( 445 | module, session, dest, src 446 | ) 447 | 448 | if results["changed"]: 449 | tmp_dest = module.params.get("tmp_dest") 450 | if tmp_dest: 451 | # tmp_dest should be an existing dir 452 | if not os.path.isdir(tmp_dest): 453 | if os.path.exists(tmp_dest): 454 | module.fail_json( 455 | msg="{} is a file but should be a directory".format( 456 | tmp_dest 457 | ) 458 | ) 459 | else: 460 | module.fail_json( 461 | msg="{} directory does not exist".format(tmp_dest) 462 | ) 463 | 464 | _, tmp_dest_path = tempfile.mkstemp(dir=tmp_dest) 465 | else: 466 | _, tmp_dest_path = tempfile.mkstemp() 467 | 468 | try: 469 | _ftp_download_file(module, session, src, tmp_dest_path) 470 | except ftplib.all_errors as ex: 471 | module.fail_json( 472 | msg="Unable to download source {} to destination {}: " 473 | "{}".format(src, dest, to_native(ex)) 474 | ) 475 | 476 | if module.params["backup"] and dest_exists: 477 | results["backup_file"] = module.backup_local(dest) 478 | 479 | module.atomic_move( 480 | tmp_dest_path, dest, unsafe_writes=module.params["unsafe_writes"] 481 | ) 482 | file_args = module.load_file_common_arguments(module.params) 483 | results["changed"] = module.set_file_attributes_if_different( 484 | file_args, results["changed"] 485 | ) 486 | 487 | return results 488 | 489 | 490 | @_ftp_retry 491 | def _ftp_connect(module, session): 492 | session.connect( 493 | module.params["host"], module.params["port"], module.params["timeout"] 494 | ) 495 | session.set_pasv(module.params["ftp_mode"] == "passive") 496 | session.login(module.params["user"], module.params["password"]) 497 | if module.params["protocol"] == "ftps": 498 | session.prot_p() 499 | 500 | 501 | def main(): 502 | """Main execution path.""" 503 | 504 | module = AnsibleModule( 505 | argument_spec={ 506 | "host": {"type": "str", "required": True}, 507 | "port": {"type": "int", "default": 21}, 508 | "user": {"type": "str"}, 509 | "password": {"type": "str", "no_log": True}, 510 | "src": {"type": "path", "required": True}, 511 | "dest": {"type": "path", "required": True}, 512 | "direction": { 513 | "type": "str", 514 | "choices": ["push", "pull"], 515 | "default": "push", 516 | }, 517 | "protocol": { 518 | "type": "str", 519 | "choices": ["ftp", "ftps"], 520 | "default": "ftp", 521 | }, 522 | "ftp_mode": { 523 | "type": "str", 524 | "choices": ["passive", "active"], 525 | "default": "passive", 526 | }, 527 | "timeout": {"type": "int"}, 528 | "retries": {"type": "int", "default": 3}, 529 | "interval": {"type": "int", "default": 1}, 530 | "tmp_dest": {"type": "path"}, 531 | }, 532 | add_file_common_args=True, 533 | ) 534 | 535 | protocol = module.params["protocol"] 536 | if protocol == "ftp": 537 | from ftplib import FTP 538 | elif protocol == "ftps": 539 | from ftplib import FTP_TLS as FTP 540 | 541 | with contextlib.closing(FTP()) as session: 542 | try: 543 | _ftp_connect(module, session) 544 | except ftplib.all_errors as ex: 545 | module.fail_json( 546 | msg="Unable to connect to FTP server: {}".format(to_native(ex)) 547 | ) 548 | 549 | results = None 550 | direction = module.params["direction"] 551 | if direction == "push": 552 | results = _ftp_upload( 553 | module, session, module.params["src"], module.params["dest"] 554 | ) 555 | elif direction == "pull": 556 | results = _ftp_download( 557 | module, session, module.params["src"], module.params["dest"] 558 | ) 559 | module.exit_json(**results) 560 | 561 | 562 | if __name__ == "__main__": 563 | main() 564 | -------------------------------------------------------------------------------- /mtk-dude-backup/library/ftp/ftp.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: utf-8 -*- 3 | 4 | # Copyright © 2018-2019 Mohamed El Morabity 5 | # 6 | # This program is free software: you can redistribute it and/or modify it under 7 | # the terms of the GNU General Public License as published by the Free Software 8 | # Foundation, either version 3 of the License, or (at your option) any later 9 | # version. 10 | # 11 | # This program is distributed in the hope that it will be useful, but WITHOUT 12 | # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 13 | # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 14 | # details. 15 | # 16 | # You should have received a copy of the GNU General Public License along with 17 | # this program. If not, see . 18 | 19 | 20 | import contextlib 21 | from enum import Enum 22 | import ftplib 23 | import hashlib 24 | import os 25 | import tempfile 26 | import time 27 | 28 | from ansible.module_utils._text import to_native 29 | from ansible.module_utils.basic import AnsibleModule 30 | from ansible.utils.path import makedirs_safe 31 | 32 | 33 | DOCUMENTATION = """ 34 | --- 35 | module: ftp 36 | author: Mohamed El Morabity 37 | short_description: Transfers files and directories from or to FTP servers 38 | description: 39 | - Transfers files and directories from or to FTP servers. 40 | options: 41 | host: 42 | description: 43 | - FTP server. 44 | required: True 45 | port: 46 | description: 47 | - FTP port. 48 | type: int 49 | required: False 50 | default: 21 51 | user: 52 | description: 53 | - The username used to authenticate with. 54 | required: False 55 | default: null 56 | password: 57 | description: 58 | - The password used to authenticate with. 59 | required: False 60 | default: null 61 | src: 62 | description: 63 | - Path on the source host that will be synchronized to the destination. 64 | type: path 65 | required: true 66 | dest: 67 | description: 68 | - Path on the destination host that will be synchronized from the source. 69 | type: path 70 | required: true 71 | protocol: 72 | description: 73 | - FTP protocol to use. 74 | type: string 75 | required: False 76 | choices: 77 | - ftp 78 | - ftps 79 | default: ftp 80 | direction: 81 | description: 82 | - Specify the direction of the synchronization. In push mode the localhost or delegate is the source; In pull mode the remote FTP server is the source. 83 | type: string 84 | required: False 85 | choices: 86 | - push 87 | - pull 88 | default: push 89 | ftp_mode: 90 | description: 91 | - FTP mode. 92 | type: string 93 | required: False 94 | choices: 95 | - passive 96 | - active 97 | default: passive 98 | timeout: 99 | description: 100 | - Timeout in seconds for FTP request. 101 | type: int 102 | required: False 103 | backup: 104 | description: 105 | - Create a remote backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. 106 | type: bool 107 | required: False 108 | default: False 109 | retries: 110 | description: 111 | - Specifies the number of retries the upload should by tried before it is considered failed. 112 | type: int 113 | required: False 114 | default: 3 115 | interval: 116 | description: 117 | - Configures the interval in seconds to wait between retries of the upload. 118 | type: int 119 | required: False 120 | default: 1 121 | tmp_dest: 122 | description: 123 | - Absolute path of where temporary file is downloaded to. 124 | - Defaults to C(TMPDIR), C(TEMP) or C(TMP) env variables or a platform specific value. 125 | - U(https://docs.python.org/2/library/tempfile.html#tempfile.tempdir). 126 | type: string 127 | required: False 128 | others: 129 | description: 130 | - All arguments accepted by the file module also work when direction is pull. 131 | required: False 132 | """ 133 | 134 | EXAMPLES = """ 135 | # Upload a local file to a remote FTP server 136 | - local_action: 137 | module: ftp 138 | host: my.ftp.server.net 139 | user: myuser 140 | password: mypassword 141 | src: /tmp/myfile.txt 142 | dest: /dest 143 | direction: push 144 | 145 | # Download a directory from a remote FTP server 146 | - local_action: 147 | module: ftp 148 | host: my.ftp.server.net 149 | user: myuser 150 | password: mypassword 151 | src: /backups 152 | dest: /var/backups/ 153 | direction: pull 154 | """ 155 | 156 | 157 | def _ftp_retry(function): 158 | """Decorator to retry FTP commands in the case of a connection failure.""" 159 | 160 | def wrapper(module, *args, **kwargs): 161 | retries = module.params["retries"] 162 | interval = module.params["interval"] 163 | 164 | for _ in range(retries): 165 | try: 166 | return function(module, *args, **kwargs) 167 | except ftplib.all_errors: 168 | time.sleep(interval) 169 | return function(module, *args, **kwargs) 170 | 171 | return wrapper 172 | 173 | 174 | class _FTPPathStatus(Enum): 175 | """Enumeration for FTP path types.""" 176 | 177 | IS_DIR = 1 178 | IS_FILE = 2 179 | NOT_EXISTS = 3 180 | 181 | 182 | @_ftp_retry 183 | def _ftp_check_path(module, session, path): 184 | """Check whether a remote path on the FTP server is a file, a directory or 185 | doesn't exist.""" 186 | 187 | try: 188 | content = session.nlst(path) 189 | # Filter out current and parent directory 190 | content = [p for p in content if not p.endswith(("/.", "/.."))] 191 | if len(content) != 1: 192 | return (_FTPPathStatus.IS_DIR, content) 193 | if content[0] == path: 194 | return (_FTPPathStatus.IS_FILE, None) 195 | return (_FTPPathStatus.IS_DIR, content) 196 | except ftplib.all_errors as ex: 197 | code = ex.args[0][:3] 198 | if code not in ("450", "550"): 199 | raise ex 200 | return (_FTPPathStatus.NOT_EXISTS, None) 201 | 202 | 203 | @_ftp_retry 204 | def _ftp_compare_files(module, session, local_path, remote_path): 205 | """Check whether a local file and a remote one on a FTP server are 206 | identical.""" 207 | 208 | # Get local file MD5 hash 209 | local_path_hash = module.md5(local_path) 210 | 211 | # Get remote file MD5 hash 212 | md5 = hashlib.md5() 213 | session.retrbinary("RETR {}".format(remote_path), md5.update) 214 | remote_path_hash = md5.hexdigest() 215 | 216 | return local_path_hash == remote_path_hash 217 | 218 | 219 | @_ftp_retry 220 | def _ftp_mkdir(module, session, path): 221 | """Create directory (and its parents) on remote FTP server.""" 222 | 223 | sub_dirs = path.split("/") 224 | current_dir = "" 225 | for dir_ in sub_dirs: 226 | if not dir_: 227 | continue 228 | current_dir += "/{}".format(dir_) 229 | try: 230 | session.mkd(current_dir) 231 | except ftplib.error_perm as ex: 232 | code = ex.args[0][:3] 233 | # Directory already exists 234 | if code != "550": 235 | raise ex 236 | 237 | 238 | @_ftp_retry 239 | def _ftp_backup_file(module, session, path): 240 | """Create a remote backup file.""" 241 | 242 | # Note: don't use colons in backup suffix filename (MS doesn't support it) 243 | ext = time.strftime("%Y-%m-%d@%H.%M.%S~", time.localtime(time.time())) 244 | backup_path = "{}.{}.{}".format(path, os.getpid(), ext) 245 | session.rename(path, backup_path) 246 | 247 | return backup_path 248 | 249 | 250 | @_ftp_retry 251 | def _ftp_upload_file(module, session, src, dest): 252 | """Upload a local file to a FTP server.""" 253 | 254 | # Upload file 255 | with open(src, "rb") as src_object: 256 | session.storbinary("STOR {}".format(dest), src_object) 257 | 258 | 259 | @_ftp_retry 260 | def _ftp_download_file(module, session, src, dest): 261 | """Download a remote file from a FTP server.""" 262 | 263 | # Upload file 264 | with open(dest, "wb") as dest_object: 265 | session.retrbinary("RETR {}".format(src), dest_object.write) 266 | 267 | 268 | def _ftp_upload(module, session, src, dest, top_dir=True): 269 | """Upload a local file or directory to a FTP server.""" 270 | 271 | dest_is_dir = dest.strip().endswith("/") 272 | src = os.path.normpath(src) 273 | dest = os.path.normpath(dest) 274 | 275 | results = {} 276 | results["src"] = src 277 | results["dest"] = dest 278 | 279 | if not os.path.exists(src): 280 | module.fail_json(msg="Source {} does not exist".format(src)) 281 | if not os.access(src, os.R_OK): 282 | module.fail_json(msg="Source {} is not readable".format(src)) 283 | if not os.path.isfile(src) and not os.path.isdir(src): 284 | module.fail_json( 285 | msg="Source {} is not a regular file or a directory".format(src) 286 | ) 287 | 288 | try: 289 | dest_status, _ = _ftp_check_path(module, session, dest) 290 | except ftplib.all_errors as ex: 291 | module.fail_json( 292 | msg="Unable to get status for destination {}: {}".format( 293 | dest, to_native(ex) 294 | ) 295 | ) 296 | 297 | dest_exists = dest_status != _FTPPathStatus.NOT_EXISTS 298 | results["changed"] = not dest_exists 299 | dest_is_dir |= dest_status == _FTPPathStatus.IS_DIR or os.path.isdir(src) 300 | 301 | if os.path.isdir(src) and dest_status == _FTPPathStatus.IS_FILE: 302 | module.fail_json( 303 | msg="Destination {} is a file whereas source {} is a " 304 | "directory".format(dest, src) 305 | ) 306 | 307 | # Create remote parent directories 308 | if not dest_exists: 309 | dest_dir = dest if dest_is_dir else "/".join(dest.split("/")[:-1]) 310 | 311 | try: 312 | _ftp_mkdir(module, session, dest_dir) 313 | except ftplib.all_errors as ex: 314 | module.fail_json( 315 | msg="Unable to create destination directory {}: {}".format( 316 | dest, to_native(ex) 317 | ) 318 | ) 319 | 320 | # Manage recursive upload 321 | if os.path.isdir(src): 322 | if dest_exists and top_dir: 323 | dest += "/{}".format(os.path.basename(src)) 324 | 325 | for path in os.listdir(src): 326 | path_src = os.path.join(src, path) 327 | path_dest = path_src.replace(src, dest, 1).replace( 328 | os.path.sep, "/" 329 | ) 330 | path_results = _ftp_upload( 331 | module, session, path_src, path_dest, False 332 | ) 333 | results["changed"] |= path_results["changed"] 334 | return results 335 | 336 | if dest_is_dir: 337 | dest += "/{}".format(os.path.basename(src)) 338 | # Get status for destination file 339 | try: 340 | dest_status, _ = _ftp_check_path(module, session, dest) 341 | except ftplib.all_errors as ex: 342 | module.fail_json( 343 | msg="Unable to get status for destination {}: {}".format( 344 | dest, to_native(ex) 345 | ) 346 | ) 347 | dest_exists = dest_status != _FTPPathStatus.NOT_EXISTS 348 | 349 | results["changed"] |= not dest_exists or not _ftp_compare_files( 350 | module, session, src, dest 351 | ) 352 | 353 | if results["changed"]: 354 | try: 355 | if module.params["backup"] and dest_exists: 356 | results["backup_file"] = _ftp_backup_file( 357 | module, session, dest 358 | ) 359 | except ftplib.all_errors as ex: 360 | module.fail_json( 361 | msg="Unable to backup destination {}: {}".format( 362 | dest, to_native(ex) 363 | ) 364 | ) 365 | 366 | try: 367 | _ftp_upload_file(module, session, src, dest) 368 | except ftplib.all_errors as ex: 369 | module.fail_json( 370 | msg="Unable to upload source {} to destination {}: {}".format( 371 | src, dest, to_native(ex) 372 | ) 373 | ) 374 | 375 | return results 376 | 377 | 378 | def _ftp_download(module, session, src, dest, top_dir=True): 379 | """Download a remote file or directory from a FTP server.""" 380 | 381 | dest_is_dir = dest.endswith("/") 382 | 383 | src = os.path.normpath(src) 384 | dest = os.path.normpath(dest) 385 | 386 | results = {} 387 | results["src"] = src 388 | results["dest"] = dest 389 | 390 | dest_exists = os.path.exists(dest) 391 | 392 | try: 393 | src_status, src_content = _ftp_check_path(module, session, src) 394 | except ftplib.all_errors as ex: 395 | module.fail_json( 396 | msg="Unable to get status for source {}: {}".format( 397 | src, to_native(ex) 398 | ) 399 | ) 400 | 401 | if src_status == _FTPPathStatus.NOT_EXISTS: 402 | module.fail_json(msg="Source {} does not exist".format(src)) 403 | 404 | dest_is_dir |= src_status == _FTPPathStatus.IS_DIR or os.path.isdir(dest) 405 | if dest_exists: 406 | if not os.access(dest, os.W_OK): 407 | module.fail_json(msg="Destination {} is not writable".format(dest)) 408 | if not dest_is_dir and not os.path.isfile(dest): 409 | module.fail_json( 410 | msg="Destination {} is not a regular file or a " 411 | "directory".format(dest) 412 | ) 413 | 414 | if dest_exists and not dest_is_dir and src_status == _FTPPathStatus.IS_DIR: 415 | module.fail_json( 416 | msg="Source {} is a directory whereas destination {} is not a " 417 | "directory".format(dest, src) 418 | ) 419 | 420 | results["changed"] = not dest_exists 421 | 422 | # Create local parent directories 423 | if not dest_exists: 424 | dest_dir = dest if dest_is_dir else os.path.dirname(dest) 425 | makedirs_safe(dest_dir, mode=module.params["directory_mode"]) 426 | 427 | # Manage recursive download 428 | if src_status == _FTPPathStatus.IS_DIR: 429 | if dest_exists and top_dir: 430 | dest = os.path.join(dest, src.split("/")[-1]) 431 | 432 | for path in src_content: 433 | path_dest = path.replace(src, dest, 1).replace("/", os.path.sep) 434 | path_results = _ftp_download( 435 | module, session, path, path_dest, False 436 | ) 437 | results["changed"] |= path_results["changed"] 438 | return results 439 | 440 | if dest_is_dir: 441 | dest = os.path.join(dest, os.path.basename(src)) 442 | dest_exists = os.path.exists(dest) 443 | 444 | results["changed"] |= not dest_exists or not _ftp_compare_files( 445 | module, session, dest, src 446 | ) 447 | 448 | if results["changed"]: 449 | tmp_dest = module.params.get("tmp_dest") 450 | if tmp_dest: 451 | # tmp_dest should be an existing dir 452 | if not os.path.isdir(tmp_dest): 453 | if os.path.exists(tmp_dest): 454 | module.fail_json( 455 | msg="{} is a file but should be a directory".format( 456 | tmp_dest 457 | ) 458 | ) 459 | else: 460 | module.fail_json( 461 | msg="{} directory does not exist".format(tmp_dest) 462 | ) 463 | 464 | _, tmp_dest_path = tempfile.mkstemp(dir=tmp_dest) 465 | else: 466 | _, tmp_dest_path = tempfile.mkstemp() 467 | 468 | try: 469 | _ftp_download_file(module, session, src, tmp_dest_path) 470 | except ftplib.all_errors as ex: 471 | module.fail_json( 472 | msg="Unable to download source {} to destination {}: " 473 | "{}".format(src, dest, to_native(ex)) 474 | ) 475 | 476 | if module.params["backup"] and dest_exists: 477 | results["backup_file"] = module.backup_local(dest) 478 | 479 | module.atomic_move( 480 | tmp_dest_path, dest, unsafe_writes=module.params["unsafe_writes"] 481 | ) 482 | file_args = module.load_file_common_arguments(module.params) 483 | results["changed"] = module.set_file_attributes_if_different( 484 | file_args, results["changed"] 485 | ) 486 | 487 | return results 488 | 489 | 490 | @_ftp_retry 491 | def _ftp_connect(module, session): 492 | session.connect( 493 | module.params["host"], module.params["port"], module.params["timeout"] 494 | ) 495 | session.set_pasv(module.params["ftp_mode"] == "passive") 496 | session.login(module.params["user"], module.params["password"]) 497 | if module.params["protocol"] == "ftps": 498 | session.prot_p() 499 | 500 | 501 | def main(): 502 | """Main execution path.""" 503 | 504 | module = AnsibleModule( 505 | argument_spec={ 506 | "host": {"type": "str", "required": True}, 507 | "port": {"type": "int", "default": 21}, 508 | "user": {"type": "str"}, 509 | "password": {"type": "str", "no_log": True}, 510 | "src": {"type": "path", "required": True}, 511 | "dest": {"type": "path", "required": True}, 512 | "direction": { 513 | "type": "str", 514 | "choices": ["push", "pull"], 515 | "default": "push", 516 | }, 517 | "protocol": { 518 | "type": "str", 519 | "choices": ["ftp", "ftps"], 520 | "default": "ftp", 521 | }, 522 | "ftp_mode": { 523 | "type": "str", 524 | "choices": ["passive", "active"], 525 | "default": "passive", 526 | }, 527 | "timeout": {"type": "int"}, 528 | "retries": {"type": "int", "default": 3}, 529 | "interval": {"type": "int", "default": 1}, 530 | "tmp_dest": {"type": "path"}, 531 | }, 532 | add_file_common_args=True, 533 | ) 534 | 535 | protocol = module.params["protocol"] 536 | if protocol == "ftp": 537 | from ftplib import FTP 538 | elif protocol == "ftps": 539 | from ftplib import FTP_TLS as FTP 540 | 541 | with contextlib.closing(FTP()) as session: 542 | try: 543 | _ftp_connect(module, session) 544 | except ftplib.all_errors as ex: 545 | module.fail_json( 546 | msg="Unable to connect to FTP server: {}".format(to_native(ex)) 547 | ) 548 | 549 | results = None 550 | direction = module.params["direction"] 551 | if direction == "push": 552 | results = _ftp_upload( 553 | module, session, module.params["src"], module.params["dest"] 554 | ) 555 | elif direction == "pull": 556 | results = _ftp_download( 557 | module, session, module.params["src"], module.params["dest"] 558 | ) 559 | module.exit_json(**results) 560 | 561 | 562 | if __name__ == "__main__": 563 | main() 564 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /mtk-ssh-keys/library/ftp/LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /mtk-dude-backup/library/ftp/LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------