-
New Feature
-
Resolution: Not A Defect
-
Minor
-
None
-
Powered by SuggestiMate
You recently used a password to access an endpoint through the GitHub API using okhttp/2.7.5. We will deprecate basic authentication using password to this endpoint soon:
https://api.github.com/repositories/155774655
We recommend using a personal access token (PAT) with the appropriate scope to access this endpoint instead. Visit https://github.com/settings/tokens for more information.
This might be just something that admins need to deal w/, but it would be helpful if there was a migration page explaining what to do from the jenkins side.
(it isn't particularly obvious to me)
[JENKINS-60480] github is deprecating basic authentication using password
Isn't that message saying that you can continue to use basic auth so long as instead of using your actual password you use a personal access token. Generate a personal access token from the GitHub "Settings" page and store that personal access token in the Jenkins username / password credential as the password. Place your username as the username. Check that it works. It has been working that way for me.
markewaite: Do you know what permissions we should give it in https://github.com/settings/tokens/new?
My ticket isn't claiming that work necessarily needs to be done in the plugin, just that a "what to do" should be published. (Although, probably it's best for the plugin to just guide people through the process since it seems like it'd be pretty easy for it to do that and remember "this token is good" or something.)
Repository read should be enough jsoref, unless your job is pushing changes back to the server.
I think we should document the credential choices as part of a larger picture of ways to use Jenkins most effectively with git. When using GitHub, prefer username and a personal access tokens rather than username and password. Same advice would apply to Bitbucket, Gitlab, Gitea, Team Foundation Server, and more.
Also, a quick look at my jenkins /credentials/store/system/domain/_/ shows that the account currently has a token with repo which was Last used within the last week according to github, and yet, I'm still getting warnings.
Maybe you're using the actual password from another location or through a different credential? I've not received any warnings from GitHub for my https repository access. I'll continue watching my mailbox in case it arrives.
Ok, for us, there were apparently two items. I've switched things over to the other one. Hopefully that will make the alert go away.
But this experience was painful.
One thing that would help immensely is the ability to search for credentials whose password matches an entered value. Expected results should only include passwords the searching user is allowed to use. Had I been able to do that, I could have quickly identified the problem.
Fwiw, the best I've managed is:
admin:org, admin:public_key, admin:repo_hook, read:user, repo
We had credentials of:
repo
admin:repo_hook, repo
But they weren't sufficient for us.
markewaite I did the following:
- Created personal token in Github
- Created credentials in Jenkins: username is username and password is the Github token
- Now I navigate to Manage Jenkins -> Configure System -> Github
- Under credentials, I don't see the new credentials I created in one of the previous steps (I'm guessing because it was username and password and it only shows items with keys only)
Also, I did try:
- Advance -> Manage Additional Github Actions -> Convert login and password to token
- When I create the token from the credentials I get the following error:
Can't create GH token - {"message":"This API can only be accessed with username and password Basic Auth","documentation_url":"https://developer.github.com/v3"}
- When I create token from login and password (username = username, password = token) I get:
Can't create GH token for xenomedia-deploy - {"message":"This API can only be accessed with username and password Basic Auth","documentation_url":"https://developer.github.com/v3"}
- When I create token from login and password (actual username and password)
Can't create GH token for username - null
Any idea what I am doing wrong? You mentioned that this was working for you.
albertski the technique that works on my Jenkins server is to use the GitHub personal access token to define a Secret text credential, then use that in the Manage Jenkins -> GitHub section. I was personally surprised when that worked, since I've been conditioned to use one of two types of credentials to interact with GitHub, either private key (for ssh protocol) or username/password (for https). Secret text is a third type and that "Manage Jenkins" field for GitHub is the only place where I've used it as far as I remember.
Thanks markewaite. Adding just the personal access token as Secret Text did work. I'll see if I get an alert of deprecated authentication.
Github is removing all support for basic auth on Nov 13, 2020 (with service brownouts on Sep 30 and Oct 28)
https://developer.github.com/changes/2020-02-14-deprecating-password-auth/
I have been using an access token with the "Username with password" credential type, but I don't think this will continue to work, as the branch source plugin is still sending those credentials via basic auth:
Is the branch source plugin currently capable of sending the credentials via the HTTP Authorization header, or will this require a code change?
You can certainly use a PAT, but note that JENKINS-57351 was released which allows github-branch-source to use App authentication. Not currently available for non-multibranch use cases, though it has been proposed to push this code down into the github-api library.
jglick: I don't think using a PAT is an option right now unless I've missed something? I'm trying to configure the plugin using a user that requires 2FA and as a result my only option is to use a Personal Access Token but it's not working.
I get the following in Jenkins when I do so:
At first, I thought that it was an issue with my token, so I tried the following:
$ curl 'https://{username}:{personal_access_token}@api.github.com/user' { "login": "{username}", ... }
Since this worked as expected, I was confused... Then I stumbled upon this issue and tried my curl request by setting the header like the code described in the previous comments/screenshots :
$ curl -H 'Authorization: Basic {base64("{username}:{personal_access_token}")}' 'https://api.github.com/user' { "message": "Bad credentials", "documentation_url": "https://developer.github.com/v3" }
I don't have a non-2fa GitHub account to check with, but I'm assuming that using a personal access token in a Basic Authorisation header is no longer supported by GitHub? Unless I'm missing something?
It does seem a bit odd assuming that it worked previously as it doesn't line up with GitHub's stated deprecation dates. Unless a PAT never worked? I can confirm that using Authorization: token personal_access_token in curl works as expected, but I see no way of doing this in the plugin right now?
liamnichols A PAT should just work, no plugin changes, no tricks, with or without 2FA enabled for the account, now or in the past. I have no idea what is wrong in your case.
Yep my bad, my credential had some trailing whitespace that went unnoticed previously as it was being escaped in other use cases but this plugin didn't escape it. I corrected the credential and all works now
Hi,
I got the same email for two of my Jenkins deployments. That's how I got here
In particular the GitHub Branch Source Plugin only supports using username and password, so the functionality provided by that plugin may break when the deprecation takes place.
Current code of the GitHub Branch Source Plugin shows:
https://github.com/jenkinsci/github-branch-source-plugin/blob/23c8a226eef074da7b87bc4b629f6a9f75bf4766/src/main/java/org/jenkinsci/plugins/github_branch_source/Connector.java#L339
Looking at what PyGitHub does (project that I use with tokens to automate some things):
https://github.com/PyGithub/PyGithub/blob/baddb7193f24fc988def1ead53876024be6066e0/github/Requester.py#L278
It looks like GitHub supports passing token in the Authorization header. So, in theory, the GitHub Branch Source Plugin could use a "Secret Text" type secret with the token an pass it down in the Authorization header.
Its interesting to note that the GitHub Plugin already supports (actually only supports) using access tokens. So, in my Jenkins deployment I have to have two secrets: