frontend/project/datastore: make sshfs port number configurable

Author: haraldschilly

src/packages/database/postgres/project-queries.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
  */
 
@@ -14,7 +14,7 @@ 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 +52,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,21 +73,28 @@ 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 (
+      typeof val !== "string" &&
+      typeof val !== "boolean" &&
+      typeof val !== "number"
+    ) {
       throw new Error(`Invalid value -- '${key}' is not a valid type`);
     }
+    if (typeof val === "number" && (val < 0 || val > 2 ** 32)) {
+      throw new Error(`Invalid value -- '${key}' is out of range`);
+    }
     if (typeof val === "string" && val.length > 100000) {
       throw new Error(`Invalid value -- '${key}' is too long`);
     }
@@ -128,7 +135,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 +156,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,
@@ -78,6 +79,18 @@ const RULE_ALPHANUM = [
   },
 ];
 
+const RULE_PORT = [
+  {
+    validator: (_: any, value: number | null) => {
+      if (value == null) return Promise.resolve();
+      if (!Number.isInteger(value) || value < 1) {
+        return Promise.reject("Port must be an integer greater or equal to 1.");
+      }
+      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 +109,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 +192,7 @@ export const Datastore: React.FC<Props> = React.memo((props: Props) => {
           user: "",
           host: "",
           path: "",
+          port: 22,
         });
         break;
       default:
@@ -308,6 +326,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 +445,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 +609,16 @@ 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) {
+      if (config.port == null || config.port === "") {
+        delete config.port;
+      } else if (config.port === 22) {
+        delete config.port;
+      }
+    }
     try {
-      await set(values);
+      await set(config);
     } catch (err) {
       if (err) set_error(err);
     }
@@ -774,6 +802,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/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;