Authenticate endpoints using x-api-key

README.md

@@ -401,6 +401,10 @@ $ localhost:8009
 
 ---
 
+## Authentication
+
+To enable authentication, set your API key in the environment variable `PYTORRENTS_API_KEY`. Clients must include this key in the `x-api-key` header of their requests to authenticate successfully.
+
 ## Want to Try api ?
 
 > [api/v1/search?site=1337x&query=eternals](https://torrent-api-py-nx0x.onrender.com/api/v1/search?site=1337x&query=eternals)

helper/dependencies.py

@@ -0,0 +1,20 @@
+import os
+
+from fastapi import Security, HTTPException, status
+from fastapi.security import APIKeyHeader
+
+
+api_key = os.environ.get("PYTORRENT_API_KEY")
+api_key_header = APIKeyHeader(name="X-API-Key", auto_error=False)
+
+def authenticate_request(
+    x_api_key: str = Security(api_key_header),
+):
+    """
+    Dependency function to authenticate a request with an API key.
+    """
+    if api_key and x_api_key != api_key:
+        raise HTTPException(
+            status_code=status.HTTP_403_FORBIDDEN,
+            detail="Access forbidden: Incorrect credentials."
+        )

main.py

@@ -1,5 +1,5 @@
 import uvicorn
-from fastapi import FastAPI, Request
+from fastapi import FastAPI, Request, Depends
 from fastapi.responses import JSONResponse
 from fastapi.middleware.cors import CORSMiddleware
 from routers.v1.search_router import router as search_router
@@ -11,6 +11,7 @@
 from routers.home_router import router as home_router
 from routers.v1.search_url_router import router as search_url_router
 from helper.uptime import getUptime
+from helper.dependencies import authenticate_request
 from mangum import Mangum
 from math import ceil
 import time
@@ -20,7 +21,7 @@
 app = FastAPI(
     title="Torrent-Api-Py",
     version="1.0.1",
-    description=f"Unofficial Torrent-Api",
+    description="Unofficial Torrent-Api",
     docs_url="/docs",
     contact={
         "name": "Neeraj Kumar",
@@ -56,13 +57,13 @@ async def health_route(req: Request):
     )
 
 
-app.include_router(search_router, prefix="/api/v1/search")
-app.include_router(trending_router, prefix="/api/v1/trending")
-app.include_router(category_router, prefix="/api/v1/category")
-app.include_router(recent_router, prefix="/api/v1/recent")
-app.include_router(combo_router, prefix="/api/v1/all")
-app.include_router(site_list_router, prefix="/api/v1/sites")
-app.include_router(search_url_router, prefix="/api/v1/search_url")
+app.include_router(search_router, prefix="/api/v1/search", dependencies=[Depends(authenticate_request)])
+app.include_router(trending_router, prefix="/api/v1/trending", dependencies=[Depends(authenticate_request)])
+app.include_router(category_router, prefix="/api/v1/category", dependencies=[Depends(authenticate_request)])
+app.include_router(recent_router, prefix="/api/v1/recent", dependencies=[Depends(authenticate_request)])
+app.include_router(combo_router, prefix="/api/v1/all", dependencies=[Depends(authenticate_request)])
+app.include_router(site_list_router, prefix="/api/v1/sites", dependencies=[Depends(authenticate_request)])
+app.include_router(search_url_router, prefix="/api/v1/search_url", dependencies=[Depends(authenticate_request)])
 app.include_router(home_router, prefix="")
 
 handler = Mangum(app)