Skip to main content

带登录认证的安全文件服务器

Project description

File Server Logo

File Server

带登录认证的安全文件服务器


功能特性

  • 用户认证系统 - 基于用户名/密码的登录认证,使用 bcrypt 加密存储密码
  • 会话管理 - 基于 Cookie 的安全会话机制,1小时超时
  • 文件浏览 - 目录列表功能,分开展示 HTML 文件和其他文件
  • 文件下载 - 支持任意文件下载,显示文件大小
  • 用户管理 - 创建、删除、修改用户密码

安全特性

  • bcrypt 密码加密(rounds=12)
  • 安全会话 ID(secrets.token_hex)
  • HttpOnly + SameSite Cookie
  • 会话超时机制
  • 访问控制(未认证用户重定向到登录页)

安装

pip install pyfileserv

或使用 pipx 安装(推荐):

pipx install pyfileserv

使用方法

1. 创建用户

pyfileserv user create
# 或指定用户名
pyfileserv user create -u admin

2. 启动服务器

pyfileserv
# 或指定端口
pyfileserv -p 9000

命令行参数

参数 说明 默认值
-p, --port 服务器端口 8000
-d, --directory 文件服务目录 当前目录
-c, --config-dir 配置文件目录 脚本目录
-s, --static-dir 静态文件目录 脚本目录

用户管理命令

# 创建用户
pyfileserv user create [-u 用户名]

# 列出用户
pyfileserv user list

# 删除用户
pyfileserv user delete [-u 用户名]

# 修改密码
pyfileserv user passwd [-u 用户名]

示例

# 在端口 9000 启动服务器
pyfileserv -p 9000

# 指定文件服务目录
pyfileserv -d /path/to/files

# 自定义配置和静态文件目录
pyfileserv -c /etc/pyfileserv -s /var/www/files

访问

启动后访问 http://localhost:8000 或局域网 IP 地址。

项目结构

pyfileserv/
├── src/file_server/
│   ├── __init__.py      # 包入口
│   ├── __main__.py      # CLI 入口
│   ├── config.py        # 配置模块
│   ├── auth.py          # 认证模块
│   ├── templates.py     # HTML 模板
│   ├── handlers.py      # HTTP 处理器
│   ├── server.py        # 服务器启动
│   ├── cli.py           # 命令行工具
│   └── static/
│       ├── logo.svg     # Logo 图标
│       └── favicon.svg  # Favicon 图标
├── tests/
│   ├── test_auth.py     # 认证模块测试
│   └── test_config.py   # 配置模块测试
├── users.json           # 用户数据存储
├── pyproject.toml       # 项目配置
└── README.md            # 文档

开发与发布

安装开发依赖

pip install -e ".[test]"

运行测试

pytest tests/ -v

构建

pip install build
python -m build

发布到 TestPyPI

pip install twine
python -m twine upload --repository testpypi dist/*

发布到 PyPI

python -m twine upload dist/*

要求

  • Python >= 3.13
  • bcrypt >= 5.0.0

许可证

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyfileserv-0.3.0.tar.gz (26.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyfileserv-0.3.0-py3-none-any.whl (19.9 kB view details)

Uploaded Python 3

File details

Details for the file pyfileserv-0.3.0.tar.gz.

File metadata

  • Download URL: pyfileserv-0.3.0.tar.gz
  • Upload date:
  • Size: 26.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for pyfileserv-0.3.0.tar.gz
Algorithm Hash digest
SHA256 b1e345ed88cf308605297a9703a0f369db1ff88df383a8ecf019c9849e79a12e
MD5 c44eddf9c22897c803dc8b72fc9f3d74
BLAKE2b-256 82b2cf7a808a49fb6a7ed9ee4ee5cc35657aac530052405f33c6a0b2db920698

See more details on using hashes here.

File details

Details for the file pyfileserv-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: pyfileserv-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 19.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for pyfileserv-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3252211beb9a163343e9106394d0ded363561ba204abb27e02c2a3a2b0340b3e
MD5 6f13cccec162f2495f01c545873d6436
BLAKE2b-256 d603ca766cc1e015be0911cfabd520a76adaeadfd49b6990cf8e1672d20b9dd0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page