Skip to content

Update auth method by token #362

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update auth method by token #362

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
36fcfee
Update authentication method with token
Oct 16, 2024
442faf2
Adf a little precision in NOTE FOR PR REVIEWER
Oct 16, 2024
a0f300a
Forgot another precision in NOTE FOR PR REVIEWER :)
Oct 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 17 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,17 +244,30 @@ tokens as documented in [Using
PATs](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html#UsingPersonalAccessTokens-UsingPATs)
Atlassian documentation.

As documented, PATs should be used without a username in Authorization header as
Bearer tokens. Following is an example of using PAT token stored in `authinfo`
As [documented here](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/#supply-basic-auth-headers), create an API token for Jira then build a string of the form `useremail:api_token`. Then encode the string into base64 then add this block into your emacs configuration:

```
(setq jiralib-url "https://yourcompany.atlassian.net")
(setq jiralib-token
(cons "Authorization"
(concat "Basic " "<BASE64_ENCODED_STRING>")))
```

If you want to use `authinfo` file, set `password` field as `useremail:api_token` base64 encoded.

As documented, PATs should be used with a username in Authorization header as
Basic tokens. Following is an example of using PAT token stored in `authinfo`
to authenticate to JIRA:

```lisp
(setq jiralib-token
(cons "Authorization"
(concat "Bearer " (auth-source-pick-first-password
:host "jira.company.com"))))
(concat "Basic " (auth-source-pick-first-password
:host "yourcompany.atlassian.net"))))
```

NOTE FOR PR REVIEWER: should we do the base64 encoding into `(setq jiralib-token)` by using `login` and `password` from `authinfo` file instead of setting `login:password` (password == token) base64 encoded directly into `(setq jiralib-token)` or `authinfo` file?

#### Last Resort Authorization workaround (NOT secure)
However, if all else fails (your Jira instance has disabled basic auth
entirely), you can still get in by copying your web browser's
Expand Down