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
|
package gitlab
import (
"context"
"fmt"
"net/http"
"net/url"
"time"
"github.com/golang-jwt/jwt/v5"
"github.com/hashicorp/go-retryablehttp"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/httpz"
"go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
)
const (
// This header carries the JWT token for gitlab-rails
jwtRequestHeader = "Gitlab-Kas-Api-Request"
jwtValidFor = 30 * time.Second
jwtNotBefore = 5 * time.Second
jwtIssuer = "gitlab-kas"
jwtGitLabAudience = "gitlab"
)
type HTTPClient interface {
Do(*retryablehttp.Request) (*http.Response, error)
}
type Client struct {
Backend *url.URL
HTTPClient HTTPClient
HTTPClientNoRetry HTTPClient
UserAgent string
}
func NewClient(backend *url.URL, authSecret []byte, opts ...ClientOption) *Client {
o := applyClientOptions(opts)
var transport http.RoundTripper = &http.Transport{
Proxy: o.transportConfig.Proxy,
DialContext: o.transportConfig.DialContext,
TLSClientConfig: o.transportConfig.TLSClientConfig,
TLSHandshakeTimeout: o.transportConfig.TLSHandshakeTimeout,
MaxIdleConns: o.transportConfig.MaxIdleConns,
MaxIdleConnsPerHost: o.transportConfig.MaxIdleConnsPerHost,
MaxConnsPerHost: o.transportConfig.MaxConnsPerHost,
IdleConnTimeout: o.transportConfig.IdleConnTimeout,
ResponseHeaderTimeout: o.transportConfig.ResponseHeaderTimeout,
ForceAttemptHTTP2: o.transportConfig.ForceAttemptHTTP2,
}
if o.limiter != nil {
transport = &httpz.RateLimitingRoundTripper{
Delegate: transport,
Limiter: o.limiter,
}
}
httpClient := &http.Client{
Transport: otelhttp.NewTransport(
transport,
otelhttp.WithPropagators(o.tracePropagator),
otelhttp.WithTracerProvider(o.traceProvider),
otelhttp.WithMeterProvider(o.meterProvider),
),
CheckRedirect: func(req *http.Request, via []*http.Request) error {
return http.ErrUseLastResponse
},
}
return &Client{
Backend: backend,
HTTPClient: &retryablehttp.Client{
HTTPClient: httpClient,
Logger: o.retryConfig.Logger,
RetryWaitMin: o.retryConfig.RetryWaitMin,
RetryWaitMax: o.retryConfig.RetryWaitMax,
RetryMax: o.retryConfig.RetryMax,
RequestLogHook: jwtRequestLogHook(authSecret, o.retryConfig.RequestLogHook),
ResponseLogHook: o.retryConfig.ResponseLogHook,
CheckRetry: o.retryConfig.CheckRetry,
Backoff: o.retryConfig.Backoff,
ErrorHandler: errorHandler,
},
HTTPClientNoRetry: &retryablehttp.Client{
HTTPClient: httpClient,
Logger: o.retryConfig.Logger,
RetryMax: 0,
RequestLogHook: jwtRequestLogHook(authSecret, o.retryConfig.RequestLogHook),
ResponseLogHook: o.retryConfig.ResponseLogHook,
CheckRetry: o.retryConfig.CheckRetry,
ErrorHandler: errorHandler,
},
UserAgent: o.userAgent,
}
}
func (c *Client) Do(ctx context.Context, opts ...DoOption) error {
o, err := applyDoOptions(opts)
if err != nil {
return err
}
r, err := retryablehttp.NewRequestWithContext(ctx, o.method, httpz.MergeURLPathAndQuery(c.Backend, o.path, o.query), o.body)
if err != nil {
return fmt.Errorf("NewRequest: %w", err)
}
if len(o.header) > 0 {
r.Header = o.header
}
if o.withJWT {
r.Header[jwtRequestHeader] = []string{"set me"} // let the jwtRequestLogHook know we need to sign this request
} else {
delete(r.Header, jwtRequestHeader) // ensure this is not set
}
if c.UserAgent != "" {
r.Header[httpz.UserAgentHeader] = []string{c.UserAgent}
}
client := c.HTTPClient
if o.noRetry {
client = c.HTTPClientNoRetry
}
resp, err := client.Do(r) //nolint: bodyclose
if err != nil {
ctxErr := ctx.Err()
if ctxErr != nil {
err = ctxErr // assume request errored out because of context
}
}
return o.responseHandler.Handle(resp, err)
}
func jwtRequestLogHook(authSecret []byte, hook retryablehttp.RequestLogHook) retryablehttp.RequestLogHook {
return func(logger retryablehttp.Logger, r *http.Request, reqNum int) {
if len(r.Header[jwtRequestHeader]) > 0 {
now := time.Now()
claims := jwt.RegisteredClaims{
Issuer: jwtIssuer,
Audience: jwt.ClaimStrings{jwtGitLabAudience},
ExpiresAt: jwt.NewNumericDate(now.Add(jwtValidFor)),
NotBefore: jwt.NewNumericDate(now.Add(-jwtNotBefore)),
IssuedAt: jwt.NewNumericDate(now),
}
signedClaims, err := jwt.NewWithClaims(jwt.SigningMethodHS256, claims).SignedString(authSecret)
if err != nil {
if logger != nil {
logger.Printf("Sign JWT: %v", err)
}
} else {
r.Header[jwtRequestHeader] = []string{signedClaims}
}
}
if hook != nil {
hook(logger, r, reqNum)
}
}
}
// errorHandler returns the last response and error when ran out of retry attempts.
// It masks values of URL query parameters.
func errorHandler(resp *http.Response, err error, numTries int) (*http.Response, error) {
ue, ok := err.(*url.Error) //nolint: errorlint
if !ok {
return resp, err
}
u, parseErr := url.Parse(ue.URL)
if parseErr != nil {
return resp, err
}
if u.RawQuery != "" {
maskURLQueryParams(u)
ue.URL = u.String()
}
return resp, ue
}
func maskURLQueryParams(u *url.URL) {
newVal := []string{"x"}
q := u.Query()
for k := range q {
q[k] = newVal
}
u.RawQuery = q.Encode()
}
|
