Google App Engine Authboss sample

gae-authboss-sample.go

/*
The MIT License (MIT)

Copyright (c) 2016 Cyph

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/


var ab = authboss.New()

var sanitizer = bluemonday.StrictPolicy()

...

func sanitize(s string, params ...int) string {
	sanitized := sanitizer.Sanitize(s)

	maxLength := -1
	if len(params) > 0 {
		maxLength = params[0]
	}

	if maxLength > -1 && len(sanitized) > maxLength {
		return sanitized[:maxLength]
	} else {
		return sanitized
	}
}

...

func setUpAuthboss() {
	ab.StoreMaker = NewGAEStorer
	ab.MailMaker = NewGAEMailer
	ab.CookieStoreMaker = NewCookieStorer
	ab.SessionStoreMaker = NewCookieStorer

	ab.LogWriter = os.Stderr
	ab.LogWriteMaker = NewGAELogger

	ab.XSRFName = "csrf_token"
	ab.XSRFMaker = func(_ http.ResponseWriter, r *http.Request) string {
		return nosurf.Token(r)
	}

	ab.RootURL = config.RootURL
	ab.MountPath = "/auth"

	ab.Policies = []authboss.Validator{
		authboss.Rules{
			FieldName:       "email",
			Required:        true,
			AllowWhitespace: false,
		},
		authboss.Rules{
			FieldName:       "password",
			Required:        true,
			MinLength:       12,
			AllowWhitespace: true,
		},
	}

	if err := ab.Init(); err != nil {
		panic(err)
	}
}

...

http.Handle("/", router)
setUpAuthboss()
router.PathPrefix("/auth").Handler(ab.NewRouter())

---

logger.go:

import (
	"appengine"
	"io"
	"net/http"
)

type GAELogger struct {
	request *http.Request
}

func NewGAELogger(_ http.ResponseWriter, r *http.Request) io.Writer {
	return &GAELogger{r}
}

func (l GAELogger) getContext() appengine.Context {
	return appengine.NewContext(l.request)
}

func (l GAELogger) Write(p []byte) (n int, err error) {
	l.getContext().Debugf(string(p))
	return len(p), nil
}

---

mailer.go:

import (
	"appengine"
	"appengine/mail"
	"gopkg.in/authboss.v0"
	"net/http"
)

type GAEMailer struct {
	request *http.Request
}

func NewGAEMailer(_ http.ResponseWriter, r *http.Request) authboss.Mailer {
	return &GAEMailer{r}
}

func (m GAEMailer) getContext() appengine.Context {
	return appengine.NewContext(m.request)
}

func (m GAEMailer) Send(email authboss.Email) error {
	return mail.Send(m.getContext(), &mail.Message{
		Sender:   config.EmailAddress,
		To:       email.To,
		Cc:       email.Cc,
		Bcc:      email.Bcc,
		Subject:  email.Subject,
		Body:     email.TextBody,
		HTMLBody: email.HTMLBody,
	})
}

---

storer.go:

import (
	"appengine"
	"appengine/datastore"
	"gopkg.in/authboss.v0"
	"net/http"
	"time"
)

type Remember struct{}

type User struct {
	Name     string
	Username string

	/* Auth */
	Email    string
	Password string

	/* OAuth2 */
	Oauth2Uid      string
	Oauth2Provider string
	Oauth2Token    string
	Oauth2Refresh  string
	Oauth2Expiry   time.Time

	/* Confirm */
	ConfirmToken string
	Confirmed    bool

	/* Lock */
	AttemptNumber int64
	AttemptTime   time.Time
	Locked        time.Time

	/* Recover */
	RecoverToken       string
	RecoverTokenExpiry time.Time
}

type GAEStorer struct {
	request *http.Request
}

func (s GAEStorer) getContext() appengine.Context {
	return appengine.NewContext(s.request)
}

func (s GAEStorer) userPut(email string, attr authboss.Attributes) error {
	email = sanitize(email)

	var user User
	if err := attr.Bind(&user, true); err != nil {
		return err
	}

	key, _, err := s.userQuery("Email", true, email)
	if err != nil {
		key = datastore.NewIncompleteKey(s.getContext(), "Users", nil)
	}

	_, err = datastore.Put(
		s.getContext(),
		key,
		&User{
			sanitize(user.Name),
			sanitize(user.Username),
			email,
			sanitize(user.Password),
			sanitize(user.Oauth2Uid),
			sanitize(user.Oauth2Provider),
			sanitize(user.Oauth2Token),
			sanitize(user.Oauth2Refresh),
			user.Oauth2Expiry,
			sanitize(user.ConfirmToken),
			user.Confirmed,
			user.AttemptNumber,
			user.AttemptTime,
			user.Locked,
			sanitize(user.RecoverToken),
			user.RecoverTokenExpiry,
		},
	)
	return err
}

