api

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 21, 2023 License: Apache-2.0 Imports: 26 Imported by: 0

Documentation

Index

Constants

View Source 
const Tag feature.Tag = "user-auth-api"

Variables

View Source 
var (
	DefaultUrl            = "http://localhost:" + strconv.Itoa(globals.DefaultPort)
	DefaultTokenDuration  = time.Minute * 5
	DefaultCookieDuration = time.Hour * 24
	DefaultUserGroups     = []string{"user"}

	DefaultEmailNewTokenTemplate = "email-new-token"
)

Functions

This section is empty.

Types

type CFeature 

type CFeature struct {
	feature.CFeature
	// contains filtered or unexported fields
}

func (*CFeature) AddAudSecretKeys 

func (f *CFeature) AddAudSecretKeys(keys ...string) MakeFeature

func (*CFeature) AddDirectProvider 

func (f *CFeature) AddDirectProvider(name string, fn provider.CredCheckerFunc) MakeFeature

func (*CFeature) AddProvider 

func (f *CFeature) AddProvider(name, cid, csecret string) MakeFeature

func (*CFeature) Apply 

func (f *CFeature) Apply(s feature.System) (err error)

func (*CFeature) AuthApiServeHTTP 

func (f *CFeature) AuthApiServeHTTP(next http.Handler, w http.ResponseWriter, r *http.Request)

func (*CFeature) Build 

func (f *CFeature) Build(b feature.Buildable) (err error)

func (*CFeature) EnableDevService 

func (f *CFeature) EnableDevService(enabled bool) MakeFeature

func (*CFeature) IncludeVerifyEmailProvider 

func (f *CFeature) IncludeVerifyEmailProvider(providerName string) MakeFeature

func (*CFeature) Init 

func (f *CFeature) Init(this interface{})

func (*CFeature) Make 

func (f *CFeature) Make() Feature

func (*CFeature) RequireApiUser 

func (f *CFeature) RequireApiUser(next http.Handler) http.Handler

func (*CFeature) RequireUserCan 

func (f *CFeature) RequireUserCan(action userbase.Action) func(next http.Handler) http.Handler

func (*CFeature) SetAuthApiMountPath 

func (f *CFeature) SetAuthApiMountPath(prefix string) MakeFeature

func (*CFeature) SetAvatarMountPath 

func (f *CFeature) SetAvatarMountPath(prefix string) MakeFeature

func (*CFeature) SetAvatarStore 

func (f *CFeature) SetAvatarStore(store avatar.Store) MakeFeature

func (*CFeature) SetCookieDuration 

func (f *CFeature) SetCookieDuration(d time.Duration) MakeFeature

func (*CFeature) SetCustomRefreshCache 

func (f *CFeature) SetCustomRefreshCache(cache middleware.RefreshCache) MakeFeature

func (*CFeature) SetIssuer 

func (f *CFeature) SetIssuer(issuer string) MakeFeature

func (*CFeature) SetJWTCookieDomain 

func (f *CFeature) SetJWTCookieDomain(domain string) MakeFeature

func (*CFeature) SetJWTCookieName 

func (f *CFeature) SetJWTCookieName(name string) MakeFeature

func (*CFeature) SetJWTHeaderKey 

func (f *CFeature) SetJWTHeaderKey(key string) MakeFeature

func (*CFeature) SetJWTQuery 

func (f *CFeature) SetJWTQuery(name string) MakeFeature

func (*CFeature) SetLogLevel 

func (f *CFeature) SetLogLevel(level log.Level) MakeFeature

func (*CFeature) SetPublicSignups 

func (f *CFeature) SetPublicSignups(allowed bool) MakeFeature

func (*CFeature) SetRefreshCache 

func (f *CFeature) SetRefreshCache(tag feature.Tag, name, bucket string) MakeFeature

func (*CFeature) SetSameSiteCookie 

func (f *CFeature) SetSameSiteCookie(site http.SameSite) MakeFeature

func (*CFeature) SetSecureCookies 

func (f *CFeature) SetSecureCookies(secure bool) MakeFeature

func (*CFeature) SetSendJWTHeader 

func (f *CFeature) SetSendJWTHeader(enabled bool) MakeFeature

func (*CFeature) SetTokenDuration 

func (f *CFeature) SetTokenDuration(d time.Duration) MakeFeature

func (*CFeature) SetUrl 

func (f *CFeature) SetUrl(url string) MakeFeature

func (*CFeature) SetUseGravatar 

func (f *CFeature) SetUseGravatar(enabled bool) MakeFeature

func (*CFeature) SetUsersManager 

func (f *CFeature) SetUsersManager(tag feature.Tag) MakeFeature

func (*CFeature) SetVerifyEmailAccount 

func (f *CFeature) SetVerifyEmailAccount(name string) MakeFeature

func (*CFeature) SetVerifyEmailTemplate 

func (f *CFeature) SetVerifyEmailTemplate(name string) MakeFeature

func (*CFeature) SetXSRFCookieName 

func (f *CFeature) SetXSRFCookieName(name string) MakeFeature

func (*CFeature) SetXSRFHeaderKey 

func (f *CFeature) SetXSRFHeaderKey(key string) MakeFeature

func (*CFeature) Setup 

func (f *CFeature) Setup(enjin feature.Internals)

func (*CFeature) Shutdown 

func (f *CFeature) Shutdown()

func (*CFeature) Startup 

func (f *CFeature) Startup(ctx *cli.Context) (err error)

func (*CFeature) Use 

func (f *CFeature) Use(s feature.System) feature.MiddlewareFn

type Feature 

type Feature interface {
	feature.Feature
	userbase.AuthUserApi
	feature.UseMiddleware
	feature.ApplyMiddleware
}

type MakeFeature 

type MakeFeature interface {
	Make() Feature

	SetUrl(url string) MakeFeature
	SetIssuer(issuer string) MakeFeature

	SetPublicSignups(allowed bool) MakeFeature

	SetUsersManager(tag feature.Tag) MakeFeature

	SetUseGravatar(enabled bool) MakeFeature

	SetAuthApiMountPath(prefix string) MakeFeature
	SetAvatarMountPath(prefix string) MakeFeature
	SetAvatarStore(store avatar.Store) MakeFeature

	SetRefreshCache(tag feature.Tag, name, bucket string) MakeFeature
	SetCustomRefreshCache(cache middleware.RefreshCache) MakeFeature

	SetTokenDuration(d time.Duration) MakeFeature
	SetCookieDuration(d time.Duration) MakeFeature

	SetSecureCookies(secure bool) MakeFeature
	SetSameSiteCookie(site http.SameSite) MakeFeature

	SetXSRFHeaderKey(key string) MakeFeature
	SetXSRFCookieName(name string) MakeFeature

	SetJWTQuery(name string) MakeFeature
	SetJWTHeaderKey(key string) MakeFeature
	SetJWTCookieName(name string) MakeFeature
	SetJWTCookieDomain(domain string) MakeFeature
	SetSendJWTHeader(enabled bool) MakeFeature

	AddAudSecretKeys(keys ...string) MakeFeature
	AddProvider(name, cid, csecret string) MakeFeature
	AddDirectProvider(name string, fn provider.CredCheckerFunc) MakeFeature

	SetVerifyEmailAccount(name string) MakeFeature
	SetVerifyEmailTemplate(name string) MakeFeature
	IncludeVerifyEmailProvider(providerName string) MakeFeature

	SetLogLevel(level log.Level) MakeFeature
	EnableDevService(enabled bool) MakeFeature
}

func New 

func New() MakeFeature

func NewTagged 

func NewTagged(tag feature.Tag) MakeFeature

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.