Paramiko的SSH和SFTP使用

目錄

• 1. 概述
• 2. Paramiko的基本使用
  • 2.1 SSHClient關鍵參數介紹
  • 2.2 SSHClient常用示例
    • 2.2.1 通過用戶名和密碼方式登陸：
    • 2.2.2 通過用戶名和密碼方式登陸 ( transport方式 )
    • 2.2.3 通過用戶名和密鑰方式登陸
  • 2.3 SFTPClient關鍵參數介紹
  • 2.4 SFTPClient常用示例
• 3. 完整代碼

1. 概述

本來是不想寫Paramiko的，因為我覺得之前的一篇關於Netmiko模塊更適合網工，后來發現paramiko有包含SFTP功能，所以還是有必要來講講，畢竟我們在設備上是要經常下載配置、上傳版本/升級版本用的，而且SFTP比FTP、TFTP更安全。

所以， 你也不用借助其他工具來上傳、下載了，通通用 'Python' 來幫你搞定了。

SSH和SFTP都是使用一樣的端口號 22。如果對數據安全傳輸較重視，那么SFTP替代FTP、TFTP是首選。

實驗環境說明：

• 一台思科路由器，用於SSH登陸；
• 一台華為交換機，用於SFTP上傳/下載；
• PyCharm Pro

2. Paramiko的基本使用

2.1 SSHClient關鍵參數介紹

connect()函數：

用途：用於連接遠端主機，其中'hostname'為必選參數。

常用參數
hostname	//遠端主機，填寫IP和域名都可以
port=SSH_PORT	//缺省為22端口
username=None	//用於登陸遠端主機使用的用戶名
password=None	//用於登陸遠端主機使用的密碼
pkey=None	//使用私鑰用於身份認證，也叫'免密'登陸
key_filename=None	//使用私鑰文件名
timeout=None	//tcp連接超時時間
allow_agent=True	//缺省允許連接到ssh代理
look_for_keys=True	//缺省在~/.ssh中搜索私鑰文件，默認為True 允許
compress=False	//缺省沒有開啟壓縮

load_system_host_keys()函數:

用途：用於加載主機密鑰，密鑰保存"known_hosts"文件中。

filename=None	//缺省會加載"~/.ssh/known_hosts"文件

set_missing_host_key_policy()函數：

用途：用於檢查遠端主機在本地'host keys'是否有記錄並使用哪種策略。

#目前支持的三種策略： 
1.AutoAddPolicy		//自動添加主機名及主機密鑰到本地HostKeys對象，不依賴load_system_host_key的配置。即新建立ssh連接時不需要再輸入yes或no進行確認
2.WarningPolicy		//用於記錄一個未知的主機密鑰的python警告。並接受，功能上和AutoAddPolicy類似，但是會提示是新連接
3.RejectPolicy		//自動拒絕未知的主機名和密鑰，依賴load_system_host_key的配置。此為默認選項

exec_command()函數：

用途：用於在遠端主機執行的命令，並返回輸入、輸出、錯誤信息。

command	//執行的命令
stdin, stdout, stderr	//分別表示輸入、輸出、錯誤

2.2 SSHClient常用示例

2.2.1 通過用戶名和密碼方式登陸：

import paramiko

def ssh_client():
    # 創建一個實例化
    ssh = paramiko.SSHClient()
    # 加載系統HostKeys密鑰
    ssh.load_system_host_keys()
    # 自動添加策略，保存遠端主機的主機名和密鑰信息，如果不添加，那么不在本地knows_hosts文件中記錄的主機將無法連接，默認拒接
    ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
    #連接遠端主機
    ssh.connect('192.168.0.101',port=22, username='admin', password='Admin@123')
    #執行命令
    stdin, stdout,stderr = ssh.exec_command('show ip int br')
    print(stdout.read().decode('utf-8'))
	#關閉連接
    ssh.close()

if __name__ == '__main__':
    ssh_client()

執行代碼返回結果如下：

2.2.2 通過用戶名和密碼方式登陸 ( transport方式 )

def ssh_client():
    # 創建一個實例化
    ssh = paramiko.SSHClient()
	#transport封裝
    t = paramiko.Transport('192.168.0.101', 22)
    t.connect(username='admin', password='Admin@123')
    ssh._transport = t

    # 加載系統HostKeys密鑰
    ssh.load_system_host_keys()
    # 自動添加策略，保存遠端主機的主機名和密鑰信息，如果不添加，那么不在本地knows_hosts文件中記錄的主機將無法連接，默認拒接
    ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
    #執行命令
    stdin, stdout,stderr = ssh.exec_command('show ip int br')
    print(stdout.read().decode('utf-8'))
    #關閉連接
    ssh.close()

if __name__ == '__main__':
    ssh_client()

執行代碼返回結果如下：

​ 結果同上，輸出結果一樣。

2.2.3 通過用戶名和密鑰方式登陸

思科路由器公鑰配置：

username admin privilege 15 password Admin@123
ip domain name cisco.com
crypto key generate rsa modulus 1024
ip ssh version 2
ip ssh pubkey-chain
  username admin
   key-hash ssh-rsa 560DE41351E40FF6C237F9BBFF4238AC singvis@DESKTOP-IQ964AEendend
line vty 0 4
 exec-timeout 5 0
 logging synchronous
 login local
 transport input ssh
 privilege level 15

python代碼：

import paramiko

def ssh_client():
    #私鑰的絕對路徑
    private = paramiko.RSAKey.from_private_key_file(r'C:\Users\singvis\Documents\Identity')

    # 創建一個實例化
    ssh = paramiko.SSHClient()
    # 加載系統HostKeys密鑰
    ssh.load_system_host_keys()
    # 自動添加策略，保存遠端主機的主機名和密鑰信息，如果不添加，那么不在本地knows_hosts文件中記錄的主機將無法連接，默認拒接
    ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
    #連接遠端主機,此處不需要密碼，為私鑰文件
    ssh.connect('192.168.0.101',port=22, username='admin', pkey=private)
    #執行命令
    stdin, stdout,stderr = ssh.exec_command('show ip int br')
    print(stdout.read().decode('utf-8'))
    ssh.close()

if __name__ == '__main__':
    ssh_client()

通過SecurityCRT采用密鑰方式登陸192.168.0.101，不用輸入密碼，直接就登陸：

說明：密鑰的生成路徑：tools->creat public key ( 本次通過SecurityCRT )

2.3 SFTPClient關鍵參數介紹

SFTPCLient作為一個sftp的客戶端對象，根據ssh傳輸協議的sftp會話，實現遠程文件操作，如上傳、下載、權限、狀態。

from_transport(cls,t)	//創建一個已連通的SFTP客戶端通道
put(localpath, remotepath, callback=None, confirm=True)	//將本地文件上傳到遠端主機
get(remotepath, localpath, callback=None)	//從遠端主機下載文件到本地
mkdir()		//創建目錄
remove()	//刪除目錄
rename()	//重命名目錄
stat()		//查看文件狀態
listdir()	//列出目錄下的文件

2.4 SFTPClient常用示例

以華為交換機為例子說明，交換機配置如下：

rsa local-key-pair create
#
stelnet server enable
sftp server enable
#
aaa
 local-user admin password simple Admin@123
 local-user admin privilege level 15
 local-user admin service-type terminal ssh
 #
ssh authentication-type default password
ssh user admin authentication-type password
ssh user admin service-type all
ssh user admin sftp-directory flash:/
#
user-interface vty 0 4
 authentication-mode aaa
 protocol inbound ssh

Python代碼如下：

import paramiko

def sftp_put():
    #文件路徑
    local_file =r'D:\test\123.txt'
    remote_file ='flash:/123.txt'

    t = paramiko.Transport('192.168.0.200', 22)
    t.connect(username='admin', password='Admin@123')

    sftp = paramiko.SFTPClient.from_transport(t)
    sftp.put(local_file,remote_file)
    t.close()

