November 2013 - tor-commits - lists.torproject.org

[flashproxy/master] fix errors in apache example config and add instructions on enabling SSL and HSTS
by infinity0＠torproject.org 21 Nov '13

21 Nov '13

commit 82e6dc766a2625f14599968e82fe3c6e5fbc704c Author: Ximin Luo <infinity0(a)gmx.com> Date: Thu Oct 10 11:31:03 2013 +0100 fix errors in apache example config and add instructions on enabling SSL and HSTS --- facilitator/examples/fp-facilitator | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/facilitator/examples/fp-facilitator b/facilitator/examples/fp-facilitator index 125d0cc..500521d 100644 --- a/facilitator/examples/fp-facilitator +++ b/facilitator/examples/fp-facilitator @@ -4,24 +4,28 @@ # /etc/apache2/sites-available/fp-facilitator, or wherever is appropriate. Then # you can run `a2ensite fp-facilitator` to enable it. # +# You should also run `a2enmod ssl headers` to enable SSL and HSTS. +# +MaxClients 256 <VirtualHost *:443> # Update this with your hostname! ServerName fp-facilitator.example.com DocumentRoot /dev/null # Make sure the path below matchs where you installed the facilitator. ScriptAliasMatch ^(.*) /usr/bin/facilitator.cgi$1 - MaxClients 256 CustomLog ${APACHE_LOG_DIR}/fp-access.log common ErrorLog ${APACHE_LOG_DIR}/fp-error.log LogLevel warn - SSLEngine on + # requires mod_ssl + SSLEngine on # Manually install your certificate to the following location. SSLCertificateFile /etc/apache2/fp-facilitator.pem # If you got an intermediate certificate, uncomment the following line # and install the certificate to that location too. #SSLCertificateChainFile /etc/apache2/fp-intermediate.pem + # requires mod_headers Header add Strict-Transport-Security "max-age=15768000" </VirtualHost>

1 0

[flashproxy/master] - drop autoconf min version to 2.68, version in Ubuntu precise
by infinity0＠torproject.org 21 Nov '13

21 Nov '13

commit cfbcbaea65acc1f6b2999785211672cf931135d0 Author: Ximin Luo <infinity0(a)gmx.com> Date: Tue Oct 15 23:18:28 2013 +0100 - drop autoconf min version to 2.68, version in Ubuntu precise --- facilitator/configure.ac | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/facilitator/configure.ac b/facilitator/configure.ac index 4bab528..397894f 100644 --- a/facilitator/configure.ac +++ b/facilitator/configure.ac @@ -1,4 +1,4 @@ -AC_PREREQ([2.69]) +AC_PREREQ([2.68]) AC_INIT([flashproxy-facilitator], [1.3]) AM_INIT_AUTOMAKE([-Wall -Werror foreign])

1 0

[flashproxy/master] don't clobber secret files during post-install, and don't remove them during pre-remove
by infinity0＠torproject.org 21 Nov '13

21 Nov '13

commit 720861831e03e5a7f9cd726dd3ea73c3e7f3f376 Author: Ximin Luo <infinity0(a)gmx.com> Date: Wed Oct 9 23:36:10 2013 +0100 don't clobber secret files during post-install, and don't remove them during pre-remove --- facilitator/INSTALL | 5 +++++ facilitator/Makefile.am | 26 +++++++++++++++----------- 2 files changed, 20 insertions(+), 11 deletions(-) diff --git a/facilitator/INSTALL b/facilitator/INSTALL index bd47adf..345d74a 100644 --- a/facilitator/INSTALL +++ b/facilitator/INSTALL @@ -29,3 +29,8 @@ instructions. Uninstall. # make pre-remove uninstall post-remove + +This will leave behind some config files (e.g. secret keys and passwords). To +get rid of those too, run this instead: + + # make pre-purge uninstall post-purge diff --git a/facilitator/Makefile.am b/facilitator/Makefile.am index 348bfb0..0164d76 100644 --- a/facilitator/Makefile.am +++ b/facilitator/Makefile.am @@ -44,8 +44,10 @@ CLEANFILES = $(initscript_SCRIPTS) pre-install: meta-install-sanity install-user post-install: meta-install-sanity install-secrets install-symlinks install-daemon -pre-remove: meta-install-sanity remove-daemon remove-symlinks remove-secrets -post-remove: meta-install-sanity remove-user +pre-remove: meta-install-sanity remove-daemon remove-symlinks +post-remove: meta-install-sanity +pre-purge: pre-remove remove-secrets +post-purge: post-remove remove-user meta-install-sanity: test "x$(DESTDIR)" = "x" || { echo >&2 \ @@ -80,14 +82,16 @@ remove-user: $(fpfacilitatoruser) ; } || true install-secrets: - install -m 600 /dev/null $(pkgconfdir)/reg-daemon.key - openssl genrsa 2048 | tee $(pkgconfdir)/reg-daemon.key | \ - openssl rsa -pubout > $(pkgconfdir)/reg-daemon.pub - install -m 600 /dev/null $(pkgconfdir)/reg-email.pass - @echo >> $(pkgconfdir)/reg-email.pass \ - "Replace this file's contents with your Gmail app-specific password;" - @echo >> $(pkgconfdir)/reg-email.pass \ - "see gmail-howto.txt in this package's documentation for details." + test -f $(pkgconfdir)/reg-daemon.key || { \ + install -m 600 /dev/null $(pkgconfdir)/reg-daemon.key && \ + openssl genrsa 2048 | tee $(pkgconfdir)/reg-daemon.key | \ + openssl rsa -pubout > $(pkgconfdir)/reg-daemon.pub; } + test -f $(pkgconfdir)/reg-email.pass || { \ + install -m 600 /dev/null $(pkgconfdir)/reg-email.pass && \ + echo >> $(pkgconfdir)/reg-email.pass \ + "Replace this file's contents with your Gmail app-specific password;" && \ + echo >> $(pkgconfdir)/reg-email.pass \ + "see gmail-howto.txt in this package's documentation for details."; } remove-secrets: rm -f $(pkgconfdir)/reg-* @@ -122,6 +126,6 @@ if DO_INITSCRIPTS done endif -.PHONY: pre-install post-install pre-remove post-remove +.PHONY: pre-install post-install pre-remove post-remove pre-purge post-purge .PHONY: install-user install-secrets install-symlinks install-daemon .PHONY: remove-user remove-secrets remove-symlinks remove-daemon

