鸿蒙OpenHarmony【@ohos.net.vpnExtension (VPN 增强管理)】ArkTS API ...

三方VPN管理模块，支持三方VPN的启动和停止功能。
三方VPN是指由第三方提供的VPN服务，它们通常提供更多的功能和更广泛的网络连接选项，包括更多的安全和隐私功能，以及更全面的定制选项。
说明
本模块首批接口从 API version 11 开始支持。后续版本的新增接口，采取上角标单独标志接口的起始版本。
导入模块

1. import { vpnExtension } from '@kit.NetworkKit';

复制代码

LinkAddress11+

type LinkAddress = connection.LinkAddress
获取网络链接信息。
体系能力：SystemCapability.Communication.NetManager.Core
类型说明[connection.LinkAddress]网络链路信息 RouteInfo11+

type RouteInfo = connection.RouteInfo
获取网络路由信息。
体系能力：SystemCapability.Communication.NetManager.Core
类型说明[connection.RouteInfo]网络路由信息 VpnExtensionContext11+

type VpnExtensionContext = _VpnExtensionContext
vpn扩展的上下文。它允许访问serviceExtension特定资源。
体系能力：SystemCapability.Ability.AbilityRuntime.Core
类型说明[_VpnExtensionContext]vpn扩展的上下文 vpnExtension.startVpnExtensionAbility

startVpnExtensionAbility(want: Want): Promise
启动新的三方vpn功能。
体系能力：SystemCapability.Ability.AbilityRuntime.Core
模子约束：此接口仅可在Stage模子下使用。
参数：
参数名类型必填说明want[Want]是指示要启动的信息。 返回值：
类型说明Promise无返回值的Promise对象。 错误码：
错误码 ID错误信息401If the input parameter is not valid parameter.16000001The specified ability does not exist.16000002Incorrect ability type.16000006Cross-user operations are not allowed.16000008The crowdtesting application expires.16000011The context does not exist.16000050Internal error.16200001The caller has been released. 示例：
Stage 模子示例：

1. import { common, Want } from '@kit.AbilityKit';import { vpnExtension } from '@kit.NetworkKit';
2. let context = getContext(this) as common.VpnExtensionContext;let want: Want = {  deviceId: "",  bundleName: "com.example.myvpndemo",  abilityName: "MyVpnExtAbility",};@Entry@Componentstruct Index {  @State message: string = 'Hello World'  build() {    Row() {      Column() {        Text(this.message)          .fontSize(50)          .fontWeight(FontWeight.Bold).onClick(() => {          console.info("btn click") })        Button('Start Extension').onClick(() => {          vpnExtension.startVpnExtensionAbility(want);        }).width('70%').fontSize(45).margin(16)        }.width('100%')    }.height('100%')  }}

复制代码

vpnExtension.stopVpnExtensionAbility

stopVpnExtensionAbility(want: Want): Promise
停止同一应用步调中的服务。
体系能力：SystemCapability.Ability.AbilityRuntime.Core
模子约束：此接口仅可在Stage模子下使用。
参数：
参数名类型必填说明want[Want]是指示要启动的信息 返回值：
类型说明Promise无返回值的Promise对象。 错误码：
错误码 ID错误信息401If the input parameter is not valid parameter.16000001The specified ability does not exist.16000002Incorrect ability type.16000006Cross-user operations are not allowed.16000011The context does not exist.16000050Internal error.16200001The caller has been released. 示例：
Stage 模子示例：

1. import { common, Want } from '@kit.AbilityKit';import { vpnExtension } from '@kit.NetworkKit';
2. let context = getContext(this) as common.VpnExtensionContext;let want: Want = {  deviceId: "",  bundleName: "com.example.myvpndemo",  abilityName: "MyVpnExtAbility",};@Entry@Componentstruct Index {  @State message: string = 'Hello World'  build() {    Row() {      Column() {        Text(this.message)          .fontSize(50)          .fontWeight(FontWeight.Bold).onClick(() => {          console.info("btn click") })        Button('Start Extension').onClick(() => {          vpnExtension.startVpnExtensionAbility(want);        }).width('70%').fontSize(45).margin(16)        Button('Stop Extension').onClick(() => {          console.info("btn end")          vpnExtension.stopVpnExtensionAbility(want);        }).width('70%').fontSize(45).margin(16)        }.width('100%')    }.height('100%')  }}

复制代码

vpnExtension.createVpnConnection

createVpnConnection(context: VpnExtensionContext): VpnConnection
创建一个 三方VPN 连接对象。
说明
调用createVpnConnection接口前，必要先调用startVpnExtensionAbility接口启用vpn功能。
体系能力：SystemCapability.Communication.NetManager.Vpn
模子约束：此接口仅可在Stage模子下使用。
参数：
参数名类型必填说明context[VpnExtensionContext]是指定 context。 返回值：
类型说明[VpnConnection]返回一个 VPN 连接对象。 错误码：
错误码 ID错误信息401Parameter error. 示例：
Stage 模子示例：

