-
-
Notifications
You must be signed in to change notification settings - Fork 35
Expand file tree
/
Copy pathclient.go
More file actions
348 lines (316 loc) · 10.2 KB
/
client.go
File metadata and controls
348 lines (316 loc) · 10.2 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
package deck
import (
"context"
"crypto/rand"
"crypto/sha256"
"encoding/base64"
"encoding/json"
"fmt"
"log/slog"
"net"
"net/http"
"os"
"path/filepath"
"strings"
"time"
"github.com/hashicorp/go-retryablehttp"
"github.com/k1LoW/deck/config"
"github.com/k1LoW/deck/version"
"github.com/k1LoW/errors"
"github.com/pkg/browser"
"golang.org/x/oauth2"
"golang.org/x/oauth2/google"
"google.golang.org/api/slides/v1"
)
// Authentication environment variables.
// These are primarily for service account usage and override the default OAuth2 flow.
const (
// EnvServiceAccountKey - JSON content of a service account key (not a file path).
// Example: DECK_SERVICE_ACCOUNT_KEY='{"type":"service_account","project_id":"..."}'.
EnvServiceAccountKey = "DECK_SERVICE_ACCOUNT_KEY"
// EnvEnableADC - Enables Application Default Credentials (ADC) via google.DefaultClient.
// Primarily for GitHub Actions with Workload Identity Federation.
// ref. https://github.com/google-github-actions/auth
EnvEnableADC = "DECK_ENABLE_ADC"
// EnvAccessToken - Pre-existing OAuth2 access token for authentication.
// Useful for tasks >5 minutes since GitHub OIDC tokens expire in 5 minutes.
EnvAccessToken = "DECK_ACCESS_TOKEN"
)
var userAgent = "k1LoW-deck/" + version.Version + " (+https://github.com/k1LoW/deck)"
// getHTTPClient returns the appropriate client option based on available credentials.
func (d *Deck) getHTTPClient(ctx context.Context) (*http.Client, error) {
client, err := func(ctx context.Context) (*http.Client, error) {
if credsJSON := os.Getenv(EnvServiceAccountKey); credsJSON != "" {
d.logger.Debug("using service account key authentication")
return d.getServiceAccountHTTPClient(ctx, credsJSON)
}
if os.Getenv(EnvEnableADC) != "" {
d.logger.Debug("using Application Default Credentials")
return google.DefaultClient(ctx,
"https://www.googleapis.com/auth/presentations", "https://www.googleapis.com/auth/drive")
}
if token := os.Getenv(EnvAccessToken); token != "" {
d.logger.Debug("using access token authentication")
return oauth2.NewClient(ctx, oauth2.StaticTokenSource(&oauth2.Token{
AccessToken: token,
})), nil
}
// default OAuth2 user authentication
d.logger.Debug("using OAuth2 user authentication")
return d.getDefaultHTTPClient(ctx)
}(ctx)
if err != nil {
return nil, fmt.Errorf("failed to get HTTP client: %w", err)
}
retryClient := retryablehttp.NewClient()
retryClient.HTTPClient = client
retryClient.RetryMax = 10
retryClient.RetryWaitMin = 1 * time.Second
retryClient.RetryWaitMax = 30 * time.Second
retryClient.Logger = newAPILogger(d.logger)
return retryClient.StandardClient(), nil
}
func GetCredentialsPath(profile string) string {
creds := filepath.Join(config.DataHomePath(), "credentials.json")
if profile != "" {
p := filepath.Join(config.DataHomePath(), fmt.Sprintf("credentials-%s.json", profile))
if fi, err := os.Stat(p); err == nil && !fi.IsDir() {
creds = p
}
}
return creds
}
func (d *Deck) getOAuthConfig() (*oauth2.Config, error) {
creds := GetCredentialsPath(d.profile)
b, err := os.ReadFile(creds)
if err != nil {
return nil, err
}
return google.ConfigFromJSON(b, slides.PresentationsScope, slides.DriveScope)
}
func (d *Deck) getDefaultHTTPClient(ctx context.Context) (_ *http.Client, err error) {
defer func() {
err = errors.WithStack(err)
}()
cfg, err := d.getOAuthConfig()
if err != nil {
return nil, err
}
tokenPath := filepath.Join(config.StateHomePath(), "token.json")
if d.profile != "" {
tokenPath = filepath.Join(config.StateHomePath(), fmt.Sprintf("token-%s.json", d.profile))
}
token, err := d.tokenFromFile(tokenPath)
if err != nil {
token, err = d.getTokenFromWeb(ctx, cfg)
if err != nil {
return nil, err
}
if err := d.saveToken(tokenPath, token); err != nil {
return nil, err
}
} else if token.Expiry.Before(time.Now()) {
// Token has expired, refresh it using the refresh token
d.logger.Info("token has expired, refreshing")
if token.RefreshToken != "" {
tokenSource := cfg.TokenSource(ctx, token)
newToken, err := tokenSource.Token()
if err != nil {
d.logger.Info("failed to refresh token, getting new token from web", slog.String("error", err.Error()))
// If refresh fails, get a new token from the web
newToken, err = d.getTokenFromWeb(ctx, cfg)
if err != nil {
return nil, err
}
} else {
d.logger.Info("token refreshed successfully")
}
// Save the new token
if err := d.saveToken(tokenPath, newToken); err != nil {
return nil, err
}
token = newToken
} else {
// No refresh token available, get a new token from the web
d.logger.Info("no refresh token available, getting new token from web")
token, err = d.getTokenFromWeb(ctx, cfg)
if err != nil {
return nil, err
}
if err := d.saveToken(tokenPath, token); err != nil {
return nil, err
}
}
}
return cfg.Client(ctx, token), nil
}
func (d *Deck) getTokenFromWeb(ctx context.Context, config *oauth2.Config) (_ *oauth2.Token, err error) {
defer func() {
err = errors.WithStack(err)
}()
// Generate code verifier and challenge for PKCE
codeVerifier, err := generateCodeVerifier()
if err != nil {
return nil, fmt.Errorf("failed to generate code verifier: %w", err)
}
codeChallenge := generateCodeChallenge(codeVerifier)
var authCode string
// Generate random state for CSRF protection
stateBytes := make([]byte, 16)
if _, err := rand.Read(stateBytes); err != nil {
return nil, fmt.Errorf("failed to generate state: %w", err)
}
state := base64.RawURLEncoding.EncodeToString(stateBytes)
listenCtx, listening := context.WithCancel(ctx)
defer listening()
doneCtx, done := context.WithCancel(ctx)
defer done()
// run and stop local server
handler := http.NewServeMux()
handler.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
if r.URL.Query().Get("state") != state {
http.Error(w, "Invalid state parameter", http.StatusBadRequest)
return
}
if r.URL.Query().Get("code") == "" {
return
}
authCode = r.URL.Query().Get("code")
_, _ = w.Write([]byte("Received code. You may now close this tab."))
done()
})
srv := &http.Server{
Handler: handler,
ReadHeaderTimeout: 10 * time.Second,
}
var listenErr error
go func() {
ln, err := net.Listen("tcp", "localhost:0")
if err != nil {
listenErr = fmt.Errorf("listen: %w", err)
listening()
done()
return
}
srv.Addr = ln.Addr().String()
listening()
if err := srv.Serve(ln); err != nil {
if err != http.ErrServerClosed {
listenErr = fmt.Errorf("serve: %w", err)
done()
return
}
}
}()
<-listenCtx.Done()
if listenErr != nil {
return nil, listenErr
}
config.RedirectURL = "http://" + srv.Addr + "/"
// Add PKCE parameters to the authorization URL
authURL := config.AuthCodeURL(state,
oauth2.AccessTypeOffline,
oauth2.SetAuthURLParam("code_challenge", codeChallenge),
oauth2.SetAuthURLParam("code_challenge_method", "S256"))
if err := browser.OpenURL(authURL); err != nil {
return nil, err
}
<-doneCtx.Done()
if err := srv.Shutdown(ctx); err != nil {
return nil, err
}
// Send code verifier during token exchange
token, err := config.Exchange(ctx, authCode,
oauth2.SetAuthURLParam("code_verifier", codeVerifier))
if err != nil {
return nil, err
}
return token, nil
}
func (d *Deck) tokenFromFile(file string) (_ *oauth2.Token, err error) {
defer func() {
err = errors.WithStack(err)
}()
f, err := os.Open(file)
if err != nil {
return nil, err
}
defer f.Close()
token := &oauth2.Token{}
if err := json.NewDecoder(f).Decode(token); err != nil {
return nil, err
}
return token, err
}
func (d *Deck) saveToken(path string, token *oauth2.Token) (err error) {
defer func() {
err = errors.WithStack(err)
}()
f, err := os.OpenFile(path, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0600)
if err != nil {
return fmt.Errorf("unable to cache oauth token: %w", err)
}
defer f.Close()
if err := json.NewEncoder(f).Encode(token); err != nil { //nolint:gosec
return fmt.Errorf("unable to cache oauth token: %w", err)
}
return nil
}
// generateCodeVerifier generates a code verifier for PKCE.
// Generates a random string of 43-128 characters in compliance with RFC7636.
func generateCodeVerifier() (_ string, err error) {
defer func() {
err = errors.WithStack(err)
}()
// Generate 64 bytes (512 bits) of random data
b := make([]byte, 64)
if _, err := rand.Read(b); err != nil {
return "", err
}
return base64.RawURLEncoding.EncodeToString(b), nil
}
// generateCodeChallenge generates a code challenge from the code verifier.
// Calculates SHA-256 hash and applies Base64 URL encoding.
func generateCodeChallenge(verifier string) string {
h := sha256.New()
h.Write([]byte(verifier))
return base64.RawURLEncoding.EncodeToString(h.Sum(nil))
}
// getServiceAccountHTTPClient creates an HTTP client using service account credentials.
func (d *Deck) getServiceAccountHTTPClient(ctx context.Context, credsJSON string) (*http.Client, error) {
config, err := google.JWTConfigFromJSON([]byte(credsJSON),
"https://www.googleapis.com/auth/presentations",
"https://www.googleapis.com/auth/drive",
)
if err != nil {
return nil, err
}
return config.Client(ctx), nil
}
var _ retryablehttp.LeveledLogger = (*apiLogger)(nil)
type apiLogger struct {
l *slog.Logger
}
func (l *apiLogger) Error(msg string, keysAndValues ...any) {
l.l.Error(msg, append([]any{slog.String("original_log_level", "error")}, keysAndValues...)...)
}
func (l *apiLogger) Info(msg string, keysAndValues ...any) {
l.l.Info(msg, append([]any{slog.String("original_log_level", "info")}, keysAndValues...)...)
}
func (l *apiLogger) Debug(msg string, keysAndValues ...any) {
if strings.HasPrefix(msg, "retrying") {
// If the message starts with "retrying", log it as info instead of debug
// For displaying spinner messages in the console
l.l.Info(msg, append([]any{slog.String("original_log_level", "debug")}, keysAndValues...)...)
return
}
l.l.Debug(msg, append([]any{slog.String("original_log_level", "debug")}, keysAndValues...)...)
}
func (l *apiLogger) Warn(msg string, keysAndValues ...any) {
l.l.Warn(msg, append([]any{slog.String("original_log_level", "warn")}, keysAndValues...)...)
}
func newAPILogger(l *slog.Logger) retryablehttp.LeveledLogger {
return &apiLogger{
l: l.WithGroup("api"),
}
}