model.go 16.6 KB
Newer Older
ale's avatar
ale committed
1
2
3
4
package backend

import (
	"context"
ale's avatar
ale committed
5
6
7
	"fmt"
	"math/rand"
	"strconv"
ale's avatar
ale committed
8
9
10
	"strings"

	ldaputil "git.autistici.org/ai3/go-common/ldap"
11
	"github.com/tstranex/u2f"
ale's avatar
ale committed
12
13
	"gopkg.in/ldap.v2"

14
	as "git.autistici.org/ai3/accountserver"
ale's avatar
ale committed
15
16
)

17
18
19
20
const (
	// Names of some well-known LDAP attributes.
	totpSecretLDAPAttr        = "totpSecret"
	preferredLanguageLDAPAttr = "preferredLanguage"
ale's avatar
ale committed
21
22
	recoveryHintLDAPAttr      = "recoverQuestion"
	recoveryResponseLDAPAttr  = "recoverAnswer"
23
24
25
26
	aspLDAPAttr               = "appSpecificPassword"
	storagePublicKeyLDAPAttr  = "storagePublicKey"
	storagePrivateKeyLDAPAttr = "storageEncryptedSecretKey"
	passwordLDAPAttr          = "userPassword"
27
	u2fRegistrationsLDAPAttr  = "u2fRegistration"
ale's avatar
ale committed
28
	uidNumberLDAPAttr         = "uidNumber"
29
30
)

31
// backend is the interface to an LDAP-backed user database.
ale's avatar
ale committed
32
33
34
35
36
//
// We keep a set of LDAP queries for each resource type, each having a
// "resource" query to return a specific resource belonging to a user,
// and a "presence" query that checks for existence of a resource for
// all users.
37
type backend struct {
ale's avatar
ale committed
38
	conn                ldapConn
ale's avatar
ale committed
39
	baseDN              string
40
41
	userQuery           *queryTemplate
	userResourceQueries []*queryTemplate
ale's avatar
ale committed
42
	resources           *resourceRegistry
ale's avatar
ale committed
43
44
45

	// Range for new user IDs.
	minUID, maxUID int
ale's avatar
ale committed
46
47
}

ale's avatar
ale committed
48
49
50
51
52
const (
	defaultMinUID = 10000
	defaultMaxUID = 1000000
)

ale's avatar
ale committed
53
54
// backendTX holds the business logic (that runs within a single
// transaction).
55
56
57
58
59
type backendTX struct {
	*ldapTX
	backend *backend
}

ale's avatar
ale committed
60
61
const ldapPoolSize = 20

62
func (b *backend) NewTransaction() (as.TX, error) {
63
64
65
66
67
68
	return &backendTX{
		ldapTX:  newLDAPTX(b.conn),
		backend: b,
	}, nil
}

ale's avatar
ale committed
69
70
// NewLDAPBackend initializes an LDAPBackend object with the given LDAP
// connection pool.
71
func NewLDAPBackend(uri, bindDN, bindPw, base string) (as.Backend, error) {
ale's avatar
ale committed
72
73
74
75
	pool, err := ldaputil.NewConnectionPool(uri, bindDN, bindPw, ldapPoolSize)
	if err != nil {
		return nil, err
	}
76
77
	return newLDAPBackendWithConn(pool, base)
}
ale's avatar
ale committed
78

79
func newLDAPBackendWithConn(conn ldapConn, base string) (*backend, error) {
ale's avatar
ale committed
80
	rsrc := newResourceRegistry()
81
82
83
84
85
86
	rsrc.register(as.ResourceTypeEmail, &emailResourceHandler{baseDN: base})
	rsrc.register(as.ResourceTypeMailingList, &mailingListResourceHandler{baseDN: base})
	rsrc.register(as.ResourceTypeDAV, &webdavResourceHandler{baseDN: base})
	rsrc.register(as.ResourceTypeWebsite, &websiteResourceHandler{baseDN: base})
	rsrc.register(as.ResourceTypeDomain, &domainResourceHandler{baseDN: base})
	rsrc.register(as.ResourceTypeDatabase, &databaseResourceHandler{baseDN: base})
ale's avatar
ale committed
87

88
	return &backend{
ale's avatar
ale committed
89
90
		conn:   conn,
		baseDN: base,
91
92
93
94
95
96
		userQuery: &queryTemplate{
			Base:   joinDN("uid=${user}", "ou=People", base),
			Filter: "(objectClass=*)",
			Scope:  ldap.ScopeBaseObject,
		},
		userResourceQueries: []*queryTemplate{
ale's avatar
ale committed
97
			// Find all resources that are children of the main uid object.
98
99
100
101
			&queryTemplate{
				Base:  joinDN("uid=${user}", "ou=People", base),
				Scope: ldap.ScopeWholeSubtree,
			},
ale's avatar
ale committed
102
			// Find mailing lists, which are nested under a different root.
103
104
			&queryTemplate{
				Base:   joinDN("ou=Lists", base),
ale's avatar
ale committed
105
				Filter: "(&(objectClass=mailingList)(listOwner=${user}))",
106
107
				Scope:  ldap.ScopeSingleLevel,
			},
ale's avatar
ale committed
108
		},
ale's avatar
ale committed
109
		resources: rsrc,
ale's avatar
ale committed
110
111
		minUID:    defaultMinUID,
		maxUID:    defaultMaxUID,
ale's avatar
ale committed
112
	}, nil
ale's avatar
ale committed
113
114
}

115
func newUser(entry *ldap.Entry) (*as.RawUser, error) {
116
117
118
119
120
121
122
123
	// Note that some user-level attributes related to
	// authentication are stored on the uid= object, while others
	// are on the email= object. We set the latter in the GetUser
	// function later.
	//
	// The case of password recovery attributes is more complex:
	// the current schema has those on email=, but we'd like to
	// move them to uid=, so we currently have to support both.
124
	uidNumber, _ := strconv.Atoi(entry.GetAttributeValue(uidNumberLDAPAttr)) // nolint
125
126
127
128
129
130
131
132
133
134
135
136
	user := &as.RawUser{
		User: as.User{
			Name:                 entry.GetAttributeValue("uid"),
			Lang:                 entry.GetAttributeValue(preferredLanguageLDAPAttr),
			UID:                  uidNumber,
			PasswordRecoveryHint: entry.GetAttributeValue(recoveryHintLDAPAttr),
			U2FRegistrations:     decodeU2FRegistrations(entry.GetAttributeValues(u2fRegistrationsLDAPAttr)),
			HasOTP:               entry.GetAttributeValue(totpSecretLDAPAttr) != "",
		},
		// Remove the legacy LDAP {crypt} prefix on old passwords.
		Password:         strings.TrimPrefix(entry.GetAttributeValue(passwordLDAPAttr), "{crypt}"),
		RecoveryPassword: strings.TrimPrefix(entry.GetAttributeValue(recoveryResponseLDAPAttr), "{crypt}"),
ale's avatar
ale committed
137
	}
138
139

	// The user has 2FA enabled if it has a TOTP secret or U2F keys.
140
	user.Has2FA = (user.HasOTP || (len(user.U2FRegistrations) > 0))
141

ale's avatar
ale committed
142
143
144
145
146
147
	if user.Lang == "" {
		user.Lang = "en"
	}
	return user, nil
}

148
func userToLDAP(user *as.User) (attrs []ldap.PartialAttribute) {
ale's avatar
ale committed
149
150
151
152
153
	// Most attributes are read-only and have specialized methods to set them.
	attrs = append(attrs, []ldap.PartialAttribute{
		{Type: "objectClass", Vals: []string{"top", "person", "posixAccount", "shadowAccount", "organizationalPerson", "inetOrgPerson", "totpAccount"}},
		{Type: "uid", Vals: s2l(user.Name)},
		{Type: "cn", Vals: s2l(user.Name)},
ale's avatar
ale committed
154
		{Type: uidNumberLDAPAttr, Vals: s2l(strconv.Itoa(user.UID))},
ale's avatar
ale committed
155
156
157
158
159
160
161
162
163
		{Type: "givenName", Vals: []string{"Private"}},
		{Type: "sn", Vals: []string{"Private"}},
		{Type: "gecos", Vals: s2l(user.Name)},
		{Type: "loginShell", Vals: []string{"/bin/false"}},
		{Type: "homeDirectory", Vals: []string{"/var/empty"}},
		{Type: "shadowLastChange", Vals: []string{"12345"}},
		{Type: "shadowWarning", Vals: []string{"7"}},
		{Type: "shadowMax", Vals: []string{"99999"}},
		{Type: preferredLanguageLDAPAttr, Vals: s2l(user.Lang)},
164
		{Type: u2fRegistrationsLDAPAttr, Vals: encodeU2FRegistrations(user.U2FRegistrations)},
ale's avatar
ale committed
165
166
167
168
	}...)
	return
}

