diff --git a/docs/onion-message-channels.md b/docs/onion-message-channels.md index deb5af6..5926f43 100644 --- a/docs/onion-message-channels.md +++ b/docs/onion-message-channels.md @@ -14,7 +14,7 @@ This is a new way for Joinmarket bots to communicate, namely by serving and connecting to Tor onion services. This does not introduce any new requirements to your Joinmarket installation, technically, because the use of Payjoin already required the need -to service such onion services, and connecting to IRC used a SOCKS5 proxy (by default, and used by almost all users) over Tor to +to run such onion services, and connecting to IRC used a SOCKS5 proxy (used by almost all users) over Tor to a remote onion service. The purpose of this new type of message channel is as follows: @@ -25,23 +25,57 @@ albeit it was and remains E2E encrypted data, in either case) * the above can lead to better scalability at large numbers * a substantial increase in the speed of transaction negotiation; this is mostly related to the throttling of high bursts of traffic on IRC -The configuration for a user is simple; in their `joinmarket.cfg` they will add a messaging section like this: +The configuration for a user is simple; in their `joinmarket.cfg` they will get a messaging section like this, if they start from scratch: ``` -[MESSAGING:onion1] +[MESSAGING:onion] +# onion based message channels must have the exact type 'onion' +# (while the section name above can be MESSAGING:whatever), and there must +# be only ONE such message channel configured (note the directory servers +# can be multiple, below): type = onion -onion_serving_port = 8082 + +socks5_host = localhost +socks5_port = 9050 + +# the tor control configuration. +# for most people running the tor daemon +# on Linux, no changes are required here: +tor_control_host = localhost +# or, to use a UNIX socket +# tor_control_host = unix:/var/run/tor/control +tor_control_port = 9051 + +# the host/port actually serving the hidden service +# (note the *virtual port*, that the client uses, +# is hardcoded to 80): +onion_serving_host = 127.0.0.1 +onion_serving_port = 8080 + +# directory node configuration +# +# This is mandatory for directory nodes (who must also set their +# own *.onion:port as the only directory in directory_nodes, below), +# but NOT TO BE USED by non-directory nodes (which is you, unless +# you know otherwise!), as it will greatly degrade your privacy. +# (note the default is no value, don't replace it with ""). +hidden_service_dir = +# # This is a comma separated list (comma can be omitted if only one item). -# Each item has format host:port +# Each item has format host:port ; both are required, though port will +# be 80 if created in this code. directory_nodes = rr6f6qtleiiwic45bby4zwmiwjrj3jsbmcvutwpqxjziaydjydkk5iad.onion:80 + +# This setting is ONLY for developer regtest setups, +# running multiple bots at once. Don't alter it otherwise +regtest_count = 0,0 ``` -Here, I have deliberately omitted the several other settings in this section which will almost always be fine as default; -see `jmclient/jmclient/configure.py` for what those defaults are, and the extensive comments explaining. +All of these can be left as default for most users, except the field `directory_nodes`. -The main point is the list of **directory nodes** (the one shown here is one being run on signet, right now), which will +The list of **directory nodes** (the one shown here is one being run on signet, right now), which will be comma separated if multiple directory nodes are configured (we expect there will be 2 or 3 as a normal situation). -The `onion_serving_port` is on which port on the local machine the onion service is served. +The `onion_serving_port` is on which port on the local machine the onion service is served; you won't usually need to use it, but it mustn't conflict with some other usage (so if you have something running on port 8080, change it). The `type` field must always be `onion` in this case, and distinguishes it from IRC message channels and others. ### Can/should I still run IRC message channels? @@ -50,11 +84,24 @@ In short, yes. ### Do I need to configure Tor, and if so, how? -These message channels use both outbound and inbound connections to onion services (or "hidden services"). +To make outbound Tor connections to other onions in the network, you will need to configure the +SOCKS5 proxy settings (so, only directory nodes may *not* need this; everyone else does). +This is identical to what we already do for IRC, except that in this case, we disallow clearnet connections. + +#### Running/testing as a maker + +A maker will additionally allow *inbound* connections to an onion service. +This onion service will be ephemeral, that is, it will have a different onion address every time +you restart. This should work automatically, using your existing Tor daemon (here, we are using +the same code as we use when running the `receive-payjoin` script, essentially). + +#### Running/testing as other bots (taker) + +A taker will not attempt to serve an onion; it will only use outbound connections, first to directory +nodes and then, as according to need, to individual makers, also. -As previously mentioned, both of these features were already in use in Joinmarket. If you never served an -onion service before, it should work fine as long as you have the Tor service running in the background, -and the default control port 9051 (if not, change that value in the `joinmarket.cfg`, see above. +As previously mentioned, both of these features - inbound and outbound, to onion, Tor connections - were already in use in Joinmarket. If you want to run/test as a maker bot, but never served an onion service before, it should work fine as long as you have the Tor service running in the background, +and the default control port 9051 (if not, change that value in the `joinmarket.cfg`, see above). #### Why not use Lightning based onions? @@ -85,7 +132,7 @@ and pay attention to the settings in `regtest_joinmarket.cfg`.) There is no separate/special configuration for signet other than the configuration that is already needed for running Joinmarket against a signet backend (so e.g. RPC port of 38332). -Add the `[MESSAGING:onion1]` message channel section to your `joinmarket.cfg`, as listed above, including the +Add the `[MESSAGING:onion]` message channel section to your `joinmarket.cfg`, as listed above, including the signet directory node listed above (rr6f6qtleiiwic45bby4zwmiwjrj3jsbmcvutwpqxjziaydjydkk5iad.onion:80), and, for the simplest test, remove the other `[MESSAGING:*]` sections that you have. @@ -101,19 +148,19 @@ who would like to help by running a directory node. You can ignore it if that do This requires a long running bot. It should be on a server you can keep running permanently, so perhaps a VPS, but in any case, very high uptime. For reliability it also makes sense to configure to run as a systemd service. -A note: in this early stage, the usage of Lightning is only really network-layer stuff, and the usage of bitcoin, is none; feel free to add elements that remove any need for a backend bitcoin blockchain, but beware: future upgrades *could* mean that the directory node really does need the bitcoin backend. +A note: the most natural way to run the directory is as a Joinmarket *maker* bot, i.e. run `yg-privacyenhanced.py`, with configuration as described below. For now it will actually offer to do coinjoins - we will want to fix this in future so no coins are needed (but it can just be a trivial size). #### Joinmarket-specific configuration -Add `hidden_service_dir` to your `[MESSAGING:onion1]` with a directory accessible to your user. You may want to lock this down +Add `hidden_service_dir` to your `[MESSAGING:onion]` with a directory accessible to your user. You may want to lock this down a bit! The point to understand is: Joinmarket's `jmbase.JMHiddenService` will, if configured with a non-empty `hidden_service_dir` field, actually start an *independent* instance of Tor specifically for serving this, under the current user. -(our tor interface library `txtorcon` needs read access to the Tor HS dir, so it's troublesome to do this another way). +(our Tor interface library `txtorcon` needs read access to the Tor HS dir, so it's troublesome to do this another way). ##### Question: How to configure the `directory-nodes` list in our `joinmarket.cfg` for this directory node bot? -Answer: **you must only enter your own node in this list!** (otherwise you may find your bot infinitely rebroadcasting messages). +Answer: **you must only enter your own node in this list!**. This way your bot will recognize that it is a directory node and it avoids weird edge case behaviour (so don't add *other* known directory nodes; you won't be talking to them). #### Suggested setup of a service: @@ -143,7 +190,7 @@ WantedBy=multi-user.target ``` This is deliberately a super-basic setup (see above). Don't forget to setup your `bitcoin.conf` as usual, -for the bitcoin user, and make it match (specifically in terms of RPC) what you set up for Lightning below. +for the bitcoin user, and make it match (specifically in terms of RPC) what you set up for Joinmarket below. 2. @@ -167,7 +214,6 @@ To state the obvious, the idea here is that this second service will run the JM to ensure they start up in the correct order. Re: password echo, obviously this kind of password entry is bad; -for now we needn't worry as these nodes don't need to carry any real coins (and it's better they don't!). -Later we may need to change that (though of course you can use standard measures to protect the box). +for now we needn't worry as these nodes don't need to carry significant coins (and it's much better they don't!). TODO: add some material on network hardening/firewalls here, I guess. diff --git a/jmbase/jmbase/commands.py b/jmbase/jmbase/commands.py index 498b96e..d75721c 100644 --- a/jmbase/jmbase/commands.py +++ b/jmbase/jmbase/commands.py @@ -27,11 +27,11 @@ class JMInit(JMCommand): """Communicates the client's required setup configuration. Blockchain source is communicated only as a naming - tag for messagechannels (currently IRC 'realname' field). + tag for messagechannels (for IRC, 'realname' field). """ arguments = [(b'bcsource', Unicode()), (b'network', Unicode()), - (b'irc_configs', JsonEncodable()), + (b'chan_configs', JsonEncodable()), (b'minmakers', Integer()), (b'maker_timeout_sec', Integer()), (b'dust_threshold', Integer()), diff --git a/jmbase/test/test_commands.py b/jmbase/test/test_commands.py index c6e4100..0c05e95 100644 --- a/jmbase/test/test_commands.py +++ b/jmbase/test/test_commands.py @@ -43,9 +43,9 @@ def end_test(): class JMTestServerProtocol(JMBaseProtocol): @JMInit.responder - def on_JM_INIT(self, bcsource, network, irc_configs, minmakers, + def on_JM_INIT(self, bcsource, network, chan_configs, minmakers, maker_timeout_sec, dust_threshold, blacklist_location): - show_receipt("JMINIT", bcsource, network, irc_configs, minmakers, + show_receipt("JMINIT", bcsource, network, chan_configs, minmakers, maker_timeout_sec, dust_threshold, blacklist_location) d = self.callRemote(JMInitProto, nick_hash_length=1, @@ -137,7 +137,7 @@ class JMTestClientProtocol(JMBaseProtocol): d = self.callRemote(JMInit, bcsource="dummyblockchain", network="dummynetwork", - irc_configs=['dummy', 'irc', 'config'], + chan_configs=['dummy', 'irc', 'config'], minmakers=7, maker_timeout_sec=8, dust_threshold=1500, diff --git a/jmclient/jmclient/client_protocol.py b/jmclient/jmclient/client_protocol.py index 01b00b8..180932d 100644 --- a/jmclient/jmclient/client_protocol.py +++ b/jmclient/jmclient/client_protocol.py @@ -434,7 +434,7 @@ class JMMakerClientProtocol(JMClientProtocol): "blockchain_source") #needed only for channel naming convention network = jm_single().config.get("BLOCKCHAIN", "network") - irc_configs = self.factory.get_mchannels() + chan_configs = self.factory.get_mchannels(mode="MAKER") #only here because Init message uses this field; not used by makers TODO minmakers = jm_single().config.getint("POLICY", "minimum_makers") maker_timeout_sec = jm_single().maker_timeout_sec @@ -442,7 +442,7 @@ class JMMakerClientProtocol(JMClientProtocol): d = self.callRemote(commands.JMInit, bcsource=blockchain_source, network=network, - irc_configs=irc_configs, + chan_configs=chan_configs, minmakers=minmakers, maker_timeout_sec=maker_timeout_sec, dust_threshold=jm_single().DUST_THRESHOLD, @@ -601,7 +601,7 @@ class JMTakerClientProtocol(JMClientProtocol): "blockchain_source") #needed only for channel naming convention network = jm_single().config.get("BLOCKCHAIN", "network") - irc_configs = self.factory.get_mchannels() + chan_configs = self.factory.get_mchannels(mode="TAKER") minmakers = jm_single().config.getint("POLICY", "minimum_makers") maker_timeout_sec = jm_single().maker_timeout_sec @@ -614,7 +614,7 @@ class JMTakerClientProtocol(JMClientProtocol): d = self.callRemote(commands.JMInit, bcsource=blockchain_source, network=network, - irc_configs=irc_configs, + chan_configs=chan_configs, minmakers=minmakers, maker_timeout_sec=maker_timeout_sec, dust_threshold=jm_single().DUST_THRESHOLD, @@ -789,19 +789,20 @@ class JMClientProtocolFactory(protocol.ClientFactory): def setClient(self, client): self.proto_client = client + def getClient(self): return self.proto_client def buildProtocol(self, addr): return self.protocol(self, self.client) - def get_mchannels(self): + def get_mchannels(self, mode): """ A transparent wrapper that allows override, so that a script can return a customised set of message channel configs; currently used for testing multiple bots on regtest. """ - return get_mchannels() + return get_mchannels(mode) def start_reactor(host, port, factory=None, snickerfactory=None, bip78=False, jm_coinjoin=True, ish=True, diff --git a/jmclient/jmclient/configure.py b/jmclient/jmclient/configure.py index 0c3ff6b..ea04d0d 100644 --- a/jmclient/jmclient/configure.py +++ b/jmclient/jmclient/configure.py @@ -137,27 +137,7 @@ rpc_password = password # information. rpc_wallet_file = -## SERVER 1/3) Darkscience IRC (Tor, IP) -################################################################################ -[MESSAGING:server1] -# by default the legacy format without a `type` field is -# understood to be IRC, but you can, optionally, add it: -# type = irc -channel = joinmarket-pit -port = 6697 -usessl = true - -# For traditional IP (default): -host = irc.darkscience.net -socks5 = false - -# For Tor (recommended as clearnet alternative): -#host = darkirc6tqgpnwd3blln3yfv5ckl47eg7llfxkmtovrv7c7iwohhb6ad.onion -#socks5 = true -#socks5_host = localhost -#socks5_port = 9050 - -[MESSAGING:onion1] +[MESSAGING:onion] # onion based message channels must have the exact type 'onion' # (while the section name above can be MESSAGING:whatever), and there must # be only ONE such message channel configured (note the directory servers @@ -193,23 +173,59 @@ hidden_service_dir = # This is a comma separated list (comma can be omitted if only one item). # Each item has format host:port ; both are required, though port will # be 80 if created in this code. -directory_nodes = rr6f6qtleiiwic45bby4zwmiwjrj3jsbmcvutwpqxjziaydjydkk5iad.onion:80 +directory_nodes = rr6f6qtleiiwic45bby4zwmiwjrj3jsbmcvutwpqxjziaydjydkk5iad.onion:80,k74oyetjqgcamsyhlym2vgbjtvhcrbxr4iowd4nv4zk5sehw4v665jad.onion:80 # This setting is ONLY for developer regtest setups, # running multiple bots at once. Don't alter it otherwise regtest_count = 0,0 -## SERVER 3/3) ILITA IRC (Tor - disabled by default) +## IRC SERVER 1: Darkscience IRC (Tor, IP) +################################################################################ +[MESSAGING:server1] +# by default the legacy format without a `type` field is +# understood to be IRC, but you can, optionally, add it: +# type = irc +channel = joinmarket-pit +port = 6697 +usessl = true + +# For traditional IP: +#host = irc.darkscience.net +#socks5 = false + +# For Tor (recommended as clearnet alternative): +host = darkirc6tqgpnwd3blln3yfv5ckl47eg7llfxkmtovrv7c7iwohhb6ad.onion +socks5 = true +socks5_host = localhost +socks5_port = 9050 + +## IRC SERVER 2: ILITA IRC (optional IRC alternate, Tor only) +################################################################################ +[MESSAGING:server2] +channel = joinmarket-pit +port = 6667 +usessl = false +socks5 = true +socks5_host = localhost + +host = ilitafrzzgxymv6umx2ux7kbz3imyeko6cnqkvy4nisjjj4qpqkrptid.onion +socks5_port = 9050 + +## IRC SERVER 3) (backup) hackint IRC (Tor, IP) ################################################################################ #[MESSAGING:server3] -#channel = joinmarket-pit +# channel = joinmarket-pit +# For traditional IP: +## host = irc.hackint.org +## port = 6697 +## usessl = true +## socks5 = false +# For Tor (default): +#host = ncwkrwxpq2ikcngxq3dy2xctuheniggtqeibvgofixpzvrwpa77tozqd.onion #port = 6667 #usessl = false #socks5 = true #socks5_host = localhost - -# For Tor (recommended): -#host = ilitafrzzgxymv6umx2ux7kbz3imyeko6cnqkvy4nisjjj4qpqkrptid.onion #socks5_port = 9050 [LOGGING] @@ -510,7 +526,7 @@ def set_config(cfg, bcint=None): global_singleton.bc_interface = bcint -def get_mchannels(): +def get_mchannels(mode="TAKER"): SECTION_NAME = 'MESSAGING' # FIXME: remove in future release if jm_single().config.has_section(SECTION_NAME): @@ -521,65 +537,64 @@ def get_mchannels(): return _get_irc_mchannels_old() SECTION_NAME += ':' - sections = [] - for s in jm_single().config.sections(): - if s.startswith(SECTION_NAME): - sections.append(s) - assert sections irc_fields = [("host", str), ("port", int), ("channel", str), ("usessl", str), - ("socks5", str), ("socks5_host", str), ("socks5_port", str)] + ("socks5", str), ("socks5_host", str), ("socks5_port", int)] onion_fields = [("type", str), ("directory_nodes", str), ("regtest_count", str), ("socks5_host", str), ("socks5_port", int), ("tor_control_host", str), ("tor_control_port", int), ("onion_serving_host", str), ("onion_serving_port", int), ("hidden_service_dir", str)] - configs = [] - - # processing the IRC sections: - for section in sections: - if jm_single().config.has_option(section, "type"): - # legacy IRC configs do not have "type" but just - # in case, we'll allow the "irc" type: - if not jm_single().config.get(section, "type").lower( - ) == "irc": - break + def get_irc_section(s): server_data = {} - # check if socks5 is enabled for tor and load relevant config if so try: - server_data["socks5"] = jm_single().config.get(section, "socks5") + server_data["socks5"] = jm_single().config.get(s, "socks5") except NoOptionError: server_data["socks5"] = "false" if server_data["socks5"].lower() == 'true': - server_data["socks5_host"] = jm_single().config.get(section, "socks5_host") - server_data["socks5_port"] = jm_single().config.get(section, "socks5_port") + server_data["socks5_host"] = jm_single().config.get(s, "socks5_host") + server_data["socks5_port"] = jm_single().config.get(s, "socks5_port") for option, otype in irc_fields: - val = jm_single().config.get(section, option) + val = jm_single().config.get(s, option) server_data[option] = otype(val) server_data['btcnet'] = get_network() - configs.append(server_data) + return server_data - # processing the onion sections: - for section in sections: - if not jm_single().config.has_option(section, "type") or \ - not jm_single().config.get(section, "type").lower() == "onion": - continue + def get_onion_section(s): onion_data = {} for option, otype in onion_fields: try: - val = jm_single().config.get(section, option) + val = jm_single().config.get(s, option) except NoOptionError: continue onion_data[option] = otype(val) + # the onion messaging section must specify whether + # to serve an onion: + onion_data["serving"] = mode == "MAKER" onion_data['btcnet'] = get_network() # Just to allow a dynamic set of var: - onion_data["section-name"] = section - configs.append(onion_data) + onion_data["section-name"] = s + return onion_data - return configs + onion_sections = [] + irc_sections = [] + for section in jm_single().config.sections(): + if not section.startswith(SECTION_NAME): + continue + if jm_single().config.has_option(section, "type"): + channel_type = jm_single().config.get(section, "type").lower() + if channel_type == "onion": + onion_sections.append(get_onion_section(section)) + elif channel_type == "irc": + irc_sections.append(get_irc_section(section)) + else: + irc_sections.append(get_irc_section(section)) + assert irc_sections or onion_sections + assert len(onion_sections) < 2 + return irc_sections + onion_sections def _get_irc_mchannels_old(): fields = [("host", str), ("port", int), ("channel", str), ("usessl", str), @@ -777,11 +792,6 @@ def load_program_config(config_path="", bs=None, plugin_services=[]): if not os.path.exists(plogsdir): os.makedirs(plogsdir) p.set_log_dir(plogsdir) - # Check if a onion message channel was configured, and if so, - # check there is only 1; multiple directory nodes will be inside the config. - chans = get_mchannels() - onion_chans = [x for x in chans if "type" in x and x["type"] == "onion"] - assert len(onion_chans) < 2 def load_test_config(**kwargs): if "config_path" not in kwargs: diff --git a/jmclient/jmclient/wallet_rpc.py b/jmclient/jmclient/wallet_rpc.py index 68c8f89..dd50b72 100644 --- a/jmclient/jmclient/wallet_rpc.py +++ b/jmclient/jmclient/wallet_rpc.py @@ -423,8 +423,7 @@ class JMWalletDaemon(Service): walletname=self.wallet_name, token=self.cookie) - def taker_finished(self, res, fromtx=False, - waittime=0.0, txdetails=None): + def taker_finished(self, res, fromtx=False, waittime=0.0, txdetails=None): # This is a slimmed down version compared with what is seen in # the CLI code, since that code encompasses schedules with multiple # entries; for now, the RPC only supports single joins. @@ -1007,7 +1006,7 @@ class JMWalletDaemon(Service): self.taker = Taker(self.services["wallet"], schedule, max_cj_fee = max_cj_fee, callbacks=(self.filter_orders_callback, - None, self.taker_finished)) + None, self.taker_finished)) # TODO ; this makes use of a pre-existing hack to allow # selectively disabling the stallMonitor function that checks # if transactions went through or not; here we want to cleanly diff --git a/jmclient/test/test_client_protocol.py b/jmclient/test/test_client_protocol.py index d60adcb..d1f07f9 100644 --- a/jmclient/test/test_client_protocol.py +++ b/jmclient/test/test_client_protocol.py @@ -167,9 +167,9 @@ def end_test(): class JMTestServerProtocol(JMBaseProtocol): @JMInit.responder - def on_JM_INIT(self, bcsource, network, irc_configs, minmakers, + def on_JM_INIT(self, bcsource, network, chan_configs, minmakers, maker_timeout_sec, dust_threshold, blacklist_location): - show_receipt("JMINIT", bcsource, network, irc_configs, minmakers, + show_receipt("JMINIT", bcsource, network, chan_configs, minmakers, maker_timeout_sec, dust_threshold, blacklist_location) d = self.callRemote(JMInitProto, nick_hash_length=1, diff --git a/jmdaemon/jmdaemon/daemon_protocol.py b/jmdaemon/jmdaemon/daemon_protocol.py index d84bbb5..9fdd641 100644 --- a/jmdaemon/jmdaemon/daemon_protocol.py +++ b/jmdaemon/jmdaemon/daemon_protocol.py @@ -475,7 +475,7 @@ class JMDaemonServerProtocol(amp.AMP, OrderbookWatch): self.factory = factory self.jm_state = 0 self.restart_mc_required = False - self.irc_configs = None + self.chan_configs = None self.mcc = None #Default role is TAKER; must be overriden to MAKER in JMSetup message. self.role = "TAKER" @@ -504,7 +504,7 @@ class JMDaemonServerProtocol(amp.AMP, OrderbookWatch): d.addErrback(self.defaultErrback) @JMInit.responder - def on_JM_INIT(self, bcsource, network, irc_configs, minmakers, + def on_JM_INIT(self, bcsource, network, chan_configs, minmakers, maker_timeout_sec, dust_threshold, blacklist_location): """Reads in required configuration from client for a new session; feeds back joinmarket messaging protocol constants @@ -518,25 +518,25 @@ class JMDaemonServerProtocol(amp.AMP, OrderbookWatch): self.dust_threshold = int(dust_threshold) #(bitcoin) network only referenced in channel name construction self.network = network - if irc_configs == self.irc_configs: + if chan_configs == self.chan_configs: self.restart_mc_required = False log.msg("New init received did not require a new message channel" " setup.") else: - if self.irc_configs: + if self.chan_configs: #close the existing connections self.mc_shutdown() - self.irc_configs = irc_configs + self.chan_configs = chan_configs self.restart_mc_required = True mcs = [] - for c in self.irc_configs: + for c in self.chan_configs: if "type" in c and c["type"] == "onion": mcs.append(OnionMessageChannel(c, daemon=self)) else: # default is IRC; TODO allow others mcs.append(IRCMessageChannel(c, - daemon=self, - realname='btcint=' + bcsource)) + daemon=self, + realname='btcint=' + bcsource)) self.mcc = MessageChannelCollection(mcs) OrderbookWatch.set_msgchan(self, self.mcc) #register taker-specific msgchan callbacks here @@ -952,7 +952,7 @@ class JMDaemonServerProtocol(amp.AMP, OrderbookWatch): for a new transaction; effectively means any previous incomplete transaction is wiped. """ - self.jm_state = 0 #uninited + self.jm_state = 0 self.mcc.set_nick(nick) if self.restart_mc_required: self.mcc.run() diff --git a/jmdaemon/jmdaemon/message_channel.py b/jmdaemon/jmdaemon/message_channel.py index 9549f19..4b46d81 100644 --- a/jmdaemon/jmdaemon/message_channel.py +++ b/jmdaemon/jmdaemon/message_channel.py @@ -259,7 +259,7 @@ class MessageChannelCollection(object): for x in self.available_channels() if mc == x.hostid] if len(matching_channels) != 1: #pragma: no cover - #this can happen if an IRC goes down shortly before a message + #this can happen if a m-channel goes down shortly before a message #is supposed to be sent. There used to be an exception raise. #to prevent a crash (especially in makers), we just inform #the user about it for now diff --git a/jmdaemon/jmdaemon/onionmc.py b/jmdaemon/jmdaemon/onionmc.py index a426674..3d8bf8f 100644 --- a/jmdaemon/jmdaemon/onionmc.py +++ b/jmdaemon/jmdaemon/onionmc.py @@ -1,17 +1,24 @@ from jmdaemon.message_channel import MessageChannel from jmdaemon.protocol import COMMAND_PREFIX, JM_VERSION -from jmbase import get_log, JM_APP_NAME, JMHiddenService +from jmbase import get_log, JM_APP_NAME, JMHiddenService, stop_reactor import json import copy -from typing import Callable, Union +from typing import Callable, Union, Tuple, List from twisted.internet import reactor, task, protocol from twisted.protocols import basic +from twisted.application.internet import ClientService from twisted.internet.endpoints import TCP4ClientEndpoint from twisted.internet.address import IPv4Address, IPv6Address from txtorcon.socks import TorSocksEndpoint log = get_log() + +NOT_SERVING_ONION_HOSTNAME = "NOT-SERVING-ONION" + +def location_tuple_to_str(t: Tuple[str, int]) -> str: + return f"{t[0]}:{t[1]}" + def network_addr_to_string(location: Union[IPv4Address, IPv4Address]) -> str: if isinstance(location, (IPv4Address, IPv6Address)): host = location.host @@ -19,18 +26,17 @@ def network_addr_to_string(location: Union[IPv4Address, IPv4Address]) -> str: else: # TODO handle other addr types assert False - return host + ":" + str(port) + return location_tuple_to_str((host, port)) # module-level var to control whether we use Tor or not -# (specifically for tests): +# (specifically for tests) testing_mode = False def set_testing_mode(configdata: dict) -> None: """ Toggles testing mode which enables non-Tor network setup: """ global testing_mode - if not "regtest_count" in configdata: - log.debug("Onion message channel is not using regtest mode.") + if "regtest_count" not in configdata: testing_mode = False return try: @@ -39,7 +45,7 @@ def set_testing_mode(configdata: dict) -> None: log.info("Failed to get regtest count settings, error: {}".format(repr(e))) testing_mode = False return - if s == 0 and e == 0: + if s == e == 0: testing_mode = False return testing_mode = True @@ -97,6 +103,9 @@ class OnionPeerConnectionError(OnionPeerError): class OnionCustomMessageDecodingError(Exception): pass +class InvalidLocationStringError(Exception): + pass + class OnionCustomMessage(object): """ Encapsulates the messages passed over the wire to and from other onion peers @@ -105,49 +114,57 @@ class OnionCustomMessage(object): self.text = text self.msgtype = msgtype - def encode(self) -> str: + def encode(self) -> bytes: self.encoded = json.dumps({"type": self.msgtype, "line": self.text}).encode("utf-8") return self.encoded @classmethod - def from_string_decode(cls, msg: str) -> 'OnionCustomMessage': + def from_string_decode(cls, msg: bytes) -> 'OnionCustomMessage': """ Build a custom message from a json-ified string. """ try: msg_obj = json.loads(msg) text = msg_obj["line"] msgtype = msg_obj["type"] + # we insist on integer but not a valid msgtype, + # crudely 'syntax, not semantics': + # semantics is the job of the OnionMessageChannel object. + assert isinstance(msgtype, int) + assert isinstance(text, str) except: + # this blanket catch and re-raise: + # we must handle untrusted input bytes without + # crashing under any circumstance. raise OnionCustomMessageDecodingError return cls(text, msgtype) class OnionLineProtocol(basic.LineReceiver): def connectionMade(self): self.factory.register_connection(self) + basic.LineReceiver.connectionMade(self) def connectionLost(self, reason): self.factory.register_disconnection(self) + basic.LineReceiver.connectionLost(self, reason) - def lineReceived(self, line: str) -> None: - #print("received", repr(line)) + def lineReceived(self, line: bytes) -> None: try: msg = OnionCustomMessage.from_string_decode(line) except OnionCustomMessageDecodingError: - log.debug("Received invalid message, dropping connection.") + log.debug("Received invalid message: {}, " + "dropping connection.".format(line)) self.transport.loseConnection() return self.factory.receive_message(msg, self) def message(self, message: OnionCustomMessage) -> None: - #log.info("in OnionLineProtocol, about to send message: {} to peer {}".format(message.encode(), self.transport.getPeer())) - self.transport.write(message.encode() + self.delimiter) + self.sendLine(message.encode()) class OnionLineProtocolFactory(protocol.ServerFactory): """ This factory allows us to start up instances of the LineReceiver protocol that are instantiated towards us. - As such, it is responsible for keeping track """ protocol = OnionLineProtocol @@ -159,15 +176,15 @@ class OnionLineProtocolFactory(protocol.ServerFactory): # make a local control message registering # the new connection peer_location = network_addr_to_string(p.transport.getPeer()) - self.client.register_connection(peer_location, direction=0) self.peers[peer_location] = p + self.client.register_connection(peer_location, direction=0) def register_disconnection(self, p: OnionLineProtocol) -> None: # make a local control message registering - # the new connection + # the disconnection peer_location = network_addr_to_string(p.transport.getPeer()) self.client.register_disconnection(peer_location) - if not peer_location in self.peers: + if peer_location not in self.peers: log.warn("Disconnection event registered for non-existent peer.") return del self.peers[peer_location] @@ -178,16 +195,15 @@ class OnionLineProtocolFactory(protocol.ServerFactory): p.transport.getPeer())) def send(self, message: OnionCustomMessage, destination: str) -> bool: - #print("trying to send in OnionLineProtocolFactory.") - #print("message: {}, destination: {}".format(message.encode(), destination)) - if not (destination in self.peers): - print("sending message {}, destination {} was not in peers {}".format(message.encode(), destination, self.peers)) + if destination not in self.peers: + log.warn("sending message {}, destination {} was not in peers {}".format( + message.encode(), destination, self.peers)) return False proto = self.peers[destination] proto.message(message) return True -class OnionClientFactory(protocol.ServerFactory): +class OnionClientFactory(protocol.ReconnectingClientFactory): """ We define a distinct protocol factory for outbound connections. Notably, this factory supports only *one* protocol instance at a time. """ @@ -195,7 +211,9 @@ class OnionClientFactory(protocol.ServerFactory): def __init__(self, message_receive_callback: Callable, connection_callback: Callable, - disconnection_callback: Callable): + disconnection_callback: Callable, + directory: bool, + mc: 'OnionMessageChannel'): self.proto_client = None # callback takes OnionCustomMessage as arg and returns None self.message_receive_callback = message_receive_callback @@ -203,9 +221,32 @@ class OnionClientFactory(protocol.ServerFactory): self.connection_callback = connection_callback # disconnection the same self.disconnection_callback = disconnection_callback + # is this connection to a directory? + self.directory = directory + # to keep track of state of overall messagechannel + self.mc = mc + + def clientConnectionLost(self, connector, reason): + log.debug('Onion client connection lost: ' + str(reason)) + # persistent reconnection is reserved for directories; + # for makers, it isn't logical to keep trying; they may + # well have just shut down the onion permanently, and we can + # reach them via directory anyway. + if self.directory and not self.mc.give_up: + if reactor.running: + log.info('Attempting to reconnect...') + protocol.ReconnectingClientFactory.clientConnectionLost(self, + connector, reason) + def clientConnectionFailed(self, connector, reason): + log.info('Onion client connection failed: ' + str(reason)) + # reasoning here exactly as for clientConnectionLost + if self.directory and not self.mc.give_up: + if reactor.running: + log.info('Attempting to reconnect...') + protocol.ReconnectingClientFactory.clientConnectionFailed(self, + connector, reason) def register_connection(self, p: OnionLineProtocol) -> None: - #print("in OnionClientFactory, registered a connection, proto instance: ", p) self.proto_client = p self.connection_callback() @@ -215,33 +256,19 @@ class OnionClientFactory(protocol.ServerFactory): def send(self, msg: OnionCustomMessage) -> bool: self.proto_client.message(msg) + # Unlike the serving protocol, the client protocol + # is never in a condition of not knowing the counterparty + return True def receive_message(self, message: OnionCustomMessage, p: OnionLineProtocol) -> None: self.message_receive_callback(message) - """ - def clientConnectionLost(self, connector, reason): - log.debug('Connection to peer lost: {}, reason: {}'.format(connector, reason)) - if reactor.running: - log.info('Attempting to reconnect...') - protocol.ReconnectingClientFactory.clientConnectionLost( - self, connector, reason) - - def clientConnectionFailed(self, connector, reason): - log.debug('Connection to peer failed: {}, reason: {}'.format( - connector, reason)) - if reactor.running: - log.info('Attempting to reconnect...') - protocol.ReconnectingClientFactory.clientConnectionFailed( - self, connector, reason) - """ - class OnionPeer(object): def __init__(self, messagechannel: 'OnionMessageChannel', socks5_host: str, socks5_port: int, - hostname: str=None, port: int=-1, + location_tuple: Tuple[str, int], directory: bool=False, nick: str="", handshake_callback: Callable=None): # reference to the managing OnionMessageChannel instance is @@ -253,9 +280,19 @@ class OnionPeer(object): self.socks5_host = socks5_host self.socks5_port = socks5_port # remote net config: - self.hostname = hostname - self.port = port - if directory and not (self.hostname): + self.hostname = location_tuple[0] + self.port = location_tuple[1] + # alternate location strings are used for inbound + # connections for this peer (these will be used by + # directories and onion-serving peers, sending + # messages backwards on a connection created towards them). + self.alternate_location = "" + if self.hostname != NOT_SERVING_ONION_HOSTNAME: + # There is no harm in always setting it by default; + # it only gets used if we don't have an outbound. + self.set_alternate_location(location_tuple_to_str( + location_tuple)) + if directory and not self.hostname: raise OnionPeerDirectoryWithoutHostError() self.directory = directory self._status = PEER_STATUS_UNCONNECTED @@ -267,13 +304,11 @@ class OnionPeer(object): # to the remote peer. Note that this won't always be used, # if we have an inbound connection from this peer: self.factory = None - # alternate location strings are used for inbound - # connections for this peer (these will be used first - # and foremost by directories, sending messages backwards - # on a connection created towards them). - self.alternate_location = "" + # the reconnecting service allows auto-reconnection to + # some peers: + self.reconnecting_service = None - def set_alternate_location(self, location_string: str): + def set_alternate_location(self, location_string: str) -> None: self.alternate_location = location_string def update_status(self, destn_status: int) -> None: @@ -284,8 +319,7 @@ class OnionPeer(object): assert destn_status in range(4) ignored_updates = [] if self._status == PEER_STATUS_UNCONNECTED: - allowed_updates = [PEER_STATUS_CONNECTED, - PEER_STATUS_DISCONNECTED] + allowed_updates = [PEER_STATUS_CONNECTED] elif self._status == PEER_STATUS_CONNECTED: # updates from connected->connected are harmless allowed_updates = [PEER_STATUS_CONNECTED, @@ -298,7 +332,6 @@ class OnionPeer(object): allowed_updates = [PEER_STATUS_CONNECTED] ignored_updates = [PEER_STATUS_DISCONNECTED] if destn_status in ignored_updates: - # TODO: this happens sometimes from 2->1; why? log.debug("Attempt to update status of peer from {} " "to {} ignored.".format(self._status, destn_status)) return @@ -307,7 +340,8 @@ class OnionPeer(object): self._status = destn_status # the handshakes are always initiated by a client: if destn_status == PEER_STATUS_CONNECTED: - log.info("We, {}, are calling the handshake callback as client.".format(self.messagechannel.self_as_peer.peer_location())) + log.info("We, {}, are calling the handshake callback as client.".format( + self.messagechannel.self_as_peer.peer_location())) self.handshake_callback(self) def status(self) -> int: @@ -336,26 +370,31 @@ class OnionPeer(object): connection information given by the network interface. TODO: special handling for inbound is needed. """ - host, port = location.split(":") - return cls(mc, socks5_host, socks5_port, hostname=host, - port=int(port), directory=directory, + try: + host, port = location.split(":") + portint = int(port) + except: + raise InvalidLocationStringError(location) + return cls(mc, socks5_host, socks5_port, + (host, portint), directory=directory, handshake_callback=handshake_callback) - def set_host_port(self, hostname: str, port: int) -> None: - """ If the connection info is discovered - after this peer was already added to our list, - we can set it with this method. - """ - self.hostname = hostname - self.port = port - def set_location(self, location_string: str) -> bool: """ Allows setting location from an unchecked - input string argument; if the string does not have - the required format, - will return False, otherwise self.hostname, self.port are + input string argument. + If the location is specified as the 'no serving' case, + we put the currently existing inbound connection as the alternate + location, and the NOT_SERVING const as the 'location', returning True. + If the string does not have the required format, will return False, + otherwise self.hostname, self.port are updated for future `peer_location` calls, and True is returned. """ + if location_string == NOT_SERVING_ONION_HOSTNAME: + self.set_alternate_location(location_tuple_to_str( + (self.hostname, self.port))) + self.hostname = NOT_SERVING_ONION_HOSTNAME + self.port = -1 + return True try: host, port = location_string.split(":") portint = int(port) @@ -369,21 +408,23 @@ class OnionPeer(object): return True def peer_location(self) -> str: - assert (self.hostname and self.port > 0) - return self.hostname + ":" + str(self.port) + if self.hostname == NOT_SERVING_ONION_HOSTNAME: + # special case for non-reachable peers, which can include + # self_as_peer: we just return this string constant + return NOT_SERVING_ONION_HOSTNAME + # in every other case we need a sensible port/host combo: + assert (self.port > 0 and self.hostname) + return location_tuple_to_str((self.hostname, self.port)) def send(self, message: OnionCustomMessage) -> bool: """ If the message can be sent on either an inbound or outbound connection, True is returned, else False. """ if not self.factory: - #print("We are: {}. peer, wich was directory {}, did not have factory, so we send via mc".format( - # self.messagechannel.self_as_peer.peer_location(), self.directory)) # we try to send via the overall message channel serving # protocol, i.e. we assume the connection was made inbound: - #print("and to this location: ", self.peer_location()) - return self.messagechannel.proto_factory.send(message, self.alternate_location) - #print("peer which was directory {} did have factory {}, we send via that".format(self.directory, self.factory)) + return self.messagechannel.proto_factory.send(message, + self.alternate_location) return self.factory.send(message) def receive_message(self, message: OnionCustomMessage) -> None: @@ -392,8 +433,6 @@ class OnionPeer(object): def connect(self) -> None: """ This method is called to connect, over Tor, to the remote peer at the given onion host/port. - The connection is 'persistent' in the sense that we use a - ReconnectingClientFactory. """ if self._status in [PEER_STATUS_HANDSHAKED, PEER_STATUS_CONNECTED]: return @@ -402,18 +441,25 @@ class OnionPeer(object): "Cannot connect without host, port info") self.factory = OnionClientFactory(self.receive_message, - self.register_connection, self.register_disconnection) + self.register_connection, self.register_disconnection, + self.directory, self.messagechannel) if testing_mode: - print("{} is making a tcp connection to {}, {}, {},".format( - self.messagechannel.self_as_peer.peer_location(), self.hostname, self.port, self.factory)) - self.tcp_connector = reactor.connectTCP(self.hostname, self.port, self.factory) + log.debug("{} is making a tcp connection to {}, {}, {},".format( + self.messagechannel.self_as_peer.peer_location(), self.hostname, + self.port, self.factory)) + self.tcp_connector = reactor.connectTCP(self.hostname, self.port, + self.factory) else: - torEndpoint = TCP4ClientEndpoint(reactor, self.socks5_host, self.socks5_port) - onionEndpoint = TorSocksEndpoint(torEndpoint, self.hostname, self.port) - onionEndpoint.connect(self.factory) + torEndpoint = TCP4ClientEndpoint(reactor, self.socks5_host, + self.socks5_port) + onionEndpoint = TorSocksEndpoint(torEndpoint, self.hostname, + self.port) + self.reconnecting_service = ClientService(onionEndpoint, self.factory) + self.reconnecting_service.startService() def register_connection(self) -> None: - self.messagechannel.register_connection(self.peer_location(), direction=1) + self.messagechannel.register_connection(self.peer_location(), + direction=1) def register_disconnection(self) -> None: self.messagechannel.register_disconnection(self.peer_location()) @@ -425,6 +471,8 @@ class OnionPeer(object): try: self.connect() except OnionPeerConnectionError as e: + # Note that this will happen naturally for non-serving peers. + # TODO remove message or change it. log.debug("Tried to connect but failed: {}".format(repr(e))) except Exception as e: log.warn("Got unexpected exception in connect attempt: {}".format( @@ -436,12 +484,12 @@ class OnionPeer(object): if not (self.hostname and self.port > 0): raise OnionPeerConnectionError( "Cannot disconnect without host, port info") - d = self.reconnecting_service.stopService() + d = self.factory.proto_client.transport.loseConnection() d.addCallback(self.complete_disconnection) d.addErrback(log.warn, "Failed to disconnect from peer {}.".format( self.peer_location())) - def complete_disconnection(self): + def complete_disconnection(self) -> None: log.debug("Disconnected from peer: {}".format(self.peer_location())) self.update_status(PEER_STATUS_DISCONNECTED) self.factory = None @@ -462,11 +510,15 @@ class OnionDirectoryPeer(OnionPeer): except OnionPeerConnectionError: reactor.callLater(self.delay, self.try_to_connect) + class OnionMessageChannel(MessageChannel): - """ Receives messages via a Torv3 hidden/onion service. - Sends messages to other nodes of the same type over Tor + """ Sends messages to other nodes of the same type over Tor via SOCKS5. - Uses one or more configured "directory nodes" + *Optionally*: Receives messages via a Torv3 hidden/onion service. + If no onion service, it means we only have connections outbound + to other onion services (directory nodes first, others if and + when they send us a privmsg.). + Uses one or more configured "directory nodes" (which could be us) to access a list of current active nodes, and updates dynamically from messages seen. """ @@ -478,54 +530,69 @@ class OnionMessageChannel(MessageChannel): # hostid is a feature to avoid replay attacks across message channels; # TODO investigate, but for now, treat onion-based as one "server". self.hostid = "onion-network" + # receives notification that we are shutting down + self.give_up = False + # for backwards compat: make sure MessageChannel log can refer to + # this in dynamic switch message: + self.serverport = self.hostid self.tor_control_host = configdata["tor_control_host"] - self.tor_control_port = int(configdata["tor_control_port"]) + self.tor_control_port = configdata["tor_control_port"] self.onion_serving_host=configdata["onion_serving_host"] - self.onion_serving_port=int(configdata["onion_serving_port"]) - self.hidden_service_dir = configdata["hidden_service_dir"] + self.onion_serving = configdata["serving"] + if self.onion_serving: + self.onion_serving_port = configdata["onion_serving_port"] + self.hidden_service_dir = configdata["hidden_service_dir"] # client side config: - self.socks5_host = "127.0.0.1" - self.socks5_port = 9050 + self.socks5_host = configdata["socks5_host"] + self.socks5_port = configdata["socks5_port"] # we use the setting in the config sent over from # the client, to decide whether to set up our connections # over localhost (if testing), without Tor: set_testing_mode(configdata) - log.info("after call to testing_mode, it is: {}".format(testing_mode)) # keep track of peers. the list will be instances # of OnionPeer: self.peers = set() - for dn in configdata["directory_nodes"].split(","): + for dn in [x.strip() for x in configdata["directory_nodes"].split(",")]: # note we don't use a nick for directories: - self.peers.add(OnionDirectoryPeer.from_location_string( - self, dn, self.socks5_host, self.socks5_port, - directory=True, handshake_callback=self.handshake_as_client)) + try: + self.peers.add(OnionDirectoryPeer.from_location_string( + self, dn, self.socks5_host, self.socks5_port, + directory=True, handshake_callback=self.handshake_as_client)) + except InvalidLocationStringError as e: + log.error("Failed to load directory nodes: {}".format(repr(e))) + stop_reactor() + return # we can direct messages via the protocol factory, which # will index protocol connections by peer location: self.proto_factory = OnionLineProtocolFactory(self) - if testing_mode: - # we serve over TCP: - self.testing_serverconn = reactor.listenTCP(self.onion_serving_port, - self.proto_factory, interface="localhost") - self.onion_hostname = "127.0.0.1" + if self.onion_serving: + if testing_mode: + # we serve over TCP: + self.testing_serverconn = reactor.listenTCP(self.onion_serving_port, + self.proto_factory, interface="localhost") + self.onion_hostname = "127.0.0.1" + else: + self.hs = JMHiddenService(self.proto_factory, + self.info_callback, + self.setup_error_callback, + self.onion_hostname_callback, + self.tor_control_host, + self.tor_control_port, + self.onion_serving_host, + self.onion_serving_port, + shutdown_callback=self.shutdown_callback, + hidden_service_dir=self.hidden_service_dir) + # this call will start bringing up the HS; when it's finished, + # it will fire the `onion_hostname_callback`, or if it fails, + # it'll fire the `setup_error_callback`. + self.hs.start_tor() + + # This will serve as our unique identifier, indicating + # that we are ready to communicate (in both directions) over Tor. + self.onion_hostname = None else: - self.hs = JMHiddenService(self.proto_factory, - self.info_callback, - self.setup_error_callback, - self.onion_hostname_callback, - self.tor_control_host, - self.tor_control_port, - self.onion_serving_host, - self.onion_serving_port, - shutdown_callback=self.shutdown_callback, - hidden_service_dir=self.hidden_service_dir) - # this call will start bringing up the HS; when it's finished, - # it will fire the `onion_hostname_callback`, or if it fails, - # it'll fire the `setup_error_callback`. - self.hs.start_tor() - - # This will serve as our unique identifier, indicating - # that we are ready to communicate (in both directions) over Tor. - self.onion_hostname = None + # dummy 'hostname' to indicate we can start running immediately: + self.onion_hostname = NOT_SERVING_ONION_HOSTNAME # intended to represent the special case of 'we are the # only directory node known', however for now dns don't interact @@ -537,23 +604,21 @@ class OnionMessageChannel(MessageChannel): # the rpc connection calls are not using twisted) self.wait_for_directories_loop = None - def info_callback(self, msg): + def info_callback(self, msg: str) -> None: log.info(msg) - def setup_error_callback(self, msg): + def setup_error_callback(self, msg: str) -> None: log.error(msg) - def shutdown_callback(self, msg): + def shutdown_callback(self, msg: str) -> None: log.info("in shutdown callback: {}".format(msg)) - def onion_hostname_callback(self, hostname): + def onion_hostname_callback(self, hostname: str) -> None: """ This entrypoint marks the start of the OnionMessageChannel running, since we need this unique identifier as our name before we can start working (we need to compare it with the configured directory nodes). """ - print("hostname: ", hostname) - print("type: ", type(hostname)) log.info("setting onion hostname to : {}".format(hostname)) self.onion_hostname = hostname @@ -562,6 +627,12 @@ class OnionMessageChannel(MessageChannel): self.hs_up_loop = task.LoopingCall(self.check_onion_hostname) self.hs_up_loop.start(0.5) + def shutdown(self) -> None: + self.give_up = True + for p in self.peers: + if p.reconnecting_service: + p.reconnecting_service.stopService() + def get_pubmsg(self, msg:str, source_nick:str ="") -> str: """ Converts a message into the known format for pubmsgs; if we are not sending this (because we @@ -572,7 +643,7 @@ class OnionMessageChannel(MessageChannel): return nick + COMMAND_PREFIX + "PUBLIC" + msg def get_privmsg(self, nick: str, cmd: str, message: str, - source_nick=None) -> None: + source_nick=None) -> str: """ See `get_pubmsg` for comment on `source_nick`. """ from_nick = source_nick if source_nick else self.nick @@ -584,34 +655,36 @@ class OnionMessageChannel(MessageChannel): send the message to every known directory node, with the PUBLIC message type and nick. """ - peerids = self.get_directory_peers() + dps = self.get_directory_peers() msg = OnionCustomMessage(self.get_pubmsg(msg), JM_MESSAGE_TYPES["pubmsg"]) - for peerid in peerids: + for dp in dps: # currently a directory node can send its own # pubmsgs (act as maker or taker); this will # probably be removed but is useful in testing: - if peerid == self.self_as_peer.peer_location(): + if dp == self.self_as_peer: self.receive_msg(msg, "00") else: - self._send(self.get_peer_by_id(peerid), msg) + self._send(dp, msg) def _privmsg(self, nick: str, cmd: str, msg:str) -> None: - log.debug("Privmsging to: {}, {}, {}".format(nick, cmd, msg)) + # in certain test scenarios the directory may try to transfer + # commitments to itself: + if nick == self.nick: + log.debug("Not sending message to ourselves: {}, {}, {}".format( + nick, cmd, msg)) + return encoded_privmsg = OnionCustomMessage(self.get_privmsg(nick, cmd, msg), JM_MESSAGE_TYPES["privmsg"]) - peerid = self.get_peerid_by_nick(nick) - if peerid: - peer = self.get_peer_by_id(peerid) - # notice the order matters here!: - if not peerid or not peer or not peer.status() == PEER_STATUS_HANDSHAKED: + peer = self.get_peer_by_nick(nick) + if not peer or peer.status() != PEER_STATUS_HANDSHAKED: # If we are trying to message a peer via their nick, we # may not yet have a connection; then we just # forward via directory nodes. log.debug("Privmsg peer: {} but don't have peerid; " "sending via directory.".format(nick)) try: - # TODO change this to redundant or switching? + # TODO change this to redundant or switching peer = self.get_connected_directory_peers()[0] except Exception as e: log.warn("Failed to send privmsg because no " @@ -625,7 +698,7 @@ class OnionMessageChannel(MessageChannel): # End ABC implementation section - def check_onion_hostname(self): + def check_onion_hostname(self) -> None: if not self.onion_hostname: return self.hs_up_loop.stop() @@ -638,30 +711,37 @@ class OnionMessageChannel(MessageChannel): # start sending us messages. reactor.callLater(0.0, self.connect_to_directories) + def get_my_location_tuple(self) -> Tuple[str, int]: + if self.onion_hostname == NOT_SERVING_ONION_HOSTNAME: + return (self.onion_hostname, -1) + elif testing_mode: + return (self.onion_hostname, self.onion_serving_port) + else: + return (self.onion_hostname, 80) + def get_our_peer_info(self) -> None: """ Create a special OnionPeer object, outside of our peerlist, to refer to ourselves. """ - dp = self.get_directory_peers() + dps = self.get_directory_peers() self_dir = False - # only for publically exposed onion does the 'virtual port' exist; + # only for publicly exposed onion does the 'virtual port' exist; # for local tests we always connect to an actual machine port: - port_to_check = 80 if not testing_mode else self.onion_serving_port - my_location_str = self.onion_hostname + ":" + str(port_to_check) - log.info("To check if we are genesis, we compare {} with {}".format(my_location_str, dp)) - if [my_location_str] == dp: + my_location_tuple = self.get_my_location_tuple() + my_location_str = location_tuple_to_str(my_location_tuple) + if [my_location_str] == [d.peer_location() for d in dps]: log.info("This is the genesis node: {}".format(self.onion_hostname)) self.genesis_node = True self_dir = True - elif my_location_str in dp: + elif my_location_str in dps: # Here we are just one of many directory nodes, # which should be fine, we should just be careful # to not query ourselves. self_dir = True self.self_as_peer = OnionPeer(self, self.socks5_host, self.socks5_port, - self.onion_hostname, self.onion_serving_port, - self_dir, nick=self.nick, - handshake_callback=None) + my_location_tuple, + self_dir, nick=self.nick, + handshake_callback=None) def connect_to_directories(self) -> None: if self.genesis_node: @@ -686,32 +766,33 @@ class OnionMessageChannel(MessageChannel): def handshake_as_client(self, peer: OnionPeer) -> None: assert peer.status() == PEER_STATUS_CONNECTED if self.self_as_peer.directory: - log.debug("Not sending client handshake to {} because we are directory.".format(peer.peer_location())) + log.debug("Not sending client handshake to {} because we " + "are directory.".format(peer.peer_location())) return our_hs = copy.deepcopy(client_handshake_json) our_hs["location-string"] = self.self_as_peer.peer_location() our_hs["nick"] = self.nick - # We fire and forget the handshake; successful setting - # of the `is_handshaked` var in the Peer object will depend - # on a valid/success return via the custommsg hook in the plugin. - log.info("Sending this handshake: {} to peer {}".format(json.dumps(our_hs), peer.peer_location())) - self._send(peer, OnionCustomMessage(json.dumps(our_hs), + our_hs_json = json.dumps(our_hs) + log.info("Sending this handshake: {} to peer {}".format( + our_hs_json, peer.peer_location())) + self._send(peer, OnionCustomMessage(our_hs_json, CONTROL_MESSAGE_TYPES["handshake"])) def handshake_as_directory(self, peer: OnionPeer, our_hs: dict) -> None: assert peer.status() == PEER_STATUS_CONNECTED - log.info("Sending this handshake as directory: {}".format(json.dumps(our_hs))) - self._send(peer, OnionCustomMessage(json.dumps(our_hs), + our_hs_json = json.dumps(our_hs) + log.info("Sending this handshake as directory: {}".format( + our_hs_json)) + self._send(peer, OnionCustomMessage(our_hs_json, CONTROL_MESSAGE_TYPES["dn-handshake"])) def get_directory_peers(self) -> list: - return [ p.peer_location() for p in self.peers if p.directory is True] + return [p for p in self.peers if p.directory is True] - def get_peerid_by_nick(self, nick:str) -> Union[OnionPeer, None]: + def get_peer_by_nick(self, nick:str) -> Union[OnionPeer, None]: for p in self.get_all_connected_peers(): if p.nick == nick: - return p.peer_location() - return None + return p def _send(self, peer: OnionPeer, message: OnionCustomMessage) -> bool: try: @@ -723,10 +804,6 @@ class OnionMessageChannel(MessageChannel): peer.peer_location(), repr(e))) return False - def shutdown(self): - """ TODO - """ - def receive_msg(self, message: OnionCustomMessage, peer_location: str) -> None: """ Messages from peers and also connection related control messages. These messages either come via OnionPeer or via @@ -734,7 +811,8 @@ class OnionMessageChannel(MessageChannel): inbound connections. """ if self.self_as_peer.directory: - print("received message as directory: ", message.encode()) + # TODO remove, useful while testing + log.debug("received message as directory: {}".format(message.encode())) peer = self.get_peer_by_id(peer_location) if not peer: log.warn("Received message but could not find peer: {}".format(peer_location)) @@ -752,7 +830,7 @@ class OnionMessageChannel(MessageChannel): return # ignore non-JM messages: - if not msgtype in JM_MESSAGE_TYPES.values(): + if msgtype not in JM_MESSAGE_TYPES.values(): log.debug("Invalid message type, ignoring: {}".format(msgtype)) return @@ -762,8 +840,6 @@ class OnionMessageChannel(MessageChannel): from_nick, to_nick = nicks_msgs[:2] msg = COMMAND_PREFIX + COMMAND_PREFIX.join(nicks_msgs[2:]) if to_nick == "PUBLIC": - #log.debug("A pubmsg is being processed by {} from {}; it " - # "is {}".format(self.self_as_peer.nick, from_nick, msg)) self.on_pubmsg(from_nick, msg) if self.self_as_peer.directory: self.forward_pubmsg_to_peers(msg, from_nick) @@ -775,9 +851,8 @@ class OnionMessageChannel(MessageChannel): else: self.on_privmsg(from_nick, msg) except Exception as e: - log.debug("Invalid joinmarket message: {}, error was: {}".format( + log.debug("Invalid Joinmarket message: {}, error was: {}".format( msgval, repr(e))) - return def forward_pubmsg_to_peers(self, msg: str, from_nick: str) -> None: """ Used by directory nodes currently. Takes a received @@ -806,35 +881,37 @@ class OnionMessageChannel(MessageChannel): def forward_privmsg_to_peer(self, nick: str, message: str, from_nick: str) -> None: assert self.self_as_peer.directory - peerid = self.get_peerid_by_nick(nick) - if not peerid: + peer = self.get_peer_by_nick(nick) + if not peer: log.debug("We were asked to send a message from {} to {}, " "but {} is not connected.".format(from_nick, nick, nick)) return # The `message` passed in has format COMMAND_PREFIX||command||" "||msg # we need to parse out cmd, message for sending. - _, cmdmsg = message.split(COMMAND_PREFIX) - cmdmsglist = cmdmsg.split(" ") + # second argument for split means only one split allowed. + cmdsmsgs = message.split(COMMAND_PREFIX, 1)[1] + cmdmsglist = cmdsmsgs.split(" ") cmd = cmdmsglist[0] msg = " ".join(cmdmsglist[1:]) privmsg = self.get_privmsg(nick, cmd, msg, source_nick=from_nick) - #log.debug("Sending out privmsg: {} to peer: {}".format(privmsg, peerid)) encoded_msg = OnionCustomMessage(privmsg, JM_MESSAGE_TYPES["privmsg"]) - self._send(self.get_peer_by_id(peerid), encoded_msg) + self._send(peer, encoded_msg) # If possible, we forward the from-nick's network location # to the to-nick peer, so they can just talk directly next time. - peerid_from = self.get_peerid_by_nick(from_nick) - if not peerid_from: + peer_from = self.get_peer_by_nick(from_nick) + if not peer_from: return - peer_to = self.get_peer_by_id(peerid) - self.send_peers(peer_to, peerid_filter=[peerid_from]) + self.send_peers(peer, peer_filter=[peer_from]) def process_control_message(self, peerid: str, msgtype: int, msgval: str) -> bool: """ Triggered by a directory node feeding us peers, or by a connect/disconnect hook; this is our housekeeping to try to create, and keep track of, useful connections. + The returned boolean indicates whether we succeeded in processing + the message or whether it must be analyzed again (note e.g. that + we return True for a rejected message!) """ all_ctrl = list(LOCAL_CONTROL_MESSAGE_TYPES.values( )) + list(CONTROL_MESSAGE_TYPES.values()) @@ -846,9 +923,12 @@ class OnionMessageChannel(MessageChannel): #log.debug("received control message: {},{}".format(msgtype, msgval)) if msgtype == CONTROL_MESSAGE_TYPES["peerlist"]: # This is the base method of seeding connections; - # a directory node can send this any time. We may well - # need to control this; for now it just gets processed, - # whereever it came from: + # a directory node can send this any time. + # These messages can only be accepted from directory peers + # (which we have configured ourselves): + peer = self.get_peer_by_id(peerid) + if not peer or not peer.directory: + return True try: peerlist = msgval.split(",") for peer in peerlist: @@ -858,25 +938,14 @@ class OnionMessageChannel(MessageChannel): except Exception as e: log.debug("Incorrectly formatted peer list: {}, " "ignoring, {}".format(msgval, e)) - # returning True either way, because although it was an - # invalid message, it *was* a control message, and should - # not be processed as something else. + # returning True whether raised or not - see docstring return True elif msgtype == CONTROL_MESSAGE_TYPES["getpeerlist"]: - # getpeerlist must be accompanied by a full node - # locator, and nick; - # add that peer before returning our peer list. - p = self.add_peer(msgval, connection=True, - overwrite_connection=True, with_nick=True) - try: - self.send_peers(p) - except OnionPeerConnectionError: - pass - # comment much as above; if we can't connect, it's none - # of our business. + log.warn("getpeerlist request received, currently not supported.") return True elif msgtype == CONTROL_MESSAGE_TYPES["handshake"]: - # sent by non-directory peers on startup + # sent by non-directory peers on startup, also to + # other non-dn peers during tx flow self.process_handshake(peerid, msgval) return True elif msgtype == CONTROL_MESSAGE_TYPES["dn-handshake"]: @@ -896,6 +965,12 @@ class OnionMessageChannel(MessageChannel): msgval = self.get_peer_by_id(msgval).peer_location() self.add_peer(msgval, connection=False, overwrite_connection=True) + # bubble up the disconnection event to the abstract + # message channel logic: + if self.on_nick_leave: + p = self.get_peer_by_id(msgval) + if p and p.nick: + reactor.callLater(0.0, self.on_nick_leave, p.nick, self) else: assert False # If we got here it is *not* a non-local control message; @@ -919,7 +994,6 @@ class OnionMessageChannel(MessageChannel): peerid, peer.status())) return if dn: - print("We, {}, are processing a handshake with dn {} from peer {}".format(self.self_as_peer.peer_location(), dn, peerid)) # it means, we are a non-dn and we are expecting # a returned `dn-handshake` message: # (currently dns don't talk to other dns): @@ -946,8 +1020,9 @@ class OnionMessageChannel(MessageChannel): assert isinstance(features, dict) assert isinstance(nick, str) except Exception as e: - log.warn("Invalid handshake message from: {}, exception: {}, message: {}," - "ignoring".format(peerid, repr(e), message)) + log.warn("Invalid handshake message from: {}," + " exception: {}, message: {},ignoring".format( + peerid, repr(e), message)) return # currently we are not using any features, but the intention # is forwards compatibility, so we don't check its contents @@ -964,7 +1039,6 @@ class OnionMessageChannel(MessageChannel): peer.update_status(PEER_STATUS_HANDSHAKED) peer.set_nick(nick) else: - print("We, {}, are processing a handshake with dn {} from peer {}".format(self.self_as_peer.peer_location(), dn, peerid)) # it means, we are receiving an initial handshake # message from a 'client' (non-dn) peer. # dns don't talk to each other: @@ -982,9 +1056,11 @@ class OnionMessageChannel(MessageChannel): assert isinstance(features, dict) assert isinstance(nick, str) except Exception as e: - log.warn("(not dn) Invalid handshake message from: {}, exception: {}, message: {}," - "ignoring".format(peerid, repr(e), message)) - accepted = False + log.warn("(not dn) Invalid handshake message from: {}, " + "exception: {}, message: {}, ignoring".format( + peerid, repr(e), message)) + # just ignore, since a syntax failure could lead to a crash + return if not (app_name == JM_APP_NAME and proto_ver == JM_VERSION \ and not is_directory): log.warn("Invalid handshake name/version data: {}, from peer: " @@ -992,13 +1068,12 @@ class OnionMessageChannel(MessageChannel): accepted = False # If accepted, we should update the peer to have the full # location which in general will not yet be present, so as to - # allow publishing their location via `getpeerlist`: + # allow publishing their location via `getpeerlist`. Note + # that if the peer declares itself as not serving, we do + # nothing here: if not peer.set_location(full_location_string): accepted = False - if not peerid == full_location_string: - print("we are reading a handshake from location {} but they sent" - "us full location string {}, setting an alternate".format( - peerid, full_location_string)) + if peerid != full_location_string: peer.set_alternate_location(peerid) peer.set_nick(nick) # client peer's handshake message was valid; send ours, and @@ -1018,8 +1093,10 @@ class OnionMessageChannel(MessageChannel): if p == "00": return self.self_as_peer for x in self.peers: - if x.peer_location() == p: + if x.peer_location() == p and p != NOT_SERVING_ONION_HOSTNAME: return x + # non-reachable peers can only match on their inbound + # connection port if x.alternate_location == p: return x return False @@ -1046,7 +1123,7 @@ class OnionMessageChannel(MessageChannel): self.receive_msg(msg, "00") def add_peer(self, peerdata: str, connection: bool=False, - overwrite_connection: bool=False, with_nick=False) -> None: + overwrite_connection: bool=False, with_nick=False) -> Union[OnionPeer, None]: """ add non-directory peer from (nick, peer) serialization `peerdata`, where "peer" is host:port; return the created OnionPeer object. Or, with_nick=False means @@ -1084,14 +1161,15 @@ class OnionMessageChannel(MessageChannel): log.warn("Failed to add peer: {}, exception: {}".format(peer, repr(e))) return if not self.get_peer_by_id(temp_p.peer_location()): + self.peers.add(temp_p) if connection: log.info("Updating status of peer: {} to connected.".format(temp_p.peer_location())) temp_p.update_status(PEER_STATUS_CONNECTED) else: - temp_p.update_status(PEER_STATUS_DISCONNECTED) + if overwrite_connection: + temp_p.update_status(PEER_STATUS_DISCONNECTED) if with_nick: temp_p.set_nick(nick) - self.peers.add(temp_p) if not connection: # Here, we are not currently connected. We # try to connect asynchronously. We don't pay attention @@ -1130,7 +1208,6 @@ class OnionMessageChannel(MessageChannel): # Notice this is checking for *handshaked* dps; # the handshake will have been initiated once a # connection was seen: - log.warn("in the wait for directories loop, this is the connected dps: {}".format(self.get_connected_directory_peers())) if len(self.get_connected_directory_peers()) == 0: return # This is what triggers the start of taker/maker workflows. @@ -1142,38 +1219,46 @@ class OnionMessageChannel(MessageChannel): """ CONTROL MESSAGES SENT BY US """ def send_peers(self, requesting_peer: OnionPeer, - peerid_filter: list=[]) -> None: - """ This message is sent by directory peers on request - by non-directory peers. - If peerid_filter is specified, only peers whose peerid is in - this list will be sent. (TODO this is inefficient). + peer_filter: List[OnionPeer]) -> None: + """ This message is sent by directory peers, currently + only when a privmsg has to be forwarded to them. It + could also be sent by directories to non-directory peers + according to some other algorithm. + If peer_filter is specified, only those peers will be sent. The peerlist message should have this format: (1) entries comma separated (2) each entry is serialized nick then the NICK_PEERLOCATOR_SEPARATOR - then *either* 66 char hex peerid, *or* peerid@host:port - (3) However this message might be long enough to exceed a 1300 byte limit, - if we don't use a filter, so we may need to split it into multiple - messages (TODO). + then host:port + (3) Peers that do not have a reachable location are not sent. """ if not requesting_peer.status() == PEER_STATUS_HANDSHAKED: raise OnionPeerConnectionError( "Cannot send peer list to unhandshaked peer") peerlist = set() + peer_filter_exists = len(peer_filter) > 0 for p in self.get_connected_nondirectory_peers(): # don't send a peer to itself - if p.peer_location() == requesting_peer.peer_location(): + if p == requesting_peer: continue - if len(peerid_filter) > 0 and p.peer_location() not in peerid_filter: + if peer_filter_exists and p not in peer_filter: continue - if not p.status() == PEER_STATUS_HANDSHAKED: + if p.status() != PEER_STATUS_HANDSHAKED: # don't advertise what is not online. continue # peers that haven't sent their nick yet are not # privmsg-reachable; don't send them if p.nick == "": continue + if p.peer_location() == NOT_SERVING_ONION_HOSTNAME: + # if a connection has no reachable destination, + # don't forward it + continue peerlist.add(p.get_nick_peerlocation_ser()) # For testing: dns won't usually participate: peerlist.add(self.self_as_peer.get_nick_peerlocation_ser()) + # don't send an empty set (will not be possible unless + # above dn add is removed). + if len(peerlist) == 0: + return self._send(requesting_peer, OnionCustomMessage(",".join( peerlist), CONTROL_MESSAGE_TYPES["peerlist"])) diff --git a/jmdaemon/test/test_daemon_protocol.py b/jmdaemon/test/test_daemon_protocol.py index f9dbf39..f8e9a6d 100644 --- a/jmdaemon/test/test_daemon_protocol.py +++ b/jmdaemon/test/test_daemon_protocol.py @@ -59,11 +59,11 @@ class JMTestClientProtocol(JMBaseProtocol): def clientStart(self): self.sigs_received = 0 - irc = [get_mchannels()[0]] + chan_configs = [get_mchannels()[0]] d = self.callRemote(JMInit, bcsource="dummyblockchain", network="dummynetwork", - irc_configs=irc, + chan_configs=chan_configs, minmakers=2, maker_timeout_sec=3, dust_threshold=27300, @@ -212,7 +212,7 @@ class JMDaemonTestServerProtocol(JMDaemonServerProtocol): return super().on_JM_REQUEST_OFFERS() @JMInit.responder - def on_JM_INIT(self, bcsource, network, irc_configs, minmakers, + def on_JM_INIT(self, bcsource, network, chan_configs, minmakers, maker_timeout_sec, dust_threshold, blacklist_location): self.maker_timeout_sec = maker_timeout_sec self.dust_threshold = int(dust_threshold) diff --git a/scripts/obwatch/ob-watcher.py b/scripts/obwatch/ob-watcher.py index b6a2950..e559814 100755 --- a/scripts/obwatch/ob-watcher.py +++ b/scripts/obwatch/ob-watcher.py @@ -45,7 +45,8 @@ if 'matplotlib' in sys.modules: from jmclient import jm_single, load_program_config, calc_cj_fee, \ get_mchannels, add_base_options -from jmdaemon import OrderbookWatch, MessageChannelCollection, IRCMessageChannel +from jmdaemon import (OrderbookWatch, MessageChannelCollection, + OnionMessageChannel, IRCMessageChannel) #TODO this is only for base58, find a solution for a client without jmbitcoin import jmbitcoin as btc from jmdaemon.protocol import * @@ -737,32 +738,32 @@ class ObBasic(OrderbookWatch): def request_orderbook(self): self.msgchan.request_orderbook() -class ObIRCMessageChannel(IRCMessageChannel): - """A customisation of the message channel - to allow receipt of privmsgs without the - verification hooks in client-daemon communication.""" - def on_privmsg(self, nick, message): - if len(message) < 2: - return - - if message[0] != COMMAND_PREFIX: - log.debug('message not a cmd') - return - cmd_string = message[1:].split(' ')[0] - if cmd_string not in offername_list: - log.debug('non-offer ignored') - return - #Ignore sigs (TODO better to include check) - sig = message[1:].split(' ')[-2:] - #reconstruct original message without cmd pref - rawmessage = ' '.join(message[1:].split(' ')[:-2]) - for command in rawmessage.split(COMMAND_PREFIX): - _chunks = command.split(" ") - try: - self.check_for_orders(nick, _chunks) - self.check_for_fidelity_bond(nick, _chunks) - except: - pass + +"""An override for MessageChannel classes, +to allow receipt of privmsgs without the +verification hooks in client-daemon communication.""" +def on_privmsg(inst, nick, message): + if len(message) < 2: + return + + if message[0] != COMMAND_PREFIX: + log.debug('message not a cmd') + return + cmd_string = message[1:].split(' ')[0] + if cmd_string not in offername_list: + log.debug('non-offer ignored') + return + #Ignore sigs (TODO better to include check) + sig = message[1:].split(' ')[-2:] + #reconstruct original message without cmd pref + rawmessage = ' '.join(message[1:].split(' ')[:-2]) + for command in rawmessage.split(COMMAND_PREFIX): + _chunks = command.split(" ") + try: + inst.check_for_orders(nick, _chunks) + inst.check_for_fidelity_bond(nick, _chunks) + except: + pass def get_dummy_nick(): @@ -804,7 +805,16 @@ def main(): (options, args) = parser.parse_args() load_program_config(config_path=options.datadir) hostport = (options.host, options.port) - mcs = [ObIRCMessageChannel(c) for c in get_mchannels()] + mcs = [] + chan_configs = get_mchannels() + for c in chan_configs: + if "type" in c and c["type"] == "onion": + mcs.append(OnionMessageChannel(c)) + else: + # default is IRC; TODO allow others + mcs.append(IRCMessageChannel(c)) + IRCMessageChannel.on_privmsg = on_privmsg + OnionMessageChannel.on_privmsg = on_privmsg mcc = MessageChannelCollection(mcs) mcc.set_nick(get_dummy_nick()) taker = ObBasic(mcc, hostport) diff --git a/test/e2e-coinjoin-test.py b/test/e2e-coinjoin-test.py index 600d6ec..81296af 100644 --- a/test/e2e-coinjoin-test.py +++ b/test/e2e-coinjoin-test.py @@ -11,7 +11,7 @@ pytest \ --btcroot=/path/to/bitcoin/bin/ \ --btcpwd=123456abcdef --btcconf=/blah/bitcoin.conf \ - -s test/ln-ygrunner.py + -s test/e2e-coinjoin-test.py ''' from twisted.internet import reactor, defer from twisted.web.client import readBody, Headers @@ -21,7 +21,7 @@ import random import json from datetime import datetime from jmbase import (get_nontor_agent, BytesProducer, jmprint, - get_log, stop_reactor, hextobin, bintohex) + get_log, stop_reactor) from jmclient import (YieldGeneratorBasic, load_test_config, jm_single, JMClientProtocolFactory, start_reactor, SegwitWallet, get_mchannels, SegwitLegacyWallet, JMWalletDaemon) @@ -45,8 +45,7 @@ mean_amt = 2.0 directory_node_indices = [1] -# -def get_onion_messaging_config_regtest(run_num: int, dns=[1], hsd=""): +def get_onion_messaging_config_regtest(run_num: int, dns=[1], hsd="", mode="TAKER"): """ Sets a onion messaging channel section for a regtest instance indexed by `run_num`. The indices to be used as directory nodes should be passed as `dns`, as a list of ints. @@ -72,6 +71,10 @@ def get_onion_messaging_config_regtest(run_num: int, dns=[1], hsd=""): "hidden_service_dir": "", "directory_nodes": dn_nodes_list, "regtest_count": "1, 1"} + if mode == "MAKER": + cf["serving"] = True + else: + cf["serving"] = False if run_num in dns: # only directories need to use fixed hidden service directories: cf["hidden_service_dir"] = hsd @@ -85,11 +88,11 @@ class RegtestJMClientProtocolFactory(JMClientProtocolFactory): # for this test: self.dns = dns - def get_mchannels(self): - # swaps out any existing lightning configs + def get_mchannels(self, mode="TAKER"): + # swaps out any existing onionmc configs # in the config settings on startup, for one # that's indexed to the regtest counter var: - default_chans = get_mchannels() + default_chans = get_mchannels(mode=mode) new_chans = [] onion_found = False hsd = "" @@ -103,7 +106,7 @@ class RegtestJMClientProtocolFactory(JMClientProtocolFactory): new_chans.append(c) if onion_found: new_chans.append(get_onion_messaging_config_regtest( - self.i, self.dns, hsd)) + self.i, self.dns, hsd, mode=mode)) return new_chans class JMWalletDaemonT(JMWalletDaemon): @@ -183,7 +186,7 @@ def test_start_yg_and_taker_setup(setup_onion_ygrunner): walletclass = SegwitLegacyWallet start_bot_num, end_bot_num = [int(x) for x in jm_single().config.get( - "MESSAGING:onion1", "regtest_count").split(",")] + "MESSAGING:onion", "regtest_count").split(",")] num_ygs = end_bot_num - start_bot_num # specify the number of wallets and bots of each type: wallet_services = make_wallets(num_ygs + 1, @@ -254,21 +257,21 @@ def test_start_yg_and_taker_setup(setup_onion_ygrunner): # This ensures that this bot knows which other bots are directory nodes: clientfactory.set_directory_nodes(directory_node_indices) nodaemon = jm_single().config.getint("DAEMON", "no_daemon") - daemon = True if nodaemon == 1 else False + daemon = bool(nodaemon) #rs = True if i == num_ygs - 1 else False start_reactor(jm_single().config.get("DAEMON", "daemon_host"), jm_single().config.getint("DAEMON", "daemon_port"), clientfactory, daemon=daemon, rs=False) - reactor.callLater(1.0, start_test_taker, wallet_services[end_bot_num - 1]['wallet'], end_bot_num) + reactor.callLater(1.0, start_test_taker, wallet_services[end_bot_num - 1]['wallet'], end_bot_num, num_ygs) reactor.run() @defer.inlineCallbacks -def start_test_taker(wallet_service, i): +def start_test_taker(wallet_service, i, num_ygs): # this rpc manager has auth disabled, # and the wallet_service is set manually, # so no unlock etc. mgr = TWalletRPCManager() - mgr.daemon.wallet_service = wallet_service + mgr.daemon.services["wallet"] = wallet_service # because we are manually setting the wallet_service # of the JMWalletDaemon instance, we do not follow the # usual flow of `initialize_wallet_service`, we do not set @@ -276,11 +279,9 @@ def start_test_taker(wallet_service, i): # sync the wallet, including bypassing any restart callback: def dummy_restart_callback(msg): log.warn("Ignoring rescan request from backend wallet service: " + msg) - mgr.daemon.wallet_service.add_restart_callback(dummy_restart_callback) + mgr.daemon.services["wallet"].add_restart_callback(dummy_restart_callback) mgr.daemon.wallet_name = wallet_name - while not mgr.daemon.wallet_service.synced: - mgr.daemon.wallet_service.sync_wallet(fast=True) - mgr.daemon.wallet_service.startService() + mgr.daemon.services["wallet"].startService() def get_client_factory(): clientfactory = RegtestJMClientProtocolFactory(mgr.daemon.taker, proto_type="TAKER") @@ -290,18 +291,25 @@ def start_test_taker(wallet_service, i): mgr.daemon.get_client_factory = get_client_factory # before preparing the RPC call to the wallet daemon, - # we decide a coinjoin destination and amount. Choosing - # a destination in the wallet is a bit easier because + # we decide a coinjoin destination, counterparty count and amount. + # Choosing a destination in the wallet is a bit easier because # we can query the mixdepth balance at the end. - coinjoin_destination = mgr.daemon.wallet_service.get_internal_addr(4) + coinjoin_destination = mgr.daemon.services["wallet"].get_internal_addr(4) cj_amount = 22000000 + def n_cps_from_n_ygs(n): + if n > 4: + return n - 2 + if n > 2: + return 2 + assert False, "Need at least 3 yield generators to test" + n_cps = n_cps_from_n_ygs(num_ygs) # once the taker is finished we sanity check before # shutting down: def dummy_taker_finished(res, fromtx=False, waittime=0.0, txdetails=None): jmprint("Taker is finished") # check that the funds have arrived. - mbal = mgr.daemon.wallet_service.get_balance_by_mixdepth()[4] + mbal = mgr.daemon.services["wallet"].get_balance_by_mixdepth()[4] assert mbal == cj_amount jmprint("Funds: {} sats successfully arrived into mixdepth 4.".format(cj_amount)) stop_reactor() @@ -315,7 +323,7 @@ def start_test_taker(wallet_service, i): addr = addr.encode() body = BytesProducer(json.dumps({"mixdepth": "1", "amount_sats": cj_amount, - "counterparties": "2", + "counterparties": str(n_cps), "destination": coinjoin_destination}).encode()) yield mgr.do_request(agent, b"POST", addr, body, process_coinjoin_response) @@ -324,39 +332,6 @@ def process_coinjoin_response(response): json_body = json.loads(response.decode("utf-8")) print("coinjoin response: {}".format(json_body)) -def get_addr_and_fund(yg): - """ This function allows us to create - and publish a fidelity bond for a particular - yield generator object after the wallet has reached - a synced state and is therefore ready to serve up - timelock addresses. We create the TL address, fund it, - refresh the wallet and then republish our offers, which - will also publish the new FB. - """ - if not yg.wallet_service.synced: - return - if yg.wallet_service.timelock_funded: - return - addr = wallet_gettimelockaddress(yg.wallet_service.wallet, "2021-11") - print("Got timelockaddress: {}".format(addr)) - - # pay into it; amount is randomized for now. - # Note that grab_coins already mines 1 block. - fb_amt = random.randint(1, 5) - jm_single().bc_interface.grab_coins(addr, fb_amt) - - # we no longer have to run this loop (TODO kill with nonlocal) - yg.wallet_service.timelock_funded = True - - # force wallet to check for the new coins so the new - # yg offers will include them: - yg.wallet_service.transaction_monitor() - - # publish a new offer: - yg.offerlist = yg.create_my_orders() - yg.fidelity_bond = yg.get_fidelity_bond_template() - jmprint('updated offerlist={}'.format(yg.offerlist)) - @pytest.fixture(scope="module") def setup_onion_ygrunner(): load_test_config() diff --git a/test/regtest_joinmarket.cfg b/test/regtest_joinmarket.cfg index 3345e29..ab0742a 100644 --- a/test/regtest_joinmarket.cfg +++ b/test/regtest_joinmarket.cfg @@ -37,7 +37,7 @@ socks5 = false socks5_host = localhost socks5_port = 9150 -[MESSAGING:onion1] +[MESSAGING:onion] # onion based message channels must have the exact type 'onion' # (while the section name above can be MESSAGING:whatever), and there must # be only ONE such message channel configured (note the directory servers