more RESTful APIs

2025-02-11 19:11:30 +01:00
parent 49fea55bc7
commit f3ba6dc716
18 changed files with 378 additions and 163 deletions
--- a/backend/routers/firewall.py
+++ b/backend/routers/firewall.py
@@ -71,7 +71,7 @@ async def get_settings():
    """Get the firewall settings"""
    return firewall.settings

-@app.post("/settings/set", response_model=StatusMessageModel)
+@app.put("/settings", response_model=StatusMessageModel)
 async def set_settings(form: FirewallSettings):
    """Set the firewall settings"""
    firewall.settings = form
@@ -86,13 +86,13 @@ async def get_rule_list():
        "enabled": firewall.enabled
    }

-@app.get('/enable', response_model=StatusMessageModel)
+@app.post('/enable', response_model=StatusMessageModel)
 async def enable_firewall():
    """Request enabling the firewall"""
    firewall.enabled = True
    return await apply_changes()

-@app.get('/disable', response_model=StatusMessageModel)
+@app.post('/disable', response_model=StatusMessageModel)
 async def disable_firewall():
    """Request disabling the firewall"""
    firewall.enabled = False
@@ -128,9 +128,9 @@ def parse_and_check_rule(rule:RuleModel):

    return rule

-@app.post('/rules/set', response_model=StatusMessageModel)
+@app.post('/rules', response_model=StatusMessageModel)
 async def add_new_service(form: RuleFormAdd):
-    """Add a new service"""
+    """Edit rule table"""
    rules = [parse_and_check_rule(ele) for ele in form.rules]
    try:
        db.queries(["DELETE FROM rules"]+
--- a/backend/routers/nfproxy.py
+++ b/backend/routers/nfproxy.py
@@ -0,0 +1,260 @@
+import secrets
+import sqlite3
+from fastapi import APIRouter, HTTPException
+from pydantic import BaseModel
+from modules.nfproxy.nftables import FiregexTables
+from modules.nfproxy.firewall import STATUS, FirewallManager
+from utils.sqlite import SQLite
+from utils import ip_parse, refactor_name, socketio_emit, PortType
+from utils.models import ResetRequest, StatusMessageModel
+
+# TODO copied file, review
+class ServiceModel(BaseModel):
+    service_id: str
+    status: str
+    port: PortType
+    name: str
+    proto: str
+    ip_int: str
+    n_filters: int
+    edited_packets: int
+    blocked_packets: int
+
+class RenameForm(BaseModel):
+    name:str
+
+class PyFilterModel(BaseModel):
+    filter_id: int
+    name: str
+    blocked_packets: int
+    edited_packets: int
+    active: bool
+
+class ServiceAddForm(BaseModel):
+    name: str
+    port: PortType
+    proto: str
+    ip_int: str
+
+class ServiceAddResponse(BaseModel):
+    status:str
+    service_id: str|None = None
+
+app = APIRouter()
+
+db = SQLite('db/nft-pyfilters.db', {
+    'services': {
+        'service_id': 'VARCHAR(100) PRIMARY KEY',
+        'status': 'VARCHAR(100) NOT NULL',
+        'port': 'INT NOT NULL CHECK(port > 0 and port < 65536)',
+        'name': 'VARCHAR(100) NOT NULL UNIQUE',
+        'proto': 'VARCHAR(3) NOT NULL CHECK (proto IN ("tcp", "http"))',
+        'ip_int': 'VARCHAR(100) NOT NULL',
+    },
+    'pyfilter': {
+        'filter_id': 'INTEGER PRIMARY KEY',
+        'name': 'VARCHAR(100) NOT NULL',
+        'blocked_packets': 'INTEGER UNSIGNED NOT NULL DEFAULT 0',
+        'edited_packets': 'INTEGER UNSIGNED NOT NULL DEFAULT 0',
+        'service_id': 'VARCHAR(100) NOT NULL',
+        'active' : 'BOOLEAN NOT NULL CHECK (active IN (0, 1)) DEFAULT 1',
+        'FOREIGN KEY (service_id)':'REFERENCES services (service_id)',
+    },
+    'QUERY':[
+        "CREATE UNIQUE INDEX IF NOT EXISTS unique_services ON services (port, ip_int, proto);",
+        "CREATE UNIQUE INDEX IF NOT EXISTS unique_pyfilter_service ON pyfilter (name, service_id);"   
+    ]
+})
+
+async def refresh_frontend(additional:list[str]=[]):
+    await socketio_emit(["nfproxy"]+additional)
+
+async def reset(params: ResetRequest):
+    if not params.delete: 
+        db.backup()
+    await firewall.close()
+    FiregexTables().reset()
+    if params.delete:
+        db.delete()
+        db.init()
+    else:
+        db.restore()
+    try:
+        await firewall.init()
+    except Exception as e:
+        raise HTTPException(status_code=500, detail=str(e))
+
+async def startup():
+    db.init()
+    try:
+        await firewall.init()
+    except Exception as e:
+        print("WARNING cannot start firewall:", e)
+
+async def shutdown():
+    db.backup()
+    await firewall.close()
+    db.disconnect()
+    db.restore()
+
+def gen_service_id():
+    while True:
+        res = secrets.token_hex(8)
+        if len(db.query('SELECT 1 FROM services WHERE service_id = ?;', res)) == 0:
+            break
+    return res
+
+firewall = FirewallManager(db)
+
+@app.get('/services', response_model=list[ServiceModel])
+async def get_service_list():
+    """Get the list of existent firegex services"""
+    return db.query("""
+        SELECT
+            s.service_id service_id,
+            s.status status,
+            s.port port,
+            s.name name,
+            s.proto proto,
+            s.ip_int ip_int,
+            COUNT(f.filter_id) n_filters,
+            COALESCE(SUM(f.blocked_packets),0) blocked_packets,
+            COALESCE(SUM(f.edited_packets),0) edited_packets
+        FROM services s LEFT JOIN pyfilter f ON s.service_id = f.service_id
+        GROUP BY s.service_id;
+    """)
+
+@app.get('/services/{service_id}', response_model=ServiceModel)
+async def get_service_by_id(service_id: str):
+    """Get info about a specific service using his id"""
+    res = db.query("""
+        SELECT
+            s.service_id service_id,
+            s.status status,
+            s.port port,
+            s.name name,
+            s.proto proto,
+            s.ip_int ip_int,
+            COUNT(f.filter_id) n_filters,
+            COALESCE(SUM(f.blocked_packets),0) blocked_packets,
+            COALESCE(SUM(f.edited_packets),0) edited_packets
+        FROM services s LEFT JOIN pyfilter f ON s.service_id = f.service_id
+        WHERE s.service_id = ? GROUP BY s.service_id;
+    """, service_id)
+    if len(res) == 0:
+        raise HTTPException(status_code=400, detail="This service does not exists!")
+    return res[0]
+
+@app.post('/services/{service_id}/stop', response_model=StatusMessageModel)
+async def service_stop(service_id: str):
+    """Request the stop of a specific service"""
+    await firewall.get(service_id).next(STATUS.STOP)
+    await refresh_frontend()
+    return {'status': 'ok'}
+
+@app.post('/services/{service_id}/start', response_model=StatusMessageModel)
+async def service_start(service_id: str):
+    """Request the start of a specific service"""
+    await firewall.get(service_id).next(STATUS.ACTIVE)
+    await refresh_frontend()
+    return {'status': 'ok'}
+
+@app.delete('/services/{service_id}', response_model=StatusMessageModel)
+async def service_delete(service_id: str):
+    """Request the deletion of a specific service"""
+    db.query('DELETE FROM services WHERE service_id = ?;', service_id)
+    db.query('DELETE FROM pyfilter WHERE service_id = ?;', service_id)
+    await firewall.remove(service_id)
+    await refresh_frontend()
+    return {'status': 'ok'}
+
+@app.put('/services/{service_id}/rename', response_model=StatusMessageModel)
+async def service_rename(service_id: str, form: RenameForm):
+    """Request to change the name of a specific service"""
+    form.name = refactor_name(form.name)
+    if not form.name:
+        raise HTTPException(status_code=400, detail="The name cannot be empty!") 
+    try:
+        db.query('UPDATE services SET name=? WHERE service_id = ?;', form.name, service_id)
+    except sqlite3.IntegrityError:
+        raise HTTPException(status_code=400, detail="This name is already used")
+    await refresh_frontend()
+    return {'status': 'ok'}
+
+@app.get('/services/{service_id}/pyfilters', response_model=list[PyFilterModel])
+async def get_service_pyfilter_list(service_id: str):
+    """Get the list of the pyfilters of a service"""
+    if not db.query("SELECT 1 FROM services s WHERE s.service_id = ?;", service_id):
+        raise HTTPException(status_code=400, detail="This service does not exists!")
+    return db.query("""
+        SELECT 
+            filter_id, name, blocked_packets, edited_packets, active
+        FROM pyfilter WHERE service_id = ?;
+    """, service_id)
+
+@app.get('/pyfilters/{filter_id}', response_model=PyFilterModel)
+async def get_pyfilter_by_id(filter_id: int):
+    """Get pyfilter info using his id"""
+    res = db.query("""
+        SELECT 
+            filter_id, name, blocked_packets, edited_packets, active
+        FROM pyfilter WHERE filter_id = ?;
+    """, filter_id)
+    if len(res) == 0:
+        raise HTTPException(status_code=400, detail="This filter does not exists!")
+    return res[0]
+
+@app.delete('/pyfilters/{filter_id}', response_model=StatusMessageModel)
+async def pyfilter_delete(filter_id: int):
+    """Delete a pyfilter using his id"""
+    res = db.query('SELECT * FROM pyfilter WHERE filter_id = ?;', filter_id)
+    if len(res) != 0:
+        db.query('DELETE FROM pyfilter WHERE filter_id = ?;', filter_id)
+        await firewall.get(res[0]["service_id"]).update_filters()
+        await refresh_frontend()
+    
+    return {'status': 'ok'}
+
+@app.post('/pyfilters/{filter_id}/enable', response_model=StatusMessageModel)
+async def pyfilter_enable(filter_id: int):
+    """Request the enabling of a pyfilter"""
+    res = db.query('SELECT * FROM pyfilter WHERE filter_id = ?;', filter_id)
+    if len(res) != 0:
+        db.query('UPDATE pyfilter SET active=1 WHERE filter_id = ?;', filter_id)
+        await firewall.get(res[0]["service_id"]).update_filters()
+        await refresh_frontend()
+    return {'status': 'ok'}
+
+@app.post('/pyfilters/{filter_id}/disable', response_model=StatusMessageModel)
+async def pyfilter_disable(filter_id: int):
+    """Request the deactivation of a pyfilter"""
+    res = db.query('SELECT * FROM pyfilter WHERE filter_id = ?;', filter_id)
+    if len(res) != 0:
+        db.query('UPDATE pyfilter SET active=0 WHERE filter_id = ?;', filter_id)
+        await firewall.get(res[0]["service_id"]).update_filters()
+        await refresh_frontend()
+    return {'status': 'ok'}
+
+@app.post('/services', response_model=ServiceAddResponse)
+async def add_new_service(form: ServiceAddForm):
+    """Add a new service"""
+    try:
+        form.ip_int = ip_parse(form.ip_int)
+    except ValueError:
+        raise HTTPException(status_code=400, detail="Invalid address")
+    if form.proto not in ["tcp", "http"]:
+        raise HTTPException(status_code=400, detail="Invalid protocol")
+    srv_id = None
+    try:
+        srv_id = gen_service_id()
+        db.query("INSERT INTO services (service_id ,name, port, status, proto, ip_int) VALUES (?, ?, ?, ?, ?, ?)",
+                    srv_id, refactor_name(form.name), form.port, STATUS.STOP, form.proto, form.ip_int)
+    except sqlite3.IntegrityError:
+        raise HTTPException(status_code=400, detail="This type of service already exists")
+    await firewall.reload()
+    await refresh_frontend()
+    return {'status': 'ok', 'service_id': srv_id}
+
+#TODO check all the APIs and add
+# 1. API to change the python filter file
+# 2. a socketio mechanism to lock the previous feature
--- a/backend/routers/nfregex.py
+++ b/backend/routers/nfregex.py
@@ -134,7 +134,7 @@ async def get_service_list():
        GROUP BY s.service_id;
    """)

-@app.get('/service/{service_id}', response_model=ServiceModel)
+@app.get('/services/{service_id}', response_model=ServiceModel)
 async def get_service_by_id(service_id: str):
    """Get info about a specific service using his id"""
    res = db.query("""
@@ -154,21 +154,21 @@ async def get_service_by_id(service_id: str):
        raise HTTPException(status_code=400, detail="This service does not exists!")
    return res[0]

-@app.get('/service/{service_id}/stop', response_model=StatusMessageModel)
+@app.post('/services/{service_id}/stop', response_model=StatusMessageModel)
 async def service_stop(service_id: str):
    """Request the stop of a specific service"""
    await firewall.get(service_id).next(STATUS.STOP)
    await refresh_frontend()
    return {'status': 'ok'}

-@app.get('/service/{service_id}/start', response_model=StatusMessageModel)
+@app.post('/services/{service_id}/start', response_model=StatusMessageModel)
 async def service_start(service_id: str):
    """Request the start of a specific service"""
    await firewall.get(service_id).next(STATUS.ACTIVE)
    await refresh_frontend()
    return {'status': 'ok'}

-@app.get('/service/{service_id}/delete', response_model=StatusMessageModel)
+@app.delete('/services/{service_id}', response_model=StatusMessageModel)
 async def service_delete(service_id: str):
    """Request the deletion of a specific service"""
    db.query('DELETE FROM services WHERE service_id = ?;', service_id)
@@ -177,7 +177,7 @@ async def service_delete(service_id: str):
    await refresh_frontend()
    return {'status': 'ok'}

-@app.post('/service/{service_id}/rename', response_model=StatusMessageModel)
+@app.put('/services/{service_id}/rename', response_model=StatusMessageModel)
 async def service_rename(service_id: str, form: RenameForm):
    """Request to change the name of a specific service"""
    form.name = refactor_name(form.name)
@@ -190,7 +190,7 @@ async def service_rename(service_id: str, form: RenameForm):
    await refresh_frontend()
    return {'status': 'ok'}

-@app.get('/service/{service_id}/regexes', response_model=list[RegexModel])
+@app.get('/services/{service_id}/regexes', response_model=list[RegexModel])
 async def get_service_regexe_list(service_id: str):
    """Get the list of the regexes of a service"""
    if not db.query("SELECT 1 FROM services s WHERE s.service_id = ?;", service_id):
@@ -202,7 +202,7 @@ async def get_service_regexe_list(service_id: str):
        FROM regexes WHERE service_id = ?;
    """, service_id)

-@app.get('/regex/{regex_id}', response_model=RegexModel)
+@app.get('/regexes/{regex_id}', response_model=RegexModel)
 async def get_regex_by_id(regex_id: int):
    """Get regex info using his id"""
    res = db.query("""
@@ -215,7 +215,7 @@ async def get_regex_by_id(regex_id: int):
        raise HTTPException(status_code=400, detail="This regex does not exists!")
    return res[0]

-@app.get('/regex/{regex_id}/delete', response_model=StatusMessageModel)
+@app.delete('/regexes/{regex_id}', response_model=StatusMessageModel)
 async def regex_delete(regex_id: int):
    """Delete a regex using his id"""
    res = db.query('SELECT * FROM regexes WHERE regex_id = ?;', regex_id)
@@ -226,7 +226,7 @@ async def regex_delete(regex_id: int):
    
    return {'status': 'ok'}

-@app.get('/regex/{regex_id}/enable', response_model=StatusMessageModel)
+@app.post('/regexes/{regex_id}/enable', response_model=StatusMessageModel)
 async def regex_enable(regex_id: int):
    """Request the enabling of a regex"""
    res = db.query('SELECT * FROM regexes WHERE regex_id = ?;', regex_id)
@@ -236,7 +236,7 @@ async def regex_enable(regex_id: int):
        await refresh_frontend()
    return {'status': 'ok'}

-@app.get('/regex/{regex_id}/disable', response_model=StatusMessageModel)
+@app.post('/regexes/{regex_id}/disable', response_model=StatusMessageModel)
 async def regex_disable(regex_id: int):
    """Request the deactivation of a regex"""
    res = db.query('SELECT * FROM regexes WHERE regex_id = ?;', regex_id)
@@ -246,7 +246,7 @@ async def regex_disable(regex_id: int):
        await refresh_frontend()
    return {'status': 'ok'}

-@app.post('/regexes/add', response_model=StatusMessageModel)
+@app.post('/regexes', response_model=StatusMessageModel)
 async def add_new_regex(form: RegexAddForm):
    """Add a new regex"""
    try:
@@ -263,7 +263,7 @@ async def add_new_regex(form: RegexAddForm):
    await refresh_frontend()
    return {'status': 'ok'}

-@app.post('/services/add', response_model=ServiceAddResponse)
+@app.post('/services', response_model=ServiceAddResponse)
 async def add_new_service(form: ServiceAddForm):
    """Add a new service"""
    try:
@@ -299,7 +299,8 @@ async def metrics():
        FROM regexes r LEFT JOIN services s ON s.service_id = r.service_id;
    """)
    metrics = []
-    sanitize = lambda s : s.replace('\\', '\\\\').replace('"', '\\"').replace('\n', '\\n')
+    def sanitize(s):
+        return s.replace('\\', '\\\\').replace('"', '\\"').replace('\n', '\\n')
    for stat in stats:
        props = f'service_name="{sanitize(stat["name"])}",regex="{sanitize(b64decode(stat["regex"]).decode())}",mode="{stat["mode"]}",is_case_sensitive="{stat["is_case_sensitive"]}"'
        metrics.append(f'firegex_blocked_packets{{{props}}} {stat["blocked_packets"]}')
--- a/backend/routers/porthijack.py
+++ b/backend/routers/porthijack.py
@@ -92,7 +92,7 @@ async def get_service_list():
    """Get the list of existent firegex services"""
    return db.query("SELECT service_id, active, public_port, proxy_port, name, proto, ip_src, ip_dst FROM services;")

-@app.get('/service/{service_id}', response_model=ServiceModel)
+@app.get('/services/{service_id}', response_model=ServiceModel)
 async def get_service_by_id(service_id: str):
    """Get info about a specific service using his id"""
    res = db.query("SELECT service_id, active, public_port, proxy_port, name, proto, ip_src, ip_dst FROM services WHERE service_id = ?;", service_id)
@@ -100,21 +100,21 @@ async def get_service_by_id(service_id: str):
        raise HTTPException(status_code=400, detail="This service does not exists!")
    return res[0]

-@app.get('/service/{service_id}/stop', response_model=StatusMessageModel)
+@app.post('/services/{service_id}/stop', response_model=StatusMessageModel)
 async def service_stop(service_id: str):
    """Request the stop of a specific service"""
    await firewall.get(service_id).disable()
    await refresh_frontend()
    return {'status': 'ok'}

-@app.get('/service/{service_id}/start', response_model=StatusMessageModel)
+@app.post('/services/{service_id}/start', response_model=StatusMessageModel)
 async def service_start(service_id: str):
    """Request the start of a specific service"""
    await firewall.get(service_id).enable()
    await refresh_frontend()
    return {'status': 'ok'}

-@app.get('/service/{service_id}/delete', response_model=StatusMessageModel)
+@app.delete('/services/{service_id}', response_model=StatusMessageModel)
 async def service_delete(service_id: str):
    """Request the deletion of a specific service"""
    db.query('DELETE FROM services WHERE service_id = ?;', service_id)
@@ -122,7 +122,7 @@ async def service_delete(service_id: str):
    await refresh_frontend()
    return {'status': 'ok'}

-@app.post('/service/{service_id}/rename', response_model=StatusMessageModel)
+@app.put('/services/{service_id}/rename', response_model=StatusMessageModel)
 async def service_rename(service_id: str, form: RenameForm):
    """Request to change the name of a specific service"""
    form.name = refactor_name(form.name)
@@ -139,7 +139,7 @@ class ChangeDestination(BaseModel):
    ip_dst: str
    proxy_port: PortType

-@app.post('/service/{service_id}/change-destination', response_model=StatusMessageModel)
+@app.put('/services/{service_id}/change-destination', response_model=StatusMessageModel)
 async def service_change_destination(service_id: str, form: ChangeDestination):
    """Request to change the proxy destination of the service"""
    
@@ -162,7 +162,7 @@ async def service_change_destination(service_id: str, form: ChangeDestination):
    await refresh_frontend()
    return {'status': 'ok'}

-@app.post('/services/add', response_model=ServiceAddResponse)
+@app.post('/services', response_model=ServiceAddResponse)
 async def add_new_service(form: ServiceAddForm):
    """Add a new service"""
    try: