ziti/controller/db/api_session_store.go

/*
	Copyright NetFoundry Inc.

	Licensed under the Apache License, Version 2.0 (the "License");
	you may not use this file except in compliance with the License.
	You may obtain a copy of the License at

	https://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License.
*/

package db

import (
	"strings"
	"time"

	"github.com/kataras/go-events"
	"github.com/michaelquigley/pfxlog"
	"github.com/openziti/ziti/v2/controller/storage/ast"
	"github.com/openziti/ziti/v2/controller/storage/boltz"
	"github.com/openziti/ziti/v2/common/eid"
	"github.com/openziti/ziti/v2/controller/change"
	"github.com/pkg/errors"
	log "github.com/sirupsen/logrus"
	"go.etcd.io/bbolt"
	bolterrors "go.etcd.io/bbolt/errors"
)

const (
	FieldApiSessionIdentity                = "identity"
	FieldApiSessionToken                   = "token"
	FieldApiSessionConfigTypes             = "configTypes"
	FieldApiSessionIPAddress               = "ipAddress"
	FieldApiSessionTotpComplete            = "mfaComplete" //"mfa" is a hold over from when TOTP was the only factor
	FieldApiSessionTotpRequired            = "mfaRequired"
	FieldApiSessionLastActivityAt          = "lastActivityAt"
	FieldApiSessionAuthenticator           = "authenticator"
	FieldApiSessionIsCertExtendable        = "isCertExtendable"
	FieldApiSessionImproperClientCertChain = "improperClientCertChain"

	EventFullyAuthenticated events.EventName = "FULLY_AUTHENTICATED"

	EventualEventApiSessionDelete = "ApiSessionDelete"
)

type ApiSession struct {
	boltz.BaseExtEntity
	IdentityId              string    `json:"identityId"`
	Token                   string    `json:"-"`
	IPAddress               string    `json:"ipAddress"`
	ConfigTypes             []string  `json:"configTypes"`
	TotpComplete            bool      `json:"mfaComplete"`
	TotpRequired            bool      `json:"mfaRequired"`
	LastActivityAt          time.Time `json:"lastActivityAt"`
	AuthenticatorId         string    `json:"authenticatorId"`
	IsCertExtendable        bool      `json:"isCertExtendable"`
	ImproperClientCertChain bool      `json:"improperClientCertChain"`
}

func NewApiSession(identityId string) *ApiSession {
	return &ApiSession{
		BaseExtEntity: boltz.BaseExtEntity{Id: eid.New()},
		IdentityId:    identityId,
		Token:         eid.New(),
	}
}

func (entity *ApiSession) GetEntityType() string {
	return EntityTypeApiSessions
}

var _ ApiSessionStore = (*apiSessionStoreImpl)(nil)

type ApiSessionStore interface {
	Store[*ApiSession]
	LoadOneByToken(tx *bbolt.Tx, token string) (*ApiSession, error)
	GetTokenIndex() boltz.ReadIndex
	GetCachedSessionId(tx *bbolt.Tx, apiSessionId, sessionType, serviceId string) *string
	GetEventsEmitter() events.EventEmmiter
}

func newApiSessionStore(stores *stores) *apiSessionStoreImpl {
	store := &apiSessionStoreImpl{
		eventsEmitter: events.New(),
	}
	store.baseStore = newBaseStore[*ApiSession](stores, store)
	stores.EventualEventer.AddEventualListener(EventualEventApiSessionDelete, store.onEventualDelete)
	store.InitImpl(store)
	store.AddEntityConstraint(store)
	return store
}

type apiSessionStoreImpl struct {
	*baseStore[*ApiSession]

	indexToken            boltz.ReadIndex
	symbolIdentity        boltz.EntitySymbol
	eventsEmitter         events.EventEmmiter
	apiSessionCertsSymbol boltz.EntitySetSymbol
}

func (store *apiSessionStoreImpl) NewEntity() *ApiSession {
	return &ApiSession{}
}

func (store *apiSessionStoreImpl) FillEntity(entity *ApiSession, bucket *boltz.TypedBucket) {
	entity.LoadBaseValues(bucket)
	entity.IdentityId = bucket.GetStringOrError(FieldApiSessionIdentity)
	entity.Token = bucket.GetStringOrError(FieldApiSessionToken)
	entity.ConfigTypes = bucket.GetStringList(FieldApiSessionConfigTypes)
	entity.IPAddress = bucket.GetStringWithDefault(FieldApiSessionIPAddress, "")
	entity.TotpComplete = bucket.GetBoolWithDefault(FieldApiSessionTotpComplete, false)
	entity.TotpRequired = bucket.GetBoolWithDefault(FieldApiSessionTotpRequired, false)
	entity.AuthenticatorId = bucket.GetStringWithDefault(FieldApiSessionAuthenticator, "")
	entity.IsCertExtendable = bucket.GetBoolWithDefault(FieldApiSessionIsCertExtendable, false)
	entity.ImproperClientCertChain = bucket.GetBoolWithDefault(FieldApiSessionImproperClientCertChain, false)
	lastActivityAt := bucket.GetTime(FieldApiSessionLastActivityAt) //not orError due to migration v18

	if lastActivityAt != nil {
		entity.LastActivityAt = *lastActivityAt
	}
}

