From 3cce1217dbc9750c7e62a8672777e9f05cdd913b Mon Sep 17 00:00:00 2001
From: ottobits <vindemaio@gmail.com>
Date: Thu, 21 Apr 2022 09:54:38 +0200
Subject: [PATCH] nmap inventory plugin: Add sudo nmap (#4506)
* nmap.py: Add sudo nmap
* Update plugins/inventory/nmap.py
Change description of new plugin option adding version_added
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update plugins/inventory/nmap.py
Change boolean values of sudo option in example
Co-authored-by: Felix Fontein <felix@fontein.de>
* Create 4506-sudo-in-nmap-inv-plugin.yaml
* Fix typo in yaml format
* Update changelogs/fragments/4506-sudo-in-nmap-inv-plugin.yaml
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
* Update changelogs/fragments/4506-sudo-in-nmap-inv-plugin.yaml
Co-authored-by: Felix Fontein <felix@fontein.de>
* Document default as false.
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
---
.../fragments/4506-sudo-in-nmap-inv-plugin.yaml | 2 ++
plugins/inventory/nmap.py | 16 ++++++++++++++++
2 files changed, 18 insertions(+)
create mode 100644 changelogs/fragments/4506-sudo-in-nmap-inv-plugin.yaml
diff --git a/changelogs/fragments/4506-sudo-in-nmap-inv-plugin.yaml b/changelogs/fragments/4506-sudo-in-nmap-inv-plugin.yaml
new file mode 100644
index 0000000000..1baded5cd4
--- /dev/null
+++ b/changelogs/fragments/4506-sudo-in-nmap-inv-plugin.yaml
@@ -0,0 +1,2 @@
+minor_changes:
+- nmap inventory plugin - add ``sudo`` option in plugin in order to execute ``sudo nmap`` so that ``nmap`` runs with elevated privileges (https://github.com/ansible-collections/community.general/pull/4506).
diff --git a/plugins/inventory/nmap.py b/plugins/inventory/nmap.py
index 44d687505a..6d1779bb48 100644
--- a/plugins/inventory/nmap.py
+++ b/plugins/inventory/nmap.py
@@ -21,6 +21,11 @@ DOCUMENTATION = '''
description: token that ensures this is a source file for the 'nmap' plugin.
required: True
choices: ['nmap', 'community.general.nmap']
+ sudo:
+ description: Set to C(true) to execute a C(sudo nmap) plugin scan.
+ version_added: 4.8.0
+ default: false
+ type: boolean
address:
description: Network IP or range of IPs to scan, you can use a simple range (10.2.2.15-25) or CIDR notation.
required: True
@@ -49,6 +54,13 @@ EXAMPLES = '''
plugin: community.general.nmap
strict: False
address: 192.168.0.0/24
+
+
+# a sudo nmap scan to fully use nmap scan power.
+plugin: community.general.nmap
+sudo: true
+strict: False
+address: 192.168.0.0/24
'''
import os
@@ -135,6 +147,10 @@ class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
if not user_cache_setting or cache_needs_update:
# setup command
cmd = [self._nmap]
+
+ if self._options['sudo']:
+ cmd.insert(0, 'sudo')
+
if not self._options['ports']:
cmd.append('-sP')