windows node support

windows node support for smb/iscsi (csi-proxy)
better logging
support (for testing) generating volume_id from name
wait for chown/chmod jobs to complete (freenas)
general improvement to smb behavior throughout

Signed-off-by: Travis Glenn Hansen <travisghansen@yahoo.com>
This commit is contained in:
Travis Glenn Hansen
2022-04-17 10:57:57 -06:00
parent 68d0d57a99
commit 3f51f5b7a6
44 changed files with 5203 additions and 997 deletions
+257
View File
@@ -0,0 +1,257 @@
const _ = require("lodash");
const grpc = require("./grpc").grpc;
const protoLoader = require("@grpc/proto-loader");
const PROTO_BASE_PATH = __dirname + "/../../csi_proxy_proto";
/**
* leave connection null as by default the named pipe is derrived
*/
const DEFAULT_SERVICES = {
filesystem: { version: "v1", connection: null },
disk: { version: "v1", connection: null },
volume: { version: "v1", connection: null },
smb: { version: "v1", connection: null },
system: { version: "v1alpha1", connection: null },
iscsi: { version: "v1alpha2", connection: null },
};
function capitalize(s) {
return s && s[0].toUpperCase() + s.slice(1);
}
class CsiProxyClient {
constructor(options = {}) {
this.clients = {};
// initialize all clients
const services = Object.assign(
{},
DEFAULT_SERVICES,
options.services || {}
);
const pipePrefix = options.pipe_prefix || "csi-proxy";
for (const serviceName in services) {
const service = services[serviceName];
const serviceVersion =
service.version || DEFAULT_SERVICES[serviceName].version;
const serviceConnection =
service.connection ||
`\\\\.\\\\pipe\\\\${pipePrefix}-${serviceName}-${serviceVersion}`;
const PROTO_PATH = `/${PROTO_BASE_PATH}/${serviceName}/${serviceVersion}/api.proto`;
const packageDefinition = protoLoader.loadSync(PROTO_PATH, {
keepCase: true,
longs: String,
enums: String,
defaults: true,
oneofs: true,
includeDirs: [__dirname + "/../csi_proxy_proto"],
});
const protoDescriptor = grpc.loadPackageDefinition(packageDefinition);
const serviceInstance = new protoDescriptor[serviceVersion][
capitalize(serviceName)
](serviceConnection, grpc.credentials.createInsecure());
this.clients[serviceName] = serviceInstance;
}
}
async executeRPC(serviceName, methodName, options = {}) {
function rescursivePathFixer(obj) {
for (const k in obj) {
if (typeof obj[k] == "object" && obj[k] !== null) {
rescursivePathFixer(obj[k]);
} else {
if (k.includes("path")) {
obj[k] = obj[k].replaceAll("/", "\\");
}
}
}
}
rescursivePathFixer(options);
const cleansedOptions = JSON.parse(JSON.stringify(options));
// This function handles arrays and objects
function recursiveCleanse(obj) {
for (const k in obj) {
if (typeof obj[k] == "object" && obj[k] !== null) {
recursiveCleanse(obj[k]);
} else {
if (
k.includes("secret") ||
k.includes("username") ||
k.includes("password")
) {
obj[k] = "redacted";
}
}
}
}
recursiveCleanse(cleansedOptions);
console.log(
"csi-proxy request %s/%s - data: %j",
capitalize(serviceName),
methodName,
cleansedOptions
);
return new Promise((resolve, reject) => {
const functionRef = this.clients[serviceName.toLowerCase()][methodName];
if (!functionRef) {
reject(
new Error(
`missing method ${methodName} on service ${capitalize(serviceName)}`
)
);
return;
}
this.clients[serviceName.toLowerCase()][methodName](
options,
(error, data) => {
console.log(
"csi-proxy response %s/%s - error: %j, data: %j",
capitalize(serviceName),
methodName,
error,
data
);
if (error) {
reject(error);
}
resolve(data);
}
);
});
}
/**
* Returns a disk_number if the target has 0 or 1 disks
*
* @param {*} target_portal
* @param {*} iqn
* @returns
*/
async getDiskNumberFromIscsiTarget(target_portal, iqn) {
let result;
if (typeof target_portal != "object") {
target_portal = {
target_address: target_portal.split(":")[0],
target_port: target_portal.split(":")[1] || 3260,
};
}
// get device
try {
result = await this.executeRPC("iscsi", "GetTargetDisks", {
target_portal,
iqn,
});
} catch (e) {
let details = _.get(e, "details", "");
if (!details.includes("ObjectNotFound")) {
throw e;
}
}
let diskIds = _.get(result, "diskIDs", []);
if (diskIds.length > 1) {
throw new Error(
`${diskIds.length} disks on the target, no way to know which is the relevant disk`
);
}
return diskIds[0];
}
/**
* Returns a volume_id if the disk has 0 or 1 volumes
*
* @param {*} disk_number
* @returns
*/
async getVolumeIdFromDiskNumber(disk_number) {
let result;
if (disk_number == 0 || disk_number > 0) {
result = await this.executeRPC("volume", "ListVolumesOnDisk", {
disk_number,
});
let volume_ids = _.get(result, "volume_ids", []);
/**
* the 1st partition is a sort of system partion and is ""
* usually around 15MB in size
*/
volume_ids = volume_ids.filter((item) => {
return Boolean(item);
});
if (volume_ids.length > 1) {
throw new Error(
`${volume_ids.length} volumes on the disk, no way to know which is the relevant volume`
);
}
// ok of null/undefined
return volume_ids[0];
}
}
/**
* Return a volume_id if the target and disk both have 0 or 1 entries
*
* @param {*} target_portal
* @param {*} iqn
* @returns
*/
async getVolumeIdFromIscsiTarget(target_portal, iqn) {
const disk_number = await this.getDiskNumberFromIscsiTarget(...arguments);
return await this.getVolumeIdFromDiskNumber(disk_number);
}
async FilesystemPathExists(path) {
let result;
try {
result = await this.executeRPC("filesystem", "PathExists", {
path,
});
return result.exists;
} catch (e) {
let details = _.get(e, "details", "");
if (details.includes("not an absolute Windows path")) {
return false;
} else {
throw e;
}
}
}
async FilesystemIsSymlink(path) {
let result;
try {
result = await this.executeRPC("filesystem", "IsSymlink", {
path,
});
return result.is_symlink;
} catch (e) {
let details = _.get(e, "details", "");
if (details.includes("not an absolute Windows path")) {
return false;
} else {
throw e;
}
}
}
}
module.exports.CsiProxyClient = CsiProxyClient;
+7 -2
View File
@@ -1,5 +1,6 @@
const cp = require("child_process");
const fs = require("fs");
const path = require("path");
const DEFAULT_TIMEOUT = process.env.FILESYSTEM_DEFAULT_TIMEOUT || 30000;
@@ -25,6 +26,10 @@ class Filesystem {
}
}
covertUnixSeparatorToWindowsSeparator(p) {
return p.replaceAll(path.posix.sep, path.win32.sep);
}
/**
* Attempt to discover if device is a block device
*
@@ -615,12 +620,12 @@ class Filesystem {
command = filesystem.options.paths.sudo;
}
console.log("executing filesystem command: %s %s", command, args.join(" "));
return new Promise((resolve, reject) => {
const child = filesystem.options.executor.spawn(command, args, options);
let stdout = "";
let stderr = "";
child.stdout.on("data", function (data) {
stdout = stdout + data;
});
+77 -3
View File
@@ -1,4 +1,5 @@
const axios = require("axios");
const crypto = require("crypto");
function sleep(ms) {
return new Promise((resolve) => {
@@ -6,6 +7,64 @@ function sleep(ms) {
});
}
function md5(val) {
return crypto.createHash("md5").update(val).digest("hex");
}
function crc32(val) {
for (var a, o = [], c = 0; c < 256; c++) {
a = c;
for (var f = 0; f < 8; f++) a = 1 & a ? 3988292384 ^ (a >>> 1) : a >>> 1;
o[c] = a;
}
for (var n = -1, t = 0; t < val.length; t++)
n = (n >>> 8) ^ o[255 & (n ^ val.charCodeAt(t))];
return (-1 ^ n) >>> 0;
}
const crctab16 = new Uint16Array([
0x0000, 0x1189, 0x2312, 0x329b, 0x4624, 0x57ad, 0x6536, 0x74bf, 0x8c48,
0x9dc1, 0xaf5a, 0xbed3, 0xca6c, 0xdbe5, 0xe97e, 0xf8f7, 0x1081, 0x0108,
0x3393, 0x221a, 0x56a5, 0x472c, 0x75b7, 0x643e, 0x9cc9, 0x8d40, 0xbfdb,
0xae52, 0xdaed, 0xcb64, 0xf9ff, 0xe876, 0x2102, 0x308b, 0x0210, 0x1399,
0x6726, 0x76af, 0x4434, 0x55bd, 0xad4a, 0xbcc3, 0x8e58, 0x9fd1, 0xeb6e,
0xfae7, 0xc87c, 0xd9f5, 0x3183, 0x200a, 0x1291, 0x0318, 0x77a7, 0x662e,
0x54b5, 0x453c, 0xbdcb, 0xac42, 0x9ed9, 0x8f50, 0xfbef, 0xea66, 0xd8fd,
0xc974, 0x4204, 0x538d, 0x6116, 0x709f, 0x0420, 0x15a9, 0x2732, 0x36bb,
0xce4c, 0xdfc5, 0xed5e, 0xfcd7, 0x8868, 0x99e1, 0xab7a, 0xbaf3, 0x5285,
0x430c, 0x7197, 0x601e, 0x14a1, 0x0528, 0x37b3, 0x263a, 0xdecd, 0xcf44,
0xfddf, 0xec56, 0x98e9, 0x8960, 0xbbfb, 0xaa72, 0x6306, 0x728f, 0x4014,
0x519d, 0x2522, 0x34ab, 0x0630, 0x17b9, 0xef4e, 0xfec7, 0xcc5c, 0xddd5,
0xa96a, 0xb8e3, 0x8a78, 0x9bf1, 0x7387, 0x620e, 0x5095, 0x411c, 0x35a3,
0x242a, 0x16b1, 0x0738, 0xffcf, 0xee46, 0xdcdd, 0xcd54, 0xb9eb, 0xa862,
0x9af9, 0x8b70, 0x8408, 0x9581, 0xa71a, 0xb693, 0xc22c, 0xd3a5, 0xe13e,
0xf0b7, 0x0840, 0x19c9, 0x2b52, 0x3adb, 0x4e64, 0x5fed, 0x6d76, 0x7cff,
0x9489, 0x8500, 0xb79b, 0xa612, 0xd2ad, 0xc324, 0xf1bf, 0xe036, 0x18c1,
0x0948, 0x3bd3, 0x2a5a, 0x5ee5, 0x4f6c, 0x7df7, 0x6c7e, 0xa50a, 0xb483,
0x8618, 0x9791, 0xe32e, 0xf2a7, 0xc03c, 0xd1b5, 0x2942, 0x38cb, 0x0a50,
0x1bd9, 0x6f66, 0x7eef, 0x4c74, 0x5dfd, 0xb58b, 0xa402, 0x9699, 0x8710,
0xf3af, 0xe226, 0xd0bd, 0xc134, 0x39c3, 0x284a, 0x1ad1, 0x0b58, 0x7fe7,
0x6e6e, 0x5cf5, 0x4d7c, 0xc60c, 0xd785, 0xe51e, 0xf497, 0x8028, 0x91a1,
0xa33a, 0xb2b3, 0x4a44, 0x5bcd, 0x6956, 0x78df, 0x0c60, 0x1de9, 0x2f72,
0x3efb, 0xd68d, 0xc704, 0xf59f, 0xe416, 0x90a9, 0x8120, 0xb3bb, 0xa232,
0x5ac5, 0x4b4c, 0x79d7, 0x685e, 0x1ce1, 0x0d68, 0x3ff3, 0x2e7a, 0xe70e,
0xf687, 0xc41c, 0xd595, 0xa12a, 0xb0a3, 0x8238, 0x93b1, 0x6b46, 0x7acf,
0x4854, 0x59dd, 0x2d62, 0x3ceb, 0x0e70, 0x1ff9, 0xf78f, 0xe606, 0xd49d,
0xc514, 0xb1ab, 0xa022, 0x92b9, 0x8330, 0x7bc7, 0x6a4e, 0x58d5, 0x495c,
0x3de3, 0x2c6a, 0x1ef1, 0x0f78,
]);
// calculate the 16-bit CRC of data with predetermined length.
function crc16(data) {
var res = 0x0ffff;
for (let b of data) {
res = ((res >> 8) & 0x0ff) ^ crctab16[(res ^ b) & 0xff];
}
return ~res & 0x0ffff;
}
function lockKeysFromRequest(call, serviceMethodName) {
switch (serviceMethodName) {
// controller
@@ -55,9 +114,9 @@ function getLargestNumber() {
/**
* transition function to replicate `request` style requests using axios
*
* @param {*} options
* @param {*} callback
*
* @param {*} options
* @param {*} callback
*/
function axios_request(options, callback = function () {}) {
function prep_response(res) {
@@ -110,8 +169,23 @@ function stringify(value) {
return JSON.stringify(value, getCircularReplacer());
}
function default_supported_block_filesystems() {
return ["btrfs", "ext3", "ext4", "ext4dev", "xfs", "ntfs"];
}
function default_supported_file_filesystems() {
return ["nfs", "cifs"];
}
module.exports.sleep = sleep;
module.exports.md5 = md5;
module.exports.crc32 = crc32;
module.exports.crc16 = crc16;
module.exports.lockKeysFromRequest = lockKeysFromRequest;
module.exports.getLargestNumber = getLargestNumber;
module.exports.stringify = stringify;
module.exports.axios_request = axios_request;
module.exports.default_supported_block_filesystems =
default_supported_block_filesystems;
module.exports.default_supported_file_filesystems =
default_supported_file_filesystems;