Net::SCP 项目技术文档

2024-12-23 20:00:54作者：卓炯娓

1. 安装指南

1.1 使用 RubyGems 安装

Net::SCP 可以通过 RubyGems 进行安装。执行以下命令：

gem install net-scp

如果需要管理员权限，请在命令前加上 sudo：

sudo gem install net-scp

1.2 验证安装

为了确保安装的代码未被篡改，建议验证签名。首先，添加项目的公钥为受信任证书：

curl -O https://raw.githubusercontent.com/net-ssh/net-ssh/master/net-ssh-public_cert.pem
gem cert --add net-ssh-public_cert.pem

然后，使用高安全级别安装 gem：

gem install net-scp -P HighSecurity

1.3 手动安装

如果不使用 RubyGems，可以手动安装：

解压源码包：
```
tar xzf net-scp-*.tgz
```
进入解压后的目录：
```
cd net-scp-*
```

配置并安装：

ruby setup.rb config
ruby setup.rb install

2. 项目使用说明

Net::SCP 是一个纯 Ruby 实现的 SCP 协议库，运行在 SSH 之上，允许通过 SCP 协议在本地和远程服务器之间传输文件和目录树。

2.1 上传文件

使用 Net::SCP.upload! 方法可以将本地文件上传到远程服务器：

require 'net/scp'

Net::SCP.upload!("remote.host.com", "username",
  "/local/path", "/remote/path",
  :ssh => { :password => "password" })

2.2 上传目录

通过设置 :recursive => true 选项，可以递归上传整个目录：

Net::SCP.upload!("remote.host", "username", "/path/to/local", "/path/to/remote",
   :ssh => { :password => "foo" }, :recursive => true)

2.3 下载文件

使用 Net::SCP.download! 方法可以从远程服务器下载文件到本地：

Net::SCP.download!("remote.host.com", "username",
  "/remote/path", "/local/path",
  :ssh => { :password => "password" })

2.4 下载到内存

可以将文件下载到内存中，而不是直接保存到磁盘：

data = Net::SCP::download!("remote.host.com", "username", "/remote/path")

2.5 使用持久连接

可以通过 Net::SCP.start 方法创建一个持久连接，并在该连接上执行多个文件传输操作：

Net::SCP.start("remote.host.com", "username", :password => "password") do |scp|
  scp.upload! "/local/path", "/remote/path"
  scp.upload! StringIO.new("some data to upload"), "/remote/path"

  d1 = scp.download("/remote/path", "/local/path")
  d2 = scp.download("/remote/path2", "/local/path2")
  [d1, d2].each { |d| d.wait }
end

3. 项目 API 使用文档

3.1 `Net::SCP.upload!`

功能: 上传文件或目录到远程服务器。
参数:
- host: 远程主机地址。
- username: 用户名。
- local_path: 本地文件或目录路径。
- remote_path: 远程文件或目录路径。
- options: 可选参数，如 :ssh 配置和 :recursive 选项。