node-opcua-pki 6.21.0 → 6.22.1

package/dist/bin/pki.mjs

@@ -93,6 +93,9 @@ var init_hostname = __esm({
 
 // packages/node-opcua-pki/lib/toolbox/common.ts
 import assert2 from "assert";
+function isOpaqueSigner(privateKey) {
+  return typeof privateKey !== "string" && typeof privateKey.sign === "function";
+}
 async function resolvePrivateKeyPassphrase(passphrase) {
   if (passphrase === void 0) {
     return void 0;
@@ -276,8 +279,9 @@ async function createCertificateSigningRequestAsync(certificateSigningRequestFil
   assert4(typeof certificateSigningRequestFilename === "string");
   const subject = params.subject ? new Subject(params.subject).toString() : void 0;
   displaySubtitle("- Creating a Certificate Signing Request with subtile");
-  const privateKeyPem = typeof params.privateKey === "string" ? await fs2.promises.readFile(params.privateKey, "utf-8") : coercePrivateKeyPem(params.privateKey);
-  const privateKey = await pemToPrivateKey(privateKeyPem);
+  const privateKey = isOpaqueSigner(params.privateKey) ? params.privateKey : await pemToPrivateKey(
+    typeof params.privateKey === "string" ? await fs2.promises.readFile(params.privateKey, "utf-8") : coercePrivateKeyPem(params.privateKey)
+  );
   const { csr } = await createCertificateSigningRequest({
     privateKey,
     dns: params.dns,
@@ -287,13 +291,16 @@ async function createCertificateSigningRequestAsync(certificateSigningRequestFil
     purpose: params.purpose
   });
   await fs2.promises.writeFile(certificateSigningRequestFilename, csr, "utf-8");
-  display(`- privateKey ${typeof params.privateKey === "string" ? params.privateKey : "<in-memory>"}`);
+  display(
+    `- privateKey ${typeof params.privateKey === "string" ? params.privateKey : isOpaqueSigner(params.privateKey) ? "<opaque-signer>" : "<in-memory>"}`
+  );
   display(`- certificateSigningRequestFilename ${certificateSigningRequestFilename}`);
 }
 var init_create_certificate_signing_request = __esm({
   "packages/node-opcua-pki/lib/toolbox/without_openssl/create_certificate_signing_request.ts"() {
     "use strict";
     init_esm_shims();
+    init_common();
     init_display();
   }
 });
@@ -327,8 +334,9 @@ async function createSelfSignedCertificateAsync(certificate, params) {
   subject = subject.toString();
   const purpose = params.purpose;
   displayTitle("Generate a certificate request");
-  const privateKeyPem = typeof params.privateKey === "string" ? await fs3.promises.readFile(params.privateKey, "utf-8") : coercePrivateKeyPem2(params.privateKey);
-  const privateKey = await pemToPrivateKey2(privateKeyPem);
+  const privateKey = isOpaqueSigner(params.privateKey) ? params.privateKey : await pemToPrivateKey2(
+    typeof params.privateKey === "string" ? await fs3.promises.readFile(params.privateKey, "utf-8") : coercePrivateKeyPem2(params.privateKey)
+  );
   const { cert } = await createSelfSignedCertificate1({
     privateKey,
     notBefore: params.startDate,
@@ -383,11 +391,14 @@ import { drainPendingLocks, withLock } from "@ster5/global-mutex";
 import chalk3 from "chalk";
 import chokidar from "chokidar";
 import {
+  caSignerFromKeyOperations,
   exploreCertificate,
   exploreCertificateInfo,
   exploreCertificateRevocationList,
   generatePrivateKeyFile,
+  keyOperationsFromPrivateKey,
   makeSHA1Thumbprint,
+  PrivateKeyUnavailableError,
   readCertificateChain,
   readCertificateChainAsync,
   readCertificateRevocationList,
@@ -419,17 +430,30 @@ function makeFingerprint(certificate) {
 function short(stringToShorten) {
   return stringToShorten.substring(0, 10);
 }
+function toFilenameLabel(commonName) {
+  const label = (commonName || "").normalize("NFKC").replace(disallowedInLabel, "_").replace(/[^\x20-\x7E]/g, "").slice(0, 64).trim();
+  return label || "certificate";
+}
 function buildIdealCertificateName(certificate) {
   const chain = coerceCertificateChain(certificate);
   const fingerprint2 = makeFingerprint(chain);
   try {
     const commonName = exploreCertificate(chain[0]).tbsCertificate.subject.commonName || "";
-    const sanitizedCommonName = commonName.replace(forbiddenChars, "_");
+    const sanitizedCommonName = toFilenameLabel(commonName);
     return `${sanitizedCommonName}[${fingerprint2}]`;
   } catch (_err) {
     return `invalid_certificate_[${fingerprint2}]`;
   }
 }
+function safeStoreJoin(folder, filename) {
+  const full = path2.resolve(folder, filename);
+  const base = path2.resolve(folder);
+  if (full !== base && !full.startsWith(base + path2.sep)) {
+    warningLog("refusing to write certificate outside its store folder:", filename);
+    throw new Error(`certificate filename escapes its store folder: ${filename}`);
+  }
+  return full;
+}
 function findMatchingIssuerKey(entries, wantedIssuerKey) {
   return entries.filter((entry) => {
     const info = getOrComputeInfo(entry);
@@ -491,7 +515,7 @@ function findIssuerCertificateInChain(certificate, chain) {
   }
   return null;
 }
-var configurationFileSimpleTemplate, fsWriteFile, forbiddenChars, ChainCompletionStatus, CertificateManager;
+var configurationFileSimpleTemplate, fsWriteFile, disallowedInLabel, ChainCompletionStatus, CertificateManager;
 var init_certificate_manager = __esm({
   "packages/node-opcua-pki/lib/pki/certificate_manager.ts"() {
     "use strict";
@@ -503,7 +527,7 @@ var init_certificate_manager = __esm({
     init_simple_config_template_cnf();
     configurationFileSimpleTemplate = simple_config_template_cnf_default;
     fsWriteFile = fs4.promises.writeFile;
-    forbiddenChars = /[\x00-\x1F<>:"/\\|?*]/g;
+    disallowedInLabel = /[^A-Za-z0-9._ -]/g;
     ChainCompletionStatus = /* @__PURE__ */ ((ChainCompletionStatus2) => {
       ChainCompletionStatus2["AlreadyComplete"] = "AlreadyComplete";
       ChainCompletionStatus2["ChainCompleted"] = "ChainCompleted";
@@ -640,6 +664,9 @@ var init_certificate_manager = __esm({
       #disableFileWatchers;
       #privateKeyPassphrase;
       #privateKeyProvider;
+      #keyOperations;
+      /** The stable lazy wrap handed out by {@link getKeyOperations} for non-opaque configurations. */
+      #lazyLocalKeyOperations;
       /**
        * The on-disk key, decrypted once and kept for the instance's lifetime,
        * so the passphrase (or its resolver function) is consulted at most
@@ -683,6 +710,17 @@ var init_certificate_manager = __esm({
         this.#disableFileWatchers = options.disableFileWatchers ?? process.env.OPCUA_PKI_DISABLE_FILE_WATCHERS === "true";
         this.#privateKeyPassphrase = options.privateKeyPassphrase;
         this.#privateKeyProvider = options.privateKeyProvider;
+        this.#keyOperations = options.keyOperations;
+        if (this.#keyOperations && this.#privateKeyProvider) {
+          throw new Error(
+            "CertificateManager: 'keyOperations' and 'privateKeyProvider' are mutually exclusive: one hides the key, the other sources its material"
+          );
+        }
+        if (this.#keyOperations && this.#privateKeyPassphrase) {
+          throw new Error(
+            "CertificateManager: 'privateKeyPassphrase' is meaningless with 'keyOperations': there is no key material for a passphrase to protect"
+          );
+        }
         mkdirRecursiveSync(options.location);
         if (!fs4.existsSync(this.#location)) {
           throw new Error(`CertificateManager cannot access location ${this.#location}`);
@@ -724,6 +762,11 @@ var init_certificate_manager = __esm({
        * authority on what the current key is.
        */
       async getPrivateKey() {
+        if (this.#keyOperations) {
+          throw new PrivateKeyUnavailableError(
+            "CertificateManager.getPrivateKey is not available when keyOperations is configured: the private key is held by the key-operations provider (HSM/KMS) and cannot be read \u2014 use getKeyOperations() instead"
+          );
+        }
         if (this.#privateKeyProvider) {
           return await this.#privateKeyProvider.getPrivateKey();
         }
@@ -749,6 +792,75 @@ var init_certificate_manager = __esm({
       }
       /** In-flight first read of the on-disk key, so concurrent callers share one passphrase resolution. */
       #privateKeyPromise;
+      /**
+       * True when this manager's key is opaque — configured through
+       * `keyOperations`, held by an HSM/KMS, never obtainable as material.
+       * When true, {@link getPrivateKey} throws `PrivateKeyUnavailableError`
+       * and {@link getKeyOperations} is the only way to use the key.
+       */
+      isPrivateKeyOpaque() {
+        return !!this.#keyOperations;
+      }
+      /**
+       * The key as an opaque {@link IKeyOperations} — the recommended way to
+       * *use* the private key regardless of where it lives.
+       *
+       * Returns the configured `keyOperations` object when the key is opaque.
+       * Otherwise returns a stable lazy wrap over {@link getPrivateKey}: its
+       * methods resolve the key on first use (disk read, passphrase,
+       * `privateKeyProvider` — all async), so the wrap offers no synchronous
+       * fast path; callers that need one resolve the key themselves and build
+       * a `LocalKeyOperations` over it. The wrap follows key rotation: a
+       * `privateKeyProvider` that starts returning a different key gets a
+       * fresh underlying `LocalKeyOperations`.
+       */
+      getKeyOperations() {
+        if (this.#keyOperations) {
+          return this.#keyOperations;
+        }
+        if (!this.#lazyLocalKeyOperations) {
+          let cached;
+          const resolve = async () => {
+            const key = await this.getPrivateKey();
+            if (!cached || cached.key !== key) {
+              cached = { key, ops: keyOperationsFromPrivateKey(key) };
+            }
+            return cached.ops;
+          };
+          this.#lazyLocalKeyOperations = {
+            sign: async (data, params) => (await resolve()).sign(data, params),
+            decryptBlock: async (block, params) => (await resolve()).decryptBlock(block, params),
+            getKeyMetadata: async () => (await resolve()).getKeyMetadata(),
+            getPublicKey: async () => (await resolve()).getPublicKey()
+          };
+        }
+        return this.#lazyLocalKeyOperations;
+      }
+      /**
+       * Fail closed at `initialize()` time, not on the first certificate
+       * operation, if the key cannot actually be used: wrong/missing
+       * passphrase on an encrypted key, a broken `privateKeyProvider`, or an
+       * unreachable `keyOperations` provider (probed via `getKeyMetadata`).
+       */
+      async #probePrivateKey() {
+        if (this.#keyOperations) {
+          await this.#keyOperations.getKeyMetadata();
+          return;
+        }
+        await this.getPrivateKey();
+      }
+      /**
+       * The key to hand to a certificate-issuance primitive: the raw
+       * {@link PrivateKey} for a local configuration, or a {@link CaSigner}
+       * adapted from `keyOperations` when the key is opaque — which requires
+       * the provider to implement `getPublicKey` (the adapter says so if not).
+       */
+      async #resolveSigningKey() {
+        if (this.#keyOperations) {
+          return caSignerFromKeyOperations(this.#keyOperations);
+        }
+        return await this.getPrivateKey();
+      }
       /**
        * Enable, disable, or rotate the passphrase protecting the on-disk
        * private key: decrypt with `oldPassphrase` (omit if the key is
@@ -770,6 +882,11 @@ var init_certificate_manager = __esm({
        * disk file for this method to rewrite).
        */
       async reencryptPrivateKey(oldPassphrase, newPassphrase) {
+        if (this.#keyOperations) {
+          throw new PrivateKeyUnavailableError(
+            "reencryptPrivateKey: not supported when keyOperations is configured \u2014 there is no key material to rewrite"
+          );
+        }
         if (this.#privateKeyProvider) {
           throw new Error("reencryptPrivateKey: not supported when a privateKeyProvider is configured");
         }
@@ -895,7 +1012,7 @@ var init_certificate_manager = __esm({
             } catch (_err) {
               return "BadCertificateInvalid";
             }
-            const filename = path2.join(this.rejectedFolder, `${buildIdealCertificateName(leafCertificate)}.pem`);
+            const filename = safeStoreJoin(this.rejectedFolder, `${buildIdealCertificateName(leafCertificate)}.pem`);
             debugLog("certificate has never been seen before and is now rejected (untrusted) ", filename);
             await fsWriteFile(filename, toPem(chain, "CERTIFICATE"));
             this.#thumbs.rejected.set(fingerprint2, { certificate: leafCertificate, filename });
@@ -1118,7 +1235,7 @@ var init_certificate_manager = __esm({
         mkdirRecursiveSync(path2.join(pkiDir, "issuers"));
         mkdirRecursiveSync(path2.join(pkiDir, "issuers/certs"));
         mkdirRecursiveSync(path2.join(pkiDir, "issuers/crl"));
-        const ownsDiskKey = !this.#privateKeyProvider;
+        const ownsDiskKey = !this.#privateKeyProvider && !this.#keyOperations;
         const needsKeyGeneration = ownsDiskKey && !fs4.existsSync(this.privateKey);
         const needsKeyEncryption = ownsDiskKey && !needsKeyGeneration && this.#privateKeyPassphrase !== void 0 && !isEncryptedPrivateKeyFile(this.privateKey);
         if (!fs4.existsSync(this.configFile) || needsKeyGeneration || needsKeyEncryption) {
@@ -1144,14 +1261,14 @@ var init_certificate_manager = __esm({
             if (ownsDiskKey) {
               restrictPrivateFilePermissions(this.privateKey, 384);
             }
-            await this.getPrivateKey();
+            await this.#probePrivateKey();
             await this.#readCertificates();
           });
         } else {
           if (ownsDiskKey) {
             restrictPrivateFilePermissions(this.privateKey, 384);
           }
-          await this.getPrivateKey();
+          await this.#probePrivateKey();
           await this.#readCertificates();
         }
       }
@@ -1236,7 +1353,7 @@ var init_certificate_manager = __esm({
         if (typeof params.applicationUri !== "string") {
           throw new Error("createSelfSignedCertificate: expecting applicationUri to be a string");
         }
-        if (!this.#privateKeyProvider && !fs4.existsSync(this.privateKey)) {
+        if (!this.#privateKeyProvider && !this.#keyOperations && !fs4.existsSync(this.privateKey)) {
           throw new Error(`Cannot find private key ${this.privateKey}`);
         }
         let certificateFilename = path2.join(this.rootDir, "own/certs/self_signed_certificate.pem");
@@ -1245,7 +1362,7 @@ var init_certificate_manager = __esm({
           ...params,
           rootDir: this.rootDir,
           configFile: this.configFile,
-          privateKey: await this.getPrivateKey(),
+          privateKey: await this.#resolveSigningKey(),
           subject: params.subject || "CN=FIXME"
         };
         await this.withLock2(async () => {
@@ -1273,7 +1390,7 @@ var init_certificate_manager = __esm({
           ...params,
           rootDir: path2.resolve(this.rootDir),
           configFile: path2.resolve(this.configFile),
-          privateKey: await this.getPrivateKey()
+          privateKey: await this.#resolveSigningKey()
         };
         return await this.withLock2(async () => {
           const now = /* @__PURE__ */ new Date();
@@ -1303,7 +1420,7 @@ var init_certificate_manager = __esm({
         if (this.#thumbs.issuers.certs.has(fingerprint2)) {
           return "Good" /* Good */;
         }
-        const filename = path2.join(this.issuersCertFolder, `issuer_${buildIdealCertificateName(certificate)}.pem`);
+        const filename = safeStoreJoin(this.issuersCertFolder, `issuer_${buildIdealCertificateName(certificate)}.pem`);
         await fs4.promises.writeFile(filename, pemCertificate, "ascii");
         this.#thumbs.issuers.certs.set(fingerprint2, { certificate, filename });
         if (addInTrustList) {
@@ -1762,7 +1879,7 @@ var init_certificate_manager = __esm({
           let status = await this.#checkRejectedOrTrusted(certificate);
           if (status === "unknown") {
             const pem = toPem(chain, "CERTIFICATE");
-            const filename = path2.join(this.rejectedFolder, `${buildIdealCertificateName(certificate)}.pem`);
+            const filename = safeStoreJoin(this.rejectedFolder, `${buildIdealCertificateName(certificate)}.pem`);
             await fs4.promises.writeFile(filename, pem);
             this.#thumbs.rejected.set(fingerprint2, { certificate, filename });
             status = "rejected";
@@ -1779,7 +1896,7 @@ var init_certificate_manager = __esm({
               throw new Error(`#moveCertificate: certificate ${fingerprint2.substring(0, 10)} not found in ${status} index`);
             }
             const destFolder = newStatus === "trusted" ? this.trustedFolder : this.rejectedFolder;
-            const certificateDest = path2.join(destFolder, path2.basename(srcEntry.filename));
+            const certificateDest = safeStoreJoin(destFolder, path2.basename(srcEntry.filename));
             debugLog("#moveCertificate", fingerprint2.substring(0, 10), "old name", srcEntry.filename);
             debugLog("#moveCertificate", fingerprint2.substring(0, 10), "new name", certificateDest);
             await fs4.promises.rename(srcEntry.filename, certificateDest);
@@ -2536,8 +2653,32 @@ function passinArg(passphrase = "") {
 function renderForDisplay(file, args) {
   return [file, ...args].map((a) => a === "" || /[\s"'`$\\]/.test(a) ? JSON.stringify(a) : a).join(" ");
 }
+function hasUnsafeArgChar(value) {
+  for (const ch of value) {
+    const code = ch.codePointAt(0);
+    if (code < 32 || code === 127) {
+      return true;
+    }
+    if (code < 128) {
+      continue;
+    }
+    if (/[\p{L}\p{N}\p{M}]/u.test(ch)) {
+      continue;
+    }
+    return true;
+  }
+  return false;
+}
+function checkArgs(file, args) {
+  for (const value of [file, ...args]) {
+    if (typeof value === "string" && hasUnsafeArgChar(value)) {
+      throw new Error(`execute_openssl: refusing argument with an unexpected character: ${JSON.stringify(value)}`);
+    }
+  }
+}
 async function execute2(file, args, options) {
   const from = new Error();
+  checkArgs(file, args);
   options.cwd = options.cwd || process.cwd();
   if (!g_config.silent) {
     warningLog(chalk5.cyan("                  CWD         "), options.cwd);