From 6049ba80896a0727c2b6aa201ab7014d8c0d97c4 Mon Sep 17 00:00:00 2001
From: vx3r <vx3r@127-0-0-1.fr>
Date: Wed, 10 Jun 2020 16:52:44 +0900
Subject: [PATCH] go fmt and golint

---
 api/api.go                    | 1 +
 api/v1/auth/auth.go           | 8 ++++----
 api/v1/v1.go                  | 1 +
 auth/auth.go                  | 2 ++
 auth/fake/fake.go             | 1 +
 auth/github/github.go         | 1 +
 auth/oauth2oidc/oauth2oidc.go | 1 +
 model/auth.go                 | 1 +
 model/user.go                 | 1 +
 util/util.go                  | 1 +
 10 files changed, 14 insertions(+), 4 deletions(-)

diff --git a/api/api.go b/api/api.go
index 8063cec..1272da0 100644
--- a/api/api.go
+++ b/api/api.go
@@ -5,6 +5,7 @@ import (
 	"gitlab.127-0-0-1.fr/vx3r/wg-gen-web/api/v1"
 )
 
+// ApplyRoutes apply routes to gin engine
 func ApplyRoutes(r *gin.Engine, private bool) {
 	api := r.Group("/api")
 	{
diff --git a/api/v1/auth/auth.go b/api/v1/auth/auth.go
index 66fcd0a..8170bc5 100644
--- a/api/v1/auth/auth.go
+++ b/api/v1/auth/auth.go
@@ -16,8 +16,8 @@ import (
 func ApplyRoutes(r *gin.RouterGroup) {
 	g := r.Group("/auth")
 	{
-		g.GET("/oauth2_url", oauth2_url)
-		g.POST("/oauth2_exchange", oauth2_exchange)
+		g.GET("/oauth2_url", oauth2URL)
+		g.POST("/oauth2_exchange", oauth2Exchange)
 		g.GET("/user", user)
 		g.GET("/logout", logout)
 	}
@@ -26,7 +26,7 @@ func ApplyRoutes(r *gin.RouterGroup) {
 /*
  * generate redirect url to get OAuth2 code or let client know that OAuth2 is disabled
  */
-func oauth2_url(c *gin.Context) {
+func oauth2URL(c *gin.Context) {
 	cacheDb := c.MustGet("cache").(*cache.Cache)
 
 	state, err := util.GenerateRandomString(32)
@@ -62,7 +62,7 @@ func oauth2_url(c *gin.Context) {
 /*
  * exchange code and get user infos, if OAuth2 is disable just send fake data
  */
-func oauth2_exchange(c *gin.Context) {
+func oauth2Exchange(c *gin.Context) {
 	var loginVals model.Auth
 	if err := c.ShouldBind(&loginVals); err != nil {
 		log.WithFields(log.Fields{
diff --git a/api/v1/v1.go b/api/v1/v1.go
index ce1339f..c7d5df5 100644
--- a/api/v1/v1.go
+++ b/api/v1/v1.go
@@ -7,6 +7,7 @@ import (
 	"gitlab.127-0-0-1.fr/vx3r/wg-gen-web/api/v1/server"
 )
 
+// ApplyRoutes apply routes to gin router
 func ApplyRoutes(r *gin.RouterGroup, private bool) {
 	v1 := r.Group("/v1.0")
 	{
diff --git a/auth/auth.go b/auth/auth.go
index f8d3e5d..7deeba3 100644
--- a/auth/auth.go
+++ b/auth/auth.go
@@ -11,6 +11,7 @@ import (
 	"os"
 )
 
+// Auth interface to implement as auth provider
 type Auth interface {
 	Setup() error
 	CodeUrl(state string) string
@@ -18,6 +19,7 @@ type Auth interface {
 	UserInfo(oauth2Token *oauth2.Token) (*model.User, error)
 }
 
+// GetAuthProvider  get an instance of auth provider based on config
 func GetAuthProvider() (Auth, error) {
 	var oauth2Client Auth
 	var err error
diff --git a/auth/fake/fake.go b/auth/fake/fake.go
index 0ebe8d8..9c9dd93 100644
--- a/auth/fake/fake.go
+++ b/auth/fake/fake.go
@@ -7,6 +7,7 @@ import (
 	"time"
 )
 
+// Fake in order to implement interface, struct is required
 type Fake struct{}
 
 // Setup validate provider
diff --git a/auth/github/github.go b/auth/github/github.go
index 5e16b21..508fd4c 100644
--- a/auth/github/github.go
+++ b/auth/github/github.go
@@ -13,6 +13,7 @@ import (
 	"time"
 )
 
+// Github in order to implement interface, struct is required
 type Github struct{}
 
 var (
diff --git a/auth/oauth2oidc/oauth2oidc.go b/auth/oauth2oidc/oauth2oidc.go
index 6976800..6f6418a 100644
--- a/auth/oauth2oidc/oauth2oidc.go
+++ b/auth/oauth2oidc/oauth2oidc.go
@@ -10,6 +10,7 @@ import (
 	"os"
 )
 
+// Oauth2idc in order to implement interface, struct is required
 type Oauth2idc struct{}
 
 var (
diff --git a/model/auth.go b/model/auth.go
index 941dfee..76fbb59 100644
--- a/model/auth.go
+++ b/model/auth.go
@@ -1,5 +1,6 @@
 package model
 
+// Auth structure
 type Auth struct {
 	Oauth2   bool   `json:"oauth2"`
 	ClientId string `json:"clientId"`
diff --git a/model/user.go b/model/user.go
index 852123f..4dbf8ac 100644
--- a/model/user.go
+++ b/model/user.go
@@ -2,6 +2,7 @@ package model
 
 import "time"
 
+// User structure
 type User struct {
 	Sub      string    `json:"sub"`
 	Name     string    `json:"name"`
diff --git a/util/util.go b/util/util.go
index c026f84..762f497 100644
--- a/util/util.go
+++ b/util/util.go
@@ -11,6 +11,7 @@ import (
 )
 
 var (
+	// AuthTokenHeaderName http header for token transport
 	AuthTokenHeaderName = "x-wg-gen-web-auth"
 	// RegexpEmail check valid email
 	RegexpEmail = regexp.MustCompile("^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$")