ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

feature(gitlab): add 'ca_path' option (#7472)

Browse source
This commit is contained in:
Léo GATELLIER 2023-11-05 12:20:36 +01:00 committed by GitHub
parent 74e941e432
commit 567c7d1839
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 14 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
changelogs/fragments/7472-gitlab-add-ca-path-option.yml Normal file
View file

@ -0,0 +1,2 @@
minor_changes:
- gitlab modules - add ``ca_path`` option (https://github.com/ansible-collections/community.general/pull/7472).

5
plugins/doc_fragments/gitlab.py
View file

@ -29,4 +29,9 @@ options:
- GitLab CI job token for logging in. - GitLab CI job token for logging in.
type: str type: str
version_added: 4.2.0 version_added: 4.2.0
ca_path:
description:
- The CA certificates bundle to use to verify GitLab server certificate.
type: str
version_added: 8.1.0
''' '''

10
plugins/module_utils/gitlab.py
View file

@ -34,6 +34,7 @@ except Exception:
def auth_argument_spec(spec=None): def auth_argument_spec(spec=None):
arg_spec = (dict( arg_spec = (dict(
ca_path=dict(type='str'),
api_token=dict(type='str', no_log=True), api_token=dict(type='str', no_log=True),
api_oauth_token=dict(type='str', no_log=True), api_oauth_token=dict(type='str', no_log=True),
api_job_token=dict(type='str', no_log=True), api_job_token=dict(type='str', no_log=True),
@ -76,6 +77,7 @@ def ensure_gitlab_package(module):
def gitlab_authentication(module): def gitlab_authentication(module):
gitlab_url = module.params['api_url'] gitlab_url = module.params['api_url']
validate_certs = module.params['validate_certs'] validate_certs = module.params['validate_certs']
ca_path = module.params['ca_path']
gitlab_user = module.params['api_username'] gitlab_user = module.params['api_username']
gitlab_password = module.params['api_password'] gitlab_password = module.params['api_password']
gitlab_token = module.params['api_token'] gitlab_token = module.params['api_token']
@ -84,23 +86,25 @@ def gitlab_authentication(module):
ensure_gitlab_package(module) ensure_gitlab_package(module)
verify = ca_path if validate_certs and ca_path else validate_certs
try: try:
# python-gitlab library remove support for username/password authentication since 1.13.0 # 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 # 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 # This condition allow to still support older version of the python-gitlab library
if LooseVersion(gitlab.__version__) < LooseVersion("1.13.0"): if LooseVersion(gitlab.__version__) < LooseVersion("1.13.0"):
gitlab_instance = gitlab.Gitlab(url=gitlab_url, ssl_verify=validate_certs, email=gitlab_user, password=gitlab_password, gitlab_instance = gitlab.Gitlab(url=gitlab_url, ssl_verify=verify, email=gitlab_user, password=gitlab_password,
private_token=gitlab_token, api_version=4) private_token=gitlab_token, api_version=4)
else: else:
# We can create an oauth_token using a username and password # We can create an oauth_token using a username and password
# https://docs.gitlab.com/ee/api/oauth2.html#authorization-code-flow # https://docs.gitlab.com/ee/api/oauth2.html#authorization-code-flow
if gitlab_user: if gitlab_user:
data = {'grant_type': 'password', 'username': gitlab_user, 'password': gitlab_password} data = {'grant_type': 'password', 'username': gitlab_user, 'password': gitlab_password}
resp = requests.post(urljoin(gitlab_url, "oauth/token"), data=data, verify=validate_certs) resp = requests.post(urljoin(gitlab_url, "oauth/token"), data=data, verify=verify)
resp_data = resp.json() resp_data = resp.json()
gitlab_oauth_token = resp_data["access_token"] gitlab_oauth_token = resp_data["access_token"]
gitlab_instance = gitlab.Gitlab(url=gitlab_url, ssl_verify=validate_certs, private_token=gitlab_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) oauth_token=gitlab_oauth_token, job_token=gitlab_job_token, api_version=4)
gitlab_instance.auth() gitlab_instance.auth()