Skip to main content

mitm

实例名实例描述
grpcMitmKey(string) "grpc_mitm_extra_conn_key"
函数名函数描述/介绍
mitm.AddMITMRootCertIntoSystemAddMITMRootCertIntoSystem 将 MITM 根证书添加到 Linux 系统信任库 支持多个发行版的证书安装路径
mitm.BridgeBridge 启动一个 MITM (中间人)代理服务器，它的第一个参数是端口，第二个参数是下游代理服务器地址，接下来可以接收零个到多个选项函数，用于影响中间人代理服务器的行为 Bridge 与 Start 类似，但略有不同，Bridge可以指定下游代理服务器地址，同时默认会在接收到请求和响应时打印...
mitm.GetDefaultExtraConnManager
mitm.QuickVerifyMITMRootCertQuickVerifyMITMRootCert 快速验证证书状态（不启动服务器，只检查系统证书池）
mitm.StartStart 启动一个 MITM (中间人)代理服务器，它的第一个参数是端口，接下来可以接收零个到多个选项函数，用于影响中间人代理服务器的行为 如果没有指定 CA 证书和私钥，那么将使用内置的证书和私钥
mitm.TestCertificateOperationsTestCertificateOperations 测试证书的安装、验证和撤销操作
mitm.VerifyMITMRootCertInstalledVerifyMITMRootCertInstalled 验证 MITM 根证书是否已正确安装到系统信任库 验证方法： 1. 使用 MITM 根证书启动一个临时 HTTPS 服务器 2. 使用系统证书池（不跳过验证）连接到该服务器 3. 如果连接成功且 TLS 握手完成，说明证书已正确安装
mitm.VerifyMITMRootCertNotInstalledVerifyMITMRootCertNotInstalled 验证 MITM 根证书是否已从系统信任库中移除 验证方法：与 VerifyMITMRootCertInstalled 相反，连接应该失败
mitm.WithdrawMITMRootCertFromSystemWithdrawMITMRootCertFromSystem 从 Linux 系统信任库中移除 MITM 根证书
mitm.callbackcallback 是一个选项函数，用于指定中间人代理服务器的回调函数，当接收到请求和响应后，会调用该回调函数
mitm.contextcontext 是一个选项函数，用于指定中间人代理服务器的上下文
mitm.extraIncomingConnextraIncomingConn 是一个选项函数，用于指定中间人代理服务器接受外部传入的连接通道 通过该选项，可以将外部的 net.Conn 连接注入到 MITM 服务器中进行劫持处理
mitm.extraIncomingConnChanWithStrongLocalHostextraIncomingConnChanWithStrongLocalHost 是一个选项函数，用于指定中间人代理服务器接受外部传入的连接通道 强制要求设置强主机模式的本地地址，用于透明劫持 TUN 生成的流量
mitm.gmRootCAgmRootCA 是一个选项函数，用于指定中间人代理服务器的国密根证书和私钥
mitm.gmtlsgmtls 是一个选项参数，用于指定中间人代理服务器是否开启 GMTLS 劫持模式，默认为false 在开启 GMTLS 劫持模式下，中间人代理服务器会劫持所有的 GMTLS 流量
mitm.gmtlsOnlygmtlsOnly 是一个选项参数，用于指定中间人代理服务器是否只使用 GMTLS 劫持模式，默认为false 在开启 GMTLS 劫持模式下，中间人代理服务器只会使用 GMTLS 劫持模式
mitm.gmtlsPrefergmtlsPrefer 是一个选项参数，用于指定中间人代理服务器是否优先使用 GMTLS 劫持模式，默认为false 在开启 GMTLS 劫持模式下，中间人代理服务器会优先使用 GMTLS 劫持模式
mitm.hijackHTTPRequesthijackHTTPRequest 是一个选项函数，用于指定中间人代理服务器的请求劫持函数，当接收到请求后，会调用该回调函数 通过调用该回调函数的第四个参数，可以修改请求内容，通过调用该回调函数的第五个参数，可以丢弃请求
mitm.hijackHTTPResponsehijackHTTPResponse 是一个选项函数，用于指定中间人代理服务器的响应劫持函数，当接收到响应后，会调用该回调函数 通过调用该回调函数的第四个参数，可以修改响应内容，通过调用该回调函数的第五个参数，可以丢弃响应
mitm.hijackHTTPResponseExhijackHTTPResponseEx 是一个选项函数，用于指定中间人代理服务器的响应劫持函数，当接收到响应后，会调用该回调函数 通过调用该回调函数的第五个参数，可以修改响应内容，通过调用该回调函数的第六个参数，可以丢弃响应 它与 hijackHTTPResponse 的区别在于，它可以获取到...
mitm.hosthost 是一个选项函数，用于指定中间人代理服务器的监听地址，默认为空，即监听所有网卡
mitm.isTransparentisTransparent 是一个选项函数，用于指定中间人代理服务器是否开启透明劫持模式，默认为false 在开启透明模式下，所有流量都会被默认转发，所有的回调函数都会被忽略
mitm.maxContentLengthmaxContentLength 是一个选项函数，用于指定中间人代理服务器的最大的请求和响应内容长度，默认为10MB
mitm.mockHTTPRequestmockHTTPRequest 是一个选项函数，用于指定中间人代理服务器的请求 mock 函数 当接收到请求后，会调用该回调函数，通过调用 mockResponse 函数可以直接返回自定义响应，跳过真实的网络请求 mockResponse 接受一个响应（字符串或字节数组），会自动修复响应格式，如...
mitm.randomJA3randomJA3 是一个选项函数，用于指定中间人代理服务器是否开启随机 JA3 劫持模式，默认为false
mitm.rootCArootCA 是一个选项函数，用于指定中间人代理服务器的根证书和私钥
mitm.useDefaultCAuseDefaultCA 是一个选项函数，用于指定中间人代理服务器是否使用内置的证书和私钥，默认为true 默认的证书与私钥路径：~/yakit-projects/yak-mitm-ca.crt 和 ~/yakit-projects/yak-mitm-ca.key
mitm.wscallbackwscallback 是一个选项函数，用于指定中间人代理服务器的 websocket 劫持函数，当接收到 websocket 请求或响应后，会调用该回调函数 该回调函数的第一个参数是请求或响应的内容 第二个参数是一个布尔值，用于指示该内容是请求还是响应，true 表示请求，false 表示响应 ...
mitm.wsforcetextwsforcetext 是一个选项函数，用于强制指定中间人代理服务器的 websocket 劫持的数据帧转换为文本帧，默认为false ! 已弃用

