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
|
package gitlab
import (
"context"
"encoding/json"
"fmt"
"io"
"io/ioutil"
"mime"
"net/http"
"net/url"
"regexp"
"strings"
"github.com/prometheus/client_golang/prometheus"
"gitlab.com/gitlab-org/gitaly/v14/internal/gitaly/config"
promcfg "gitlab.com/gitlab-org/gitaly/v14/internal/gitaly/config/prometheus"
"gitlab.com/gitlab-org/gitaly/v14/internal/prometheus/metrics"
"gitlab.com/gitlab-org/gitaly/v14/internal/version"
"gitlab.com/gitlab-org/gitlab-shell/client"
)
var glIDRegex = regexp.MustCompile(`\A[0-9]+\z`)
// HTTPClient is an HTTP client used to talk to the internal GitLab Rails API.
type HTTPClient struct {
*client.GitlabNetClient
latencyMetric metrics.HistogramVec
}
// NewHTTPClient creates an HTTP client to talk to the Rails internal API
func NewHTTPClient(
gitlabCfg config.Gitlab,
tlsCfg config.TLS,
promCfg promcfg.Config,
) (*HTTPClient, error) {
url, err := url.PathUnescape(gitlabCfg.URL)
if err != nil {
return nil, err
}
var opts []client.HTTPClientOpt
if tlsCfg.CertPath != "" && tlsCfg.KeyPath != "" {
opts = append(opts, client.WithClientCert(tlsCfg.CertPath, tlsCfg.KeyPath))
}
httpClient, err := client.NewHTTPClientWithOpts(
url,
gitlabCfg.RelativeURLRoot,
gitlabCfg.HTTPSettings.CAFile,
gitlabCfg.HTTPSettings.CAPath,
gitlabCfg.HTTPSettings.SelfSigned,
uint64(gitlabCfg.HTTPSettings.ReadTimeout),
opts,
)
if err != nil {
return nil, fmt.Errorf("building new HTTP client for GitLab API: %w", err)
}
if httpClient == nil {
return nil, fmt.Errorf("%s is not a valid url", gitlabCfg.URL)
}
secret, err := ioutil.ReadFile(gitlabCfg.SecretFile)
if err != nil {
return nil, fmt.Errorf("reading secret file: %w", err)
}
gitlabnetClient, err := client.NewGitlabNetClient(gitlabCfg.HTTPSettings.User, gitlabCfg.HTTPSettings.Password, string(secret), httpClient)
if err != nil {
return nil, fmt.Errorf("instantiating gitlab net client: %w", err)
}
gitlabnetClient.SetUserAgent("gitaly/" + version.GetVersion())
return &HTTPClient{
GitlabNetClient: gitlabnetClient,
latencyMetric: prometheus.NewHistogramVec(
prometheus.HistogramOpts{
Name: "gitaly_gitlab_api_latency_seconds",
Help: "Latency between posting to GitLab's `/internal/` APIs and receiving a response",
Buckets: promCfg.GRPCLatencyBuckets,
},
[]string{"endpoint"},
),
}, nil
}
// Describe describes Prometheus metrics exposed by the HTTPClient.
func (c *HTTPClient) Describe(descs chan<- *prometheus.Desc) {
prometheus.DescribeByCollect(c, descs)
}
// Collect collects Prometheus metrics exposed by the HTTPClient.
func (c *HTTPClient) Collect(metrics chan<- prometheus.Metric) {
c.latencyMetric.Collect(metrics)
}
// allowedRequest is a request for the internal gitlab api /allowed endpoint
type allowedRequest struct {
Action string `json:"action,omitempty"`
GLRepository string `json:"gl_repository,omitempty"`
Project string `json:"project,omitempty"`
Changes string `json:"changes,omitempty"`
Protocol string `json:"protocol,omitempty"`
Env string `json:"env,omitempty"`
Username string `json:"username,omitempty"`
KeyID string `json:"key_id,omitempty"`
UserID string `json:"user_id,omitempty"`
}
func (a *allowedRequest) parseAndSetGLID(glID string) error {
var value string
switch {
case strings.HasPrefix(glID, "username-"):
a.Username = strings.TrimPrefix(glID, "username-")
return nil
case strings.HasPrefix(glID, "key-"):
a.KeyID = strings.TrimPrefix(glID, "key-")
value = a.KeyID
case strings.HasPrefix(glID, "user-"):
a.UserID = strings.TrimPrefix(glID, "user-")
value = a.UserID
}
if !glIDRegex.MatchString(value) {
return fmt.Errorf("gl_id='%s' is invalid", glID)
}
return nil
}
// allowedResponse is a response for the internal gitlab api's /allowed endpoint with a subset
// of fields
type allowedResponse struct {
Status bool `json:"status"`
Message string `json:"message"`
}
// Allowed checks if a ref change for a given repository is allowed through the gitlab internal api /allowed endpoint
func (c *HTTPClient) Allowed(ctx context.Context, params AllowedParams) (bool, string, error) {
defer prometheus.NewTimer(c.latencyMetric.WithLabelValues("allowed")).ObserveDuration()
gitObjDirVars, err := marshallGitObjectDirs(params.GitObjectDirectory, params.GitAlternateObjectDirectories)
if err != nil {
return false, "", fmt.Errorf("when getting git object directories json encoded string: %w", err)
}
req := allowedRequest{
Action: "git-receive-pack",
GLRepository: params.GLRepository,
Changes: params.Changes,
Protocol: params.GLProtocol,
Project: strings.Replace(params.RepoPath, "'", "", -1),
Env: gitObjDirVars,
}
if err := req.parseAndSetGLID(params.GLID); err != nil {
return false, "", fmt.Errorf("setting gl_id: %w", err)
}
resp, err := c.Post(ctx, "/allowed", &req)
if err != nil {
return false, "", err
}
defer func() {
io.Copy(ioutil.Discard, resp.Body)
resp.Body.Close()
}()
var response allowedResponse
switch resp.StatusCode {
case http.StatusOK,
http.StatusMultipleChoices:
mtype, _, err := mime.ParseMediaType(resp.Header.Get("Content-Type"))
if err != nil {
return false, "", fmt.Errorf("/allowed endpoint respond with unsupported content type: %w", err)
}
if mtype != "application/json" {
return false, "", fmt.Errorf("/allowed endpoint respond with unsupported content type: %s", mtype)
}
if err = json.NewDecoder(resp.Body).Decode(&response); err != nil {
return false, "", fmt.Errorf("decoding response from /allowed endpoint: %w", err)
}
default:
return false, "", fmt.Errorf("gitlab api is not accessible: %d", resp.StatusCode)
}
return response.Status, response.Message, nil
}
type preReceiveResponse struct {
ReferenceCounterIncreased bool `json:"reference_counter_increased"`
}
// PreReceive increases the reference counter for a push for a given gl_repository through the gitlab internal API /pre_receive endpoint
func (c *HTTPClient) PreReceive(ctx context.Context, glRepository string) (bool, error) {
defer prometheus.NewTimer(c.latencyMetric.WithLabelValues("pre-receive")).ObserveDuration()
resp, err := c.Post(ctx, "/pre_receive", map[string]string{"gl_repository": glRepository})
if err != nil {
return false, fmt.Errorf("http post to gitlab api /pre_receive endpoint: %w", err)
}
defer func() {
io.Copy(ioutil.Discard, resp.Body)
resp.Body.Close()
}()
if resp.StatusCode != http.StatusOK {
return false, fmt.Errorf("pre-receive call failed with status: %d", resp.StatusCode)
}
mtype, _, err := mime.ParseMediaType(resp.Header.Get("Content-Type"))
if err != nil {
return false, fmt.Errorf("/pre_receive endpoint respond with unsupported content type: %w", err)
}
if mtype != "application/json" {
return false, fmt.Errorf("/pre_receive endpoint respond with unsupported content type: %s", mtype)
}
var result preReceiveResponse
if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
return false, fmt.Errorf("decoding response from /pre_receive endpoint: %w", err)
}
return result.ReferenceCounterIncreased, nil
}
// postReceiveResponse is the response the GitLab internal api provides on a successful /post_receive call
type postReceiveResponse struct {
ReferenceCounterDecreased bool `json:"reference_counter_decreased"`
Messages []PostReceiveMessage `json:"messages"`
}
// PostReceive decreases the reference counter for a push for a given gl_repository through the gitlab internal API /post_receive endpoint
func (c *HTTPClient) PostReceive(ctx context.Context, glRepository, glID, changes string, pushOptions ...string) (bool, []PostReceiveMessage, error) {
defer prometheus.NewTimer(c.latencyMetric.WithLabelValues("post-receive")).ObserveDuration()
resp, err := c.Post(ctx, "/post_receive", map[string]interface{}{"gl_repository": glRepository, "identifier": glID, "changes": changes, "push_options": pushOptions})
if err != nil {
return false, nil, fmt.Errorf("http post to gitlab api /post_receive endpoint: %w", err)
}
defer func() {
io.Copy(ioutil.Discard, resp.Body)
resp.Body.Close()
}()
if resp.StatusCode != http.StatusOK {
return false, nil, fmt.Errorf("post-receive call failed with status: %d", resp.StatusCode)
}
mtype, _, err := mime.ParseMediaType(resp.Header.Get("Content-Type"))
if err != nil {
return false, nil, fmt.Errorf("/post_receive endpoint respond with invalid content type: %w", err)
}
if mtype != "application/json" {
return false, nil, fmt.Errorf("/post_receive endpoint respond with unsupported content type: %s", mtype)
}
var result postReceiveResponse
if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
return false, nil, fmt.Errorf("decoding response from /post_receive endpoint: %w", err)
}
return result.ReferenceCounterDecreased, result.Messages, nil
}
// Check performs an HTTP request to the internal/check API endpoint to verify
// the connection and tokens. It returns basic information of the installed
// GitLab
func (c *HTTPClient) Check(ctx context.Context) (*CheckInfo, error) {
defer prometheus.NewTimer(c.latencyMetric.WithLabelValues("check")).ObserveDuration()
resp, err := c.Get(ctx, "/check")
if err != nil {
return nil, fmt.Errorf("HTTP GET to GitLab endpoint /check failed: %w", err)
}
defer func() {
io.Copy(ioutil.Discard, resp.Body)
resp.Body.Close()
}()
if resp.StatusCode != http.StatusOK {
return nil, fmt.Errorf("Check HTTP request failed with status: %d", resp.StatusCode)
}
var info CheckInfo
if err := json.NewDecoder(resp.Body).Decode(&info); err != nil {
return nil, fmt.Errorf("failed to decode response from /check endpoint: %w", err)
}
return &info, nil
}
// marshallGitObjectDirs generates a json encoded string containing GIT_OBJECT_DIRECTORY_RELATIVE, and GIT_ALTERNATE_OBJECT_DIRECTORIES_RELATIVE
func marshallGitObjectDirs(gitObjectDirRel string, gitAltObjectDirsRel []string) (string, error) {
envString, err := json.Marshal(map[string]interface{}{
"GIT_OBJECT_DIRECTORY_RELATIVE": gitObjectDirRel,
"GIT_ALTERNATE_OBJECT_DIRECTORIES_RELATIVE": gitAltObjectDirsRel,
})
if err != nil {
return "", err
}
return string(envString), nil
}
|