fix cloud server by TheCommCraft · Pull Request #658 · TimMcCool/scratchattach

TheCommCraft · 2026-06-16T20:25:47Z

Solves issue #648

Changes

Added SSL version of cloud server and refactored cloud server module

Tests

TheCommCraft · 2026-06-16T20:36:00Z

When we merge this, we will need to update the documentation.

faretek1

There is a bunch of code duplication between TWCloudServer and TWSslCloudServer. Would it be worth reducing this? Inheritance/polymorphism could work here however that can tend to confuse where actual implementations are. Do you want me to try running this code to see if it works?

faretek1 · 2026-06-16T22:41:48Z

                        if self.server.log_var_sets:
-                            print(self.address[0]+":"+str(self.address[1]), "tried to set a var on non-whitelisted project and was disconnected, project:", data["project_id"], "user:",data["user"])
+                            print(
+                                self.address[0] + ":" + str(self.address[1]),


Could use fstring

This is just because the old code has it, which is kind of a separate issue

TheCommCraft · 2026-06-16T23:12:15Z

I guess it can't hurt

TheCommCraft · 2026-06-20T09:31:04Z

so?

faretek1

I have tried running it and have encountered issues (unable to connect to turbowarp project like I used to be able to). Am I doing something wrong?

faretek1 · 2026-06-25T07:39:13Z

+    keyfile: Optional[str] = None,
+    ssl_version: int = ssl.PROTOCOL_TLSv1_2,
+    ssl_context: Optional[ssl.SSLContext] = None,
+    thread: bool = True,


this argument is unused

faretek1 · 2026-06-25T07:40:28Z

+    hostname: str = "127.0.0.1",
+    port: int = 8080,
+    *,
+    thread: bool = True,


this argument also appears unused. i fixed this in the main branch a while ago. thread=True/False has to be provided when calling server.start() e.g. server.start(thread=False)

yea, it was already unused and this is semver2 so we cannot make api incompatible changes. we could however issue a warning if this is supplied.

i have added a warning for both unused params

faretek1 · 2026-06-25T07:43:04Z

+    )
+
+
+class TwSSLCloudServer(SimpleSSLWebSocketServer, BaseEventHandler):


It appears that the use of SimpleWebSocketServer means that we are forced to have class duplication here. I think it may be a good idea, at some point, to refactor the server to use the more conventional websockets library for both client and server. However this is not high priority

faretek1 · 2026-06-25T07:51:14Z

+    thread: bool = True,
+    length_limit: Optional[int] = None,
+    allow_non_numeric: bool = True,
+    whitelisted_projects: Optional[list[Any]] = None,


the default whitelisted_projects is None however when I use this default argument and try to connect to my project, it gives

127.0.0.1:60512 connected 127.0.0.1:60512 tried to handshake on a non-whitelisted project: 1315568661 user: player 127.0.0.1:60512 disconnected

i.e. it is not whitelisted when there is no whitelist in existence. This should not happen. I have not tested the SSLServer yet.

full log:

uv run python Python 3.14.0 (main, Nov 19 2025, 22:48:15) [Clang 21.1.4 ] on linux Type "help", "copyright", "credits" or "license" for more information. >>> import scratchattach as sa >>> sa.init_cloud_server.__annotations__ {'hostname': 'str', 'port': 'int', 'thread': 'bool', 'length_limit': 'Optional[int]', 'allow_non_numeric': 'bool', 'whitelisted_projects': 'Optional[list[Any]]', 'allow_nonscratch_names': 'bool', 'blocked_ips': 'Optional[list[str]]', 'sync_players': 'bool', 'log_var_sets': 'bool', 'return': 'TwCloudServer'} >>> srv = sa.init_cloud_server() >>> srv <scratchattach.eventhandlers.cloud_server.TwCloudServer object at 0x72620d9abe00> >>> srv <scratchattach.eventhandlers.cloud_server.TwCloudServer object at 0x72620d9abe00> >>> srv.start() Serving websocket server: ws://127.0.0.1:8080 >>> 127.0.0.1:48630 connected 127.0.0.1:48630 tried to handshake on a non-whitelisted project: 1315568661 user: player 127.0.0.1:48630 disconnected 127.0.0.1:60512 connected 127.0.0.1:60512 tried to handshake on a non-whitelisted project: 1315568661 user: player 127.0.0.1:60512 disconnected >>> >>>

url i used: https://turbowarp.org/1315568661?cloud_host=ws://127.0.0.1:8080

since it disconnects the user immediately, turbowarp thinks that the server rejected it because of its username, which is not true. Perhaps this should be added to documentation as a side note.

Even when I explicitly whitelist the project, it still fails. Is it meant to be a string, not an int? maybe we should avoid Any here.

>>> srv = sa.init_cloud_server(whitelisted_projects=[1315568661]) >>> srv.start() Serving websocket server: ws://127.0.0.1:8080 >>> 127.0.0.1:46418 connected 127.0.0.1:46418 tried to handshake on a non-whitelisted project: 1315568661 user: player 127.0.0.1:46418 disconnected >>> srv.whitelisted_projects [1315568661] >>>

that is how i provided the id, which could be wrong

should be fixed

faretek1 · 2026-06-25T07:59:52Z

+            thread.join()
+
+
+def init_ssl_cloud_server(


this function is not exported in __init__.py so i cannot use sa.init_ssl_cloud_server, but have to do sa.eventhandlers.cloud_server.init_ssl_cloud_server

faretek1 · 2026-06-25T08:06:39Z

+    port: int = 8080,
+    *,
+    certfile: Optional[str] = None,
+    keyfile: Optional[str] = None,


there should be docs for this. Also it would be nice if a more graceful error could be given (I am not aware of how to use ssl_context) instead of relying on SimpleSSLWebsockerServer to fail and give an error like so: TypeError: certfile should be a valid filesystem path. If I haven't provided a certfile, then how can I know what this means and how to fix it?

I cannot use this in a browser because it complains about it being a Self-signed cert, and when I add it to the CAs, it complains about a "CA cert being used as an end entity." How should I add an exception for my browser (or something else) so that I can use turbowarp's cloud_host parameter with the TWSSLCloudServer?

I looked it up and if one wants to be accepted by any browser (without changing any settings), one needs to use a domain instead of an ip to access the secure websocket. It might still be possible to use your own computer to host the cloud server but you would have to forward a port.

TheCommCraft · 2026-06-25T09:29:53Z

The easiest way to get a cloud server that is accessible from any normal browser is to start the cloud server without SSL and then just tunnel the port and use wss://<tunnel_domain>. You can also host a cloud server with SSL if your server is accessible from the internet by pointing a domain at the server and using a CA signed certificate with the SSL server.

TheCommCraft · 2026-06-25T09:30:30Z

I have only tested the first method but it works well and I don't have a server that I could use to test the second method.

fix cloud server

239391d

TheCommCraft had a problem deploying to release June 16, 2026 20:25 — with GitHub Actions Failure

TheCommCraft requested a review from faretek1 June 16, 2026 20:27

faretek1 reviewed Jun 16, 2026

View reviewed changes

faretek1 requested changes Jun 25, 2026

View reviewed changes

warn if thread is set in init_cloud_server

e73e500

TheCommCraft temporarily deployed to release June 25, 2026 08:39 — with GitHub Actions Inactive

remove incorrect default value for whitelisted_projects

798531a

TheCommCraft temporarily deployed to release June 25, 2026 08:41 — with GitHub Actions Inactive

use f-strings + implicit concatenation instead of concatenations

28694ad

TheCommCraft temporarily deployed to release June 25, 2026 08:45 — with GitHub Actions Inactive

export init_ssl_cloud_server

8ae769a

TheCommCraft temporarily deployed to release June 25, 2026 08:46 — with GitHub Actions Inactive

convert project ids to strings

309df20

TheCommCraft temporarily deployed to release June 25, 2026 08:48 — with GitHub Actions Inactive

add remove_cloud_prefix

92b7cd7

TheCommCraft deployed to release June 25, 2026 09:37 — with GitHub Actions Active

		)


		class TwSSLCloudServer(SimpleSSLWebSocketServer, BaseEventHandler):

Conversation

TheCommCraft commented Jun 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Tests

Uh oh!

TheCommCraft commented Jun 16, 2026

Uh oh!

faretek1 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

faretek1 Jun 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TheCommCraft commented Jun 16, 2026

Uh oh!

TheCommCraft commented Jun 20, 2026

Uh oh!

faretek1 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TheCommCraft commented Jun 25, 2026

Uh oh!

TheCommCraft commented Jun 25, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

TheCommCraft commented Jun 16, 2026 •

edited

Loading

faretek1 Jun 16, 2026 •

edited

Loading