model.go 16.2 KB
Newer Older
ale's avatar
ale committed
1
2
3
4
5
6
7
package backend

import (
	"context"
	"strings"

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

	"git.autistici.org/ai3/accountserver"
)

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

27
// backend is the interface to an LDAP-backed user database.
ale's avatar
ale committed
28
29
30
31
32
//
// 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.
33
type backend struct {
ale's avatar
ale committed
34
	conn                ldapConn
ale's avatar
ale committed
35
	baseDN              string
36
37
	userQuery           *queryTemplate
	userResourceQueries []*queryTemplate
ale's avatar
ale committed
38
	resources           *resourceRegistry
ale's avatar
ale committed
39
40
}

ale's avatar
ale committed
41
42
// backendTX holds the business logic (that runs within a single
// transaction).
43
44
45
46
47
type backendTX struct {
	*ldapTX
	backend *backend
}

ale's avatar
ale committed
48
49
const ldapPoolSize = 20

50
51
52
53
54
55
56
func (b *backend) NewTransaction() (accountserver.TX, error) {
	return &backendTX{
		ldapTX:  newLDAPTX(b.conn),
		backend: b,
	}, nil
}

ale's avatar
ale committed
57
58
// NewLDAPBackend initializes an LDAPBackend object with the given LDAP
// connection pool.
59
func NewLDAPBackend(uri, bindDN, bindPw, base string) (accountserver.Backend, error) {
ale's avatar
ale committed
60
61
62
63
	pool, err := ldaputil.NewConnectionPool(uri, bindDN, bindPw, ldapPoolSize)
	if err != nil {
		return nil, err
	}
64
65
	return newLDAPBackendWithConn(pool, base)
}
ale's avatar
ale committed
66

67
func newLDAPBackendWithConn(conn ldapConn, base string) (*backend, error) {
ale's avatar
ale committed
68
69
70
71
72
73
74
75
	rsrc := newResourceRegistry()
	rsrc.register(accountserver.ResourceTypeEmail, &emailResourceHandler{baseDN: base})
	rsrc.register(accountserver.ResourceTypeMailingList, &mailingListResourceHandler{baseDN: base})
	rsrc.register(accountserver.ResourceTypeDAV, &webdavResourceHandler{baseDN: base})
	rsrc.register(accountserver.ResourceTypeWebsite, &websiteResourceHandler{baseDN: base})
	rsrc.register(accountserver.ResourceTypeDomain, &domainResourceHandler{baseDN: base})
	rsrc.register(accountserver.ResourceTypeDatabase, &databaseResourceHandler{baseDN: base})

76
	return &backend{
ale's avatar
ale committed
77
78
		conn:   conn,
		baseDN: base,
79
80
81
82
83
84
		userQuery: &queryTemplate{
			Base:   joinDN("uid=${user}", "ou=People", base),
			Filter: "(objectClass=*)",
			Scope:  ldap.ScopeBaseObject,
		},
		userResourceQueries: []*queryTemplate{
ale's avatar
ale committed
85
			// Find all resources that are children of the main uid object.
86
87
88
89
			&queryTemplate{
				Base:  joinDN("uid=${user}", "ou=People", base),
				Scope: ldap.ScopeWholeSubtree,
			},
ale's avatar
ale committed
90
			// Find mailing lists, which are nested under a different root.
91
92
			&queryTemplate{
				Base:   joinDN("ou=Lists", base),
ale's avatar
ale committed
93
				Filter: "(&(objectClass=mailingList)(listOwner=${user}))",
94
95
				Scope:  ldap.ScopeSingleLevel,
			},
ale's avatar
ale committed
96
		},
ale's avatar
ale committed
97
		resources: rsrc,
ale's avatar
ale committed
98
	}, nil
ale's avatar
ale committed
99
100
101
102
}

