Merge pull request #149 from dromara/dev

Dev

Author: lijiahangmax

.env.example

@@ -6,6 +6,7 @@ SPRING_PROFILES_ACTIVE=prod
 DEMO_MODE=false
 
 API_CORS=true
+API_IP_HEADERS=X-Forwarded-For,X-Real-IP
 API_EXPOSE_TOKEN=pmqeHOyZaumHm0Wt
 SECRET_KEY=uQeacXV8b3isvKLK
 

docker-compose.yaml

@@ -1,6 +1,6 @@
 version: '3.3'
 
-# latest = 2.5.4
+# latest = 2.5.5
 
 # 支持以下源
 # lijiahangmax/*
@@ -49,6 +49,7 @@ services:
       GUACD_DRIVE_PATH: ${GUACD_DRIVE_PATH:-/drive}
       SECRET_KEY: ${SECRET_KEY:-uQeacXV8b3isvKLK}
       API_EXPOSE_TOKEN: ${API_EXPOSE_TOKEN:-pmqeHOyZaumHm0Wt}
+      API_IP_HEADERS: ${API_IP_HEADERS:-X-Forwarded-For,X-Real-IP}
       API_CORS: ${API_CORS:-true}
       DEMO_MODE: ${DEMO_MODE:-false}
     volumes:

docker/docker-build.sh

@@ -7,7 +7,7 @@ set -e
 source ./project-build.sh "$@"
 
 # 版本号
-version=2.5.4
+version=2.5.5
 # 是否推送镜像
 push_image=false
 # 是否构建 latest

docker/project-build.sh

@@ -4,7 +4,7 @@ set -e
 # DockerContext: orion-visor
 
 # 版本号
-version=2.5.4
+version=2.5.5
 # 是否构建 service
 export build_service=false
 # 是否构建 ui

orion-visor-common/src/main/java/org/dromara/visor/common/configuration/CommonConfiguration.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2023 - present Dromara, All rights reserved.
+ *
+ *   https://visor.dromara.org
+ *   https://visor.dromara.org.cn
+ *   https://visor.orionsec.cn
+ *
+ * Members:
+ *   Jiahang Li - ljh1553488six@139.com - author
+ *
+ * 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
+ *
+ *   http://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.dromara.visor.common.configuration;
+
+import lombok.extern.slf4j.Slf4j;
+import org.dromara.visor.common.utils.IpUtils;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Configuration;
+
+import javax.annotation.PostConstruct;
+
+/**
+ * 公共配置类
+ *
+ * @author Jiahang Li
+ * @version 1.0.0
+ * @since 2023/6/20 10:34
+ */
+@Slf4j
+@Configuration
+public class CommonConfiguration {
+
+    @Value("${orion.api.ip-headers}")
+    private String[] ipHeaders;
+
+    /**
+     * 设置 IP 请求头
+     */
+    @PostConstruct
+    public void setIpHeader() {
+        IpUtils.setIpHeader(ipHeaders);
+        log.info("IpUtils.setIpHeader {}", String.join(",", ipHeaders));
+    }
+
+}

orion-visor-common/src/main/java/org/dromara/visor/common/constant/AppConst.java