169
func decodeU2FRegistration(enc string) (*as.U2FRegistration, error) {
170
171
172
173
	var reg u2f.Registration
	if err := reg.UnmarshalBinary([]byte(enc)); err != nil {
		return nil, err
	}
174
	return &as.U2FRegistration{Registration: &reg}, nil
175
176
}

177
178
179
func encodeU2FRegistration(r *as.U2FRegistration) string {
	// MarshalBinary can't fail, ignore error.
	b, _ := r.MarshalBinary() // nolint
180
181
182
	return string(b)
}

183
184
func decodeU2FRegistrations(encRegs []string) []*as.U2FRegistration {
	var out []*as.U2FRegistration
185
186
187
188
189
190
191
192
	for _, enc := range encRegs {
		if r, err := decodeU2FRegistration(enc); err == nil {
			out = append(out, r)
		}
	}
	return out
}

193
func encodeU2FRegistrations(regs []*as.U2FRegistration) []string {
194
195
196
197
198
199
200
	var out []string
	for _, r := range regs {
		out = append(out, encodeU2FRegistration(r))
	}
	return out
}

201
func (tx *backendTX) getUserDN(user *as.User) string {
ale's avatar
ale committed
202
	return joinDN("uid="+user.Name, "ou=People", tx.backend.baseDN)
ale's avatar
ale committed
203
204
}

ale's avatar
ale committed
205
// CreateUser creates a new user.
206
func (tx *backendTX) CreateUser(ctx context.Context, user *as.User) error {
ale's avatar
ale committed
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
	dn := tx.getUserDN(user)

	tx.create(dn)
	for _, attr := range userToLDAP(user) {
		tx.setAttr(dn, attr.Type, attr.Vals...)
	}

	// Create all resources.
	for _, r := range user.Resources {
		if err := tx.CreateResource(ctx, r); err != nil {
			return err
		}
	}

	return nil
}

224
// UpdateUser updates values for the user only (not the resources).
225
func (tx *backendTX) UpdateUser(ctx context.Context, user *as.User) error {
226
227
228
229
230
231
232
	dn := tx.getUserDN(user)
	for _, attr := range userToLDAP(user) {
		tx.setAttr(dn, attr.Type, attr.Vals...)
	}
	return nil
}

ale's avatar
ale committed
233
// GetUser returns a user.
234
func (tx *backendTX) GetUser(ctx context.Context, username string) (*as.RawUser, error) {
ale's avatar
ale committed
235
236
	// First of all, find the main user object, and just that one.
	vars := map[string]string{"user": username}
237
	result, err := tx.search(ctx, tx.backend.userQuery.query(vars))
ale's avatar
ale committed
238
239
240
241
242
243
	if err != nil {
		if ldap.IsErrorWithCode(err, ldap.LDAPResultNoSuchObject) {
			return nil, nil
		}
		return nil, err
	}
244
245
246
	if len(result.Entries) == 0 {
		return nil, nil
	}
ale's avatar
ale committed
247
248
249
250
251
252
253
254
255
256

	user, err := newUser(result.Entries[0])
	if err != nil {
		return nil, err
	}

	// Now run the resource queries, and accumulate results on the User
	// object we just created.
	// TODO: parallelize.
	// TODO: add support for non-LDAP resource queries.
257
258
	for _, tpl := range tx.backend.userResourceQueries {
		result, err = tx.search(ctx, tpl.query(vars))
ale's avatar
ale committed
259
260
261
262
263
264
265
266
267
		if err != nil {
			continue
		}

		for _, entry := range result.Entries {
			// Some user-level attributes are actually stored on the email
			// object, a shortcoming of the legacy A/I database model. Set
			// them on the main User object.
			if isObjectClass(entry, "virtualMailUser") {
268
269
270
				if s := entry.GetAttributeValue(recoveryHintLDAPAttr); s != "" {
					user.PasswordRecoveryHint = s
				}
271
				user.AppSpecificPasswords = getASPInfo(decodeAppSpecificPasswords(entry.GetAttributeValues(aspLDAPAttr)))
272
273
				user.Keys = decodeUserEncryptionKeys(
					entry.GetAttributeValues(storagePrivateKeyLDAPAttr))
274
				user.HasEncryptionKeys = (entry.GetAttributeValue(storagePublicKeyLDAPAttr) != "")
ale's avatar
ale committed
275
			}
ale's avatar
ale committed
276

ale's avatar
ale committed
277
			// Parse the resource and add it to the User.
ale's avatar
ale committed
278
			if r, err := tx.backend.resources.FromLDAP(entry); err == nil {
ale's avatar
ale committed
279
280
281
282
283
284
285
286
				user.Resources = append(user.Resources, r)
			}
		}
	}

	return user, nil
}

287
func (tx *backendTX) SetUserPassword(ctx context.Context, user *as.User, encryptedPassword string) (err error) {
288
289
	dn := tx.getUserDN(user)
	tx.setAttr(dn, passwordLDAPAttr, encryptedPassword)
290
291
292
293
294
	for _, r := range user.GetResourcesByType(as.ResourceTypeEmail) {
		dn, err = tx.backend.resources.GetDN(r.ID)
		if err != nil {
			return
		}
295
296
		tx.setAttr(dn, passwordLDAPAttr, encryptedPassword)
	}
297
	return
ale's avatar
ale committed
298
299
}

300
func (tx *backendTX) SetPasswordRecoveryHint(ctx context.Context, user *as.User, hint, response string) error {
301
302
	// Write the password recovery attributes on the uid= object,
	// as per the new schema.
ale's avatar
ale committed
303
304
305
306
307
308
	dn := tx.getUserDN(user)
	tx.setAttr(dn, recoveryHintLDAPAttr, hint)
	tx.setAttr(dn, recoveryResponseLDAPAttr, response)
	return nil
}

309
310
311
312
313
314
315
func (tx *backendTX) DeletePasswordRecoveryHint(ctx context.Context, user *as.User) error {
	// Write the password recovery attributes on the uid= object,
	// as per the new schema.
	dn := tx.getUserDN(user)
	tx.setAttr(dn, recoveryHintLDAPAttr)
	tx.setAttr(dn, recoveryResponseLDAPAttr)
	return nil
ale's avatar
ale committed
316
317
}

318
func (tx *backendTX) SetUserEncryptionKeys(ctx context.Context, user *as.User, keys []*as.UserEncryptionKey) error {
319
	encKeys := encodeUserEncryptionKeys(keys)
320
321
322
323
324
	for _, r := range user.GetResourcesByType(as.ResourceTypeEmail) {
		dn, err := tx.backend.resources.GetDN(r.ID)
		if err != nil {
			return err
		}
325
326
		tx.setAttr(dn, storagePrivateKeyLDAPAttr, encKeys...)
	}
327
	return nil
ale's avatar
ale committed
328
329
}

330
331
332
333
334
335
func (tx *backendTX) SetUserEncryptionPublicKey(ctx context.Context, user *as.User, pub []byte) error {
	for _, r := range user.GetResourcesByType(as.ResourceTypeEmail) {
		dn, err := tx.backend.resources.GetDN(r.ID)
		if err != nil {
			return err
		}
336
337
		tx.setAttr(dn, storagePublicKeyLDAPAttr, string(pub))
	}
338
339
340
341
342
343
344
345
346
	return nil
}

func excludeASPFromList(asps []*appSpecificPassword, id string) []*appSpecificPassword {
	var out []*appSpecificPassword
	for _, asp := range asps {
		if asp.ID != id {
			out = append(out, asp)
		}
347
	}
348
	return out
349
350
}

351
352
353
354
355
func (tx *backendTX) setASPOnResource(ctx context.Context, r *as.Resource, info *as.AppSpecificPasswordInfo, encryptedPassword string) {
	dn, err := tx.backend.resources.GetDN(r.ID)
	if err != nil {
		return
	}
ale's avatar
ale committed
356

357
	// Obtain the full list of ASPs from the backend and replace/append the new one.
358
	asps := decodeAppSpecificPasswords(tx.readAttributeValues(ctx, dn, aspLDAPAttr))
359
360
	asps = append(excludeASPFromList(asps, info.ID), newAppSpecificPassword(*info, encryptedPassword))
	outASPs := encodeAppSpecificPasswords(asps)
361
	tx.setAttr(dn, aspLDAPAttr, outASPs...)
ale's avatar
ale committed
362
363
}

364
365
func (tx *backendTX) SetApplicationSpecificPassword(ctx context.Context, user *as.User, info *as.AppSpecificPasswordInfo, encryptedPassword string) error {
	for _, r := range user.GetResourcesByType(as.ResourceTypeEmail) {
366
		tx.setASPOnResource(ctx, r, info, encryptedPassword)
ale's avatar
ale committed
367
	}
368
369
	return nil
}
ale's avatar
ale committed
370

371
372
373
374
375
func (tx *backendTX) deleteASPOnResource(ctx context.Context, r *as.Resource, id string) {
	dn, err := tx.backend.resources.GetDN(r.ID)
	if err != nil {
		return
	}
376
	asps := decodeAppSpecificPasswords(tx.readAttributeValues(ctx, dn, aspLDAPAttr))
377
378
	asps = excludeASPFromList(asps, id)
	outASPs := encodeAppSpecificPasswords(asps)
379
380
	tx.setAttr(dn, aspLDAPAttr, outASPs...)
}
ale's avatar
ale committed
381

382
383
func (tx *backendTX) DeleteApplicationSpecificPassword(ctx context.Context, user *as.User, id string) error {
	for _, r := range user.GetResourcesByType(as.ResourceTypeEmail) {
384
385
		tx.deleteASPOnResource(ctx, r, id)
	}
386
	return nil
ale's avatar
ale committed
387
388
}

389
func (tx *backendTX) SetUserTOTPSecret(ctx context.Context, user *as.User, secret string) error {
390
	tx.setAttr(tx.getUserDN(user), totpSecretLDAPAttr, secret)
391
	return nil
ale's avatar
ale committed
392
393
}

394
func (tx *backendTX) DeleteUserTOTPSecret(ctx context.Context, user *as.User) error {
395
	tx.setAttr(tx.getUserDN(user), totpSecretLDAPAttr)
396
	return nil
ale's avatar
ale committed
397
398
}

399
400
401
402
403
func (tx *backendTX) SetResourcePassword(ctx context.Context, r *as.Resource, encryptedPassword string) error {
	dn, err := tx.backend.resources.GetDN(r.ID)
	if err != nil {
		return err
	}
404
	tx.setAttr(dn, passwordLDAPAttr, encryptedPassword)
405
	return nil
ale's avatar
ale committed
406
407
}

ale's avatar
ale committed
408
func (tx *backendTX) hasResource(ctx context.Context, resourceType, resourceName string) (bool, error) {
409
	tpl, err := tx.backend.resources.SearchQuery(resourceType)
ale's avatar
ale committed
410
411
	if err != nil {
		return false, err
ale's avatar
ale committed
412
413
414
	}

	// Make a quick LDAP search that only fetches the DN attribute.
415
416
	tpl.Attrs = []string{"dn"}
	result, err := tx.search(ctx, tpl.query(map[string]string{
ale's avatar
ale committed
417
418
		"resource": resourceName,
		"type":     resourceType,
419
	}))
ale's avatar
ale committed
420
421
422
423
424
425
426
427
428
429
430
431
432
	if err != nil {
		if ldap.IsErrorWithCode(err, ldap.LDAPResultNoSuchObject) {
			return false, nil
		}
		return false, err
	}
	if len(result.Entries) == 0 {
		return false, nil
	}
	return true, nil
}

