* 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 <xiaolunwen@gmail.com> Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: guillep2k <18600385+guillep2k@users.noreply.github.com> Co-authored-by: techknowlogick <matti@mdranta.net> Co-authored-by: Lauris BH <lauris@nix.lv>tokarchuk/v1.17
Lauris BH
5 years ago
committed by
GitHub
parent
afa1e1af16
commit
3d5d21133c
|
After Width: | Height: | Size: 826 B |
@ -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 |
||||
} |
||||
@ -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 |
||||
} |
||||
Loading…
Reference in new issue