Fixes typos in GoDoc and comments
This commit is contained in:
parent
33f8df7eb2
commit
44fe280213
2 changed files with 5 additions and 5 deletions
|
@ -56,7 +56,7 @@ func SetupServer(issuer string, storage Storage, logger *slog.Logger, wrapServer
|
||||||
// for simplicity, we provide a very small default page for users who have signed out
|
// for simplicity, we provide a very small default page for users who have signed out
|
||||||
router.HandleFunc(pathLoggedOut, func(w http.ResponseWriter, req *http.Request) {
|
router.HandleFunc(pathLoggedOut, func(w http.ResponseWriter, req *http.Request) {
|
||||||
w.Write([]byte("signed out successfully"))
|
w.Write([]byte("signed out successfully"))
|
||||||
// no need to check/log error, this will be handeled by the middleware.
|
// no need to check/log error, this will be handled by the middleware.
|
||||||
})
|
})
|
||||||
|
|
||||||
// creation of the OpenIDProvider with the just created in-memory Storage
|
// creation of the OpenIDProvider with the just created in-memory Storage
|
||||||
|
|
|
@ -60,7 +60,7 @@ type RelyingParty interface {
|
||||||
// UserinfoEndpoint returns the userinfo
|
// UserinfoEndpoint returns the userinfo
|
||||||
UserinfoEndpoint() string
|
UserinfoEndpoint() string
|
||||||
|
|
||||||
// GetDeviceAuthorizationEndpoint returns the enpoint which can
|
// GetDeviceAuthorizationEndpoint returns the endpoint which can
|
||||||
// be used to start a DeviceAuthorization flow.
|
// be used to start a DeviceAuthorization flow.
|
||||||
GetDeviceAuthorizationEndpoint() string
|
GetDeviceAuthorizationEndpoint() string
|
||||||
|
|
||||||
|
@ -388,7 +388,7 @@ func AuthURL(state string, rp RelyingParty, opts ...AuthURLOpt) string {
|
||||||
|
|
||||||
// AuthURLHandler extends the `AuthURL` method with a http redirect handler
|
// AuthURLHandler extends the `AuthURL` method with a http redirect handler
|
||||||
// including handling setting cookie for secure `state` transfer.
|
// including handling setting cookie for secure `state` transfer.
|
||||||
// Custom paramaters can optionally be set to the redirect URL.
|
// Custom parameters can optionally be set to the redirect URL.
|
||||||
func AuthURLHandler(stateFn func() string, rp RelyingParty, urlParam ...URLParamOpt) http.HandlerFunc {
|
func AuthURLHandler(stateFn func() string, rp RelyingParty, urlParam ...URLParamOpt) http.HandlerFunc {
|
||||||
return func(w http.ResponseWriter, r *http.Request) {
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
opts := make([]AuthURLOpt, len(urlParam))
|
opts := make([]AuthURLOpt, len(urlParam))
|
||||||
|
@ -642,7 +642,7 @@ func GetEndpoints(discoveryConfig *oidc.DiscoveryConfiguration) Endpoints {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// withURLParam sets custom url paramaters.
|
// withURLParam sets custom url parameters.
|
||||||
// This is the generalized, unexported, function used by both
|
// This is the generalized, unexported, function used by both
|
||||||
// URLParamOpt and AuthURLOpt.
|
// URLParamOpt and AuthURLOpt.
|
||||||
func withURLParam(key, value string) func() []oauth2.AuthCodeOption {
|
func withURLParam(key, value string) func() []oauth2.AuthCodeOption {
|
||||||
|
@ -734,7 +734,7 @@ type RefreshTokenRequest struct {
|
||||||
// the old one should be considered invalid.
|
// the old one should be considered invalid.
|
||||||
//
|
//
|
||||||
// In case the RP is not OAuth2 only and an IDToken was part of the response,
|
// In case the RP is not OAuth2 only and an IDToken was part of the response,
|
||||||
// the IDToken and AccessToken will be verfied
|
// the IDToken and AccessToken will be verified
|
||||||
// and the IDToken and IDTokenClaims fields will be populated in the returned object.
|
// and the IDToken and IDTokenClaims fields will be populated in the returned object.
|
||||||
func RefreshTokens[C oidc.IDClaims](ctx context.Context, rp RelyingParty, refreshToken, clientAssertion, clientAssertionType string) (*oidc.Tokens[C], error) {
|
func RefreshTokens[C oidc.IDClaims](ctx context.Context, rp RelyingParty, refreshToken, clientAssertion, clientAssertionType string) (*oidc.Tokens[C], error) {
|
||||||
ctx, span := client.Tracer.Start(ctx, "RefreshTokens")
|
ctx, span := client.Tracer.Start(ctx, "RefreshTokens")
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue