forked from gravitational/teleport
-
Notifications
You must be signed in to change notification settings - Fork 0
/
errors.go
456 lines (388 loc) · 11.2 KB
/
errors.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
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
450
451
452
453
454
455
456
/*
Copyright 2015 Gravitational, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package teleport
import (
"fmt"
"net"
"os"
"syscall"
"github.com/gravitational/trace"
)
// AlreadyAcquiredError is returned when lock has been acquired
type AlreadyAcquiredError struct {
trace.Traces `json:"traces"`
Message string `json:"message"`
}
// IsAlreadyAcquiredError returns true to indicate that this is AlreadyAcquiredError
func (e *AlreadyAcquiredError) IsAlreadyAcquiredError() bool {
return true
}
// Error returns log friendly description
func (e *AlreadyAcquiredError) Error() string {
if e.Message != "" {
return e.Message
}
return "lock is already aquired"
}
// OrigError returns original error (in this case this is the error itself)
func (e *AlreadyAcquiredError) OrigError() error {
return e
}
// NotFound returns new instance of not found error
func NotFound(message string) *NotFoundError {
return &NotFoundError{
Message: message,
}
}
// NotFoundError indicates that object has not been found
type NotFoundError struct {
trace.Traces `json:"traces"`
Message string `json:"message"`
}
// IsNotFoundError returns true to indicate that is NotFoundError
func (e *NotFoundError) IsNotFoundError() bool {
return true
}
// Error returns log friendly description of an error
func (e *NotFoundError) Error() string {
if e.Message != "" {
return e.Message
}
return "object not found"
}
// OrigError returns original error (in this case this is the error itself)
func (e *NotFoundError) OrigError() error {
return e
}
// IsNotFound returns whether this error indicates that the object is not found
func IsNotFound(e error) bool {
type nf interface {
IsNotFoundError() bool
}
_, ok := e.(nf)
return ok
}
// AlreadyExists returns new AlreadyExists error
func AlreadyExists(message string) *AlreadyExistsError {
return &AlreadyExistsError{
Message: message,
}
}
// AlreadyExistsError indicates that there's a duplicate object that already
// exists in the storage/system
type AlreadyExistsError struct {
trace.Traces `json:"traces"`
// Message is user-friendly error message
Message string `json:"message"`
}
// Error returns log-friendly error description
func (n *AlreadyExistsError) Error() string {
if n.Message != "" {
return n.Message
}
return "object already exists"
}
// IsAlreadyExistsError indicates that this error is of AlreadyExists kind
func (AlreadyExistsError) IsAlreadyExistsError() bool {
return true
}
// OrigError returns original error (in this case this is the error itself)
func (e *AlreadyExistsError) OrigError() error {
return e
}
// IsAlreadyExists returns if this is error indicating that object
// already exists
func IsAlreadyExists(e error) bool {
type ae interface {
IsAlreadyExistsError() bool
}
_, ok := e.(ae)
return ok
}
// MissingParameterError indicates that one of the parameters was missing
type MissingParameterError struct {
trace.Traces `json:"traces"`
// Param is the name of the missing parameter
Param string
}
// Error returns log-friendly description of the error
func (m *MissingParameterError) Error() string {
return fmt.Sprintf("missing required parameter '%v'", m.Param)
}
// IsMissingParameterError indicates that this error is of MissingParameter type
func (m *MissingParameterError) IsMissingParameterError() bool {
return true
}
// OrigError returns original error (in this case this is the error itself)
func (e *MissingParameterError) OrigError() error {
return e
}
// IsMissingParameter detects if this error is of MissingParameter kind
func IsMissingParameter(e error) bool {
type ae interface {
IsMissingParameterError() bool
}
_, ok := e.(ae)
return ok
}
// BadParameter returns a new instance of BadParameterError
func BadParameter(name, message string) *BadParameterError {
return &BadParameterError{
Param: name,
Err: message,
}
}
// BadParameterError indicates that something is wrong with passed
// parameter to API method
type BadParameterError struct {
trace.Traces
Param string `json:"param"`
Err string `json:"message"`
}
// Error returrns debug friendly message
func (b *BadParameterError) Error() string {
return fmt.Sprintf("bad parameter '%v', %v", b.Param, b.Err)
}
// OrigError returns original error (in this case this is the error itself)
func (b *BadParameterError) OrigError() error {
return b
}
// IsBadParameterError indicates that error is of bad parameter type
func (b *BadParameterError) IsBadParameterError() bool {
return true
}
// IsBadParameter detects if this error is of BadParameter kind
func IsBadParameter(e error) bool {
type bp interface {
IsBadParameterError() bool
}
_, ok := e.(bp)
return ok
}
// CompareFailedError indicates that compare failed (e.g wrong password or hash)
type CompareFailedError struct {
trace.Traces
// Message is user-friendly error message
Message string `json:"message"`
}
// Error is debug - friendly message
func (e *CompareFailedError) Error() string {
if e.Message != "" {
return e.Message
}
return "compare failed"
}
// OrigError returns original error (in this case this is the error itself)
func (e *CompareFailedError) OrigError() error {
return e
}
// IsCompareFailedError indicates that this is compare failed error
func (e *CompareFailedError) IsCompareFailedError() bool {
return true
}
// IsCompareFailed detects if this error is of CompareFailed kind
func IsCompareFailed(e error) bool {
type cf interface {
IsCompareFailedError() bool
}
_, ok := e.(cf)
return ok
}
// ReadonlyError indicates that some backend can only read, not write
type ReadonlyError struct {
trace.Traces
Message string `json:"message"`
}
// Error is debug - friendly error message
func (e *ReadonlyError) Error() string {
if e.Message != "" {
return e.Message
}
return "can't modify data in readonly mode"
}
// IsReadonlyError indicates that this error is of Readonly type
func (e *ReadonlyError) IsReadonlyError() bool {
return true
}
// OrigError returns original error (in this case this is the error itself)
func (e *ReadonlyError) OrigError() error {
return e
}
// IsReadonly detects if this error is of ReadonlyError
func IsReadonly(e error) bool {
type ro interface {
IsReadonlyError() bool
}
_, ok := e.(ro)
return ok
}
// AccessDenied returns new access denied error
func AccessDenied(message string) *AccessDeniedError {
return &AccessDeniedError{
Message: message,
}
}
// AccessDeniedError indicates denied access
type AccessDeniedError struct {
trace.Traces
Message string `json:"message"`
}
// Error is debug - friendly error message
func (e *AccessDeniedError) Error() string {
if e.Message != "" {
return e.Message
}
return "access denied"
}
// IsAccessDeniedError indicates that this error is of AccessDenied type
func (e *AccessDeniedError) IsAccessDeniedError() bool {
return true
}
// OrigError returns original error (in this case this is the error itself)
func (e *AccessDeniedError) OrigError() error {
return e
}
// IsAccessDenied detects if this error is of AccessDeniedError
func IsAccessDenied(e error) bool {
type ad interface {
IsAccessDeniedError() bool
}
_, ok := e.(ad)
return ok
}
// ConvertSystemError converts system error to appropriate teleport error
// if it is possible, otherwise, returns original error
func ConvertSystemError(err error) error {
innerError := err
if terr, ok := err.(trace.Error); ok {
innerError = terr.OrigError()
}
if os.IsNotExist(err) {
return NotFound(innerError.Error())
}
if os.IsPermission(err) {
return AccessDenied(innerError.Error())
}
switch realErr := innerError.(type) {
case *net.OpError:
return ConnectionProblem(
fmt.Sprintf("failed to connect to server %v", realErr.Addr), realErr)
case *os.PathError:
return AccessDenied(
fmt.Sprintf("failed to execute command %v error: %v", realErr.Path, realErr.Err))
default:
return err
}
}
// ConnectionProblem returns ConnectionProblem
func ConnectionProblem(message string, err error) *ConnectionProblemError {
return &ConnectionProblemError{
Message: message,
Err: err,
}
}
// ConnectionProblemError indicates any network error that has occured
type ConnectionProblemError struct {
trace.Traces
Message string `json:"message"`
Err error `json:"-"`
}
// Error is debug - friendly error message
func (c *ConnectionProblemError) Error() string {
return fmt.Sprintf("%v: %v", c.Message, c.Err)
}
// IsConnectionProblemError indicates that this error is of ConnectionProblem
func (c *ConnectionProblemError) IsConnectionProblemError() bool {
return true
}
// OrigError returns original error (in this case this is the error itself)
func (c *ConnectionProblemError) OrigError() error {
return c
}
// IsConnectionProblem detects if this error is of ConnectionProblemError
func IsConnectionProblem(e error) bool {
type ad interface {
IsConnectionProblemError() bool
}
_, ok := e.(ad)
return ok
}
// NewSystemError returns a new system error
func NewSystemError(code syscall.Errno, message string) *SystemError {
return &SystemError{
Message: message,
Code: code,
}
}
// SystemError is the error raised by Operating system
// usually contains error code returned by linux API
type SystemError struct {
trace.Traces `json:"traces"`
// Message is user-friendly error message
Message string `json:"message"`
Code syscall.Errno `json:"code"`
}
// Error returns log-friendly error description
func (s *SystemError) Error() string {
if s.Message != "" {
return s.Message
}
return fmt.Sprintf("system error, code: %v", s.Code.Error())
}
// IsSystemError indicates that this error is of system error kind
func (SystemError) IsSystemError() bool {
return true
}
// OrigError returns original error (in this case this is the error itself)
func (s *SystemError) OrigError() error {
return s
}
// IsSystemError returns if this is a system error
func IsSystemError(e error) bool {
type se interface {
IsSystemError() bool
}
_, ok := e.(se)
return ok
}
// LimitExceeded returns new limit exceeded error
func LimitExceeded(message string) *LimitExceededError {
return &LimitExceededError{
Message: message,
}
}
// LimitExceededError indicates rate limit or connection limit problem
type LimitExceededError struct {
trace.Traces
Message string `json:"message"`
}
// Error is debug - friendly error message
func (c *LimitExceededError) Error() string {
return c.Message
}
// IsLimitExceededError indicates that this error is of ConnectionProblem
func (c *LimitExceededError) IsLimitExceededError() bool {
return true
}
// OrigError returns original error (in this case this is the error itself)
func (c *LimitExceededError) OrigError() error {
return c
}
// IsLimitExceeded detects if this error is of LimitExceededError
func IsLimitExceeded(e error) bool {
type ad interface {
IsLimitExceededError() bool
}
_, ok := e.(ad)
return ok
}