feat(cloud_server): implement SSL secure websocket from semver2 into semver3 by Boss-1s · Pull Request #723 · TimMcCool/scratchattach

Boss-1s · 2026-08-26T03:16:16Z

Resolves nothing

Changes

Implemented SSL secure ws server (fix cloud server #658) from semver2 into semver 3
New class ~~_SaWebSockectServer~~ BaseWebSocketServer in sa.eventhandlers._base to keep things pythonic and organized
You can now link a cloud
refactoring everything related cause why not

Tasks

implement
clean up to match semver3 logic
feat(cloud_server): implement SSL secure websocket from semver2 into semver3 #723 (comment)
feat(cloud_server): implement SSL secure websocket from semver2 into semver3 #723 (comment)
could be more, we may need @faretek1 's thoughts on this as well

Tests

First, start up an insecure server to ensure it works:

import scratchattach as sa
from scratchattach.cloud.cloud import CustomCloud
import logging
from rich.traceback import install

install(show_locals=True)

# Init Server & Cloud Events

server_ip = '127.0.0.1'
server_port = 8080
project_id="1321224718"

server = sa.init_cloud_server("127.0.0.1",
                              server_port,
                              length_limit=65536,
                              allow_non_numeric=True,
                              whitelisted_projects=[project_id],
                              allow_nonscratch_names=False,
                              blocked_ips=["127.0.0.2"],
                              sync_players=True,
                              log_var_sets=True
                              )
server.start()


banned_cloud = CustomCloud(project_id='1234567',
                    cloud_host=f"ws://{server_ip}:{server_port}",
                    username = "Boss_1s",
                    length_limit = None,
                    allow_non_numeric = True,
                    _session = None,
                    header = None,
                    cookie = None,
                    origin = None,
                    print_connect_messages = True
                    )

bad_user_name_cloud = CustomCloud(project_id=project_id,
                    cloud_host=f"ws://{server_ip}:{server_port}",
                    username = "Boss_asdfghjkl",
                    length_limit = None,
                    allow_non_numeric = True,
                    _session = None,
                    header = None,
                    cookie = None,
                    origin = None,
                    print_connect_messages = True
                    )

cloud = CustomCloud(project_id=project_id,
                    cloud_host=f"ws://{server_ip}:{server_port}",
                    username = "Boss_1s",
                    length_limit = None,
                    allow_non_numeric = True,
                    _session = None,
                    header = None,
                    cookie = None,
                    origin = None,
                    print_connect_messages = True
                    )

no_user_cloud = CustomCloud(project_id=project_id,
                    cloud_host=f"ws://{server_ip}:{server_port}",
                    username = None,
                    length_limit = None,
                    allow_non_numeric = True,
                    _session = None,
                    header = None,
                    cookie = None,
                    origin = None,
                    print_connect_messages = True
                    )

no_project_cloud = CustomCloud(project_id=None,
                    cloud_host=f"ws://{server_ip}:{server_port}",
                    username="Boss_1s",
                    length_limit = None,
                    allow_non_numeric = True,
                    _session = None,
                    header = None,
                    cookie = None,
                    origin = None,
                    print_connect_messages = True
                    )

banned_cloud_events=banned_cloud.events()
bad_user_name_cloud_events=bad_user_name_cloud.events()
cloud_events=cloud.events()
no_user_cloud_events=no_user_cloud.events()
no_project_cloud_events=no_project_cloud.events()

While the above script is running, run websocat ws://127.0.0.1:8080 to interact with the websocket.

Once you have determined that this works, replace the above script with the one below:

import scratchattach as sa
from scratchattach.cloud.cloud import CustomCloud
import logging
from rich.traceback import install

install(show_locals=True)

# Init Server & Cloud Events

server_ip = '127.0.0.1'
server_port = 8080
project_id="1321224718"

# Test with ssl and make sure it works

server = sa.init_ssl_cloud_server("127.0.0.1",
                              server_port,
                              length_limit=65536,
                              allow_non_numeric=True,
                              whitelisted_projects=[project_id],
                              allow_nonscratch_names=False,
                              blocked_ips=["127.0.0.2"],
                              sync_players=True,
                              log_var_sets=True,
                              certfile="certfile.pem",
                              keyfile="keyfile.pem"
                              )
server.start()


banned_cloud = CustomCloud(project_id='1234567',
                    cloud_host=f"wss://{server_ip}:{server_port}",
                    username = "Boss_1s",
                    length_limit = None,
                    allow_non_numeric = True,
                    _session = None,
                    header = None,
                    cookie = None,
                    origin = None,
                    print_connect_messages = True
                    )

bad_user_name_cloud = CustomCloud(project_id=project_id,
                    cloud_host=f"wss://{server_ip}:{server_port}",
                    username = "Boss_asdfghjkl",
                    length_limit = None,
                    allow_non_numeric = True,
                    _session = None,
                    header = None,
                    cookie = None,
                    origin = None,
                    print_connect_messages = True
                    )

cloud = CustomCloud(project_id=project_id,
                    cloud_host=f"wss://{server_ip}:{server_port}",
                    username = "Boss_1s",
                    length_limit = None,
                    allow_non_numeric = True,
                    _session = None,
                    header = None,
                    cookie = None,
                    origin = None,
                    print_connect_messages = True
                    )

no_user_cloud = CustomCloud(project_id=project_id,
                    cloud_host=f"wss://{server_ip}:{server_port}",
                    username = None,
                    length_limit = None,
                    allow_non_numeric = True,
                    _session = None,
                    header = None,
                    cookie = None,
                    origin = None,
                    print_connect_messages = True
                    )

no_project_cloud = CustomCloud(project_id=None,
                    cloud_host=f"wss://{server_ip}:{server_port}",
                    username="Boss_1s",
                    length_limit = None,
                    allow_non_numeric = True,
                    _session = None,
                    header = None,
                    cookie = None,
                    origin = None,
                    print_connect_messages = True
                    )

banned_cloud_events=banned_cloud.events()
bad_user_name_cloud_events=bad_user_name_cloud.events()
cloud_events=cloud.events()
no_user_cloud_events=no_user_cloud.events()
no_project_cloud_events=no_project_cloud.events()

Then, generate an OpenSSL certificate:

openssl req -x509 -newkey rsa:4096 -keyout keyfile.pem -out certfile.pem -days 365 -nodes

Finally, run the server script, and interact with the WebSocket with websocat -k wss://127.0.0.1:8080

Notes

might wanna have #722 fixed before merging this, idk

…semver3 Signed-off-by: GitHub <noreply@github.com>

Signed-off-by: GitHub <noreply@github.com>

- Moved `BaseCloudServer` (Formerly `_SaCloudServer`) to sa.eventhandlers._base Signed-off-by: GitHub <noreply@github.com>

Signed-off-by: GitHub <noreply@github.com>

Boss-1s · 2026-08-30T16:05:05Z

@TheCommCraft

TheCommCraft · 2026-09-02T18:00:34Z

Tell me if you require help in applying these changes

(cherry picked from commit 8d30697) Signed-off-by: GitHub <noreply@github.com>

### sa.eventhandlers._base - changed list comp to generator comp in set_project_vars() and set_var() - reimplemented attribute type hints into BaseCloudServer. since type hints are inhierted, there is no need to restate them in child classes of BaseCloudServer. ### sa.eventhandlers.cloud_server - added type hitns to __init__ of BaseCloudServer child classes - added type hints to init_cloud_server and init_ssl_cloud_server - revert changing warnings.warn to print in 9863d50 Signed-off-by: GitHub <noreply@github.com>

Signed-off-by: GitHub <noreply@github.com>

Co-authored-by: TheCommCraft <79996518+TheCommCraft@users.noreply.github.com> Signed-off-by: Boss_1s <95505913+Boss-1s@users.noreply.github.com>

Signed-off-by: Boss_1s <95505913+Boss-1s@users.noreply.github.com>

Signed-off-by: GitHub <noreply@github.com>

TheCommCraft · 2026-09-05T21:32:31Z

I think that the custom cloud solution you added might cause extreme lag, it would be better to just not add a cloud at first (or you could create a cloud that just translates method calls of the cloud into those of the server)

Signed-off-by: GitHub <noreply@github.com>

Boss-1s · 2026-09-09T15:32:01Z

The only thing left is the set var prefix option, then we should be done here

TheCommCraft · 2026-11-05T18:25:09Z

Do you want to complete this PR or should I continue?

Boss-1s · 2026-11-06T14:30:07Z

jtlyk I am unable to resolve the conflicts; they are too complex

Signed-off-by: TheCommCraft <79996518+TheCommCraft@users.noreply.github.com>

faretek1

It is difficult for me to provide a useful review because I haven't interacted the codebase that much recently, but I have tried to provide a few comments. I do not see anything obviously wrong, however my judgement is limited

Some additional notes:

We are using a lot of Any and then converting to str. Maybe it is not possible now but it would probably be better to do that conversion earlier, so we do not get Any propagating everywhere. Unless if it would be a breaking change to a user-facing API
We are using SimpleWebSocketServer a lot although we really should change that (#734)
In truth, AI code review could probably be useful here

faretek1 · 2026-08-30T18:33:46Z

+                certfile: str|None = None,
+                keyfile: str|None = None,
+                ssl_version: int = ssl.PROTOCOL_TLSv1_2,
+                ssl_context: ssl.SSLContext|None = None,


These attrs should be specific to SSL servers right?

Ie don't put them in the base class

faretek1 · 2026-11-06T17:46:59Z



-class BaseCloud(AnyCloud[Union[str, int]]):
+class BaseCloud(AnyCloud[Union[str, int, float]]):


small thing, but str | int | float is more concise

This would apply in a lot of cases in the codebase, e.g. every use of Optional, so this is more of a separate style issue

faretek1 · 2026-11-06T17:50:27Z

+
+        Args:
+            variable (str): The name of the cloud variable that should be set (provided without the cloud emoji)
+            value (Any): The value the cloud variable should be set to


Any is the wrong type here. should be str | int | float

faretek1 · 2026-11-06T17:53:19Z

+    "IP address or domain name of the host to bind the server to."
+    port: int
+    "Port to bind the server to."
+    tw_clients: dict[tuple[str, int], dict[str, Any]]


Would a TypedDict be possible here instead of using Any?

It would be better, but we could also just use a class.

faretek1 · 2026-11-06T17:53:47Z

+    "Port to bind the server to."
+    tw_clients: dict[tuple[str, int], dict[str, Any]]
+    "Dictionary containing information on connected clients."
+    tw_variables: dict[str, dict[str, Any]]


Would a TypedDict be possible here instead of using Any?

It would be better to use str | int | float

faretek1 · 2026-11-06T18:23:19Z

+            )
+            for varname in data
+        ]
+        json_string = "\n".join(json.dumps(packet) for packet in packets)


