Clean up after Client deletion, finish cleaning up after Profile deletion.
6f473576c6ae started cleaning up after Profiles when they're deleted, but
didn't clean up the Clients created by that Profile. This fixes that, and also
fixes a BUG note about cleaning up after a Client when it's deleted.
Extend the authorizationCodeStore to have a deleteAuthorizationCodesByClientID
method that will delete the AuthorizationCodes that have been granted by the
Client specified by the passed ID. We also implemented this in memstore and
postgres, so tests continue to pass.
Extend the clientStore to have a deleteClientsByOwner method that will delete
the Clients that were created by the Profile specified by the passed ID. We also
implemented this in memstore and postgres, so tests continue to pass.
Extend the clientStore to have a removeEndpointsByClientID method that will
delete the Endpoints that belong(ed) to a the Client specified by the passed ID.
We also implemented this in memstore and postgres, so tests continue to pass.
Extend the tokenStore to have a revokeTokensByClientID method that will revoke
all the Tokens that were granted to the Client specified by the passed ID. We
also implemented this in memstore and postgres, so tests continue to pass.
When listing Clients by their owner, allow setting the num argument (which
controls how many to return) to 0 or lower, and using that to signal "return all
Clients belonging to this owner", instead of paging. This is useful when
deleting the Clients belonging to a Profile as part of the cleanup after
deleting the Profile.
Create a cleanUpAfterClientDeletion helper function that will delete the
Endpoints and AuthorizationCodes belonging to a Client, and revoke the Tokens
belonging to a Client, as part of cleaning up after a Client has been deleted.
Add a check in the handler for listing Clients owned by a Profile to disallow
the num argument to be lower than 1, because the API should be forced to page.
Call our cleanUpAfterClientDeletion once the Client has been deleted in the
appropriate handler.
Fill out our Context with new methods to wrap all the new methods we're adding
to our *Stores.
In cleanUpAfterProfileDeletion, obtain a list of clients belonging to the owner,
use our new DeleteClientsByOwner method to remove all of them, and then use the
list to run our new cleanUpAfterClientDeletion function to clear away the final
remnants of a Profile when it's deleted.
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"`
84 // ApplyChange applies the properties of the passed ProfileChange
85 // to the Profile it is called on.
86 func (p *Profile) ApplyChange(change ProfileChange) {
87 if change.Name != nil {
90 if change.Passphrase != nil {
91 p.Passphrase = *change.Passphrase
93 if change.Iterations != nil {
94 p.Iterations = *change.Iterations
96 if change.Salt != nil {
99 if change.PassphraseScheme != nil {
100 p.PassphraseScheme = *change.PassphraseScheme
102 if change.Compromised != nil {
103 p.Compromised = *change.Compromised
105 if change.LockedUntil != nil {
106 p.LockedUntil = *change.LockedUntil
108 if change.PassphraseReset != nil {
109 p.PassphraseReset = *change.PassphraseReset
111 if change.PassphraseResetCreated != nil {
112 p.PassphraseResetCreated = *change.PassphraseResetCreated
114 if change.LastSeen != nil {
115 p.LastSeen = *change.LastSeen
119 // ApplyBulkChange applies the properties of the passed BulkProfileChange
120 // to the Profile it is called on.
121 func (p *Profile) ApplyBulkChange(change BulkProfileChange) {
122 if change.Compromised != nil {
123 p.Compromised = *change.Compromised
127 // ProfileChange represents a single atomic change to a Profile's mutable data.
128 type ProfileChange struct {
133 PassphraseScheme *int
135 LockedUntil *time.Time
136 PassphraseReset *string
137 PassphraseResetCreated *time.Time
141 func (c ProfileChange) Empty() bool {
142 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)
145 // Validate checks the ProfileChange it is called on
146 // and asserts its internal validity, or lack thereof.
147 // A descriptive error will be returned in the case of
148 // an invalid change.
149 func (c ProfileChange) Validate() error {
151 return ErrEmptyChange
153 if c.PassphraseScheme != nil && c.Passphrase == nil {
154 return ErrMissingPassphrase
156 if c.PassphraseReset != nil && c.PassphraseResetCreated == nil {
157 return ErrMissingPassphraseResetCreated
159 if c.PassphraseReset == nil && c.PassphraseResetCreated != nil {
160 return ErrMissingPassphraseReset
162 if c.Salt != nil && c.Passphrase == nil {
163 return ErrMissingPassphrase
165 if c.Iterations != nil && c.Passphrase == nil {
166 return ErrMissingPassphrase
171 // BulkProfileChange represents a single atomic change to many Profiles' mutable data.
172 // It is a subset of a ProfileChange, as it doesn't make sense to mutate some of the
173 // ProfileChange values across many Profiles all at once.
174 type BulkProfileChange struct {
178 func (b BulkProfileChange) Empty() bool {
179 return b.Compromised == nil
182 // Validate checks the BulkProfileChange it is called on
183 // and asserts its internal validity, or lack thereof.
184 // A descriptive error will be returned in the case of an
186 func (b BulkProfileChange) Validate() error {
188 return ErrEmptyChange
193 // Login represents a single human-friendly identifier for
194 // a given Profile that can be used to log into that Profile.
195 // Each Profile may only have one Login for each Type.
197 Type string `json:"type,omitempty"`
198 Value string `json:"value,omitempty"`
199 ProfileID uuid.ID `json:"profile_id,omitempty"`
200 Created time.Time `json:"created,omitempty"`
201 LastUsed time.Time `json:"last_used,omitempty"`
204 type newProfileRequest struct {
205 Email string `json:"email"`
206 Passphrase string `json:"passphrase"`
207 Name string `json:"name"`
210 func validateNewProfileRequest(req *newProfileRequest) []requestError {
211 errors := []requestError{}
212 req.Name = strings.TrimSpace(req.Name)
213 req.Email = strings.TrimSpace(req.Email)
214 if len(req.Passphrase) < MinPassphraseLength {
215 errors = append(errors, requestError{
216 Slug: requestErrInsufficient,
217 Field: "/passphrase",
220 if len(req.Passphrase) > MaxPassphraseLength {
221 errors = append(errors, requestError{
222 Slug: requestErrOverflow,
223 Field: "/passphrase",
226 if len(req.Name) > MaxNameLength {
227 errors = append(errors, requestError{
228 Slug: requestErrOverflow,
233 errors = append(errors, requestError{
234 Slug: requestErrMissing,
238 if len(req.Email) > MaxEmailLength {
239 errors = append(errors, requestError{
240 Slug: requestErrOverflow,
244 re := regexp.MustCompile(".+@.+\\..+")
245 if !re.Match([]byte(req.Email)) {
246 errors = append(errors, requestError{
247 Slug: requestErrInvalidFormat,
254 type profileStore interface {
255 getProfileByID(id uuid.ID) (Profile, error)
256 getProfileByLogin(value string) (Profile, error)
257 saveProfile(profile Profile) error
258 updateProfile(id uuid.ID, change ProfileChange) error
259 updateProfiles(ids []uuid.ID, change BulkProfileChange) error
260 deleteProfile(id uuid.ID) error
262 addLogin(login Login) error
263 removeLogin(value string, profile uuid.ID) error
264 removeLoginsByProfile(profile uuid.ID) error
265 recordLoginUse(value string, when time.Time) error
266 listLogins(profile uuid.ID, num, offset int) ([]Login, error)
269 func (m *memstore) getProfileByID(id uuid.ID) (Profile, error) {
270 m.profileLock.RLock()
271 defer m.profileLock.RUnlock()
272 p, ok := m.profiles[id.String()]
274 return Profile{}, ErrProfileNotFound
279 func (m *memstore) getProfileByLogin(value string) (Profile, error) {
281 defer m.loginLock.RUnlock()
282 login, ok := m.logins[value]
284 return Profile{}, ErrLoginNotFound
286 m.profileLock.RLock()
287 defer m.profileLock.RUnlock()
288 profile, ok := m.profiles[login.ProfileID.String()]
290 return Profile{}, ErrProfileNotFound
295 func (m *memstore) saveProfile(profile Profile) error {
297 defer m.profileLock.Unlock()
298 _, ok := m.profiles[profile.ID.String()]
300 return ErrProfileAlreadyExists
302 m.profiles[profile.ID.String()] = profile
306 func (m *memstore) updateProfile(id uuid.ID, change ProfileChange) error {
308 defer m.profileLock.Unlock()
309 p, ok := m.profiles[id.String()]
311 return ErrProfileNotFound
313 p.ApplyChange(change)
314 m.profiles[id.String()] = p
318 func (m *memstore) updateProfiles(ids []uuid.ID, change BulkProfileChange) error {
320 defer m.profileLock.Unlock()
321 for id, profile := range m.profiles {
322 for _, i := range ids {
323 if id == i.String() {
324 profile.ApplyBulkChange(change)
325 m.profiles[id] = profile
333 func (m *memstore) deleteProfile(id uuid.ID) error {
335 defer m.profileLock.Unlock()
336 if _, ok := m.profiles[id.String()]; !ok {
337 return ErrProfileNotFound
339 delete(m.profiles, id.String())
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 err = context.TerminateSessionsByProfile(profile)
437 log.Printf("Error terminating sessions associated with profile %s: %+v\n", profile, err)
439 err = context.RevokeTokensByProfileID(profile)
441 log.Printf("Error revoking tokens associated with profile %s: %+v\n", profile, err)
443 err = context.DeleteAuthorizationCodesByProfileID(profile)
445 log.Printf("Error deleting authorization codes associated with profile %s: %+v\n", profile, err)
447 clients, err := context.ListClientsByOwner(profile, -1, 0)
449 log.Printf("Error listing clients by profile %s: %+v\n", profile, err)
451 err = context.DeleteClientsByOwner(profile)
453 log.Printf("Error deleting clients by profile %s: %+v\n", profile, err)
455 for _, client := range clients {
456 cleanUpAfterClientDeletion(client.ID, context)
460 // RegisterProfileHandlers adds handlers to the passed router to handle the profile endpoints, like registration and user retrieval.
461 func RegisterProfileHandlers(r *mux.Router, context Context) {
462 r.Handle("/profiles", wrap(context, CreateProfileHandler)).Methods("POST")
463 // BUG(paddy): We need to implement a handler that will return information about a profile or set of profiles.
464 r.Handle("/profiles/{id}", wrap(context, UpdateProfileHandler)).Methods("PATCH")
465 r.Handle("/profiles/{id}", wrap(context, DeleteProfileHandler)).Methods("DELETE")
466 // BUG(paddy): We need to implement a handler that will add a login to a profile.
467 // BUG(paddy): We need to implement a handler that will remove a login from a profile. What happens to sessions created with that login?
468 // BUG(paddy): We need to implement a handler that will list the logins attached to a profile.
471 // CreateProfileHandler is an HTTP handler for registering new profiles.
472 func CreateProfileHandler(w http.ResponseWriter, r *http.Request, context Context) {
473 scheme, ok := passphraseSchemes[CurPassphraseScheme]
475 log.Printf("Error selecting passphrase scheme #%d\n", CurPassphraseScheme)
476 encode(w, r, http.StatusInternalServerError, actOfGodResponse)
479 var req newProfileRequest
480 errors := []requestError{}
481 decoder := json.NewDecoder(r.Body)
482 err := decoder.Decode(&req)
484 encode(w, r, http.StatusBadRequest, invalidFormatResponse)
487 errors = append(errors, validateNewProfileRequest(&req)...)
489 encode(w, r, http.StatusBadRequest, response{Errors: errors})
492 passphrase, salt, err := scheme.create(req.Passphrase, context.config.iterations)
494 log.Printf("Error creating encoded passphrase: %#+v\n", err)
495 encode(w, r, http.StatusInternalServerError, actOfGodResponse)
501 Passphrase: string(passphrase),
502 Iterations: context.config.iterations,
504 PassphraseScheme: CurPassphraseScheme,
506 LastSeen: time.Now(),
508 err = context.SaveProfile(profile)
510 if err == ErrProfileAlreadyExists {
511 encode(w, r, http.StatusBadRequest, response{Errors: []requestError{{Slug: requestErrConflict, Field: "/id"}}})
514 log.Printf("Error saving profile: %#+v\n", err)
515 encode(w, r, http.StatusInternalServerError, actOfGodResponse)
522 Created: profile.Created,
523 LastUsed: profile.Created,
524 ProfileID: profile.ID,
526 err = context.AddLogin(login)
528 if err == ErrLoginAlreadyExists {
529 encode(w, r, http.StatusBadRequest, response{Errors: []requestError{{Slug: requestErrConflict, Field: "/email"}}})
532 log.Printf("Error adding login: %#+v\n", err)
533 encode(w, r, http.StatusInternalServerError, actOfGodResponse)
536 logins = append(logins, login)
539 Profiles: []Profile{profile},
541 encode(w, r, http.StatusCreated, resp)
542 // TODO(paddy): should we kick off the email validation flow?
545 func UpdateProfileHandler(w http.ResponseWriter, r *http.Request, context Context) {
546 errors := []requestError{}
548 if vars["id"] == "" {
549 errors = append(errors, requestError{Slug: requestErrMissing, Param: "id"})
550 encode(w, r, http.StatusBadRequest, response{Errors: errors})
553 id, err := uuid.Parse(vars["id"])
555 errors = append(errors, requestError{Slug: requestErrAccessDenied})
556 encode(w, r, http.StatusBadRequest, response{Errors: errors})
559 username, password, ok := r.BasicAuth()
561 errors = append(errors, requestError{Slug: requestErrAccessDenied})
562 encode(w, r, http.StatusUnauthorized, response{Errors: errors})
565 profile, err := authenticate(username, password, context)
567 if isAuthError(err) {
568 errors = append(errors, requestError{Slug: requestErrAccessDenied})
569 encode(w, r, http.StatusUnauthorized, response{Errors: errors})
571 errors = append(errors, requestError{Slug: requestErrActOfGod})
572 encode(w, r, http.StatusInternalServerError, response{Errors: errors})
576 if !profile.ID.Equal(id) {
577 errors = append(errors, requestError{Slug: requestErrAccessDenied})
578 encode(w, r, http.StatusForbidden, response{Errors: errors})
581 var req ProfileChange
582 decoder := json.NewDecoder(r.Body)
583 err = decoder.Decode(&req)
585 log.Printf("Error decoding request: %#+v\n", err)
586 encode(w, r, http.StatusBadRequest, invalidFormatResponse)
591 req.PassphraseScheme = nil
592 req.Compromised = nil // BUG(paddy): Need a way for admins to mark accounts as compromised
593 req.LockedUntil = nil
595 if req.Passphrase != nil {
596 if len(*req.Passphrase) < MinPassphraseLength {
597 errors = append(errors, requestError{Slug: requestErrInsufficient, Field: "/passphrase"})
598 encode(w, r, http.StatusBadRequest, response{Errors: errors})
601 if len(*req.Passphrase) > MaxPassphraseLength {
602 errors = append(errors, requestError{Slug: requestErrOverflow, Field: "/passphrase"})
603 encode(w, r, http.StatusBadRequest, response{Errors: errors})
606 iterations := context.config.iterations
607 scheme, ok := passphraseSchemes[CurPassphraseScheme]
609 encode(w, r, http.StatusInternalServerError, actOfGodResponse)
612 curScheme := CurPassphraseScheme
613 req.PassphraseScheme = &curScheme
614 passphrase, salt, err := scheme.create(*req.Passphrase, iterations)
616 encode(w, r, http.StatusInternalServerError, actOfGodResponse)
619 req.Passphrase = &passphrase
621 req.Iterations = &iterations
623 if req.PassphraseReset != nil {
625 req.PassphraseResetCreated = &now
633 resp.Profiles = []Profile{profile}
634 status = http.StatusOK
636 errors = append(errors, requestError{Slug: requestErrActOfGod})
638 status = http.StatusInternalServerError
640 encode(w, r, status, resp)
643 err = context.UpdateProfile(id, req)
645 if err == ErrProfileNotFound {
646 errors = append(errors, requestError{Slug: requestErrNotFound})
647 encode(w, r, http.StatusNotFound, response{Errors: errors})
650 encode(w, r, http.StatusInternalServerError, actOfGodResponse)
653 profile.ApplyChange(req)
654 encode(w, r, http.StatusOK, response{Profiles: []Profile{profile}})
658 func DeleteProfileHandler(w http.ResponseWriter, r *http.Request, context Context) {
659 errors := []requestError{}
661 if vars["id"] == "" {
662 errors = append(errors, requestError{Slug: requestErrMissing, Param: "id"})
663 encode(w, r, http.StatusBadRequest, response{Errors: errors})
666 id, err := uuid.Parse(vars["id"])
668 errors = append(errors, requestError{Slug: requestErrAccessDenied})
669 encode(w, r, http.StatusBadRequest, response{Errors: errors})
672 username, password, ok := r.BasicAuth()
674 errors = append(errors, requestError{Slug: requestErrAccessDenied})
675 encode(w, r, http.StatusUnauthorized, response{Errors: errors})
678 profile, err := authenticate(username, password, context)
680 if isAuthError(err) {
681 errors = append(errors, requestError{Slug: requestErrAccessDenied})
682 encode(w, r, http.StatusUnauthorized, response{Errors: errors})
684 errors = append(errors, requestError{Slug: requestErrActOfGod})
685 encode(w, r, http.StatusInternalServerError, response{Errors: errors})
689 if !profile.ID.Equal(id) {
690 errors = append(errors, requestError{Slug: requestErrAccessDenied})
691 encode(w, r, http.StatusForbidden, response{Errors: errors})
694 err = context.DeleteProfile(id)
696 if err == ErrProfileNotFound {
697 errors = append(errors, requestError{Slug: requestErrNotFound})
698 encode(w, r, http.StatusNotFound, response{Errors: errors})
701 encode(w, r, http.StatusInternalServerError, actOfGodResponse)
704 encode(w, r, http.StatusOK, response{Profiles: []Profile{profile}})
705 go cleanUpAfterProfileDeletion(profile.ID, context)