From 3d5d21133ca93ab5ab4482bac11ca7c4fa21c407 Mon Sep 17 00:00:00 2001 From: Lauris BH Date: Thu, 5 Mar 2020 00:08:52 +0200 Subject: [PATCH] OAuth2: add Yandex provider (#8335) (#10564) * OAuth2: add Yandex provider (#8335) * remove changes from locale ru-RU * fmt modules/auth/oauth2/oauth2.go Co-Authored-By: 6543 <6543@obermui.de> * fix fmt * Update templates/admin/auth/new.tmpl * fix fmt Co-authored-by: Lunny Xiao Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: guillep2k <18600385+guillep2k@users.noreply.github.com> Co-authored-by: techknowlogick Co-authored-by: Lauris BH --- models/oauth2.go | 1 + modules/auth/oauth2/oauth2.go | 4 + options/locale/locale_en-US.ini | 1 + public/img/auth/yandex.png | Bin 0 -> 826 bytes templates/admin/auth/new.tmpl | 2 + .../goth/providers/yandex/session.go | 64 ++++++ .../markbates/goth/providers/yandex/yandex.go | 183 ++++++++++++++++++ vendor/modules.txt | 1 + 8 files changed, 256 insertions(+) create mode 100644 public/img/auth/yandex.png create mode 100644 vendor/github.com/markbates/goth/providers/yandex/session.go create mode 100644 vendor/github.com/markbates/goth/providers/yandex/yandex.go diff --git a/models/oauth2.go b/models/oauth2.go index 8164699d8..1fb4783d0 100644 --- a/models/oauth2.go +++ b/models/oauth2.go @@ -58,6 +58,7 @@ var OAuth2Providers = map[string]OAuth2Provider{ ProfileURL: oauth2.GetDefaultProfileURL("nextcloud"), }, }, + "yandex": {Name: "yandex", DisplayName: "Yandex", Image: "/img/auth/yandex.png"}, } // OAuth2DefaultCustomURLMappings contains the map of default URL's for OAuth2 providers that are allowed to have custom urls diff --git a/modules/auth/oauth2/oauth2.go b/modules/auth/oauth2/oauth2.go index 193a87c4e..0b18afdaf 100644 --- a/modules/auth/oauth2/oauth2.go +++ b/modules/auth/oauth2/oauth2.go @@ -25,6 +25,7 @@ import ( "github.com/markbates/goth/providers/nextcloud" "github.com/markbates/goth/providers/openidConnect" "github.com/markbates/goth/providers/twitter" + "github.com/markbates/goth/providers/yandex" "github.com/satori/go.uuid" "xorm.io/xorm" ) @@ -209,6 +210,9 @@ func createProvider(providerName, providerType, clientID, clientSecret, openIDCo } } provider = nextcloud.NewCustomisedURL(clientID, clientSecret, callbackURL, authURL, tokenURL, profileURL) + case "yandex": + // See https://tech.yandex.com/passport/doc/dg/reference/response-docpage/ + provider = yandex.New(clientID, clientSecret, callbackURL, "login:email", "login:info", "login:avatar") } // always set the name if provider is created so we can support multiple setups of 1 provider diff --git a/options/locale/locale_en-US.ini b/options/locale/locale_en-US.ini index ee58de627..b43fe51ef 100644 --- a/options/locale/locale_en-US.ini +++ b/options/locale/locale_en-US.ini @@ -1937,6 +1937,7 @@ auths.tip.openid_connect = Use the OpenID Connect Discovery URL (/.well- auths.tip.twitter = Go to https://dev.twitter.com/apps, create an application and ensure that the “Allow this application to be used to Sign in with Twitter” option is enabled auths.tip.discord = Register a new application on https://discordapp.com/developers/applications/me auths.tip.gitea = Register a new OAuth2 application. Guide can be found at https://docs.gitea.io/en-us/oauth2-provider/ +auths.tip.yandex = Create a new application at https://oauth.yandex.com/client/new. Select following permissions from the "Yandex.Passport API" section: "Access to email address", "Access to user avatar" and "Access to username, first name and surname, gender" auths.edit = Edit Authentication Source auths.activated = This Authentication Source is Activated auths.new_success = The authentication '%s' has been added. diff --git a/public/img/auth/yandex.png b/public/img/auth/yandex.png new file mode 100644 index 0000000000000000000000000000000000000000..3414ad4249335496f8bbbbf0da2f4cf5e8876fd9 GIT binary patch literal 826 zcmV-A1I7G_P)SF9J6{O z6P<5_?_;0*4$#@>iQXEM?|Gv>z9&z)oGv6wc|!#tGq&ultn9C|Lf@}oQo4ZQ#@ya0 zL_Pg~fXV0$`X@~1jbSn~37dCOpbwX8zvCKulRV{CtpXnHBKg0s>tH2%6Yp46H;($? zIhmPGP&J(1`tluRAa{HvgWx#0lkz`a2bkl_vP2!G_vd^>Cn${1MdynV3G-402G7Mz z-ceOSs2PjW0cyq~I{UmtnaCY?tHw4Q=XbEo)8z`|*qJiXaICGf#b5WsL>-X-ccQ!@ z|IWr#l#B_y@q<(UPD#?q>+u=JL7zkZC~uyA)f<$sjZ-_ioaT;wC>i?vuCK3t1|~qCF0T`3it2#*nVx3B zJD!vqqY7&<9$tZo!$pb+-2KgVg}sRkK*Ejfov*O4EkekrfBQsO0c{_ zc{Cdh<1D=-vOS{_?)AJeFe=My#C%lLWoD7^9HWsrHjUEqDvamFq?QkxhdD=EI`56r z^2&^@LPx}NG(b4odSh6WmRIlw3djFqGW-f4b8M?DuW-Pk*~wEb&`ToAdE*gnc|}0A z!h-tJl-s?dsx7a0y#3cy5ISdhMeuHqw!9+Zm-(4IWVIa%Sc%vOmbvb{{.i18n.Tr "admin.auths.tip.gitea"}}
  • Nextcloud
    • {{.i18n.Tr "admin.auths.tip.nextcloud"}} +
  • Yandex
    • + {{.i18n.Tr "admin.auths.tip.yandex"}} diff --git a/vendor/github.com/markbates/goth/providers/yandex/session.go b/vendor/github.com/markbates/goth/providers/yandex/session.go new file mode 100644 index 000000000..587941664 --- /dev/null +++ b/vendor/github.com/markbates/goth/providers/yandex/session.go @@ -0,0 +1,64 @@ +package yandex + +import ( + "encoding/json" + "errors" + "strings" + "time" + + "github.com/markbates/goth" + "golang.org/x/oauth2" +) + +// Session stores data during the auth process with Yandex. +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 Yandex provider. +func (s Session) GetAuthURL() (string, error) { + if s.AuthURL == "" { + return "", errors.New(goth.NoAuthUrlErrorMessage) + } + return s.AuthURL, nil +} + +// Authorize the session with Yandex 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(oauth2.NoContext, 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 will 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/vendor/github.com/markbates/goth/providers/yandex/yandex.go b/vendor/github.com/markbates/goth/providers/yandex/yandex.go new file mode 100644 index 000000000..2db41512d --- /dev/null +++ b/vendor/github.com/markbates/goth/providers/yandex/yandex.go @@ -0,0 +1,183 @@ +// package yandex implements the OAuth2 protocol for authenticating users through Yandex. +// This package can be used as a reference implementation of an OAuth2 provider for Goth. +package yandex + +import ( + "bytes" + "encoding/json" + "io" + "io/ioutil" + "net/http" + + "fmt" + "github.com/markbates/goth" + "golang.org/x/oauth2" +) + +const ( + authEndpoint string = "https://oauth.yandex.ru/authorize" + tokenEndpoint string = "https://oauth.yandex.com/token" + profileEndpoint string = "https://login.yandex.ru/info" + avatarURL string = "https://avatars.yandex.net/get-yapic" + avatarSize string = "islands-200" +) + +// Provider is the implementation of `goth.Provider` for accessing Yandex. +type Provider struct { + ClientKey string + Secret string + CallbackURL string + HTTPClient *http.Client + config *oauth2.Config + providerName string +} + +// New creates a new Yandex provider and sets up important connection details. +// You should always call `yandex.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: "yandex", + } + p.config = newConfig(p, scopes) + return p +} + +func (p *Provider) Client() *http.Client { + return goth.HTTPClientWithFallBack(p.HTTPClient) +} + +// 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 +} + +// Debug is a no-op for the yandex package. +func (p *Provider) Debug(debug bool) {} + +// BeginAuth asks Yandex 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 Yandex 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) + } + + req, err := http.NewRequest("GET", profileEndpoint, nil) + if err != nil { + return user, err + } + req.Header.Set("Authorization", "OAuth " + sess.AccessToken) + resp, err := p.Client().Do(req) + if err != nil { + if resp != nil { + resp.Body.Close() + } + return user, err + } + defer resp.Body.Close() + + if resp.StatusCode != http.StatusOK { + return user, fmt.Errorf("%s responded with a %d trying to fetch user information", p.providerName, resp.StatusCode) + } + + bits, err := ioutil.ReadAll(resp.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 +} + +func newConfig(provider *Provider, scopes []string) *oauth2.Config { + c := &oauth2.Config{ + ClientID: provider.ClientKey, + ClientSecret: provider.Secret, + RedirectURL: provider.CallbackURL, + Endpoint: oauth2.Endpoint{ + AuthURL: authEndpoint, + TokenURL: tokenEndpoint, + }, + Scopes: []string{}, + } + if len(scopes) > 0 { + for _, scope := range scopes { + c.Scopes = append(c.Scopes, scope) + } + } else { + c.Scopes = append(c.Scopes, "login:email login:info login:avatar") + } + return c +} + +func userFromReader(r io.Reader, user *goth.User) error { + u := struct { + UserID string `json:"id"` + Email string `json:"default_email"` + Login string `json:"login"` + Name string `json:"real_name"` + FirstName string `json:"first_name"` + LastName string `json:"last_name"` + AvatarID string `json:"default_avatar_id"` + IsAvatarEmpty bool `json:"is_avatar_empty"` + }{} + + err := json.NewDecoder(r).Decode(&u) + if err != nil { + return err + } + user.UserID = u.UserID + user.Email = u.Email + user.NickName = u.Login + user.Name = u.Name + user.FirstName = u.FirstName + user.LastName = u.LastName + if u.AvatarID != `` { + user.AvatarURL = fmt.Sprintf("%s/%s/%s", avatarURL, u.AvatarID, avatarSize) + } + return nil +} + +//RefreshTokenAvailable refresh token is provided by auth provider or not +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 +} diff --git a/vendor/modules.txt b/vendor/modules.txt index 80f3b6ac0..28bf533ec 100644 --- a/vendor/modules.txt +++ b/vendor/modules.txt @@ -314,6 +314,7 @@ github.com/markbates/goth/providers/google github.com/markbates/goth/providers/nextcloud github.com/markbates/goth/providers/openidConnect github.com/markbates/goth/providers/twitter +github.com/markbates/goth/providers/yandex # github.com/mattn/go-isatty v0.0.7 github.com/mattn/go-isatty # github.com/mattn/go-sqlite3 v1.11.0