def sftp_get():
    local_path = r'D:\test\vrpcfg.zip'
    remote_path = 'flash:/vrpcfg.zip'

    t = paramiko.Transport('192.168.0.200', 22)
    t.connect(username='admin', password='Admin@123')
    #
    sftp = paramiko.SFTPClient.from_transport(t)
    sftp.get(remote_path, local_path)
    t.close()

if __name__ == '__main__':
    sftp_put()
    sftp_get()

執行代碼返回結果如下：

3. 完整代碼

#!/usr/bin/env python
#coding:utf-8
#歡迎關注微信公眾號：點滴技術
#這里有靠譜的、有價值的、共成長的，專屬於網絡攻城獅

import paramiko, time
from paramiko.ssh_exception import NoValidConnectionsError,AuthenticationException

def ssh_client(host, user, pwd, cmds, verbose=True):
    # 私鑰文件的存放路徑
    # private = paramiko.RSAKey.from_private_key_file(r'C:\Users\singvis\Documents\Identity')
    # 創建一個實例化
    ssh = paramiko.SSHClient()
    # 加載系統SSH密鑰
    ssh.load_system_host_keys()
    # 自動添加策略，保存服務器的主機名和密鑰信息，如果不添加，那么不在本地knows_hosts文件中記錄的主機將無法連接，默認拒接
    ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
    # 連接設備
    try:
        ssh.connect(hostname=host,
                    username=user,
                    timeout=5,
                    compress=True,
                    password=pwd
                    #pkey=private,	#可以采用密鑰連接
                    )

        print("正在連接主機{}.....".format(host))
    except NoValidConnectionsError:
        print('連接出現了問題')
    except AuthenticationException:
        print('用戶名或密碼錯誤')
    except Exception as e:
        print('其他錯誤問題{}'.format(e))
    finally:
        #激活交互式shell
        chan = ssh.invoke_shell()
        time.sleep(1)

        for cmd in cmds:
            chan.send(cmd.encode())
            #一定要有回車'Enter'這個動作
            chan.send(b'\n')
            time.sleep(2)
            r = chan.recv(40960).decode()
            if verbose:
                print(r)
        chan.close()
        ssh.close()

def sftp_get(ip, user, pwd, local_file,remote_file, port=22):
    try:
        t = paramiko.Transport(ip, port)
        t.connect(username=user, password=pwd)
        sftp = paramiko.SFTPClient.from_transport(t)
        sftp.get(remote_file, local_file)
        t.close()

    except Exception as e:
        print(e)


def sftp_put(ip, user, pwd, local_file, remote_file, port=22):
    try:
        t = paramiko.Transport(ip, port)
        t.connect(username=user, password=pwd)
        sftp = paramiko.SFTPClient.from_transport(t)
        sftp.put(local_file, remote_file)
        t.close()

    except Exception as e:
        print(e)


if __name__ == '__main__':
    '''
    不要運行的，請注釋掉，前面加'#'符號
    '''
    ip = '192.168.0.101'
    user= 'admin'
    pwd= 'Admin@123'
    # local_file = r'D:\test\123.txt'
    # remote_file = 'flash:/vrpcfg.zip'
    # sftp_get(ip='192.168.0.200', user=user, pwd=pwd, remote_file=remote_file, local_file=r'D:\test\vrpcfg.zip')
    # sftp_put(ip='192.168.0.200', user=user, pwd=pwd, local_file=local_file, remote_file='flash:/123.txt')

    cmds = ['terminal length 0', 'show version', 'show ip int br','show ip route']
    # cmds = ['disp ip int br','disp device','disp clock']
    ssh_client(ip, user, pwd, cmds)

參考信息：

思科路由器和交換機SSH配置

---

如果喜歡的我的文章，歡迎關注我的公眾號：點滴技術，掃碼關注，不定期分享