1/* 2 * Copyright (C) 2019 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16syntax = "proto2"; 17option optimize_for = LITE_RUNTIME; 18package android.net; 19 20enum EventType { 21 EVENT_UNKNOWN = 0; 22 EVENT_GETADDRINFO = 1; 23 EVENT_GETHOSTBYNAME = 2; 24 EVENT_GETHOSTBYADDR = 3; 25 EVENT_RES_NSEND = 4; 26} 27 28// The return value of the DNS resolver for each DNS lookups. 29// bionic/libc/include/netdb.h 30// system/netd/resolv/include/netd_resolv/resolv.h 31enum ReturnCode { 32 RC_EAI_NO_ERROR = 0; 33 RC_EAI_ADDRFAMILY = 1; 34 RC_EAI_AGAIN = 2; 35 RC_EAI_BADFLAGS = 3; 36 RC_EAI_FAIL = 4; 37 RC_EAI_FAMILY = 5; 38 RC_EAI_MEMORY = 6; 39 RC_EAI_NODATA = 7; 40 RC_EAI_NONAME = 8; 41 RC_EAI_SERVICE = 9; 42 RC_EAI_SOCKTYPE = 10; 43 RC_EAI_SYSTEM = 11; 44 RC_EAI_BADHINTS = 12; 45 RC_EAI_PROTOCOL = 13; 46 RC_EAI_OVERFLOW = 14; 47 RC_RESOLV_INTERNAL_ERROR = 254; 48 RC_RESOLV_TIMEOUT = 255; 49 RC_EAI_MAX = 256; 50} 51 52enum NsRcode { 53 NS_R_NO_ERROR = 0; // No error occurred. 54 NS_R_FORMERR = 1; // Format error. 55 NS_R_SERVFAIL = 2; // Server failure. 56 NS_R_NXDOMAIN = 3; // Name error. 57 NS_R_NOTIMPL = 4; // Unimplemented. 58 NS_R_REFUSED = 5; // Operation refused. 59 // these are for BIND_UPDATE 60 NS_R_YXDOMAIN = 6; // Name exists 61 NS_R_YXRRSET = 7; // RRset exists 62 NS_R_NXRRSET = 8; // RRset does not exist 63 NS_R_NOTAUTH = 9; // Not authoritative for zone 64 NS_R_NOTZONE = 10; // Zone of record different from zone section 65 NS_R_MAX = 11; 66 // Define rcode=12~15(UNASSIGNED) in rcode enum type. 67 // Some DNS Servers might return undefined code to devices. 68 // Without the enum definition, that would be noise for our dashboard. 69 NS_R_UNASSIGNED12 = 12; // Unassigned 70 NS_R_UNASSIGNED13 = 13; // Unassigned 71 NS_R_UNASSIGNED14 = 14; // Unassigned 72 NS_R_UNASSIGNED15 = 15; // Unassigned 73 // The following are EDNS extended rcodes 74 NS_R_BADVERS = 16; 75 // The following are TSIG errors 76 // NS_R_BADSIG = 16, 77 NS_R_BADKEY = 17; 78 NS_R_BADTIME = 18; 79 NS_R_INTERNAL_ERROR = 254; 80 NS_R_TIMEOUT = 255; 81} 82 83// Currently defined type values for resources and queries. 84enum NsType { 85 NS_T_INVALID = 0; // Cookie. 86 NS_T_A = 1; // Host address. 87 NS_T_NS = 2; // Authoritative server. 88 NS_T_MD = 3; // Mail destination. 89 NS_T_MF = 4; // Mail forwarder. 90 NS_T_CNAME = 5; // Canonical name. 91 NS_T_SOA = 6; // Start of authority zone. 92 NS_T_MB = 7; // Mailbox domain name. 93 NS_T_MG = 8; // Mail group member. 94 NS_T_MR = 9; // Mail rename name. 95 NS_T_NULL = 10; // Null resource record. 96 NS_T_WKS = 11; // Well known service. 97 NS_T_PTR = 12; // Domain name pointer. 98 NS_T_HINFO = 13; // Host information. 99 NS_T_MINFO = 14; // Mailbox information. 100 NS_T_MX = 15; // Mail routing information. 101 NS_T_TXT = 16; // Text strings. 102 NS_T_RP = 17; // Responsible person. 103 NS_T_AFSDB = 18; // AFS cell database. 104 NS_T_X25 = 19; // X_25 calling address. 105 NS_T_ISDN = 20; // ISDN calling address. 106 NS_T_RT = 21; // Router. 107 NS_T_NSAP = 22; // NSAP address. 108 NS_T_NSAP_PTR = 23; // Reverse NSAP lookup (deprecated). 109 NS_T_SIG = 24; // Security signature. 110 NS_T_KEY = 25; // Security key. 111 NS_T_PX = 26; // X.400 mail mapping. 112 NS_T_GPOS = 27; // Geographical position (withdrawn). 113 NS_T_AAAA = 28; // IPv6 Address. 114 NS_T_LOC = 29; // Location Information. 115 NS_T_NXT = 30; // Next domain (security). 116 NS_T_EID = 31; // Endpoint identifier. 117 NS_T_NIMLOC = 32; // Nimrod Locator. 118 NS_T_SRV = 33; // Server Selection. 119 NS_T_ATMA = 34; // ATM Address 120 NS_T_NAPTR = 35; // Naming Authority PoinTeR 121 NS_T_KX = 36; // Key Exchange 122 NS_T_CERT = 37; // Certification record 123 NS_T_A6 = 38; // IPv6 address (experimental) 124 NS_T_DNAME = 39; // Non-terminal DNAME 125 NS_T_SINK = 40; // Kitchen sink (experimentatl) 126 NS_T_OPT = 41; // EDNS0 option (meta-RR) 127 NS_T_APL = 42; // Address prefix list (RFC 3123) 128 NS_T_DS = 43; // Delegation Signer 129 NS_T_SSHFP = 44; // SSH Fingerprint 130 NS_T_IPSECKEY = 45; // IPSEC Key 131 NS_T_RRSIG = 46; // RRset Signature 132 NS_T_NSEC = 47; // Negative security 133 NS_T_DNSKEY = 48; // DNS Key 134 NS_T_DHCID = 49; // Dynamic host configuratin identifier 135 NS_T_NSEC3 = 50; // Negative security type 3 136 NS_T_NSEC3PARAM = 51; // Negative security type 3 parameters 137 NS_T_HIP = 55; // Host Identity Protocol 138 NS_T_SPF = 99; // Sender Policy Framework 139 NS_T_TKEY = 249; // Transaction key 140 NS_T_TSIG = 250; // Transaction signature. 141 NS_T_IXFR = 251; // Incremental zone transfer. 142 NS_T_AXFR = 252; // Transfer zone of authority. 143 NS_T_MAILB = 253; // Transfer mailbox records. 144 NS_T_MAILA = 254; // Transfer mail agent records. 145 NS_T_ANY = 255; // Wildcard match. 146 NS_T_ZXFR = 256; // BIND-specific, nonstandard. 147 NS_T_DLV = 32769; // DNSSEC look-aside validatation. 148 NS_T_MAX = 65536; 149} 150 151enum IpVersion { 152 IV_UNKNOWN = 0; 153 IV_IPV4 = 1; 154 IV_IPV6 = 2; 155} 156 157enum Protocol { 158 PROTO_UNKNOWN = 0; 159 PROTO_UDP = 1; 160 PROTO_TCP = 2; 161 PROTO_DOT = 3; 162 PROTO_DOH = 4; 163} 164 165enum PrivateDnsModes { 166 PDM_UNKNOWN = 0; 167 PDM_OFF = 1; 168 PDM_OPPORTUNISTIC = 2; 169 PDM_STRICT = 3; 170} 171 172enum NetworkType { 173 NT_UNKNOWN = 0; 174 // Indicates this network uses a Cellular transport. 175 NT_CELLULAR = 1; 176 // Indicates this network uses a Wi-Fi transport. 177 NT_WIFI = 2; 178 // Indicates this network uses a Bluetooth transport. 179 NT_BLUETOOTH = 3; 180 // Indicates this network uses an Ethernet transport. 181 NT_ETHERNET = 4; 182 // Indicates this network uses a VPN transport, now deprecated. 183 NT_VPN = 5 [deprecated=true]; 184 // Indicates this network uses a Wi-Fi Aware transport. 185 NT_WIFI_AWARE = 6; 186 // Indicates this network uses a LoWPAN transport. 187 NT_LOWPAN = 7; 188 // Indicates this network uses a Cellular+VPN transport. 189 NT_CELLULAR_VPN = 8; 190 // Indicates this network uses a Wi-Fi+VPN transport. 191 NT_WIFI_VPN = 9; 192 // Indicates this network uses a Bluetooth+VPN transport. 193 NT_BLUETOOTH_VPN = 10; 194 // Indicates this network uses an Ethernet+VPN transport. 195 NT_ETHERNET_VPN = 11; 196 // Indicates this network uses a Wi-Fi+Cellular+VPN transport. 197 NT_WIFI_CELLULAR_VPN = 12; 198} 199 200enum CacheStatus{ 201 // the cache can't handle that kind of queries. 202 // or the answer buffer is too small. 203 CS_UNSUPPORTED = 0; 204 // the cache doesn't know about this query. 205 CS_NOTFOUND = 1; 206 // the cache found the answer. 207 CS_FOUND = 2; 208 // Don't do anything on cache. 209 CS_SKIP = 3; 210} 211 212// The enum LinuxErrno is defined in the following 2 files. 213// 1. bionic/libc/kernel/uapi/asm-generic/errno-base.h 214// 2. bionic/libc/kernel/uapi/asm-generic/errno.h 215enum LinuxErrno { 216 SYS_NO_ERROR = 0; 217 SYS_EPERM = 1; // Not super-user 218 SYS_ENOENT = 2; // No such file or directory 219 SYS_ESRCH = 3; // No such process 220 SYS_EINTR = 4; // Interrupted system call 221 SYS_EIO = 5; // I/O error 222 SYS_ENXIO = 6; // No such device or address 223 SYS_E2BIG = 7; // Arg list too long 224 SYS_ENOEXEC = 8; // Exec format error 225 SYS_EBADF = 9; // Bad file number 226 SYS_ECHILD = 10; // No children 227 SYS_EAGAIN = 11; // No more processes 228 SYS_ENOMEM = 12; // Not enough core 229 SYS_EACCES = 13; // Permission denied 230 SYS_EFAULT = 14; // Bad address 231 SYS_ENOTBLK = 15; // Block device required 232 SYS_EBUSY = 16; // Mount device busy 233 SYS_EEXIST = 17; // File exists 234 SYS_EXDEV = 18; // Cross-device link 235 SYS_ENODEV = 19; // No such device 236 SYS_ENOTDIR = 20; // Not a directory 237 SYS_EISDIR = 21; // Is a directory 238 SYS_EINVAL = 22; // Invalid argument 239 SYS_ENFILE = 23; // Too many open files in system 240 SYS_EMFILE = 24; // Too many open files 241 SYS_ENOTTY = 25; // Not a typewriter 242 SYS_ETXTBSY = 26; // Text file busy 243 SYS_EFBIG = 27; // File too large 244 SYS_ENOSPC = 28; // No space left on device 245 SYS_ESPIPE = 29; // Illegal seek 246 SYS_EROFS = 30; // Read only file system 247 SYS_EMLINK = 31; // Too many links 248 SYS_EPIPE = 32; // Broken pipe 249 SYS_EDOM = 33; // Math arg out of domain of func 250 SYS_ERANGE = 34; // Math result not representable 251 SYS_EDEADLOCK = 35; // File locking deadlock error 252 SYS_ENAMETOOLONG = 36; // File or path name too long 253 SYS_ENOLCK = 37; // No record locks available 254 SYS_ENOSYS = 38; // Function not implemented 255 SYS_ENOTEMPTY = 39; // Directory not empty 256 SYS_ELOOP = 40; // Too many symbolic links 257 SYS_ENOMSG = 42; // No message of desired type 258 SYS_EIDRM = 43; // Identifier removed 259 SYS_ECHRNG = 44; // Channel number out of range 260 SYS_EL2NSYNC = 45; // Level 2 not synchronized 261 SYS_EL3HLT = 46; // Level 3 halted 262 SYS_EL3RST = 47; // Level 3 reset 263 SYS_ELNRNG = 48; // Link number out of range 264 SYS_EUNATCH = 49; // rotocol driver not attached 265 SYS_ENOCSI = 50; // No CSI structure available 266 SYS_EL2HLT = 51; // Level 2 halted 267 SYS_EBADE = 52; // Invalid exchange 268 SYS_EBADR = 53; // Invalid request descriptor 269 SYS_EXFULL = 54; // Exchange full 270 SYS_ENOANO = 55; // No anode 271 SYS_EBADRQC = 56; // Invalid request code 272 SYS_EBADSLT = 57; // Invalid slot 273 SYS_EBFONT = 59; // Bad font file fmt 274 SYS_ENOSTR = 60; // Device not a stream 275 SYS_ENODATA = 61; // No data (for no delay io) 276 SYS_ETIME = 62; // Timer expired 277 SYS_ENOSR = 63; // Out of streams resources 278 SYS_ENONET = 64; // Machine is not on the network 279 SYS_ENOPKG = 65; // Package not installed 280 SYS_EREMOTE = 66; // The object is remote 281 SYS_ENOLINK = 67; // The link has been severed 282 SYS_EADV = 68; // Advertise error 283 SYS_ESRMNT = 69; // Srmount error 284 SYS_ECOMM = 70; // Communication error on send 285 SYS_EPROTO = 71; // Protocol error 286 SYS_EMULTIHOP = 72; // Multihop attempted 287 SYS_EDOTDOT = 73; // Cross mount point (not really error) 288 SYS_EBADMSG = 74; // Trying to read unreadable message 289 SYS_EOVERFLOW = 75; // Value too large for defined data type 290 SYS_ENOTUNIQ = 76; // Given log. name not unique 291 SYS_EBADFD = 77; // f.d. invalid for this operation 292 SYS_EREMCHG = 78; // Remote address changed 293 SYS_ELIBACC = 79; // Can't access a needed shared lib 294 SYS_ELIBBAD = 80; // Accessing a corrupted shared lib 295 SYS_ELIBSCN = 81; // .lib section in a.out corrupted 296 SYS_ELIBMAX = 82; // Attempting to link in too many libs 297 SYS_ELIBEXEC = 83; // Attempting to exec a shared library 298 SYS_EILSEQ = 84; 299 SYS_ERESTART = 85; 300 SYS_ESTRPIPE = 86; 301 SYS_EUSERS = 87; 302 SYS_ENOTSOCK = 88; // Socket operation on non-socket 303 SYS_EDESTADDRREQ = 89; // Destination address required 304 SYS_EMSGSIZE = 90; // Message too long 305 SYS_EPROTOTYPE = 91; // Protocol wrong type for socket 306 SYS_ENOPROTOOPT = 92; // Protocol not available 307 SYS_EPROTONOSUPPORT = 93; // Unknown protocol 308 SYS_ESOCKTNOSUPPORT = 94; // Socket type not supported 309 SYS_EOPNOTSUPP = 95; // Operation not supported on transport endpoint 310 SYS_EPFNOSUPPORT = 96; // Protocol family not supported 311 SYS_EAFNOSUPPORT = 97; // Address family not supported by protocol family 312 SYS_EADDRINUSE = 98; // Address already in use 313 SYS_EADDRNOTAVAIL = 99; // Address not available 314 SYS_ENETDOWN = 100; // Network interface is not configured 315 SYS_ENETUNREACH = 101; // Network is unreachable 316 SYS_ENETRESET = 102; 317 SYS_ECONNABORTED = 103; // Connection aborted 318 SYS_ECONNRESET = 104; // Connection reset by peer 319 SYS_ENOBUFS = 105; // No buffer space available 320 SYS_EISCONN = 106; // Socket is already connected 321 SYS_ENOTCONN = 107; // Socket is not connected 322 SYS_ESHUTDOWN = 108; // Can't send after socket shutdown 323 SYS_ETOOMANYREFS = 109; 324 SYS_ETIMEDOUT = 110; // Connection timed out 325 SYS_ECONNREFUSED = 111; // Connection refused 326 SYS_EHOSTDOWN = 112; // Host is down 327 SYS_EHOSTUNREACH = 113; // Host is unreachable 328 SYS_EALREADY = 114; // Socket already connected 329 SYS_EINPROGRESS = 115; // Connection already in progress 330 SYS_ESTALE = 116; 331 SYS_EUCLEAN = 117; 332 SYS_ENOTNAM = 118; 333 SYS_ENAVAIL = 119; 334 SYS_EISNAM = 120; 335 SYS_EREMOTEIO = 121; 336 SYS_EDQUOT = 122; 337 SYS_ENOMEDIUM = 123; // No medium (in tape drive) 338 SYS_EMEDIUMTYPE = 124; 339 SYS_ECANCELED = 125; 340 SYS_ENOKEY = 126; 341 SYS_EKEYEXPIRED = 127; 342 SYS_EKEYREVOKED = 128; 343 SYS_EKEYREJECTED = 129; 344 SYS_EOWNERDEAD = 130; 345 SYS_ENOTRECOVERABLE = 131; 346 SYS_ERFKILL = 132; 347 SYS_EHWPOISON = 133; 348} 349 350message DnsQueryEvent { 351 optional NsRcode rcode = 1; 352 353 optional NsType type = 2; 354 355 optional CacheStatus cache_hit = 3; 356 357 optional IpVersion ip_version = 4; 358 359 optional Protocol protocol = 5; 360 361 // Number of DNS query retry times 362 optional int32 retry_times = 6; 363 364 // Ordinal number of name server. 365 optional int32 dns_server_index = 7; 366 367 // Used only by TCP and DOT. True for new connections. 368 optional bool connected = 8; 369 370 optional int32 latency_micros = 9; 371 372 optional LinuxErrno linux_errno = 10; 373} 374 375message DnsQueryEvents { 376 repeated DnsQueryEvent dns_query_event = 1; 377} 378 379/** 380 * Logs a DNS lookup operation initiated by the system resolver on behalf of an application 381 * invoking native APIs such as getaddrinfo() or Java APIs such as Network#getAllByName(). 382 * 383 * The NetworkDnsEventReported message represents the entire lookup operation, which may 384 * result one or more queries to the recursive DNS resolvers. Those are individually logged 385 * in DnsQueryEvents to enable computing error rates and network latency and timeouts 386 * broken up by query type, transport, network interface, etc. 387 */ 388message NetworkDnsEventReported { 389 optional EventType event_type = 1; 390 391 optional ReturnCode return_code = 2; 392 393 // The latency in microseconds of the entire DNS lookup operation. 394 optional int32 latency_micros = 3; 395 396 // Only valid for event_type = EVENT_GETADDRINFO. 397 optional int32 hints_ai_flags = 4; 398 399 // Flags passed to android_res_nsend() defined in multinetwork.h 400 // Only valid for event_type = EVENT_RESNSEND. 401 optional int32 res_nsend_flags = 5; 402 403 optional NetworkType network_type = 6; 404 405 // The DNS over TLS mode on a specific netId. 406 optional PrivateDnsModes private_dns_modes = 7; 407 408 // Additional pass-through fields opaque to statsd. 409 // The DNS resolver Mainline module can add new fields here without requiring an OS update. 410 optional DnsQueryEvents dns_query_events = 8; 411 412 // The sample rate of DNS stats (to statsd) is 1/sampling_rate_denom. 413 optional int32 sampling_rate_denom = 9; 414} 415