函数定义#

AddMITMRootCertIntoSystem#

详细描述#

AddMITMRootCertIntoSystem 将 MITM 根证书添加到 Linux 系统信任库 支持多个发行版的证书安装路径

定义#

AddMITMRootCertIntoSystem() error

返回值#

返回值(顺序)返回值类型返回值解释
r1error

Bridge#

详细描述#

Bridge 启动一个 MITM (中间人)代理服务器，它的第一个参数是端口，第二个参数是下游代理服务器地址，接下来可以接收零个到多个选项函数，用于影响中间人代理服务器的行为

Bridge 与 Start 类似，但略有不同，Bridge可以指定下游代理服务器地址，同时默认会在接收到请求和响应时打印到标准输出

如果没有指定 CA 证书和私钥，那么将使用内置的证书和私钥

Example:

mitm.Bridge(8080, "", mitm.host("127.0.0.1"), mitm.callback(func(isHttps, urlStr, req, rsp) { http.dump(req); http.dump(rsp)  })) // 启动一个中间人代理服务器，并将请求和响应打印到标准输出

定义#

Bridge(port any, downstreamProxy string, opts ...MitmConfigOpt) error

参数#

参数名参数类型参数解释
portany
downstreamProxystring
opts...MitmConfigOpt

返回值#

