260421_02_ENH: 전체적으로 정리
This commit is contained in:
43
README.md
43
README.md
@@ -208,13 +208,6 @@ kri:
|
|||||||
allowed-ips:
|
allowed-ips:
|
||||||
# Swagger UI / API Docs 접근 허용 IP
|
# Swagger UI / API Docs 접근 허용 IP
|
||||||
- "127.0.0.1"
|
- "127.0.0.1"
|
||||||
webmvc:
|
|
||||||
# 공통 MVC 자동구성 활성화
|
|
||||||
enabled: true
|
|
||||||
ip:
|
|
||||||
additional-cidrs:
|
|
||||||
# Swagger 접근 허용 CIDR 추가값
|
|
||||||
- "192.168.0.0/16"
|
|
||||||
web:
|
web:
|
||||||
# 공통 웹 예외/trace 필터 활성화
|
# 공통 웹 예외/trace 필터 활성화
|
||||||
enabled: true
|
enabled: true
|
||||||
@@ -267,11 +260,6 @@ kri:
|
|||||||
- 사용 대상 클래스: `CommonWebAutoConfiguration`
|
- 사용 대상 클래스: `CommonWebAutoConfiguration`
|
||||||
- 설명: `ErrorAdvice`, `TraceFilter`, MDC 관련 구성을 켜고 끕니다.
|
- 설명: `ErrorAdvice`, `TraceFilter`, MDC 관련 구성을 켜고 끕니다.
|
||||||
|
|
||||||
#### `kri.webmvc`
|
|
||||||
|
|
||||||
- 대상: CORS, Swagger IP 인터셉터, `RequestUserContext` 처리
|
|
||||||
- 사용 대상 클래스: `KriWebMvcAutoConfiguration`, `KriIpAccessProperties`
|
|
||||||
- 설명: MVC 확장 기능과 CIDR 기반 접근 제어를 등록합니다.
|
|
||||||
|
|
||||||
#### `kri.redis`
|
#### `kri.redis`
|
||||||
|
|
||||||
@@ -307,19 +295,16 @@ kri:
|
|||||||
- `com.kri.common.runtime.swagger`
|
- `com.kri.common.runtime.swagger`
|
||||||
- `SwaggerIpFilter`
|
- `SwaggerIpFilter`
|
||||||
- `com.kri.common.runtime.web`
|
- `com.kri.common.runtime.web`
|
||||||
- `ErrorAdvice`
|
|
||||||
- `TraceFilter`
|
|
||||||
- `MdcHandlerConfig`
|
|
||||||
- `ServiceMdcAspect`
|
|
||||||
- `com.kri.common.runtime.webmvc`
|
|
||||||
- `CodeEnumConverter`
|
- `CodeEnumConverter`
|
||||||
- `IpAccessControlInterceptor`
|
- `ErrorAdvice`
|
||||||
- `IpAccessControlService`
|
|
||||||
- `IpUtil`
|
- `IpUtil`
|
||||||
- `RequestUserContextArgumentResolver`
|
- `RequestUserContextArgumentResolver`
|
||||||
|
- `TraceFilter`
|
||||||
|
- `ServiceMdcAspect`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
## 자동 노출 endpoint
|
## 자동 노출 endpoint
|
||||||
|
|
||||||
#### `com.kri.common.endpoint.auth.apikey.ApiKeyAdminController`
|
#### `com.kri.common.endpoint.auth.apikey.ApiKeyAdminController`
|
||||||
@@ -330,6 +315,25 @@ kri:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Migration Guide
|
||||||
|
|
||||||
|
- `kri.webmvc.enabled` 설정은 제거하고 `kri.web.enabled`만 사용합니다.
|
||||||
|
- `kri.webmvc.ip.*` 설정은 제거하고 Swagger IP 제어는 `kri.swagger.allowed-ips`만 사용합니다.
|
||||||
|
- 프록시 환경에서는 API Key admin API와 Swagger가 모두 `IpUtil` 기준으로 클라이언트 IP를 해석합니다. `kri.auth.apikey.admin-allow-ips` 값을 다시 확인하세요.
|
||||||
|
- 내부 클래스를 직접 import하고 있었다면 아래처럼 경로를 변경해야 합니다.
|
||||||
|
- `com.kri.common.runtime.webmvc.CodeEnumConverter` -> `com.kri.common.runtime.web.CodeEnumConverter`
|
||||||
|
- `com.kri.common.runtime.webmvc.IpUtil` -> `com.kri.common.runtime.web.IpUtil`
|
||||||
|
- `com.kri.common.runtime.webmvc.RequestUserContextArgumentResolver` -> `com.kri.common.runtime.web.RequestUserContextArgumentResolver`
|
||||||
|
- 아래 클래스와 설정 객체는 제거되었습니다.
|
||||||
|
- `com.kri.common.autoconfigure.webmvc.KriWebMvcAutoConfiguration`
|
||||||
|
- `com.kri.common.autoconfigure.webmvc.KriIpAccessProperties`
|
||||||
|
- `com.kri.common.runtime.web.IpAccessControlInterceptor`
|
||||||
|
- `com.kri.common.runtime.web.IpAccessControlService`
|
||||||
|
- `com.kri.common.runtime.web.MdcHandlerConfig`
|
||||||
|
- Swagger 문서의 인증 표시는 `BearerAuth`와 `ApiKeyAuth`를 동시에 요구하지 않고, 둘 중 하나로 인증 가능한 형태로 바뀌었습니다.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## AutoConfiguration 목록
|
## AutoConfiguration 목록
|
||||||
|
|
||||||
`src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports`
|
`src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports`
|
||||||
@@ -340,7 +344,6 @@ kri:
|
|||||||
- `com.kri.common.autoconfigure.auth.apikey.ApiKeyAdminAutoConfiguration`
|
- `com.kri.common.autoconfigure.auth.apikey.ApiKeyAdminAutoConfiguration`
|
||||||
- `com.kri.common.autoconfigure.security.KriSecurityAutoConfiguration`
|
- `com.kri.common.autoconfigure.security.KriSecurityAutoConfiguration`
|
||||||
- `com.kri.common.autoconfigure.web.CommonWebAutoConfiguration`
|
- `com.kri.common.autoconfigure.web.CommonWebAutoConfiguration`
|
||||||
- `com.kri.common.autoconfigure.webmvc.KriWebMvcAutoConfiguration`
|
|
||||||
- `com.kri.common.autoconfigure.swagger.KriSwaggerAutoConfiguration`
|
- `com.kri.common.autoconfigure.swagger.KriSwaggerAutoConfiguration`
|
||||||
- `com.kri.common.autoconfigure.redis.CommonRedisAutoConfiguration`
|
- `com.kri.common.autoconfigure.redis.CommonRedisAutoConfiguration`
|
||||||
- `com.kri.common.autoconfigure.scheduling.CommonSchedulingAutoConfiguration`
|
- `com.kri.common.autoconfigure.scheduling.CommonSchedulingAutoConfiguration`
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ plugins {
|
|||||||
}
|
}
|
||||||
|
|
||||||
//버전 변경은 여기서
|
//버전 변경은 여기서
|
||||||
def commonVer = "beta.1.1.16"
|
def commonVer = "beta.1.1.17"
|
||||||
|
|
||||||
group = 'com.kri.common'
|
group = 'com.kri.common'
|
||||||
version = commonVer
|
version = commonVer
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
package com.kri.common.autoconfigure.security;
|
package com.kri.common.autoconfigure.security;
|
||||||
|
|
||||||
import com.kri.common.runtime.auth.apikey.ApiKeyAuthFilter;
|
import com.kri.common.runtime.auth.apikey.ApiKeyAuthFilter;
|
||||||
import com.kri.common.autoconfigure.auth.jwt.JwtProperties;
|
|
||||||
import com.kri.common.feature.auth.jwt.JwtService;
|
import com.kri.common.feature.auth.jwt.JwtService;
|
||||||
import com.kri.common.runtime.security.JwtAuthenticationFilter;
|
import com.kri.common.runtime.security.JwtAuthenticationFilter;
|
||||||
import lombok.RequiredArgsConstructor;
|
import lombok.RequiredArgsConstructor;
|
||||||
@@ -21,7 +20,7 @@ import org.springframework.security.web.SecurityFilterChain;
|
|||||||
import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;
|
import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;
|
||||||
|
|
||||||
@AutoConfiguration(before = SecurityAutoConfiguration.class)
|
@AutoConfiguration(before = SecurityAutoConfiguration.class)
|
||||||
@EnableConfigurationProperties({KriSecurityProperties.class, JwtProperties.class})
|
@EnableConfigurationProperties(KriSecurityProperties.class)
|
||||||
@ConditionalOnProperty(prefix = "kri.security", name = "enabled", havingValue = "true", matchIfMissing = true)
|
@ConditionalOnProperty(prefix = "kri.security", name = "enabled", havingValue = "true", matchIfMissing = true)
|
||||||
@EnableMethodSecurity(
|
@EnableMethodSecurity(
|
||||||
jsr250Enabled = true,
|
jsr250Enabled = true,
|
||||||
@@ -31,13 +30,6 @@ import org.springframework.security.web.authentication.UsernamePasswordAuthentic
|
|||||||
public class KriSecurityAutoConfiguration {
|
public class KriSecurityAutoConfiguration {
|
||||||
|
|
||||||
private final KriSecurityProperties securityProperties;
|
private final KriSecurityProperties securityProperties;
|
||||||
private final JwtProperties jwtProperties;
|
|
||||||
|
|
||||||
@Bean
|
|
||||||
@ConditionalOnMissingBean
|
|
||||||
public JwtService jwtService(JwtProperties properties) {
|
|
||||||
return new JwtService(properties);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Bean
|
@Bean
|
||||||
@ConditionalOnMissingBean
|
@ConditionalOnMissingBean
|
||||||
|
|||||||
@@ -55,13 +55,15 @@ public class KriSwaggerAutoConfiguration {
|
|||||||
.name(apiKeyProperties.getHeaderName())); // 예: X-API-Key
|
.name(apiKeyProperties.getHeaderName())); // 예: X-API-Key
|
||||||
|
|
||||||
// 두 보안 스키마를 기본 보안 요구사항으로 등록
|
// 두 보안 스키마를 기본 보안 요구사항으로 등록
|
||||||
SecurityRequirement securityRequirement = new SecurityRequirement()
|
SecurityRequirement bearerRequirement = new SecurityRequirement()
|
||||||
.addList("BearerAuth")
|
.addList("BearerAuth");
|
||||||
|
SecurityRequirement apiKeyRequirement = new SecurityRequirement()
|
||||||
.addList("ApiKeyAuth");
|
.addList("ApiKeyAuth");
|
||||||
|
|
||||||
return new OpenAPI()
|
return new OpenAPI()
|
||||||
.components(components)
|
.components(components)
|
||||||
.addSecurityItem(securityRequirement)
|
.addSecurityItem(bearerRequirement)
|
||||||
|
.addSecurityItem(apiKeyRequirement)
|
||||||
.info(new Info()
|
.info(new Info()
|
||||||
.title(properties.getTitle())
|
.title(properties.getTitle())
|
||||||
.description(properties.getDescription())
|
.description(properties.getDescription())
|
||||||
|
|||||||
@@ -1,21 +1,31 @@
|
|||||||
package com.kri.common.autoconfigure.web;
|
package com.kri.common.autoconfigure.web;
|
||||||
|
|
||||||
|
import com.kri.common.feature.auth.jwt.JwtService;
|
||||||
|
import com.kri.common.runtime.web.CodeEnumConverter;
|
||||||
import com.kri.common.runtime.web.ErrorAdvice;
|
import com.kri.common.runtime.web.ErrorAdvice;
|
||||||
import com.kri.common.runtime.web.MdcHandlerConfig;
|
|
||||||
import com.kri.common.runtime.web.ServiceMdcAspect;
|
import com.kri.common.runtime.web.ServiceMdcAspect;
|
||||||
import com.kri.common.runtime.web.TraceFilter;
|
import com.kri.common.runtime.web.TraceFilter;
|
||||||
|
import com.kri.common.runtime.web.RequestUserContextArgumentResolver;
|
||||||
|
import jakarta.servlet.http.HttpServletRequest;
|
||||||
|
import jakarta.servlet.http.HttpServletResponse;
|
||||||
import org.aspectj.lang.annotation.Aspect;
|
import org.aspectj.lang.annotation.Aspect;
|
||||||
|
import org.springframework.beans.factory.ObjectProvider;
|
||||||
import org.springframework.boot.autoconfigure.AutoConfiguration;
|
import org.springframework.boot.autoconfigure.AutoConfiguration;
|
||||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
|
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
|
||||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
|
import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
|
||||||
|
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
|
||||||
|
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
|
||||||
import org.springframework.boot.web.servlet.FilterRegistrationBean;
|
import org.springframework.boot.web.servlet.FilterRegistrationBean;
|
||||||
import org.springframework.context.annotation.Bean;
|
import org.springframework.context.annotation.Bean;
|
||||||
import org.springframework.context.annotation.Import;
|
|
||||||
import org.springframework.core.Ordered;
|
import org.springframework.core.Ordered;
|
||||||
|
import org.slf4j.MDC;
|
||||||
|
import org.springframework.web.method.HandlerMethod;
|
||||||
|
import org.springframework.web.servlet.config.annotation.CorsRegistry;
|
||||||
|
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
|
||||||
|
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
|
||||||
|
|
||||||
@AutoConfiguration
|
@AutoConfiguration
|
||||||
@ConditionalOnExpression("${kri.web.enabled:true}")
|
@ConditionalOnExpression("${kri.web.enabled:true}")
|
||||||
@Import(MdcHandlerConfig.class)
|
|
||||||
public class CommonWebAutoConfiguration {
|
public class CommonWebAutoConfiguration {
|
||||||
|
|
||||||
@Bean
|
@Bean
|
||||||
@@ -36,4 +46,75 @@ public class CommonWebAutoConfiguration {
|
|||||||
public ServiceMdcAspect serviceMdcAspect() {
|
public ServiceMdcAspect serviceMdcAspect() {
|
||||||
return new ServiceMdcAspect();
|
return new ServiceMdcAspect();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Bean
|
||||||
|
@ConditionalOnExpression("${kri.web.mdc.enabled:true}")
|
||||||
|
public WebMvcConfigurer mdcWebMvcConfigurer() {
|
||||||
|
return new WebMvcConfigurer() {
|
||||||
|
@Override
|
||||||
|
public void addInterceptors(InterceptorRegistry registry) {
|
||||||
|
registry.addInterceptor(new org.springframework.web.servlet.HandlerInterceptor() {
|
||||||
|
@Override
|
||||||
|
public boolean preHandle(HttpServletRequest req, HttpServletResponse res, Object handler) {
|
||||||
|
if (handler instanceof HandlerMethod hm) {
|
||||||
|
String ctrl = hm.getBeanType().getSimpleName();
|
||||||
|
String method = hm.getMethod().getName();
|
||||||
|
MDC.put("handler", ctrl + "#" + method);
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void afterCompletion(
|
||||||
|
HttpServletRequest req,
|
||||||
|
HttpServletResponse res,
|
||||||
|
Object handler,
|
||||||
|
Exception ex
|
||||||
|
) {
|
||||||
|
MDC.remove("handler");
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
@Bean
|
||||||
|
@ConditionalOnBean(JwtService.class)
|
||||||
|
@ConditionalOnMissingBean
|
||||||
|
public RequestUserContextArgumentResolver requestUserContextArgumentResolver(
|
||||||
|
JwtService jwtService
|
||||||
|
) {
|
||||||
|
return new RequestUserContextArgumentResolver(jwtService);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Bean
|
||||||
|
public WebMvcConfigurer kriCommonWebMvcConfigurer(
|
||||||
|
ObjectProvider<RequestUserContextArgumentResolver> requestUserContextArgumentResolverProvider
|
||||||
|
) {
|
||||||
|
return new WebMvcConfigurer() {
|
||||||
|
@Override
|
||||||
|
public void addCorsMappings(CorsRegistry registry) {
|
||||||
|
registry.addMapping("/**")
|
||||||
|
.allowedOriginPatterns("*")
|
||||||
|
.allowedMethods("*")
|
||||||
|
.allowedHeaders("*")
|
||||||
|
.allowCredentials(true);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void addInterceptors(InterceptorRegistry registry) {
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void addArgumentResolvers(
|
||||||
|
java.util.List<org.springframework.web.method.support.HandlerMethodArgumentResolver> resolvers) {
|
||||||
|
requestUserContextArgumentResolverProvider.ifAvailable(resolvers::add);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void addFormatters(org.springframework.format.FormatterRegistry registry) {
|
||||||
|
registry.addConverterFactory(new CodeEnumConverter());
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,60 +0,0 @@
|
|||||||
package com.kri.common.autoconfigure.webmvc;
|
|
||||||
|
|
||||||
import com.kri.common.feature.auth.jwt.JwtService;
|
|
||||||
import com.kri.common.runtime.webmvc.RequestUserContextArgumentResolver;
|
|
||||||
import lombok.RequiredArgsConstructor;
|
|
||||||
import org.springframework.beans.factory.ObjectProvider;
|
|
||||||
import org.springframework.boot.autoconfigure.AutoConfiguration;
|
|
||||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
|
|
||||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
|
|
||||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
|
|
||||||
import org.springframework.context.annotation.Bean;
|
|
||||||
import org.springframework.web.servlet.config.annotation.CorsRegistry;
|
|
||||||
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
|
|
||||||
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
|
|
||||||
|
|
||||||
@AutoConfiguration
|
|
||||||
@ConditionalOnProperty(name = "kri.webmvc.enabled", matchIfMissing = true)
|
|
||||||
@RequiredArgsConstructor
|
|
||||||
public class KriWebMvcAutoConfiguration {
|
|
||||||
|
|
||||||
@Bean
|
|
||||||
@ConditionalOnBean(JwtService.class)
|
|
||||||
@ConditionalOnMissingBean
|
|
||||||
public RequestUserContextArgumentResolver requestUserContextArgumentResolver(
|
|
||||||
JwtService jwtService
|
|
||||||
) {
|
|
||||||
return new RequestUserContextArgumentResolver(jwtService);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Bean
|
|
||||||
public WebMvcConfigurer kriCommonWebMvcConfigurer(
|
|
||||||
ObjectProvider<RequestUserContextArgumentResolver> requestUserContextArgumentResolverProvider
|
|
||||||
) {
|
|
||||||
return new WebMvcConfigurer() {
|
|
||||||
@Override
|
|
||||||
public void addCorsMappings(CorsRegistry registry) {
|
|
||||||
registry.addMapping("/**")
|
|
||||||
.allowedOriginPatterns("*")
|
|
||||||
.allowedMethods("*")
|
|
||||||
.allowedHeaders("*")
|
|
||||||
.allowCredentials(true);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public void addInterceptors(InterceptorRegistry registry) {
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public void addArgumentResolvers(
|
|
||||||
java.util.List<org.springframework.web.method.support.HandlerMethodArgumentResolver> resolvers) {
|
|
||||||
requestUserContextArgumentResolverProvider.ifAvailable(resolvers::add);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public void addFormatters(org.springframework.format.FormatterRegistry registry) {
|
|
||||||
registry.addConverterFactory(new com.kri.common.runtime.webmvc.CodeEnumConverter());
|
|
||||||
}
|
|
||||||
};
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -3,10 +3,10 @@ package com.kri.common.endpoint.auth.apikey;
|
|||||||
import com.kri.common.autoconfigure.auth.apikey.ApiKeyProperties;
|
import com.kri.common.autoconfigure.auth.apikey.ApiKeyProperties;
|
||||||
import com.kri.common.feature.auth.dto.JwtUserClaimsDto;
|
import com.kri.common.feature.auth.dto.JwtUserClaimsDto;
|
||||||
import com.kri.common.runtime.auth.apikey.PreloadedApiKeyUserClaimsProvider;
|
import com.kri.common.runtime.auth.apikey.PreloadedApiKeyUserClaimsProvider;
|
||||||
|
import com.kri.common.runtime.web.IpUtil;
|
||||||
import jakarta.servlet.http.HttpServletRequest;
|
import jakarta.servlet.http.HttpServletRequest;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Map;
|
import java.util.Map;
|
||||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
|
|
||||||
import org.springframework.http.HttpStatus;
|
import org.springframework.http.HttpStatus;
|
||||||
import org.springframework.security.web.util.matcher.IpAddressMatcher;
|
import org.springframework.security.web.util.matcher.IpAddressMatcher;
|
||||||
import org.springframework.web.bind.annotation.GetMapping;
|
import org.springframework.web.bind.annotation.GetMapping;
|
||||||
@@ -17,7 +17,6 @@ import org.springframework.web.server.ResponseStatusException;
|
|||||||
|
|
||||||
@RestController
|
@RestController
|
||||||
@RequestMapping("/internal/apikey")
|
@RequestMapping("/internal/apikey")
|
||||||
@ConditionalOnProperty(prefix = "kri.auth.apikey", name = "admin-api-enabled", havingValue = "true")
|
|
||||||
public class ApiKeyAdminController {
|
public class ApiKeyAdminController {
|
||||||
|
|
||||||
private final ApiKeyProperties props;
|
private final ApiKeyProperties props;
|
||||||
@@ -53,7 +52,7 @@ public class ApiKeyAdminController {
|
|||||||
if (!props.isAdminApiEnabled()) {
|
if (!props.isAdminApiEnabled()) {
|
||||||
throw new ResponseStatusException(HttpStatus.NOT_FOUND);
|
throw new ResponseStatusException(HttpStatus.NOT_FOUND);
|
||||||
}
|
}
|
||||||
String remote = req.getRemoteAddr();
|
String remote = IpUtil.getClientIp(req);
|
||||||
boolean ok = allow.stream().anyMatch(m -> m.matches(remote));
|
boolean ok = allow.stream().anyMatch(m -> m.matches(remote));
|
||||||
if (!ok) {
|
if (!ok) {
|
||||||
throw new ResponseStatusException(HttpStatus.FORBIDDEN, "IP not allowed: " + remote);
|
throw new ResponseStatusException(HttpStatus.FORBIDDEN, "IP not allowed: " + remote);
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
package com.kri.common.runtime.swagger;
|
package com.kri.common.runtime.swagger;
|
||||||
|
|
||||||
|
import com.kri.common.runtime.web.IpUtil;
|
||||||
import jakarta.servlet.Filter;
|
import jakarta.servlet.Filter;
|
||||||
import jakarta.servlet.FilterChain;
|
import jakarta.servlet.FilterChain;
|
||||||
import jakarta.servlet.ServletException;
|
import jakarta.servlet.ServletException;
|
||||||
@@ -7,13 +8,12 @@ import jakarta.servlet.ServletRequest;
|
|||||||
import jakarta.servlet.ServletResponse;
|
import jakarta.servlet.ServletResponse;
|
||||||
import jakarta.servlet.http.HttpServletRequest;
|
import jakarta.servlet.http.HttpServletRequest;
|
||||||
import jakarta.servlet.http.HttpServletResponse;
|
import jakarta.servlet.http.HttpServletResponse;
|
||||||
import lombok.RequiredArgsConstructor;
|
|
||||||
import lombok.extern.slf4j.Slf4j;
|
|
||||||
|
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
import java.util.HashSet;
|
import java.util.HashSet;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Set;
|
import java.util.Set;
|
||||||
|
import lombok.RequiredArgsConstructor;
|
||||||
|
import lombok.extern.slf4j.Slf4j;
|
||||||
|
|
||||||
@Slf4j
|
@Slf4j
|
||||||
@RequiredArgsConstructor
|
@RequiredArgsConstructor
|
||||||
@@ -24,7 +24,7 @@ public class SwaggerIpFilter implements Filter {
|
|||||||
private static final Set<String> DEFAULT_ALLOWED_IPS = Set.of(
|
private static final Set<String> DEFAULT_ALLOWED_IPS = Set.of(
|
||||||
"127.0.0.1",
|
"127.0.0.1",
|
||||||
"localhost",
|
"localhost",
|
||||||
"0:0:0:0:0:0:0:1" // IPv6 localhost
|
"0:0:0:0:0:0:0:1"
|
||||||
);
|
);
|
||||||
|
|
||||||
public SwaggerIpFilter(List<String> configuredIps) {
|
public SwaggerIpFilter(List<String> configuredIps) {
|
||||||
@@ -42,7 +42,7 @@ public class SwaggerIpFilter implements Filter {
|
|||||||
HttpServletRequest httpRequest = (HttpServletRequest) request;
|
HttpServletRequest httpRequest = (HttpServletRequest) request;
|
||||||
HttpServletResponse httpResponse = (HttpServletResponse) response;
|
HttpServletResponse httpResponse = (HttpServletResponse) response;
|
||||||
|
|
||||||
String clientIp = getClientIp(httpRequest);
|
String clientIp = IpUtil.getClientIp(httpRequest);
|
||||||
|
|
||||||
if (isAllowed(clientIp)) {
|
if (isAllowed(clientIp)) {
|
||||||
chain.doFilter(request, response);
|
chain.doFilter(request, response);
|
||||||
@@ -58,18 +58,15 @@ public class SwaggerIpFilter implements Filter {
|
|||||||
}
|
}
|
||||||
|
|
||||||
private boolean matches(String clientIp, String allowedIp) {
|
private boolean matches(String clientIp, String allowedIp) {
|
||||||
// 정확히 일치하는 경우
|
|
||||||
if (clientIp.equals(allowedIp)) {
|
if (clientIp.equals(allowedIp)) {
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
// localhost 처리
|
|
||||||
if ("localhost".equalsIgnoreCase(allowedIp) &&
|
if ("localhost".equalsIgnoreCase(allowedIp) &&
|
||||||
(clientIp.equals("127.0.0.1") || clientIp.equals("0:0:0:0:0:0:0:1"))) {
|
(clientIp.equals("127.0.0.1") || clientIp.equals("0:0:0:0:0:0:0:1"))) {
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
// CIDR 표기법 지원 (예: 192.168.1.0/24)
|
|
||||||
if (allowedIp.contains("/")) {
|
if (allowedIp.contains("/")) {
|
||||||
return matchesCidr(clientIp, allowedIp);
|
return matchesCidr(clientIp, allowedIp);
|
||||||
}
|
}
|
||||||
@@ -102,30 +99,4 @@ public class SwaggerIpFilter implements Filter {
|
|||||||
}
|
}
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
}
|
||||||
private String getClientIp(HttpServletRequest request) {
|
|
||||||
String ip = request.getHeader("X-Forwarded-For");
|
|
||||||
if (ip == null || ip.isEmpty() || "unknown".equalsIgnoreCase(ip)) {
|
|
||||||
ip = request.getHeader("Proxy-Client-IP");
|
|
||||||
}
|
|
||||||
if (ip == null || ip.isEmpty() || "unknown".equalsIgnoreCase(ip)) {
|
|
||||||
ip = request.getHeader("WL-Proxy-Client-IP");
|
|
||||||
}
|
|
||||||
if (ip == null || ip.isEmpty() || "unknown".equalsIgnoreCase(ip)) {
|
|
||||||
ip = request.getHeader("HTTP_X_FORWARDED_FOR");
|
|
||||||
}
|
|
||||||
if (ip == null || ip.isEmpty() || "unknown".equalsIgnoreCase(ip)) {
|
|
||||||
ip = request.getHeader("HTTP_CLIENT_IP");
|
|
||||||
}
|
|
||||||
if (ip == null || ip.isEmpty() || "unknown".equalsIgnoreCase(ip)) {
|
|
||||||
ip = request.getRemoteAddr();
|
|
||||||
}
|
|
||||||
|
|
||||||
// X-Forwarded-For에 여러 IP가 있을 경우 첫 번째 IP 사용
|
|
||||||
if (ip != null && ip.contains(",")) {
|
|
||||||
ip = ip.split(",")[0].trim();
|
|
||||||
}
|
|
||||||
|
|
||||||
return ip;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
package com.kri.common.runtime.webmvc;
|
package com.kri.common.runtime.web;
|
||||||
|
|
||||||
import com.kri.common.feature.enums.CodeEnum;
|
import com.kri.common.feature.enums.CodeEnum;
|
||||||
import org.springframework.core.convert.converter.Converter;
|
import org.springframework.core.convert.converter.Converter;
|
||||||
35
src/main/java/com/kri/common/runtime/web/IpUtil.java
Normal file
35
src/main/java/com/kri/common/runtime/web/IpUtil.java
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
package com.kri.common.runtime.web;
|
||||||
|
|
||||||
|
import jakarta.servlet.http.HttpServletRequest;
|
||||||
|
|
||||||
|
public final class IpUtil {
|
||||||
|
|
||||||
|
private static final String[] IP_HEADER_CANDIDATES = {
|
||||||
|
"X-Forwarded-For",
|
||||||
|
"X-Real-IP",
|
||||||
|
"Proxy-Client-IP",
|
||||||
|
"WL-Proxy-Client-IP",
|
||||||
|
"HTTP_X_FORWARDED_FOR",
|
||||||
|
"HTTP_CLIENT_IP"
|
||||||
|
};
|
||||||
|
|
||||||
|
private IpUtil() {
|
||||||
|
}
|
||||||
|
|
||||||
|
public static String getClientIp(HttpServletRequest request) {
|
||||||
|
for (String header : IP_HEADER_CANDIDATES) {
|
||||||
|
String ip = request.getHeader(header);
|
||||||
|
if (ip == null || ip.isBlank() || "unknown".equalsIgnoreCase(ip)) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (ip.contains(",")) {
|
||||||
|
return ip.split(",")[0].trim();
|
||||||
|
}
|
||||||
|
|
||||||
|
return ip.trim();
|
||||||
|
}
|
||||||
|
|
||||||
|
return request.getRemoteAddr();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
package com.kri.common.runtime.web;
|
|
||||||
|
|
||||||
import jakarta.servlet.http.HttpServletRequest;
|
|
||||||
import jakarta.servlet.http.HttpServletResponse;
|
|
||||||
import org.slf4j.MDC;
|
|
||||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
|
|
||||||
import org.springframework.context.annotation.Configuration;
|
|
||||||
import org.springframework.context.annotation.Bean;
|
|
||||||
import org.springframework.web.method.HandlerMethod;
|
|
||||||
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
|
|
||||||
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
|
|
||||||
|
|
||||||
@Configuration(proxyBeanMethods = false)
|
|
||||||
@ConditionalOnExpression("${kri.web.mdc.enabled:true}")
|
|
||||||
public class MdcHandlerConfig {
|
|
||||||
|
|
||||||
@Bean
|
|
||||||
public WebMvcConfigurer mdcWebMvcConfigurer() {
|
|
||||||
return new WebMvcConfigurer() {
|
|
||||||
@Override
|
|
||||||
public void addInterceptors(InterceptorRegistry registry) {
|
|
||||||
registry.addInterceptor(new org.springframework.web.servlet.HandlerInterceptor() {
|
|
||||||
@Override
|
|
||||||
public boolean preHandle(HttpServletRequest req, HttpServletResponse res,
|
|
||||||
Object handler) {
|
|
||||||
if (handler instanceof HandlerMethod hm) {
|
|
||||||
String ctrl = hm.getBeanType().getSimpleName(); // ex) ContactController
|
|
||||||
String method = hm.getMethod().getName(); // ex) create
|
|
||||||
MDC.put("handler", ctrl + "#" + method); // ex) ContactController#create
|
|
||||||
}
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public void afterCompletion(HttpServletRequest req, HttpServletResponse res,
|
|
||||||
Object handler, Exception ex) {
|
|
||||||
MDC.remove("handler");
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
};
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
package com.kri.common.runtime.webmvc;
|
package com.kri.common.runtime.web;
|
||||||
|
|
||||||
import com.kri.common.feature.auth.dto.JwtUserClaimsDto;
|
import com.kri.common.feature.auth.dto.JwtUserClaimsDto;
|
||||||
import com.kri.common.feature.auth.jwt.JwtService;
|
import com.kri.common.feature.auth.jwt.JwtService;
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
package com.kri.common.runtime.webmvc;
|
|
||||||
|
|
||||||
import jakarta.servlet.http.HttpServletRequest;
|
|
||||||
|
|
||||||
public final class IpUtil {
|
|
||||||
|
|
||||||
private IpUtil() {
|
|
||||||
}
|
|
||||||
|
|
||||||
public static String getClientIp(HttpServletRequest request) {
|
|
||||||
// 1. Proxy 환경 고려: X-Forwarded-For 헤더 우선
|
|
||||||
String xff = request.getHeader("X-Forwarded-For");
|
|
||||||
if (xff != null && !xff.isBlank()) {
|
|
||||||
// X-Forwarded-For: client, proxy1, proxy2 ...
|
|
||||||
return xff.split(",")[0].trim();
|
|
||||||
}
|
|
||||||
|
|
||||||
// 2. 그 다음 X-Real-IP
|
|
||||||
String realIp = request.getHeader("X-Real-IP");
|
|
||||||
if (realIp != null && !realIp.isBlank()) {
|
|
||||||
return realIp;
|
|
||||||
}
|
|
||||||
|
|
||||||
// 3. 최후 fallback
|
|
||||||
return request.getRemoteAddr();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -5,7 +5,6 @@ com.kri.common.autoconfigure.auth.apikey.ApiKeyAdminAutoConfiguration
|
|||||||
|
|
||||||
com.kri.common.autoconfigure.security.KriSecurityAutoConfiguration
|
com.kri.common.autoconfigure.security.KriSecurityAutoConfiguration
|
||||||
com.kri.common.autoconfigure.web.CommonWebAutoConfiguration
|
com.kri.common.autoconfigure.web.CommonWebAutoConfiguration
|
||||||
com.kri.common.autoconfigure.webmvc.KriWebMvcAutoConfiguration
|
|
||||||
com.kri.common.autoconfigure.swagger.KriSwaggerAutoConfiguration
|
com.kri.common.autoconfigure.swagger.KriSwaggerAutoConfiguration
|
||||||
com.kri.common.autoconfigure.redis.CommonRedisAutoConfiguration
|
com.kri.common.autoconfigure.redis.CommonRedisAutoConfiguration
|
||||||
com.kri.common.autoconfigure.scheduling.CommonSchedulingAutoConfiguration
|
com.kri.common.autoconfigure.scheduling.CommonSchedulingAutoConfiguration
|
||||||
|
|||||||
Reference in New Issue
Block a user