func newUser(entry *ldap.Entry) (*accountserver.User, error) {
	user := &accountserver.User{
103
104
105
106
		Name:   entry.GetAttributeValue("uid"),
		Lang:   entry.GetAttributeValue(preferredLanguageLDAPAttr),
		Has2FA: (entry.GetAttributeValue(totpSecretLDAPAttr) != ""),
		//HasEncryptionKeys: (len(entry.GetAttributeValues("storageEncryptionKey")) > 0),
ale's avatar
ale committed
107
		//PasswordRecoveryHint: entry.GetAttributeValue("recoverQuestion"),
108
		U2FRegistrations: decodeU2FRegistrations(entry.GetAttributeValues(u2fRegistrationsLDAPAttr)),
ale's avatar
ale committed
109
110
111
112
113
114
115
	}
	if user.Lang == "" {
		user.Lang = "en"
	}
	return user, nil
}

ale's avatar
ale committed
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
func userToLDAP(user *accountserver.User) (attrs []ldap.PartialAttribute) {
	// 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)},
		{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)},
131
		{Type: u2fRegistrationsLDAPAttr, Vals: encodeU2FRegistrations(user.U2FRegistrations)},
ale's avatar
ale committed
132
133
134
135
	}...)
	return
}

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
func decodeU2FRegistration(enc string) (*u2f.Registration, error) {
	var reg u2f.Registration
	if err := reg.UnmarshalBinary([]byte(enc)); err != nil {
		return nil, err
	}
	return &reg, nil
}

func encodeU2FRegistration(r *u2f.Registration) string {
	b, _ := r.MarshalBinary()
	return string(b)
}

func decodeU2FRegistrations(encRegs []string) []*u2f.Registration {
	var out []*u2f.Registration
	for _, enc := range encRegs {
		if r, err := decodeU2FRegistration(enc); err == nil {
			out = append(out, r)
		}
	}
	return out
}

func encodeU2FRegistrations(regs []*u2f.Registration) []string {
	var out []string
	for _, r := range regs {
		out = append(out, encodeU2FRegistration(r))
	}
	return out
}

ale's avatar
ale committed
167
168
func (tx *backendTX) getUserDN(user *accountserver.User) string {
	return joinDN("uid="+user.Name, "ou=People", tx.backend.baseDN)
ale's avatar
ale committed
169
170
}

ale's avatar
ale committed
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
// CreateUser creates a new user.
func (tx *backendTX) CreateUser(ctx context.Context, user *accountserver.User) error {
	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
}

190
191
192
193
194
195
196
197
198
// UpdateUser updates values for the user only (not the resources).
func (tx *backendTX) UpdateUser(ctx context.Context, user *accountserver.User) error {
	dn := tx.getUserDN(user)
	for _, attr := range userToLDAP(user) {
		tx.setAttr(dn, attr.Type, attr.Vals...)
	}
	return nil
}

ale's avatar
ale committed
199
// GetUser returns a user.
200
func (tx *backendTX) GetUser(ctx context.Context, username string) (*accountserver.User, error) {
ale's avatar
ale committed
201
202
	// First of all, find the main user object, and just that one.
	vars := map[string]string{"user": username}
203
	result, err := tx.search(ctx, tx.backend.userQuery.query(vars))
ale's avatar
ale committed
204
205
206
207
208
209
	if err != nil {
		if ldap.IsErrorWithCode(err, ldap.LDAPResultNoSuchObject) {
			return nil, nil
		}
		return nil, err
	}
210
211
212
	if len(result.Entries) == 0 {
		return nil, nil
	}
ale's avatar
ale committed
213
214
215
216
217
218
219
220
221
222

	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.
223
224
	for _, tpl := range tx.backend.userResourceQueries {
		result, err = tx.search(ctx, tpl.query(vars))
ale's avatar
ale committed
225
226
227
228
229
230
231
232
233
		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") {
ale's avatar
ale committed
234
				user.PasswordRecoveryHint = entry.GetAttributeValue(recoveryHintLDAPAttr)
235
236
				user.AppSpecificPasswords = getASPInfo(decodeAppSpecificPasswords(entry.GetAttributeValues(aspLDAPAttr)))
				user.HasEncryptionKeys = (entry.GetAttributeValue(storagePublicKeyLDAPAttr) != "")
ale's avatar
ale committed
237
			}
ale's avatar
ale committed
238

ale's avatar
ale committed
239
			// Parse the resource and add it to the User.
ale's avatar
ale committed
240
			if r, err := tx.backend.resources.FromLDAP(entry); err == nil {
ale's avatar
ale committed
241
242
243
244
245
246
247
248
249
250
				user.Resources = append(user.Resources, r)
			}
		}
	}

	groupWebResourcesByHomedir(user.Resources)

	return user, nil
}

