Paramiko官方文檔-Server
ServerInterface is an interface to override for server support.
Paramiko的ServerInterface是用來(lái)重寫(xiě)Paramiko服務(wù)端支持的接口薯定。
class paramiko.server.ServerInterface
這個(gè)類(lèi)定義了一個(gè)在服務(wù)端控制paramiko所有行為的接口冀值,這個(gè)類(lèi)的方法是在Paramiko主線(xiàn)程下調(diào)用的淮腾,所以戴质,你不應(yīng)該在這些方法中做太多的工作(一定不能去阻塞或者睡眠)。
check_channel_request(kind, chanid):
這個(gè)方法決定一個(gè)指定類(lèi)型的通道請(qǐng)求是否被允許手幢,將會(huì)返回OPEN_SUCCEEDED或者其他錯(cuò)誤碼哩掺。當(dāng)客戶(hù)端完成身份認(rèn)證并請(qǐng)求通道時(shí)云芦,該方法在服務(wù)端被調(diào)用关炼。
當(dāng)你允許通道請(qǐng)求的時(shí)候(當(dāng)然如果不允許就無(wú)法使用)程腹,你同樣應(yīng)該重寫(xiě)下面這些通道請(qǐng)求方法,這些方法用于確定給定的通道將授權(quán)哪些服務(wù)儒拂。
- check_channel_pty_request
- check_channel_shell_request
- check_channel_subsystem_request
- check_channel_window_change_request
- check_channel_x11_request
- check_channel_forward_agent_request
chanid參數(shù)是一個(gè)小的數(shù)字寸潦,用來(lái)唯一標(biāo)識(shí)傳輸中的通道。除非該方法返回OPEN_SUCCEEDED否則通道對(duì)象將不會(huì)被創(chuàng)建社痛,一旦通道被創(chuàng)建见转,你就可以調(diào)用Channel.get_id方法來(lái)獲取這個(gè)通道的ID。
該方法的返回值應(yīng)該是OPEN_SUCCEEDED (or 0)來(lái)允許通道請(qǐng)求蒜哀,或者返回下面的錯(cuò)誤碼中的一個(gè)來(lái)拒絕通道請(qǐng)求斩箫。
- OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
- OPEN_FAILED_CONNECT_FAILED
- OPEN_FAILED_UNKNOWN_CHANNEL_TYPE
- OPEN_FAILED_RESOURCE_SHORTAGE
該方法默認(rèn)返回OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED。
check_channel_pty_request(channel, term, width, height, pixelwidth, pixelheight, modes):
確定在偽終端上是否可以在指定通道上提供指定尺寸(通常為shell訪(fǎng)問(wèn)而請(qǐng)求)撵儿。默認(rèn)值為False乘客。
check_channel_shell_request(channel):
確定在偽終端上是否可以提供shell給客戶(hù)端。如果返回True统倒,通道將會(huì)連接到shell的stdin/stdout(或者類(lèi)似shell的東西)寨典。默認(rèn)返回False。
check_channel_exec_request(channel, command):
確定是否要為客戶(hù)端執(zhí)行一個(gè)shell命令房匆。如果返回True,該通道應(yīng)該連接到shell命令的stdin/stdout/stderror报亩。默認(rèn)返回False浴鸿。
check_channel_subsystem_request(channel, name):
確定是否要為通道上的客戶(hù)端提供子系統(tǒng)請(qǐng)求。如果返回True弦追,將會(huì)認(rèn)為該通道后面所有的I/O都會(huì)連接到同一個(gè)請(qǐng)求的子系統(tǒng)岳链。例如sftp子系統(tǒng)。
默認(rèn)通過(guò)Transport.set_subsystem_handler處理程序來(lái)實(shí)現(xiàn)子系統(tǒng)的檢測(cè)操作劲件,如果一旦被設(shè)置掸哑,將會(huì)調(diào)用該處理程序并且該方法返回True约急,其他情況將會(huì)返回False。
注意:
應(yīng)為默認(rèn)的實(shí)現(xiàn)使用Transport來(lái)標(biāo)識(shí)有效的子系統(tǒng)苗分,所以你可能不需要重寫(xiě)此方法厌蔽。
check_channel_window_change_request(channel, width, height, pixelwidth, pixelheight):
確定指定的通道上的偽終端是否可以調(diào)整大小,當(dāng)然摔癣,這只有在之前為它分配了pty才會(huì)生效奴饮。默認(rèn)返回False。
check_channel_x11_request(channel, single_connection, auth_protocol, auth_cookie, screen_number):
確定是否為客戶(hù)端提供一個(gè)X11會(huì)話(huà)择浊。如果返回True戴卜,將會(huì)通過(guò)Transport.open_x11_channel讓X11應(yīng)用程序使用新的SSH通道。默認(rèn)返回False琢岩。
check_channel_forward_agent_request(channel):
確定是否為客戶(hù)端提供一個(gè)轉(zhuǎn)發(fā)代理會(huì)話(huà)投剥。如果返回True,服務(wù)端將會(huì)允許SSH代理轉(zhuǎn)發(fā)担孔。默認(rèn)返回False薇缅。
check_channel_direct_tcpip_request(chanid, origin, destination):
確定本地端口轉(zhuǎn)發(fā)通道是否被授權(quán),該方法將會(huì)返回OPEN_SUCCEEDED或者其他錯(cuò)誤碼攒磨。完成身份證人之后泳桦,當(dāng)有客戶(hù)端請(qǐng)求時(shí)該方法將會(huì)調(diào)用。
默認(rèn)返回OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED娩缰。
check_channel_env_request(channel, name, value):
檢查通道是否要指定一個(gè)環(huán)境變量灸撰。如果服務(wù)端將要指定一個(gè)環(huán)境變量,該方法應(yīng)該返回True拼坎。注意有些環(huán)境變量被設(shè)置將會(huì)很危險(xiǎn)浮毯,所以不要盲目的允許客戶(hù)端設(shè)置環(huán)境變量。默認(rèn)返回False泰鸡。
get_allowed_auths(username):
返回一個(gè)服務(wù)端所支持的身份認(rèn)證方法的列表债蓝。這個(gè)列表發(fā)送給試圖進(jìn)行認(rèn)證的客戶(hù)端,通知客戶(hù)端成功通過(guò)身份認(rèn)證的方法盛龄。
實(shí)際上饰迹,這個(gè)列表是以逗號(hào)(,)分割的身份認(rèn)證類(lèi)型的名字的列表。值通常為"password", "publickey"或"None"余舶。默認(rèn)是"password"啊鸭。
check_auth_none(username):
確定客戶(hù)端可以在無(wú)認(rèn)證的情況下打開(kāi)通道。如果必須身份認(rèn)證請(qǐng)返回AUTH_FAILED匿值,允許不需要認(rèn)證請(qǐng)返回AUTH_SUCCESSFUL赠制。默認(rèn)返回AUTH_FAILED。
check_auth_password(username, password):
確定需要用戶(hù)名和密碼建立通道挟憔。密碼認(rèn)證失敗返回AUTH_FAILED钟些,密碼認(rèn)證通過(guò)并且完成身份認(rèn)證時(shí)返回AUTH_SUCCESSFUL烟号,如果是有狀態(tài)的認(rèn)證返回AUTH_PARTIALLY_SUCCESSFUL,這個(gè)值用于身份認(rèn)證政恍,但是需要提供更多的信息(該情況下將會(huì)調(diào)用get_allowed_auths允許的選項(xiàng)讓通知客戶(hù)端繼續(xù)認(rèn)證)汪拥。
默認(rèn)返回AUTH_FAILED。
check_auth_publickey(username, key):
確定是否接受客戶(hù)端通過(guò)KEY來(lái)認(rèn)證抚垃,如果是喷楣,你需要重寫(xiě)該方法來(lái)檢測(cè)用戶(hù)名和KEY,同時(shí)要確定你是否接受該KEY產(chǎn)生的簽名鹤树。默認(rèn)返回AUTH_FAILED铣焊。
注意:你不要完成簽名驗(yàn)證的工作,如果你接受這個(gè)KEY罕伯,那么Paramiko將會(huì)替你完成這些驗(yàn)證曲伊。
check_auth_interactive(username, submethods):
如果支持該方法,那么將會(huì)進(jìn)行人機(jī)交互認(rèn)證追他。如果你想要支持"keyboard-interactive"類(lèi)型的認(rèn)證坟募,你需要提出一系列的問(wèn)題讓客戶(hù)端回復(fù)。
如果不支持則返回AUTH_FAILED邑狸,否則懈糯,你應(yīng)該返回給用戶(hù)一個(gè)包含提示和說(shuō)明的 InteractiveQuery對(duì)象。響應(yīng)結(jié)果將會(huì)通過(guò)調(diào)用check_auth_interactive_response方法來(lái)發(fā)送单雾。
默認(rèn)返回AUTH_FAILED赚哗。
check_auth_interactive_response(responses):
如果支持的話(huà),將會(huì)繼續(xù)或者完成一個(gè)人機(jī)交互認(rèn)證硅堆。如果你的服務(wù)端支持"keyboard-interactive"的認(rèn)證類(lèi)型屿储,你應(yīng)該重寫(xiě)該方法。
如果你想要通過(guò)更多問(wèn)題繼續(xù)進(jìn)行人機(jī)交互認(rèn)證渐逃,你應(yīng)該返回一個(gè)InteractiveQuery對(duì)象够掠,將會(huì)告訴客戶(hù)端回答更多問(wèn)題,然后會(huì)繼續(xù)調(diào)用該方法茄菊。這個(gè)過(guò)程可以一直執(zhí)行下去疯潭。
默認(rèn)返回AUTH_FAILED。
check_auth_gssapi_with_mic(username, gss_authenticated=2, cc_file=None):
為服務(wù)端認(rèn)證給出的krb5主體的用戶(hù)买羞。(kerberos認(rèn)證)
check_auth_gssapi_keyex(username, gss_authenticated=2, cc_file=None):
如果給定的用戶(hù)是一個(gè)有效的krb5主體袁勺,則向服務(wù)器進(jìn)行身份驗(yàn)證,并執(zhí)行GSS-API密鑰交換畜普。如果沒(méi)有執(zhí)行GSS-API密鑰交換,則此身份驗(yàn)證方法將不可用群叶。
enable_auth_gssapi():
重寫(xiě)該方法開(kāi)啟GSSAPI認(rèn)證吃挑。默認(rèn)False钝荡。
check_port_forward_request(address, port):
處理一個(gè)端口轉(zhuǎn)發(fā)請(qǐng)求〔俺模客戶(hù)端請(qǐng)求這個(gè)SSH連接轉(zhuǎn)發(fā)到指定的地址和端口上埠通。0.0.0.0表示全局地址,0表示任意端口(通彻溆蹋客戶(hù)端會(huì)隨機(jī)選擇一個(gè)端口)端辱。
默認(rèn)返回False拒絕。如果允許虽画,應(yīng)該返回所監(jiān)聽(tīng)的端口舞蔽。
cancel_port_forward_request(address, port):
取消之前設(shè)置的端口轉(zhuǎn)發(fā)請(qǐng)求。
check_global_request(kind, msg):
處理給定類(lèi)型的全局請(qǐng)求码撰。在服務(wù)器模式和客戶(hù)端模式下渗柿,只要遠(yuǎn)程主機(jī)發(fā)出全局請(qǐng)求,就會(huì)調(diào)用此方法脖岛。如果請(qǐng)求有任何參數(shù)朵栖,它們將在msg中。除了端口轉(zhuǎn)發(fā)柴梆,沒(méi)有定義任何有用的全局請(qǐng)求陨溅,所以通常這種類(lèi)型的請(qǐng)求是協(xié)議的擴(kuò)展。
如果請(qǐng)求成功绍在,并且希望將上下文數(shù)據(jù)返回到遠(yuǎn)程主機(jī)门扇,則返回一個(gè)元組。元組中的項(xiàng)將隨著成功的結(jié)果被發(fā)回揣苏。(注意悯嗓,元組中的項(xiàng)只能是字符串、整型卸察、長(zhǎng)型或bool型脯厨。)
默認(rèn)實(shí)現(xiàn)總是返回False,表示它不支持任何全局請(qǐng)求坑质。