mirror of
https://github.com/ansible/awx.git
synced 2026-06-20 06:07:42 -02:30
c8981e321e
The aap_token parameter was added to the collection argspec and docs in #16025, but nothing consumed it after token auth was removed in #15623: modules silently ignored the token and fell back to basic auth, breaking token authentication through the AAP gateway. Wire it up so requests authenticate with the provided token (e.g. one issued by the AAP gateway, which validates it and proxies to the controller): - Send "Authorization: Bearer <token>" in make_request when aap_token is set, skipping the basic-auth login probe; basic auth is unchanged when no token is given - Accept the token as a string or as the dict set as a fact by the ansible.platform.token module ({token: ..., id: ...}), which is the documented cross-collection mint/use/delete workflow - Restore controller_oauthtoken and tower_oauthtoken as aliases for back-compat with pre-#15623 playbooks, matching downstream - Forward aap_token through the controller_api lookup and controller inventory plugins via short_params, and add the missing CONTROLLER_OAUTH_TOKEN/TOWER_OAUTH_TOKEN env sources to the plugin doc fragment (plugins resolve env vars from doc fragments, not env_fallback); AAP_TOKEN is no longer marked deprecated there - Support tokens in the awxkit-based export/import modules - Add unit tests covering the Bearer header for both token forms, the aliases, the bad-dict failure, and the basic-auth fallback Verified end-to-end against a live gateway-fronted AAP 2.7 deployment: modules, the lookup plugin, both aliases, all env sources, dict-form tokens, job launch/wait, and a clean HTTP 401 on an invalid token. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
62 lines
2.0 KiB
Python
62 lines
2.0 KiB
Python
from __future__ import absolute_import, division, print_function
|
|
|
|
__metaclass__ = type
|
|
|
|
from .controller_api import ControllerModule
|
|
from ansible.module_utils.basic import missing_required_lib
|
|
from os import getenv
|
|
|
|
try:
|
|
from awxkit.api.client import Connection
|
|
from awxkit.api.pages.api import ApiV2
|
|
from awxkit.api import get_registered_page
|
|
|
|
HAS_AWX_KIT = True
|
|
except ImportError:
|
|
HAS_AWX_KIT = False
|
|
|
|
|
|
class ControllerAWXKitModule(ControllerModule):
|
|
connection = None
|
|
apiV2Ref = None
|
|
|
|
def __init__(self, argument_spec, **kwargs):
|
|
kwargs['supports_check_mode'] = False
|
|
|
|
super().__init__(argument_spec=argument_spec, **kwargs)
|
|
|
|
# Die if we don't have AWX_KIT installed
|
|
if not HAS_AWX_KIT:
|
|
self.fail_json(msg=missing_required_lib('awxkit'))
|
|
|
|
# Establish our conneciton object
|
|
self.connection = Connection(self.host, verify=self.verify_ssl)
|
|
|
|
def authenticate(self):
|
|
try:
|
|
if self.aap_token:
|
|
self.connection.session.headers['Authorization'] = 'Bearer {0}'.format(self.aap_token)
|
|
else:
|
|
self.connection.login(username=self.username, password=self.password)
|
|
self.authenticated = True
|
|
except Exception:
|
|
self.fail_json("Failed to authenticate")
|
|
|
|
def get_api_v2_object(self):
|
|
if not self.apiV2Ref:
|
|
if not self.authenticated:
|
|
self.authenticate()
|
|
prefix = getenv('CONTROLLER_OPTIONAL_API_URLPATTERN_PREFIX', '/api/')
|
|
if not prefix.startswith('/'):
|
|
prefix = f"/{prefix}"
|
|
if not prefix.endswith('/'):
|
|
prefix = f"{prefix}/"
|
|
v2_path = f"{prefix}v2/"
|
|
v2_index = get_registered_page(v2_path)(self.connection).get()
|
|
self.api_ref = ApiV2(connection=self.connection, **{'json': v2_index})
|
|
return self.api_ref
|
|
|
|
def logout(self):
|
|
if self.authenticated:
|
|
self.connection.logout()
|