Start to support deleting profiles through the API.
Create a removeLoginsByProfile method on the profileStore, to allow an easy way
to bulk-delete logins associated with a Profile after the Profile has been
deleted.
Create postgres and memstore implementations of the removeLoginsByProfile
method.
Create a cleanUpAfterProfileDeletion helper method that will clean up the child
objects of a Profile (its Sessions, Tokens, Clients, etc.). The intended usage
is to call this in a goroutine after a Profile has been deleted, to try and get
things back in order.
Detect when the UpdateProfileHandler API is used to set the Deleted flag of a
Profile to true, and clean up after the Profile when that's the case.
Add a DeleteProfileHandler API endpoint that is a shortcut to setting the
Deleted flag of a Profile to true and cleaning up after the Profile.
The problem with our approach thus far is that some of it is reversible and some
is not. If a Profile is maliciously/accidentally deleted, it's simple enough to
use the API as a superuser to restore the Profile. But doing that will not (and
cannot) restore the Logins associated with that Profile, for example. While it
would be nice to add a Deleted flag to our Logins that we could simply toggle,
that would wreak havoc with our database constraints and ensuring uniqueness of
Login values. I still don't have a solution for this, outside the superuser
manually restoring a Login for the Profile, after which the user can
authenticate themselves and add more Logins as desired. But there has to be a
better way.
I suppose since the passphrase is being stored with the Profile and not the
Login, we could offer an endpoint that would automate this, but... well, that
would be tricky. It would require the user remembering their Profile ID, and
let's be honest, nobody's going to remember a UUID.
Maybe such an endpoint would help from a customer service standpoint: we
identify their Profile manually, then send them to /profiles/ID/restorelogin or
something, and that lets them add a Login back to the Profile.
I'll figure it out later. For now, we know we at least have enough information
to identify a user is who they say they are and resolve the situation manually.
12 "code.secondbit.org/uuid.hg"
13 "github.com/gorilla/mux"
17 // MinPassphraseLength is the minimum length, in bytes, of a passphrase, exclusive.
18 MinPassphraseLength = 6
19 // MaxPassphraseLength is the maximum length, in bytes, of a passphrase, exclusive.
20 MaxPassphraseLength = 64
21 // CurPassphraseScheme is the current passphrase scheme. Incrememnt it when we use a different passphrase scheme
22 CurPassphraseScheme = 1
23 // MaxNameLength is the maximum length, in bytes, of a name, exclusive.
25 // MaxEmailLength is the maximum length, in bytes, of an email address, exclusive.
30 // ErrNoProfileStore is returned when a Context tries to act on a profileStore without setting one first.
31 ErrNoProfileStore = errors.New("no profileStore was specified for the Context")
32 // ErrProfileAlreadyExists is returned when a Profile is added to a profileStore, but another Profile with
33 // the same ID already exists in the profileStore.
34 ErrProfileAlreadyExists = errors.New("profile already exists in profileStore")
35 // ErrProfileNotFound is returned when a Profile is requested but not found in the profileStore.
36 ErrProfileNotFound = errors.New("profile not found in profileStore")
37 // ErrLoginAlreadyExists is returned when a Login is added to a profileStore, but another Login with the same
38 // Type and Value already exists in the profileStore.
39 ErrLoginAlreadyExists = errors.New("login already exists in profileStore")
40 // ErrLoginNotFound is returned when a Login is requested but not found in the profileStore.
41 ErrLoginNotFound = errors.New("login not found in profileStore")
43 // ErrMissingPassphrase is returned when a ProfileChange is validated but does not contain a
44 // Passphrase, and requires one.
45 ErrMissingPassphrase = errors.New("missing passphrase")
46 // ErrMissingPassphraseReset is returned when a ProfileChange is validated but does not contain
47 // a PassphraseReset, and requires one.
48 ErrMissingPassphraseReset = errors.New("missing passphrase reset")
49 // ErrMissingPassphraseResetCreated is returned when a ProfileChange is validated but does not
50 // contain a PassphraseResetCreated, and requires one.
51 ErrMissingPassphraseResetCreated = errors.New("missing passphrase reset created timestamp")
52 // ErrPassphraseTooShort is returned when a ProfileChange is validated and contains a Passphrase,
53 // but the Passphrase is shorter than MinPassphraseLength.
54 ErrPassphraseTooShort = errors.New("passphrase too short")
55 // ErrPassphraseTooLong is returned when a ProfileChange is validated and contains a Passphrase,
56 // but the Passphrase is longer than MaxPassphraseLength.
57 ErrPassphraseTooLong = errors.New("passphrase too long")
59 // ErrProfileCompromised is returned when a user tries to log in with a profile that is suspected
60 // of being compromised.
61 ErrProfileCompromised = errors.New("profile compromised")
62 // ErrProfileLocked is returned when a user tries to log in with a profile that is locked for a certain
63 // duration, to prevent brute force attacks.
64 ErrProfileLocked = errors.New("profile locked")
67 // Profile represents a single user of the service,
68 // including their authentication information.
70 ID uuid.ID `json:"id,omitempty"`
71 Name string `json:"name,omitempty"`
72 Passphrase string `json:"-"`
73 Iterations int `json:"-"`
74 Salt string `json:"-"`
75 PassphraseScheme int `json:"-"`
76 Compromised bool `json:"-"`
77 LockedUntil time.Time `json:"-"`
78 PassphraseReset string `json:"-"`
79 PassphraseResetCreated time.Time `json:"-"`
80 Created time.Time `json:"created,omitempty"`
81 LastSeen time.Time `json:"last_seen,omitempty"`
82 Deleted bool `json:"deleted,omitempty"`
85 // ApplyChange applies the properties of the passed ProfileChange
86 // to the Profile it is called on.
87 func (p *Profile) ApplyChange(change ProfileChange) {
88 if change.Name != nil {
91 if change.Passphrase != nil {
92 p.Passphrase = *change.Passphrase
94 if change.Iterations != nil {
95 p.Iterations = *change.Iterations
97 if change.Salt != nil {
100 if change.PassphraseScheme != nil {
101 p.PassphraseScheme = *change.PassphraseScheme
103 if change.Compromised != nil {
104 p.Compromised = *change.Compromised
106 if change.LockedUntil != nil {
107 p.LockedUntil = *change.LockedUntil
109 if change.PassphraseReset != nil {
110 p.PassphraseReset = *change.PassphraseReset
112 if change.PassphraseResetCreated != nil {
113 p.PassphraseResetCreated = *change.PassphraseResetCreated
115 if change.LastSeen != nil {
116 p.LastSeen = *change.LastSeen
118 if change.Deleted != nil {
119 p.Deleted = *change.Deleted
123 // ApplyBulkChange applies the properties of the passed BulkProfileChange
124 // to the Profile it is called on.
125 func (p *Profile) ApplyBulkChange(change BulkProfileChange) {
126 if change.Compromised != nil {
127 p.Compromised = *change.Compromised
131 // ProfileChange represents a single atomic change to a Profile's mutable data.
132 type ProfileChange struct {
137 PassphraseScheme *int
139 LockedUntil *time.Time
140 PassphraseReset *string
141 PassphraseResetCreated *time.Time
146 func (c ProfileChange) Empty() bool {
147 return (c.Name == nil && c.Passphrase == nil && c.Iterations == nil && c.Salt == nil && c.PassphraseScheme == nil && c.Compromised == nil && c.LockedUntil == nil && c.PassphraseReset == nil && c.PassphraseResetCreated == nil && c.LastSeen == nil && c.Deleted == nil)
150 // Validate checks the ProfileChange it is called on
151 // and asserts its internal validity, or lack thereof.
152 // A descriptive error will be returned in the case of
153 // an invalid change.
154 func (c ProfileChange) Validate() error {
156 return ErrEmptyChange
158 if c.PassphraseScheme != nil && c.Passphrase == nil {
159 return ErrMissingPassphrase
161 if c.PassphraseReset != nil && c.PassphraseResetCreated == nil {
162 return ErrMissingPassphraseResetCreated
164 if c.PassphraseReset == nil && c.PassphraseResetCreated != nil {
165 return ErrMissingPassphraseReset
167 if c.Salt != nil && c.Passphrase == nil {
168 return ErrMissingPassphrase
170 if c.Iterations != nil && c.Passphrase == nil {
171 return ErrMissingPassphrase
176 // BulkProfileChange represents a single atomic change to many Profiles' mutable data.
177 // It is a subset of a ProfileChange, as it doesn't make sense to mutate some of the
178 // ProfileChange values across many Profiles all at once.
179 type BulkProfileChange struct {
183 func (b BulkProfileChange) Empty() bool {
184 return b.Compromised == nil
187 // Validate checks the BulkProfileChange it is called on
188 // and asserts its internal validity, or lack thereof.
189 // A descriptive error will be returned in the case of an
191 func (b BulkProfileChange) Validate() error {
193 return ErrEmptyChange
198 // Login represents a single human-friendly identifier for
199 // a given Profile that can be used to log into that Profile.
200 // Each Profile may only have one Login for each Type.
202 Type string `json:"type,omitempty"`
203 Value string `json:"value,omitempty"`
204 ProfileID uuid.ID `json:"profile_id,omitempty"`
205 Created time.Time `json:"created,omitempty"`
206 LastUsed time.Time `json:"last_used,omitempty"`
209 type newProfileRequest struct {
210 Email string `json:"email"`
211 Passphrase string `json:"passphrase"`
212 Name string `json:"name"`
215 func validateNewProfileRequest(req *newProfileRequest) []requestError {
216 errors := []requestError{}
217 req.Name = strings.TrimSpace(req.Name)
218 req.Email = strings.TrimSpace(req.Email)
219 if len(req.Passphrase) < MinPassphraseLength {
220 errors = append(errors, requestError{
221 Slug: requestErrInsufficient,
222 Field: "/passphrase",
225 if len(req.Passphrase) > MaxPassphraseLength {
226 errors = append(errors, requestError{
227 Slug: requestErrOverflow,
228 Field: "/passphrase",
231 if len(req.Name) > MaxNameLength {
232 errors = append(errors, requestError{
233 Slug: requestErrOverflow,
238 errors = append(errors, requestError{
239 Slug: requestErrMissing,
243 if len(req.Email) > MaxEmailLength {
244 errors = append(errors, requestError{
245 Slug: requestErrOverflow,
249 re := regexp.MustCompile(".+@.+\\..+")
250 if !re.Match([]byte(req.Email)) {
251 errors = append(errors, requestError{
252 Slug: requestErrInvalidFormat,
259 type profileStore interface {
260 getProfileByID(id uuid.ID) (Profile, error)
261 getProfileByLogin(value string) (Profile, error)
262 saveProfile(profile Profile) error
263 updateProfile(id uuid.ID, change ProfileChange) error
264 updateProfiles(ids []uuid.ID, change BulkProfileChange) error
266 addLogin(login Login) error
267 removeLogin(value string, profile uuid.ID) error
268 removeLoginsByProfile(profile uuid.ID) error
269 recordLoginUse(value string, when time.Time) error
270 listLogins(profile uuid.ID, num, offset int) ([]Login, error)
273 func (m *memstore) getProfileByID(id uuid.ID) (Profile, error) {
274 m.profileLock.RLock()
275 defer m.profileLock.RUnlock()
276 p, ok := m.profiles[id.String()]
278 return Profile{}, ErrProfileNotFound
281 return Profile{}, ErrProfileNotFound
286 func (m *memstore) getProfileByLogin(value string) (Profile, error) {
288 defer m.loginLock.RUnlock()
289 login, ok := m.logins[value]
291 return Profile{}, ErrLoginNotFound
293 m.profileLock.RLock()
294 defer m.profileLock.RUnlock()
295 profile, ok := m.profiles[login.ProfileID.String()]
297 return Profile{}, ErrProfileNotFound
300 return Profile{}, ErrProfileNotFound
305 func (m *memstore) saveProfile(profile Profile) error {
307 defer m.profileLock.Unlock()
308 _, ok := m.profiles[profile.ID.String()]
310 return ErrProfileAlreadyExists
312 m.profiles[profile.ID.String()] = profile
316 func (m *memstore) updateProfile(id uuid.ID, change ProfileChange) error {
318 defer m.profileLock.Unlock()
319 p, ok := m.profiles[id.String()]
321 return ErrProfileNotFound
323 p.ApplyChange(change)
324 m.profiles[id.String()] = p
328 func (m *memstore) updateProfiles(ids []uuid.ID, change BulkProfileChange) error {
330 defer m.profileLock.Unlock()
331 for id, profile := range m.profiles {
332 for _, i := range ids {
333 if id == i.String() {
334 profile.ApplyBulkChange(change)
335 m.profiles[id] = profile
343 func (m *memstore) addLogin(login Login) error {
345 defer m.loginLock.Unlock()
346 _, ok := m.logins[login.Value]
348 return ErrLoginAlreadyExists
350 m.logins[login.Value] = login
351 m.profileLoginLookup[login.ProfileID.String()] = append(m.profileLoginLookup[login.ProfileID.String()], login.Value)
355 func (m *memstore) removeLogin(value string, profile uuid.ID) error {
357 defer m.loginLock.Unlock()
358 l, ok := m.logins[value]
360 return ErrLoginNotFound
362 if !l.ProfileID.Equal(profile) {
363 return ErrLoginNotFound
365 delete(m.logins, value)
367 for p, id := range m.profileLoginLookup[profile.String()] {
374 m.profileLoginLookup[profile.String()] = append(m.profileLoginLookup[profile.String()][:pos], m.profileLoginLookup[profile.String()][pos+1:]...)
379 func (m *memstore) removeLoginsByProfile(profile uuid.ID) error {
381 defer m.loginLock.Unlock()
382 logins, ok := m.profileLoginLookup[profile.String()]
384 return ErrProfileNotFound
386 delete(m.profileLoginLookup, profile.String())
387 for _, login := range logins {
388 delete(m.logins, login)
393 func (m *memstore) recordLoginUse(value string, when time.Time) error {
395 defer m.loginLock.Unlock()
396 l, ok := m.logins[value]
398 return ErrLoginNotFound
405 func (m *memstore) listLogins(profile uuid.ID, num, offset int) ([]Login, error) {
407 defer m.loginLock.RUnlock()
408 ids, ok := m.profileLoginLookup[profile.String()]
410 return []Login{}, nil
412 if len(ids) > num+offset {
413 ids = ids[offset : num+offset]
414 } else if len(ids) > offset {
417 return []Login{}, nil
420 for _, id := range ids {
421 login, ok := m.logins[id]
425 logins = append(logins, login)
430 func cleanUpAfterProfileDeletion(profile uuid.ID, context Context) {
431 err := context.RemoveLoginsByProfile(profile)
433 log.Printf("Error removing logins from profile %s: %+v\n", profile, err)
435 // BUG(paddy): need to terminate all sessions associated with the Profile
436 // BUG(paddy): need to invalidate all tokens associated with the Profile
437 // BUG(paddy): need to delete all the grants associated with the Profile
440 // RegisterProfileHandlers adds handlers to the passed router to handle the profile endpoints, like registration and user retrieval.
441 func RegisterProfileHandlers(r *mux.Router, context Context) {
442 r.Handle("/profiles", wrap(context, CreateProfileHandler)).Methods("POST")
443 // BUG(paddy): We need to implement a handler that will return information about a profile or set of profiles.
444 r.Handle("/profiles/{id}", wrap(context, UpdateProfileHandler)).Methods("PATCH")
445 r.Handle("/profiles/{id}", wrap(context, DeleteProfileHandler)).Methods("DELETE")
446 // BUG(paddy): We need to implement a handler that will add a login to a profile.
447 // BUG(paddy): We need to implement a handler that will remove a login from a profile. What happens to sessions created with that login?
448 // BUG(paddy): We need to implement a handler that will list the logins attached to a profile.
451 // CreateProfileHandler is an HTTP handler for registering new profiles.
452 func CreateProfileHandler(w http.ResponseWriter, r *http.Request, context Context) {
453 scheme, ok := passphraseSchemes[CurPassphraseScheme]
455 log.Printf("Error selecting passphrase scheme #%d\n", CurPassphraseScheme)
456 encode(w, r, http.StatusInternalServerError, actOfGodResponse)
459 var req newProfileRequest
460 errors := []requestError{}
461 decoder := json.NewDecoder(r.Body)
462 err := decoder.Decode(&req)
464 encode(w, r, http.StatusBadRequest, invalidFormatResponse)
467 errors = append(errors, validateNewProfileRequest(&req)...)
469 encode(w, r, http.StatusBadRequest, response{Errors: errors})
472 passphrase, salt, err := scheme.create(req.Passphrase, context.config.iterations)
474 log.Printf("Error creating encoded passphrase: %#+v\n", err)
475 encode(w, r, http.StatusInternalServerError, actOfGodResponse)
481 Passphrase: string(passphrase),
482 Iterations: context.config.iterations,
484 PassphraseScheme: CurPassphraseScheme,
486 LastSeen: time.Now(),
488 err = context.SaveProfile(profile)
490 if err == ErrProfileAlreadyExists {
491 encode(w, r, http.StatusBadRequest, response{Errors: []requestError{{Slug: requestErrConflict, Field: "/id"}}})
494 log.Printf("Error saving profile: %#+v\n", err)
495 encode(w, r, http.StatusInternalServerError, actOfGodResponse)
502 Created: profile.Created,
503 LastUsed: profile.Created,
504 ProfileID: profile.ID,
506 err = context.AddLogin(login)
508 if err == ErrLoginAlreadyExists {
509 encode(w, r, http.StatusBadRequest, response{Errors: []requestError{{Slug: requestErrConflict, Field: "/email"}}})
512 log.Printf("Error adding login: %#+v\n", err)
513 encode(w, r, http.StatusInternalServerError, actOfGodResponse)
516 logins = append(logins, login)
519 Profiles: []Profile{profile},
521 encode(w, r, http.StatusCreated, resp)
522 // TODO(paddy): should we kick off the email validation flow?
525 func UpdateProfileHandler(w http.ResponseWriter, r *http.Request, context Context) {
526 errors := []requestError{}
528 if vars["id"] == "" {
529 errors = append(errors, requestError{Slug: requestErrMissing, Param: "id"})
530 encode(w, r, http.StatusBadRequest, response{Errors: errors})
533 id, err := uuid.Parse(vars["id"])
535 errors = append(errors, requestError{Slug: requestErrAccessDenied})
536 encode(w, r, http.StatusBadRequest, response{Errors: errors})
539 username, password, ok := r.BasicAuth()
541 errors = append(errors, requestError{Slug: requestErrAccessDenied})
542 encode(w, r, http.StatusUnauthorized, response{Errors: errors})
545 profile, err := authenticate(username, password, context)
547 if isAuthError(err) {
548 errors = append(errors, requestError{Slug: requestErrAccessDenied})
549 encode(w, r, http.StatusUnauthorized, response{Errors: errors})
551 errors = append(errors, requestError{Slug: requestErrActOfGod})
552 encode(w, r, http.StatusInternalServerError, response{Errors: errors})
556 if !profile.ID.Equal(id) {
557 errors = append(errors, requestError{Slug: requestErrAccessDenied})
558 encode(w, r, http.StatusForbidden, response{Errors: errors})
561 var req ProfileChange
562 decoder := json.NewDecoder(r.Body)
563 err = decoder.Decode(&req)
565 log.Printf("Error decoding request: %#+v\n", err)
566 encode(w, r, http.StatusBadRequest, invalidFormatResponse)
571 req.PassphraseScheme = nil
572 req.Compromised = nil // BUG(paddy): Need a way for admins to mark accounts as compromised
573 req.LockedUntil = nil
575 if req.Passphrase != nil {
576 if len(*req.Passphrase) < MinPassphraseLength {
577 errors = append(errors, requestError{Slug: requestErrInsufficient, Field: "/passphrase"})
578 encode(w, r, http.StatusBadRequest, response{Errors: errors})
581 if len(*req.Passphrase) > MaxPassphraseLength {
582 errors = append(errors, requestError{Slug: requestErrOverflow, Field: "/passphrase"})
583 encode(w, r, http.StatusBadRequest, response{Errors: errors})
586 iterations := context.config.iterations
587 scheme, ok := passphraseSchemes[CurPassphraseScheme]
589 encode(w, r, http.StatusInternalServerError, actOfGodResponse)
592 curScheme := CurPassphraseScheme
593 req.PassphraseScheme = &curScheme
594 passphrase, salt, err := scheme.create(*req.Passphrase, iterations)
596 encode(w, r, http.StatusInternalServerError, actOfGodResponse)
599 req.Passphrase = &passphrase
601 req.Iterations = &iterations
603 if req.PassphraseReset != nil {
605 req.PassphraseResetCreated = &now
613 resp.Profiles = []Profile{profile}
614 status = http.StatusOK
616 errors = append(errors, requestError{Slug: requestErrActOfGod})
618 status = http.StatusInternalServerError
620 encode(w, r, status, resp)
623 err = context.UpdateProfile(id, req)
625 if err == ErrProfileNotFound {
626 errors = append(errors, requestError{Slug: requestErrNotFound})
627 encode(w, r, http.StatusNotFound, response{Errors: errors})
630 encode(w, r, http.StatusInternalServerError, actOfGodResponse)
633 if !profile.Deleted && req.Deleted != nil && *req.Deleted {
634 go cleanUpAfterProfileDeletion(profile.ID, context)
636 profile.ApplyChange(req)
637 encode(w, r, http.StatusOK, response{Profiles: []Profile{profile}})
641 func DeleteProfileHandler(w http.ResponseWriter, r *http.Request, context Context) {
642 errors := []requestError{}
644 if vars["id"] == "" {
645 errors = append(errors, requestError{Slug: requestErrMissing, Param: "id"})
646 encode(w, r, http.StatusBadRequest, response{Errors: errors})
649 id, err := uuid.Parse(vars["id"])
651 errors = append(errors, requestError{Slug: requestErrAccessDenied})
652 encode(w, r, http.StatusBadRequest, response{Errors: errors})
655 username, password, ok := r.BasicAuth()
657 errors = append(errors, requestError{Slug: requestErrAccessDenied})
658 encode(w, r, http.StatusUnauthorized, response{Errors: errors})
661 profile, err := authenticate(username, password, context)
663 if isAuthError(err) {
664 errors = append(errors, requestError{Slug: requestErrAccessDenied})
665 encode(w, r, http.StatusUnauthorized, response{Errors: errors})
667 errors = append(errors, requestError{Slug: requestErrActOfGod})
668 encode(w, r, http.StatusInternalServerError, response{Errors: errors})
672 if !profile.ID.Equal(id) {
673 errors = append(errors, requestError{Slug: requestErrAccessDenied})
674 encode(w, r, http.StatusForbidden, response{Errors: errors})
677 var change ProfileChange
679 change.Deleted = &deleted
680 err = context.UpdateProfile(id, change)
682 if err == ErrProfileNotFound {
683 errors = append(errors, requestError{Slug: requestErrNotFound})
684 encode(w, r, http.StatusNotFound, response{Errors: errors})
687 encode(w, r, http.StatusInternalServerError, actOfGodResponse)
690 profile.ApplyChange(change)
691 encode(w, r, http.StatusOK, response{Profiles: []Profile{profile}})
692 go cleanUpAfterProfileDeletion(profile.ID, context)