node-opcua-pki 3.0.2 → 3.1.0

package/lib/index.ts

@@ -1,28 +1,28 @@
-// ---------------------------------------------------------------------------------------------------------------------
-// node-opcua-pki
-// ---------------------------------------------------------------------------------------------------------------------
-// Copyright (c) 2014-2022 - Etienne Rossignon - etienne.rossignon (at) gadz.org
-// Copyright (c) 2022 - Sterfive.com
-// ---------------------------------------------------------------------------------------------------------------------
-//
-// This  project is licensed under the terms of the MIT license.
-//
-// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
-// documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
-// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
-// permit persons to whom the Software is furnished to do so,  subject to the following conditions:
-//
-// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
-// Software.
-//
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
-// WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
-// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-// ---------------------------------------------------------------------------------------------------------------------
-export * from "./pki/toolbox";
-export * from "./pki/certificate_authority";
-export * from "./pki/certificate_manager";
-export * from "./pki/common";
-export * from "./misc/install_prerequisite";
-export * from "./misc/subject";
+// ---------------------------------------------------------------------------------------------------------------------
+// node-opcua-pki
+// ---------------------------------------------------------------------------------------------------------------------
+// Copyright (c) 2014-2022 - Etienne Rossignon - etienne.rossignon (at) gadz.org
+// Copyright (c) 2022 - Sterfive.com
+// ---------------------------------------------------------------------------------------------------------------------
+//
+// This  project is licensed under the terms of the MIT license.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+// documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+// permit persons to whom the Software is furnished to do so,  subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+// Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+// WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+// ---------------------------------------------------------------------------------------------------------------------
+export * from "./pki/toolbox";
+export * from "./pki/certificate_authority";
+export * from "./pki/certificate_manager";
+export * from "./pki/common";
+export * from "./misc/install_prerequisite";
+export * from "./misc/subject";

package/lib/misc/applicationurn.ts

@@ -1,45 +1,45 @@
-// ---------------------------------------------------------------------------------------------------------------------
-// node-opcua-pki
-// ---------------------------------------------------------------------------------------------------------------------
-// Copyright (c) 2014-2022 - Etienne Rossignon - etienne.rossignon (at) gadz.org
-// Copyright (c) 2022 - Sterfive.com
-// ---------------------------------------------------------------------------------------------------------------------
-//
-// This  project is licensed under the terms of the MIT license.
-//
-// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
-// documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
-// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
-// permit persons to whom the Software is furnished to do so,  subject to the following conditions:
-//
-// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
-// Software.
-//
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
-// WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
-// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-// ---------------------------------------------------------------------------------------------------------------------
-import * as assert from "assert";
-import * as crypto from "crypto";
-
-export function makeApplicationUrn(hostname: string, suffix: string): string {
-
-    // beware : Openssl doesn't support urn with length greater than 64 !!
-    //          sometimes hostname length could be too long ...
-    // application urn length must not exceed 64 car. to comply with openssl
-    // see cryptoCA
-    let hostnameHash = hostname;
-    if (hostnameHash.length + 7 + suffix.length >= 64) {
-        // we need to reduce the applicationUrn side => let's take
-        // a portion of the hostname hash.
-        hostnameHash = crypto.createHash("md5")
-            .update(hostname)
-            .digest("hex")
-            .substr(0, 16);
-    }
-
-    const applicationUrn = "urn:" + hostnameHash + ":" + suffix;
-    assert(applicationUrn.length <= 64);
-    return applicationUrn;
-}
+// ---------------------------------------------------------------------------------------------------------------------
+// node-opcua-pki
+// ---------------------------------------------------------------------------------------------------------------------
+// Copyright (c) 2014-2022 - Etienne Rossignon - etienne.rossignon (at) gadz.org
+// Copyright (c) 2022 - Sterfive.com
+// ---------------------------------------------------------------------------------------------------------------------
+//
+// This  project is licensed under the terms of the MIT license.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+// documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+// permit persons to whom the Software is furnished to do so,  subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+// Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+// WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+// ---------------------------------------------------------------------------------------------------------------------
+import * as assert from "assert";
+import * as crypto from "crypto";
+
+export function makeApplicationUrn(hostname: string, suffix: string): string {
+
+    // beware : Openssl doesn't support urn with length greater than 64 !!
+    //          sometimes hostname length could be too long ...
+    // application urn length must not exceed 64 car. to comply with openssl
+    // see cryptoCA
+    let hostnameHash = hostname;
+    if (hostnameHash.length + 7 + suffix.length >= 64) {
+        // we need to reduce the applicationUrn side => let's take
+        // a portion of the hostname hash.
+        hostnameHash = crypto.createHash("md5")
+            .update(hostname)
+            .digest("hex")
+            .substr(0, 16);
+    }
+
+    const applicationUrn = "urn:" + hostnameHash + ":" + suffix;
+    assert(applicationUrn.length <= 64);
+    return applicationUrn;
+}

