github

package

v0.0.0-...-530d8eb Latest Latest Go to latest Published: Dec 17, 2019 License: MIT Imports: 13 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/lzecca78/one

Links

Open Source Insights

Documentation ¶

Overview ¶

Package github provides you access to Github's OAuth2 infrastructure.

Index ¶

func Auth() gin.HandlerFunc
func CheckAuthenticatedUser() gin.HandlerFunc
func LoginHandler(ctx *gin.Context)
func Session(name string) gin.HandlerFunc
func Setup(credFile string, scopes []string, secret []byte, ...)
type AuthUser
type Credentials

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Auth ¶

func Auth() gin.HandlerFunc

Auth initialize the authentication with Github

func CheckAuthenticatedUser ¶

func CheckAuthenticatedUser() gin.HandlerFunc

CheckAuthenticatedUser will be implemented as a controller for authentication for every api in a group

func LoginHandler ¶

func LoginHandler(ctx *gin.Context)

LoginHandler save in the cookie the state and return the url needed for authentication with Github

func Session ¶

func Session(name string) gin.HandlerFunc

Session is the function needed by the handler github to initialize the session

func Setup ¶

func Setup(credFile string, scopes []string, secret []byte, authRedirectURL, orgRequired string)

Setup setup the github oauth2 handler

Types ¶

type AuthUser ¶

type AuthUser struct {
	Login              string `json:"login"`
	Name               string `json:"name"`
	OrganizationNeeded bool   `json:"organization_needed"`
}

AuthUser rapresents datas of authenticated user

type Credentials ¶

type Credentials struct {
	ClientID     string `json:"clientid"`
	ClientSecret string `json:"secret"`
}

Credentials stores google client-ids.

Source Files ¶

View all Source files

oauth.go

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