Jira: add SSL client certificate support for authentication #9753
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ansibullbot
added
docs
module
felixfontein
added
check-before-release
This comment was marked as outdated.
This comment was marked as outdated.
ansibullbot
added
ci_verified
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
There was a problem hiding this comment.
Thanks for your contribution! Please remember to add a changelog fragment. Thanks.
Co-authored-by: Felix Fontein <[email protected]>
Co-authored-by: Felix Fontein <[email protected]>
ansibullbot
removed
the
needs_revision
|
@weristdominik this PR contains the following merge commits: Please rebase your branch to remove these commits. |
ansibullbot
added
merge_commit
ansibullbot
removed
the
needs_revision
russoz
reviewed
Feb 16, 2025
ansibullbot
added
needs_ci
ansibullbot
removed
needs_ci
russoz
reviewed
Feb 16, 2025
Comment on lines
+62
to
+73
| client_cert: | ||
| type: path | ||
| description: | ||
| - Client certificate if required. | ||
| - In addition to O(username) and O(password) or O(token). Not mutually exclusive. | ||
| version_added: 10.4.0 | ||
| client_key: | ||
| type: path | ||
| description: | ||
| - Client certificate key if required. | ||
| - In addition to O(username) and O(password) or O(token). Not mutually exclusive. | ||
| version_added: 10.4.0 |
There was a problem hiding this comment.
Something that will not be solved now, let alone in this PR, is that the docs for these parameters should be in a doc_fragment, ansible-core has one for urls but that one includes a parameter .... url. I don't think ansible-core will be changing that anytime soon (in theory it should break that in two separate fragments, one for the url itself and another for all these other operational parameters for HTTP transactions, but that would imply changes in a lot modules - not gonna happen).
So, it could/should be a future PR for c.g. to create doc fragments like that and use it within the collection.
Backport to stable-10: 💚 backport PR created✅ Backport PR branch: Backported as #9763 🤖 @patchback |
felixfontein
removed
the
check-before-release
patchback bot
pushed a commit
that referenced
this pull request
Feb 16, 2025
* jira: add ssl client certificate support for authentification * fix code bugs from first CI run * fix fstring not compatible with older python and chhange urlopen module call * removed duplicated post,put,get method * fix urllib module detection Python2/ Python3 * edit HTTP Request back to fetch_url * add changelog fragment * fix python line spacing * Update plugins/modules/jira.py Co-authored-by: Felix Fontein <[email protected]> * Update plugins/modules/jira.py Co-authored-by: Felix Fontein <[email protected]> * edit documentation certificate auth not mutually exclusive * Update changelogs/fragments/9753-jira-add-client-certificate-auth.yml Co-authored-by: Felix Fontein <[email protected]> * edit documentation for client certificate auth and token * add no_log for client_cert and client_key * removed no_log for client_cert and client_key --------- Co-authored-by: domin <[email protected]> Co-authored-by: Felix Fontein <[email protected]> (cherry picked from commit fa7876b)
|
@weristdominik thanks for your contribution! |
felixfontein
pushed a commit
that referenced
this pull request
Feb 16, 2025
…ate support for authentication (#9763) Jira: add SSL client certificate support for authentication (#9753) * jira: add ssl client certificate support for authentification * fix code bugs from first CI run * fix fstring not compatible with older python and chhange urlopen module call * removed duplicated post,put,get method * fix urllib module detection Python2/ Python3 * edit HTTP Request back to fetch_url * add changelog fragment * fix python line spacing * Update plugins/modules/jira.py Co-authored-by: Felix Fontein <[email protected]> * Update plugins/modules/jira.py Co-authored-by: Felix Fontein <[email protected]> * edit documentation certificate auth not mutually exclusive * Update changelogs/fragments/9753-jira-add-client-certificate-auth.yml Co-authored-by: Felix Fontein <[email protected]> * edit documentation for client certificate auth and token * add no_log for client_cert and client_key * removed no_log for client_cert and client_key --------- Co-authored-by: domin <[email protected]> Co-authored-by: Felix Fontein <[email protected]> (cherry picked from commit fa7876b) Co-authored-by: Dominik <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SUMMARY
Enabled support for Client Certificate authentification for community.general.jira module, for all usecases (creating issue, comment etc.)
Edit
def request()function and replacedfetch_url()with usage ofurllib.request. Allowing both Username+Password (or token) AND Username+Password (or token) + Client Certificate/ Client Key.Can be used by simply adding 2x more values into each Ansible task:
client_cert: "/path/to/client.crt"client_key: "/path/to/client.key"Edit DOCUMENTATION & EXAMPLES section inside jira.py File.
ISSUE TYPE
COMPONENT NAME
jira
ADDITIONAL INFORMATION