Skip to content

Commit

Permalink
feat(gitlab modules): remove basic auth (#8405)
Browse files Browse the repository at this point in the history
BREAKING CHANGE : Remove basic auth against GitLab API
  • Loading branch information
lgatellier authored Jun 1, 2024
1 parent 54df0c9 commit 58ce19d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 23 deletions.
2 changes: 2 additions & 0 deletions changelogs/fragments/8405-gitlab-remove-basic-auth.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
removed_features:
- gitlab modules - remove basic auth feature (https://github.com/ansible-collections/community.general/pull/8405).
33 changes: 10 additions & 23 deletions plugins/module_utils/gitlab.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,29 +111,16 @@ def gitlab_authentication(module, min_version=None):
verify = ca_path if validate_certs and ca_path else validate_certs

try:
# python-gitlab library remove support for username/password authentication since 1.13.0
# Changelog : https://github.com/python-gitlab/python-gitlab/releases/tag/v1.13.0
# This condition allow to still support older version of the python-gitlab library
if LooseVersion(gitlab.__version__) < LooseVersion("1.13.0"):
module.deprecate(
"GitLab basic auth is deprecated and will be removed in next major version, "
"using another auth method (API token or OAuth) is strongly recommended.",
version='10.0.0',
collection_name='community.general')
gitlab_instance = gitlab.Gitlab(url=gitlab_url, ssl_verify=verify, email=gitlab_user, password=gitlab_password,
private_token=gitlab_token, api_version=4)
else:
# We can create an oauth_token using a username and password
# https://docs.gitlab.com/ee/api/oauth2.html#authorization-code-flow
if gitlab_user:
data = {'grant_type': 'password', 'username': gitlab_user, 'password': gitlab_password}
resp = requests.post(urljoin(gitlab_url, "oauth/token"), data=data, verify=verify)
resp_data = resp.json()
gitlab_oauth_token = resp_data["access_token"]

gitlab_instance = gitlab.Gitlab(url=gitlab_url, ssl_verify=verify, private_token=gitlab_token,
oauth_token=gitlab_oauth_token, job_token=gitlab_job_token, api_version=4)

# We can create an oauth_token using a username and password
# https://docs.gitlab.com/ee/api/oauth2.html#authorization-code-flow
if gitlab_user:
data = {'grant_type': 'password', 'username': gitlab_user, 'password': gitlab_password}
resp = requests.post(urljoin(gitlab_url, "oauth/token"), data=data, verify=verify)
resp_data = resp.json()
gitlab_oauth_token = resp_data["access_token"]

gitlab_instance = gitlab.Gitlab(url=gitlab_url, ssl_verify=verify, private_token=gitlab_token,
oauth_token=gitlab_oauth_token, job_token=gitlab_job_token, api_version=4)
gitlab_instance.auth()
except (gitlab.exceptions.GitlabAuthenticationError, gitlab.exceptions.GitlabGetError) as e:
module.fail_json(msg="Failed to connect to GitLab server: %s" % to_native(e))
Expand Down

0 comments on commit 58ce19d

Please sign in to comment.