This isn't really a json string, but rather a number of lines of json (JSONL). Is this expected and is the scratchattach client also able to handle this?

It is the intended way to transmit multiple packets in scratch cloud variable websockets

faretek1 · 2026-11-06T18:32:11Z

+        intelligent_waits: bool = True,
+        max_retries: int = 2,


these arguments are unused. if this is intentional, they should also be removed from the docstring

faretek1 · 2026-11-06T18:34:26Z

+        if self.disconnected.is_set():
+            return


Would it be more appropriate to raise an error if you are trying to set variables if you are disconnected?

Also, it is noteworthy that self.disconnected.is_set() is being used for the set_var methods but not for the get_var methods. Is this intentional? Perhaps it is useful to still be able to see the variables after you are disconnected?

that was the thought behind it

faretek1 · 2026-11-06T18:42:50Z

+        while (progress < amount if amount >= 0 else progress == 0) and (
+            time.time() < end_time if end_time is not None else True
+        ):


this is a pretty confusing condition

feat(cloud_server): implement SSL secure websocket from semver2 into …

9863d50

…semver3 Signed-off-by: GitHub <noreply@github.com>

Boss-1s deployed to release August 26, 2026 03:16 — with GitHub Actions Active

Boss-1s added 2 commits August 26, 2026 15:36

fix(cloud_server): expose init_ssl_cloud_sever to top-level

7e8fddd

Signed-off-by: GitHub <noreply@github.com>

chore(eventhandlers._base): move mixin class to _base

bab2905

- Moved `BaseCloudServer` (Formerly `_SaCloudServer`) to sa.eventhandlers._base Signed-off-by: GitHub <noreply@github.com>

Boss-1s had a problem deploying to release August 26, 2026 16:18 — with GitHub Actions Failure

fatal(eventhandlers._base): missing imports

5cd379d

Signed-off-by: GitHub <noreply@github.com>

Boss-1s deployed to release August 26, 2026 17:38 — with GitHub Actions Active

TheCommCraft reviewed Sep 2, 2026

View reviewed changes

Boss-1s deployed to release September 2, 2026 21:38 — with GitHub Actions Active

export cloud server types

2950297

(cherry picked from commit 8d30697) Signed-off-by: GitHub <noreply@github.com>

Boss-1s force-pushed the semver3-secure-ws branch from 9a6846e to 2950297 Compare September 2, 2026 21:40

Boss-1s deployed to release September 2, 2026 21:40 — with GitHub Actions Active

Boss-1s deployed to release September 2, 2026 22:04 — with GitHub Actions Active

Boss-1s requested a review from TheCommCraft September 2, 2026 22:05

