devauth

README

Dev-Auth-Server

Warning! This library is for development only!

This is a simple REST server for a basic email-password-authentication for development purpose.

Documentation

Index

• Variables
• type Database
• type MongoDatabase
  • func NewMongoDatabase(ctx context.Context, uri string, database string, collection string) (*MongoDatabase, error)
  • func (m *MongoDatabase) AddUser(email string, password string) (string, error)
  • func (m *MongoDatabase) CheckIfUserExists(email string) (bool, error)
  • func (m *MongoDatabase) GetUserByEmail(email string) (*User, error)
• type RequestData
• type Server
  • func NewServer(db Database) *Server
  • func (s Server) HandleLoginForm(c *gin.Context)
  • func (s Server) HandleLoginJSON(c *gin.Context)
  • func (s Server) HandleRegisterForm(c *gin.Context)
  • func (s Server) HandleRegisterJSON(c *gin.Context)
• type User

Variables

var OptionEmailMaxLength = 50

var OptionPasswordMaxLength = 50

Types

type Database

type Database interface {
	CheckIfUserExists(email string) (bool, error)
	GetUserByEmail(email string) (*User, error)
	AddUser(email string, password string) (string, error)
}

Database is an interface, which defines the interaction of the auth server with the database. You can use an existing database interface or add your own.

type MongoDatabase

type MongoDatabase struct {
	// contains filtered or unexported fields
}

MongoDatabase is an implementation for using Mongo as your database to store the users

func NewMongoDatabase

func NewMongoDatabase(ctx context.Context, uri string, database string, collection string) (*MongoDatabase, error)

func (*MongoDatabase) AddUser

func (m *MongoDatabase) AddUser(email string, password string) (string, error)

AddUser adds a user to the database. It does not check for collisions.

func (*MongoDatabase) CheckIfUserExists

func (m *MongoDatabase) CheckIfUserExists(email string) (bool, error)

CheckIfUserExists searches a user by the email address and returns true when one was found

func (*MongoDatabase) GetUserByEmail

func (m *MongoDatabase) GetUserByEmail(email string) (*User, error)

GetUserByEmail fetches one user by the email address. It returns nil, when no user has been found.

type RequestData

type RequestData struct {
	Email    string `json:"email"`
	Password string `json:"password"`
}

RequestData is a simple model to fetch the json request data

type Server

type Server struct {
	// contains filtered or unexported fields
}

func NewServer

func NewServer(db Database) *Server

func (Server) HandleLoginForm

func (s Server) HandleLoginForm(c *gin.Context)

func (Server) HandleLoginJSON

func (s Server) HandleLoginJSON(c *gin.Context)

func (Server) HandleRegisterForm

func (s Server) HandleRegisterForm(c *gin.Context)

func (Server) HandleRegisterJSON

func (s Server) HandleRegisterJSON(c *gin.Context)

type User

type User struct {
	ID       string `json:"id"`
	Email    string `json:"email"`
	Password string `json:"-"`
}

User is a simple structure to communicate with the database