Python 下 Django 透過 SSHTunnel 連線 ECS 上未開通外網地址 RDS 的方案

shinonomeasahi發表於2024-03-15
PythonDjango

在開發過程中，碰到需要在 Python Django 專案中連線到位於 ECS 上但未開通外網地址的 RDS 資料庫。

這種情況下，透過建立 SSH 隧道來實現連線，確保資料傳輸的安全性和可靠性。

1、安裝 sshtunnel 包

pip3 install sshtunnel

2、匯入 SSHTunnelFowarder 模組（以下程式碼均寫在 settings.py 中）

from sshtunnel import SSHTunnelForwarder

3、使用 SSHTunnelFowarder 類來建立一個 SSH 隧道，將本地主機的某個埠對映到遠端伺服器的指定埠上

1 def get_ssh_tunnel():
2     server = SSHTunnelForwarder(
　　　　　　# 此處填入 ECS 的外網 ip 地址以及 ssh 的埠號（預設22）
3         ("xxx.xxx.xxx.xxx", 22),
　　　　　　# 填入 ECS 的使用者名稱和密碼
4         ssh_username="your_ssh_username",
5         ssh_password="your_ssh_password",
　　　　　　# 填入 RDS 資料庫的內網地址以及埠號（預設3306）
6         remote_bind_address=("mysql_host", 3306)
7     )
8     server.start()
9     return server

4、獲取 SSH 隧道物件

10 ssh_tunnel = get_ssh_tunnel()

5、Django 資料庫配置

11 DATABASES = {
12     'default': {
13         'ENGINE': 'django.db.backends.mysql',
　　　　　　　# 填入要連線的 mysql 資料庫名、使用者名稱、密碼
14         'NAME': 'mysql_db',
15         'USER': 'mysql_user',
16         'PASSWORD': 'mysql_password',
　　　　　　　# 此處 HOST 引數必須為 127.0.0.1
17         'HOST': "127.0.0.1",
18         'PORT': ssh_tunnel.local_bind_port
19     }
20 }

透過在本地主機（127.0.0.1）上建立 SSH 隧道連線到遠端 MySQL 伺服器，實際上是將本地主機的某個埠對映到遠端 MySQL 伺服器的埠上。

因此，將 "HOST" 設定為 "127.0.0.1" 表示連線到本地主機，而不是直接連線到遠端 MySQL 伺服器。

ssh_tunnel.local_bind_port

返回了本地主機上對映到遠端 MySQL 伺服器的埠號，透過將這個埠號作為 "PORT" 的值，Django 就可以透過 SSH 隧道連線到遠端 MySQL 伺服器。

相關文章