unplugin-https-reverse-proxy 4.0.4 → 4.1.0-beta.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. package/README.md +30 -6
  2. package/dist/{chunk-2P7SUCQ3.js → chunk-EY3HXBJ4.js} +0 -26
  3. package/dist/chunk-RKHJN6KY.js +53 -0
  4. package/dist/{chunk-5R33PUJP.js → chunk-U7KAIPZC.js} +981 -796
  5. package/dist/chunk-WOMR3ZLM.js +17 -0
  6. package/dist/esbuild.cjs +1077 -864
  7. package/dist/esbuild.js +4 -2
  8. package/dist/index.cjs +1077 -864
  9. package/dist/index.js +4 -2
  10. package/dist/nuxt.cjs +1049 -850
  11. package/dist/nuxt.js +6 -9
  12. package/dist/privilege-state.cjs +44 -0
  13. package/dist/privilege-state.d.cts +7 -0
  14. package/dist/privilege-state.d.ts +7 -0
  15. package/dist/privilege-state.js +10 -0
  16. package/dist/privileged-helper.cjs +824 -0
  17. package/dist/privileged-helper.d.cts +2 -0
  18. package/dist/privileged-helper.d.ts +2 -0
  19. package/dist/privileged-helper.js +797 -0
  20. package/dist/rollup.cjs +1077 -864
  21. package/dist/rollup.js +4 -2
  22. package/dist/rspack.cjs +1077 -864
  23. package/dist/rspack.js +4 -2
  24. package/dist/utils.cjs +0 -28
  25. package/dist/utils.d.cts +1 -3
  26. package/dist/utils.d.ts +1 -3
  27. package/dist/utils.js +1 -5
  28. package/dist/vite.cjs +1077 -864
  29. package/dist/vite.js +4 -2
  30. package/dist/webpack.cjs +1077 -864
  31. package/dist/webpack.js +4 -2
  32. package/package.json +1 -4
  33. package/src/caddy/caddyfile.ts +3 -0
  34. package/src/caddy/config.ts +195 -53
  35. package/src/caddy/constants.ts +30 -1
  36. package/src/caddy/index.ts +239 -206
  37. package/src/caddy/privileged.ts +124 -0
  38. package/src/caddy/utils.ts +0 -43
  39. package/src/index.ts +49 -22
  40. package/src/nuxt.ts +1 -6
  41. package/src/privilege-state.ts +23 -0
  42. package/src/privileged/bootstrap.ts +289 -0
  43. package/src/privileged/client.ts +288 -0
  44. package/src/privileged/entry.ts +73 -0
  45. package/src/privileged/hosts-file.ts +142 -0
  46. package/src/privileged/launch.ts +332 -0
  47. package/src/privileged/path-guard.ts +74 -0
  48. package/src/privileged/ports.ts +45 -0
  49. package/src/privileged/protocol.ts +111 -0
  50. package/src/privileged/server.ts +578 -0
  51. package/src/privileged/session.ts +169 -0
  52. package/src/privileged/validation.ts +38 -0
  53. package/src/privileged/windows-elevation.ts +80 -0
  54. package/src/privileged-helper.ts +123 -0
  55. package/src/utils.ts +0 -28
  56. package/src/host/index.ts +0 -52
