Merge pull request #189 from dappnode/dapplion/release-fixes

dapplion · web-flow · commit 7668c9a2b71c · 2021-01-21T17:25:55.000+01:00
v0.2.8 Release fixes
diff --git a/build/src/src/api/routes.ts b/build/src/src/api/routes.ts
@@ -8,6 +8,12 @@ export interface Routes {
    */
   addDevice: (kwargs: { id: string }) => Promise<void>;
 
+  /**
+   * Returns the credentials file (.ovpn) for device `id`
+   * @param id "new-device"
+   */
+  getCredFile({ id }: { id: string }): Promise<string>;
+
   /**
    * Creates a new OpenVPN credentials file, encrypted.
    * The filename is the (16 chars short) result of hashing the generated salt in the db,
@@ -43,12 +49,6 @@ export interface Routes {
    */
   resetDevice: (kwargs: { id: string }) => Promise<void>;
 
-  /**
-   * Gives/removes admin rights to the provided device id.
-   * @param id Device id name
-   */
-  toggleAdmin: (kwargs: { id: string }) => Promise<void>;
-
   /**
    * Returns a list of the existing devices, with the admin property
    */
@@ -57,12 +57,12 @@ export interface Routes {
 
 export const routesData: { [P in keyof Routes]: {} } = {
   addDevice: {},
+  getCredFile: {},
   getDeviceCredentials: {},
   getMasterAdminCred: {},
   getStatus: {},
   removeDevice: {},
   resetDevice: {},
-  toggleAdmin: {},
   listDevices: {}
 };
 
diff --git a/build/src/src/calls/getCredFile.ts b/build/src/src/calls/getCredFile.ts
@@ -0,0 +1,9 @@
+import { getClient } from "../openvpn";
+
+/**
+ * Returns the credentials file (.ovpn) for device `id`
+ * @param id "new-device"
+ */
+export async function getCredFile({ id }: { id: string }): Promise<string> {
+  return await getClient(id);
+}
diff --git a/build/src/src/calls/getMasterAdminCred.ts b/build/src/src/calls/getMasterAdminCred.ts
@@ -1,5 +1,4 @@
 import { addDevice } from "./addDevice";
-import { toggleAdmin } from "./toggleAdmin";
 import { MAIN_ADMIN_NAME } from "../params";
 import { logs } from "../logs";
 import { getDeviceCredentials } from "./getDeviceCredentials";
@@ -19,7 +18,6 @@ export async function getMasterAdminCred(): Promise<VpnDeviceCredentials> {
       logs.info(`User ${MAIN_ADMIN_NAME} already exists`);
     } else {
       await addDevice({ id: MAIN_ADMIN_NAME });
-      await toggleAdmin({ id: MAIN_ADMIN_NAME });
     }
   } catch (e) {
     if (!e.message.includes("exist"))
diff --git a/build/src/src/calls/index.ts b/build/src/src/calls/index.ts
@@ -1,9 +1,9 @@
 export * from "./addDevice";
+export * from "./getCredFile";
 export * from "./getDeviceCredentials";
 export * from "./getMasterAdminCred";
 export * from "./getStatus";
 export * from "./getVersionData";
 export * from "./listDevices";
 export * from "./removeDevice";
 export * from "./resetDevice";
-export * from "./toggleAdmin";
diff --git a/build/src/src/calls/listDevices.ts b/build/src/src/calls/listDevices.ts
@@ -1,23 +1,13 @@
-import { getUserList, getCCD } from "../openvpn";
-import { VpnDevice, OpenVpnCCDItem } from "../types";
+import { getUserList } from "../openvpn";
+import { VpnDevice } from "../types";
 
 /**
  * Returns a list of the existing devices, with the admin property
  */
 export async function listDevices(): Promise<VpnDevice[]> {
   const userList = await getUserList();
-  const ccd = getCCD();
-
-  const ccdById = ccd.reduce(
-    (byId, device) => {
-      return { ...byId, [device.cn]: device };
-    },
-    {} as { [id: string]: OpenVpnCCDItem }
-  );
 
   return userList.map(user => ({
-    id: user,
-    admin: Boolean(ccdById[user]),
-    ip: (ccdById[user] || {}).ip || ""
+    id: user
   }));
 }
diff --git a/build/src/src/calls/removeDevice.ts b/build/src/src/calls/removeDevice.ts
@@ -1,19 +1,17 @@
-import { getUserList, getCCD, removeClient } from "../openvpn";
+import { getUserList, removeClient } from "../openvpn";
 import { MAIN_ADMIN_NAME } from "../params";
 
+export const REMOVE_MAIN_ADMIN_ERROR = "Cannot remove the main admin user";
+
 /**
  * Removes the device with the provided id, if exists.
  * @param id "new-device"
  */
 export async function removeDevice({ id }: { id: string }): Promise<void> {
   const deviceArray = await getUserList();
-  const ccdArray = getCCD();
-
-  if (ccdArray.find(c => c.cn === id))
-    throw Error("You cannot remove an admin user");
 
   if (id === MAIN_ADMIN_NAME) {
-    throw Error("Cannot remove the main admin user");
+    throw Error(REMOVE_MAIN_ADMIN_ERROR);
   }
 
   if (!deviceArray.includes(id)) {
diff --git a/build/src/src/calls/toggleAdmin.ts b/build/src/src/calls/toggleAdmin.ts
diff --git a/build/src/src/openvpn/admin.ts b/build/src/src/openvpn/admin.ts
diff --git a/build/src/src/openvpn/getCCD.ts b/build/src/src/openvpn/getCCD.ts
diff --git a/build/src/src/openvpn/index.ts b/build/src/src/openvpn/index.ts
@@ -1,6 +1,4 @@
-export * from "./admin";
 export * from "./buildClient";
-export * from "./getCCD";
 export * from "./getClient";
 export * from "./getUserList";
 export * from "./openvpnBinary";
diff --git a/build/src/src/params.ts b/build/src/src/params.ts
@@ -6,7 +6,6 @@ export const dappmanagerApiUrlGlobalEnvs = `${dappmanagerApiUrl}/global-envs`;
 
 // OpenVPN parameters
 export const USER_LIMIT = 500;
-export const CCD_MASK = "255.255.252.0";
 export const MAIN_ADMIN_NAME = "dappnode_admin";
 export const MASTER_ADMIN_IP = "172.33.10.1";
 export const ADMIN_IP_RANGE = ["172.33.10.2", "172.33.11.250"];
@@ -17,7 +16,6 @@ export const OPENVPN = "/etc/openvpn";
 export const OPENVPN_CCD_DIR = path.join(OPENVPN, "ccd");
 export const PKI_PATH = path.join(OPENVPN, "/pki/reqs");
 export const PROXY_ARP_PATH = "/proc/sys/net/ipv4/conf/eth0/proxy_arp";
-export const CCD_PATH = "/etc/openvpn/ccd";
 export const OPENVPN_CRED_DIR = "/usr/www/openvpn/cred";
 
 // API params
diff --git a/build/src/src/types.ts b/build/src/src/types.ts
@@ -38,15 +38,8 @@ export interface VersionData {
 
 export interface VpnDevice {
   id: string;
-  admin: boolean;
-  ip: string;
 }
 
 export interface VpnDeviceCredentials {
   url: string;
 }
-
-export interface OpenVpnCCDItem {
-  cn: string;
-  ip: string;
-}
diff --git a/build/src/src/vpncli.ts b/build/src/src/vpncli.ts
@@ -63,6 +63,15 @@ yargs
       console.log(chalk.green(`Credentials generated for ${id}:\n${url}`));
     }
   })
+  .command({
+    command: "print <id>",
+    describe: "Print config file to stdout.",
+    builder: idArg,
+    handler: async ({ id }) => {
+      const credFile = await api.getCredFile({ id });
+      console.log(credFile);
+    }
+  })
   .command({
     command: "add <id>",
     describe: "Add device.",
@@ -81,15 +90,6 @@ yargs
       console.log(chalk.green(`Removed device ${id}`));
     }
   })
-  .command({
-    command: "toggle <id>",
-    describe: "Give/remove admin rights to device.",
-    builder: idArg,
-    handler: async ({ id }) => {
-      await api.toggleAdmin({ id });
-      console.log(chalk.green(`Toggled admin status of ${id}`));
-    }
-  })
   .command({
     command: "reset <id>",
     describe: "Reset device credentials.",
diff --git a/build/src/test/calls/listDevices.test.ts b/build/src/test/calls/listDevices.test.ts
@@ -12,10 +12,10 @@ describe("Call function: listDevices", () => {
     { cn: "tom", ip: "172.33.0.2" }
   ];
   const userResult = [
-    { id: "dappnode_admin", admin: true, ip: "172.33.0.1" },
-    { id: "mobile", admin: false, ip: "" },
-    { id: "guest", admin: false, ip: "" },
-    { id: "tom", admin: true, ip: "172.33.0.2" }
+    { id: "dappnode_admin" },
+    { id: "mobile" },
+    { id: "guest" },
+    { id: "tom" }
   ];
   // sinon.replace(,));   <--- to replace an inside function
   const getUserList = sinon.stub();
diff --git a/build/src/test/calls/removeDevice.test.ts b/build/src/test/calls/removeDevice.test.ts
@@ -2,6 +2,7 @@ import "mocha";
 import { expect } from "chai";
 import sinon from "sinon";
 import proxyquire from "proxyquire";
+import { REMOVE_MAIN_ADMIN_ERROR } from "../../src/calls/removeDevice";
 
 describe("Call function: removeDevice", () => {
   // This function calls getUserList and getCCD to build
@@ -46,6 +47,6 @@ describe("Call function: removeDevice", () => {
     } catch (e) {
       error = e.message;
     }
-    expect(error).to.equal("You cannot remove an admin user");
+    expect(error).to.equal(REMOVE_MAIN_ADMIN_ERROR);
   });
 });
diff --git a/build/src/test/client.test.int.ts b/build/src/test/client.test.int.ts
