pmcf 2.1.3 → 2.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pmcf",
-  "version": "2.1.3",
+  "version": "2.3.0",
   "publishConfig": {
     "access": "public"
   },

package/src/dns-utils.mjs

@@ -1,11 +1,29 @@
-import { asArray, asIterator } from "./utils.mjs";
+import {
+  asIterator,
+  decodeIPv6,
+  encodeIPv6,
+  normalizeIPAddress
+} from "./utils.mjs";
 
 export function dnsFullName(name) {
   return name.endsWith(".") ? name : name + ".";
 }
 
 export function DNSRecord(key, type, ...values) {
-  const pad = type === "MX" ? "        " : "";
+  let pad = "";
+
+  switch (type) {
+    case "MX":
+      pad = "        ";
+      break;
+
+    case "A":
+      values[0] = normalizeIPAddress(values[0]);
+      break;
+    case "AAAA":
+      values[0] = decodeIPv6(encodeIPv6(values[0]));
+      break;
+  }
 
   values = values.map(v =>
     typeof v === "number" ? String(v).padStart(3) + pad : v
@@ -13,7 +31,7 @@ export function DNSRecord(key, type, ...values) {
 
   return {
     key,
-    toString: (maxKeyLength, ttl) =>
+    toString: (maxKeyLength = 0, ttl = "1W") =>
       `${key.padEnd(maxKeyLength, " ")} ${ttl} IN ${type.padEnd(
         5,
         " "

package/src/service.mjs

@@ -1,6 +1,6 @@
 import { Base } from "./base.mjs";
 import { addType } from "./types.mjs";
-import { asArray,isLocalhost } from "./utils.mjs";
+import { asArray, isLocalhost } from "./utils.mjs";
 import { networkAddressProperties } from "./network-support.mjs";
 import {
   DNSRecord,
@@ -11,38 +11,43 @@ import {
 import { DHCPService, DNSService, NTPService } from "./module.mjs";
 
 const ServiceTypes = {
-  ntp: { protocol: "udp", port: 123, tls: false },
-  dns: { protocol: "udp", port: 53, tls: false },
-  ldap: { protocol: "tcp", port: 389, tls: false },
-  ldaps: { protocol: "tcp", port: 636, tls: true },
-  http: { protocol: "tcp", port: 80, tls: false },
+  ntp: { endpoints: [{ protocol: "udp", port: 123, tls: false }] },
+  dns: { endpoints: [{ protocol: "udp", port: 53, tls: false }] },
+  ldap: { endpoints: [{ protocol: "tcp", port: 389, tls: false }] },
+  ldaps: { endpoints: [{ protocol: "tcp", port: 636, tls: true }] },
+  http: { endpoints: [{ protocol: "tcp", port: 80, tls: false }] },
   https: {
-    protocol: "tcp",
-    port: 443,
-    tls: true,
+    endpoints: [{ protocol: "tcp", port: 443, tls: true }],
     dnsRecord: { type: "HTTPS", parameters: { alpn: "h2" } }
   },
   http3: {
     type: "https",
-    protocol: "tcp",
-    port: 443,
-    tls: true,
+    endpoints: [{ protocol: "tcp", port: 443, tls: true }],
     dnsRecord: {
       type: "HTTPS",
       parameters: { "no-default-alpn": undefined, alpn: "h3" }
     }
   },
-  rtsp: { protocol: "tcp", port: 554, tls: false },
-  smtp: { protocol: "tcp", port: 25, tls: false, dnsRecord: { type: "MX" } },
-  ssh: { protocol: "tcp", port: 22, tls: false },
-  imap: { protocol: "tcp", port: 143, tls: false },
-  imaps: { protocol: "tcp", port: 993, tls: true },
-  dhcp: { tls: false },
-  smb: { protocol: "tcp", port: 445, tls: false },
+  rtsp: { endpoints: [{ protocol: "tcp", port: 554, tls: false }] },
+  smtp: {
+    endpoints: [{ protocol: "tcp", port: 25, tls: false }],
+    dnsRecord: { type: "MX" }
+  },
+  ssh: { endpoints: [{ protocol: "tcp", port: 22, tls: false }] },
+  imap: { endpoints: [{ protocol: "tcp", port: 143, tls: false }] },
+  imaps: { endpoints: [{ protocol: "tcp", port: 993, tls: true }] },
+  dhcp: { endpoints: [{ port: 547, tls: false }] },
+  "dhcpv6-client": {
+    endpoints: [
+      { protocol: "tcp", port: 546, tls: false },
+      { protocol: "udp", port: 546, tls: false }
+    ]
+  },
+  "dhcpv6-server": { endpoints: [{ port: 547, tls: false }] },
+  smb: { endpoints: [{ protocol: "tcp", port: 445, tls: false }] },
   timemachine: {
     type: "adisk",
-    protocol: "tcp",
-    tls: false,
+    endpoints: [{ protocol: "tcp", tls: false }],
     dnsRecord: {
       type: "TXT",
       parameters: {
@@ -86,7 +91,6 @@ export const ServiceTypeDefinition = {
     alias: { type: "string", collection: false, writeable: true },
     type: { type: "string", collection: false, writeable: true },
     weight: { type: "number", collection: false, writeable: true },
-    srvPrefix: { type: "string", collection: false, writeable: false },
     tls: { type: "string", collection: false, writeable: false },
     systemd: { type: "string", collection: true, writeable: true }
   }
@@ -145,12 +149,22 @@ export class Service extends Base {
     return this.rawAddresses.map(a => `${a}:${this.port}`);
   }
 
+  get endpoints() {
+    if (this._port !== undefined) {
+      return [
+        { protocol: this.protocol, address: this.rawAddress, port: this._port }
+      ];
+    }
+
+    return ServiceTypes[this.type]?.endpoints || [];
+  }
+
   set port(value) {
     this._port = value;
   }
 
   get port() {
-    return this._port || ServiceTypes[this.type]?.port;
+    return this._port || ServiceTypes[this.type]?.endpoints[0].port;
   }
 
   set weight(value) {
@@ -178,7 +192,7 @@ export class Service extends Base {
   }
 
   get protocol() {
-    return ServiceTypes[this.type]?.protocol;
+    return ServiceTypes[this.type]?.endpoints[0].protocol;
   }
 
   get tls() {
@@ -189,30 +203,29 @@ export class Service extends Base {
     return this._systemd;
   }
 
-  get srvPrefix() {
-    const st = ServiceTypes[this.type];
-    if (st?.protocol) {
-      return `_${st.type || this.type}._${st.protocol}`;
-    }
-  }
-
   dnsRecordsForDomainName(domainName, hasSVRRecords) {
     const records = [];
     if (this.priority <= 1 && this.alias) {
       records.push(DNSRecord(this.alias, "CNAME", dnsFullName(domainName)));
     }
 
-    if (hasSVRRecords && this.srvPrefix) {
-      records.push(
-        DNSRecord(
-          dnsFullName(`${this.srvPrefix}.${domainName}`),
-          "SRV",
-          this.priority || 10,
-          this.weight,
-          this.port,
-          dnsFullName(this.domainName)
-        )
-      );
+    if (hasSVRRecords) {
+      for (const ep of this.endpoints.filter(e => e.protocol)) {
+        records.push(
+          DNSRecord(
+            dnsFullName(
+              `_${ServiceTypes[this.type]?.type || this.type}._${
+                ep.protocol
+              }.${domainName}`
+            ),
+            "SRV",
+            this.priority === undefined ? 10 : this.priority,
+            this.weight,
+            ep.port,
+            dnsFullName(this.domainName)
+          )
+        );
+      }
     }
 
     const dnsRecord = ServiceTypes[this.type]?.dnsRecord;
@@ -234,7 +247,7 @@ export class Service extends Base {
           DNSRecord(
             dnsFullName(domainName),
             dnsRecord.type,
-            this.priority || 10,
+            this.priority === undefined ? 10 : this.priority,
             ".",
             dnsFormatParameters(parameters)
           )
@@ -256,12 +269,13 @@ export function serviceAddresses(
   sources,
   filter,
   addressType = "rawAddresses",
-  addressFilter = a=>!isLocalhost(a)
+  addressFilter = a => !isLocalhost(a)
 ) {
   return asArray(sources)
     .map(ft => Array.from(ft.findServices(filter)))
     .flat()
     .sort(sortByPriority)
     .map(s => s[addressType])
-    .flat().filter(addressFilter);
+    .flat()
+    .filter(addressFilter);
 }

package/src/services/dns.mjs

@@ -5,16 +5,16 @@ import {
   writeLines,
   isIPv6Address,
   normalizeIPAddress,
-  isLinkLocal
+  isLinkLocal,
+  isLocalhost
 } from "../utils.mjs";
 import { DNSRecord, dnsFullName } from "../dns-utils.mjs";
 import { addType } from "../types.mjs";
+import { ServiceTypeDefinition, serviceAddresses } from "../service.mjs";
 import {
-  Service,
-  ServiceTypeDefinition,
-  serviceAddresses
-} from "../service.mjs";
-import { ExtraSourceService, ExtraSourceServiceTypeDefinition } from "../extra-source-service.mjs";
+  ExtraSourceService,
+  ExtraSourceServiceTypeDefinition
+} from "../extra-source-service.mjs";
 import { subnets } from "../subnet.mjs";
 
 const DNSServiceTypeDefinition = {
@@ -262,15 +262,14 @@ async function generateZoneDefs(dns, location, packageData) {
       };
       configs.push(config);
 
+      zone.records.add(DNSRecord("location", "TXT", host.location.name));
+
       for (const address of host.rawAddresses) {
-        zone.records.add(
-          DNSRecord(
-            "@",
-            isIPv6Address(address) ? "AAAA" : "A",
-            normalizeIPAddress(address)
-          )
-        );
-        zone.records.add(DNSRecord("location", "TXT", host.location.name));
+        if (!isLocalhost(address)) {
+          zone.records.add(
+            DNSRecord("@", isIPv6Address(address) ? "AAAA" : "A", address)
+          );
+        }
       }
     }
   }
@@ -335,7 +334,7 @@ async function generateZoneDefs(dns, location, packageData) {
               DNSRecord(
                 dnsFullName(domainName),
                 isIPv6Address(address) ? "AAAA" : "A",
-                normalizeIPAddress(address)
+                address
               )
             );
           }

package/src/utils.mjs

@@ -96,7 +96,15 @@ export function isIPv6Address(address) {
 }
 
 export function isLinkLocal(address) {
-  return address.startsWith("fe80");
+  switch (typeof address) {
+    case "string":
+      return address.startsWith("fe80");
+
+    case "bigint":
+      return ((address >> 112n) & 0xffffn) === 0xfe80n;
+  }
+
+  return false;
 }
 
 export function isLocalhost(address) {
@@ -136,6 +144,10 @@ const ipv6 = {
 };
 
 function _decode(definition, address, length = definition.length) {
+  if (typeof address === "string") {
+    return address;
+  }
+
   let result = "";
   let compressed = 0;
   let shift = definition.length;

package/types/dns-utils.d.mts

@@ -1,7 +1,7 @@
 export function dnsFullName(name: any): any;
 export function DNSRecord(key: any, type: any, ...values: any[]): {
     key: any;
-    toString: (maxKeyLength: any, ttl: any) => string;
+    toString: (maxKeyLength?: number, ttl?: string) => string;
 };
 export function dnsFormatParameters(parameters: any): string;
 export function dnsMergeParameters(a: any, b: any): {

package/types/extra-source-service.d.mts

@@ -98,11 +98,6 @@ export class ExtraSourceService extends Service {
                     collection: boolean;
                     writeable: boolean;
                 };
-                srvPrefix: {
-                    type: string;
-                    collection: boolean;
-                    writeable: boolean;
-                };
                 tls: {
                     type: string;
                     collection: boolean;

package/types/service.d.mts

@@ -83,11 +83,6 @@ export namespace ServiceTypeDefinition {
             collection: boolean;
             writeable: boolean;
         };
-        srvPrefix: {
-            type: string;
-            collection: boolean;
-            writeable: boolean;
-        };
         tls: {
             type: string;
             collection: boolean;
@@ -209,11 +204,6 @@ export class Service extends Base {
                 collection: boolean;
                 writeable: boolean;
             };
-            srvPrefix: {
-                type: string;
-                collection: boolean;
-                writeable: boolean;
-            };
             tls: {
                 type: string;
                 collection: boolean;
@@ -264,6 +254,7 @@ export class Service extends Base {
     get rawAddress(): any;
     set ipAddresses(value: any);
     get addresses(): any;
+    get endpoints(): any;
     set port(value: any);
     get port(): any;
     set weight(value: any);
@@ -273,10 +264,9 @@ export class Service extends Base {
     get protocol(): any;
     get tls(): any;
     get systemdServices(): any;
-    get srvPrefix(): string;
     dnsRecordsForDomainName(domainName: any, hasSVRRecords: any): {
         key: any;
-        toString: (maxKeyLength: any, ttl: any) => string;
+        toString: (maxKeyLength?: number, ttl?: string) => string;
     }[];
 }
 export function sortByPriority(a: any, b: any): number;

package/types/services/dhcp.d.mts

@@ -85,11 +85,6 @@ export class DHCPService extends Service {
                     collection: boolean;
                     writeable: boolean;
                 };
-                srvPrefix: {
-                    type: string;
-                    collection: boolean;
-                    writeable: boolean;
-                };
                 tls: {
                     type: string;
                     collection: boolean;

package/types/services/dns.d.mts

@@ -58,7 +58,7 @@ export class DNSService extends ExtraSourceService {
                         };
                     };
                 };
-                factoryFor(value: any): typeof Service | typeof DNSService | typeof import("./ntp.mjs").NTPService | typeof import("./dhcp.mjs").DHCPService;
+                factoryFor(value: any): typeof import("../service.mjs").Service | typeof DNSService | typeof import("./ntp.mjs").NTPService | typeof import("./dhcp.mjs").DHCPService;
                 properties: {
                     ipAddresses: {
                         type: string;
@@ -90,11 +90,6 @@ export class DNSService extends ExtraSourceService {
                         collection: boolean;
                         writeable: boolean;
                     };
-                    srvPrefix: {
-                        type: string;
-                        collection: boolean;
-                        writeable: boolean;
-                    };
                     tls: {
                         type: string;
                         collection: boolean;
@@ -264,4 +259,3 @@ export class DNSService extends ExtraSourceService {
     }, void, unknown>;
 }
 import { ExtraSourceService } from "../extra-source-service.mjs";
-import { Service } from "../service.mjs";

package/types/services/ntp.d.mts

@@ -88,11 +88,6 @@ export class NTPService extends ExtraSourceService {
                         collection: boolean;
                         writeable: boolean;
                     };
-                    srvPrefix: {
-                        type: string;
-                        collection: boolean;
-                        writeable: boolean;
-                    };
                     tls: {
                         type: string;
                         collection: boolean;

package/types/subnet.d.mts

@@ -27,7 +27,7 @@ export class Subnet extends Base {
     networks: Set<any>;
     get fullName(): string;
     matchesAddress(address: any): any;
-    get isLinkLocal(): any;
+    get isLinkLocal(): boolean;
     get prefix(): string;
     get prefixLength(): number;
     get address(): string;

package/types/utils.d.mts

@@ -8,7 +8,7 @@ export function asIterator(value: any): any;
 export function isIPv4Address(address: any): boolean;
 export function generateEU64(mac: any): void;
 export function isIPv6Address(address: any): boolean;
-export function isLinkLocal(address: any): any;
+export function isLinkLocal(address: any): boolean;
 export function isLocalhost(address: any): boolean;
 export function normalizeIPAddress(address: any): any;
 export function _encode(definition: any, address: any): any;
@@ -28,7 +28,7 @@ export function normalizeCIDR(address: any): {
     prefixLength: any;
     cidr: string;
 };
-export function hasWellKnownSubnet(address: any): any;
+export function hasWellKnownSubnet(address: any): boolean;
 export const IPV4_LOCALHOST: any;
 export const IPV6_LOCALHOST: any;
 export const IPV6_LINK_LOCAL_BROADCAST: any;