From d476a5721bfceed4b59a7a8884ba286c12362d39 Mon Sep 17 00:00:00 2001 From: Travis Glenn Hansen Date: Sat, 8 Apr 2023 12:19:29 -0600 Subject: [PATCH] minor improvements, better naming Signed-off-by: Travis Glenn Hansen --- CHANGELOG.md | 8 +- examples/private.yaml | 12 +- package-lock.json | 107 ++++++++++------ package.json | 1 + src/driver/controller-client-common/index.js | 21 +-- src/driver/controller-local-hostpath/index.js | 5 +- src/driver/controller-lustre-client/index.js | 4 +- src/driver/controller-nfs-client/index.js | 4 +- src/driver/controller-smb-client/index.js | 4 +- src/driver/controller-synology/index.js | 29 ++--- src/driver/controller-zfs/index.js | 9 +- src/driver/freenas/api.js | 9 +- src/driver/index.js | 120 ++++++++++++++++-- src/utils/general.js | 56 ++------ 14 files changed, 227 insertions(+), 162 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3c27e46..2937917 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,12 @@ +# v1.8.4 + +Released 2023-04-08 + +- minor improvements + # v1.8.3 -Released 2023-04-02 +Released 2023-04-05 - fix invalid `access_mode` logic (see #287) diff --git a/examples/private.yaml b/examples/private.yaml index 8d2d969..4cd9ade 100644 --- a/examples/private.yaml +++ b/examples/private.yaml @@ -8,10 +8,20 @@ _private: csi: volume: - derivedContext: + volumeContext: # driver left blank is used to auto select driver: memory # strictly to facilitate testing #driver: kubernetes + + # THIS IS UNSUPPORTED, BAD THINGS WILL HAPPEN IF NOT CONFIGURED PROPERLY + # + # note the volume length must *always* be the same for every call for the same volume by the CO + # the length must NOT execeed 128 characters + # must start with an alphanumeric character + # must only contain alphnumeric characters or `-` or `_` + idTemplate: "{{ parameters.[csi.storage.k8s.io/pvc/namespace] }}-{{ parameters.[csi.storage.k8s.io/pvc/name] }}" + + # if set, this hash is applied *after* the templating above idHash: strategy: crc16 #strategy: crc32 diff --git a/package-lock.json b/package-lock.json index a3336d2..4fff388 100644 --- a/package-lock.json +++ b/package-lock.json @@ -15,6 +15,7 @@ "async-mutex": "^0.4.0", "axios": "^1.1.3", "bunyan": "^1.8.15", + "crc": "^4.3.2", "fs-extra": "^11.1.0", "handlebars": "^4.7.7", "js-yaml": "^4.0.0", @@ -98,9 +99,9 @@ } }, "node_modules/@eslint/js": { - "version": "8.37.0", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.37.0.tgz", - "integrity": "sha512-x5vzdtOOGgFVDCUs81QRB2+liax8rFg3+7hqM+QhBG0/G3F1ZsoYl97UrqgHgQ9KKT7G6c4V+aTUCgu/n22v1A==", + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.38.0.tgz", + "integrity": "sha512-IoD2MfUnOV58ghIHCiil01PcohxjbYR/qCxsoC+xNgUwh1EY8jOOrYmu3d3a71+tJJ23uscEV4X2HJWMsPJu4g==", "dev": true, "engines": { "node": "^12.22.0 || ^14.17.0 || >=16.0.0" @@ -479,9 +480,9 @@ "integrity": "sha512-NmWvPnx0F1SfrQbYwOi7OeaNGokp9XhzNioJ/CSBs8Qa4vxug81mhJEAVZwxXuBmYB5KDRfMq/F3RR0BIU7sWg==" }, "node_modules/axios": { - "version": "1.3.4", - "resolved": "https://registry.npmjs.org/axios/-/axios-1.3.4.tgz", - "integrity": "sha512-toYm+Bsyl6VC5wSkfkbbNB6ROv7KY93PEBBL6xyDczaIHasAiv4wPqQ/c4RjoQzipxRD2W5g21cOqQulZ7rHwQ==", + "version": "1.3.5", + "resolved": "https://registry.npmjs.org/axios/-/axios-1.3.5.tgz", + "integrity": "sha512-glL/PvG/E+xCWwV8S6nCHcrfg1exGx7vxyUIivIA1iL7BIh6bePylCfVHwp6k13ao7SATxB6imau2kqY+I67kw==", "dependencies": { "follow-redirects": "^1.15.0", "form-data": "^4.0.0", @@ -524,9 +525,9 @@ } }, "node_modules/buildcheck": { - "version": "0.0.3", - "resolved": "https://registry.npmjs.org/buildcheck/-/buildcheck-0.0.3.tgz", - "integrity": "sha512-pziaA+p/wdVImfcbsZLNF32EiWyujlQLwolMqUQE8xpKNOH7KmZQaY8sXN7DGOEzPAElo9QTaeNRfGnf3iOJbA==", + "version": "0.0.4", + "resolved": "https://registry.npmjs.org/buildcheck/-/buildcheck-0.0.4.tgz", + "integrity": "sha512-3lROzwIR07xIL4Dan3Bj2uJ0x3XQOwRxQ3kivEyTJRevxJLR9erAWgIgmXnjTpC1eL5jPtAhmWyyPqvZEzchaA==", "optional": true, "engines": { "node": ">=10.0.0" @@ -694,19 +695,35 @@ "integrity": "sha512-3lqz5YjWTYnW6dlDa5TLaTCcShfar1e40rmcJVwCBJC6mWlFuj0eCHIElmG1g5kyuJ/GD+8Wn4FFCcz4gJPfaQ==" }, "node_modules/cpu-features": { - "version": "0.0.4", - "resolved": "https://registry.npmjs.org/cpu-features/-/cpu-features-0.0.4.tgz", - "integrity": "sha512-fKiZ/zp1mUwQbnzb9IghXtHtDoTMtNeb8oYGx6kX2SYfhnG0HNdBEBIzB9b5KlXu5DQPhfy3mInbBxFcgwAr3A==", + "version": "0.0.5", + "resolved": "https://registry.npmjs.org/cpu-features/-/cpu-features-0.0.5.tgz", + "integrity": "sha512-QgKUyYyeIKv07l2Foyclh+NcUPqR3CHybtnHpPWbnET5ENkRgZxHa39ItLcduMU09VYombm6N+7Dr/zh10w6KQ==", "hasInstallScript": true, "optional": true, "dependencies": { - "buildcheck": "0.0.3", - "nan": "^2.15.0" + "buildcheck": "0.0.4", + "nan": "^2.17.0" }, "engines": { "node": ">=10.0.0" } }, + "node_modules/crc": { + "version": "4.3.2", + "resolved": "https://registry.npmjs.org/crc/-/crc-4.3.2.tgz", + "integrity": "sha512-uGDHf4KLLh2zsHa8D8hIQ1H/HtFQhyHrc0uhHBcoKGol/Xnb+MPYfUMw7cvON6ze/GUESTudKayDcJC5HnJv1A==", + "engines": { + "node": ">=12" + }, + "peerDependencies": { + "buffer": ">=6.0.3" + }, + "peerDependenciesMeta": { + "buffer": { + "optional": true + } + } + }, "node_modules/cross-spawn": { "version": "7.0.3", "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", @@ -836,15 +853,15 @@ } }, "node_modules/eslint": { - "version": "8.37.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.37.0.tgz", - "integrity": "sha512-NU3Ps9nI05GUoVMxcZx1J8CNR6xOvUT4jAUMH5+z8lpp3aEdPVCImKw6PWG4PY+Vfkpr+jvMpxs/qoE7wq0sPw==", + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.38.0.tgz", + "integrity": "sha512-pIdsD2jwlUGf/U38Jv97t8lq6HpaU/G9NKbYmpWpZGw3LdTNhZLbJePqxOXGB5+JEKfOPU/XLxYxFh03nr1KTg==", "dev": true, "dependencies": { "@eslint-community/eslint-utils": "^4.2.0", "@eslint-community/regexpp": "^4.4.0", "@eslint/eslintrc": "^2.0.2", - "@eslint/js": "8.37.0", + "@eslint/js": "8.38.0", "@humanwhocodes/config-array": "^0.11.8", "@humanwhocodes/module-importer": "^1.0.1", "@nodelib/fs.walk": "^1.2.8", @@ -1772,9 +1789,9 @@ } }, "node_modules/oidc-token-hash": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/oidc-token-hash/-/oidc-token-hash-5.0.1.tgz", - "integrity": "sha512-EvoOtz6FIEBzE+9q253HsLCVRiK/0doEJ2HCvvqMQb3dHZrP3WlJKYtJ55CRTw4jmYomzH4wkPuCj/I3ZvpKxQ==", + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/oidc-token-hash/-/oidc-token-hash-5.0.2.tgz", + "integrity": "sha512-U91Ba78GtVBxcExLI7U+hC2AwJQqXQEW/D3fjmJC4hhSVIgdl954KO4Gu95WqAlgDKJdLATxkmuxraWLT0fVRQ==", "optional": true, "engines": { "node": "^10.13.0 || >=12.0.0" @@ -2784,9 +2801,9 @@ } }, "@eslint/js": { - "version": "8.37.0", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.37.0.tgz", - "integrity": "sha512-x5vzdtOOGgFVDCUs81QRB2+liax8rFg3+7hqM+QhBG0/G3F1ZsoYl97UrqgHgQ9KKT7G6c4V+aTUCgu/n22v1A==", + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.38.0.tgz", + "integrity": "sha512-IoD2MfUnOV58ghIHCiil01PcohxjbYR/qCxsoC+xNgUwh1EY8jOOrYmu3d3a71+tJJ23uscEV4X2HJWMsPJu4g==", "dev": true }, "@grpc/grpc-js": { @@ -3101,9 +3118,9 @@ "integrity": "sha512-NmWvPnx0F1SfrQbYwOi7OeaNGokp9XhzNioJ/CSBs8Qa4vxug81mhJEAVZwxXuBmYB5KDRfMq/F3RR0BIU7sWg==" }, "axios": { - "version": "1.3.4", - "resolved": "https://registry.npmjs.org/axios/-/axios-1.3.4.tgz", - "integrity": "sha512-toYm+Bsyl6VC5wSkfkbbNB6ROv7KY93PEBBL6xyDczaIHasAiv4wPqQ/c4RjoQzipxRD2W5g21cOqQulZ7rHwQ==", + "version": "1.3.5", + "resolved": "https://registry.npmjs.org/axios/-/axios-1.3.5.tgz", + "integrity": "sha512-glL/PvG/E+xCWwV8S6nCHcrfg1exGx7vxyUIivIA1iL7BIh6bePylCfVHwp6k13ao7SATxB6imau2kqY+I67kw==", "requires": { "follow-redirects": "^1.15.0", "form-data": "^4.0.0", @@ -3145,9 +3162,9 @@ } }, "buildcheck": { - "version": "0.0.3", - "resolved": "https://registry.npmjs.org/buildcheck/-/buildcheck-0.0.3.tgz", - "integrity": "sha512-pziaA+p/wdVImfcbsZLNF32EiWyujlQLwolMqUQE8xpKNOH7KmZQaY8sXN7DGOEzPAElo9QTaeNRfGnf3iOJbA==", + "version": "0.0.4", + "resolved": "https://registry.npmjs.org/buildcheck/-/buildcheck-0.0.4.tgz", + "integrity": "sha512-3lROzwIR07xIL4Dan3Bj2uJ0x3XQOwRxQ3kivEyTJRevxJLR9erAWgIgmXnjTpC1eL5jPtAhmWyyPqvZEzchaA==", "optional": true }, "bunyan": { @@ -3281,15 +3298,21 @@ "integrity": "sha512-3lqz5YjWTYnW6dlDa5TLaTCcShfar1e40rmcJVwCBJC6mWlFuj0eCHIElmG1g5kyuJ/GD+8Wn4FFCcz4gJPfaQ==" }, "cpu-features": { - "version": "0.0.4", - "resolved": "https://registry.npmjs.org/cpu-features/-/cpu-features-0.0.4.tgz", - "integrity": "sha512-fKiZ/zp1mUwQbnzb9IghXtHtDoTMtNeb8oYGx6kX2SYfhnG0HNdBEBIzB9b5KlXu5DQPhfy3mInbBxFcgwAr3A==", + "version": "0.0.5", + "resolved": "https://registry.npmjs.org/cpu-features/-/cpu-features-0.0.5.tgz", + "integrity": "sha512-QgKUyYyeIKv07l2Foyclh+NcUPqR3CHybtnHpPWbnET5ENkRgZxHa39ItLcduMU09VYombm6N+7Dr/zh10w6KQ==", "optional": true, "requires": { - "buildcheck": "0.0.3", - "nan": "^2.15.0" + "buildcheck": "0.0.4", + "nan": "^2.17.0" } }, + "crc": { + "version": "4.3.2", + "resolved": "https://registry.npmjs.org/crc/-/crc-4.3.2.tgz", + "integrity": "sha512-uGDHf4KLLh2zsHa8D8hIQ1H/HtFQhyHrc0uhHBcoKGol/Xnb+MPYfUMw7cvON6ze/GUESTudKayDcJC5HnJv1A==", + "requires": {} + }, "cross-spawn": { "version": "7.0.3", "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", @@ -3383,15 +3406,15 @@ "dev": true }, "eslint": { - "version": "8.37.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.37.0.tgz", - "integrity": "sha512-NU3Ps9nI05GUoVMxcZx1J8CNR6xOvUT4jAUMH5+z8lpp3aEdPVCImKw6PWG4PY+Vfkpr+jvMpxs/qoE7wq0sPw==", + "version": "8.38.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.38.0.tgz", + "integrity": "sha512-pIdsD2jwlUGf/U38Jv97t8lq6HpaU/G9NKbYmpWpZGw3LdTNhZLbJePqxOXGB5+JEKfOPU/XLxYxFh03nr1KTg==", "dev": true, "requires": { "@eslint-community/eslint-utils": "^4.2.0", "@eslint-community/regexpp": "^4.4.0", "@eslint/eslintrc": "^2.0.2", - "@eslint/js": "8.37.0", + "@eslint/js": "8.38.0", "@humanwhocodes/config-array": "^0.11.8", "@humanwhocodes/module-importer": "^1.0.1", "@nodelib/fs.walk": "^1.2.8", @@ -4095,9 +4118,9 @@ "optional": true }, "oidc-token-hash": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/oidc-token-hash/-/oidc-token-hash-5.0.1.tgz", - "integrity": "sha512-EvoOtz6FIEBzE+9q253HsLCVRiK/0doEJ2HCvvqMQb3dHZrP3WlJKYtJ55CRTw4jmYomzH4wkPuCj/I3ZvpKxQ==", + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/oidc-token-hash/-/oidc-token-hash-5.0.2.tgz", + "integrity": "sha512-U91Ba78GtVBxcExLI7U+hC2AwJQqXQEW/D3fjmJC4hhSVIgdl954KO4Gu95WqAlgDKJdLATxkmuxraWLT0fVRQ==", "optional": true }, "once": { diff --git a/package.json b/package.json index 77ce2b3..87906fc 100644 --- a/package.json +++ b/package.json @@ -24,6 +24,7 @@ "async-mutex": "^0.4.0", "axios": "^1.1.3", "bunyan": "^1.8.15", + "crc": "^4.3.2", "fs-extra": "^11.1.0", "handlebars": "^4.7.7", "js-yaml": "^4.0.0", diff --git a/src/driver/controller-client-common/index.js b/src/driver/controller-client-common/index.js index 0279faa..d12dd03 100644 --- a/src/driver/controller-client-common/index.js +++ b/src/driver/controller-client-common/index.js @@ -443,16 +443,9 @@ class ControllerClientCommonDriver extends CsiBaseDriver { const driver = this; let config_key = this.getConfigKey(); - let name = call.request.name; + let volume_id = await driver.getVolumeIdFromCall(call); let volume_content_source = call.request.volume_content_source; - if (!name) { - throw new GrpcError( - grpc.status.INVALID_ARGUMENT, - `volume name is required` - ); - } - if ( call.request.volume_capabilities && call.request.volume_capabilities.length > 0 @@ -513,7 +506,7 @@ class ControllerClientCommonDriver extends CsiBaseDriver { ); } - const volume_path = driver.getControllerVolumePath(name); + const volume_path = driver.getControllerVolumePath(volume_id); let response; let source_path; @@ -596,7 +589,7 @@ class ControllerClientCommonDriver extends CsiBaseDriver { } } - let volume_context = driver.getVolumeContext(name); + let volume_context = driver.getVolumeContext(volume_id); volume_context["provisioner_driver"] = driver.options.driver; if (driver.options.instance_id) { @@ -611,7 +604,7 @@ class ControllerClientCommonDriver extends CsiBaseDriver { const res = { volume: { - volume_id: name, + volume_id, //capacity_bytes: capacity_bytes, // kubernetes currently pukes if capacity is returned as 0 capacity_bytes: 0, content_source: volume_content_source, @@ -634,16 +627,16 @@ class ControllerClientCommonDriver extends CsiBaseDriver { async DeleteVolume(call) { const driver = this; - let name = call.request.volume_id; + let volume_id = call.request.volume_id; - if (!name) { + if (!volume_id) { throw new GrpcError( grpc.status.INVALID_ARGUMENT, `volume_id is required` ); } - const volume_path = driver.getControllerVolumePath(name); + const volume_path = driver.getControllerVolumePath(volume_id); await driver.deleteDir(volume_path); return {}; diff --git a/src/driver/controller-local-hostpath/index.js b/src/driver/controller-local-hostpath/index.js index e27734f..a838cac 100644 --- a/src/driver/controller-local-hostpath/index.js +++ b/src/driver/controller-local-hostpath/index.js @@ -44,12 +44,11 @@ class ControllerLocalHostpathDriver extends ControllerClientCommonDriver { return "local-hostpath"; } - getVolumeContext(name) { + getVolumeContext(volume_id) { const driver = this; - const config_key = driver.getConfigKey(); return { node_attach_driver: "hostpath", - path: driver.getShareVolumePath(name), + path: driver.getShareVolumePath(volume_id), }; } diff --git a/src/driver/controller-lustre-client/index.js b/src/driver/controller-lustre-client/index.js index 18914a8..f504f2a 100644 --- a/src/driver/controller-lustre-client/index.js +++ b/src/driver/controller-lustre-client/index.js @@ -13,13 +13,13 @@ class ControllerLustreClientDriver extends ControllerClientCommonDriver { return "lustre"; } - getVolumeContext(name) { + getVolumeContext(volume_id) { const driver = this; const config_key = driver.getConfigKey(); return { node_attach_driver: "lustre", server: this.options[config_key].shareHost, - share: driver.getShareVolumePath(name), + share: driver.getShareVolumePath(volume_id), }; } diff --git a/src/driver/controller-nfs-client/index.js b/src/driver/controller-nfs-client/index.js index eb17efb..13afff0 100644 --- a/src/driver/controller-nfs-client/index.js +++ b/src/driver/controller-nfs-client/index.js @@ -13,13 +13,13 @@ class ControllerNfsClientDriver extends ControllerClientCommonDriver { return "nfs"; } - getVolumeContext(name) { + getVolumeContext(volume_id) { const driver = this; const config_key = driver.getConfigKey(); return { node_attach_driver: "nfs", server: this.options[config_key].shareHost, - share: driver.getShareVolumePath(name), + share: driver.getShareVolumePath(volume_id), }; } diff --git a/src/driver/controller-smb-client/index.js b/src/driver/controller-smb-client/index.js index e521c31..1d9a1ad 100644 --- a/src/driver/controller-smb-client/index.js +++ b/src/driver/controller-smb-client/index.js @@ -13,13 +13,13 @@ class ControllerSmbClientDriver extends ControllerClientCommonDriver { return "smb"; } - getVolumeContext(name) { + getVolumeContext(volume_id) { const driver = this; const config_key = driver.getConfigKey(); return { node_attach_driver: "smb", server: this.options[config_key].shareHost, - share: driver.stripLeadingSlash(driver.getShareVolumePath(name)), + share: driver.stripLeadingSlash(driver.getShareVolumePath(volume_id)), }; } diff --git a/src/driver/controller-synology/index.js b/src/driver/controller-synology/index.js index 6e3542a..6c261d9 100644 --- a/src/driver/controller-synology/index.js +++ b/src/driver/controller-synology/index.js @@ -176,8 +176,8 @@ class ControllerSynologyDriver extends CsiBaseDriver { } } - buildIscsiName(name) { - let iscsiName = name; + buildIscsiName(volume_id) { + let iscsiName = volume_id; if (this.options.iscsi.namePrefix) { iscsiName = this.options.iscsi.namePrefix + iscsiName; } @@ -324,16 +324,9 @@ class ControllerSynologyDriver extends CsiBaseDriver { const driver = this; const httpClient = await driver.getHttpClient(); - let name = call.request.name; + let volume_id = await driver.getVolumeIdFromCall(call); let volume_content_source = call.request.volume_content_source; - if (!name) { - throw new GrpcError( - grpc.status.INVALID_ARGUMENT, - `volume name is required` - ); - } - if ( call.request.volume_capabilities && call.request.volume_capabilities.length > 0 @@ -414,7 +407,7 @@ class ControllerSynologyDriver extends CsiBaseDriver { ); break; case "iscsi": - let iscsiName = driver.buildIscsiName(name); + let iscsiName = driver.buildIscsiName(volume_id); let lunTemplate; let targetTemplate; let data; @@ -670,7 +663,7 @@ class ControllerSynologyDriver extends CsiBaseDriver { const res = { volume: { - volume_id: name, + volume_id, capacity_bytes, // kubernetes currently pukes if capacity is returned as 0 content_source: volume_content_source, volume_context, @@ -689,9 +682,9 @@ class ControllerSynologyDriver extends CsiBaseDriver { const driver = this; const httpClient = await driver.getHttpClient(); - let name = call.request.volume_id; + let volume_id = call.request.volume_id; - if (!name) { + if (!volume_id) { throw new GrpcError( grpc.status.INVALID_ARGUMENT, `volume_id is required` @@ -718,7 +711,7 @@ class ControllerSynologyDriver extends CsiBaseDriver { case "iscsi": //await httpClient.DeleteAllLuns(); - let iscsiName = driver.buildIscsiName(name); + let iscsiName = driver.buildIscsiName(volume_id); let iqn = driver.options.iscsi.baseiqn + iscsiName; let target = await httpClient.GetTargetByIQN(iqn); @@ -786,9 +779,9 @@ class ControllerSynologyDriver extends CsiBaseDriver { const driver = this; const httpClient = await driver.getHttpClient(); - let name = call.request.volume_id; + let volume_id = call.request.volume_id; - if (!name) { + if (!volume_id) { throw new GrpcError( grpc.status.INVALID_ARGUMENT, `volume_id is required` @@ -850,7 +843,7 @@ class ControllerSynologyDriver extends CsiBaseDriver { break; case "iscsi": node_expansion_required = true; - let iscsiName = driver.buildIscsiName(name); + let iscsiName = driver.buildIscsiName(volume_id); response = await httpClient.GetLunUUIDByName(iscsiName); await httpClient.ExpandISCSILun(response, capacity_bytes); diff --git a/src/driver/controller-zfs/index.js b/src/driver/controller-zfs/index.js index 1747b5a..1fca665 100644 --- a/src/driver/controller-zfs/index.js +++ b/src/driver/controller-zfs/index.js @@ -644,7 +644,7 @@ class ControllerZfsBaseDriver extends CsiBaseDriver { let snapshotParentDatasetName = this.getDetachedSnapshotParentDatasetName(); let zvolBlocksize = this.options.zfs.zvolBlocksize || "16K"; let name = call.request.name; - let volume_id = await driver.getVolumeIdFromName(name); + let volume_id = await driver.getVolumeIdFromCall(call); let volume_content_source = call.request.volume_content_source; if (!datasetParentName) { @@ -654,13 +654,6 @@ class ControllerZfsBaseDriver extends CsiBaseDriver { ); } - if (!name) { - throw new GrpcError( - grpc.status.INVALID_ARGUMENT, - `volume name is required` - ); - } - if ( call.request.volume_capabilities && call.request.volume_capabilities.length > 0 diff --git a/src/driver/freenas/api.js b/src/driver/freenas/api.js index b1e610e..d87c098 100644 --- a/src/driver/freenas/api.js +++ b/src/driver/freenas/api.js @@ -2207,7 +2207,7 @@ class FreeNASApiDriver extends CsiBaseDriver { let snapshotParentDatasetName = this.getDetachedSnapshotParentDatasetName(); let zvolBlocksize = this.options.zfs.zvolBlocksize || "16K"; let name = call.request.name; - let volume_id = await driver.getVolumeIdFromName(name); + let volume_id = await driver.getVolumeIdFromCall(call); let volume_content_source = call.request.volume_content_source; let minimum_volume_size = await driver.getMinimumVolumeSize(); let default_required_bytes = 1073741824; @@ -2219,13 +2219,6 @@ class FreeNASApiDriver extends CsiBaseDriver { ); } - if (!name) { - throw new GrpcError( - grpc.status.INVALID_ARGUMENT, - `volume name is required` - ); - } - if ( call.request.volume_capabilities && call.request.volume_capabilities.length > 0 diff --git a/src/driver/index.js b/src/driver/index.js index 7edf891..bac0290 100644 --- a/src/driver/index.js +++ b/src/driver/index.js @@ -5,6 +5,7 @@ const fs = require("fs"); const CsiProxyClient = require("../utils/csi_proxy_client").CsiProxyClient; const k8s = require("@kubernetes/client-node"); const { GrpcError, grpc } = require("../utils/grpc"); +const Handlebars = require("handlebars"); const { Mount } = require("../utils/mount"); const { OneClient } = require("../utils/oneclient"); const { Filesystem } = require("../utils/filesystem"); @@ -14,7 +15,6 @@ const registry = require("../utils/registry"); const semver = require("semver"); const GeneralUtils = require("../utils/general"); const { Zetabyte } = require("../utils/zfs"); -const { transport } = require("winston"); const __REGISTRY_NS__ = "CsiBaseDriver"; @@ -366,26 +366,120 @@ class CsiBaseDriver { * the value of `volume_id` to play nicely with scenarios that do not support * long names (ie: smb share, etc) * - * @param {*} name + * per csi, strings have a max size of 128 bytes, volume_id should NOT + * execeed this limit + * + * Any Unicode string that conforms to the length limit is allowed + * except those containing the following banned characters: + * U+0000-U+0008, U+000B, U+000C, U+000E-U+001F, U+007F-U+009F. + * (These are control characters other than commonly used whitespace.) + * + * https://github.com/container-storage-interface/spec/blob/master/spec.md#size-limits + * https://docs.oracle.com/cd/E26505_01/html/E37384/gbcpt.html + * + * @param {*} call * @returns */ - async getVolumeIdFromName(name) { + async getVolumeIdFromCall(call) { const driver = this; - const strategy = _.get( + let volume_id = call.request.name; + + if (!volume_id) { + throw new GrpcError( + grpc.status.INVALID_ARGUMENT, + `volume name is required` + ); + } + + const idTemplate = _.get( + driver.options, + "_private.csi.volume.idTemplate", + "" + ); + if (idTemplate) { + volume_id = Handlebars.compile(idTemplate)({ + name: call.request.name, + parameters: call.request.parameters, + }); + + if (!volume_id) { + throw new GrpcError( + grpc.status.INVALID_ARGUMENT, + `generated volume_id is empty, idTemplate may be invalid` + ); + } + } + + const hash_strategy = _.get( driver.options, "_private.csi.volume.idHash.strategy", "" ); - switch (strategy.toLowerCase()) { - case "md5": - return GeneralUtils.md5(name); - case "crc32": - return GeneralUtils.crc32(name); - case "crc16": - return GeneralUtils.crc16(name); - default: - return name; + + if (hash_strategy) { + switch (hash_strategy.toLowerCase()) { + case "md5": + volume_id = GeneralUtils.md5(volume_id); + break; + case "crc8": + volume_id = GeneralUtils.crc8(volume_id); + break; + case "crc16": + volume_id = GeneralUtils.crc16(volume_id); + break; + case "crc32": + volume_id = GeneralUtils.crc32(volume_id); + break; + default: + throw new GrpcError( + grpc.status.INVALID_ARGUMENT, + `unkown hash strategy: ${hash_strategy}` + ); + } } + + volume_id = String(volume_id); + + if (volume_id.length > 128) { + throw new GrpcError( + grpc.status.INVALID_ARGUMENT, + `generated volume_id '${volume_id}' is too large` + ); + } + + if (volume_id.length < 1) { + throw new GrpcError( + grpc.status.INVALID_ARGUMENT, + `generated volume_id '${volume_id}' is too small` + ); + } + + /** + * technically zfs allows `:` and `.` in addition to `_` and `-` + */ + let invalid_chars; + invalid_chars = volume_id.match(/[^a-z0-9_\-]/gi); + if (invalid_chars) { + invalid_chars = String.prototype.concat( + ...new Set(invalid_chars.join("")) + ); + throw new GrpcError( + grpc.status.INVALID_ARGUMENT, + `generated volume_id '${volume_id}' contains invalid characters: '${invalid_chars}'` + ); + } + + /** + * Dataset names must begin with an alphanumeric character. + */ + if (!/^[a-z0-9]/gi.test(volume_id)) { + throw new GrpcError( + grpc.status.INVALID_ARGUMENT, + `generated volume_id '${volume_id}' must begin with alphanumeric character` + ); + } + + return volume_id; } async GetPluginInfo(call) { diff --git a/src/utils/general.js b/src/utils/general.js index e07b7b9..ea79423 100644 --- a/src/utils/general.js +++ b/src/utils/general.js @@ -2,6 +2,7 @@ const _ = require("lodash"); const axios = require("axios"); const crypto = require("crypto"); const dns = require("dns"); +const crc = require('crc'); function sleep(ms) { return new Promise((resolve) => { @@ -24,58 +25,16 @@ 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; +function crc8(data) { + return crc.crc8(data); } -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; + return crc.crc16(data); +} - for (let b of data) { - res = ((res >> 8) & 0x0ff) ^ crctab16[(res ^ b) & 0xff]; - } - - return ~res & 0x0ffff; +function crc32(data) { + return crc.crc32(data); } function lockKeysFromRequest(call, serviceMethodName) { @@ -278,6 +237,7 @@ module.exports.sleep = sleep; module.exports.md5 = md5; module.exports.crc32 = crc32; module.exports.crc16 = crc16; +module.exports.crc8 = crc8; module.exports.lockKeysFromRequest = lockKeysFromRequest; module.exports.getLargestNumber = getLargestNumber; module.exports.stringify = stringify;