返回值(顺序)返回值类型返回值解释
r1error

GetDefaultExtraConnManager#

详细描述#

定义#

GetDefaultExtraConnManager() *MitmExtraConnManager

返回值#

返回值(顺序)返回值类型返回值解释
r1*MitmExtraConnManager

QuickVerifyMITMRootCert#

详细描述#

QuickVerifyMITMRootCert 快速验证证书状态（不启动服务器，只检查系统证书池）

定义#

QuickVerifyMITMRootCert() (bool, error)

返回值#

返回值(顺序)返回值类型返回值解释
r1bool
r2error

Start#

详细描述#

Start 启动一个 MITM (中间人)代理服务器，它的第一个参数是端口，接下来可以接收零个到多个选项函数，用于影响中间人代理服务器的行为

如果没有指定 CA 证书和私钥，那么将使用内置的证书和私钥

Example:

mitm.Start(8080, mitm.host("127.0.0.1"), mitm.callback(func(isHttps, urlStr, req, rsp) { http.dump(req); http.dump(rsp)  })) // 启动一个中间人代理服务器，并将请求和响应打印到标准输出

定义#

Start(port int, opts ...MitmConfigOpt) error

参数#

参数名参数类型参数解释
portint
opts...MitmConfigOpt

返回值#

返回值(顺序)返回值类型返回值解释
r1error

TestCertificateOperations#

详细描述#

TestCertificateOperations 测试证书的安装、验证和撤销操作

定义#

TestCertificateOperations() error

返回值#

返回值(顺序)返回值类型返回值解释
r1error

VerifyMITMRootCertInstalled#

详细描述#

VerifyMITMRootCertInstalled 验证 MITM 根证书是否已正确安装到系统信任库 验证方法：

  1. 使用 MITM 根证书启动一个临时 HTTPS 服务器
  2. 使用系统证书池（不跳过验证）连接到该服务器
  3. 如果连接成功且 TLS 握手完成，说明证书已正确安装

定义#

VerifyMITMRootCertInstalled() error

返回值#

返回值(顺序)返回值类型返回值解释
r1error

VerifyMITMRootCertNotInstalled#

详细描述#

VerifyMITMRootCertNotInstalled 验证 MITM 根证书是否已从系统信任库中移除 验证方法：与 VerifyMITMRootCertInstalled 相反，连接应该失败

定义#

VerifyMITMRootCertNotInstalled() error

返回值#

返回值(顺序)返回值类型返回值解释
r1error

WithdrawMITMRootCertFromSystem#

详细描述#

WithdrawMITMRootCertFromSystem 从 Linux 系统信任库中移除 MITM 根证书

定义#

WithdrawMITMRootCertFromSystem() error

返回值#

返回值(顺序)返回值类型返回值解释
r1error

callback#

详细描述#

callback 是一个选项函数，用于指定中间人代理服务器的回调函数，当接收到请求和响应后，会调用该回调函数

Example:

mitm.Start(8080, mitm.callback(func(isHttps, urlStr, req, rsp) { http.dump(req); http.dump(rsp)  }))

定义#

callback(f func(bool, string, *http.Request, *http.Response)) MitmConfigOpt

参数#

参数名参数类型参数解释
ffunc(bool, string, *http.Request, *http.Response)

返回值#

返回值(顺序)返回值类型返回值解释
r1MitmConfigOpt

context#

详细描述#

context 是一个选项函数，用于指定中间人代理服务器的上下文

Example:

mitm.Start(8080, mitm.context(context.Background()))

定义#

context(ctx context.Context) MitmConfigOpt

参数#

参数名参数类型参数解释
ctxcontext.Context

返回值#

返回值(顺序)返回值类型返回值解释
r1MitmConfigOpt

