旧版增强功能 · 参数说明

脚本分派连接的功能怎样读取请求信息并决定去向

先弄清策略返回值,再编写 main(ctx, metadata) 的判断逻辑。需要按目标地址匹配时,解析结果必须写回 metadata,随后才能交给相应规则集合处理。

  • Script
  • metadata
  • resolve_ip
  • geoip
  • rule_providers

旧配置与现用环境的区别

旧版内核的参数约定与现用软件可能不同。遇到权限要求、平台边界或增强功能说明时,应结合正在使用的程序核查;不要把历史配置直接覆盖到现有环境。

核对正在使用的内核时,可阅读 现行参数说明;涉及应用界面或系统授权,再查阅 应用项目的操作说明 确认具体操作。

脚本入口接收连接信息与运行上下文,并返回本次连接采用的策略。旧版增强内核使用 Python 编写这段判断逻辑。

策略可以由主函数统一决定,也能把局部判断接入常规规则。下方示例采用主函数方式,快捷逻辑的写法另见脚本快捷逻辑说明。

由主函数决定连接策略

yaml
mode: Script

# https://lancellc.gitbook.io/clash/clash-config-file/script
script:
  code: |
    def main(ctx, metadata):
      ip = metadata["dst_ip"] = ctx.resolve_ip(metadata["host"])
      if ip == "":
        return "DIRECT"

      code = ctx.geoip(ip)
      if code == "LAN" or code == "CN":
        return "DIRECT"

      return "Proxy" # default policy for requests which are not matched by any other script

目标地址尚未解析时,IP-CIDR 或 GEOIP 条件无法直接依靠域名完成判断。先取得地址并填写 metadata,再调用对应匹配方法:

python
def main(ctx, metadata):
    # ctx.rule_providers["geoip"].match(metadata) return false

    ip = ctx.resolve_ip(metadata["host"])
    if ip == "":
        return "DIRECT"
    metadata["dst_ip"] = ip

    # ctx.rule_providers["iprule"].match(metadata) return true

    return "Proxy"

编写逻辑时,可按下列声明核查连接字段与上下文方法的类型:

ts
interface Metadata {
  type: string // socks5、http
  network: string // tcp
  host: string
  src_ip: string
  src_port: string
  dst_ip: string
  dst_port: string
  inbound_port: number
}

interface Context {
  resolve_ip: (host: string) => string // ip string
  resolve_process_name: (metadata: Metadata) => string
  resolve_process_path: (metadata: Metadata) => string
  geoip: (ip: string) => string // country code
  log: (log: string) => void
  proxy_providers: Record<string, Array<{ name: string, alive: boolean, delay: number }>>
  rule_providers: Record<string, { match: (metadata: Metadata) => boolean }>
}