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
|
package sshd
import (
"bytes"
"context"
"errors"
"io"
"net/http"
"testing"
"github.com/stretchr/testify/require"
"golang.org/x/crypto/ssh"
"gitlab.com/gitlab-org/gitlab-shell/v14/client/testserver"
"gitlab.com/gitlab-org/gitlab-shell/v14/internal/config"
"gitlab.com/gitlab-org/gitlab-shell/v14/internal/console"
)
type fakeChannel struct {
stdErr io.ReadWriter
stdOut io.ReadWriter
sentRequestName string
sentRequestPayload []byte
}
func (f *fakeChannel) Read(data []byte) (int, error) {
return 0, nil
}
func (f *fakeChannel) Write(data []byte) (int, error) {
return f.stdOut.Write(data)
}
func (f *fakeChannel) Close() error {
return nil
}
func (f *fakeChannel) CloseWrite() error {
return nil
}
func (f *fakeChannel) SendRequest(name string, wantReply bool, payload []byte) (bool, error) {
f.sentRequestName = name
f.sentRequestPayload = payload
return true, nil
}
func (f *fakeChannel) Stderr() io.ReadWriter {
return f.stdErr
}
var requests = []testserver.TestRequestHandler{
{
Path: "/api/v4/internal/discover",
Handler: func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte(`{"id": 1000, "name": "Test User", "username": "test-user"}`))
},
},
}
func TestHandleEnv(t *testing.T) {
testCases := []struct {
desc string
payload []byte
expectedErr error
expectedProtocolVersion string
expectedResult bool
}{
{
desc: "invalid payload",
payload: []byte("invalid"),
expectedErr: errors.New("ssh: unmarshal error for field Name of type envRequest"),
expectedProtocolVersion: "1",
expectedResult: false,
}, {
desc: "valid payload",
payload: ssh.Marshal(envRequest{Name: "GIT_PROTOCOL", Value: "2"}),
expectedErr: nil,
expectedProtocolVersion: "2",
expectedResult: true,
}, {
desc: "valid payload with forbidden env var",
payload: ssh.Marshal(envRequest{Name: "GIT_PROTOCOL_ENV", Value: "2"}),
expectedErr: nil,
expectedProtocolVersion: "1",
expectedResult: true,
},
}
for _, tc := range testCases {
t.Run(tc.desc, func(t *testing.T) {
s := &session{gitProtocolVersion: "1"}
r := &ssh.Request{Payload: tc.payload}
shouldContinue, err := s.handleEnv(context.Background(), r)
require.Equal(t, tc.expectedErr, err)
require.Equal(t, tc.expectedResult, shouldContinue)
require.Equal(t, tc.expectedProtocolVersion, s.gitProtocolVersion)
})
}
}
func TestHandleExec(t *testing.T) {
testCases := []struct {
desc string
payload []byte
expectedErr error
expectedExecCmd string
sentRequestName string
sentRequestPayload []byte
}{
{
desc: "invalid payload",
payload: []byte("invalid"),
expectedErr: errors.New("ssh: unmarshal error for field Command of type execRequest"),
expectedExecCmd: "",
sentRequestName: "",
}, {
desc: "valid payload",
payload: ssh.Marshal(execRequest{Command: "discover"}),
expectedErr: nil,
expectedExecCmd: "discover",
sentRequestName: "exit-status",
sentRequestPayload: ssh.Marshal(exitStatusReq{ExitStatus: 0}),
},
}
url := testserver.StartHttpServer(t, requests)
for _, tc := range testCases {
t.Run(tc.desc, func(t *testing.T) {
sessions := []*session{
{
gitlabKeyId: "id",
cfg: &config.Config{GitlabUrl: url},
},
{
gitlabUsername: "root",
cfg: &config.Config{GitlabUrl: url},
},
{
gitlabKrb5Principal: "test@TEST.TEST",
cfg: &config.Config{GitlabUrl: url},
},
}
for _, s := range sessions {
stdErr := &bytes.Buffer{}
stdOut := &bytes.Buffer{}
f := &fakeChannel{stdErr: stdErr, stdOut: stdOut}
r := &ssh.Request{Payload: tc.payload}
s.channel = f
_, shouldContinue, err := s.handleExec(context.Background(), r)
require.Equal(t, tc.expectedErr, err)
require.False(t, shouldContinue)
require.Equal(t, tc.sentRequestName, f.sentRequestName)
require.Equal(t, tc.sentRequestPayload, f.sentRequestPayload)
}
})
}
}
func TestHandleShell(t *testing.T) {
testCases := []struct {
desc string
cmd string
errMsg string
gitlabKeyId string
expectedOutString string
expectedErrString string
expectedExitCode uint32
expectedWrittenBytes int64
}{
{
desc: "fails to parse command",
cmd: `\`,
errMsg: "ERROR: Failed to parse command: Invalid SSH command: invalid command line string\n",
gitlabKeyId: "root",
expectedErrString: "Invalid SSH command: invalid command line string",
expectedExitCode: 128,
},
{
desc: "specified command is unknown",
cmd: "unknown-command",
errMsg: "ERROR: Unknown command: unknown-command\n",
gitlabKeyId: "root",
expectedErrString: "Disallowed command",
expectedExitCode: 128,
},
{
desc: "fails to parse command",
cmd: "discover",
gitlabKeyId: "",
errMsg: "ERROR: Failed to get username: who='' is invalid\n",
expectedErrString: "Failed to get username: who='' is invalid",
expectedExitCode: 1,
},
{
desc: "parses command",
cmd: "discover",
errMsg: "",
gitlabKeyId: "root",
expectedOutString: "Welcome to GitLab, @test-user!\n",
expectedErrString: "",
expectedExitCode: 0,
expectedWrittenBytes: 31,
},
}
url := testserver.StartHttpServer(t, requests)
for _, tc := range testCases {
t.Run(tc.desc, func(t *testing.T) {
stdOut := &bytes.Buffer{}
stdErr := &bytes.Buffer{}
s := &session{
gitlabKeyId: tc.gitlabKeyId,
execCmd: tc.cmd,
channel: &fakeChannel{stdErr: stdErr, stdOut: stdOut},
cfg: &config.Config{GitlabUrl: url},
}
r := &ssh.Request{}
ctxWithLogData, exitCode, err := s.handleShell(context.Background(), r)
logData := extractDataFromContext(ctxWithLogData)
if tc.expectedOutString != "" {
require.Equal(t, tc.expectedOutString, stdOut.String())
}
if tc.expectedErrString != "" {
require.Equal(t, tc.expectedErrString, err.Error())
}
require.Equal(t, tc.expectedExitCode, exitCode)
require.Equal(t, tc.expectedWrittenBytes, logData.WrittenBytes)
formattedErr := &bytes.Buffer{}
if tc.errMsg != "" {
console.DisplayWarningMessage(tc.errMsg, formattedErr)
require.Equal(t, formattedErr.String(), stdErr.String())
} else {
require.Equal(t, tc.errMsg, stdErr.String())
}
})
}
}
|
