Common Web User Workflows in Go
MIT License
This Go package provides net/http
handlers for the following functions:
Special emphasis is placed on reducing the risk of someone hijacking user accounts. This is achieved by enforcing a certain user structure and following certain procedures:
go get github.com/rivo/users
The users.Main()
function registers all handlers and starts an HTTP server:
if err := users.Main(); err != nil {
panic(err)
}
Alternatively, register the handlers and start the server yourself:
http.HandleFunc(users.Config.RouteSignUp, users.SignUp)
http.HandleFunc(users.Config.RouteVerify, users.Verify)
http.HandleFunc(users.Config.RouteLogIn, users.LogIn)
http.HandleFunc(users.Config.RouteLogOut, users.LogOut)
http.HandleFunc(users.Config.RouteForgottenPassword, users.ForgottenPassword)
http.HandleFunc(users.Config.RouteResetPassword, users.ResetPassword)
http.HandleFunc(users.Config.RouteChange, users.Change)
if err := http.ListenAndServe(users.Config.ServerAddr, nil); err != nil {
panic(err)
}
If you use these handlers as they are, you will need access to an SMTP mail server (for email verification and password reset emails).
For pages behind the login, you can use the users.IsLoggedIn()
function in your own handler:
user, _, _ := users.IsLoggedIn(response, request)
if user == nil {
users.RenderProgramError(response, request, "You must be logged in", "", nil)
return
}
fmt.Fprintf(response, "You are logged in: %s", user.GetEmail())
This package uses Golang HTML templates for the various pages and text templates for the various emails sent to the user. Basic templates are provided which can be customized to your needs. Internationalization is supported via the "lang" browser cookie.
The users.User
type is an interface. Bring your own user model.
The users.Config
struct provides a number of fields with sensible defaults but which may be customized for your application. Refer to the Godoc documentation for details.
No specific database backend is assumed. The functions to load and save users default to a RAM-based solution but can be customized to access your individual database.
See http://godoc.org/github.com/rivo/users for the documentation.
See also the https://github.com/rivo/users/wiki for more examples and explanations.
Add your issue here on GitHub. Feel free to get in touch if you have any questions.