/
events.go
204 lines (174 loc) · 6.32 KB
/
events.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
package main
import (
"context"
"fmt"
"net/http"
"slices"
"strings"
"github.com/lxc/incus/v6/internal/server/auth"
"github.com/lxc/incus/v6/internal/server/db"
"github.com/lxc/incus/v6/internal/server/db/cluster"
"github.com/lxc/incus/v6/internal/server/events"
"github.com/lxc/incus/v6/internal/server/request"
"github.com/lxc/incus/v6/internal/server/response"
"github.com/lxc/incus/v6/internal/server/state"
"github.com/lxc/incus/v6/shared/api"
"github.com/lxc/incus/v6/shared/logger"
"github.com/lxc/incus/v6/shared/util"
"github.com/lxc/incus/v6/shared/ws"
)
var eventTypes = []string{api.EventTypeLogging, api.EventTypeOperation, api.EventTypeLifecycle, api.EventTypeNetworkACL}
var privilegedEventTypes = []string{api.EventTypeLogging}
var eventsCmd = APIEndpoint{
Path: "events",
Get: APIEndpointAction{Handler: eventsGet, AccessHandler: allowAuthenticated},
}
type eventsServe struct {
req *http.Request
s *state.State
}
func (r *eventsServe) Render(w http.ResponseWriter) error {
return eventsSocket(r.s, r.req, w)
}
func (r *eventsServe) String() string {
return "event handler"
}
func eventsSocket(s *state.State, r *http.Request, w http.ResponseWriter) error {
// Detect project mode.
projectName := request.QueryParam(r, "project")
allProjects := util.IsTrue(request.QueryParam(r, "all-projects"))
if allProjects && projectName != "" {
return api.StatusErrorf(http.StatusBadRequest, "Cannot specify a project when requesting all projects")
} else if !allProjects && projectName == "" {
projectName = api.ProjectDefaultName
}
if !allProjects && projectName != api.ProjectDefaultName {
_, err := s.DB.GetProject(context.Background(), projectName)
if err != nil {
return err
}
}
var projectPermissionFunc auth.PermissionChecker
if projectName != "" {
err := s.Authorizer.CheckPermission(r.Context(), r, auth.ObjectProject(projectName), auth.EntitlementCanViewEvents)
if err != nil {
return err
}
} else if allProjects {
var err error
projectPermissionFunc, err = s.Authorizer.GetPermissionChecker(r.Context(), r, auth.EntitlementCanViewEvents, auth.ObjectTypeProject)
if err != nil {
return err
}
}
canViewPrivilegedEvents := s.Authorizer.CheckPermission(r.Context(), r, auth.ObjectServer(), auth.EntitlementCanViewPrivilegedEvents) == nil
types := strings.Split(r.FormValue("type"), ",")
if len(types) == 1 && types[0] == "" {
types = []string{}
for _, entry := range eventTypes {
if !canViewPrivilegedEvents && slices.Contains(privilegedEventTypes, entry) {
continue
}
types = append(types, entry)
}
}
// Validate event types.
for _, entry := range types {
if !slices.Contains(eventTypes, entry) {
return api.StatusErrorf(http.StatusBadRequest, "%q isn't a supported event type", entry)
}
}
if slices.Contains(types, api.EventTypeLogging) && !canViewPrivilegedEvents {
return api.StatusErrorf(http.StatusForbidden, "Forbidden")
}
l := logger.AddContext(logger.Ctx{"remote": r.RemoteAddr})
var excludeLocations []string
// Get the current local serverName and store it for the events.
// We do that now to avoid issues with changes to the name and to limit
// the number of DB access to just one per connection.
err := s.DB.Cluster.Transaction(context.TODO(), func(ctx context.Context, tx *db.ClusterTx) error {
if isClusterNotification(r) {
ctx := r.Context()
// Try and match cluster member certificate fingerprint to member name.
fingerprint, found := ctx.Value(request.CtxUsername).(string)
if found {
cert, err := cluster.GetCertificateByFingerprintPrefix(context.Background(), tx.Tx(), fingerprint)
if err != nil {
return fmt.Errorf("Failed matching client certificate to cluster member: %w", err)
}
// Add the cluster member client's name to the excluded locations so that we can avoid
// looping the event back to them when they send us an event via recvFunc.
excludeLocations = append(excludeLocations, cert.Name)
}
}
return nil
})
if err != nil {
l.Warn("Failed setting up event connection", logger.Ctx{"err": err})
return nil
}
var recvFunc events.EventHandler
var excludeSources []events.EventSource
if isClusterNotification(r) {
// If client is another cluster member, it will already be pulling events from other cluster
// members so no need to also deliver forwarded events that this member receives.
excludeSources = append(excludeSources, events.EventSourcePull)
recvFunc = func(event api.Event) {
// Inject event received via push from event listener client so its forwarded to
// other event hub members (if operating in event hub mode).
s.Events.Inject(event, events.EventSourcePush)
}
}
// Upgrade the connection to websocket as late as possible.
// This is because the client will assume it's getting events as soon as the upgrade is performed.
conn, err := ws.Upgrader.Upgrade(w, r, nil)
if err != nil {
l.Warn("Failed upgrading event connection", logger.Ctx{"err": err})
return nil
}
defer func() { _ = conn.Close() }() // Ensure listener below ends when this function ends.
listenerConnection := events.NewWebsocketListenerConnection(conn)
listener, err := s.Events.AddListener(projectName, allProjects, projectPermissionFunc, listenerConnection, types, excludeSources, recvFunc, excludeLocations)
if err != nil {
l.Warn("Failed to add event listener", logger.Ctx{"err": err})
return nil
}
listener.Wait(r.Context())
return nil
}
// swagger:operation GET /1.0/events server events_get
//
// Get the event stream
//
// Connects to the event API using websocket.
//
// ---
// produces:
// - application/json
// parameters:
// - in: query
// name: project
// description: Project name
// type: string
// example: default
// - in: query
// name: type
// description: Event type(s), comma separated (valid types are logging, operation or lifecycle)
// type: string
// example: logging,lifecycle
// - in: query
// name: all-projects
// description: Retrieve instances from all projects
// type: boolean
// responses:
// "200":
// description: Websocket message (JSON)
// schema:
// $ref: "#/definitions/Event"
// "403":
// $ref: "#/responses/Forbidden"
// "500":
// $ref: "#/responses/InternalServerError"
func eventsGet(d *Daemon, r *http.Request) response.Response {
return &eventsServe{req: r, s: d.State()}
}