Merge pull request #29932 from hpoettker
* pr/29932: Polish "Document WebSecurityCustomizer for H2 Console" Document WebSecurityCustomizer for H2 Console Closes gh-29932
This commit is contained in:
commit
0c90330f2a
|
|
@ -322,6 +322,30 @@ You can customize the console's path by using the configprop:spring.h2.console.p
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[[features.sql.h2-web-console.spring-security]]
|
||||||
|
==== Accessing the H2 Console in a Secured Application
|
||||||
|
H2 Console uses frames and, as it is intended for development only, does not implement CSRF protection measures.
|
||||||
|
If your application uses Spring Security, you need to configure it to
|
||||||
|
|
||||||
|
* disable CSRF protection for requests against the console,
|
||||||
|
* set the header `X-Frame-Options` to `SAMEORIGIN` on responses from the console.
|
||||||
|
|
||||||
|
More information on {spring-security-docs}#csrf[CSRF] and the header {spring-security-docs}#headers-frame-options[X-Frame-Options] can be found in the Spring Security Reference Guide.
|
||||||
|
|
||||||
|
In simple setups, a `SecurityFilterChain` like the following can be used:
|
||||||
|
|
||||||
|
[source,java,indent=0,subs="verbatim"]
|
||||||
|
----
|
||||||
|
include::{docs-java}/features/sql/h2webconsole/springsecurity/DevProfileSecurityConfiguration.java[]
|
||||||
|
----
|
||||||
|
|
||||||
|
WARNING: The H2 console is only intended for use during development.
|
||||||
|
In production, disabling CSRF protection or allowing frames for a website may create severe security risks.
|
||||||
|
|
||||||
|
TIP: `PathRequest.toH2Console()` returns the correct request matcher also when the console's path has been customized.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[[features.sql.jooq]]
|
[[features.sql.jooq]]
|
||||||
=== Using jOOQ
|
=== Using jOOQ
|
||||||
jOOQ Object Oriented Querying (https://www.jooq.org/[jOOQ]) is a popular product from https://www.datageekery.com/[Data Geekery] which generates Java code from your database and lets you build type-safe SQL queries through its fluent API.
|
jOOQ Object Oriented Querying (https://www.jooq.org/[jOOQ]) is a popular product from https://www.datageekery.com/[Data Geekery] which generates Java code from your database and lets you build type-safe SQL queries through its fluent API.
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,44 @@
|
||||||
|
/*
|
||||||
|
* Copyright 2012-2022 the original author or authors.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* https://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package org.springframework.boot.docs.features.sql.h2webconsole.springsecurity;
|
||||||
|
|
||||||
|
import org.springframework.boot.autoconfigure.security.servlet.PathRequest;
|
||||||
|
import org.springframework.context.annotation.Bean;
|
||||||
|
import org.springframework.context.annotation.Configuration;
|
||||||
|
import org.springframework.context.annotation.Profile;
|
||||||
|
import org.springframework.core.Ordered;
|
||||||
|
import org.springframework.core.annotation.Order;
|
||||||
|
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
|
||||||
|
import org.springframework.security.web.SecurityFilterChain;
|
||||||
|
|
||||||
|
@Profile("dev")
|
||||||
|
@Configuration(proxyBeanMethods = false)
|
||||||
|
public class DevProfileSecurityConfiguration {
|
||||||
|
|
||||||
|
@Bean
|
||||||
|
@Order(Ordered.HIGHEST_PRECEDENCE)
|
||||||
|
SecurityFilterChain h2ConsoleSecurityFilterChain(HttpSecurity http) throws Exception {
|
||||||
|
// @formatter:off
|
||||||
|
return http.requestMatcher(PathRequest.toH2Console())
|
||||||
|
// ... configuration for authorization
|
||||||
|
.csrf().disable()
|
||||||
|
.headers().frameOptions().sameOrigin().and()
|
||||||
|
.build();
|
||||||
|
// @formatter:on
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue