go-pkgz / auth / 30137880201

85%

push

github

feat: opt-in github numeric user id, reject non-2xx user info (#301)

* feat: add opt-in github user id derived from immutable numeric id

GitHub logins are released on rename or account removal and can be claimed
by someone else, so a local id derived from the login may be inherited by
the next holder of the name. Every other oauth2 provider here keys on an
immutable subject, github was the only one on a mutable field.

Add Params.GithubNumericID and Service.AddGithubProviderWithNumericID to
derive the id from the numeric account id instead. Off by default because
it changes the id of every existing github user, and records stored under
the old id cannot be remapped offline once a login is hashed.

The numeric id is read from the raw response body with a typed unmarshal.
data.Value is not usable for it, json numbers decode to float64 and format
as "1.345027e+06". A missing or zero id keeps the login-based value rather
than hashing an empty string.

Applied to both the v1 (provider/) and v2 (v2/provider/) module paths.

* fix(review-loop): iteration 1 addressed 8 findings

- [major] [provider/providers.go:70] numeric ids shared a hash namespace with logins, which may be all-digit; domain-separate the hashed input with a "gid:" prefix
- [major] [auth_test.go] AddGithubProviderWithNumericID had no test; add Service-level coverage plus the default-unchanged negative case
- [minor] [provider/providers.go:69] warn when the numeric id is unusable instead of falling back silently
- [minor] [provider/providers.go:52] default the logger in NewGithub, the mapUser closure captures p before initOauth2Handler defaults its own copy
- [minor] [provider/providers.go:65] comment claimed the login fallback was safe; state the recycling caveat instead
- [minor] [provider/oauth2.go:62] document the best-effort fallback on Params.GithubNumericID and the Service method
- [minor] [auth.go:389] add the advanced-configuration note the AddMicrosoftProvider godoc carries
- [min... (continued)

37 of 41 new or added lines in 4 files covered. (90.24%)

3107 of 3632 relevant lines covered (85.55%)

8.6 hits per line