mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-11-23 15:20:17 +00:00
318 lines
11 KiB
TypeScript
318 lines
11 KiB
TypeScript
/*
|
|
* Copyright (C) 2023 Huawei Device Co., Ltd.
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
/**
|
|
* @file
|
|
* @kit NetworkKit
|
|
*/
|
|
|
|
import type connection from './@ohos.net.connection';
|
|
import type _VpnExtensionContext from './application/VpnExtensionContext';
|
|
import type Want from './@ohos.app.ability.Want';
|
|
|
|
/**
|
|
* Provides VPN related interfaces.
|
|
* @namespace vpnExtension
|
|
* @syscap SystemCapability.Communication.NetManager.Vpn
|
|
* @since 11
|
|
*/
|
|
declare namespace vpnExtension {
|
|
/**
|
|
* Get network link information.
|
|
* @typedef { connection.LinkAddress }
|
|
* @syscap SystemCapability.Communication.NetManager.Core
|
|
* @since 11
|
|
*/
|
|
export type LinkAddress = connection.LinkAddress;
|
|
|
|
/**
|
|
* Get network route information.
|
|
* @typedef { connection.RouteInfo }
|
|
* @syscap SystemCapability.Communication.NetManager.Core
|
|
* @since 11
|
|
*/
|
|
export type RouteInfo = connection.RouteInfo;
|
|
|
|
/**
|
|
* The context of vpn extension. It allows access to
|
|
* serviceExtension-specific resources.
|
|
* @typedef _VpnExtensionContext
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @since 11
|
|
*/
|
|
export type VpnExtensionContext = _VpnExtensionContext;
|
|
|
|
/**
|
|
* Starts a new vpn extension ability.
|
|
*
|
|
* @param { Want } want - Indicates the want info to start.
|
|
* @returns { Promise<void> } The promise returned by the function.
|
|
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
|
|
* @throws { BusinessError } 16000001 - The specified ability does not exist.
|
|
* @throws { BusinessError } 16000002 - Incorrect ability type.
|
|
* @throws { BusinessError } 16000006 - Cross-user operations are not allowed.
|
|
* @throws { BusinessError } 16000008 - The crowdtesting application expires.
|
|
* @throws { BusinessError } 16000011 - The context does not exist.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @throws { BusinessError } 16200001 - The caller has been released.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @stagemodelonly
|
|
* @since 11
|
|
*/
|
|
function startVpnExtensionAbility(want: Want): Promise<void>;
|
|
|
|
/**
|
|
* Stops a service within the same application.
|
|
*
|
|
* @param { Want } want - Indicates the want info to start.
|
|
* @returns { Promise<void> } The promise returned by the function.
|
|
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
|
|
* @throws { BusinessError } 16000001 - The specified ability does not exist.
|
|
* @throws { BusinessError } 16000002 - Incorrect ability type.
|
|
* @throws { BusinessError } 16000006 - Cross-user operations are not allowed.
|
|
* @throws { BusinessError } 16000011 - The context does not exist.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @throws { BusinessError } 16200001 - The caller has been released.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @stagemodelonly
|
|
* @since 11
|
|
*/
|
|
function stopVpnExtensionAbility(want: Want): Promise<void>;
|
|
|
|
/**
|
|
* Set the Enable/Disable Always on VPN mode for a device.
|
|
*
|
|
* @permission ohos.permission.MANAGE_VPN
|
|
* @param { boolean } enable - Always on enable or disable
|
|
* @param { string } bundleName - bundleName is used to set always on.
|
|
* @returns { Promise<void> } The promise returned by the function.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Non-system applications use system APIs.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @syscap SystemCapability.Communication.NetManager.Vpn
|
|
* @systemapi Hide this for inner system use.
|
|
* @stagemodelonly
|
|
* @since 11
|
|
*/
|
|
function setAlwaysOnVpnEnabled(enable: boolean, bundleName: string): Promise<void>;
|
|
|
|
/**
|
|
* Get the Always on VPN mode status for a device.
|
|
*
|
|
* @permission ohos.permission.MANAGE_VPN
|
|
* @param { string } bundleName - bundleName is used to retrieve whether it has the always on.
|
|
* @returns { Promise<boolean>} return the mode for alway on vpn status
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Non-system applications use system APIs.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @syscap SystemCapability.Communication.NetManager.Vpn
|
|
* @systemapi Hide this for inner system use.
|
|
* @stagemodelonly
|
|
* @since 11
|
|
*/
|
|
function isAlwaysOnVpnEnabled(bundleName: string): Promise<boolean>;
|
|
|
|
/**
|
|
* Update a VPN dialog authorize information
|
|
*
|
|
* @permission ohos.permission.MANAGE_VPN
|
|
* @param { string } bundleName - authorize or not
|
|
* @returns { boolean } The promise returned by the function.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Non-system applications use system APIs.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @syscap SystemCapability.Communication.NetManager.Vpn
|
|
* @systemapi Hide this for inner system use.
|
|
* @stagemodelonly
|
|
* @since 11
|
|
*/
|
|
function updateVpnAuthorizedState(bundleName: string): boolean;
|
|
/**
|
|
* Create a VPN connection using the VpnExtensionContext.
|
|
*
|
|
* @param { VpnExtensionContext } context - Indicates the context of application or capability.
|
|
* @returns { VpnConnection } the VpnConnection of the construct VpnConnection instance.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @syscap SystemCapability.Communication.NetManager.Vpn
|
|
* @stagemodelonly
|
|
* @since 11
|
|
*/
|
|
function createVpnConnection(context: VpnExtensionContext): VpnConnection;
|
|
|
|
/**
|
|
* Defines a VPN connection.
|
|
*
|
|
* @interface VpnConnection
|
|
* @syscap SystemCapability.Communication.NetManager.Vpn
|
|
* @since 11
|
|
*/
|
|
export interface VpnConnection {
|
|
|
|
/**
|
|
* Create a VPN network using the VpnConfig.
|
|
*
|
|
* @param { VpnConfig } config - Indicates the {@link VpnConfig} configuration of the VPN network.
|
|
* @returns { Promise<number> } The promise returns file descriptor of VPN interface.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @throws { BusinessError } 2200001 - Invalid parameter value.
|
|
* @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service.
|
|
* @throws { BusinessError } 2200003 - System internal error.
|
|
* @throws { BusinessError } 2203001 - VPN creation denied, please check the user type.
|
|
* @throws { BusinessError } 2203002 - VPN exist already, please execute destroy first.
|
|
* @syscap SystemCapability.Communication.NetManager.Vpn
|
|
* @since 11
|
|
*/
|
|
create(config: VpnConfig): Promise<number>;
|
|
|
|
/**
|
|
* Protect a socket from VPN connections. After protecting, data sent through this socket will go directly to the
|
|
* underlying network so its traffic will not be forwarded through the VPN.
|
|
*
|
|
* @param { number } socketFd - File descriptor of socket, this socket from @ohos.net.socket.
|
|
* @returns { Promise<void> } The promise returned by the function.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @throws { BusinessError } 2200001 - Invalid parameter value.
|
|
* @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service.
|
|
* @throws { BusinessError } 2200003 - System internal error.
|
|
* @throws { BusinessError } 2203004 - Invalid socket file descriptor.
|
|
* @syscap SystemCapability.Communication.NetManager.Vpn
|
|
* @since 11
|
|
*/
|
|
protect(socketFd: number): Promise<void>;
|
|
|
|
/**
|
|
* Destroy the VPN network.
|
|
*
|
|
* @returns { Promise<void> } The promise returned by the function.
|
|
* @throws { BusinessError } 401 - Parameter error.
|
|
* @throws { BusinessError } 2200002 - Operation failed. Cannot connect to service.
|
|
* @throws { BusinessError } 2200003 - System internal error.
|
|
* @syscap SystemCapability.Communication.NetManager.Vpn
|
|
* @since 11
|
|
*/
|
|
destroy(): Promise<void>;
|
|
}
|
|
|
|
/**
|
|
* Define configuration of the VPN network.
|
|
*
|
|
* @interface VpnConfig
|
|
* @syscap SystemCapability.Communication.NetManager.Vpn
|
|
* @since 11
|
|
*/
|
|
export interface VpnConfig {
|
|
/**
|
|
* The array of addresses for VPN interface.
|
|
*
|
|
* @type {Array<LinkAddress>}
|
|
* @syscap SystemCapability.Communication.NetManager.Vpn
|
|
* @since 11
|
|
*/
|
|
addresses: Array<LinkAddress>;
|
|
|
|
/**
|
|
* The array of routes for VPN interface.
|
|
*
|
|
* @type {?Array<RouteInfo>}
|
|
* @syscap SystemCapability.Communication.NetManager.Vpn
|
|
* @since 11
|
|
*/
|
|
routes?: Array<RouteInfo>;
|
|
|
|
/**
|
|
* The array of DNS servers for the VPN network.
|
|
*
|
|
* @type {?Array<string>}
|
|
* @syscap SystemCapability.Communication.NetManager.Vpn
|
|
* @since 11
|
|
*/
|
|
dnsAddresses?: Array<string>;
|
|
|
|
/**
|
|
* The array of search domains for the DNS resolver.
|
|
*
|
|
* @type {?Array<string>}
|
|
* @syscap SystemCapability.Communication.NetManager.Vpn
|
|
* @since 11
|
|
*/
|
|
searchDomains?: Array<string>;
|
|
|
|
/**
|
|
* The maximum transmission unit (MTU) for the VPN interface.
|
|
*
|
|
* @type {?number}
|
|
* @syscap SystemCapability.Communication.NetManager.Vpn
|
|
* @since 11
|
|
*/
|
|
mtu?: number;
|
|
|
|
/**
|
|
* Whether ipv4 is supported. The default value is true.
|
|
*
|
|
* @type {?boolean}
|
|
* @syscap SystemCapability.Communication.NetManager.Vpn
|
|
* @since 11
|
|
*/
|
|
isIPv4Accepted?: boolean;
|
|
|
|
/**
|
|
* Whether ipv6 is supported. The default value is false.
|
|
*
|
|
* @type {?boolean}
|
|
* @syscap SystemCapability.Communication.NetManager.Vpn
|
|
* @since 11
|
|
*/
|
|
isIPv6Accepted?: boolean;
|
|
|
|
/**
|
|
* Whether to use the built-in VPN. The default value is false.
|
|
*
|
|
* @type {?boolean}
|
|
* @syscap SystemCapability.Communication.NetManager.Vpn
|
|
* @since 11
|
|
*/
|
|
isInternal?: boolean;
|
|
|
|
/**
|
|
* Whether the VPN interface's file descriptor is in blocking/non-blocking mode. The default value is false.
|
|
*
|
|
* @type {?boolean}
|
|
* @syscap SystemCapability.Communication.NetManager.Vpn
|
|
* @since 11
|
|
*/
|
|
isBlocking?: boolean;
|
|
|
|
/**
|
|
* The array of trustlist for the VPN network. The string indicates package name.
|
|
*
|
|
* @type {?Array<string>}
|
|
* @syscap SystemCapability.Communication.NetManager.Vpn
|
|
* @since 11
|
|
*/
|
|
trustedApplications?: Array<string>;
|
|
|
|
/**
|
|
* The array of blocklist for the VPN network. The string indicates package name.
|
|
*
|
|
* @type {?Array<string>}
|
|
* @syscap SystemCapability.Communication.NetManager.Vpn
|
|
* @since 11
|
|
*/
|
|
blockedApplications?: Array<string>;
|
|
}
|
|
}
|
|
export default vpnExtension;
|
|
|