usersec

Documentation

Index

• type UserEventType
• type UserLoginOperation
  • func StartUserLoginOperation(ctx context.Context, eventType UserEventType, args UserLoginOperationArgs) (*UserLoginOperation, *error)
  • func (op *UserLoginOperation) Finish(args UserLoginOperationRes)
• type UserLoginOperationArgs
  • func (UserLoginOperationArgs) IsArgOf(*UserLoginOperation)
• type UserLoginOperationRes
  • func (UserLoginOperationRes) IsResultOf(*UserLoginOperation)

Types

type UserEventType

type UserEventType int

UserEventType is the type of user event, such as a successful login or a failed login or any other authenticated request.

const (
	// UserLoginSuccess is the event type for a successful user login, when a new session or JWT is created.
	UserLoginSuccess UserEventType = iota
	// UserLoginFailure is the event type for a failed user login, when the user ID is not found or the password is incorrect.
	UserLoginFailure
	// UserSet is the event type for a user ID operation that is not a login, such as any authenticated request made by the user.
	UserSet
)

type UserLoginOperation

type UserLoginOperation struct {
	dyngo.Operation
	EventType UserEventType
}

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

func StartUserLoginOperation

func StartUserLoginOperation(ctx context.Context, eventType UserEventType, args UserLoginOperationArgs) (*UserLoginOperation, *error)

func (*UserLoginOperation) Finish

func (op *UserLoginOperation) Finish(args UserLoginOperationRes)

type UserLoginOperationArgs

type UserLoginOperationArgs struct {
}

UserLoginOperationArgs is the user ID operation arguments.

func (UserLoginOperationArgs) IsArgOf

func (UserLoginOperationArgs) IsArgOf(*UserLoginOperation)

type UserLoginOperationRes

type UserLoginOperationRes struct {
	UserID    string
	SessionID string
}

UserLoginOperationRes is the user ID operation results.

func (UserLoginOperationRes) IsResultOf

func (UserLoginOperationRes) IsResultOf(*UserLoginOperation)