Merge remote-tracking branch 'origin/datastore-sshfs-port' into pr-20251208

Author: haraldschilly

src/packages/database/postgres/project-queries.ts

@@ -1,20 +1,27 @@
 /*
- *  This file is part of CoCalc: Copyright © 2020 Sagemath, Inc.
+ *  This file is part of CoCalc: Copyright © 2020 – 2025 Sagemath, Inc.
  *  License: MS-RSL – see LICENSE.md for details
  */
 
+import debug from "debug";
 import { omit } from "lodash";
-import { PostgreSQL } from "./types";
+
 import { callback2 } from "@cocalc/util/async-utils";
+import {
+  DUMMY_SECRET,
+  PORT_MAX,
+  PORT_MIN,
+  validatePortNumber,
+} from "@cocalc/util/consts";
+import { DatastoreConfig } from "@cocalc/util/types";
 import { query } from "./query";
-import debug from "debug";
+import { PostgreSQL } from "./types";
+
 const L = debug("hub:project-queries");
-import { DUMMY_SECRET } from "@cocalc/util/consts";
-import { DatastoreConfig } from "@cocalc/util/types";
 
 export async function project_has_network_access(
   db: PostgreSQL,
-  project_id: string
+  project_id: string,
 ): Promise<boolean> {
   let x;
   try {
@@ -52,7 +59,7 @@ interface GetDSOpts {
 }
 
 async function get_datastore(
-  opts: GetDSOpts
+  opts: GetDSOpts,
 ): Promise<{ [key: string]: DatastoreConfig }> {
   const { db, account_id, project_id } = opts;
   const q: { users: any; addons?: any } = await query({
@@ -73,19 +80,34 @@ export async function project_datastore_set(
   db: PostgreSQL,
   account_id: string,
   project_id: string,
-  config: any
+  config: any,
 ): Promise<void> {
   // L("project_datastore_set", config);
 
   if (config.name == null) throw Error("configuration 'name' is not defined");
   if (typeof config.type !== "string")
     throw Error(
-      "configuration 'type' is not defined (must be 'gcs', 'sshfs', ...)"
+      "configuration 'type' is not defined (must be 'gcs', 'sshfs', ...)",
     );
 
   // check data from user
   for (const [key, val] of Object.entries(config)) {
-    if (typeof val !== "string" && typeof val !== "boolean") {
+    if (val == null) continue;
+    if (key === "port") {
+      const port = validatePortNumber(val);
+      if (port == null) {
+        throw new Error(
+          `Invalid value -- 'port' must be an integer between ${PORT_MIN} and ${PORT_MAX}`,
+        );
+      }
+      config.port = port;
+      continue;
+    }
+    if (
+      typeof val !== "string" &&
+      typeof val !== "boolean" &&
+      typeof val !== "number"
+    ) {
       throw new Error(`Invalid value -- '${key}' is not a valid type`);
     }
     if (typeof val === "string" && val.length > 100000) {
@@ -128,7 +150,7 @@ export async function project_datastore_del(
   db: PostgreSQL,
   account_id: string,
   project_id: string,
-  name: string
+  name: string,
 ): Promise<void> {
   L("project_datastore_del", name);
   if (typeof name !== "string" || name.length == 0) {
@@ -149,7 +171,7 @@ export async function project_datastore_del(
 export async function project_datastore_get(
   db: PostgreSQL,
   account_id: string,
-  project_id: string
+  project_id: string,
 ): Promise<any> {
   try {
     const ds = await get_datastore({

src/packages/frontend/project/settings/datastore.tsx

@@ -1,5 +1,5 @@
 /*
- *  This file is part of CoCalc: Copyright © 2021 – 2023 Sagemath, Inc.
+ *  This file is part of CoCalc: Copyright © 2021 – 2025 Sagemath, Inc.
  *  License: MS-RSL – see LICENSE.md for details
  */
 
@@ -21,6 +21,7 @@ import {
   Checkbox,
   Form,
   Input,
+  InputNumber,
   Modal,
   Popconfirm,
   Space,
@@ -50,6 +51,7 @@ import Password, {
 } from "@cocalc/frontend/components/password";
 import { labels } from "@cocalc/frontend/i18n";
 import { webapp_client } from "@cocalc/frontend/webapp-client";
+import { PORT_MAX, PORT_MIN, validatePortNumber } from "@cocalc/util/consts";
 import { DOC_CLOUD_STORAGE_URL } from "@cocalc/util/consts/project";
 import { DATASTORE_TITLE } from "@cocalc/util/db-schema/site-defaults";
 import { unreachable } from "@cocalc/util/misc";
@@ -78,6 +80,21 @@ const RULE_ALPHANUM = [
   },
 ];
 
+const RULE_PORT = [
+  {
+    validator: (_: any, value: number | null) => {
+      if (value == null) return Promise.resolve();
+      const port = validatePortNumber(value);
+      if (port == null) {
+        return Promise.reject(
+          `Port must be an integer between ${PORT_MIN} and ${PORT_MAX}.`,
+        );
+      }
+      return Promise.resolve();
+    },
+  },
+];
+
 // convert the configuration from the DB to fields for the table
 function raw2configs(raw: { [name: string]: Config }): Config[] {
   const ret: Config[] = [];
@@ -96,11 +113,15 @@ function raw2configs(raw: { [name: string]: Config }): Config[] {
         v.about = `Bucket: ${v.bucket}`;
         break;
       case "sshfs":
-        v.about = [
+        const about_sshfs = [
           `User: ${v.user}`,
           `Host: ${v.host}`,
           `Path: ${v.path ?? `/user/${v.user}`}`,
-        ].join("\n");
+        ];
+        if (v.port != null && v.port !== 22) {
+          about_sshfs.push(`Port: ${v.port}`);
+        }
+        v.about = about_sshfs.join("\n");
         break;
       default:
         unreachable(v);
@@ -175,6 +196,7 @@ export const Datastore: React.FC<Props> = React.memo((props: Props) => {
           user: "",
           host: "",
           path: "",
+          port: 22,
         });
         break;
       default:
@@ -308,6 +330,9 @@ export const Datastore: React.FC<Props> = React.memo((props: Props) => {
     const conf: Config = { ...record };
     conf.secret = "";
     delete conf.about;
+    if (conf.type === "sshfs" && conf.port == null) {
+      conf.port = 22;
+    }
     set_new_config(conf);
     set_form_readonly(conf.readonly ?? READONLY_DEFAULT);
     setEditMode(true);
@@ -424,7 +449,7 @@ export const Datastore: React.FC<Props> = React.memo((props: Props) => {
               >
                 <div style={{ fontSize: "90%" }}>
                   <Icon
-                    name={record.readonly ?? false ? "lock" : "lock-open"}
+                    name={(record.readonly ?? false) ? "lock" : "lock-open"}
                   />{" "}
                   {record.readonly ? "Read-only" : "Read/write"}
                 </div>
@@ -588,9 +613,13 @@ export const Datastore: React.FC<Props> = React.memo((props: Props) => {
   }
 
   async function save_config(values: any): Promise<void> {
-    values.readonly = form_readonly;
+    const config = { ...values, readonly: form_readonly };
+    if ("port" in config) {
+      const port = validatePortNumber(config.port);
+      config.port = port ?? 22;
+    }
     try {
-      await set(values);
+      await set(config);
     } catch (err) {
       if (err) set_error(err);
     }
@@ -774,6 +803,15 @@ function NewSSHFS({
       >
         <Input placeholder="login.server.edu" />
       </Form.Item>
+      <Form.Item
+        label="Port"
+        name="port"
+        rules={RULE_PORT}
+        tooltip="The SSH port, defaults to 22"
+        help="Leave empty to use port 22."
+      >
+        <InputNumber min={1} placeholder="22" style={{ width: "100%" }} />
+      </Form.Item>
       <Form.Item
         label="Remote Path"
         name="path"

src/packages/util/consts/index.ts

@@ -1,5 +1,5 @@
 /*
- *  This file is part of CoCalc: Copyright © 2020 Sagemath, Inc.
+ *  This file is part of CoCalc: Copyright © 2020 – 2025 Sagemath, Inc.
  *  License: MS-RSL – see LICENSE.md for details
  */
 
@@ -16,3 +16,5 @@ export { DUMMY_SECRET } from "./project";
 export { SERVER_SETTINGS_ENV_PREFIX } from "./server_settings";
 
 export { ANALYTICS_COOKIE_NAME } from "./tracking";
+
+export { PORT_MAX, PORT_MIN, validatePortNumber } from "./portnumber";

src/packages/util/consts/portnumber.ts

@@ -0,0 +1,20 @@
+/*
+ *  This file is part of CoCalc: Copyright © 2025 Sagemath, Inc.
+ *  License: MS-RSL – see LICENSE.md for details
+ */
+
+export const PORT_MIN = 1;
+export const PORT_MAX = 65535;
+
+export function validatePortNumber(port: unknown): number | undefined {
+  if (port == null || port === "") return;
+  const value =
+    typeof port === "number"
+      ? port
+      : typeof port === "string"
+      ? Number(port)
+      : NaN;
+  if (!Number.isInteger(value)) return;
+  if (value < PORT_MIN || value > PORT_MAX) return;
+  return value;
+}

src/packages/util/types/datastore.ts

@@ -26,6 +26,7 @@ interface ConfigSSHFS extends ConfigCommon {
   user: string;
   host: string;
   path?: string; // remote path, defaults to /home/user
+  port?: number;
 }
 
 export type DatastoreConfig = ConfigS3 | ConfigGCS | ConfigSSHFS;