fix(sa.eventhandlers._base): ensure blocked_ips is always some list

8d5aa20

Signed-off-by: GitHub <noreply@github.com>

Boss-1s deployed to release September 2, 2026 22:08 — with GitHub Actions Active

feat: expose BaseCloudServer

70ffb36

Signed-off-by: GitHub <noreply@github.com>

Boss-1s deployed to release September 2, 2026 22:30 — with GitHub Actions Active

fatal: BaseCloudServer should not have ssl-related stuff

92cc748

Signed-off-by: GitHub <noreply@github.com>

Boss-1s deployed to release September 2, 2026 22:36 — with GitHub Actions Active

docstrings

1924636

Signed-off-by: GitHub <noreply@github.com>

Boss-1s deployed to release September 2, 2026 22:37 — with GitHub Actions Active

TheCommCraft requested changes Sep 2, 2026

View reviewed changes

Comment thread scratchattach/eventhandlers/cloud_server.py Resolved

Comment thread scratchattach/eventhandlers/_base.py Resolved

Comment thread scratchattach/eventhandlers/_base.py Resolved

resolve TimMcCool#723 (comment)

2a5dfc9

Co-authored-by: TheCommCraft <79996518+TheCommCraft@users.noreply.github.com> Signed-off-by: Boss_1s <95505913+Boss-1s@users.noreply.github.com>

Boss-1s deployed to release September 2, 2026 23:01 — with GitHub Actions Active

resolve

5b0ff22

Signed-off-by: Boss_1s <95505913+Boss-1s@users.noreply.github.com>

Boss-1s deployed to release September 2, 2026 23:04 — with GitHub Actions Active

Boss-1s deployed to release September 5, 2026 21:15 — with GitHub Actions Active

remove invalid cloudactivitydict values + temp fill-in for cloud key

0f921da

Signed-off-by: GitHub <noreply@github.com>

Boss-1s deployed to release September 5, 2026 21:20 — with GitHub Actions Active

This comment was marked as resolved.

Sign in to view

feat: link_cloud

c8a76c9

Signed-off-by: GitHub <noreply@github.com>

Boss-1s deployed to release September 7, 2026 13:11 — with GitHub Actions Active

This comment was marked as resolved.

Sign in to view

add cloud server adapter

cb00837

TheCommCraft had a problem deploying to release September 7, 2026 15:02 — with GitHub Actions Failure

fix circular import

615cb99

TheCommCraft had a problem deploying to release September 7, 2026 15:21 — with GitHub Actions Failure

fix second circular import

cc66264

TheCommCraft deployed to release September 7, 2026 15:24 — with GitHub Actions Active

Boss-1s mentioned this pull request Sep 27, 2026

feat: Turbowarp cloud debug message compliance #613

Draft

12 of 14 tasks

Merge branch 'main' into semver3-secure-ws

aa697f9

Signed-off-by: TheCommCraft <79996518+TheCommCraft@users.noreply.github.com>

TheCommCraft had a problem deploying to release November 6, 2026 17:16 — with GitHub Actions Failure

fix errors originating in merge commit

9964178

TheCommCraft deployed to release November 6, 2026 17:26 — with GitHub Actions Active

fix KeyError and infinite loop

c4779a2

TheCommCraft deployed to release November 6, 2026 17:36 — with GitHub Actions Active

TheCommCraft self-requested a review November 6, 2026 17:41

remove resolved todo

d78f40d

TheCommCraft deployed to release November 6, 2026 17:42 — with GitHub Actions Active

TheCommCraft approved these changes Nov 6, 2026

View reviewed changes

TheCommCraft requested a review from faretek1 November 6, 2026 17:43

faretek1 reviewed Nov 6, 2026

View reviewed changes



		class BaseCloud(AnyCloud[Union[str, int]]):
		class BaseCloud(AnyCloud[Union[str, int, float]]):

Conversation

Boss-1s commented Aug 26, 2026 • edited by TheCommCraft Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Tasks

Tests

Notes

Uh oh!

Boss-1s commented Aug 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TheCommCraft commented Sep 2, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TheCommCraft commented Sep 5, 2026

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

Boss-1s commented Sep 9, 2026

Uh oh!

TheCommCraft commented Nov 5, 2026

Uh oh!

Boss-1s commented Nov 6, 2026

Uh oh!

faretek1 left a comment • 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!

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!

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!

This branch was successfully deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Boss-1s commented Aug 26, 2026 •

edited by TheCommCraft

Loading

Boss-1s commented Aug 30, 2026 •

edited

Loading

faretek1 left a comment •

edited

Loading