Blame plugins/modules/ipapwpolicy.py

Packit Service ee01e6
#!/usr/bin/python
Packit Service 0a38ef
# -*- coding: utf-8 -*-
Packit Service 0a38ef
Packit Service 0a38ef
# Authors:
Packit Service 0a38ef
#   Thomas Woerner <twoerner@redhat.com>
Packit Service 0a38ef
#
Packit Service 0a38ef
# Copyright (C) 2019 Red Hat
Packit Service 0a38ef
# see file 'COPYING' for use and warranty information
Packit Service 0a38ef
#
Packit Service 0a38ef
# This program is free software; you can redistribute it and/or modify
Packit Service 0a38ef
# it under the terms of the GNU General Public License as published by
Packit Service 0a38ef
# the Free Software Foundation, either version 3 of the License, or
Packit Service 0a38ef
# (at your option) any later version.
Packit Service 0a38ef
#
Packit Service 0a38ef
# This program is distributed in the hope that it will be useful,
Packit Service 0a38ef
# but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit Service 0a38ef
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit Service 0a38ef
# GNU General Public License for more details.
Packit Service 0a38ef
#
Packit Service 0a38ef
# You should have received a copy of the GNU General Public License
Packit Service 0a38ef
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
Packit Service 0a38ef
Packit Service 0a38ef
ANSIBLE_METADATA = {
Packit Service 0a38ef
    "metadata_version": "1.0",
Packit Service 0a38ef
    "supported_by": "community",
Packit Service 0a38ef
    "status": ["preview"],
Packit Service 0a38ef
}
Packit Service 0a38ef
Packit Service 0a38ef
DOCUMENTATION = """
Packit Service 0a38ef
---
Packit Service 0a38ef
module: ipapwpolicy
Packit Service 0a38ef
short description: Manage FreeIPA pwpolicies
Packit Service 0a38ef
description: Manage FreeIPA pwpolicies
Packit Service 0a38ef
options:
Packit Service 0a38ef
  ipaadmin_principal:
Packit Service 0a38ef
    description: The admin principal
Packit Service 0a38ef
    default: admin
Packit Service 0a38ef
  ipaadmin_password:
Packit Service 0a38ef
    description: The admin password
Packit Service 0a38ef
    required: false
Packit Service 0a38ef
  name:
Packit Service 0a38ef
    description: The group name
Packit Service 0a38ef
    required: false
Packit Service 0a38ef
    aliases: ["cn"]
Packit Service 0a38ef
  maxlife:
Packit Service 0a38ef
    description: Maximum password lifetime (in days)
Packit Service 0a38ef
    type: int
Packit Service 0a38ef
    required: false
Packit Service 0a38ef
    aliases: ["krbmaxpwdlife"]
Packit Service 0a38ef
  minlife:
Packit Service 0a38ef
    description: Minimum password lifetime (in hours)
Packit Service 0a38ef
    type: int
Packit Service 0a38ef
    required: false
Packit Service 0a38ef
    aliases: ["krbminpwdlife"]
Packit Service 0a38ef
  history:
Packit Service 0a38ef
    description: Password history size
Packit Service 0a38ef
    type: int
Packit Service 0a38ef
    required: false
Packit Service 0a38ef
    aliases: ["krbpwdhistorylength"]
Packit Service 0a38ef
  minclasses:
Packit Service 0a38ef
    description: Minimum number of character classes
Packit Service 0a38ef
    type: int
Packit Service 0a38ef
    required: false
Packit Service 0a38ef
    aliases: ["krbpwdmindiffchars"]
Packit Service 0a38ef
  minlength:
Packit Service 0a38ef
    description: Minimum length of password
Packit Service 0a38ef
    type: int
Packit Service 0a38ef
    required: false
Packit Service 0a38ef
    aliases: ["krbpwdminlength"]
Packit Service 0a38ef
  priority:
Packit Service 0a38ef
    description: Priority of the policy (higher number means lower priority)
Packit Service 0a38ef
    type: int
Packit Service 0a38ef
    required: false
Packit Service 0a38ef
    aliases: ["cospriority"]
Packit Service 0a38ef
  maxfail:
Packit Service 0a38ef
    description: Consecutive failures before lockout
Packit Service 0a38ef
    type: int
Packit Service 0a38ef
    required: false
Packit Service 0a38ef
    aliases: ["krbpwdmaxfailure"]
Packit Service 0a38ef
  failinterval:
Packit Service 0a38ef
    description: Period after which failure count will be reset (seconds)
Packit Service 0a38ef
    type: int
Packit Service 0a38ef
    required: false
Packit Service 0a38ef
    aliases: ["krbpwdfailurecountinterval"]
Packit Service 0a38ef
  lockouttime:
Packit Service 0a38ef
    description: Period for which lockout is enforced (seconds)
Packit Service 0a38ef
    type: int
Packit Service 0a38ef
    required: false
Packit Service 0a38ef
    aliases: ["krbpwdlockoutduration"]
Packit Service 0a38ef
  state:
Packit Service 0a38ef
    description: State to ensure
Packit Service 0a38ef
    default: present
Packit Service 0a38ef
    choices: ["present", "absent"]
Packit Service 0a38ef
author:
Packit Service 0a38ef
    - Thomas Woerner
Packit Service 0a38ef
"""
Packit Service 0a38ef
Packit Service 0a38ef
EXAMPLES = """
Packit Service 0a38ef
# Ensure pwpolicy is set for ops
Packit Service 0a38ef
- ipapwpolicy:
Packit Service 0a38ef
    ipaadmin_password: SomeADMINpassword
Packit Service 0a38ef
    name: ops
Packit Service 0a38ef
    minlife: 7
Packit Service 0a38ef
    maxlife: 49
Packit Service 0a38ef
    history: 5
Packit Service 0a38ef
    priority: 1
Packit Service 0a38ef
    lockouttime: 300
Packit Service 0a38ef
    minlength: 8
Packit Service 0a38ef
"""
Packit Service 0a38ef
Packit Service 0a38ef
RETURN = """
Packit Service 0a38ef
"""
Packit Service 0a38ef
Packit Service 0a38ef
from ansible.module_utils.basic import AnsibleModule
Packit Service 0a38ef
from ansible.module_utils._text import to_text
Packit Service 0a38ef
from ansible.module_utils.ansible_freeipa_module import temp_kinit, \
Packit Service 0a38ef
    temp_kdestroy, valid_creds, api_connect, api_command, compare_args_ipa
