https://github.com/ahmeddelattarr/matrix
A simple, SSL-enabled server/client application written in Python using asyncio and ssl
https://github.com/ahmeddelattarr/matrix
asyncio python server ssl
Last synced: 5 months ago
JSON representation
A simple, SSL-enabled server/client application written in Python using asyncio and ssl
- Host: GitHub
- URL: https://github.com/ahmeddelattarr/matrix
- Owner: ahmeddelattarr
- License: mit
- Created: 2024-07-26T20:26:44.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-23T18:57:29.000Z (almost 2 years ago)
- Last Synced: 2024-08-23T22:07:02.845Z (almost 2 years ago)
- Topics: asyncio, python, server, ssl
- Language: Python
- Homepage:
- Size: 313 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Matrix: Secure Asyncio Server/Client
A simple, SSL-enabled server/client application written in Python using `asyncio` and `ssl`.
## Table of Contents
- [Features](#features)
- [Project Structure](#project-structure)
- [Requirements](#requirements)
- [Setup](#setup)
- [Usage](#usage)
- [Key Components](#key-components)
- [Security](#security)
- [Contributing](#contributing)
- [License](#license)
## Features
- Asynchronous server and client communication
- SSL encryption for secure data transfer
- JWT-based authentication
- PostgreSQL database integration
- Automatic SSL certificate generation
## Project Structure
```plaintext
src/
│
├── ssl/
│ ├── cert.pem
│ ├── key.pem
├── client.py
├── testing.py
├── openssl.cnf
├── requirements.txt
├── dbConnection.py
└── server.py
```
- `ssl/`: Contains SSL certificate (`cert.pem`) and key (`key.pem`)
- `client.py`: Asyncio-based client implementation
- `openssl.cnf`: OpenSSL configuration for certificate generation
- `requirements.txt`: Project dependencies
- `dbConnection.py`: Database connection and table initialization
- `server.py`: Main server code handling connections, JWT, and verification
- `testing.py`: Main testing, runs with `pytest`
## Requirements
- Python 3.8+
- Dependencies (installed via `requirements.txt`):
- asyncio
- ssl
- os
- subprocess
- pyjwt
- python-dotenv
- asyncpg
## Setup
1. Clone the repository:
```bash
git clone https://github.com/yourusername/matrix.git
cd matrix
```
2. Install dependencies:
```bash
bin/install
```
3. Set up environment variables:
Create a `.env` file in the project root and add:
```
DATABASE_URL=
```
## Usage
### Starting the Server
```bash
bin/start
```
### Running the Client
```bash
python client.py
```
The client will establish an SSL connection with the server, receive a JWT token, and can then send authenticated messages.
## Key Components
### SSL Certificate
The server automatically generates SSL certificates if not present in the `ssl/` directory, using the `openssl.cnf` configuration.
### JWT Authentication
- Clients receive a JWT token upon connection, valid for 1 hour
- The server verifies the JWT token with each communication
- Clients are notified upon token expiration
### Database Integration
- Utilizes Neon DB (PostgreSQL)
- Initializes connection and creates `Users` and `Messages` tables on server start
## Security
- SSL encryption ensures secure data transfer
- JWT tokens provide stateless authentication
- Automatic certificate generation enhances ease of deployment
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request. Run `ruff check` and `pytest` before pushing.
## License
This project is licensed under the [MIT License](LICENSE).