sharedsec

Documentation

Index

• func ExecuteUserIDOperation(parent dyngo.Operation, args UserIDOperationArgs) error
• func MonitorUser(ctx context.Context, userID string) error
• type OnUserIDOperationStart
  • func (f OnUserIDOperationStart) Call(op dyngo.Operation, v interface{})
  • func (OnUserIDOperationStart) ListenedType() reflect.Type
• type UserIDOperation
• type UserIDOperationArgs
• type UserIDOperationRes
• type UserMonitoringError
  • func NewUserMonitoringError(msg string) *UserMonitoringError

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 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 UserIDOperation

type UserIDOperation struct {
	dyngo.Operation
	Error error
}

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.

type UserIDOperationRes

type UserIDOperationRes struct{}

UserIDOperationRes is the user ID operation results.

type UserMonitoringError

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

UserMonitoringError wraps an error interface to decorate it with additional appsec data, if needed

func NewUserMonitoringError

func NewUserMonitoringError(msg string) *UserMonitoringError

NewUserMonitoringError creates a new user monitoring error that returns `msg` upon calling `Error()`