oauth2

package

v3.1.59 Latest Latest Go to latest Published: Jan 25, 2026 License: MIT, MIT Imports: 43 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

git.marketally.com/gitcaddy/gitcaddy-server

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func ClearProviders()
func Init(ctx context.Context) error
func IsErrOpenIDConnectInitialize(err error) bool
func RegisterGothProvider(provider GothProvider)
func RegisterProviderWithGothic(providerName string, source *Source) error
func RemoveProviderFromGothic(providerName string)
func ResetOAuth2(ctx context.Context) error
type Attribute
type AuthSourceProvider
- func (p *AuthSourceProvider) DisplayName() string
- func (p *AuthSourceProvider) IconHTML(size int) template.HTML
- func (p *AuthSourceProvider) Name() string
type BaseProvider
- func (b *BaseProvider) CustomURLSettings() *CustomURLSettings
- func (b *BaseProvider) DisplayName() string
- func (b *BaseProvider) IconHTML(size int) template.HTML
- func (b *BaseProvider) Name() string
- func (b *BaseProvider) SupportSSHPublicKey() bool
type CustomProvider
- func NewCustomProvider(name, displayName string, customURLSetting *CustomURLSettings, ...) *CustomProvider
- func (c *CustomProvider) CreateGothProvider(providerName, callbackURL string, source *Source) (goth.Provider, error)
- func (c *CustomProvider) CustomURLSettings() *CustomURLSettings
type CustomProviderNewFn
type CustomURLMapping
type CustomURLSettings
- func (c *CustomURLSettings) OverrideWith(override *CustomURLMapping) *CustomURLMapping
- func (c *CustomURLSettings) Required() bool
type ErrOpenIDConnectInitialize
- func (err ErrOpenIDConnectInitialize) Error() string
- func (err ErrOpenIDConnectInitialize) Unwrap() error
type GothProvider
type GothProviderCreator
type OpenIDProvider
- func (o *OpenIDProvider) CreateGothProvider(providerName, callbackURL string, source *Source) (goth.Provider, error)
- func (o *OpenIDProvider) CustomURLSettings() *CustomURLSettings
- func (o *OpenIDProvider) DisplayName() string
- func (o *OpenIDProvider) IconHTML(size int) template.HTML
- func (o *OpenIDProvider) Name() string
- func (o *OpenIDProvider) SupportSSHPublicKey() bool
type Provider
- func CreateProviderFromSource(source *auth.Source) (Provider, error)
- func GetOAuth2Providers(ctx context.Context, isActive optional.Option[bool]) ([]Provider, error)
- func GetSupportedOAuth2Providers(ctx context.Context) []Provider
type SessionsStore
- func (st *SessionsStore) Get(r *http.Request, name string) (*sessions.Session, error)
- func (st *SessionsStore) New(r *http.Request, name string) (*sessions.Session, error)
- func (st *SessionsStore) Save(r *http.Request, w http.ResponseWriter, session *sessions.Session) error
type SimpleProvider
- func NewSimpleProvider(name, displayName string, scopes []string, newFn SimpleProviderNewFn) *SimpleProvider
- func (c *SimpleProvider) CreateGothProvider(providerName, callbackURL string, source *Source) (goth.Provider, error)
type SimpleProviderNewFn
type Source
- func (source *Source) Authenticate(ctx context.Context, user *user_model.User, login, password string) (*user_model.User, error)
- func (source *Source) Callback(request *http.Request, response http.ResponseWriter) (goth.User, error)
- func (source *Source) Callout(request *http.Request, response http.ResponseWriter) error
- func (source *Source) DisplayName() string
- func (source *Source) FromDB(bs []byte) error
- func (source *Source) Name() string
- func (source *Source) RegisterSource() error
- func (source *Source) Sync(ctx context.Context, updateExisting bool) error
- func (source *Source) ToDB() ([]byte, error)
- func (source *Source) UnregisterSource() error

Constants ¶

View Source

const ProviderHeaderKey = "gitea-oauth2-provider"

ProviderHeaderKey is the HTTP header key

Variables ¶

View Source

var ErrAuthSourceNotActivated = errors.New("auth source is not activated")

Functions ¶

func ClearProviders ¶

func ClearProviders()

ClearProviders clears all OAuth2 providers from the goth lib

func Init ¶

func Init(ctx context.Context) error

Init initializes the oauth source

func IsErrOpenIDConnectInitialize ¶

func IsErrOpenIDConnectInitialize(err error) bool

IsErrOpenIDConnectInitialize checks if an error is a ExternalLoginUserAlreadyExist.

func RegisterGothProvider ¶

func RegisterGothProvider(provider GothProvider)

RegisterGothProvider registers a GothProvider

func RegisterProviderWithGothic ¶

func RegisterProviderWithGothic(providerName string, source *Source) error

RegisterProviderWithGothic register a OAuth2 provider in goth lib

func RemoveProviderFromGothic ¶

func RemoveProviderFromGothic(providerName string)

RemoveProviderFromGothic removes the given OAuth2 provider from the goth lib

func ResetOAuth2 ¶

func ResetOAuth2(ctx context.Context) error

ResetOAuth2 clears existing OAuth2 providers and loads them from DB

Types ¶

type Attribute ¶

type Attribute struct {
	Value     string
	Available bool
	Required  bool
}

Attribute describes the availability, and required status for a custom url configuration

type AuthSourceProvider ¶

type AuthSourceProvider struct {
	GothProvider
	// contains filtered or unexported fields
}

AuthSourceProvider provides a provider for an AuthSource. Multiple auth sources could use the same registered GothProvider So each auth source should have its own DisplayName and IconHTML for display. 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.

func (*AuthSourceProvider) DisplayName ¶

func (p *AuthSourceProvider) DisplayName() string

func (*AuthSourceProvider) IconHTML ¶

func (p *AuthSourceProvider) IconHTML(size int) template.HTML