unplugin-https-reverse-proxy 1.0.0 → 2.0.1

package/src/caddy/index.ts

@@ -1,18 +1,19 @@
-import { platform } from 'node:os'
-import process from 'node:process'
-import { chmodSync, createWriteStream, existsSync, mkdirSync, unlinkSync, writeFileSync } from 'node:fs'
 import { spawn } from 'node:child_process'
+import { chmodSync, createWriteStream, existsSync, mkdirSync, unlinkSync, writeFileSync } from 'node:fs'
 import { readFile, unlink, writeFile } from 'node:fs/promises'
+import { platform } from 'node:os'
+import { join } from 'node:path'
+import process from 'node:process'
 import { got } from 'got-cjs'
 import { HttpProxyAgent } from 'http-proxy-agent'
 import { HttpsProxyAgent } from 'https-proxy-agent'
 import * as lockfile from 'proper-lockfile'
-import { chmodRecursive, consola, once } from '../utils'
 import { addHost, removeHost } from '../host'
-import { TEMP_DIR, caddyFilePath, caddyLockFilePath, caddyPath, supportList } from './constants'
+import { chmodRecursive, consola, once } from '../utils'
+import { caddyFilePath, caddyLockFilePath, caddyPath, supportList, TEMP_DIR } from './constants'
 import { kill, logProgress, logProgressOver, tryPort } from './utils'
 