251
func (tx *backendTX) SetUserPassword(ctx context.Context, user *accountserver.User, encryptedPassword string) error {
252
253
254
255
256
257
	dn := tx.getUserDN(user)
	tx.setAttr(dn, passwordLDAPAttr, encryptedPassword)
	for _, r := range user.GetResourcesByType(accountserver.ResourceTypeEmail) {
		dn, _ = tx.backend.resources.GetDN(r.ID)
		tx.setAttr(dn, passwordLDAPAttr, encryptedPassword)
	}
258
	return nil
ale's avatar
ale committed
259
260
}

261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
func (tx *backendTX) GetUserEncryptedPassword(ctx context.Context, user *accountserver.User) string {
	values := tx.readAttributeValues(ctx, tx.getUserDN(user), passwordLDAPAttr)
	if len(values) > 0 {
		// Remove legacy LDAP encryption prefix.
		return strings.TrimPrefix(values[0], "{crypt}")
	}
	return ""
}

func (tx *backendTX) GetUserRecoveryEncryptedPassword(ctx context.Context, user *accountserver.User) string {
	values := tx.readAttributeValues(ctx, tx.getUserDN(user), recoveryResponseLDAPAttr)
	if len(values) > 0 {
		// Remove legacy LDAP encryption prefix.
		return strings.TrimPrefix(values[0], "{crypt}")
	}
	return ""
}

ale's avatar
ale committed
279
280
281
282
283
284
285
func (tx *backendTX) SetPasswordRecoveryHint(ctx context.Context, user *accountserver.User, hint, response string) error {
	dn := tx.getUserDN(user)
	tx.setAttr(dn, recoveryHintLDAPAttr, hint)
	tx.setAttr(dn, recoveryResponseLDAPAttr, response)
	return nil
}

286
func (tx *backendTX) GetUserEncryptionKeys(ctx context.Context, user *accountserver.User) ([]*accountserver.UserEncryptionKey, error) {
287
288
289
	r := user.GetSingleResourceByType(accountserver.ResourceTypeEmail)
	dn, _ := tx.backend.resources.GetDN(r.ID)
	rawKeys := tx.readAttributeValues(ctx, dn, storagePrivateKeyLDAPAttr)
290
	return decodeUserEncryptionKeys(rawKeys), nil
ale's avatar
ale committed
291
292
}

293
func (tx *backendTX) SetUserEncryptionKeys(ctx context.Context, user *accountserver.User, keys []*accountserver.UserEncryptionKey) error {
294
	encKeys := encodeUserEncryptionKeys(keys)
295
296
297
298
	for _, r := range user.GetResourcesByType(accountserver.ResourceTypeEmail) {
		dn, _ := tx.backend.resources.GetDN(r.ID)
		tx.setAttr(dn, storagePrivateKeyLDAPAttr, encKeys...)
	}
299
	return nil
ale's avatar
ale committed
300
301
}

