users

package

v0.0.0-...-0f5ba4b Latest Latest Go to latest Published: Jul 29, 2022 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/hrand1005/training-notebook

Links

Open Source Insights

Documentation ¶

Overview ¶

Package classification of User API

Documentation for User API

Schemes: http
BasePath: /
Version: 1.0.0

Consumes:
- application/json

Produces:
- application/json

swagger:meta

Index ¶

Constants
Variables
func AuthenticateUser(user *models.User, credentials models.Credentails) (string, error)
func New(db data.UserDB) (*user, error)
func RequireAuthorization() gin.HandlerFunc
func UserIDFromContext(c *gin.Context) (models.UserID, error)
func UserIDFromParams(c *gin.Context) (models.UserID, error)
type Claims

Constants ¶

View Source

const (
	LoginCookieName     = "token"
	LoginCookieMaxAge   = 3600
	LoginCookieSecure   = false
	LoginCookieHTTPOnly = true
)

token settings

View Source

const (
	UserIDFromContextKey = "loggedInUserID"
	UserIDFromParamsKey  = "paramUserID"
)

Keys used to retrieve values from gin.Context

Variables ¶

View Source

var ErrInvalidUserID = "Invalid user ID"

Functions ¶

func AuthenticateUser ¶

func AuthenticateUser(user *models.User, credentials models.Credentails) (string, error)

func New ¶

func New(db data.UserDB) (*user, error)

func RequireAuthorization ¶

func RequireAuthorization() gin.HandlerFunc

TODO: authorization/permissions levels RequireAuthorization checks that the LoginCookie is set in the http request. If not found, sets StatusUnauthorized, else sets the token in the gin context.

func UserIDFromContext ¶

func UserIDFromContext(c *gin.Context) (models.UserID, error)

func UserIDFromParams ¶

func UserIDFromParams(c *gin.Context) (models.UserID, error)

Types ¶

type Claims ¶

type Claims struct {
	UserID models.UserID
	jwt.StandardClaims
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL