/
git.go
355 lines (311 loc) · 10.3 KB
/
git.go
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
// Copyright 2017 Keybase, Inc. All rights reserved. Use of
// this source code is governed by the included BSD license.
package service
import (
"errors"
"fmt"
"time"
"github.com/adamwalz/keybase-client/go/git"
"github.com/adamwalz/keybase-client/go/libkb"
keybase1 "github.com/adamwalz/keybase-client/go/protocol/keybase1"
"github.com/adamwalz/keybase-client/go/teams"
"github.com/keybase/go-framed-msgpack-rpc/rpc"
"golang.org/x/net/context"
)
type GitHandler struct {
*BaseHandler
libkb.Contextified
}
var _ keybase1.GitInterface = (*GitHandler)(nil)
const (
gitDefaultMaxLooseRefs = 50
gitDefaultPruneMinLooseObjects = 50
gitDefaultPruneExpireAge = 14 * 24 * time.Hour
gitDefaultMaxObjectPacks = 50
)
func NewGitHandler(xp rpc.Transporter, g *libkb.GlobalContext) *GitHandler {
return &GitHandler{
BaseHandler: NewBaseHandler(g, xp),
Contextified: libkb.NewContextified(g),
}
}
func (h *GitHandler) PutGitMetadata(ctx context.Context, arg keybase1.PutGitMetadataArg) (err error) {
ctx = libkb.WithLogTag(ctx, "GIT")
defer h.G().CTrace(ctx, fmt.Sprintf(
"git:PutGitMetadata(%v, %v, %v)", arg.RepoID, arg.Folder.Name, arg.Folder.FolderType),
&err)()
return git.PutMetadata(ctx, h.G(), arg)
}
func (h *GitHandler) DeleteGitMetadata(ctx context.Context, arg keybase1.DeleteGitMetadataArg) (err error) {
ctx = libkb.WithLogTag(ctx, "GIT")
defer h.G().CTrace(ctx, fmt.Sprintf(
"git:DeleteGitMetadata(%v, %v)", arg.Folder.Name, arg.Folder.FolderType),
&err)()
return git.DeleteMetadata(ctx, h.G(), arg.Folder, arg.RepoName)
}
func (h *GitHandler) GetGitMetadata(ctx context.Context, folder keybase1.FolderHandle) (res []keybase1.GitRepoResult, err error) {
ctx = libkb.WithLogTag(ctx, "GIT")
defer h.G().CTrace(ctx, fmt.Sprintf(
"git:GetGitMetadata(%v, %v)", folder.Name, folder.FolderType),
&err)()
return git.GetMetadata(ctx, h.G(), folder)
}
func (h *GitHandler) GetAllGitMetadata(ctx context.Context) (res []keybase1.GitRepoResult, err error) {
ctx = libkb.WithLogTag(ctx, "GIT")
defer h.G().CTrace(ctx, "git:GetAllGitMetadata", &err)()
return git.GetAllMetadata(ctx, h.G())
}
// In several cases (implicit admins doing anything, writers doing deletes),
// KBFS will allow or give confusing error messages for operations that don't
// have the right permissions. Doing an explicit check for these helps us give
// clear errors.
//
// Note that the minimumRole here does *not* respect implicit adminship.
func isRoleAtLeast(ctx context.Context, g *libkb.GlobalContext, teamName string, public bool, minimumRole keybase1.TeamRole) (bool, error) {
team, err := teams.Load(ctx, g, keybase1.LoadTeamArg{
Name: teamName,
Public: public,
ForceRepoll: true,
})
if err != nil {
return false, err
}
self, _, err := g.GetUPAKLoader().LoadV2(libkb.NewLoadUserSelfAndUIDArg(g))
if err != nil {
return false, err
}
role, err := team.MemberRole(ctx, self.Current.ToUserVersion())
if err != nil {
return false, fmt.Errorf("self role missing from team %s", teamName)
}
return role.IsOrAbove(minimumRole), nil
}
func (h *GitHandler) createRepo(ctx context.Context, folder keybase1.FolderHandle, repoName keybase1.GitRepoName, notifyTeam bool) (repoID keybase1.RepoID, err error) {
ctx = libkb.WithLogTag(ctx, "GIT")
defer h.G().CTrace(ctx, fmt.Sprintf(
"git:createRepo(%v, %v)", folder.Name, folder.FolderType),
&err)()
client, err := h.kbfsClient()
if err != nil {
return "", err
}
carg := keybase1.CreateRepoArg{
Folder: folder,
Name: repoName,
}
repoID, err = client.CreateRepo(ctx, carg)
if err != nil {
// Real user errors are going to come through this path, like "repo
// already exists". Make them clear for the user.
return "", git.HumanizeGitErrors(ctx, h.G(), err)
}
// Currently KBFS will also call back into the service to put metadata
// after a create, so the put might happen twice, but we don't want to
// depend on that behavior.
err = git.PutMetadata(ctx, h.G(), keybase1.PutGitMetadataArg{
Folder: folder,
RepoID: repoID,
Metadata: keybase1.GitLocalMetadata{
RepoName: repoName,
},
NotifyTeam: notifyTeam,
})
if err != nil {
return "", err
}
return repoID, nil
}
func (h *GitHandler) CreatePersonalRepo(ctx context.Context, repoName keybase1.GitRepoName) (repoID keybase1.RepoID, err error) {
ctx = libkb.WithLogTag(ctx, "GIT")
defer h.G().CTrace(ctx, "git:CreatePersonalRepo", &err)()
folder := keybase1.FolderHandle{
Name: h.G().Env.GetUsername().String(),
FolderType: keybase1.FolderType_PRIVATE,
}
return h.createRepo(ctx, folder, repoName, false /* notifyTeam */)
}
func (h *GitHandler) CreateTeamRepo(ctx context.Context, arg keybase1.CreateTeamRepoArg) (repoID keybase1.RepoID, err error) {
ctx = libkb.WithLogTag(ctx, "GIT")
defer h.G().CTrace(ctx, fmt.Sprintf(
"git:CreateTeamRepo(%v)", arg.TeamName),
&err)()
// Only support private teams
public := false
// This prevents implicit admins from getting a confusing error message.
isWriter, err := isRoleAtLeast(ctx, h.G(), arg.TeamName.String(), public, keybase1.TeamRole_WRITER)
if err != nil {
return "", err
}
if !isWriter {
return "", fmt.Errorf("Only team writers may create git repos.")
}
folder := keybase1.FolderHandle{
Name: arg.TeamName.String(),
FolderType: keybase1.FolderType_TEAM,
}
return h.createRepo(ctx, folder, arg.RepoName, arg.NotifyTeam)
}
func (h *GitHandler) DeletePersonalRepo(ctx context.Context, repoName keybase1.GitRepoName) (err error) {
ctx = libkb.WithLogTag(ctx, "GIT")
defer h.G().CTrace(ctx, "git:DeletePersonalRepo",
&err)()
client, err := h.kbfsClient()
if err != nil {
return err
}
folder := keybase1.FolderHandle{
Name: h.G().Env.GetUsername().String(),
FolderType: keybase1.FolderType_PRIVATE,
}
darg := keybase1.DeleteRepoArg{
Folder: folder,
Name: repoName,
}
err = client.DeleteRepo(ctx, darg)
if err != nil {
switch err.(type) {
case libkb.RepoDoesntExistError:
h.G().Log.Warning("Git repo doesn't exist. Deleting metadata anyway.")
default:
return err
}
}
// Delete the repo metadata from the Keybase server.
err = git.DeleteMetadata(ctx, h.G(), folder, repoName)
return git.HumanizeGitErrors(ctx, h.G(), err)
}
func (h *GitHandler) DeleteTeamRepo(ctx context.Context, arg keybase1.DeleteTeamRepoArg) (err error) {
ctx = libkb.WithLogTag(ctx, "GIT")
defer h.G().CTrace(ctx, fmt.Sprintf(
"git:DeleteTeamRepo(%v)", arg.TeamName),
&err)()
// Only support private teams
public := false
// First make sure the user is an admin of the team. KBFS doesn't directly
// enforce this requirement, so a non-admin could get around it by hacking
// up their own client, but they could already wreak a lot of abuse by
// pushing garbage to the repo, so we don't consider this a big deal.
isAdmin, err := isRoleAtLeast(ctx, h.G(), arg.TeamName.String(), public, keybase1.TeamRole_ADMIN)
if err != nil {
return err
}
if !isAdmin {
return fmt.Errorf("Only team admins may delete git repos.")
}
client, err := h.kbfsClient()
if err != nil {
return err
}
folder := keybase1.FolderHandle{
Name: arg.TeamName.String(),
FolderType: keybase1.FolderType_TEAM,
}
darg := keybase1.DeleteRepoArg{
Folder: folder,
Name: arg.RepoName,
}
err = client.DeleteRepo(ctx, darg)
if err != nil {
switch err.(type) {
case libkb.RepoDoesntExistError:
h.G().Log.Warning("Git repo doesn't exist. Deleting metadata anyway.")
default:
return err
}
}
// Delete the repo metadata from the Keybase server.
err = git.DeleteMetadata(ctx, h.G(), folder, arg.RepoName)
return git.HumanizeGitErrors(ctx, h.G(), err)
}
func (h *GitHandler) GcPersonalRepo(ctx context.Context, arg keybase1.GcPersonalRepoArg) (err error) {
ctx = libkb.WithLogTag(ctx, "GIT")
defer h.G().CTrace(ctx, "git:GCPersonalRepo",
&err)()
client, err := h.kbfsClient()
if err != nil {
return err
}
folder := keybase1.FolderHandle{
Name: h.G().Env.GetUsername().String(),
FolderType: keybase1.FolderType_PRIVATE,
}
options := keybase1.GcOptions{}
if !arg.Force {
options.MaxLooseRefs = gitDefaultMaxLooseRefs
options.MaxObjectPacks = gitDefaultMaxObjectPacks
}
gcarg := keybase1.GcArg{
Folder: folder,
Name: arg.RepoName,
Options: options,
}
err = client.Gc(ctx, gcarg)
if err != nil {
return git.HumanizeGitErrors(ctx, h.G(), err)
}
return nil
}
func (h *GitHandler) GcTeamRepo(ctx context.Context, arg keybase1.GcTeamRepoArg) (err error) {
ctx = libkb.WithLogTag(ctx, "GIT")
defer h.G().CTrace(ctx, fmt.Sprintf(
"git:GcTeamRepo(%v)", arg.TeamName),
&err)()
// Only support private teams
public := false
// First make sure the user is a writer of the team.
isWriter, err := isRoleAtLeast(ctx, h.G(), arg.TeamName.String(), public, keybase1.TeamRole_WRITER)
if err != nil {
return err
}
if !isWriter {
return fmt.Errorf("Only writers may garbage collect git repos.")
}
client, err := h.kbfsClient()
if err != nil {
return err
}
folder := keybase1.FolderHandle{
Name: arg.TeamName.String(),
FolderType: keybase1.FolderType_TEAM,
}
options := keybase1.GcOptions{
PruneExpireTime: keybase1.ToTime(
time.Now().Add(-gitDefaultPruneExpireAge)),
}
if !arg.Force {
options.MaxLooseRefs = gitDefaultMaxLooseRefs
options.PruneMinLooseObjects = gitDefaultPruneMinLooseObjects
}
gcarg := keybase1.GcArg{
Folder: folder,
Name: arg.RepoName,
Options: options,
}
err = client.Gc(ctx, gcarg)
if err != nil {
return git.HumanizeGitErrors(ctx, h.G(), err)
}
return nil
}
func (h *GitHandler) GetTeamRepoSettings(ctx context.Context, arg keybase1.GetTeamRepoSettingsArg) (keybase1.GitTeamRepoSettings, error) {
return git.GetTeamRepoSettings(ctx, h.G(), arg)
}
func (h *GitHandler) SetTeamRepoSettings(ctx context.Context, arg keybase1.SetTeamRepoSettingsArg) error {
return git.SetTeamRepoSettings(ctx, h.G(), arg)
}
func (h *GitHandler) kbfsClient() (*keybase1.KBFSGitClient, error) {
if !h.G().ActiveDevice.Valid() {
return nil, libkb.LoginRequiredError{}
}
if h.G().ConnectionManager == nil {
return nil, errors.New("no connection manager available")
}
xp := h.G().ConnectionManager.LookupByClientType(keybase1.ClientType_KBFS)
if xp == nil {
return nil, libkb.KBFSNotRunningError{}
}
return &keybase1.KBFSGitClient{
Cli: rpc.NewClient(
xp, libkb.NewContextifiedErrorUnwrapper(h.G()), libkb.LogTagsFromContext),
}, nil
}