coderaft 0.0.13 → 0.0.15

package/README.md

@@ -57,7 +57,7 @@ const instance = await startCodeServer({
   port: 6063,
   host: "127.0.0.1",
   defaultFolder: "/path/to/workspace",
-  // connectionToken: "my-secret", // auto-generated if omitted
+  // connectionToken: "my-secret", // disabled for localhost, auto-generated otherwise
 });
 
 console.log(`Ready at ${instance.url}`);
@@ -93,11 +93,12 @@ server.listen(3000);
 
 Creates a code-server handler without binding to a port.
 
-| Option            | Type                  | Description                                                     |
-| ----------------- | --------------------- | --------------------------------------------------------------- |
-| `defaultFolder`   | `string`              | Workspace folder opened when no input is given in the URL.      |
-| `connectionToken` | `string`              | Shared auth secret. Auto-generated if omitted.                  |
-| `vscode`          | `VSCodeServerOptions` | Extra options forwarded to VS Code's internal `createServer()`. |
+| Option            | Type                  | Description                                                                  |
+| ----------------- | --------------------- | ---------------------------------------------------------------------------- |
+| `defaultFolder`   | `string`              | Workspace folder opened when no input is given in the URL.                   |
+| `connectionToken` | `string`              | Shared auth secret. Disabled for localhost, auto-generated for remote hosts. |
+| `host`            | `string`              | Host/interface to bind. Used to infer whether to require a token.            |
+| `vscode`          | `VSCodeServerOptions` | Extra options forwarded to VS Code's internal `createServer()`.              |
 
 Returns a `CodeServerHandler`:
 
@@ -116,10 +117,9 @@ Convenience wrapper around `createCodeServer` that creates an HTTP server and st
 
 Accepts all `createCodeServer` options plus:
 
-| Option | Type     | Description                                                          |
-| ------ | -------- | -------------------------------------------------------------------- |
-| `port` | `number` | TCP port to listen on. Defaults to `$PORT` or `6063`.                |
-| `host` | `string` | Host/interface to bind. Defaults to Node's default (all interfaces). |
+| Option | Type     | Description                                           |
+| ------ | -------- | ----------------------------------------------------- |
+| `port` | `number` | TCP port to listen on. Defaults to `$PORT` or `6063`. |
 
 Returns a `CodeServerHandle`:
 
