MCP Server With HTTPS And GitHub OAuth

🚀 Local MCP-Server with HTTPS and GitHub OAuth

This project is a secure local MCP server built with Node.js and Express. It supports HTTPS encryption (using self-signed certificates), GitHub OAuth authentication, and additional security measures such as rate limiting and HTTP header protection.

🚀 Quick Start

Prerequisites

Before you start, make sure the following are installed:

• Node.js (v16 or higher)
• npm (comes with Node.js)
• OpenSSL (for generating SSL certificates)

Setup Instructions

Step 1: Clone the Repository

Clone this repository to your local machine:

git clone https://github.com/omar-steam/MCP-Server-with-HTTPS-and-GitHub-OAuth.git
cd mcp-server

Step 2: Install Dependencies

Install the required npm packages:

npm install

Step 3: Generate SSL Certificates

Use OpenSSL to generate self-signed SSL certificates:

openssl genrsa -out key.pem 2048
openssl req -new -key key.pem -out csr.pem
openssl x509 -req -days 365 -in csr.pem -signkey key.pem -out cert.pem

This will create the following files in the project directory:

• key.pem: Private key
• cert.pem: Self-signed certificate

Step 4: Configure Environment Variables

Create a .env file in the project root directory and add the following variables:

CLIENT_ID=your-github-client-id
CLIENT_SECRET=your-github-client-secret
REDIRECT_URI=https://localhost:3000/auth/callback
SESSION_SECRET=your-session-secret

Replace your-github-client-id and your-github-client-secret with the credentials obtained from your GitHub OAuth App.

Step 5: Start the Server

Run the server:

node server.js

You should see the following output:

Secure server running at https://localhost:3000

✨ Features

• HTTPS Encryption: Ensures secure communication between the client and the server.
• GitHub OAuth Authentication: Allows users to log in using their GitHub accounts.
• Rate Limiting: Prevents abuse and Denial of Service (DoS) attacks.
• Secure Session Management: Uses express-session and secure cookies.
• HTTP Header Protection: Uses helmet to protect against common vulnerabilities.

💻 Usage Examples

Access the Server

Open your browser and visit:

https://localhost:3000

Authenticate via GitHub

1. Visit /auth to start the GitHub authentication process:

https://localhost:3000/auth

2. After completing the authentication, you will be redirected to http://localhost:3000/callback.

Using Protected Routes

Run the following command in the terminal to access protected routes:

curl -X POST http://localhost:3000/protected --user user:password

📚 Documentation

Project Structure

• index.js: The main server file.
• routes/api.js: Defines API routes.
• public/index.html: A simple HTML page for testing.

Troubleshooting

Port in Use

If you encounter a port in use issue, try changing the port:

node server.js 3001

Then update the port settings in the .env file.

SSL Certificate Warnings

Accept the certificate in the console to continue accessing the HTTPS link.

🤝 Contributing

We welcome any contributions! Please fork this repository and read our CONTRIBUTING.md before submitting a Pull Request.

📄 License

This project is licensed under the MIT License.

🙏 Acknowledgments

• Express.js
• Passport.js
• GitHub API

⚠️ Important Note

Please replace placeholders such as your-github-client-id and your-github-client-secret. If you host this code, please update the repository URL.