Packit Service 0a38ef
Packit Service 0a38ef
Packit Service 0a38ef
def find_pwpolicy(module, name):
Packit Service 0a38ef
    _args = {
Packit Service 0a38ef
        "all": True,
Packit Service 0a38ef
        "cn": to_text(name),
Packit Service 0a38ef
    }
Packit Service 0a38ef
Packit Service 0a38ef
    _result = api_command(module, "pwpolicy_find", to_text(name), _args)
Packit Service 0a38ef
Packit Service 0a38ef
    if len(_result["result"]) > 1:
Packit Service 0a38ef
        module.fail_json(
Packit Service 0a38ef
            msg="There is more than one pwpolicy '%s'" % (name))
Packit Service 0a38ef
    elif len(_result["result"]) == 1:
Packit Service 0a38ef
        return _result["result"][0]
Packit Service 0a38ef
    else:
Packit Service 0a38ef
        return None
Packit Service 0a38ef
Packit Service 0a38ef
Packit Service 0a38ef
def gen_args(maxlife, minlife, history, minclasses, minlength, priority,
Packit Service 0a38ef
             maxfail, failinterval, lockouttime):
Packit Service 0a38ef
    _args = {}
Packit Service 0a38ef
    if maxlife is not None:
Packit Service 0a38ef
        _args["krbmaxpwdlife"] = maxlife
Packit Service 0a38ef
    if minlife is not None:
Packit Service 0a38ef
        _args["krbminpwdlife"] = minlife
Packit Service 0a38ef
    if history is not None:
Packit Service 0a38ef
        _args["krbpwdhistorylength"] = history
Packit Service 0a38ef
    if minclasses is not None:
Packit Service 0a38ef
        _args["krbpwdmindiffchars"] = minclasses
Packit Service 0a38ef
    if minlength is not None:
Packit Service 0a38ef
        _args["krbpwdminlength"] = minlength
Packit Service 0a38ef
    if priority is not None:
Packit Service 0a38ef
        _args["cospriority"] = priority
Packit Service 0a38ef
    if maxfail is not None:
Packit Service 0a38ef
        _args["krbpwdmaxfailure"] = maxfail
Packit Service 0a38ef
    if failinterval is not None:
Packit Service 0a38ef
        _args["krbpwdfailurecountinterval"] = failinterval
Packit Service 0a38ef
    if lockouttime is not None:
Packit Service 0a38ef
        _args["krbpwdlockoutduration"] = lockouttime
Packit Service 0a38ef
Packit Service 0a38ef
    return _args
