capifcore/internal/invokermanagement/invokermanagement.go

   1 // -
   2 //   ========================LICENSE_START=================================
   3 //   O-RAN-SC
   4 //   %%
   5 //   Copyright (C) 2022: Nordix Foundation
   6 //   %%
   7 //   Licensed under the Apache License, Version 2.0 (the "License");
   8 //   you may not use this file except in compliance with the License.
   9 //   You may obtain a copy of the License at
  10 //
  11 //        http://www.apache.org/licenses/LICENSE-2.0
  12 //
  13 //   Unless required by applicable law or agreed to in writing, software
  14 //   distributed under the License is distributed on an "AS IS" BASIS,
  15 //   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 //   See the License for the specific language governing permissions and
  17 //   limitations under the License.
  18 //   ========================LICENSE_END===================================
  19 //
  20
  21 package invokermanagement
  22
  23 import (
  24         "errors"
  25         "fmt"
  26         "net/http"
  27         "path"
  28         "sync"
  29
  30         "oransc.org/nonrtric/capifcore/internal/eventsapi"
  31         publishapi "oransc.org/nonrtric/capifcore/internal/publishserviceapi"
  32
  33         "oransc.org/nonrtric/capifcore/internal/common29122"
  34         invokerapi "oransc.org/nonrtric/capifcore/internal/invokermanagementapi"
  35
  36         "oransc.org/nonrtric/capifcore/internal/publishservice"
  37
  38         "github.com/labstack/echo/v4"
  39 )
  40
  41 //go:generate mockery --name InvokerRegister
  42 type InvokerRegister interface {
  43         // Checks if the invoker is registered.
  44         // Returns true of the provided invoker is registered, false otherwise.
  45         IsInvokerRegistered(invokerId string) bool
  46         // Verifies that the provided secret is the invoker's registered secret.
  47         // Returns true if the provided secret is the registered invoker's secret, false otherwise.
  48         VerifyInvokerSecret(invokerId, secret string) bool
  49         // Gets the provided invoker's registered APIs.
  50         // Returns a list of all the invoker's registered APIs.
  51         GetInvokerApiList(invokerId string) *invokerapi.APIList
  52 }
  53
  54 type InvokerManager struct {
  55         onboardedInvokers map[string]invokerapi.APIInvokerEnrolmentDetails
  56         publishRegister   publishservice.PublishRegister
  57         nextId            int64
  58         eventChannel      chan<- eventsapi.EventNotification
  59         lock              sync.Mutex
  60 }
  61
  62 // Creates a manager that implements both the InvokerRegister and the invokermanagementapi.ServerInterface interfaces.
  63 func NewInvokerManager(publishRegister publishservice.PublishRegister, eventChannel chan<- eventsapi.EventNotification) *InvokerManager {
  64         return &InvokerManager{
  65                 onboardedInvokers: make(map[string]invokerapi.APIInvokerEnrolmentDetails),
  66                 publishRegister:   publishRegister,
  67                 nextId:            1000,
  68                 eventChannel:      eventChannel,
  69         }
  70 }
  71
  72 func (im *InvokerManager) IsInvokerRegistered(invokerId string) bool {
  73         im.lock.Lock()
  74         defer im.lock.Unlock()
  75
  76         _, registered := im.onboardedInvokers[invokerId]
  77         return registered
  78 }
  79
  80 func (im *InvokerManager) VerifyInvokerSecret(invokerId, secret string) bool {
  81         im.lock.Lock()
  82         defer im.lock.Unlock()
  83
  84         verified := false
  85         if invoker, registered := im.onboardedInvokers[invokerId]; registered {
  86                 verified = *invoker.OnboardingInformation.OnboardingSecret == secret
  87         }
  88         return verified
  89 }
  90
  91 func (im *InvokerManager) GetInvokerApiList(invokerId string) *invokerapi.APIList {
  92         var apiList invokerapi.APIList = im.publishRegister.GetAllPublishedServices()
  93         im.lock.Lock()
  94         defer im.lock.Unlock()
  95         invoker, ok := im.onboardedInvokers[invokerId]
  96         if ok {
  97                 invoker.ApiList = &apiList
  98                 return &apiList
  99         }
 100         return nil
 101 }
 102
 103 // Creates a new individual API Invoker profile.
 104 func (im *InvokerManager) PostOnboardedInvokers(ctx echo.Context) error {
 105         var newInvoker invokerapi.APIInvokerEnrolmentDetails
 106         errMsg := "Unable to onboard invoker due to %s"
 107         if err := ctx.Bind(&newInvoker); err != nil {
 108                 return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, "invalid format for invoker"))
 109         }
 110
 111         if err := im.validateInvoker(newInvoker, ctx); err != nil {
 112                 return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, err))
 113         }
 114
 115         im.prepareNewInvoker(&newInvoker)
 116
 117         go im.sendEvent(*newInvoker.ApiInvokerId, eventsapi.CAPIFEventAPIINVOKERONBOARDED)
 118
 119         uri := ctx.Request().Host + ctx.Request().URL.String()
 120         ctx.Response().Header().Set(echo.HeaderLocation, ctx.Scheme()+`://`+path.Join(uri, *newInvoker.ApiInvokerId))
 121         err := ctx.JSON(http.StatusCreated, newInvoker)
 122         if err != nil {
 123                 // Something really bad happened, tell Echo that our handler failed
 124                 return err
 125         }
 126
 127         return nil
 128 }
 129
 130 func (im *InvokerManager) prepareNewInvoker(newInvoker *invokerapi.APIInvokerEnrolmentDetails) {
 131         var apiList invokerapi.APIList = im.publishRegister.GetAllPublishedServices()
 132         newInvoker.ApiList = &apiList
 133
 134         im.lock.Lock()
 135         defer im.lock.Unlock()
 136
 137         newInvoker.PrepareNewInvoker()
 138
 139         im.onboardedInvokers[*newInvoker.ApiInvokerId] = *newInvoker
 140 }
 141
 142 // Deletes an individual API Invoker.
 143 func (im *InvokerManager) DeleteOnboardedInvokersOnboardingId(ctx echo.Context, onboardingId string) error {
 144         if _, ok := im.onboardedInvokers[onboardingId]; ok {
 145                 im.deleteInvoker(onboardingId)
 146         }
 147
 148         go im.sendEvent(onboardingId, eventsapi.CAPIFEventAPIINVOKEROFFBOARDED)
 149
 150         return ctx.NoContent(http.StatusNoContent)
 151 }
 152
 153 func (im *InvokerManager) deleteInvoker(onboardingId string) {
 154         im.lock.Lock()
 155         defer im.lock.Unlock()
 156         delete(im.onboardedInvokers, onboardingId)
 157 }
 158
 159 // Updates an individual API invoker details.
 160 func (im *InvokerManager) PutOnboardedInvokersOnboardingId(ctx echo.Context, onboardingId string) error {
 161         var invoker invokerapi.APIInvokerEnrolmentDetails
 162         errMsg := "Unable to update invoker due to %s"
 163         if err := ctx.Bind(&invoker); err != nil {
 164                 return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, "invalid format for invoker"))
 165         }
 166
 167         if onboardingId != *invoker.ApiInvokerId {
 168                 return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, "ApiInvokerId not matching"))
 169         }
 170
 171         if err := im.validateInvoker(invoker, ctx); err != nil {
 172                 return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, err))
 173         }
 174
 175         if _, ok := im.onboardedInvokers[onboardingId]; ok {
 176                 im.updateInvoker(invoker)
 177         } else {
 178                 return sendCoreError(ctx, http.StatusNotFound, "The invoker to update has not been onboarded")
 179         }
 180
 181         err := ctx.JSON(http.StatusOK, invoker)
 182         if err != nil {
 183                 // Something really bad happened, tell Echo that our handler failed
 184                 return err
 185         }
 186
 187         return nil
 188 }
 189
 190 func (im *InvokerManager) updateInvoker(invoker invokerapi.APIInvokerEnrolmentDetails) {
 191         im.lock.Lock()
 192         defer im.lock.Unlock()
 193         im.onboardedInvokers[*invoker.ApiInvokerId] = invoker
 194 }
 195
 196 func (im *InvokerManager) ModifyIndApiInvokeEnrolment(ctx echo.Context, onboardingId string) error {
 197         return ctx.NoContent(http.StatusNotImplemented)
 198 }
 199
 200 func (im *InvokerManager) validateInvoker(invoker invokerapi.APIInvokerEnrolmentDetails, ctx echo.Context) error {
 201         if err := invoker.Validate(); err != nil {
 202                 return err
 203         }
 204         if !im.areAPIsPublished(invoker.ApiList) {
 205                 return errors.New("some APIs needed by invoker are not registered")
 206         }
 207
 208         return nil
 209 }
 210
 211 func (im *InvokerManager) areAPIsPublished(apis *invokerapi.APIList) bool {
 212         if apis == nil {
 213                 return true
 214         }
 215         return im.publishRegister.AreAPIsPublished((*[]publishapi.ServiceAPIDescription)(apis))
 216 }
 217
 218 func (im *InvokerManager) sendEvent(invokerId string, eventType eventsapi.CAPIFEvent) {
 219         invokerIds := []string{invokerId}
 220         event := eventsapi.EventNotification{
 221                 EventDetail: &eventsapi.CAPIFEventDetail{
 222                         ApiInvokerIds: &invokerIds,
 223                 },
 224                 Events: eventType,
 225         }
 226         im.eventChannel <- event
 227 }
 228
 229 // This function wraps sending of an error in the Error format, and
 230 // handling the failure to marshal that.
 231 func sendCoreError(ctx echo.Context, code int, message string) error {
 232         pd := common29122.ProblemDetails{
 233                 Cause:  &message,
 234                 Status: &code,
 235         }
 236         err := ctx.JSON(code, pd)
 237         return err
 238 }