portless 0.9.0 → 0.9.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright 2025 Vercel Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -9,11 +9,19 @@ Replace port numbers with stable, named .localhost URLs for local development. F
 
 ## Install
 
+**Global (recommended):**
+
 ```bash
 npm install -g portless
 ```
 
-> Install globally. Do not add as a project dependency or run via npx.
+**Or as a project dev dependency:**
+
+```bash
+npm install -D portless
+```
+
+> portless is pre-1.0. When installed per-project, different contributors may run different versions. The state directory format may change between releases, which can require re-running `portless trust`.
 
 ## Run your app
 
@@ -239,7 +247,7 @@ pnpm build            # Build all packages
 pnpm test             # Run tests
 pnpm test:coverage    # Run tests with coverage
 pnpm lint             # Lint all packages
-pnpm typecheck        # Type-check all packages
+pnpm type-check       # Type-check all packages
 pnpm format           # Format all files with Prettier
 ```
 

package/dist/{chunk-5BR7NCNI.js → chunk-YDICEMNW.js}

@@ -301,6 +301,29 @@ function buildForwardedHeaders(req, tls) {
   headers["x-forwarded-port"] = req.headers["x-forwarded-port"] || hostHeader.split(":")[1] || defaultPort;
   return headers;
 }
+function rewriteOriginHeaders(headers, targetPort, tldSuffix, tld) {
+  const localOrigin = `http://localhost:${targetPort}`;
+  if (typeof headers.origin === "string") {
+    try {
+      const parsed = new URL(headers.origin);
+      if (parsed.hostname === tld || parsed.hostname.endsWith(tldSuffix)) {
+        headers.origin = localOrigin;
+      }
+    } catch {
+    }
+  }
+  if (typeof headers.referer === "string") {
+    try {
+      const parsed = new URL(headers.referer);
+      if (parsed.hostname === tld || parsed.hostname.endsWith(tldSuffix)) {
+        parsed.protocol = "http:";
+        parsed.host = `localhost:${targetPort}`;
+        headers.referer = parsed.toString();
+      }
+    } catch {
+    }
+  }
+}
 var PORTLESS_HOPS_HEADER = "x-portless-hops";
 var MAX_PROXY_HOPS = 5;
 function findRoute(routes, host, strict) {
@@ -373,6 +396,7 @@ function createProxyServer(options) {
         delete proxyReqHeaders[key];
       }
     }
