forked from wso2/api-platform
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathbuilder.go
More file actions
256 lines (230 loc) · 10.5 KB
/
builder.go
File metadata and controls
256 lines (230 loc) · 10.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
/*
* Copyright (c) 2026, WSO2 LLC. (https://www.wso2.com).
*
* WSO2 LLC. licenses this file to you 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
*
* http://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 policy
import (
"log/slog"
"strings"
"time"
versionutil "github.com/wso2/api-platform/common/version"
api "github.com/wso2/api-platform/gateway/gateway-controller/pkg/api/management"
"github.com/wso2/api-platform/gateway/gateway-controller/pkg/config"
"github.com/wso2/api-platform/gateway/gateway-controller/pkg/models"
"github.com/wso2/api-platform/gateway/gateway-controller/pkg/utils"
"github.com/wso2/api-platform/gateway/gateway-controller/pkg/xds"
policyv1alpha "github.com/wso2/api-platform/sdk/core/policy/v1alpha2"
policyenginev1 "github.com/wso2/api-platform/sdk/core/policyengine"
)
// DerivePolicyFromAPIConfig derives a policy configuration from an API stored config.
// Handles both RestApi and WebSubApi kinds. This is a shared utility used by:
// - APIDeploymentService (WebSocket event path)
// - APIServer handlers (REST API path) - TODO: Refactor this to use the implementation
// - main.go startup (loading existing configs)
//
// Policy execution order: System Policies -> API Level Policies -> Operation Level Policies
// Each level does not override the previous one; policies are executed in the given order.
func DerivePolicyFromAPIConfig(cfg *models.StoredConfig, routerConfig *config.RouterConfig, systemConfig *config.Config, policyDefinitions map[string]models.PolicyDefinition) *models.StoredPolicyConfig {
// Pre-compute latest version index once for all ResolvePolicyVersion calls in this function.
latestVersions := config.BuildLatestVersionIndex(policyDefinitions)
// Collect API-level policies (validate policy version exists, pass major-only to engine)
apiPolicies := make(map[string]policyenginev1.PolicyInstance)
if cfg.GetPolicies() != nil {
for _, p := range *cfg.GetPolicies() {
resolved, err := config.ResolvePolicyVersion(policyDefinitions, latestVersions, p.Name, p.Version)
if err != nil {
slog.Error("Failed to resolve policy version for API-level policy", "policy_name", p.Name, "error", err)
continue
}
apiPolicies[p.Name] = ConvertAPIPolicyToModel(p, policyv1alpha.LevelAPI, versionutil.MajorVersion(resolved))
}
}
routes := make([]policyenginev1.PolicyChain, 0)
switch cfgTyped := cfg.Configuration.(type) {
case api.WebSubAPI:
apiData := cfgTyped.Spec
var channels map[string]api.WebSubChannel
if apiData.Channels != nil {
channels = *apiData.Channels
}
for chName, ch := range channels {
var finalPolicies []policyenginev1.PolicyInstance
// Policy execution order: allChannels (on_subscription) -> per-channel policies
// Start with API-level subscription policies
if apiData.AllChannels != nil && apiData.AllChannels.OnSubscription != nil && apiData.AllChannels.OnSubscription.Policies != nil {
finalPolicies = make([]policyenginev1.PolicyInstance, 0, len(*apiData.AllChannels.OnSubscription.Policies))
for _, p := range *apiData.AllChannels.OnSubscription.Policies {
resolved, err := config.ResolvePolicyVersion(policyDefinitions, latestVersions, p.Name, p.Version)
if err != nil {
slog.Error("Failed to resolve policy version for all-channel subscription policy", "policy_name", p.Name, "error", err)
continue
}
finalPolicies = append(finalPolicies, ConvertAPIPolicyToModel(p, policyv1alpha.LevelAPI, versionutil.MajorVersion(resolved)))
}
}
// Append channel-level on_subscription policies
if ch.OnSubscription != nil && ch.OnSubscription.Policies != nil && len(*ch.OnSubscription.Policies) > 0 {
for _, opPolicy := range *ch.OnSubscription.Policies {
resolved, err := config.ResolvePolicyVersion(policyDefinitions, latestVersions, opPolicy.Name, opPolicy.Version)
if err != nil {
slog.Error("Failed to resolve policy version for channel-level policy", "policy_name", opPolicy.Name, "channel_name", chName, "error", err)
continue
}
finalPolicies = append(finalPolicies, ConvertAPIPolicyToModel(opPolicy, policyv1alpha.LevelRoute, versionutil.MajorVersion(resolved)))
}
}
routeKey := xds.GenerateRouteName("SUB", apiData.Context, apiData.Version, chName, routerConfig.GatewayHost)
props := make(map[string]any)
injectedPolicies := utils.InjectSystemPolicies(finalPolicies, systemConfig, props)
routes = append(routes, policyenginev1.PolicyChain{
RouteKey: routeKey,
Policies: injectedPolicies,
})
// Build UNSUB (unsubscription) policy chain for this channel
var unsubPolicies []policyenginev1.PolicyInstance
if apiData.AllChannels != nil && apiData.AllChannels.OnUnsubscription != nil && apiData.AllChannels.OnUnsubscription.Policies != nil {
unsubPolicies = make([]policyenginev1.PolicyInstance, 0, len(*apiData.AllChannels.OnUnsubscription.Policies))
for _, p := range *apiData.AllChannels.OnUnsubscription.Policies {
resolved, err := config.ResolvePolicyVersion(policyDefinitions, latestVersions, p.Name, p.Version)
if err != nil {
slog.Error("Failed to resolve policy version for all-channel unsubscription policy", "policy_name", p.Name, "error", err)
continue
}
unsubPolicies = append(unsubPolicies, ConvertAPIPolicyToModel(p, policyv1alpha.LevelAPI, versionutil.MajorVersion(resolved)))
}
}
if ch.OnUnsubscription != nil && ch.OnUnsubscription.Policies != nil && len(*ch.OnUnsubscription.Policies) > 0 {
for _, opPolicy := range *ch.OnUnsubscription.Policies {
resolved, err := config.ResolvePolicyVersion(policyDefinitions, latestVersions, opPolicy.Name, opPolicy.Version)
if err != nil {
slog.Error("Failed to resolve policy version for channel-level unsubscription policy", "policy_name", opPolicy.Name, "channel_name", chName, "error", err)
continue
}
unsubPolicies = append(unsubPolicies, ConvertAPIPolicyToModel(opPolicy, policyv1alpha.LevelRoute, versionutil.MajorVersion(resolved)))
}
}
unsubRouteKey := xds.GenerateRouteName("UNSUB", apiData.Context, apiData.Version, chName, routerConfig.GatewayHost)
unsubProps := make(map[string]any)
injectedUnsubPolicies := utils.InjectSystemPolicies(unsubPolicies, systemConfig, unsubProps)
routes = append(routes, policyenginev1.PolicyChain{
RouteKey: unsubRouteKey,
Policies: injectedUnsubPolicies,
})
}
case api.RestAPI:
apiData := cfgTyped.Spec
for _, op := range apiData.Operations {
var finalPolicies []policyenginev1.PolicyInstance
// Policy execution order: API Level Policies -> Operation Level Policies
// Start with API-level policies
if apiData.Policies != nil {
finalPolicies = make([]policyenginev1.PolicyInstance, 0, len(*apiData.Policies))
for _, p := range *apiData.Policies {
// Only append if the policy was successfully resolved (exists in apiPolicies map)
if v, ok := apiPolicies[p.Name]; ok {
finalPolicies = append(finalPolicies, v)
}
}
}
// Append operation-level policies (they don't override, just execute after API-level)
if op.Policies != nil && len(*op.Policies) > 0 {
for _, opPolicy := range *op.Policies {
resolved, err := config.ResolvePolicyVersion(policyDefinitions, latestVersions, opPolicy.Name, opPolicy.Version)
if err != nil {
slog.Error("Failed to resolve policy version for operation-level policy", "policy_name", opPolicy.Name, "operation_method", op.Method, "operation_path", op.Path, "error", err)
continue
}
finalPolicies = append(finalPolicies, ConvertAPIPolicyToModel(opPolicy, policyv1alpha.LevelRoute, versionutil.MajorVersion(resolved)))
}
}
// Determine effective vhosts
effectiveMainVHost := routerConfig.VHosts.Main.Default
effectiveSandboxVHost := routerConfig.VHosts.Sandbox.Default
if apiData.Vhosts != nil {
if strings.TrimSpace(apiData.Vhosts.Main) != "" {
effectiveMainVHost = apiData.Vhosts.Main
}
if apiData.Vhosts.Sandbox != nil && strings.TrimSpace(*apiData.Vhosts.Sandbox) != "" {
effectiveSandboxVHost = *apiData.Vhosts.Sandbox
}
}
vhosts := []string{effectiveMainVHost}
if apiData.Upstream.Sandbox != nil {
vhosts = append(vhosts, effectiveSandboxVHost)
}
// Populate props for system policies (currently no-op but maintains structure for future use)
props := make(map[string]any)
// populatePropsForSystemPolicies(cfg.SourceConfiguration, props)
for _, vhost := range vhosts {
injectedPolicies := utils.InjectSystemPolicies(finalPolicies, systemConfig, props)
routes = append(routes, policyenginev1.PolicyChain{
RouteKey: xds.GenerateRouteName(string(op.Method), apiData.Context, apiData.Version, op.Path, vhost),
Policies: injectedPolicies,
})
}
}
}
// If there are no policies at all, return nil
policyCount := 0
for _, r := range routes {
policyCount += len(r.Policies)
}
if policyCount == 0 {
return nil
}
displayName := cfg.DisplayName
apiVersion := cfg.Version
apiContext, err := cfg.GetContext()
if err != nil {
slog.Error("Failed to get context", "error", err)
return nil
}
now := time.Now().Unix()
return &models.StoredPolicyConfig{
ID: cfg.UUID + "-policies",
Configuration: policyenginev1.Configuration{
Routes: routes,
Metadata: policyenginev1.Metadata{
CreatedAt: now,
UpdatedAt: now,
ResourceVersion: 0,
APIName: displayName,
Version: apiVersion,
Context: apiContext,
},
},
Version: 0,
}
}
// ConvertAPIPolicyToModel converts generated api.Policy to policyenginev1.PolicyInstance
func ConvertAPIPolicyToModel(p api.Policy, attachedTo policyv1alpha.Level, resolvedVersion string) policyenginev1.PolicyInstance {
paramsMap := make(map[string]interface{})
if p.Params != nil {
for k, v := range *p.Params {
paramsMap[k] = v
}
}
if attachedTo != "" {
paramsMap["attachedTo"] = string(attachedTo)
}
return policyenginev1.PolicyInstance{
Name: p.Name,
Version: resolvedVersion,
Enabled: true,
ExecutionCondition: p.ExecutionCondition,
Parameters: paramsMap,
}
}