Documentation
¶
Overview ¶
Package openid implements OpenID Connect Login protocol (client side).
Tested only with Google's implementation of the protocol.
See https://developers.google.com/identity/protocols/OpenIDConnect.
Index ¶
- Constants
- Variables
- type AuthMethod
- func (m *AuthMethod) Authenticate(c context.Context, r *http.Request) (*auth.User, error)
- func (m *AuthMethod) InstallHandlers(r *router.Router, base router.MiddlewareChain)
- func (m *AuthMethod) LoginURL(c context.Context, dest string) (string, error)
- func (m *AuthMethod) LogoutURL(c context.Context, dest string) (string, error)
- func (m *AuthMethod) Warmup(c context.Context) (err error)
- type Settings
Constants ¶
const SettingsKey = "openid_auth"
SettingsKey is key for OpenID settings (described by Settings struct) in settings store. See github.com/luci/luci-go/server/settings.
Variables ¶
Functions ¶
This section is empty.
Types ¶
type AuthMethod ¶
type AuthMethod struct {
// SessionStore keeps user sessions in some permanent storage. Must be set,
// otherwise all methods return ErrNotConfigured.
SessionStore auth.SessionStore
// Insecure is true to allow http:// URLs and non-https cookies. Useful for
// local development.
Insecure bool
// IncompatibleCookies is a list of cookies to remove when setting or clearing
// session cookie. It is useful to get rid of GAE cookies when OpenID cookies
// are being used. Having both is very confusing.
IncompatibleCookies []string
}
AuthMethod implements auth.Method and auth.UsersAPI and can be used as one of authentication method in auth.Authenticator. It is using OpenID for login flow, stores session ID in cookies, and session itself in supplied SessionStore.
It requires some routes to be added to the router. Use exact same instance of AuthMethod in auth.Authenticator and when adding routes via InstallHandlers.
func (*AuthMethod) Authenticate ¶
Authenticate extracts peer's identity from the incoming request. It is part of auth.Method interface.
func (*AuthMethod) InstallHandlers ¶
func (m *AuthMethod) InstallHandlers(r *router.Router, base router.MiddlewareChain)
InstallHandlers installs HTTP handlers used in OpenID protocol. Must be installed in server HTTP router for OpenID authentication flow to work.
func (*AuthMethod) LoginURL ¶
LoginURL returns a URL that, when visited, prompts the user to sign in, then redirects the user to the URL specified by dest. It is part of auth.UsersAPI interface.
func (*AuthMethod) LogoutURL ¶
LogoutURL returns a URL that, when visited, signs the user out, then redirects the user to the URL specified by dest. It is part of auth.UsersAPI interface.
func (*AuthMethod) Warmup ¶
func (m *AuthMethod) Warmup(c context.Context) (err error)
Warmup prepares local caches. It's optional.
type Settings ¶
type Settings struct {
// DiscoveryURL is where to grab discovery document with provider's config.
// Use `https://accounts.google.com/.well-known/openid-configuration` for
// Google OpenID Connect provider.
DiscoveryURL string `json:"discovery_url"`
// ClientID identifies OAuth2 Web client representing the application. Create
// one in Cloud Console if using Google OpenID Connect provider.
ClientID string `json:"client_id"`
// ClientSecret is a secret associated with ClientID.
ClientSecret string `json:"client_secret"`
// RedirectURI must be `https://<apphost>/auth/openid/callback`. It is stored
// in config explicitly to remind admin that OAuth2 client in Cloud Console
// must be configured accordingly.
RedirectURI string `json:"redirect_uri"`
}
Settings contain parameters of OpenID protocol. They are stored in app settings store under SettingsKey key.
Source Files