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 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
|
package main
import (
"context"
"errors"
"fmt"
"io"
"net"
"os"
"path/filepath"
grpc_middleware "github.com/grpc-ecosystem/go-grpc-middleware"
"github.com/sirupsen/logrus"
gitalyauth "gitlab.com/gitlab-org/gitaly/v16/auth"
"gitlab.com/gitlab-org/gitaly/v16/client"
"gitlab.com/gitlab-org/gitaly/v16/internal/featureflag"
"gitlab.com/gitlab-org/gitaly/v16/internal/git"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/hook"
"gitlab.com/gitlab-org/gitaly/v16/internal/helper/env"
gitalylog "gitlab.com/gitlab-org/gitaly/v16/internal/log"
"gitlab.com/gitlab-org/gitaly/v16/internal/stream"
"gitlab.com/gitlab-org/gitaly/v16/internal/tracing"
"gitlab.com/gitlab-org/gitaly/v16/proto/go/gitalypb"
"gitlab.com/gitlab-org/gitaly/v16/streamio"
labkitcorrelation "gitlab.com/gitlab-org/labkit/correlation/grpc"
labkittracing "gitlab.com/gitlab-org/labkit/tracing"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/metadata"
"google.golang.org/grpc/status"
)
type hookError struct {
returnCode int
err error
clientMsg string
}
func (e hookError) Error() string {
return fmt.Sprintf("hook returned error code %d", e.returnCode)
}
type hookCommand struct {
exec func(context.Context, git.HooksPayload, gitalypb.HookServiceClient, []string) error
hookType git.Hook
}
var hooksBySubcommand = map[string]hookCommand{
"update": {
exec: updateHook,
hookType: git.UpdateHook,
},
"pre-receive": {
exec: preReceiveHook,
hookType: git.PreReceiveHook,
},
"post-receive": {
exec: postReceiveHook,
hookType: git.PostReceiveHook,
},
"reference-transaction": {
exec: referenceTransactionHook,
hookType: git.ReferenceTransactionHook,
},
}
func main() {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
// Since the environment is sanitized at the moment, we're only
// using this to extract the correlation ID. The finished() call
// to clean up the tracing will be a NOP here.
ctx, finished := labkittracing.ExtractFromEnv(ctx)
defer finished()
logger := gitalylog.NewHookLogger(ctx)
if err := run(ctx, os.Args); err != nil {
var hookError hookError
if errors.As(err, &hookError) {
if hookError.err != nil {
notifyError("error executing git hook")
logger.WithError(hookError.err).Error("error executing git hook")
}
if hookError.clientMsg != "" {
notifyError(hookError.clientMsg)
}
os.Exit(hookError.returnCode)
}
notifyError("error executing git hook")
logger.WithError(err).Error("error executing git hook")
os.Exit(1)
}
}
// Both stderr and stdout of gitaly-hooks are streamed back to clients. stdout is processed by client
// git process transparently. stderr is dumped directly to client's stdout. Thus, we must be cautious
// what to write into stderr.
func notifyError(msg string) {
fmt.Fprintln(os.Stderr, msg)
}
func run(ctx context.Context, args []string) error {
switch filepath.Base(args[0]) {
case "gitaly-hooks":
if len(args) < 2 {
return fmt.Errorf("requires hook name. args: %v", args)
}
subCmd := args[1]
switch subCmd {
case "git":
return executeHook(ctx, hookCommand{
exec: packObjectsHook,
hookType: git.PackObjectsHook,
}, args[2:])
}
return fmt.Errorf("subcommand name invalid: %q", subCmd)
default:
hookName := filepath.Base(args[0])
hookCommand, ok := hooksBySubcommand[hookName]
if !ok {
return fmt.Errorf("subcommand name invalid: %q", hookName)
}
return executeHook(ctx, hookCommand, args[1:])
}
}
func executeHook(ctx context.Context, cmd hookCommand, args []string) error {
payload, err := git.HooksPayloadFromEnv(os.Environ())
if err != nil {
return fmt.Errorf("error when getting hooks payload: %w", err)
}
// If the hook wasn't requested, then we simply skip executing any
// logic.
if !payload.IsHookRequested(cmd.hookType) {
return nil
}
ctx = injectMetadataIntoOutgoingCtx(ctx, payload)
conn, err := dialGitaly(payload)
if err != nil {
return fmt.Errorf("error when connecting to gitaly: %w", err)
}
defer conn.Close()
hookClient := gitalypb.NewHookServiceClient(conn)
return cmd.exec(ctx, payload, hookClient, args)
}
func injectMetadataIntoOutgoingCtx(ctx context.Context, payload git.HooksPayload) context.Context {
if payload.UserDetails != nil {
ctx = metadata.AppendToOutgoingContext(
ctx,
"user_id",
payload.UserDetails.UserID,
"username",
payload.UserDetails.Username,
"remote_ip",
payload.UserDetails.RemoteIP,
)
}
for _, flag := range payload.FeatureFlagsWithValue {
ctx = featureflag.OutgoingCtxWithFeatureFlag(ctx, flag.Flag, flag.Enabled)
}
return ctx
}
func noopSender(c chan error) {}
func dialGitaly(payload git.HooksPayload) (*grpc.ClientConn, error) {
dialOpts := client.DefaultDialOpts
if payload.InternalSocketToken != "" {
dialOpts = append(dialOpts, grpc.WithPerRPCCredentials(gitalyauth.RPCCredentialsV2(payload.InternalSocketToken)))
}
// Propagate correlation ID
unaryInterceptors := []grpc.UnaryClientInterceptor{
labkitcorrelation.UnaryClientCorrelationInterceptor(
labkitcorrelation.WithClientName("gitaly-hooks"),
),
}
streamInterceptors := []grpc.StreamClientInterceptor{
labkitcorrelation.StreamClientCorrelationInterceptor(
labkitcorrelation.WithClientName("gitaly-hooks"),
),
}
// Setup tracing is possible
initializeTracing()
if spanContext, err := tracing.ExtractSpanContextFromEnv(os.Environ()); err == nil {
unaryInterceptors = append(unaryInterceptors, tracing.UnaryPassthroughInterceptor(spanContext))
streamInterceptors = append(streamInterceptors, tracing.StreamPassthroughInterceptor(spanContext))
}
dialOpts = append(dialOpts, grpc.WithUnaryInterceptor(grpc_middleware.ChainUnaryClient(unaryInterceptors...)))
dialOpts = append(dialOpts, grpc.WithStreamInterceptor(grpc_middleware.ChainStreamClient(streamInterceptors...)))
conn, err := client.Dial("unix://"+payload.InternalSocket, dialOpts)
if err != nil {
return nil, fmt.Errorf("error when dialing: %w", err)
}
return conn, nil
}
func initializeTracing() {
// All stdout and stderr are captured by Gitaly process. They may be sent back to users.
// We don't want to bother them with these redundant logs. As a result, all logs should be
// suppressed while labkit is in initialization phase.
output := logrus.StandardLogger().Out
logrus.SetOutput(io.Discard)
defer logrus.SetOutput(output)
// This is a sanitized environment. It does not suppose to expose any spans. Instead, it
// transfers incoming metadata from ENV to gRPC outgoing metadata without any modification
// or starting new span. This technique connects the parent span in parent Gitaly process
// and the remote spans when Gitaly handle subsequent gRPC calls issued by this hook.
// As tracing is a nice-to-have feature, it should not interrupt the main functionality
// of Gitaly hook. As a result, errors, if any, are ignored.
labkittracing.Initialize()
}
func gitPushOptions() []string {
var gitPushOptions []string
gitPushOptionCount, err := env.GetInt("GIT_PUSH_OPTION_COUNT", 0)
if err != nil {
return gitPushOptions
}
for i := 0; i < gitPushOptionCount; i++ {
gitPushOptions = append(gitPushOptions, os.Getenv(fmt.Sprintf("GIT_PUSH_OPTION_%d", i)))
}
return gitPushOptions
}
func sendFunc(reqWriter io.Writer, stream grpc.ClientStream, stdin io.Reader) func(errC chan error) {
return func(errC chan error) {
_, errSend := io.Copy(reqWriter, stdin)
errClose := stream.CloseSend()
if errSend != nil {
errC <- errSend
} else {
errC <- errClose
}
}
}
func updateHook(ctx context.Context, payload git.HooksPayload, hookClient gitalypb.HookServiceClient, args []string) error {
if len(args) != 3 {
return fmt.Errorf("update hook expects exactly three arguments, got %q", args)
}
ref, oldValue, newValue := args[0], args[1], args[2]
req := &gitalypb.UpdateHookRequest{
Repository: payload.Repo,
EnvironmentVariables: os.Environ(),
Ref: []byte(ref),
OldValue: oldValue,
NewValue: newValue,
}
updateHookStream, err := hookClient.UpdateHook(ctx, req)
if err != nil {
return fmt.Errorf("error when starting command for update hook: %w", err)
}
if returnCode, err := stream.Handler(func() (stream.StdoutStderrResponse, error) {
return updateHookStream.Recv()
}, noopSender, os.Stdout, os.Stderr); err != nil {
return fmt.Errorf("error when receiving data for update hook: %w", err)
} else if returnCode != 0 {
return hookError{returnCode: int(returnCode)}
}
return nil
}
func preReceiveHook(ctx context.Context, payload git.HooksPayload, hookClient gitalypb.HookServiceClient, args []string) error {
preReceiveHookStream, err := hookClient.PreReceiveHook(ctx)
if err != nil {
return fmt.Errorf("error when getting preReceiveHookStream client for: %w", err)
}
if err := preReceiveHookStream.Send(&gitalypb.PreReceiveHookRequest{
Repository: payload.Repo,
EnvironmentVariables: os.Environ(),
GitPushOptions: gitPushOptions(),
}); err != nil {
return fmt.Errorf("error when sending request for pre-receive hook: %w", err)
}
f := sendFunc(streamio.NewWriter(func(p []byte) error {
return preReceiveHookStream.Send(&gitalypb.PreReceiveHookRequest{Stdin: p})
}), preReceiveHookStream, os.Stdin)
if returnCode, err := stream.Handler(func() (stream.StdoutStderrResponse, error) {
return preReceiveHookStream.Recv()
}, f, os.Stdout, os.Stderr); err != nil {
return fmt.Errorf("error when receiving data for pre-receive hook: %w", err)
} else if returnCode != 0 {
return hookError{returnCode: int(returnCode)}
}
return nil
}
func postReceiveHook(ctx context.Context, payload git.HooksPayload, hookClient gitalypb.HookServiceClient, args []string) error {
postReceiveHookStream, err := hookClient.PostReceiveHook(ctx)
if err != nil {
return fmt.Errorf("error when getting stream client for post-receive hook: %w", err)
}
if err := postReceiveHookStream.Send(&gitalypb.PostReceiveHookRequest{
Repository: payload.Repo,
EnvironmentVariables: os.Environ(),
GitPushOptions: gitPushOptions(),
}); err != nil {
return fmt.Errorf("error when sending request for post-receive hook: %w", err)
}
f := sendFunc(streamio.NewWriter(func(p []byte) error {
return postReceiveHookStream.Send(&gitalypb.PostReceiveHookRequest{Stdin: p})
}), postReceiveHookStream, os.Stdin)
if returnCode, err := stream.Handler(func() (stream.StdoutStderrResponse, error) {
return postReceiveHookStream.Recv()
}, f, os.Stdout, os.Stderr); err != nil {
return fmt.Errorf("error when receiving data for post-receive hook: %w", err)
} else if returnCode != 0 {
return hookError{returnCode: int(returnCode)}
}
return nil
}
func referenceTransactionHook(ctx context.Context, payload git.HooksPayload, hookClient gitalypb.HookServiceClient, args []string) error {
if len(args) != 1 {
return fmt.Errorf("reference-transaction hook is missing required arguments, got %q", args)
}
var state gitalypb.ReferenceTransactionHookRequest_State
switch args[0] {
case "prepared":
state = gitalypb.ReferenceTransactionHookRequest_PREPARED
case "committed":
state = gitalypb.ReferenceTransactionHookRequest_COMMITTED
case "aborted":
state = gitalypb.ReferenceTransactionHookRequest_ABORTED
default:
return fmt.Errorf("reference-transaction hook has invalid state: %q", args[0])
}
referenceTransactionHookStream, err := hookClient.ReferenceTransactionHook(ctx)
if err != nil {
return fmt.Errorf("error when getting referenceTransactionHookStream client: %w", err)
}
if err := referenceTransactionHookStream.Send(&gitalypb.ReferenceTransactionHookRequest{
Repository: payload.Repo,
EnvironmentVariables: os.Environ(),
State: state,
}); err != nil {
return fmt.Errorf("error when sending request for reference-transaction hook: %w", err)
}
f := sendFunc(streamio.NewWriter(func(p []byte) error {
return referenceTransactionHookStream.Send(&gitalypb.ReferenceTransactionHookRequest{Stdin: p})
}), referenceTransactionHookStream, os.Stdin)
if returnCode, err := stream.Handler(func() (stream.StdoutStderrResponse, error) {
return referenceTransactionHookStream.Recv()
}, f, os.Stdout, os.Stderr); err != nil {
return fmt.Errorf("error when receiving data for reference-transaction hook: %w", err)
} else if returnCode != 0 {
return hookError{returnCode: int(returnCode)}
}
return nil
}
func packObjectsHook(ctx context.Context, payload git.HooksPayload, hookClient gitalypb.HookServiceClient, args []string) error {
ctx, wt, err := hook.SetupSidechannel(ctx, payload, func(c *net.UnixConn) error {
return stream.ProxyPktLine(c, os.Stdin, os.Stdout, os.Stderr)
})
if err != nil {
return hookError{returnCode: 1, err: fmt.Errorf("RPC failed: SetupSidechannel: %w", err)}
}
defer func() {
// We aleady check the error further down.
_ = wt.Close()
}()
var glID, glUsername, gitProtocol, remoteIP string
if payload.UserDetails != nil {
glID = payload.UserDetails.UserID
glUsername = payload.UserDetails.Username
gitProtocol = payload.UserDetails.Protocol
remoteIP = payload.UserDetails.RemoteIP
}
if _, err := hookClient.PackObjectsHookWithSidechannel(
ctx,
&gitalypb.PackObjectsHookWithSidechannelRequest{
Repository: payload.Repo,
Args: args,
GlId: glID,
GlUsername: glUsername,
GitProtocol: gitProtocol,
RemoteIp: remoteIP,
},
); err != nil {
return wrapGRPCError(err)
}
if err := wt.Wait(); err != nil {
return hookError{returnCode: 1, err: fmt.Errorf("RPC failed: %w", err)}
}
if err := wt.Close(); err != nil {
return hookError{returnCode: 1, err: fmt.Errorf("RPC failed: closing sidechannel: %w", err)}
}
return nil
}
func wrapGRPCError(err error) error {
wrappedErr := hookError{
returnCode: 1,
err: fmt.Errorf("RPC failed: %w", err),
}
if e, ok := status.FromError(err); ok {
switch e.Code() {
case codes.ResourceExhausted:
wrappedErr.clientMsg = "error resource exhausted, please try again later"
}
}
return wrappedErr
}
|