wip: auth

Author: antfu

packages/core/src/node/rpc/anonymous/auth.ts

@@ -0,0 +1,25 @@
+import { defineRpcFunction } from '@vitejs/devtools-kit'
+
+export interface DevToolsAuthInput {
+  authId: string
+  ua: string
+}
+
+export interface DevToolsAuthReturn {
+  isTrusted: boolean
+}
+
+export const anonymousAuth = defineRpcFunction({
+  name: 'vite:anonymous:auth',
+  type: 'action',
+  setup: (context) => {
+    return {
+      handler: (query: DevToolsAuthInput): DevToolsAuthReturn => {
+        // TODO: Implement the auth logic
+        return {
+          isTrusted: false,
+        }
+      },
+    }
+  },
+})

packages/core/src/node/rpc/index.ts

@@ -1,4 +1,5 @@
 import type { DevToolsTerminalSessionStreamChunkEvent, RpcDefinitionsFilter, RpcDefinitionsToFunctions } from '@vitejs/devtools-kit'
+import { anonymousAuth } from './anonymous/auth'
 import { docksList } from './internal/docks-list'
 import { docksOnLaunch } from './internal/docks-on-launch'
 import { rpcServerList } from './internal/rpc-server-list'
@@ -13,6 +14,10 @@ export const builtinPublicRpcDecalrations = [
   openInFinder,
 ] as const
 
