catch

package module

v1.0.0 Latest Latest Go to latest Published: Feb 13, 2024 License: MIT Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/covrom/catch

Links

Open Source Insights

README ¶

catch

some middlewares

Documentation ¶

Index ¶

func BytesToPrivateKey(priv []byte) (*rsa.PrivateKey, error)
func BytesToPublicKey(pub []byte) (*rsa.PublicKey, error)
func DecryptWithPrivateKey(ciphertext []byte, priv *rsa.PrivateKey) ([]byte, error)
func EncryptWithPublicKey(msg []byte, pub *rsa.PublicKey) ([]byte, error)
func GenerateKeyPair(bits int) (*rsa.PrivateKey, *rsa.PublicKey, error)
func GetLogEntry(r *http.Request) *slog.Logger
func GetRequestIdLogger(r *http.Request) *slog.Logger
func Identify() string
func LimitIPMiddleware(limiter *KeyRateLimiter) func(next http.Handler) http.Handler
func LogAllStatuses(r *http.Request)
func LogEntrySetAttrs(r *http.Request, attrs ...any)
func LogEntrySetField(r *http.Request, key string, value interface{})
func LogEntrySetFields(r *http.Request, fields map[string]interface{})
func LogHeaders(r *http.Request)
func NewStructuredLogger(handler slog.Handler, onlyErrs bool) func(next http.Handler) http.Handler
func PrivateKeyToBytes(priv *rsa.PrivateKey) []byte
func Protection(next http.Handler) http.Handler
func PublicKeyToBytes(pub *rsa.PublicKey) ([]byte, error)
func RealIPFromRequest(r *http.Request) string
func Recoverer(next http.Handler) http.Handler
func RequestForwardedHostProtoMiddleware(next http.Handler) http.Handler
func RequestHost(r *http.Request) (host string)
func RequestProto(r *http.Request) (proto string)
type ErrResponse
- func (e *ErrResponse) Error() string
- func (e *ErrResponse) Render(w http.ResponseWriter, r *http.Request) error
type KeyCountLimiter
- func NewKeyCountLimiter(b int) *KeyCountLimiter
- func (i *KeyCountLimiter) Allow(key, countKey string) bool
type KeyRateLimiter
- func NewKeyRateLimiter(r rate.Limit, b int) *KeyRateLimiter
- func (i *KeyRateLimiter) GetKeyLimiter(key string) *rate.Limiter
type StringLimiter
type StructuredLogger
- func (l *StructuredLogger) NewLogEntry(r *http.Request) middleware.LogEntry
type StructuredLoggerEntry
- func (l *StructuredLoggerEntry) Panic(v interface{}, stack []byte)
- func (l *StructuredLoggerEntry) Write(status, bytes int, header http.Header, elapsed time.Duration, ...)
type UniqueKeyLimiter

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GetLogEntry ¶

func GetLogEntry(r *http.Request) *slog.Logger

func GetRequestIdLogger ¶

func GetRequestIdLogger(r *http.Request) *slog.Logger

func Identify ¶

func Identify() string

Identify returns name of package, file name and line number of place where panic occurs

func LimitIPMiddleware ¶

func LimitIPMiddleware(limiter *KeyRateLimiter) func(next http.Handler) http.Handler

func LogAllStatuses ¶

func LogAllStatuses(r *http.Request)

func LogEntrySetAttrs ¶

func LogEntrySetAttrs(r *http.Request, attrs ...any)

func LogEntrySetField ¶

func LogEntrySetField(r *http.Request, key string, value interface{})

func LogEntrySetFields ¶

func LogEntrySetFields(r *http.Request, fields map[string]interface{})

func LogHeaders ¶

func LogHeaders(r *http.Request)

func NewStructuredLogger ¶

func NewStructuredLogger(handler slog.Handler, onlyErrs bool) func(next http.Handler) http.Handler

StructuredLogger is a simple, but powerful implementation of a custom structured logger backed on log/slog. I encourage users to copy it, adapt it and make it their own. Also take a look at https://github.com/go-chi/httplog for a dedicated pkg based on this work, designed for context-based http routers. Example: logger := slog.New(slog.NewJSONHandler(os.Stdout, nil)) slog.SetDefault(logger) hlog := NewStructuredLogger(slog.Default().Handler(), true)

func PrivateKeyToBytes ¶

func PrivateKeyToBytes(priv *rsa.PrivateKey) []byte

Convert private key to bytes (pem)

func Protection ¶

func Protection(next http.Handler) http.Handler

