# tun2sock

**Repository Path**: suzg-net/tun2sock

## Basic Information

- **Project Name**: tun2sock
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-09-14
- **Last Updated**: 2025-01-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Tun2socks for HarmonyOS

## 准备测试服务器
可以使用任何符合socks5协议的服务器，比如 serjs/go-socks5-proxy。

### 启动测试服务器

```bash
docker run -d --name socks5 -p 1080:1080 serjs/go-socks5-proxy
```

## 引入 Tun2socks
### 方式一：在Terminal窗口中，切换到需要引入三方包的模块，如entry模块，执行如下命令安装三方包，DevEco Studio会自动在该模块的oh-package.json5中自动添加三方包依赖。
```
cd path/to/your/project/entry
ohpm install @mosafe/tun2sock
```

### 方式二：在需要引入三方包的模块的oh-package.json5中设置三方包依赖，配置示例如下：
```
"dependencies": {
  "@mosafe/tun2sock": "^1.0.0"
}
```
依赖设置完成后，需要执行ohpm install命令安装依赖包，依赖包会安装到该模块的oh_modules目录下。
```
ohpm install
```

## 代码中使用

### import 
```
import { Tun2socks } from '@mosafe/tun2sock';
```

### 函数
当VPN连接完成后，调用：
```
    Tun2socks.start(fd: number, host: string, port:number);
```
其中：
* fd: tun的fd
* host: socks5 服务器地址
* port：socks5 服务器端口