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
|
package server
import (
"crypto/sha256"
"crypto/tls"
"encoding/binary"
"fmt"
"net"
gapi "gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/gitlab/api"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/module/kubernetes_api"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/module/kubernetes_api/rpc"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/module/modserver"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/module/modshared"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/cache"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/prototool"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/redistool"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/tlstool"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/serializer"
)
const (
k8sApiRequestCountKnownMetric = "k8s_api_proxy_request"
usersCiTunnelInteractionsCountMetric = "agent_users_using_ci_tunnel"
)
type Factory struct {
}
func (f *Factory) New(config *modserver.Config) (modserver.Module, error) {
k8sApi := config.Config.Agent.KubernetesApi
if k8sApi == nil {
return nopModule{}, nil
}
listenCfg := k8sApi.Listen
certFile := listenCfg.CertificateFile
keyFile := listenCfg.KeyFile
var listener func() (net.Listener, error)
tlsConfig, err := tlstool.MaybeDefaultServerTLSConfig(certFile, keyFile)
if err != nil {
return nil, err
}
if tlsConfig != nil {
listener = func() (net.Listener, error) {
return tls.Listen(*listenCfg.Network, listenCfg.Address, tlsConfig)
}
} else {
listener = func() (net.Listener, error) {
return net.Listen(*listenCfg.Network, listenCfg.Address)
}
}
serverName := fmt.Sprintf("%s/%s/%s", config.KasName, config.Version, config.CommitId)
var allowedOriginUrls []string
if u := config.Config.Gitlab.GetExternalUrl(); u != "" {
allowedOriginUrls = append(allowedOriginUrls, u)
}
allowedAgentCacheTtl := k8sApi.AllowedAgentCacheTtl.AsDuration()
allowedAgentCacheErrorTtl := k8sApi.AllowedAgentCacheErrorTtl.AsDuration()
tracer := config.TraceProvider.Tracer(kubernetes_api.ModuleName)
m := &module{
log: config.Log,
proxy: kubernetesApiProxy{
log: config.Log,
api: config.Api,
kubernetesApiClient: rpc.NewKubernetesApiClient(config.AgentConn),
gitLabClient: config.GitLabClient,
allowedOriginUrls: allowedOriginUrls,
allowedAgentsCache: cache.NewWithError[string, *gapi.AllowedAgentsForJob](
allowedAgentCacheTtl,
allowedAgentCacheErrorTtl,
&redistool.ErrCacher[string]{
Log: config.Log,
ErrRep: modshared.ApiToErrReporter(config.Api),
Client: config.RedisClient,
ErrMarshaler: prototool.ProtoErrMarshaler{},
KeyToRedisKey: func(jobToken string) string {
// Hash half of the token. Even if that hash leaks, it's not a big deal.
// We do the same in api.AgentToken2key().
n := len(jobToken) / 2
tokenHash := sha256.Sum256([]byte(jobToken[:n]))
return config.Config.Redis.KeyPrefix + ":allowed_agents_errs:" + string(tokenHash[:])
},
},
tracer,
gapi.IsCacheableError,
),
authorizeProxyUserCache: cache.NewWithError[proxyUserCacheKey, *gapi.AuthorizeProxyUserResponse](
allowedAgentCacheTtl,
allowedAgentCacheErrorTtl,
&redistool.ErrCacher[proxyUserCacheKey]{
Log: config.Log,
ErrRep: modshared.ApiToErrReporter(config.Api),
Client: config.RedisClient,
ErrMarshaler: prototool.ProtoErrMarshaler{},
KeyToRedisKey: getAuthorizedProxyUserCacheKey(config.Config.Redis.KeyPrefix),
},
tracer,
gapi.IsCacheableError,
),
requestCounter: config.UsageTracker.RegisterCounter(k8sApiRequestCountKnownMetric),
ciTunnelUsersCounter: config.UsageTracker.RegisterUniqueCounter(usersCiTunnelInteractionsCountMetric),
responseSerializer: serializer.NewCodecFactory(runtime.NewScheme()),
traceProvider: config.TraceProvider,
tracePropagator: config.TracePropagator,
meterProvider: config.MeterProvider,
serverName: serverName,
serverVia: "gRPC/1.0 " + serverName,
urlPathPrefix: k8sApi.UrlPathPrefix,
listenerGracePeriod: listenCfg.ListenGracePeriod.AsDuration(),
shutdownGracePeriod: listenCfg.ShutdownGracePeriod.AsDuration(),
},
listener: listener,
}
config.RegisterAgentApi(&rpc.KubernetesApi_ServiceDesc)
return m, nil
}
func (f *Factory) Name() string {
return kubernetes_api.ModuleName
}
func (f *Factory) StartStopPhase() modshared.ModuleStartStopPhase {
// Start after servers because proxy uses agent connection (config.AgentConn), which works by accessing
// in-memory private API server. So proxy needs to start after and stop before that server.
return modshared.ModuleStartAfterServers
}
func getAuthorizedProxyUserCacheKey(redisKeyPrefix string) redistool.KeyToRedisKey[proxyUserCacheKey] {
return func(key proxyUserCacheKey) string {
// Hash half of the token. Even if that hash leaks, it's not a big deal.
// We do the same in api.AgentToken2key().
n := len(key.accessKey) / 2
// Use delimiters between fields to ensure hash of "ab" + "c" is different from "a" + "bc".
h := sha256.New()
id := make([]byte, 8)
binary.LittleEndian.PutUint64(id, uint64(key.agentId))
h.Write(id)
// Don't need a delimiter here because id is fixed size in bytes
h.Write([]byte(key.accessType))
h.Write([]byte{11}) // delimiter
h.Write([]byte(key.accessKey[:n]))
h.Write([]byte{11}) // delimiter
h.Write([]byte(key.csrfToken))
tokenHash := h.Sum(nil)
return redisKeyPrefix + ":auth_proxy_user_errs:" + string(tokenHash)
}
}
|
