记录一次SFTP文件上传异常

末蓝、 2024-04-22 19:23 74阅读 0赞

**目录**

一、异常展示

1.1.日志报错

1.2.nacos中SFTP参数配置

二、bug溯源

2.1.本地代码排查

2.1.1.核心代码展示

2.1.2.补充说明

2.2.本地测试

2.3.服务器测试

2.4.SFTP排查

2.4.1.SFTP访问权限排查

2.4.2.SFTP展示权限排查

三、SFTP配置文件权限说明

四、liunx权限说明

--------------------

## 一、异常展示 ##

### 1.1.日志报错 ###

![cba328d1db434146a313aedc8d2b6359.png][]

### 1.2.nacos中SFTP参数配置 ###

![e10b55ae7ab14f228709efbbeb9a64c6.png][]

上周客户反应，本地文件生成后，在上传文件时创建SFTP目录时失败，既然有问题，那就找呗，毕竟工作不就是创造bug和解决bug么。**由异常报错可知，文件是在上传时，创建SFTP目录时失败，而SFTP的目录是 /1001\*\*\*\*\*\*\*\*\*\*23/，下面记录一下解决问题的思路。**

## 二、bug溯源 ##

### 2.1.本地代码排查 ###

#### 2.1.1.核心代码展示 ####

public void upload1(String directory,String name, String sftpFileName, InputStream input) throws SftpException {
    		try {
    			//创建一级目录
    			sftp.cd(directory);
    		} catch (SftpException e) {
    			logger.warn("directory is not exist:1级目录"+directory);
    			//创建多级目录
    			createDir(directory,sftp);
    			sftp.cd(directory);
    		}
    		//创建2级目录
    		try {
    			sftp.cd(directory+name);
    		} catch (Exception e) {
    			logger.warn("directory is not exist:2级目录"+directory+name);
    			sftp.mkdir(directory+name);
    			sftp.cd(directory+name);
    		}
    		
    		sftp.put(input, sftpFileName);
    		logger.info("file:{} is upload successful", sftpFileName);
    	}
    
    	
    	/**
    	 * 创建一个文件目录
    	 */
    	public void createDir(String createpath, ChannelSftp sftp) {
    		try {
    			if (isDirExist(createpath)) {
    				this.sftp.cd(createpath);
    				return;
    			}
    			String pathArry[] = createpath.split("/");
    			StringBuffer filePath = new StringBuffer("/");
    			for (String path : pathArry) {
    				if ("".equals(path)) {
    					continue;
    				}
    				filePath.append(path + "/");
    				if (isDirExist(filePath.toString())) {
    					sftp.cd(filePath.toString());
    				} else {
    					// 建立目录
    					sftp.mkdir(filePath.toString());
    					// 进入并设置为当前目录
    					sftp.cd(filePath.toString());
    				}
    			}
    			this.sftp.cd(createpath);
    		} catch (SftpException e) {
    			logger.error("创建路径错误："+createpath);
    		}
    	}
    
    	/**
    	 * 判断目录是否存在
    	 */
    	public boolean isDirExist(String directory) {
    		boolean isDirExistFlag = false;
    		try {
    			SftpATTRS sftpATTRS = sftp.lstat(directory);
    			isDirExistFlag = true;
    			return sftpATTRS.isDir();
    		} catch (Exception e) {
    			if ("no such file".equals(e.getMessage().toLowerCase())) {
    				isDirExistFlag = false;
    			}
    		}
    		return isDirExistFlag;
    	}

由客户的日志反馈可知，是upload1方法在创建一级目录时失败，上面是创建一级目录的代码。

#### 2.1.2.补充说明 ####

本地目录创建和SFTP目录创建是不一样的，本地可以一次性创建多级目录，详情请看[本地多级目录创建][Link 1] ，可以直接用mkdirs()方法进行创建多级目录。而SFTP不一样，SFTP没有这个方法，只能用mkdir()方法一级一级创建，具体展示如下：

![043b961a15fd47ddb7c91b8248d6df7f.png][]

### 2.2.本地测试 ###

在排查错误时，除了明显的编写错误以外，别的错误都是不好直接看出来的。所以我们在寻找错误的过程中，Debug是最常用的方法，这里没有上传视频，看图片也差不多的。

![970c1bb56b0b4b068446b9eea4a6fd1c.png][]

截止到这里，符合图片中的日志打印

![0cf05a538b574175aeb37b54c070d666.png][]

进一步Debug发现，创建多级目录正常，并无报错。

根据本地 Debug 寻找，发现文件目录正常创建，并没有报错。**没报错说明代码的设计是没有问题的，那就需要找系统的问题了。系统方面包含两方面，一方面是本地系统异常，包含白名单和登录失败等问题；一方面是客户SFTP服务器异常，包含创建目录权限限制和SFTP系统配置等。**

### 2.3.服务器测试 ###

![3220de43eae04a65aebe6892a0fc3ae2.png][]

这个是用测试服务器和测试SFTP运行的程序，我通过一次性创建5级目录 /1000066666/ICBCRecon/01/02/03/200028029321208/ ，进一步验证了不是代码的问题，同时，我们联系客户，也确认了是**①服务器和SFTP之间是不需要添加白名单的，②登录是可以正常登录，③生产环境在访问SFTP时，SFTP的端口也是经过服务器防火墙放行的**，这个流程就不做记录了。

### 2.4.SFTP排查 ###

#### 2.4.1.SFTP访问权限排查 ####

由上述排查可知，程序是可以正常创建多级目录的，那么代码bug的几率就很小了。检查SFTP创建目录的权限。

用nacos 中配置的SFTP用户登录SFTP，并且在 **/1001\*\*\*\*\*\*\*\*\*\*23/** 目录的上一层创建 test 目录，发现报的是没有权限。

![f9c2fc11adcc40bdabd67bf7777a9bc6.png][]

然后在 **/1001\*\*\*\*\*\*\*\*\*\*23/** 目录的下一层创建 test 目录，发现是可以创建的。

![792114022cfc4b2c9000e736e6f3b3a8.png][]

由上述操作可知，当用指定用户创建目录时，权限是没问题的。代码没问题，权限没问题，那就要看SFTP配置问题了。

#### 2.4.2.SFTP展示权限排查 ####

从上图可以看到，当前目录是 /data/sftpsite/szfs/1001001001000023/ ，与nacos配置相比，多出来了 /data/sftpsite/szfs/ ，那么就有可能是SFTP目录权限的问题，具体还需要验证。

寻找SFTP的ssh配置文件，文件路径 /etc/ssh/sshd\_config ，可以看到：

![4f226bf09a45420dbc5cad4c31d7ed1c.png][]

左边是当前SSH配置文件，文件为初始化配置文件，并没有对目录进行权限限制，右边是应该有的权限配置。

![b63fed5ef55c4cf8a12e5ad94c0e020f.png][]

从系统的历史操作可以看到 ，在2023年11月22日，配置文件被修改过，所以系统原有的配置操作被初始化掉了，造成了突然的创建目录异常。

**根据配置文件可知，原本添加的权限限制都没了，所以这个时候，nacos 配置的路径就应该是系统全路径，也就是系统绝对路径 ，只配置相对路径是访问不到SFTP目录的，所以才会创建目录失败。**

**所以解决bug有两种操作，一是将权限添加上，然后系统还访问相对路径；一是不添加权限，系统访问绝对路径。**

## 三、SFTP配置文件权限说明 ##

在一般情况下，用户登录上SFTP以后，看到的目录结构都是相对路径，也就是说是经过限制的路径，而非从系统的根路径开始展示，那么合理的添加限制有哪些作用呢?

在SFTP的配置文件/etc/ssh/sshd\_config中添加用户访问权限，可以带来以下几个好处：

1.  **安全性增强**：通过设置正确的用户访问权限，可以限制哪些用户可以访问特定的目录或文件，从而提高系统的安全性。
2.  **灵活性增加**：可以针对不同的用户或用户组设置不同的访问权限，提供更加灵活的文件访问控制。
3.  **资源管理优化**：通过合理的权限设置，可以更好地管理和分配系统资源，避免资源的浪费或过度使用。
4.  **审计和监控**：对于有权限访问敏感信息的用户，可以实施更严格的审计和监控措施，确保系统的合规性和安全性。

## 四、liunx权限说明 ##

我上面在2.4.1进行访问权限排查时，是直接用工具进行目录创建测试，而在Linux中，实际上是不需要创建，只看文件就行，具体操作如下：

在Linux系统中，您可以使用`ls -l`命令来查看文件操作权限。这个命令会以长格式列出文件和目录的信息，包括权限、所有者、所属组和其他属性。

以下是使用`ls -l`命令的示例：

ls -l filename

其中，"filename"是您要查看权限的文件或目录的名称。执行该命令后，将显示类似于以下的结果：

-rw-r--r-- 1 user group 1234 Oct 23 10:00 filename

您还可以使用 ll 命令来查看文件操作权限，它是`ls -l`命令的别名。在终端中输入`ll`命令即可：在这个例子中，文件权限被表示为"-rw-r--r--"。这些字符按照三个一组划分，分别代表所有者、所属组和其他用户的权限。每组的三个字符分别表示读（r）、写（w）和执行（x）权限。如果权限被拒绝，则表示为"-"。

ll filename

这将以长格式列出文件或目录的详细信息，包括权限、所有者、所属组和其他属性。SFTP查看示例如下：

![f1956b3ba5344588be631c6abebaf7bf.png][]

[cba328d1db434146a313aedc8d2b6359.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/e91e2828190c4a51a171f00431bb1c8b.png
[e10b55ae7ab14f228709efbbeb9a64c6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/75f3b2ca48234865846e87b2b1b1bca9.png
[Link 1]: https://blog.csdn.net/weixin_52255395/article/details/130933375?spm=1001.2014.3001.5502
[043b961a15fd47ddb7c91b8248d6df7f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/8d03828421ab4742ba4f13058bc6509f.png
[970c1bb56b0b4b068446b9eea4a6fd1c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/71de08bb91c34098be3eced296dcf15d.png
[0cf05a538b574175aeb37b54c070d666.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/928c1972e9a64871bd2453522ff688f4.png
[3220de43eae04a65aebe6892a0fc3ae2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/095e87d7217b4de6925efea583bc9967.png
[f9c2fc11adcc40bdabd67bf7777a9bc6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/baa38e3e67e441c1b33655c1bf8758f3.png
[792114022cfc4b2c9000e736e6f3b3a8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/4d6f5298b1674ac6b8fa0423730614d6.png
[4f226bf09a45420dbc5cad4c31d7ed1c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/953a28bb5ec549fab35a057366792580.png
[b63fed5ef55c4cf8a12e5ad94c0e020f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/e26518ab20c744b4a28e1c86ae4909cd.png
[f1956b3ba5344588be631c6abebaf7bf.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/9ceb68377aef4d3eb2c7cbb84419ff00.png