/* 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 ( "encoding/binary" "github.com/michaelquigley/pfxlog" "github.com/openziti/fabric/controller/xt" "github.com/openziti/fabric/controller/xtv" "github.com/openziti/foundation/storage/ast" "github.com/openziti/foundation/storage/boltz" "github.com/openziti/foundation/util/sequence" "go.etcd.io/bbolt" ) const ( EntityTypeTerminators = "terminators" FieldTerminatorService = "service" FieldTerminatorRouter = "router" FieldTerminatorBinding = "binding" FieldTerminatorAddress = "address" FieldTerminatorIdentity = "identity" FieldTerminatorIdentitySecret = "identitySecret" FieldTerminatorCost = "cost" FieldTerminatorPrecedence = "precedence" FieldServerPeerData = "peerData" ) type Terminator struct { boltz.BaseExtEntity Service string Router string Binding string Address string Identity string IdentitySecret []byte Cost uint16 Precedence string PeerData xt.PeerData } func (entity *Terminator) GetCost() uint16 { return entity.Cost } func (entity *Terminator) GetServiceId() string { return entity.Service } func (entity *Terminator) GetRouterId() string { return entity.Router } func (entity *Terminator) GetBinding() string { return entity.Binding } func (entity *Terminator) GetAddress() string { return entity.Address } func (entity *Terminator) GetIdentity() string { return entity.Identity } func (entity *Terminator) GetIdentitySecret() []byte { return entity.IdentitySecret } func (entity *Terminator) GetPeerData() xt.PeerData { return entity.PeerData } func (entity *Terminator) LoadValues(_ boltz.CrudStore, bucket *boltz.TypedBucket) { entity.LoadBaseValues(bucket) entity.Service = bucket.GetStringOrError(FieldTerminatorService) entity.Router = bucket.GetStringOrError(FieldTerminatorRouter) entity.Binding = bucket.GetStringOrError(FieldTerminatorBinding) entity.Address = bucket.GetStringWithDefault(FieldTerminatorAddress, "") entity.Identity = bucket.GetStringWithDefault(FieldTerminatorIdentity, "") entity.IdentitySecret = bucket.Get([]byte(FieldTerminatorIdentitySecret)) entity.Cost = uint16(bucket.GetInt32WithDefault(FieldTerminatorCost, 0)) entity.Precedence = bucket.GetStringWithDefault(FieldTerminatorPrecedence, xt.Precedences.Default.String()) data := bucket.GetBucket(FieldServerPeerData) if data != nil { entity.PeerData = make(map[uint32][]byte) iter := data.Cursor() for k, v := iter.First(); k != nil; k, v = iter.Next() { entity.PeerData[binary.LittleEndian.Uint32(k)] = v } } } func (entity *Terminator) SetValues(ctx *boltz.PersistContext) { entity.SetBaseValues(ctx) if entity.Precedence == "" { entity.Precedence = xt.Precedences.Default.String() } terminatorStore := ctx.Store.(*terminatorStoreImpl) if ctx.Bucket.HasError() { return } if ctx.IsCreate { // don't allow service, identity or secret to be changed ctx.SetRequiredString(FieldTerminatorService, entity.Service) ctx.SetString(FieldTerminatorIdentity, entity.Identity) if entity.IdentitySecret != nil { ctx.Bucket.PutValue([]byte(FieldTerminatorIdentitySecret), entity.IdentitySecret) } } ctx.SetRequiredString(FieldTerminatorRouter, entity.Router) ctx.SetRequiredString(FieldTerminatorBinding, entity.Binding) ctx.SetRequiredString(FieldTerminatorAddress, entity.Address) ctx.SetInt32(FieldTerminatorCost, int32(entity.Cost)) ctx.SetRequiredString(FieldTerminatorPrecedence, entity.Precedence) if ctx.ProceedWithSet(FieldServerPeerData) { _ = ctx.Bucket.DeleteBucket([]byte(FieldServerPeerData)) if entity.PeerData != nil { hostDataBucket := ctx.Bucket.GetOrCreateBucket(FieldServerPeerData) for k, v := range entity.PeerData { key := make([]byte, 4) binary.LittleEndian.PutUint32(key, k) hostDataBucket.PutValue(key, v) } } } if ctx.Bucket.HasError() { return } serviceId := ctx.Bucket.GetStringOrError(FieldTerminatorService) // service won't be passed in on change service, err := terminatorStore.stores.service.LoadOneById(ctx.Bucket.Tx(), serviceId) if err != nil || service == nil { ctx.Bucket.SetError(err) return } strategy, err := xt.GlobalRegistry().GetStrategy(service.TerminatorStrategy) ctx.Bucket.SetError(err) if ctx.Bucket.HasError() { return } var event xt.StrategyChangeEvent terminators, err := terminatorStore.stores.service.getTerminators(ctx.Bucket.Tx(), serviceId) ctx.Bucket.SetError(err) if ctx.IsCreate { event = xt.NewStrategyChangeEvent(entity.Id, terminators, xt.TList(entity), nil, nil) } else { event = xt.NewStrategyChangeEvent(entity.Id, terminators, nil, xt.TList(entity), nil) } ctx.Bucket.SetError(strategy.HandleTerminatorChange(event)) } func (entity *Terminator) GetEntityType() string { return EntityTypeTerminators } type TerminatorStore interface { boltz.CrudStore LoadOneById(tx *bbolt.Tx, id string) (*Terminator, error) GetTerminatorsInIdentityGroup(tx *bbolt.Tx, terminator xtv.Terminator, create bool) ([]*Terminator, error) } func newTerminatorStore(stores *stores) *terminatorStoreImpl { notFoundErrorFactory := func(id string) error { return boltz.NewNotFoundError(boltz.GetSingularEntityType(EntityTypeTerminators), "id", id) } store := &terminatorStoreImpl{ baseStore: baseStore{ stores: stores, BaseStore: boltz.NewBaseStore(EntityTypeTerminators, notFoundErrorFactory, boltz.RootBucket), }, sequence: sequence.NewSequence(), } store.InitImpl(store) return store } type terminatorStoreImpl struct { baseStore sequence *sequence.Sequence serviceSymbol boltz.EntitySymbol routerSymbol boltz.EntitySymbol } func (store *terminatorStoreImpl) NewStoreEntity() boltz.Entity { return &Terminator{} } func (store *terminatorStoreImpl) initializeLocal() { store.AddExtEntitySymbols() store.AddSymbol(FieldTerminatorBinding, ast.NodeTypeString) store.AddSymbol(FieldTerminatorAddress, ast.NodeTypeString) store.AddSymbol(FieldTerminatorIdentity, ast.NodeTypeString) store.serviceSymbol = store.AddFkSymbol(FieldTerminatorService, store.stores.service) store.routerSymbol = store.AddFkSymbol(FieldTerminatorRouter, store.stores.router) } func (store *terminatorStoreImpl) initializeLinked() { store.AddFkIndex(store.serviceSymbol, store.stores.service.terminatorsSymbol) store.AddFkIndex(store.routerSymbol, store.stores.router.terminatorsSymbol) } func (store *terminatorStoreImpl) LoadOneById(tx *bbolt.Tx, id string) (*Terminator, error) { entity := &Terminator{} if found, err := store.BaseLoadOneById(tx, id, entity); !found || err != nil { return nil, err } return entity, nil } func (store *terminatorStoreImpl) Create(ctx boltz.MutateContext, entity boltz.Entity) error { if entity.GetId() == "" { var err error id, err := store.sequence.NextHash() if err != nil { return err } entity.SetId(id) } if err := store.baseStore.Create(ctx, entity); err != nil { return err } return xtv.Validate(ctx.Tx(), entity.(*Terminator), true) } func (store *terminatorStoreImpl) Update(ctx boltz.MutateContext, entity boltz.Entity, checker boltz.FieldChecker) error { if err := store.baseStore.Update(ctx, entity, checker); err != nil { return err } // load from database, as entity used to persist may be incomplete or have out of sync data, for example when patching // or when fields become immutable after create terminator, err := store.LoadOneById(ctx.Tx(), entity.GetId()) if err != nil { return err } return xtv.Validate(ctx.Tx(), terminator, false) } func (store *terminatorStoreImpl) DeleteById(ctx boltz.MutateContext, id string) error { if terminator, err := store.LoadOneById(ctx.Tx(), id); terminator != nil { if service, err := store.stores.service.LoadOneById(ctx.Tx(), terminator.Service); service != nil { if strategy, err := xt.GlobalRegistry().GetStrategy(service.TerminatorStrategy); strategy != nil { if terminators, err := store.stores.service.getTerminators(ctx.Tx(), service.Id); err == nil { event := xt.NewStrategyChangeEvent(service.Id, terminators, nil, nil, xt.TList(terminator)) if err = strategy.HandleTerminatorChange(event); err != nil { return err } } else { pfxlog.Logger().Debugf("could not get terminators service %v for terminator %v while deleting terminator (%v)", terminator.Service, id, err) } } else { pfxlog.Logger().Debugf("could not find strategy %v on service %v for terminator %v while deleting terminator (%v)", service.TerminatorStrategy, terminator.Service, id, err) } } else { pfxlog.Logger().Debugf("could not find service %v for terminator %v while deleting (%v)", terminator.Service, id, err) } } else { pfxlog.Logger().Debugf("could not find terminator %v for delete (%v)", id, err) } return store.baseStore.DeleteById(ctx, id) } func (store *terminatorStoreImpl) GetTerminatorsInIdentityGroup(tx *bbolt.Tx, entity xtv.Terminator, create bool) ([]*Terminator, error) { serviceId := "" if create { // don't allow service to be changed serviceId = entity.GetServiceId() } else { terminator, err := store.LoadOneById(tx, entity.GetId()) if err != nil { return nil, err } serviceId = terminator.GetServiceId() } identity := entity.GetIdentity() terminatorIds := store.stores.service.GetRelatedEntitiesIdList(tx, serviceId, EntityTypeTerminators) var identityTerminators []*Terminator for _, terminatorId := range terminatorIds { if terminatorId != entity.GetId() { if terminator, _ := store.LoadOneById(tx, terminatorId); terminator != nil { if identity == terminator.Identity { identityTerminators = append(identityTerminators, terminator) } } } } return identityTerminators, nil }