• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1#!/usr/bin/env python3
2#
3#   Copyright 2016 - Google
4#
5#   Licensed under the Apache License, Version 2.0 (the "License");
6#   you may not use this file except in compliance with the License.
7#   You may obtain a copy of the License at
8#
9#       http://www.apache.org/licenses/LICENSE-2.0
10#
11#   Unless required by applicable law or agreed to in writing, software
12#   distributed under the License is distributed on an "AS IS" BASIS,
13#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14#   See the License for the specific language governing permissions and
15#   limitations under the License.
16
17import enum
18
19######################################################
20# ConnectivityManager.NetworkCallback events
21######################################################
22EVENT_NETWORK_CALLBACK = "NetworkCallback"
23
24# event types
25NETWORK_CB_PRE_CHECK = "PreCheck"
26NETWORK_CB_AVAILABLE = "Available"
27NETWORK_CB_LOSING = "Losing"
28NETWORK_CB_LOST = "Lost"
29NETWORK_CB_UNAVAILABLE = "Unavailable"
30NETWORK_CB_CAPABILITIES_CHANGED = "CapabilitiesChanged"
31NETWORK_CB_SUSPENDED = "Suspended"
32NETWORK_CB_RESUMED = "Resumed"
33NETWORK_CB_LINK_PROPERTIES_CHANGED = "LinkPropertiesChanged"
34NETWORK_CB_INVALID = "Invalid"
35
36# event data keys
37NETWORK_CB_KEY_ID = "id"
38NETWORK_CB_KEY_EVENT = "networkCallbackEvent"
39NETWORK_CB_KEY_MAX_MS_TO_LIVE = "maxMsToLive"
40NETWORK_CB_KEY_RSSI = "rssi"
41NETWORK_CB_KEY_INTERFACE_NAME = "interfaceName"
42NETWORK_CB_KEY_CREATE_TS = "creation_timestamp"
43NETWORK_CB_KEY_CURRENT_TS = "current_timestamp"
44NETWORK_CB_KEY_NETWORK_SPECIFIER = "network_specifier"
45NETWORK_CB_KEY_TRANSPORT_INFO = "transport_info"
46
47# Constants for VPN connection status
48VPN_STATE_DISCONNECTED = 0
49VPN_STATE_INITIALIZING = 1
50VPN_STATE_CONNECTING = 2
51VPN_STATE_CONNECTED = 3
52VPN_STATE_TIMEOUT = 4
53VPN_STATE_FAILED = 5
54# TODO gmoturu: determine the exact timeout value
55# This is a random value as of now
56VPN_TIMEOUT = 30
57
58# Connectiivty Manager constants
59TYPE_MOBILE = 0
60TYPE_WIFI = 1
61
62# Network request related constants.
63NETWORK_CAP_TRANSPORT_WIFI = TYPE_WIFI
64NETWORK_CAP_CAPABILITY_INTERNET = 12
65
66# Network request related keys.
67NETWORK_CAP_TRANSPORT_TYPE_KEY = "TransportType"
68NETWORK_CAP_CAPABILITY_KEY = "Capability"
69
70# Multipath preference constants
71MULTIPATH_PREFERENCE_NONE = 0
72MULTIPATH_PREFERENCE_HANDOVER = 1 << 0
73MULTIPATH_PREFERENCE_RELIABILITY = 1 << 1
74MULTIPATH_PREFERENCE_PERFORMANCE = 1 << 2
75
76# Private DNS constants
77DNS_GOOGLE = "dns.google"
78DNS_QUAD9 = "dns.quad9.net"
79DNS_CLOUDFLARE = "1dot1dot1dot1.cloudflare-dns.com"
80PRIVATE_DNS_MODE_OFF = "off"
81PRIVATE_DNS_MODE_OPPORTUNISTIC = "opportunistic"
82PRIVATE_DNS_MODE_STRICT = "hostname"
83
84# IpSec constants
85SOCK_STREAM = 1
86SOCK_DGRAM = 2
87AF_INET = 2
88AF_INET6 = 10
89DIRECTION_IN = 0
90DIRECTION_OUT = 1
91MODE_TRANSPORT = 0
92MODE_TUNNEL = 1
93CRYPT_NULL = "ecb(cipher_null)"
94CRYPT_AES_CBC = "cbc(aes)"
95AUTH_HMAC_MD5 = "hmac(md5)"
96AUTH_HMAC_SHA1 = "hmac(sha1)"
97AUTH_HMAC_SHA256 = "hmac(sha256)"
98AUTH_HMAC_SHA384 = "hmac(sha384)"
99AUTH_HMAC_SHA512 = "hmac(sha512)"
100AUTH_CRYPT_AES_GCM = "rfc4106(gcm(aes))"
101
102
103# Constants for VpnProfile
104class VpnProfile(object):
105    """ This class contains all the possible
106        parameters required for VPN connection
107    """
108    NAME = "name"
109    TYPE = "type"
110    SERVER = "server"
111    USER = "username"
112    PWD = "password"
113    DNS = "dnsServers"
114    SEARCH_DOMAINS = "searchDomains"
115    ROUTES = "routes"
116    MPPE = "mppe"
117    L2TP_SECRET = "l2tpSecret"
118    IPSEC_ID = "ipsecIdentifier"
119    IPSEC_SECRET = "ipsecSecret"
120    IPSEC_USER_CERT = "ipsecUserCert"
121    IPSEC_CA_CERT = "ipsecCaCert"
122    IPSEC_SERVER_CERT = "ipsecServerCert"
123
124
125# Enums for VPN profile types
126class VpnProfileType(enum.Enum):
127    """ Integer constant for each type of VPN
128    """
129    PPTP = 0
130    L2TP_IPSEC_PSK = 1
131    L2TP_IPSEC_RSA = 2
132    IPSEC_XAUTH_PSK = 3
133    IPSEC_XAUTH_RSA = 4
134    IPSEC_HYBRID_RSA = 5
135    IKEV2_IPSEC_USER_PASS = 6
136    IKEV2_IPSEC_PSK = 7
137    IKEV2_IPSEC_RSA = 8
138
139
140# Constants for config file
141class VpnReqParams(object):
142    """ Config file parameters required for
143        VPN connection
144    """
145    vpn_server_addresses = "vpn_server_addresses"
146    vpn_verify_addresses = "vpn_verify_addresses"
147    vpn_username = "vpn_username"
148    vpn_password = "vpn_password"
149    psk_secret = "psk_secret"
150    client_pkcs_file_name = "client_pkcs_file_name"
151    cert_path_vpnserver = "cert_path_vpnserver"
152    cert_password = "cert_password"
153    pptp_mppe = "pptp_mppe"
154    ipsec_server_type = "ipsec_server_type"
155    wifi_network = "wifi_network"
156    vpn_identity = "vpn_identity"
157    vpn_server_hostname = "vpn_server_hostname"
158