package/README.md CHANGED
@@ -314,15 +314,39 @@ Please check [caddy path](https://github.com/zcf0508/unplugin-https-reverse-prox
314
314
  ## Usage
315
315
 
316
316
  ```bash
317
- # macOS
318
- sudo -E npm run dev # your dev script
319
- # ^ `-E` is important
320
-
321
- # windows
322
- # use powershell as administrator
317
+ # macOS / Linux / Windows
323
318
  npm run dev # your dev script
324
319
  ```
325
320
 
321
+ Run it as your normal user. The plugin starts a small privileged helper that
322
+ runs as administrator, and only that helper touches `/etc/hosts` and ports
323
+ 80/443. Your dev server, its caches and `node_modules` stay owned by you.
324
+
325
+ On macOS and Linux the plugin asks for your password once when the dev server
326
+ starts, then reuses the sudo credential for the rest of the session. If you
327
+ already ran `sudo -v` in the same terminal, no prompt is shown.
328
+
329
+ The helper restores the hosts entries by itself when the dev server exits,
330
+ including when it is killed or crashes.
331
+
332
+ ### Granting the permission once (optional)
333
+
334
+ To skip the password prompt entirely, allow the plugin's helper in
335
+ `/etc/sudoers.d/` (edit with `sudo visudo -f /etc/sudoers.d/uhrp`):
336
+
337
+ ```
338
+ yourname ALL=(root) NOPASSWD: /usr/bin/killall -HUP mDNSResponder
339
+ yourname ALL=(root) NOPASSWD: /usr/bin/install -m 644 -o root -g wheel /tmp/uhrp-hosts.* /etc/hosts
340
+ ```
341
+
342
+ The second rule only matters when the helper rewrites `/etc/hosts` through
343
+ `install`; adjust the paths to your platform.
344
+
345
+ ### Windows
346
+
347
+ Run `npm run dev` normally. Windows raises a UAC prompt once, when the helper
348
+ is started through `Start-Process -Verb RunAs`.
349
+
326
350
  If your broswer shows a not trusted certificate warning, please check the keychain.
327
351
 
328
352
  ![keychain](https://github.com/zcf0508/unplugin-https-reverse-proxy/blob/main/images/Snipaste_2023-11-16_16-59-55.png)
@@ -1,23 +1,11 @@
1
1
  // src/utils.ts
2
- import { execSync } from "node:child_process";
3
- import { chmod, readdir, stat } from "node:fs/promises";
4
2
  import { networkInterfaces } from "node:os";
5
- import path from "node:path";
6
- import process from "node:process";
7
3
  import { createConsola } from "consola";
8
4
  import c from "picocolors";
9
5
  import qrcode from "qrcode-terminal";
10
6
  var consola = createConsola({
11
7
  level: 3
12
8
  }).withTag("reverse-proxy");
13
- async function chmodRecursive(_path, mode) {
14
- await chmod(_path, mode);
15
- if ((await stat(_path)).isDirectory()) {
16
- const children = await readdir(_path);
17
- for (const child of children)
18
- await chmodRecursive(path.join(_path, child), mode);
19
- }
20
- }
21
9
  function once(fn) {
22
10
  let called = false;
23
11
  return (...args) => {
@@ -27,18 +15,6 @@ function once(fn) {
27
15
  return fn(...args);
28
16
  };
29
17
  }
30
- function isAdmin() {
31
- if (process.platform === "win32") {
32
- try {
33
- execSync("net session", { stdio: "ignore" });
34
- return true;
35
- } catch {
36
- return false;
37
- }
38
- } else {
39
- return !!(process.getuid && process.getuid() === 0);
40
- }
41
- }
42
18
  function getIpv4List() {
43
19
  const interfaces = networkInterfaces();
44
20
  return Object.values(interfaces).flatMap((nInterface) => nInterface ?? []).filter(
@@ -55,9 +31,7 @@ async function generateQrcode(input) {
55
31
 
56
32
  export {
57
33
  consola,
58
- chmodRecursive,
59
34
  once,
60
- isAdmin,
61
35
  getIpv4List,
62
36
  generateQrcode
63
37
  };
@@ -0,0 +1,53 @@
1
+ // src/privileged/protocol.ts
2
+ function serializeMessage(message) {
3
+ return `${JSON.stringify(message)}
4
+ `;
5
+ }
6
+ function splitLines(buffer, chunk) {
7
+ const parts = (buffer + chunk).split("\n");
8
+ const rest = parts.pop() ?? "";
9
+ return { lines: parts.filter((line) => line.trim() !== ""), rest };
10
+ }
11
+ function isRecord(value) {
12
+ return typeof value === "object" && value !== null;
13
+ }
14
+ function decodeMessage(line) {
15
+ let parsed;
16
+ try {
17
+ parsed = JSON.parse(line);
18
+ } catch (error) {
19
+ return { ok: false, error: `invalid JSON: ${error.message}` };
20
+ }
21
+ if (!isRecord(parsed))
22
+ return { ok: false, error: "message must be an object" };
23
+ if (parsed.type === "event") {
24
+ if (typeof parsed.kind !== "string")
25
+ return { ok: false, error: "event.kind must be a string" };
26
+ return { ok: true, message: parsed };
27
+ }
28
+ if (typeof parsed.id !== "number")
29
+ return { ok: false, error: "response.id must be a number" };
30
+ if (parsed.ok === true)
31
+ return { ok: true, message: { id: parsed.id, ok: true, result: parsed.result } };
32
+ if (parsed.ok === false) {
33
+ const error = isRecord(parsed.error) ? parsed.error : {};
34
+ return {
35
+ ok: true,
36
+ message: {
37
+ id: parsed.id,
38
+ ok: false,
39
+ error: {
40
+ message: typeof error.message === "string" ? error.message : "helper request failed",
41
+ code: typeof error.code === "string" ? error.code : void 0
42
+ }
43
+ }
44
+ };
45
+ }
46
+ return { ok: false, error: "response.ok must be a boolean" };
47
+ }
48
+
49
+ export {
50
+ serializeMessage,
51
+ splitLines,
52
+ decodeMessage
53
+ };