/* 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 trace import ( "crypto/x509" "fmt" "io" "net" "net/url" "os" ) // NotFound returns new instance of not found error func NotFound(message string, args ...interface{}) error { return WrapWithMessage(&NotFoundError{ Message: fmt.Sprintf(message, args...), }, message, args...) } // NotFoundError indicates that object has not been found type NotFoundError struct { 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 is of NotFoundError type func IsNotFound(e error) bool { type nf interface { IsNotFoundError() bool } err := Unwrap(e) _, ok := err.(nf) if !ok { return os.IsNotExist(err) } return ok } // AlreadyExists returns a new instance of AlreadyExists error func AlreadyExists(message string, args ...interface{}) error { return WrapWithMessage(&AlreadyExistsError{ fmt.Sprintf(message, args...), }, message, args...) } // AlreadyExistsError indicates that there's a duplicate object that already // exists in the storage/system type AlreadyExistsError struct { Message string `json:"message"` } // Error returns log friendly description of an error func (n *AlreadyExistsError) Error() string { if n.Message != "" { return n.Message } return "object already exists" } // IsAlreadyExistsError indicates that this error of the AlreadyExistsError type 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 whether this is error indicating that object // already exists func IsAlreadyExists(e error) bool { type ae interface { IsAlreadyExistsError() bool } _, ok := Unwrap(e).(ae) return ok } // BadParameter returns a new instance of BadParameterError func BadParameter(message string, args ...interface{}) error { return WrapWithMessage(&BadParameterError{ Message: fmt.Sprintf(message, args...), }, message, args...) } // BadParameterError indicates that something is wrong with passed // parameter to API method type BadParameterError struct { Message string `json:"message"` } // Error returns log friendly description of an error func (b *BadParameterError) Error() string { return b.Message } // OrigError returns original error (in this case this is the error itself) func (b *BadParameterError) OrigError() error { return b } // IsBadParameterError indicates that this error is of BadParameterError type func (b *BadParameterError) IsBadParameterError() bool { return true } // IsBadParameter returns whether this error is of BadParameterType func IsBadParameter(e error) bool { type bp interface { IsBadParameterError() bool } _, ok := Unwrap(e).(bp) return ok } // CompareFailed returns new instance of CompareFailedError func CompareFailed(message string, args ...interface{}) error { return WrapWithMessage(&CompareFailedError{Message: fmt.Sprintf(message, args...)}, message, args...) } // CompareFailedError indicates a failed comparison (e.g. bad password or hash) type CompareFailedError struct { // 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 CompareFailedError func (e *CompareFailedError) IsCompareFailedError() bool { return true } // IsCompareFailed detects if this error is of CompareFailed type func IsCompareFailed(e error) bool { type cf interface { IsCompareFailedError() bool } _, ok := Unwrap(e).(cf) return ok } // AccessDenied returns new instance of AccessDeniedError func AccessDenied(message string, args ...interface{}) error { return WrapWithMessage(&AccessDeniedError{ Message: fmt.Sprintf(message, args...), }, message, args...) } // AccessDeniedError indicates denied access type AccessDeniedError struct { 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 AccessDeniedError 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 type func IsAccessDenied(e error) bool { type ad interface { IsAccessDeniedError() bool } _, ok := Unwrap(e).(ad) return ok } // ConvertSystemError converts system error to appropriate trace error // if it is possible, otherwise, returns original error func ConvertSystemError(err error) error { innerError := Unwrap(err) if os.IsExist(innerError) { return WrapWithMessage(&AlreadyExistsError{Message: innerError.Error()}, innerError.Error()) } if os.IsNotExist(innerError) { return WrapWithMessage(&NotFoundError{Message: innerError.Error()}, innerError.Error()) } if os.IsPermission(innerError) { return WrapWithMessage(&AccessDeniedError{Message: innerError.Error()}, innerError.Error()) } switch realErr := innerError.(type) { case *net.OpError: return WrapWithMessage(&ConnectionProblemError{ Message: realErr.Error(), Err: realErr}, realErr.Error()) case *os.PathError: message := fmt.Sprintf("failed to execute command %v error: %v", realErr.Path, realErr.Err) return WrapWithMessage(&AccessDeniedError{ Message: message, }, message) case x509.SystemRootsError, x509.UnknownAuthorityError: return wrapWithDepth(&TrustError{Err: innerError}, 2) } if _, ok := innerError.(net.Error); ok { return WrapWithMessage(&ConnectionProblemError{ Message: innerError.Error(), Err: innerError}, innerError.Error()) } return err } // ConnectionProblem returns new instance of ConnectionProblemError func ConnectionProblem(err error, message string, args ...interface{}) error { return WrapWithMessage(&ConnectionProblemError{ Message: fmt.Sprintf(message, args...), Err: err, }, message, args...) } // ConnectionProblemError indicates a network related problem type ConnectionProblemError struct { Message string `json:"message"` Err error `json:"-"` } // Error is debug - friendly error message func (c *ConnectionProblemError) Error() string { if c.Err == nil { return c.Message } return c.Err.Error() } // IsConnectionProblemError indicates that this error is of ConnectionProblemError type 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 returns whether this error is of ConnectionProblemError func IsConnectionProblem(e error) bool { type ad interface { IsConnectionProblemError() bool } _, ok := Unwrap(e).(ad) return ok } // LimitExceeded returns whether new instance of LimitExceededError func LimitExceeded(message string, args ...interface{}) error { return WrapWithMessage(&LimitExceededError{ Message: fmt.Sprintf(message, args...), }, message, args...) } // LimitExceededError indicates rate limit or connection limit problem type LimitExceededError struct { 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 := Unwrap(e).(ad) return ok } // TrustError indicates trust-related validation error (e.g. untrusted cert) type TrustError struct { // Err is original error Err error `json:"error"` Message string } // Error returns log-friendly error description func (t *TrustError) Error() string { return t.Err.Error() } // IsTrustError indicates that this error is of TrustError type func (*TrustError) IsTrustError() bool { return true } // OrigError returns original error (in this case this is the error itself) func (t *TrustError) OrigError() error { return t } // IsTrustError returns if this is a trust error func IsTrustError(e error) bool { type te interface { IsTrustError() bool } _, ok := Unwrap(e).(te) return ok } // OAuth2 returns new instance of OAuth2Error func OAuth2(code, message string, query url.Values) Error { return WrapWithMessage(&OAuth2Error{ Code: code, Message: message, Query: query, }, message) } // OAuth2Error defined an error used in OpenID Connect Flow (OIDC) type OAuth2Error struct { Code string `json:"code"` Message string `json:"message"` Query url.Values `json:"query"` } //Error returns log friendly description of an error func (o *OAuth2Error) Error() string { return fmt.Sprintf("OAuth2 error code=%v, message=%v", o.Code, o.Message) } // IsOAuth2Error returns whether this error of OAuth2Error type func (o *OAuth2Error) IsOAuth2Error() bool { return true } // IsOAuth2 returns if this is a OAuth2-related error func IsOAuth2(e error) bool { type oe interface { IsOAuth2Error() bool } _, ok := Unwrap(e).(oe) return ok } // IsEOF returns true if the passed error is io.EOF func IsEOF(e error) bool { return Unwrap(e) == io.EOF } // Retry return new instance of RetryError which indicates a transient error type func Retry(err error, message string, args ...interface{}) error { return WrapWithMessage(&RetryError{ Message: fmt.Sprintf(message, args...), Err: err, }, message, args...) } // RetryError indicates a transient error type type RetryError struct { Message string `json:"message"` Err error `json:"-"` } // Error is debug-friendly error message func (c *RetryError) Error() string { if c.Err == nil { return c.Message } return c.Err.Error() } // IsRetryError indicates that this error is of RetryError type func (c *RetryError) IsRetryError() bool { return true } // OrigError returns original error (in this case this is the error itself) func (c *RetryError) OrigError() error { return c } // IsRetryError returns whether this error is of ConnectionProblemError func IsRetryError(e error) bool { type ad interface { IsRetryError() bool } _, ok := Unwrap(e).(ad) return ok }