vendor

vendor/github.com/revel/modules/auth/README.md

@@ -0,0 +1,6 @@
+modules/auth
+===============
+
+Basic user/auth module
+
+This should be modeled after [flask-security](https://github.com/mattupstate/flask-security)

vendor/github.com/revel/modules/auth/auth.go

@@ -0,0 +1,78 @@
+package auth
+
+import (
+// "errors"
+)
+
+var (
+	Store StorageDriver
+)
+
+// Store = gormauth.NewGormAuthDriver()
+
+type UserAuth interface {
+	// getters/setters implemented by the app-level model
+	UserId() string
+	Secret() string
+	HashedSecret() string
+	SetHashedSecret(string)
+
+	SecretDriver
+	// // implemented by secret driver
+	// Authenticate() (bool, error)
+}
+
+type SecretDriver interface {
+	Authenticate() (bool, error)
+	HashSecret(args ...interface{}) (string, error)
+
+	// stuff for documentation
+	// UserContext is expected in these?
+
+	// Secret expects 0 or non-0 arguments
+	// When no parameter is passed, it acts as a getter
+	// When one or more parameters are passed, it acts as a setter
+	// A driver should specify the expected arguments and their meanings
+
+	// Register()
+	// Login()
+	// Logout()
+}
+
+type StorageDriver interface {
+	Save(user interface{}) error
+	// Load should take a partially filled struct
+	// (with values needed to look up)
+	// and fills in the rest
+	Load(user interface{}) error
+}
+
+// func init() {
+// 	// auth.Store = gorm...
+// }
+
+// func (c App) Login(email, password string) {
+
+// 	u := User {
+// 		Email ...
+// 	}
+
+// 	good, err := auth.Authenticate(email, password)
+
+// 	user, err := user_info.GetUserByEmail(email)
+// }
+
+// Bycrypt Authenticate() expects a single string argument of the plaintext password
+// It returns true on success and false if error or password mismatch
+// func Authenticate(attemptedUser UserAuth) (bool, error) {
+// 	// check user in Store
+// 	loadedUser, err := Store.Load(attemptedUser.UserId())
+// 	if err != nil {
+// 		return false, errors.New("User Not Found")
+// 	}
+
+// 	loadedUser.Authenticate(attemptedUser.Secret())
+
+// 	// successfully authenticated
+// 	return true, nil
+// }

vendor/github.com/revel/modules/auth/auth_test.go

@@ -0,0 +1,134 @@
+package auth_test
+
+import (
+	"errors"
+	"testing"
+
+	"github.com/revel/modules/auth"
+	"github.com/revel/modules/auth/driver/secret"
+)
+
+type User struct {
+	email    string
+	password string
+	hashpass string
+
+	secret.BcryptAuth // SecurityDriver for testing
+}
+
+func NewUser(email, pass string) *User {
+	u := &User{
+		email:    email,
+		password: pass,
+	}
+	u.UserContext = u
+	return u
+}
+
+func (self *User) UserId() string {
+	return self.email
+}
+
+func (self *User) Secret() string {
+	return self.password
+}
+
+func (self *User) HashedSecret() string {
+	return self.hashpass
+}
+
+func (self *User) SetHashedSecret(hpass string) {
+	self.hashpass = hpass
+}
+
+// func (self *User) Load() string
+
+type TestStore struct {
+	data map[string]string
+}
+
+func (self *TestStore) Save(user interface{}) error {
+	u, ok := user.(*User)
+	if !ok {
+		return errors.New("TestStore.Save() expected arg of type User")
+	}
+
+	hPass, err := u.HashSecret(u.Secret())
+	if err != nil {
+		return err
+	}
+	self.data[u.UserId()] = hPass
+
+	return nil
+}
+func (self *TestStore) Load(user interface{}) error {
+	u, ok := user.(*User)
+	if !ok {
+		return errors.New("TestStore.Load() expected arg of type User")
+	}
+
+	hpass, ok := self.data[u.UserId()]
+	if !ok {
+		return errors.New("Record Not Found")
+	}
+	u.SetHashedSecret(hpass)
+	return nil
+}
+
+func TestPasswordHash(t *testing.T) {
+	auth.Store = &TestStore{
+		data: make(map[string]string),
+	}
+	u := NewUser("demo@domain.com", "demopass")
+	fail := NewUser("demo@domain.com", "")
+
+	var err error
+	u.hashpass, err = u.HashSecret(u.password)
+	if err != nil {
+		t.Errorf("Should have hashed password, get error: %v\n", err)
+	}
+	fail.hashpass, err = fail.HashSecret(fail.password)
+	if err == nil {
+		t.Errorf("Should have failed hashing\n")
+	}
+}
+
+func TestAuthenticate(t *testing.T) {
+	auth.Store = &TestStore{
+		data: make(map[string]string),
+	}
+
+	// user registered a long time ago
+	u := NewUser("demo@domain.com", "demopass")
+	err := auth.Store.Save(u)
+	if err != nil {
+		t.Errorf("Should have saved user: %v", err)
+	}
+
+	// users now logging in
+	pass := NewUser("demo@domain.com", "demopass")
+	fail := NewUser("demo@domain.com", "invalid")
+
+	// valid user is now trying to login
+	// check user in DB
+	err = auth.Store.Load(pass)
+	if err != nil {
+		t.Errorf("Should have loaded pass user: %v\n", err)
+	}
+	// check credentials
+	ok, err := pass.Authenticate()
+	if !ok || err != nil {
+		t.Errorf("Should have authenticated user")
+	}
+
+	// invalid user is now trying to login
+	err = auth.Store.Load(fail)
+	if err != nil {
+		t.Errorf("Should have loaded fail user")
+	}
+	// this should fail
+	ok, err = fail.Authenticate()
+	if ok || err != nil {
+		t.Errorf("Should have failed to authenticate user: %v\n", err)
+	}
+}

vendor/github.com/revel/modules/auth/doc.go

@@ -0,0 +1,27 @@
+/*	A basic user authentication module for Revel
+
+ list of concerns:
+- Separating out the interface and driver
+- Removing DB/Storage dependency
+- UUID as default identifier?
+- how to deal with password/secret or generally, method of authorization
+- default {views,controllers,routes} for register/login/logut ?
+- reset password in most basic ?
+- activation (and other features) in a second / more sophisticated driver
+- filter for checking that user is authenticated
+
+
+I think a driver is made up of 2 parts
+data prep and data storage
+register and password reset are part of data prep
+as is the auth hash method
+they don't care how the data is stored
+
+then there is the data store
+
+perhaps each auth user model should instantiate 2 drivers instead of 1?
+one for data prep components and one for storage
+so the security driver and the storage driver
+
+*/
+package auth

vendor/github.com/revel/modules/auth/driver/secret/bcrypt.go

@@ -0,0 +1,73 @@
+package secret
+
+import (
+	"errors"
+
+	"github.com/revel/modules/auth"
+	"golang.org/x/crypto/bcrypt"
+)
+
+// example implementation of a Revel auth security driver
+// This driver should be embedded into your app-level User model
+// It expects your User model to have `Password` and `HashedPassword` string fields
+//
+// Your User model also needs to set itself as the UserContext for the BcryptAuth driver
+//
+// func NewUser(email, pass string) *User {
+// 	u := &User{
+// 		email:    email,
+// 		password: pass,
+// 	}
+// 	u.UserContext = u
+// }
+//
+type BcryptAuth struct {
+	UserContext auth.UserAuth
+}
+
+// Bcrypt Secret() returns the hashed version of the password.
+// It expects an argument of type string, which is the plain text password
+func (self *BcryptAuth) HashSecret(args ...interface{}) (string, error) {
+	if auth.Store == nil {
+		return "", errors.New("Auth module StorageDriver not set")
+	}
+	argLen := len(args)
+	if argLen == 0 {
+		// we are getting
+		return string(self.UserContext.HashedSecret()), nil
+	}
+
+	if argLen == 1 {
+		// we are setting
+		password, ok := args[0].(string)
+		if !ok {
+			return "", errors.New("Wrong argument type provided, expected plaintext password as string")
+		}
+		hPass, err := bcrypt.GenerateFromPassword([]byte(password), bcrypt.DefaultCost)
+		if err != nil {
+			return "", err
+		}
+
+		self.UserContext.SetHashedSecret(string(hPass))
+		return self.UserContext.HashedSecret(), nil
+	}
+
+	// bad argument count
+	return "", errors.New("Too many arguments provided, expected one")
+}
+
+// Bycrypt Authenticate() expects a single string argument of the plaintext password
+// It returns true on success and false if error or password mismatch
+func (self *BcryptAuth) Authenticate() (bool, error) {
+	// check password
+	err := bcrypt.CompareHashAndPassword([]byte(self.UserContext.HashedSecret()), []byte(self.UserContext.Secret()))
+	if err == bcrypt.ErrMismatchedHashAndPassword {
+		return false, nil
+	}
+	if err != nil {
+		return false, err
+	}
+
+	// successfully authenticated
+	return true, nil
+}

vendor/github.com/revel/modules/auth/driver/storage/mysql/README.md

@@ -0,0 +1,3 @@
+Mysql Auth driver
+==================
+

vendor/github.com/revel/modules/auth/driver/storage/postgres/README.md

@@ -0,0 +1,3 @@
+Postgresql Auth driver
+==================
+

vendor/github.com/revel/modules/auth/driver/storage/sqlite/README.md

@@ -0,0 +1,3 @@
+Sqlite Auth driver
+==================
+

vendor/github.com/revel/modules/auth/user.go

@@ -0,0 +1,17 @@
+package auth
+
+// var storageDriver auth.StorageDriver // postgres in example
+
+// type AuthUserModel struct {
+// 	userId   string
+// 	security *SecurityDriver // bcrypt in example
+
+// }
+
+// func (self *AuthUserModel) UserId() string {
+// 	return self.userId
+// }
+
+// func (self *AuthUserModel) Secret() string {
+// 	return self.security.Secret()
+// }