STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Guide user through re-authorization flow if read:org scope is missing

Browse source 
How this works for people with existing OAuth tokens:

    $ gh issue list -L1
    Notice: additional authorization required
    Press Enter to open github.com in your browser...
    [auth flow in the browser...]
    Authentication complete. Press Enter to continue...

    Showing 1 of 132 issues in cli/cli
    ...

Users of Personal Access Tokens get a different notice:

    Warning: gh now requires the `read:org` OAuth scope.
    Visit https://github.com/settings/tokens and edit your token to enable `read:org`
    or generate a new token and paste it via `gh config set -h github.com oauth_token MYTOKEN`
This commit is contained in:
Mislav Marohnić 2020-04-23 18:15:20 +02:00
parent 8ed9a0324e
commit 3aaa231cc5
3 changed files with 81 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

27
api/client.go
View file

@ -7,7 +7,6 @@ import (
"io"
"io/ioutil"
"net/http"
"os"
"regexp"
"strings"
@ -38,6 +37,16 @@ func AddHeader(name, value string) ClientOption {
}
}
// AddHeaderFunc is an AddHeader that gets the string value from a function
func AddHeaderFunc(name string, value func() string) ClientOption {
return func(tr http.RoundTripper) http.RoundTripper {
return &funcTripper{roundTrip: func(req *http.Request) (*http.Response, error) {
req.Header.Add(name, value())
return tr.RoundTrip(req)
}}
}
}
// VerboseLog enables request/response logging within a RoundTripper
func VerboseLog(out io.Writer, logTraffic bool, colorize bool) ClientOption {
logger := &httpretty.Logger{
@ -67,15 +76,15 @@ func ReplaceTripper(tr http.RoundTripper) ClientOption {
var issuedScopesWarning bool
// CheckScopes checks whether an OAuth scope is present in a response
func CheckScopes(wantedScope string) ClientOption {
func CheckScopes(wantedScope string, cb func(string) error) ClientOption {
return func(tr http.RoundTripper) http.RoundTripper {
return &funcTripper{roundTrip: func(req *http.Request) (*http.Response, error) {
res, err := tr.RoundTrip(req)
if err != nil || issuedScopesWarning {
if err != nil || res.StatusCode > 299 || issuedScopesWarning {
return res, err
}
isApp := res.Header.Get("X-Oauth-Client-Id") != ""
appID := res.Header.Get("X-Oauth-Client-Id")
hasScopes := strings.Split(res.Header.Get("X-Oauth-Scopes"), ",")
hasWanted := false
@ -87,14 +96,8 @@ func CheckScopes(wantedScope string) ClientOption {
}
if !hasWanted {
fmt.Fprintln(os.Stderr, "Warning: gh now requires the `read:org` OAuth scope.")
// TODO: offer to take the person through the authentication flow again?
// TODO: retry the original request if it was a read?
if isApp {
fmt.Fprintln(os.Stderr, "To re-authenticate, please `rm ~/.config/gh/config.yml` and try again.")
} else {
// the person has pasted a Personal Access Token
fmt.Fprintln(os.Stderr, "Re-generate your token in `rm ~/.config/gh/config.yml` and try again.")
if err := cb(appID); err != nil {
return res, err
}
issuedScopesWarning = true
}