-
-
Notifications
You must be signed in to change notification settings - Fork 6
/
group.go
361 lines (315 loc) · 9 KB
/
group.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
package adc
import (
"errors"
"fmt"
"slices"
"sync"
"github.com/go-ldap/ldap/v3"
)
// Active Direcotry group.
type Group struct {
DN string `json:"dn"`
Id string `json:"id"`
Attributes map[string]interface{} `json:"attributes"`
Members []GroupMember `json:"members"`
}
// Active Direcotry member info.
type GroupMember struct {
DN string `json:"dn"`
Id string `json:"id"`
}
// Returns string attribute by attribute name.
// Returns empty string if attribute not exists or it can't be covnerted to string.
func (g *Group) GetStringAttribute(name string) string {
for att, val := range g.Attributes {
if att == name {
if s, ok := val.(string); ok {
return s
}
}
}
return ""
}
type GetGroupArgs struct {
// Group ID to search.
Id string `json:"id"`
// Optional group DN. Overwrites ID if provided in request.
Dn string `json:"dn"`
// Optional LDAP filter to search entry. Warning! provided Filter arg overwrites Id and Dn args usage.
Filter string `json:"filter"`
// Optional group attributes to overwrite attributes in client config.
Attributes []string `json:"attributes"`
// Skip search of group members data. Can improve request time.
SkipMembersSearch bool `json:"skip_members_search"`
}
func (args GetGroupArgs) Validate() error {
if args.Id == "" && args.Dn == "" && args.Filter == "" {
return errors.New("neither of ID, DN or Filter provided")
}
return nil
}
func (cl *Client) GetGroup(args GetGroupArgs) (*Group, error) {
if err := args.Validate(); err != nil {
return nil, err
}
var filter string
if args.Filter != "" {
filter = args.Filter
} else {
filter = fmt.Sprintf(cl.Config.Groups.FilterById, args.Id)
if args.Dn != "" {
filter = fmt.Sprintf(cl.Config.Groups.FilterByDn, ldap.EscapeFilter(args.Dn))
}
}
req := &ldap.SearchRequest{
BaseDN: cl.Config.Groups.SearchBase,
Scope: ldap.ScopeWholeSubtree,
DerefAliases: ldap.NeverDerefAliases,
TimeLimit: int(cl.Config.Timeout.Seconds()),
Filter: filter,
Attributes: cl.Config.Groups.Attributes,
}
if args.Attributes != nil {
req.Attributes = args.Attributes
}
entry, err := cl.searchEntry(req)
if err != nil {
return nil, err
}
if entry == nil {
return nil, nil
}
result := &Group{
DN: entry.DN,
Id: entry.GetAttributeValue(cl.Config.Groups.IdAttribute),
Attributes: make(map[string]interface{}, len(entry.Attributes)),
}
for _, a := range entry.Attributes {
result.Attributes[a.Name] = entry.GetAttributeValue(a.Name)
}
if !args.SkipMembersSearch {
members, err := cl.getGroupMembers(entry.DN)
if err != nil {
return nil, fmt.Errorf("can't get group members: %s", err.Error())
}
result.Members = members
}
return result, nil
}
func (cl *Client) getGroupMembers(dn string) ([]GroupMember, error) {
req := &ldap.SearchRequest{
BaseDN: cl.Config.Users.SearchBase,
Scope: ldap.ScopeWholeSubtree,
DerefAliases: ldap.NeverDerefAliases,
TimeLimit: int(cl.Config.Timeout.Seconds()),
Filter: fmt.Sprintf(cl.Config.Groups.FilterMembersByDn, ldap.EscapeFilter(dn)),
Attributes: []string{cl.Config.Users.IdAttribute},
}
entries, err := cl.searchEntries(req)
if err != nil {
return nil, err
}
var result []GroupMember
for _, e := range entries {
result = append(result, GroupMember{
DN: e.DN,
Id: e.GetAttributeValue(cl.Config.Groups.IdAttribute),
})
}
return result, nil
}
// Returns list of group members DNs.
func (g *Group) MembersDn() []string {
var result []string
for _, m := range g.Members {
result = append(result, m.DN)
}
return result
}
// Returns list of group members IDs.
func (g *Group) MembersId() []string {
var result []string
for _, m := range g.Members {
result = append(result, m.Id)
}
return result
}
// Adds provided accounts IDs to provided group members. Returns number of addedd accounts.
func (cl *Client) AddGroupMembers(groupId string, membersIds ...string) (int, error) {
group, err := cl.GetGroup(GetGroupArgs{Id: groupId})
if err != nil {
return 0, fmt.Errorf("can't get group: %s", err.Error())
}
if group == nil {
return 0, fmt.Errorf("group '%s' not found by ID", groupId)
}
ch := make(chan string, len(membersIds))
errCh := make(chan error, len(membersIds))
wg := &sync.WaitGroup{}
for _, id := range membersIds {
wg.Add(1)
go func(userId string, ch chan<- string, errCh chan<- error, wg *sync.WaitGroup) {
defer wg.Done()
user, err := cl.GetUser(GetUserArgs{Id: userId})
if err != nil {
errCh <- fmt.Errorf("can't get account '%s': %s", userId, err.Error())
return
}
if user == nil {
cl.logger.Debugf("Account '%s' being added to '%s' wasn't found",
userId, groupId)
return
}
if user.IsGroupMember(groupId) {
cl.logger.Debugf("The adding account '%s' is already a member of the group '%s'",
userId, groupId)
return
}
ch <- user.DN
}(id, ch, errCh, wg)
}
wg.Wait()
close(errCh)
close(ch)
for err := range errCh {
if err != nil {
return 0, err
}
}
var toAdd []string
for dn := range ch {
toAdd = append(toAdd, dn)
}
if len(toAdd) == 0 {
return 0, nil
}
newMembers := popAddGroupMembers(group, toAdd)
cl.logger.Debugf("Adding new group members to '%s'; Old count: %d; New count: %d",
groupId, len(group.MembersId()), len(newMembers))
if err := cl.updateAttribute(group.DN, "member", newMembers); err != nil {
return 0, err
}
return len(toAdd), nil
}
func popAddGroupMembers(g *Group, toAdd []string) []string {
if len(toAdd) == 0 {
return g.MembersDn()
}
result := make([]string, 0, len(g.Members)+len(toAdd))
result = append(result, g.MembersDn()...)
result = append(result, toAdd...)
return result
}
// Deletes provided accounts IDs from provided group members. Returns number of deleted from group members.
func (cl *Client) DeleteGroupMembers(groupId string, membersIds ...string) (int, error) {
group, err := cl.GetGroup(GetGroupArgs{Id: groupId})
if err != nil {
return 0, fmt.Errorf("can't get group: %s", err.Error())
}
if group == nil {
return 0, fmt.Errorf("group '%s' not found by ID", groupId)
}
ch := make(chan string, len(membersIds))
errCh := make(chan error, len(membersIds))
wg := &sync.WaitGroup{}
for _, id := range membersIds {
wg.Add(1)
go func(userId string, ch chan<- string, errCh chan<- error, wg *sync.WaitGroup) {
defer wg.Done()
user, err := cl.GetUser(GetUserArgs{Id: userId})
if err != nil {
errCh <- fmt.Errorf("can't get account '%s': %s", userId, err.Error())
return
}
if user == nil {
cl.logger.Debugf("Account '%s' being deleted from '%s' wasn't found",
userId, groupId)
return
}
if !user.IsGroupMember(groupId) {
cl.logger.Debugf("The deleting account '%s' already isn't a member of the group '%s'",
userId, groupId)
return
}
ch <- user.DN
}(id, ch, errCh, wg)
}
wg.Wait()
close(errCh)
close(ch)
for err := range errCh {
if err != nil {
return 0, err
}
}
var toDel []string
for dn := range ch {
toDel = append(toDel, dn)
}
if len(toDel) == 0 {
return 0, nil
}
newMembers := popDelGroupMembers(group, toDel)
cl.logger.Debugf("Deleting members from group '%s'; Old count: %d; New count: %d",
groupId, len(group.MembersId()), len(newMembers))
if err := cl.updateAttribute(group.DN, "member", newMembers); err != nil {
return 0, err
}
return len(toDel), nil
}
func popDelGroupMembers(g *Group, toDel []string) []string {
result := []string{}
for _, memberDN := range g.MembersDn() {
if !slices.Contains(toDel, memberDN) {
result = append(result, memberDN)
}
}
return result
}
type CreateGroupArgs struct {
Id string
Attributes map[string][]string // Additional attributes to set in the new group.
}
func (args CreateGroupArgs) Validate() error {
if args.Id == "" {
return errors.New("Group ID is required")
}
return nil
}
// Creates a new group.
func (cl *Client) CreateGroup(args CreateGroupArgs) error {
if err := args.Validate(); err != nil {
return fmt.Errorf("Bad request: %w", err)
}
var attributes []ldap.Attribute
if len(args.Attributes) == 0 {
args.Attributes = make(map[string][]string)
}
// Setting up default attributes.
if _, ok := args.Attributes["objectClass"]; !ok {
args.Attributes["objectClass"] = []string{"group"}
}
if _, ok := args.Attributes["sAMAccountName"]; !ok {
args.Attributes["sAMAccountName"] = []string{args.Id}
}
if _, ok := args.Attributes["cn"]; !ok {
args.Attributes["cn"] = []string{args.Id}
}
for k, v := range args.Attributes {
attributes = append(attributes, ldap.Attribute{Type: k, Vals: v})
}
entryDn := fmt.Sprintf("CN=%s,%s", args.Id, cl.Config.Groups.SearchBase)
return cl.createEntry(entryDn, attributes)
}
// Deletes a group by ID.
func (cl *Client) DeleteGroup(groupId string) error {
entry, err := cl.GetGroup(GetGroupArgs{Id: groupId})
if err != nil {
return fmt.Errorf("Failed to get group: %w", err)
}
if entry == nil {
cl.logger.Debugf("Group '%s' already doesn't exist", groupId)
return nil
}
return cl.deleteEntry(entry.DN)
}