# iproxy

**Repository Path**: wangshili123/iproxy

## Basic Information

- **Project Name**: iproxy
- **Description**: IProxy 是一个 JAVA 编写的 HTTP 代理服务器类库，支持 HTTP、HTTPS、Websocket 协议，并且支持 MITM(中间人攻击)，可以对 HTTP、HTTPS 协议的报文进行捕获和篡改。
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://rplees.com
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2024-10-26
- **Last Updated**: 2024-10-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">
  <h1>IProxy</h1>
  <p>
  
  [![maven](https://img.shields.io/maven-central/v/com.rplees/iproxy.svg)](https://search.maven.org/search?q=com.rplees)
  [![license](https://img.shields.io/github/license/rplees/iproxy.svg)](https://opensource.org/licenses/MIT)
  
  </p>
  <p>

[English](/README.md) | [中文](/README_zh-CN.md)

  </p>
</div>

---

## 简介

IProxy 是一个 JAVA 编写的 HTTP 代理服务器类库，支持 HTTP、HTTPS、Websocket 协议，并且支持 MITM(中间人攻击)，可以对 HTTP、HTTPS 协议的报文进行捕获和篡改。

## 使用

```xml
<dependency>
    <groupId>com.rplees</groupId>
    <artifactId>iproxy</artifactId>
    <version>1.1.3</version>
</dependency>
```

## 示例

- 普通 HTTP 代理服务器

```java
new ServerStarter().start(1113);
```

- 中间人 HTTP 代理服务器

以下是一个中间人攻击演示，在访问百度首页时修改响应头和响应报文

代码实现：

```java
int port = 1113;
RuntimeOption option = RuntimeOption.builder()
		//不开启的话HTTPS不会被拦截，而是直接转发原始报文
		.ssl(true)
		.initializer(new DefaultEventInitializer() {
			@Override
			public void init(EventPipeline pipeline) {
				pipeline.addFirst(new FullHttpIntercept() {
					public boolean match(ParamContext paramCtx) {
						//在匹配到百度首页时插入js
						if(StringUtils.contains(paramCtx.router().local().host(), "www.baidu.com")) {
							return true;
						}
						return false;
					}
					
					@Override
					public void responseHandle(FullHttpResponse msg, ParamContext paramCtx, EventHandlerContext ctx) {
						System.out.println(msg.content().toString(CharsetUtil.UTF_8));
						msg.content().writeBytes("<script>alert('hello')</script>".getBytes());
					}
				});
			}
		})
		.build();
new ServerStarter(option)
	.startAsync(port);
```

> 注：当开启了 https 支持时，需要安装 CA 证书(`src/resources/ca.crt`)至受信任的根证书颁发机构。

更多 demo 代码在 test 包内可以找到，这里就不一一展示了

## HTTPS 支持

需要导入项目中的 CA 证书(src/resources/ca.crt)至受信任的根证书颁发机构。
可以使用 CertDownIntercept 拦截器，开启网页下载证书功能，访问 http://serverIP:serverPort 即可进入。

> 注 1：安卓手机上安装证书若弹出键入凭据存储的密码，输入锁屏密码即可。
>
> 注 2：Android 7 以及以上，系统不再信任用户安装的证书，你需要 root 后，使用
> cat ca.crt > $(openssl x509 -inform PEM -subject_hash_old -in ca.crt | head -1).0
> 命令生成 d1488b25.0 文件，然后把文件移动到
> /system/etc/security/cacerts/
> 并给与 644 权限
>
> 注 3：在 Android 7 以及以上，即使你把证书添加进系统证书里，这个证书在 chrome 里也是不工作的。原因是 chrome 从 2018 年开始只信任有效期少于 27 个月的证书(https://www.entrustdatacard.com/blog/2018/february/chrome-requires-ct-after-april-2018)。所以你需要自行生成证书文件。

### 使用自定义根证书

由于项目附带的根证书和私钥是公开的，所以只适用于本地开发调试使用，在正式环境使用时请自行生成根证书和私钥，否则会存在风险。

- 通过运行`CertUtil`类的 main 方法生成

- 通过 openssl

```sh
#key的生成，这样是生成RSA密钥，openssl格式，2048位强度。ca.key是密钥文件名。
openssl genrsa -out ca.key 2048

#key的转换，转换成netty支持私钥编码格式
openssl pkcs8 -topk8 -nocrypt -inform PEM -outform DER -in ca.key -out ca_private.der

#crt的生成，通过-subj选项可以自定义证书的相关信息
openssl req -sha256 -new -x509 -days 365 -key ca.key -out ca.crt \
    -subj "/C=CN/ST=GD/L=HZ/O=lee/OU=study/CN=testRoot"
```

生成完之后把`ca.crt`和`ca_private.der`复制到项目的 src/resources/中，或者实现 ICACertFactory 接口来自定义加载根证书和私钥

## 身份验证

目前只支持基本身份验证方案。

- 基本验证

```java
// curl -i -x 127.0.0.1:1113 -U admin:123456 http://www.baidu.com
int port = 1113;
RuntimeOption option = RuntimeOption.builder()
		.authProvider(new AuthProvider.DefaultAuthProvider() {
			@Override
			protected BasicAuthToken authenticate(String usr, String pwd) {
				if ("admin".equals(usr) && "123456".equals(pwd)) {
                    return new BasicAuthToken(usr, pwd);
                }
                return null;
			}
		})
		.build();
new ServerStarter(option)
	.startAsync(port);
```
- 自定义验证

通过实现`AuthProvider`接口来自定义验证。

### 获取身份验证上下文

在授权通过之后，可以在后续的链路中获取到验证通过返回的 token 信息。

```java
AuthToken token = AuthContext.getToken(clientChannel);
```

## 前置代理支持

可设置前置代理,支持 http,socks4,socks5 协议

```java
int port = 1113;
RuntimeOption option = RuntimeOption.builder()
		.ssl(true)
		.proxyConfig(new ProxyConfig(ProxyType.SOCKS5, "127.0.0.1", 1085))//使用socks5二级代理
		.build();
new ServerStarter(option)
	.startAsync(port);
```

## 感谢
- [Proxyee](https://github.com/monkeyWie/proxyee)