secure-http-server 0.0.1

A secure HTTP server with authentication and file management

Secure HTTP Server

A lightweight, secure HTTP server with authentication and comprehensive file management capabilities.

Features

• 🔐 HTTP Basic Authentication with user management
• 📁 Full CRUD Operations: GET, POST, PUT, DELETE
• 🛡️ Security Features: Path traversal prevention, password hashing
• 👥 Multi-user Support with role-based access
• 📂 Directory Browsing with HTML interface
• 🔧 Command-line Management for users
• 📝 Comprehensive Logging with debug mode
• 🚀 Zero External Dependencies for core functionality
• 📦 Easy Installation via pip or Debian package (Not supporeted for now!!)

Table of Contents

• Installation
  • From PyPI
  • From Source
  • Debian Package
• Quick Start
• Usage
  • Starting the Server
  • User Management
  • API Examples
• Configuration
• Security
• Development
• Testing
• Documentation
• Contributing
• License

Installation

From PyPI

pip3 install secure-http-server

From Source

git clone https://github.com/moncef007/secure-http-server.git
cd secure-http-server
pip3 install -r requirements.txt
make all

Debian Package

TODO

Quick Start

1. Start the server (default port 9000):

   secure-http-server
   

2. Access the server:

   http://localhost:9000
   

   Default credentials: admin / admin123

3. Change the default password:

   secure-http-server --manage-users
   

Usage

Starting the Server

# Basic usage (serves current directory)
secure-http-server

# Specify host and port
secure-http-server --host 0.0.0.0 --port 8080

# Serve a specific directory
secure-http-server --directory /path/to/share

# Use custom users file
secure-http-server --users-file /etc/secure-server/users.json

# Enable debug mode
secure-http-server --debug

# Show help
secure-http-server --help

User Management

Interactive Management

secure-http-server --manage-users

Command-line Management

# List all users
secure-http-server --list-users

# Add a new user
secure-http-server --add-user username password role

# Remove a user
secure-http-server --remove-user username

API Examples

Upload a File

curl -u username:password -X PUT \
  --data-binary @local-file.txt \
  http://localhost:9000/uploaded-file.txt

Download a File

curl -u username:password \
  http://localhost:9000/uploaded-file.txt \
  -o downloaded-file.txt

List Directory

curl -u username:password http://localhost:9000/

Append to File

echo "New log entry" | curl -u username:password -X POST \
  --data-binary @- \
  http://localhost:9000/logfile.txt

Delete a File

curl -u username:password -X DELETE \
  http://localhost:9000/unwanted-file.txt

Configuration

Server Options

Option	Default	Description
--host	localhost	Server bind address
--port	9000	Server port
--directory	.	Directory to serve
--users-file	users.json	Path to users database
--debug	False	Enable debug logging
--no-banner	False	Disable startup banner

Users File Format

The users file is a JSON file with the following structure:

{
  "username": {
    "password_hash": "sha256_hash_of_password",
    "role": "user|admin"
  }
}

Security

Features

• Authentication: HTTP Basic Authentication required for all operations
• Password Security: SHA-256 hashed passwords (never stored in plain text)
• Path Traversal Prevention: All paths are sanitized and restricted to the server root
• No Directory Traversal: Requests containing .. are rejected

Documentation

Available Documentation

• API Documentation: docs/API.md

Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Commit your changes (git commit -am 'Add amazing feature')
5. Push to the branch (git push origin feature/amazing-feature)
6. Create a Pull Request

Development Guidelines

• Follow PEP 8 style guide
• Update documentation as needed
• Keep commits atomic and well-described

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• Built with Python's built-in http.server module
• Thanks to all contributors and testers

Support

• Issues: GitHub Issues
• Discussions: GitHub Discussions

---