ssh是一個協議，OpenSSH是其中一個開源實現，paramiko是Python的一個庫，實現了SSHv2協議(底層使用cryptography)。
有了Paramiko以后，我們就可以在Python代碼中直接使用SSH協議對遠程服務器執行操作，而不是通過ssh命令對遠程服務器進行操作。
paramiko包含兩個核心組件：SSHClient和SFTPClient。
SSHClient的作用類似於Linux的ssh命令，是對SSH會話的封裝，該類封裝了傳輸(Transport)，通道(Channel)及SFTPClient建立的方法(open_sftp)，通常用於執行遠程命令。
SFTPClient的作用類似與Linux的sftp命令，是對SFTP客戶端的封裝，用以實現遠程文件操作，如文件上傳、下載、修改文件權限等操作。
# Paramiko中的幾個基礎名詞：
1、Channel：是一種類Socket，一種安全的SSH傳輸通道；
2、Transport：是一種加密的會話，使用時會同步創建了一個加密的Tunnels(通道)，這個Tunnels叫做Channel；
3、Session：是client與Server保持連接的對象，用connect()/start_client()/start_server()開始會話。
基本使用
SSHClient常用的方法介紹
connect()：實現遠程服務器的連接與認證，對於該方法只有hostname是必傳參數。
常用參數
hostname 連接的目標主機
port=SSH_PORT 指定端口
username=None 驗證的用戶名
password=None 驗證的用戶密碼
pkey=None 私鑰方式用於身份驗證
key_filename=None 一個文件名或文件列表，指定私鑰文件
timeout=None 可選的tcp連接超時時間
allow_agent=True, 是否允許連接到ssh代理，默認為True 允許
look_for_keys=True 是否在~/.ssh中搜索私鑰文件，默認為True 允許
compress=False, 是否打開壓縮
set_missing_host_key_policy()：設置遠程服務器沒有在know_hosts文件中記錄時的應對策略。目前支持三種策略：
設置連接的遠程主機沒有本地主機密鑰或HostKeys對象時的策略，目前支持三種：
AutoAddPolicy 自動添加主機名及主機密鑰到本地HostKeys對象，不依賴load_system_host_key的配置。即新建立ssh連接時不需要再輸入yes或no進行確認
WarningPolicy 用於記錄一個未知的主機密鑰的python警告。並接受，功能上和AutoAddPolicy類似，但是會提示是新連接
RejectPolicy 自動拒絕未知的主機名和密鑰，依賴load_system_host_key的配置。此為默認選項
exec_command()：在遠程服務器執行Linux命令的方法。
open_sftp()：在當前ssh會話的基礎上創建一個sftp會話。該方法會返回一個SFTPClient對象。
# 利用SSHClient對象的open_sftp()方法，可以直接返回一個基於當前連接的sftp對象，可以進行文件的上傳等操作.
sftp = client.open_sftp()
sftp.put('test.txt','text.txt')
SSHClient常用的方法舉例
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
import
paramiko
# 實例化SSHClient
client
=
paramiko.SSHClient()
# 自動添加策略，保存服務器的主機名和密鑰信息，如果不添加，那么不再本地know_hosts文件中記錄的主機將無法連接
client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
# 連接SSH服務端，以用戶名和密碼進行認證
client.connect(hostname
=
'192.168.1.105'
, port
=
22
, username
=
'root'
, password
=
'123456'
)
# 打開一個Channel並執行命令
stdin, stdout, stderr
=
client.exec_command(
'df -h '
)
# stdout 為正確輸出，stderr為錯誤輸出，同時是有1個變量有值
# 打印執行結果
print
(stdout.read().decode(
'utf-8'
))
# 關閉SSHClient
client.close()
|
密鑰連接方式
|
1
2
3
4
5
6
7
8
9
10
11
|
# 配置私人密鑰文件位置
private
=
paramiko.RSAKey.from_private_key_file(
'/Users/ch/.ssh/id_rsa'
)
#實例化SSHClient
client
=
paramiko.SSHClient()
#自動添加策略，保存服務器的主機名和密鑰信息，如果不添加，那么不再本地know_hosts文件中記錄的主機將無法連接
client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
#連接SSH服務端，以用戶名和密碼進行認證
client.connect(hostname
=
'10.0.0.1'
,port
=
22
,username
=
'root'
,pkey
=
private)
|
SSHClient 封裝 Transport
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
import
paramiko
# 創建一個通道
transport
=
paramiko.Transport((
'hostname'
,
22
))
transport.connect(username
=
'root'
, password
=
'123'
)
ssh
=
paramiko.SSHClient()
ssh._transport
=
transport
stdin, stdout, stderr
=
ssh.exec_command(
'df -h'
)
print
(stdout.read().decode(
'utf-8'
))
transport.close()
|
SFTPClient常用方法介紹
|
1
2
3
4
5
6
7
8
9
10
|
SFTPCLient作為一個sftp的客戶端對象，根據ssh傳輸協議的sftp會話，實現遠程文件操作，如上傳、下載、權限、狀態
from_transport(
cls
,t) 創建一個已連通的SFTP客戶端通道
put(localpath, remotepath, callback
=
None
, confirm
=
True
) 將本地文件上傳到服務器 參數confirm：是否調用stat()方法檢查文件狀態，返回ls
-
l的結果
get(remotepath, localpath, callback
=
None
) 從服務器下載文件到本地
mkdir() 在服務器上創建目錄
remove() 在服務器上刪除目錄
rename() 在服務器上重命名目錄
stat() 查看服務器文件狀態
listdir() 列出服務器目錄下的文件
|
SFTPClient常用方法舉例
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
import
paramiko
# 獲取Transport實例
tran
=
paramiko.Transport((
'10.0.0.3'
,
22
))
# 連接SSH服務端，使用password
tran.connect(username
=
"root"
, password
=
'123456'
)
# 或使用
# 配置私人密鑰文件位置
private
=
paramiko.RSAKey.from_private_key_file(
'/Users/root/.ssh/id_rsa'
)
# 連接SSH服務端，使用pkey指定私鑰
tran.connect(username
=
"root"
, pkey
=
private)
# 獲取SFTP實例
sftp
=
paramiko.SFTPClient.from_transport(tran)
# 設置上傳的本地/遠程文件路徑
localpath
=
"/Users/root/Downloads/1.txt"
remotepath
=
"/tmp/1.txt"
# 執行上傳動作
sftp.put(localpath, remotepath)
# 執行下載動作
sftp.get(remotepath, localpath)
tran.close()
|
、