MCP Server With HTTPS And GitHub OAuth

🚀 本地 MCP-Server 帶 HTTPS 和 GitHub OAuth

本項目是一個安全的本地 MCP 服務器，基於 Node.js 和 Express 構建。它支持 HTTPS 加密（採用自簽名證書）、GitHub OAuth 身份驗證，還具備速率限制和 HTTP 頭保護等額外安全措施，保障服務器的穩定與安全。

🚀 快速開始

本項目是一個安全的本地 MCP 服務器，使用 Node.js 和 Express 構建。它支持 HTTPS 加密（使用自簽名證書）、GitHub OAuth 身份驗證以及速率限制和 HTTP 頭保護等額外的安全措施。

✨ 主要特性

• HTTPS 加密：確保客戶端與服務器之間的通信安全。
• GitHub OAuth 身份驗證：允許用戶使用其 GitHub 帳戶登錄。
• 速率限制：防止濫用和拒絕服務（DoS）攻擊。
• 安全會話管理：使用 express-session 和安全的 cookie。
• HTTP 頭保護：使用 helmet 保護常見漏洞。

📦 安裝指南

先決條件

在開始之前，請確保以下內容已安裝：

• Node.js（v16 或更高版本）
• npm（隨 Node.js 提供）
• OpenSSL（用於生成 SSL 證書）

安裝步驟

步驟 1：克隆倉庫

將此倉庫克隆到本地機器：

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

步驟 2：安裝依賴項

安裝所需的 npm 包：

npm install

步驟 3：生成 SSL 證書

使用 OpenSSL 生成自簽名 SSL 證書：

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

這將在項目目錄中創建以下文件：

• key.pem：私鑰
• cert.pem：自簽名證書

步驟 4：配置環境變量

在項目根目錄下創建一個 .env 文件，並添加以下變量：

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

將 your-github-client-id 和 your-github-client-secret 替換為從您的 GitHub OAuth App 獲取的憑證。

步驟 5：啟動服務器

運行服務器：

node server.js

您應該看到以下輸出：

安全服務器在 https://localhost:3000 運行

💻 使用示例

基礎用法

訪問服務器

打開瀏覽器並訪問：

https://localhost:3000

通過 GitHub 身份驗證

1. 訪問 /auth 開始 GitHub 身份驗證流程：

https://localhost:3000/auth

2. 完成身份驗證後，您將重定向到 http://localhost:3000/callback。

受保護路由使用說明

在終端中運行以下命令以訪問受保護路由：

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

📚 詳細文檔

項目結構

• index.js：主服務器文件。
• routes/api.js：定義 API 路由。
• public/index.html：簡單的 HTML 頁面用於測試。

故障排除

端口被佔用

如果遇到端口被佔用的問題，請嘗試更換端口：

node server.js 3001

然後在 .env 文件中更新端口設置。

SSL 證書警告

在控制檯中接受證書以繼續訪問 HTTPS 鏈接。

🤝 貢獻指南

我們歡迎任何貢獻！請 fork 此倉庫並在提交 Pull Request 前閱讀我們的 CONTRIBUTING.md。

📄 許可證

本項目由 MIT 許可證授權。

👏 鳴謝

• Express.js
• Passport.js
• GitHub API

⚠️ 重要提示

請替換佔位符，例如 your-github-client-id 和 your-github-client-secret。如果您託管此代碼，請更新倉庫 URL。