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.

Sign up for GitHub

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

BED-5013: Deprecate Create SAML Endpoint #1033

Merged
merged 13 commits into from
Dec 20, 2024
Merged

BED-5013: Deprecate Create SAML Endpoint #1033

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
2593dd3
fix: deprecated and moved CreateSAMLProvider to POST sso-providers/sa…
iustinum Dec 20, 2024
afa1b07
chore: just prepare-for-codereview
iustinum Dec 20, 2024
c41501b
fix: update UI api call to new endpoint
iustinum Dec 20, 2024
f6d895f
Update cmd/api/src/api/registration/v2.go
iustinum Dec 20, 2024
853421c
Update packages/go/openapi/src/paths/auth.sso-providers.saml.yaml
iustinum Dec 20, 2024
c6a2315
Merge branch 'main' of github.com:SpecterOps/BloodHound into BED-5013
iustinum Dec 20, 2024
26c7917
Merge branch 'BED-5013' of github.com:SpecterOps/BloodHound into BED-…
iustinum Dec 20, 2024
00a155f
chore: remove deprecated api from ui and docs
iustinum Dec 20, 2024
1953bd0
just gen-spec
iustinum Dec 20, 2024
a53f232
chore: just prepare-for-codereview
iustinum Dec 20, 2024
4dd8d2d
restore saml doc and mark as deprecated
iustinum Dec 20, 2024
88fb7a8
chore: just ready-for-codereview
iustinum Dec 20, 2024
a21c4a9
minor description fix
iustinum Dec 20, 2024
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
2 changes: 2 additions & 0 deletions cmd/api/src/api/registration/v2.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ func registerV2Auth(resources v2.Resources, routerInst *router.Router, permissio
routerInst.PathPrefix(fmt.Sprintf("/api/{version}/login/saml/{%s}", api.URIPathVariableSSOProviderSlug), http.HandlerFunc(managementResource.SAMLLoginRedirect)),

// SAML resources
// DEPRECATED as of v6.4.0: Please use /api/v2/sso-providers/* endpoints instead of /api/v2/saml/*
routerInst.GET("/api/v2/saml", managementResource.ListSAMLProviders).RequirePermissions(permissions.AuthManageProviders),
routerInst.GET("/api/v2/saml/sso", managementResource.ListSAMLSignOnEndpoints),
routerInst.POST("/api/v2/saml/providers", managementResource.CreateSAMLProviderMultipart).RequirePermissions(permissions.AuthManageProviders),
Expand All @@ -57,6 +58,7 @@ func registerV2Auth(resources v2.Resources, routerInst *router.Router, permissio

// SSO
routerInst.GET("/api/v2/sso-providers", managementResource.ListAuthProviders),
routerInst.POST("/api/v2/sso-providers/saml", managementResource.CreateSAMLProviderMultipart).RequirePermissions(permissions.AuthManageProviders),
routerInst.POST("/api/v2/sso-providers/oidc", managementResource.CreateOIDCProvider).CheckFeatureFlag(resources.DB, appcfg.FeatureOIDCSupport).RequirePermissions(permissions.AuthManageProviders),
routerInst.DELETE(fmt.Sprintf("/api/v2/sso-providers/{%s}", api.URIPathVariableSSOProviderID), managementResource.DeleteSSOProvider).RequirePermissions(permissions.AuthManageProviders),
routerInst.PATCH(fmt.Sprintf("/api/v2/sso-providers/{%s}", api.URIPathVariableSSOProviderID), managementResource.UpdateSSOProvider).RequirePermissions(permissions.AuthManageProviders),
Expand Down
79 changes: 74 additions & 5 deletions packages/go/openapi/doc/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,8 @@
"get": {
"operationId": "ListSamlProviders",
"summary": "List SAML Providers",
"description": "List all registered SAML providers.",
"description": "**Deprecated**: This endpoint will no longer be supported in a future release. Please use `GET /api/v2/sso-providers` instead.\n",
"deprecated": true,
"tags": [
"Auth",
"Community",
Expand Down Expand Up @@ -279,7 +280,8 @@
"get": {
"operationId": "GetSamlSignSignOnEndpoints",
"summary": "Get all SAML sign on endpoints",
"description": "Get all SAML sign on endpoints",
"description": "**Deprecated**: This endpoint will no longer be supported in a future release. Please use `GET /api/v2/sso-providers` instead to list available SSO endpoints.\n",
"deprecated": true,
"tags": [
"Auth",
"Community",
Expand Down Expand Up @@ -323,7 +325,8 @@
"post": {
"operationId": "CreateSamlProvider",
"summary": "Create a New SAML Provider from Metadata",
"description": "Creates a new SAML provider with the given name and metadata XML.",
"description": "**Deprecated**: This endpoint will no longer be supported in a future release. Please use `POST /api/v2/sso-providers/saml` instead.\n",
"deprecated": true,
"tags": [
"Auth",
"Community",
Expand Down Expand Up @@ -402,7 +405,8 @@
"get": {
"operationId": "GetSamlProvider",
"summary": "Get SAML Provider",
"description": "Get the service and identity provider configuration details for a SAML authentication provider.",
"description": "**Deprecated**: This endpoint will no longer be supported in a future release. Please use `GET /api/v2/sso-providers` to list all SAML providers instead.\n",
"deprecated": true,
"tags": [
"Auth",
"Community",
Expand Down Expand Up @@ -444,7 +448,8 @@
"delete": {
"operationId": "DeleteSamlProvider",
"summary": "Delete a SAML Provider",
"description": "Deletes an existing BloodHound SAML provider.",
"description": "**Deprecated**: This endpoint will no longer be supported in a future release. Please use `DELETE /api/v2/sso-providers/{sso_provider_id}` instead.\n",
"deprecated": true,
"tags": [
"Auth",
"Community",
Expand Down Expand Up @@ -630,6 +635,70 @@
}
}
},
"/api/v2/sso-providers/saml": {
"post": {
"operationId": "CreateSSOSAMLProvider",
"summary": "Create a New SAML Provider from Metadata",
"description": "Creates a new SAML provider with the given name and metadata XML.",
"tags": [
"Auth",
"Community",
"Enterprise"
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"name": {
"type": "string",
"description": "Name of the new SAML provider."
},
"metadata": {
"type": "string",
"format": "binary",
"description": "Metadata XML file."
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/model.saml-provider"
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/bad-request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"429": {
"$ref": "#/components/responses/too-many-requests"
},
"500": {
"$ref": "#/components/responses/internal-server-error"
}
}
}
},
"/api/v2/sso-providers/{sso_provider_id}": {
"parameters": [
{
Expand Down
Loading
Loading