Python的網絡編程[1] -> FTP 協議[1] -> 使用 pyftplib 建立 FTP 服務器

使用 pyftplib 建立 FTP 服務器

---

pyftplib 主要用於建立 FTP Server，與 ftplib 建立的 Client 進行通信。

快速導航

1. 模塊信息

2. 建立 FTP 服務器

 

1 模塊信息

1.1 servers模塊

用於建立服務器

1.1.1 FTPServer()類

類實例化：ftpServer = FTPServer(address, handler)

類的功能: 用於建立服務器

傳入參數: address, handler

address: tuple類型，包含ip地址和端口號

handler: type類型，可直接傳入FTPHandler 模塊

返回參數: ftpServer

1.1.1.1 serve_forever()方法

函數調用: ftpServer.serve_forever()

函數功能:用於啟動服務器

傳入參數: 無

返回參數: 無

1.1.1.2 close_all()方法

函數調用: ftpServer.close_all()

函數功能:用於關閉服務器

傳入參數: 無

返回參數: 無

1.1.1.3 max_cons屬性

屬性調用: handler.max_cons = num

屬性功能:用於設置最大連接數

屬性參數: num

num: int類型

1.1.1.4 max_cons_per_ip屬性

屬性調用: handler.max_cons _per_ip = num

屬性功能:用於設置最多ip數

屬性參數: num

num: int類型

 

1.2 handlers模塊

用於建立句柄

1.2.1 FTPHandler()類

handler = FTPHandler

用於建立服務器時傳入FTPServer

1.2.1.1 banner屬性

屬性調用: handler.banner = info

屬性功能:用於設置歡迎信息

屬性參數: info

info: str類型，歡迎詞字符串

1.2.1.2 authorizer屬性

屬性調用: handler.authorizer = authorizer

屬性功能:用於設置許可用戶信息

屬性參數: authorizer

authorizer: instance類型，由DummyAuthorizer生成

1.2.1.3 passive_ports屬性

屬性調用: handler.passive_ports = range(from_port, to_port)

屬性功能: 被動模式端口范圍，該范圍需大於最大ip連接數，否則可能造成連接失敗

屬性參數: range(from_port, to_port)

from_port: int類型，端口范圍起始點

to_port: int類型，端口范圍結束點，比實際最大端口大1

 

1.3 authorizers模塊

用於授權用戶等操作

1.3.1 DummyAuthorizer()類

類實例化：authorizer = DummyAuthorizer()

類的功能:用於創建權限類實例，進行用戶信息授權

傳入參數: 無

返回參數: authorizer

1.3.1.1 add_user()方法

函數調用: authorizer.add_user(username, password, homedir, perm=’elr’, msg_login=’Login successful.’, msg_quit=’Goodbye.’)

函數功能: 用於添加許可用戶及其信息

傳入參數: username, password, homedir, perm, msg_login, msg_quit

username: str類型，用戶名

password: str類型，密碼

homedir：str類型，路徑

perm: str類型，權限

msg_login: str類型，登錄信息

msg_quit: str類型，離開信息

返回參數: 無

關於權限，

讀權限：e 改變文件目錄，l 列出文件，r 從服務器接收文件

寫權限：a 文件上傳，d 刪除文件，f 文件重命名，m 創建文件，w 寫權限 ，M 文件傳輸模式（通過FTP設置文件權限 ）

1.3.1.2 add_anonymous()方法

函數調用: authorizer. anonymous(homedir, perm=’elr’, msg_login=’Login successful.’, msg_quit=’Goodbye.’)

函數功能: 用於添加匿名登錄許可

傳入參數: homedir, perm, msg_login, msg_quit

homedir：str類型，路徑

perm: str類型，權限

msg_login: str類型，登錄信息

msg_quit: str類型，離開信息

返回參數: 無

 

2 FTP的服務器建立過程

服務器建立步驟主要有:

（1）      設定IP和端口號(常用21)，生成handler

（2）      生成ftp實例，設置banner;

（3）      添加用戶信息或匿名授權;

（4）      serve_forever()開啟服務器;

（5）      close_all()函數結束服務器。

from pyftpdlib.servers import FTPServer
from pyftpdlib.handlers import FTPHandler
from pyftpdlib.authorizers import DummyAuthorizer

class FTP_Server():
    def __init__(self):
        handler = FTPHandler        # handler is a class(type is 'type')
        ip = '127.0.0.10'
        port = 21
        address = (ip, port)
        self.ftpServer = FTPServer(address, handler)
        self.ftpServer.max_cons = 150           # max connection numbers
        self.ftpServer.max_cons_per_ip = 10     # max connection ip numbers
        print('FTP server created')
        print(self.ftpServer)
        # Change welcome info when client logined in
        self.ftpServer.handler.banner = 'Welcome to my FTP server.'
        # Passive port number should be more than max ip number, otherwise may course connection failed
        self.ftpServer.handler.passive_ports = range(2000, 2333)

        # User info bin
        self.userInfo = {'User_1': {'user_name': 'Admin',
                                    'password': '888888',
                                    'home_path': '.\\FTPServerFile',
                                    'permission': 'elradfmwM',
                                    'msg_login': 'Admin login successful',
                                    'msg_quit': 'Goodbye, admin.'},
                         'User_2': {'user_name': 'Customer',
                                    'password': '777777',
                                    'home_path': '.\\FTPServerFile',
                                    'permission': 'elr',
                                    'msg_login': 'Customer login successful',
                                    'msg_quit': 'Goodbye, customer.'}}

    def addUser(self):
        # Add users method_1
        authorizer = DummyAuthorizer()
        # Add new user, user name, password, home path('.' is current root path), permission level
        for user in self.userInfo.values():
            authorizer.add_user(user['user_name'], user['password'], user['home_path'],
                                perm=user['permission'], msg_login=user['msg_login'], msg_quit=user['msg_quit'])
        self.ftpServer.handler.authorizer = authorizer

        # Add users method_2
        # Mark here: handler.authorizer also generate from DummyAuthorizer inside Handler module
        # for user in self.userInfo.values():
        #    self.ftpServer.handler.authorizer.add_user(user['user_name'], user['password'], user['home_path'],
        #                        perm=user['permission'], msg_login=user['msg_login'], msg_quit=user['msg_quit'])

        # Add anonymous
        authorizer.add_anonymous('.\\FTPServerFile',
                                 perm='elr', msg_login='anonymous login successful', msg_quit='Goodbye, anonymous.')

    def run(self):
        print('FTP server start')
        self.ftpServer.serve_forever()

    def stop(self):
        self.ftpServer.close_all()

ftp_server = FTP_Server()
ftp_server.addUser()
ftp_server.run()

 Note:

第 19 行：被動模式設置的端口數量應大於最大端口數，否則會產生報錯

第 38-48 行：添加用戶即可以通過 DummyAuthorizer 類生成一個新的實例進行設置，再傳給 ftp 實例（42行），也可以直接通過 ftpServer.handler.authorizer 獲取原本的 DummyAuthorizer 實例進行設置。

 

相關閱讀

---

1. ftp 客戶端

 

參考鏈接

---

http://www.cnblogs.com/huangxm/p/6274645.html