2021-07-24 18:16:34 +08:00
|
|
|
// Copyright 2021 The Gitea Authors. All rights reserved.
|
2022-11-28 02:20:29 +08:00
|
|
|
// SPDX-License-Identifier: MIT
|
2017-02-22 15:14:37 +08:00
|
|
|
|
|
|
|
package oauth2
|
|
|
|
|
|
|
|
import (
|
2023-10-14 16:37:24 +08:00
|
|
|
"context"
|
2021-11-24 17:49:20 +08:00
|
|
|
"errors"
|
2023-06-13 18:51:02 +08:00
|
|
|
"fmt"
|
|
|
|
"html"
|
|
|
|
"html/template"
|
2020-08-31 06:55:01 +08:00
|
|
|
"net/url"
|
2021-07-24 18:16:34 +08:00
|
|
|
"sort"
|
2017-03-03 16:21:31 +08:00
|
|
|
|
2022-01-02 21:12:35 +08:00
|
|
|
"code.gitea.io/gitea/models/auth"
|
2017-02-22 15:14:37 +08:00
|
|
|
"code.gitea.io/gitea/modules/log"
|
2017-03-03 16:21:31 +08:00
|
|
|
"code.gitea.io/gitea/modules/setting"
|
|
|
|
|
2017-02-22 15:14:37 +08:00
|
|
|
"github.com/markbates/goth"
|
|
|
|
)
|
|
|
|
|
2021-08-06 09:11:08 +08:00
|
|
|
// Provider is an interface for describing a single OAuth2 provider
|
|
|
|
type Provider interface {
|
|
|
|
Name() string
|
|
|
|
DisplayName() string
|
2023-09-20 05:47:13 +08:00
|
|
|
IconHTML(size int) template.HTML
|
2021-08-06 09:11:08 +08:00
|
|
|
CustomURLSettings() *CustomURLSettings
|
|
|
|
}
|
|
|
|
|
|
|
|
// GothProviderCreator provides a function to create a goth.Provider
|
|
|
|
type GothProviderCreator interface {
|
|
|
|
CreateGothProvider(providerName, callbackURL string, source *Source) (goth.Provider, error)
|
|
|
|
}
|
|
|
|
|
|
|
|
// GothProvider is an interface for describing a single OAuth2 provider
|
|
|
|
type GothProvider interface {
|
|
|
|
Provider
|
|
|
|
GothProviderCreator
|
|
|
|
}
|
|
|
|
|
2023-06-09 00:35:29 +08:00
|
|
|
// AuthSourceProvider provides a provider for an AuthSource. Multiple auth sources could use the same registered GothProvider
|
2023-06-13 18:51:02 +08:00
|
|
|
// So each auth source should have its own DisplayName and IconHTML for display.
|
2023-06-09 00:35:29 +08:00
|
|
|
// The Name is the GothProvider's name, to help to find the GothProvider to sign in.
|
|
|
|
// The DisplayName is the auth source config's name, site admin set it on the admin page, the IconURL can also be set there.
|
|
|
|
type AuthSourceProvider struct {
|
2021-08-06 09:11:08 +08:00
|
|
|
GothProvider
|
2023-06-09 00:35:29 +08:00
|
|
|
sourceName, iconURL string
|
2021-08-06 09:11:08 +08:00
|
|
|
}
|
|
|
|
|
2023-06-09 00:35:29 +08:00
|
|
|
func (p *AuthSourceProvider) Name() string {
|
|
|
|
return p.GothProvider.Name()
|
2021-08-06 09:11:08 +08:00
|
|
|
}
|
|
|
|
|
2023-06-09 00:35:29 +08:00
|
|
|
func (p *AuthSourceProvider) DisplayName() string {
|
|
|
|
return p.sourceName
|
|
|
|
}
|
|
|
|
|
2023-09-20 05:47:13 +08:00
|
|
|
func (p *AuthSourceProvider) IconHTML(size int) template.HTML {
|
2023-06-09 00:35:29 +08:00
|
|
|
if p.iconURL != "" {
|
2023-09-20 05:47:13 +08:00
|
|
|
img := fmt.Sprintf(`<img class="gt-object-contain gt-mr-3" width="%d" height="%d" src="%s" alt="%s">`,
|
|
|
|
size,
|
|
|
|
size,
|
2023-06-13 18:51:02 +08:00
|
|
|
html.EscapeString(p.iconURL), html.EscapeString(p.DisplayName()),
|
|
|
|
)
|
|
|
|
return template.HTML(img)
|
2021-08-06 09:11:08 +08:00
|
|
|
}
|
2023-09-20 05:47:13 +08:00
|
|
|
return p.GothProvider.IconHTML(size)
|
2021-07-24 18:16:34 +08:00
|
|
|
}
|
2017-02-22 15:14:37 +08:00
|
|
|
|
2021-07-24 18:16:34 +08:00
|
|
|
// Providers contains the map of registered OAuth2 providers in Gitea (based on goth)
|
2022-01-02 21:12:35 +08:00
|
|
|
// key is used to map the OAuth2Provider with the goth provider type (also in AuthSource.OAuth2Config.Provider)
|
2021-07-24 18:16:34 +08:00
|
|
|
// value is used to store display data
|
2021-08-06 09:11:08 +08:00
|
|
|
var gothProviders = map[string]GothProvider{}
|
|
|
|
|
|
|
|
// RegisterGothProvider registers a GothProvider
|
|
|
|
func RegisterGothProvider(provider GothProvider) {
|
|
|
|
if _, has := gothProviders[provider.Name()]; has {
|
|
|
|
log.Fatal("Duplicate oauth2provider type provided: %s", provider.Name())
|
|
|
|
}
|
|
|
|
gothProviders[provider.Name()] = provider
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetOAuth2Providers returns the map of unconfigured OAuth2 providers
|
|
|
|
// key is used as technical name (like in the callbackURL)
|
|
|
|
// values to display
|
|
|
|
func GetOAuth2Providers() []Provider {
|
|
|
|
providers := make([]Provider, 0, len(gothProviders))
|
|
|
|
|
|
|
|
for _, provider := range gothProviders {
|
|
|
|
providers = append(providers, provider)
|
|
|
|
}
|
|
|
|
sort.Slice(providers, func(i, j int) bool {
|
|
|
|
return providers[i].Name() < providers[j].Name()
|
|
|
|
})
|
|
|
|
return providers
|
2017-05-01 21:26:53 +08:00
|
|
|
}
|
|
|
|
|
2021-07-24 18:16:34 +08:00
|
|
|
// GetActiveOAuth2Providers returns the map of configured active OAuth2 providers
|
|
|
|
// key is used as technical name (like in the callbackURL)
|
|
|
|
// values to display
|
2023-10-14 16:37:24 +08:00
|
|
|
func GetActiveOAuth2Providers(ctx context.Context) ([]string, map[string]Provider, error) {
|
2021-07-24 18:16:34 +08:00
|
|
|
// Maybe also separate used and unused providers so we can force the registration of only 1 active provider for each type
|
2017-02-22 15:14:37 +08:00
|
|
|
|
2023-10-14 16:37:24 +08:00
|
|
|
authSources, err := auth.GetActiveOAuth2ProviderSources(ctx)
|
2018-04-29 14:09:24 +08:00
|
|
|
if err != nil {
|
2021-07-24 18:16:34 +08:00
|
|
|
return nil, nil, err
|
2017-02-22 15:14:37 +08:00
|
|
|
}
|
|
|
|
|
2021-07-24 18:16:34 +08:00
|
|
|
var orderedKeys []string
|
|
|
|
providers := make(map[string]Provider)
|
2022-01-02 21:12:35 +08:00
|
|
|
for _, source := range authSources {
|
2023-06-09 00:35:29 +08:00
|
|
|
oauth2Cfg, ok := source.Cfg.(*Source)
|
|
|
|
if !ok {
|
|
|
|
log.Error("Invalid OAuth2 source config: %v", oauth2Cfg)
|
|
|
|
continue
|
2021-07-24 18:16:34 +08:00
|
|
|
}
|
2023-06-09 00:35:29 +08:00
|
|
|
gothProv := gothProviders[oauth2Cfg.Provider]
|
|
|
|
providers[source.Name] = &AuthSourceProvider{GothProvider: gothProv, sourceName: source.Name, iconURL: oauth2Cfg.IconURL}
|
2021-07-24 18:16:34 +08:00
|
|
|
orderedKeys = append(orderedKeys, source.Name)
|
2017-02-22 15:14:37 +08:00
|
|
|
}
|
|
|
|
|
2021-07-24 18:16:34 +08:00
|
|
|
sort.Strings(orderedKeys)
|
2017-02-22 15:14:37 +08:00
|
|
|
|
2021-07-24 18:16:34 +08:00
|
|
|
return orderedKeys, providers, nil
|
2017-02-22 15:14:37 +08:00
|
|
|
}
|
|
|
|
|
2021-08-06 09:11:08 +08:00
|
|
|
// RegisterProviderWithGothic register a OAuth2 provider in goth lib
|
|
|
|
func RegisterProviderWithGothic(providerName string, source *Source) error {
|
|
|
|
provider, err := createProvider(providerName, source)
|
2017-02-22 15:14:37 +08:00
|
|
|
|
2017-05-01 21:26:53 +08:00
|
|
|
if err == nil && provider != nil {
|
2021-07-30 01:53:18 +08:00
|
|
|
gothRWMutex.Lock()
|
|
|
|
defer gothRWMutex.Unlock()
|
|
|
|
|
2017-02-22 15:14:37 +08:00
|
|
|
goth.UseProviders(provider)
|
|
|
|
}
|
2017-05-01 21:26:53 +08:00
|
|
|
|
|
|
|
return err
|
2017-02-22 15:14:37 +08:00
|
|
|
}
|
|
|
|
|
2021-08-06 09:11:08 +08:00
|
|
|
// RemoveProviderFromGothic removes the given OAuth2 provider from the goth lib
|
|
|
|
func RemoveProviderFromGothic(providerName string) {
|
2021-07-30 01:53:18 +08:00
|
|
|
gothRWMutex.Lock()
|
|
|
|
defer gothRWMutex.Unlock()
|
|
|
|
|
2017-02-22 15:14:37 +08:00
|
|
|
delete(goth.GetProviders(), providerName)
|
|
|
|
}
|
|
|
|
|
2020-12-25 03:47:17 +08:00
|
|
|
// ClearProviders clears all OAuth2 providers from the goth lib
|
|
|
|
func ClearProviders() {
|
2021-07-30 01:53:18 +08:00
|
|
|
gothRWMutex.Lock()
|
|
|
|
defer gothRWMutex.Unlock()
|
|
|
|
|
2020-12-25 03:47:17 +08:00
|
|
|
goth.ClearProviders()
|
|
|
|
}
|
|
|
|
|
2023-06-09 00:35:29 +08:00
|
|
|
var ErrAuthSourceNotActivated = errors.New("auth source is not activated")
|
2021-11-24 17:49:20 +08:00
|
|
|
|
2017-02-22 15:14:37 +08:00
|
|
|
// used to create different types of goth providers
|
2021-08-06 09:11:08 +08:00
|
|
|
func createProvider(providerName string, source *Source) (goth.Provider, error) {
|
2020-08-31 06:55:01 +08:00
|
|
|
callbackURL := setting.AppURL + "user/oauth2/" + url.PathEscape(providerName) + "/callback"
|
2017-02-22 15:14:37 +08:00
|
|
|
|
|
|
|
var provider goth.Provider
|
2017-05-01 21:26:53 +08:00
|
|
|
var err error
|
2017-02-22 15:14:37 +08:00
|
|
|
|
2021-08-06 09:11:08 +08:00
|
|
|
p, ok := gothProviders[source.Provider]
|
|
|
|
if !ok {
|
2023-06-09 00:35:29 +08:00
|
|
|
return nil, ErrAuthSourceNotActivated
|
2021-08-06 09:11:08 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
provider, err = p.CreateGothProvider(providerName, callbackURL, source)
|
|
|
|
if err != nil {
|
|
|
|
return provider, err
|
2017-02-22 15:14:37 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
// always set the name if provider is created so we can support multiple setups of 1 provider
|
2017-05-01 21:26:53 +08:00
|
|
|
if err == nil && provider != nil {
|
2017-02-22 15:14:37 +08:00
|
|
|
provider.SetName(providerName)
|
|
|
|
}
|
|
|
|
|
2017-05-01 21:26:53 +08:00
|
|
|
return provider, err
|
|
|
|
}
|