Welcome to acore_db_ssh_tunnel Documentation
出于安全考虑, 通常数据库都会被部署到私网中, 是不允许直接从公网访问的. 为了能让开发者从工具配置齐全的开发电脑连接到数据库, 通常采用跳板机 + SSH Tunnel 技术实现. 具体方法是用 SSH 和 EC2 的秘钥在本地机器上建立一个 tunnel, 所有本来要发送到 Database domain 的流量都发送到 127.0.0.1, 然后 SSH 会自动将流量发送到跳板机, 然后堡垒机再发送到 Database.
本项目将创建, 关闭, 查看, 以及测试 SSH Tunnel 的方法封装成了一个 Python package, 以便于在 Python 代码中使用.
用例
from acore_db_ssh_tunnel import api
def create_ssh_tunnel():
api.create_ssh_tunnel(
path_pem_file=path_pem_file,
db_host=db_host,
db_port=db_port,
jump_host_username=jump_host_username,
jump_host_public_ip=jump_host_public_ip,
)
def list_ssh_tunnel():
api.list_ssh_tunnel(path_pem_file)
def test_ssh_tunnel():
api.test_ssh_tunnel(
db_port=db_port,
db_username=db_username,
db_password=db_password,
db_name=db_name,
)
def kill_ssh_tunnel():
api.kill_ssh_tunnel(path_pem_file)
# edit the following variables to your own
db_host = "my-server.1a2b3c4d5e6f.us-east-1.rds.amazonaws.com"
db_port = 3306
db_username = "admin"
db_password = "admin"
db_name = "my_database"
jump_host_username = "ubuntu"
jump_host_public_ip = "111.111.111.111"
path_pem_file = "/Users/myusername/ec2-key.pem"
# create_ssh_tunnel() # run this first
# list_ssh_tunnel() # then this
# test_ssh_tunnel() # then this
# kill_ssh_tunnel() # then clean up
Install
acore_db_ssh_tunnel is released on PyPI, so all you need is to:
$ pip install acore-db-ssh-tunnel
To upgrade to latest version:
$ pip install --upgrade acore-db-ssh-tunnel
Metadata
Release files for acore-db-ssh-tunnel 0.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| acore_db_ssh_tunnel-0.1.4.tar.gz | 14.9 kB | Without provenance | Details for acore_db_ssh_tunnel-0.1.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| acore_db_ssh_tunnel-0.1.4-py3-none-any.whl | Python 3 | none | any | Details for acore_db_ssh_tunnel-0.1.4-py3-none-any.whl |
Total release size: 28.3 kB
Release files / acore_db_ssh_tunnel-0.1.4.tar.gz
| Download URL | acore_db_ssh_tunnel-0.1.4.tar.gz |
|---|---|
| Size | 14.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a096e6b90b24520a978d0fc75a0641a1ea6f432e939f93ecf8792c821708abf5
|
|
BLAKE2b-256 checksum How to use checksums |
2f82ac49332f8efd3605502db593486ece0defffe11aba302f7ad34a38bb831d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.0 CPython/3.8.13
|
Release files / acore_db_ssh_tunnel-0.1.4-py3-none-any.whl
| Download URL | acore_db_ssh_tunnel-0.1.4-py3-none-any.whl |
|---|---|
| Size | 13.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e1dc396ff2809b792edd2bb92bc0e35eb2b96ce75b68b84ed12e11f60324f52b
|
|
BLAKE2b-256 checksum How to use checksums |
8a91a7f3a45f0800fad701e3e7a98d7637db748449013d4b8319552981d473cf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.0 CPython/3.8.13
|
Security for acore-db-ssh-tunnel 0.1.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.