extraIncomingConn#

详细描述#

extraIncomingConn 是一个选项函数，用于指定中间人代理服务器接受外部传入的连接通道

通过该选项，可以将外部的 net.Conn 连接注入到 MITM 服务器中进行劫持处理

Example:

connChan = make(chan net.Conn)mitm.Start(8080, mitm.extraIncomingConn(connChan))

定义#

extraIncomingConn(ch any) MitmConfigOpt

参数#

参数名参数类型参数解释
chany

返回值#

返回值(顺序)返回值类型返回值解释
r1MitmConfigOpt

extraIncomingConnChanWithStrongLocalHost#

详细描述#

extraIncomingConnChanWithStrongLocalHost 是一个选项函数，用于指定中间人代理服务器接受外部传入的连接通道

强制要求设置强主机模式的本地地址，用于透明劫持 TUN 生成的流量

Example:

connChan = make(chan net.Conn)mitm.Start(8080, mitm.extraIncomingConnChanWithStrongLocalHost("192.168.1.100", connChan))  // 设置强主机模式本地地址mitm.Start(8080, mitm.extraIncomingConnChanWithStrongLocalHost("192.168.1.100", connChan, {"key": "value"}))  // 设置强主机模式本地地址并设置元数据

定义#

extraIncomingConnChanWithStrongLocalHost(localAddr any, ch any, kv ...any) MitmConfigOpt

参数#

参数名参数类型参数解释
localAddrany
chany
kv...any

返回值#

返回值(顺序)返回值类型返回值解释
r1MitmConfigOpt

gmRootCA#

详细描述#

gmRootCA 是一个选项函数，用于指定中间人代理服务器的国密根证书和私钥

Example:

mitm.Start(8080, mitm.gmRootCA(cert, key))

定义#

gmRootCA(cert []byte, key []byte) MitmConfigOpt

参数#

参数名参数类型参数解释
cert[]byte
key[]byte

返回值#

返回值(顺序)返回值类型返回值解释
r1MitmConfigOpt

gmtls#

详细描述#

gmtls 是一个选项参数，用于指定中间人代理服务器是否开启 GMTLS 劫持模式，默认为false

在开启 GMTLS 劫持模式下，中间人代理服务器会劫持所有的 GMTLS 流量

Example:

mitm.Start(8080, mitm.gmtls(true))

定义#

gmtls(b bool) MitmConfigOpt

参数#

参数名参数类型参数解释
bbool

返回值#

返回值(顺序)返回值类型返回值解释
r1MitmConfigOpt

gmtlsOnly#

详细描述#

gmtlsOnly 是一个选项参数，用于指定中间人代理服务器是否只使用 GMTLS 劫持模式，默认为false

在开启 GMTLS 劫持模式下，中间人代理服务器只会使用 GMTLS 劫持模式

Example:

mitm.Start(8080, mitm.gmtlsOnly(true))

定义#

gmtlsOnly(b bool) MitmConfigOpt

参数#

参数名参数类型参数解释
bbool

返回值#

返回值(顺序)返回值类型返回值解释
r1MitmConfigOpt

gmtlsPrefer#

详细描述#

gmtlsPrefer 是一个选项参数，用于指定中间人代理服务器是否优先使用 GMTLS 劫持模式，默认为false

在开启 GMTLS 劫持模式下，中间人代理服务器会优先使用 GMTLS 劫持模式

Example:

mitm.Start(8080, mitm.gmtlsPrefer(true))

定义#

gmtlsPrefer(b bool) MitmConfigOpt

参数#

参数名参数类型参数解释
bbool

返回值#

返回值(顺序)返回值类型返回值解释
r1MitmConfigOpt

hijackHTTPRequest#

详细描述#

hijackHTTPRequest 是一个选项函数，用于指定中间人代理服务器的请求劫持函数，当接收到请求后，会调用该回调函数

