From d36c26f2edd66ddbd8338de4901957a9b9b7342e Mon Sep 17 00:00:00 2001 From: aeneasr <3372410+aeneasr@users.noreply.github.com> Date: Wed, 5 Aug 2020 11:31:25 +0200 Subject: [PATCH] feat: add session token security definition Adds the new Session Token as a Swagger security definition to allow setting the session token as a Bearer token when calling `/sessions/whoami`. --- .schema/api.swagger.json | 7 +++++++ .../httpclient/client/admin/create_identity_responses.go | 2 +- .../client/admin/create_recovery_link_responses.go | 2 +- .../httpclient/client/admin/delete_identity_responses.go | 2 +- internal/httpclient/client/admin/get_identity_responses.go | 2 +- .../httpclient/client/admin/list_identities_responses.go | 2 +- .../httpclient/client/admin/update_identity_responses.go | 2 +- internal/httpclient/client/common/get_schema_responses.go | 2 +- .../get_self_service_browser_login_request_responses.go | 2 +- .../get_self_service_browser_recovery_request_responses.go | 2 +- ..._self_service_browser_registration_request_responses.go | 2 +- .../get_self_service_browser_settings_request_responses.go | 2 +- .../client/common/get_self_service_error_responses.go | 2 +- .../get_self_service_verification_request_responses.go | 2 +- .../client/health/is_instance_alive_responses.go | 2 +- .../client/health/is_instance_ready_responses.go | 2 +- ...ervice_browser_recovery_link_strategy_flow_responses.go | 2 +- ...vice_browser_settings_o_id_c_settings_flow_responses.go | 2 +- ...ce_browser_settings_password_strategy_flow_responses.go | 2 +- ...ice_browser_settings_profile_strategy_flow_responses.go | 2 +- ...ete_self_service_browser_verification_flow_responses.go | 2 +- ...initialize_self_service_browser_login_flow_responses.go | 2 +- ...nitialize_self_service_browser_logout_flow_responses.go | 2 +- ...ize_self_service_browser_registration_flow_responses.go | 2 +- ...ize_self_service_browser_verification_flow_responses.go | 2 +- .../initialize_self_service_recovery_flow_responses.go | 2 +- .../initialize_self_service_settings_flow_responses.go | 2 +- .../client/public/self_service_browser_verify_responses.go | 2 +- internal/httpclient/client/public/whoami_responses.go | 2 +- .../httpclient/client/version/get_version_responses.go | 2 +- session/handler.go | 3 +++ swagger_meta.go | 6 ++++++ 32 files changed, 45 insertions(+), 29 deletions(-) diff --git a/.schema/api.swagger.json b/.schema/api.swagger.json index 58236ef0bbf..9ff1138fe1e 100755 --- a/.schema/api.swagger.json +++ b/.schema/api.swagger.json @@ -1981,6 +1981,13 @@ } } }, + "securityDefinitions": { + "sessionToken": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + }, "x-forwarded-proto": "string", "x-request-id": "string" } \ No newline at end of file diff --git a/internal/httpclient/client/admin/create_identity_responses.go b/internal/httpclient/client/admin/create_identity_responses.go index 274bbf9ac95..5e2173f5c4c 100644 --- a/internal/httpclient/client/admin/create_identity_responses.go +++ b/internal/httpclient/client/admin/create_identity_responses.go @@ -43,7 +43,7 @@ func (o *CreateIdentityReader) ReadResponse(response runtime.ClientResponse, con return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/admin/create_recovery_link_responses.go b/internal/httpclient/client/admin/create_recovery_link_responses.go index eb651d02aba..7ee43c45422 100644 --- a/internal/httpclient/client/admin/create_recovery_link_responses.go +++ b/internal/httpclient/client/admin/create_recovery_link_responses.go @@ -52,7 +52,7 @@ func (o *CreateRecoveryLinkReader) ReadResponse(response runtime.ClientResponse, return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/admin/delete_identity_responses.go b/internal/httpclient/client/admin/delete_identity_responses.go index e427870e714..3588ef3bac1 100644 --- a/internal/httpclient/client/admin/delete_identity_responses.go +++ b/internal/httpclient/client/admin/delete_identity_responses.go @@ -37,7 +37,7 @@ func (o *DeleteIdentityReader) ReadResponse(response runtime.ClientResponse, con return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/admin/get_identity_responses.go b/internal/httpclient/client/admin/get_identity_responses.go index 627ef91e59f..9a8941f9f07 100644 --- a/internal/httpclient/client/admin/get_identity_responses.go +++ b/internal/httpclient/client/admin/get_identity_responses.go @@ -43,7 +43,7 @@ func (o *GetIdentityReader) ReadResponse(response runtime.ClientResponse, consum return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/admin/list_identities_responses.go b/internal/httpclient/client/admin/list_identities_responses.go index 66cb2fda616..c5f85b4f569 100644 --- a/internal/httpclient/client/admin/list_identities_responses.go +++ b/internal/httpclient/client/admin/list_identities_responses.go @@ -37,7 +37,7 @@ func (o *ListIdentitiesReader) ReadResponse(response runtime.ClientResponse, con return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/admin/update_identity_responses.go b/internal/httpclient/client/admin/update_identity_responses.go index 6bf416f4b33..c3521abb358 100644 --- a/internal/httpclient/client/admin/update_identity_responses.go +++ b/internal/httpclient/client/admin/update_identity_responses.go @@ -49,7 +49,7 @@ func (o *UpdateIdentityReader) ReadResponse(response runtime.ClientResponse, con return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/common/get_schema_responses.go b/internal/httpclient/client/common/get_schema_responses.go index 74d43bbbcb3..7b35f518d7b 100644 --- a/internal/httpclient/client/common/get_schema_responses.go +++ b/internal/httpclient/client/common/get_schema_responses.go @@ -43,7 +43,7 @@ func (o *GetSchemaReader) ReadResponse(response runtime.ClientResponse, consumer return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/common/get_self_service_browser_login_request_responses.go b/internal/httpclient/client/common/get_self_service_browser_login_request_responses.go index 89903376e77..32b07cd5f69 100644 --- a/internal/httpclient/client/common/get_self_service_browser_login_request_responses.go +++ b/internal/httpclient/client/common/get_self_service_browser_login_request_responses.go @@ -55,7 +55,7 @@ func (o *GetSelfServiceBrowserLoginRequestReader) ReadResponse(response runtime. return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/common/get_self_service_browser_recovery_request_responses.go b/internal/httpclient/client/common/get_self_service_browser_recovery_request_responses.go index fa40ce21d06..1be5312ea14 100644 --- a/internal/httpclient/client/common/get_self_service_browser_recovery_request_responses.go +++ b/internal/httpclient/client/common/get_self_service_browser_recovery_request_responses.go @@ -55,7 +55,7 @@ func (o *GetSelfServiceBrowserRecoveryRequestReader) ReadResponse(response runti return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/common/get_self_service_browser_registration_request_responses.go b/internal/httpclient/client/common/get_self_service_browser_registration_request_responses.go index 932cb3f2074..8651879d941 100644 --- a/internal/httpclient/client/common/get_self_service_browser_registration_request_responses.go +++ b/internal/httpclient/client/common/get_self_service_browser_registration_request_responses.go @@ -55,7 +55,7 @@ func (o *GetSelfServiceBrowserRegistrationRequestReader) ReadResponse(response r return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/common/get_self_service_browser_settings_request_responses.go b/internal/httpclient/client/common/get_self_service_browser_settings_request_responses.go index 2bd06d6b811..a2b6d47374f 100644 --- a/internal/httpclient/client/common/get_self_service_browser_settings_request_responses.go +++ b/internal/httpclient/client/common/get_self_service_browser_settings_request_responses.go @@ -55,7 +55,7 @@ func (o *GetSelfServiceBrowserSettingsRequestReader) ReadResponse(response runti return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/common/get_self_service_error_responses.go b/internal/httpclient/client/common/get_self_service_error_responses.go index 21fccc2df82..101855f2f99 100644 --- a/internal/httpclient/client/common/get_self_service_error_responses.go +++ b/internal/httpclient/client/common/get_self_service_error_responses.go @@ -49,7 +49,7 @@ func (o *GetSelfServiceErrorReader) ReadResponse(response runtime.ClientResponse return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/common/get_self_service_verification_request_responses.go b/internal/httpclient/client/common/get_self_service_verification_request_responses.go index 61d9f44c2ca..629e2177c13 100644 --- a/internal/httpclient/client/common/get_self_service_verification_request_responses.go +++ b/internal/httpclient/client/common/get_self_service_verification_request_responses.go @@ -49,7 +49,7 @@ func (o *GetSelfServiceVerificationRequestReader) ReadResponse(response runtime. return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/health/is_instance_alive_responses.go b/internal/httpclient/client/health/is_instance_alive_responses.go index 392091c8fa8..e2a749c5fd6 100644 --- a/internal/httpclient/client/health/is_instance_alive_responses.go +++ b/internal/httpclient/client/health/is_instance_alive_responses.go @@ -37,7 +37,7 @@ func (o *IsInstanceAliveReader) ReadResponse(response runtime.ClientResponse, co return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/health/is_instance_ready_responses.go b/internal/httpclient/client/health/is_instance_ready_responses.go index e3b8c0c29a7..d64fb185ade 100644 --- a/internal/httpclient/client/health/is_instance_ready_responses.go +++ b/internal/httpclient/client/health/is_instance_ready_responses.go @@ -37,7 +37,7 @@ func (o *IsInstanceReadyReader) ReadResponse(response runtime.ClientResponse, co return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/public/complete_self_service_browser_recovery_link_strategy_flow_responses.go b/internal/httpclient/client/public/complete_self_service_browser_recovery_link_strategy_flow_responses.go index e5d0f8bf97f..6a9b6d1d345 100644 --- a/internal/httpclient/client/public/complete_self_service_browser_recovery_link_strategy_flow_responses.go +++ b/internal/httpclient/client/public/complete_self_service_browser_recovery_link_strategy_flow_responses.go @@ -37,7 +37,7 @@ func (o *CompleteSelfServiceBrowserRecoveryLinkStrategyFlowReader) ReadResponse( return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/public/complete_self_service_browser_settings_o_id_c_settings_flow_responses.go b/internal/httpclient/client/public/complete_self_service_browser_settings_o_id_c_settings_flow_responses.go index ca637dbb2dd..ddebc8a6c62 100644 --- a/internal/httpclient/client/public/complete_self_service_browser_settings_o_id_c_settings_flow_responses.go +++ b/internal/httpclient/client/public/complete_self_service_browser_settings_o_id_c_settings_flow_responses.go @@ -37,7 +37,7 @@ func (o *CompleteSelfServiceBrowserSettingsOIDCSettingsFlowReader) ReadResponse( return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/public/complete_self_service_browser_settings_password_strategy_flow_responses.go b/internal/httpclient/client/public/complete_self_service_browser_settings_password_strategy_flow_responses.go index 5a0a8ffc35b..e0fee737b01 100644 --- a/internal/httpclient/client/public/complete_self_service_browser_settings_password_strategy_flow_responses.go +++ b/internal/httpclient/client/public/complete_self_service_browser_settings_password_strategy_flow_responses.go @@ -37,7 +37,7 @@ func (o *CompleteSelfServiceBrowserSettingsPasswordStrategyFlowReader) ReadRespo return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/public/complete_self_service_browser_settings_profile_strategy_flow_responses.go b/internal/httpclient/client/public/complete_self_service_browser_settings_profile_strategy_flow_responses.go index 2df539415c5..fe112eaa427 100644 --- a/internal/httpclient/client/public/complete_self_service_browser_settings_profile_strategy_flow_responses.go +++ b/internal/httpclient/client/public/complete_self_service_browser_settings_profile_strategy_flow_responses.go @@ -37,7 +37,7 @@ func (o *CompleteSelfServiceBrowserSettingsProfileStrategyFlowReader) ReadRespon return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/public/complete_self_service_browser_verification_flow_responses.go b/internal/httpclient/client/public/complete_self_service_browser_verification_flow_responses.go index 418ce0651aa..ea3d53ff79f 100644 --- a/internal/httpclient/client/public/complete_self_service_browser_verification_flow_responses.go +++ b/internal/httpclient/client/public/complete_self_service_browser_verification_flow_responses.go @@ -37,7 +37,7 @@ func (o *CompleteSelfServiceBrowserVerificationFlowReader) ReadResponse(response return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/public/initialize_self_service_browser_login_flow_responses.go b/internal/httpclient/client/public/initialize_self_service_browser_login_flow_responses.go index 2ffa4c434b9..071d7471512 100644 --- a/internal/httpclient/client/public/initialize_self_service_browser_login_flow_responses.go +++ b/internal/httpclient/client/public/initialize_self_service_browser_login_flow_responses.go @@ -37,7 +37,7 @@ func (o *InitializeSelfServiceBrowserLoginFlowReader) ReadResponse(response runt return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/public/initialize_self_service_browser_logout_flow_responses.go b/internal/httpclient/client/public/initialize_self_service_browser_logout_flow_responses.go index 0ae132d7d33..30e222afa88 100644 --- a/internal/httpclient/client/public/initialize_self_service_browser_logout_flow_responses.go +++ b/internal/httpclient/client/public/initialize_self_service_browser_logout_flow_responses.go @@ -37,7 +37,7 @@ func (o *InitializeSelfServiceBrowserLogoutFlowReader) ReadResponse(response run return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/public/initialize_self_service_browser_registration_flow_responses.go b/internal/httpclient/client/public/initialize_self_service_browser_registration_flow_responses.go index 5b65b686476..e3328029e7a 100644 --- a/internal/httpclient/client/public/initialize_self_service_browser_registration_flow_responses.go +++ b/internal/httpclient/client/public/initialize_self_service_browser_registration_flow_responses.go @@ -37,7 +37,7 @@ func (o *InitializeSelfServiceBrowserRegistrationFlowReader) ReadResponse(respon return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/public/initialize_self_service_browser_verification_flow_responses.go b/internal/httpclient/client/public/initialize_self_service_browser_verification_flow_responses.go index a6fa50d3b7e..78bf0eb6d37 100644 --- a/internal/httpclient/client/public/initialize_self_service_browser_verification_flow_responses.go +++ b/internal/httpclient/client/public/initialize_self_service_browser_verification_flow_responses.go @@ -37,7 +37,7 @@ func (o *InitializeSelfServiceBrowserVerificationFlowReader) ReadResponse(respon return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/public/initialize_self_service_recovery_flow_responses.go b/internal/httpclient/client/public/initialize_self_service_recovery_flow_responses.go index 1995abf0e26..69ff637a906 100644 --- a/internal/httpclient/client/public/initialize_self_service_recovery_flow_responses.go +++ b/internal/httpclient/client/public/initialize_self_service_recovery_flow_responses.go @@ -37,7 +37,7 @@ func (o *InitializeSelfServiceRecoveryFlowReader) ReadResponse(response runtime. return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/public/initialize_self_service_settings_flow_responses.go b/internal/httpclient/client/public/initialize_self_service_settings_flow_responses.go index bb6bc9a14d7..0e4a6a69246 100644 --- a/internal/httpclient/client/public/initialize_self_service_settings_flow_responses.go +++ b/internal/httpclient/client/public/initialize_self_service_settings_flow_responses.go @@ -37,7 +37,7 @@ func (o *InitializeSelfServiceSettingsFlowReader) ReadResponse(response runtime. return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/public/self_service_browser_verify_responses.go b/internal/httpclient/client/public/self_service_browser_verify_responses.go index 8681ff7d759..980071a46eb 100644 --- a/internal/httpclient/client/public/self_service_browser_verify_responses.go +++ b/internal/httpclient/client/public/self_service_browser_verify_responses.go @@ -37,7 +37,7 @@ func (o *SelfServiceBrowserVerifyReader) ReadResponse(response runtime.ClientRes return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/public/whoami_responses.go b/internal/httpclient/client/public/whoami_responses.go index c98c9304082..17df465a26b 100644 --- a/internal/httpclient/client/public/whoami_responses.go +++ b/internal/httpclient/client/public/whoami_responses.go @@ -43,7 +43,7 @@ func (o *WhoamiReader) ReadResponse(response runtime.ClientResponse, consumer ru return nil, result default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/internal/httpclient/client/version/get_version_responses.go b/internal/httpclient/client/version/get_version_responses.go index 35b7856134e..cc099509922 100644 --- a/internal/httpclient/client/version/get_version_responses.go +++ b/internal/httpclient/client/version/get_version_responses.go @@ -31,7 +31,7 @@ func (o *GetVersionReader) ReadResponse(response runtime.ClientResponse, consume return result, nil default: - return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + return nil, runtime.NewAPIError("unknown error", response, response.Code()) } } diff --git a/session/handler.go b/session/handler.go index a687b93dc9f..abe78ab703c 100644 --- a/session/handler.go +++ b/session/handler.go @@ -67,6 +67,9 @@ func (h *Handler) RegisterAdminRoutes(admin *x.RouterAdmin) { // // Schemes: http, https // +// Security: +// - sessionToken +// // Responses: // 200: session // 403: genericError diff --git a/swagger_meta.go b/swagger_meta.go index 20900830250..c0ff39d05b7 100644 --- a/swagger_meta.go +++ b/swagger_meta.go @@ -14,6 +14,12 @@ // Produces: // - application/json // +// SecurityDefinitions: +// sessionToken: +// type: apiKey +// name: Authorization +// in: header +// // Extensions: // --- // x-request-id: string