// HasAnyResource returns true if any of the specified resources exists.
433
func (tx *backendTX) HasAnyResource(ctx context.Context, resourceIDs []as.FindResourceRequest) (bool, error) {
ale's avatar
ale committed
434
435
	for _, req := range resourceIDs {
		has, err := tx.hasResource(ctx, req.Type, req.Name)
ale's avatar
ale committed
436
437
438
439
440
441
442
		if err != nil || has {
			return has, err
		}
	}
	return false, nil
}

443
// GetResource returns a ResourceWrapper, as part of a read-modify-update transaction.
444
func (tx *backendTX) GetResource(ctx context.Context, rsrcID as.ResourceID) (*as.Resource, error) {
ale's avatar
ale committed
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
	// From the resource ID we can obtain the DN, and fetch it
	// straight from LDAP without even doing a real search.
	dn, err := tx.backend.resources.GetDN(rsrcID)
	if err != nil {
		return nil, err
	}

	// This is just a 'point' search.
	req := ldap.NewSearchRequest(
		dn,
		ldap.ScopeBaseObject,
		ldap.NeverDerefAliases,
		0,
		0,
		false,
		"(objectClass=*)",
		nil,
		nil,
	)

	result, err := tx.search(ctx, req)
466
467
468
469
470
471
472
	if err != nil {
		if ldap.IsErrorWithCode(err, ldap.LDAPResultNoSuchObject) {
			return nil, nil
		}
		return nil, err
	}

ale's avatar
ale committed
473
474
	// We know the resource type so we don't have to guess.
	return tx.backend.resources.FromLDAPWithType(rsrcID.Type(), result.Entries[0])
475
476
}

ale's avatar
ale committed
477
// CreateResource creates a new LDAP-backed resource object.
478
func (tx *backendTX) CreateResource(ctx context.Context, r *as.Resource) error {
ale's avatar
ale committed
479
480
481
482
483
484
485
486
487
488
489
490
491
	dn, err := tx.backend.resources.GetDN(r.ID)
	if err != nil {
		return err
	}

	tx.create(dn)
	for _, attr := range tx.backend.resources.ToLDAP(r) {
		tx.setAttr(dn, attr.Type, attr.Vals...)
	}

	return nil
}

492
// UpdateResource updates a LDAP-backed resource that was obtained by a previous GetResource call.
493
func (tx *backendTX) UpdateResource(ctx context.Context, r *as.Resource) error {
ale's avatar
ale committed
494
495
496
497
	dn, err := tx.backend.resources.GetDN(r.ID)
	if err != nil {
		return err
	}
498

499
500
	// We can simply dump all attribute/value pairs and let the
	// code in ldapTX do the work of finding the differences.
ale's avatar
ale committed
501
	for _, attr := range tx.backend.resources.ToLDAP(r) {
502
		tx.setAttr(dn, attr.Type, attr.Vals...)
503
504
	}

505
	return nil
506
507
}

ale's avatar
ale committed
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
// NextUID returns an available user ID (uidNumber). It does so
// without keeping state by just guessing random UIDs in the
// minUID-maxUID range, and checking if they are available (so it's
// best to keep the range largely underutilized).
func (tx *backendTX) NextUID(ctx context.Context) (uid int, err error) {
	// Won't actually run forever, at some point the context will expire.
	var ok bool
	for !ok && err == nil {
		uid = tx.backend.minUID + rand.Intn(tx.backend.maxUID-tx.backend.minUID)
		ok, err = tx.isUIDAvailable(ctx, uid)
	}
	return
}

func (tx *backendTX) isUIDAvailable(ctx context.Context, uid int) (bool, error) {
	// Try to make this query lightweight: ask for no attributes,
	// use a size limit of 1 and treat "Size Limit Exceeded"
	// errors as a successful result.
	result, err := tx.search(ctx, ldap.NewSearchRequest(
		tx.backend.baseDN,
		ldap.ScopeWholeSubtree,
		ldap.NeverDerefAliases,
		1, // just one result is enough
		0,
		false,
		fmt.Sprintf("(uidNumber=%d)", uid),
		[]string{"dn"},
		nil,
	))
	if err != nil {
		if ldap.IsErrorWithCode(err, ldap.LDAPResultSizeLimitExceeded) {
			return false, nil
		}
		return false, err
	}
	if len(result.Entries) > 0 {
		return false, nil
	}
	return true, nil
}