-
Notifications
You must be signed in to change notification settings - Fork 1.1k
webrepl: Changes for more webrepl features while making it smaller. #814
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev
Previous commit
webrepl: Implement file transfer protocol in python.
Signed-off-by: Felix Dörre <felix@dogcraft.de>
- Loading branch information
commit 772d240f81882eeda95c6dc38197292d34d89ab8
There are no files selected for viewing
53 changes: 53 additions & 0 deletions
micropython/net/webrepl/legacy_file_transfer.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| class LegacyFileTransfer: | ||
| def __init__(self): | ||
| self.opbuf = bytearray(82) | ||
| self.opptr = 0 | ||
| self.op = 0 | ||
|
|
||
| def handle(self, buf, sock): | ||
| if self.op == 2: | ||
| import struct | ||
|
|
||
| ret = self.file.readinto(memoryview(self.filebuf)[2:]) | ||
| memoryview(self.filebuf)[0:2] = struct.pack("<h", ret) | ||
| sock.ioctl(9, 2) | ||
| sock.write(memoryview(self.filebuf)[0 : (2 + ret)]) | ||
| if ret == 0: | ||
| sock.write(b"WB\x00\x00") | ||
| self.op = 0 | ||
| self.filebuf = None | ||
| sock.ioctl(9, 1) | ||
| return | ||
| self.opbuf[self.opptr] = buf[0] | ||
| self.opptr += 1 | ||
| if self.opptr != 82: # or bytes(buf[0:2]) != b"WA": | ||
| return | ||
| self.opptr = 0 | ||
| sock.ioctl(9, 2) | ||
| sock.write(b"WB\x00\x00") | ||
| sock.ioctl(9, 1) | ||
| type = self.opbuf[2] | ||
| if type == 2: # GET_FILE | ||
| self.op = type | ||
| name = self.opbuf[18:82].rstrip(b"\x00") | ||
| self.filebuf = bytearray(2 + 256) | ||
| self.file = open(name.decode(), "rb") | ||
| elif type == 1: # PUT_FILE | ||
| import struct | ||
|
|
||
| name = self.opbuf[18:82].rstrip(b"\x00") | ||
| size = struct.unpack("<I", self.opbuf[12:16])[0] | ||
| filebuf = bytearray(512) | ||
| with open(name.decode(), "wb") as file: | ||
| while size > 0: | ||
| ret = sock.readinto(filebuf) | ||
| if ret is None: | ||
| continue | ||
| if ret > 0: | ||
| file.write(memoryview(filebuf)[0:ret]) | ||
| size -= ret | ||
| elif ret < 0: | ||
| break | ||
| sock.ioctl(9, 2) | ||
| sock.write(b"WB\x00\x00") | ||
| sock.ioctl(9, 1) |
1 change: 1 addition & 0 deletions
micropython/net/webrepl/manifest.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| metadata(description="WebREPL server.", version="1.0.0") | ||
|
|
||
| module("webrepl.py", opt=3) | ||
| module("legacy_file_transfer.py", opt=3) | ||
| module("webrepl_setup.py", opt=3) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,56 +7,73 @@ | |
| import sys | ||
| import websocket | ||
| import io | ||
| from micropython import const | ||
| from legacy_file_transfer import LegacyFileTransfer | ||
|
|
||
| listen_s = None | ||
| client_s = None | ||
|
|
||
| DEBUG = 0 | ||
|
|
||
| _DEFAULT_STATIC_HOST = const("https://felix.dogcraft.de/webrepl/") | ||
| _DEFAULT_STATIC_HOST = const("https://micropython.org/webrepl/") | ||
| _WELCOME_PROMPT = const("\r\nWebREPL connected\r\n>>> ") | ||
| static_host = _DEFAULT_STATIC_HOST | ||
| webrepl_pass = None | ||
|
|
||
| legacy = LegacyFileTransfer() | ||
|
|
||
|
|
||
| class WebreplWrapper(io.IOBase): | ||
| def __init__(self, sock): | ||
| self.sock = sock | ||
| self.sock.ioctl(9, 2) | ||
| self.sock.ioctl(9, 1 if legacy else 2) | ||
| if webrepl_pass is not None: | ||
| self.pw = bytearray(16) | ||
| self.pwPos = 0 | ||
| self.sock.write("Password: ") | ||
| else: | ||
| self.pw = None | ||
| self.sock.write(_WELCOME_PROMPT); | ||
| self.sock.write(_WELCOME_PROMPT) | ||
|
|
||
| def readinto(self, buf): | ||
| if self.pw is not None: | ||
| buf = bytearray(1) | ||
| buf1 = bytearray(1) | ||
| while True: | ||
| l = self.sock.readinto(buf) | ||
| l = self.sock.readinto(buf1) | ||
| if l is None: | ||
| continue | ||
| if l <= 0: | ||
| return l | ||
| if buf[0] == 10 or buf[0] == 13: | ||
| if buf1[0] == 10 or buf1[0] == 13: | ||
| print("Authenticating with:") | ||
| print(self.pw[0:self.pwPos]) | ||
| if bytes(self.pw[0:self.pwPos]) == webrepl_pass: | ||
| print(self.pw[0 : self.pwPos]) | ||
| if bytes(self.pw[0 : self.pwPos]) == webrepl_pass: | ||
| self.pw = None | ||
| del self.pwPos | ||
| self.sock.write(_WELCOME_PROMPT) | ||
| break | ||
| else: | ||
| print(bytes(self.pw[0:self.pwPos])) | ||
| print(bytes(self.pw[0 : self.pwPos])) | ||
| print(webrepl_pass) | ||
| self.sock.write("\r\nAccess denied\r\n") | ||
| return 0 | ||
| else: | ||
| if self.pwPos < len(self.pw): | ||
| self.pw[self.pwPos] = buf[0] | ||
| self.pw[self.pwPos] = buf1[0] | ||
| self.pwPos = self.pwPos + 1 | ||
| return self.sock.readinto(buf) | ||
| ret = None | ||
| while True: | ||
| ret = self.sock.readinto(buf) | ||
| if ret is None or ret <= 0: | ||
| break | ||
| # ignore any non-data frames | ||
| if self.sock.ioctl(8) >= 8: | ||
| continue | ||
| if self.sock.ioctl(8) == 2 and legacy: | ||
| legacy.handle(buf, self.sock) | ||
| continue | ||
| break | ||
| return ret | ||
|
|
||
| def write(self, buf): | ||
| if self.pw is not None: | ||
|
|
@@ -72,8 +89,8 @@ def ioctl(self, kind, arg): | |
| def close(self): | ||
| self.sock.close() | ||
|
|
||
| def server_handshake(cl): | ||
| req = cl.makefile("rwb", 0) | ||
|
|
||
| def server_handshake(req): | ||
| # Skip HTTP GET line. | ||
| l = req.readline() | ||
| if DEBUG: | ||
|
|
@@ -115,30 +132,35 @@ def server_handshake(cl): | |
| if DEBUG: | ||
| print("respkey:", respkey) | ||
|
|
||
| cl.send( | ||
| req.write( | ||
| b"""\ | ||
| HTTP/1.1 101 Switching Protocols\r | ||
| Upgrade: websocket\r | ||
| Connection: Upgrade\r | ||
| Sec-WebSocket-Accept: """ | ||
| ) | ||
| cl.send(respkey) | ||
| cl.send("\r\n\r\n") | ||
| req.write(respkey) | ||
| req.write("\r\n\r\n") | ||
|
|
||
| return True | ||
|
|
||
|
|
||
| def send_html(cl): | ||
| cl.send( | ||
| cl.write( | ||
| b"""\ | ||
| HTTP/1.0 200 OK\r | ||
| \r | ||
| <base href=\"""" | ||
| ) | ||
| cl.send(static_host) | ||
| cl.send( | ||
| cl.write(static_host) | ||
| cl.write( | ||
| b"""\"></base>\r | ||
| <script src="webreplv2_content.js"></script>\r | ||
| <script src="webrepl""" | ||
| ) | ||
| if not legacy: | ||
| cl.write("v2") | ||
| cl.write( | ||
| b"""_content.js"></script>\r | ||
| """ | ||
| ) | ||
| cl.close() | ||
|
|
@@ -149,10 +171,7 @@ def setup_conn(port, accept_handler): | |
| listen_s = socket.socket() | ||
| listen_s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) | ||
|
|
||
| ai = socket.getaddrinfo("0.0.0.0", port) | ||
| addr = ai[0][4] | ||
|
|
||
| listen_s.bind(addr) | ||
| listen_s.bind(("", port)) | ||
| listen_s.listen(1) | ||
| if accept_handler: | ||
| listen_s.setsockopt(socket.SOL_SOCKET, 20, accept_handler) | ||
|
|
@@ -164,11 +183,14 @@ def setup_conn(port, accept_handler): | |
|
|
||
|
|
||
| def accept_conn(listen_sock): | ||
| global client_s | ||
| global client_s, webrepl_ssl_context | ||
| cl, remote_addr = listen_sock.accept() | ||
| sock = cl | ||
| if webrepl_ssl_context is not None: | ||
| sock = webrepl_ssl_context.wrap_socket(sock) | ||
|
|
||
| if not server_handshake(cl): | ||
| send_html(cl) | ||
| send_html(sock) | ||
| return False | ||
|
|
||
| prev = os.dupterm(None) | ||
|
|
@@ -180,13 +202,13 @@ def accept_conn(listen_sock): | |
| print("\nWebREPL connection from:", remote_addr) | ||
| client_s = cl | ||
|
|
||
| ws = websocket.websocket(cl, True) | ||
| ws = WebreplWrapper(ws) | ||
| sock = websocket.websocket(sock) | ||
| sock = WebreplWrapper(sock) | ||
| cl.setblocking(False) | ||
| # notify REPL on socket incoming data (ESP32/ESP8266-only) | ||
| if hasattr(os, "dupterm_notify"): | ||
| cl.setsockopt(socket.SOL_SOCKET, 20, os.dupterm_notify) | ||
| os.dupterm(ws) | ||
| os.dupterm(sock) | ||
|
|
||
| return True | ||
|
|
||
|
|
@@ -200,9 +222,10 @@ def stop(): | |
| listen_s.close() | ||
|
|
||
|
|
||
| def start(port=8266, password=None, accept_handler=accept_conn): | ||
| global static_host, webrepl_pass | ||
| def start(port=8266, password=None, ssl_context=None, accept_handler=accept_conn): | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
| global static_host, webrepl_pass, webrepl_ssl_context | ||
| stop() | ||
| webrepl_ssl_context = ssl_context | ||
| webrepl_pass = password | ||
| if password is None: | ||
| try: | ||
|
|
@@ -230,5 +253,5 @@ def start(port=8266, password=None, accept_handler=accept_conn): | |
| print("Started webrepl in manual override mode") | ||
|
|
||
|
|
||
| def start_foreground(port=8266, password=None): | ||
| start(port, password, None) | ||
| def start_foreground(port=8266, password=None, ssl_context=None): | ||
| start(port, password, ssl_context=ssl_context, accept_handler=None) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.