通过调用该回调函数的第四个参数，可以修改请求内容，通过调用该回调函数的第五个参数，可以丢弃请求

Example:

mitm.Start(8080, mitm.hijackHTTPRequest(func(isHttps, urlStr, req, modified, dropped) {// 添加一个额外的请求头req = poc.ReplaceHTTPPacketHeader(req, "AAA", "BBB")modified(req)}))

定义#

hijackHTTPRequest(h func(isHttps bool, u string, req []byte, modified func([]byte), dropped func())) MitmConfigOpt

参数#

参数名参数类型参数解释
hfunc(isHttps bool, u string, req []byte, modified func([]byte), dropped func())

返回值#

返回值(顺序)返回值类型返回值解释
r1MitmConfigOpt

hijackHTTPResponse#

详细描述#

hijackHTTPResponse 是一个选项函数，用于指定中间人代理服务器的响应劫持函数，当接收到响应后，会调用该回调函数

通过调用该回调函数的第四个参数，可以修改响应内容，通过调用该回调函数的第五个参数，可以丢弃响应

Example:

mitm.Start(8080, mitm.hijackHTTPResponse(func(isHttps, urlStr, rsp, modified, dropped) {// 修改响应体为hijackedrsp = poc.ReplaceBody(rsp, b"hijacked", false)modified(rsp)}))

定义#

hijackHTTPResponse(h func(isHttps bool, u string, rsp []byte, modified func([]byte), dropped func())) MitmConfigOpt

参数#

参数名参数类型参数解释
hfunc(isHttps bool, u string, rsp []byte, modified func([]byte), dropped func())

返回值#

返回值(顺序)返回值类型返回值解释
r1MitmConfigOpt

hijackHTTPResponseEx#

详细描述#

hijackHTTPResponseEx 是一个选项函数，用于指定中间人代理服务器的响应劫持函数，当接收到响应后，会调用该回调函数

通过调用该回调函数的第五个参数，可以修改响应内容，通过调用该回调函数的第六个参数，可以丢弃响应

它与 hijackHTTPResponse 的区别在于，它可以获取到原始请求报文

Example:

mitm.Start(8080, mitm.hijackHTTPResponseEx(func(isHttps, urlStr, req, rsp, modified, dropped) {// 修改响应体为hijackedrsp = poc.ReplaceBody(rsp, b"hijacked", false)modified(rsp)}))

定义#

hijackHTTPResponseEx(h func(bool, string, []byte, []byte, func([]byte), func())) MitmConfigOpt

参数#

参数名参数类型参数解释
hfunc(bool, string, []byte, []byte, func([]byte), func())

返回值#

返回值(顺序)返回值类型返回值解释
r1MitmConfigOpt

host#

详细描述#

host 是一个选项函数，用于指定中间人代理服务器的监听地址，默认为空，即监听所有网卡

Example:

mitm.Start(8080, mitm.host("127.0.0.1"))

定义#

host(host string) MitmConfigOpt

参数#

参数名参数类型参数解释
hoststring

返回值#

返回值(顺序)返回值类型返回值解释
r1MitmConfigOpt

isTransparent#

详细描述#

isTransparent 是一个选项函数，用于指定中间人代理服务器是否开启透明劫持模式，默认为false

在开启透明模式下，所有流量都会被默认转发，所有的回调函数都会被忽略

Example:

mitm.Start(8080, mitm.isTransparent(true))

定义#

isTransparent(b bool) MitmConfigOpt

参数#

参数名参数类型参数解释
bbool

返回值#

返回值(顺序)返回值类型返回值解释
r1MitmConfigOpt

maxContentLength#

详细描述#

maxContentLength 是一个选项函数，用于指定中间人代理服务器的最大的请求和响应内容长度，默认为10MB

Example:

mitm.Start(8080, mitm.maxContentLength(100 * 1000 * 1000))

定义#

maxContentLength(i int) MitmConfigOpt

参数#

参数名参数类型参数解释
iint

返回值#

返回值(顺序)返回值类型返回值解释
r1MitmConfigOpt

mockHTTPRequest#

详细描述#

mockHTTPRequest 是一个选项函数，用于指定中间人代理服务器的请求 mock 函数

当接收到请求后，会调用该回调函数，通过调用 mockResponse 函数可以直接返回自定义响应，跳过真实的网络请求

mockResponse 接受一个响应（字符串或字节数组），会自动修复响应格式，如果修复失败则返回 502 Bad Gateway

Example:

mitm.Start(8080, mitm.mockHTTPRequest(func(isHttps, urlStr, req, mockResponse) {
    if str.Contains(urlStr, "test") {        mockResponse("HTTP/1.1 200 OK\r\nContent-Type: text/html\r\n\r\nMocked Response")    }
}))

定义#

mockHTTPRequest(h func(isHttps bool, urlStr string, req []byte, mockResponse func(rsp any))) MitmConfigOpt

参数#

参数名参数类型参数解释
hfunc(isHttps bool, urlStr string, req []byte, mockResponse func(rsp any))

返回值#

返回值(顺序)返回值类型返回值解释
r1MitmConfigOpt

randomJA3#

详细描述#

randomJA3 是一个选项函数，用于指定中间人代理服务器是否开启随机 JA3 劫持模式，默认为false

Example:

mitm.Start(8080, mitm.randomJA3(true))

定义#

randomJA3(b bool) MitmConfigOpt

参数#

参数名参数类型参数解释
bbool

返回值#

返回值(顺序)返回值类型返回值解释
r1MitmConfigOpt

rootCA#

详细描述#

rootCA 是一个选项函数，用于指定中间人代理服务器的根证书和私钥

Example:

mitm.Start(8080, mitm.rootCA(cert, key))

定义#

rootCA(cert []byte, key []byte) MitmConfigOpt

参数#

参数名参数类型参数解释
cert[]byte
key[]byte

返回值#

返回值(顺序)返回值类型返回值解释
r1MitmConfigOpt

useDefaultCA#

详细描述#

useDefaultCA 是一个选项函数，用于指定中间人代理服务器是否使用内置的证书和私钥，默认为true

默认的证书与私钥路径：~/yakit-projects/yak-mitm-ca.crt 和 ~/yakit-projects/yak-mitm-ca.key

Example:

mitm.Start(8080, mitm.useDefaultCA(true))

定义#

useDefaultCA(t bool) MitmConfigOpt

参数#

参数名参数类型参数解释
tbool

返回值#

返回值(顺序)返回值类型返回值解释
r1MitmConfigOpt

wscallback#

详细描述#

wscallback 是一个选项函数，用于指定中间人代理服务器的 websocket 劫持函数，当接收到 websocket 请求或响应后，会调用该回调函数

该回调函数的第一个参数是请求或响应的内容

第二个参数是一个布尔值，用于指示该内容是请求还是响应，true 表示请求，false 表示响应

通过该回调函数的返回值，可以修改请求或响应的内容

Example:

mitm.Start(8080, mitm.wscallback(func(data, isRequest) { println(data); return data }))

定义#

wscallback(f func([]byte, bool) any) MitmConfigOpt

参数#

参数名参数类型参数解释
ffunc([]byte, bool) any

返回值#

返回值(顺序)返回值类型返回值解释
r1MitmConfigOpt

wsforcetext#

详细描述#

wsforcetext 是一个选项函数，用于强制指定中间人代理服务器的 websocket 劫持的数据帧转换为文本帧，默认为false

! 已弃用

Example:

mitm.Start(8080, mitm.wsforcetext(true))

定义#

wsforcetext(b bool) MitmConfigOpt

参数#

参数名参数类型参数解释
bbool

返回值#

返回值(顺序)返回值类型返回值解释
r1MitmConfigOpt