sharedsec

Documentation

Index

• func ExecuteUserIDOperation(parent dyngo.Operation, args UserIDOperationArgs) error
• func MonitorUser(ctx context.Context, userID string) error
• type Action
  • func NewBlockAction(params map[string]any) []Action
  • func NewStackTraceAction(params map[string]any) Action
• type GRPCAction
  • func (a *GRPCAction) Blocking() bool
  • func (a *GRPCAction) EmitData(op dyngo.Operation)
• type GRPCWrapper
• type HTTPAction
  • func NewRedirectAction(params map[string]any) *HTTPAction
  • func (a *HTTPAction) Blocking() bool
  • func (a *HTTPAction) EmitData(op dyngo.Operation)
• type OnUserIDOperationStart
  • func (f OnUserIDOperationStart) Call(op dyngo.Operation, v interface{})
  • func (OnUserIDOperationStart) ListenedType() reflect.Type
• type StackTraceAction
  • func (a *StackTraceAction) Blocking() bool
  • func (a *StackTraceAction) EmitData(op dyngo.Operation)
• type UserIDOperation
• type UserIDOperationArgs
  • func (UserIDOperationArgs) IsArgOf(*UserIDOperation)
• type UserIDOperationRes
  • func (UserIDOperationRes) IsResultOf(*UserIDOperation)

Functions

func ExecuteUserIDOperation

func ExecuteUserIDOperation(parent dyngo.Operation, args UserIDOperationArgs) error

ExecuteUserIDOperation starts and finishes the UserID operation by emitting a dyngo start and finish events An error is returned if the user associated to that operation must be blocked

func MonitorUser

func MonitorUser(ctx context.Context, userID string) error

MonitorUser starts and finishes a UserID operation. A call to the WAF is made to check the user ID and an error is returned if the user should be blocked. The return value is nil otherwise.

Types

type Action

type Action interface {
	Blocking() bool
	EmitData(op dyngo.Operation)
}

Action is a generic interface that represents any WAF action

func NewBlockAction

func NewBlockAction(params map[string]any) []Action

NewBlockAction creates an action for the "block_request" action type

func NewStackTraceAction

func NewStackTraceAction(params map[string]any) Action

NewStackTraceAction creates an action for the "stacktrace" action type

type GRPCAction

type GRPCAction struct {
	GRPCWrapper
}

GRPCAction are actions that interact with a GRPC request flow

func (*GRPCAction) Blocking

func (a *GRPCAction) Blocking() bool

func (*GRPCAction) EmitData

func (a *GRPCAction) EmitData(op dyngo.Operation)

type GRPCWrapper

type GRPCWrapper func() (uint32, error)

GRPCWrapper is an opaque prototype abstraction for a gRPC handler (to avoid importing grpc) that returns a status code and an error TODO: rely on strongly typed actions (with the actual grpc types) by introducing WAF constructors

 living in the contrib packages, along with their dependencies - something like `appsec.RegisterWAFConstructor(newGRPCWAF)`
Such constructors would receive the full appsec config and rules, so that they would be able to build
specific blocking actions.

type HTTPAction

type HTTPAction struct {
	http.Handler
}

HTTPAction are actions that interact with an HTTP request flow (block, redirect...)

func NewRedirectAction

func NewRedirectAction(params map[string]any) *HTTPAction

NewRedirectAction creates an action for the "redirect_request" action type

func (*HTTPAction) Blocking

func (a *HTTPAction) Blocking() bool

func (*HTTPAction) EmitData

func (a *HTTPAction) EmitData(op dyngo.Operation)

type OnUserIDOperationStart

type OnUserIDOperationStart func(operation *UserIDOperation, args UserIDOperationArgs)

OnUserIDOperationStart function type, called when a user ID operation starts.

func (OnUserIDOperationStart) Call

func (f OnUserIDOperationStart) Call(op dyngo.Operation, v interface{})

Call the underlying event listener function by performing the type-assertion on v whose type is the one returned by ListenedType().

func (OnUserIDOperationStart) ListenedType

func (OnUserIDOperationStart) ListenedType() reflect.Type

ListenedType returns the type a OnUserIDOperationStart event listener listens to, which is the UserIDOperationStartArgs type.

type StackTraceAction

type StackTraceAction struct {
	Event stacktrace.Event
}

StackTraceAction are actions that generate a stacktrace

func (*StackTraceAction) Blocking

func (a *StackTraceAction) Blocking() bool

func (*StackTraceAction) EmitData

func (a *StackTraceAction) EmitData(op dyngo.Operation)

type UserIDOperation

type UserIDOperation struct {
	dyngo.Operation
}

UserIDOperation type representing a call to appsec.SetUser(). It gets both created and destroyed in a single call to ExecuteUserIDOperation

type UserIDOperationArgs

type UserIDOperationArgs struct {
	UserID string
}

UserIDOperationArgs is the user ID operation arguments.

func (UserIDOperationArgs) IsArgOf

func (UserIDOperationArgs) IsArgOf(*UserIDOperation)

type UserIDOperationRes

type UserIDOperationRes struct{}

UserIDOperationRes is the user ID operation results.

func (UserIDOperationRes) IsResultOf

func (UserIDOperationRes) IsResultOf(*UserIDOperation)