+    rewriteOriginHeaders(proxyReqHeaders, route.port, tldSuffix, tld);
     const proxyReq = http.request(
       {
         hostname: "127.0.0.1",
@@ -456,6 +480,7 @@ function createProxyServer(options) {
         delete proxyReqHeaders[key];
       }
     }
+    rewriteOriginHeaders(proxyReqHeaders, route.port, tldSuffix, tld);
     const proxyReq = http.request({
       hostname: "127.0.0.1",
       port: route.port,
@@ -667,6 +692,91 @@ var USER_STATE_DIR = path2.join(os.homedir(), ".portless");
 var MIN_APP_PORT = 4e3;
 var MAX_APP_PORT = 4999;
 var RANDOM_PORT_ATTEMPTS = 50;
+var BLOCKED_PORTS = /* @__PURE__ */ new Set([
+  0,
+  1,
+  7,
+  9,
+  11,
+  13,
+  15,
+  17,
+  19,
+  20,
+  21,
+  22,
+  23,
+  25,
+  37,
+  42,
+  43,
+  53,
+  69,
+  77,
+  79,
+  87,
+  95,
+  101,
+  102,
+  103,
+  104,
+  109,
+  110,
+  111,
+  113,
+  115,
+  117,
+  119,
+  123,
+  135,
+  137,
+  139,
+  143,
+  161,
+  179,
+  389,
+  427,
+  465,
+  512,
+  513,
+  514,
+  515,
+  526,
+  530,
+  531,
+  532,
+  540,
+  548,
+  554,
+  556,
+  563,
+  587,
+  601,
+  636,
+  989,
+  990,
+  993,
+  995,
+  1719,
+  1720,
+  1723,
+  2049,
+  3659,
+  4045,
+  4190,
+  5060,
+  5061,
+  6e3,
+  6566,
+  6665,
+  6666,
+  6667,
+  6668,
+  6669,
+  6679,
+  6697,
+  10080
+]);
 var SOCKET_TIMEOUT_MS = 500;
 var PID_LOOKUP_TIMEOUT_MS = 5e3;
 var WAIT_FOR_PROXY_MAX_ATTEMPTS = 20;
@@ -835,12 +945,12 @@ async function findFreePort(minPort = MIN_APP_PORT, maxPort = MAX_APP_PORT) {
   };
   for (let i = 0; i < RANDOM_PORT_ATTEMPTS; i++) {
     const port = minPort + Math.floor(Math.random() * (maxPort - minPort + 1));
-    if (await tryPort(port)) {
+    if (!BLOCKED_PORTS.has(port) && await tryPort(port)) {
       return port;
     }
   }
   for (let port = minPort; port <= maxPort; port++) {
-    if (await tryPort(port)) {
+    if (!BLOCKED_PORTS.has(port) && await tryPort(port)) {
       return port;
     }
   }

package/dist/cli.js

@@ -35,7 +35,7 @@ import {
   waitForProxy,
   writeTldFile,
   writeTlsMarker
-} from "./chunk-5BR7NCNI.js";
+} from "./chunk-YDICEMNW.js";
 
 // src/colors.ts
 function supportsColor() {
@@ -91,6 +91,40 @@ function fileExists(filePath) {
     return false;
   }
 }
+var _opensslEnv;
+function getOpensslEnv() {
+  if (process.platform !== "win32") return void 0;
+  if (_opensslEnv !== void 0) return _opensslEnv;
+  if (process.env.OPENSSL_CONF && fileExists(process.env.OPENSSL_CONF)) {
+    _opensslEnv = {};
+    return _opensslEnv;
+  }
+  const candidates = [
+    // Git-for-Windows bundles OpenSSL here
+    path.join("C:", "Program Files", "Git", "mingw64", "etc", "ssl", "openssl.cnf"),
+    path.join("C:", "Program Files", "Git", "usr", "ssl", "openssl.cnf"),
+    // Standalone OpenSSL installers
+    path.join("C:", "Program Files", "OpenSSL-Win64", "bin", "cnf", "openssl.cnf"),
+    path.join("C:", "Program Files", "OpenSSL-Win64", "openssl.cnf"),
+    path.join("C:", "Program Files (x86)", "OpenSSL-Win32", "bin", "cnf", "openssl.cnf"),
+    // Common winget/chocolatey install paths
+    path.join("C:", "Program Files", "OpenSSL", "bin", "cnf", "openssl.cnf")
+  ];
+  for (const candidate of candidates) {
+    if (fileExists(candidate)) {
+      _opensslEnv = { OPENSSL_CONF: candidate };
+      return _opensslEnv;
+    }
+  }
+  _opensslEnv = {};
+  return _opensslEnv;
+}
+function opensslErrorMessage() {
+  if (process.platform === "win32") {
+    return "Make sure openssl is installed and working.\nInstall via: winget install -e --id ShiningLight.OpenSSL.Dev\nIf already installed, set OPENSSL_CONF to the path of your openssl.cnf file.";
+  }
+  return "Make sure openssl is installed (ships with macOS and most Linux distributions).";
+}
 function isCertValid(certPath) {
   try {
     const pem = fs.readFileSync(certPath, "utf-8");
@@ -114,36 +148,36 @@ function isCertSignatureStrong(certPath) {
 }
 function openssl(args, options) {
   try {
+    const extraEnv = getOpensslEnv();
     return execFileSync("openssl", args, {
       encoding: "utf-8",
       timeout: OPENSSL_TIMEOUT_MS,
       input: options?.input,
-      stdio: ["pipe", "pipe", "pipe"]
+      stdio: ["pipe", "pipe", "pipe"],
+      ...extraEnv && Object.keys(extraEnv).length > 0 ? { env: { ...process.env, ...extraEnv } } : {}
     });
   } catch (err) {
     const message = err instanceof Error ? err.message : String(err);
-    throw new Error(
-      `openssl failed: ${message}
+    throw new Error(`openssl failed: ${message}
 
-Make sure openssl is installed (ships with macOS and most Linux distributions).`
-    );
+${opensslErrorMessage()}`);
   }
 }
 var execFileAsync = promisify(execFileCb);
 async function opensslAsync(args) {
   try {
+    const extraEnv = getOpensslEnv();
     const { stdout } = await execFileAsync("openssl", args, {
       encoding: "utf-8",
-      timeout: OPENSSL_TIMEOUT_MS
+      timeout: OPENSSL_TIMEOUT_MS,
+      ...extraEnv && Object.keys(extraEnv).length > 0 ? { env: { ...process.env, ...extraEnv } } : {}
     });
     return stdout;
   } catch (err) {
     const message = err instanceof Error ? err.message : String(err);
-    throw new Error(
-      `openssl failed: ${message}
+    throw new Error(`openssl failed: ${message}
 
-Make sure openssl is installed (ships with macOS and most Linux distributions).`
-    );
+${opensslErrorMessage()}`);
   }
 }
 function generateCA(stateDir) {
@@ -491,7 +525,10 @@ function createSNICallback(stateDir, defaultCert, defaultKey, tld = "localhost")
 function trustCA(stateDir) {
   const caCertPath = path.join(stateDir, CA_CERT_FILE);
   if (!fileExists(caCertPath)) {
-    return { trusted: false, error: "CA certificate not found. Run with --https first." };
+    return {
+      trusted: false,
+      error: "CA certificate not found. Run portless trust to generate it."
+    };
   }
   try {
     if (process.platform === "darwin") {
@@ -735,6 +772,18 @@ function getEntryScript() {
   }
   return script;
 }
+function isLocallyInstalled() {
+  let dir = process.cwd();
+  for (; ; ) {
+    if (fs3.existsSync(path3.join(dir, "node_modules", "portless", "package.json"))) {
+      return true;
+    }
+    const parent = path3.dirname(dir);
+    if (parent === dir) break;
+    dir = parent;
+  }
+  return false;
+}
 function collectPortlessEnvArgs() {
   const envArgs = [];
   for (const key of Object.keys(process.env)) {
@@ -1276,8 +1325,8 @@ Eliminates port conflicts, memorizing port numbers, and cookie/storage
 clashes by giving each dev server a stable .localhost URL.
 
 ${colors_default.bold("Install:")}
-  ${colors_default.cyan("npm install -g portless")}
-  Do NOT add portless as a project dependency.
+  ${colors_default.cyan("npm install -g portless")}          Global (recommended)
+  ${colors_default.cyan("npm install -D portless")}          Project dev dependency
 
 ${colors_default.bold("Usage:")}
   ${colors_default.cyan("portless proxy start")}             Start the proxy (HTTPS on port 443, daemon)
@@ -1378,11 +1427,18 @@ ${colors_default.bold("Reserved names:")}
   process.exit(0);
 }
 function printVersion() {
-  console.log("0.9.0");
+  console.log("0.9.2");
   process.exit(0);
 }
 async function handleTrust() {
   const { dir } = await discoverState();
+  if (!fs3.existsSync(dir)) {
+    fs3.mkdirSync(dir, { recursive: true });
+  }
+  const { caGenerated } = ensureCerts(dir);
+  if (caGenerated) {
+    console.log(colors_default.gray("Generated local CA certificate."));
+  }
   const result = trustCA(dir);
   if (result.trusted) {
     console.log(colors_default.green("Local CA added to system trust store."));
@@ -1392,10 +1448,21 @@ async function handleTrust() {
   const isPermissionError = result.error?.includes("Permission denied") || result.error?.includes("EACCES");
   if (isPermissionError && !isWindows && process.getuid?.() !== 0) {
     console.log(colors_default.yellow("Trusting the CA requires elevated privileges. Requesting sudo..."));
-    const sudoResult = spawnSync("sudo", [process.execPath, getEntryScript(), "trust"], {
-      stdio: "inherit",
-      timeout: SUDO_SPAWN_TIMEOUT_MS
-    });
+    const sudoResult = spawnSync(
+      "sudo",
+      [
+        "env",
+        ...collectPortlessEnvArgs(),
+        `PORTLESS_STATE_DIR=${dir}`,
+        process.execPath,
+        getEntryScript(),
+        "trust"
+      ],
+      {
+        stdio: "inherit",
+        timeout: SUDO_SPAWN_TIMEOUT_MS
+      }
+    );
     if (sudoResult.status === 0) return;
     console.error(colors_default.red("sudo elevation also failed."));
   }
@@ -2032,10 +2099,11 @@ async function main() {
   const args = process.argv.slice(2);
   const isNpx = process.env.npm_command === "exec" && !process.env.npm_lifecycle_event;
   const isPnpmDlx = !!process.env.PNPM_SCRIPT_SRC_DIR && !process.env.npm_lifecycle_event;
-  if (isNpx || isPnpmDlx) {
+  if ((isNpx || isPnpmDlx) && !isLocallyInstalled()) {
     console.error(colors_default.red("Error: portless should not be run via npx or pnpm dlx."));
-    console.error(colors_default.blue("Install globally instead:"));
+    console.error(colors_default.blue("Install globally or as a project dependency:"));
     console.error(colors_default.cyan("  npm install -g portless"));
+    console.error(colors_default.cyan("  npm install -D portless"));
     process.exit(1);
   }
   if (args[0] === "--name") {

package/dist/index.js

@@ -20,7 +20,7 @@ import {
   parseHostname,
   removeBlock,
   syncHostsFile
-} from "./chunk-5BR7NCNI.js";
+} from "./chunk-YDICEMNW.js";
 export {
   DIR_MODE,
   FILE_MODE,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "portless",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "description": "Replace port numbers with stable, named .localhost URLs. For humans and agents.",
   "type": "module",
   "main": "./dist/index.js",
@@ -25,17 +25,6 @@
     "linux",
     "win32"
   ],
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "lint": "eslint src/",
-    "lint:fix": "eslint src/ --fix",
-    "prepublishOnly": "cp ../../README.md . && pnpm build",
-    "test": "vitest run",
-    "test:coverage": "vitest run --coverage",
-    "test:watch": "vitest",
-    "typecheck": "tsc --noEmit"
-  },
   "keywords": [
     "local",
     "development",
@@ -48,7 +37,7 @@
     "type": "git",
     "url": "https://github.com/vercel-labs/portless.git"
   },
-  "homepage": "https://port1355.dev",
+  "homepage": "https://portless.sh",
   "bugs": {
     "url": "https://github.com/vercel-labs/portless/issues"
   },
@@ -59,5 +48,15 @@
     "tsup": "^8.0.1",
     "typescript": "^5.3.3",
     "vitest": "^4.0.18"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "lint": "eslint src/",
+    "lint:fix": "eslint src/ --fix",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "test:watch": "vitest",
+    "type-check": "tsc --noEmit"
   }
-}
+}