add native websocket support #2350
Conversation
There was a problem hiding this comment.
Thank you for bringing this in! There are several things we need to consider before merging which I've mentioned inline.
Hi @frankli0324
| Examples: | ||
| >>> ws = wstube('wss://echo.websocket.events') |
There was a problem hiding this comment.
Can we host a basic echo server ourselves in ci instead of relying on an external service? Those tend to be flakey and disturb the testing flow from time to time.
|
|
||
| ## 4.13.0 (`dev`) | ||
|
|
||
| - [#2350][2350] add native websocket support |
There was a problem hiding this comment.
Please add new entries to the bottom of the list
| .. testsetup:: * | ||
|
|
||
| from pwn import * | ||
| from websocket import WebSocket, ABNF, WebSocketException, WebSocketTimeoutException |
There was a problem hiding this comment.
This isn't necessary since it's not used in the doc tests themselves
| Arguments: | ||
| url (str): The websocket server's URL to connect to. | ||
| headers (dict): The same headers as the websocket protocol. |
There was a problem hiding this comment.
Aren't those additional headers to pass around?
How could we test this?
| self.closed = False | ||
| self.sock = WebSocket() | ||
| self.url = url | ||
| self.sock.connect(url, header=headers) |
There was a problem hiding this comment.
I think it is worth it to forward other useful arguments to the constructor like host, origin, cookie, and subprotocols. As well as the other ones.
There was a problem hiding this comment.
Handling the proxy configured in context.proxy would be great too!
| self.url = url | ||
| self.sock.connect(url, header=headers) | ||
|
|
||
|
|
There was a problem hiding this comment.
Maybe add a magic __call__ handler to forward calls to the underlying web socket instance like ping()
Some __getattr__ forward to e.g. get the optional close reason of the remote after the server closed the connection would be cool too.
| except: | ||
| return False | ||
|
|
||
| def close(self): |
There was a problem hiding this comment.
It should be possible to specify the web socket close reason
| self.sock.connect(url, header=headers) | ||
|
|
||
|
|
||
| def recv_raw(self, numb): |
There was a problem hiding this comment.
can_recv_raw needs to be implemented too to handle timeouts in the tube model.
|
Is anyone working on this? I hope it will be merged by the third 2024 Q3 at the latest. If there are no contributors working on it, I will try it. |
|
@minpeter Please open a new pull request if you start working on this. Closing for now since this has gone stale, feel free to reopen if you continue yourself @ksshen0000! |
Add native support for websocket.
this file are derived from pwntools-tube-websocket by frankli0324 under the MIT License.
https://gist.github.com/frankli0324/795162a14be988a01e0efa0531f7ac5a