1. import { vpnExtension, VpnExtensionAbility } from '@kit.NetworkKit';
2. import { common, Want } from '@kit.AbilityKit';
4. let context: vpnExtension.VpnExtensionContext;
5. export default class MyVpnExtAbility extends VpnExtensionAbility {
6.   onCreate(want: Want) {
7.     let VpnConnection : vpnExtension.VpnConnection = vpnExtension.createVpnConnection(context);
8.     console.info("vpn createVpnConnection: " + JSON.stringify(VpnConnection));
9.   }
10. }

复制代码

VpnConnection

VPN 连接对象。在调用 VpnConnection 的方法前，必要先通过vpnExt.createVpnConnection创建 VPN 连接对象。
create

create(config: VpnConfig): Promise
使用 config 创建一个 vpn 网络，使用 Promise 方式作为异步方法。
体系能力：SystemCapability.Communication.NetManager.Vpn
参数：
参数名类型必填说明config[VpnConfig]是指定 VPN 网络的配置信息。 返回值：
类型说明Promise以 Promise 情势返回获取效果，返回指定虚拟网卡的文件描述符 fd。 错误码：
错误码 ID错误信息401Parameter error.2200001Invalid parameter value.2200002Operation failed. Cannot connect to service.2200003System internal error.2203001VPN creation denied, please check the user type.2203002VPN exist already, please execute destroy first. 示例：

1. import { vpnExtension, VpnExtensionAbility } from '@kit.NetworkKit';
2. import { common, Want } from '@kit.AbilityKit';
3. import { hilog } from '@kit.PerformanceAnalysisKit';
5. let context: vpnExtension.VpnExtensionContext;
6. export default class MyVpnExtAbility extends VpnExtensionAbility {
7.   private tunIp: string = '10.0.0.5';
8.   private blockedAppName: string = 'com.example.myvpndemo';
9.   onCreate(want: Want) {
10.     let VpnConnection : vpnExtension.VpnConnection = vpnExtension.createVpnConnection(context);
11.     console.info("vpn createVpnConnection: " + JSON.stringify(VpnConnection));
12.     this.SetupVpn();
13.   }
14.   SetupVpn() {
15.         class Address {
16.             address: string;
17.             family: number;
19.             constructor(address: string, family: number) {
20.                 this.address = address;
21.                 this.family = family;
22.             }
23.         }
25.         class AddressWithPrefix {
26.             address: Address;
27.             prefixLength: number;
29.             constructor(address: Address, prefixLength: number) {
30.                 this.address = address;
31.                 this.prefixLength = prefixLength;
32.             }
33.         }
35.         class Config {
36.             addresses: AddressWithPrefix[];
37.             mtu: number;
38.             dnsAddresses: string[];
39.             trustedApplications: string[];
40.             blockedApplications: string[];
42.             constructor(
43.                 tunIp: string,
44.                 blockedAppName: string
45.             ) {
46.                 this.addresses = [
47.                     new AddressWithPrefix(new Address(tunIp, 1), 24)
48.                 ];
49.                 this.mtu = 1400;
50.                 this.dnsAddresses = ["114.114.114.114"];
51.                 this.trustedApplications = [];
52.                 this.blockedApplications = [blockedAppName];
53.             }
54.         }
56.         let config = new Config(this.tunIp, this.blockedAppName);
58.         try {
59.             let VpnConnection : vpnExtension.VpnConnection = vpnExtension.createVpnConnection(context);
60.             VpnConnection.create(config).then((data) => {
61.                 hilog.error(0x0000, 'developTag', 'tunfd: %{public}s', JSON.stringify(data) ?? '');
62.             })
63.         } catch (error) {
64.             hilog.error(0x0000, 'developTag', 'vpn setUp fail: %{public}s', JSON.stringify(error) ?? '');
65.         }
66.     }
67. }

复制代码

protect

protect(socketFd: number): Promise
保护套接字不受 VPN 连接影响，通过该套接字发送的数据将直接基于物理网络收发，因此其流量不会通过 VPN 转发, 使用 Promise 方式作为异步方法。
体系能力：SystemCapability.Communication.NetManager.Vpn
参数：
参数名类型必填说明socketFdnumber是指定保护的 socketfd, 该文件描述符通过[getSocketFd]获取。 返回值：
类型说明Promise以 Promise 情势返回设定效果，失败返回错误码错误信息。 错误码：
错误码 ID错误信息401Parameter error.2200001Invalid parameter value.2200002Operation failed. Cannot connect to service.2200003System internal error.2203004Invalid socket file descriptor. 示例：

