1/* 2 * Copyright (C) 2023 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16/** 17 * @file 18 * @kit NetworkKit 19 */ 20 21import type { AsyncCallback, Callback } from './@ohos.base'; 22import type connection from './@ohos.net.connection'; 23import type _AbilityContext from './application/UIAbilityContext'; 24 25/** 26 * Provides VPN related interfaces. 27 * @namespace vpn 28 * @syscap SystemCapability.Communication.NetManager.Vpn 29 * @since 10 30 */ 31declare namespace vpn { 32 /** 33 * Get network link information. 34 * @syscap SystemCapability.Communication.NetManager.Core 35 * @since 10 36 */ 37 export type LinkAddress = connection.LinkAddress; 38 39 /** 40 * Get network route information. 41 * @syscap SystemCapability.Communication.NetManager.Core 42 * @since 10 43 */ 44 export type RouteInfo = connection.RouteInfo; 45 46 /** 47 * The context of an ability. It allows access to ability-specific resources. 48 * @syscap SystemCapability.Ability.AbilityRuntime.Core 49 * @since 10 50 */ 51 export type AbilityContext = _AbilityContext; 52 53 /** 54 * Create a VPN connection using the AbilityContext. 55 * @param { AbilityContext } context - Indicates the context of application or capability. 56 * @returns { VpnConnection } the VpnConnection of the construct VpnConnection instance. 57 * @throws { BusinessError } 202 - Non-system applications use system APIs. 58 * @throws { BusinessError } 401 - Parameter error. 59 * @syscap SystemCapability.Communication.NetManager.Vpn 60 * @systemapi Hide this for inner system use. 61 * @since 10 62 */ 63 function createVpnConnection(context: AbilityContext): VpnConnection; 64 65 /** 66 * Defines a VPN connection. 67 * @interface VpnConnection 68 * @syscap SystemCapability.Communication.NetManager.Vpn 69 * @systemapi Hide this for inner system use. 70 * @since 10 71 */ 72 export interface VpnConnection { 73 /** 74 * Create a VPN network using the VpnConfig. 75 * @permission ohos.permission.MANAGE_VPN 76 * @param { VpnConfig } config - Indicates the {@link VpnConfig} configuration of the VPN network. 77 * @param { AsyncCallback<number> } callback - The callback is used to return file descriptor of VPN interface. 78 * @throws { BusinessError } 201 - Permission denied. 79 * @throws { BusinessError } 202 - Non-system applications use system APIs. 80 * @throws { BusinessError } 401 - Parameter error. 81 * @throws { BusinessError } 2200001 - Invalid parameter value. 82 * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. 83 * @throws { BusinessError } 2200003 - System internal error. 84 * @throws { BusinessError } 2203001 - VPN creation denied. Check the user type. 85 * @throws { BusinessError } 2203002 - VPN already exists. 86 * @syscap SystemCapability.Communication.NetManager.Vpn 87 * @systemapi Hide this for inner system use. 88 * @since 10 89 */ 90 setUp(config: VpnConfig, callback: AsyncCallback<number>): void; 91 92 /** 93 * Create a VPN network using the VpnConfig. 94 * @permission ohos.permission.MANAGE_VPN 95 * @param { VpnConfig } config - Indicates the {@link VpnConfig} configuration of the VPN network. 96 * @returns { Promise<number> } The promise returns file descriptor of VPN interface. 97 * @throws { BusinessError } 201 - Permission denied. 98 * @throws { BusinessError } 202 - Non-system applications use system APIs. 99 * @throws { BusinessError } 401 - Parameter error. 100 * @throws { BusinessError } 2200001 - Invalid parameter value. 101 * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. 102 * @throws { BusinessError } 2200003 - System internal error. 103 * @throws { BusinessError } 2203001 - VPN creation denied. Check the user type. 104 * @throws { BusinessError } 2203002 - VPN already exists. 105 * @syscap SystemCapability.Communication.NetManager.Vpn 106 * @systemapi Hide this for inner system use. 107 * @since 10 108 */ 109 setUp(config: VpnConfig): Promise<number>; 110 111 /** 112 * Protect a socket from VPN connections. After protecting, data sent through this socket will go directly to the 113 * underlying network so its traffic will not be forwarded through the VPN. 114 * @permission ohos.permission.MANAGE_VPN 115 * @param { number } socketFd - File descriptor of socket, this socket from @ohos.net.socket. 116 * @param { AsyncCallback<void> } callback - The callback of protect. 117 * @throws { BusinessError } 201 - Permission denied. 118 * @throws { BusinessError } 202 - Non-system applications use system APIs. 119 * @throws { BusinessError } 401 - Parameter error. 120 * @throws { BusinessError } 2200001 - Invalid parameter value. 121 * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. 122 * @throws { BusinessError } 2200003 - System internal error. 123 * @throws { BusinessError } 2203004 - Invalid socket file descriptor. 124 * @syscap SystemCapability.Communication.NetManager.Vpn 125 * @systemapi Hide this for inner system use. 126 * @since 10 127 */ 128 protect(socketFd: number, callback: AsyncCallback<void>): void; 129 130 /** 131 * Protect a socket from VPN connections. After protecting, data sent through this socket will go directly to the 132 * underlying network so its traffic will not be forwarded through the VPN. 133 * @permission ohos.permission.MANAGE_VPN 134 * @param { number } socketFd - File descriptor of socket, this socket from @ohos.net.socket. 135 * @returns { Promise<void> } The promise returned by the function. 136 * @throws { BusinessError } 201 - Permission denied. 137 * @throws { BusinessError } 202 - Non-system applications use system APIs. 138 * @throws { BusinessError } 401 - Parameter error. 139 * @throws { BusinessError } 2200001 - Invalid parameter value. 140 * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. 141 * @throws { BusinessError } 2200003 - System internal error. 142 * @throws { BusinessError } 2203004 - Invalid socket file descriptor. 143 * @syscap SystemCapability.Communication.NetManager.Vpn 144 * @systemapi Hide this for inner system use. 145 * @since 10 146 */ 147 protect(socketFd: number): Promise<void>; 148 149 /** 150 * Destroy the VPN network. 151 * @permission ohos.permission.MANAGE_VPN 152 * @param { AsyncCallback<void> } callback - The callback of destroy. 153 * @throws { BusinessError } 201 - Permission denied. 154 * @throws { BusinessError } 202 - Non-system applications use system APIs. 155 * @throws { BusinessError } 401 - Parameter error. 156 * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. 157 * @throws { BusinessError } 2200003 - System internal error. 158 * @syscap SystemCapability.Communication.NetManager.Vpn 159 * @systemapi Hide this for inner system use. 160 * @since 10 161 */ 162 destroy(callback: AsyncCallback<void>): void; 163 164 /** 165 * Destroy the VPN network. 166 * @permission ohos.permission.MANAGE_VPN 167 * @returns { Promise<void> } The promise returned by the function. 168 * @throws { BusinessError } 201 - Permission denied. 169 * @throws { BusinessError } 202 - Non-system applications use system APIs. 170 * @throws { BusinessError } 401 - Parameter error. 171 * @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service. 172 * @throws { BusinessError } 2200003 - System internal error. 173 * @syscap SystemCapability.Communication.NetManager.Vpn 174 * @systemapi Hide this for inner system use. 175 * @since 10 176 */ 177 destroy(): Promise<void>; 178 } 179 180 /** 181 * Define configuration of the VPN network. 182 * @interface VpnConfig 183 * @syscap SystemCapability.Communication.NetManager.Vpn 184 * @systemapi Hide this for inner system use. 185 * @since 10 186 */ 187 export interface VpnConfig { 188 /** 189 * The array of addresses for VPN interface. 190 * @type {Array<LinkAddress>} 191 * @syscap SystemCapability.Communication.NetManager.Vpn 192 * @systemapi Hide this for inner system use. 193 * @since 10 194 */ 195 addresses: Array<LinkAddress>; 196 197 /** 198 * The array of routes for VPN interface. 199 * @type {?Array<RouteInfo>} 200 * @syscap SystemCapability.Communication.NetManager.Vpn 201 * @systemapi Hide this for inner system use. 202 * @since 10 203 */ 204 routes?: Array<RouteInfo>; 205 206 /** 207 * The array of DNS servers for the VPN network. 208 * @type {?Array<string>} 209 * @syscap SystemCapability.Communication.NetManager.Vpn 210 * @systemapi Hide this for inner system use. 211 * @since 10 212 */ 213 dnsAddresses?: Array<string>; 214 215 /** 216 * The array of search domains for the DNS resolver. 217 * @type {?Array<string>} 218 * @syscap SystemCapability.Communication.NetManager.Vpn 219 * @systemapi Hide this for inner system use. 220 * @since 10 221 */ 222 searchDomains?: Array<string>; 223 224 /** 225 * The maximum transmission unit (MTU) for the VPN interface. 226 * @type {?number} 227 * @syscap SystemCapability.Communication.NetManager.Vpn 228 * @systemapi Hide this for inner system use. 229 * @since 10 230 */ 231 mtu?: number; 232 233 /** 234 * Whether ipv4 is supported. The default value is true. 235 * @type {?boolean} 236 * @syscap SystemCapability.Communication.NetManager.Vpn 237 * @systemapi Hide this for inner system use. 238 * @since 10 239 */ 240 isIPv4Accepted?: boolean; 241 242 /** 243 * Whether ipv6 is supported. The default value is false. 244 * @type {?boolean} 245 * @syscap SystemCapability.Communication.NetManager.Vpn 246 * @systemapi Hide this for inner system use. 247 * @since 10 248 */ 249 isIPv6Accepted?: boolean; 250 251 /** 252 * Whether to use the built-in VPN. The default value is false. 253 * @type {?boolean} 254 * @syscap SystemCapability.Communication.NetManager.Vpn 255 * @systemapi Hide this for inner system use. 256 * @since 10 257 */ 258 isLegacy?: boolean; 259 260 /** 261 * Whether the VPN interface's file descriptor is in blocking/non-blocking mode. The default value is false. 262 * @type {?boolean} 263 * @syscap SystemCapability.Communication.NetManager.Vpn 264 * @systemapi Hide this for inner system use. 265 * @since 10 266 */ 267 isBlocking?: boolean; 268 269 /** 270 * The array of trustlist for the VPN network. The string indicates package name. 271 * @type {?Array<string>} 272 * @syscap SystemCapability.Communication.NetManager.Vpn 273 * @systemapi Hide this for inner system use. 274 * @since 10 275 */ 276 trustedApplications?: Array<string>; 277 278 /** 279 * The array of blocklist for the VPN network. The string indicates package name. 280 * @type {?Array<string>} 281 * @syscap SystemCapability.Communication.NetManager.Vpn 282 * @systemapi Hide this for inner system use. 283 * @since 10 284 */ 285 blockedApplications?: Array<string>; 286 } 287} 288export default vpn; 289 290