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
// Package fxa implements the Firefox Accounts client: password login with
// HAWK-authenticated session calls, sign-in verification, OAuth token
// issuance and refresh, the Fastly anti-bot challenge that guards the
// account API, and the local OAuth token cache.
package fxa
import (
"context"
"encoding/hex"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"strings"
"time"
"github.com/armanlife/firefox-vpn-client/core/internal/controlplane"
)
const (
fxaAuthServer = "https://api.accounts.firefox.com/v1"
firefoxClientID = "5882386c6d801776"
oauthScope = "profile https://identity.mozilla.com/apps/vpn"
// maxChallengeAttempts bounds how many times an FxA call re-solves the
// Fastly anti-bot challenge; with rotating-exit proxies a solved cookie
// can be rejected when the API request leaves through another IP.
maxChallengeAttempts = 5
// fxaCallMinBudget is the minimum wall-clock budget an FxA call gets:
// the caller's per-request timeout is often shorter than a full
// challenge-solving round trip.
fxaCallMinBudget = 90 * time.Second
// verificationMethodEmail2FA tells FxA to deliver the sign-in
// confirmation as a code emailed to the account instead of the
// default confirmation link: the link redirects through
// accounts.firefox.com, which warns about non-Firefox browsers and
// cannot be followed from this CLI client.
verificationMethodEmail2FA = "email-2fa"
// fxaErrnoInvalidParameter is FxA's "Invalid parameter" errno; a
// deployment that does not accept verificationMethod in the login
// body answers with it, so we fall back to a plain login.
fxaErrnoInvalidParameter = 107
// fxaErrnoIncorrectEmailCase is FxA's "Incorrect email case" errno: the
// email was typed in another letter case than the account's, which the
// password's key stretching depends on. The error names the account's
// own spelling.
fxaErrnoIncorrectEmailCase = 120
)
type LoginResponse struct {
SessionToken string `json:"sessionToken"`
UID string `json:"uid"`
Verified bool `json:"verified"`
AuthAt int64 `json:"authAt"`
VerificationMethod string `json:"verificationMethod"`
VerificationReason string `json:"verificationReason"`
// Email is the email the sign-in succeeded with, in the account's own
// letter case.
Email string `json:"-"`
}
type TokenResponse struct {
AccessToken string `json:"access_token"`
RefreshToken string `json:"refresh_token"`
ExpiresIn int `json:"expires_in"`
Scope string `json:"scope"`
TokenType string `json:"token_type"`
}
// fxaAPIError carries a non-2xx FxA response so callers can branch on the
// API errno (e.g. invalid parameter) instead of parsing error strings.
type fxaAPIError struct {
Status int
Errno int
Body string
// Email is the account's email as FxA stores it, which sign-in errors
// carry.
Email string
}
func (e *fxaAPIError) Error() string {
if e.Errno != 0 {
return fmt.Sprintf("FxA error (HTTP %d, errno %d): %s", e.Status, e.Errno, e.Body)
}
return fmt.Sprintf("FxA request failed (HTTP %d): %s", e.Status, e.Body)
}
// ErrReauthRequired signals that FxA permanently rejected the stored
// credential (refresh token or session token), e.g. after the session was
// revoked server-side. Retrying cannot help; the user must sign in again.
var ErrReauthRequired = errors.New("Firefox Account sign-in required")
// Is lets errors.Is match ErrReauthRequired for credential rejections. FxA
// answers an invalid or revoked token with HTTP 400 (invalid_grant), 401,
// or 403; HTTP 429 and 5xx stay transient.
func (e *fxaAPIError) Is(target error) bool {
if target != ErrReauthRequired {
return false
}
switch e.Status {
case http.StatusBadRequest, http.StatusUnauthorized, http.StatusForbidden:
return e.Errno != fxaErrnoInvalidParameter
}
return false
}
func newFxaAPIError(status int, body []byte) *fxaAPIError {
var parsed struct {
Errno int `json:"errno"`
Email string `json:"email"`
}
_ = json.Unmarshal(body, &parsed)
return &fxaAPIError{Status: status, Errno: parsed.Errno, Body: string(body), Email: parsed.Email}
}
// emailCaseError is the error of a sign-in repeated in the account's own
// letter case that still failed (for example blocked until an unblock
// code); it keeps that spelling for the next attempts.
type emailCaseError struct {
email string
err error
}
func (e *emailCaseError) Error() string { return e.err.Error() }
func (e *emailCaseError) Unwrap() error { return e.err }
// fxaDo sends an FxA API request built by newRequest, transparently solving
// the Fastly anti-bot client challenge when the edge answers HTTP 406 (empty
// body, no FxA error payload). The request factory is invoked again after
// each successful solve because request bodies are single-use readers.
func fxaDo(ctx context.Context, newRequest func() (*http.Request, error)) (*http.Response, error) {
ctx, cancel := contextWithMinDeadline(ctx, fxaCallMinBudget)
defer cancel()
for attempt := 1; attempt <= maxChallengeAttempts; attempt++ {
req, err := newRequest()
if err != nil {
return nil, err
}
resp, err := controlplane.Do(req)
if err != nil {
return nil, err
}
if resp.StatusCode != http.StatusNotAcceptable {
return resp, nil
}
io.Copy(io.Discard, io.LimitReader(resp.Body, 4096))
resp.Body.Close()
if err := solveFastlyChallenge(ctx); err != nil {
return nil, fmt.Errorf("Fastly anti-bot challenge: %w", err)
}
}
return nil, fmt.Errorf("Fastly anti-bot challenge still failing after %d attempts (HTTP 406)", maxChallengeAttempts)
}
// fxaLogin signs in. An email typed in another letter case than the
// account's is refused with the account's own spelling (errno 120); the
// sign-in is then repeated once with it, as Firefox does, naming the typed
// email as originalLoginEmail.
func fxaLogin(ctx context.Context, email, password, unblockCode string) (*LoginResponse, error) {
resp, err := fxaLoginAs(ctx, email, "", password, unblockCode)
var apiErr *fxaAPIError
if errors.As(err, &apiErr) && apiErr.Errno == fxaErrnoIncorrectEmailCase && apiErr.Email != "" && apiErr.Email != email {
resp, err = fxaLoginAs(ctx, apiErr.Email, email, password, unblockCode)
if err != nil {
return nil, &emailCaseError{email: apiErr.Email, err: err}
}
}
return resp, err
}
// fxaLoginAs signs in as email; a deployment that does not accept the
// verification method is asked again without it.
func fxaLoginAs(ctx context.Context, email, originalEmail, password, unblockCode string) (*LoginResponse, error) {
resp, err := fxaLoginAttempt(ctx, email, originalEmail, password, verificationMethodEmail2FA, unblockCode)
var apiErr *fxaAPIError
if errors.As(err, &apiErr) && apiErr.Errno == fxaErrnoInvalidParameter {
resp, err = fxaLoginAttempt(ctx, email, originalEmail, password, "", unblockCode)
}
if err != nil {
return nil, err
}
resp.Email = email
return resp, nil
}
func fxaLoginAttempt(ctx context.Context, email, originalEmail, password, verificationMethod, unblockCode string) (*LoginResponse, error) {
authPW, err := deriveAuthPW(email, password)
if err != nil {
return nil, fmt.Errorf("deriving authPW: %w", err)
}
body := map[string]string{
"email": email,
"authPW": hex.EncodeToString(authPW),
}
if originalEmail != "" {
body["originalLoginEmail"] = originalEmail
}
if verificationMethod != "" {
body["verificationMethod"] = verificationMethod
}
if unblockCode != "" {
body["unblockCode"] = unblockCode
}
bodyJSON, _ := json.Marshal(body)
loginURL := fxaAuthServer + "/account/login"
resp, err := fxaDo(ctx, func() (*http.Request, error) {
req, err := http.NewRequestWithContext(ctx, http.MethodPost, loginURL, strings.NewReader(string(bodyJSON)))
if err != nil {
return nil, fmt.Errorf("creating login request: %w", err)
}
req.Header.Set("Content-Type", "application/json")
controlplane.ApplyFirefoxHeaders(req)
return req, nil
})
if err != nil {
return nil, fmt.Errorf("login request: %w", err)
}
defer resp.Body.Close()
data, _ := io.ReadAll(resp.Body)
if resp.StatusCode != http.StatusOK {
return nil, newFxaAPIError(resp.StatusCode, data)
}
var loginResp LoginResponse
if err := json.Unmarshal(data, &loginResp); err != nil {
return nil, fmt.Errorf("parsing login response: %w", err)
}
return &loginResp, nil
}
// fxaVerifySession submits the email confirmation code for an unverified
// session created by fxaLogin; FxA sends the code to the account email at
// login time.
func fxaVerifySession(ctx context.Context, sessionToken, code string) error {
hawkID, hawkKey, err := deriveHawkCredentials(sessionToken, "sessionToken")
if err != nil {
return fmt.Errorf("deriving hawk credentials: %w", err)
}
body := map[string]string{"code": code}
bodyJSON, _ := json.Marshal(body)
verifyURL := fxaAuthServer + "/session/verify_code"
resp, err := fxaDo(ctx, func() (*http.Request, error) {
authHeader, err := hawkHeader("POST", verifyURL, hawkID, hawkKey, string(bodyJSON))
if err != nil {
return nil, fmt.Errorf("generating hawk header: %w", err)
}
req, err := http.NewRequestWithContext(ctx, http.MethodPost, verifyURL, strings.NewReader(string(bodyJSON)))
if err != nil {
return nil, fmt.Errorf("creating verify code request: %w", err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", authHeader)
controlplane.ApplyFirefoxHeaders(req)
return req, nil
})
if err != nil {
return fmt.Errorf("verify code request: %w", err)
}
defer resp.Body.Close()
data, _ := io.ReadAll(resp.Body)
if resp.StatusCode != http.StatusOK {
return newFxaAPIError(resp.StatusCode, data)
}
return nil
}
// DestroySession ends a session token once its OAuth tokens are issued.
// Left alive, it stays in the account's connected services as an
// "unknown" session next to the device record; the program needs only the
// refresh token (and signs in again with the stored password when that
// stops working).
func DestroySession(ctx context.Context, sessionToken string) error {
hawkID, hawkKey, err := deriveHawkCredentials(sessionToken, "sessionToken")
if err != nil {
return fmt.Errorf("deriving hawk credentials: %w", err)
}
const body = "{}"
destroyURL := fxaAuthServer + "/session/destroy"
resp, err := fxaDo(ctx, func() (*http.Request, error) {
authHeader, err := hawkHeader("POST", destroyURL, hawkID, hawkKey, body)
if err != nil {
return nil, fmt.Errorf("generating hawk header: %w", err)
}
req, err := http.NewRequestWithContext(ctx, http.MethodPost, destroyURL, strings.NewReader(body))
if err != nil {
return nil, fmt.Errorf("creating session destroy request: %w", err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", authHeader)
controlplane.ApplyFirefoxHeaders(req)
return req, nil
})
if err != nil {
return fmt.Errorf("session destroy request: %w", err)
}
defer resp.Body.Close()
data, _ := io.ReadAll(resp.Body)
if resp.StatusCode != http.StatusOK {
return newFxaAPIError(resp.StatusCode, data)
}
return nil
}
func fxaOAuthToken(ctx context.Context, sessionToken string) (*TokenResponse, error) {
hawkID, hawkKey, err := deriveHawkCredentials(sessionToken, "sessionToken")
if err != nil {
return nil, fmt.Errorf("deriving hawk credentials: %w", err)
}
body := map[string]interface{}{
"client_id": firefoxClientID,
"grant_type": "fxa-credentials",
"scope": oauthScope,
"access_type": "offline",
}
bodyJSON, _ := json.Marshal(body)
tokenURL := fxaAuthServer + "/oauth/token"
resp, err := fxaDo(ctx, func() (*http.Request, error) {
authHeader, err := hawkHeader("POST", tokenURL, hawkID, hawkKey, string(bodyJSON))
if err != nil {
return nil, fmt.Errorf("generating hawk header: %w", err)
}
req, err := http.NewRequestWithContext(ctx, http.MethodPost, tokenURL, strings.NewReader(string(bodyJSON)))
if err != nil {
return nil, fmt.Errorf("creating oauth token request: %w", err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", authHeader)
controlplane.ApplyFirefoxHeaders(req)
return req, nil
})
if err != nil {
return nil, fmt.Errorf("oauth token request: %w", err)
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return nil, newFxaAPIError(resp.StatusCode, []byte(controlplane.ReadErrorBody(resp.Body)))
}
data, err := io.ReadAll(resp.Body)
if err != nil {
return nil, fmt.Errorf("reading token response: %w", err)
}
var tok TokenResponse
if err := json.Unmarshal(data, &tok); err != nil {
return nil, fmt.Errorf("parsing token response: %w", err)
}
return &tok, nil
}
func fxaRefreshToken(ctx context.Context, refreshToken string) (*TokenResponse, error) {
body := map[string]interface{}{
"client_id": firefoxClientID,
"grant_type": "refresh_token",
"refresh_token": refreshToken,
"scope": oauthScope,
}
bodyJSON, _ := json.Marshal(body)
tokenURL := fxaAuthServer + "/oauth/token"
resp, err := fxaDo(ctx, func() (*http.Request, error) {
req, err := http.NewRequestWithContext(ctx, http.MethodPost, tokenURL, strings.NewReader(string(bodyJSON)))
if err != nil {
return nil, fmt.Errorf("creating refresh request: %w", err)
}
req.Header.Set("Content-Type", "application/json")
controlplane.ApplyFirefoxHeaders(req)
return req, nil
})
if err != nil {
return nil, fmt.Errorf("refresh request: %w", err)
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return nil, newFxaAPIError(resp.StatusCode, []byte(controlplane.ReadErrorBody(resp.Body)))
}
data, err := io.ReadAll(resp.Body)
if err != nil {
return nil, fmt.Errorf("reading refresh response: %w", err)
}
var tok TokenResponse
if err := json.Unmarshal(data, &tok); err != nil {
return nil, fmt.Errorf("parsing refresh response: %w", err)
}
// Refresh response may not include a new refresh_token; keep the old one
if tok.RefreshToken == "" {
tok.RefreshToken = refreshToken
}
return &tok, nil
}
func Login(ctx context.Context, email, password string) (*LoginResponse, error) {
return fxaLogin(ctx, email, password, "")
}
func VerifySession(ctx context.Context, sessionToken, code string) error {
return fxaVerifySession(ctx, sessionToken, NormalizeCode(code))
}
func OAuthToken(ctx context.Context, sessionToken string) (*TokenResponse, error) {
return fxaOAuthToken(ctx, sessionToken)
}
func RefreshToken(ctx context.Context, refreshToken string) (*TokenResponse, error) {
return fxaRefreshToken(ctx, refreshToken)
}