1 0

[flashproxy/master] use automake's python test runner
by infinity0＠torproject.org 21 Nov '13

21 Nov '13

commit 04afd3a2954946d54e12f1da090f368c09a2689f Author: Ximin Luo <infinity0(a)gmx.com> Date: Wed Oct 9 14:44:01 2013 +0100 use automake's python test runner --- facilitator/.gitignore | 6 +- facilitator/Makefile.am | 10 +- facilitator/configure.ac | 2 + facilitator/facilitator-test | 192 --------------------------------------- facilitator/facilitator-test.py | 192 +++++++++++++++++++++++++++++++++++++++ 5 files changed, 203 insertions(+), 199 deletions(-) diff --git a/facilitator/.gitignore b/facilitator/.gitignore index 7574515..9c6d1c7 100644 --- a/facilitator/.gitignore +++ b/facilitator/.gitignore @@ -22,6 +22,6 @@ /flashproxy-facilitator-*.tar.* # files output by test-driver -/test-*.log -/*-test.log -/*-test.trs +test*.log +*test.log +*test.trs diff --git a/facilitator/Makefile.am b/facilitator/Makefile.am index 559f12c..348bfb0 100644 --- a/facilitator/Makefile.am +++ b/facilitator/Makefile.am @@ -23,7 +23,12 @@ dist_example_DATA = examples/fp-facilitator dist_appengine_DATA = appengine/app.yaml appengine/config.go appengine/fp-reg.go appengine/README appengineconf_DATA = appengine/config.go -dist_TESTS = facilitator-test +TESTS = facilitator-test.py +# see http://www.gnu.org/software/automake/manual/html_node/Parallel-Test-Harness… +TEST_EXTENSIONS = .py +PY_LOG_COMPILER = $(PYTHON) +AM_TESTS_ENVIRONMENT = PYTHONPATH='$(srcdir)'; export PYTHONPATH; +AM_PY_LOG_FLAGS = # stuff built from AC_CONFIG_FILES # see http://www.gnu.org/software/automake/manual/html_node/Scripts.html @@ -31,9 +36,6 @@ CLEANFILES = $(initscript_SCRIPTS) # our own targets -check: - ./facilitator-test - # The {pre,post}-{install,remove} targets are just given as reference, and # ought to be separate scripts as part of your distro's installation process. # They are intentionally not linked to the install target since they require diff --git a/facilitator/configure.ac b/facilitator/configure.ac index a212332..3542238 100644 --- a/facilitator/configure.ac +++ b/facilitator/configure.ac @@ -11,6 +11,8 @@ AC_CONFIG_FILES([Makefile init.d/facilitator-reg-daemon]) AC_PROG_LN_S +AM_PATH_PYTHON + # check that we want to install initscripts. don't bother checking that they # are supported, since we might be doing a staged install on a different system. # disabled by default since it ignores ${prefix} so `make distcheck` would fail diff --git a/facilitator/facilitator-test b/facilitator/facilitator-test deleted file mode 100755 index 6dec76d..0000000 --- a/facilitator/facilitator-test +++ /dev/null @@ -1,192 +0,0 @@ -#!/usr/bin/env python - -import socket -import subprocess -import time -import unittest - -import fac - -FACILITATOR_HOST = "127.0.0.1" -FACILITATOR_PORT = 39002 -FACILITATOR_ADDR = (FACILITATOR_HOST, FACILITATOR_PORT) - -def gimme_socket(host, port): - addrinfo = socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM, socket.IPPROTO_TCP)[0] - s = socket.socket(addrinfo[0], addrinfo[1], addrinfo[2]) - s.settimeout(10.0) - s.connect(addrinfo[4]) - return s - -class FacilitatorTest(unittest.TestCase): - IPV4_CLIENT_ADDR = ("1.1.1.1", 9000) - IPV6_CLIENT_ADDR = ("[11::11]", 9000) - IPV4_PROXY_ADDR = ("2.2.2.2", 13000) - IPV6_PROXY_ADDR = ("[22::22]", 13000) - - def gimme_socket(self): - return gimme_socket(FACILITATOR_HOST, FACILITATOR_PORT) - - def setUp(self): - self.process = subprocess.Popen(["./facilitator", "-d", "-p", str(FACILITATOR_PORT), "-r", "0.0.1.0:1", "-l", "/dev/null"]) - time.sleep(0.1) - - def tearDown(self): - ret = self.process.poll() - if ret is not None: - raise Exception("facilitator subprocess exited unexpectedly with status %d" % ret) - self.process.terminate() - - def test_timeout(self): - """Test that the socket will not accept slow writes indefinitely. - Successive sends should not reset the timeout counter.""" - s = self.gimme_socket() - time.sleep(0.3) - s.send("w") - time.sleep(0.3) - s.send("w") - time.sleep(0.3) - s.send("w") - time.sleep(0.3) - s.send("w") - time.sleep(0.3) - self.assertRaises(socket.error, s.send, "w") - - def test_readline_limit(self): - """Test that reads won't buffer indefinitely.""" - s = self.gimme_socket() - buflen = 0 - try: - while buflen + 1024 < 200000: - s.send("X" * 1024) - buflen += 1024 - self.fail("should have raised a socket error") - except socket.error: - pass - - def test_af_v4_v4(self): - """Test that IPv4 proxies can get IPv4 clients.""" - fac.put_reg(FACILITATOR_ADDR, self.IPV4_CLIENT_ADDR) - fac.put_reg(FACILITATOR_ADDR, self.IPV6_CLIENT_ADDR) - reg = fac.get_reg(FACILITATOR_ADDR, self.IPV4_PROXY_ADDR) - self.assertEqual(reg["client"], fac.format_addr(self.IPV4_CLIENT_ADDR)) - - def test_af_v4_v6(self): - """Test that IPv4 proxies do not get IPv6 clients.""" - fac.put_reg(FACILITATOR_ADDR, self.IPV6_CLIENT_ADDR) - reg = fac.get_reg(FACILITATOR_ADDR, self.IPV4_PROXY_ADDR) - self.assertEqual(reg["client"], "") - - def test_af_v6_v4(self): - """Test that IPv6 proxies do not get IPv4 clients.""" - fac.put_reg(FACILITATOR_ADDR, self.IPV4_CLIENT_ADDR) - reg = fac.get_reg(FACILITATOR_ADDR, self.IPV6_PROXY_ADDR) - self.assertEqual(reg["client"], "") - - def test_af_v6_v6(self): - """Test that IPv6 proxies can get IPv6 clients.""" - fac.put_reg(FACILITATOR_ADDR, self.IPV4_CLIENT_ADDR) - fac.put_reg(FACILITATOR_ADDR, self.IPV6_CLIENT_ADDR) - reg = fac.get_reg(FACILITATOR_ADDR, self.IPV6_PROXY_ADDR) - self.assertEqual(reg["client"], fac.format_addr(self.IPV6_CLIENT_ADDR)) - - def test_check_back_in(self): - """Test that facilitator responses contain a CHECK-BACK-IN key with a - numeric value.""" - reg = fac.get_reg(FACILITATOR_ADDR, self.IPV6_PROXY_ADDR) - self.assertGreater(int(reg["check-back-in"]), 0) - -# def test_same_proxy(self): -# """Test that the same proxy doesn't get the same client when asking -# twice.""" -# self.fail() -# -# def test_num_clients(self): -# """Test that the same proxy can pick up up to five different clients but -# no more. Test that a proxy ceasing to handle a client allows the proxy -# to handle another, different client.""" -# self.fail() -# -# def test_num_proxies(self): -# """Test that a single client is handed out to five different proxies but -# no more. Test that a proxy ceasing to handle a client reduces its count -# so another proxy can handle it.""" -# self.fail() -# -# def test_proxy_timeout(self): -# """Test that a proxy ceasing to connect for some time period causes that -# proxy's clients to be unhandled by that proxy.""" -# self.fail() -# -# def test_localhost_only(self): -# """Test that the facilitator doesn't listen on any external -# addresses.""" -# self.fail() -# -# def test_hostname(self): -# """Test that the facilitator rejects hostnames.""" -# self.fail() - -class ParseAddrSpecTest(unittest.TestCase): - def test_ipv4(self): - self.assertEqual(fac.parse_addr_spec("192.168.0.1:9999"), ("192.168.0.1", 9999)) - - def test_ipv6(self): - self.assertEqual(fac.parse_addr_spec("[12::34]:9999"), ("12::34", 9999)) - - def test_defhost_defport_ipv4(self): - self.assertEqual(fac.parse_addr_spec("192.168.0.2:8888", defhost="192.168.0.1", defport=9999), ("192.168.0.2", 8888)) - self.assertEqual(fac.parse_addr_spec("192.168.0.2:", defhost="192.168.0.1", defport=9999), ("192.168.0.2", 9999)) - self.assertEqual(fac.parse_addr_spec("192.168.0.2", defhost="192.168.0.1", defport=9999), ("192.168.0.2", 9999)) - self.assertEqual(fac.parse_addr_spec(":8888", defhost="192.168.0.1", defport=9999), ("192.168.0.1", 8888)) - self.assertEqual(fac.parse_addr_spec(":", defhost="192.168.0.1", defport=9999), ("192.168.0.1", 9999)) - self.assertEqual(fac.parse_addr_spec("", defhost="192.168.0.1", defport=9999), ("192.168.0.1", 9999)) - - def test_defhost_defport_ipv6(self): - self.assertEqual(fac.parse_addr_spec("[1234::2]:8888", defhost="1234::1", defport=9999), ("1234::2", 8888)) - self.assertEqual(fac.parse_addr_spec("[1234::2]:", defhost="1234::1", defport=9999), ("1234::2", 9999)) - self.assertEqual(fac.parse_addr_spec("[1234::2]", defhost="1234::1", defport=9999), ("1234::2", 9999)) - self.assertEqual(fac.parse_addr_spec(":8888", defhost="1234::1", defport=9999), ("1234::1", 8888)) - self.assertEqual(fac.parse_addr_spec(":", defhost="1234::1", defport=9999), ("1234::1", 9999)) - self.assertEqual(fac.parse_addr_spec("", defhost="1234::1", defport=9999), ("1234::1", 9999)) - - def test_noresolve(self): - """Test that parse_addr_spec does not do DNS resolution by default.""" - self.assertRaises(ValueError, fac.parse_addr_spec, "example.com") - -class ParseTransactionTest(unittest.TestCase): - def test_empty_string(self): - self.assertRaises(ValueError, fac.parse_transaction, "") - - def test_correct(self): - self.assertEqual(fac.parse_transaction("COMMAND"), ("COMMAND", ())) - self.assertEqual(fac.parse_transaction("COMMAND X=\"\""), ("COMMAND", (("X", ""),))) - self.assertEqual(fac.parse_transaction("COMMAND X=\"ABC\""), ("COMMAND", (("X", "ABC"),))) - self.assertEqual(fac.parse_transaction("COMMAND X=\"\\A\\B\\C\""), ("COMMAND", (("X", "ABC"),))) - self.assertEqual(fac.parse_transaction("COMMAND X=\"\\\\\\\"\""), ("COMMAND", (("X", "\\\""),))) - self.assertEqual(fac.parse_transaction("COMMAND X=\"ABC\" Y=\"DEF\""), ("COMMAND", (("X", "ABC"), ("Y", "DEF")))) - self.assertEqual(fac.parse_transaction("COMMAND KEY-NAME=\"ABC\""), ("COMMAND", (("KEY-NAME", "ABC"),))) - self.assertEqual(fac.parse_transaction("COMMAND KEY_NAME=\"ABC\""), ("COMMAND", (("KEY_NAME", "ABC"),))) - - def test_missing_command(self): - self.assertRaises(ValueError, fac.parse_transaction, "X=\"ABC\"") - self.assertRaises(ValueError, fac.parse_transaction, " X=\"ABC\"") - - def test_missing_space(self): - self.assertRaises(ValueError, fac.parse_transaction, "COMMAND/X=\"ABC\"") - self.assertRaises(ValueError, fac.parse_transaction, "COMMAND X=\"ABC\"Y=\"DEF\"") - - def test_bad_quotes(self): - self.assertRaises(ValueError, fac.parse_transaction, "COMMAND X=\"") - self.assertRaises(ValueError, fac.parse_transaction, "COMMAND X=\"ABC") - self.assertRaises(ValueError, fac.parse_transaction, "COMMAND X=\"ABC\" Y=\"ABC") - self.assertRaises(ValueError, fac.parse_transaction, "COMMAND X=\"ABC\\") - - def test_truncated(self): - self.assertRaises(ValueError, fac.parse_transaction, "COMMAND X=") - - def test_newline(self): - self.assertRaises(ValueError, fac.parse_transaction, "COMMAND X=\"ABC\" \nY=\"DEF\"") - -if __name__ == "__main__": - unittest.main() diff --git a/facilitator/facilitator-test.py b/facilitator/facilitator-test.py new file mode 100755 index 0000000..6dec76d --- /dev/null +++ b/facilitator/facilitator-test.py @@ -0,0 +1,192 @@ +#!/usr/bin/env python + +import socket +import subprocess +import time +import unittest + +import fac + +FACILITATOR_HOST = "127.0.0.1" +FACILITATOR_PORT = 39002 +FACILITATOR_ADDR = (FACILITATOR_HOST, FACILITATOR_PORT) + +def gimme_socket(host, port): + addrinfo = socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM, socket.IPPROTO_TCP)[0] + s = socket.socket(addrinfo[0], addrinfo[1], addrinfo[2]) + s.settimeout(10.0) + s.connect(addrinfo[4]) + return s + +class FacilitatorTest(unittest.TestCase): + IPV4_CLIENT_ADDR = ("1.1.1.1", 9000) + IPV6_CLIENT_ADDR = ("[11::11]", 9000) + IPV4_PROXY_ADDR = ("2.2.2.2", 13000) + IPV6_PROXY_ADDR = ("[22::22]", 13000) + + def gimme_socket(self): + return gimme_socket(FACILITATOR_HOST, FACILITATOR_PORT) + + def setUp(self): + self.process = subprocess.Popen(["./facilitator", "-d", "-p", str(FACILITATOR_PORT), "-r", "0.0.1.0:1", "-l", "/dev/null"]) + time.sleep(0.1) + + def tearDown(self): + ret = self.process.poll() + if ret is not None: + raise Exception("facilitator subprocess exited unexpectedly with status %d" % ret) + self.process.terminate() + + def test_timeout(self): + """Test that the socket will not accept slow writes indefinitely. + Successive sends should not reset the timeout counter.""" + s = self.gimme_socket() + time.sleep(0.3) + s.send("w") + time.sleep(0.3) + s.send("w") + time.sleep(0.3) + s.send("w") + time.sleep(0.3) + s.send("w") + time.sleep(0.3) + self.assertRaises(socket.error, s.send, "w") + + def test_readline_limit(self): + """Test that reads won't buffer indefinitely.""" + s = self.gimme_socket() + buflen = 0 + try: + while buflen + 1024 < 200000: + s.send("X" * 1024) + buflen += 1024 + self.fail("should have raised a socket error") + except socket.error: + pass + + def test_af_v4_v4(self): + """Test that IPv4 proxies can get IPv4 clients.""" + fac.put_reg(FACILITATOR_ADDR, self.IPV4_CLIENT_ADDR) + fac.put_reg(FACILITATOR_ADDR, self.IPV6_CLIENT_ADDR) + reg = fac.get_reg(FACILITATOR_ADDR, self.IPV4_PROXY_ADDR) + self.assertEqual(reg["client"], fac.format_addr(self.IPV4_CLIENT_ADDR)) + + def test_af_v4_v6(self): + """Test that IPv4 proxies do not get IPv6 clients.""" + fac.put_reg(FACILITATOR_ADDR, self.IPV6_CLIENT_ADDR) + reg = fac.get_reg(FACILITATOR_ADDR, self.IPV4_PROXY_ADDR) + self.assertEqual(reg["client"], "") + + def test_af_v6_v4(self): + """Test that IPv6 proxies do not get IPv4 clients.""" + fac.put_reg(FACILITATOR_ADDR, self.IPV4_CLIENT_ADDR) + reg = fac.get_reg(FACILITATOR_ADDR, self.IPV6_PROXY_ADDR) + self.assertEqual(reg["client"], "") + + def test_af_v6_v6(self): + """Test that IPv6 proxies can get IPv6 clients.""" + fac.put_reg(FACILITATOR_ADDR, self.IPV4_CLIENT_ADDR) + fac.put_reg(FACILITATOR_ADDR, self.IPV6_CLIENT_ADDR) + reg = fac.get_reg(FACILITATOR_ADDR, self.IPV6_PROXY_ADDR) + self.assertEqual(reg["client"], fac.format_addr(self.IPV6_CLIENT_ADDR)) + + def test_check_back_in(self): + """Test that facilitator responses contain a CHECK-BACK-IN key with a + numeric value.""" + reg = fac.get_reg(FACILITATOR_ADDR, self.IPV6_PROXY_ADDR) + self.assertGreater(int(reg["check-back-in"]), 0) + +# def test_same_proxy(self): +# """Test that the same proxy doesn't get the same client when asking +# twice.""" +# self.fail() +# +# def test_num_clients(self): +# """Test that the same proxy can pick up up to five different clients but +# no more. Test that a proxy ceasing to handle a client allows the proxy +# to handle another, different client.""" +# self.fail() +# +# def test_num_proxies(self): +# """Test that a single client is handed out to five different proxies but +# no more. Test that a proxy ceasing to handle a client reduces its count +# so another proxy can handle it.""" +# self.fail() +# +# def test_proxy_timeout(self): +# """Test that a proxy ceasing to connect for some time period causes that +# proxy's clients to be unhandled by that proxy.""" +# self.fail() +# +# def test_localhost_only(self): +# """Test that the facilitator doesn't listen on any external +# addresses.""" +# self.fail() +# +# def test_hostname(self): +# """Test that the facilitator rejects hostnames.""" +# self.fail() + +class ParseAddrSpecTest(unittest.TestCase): + def test_ipv4(self): + self.assertEqual(fac.parse_addr_spec("192.168.0.1:9999"), ("192.168.0.1", 9999)) + + def test_ipv6(self): + self.assertEqual(fac.parse_addr_spec("[12::34]:9999"), ("12::34", 9999)) + + def test_defhost_defport_ipv4(self): + self.assertEqual(fac.parse_addr_spec("192.168.0.2:8888", defhost="192.168.0.1", defport=9999), ("192.168.0.2", 8888)) + self.assertEqual(fac.parse_addr_spec("192.168.0.2:", defhost="192.168.0.1", defport=9999), ("192.168.0.2", 9999)) + self.assertEqual(fac.parse_addr_spec("192.168.0.2", defhost="192.168.0.1", defport=9999), ("192.168.0.2", 9999)) + self.assertEqual(fac.parse_addr_spec(":8888", defhost="192.168.0.1", defport=9999), ("192.168.0.1", 8888)) + self.assertEqual(fac.parse_addr_spec(":", defhost="192.168.0.1", defport=9999), ("192.168.0.1", 9999)) + self.assertEqual(fac.parse_addr_spec("", defhost="192.168.0.1", defport=9999), ("192.168.0.1", 9999)) + + def test_defhost_defport_ipv6(self): + self.assertEqual(fac.parse_addr_spec("[1234::2]:8888", defhost="1234::1", defport=9999), ("1234::2", 8888)) + self.assertEqual(fac.parse_addr_spec("[1234::2]:", defhost="1234::1", defport=9999), ("1234::2", 9999)) + self.assertEqual(fac.parse_addr_spec("[1234::2]", defhost="1234::1", defport=9999), ("1234::2", 9999)) + self.assertEqual(fac.parse_addr_spec(":8888", defhost="1234::1", defport=9999), ("1234::1", 8888)) + self.assertEqual(fac.parse_addr_spec(":", defhost="1234::1", defport=9999), ("1234::1", 9999)) + self.assertEqual(fac.parse_addr_spec("", defhost="1234::1", defport=9999), ("1234::1", 9999)) + + def test_noresolve(self): + """Test that parse_addr_spec does not do DNS resolution by default.""" + self.assertRaises(ValueError, fac.parse_addr_spec, "example.com") + +class ParseTransactionTest(unittest.TestCase): + def test_empty_string(self): + self.assertRaises(ValueError, fac.parse_transaction, "") + + def test_correct(self): + self.assertEqual(fac.parse_transaction("COMMAND"), ("COMMAND", ())) + self.assertEqual(fac.parse_transaction("COMMAND X=\"\""), ("COMMAND", (("X", ""),))) + self.assertEqual(fac.parse_transaction("COMMAND X=\"ABC\""), ("COMMAND", (("X", "ABC"),))) + self.assertEqual(fac.parse_transaction("COMMAND X=\"\\A\\B\\C\""), ("COMMAND", (("X", "ABC"),))) + self.assertEqual(fac.parse_transaction("COMMAND X=\"\\\\\\\"\""), ("COMMAND", (("X", "\\\""),))) + self.assertEqual(fac.parse_transaction("COMMAND X=\"ABC\" Y=\"DEF\""), ("COMMAND", (("X", "ABC"), ("Y", "DEF")))) + self.assertEqual(fac.parse_transaction("COMMAND KEY-NAME=\"ABC\""), ("COMMAND", (("KEY-NAME", "ABC"),))) + self.assertEqual(fac.parse_transaction("COMMAND KEY_NAME=\"ABC\""), ("COMMAND", (("KEY_NAME", "ABC"),))) + + def test_missing_command(self): + self.assertRaises(ValueError, fac.parse_transaction, "X=\"ABC\"") + self.assertRaises(ValueError, fac.parse_transaction, " X=\"ABC\"") + + def test_missing_space(self): + self.assertRaises(ValueError, fac.parse_transaction, "COMMAND/X=\"ABC\"") + self.assertRaises(ValueError, fac.parse_transaction, "COMMAND X=\"ABC\"Y=\"DEF\"") + + def test_bad_quotes(self): + self.assertRaises(ValueError, fac.parse_transaction, "COMMAND X=\"") + self.assertRaises(ValueError, fac.parse_transaction, "COMMAND X=\"ABC") + self.assertRaises(ValueError, fac.parse_transaction, "COMMAND X=\"ABC\" Y=\"ABC") + self.assertRaises(ValueError, fac.parse_transaction, "COMMAND X=\"ABC\\") + + def test_truncated(self): + self.assertRaises(ValueError, fac.parse_transaction, "COMMAND X=") + + def test_newline(self): + self.assertRaises(ValueError, fac.parse_transaction, "COMMAND X=\"ABC\" \nY=\"DEF\"") + +if __name__ == "__main__": + unittest.main()

