forked from pydio/cells
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api-discovery.go
362 lines (334 loc) · 13.2 KB
/
api-discovery.go
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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
/*
* Copyright (c) 2018. Abstrium SAS <team (at) pydio.com>
* This file is part of Pydio Cells.
*
* Pydio Cells is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Pydio Cells is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with Pydio Cells. If not, see <http://www.gnu.org/licenses/>.
*
* The latest code can be found at <https://pydio.com>.
*/
package rest
import (
"fmt"
"net/url"
"strings"
"time"
"github.com/pydio/cells/discovery/config/lang"
"github.com/emicklei/go-restful"
"github.com/go-openapi/spec"
"github.com/micro/go-micro/errors"
"github.com/micro/go-micro/registry"
"github.com/ory/ladon"
"github.com/spf13/viper"
"go.uber.org/zap"
"github.com/pydio/cells/common"
"github.com/pydio/cells/common/auth/claim"
"github.com/pydio/cells/common/config"
"github.com/pydio/cells/common/forms"
"github.com/pydio/cells/common/forms/protos"
"github.com/pydio/cells/common/log"
"github.com/pydio/cells/common/proto/idm"
"github.com/pydio/cells/common/proto/jobs"
"github.com/pydio/cells/common/proto/rest"
"github.com/pydio/cells/common/proto/tree"
"github.com/pydio/cells/common/service"
servicecontext "github.com/pydio/cells/common/service/context"
"github.com/pydio/cells/common/utils/i18n"
"github.com/pydio/cells/common/utils/net"
"github.com/pydio/cells/scheduler/actions"
)
/*****************************
PUBLIC ENDPOINTS FOR DISCOVERY
******************************/
func withPath(u *url.URL, p string) *url.URL {
u2 := *u
u2.Path = p
return &u2
}
func withScheme(u *url.URL, s string) *url.URL {
u2 := *u
u2.Scheme = s
return &u2
}
// Publish a list of available endpoints
func (s *Handler) EndpointsDiscovery(req *restful.Request, resp *restful.Response) {
var t time.Time
var e error
if t, e = time.Parse("2006-01-02T15:04:05", common.BuildStamp); e != nil {
t = time.Now()
}
endpointResponse := &rest.DiscoveryResponse{
Endpoints: make(map[string]string),
}
if _, ok := req.Request.Context().Value(claim.ContextKey).(claim.Claims); ok {
endpointResponse.PackageType = common.PackageType
endpointResponse.PackageLabel = common.PackageLabel
endpointResponse.Version = common.Version().String()
endpointResponse.BuildStamp = int32(t.Unix())
endpointResponse.BuildRevision = common.BuildRevision
}
urlParsed := net.ExternalDomainFromRequest(req.Request)
log.Logger(req.Request.Context()).Debug("Request", zap.Any("mainUrl", urlParsed))
wsProtocol := "ws"
if urlParsed.Scheme == "https" {
wsProtocol = "wss"
}
endpointResponse.Endpoints["rest"] = withPath(urlParsed, "/a").String()
endpointResponse.Endpoints["openapi"] = withPath(urlParsed, "/a/config/discovery/openapi").String()
endpointResponse.Endpoints["forms"] = withPath(urlParsed, "/a/config/discovery/forms").String() + "/{serviceName}"
endpointResponse.Endpoints["oidc"] = withPath(urlParsed, "/auth").String()
endpointResponse.Endpoints["s3"] = withPath(urlParsed, "/io").String()
endpointResponse.Endpoints["chats"] = withScheme(withPath(urlParsed, "/ws/chat"), wsProtocol).String()
endpointResponse.Endpoints["websocket"] = withScheme(withPath(urlParsed, "/ws/event"), wsProtocol).String()
endpointResponse.Endpoints["frontend"] = withPath(urlParsed, "").String()
if urlParsed.Scheme == "http" {
if external := viper.GetString("grpc_external"); external != "" {
endpointResponse.Endpoints["grpc"] = external
} else {
// Pure HTTP and no grpc_external : detect GRPC_CLEAR Service Port
var grpcPorts []string
if ss, e := registry.GetService(common.ServiceGatewayGrpcClear); e == nil {
for _, s := range ss {
for _, n := range s.Nodes {
grpcPorts = append(grpcPorts, fmt.Sprintf("%d", n.Port))
}
}
}
if len(grpcPorts) > 0 {
endpointResponse.Endpoints["grpc"] = strings.Join(grpcPorts, ",")
}
}
}
resp.WriteEntity(endpointResponse)
}
// OpenApiDiscovery prints out the Swagger Spec in JSON format
func (s *Handler) OpenApiDiscovery(req *restful.Request, resp *restful.Response) {
p := net.ExternalDomainFromRequest(req.Request)
p.Path = ""
jsonSpec := service.SwaggerSpec()
jsonSpec.Spec().Host = p.Host
jsonSpec.Spec().Schemes = []string{p.Scheme}
jsonSpec.Spec().Info.Title = "Pydio Cells API"
jsonSpec.Spec().Info.Version = "2.0"
jsonSpec.Spec().Info.Description = "OAuth2-based REST API (automatically generated from protobufs)"
scheme := &spec.SecurityScheme{
VendorExtensible: spec.VendorExtensible{},
SecuritySchemeProps: spec.SecuritySchemeProps{
Type: "oauth2",
Description: "Login using OAuth2 code flow",
Flow: "accessCode",
AuthorizationURL: p.String() + "/oidc/oauth2/auth",
TokenURL: p.String() + "/oidc/oauth2/token",
},
}
jsonSpec.Spec().SecurityDefinitions = map[string]*spec.SecurityScheme{"oauth2": scheme}
jsonSpec.Spec().Security = append(jsonSpec.Spec().Security, map[string][]string{"oauth2": []string{}})
for path, ops := range jsonSpec.Spec().Paths.Paths {
s.documentOpResponse(ops.Get)
s.documentOpResponse(ops.Head)
s.documentOpResponse(ops.Patch)
s.documentOpResponse(ops.Post)
s.documentOpResponse(ops.Delete)
s.documentOpResponse(ops.Put)
if strings.HasPrefix(path, "/a/") {
continue
}
outPath := "/a" + path
delete(jsonSpec.Spec().Paths.Paths, path)
jsonSpec.Spec().Paths.Paths[outPath] = ops
}
resp.WriteAsJson(jsonSpec.Spec())
}
// documentOpResponse adds a description on response to comply with Swagger spec
func (s *Handler) documentOpResponse(p *spec.Operation) {
if p == nil || p.Responses == nil || p.Responses.StatusCodeResponses == nil {
return
}
if success, ok := p.Responses.StatusCodeResponses[200]; ok {
success.Description = "Successful response"
p.Responses.StatusCodeResponses[200] = success
}
}
// ConfigFormsDiscovery serves an XML description for building a form
func (s *Handler) ConfigFormsDiscovery(req *restful.Request, rsp *restful.Response) {
serviceName := req.PathParameter("ServiceName")
if serviceName == "" {
service.RestError500(req, rsp, errors.BadRequest("configs", "Please provide a service name"))
}
form := config.ExposedConfigsForService(serviceName)
if form == nil {
service.RestError404(req, rsp, errors.NotFound("configs", "Cannot find service "+serviceName))
return
}
rsp.WriteAsXml(form.Serialize(i18n.UserLanguagesFromRestRequest(req, config.Get())...))
return
}
// SchedulerActionsDiscovery lists all registered actions
func (s *Handler) SchedulerActionsDiscovery(req *restful.Request, rsp *restful.Response) {
actionManager := actions.GetActionsManager()
allActions := actionManager.DescribeActions(i18n.UserLanguagesFromRestRequest(req, config.Get())...)
response := &rest.SchedulerActionsResponse{
Actions: make(map[string]*rest.ActionDescription, len(allActions)),
}
for name, a := range allActions {
t := a.Tint
if ct, o := actions.CategoryTints[a.Category]; o && t == "" {
t = ct
}
response.Actions[name] = &rest.ActionDescription{
Name: a.ID,
Icon: a.Icon,
Label: a.Label,
IsInternal: a.IsInternal,
Tint: t,
Description: a.Description,
SummaryTemplate: a.SummaryTemplate,
Category: a.Category,
InputDescription: a.InputDescription,
OutputDescription: a.OutputDescription,
HasForm: a.HasForm,
FormModule: a.FormModule,
FormModuleProps: a.FormModuleProps,
}
}
rsp.WriteEntity(response)
}
// SchedulerActionFormDiscovery sends an XML-serialized form for building parameters for a given action
func (s *Handler) SchedulerActionFormDiscovery(req *restful.Request, rsp *restful.Response) {
actionName := req.PathParameter("ActionName")
var form *forms.Form
if strings.HasPrefix(actionName, "proto:") {
protoName := strings.TrimPrefix(actionName, "proto:")
var asSwitch bool
if strings.HasPrefix(protoName, "switch:") {
asSwitch = true
protoName = strings.TrimPrefix(protoName, "switch:")
}
switch protoName {
case "idm.UserSingleQuery":
form = protos.GenerateProtoToForm("userSingleQuery", &idm.UserSingleQuery{}, asSwitch)
case "idm.RoleSingleQuery":
form = protos.GenerateProtoToForm("roleSingleQuery", &idm.RoleSingleQuery{}, asSwitch)
case "idm.WorkspaceSingleQuery":
form = protos.GenerateProtoToForm("workspaceSingleQuery", &idm.WorkspaceSingleQuery{}, asSwitch)
case "idm.ACLSingleQuery":
form = protos.GenerateProtoToForm("aclSingleQuery", &idm.ACLSingleQuery{}, asSwitch)
a := protos.GenerateProtoToForm("aclAction", &idm.ACLAction{}, false)
if asSwitch {
// Patch Actions field manually
sw := form.Groups[0].Fields[0].(*forms.SwitchField)
sw.Values = append(sw.Values, &forms.SwitchValue{
Name: "Actions",
Value: "Actions",
Label: "Actions",
Fields: []forms.Field{&forms.ReplicableFields{
Id: "Actions",
Title: "Actions",
Description: "Acl Actions",
Mandatory: true,
Fields: a.Groups[0].Fields,
}},
})
} else {
form.Groups[0].Fields = append(form.Groups[0].Fields, &forms.ReplicableFields{
Id: "Actions",
Title: "Actions",
Description: "Acl Actions",
Fields: a.Groups[0].Fields,
})
}
case "tree.Query":
form = protos.GenerateProtoToForm("treeQuery", &tree.Query{}, asSwitch)
case "jobs.ActionOutputSingleQuery":
form = protos.GenerateProtoToForm("actionOutputSingleQuery", &jobs.ActionOutputSingleQuery{}, asSwitch)
case "jobs.ContextMetaSingleQuery", "policy.Conditions":
// Add SwitchField for PolicyCondition
condField := &forms.SwitchField{
Name: "Condition",
Label: "Condition",
Description: "Condition",
}
for name, f := range ladon.ConditionFactories {
condition := f()
condForm := protos.GenerateProtoToForm("condition"+condition.GetName(), condition, false)
// Do not enqueue conditions with zero fields: they are not usable
if len(condForm.Groups[0].Fields) > 0 {
condField.Values = append(condField.Values, &forms.SwitchValue{
Name: name,
Value: name,
Label: "contextMetaCondition." + name,
Fields: condForm.Groups[0].Fields,
})
}
}
if protoName == "policy.Conditions" {
// Specific case to just build Conditions form
form = &forms.Form{Groups: []*forms.Group{{
Fields: []forms.Field{condField},
}}}
} else {
// Build FieldName / Condition Form
form = protos.GenerateProtoToForm("contextMetaSingleQuery", &jobs.ContextMetaSingleQuery{}, asSwitch)
selectChoices := []map[string]string{
{servicecontext.HttpMetaRemoteAddress: "contextMetaField." + servicecontext.HttpMetaRemoteAddress},
{servicecontext.HttpMetaUserAgent: "contextMetaField." + servicecontext.HttpMetaUserAgent},
{servicecontext.HttpMetaContentType: "contextMetaField." + servicecontext.HttpMetaContentType},
{servicecontext.HttpMetaProtocol: "contextMetaField." + servicecontext.HttpMetaProtocol},
{servicecontext.HttpMetaHost: "contextMetaField." + servicecontext.HttpMetaHost},
{servicecontext.HttpMetaHostname: "contextMetaField." + servicecontext.HttpMetaHostname},
{servicecontext.HttpMetaPort: "contextMetaField." + servicecontext.HttpMetaPort},
{servicecontext.HttpMetaRequestMethod: "contextMetaField." + servicecontext.HttpMetaRequestMethod},
{servicecontext.HttpMetaRequestURI: "contextMetaField." + servicecontext.HttpMetaRequestURI},
{servicecontext.HttpMetaCookiesString: "contextMetaField." + servicecontext.HttpMetaCookiesString},
//{servicecontext.ClientTime: servicecontext.ClientTime},
{servicecontext.ServerTime: "contextMetaField." + servicecontext.ServerTime},
}
if asSwitch {
sw := form.Groups[0].Fields[0].(*forms.SwitchField)
sw.Values[0].Fields[0].(*forms.FormField).Type = forms.ParamSelect
sw.Values[0].Fields[0].(*forms.FormField).ChoicePresetList = selectChoices
sw.Values[0].Fields = append(sw.Values[0].Fields, condField)
} else {
form.Groups[0].Fields[0].(*forms.FormField).Type = forms.ParamSelect
form.Groups[0].Fields[0].(*forms.FormField).ChoicePresetList = selectChoices
form.Groups[0].Fields = append(form.Groups[0].Fields, condField)
}
}
}
} else {
actionManager := actions.GetActionsManager()
var err error
form, err = actionManager.LoadActionForm(actionName)
if err != nil {
service.RestErrorDetect(req, rsp, err)
return
}
}
if form == nil {
service.RestError404(req, rsp, fmt.Errorf("cannot find form"))
}
form.I18NBundle = lang.Bundle()
rsp.WriteAsXml(form.Serialize(i18n.UserLanguagesFromRestRequest(req, config.Get())...))
}
// ListSites implements /config/sites GET API
func (s *Handler) ListSites(req *restful.Request, rsp *restful.Response) {
// There is an optional Filter string on req
ss, err := config.LoadSites()
if err != nil {
service.RestError500(req, rsp, err)
return
}
sites := &rest.ListSitesResponse{}
sites.Sites = ss
rsp.WriteEntity(sites)
}