func PublicKeyToBytes ¶

func PublicKeyToBytes(pub *rsa.PublicKey) ([]byte, error)

Convert public key to bytes (pem)

func RealIPFromRequest ¶

func RealIPFromRequest(r *http.Request) string

func Recoverer ¶

func Recoverer(next http.Handler) http.Handler

func RequestForwardedHostProtoMiddleware ¶

func RequestForwardedHostProtoMiddleware(next http.Handler) http.Handler

func RequestHost ¶

func RequestHost(r *http.Request) (host string)

func RequestProto ¶

func RequestProto(r *http.Request) (proto string)

Types ¶

type ErrResponse ¶

type ErrResponse struct {
	Err            error `json:"-"` // low-level runtime error
	HTTPStatusCode int   `json:"-"` // http response status code

	StatusText string `json:"status"`          // user-level status message
	AppCode    int64  `json:"code,omitempty"`  // application-specific error code
	ErrorText  string `json:"error,omitempty"` // application-level error message, for debugging
}

func (*ErrResponse) Error ¶

func (e *ErrResponse) Error() string

func (*ErrResponse) Render ¶

func (e *ErrResponse) Render(w http.ResponseWriter, r *http.Request) error

type KeyCountLimiter ¶

type KeyCountLimiter struct {
	// contains filtered or unexported fields
}

func NewKeyCountLimiter ¶

func NewKeyCountLimiter(b int) *KeyCountLimiter

func (*KeyCountLimiter) Allow ¶

func (i *KeyCountLimiter) Allow(key, countKey string) bool

type KeyRateLimiter ¶

type KeyRateLimiter struct {
	// contains filtered or unexported fields
}

func NewKeyRateLimiter ¶

func NewKeyRateLimiter(r rate.Limit, b int) *KeyRateLimiter

func (*KeyRateLimiter) GetKeyLimiter ¶

func (i *KeyRateLimiter) GetKeyLimiter(key string) *rate.Limiter

type StringLimiter ¶

type StringLimiter struct {
	Key     string
	Limiter *rate.Limiter
}

type StructuredLogger ¶

type StructuredLogger struct {
	Logger     slog.Handler
	OnlyErrors bool
}

func (*StructuredLogger) NewLogEntry ¶

func (l *StructuredLogger) NewLogEntry(r *http.Request) middleware.LogEntry

type StructuredLoggerEntry ¶

type StructuredLoggerEntry struct {
	Ctx        context.Context
	OnlyErrors bool
	Logger     *slog.Logger
}

func (*StructuredLoggerEntry) Panic ¶

func (l *StructuredLoggerEntry) Panic(v interface{}, stack []byte)

func (*StructuredLoggerEntry) Write ¶

func (l *StructuredLoggerEntry) Write(status, bytes int, header http.Header, elapsed time.Duration, extra interface{})

type UniqueKeyLimiter ¶

type UniqueKeyLimiter struct {
	Key   string
	Count []string // unique keys for counting
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

README ¶

catch

Documentation ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

func BytesToPrivateKey ¶

func BytesToPublicKey ¶

func DecryptWithPrivateKey ¶

func EncryptWithPublicKey ¶

func GenerateKeyPair ¶

func GetLogEntry ¶

func GetRequestIdLogger ¶

func Identify ¶

func LimitIPMiddleware ¶

func LogAllStatuses ¶

func LogEntrySetAttrs ¶

func LogEntrySetField ¶

func LogEntrySetFields ¶

func LogHeaders ¶

func NewStructuredLogger ¶

func PrivateKeyToBytes ¶

func Protection ¶

func PublicKeyToBytes ¶

func RealIPFromRequest ¶

func Recoverer ¶

func RequestForwardedHostProtoMiddleware ¶

func RequestHost ¶

func RequestProto ¶

Types ¶

type ErrResponse ¶

func (*ErrResponse) Error ¶

func (*ErrResponse) Render ¶

type KeyCountLimiter ¶

func NewKeyCountLimiter ¶

func (*KeyCountLimiter) Allow ¶

type KeyRateLimiter ¶

func NewKeyRateLimiter ¶

func (*KeyRateLimiter) GetKeyLimiter ¶

type StringLimiter ¶

type StructuredLogger ¶

func (*StructuredLogger) NewLogEntry ¶

type StructuredLoggerEntry ¶

func (*StructuredLoggerEntry) Panic ¶

func (*StructuredLoggerEntry) Write ¶

type UniqueKeyLimiter ¶

Source Files ¶