Merge pull request #21 from Vovaman/f-18-make-real-tls

F 18 make real tls

Author: Vovaman

HISTORY.md

@@ -1,3 +1,9 @@
+0.3.0
+-----
+Full support for TLS.
+
+The installation method has also been changed.
+
 0.2.0
 -----
 Fix for big data packet.

Pipfile

@@ -4,9 +4,17 @@ verify_ssl = true
 name = "pypi"
 
 [packages]
-twine = "*"
+pyelftools = "*"
+micropy-cli = "*"
+esptool = "*"
+mpremote = "*"
 
 [dev-packages]
+setuptools = ">=68.0.0"
+wheel = "*"
+build = "*"
+twine = ">=6.1.0"
+packaging = "==25.0"
 
 [requires]
-python_version = "3.9"
+python_version = "3.10"

Pipfile.lock

@@ -1,19 +1,29 @@
+> This module is only for [micropython](https://micropython.org/)!
+
 # micropython-async_websocket_client
 This module is designed for ESP32 (and other) controllers.
-Goal: create and keep alive connection channel with websocket server.
+
+Target: create and keep alive connection channel with websocket server.
+
 You may send captured data from controlled devices through this channel to server and accept managing signals on your controller.
+
 This data channel works as background task while main control cycle is running too.
 The break of websocket channel doesn't corrupt main cycle of control.
 
+Module supports TLS with both client and server certificates.
+
 This project based on:
+
 https://github.com/danni/uwebsockets
+
 https://github.com/peterhinch/micropython-async
 
 **My gratitudes to authors**.
 
 # requirements
 This module is designed and tested on [ESP32S-WROOM-32](https://ru.wikipedia.org/wiki/%D0%A4%D0%B0%D0%B9%D0%BB:ESP32_Espressif_ESP-WROOM-32_Dev_Board.jpg).
-Development and tests were done based on [esp32-20220618-v1.19.1.bin](https://micropython.org/resources/firmware/esp32-20220618-v1.19.1.bin).
+
+Development and tests were done based on [ESP32-20250415-v1.25.0.bin](https://micropython.org/resources/firmware/ESP32_GENERIC-20250415-v1.25.0.bin).
 
 # installation
 <details>
@@ -30,10 +40,10 @@ Development and tests were done based on [esp32-20220618-v1.19.1.bin](https://mi
 >>> wifi = network.WLAN(network.STA_IF)
 >>> wifi.active(1)
 >>> wifi.connect(<name_of_your_wifi_net>, <wifi_password>)
->>> import upip
->>> upip.install('micropython-async-websocket-client')
+>>> import mip
+>>> mip.install("github:Vovaman/micropython_async_websocket_client/async_websocket_client/ws.py")
 ```
 
-All needed dependencies are in esp32-20220618-v1.19.1.bin.
+All needed dependencies are in firmware.
 # example
-Sample using of this module is in https://github.com/Vovaman/example_async_websocket.
+An example of how to use this module can be found in the https://github.com/Vovaman/example_async_websocket.

README.md

@@ -1,11 +1,11 @@
-import usocket as socket
-import uasyncio as a
-import ubinascii as binascii
-import urandom as random
-from ucollections import namedtuple
-import ure as re
-import ustruct as struct
-import ussl
+import socket
+import asyncio as a
+import binascii as b
+import random as r
+from collections import namedtuple
+import re
+import struct
+import ssl
 
 # Opcodes
 OP_CONT = const(0x0)
@@ -76,7 +76,7 @@ async def a_read(self, size: int = None):
         if size == 0:
             return b''
         chunks = []
-        
+
         while True:
             b = self.sock.read(size)
             await a.sleep_ms(self.delay_read)
@@ -97,25 +97,34 @@ async def a_read(self, size: int = None):
         # Join all the chunks and return them
         return b''.join(chunks)
 
-    async def handshake(self, uri, headers=[]):
+    async def handshake(self, uri, headers=[], keyfile=None, certfile=None, cafile=None):
         if self.sock:
             self.close()
 
         self.sock = socket.socket()
         self.uri = self.urlparse(uri)
         ai = socket.getaddrinfo(self.uri.hostname, self.uri.port)
         addr = ai[0][4]
+
         self.sock.connect(addr)
         self.sock.setblocking(False)
+
         if self.uri.protocol == 'wss':
-            self.sock = ussl.wrap_socket(self.sock, server_hostname=self.uri.hostname)
-        # await self.open(False)
+            with open(cafile, 'rb') as f:
+                cadata = f.read()
+            self.sock = ssl.wrap_socket(
+                self.sock, server_side=False,
+                key=keyfile, cert=certfile,
+                cert_reqs=2, #ssl.CERT_REQUIED,
+                cadata=cadata,
+                server_hostname=self.uri.hostname
+            )
 
         def send_header(header, *args):
             self.sock.write(header % args + '\r\n')
 
         # Sec-WebSocket-Key is 16 bytes of random base64 encoded
-        key = binascii.b2a_base64(bytes(random.getrandbits(8)
+        key = b.b2a_base64(bytes(r.getrandbits(8)
                                         for _ in range(16)))[:-1]
 
         send_header(b'GET %s HTTP/1.1', self.uri.path or '/')
@@ -211,7 +220,7 @@ def write_frame(self, opcode, data=b''):
             raise ValueError()
 
         if mask:  # Mask is 4 bytes
-            mask_bits = struct.pack('!I', random.getrandbits(32))
+            mask_bits = struct.pack('!I', r.getrandbits(32))
             self.sock.write(mask_bits)
             data = bytes(b ^ mask_bits[i % 4]
                          for i, b in enumerate(data))

async_websocket_client/ws.py

@@ -1,10 +1,9 @@
 # build package
 ```bash
 $ pipenv shell
-$ python setup.py sdist
+$ python -m build
 ```
 # ...and upload to PyPi
 ```bash
-$ rm dist/*.orig
-$ python -m twine upload dist/*
+$ twine upload dist/*
 ```

how_to_make_package.md

@@ -0,0 +1,19 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "micropython-async_websocket_client"
+version = "0.3.0"
+authors = [
+    {name = "Vladimir Badashkin", email = "bd_postbox1@mail.ru"},
+]
+description = "Asynchronous websocket client for ESP32 controller."
+readme = "README.md"
+license = {file = "LICENSE"}
+requires-python = ">=3.10"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+]