iam_policy

lib/ansible/modules/cloud/amazon/iam_policy.py

@@ -0,0 +1,325 @@
+#!/usr/bin/env python
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+DOCUMENTATION = '''
+---
+module: iam_policy
+short_description: Manage IAM policies for users, groups, and roles
+description:
+     - Allows uploading or removing IAM policies for IAM users, groups or roles.
+version_added: "1.9"
+options:
+  iam_type:
+    description:
+      - Type of IAM resource
+    required: true
+    default: null
+    choices: [ "user", "group", "role"]
+    aliases: []
+  iam_name:
+    description:
+      - Name of IAM resource you wish to target for policy actions. In other words, the user name, group name or role name.
+    required: true
+    aliases: []
+  policy_name:
+    description:
+      - The name label for the policy to create or remove.
+    required: false
+    aliases: []
+  policy_document:
+    description:
+      - The path to the properly json formatted policy file
+    required: false
+    aliases: []
+  state:
+    description:
+      - Whether to create or delete the IAM policy.
+    required: true
+    default: null
+    choices: [ "present", "absent"]
+    aliases: []
+  skip_duplicates:
+    description:
+      - By default the module looks for any policies that match the document you pass in, if there is a match it will not make a new policy object with the same rules. You can override this by specifying false which would allow for two policy objects with different names but same rules.
+    required: false
+    default: "/"
+    aliases: []
+  aws_secret_key:
+    description:
+      - AWS secret key. If not set then the value of the AWS_SECRET_KEY environment variable is used.
+    required: false
+    default: null
+    aliases: [ 'ec2_secret_key', 'secret_key' ]
+  aws_access_key:
+    description:
+      - AWS access key. If not set then the value of the AWS_ACCESS_KEY environment variable is used.
+    required: false
+    default: null
+    aliases: [ 'ec2_access_key', 'access_key' ]
+
+
+requirements: [ "boto" ]
+notes:
+  - 'Currently boto does not support the removal of Managed Policies, the module will not work removing/adding managed policies.'
+author: Jonathan I. Davila and Paul Seiffert
+'''
+
+EXAMPLES = '''
+# Create and policy with the name of 'Admin' to the group 'administrators'
+tasks:
+- name: Create two new IAM users with API keys
+  iam_policy:
+    iam_type: group
+    iam_name: administrators
+    policy_name: Admin
+    state: present
+    policy_document: admin_policy.json
+
+# Advanced example, create two new groups and add a READ-ONLY policy to both
+# groups.
+task:
+- name: Create Two Groups, Mario and Luigi
+  iam:
+    iam_type: group
+    name: "{{ item }}"
+    state: present
+  with_items:
+     - Mario
+     - Luigi
+  register: new_groups
+
+- name:
+  iam_policy:
+    iam_type: group
+    iam_name: "{{ item.created_group.group_name }}"
+    policy_name: "READ-ONLY"
+    policy_document: readonlypolicy.json
+    state: present
+  with_items: new_groups.results
+
+'''
+import json
+import urllib
+import sys
+try:
+    import boto
+    import boto.iam
+except ImportError:
+    print "failed=True msg='boto required for this module'"
+    sys.exit(1)
+
+def boto_exception(err):
+    '''generic error message handler'''
+    if hasattr(err, 'error_message'):
+        error = err.error_message
+    elif hasattr(err, 'message'):
+        error = err.message
+    else:
+        error = '%s: %s' % (Exception, err)
+
+    return error
+
+
+def user_action(module, iam, name, policy_name, skip, pdoc, state):
+  policy_match = False
+  changed = False
+  try:
+    current_policies = [cp for cp in iam.get_all_user_policies(name).
+                                        list_user_policies_result.
+                                        policy_names]
+    for pol in current_policies:
+      '''
+      urllib is needed here because boto returns url encoded strings instead
+      '''
+      if urllib.unquote(iam.get_user_policy(name, pol).
+                        get_user_policy_result.policy_document) == pdoc:
+        policy_match = True
+        if policy_match:
+          msg=("The policy document you specified already exists "
+               "under the name %s." % pol)
+    if state == 'present' and skip:
+      if policy_name not in current_policies and not policy_match:
+        changed = True
+        iam.put_user_policy(name, policy_name, pdoc)
+    elif state == 'present' and not skip:
+        changed = True
+        iam.put_user_policy(name, policy_name, pdoc)
+    elif state == 'absent':
+      try:
+        iam.delete_user_policy(name, policy_name)
+        changed = True
+      except boto.exception.BotoServerError, err:
+        error_msg = boto_exception(err)
+        if 'cannot be found.' in error_msg:
+          changed = False
+          module.exit_json(changed=changed, msg="%s policy is already absent" % policy_name)
+
+    updated_policies = [cp for cp in iam.get_all_user_policies(name).
+                                        list_user_policies_result.
+                                        policy_names]
+  except boto.exception.BotoServerError, err:
+    error_msg = boto_exception(err)
+    module.fail_json(changed=changed, msg=error_msg)
+
+  return changed, name, updated_policies
+
+
+def role_action(module, iam, name, policy_name, skip, pdoc, state):
+  policy_match = False
+  changed = False
+  try:
+    current_policies = [cp for cp in iam.list_role_policies(name).
+                                        list_role_policies_result.
+                                        policy_names]
+    for pol in current_policies:
+      if urllib.unquote(iam.get_role_policy(name, pol).
+                        get_role_policy_result.policy_document) == pdoc:
+        policy_match = True
+        if policy_match:
+          msg=("The policy document you specified already exists "
+               "under the name %s." % pol)
+    if state == 'present' and skip:
+      if policy_name not in current_policies and not policy_match:
+        changed = True
+        iam.put_role_policy(name, policy_name, pdoc)
+    elif state == 'present' and not skip:
+        changed = True
+        iam.put_role_policy(name, policy_name, pdoc)
+    elif state == 'absent':
+      try:
+        iam.delete_role_policy(name, policy_name)
+        changed = True
+      except boto.exception.BotoServerError, err:
+        error_msg = boto_exception(err)
+        if 'cannot be found.' in error_msg:
+          changed = False
+          module.exit_json(changed=changed,
+                           msg="%s policy is already absent" % policy_name)
+
+    updated_policies = [cp for cp in iam.list_role_policies(name).
+                                        list_role_policies_result.
+                                        policy_names]
+  except boto.exception.BotoServerError, err:
+    error_msg = boto_exception(err)
+    module.fail_json(changed=changed, msg=error_msg)
+
+  return changed, name, updated_policies
+
+
+def group_action(module, iam, name, policy_name, skip, pdoc, state):
+  policy_match = False
+  changed = False
+  msg=''
+  try:
+    current_policies = [cp for cp in iam.get_all_group_policies(name).
+                                        list_group_policies_result.
+                                        policy_names]
+    for pol in current_policies:
+      if urllib.unquote(iam.get_group_policy(name, pol).
+                        get_group_policy_result.policy_document) == pdoc:
+        policy_match = True
+        if policy_match:
+          msg=("The policy document you specified already exists "
+               "under the name %s." % pol)
+    if state == 'present' and skip:
+      if policy_name not in current_policies and not policy_match:
+        changed = True
+        iam.put_group_policy(name, policy_name, pdoc)
+    elif state == 'present' and not skip:
+        changed = True
+        iam.put_group_policy(name, policy_name, pdoc)
+    elif state == 'absent':
+      try:
+        iam.delete_group_policy(name, policy_name)
+        changed = True
+      except boto.exception.BotoServerError, err:
+        error_msg = boto_exception(err)
+        if 'cannot be found.' in error_msg:
+          changed = False
+          module.exit_json(changed=changed,
+                           msg="%s policy is already absent" % policy_name)
+
+    updated_policies = [cp for cp in iam.get_all_group_policies(name).
+                                        list_group_policies_result.
+                                        policy_names]
+  except boto.exception.BotoServerError, err:
+    error_msg = boto_exception(err)
+    module.fail_json(changed=changed, msg=error_msg)
+
+  return changed, name, updated_policies, msg
+
+
+def main():
+  argument_spec = ec2_argument_spec()
+  argument_spec.update(dict(
+      iam_type=dict(
+          default=None, required=True, choices=['user', 'group', 'role']),
+      state=dict(
+          default=None, required=True, choices=['present', 'absent']),
+      iam_name=dict(default=None, required=False),
+      policy_name=dict(default=None, required=True),
+      policy_document=dict(default=None, required=False),
+      skip_duplicates=dict(type='bool', default=True, required=False)
+  ))
+
+  module = AnsibleModule(
+      argument_spec=argument_spec,
+  )
+
+  state = module.params.get('state').lower()
+  iam_type = module.params.get('iam_type').lower()
+  state = module.params.get('state')
+  name = module.params.get('iam_name')
+  policy_name = module.params.get('policy_name')
+  skip = module.params.get('skip_duplicates')
+  if module.params.get('policy_document') != None:
+    with open(module.params.get('policy_document'), 'r') as json_data:
+          pdoc = json.dumps(json.load(json_data))
+          json_data.close()
+  else:
+    pdoc=None
+
+  ec2_url, aws_access_key, aws_secret_key, region = get_ec2_creds(module)
+
+  try:
+      iam = boto.iam.connection.IAMConnection(
+          aws_access_key_id=aws_access_key,
+          aws_secret_access_key=aws_secret_key,
+      )
+  except boto.exception.NoAuthHandlerFound, e:
+      module.fail_json(msg=str(e))
+
+  changed = False
+
+  if iam_type == 'user':
+    changed, user_name, current_policies = user_action(module, iam, name,
+                                                       policy_name, skip, pdoc,
+                                                       state)
+    module.exit_json(changed=changed, user_name=name, policies=current_policies)
+  elif iam_type == 'role':
+    changed, role_name, current_policies = role_action(module, iam, name,
+                                                       policy_name, skip, pdoc,
+                                                       state)
+    module.exit_json(changed=changed, role_name=name, policies=current_policies)
+  elif iam_type == 'group':
+    changed, group_name, current_policies, msg = group_action(module, iam, name,
+                                                       policy_name, skip, pdoc,
+                                                       state)
+    module.exit_json(changed=changed, group_name=name, policies=current_policies, msg=msg)
+
+from ansible.module_utils.basic import *
+from ansible.module_utils.ec2 import *
+
+main()