session

type AutoCleanUpAllowedFor func(context.Context, configuration.FlowName, Id) bool

type CloseableRepository interface {
	Repository
	io.Closer
}

type ConnectionInterceptor interface {
	io.Closer

	OnReadConnection(essh.Context, log.Logger, gonet.Conn) (time.Time, ConnectionInterceptorResult, error)
	OnWriteConnection(essh.Context, log.Logger, gonet.Conn) (time.Time, ConnectionInterceptorResult, error)
}

type ConnectionInterceptorResult uint8

type Consumer func(context.Context, Session) (canContinue bool, err error)

type EnvironmentCleanupTokenUpdater interface {
	UpdateEnvironmentTokenForCleanup(context.Context, []byte, []byte) error
}

type FacadeRepository struct {
	CloseableRepository
}

type FindDiagnostic struct {
	Flow configuration.FlowName
	Id   Id
	Path string
	Err  error
}

type FindDiagnosticConsumer func(context.Context, FindDiagnostic) error

type FindOpts struct {
	// Predicates are used to filter the returned sessions.
	Predicates Predicates

	// AutoCleanUpAllowed tells the repository to clean up everything
	// automatically while executing the search. The requester will never
	// see the requested result. This is false by default because it could
	// lead to quite performance impacts or other unwanted side effects.
	//
	// Therefore: Use with caution.
	AutoCleanUpAllowed *bool

	// AutoCleanUpAllowedFor optionally restricts AutoCleanUpAllowed for one
	// session entry. It cannot enable cleanup when AutoCleanUpAllowed is false.
	AutoCleanUpAllowedFor AutoCleanUpAllowedFor

	// Logger will be used (if any log is required) instead of the standard logger.
	Logger log.Logger

	// DiagnosticConsumer receives non-destructive per-entry diagnostics while
	// iterating all sessions. Without one, the first diagnostic remains fatal.
	DiagnosticConsumer FindDiagnosticConsumer
}

type FsRepository struct {
	Logger log.Logger
	// contains filtered or unexported fields
}

type Id uuid.UUID

type Info interface {
	Flow() configuration.FlowName
	Id() Id
	State() State
	Created(context.Context) (InfoCreated, error)
	LastAccessed(context.Context) (InfoLastAccessed, error)
	// ValidUntil defines until when the actual Session is valid to be used.
	// If returned time.Time.IsZero() means forever.
	ValidUntil(context.Context) (time.Time, error)
	String() string
}

type InfoCreated interface {
	At() time.Time
	Remote() net.Remote
}

type InfoLastAccessed interface {
	At() time.Time
	Remote() net.Remote
}

type Predicate func(context.Context, Session) (bool, error)

type Predicates []Predicate

type Repository interface {
	Create(ctx context.Context, flow configuration.FlowName, remote net.Remote, authToken []byte) (Session, error)

	FindBy(context.Context, configuration.FlowName, Id, *FindOpts) (Session, error)
	FindByPublicKey(context.Context, ssh.PublicKey, *FindOpts) (Session, error)
	FindByAccessToken(context.Context, []byte, *FindOpts) (Session, error)
	FindAll(context.Context, Consumer, *FindOpts) error

	DeleteBy(context.Context, configuration.FlowName, Id) error
	Delete(context.Context, Session) error
}

type RepositoryFactory[C any, R CloseableRepository] func(ctx context.Context, conf C) (R, error)

type Session interface {
	Flow() configuration.FlowName
	Id() Id
	Info(context.Context) (Info, error)
	AuthorizationToken(context.Context) ([]byte, error)
	EnvironmentToken(context.Context) ([]byte, error)
	HasPublicKey(context.Context, ssh.PublicKey) (bool, error)

	// ConnectionInterceptor creates a new instance of ConnectionInterceptor to
	// watch net.Conn of each connection related to this Session.
	//
	// It can return ErrMaxConnectionsPerSessionReached to indicate that no more
	// net.Conn are allowed for this Session.
	ConnectionInterceptor(context.Context) (ConnectionInterceptor, error)

	SetAuthorizationToken(context.Context, []byte) error
	SetEnvironmentToken(context.Context, []byte) error
	AddPublicKey(context.Context, ssh.PublicKey) error
	DeletePublicKey(context.Context, ssh.PublicKey) error
	NotifyLastAccess(ctx context.Context, remote net.Remote, newState State) (oldState State, err error)
	Dispose(ctx context.Context) (bool, error)

	String() string
}

type State uint8