saltyrtc.server 5.0.1

Quick Start

Generate a new private permanent key:

saltyrtc-server generate /path/to/permanent-key

Run the following command to start the server on any address with port 8765:

saltyrtc-server serve \
    -p 8765 \
    -tc /path/to/x509-certificate \
    -tk /path/to/key \
    -k /path/to/permanent-key

Alternatively, provide the options via environment variables:

export SALTYRTC_SERVER_SERVE_PORT=8765 \
       SALTYRTC_SERVER_SERVE_TLSCERT=/path/to/x509-certificate \
       SALTYRTC_SERVER_SERVE_TLSKEY=/path/to/key \
       SALTYRTC_SERVER_SERVE_KEY=/path/to/permanent-key
saltyrtc-server serve

Docker

You can also use our official Docker images to run the server:

docker run \
    -v /path/to/cert-and-keys:/var/saltyrtc \
    -p 8765:8765
    -it saltyrtc/saltyrtc-server-python:<tag> serve \
    -p 8765 \
    -tc /var/saltyrtc/x509-certificate \
    -tk /var/saltyrtc/key \
    -k /var/saltyrtc/permanent-key

The above command maps port 8765 of the server within the container to port 8765 on the host machine.

Of course it is also possible to use environment variables to provide the options, as explained in the previous section.

5.0.1 (2019-09-09)

• Fix an exception when disconnected by another client

5.0.0 (2019-08-29)

• Bump the Python version requirement to 3.6.1

• Upgrade dependencies

• Fix a race condition that leads to path duplication

4.2.0 (2019-04-25)

• Internal refactoring of task and job handling

4.1.1 (2019-04-09)

• Fix accidental cancellation of the task loop

4.1.0 (2019-04-04)

• Allow the use of environment variables as CLI parameter substitution

  • Instead of saltyrtc-server serve --tlskey=foo you can now write SALTYRTC_SERVER_TLSKEY=foo saltyrtc-server serve

• Fix import order in pyi files

4.0.1 (2019-01-24)

• Bump the Python version requirement to 3.5.3

• Remove workarounds for Python 3.5.2

4.0.0 (2018-01-24)

Important: Make sure you’re using Python >= 3.5.3 before upgrading.

• Drop Python 3.4 support (major)

• Deprecate the CLI options -sc, –sslcert and -sk, –sslkey. Use -tc, –tlscert and -tk, –tlskey instead.

• Add type hints

• Fix discard string messages

• Fix validate received client ID types correctly

• Fix validate received sub-protocols correctly

• Fix a race condition during the handshake when one client drops another

• Cleanup of the code base

3.1.2 (2019-01-08)

• Fix imports for earlier Python 3.5 versions

3.1.1 (2019-01-08)

• Disable deprecation warning in py.test for now (see #90)

3.1.0 (2019-01-07)

• Event callback arguments now always need to provide a data argument

3.0.1 (2019-01-02)

• Fix forward the timeout close code as an int to event callbacks

3.0.0 (2018-12-18)

• Use the timeout close code (3008) when a client does not respond to a ping message (major)

• Add support for Python 3.7

• Various task queue improvements resulting in more robust client handling

• Fix to not send a ‘disconnected’ message when a responder has been dropped via ‘drop-responder’

• Fix to prevent the initiator from relaying messages to a responder client which is in the process of being dropped

• Fix to not accept new incoming connections when closing the server

2.0.1 (2018-08-20)

• Fix to prevent creating two path instances with the same path string

• Various improvements to logging messages

2.0.0 (2018-07-16)

Important: Make sure you’re using Python >= 3.4.4 and that your clients support the disconnected message before upgrading.

• Add support for the disconnected message (major)

• Fix potential invalid order of messages when dispatching a send-error

• Fix the id field’s value in the send-error message

• Fix a few potential race conditions

1.0.2 (2017-11-15)

• Fix do not accept unencrypted ‘client-auth’ messages from the initiator

1.0.1 (2017-07-25)

• Fix to handle new libnacl exceptions

1.0.0 (2017-03-24)

• Add server implementation of the SaltyRTC 1.0 Protocol

• Initial publication on PyPI