302
func (tx *backendTX) SetUserEncryptionPublicKey(ctx context.Context, user *accountserver.User, pub []byte) error {
303
304
305
306
	for _, r := range user.GetResourcesByType(accountserver.ResourceTypeEmail) {
		dn, _ := tx.backend.resources.GetDN(r.ID)
		tx.setAttr(dn, storagePublicKeyLDAPAttr, string(pub))
	}
307
308
309
310
311
312
313
314
315
	return nil
}

func excludeASPFromList(asps []*appSpecificPassword, id string) []*appSpecificPassword {
	var out []*appSpecificPassword
	for _, asp := range asps {
		if asp.ID != id {
			out = append(out, asp)
		}
316
	}
317
	return out
318
319
}

320
321
func (tx *backendTX) setASPOnResource(ctx context.Context, r *accountserver.Resource, info *accountserver.AppSpecificPasswordInfo, encryptedPassword string) {
	dn, _ := tx.backend.resources.GetDN(r.ID)
ale's avatar
ale committed
322

323
	// Obtain the full list of ASPs from the backend and replace/append the new one.
324
	asps := decodeAppSpecificPasswords(tx.readAttributeValues(ctx, dn, aspLDAPAttr))
325
326
	asps = append(excludeASPFromList(asps, info.ID), newAppSpecificPassword(*info, encryptedPassword))
	outASPs := encodeAppSpecificPasswords(asps)
327
	tx.setAttr(dn, aspLDAPAttr, outASPs...)
ale's avatar
ale committed
328
329
}

330
331
332
func (tx *backendTX) SetApplicationSpecificPassword(ctx context.Context, user *accountserver.User, info *accountserver.AppSpecificPasswordInfo, encryptedPassword string) error {
	for _, r := range user.GetResourcesByType(accountserver.ResourceTypeEmail) {
		tx.setASPOnResource(ctx, r, info, encryptedPassword)
ale's avatar
ale committed
333
	}
334
335
	return nil
}
ale's avatar
ale committed
336

337
338
339
func (tx *backendTX) deleteASPOnResource(ctx context.Context, r *accountserver.Resource, id string) {
	dn, _ := tx.backend.resources.GetDN(r.ID)
	asps := decodeAppSpecificPasswords(tx.readAttributeValues(ctx, dn, aspLDAPAttr))
340
341
	asps = excludeASPFromList(asps, id)
	outASPs := encodeAppSpecificPasswords(asps)
342
343
	tx.setAttr(dn, aspLDAPAttr, outASPs...)
}
ale's avatar
ale committed
344

345
346
347
348
func (tx *backendTX) DeleteApplicationSpecificPassword(ctx context.Context, user *accountserver.User, id string) error {
	for _, r := range user.GetResourcesByType(accountserver.ResourceTypeEmail) {
		tx.deleteASPOnResource(ctx, r, id)
	}
349
	return nil
ale's avatar
ale committed
350
351
}

352
func (tx *backendTX) SetUserTOTPSecret(ctx context.Context, user *accountserver.User, secret string) error {
353
	tx.setAttr(tx.getUserDN(user), totpSecretLDAPAttr, secret)
354
	return nil
ale's avatar
ale committed
355
356
}

357
func (tx *backendTX) DeleteUserTOTPSecret(ctx context.Context, user *accountserver.User) error {
358
	tx.setAttr(tx.getUserDN(user), totpSecretLDAPAttr)
359
	return nil
ale's avatar
ale committed
360
361
}

362
func (tx *backendTX) SetResourcePassword(ctx context.Context, r *accountserver.Resource, encryptedPassword string) error {
ale's avatar
ale committed
363
	dn, _ := tx.backend.resources.GetDN(r.ID)
364
	tx.setAttr(dn, passwordLDAPAttr, encryptedPassword)
365
	return nil
ale's avatar
ale committed
366
367
}

