mirror of https://github.com/ory/hydra
80 lines
4.5 KiB
Go
80 lines
4.5 KiB
Go
// Copyright © 2025 Ory Corp
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package fosite
|
|
|
|
import (
|
|
"context"
|
|
)
|
|
|
|
type AuthorizeEndpointHandler interface {
|
|
// HandleAuthorizeRequest handles an authorize endpoint request. To extend the handler's capabilities, the http request
|
|
// is passed along, if further information retrieval is required. If the handler feels that he is not responsible for
|
|
// the authorize request, he must return nil and NOT modify session nor responder neither requester.
|
|
//
|
|
// The following spec is a good example of what HandleAuthorizeRequest should do.
|
|
// * https://tools.ietf.org/html/rfc6749#section-3.1.1
|
|
// response_type REQUIRED.
|
|
// The value MUST be one of "code" for requesting an
|
|
// authorization code as described by Section 4.1.1, "token" for
|
|
// requesting an access token (implicit grant) as described by
|
|
// Section 4.2.1, or a registered extension value as described by Section 8.4.
|
|
HandleAuthorizeEndpointRequest(ctx context.Context, requester AuthorizeRequester, responder AuthorizeResponder) error
|
|
}
|
|
|
|
type TokenEndpointHandler interface {
|
|
// PopulateTokenEndpointResponse is responsible for setting return values and should only be executed if
|
|
// the handler's HandleTokenEndpointRequest did not return ErrUnknownRequest.
|
|
PopulateTokenEndpointResponse(ctx context.Context, requester AccessRequester, responder AccessResponder) error
|
|
|
|
// HandleTokenEndpointRequest handles an authorize request. If the handler is not responsible for handling
|
|
// the request, this method should return ErrUnknownRequest and otherwise handle the request.
|
|
HandleTokenEndpointRequest(ctx context.Context, requester AccessRequester) error
|
|
|
|
// CanSkipClientAuth indicates if client authentication can be skipped. By default it MUST be false, unless you are
|
|
// implementing extension grant type, which allows unauthenticated client. CanSkipClientAuth must be called
|
|
// before HandleTokenEndpointRequest to decide, if AccessRequester will contain authenticated client.
|
|
CanSkipClientAuth(ctx context.Context, requester AccessRequester) bool
|
|
|
|
// CanHandleRequest indicates, if TokenEndpointHandler can handle this request or not. If true,
|
|
// HandleTokenEndpointRequest can be called.
|
|
CanHandleTokenEndpointRequest(ctx context.Context, requester AccessRequester) bool
|
|
}
|
|
|
|
// RevocationHandler is the interface that allows token revocation for an OAuth2.0 provider.
|
|
// https://tools.ietf.org/html/rfc7009
|
|
//
|
|
// RevokeToken is invoked after a new token revocation request is parsed.
|
|
//
|
|
// https://tools.ietf.org/html/rfc7009#section-2.1
|
|
// If the particular
|
|
// token is a refresh token and the authorization server supports the
|
|
// revocation of access tokens, then the authorization server SHOULD
|
|
// also invalidate all access tokens based on the same authorization
|
|
// grant (see Implementation Note). If the token passed to the request
|
|
// is an access token, the server MAY revoke the respective refresh
|
|
// token as well.
|
|
type RevocationHandler interface {
|
|
// RevokeToken handles access and refresh token revocation.
|
|
RevokeToken(ctx context.Context, token string, tokenType TokenType, client Client) error
|
|
}
|
|
|
|
// PushedAuthorizeEndpointHandler is the interface that handles PAR (https://datatracker.ietf.org/doc/html/rfc9126)
|
|
type PushedAuthorizeEndpointHandler interface {
|
|
// HandlePushedAuthorizeRequest handles a pushed authorize endpoint request. To extend the handler's capabilities, the http request
|
|
// is passed along, if further information retrieval is required. If the handler feels that he is not responsible for
|
|
// the pushed authorize request, he must return nil and NOT modify session nor responder neither requester.
|
|
HandlePushedAuthorizeEndpointRequest(ctx context.Context, requester AuthorizeRequester, responder PushedAuthorizeResponder) error
|
|
}
|
|
|
|
// DeviceEndpointHandler is the interface that handles https://tools.ietf.org/html/rfc8628
|
|
type DeviceEndpointHandler interface {
|
|
// HandleDeviceEndpointRequest handles a device authorize endpoint request. To extend the handler's capabilities, the http request
|
|
// is passed along, if further information retrieval is required. If the handler feels that he is not responsible for
|
|
// the device authorize request, he must return nil and NOT modify session nor responder neither requester.
|
|
//
|
|
// The following spec is a good example of what HandleDeviceEndpointRequest should do.
|
|
// * https://tools.ietf.org/html/rfc8628#section-3.2
|
|
HandleDeviceEndpointRequest(ctx context.Context, requester DeviceRequester, responder DeviceResponder) error
|
|
}
|