@small-tech/auto-encrypt 5.0.1 → 5.1.0

package/index.d.ts

@@ -20,6 +20,9 @@ import { Server, ServerOptions } from 'node:https'
 import { SecureContext } from 'node:tls'
 import { IncomingMessage, ServerResponse } from 'node:http'
 
+import IPAddresses from './lib/IPAddresses.js'
+export { IPAddresses }
+
 /**
   Options for creating an AutoEncrypt server. Extends Node’s https.ServerOptions.
 */

package/index.js

@@ -16,9 +16,10 @@
   @license AGPLv3 or later.
  */
 
-import os from 'os'
-import util from 'util'
-import https from 'https'
+import os from 'node:os'
+import util from 'node:util'
+import net from 'node:net'
+import https from 'node:https'
 import monkeyPatchTls from './lib/staging/monkeyPatchTls.js'
 import LetsEncryptServer from './lib/LetsEncryptServer.js'
 import Configuration from './lib/Configuration.js'
@@ -28,11 +29,9 @@ import Pluralise from './lib/util/Pluralise.js'
 import Throws from './lib/util/Throws.js'
 import HttpServer from './lib/HttpServer.js'
 import IPAddresses from './lib/IPAddresses.js'
+export { IPAddresses }
 import log from './lib/util/log.js'
 
-// Use module-level await to ensure we have the IP address information we need.
-const ipAddresses = await IPAddresses.getInstanceAsync()
-
 // Custom errors thrown by the autoEncrypt function.
 const throws = new Throws({
   [Symbol.for('BusyProvisioningCertificateError')]:
@@ -152,37 +151,56 @@ export default class AutoEncrypt {
       defaultPebbleDomains.push('pebble')
     }
 
-    if (options.ipv4 === true) {
-      if (letsEncryptServer.type === LetsEncryptServer.type.PEBBLE) {
-        const localIPv4Address = '127.0.0.1'
-        defaultPebbleDomains.push(localIPv4Address)
-        log(`   📍    ❨auto-encrypt❩ Will provision TLS certificate from Pebble server for local IPv4 address (${localIPv4Address})`)
-      } else {
-        if (ipAddresses.hasIPv4Address) {
-          const ipv4Address = ipAddresses.ipv4Address
-          defaultStagingAndProductionDomains.push(ipv4Address)
-          log(`   📍    ❨auto-encrypt❩ Will provision TLS certificate for detected IPv4 address: ${ipv4Address}`)
+    // Check if the passed list of domains contains an IP address. If it does, we can skip our automatic IP address detection and use the provides ones.
+    let domainsListContainsAtLeastOneIPAddress = false
+    if (options.domains) {
+      const ip = options.domains.find(domain => net.isIP(domain) !== 0)
+      if (ip !== undefined) {
+        domainsListContainsAtLeastOneIPAddress = true
+      }
+    }
+
+    if (!domainsListContainsAtLeastOneIPAddress) {
+      // Domains list does not contain any IP addresses, if auto detection is requested, auto detect the requested IP types.
+
+      /** @type { IPAddresses } */
+      let ipAddresses
+      if (options.ipv4 === true || options.ipv6 === true) {
+        ipAddresses = await IPAddresses.getInstanceAsync()
+      }
+
+      if (options.ipv4 === true) {
+        if (letsEncryptServer.type === LetsEncryptServer.type.PEBBLE) {
+          const localIPv4Address = '127.0.0.1'
+          defaultPebbleDomains.push(localIPv4Address)
+          log(`   📍    ❨auto-encrypt❩ Will provision TLS certificate from Pebble server for local IPv4 address (${localIPv4Address})`)
         } else {
-          throws.error(Symbol.for('IPv4AddressNotFound'))
+          if (ipAddresses.hasIPv4Address) {
+            const ipv4Address = ipAddresses.ipv4Address
+            defaultStagingAndProductionDomains.push(ipv4Address)
+            log(`   📍    ❨auto-encrypt❩ Will provision TLS certificate for detected IPv4 address: ${ipv4Address}`)
+          } else {
+            throws.error(Symbol.for('IPv4AddressNotFound'))
+          }
         }
       }
-    }
 
-    if (options.ipv6 === true) {
-      if (letsEncryptServer.type === LetsEncryptServer.type.PEBBLE) {
-        // IPv6: Pebble.
-        const localIPv6Address = '::1'
-        defaultPebbleDomains.push(localIPv6Address)
-        log(`   📍    ❨auto-encrypt❩ Will provision TLS certificate from Pebble server for local IPv6 address (${localIPv6Address})`)
-      } else {
-        // IPv6:  Staging and production.
-        const ipv6Addresses = ipAddresses.ipv6Addresses
-        if (ipv6Addresses.length > 0) {
-          defaultStagingAndProductionDomains = defaultStagingAndProductionDomains.concat(ipv6Addresses)
-          ipv6Addresses.forEach(ipv6Address => defaultPebbleDomains.push(ipv6Address))
-          log(`   📍    ❨auto-encrypt❩ Will provision TLS certificate for detected stable IPv6 address${ipv6Addresses.length > 1 ? 'es' : ''}: ${ipv6Addresses}`)
+      if (options.ipv6 === true) {
+        if (letsEncryptServer.type === LetsEncryptServer.type.PEBBLE) {
+          // IPv6: Pebble.
+          const localIPv6Address = '::1'
+          defaultPebbleDomains.push(localIPv6Address)
+          log(`   📍    ❨auto-encrypt❩ Will provision TLS certificate from Pebble server for local IPv6 address (${localIPv6Address})`)
         } else {
-          throws.error(Symbol.for('IPv6AddressNotFound'))
+          // IPv6: Staging and production.
+          const ipv6Addresses = ipAddresses.ipv6Addresses
+          if (ipv6Addresses.length > 0) {
+            defaultStagingAndProductionDomains = defaultStagingAndProductionDomains.concat(ipv6Addresses)
+            ipv6Addresses.forEach(ipv6Address => defaultPebbleDomains.push(ipv6Address))
+            log(`   📍    ❨auto-encrypt❩ Will provision TLS certificate for detected stable IPv6 address${ipv6Addresses.length > 1 ? 'es' : ''}: ${ipv6Addresses}`)
+          } else {
+            throws.error(Symbol.for('IPv6AddressNotFound'))
+          }
         }
       }
     }

package/lib/IPAddresses.js

@@ -11,6 +11,10 @@ import Throws from './util/Throws.js'
 
 const throws = new Throws()
 
+/**
+  @typedef {{ ip: string }} IpAddressApiResponse
+*/
+
 export default class IPAddresses {
   /** @type {IPAddresses} */
   static instance
@@ -82,7 +86,7 @@ export default class IPAddresses {
     try {
       const response = await fetch('https://ip.small-web.org/json/')
       if (response.status === 200) {
-        const ip = (await response.json()).ip
+        const ip = /** @type { IpAddressApiResponse } */ (await response.json()).ip
         if (ip !== '::1') {
           this.ipv4Address = ip
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@small-tech/auto-encrypt",
-  "version": "5.0.1",
+  "version": "5.1.0",
   "description": "Automatically provisions and renews Let’s Encrypt TLS certificates on Node.js https servers (including Kitten, Polka, Express.js, etc.)",
   "engines": {
     "node": ">=18.20.0"