-export async function download() {
+export async function download(): Promise<string> {
   if (await testCaddy())
     return caddyPath
 
@@ -38,7 +39,7 @@ export async function download() {
     if (!support)
       return reject(new Error('not support'))
 
-    const dowmloadLink = `https://caddyserver.com/api/download?os=${support.platform}&arch=${support.arch}`
+    const dowmloadLink = `https://caddyserver.com/api/download?os=${support.platform}&arch=${support.arch}&p=github.com%2Fcaddyserver%2Fforwardproxy`
 
     existsSync(caddyPath) && unlinkSync(caddyPath)
 
@@ -75,7 +76,7 @@ export async function download() {
   })
 }
 
-function testCaddy() {
+function testCaddy(): Promise<boolean> {
   return new Promise((resolve, reject) => {
     if (!existsSync(caddyPath))
       return resolve(false)
@@ -123,13 +124,13 @@ export class CaddyInstant {
     this.locked = this.checkLock()
   }
 
-  checkLock() {
+  checkLock(): boolean {
     if (!existsSync(caddyLockFilePath))
       writeFileSync(caddyLockFilePath, '')
     return lockfile.checkSync(caddyLockFilePath)
   }
 
-  async getCaddyfile() {
+  async getCaddyfile(): Promise<string> {
     if (!existsSync(caddyFilePath))
       await this.initCaddyfile()
 
@@ -137,27 +138,49 @@ export class CaddyInstant {
     return this.caddyfile
   }
 
-  async initCaddyfile() {
+  async initCaddyfile(): Promise<void> {
     const contet = `
 {
   debug
   auto_https disable_redirects
 }
-    
+
+:7601 {
+  root * "${join(
+    process.platform === 'win32'
+      ? `${process.env.AppData!}/Caddy`
+      : `${process.env.HOME!}/Library/Application Support/Caddy`,
+    './pki/authorities/local',
+  )}"
+  file_server browse
+}
+
+# 正向代理配置
+:7600 {
+  bind 0.0.0.0
+  
+  forward_proxy {
+    hide_ip
+    hide_via
+    acl {
+      allow all
+    }
+  }
+}
 `
     await writeFile(caddyFilePath, contet)
     this.caddyfile = contet
   }
 
-  async writeCaddyfile() {
+  async writeCaddyfile(): Promise<void> {
     return await writeFile(caddyFilePath, this.caddyfile || '')
   }
 
-  async deleteCaddyfile() {
+  async deleteCaddyfile(): Promise<void> {
     return await unlink(caddyFilePath)
   }
 
-  async init() {
+  async init(): Promise<void> {
     await download()
     this.inited = true
   }
@@ -165,9 +188,8 @@ export class CaddyInstant {
   /**
    * @param source like `127.0.0.1:8080`
    * @param target like `test.abc.com`. And if you provide a port ,it will be ignore.
-   * @returns
    */
-  async run(source: string, target: string, options?: Partial<RunOptions>) {
+  async run(source: string, target: string, options?: Partial<RunOptions>): Promise<void> {
     source = source.replace('0.0.0.0', '127.0.0.1')
     const {
       restore = true,
@@ -214,7 +236,6 @@ ${target.split(':')[0]}${https ? '' : ':80'} {
     }
   }
 }
-
 `
 
       await this.writeCaddyfile()
@@ -230,7 +251,7 @@ ${target.split(':')[0]}${https ? '' : ':80'} {
     }
 
     return new Promise<void>((resolve, reject) => {
-      const setupCleanup = () => {
+      const setupCleanup = (): void => {
         process.on('SIGINT', async () => {
           if (this.stoped)
             return
@@ -340,7 +361,7 @@ ${target.split(':')[0]}${https ? '' : ':80'} {
     })
   }
 
-  async baseCleanup(restore: boolean = true) {
+  async baseCleanup(restore: boolean = true): Promise<void> {
     try {
       if (restore && this._source && this._target) {
         if (await removeHost(this._source.split(':')[0], this._target.split(':')[0]))

package/src/caddy/utils.ts

@@ -1,5 +1,5 @@
-import { createServer } from 'node:net'
 import { exec } from 'node:child_process'
+import { createServer } from 'node:net'
 import ora from 'ora'
 import { consola } from '../utils'
 
@@ -8,8 +8,8 @@ let spinner: ora.Ora
 /**
  * @returns whether the port is in use
  */
-export function tryPort(port: number) {
-  return new Promise<boolean>((resolve, reject) => {
+export function tryPort(port: number): Promise<boolean> {
+  return new Promise<boolean>((resolve, _reject) => {
     try {
       const server = createServer().listen(port)
       server.on('listening', () => {
@@ -23,7 +23,7 @@ export function tryPort(port: number) {
         server.close()
       })
     }
-    catch (e) {
+    catch {
       resolve(true)
     }
   })
@@ -32,9 +32,9 @@ export function tryPort(port: number) {
 /**
  * npx free-port :port
  */
-export async function kill(port: number) {
+export async function kill(port: number): Promise<void> {
   return new Promise<void>((resolve, reject) => {
-    exec(`npx @maxbo/free-port ${port} -s`, (err, stdout, stderr) => {
+    exec(`npx @maxbo/free-port ${port} -s`, (err, stdout, _stderr) => {
       if (err) {
         reject(err)
       }
@@ -46,7 +46,7 @@ export async function kill(port: number) {
   })
 }
 
-function getNumber(number: number) {
+function getNumber(number: number): string {
   if (number <= 0)
     return '0%'
   else if (number < 100)
@@ -55,7 +55,7 @@ function getNumber(number: number) {
     return '100%'
 }
 
-export function logProgress(percent: number | string) {
+export function logProgress(percent: number | string): void {
   if (!spinner) {
     // empty a line before start
     consola.log('')
@@ -68,7 +68,7 @@ export function logProgress(percent: number | string) {
   else { spinner.text = `Download Caddy: ${getNumber(Number(percent) * 100)}` }
 }
 
-export function logProgressOver() {
+export function logProgressOver(): void {
   if (!spinner) {
     spinner = ora({
       text: 'Start Download Caddy: 100%',

package/src/host/index.ts

@@ -1,6 +1,6 @@
-import process from 'node:process'
 import { exec } from 'node:child_process'
 import { chmodSync } from 'node:fs'
+import process from 'node:process'
 import { promisify } from 'node:util'
 
 import hostile from 'hostile'
@@ -9,29 +9,30 @@ import { consola } from '../utils'
 const _setHost = promisify(hostile.set)
 const _removeHost = promisify(hostile.remove)
 
-function getPathOfSystemHostsPath() {
+function getPathOfSystemHostsPath(): string {
   return process.platform === 'win32'
     ? `${process.env.windir || 'C:\\WINDOWS'}\\system32\\drivers\\etc\\hosts`
     : '/etc/hosts'
 }
 
-async function syncHost() {
-  return new Promise<boolean>((resolve, reject) => {
+async function syncHost(): Promise<boolean> {
+  return new Promise<boolean>((resolve, _reject) => {
     exec(
       process.platform === 'win32'
         ? 'ipconfig /flushdns'
         : 'sudo -E killall -HUP mDNSResponder',
-      (error, stdout, stderr) => {
+      (error, _stdout, _stderr) => {
         if (error) {
           consola.error(`exec error: ${error}`)
           return resolve(false)
         }
         return resolve(true)
-      })
+      },
+    )
   })
 }
 
-export async function addHost(ip: string, host: string) {
+export async function addHost(ip: string, host: string): Promise<boolean> {
   if (process.platform !== 'win32')
     chmodSync(getPathOfSystemHostsPath(), 0o777)
   await _setHost('127.0.0.1', 'localhost')
@@ -41,7 +42,7 @@ export async function addHost(ip: string, host: string) {
   return await syncHost()
 }
 
-export async function removeHost(ip: string, host: string) {
+export async function removeHost(ip: string, host: string): Promise<boolean> {
   if (process.platform !== 'win32')
     chmodSync(getPathOfSystemHostsPath(), 0o777)
   await _removeHost(ip, host)

package/src/index.ts

@@ -1,11 +1,12 @@
-import process from 'node:process'
 import type { UnpluginFactory } from 'unplugin'
-import { createUnplugin } from 'unplugin'
 import type { ResolvedConfig } from 'vite'
-import c from 'picocolors'
-import { consola, isAdmin, once } from './utils'
 import type { Options } from './types'
+import process from 'node:process'
+import { Table } from 'console-table-printer'
+import c from 'picocolors'
+import { createUnplugin } from 'unplugin'
 import { CaddyInstant } from './caddy'
+import { consola, generateQrcode, getIpv4List, isAdmin, once } from './utils'
 
 let config: ResolvedConfig
 
@@ -13,6 +14,42 @@ let caddy: CaddyInstant
 
 const cwd = process.cwd()
 
+function colorUrl(url: string): string {
+  return c.green(url.replace(/:(\d+)\//, (_, port) => `:${c.bold(port)}/`))
+}
+
+async function printForwardProxy(): Promise<void> {
+  const ipv4List = getIpv4List()
+  if (ipv4List.length) {
+    const ips = ipv4List.map(ip => c.cyan(ip)).join(', ')
+    consola.info(`${c.bold('Mobile device proxy access')}:\n`)
+    consola.info('1. Install certificate: scan the QR code and download the \`root.crt\` file,')
+    consola.info('   then install it on your mobile device')
+
+    const ipTable = await Promise.all(
+      ipv4List.map(async ip => ({
+        target: `http://${ip}:7601`,
+        certificate: await generateQrcode(`http://${ip}:7601`),
+      })),
+    )
+
+    const table = new Table({
+      columns: [
+        { name: 'target', alignment: 'left' },
+        { name: 'certificate', alignment: 'center', minLen: 28 },
+      ],
+    })
+
+    ipTable.forEach((ip) => {
+      table.addRow(ip)
+    })
+
+    table.printTable()
+
+    consola.info(`2. Set proxy on mobile device (Available IPs: ${ips}):${c.bold(7600)}\n\n`)
+  }
+}
+
 export const vitePrintUrls = once((
   options: Options,
   source: string,
@@ -28,8 +65,9 @@ export const vitePrintUrls = once((
   caddy.run(source, target, {
     base,
     ...options,
-  }).then(() => {
-    const colorUrl = (url: string) => c.green(url.replace(/:(\d+)\//, (_, port) => `:${c.bold(port)}/`))
+  }).then(async () => {
+    await printForwardProxy()
+
     consola.success(`  ${c.green('➜')}  ${c.bold('run caddy reverse proxy success')}: ${colorUrl(`${options.https ? 'https' : 'http'}://${target}${base}`)}`)
   }).catch((e) => {
     throw e
@@ -64,6 +102,11 @@ export const unpluginFactory: UnpluginFactory<Options> = options => ({
         return
       }
 
+      if (target.match(/^(?:https?)?:\/\//)) {
+        consola.fail('target must be a domain')
+        return
+      }
+
       const _printUrls = server.printUrls.bind(server)
 
       let source = `localhost:${config.server.port || 5173}`
@@ -100,6 +143,11 @@ export const unpluginFactory: UnpluginFactory<Options> = options => ({
       return
     }
 
+    if (target.match(/^(?:https?)?:\/\//)) {
+      consola.fail('target must be a domain')
+      return
+    }
+
     const devServer = {
       host: 'localhost',
       port: 8080,
@@ -131,9 +179,9 @@ export const unpluginFactory: UnpluginFactory<Options> = options => ({
     caddy.run(source, target, {
       ...options,
     }).then(() => {
-      const colorUrl = (url: string) => c.green(url.replace(/:(\d+)\//, (_, port) => `:${c.bold(port)}/`))
+      compiler.hooks.done.tap('unplugin-https-reverse-proxy', async () => {
+        await printForwardProxy()
 
-      compiler.hooks.done.tap('unplugin-https-reverse-proxy', () => {
         consola.success(`  ${c.green('➜')}  ${c.bold('run caddy reverse proxy success')}: ${colorUrl(`${options.https ? 'https' : 'http'}://${target}`)}`)
       })
     }).catch((e) => {
@@ -162,6 +210,11 @@ export const unpluginFactory: UnpluginFactory<Options> = options => ({
       return
     }
 
+    if (target.match(/^(?:https?)?:\/\//)) {
+      consola.fail('target must be a domain')
+      return
+    }
+
     const devServer = {
       host: 'localhost',
       port: 8080,
@@ -180,8 +233,8 @@ export const unpluginFactory: UnpluginFactory<Options> = options => ({
 
     caddy.run(source, target, {
       ...options,
-    }).then(() => {
-      const colorUrl = (url: string) => c.green(url.replace(/:(\d+)\//, (_, port) => `:${c.bold(port)}/`))
+    }).then(async () => {
+      await printForwardProxy()
 
       consola.success(`  ${c.green('➜')}  ${c.bold('run caddy reverse proxy success')}: ${colorUrl(`${options.https ? 'https' : 'http'}://${target}`)}`)
     }).catch((e) => {

package/src/nuxt.ts

@@ -1,9 +1,9 @@
+import type { Options } from './types'
 import process from 'node:process'
 import { defineNuxtModule } from '@nuxt/kit'
-import type { Options } from './types'
-import '@nuxt/schema'
-import { consola, isAdmin } from './utils'
 import { vitePrintUrls } from '.'
+import { consola, isAdmin } from './utils'
+import '@nuxt/schema'
 
 export interface ModuleOptions extends Options {
 
@@ -36,6 +36,11 @@ export default defineNuxtModule<ModuleOptions>({
       return
     }
 
+    if (target.match(/^(?:https?)?:\/\//)) {
+      consola.fail('target must be a domain')
+      return
+    }
+
     // https://github.com/nuxt/cli/issues/220#issuecomment-1735394141
     _nuxt.hook('listen', (_, listener) => {
       const url = listener.url

package/src/utils.ts

@@ -1,14 +1,17 @@
-import process from 'node:process'
-import path from 'node:path'
-import { chmod, readdir, stat } from 'node:fs/promises'
 import { execSync } from 'node:child_process'
+import { chmod, readdir, stat } from 'node:fs/promises'
+import { networkInterfaces } from 'node:os'
+import path from 'node:path'
+import process from 'node:process'
 import { createConsola } from 'consola'
+import c from 'picocolors'
+import qrcode from 'qrcode-terminal'
 
 export const consola = createConsola({
   level: 3,
 }).withTag('reverse-proxy')
 
-export async function chmodRecursive(_path: string, mode: number) {
+export async function chmodRecursive(_path: string, mode: number): Promise<void> {
   await chmod(_path, mode)
   if ((await stat(_path)).isDirectory()) {
     const children = await readdir(_path)
@@ -27,7 +30,7 @@ export function once<T extends (...args: any[]) => any>(fn: T): (...args: Parame
   }
 }
 
-export function isAdmin() {
+export function isAdmin(): boolean {
   if (process.platform === 'win32') {
     try {
       execSync('net session', { stdio: 'ignore' })
@@ -38,6 +41,30 @@ export function isAdmin() {
     }
   }
   else {
-    return process.getuid && process.getuid() === 0
+    return !!(process.getuid && process.getuid() === 0)
   }
 }
+
+export function getIpv4List(): string[] {
+  const interfaces = networkInterfaces()
+
+  return Object.values(interfaces)
+    .flatMap(nInterface => nInterface ?? [])
+    .filter(
+      detail =>
+        detail.address
+        && (detail.family === 'IPv4'
+        // @ts-expect-error Node 18.0 - 18.3 returns number
+          || detail.family === 4),
+    )
+    .filter(detail => detail.family === 'IPv4' && !detail.internal)
+    .map(detail => detail.address)
+}
+
+export async function generateQrcode(input: string): Promise<string> {
+  return new Promise((resolve) => {
+    qrcode.generate(input, { small: true }, (code) => {
+      resolve(code.split('\n').map(line => c.bgBlack(c.white(line))).join('\n'))
+    })
+  })
+}