mcm_google_sso

README

GoLang Google SSO handlers

[]

Package for creating authorization with Google on GoLang, can be use in any frameworks. Have protection from csrf attack.

Usage

go get github.com/PxyUp/google-sso-handlers

type ConfigController interface {
	GetHost() string
	GetClientId() string
	GetClientSecret() string
	GetRandomBytesLength() int
}

type RedirectsController interface {
	GetSuccessRedirectUrl(token string) string
	GetFailedRedirectUrl(errCode int, err error) string
	GetCallbackUrl() string
}

type UserController interface {
	UserInfoFn(user *mcm_google_sso.GoogleOauthUser) (string, error)
}

func initRouter() error {
	oauth, err := mcm_google_sso.NewGoogleOAuth(ConfigController, RedirectsController, UserController).GetGoogleAuthHandler()
    	if err != nil {
    		return nil, err
    	}
        http.HandleFunc("/google/login", oauth.LoginHandler)
	http.HandleFunc("/google/callback", oauth.CallbackHandler) // callback url from redirects
        log.Fatal(http.ListenAndServe(":8080", nil))
}

Examples

• HTTP
• GIN

Documentation

Index

• Variables
• type ConfigController
• type GoogleAuthHandlers
• type GoogleOAuth
  • func NewGoogleOAuth(c ConfigController, r RedirectsController, u UserController) *GoogleOAuth
  • func (c *GoogleOAuth) GetGoogleAuthHandler() (*GoogleAuthHandlers, error)
• type GoogleOauthUser
• type RedirectsController
• type UserController

Variables

var (
	SECURE_ERROR = errors.New("Length of the secure bytes must be more than 10")
)

Types

type ConfigController

type ConfigController interface {
	GetHost() string
	GetClientId() string
	GetClientSecret() string
	GetRandomBytesLength() int
}

type GoogleAuthHandlers

type GoogleAuthHandlers struct {
	LoginHandler    func(w http.ResponseWriter, r *http.Request)
	CallbackHandler func(w http.ResponseWriter, r *http.Request)
}

type GoogleOAuth

type GoogleOAuth struct {
	// contains filtered or unexported fields
}

func NewGoogleOAuth

func NewGoogleOAuth(c ConfigController, r RedirectsController, u UserController) *GoogleOAuth

func (*GoogleOAuth) GetGoogleAuthHandler

func (c *GoogleOAuth) GetGoogleAuthHandler() (*GoogleAuthHandlers, error)

type GoogleOauthUser

type GoogleOauthUser struct {
	Name    string `json:"name"`
	Picture string `json:"picture"`
	Email   string `json:"email"`
}

type RedirectsController

type RedirectsController interface {
	GetSuccessRedirectUrl(token string) string
	GetFailedRedirectUrl(errCode int, err error) string
	GetCallbackUrl() string
}

type UserController

type UserController interface {
	UserInfoFn(user *GoogleOauthUser) (string, error)
}