From 4b820a8c52b9010f8ed4ff0b80e21c71f4e16587 Mon Sep 17 00:00:00 2001 From: sunho Date: Wed, 14 Mar 2018 22:52:32 +0900 Subject: [PATCH 1/7] add naver provider --- README.md | 139 ++----------------------- providers/naver/naver.go | 173 ++++++++++++++++++++++++++++++++ providers/naver/naver_test.go | 56 +++++++++++ providers/naver/session.go | 61 +++++++++++ providers/naver/session_test.go | 53 ++++++++++ 5 files changed, 351 insertions(+), 131 deletions(-) create mode 100644 providers/naver/naver.go create mode 100644 providers/naver/naver_test.go create mode 100644 providers/naver/session.go create mode 100644 providers/naver/session_test.go diff --git a/README.md b/README.md index 05b19fce5..e7758fc67 100644 --- a/README.md +++ b/README.md @@ -1,140 +1,17 @@ -# Goth: Multi-Provider Authentication for Go [![GoDoc](https://godoc.org/github.com/markbates/goth?status.svg)](https://godoc.org/github.com/markbates/goth) [![Build Status](https://travis-ci.org/markbates/goth.svg)](https://travis-ci.org/markbates/goth) +# Goth + naver provider -Package goth provides a simple, clean, and idiomatic way to write authentication -packages for Go web applications. +## Introduction -Unlike other similar packages, Goth, lets you write OAuth, OAuth2, or any other -protocol providers, as long as they implement the `Provider` and `Session` interfaces. +Naver.com is the biggest search engine in South Korea. It even has a bigger share, compared to Google. Naver provides an oauth api but it seems there's no go library for it. Since I want to use it along with others(google, facebook oauth) I implemented it on goth. -This package was inspired by [https://github.com/intridea/omniauth](https://github.com/intridea/omniauth). +## Documents regarding Naver api +english translation: https://www.drupal.org/files/issues/naver%20login_development%20guide.pdf -## Goth Needs a New Maintainer +original: https://developers.naver.com/docs/login/api/ -[https://blog.gobuffalo.io/goth-needs-a-new-maintainer-626cd47ca37b](https://blog.gobuffalo.io/goth-needs-a-new-maintainer-626cd47ca37b) - TL;DR: I, @markbates, won't be responding to any more issues, PRs, etc... for this package. A new maintainer needs to be found ASAP. Is this you? -## Installation +## Key and secret -```text -$ go get github.com/markbates/goth -``` +Since creating key and secret needs korean citizenship(phone verification), I've made them. Also I added "http://localhost:3000/auth/naver/callback" as permitted callback url. You can use them freely. -## Supported Providers -* Amazon -* Auth0 -* Azure AD -* Battle.net -* Bitbucket -* Box -* Cloud Foundry -* Dailymotion -* Deezer -* Digital Ocean -* Discord -* Dropbox -* Eve Online -* Facebook -* Fitbit -* GitHub -* Gitlab -* Google+ -* Heroku -* InfluxCloud -* Instagram -* Intercom -* Lastfm -* Linkedin -* Meetup -* MicrosoftOnline -* OneDrive -* OpenID Connect (auto discovery) -* Paypal -* SalesForce -* Slack -* Soundcloud -* Spotify -* Steam -* Stripe -* Twitch -* Twitter -* Uber -* VK -* Wepay -* Xero -* Yahoo -* Yammer - -## Examples - -See the [examples](examples) folder for a working application that lets users authenticate -through Twitter, Facebook, Google Plus etc. - -To run the example either clone the source from GitHub - -```text -$ git clone git@github.com:markbates/goth.git -``` -or use -```text -$ go get github.com/markbates/goth -``` -```text -$ cd goth/examples -$ go get -v -$ go build -$ ./examples -``` - -Now open up your browser and go to [http://localhost:3000](http://localhost:3000) to see the example. - -To actually use the different providers, please make sure you set environment variables. Example given in the examples/main.go file - -## Security Notes - -By default, gothic uses a `CookieStore` from the `gorilla/sessions` package to store session data. - -As configured, this default store (`gothic.Store`) will generate cookies with `Options`: - -```go -&Options{ - Path: "/", - Domain: "", - MaxAge: 86400 * 30, - HttpOnly: true, - Secure: false, - } -``` - -To tailor these fields for your application, you can override the `gothic.Store` variable at startup. - -The follow snippet show one way to do this: - -```go -key := "" // Replace with your SESSION_SECRET or similar -maxAge := 86400 * 30 // 30 days -isProd := false // Set to true when serving over https - -store := sessions.NewCookieStore([]byte(key)) -store.MaxAge(maxAge) -store.Options.Path = "/" -store.Options.HttpOnly = true // HttpOnly should always be enabled -store.Options.Secure = isProd - -gothic.Store = store -``` - -## Issues - -Issues always stand a significantly better chance of getting fixed if they are accompanied by a -pull request. - -## Contributing - -Would I love to see more providers? Certainly! Would you love to contribute one? Hopefully, yes! - -1. Fork it -2. Create your feature branch (git checkout -b my-new-feature) -3. Write Tests! -4. Commit your changes (git commit -am 'Add some feature') -5. Push to the branch (git push origin my-new-feature) -6. Create new Pull Request diff --git a/providers/naver/naver.go b/providers/naver/naver.go new file mode 100644 index 000000000..00a0e03c1 --- /dev/null +++ b/providers/naver/naver.go @@ -0,0 +1,173 @@ +package naver + +import ( + "bytes" + "encoding/json" + "fmt" + "io" + "io/ioutil" + "net/http" + + "github.com/markbates/goth" + "golang.org/x/oauth2" +) + +const ( + authURL = "https://nid.naver.com/oauth2.0/authorize" + tokenURL = "https://nid.naver.com/oauth2.0/token" + profileURL = "https://openapi.naver.com/v1/nid/me" +) + +// Provider is the implementation of `goth.Provider` for accessing naver.com. +type Provider struct { + ClientKey string + Secret string + CallbackURL string + HTTPClient *http.Client + config *oauth2.Config + providerName string +} + +// Name is the name used to retrive 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 +} + +func (p *Provider) Client() *http.Client { + return goth.HTTPClientWithFallBack(p.HTTPClient) +} + +// FetchUser will go to navercom 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 == "" { + return user, fmt.Errorf("%s cannot get user information without accessToken", p.providerName) + } + + request, err := http.NewRequest("GET", profileURL, nil) + if err != nil { + return user, err + } + + request.Header.Set("Authorization", "Bearer "+sess.AccessToken) + response, err := p.Client().Do(request) + if err != nil { + return user, err + } + defer response.Body.Close() + + 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 + } + + err = json.NewDecoder(bytes.NewReader(bits)).Decode(&user.RawData) + if err != nil { + return user, err + } + + err = userFromReader(bytes.NewReader(bits), &user) + return user, err +} + +// Debug is a no-op for the naver package. +func (p *Provider) Debug(debug bool) {} + +// BeginAuth asks naver.com for an authentication end-point. +func (p *Provider) BeginAuth(state string) (goth.Session, error) { + url := p.config.AuthCodeURL(state) + session := &Session{ + AuthURL: url, + } + return session, nil +} + +//RefreshTokenAvailable refresh token is provided by naver +func (p *Provider) RefreshTokenAvailable() bool { + return true +} + +//RefreshToken get new access token based on the refresh token +func (p *Provider) RefreshToken(refreshToken string) (*oauth2.Token, error) { + token := &oauth2.Token{RefreshToken: refreshToken} + ts := p.config.TokenSource(goth.ContextForClient(p.Client()), token) + newToken, err := ts.Token() + if err != nil { + return nil, err + } + return newToken, err +} + +// New creates a New provider and sets up important connection details. +// You should always call `naver.New` to get a new Provider. Never try to craete +// one manually. +// Currently Naver only supports pre-defined scopes. +// You should visit Naver Developer page in order to define your application's oauth scope. +func New(clientKey, secret, callbackURL string) *Provider { + p := &Provider{ + ClientKey: clientKey, + Secret: secret, + CallbackURL: callbackURL, + providerName: "naver", + } + p.config = newConfig(p) + return p +} + +func newConfig(p *Provider) *oauth2.Config { + c := &oauth2.Config{ + ClientID: p.ClientKey, + ClientSecret: p.Secret, + RedirectURL: p.CallbackURL, + Endpoint: oauth2.Endpoint{ + AuthURL: authURL, + TokenURL: tokenURL, + }, + Scopes: []string{}, + } + return c +} + +func userFromReader(reader io.Reader, user *goth.User) error { + u := struct { + Response struct { + ID string + Nickname string + Name string + Email string + Gender string + Age string + Birthday string + ProfileImage string `json:"profile_image"` + } + }{} + + if err := json.NewDecoder(reader).Decode(&u); err != nil { + return err + } + r := u.Response + user.Email = r.Email + user.Name = r.Name + user.NickName = r.Nickname + user.AvatarURL = r.ProfileImage + user.UserID = r.ID + user.Description = fmt.Sprintf(`{"gender":"%s","age":"%s","birthday":"%s"}`, r.Gender, r.Age, r.Birthday) + + return nil +} diff --git a/providers/naver/naver_test.go b/providers/naver/naver_test.go new file mode 100644 index 000000000..e86b3c060 --- /dev/null +++ b/providers/naver/naver_test.go @@ -0,0 +1,56 @@ +package naver_test + +import ( + "fmt" + "os" + "testing" + + "github.com/markbates/goth" + "github.com/stretchr/testify/assert" + "github.com/sunho/goth/providers/naver" +) + +func Test_New(t *testing.T) { + t.Parallel() + a := assert.New(t) + p := provider() + + a.Equal(p.ClientKey, os.Getenv("NAVER_KEY")) + a.Equal(p.Secret, os.Getenv("NAVER_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.(*naver.Session) + a.NoError(err) + a.Contains(s.AuthURL, "https://nid.naver.com/oauth2.0/authorize") + a.Contains(s.AuthURL, fmt.Sprintf("client_id=%s", os.Getenv("NAVER_KEY"))) + a.Contains(s.AuthURL, "state=test_state") +} + +func Test_SessionFromJSON(t *testing.T) { + t.Parallel() + a := assert.New(t) + + p := provider() + session, err := p.UnmarshalSession(`{"AuthURL":"ttps://nid.naver.com/oauth2.0/authorize","AccessToken":"1234567890"}`) + a.NoError(err) + + s := session.(*naver.Session) + a.Equal(s.AuthURL, "ttps://nid.naver.com/oauth2.0/authorize") + a.Equal(s.AccessToken, "1234567890") +} + +func provider() *naver.Provider { + return naver.New(os.Getenv("NAVER_KEY"), os.Getenv("NAVER_SECRET"), "/foo") +} diff --git a/providers/naver/session.go b/providers/naver/session.go new file mode 100644 index 000000000..01ad71359 --- /dev/null +++ b/providers/naver/session.go @@ -0,0 +1,61 @@ +package naver + +import ( + "encoding/json" + "errors" + "strings" + "time" + + "github.com/markbates/goth" +) + +// Session stores data during the auth process with naver.com. +type Session struct { + AuthURL string + AccessToken string + RefreshToken string + ExpiresAt time.Time +} + +// GetAuthURL will return the URL set by calling the `BeginAuth` function on the meetup.com provider. +func (s Session) GetAuthURL() (string, error) { + if s.AuthURL == "" { + return "", errors.New(goth.NoAuthUrlErrorMessage) + } + return s.AuthURL, nil +} + +// Authorize the session with naver.com 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) + 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/naver/session_test.go b/providers/naver/session_test.go new file mode 100644 index 000000000..cea7886cc --- /dev/null +++ b/providers/naver/session_test.go @@ -0,0 +1,53 @@ +package naver_test + +import ( + "testing" + + "github.com/markbates/goth" + "github.com/stretchr/testify/assert" + "github.com/sunho/goth/providers/naver" +) + +func Test_Implements_Session(t *testing.T) { + t.Parallel() + a := assert.New(t) + s := &naver.Session{} + + a.Implements((*goth.Session)(nil), s) +} + +func Test_GetAuthURL(t *testing.T) { + t.Parallel() + a := assert.New(t) + s := &naver.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 := &naver.Session{ + AuthURL: "https://nid.naver.com/oauth2.0/authorize", + AccessToken: "1234567890", + } + data := s.Marshal() + a.Equal(`{"AuthURL":"https://nid.naver.com/oauth2.0/authorize","AccessToken":"1234567890","RefreshToken":"","ExpiresAt":"0001-01-01T00:00:00Z"}`, data) +} + +func Test_String(t *testing.T) { + t.Parallel() + a := assert.New(t) + s := &naver.Session{ + AuthURL: "https://nid.naver.com/oauth2.0/authorize", + AccessToken: "1234567890", + } + + a.Equal(s.String(), s.Marshal()) +} From 4f1841d2fed2435cfd512bb4966eb18fd70424d7 Mon Sep 17 00:00:00 2001 From: sunho Date: Wed, 14 Mar 2018 22:53:44 +0900 Subject: [PATCH 2/7] add key secret --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index e7758fc67..2cf398e26 100644 --- a/README.md +++ b/README.md @@ -14,4 +14,8 @@ original: https://developers.naver.com/docs/login/api/ Since creating key and secret needs korean citizenship(phone verification), I've made them. Also I added "http://localhost:3000/auth/naver/callback" as permitted callback url. You can use them freely. +Key: 4QqFkFjcJ0JCgWJLqPYE + +Secret: t1sxmpJQNk + From 316ad8384de44ad5a3a0138ea0726d97705346a2 Mon Sep 17 00:00:00 2001 From: f9 Date: Wed, 14 Mar 2018 23:04:17 +0900 Subject: [PATCH 3/7] Update README.md --- README.md | 139 ++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 129 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 2cf398e26..05b19fce5 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,140 @@ -# Goth + naver provider +# Goth: Multi-Provider Authentication for Go [![GoDoc](https://godoc.org/github.com/markbates/goth?status.svg)](https://godoc.org/github.com/markbates/goth) [![Build Status](https://travis-ci.org/markbates/goth.svg)](https://travis-ci.org/markbates/goth) -## Introduction +Package goth provides a simple, clean, and idiomatic way to write authentication +packages for Go web applications. -Naver.com is the biggest search engine in South Korea. It even has a bigger share, compared to Google. Naver provides an oauth api but it seems there's no go library for it. Since I want to use it along with others(google, facebook oauth) I implemented it on goth. +Unlike other similar packages, Goth, lets you write OAuth, OAuth2, or any other +protocol providers, as long as they implement the `Provider` and `Session` interfaces. -## Documents regarding Naver api -english translation: https://www.drupal.org/files/issues/naver%20login_development%20guide.pdf +This package was inspired by [https://github.com/intridea/omniauth](https://github.com/intridea/omniauth). -original: https://developers.naver.com/docs/login/api/ +## Goth Needs a New Maintainer +[https://blog.gobuffalo.io/goth-needs-a-new-maintainer-626cd47ca37b](https://blog.gobuffalo.io/goth-needs-a-new-maintainer-626cd47ca37b) - TL;DR: I, @markbates, won't be responding to any more issues, PRs, etc... for this package. A new maintainer needs to be found ASAP. Is this you? -## Key and secret +## Installation -Since creating key and secret needs korean citizenship(phone verification), I've made them. Also I added "http://localhost:3000/auth/naver/callback" as permitted callback url. You can use them freely. +```text +$ go get github.com/markbates/goth +``` -Key: 4QqFkFjcJ0JCgWJLqPYE +## Supported Providers -Secret: t1sxmpJQNk +* Amazon +* Auth0 +* Azure AD +* Battle.net +* Bitbucket +* Box +* Cloud Foundry +* Dailymotion +* Deezer +* Digital Ocean +* Discord +* Dropbox +* Eve Online +* Facebook +* Fitbit +* GitHub +* Gitlab +* Google+ +* Heroku +* InfluxCloud +* Instagram +* Intercom +* Lastfm +* Linkedin +* Meetup +* MicrosoftOnline +* OneDrive +* OpenID Connect (auto discovery) +* Paypal +* SalesForce +* Slack +* Soundcloud +* Spotify +* Steam +* Stripe +* Twitch +* Twitter +* Uber +* VK +* Wepay +* Xero +* Yahoo +* Yammer +## Examples +See the [examples](examples) folder for a working application that lets users authenticate +through Twitter, Facebook, Google Plus etc. + +To run the example either clone the source from GitHub + +```text +$ git clone git@github.com:markbates/goth.git +``` +or use +```text +$ go get github.com/markbates/goth +``` +```text +$ cd goth/examples +$ go get -v +$ go build +$ ./examples +``` + +Now open up your browser and go to [http://localhost:3000](http://localhost:3000) to see the example. + +To actually use the different providers, please make sure you set environment variables. Example given in the examples/main.go file + +## Security Notes + +By default, gothic uses a `CookieStore` from the `gorilla/sessions` package to store session data. + +As configured, this default store (`gothic.Store`) will generate cookies with `Options`: + +```go +&Options{ + Path: "/", + Domain: "", + MaxAge: 86400 * 30, + HttpOnly: true, + Secure: false, + } +``` + +To tailor these fields for your application, you can override the `gothic.Store` variable at startup. + +The follow snippet show one way to do this: + +```go +key := "" // Replace with your SESSION_SECRET or similar +maxAge := 86400 * 30 // 30 days +isProd := false // Set to true when serving over https + +store := sessions.NewCookieStore([]byte(key)) +store.MaxAge(maxAge) +store.Options.Path = "/" +store.Options.HttpOnly = true // HttpOnly should always be enabled +store.Options.Secure = isProd + +gothic.Store = store +``` + +## Issues + +Issues always stand a significantly better chance of getting fixed if they are accompanied by a +pull request. + +## Contributing + +Would I love to see more providers? Certainly! Would you love to contribute one? Hopefully, yes! + +1. Fork it +2. Create your feature branch (git checkout -b my-new-feature) +3. Write Tests! +4. Commit your changes (git commit -am 'Add some feature') +5. Push to the branch (git push origin my-new-feature) +6. Create new Pull Request From 325d8d73ced683ae6b2ab178be778638cfe8e0b1 Mon Sep 17 00:00:00 2001 From: f9 Date: Wed, 14 Mar 2018 23:08:47 +0900 Subject: [PATCH 4/7] Update naver_test.go --- providers/naver/naver_test.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/providers/naver/naver_test.go b/providers/naver/naver_test.go index e86b3c060..e9e323522 100644 --- a/providers/naver/naver_test.go +++ b/providers/naver/naver_test.go @@ -7,7 +7,7 @@ import ( "github.com/markbates/goth" "github.com/stretchr/testify/assert" - "github.com/sunho/goth/providers/naver" + "github.com/markbates/goth/providers/naver" ) func Test_New(t *testing.T) { From 99fa28d7e922f65ca09caa4819ff9ce452b22b2d Mon Sep 17 00:00:00 2001 From: f9 Date: Wed, 14 Mar 2018 23:08:59 +0900 Subject: [PATCH 5/7] Update session_test.go --- providers/naver/session_test.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/providers/naver/session_test.go b/providers/naver/session_test.go index cea7886cc..65dc905e3 100644 --- a/providers/naver/session_test.go +++ b/providers/naver/session_test.go @@ -5,7 +5,7 @@ import ( "github.com/markbates/goth" "github.com/stretchr/testify/assert" - "github.com/sunho/goth/providers/naver" + "github.com/markbates/goth/providers/naver" ) func Test_Implements_Session(t *testing.T) { From bf036883446ec0bf746cc182f3baea400e1feddc Mon Sep 17 00:00:00 2001 From: f9 Date: Wed, 14 Mar 2018 23:47:43 +0900 Subject: [PATCH 6/7] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 05b19fce5..737d9ecff 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,7 @@ $ go get github.com/markbates/goth * Linkedin * Meetup * MicrosoftOnline +* Naver * OneDrive * OpenID Connect (auto discovery) * Paypal From c4d40670cfd69f412af76c32d8beebc2fc6f32a8 Mon Sep 17 00:00:00 2001 From: sunho Date: Thu, 15 Mar 2018 00:19:05 +0900 Subject: [PATCH 7/7] edit: examples --- examples/main.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/examples/main.go b/examples/main.go index d43fbe348..e521abd60 100644 --- a/examples/main.go +++ b/examples/main.go @@ -37,6 +37,7 @@ import ( "github.com/markbates/goth/providers/linkedin" "github.com/markbates/goth/providers/meetup" "github.com/markbates/goth/providers/microsoftonline" + "github.com/markbates/goth/providers/naver" "github.com/markbates/goth/providers/onedrive" "github.com/markbates/goth/providers/openidConnect" "github.com/markbates/goth/providers/paypal" @@ -108,6 +109,7 @@ func main() { auth0.New(os.Getenv("AUTH0_KEY"), os.Getenv("AUTH0_SECRET"), "http://localhost:3000/auth/auth0/callback", os.Getenv("AUTH0_DOMAIN")), xero.New(os.Getenv("XERO_KEY"), os.Getenv("XERO_SECRET"), "http://localhost:3000/auth/xero/callback"), vk.New(os.Getenv("VK_KEY"), os.Getenv("VK_SECRET"), "http://localhost:3000/auth/vk/callback"), + naver.New(os.Getenv("NAVER_KEY"), os.Getenv("NAVER_SECRET"), "http://localhost:3000/auth/naver/callback"), ) // OpenID Connect is based on OpenID Connect Auto Discovery URL (https://openid.net/specs/openid-connect-discovery-1_0-17.html) @@ -160,6 +162,7 @@ func main() { m["openid-connect"] = "OpenID Connect" m["xero"] = "Xero" m["vk"] = "VK" + m["naver"] = "Naver" var keys []string for k := range m {