Compare commits
42
Commits
old
..
10537855f6
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
10537855f6 | ||
|
|
3a5f477914 | ||
|
|
de9852e374 | ||
|
|
5440da0bdf | ||
|
|
40d9999a80 | ||
|
|
5887771a38 | ||
|
|
55e04f0a7c | ||
|
|
1df6c42b41 | ||
|
|
1ba6f903d9 | ||
|
|
8faf56f9ad | ||
|
|
d1059905c6 | ||
|
|
6e488ca352 | ||
|
|
dd356b0d13 | ||
|
|
1a77623e4d | ||
|
|
8d7564185f | ||
|
|
e1da46d61b | ||
|
|
86d6e5a61d | ||
|
|
5d580d68f6 | ||
|
|
2308d183e9 | ||
|
|
67891e5222 | ||
|
|
04cfd42b4b | ||
|
|
d612003f32 | ||
|
|
8ded841d44 | ||
|
|
76fa9a8db1 | ||
|
|
005bf87df5 | ||
|
|
aa8883c822 | ||
|
|
53994f99dc | ||
|
|
0f8b9b444b | ||
|
|
90ca36f426 | ||
|
|
5691cebc11 | ||
|
|
f1c9655748 | ||
|
|
4fe20615d3 | ||
|
|
d32c17a5da | ||
|
|
729746b0bd | ||
|
|
152bfb316b | ||
|
|
369ccdbfc0 | ||
|
|
a419dd498f | ||
|
|
b4b0ccdac6 | ||
|
|
32664c3a10 | ||
|
|
41ce94c85c | ||
|
|
397eddf299 | ||
|
|
8affb90308 |
No files matched your search
@@ -1,72 +0,0 @@
|
||||
# studspider Environment Configuration
|
||||
|
||||
# ============================================================================
|
||||
# Square API Configuration
|
||||
# ============================================================================
|
||||
|
||||
# Environment: "production" or "sandbox"
|
||||
SQUARE_ENV=sandbox
|
||||
|
||||
# Sandbox credentials
|
||||
SANDBOX_SQUARE_APP_ID=your_sandbox_app_id
|
||||
SANDBOX_SQUARE_TOKEN=your_sandbox_access_token
|
||||
|
||||
# Production credentials
|
||||
PROD_SQUARE_APP_ID=your_production_app_id
|
||||
PROD_SQUARE_TOKEN=your_production_access_token
|
||||
|
||||
# Square LEGO category ID (find this in Square Dashboard)
|
||||
SQUARE_LEGO_CAT_ID=your_lego_category_id
|
||||
|
||||
# ============================================================================
|
||||
# Brickset API Configuration
|
||||
# ============================================================================
|
||||
|
||||
BRICKSET_USERNAME=your_brickset_username
|
||||
BRICKSET_PASS=your_brickset_password
|
||||
BRICKSET_API_KEY=your_brickset_api_key
|
||||
|
||||
# ============================================================================
|
||||
# SSL Certificate Configuration (Optional)
|
||||
# ============================================================================
|
||||
|
||||
# NOTE: Only needed if running HTTPS directly (not recommended with nginx)
|
||||
# For nginx reverse proxy setup, leave these empty
|
||||
|
||||
# Path to SSL certificate in PEM format
|
||||
# SSL_CERT_PATH=/path/to/cert.pem
|
||||
|
||||
# Path to SSL private key in PEM format
|
||||
# SSL_KEY_PATH=/path/to/key.pem
|
||||
|
||||
# ============================================================================
|
||||
# Square Webhook Certificate (P7B Format)
|
||||
# ============================================================================
|
||||
|
||||
# Path to P7B certificate file for Square webhook signature verification
|
||||
# This file is UPLOADED to Square Dashboard, not used by your server
|
||||
# Generate with: python convert_to_p7b.py
|
||||
SQUARE_P7B_PATH=./cert.p7b
|
||||
|
||||
# ============================================================================
|
||||
# Server Configuration (Optional)
|
||||
# ============================================================================
|
||||
|
||||
# Default host and port (can override with command line args)
|
||||
# SERVER_HOST=0.0.0.0
|
||||
# SERVER_PORT=7432
|
||||
# SERVER_HOOK_PORT=8080
|
||||
|
||||
# ============================================================================
|
||||
# Usage Examples
|
||||
# ============================================================================
|
||||
|
||||
# Basic HTTP server (recommended with nginx):
|
||||
# python src/test_server.py
|
||||
#
|
||||
# With SSL from .env:
|
||||
# Set SSL_CERT_PATH and SSL_KEY_PATH above, then:
|
||||
# python src/test_server.py --hook-port 8443 --hook-ssl-only
|
||||
#
|
||||
# Override SSL from command line:
|
||||
# python src/test_server.py --ssl-cert /custom/cert.pem --ssl-key /custom/key.pem
|
||||
@@ -35,6 +35,4 @@ assets/external/
|
||||
__pycache__/
|
||||
win/
|
||||
.github/
|
||||
bin/
|
||||
activate/
|
||||
build/
|
||||
@@ -1,136 +0,0 @@
|
||||
# Understanding PEM vs P7B Certificates
|
||||
|
||||
## Quick Summary
|
||||
|
||||
**You CANNOT use P7B files to run your HTTPS server!**
|
||||
|
||||
- **PEM files** = Run your server with HTTPS ✓
|
||||
- **P7B files** = Upload to Square Dashboard ✓
|
||||
|
||||
## The Complete Picture
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ Your HTTPS Server │
|
||||
│ │
|
||||
│ Uses: cert.pem + key.pem (PEM format) │
|
||||
│ Command: python src/test_server.py │
|
||||
│ --ssl-cert cert.pem │
|
||||
│ --ssl-key key.pem │
|
||||
│ --hook-port 8443 │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
│
|
||||
│ HTTPS traffic
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ Square's Servers │
|
||||
│ │
|
||||
│ They verify your server using: cert.p7b │
|
||||
│ (which YOU upload to Square Dashboard) │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
## Why Two Formats?
|
||||
|
||||
### PEM Format (.pem files)
|
||||
- **Contains**: Certificate AND private key (separate files)
|
||||
- **Used by**: Your HTTPS server to encrypt traffic
|
||||
- **Files needed**:
|
||||
- `cert.pem` - Your public certificate
|
||||
- `key.pem` - Your private key (NEVER share this!)
|
||||
|
||||
### P7B Format (.p7b files)
|
||||
- **Contains**: Certificate ONLY (no private key)
|
||||
- **Used by**: Square to verify webhook signatures
|
||||
- **File**: `cert.p7b` - Uploaded to Square Dashboard
|
||||
|
||||
## Step-by-Step Workflow
|
||||
|
||||
### 1. Generate Certificates (PEM format)
|
||||
```powershell
|
||||
python generate_cert.py
|
||||
```
|
||||
**Creates:**
|
||||
- `cert.pem` - Your certificate (public)
|
||||
- `key.pem` - Your private key (secret!)
|
||||
|
||||
### 2. Start Your HTTPS Server (uses PEM)
|
||||
```powershell
|
||||
python src/test_server.py --ssl-cert cert.pem --ssl-key key.pem --hook-port 8443 --hook-ssl-only
|
||||
```
|
||||
**Server runs at:**
|
||||
- `https://localhost:8443/hook`
|
||||
|
||||
### 3. Convert Certificate to P7B for Square
|
||||
```powershell
|
||||
python convert_to_p7b.py
|
||||
```
|
||||
**Creates:**
|
||||
- `cert.p7b` - Certificate in P7B format (for Square)
|
||||
|
||||
### 4. Upload P7B to Square
|
||||
1. Go to: https://developer.squareup.com/apps
|
||||
2. Your App → **Webhooks** → **Manage Notification Settings**
|
||||
3. Upload `cert.p7b`
|
||||
|
||||
### 5. Configure Square Webhook URL
|
||||
- Enter: `https://yourdomain.com:8443/hook`
|
||||
- Square will verify using the P7B you uploaded
|
||||
|
||||
## Common Mistakes
|
||||
|
||||
### ❌ Trying to use P7B with your server
|
||||
```powershell
|
||||
# THIS WON'T WORK!
|
||||
python src/test_server.py --ssl-cert cert.p7b --ssl-key key.p7b
|
||||
```
|
||||
**Error:** P7B doesn't contain the private key needed for HTTPS!
|
||||
|
||||
### ✓ Correct usage
|
||||
```powershell
|
||||
# Server uses PEM files
|
||||
python src/test_server.py --ssl-cert cert.pem --ssl-key key.pem --hook-port 8443
|
||||
|
||||
# P7B file is uploaded to Square Dashboard (not used by your server)
|
||||
```
|
||||
|
||||
## If You Only Have a P7B File
|
||||
|
||||
If someone gave you a P7B file, you can extract the certificate:
|
||||
|
||||
```powershell
|
||||
python convert_from_p7b.py your_cert.p7b --output cert.pem
|
||||
```
|
||||
|
||||
**BUT:** You still need the private key (`key.pem`) to run HTTPS!
|
||||
|
||||
If you don't have the private key, you must:
|
||||
1. Generate a new certificate pair: `python generate_cert.py`
|
||||
2. Or get the private key from whoever created the P7B
|
||||
|
||||
## File Checklist
|
||||
|
||||
To run your HTTPS server with Square webhooks, you need:
|
||||
|
||||
- [ ] `cert.pem` - Certificate (PEM format) - For your server
|
||||
- [ ] `key.pem` - Private key (PEM format) - For your server
|
||||
- [ ] `cert.p7b` - Certificate (P7B format) - Upload to Square
|
||||
|
||||
Generate all three with:
|
||||
```powershell
|
||||
python generate_cert.py # Creates cert.pem and key.pem
|
||||
python convert_to_p7b.py # Creates cert.p7b from cert.pem
|
||||
```
|
||||
|
||||
## Security Notes
|
||||
|
||||
- **Never share `key.pem`** - This is your private key!
|
||||
- **`cert.pem` is public** - Safe to share
|
||||
- **`cert.p7b` is public** - You upload this to Square
|
||||
- Self-signed certificates are fine for testing but use Let's Encrypt for production
|
||||
|
||||
## Need Help?
|
||||
|
||||
See the detailed guides:
|
||||
- `HTTPS_SETUP.md` - Complete HTTPS setup instructions
|
||||
- `SQUARE_WEBHOOK_SETUP.md` - Square webhook configuration
|
||||
@@ -1,166 +0,0 @@
|
||||
# HTTPS Webhook Setup Guide
|
||||
|
||||
## Quick Start (Self-Signed Certificate for Testing)
|
||||
|
||||
### 1. Generate Certificate
|
||||
```powershell
|
||||
python generate_cert.py
|
||||
```
|
||||
|
||||
This creates `cert.pem` and `key.pem` files.
|
||||
|
||||
### 1.5. Convert to P7B for Square (Required for Square Webhooks)
|
||||
```powershell
|
||||
python convert_to_p7b.py
|
||||
```
|
||||
|
||||
This creates `cert.p7b` which Square needs for webhook signature verification.
|
||||
Upload this P7B file to Square Developer Dashboard → Webhooks → Manage Notification Settings.
|
||||
|
||||
### 2. Run Server with HTTPS
|
||||
|
||||
#### Option A: HTTPS for webhook only (recommended for development)
|
||||
```powershell
|
||||
python src/test_server.py --ssl-cert cert.pem --ssl-key key.pem --hook-port 8443 --hook-ssl-only
|
||||
```
|
||||
- Main server: `http://localhost:7432/` (HTTP)
|
||||
- Webhook: `https://localhost:8443/hook` (HTTPS)
|
||||
|
||||
#### Option B: HTTPS for everything
|
||||
```powershell
|
||||
python src/test_server.py --ssl-cert cert.pem --ssl-key key.pem --hook-port 8443
|
||||
```
|
||||
- Main server: `https://localhost:7432/` (HTTPS)
|
||||
- Webhook: `https://localhost:8443/hook` (HTTPS)
|
||||
|
||||
#### Option C: Single port with HTTPS
|
||||
```powershell
|
||||
python src/test_server.py --ssl-cert cert.pem --ssl-key key.pem
|
||||
```
|
||||
- Everything on: `https://localhost:7432/`
|
||||
|
||||
### 3. Test the Webhook
|
||||
|
||||
Update `src/test_webhook.py` to use HTTPS:
|
||||
```python
|
||||
url = "https://localhost:8443/hook"
|
||||
```
|
||||
|
||||
Then run:
|
||||
```powershell
|
||||
python src/test_webhook.py
|
||||
```
|
||||
|
||||
## Production Setup (with Real Certificate)
|
||||
|
||||
### Option 1: Let's Encrypt (Free, Recommended)
|
||||
|
||||
On Linux/WSL:
|
||||
```bash
|
||||
# Install certbot
|
||||
sudo apt-get install certbot
|
||||
|
||||
# Generate certificate (replace yourdomain.com)
|
||||
sudo certbot certonly --standalone -d yourdomain.com
|
||||
|
||||
# Certificates will be at:
|
||||
# /etc/letsencrypt/live/yourdomain.com/fullchain.pem
|
||||
# /etc/letsencrypt/live/yourdomain.com/privkey.pem
|
||||
|
||||
# Run server
|
||||
python src/test_server.py \
|
||||
--ssl-cert /etc/letsencrypt/live/yourdomain.com/fullchain.pem \
|
||||
--ssl-key /etc/letsencrypt/live/yourdomain.com/privkey.pem \
|
||||
--host 0.0.0.0 \
|
||||
--hook-port 443 \
|
||||
--hook-ssl-only
|
||||
```
|
||||
|
||||
### Option 2: Reverse Proxy (nginx/Caddy)
|
||||
|
||||
Run studspider on HTTP internally, use nginx/Caddy for HTTPS:
|
||||
|
||||
```nginx
|
||||
# nginx config
|
||||
server {
|
||||
listen 443 ssl;
|
||||
server_name yourdomain.com;
|
||||
|
||||
ssl_certificate /path/to/cert.pem;
|
||||
ssl_certificate_key /path/to/key.pem;
|
||||
|
||||
location /hook {
|
||||
proxy_pass http://localhost:7432/hook;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Then run studspider normally:
|
||||
```powershell
|
||||
python src/test_server.py
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### "OpenSSL not found" Error
|
||||
- **Windows**: Install from https://slproweb.com/products/Win32OpenSSL.html
|
||||
- **Alternative**: Use Git Bash or WSL which include OpenSSL
|
||||
|
||||
### Self-Signed Certificate Warnings
|
||||
- Normal for development
|
||||
- Use `--insecure` flag with curl/tools for testing
|
||||
- For production, get a proper certificate from Let's Encrypt
|
||||
|
||||
### Port 443 Already in Use
|
||||
- Use a different port like 8443
|
||||
- Or stop the service using port 443
|
||||
|
||||
### Certificate File Not Found
|
||||
- Use absolute paths: `--ssl-cert C:\path\to\cert.pem`
|
||||
- Or run from the directory containing the certificates
|
||||
|
||||
## Square Webhook Configuration
|
||||
|
||||
### Certificate Requirements
|
||||
Square requires a **P7B (PKCS#7)** certificate file for webhook signature verification.
|
||||
|
||||
### Setup Steps:
|
||||
|
||||
1. **Generate your certificate** (if you haven't already):
|
||||
```powershell
|
||||
python generate_cert.py
|
||||
```
|
||||
|
||||
2. **Convert PEM to P7B format**:
|
||||
```powershell
|
||||
# Basic conversion
|
||||
python convert_to_p7b.py
|
||||
|
||||
# With intermediate certificates (production)
|
||||
python convert_to_p7b.py --cert fullchain.pem --chain intermediate.pem --output square.p7b
|
||||
```
|
||||
|
||||
3. **Upload to Square Dashboard**:
|
||||
- Go to https://developer.squareup.com/
|
||||
- Navigate to your application
|
||||
- Click on "Webhooks"
|
||||
- Click "Manage Notification Settings"
|
||||
- Upload the `cert.p7b` file
|
||||
- Square will use this to verify webhook signatures
|
||||
|
||||
4. **Configure webhook URL in Square**:
|
||||
- Use your public HTTPS URL: `https://yourdomain.com:8443/hook`
|
||||
- Square requires valid SSL (not self-signed for production)
|
||||
|
||||
### Testing with Square Webhooks:
|
||||
|
||||
When setting up webhooks in Square Dashboard:
|
||||
1. Use your HTTPS URL: `https://yourdomain.com:8443/hook`
|
||||
2. Square requires valid SSL (not self-signed)
|
||||
3. Consider using ngrok for local testing:
|
||||
```powershell
|
||||
ngrok http 8443
|
||||
```
|
||||
Then use the ngrok HTTPS URL in Square Dashboard
|
||||
@@ -1,356 +0,0 @@
|
||||
# Nginx Reverse Proxy Configuration for studspider
|
||||
|
||||
## Overview
|
||||
|
||||
When using nginx as a reverse proxy:
|
||||
- **Nginx handles HTTPS** (SSL/TLS termination)
|
||||
- **studspider runs on HTTP** internally (no SSL needed)
|
||||
- **nginx forwards requests** to studspider
|
||||
|
||||
## Architecture
|
||||
|
||||
```
|
||||
Internet (HTTPS) → nginx (443) → studspider (7432/HTTP)
|
||||
↓
|
||||
Handles SSL certificates
|
||||
Handles HTTPS traffic
|
||||
Forwards to HTTP backend
|
||||
```
|
||||
|
||||
## Benefits
|
||||
|
||||
✓ **No SSL certificates needed in studspider**
|
||||
✓ **nginx handles SSL efficiently**
|
||||
✓ **Easy certificate renewal** (Let's Encrypt)
|
||||
✓ **Better performance** (nginx is optimized for this)
|
||||
✓ **Additional security** (rate limiting, IP filtering, etc.)
|
||||
|
||||
---
|
||||
|
||||
## Configuration Examples
|
||||
|
||||
### Basic Configuration (HTTP → HTTPS redirect + webhook proxy)
|
||||
|
||||
Create `/etc/nginx/sites-available/studspider`:
|
||||
|
||||
```nginx
|
||||
# Redirect HTTP to HTTPS
|
||||
server {
|
||||
listen 80;
|
||||
server_name studspider.sh www.studspider.sh;
|
||||
|
||||
location / {
|
||||
return 301 https://$host$request_uri;
|
||||
}
|
||||
}
|
||||
|
||||
# HTTPS server
|
||||
server {
|
||||
listen 443 ssl http2;
|
||||
server_name studspider.sh www.studspider.sh;
|
||||
|
||||
# SSL certificates (Let's Encrypt)
|
||||
ssl_certificate /etc/letsencrypt/live/studspider.sh/fullchain.pem;
|
||||
ssl_certificate_key /etc/letsencrypt/live/studspider.sh/privkey.pem;
|
||||
|
||||
# SSL configuration (modern, secure)
|
||||
ssl_protocols TLSv1.2 TLSv1.3;
|
||||
ssl_ciphers HIGH:!aNULL:!MD5;
|
||||
ssl_prefer_server_ciphers on;
|
||||
|
||||
# Logs
|
||||
access_log /var/log/nginx/studspider_access.log;
|
||||
error_log /var/log/nginx/studspider_error.log;
|
||||
|
||||
# Webhook endpoint (Square webhooks)
|
||||
location /hook {
|
||||
proxy_pass http://localhost:7432/hook;
|
||||
|
||||
# Forward headers
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
|
||||
# Timeouts
|
||||
proxy_connect_timeout 60s;
|
||||
proxy_send_timeout 60s;
|
||||
proxy_read_timeout 60s;
|
||||
|
||||
# Disable buffering for real-time responses
|
||||
proxy_buffering off;
|
||||
}
|
||||
|
||||
# Main API endpoint (optional)
|
||||
location / {
|
||||
proxy_pass http://localhost:7432/;
|
||||
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Separate Port Configuration (webhook on different port)
|
||||
|
||||
```nginx
|
||||
server {
|
||||
listen 443 ssl http2;
|
||||
server_name studspider.sh;
|
||||
|
||||
ssl_certificate /etc/letsencrypt/live/studspider.sh/fullchain.pem;
|
||||
ssl_certificate_key /etc/letsencrypt/live/studspider.sh/privkey.pem;
|
||||
|
||||
# Main API
|
||||
location / {
|
||||
proxy_pass http://localhost:7432/;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto https;
|
||||
}
|
||||
}
|
||||
|
||||
# Separate server for webhooks on different port
|
||||
server {
|
||||
listen 8443 ssl http2;
|
||||
server_name studspider.sh;
|
||||
|
||||
ssl_certificate /etc/letsencrypt/live/studspider.sh/fullchain.pem;
|
||||
ssl_certificate_key /etc/letsencrypt/live/studspider.sh/privkey.pem;
|
||||
|
||||
# Webhook only
|
||||
location /hook {
|
||||
proxy_pass http://localhost:8080/hook; # studspider webhook port
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto https;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### With Rate Limiting (recommended for webhooks)
|
||||
|
||||
```nginx
|
||||
# Define rate limit zone (outside server block)
|
||||
limit_req_zone $binary_remote_addr zone=webhook_limit:10m rate=10r/s;
|
||||
|
||||
server {
|
||||
listen 443 ssl http2;
|
||||
server_name studspider.sh;
|
||||
|
||||
ssl_certificate /etc/letsencrypt/live/studspider.sh/fullchain.pem;
|
||||
ssl_certificate_key /etc/letsencrypt/live/studspider.sh/privkey.pem;
|
||||
|
||||
# Webhook with rate limiting
|
||||
location /hook {
|
||||
# Rate limit: 10 requests per second per IP
|
||||
limit_req zone=webhook_limit burst=20 nodelay;
|
||||
|
||||
# Only allow POST requests
|
||||
limit_except POST {
|
||||
deny all;
|
||||
}
|
||||
|
||||
proxy_pass http://localhost:7432/hook;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto https;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Setup Steps
|
||||
|
||||
### 1. Install nginx (if not already installed)
|
||||
|
||||
```bash
|
||||
# Ubuntu/Debian
|
||||
sudo apt update
|
||||
sudo apt install nginx
|
||||
|
||||
# CentOS/RHEL
|
||||
sudo yum install nginx
|
||||
```
|
||||
|
||||
### 2. Get SSL Certificate (Let's Encrypt - Free!)
|
||||
|
||||
```bash
|
||||
# Install certbot
|
||||
sudo apt install certbot python3-certbot-nginx
|
||||
|
||||
# Get certificate for your domain
|
||||
sudo certbot --nginx -d studspider.sh -d www.studspider.sh
|
||||
|
||||
# Certbot will automatically:
|
||||
# 1. Generate certificate
|
||||
# 2. Configure nginx
|
||||
# 3. Set up auto-renewal
|
||||
```
|
||||
|
||||
### 3. Create nginx Configuration
|
||||
|
||||
```bash
|
||||
# Create config file
|
||||
sudo nano /etc/nginx/sites-available/studspider
|
||||
|
||||
# Paste one of the configurations above
|
||||
|
||||
# Create symbolic link to enable site
|
||||
sudo ln -s /etc/nginx/sites-available/studspider /etc/nginx/sites-enabled/
|
||||
|
||||
# Test configuration
|
||||
sudo nginx -t
|
||||
|
||||
# Reload nginx
|
||||
sudo systemctl reload nginx
|
||||
```
|
||||
|
||||
### 4. Start studspider (HTTP only, no SSL needed!)
|
||||
|
||||
```bash
|
||||
# Simple - single port
|
||||
python src/test_server.py --port 7432
|
||||
|
||||
# Or with separate webhook port
|
||||
python src/test_server.py --port 7432 --hook-port 8080
|
||||
```
|
||||
|
||||
### 5. Configure Square Webhook URL
|
||||
|
||||
In Square Developer Dashboard:
|
||||
- **Webhook URL**: `https://studspider.sh/hook`
|
||||
- **Certificate**: Upload the P7B file (see below)
|
||||
|
||||
### 6. Generate P7B for Square
|
||||
|
||||
```bash
|
||||
# Convert your Let's Encrypt certificate to P7B for Square
|
||||
python convert_to_p7b.py --cert /etc/letsencrypt/live/studspider.sh/fullchain.pem --output square.p7b
|
||||
|
||||
# Upload square.p7b to Square Dashboard
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Systemd Service (Run studspider at boot)
|
||||
|
||||
Create `/etc/systemd/system/studspider.service`:
|
||||
|
||||
```ini
|
||||
[Unit]
|
||||
Description=studspider - LEGO Inventory Sync Service
|
||||
After=network.target
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
User=www-data
|
||||
WorkingDirectory=/opt/studspider
|
||||
Environment="PATH=/opt/studspider/.venv/bin"
|
||||
ExecStart=/opt/studspider/.venv/bin/python src/test_server.py --port 7432
|
||||
Restart=always
|
||||
RestartSec=10
|
||||
|
||||
# Logging
|
||||
StandardOutput=append:/var/log/studspider/stdout.log
|
||||
StandardError=append:/var/log/studspider/stderr.log
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
```
|
||||
|
||||
Enable and start:
|
||||
|
||||
```bash
|
||||
# Create log directory
|
||||
sudo mkdir -p /var/log/studspider
|
||||
sudo chown www-data:www-data /var/log/studspider
|
||||
|
||||
# Enable service
|
||||
sudo systemctl enable studspider
|
||||
|
||||
# Start service
|
||||
sudo systemctl start studspider
|
||||
|
||||
# Check status
|
||||
sudo systemctl status studspider
|
||||
|
||||
# View logs
|
||||
sudo journalctl -u studspider -f
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Testing
|
||||
|
||||
### Test nginx configuration
|
||||
```bash
|
||||
sudo nginx -t
|
||||
```
|
||||
|
||||
### Test studspider locally
|
||||
```bash
|
||||
curl http://localhost:7432/hook -X POST -H "Content-Type: application/json" -d '{"test":"data"}'
|
||||
```
|
||||
|
||||
### Test through nginx
|
||||
```bash
|
||||
curl https://studspider.sh/hook -X POST -H "Content-Type: application/json" -d '{"test":"data"}'
|
||||
```
|
||||
|
||||
### Monitor logs
|
||||
```bash
|
||||
# nginx logs
|
||||
sudo tail -f /var/log/nginx/studspider_access.log
|
||||
sudo tail -f /var/log/nginx/studspider_error.log
|
||||
|
||||
# studspider logs
|
||||
tail -f ./logs/studspider.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### 502 Bad Gateway
|
||||
- Check if studspider is running: `ps aux | grep test_server.py`
|
||||
- Check the port matches nginx config
|
||||
- Check firewall isn't blocking internal connections
|
||||
|
||||
### Certificate Errors
|
||||
- Ensure Let's Encrypt renewal is working: `sudo certbot renew --dry-run`
|
||||
- Check certificate files exist and have correct permissions
|
||||
|
||||
### Webhook Not Receiving
|
||||
- Verify nginx is forwarding: Check nginx access logs
|
||||
- Verify studspider is receiving: Check studspider logs
|
||||
- Test locally first, then through nginx
|
||||
|
||||
### Connection Refused
|
||||
- Check studspider is listening: `sudo netstat -tlnp | grep 7432`
|
||||
- Check nginx proxy_pass points to correct host:port
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
### With nginx reverse proxy:
|
||||
|
||||
✓ **studspider runs simple HTTP** (no SSL certificates needed)
|
||||
```bash
|
||||
python src/test_server.py --port 7432
|
||||
```
|
||||
|
||||
✓ **nginx handles HTTPS** (manages certificates automatically)
|
||||
|
||||
✓ **Square gets HTTPS webhook** (`https://studspider.sh/hook`)
|
||||
|
||||
✓ **You upload P7B to Square** (converted from nginx's certificate)
|
||||
|
||||
### This is the recommended production setup!
|
||||
@@ -1,191 +0,0 @@
|
||||
# Square Webhook Setup - Quick Reference
|
||||
|
||||
## Complete Setup Process
|
||||
|
||||
### Step 1: Generate SSL Certificate
|
||||
```powershell
|
||||
# Generate PEM certificate
|
||||
python generate_cert.py
|
||||
# Creates: cert.pem, key.pem
|
||||
```
|
||||
|
||||
### Step 2: Convert to P7B for Square
|
||||
```powershell
|
||||
# Convert PEM to P7B (PKCS#7) format
|
||||
python convert_to_p7b.py
|
||||
# Creates: cert.p7b
|
||||
```
|
||||
|
||||
### Step 3: Start HTTPS Server
|
||||
```powershell
|
||||
# Start webhook server with HTTPS
|
||||
python src/test_server.py --ssl-cert cert.pem --ssl-key key.pem --hook-port 8443 --hook-ssl-only
|
||||
|
||||
# Server URLs:
|
||||
# Main: http://localhost:7432/
|
||||
# Webhook: https://localhost:8443/hook (or https://yourdomain.com:8443/hook)
|
||||
```
|
||||
|
||||
### Step 4: Configure Square Webhook
|
||||
|
||||
1. **Upload P7B Certificate to Square:**
|
||||
- Go to: https://developer.squareup.com/apps
|
||||
- Select your application
|
||||
- Navigate to: **Webhooks** → **Manage Notification Settings**
|
||||
- Upload `cert.p7b` file
|
||||
- This allows Square to verify webhook signatures
|
||||
|
||||
2. **Add Webhook Subscription:**
|
||||
- Still in Webhooks section
|
||||
- Click **"Add Subscription"**
|
||||
- Enter URL: `https://yourdomain.com:8443/hook`
|
||||
- Select events to subscribe to (e.g., `inventory.count.updated`)
|
||||
- Click **Save**
|
||||
|
||||
### Step 5: Test the Webhook
|
||||
|
||||
```powershell
|
||||
# Test from command line
|
||||
python src/test_webhook.py
|
||||
|
||||
# Or manually with curl
|
||||
curl -X POST https://localhost:8443/hook \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"type":"inventory.count.updated","merchant_id":"test"}'
|
||||
```
|
||||
|
||||
## Production Deployment
|
||||
|
||||
### Using Let's Encrypt (Recommended)
|
||||
|
||||
```bash
|
||||
# 1. Get Let's Encrypt certificate (Linux/WSL)
|
||||
sudo certbot certonly --standalone -d yourdomain.com
|
||||
|
||||
# 2. Convert to P7B for Square
|
||||
python convert_to_p7b.py \
|
||||
--cert /etc/letsencrypt/live/yourdomain.com/fullchain.pem \
|
||||
--output square.p7b
|
||||
|
||||
# 3. Upload square.p7b to Square Dashboard
|
||||
|
||||
# 4. Run server
|
||||
python src/test_server.py \
|
||||
--ssl-cert /etc/letsencrypt/live/yourdomain.com/fullchain.pem \
|
||||
--ssl-key /etc/letsencrypt/live/yourdomain.com/privkey.pem \
|
||||
--host 0.0.0.0 \
|
||||
--hook-port 443 \
|
||||
--hook-ssl-only
|
||||
```
|
||||
|
||||
### Using ngrok (Easy Testing)
|
||||
|
||||
```powershell
|
||||
# Terminal 1: Start your server (HTTP is fine)
|
||||
python src/test_server.py --hook-port 8080
|
||||
|
||||
# Terminal 2: Expose with ngrok (provides HTTPS automatically)
|
||||
ngrok http 8080
|
||||
|
||||
# Use the ngrok HTTPS URL in Square:
|
||||
# Example: https://abc123.ngrok.io/hook
|
||||
|
||||
# For P7B certificate with ngrok:
|
||||
# ngrok provides its own certificate, so you don't need to upload one to Square
|
||||
```
|
||||
|
||||
## Webhook Event Types
|
||||
|
||||
Common Square webhook events you can subscribe to:
|
||||
|
||||
- `inventory.count.updated` - Inventory quantity changes
|
||||
- `catalog.version.updated` - Catalog item updates
|
||||
- `payment.created` - New payment received
|
||||
- `payment.updated` - Payment status changes
|
||||
- `order.created` - New order created
|
||||
- `order.updated` - Order status changes
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Certificate Upload Fails
|
||||
- Ensure file is in P7B format (not PEM)
|
||||
- File must be valid PKCS#7 structure
|
||||
- Check file isn't corrupted: `openssl pkcs7 -print_certs -in cert.p7b`
|
||||
|
||||
### Webhook Not Receiving Data
|
||||
1. Check server is running and accessible from internet
|
||||
2. Verify URL in Square Dashboard is correct
|
||||
3. Check firewall allows incoming traffic on webhook port
|
||||
4. Review server logs: `./logs/studspider.log`
|
||||
|
||||
### SSL Certificate Errors
|
||||
- Self-signed certificates won't work with Square in production
|
||||
- Use Let's Encrypt or commercial CA for production
|
||||
- Use ngrok for quick testing (provides valid HTTPS)
|
||||
|
||||
### Testing Locally
|
||||
```powershell
|
||||
# Square can't reach localhost - use one of these:
|
||||
# 1. ngrok (easiest)
|
||||
ngrok http 8443
|
||||
|
||||
# 2. Cloudflare Tunnel
|
||||
cloudflared tunnel --url http://localhost:8443
|
||||
|
||||
# 3. Deploy to cloud (AWS, Azure, DigitalOcean, etc.)
|
||||
```
|
||||
|
||||
## Verifying Webhook Signatures
|
||||
|
||||
Square signs webhook requests. Your server should verify signatures:
|
||||
|
||||
```python
|
||||
# TODO: Add to hook_handler in test_server.py
|
||||
import hmac
|
||||
import hashlib
|
||||
|
||||
def verify_square_signature(payload: bytes, signature: str, webhook_signature_key: str) -> bool:
|
||||
"""Verify Square webhook signature"""
|
||||
computed_signature = hmac.new(
|
||||
webhook_signature_key.encode('utf-8'),
|
||||
payload,
|
||||
hashlib.sha256
|
||||
).digest()
|
||||
|
||||
expected_signature = base64.b64decode(signature)
|
||||
return hmac.compare_digest(computed_signature, expected_signature)
|
||||
```
|
||||
|
||||
Get your webhook signature key from Square Dashboard → Webhooks → Signature Key.
|
||||
|
||||
## Environment Variables
|
||||
|
||||
Add to your `.env` file:
|
||||
|
||||
```env
|
||||
# Square Webhook Configuration
|
||||
SQUARE_WEBHOOK_SIGNATURE_KEY=your_signature_key_from_square_dashboard
|
||||
|
||||
# SSL Certificate Paths (production)
|
||||
SSL_CERT_PATH=/path/to/fullchain.pem
|
||||
SSL_KEY_PATH=/path/to/privkey.pem
|
||||
```
|
||||
|
||||
## Commands Quick Reference
|
||||
|
||||
```powershell
|
||||
# Generate certificate
|
||||
python generate_cert.py
|
||||
|
||||
# Convert to P7B
|
||||
python convert_to_p7b.py
|
||||
|
||||
# Start HTTPS server
|
||||
python src/test_server.py --ssl-cert cert.pem --ssl-key key.pem --hook-port 8443 --hook-ssl-only
|
||||
|
||||
# Test webhook
|
||||
python src/test_webhook.py
|
||||
|
||||
# Start with ngrok
|
||||
ngrok http 8443
|
||||
```
|
||||
@@ -6,14 +6,6 @@ dotenv.load_dotenv()
|
||||
|
||||
LEGO_CAT_ID = os.getenv("SQUARE_LEGO_CAT_ID")
|
||||
|
||||
# SSL Certificate paths (optional - for direct HTTPS, not needed with nginx)
|
||||
SSL_CERT_PATH = os.getenv("SSL_CERT_PATH")
|
||||
SSL_KEY_PATH = os.getenv("SSL_KEY_PATH")
|
||||
|
||||
# P7B certificate for Square webhook signature verification
|
||||
# This is uploaded to Square Dashboard, not used by the server
|
||||
SQUARE_P7B_PATH = os.getenv("SQUARE_P7B_PATH")
|
||||
|
||||
if os.getenv("SQUARE_ENV") == "production":
|
||||
SQUARE_APP_ID = os.getenv("PROD_SQUARE_APP_ID")
|
||||
SQUARE_TOKEN = os.getenv("PROD_SQUARE_TOKEN")
|
||||
|
||||
@@ -1,110 +0,0 @@
|
||||
"""
|
||||
Convert P7B (PKCS#7) certificate to PEM format for use with the server
|
||||
Use this if you have a P7B file and need to extract PEM certificates
|
||||
"""
|
||||
|
||||
import subprocess
|
||||
import sys
|
||||
import os
|
||||
|
||||
|
||||
def convert_p7b_to_pem(p7b_file, cert_output="cert.pem", extract_key=False):
|
||||
"""
|
||||
Convert P7B certificate to PEM format
|
||||
|
||||
Args:
|
||||
p7b_file: Input P7B (PKCS#7) file
|
||||
cert_output: Output PEM certificate file
|
||||
extract_key: If True, try to extract private key (rarely works with P7B)
|
||||
"""
|
||||
|
||||
# Check if OpenSSL is available
|
||||
try:
|
||||
subprocess.run(["openssl", "version"], capture_output=True, check=True)
|
||||
except (subprocess.CalledProcessError, FileNotFoundError):
|
||||
print("ERROR: OpenSSL not found!")
|
||||
print("\nFor Windows, you can:")
|
||||
print(
|
||||
"1. Install OpenSSL from: https://slproweb.com/products/Win32OpenSSL.html"
|
||||
)
|
||||
print("2. Or use Git Bash which includes OpenSSL")
|
||||
print("3. Or use WSL (Windows Subsystem for Linux)")
|
||||
return False
|
||||
|
||||
# Check if input file exists
|
||||
if not os.path.exists(p7b_file):
|
||||
print(f"ERROR: P7B file not found: {p7b_file}")
|
||||
print(f"Current directory: {os.getcwd()}")
|
||||
return False
|
||||
|
||||
print(f"Converting {p7b_file} to PEM format...")
|
||||
|
||||
# Convert P7B to PEM
|
||||
cmd = ["openssl", "pkcs7", "-print_certs", "-in", p7b_file, "-out", cert_output]
|
||||
|
||||
try:
|
||||
result = subprocess.run(cmd, check=True, capture_output=True, text=True)
|
||||
|
||||
if os.path.exists(cert_output):
|
||||
print(f"\n✓ PEM certificate created: {os.path.abspath(cert_output)}")
|
||||
print(f" File size: {os.path.getsize(cert_output)} bytes")
|
||||
|
||||
# Check what was extracted
|
||||
with open(cert_output, "r") as f:
|
||||
content = f.read()
|
||||
cert_count = content.count("BEGIN CERTIFICATE")
|
||||
print(f" Certificates found: {cert_count}")
|
||||
|
||||
print("\n" + "=" * 60)
|
||||
print("IMPORTANT:")
|
||||
print("=" * 60)
|
||||
print("⚠️ P7B files usually contain ONLY certificates, not private keys!")
|
||||
print("\nTo run an HTTPS server, you need:")
|
||||
print("1. Certificate (cert.pem) - ✓ Extracted")
|
||||
print("2. Private Key (key.pem) - ✗ NOT in P7B file")
|
||||
print("\nIf you don't have the private key:")
|
||||
print("- Generate a new certificate pair: python generate_cert.py")
|
||||
print("- Or obtain the private key from your certificate provider")
|
||||
print("=" * 60)
|
||||
|
||||
return True
|
||||
else:
|
||||
print("ERROR: Output file was not created")
|
||||
return False
|
||||
|
||||
except subprocess.CalledProcessError as e:
|
||||
print(f"ERROR: Conversion failed: {e}")
|
||||
if e.stderr:
|
||||
print(f"OpenSSL error: {e.stderr}")
|
||||
return False
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
import argparse
|
||||
|
||||
parser = argparse.ArgumentParser(
|
||||
description="Convert P7B (PKCS#7) certificate to PEM format"
|
||||
)
|
||||
parser.add_argument("p7b_file", help="Input P7B certificate file")
|
||||
parser.add_argument(
|
||||
"--output",
|
||||
default="cert.pem",
|
||||
help="Output PEM certificate file (default: cert.pem)",
|
||||
)
|
||||
|
||||
args = parser.parse_args()
|
||||
|
||||
print("=" * 60)
|
||||
print("P7B to PEM Certificate Converter")
|
||||
print("=" * 60)
|
||||
print()
|
||||
|
||||
success = convert_p7b_to_pem(args.p7b_file, args.output)
|
||||
|
||||
if success:
|
||||
print("\n✓ Conversion complete!")
|
||||
print("\nNext steps:")
|
||||
print("1. If you have the private key separately, use it with --ssl-key")
|
||||
print("2. If not, generate a new certificate: python generate_cert.py")
|
||||
else:
|
||||
sys.exit(1)
|
||||
@@ -1,166 +0,0 @@
|
||||
"""
|
||||
Convert PEM certificate to P7B (PKCS#7) format for Square webhooks
|
||||
Square requires P7B format for webhook signature verification
|
||||
"""
|
||||
|
||||
import subprocess
|
||||
import sys
|
||||
import os
|
||||
|
||||
|
||||
def convert_pem_to_p7b(cert_file="cert.pem", output_file="cert.p7b"):
|
||||
"""
|
||||
Convert PEM certificate to P7B (PKCS#7) format
|
||||
|
||||
Args:
|
||||
cert_file: Input PEM certificate file
|
||||
output_file: Output P7B file
|
||||
"""
|
||||
|
||||
# Check if OpenSSL is available
|
||||
try:
|
||||
subprocess.run(["openssl", "version"], capture_output=True, check=True)
|
||||
except (subprocess.CalledProcessError, FileNotFoundError):
|
||||
print("ERROR: OpenSSL not found!")
|
||||
print("\nFor Windows, you can:")
|
||||
print(
|
||||
"1. Install OpenSSL from: https://slproweb.com/products/Win32OpenSSL.html"
|
||||
)
|
||||
print("2. Or use Git Bash which includes OpenSSL")
|
||||
print("3. Or use WSL (Windows Subsystem for Linux)")
|
||||
return False
|
||||
|
||||
# Check if input file exists
|
||||
if not os.path.exists(cert_file):
|
||||
print(f"ERROR: Certificate file not found: {cert_file}")
|
||||
print(f"Current directory: {os.getcwd()}")
|
||||
print("\nMake sure you've generated the certificate first:")
|
||||
print(" python generate_cert.py")
|
||||
return False
|
||||
|
||||
print(f"Converting {cert_file} to P7B format...")
|
||||
|
||||
# Convert PEM to P7B (PKCS#7)
|
||||
# -certfile can include intermediate certificates if needed
|
||||
cmd = [
|
||||
"openssl",
|
||||
"crl2pkcs7",
|
||||
"-nocrl",
|
||||
"-certfile",
|
||||
cert_file,
|
||||
"-out",
|
||||
output_file,
|
||||
]
|
||||
|
||||
try:
|
||||
result = subprocess.run(cmd, check=True, capture_output=True, text=True)
|
||||
|
||||
if os.path.exists(output_file):
|
||||
print(f"\n✓ P7B certificate created: {os.path.abspath(output_file)}")
|
||||
print(f" File size: {os.path.getsize(output_file)} bytes")
|
||||
|
||||
print("\n" + "=" * 60)
|
||||
print("Square Webhook Configuration:")
|
||||
print("=" * 60)
|
||||
print(f"1. Upload this file to Square Developer Dashboard:")
|
||||
print(f" {os.path.abspath(output_file)}")
|
||||
print("\n2. In Square Dashboard:")
|
||||
print(" - Go to Webhooks settings")
|
||||
print(" - Click 'Manage Notification Settings'")
|
||||
print(" - Upload the P7B file for signature verification")
|
||||
print("\n3. Square will use this to verify webhook signatures")
|
||||
print("=" * 60)
|
||||
|
||||
# Show file contents preview
|
||||
print("\nP7B file preview (first 500 chars):")
|
||||
with open(output_file, "r") as f:
|
||||
content = f.read(500)
|
||||
print(content)
|
||||
if len(content) == 500:
|
||||
print("...")
|
||||
|
||||
return True
|
||||
else:
|
||||
print("ERROR: Output file was not created")
|
||||
return False
|
||||
|
||||
except subprocess.CalledProcessError as e:
|
||||
print(f"ERROR: Conversion failed: {e}")
|
||||
if e.stderr:
|
||||
print(f"OpenSSL error: {e.stderr}")
|
||||
return False
|
||||
|
||||
|
||||
def convert_with_chain(cert_file="cert.pem", chain_file=None, output_file="cert.p7b"):
|
||||
"""
|
||||
Convert PEM certificate with certificate chain to P7B format
|
||||
Use this if you have intermediate certificates
|
||||
|
||||
Args:
|
||||
cert_file: Your certificate file
|
||||
chain_file: Intermediate/chain certificate file (optional)
|
||||
output_file: Output P7B file
|
||||
"""
|
||||
|
||||
if not chain_file:
|
||||
return convert_pem_to_p7b(cert_file, output_file)
|
||||
|
||||
# Check files exist
|
||||
for f in [cert_file, chain_file]:
|
||||
if not os.path.exists(f):
|
||||
print(f"ERROR: File not found: {f}")
|
||||
return False
|
||||
|
||||
print(f"Converting {cert_file} with chain {chain_file} to P7B format...")
|
||||
|
||||
# Create combined cert file
|
||||
combined = "combined_cert.pem"
|
||||
with open(combined, "w") as out:
|
||||
with open(cert_file, "r") as f:
|
||||
out.write(f.read())
|
||||
with open(chain_file, "r") as f:
|
||||
out.write(f.read())
|
||||
|
||||
result = convert_pem_to_p7b(combined, output_file)
|
||||
|
||||
# Clean up combined file
|
||||
if os.path.exists(combined):
|
||||
os.remove(combined)
|
||||
|
||||
return result
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
import argparse
|
||||
|
||||
parser = argparse.ArgumentParser(
|
||||
description="Convert PEM certificate to P7B (PKCS#7) for Square webhooks"
|
||||
)
|
||||
parser.add_argument(
|
||||
"--cert",
|
||||
default="cert.pem",
|
||||
help="Input PEM certificate file (default: cert.pem)",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--chain", default=None, help="Optional: Intermediate certificate chain file"
|
||||
)
|
||||
parser.add_argument(
|
||||
"--output", default="cert.p7b", help="Output P7B file (default: cert.p7b)"
|
||||
)
|
||||
|
||||
args = parser.parse_args()
|
||||
|
||||
print("=" * 60)
|
||||
print("PEM to P7B Certificate Converter for Square Webhooks")
|
||||
print("=" * 60)
|
||||
print()
|
||||
|
||||
if args.chain:
|
||||
success = convert_with_chain(args.cert, args.chain, args.output)
|
||||
else:
|
||||
success = convert_pem_to_p7b(args.cert, args.output)
|
||||
|
||||
if not success:
|
||||
sys.exit(1)
|
||||
|
||||
print("\n✓ Conversion complete!")
|
||||
File renamed without changes.
@@ -1,76 +0,0 @@
|
||||
"""
|
||||
Generate self-signed SSL certificate for testing HTTPS webhooks
|
||||
Run this script to create cert.pem and key.pem files
|
||||
"""
|
||||
|
||||
import subprocess
|
||||
import sys
|
||||
import os
|
||||
|
||||
|
||||
def generate_certificate():
|
||||
"""Generate self-signed certificate using OpenSSL"""
|
||||
|
||||
cert_file = "cert.pem"
|
||||
key_file = "key.pem"
|
||||
|
||||
# Check if OpenSSL is available
|
||||
try:
|
||||
subprocess.run(["openssl", "version"], capture_output=True, check=True)
|
||||
except (subprocess.CalledProcessError, FileNotFoundError):
|
||||
print("ERROR: OpenSSL not found!")
|
||||
print("\nFor Windows, you can:")
|
||||
print(
|
||||
"1. Install OpenSSL from: https://slproweb.com/products/Win32OpenSSL.html"
|
||||
)
|
||||
print("2. Or use Git Bash which includes OpenSSL")
|
||||
print("3. Or use WSL (Windows Subsystem for Linux)")
|
||||
return False
|
||||
|
||||
print("Generating self-signed certificate...")
|
||||
print("This will create cert.pem and key.pem files")
|
||||
print()
|
||||
|
||||
# Generate certificate valid for 365 days
|
||||
cmd = [
|
||||
"openssl",
|
||||
"req",
|
||||
"-x509",
|
||||
"-newkey",
|
||||
"rsa:4096",
|
||||
"-keyout",
|
||||
key_file,
|
||||
"-out",
|
||||
cert_file,
|
||||
"-days",
|
||||
"365",
|
||||
"-nodes", # No passphrase
|
||||
"-subj",
|
||||
"/C=US/ST=State/L=City/O=Organization/CN=localhost",
|
||||
]
|
||||
|
||||
try:
|
||||
subprocess.run(cmd, check=True)
|
||||
print(f"\n✓ Certificate created: {os.path.abspath(cert_file)}")
|
||||
print(f"✓ Private key created: {os.path.abspath(key_file)}")
|
||||
print("\nYou can now run the server with HTTPS:")
|
||||
print(
|
||||
f" python src/test_server.py --ssl-cert {cert_file} --ssl-key {key_file} --hook-port 8443"
|
||||
)
|
||||
print("\nOr webhook-only HTTPS:")
|
||||
print(
|
||||
f" python src/test_server.py --ssl-cert {cert_file} --ssl-key {key_file} --hook-port 8443 --hook-ssl-only"
|
||||
)
|
||||
print(
|
||||
"\nNote: Self-signed certificates will show security warnings in browsers."
|
||||
)
|
||||
print("For production, use certificates from a trusted CA like Let's Encrypt.")
|
||||
return True
|
||||
except subprocess.CalledProcessError as e:
|
||||
print(f"ERROR: Failed to generate certificate: {e}")
|
||||
return False
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
if not generate_certificate():
|
||||
sys.exit(1)
|
||||
+29
-184
@@ -1,7 +1,6 @@
|
||||
import argparse
|
||||
import asyncio
|
||||
import json
|
||||
import ssl
|
||||
from aiohttp import web
|
||||
from base64 import b64decode
|
||||
from typing import Dict, Any
|
||||
@@ -15,6 +14,9 @@ import logging
|
||||
from logging.handlers import RotatingFileHandler
|
||||
from pathlib import Path
|
||||
|
||||
print("Creating log directory if it doesn't exist...")
|
||||
os.makedirs("./logs/", exist_ok=True)
|
||||
|
||||
import banner
|
||||
import get_sq_env
|
||||
from time import time
|
||||
@@ -85,77 +87,41 @@ def valid_uuid(val):
|
||||
async def hook_handler(request: web.Request) -> web.Response:
|
||||
"""Handle incoming JSON webhook POSTs on /hook endpoint"""
|
||||
try:
|
||||
current_time = int(asyncio.get_event_loop().time())
|
||||
|
||||
# Verify request method
|
||||
if request.method != "POST":
|
||||
logger.error(
|
||||
f"{current_time}\tInvalid request method to /hook from %s",
|
||||
request.remote,
|
||||
f"{time}\tInvalid request method to /hook from %s", request.remote
|
||||
)
|
||||
return web.Response(status=405, text="Method not allowed. Use POST.")
|
||||
|
||||
# Get JSON data from request
|
||||
try:
|
||||
data = await request.json()
|
||||
except json.JSONDecodeError as e:
|
||||
print(f"[@DEBUG] Invalid JSON to /hook from {request.remote}: {str(e)}")
|
||||
logger.error(f"Invalid JSON to /hook from {request.remote}: {str(e)}")
|
||||
except json.JSONDecodeError:
|
||||
logger.error("Invalid JSON to /hook from %s", request.remote)
|
||||
return web.Response(status=400, text="Invalid JSON in request body")
|
||||
|
||||
# Log the received webhook with detailed output
|
||||
print(f"\n{'='*60}")
|
||||
print(f"[@DEBUG] WEBHOOK RECEIVED at {current_time}")
|
||||
print(f"[@DEBUG] From: {request.remote}")
|
||||
print(f"[@DEBUG] Headers: {dict(request.headers)}")
|
||||
print(f"[@DEBUG] Data type: {data.get('type', 'unknown')}")
|
||||
print(f"[@DEBUG] Event ID: {data.get('event_id', 'none')}")
|
||||
print(f"[@DEBUG] Full payload:")
|
||||
print(json.dumps(data, indent=2))
|
||||
print(f"{'='*60}\n")
|
||||
|
||||
# Log the received webhook
|
||||
print(f"[@DEBUG] Webhook received at {time} from {request.remote}")
|
||||
logger.info(
|
||||
f"{current_time}\tWebhook received from {request.remote}: {json.dumps(data)}"
|
||||
f"{time}\tWebhook received from {request.remote}: {json.dumps(data)}"
|
||||
)
|
||||
|
||||
# Process the webhook data here
|
||||
# TODO: Add your webhook processing logic
|
||||
webhook_type = data.get("type", "unknown")
|
||||
|
||||
if webhook_type == "inventory.count.updated":
|
||||
print(f"[@DEBUG] Processing inventory count update...")
|
||||
# Extract inventory data
|
||||
inventory_counts = (
|
||||
data.get("data", {}).get("object", {}).get("inventory_counts", [])
|
||||
)
|
||||
for count in inventory_counts:
|
||||
print(f"[@DEBUG] Catalog Object: {count.get('catalog_object_id')}")
|
||||
print(f"[@DEBUG] Quantity: {count.get('quantity')}")
|
||||
print(f"[@DEBUG] State: {count.get('state')}")
|
||||
|
||||
response_data = {
|
||||
"status": "success",
|
||||
"message": f"Webhook received: {webhook_type}",
|
||||
"timestamp": current_time,
|
||||
"event_id": data.get("event_id"),
|
||||
"message": "Webhook received",
|
||||
"timestamp": time,
|
||||
"data_received": data,
|
||||
}
|
||||
|
||||
return web.json_response(response_data)
|
||||
|
||||
except json.JSONDecodeError as e:
|
||||
error_msg = f"JSON decode error in webhook: {str(e)}"
|
||||
print(f"[@DEBUG] {error_msg}")
|
||||
logger.error(error_msg)
|
||||
return web.Response(status=400, text=error_msg)
|
||||
except Exception as e:
|
||||
error_msg = f"Webhook handler error: {str(e)}"
|
||||
print(f"[@DEBUG] {error_msg}")
|
||||
print(f"[@DEBUG] Exception type: {type(e).__name__}")
|
||||
import traceback
|
||||
|
||||
print(f"[@DEBUG] Traceback:\n{traceback.format_exc()}")
|
||||
logger.error(f"{error_msg}\n{traceback.format_exc()}")
|
||||
logger.error(f"Webhook handler error: {str(e)}")
|
||||
print(f"Webhook handler error: {str(e)}")
|
||||
return web.Response(status=500, text="Internal server error")
|
||||
|
||||
|
||||
@@ -202,7 +168,7 @@ async def request_handler(request: web.Request) -> web.Response:
|
||||
if decoded_cmd == "RUNUPDATE":
|
||||
response_data = {"status": "success", "message": "Update started"}
|
||||
await run_update()
|
||||
logging.info(f"{time}\tUpdate command processed successfully")
|
||||
logging.info(f"{time()}\tUpdate command processed successfully")
|
||||
return web.json_response(response_data)
|
||||
else:
|
||||
return web.Response(status=400, text=f"Unknown command: {decoded_cmd}")
|
||||
@@ -222,145 +188,32 @@ app = web.Application()
|
||||
app.router.add_post("/api", request_handler)
|
||||
app.router.add_post("/hook", hook_handler)
|
||||
|
||||
parser = argparse.ArgumentParser(
|
||||
description="studspider - LEGO Inventory Sync Service for Square POS and Brickset",
|
||||
epilog="""
|
||||
Examples:
|
||||
# Basic HTTP server (recommended with nginx reverse proxy)
|
||||
python src/test_server.py --host 0.0.0.0 --port 7432
|
||||
|
||||
# With separate webhook port
|
||||
python src/test_server.py --port 7432 --hook-port 8080
|
||||
|
||||
# HTTPS using certificates from .env (set SSL_CERT_PATH and SSL_KEY_PATH)
|
||||
python src/test_server.py --hook-port 8443 --hook-ssl-only
|
||||
|
||||
# HTTPS with command line override (self-signed cert for testing)
|
||||
python src/test_server.py --ssl-cert cert.pem --ssl-key key.pem --hook-port 8443 --hook-ssl-only
|
||||
|
||||
# Full HTTPS (both endpoints)
|
||||
python src/test_server.py --ssl-cert cert.pem --ssl-key key.pem --hook-port 8443
|
||||
|
||||
# Production behind nginx (no SSL needed in app)
|
||||
python src/test_server.py --host 127.0.0.1 --port 7432
|
||||
|
||||
Environment Variables (.env):
|
||||
SSL_CERT_PATH - Default SSL certificate path
|
||||
SSL_KEY_PATH - Default SSL key path
|
||||
SQUARE_P7B_PATH - P7B file to upload to Square Dashboard
|
||||
|
||||
For more information, see doc/
|
||||
""",
|
||||
formatter_class=argparse.RawDescriptionHelpFormatter,
|
||||
)
|
||||
parser = argparse.ArgumentParser(description="studspider")
|
||||
parser.add_argument(
|
||||
"--host",
|
||||
type=str,
|
||||
default="localhost",
|
||||
help="IP address to listen on (default: localhost, use 0.0.0.0 for all interfaces)",
|
||||
help="IP address to listen on. default: localhost",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--port", type=int, default=7432, help="Port for main API endpoint (default: 7432)"
|
||||
"--port", type=int, default=7432, help="Port to listen on. default: 7432"
|
||||
)
|
||||
parser.add_argument(
|
||||
"--hook-port",
|
||||
type=int,
|
||||
default=None,
|
||||
help="Separate port for webhook endpoint (default: None - uses same port as --port)",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--ssl-cert",
|
||||
type=str,
|
||||
default=get_sq_env.SSL_CERT_PATH,
|
||||
help="Path to SSL certificate file in PEM format (default: from .env SSL_CERT_PATH)",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--ssl-key",
|
||||
type=str,
|
||||
default=get_sq_env.SSL_KEY_PATH,
|
||||
help="Path to SSL private key file in PEM format (default: from .env SSL_KEY_PATH)",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--hook-ssl-only",
|
||||
action="store_true",
|
||||
help="Enable HTTPS only for webhook endpoint, main API stays HTTP (requires --ssl-cert and --ssl-key)",
|
||||
default=8080,
|
||||
help="Optional separate port for webhook endpoint. default: 8080",
|
||||
)
|
||||
args = parser.parse_args()
|
||||
|
||||
if __name__ == "__main__":
|
||||
print("Creating log directory if it doesn't exist...")
|
||||
os.makedirs("./logs/", exist_ok=True)
|
||||
print(banner.generate("studspider v0.1"))
|
||||
print("Built for PLAY-WELL TEKNOLOGIES by contact@studspider.sh\n\n")
|
||||
|
||||
# Setup SSL context if certificates provided
|
||||
ssl_context = None
|
||||
if args.ssl_cert and args.ssl_key:
|
||||
# Check if trying to use P7B file
|
||||
if args.ssl_cert.endswith(".p7b") or args.ssl_key.endswith(".p7b"):
|
||||
print("ERROR: Cannot use P7B files directly for HTTPS server!")
|
||||
print("\nP7B files are for Square's webhook signature verification only.")
|
||||
print("Your server needs PEM format files (.pem)")
|
||||
print("\nWorkflow:")
|
||||
print("1. Generate PEM files: python generate_cert.py")
|
||||
print("2. Convert to P7B for Square: python convert_to_p7b.py")
|
||||
print("3. Upload P7B to Square Dashboard")
|
||||
print("4. Run server with PEM files:")
|
||||
print(
|
||||
" python src/test_server.py --ssl-cert cert.pem --ssl-key key.pem --hook-port 8443"
|
||||
)
|
||||
print("\nIf you have a P7B and need PEM:")
|
||||
print(" python convert_from_p7b.py your_cert.p7b")
|
||||
exit(1)
|
||||
|
||||
try:
|
||||
ssl_context = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)
|
||||
ssl_context.load_cert_chain(args.ssl_cert, args.ssl_key)
|
||||
print(f"✓ SSL enabled with cert: {args.ssl_cert}")
|
||||
|
||||
# Show P7B info if configured
|
||||
if get_sq_env.SQUARE_P7B_PATH:
|
||||
print(
|
||||
f"ℹ️ Square P7B certificate for upload: {get_sq_env.SQUARE_P7B_PATH}"
|
||||
)
|
||||
if os.path.exists(get_sq_env.SQUARE_P7B_PATH):
|
||||
print(f" ✓ P7B file exists")
|
||||
else:
|
||||
print(f" ⚠️ P7B file not found - run: python convert_to_p7b.py")
|
||||
except FileNotFoundError as e:
|
||||
print(f"ERROR: Certificate file not found: {e}")
|
||||
exit(1)
|
||||
except ssl.SSLError as e:
|
||||
print(f"ERROR: Invalid certificate or key file: {e}")
|
||||
print("\nMake sure you're using PEM format files.")
|
||||
print("Generate certificates with: python generate_cert.py")
|
||||
exit(1)
|
||||
elif args.ssl_cert or args.ssl_key:
|
||||
print("ERROR: Both --ssl-cert and --ssl-key must be provided together")
|
||||
exit(1)
|
||||
else:
|
||||
print("ℹ️ Running without SSL (HTTP only)")
|
||||
print(" For production with nginx reverse proxy, this is recommended.")
|
||||
print(" Nginx will handle HTTPS, forward HTTP to this server.")
|
||||
|
||||
# Show P7B info even without SSL (for nginx setup)
|
||||
if get_sq_env.SQUARE_P7B_PATH:
|
||||
print(
|
||||
f"\nℹ️ Square P7B certificate configured: {get_sq_env.SQUARE_P7B_PATH}"
|
||||
)
|
||||
if os.path.exists(get_sq_env.SQUARE_P7B_PATH):
|
||||
print(f" ✓ P7B file exists - upload this to Square Dashboard")
|
||||
print(f" Square Dashboard → Webhooks → Manage Notification Settings")
|
||||
else:
|
||||
print(f" ⚠️ P7B file not found")
|
||||
print(
|
||||
f" Generate with: python convert_to_p7b.py --cert /path/to/nginx/cert.pem"
|
||||
)
|
||||
print("Built for PLAY-WELL TEKNOLOGIES by contact@traps.moe\n\n")
|
||||
|
||||
# If hook-port is specified, run a separate server for webhooks
|
||||
if args.hook_port:
|
||||
protocol_main = "https" if (ssl_context and not args.hook_ssl_only) else "http"
|
||||
protocol_hook = "https" if ssl_context else "http"
|
||||
print(f"Starting main server on {args.host}:{args.port}")
|
||||
print(f"Starting webhook server on {args.host}:{args.hook_port}")
|
||||
|
||||
# Create separate app for webhook
|
||||
hook_app = web.Application()
|
||||
@@ -370,31 +223,23 @@ if __name__ == "__main__":
|
||||
async def run_servers():
|
||||
runner1 = web.AppRunner(app)
|
||||
await runner1.setup()
|
||||
# Main server uses SSL only if not hook-ssl-only mode
|
||||
main_ssl = None if args.hook_ssl_only else ssl_context
|
||||
site1 = web.TCPSite(runner1, args.host, args.port, ssl_context=main_ssl)
|
||||
site1 = web.TCPSite(runner1, args.host, args.port)
|
||||
|
||||
runner2 = web.AppRunner(hook_app)
|
||||
await runner2.setup()
|
||||
# Webhook server always uses SSL if certificates provided
|
||||
site2 = web.TCPSite(
|
||||
runner2, args.host, args.hook_port, ssl_context=ssl_context
|
||||
)
|
||||
site2 = web.TCPSite(runner2, args.host, args.hook_port)
|
||||
|
||||
await site1.start()
|
||||
await site2.start()
|
||||
|
||||
print(f"Starting main server on {args.host}:{args.port} ({protocol_main})")
|
||||
print(
|
||||
f"Starting webhook server on {args.host}:{args.hook_port} ({protocol_hook})"
|
||||
)
|
||||
print(f"Main server running on http://{args.host}:{args.port}")
|
||||
print(f"Webhook server running on http://{args.host}:{args.hook_port}/hook")
|
||||
|
||||
# Keep running
|
||||
await asyncio.Event().wait()
|
||||
|
||||
asyncio.run(run_servers())
|
||||
else:
|
||||
protocol = "https" if ssl_context else "http"
|
||||
print(f"Server running on {args.host}:{args.port} ({protocol})")
|
||||
print(f"Webhook endpoint: {protocol}://{args.host}:{args.port}/hook")
|
||||
web.run_app(app, host=args.host, port=args.port, ssl_context=ssl_context)
|
||||
print(f"Server running on {args.host}:{args.port}")
|
||||
print(f"Webhook endpoint: http://{args.host}:{args.port}/hook")
|
||||
web.run_app(app, host=args.host, port=args.port)
|
||||
@@ -1,102 +0,0 @@
|
||||
"""
|
||||
Test script for webhook endpoint
|
||||
Sends the Square inventory.count.updated webhook payload
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import aiohttp
|
||||
import json
|
||||
import ssl
|
||||
import sys
|
||||
|
||||
|
||||
async def test_webhook(verify_ssl=True):
|
||||
url = "https://studspider.sh:8443/hook"
|
||||
|
||||
# Your Square webhook payload
|
||||
payload = {
|
||||
"merchant_id": "6SSW7HV8K2ST5",
|
||||
"type": "inventory.count.updated",
|
||||
"event_id": "df5f3813-a913-45a1-94e9-fdc3f7d5e3b6",
|
||||
"created_at": "2019-10-29T18:38:45.455006797Z",
|
||||
"data": {
|
||||
"type": "inventory_counts",
|
||||
"id": "84e4ac73-d605-4dbd-a9e5-ffff794ddb9d",
|
||||
"object": {
|
||||
"inventory_counts": [
|
||||
{
|
||||
"calculated_at": "2019-10-29T18:38:45.10296Z",
|
||||
"catalog_object_id": "FGQ5JJWT2PYTHF35CKZ2DSKP",
|
||||
"catalog_object_type": "ITEM_VARIATION",
|
||||
"location_id": "YYQR03DGCTXA4",
|
||||
"quantity": "10",
|
||||
"state": "IN_STOCK",
|
||||
}
|
||||
]
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
print("Sending webhook test payload...")
|
||||
print(f"URL: {url}")
|
||||
print(
|
||||
f"SSL Verification: {'Enabled' if verify_ssl else 'Disabled (accepting self-signed certs)'}"
|
||||
)
|
||||
print(json.dumps(payload, indent=2))
|
||||
print("\n" + "=" * 60 + "\n")
|
||||
|
||||
# Create SSL context that allows self-signed certificates if verify_ssl is False
|
||||
ssl_context = None
|
||||
if not verify_ssl:
|
||||
ssl_context = ssl.create_default_context()
|
||||
ssl_context.check_hostname = False
|
||||
ssl_context.verify_mode = ssl.CERT_NONE
|
||||
|
||||
try:
|
||||
connector = aiohttp.TCPConnector(ssl=ssl_context)
|
||||
async with aiohttp.ClientSession(connector=connector) as session:
|
||||
async with session.post(url, json=payload) as resp:
|
||||
print(f"Status: {resp.status}")
|
||||
print(f"Response headers: {dict(resp.headers)}")
|
||||
|
||||
response_text = await resp.text()
|
||||
print(f"\nResponse body:")
|
||||
|
||||
try:
|
||||
response_json = json.loads(response_text)
|
||||
print(json.dumps(response_json, indent=2))
|
||||
except json.JSONDecodeError:
|
||||
print(response_text)
|
||||
|
||||
except aiohttp.ClientConnectorError as e:
|
||||
print(f"Connection error: {e}")
|
||||
print("\nTroubleshooting:")
|
||||
print("1. Make sure the server is running")
|
||||
print("2. Check if the hostname and port are correct")
|
||||
print("3. For self-signed certificates, the script now accepts them by default")
|
||||
print("\nServer start command:")
|
||||
print(
|
||||
" python src/test_server.py --ssl-cert cert.pem --ssl-key key.pem --hook-port 8443 --hook-ssl-only"
|
||||
)
|
||||
except aiohttp.ServerTimeoutError as e:
|
||||
print(f"Timeout error: {e}")
|
||||
print("The server took too long to respond")
|
||||
except Exception as e:
|
||||
print(f"Error: {type(e).__name__}: {e}")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
# Check command line arguments
|
||||
verify_ssl = True
|
||||
if len(sys.argv) > 1 and sys.argv[1] in ["--no-verify", "--insecure", "-k"]:
|
||||
verify_ssl = False
|
||||
print("⚠️ SSL verification disabled - accepting self-signed certificates\n")
|
||||
elif len(sys.argv) > 1:
|
||||
print("Usage: python src/test_webhook.py [--no-verify]")
|
||||
print(
|
||||
" --no-verify: Disable SSL certificate verification (for self-signed certs)"
|
||||
)
|
||||
sys.exit(1)
|
||||
|
||||
# Default to no verification since we're likely using self-signed certs
|
||||
asyncio.run(test_webhook(verify_ssl=False))
|
||||
Reference in new issue
Block a user