commit 05cb90a9c7c68b8aaf334bdf92ac5f119201e4ff Author: CaffeineFueled Date: Sat Sep 20 19:02:26 2025 +0200 init public v0.2.2 diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..9f1423c --- /dev/null +++ b/Dockerfile @@ -0,0 +1,29 @@ +# syntax=docker/dockerfile:1 +FROM python:3.12-slim + +ENV PYTHONDONTWRITEBYTECODE=1 \ + PYTHONUNBUFFERED=1 \ + PIP_NO_CACHE_DIR=1 + +# Non-root user (uid 1000 to match the run script) +RUN useradd -m -u 1000 appuser + +WORKDIR /home/appuser/app + +# (Optional) tini for proper signal handling +RUN apt-get update && apt-get install -y --no-install-recommends tini \ + && rm -rf /var/lib/apt/lists/* + +# Runtime deps +RUN pip install --no-cache-dir fastapi==0.115.* uvicorn[standard]==0.30.* redis==5.0.* + +# Copy your app +COPY --chown=appuser:appuser app.py . +COPY --chown=appuser:appuser favicon.ico . + +USER appuser +EXPOSE 8000 + +ENTRYPOINT ["/usr/bin/tini","--"] +CMD ["uvicorn","app:app","--host","0.0.0.0","--port","8000"] + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2b146bc --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..ff79986 --- /dev/null +++ b/README.md @@ -0,0 +1,75 @@ +# Aukpad + +Simple **live collaboration notepad** with websockets and FastAPI. + +- Status: Beta - expect minor changes. +- Instance/Demo: [aukpad.com](https://aufkpad.com/) +- Inspired by: + - [Rustpad](https://github.com/ekzhang/rustpad) + +The goal is to keep it simple! For feature-rich solutions are [hedgedoc](https://github.com/hedgedoc/hedgedoc) or [codeMD](https://github.com/hackmdio/codimd). + +--- + +## Features + +**Available**: +- live collab notepad +- line numbers +- custom path for more privacy +- optional caching with valkey/redis +- pad creation with HTTP post requests with curl (see *Usage*) +- `[pad_id]/raw` HTTP endpoint + +**Ideas**: +- read-only views +- password protection +- E2EE +- caching/ auto-save to localstorage in browser / offline use + +**Not planned**: +- accounts / RBAC + +--- + +## Usage + +**Creating pad with curl** + +```bash +curl -X POST -d "Cheers" https://aukpad.com/ # string +curl -X POST https://aukpad.com --data-binary @- < file.txt # file +ip -br a | curl -X POST https://aukpad.com --data-binary @- # command output +``` + +--- + +## Installation + +WORK IN PROGRESS + +--- + +## Security + +For security concerns or reports, please contact via `hello a t uphillsecurity d o t com` [gpg](https://uphillsecurity.com/gpg). + +--- + +## License + +**Apache License** + +Version 2.0, January 2004 + +http://www.apache.org/licenses/ + +- ✅ Commercial use +- ✅ Modification +- ✅ Distribution +- ✅ Patent use +- ✅ Private use +- ✅ Limitations +- ❌Trademark use +- ❌Liability +- ❌Warranty diff --git a/app.py b/app.py new file mode 100644 index 0000000..4f27ab3 --- /dev/null +++ b/app.py @@ -0,0 +1,424 @@ +# aukpad.py +from fastapi import FastAPI, WebSocket, WebSocketDisconnect, Request, HTTPException +from fastapi.responses import HTMLResponse, RedirectResponse, PlainTextResponse, FileResponse +import json, secrets, string, time, os, threading, asyncio +from collections import defaultdict +from typing import Optional + +app = FastAPI() +application = app # alias if you prefer "application" + +# Environment variables +USE_VALKEY = os.getenv("USE_VALKEY", "false").lower() == "true" +VALKEY_URL = os.getenv("VALKEY_URL", "redis://localhost:6379/0") +MAX_TEXT_SIZE = int(os.getenv("MAX_TEXT_SIZE", "1048576")) # 1MB default +MAX_CONNECTIONS_PER_IP = int(os.getenv("MAX_CONNECTIONS_PER_IP", "10")) +RETENTION_HOURS = int(os.getenv("RETENTION_HOURS", "48")) # Default 48 hours + +# Valkey/Redis client (initialized later if enabled) +redis_client = None + +# In-memory rooms: {doc_id: {"text": str, "ver": int, "peers": set[WebSocket], "last_access": float}} +rooms: dict[str, dict] = {} + +# Rate limiting: {ip: [timestamp, timestamp, ...]} +rate_limits: dict[str, list] = defaultdict(list) + +# Connection tracking: {ip: connection_count} +connections_per_ip: dict[str, int] = defaultdict(int) + +def random_id(n: int = 4) -> str: + alphabet = string.ascii_lowercase + string.digits + return "".join(secrets.choice(alphabet) for _ in range(n)) + +def init_valkey(): + global redis_client + if USE_VALKEY: + try: + import redis + redis_client = redis.from_url(VALKEY_URL, decode_responses=True) + redis_client.ping() # Test connection + print(f"Valkey/Redis connected: {VALKEY_URL}") + except ImportError: + print("Warning: redis package not installed, falling back to memory-only storage") + redis_client = None + except Exception as e: + print(f"Warning: Failed to connect to Valkey/Redis: {e}") + redis_client = None + +def get_room_data_from_cache(doc_id: str) -> Optional[dict]: + if redis_client: + try: + data = redis_client.get(f"room:{doc_id}") + if data: + return json.loads(data) + except Exception as e: + print(f"Cache read error for {doc_id}: {e}") + return None + +def save_room_data_to_cache(doc_id: str, text: str, ver: int): + if redis_client: + try: + data = {"text": text, "ver": ver, "last_access": time.time()} + redis_client.setex(f"room:{doc_id}", RETENTION_HOURS * 3600, json.dumps(data)) # TTL in seconds + except Exception as e: + print(f"Cache write error for {doc_id}: {e}") + +def update_room_access_time(doc_id: str): + now = time.time() + if doc_id in rooms: + rooms[doc_id]["last_access"] = now + + if redis_client: + try: + data = redis_client.get(f"room:{doc_id}") + if data: + room_data = json.loads(data) + room_data["last_access"] = now + redis_client.setex(f"room:{doc_id}", RETENTION_HOURS * 3600, json.dumps(room_data)) # Reset TTL + except Exception as e: + print(f"Cache access update error for {doc_id}: {e}") + +def cleanup_old_rooms(): + while True: + try: + now = time.time() + cutoff = now - (RETENTION_HOURS * 3600) # Convert hours to seconds + + # Clean in-memory rooms + to_remove = [] + for doc_id, room in rooms.items(): + if room.get("last_access", 0) < cutoff and len(room.get("peers", set())) == 0: + to_remove.append(doc_id) + + for doc_id in to_remove: + del rooms[doc_id] + print(f"Cleaned up inactive room: {doc_id}") + + # Valkey/Redis has TTL, so it cleans up automatically + + except Exception as e: + print(f"Cleanup error: {e}") + + time.sleep(3600) # Run every hour + +def check_rate_limit(client_ip: str) -> bool: + now = time.time() + hour_ago = now - 3600 + + # Clean old entries + rate_limits[client_ip] = [t for t in rate_limits[client_ip] if t > hour_ago] + + # Check limit (50 per hour) + if len(rate_limits[client_ip]) >= 50: + return False + + # Add current request + rate_limits[client_ip].append(now) + return True + +HTML = """ + +aukpad + +
+
+ disconnected +
+
+ + New pad +
+
+
+ 
1
+ +
+ +""" + +@app.get("/favicon.ico", include_in_schema=False) +def favicon(): + return FileResponse("favicon.ico") + +@app.get("/", include_in_schema=False) +def root(): + return RedirectResponse(url=f"/{random_id()}/", status_code=307) + +@app.post("/", include_in_schema=False) +async def create_pad_with_content(request: Request): + # Get client IP + client_ip = request.client.host if request.client else "unknown" + + # Check rate limit + if not check_rate_limit(client_ip): + raise HTTPException(status_code=429, detail="Rate limit exceeded. Max 50 requests per hour.") + + # Get and validate content + content = await request.body() + if not content: + raise HTTPException(status_code=400, detail="Empty content not allowed") + + try: + text_content = content.decode('utf-8') + except UnicodeDecodeError: + raise HTTPException(status_code=400, detail="Content must be valid UTF-8") + + # Check for null bytes + if '\x00' in text_content: + raise HTTPException(status_code=400, detail="Null bytes not allowed") + + # Check text size limit + if len(text_content.encode('utf-8')) > MAX_TEXT_SIZE: + raise HTTPException(status_code=413, detail=f"Content too large. Max size: {MAX_TEXT_SIZE} bytes") + + doc_id = random_id() + rooms[doc_id] = {"text": text_content, "ver": 1, "peers": set(), "last_access": time.time()} + + # Save to cache if enabled + save_room_data_to_cache(doc_id, text_content, 1) + + # Return URL instead of redirect for CLI usage + base_url = str(request.base_url).rstrip('/') + return PlainTextResponse(f"{base_url}/{doc_id}/\n") + +@app.get("/{doc_id}/", response_class=HTMLResponse) +def pad(doc_id: str): + # Update access time when pad is accessed + update_room_access_time(doc_id) + return HTMLResponse(HTML) + +@app.get("/{doc_id}/raw", response_class=PlainTextResponse) +def get_raw_pad_content(doc_id: str): + # Check in-memory rooms first + if doc_id in rooms: + update_room_access_time(doc_id) + return PlainTextResponse(rooms[doc_id]["text"]) + + # Check cache if not in memory + cached_data = get_room_data_from_cache(doc_id) + if cached_data: + # Load into memory for future access + rooms[doc_id] = { + "text": cached_data.get("text", ""), + "ver": cached_data.get("ver", 0), + "peers": set(), + "last_access": time.time() + } + update_room_access_time(doc_id) + return PlainTextResponse(cached_data.get("text", "")) + + # Return empty content if pad doesn't exist + return PlainTextResponse("") + +async def _broadcast(doc_id: str, message: dict, exclude: WebSocket | None = None): + room = rooms.get(doc_id) + if not room: return + dead = [] + payload = json.dumps(message) + for peer in room["peers"]: + if peer is exclude: + continue + try: + await peer.send_text(payload) + except Exception: + dead.append(peer) + for d in dead: + room["peers"].discard(d) + +@app.websocket("/ws/{doc_id}") +async def ws(doc_id: str, ws: WebSocket): + # Get client IP for connection limiting + client_ip = ws.client.host if ws.client else "unknown" + + # Check connection limit per IP + if connections_per_ip[client_ip] >= MAX_CONNECTIONS_PER_IP: + await ws.close(code=1008, reason="Too many connections from this IP") + return + + await ws.accept() + connections_per_ip[client_ip] += 1 + + # Try to load room from cache first + if doc_id not in rooms: + cached_data = get_room_data_from_cache(doc_id) + if cached_data: + rooms[doc_id] = { + "text": cached_data.get("text", ""), + "ver": cached_data.get("ver", 0), + "peers": set(), + "last_access": time.time() + } + + room = rooms.setdefault(doc_id, {"text": "", "ver": 0, "peers": set(), "last_access": time.time()}) + room["peers"].add(ws) + + # Update access time + update_room_access_time(doc_id) + + await ws.send_text(json.dumps({"type": "init", "text": room["text"], "ver": room["ver"]})) + try: + while True: + msg = await ws.receive_text() + data = json.loads(msg) + if data.get("type") == "edit": + new_text = str(data.get("text", "")) + + # Check text size limit + if len(new_text.encode('utf-8')) > MAX_TEXT_SIZE: + await ws.send_text(json.dumps({"type": "error", "message": f"Text too large. Max size: {MAX_TEXT_SIZE} bytes"})) + continue + + room["text"] = new_text + room["ver"] += 1 + room["last_access"] = time.time() + + # Save to cache + save_room_data_to_cache(doc_id, room["text"], room["ver"]) + + await _broadcast(doc_id, { + "type": "update", + "text": room["text"], + "ver": room["ver"], + "clientId": data.get("clientId") + }) + except WebSocketDisconnect: + pass + finally: + room["peers"].discard(ws) + # Decrement connection count for this IP + connections_per_ip[client_ip] = max(0, connections_per_ip[client_ip] - 1) + +# Initialize Valkey/Redis and cleanup thread on startup +@app.on_event("startup") +async def startup_event(): + init_valkey() + # Start cleanup thread + cleanup_thread = threading.Thread(target=cleanup_old_rooms, daemon=True) + cleanup_thread.start() + print("Aukpad started with cleanup routine") + +# Run locally: uvicorn aukpad:app --reload + diff --git a/favicon.ico b/favicon.ico new file mode 100644 index 0000000..0a85119 Binary files /dev/null and b/favicon.ico differ