Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2016 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 | */ |
| 16 | |
| 17 | package android.net.ip; |
| 18 | |
Remi NGUYEN VAN | 811f638 | 2019-01-20 12:08:21 +0900 | [diff] [blame] | 19 | import static android.net.util.SocketUtils.makePacketSocketAddress; |
Remi NGUYEN VAN | e7e9f2b | 2019-01-18 19:05:29 +0900 | [diff] [blame] | 20 | import static android.system.OsConstants.AF_PACKET; |
| 21 | import static android.system.OsConstants.ARPHRD_ETHER; |
| 22 | import static android.system.OsConstants.ETH_P_ALL; |
Remi NGUYEN VAN | 231b52b | 2019-01-29 15:38:52 +0900 | [diff] [blame] | 23 | import static android.system.OsConstants.SOCK_NONBLOCK; |
Remi NGUYEN VAN | e7e9f2b | 2019-01-18 19:05:29 +0900 | [diff] [blame] | 24 | import static android.system.OsConstants.SOCK_RAW; |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 25 | |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 26 | import android.net.util.ConnectivityPacketSummary; |
Erik Kline | 8bd00d5 | 2017-12-08 17:47:50 +0900 | [diff] [blame] | 27 | import android.net.util.InterfaceParams; |
Remi NGUYEN VAN | e7e9f2b | 2019-01-18 19:05:29 +0900 | [diff] [blame] | 28 | import android.net.util.PacketReader; |
Remi NGUYEN VAN | 231b52b | 2019-01-29 15:38:52 +0900 | [diff] [blame] | 29 | import android.net.util.SocketUtils; |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 30 | import android.os.Handler; |
| 31 | import android.system.ErrnoException; |
| 32 | import android.system.Os; |
Erik Kline | e42502d | 2017-10-04 20:28:54 +0900 | [diff] [blame] | 33 | import android.text.TextUtils; |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 34 | import android.util.LocalLog; |
Remi NGUYEN VAN | e7e9f2b | 2019-01-18 19:05:29 +0900 | [diff] [blame] | 35 | import android.util.Log; |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 36 | |
Remi NGUYEN VAN | 231b52b | 2019-01-29 15:38:52 +0900 | [diff] [blame] | 37 | import com.android.internal.util.HexDump; |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 38 | |
| 39 | import java.io.FileDescriptor; |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 40 | import java.io.IOException; |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 41 | |
| 42 | |
| 43 | /** |
| 44 | * Critical connectivity packet tracking daemon. |
| 45 | * |
| 46 | * Tracks ARP, DHCPv4, and IPv6 RS/RA/NS/NA packets. |
| 47 | * |
| 48 | * This class's constructor, start() and stop() methods must only be called |
| 49 | * from the same thread on which the passed in |log| is accessed. |
| 50 | * |
| 51 | * Log lines include a hexdump of the packet, which can be decoded via: |
| 52 | * |
| 53 | * echo -n H3XSTR1NG | sed -e 's/\([0-9A-F][0-9A-F]\)/\1 /g' -e 's/^/000000 /' |
| 54 | * | text2pcap - - |
| 55 | * | tcpdump -n -vv -e -r - |
| 56 | * |
| 57 | * @hide |
| 58 | */ |
| 59 | public class ConnectivityPacketTracker { |
| 60 | private static final String TAG = ConnectivityPacketTracker.class.getSimpleName(); |
| 61 | private static final boolean DBG = false; |
| 62 | private static final String MARK_START = "--- START ---"; |
| 63 | private static final String MARK_STOP = "--- STOP ---"; |
Erik Kline | e42502d | 2017-10-04 20:28:54 +0900 | [diff] [blame] | 64 | private static final String MARK_NAMED_START = "--- START (%s) ---"; |
| 65 | private static final String MARK_NAMED_STOP = "--- STOP (%s) ---"; |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 66 | |
| 67 | private final String mTag; |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 68 | private final LocalLog mLog; |
Erik Kline | 84714bf | 2017-05-19 09:29:48 +0900 | [diff] [blame] | 69 | private final PacketReader mPacketListener; |
Erik Kline | f840e07 | 2017-07-10 20:17:30 +0900 | [diff] [blame] | 70 | private boolean mRunning; |
Erik Kline | e42502d | 2017-10-04 20:28:54 +0900 | [diff] [blame] | 71 | private String mDisplayName; |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 72 | |
Erik Kline | 8bd00d5 | 2017-12-08 17:47:50 +0900 | [diff] [blame] | 73 | public ConnectivityPacketTracker(Handler h, InterfaceParams ifParams, LocalLog log) { |
| 74 | if (ifParams == null) throw new IllegalArgumentException("null InterfaceParams"); |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 75 | |
Erik Kline | 8bd00d5 | 2017-12-08 17:47:50 +0900 | [diff] [blame] | 76 | mTag = TAG + "." + ifParams.name; |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 77 | mLog = log; |
Erik Kline | 8bd00d5 | 2017-12-08 17:47:50 +0900 | [diff] [blame] | 78 | mPacketListener = new PacketListener(h, ifParams); |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 79 | } |
| 80 | |
Erik Kline | e42502d | 2017-10-04 20:28:54 +0900 | [diff] [blame] | 81 | public void start(String displayName) { |
Erik Kline | f840e07 | 2017-07-10 20:17:30 +0900 | [diff] [blame] | 82 | mRunning = true; |
Erik Kline | e42502d | 2017-10-04 20:28:54 +0900 | [diff] [blame] | 83 | mDisplayName = displayName; |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 84 | mPacketListener.start(); |
| 85 | } |
| 86 | |
| 87 | public void stop() { |
| 88 | mPacketListener.stop(); |
Erik Kline | f840e07 | 2017-07-10 20:17:30 +0900 | [diff] [blame] | 89 | mRunning = false; |
Erik Kline | e42502d | 2017-10-04 20:28:54 +0900 | [diff] [blame] | 90 | mDisplayName = null; |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 91 | } |
| 92 | |
Erik Kline | 84714bf | 2017-05-19 09:29:48 +0900 | [diff] [blame] | 93 | private final class PacketListener extends PacketReader { |
Erik Kline | 8bd00d5 | 2017-12-08 17:47:50 +0900 | [diff] [blame] | 94 | private final InterfaceParams mInterface; |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 95 | |
Erik Kline | 8bd00d5 | 2017-12-08 17:47:50 +0900 | [diff] [blame] | 96 | PacketListener(Handler h, InterfaceParams ifParams) { |
| 97 | super(h, ifParams.defaultMtu); |
| 98 | mInterface = ifParams; |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 99 | } |
| 100 | |
| 101 | @Override |
Erik Kline | f840e07 | 2017-07-10 20:17:30 +0900 | [diff] [blame] | 102 | protected FileDescriptor createFd() { |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 103 | FileDescriptor s = null; |
| 104 | try { |
Remi NGUYEN VAN | 231b52b | 2019-01-29 15:38:52 +0900 | [diff] [blame] | 105 | s = Os.socket(AF_PACKET, SOCK_RAW | SOCK_NONBLOCK, 0); |
| 106 | SocketUtils.attachControlPacketFilter(s, ARPHRD_ETHER); |
| 107 | SocketUtils.bindSocket( |
| 108 | s, makePacketSocketAddress((short) ETH_P_ALL, mInterface.index)); |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 109 | } catch (ErrnoException | IOException e) { |
| 110 | logError("Failed to create packet tracking socket: ", e); |
Erik Kline | f840e07 | 2017-07-10 20:17:30 +0900 | [diff] [blame] | 111 | closeFd(s); |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 112 | return null; |
| 113 | } |
| 114 | return s; |
| 115 | } |
| 116 | |
| 117 | @Override |
| 118 | protected void handlePacket(byte[] recvbuf, int length) { |
| 119 | final String summary = ConnectivityPacketSummary.summarize( |
Erik Kline | 8bd00d5 | 2017-12-08 17:47:50 +0900 | [diff] [blame] | 120 | mInterface.macAddr, recvbuf, length); |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 121 | if (summary == null) return; |
| 122 | |
| 123 | if (DBG) Log.d(mTag, summary); |
Remi NGUYEN VAN | 231b52b | 2019-01-29 15:38:52 +0900 | [diff] [blame] | 124 | addLogEntry(summary + "\n[" + HexDump.toHexString(recvbuf, 0, length) + "]"); |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 125 | } |
| 126 | |
| 127 | @Override |
Erik Kline | f840e07 | 2017-07-10 20:17:30 +0900 | [diff] [blame] | 128 | protected void onStart() { |
Erik Kline | e42502d | 2017-10-04 20:28:54 +0900 | [diff] [blame] | 129 | final String msg = TextUtils.isEmpty(mDisplayName) |
| 130 | ? MARK_START |
| 131 | : String.format(MARK_NAMED_START, mDisplayName); |
| 132 | mLog.log(msg); |
Erik Kline | f840e07 | 2017-07-10 20:17:30 +0900 | [diff] [blame] | 133 | } |
| 134 | |
| 135 | @Override |
| 136 | protected void onStop() { |
Erik Kline | e42502d | 2017-10-04 20:28:54 +0900 | [diff] [blame] | 137 | String msg = TextUtils.isEmpty(mDisplayName) |
| 138 | ? MARK_STOP |
| 139 | : String.format(MARK_NAMED_STOP, mDisplayName); |
| 140 | if (!mRunning) msg += " (packet listener stopped unexpectedly)"; |
| 141 | mLog.log(msg); |
Erik Kline | f840e07 | 2017-07-10 20:17:30 +0900 | [diff] [blame] | 142 | } |
| 143 | |
| 144 | @Override |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 145 | protected void logError(String msg, Exception e) { |
| 146 | Log.e(mTag, msg, e); |
| 147 | addLogEntry(msg + e); |
| 148 | } |
| 149 | |
| 150 | private void addLogEntry(String entry) { |
Erik Kline | f840e07 | 2017-07-10 20:17:30 +0900 | [diff] [blame] | 151 | mLog.log(entry); |
Erik Kline | 473355f | 2016-10-19 17:42:01 +0900 | [diff] [blame] | 152 | } |
| 153 | } |
| 154 | } |