func (store *apiSessionStoreImpl) PersistEntity(entity *ApiSession, ctx *boltz.PersistContext) {
	entity.SetBaseValues(ctx)
	ctx.SetString(FieldApiSessionIdentity, entity.IdentityId)
	ctx.SetString(FieldApiSessionToken, entity.Token)
	ctx.SetStringList(FieldApiSessionConfigTypes, entity.ConfigTypes)
	ctx.SetString(FieldApiSessionIPAddress, entity.IPAddress)
	ctx.SetBool(FieldApiSessionTotpComplete, entity.TotpComplete)
	ctx.SetBool(FieldApiSessionTotpRequired, entity.TotpRequired)
	ctx.SetString(FieldApiSessionAuthenticator, entity.AuthenticatorId)
	ctx.SetTimeP(FieldApiSessionLastActivityAt, &entity.LastActivityAt)
	ctx.SetBool(FieldApiSessionIsCertExtendable, entity.IsCertExtendable)
	ctx.SetBool(FieldApiSessionImproperClientCertChain, entity.ImproperClientCertChain)
}

func (store *apiSessionStoreImpl) GetEventsEmitter() events.EventEmmiter {
	return store.eventsEmitter
}

func (store *apiSessionStoreImpl) onEventualDelete(db boltz.Db, name string, apiSessionId []byte) {
	idCollector := &sessionIdCollector{}
	indexPath := []string{RootBucket, boltz.IndexesBucket, EntityTypeApiSessions, EntityTypeSessions}

	err := db.View(func(tx *bbolt.Tx) error {
		path := append(indexPath, string(apiSessionId))
		if bucket := boltz.Path(tx, path...); bucket != nil {
			boltz.Traverse(bucket.Bucket, "/"+strings.Join(path, "/"), idCollector)
		}
		return nil
	})

	if err != nil {
		pfxlog.Logger().WithError(err).WithFields(map[string]interface{}{
			"eventName":    name,
			"apiSessionId": string(apiSessionId),
		}).Error("error querying for session associated to an api session during onEventualDelete")
	}

	if store.stores.rateLimiter.GetQueueFillPct() > 0.5 {
		time.Sleep(time.Second)
	}

	store.cleanupSessions(db, name, apiSessionId, idCollector.ids)
}

func (store *apiSessionStoreImpl) cleanupSessions(db boltz.Db, name string, apiSessionId []byte, sessionIds []string) {
	logger := pfxlog.Logger().WithField("eventName", name).
		WithField("apiSessionId", string(apiSessionId))

	changeContext := change.New().SetSourceType("events.emitter").SetChangeAuthorType(change.AuthorTypeController)
	err := db.Update(changeContext.NewMutateContext(), func(ctx boltz.MutateContext) error {
		indexPath := []string{RootBucket, boltz.IndexesBucket, EntityTypeApiSessions, EntityTypeSessions}
		if bucket := boltz.Path(ctx.Tx(), indexPath...); bucket != nil {
			if err := bucket.DeleteBucket(apiSessionId); err != nil {
				if !errors.Is(err, bolterrors.ErrBucketNotFound) {
					logger.WithError(err).
						Error("error deleting for api session index associated to an api session during onEventualDelete")
				}
			}
		}

		for _, id := range sessionIds {
			if err := store.stores.session.DeleteById(ctx, id); err != nil {
				if !boltz.IsErrNotFoundErr(err) {
					logger.WithError(err).WithField("sessionId", id).
						Error("error deleting for session associated to an api session during onEventualDelete")
				}
			}
		}

		return nil
	})

	if err != nil {
		log.WithError(err).Error("error while cleanup after api-session delete")
	}
}

func (store *apiSessionStoreImpl) Create(ctx boltz.MutateContext, entity *ApiSession) error {
	err := store.baseStore.Create(ctx, entity)

	if err == nil {
		if !entity.TotpRequired || entity.TotpComplete {
			ctx.AddCommitAction(func() {
				store.eventsEmitter.Emit(EventFullyAuthenticated, entity)
			})
		}

	}

	return err
}
func (store *apiSessionStoreImpl) Update(ctx boltz.MutateContext, entity *ApiSession, checker boltz.FieldChecker) error {
	err := store.baseStore.Update(ctx, entity, checker)

	if err == nil {
		if (checker == nil || checker.IsUpdated(FieldApiSessionTotpComplete)) && entity.TotpComplete {
			ctx.AddCommitAction(func() {
				store.eventsEmitter.Emit(EventFullyAuthenticated, entity)
			})
		}
	}

	return err
}

func (store *apiSessionStoreImpl) ProcessPreCommit(state *boltz.EntityChangeState[*ApiSession]) error {
	if state.ChangeType == boltz.EntityDeleted {
		return store.handleDeleteCleanup(state.Ctx, state.EntityId)
	}
	return nil
}

func (store *apiSessionStoreImpl) ProcessPostCommit(_ *boltz.EntityChangeState[*ApiSession]) {
	/* does nothing */
}

func (store *apiSessionStoreImpl) handleDeleteCleanup(ctx boltz.MutateContext, id string) error {
	for _, apiSessionCertId := range store.GetRelatedEntitiesIdList(ctx.Tx(), id, EntityTypeApiSessionCertificates) {
		if err := store.stores.apiSessionCertificate.DeleteById(ctx, apiSessionCertId); err != nil {
			return err
		}
	}

	if bboltEventualEventer, ok := store.baseStore.stores.EventualEventer.(*EventualEventerBbolt); ok {
		if err := bboltEventualEventer.AddEventualEventWithCtx(ctx, EventualEventApiSessionDelete, []byte(id)); err != nil {
			return err
		}
	} else {
		store.baseStore.stores.EventualEventer.AddEventualEvent(EventualEventApiSessionDelete, []byte(id))
	}

	return nil
}

func (store *apiSessionStoreImpl) GetTokenIndex() boltz.ReadIndex {
	return store.indexToken
}

func (store *apiSessionStoreImpl) initializeLocal() {
	store.AddExtEntitySymbols()
	symbolToken := store.AddSymbol(FieldApiSessionToken, ast.NodeTypeString)
	store.indexToken = store.AddUniqueIndex(symbolToken)
	store.symbolIdentity = store.AddFkSymbol(FieldApiSessionIdentity, store.stores.identity)
	store.AddSymbol(FieldApiSessionLastActivityAt, ast.NodeTypeDatetime)
	store.AddSymbol(FieldApiSessionAuthenticator, ast.NodeTypeString)
	store.AddSymbol(FieldApiSessionIdentity, ast.NodeTypeString)
	store.AddSymbol(FieldApiSessionIPAddress, ast.NodeTypeString)
	store.AddSymbol(FieldApiSessionTotpComplete, ast.NodeTypeBool)
	store.AddSymbol(FieldApiSessionTotpRequired, ast.NodeTypeBool)
	store.AddSymbol(FieldApiSessionImproperClientCertChain, ast.NodeTypeBool)

	store.AddFkConstraint(store.symbolIdentity, false, boltz.CascadeDelete)
	store.apiSessionCertsSymbol = store.AddFkSetSymbol(EntityTypeApiSessionCertificates, store.stores.apiSessionCertificate)
}

func (store *apiSessionStoreImpl) initializeLinked() {
}

func (store *apiSessionStoreImpl) LoadOneByToken(tx *bbolt.Tx, token string) (*ApiSession, error) {
	id := store.indexToken.Read(tx, []byte(token))
	if id != nil {
		return store.LoadById(tx, string(id))
	}
	return nil, boltz.NewNotFoundError(store.GetSingularEntityType(), "token", token)
}

func (store *apiSessionStoreImpl) GetCachedSessionId(tx *bbolt.Tx, apiSessionId, sessionType, serviceId string) *string {
	bucket := boltz.Path(tx,
		RootBucket, boltz.IndexesBucket,
		EntityTypeApiSessions, EntityTypeSessions,
		apiSessionId, sessionType,
	)

	if bucket != nil {
		return bucket.GetString(serviceId)
	}

	return nil
}

type UpdateLastActivityAtChecker struct{}

func (u UpdateLastActivityAtChecker) IsUpdated(field string) bool {
	return field == FieldApiSessionLastActivityAt
}

type sessionIdCollector struct {
	ids []string
}

func (self *sessionIdCollector) VisitBucket(string, []byte, *bbolt.Bucket) bool {
	return true
}

func (self *sessionIdCollector) VisitKeyValue(_ string, _, value []byte) bool {
	if sessionId := boltz.FieldToString(boltz.GetTypeAndValue(value)); sessionId != nil {
		self.ids = append(self.ids, *sessionId)
	}
	return true
}