增加FTP服务

doc-admin/src/main/resources/application-dev.yml

@@ -105,5 +105,5 @@ spring:
 # 日志配置
 logging:
   level:
-    com.doc: debug
-    org.springframework: warn
+    com.doc: info
+    org.springframework: info

doc-admin/src/main/resources/application.yml

@@ -62,6 +62,11 @@ token:
   soloLogin: false
   # 请求有效时间（秒）
   requestTime: 5
+#内置FTP配置
+ftp:
+  enable: true
+  port: 60021
+  passivePorts: 64000-64050
 
 # MyBatis配置
 mybatis-plus:

doc-biz/pom.xml

@@ -24,6 +24,24 @@
             <!-- 请到https://search.maven.org/search?q=tencentcloud-sdk-java查询所有版本，最新版本如下 -->
             <version>3.1.899</version>
         </dependency>
+        <!--这些只是apache ftp server相关的依赖，springboot项目本身的依赖大家自己添加即可-->
+        <dependency>
+            <groupId>org.apache.ftpserver</groupId>
+            <artifactId>ftpserver-core</artifactId>
+            <version>1.2.0</version>
+        </dependency>
+
+<!--        <dependency>-->
+<!--            <groupId>org.apache.ftpserver</groupId>-->
+<!--            <artifactId>ftplet-api</artifactId>-->
+<!--            <version>1.2.0</version>-->
+<!--        </dependency>-->
+        <dependency>
+            <groupId>org.apache.mina</groupId>
+            <artifactId>mina-core</artifactId>
+            <version>2.2.1</version>
+        </dependency>
+        <!--apache ftp server end-->
         <!-- 通用工具-->
         <dependency>
             <groupId>com.jjt</groupId>

doc-biz/src/main/java/com/doc/ftp/DocFtpServer.java

@@ -0,0 +1,155 @@
+package com.doc.ftp;
+
+import org.apache.ftpserver.DataConnectionConfigurationFactory;
+import org.apache.ftpserver.FtpServer;
+import org.apache.ftpserver.FtpServerFactory;
+import org.apache.ftpserver.ftplet.FtpException;
+import org.apache.ftpserver.listener.Listener;
+import org.apache.ftpserver.listener.ListenerFactory;
+import org.apache.ftpserver.usermanager.ClearTextPasswordEncryptor;
+import org.apache.ftpserver.usermanager.DbUserManagerFactory;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.core.env.Environment;
+import org.springframework.stereotype.Component;
+
+import javax.annotation.PostConstruct;
+import javax.annotation.PreDestroy;
+import javax.annotation.Resource;
+import javax.sql.DataSource;
+
+/**
+ * 注意：被@Configuration标记的类会被加入ioc容器中，而且类中所有带 @Bean注解的方法都会被动态代理，因此调用该方法返回的都是同一个实例。
+ * ftp服务访问地址：
+ * ftp://localhost:3131/
+ *
+ * @author wukai
+ */
+@Component
+public class DocFtpServer {
+    private static final Logger logger = LoggerFactory.getLogger(DocFtpServer.class);
+    @Resource
+    private DataSource dataSource;
+    @Resource
+    private Environment environment;
+
+    protected FtpServer server;
+
+    /**
+     * 利用spring加载@Configuration的特性来完成ftp server的初始化
+     * <p>
+     * //     * @param dataSource 数据源
+     */
+    public DocFtpServer(DataSource dataSource, Environment environment) {
+        this.dataSource = dataSource;
+        this.environment = environment;
+        initFtp();
+        logger.info("Apache ftp server 实例化完成!");
+    }
+
+    /**
+     * ftp 服务器初始化
+     */
+    public void initFtp() {
+        if (enable()) {
+            int port = Integer.parseInt(environment.getProperty("ftp.port"));
+            String passivePorts = environment.getProperty("ftp.passivePorts");
+            System.err.println();
+            FtpServerFactory serverFactory = new FtpServerFactory();
+            ListenerFactory listenerFactory = new ListenerFactory();
+            //1、设置服务端口
+            listenerFactory.setPort(port);
+            //2、设置被动模式数据上传的接口范围,云服务器需要开放对应区间的端口给客户端
+            DataConnectionConfigurationFactory dataConnectionConfFactory = new DataConnectionConfigurationFactory();
+            dataConnectionConfFactory.setPassivePorts(passivePorts);
+            listenerFactory.setDataConnectionConfiguration(dataConnectionConfFactory.createDataConnectionConfiguration());
+            //3、增加SSL安全配置
+//        SslConfigurationFactory ssl = new SslConfigurationFactory();
+//        ssl.setKeystoreFile(new File("src/main/resources/ftpserver.jks"));
+//        ssl.setKeystorePassword("password");
+            //ssl.setSslProtocol("SSL");
+            // set the SSL configuration for the listener
+//        listenerFactory.setSslConfiguration(ssl.createSslConfiguration());
+//        listenerFactory.setImplicitSsl(true);
+            //4、替换默认的监听器
+            Listener listener = listenerFactory.createListener();
+            serverFactory.addListener("default", listener);
+            //5、配置自定义用户事件
+//        Map<String, Ftplet> ftpLets = new HashMap();
+//        ftpLets.put("ftpService", new MyFtpPlet());
+//        serverFactory.setFtplets(ftpLets);
+            //6、读取用户的配置信息
+            //注意：配置文件位于resources目录下，如果项目使用内置容器打成jar包发布，FTPServer无法直接直接读取Jar包中的配置文件。
+            //解决办法：将文件复制到指定目录(本文指定到根目录)下然后FTPServer才能读取到。
+//        PropertiesUserManagerFactory userManagerFactory = new PropertiesUserManagerFactory();
+//        String tempPath = System.getProperty("java.io.tmpdir") + System.currentTimeMillis() + ".properties";
+//        File tempConfig = new File(tempPath);
+//        ClassPathResource resource = new ClassPathResource("users.properties");
+//        IOUtils.copy(resource.getInputStream(), new FileOutputStream(tempConfig));
+//        userManagerFactory.setFile(tempConfig);
+//        userManagerFactory.setPasswordEncryptor(new ClearTextPasswordEncryptor());  //密码以明文的方式
+//        serverFactory.setUserManager(userManagerFactory.createUserManager());
+            //6.2、基于数据库来存储用户实例
+            DbUserManagerFactory factory = new DbUserManagerFactory();
+            factory.setDataSource(dataSource);
+            factory.setAdminName("admin");
+            factory.setSqlUserAdmin("SELECT userid FROM FTP_USER WHERE userid='{userid}' AND userid='admin'");
+            factory.setSqlUserInsert("INSERT INTO FTP_USER (userid, userpassword, homedirectory, " +
+                    "enableflag, writepermission, idletime, uploadrate, downloadrate) VALUES " +
+                    "('{userid}', '{userpassword}', '{homedirectory}', {enableflag}, " +
+                    "{writepermission}, {idletime}, uploadrate}, {downloadrate})");
+            factory.setSqlUserDelete("DELETE FROM FTP_USER WHERE userid = '{userid}'");
+            factory.setSqlUserUpdate("UPDATE FTP_USER SET userpassword='{userpassword}',homedirectory='{homedirectory}',enableflag={enableflag},writepermission={writepermission},idletime={idletime},uploadrate={uploadrate},downloadrate={downloadrate},maxloginnumber={maxloginnumber}, maxloginperip={maxloginperip} WHERE userid='{userid}'");
+            factory.setSqlUserSelect("SELECT * FROM FTP_USER WHERE userid = '{userid}'");
+            factory.setSqlUserSelectAll("SELECT userid FROM FTP_USER ORDER BY userid");
+            factory.setSqlUserAuthenticate("SELECT userid, userpassword FROM FTP_USER WHERE userid='{userid}'");
+            factory.setPasswordEncryptor(new Sm3Ftp());
+            serverFactory.setUserManager(factory.createUserManager());
+            //7、实例化FTP Server
+            server = serverFactory.createServer();
+        }
+    }
+
+
+    /**
+     * ftp server start
+     * PostConstruct 跟随容器启动执行
+     */
+    @PostConstruct
+    public void start() {
+        if (enable()) {
+            try {
+                server.start();
+                logger.info("Apache Ftp server 已启动!");
+            } catch (FtpException e) {
+                e.printStackTrace();
+            }
+        }
+    }
+
+
+    /**
+     * ftp server stop
+     * PreDestroy 跟随容器关闭执行
+     */
+    @PreDestroy
+    public void stop() {
+        if (enable()) {
+            server.stop();
+            logger.info("Apache Ftp server 已关闭!");
+        }
+    }
+
+    private boolean enable() {
+        String trueStr = "true";
+        return trueStr.equals(environment.getProperty("ftp.enable"));
+    }
+
+    public static void main(String[] args) {
+        ClearTextPasswordEncryptor encryptor = new ClearTextPasswordEncryptor();
+
+        String s = encryptor.encrypt("123456");
+        System.err.println(s);
+    }
+
+}

doc-biz/src/main/java/com/doc/ftp/Sm3Ftp.java

@@ -0,0 +1,23 @@
+package com.doc.ftp;
+
+import com.doc.common.utils.encrypt.Sm3Util;
+import org.apache.ftpserver.usermanager.PasswordEncryptor;
+
+/**
+ * FTP专用密码存储
+ *
+ * @author wukai
+ * @date 2023/11/27 20:54
+ */
+public class Sm3Ftp implements PasswordEncryptor {
+
+    @Override
+    public String encrypt(String s) {
+        return Sm3Util.encrypt(s);
+    }
+
+    @Override
+    public boolean matches(String passwordToCheck, String storedPassword) {
+        return storedPassword.equals(Sm3Util.encrypt(passwordToCheck));
+    }
+}