Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: more extension points #4272

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions driver/registry.go
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,7 @@ type options struct {
extraGoMigrations popx.Migrations
replacementStrategies []NewStrategy
extraHooks map[string]func(config.SelfServiceHook) any
extraHandlers []NewHandlerRegistrar
disableMigrationLogging bool
jsonnetPool jsonnetsecure.Pool
}
Expand Down Expand Up @@ -236,6 +237,14 @@ func WithExtraHooks(hooks map[string]func(config.SelfServiceHook) any) RegistryO
}
}

type NewHandlerRegistrar func(deps any) x.HandlerRegistrar

func WithExtraHandlers(handlers ...NewHandlerRegistrar) RegistryOption {
return func(o *options) {
o.extraHandlers = handlers
}
}

func Inspect(f func(reg Registry) error) RegistryOption {
return func(o *options) {
o.inspect = f
Expand Down
20 changes: 20 additions & 0 deletions driver/registry_default.go
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,8 @@ type RegistryDefault struct {
ctxer contextx.Contextualizer

injectedSelfserviceHooks map[string]func(config.SelfServiceHook) interface{}
extraHandlerFactories []NewHandlerRegistrar
extraHandlers []x.HandlerRegistrar

nosurf nosurf.Handler
trc *otelx.Tracer
Expand Down Expand Up @@ -175,6 +177,9 @@ func (m *RegistryDefault) Audit() *logrusx.Logger {
}

func (m *RegistryDefault) RegisterPublicRoutes(ctx context.Context, router *x.RouterPublic) {
for _, h := range m.ExtraHandlers() {
h.RegisterPublicRoutes(router)
}
m.LoginHandler().RegisterPublicRoutes(router)
m.RegistrationHandler().RegisterPublicRoutes(router)
m.LogoutHandler().RegisterPublicRoutes(router)
Expand All @@ -198,6 +203,9 @@ func (m *RegistryDefault) RegisterPublicRoutes(ctx context.Context, router *x.Ro
}

func (m *RegistryDefault) RegisterAdminRoutes(ctx context.Context, router *x.RouterAdmin) {
for _, h := range m.ExtraHandlers() {
h.RegisterAdminRoutes(router)
}
m.RegistrationHandler().RegisterAdminRoutes(router)
m.LoginHandler().RegisterAdminRoutes(router)
m.LogoutHandler().RegisterAdminRoutes(router)
Expand Down Expand Up @@ -640,6 +648,9 @@ func (m *RegistryDefault) Init(ctx context.Context, ctxer contextx.Contextualize
if o.extraHooks != nil {
m.WithHooks(o.extraHooks)
}
if o.extraHandlers != nil {
m.WithExtraHandlers(o.extraHandlers)
}

if o.replaceIdentitySchemaProvider != nil {
m.identitySchemaProvider = o.replaceIdentitySchemaProvider(m)
Expand Down Expand Up @@ -904,3 +915,12 @@ func (m *RegistryDefault) SessionTokenizer() *session.Tokenizer {
}
return m.sessionTokenizer
}

func (m *RegistryDefault) ExtraHandlers() []x.HandlerRegistrar {
if m.extraHandlers == nil {
for _, newHandler := range m.extraHandlerFactories {
m.extraHandlers = append(m.extraHandlers, newHandler(m))
}
}
return m.extraHandlers
}
3 changes: 3 additions & 0 deletions driver/registry_default_hooks.go
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,9 @@ func (m *RegistryDefault) HookTwoStepRegistration() *hook.TwoStepRegistration {
func (m *RegistryDefault) WithHooks(hooks map[string]func(config.SelfServiceHook) interface{}) {
m.injectedSelfserviceHooks = hooks
}
func (m *RegistryDefault) WithExtraHandlers(handlers []NewHandlerRegistrar) {
m.extraHandlerFactories = handlers
}

func (m *RegistryDefault) getHooks(credentialsType string, configs []config.SelfServiceHook) (i []interface{}) {
var addSessionIssuer bool
Expand Down
10 changes: 9 additions & 1 deletion embedx/config.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -460,7 +460,8 @@
"linkedin",
"linkedin_v2",
"lark",
"x"
"x",
"fedcm-test"
],
"examples": ["google"]
},
Expand Down Expand Up @@ -578,6 +579,13 @@
"type": "string",
"enum": ["auto", "never", "force"],
"default": "auto"
},
"fedcm_config_url": {
"title": "Federation Configuration URL",
"description": "The URL where the FedCM IdP configuration is located for the provider. This is only effective in the Ory Network.",
"type": "string",
"format": "uri",
"examples": ["https://example.com/config.json"]
}
},
"additionalProperties": false,
Expand Down
6 changes: 6 additions & 0 deletions internal/client-go/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ docs/ErrorGeneric.md
docs/FlowError.md
docs/FrontendAPI.md
docs/GenericError.md
docs/GetFedCmParametersResponse.md
docs/GetVersion200Response.md
docs/HealthNotReadyStatus.md
docs/HealthStatus.md
Expand Down Expand Up @@ -70,6 +71,7 @@ docs/OAuth2ConsentRequestOpenIDConnectContext.md
docs/OAuth2LoginRequest.md
docs/PatchIdentitiesBody.md
docs/PerformNativeLogoutBody.md
docs/Provider.md
docs/RecoveryCodeForIdentity.md
docs/RecoveryFlow.md
docs/RecoveryFlowState.md
Expand All @@ -83,6 +85,7 @@ docs/SessionAuthenticationMethod.md
docs/SessionDevice.md
docs/SettingsFlow.md
docs/SettingsFlowState.md
docs/SubmitFedcmTokenBody.md
docs/SuccessfulCodeExchangeResponse.md
docs/SuccessfulNativeLogin.md
docs/SuccessfulNativeRegistration.md
Expand Down Expand Up @@ -160,6 +163,7 @@ model_error_flow_replaced.go
model_error_generic.go
model_flow_error.go
model_generic_error.go
model_get_fed_cm_parameters_response.go
model_get_version_200_response.go
model_health_not_ready_status.go
model_health_status.go
Expand Down Expand Up @@ -193,6 +197,7 @@ model_o_auth2_consent_request_open_id_connect_context.go
model_o_auth2_login_request.go
model_patch_identities_body.go
model_perform_native_logout_body.go
model_provider.go
model_recovery_code_for_identity.go
model_recovery_flow.go
model_recovery_flow_state.go
Expand All @@ -206,6 +211,7 @@ model_session_authentication_method.go
model_session_device.go
model_settings_flow.go
model_settings_flow_state.go
model_submit_fedcm_token_body.go
model_successful_code_exchange_response.go
model_successful_native_login.go
model_successful_native_registration.go
Expand Down
5 changes: 5 additions & 0 deletions internal/client-go/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ Class | Method | HTTP request | Description
*FrontendAPI* | [**DisableMyOtherSessions**](docs/FrontendAPI.md#disablemyothersessions) | **Delete** /sessions | Disable my other sessions
*FrontendAPI* | [**DisableMySession**](docs/FrontendAPI.md#disablemysession) | **Delete** /sessions/{id} | Disable one of my sessions
*FrontendAPI* | [**ExchangeSessionToken**](docs/FrontendAPI.md#exchangesessiontoken) | **Get** /sessions/token-exchange | Exchange Session Token
*FrontendAPI* | [**GetFedcmParameters**](docs/FrontendAPI.md#getfedcmparameters) | **Get** /self-service/fed-cm/parameters | Get FedCM Parameters
*FrontendAPI* | [**GetFlowError**](docs/FrontendAPI.md#getflowerror) | **Get** /self-service/errors | Get User-Flow Errors
*FrontendAPI* | [**GetLoginFlow**](docs/FrontendAPI.md#getloginflow) | **Get** /self-service/login/flows | Get Login Flow
*FrontendAPI* | [**GetRecoveryFlow**](docs/FrontendAPI.md#getrecoveryflow) | **Get** /self-service/recovery/flows | Get Recovery Flow
Expand All @@ -104,6 +105,7 @@ Class | Method | HTTP request | Description
*FrontendAPI* | [**GetWebAuthnJavaScript**](docs/FrontendAPI.md#getwebauthnjavascript) | **Get** /.well-known/ory/webauthn.js | Get WebAuthn JavaScript
*FrontendAPI* | [**ListMySessions**](docs/FrontendAPI.md#listmysessions) | **Get** /sessions | Get My Active Sessions
*FrontendAPI* | [**PerformNativeLogout**](docs/FrontendAPI.md#performnativelogout) | **Delete** /self-service/logout/api | Perform Logout for Native Apps
*FrontendAPI* | [**SubmitFedcmToken**](docs/FrontendAPI.md#submitfedcmtoken) | **Post** /self-service/fed-cm/token | Submit a FedCM token
*FrontendAPI* | [**ToSession**](docs/FrontendAPI.md#tosession) | **Get** /sessions/whoami | Check Who the Current HTTP Session Belongs To
*FrontendAPI* | [**UpdateLoginFlow**](docs/FrontendAPI.md#updateloginflow) | **Post** /self-service/login | Submit a Login Flow
*FrontendAPI* | [**UpdateLogoutFlow**](docs/FrontendAPI.md#updatelogoutflow) | **Get** /self-service/logout | Update Logout Flow
Expand Down Expand Up @@ -160,6 +162,7 @@ Class | Method | HTTP request | Description
- [ErrorGeneric](docs/ErrorGeneric.md)
- [FlowError](docs/FlowError.md)
- [GenericError](docs/GenericError.md)
- [GetFedCmParametersResponse](docs/GetFedCmParametersResponse.md)
- [GetVersion200Response](docs/GetVersion200Response.md)
- [HealthNotReadyStatus](docs/HealthNotReadyStatus.md)
- [HealthStatus](docs/HealthStatus.md)
Expand Down Expand Up @@ -193,6 +196,7 @@ Class | Method | HTTP request | Description
- [OAuth2LoginRequest](docs/OAuth2LoginRequest.md)
- [PatchIdentitiesBody](docs/PatchIdentitiesBody.md)
- [PerformNativeLogoutBody](docs/PerformNativeLogoutBody.md)
- [Provider](docs/Provider.md)
- [RecoveryCodeForIdentity](docs/RecoveryCodeForIdentity.md)
- [RecoveryFlow](docs/RecoveryFlow.md)
- [RecoveryFlowState](docs/RecoveryFlowState.md)
Expand All @@ -206,6 +210,7 @@ Class | Method | HTTP request | Description
- [SessionDevice](docs/SessionDevice.md)
- [SettingsFlow](docs/SettingsFlow.md)
- [SettingsFlowState](docs/SettingsFlowState.md)
- [SubmitFedcmTokenBody](docs/SubmitFedcmTokenBody.md)
- [SuccessfulCodeExchangeResponse](docs/SuccessfulCodeExchangeResponse.md)
- [SuccessfulNativeLogin](docs/SuccessfulNativeLogin.md)
- [SuccessfulNativeRegistration](docs/SuccessfulNativeRegistration.md)
Expand Down
Loading
Loading