feat: update insights action plugin to handle oauth (ansible#15742)

Author: adrisala

awx/playbooks/action_plugins/insights.py

@@ -6,6 +6,7 @@
 import re
 
 import requests
+from urllib.parse import urljoin
 
 from ansible.plugins.action import ActionBase
 
@@ -34,27 +35,73 @@ def write_version(self, proj_path, etag):
         with open(file_path, 'w') as f:
             f.write(etag)
 
+    def _obtain_auth_token(self, oidc_endpoint, client_id, client_secret):
+        main_url = urljoin(oidc_endpoint, '/.well-known/openid-configuration')
+        response = requests.get(url=main_url, headers={'Accept': 'application/json'})
+        data = {}
+        if response.status_code != 200:
+            data['failed'] = True
+            data['msg'] = 'Expected {} to return a status code of 200 but returned status code "{}" instead with content "{}".'.format(
+                main_url, response.status_code, response.content
+            )
+            return data
+
+        auth_url = response.json().get('token_endpoint', None)
+        data = {
+            'grant_type': 'client_credentials',
+            'scope': 'api.console',
+            'client_id': client_id,
+            'client_secret': client_secret,
+        }
+        response = requests.post(url=auth_url, data=data)
+
+        if response.status_code != 200:
+            data['failed'] = True
+            data['msg'] = 'Expected {} to return a status code of 200 but returned status code "{}" instead with content "{}".'.format(
+                auth_url, response.status_code, response.content
+            )
+        else:
+            data['token'] = response.json().get('access_token', None)
+            data['token_type'] = response.json().get('token_type', None)
+        return data
+
     def run(self, tmp=None, task_vars=None):
         self._supports_check_mode = False
 
+        session = requests.Session()
         result = super(ActionModule, self).run(tmp, task_vars)
 
         insights_url = self._task.args.get('insights_url', None)
-        username = self._task.args.get('username', None)
-        password = self._task.args.get('password', None)
         proj_path = self._task.args.get('project_path', None)
         license = self._task.args.get('awx_license_type', None)
         awx_version = self._task.args.get('awx_version', None)
+        authentication = self._task.args.get('authentication', None)
+        username = self._task.args.get('username', None)
+        password = self._task.args.get('password', None)
+        client_id = self._task.args.get('client_id', None)
+        client_secret = self._task.args.get('client_secret', None)
+        oidc_endpoint = self._task.args.get('oidc_endpoint', None)
+
+        session.headers.update(
+            {
+                'Content-Type': 'application/json',
+                'User-Agent': '{} {} ({})'.format('AWX' if license == 'open' else 'Red Hat Ansible Automation Platform', awx_version, license),
+            }
+        )
+
+        if authentication == 'service_account' or (client_id and client_secret):
+            data = self._obtain_auth_token(oidc_endpoint, client_id, client_secret)
+            if 'token' not in data:
+                result['failed'] = data['failed']
+                result['msg'] = data['msg']
+                return result
+            session.headers.update({'Authorization': f'{result['token_type']} {result['token']}'})
+        elif authentication == 'basic' or (username and password):
+            session.auth = requests.auth.HTTPBasicAuth(username, password)
 
-        session = requests.Session()
-        session.auth = requests.auth.HTTPBasicAuth(username, password)
-        headers = {
-            'Content-Type': 'application/json',
-            'User-Agent': '{} {} ({})'.format('AWX' if license == 'open' else 'Red Hat Ansible Automation Platform', awx_version, license),
-        }
         url = '/api/remediations/v1/remediations'
         while url:
-            res = session.get('{}{}'.format(insights_url, url), headers=headers, timeout=120)
+            res = session.get('{}{}'.format(insights_url, url), timeout=120)
 
             if res.status_code != 200:
                 result['failed'] = True

awx/playbooks/project_update.yml

@@ -19,6 +19,9 @@
 # awx_version: Current running version of the awx or tower as a string
 # awx_license_type: "open" for AWX; else presume Tower
 # gpg_pubkey: the GPG public key to use for validation, when enabled
+# client_id: Red Hat service account client ID; required for the 'service_account' authentication method used against the Insights API
+# client_secret: Red Hat service account client secret; required for the 'service_account' authentication method used against the Insights API
+# oidc_endpoint: OpenID Connect URL for 'service_account' authentication method.
 
 - hosts: localhost
   gather_facts: false
@@ -95,11 +98,14 @@
         - name: Fetch Insights Playbook(s)
           insights:
             insights_url: "{{ insights_url }}"
-            username: "{{ scm_username }}"
-            password: "{{ scm_password }}"
+            username: "{{ scm_username | default(omit) }}"
+            password: "{{ scm_password | default(omit) }}"
             project_path: "{{ project_path }}"
             awx_license_type: "{{ awx_license_type }}"
             awx_version: "{{ awx_version }}"
+            client_id: "{{ client_id | default(omit) }}"
+            client_secret: "{{ client_secret | default(omit) }}"
+            authentication: "{{ authentication | default(omit) }}"
           register: results
 
         - name: Save Insights Version