Add listen_port_facts module (#61463)
Co-authored-by: Nathan Davison <ndavison85@gmail.com>
This commit is contained in:
parent
a7a053defc
commit
58edfec145
3 changed files with 332 additions and 0 deletions
249
lib/ansible/modules/system/listen_ports_facts.py
Normal file
249
lib/ansible/modules/system/listen_ports_facts.py
Normal file
|
@ -0,0 +1,249 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Copyright: (c) 2017, Nathan Davison <ndavison85@gmail.com>
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: listen_ports_facts
|
||||
|
||||
author:
|
||||
- Nathan Davison (@ndavison)
|
||||
|
||||
version_added: "2.9"
|
||||
|
||||
description:
|
||||
- Gather facts on processes listening on TCP and UDP ports.
|
||||
|
||||
short_description: Gather facts on processes listening on TCP and UDP ports.
|
||||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
- name: Gather facts on listening ports
|
||||
listen_ports_facts:
|
||||
|
||||
- name: TCP whitelist violation
|
||||
debug:
|
||||
msg: TCP port {{ item.port }} by pid {{ item.pid }} violates the whitelist
|
||||
vars:
|
||||
tcp_listen_violations: "{{ ansible_facts.tcp_listen | selectattr('port', 'in', tcp_whitelist) | list }}"
|
||||
tcp_whitelist:
|
||||
- 22
|
||||
- 25
|
||||
loop: "{{ tcp_listen_violations }}"
|
||||
|
||||
- name: List TCP ports
|
||||
debug:
|
||||
msg: "{{ ansible_facts.tcp_listen | map(attribute='port') | sort | list }}"
|
||||
|
||||
- name: List UDP ports
|
||||
debug:
|
||||
msg: "{{ ansible_facts.udp_listen | map(attribute='port') | sort | list }}"
|
||||
|
||||
- name: List all ports
|
||||
debug:
|
||||
msg: "{{ (ansible_facts.tcp_listen + ansible_facts.udp_listen) | map(attribute='port') | unique | sort | list }}"
|
||||
'''
|
||||
|
||||
RETURN = r'''
|
||||
ansible_facts:
|
||||
description: Dictionary containing details of TCP and UDP ports with listening servers
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
tcp_listen:
|
||||
description: A list of processes that are listening on a TCP port.
|
||||
returned: if TCP servers were found
|
||||
type: list
|
||||
contains:
|
||||
address:
|
||||
description: The address the server is listening on.
|
||||
returned: always
|
||||
type: str
|
||||
sample: "0.0.0.0"
|
||||
name:
|
||||
description: The name of the listening process.
|
||||
returned: if user permissions allow
|
||||
type: str
|
||||
sample: "mysqld"
|
||||
pid:
|
||||
description: The pid of the listening process.
|
||||
returned: always
|
||||
type: int
|
||||
sample: 1223
|
||||
port:
|
||||
description: The port the server is listening on.
|
||||
returned: always
|
||||
type: int
|
||||
sample: 3306
|
||||
protocol:
|
||||
description: The network protocol of the server.
|
||||
returned: always
|
||||
type: str
|
||||
sample: "tcp"
|
||||
stime:
|
||||
description: The start time of the listening process.
|
||||
returned: always
|
||||
type: str
|
||||
sample: "Thu Feb 2 13:29:45 2017"
|
||||
user:
|
||||
description: The user who is running the listening process.
|
||||
returned: always
|
||||
type: str
|
||||
sample: "mysql"
|
||||
udp_listen:
|
||||
description: A list of processes that are listening on a UDP port.
|
||||
returned: if UDP servers were found
|
||||
type: list
|
||||
contains:
|
||||
address:
|
||||
description: The address the server is listening on.
|
||||
returned: always
|
||||
type: str
|
||||
sample: "0.0.0.0"
|
||||
name:
|
||||
description: The name of the listening process.
|
||||
returned: if user permissions allow
|
||||
type: str
|
||||
sample: "rsyslogd"
|
||||
pid:
|
||||
description: The pid of the listening process.
|
||||
returned: always
|
||||
type: int
|
||||
sample: 609
|
||||
port:
|
||||
description: The port the server is listening on.
|
||||
returned: always
|
||||
type: int
|
||||
sample: 514
|
||||
protocol:
|
||||
description: The network protocol of the server.
|
||||
returned: always
|
||||
type: str
|
||||
sample: "udp"
|
||||
stime:
|
||||
description: The start time of the listening process.
|
||||
returned: always
|
||||
type: str
|
||||
sample: "Thu Feb 2 13:29:45 2017"
|
||||
user:
|
||||
description: The user who is running the listening process.
|
||||
returned: always
|
||||
type: str
|
||||
sample: "root"
|
||||
'''
|
||||
|
||||
import re
|
||||
import platform
|
||||
from ansible.module_utils._text import to_native
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
|
||||
def netStatParse(raw):
|
||||
results = list()
|
||||
for line in raw.splitlines():
|
||||
listening_search = re.search('[^ ]+:[0-9]+', line)
|
||||
if listening_search:
|
||||
splitted = line.split()
|
||||
conns = re.search('([^ ]+):([0-9]+)', splitted[3])
|
||||
pidstr = ''
|
||||
if 'tcp' in splitted[0]:
|
||||
protocol = 'tcp'
|
||||
pidstr = splitted[6]
|
||||
elif 'udp' in splitted[0]:
|
||||
protocol = 'udp'
|
||||
pidstr = splitted[5]
|
||||
pids = re.search(r'(([0-9]+)/(.*)|-)', pidstr)
|
||||
if conns and pids:
|
||||
address = conns.group(1)
|
||||
port = conns.group(2)
|
||||
if (pids.group(2)):
|
||||
pid = pids.group(2)
|
||||
else:
|
||||
pid = 0
|
||||
if (pids.group(3)):
|
||||
name = pids.group(3)
|
||||
else:
|
||||
name = ''
|
||||
result = {
|
||||
'pid': int(pid),
|
||||
'address': address,
|
||||
'port': int(port),
|
||||
'protocol': protocol,
|
||||
'name': name,
|
||||
}
|
||||
if result not in results:
|
||||
results.append(result)
|
||||
else:
|
||||
raise EnvironmentError('Could not get process information for the listening ports.')
|
||||
return results
|
||||
|
||||
|
||||
def main():
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec={},
|
||||
supports_check_mode=True,
|
||||
)
|
||||
|
||||
if platform.system() != 'Linux':
|
||||
module.fail_json(msg='This module requires Linux.')
|
||||
|
||||
def getPidSTime(pid):
|
||||
ps_cmd = module.get_bin_path('ps', True)
|
||||
rc, ps_output, stderr = module.run_command([ps_cmd, '-o', 'lstart', '-p', str(pid)])
|
||||
stime = ''
|
||||
if rc == 0:
|
||||
for line in ps_output.splitlines():
|
||||
if 'started' not in line:
|
||||
stime = line
|
||||
return stime
|
||||
|
||||
def getPidUser(pid):
|
||||
ps_cmd = module.get_bin_path('ps', True)
|
||||
rc, ps_output, stderr = module.run_command([ps_cmd, '-o', 'user', '-p', str(pid)])
|
||||
user = ''
|
||||
if rc == 0:
|
||||
for line in ps_output.splitlines():
|
||||
if line != 'USER':
|
||||
user = line
|
||||
return user
|
||||
|
||||
result = {
|
||||
'changed': False,
|
||||
'ansible_facts': {
|
||||
'tcp_listen': [],
|
||||
'udp_listen': [],
|
||||
},
|
||||
}
|
||||
|
||||
try:
|
||||
netstat_cmd = module.get_bin_path('netstat', True)
|
||||
|
||||
# which ports are listening for connections?
|
||||
rc, stdout, stderr = module.run_command([netstat_cmd, '-plunt'])
|
||||
if rc == 0:
|
||||
netstatOut = netStatParse(stdout)
|
||||
for p in netstatOut:
|
||||
p['stime'] = getPidSTime(p['pid'])
|
||||
p['user'] = getPidUser(p['pid'])
|
||||
if p['protocol'] == 'tcp':
|
||||
result['ansible_facts']['tcp_listen'].append(p)
|
||||
elif p['protocol'] == 'udp':
|
||||
result['ansible_facts']['udp_listen'].append(p)
|
||||
except (KeyError, EnvironmentError) as e:
|
||||
module.fail_json(msg=to_native(e))
|
||||
|
||||
module.exit_json(**result)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
4
test/integration/targets/listen_ports_facts/aliases
Normal file
4
test/integration/targets/listen_ports_facts/aliases
Normal file
|
@ -0,0 +1,4 @@
|
|||
shippable/posix/group3
|
||||
destructive
|
||||
skip/osx
|
||||
skip/freebsd
|
79
test/integration/targets/listen_ports_facts/tasks/main.yml
Normal file
79
test/integration/targets/listen_ports_facts/tasks/main.yml
Normal file
|
@ -0,0 +1,79 @@
|
|||
# Test playbook for the listen_ports_facts module
|
||||
# Copyright: (c) 2019, Nathan Davison <ndavison85@gmail.com>
|
||||
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
- name: install netstat and netcat on deb
|
||||
apt:
|
||||
name: "{{ item }}"
|
||||
state: latest
|
||||
with_items:
|
||||
- net-tools
|
||||
- netcat
|
||||
when: ansible_os_family == "Debian"
|
||||
|
||||
- name: install netstat and netcat on rh < 7
|
||||
yum:
|
||||
name: "{{ item }}"
|
||||
state: latest
|
||||
with_items:
|
||||
- net-tools
|
||||
- nc.x86_64
|
||||
when: ansible_os_family == "RedHat" and ansible_distribution_major_version|int < 7
|
||||
|
||||
- name: install netstat and netcat on rh >= 7
|
||||
yum:
|
||||
name: "{{ item }}"
|
||||
state: latest
|
||||
with_items:
|
||||
- net-tools
|
||||
- nmap-ncat
|
||||
when: ansible_os_family == "RedHat" and ansible_distribution_major_version|int >= 7
|
||||
|
||||
- name: start UDP server on port 5555
|
||||
command: nc -u -l -p 5555
|
||||
async: 1000
|
||||
poll: 0
|
||||
when: (ansible_os_family == "RedHat" and ansible_distribution_major_version|int >= 7) or ansible_os_family == "Debian"
|
||||
|
||||
- name: start UDP server on port 5555
|
||||
command: nc -u -l 5555
|
||||
async: 1000
|
||||
poll: 0
|
||||
when: ansible_os_family == "RedHat" and ansible_distribution_major_version|int < 7
|
||||
|
||||
- name: start TCP server on port 5556
|
||||
command: "nc -l -p 5556"
|
||||
async: 1000
|
||||
poll: 0
|
||||
when: (ansible_os_family == "RedHat" and ansible_distribution_major_version|int >= 7) or ansible_os_family == "Debian"
|
||||
|
||||
- name: start TCP server on port 5556
|
||||
command: "nc -l 5556"
|
||||
async: 1000
|
||||
poll: 0
|
||||
when: ansible_os_family == "RedHat" and ansible_distribution_major_version|int < 7
|
||||
|
||||
- name: Gather listening ports facts
|
||||
listen_ports_facts:
|
||||
when: ansible_os_family == "RedHat" or ansible_os_family == "Debian"
|
||||
|
||||
- name: check for ansible_facts.udp_listen exists
|
||||
assert:
|
||||
that: ansible_facts.udp_listen is defined
|
||||
when: ansible_os_family == "RedHat" or ansible_os_family == "Debian"
|
||||
|
||||
- name: check for ansible_facts.tcp_listen exists
|
||||
assert:
|
||||
that: ansible_facts.tcp_listen is defined
|
||||
when: ansible_os_family == "RedHat" or ansible_os_family == "Debian"
|
||||
|
||||
- name: check TCP 5556 is in listening ports
|
||||
assert:
|
||||
that: 5556 in ansible_facts.tcp_listen | map(attribute='port') | sort | list
|
||||
when: (ansible_os_family == "RedHat" and ansible_distribution_major_version|int >= 7) or ansible_os_family == "Debian"
|
||||
|
||||
- name: check UDP 5555 is in listening ports
|
||||
assert:
|
||||
that: 5555 in ansible_facts.udp_listen | map(attribute='port') | sort | list
|
||||
when: (ansible_os_family == "RedHat" and ansible_distribution_major_version|int >= 7) or ansible_os_family == "Debian"
|
Loading…
Reference in a new issue