diff --git a/README.md b/README.md index 7e0e8e8f4..12973ceec 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,7 @@ $ go get github.com/markbates/goth * InfluxCloud * Instagram * Intercom +* Kakao * Lastfm * Linkedin * LINE diff --git a/examples/main.go b/examples/main.go index 90137f4e5..aa8ee33da 100644 --- a/examples/main.go +++ b/examples/main.go @@ -36,6 +36,7 @@ import ( "github.com/markbates/goth/providers/heroku" "github.com/markbates/goth/providers/instagram" "github.com/markbates/goth/providers/intercom" + "github.com/markbates/goth/providers/kakao" "github.com/markbates/goth/providers/lastfm" "github.com/markbates/goth/providers/line" "github.com/markbates/goth/providers/linkedin" @@ -98,6 +99,7 @@ func main() { microsoftonline.New(os.Getenv("MICROSOFTONLINE_KEY"), os.Getenv("MICROSOFTONLINE_SECRET"), "http://localhost:3000/auth/microsoftonline/callback"), battlenet.New(os.Getenv("BATTLENET_KEY"), os.Getenv("BATTLENET_SECRET"), "http://localhost:3000/auth/battlenet/callback"), eveonline.New(os.Getenv("EVEONLINE_KEY"), os.Getenv("EVEONLINE_SECRET"), "http://localhost:3000/auth/eveonline/callback"), + kakao.New(os.Getenv("KAKAO_KEY"), os.Getenv("KAKAO_SECRET"), "http://localhost:3000/auth/kakao/callback"), //Pointed localhost.com to http://localhost:3000/auth/yahoo/callback through proxy as yahoo // does not allow to put custom ports in redirection uri @@ -170,6 +172,7 @@ func main() { m["heroku"] = "Heroku" m["instagram"] = "Instagram" m["intercom"] = "Intercom" + m["kakao"] = "Kakao" m["lastfm"] = "Last FM" m["linkedin"] = "Linkedin" m["line"] = "LINE" diff --git a/providers/kakao/kakao.go b/providers/kakao/kakao.go new file mode 100644 index 000000000..8743f4d21 --- /dev/null +++ b/providers/kakao/kakao.go @@ -0,0 +1,163 @@ +// Package kakao implements the OAuth2 protocol for authenticating users through kakao. +// This package can be used as a reference implementation of an OAuth2 provider for Goth. +package kakao + +import ( + "bytes" + "encoding/json" + "io/ioutil" + "net/http" + "strconv" + + "fmt" + + "github.com/markbates/goth" + "golang.org/x/oauth2" +) + +const ( + authURL string = "https://kauth.kakao.com/oauth/authorize" + tokenURL string = "https://kauth.kakao.com/oauth/token" + endpointUser string = "https://kapi.kakao.com/v2/user/me" +) + +// Provider is the implementation of `goth.Provider` for accessing Kakao. +type Provider struct { + ClientKey string + Secret string + CallbackURL string + HTTPClient *http.Client + config *oauth2.Config + providerName string +} + +// New creates a new Kakao provider and sets up important connection details. +// You should always call `kakao.New` to get a new provider. Never try to +// create one manually. +func New(clientKey, secret, callbackURL string, scopes ...string) *Provider { + p := &Provider{ + ClientKey: clientKey, + Secret: secret, + CallbackURL: callbackURL, + providerName: "kakao", + } + p.config = newConfig(p, scopes) + return p +} + +// Name is the name used to retrieve this provider later. +func (p *Provider) Name() string { + return p.providerName +} + +// SetName is to update the name of the provider (needed in case of multiple providers of 1 type) +func (p *Provider) SetName(name string) { + p.providerName = name +} + +// Client returns a pointer to http.Client setting some client fallback. +func (p *Provider) Client() *http.Client { + return goth.HTTPClientWithFallBack(p.HTTPClient) +} + +// Debug is a no-op for the kakao package. +func (p *Provider) Debug(debug bool) {} + +// BeginAuth asks kakao for an authentication end-point. +func (p *Provider) BeginAuth(state string) (goth.Session, error) { + return &Session{ + AuthURL: p.config.AuthCodeURL(state), + }, nil +} + +// FetchUser will go to kakao and access basic information about the user. +func (p *Provider) FetchUser(session goth.Session) (goth.User, error) { + sess := session.(*Session) + user := goth.User{ + AccessToken: sess.AccessToken, + Provider: p.Name(), + RefreshToken: sess.RefreshToken, + ExpiresAt: sess.ExpiresAt, + } + + if user.AccessToken == "" { + // data is not yet retrieved since accessToken is still empty + return user, fmt.Errorf("%s cannot get user information without accessToken", p.providerName) + } + + // Get the userID, kakao needs userID in order to get user profile info + c := p.Client() + req, err := http.NewRequest("GET", endpointUser, nil) + if err != nil { + return user, err + } + + req.Header.Add("Authorization", "Bearer "+sess.AccessToken) + + response, err := c.Do(req) + if err != nil { + if response != nil { + response.Body.Close() + } + return user, err + } + + if response.StatusCode != http.StatusOK { + return user, fmt.Errorf("%s responded with a %d trying to fetch user information", p.providerName, response.StatusCode) + } + + bits, err := ioutil.ReadAll(response.Body) + if err != nil { + return user, err + } + + u := struct { + ID int `json:"id"` + Properties struct { + Nickname string `json:"nickname"` + ThumbnailImage string `json:"thumbnail_image"` + ProfileImage string `json:"profile_image"` + } `json:"properties"` + }{} + + if err = json.NewDecoder(bytes.NewReader(bits)).Decode(&u); err != nil { + return user, err + } + + id := strconv.Itoa(u.ID) + + user.NickName = u.Properties.Nickname + user.AvatarURL = u.Properties.ProfileImage + user.UserID = id + return user, err +} + +func newConfig(provider *Provider, scopes []string) *oauth2.Config { + c := &oauth2.Config{ + ClientID: provider.ClientKey, + ClientSecret: provider.Secret, + RedirectURL: provider.CallbackURL, + Endpoint: oauth2.Endpoint{ + AuthURL: authURL, + TokenURL: tokenURL, + }, + Scopes: []string{}, + } + + if len(scopes) > 0 { + for _, scope := range scopes { + c.Scopes = append(c.Scopes, scope) + } + } + return c +} + +//RefreshTokenAvailable refresh token is provided by auth provider or not +func (p *Provider) RefreshTokenAvailable() bool { + return false +} + +//RefreshToken get new access token based on the refresh token +func (p *Provider) RefreshToken(refreshToken string) (*oauth2.Token, error) { + return nil, nil +} diff --git a/providers/kakao/kakao_test.go b/providers/kakao/kakao_test.go new file mode 100644 index 000000000..2221ab68f --- /dev/null +++ b/providers/kakao/kakao_test.go @@ -0,0 +1,53 @@ +package kakao_test + +import ( + "os" + "testing" + + "github.com/markbates/goth" + "github.com/markbates/goth/providers/kakao" + "github.com/stretchr/testify/assert" +) + +func Test_New(t *testing.T) { + t.Parallel() + a := assert.New(t) + p := provider() + + a.Equal(p.ClientKey, os.Getenv("KAKAO_CLIENT_ID")) + a.Equal(p.Secret, os.Getenv("KAKAO_CLIENT_SECRET")) + a.Equal(p.CallbackURL, "/foo") +} + +func Test_Implements_Provider(t *testing.T) { + t.Parallel() + a := assert.New(t) + a.Implements((*goth.Provider)(nil), provider()) +} + +func Test_BeginAuth(t *testing.T) { + t.Parallel() + a := assert.New(t) + p := provider() + session, err := p.BeginAuth("test_state") + s := session.(*kakao.Session) + a.NoError(err) + a.Contains(s.AuthURL, "https://kauth.kakao.com/oauth/authorize") +} + +func Test_SessionFromJSON(t *testing.T) { + t.Parallel() + a := assert.New(t) + + p := provider() + session, err := p.UnmarshalSession(`{"AuthURL":"https://kauth.kakao.com/oauth/authorize","AccessToken":"1234567890"}`) + a.NoError(err) + + s := session.(*kakao.Session) + a.Equal(s.AuthURL, "https://kauth.kakao.com/oauth/authorize") + a.Equal(s.AccessToken, "1234567890") +} + +func provider() *kakao.Provider { + return kakao.New(os.Getenv("KAKAO_CLIENT_ID"), os.Getenv("KAKAO_CLIENT_SECRET"), "/foo") +} diff --git a/providers/kakao/session.go b/providers/kakao/session.go new file mode 100644 index 000000000..3eb401e77 --- /dev/null +++ b/providers/kakao/session.go @@ -0,0 +1,65 @@ +package kakao + +import ( + "encoding/json" + "errors" + "strings" + "time" + + "github.com/markbates/goth" + "golang.org/x/oauth2" +) + +// Session stores data during the auth process with Kakao. +type Session struct { + AuthURL string + AccessToken string + RefreshToken string + ExpiresAt time.Time +} + +var _ goth.Session = &Session{} + +// GetAuthURL will return the URL set by calling the `BeginAuth` function on the Kakao provider. +func (s Session) GetAuthURL() (string, error) { + if s.AuthURL == "" { + return "", errors.New(goth.NoAuthUrlErrorMessage) + } + return s.AuthURL, nil +} + +// Authorize the session with Kakao and return the access token to be stored for future use. +func (s *Session) Authorize(provider goth.Provider, params goth.Params) (string, error) { + p := provider.(*Provider) + oauth2.RegisterBrokenAuthHeaderProvider(tokenURL) + token, err := p.config.Exchange(goth.ContextForClient(p.Client()), params.Get("code")) + if err != nil { + return "", err + } + + if !token.Valid() { + return "", errors.New("Invalid token received from provider") + } + + s.AccessToken = token.AccessToken + s.RefreshToken = token.RefreshToken + s.ExpiresAt = token.Expiry + return token.AccessToken, err +} + +// Marshal the session into a string +func (s Session) Marshal() string { + b, _ := json.Marshal(s) + return string(b) +} + +func (s Session) String() string { + return s.Marshal() +} + +// UnmarshalSession wil unmarshal a JSON string into a session. +func (p *Provider) UnmarshalSession(data string) (goth.Session, error) { + s := &Session{} + err := json.NewDecoder(strings.NewReader(data)).Decode(s) + return s, err +} diff --git a/providers/kakao/session_test.go b/providers/kakao/session_test.go new file mode 100644 index 000000000..bf17a6a3a --- /dev/null +++ b/providers/kakao/session_test.go @@ -0,0 +1,48 @@ +package kakao_test + +import ( + "testing" + + "github.com/markbates/goth" + "github.com/markbates/goth/providers/line" + "github.com/stretchr/testify/assert" +) + +func Test_Implements_Session(t *testing.T) { + t.Parallel() + a := assert.New(t) + s := &line.Session{} + + a.Implements((*goth.Session)(nil), s) +} + +func Test_GetAuthURL(t *testing.T) { + t.Parallel() + a := assert.New(t) + s := &line.Session{} + + _, err := s.GetAuthURL() + a.Error(err) + + s.AuthURL = "/foo" + + url, _ := s.GetAuthURL() + a.Equal(url, "/foo") +} + +func Test_ToJSON(t *testing.T) { + t.Parallel() + a := assert.New(t) + s := &line.Session{} + + data := s.Marshal() + a.Equal(data, `{"AuthURL":"","AccessToken":"","RefreshToken":"","ExpiresAt":"0001-01-01T00:00:00Z"}`) +} + +func Test_String(t *testing.T) { + t.Parallel() + a := assert.New(t) + s := &line.Session{} + + a.Equal(s.String(), s.Marshal()) +}