flask-tor 1.0.3__tar.gz → 1.1.0__tar.gz

{flask-tor-1.0.3 → flask-tor-1.1.0}/PKG-INFO

@@ -1,13 +1,12 @@
 Metadata-Version: 2.1
 Name: flask-tor
-Version: 1.0.3
+Version: 1.1.0
 Summary: A simple way to run Flask apps on tor from your machine.
 Home-page: https://github.com/jakbin/flask-tor
 Author: Jak Bin
 License: MIT License
 Project-URL: Bug Tracker, https://github.com/jakbin/flask-tor/issues
 Keywords: flask,tor,onion
-Platform: UNKNOWN
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python :: 3.6
 Classifier: License :: OSI Approved :: MIT License
@@ -32,6 +31,7 @@ Use it only for educational purpose.
 ## Features
 - No need root permission
 - Multiple instances
+- Optional persistent onion address (reuse the same .onion between runs)
 
 ## Compatability
 Python 3.6+ is required.
@@ -52,7 +52,7 @@ from flask import Flask
 from flask_tor import run_with_tor
 
 app = Flask(__name__)
-port = run_with_tor()
+port = run_with_tor(persistent_key_file='~/.flask_tor/hidden_service_key')
 
 @app.route("/")
 def hello():
@@ -70,7 +70,11 @@ connecting_to_tor: 100% - Done
  * Serving Flask app "main"
  * Debug mode: off
  * Running on http://127.0.0.1:<port>/
+
+If you pass a persistent_key_file path, the first run will create a key file and subsequent runs will reuse it so the onion address stays the same. Set reuse_key=False to force a new address while still updating the stored key.
 ```
 
-### Credit :- [onionshare](https://github.com/onionshare/onionshare)
+## Tutorial
+[Watch Here](https://youtu.be/gmssaGzRT8M)
 
+### Credit :- [onionshare](https://github.com/onionshare/onionshare)

{flask-tor-1.0.3 → flask-tor-1.1.0}/README.md

@@ -14,6 +14,7 @@ Use it only for educational purpose.
 ## Features
 - No need root permission
 - Multiple instances
+- Optional persistent onion address (reuse the same .onion between runs)
 
 ## Compatability
 Python 3.6+ is required.
@@ -34,7 +35,7 @@ from flask import Flask
 from flask_tor import run_with_tor
 
 app = Flask(__name__)
-port = run_with_tor()
+port = run_with_tor(persistent_key_file='~/.flask_tor/hidden_service_key')
 
 @app.route("/")
 def hello():
@@ -52,6 +53,11 @@ connecting_to_tor: 100% - Done
  * Serving Flask app "main"
  * Debug mode: off
  * Running on http://127.0.0.1:<port>/
+
+If you pass a persistent_key_file path, the first run will create a key file and subsequent runs will reuse it so the onion address stays the same. Set reuse_key=False to force a new address while still updating the stored key.
 ```
 
-### Credit :- [onionshare](https://github.com/onionshare/onionshare)
+## Tutorial
+[Watch Here](https://youtu.be/gmssaGzRT8M)
+
+### Credit :- [onionshare](https://github.com/onionshare/onionshare)

{flask-tor-1.0.3 → flask-tor-1.1.0}/flask_tor/__init__.py

@@ -1,3 +1,3 @@
 from .flask_tor import run_with_tor
 
-__version__ = '1.0.3'
+__version__ = '1.1.0'

{flask-tor-1.0.3 → flask-tor-1.1.0}/flask_tor/flask_tor.py

@@ -1,8 +1,18 @@
 from .onion import *
 from .onionstart import OnionStart
-import sys, threading
+import sys, threading, os
 
-def run_with_tor():
+def run_with_tor(persistent_key_file=None, reuse_key=True):
+    """
+    Start Flask app with Tor hidden service.
+
+    Args:
+        persistent_key_file (str, optional): Path to a file for saving/loading the onion service private key. If provided, the same onion address will be reused across runs (unless reuse_key is False). If None, a new address is generated each run.
+        reuse_key (bool, optional): If True (default), reuse the key in persistent_key_file for the onion address. If False, always generate a new address and overwrite the file.
+
+    Returns:
+        int: The port number to use for the Flask app.
+    """
     # Start the Onion object
     onion = Onion()
     try:
@@ -15,7 +25,7 @@ def run_with_tor():
 
     # Start the onionshare app
     try:
-        app_tor = OnionStart(onion)
+        app_tor = OnionStart(onion, persistent_key_file=persistent_key_file, reuse_key=reuse_key)
         # app_tor.set_stealth(stealth)
         app_tor.start_onion_service()
     except KeyboardInterrupt:

{flask-tor-1.0.3 → flask-tor-1.1.0}/flask_tor/onion.py

@@ -105,9 +105,11 @@ class Onion(object):
     is necessary for status updates to reach the GUI.
     """
     def __init__(self):
-
         self.stealth = False
         self.service_id = None
+        # Private key (eg: 'ED25519-V3:AAAA....') captured from ADD_ONION so it can
+        # optionally be reused to get the same onion address in future runs.
+        self.private_key = None
 
         self.system = platform.system()
 
@@ -342,7 +344,7 @@ class Onion(object):
             # ephemeral stealth onion services are not supported
             self.supports_stealth = False
 
-    def start_onion_service(self, port):
+    def start_onion_service(self, port, existing_key=None):
         """
         Start a onion service on port 80, pointing to the given port, and
         return the onion hostname.
@@ -362,11 +364,22 @@ class Onion(object):
             basic_auth = None
 
         try:
-            if basic_auth != None :
-                res = self.c.create_ephemeral_hidden_service({ 80: port }, await_publication=True, basic_auth=basic_auth)
-            else :
-                # if the stem interface is older than 1.5.0, basic_auth isn't a valid keyword arg
-                res = self.c.create_ephemeral_hidden_service({ 80: port }, await_publication=True)
+            if existing_key:
+                # Re-create an onion service using a previously saved key
+                try:
+                    key_type, key_content = existing_key.split(':', 1)
+                except ValueError:
+                    raise TorErrorInvalidSetting('invalid_saved_private_key')
+                if basic_auth is not None:
+                    res = self.c.create_ephemeral_hidden_service({80: port}, key_type=key_type, key_content=key_content, await_publication=True, basic_auth=basic_auth)
+                else:
+                    res = self.c.create_ephemeral_hidden_service({80: port}, key_type=key_type, key_content=key_content, await_publication=True)
+            else:
+                if basic_auth is not None:
+                    res = self.c.create_ephemeral_hidden_service({ 80: port }, await_publication=True, basic_auth=basic_auth)
+                else:
+                    # if the stem interface is older than 1.5.0, basic_auth isn't a valid keyword arg
+                    res = self.c.create_ephemeral_hidden_service({ 80: port }, await_publication=True)
 
         except ProtocolError:
             raise TorErrorProtocolError('error_tor_protocol_error')
@@ -374,6 +387,16 @@ class Onion(object):
         self.service_id = res.content()[0][2].split('=')[1]
         onion_host = self.service_id + '.onion'
 
+        # Extract and store the private key if Tor returned it (Tor omits this
+        # line when we supplied our own existing key).
+        try:
+            for line in res.content():
+                if line[2].startswith('PrivateKey='):
+                    self.private_key = line[2].split('=',1)[1]
+                    break
+        except Exception:
+            pass
+
         if self.stealth:
             auth_cookie = res.content()[2][2].split('=')[1].split(':')[1]
             self.auth_string = 'HidServAuth {} {}'.format(onion_host, auth_cookie)

flask-tor-1.1.0/flask_tor/onionstart.py

@@ -0,0 +1,67 @@
+import os, shutil
+
+from . import common
+
+class OnionStart(object):
+    """
+    OnionShare is the main application class. Pass in options and run
+    start_onion_service and it will do the magic.
+    """
+    def __init__(self, onion, local_only=False, stay_open=False, persistent_key_file=None, reuse_key=True):
+        """
+        Args:
+            onion (Onion): The Onion controller object.
+            local_only (bool): If True, only bind to localhost (no Tor).
+            stay_open (bool): Unused, for compatibility.
+            persistent_key_file (str, optional): Path to file for saving/loading the onion service private key. If provided, the same onion address will be reused across runs (unless reuse_key is False).
+            reuse_key (bool, optional): If True (default), reuse the key in persistent_key_file for the onion address. If False, always generate a new address and overwrite the file.
+        """
+        # The Onion object
+        self.onion = onion
+        self.hidserv_dir = None
+        self.onion_host = None
+        self.stealth = None
+        self.local_only = local_only
+        # Path to store/load persistent onion private key (text file containing 'ED25519-V3:...' format)
+        self.persistent_key_file = os.path.expanduser(persistent_key_file) if persistent_key_file else None
+        print(self.persistent_key_file)
+        self.reuse_key = reuse_key
+
+    def start_onion_service(self):
+        """
+        Start the onionshare onion service.
+        """
+
+        # Choose a random port
+        self.port = common.get_available_port(17600, 17650)
+
+        if self.local_only:
+            self.onion_host = '127.0.0.1:{0:d}'.format(self.port)
+            return
+
+        existing_key = None
+        if self.persistent_key_file and self.reuse_key and os.path.exists(self.persistent_key_file):
+            try:
+                with open(self.persistent_key_file, 'r') as f:
+                    existing_key = f.read().strip() or None
+            except Exception:
+                existing_key = None
+
+        self.onion_host = self.onion.start_onion_service(self.port, existing_key=existing_key)
+
+        # Save newly generated key if we didn't reuse one
+        if self.persistent_key_file and (self.onion.private_key is not None):
+            # Only save if either no existing file or we generated a new key
+            if (not existing_key) or (existing_key and existing_key != self.onion.private_key):
+                try:
+                    parent_dir = os.path.dirname(self.persistent_key_file)
+                    if parent_dir:
+                        os.makedirs(parent_dir, exist_ok=True)
+                    with open(self.persistent_key_file, 'w') as f:
+                        f.write(self.onion.private_key)
+                except Exception as e:
+                    print(f"[flask-tor] Failed to save persistent key file '{self.persistent_key_file}': {e}")
+
+        if self.stealth:
+            self.auth_string = self.onion.auth_string
+

{flask-tor-1.0.3 → flask-tor-1.1.0}/flask_tor.egg-info/PKG-INFO

@@ -1,13 +1,12 @@
 Metadata-Version: 2.1
 Name: flask-tor
-Version: 1.0.3
+Version: 1.1.0
 Summary: A simple way to run Flask apps on tor from your machine.
 Home-page: https://github.com/jakbin/flask-tor
 Author: Jak Bin
 License: MIT License
 Project-URL: Bug Tracker, https://github.com/jakbin/flask-tor/issues
 Keywords: flask,tor,onion
-Platform: UNKNOWN
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python :: 3.6
 Classifier: License :: OSI Approved :: MIT License
@@ -32,6 +31,7 @@ Use it only for educational purpose.
 ## Features
 - No need root permission
 - Multiple instances
+- Optional persistent onion address (reuse the same .onion between runs)
 
 ## Compatability
 Python 3.6+ is required.
@@ -52,7 +52,7 @@ from flask import Flask
 from flask_tor import run_with_tor
 
 app = Flask(__name__)
-port = run_with_tor()
+port = run_with_tor(persistent_key_file='~/.flask_tor/hidden_service_key')
 
 @app.route("/")
 def hello():
@@ -70,7 +70,11 @@ connecting_to_tor: 100% - Done
  * Serving Flask app "main"
  * Debug mode: off
  * Running on http://127.0.0.1:<port>/
+
+If you pass a persistent_key_file path, the first run will create a key file and subsequent runs will reuse it so the onion address stays the same. Set reuse_key=False to force a new address while still updating the stored key.
 ```
 
-### Credit :- [onionshare](https://github.com/onionshare/onionshare)
+## Tutorial
+[Watch Here](https://youtu.be/gmssaGzRT8M)
 
+### Credit :- [onionshare](https://github.com/onionshare/onionshare)

flask-tor-1.0.3/flask_tor/onionstart.py

@@ -1,36 +0,0 @@
-import os, shutil
-
-from . import common
-
-class OnionStart(object):
-    """
-    OnionShare is the main application class. Pass in options and run
-    start_onion_service and it will do the magic.
-    """
-    def __init__(self, onion, local_only=False, stay_open=False):
-
-        # The Onion object
-        self.onion = onion
-
-        self.hidserv_dir = None
-        self.onion_host = None
-        self.stealth = None
-        self.local_only = local_only
-
-    def start_onion_service(self):
-        """
-        Start the onionshare onion service.
-        """
-
-        # Choose a random port
-        self.port = common.get_available_port(17600, 17650)
-
-        if self.local_only:
-            self.onion_host = '127.0.0.1:{0:d}'.format(self.port)
-            return
-
-        self.onion_host = self.onion.start_onion_service(self.port)
-
-        if self.stealth:
-            self.auth_string = self.onion.auth_string
-