Packit Service 0a38ef
Packit Service 0a38ef
Packit Service 0a38ef
def main():
Packit Service 0a38ef
    ansible_module = AnsibleModule(
Packit Service 0a38ef
        argument_spec=dict(
Packit Service 0a38ef
            # general
Packit Service 0a38ef
            ipaadmin_principal=dict(type="str", default="admin"),
Packit Service 0a38ef
            ipaadmin_password=dict(type="str", required=False, no_log=True),
Packit Service 0a38ef
Packit Service 0a38ef
            name=dict(type="list", aliases=["cn"], default=None,
Packit Service 0a38ef
                      required=False),
Packit Service 0a38ef
            # present
Packit Service 0a38ef
Packit Service 0a38ef
            maxlife=dict(type="int", aliases=["krbmaxpwdlife"], default=None),
Packit Service 0a38ef
            minlife=dict(type="int", aliases=["krbminpwdlife"], default=None),
Packit Service 0a38ef
            history=dict(type="int", aliases=["krbpwdhistorylength"],
Packit Service 0a38ef
                         default=None),
Packit Service 0a38ef
            minclasses=dict(type="int", aliases=["krbpwdmindiffchars"],
Packit Service 0a38ef
                            default=None),
Packit Service 0a38ef
            minlength=dict(type="int", aliases=["krbpwdminlength"],
Packit Service 0a38ef
                           default=None),
Packit Service 0a38ef
            priority=dict(type="int", aliases=["cospriority"], default=None),
Packit Service 0a38ef
            maxfail=dict(type="int", aliases=["krbpwdmaxfailure"],
Packit Service 0a38ef
                         default=None),
Packit Service 0a38ef
            failinterval=dict(type="int",
Packit Service 0a38ef
                              aliases=["krbpwdfailurecountinterval"],
Packit Service 0a38ef
                              default=None),
Packit Service 0a38ef
            lockouttime=dict(type="int", aliases=["krbpwdlockoutduration"],
Packit Service 0a38ef
                             default=None),
Packit Service 0a38ef
            # state
Packit Service 0a38ef
            state=dict(type="str", default="present",
Packit Service 0a38ef
                       choices=["present", "absent"]),
Packit Service 0a38ef
        ),
Packit Service 0a38ef
        supports_check_mode=True,
Packit Service 0a38ef
    )
Packit Service 0a38ef
Packit Service 0a38ef
    ansible_module._ansible_debug = True
Packit Service 0a38ef
Packit Service 0a38ef
    # Get parameters
Packit Service 0a38ef
Packit Service 0a38ef
    # general
Packit Service 0a38ef
    ipaadmin_principal = ansible_module.params.get("ipaadmin_principal")
Packit Service 0a38ef
    ipaadmin_password = ansible_module.params.get("ipaadmin_password")
Packit Service 0a38ef
    names = ansible_module.params.get("name")
Packit Service 0a38ef
Packit Service 0a38ef
    # present
Packit Service 0a38ef
    maxlife = ansible_module.params.get("maxlife")
Packit Service 0a38ef
    minlife = ansible_module.params.get("minlife")
Packit Service 0a38ef
    history = ansible_module.params.get("history")
Packit Service 0a38ef
    minclasses = ansible_module.params.get("minclasses")
Packit Service 0a38ef
    minlength = ansible_module.params.get("minlength")
Packit Service 0a38ef
    priority = ansible_module.params.get("priority")
Packit Service 0a38ef
    maxfail = ansible_module.params.get("maxfail")
Packit Service 0a38ef
    failinterval = ansible_module.params.get("failinterval")
Packit Service 0a38ef
    lockouttime = ansible_module.params.get("lockouttime")
Packit Service 0a38ef
Packit Service 0a38ef
    # state
Packit Service 0a38ef
    state = ansible_module.params.get("state")
Packit Service 0a38ef
Packit Service 0a38ef
    # Check parameters
Packit Service 0a38ef
Packit Service 0a38ef
    if names is None:
Packit Service 0a38ef
        names = ["global_policy"]
Packit Service 0a38ef
Packit Service 0a38ef
    if state == "present":
Packit Service 0a38ef
        if len(names) != 1:
Packit Service 0a38ef
            ansible_module.fail_json(
Packit Service 0a38ef
                msg="Only one pwpolicy can be set at a time.")
Packit Service 0a38ef
Packit Service 0a38ef
    if state == "absent":
Packit Service 0a38ef
        if len(names) < 1:
Packit Service 0a38ef
            ansible_module.fail_json(msg="No name given.")
Packit Service 0a38ef
        if "global_policy" in names:
Packit Service 0a38ef
            ansible_module.fail_json(
Packit Service 0a38ef
                msg="'global_policy' can not be made absent.")
Packit Service 0a38ef
        invalid = ["maxlife", "minlife", "history", "minclasses",
Packit Service 0a38ef
                   "minlength", "priority", "maxfail", "failinterval",
Packit Service 0a38ef
                   "lockouttime"]
Packit Service 0a38ef
        for x in invalid:
Packit Service 0a38ef
            if vars()[x] is not None:
Packit Service 0a38ef
                ansible_module.fail_json(
Packit Service 0a38ef
                    msg="Argument '%s' can not be used with state '%s'" %
Packit Service 0a38ef
                    (x, state))
Packit Service 0a38ef
Packit Service 0a38ef
    # Init
Packit Service 0a38ef
Packit Service 0a38ef
    changed = False
Packit Service 0a38ef
    exit_args = {}
Packit Service 0a38ef
    ccache_dir = None
Packit Service 0a38ef
    ccache_name = None
Packit Service 0a38ef
    try:
Packit Service 0a38ef
        if not valid_creds(ansible_module, ipaadmin_principal):
Packit Service 0a38ef
            ccache_dir, ccache_name = temp_kinit(ipaadmin_principal,
Packit Service 0a38ef
                                                 ipaadmin_password)
Packit Service 0a38ef
        api_connect()
Packit Service 0a38ef
Packit Service 0a38ef
        commands = []
Packit Service 0a38ef
Packit Service 0a38ef
        for name in names:
Packit Service 0a38ef
            # Try to find pwpolicy
Packit Service 0a38ef
            res_find = find_pwpolicy(ansible_module, name)
Packit Service 0a38ef
Packit Service 0a38ef
            # Create command
Packit Service 0a38ef
            if state == "present":
Packit Service 0a38ef
                # Generate args
Packit Service 0a38ef
                args = gen_args(maxlife, minlife, history, minclasses,
Packit Service 0a38ef
                                minlength, priority, maxfail, failinterval,
Packit Service 0a38ef
                                lockouttime)
Packit Service 0a38ef
Packit Service 0a38ef
                # Found the pwpolicy
Packit Service 0a38ef
                if res_find is not None:
Packit Service 0a38ef
                    # For all settings is args, check if there are
Packit Service 0a38ef
                    # different settings in the find result.
Packit Service 0a38ef
                    # If yes: modify
Packit Service 0a38ef
                    if not compare_args_ipa(ansible_module, args,
Packit Service 0a38ef
                                            res_find):
Packit Service 0a38ef
                        commands.append([name, "pwpolicy_mod", args])
Packit Service 0a38ef
                else:
Packit Service 0a38ef
                    commands.append([name, "pwpolicy_add", args])
Packit Service 0a38ef
Packit Service 0a38ef
            elif state == "absent":
Packit Service 0a38ef
                if res_find is not None:
Packit Service 0a38ef
                    commands.append([name, "pwpolicy_del", {}])
Packit Service 0a38ef
Packit Service 0a38ef
            else:
Packit Service 0a38ef
                ansible_module.fail_json(msg="Unkown state '%s'" % state)
Packit Service 0a38ef
Packit Service 0a38ef
        # Execute commands
Packit Service 0a38ef
Packit Service 0a38ef
        for name, command, args in commands:
Packit Service 0a38ef
            try:
Packit Service 0a38ef
                api_command(ansible_module, command, to_text(name), args)
Packit Service 0a38ef
                changed = True
Packit Service 0a38ef
            except Exception as e:
Packit Service 0a38ef
                ansible_module.fail_json(msg="%s: %s: %s" % (command, name,
Packit Service 0a38ef
                                                             str(e)))
Packit Service 0a38ef
Packit Service 0a38ef
    except Exception as e:
Packit Service 0a38ef
        ansible_module.fail_json(msg=str(e))
Packit Service 0a38ef
Packit Service 0a38ef
    finally:
Packit Service 0a38ef
        temp_kdestroy(ccache_dir, ccache_name)
Packit Service 0a38ef
Packit Service 0a38ef
    # Done
Packit Service 0a38ef
Packit Service 0a38ef
    ansible_module.exit_json(changed=changed, **exit_args)
Packit Service 0a38ef
Packit Service 0a38ef
Packit Service 0a38ef
if __name__ == "__main__":
Packit Service 0a38ef
    main()