ginoidc

README

gin-oidc

gin middleware - an OIDC client for a relying party web server

example usage

  //middleware params
 	initParams := gin_oidc.InitParams{
 		Router:       router,
 		ClientId:     "xx-xxx-xxx",
 		ClientSecret: "xx-xxx-xxx",
 		Issuer:       "https://accounts.google.com", //add '.well-known/openid-configuration' to see it's a good link
 		ClientUrl:    "http://example.domain", //your website's url
 		Scopes:       []string{"openid"},
 		ErrorHandler: func(c *gin.Context) {
 			//gin_oidc pushes a new error before any "ErrorHandler" invocation
 			message := c.Errors.Last().Error()
 			//redirect to ErrorEndpoint with error message
 			//redirectToErrorPage(c, "http://example2.domain/error", message)
 			//when "ErrorHandler" ends "c.Abort()" is invoked - no further handlers will be invoked
 		},
 		PostLogoutUrl: "http://example2.domain/",
 	}
  
  //protect all endpoint below this line
  router.Use(gin_oidc.Init(initParams))
  ////or protect a single endpoint
  //protectMiddleware := gin_oidc.Init(initParams)
  //router.GET("/protectedEndpoint", protectMiddleware, protectedEndpointHandler)
  

Documentation

Index

• func Init(i InitParams) gin.HandlerFunc
• func RandomString(n int) string
• type InitParams

Functions

func Init

func Init(i InitParams) gin.HandlerFunc

func RandomString

func RandomString(n int) string

Types

type InitParams

type InitParams struct {
	Router        *gin.Engine     //gin router (used to set handler for OIDC)
	ClientId      string          //id from the authorization service (OIDC provider)
	ClientSecret  string          //secret from the authorization service (OIDC provider)
	Issuer        string          //the URL identifier for the authorization service. for example: "https://accounts.google.com" - try adding "/.well-known/openid-configuration" to the path to make sure it's correct
	ClientUrl     string          //your website's/service's URL for example: "http://localhost:8081/" or "https://mydomain.com/
	Scopes        []string        //OAuth scopes. If you're unsure go with: []string{oidc.ScopeOpenID, "profile", "email"}
	ErrorHandler  gin.HandlerFunc //errors handler. for example: func(c *gin.Context) {c.String(http.StatusBadRequest, "ERROR...")}
	PostLogoutUrl string          //user will be redirected to this URL after he logs out (i.e. accesses the '/logout' endpoint added in 'Init()')
}