summaryrefslogtreecommitdiff
path: root/lib/ansible/modules/extras/cloud/amazon/sts_session_token.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ansible/modules/extras/cloud/amazon/sts_session_token.py')
-rw-r--r--lib/ansible/modules/extras/cloud/amazon/sts_session_token.py159
1 files changed, 159 insertions, 0 deletions
diff --git a/lib/ansible/modules/extras/cloud/amazon/sts_session_token.py b/lib/ansible/modules/extras/cloud/amazon/sts_session_token.py
new file mode 100644
index 0000000000..dc284deaec
--- /dev/null
+++ b/lib/ansible/modules/extras/cloud/amazon/sts_session_token.py
@@ -0,0 +1,159 @@
+#!/usr/bin/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: sts_session_token
+short_description: Obtain a session token from the AWS Security Token Service
+description:
+ - Obtain a session token from the AWS Security Token Service
+version_added: "2.2"
+author: Victor Costan (@pwnall)
+options:
+ duration_seconds:
+ description:
+ - The duration, in seconds, of the session token. See http://docs.aws.amazon.com/STS/latest/APIReference/API_GetSessionToken.html#API_GetSessionToken_RequestParameters for acceptable and default values.
+ required: false
+ default: null
+ mfa_serial_number:
+ description:
+ - The identification number of the MFA device that is associated with the user who is making the GetSessionToken call.
+ required: false
+ default: null
+ mfa_token:
+ description:
+ - The value provided by the MFA device, if the trust policy of the user requires MFA.
+ required: false
+ default: null
+notes:
+ - In order to use the session token in a following playbook task you must pass the I(access_key), I(access_secret) and I(access_token).
+extends_documentation_fragment:
+ - aws
+ - ec2
+requirements:
+ - boto3
+ - botocore
+'''
+
+RETURN = """
+sts_creds:
+ description: The Credentials object returned by the AWS Security Token Service
+ returned: always
+ type: list
+ sample:
+ access_key: ASXXXXXXXXXXXXXXXXXX
+ expiration: "2016-04-08T11:59:47+00:00"
+ secret_key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ session_token: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+changed:
+ description: True if obtaining the credentials succeeds
+ type: bool
+ returned: always
+"""
+
+
+EXAMPLES = '''
+# Note: These examples do not set authentication details, see the AWS Guide for details.
+
+# Get a session token (more details: http://docs.aws.amazon.com/STS/latest/APIReference/API_GetSessionToken.html)
+sts_session_token:
+ duration: 3600
+register: session_credentials
+
+# Use the session token obtained above to tag an instance in account 123456789012
+ec2_tag:
+ aws_access_key: "{{ session_credentials.sts_creds.access_key }}"
+ aws_secret_key: "{{ session_credentials.sts_creds.secret_key }}"
+ security_token: "{{ session_credentials.sts_creds.session_token }}"
+ resource: i-xyzxyz01
+ state: present
+ tags:
+ MyNewTag: value
+
+'''
+
+try:
+ import boto3
+ from botocore.exceptions import ClientError
+ HAS_BOTO3 = True
+except ImportError:
+ HAS_BOTO3 = False
+
+def normalize_credentials(credentials):
+ access_key = credentials.get('AccessKeyId', None)
+ secret_key = credentials.get('SecretAccessKey', None)
+ session_token = credentials.get('SessionToken', None)
+ expiration = credentials.get('Expiration', None)
+ return {
+ 'access_key': access_key,
+ 'secret_key': secret_key,
+ 'session_token': session_token,
+ 'expiration': expiration
+ }
+
+def get_session_token(connection, module):
+ duration_seconds = module.params.get('duration_seconds')
+ mfa_serial_number = module.params.get('mfa_serial_number')
+ mfa_token = module.params.get('mfa_token')
+ changed = False
+
+ args = {}
+ if duration_seconds is not None:
+ args['DurationSeconds'] = duration_seconds
+ if mfa_serial_number is not None:
+ args['SerialNumber'] = mfa_serial_number
+ if mfa_token is not None:
+ args['TokenCode'] = mfa_token
+
+ try:
+ response = connection.get_session_token(**args)
+ changed = True
+ except ClientError, e:
+ module.fail_json(msg=e)
+
+ credentials = normalize_credentials(response.get('Credentials', {}))
+ module.exit_json(changed=changed, sts_creds=credentials)
+
+def main():
+ argument_spec = ec2_argument_spec()
+ argument_spec.update(
+ dict(
+ duration_seconds = dict(required=False, default=None, type='int'),
+ mfa_serial_number = dict(required=False, default=None),
+ mfa_token = dict(required=False, default=None)
+ )
+ )
+
+ module = AnsibleModule(argument_spec=argument_spec)
+
+ if not HAS_BOTO3:
+ module.fail_json(msg='boto3 and botocore are required.')
+
+ region, ec2_url, aws_connect_kwargs = get_aws_connection_info(module, boto3=True)
+ if region:
+ connection = boto3_conn(module, conn_type='client', resource='sts', region=region, endpoint=ec2_url, **aws_connect_kwargs)
+ else:
+ module.fail_json(msg="region must be specified")
+
+ get_session_token(connection, module)
+
+
+# import module snippets
+from ansible.module_utils.basic import *
+from ansible.module_utils.ec2 import *
+
+if __name__ == '__main__':
+ main()