-
Notifications
You must be signed in to change notification settings - Fork 36
Expand file tree
/
Copy pathauth.go
More file actions
498 lines (443 loc) · 13.5 KB
/
auth.go
File metadata and controls
498 lines (443 loc) · 13.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
package auth
import (
"bufio"
"errors"
"fmt"
"os"
"os/exec"
"runtime"
"strings"
"github.com/brevdev/brev-cli/pkg/config"
"github.com/brevdev/brev-cli/pkg/entity"
breverrors "github.com/brevdev/brev-cli/pkg/errors"
"github.com/fatih/color"
"github.com/golang-jwt/jwt/v5"
"github.com/pkg/browser"
)
type LoginAuth struct {
Auth
}
func NewLoginAuth(authStore AuthStore, oauth OAuth) *LoginAuth {
return &LoginAuth{
Auth: *NewAuth(authStore, oauth),
}
}
func (l LoginAuth) GetAccessToken() (string, error) {
token, err := l.GetFreshAccessTokenOrLogin()
if err != nil {
return "", breverrors.WrapAndTrace(err)
}
return token, nil
}
type NoLoginAuth struct {
Auth
}
func NewNoLoginAuth(authStore AuthStore, oauth OAuth) *NoLoginAuth {
return &NoLoginAuth{
Auth: *NewAuth(authStore, oauth),
}
}
func (l NoLoginAuth) GetAccessToken() (string, error) {
token, err := l.GetFreshAccessTokenOrNil()
if err != nil {
return "", breverrors.WrapAndTrace(err)
}
return token, nil
}
type AuthStore interface {
SaveAuthTokens(tokens entity.AuthTokens) error
GetAuthTokens() (*entity.AuthTokens, error)
DeleteAuthTokens() error
}
type OAuth interface {
DoDeviceAuthFlow(onStateRetrieved func(url string, code string)) (*LoginTokens, error)
GetNewAuthTokensWithRefresh(refreshToken string) (*entity.AuthTokens, error)
GetCredentialProvider() entity.CredentialProvider
IsTokenValid(token string) bool
}
type OAuthRetriever struct {
oauths []OAuth
}
func NewOAuthRetriever(oauths []OAuth) *OAuthRetriever {
return &OAuthRetriever{
oauths: oauths,
}
}
func (o *OAuthRetriever) GetByProvider(provider entity.CredentialProvider) (OAuth, error) {
for _, oauth := range o.oauths {
if oauth.GetCredentialProvider() == provider {
return oauth, nil
}
}
return nil, fmt.Errorf("no oauth found for provider %s", provider)
}
func (o *OAuthRetriever) GetByToken(token string) (OAuth, error) {
for _, oauth := range o.oauths {
if oauth.IsTokenValid(token) {
return oauth, nil
}
}
return nil, fmt.Errorf("no oauth found for token")
}
type Auth struct {
authStore AuthStore
oauth OAuth
accessTokenValidator func(string) (bool, error)
shouldLogin func() (bool, error)
}
func NewAuth(authStore AuthStore, oauth OAuth) *Auth {
return &Auth{
authStore: authStore,
oauth: oauth,
accessTokenValidator: isAccessTokenValid,
shouldLogin: shouldLogin,
}
}
func (t *Auth) WithAccessTokenValidator(val func(string) (bool, error)) *Auth {
t.accessTokenValidator = val
return t
}
func (t *Auth) WithShouldLogin(fn func() (bool, error)) *Auth {
t.shouldLogin = fn
return t
}
// Gets fresh access token and prompts for login and saves to store
func (t Auth) GetFreshAccessTokenOrLogin() (string, error) {
token, err := t.GetFreshAccessTokenOrNil()
if err != nil {
return "", breverrors.WrapAndTrace(err)
}
if token == "" {
lt, err := t.PromptForLogin()
if err != nil {
return "", breverrors.WrapAndTrace(err)
}
token = lt.AccessToken
}
return token, nil
}
// Gets fresh access token or returns nil and saves to store
func (t Auth) GetFreshAccessTokenOrNil() (string, error) {
tokens, err := t.getSavedTokensOrNil()
if err != nil {
return "", breverrors.WrapAndTrace(err)
}
if tokens == nil {
return "", nil
}
// Older CLI versions stored the literal string "auto-login" when
// `brev login --token` had no real refresh token to save. Treat it as
// absent so we do not attempt to exchange it with the IdP and fail.
if tokens.RefreshToken == autoLoginSentinel {
tokens.RefreshToken = ""
}
// should always at least have access token?
if tokens.AccessToken == "" {
breverrors.GetDefaultErrorReporter().ReportMessage("access token is an empty string but shouldn't be")
}
isAccessTokenValid, err := t.accessTokenValidator(tokens.AccessToken)
if err != nil {
return "", breverrors.WrapAndTrace(err)
}
if !isAccessTokenValid {
if tokens.RefreshToken == "" {
// Access token is expired and we have no refresh token. Returning
// the expired token here would just cause a 401 on the next API
// call; return empty so callers can prompt for re-login instead.
return "", nil
}
tokens, err = t.getNewTokensWithRefreshOrNil(tokens.RefreshToken)
if err != nil {
return "", breverrors.WrapAndTrace(err)
}
if tokens == nil {
return "", nil
}
}
return tokens.AccessToken, nil
}
// Prompts for login and returns tokens, and saves to store
func (t Auth) PromptForLogin() (*LoginTokens, error) {
shouldLogin, err := t.shouldLogin()
if err != nil {
return nil, breverrors.WrapAndTrace(err)
}
if !shouldLogin {
return nil, &breverrors.DeclineToLoginError{}
}
tokens, err := t.Login(false)
if err != nil {
return nil, breverrors.WrapAndTrace(err)
}
return tokens, nil
}
func shouldLogin() (bool, error) {
reader := bufio.NewReader(os.Stdin) // TODO 9 inject?
fmt.Print(`You are currently logged out, would you like to log in? [Y/n]: `)
text, err := reader.ReadString('\n')
if err != nil {
return false, breverrors.WrapAndTrace(err)
}
trimmed := strings.ToLower(strings.TrimSpace(text))
return trimmed == "y" || trimmed == "", nil
}
// autoLoginSentinel is a legacy value older CLI versions stored in place of
// a real token when `brev login --token` was used. It is not a valid token of
// any kind; treat it as "absent" on read.
const autoLoginSentinel = "auto-login"
func (t Auth) LoginWithToken(token string) error {
valid, err := isAccessTokenValid(token)
if err != nil {
return breverrors.WrapAndTrace(err)
}
if valid {
// The token is a self-contained JWT access token with no accompanying
// refresh token. Previously we stored the string "auto-login" in the
// RefreshToken slot; when the access token expired the refresh path
// then attempted to exchange that sentinel with the IdP, which always
// failed, logging the user out every time the short-lived access
// token aged out. Store an empty RefreshToken instead so the refresh
// path correctly recognizes there is nothing to refresh and prompts
// for a fresh login exactly once.
fmt.Fprintln(os.Stderr, "Note: tokens from --token cannot be refreshed; re-run `brev login` when the session expires.")
err := t.authStore.SaveAuthTokens(entity.AuthTokens{
AccessToken: token,
RefreshToken: "",
})
if err != nil {
return breverrors.WrapAndTrace(err)
}
} else {
// The token is not a JWT, assume it is a refresh token. The access
// token slot is filled with the sentinel so the first API call
// triggers a refresh to populate a real access token.
err := t.authStore.SaveAuthTokens(entity.AuthTokens{
AccessToken: autoLoginSentinel,
RefreshToken: token,
})
if err != nil {
return breverrors.WrapAndTrace(err)
}
}
return nil
}
// showLoginURL displays the login link and CLI alternative for manual navigation.
func showLoginURL(url string) {
urlType := color.New(color.FgCyan, color.Bold).SprintFunc()
fmt.Println("Login here: " + urlType(url))
}
func defaultAuthFunc(url, code string) {
codeType := color.New(color.FgWhite, color.Bold).SprintFunc()
if code != "" {
fmt.Println("Your Device Confirmation Code is 👉", codeType(code), "👈")
fmt.Print("\n")
}
if hasBrowser() {
if err := browser.OpenURL(url); err == nil {
fmt.Println("Waiting for login to complete in browser...")
return
}
}
showLoginURL(url)
fmt.Println("\nWaiting for login to complete...")
}
func skipBrowserAuthFunc(url, _ string) {
showLoginURL(url)
fmt.Println("\nWaiting for login to complete...")
}
// hasBrowser reports whether a browser can be opened on the current platform.
func hasBrowser() bool {
if runtime.GOOS == "darwin" {
// macOS always has "open".
return true
}
// Linux: check for a known browser launcher.
for _, name := range []string{"xdg-open", "x-www-browser", "www-browser"} {
if _, err := exec.LookPath(name); err == nil {
return true
}
}
return false
}
func (t Auth) Login(skipBrowser bool) (*LoginTokens, error) {
authFunc := defaultAuthFunc
if skipBrowser {
authFunc = skipBrowserAuthFunc
}
tokens, err := t.oauth.DoDeviceAuthFlow(authFunc)
if err != nil {
fmt.Println("failed.")
fmt.Println("")
return nil, breverrors.WrapAndTrace(err)
}
err = t.authStore.SaveAuthTokens(tokens.AuthTokens)
if err != nil {
fmt.Println("failed.")
fmt.Println("")
return nil, breverrors.WrapAndTrace(err)
}
caretType := color.New(color.FgGreen, color.Bold).SprintFunc()
fmt.Println("")
fmt.Println(" ", caretType("▸"), " Successfully logged in.")
return tokens, nil
}
func (t Auth) Logout() error {
err := t.authStore.DeleteAuthTokens()
if err != nil {
return breverrors.WrapAndTrace(err)
}
return nil
}
type LoginTokens struct {
entity.AuthTokens
IDToken string
}
func (t Auth) getSavedTokensOrNil() (*entity.AuthTokens, error) {
tokens, err := t.authStore.GetAuthTokens()
if err != nil {
switch err.(type) { //nolint:gocritic // like the ability to extend
case *breverrors.CredentialsFileNotFound:
return nil, nil
}
return nil, breverrors.WrapAndTrace(err)
}
if tokens != nil && tokens.AccessToken == "" && tokens.RefreshToken == "" {
return nil, nil
}
return tokens, nil
}
// gets new access and refresh token or returns nil if refresh token expired, and updates store
func (t Auth) getNewTokensWithRefreshOrNil(refreshToken string) (*entity.AuthTokens, error) {
tokens, err := t.oauth.GetNewAuthTokensWithRefresh(refreshToken)
// TODO 2 handle if 403 invalid grant
// https://stackoverflow.com/questions/57383523/how-to-detect-when-an-oauth2-refresh-token-expired
if err != nil {
if strings.Contains(err.Error(), "not implemented") {
return nil, nil
}
return nil, breverrors.WrapAndTrace(err)
}
if tokens == nil {
return nil, nil
}
if tokens.RefreshToken == "" {
tokens.RefreshToken = refreshToken
}
err = t.authStore.SaveAuthTokens(*tokens)
if err != nil {
return nil, breverrors.WrapAndTrace(err)
}
return tokens, nil
}
func isAccessTokenValid(token string) (bool, error) {
parser := jwt.Parser{}
ptoken, _, err := parser.ParseUnverified(token, jwt.MapClaims{})
if err != nil {
// ValidationErrors occurred while parsing token is handled below. jwt.ValidationErrors is removed in new jwt v5
if errors.Is(err, jwt.ErrTokenMalformed) || errors.Is(err, jwt.ErrTokenUnverifiable) {
// fmt.Printf("warning: token error validation failed | %v\n", err)
return false, nil
}
return false, breverrors.WrapAndTrace(err)
}
// Migrate from deprecated claims.Valid() to jwt v5 Validator.Validate() for standards-compliant claim validation.
validator := jwt.NewValidator(
jwt.WithIssuedAt(),
)
err = validator.Validate(ptoken.Claims)
if err != nil {
// https://pkg.go.dev/github.com/golang-jwt/jwt@v3.2.2+incompatible#MapClaims.Valid // https://github.com/dgrijalva/jwt-go/issues/383 // sometimes client clock is skew/out of sync with server who generated token
if strings.Contains(err.Error(), "Token used before issued") { // not a security issue because we always check server side as well
_ = 0
// ignore error
} else {
// fmt.Printf("warning: token check validation failed | %v\n", err) // TODO need logger
return false, nil
}
}
return true, nil
}
func IssuerCheck(token string, issuer string) bool {
parser := jwt.Parser{}
claims := jwt.MapClaims{}
_, _, err := parser.ParseUnverified(token, &claims)
if err != nil {
return false
}
iss, ok := claims["iss"].(string)
if !ok {
return false
}
return iss == issuer
}
func GetEmailFromToken(token string) string {
parser := jwt.Parser{}
claims := jwt.MapClaims{}
_, _, err := parser.ParseUnverified(token, &claims)
if err != nil {
return ""
}
email, ok := claims["email"].(string)
if !ok {
return ""
}
return email
}
func AuthProviderFlagToCredentialProvider(authProviderFlag string) entity.CredentialProvider {
if authProviderFlag == "" {
return ""
}
if authProviderFlag == "nvidia" {
return CredentialProviderKAS
}
return CredentialProviderAuth0
}
func StandardLogin(authProvider string, email string, tokens *entity.AuthTokens) OAuth {
// Set KAS as the default authenticator
shouldPromptEmail := false
if email == "" && tokens != nil && tokens.AccessToken != "" {
email = GetEmailFromToken(tokens.AccessToken)
shouldPromptEmail = true
}
kasAuthenticator := NewKasAuthenticator(
email,
config.GlobalConfig.GetBrevAuthURL(),
config.GlobalConfig.GetBrevAuthIssuerURL(),
shouldPromptEmail,
config.GlobalConfig.GetConsoleURL(),
)
// Create the auth0 authenticator as an alternative
auth0Authenticator := Auth0Authenticator{
Issuer: "https://brevdev.us.auth0.com/",
Audience: "https://brevdev.us.auth0.com/api/v2/",
ClientID: "JaqJRLEsdat5w7Tb0WqmTxzIeqwqepmk",
DeviceCodeEndpoint: "https://brevdev.us.auth0.com/oauth/device/code",
OauthTokenEndpoint: "https://brevdev.us.auth0.com/oauth/token",
}
// Default to KAS authenticator
var authenticator OAuth = kasAuthenticator
authRetriever := NewOAuthRetriever([]OAuth{
auth0Authenticator,
kasAuthenticator,
})
if tokens != nil && tokens.AccessToken != "" {
authenticatorFromToken, errr := authRetriever.GetByToken(tokens.AccessToken)
if errr != nil {
fmt.Printf("%v\n", errr)
} else {
authenticator = authenticatorFromToken
}
}
if authProvider != "" {
provider := AuthProviderFlagToCredentialProvider(authProvider)
if provider == CredentialProviderAuth0 || provider == CredentialProviderKAS {
oauth, errr := authRetriever.GetByProvider(provider)
if errr != nil {
fmt.Printf("%v\n", errr)
} else {
authenticator = oauth
}
}
}
return authenticator
}