ale's avatar
ale committed
368
func (tx *backendTX) hasResource(ctx context.Context, resourceType, resourceName string) (bool, error) {
369
	tpl, err := tx.backend.resources.SearchQuery(resourceType)
ale's avatar
ale committed
370
371
	if err != nil {
		return false, err
ale's avatar
ale committed
372
373
374
	}

	// Make a quick LDAP search that only fetches the DN attribute.
375
376
	tpl.Attrs = []string{"dn"}
	result, err := tx.search(ctx, tpl.query(map[string]string{
ale's avatar
ale committed
377
378
		"resource": resourceName,
		"type":     resourceType,
379
	}))
ale's avatar
ale committed
380
381
382
383
384
385
386
387
388
389
390
391
392
	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.
ale's avatar
ale committed
393
394
395
func (tx *backendTX) HasAnyResource(ctx context.Context, resourceIDs []accountserver.FindResourceRequest) (bool, error) {
	for _, req := range resourceIDs {
		has, err := tx.hasResource(ctx, req.Type, req.Name)
ale's avatar
ale committed
396
397
398
399
400
401
402
		if err != nil || has {
			return has, err
		}
	}
	return false, nil
}

403
// GetResource returns a ResourceWrapper, as part of a read-modify-update transaction.
404
func (tx *backendTX) GetResource(ctx context.Context, rsrcID accountserver.ResourceID) (*accountserver.Resource, error) {
ale's avatar
ale committed
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
	// 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)
426
427
428
429
430
431
432
	if err != nil {
		if ldap.IsErrorWithCode(err, ldap.LDAPResultNoSuchObject) {
			return nil, nil
		}
		return nil, err
	}

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

ale's avatar
ale committed
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
// CreateResource creates a new LDAP-backed resource object.
func (tx *backendTX) CreateResource(ctx context.Context, r *accountserver.Resource) error {
	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
}

452
// UpdateResource updates a LDAP-backed resource that was obtained by a previous GetResource call.
453
func (tx *backendTX) UpdateResource(ctx context.Context, r *accountserver.Resource) error {
ale's avatar
ale committed
454
455
456
457
	dn, err := tx.backend.resources.GetDN(r.ID)
	if err != nil {
		return err
	}
458

459
460
	// 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
461
	for _, attr := range tx.backend.resources.ToLDAP(r) {
462
		tx.setAttr(dn, attr.Type, attr.Vals...)
463
464
	}

465
	return nil
466
467
}

ale's avatar
ale committed
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
var siteRoot = "/home/users/investici.org/"

// The hosting directory for a website is the path component immediately after
// siteRoot. This works also for sites with nested documentRoots.
func getHostingDir(path string) string {
	path = strings.TrimPrefix(path, siteRoot)
	if i := strings.Index(path, "/"); i > 0 {
		return path[:i]
	}
	return path
}

// This is a very specific function meant to address a peculiar characteristic
// of the A/I legacy data model, where DAV accounts and websites do not have an
// explicit relation.
func groupWebResourcesByHomedir(resources []*accountserver.Resource) {
	// Set the group name to be the 'hostingDir' for sites and DAV
	// accounts. Keep a reference of websites by ID so we can later fix the
	// group for databases too, via their ParentID.
	webs := make(map[string]*accountserver.Resource)
	for _, r := range resources {
ale's avatar
ale committed
489
		switch r.ID.Type() {
490
		case accountserver.ResourceTypeWebsite, accountserver.ResourceTypeDomain:
ale's avatar
ale committed
491
			r.Group = getHostingDir(r.Website.DocumentRoot)
492
			webs[r.ID.String()] = r
ale's avatar
ale committed
493
494
495
496
497
498
		case accountserver.ResourceTypeDAV:
			r.Group = getHostingDir(r.DAV.Homedir)
		}
	}
	// Fix databases in a second pass.
	for _, r := range resources {
ale's avatar
ale committed
499
		if r.ID.Type() == accountserver.ResourceTypeDatabase && !r.ParentID.Empty() {
500
			r.Group = webs[r.ParentID.String()].Group
ale's avatar
ale committed
501
502
503
		}
	}
}