docs: expand Config Server security guide#3247
Open
won-seoop wants to merge 1 commit into
Open
Conversation
Expands the server/security.adoc page from a single-paragraph stub into a practical security reference guide, addressing the request in spring-cloud#1902. Adds the following sections: * HTTP Basic Authentication — configuration on both server and client sides, with a note on encrypting the password. * OAuth2 / JWT Bearer Token Authentication — dependency, JWKS/issuer-uri configuration, and a note that the Config Client does not obtain tokens automatically. * Per-Application Access Control — explains the risk raised in spring-cloud#1796 (any authenticated client can read any other application's config) and shows a Spring Security RequestMatcher example that restricts each client to paths matching its own principal name. * TLS / HTTPS — brief guidance to always enable TLS in production. * Client-Side Configuration — shows both the bootstrap.yml and spring.config.import patterns for supplying server credentials from environment variables rather than source-controlled files. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Addresses #1902.
Expands the
server/security.adocpage from a single-paragraph stub into a practical security reference guide.New sections
HTTP Basic Authentication
Shows server-side and client-side configuration, including encrypted passwords and how to supply credentials via environment variables.
OAuth2 / JWT Bearer Token Authentication
Shows the resource server dependency and
issuer-uriconfiguration. Includes a note that the Config Client does not automatically acquire OAuth2 tokens — the user is responsible for wiring upclient_credentialsgrant or similar.Per-Application Access Control⚠️
Explains the risk highlighted in #1796: any authenticated client can read any other application's config by using that application's name in the URL path. Shows a concrete
SecurityFilterChainexample that uses a Spring SecurityAuthorizationManagerto enforce that each principal can only access the{application}path that matches its own name.TLS / HTTPS
Brief note that TLS must be enabled in production.
Client-Side Configuration
Shows both the
bootstrap.ymlpattern and thespring.config.importURL pattern for supplying server credentials from environment variables rather than source-controlled files.Why
The current docs had one paragraph and left readers with no actionable guidance. The per-application access control section fills a specific security gap that has tripped up multiple users (see #1796 and related issues).
🤖 Generated with Claude Code