+export const builtinAnonymousRpcDecalrations = [
+  anonymousAuth,
+] as const
+
 // @keep-sorted
 export const builtinInternalRpcDecalrations = [
   docksList,
@@ -24,6 +29,7 @@ export const builtinInternalRpcDecalrations = [
 
 export const builtinRpcDecalrations = [
   ...builtinPublicRpcDecalrations,
+  ...builtinAnonymousRpcDecalrations,
   ...builtinInternalRpcDecalrations,
 ] as const
 

packages/kit/package.json

@@ -44,6 +44,7 @@
     "birpc-x": "catalog:deps"
   },
   "devDependencies": {
+    "nanoid": "^5.1.6",
     "tsdown": "catalog:build",
     "vite": "catalog:build"
   }

packages/kit/src/client/rpc.ts

@@ -1,12 +1,14 @@
 import type { WebSocketRpcClientOptions } from '@vitejs/devtools-rpc/presets/ws/client'
-import type { BirpcOptions, BirpcReturn } from 'birpc'
+import type { BirpcReturn, EventOptions } from 'birpc'
 import type { ConnectionMeta, DevToolsRpcClientFunctions, DevToolsRpcServerFunctions } from '../types'
 import type { DevToolsClientContext, DevToolsClientRpcHost } from './docks'
 import { createRpcClient } from '@vitejs/devtools-rpc'
 import { createWsRpcPreset } from '@vitejs/devtools-rpc/presets/ws/client'
 import { RpcFunctionsCollectorBase } from 'birpc-x'
+import { nanoid } from 'nanoid'
 
 const CONNECTION_META_KEY = '__VITE_DEVTOOLS_CONNECTION_META__'
+const CONNECTION_AUTH_ID_KEY = '__VITE_DEVTOOLS_CONNECTION_AUTH_ID__'
 
 function isNumeric(str: string | number | undefined) {
   if (str == null)
@@ -18,7 +20,7 @@ export interface DevToolsRpcClientOptions {
   connectionMeta?: ConnectionMeta
   baseURL?: string[]
   wsOptions?: Partial<WebSocketRpcClientOptions>
-  rpcOptions?: Partial<BirpcOptions<DevToolsRpcServerFunctions>>
+  rpcOptions?: EventOptions<DevToolsRpcServerFunctions, DevToolsRpcClientFunctions>
 }
 
 export type DevToolsRpcClient = BirpcReturn<DevToolsRpcServerFunctions, DevToolsRpcClientFunctions>
@@ -27,13 +29,39 @@ export interface ClientRpcReturn {
   connectionMeta: ConnectionMeta
   rpc: DevToolsRpcClient
   clientRpc: DevToolsClientRpcHost
+  readonly isTrusted: boolean
+}
+
+function getConnectionAuthIdFromWindows(): string {
+  const getters = [
+    () => localStorage.getItem(CONNECTION_AUTH_ID_KEY),
+    () => (window as any)?.[CONNECTION_AUTH_ID_KEY],
+    () => (globalThis as any)?.[CONNECTION_AUTH_ID_KEY],
+    () => (parent.window as any)?.[CONNECTION_AUTH_ID_KEY],
+  ]
+
+  for (const getter of getters) {
+    try {
+      const value = getter()
+      if (value) {
+        if (!localStorage.getItem(CONNECTION_AUTH_ID_KEY))
+          localStorage.setItem(CONNECTION_AUTH_ID_KEY, value)
+        return value
+      }
+    }
+    catch {}
+  }
+
+  const uid = nanoid()
+  localStorage.setItem(CONNECTION_AUTH_ID_KEY, uid)
+  return uid
 }
 
 function findConnectionMetaFromWindows(): ConnectionMeta | undefined {
   const getters = [
-    () => (window as any)[CONNECTION_META_KEY],
-    () => (globalThis as any)[CONNECTION_META_KEY],
-    () => (parent.window as any)[CONNECTION_META_KEY],
+    () => (window as any)?.[CONNECTION_META_KEY],
+    () => (globalThis as any)?.[CONNECTION_META_KEY],
+    () => (parent.window as any)?.[CONNECTION_META_KEY],
   ]
 
   for (const getter of getters) {
@@ -83,22 +111,54 @@ export async function getDevToolsRpcClient(
   const context: DevToolsClientContext = {
     rpc: undefined!,
   }
+  const authId = getConnectionAuthIdFromWindows()
+
+  let isTrusted = false
   const clientRpc: DevToolsClientRpcHost = new RpcFunctionsCollectorBase<DevToolsRpcClientFunctions, DevToolsClientContext>(context)
+
+  // Builtin rpc functions
+  clientRpc.register({
+    name: 'vite:anonymous:trusted',
+    type: 'event',
+    handler: () => {
+      isTrusted = true
+      return true
+    },
+  })
+
+  // Create the RPC client
   const rpc = createRpcClient<DevToolsRpcServerFunctions, DevToolsRpcClientFunctions>(
     clientRpc.functions,
     {
       preset: createWsRpcPreset({
         url,
         ...options.wsOptions,
       }),
-      rpcOptions,
+      rpcOptions: {
+        ...rpcOptions,
+        meta: {
+          authId,
+          get isTrusted() {
+            return isTrusted
+          },
+        },
+      },
     },
   )
   // @ts-expect-error assign to readonly property
   context.rpc = rpc
 
+  // TODO: implement the trust logic
+  rpc.$call('vite:anonymous:auth', {
+    authId,
+    ua: navigator.userAgent,
+  })
+
   return {
     connectionMeta,
+    get isTrusted() {
+      return isTrusted
+    },
     rpc,
     clientRpc,
   }

packages/rpc/src/client.ts

@@ -1,14 +1,14 @@
-import type { BirpcOptions, BirpcReturn } from 'birpc'
+import type { BirpcOptions, BirpcReturn, ChannelOptions } from 'birpc'
 import { createBirpc } from 'birpc'
 
 export function createRpcClient<
-  ServerFunctions = Record<string, never>,
-  ClientFunctions extends object = Record<string, never>,
+  ServerFunctions,
+  ClientFunctions extends object,
 >(
   functions: ClientFunctions,
   options: {
-    preset: BirpcOptions<ServerFunctions>
-    rpcOptions?: Partial<BirpcOptions<ServerFunctions>>
+    preset: ChannelOptions
+    rpcOptions?: Partial<BirpcOptions<ServerFunctions, ClientFunctions>>
   },
 ): BirpcReturn<ServerFunctions, ClientFunctions> {
   const { preset, rpcOptions = {} } = options

packages/rpc/src/presets/ws/client.ts

@@ -1,3 +1,4 @@
+import type { ChannelOptions } from 'birpc'
 import type { RpcClientPreset } from '..'
 import { parse, stringify } from 'structured-clone-es'
 import { defineRpcClientPreset } from '..'
@@ -11,12 +12,7 @@ export interface WebSocketRpcClientOptions {
 
 function NOOP() {}
 
-export const createWsRpcPreset: RpcClientPreset<(options: WebSocketRpcClientOptions) => {
-  on: (handler: (data: string) => void) => void
-  post: (data: string) => void
-  serialize: (obj: any) => string
-  deserialize: (str: string) => unknown
-}> = defineRpcClientPreset((options: WebSocketRpcClientOptions) => {
+export const createWsRpcPreset: RpcClientPreset<(options: WebSocketRpcClientOptions) => ChannelOptions> = defineRpcClientPreset((options: WebSocketRpcClientOptions) => {
   const ws = new WebSocket(options.url)
   const {
     onConnected = NOOP,