@@ -147,8 +147,12 @@ interface CodeServerHandle {
 
 ### Auth
 
+> [!NOTE]
+> When binding to `localhost` / `127.0.0.1` (or no `--host`), the connection token is **disabled by default** for convenience. When binding to any other host, a token is auto-generated unless `--without-connection-token` is explicitly passed. You can always override by providing `--token` or `--connection-token`.
+
 | Option                           | Description                                           |
 | -------------------------------- | ----------------------------------------------------- |
+| `-t, --token <token>`            | Connection token for auth (shorthand)                 |
 | `--connection-token <token>`     | Connection token for auth (auto-generated if omitted) |
 | `--connection-token-file <path>` | Path to file containing the connection token          |
 | `--without-connection-token`     | Disable connection token auth                         |

package/code.mjs

@@ -4,7 +4,7 @@ import { tmpdir } from "node:os";
 import { fileURLToPath } from "node:url";
 
 // Auto-updated by scripts/pack.ts
-const codeArchiveHash = "d28f51becc566aa4";
+const codeArchiveHash = "28b47fa16ea99a3f";
 
 const archivePath = fileURLToPath(new URL("./code.tar.zst", import.meta.url));
 

package/dist/_chunks/server.mjs

@@ -2,7 +2,6 @@ import { createRequire } from "node:module";
 import { randomBytes, randomUUID } from "node:crypto";
 import { createReadStream, readFileSync, readdirSync, unlinkSync } from "node:fs";
 import { createServer } from "node:http";
-import os, { homedir } from "node:os";
 import { extname, join, normalize, sep } from "node:path";
 import { stat } from "node:fs/promises";
 import { loadCode } from "#code";
@@ -53,6 +52,7 @@ if (process.platform === "android") {
 	const preload = `--import "data:text/javascript,Object.defineProperty(process,'platform',{value:'linux'})"`;
 	process.env.NODE_OPTIONS = process.env.NODE_OPTIONS ? `${process.env.NODE_OPTIONS} ${preload}` : preload;
 }
+const _os = __require("node:os");
 const MANIFEST_BODY = JSON.stringify({
 	name: "coderaft",
 	short_name: "coderaft",
@@ -74,12 +74,14 @@ const MANIFEST_BODY = JSON.stringify({
 });
 const ROBOTS_TXT = "User-agent: *\nDisallow: /\n";
 async function createCodeServer(opts = {}) {
-	const withoutToken = opts.vscode?.["without-connection-token"] === true;
+	const explicitToken = opts.connectionToken || opts.vscode?.["connection-token"];
+	const isLocal = !opts.host || /^(localhost|127\.0\.0\.1)$/.test(opts.host);
+	const withoutToken = opts.vscode?.["without-connection-token"] === true || !explicitToken && isLocal;
 	const connectionToken = withoutToken ? "" : opts.connectionToken ?? randomUUID();
 	const defaultFolder = opts.defaultFolder ?? process.cwd();
 	const mintKey = randomBytes(32);
 	process.env.CODE_SERVER_PARENT_PID ??= String(process.pid);
-	cleanupStaleLocks(opts.vscode?.["user-data-dir"] ?? join(homedir(), ".vscode-server-oss", "data"));
+	cleanupStaleLocks(opts.vscode?.["user-data-dir"] ?? join(_os.homedir(), ".vscode-server-oss", "data"));
 	const { modulesDir } = await loadCode();
 	const vsRootPath = join(modulesDir, "code-server", "lib", "vscode");
 	ensureNetworkInterface();
@@ -98,7 +100,7 @@ async function createCodeServer(opts = {}) {
 	}
 	const vscodeServer = await (await mod.loadCodeWithNls()).createServer(null, {
 		"default-folder": defaultFolder,
-		...withoutToken ? {} : { "connection-token": connectionToken },
+		...withoutToken ? { "without-connection-token": true } : { "connection-token": connectionToken },
 		"reconnection-grace-time": "10800",
 		"disable-getting-started-override": true,
 		...opts.vscode
@@ -212,17 +214,17 @@ async function startCodeServer(opts = {}) {
 	};
 }
 function ensureNetworkInterface() {
-	const original = os.networkInterfaces;
+	const original = _os.networkInterfaces;
 	const BLACKLISTED = new Set([
 		"00:00:00:00:00:00",
 		"ff:ff:ff:ff:ff:ff",
 		"ac:de:48:00:11:22"
 	]);
-	os.networkInterfaces = function networkInterfaces() {
-		const ifaces = original.call(os);
+	_os.networkInterfaces = function networkInterfaces() {
+		const ifaces = original.call(_os);
 		for (const name in ifaces) for (const info of ifaces[name]) if (info.mac && !BLACKLISTED.has(info.mac)) return ifaces;
 		const { createHash } = __require("node:crypto");
-		const hash = createHash("md5").update(os.hostname()).digest();
+		const hash = createHash("md5").update(_os.hostname()).digest();
 		hash[0] = (hash[0] | 2) & 254;
 		ifaces._coderaft = [{
 			address: "10.0.0.1",

package/dist/cli.mjs

@@ -15,6 +15,10 @@ const { values, positionals } = parseArgs({
 		"server-base-path": { type: "string" },
 		"socket-path": { type: "string" },
 		"print-startup-performance": { type: "boolean" },
+		token: {
+			type: "string",
+			short: "t"
+		},
 		"connection-token": { type: "string" },
 		"connection-token-file": { type: "string" },
 		"without-connection-token": { type: "boolean" },
@@ -93,6 +97,7 @@ if (values.help) {
         --print-startup-performance      Print startup timing to stdout
 
   Auth:
+    -t, --token <token>                  Connection token for auth (shorthand)
         --connection-token <token>       Connection token for auth (auto-generated)
         --connection-token-file <path>   Path to file containing connection token
         --without-connection-token       Disable connection token auth
@@ -223,7 +228,7 @@ const handle = await startCodeServer({
 	port: values.port ? Number(values.port) : void 0,
 	host: values.host,
 	defaultFolder: dir || values["default-folder"],
-	connectionToken: values["connection-token"],
+	connectionToken: values["connection-token"] ?? values.token,
 	vscode
 });
 const c = {

package/dist/index.d.mts

@@ -83,14 +83,14 @@ interface CreateCodeServerOptions {
   defaultFolder?: string;
   /** Connection token (shared auth secret). Auto-generated if omitted. */
   connectionToken?: string;
+  /** Host/interface to bind (used to infer local-only access for token default). */
+  host?: string;
   /** Extra options forwarded to VS Code's `createServer()`. */
   vscode?: VSCodeServerOptions;
 }
 interface StartCodeServerOptions extends CreateCodeServerOptions {
   /** TCP port to listen on. Defaults to `$PORT` or `6063`. */
   port?: number;
-  /** Host/interface to bind. Defaults to Node's default (all interfaces). */
-  host?: string;
 }
 interface CodeServerHandler {
   /** Node-style HTTP request handler (middleware). */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "coderaft",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "repository": "pithings/coderaft",
   "bin": {
     "coderaft": "./dist/cli.mjs"