capyy 0.3.0__tar.gz → 0.3.2__tar.gz

{capyy-0.3.0/capyy.egg-info → capyy-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: capyy
-Version: 0.3.0
+Version: 0.3.2
 Summary: Tiny encrypted JSON-over-TCP APIs: call a function in another program, on your Wi-Fi or across the internet
 Author: Izac
 License-Expression: MIT
@@ -81,6 +81,8 @@ Everything is encrypted by default, with nothing to configure.
   and prints its **fingerprint**.
 - Like SSH, a client **remembers a server's fingerprint** the first time (`~/.capy/known_hosts.json`)
   and raises `capy.SecurityError` if it ever changes.
+- The server logs every request, but **never secrets**: parameters whose name contains
+  `password`, `pwd`, `mdp`, `secret` or `token` are shown as `"***"`.
 - Use `tls=False` on **both** sides to talk in clear (faster on localhost).
 
 ## `capy.wifi` — find each other on the same network

{capyy-0.3.0 → capyy-0.3.2}/README.md

@@ -59,6 +59,8 @@ Everything is encrypted by default, with nothing to configure.
   and prints its **fingerprint**.
 - Like SSH, a client **remembers a server's fingerprint** the first time (`~/.capy/known_hosts.json`)
   and raises `capy.SecurityError` if it ever changes.
+- The server logs every request, but **never secrets**: parameters whose name contains
+  `password`, `pwd`, `mdp`, `secret` or `token` are shown as `"***"`.
 - Use `tls=False` on **both** sides to talk in clear (faster on localhost).
 
 ## `capy.wifi` — find each other on the same network

{capyy-0.3.0 → capyy-0.3.2}/capy/__init__.py

@@ -3,6 +3,7 @@
 import json as jsonlib  # "json" est pris par capy.json()
 import socket
 import threading
+from typing import Any
 
 from . import _tls
 from ._tls import SecurityError  # noqa: F401  (capy.SecurityError)
@@ -53,7 +54,7 @@ class Server:
                 conn.sendall((jsonlib.dumps(self.handle(line), ensure_ascii=False) + "\n").encode())
             except (OSError, ValueError):
                 return
-            print(f"{addr[0]} → {line.strip()}")
+            print(f"{addr[0]} → {_hide(line)}")
 
     # port 0 -> le système choisit un port libre
     def run(self, port=None):
@@ -75,8 +76,27 @@ class Server:
 
 
 # Renvoyer du JSON écrit en texte depuis une action
+# Paramètres jamais affichés dans le journal du serveur (mots de passe, tokens…)
+SECRETS = ("password", "passwd", "pwd", "mdp", "motdepasse", "secret", "token")
+
+
+# Une requête -> texte pour le journal, avec les secrets remplacés par "***"
+# Ex : {"action": "login", "password": "1234"} -> {"action": "login", "password": "***"}
+def _hide(line):
+    try:
+        request = jsonlib.loads(line) if isinstance(line, str) else dict(line)
+    except (ValueError, TypeError):
+        return str(line).strip()
+    if not isinstance(request, dict):
+        return str(line).strip()
+    for key in request:
+        if any(word in key.lower() for word in SECRETS):
+            request[key] = "***"
+    return jsonlib.dumps(request, ensure_ascii=False)
+
+
 # Ex : return capy.json('{"text": "Hello"}')
-def json(text):
+def json(text) -> Any:
     try:
         return jsonlib.loads(text)
     except ValueError as e:
@@ -94,7 +114,8 @@ _NOTHING = object()  # Pour savoir si default a été donné (None est une vraie
 # Ex : get('{"text": "Hello"}', "text") -> "Hello"
 #      get(reponse, "users.0.name") -> "Izac"  (0 = 1er élément d'une liste)
 #      get(reponse, "age", default=0) -> 0 si "age" n'existe pas (au lieu d'une erreur)
-def get(data, path, default=_NOTHING):
+# -> Any : la valeur peut être de n'importe quel type (sinon Pylance croit que c'est un object)
+def get(data, path, default=_NOTHING) -> Any:
     value = json(data) if isinstance(data, str) else data
     for key in str(path).split("."):
         if isinstance(value, dict) and key in value:
@@ -131,7 +152,7 @@ def _error(name, data, target):
 # Du JSON (dict, liste...) -> texte JSON sur une ligne (un texte reste tel quel)
 # Ex : to_str({"text": "Hello"}) -> '{"text": "Hello"}'
 #      to_str('{"text": "Hello"}', "text") -> "Hello"
-def to_str(data, key=None):
+def to_str(data, key=None) -> str:
     if key is not None:
         data = get(data, key)
     if isinstance(data, str):
@@ -144,7 +165,7 @@ def to_str(data, key=None):
 
 # -> entier. Accepte 42, 42.0, "42", " 42 "
 # Ex : to_int("42") -> 42 / to_int("abc") -> ValueError
-def to_int(data, key=None):
+def to_int(data, key=None) -> int:
     if key is not None:
         data = get(data, key)
     if isinstance(data, bool):  # True est un int pour Python, mais pas pour nous
@@ -163,7 +184,7 @@ def to_int(data, key=None):
 
 # -> nombre à virgule. Accepte 4.5, 4, "4.5"
 # Ex : to_float("4.5") -> 4.5
-def to_float(data, key=None):
+def to_float(data, key=None) -> float:
     if key is not None:
         data = get(data, key)
     if not isinstance(data, bool) and isinstance(data, (int, float, str)):
@@ -176,7 +197,7 @@ def to_float(data, key=None):
 
 # -> True / False. Accepte true/false, 1/0, "true"/"false", "oui"/"non", "1"/"0"
 # Ex : to_bool("oui") -> True
-def to_bool(data, key=None):
+def to_bool(data, key=None) -> bool:
     if key is not None:
         data = get(data, key)
     if isinstance(data, bool):
@@ -194,7 +215,7 @@ def to_bool(data, key=None):
 
 # -> liste. Accepte une liste, un tuple, ou du texte JSON '[1, 2]'
 # Ex : to_list("[1, 2]") -> [1, 2]
-def to_list(data, key=None):
+def to_list(data, key=None) -> list:
     if key is not None:
         data = get(data, key)
     if isinstance(data, (list, tuple)):
@@ -211,7 +232,7 @@ def to_list(data, key=None):
 
 # -> dict. Accepte un dict, ou du texte JSON '{"a": 1}'
 # Ex : to_dict('{"a": 1}') -> {"a": 1}
-def to_dict(data, key=None):
+def to_dict(data, key=None) -> dict:
     if key is not None:
         data = get(data, key)
     if isinstance(data, dict):
@@ -229,7 +250,7 @@ def to_dict(data, key=None):
 # Client : capy.call("127.0.0.1", 4000, "get", id=2) -> dict
 # Lève ConnectionError si le serveur ne répond pas, SecurityError si ce n'est pas le bon serveur
 # tls=False : pour un serveur pas chiffré (Server(..., tls=False))
-def call(host, port, action, /, tls=True, **params):
+def call(host, port, action, /, tls=True, **params) -> Any:
     return _call(host, port, action, params, tls, label=f"{host}:{port}")
 
 
@@ -270,6 +291,6 @@ def _call(host, port, action, params, tls, label, who="capy"):
 
 # Empreinte du certificat des serveurs capy de cette machine (à donner aux clients qui veulent vérifier)
 # Ex : capy.fingerprint() -> "9dfa7b98…"
-def fingerprint():
+def fingerprint() -> str:
     _tls.server_context("server")  # Crée le certificat s'il n'existe pas encore
     return _tls.my_fingerprint("server")

{capyy-0.3.0 → capyy-0.3.2}/capy/network.py

@@ -20,6 +20,7 @@ import socket
 import sys
 import threading
 import time
+from typing import Any
 
 import capy
 from capy import _tls
@@ -366,7 +367,7 @@ class Server(capy.Server):
             channel.send({"id": message.get("id"), "response": response})
         except ConnectionError:
             return
-        _log(f"réseau → {jsonlib.dumps(message['request'], ensure_ascii=False)}")
+        _log(f"réseau → {capy._hide(message['request'])}")
 
 
 # ============================================================
@@ -476,7 +477,7 @@ def _call_once(host, port, message):
 # Appeler une action d'un serveur par son nom, via le relais (comme capy.call)
 # La connexion chiffrée reste ouverte : seul le 1er appel paie la connexion TLS
 # Ex : capy.network.call("maison", "test") -> {"text": "Hello"}
-def call(name, action, /, **params):
+def call(name, action, /, **params) -> Any:
     host, port = _address(None)
     message = {"capy": "call", "to": name, "key": _config["key"], "request": {"action": action, **params}}
     reply = None

{capyy-0.3.0 → capyy-0.3.2}/capy/wifi.py

@@ -6,6 +6,7 @@ import json as jsonlib
 import socket
 import threading
 import time
+from typing import Any
 
 import capy
 
@@ -87,7 +88,7 @@ def find(name, timeout=1):
 # Appeler une action d'un serveur par son nom (comme capy.call, sans IP ni port)
 # tls=False : pour un serveur pas chiffré (Server(..., tls=False))
 # Ex : capy.wifi.call("maison", "test") -> {"text": "Hello"}
-def call(name, action, /, tls=True, **params):
+def call(name, action, /, tls=True, **params) -> Any:
     for attempt in range(2):
         host, port = find(name)
         if _secure.get(name, True) != tls:

{capyy-0.3.0 → capyy-0.3.2/capyy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: capyy
-Version: 0.3.0
+Version: 0.3.2
 Summary: Tiny encrypted JSON-over-TCP APIs: call a function in another program, on your Wi-Fi or across the internet
 Author: Izac
 License-Expression: MIT
@@ -81,6 +81,8 @@ Everything is encrypted by default, with nothing to configure.
   and prints its **fingerprint**.
 - Like SSH, a client **remembers a server's fingerprint** the first time (`~/.capy/known_hosts.json`)
   and raises `capy.SecurityError` if it ever changes.
+- The server logs every request, but **never secrets**: parameters whose name contains
+  `password`, `pwd`, `mdp`, `secret` or `token` are shown as `"***"`.
 - Use `tls=False` on **both** sides to talk in clear (faster on localhost).
 
 ## `capy.wifi` — find each other on the same network

{capyy-0.3.0 → capyy-0.3.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "capyy"
-version = "0.3.0"
+version = "0.3.2"
 description = "Tiny encrypted JSON-over-TCP APIs: call a function in another program, on your Wi-Fi or across the internet"
 readme = "README.md"
 requires-python = ">=3.9"

{capyy-0.3.0 → capyy-0.3.2}/tests/test_capy.py

@@ -68,6 +68,12 @@ class TestHandle(unittest.TestCase):
         self.assertEqual(self.api.handle('{"action": "divide", "a": 1, "b": 0}'), {"erreur": "division by zero"})
         self.assertIn("erreur", self.api.handle('{"action": "divide"}'))
 
+    def test_hide_secrets(self):
+        line = '{"action": "login", "name": "Zoe", "password": "1234", "user_token": "abc"}'
+        self.assertEqual(capy._hide(line), '{"action": "login", "name": "Zoe", "password": "***", "user_token": "***"}')
+        self.assertEqual(capy._hide({"mdp": "x"}), '{"mdp": "***"}')
+        self.assertEqual(capy._hide("pas du json\n"), "pas du json")
+
 
 class TestValues(unittest.TestCase):
     data = {"city": "Paris", "temp": "18.5", "rain": "non", "days": [{"name": "lundi"}, {"name": "mardi"}]}