Merge pull request #86 from saltyrtc/py37-support

Python 3.7 Support & Task Queue Refactoring (again)

Author: lgrahl

.coveragerc

@@ -1,6 +1,6 @@
 [run]
 branch = True
-source = saltyrtc
+source = saltyrtc.server
 
 [report]
 exclude_lines =

.travis-install-libsodium.sh

@@ -1,73 +1,95 @@
 # Use container system
 sudo: false
 
-# Cache pip & libsodium
+# Install APT dependencies
+addons:
+  apt:
+    sources:
+    - sourceline: "ppa:chris-lea/libsodium"
+    packages:
+    - libsodium-dev
+
+# Cache pip
 cache:
   directories:
-  - $HOME/libsodium
   - $HOME/.cache/pip
 
 # Clean up pip log
 before_cache:
-  - rm -f $HOME/.cache/pip/log/debug.log
+- rm -f $HOME/.cache/pip/log/debug.log
 
 # Build matrix
 language: python
 matrix:
   include:
   - python: "3.4"
     env:
-      - EVENT_LOOP=asyncio
-      - TIMEOUT=2.0
+    - EVENT_LOOP=asyncio
+    - TIMEOUT=2.0
+    - IGNORE=tests/test_cli.py
   - python: "3.5"
     env:
-      - EVENT_LOOP=asyncio
-      - TIMEOUT=2.0
+    - EVENT_LOOP=asyncio
+    - TIMEOUT=2.0
   - python: "3.5"
     env:
-      - EVENT_LOOP=uvloop
-      - TIMEOUT=2.0
+    - EVENT_LOOP=uvloop
+    - TIMEOUT=2.0
     before_script: "pip install .[uvloop]"
   - python: "3.6"
     env:
-      - EVENT_LOOP=asyncio
-      - TIMEOUT=2.0
+    - EVENT_LOOP=asyncio
+    - TIMEOUT=2.0
   - python: "3.6"
     env:
-      - EVENT_LOOP=uvloop
-      - TIMEOUT=2.0
+    - EVENT_LOOP=uvloop
+    - TIMEOUT=2.0
     before_script: "pip install .[uvloop]"
+# TODO: Enable once 3.7 support has been added
+#  - python: "3.7"
+#    env:
+#    - EVENT_LOOP=asyncio
+#    - TIMEOUT=2.0
+#  - python: "3.7"
+#    env:
+#    - EVENT_LOOP=uvloop
+#    - TIMEOUT=2.0
+#    before_script: "pip install .[uvloop]"
   - python: "pypy3"  # 2017-08-05: It's pypy3-5.8.0-beta
     env:
-      - EVENT_LOOP=asyncio
-      - TIMEOUT=16.0
+    - EVENT_LOOP=asyncio
+    - TIMEOUT=16.0
 # TODO: Re-enable once pypy3 is able to compile uvloop
 #  - python: "pypy3"  # 2017-08-05: It's pypy3-5.8.0-beta
 #    env:
-#      - EVENT_LOOP=uvloop
-#      - TIMEOUT=16.0
+#    - EVENT_LOOP=uvloop
+#    - TIMEOUT=16.0
 #    before_script: "pip install .[uvloop]"
 
 # Install dependencies
-before_install:
-  - ./.travis-install-libsodium.sh
-  - export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:${HOME}/libsodium/lib
 install:
-  - pip install -U setuptools pip
-  - "pip install .[dev]"
-  - pip install codecov
+- pip install -U setuptools pip
+- "pip install .[dev]"
+- pip install codecov
 
 # Run flake8, isort, check docs & tests
+# TODO: Re-enable isort once #85 has been resolved
 script:
-  - >
-    if [[ "$TRAVIS_PYTHON_VERSION" != "pypy3" ]]; then
-      flake8 . || travis_terminate 1;
-      isort -rc -c . || (isort -rc -df . && return 1) || travis_terminate 1;
-    fi
-  - python setup.py checkdocs
-  - py.test --cov-config .coveragerc --cov=saltyrtc.server --loop=$EVENT_LOOP --timeout=$TIMEOUT
+- >
+  if [[ "$TRAVIS_PYTHON_VERSION" != "pypy3" ]]; then
+    flake8 . || travis_terminate 1;
+    #isort -rc -c . || (isort -rc -df . && return 1) || travis_terminate 1;
+  fi
+- python setup.py checkdocs
+- >
+  py.test \
+    --ignore=$IGNORE \
+    --cov-config=.coveragerc \
+    --cov=saltyrtc.server \
+    --loop=$EVENT_LOOP \
+    --timeout=$TIMEOUT
 
 # After success
 after_success:
-  - codecov
+- codecov
 

.travis.yml

@@ -272,3 +272,7 @@ def main():
     finally:
         if obj['logging_handler'] is not None:
             obj['logging_handler'].pop_application()
+
+
+if __name__ == '__main__':
+    main()

saltyrtc/server/bin.py

@@ -21,6 +21,7 @@
     'OverflowSentinel',
     'SubProtocol',
     'CloseCode',
+    'ClientState',
     'AddressType',
     'MessageType',
     'available_slot_range',
@@ -82,12 +83,44 @@ class CloseCode(enum.IntEnum):
     initiator_could_not_decrypt = 3005
     no_shared_tasks = 3006
     invalid_key = 3007
+    timeout = 3008
 
     @property
     def is_valid_drop_reason(self):
         return self.value in _drop_reasons
 
 
+@enum.unique
+class ClientState(enum.IntEnum):
+    """
+    The state of a :class:`PathClient`.
+
+    .. important:: States MUST follow the exact order as enumerated
+                   below. A client cannot go back a state or skip
+                   a state in between. For example, a *dropped* client
+                   MUST have been formerly *authenticated*.
+    """
+    # The client is connected but is not allowed to communicate
+    # with another client.
+    restricted = 1
+
+    # The client has been authenticated and may communicate with
+    # other clients (of different type).
+    authenticated = 2
+
+    # The client has been dropped by another client.
+    dropped = 3
+
+    @property
+    def next(self):
+        """
+        Return the subsequent state.
+
+        Raises :exc:`ValueError` in case there is no subsequent state.
+        """
+        return ClientState(self + 1)
+
+
 @enum.unique
 class AddressType(enum.IntEnum):
     server = 0x00

saltyrtc/server/common.py

@@ -14,6 +14,7 @@
     NONCE_FORMATTER,
     NONCE_LENGTH,
     AddressType,
+    ClientState,
     CloseCode,
     MessageType,
     OverflowSentinel,
@@ -192,8 +193,8 @@ def pack(self, client):
 
         # Encrypt payload if required
         if self.encrypted:
-            if not client.authenticated:
-                raise MessageFlowError('Cannot encrypt payload, no box available')
+            if client.state != ClientState.authenticated:
+                raise MessageFlowError('Cannot encrypt payload, not authenticated')
             payload = self._encrypt_payload(client, nonce, payload)
 
         # Append payload and return as bytes
@@ -224,7 +225,7 @@ def unpack(cls, client, data):
         expect_type = None
         if destination_type == AddressType.server:
             data = data[NONCE_LENGTH:]
-            if not client.authenticated and client.type is None:
+            if client.state == ClientState.restricted and client.type is None:
                 payload = None
 
                 # Try client-auth (encrypted)