package/lib/misc/hostname.ts

@@ -1,89 +1,89 @@
-/**
- * @module node-opcua-hostname
- */
-import * as dns from "dns";
-import * as os from "os";
-import { promisify } from "util";
-
-function trim(str: string, length?: number): string {
-    if (!length) {
-        return str;
-    }
-    return str.substr(0, Math.min(str.length, length));
-}
-
-function fqdn(callback: (err: Error | null, fqdn?: string) => void) {
-    const uqdn = os.hostname();
-
-    dns.lookup(uqdn, { hints: dns.ADDRCONFIG }, (err1: Error | null, ip: string) => {
-        if (err1) {
-            return callback(err1);
-        }
-
-        dns.lookupService(ip, 0, (err2: Error | null, _fqdn: string) => {
-            if (err2) {
-                return callback(err2);
-            }
-            _fqdn = _fqdn.replace(".localdomain", "");
-            callback(null, _fqdn);
-        });
-    });
-}
-
-let _fullyQualifiedDomainNameInCache: string | undefined;
-
-/**
- * extract FullyQualifiedDomainName of this computer
- */
-export async function extractFullyQualifiedDomainName(): Promise<string> {
-    if (_fullyQualifiedDomainNameInCache) {
-        return _fullyQualifiedDomainNameInCache;
-    }
-    if (process.platform === "win32") {
-        // http://serverfault.com/a/73643/251863
-        const env = process.env; 
-        _fullyQualifiedDomainNameInCache =
-            env.COMPUTERNAME + (env.USERDNSDOMAIN && env.USERDNSDOMAIN!.length > 0 ? "." + env.USERDNSDOMAIN! : "");
-    } else {
-        try {
-            _fullyQualifiedDomainNameInCache = await promisify(fqdn)();
-            if (_fullyQualifiedDomainNameInCache === "localhost") {
-                throw new Error("localhost not expected");
-            }
-            if (/sethostname/.test(_fullyQualifiedDomainNameInCache as string)) {
-                throw new Error("Detecting fqdn  on windows !!!");
-            }
-        } catch (err) {
-            // fall back to old method
-            _fullyQualifiedDomainNameInCache = os.hostname();
-        }
-    }
-    return _fullyQualifiedDomainNameInCache!;
-}
-
-export async function prepareFQDN() {
-    _fullyQualifiedDomainNameInCache = await extractFullyQualifiedDomainName();
-}
-
-export function getFullyQualifiedDomainName(optional_max_length?: number) {
-    if (!_fullyQualifiedDomainNameInCache) {
-        throw new Error("FullyQualifiedDomainName computation is not completed yet");
-    }
-    return _fullyQualifiedDomainNameInCache ? trim(_fullyQualifiedDomainNameInCache, optional_max_length) : "%FQDN%";
-}
-
-export function getHostname() {
-    return os.hostname();
-}
-
-export function resolveFullyQualifiedDomainName(str: string): string {
-    if (!_fullyQualifiedDomainNameInCache) {
-        throw new Error("FullyQualifiedDomainName computation is not completed yet");
-    }
-    str = str.replace("%FQDN%", _fullyQualifiedDomainNameInCache);
-    str = str.replace("{FQDN}", _fullyQualifiedDomainNameInCache);
-    str = str.replace("{hostname}", getHostname());
-    return str;
-}
-// note : under windows ... echo %COMPUTERNAME%.%USERDNSDOMAIN%
-prepareFQDN();
+/**
+ * @module node-opcua-hostname
+ */
+import * as dns from "dns";
+import * as os from "os";
+import { promisify } from "util";
+
+function trim(str: string, length?: number): string {
+    if (!length) {
+        return str;
+    }
+    return str.substr(0, Math.min(str.length, length));
+}
+
+function fqdn(callback: (err: Error | null, fqdn?: string) => void) {
+    const uqdn = os.hostname();
+
+    dns.lookup(uqdn, { hints: dns.ADDRCONFIG }, (err1: Error | null, ip: string) => {
+        if (err1) {
+            return callback(err1);
+        }
+
+        dns.lookupService(ip, 0, (err2: Error | null, _fqdn: string) => {
+            if (err2) {
+                return callback(err2);
+            }
+            _fqdn = _fqdn.replace(".localdomain", "");
+            callback(null, _fqdn);
+        });
+    });
+}
+
+let _fullyQualifiedDomainNameInCache: string | undefined;
+
+/**
+ * extract FullyQualifiedDomainName of this computer
+ */
+export async function extractFullyQualifiedDomainName(): Promise<string> {
+    if (_fullyQualifiedDomainNameInCache) {
+        return _fullyQualifiedDomainNameInCache;
+    }
+    if (process.platform === "win32") {
+        // http://serverfault.com/a/73643/251863
+        const env = process.env; 
+        _fullyQualifiedDomainNameInCache =
+            env.COMPUTERNAME + (env.USERDNSDOMAIN && env.USERDNSDOMAIN!.length > 0 ? "." + env.USERDNSDOMAIN! : "");
+    } else {
+        try {
+            _fullyQualifiedDomainNameInCache = await promisify(fqdn)();
+            if (_fullyQualifiedDomainNameInCache === "localhost") {
+                throw new Error("localhost not expected");
+            }
+            if (/sethostname/.test(_fullyQualifiedDomainNameInCache as string)) {
+                throw new Error("Detecting fqdn  on windows !!!");
+            }
+        } catch (err) {
+            // fall back to old method
+            _fullyQualifiedDomainNameInCache = os.hostname();
+        }
+    }
+    return _fullyQualifiedDomainNameInCache!;
+}
+
+export async function prepareFQDN() {
+    _fullyQualifiedDomainNameInCache = await extractFullyQualifiedDomainName();
+}
+
+export function getFullyQualifiedDomainName(optional_max_length?: number) {
+    if (!_fullyQualifiedDomainNameInCache) {
+        throw new Error("FullyQualifiedDomainName computation is not completed yet");
+    }
+    return _fullyQualifiedDomainNameInCache ? trim(_fullyQualifiedDomainNameInCache, optional_max_length) : "%FQDN%";
+}
+
+export function getHostname() {
+    return os.hostname();
+}
+
+export function resolveFullyQualifiedDomainName(str: string): string {
+    if (!_fullyQualifiedDomainNameInCache) {
+        throw new Error("FullyQualifiedDomainName computation is not completed yet");
+    }
+    str = str.replace("%FQDN%", _fullyQualifiedDomainNameInCache);
+    str = str.replace("{FQDN}", _fullyQualifiedDomainNameInCache);
+    str = str.replace("{hostname}", getHostname());
+    return str;
+}
+// note : under windows ... echo %COMPUTERNAME%.%USERDNSDOMAIN%
+prepareFQDN();