Merge pull request #53 from ricott1/onion3_address

added onion3 codec

Author: mhchia

multiaddr/codecs/onion3.py

@@ -0,0 +1,40 @@
+from __future__ import absolute_import
+import base64
+import struct
+
+import six
+
+
+SIZE = 296
+IS_PATH = False
+
+
+def to_bytes(proto, string):
+    addr = string.split(":")
+    if len(addr) != 2:
+        raise ValueError("Does not contain a port number")
+
+    # onion3 address without the ".onion" substring
+    if len(addr[0]) != 56:
+        raise ValueError("Invalid onion3 host address length (must be 56 characters)")
+    try:
+        onion3_host_bytes = base64.b32decode(addr[0].upper())
+    except Exception as exc:
+        six.raise_from(ValueError("Cannot decode {0!r} as base32: {1}".format(addr[0], exc)), exc)
+
+    # onion3 port number
+    try:
+        port = int(addr[1], 10)
+    except ValueError as exc:
+        six.raise_from(ValueError("Port number is not a base 10 integer"), exc)
+    if port not in range(1, 65536):
+        raise ValueError("Port number is not in range(1, 65536)")
+
+    return b''.join((onion3_host_bytes, struct.pack('>H', port)))
+
+
+def to_string(proto, buf):
+    addr_bytes, port_bytes = (buf[:-2], buf[-2:])
+    addr = base64.b32encode(addr_bytes).decode('ascii').lower()
+    port = six.text_type(struct.unpack('>H', port_bytes)[0])
+    return u':'.join([addr, port])

multiaddr/protocols.py

@@ -27,6 +27,7 @@
 P_WS = 0x01DD
 P_WSS = 0x01DE
 P_ONION = 0x01BC
+P_ONION3 = 0x01BD
 P_P2P_CIRCUIT = 0x0122
 P_DNS = 0x35
 P_DNS4 = 0x36
@@ -54,6 +55,7 @@
     P_WS,
     P_WSS,
     P_ONION,
+    P_ONION3,
     P_P2P_CIRCUIT,
     P_DNS,
     P_DNS4,
@@ -134,6 +136,7 @@ def __repr__(self):
     Protocol(P_UTP, 'utp', None),
     Protocol(P_P2P, 'p2p', 'p2p'),
     Protocol(P_ONION, 'onion', 'onion'),
+    Protocol(P_ONION3, 'onion3', 'onion3'),
     Protocol(P_QUIC, 'quic', None),
     Protocol(P_HTTP, 'http', None),
     Protocol(P_HTTPS, 'https', None),

tests/test_multiaddr.py

@@ -43,6 +43,12 @@
      "/onion/timaq4ygg2iegci7:-1",
      "/onion/timaq4ygg2iegci7",
      "/onion/timaq4ygg2iegci@:666",
+     "/onion3/9ww6ybal4bd7szmgncyruucpgfkqahzddi37ktceo3ah7ngmcopnpyyd:80",
+     "/onion3/vww6ybal4bd7szmgncyruucpgfkqahzddi37ktceo3ah7ngmcopnpyyd7:80",
+     "/onion3/vww6ybal4bd7szmgncyruucpgfkqahzddi37ktceo3ah7ngmcopnpyyd:0",
+     "/onion3/vww6ybal4bd7szmgncyruucpgfkqahzddi37ktceo3ah7ngmcopnpyyd:-1",
+     "/onion3/vww6ybal4bd7szmgncyruucpgfkqahzddi37ktceo3ah7ngmcopnpyyd",
+     "/onion3/vww6ybal4bd7szmgncyruucpgfkqahzddi37ktceo3ah7ngmcopnpyy@:666",
      "/udp/1234/sctp",
      "/udp/1234/udt/1234",
      "/udp/1234/utp/1234",
@@ -75,6 +81,8 @@ def test_invalid(addr_str):
      "/ip6zone/x%y/ip6/::",
      "/onion/timaq4ygg2iegci7:1234",
      "/onion/timaq4ygg2iegci7:80/http",
+     "/onion3/vww6ybal4bd7szmgncyruucpgfkqahzddi37ktceo3ah7ngmcopnpyyd:1234",
+     "/onion3/vww6ybal4bd7szmgncyruucpgfkqahzddi37ktceo3ah7ngmcopnpyyd:80/http",
      "/udp/0",
      "/tcp/0",
      "/sctp/0",

tests/test_protocols.py

@@ -94,9 +94,11 @@ def test_protocol_equality():
     proto1 = protocols.protocol_with_name('ip4')
     proto2 = protocols.protocol_with_code(protocols.P_IP4)
     proto3 = protocols.protocol_with_name('onion')
+    proto4 = protocols.protocol_with_name('onion3')
 
     assert proto1 == proto2
     assert proto1 != proto3
+    assert proto3 != proto4
     assert proto1 is not None
     assert proto2 != str(proto2)