authenticator

README

Authenticator bundle

This bundle is used to authenticate users on your API. It uses Json Web Token.

Setup

In order to work, the bundle needs the following variables to be set in your .env file :

variable	description
TOKEN_VALID_DURATION	valid duration of the token in minutes
RSA_PUBLIC_PATH	the path to the public.pem file
RSA_PRIVATE_PATH	the path to the private.pem file
RSA_PASSWORD	password of the encryption key
DOMAIN	the domain for the cookies

As the bundle uses RSA keys, you need to generate them :

# Generate private.pem
openssl genrsa -des3 -out private.pem 2048

# Generate public.pem
openssl rsa -in private.pem -outform PEM -pubout -out public.pem

💡 You need to use the same password for both commands, this password is the one you set as RSA_PASSWORD

By default if you put your public.pem and private.pem in project root, then the path to them should be public.pem.

Available methods

The following methods are available :

name	description
GenerateToken	generates a JWT from email
DecodeToken	decode a jwt and returns the token and its claim
HashPassword	hash password with MD5 method

Use

When installed, a middleware is automatically created for authentication. You can use it inside the api/routes/router.go file :

func Init(r *gin.Engine) {
  r.POST("/register", controllers.CreateCustomer)
  r.POST("/login", controllers.Login)

  api := r.Group("/api")
  api.Use(middlewares.CheckAuthorization)
  {
    api.GET("/", controllers.TestController)
  }
}

login controller is also created, feel free to modify it to your needs.

Your customer model should have a password, you can use the authenticator.HashPassword to do so.

Documentation

Index

• func GenerateToken(email string) (string, error)
• func HashPassword(password string) string
• type Claim
  • func DecodeToken(tokenString string) (*jwt.Token, *Claim, error)
• type Rsa

Functions

func GenerateToken

func GenerateToken(email string) (string, error)

GenerateToken creates a JWT with email and expiration time in the payload

func HashPassword

func HashPassword(password string) string

HashPassword takes a string in parameter and returns the same string hashed with sha512

Types

type Claim

type Claim struct {
	Email string
	jwt.StandardClaims
}

Claim is the struct for the jwt claim

func DecodeToken

func DecodeToken(tokenString string) (*jwt.Token, *Claim, error)

DecodeToken decode and validates a token

type Rsa

type Rsa struct {
	PublicKeyPath  string
	PrivateKeyPath string
	PublicKey      interface{}
	PrivateKey     interface{}
}

Rsa is the struct to get the rsa keys used to generate and verify tokens from the environment variables