summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKali Kaneko (leap communications) <kali@leap.se>2017-02-06 15:53:26 +0100
committerKali Kaneko (leap communications) <kali@leap.se>2017-02-23 00:40:40 +0100
commitdd7c63bd9ca5570d9a924d131c4786ffd15e2d2d (patch)
tree771d285366651c7f20604385bb00ae7191ad4aee
parent1ba66d113ae0e3ce1651709c812426a3453d94d2 (diff)
[docs] document the API/cli
-rw-r--r--src/leap/bitmask/vpn/README.rst52
-rw-r--r--src/leap/bitmask/vpn/service.py2
2 files changed, 53 insertions, 1 deletions
diff --git a/src/leap/bitmask/vpn/README.rst b/src/leap/bitmask/vpn/README.rst
new file mode 100644
index 00000000..f08d7abc
--- /dev/null
+++ b/src/leap/bitmask/vpn/README.rst
@@ -0,0 +1,52 @@
+VPN port
+--------
+What's here is a quick port of the legacy bitmask_client vpn code.
+It only work through the cli right now::
+
+ bitmaskctl user create tmp_user_baz002@demo.bitmask.net --pass 1234
+ signup ok
+ user tmp_user_baz002
+
+ bitmaskctl user auth tmp_user_baz002@demo.bitmask.net --pass 1234
+ srp_token iye7s1J7M3_iCdB4gXEAhxs-if3XOCwpKNPnvTC8ycE
+ uuid b63ac83826c7e1e903ed18f6f7780491
+
+ bitmaskctl eip get_cert demo.bitmask.net
+ get_cert ok
+
+ bitmaskctl eip check
+ eip_ready ok
+
+
+You also might want to install the helpers (a pop-up should appear, asking for
+authentication)::
+
+ bitmaskctl eip install
+ install ok
+
+And finally you should be able to launch the VPN::
+
+ bitmaskctl eip start demo.bitmask.net
+ start ok
+ result started
+
+ bitmaskctl eip status
+ firewall ON
+ EIP AUTH
+
+ bitmaskctl eip status
+ firewall ON
+ EIP CONNECTED
+ ↑↑↑ 11.3 K
+ ↓↓↓ 3.9 K
+
+
+Feedback needed
+---------------
+Much of what's exposed in the above API should be made transparently (download
+certificate). However, I prefer to test it manually before hiding it from the
+CLI.
+
+The UI integration should follow soon.
+
+Meanwhile, please report any bugs you find with its expected behavior.
diff --git a/src/leap/bitmask/vpn/service.py b/src/leap/bitmask/vpn/service.py
index 170c5afd..bbde1044 100644
--- a/src/leap/bitmask/vpn/service.py
+++ b/src/leap/bitmask/vpn/service.py
@@ -104,7 +104,7 @@ class EIPService(HookableService):
os.makedirs(cert_dir, mode=0700)
with open(cert_path, 'w') as outf:
outf.write(cert_str)
- heck_and_fix_urw_only(cert_path)
+ check_and_fix_urw_only(cert_path)
defer.returnValue({'get_cert': 'ok'})
def do_install(self):