zt/controller/internal/routes/edge_router_api_model.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 routes

import (
	"github.com/openziti/foundation/v2/util"
	"github.com/openziti/foundation/v2/versions"

	"strings"

	"github.com/go-openapi/strfmt"
	"github.com/michaelquigley/pfxlog"
	"github.com/openziti/edge-api/rest_model"
	"github.com/openziti/foundation/v2/stringz"
	"github.com/openziti/ziti/controller/env"
	"github.com/openziti/ziti/controller/model"
	"github.com/openziti/ziti/controller/models"
	"github.com/openziti/ziti/controller/response"
)

const (
	EntityNameEdgeRouter = "edge-routers"
)

var EdgeRouterLinkFactory = NewEdgeRouterLinkFactory()

type EdgeRouterLinkFactoryImpl struct {
	BasicLinkFactory
}

func NewEdgeRouterLinkFactory() *EdgeRouterLinkFactoryImpl {
	return &EdgeRouterLinkFactoryImpl{
		BasicLinkFactory: *NewBasicLinkFactory(EntityNameEdgeRouter),
	}
}

func (factory *EdgeRouterLinkFactoryImpl) Links(entity models.Entity) rest_model.Links {
	links := factory.BasicLinkFactory.Links(entity)
	links[EntityNameEdgeRouterPolicy] = factory.NewNestedLink(entity, EntityNameEdgeRouterPolicy)
	return links
}

func MapCreateEdgeRouterToModel(router *rest_model.EdgeRouterCreate) *model.EdgeRouter {
	ret := &model.EdgeRouter{
		BaseEntity: models.BaseEntity{
			Tags: TagsOrDefault(router.Tags),
		},
		Name:              stringz.OrEmpty(router.Name),
		RoleAttributes:    AttributesOrDefault(router.RoleAttributes),
		IsTunnelerEnabled: router.IsTunnelerEnabled,
		AppData:           TagsOrDefault(router.AppData),
		Cost:              uint16(Int64OrDefault(router.Cost)),
		NoTraversal:       BoolOrDefault(router.NoTraversal),
		Disabled:          BoolOrDefault(router.Disabled),
	}

	return ret
}

func MapUpdateEdgeRouterToModel(id string, router *rest_model.EdgeRouterUpdate) *model.EdgeRouter {
	ret := &model.EdgeRouter{
		BaseEntity: models.BaseEntity{
			Tags: TagsOrDefault(router.Tags),
			Id:   id,
		},
		Name:              stringz.OrEmpty(router.Name),
		RoleAttributes:    AttributesOrDefault(router.RoleAttributes),
		IsTunnelerEnabled: router.IsTunnelerEnabled,
		AppData:           TagsOrDefault(router.AppData),
		Cost:              uint16(Int64OrDefault(router.Cost)),
		NoTraversal:       BoolOrDefault(router.NoTraversal),
		Disabled:          BoolOrDefault(router.Disabled),
	}

	return ret
}

func MapPatchEdgeRouterToModel(id string, router *rest_model.EdgeRouterPatch) *model.EdgeRouter {
	ret := &model.EdgeRouter{
		BaseEntity: models.BaseEntity{
			Tags: TagsOrDefault(router.Tags),
			Id:   id,
		},
		Name:              stringz.OrEmpty(router.Name),
		RoleAttributes:    AttributesOrDefault(router.RoleAttributes),
		IsTunnelerEnabled: router.IsTunnelerEnabled,
		AppData:           TagsOrDefault(router.AppData),
		Cost:              uint16(Int64OrDefault(router.Cost)),
		NoTraversal:       BoolOrDefault(router.NoTraversal),
		Disabled:          BoolOrDefault(router.Disabled),
	}

	return ret
}

func MapEdgeRouterToRestEntity(ae *env.AppEnv, _ *response.RequestContext, router *model.EdgeRouter) (interface{}, error) {
	return MapEdgeRouterToRestModel(ae, router)
}

func MapVersionInfoToRestModel(versionInfo versions.VersionInfo) *rest_model.VersionInfo {
	ret := &rest_model.VersionInfo{
		Arch:      &versionInfo.Arch,
		BuildDate: &versionInfo.BuildDate,
		Os:        &versionInfo.OS,
		Revision:  &versionInfo.Revision,
		Version:   &versionInfo.Version,
	}

	return ret
}

func MapEdgeRouterToRestModel(ae *env.AppEnv, router *model.EdgeRouter) (*rest_model.EdgeRouterDetail, error) {
	routerState := ae.Broker.GetEdgeRouterState(router.Id)
	syncStatusStr := string(routerState.SyncStatus)

	roleAttributes := rest_model.Attributes(router.RoleAttributes)

	appData := rest_model.Tags{
		SubTags: router.AppData,
	}

	if appData.SubTags == nil {
		appData.SubTags = map[string]interface{}{}
	}

	cost := int64(router.Cost)
	ret := &rest_model.EdgeRouterDetail{
		BaseEntity: BaseEntityToRestModel(router, EdgeRouterLinkFactory),
		CommonEdgeRouterProperties: rest_model.CommonEdgeRouterProperties{
			Name:               &router.Name,
			IsOnline:           &routerState.IsOnline,
			Hostname:           &routerState.Hostname,
			SupportedProtocols: routerState.Protocols,
			SyncStatus:         &syncStatusStr,
			AppData:            &appData,
			Cost:               &cost,
			NoTraversal:        &router.NoTraversal,
			Disabled:           &router.Disabled,
		},
		RoleAttributes:        &roleAttributes,
		EnrollmentToken:       nil,
		EnrollmentCreatedAt:   nil,
		EnrollmentExpiresAt:   nil,
		EnrollmentJWT:         nil,
		IsVerified:            &router.IsVerified,
		Fingerprint:           stringz.OrEmpty(router.Fingerprint),
		VersionInfo:           MapVersionInfoToRestModel(routerState.VersionInfo),
		IsTunnelerEnabled:     &router.IsTunnelerEnabled,
		CertPem:               router.CertPem,
		UnverifiedFingerprint: router.UnverifiedFingerprint,
		UnverifiedCertPem:     router.UnverifiedCertPem,
	}

	for _, intf := range router.Interfaces {
		apiIntf := &rest_model.Interface{
			HardwareAddress: &intf.HardwareAddress,
			Index:           &intf.Index,
			IsBroadcast:     util.Ptr(intf.IsBroadcast()),
			IsLoopback:      util.Ptr(intf.IsLoopback()),
			IsMulticast:     util.Ptr(intf.IsMulticast()),
			IsRunning:       util.Ptr(intf.IsRunning()),
			IsUp:            util.Ptr(intf.IsUp()),
			Mtu:             &intf.MTU,
			Name:            &intf.Name,
			Addresses:       intf.Addresses,
		}
		ret.Interfaces = append(ret.Interfaces, apiIntf)
	}

	if !router.IsVerified {
		var enrollments []*model.Enrollment

		err := ae.GetManagers().EdgeRouter.CollectEnrollments(router.Id, func(entity *model.Enrollment) error {
			enrollments = append(enrollments, entity)
			return nil
		})

		if err != nil {
			return nil, err
		}

		if len(enrollments) > 0 {
			enrollment := enrollments[0]

			createdAt := strfmt.DateTime(enrollment.CreatedAt)
			expiresAt := strfmt.DateTime(*enrollment.ExpiresAt)

			ret.EnrollmentExpiresAt = &expiresAt
			ret.EnrollmentCreatedAt = &createdAt
			ret.EnrollmentJWT = &enrollment.Jwt
			ret.EnrollmentToken = &enrollment.Token
		}
	}

	return ret, nil
}

func GetNamedEdgeRouterRoles(edgeRouterHandler *model.EdgeRouterManager, roles []string) rest_model.NamedRoles {
	result := rest_model.NamedRoles{}
	for _, role := range roles {
		if strings.HasPrefix(role, "@") {

			edgeRouter, err := edgeRouterHandler.Read(role[1:])
			if err != nil {
				pfxlog.Logger().Errorf("error converting edgeRouter role [%s] to a named role: %v", role, err)
				continue
			}

			result = append(result, &rest_model.NamedRole{
				Role: role,
				Name: "@" + edgeRouter.Name,
			})
		} else {
			result = append(result, &rest_model.NamedRole{
				Role: role,
				Name: role,
			})
		}

	}
	return result
}