Skip to content

Commit

Permalink
Update api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Sep 27, 2024
1 parent dde89d3 commit e2686b9
Show file tree
Hide file tree
Showing 2 changed files with 88 additions and 1 deletion.
87 changes: 87 additions & 0 deletions docs/api/mitm.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
| [mitm.Start](#start) |Start 启动一个 MITM (中间人)代理服务器,它的第一个参数是端口,接下来可以接收零个到多个选项函数,用于影响中间人代理服务器的行为 如果没有指定 CA 证书和私钥,那么将使用内置的证书和私钥 |
| [mitm.callback](#callback) |callback 是一个选项函数,用于指定中间人代理服务器的回调函数,当接收到请求和响应后,会调用该回调函数 |
| [mitm.context](#context) |context 是一个选项函数,用于指定中间人代理服务器的上下文 |
| [mitm.gmtls](#gmtls) |gmtls 是一个选项参数,用于指定中间人代理服务器是否开启 GMTLS 劫持模式,默认为false 在开启 GMTLS 劫持模式下,中间人代理服务器会劫持所有的 GMTLS 流量 |
| [mitm.gmtlsOnly](#gmtlsonly) |gmtlsOnly 是一个选项参数,用于指定中间人代理服务器是否只使用 GMTLS 劫持模式,默认为false 在开启 GMTLS 劫持模式下,中间人代理服务器只会使用 GMTLS 劫持模式 |
| [mitm.gmtlsPrefer](#gmtlsprefer) |gmtlsPrefer 是一个选项参数,用于指定中间人代理服务器是否优先使用 GMTLS 劫持模式,默认为false 在开启 GMTLS 劫持模式下,中间人代理服务器会优先使用 GMTLS 劫持模式 |
| [mitm.hijackHTTPRequest](#hijackhttprequest) |hijackHTTPRequest 是一个选项函数,用于指定中间人代理服务器的请求劫持函数,当接收到请求后,会调用该回调函数 通过调用该回调函数的第四个参数,可以修改请求内容,通过调用该回调函数的第五个参数,可以丢弃请求 |
| [mitm.hijackHTTPResponse](#hijackhttpresponse) |hijackHTTPResponse 是一个选项函数,用于指定中间人代理服务器的响应劫持函数,当接收到响应后,会调用该回调函数 通过调用该回调函数的第四个参数,可以修改响应内容,通过调用该回调函数的第五个参数,可以丢弃响应 |
| [mitm.hijackHTTPResponseEx](#hijackhttpresponseex) |hijackHTTPResponseEx 是一个选项函数,用于指定中间人代理服务器的响应劫持函数,当接收到响应后,会调用该回调函数 通过调用该回调函数的第五个参数,可以修改响应内容,通过调用该回调函数的第六个参数,可以丢弃响应 它与 hijackHTTPResponse 的区别在于,它可以获取到...|
Expand Down Expand Up @@ -132,6 +135,90 @@ mitm.Start(8080, mitm.context(context.Background()))
| r1 | `MitmConfigOpt` | |


### gmtls

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

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

Example:
```
mitm.Start(8080, mitm.gmtls(true))
```


#### 定义

`gmtls(b bool) MitmConfigOpt`

#### 参数
|参数名|参数类型|参数解释|
|:-----------|:---------- |:-----------|
| b | `bool` | |

#### 返回值
|返回值(顺序)|返回值类型|返回值解释|
|:-----------|:---------- |:-----------|
| r1 | `MitmConfigOpt` | |


### gmtlsOnly

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

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

Example:
```
mitm.Start(8080, mitm.gmtlsOnly(true))
```


#### 定义

`gmtlsOnly(b bool) MitmConfigOpt`

#### 参数
|参数名|参数类型|参数解释|
|:-----------|:---------- |:-----------|
| b | `bool` | |

#### 返回值
|返回值(顺序)|返回值类型|返回值解释|
|:-----------|:---------- |:-----------|
| r1 | `MitmConfigOpt` | |


### gmtlsPrefer

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

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

Example:
```
mitm.Start(8080, mitm.gmtlsPrefer(true))
```


#### 定义

`gmtlsPrefer(b bool) MitmConfigOpt`

#### 参数
|参数名|参数类型|参数解释|
|:-----------|:---------- |:-----------|
| b | `bool` | |

#### 返回值
|返回值(顺序)|返回值类型|返回值解释|
|:-----------|:---------- |:-----------|
| r1 | `MitmConfigOpt` | |


### hijackHTTPRequest

#### 详细描述
Expand Down
2 changes: 1 addition & 1 deletion docs/api/simulator.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ htmlChangeMode|(simulator.loginDetectMode) 1|
leaklessDefault|(simulator.LeaklessMode) 0|
leaklessOff|(simulator.LeaklessMode) -1|
leaklessOn|(simulator.LeaklessMode) 1|
simple|(map[string]interface {}) map[string]interface {}{"bodyModifyTarget": "body", "bodyReplaceTarget": "bodyReplace", "createBrowser": (func(...simple.BrowserConfigOpt) *simple.VBrowser)(0x275a1c0), "headersModifyTarget": "headers", "headless": (func(bool) simple.BrowserConfigOpt)(0x2759c00), "hostModifyTarget": "host", "noSandBox": (func(bool) simple.BrowserConfigOpt)(0x2759b80), "proxy": (func(string, ...string) simple.BrowserConfigOpt)(0x27599c0), "requestModify": (func(string, simple.ModifyTarget, interface {}) simple.BrowserConfigOpt)(0x2759f20), "responseModify": (func(string, simple.ModifyTarget, interface {}) simple.BrowserConfigOpt)(0x2759c80), "wsAddress": (func(string) simple.BrowserConfigOpt)(0x27598e0)}|
simple|(map[string]interface {}) map[string]interface {}{"bodyModifyTarget": "body", "bodyReplaceTarget": "bodyReplace", "createBrowser": (func(...simple.BrowserConfigOpt) *simple.VBrowser)(0x275b6e0), "headersModifyTarget": "headers", "headless": (func(bool) simple.BrowserConfigOpt)(0x275b120), "hostModifyTarget": "host", "noSandBox": (func(bool) simple.BrowserConfigOpt)(0x275b0a0), "proxy": (func(string, ...string) simple.BrowserConfigOpt)(0x275aee0), "requestModify": (func(string, simple.ModifyTarget, interface {}) simple.BrowserConfigOpt)(0x275b440), "responseModify": (func(string, simple.ModifyTarget, interface {}) simple.BrowserConfigOpt)(0x275b1a0), "wsAddress": (func(string) simple.BrowserConfigOpt)(0x275ae00)}|
urlChangeMode|(simulator.loginDetectMode) 0|

|函数名|函数描述/介绍|
Expand Down

0 comments on commit e2686b9

Please sign in to comment.