260320_01_ENH: 스웨거 허용 IP 필터 추가
This commit is contained in:
@@ -13,6 +13,7 @@ import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
|
||||
import org.springframework.boot.context.properties.EnableConfigurationProperties;
|
||||
import org.springframework.boot.web.servlet.FilterRegistrationBean;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
|
||||
@AutoConfiguration
|
||||
@@ -74,4 +75,15 @@ public class KriSwaggerAutoConfiguration {
|
||||
|
||||
return builder.build();
|
||||
}
|
||||
|
||||
@Bean
|
||||
@ConditionalOnMissingBean(name = "swaggerIpFilter")
|
||||
public FilterRegistrationBean<SwaggerIpFilter> swaggerIpFilter() {
|
||||
FilterRegistrationBean<SwaggerIpFilter> registrationBean = new FilterRegistrationBean<>();
|
||||
registrationBean.setFilter(new SwaggerIpFilter(properties.getAllowedIps()));
|
||||
registrationBean.addUrlPatterns("/swagger-ui/*", "/v3/api-docs/*", "/swagger-ui.html");
|
||||
registrationBean.setName("swaggerIpFilter");
|
||||
registrationBean.setOrder(1);
|
||||
return registrationBean;
|
||||
}
|
||||
}
|
||||
@@ -4,6 +4,9 @@ import lombok.Getter;
|
||||
import lombok.Setter;
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
@Getter
|
||||
@Setter
|
||||
@ConfigurationProperties(prefix = "kri.swagger")
|
||||
@@ -19,4 +22,9 @@ public class KriSwaggerProperties {
|
||||
* 문서화할 base package (null 이면 전체)
|
||||
*/
|
||||
private String basePackage;
|
||||
|
||||
/**
|
||||
* Swagger 접근 허용 IP 목록 (127.0.0.1, localhost, 0:0:0:0:0:0:0:1은 기본 허용)
|
||||
*/
|
||||
private List<String> allowedIps = new ArrayList<>();
|
||||
}
|
||||
|
||||
131
src/main/java/com/kri/common/swagger/SwaggerIpFilter.java
Normal file
131
src/main/java/com/kri/common/swagger/SwaggerIpFilter.java
Normal file
@@ -0,0 +1,131 @@
|
||||
package com.kri.common.swagger;
|
||||
|
||||
import jakarta.servlet.Filter;
|
||||
import jakarta.servlet.FilterChain;
|
||||
import jakarta.servlet.ServletException;
|
||||
import jakarta.servlet.ServletRequest;
|
||||
import jakarta.servlet.ServletResponse;
|
||||
import jakarta.servlet.http.HttpServletRequest;
|
||||
import jakarta.servlet.http.HttpServletResponse;
|
||||
import lombok.RequiredArgsConstructor;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.util.HashSet;
|
||||
import java.util.List;
|
||||
import java.util.Set;
|
||||
|
||||
@Slf4j
|
||||
@RequiredArgsConstructor
|
||||
public class SwaggerIpFilter implements Filter {
|
||||
|
||||
private final Set<String> allowedIps;
|
||||
|
||||
private static final Set<String> DEFAULT_ALLOWED_IPS = Set.of(
|
||||
"127.0.0.1",
|
||||
"localhost",
|
||||
"0:0:0:0:0:0:0:1" // IPv6 localhost
|
||||
);
|
||||
|
||||
public SwaggerIpFilter(List<String> configuredIps) {
|
||||
this.allowedIps = new HashSet<>(DEFAULT_ALLOWED_IPS);
|
||||
if (configuredIps != null && !configuredIps.isEmpty()) {
|
||||
this.allowedIps.addAll(configuredIps);
|
||||
}
|
||||
log.info("Swagger IP Filter initialized. Allowed IPs: {}", this.allowedIps);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
|
||||
throws IOException, ServletException {
|
||||
|
||||
HttpServletRequest httpRequest = (HttpServletRequest) request;
|
||||
HttpServletResponse httpResponse = (HttpServletResponse) response;
|
||||
|
||||
String clientIp = getClientIp(httpRequest);
|
||||
|
||||
if (isAllowed(clientIp)) {
|
||||
chain.doFilter(request, response);
|
||||
} else {
|
||||
log.warn("Swagger access denied for IP: {}", clientIp);
|
||||
httpResponse.setStatus(HttpServletResponse.SC_FORBIDDEN);
|
||||
httpResponse.getWriter().write("Access denied: Your IP is not allowed to access Swagger UI");
|
||||
}
|
||||
}
|
||||
|
||||
private boolean isAllowed(String clientIp) {
|
||||
return allowedIps.stream().anyMatch(allowed -> matches(clientIp, allowed));
|
||||
}
|
||||
|
||||
private boolean matches(String clientIp, String allowedIp) {
|
||||
// 정확히 일치하는 경우
|
||||
if (clientIp.equals(allowedIp)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
// localhost 처리
|
||||
if ("localhost".equalsIgnoreCase(allowedIp) &&
|
||||
(clientIp.equals("127.0.0.1") || clientIp.equals("0:0:0:0:0:0:0:1"))) {
|
||||
return true;
|
||||
}
|
||||
|
||||
// CIDR 표기법 지원 (예: 192.168.1.0/24)
|
||||
if (allowedIp.contains("/")) {
|
||||
return matchesCidr(clientIp, allowedIp);
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
private boolean matchesCidr(String clientIp, String cidr) {
|
||||
try {
|
||||
String[] parts = cidr.split("/");
|
||||
String network = parts[0];
|
||||
int prefixLength = Integer.parseInt(parts[1]);
|
||||
|
||||
long ipLong = ipToLong(clientIp);
|
||||
long networkLong = ipToLong(network);
|
||||
long mask = -1L << (32 - prefixLength);
|
||||
|
||||
return (ipLong & mask) == (networkLong & mask);
|
||||
} catch (Exception e) {
|
||||
log.warn("Failed to parse CIDR: {}", cidr, e);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
private long ipToLong(String ip) {
|
||||
String[] octets = ip.split("\\.");
|
||||
long result = 0;
|
||||
for (int i = 0; i < 4; i++) {
|
||||
result |= (Long.parseLong(octets[i]) << (24 - (8 * i)));
|
||||
}
|
||||
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;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user