Merge pull request #23 from LyricTian/develop

Fixed error handling

Author: LyricTian

README.md

@@ -65,24 +65,23 @@ func main() {
 	// client test store
 	manager.MapClientStorage(store.NewTestClientStore())
 
-	srv := server.NewServer(server.NewConfig(), manager)
-	srv.SetUserAuthorizationHandler(func(w http.ResponseWriter, r *http.Request) (userID string, err error) {
-		// validation and to get the user id
-		userID = "000000"
-		return
-	})
+	srv := server.NewDefaultServer(manager)
+	srv.SetAllowGetAccessRequest(true)
+
 	http.HandleFunc("/authorize", func(w http.ResponseWriter, r *http.Request) {
 		err := srv.HandleAuthorizeRequest(w, r)
 		if err != nil {
 			http.Error(w, err.Error(), http.StatusBadRequest)
 		}
 	})
+
 	http.HandleFunc("/token", func(w http.ResponseWriter, r *http.Request) {
 		err := srv.HandleTokenRequest(w, r)
 		if err != nil {
 			http.Error(w, err.Error(), http.StatusBadRequest)
 		}
 	})
+
 	http.ListenAndServe(":9096", nil)
 }
 ```
@@ -97,7 +96,16 @@ $ ./server
 ### Open in your web browser
 
 ```
-http://localhost:9096/authorize?response_type=code&client_id=1&redirect_uri=http%253A%252F%252Flocalhost&scope=all&state=xyz
+http://localhost:9096/token?grant_type=clientcredentials&client_id=1&client_secret=11&scope=all
+```
+
+```
+{
+    "access_token": "ZGF4ARHJPT2Y_QAIOJVL-Q",
+    "expires_in": 7200,
+    "scope": "all",
+    "token_type": "Bearer"
+}
 ```
 
 ## Features

const.go

@@ -1,33 +1,28 @@
 package oauth2
 
-// ResponseType Response Type
+// ResponseType the type of authorization request
 type ResponseType string
 
+// define the type of authorization request
 const (
-	// Code Authorization code type
-	Code ResponseType = "code"
-	// Token Token type
+	Code  ResponseType = "code"
 	Token ResponseType = "token"
 )
 
 func (rt ResponseType) String() string {
 	return string(rt)
 }
 
-// GrantType Authorization Grant
+// GrantType authorization model
 type GrantType string
 
+// define authorization model
 const (
-	// AuthorizationCode Authorization Code
-	AuthorizationCode GrantType = "authorization_code"
-	// PasswordCredentials Resource Owner Password Credentials
+	AuthorizationCode   GrantType = "authorization_code"
 	PasswordCredentials GrantType = "password"
-	// ClientCredentials Client Credentials
-	ClientCredentials GrantType = "clientcredentials"
-	// Refreshing Refresh Token
-	Refreshing GrantType = "refreshtoken"
-	// Implicit Implicit Grant
-	Implicit GrantType = "__implicit"
+	ClientCredentials   GrantType = "clientcredentials"
+	Refreshing          GrantType = "refreshtoken"
+	Implicit            GrantType = "__implicit"
 )
 
 func (gt GrantType) String() string {

example/README.md

@@ -1,35 +1,25 @@
-Authorization code simulation
-=============================
+# Authorization Code Grant
 
-Run Server
----------
+![login](https://raw.githubusercontent.com/go-oauth2/oauth2/master/example/server/static/login.png)
+![auth](https://raw.githubusercontent.com/go-oauth2/oauth2/master/example/server/static/auth.png)
+![token](https://raw.githubusercontent.com/go-oauth2/oauth2/master/example/server/static/token.png)
+
+## Run Server
 
 ``` bash
 $ cd example/server
 $ go build server.go
 $ ./server
 ```
 
-Run Client
-----------
+## Run Client
 
 ```
 $ cd example/client
 $ go build client.go
 $ ./client
 ```
 
-Open the browser
-----------------
-
-[http://localhost:9094](http://localhost:9094)
+## Open the browser
 
-``` json
-{
-    "access_token": "BIX-RYRPMHYY4L7O4QTP3Q",
-    "expires_in": 7200,
-    "refresh_token": "JRITD106WU6YNRE4UUEV_A",
-    "scope": "all",
-    "token_type": "Bearer"
-}
-```
+[http://localhost:9094](http://localhost:9094)

example/server/server.go

@@ -37,8 +37,8 @@ func main() {
 
 	srv := server.NewServer(server.NewConfig(), manager)
 	srv.SetUserAuthorizationHandler(userAuthorizeHandler)
-	srv.SetInternalErrorHandler(func(r *http.Request, err error) {
-		fmt.Println("OAuth2 Error:", r.RequestURI, err.Error())
+	srv.SetInternalErrorHandler(func(err error) {
+		fmt.Println("internal error:", err.Error())
 	})
 
 	http.HandleFunc("/login", loginHandler)

example/server/static/auth.png

@@ -3,19 +3,19 @@ package oauth2
 import "time"
 
 type (
-	// GenerateBasic Provide the basis of the generated token data
+	// GenerateBasic provide the basis of the generated token data
 	GenerateBasic struct {
-		Client   ClientInfo // The client information
-		UserID   string     // The user id
-		CreateAt time.Time  // Creation time
+		Client   ClientInfo
+		UserID   string
+		CreateAt time.Time
 	}
 
-	// AuthorizeGenerate Generate the authorization code interface
+	// AuthorizeGenerate generate the authorization code interface
 	AuthorizeGenerate interface {
 		Token(data *GenerateBasic) (code string, err error)
 	}
 
-	// AccessGenerate Generate the access and refresh tokens interface
+	// AccessGenerate generate the access and refresh tokens interface
 	AccessGenerate interface {
 		Token(data *GenerateBasic, isGenRefresh bool) (access, refresh string, err error)
 	}

example/server/static/login.png

@@ -10,16 +10,16 @@ import (
 	"gopkg.in/oauth2.v3"
 )
 
-// NewAccessGenerate Create to generate the access token instance
+// NewAccessGenerate create to generate the access token instance
 func NewAccessGenerate() *AccessGenerate {
 	return &AccessGenerate{}
 }
 
-// AccessGenerate Generate the access token
+// AccessGenerate generate the access token
 type AccessGenerate struct {
 }
 
-// Token Based on the UUID generated token
+// Token based on the UUID generated token
 func (ag *AccessGenerate) Token(data *oauth2.GenerateBasic, isGenRefresh bool) (access, refresh string, err error) {
 	buf := bytes.NewBufferString(data.Client.GetID())
 	buf.WriteString(data.UserID)

example/server/static/token.png

@@ -9,15 +9,15 @@ import (
 	"gopkg.in/oauth2.v3"
 )
 
-// NewAuthorizeGenerate Create to generate the authorize code instance
+// NewAuthorizeGenerate create to generate the authorize code instance
 func NewAuthorizeGenerate() *AuthorizeGenerate {
 	return &AuthorizeGenerate{}
 }
 
-// AuthorizeGenerate Generate the authorize code
+// AuthorizeGenerate generate the authorize code
 type AuthorizeGenerate struct{}
 
-// Token Based on the UUID generated token
+// Token based on the UUID generated token
 func (ag *AuthorizeGenerate) Token(data *oauth2.GenerateBasic) (code string, err error) {
 	buf := bytes.NewBufferString(data.Client.GetID())
 	buf.WriteString(data.UserID)

generate.go

@@ -4,44 +4,44 @@ import (
 	"time"
 )
 
-// TokenGenerateRequest Provide to generate the token request parameters
+// TokenGenerateRequest provide to generate the token request parameters
 type TokenGenerateRequest struct {
-	ClientID       string        // The client information
-	ClientSecret   string        // The client secret
-	UserID         string        // The user id
-	RedirectURI    string        // Redirect URI
-	Scope          string        // Scope of authorization
-	Code           string        // Authorization code
-	Refresh        string        // Refreshing token
-	AccessTokenExp time.Duration // Access token expiration time (in seconds)
+	ClientID       string
+	ClientSecret   string
+	UserID         string
+	RedirectURI    string
+	Scope          string
+	Code           string
+	Refresh        string
+	AccessTokenExp time.Duration
 }
 
-// Manager Authorization management interface
+// Manager authorization management interface
 type Manager interface {
-	// Check the interface implementation
+	// check the interface implementation
 	CheckInterface() (err error)
 
-	// Get the client information
+	// get the client information
 	GetClient(clientID string) (cli ClientInfo, err error)
 
-	// Generate the authorization token(code)
+	// generate the authorization token(code)
 	GenerateAuthToken(rt ResponseType, tgr *TokenGenerateRequest) (authToken TokenInfo, err error)
 
-	// Generate the access token
+	// generate the access token
 	GenerateAccessToken(rt GrantType, tgr *TokenGenerateRequest) (accessToken TokenInfo, err error)
 
-	// Refreshing an access token
+	// refreshing an access token
 	RefreshAccessToken(tgr *TokenGenerateRequest) (accessToken TokenInfo, err error)
 
-	// Use the access token to delete the token information
+	// use the access token to delete the token information
 	RemoveAccessToken(access string) (err error)
 
-	// Use the refresh token to delete the token information
+	// use the refresh token to delete the token information
 	RemoveRefreshToken(refresh string) (err error)
 
-	// According to the access token for corresponding token information
+	// according to the access token for corresponding token information
 	LoadAccessToken(access string) (ti TokenInfo, err error)
 
-	// According to the refresh token for corresponding token information
+	// according to the refresh token for corresponding token information
 	LoadRefreshToken(refresh string) (ti TokenInfo, err error)
 }

generates/access.go

@@ -4,9 +4,9 @@ import "time"
 
 // Config authorization configuration parameters
 type Config struct {
-	// access token expiration time (in seconds)
+	// access token expiration time
 	AccessTokenExp time.Duration
-	// refresh token expiration time(in seconds)
+	// refresh token expiration time
 	RefreshTokenExp time.Duration
 	// whether to generate the refreshing token
 	IsGenerateRefresh bool

generates/authorize.go

@@ -8,11 +8,11 @@ import (
 )
 
 type (
-	// ValidateURIHandler Validates that RedirectURI is contained in baseURI
+	// ValidateURIHandler validates that redirectURI is contained in baseURI
 	ValidateURIHandler func(baseURI, redirectURI string) (err error)
 )
 
-// DefaultValidateURI Validates that RedirectURI is contained in baseURI
+// DefaultValidateURI validates that redirectURI is contained in baseURI
 func DefaultValidateURI(baseURI string, redirectURI string) (err error) {
 	base, err := url.Parse(baseURI)
 	if err != nil {

manage.go

@@ -3,74 +3,44 @@ package oauth2
 import "time"
 
 type (
-	// ClientInfo The client information model interface
+	// ClientInfo the client information model interface
 	ClientInfo interface {
-		// The client id
 		GetID() string
-		// The client secret
 		GetSecret() string
-		// The client domain
 		GetDomain() string
-		// The extension data related to the client
 		GetExtraData() interface{}
 	}
 
-	// TokenInfo The token information model interface
+	// TokenInfo the token information model interface
 	TokenInfo interface {
-		// Get client id
 		GetClientID() string
-		// Set client id
 		SetClientID(string)
-		// Get user id
 		GetUserID() string
-		// Set user id
 		SetUserID(string)
-		// Get Redirect URI
 		GetRedirectURI() string
-		// Set Redirect URI
 		SetRedirectURI(string)
-		// Get Scope of authorization
 		GetScope() string
-		// Set Scope of authorization
 		SetScope(string)
 
-		// Get Authorization code
 		GetCode() string
-		// Set Authorization code
 		SetCode(string)
-		// Get Create Time
 		GetCodeCreateAt() time.Time
-		// Set Create Time
 		SetCodeCreateAt(time.Time)
-		// Get The lifetime in seconds of the authorization code
 		GetCodeExpiresIn() time.Duration
-		// Set The lifetime in seconds of the authorization code
 		SetCodeExpiresIn(time.Duration)
 
-		// Get Access Token
 		GetAccess() string
-		// Set Access Token
 		SetAccess(string)
-		// Get Create Time
 		GetAccessCreateAt() time.Time
-		// Set Create Time
 		SetAccessCreateAt(time.Time)
-		// Get The lifetime in seconds of the access token
 		GetAccessExpiresIn() time.Duration
-		// Set The lifetime in seconds of the access token
 		SetAccessExpiresIn(time.Duration)
 
-		// Get Refresh Token
 		GetRefresh() string
-		// Set Refresh Token
 		SetRefresh(string)
-		// Get Create Time
 		GetRefreshCreateAt() time.Time
-		// Set Create Time
 		SetRefreshCreateAt(time.Time)
-		// Get The lifetime in seconds of the access token
 		GetRefreshExpiresIn() time.Duration
-		// Set The lifetime in seconds of the access token
 		SetRefreshExpiresIn(time.Duration)
 	}
 )