[OJ-12496] Add bearer token authorization for Jira Server #161
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
eliwind
reviewed
Oct 18, 2021
jf_agent/main.py
Outdated
| if config.jira_url and not (jira_username and jira_password): | ||
| # This is a bit hairy, they must either provide a jira username | ||
| # and a jira password OR a single jira bearer token. | ||
| if config.jira_url and ((not (jira_username and jira_password)) and (not jira_bearer_token)): |
There was a problem hiding this comment.
(jira_username and jira_password) != bool(jira_bearer_token) perhaps?
There was a problem hiding this comment.
ie one side must be truthy and one falsy
There was a problem hiding this comment.
This makes sense but also might be a bit less readable (unless this way is more pythonic?)
sarah256
approved these changes
Oct 19, 2021
|
|
||
| 3. Add the following section to your environment variable file. This is the same file mentioned in step 3 above. Adding the following variables allows the agent to access your Jira data: | ||
| <p class="code-block"><code> | ||
| JIRA_BEARER_TOKEN=...<br/> |
There was a problem hiding this comment.
nit (feel free to ignore) I don't think you need a <br/> here
jf_agent/main.py
Outdated
| if config.jira_url and not (jira_username and jira_password): | ||
| # This is a bit hairy, they must either provide a jira username | ||
| # and a jira password OR a single jira bearer token. | ||
| if config.jira_url and ((not (jira_username and jira_password)) and (not jira_bearer_token)): |
There was a problem hiding this comment.
This makes sense but also might be a bit less readable (unless this way is more pythonic?)
In cases where a customer has disabled basic authentication on Jira server (see [here](https://confluence.atlassian.com/enterprise/disabling-basic-authentication-1044776464.html)) we want to allow using `Authorization: Bearer <token>` headers directly instead of forcing all users to use basic auth. This is a bit hacky (I would like to get this integrated upstream, PR for that coming soon) but will allow customers to use bearer tokens in the short term. Tested this locally against a Jira server running in Docker on which I disabled basic authentication and against the Jellyfish cloud Jira instance, both of which worked.
ametzger
force-pushed
the
oj-12496-bearer-token-auth
branch
from
37ac4e8 to
9c8afe0
Compare
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.
In cases where a customer has disabled basic authentication on Jira server (see here) we want to allow using
Authorization: Bearer <token>headers directly instead of forcing all users to use basic auth. This is a bit hacky but will allow customers to use bearer tokens in the short term.Tested this locally against a Jira server running in Docker on which I disabled basic authentication and against the Jellyfish cloud Jira instance, both of which worked.
Patch has also been submitted upstream, so we should use that if/when it is merged.