1 0

[flashproxy/master] source the email address from a defaults file, don't hard code it
by infinity0＠torproject.org 21 Nov '13

21 Nov '13

commit 4811b51af8a5bf5c97dd1053e89c091a07916f4a Author: Ximin Luo <infinity0(a)gmx.com> Date: Tue Sep 24 20:11:41 2013 +0100 source the email address from a defaults file, don't hard code it --- facilitator/INSTALL | 6 ++++-- facilitator/Makefile.am | 2 ++ facilitator/default/facilitator-email-poller | 6 ++++++ facilitator/facilitator-email-poller | 13 ++++++++----- facilitator/init.d/facilitator-email-poller.in | 13 ++++++++++++- 5 files changed, 32 insertions(+), 8 deletions(-) diff --git a/facilitator/INSTALL b/facilitator/INSTALL index a7ed1dc..bd47adf 100644 --- a/facilitator/INSTALL +++ b/facilitator/INSTALL @@ -21,8 +21,10 @@ You should securely distribute the public key to anyone that wants to use your facilitator; they will need to pass it as the --facilitator-pubkey option to flashproxy-reg-email. -You should also edit /usr/local/etc/flashproxy/reg-email.pass to contain your -app-specific Gmail password; see doc/gmail-howto.txt for instructions. +You should also edit /usr/local/etc/default/facilitator-email-poller to +contain your Gmail address and /usr/local/etc/flashproxy/reg-email.pass +to contain your app-specific password; see doc/gmail-howto.txt for +instructions. Uninstall. diff --git a/facilitator/Makefile.am b/facilitator/Makefile.am index b8dff41..740ac3f 100644 --- a/facilitator/Makefile.am +++ b/facilitator/Makefile.am @@ -7,6 +7,7 @@ initscriptdir = /etc/init.d exampledir = $(docdir)/examples appenginedir = $(pkgdatadir)/appengine pkgconfdir = $(sysconfdir)/flashproxy +initdefaultdir = $(sysconfdir)/default appengineconfdir = $(pkgconfdir)/reg-appengine # automake PLVs @@ -14,6 +15,7 @@ appengineconfdir = $(pkgconfdir)/reg-appengine dist_bin_SCRIPTS = facilitator facilitator-email-poller facilitator-reg-daemon facilitator-reg facilitator.cgi fac.py if DO_INITSCRIPTS initscript_SCRIPTS = init.d/facilitator init.d/facilitator-email-poller init.d/facilitator-reg-daemon +initdefault_DATA = default/facilitator-email-poller endif dist_doc_DATA = doc/appengine-howto.txt doc/facilitator-howto.txt doc/gmail-howto.txt README diff --git a/facilitator/default/facilitator-email-poller b/facilitator/default/facilitator-email-poller new file mode 100644 index 0000000..af2f8ca --- /dev/null +++ b/facilitator/default/facilitator-email-poller @@ -0,0 +1,6 @@ +# Change to "yes" to run the email poller. +RUN_DAEMON="no" + +# Replace this with the email address for your facilitator. +# You should also edit the reg-email.pass file as needed. +FACILITATOR_EMAIL_ADDR="invalid" diff --git a/facilitator/facilitator-email-poller b/facilitator/facilitator-email-poller index 3504c51..32dc2d4 100755 --- a/facilitator/facilitator-email-poller +++ b/facilitator/facilitator-email-poller @@ -23,7 +23,6 @@ from M2Crypto import SSL, X509 DEFAULT_IMAP_HOST = "imap.gmail.com" DEFAULT_IMAP_PORT = 993 -DEFAULT_EMAIL_ADDRESS = "flashproxyreg.a(a)gmail.com" DEFAULT_LOG_FILENAME = "facilitator-email-poller.log" POLL_INTERVAL = 60 @@ -126,14 +125,14 @@ class IMAP4_SSL_REQUIRED(imaplib.IMAP4_SSL): def usage(f = sys.stdout): print >> f, """\ -Usage: %(progname)s --pass=PASSFILE +Usage: %(progname)s --email=ADDRESS --pass=PASSFILE Facilitator-side helper for the facilitator-reg-email rendezvous. Polls an IMAP server for email messages with client registrations, deletes them, and forwards the registrations to the facilitator. -d, --debug don't daemonize, log to stdout. --disable-pin don't check server public key against a known pin. - -e, --email=ADDRESS log in as ADDRESS (default "%(email_addr)s"). + -e, --email=ADDRESS log in as ADDRESS -h, --help show this help. -i, --imap=HOST[:PORT] use the given IMAP server (default "%(imap_addr)s"). --imaplib-debug show raw IMAP messages (will include email password). @@ -144,7 +143,6 @@ them, and forwards the registrations to the facilitator. --unsafe-logging don't scrub email password and IP addresses from logs.\ """ % { "progname": sys.argv[0], - "email_addr": DEFAULT_EMAIL_ADDRESS, "imap_addr": fac.format_addr((DEFAULT_IMAP_HOST, DEFAULT_IMAP_PORT)), "log": DEFAULT_LOG_FILENAME, } @@ -160,7 +158,7 @@ def log(msg): print >> options.log_file, (u"%s %s" % (time.strftime(LOG_DATE_FORMAT), msg)).encode("UTF-8") options.log_file.flush() -options.email_addr = DEFAULT_EMAIL_ADDRESS +options.email_addr = None options.imap_addr = (DEFAULT_IMAP_HOST, DEFAULT_IMAP_PORT) opts, args = getopt.gnu_getopt(sys.argv[1:], "de:hi:l:p:", [ @@ -206,6 +204,11 @@ if len(args) != 0: usage(sys.stderr) sys.exit(1) +# Check the email +if not options.email_addr or '@' not in options.email_addr: + print >> sys.stderr, "The --email option is required and must be an email address." + sys.exit(1) + # Load the email password. if options.password_filename is None: print >> sys.stderr, "The --pass option is required." diff --git a/facilitator/init.d/facilitator-email-poller.in b/facilitator/init.d/facilitator-email-poller.in index ef90794..44cc527 100755 --- a/facilitator/init.d/facilitator-email-poller.in +++ b/facilitator/init.d/facilitator-email-poller.in @@ -24,8 +24,15 @@ PIDFILE=@localstatedir@/run/$NAME.pid LOGFILE=@localstatedir@/log/$NAME.log CONFDIR=@sysconfdir@/flashproxy PRIVDROP_USER=@fpfacilitatoruser@ +DEFAULTSFILE=@sysconfdir@/default/$NAME + +# Include defaults if available +if [ -f $DEFAULTSFILE ] ; then + . $DEFAULTSFILE +fi + DAEMON=@bindir@/$NAME -DAEMON_ARGS="--pass $CONFDIR/reg-email.pass --log $LOGFILE --pidfile $PIDFILE --privdrop-user $PRIVDROP_USER" +DAEMON_ARGS="--email $FACILITATOR_EMAIL_ADDR --pass $CONFDIR/reg-email.pass --log $LOGFILE --pidfile $PIDFILE --privdrop-user $PRIVDROP_USER" # Exit if the package is not installed [ -x "$DAEMON" ] || exit 0 @@ -76,6 +83,10 @@ do_stop() case "$1" in start) + if [ "$RUN_DAEMON" != "yes" ]; then + log_action_msg "Not starting $DESC (Disabled in $DEFAULTSFILE)." + exit 0 + fi [ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME" do_start case "$?" in

1 0

[flashproxy/master] - move doc to more relevant place, move AC_CONFIG_FILES to bottom as standard
by infinity0＠torproject.org 21 Nov '13

21 Nov '13

commit d071b3362a305e1a3e33c24b69b76bf1bbaf9eb6 Author: Ximin Luo <infinity0(a)gmx.com> Date: Wed Oct 9 15:13:41 2013 +0100 - move doc to more relevant place, move AC_CONFIG_FILES to bottom as standard --- facilitator/README | 35 +++++++++++++++++++++++++++++++ facilitator/configure.ac | 10 ++++----- facilitator/doc/facilitator-howto.txt | 37 +-------------------------------- 3 files changed, 41 insertions(+), 41 deletions(-) diff --git a/facilitator/README b/facilitator/README index 81b44d5..49f17ce 100644 --- a/facilitator/README +++ b/facilitator/README @@ -8,3 +8,38 @@ integrate this package into its repositories.) For instructions on setting up and running the facilitator, see doc/facilitator-howto.txt. + +== Overview + +The facilitator consists of a backend server that is essentially a +dynamic database of client addresses, as well as helper programs that +receive client registrations from the Internet over various means and +pass them to the backend. There are three supported helper rendezvous +methods: HTTP, URL, and email. + +The HTTP rendezvous uses an HTTP server and a CGI program. The HTTP +server is responsible for speaking TLS and invoking the CGI program. The +CGI program receives client registrations and proxy requests for +clients, parses them, and forwards them to the backend. We use Apache 2 +as the HTTP server. The CGI script is facilitator.cgi. The backend is +facilitator. + +The email rendezvous uses the helper program facilitator-email-poller. +Clients use the flashproxy-reg-email program to send an encrypted +message to a Gmail address. The poller constantly checks for new +messages and forwards them to facilitator-reg. + +facilitator-reg is a simple program that forwards its standard input to +a locally running facilitator-reg-daemon process. + +facilitator-reg-daemon accepts connections containing encrypted client +registrations and forwards them to the facilitator. It exists as a +process of its own so that only one program requires access to the +facilitator's private key. + +The URL rendezvous uses the helper program flashproxy-reg-email. The +helper program doesn't actually make a registration; rather, it prints +out a URL which, when retrieved, makes the registration. + +fac.py is a Python module containing code common to the various +facilitator programs. diff --git a/facilitator/configure.ac b/facilitator/configure.ac index 3542238..4bab528 100644 --- a/facilitator/configure.ac +++ b/facilitator/configure.ac @@ -5,11 +5,6 @@ AM_INIT_AUTOMAKE([-Wall -Werror foreign]) AC_ARG_VAR(fpfacilitatoruser, [the user/group for the facilitator to run as]) fpfacilitatoruser="${fpfacilitatoruser:-flashproxy-fac}" -AC_CONFIG_FILES([Makefile - init.d/facilitator - init.d/facilitator-email-poller - init.d/facilitator-reg-daemon]) - AC_PROG_LN_S AM_PATH_PYTHON @@ -22,4 +17,9 @@ AC_ARG_ENABLE([initscripts], [do_initscripts=yes], [do_initscripts=]) AM_CONDITIONAL([DO_INITSCRIPTS], [test "x$do_initscripts" = xyes]) +AC_CONFIG_FILES([Makefile + init.d/facilitator + init.d/facilitator-email-poller + init.d/facilitator-reg-daemon]) + AC_OUTPUT diff --git a/facilitator/doc/facilitator-howto.txt b/facilitator/doc/facilitator-howto.txt index 3a853ef..7cd2f78 100644 --- a/facilitator/doc/facilitator-howto.txt +++ b/facilitator/doc/facilitator-howto.txt @@ -1,41 +1,6 @@ -This document describes how to run a flash proxy facilitator on Debian 7. +This document describes how to configure a flash proxy facilitator on Debian 7. We will use the domain name fp-facilitator.example.com. -== Overview - -The facilitator consists of a backend server that is essentially a -dynamic database of client addresses, as well as helper programs that -receive client registrations from the Internet over various means and -pass them to the backend. There are three supported helper rendezvous -methods: HTTP, URL, and email. - -The HTTP rendezvous uses an HTTP server and a CGI program. The HTTP -server is responsible for speaking TLS and invoking the CGI program. The -CGI program receives client registrations and proxy requests for -clients, parses them, and forwards them to the backend. We use Apache 2 -as the HTTP server. The CGI script is facilitator.cgi. The backend is -facilitator. - -The email rendezvous uses the helper program facilitator-email-poller. -Clients use the flashproxy-reg-email program to send an encrypted -message to a Gmail address. The poller constantly checks for new -messages and forwards them to facilitator-reg. - -facilitator-reg is a simple program that forwards its standard input to -a locally running facilitator-reg-daemon process. - -facilitator-reg-daemon accepts connections containing encrypted client -registrations and forwards them to the facilitator. It exists as a -process of its own so that only one program requires access to the -facilitator's private key. - -The URL rendezvous uses the helper program flashproxy-reg-email. The -helper program doesn't actually make a registration; rather, it prints -out a URL which, when retrieved, makes the registration. - -fac.py is a Python module containing code common to the various -facilitator programs. - == Basic and security setup Install some essential packages and configure a firewall.

1 0

[flashproxy/master] readd check target and change the test port so as to not conflict with existing service
by infinity0＠torproject.org 21 Nov '13

21 Nov '13

commit e2b902fbf0abf768bfacda495fa10868aea26568 Author: Ximin Luo <infinity0(a)gmx.com> Date: Sun Sep 15 17:37:12 2013 +0100 readd check target and change the test port so as to not conflict with existing service --- facilitator/Makefile.am | 3 +++ facilitator/facilitator-test | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/facilitator/Makefile.am b/facilitator/Makefile.am index d28dc48..b8dff41 100644 --- a/facilitator/Makefile.am +++ b/facilitator/Makefile.am @@ -29,6 +29,9 @@ CLEANFILES = $(initscript_SCRIPTS) # our own targets +check: + ./facilitator-test + # The {pre,post}-{install,remove} targets are just given as reference, and # ought to be separate scripts as part of your distro's installation process. # They are intentionally not linked to the install target since they require diff --git a/facilitator/facilitator-test b/facilitator/facilitator-test index cbd45f8..6dec76d 100755 --- a/facilitator/facilitator-test +++ b/facilitator/facilitator-test @@ -8,7 +8,7 @@ import unittest import fac FACILITATOR_HOST = "127.0.0.1" -FACILITATOR_PORT = 9002 +FACILITATOR_PORT = 39002 FACILITATOR_ADDR = (FACILITATOR_HOST, FACILITATOR_PORT) def gimme_socket(host, port):

1 0

[flashproxy/master] don't change owner of secret files; they are read by root and then privileges are dropped
by infinity0＠torproject.org 21 Nov '13

21 Nov '13

commit 11874b8dfe4b468f22572bab093cb7057d164e4d Author: Ximin Luo <infinity0(a)gmx.com> Date: Tue Oct 8 14:43:14 2013 +0100 don't change owner of secret files; they are read by root and then privileges are dropped --- facilitator/Makefile.am | 2 -- 1 file changed, 2 deletions(-) diff --git a/facilitator/Makefile.am b/facilitator/Makefile.am index 740ac3f..559f12c 100644 --- a/facilitator/Makefile.am +++ b/facilitator/Makefile.am @@ -86,8 +86,6 @@ install-secrets: "Replace this file's contents with your Gmail app-specific password;" @echo >> $(pkgconfdir)/reg-email.pass \ "see gmail-howto.txt in this package's documentation for details." - chown $(fpfacilitatoruser): $(pkgconfdir)/reg-daemon.key - chown $(fpfacilitatoruser): $(pkgconfdir)/reg-email.pass remove-secrets: rm -f $(pkgconfdir)/reg-*

1 0

[flashproxy/master] better instructions making use of the existing option
by infinity0＠torproject.org 21 Nov '13

21 Nov '13

commit a41dd9645725fb89e5d0112682410bb2a3deced5 Author: Ximin Luo <infinity0(a)gmx.com> Date: Sun Sep 15 17:21:47 2013 +0100 better instructions making use of the existing option --- facilitator/INSTALL | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/facilitator/INSTALL b/facilitator/INSTALL index dc9e848..a7ed1dc 100644 --- a/facilitator/INSTALL +++ b/facilitator/INSTALL @@ -17,9 +17,9 @@ The pre/post-install scripts create a user for the daemon to as, and sets up the initscripts in the default system runlevels. They also generate a RSA key in /usr/local/etc/flashproxy/reg-daemon.{key,pub}. -You will have to edit flashproxy-reg-email (in the client package) and -copy the contents of reg-daemon.pub into the appropriate place. -TODO(infinity0): find a better solution for this. +You should securely distribute the public key to anyone that wants to +use your facilitator; they will need to pass it as the +--facilitator-pubkey option to flashproxy-reg-email. You should also edit /usr/local/etc/flashproxy/reg-email.pass to contain your app-specific Gmail password; see doc/gmail-howto.txt for instructions.

1 0

[flashproxy/master] disable initscripts by default since it ignores ${prefix} and causes `make distcheck` to fail
by infinity0＠torproject.org 21 Nov '13

21 Nov '13

commit ce622cbf25a754dcac838f2af350b9c49ecf12b5 Author: Ximin Luo <infinity0(a)gmx.com> Date: Sat Sep 14 16:55:52 2013 +0100 disable initscripts by default since it ignores ${prefix} and causes `make distcheck` to fail --- facilitator/INSTALL | 2 +- facilitator/configure.ac | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/facilitator/INSTALL b/facilitator/INSTALL index b7e80a3..dc9e848 100644 --- a/facilitator/INSTALL +++ b/facilitator/INSTALL @@ -6,7 +6,7 @@ Install the dependencies. Configure and install. $ ./autogen.sh # if running from git or ./configure doesn't otherwise exist - $ ./configure --localstatedir=/var/local && make + $ ./configure --localstatedir=/var/local --enable-initscripts && make # make pre-install install post-install This installs facilitator.cgi, facilitator, facilitator-email-poller, diff --git a/facilitator/configure.ac b/facilitator/configure.ac index e6a100d..a212332 100644 --- a/facilitator/configure.ac +++ b/facilitator/configure.ac @@ -13,10 +13,11 @@ AC_CONFIG_FILES([Makefile AC_PROG_LN_S # check that we want to install initscripts. don't bother checking that they # are supported, since we might be doing a staged install on a different system. +# disabled by default since it ignores ${prefix} so `make distcheck` would fail AC_ARG_ENABLE([initscripts], - [AS_HELP_STRING([--disable-initscripts], - [install and configure sysvinit-style initscripts (default yes)])], - [do_initscripts=], [do_initscripts=yes]) + [AS_HELP_STRING([--enable-initscripts], + [install and configure sysvinit-style initscripts (default no)])], + [do_initscripts=yes], [do_initscripts=]) AM_CONDITIONAL([DO_INITSCRIPTS], [test "x$do_initscripts" = xyes]) AC_OUTPUT

1 0