Blame plugins/modules/ipapwpolicy.py

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