This repository contains source code of noiseprotocol - a Python 3 implementation of Noise Protocol Framework. Compatible with revisions 32 and 33.
Master branch contains latest version released. Trunk branch is an active development branch.
Available on Read the Docs. For now it provides basic documentation on HandshakeState, CipherState and SymmetricState. Refer to the rest of the README below for more information.
Installation and prerequisites
Only Python 3.5+ is supported. The author provides support for Linux systems only. Theoretically, package should work under Windows and OS X too, but those systems are not included in CI workflow.
Install via pip:
pip install noiseprotocol
noiseprotocol depends on Cryptography package (and its' pre-packaged OpenSSL v1.1) as a source of crypto-primitives. Usage of non-default crypto backend is possible as of version 0.3.0.
NoiseConnection class provides highest level of abstraction for the package. You can access full functionality of the package through this class' interfaces. An example for setting up NoiseConnection could look like this:
import socket from noise.connection import NoiseConnection sock = socket.socket() sock.connect(('localhost', 2000)) # Create instance of NoiseConnection, set up to use NN handshake pattern, Curve25519 for # elliptic curve keypair, ChaCha20Poly1305 as cipher function and SHA256 for hashing. proto = NoiseConnection.from_name(b'Noise_NN_25519_ChaChaPoly_SHA256') # Set role in this connection as initiator proto.set_as_initiator() # Enter handshake mode proto.start_handshake() # Perform handshake - as we are the initiator, we need to generate first message. # We don't provide any payload (although we could, but it would be cleartext for this pattern). message = proto.write_message() # Send the message to the responder - you may simply use sockets or any other way # to exchange bytes between communicating parties. sock.sendall(message) # Receive the message from the responder received = sock.recv(2048) # Feed the received message into noise payload = proto.read_message(received) # As of now, the handshake should be finished (as we are using NN pattern). # Any further calls to write_message or read_message would raise NoiseHandshakeError exception. # We can use encrypt/decrypt methods of NoiseConnection now for encryption and decryption of messages. encrypted_message = proto.encrypt(b'This is an example payload') sock.sendall(encrypted_message) ciphertext = sock.recv(2048) plaintext = proto.decrypt(ciphertext) print(plaintext)
The example above covers the connection from the initiator's ("client") point of view. The snippet below is an example of responder's code ("server") using a socket connection to send and receive ciphertext.
import socket from itertools import cycle from noise.connection import NoiseConnection if __name__ == '__main__': s = socket.socket() s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) s.bind(('localhost', 2000)) s.listen(1) conn, addr = s.accept() print('Accepted connection from', addr) noise = NoiseConnection.from_name(b'Noise_NN_25519_ChaChaPoly_SHA256') noise.set_as_responder() noise.start_handshake() # Perform handshake. Break when finished for action in cycle(['receive', 'send']): if noise.handshake_finished: break elif action == 'send': ciphertext = noise.write_message() conn.sendall(ciphertext) elif action == 'receive': data = conn.recv(2048) plaintext = noise.read_message(data) # Endless loop "echoing" received data while True: data = conn.recv(2048) if not data: break received = noise.decrypt(data) conn.sendall(noise.encrypt(received))
Wireguard integration example
In examples directory, there is an example of interoperation of this package with Wireguard VPN solution. Please refer to README.md of that example for details.
This software was tested only on Linux. It may or may not work on Windows, explicit support for this system may be added in future.
Please file any bug reports in project's issue tracker.
Development & contributing
Additional packages that may be useful during development are contained in dev_requirements.txt. Installation:
pip install -r dev_requirements.txt
Running tests (from root directory):
Todo-list for the project:
- add non-default crypto algorithms support, as requested
- fallback patterns support
- scripts for keypair generation (+ console entry points)
- "echo" (noise-c like) example
- extensive logging
- move away from custom ed448 implementation
- implement countermeasures for side-channel attacks
- get peer review of the code
You are more than welcome to propose new things to this list and/or implement them and file a merge request.
Contact the author: plizonczyk.public [at] gmail.com
This project is licensed under the MIT License - see the LICENSE file for details.