func (s GAEStorer) userQuery(prop string, keyOnly bool, value interface{}) (*datastore.Key, *User, error) {
	var user User
	q := datastore.NewQuery("Users").Filter(prop+"=", value)

	if keyOnly {
		q = q.KeysOnly()
	}

	key, err := q.Run(s.getContext()).Next(&user)
	return key, &user, err
}

func (s GAEStorer) rememberKey(userKey *datastore.Key, token string) *datastore.Key {
	return datastore.NewKey(s.getContext(), "Remember", token, 0, userKey)
}

func NewGAEStorer(_ http.ResponseWriter, r *http.Request) authboss.Storer {
	return &GAEStorer{r}
}

func (s GAEStorer) Create(email string, attr authboss.Attributes) error {
	if _, err := s.Get(email); err != nil {
		return s.userPut(email, attr)
	}

	return authboss.ErrUserFound
}

func (s GAEStorer) Put(email string, attr authboss.Attributes) error {
	if _, err := s.Get(email); err != nil {
		return nil
	}

	return s.userPut(email, attr)
}

func (s GAEStorer) Get(email string) (result interface{}, err error) {
	email = sanitize(email)

	_, user, err := s.userQuery("Email", false, email)
	if err != nil {
		return nil, authboss.ErrUserNotFound
	}

	return user, nil
}

func (s GAEStorer) PutOAuth(uid string, provider string, attr authboss.Attributes) error {
	return s.userPut(uid+provider, attr)
}

func (s GAEStorer) GetOAuth(uid string, provider string) (result interface{}, err error) {
	return s.Get(uid + provider)
}

func (s GAEStorer) AddToken(email string, token string) error {
	email = sanitize(email)
	token = sanitize(token)

	userKey, _, err := s.userQuery("Email", true, email)
	if err != nil {
		return authboss.ErrUserNotFound
	}

	_, err = datastore.Put(
		s.getContext(),
		s.rememberKey(userKey, token),
		&Remember{},
	)
	return err
}

func (s GAEStorer) DelTokens(email string) error {
	email = sanitize(email)

	userKey, _, err := s.userQuery("Email", true, email)
	if err != nil {
		return authboss.ErrUserNotFound
	}

	keys, err := datastore.NewQuery("Remember").Ancestor(userKey).KeysOnly().GetAll(s.getContext(), nil)
	if err != nil {
		return err
	}

	return datastore.DeleteMulti(s.getContext(), keys)
}

func (s GAEStorer) UseToken(email string, token string) error {
	email = sanitize(email)
	token = sanitize(token)

	userKey, _, err := s.userQuery("Email", true, email)
	if err != nil {
		return authboss.ErrUserNotFound
	}

	if err = datastore.Delete(s.getContext(), s.rememberKey(userKey, token)); err != nil {
		return authboss.ErrTokenNotFound
	}

	return nil
}

func (s GAEStorer) ConfirmUser(confirmToken string) (result interface{}, err error) {
	confirmToken = sanitize(confirmToken)

	if _, user, err := s.userQuery("ConfirmToken", false, confirmToken); err == nil {
		return user, nil
	}

	return nil, authboss.ErrUserNotFound
}

func (s GAEStorer) RecoverUser(recoverToken string) (result interface{}, err error) {
	recoverToken = sanitize(recoverToken)

	if _, user, err := s.userQuery("RecoverToken", false, recoverToken); err == nil {
		return user, nil
	}

	return nil, authboss.ErrUserNotFound
}

---

client_storer.go:

import (
	"github.com/gorilla/securecookie"
	"gopkg.in/authboss.v0"
	"net/http"
	"os"
	"time"
)

var cookieStore = securecookie.New(
	[]byte(os.Getenv("SECURECOOKIE_HASH_KEY")),
	[]byte(os.Getenv("SECURECOOKIE_BLOCK_KEY")),
)

type CookieStorer struct {
	Request *http.Request
	Writer  http.ResponseWriter
}

func NewCookieStorer(w http.ResponseWriter, r *http.Request) authboss.ClientStorer {
	return &CookieStorer{r, w}
}

func (s CookieStorer) Get(key string) (string, bool) {
	key = sanitize(key)

	cookie, err := s.Request.Cookie(key)
	if err != nil {
		return "", false
	}

	var value string
	err = cookieStore.Decode(key, cookie.Value, &value)
	if err != nil {
		return "", false
	}

	return sanitize(value), true
}

func (s CookieStorer) Put(key string, value string) {
	key = sanitize(key)
	key = sanitize(value)

	encoded, _ := cookieStore.Encode(key, value)

	cookie := &http.Cookie{
		Expires: time.Now().UTC().AddDate(1, 0, 0),
		Name:    key,
		Value:   encoded,
		Path:    "/",
	}
	http.SetCookie(s.Writer, cookie)
}

func (s CookieStorer) Del(key string) {
	key = sanitize(key)

	cookie := &http.Cookie{
		MaxAge: -1,
		Name:   key,
		Path:   "/",
	}
	http.SetCookie(s.Writer, cookie)
}