Skip to content

Commit 9595306

Browse files
migunomiguno
committed
Remove Spring Boot Admin to make this project's code simpler
1 parent 7ec2642 commit 9595306

5 files changed

Lines changed: 3 additions & 141 deletions

File tree

‎README.md‎

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,6 @@ Features:
3333
at endpoint [/actuator](http://localhost:8123/actuator), e.g. for
3434
[healthchecks](http://localhost:8123/actuator/health) or [Prometheus
3535
metrics](http://localhost:8123/actuator/prometheus)
36-
- Integrates [Spring Boot
37-
Admin](https://github.com/codecentric/spring-boot-admin) at endpoint
38-
[`/admin`](http://localhost:8123/admin) to inspect the running application.
39-
Login with username `admin` and password `admin`.<br />
40-
<a href="https://github.com/miguno/java-docker-build-tutorial/raw/main/images/spring-boot-admin-dashboard.png"><img src="https://github.com/miguno/java-docker-build-tutorial/raw/main/images/spring-boot-admin-dashboard.png" alt="Spring Boot Admin screenshot" width="300"></a><br />
41-
Note that, in production, [it is recommended to
42-
separate the SBA server](https://docs.spring-boot-admin.com/current/faq.html)
43-
from your application (the SBA client), unlike what this project does for
44-
demonstration purposes.
4536
- Maven for build management (see [pom.xml](pom.xml)), using
4637
[Maven Wrapper](https://github.com/apache/maven-wrapper)
4738
- [GitHub Actions workflows](https://github.com/miguno/java-docker-build-tutorial/actions) for

‎src/main/java/com/miguno/javadockerbuild/controllers/RootController.java‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ public String root() {
4242
<li><a href="/welcome"><code>/welcome</code></a> &mdash; this app's example endpoint</li>
4343
<li><a href="/actuator/health"><code>/actuator/health</code></a> &mdash; Spring built-in feature</li>
4444
<li><a href="/actuator/prometheus"><code>/actuator/prometheus</code></a> &mdash; Spring built-in feature</li>
45-
<li><a href="/admin">Spring Boot Admin dashboard</a> <strong>(requires login, see below)</strong></li>
4645
<li><a href="/swagger-ui.html">Swagger UI</a></li>
4746
</ul>
4847
<h2>User Accounts</h2>

‎src/main/java/com/miguno/javadockerbuild/routes/AdminRedirector.java‎

Lines changed: 0 additions & 30 deletions
This file was deleted.

‎src/main/java/com/miguno/javadockerbuild/security/AppSecurityConfiguration.java‎

Lines changed: 3 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@
22

33
import java.util.UUID;
44

5-
import de.codecentric.boot.admin.server.config.AdminServerProperties;
65
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
7-
import jakarta.servlet.DispatcherType;
86
import org.springframework.beans.factory.annotation.Value;
97
import org.springframework.boot.autoconfigure.security.SecurityProperties;
108
import org.springframework.context.annotation.Bean;
@@ -24,16 +22,11 @@
2422
import org.springframework.security.web.csrf.CsrfTokenRequestAttributeHandler;
2523
import org.springframework.security.web.util.matcher.AntPathRequestMatcher;
2624

27-
import static org.springframework.http.HttpMethod.DELETE;
28-
import static org.springframework.http.HttpMethod.POST;
29-
3025
/** Secures the endpoints of this application. */
3126
@Configuration(proxyBeanMethods = false)
3227
@EnableWebSecurity
3328
public class AppSecurityConfiguration {
3429

35-
private final AdminServerProperties adminServer;
36-
3730
@Value("${app.spring-boot-admin.role.user.name}")
3831
private String roleUserName;
3932

@@ -47,9 +40,7 @@ public class AppSecurityConfiguration {
4740
private String roleAdminPassword;
4841

4942
@SuppressFBWarnings("EI_EXPOSE_REP2")
50-
public AppSecurityConfiguration(AdminServerProperties adminServer, SecurityProperties security) {
51-
this.adminServer = adminServer;
52-
}
43+
public AppSecurityConfiguration(SecurityProperties security) {}
5344

5445
/**
5546
* Applies security policies such as authentication requirements to endpoints.
@@ -63,7 +54,7 @@ protected SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
6354
SavedRequestAwareAuthenticationSuccessHandler successHandler =
6455
new SavedRequestAwareAuthenticationSuccessHandler();
6556
successHandler.setTargetUrlParameter("redirectTo");
66-
successHandler.setDefaultTargetUrl(this.adminServer.path("/"));
57+
successHandler.setDefaultTargetUrl("/");
6758

6859
// NOTE: In this project, the Spring Boot Admin server and client are colocated in the same
6960
// application for demonstration purposes. In production, you would typically not do that
@@ -77,20 +68,6 @@ protected SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
7768
http.authorizeHttpRequests(
7869
(authorizeRequests) ->
7970
authorizeRequests
80-
//// For the Spring Boot Admin server.
81-
.requestMatchers(
82-
// Permit public access to all static assets.
83-
new AntPathRequestMatcher(this.adminServer.path("/assets/**")),
84-
// Permit public access to the login page.
85-
new AntPathRequestMatcher(this.adminServer.path("/login")))
86-
.permitAll()
87-
// Permit asynchronous processing of a request without requiring authentication.
88-
// FIXME: Permitting any async requests as a workaround appears dangerous.
89-
// https://github.com/spring-projects/spring-security/issues/11027 (from 2022)
90-
.dispatcherTypeMatchers(DispatcherType.ASYNC)
91-
.permitAll()
92-
93-
//// For the Spring Boot Admin client (the "real" app being developed).
9471
.requestMatchers(
9572
new AntPathRequestMatcher("/"),
9673
// Permit public access to this app's example endpoint at `/welcome`.
@@ -103,16 +80,9 @@ protected SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
10380
new AntPathRequestMatcher("/actuator/info"),
10481
new AntPathRequestMatcher("/actuator/prometheus"))
10582
.permitAll()
106-
107-
//// Applies to both SBA server and clients.
10883
// All other requests must be authenticated.
10984
.anyRequest()
11085
.authenticated())
111-
// For Spring Boot Admin server: enables form-based login and logout.
112-
.formLogin(
113-
(formLogin) ->
114-
formLogin.loginPage(this.adminServer.path("/login")).successHandler(successHandler))
115-
.logout((logout) -> logout.logoutUrl(this.adminServer.path("/logout")))
11686
// Enables HTTP Basic Authentication support.
11787
.httpBasic(Customizer.withDefaults());
11888

@@ -121,20 +91,7 @@ protected SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
12191
.csrf(
12292
(csrf) ->
12393
csrf.csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse())
124-
.csrfTokenRequestHandler(new CsrfTokenRequestAttributeHandler())
125-
.ignoringRequestMatchers(
126-
//// For the Spring Boot Admin server.
127-
// Disables CSRF-Protection for the SBA server's endpoints that the SBA
128-
// client uses to (de-)register.
129-
new AntPathRequestMatcher(
130-
this.adminServer.path("/instances"), POST.toString()),
131-
new AntPathRequestMatcher(
132-
this.adminServer.path("/instances/*"), DELETE.toString()),
133-
134-
//// For the Spring Boot Admin client.
135-
// Disables CSRF-Protection for the SBA client's actuator endpoints that
136-
// the SBA server uses to collect metrics.
137-
new AntPathRequestMatcher("/actuator/**")));
94+
.csrfTokenRequestHandler(new CsrfTokenRequestAttributeHandler()));
13895

13996
http.rememberMe(
14097
(rememberMe) -> rememberMe.key(UUID.randomUUID().toString()).tokenValiditySeconds(1209600));
@@ -145,14 +102,6 @@ protected SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
145102
/** Required to provide UserDetailsService for "remember functionality". */
146103
@Bean
147104
public InMemoryUserDetailsManager userDetailsService(PasswordEncoder passwordEncoder) {
148-
// NOTE: Because this example project runs the Spring Boot Admin server and client in the same
149-
// application, both the server's secured (with HTTP Basic Authentication) SBA API
150-
// endpoint and the client's Spring actuator endpoints coincidentally require exactly the
151-
// same username/password combination.
152-
// In production, this is not recommended. See the recommendations of Spring Boot Admin at
153-
// https://docs.spring-boot-admin.com/current/faq.html.
154-
// Instead, in production you would separate clients from the server, and thus different
155-
// username/password combinations can be used.
156105
// NOTE: HTTP Basic Authentication itself is not recommended for production.
157106
UserDetails user =
158107
User.withUsername(roleUserName)

‎src/main/resources/application.properties‎

Lines changed: 0 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -31,50 +31,3 @@ server.port=8123
3131
management.endpoints.web.exposure.include=*
3232
# Enable the env contributor.
3333
management.info.env.enabled=true
34-
35-
################################################################################
36-
# Spring Boot Admin #
37-
################################################################################
38-
### Spring Boot Admin: server settings
39-
spring.boot.admin.context-path=admin
40-
spring.boot.admin.ui.title=Spring Boot Admin (user: ${app.spring-boot-admin.role.admin.name}, password: ${app.spring-boot-admin.role.admin.password})
41-
spring.boot.admin.instance-auth.enabled=true
42-
# Default username to use if SBA Client actuator endpoints are protected with
43-
# HTTP Basic authentication.
44-
#
45-
# Used as fallback when the server attempts to collect metrics from a secured
46-
# client in the case that the client, upon its own registration with the server,
47-
# did not provide a particular username and password for the server to use.
48-
# Clients can pass such metadata to servers so that a server can "personalize"
49-
# its communication with a client. Here, the client would do this by setting
50-
# `spring.boot.admin.client.instance.metadata.user.name` and
51-
# `spring.boot.admin.client.instance.metadata.user.password` in its
52-
# `application.properties`.
53-
#spring.boot.admin.instance-auth.default-user-name=${app.spring-boot-admin.role.user.name}
54-
# Same as `spring.boot.admin.instance-auth.default-user-name`, but for the
55-
# password.
56-
#spring.boot.admin.instance-auth.default-password=${app.spring-boot-admin.role.user.password}
57-
58-
### Spring Boot Admin: client settings
59-
spring.boot.admin.client.enabled=true
60-
# The URL of the Spring Boot Admin server that the client uses to register
61-
# itself.
62-
spring.boot.admin.client.url=http://localhost:${server.port}/admin
63-
# Username if SBA server API is protected with HTTP Basic Authentication.
64-
# Used when the client registers itself with a secured SBA server.
65-
spring.boot.admin.client.username=${app.spring-boot-admin.role.user.name}
66-
# Password if SBA server API is protected with HTTP Basic Authentication.
67-
# Used when the client registers itself with a secured SBA server.
68-
spring.boot.admin.client.password=${app.spring-boot-admin.role.user.password}
69-
# The URL of the Spring Boot Admin client that is used by the server to collect
70-
# metrics.
71-
spring.boot.admin.client.instance.service-base-url=http://localhost:${server.port}/
72-
# Part of the metadata passed from the SBA client to the SBA server. Here, the
73-
# SBA client tells the SBA server: "When you (server) are connecting to my
74-
# (client) actuator endpoints (like `/actuator/health`) to fetch metrics etc.,
75-
# use the following username in case the actuator endpoints are protected by
76-
# HTTP Basic authentication."
77-
spring.boot.admin.client.instance.metadata.user.name=${app.spring-boot-admin.role.user.name}
78-
# Same as `spring.boot.admin.client.instance.metadata.user.name`, but for the
79-
# password.
80-
spring.boot.admin.client.instance.metadata.user.password=${app.spring-boot-admin.role.user.password}

0 commit comments

Comments
 (0)