267 lines
7.0 KiB
Go
267 lines
7.0 KiB
Go
// Package gitea provides authentication strategies using Gitea.
|
|
package gitea
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
"net/http"
|
|
"strconv"
|
|
"sync"
|
|
"time"
|
|
|
|
"golang.org/x/oauth2"
|
|
|
|
"github.com/dexidp/dex/connector"
|
|
"github.com/dexidp/dex/pkg/log"
|
|
)
|
|
|
|
// Config holds configuration options for gitea logins.
|
|
type Config struct {
|
|
BaseURL string `json:"baseURL"`
|
|
ClientID string `json:"clientID"`
|
|
ClientSecret string `json:"clientSecret"`
|
|
RedirectURI string `json:"redirectURI"`
|
|
UseLoginAsID bool `json:"useLoginAsID"`
|
|
}
|
|
|
|
type giteaUser struct {
|
|
ID int `json:"id"`
|
|
Name string `json:"full_name"`
|
|
Username string `json:"login"`
|
|
Email string `json:"email"`
|
|
IsAdmin bool `json:"is_admin"`
|
|
}
|
|
|
|
// Open returns a strategy for logging in through GitLab.
|
|
func (c *Config) Open(id string, logger log.Logger) (connector.Connector, error) {
|
|
if c.BaseURL == "" {
|
|
c.BaseURL = "https://gitea.com"
|
|
}
|
|
return &giteaConnector{
|
|
baseURL: c.BaseURL,
|
|
redirectURI: c.RedirectURI,
|
|
clientID: c.ClientID,
|
|
clientSecret: c.ClientSecret,
|
|
logger: logger,
|
|
useLoginAsID: c.UseLoginAsID,
|
|
}, nil
|
|
}
|
|
|
|
type connectorData struct {
|
|
AccessToken string `json:"accessToken"`
|
|
RefreshToken string `json:"refreshToken"`
|
|
Expiry time.Time `json:"expiry"`
|
|
}
|
|
|
|
var (
|
|
_ connector.CallbackConnector = (*giteaConnector)(nil)
|
|
_ connector.RefreshConnector = (*giteaConnector)(nil)
|
|
)
|
|
|
|
type giteaConnector struct {
|
|
baseURL string
|
|
redirectURI string
|
|
clientID string
|
|
clientSecret string
|
|
logger log.Logger
|
|
httpClient *http.Client
|
|
// if set to true will use the user's handle rather than their numeric id as the ID
|
|
useLoginAsID bool
|
|
}
|
|
|
|
func (c *giteaConnector) oauth2Config(_ connector.Scopes) *oauth2.Config {
|
|
giteaEndpoint := oauth2.Endpoint{AuthURL: c.baseURL + "/login/oauth/authorize", TokenURL: c.baseURL + "/login/oauth/access_token"}
|
|
return &oauth2.Config{
|
|
ClientID: c.clientID,
|
|
ClientSecret: c.clientSecret,
|
|
Endpoint: giteaEndpoint,
|
|
RedirectURL: c.redirectURI,
|
|
}
|
|
}
|
|
|
|
func (c *giteaConnector) LoginURL(scopes connector.Scopes, callbackURL, state string) (string, error) {
|
|
if c.redirectURI != callbackURL {
|
|
return "", fmt.Errorf("expected callback URL %q did not match the URL in the config %q", c.redirectURI, callbackURL)
|
|
}
|
|
return c.oauth2Config(scopes).AuthCodeURL(state), nil
|
|
}
|
|
|
|
type oauth2Error struct {
|
|
error string
|
|
errorDescription string
|
|
}
|
|
|
|
func (e *oauth2Error) Error() string {
|
|
if e.errorDescription == "" {
|
|
return e.error
|
|
}
|
|
return e.error + ": " + e.errorDescription
|
|
}
|
|
|
|
func (c *giteaConnector) HandleCallback(s connector.Scopes, r *http.Request) (identity connector.Identity, err error) {
|
|
q := r.URL.Query()
|
|
if errType := q.Get("error"); errType != "" {
|
|
return identity, &oauth2Error{errType, q.Get("error_description")}
|
|
}
|
|
|
|
oauth2Config := c.oauth2Config(s)
|
|
|
|
ctx := r.Context()
|
|
if c.httpClient != nil {
|
|
ctx = context.WithValue(r.Context(), oauth2.HTTPClient, c.httpClient)
|
|
}
|
|
|
|
token, err := oauth2Config.Exchange(ctx, q.Get("code"))
|
|
if err != nil {
|
|
return identity, fmt.Errorf("gitea: failed to get token: %v", err)
|
|
}
|
|
|
|
client := oauth2Config.Client(ctx, token)
|
|
|
|
user, err := c.user(ctx, client)
|
|
if err != nil {
|
|
return identity, fmt.Errorf("gitea: get user: %v", err)
|
|
}
|
|
|
|
username := user.Name
|
|
if username == "" {
|
|
username = user.Email
|
|
}
|
|
identity = connector.Identity{
|
|
UserID: strconv.Itoa(user.ID),
|
|
Username: username,
|
|
PreferredUsername: user.Username,
|
|
Email: user.Email,
|
|
EmailVerified: true,
|
|
}
|
|
if c.useLoginAsID {
|
|
identity.UserID = user.Username
|
|
}
|
|
|
|
if s.OfflineAccess {
|
|
data := connectorData{
|
|
AccessToken: token.AccessToken,
|
|
RefreshToken: token.RefreshToken,
|
|
Expiry: token.Expiry,
|
|
}
|
|
connData, err := json.Marshal(data)
|
|
if err != nil {
|
|
return identity, fmt.Errorf("gitea: marshal connector data: %v", err)
|
|
}
|
|
identity.ConnectorData = connData
|
|
}
|
|
|
|
return identity, nil
|
|
}
|
|
|
|
// Refreshing tokens
|
|
// https://github.com/golang/oauth2/issues/84#issuecomment-332860871
|
|
type tokenNotifyFunc func(*oauth2.Token) error
|
|
|
|
// notifyRefreshTokenSource is essentially `oauth2.ReuseTokenSource` with `TokenNotifyFunc` added.
|
|
type notifyRefreshTokenSource struct {
|
|
new oauth2.TokenSource
|
|
mu sync.Mutex // guards t
|
|
t *oauth2.Token
|
|
f tokenNotifyFunc // called when token refreshed so new refresh token can be persisted
|
|
}
|
|
|
|
// Token returns the current token if it's still valid, else will
|
|
// refresh the current token (using r.Context for HTTP client
|
|
// information) and return the new one.
|
|
func (s *notifyRefreshTokenSource) Token() (*oauth2.Token, error) {
|
|
s.mu.Lock()
|
|
defer s.mu.Unlock()
|
|
if s.t.Valid() {
|
|
return s.t, nil
|
|
}
|
|
t, err := s.new.Token()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
s.t = t
|
|
return t, s.f(t)
|
|
}
|
|
|
|
func (c *giteaConnector) Refresh(ctx context.Context, s connector.Scopes, ident connector.Identity) (connector.Identity, error) {
|
|
if len(ident.ConnectorData) == 0 {
|
|
return ident, errors.New("gitea: no upstream access token found")
|
|
}
|
|
|
|
var data connectorData
|
|
if err := json.Unmarshal(ident.ConnectorData, &data); err != nil {
|
|
return ident, fmt.Errorf("gitea: unmarshal access token: %v", err)
|
|
}
|
|
|
|
tok := &oauth2.Token{
|
|
AccessToken: data.AccessToken,
|
|
RefreshToken: data.RefreshToken,
|
|
Expiry: data.Expiry,
|
|
}
|
|
|
|
client := oauth2.NewClient(ctx, ¬ifyRefreshTokenSource{
|
|
new: c.oauth2Config(s).TokenSource(ctx, tok),
|
|
t: tok,
|
|
f: func(tok *oauth2.Token) error {
|
|
data := connectorData{
|
|
AccessToken: tok.AccessToken,
|
|
RefreshToken: tok.RefreshToken,
|
|
Expiry: tok.Expiry,
|
|
}
|
|
connData, err := json.Marshal(data)
|
|
if err != nil {
|
|
return fmt.Errorf("gitea: marshal connector data: %v", err)
|
|
}
|
|
ident.ConnectorData = connData
|
|
return nil
|
|
},
|
|
})
|
|
user, err := c.user(ctx, client)
|
|
if err != nil {
|
|
return ident, fmt.Errorf("gitea: get user: %v", err)
|
|
}
|
|
|
|
username := user.Name
|
|
if username == "" {
|
|
username = user.Email
|
|
}
|
|
ident.Username = username
|
|
ident.PreferredUsername = user.Username
|
|
ident.Email = user.Email
|
|
|
|
return ident, nil
|
|
}
|
|
|
|
// user queries the Gitea API for profile information using the provided client. The HTTP
|
|
// client is expected to be constructed by the golang.org/x/oauth2 package, which inserts
|
|
// a bearer token as part of the request.
|
|
func (c *giteaConnector) user(ctx context.Context, client *http.Client) (giteaUser, error) {
|
|
var u giteaUser
|
|
req, err := http.NewRequest("GET", c.baseURL+"/api/v1/user", nil)
|
|
if err != nil {
|
|
return u, fmt.Errorf("gitea: new req: %v", err)
|
|
}
|
|
req = req.WithContext(ctx)
|
|
resp, err := client.Do(req)
|
|
if err != nil {
|
|
return u, fmt.Errorf("gitea: get URL %v", err)
|
|
}
|
|
defer resp.Body.Close()
|
|
|
|
if resp.StatusCode != http.StatusOK {
|
|
body, err := io.ReadAll(resp.Body)
|
|
if err != nil {
|
|
return u, fmt.Errorf("gitea: read body: %v", err)
|
|
}
|
|
return u, fmt.Errorf("%s: %s", resp.Status, body)
|
|
}
|
|
|
|
if err := json.NewDecoder(resp.Body).Decode(&u); err != nil {
|
|
return u, fmt.Errorf("failed to decode response: %v", err)
|
|
}
|
|
return u, nil
|
|
}
|