@@ -36,7 +36,7 @@ public interface AppConst extends OrionConst {
     /**
      * 同 ${orion.version} 迭代时候需要手动更改
      */
-    String VERSION = "2.5.4";
+    String VERSION = "2.5.5";
 
     /**
      * 同 ${spring.application.name}

orion-visor-common/src/main/java/org/dromara/visor/common/entity/RequestIdentity.java

@@ -33,6 +33,20 @@
  */
 public interface RequestIdentity extends Serializable {
 
+    /**
+     * 获取请求时间戳
+     *
+     * @return timestamp
+     */
+    Long getTimestamp();
+
+    /**
+     * 设置请求时间戳
+     *
+     * @param timestamp timestamp
+     */
+    void setTimestamp(Long timestamp);
+
     /**
      * 获取请求地址
      *

orion-visor-common/src/main/java/org/dromara/visor/common/entity/RequestIdentityModel.java

@@ -23,7 +23,10 @@
 package org.dromara.visor.common.entity;
 
 import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
 import lombok.Data;
+import lombok.NoArgsConstructor;
 
 /**
  * 请求留痕模型
@@ -33,9 +36,15 @@
  * @since 2023/12/29 11:57
  */
 @Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
 @Schema(name = "RequestIdentityModel", description = "请求留痕模型")
 public class RequestIdentityModel implements RequestIdentity {
 
+    @Schema(description = "时间戳")
+    private Long timestamp;
+
     @Schema(description = "请求地址")
     private String address;
 

orion-visor-common/src/main/java/org/dromara/visor/common/mapstruct/DateConversion.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright (c) 2023 - present Dromara, All rights reserved.
+ *
+ *   https://visor.dromara.org
+ *   https://visor.dromara.org.cn
+ *   https://visor.orionsec.cn
+ *
+ * Members:
+ *   Jiahang Li - ljh1553488six@139.com - author
+ *
+ * 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
+ *
+ *   http://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.dromara.visor.common.mapstruct;
+
+import java.util.Date;
+
+/**
+ * date 转换器
+ *
+ * @author Jiahang Li
+ * @version 1.0.0
+ * @since 2025/3/7 17:43
+ */
+public class DateConversion {
+
+    private DateConversion() {
+    }
+
+    /**
+     * Long > Date
+     *
+     * @param timestamp timestamp
+     * @return Date
+     */
+    public static Date longToDate(Long timestamp) {
+        return timestamp != null ? new Date(timestamp) : null;
+    }
+
+    /**
+     * Date > Long
+     *
+     * @param date date
+     * @return Long
+     */
+    public static Long dateToLong(Date date) {
+        return date != null ? date.getTime() : null;
+    }
+
+}

orion-visor-common/src/main/java/org/dromara/visor/common/utils/IpUtils.java

@@ -24,7 +24,7 @@
 
 import cn.orionsec.kit.ext.location.Region;
 import cn.orionsec.kit.ext.location.region.LocationRegions;
-import cn.orionsec.kit.web.servlet.web.Servlets;
+import cn.orionsec.kit.lang.utils.net.IPs;
 import org.dromara.visor.common.constant.Const;
 
 import javax.servlet.http.HttpServletRequest;
@@ -40,6 +40,8 @@
  */
 public class IpUtils {
 
+    private static String[] IP_HEADER = new String[]{"X-Forwarded-For", "X-Real-IP"};
+
     private static final Map<String, String> CACHE = new HashMap<>();
 
     private IpUtils() {
@@ -52,13 +54,17 @@ private IpUtils() {
      * @return addr
      */
     public static String getRemoteAddr(HttpServletRequest request) {
-        // 获取实际地址 X_REAL_IP 在多代理情况下会有问题
-        // String realIp = request.getHeader(StandardHttpHeader.X_REAL_IP);
-        // if (!Strings.isBlank(realIp)) {
-        //     return realIp;
-        // }
-        // 获取请求地址
-        return Servlets.getRemoteAddr(request);
+        if (request == null) {
+            return null;
+        } else {
+            for (String remoteAddrHeader : IP_HEADER) {
+                String addr = checkIpHeader(request.getHeader(remoteAddrHeader));
+                if (addr != null) {
+                    return addr;
+                }
+            }
+            return checkIpHeader(request.getRemoteAddr());
+        }
     }
 
     /**
@@ -112,4 +118,23 @@ private static String queryLocation(String ip) {
         return Const.CN_UNKNOWN;
     }
 
+    /**
+     * 检查 ip 请求头
+     *
+     * @param headerValue headerValue
+     * @return header
+     */
+    private static String checkIpHeader(String headerValue) {
+        if (headerValue == null) {
+            return null;
+        } else {
+            headerValue = headerValue.split(",")[0];
+            return IPs.checkIp(headerValue);
+        }
+    }
+
+    public static void setIpHeader(String[] ipHeader) {
+        IP_HEADER = ipHeader;
+    }
+
 }