@gitpod/gitpod-protocol 0.1.5-pd-metrics.33 → 0.1.5-pd-gen47-patch-test.0

package/src/gitpod-service.ts

@@ -24,6 +24,8 @@ import {
     GuessGitTokenScopesParams,
     GuessedGitTokenScopes,
     ProjectEnvVar,
+    UserSSHPublicKeyValue,
+    SSHPublicKeyValue,
 } from "./protocol";
 import {
     Team,
@@ -47,7 +49,12 @@ import { LicenseService } from "./license-protocol";
 import { Emitter } from "./util/event";
 import { AccountStatement, CreditAlert } from "./accounting-protocol";
 import { GithubUpgradeURL, PlanCoupon } from "./payment-protocol";
-import { TeamSubscription, TeamSubscriptionSlot, TeamSubscriptionSlotResolved } from "./team-subscription-protocol";
+import {
+    TeamSubscription,
+    TeamSubscription2,
+    TeamSubscriptionSlot,
+    TeamSubscriptionSlotResolved,
+} from "./team-subscription-protocol";
 import { RemotePageMessage, RemoteTrackMessage, RemoteIdentifyMessage } from "./analytics";
 import { IDEServer } from "./ide-protocol";
 import { InstallationAdminSettings, TelemetryData } from "./installation-admin-protocol";
@@ -142,6 +149,12 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     setEnvVar(variable: UserEnvVarValue): Promise<void>;
     deleteEnvVar(variable: UserEnvVarValue): Promise<void>;
 
+    // User SSH Keys
+    hasSSHPublicKey(): Promise<boolean>;
+    getSSHPublicKeys(): Promise<UserSSHPublicKeyValue[]>;
+    addSSHPublicKey(value: SSHPublicKeyValue): Promise<UserSSHPublicKeyValue>;
+    deleteSSHPublicKey(id: string): Promise<void>;
+
     // Teams
     getTeams(): Promise<Team[]>;
     getTeamMembers(teamId: string): Promise<TeamMemberInfo[]>;
@@ -235,7 +248,9 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
      */
     getChargebeeSiteId(): Promise<string>;
     createPortalSession(): Promise<{}>;
+    createTeamPortalSession(teamId: string): Promise<{}>;
     checkout(planId: string, planQuantity?: number): Promise<{}>;
+    teamCheckout(teamId: string, planId: string): Promise<{}>;
     getAvailableCoupons(): Promise<PlanCoupon[]>;
     getAppliedCoupons(): Promise<PlanCoupon[]>;
 
@@ -247,6 +262,7 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     subscriptionCancel(subscriptionId: string): Promise<void>;
     subscriptionCancelDowngrade(subscriptionId: string): Promise<void>;
 
+    getTeamSubscription(teamId: string): Promise<TeamSubscription2 | undefined>;
     tsGet(): Promise<TeamSubscription[]>;
     tsGetSlots(): Promise<TeamSubscriptionSlotResolved[]>;
     tsGetUnassignedSlot(teamSubscriptionId: string): Promise<TeamSubscriptionSlot | undefined>;

package/src/protocol.spec.ts

@@ -0,0 +1,97 @@
+/**
+ * Copyright (c) 2020 Gitpod GmbH. All rights reserved.
+ * Licensed under the GNU Affero General Public License (AGPL).
+ * See License-AGPL.txt in the project root for license information.
+ */
+
+import { suite, test } from "mocha-typescript";
+import * as chai from "chai";
+import { SSHPublicKeyValue } from ".";
+
+const expect = chai.expect;
+
+@suite
+class TestSSHPublicKeyValue {
+    private key =
+        "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDCnrN9UdK1bNGPmZfenTWXLuYYDjlYvZE8S+WOfP08WpR1GETzX5ZvgYOEZGwEE8KUPHC9cge4Hvo/ydIS9aqbZ5MiVGJ8cAIq1Ic89SjlDWU6fl8TwIqOPCi2imAASlEDP4q8vMLK1N6UOW1EVbxyL3uybGd10ysC1t1FxFPveIGNsYE/MOQeuEWS16AplpXYXIfVRSlgAskeBft2w8Ud3B4gNe8ECLA/FXu96UpvZkdtOarA3JZ9Z27GveNJg9Mtmmw0+US0KXiO9x9NyH7G8+mqVDwDY+nNvaFA5gtQxkkl/uY2oz9k/B4Rjlj3jOiUXe5uQs3XUm5m8g9a9fh62DabLpA2fEvtfg+a/VqNe52dNa5YjupwvBd6Inb5uMW/TYjNl6bNHPlXFKw/nwLOVzukpkjxMZUKS6+4BGkpoasj6y2rTU/wkpbdD8J7yjI1p6J9aKkC6KksIWgN7xGmHkv2PCGDqMHTNbnQyowtNKMgA/667vAYJ0qW7HAHBFXJRs6uRi/DI3+c1QV2s4wPCpEHDIYApovQ0fbON4WDPoGMyHd7kPh9xB/bX7Dj0uMXImu1pdTd62fQ/1XXX64+vjAAXS/P9RSCD0RCRt/K3LPKl2m7GPI3y1niaE52XhxZw+ms9ays6NasNVMw/ZC+f02Ti+L5FBEVf8230RVVRQ== notfound@gitpod.io";
+
+    @test public testValidate() {
+        const key = this.key;
+        const [t, k, e] = key.split(" ");
+        expect(
+            SSHPublicKeyValue.getData({
+                key,
+                name: "NiceName",
+            }),
+        ).to.deep.equal({ type: t, key: k, email: e });
+    }
+
+    @test public testValidateWithDiffType() {
+        const key = this.key;
+        const [_, k, e] = key.split(" ");
+        expect(
+            SSHPublicKeyValue.getData({
+                key: key.replace("ssh-rsa", "sk-ecdsa-sha2-nistp256@openssh.com"),
+                name: "NiceName",
+            }),
+        ).to.deep.equal({ type: "sk-ecdsa-sha2-nistp256@openssh.com", key: k, email: e });
+    }
+
+    @test public testValidateWithoutEmail() {
+        const key = this.key;
+        const [t, k, _] = key.split(" ");
+        expect(
+            SSHPublicKeyValue.getData({
+                key: key.replace(" notfound@gitpod.io", ""),
+                name: "NiceName",
+            }),
+        ).to.deep.equal({ type: t, key: k, email: undefined });
+    }
+
+    @test public testValidateWithoutEmailButEndsWithSpaces() {
+        const key = this.key;
+        const [t, k, _] = key.split(" ");
+        expect(
+            SSHPublicKeyValue.getData({
+                key: key.replace("notfound@gitpod.io", "  "),
+                name: "NiceName",
+            }),
+        ).to.deep.equal({ type: t, key: k, email: undefined });
+    }
+
+    @test public testValidateWithError() {
+        expect(() =>
+            SSHPublicKeyValue.getData({
+                key: "Hello World",
+                name: "NiceName",
+            }),
+        ).throw("Key is invalid");
+
+        expect(() =>
+            SSHPublicKeyValue.getData({
+                key: "",
+                name: "NiceName",
+            }),
+        ).throw("Key is invalid");
+    }
+
+    @test public testGetFingerprint() {
+        const key = this.key;
+        expect(
+            SSHPublicKeyValue.getFingerprint({
+                key,
+                name: "NiceName",
+            }),
+        ).to.equal("ykjP/b5aqoa3envmXzWpPMCGgEFMu3QvubfSTNrJCMA=");
+    }
+
+    @test public testGetFingerprintWithIncorrectPublicKey() {
+        expect(() =>
+            SSHPublicKeyValue.getFingerprint({
+                key: "Hello World",
+                name: "NiceName",
+            }),
+        ).to.throw("Key is invalid");
+    }
+}
+module.exports = new TestSSHPublicKeyValue(); // Only to circumvent no usage warning :-/

package/src/protocol.ts

@@ -242,12 +242,18 @@ export namespace UserEnvVar {
         if (name.trim() === "") {
             return "Name must not be empty.";
         }
+        if (name.length > 255) {
+            return "Name too long. Maximum name length is 255 characters.";
+        }
         if (!/^[a-zA-Z_]+[a-zA-Z0-9_]*$/.test(name)) {
             return "Name must match /^[a-zA-Z_]+[a-zA-Z0-9_]*$/.";
         }
         if (variable.value.trim() === "") {
             return "Value must not be empty.";
         }
+        if (variable.value.length > 32767) {
+            return "Value too long. Maximum value length is 32767 characters.";
+        }
         if (pattern.trim() === "") {
             return "Scope must not be empty.";
         }
@@ -350,6 +356,68 @@ export namespace UserEnvVar {
     }
 }
 
+export interface SSHPublicKeyValue {
+    name: string;
+    key: string;
+}
+export interface UserSSHPublicKey extends SSHPublicKeyValue {
+    id: string;
+    key: string;
+    userId: string;
+    fingerprint: string;
+    creationTime: string;
+    lastUsedTime?: string;
+}
+
+export type UserSSHPublicKeyValue = Omit<UserSSHPublicKey, "key" | "userId">;
+
+export namespace SSHPublicKeyValue {
+    export function validate(value: SSHPublicKeyValue): string | undefined {
+        if (value.name.length === 0) {
+            return "Title must not be empty.";
+        }
+        if (value.name.length > 255) {
+            return "Title too long. Maximum value length is 255 characters.";
+        }
+        if (value.key.length === 0) {
+            return "Key must not be empty.";
+        }
+        try {
+            getData(value);
+        } catch (e) {
+            return "Key is invalid. You must supply a key in OpenSSH public key format.";
+        }
+        return;
+    }
+
+    export function getData(value: SSHPublicKeyValue) {
+        // Begins with 'ssh-rsa', 'ecdsa-sha2-nistp256', 'ecdsa-sha2-nistp384', 'ecdsa-sha2-nistp521', 'ssh-ed25519', 'sk-ecdsa-sha2-nistp256@openssh.com', or 'sk-ssh-ed25519@openssh.com'.
+        const regex =
+            /^(?<type>ssh-rsa|ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-ed25519|sk-ecdsa-sha2-nistp256@openssh\.com|sk-ssh-ed25519@openssh\.com) (?<key>.*?)( (?<email>.*?))?$/;
+        const resultGroup = regex.exec(value.key.trim());
+        if (!resultGroup) {
+            throw new Error("Key is invalid.");
+        }
+        return {
+            type: resultGroup.groups?.["type"] as string,
+            key: resultGroup.groups?.["key"] as string,
+            email: resultGroup.groups?.["email"] || undefined,
+        };
+    }
+
+    export function getFingerprint(value: SSHPublicKeyValue) {
+        const data = getData(value);
+        let buf = Buffer.from(data.key, "base64");
+        // gitlab style
+        // const hash = createHash("md5").update(buf).digest("hex");
+        // github style
+        const hash = createHash("sha256").update(buf).digest("base64");
+        return hash;
+    }
+
+    export const MAXIMUM_KEY_LENGTH = 5;
+}
+
 export interface GitpodToken {
     /** Hash value (SHA256) of the token (primary key). */
     tokenHash: string;
@@ -482,6 +550,12 @@ export interface Snapshot {
     message?: string;
 }
 
+export interface VolumeSnapshot {
+    id: string;
+    creationTime: string;
+    volumeHandle: string;
+}
+
 export type SnapshotState = "pending" | "available" | "error";
 
 export interface LayoutData {
@@ -866,6 +940,7 @@ export namespace ExternalImageConfigFile {
 
 export interface WorkspaceContext {
     title: string;
+    ref?: string;
     /** This contains the URL portion of the contextURL (which might contain other modifiers as well). It's optional because it's not set for older workspaces. */
     normalizedContextURL?: string;
     forceCreateNewWorkspace?: boolean;

package/src/team-subscription-protocol.ts

@@ -33,6 +33,30 @@ export namespace TeamSubscription {
     };
 }
 
+export interface TeamSubscription2 {
+    id: string;
+    teamId: string;
+    planId: string;
+    startDate: string;
+    endDate?: string;
+    quantity: number;
+    /** The Chargebee subscription id */
+    paymentReference: string;
+    cancellationDate?: string;
+    excludeFromMoreResources: boolean;
+}
+
+export namespace TeamSubscription2 {
+    export const create = (ts2: Omit<TeamSubscription2, "id">): TeamSubscription2 => {
+        const withId = ts2 as TeamSubscription2;
+        withId.id = uuidv4();
+        return withId;
+    };
+    export const isActive = (ts2: TeamSubscription2, date: string): boolean => {
+        return ts2.startDate <= date && (ts2.endDate === undefined || date < ts2.endDate);
+    };
+}
+
 /**
  * A slot represents one unit of a TeamSubscription that gets assigned to one user at a time
  */

package/src/wsready.ts

@@ -4,7 +4,7 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
-// generated using github.com/32leaves/bel on 2022-03-29 17:08:06.113873917 +0000 UTC m=+0.010035965
+// generated using github.com/32leaves/bel on 2022-05-18 18:19:49.011672619 +0000 UTC m=+0.006607361
 // DO NOT MODIFY
 
 export enum WorkspaceInitSource {