不到200行代碼，使用python寫一個超簡單的跳板機工具
[toc]python
在平常工做中，少不了須要上服務器執行一些操做或者命令，即便在如今雲時代，可是一旦出現問題，仍是須要上機排查，因此寫了一個小小的跳板機工具mysql
在寫這個小工具以前，我就在想必定要很是簡單，足夠簡單，因此這裏用了不到 200 行代碼，寫了一個，能夠說是很是簡單。git
1. 使用模塊介紹
- pexpect
就這一個就完了！正則表達式
簡單介紹一下這個模塊：
pexpect 是 expect 的一個 python 實現，用來進行人機交互，好比執行某一段程序時要求輸入用戶名和密碼，或者是 yes/no 這種狀況時，使用 pexpect 即可以經過捕獲這種關鍵字進行輸入一些必要信息來繼續操做程序。sql
pexpect 的使用範圍很廣，能夠用來實現與 ssh、ftp 、telnet 等程序的自動交互shell
1.1 使用方式
pexpect 的使用基本上分爲三個步驟:數據庫
- 首先用 spawn 來執行一條命令或者一段程序
- 而後 expect 捕獲關鍵字
- 捕獲到指定關鍵字後，執行 send 指令發送必要的內容來繼續操做程序
1.1.1 spawn類
spawn是 pexpect 的一個主要類，用來執行一個程序，並返回一個操做這個程序的句柄，後面的一系列操做均可以經過這個句柄來完成，下面是它的構造函數的定義：windows
class spawn(command, args=[], timeout=30, maxread=2000, searchwindowsize=None, logfile=None, cwd=None,env=None, ignore_sighup=False, echo=True, preexec_fn=None, encoding=None, codec_errors='strict', dimensions=None, use_poll=False) 複製代碼
command是任意的命令
child = pexpect.spawn('/usr/bin/ftp')
child = pexpect.spawn('/usr/bin/ssh user@example.com')
child = pexpect.spawn('ls -latr /tmp')
複製代碼
可是當包含一些特殊字符時(>, |, or *)，就必須啓動一個 shell 來執行了，例如：bash
child = pexpect.spawn('/bin/bash -c "ls -l | grep LOG > logs.txt"')
child.expect(pexpect.EOF)
複製代碼
也能夠這樣寫，定一個變量，將要執行的命令經過這個變量來接收服務器
shell_cmd = 'ls -l | grep LOG > logs.txt'
child = pexpect.spawn('/bin/bash', ['-c', shell_cmd])
child.expect(pexpect.EOF)
複製代碼
args=[]執行程序時傳入所需的參數
child = pexpect.spawn('/usr/bin/ftp', [])
child = pexpect.spawn('/usr/bin/ssh', ['user@example.com'])
child = pexpect.spawn('ls', ['-latr', '/tmp'])
複製代碼
-
timeout=30設置超時時間 -
maxread=2000pexpect 從終端控制檯一次讀取的最大字節數 -
searchwindowsize匹配緩衝區字符串的位置，默認是從開始位置匹配
不過有時候須要打印下執行的結果，也就是將輸出打印到標準輸出裏，方式以下：
import pexpect
import sys
child = pexpect.spawn("df -h", encoding='utf-8')
child.logfile = sys.stdout
child.expect(pexpect.EOF)
複製代碼
必需要加上encoding='utf-8'，不然會報TypeError: write() argument must be str, not bytes
固然，也可使用logfile這個參數，例如：
child = pexpect.spawn("df -h", logfile=sys.stdout, encoding='utf-8')
child.expect(pexpect.EOF)
複製代碼
1.1.2 expect方法
expect最後會返回 0 表示匹配到了所需的關鍵字，若是定義了一個關鍵字列表的話，就會返回一個數字表示匹配到了列表中第幾個關鍵字，從 0 開始計算，也就是該關鍵字所在的索引號
expect(pattern, timeout=-1, searchwindowsize=-1, async_=False, **kw)
複製代碼
pattern 能夠是 StringType, EOF，正則表達式，或者這些類型的列表 若是當pattern是一個列表時，且列表裏有多個可被匹配到的值時，最後只能返回第一個被匹配到的索引，例如：
child = pexpect.spawn("echo 'hello world'", logfile=sys.stdout, encoding='utf-8')
index = child.expect(['hahaha', 'hello', 'hello world'])
print(index) # 結果爲1，'hello'的索引編號
複製代碼
注意： 這裏必定要知道, 是拿
pattern裏的內容來匹配spawn中的關鍵字
1.1.3 send方法
send就是發送關鍵字給程序，這裏舉一個示例，寫一個簡單的 shell 腳本,這個腳本會接收一個 username 的參數，並把該變量的值寫道一個文件裏
# test.sh
#!/bin/bash
read -p "Input your name:" username
echo "$username" > name.txt
複製代碼
而後經過 expect 進行捕獲關鍵字，最後使用 send 發送關鍵字
child = pexpect.spawn("sh test.sh", logfile=sys.stdout, encoding='utf-8')
index = child.expect("Input your name")
if index == 0:
child.send("dogfei") # 執行完還要再敲一次回車
複製代碼
上面執行完以後，還要再敲下回車，若是想不用敲回車，可使用sendline
結果當前目錄下會有一個 name.txt 文件，而且裏面的內容就是剛傳進去的變量的值
ok, 說了這麼多，基本上對 pexpect 這個模塊有了一個瞭解，那麼接下來就直奔主題！
實現遠程 ssh 鏈接到目標主機
既然是跳板機，那確定是經過執行ssh來遠程登陸，那麼就要有服務器地址、用戶名、密碼、端口等信息，而後遠程登陸的時候，通常會有幾種狀況，以下：
- 第一次 ssh 鏈接時，通常會提示：
Are you sure you want to continue connecting (yes/no)，要求輸入yes/no - 若是 ssh 鏈接時，ssh 的端口不正確，通常會提示：
Connection refused - 若是網絡問題，通常會鏈接超時
- 若是以前 ssh 鏈接過，那再次鏈接時，就會提示：
password:，要求輸入密碼 - 輸入密碼且密碼正確，通常會提示：
Last login - 密碼錯誤，通常會提示：
Permission denied, please try again
知道了，這些，那麼咱們在寫的時候，就比較容易了。
import pexpect
import os
def run_cmd(cmd, patterns):
child = pexpect.spawn(cmd, encoding='utf-8')
child.setwinsize(lines, columns)
index = child.expect(patterns, timeout=10)
return [index, child]
複製代碼
該函數返回一個列表，分別是捕獲關鍵字的索引編號，操做程序的一個句柄，而後下面是針對遠程 ssh 時的各類狀況，用到了一個遞歸，這樣避免使用嵌套while循環
def sshclient(host, user, port, passwd):
ssh_newkey = "continue"
ssh_passwd = "assword:"
ssh_confirm = "yes"
ssh_refuse = "Connection refused"
ssh_login = "Last login:"
ssh_repeat_passwd = "Permission denied, please try again"
ssh_noroutetohost = "No route to host"
ssh_conntimeout = "Connection timed out"
# 遠程ssh時的完整命令
ssh_cmd = "ssh {u}@{h} -p {p}".format(u=user, h=host, p=port)
# 初始化一個句柄，並獲取索引號
index, child = run_cmd(ssh_cmd, [
ssh_newkey,
ssh_passwd,
ssh_refuse,
ssh_login,
ssh_noroutetohost,
ssh_conntimeout,
pexpect.EOF,
pexpect.TIMEOUT])
try:
if index == 0:
child.sendline(ssh_confirm)
# 通常第一次ssh時，會讓你輸入yes/no之類的，因此匹配到這個的時候，就作一次遞歸
return sshclient(host, user, port, passwd)
elif index == 1:
print("Begin Load Password...")
child.sendline(passwd)
result = child.expect([
ssh_repeat_passwd,
ssh_login,
])
if result == 1:
print("{} login success (-_-)".format(host))
child.interact()
return
elif result == 0:
# 說明密碼錯誤，須要從新輸入密碼，並進行遞歸
passwd = input('Passwd: ').strip()
return sshclient(host, user, port, passwd)
elif index == 2:
print("Connect refused, Pls check ssh port.")
return
elif index == 3:
print("Login success")
child.interact()
return
elif index == 4:
print("The host %s connected faild: No route to host" % host)
return
elif index == 5:
print("The host %s connected faild: Connection timeout" % host)
return
elif index == 6:
print("Abnormal exit")
return
elif index == 7:
print("Timeout for connect host %s, pls check network" % host)
return
return
except Exception as e:
raise e
複製代碼
到這裏，咱們就能使用這個程序來進行遠程操做了，拿本機作下測試：
if __name__ == "__main__":
sshclient('127.0.0.1','dogfei',22, '123456')
複製代碼
提示以下：
$ python3 test_jp.py
Begin Load Password...
127.0.0.1 login success (-_-)
Sun Jun 20 19:43:32 2021 from 127.0.0.1
複製代碼
但這裏僅實現了能遠程鏈接到遠程主機，但是跳板機的話，是有不少臺機器，而且有不少類型，每臺機器都有本身的編號，因此咱們要實現這樣的功能，淦！
簡易跳板機的實現
既然有不少主機，這些主機又劃分了不少類型，也就是標籤之類的，還有可能每臺主機的密碼都不同，又或者相同類型的機器密碼同樣，又或者不能使用 root 登陸等等等等，因此咱們必定要作一個既簡單又靈活的，機器密碼不一致和用戶名不一致這個能夠經過定義一個完整的登陸命令來解決，而對主機劃分類型、設置密碼（默認密碼），用戶名這些信息，就要經過一個很是靈活的數據庫表結構來實現了，這裏我經過一個本地的配置文件來解決，方式以下：
global:
user: root
port: 22
passwd: 123456
jumpserver:
- name: k8s
hostList:
- 192.168.1.1
- 192.168.1.2
- 192.168.1.3
複製代碼
該配置文件有一個全局的配置，global 下的爲全局配置，若是jumpserver部分中沒有指定，則會拿全局配置，若是全部的機器用戶名、密碼、端口都同樣，那麼就能夠這樣寫.
若是用戶名，密碼不同，那就能夠這樣寫：
global:
user: root
port: 22
passwd: 123456
jumpserver:
- name: k8s
hostList:
- 192.168.1.1
- 192.168.1.2
- 192.168.1.3
- name: mysql
hostList:
- host: 192.168.1.4
user: dogfei
- host: 192.168.1.5
user: db
passwd: 111111
複製代碼
通過這樣設計之後，那麼咱們的代碼就變成了這個樣子：
import yaml
def parseYaml(yamlfile, parse_list=None):
if parse_list is None:
parse_list = []
with open(yamlfile, 'r', encoding='utf-8') as fr:
yaml_to_dict = yaml.safe_load(fr)
global_user = yaml_to_dict['global']['user']
global_passwd = yaml_to_dict['global']['passwd']
global_port = int(yaml_to_dict['global']['port'])
for detail in yaml_to_dict['jumpserver']:
tag = detail['name']
get_hostList = detail['hostList']
if isinstance(get_hostList[0], dict):
for ssh in get_hostList:
sshDetail = {
'tag': tag,
'host': ssh['host'],
'user': ssh['user'] if 'user' in ssh else global_user,
'port': int(ssh['port']) if 'port' in ssh else global_port,
'passwd': ssh['passwd'] if 'passwd' in ssh else global_passwd
}
parse_list.append(sshDetail)
elif isinstance(get_hostList[0], str):
for h in get_hostList:
sshDetail = {
'tag': tag,
'host': h,
'user': global_user,
'port': global_port,
'passwd': global_passwd
}
parse_list.append(sshDetail)
return parse_list
if __name__ == '__main__':
print(parseYaml('ip.yaml'))
複製代碼
最終返回的是一個列表，列表裏的元素是一個字典，以下所示：
[
{'tag': 'k8s', 'host': '192.168.1.1', 'user': 'root', 'port': 22, 'passwd': 123456},
{'tag': 'k8s', 'host': '192.168.1.2', 'user': 'root', 'port': 22, 'passwd': 123456},
{'tag': 'k8s', 'host': '192.168.1.3', 'user': 'root', 'port': 22, 'passwd': 123456},
{'tag': 'mysql', 'host': '192.168.1.4', 'user': 'dogfei', 'port': 22, 'passwd': 123456},
{'tag': 'mysql', 'host': '192.168.1.5', 'user': 'db', 'port': 22, 'passwd': 111111}
]
複製代碼
拿到這一堆數據字後，就能夠進行美化了，以下所示：
def list_info(originList):
try:
print("******\033[1;30;43mIP信息以下，請選擇對應的編號進行登錄\033[0m******\n")
print("\033[0;32m{:<5}\033[0m{:<19}{}".format("編號", "IP地址", "標籤"))
sshList = []
sshDict = {}
for info in originList:
id = originList.index(info) + 1
host = info['host']
tag = info['tag']
user = info['user']
port = int(info['port'])
passwd = info['passwd']
sshDict[id] = [
host, user, passwd, port
]
print("{:<5}{:<22}{}".format(id, host, tag))
return sshDict
except Exception as e:
raise e
複製代碼
這段代碼的執行結果如圖所示：
而後下面就是一堆循環，主要是實現打印主機信息、退出、進入主機等功能，以下所示：
def login(yamlfile):
try:
print("\033[1;30;47m{:^50}\033[0m\n".format("簡易跳板機"))
outer_flag = False
while not outer_flag:
print("\033[5;35;46m{:<}\033[0m\n".format("請選擇"))
print("\033[0;32m輸入 'p/P' 打印全部主機信息\033[0m")
print("\033[0;31m輸入 'q/quit' 退出\033[0m\n")
input_x = input(">>>>>: ").strip().lower()
if input_x == 'p':
os.system("clear")
ip_info = list_info(yamlfile)
print("\n")
print("\033[0;32m輸入 '編號' 進入對應的服務器\033[0m")
print("\033[0;32m輸入 'q' 退出\033[0m")
print("\033[0;32m輸入 'b' 返回\033[0m")
inner_flag = False
while not inner_flag:
act = input("\033[0;32m>>>>>: \033[0m").strip().lower()
if act.isdigit():
ip_id = int(act)
if ip_id in ip_info.keys():
host = ip_info[ip_id][0]
user = ip_info[ip_id][1]
passwd = str(ip_info[ip_id][2])
port = int(ip_info[ip_id][3])
sshclient(
host=host,
user=user,
port=port,
passwd=passwd
)
inner_flag = True
else:
print("\033[0;31m編號不存在，請從新輸入，退出請輸入任意字符\033[0m")
continue
else:
if act == 'q' or act == 'quit':
print("\033[0;31m告辭 !!!\033[0m")
inner_flag = True
outer_flag = True
elif act == 'b' or act == 'back':
inner_flag = True
elif input_x == 'q' or input_x == 'quit':
print("\033[0;31m告辭 !!!\033[0m")
outer_flag = True
else:
print("\033[0;31m請輸入指定的內容 !!!\033[0m")
continue
except Exception as e:
raise e
複製代碼
而後下面看下效果圖：
下面是動態演示：
總共加上空行，一共 185 行，真是太實用了啊！
完整代碼可去個人我的博客或者關注公衆號進行查看：www.dogfei.cn
- 1. 不到200行代碼，使用python寫一個超簡單的跳板機工具
- 2. Python寫一個簡單的爬蟲樣例（不超過50行代碼）
- 3. 使用node.js寫一個簡單的命令行程序工具
- 4. python 之路，200行Python代碼寫了個打飛機遊戲！
- 5. 200行代碼寫一個簡易的dva
- 6. 只用200行Go代碼寫一個本身的區塊鏈！
- 7. 用Python寫了一個測試Web服務的簡單工具
- 8. 不到150行代碼，寫一個簡單的Flutter狀態管理組件
- 9. 用一行python代碼作一個簡單的web服務器
- 10. 如何用不到200行代碼寫一款屬於本身的js框架
- 更多相關文章...
- • Eclipse 代碼模板 - Eclipse 教程
- • C# 不安全代碼 - C#教程
- • PHP開發工具
- • 漫談MySQL的鎖機制
-
每一个你不满意的现在，都有一个你没有努力的曾经。