mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-08-22 22:11:44 -07:00
Pamd++ (#35709)
* Cleaner, more pythonic, shorter, easier to maintain * Added validation
This commit is contained in:
parent
a3cfe0d72f
commit
fabce98104
2 changed files with 744 additions and 572 deletions
|
@ -1,6 +1,6 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
# (c) 2017, Kenneth D. Evensen <kevensen@redhat.com>
|
||||
# (c) 2017, Kenneth D. Evensen <kdevensen@gmail.com>
|
||||
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
|
@ -89,6 +89,14 @@ options:
|
|||
default: /etc/pam.d/
|
||||
description:
|
||||
- This is the path to the PAM service files
|
||||
backup:
|
||||
description:
|
||||
- Create a backup file including the timestamp information so you can
|
||||
get the original file back if you somehow clobbered it incorrectly.
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: '2.6'
|
||||
|
||||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
|
@ -157,7 +165,8 @@ EXAMPLES = """
|
|||
- name: Remove specific arguments from a rule
|
||||
pamd:
|
||||
name: system-auth
|
||||
type: session control='[success=1 default=ignore]'
|
||||
type: session
|
||||
control: '[success=1 default=ignore]'
|
||||
module_path: pam_succeed_if.so
|
||||
module_arguments: crond,quiet
|
||||
state: args_absent
|
||||
|
@ -221,13 +230,14 @@ change_count:
|
|||
returned: success
|
||||
version_added: 2.4
|
||||
new_rule:
|
||||
description: The changes to the rule
|
||||
description: The changes to the rule. This was available in Ansible version 2.4 and 2.5. It was removed in 2.6.
|
||||
type: string
|
||||
sample: None None None sha512 shadow try_first_pass use_authtok
|
||||
returned: success
|
||||
version_added: 2.4
|
||||
updated_rule_(n):
|
||||
description: The rule(s) that was/were changed
|
||||
description: The rule(s) that was/were changed. This is only available in
|
||||
Ansible version 2.4 and was removed in 2.5.
|
||||
type: string
|
||||
sample:
|
||||
- password sufficient pam_unix.so sha512 shadow try_first_pass
|
||||
|
@ -250,346 +260,418 @@ dest:
|
|||
returned: success
|
||||
type: string
|
||||
sample: "/etc/pam.d/system-auth"
|
||||
backupdest:
|
||||
description:
|
||||
- "The file name of the the backup file, if created."
|
||||
returned: success
|
||||
type: string
|
||||
version_added: 2.6
|
||||
...
|
||||
'''
|
||||
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils._text import to_native
|
||||
import os
|
||||
import re
|
||||
import time
|
||||
from tempfile import NamedTemporaryFile
|
||||
from datetime import datetime
|
||||
|
||||
|
||||
# The PamdRule class encapsulates a rule in a pam.d service
|
||||
class PamdRule(object):
|
||||
RULE_REGEX = re.compile(r"""(?P<rule_type>auth|account|session|password)\s+
|
||||
(?P<control>\[.*\]|\S*)\s+
|
||||
(?P<path>\S*)\s?
|
||||
(?P<args>.*)""", re.X)
|
||||
|
||||
def __init__(self, rule_type,
|
||||
rule_control, rule_module_path,
|
||||
rule_module_args=None):
|
||||
|
||||
class PamdLine(object):
|
||||
|
||||
def __init__(self, line):
|
||||
self.line = line
|
||||
self.prev = None
|
||||
self.next = None
|
||||
|
||||
# Method to check if a rule matches the type, control and path.
|
||||
def matches(self, rule_type, rule_control, rule_path, rule_args=None):
|
||||
return False
|
||||
|
||||
def __str__(self):
|
||||
return str(self.line)
|
||||
|
||||
|
||||
class PamdComment(PamdLine):
|
||||
|
||||
def __init__(self, line):
|
||||
super(PamdComment, self).__init__(line)
|
||||
|
||||
@property
|
||||
def is_valid(self):
|
||||
if self.line.startswith('#'):
|
||||
return True
|
||||
return False
|
||||
|
||||
|
||||
class PamdInclude(PamdLine):
|
||||
def __init__(self, line):
|
||||
super(PamdInclude, self).__init__(line)
|
||||
|
||||
@property
|
||||
def is_valid(self):
|
||||
if self.line.startswith('@include'):
|
||||
return True
|
||||
return False
|
||||
|
||||
|
||||
class PamdRule(PamdLine):
|
||||
|
||||
valid_types = ['account', 'auth', 'password', 'session']
|
||||
valid_simple_controls = ['required', 'requisite', 'sufficicent', 'optional', 'include', 'substack']
|
||||
valid_control_values = ['success', 'open_err', 'symbol_err', 'service_err', 'system_err', 'buf_err',
|
||||
'perm_denied', 'auth_err', 'cred_insufficient', 'authinfo_unavail', 'user_unknown',
|
||||
'maxtries', 'new_authtok_reqd', 'acct_expired', 'session_err', 'cred_unavail',
|
||||
'cred_expired', 'cred_err', 'no_module_data', 'conv_err', 'authtok_err',
|
||||
'authtok_recover_err', 'authtok_lock_busy', 'authtok_disable_aging', 'try_again',
|
||||
'ignore', 'abort', 'authtok_expired', 'module_unknown', 'bad_item', 'conv_again',
|
||||
'incomplete', 'default']
|
||||
valid_control_actions = ['ignore', 'bad', 'die', 'ok', 'done', 'reset']
|
||||
|
||||
def __init__(self, rule_type, rule_control, rule_path, rule_args=None):
|
||||
self._control = None
|
||||
self._args = None
|
||||
self.rule_type = rule_type
|
||||
self.rule_control = rule_control
|
||||
self.rule_module_path = rule_module_path
|
||||
|
||||
try:
|
||||
if (rule_module_args is not None and
|
||||
type(rule_module_args) is list):
|
||||
self.rule_module_args = rule_module_args
|
||||
elif (rule_module_args is not None and
|
||||
type(rule_module_args) is str):
|
||||
self.rule_module_args = rule_module_args.split()
|
||||
except AttributeError:
|
||||
self.rule_module_args = []
|
||||
self.rule_path = rule_path
|
||||
self.rule_args = rule_args
|
||||
|
||||
# Method to check if a rule matches the type, control and path.
|
||||
def matches(self, rule_type, rule_control, rule_path, rule_args=None):
|
||||
if (rule_type == self.rule_type and
|
||||
rule_control == self.rule_control and
|
||||
rule_path == self.rule_path):
|
||||
return True
|
||||
return False
|
||||
|
||||
@classmethod
|
||||
def rulefromstring(cls, stringline):
|
||||
pattern = None
|
||||
|
||||
rule_type = ''
|
||||
rule_control = ''
|
||||
rule_module_path = ''
|
||||
rule_module_args = ''
|
||||
complicated = False
|
||||
|
||||
if '[' in stringline:
|
||||
pattern = re.compile(
|
||||
r"""([\-A-Za-z0-9_]+)\s* # Rule Type
|
||||
\[([A-Za-z0-9_=\s]+)\]\s* # Rule Control
|
||||
([A-Za-z0-9/_\-\.]+)\s* # Rule Path
|
||||
([A-Za-z0-9,_=<>\-\s\./]*)""", # Rule Args
|
||||
re.X)
|
||||
complicated = True
|
||||
else:
|
||||
pattern = re.compile(
|
||||
r"""([@\-A-Za-z0-9_]+)\s* # Rule Type
|
||||
([A-Za-z0-9_\-]+)\s* # Rule Control
|
||||
([A-Za-z0-9/_\-\.]*)\s* # Rule Path
|
||||
([A-Za-z0-9,_=<>\-\s\./]*)""", # Rule Args
|
||||
re.X)
|
||||
|
||||
result = pattern.match(stringline)
|
||||
rule_type = result.group(1)
|
||||
if complicated:
|
||||
rule_control = '[' + result.group(2) + ']'
|
||||
else:
|
||||
rule_control = result.group(2)
|
||||
rule_module_path = result.group(3)
|
||||
if result.group(4) is not None:
|
||||
rule_module_args = result.group(4)
|
||||
|
||||
return cls(rule_type, rule_control, rule_module_path, rule_module_args)
|
||||
|
||||
def get_module_args_as_string(self):
|
||||
try:
|
||||
if self.rule_module_args is not None:
|
||||
return ' '.join(self.rule_module_args)
|
||||
except AttributeError:
|
||||
pass
|
||||
return ''
|
||||
def rule_from_string(cls, line):
|
||||
match = RULE_REGEX.search(line)
|
||||
return cls(match.group('rule_type'), match.group('control'), match.group('path'), match.group('args'))
|
||||
|
||||
def __str__(self):
|
||||
return "%-10s\t%s\t%s %s" % (self.rule_type,
|
||||
self.rule_control,
|
||||
self.rule_module_path,
|
||||
self.get_module_args_as_string())
|
||||
if self.rule_args:
|
||||
return '{0: <11}{1} {2} {3}'.format(self.rule_type, self.rule_control, self.rule_path, ' '.join(self.rule_args))
|
||||
return '{0: <11}{1} {2}'.format(self.rule_type, self.rule_control, self.rule_path)
|
||||
|
||||
@property
|
||||
def rule_control(self):
|
||||
if isinstance(self._control, list):
|
||||
return '[' + ' '.join(self._control) + ']'
|
||||
return self._control
|
||||
|
||||
@rule_control.setter
|
||||
def rule_control(self, control):
|
||||
if control.startswith('['):
|
||||
control = control.replace(' = ', '=').replace('[', '').replace(']', '')
|
||||
self._control = control.split(' ')
|
||||
else:
|
||||
self._control = control
|
||||
|
||||
@property
|
||||
def rule_args(self):
|
||||
if not self._args:
|
||||
return []
|
||||
return self._args
|
||||
|
||||
@rule_args.setter
|
||||
def rule_args(self, args):
|
||||
if isinstance(args, str):
|
||||
args = args.replace(" = ", "=")
|
||||
self._args = args.split(" ")
|
||||
else:
|
||||
self._args = args
|
||||
|
||||
@property
|
||||
def line(self):
|
||||
return str(self)
|
||||
|
||||
@classmethod
|
||||
def is_action_unsigned_int(cls, string_num):
|
||||
number = 0
|
||||
try:
|
||||
number = int(string_num)
|
||||
except ValueError:
|
||||
return False
|
||||
|
||||
if number >= 0:
|
||||
return True
|
||||
return False
|
||||
|
||||
def validate(self):
|
||||
# Validate the rule type
|
||||
if self.rule_type not in PamdRule.valid_types:
|
||||
return False, "Rule type, " + self.rule_type + ", is not valid in rule " + self.line
|
||||
# Validate the rule control
|
||||
if isinstance(self.rule_control, str) and self.rule_control not in PamdRule.valid_simple_controls:
|
||||
return False, "Rule control, " + self.rule_control + ", is not valid in rule " + self.line
|
||||
elif isinstance(self.rule_control, list):
|
||||
for control in self.rule_control:
|
||||
value, action = control.split("=")
|
||||
if value not in PamdRule.valid_control_values:
|
||||
return False, "Rule control value, " + value + ", is not valid in rule " + self.line
|
||||
if action not in PamdRule.valid_control_actions and not PamdRule.is_action_unsigned_int(action):
|
||||
return False, "Rule control action, " + action + ", is not valid in rule " + self.line
|
||||
|
||||
# TODO: Validate path
|
||||
|
||||
return True, "Rule is valid " + self.line
|
||||
|
||||
|
||||
# PamdService encapsulates an entire service and contains one or more rules
|
||||
# PamdService encapsulates an entire service and contains one or more rules. It seems the best way is to do this
|
||||
# as a doubly linked list.
|
||||
class PamdService(object):
|
||||
|
||||
def __init__(self, ansible=None):
|
||||
def __init__(self, content):
|
||||
self._head = None
|
||||
self._tail = None
|
||||
for line in content.splitlines():
|
||||
if line.lstrip().startswith('#'):
|
||||
pamd_line = PamdComment(line)
|
||||
elif line.lstrip().startswith('@include'):
|
||||
pamd_line = PamdInclude(line)
|
||||
elif line == '':
|
||||
pamd_line = PamdLine(line)
|
||||
else:
|
||||
pamd_line = PamdRule.rule_from_string(line)
|
||||
|
||||
if ansible is not None:
|
||||
self.check = ansible.check_mode
|
||||
self.check = False
|
||||
self.ansible = ansible
|
||||
self.preamble = []
|
||||
self.rules = []
|
||||
self.fname = None
|
||||
if ansible is not None:
|
||||
self.path = self.ansible.params["path"]
|
||||
self.name = self.ansible.params["name"]
|
||||
self.append(pamd_line)
|
||||
|
||||
def load_rules_from_file(self):
|
||||
self.fname = os.path.join(self.path, self.name)
|
||||
stringline = ''
|
||||
try:
|
||||
for line in open(self.fname, 'r'):
|
||||
stringline += line.rstrip().lstrip()
|
||||
stringline += '\n'
|
||||
self.load_rules_from_string(stringline.replace("\\\n", ""))
|
||||
def append(self, pamd_line):
|
||||
if self._head is None:
|
||||
self._head = self._tail = pamd_line
|
||||
else:
|
||||
pamd_line.prev = self._tail
|
||||
pamd_line.next = None
|
||||
self._tail.next = pamd_line
|
||||
self._tail = pamd_line
|
||||
|
||||
except IOError as e:
|
||||
self.ansible.fail_json(msg='Unable to open/read PAM module \
|
||||
file %s with error %s. And line %s' %
|
||||
(self.fname, to_native(e), stringline))
|
||||
def remove(self, rule_type, rule_control, rule_path):
|
||||
current_line = self._head
|
||||
changed = 0
|
||||
|
||||
def load_rules_from_string(self, stringvalue):
|
||||
for line in stringvalue.splitlines():
|
||||
stringline = line.rstrip()
|
||||
if line.startswith('#') and not line.isspace():
|
||||
self.preamble.append(line.rstrip())
|
||||
elif (not line.startswith('#') and
|
||||
not line.isspace() and
|
||||
len(line) != 0):
|
||||
try:
|
||||
self.ansible.log(msg="Creating rule from string %s" % stringline)
|
||||
except AttributeError:
|
||||
pass
|
||||
self.rules.append(PamdRule.rulefromstring(stringline))
|
||||
while current_line is not None:
|
||||
if current_line.matches(rule_type, rule_control, rule_path):
|
||||
if current_line.prev is not None:
|
||||
current_line.prev.next = current_line.next
|
||||
current_line.next.prev = current_line.prev
|
||||
else:
|
||||
self._head = current_line.next
|
||||
current_line.next.prev = None
|
||||
changed += 1
|
||||
|
||||
def write(self):
|
||||
if self.fname is None:
|
||||
self.fname = self.path + "/" + self.name
|
||||
# If the file is a symbollic link, we'll write to the source.
|
||||
pamd_file = os.path.realpath(self.fname)
|
||||
temp_file = "/tmp/" + self.name + "_" + time.strftime("%y%m%d%H%M%S")
|
||||
try:
|
||||
f = open(temp_file, 'w')
|
||||
f.write(str(self))
|
||||
f.close()
|
||||
except IOError:
|
||||
self.ansible.fail_json(msg='Unable to create temporary \
|
||||
file %s' % self.temp_file)
|
||||
current_line = current_line.next
|
||||
return changed
|
||||
|
||||
self.ansible.atomic_move(temp_file, pamd_file)
|
||||
def get(self, rule_type, rule_control, rule_path):
|
||||
lines = []
|
||||
current_line = self._head
|
||||
while current_line is not None:
|
||||
|
||||
if isinstance(current_line, PamdRule) and current_line.matches(rule_type, rule_control, rule_path):
|
||||
lines.append(current_line)
|
||||
|
||||
current_line = current_line.next
|
||||
|
||||
return lines
|
||||
|
||||
def has_rule(self, rule_type, rule_control, rule_path):
|
||||
if self.get(rule_type, rule_control, rule_path):
|
||||
return True
|
||||
return False
|
||||
|
||||
def update_rule(self, rule_type, rule_control, rule_path,
|
||||
new_type=None, new_control=None, new_path=None, new_args=None):
|
||||
# Get a list of rules we want to change
|
||||
rules_to_find = self.get(rule_type, rule_control, rule_path)
|
||||
|
||||
for current_rule in rules_to_find:
|
||||
if new_type:
|
||||
current_rule.rule_type = new_type
|
||||
if new_control:
|
||||
current_rule.rule_control = new_control
|
||||
if new_path:
|
||||
current_rule.rule_path = new_path
|
||||
if new_args:
|
||||
if isinstance(new_args, str):
|
||||
new_args = new_args.replace(" = ", "=")
|
||||
new_args = new_args.split(' ')
|
||||
current_rule.rule_args = new_args
|
||||
|
||||
return len(rules_to_find)
|
||||
|
||||
def insert_before(self, rule_type, rule_control, rule_path,
|
||||
new_type=None, new_control=None, new_path=None, new_args=None):
|
||||
# Get a list of rules we want to change
|
||||
rules_to_find = self.get(rule_type, rule_control, rule_path)
|
||||
changed = 0
|
||||
# There are two cases to consider.
|
||||
# 1. The new rule doesn't exist before the existing rule
|
||||
# 2. The new rule exists
|
||||
|
||||
for current_rule in rules_to_find:
|
||||
# Create a new rule
|
||||
new_rule = PamdRule(new_type, new_control, new_path, new_args)
|
||||
# First we'll get the previous rule.
|
||||
previous_rule = current_rule.prev
|
||||
|
||||
# Next we may have to loop backwards if the previous line is a comment. If it
|
||||
# is, we'll get the previous "rule's" previous.
|
||||
while previous_rule is not None and isinstance(previous_rule, PamdComment):
|
||||
previous_rule = previous_rule.prev
|
||||
# Next we'll see if the previous rule matches what we are trying to insert.
|
||||
if previous_rule is not None and not previous_rule.matches(new_type, new_control, new_path):
|
||||
# First set the original previous rule's next to the new_rule
|
||||
previous_rule.next = new_rule
|
||||
# Second, set the new_rule's previous to the original previous
|
||||
new_rule.prev = previous_rule
|
||||
# Third, set the new rule's next to the current rule
|
||||
new_rule.next = current_rule
|
||||
# Fourth, set the current rule's previous to the new_rule
|
||||
current_rule.prev = new_rule
|
||||
|
||||
changed += 1
|
||||
|
||||
# Handle the case where it is the first rule in the list.
|
||||
elif previous_rule is None:
|
||||
# This is the case where the current rule is not only the first rule
|
||||
# but the first line as well. So we set the head to the new rule
|
||||
if current_rule.prev is None:
|
||||
self._head = new_rule
|
||||
# This case would occur if the previous line was a comment.
|
||||
else:
|
||||
current_rule.prev.next = new_rule
|
||||
new_rule.prev = current_rule.prev
|
||||
new_rule.next = current_rule
|
||||
current_rule.prev = new_rule
|
||||
changed += 1
|
||||
|
||||
return changed
|
||||
|
||||
def insert_after(self, rule_type, rule_control, rule_path,
|
||||
new_type=None, new_control=None, new_path=None, new_args=None):
|
||||
# Get a list of rules we want to change
|
||||
rules_to_find = self.get(rule_type, rule_control, rule_path)
|
||||
changed = 0
|
||||
# There are two cases to consider.
|
||||
# 1. The new rule doesn't exist after the existing rule
|
||||
# 2. The new rule exists
|
||||
for current_rule in rules_to_find:
|
||||
# First we'll get the next rule.
|
||||
next_rule = current_rule.next
|
||||
# Next we may have to loop forwards if the next line is a comment. If it
|
||||
# is, we'll get the next "rule's" next.
|
||||
while next_rule is not None and isinstance(next_rule, PamdComment):
|
||||
next_rule = next_rule.next
|
||||
|
||||
# First we create a new rule
|
||||
new_rule = PamdRule(new_type, new_control, new_path, new_args)
|
||||
if next_rule is not None and not next_rule.matches(new_type, new_control, new_path):
|
||||
# If the previous rule doesn't match we'll insert our new rule.
|
||||
|
||||
# Second set the original next rule's previuous to the new_rule
|
||||
next_rule.prev = new_rule
|
||||
# Third, set the new_rule's next to the original next rule
|
||||
new_rule.next = next_rule
|
||||
# Fourth, set the new rule's previous to the current rule
|
||||
new_rule.prev = current_rule
|
||||
# Fifth, set the current rule's next to the new_rule
|
||||
current_rule.next = new_rule
|
||||
|
||||
changed += 1
|
||||
|
||||
# This is the case where the current_rule is the last in the list
|
||||
elif next_rule is None:
|
||||
new_rule.prev = self._tail
|
||||
new_rule.next = None
|
||||
self._tail.next = new_rule
|
||||
self._tail = new_rule
|
||||
|
||||
current_rule.next = new_rule
|
||||
changed += 1
|
||||
|
||||
return changed
|
||||
|
||||
def add_module_arguments(self, rule_type, rule_control, rule_path, args_to_add):
|
||||
# Get a list of rules we want to change
|
||||
rules_to_find = self.get(rule_type, rule_control, rule_path)
|
||||
|
||||
changed = 0
|
||||
|
||||
for current_rule in rules_to_find:
|
||||
if isinstance(args_to_add, str):
|
||||
args_to_add = args_to_add.replace(" = ", "=")
|
||||
args_to_add = args_to_add.split(' ')
|
||||
if not args_to_add:
|
||||
args_to_add = []
|
||||
# Create a list of new args that aren't already present
|
||||
new_args = [arg for arg in args_to_add if arg not in current_rule.rule_args]
|
||||
# If there aren't any new args to add, we'll move on to the next rule
|
||||
if not new_args:
|
||||
continue
|
||||
|
||||
current_rule.rule_args = current_rule.rule_args + new_args
|
||||
|
||||
changed += 1
|
||||
|
||||
return changed
|
||||
|
||||
def remove_module_arguments(self, rule_type, rule_control, rule_path, args_to_remove):
|
||||
# Get a list of rules we want to change
|
||||
rules_to_find = self.get(rule_type, rule_control, rule_path)
|
||||
|
||||
changed = 0
|
||||
|
||||
for current_rule in rules_to_find:
|
||||
if isinstance(args_to_remove, str):
|
||||
args_to_remove = args_to_remove.replace(" = ", "=")
|
||||
args_to_remove = args_to_remove.split(' ')
|
||||
if not args_to_remove:
|
||||
args_to_remove = []
|
||||
|
||||
# Let's check to see if there are any args to remove by finding the intersection
|
||||
# of the rule's current args and the args_to_remove lists
|
||||
if not list(set(current_rule.rule_args) & set(args_to_remove)):
|
||||
continue
|
||||
|
||||
# There are args to remove, so we create a list of new_args absent the args
|
||||
# to remove.
|
||||
current_rule.rule_args = [arg for arg in current_rule.rule_args if arg not in args_to_remove]
|
||||
|
||||
changed += 1
|
||||
|
||||
return changed
|
||||
|
||||
def validate(self):
|
||||
current_line = self._head
|
||||
|
||||
while current_line is not None:
|
||||
if not current_line.is_valid()[0]:
|
||||
return current_line.is_valid()
|
||||
current_line = current_line.next
|
||||
return True, "Module is valid"
|
||||
|
||||
def __str__(self):
|
||||
stringvalue = ''
|
||||
previous_rule = None
|
||||
for amble in self.preamble:
|
||||
stringvalue += amble
|
||||
stringvalue += '\n'
|
||||
lines = []
|
||||
current_line = self._head
|
||||
|
||||
for rule in self.rules:
|
||||
if (previous_rule is not None and
|
||||
(previous_rule.rule_type.replace('-', '') !=
|
||||
rule.rule_type.replace('-', ''))):
|
||||
stringvalue += '\n'
|
||||
stringvalue += str(rule).rstrip()
|
||||
stringvalue += '\n'
|
||||
previous_rule = rule
|
||||
while current_line is not None:
|
||||
lines.append(str(current_line))
|
||||
current_line = current_line.next
|
||||
|
||||
if stringvalue.endswith('\n'):
|
||||
stringvalue = stringvalue[:-1]
|
||||
if lines[1].startswith("# Updated by Ansible"):
|
||||
lines.pop(1)
|
||||
|
||||
return stringvalue
|
||||
lines.insert(1, "# Updated by Ansible - " + datetime.now().isoformat())
|
||||
|
||||
|
||||
def update_rule(service, old_rule, new_rule):
|
||||
|
||||
changed = False
|
||||
change_count = 0
|
||||
result = {'action': 'update_rule'}
|
||||
|
||||
for rule in service.rules:
|
||||
if (old_rule.rule_type == rule.rule_type and
|
||||
old_rule.rule_control == rule.rule_control and
|
||||
old_rule.rule_module_path == rule.rule_module_path):
|
||||
|
||||
if (new_rule.rule_type is not None and
|
||||
new_rule.rule_type != rule.rule_type):
|
||||
rule.rule_type = new_rule.rule_type
|
||||
changed = True
|
||||
if (new_rule.rule_control is not None and
|
||||
new_rule.rule_control != rule.rule_control):
|
||||
rule.rule_control = new_rule.rule_control
|
||||
changed = True
|
||||
if (new_rule.rule_module_path is not None and
|
||||
new_rule.rule_module_path != rule.rule_module_path):
|
||||
rule.rule_module_path = new_rule.rule_module_path
|
||||
changed = True
|
||||
try:
|
||||
if (new_rule.rule_module_args is not None and
|
||||
new_rule.get_module_args_as_string() !=
|
||||
rule.get_module_args_as_string()):
|
||||
rule.rule_module_args = new_rule.rule_module_args
|
||||
changed = True
|
||||
except AttributeError:
|
||||
pass
|
||||
if changed:
|
||||
result['updated_rule_' + str(change_count)] = str(rule)
|
||||
result['new_rule'] = str(new_rule)
|
||||
|
||||
change_count += 1
|
||||
|
||||
result['change_count'] = change_count
|
||||
return changed, result
|
||||
|
||||
|
||||
def insert_before_rule(service, old_rule, new_rule):
|
||||
index = 0
|
||||
change_count = 0
|
||||
result = {'action':
|
||||
'insert_before_rule'}
|
||||
changed = False
|
||||
for rule in service.rules:
|
||||
if (old_rule.rule_type == rule.rule_type and
|
||||
old_rule.rule_control == rule.rule_control and
|
||||
old_rule.rule_module_path == rule.rule_module_path):
|
||||
if index == 0:
|
||||
service.rules.insert(0, new_rule)
|
||||
changed = True
|
||||
elif (new_rule.rule_type != service.rules[index - 1].rule_type or
|
||||
new_rule.rule_control !=
|
||||
service.rules[index - 1].rule_control or
|
||||
new_rule.rule_module_path !=
|
||||
service.rules[index - 1].rule_module_path):
|
||||
service.rules.insert(index, new_rule)
|
||||
changed = True
|
||||
if changed:
|
||||
result['new_rule'] = str(new_rule)
|
||||
result['before_rule_' + str(change_count)] = str(rule)
|
||||
change_count += 1
|
||||
index += 1
|
||||
result['change_count'] = change_count
|
||||
return changed, result
|
||||
|
||||
|
||||
def insert_after_rule(service, old_rule, new_rule):
|
||||
index = 0
|
||||
change_count = 0
|
||||
result = {'action': 'insert_after_rule'}
|
||||
changed = False
|
||||
for rule in service.rules:
|
||||
if (old_rule.rule_type == rule.rule_type and
|
||||
old_rule.rule_control == rule.rule_control and
|
||||
old_rule.rule_module_path == rule.rule_module_path):
|
||||
if (index == len(service.rules) - 1):
|
||||
service.rules.insert(len(service.rules), new_rule)
|
||||
changed = True
|
||||
elif (new_rule.rule_type != service.rules[index + 1].rule_type or
|
||||
new_rule.rule_control !=
|
||||
service.rules[index + 1].rule_control or
|
||||
new_rule.rule_module_path !=
|
||||
service.rules[index + 1].rule_module_path):
|
||||
service.rules.insert(index + 1, new_rule)
|
||||
changed = True
|
||||
if changed:
|
||||
result['new_rule'] = str(new_rule)
|
||||
result['after_rule_' + str(change_count)] = str(rule)
|
||||
change_count += 1
|
||||
index += 1
|
||||
|
||||
result['change_count'] = change_count
|
||||
return changed, result
|
||||
|
||||
|
||||
def remove_module_arguments(service, old_rule, module_args):
|
||||
result = {'action': 'args_absent'}
|
||||
changed = False
|
||||
change_count = 0
|
||||
|
||||
for rule in service.rules:
|
||||
if (old_rule.rule_type == rule.rule_type and
|
||||
old_rule.rule_control == rule.rule_control and
|
||||
old_rule.rule_module_path == rule.rule_module_path):
|
||||
for arg_to_remove in module_args:
|
||||
for arg in rule.rule_module_args:
|
||||
if arg == arg_to_remove:
|
||||
rule.rule_module_args.remove(arg)
|
||||
changed = True
|
||||
result['removed_arg_' + str(change_count)] = arg
|
||||
result['from_rule_' + str(change_count)] = str(rule)
|
||||
change_count += 1
|
||||
|
||||
result['change_count'] = change_count
|
||||
return changed, result
|
||||
|
||||
|
||||
def add_module_arguments(service, old_rule, module_args):
|
||||
result = {'action': 'args_present'}
|
||||
changed = False
|
||||
change_count = 0
|
||||
|
||||
for rule in service.rules:
|
||||
if (old_rule.rule_type == rule.rule_type and
|
||||
old_rule.rule_control == rule.rule_control and
|
||||
old_rule.rule_module_path == rule.rule_module_path):
|
||||
for arg_to_add in module_args:
|
||||
if "=" in arg_to_add:
|
||||
pre_string = arg_to_add[:arg_to_add.index('=') + 1]
|
||||
indicies = [i for i, arg
|
||||
in enumerate(rule.rule_module_args)
|
||||
if arg.startswith(pre_string)]
|
||||
if len(indicies) == 0:
|
||||
rule.rule_module_args.append(arg_to_add)
|
||||
changed = True
|
||||
result['added_arg_' + str(change_count)] = arg_to_add
|
||||
result['to_rule_' + str(change_count)] = str(rule)
|
||||
change_count += 1
|
||||
else:
|
||||
for i in indicies:
|
||||
if rule.rule_module_args[i] != arg_to_add:
|
||||
rule.rule_module_args[i] = arg_to_add
|
||||
changed = True
|
||||
result['updated_arg_' +
|
||||
str(change_count)] = arg_to_add
|
||||
result['in_rule_' +
|
||||
str(change_count)] = str(rule)
|
||||
change_count += 1
|
||||
elif arg_to_add not in rule.rule_module_args:
|
||||
rule.rule_module_args.append(arg_to_add)
|
||||
changed = True
|
||||
result['added_arg_' + str(change_count)] = arg_to_add
|
||||
result['to_rule_' + str(change_count)] = str(rule)
|
||||
change_count += 1
|
||||
result['change_count'] = change_count
|
||||
return changed, result
|
||||
|
||||
|
||||
def remove_rule(service, old_rule):
|
||||
result = {'action': 'absent'}
|
||||
changed = False
|
||||
change_count = 0
|
||||
for rule in service.rules:
|
||||
if (old_rule.rule_type == rule.rule_type and
|
||||
old_rule.rule_control == rule.rule_control and
|
||||
old_rule.rule_module_path == rule.rule_module_path):
|
||||
service.rules.remove(rule)
|
||||
changed = True
|
||||
return changed, result
|
||||
return '\n'.join(lines)
|
||||
|
||||
|
||||
def main():
|
||||
|
@ -611,7 +693,8 @@ def main():
|
|||
state=dict(required=False, default="updated",
|
||||
choices=['before', 'after', 'updated',
|
||||
'args_absent', 'args_present', 'absent']),
|
||||
path=dict(required=False, default='/etc/pam.d', type='str')
|
||||
path=dict(required=False, default='/etc/pam.d', type='str'),
|
||||
backup=dict(default=False, type='bool')
|
||||
),
|
||||
supports_check_mode=True,
|
||||
required_if=[
|
||||
|
@ -626,66 +709,77 @@ def main():
|
|||
|
||||
]
|
||||
)
|
||||
content = str()
|
||||
fname = os.path.join(module.params["path"], module.params["name"])
|
||||
backupdest = ""
|
||||
# Open the file and read the content or fail
|
||||
try:
|
||||
with open(fname, 'r') as service_file_obj:
|
||||
content = service_file_obj.read()
|
||||
except IOError as e:
|
||||
# If unable to read the file, fail out
|
||||
module.fail_json(msg='Unable to open/read PAM module \
|
||||
file %s with error %s.' %
|
||||
(fname, str(e)))
|
||||
|
||||
service = module.params['name']
|
||||
old_type = module.params['type']
|
||||
old_control = module.params['control']
|
||||
old_module_path = module.params['module_path']
|
||||
# Assuming we didnt fail, create the service
|
||||
service = PamdService(content)
|
||||
# Set the action
|
||||
action = module.params['state']
|
||||
|
||||
new_type = module.params['new_type']
|
||||
new_control = module.params['new_control']
|
||||
new_module_path = module.params['new_module_path']
|
||||
# Take action
|
||||
if action == 'updated':
|
||||
changes = service.update_rule(module.params['type'], module.params['control'], module.params['module_path'],
|
||||
module.params['new_type'], module.params['new_control'], module.params['new_module_path'],
|
||||
module.params['module_arguments'])
|
||||
elif action == 'before':
|
||||
changes = service.insert_before(module.params['type'], module.params['control'], module.params['module_path'],
|
||||
module.params['new_type'], module.params['new_control'], module.params['new_module_path'],
|
||||
module.params['module_arguments'])
|
||||
elif action == 'after':
|
||||
changes = service.insert_after(module.params['type'], module.params['control'], module.params['module_path'],
|
||||
module.params['new_type'], module.params['new_control'], module.params['new_module_path'],
|
||||
module.params['module_arguments'])
|
||||
elif action == 'args_absent':
|
||||
changes = service.remove_module_arguments(module.params['type'], module.params['control'], module.params['module_path'],
|
||||
module.params['module_arguments'])
|
||||
elif action == 'args_present':
|
||||
changes = service.add_module_arguments(module.params['type'], module.params['control'], module.params['module_path'],
|
||||
module.params['module_arguments'])
|
||||
elif action == 'absent':
|
||||
changes = service.remove(module.params['type'], module.params['control'], module.params['module_path'])
|
||||
|
||||
module_arguments = module.params['module_arguments']
|
||||
state = module.params['state']
|
||||
valid, msg = service.validate()
|
||||
|
||||
path = module.params['path']
|
||||
# If the module is not valid (meaning one of the rules is invalid), we will fail
|
||||
if not valid:
|
||||
module.fail_json(msg=msg)
|
||||
|
||||
pamd = PamdService(module)
|
||||
pamd.load_rules_from_file()
|
||||
# If not check mode and something changed, backup the original if necessary then write out the file or fail
|
||||
if not module.check_mode and changes > 0:
|
||||
pamd_file = os.path.realpath(fname)
|
||||
# First, create a backup if desired.
|
||||
if module.params['backup']:
|
||||
backupdest = module.backup_local(fname)
|
||||
print("BACKUP DEST", backupdest)
|
||||
try:
|
||||
temp_file = NamedTemporaryFile(mode='w')
|
||||
with open(temp_file.name, 'w') as fd:
|
||||
fd.write(str(service))
|
||||
|
||||
old_rule = PamdRule(old_type,
|
||||
old_control,
|
||||
old_module_path)
|
||||
new_rule = PamdRule(new_type,
|
||||
new_control,
|
||||
new_module_path,
|
||||
module_arguments)
|
||||
except IOError:
|
||||
module.fail_json(msg='Unable to create temporary \
|
||||
file %s' % temp_file)
|
||||
|
||||
if state == 'updated':
|
||||
change, result = update_rule(pamd,
|
||||
old_rule,
|
||||
new_rule)
|
||||
elif state == 'before':
|
||||
change, result = insert_before_rule(pamd,
|
||||
old_rule,
|
||||
new_rule)
|
||||
elif state == 'after':
|
||||
change, result = insert_after_rule(pamd,
|
||||
old_rule,
|
||||
new_rule)
|
||||
elif state == 'args_absent':
|
||||
change, result = remove_module_arguments(pamd,
|
||||
old_rule,
|
||||
module_arguments)
|
||||
elif state == 'args_present':
|
||||
change, result = add_module_arguments(pamd,
|
||||
old_rule,
|
||||
module_arguments)
|
||||
elif state == 'absent':
|
||||
change, result = remove_rule(pamd,
|
||||
old_rule)
|
||||
|
||||
if not module.check_mode and change:
|
||||
pamd.write()
|
||||
module.atomic_move(temp_file.name, pamd_file)
|
||||
|
||||
facts = {}
|
||||
facts['pamd'] = {'changed': change, 'result': result}
|
||||
|
||||
module.params['dest'] = pamd.fname
|
||||
|
||||
module.exit_json(changed=change, ansible_facts=facts)
|
||||
facts['pamd'] = {'changed': changes > 0,
|
||||
'change_count': changes,
|
||||
'action': action,
|
||||
'backupdest': backupdest}
|
||||
|
||||
module.exit_json(changed=changes > 0, ansible_facts=facts)
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue