add tor

.env.example

@@ -8,6 +8,9 @@ CASHU_DIR=~/.cashu
 MINT_HOST=127.0.0.1
 MINT_PORT=3338
 
+SOCKS_HOST = localhost
+SOCKS_PORT = 9050
+
 # MINT 
 
 MINT_PRIVATE_KEY=supersecretprivatekey

README.md

@@ -106,7 +106,7 @@ cashu info
 
 Returns:
 ```bash
-Version: 0.4.2
+Version: 0.4.3
 Debug: False
 Cashu dir: /home/user/.cashu
 Wallet: wallet

cashu/core/settings.py

@@ -24,6 +24,9 @@ CASHU_DIR = env.str("CASHU_DIR", default=os.path.join(str(Path.home()), ".cashu"
 CASHU_DIR = CASHU_DIR.replace("~", str(Path.home()))
 assert len(CASHU_DIR), "CASHU_DIR not defined"
 
+SOCKS_HOST = env.str("SOCKS_HOST", default=None)
+SOCKS_PORT = env.int("SOCKS_PORT", default=9050)
+
 LIGHTNING = env.bool("LIGHTNING", default=True)
 LIGHTNING_FEE_PERCENT = env.float("LIGHTNING_FEE_PERCENT", default=1.0)
 assert LIGHTNING_FEE_PERCENT >= 0, "LIGHTNING_FEE_PERCENT must be at least 0"
@@ -48,4 +51,4 @@ LNBITS_ENDPOINT = env.str("LNBITS_ENDPOINT", default=None)
 LNBITS_KEY = env.str("LNBITS_KEY", default=None)
 
 MAX_ORDER = 64
-VERSION = "0.4.2"
+VERSION = "0.4.3"

cashu/tor/tor.pid

@@ -0,0 +1 @@
+26406

cashu/tor/tor.py

@@ -0,0 +1,120 @@
+import os
+import pathlib
+import platform
+import socket
+import subprocess
+from loguru import logger
+import time
+
+
+class TorProxy:
+    def __init__(self):
+        self.base_path = pathlib.Path(__file__).parent.resolve()
+        self.platform = platform.system()
+        self.keep_alive = 60 * 60  # seconds
+        self.tor_proc = None
+        self.pid_file = os.path.join(self.base_path, "tor.pid")
+        self.tor_pid = None
+        logger.info(f"Tor running: {self.is_running()}")
+        logger.info(
+            f"Tor port open: {self.is_port_open()}",
+        )
+        logger.info(f"Tor binary path: {self.tor_path()}")
+        logger.info(f"Tor config path: {self.tor_config_path()}")
+        logger.info(f"Tor PID in tor.pid: {self.read_pid()}")
+        logger.info(f"Tor PID running: {self.signal_pid(self.read_pid())}")
+        self.run_daemon()
+
+    def run_daemon(self):
+        if self.is_port_open() and not self.is_running():
+            raise Exception(
+                "Another Tor instance seems to be already running on port 9050."
+            )
+        if self.is_running():
+            logger.info("Tor proxy already running.")
+            return
+
+        self.tor_proc = subprocess.Popen(
+            [f"{self.tor_path()}", "--defaults-torrc", f"{self.tor_config_path()}"],
+            shell=False,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.STDOUT,
+        )
+        logger.info("Running tor daemon with pid {}".format(self.tor_proc.pid))
+        with open(self.pid_file, "w", encoding="utf-8") as f:
+            f.write(str(self.tor_proc.pid))
+
+    def stop_daemon(self, pid=None):
+        pid = pid or self.tor_proc.pid if self.tor_proc else None
+        if self.tor_proc and pid:
+            self.signal_pid(pid, 15)  # sigterm
+            time.sleep(5)
+            self.signal_pid(pid, 9)  # sigkill
+
+            if os.path.exists(self.pid_file):
+                os.remove(self.pid_file)
+
+    def tor_path(self):
+        PATHS = {
+            "Windows": os.path.join(self.base_path, "bundle", "win", "tor.exe"),
+            "Linux": os.path.join(self.base_path, "bundle", "linux", "tor"),
+            "Darwin": os.path.join(self.base_path, "bundle", "mac", "tor"),
+        }
+        # make sure that file has correct permissions
+        try:
+            logger.debug(f"Setting permissions of {PATHS[platform.system()]} to 755")
+            os.chmod(PATHS[platform.system()], 755)
+        except:
+            raise Exception("error setting permissions for tor binary.")
+        return PATHS[platform.system()]
+
+    def tor_config_path(self):
+        return os.path.join(self.base_path, "torrc")
+
+    def is_port_open(self):
+        s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+        location = ("127.0.0.1", 9050)
+        try:
+            s.connect(location)
+            s.close()
+            return True
+        except Exception as e:
+            return False
+
+    def is_running(self):
+        return self.tor_proc is not None
+
+    def read_pid(self):
+        if not os.path.isfile(self.pid_file):
+            return None
+        with open(self.pid_file, "r") as f:
+            pid = f.readlines()
+        # check if pid is valid
+        if len(pid) == 0 or not int(pid[0]) > 0:
+            return None
+        return pid[0]
+
+    def signal_pid(self, pid, signal=0):
+        """
+        Checks whether a process with pid is running (signal 0 is not a kill signal!)
+        or stops (signal 15) or kills it (signal 9).
+        """
+        if not pid:
+            return False
+        print(f"running {pid} with signal={signal}")
+        if not int(pid) > 0:
+            return False
+        pid = int(pid)
+        try:
+            os.kill(pid, signal)
+        except:
+            return False
+        else:
+            return True
+
+
+if __name__ == "__main__":
+    tor = TorProxy()
+    time.sleep(5)
+    logger.info("Killing Tor")
+    tor.stop_daemon()

cashu/tor/torrc

@@ -0,0 +1,254 @@
+## Configuration file for a typical Tor user
+## Last updated 28 February 2019 for Tor 0.3.5.1-alpha.
+## (may or may not work for much older or much newer versions of Tor.)
+##
+## Lines that begin with "## " try to explain what's going on. Lines
+## that begin with just "#" are disabled commands: you can enable them
+## by removing the "#" symbol.
+##
+## See 'man tor', or https://www.torproject.org/docs/tor-manual.html,
+## for more options you can use in this file.
+##
+## Tor will look for this file in various places based on your platform:
+## https://www.torproject.org/docs/faq#torrc
+
+## Tor opens a SOCKS proxy on port 9050 by default -- even if you don't
+## configure one below. Set "SOCKSPort 0" if you plan to run Tor only
+## as a relay, and not make any local application connections yourself.
+SOCKSPort 9050 # Default: Bind to localhost:9050 for local connections.
+#SOCKSPort 192.168.0.1:9100 # Bind to this address:port too.
+
+## Entry policies to allow/deny SOCKS requests based on IP address.
+## First entry that matches wins. If no SOCKSPolicy is set, we accept
+## all (and only) requests that reach a SOCKSPort. Untrusted users who
+## can access your SOCKSPort may be able to learn about the connections
+## you make.
+#SOCKSPolicy accept 192.168.0.0/16
+#SOCKSPolicy accept6 FC00::/7
+#SOCKSPolicy reject *
+SOCKSPolicy accept 127.0.0.1
+
+## Logs go to stdout at level "notice" unless redirected by something
+## else, like one of the below lines. You can have as many Log lines as
+## you want.
+##
+## We advise using "notice" in most cases, since anything more verbose
+## may provide sensitive information to an attacker who obtains the logs.
+##
+## Send all messages of level 'notice' or higher to /usr/local/var/log/tor/notices.log
+#Log notice file /usr/local/var/log/tor/notices.log
+## Send every possible message to /usr/local/var/log/tor/debug.log
+#Log debug file /usr/local/var/log/tor/debug.log
+## Use the system log instead of Tor's logfiles
+#Log notice syslog
+## To send all messages to stderr:
+#Log debug stderr
+
+## Uncomment this to start the process in the background... or use
+## --runasdaemon 1 on the command line. This is ignored on Windows;
+## see the FAQ entry if you want Tor to run as an NT service.
+#RunAsDaemon 1
+
+## The directory for keeping all the keys/etc. By default, we store
+## things in $HOME/.tor on Unix, and in Application Data\tor on Windows.
+#DataDirectory /usr/local/var/lib/tor
+
+## The port on which Tor will listen for local connections from Tor
+## controller applications, as documented in control-spec.txt.
+ControlPort 9051
+## If you enable the controlport, be sure to enable one of these
+## authentication methods, to prevent attackers from accessing it.
+HashedControlPassword 16:3F85DAF2A2A34032603235343E19ABBE3CB6BF03F1443984F21EEE749F
+#CookieAuthentication 1
+
+############### This section is just for location-hidden services ###
+
+## Once you have configured a hidden service, you can look at the
+## contents of the file ".../hidden_service/hostname" for the address
+## to tell people.
+##
+## HiddenServicePort x y:z says to redirect requests on port x to the
+## address y:z.
+
+#HiddenServiceDir /usr/local/var/lib/tor/hidden_service/
+#HiddenServicePort 80 127.0.0.1:80
+
+#HiddenServiceDir /usr/local/var/lib/tor/other_hidden_service/
+#HiddenServicePort 80 127.0.0.1:80
+#HiddenServicePort 22 127.0.0.1:22
+
+################ This section is just for relays #####################
+#
+## See https://www.torproject.org/docs/tor-doc-relay for details.
+
+## Required: what port to advertise for incoming Tor connections.
+#ORPort 9001
+## If you want to listen on a port other than the one advertised in
+## ORPort (e.g. to advertise 443 but bind to 9090), you can do it as
+## follows.  You'll need to do ipchains or other port forwarding
+## yourself to make this work.
+#ORPort 443 NoListen
+#ORPort 127.0.0.1:9090 NoAdvertise
+## If you want to listen on IPv6 your numeric address must be explictly
+## between square brackets as follows. You must also listen on IPv4.
+#ORPort [2001:DB8::1]:9050
+
+## The IP address or full DNS name for incoming connections to your
+## relay. Leave commented out and Tor will guess.
+Address 1.1.1.1
+
+## If you have multiple network interfaces, you can specify one for
+## outgoing traffic to use.
+## OutboundBindAddressExit will be used for all exit traffic, while
+## OutboundBindAddressOR will be used for all OR and Dir connections
+## (DNS connections ignore OutboundBindAddress).
+## If you do not wish to differentiate, use OutboundBindAddress to
+## specify the same address for both in a single line.
+#OutboundBindAddressExit 10.0.0.4
+#OutboundBindAddressOR 10.0.0.5
+
+## A handle for your relay, so people don't have to refer to it by key.
+## Nicknames must be between 1 and 19 characters inclusive, and must
+## contain only the characters [a-zA-Z0-9].
+## If not set, "Unnamed" will be used.
+#Nickname ididnteditheconfig
+
+## Define these to limit how much relayed traffic you will allow. Your
+## own traffic is still unthrottled. Note that RelayBandwidthRate must
+## be at least 75 kilobytes per second.
+## Note that units for these config options are bytes (per second), not
+## bits (per second), and that prefixes are binary prefixes, i.e. 2^10,
+## 2^20, etc.
+#RelayBandwidthRate 100 KBytes  # Throttle traffic to 100KB/s (800Kbps)
+#RelayBandwidthBurst 200 KBytes # But allow bursts up to 200KB (1600Kb)
+
+## Use these to restrict the maximum traffic per day, week, or month.
+## Note that this threshold applies separately to sent and received bytes,
+## not to their sum: setting "40 GB" may allow up to 80 GB total before
+## hibernating.
+##
+## Set a maximum of 40 gigabytes each way per period.
+#AccountingMax 40 GBytes
+## Each period starts daily at midnight (AccountingMax is per day)
+#AccountingStart day 00:00
+## Each period starts on the 3rd of the month at 15:00 (AccountingMax
+## is per month)
+#AccountingStart month 3 15:00
+
+## Administrative contact information for this relay or bridge. This line
+## can be used to contact you if your relay or bridge is misconfigured or
+## something else goes wrong. Note that we archive and publish all
+## descriptors containing these lines and that Google indexes them, so
+## spammers might also collect them. You may want to obscure the fact that
+## it's an email address and/or generate a new address for this purpose.
+##
+## If you are running multiple relays, you MUST set this option.
+##
+#ContactInfo Random Person <nobody AT example dot com>
+## You might also include your PGP or GPG fingerprint if you have one:
+#ContactInfo 0xFFFFFFFF Random Person <nobody AT example dot com>
+
+## Uncomment this to mirror directory information for others. Please do
+## if you have enough bandwidth.
+#DirPort 9030 # what port to advertise for directory connections
+## If you want to listen on a port other than the one advertised in
+## DirPort (e.g. to advertise 80 but bind to 9091), you can do it as
+## follows.  below too. You'll need to do ipchains or other port
+## forwarding yourself to make this work.
+#DirPort 80 NoListen
+#DirPort 127.0.0.1:9091 NoAdvertise
+## Uncomment to return an arbitrary blob of html on your DirPort. Now you
+## can explain what Tor is if anybody wonders why your IP address is
+## contacting them. See contrib/tor-exit-notice.html in Tor's source
+## distribution for a sample.
+#DirPortFrontPage /usr/local/etc/tor/tor-exit-notice.html
+
+## Uncomment this if you run more than one Tor relay, and add the identity
+## key fingerprint of each Tor relay you control, even if they're on
+## different networks. You declare it here so Tor clients can avoid
+## using more than one of your relays in a single circuit. See
+## https://www.torproject.org/docs/faq#MultipleRelays
+## However, you should never include a bridge's fingerprint here, as it would
+## break its concealability and potentially reveal its IP/TCP address.
+##
+## If you are running multiple relays, you MUST set this option.
+##
+## Note: do not use MyFamily on bridge relays.
+#MyFamily $keyid,$keyid,...
+
+## Uncomment this if you want your relay to be an exit, with the default
+## exit policy (or whatever exit policy you set below).
+## (If ReducedExitPolicy, ExitPolicy, or IPv6Exit are set, relays are exits.
+## If none of these options are set, relays are non-exits.)
+#ExitRelay 1
+
+## Uncomment this if you want your relay to allow IPv6 exit traffic.
+## (Relays do not allow any exit traffic by default.)
+#IPv6Exit 1
+
+## Uncomment this if you want your relay to be an exit, with a reduced set
+## of exit ports.
+#ReducedExitPolicy 1
+
+## Uncomment these lines if you want your relay to be an exit, with the
+## specified set of exit IPs and ports.
+##
+## A comma-separated list of exit policies. They're considered first
+## to last, and the first match wins.
+##
+## If you want to allow the same ports on IPv4 and IPv6, write your rules
+## using accept/reject *. If you want to allow different ports on IPv4 and
+## IPv6, write your IPv6 rules using accept6/reject6 *6, and your IPv4 rules
+## using accept/reject *4.
+##
+## If you want to _replace_ the default exit policy, end this with either a
+## reject *:* or an accept *:*. Otherwise, you're _augmenting_ (prepending to)
+## the default exit policy. Leave commented to just use the default, which is
+## described in the man page or at
+## https://www.torproject.org/documentation.html
+##
+## Look at https://www.torproject.org/faq-abuse.html#TypicalAbuses
+## for issues you might encounter if you use the default exit policy.
+##
+## If certain IPs and ports are blocked externally, e.g. by your firewall,
+## you should update your exit policy to reflect this -- otherwise Tor
+## users will be told that those destinations are down.
+##
+## For security, by default Tor rejects connections to private (local)
+## networks, including to the configured primary public IPv4 and IPv6 addresses,
+## and any public IPv4 and IPv6 addresses on any interface on the relay.
+## See the man page entry for ExitPolicyRejectPrivate if you want to allow
+## "exit enclaving".
+##
+#ExitPolicy accept *:6660-6667,reject *:* # allow irc ports on IPv4 and IPv6 but no more
+#ExitPolicy accept *:119 # accept nntp ports on IPv4 and IPv6 as well as default exit policy
+#ExitPolicy accept *4:119 # accept nntp ports on IPv4 only as well as default exit policy
+#ExitPolicy accept6 *6:119 # accept nntp ports on IPv6 only as well as default exit policy
+#ExitPolicy reject *:* # no exits allowed
+
+## Bridge relays (or "bridges") are Tor relays that aren't listed in the
+## main directory. Since there is no complete public list of them, even an
+## ISP that filters connections to all the known Tor relays probably
+## won't be able to block all the bridges. Also, websites won't treat you
+## differently because they won't know you're running Tor. If you can
+## be a real relay, please do; but if not, be a bridge!
+##
+## Warning: when running your Tor as a bridge, make sure than MyFamily is
+## NOT configured.
+#BridgeRelay 1
+## By default, Tor will advertise your bridge to users through various
+## mechanisms like https://bridges.torproject.org/. If you want to run
+## a private bridge, for example because you'll give out your bridge
+## address manually to your friends, uncomment this line:
+#PublishServerDescriptor 0
+
+## Configuration options can be imported from files or folders using the %include
+## option with the value being a path. If the path is a file, the options from the
+## file will be parsed as if they were written where the %include option is. If
+## the path is a folder, all files on that folder will be parsed following lexical
+## order. Files starting with a dot are ignored. Files on subfolders are ignored.
+## The %include option can be used recursively.
+#%include /etc/torrc.d/
+#%include /etc/torrc.custom
+
+#HTTPTunnelPort 8118

cashu/wallet/cli.py

@@ -19,7 +19,16 @@ from loguru import logger
 from cashu.core.base import Proof
 from cashu.core.helpers import sum_proofs
 from cashu.core.migrations import migrate_databases
-from cashu.core.settings import CASHU_DIR, DEBUG, ENV_FILE, LIGHTNING, MINT_URL, VERSION
+from cashu.core.settings import (
+    CASHU_DIR,
+    DEBUG,
+    ENV_FILE,
+    LIGHTNING,
+    MINT_URL,
+    VERSION,
+    SOCKS_HOST,
+    SOCKS_PORT,
+)
 from cashu.wallet import migrations
 from cashu.wallet.crud import (
     get_lightning_invoices,
@@ -387,10 +396,13 @@ async def wallets(ctx):
 @coro
 async def info(ctx):
     print(f"Version: {VERSION}")
-    print(f"Debug: {DEBUG}")
+    print(f"Wallet: {ctx.obj['WALLET_NAME']}")
+    if DEBUG:
+        print(f"Debug: {DEBUG}")
     print(f"Cashu dir: {CASHU_DIR}")
     if ENV_FILE:
         print(f"Settings: {ENV_FILE}")
-    print(f"Wallet: {ctx.obj['WALLET_NAME']}")
+    if SOCKS_HOST:
+        print(f"Socks proxy: {SOCKS_HOST}:{SOCKS_PORT}")
     print(f"Mint URL: {MINT_URL}")
     return

cashu/wallet/wallet.py

@@ -35,7 +35,7 @@ from cashu.core.script import (
     step2_carol_sign_tx,
 )
 from cashu.core.secp import PublicKey
-from cashu.core.settings import DEBUG, VERSION
+from cashu.core.settings import DEBUG, VERSION, SOCKS_HOST, SOCKS_PORT
 from cashu.core.split import amount_split
 from cashu.wallet.crud import (
     get_keyset,
@@ -57,9 +57,21 @@ class LedgerAPI:
 
     def __init__(self, url):
         self.url = url
-        self.s = requests.Session()
+        self.s = self._set_requests()
         self.s.headers.update({"Client-version": VERSION})
 
+    def _set_requests(self):
+        s = requests.Session()
+        if SOCKS_HOST:
+            proxies = {
+                "http": f"socks5://{SOCKS_HOST}:{SOCKS_PORT}",
+                "https": f"socks5://{SOCKS_HOST}:{SOCKS_PORT}",
+            }
+            s.proxies.update(proxies)
+            s.headers.update({"User-Agent": scrts.token_urlsafe(8)})
+
+        return s
+
     def _construct_proofs(
         self, promises: List[BlindedSignature], secrets: List[str], rs: List[str]
     ):

poetry.lock

@@ -397,6 +397,14 @@ python-versions = ">=3.6.8"
 [package.extras]
 diagrams = ["jinja2", "railroad-diagrams"]
 
+[[package]]
+name = "PySocks"
+version = "1.7.1"
+description = "A Python SOCKS client module. See https://github.com/Anorov/PySocks for more information."
+category = "main"
+optional = false
+python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*"
+
 [[package]]
 name = "pytest"
 version = "7.1.3"
@@ -658,7 +666,7 @@ testing = ["flake8 (<5)", "func-timeout", "jaraco.functools", "jaraco.itertools"
 [metadata]
 lock-version = "1.1"
 python-versions = "^3.7"
-content-hash = "6ba135e91c4ec10d7f55569ff65531717da6d7070d41355173f06f2cdfc1797f"
+content-hash = "aa0c3cf3a023b4143939128be203cf0c519341abc7cd7ef0b200694f8b925b78"
 
 [metadata.files]
 anyio = [
@@ -974,6 +982,11 @@ pyparsing = [
     {file = "pyparsing-3.0.9-py3-none-any.whl", hash = "sha256:5026bae9a10eeaefb61dab2f09052b9f4307d44aee4eda64b309723d8d206bbc"},
     {file = "pyparsing-3.0.9.tar.gz", hash = "sha256:2b020ecf7d21b687f219b71ecad3631f644a47f01403fa1d1036b0c6416d70fb"},
 ]
+PySocks = [
+    {file = "PySocks-1.7.1-py27-none-any.whl", hash = "sha256:08e69f092cc6dbe92a0fdd16eeb9b9ffbc13cadfe5ca4c7bd92ffb078b293299"},
+    {file = "PySocks-1.7.1-py3-none-any.whl", hash = "sha256:2725bd0a9925919b9b51739eea5f9e2bae91e83288108a9ad338b2e3a4435ee5"},
+    {file = "PySocks-1.7.1.tar.gz", hash = "sha256:3f8804571ebe159c380ac6de37643bb4685970655d3bba243530d6558b799aa0"},
+]
 pytest = [
     {file = "pytest-7.1.3-py3-none-any.whl", hash = "sha256:1377bda3466d70b55e3f5cecfa55bb7cfcf219c7964629b967c37cf0bda818b7"},
     {file = "pytest-7.1.3.tar.gz", hash = "sha256:4f365fec2dff9c1162f834d9f18af1ba13062db0c708bf7b946f8a5c76180c39"},

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cashu"
-version = "0.4.2"
+version = "0.4.3"
 description = "Ecash wallet and mint."
 authors = ["calle <callebtc@protonmail.com>"]
 license = "MIT"
@@ -23,6 +23,7 @@ secp256k1 = "^0.14.0"
 sqlalchemy-aio = "^0.17.0"
 python-bitcoinlib = "^0.11.2"
 h11 = "0.12.0"
+PySocks = "^1.7.1"
 
 [tool.poetry.dev-dependencies]
 black = {version = "^22.8.0", allow-prereleases = true}

requirements.txt

@@ -23,6 +23,7 @@ py==1.11.0 ; python_version >= "3.7" and python_version < "4.0"
 pycparser==2.21 ; python_version >= "3.7" and python_version < "4.0"
 pydantic==1.10.2 ; python_version >= "3.7" and python_version < "4.0"
 pyparsing==3.0.9 ; python_version >= "3.7" and python_version < "4.0"
+pysocks==1.7.1 ; python_version >= "3.7" and python_version < "4.0"
 pytest-asyncio==0.19.0 ; python_version >= "3.7" and python_version < "4.0"
 pytest==7.1.3 ; python_version >= "3.7" and python_version < "4.0"
 python-bitcoinlib==0.11.2 ; python_version >= "3.7" and python_version < "4.0"

setup.py

@@ -13,7 +13,7 @@ entry_points = {"console_scripts": ["cashu = cashu.wallet.cli:cli"]}
 
 setuptools.setup(
     name="cashu",
-    version="0.4.2",
+    version="0.4.3",
     description="Ecash wallet and mint with Bitcoin Lightning support",
     long_description=long_description,
     long_description_content_type="text/markdown",