1. import { vpnExtension, VpnExtensionAbility } from '@kit.NetworkKit';
2. import { common, Want } from '@kit.AbilityKit';
3. import { hilog } from '@kit.PerformanceAnalysisKit';
5. let g_tunnelFd = -1;
6. let context: vpnExtension.VpnExtensionContext;
7. export default class MyVpnExtAbility extends VpnExtensionAbility {
8.   private vpnServerIp: string = '192.168.31.13';
9.   onCreate(want: Want) {
10.     let VpnConnection : vpnExtension.VpnConnection = vpnExtension.createVpnConnection(context);
11.     console.info("vpn createVpnConnection: " + JSON.stringify(VpnConnection));
12.     this.CreateTunnel();
13.     this.Protect();
14.   }
15.   CreateTunnel() {
16.       g_tunnelFd = 8888;
17.   }
18.   Protect() {
19.         hilog.info(0x0000, 'developTag', '%{public}s', 'vpn Protect');
20.         let VpnConnection : vpnExtension.VpnConnection = vpnExtension.createVpnConnection(context);
21.         VpnConnection.protect(g_tunnelFd).then(() => {
22.             hilog.info(0x0000, 'developTag', '%{public}s', 'vpn Protect Success');
23.         }).catch((err : Error) => {
24.             hilog.error(0x0000, 'developTag', 'vpn Protect Failed %{public}s', JSON.stringify(err) ?? '');
25.         })
26.   }
27. }

复制代码

destroy

destroy(): Promise
销毁启动的 VPN 网络，使用 Promise 方式作为异步方法。
体系能力：SystemCapability.Communication.NetManager.Vpn
返回值：
类型说明Promise以 Promise 情势返回设定效果，失败返回错误码错误信息。 错误码：
错误码 ID错误信息401Parameter error.2200002Operation failed. Cannot connect to service.2200003System internal error. 示例：

1. import { vpnExtension, VpnExtensionAbility } from '@kit.NetworkKit';
2. import { common, Want } from '@kit.AbilityKit';
3. import { BusinessError } from '@kit.BasicServicesKit';
5. let context: vpnExtension.VpnExtensionContext;
6. export default class MyVpnExtAbility extends VpnExtensionAbility {
7.   onCreate(want: Want) {
8.     let VpnConnection : vpnExtension.VpnConnection = vpnExtension.createVpnConnection(context);
9.     console.info("vpn createVpnConnection: " + JSON.stringify(VpnConnection));
10.     VpnConnection.destroy().then(() => {
11.       console.info("destroy success.");
12.     }).catch((error : BusinessError) => {
13.       console.error("destroy fail" + JSON.stringify(error));
14.     });
15.   }
16. }

复制代码

VpnConfig

三方VPN配置参数。
体系能力：SystemCapability.Communication.NetManager.Vpn
名称类型必填说明addressesArray<[LinkAddress]>是VPN 虚拟网卡的 IP 地址。routesArray<[RouteInfo]>否VPN 虚拟网卡的路由信息(现在最多可配置1024条路由)。dnsAddressesArray否DNS 服务器地址信息。searchDomainsArray否DNS 的搜索域列表。mtunumber否最大传输单元 MTU 值(单位:字节)。isIPv4Acceptedboolean否是否支持 IPV4, 默认值为 true。isIPv6Acceptedboolean否是否支持 IPV6, 默认值为 false。isInternalboolean否是否支持内置 VPN, 默认值为 false。isBlockingboolean否是否阻塞模式, 默认值为 false。trustedApplicationsArray否白名单信息, string 类型表示的包名。blockedApplicationsArray否黑名单信息, string 类型表示的包名。 示例：

1. import { vpnExtension} from '@kit.NetworkKit';
3. let vpnConfig: vpnExtension.VpnConfig = {
4.   addresses: [],
5.   routes: [{
6.     interface: "eth0",
7.     destination: {
8.       address: {
9.         address:'',
10.         family:1,
11.         port:8080
12.       },
13.       prefixLength:1
14.     },
15.     gateway: {
16.       address:'',
17.       family:1,
18.       port:8080
19.     },
20.     hasGateway: true,
21.     isDefaultRoute: true,
22.   }],
23.   mtu: 1400,
24.   dnsAddresses: ["223.5.5.5", "223.6.6.6"],
25.   trustedApplications: [],
26.   blockedApplications: [],
27. }
28. let context: vpnExtension.VpnExtensionContext;
30. function vpnCreate(){
31.   let VpnConnection: vpnExtension.VpnConnection = vpnExtension.createVpnConnection(context);
32.   VpnConnection.create(vpnConfig).then((data) => {
33.     console.info("vpn create " + JSON.stringify(data));
34.   })
35. }

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。