-
Notifications
You must be signed in to change notification settings - Fork 301
/
rights.go
364 lines (336 loc) · 11 KB
/
rights.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
363
364
// Copyright © 2019 The Things Network Foundation, The Things Industries B.V.
//
// Licensed 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 identityserver
import (
"context"
"go.thethings.network/lorawan-stack/v3/pkg/errors"
"go.thethings.network/lorawan-stack/v3/pkg/identityserver/store"
"go.thethings.network/lorawan-stack/v3/pkg/ttnpb"
)
func allPotentialRights(eIDs *ttnpb.EntityIdentifiers, rights *ttnpb.Rights) *ttnpb.Rights {
switch eIDs.GetIds().(type) {
case *ttnpb.EntityIdentifiers_ApplicationIds:
return ttnpb.AllApplicationRights.Intersect(rights)
case *ttnpb.EntityIdentifiers_ClientIds:
return ttnpb.AllClientRights.Intersect(rights)
case *ttnpb.EntityIdentifiers_GatewayIds:
return ttnpb.AllGatewayRights.Intersect(rights)
case *ttnpb.EntityIdentifiers_OrganizationIds:
return ttnpb.AllEntityRights.Union(ttnpb.AllOrganizationRights).Intersect(rights)
case *ttnpb.EntityIdentifiers_UserIds:
return ttnpb.AllEntityRights.Union(ttnpb.AllOrganizationRights, ttnpb.AllUserRights).Intersect(rights)
}
return nil
}
func (is *IdentityServer) getRights(ctx context.Context, entityID *ttnpb.EntityIdentifiers) (entityRights, universalRights *ttnpb.Rights, err error) {
authInfo, err := is.authInfo(ctx)
if err != nil {
return nil, nil, err
}
authInfoRights := ttnpb.RightsFrom(authInfo.GetRights()...)
universalRights = allPotentialRights(entityID, authInfo.GetUniversalRights())
if len(universalRights.GetRights()) == 0 {
universalRights = nil
}
allPotentialRights := allPotentialRights(entityID, authInfoRights)
// If the rights of the auth do not contain any rights for the entity type,
// there's nothing more to do.
if len(allPotentialRights.GetRights()) == 0 {
return nil, universalRights, nil
}
// If the caller is the requested entity,
// we can directly return the rights of the auth.
authenticatedAs := authInfo.GetEntityIdentifiers()
if entityID.EntityType() == authenticatedAs.EntityType() &&
entityID.IDString() == authenticatedAs.IDString() {
return authInfoRights, universalRights, nil
}
// If the caller is not an organization or user, there's nothing more to do.
ouID := authInfo.GetOrganizationOrUserIdentifiers()
if ouID == nil {
return nil, universalRights, nil
}
// If the caller is requesting a user, and they're not that user (see above),
// they don't have rights on it, so nothing more to do.
if entityID.GetUserIds() != nil {
return nil, universalRights, nil
}
err = is.store.Transact(ctx, func(ctx context.Context, st store.Store) error {
membershipChains, err := st.FindAccountMembershipChains(ctx, ouID, entityID.EntityType(), entityID.IDString())
if err != nil {
return err
}
for _, chain := range membershipChains {
entityRights = entityRights.Union(chain.GetRights())
}
return nil
})
if err != nil {
return nil, nil, err
}
entityRights = entityRights.Intersect(authInfoRights)
return entityRights, universalRights, err
}
// ApplicationRights returns the rights the caller has on the given application.
func (is *IdentityServer) ApplicationRights(ctx context.Context, appIDs *ttnpb.ApplicationIdentifiers) (*ttnpb.Rights, error) {
entity, universal, err := is.getRights(ctx, appIDs.GetEntityIdentifiers())
if err != nil {
return nil, err
}
err = is.store.Transact(ctx, func(ctx context.Context, st store.Store) error {
_, err := st.GetApplication(ctx, appIDs, []string{"ids"})
return err
})
if errors.IsNotFound(err) {
if is.IsAdmin(ctx) {
return nil, err
}
return &ttnpb.Rights{}, nil
} else if err != nil {
return nil, err
}
return entity.Union(universal), nil
}
// ClientRights returns the rights the caller has on the given client.
func (is *IdentityServer) ClientRights(ctx context.Context, cliIDs *ttnpb.ClientIdentifiers) (*ttnpb.Rights, error) {
entity, universal, err := is.getRights(ctx, cliIDs.GetEntityIdentifiers())
if err != nil {
return nil, err
}
err = is.store.Transact(ctx, func(ctx context.Context, st store.Store) error {
_, err := st.GetClient(ctx, cliIDs, []string{"ids"})
return err
})
if errors.IsNotFound(err) {
if is.IsAdmin(ctx) {
return nil, err
}
return &ttnpb.Rights{}, nil
} else if err != nil {
return nil, err
}
return entity.Union(universal), nil
}
// GatewayRights returns the rights the caller has on the given gateway.
// The query for the gateway only considers the Gateway ID and not the EUI (if provided).
func (is *IdentityServer) GatewayRights(ctx context.Context, gtwIDs *ttnpb.GatewayIdentifiers) (*ttnpb.Rights, error) {
ids := &ttnpb.GatewayIdentifiers{
GatewayId: gtwIDs.GatewayId,
}
entity, universal, err := is.getRights(ctx, ids.GetEntityIdentifiers())
if err != nil {
return nil, err
}
err = is.store.Transact(ctx, func(ctx context.Context, st store.Store) (err error) {
gtw, err := st.GetGateway(ctx, ids, []string{"ids", "status_public", "location_public"})
if err != nil {
return err
}
if gtw.StatusPublic {
entity = entity.Union(ttnpb.RightsFrom(ttnpb.Right_RIGHT_GATEWAY_STATUS_READ))
}
if gtw.LocationPublic {
entity = entity.Union(ttnpb.RightsFrom(ttnpb.Right_RIGHT_GATEWAY_LOCATION_READ))
}
return nil
})
if errors.IsNotFound(err) {
if is.IsAdmin(ctx) {
return nil, err
}
return &ttnpb.Rights{}, nil
} else if err != nil {
return nil, err
}
return entity.Union(universal), nil
}
// OrganizationRights returns the rights the caller has on the given organization.
func (is *IdentityServer) OrganizationRights(ctx context.Context, orgIDs *ttnpb.OrganizationIdentifiers) (*ttnpb.Rights, error) {
entity, universal, err := is.getRights(ctx, orgIDs.GetEntityIdentifiers())
if err != nil {
return nil, err
}
err = is.store.Transact(ctx, func(ctx context.Context, st store.Store) error {
_, err := st.GetOrganization(ctx, orgIDs, []string{"ids"})
return err
})
if errors.IsNotFound(err) {
if is.IsAdmin(ctx) {
return nil, err
}
return &ttnpb.Rights{}, nil
} else if err != nil {
return nil, err
}
return entity.Union(universal), nil
}
// UserRights returns the rights the caller has on the given user.
func (is *IdentityServer) UserRights(ctx context.Context, userIDs *ttnpb.UserIdentifiers) (*ttnpb.Rights, error) {
entity, universal, err := is.getRights(ctx, userIDs.GetEntityIdentifiers())
if err != nil {
return nil, err
}
err = is.store.Transact(ctx, func(ctx context.Context, st store.Store) error {
_, err := st.GetUser(ctx, userIDs, []string{"ids"})
return err
})
if errors.IsNotFound(err) {
if is.IsAdmin(ctx) {
return nil, err
}
return &ttnpb.Rights{}, nil
} else if err != nil {
return nil, err
}
return entity.Union(universal), nil
}
var (
errInsufficientRights = errors.DefinePermissionDenied(
"insufficient_rights",
"insufficient rights",
)
errNeitherUserNorOrganization = errors.DefinePermissionDenied(
"neither_user_nor_organization",
"caller is neither a user nor an organization",
)
errSomeGatewaysNotFound = errors.DefineNotFound(
"some_gateways_not_found",
"some gateways not found",
)
)
func (is *IdentityServer) assertGatewayRights( // nolint:gocyclo
ctx context.Context,
gtwIDs []*ttnpb.GatewayIdentifiers,
requiredGatewayRights *ttnpb.Rights,
) error {
authInfo, err := is.authInfo(ctx)
if err != nil {
return err
}
// If the caller is not an organization or user, there's nothing more to do.
ouID := authInfo.GetOrganizationOrUserIdentifiers()
if ouID == nil {
return errNeitherUserNorOrganization.New()
}
// Check that the caller has the requested rights.
authInfoRights := ttnpb.RightsFrom(authInfo.GetRights()...)
if !authInfoRights.IncludesAll(requiredGatewayRights.GetRights()...) {
return errInsufficientRights.New()
}
// If the caller has specified the identifiers multiple times, deduplicate them.
gtwIDs = uniqueIdentifiers(gtwIDs)
return is.store.Transact(ctx, func(ctx context.Context, st store.Store) error {
gtws, err := st.FindGateways(ctx, gtwIDs, []string{"ids", "status_public", "location_public"})
if err != nil {
return err
}
if len(gtws) != len(gtwIDs) {
if authInfo.IsAdmin {
// Return the cause only to the admin.
// This follows the same logic as in ListRights.
return errSomeGatewaysNotFound.New()
}
return errInsufficientRights.New()
}
// Filter out the public gateways from membership checks,
// when only public fields are requested.
publicGatewayIds := make(map[string]struct{}, len(gtws))
bothStatsAndLocation := len(requiredGatewayRights.Sub(
ttnpb.RightsFrom(
ttnpb.Right_RIGHT_GATEWAY_LOCATION_READ,
ttnpb.Right_RIGHT_GATEWAY_STATUS_READ,
),
).GetRights()) == 0
onlyPublicLocation := len(requiredGatewayRights.Sub(
ttnpb.RightsFrom(
ttnpb.Right_RIGHT_GATEWAY_LOCATION_READ,
),
).GetRights()) == 0
onlyPublicStats := len(requiredGatewayRights.Sub(
ttnpb.RightsFrom(
ttnpb.Right_RIGHT_GATEWAY_STATUS_READ,
),
).GetRights()) == 0
if bothStatsAndLocation {
for _, gtw := range gtws {
if gtw.StatusPublic && gtw.LocationPublic {
publicGatewayIds[gtw.IDString()] = struct{}{}
}
}
} else {
if onlyPublicStats {
for _, gtw := range gtws {
if gtw.StatusPublic {
publicGatewayIds[gtw.IDString()] = struct{}{}
}
}
}
if onlyPublicLocation {
for _, gtw := range gtws {
if gtw.LocationPublic {
publicGatewayIds[gtw.IDString()] = struct{}{}
}
}
}
}
entityIDs := make([]string, 0, len(gtwIDs))
for _, gtwID := range gtwIDs {
if _, ok := publicGatewayIds[gtwID.IDString()]; ok {
continue
}
entityIDs = append(entityIDs, gtwID.GetEntityIdentifiers().IDString())
}
if len(entityIDs) == 0 {
return nil
}
if authInfo.IsAdmin {
if authInfo.GetUniversalRights().IncludesAll(requiredGatewayRights.GetRights()...) {
return nil
}
}
membershipChains, err := st.FindAccountMembershipChains(
ctx,
ouID,
store.EntityGateway,
entityIDs...,
)
if err != nil {
return err
}
entityRights := make(map[string]*ttnpb.Rights, len(membershipChains))
for _, chain := range membershipChains {
id := chain.EntityIdentifiers.IDString()
entityRights[id] = entityRights[id].Union(chain.GetRights())
}
for _, entityID := range entityIDs {
// Make sure that there are no extra rights requested.
if !entityRights[entityID].IncludesAll(requiredGatewayRights.GetRights()...) {
return errInsufficientRights.New()
}
}
return nil
})
}
func uniqueIdentifiers[T ttnpb.IDStringer](ids []T) []T {
m := make(map[string]struct{}, len(ids))
result := make([]T, 0, len(ids))
for _, id := range ids {
if _, ok := m[id.IDString()]; ok {
continue
}
m[id.IDString()] = struct{}{}
result = append(result, id)
}
return result
}