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
|
package git
import (
"encoding/base64"
"encoding/json"
"errors"
"fmt"
"strings"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/config"
"gitlab.com/gitlab-org/gitaly/v16/internal/metadata/featureflag"
"gitlab.com/gitlab-org/gitaly/v16/internal/transaction/txinfo"
"gitlab.com/gitlab-org/gitaly/v16/proto/go/gitalypb"
"google.golang.org/protobuf/encoding/protojson"
)
const (
// EnvHooksPayload is the name of the environment variable used
// to hold the hooks payload.
EnvHooksPayload = "GITALY_HOOKS_PAYLOAD"
)
// ErrPayloadNotFound is returned by HooksPayloadFromEnv if the given
// environment variables don't have a hooks payload.
var ErrPayloadNotFound = errors.New("no hooks payload found in environment")
// Hook represents a git hook. See githooks(5) for more information about
// existing hooks.
type Hook uint
const (
// ReferenceTransactionHook represents the reference-transaction git hook.
ReferenceTransactionHook = Hook(1 << iota)
// UpdateHook represents the update git hook.
UpdateHook
// PreReceiveHook represents the pre-receive git hook.
PreReceiveHook
// PostReceiveHook represents the post-receive git hook.
PostReceiveHook
// PackObjectsHook represents the pack-objects git hook.
PackObjectsHook
// AllHooks is the bitwise set of all hooks supported by Gitaly.
AllHooks = ReferenceTransactionHook | UpdateHook | PreReceiveHook | PostReceiveHook | PackObjectsHook
// ReceivePackHooks includes the set of hooks which shall be executed in
// a typical "push" or an emulation thereof (e.g. `updateReferenceWithHooks()`).
ReceivePackHooks = ReferenceTransactionHook | UpdateHook | PreReceiveHook | PostReceiveHook
)
// FeatureFlagWithValue is used as part of the HooksPayload to pass on feature flags with their
// values to gitaly-hooks.
type FeatureFlagWithValue struct {
// Flag is the feature flag.
Flag featureflag.FeatureFlag `json:"flag"`
// Enabled indicates whether the flag is enabled or not.
Enabled bool `json:"enabled"`
}
// HooksPayload holds parameters required for all hooks.
type HooksPayload struct {
// RequestedHooks is a bitfield of requested Hooks. Hooks which
// were not requested will not get executed.
RequestedHooks Hook `json:"requested_hooks"`
// FeatureFlagsWithValue contains feature flags with their values. They are set into the
// outgoing context when calling HookService.
FeatureFlagsWithValue []FeatureFlagWithValue `json:"feature_flags_with_value,omitempty"`
// Repo is the repository in which the hook is running.
Repo *gitalypb.Repository `json:"-"`
// ObjectFormat is the object format used by the repository. Some hooks use it in order to
// verify object IDs part of their input.
ObjectFormat string `json:"object_format"`
// RuntimeDir is the path to Gitaly's runtime directory.
RuntimeDir string `json:"runtime_dir"`
// InternalSocket is the path to Gitaly's internal socket.
InternalSocket string `json:"internal_socket"`
// InternalSocketToken is the token required to authenticate with
// Gitaly's internal socket.
InternalSocketToken string `json:"internal_socket_token"`
// Transaction is used to identify a reference transaction. This is an optional field -- if
// it's not set, no transactional voting will happen.
Transaction *txinfo.Transaction `json:"transaction"`
// UserDetails contains information required when executing
// git-receive-pack or git-upload-pack
UserDetails *UserDetails `json:"user_details"`
}
// UserDetails contains all information which is required for hooks
// executed by git-receive-pack, namely the pre-receive, update or post-receive
// hook.
type UserDetails struct {
// Username contains the name of the user who has caused the hook to be executed.
Username string `json:"username"`
// UserID contains the ID of the user who has caused the hook to be executed.
UserID string `json:"userid"`
// Protocol contains the protocol via which the hook was executed. This
// can be one of "web", "ssh" or "smarthttp".
Protocol string `json:"protocol"`
// RemoteIP contains the original IP of the client who initiated the flow leading to this
// target hook.
RemoteIP string `json:"remote_ip"`
}
// jsonHooksPayload wraps the HooksPayload such that we can manually encode the
// repository protobuf message.
type jsonHooksPayload struct {
HooksPayload
Repo string `json:"repository"`
}
// NewHooksPayload creates a new hooks payload which can then be encoded and
// passed to Git hooks.
func NewHooksPayload(
cfg config.Cfg,
repo *gitalypb.Repository,
objectHash ObjectHash,
tx *txinfo.Transaction,
userDetails *UserDetails,
requestedHooks Hook,
featureFlagsWithValue map[featureflag.FeatureFlag]bool,
) HooksPayload {
flags := make([]FeatureFlagWithValue, 0, len(featureFlagsWithValue))
for flag, enabled := range featureFlagsWithValue {
flags = append(flags, FeatureFlagWithValue{
Flag: flag,
Enabled: enabled,
})
}
return HooksPayload{
Repo: repo,
ObjectFormat: objectHash.Format,
RuntimeDir: cfg.RuntimeDir,
InternalSocket: cfg.InternalSocketPath(),
InternalSocketToken: cfg.Auth.Token,
Transaction: tx,
UserDetails: userDetails,
RequestedHooks: requestedHooks,
FeatureFlagsWithValue: flags,
}
}
func lookupEnv(envs []string, key string) (string, bool) {
for _, env := range envs {
kv := strings.SplitN(env, "=", 2)
if len(kv) != 2 {
continue
}
if kv[0] == key {
return kv[1], true
}
}
return "", false
}
// HooksPayloadFromEnv extracts the HooksPayload from the given environment
// variables. If no HooksPayload exists, it returns a ErrPayloadNotFound
// error.
func HooksPayloadFromEnv(envs []string) (HooksPayload, error) {
encoded, ok := lookupEnv(envs, EnvHooksPayload)
if !ok {
return HooksPayload{}, ErrPayloadNotFound
}
decoded, err := base64.StdEncoding.DecodeString(encoded)
if err != nil {
return HooksPayload{}, err
}
var jsonPayload jsonHooksPayload
if err := json.Unmarshal(decoded, &jsonPayload); err != nil {
return HooksPayload{}, err
}
var repo gitalypb.Repository
err = protojson.Unmarshal([]byte(jsonPayload.Repo), &repo)
if err != nil {
return HooksPayload{}, err
}
payload := jsonPayload.HooksPayload
payload.Repo = &repo
// If no RequestedHooks are passed down to us, then we need to assume
// that the caller of this hook isn't aware of this field and thus just
// pretend that he wants to execute all hooks.
if payload.RequestedHooks == 0 {
payload.RequestedHooks = AllHooks
}
return payload, nil
}
// Env encodes the given HooksPayload into an environment variable.
func (p HooksPayload) Env() (string, error) {
repo, err := protojson.Marshal(p.Repo)
if err != nil {
return "", err
}
jsonPayload := jsonHooksPayload{HooksPayload: p, Repo: string(repo)}
marshalled, err := json.Marshal(jsonPayload)
if err != nil {
return "", err
}
encoded := base64.StdEncoding.EncodeToString(marshalled)
return fmt.Sprintf("%s=%s", EnvHooksPayload, encoded), nil
}
// IsHookRequested returns whether the HooksPayload is requesting execution of
// the given git hook.
func (p HooksPayload) IsHookRequested(hook Hook) bool {
return p.RequestedHooks&hook != 0
}
|