pmcf 2.38.0 → 2.39.0

package/package.json

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

package/src/cluster.mjs

@@ -2,6 +2,7 @@ import { join } from "node:path";
 import { FileContentProvider } from "npm-pkgbuild";
 import { Owner } from "./owner.mjs";
 import { Host } from "./host.mjs";
+import { serviceEndpoints } from "pmcf";
 import { addType } from "./types.mjs";
 import { writeLines } from "./utils.mjs";
 
@@ -139,20 +140,25 @@ export class Cluster extends Host {
         cfg.push("}");
         cfg.push("");
 
-        for (const service of cluster.findServices({ type: "http" })) {
-          cfg.push(`virtual_server ${cluster.address} ${service.port} {`);
+        for (const endpoint of serviceEndpoints(cluster, {
+          services: { type: "http" },
+          endpoints: e => e.networkInterface.kind !== "loopback"
+        })) {
+          cfg.push(`virtual_server ${cluster.address} ${endpoint.port} {`);
           cfg.push(`  delay_loop ${cluster.checkInterval}`);
           cfg.push("  lb_algo wlc");
           cfg.push("  persistence_timeout 600");
-          cfg.push(`  protocol ${service.protocol.toUpperCase()}`);
+          cfg.push(`  protocol ${endpoint.protocol.toUpperCase()}`);
 
           for (const member of this.members) {
-            const memberService = member.findService({ type: service.type }) || member.host.findService({ type: service.type }); // TODO
+            const memberService =
+              member.findService({ type: endpoint.type }) ||
+              member.host.findService({ type: endpoint.type }); // TODO
 
             cfg.push(`  real_server ${member.address} ${memberService.port} {`);
             cfg.push(`    weight ${memberService.weight}`);
 
-            switch (service.type) {
+            switch (endpoint.type) {
               case "dns":
                 cfg.push(`    DNS_CHECK {`);
                 cfg.push("      type A");
@@ -165,7 +171,7 @@ export class Cluster extends Host {
                 break;
 
               default:
-                switch (service.protocol) {
+                switch (endpoint.protocol) {
                   case "tcp":
                     cfg.push(`    TCP_CHECK {`);
                     cfg.push("      connect_timeout 10");

package/src/endpoint.mjs

@@ -1,12 +1,37 @@
-export class Endpoint {
-  constructor(service, networkAddress, data) {
+class _Endpoint {
+  #port;
+  #type;
+  constructor(service, data) {
     this.service = service;
-    this.networkAddress = networkAddress;
+    if (data.port) {
+      this.#port = data.port;
+      delete data.port;
+    }
+
+    if (data.type) {
+      this.#type = data.type;
+      delete data.type;
+    }
     Object.assign(this, data);
   }
 
+  get type() {
+    return this.#type ?? this.service.type;
+  }
+
+  get port() {
+    return this.#port ?? this.service._port;
+  }
+
   toString() {
-    return `${this.address}[${this.port}]`;
+    return `${this.type}/${this.address}[${this.port}]`;
+  }
+}
+
+export class Endpoint extends _Endpoint {
+  constructor(service, networkAddress, data) {
+    super(service, data);
+    this.networkAddress = networkAddress;
   }
 
   get socketAddress() {
@@ -34,11 +59,10 @@ export class Endpoint {
   }
 }
 
-export class DomainNameEndpoint {
+export class DomainNameEndpoint extends _Endpoint {
   constructor(service, domainName, data) {
-    this.service = service;
+    super(service, data);
     this.domainName = domainName;
-    Object.assign(this, data);
   }
 
   get networkInterface() {
@@ -48,17 +72,15 @@ export class DomainNameEndpoint {
   get address() {
     return this.domainName;
   }
-
-  toString() {
-    return `${this.address}[${this.port}]`;
-  }
 }
 
-export class HTTPEndpoint {
+export class HTTPEndpoint extends _Endpoint {
   constructor(service, url, data) {
-    this.service = service;
+    super(service, data);
     this.url = url;
-    Object.assign(this, data);
   }
 
-}
+  get address() {
+    return this.url;
+  }
+}

package/src/owner.mjs

@@ -175,10 +175,6 @@ export class Owner extends Base {
       yield* this.owner.subnets();
     }
     yield* this.typeList("subnet");
-
-    /* for (const network of this.networks()) {
-      yield* network.subnets();
-    }*/
   }
 
   addSubnet(address) {

package/src/service.mjs

@@ -24,7 +24,6 @@ const ServiceTypes = {
   },
   http3: {
     extends: ["https"],
-    type: "https",
     dnsRecord: {
       type: "HTTPS",
       parameters: { "no-default-alpn": undefined, alpn: "h3" }
@@ -48,7 +47,6 @@ const ServiceTypes = {
   "dhcpv6-server": { endpoints: [{ port: 547, tls: false }] },
   smb: { endpoints: [{ protocol: "tcp", port: 445, tls: false }] },
   timemachine: {
-    type: "adisk",
     extends: ["smb"],
     endpoints: [{ protocol: "tcp", port: 445, tls: false }],
     dnsRecord: {
@@ -68,13 +66,19 @@ function serviceTypeEndpoints(type) {
   if (st) {
     if (st.extends) {
       return st.extends.reduce(
-        (a, c) => [...a, ...(ServiceTypes[c]?.endpoints||[])],
+        (a, c) => [...a, ...(ServiceTypes[c]?.endpoints || [])],
         st.endpoints || []
       );
     }
 
     return st.endpoints;
   }
+
+  return [
+    {
+      tls: false
+    }
+  ];
 }
 
 export const endpointProperties = {
@@ -96,7 +100,7 @@ export const endpointProperties = {
 
 export const EndpointTypeDefinition = {
   name: "endpoint",
-  owners: ["service", "network-interface"],
+  owners: ["service", "network_interface"],
   priority: 0.4,
   specializations: {},
   properties: endpointProperties
@@ -149,6 +153,10 @@ export class Service extends Base {
     this.read(data, ServiceTypeDefinition);
   }
 
+  toString() {
+    return `${this.type}`;
+  }
+
   set extends(value) {
     this._extends.push(value);
   }
@@ -184,32 +192,16 @@ export class Service extends Base {
   }
 
   endpoints(filter) {
-    const local =
-      this._port === undefined
-        ? { type: this.type }
-        : { type: this.type, port: this._port };
-
-    const data = serviceTypeEndpoints(this.type) || [
-      {
-        tls: false
-      }
-    ];
+    const data = serviceTypeEndpoints(this.type);
 
+    const l = this._port === undefined ? {} : { port: this._port };
     let result = [...this.host.networkAddresses()]
-      .map(na =>
-        data.map(
-          d =>
-            new Endpoint(this, na, {
-              ...d,
-              ...local
-            })
-        )
-      )
+      .map(na => data.map(d => new Endpoint(this, na, { ...d, ...l })))
       .flat();
 
     if (result.length === 0) {
       result = data.map(
-        d => new DomainNameEndpoint(this, this.domainName, { ...d, ...local })
+        d => new DomainNameEndpoint(this, this.domainName, { ...d, ...l })
       );
     }
 
@@ -229,7 +221,7 @@ export class Service extends Base {
   }
 
   get port() {
-    return this.endpoints()[0].port;
+    return this._port ?? this.endpoints()[0].port;
   }
 
   set weight(value) {
@@ -264,11 +256,7 @@ export class Service extends Base {
       )) {
         records.push(
           DNSRecord(
-            dnsFullName(
-              `_${ServiceTypes[this.type]?.type ?? this.type}._${
-                ep.protocol
-              }.${domainName}`
-            ),
+            dnsFullName(`_${this.type}._${ep.protocol}.${domainName}`),
             "SRV",
             this.priority ?? 10,
             this.weight,
@@ -305,7 +293,12 @@ export class Service extends Base {
         );
       } else {
         records.push(
-          DNSRecord("@", dnsRecord.type, this.priority ?? 10, dnsFullName(domainName))
+          DNSRecord(
+            "@",
+            dnsRecord.type,
+            this.priority ?? 10,
+            dnsFullName(domainName)
+          )
         );
       }
     }
@@ -317,9 +310,9 @@ export class Service extends Base {
 export const sortByPriority = (a, b) => a.priority - b.priority;
 
 /**
- * 
- * @param {*} sources 
- * @param {Object} [options] 
+ *
+ * @param {*} sources
+ * @param {Object} [options]
  * @param {Function} [options.services] filter for services
  * @param {Function} [options.endpoints] filter for endpoints
  * @param {Function} [options.select] mapper from Endpoint into result

package/src/services/dns.mjs

@@ -54,6 +54,12 @@ const DNSServiceTypeDefinition = {
       writeable: true,
       default: false
     },
+    hasLocationRecord: {
+      type: "boolean",
+      collection: false,
+      writeable: true,
+      default: true
+    },
     excludeInterfaceKinds: {
       type: "string",
       collection: true,
@@ -107,6 +113,7 @@ export class DNSService extends ExtraSourceService {
   hasSVRRecords = true;
   hasCatalog = true;
   hasLinkLocalAdresses = true;
+  hasLocationRecord = true;
   notify = true;
   _trusted = [];
   _protected = [];
@@ -274,249 +281,253 @@ export class DNSService extends ExtraSourceService {
       )
     ];
 
-    await generateZoneDefs(this, location, packageData);
+    await this.generateZoneDefs(location, packageData);
 
     yield packageData;
   }
-}
 
-async function generateZoneDefs(dns, location, packageData) {
-  const ttl = dns.recordTTL;
-  const nameService = dns.findService({ type: "dns", priority: "<10" });
-  const rname = dns.administratorEmail.replace(/@/, ".");
+  async generateZoneDefs(location, packageData) {
+    const ttl = this.recordTTL;
+    const nameService = this.findService({ type: "dns", priority: "<10" });
+    const rname = this.administratorEmail.replace(/@/, ".");
+
+    const SOARecord = DNSRecord(
+      "@",
+      "SOA",
+      dnsFullName(nameService.domainName),
+      dnsFullName(rname),
+      `(${[...this.soaUpdates].join(" ")})`
+    );
 
-  const SOARecord = DNSRecord(
-    "@",
-    "SOA",
-    dnsFullName(nameService.domainName),
-    dnsFullName(rname),
-    `(${[...dns.soaUpdates].join(" ")})`
-  );
+    const NSRecord = DNSRecord(
+      "@",
+      "NS",
+      dnsFullName(nameService.ipAddressOrDomainName)
+    );
 
-  const NSRecord = DNSRecord(
-    "@",
-    "NS",
-    dnsFullName(nameService.ipAddressOrDomainName)
-  );
+    console.log(`${nameService}`, nameService.ipAddressOrDomainName);
 
-  console.log(`${nameService}`, nameService.ipAddressOrDomainName);
+    const configs = [];
 
-  const configs = [];
+    for (const host of location.hosts()) {
+      for (const domain of host.foreignDomainNames) {
+        const zone = {
+          id: domain,
+          file: `FOREIGN/${domain}.zone`,
+          records: new Set([SOARecord, NSRecord])
+        };
 
-  for (const host of location.hosts()) {
-    for (const domain of host.foreignDomainNames) {
-      const zone = {
-        id: domain,
-        file: `FOREIGN/${domain}.zone`,
-        records: new Set([SOARecord, NSRecord])
-      };
-
-      const config = {
-        name: `${domain}.zone.conf`,
-        zones: [zone]
-      };
-      configs.push(config);
+        const config = {
+          name: `${domain}.zone.conf`,
+          zones: [zone]
+        };
+        configs.push(config);
 
-      zone.records.add(DNSRecord("location", "TXT", host.location.name));
+        if (this.hasLocationRecord) {
+          zone.records.add(DNSRecord("location", "TXT", host.location.name));
+        }
 
-      for (const na of host.networkAddresses(
-        na => na.networkInterface.kind != "loopback"
-      )) {
-        zone.records.add(
-          DNSRecord("@", dnsRecordTypeForAddressFamily(na.family), na.address)
-        );
+        for (const na of host.networkAddresses(
+          na => na.networkInterface.kind != "loopback"
+        )) {
+          zone.records.add(
+            DNSRecord("@", dnsRecordTypeForAddressFamily(na.family), na.address)
+          );
+        }
       }
     }
-  }
 
-  const foreignZones = configs.map(c => c.zones).flat();
+    const foreignZones = configs.map(c => c.zones).flat();
+
+    if (foreignZones.length) {
+      addHook(
+        packageData.properties.hooks,
+        "post_upgrade",
+        `rm -f ${foreignZones.map(
+          zone => `/var/lib/named/${zone.file}.jnl`
+        )}\n` +
+          `/usr/bin/named-hostname-info ${foreignZones
+            .map(zone => zone.id)
+            .join(" ")}|/usr/bin/named-hostname-update`
+      );
+    }
 
-  if (foreignZones.length) {
-    addHook(
-      packageData.properties.hooks,
-      "post_upgrade",
-      `rm -f ${foreignZones.map(zone => `/var/lib/named/${zone.file}.jnl`)}\n` +
-        `/usr/bin/named-hostname-info ${foreignZones
-          .map(zone => zone.id)
-          .join(" ")}|/usr/bin/named-hostname-update`
+    console.log(
+      "LOCAL DOMAINS",
+      location.localDomains,
+      location.domain,
+      location.toString()
     );
-  }
 
-  console.log(
-    "LOCAL DOMAINS",
-    location.localDomains,
-    location.domain,
-    location.toString()
-  );
+    for (const domain of location.localDomains) {
+      const locationName = location.name;
+      const reverseZones = new Map();
 
-  for (const domain of location.localDomains) {
-    const locationName = location.name;
-    const reverseZones = new Map();
-
-    const config = {
-      name: `${domain}.zone.conf`,
-      zones: []
-    };
-    configs.push(config);
-
-    const locationRecord = DNSRecord("location", "TXT", locationName);
-
-    const zone = {
-      id: domain,
-      file: `${locationName}/${domain}.zone`,
-      records: new Set([SOARecord, NSRecord, locationRecord])
-    };
-    config.zones.push(zone);
-
-    if (dns.hasCatalog) {
-      const catalogConfig = {
-        name: `catalog.${domain}.zone.conf`,
+      const config = {
+        name: `${domain}.zone.conf`,
         zones: []
       };
-      configs.push(catalogConfig);
-
-      zone.catalogZone = {
-        id: `catalog.${domain}`,
-        file: `${locationName}/catalog.${domain}.zone`,
-        records: new Set([
-          SOARecord,
-          NSRecord,
-          DNSRecord(dnsFullName(`version.catalog.${domain}`), "TXT", '"1"')
-        ])
+      configs.push(config);
+
+      const locationRecord = DNSRecord("location", "TXT", locationName);
+
+      const zone = {
+        id: domain,
+        file: `${locationName}/${domain}.zone`,
+        records: new Set([SOARecord, NSRecord, locationRecord])
       };
-      catalogConfig.zones.push(zone.catalogZone);
-    }
+      config.zones.push(zone);
+
+      if (this.hasCatalog) {
+        const catalogConfig = {
+          name: `catalog.${domain}.zone.conf`,
+          zones: []
+        };
+        configs.push(catalogConfig);
+
+        zone.catalogZone = {
+          id: `catalog.${domain}`,
+          file: `${locationName}/catalog.${domain}.zone`,
+          records: new Set([
+            SOARecord,
+            NSRecord,
+            DNSRecord(dnsFullName(`version.catalog.${domain}`), "TXT", '"1"')
+          ])
+        };
+        catalogConfig.zones.push(zone.catalogZone);
+      }
+
+      const hosts = new Set();
+      const addresses = new Set();
 
-    const hosts = new Set();
-    const addresses = new Set();
-
-    for await (const {
-      address,
-      subnet,
-      networkInterface,
-      domainNames,
-      family
-    } of location.networkAddresses()) {
-      if (
-        !dns.exclude.has(networkInterface.network) &&
-        !dns.excludeInterfaceKinds.has(networkInterface.kind)
-      ) {
-        const host = networkInterface.host;
+      for await (const {
+        address,
+        subnet,
+        networkInterface,
+        domainNames,
+        family
+      } of location.networkAddresses()) {
         if (
-          !addresses.has(address) &&
-          (dns.hasLinkLocalAdresses || !isLinkLocal(address))
+          !this.exclude.has(networkInterface.network) &&
+          !this.excludeInterfaceKinds.has(networkInterface.kind)
         ) {
-          addresses.add(address);
-
-          for (const domainName of domainNames) {
-            zone.records.add(
-              DNSRecord(
-                dnsFullName(domainName),
-                dnsRecordTypeForAddressFamily(family),
-                address
-              )
-            );
-          }
-          if (subnet && host.domain === domain) {
-            let reverseZone = reverseZones.get(subnet.address);
-
-            if (!reverseZone) {
-              const id = reverseArpa(subnet.prefix);
-              reverseZone = {
-                id,
-                type: "plain",
-                file: `${locationName}/${id}.zone`,
-                records: new Set([SOARecord, NSRecord])
-              };
-              config.zones.push(reverseZone);
-              reverseZones.set(subnet.address, reverseZone);
-            }
-
-            for (const domainName of host.domainNames) {
-              reverseZone.records.add(
+          const host = networkInterface.host;
+          if (
+            !addresses.has(address) &&
+            (this.hasLinkLocalAdresses || !isLinkLocal(address))
+          ) {
+            addresses.add(address);
+
+            for (const domainName of domainNames) {
+              zone.records.add(
                 DNSRecord(
-                  dnsFullName(reverseArpa(address)),
-                  "PTR",
-                  dnsFullName(domainName)
+                  dnsFullName(domainName),
+                  dnsRecordTypeForAddressFamily(family),
+                  address
                 )
               );
             }
+            if (subnet && host.domain === domain) {
+              let reverseZone = reverseZones.get(subnet.address);
+
+              if (!reverseZone) {
+                const id = reverseArpa(subnet.prefix);
+                reverseZone = {
+                  id,
+                  type: "plain",
+                  file: `${locationName}/${id}.zone`,
+                  records: new Set([SOARecord, NSRecord])
+                };
+                config.zones.push(reverseZone);
+                reverseZones.set(subnet.address, reverseZone);
+              }
+
+              for (const domainName of host.domainNames) {
+                reverseZone.records.add(
+                  DNSRecord(
+                    dnsFullName(reverseArpa(address)),
+                    "PTR",
+                    dnsFullName(domainName)
+                  )
+                );
+              }
+            }
           }
-        }
 
-        if (!hosts.has(host)) {
-          hosts.add(host);
+          if (!hosts.has(host)) {
+            hosts.add(host);
 
-          for (const foreignDomainName of host.foreignDomainNames) {
-            zone.records.add(
-              DNSRecord("outfacing", "PTR", dnsFullName(foreignDomainName))
-            );
-          }
+            for (const foreignDomainName of host.foreignDomainNames) {
+              zone.records.add(
+                DNSRecord("outfacing", "PTR", dnsFullName(foreignDomainName))
+              );
+            }
 
-          for (const service of host.findServices()) {
-            for (const record of service.dnsRecordsForDomainName(
-              host.domainName,
-              dns.hasSVRRecords
-            )) {
-              zone.records.add(record);
+            for (const service of host.findServices()) {
+              for (const record of service.dnsRecordsForDomainName(
+                host.domainName,
+                this.hasSVRRecords
+              )) {
+                zone.records.add(record);
+              }
             }
           }
         }
       }
     }
-  }
 
-  for (const config of configs) {
-    console.log(`config: ${config.name}`);
-
-    const content = [];
-    for (const zone of config.zones) {
-      console.log(`  file: ${zone.file}`);
-
-      if (zone.catalogZone) {
-        const hash = createHmac("md5", zone.id).digest("hex");
-        zone.catalogZone.records.add(
-          DNSRecord(
-            `${hash}.zones.catalog.${zone.id}.`,
-            "PTR",
-            dnsFullName(zone.id)
-          )
-        );
-      }
+    for (const config of configs) {
+      console.log(`config: ${config.name}`);
+
+      const content = [];
+      for (const zone of config.zones) {
+        console.log(`  file: ${zone.file}`);
+
+        if (zone.catalogZone) {
+          const hash = createHmac("md5", zone.id).digest("hex");
+          zone.catalogZone.records.add(
+            DNSRecord(
+              `${hash}.zones.catalog.${zone.id}.`,
+              "PTR",
+              dnsFullName(zone.id)
+            )
+          );
+        }
 
-      content.push(`zone \"${zone.id}\" {`);
-      content.push(`  type master;`);
-      content.push(`  file \"${zone.file}\";`);
+        content.push(`zone \"${zone.id}\" {`);
+        content.push(`  type master;`);
+        content.push(`  file \"${zone.file}\";`);
 
-      content.push(
-        `  allow-update { ${
-          dns.allowedUpdates.length ? dns.allowedUpdates.join(";") : "none"
-        }; };`
-      );
-      content.push(`  notify ${dns.notify ? "yes" : "no"};`);
-      content.push(`};`);
-      content.push("");
-
-      let maxKeyLength = 0;
-      for (const r of zone.records) {
-        if (r.key.length > maxKeyLength) {
-          maxKeyLength = r.key.length;
+        content.push(
+          `  allow-update { ${
+            this.allowedUpdates.length ? this.allowedUpdates.join(";") : "none"
+          }; };`
+        );
+        content.push(`  notify ${this.notify ? "yes" : "no"};`);
+        content.push(`};`);
+        content.push("");
+
+        let maxKeyLength = 0;
+        for (const r of zone.records) {
+          if (r.key.length > maxKeyLength) {
+            maxKeyLength = r.key.length;
+          }
         }
+
+        await writeLines(
+          join(packageData.dir, "var/lib/named"),
+          zone.file,
+          [...zone.records]
+            .sort(sortZoneRecords)
+            .map(r => r.toString(maxKeyLength, ttl))
+        );
       }
 
       await writeLines(
-        join(packageData.dir, "var/lib/named"),
-        zone.file,
-        [...zone.records]
-          .sort(sortZoneRecords)
-          .map(r => r.toString(maxKeyLength, ttl))
+        join(packageData.dir, "etc/named/zones"),
+        config.name,
+        content
       );
     }
-
-    await writeLines(
-      join(packageData.dir, "etc/named/zones"),
-      config.name,
-      content
-    );
   }
 }

package/types/endpoint.d.mts

@@ -1,8 +1,6 @@
-export class Endpoint {
+export class Endpoint extends _Endpoint {
     constructor(service: any, networkAddress: any, data: any);
-    service: any;
     networkAddress: any;
-    toString(): string;
     get socketAddress(): string;
     get hostName(): any;
     get domainName(): any;
@@ -10,16 +8,23 @@ export class Endpoint {
     get family(): any;
     get networkInterface(): any;
 }
-export class DomainNameEndpoint {
+export class DomainNameEndpoint extends _Endpoint {
     constructor(service: any, domainName: any, data: any);
-    service: any;
     domainName: any;
     get networkInterface(): {};
     get address(): any;
-    toString(): string;
 }
-export class HTTPEndpoint {
+export class HTTPEndpoint extends _Endpoint {
     constructor(service: any, url: any, data: any);
-    service: any;
     url: any;
+    get address(): any;
+}
+declare class _Endpoint {
+    constructor(service: any, data: any);
+    service: any;
+    get type(): any;
+    get port(): any;
+    toString(): string;
+    #private;
 }
+export {};

package/types/services/dns.d.mts

@@ -287,6 +287,12 @@ export class DNSService extends ExtraSourceService {
                 writeable: boolean;
                 default: boolean;
             };
+            hasLocationRecord: {
+                type: string;
+                collection: boolean;
+                writeable: boolean;
+                default: boolean;
+            };
             excludeInterfaceKinds: {
                 type: string;
                 collection: boolean;
@@ -345,6 +351,7 @@ export class DNSService extends ExtraSourceService {
     hasSVRRecords: boolean;
     hasCatalog: boolean;
     hasLinkLocalAdresses: boolean;
+    hasLocationRecord: boolean;
     notify: boolean;
     _trusted: any[];
     _protected: any[];
@@ -377,6 +384,7 @@ export class DNSService extends ExtraSourceService {
             access: string;
         };
     }, void, unknown>;
+    generateZoneDefs(location: any, packageData: any): Promise<void>;
 }
 import { ExtraSourceService } from "pmcf";
 import { FileContentProvider } from "npm-pkgbuild";