2 // ========================LICENSE_START=================================
5 // Copyright (C) 2022: Nordix Foundation
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
11 // http://www.apache.org/licenses/LICENSE-2.0
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===================================
21 package invokermanagement
30 "oransc.org/nonrtric/capifcore/internal/eventsapi"
31 publishapi "oransc.org/nonrtric/capifcore/internal/publishserviceapi"
33 "oransc.org/nonrtric/capifcore/internal/common29122"
34 invokerapi "oransc.org/nonrtric/capifcore/internal/invokermanagementapi"
36 "oransc.org/nonrtric/capifcore/internal/publishservice"
38 "github.com/labstack/echo/v4"
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
54 type InvokerManager struct {
55 onboardedInvokers map[string]invokerapi.APIInvokerEnrolmentDetails
56 publishRegister publishservice.PublishRegister
58 eventChannel chan<- eventsapi.EventNotification
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,
68 eventChannel: eventChannel,
72 func (im *InvokerManager) IsInvokerRegistered(invokerId string) bool {
74 defer im.lock.Unlock()
76 _, registered := im.onboardedInvokers[invokerId]
80 func (im *InvokerManager) VerifyInvokerSecret(invokerId, secret string) bool {
82 defer im.lock.Unlock()
85 if invoker, registered := im.onboardedInvokers[invokerId]; registered {
86 verified = *invoker.OnboardingInformation.OnboardingSecret == secret
91 func (im *InvokerManager) GetInvokerApiList(invokerId string) *invokerapi.APIList {
92 var apiList invokerapi.APIList = im.publishRegister.GetAllPublishedServices()
94 defer im.lock.Unlock()
95 invoker, ok := im.onboardedInvokers[invokerId]
97 invoker.ApiList = &apiList
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"))
111 if im.isInvokerOnboarded(newInvoker) {
112 return sendCoreError(ctx, http.StatusForbidden, fmt.Sprintf(errMsg, "invoker already onboarded"))
115 if err := im.validateInvoker(newInvoker, ctx); err != nil {
116 return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, err))
119 im.prepareNewInvoker(&newInvoker)
121 go im.sendEvent(*newInvoker.ApiInvokerId, eventsapi.CAPIFEventAPIINVOKERONBOARDED)
123 uri := ctx.Request().Host + ctx.Request().URL.String()
124 ctx.Response().Header().Set(echo.HeaderLocation, ctx.Scheme()+`://`+path.Join(uri, *newInvoker.ApiInvokerId))
125 err := ctx.JSON(http.StatusCreated, newInvoker)
127 // Something really bad happened, tell Echo that our handler failed
134 func (im *InvokerManager) isInvokerOnboarded(newInvoker invokerapi.APIInvokerEnrolmentDetails) bool {
135 for _, invoker := range im.onboardedInvokers {
136 if invoker.IsOnboarded(newInvoker) {
143 func (im *InvokerManager) prepareNewInvoker(newInvoker *invokerapi.APIInvokerEnrolmentDetails) {
144 var apiList invokerapi.APIList = im.publishRegister.GetAllPublishedServices()
145 newInvoker.ApiList = &apiList
148 defer im.lock.Unlock()
150 newInvoker.PrepareNewInvoker()
152 im.onboardedInvokers[*newInvoker.ApiInvokerId] = *newInvoker
155 // Deletes an individual API Invoker.
156 func (im *InvokerManager) DeleteOnboardedInvokersOnboardingId(ctx echo.Context, onboardingId string) error {
157 if _, ok := im.onboardedInvokers[onboardingId]; ok {
158 im.deleteInvoker(onboardingId)
161 go im.sendEvent(onboardingId, eventsapi.CAPIFEventAPIINVOKEROFFBOARDED)
163 return ctx.NoContent(http.StatusNoContent)
166 func (im *InvokerManager) deleteInvoker(onboardingId string) {
168 defer im.lock.Unlock()
169 delete(im.onboardedInvokers, onboardingId)
172 // Updates an individual API invoker details.
173 func (im *InvokerManager) PutOnboardedInvokersOnboardingId(ctx echo.Context, onboardingId string) error {
174 var invoker invokerapi.APIInvokerEnrolmentDetails
175 errMsg := "Unable to update invoker due to %s"
176 if err := ctx.Bind(&invoker); err != nil {
177 return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, "invalid format for invoker"))
180 if onboardingId != *invoker.ApiInvokerId {
181 return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, "ApiInvokerId not matching"))
184 if err := im.validateInvoker(invoker, ctx); err != nil {
185 return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, err))
188 if _, ok := im.onboardedInvokers[onboardingId]; ok {
189 im.updateInvoker(invoker)
191 return sendCoreError(ctx, http.StatusNotFound, "The invoker to update has not been onboarded")
194 err := ctx.JSON(http.StatusOK, invoker)
196 // Something really bad happened, tell Echo that our handler failed
203 func (im *InvokerManager) updateInvoker(invoker invokerapi.APIInvokerEnrolmentDetails) {
205 defer im.lock.Unlock()
206 im.onboardedInvokers[*invoker.ApiInvokerId] = invoker
209 func (im *InvokerManager) ModifyIndApiInvokeEnrolment(ctx echo.Context, onboardingId string) error {
210 return ctx.NoContent(http.StatusNotImplemented)
213 func (im *InvokerManager) validateInvoker(invoker invokerapi.APIInvokerEnrolmentDetails, ctx echo.Context) error {
214 if err := invoker.Validate(); err != nil {
217 if !im.areAPIsPublished(invoker.ApiList) {
218 return errors.New("some APIs needed by invoker are not registered")
224 func (im *InvokerManager) areAPIsPublished(apis *invokerapi.APIList) bool {
228 return im.publishRegister.AreAPIsPublished((*[]publishapi.ServiceAPIDescription)(apis))
231 func (im *InvokerManager) sendEvent(invokerId string, eventType eventsapi.CAPIFEvent) {
232 invokerIds := []string{invokerId}
233 event := eventsapi.EventNotification{
234 EventDetail: &eventsapi.CAPIFEventDetail{
235 ApiInvokerIds: &invokerIds,
239 im.eventChannel <- event
242 // This function wraps sending of an error in the Error format, and
243 // handling the failure to marshal that.
244 func sendCoreError(ctx echo.Context, code int, message string) error {
245 pd := common29122.ProblemDetails{
249 err := ctx.JSON(code, pd)