doc/androiddump.pod

   1
   2 =head1 NAME
   3
   4 androiddump - Provide interfaces to capture from Android devices
   5
   6 =head1 SYNOPSIS
   7
   8 B<androiddump>
   9 S<[ B<--help> ]>
  10 S<[ B<--version> ]>
  11 S<[ B<--extcap-interfaces> ]>
  12 S<[ B<--extcap-dlts> ]>
  13 S<[ B<--extcap-interface>=E<lt>interfaceE<gt> ]>
  14 S<[ B<--extcap-config> ]>
  15 S<[ B<--capture> ]>
  16 S<[ B<--fifo>=E<lt>path to file or pipeE<gt> ]>
  17 S<[ B<--adb-server-ip>=E<lt>IP addressE<gt> ]>
  18 S<[ B<--adb-server-tcp-port>=E<lt>TCP portE<gt> ]>
  19 S<[ B<--logcat-text>=E<lt>TRUE or FALSEE<gt> ]>
  20 S<[ B<--bt-server-tcp-port>=E<lt>TCP portE<gt> ]>
  21 S<[ B<--bt-forward-socket>=E<lt>TRUE or FALSEE<gt> ]>
  22 S<[ B<--bt-local-ip>=E<lt>IP addressE<gt> ]>
  23 S<[ B<--bt-local-tcp-port>=E<lt>TCP portE<gt> ]>
  24
  25 B<androiddump>
  26 S< B<--extcap-interfaces> >
  27 S<[ B<--adb-server-ip>=E<lt>IP addressE<gt> ]>
  28 S<[ B<--adb-server-tcp-port>=E<lt>TCP portE<gt> ]>
  29
  30 B<androiddump>
  31 S< B<--extcap-interface>=E<lt>interfaceE<gt> >
  32 S<[ B<--extcap-dlts> ]>
  33
  34 B<androiddump>
  35 S< B<--extcap-interface>=E<lt>interfaceE<gt> >
  36 S<[ B<--extcap-config> ]>
  37
  38 B<androiddump>
  39 S< B<--extcap-interface>=E<lt>interfaceE<gt> >
  40 S< B<--fifo>=E<lt>path to file or pipeE<gt> >
  41 S< B<--capture> >
  42
  43 =head1 DESCRIPTION
  44
  45 B<Androiddump> is a extcap tool that provide interfaces to capture from
  46 Android device. There is only two requirements:
  47
  48 1. You must have Android SDK and add it PATH environment variable.
  49 PATH should contain directory with tools like "adb" and "android".
  50 Android SDK for various platform are available on:
  51 https://developer.android.com/sdk/index.html#Other
  52
  53 2. You must have permission to Android devices.
  54
  55
  56 Supported interfaces:
  57
  58 =over 4
  59
  60 =item 1. Logcat Main (binary or text)
  61
  62 =item 2. Logcat System (binary or text)
  63
  64 =item 3. Logcat Events (binary or text)
  65
  66 =item 4. Logcat Radio (binary or text)
  67
  68 =item 5. Logcat Crash (text; Lollipop)
  69
  70 =item 6. Bluetooth Hcidump (<Kitkat)
  71
  72 =item 7. Bluetooth Bluedroid External Parser (Kitkat)
  73
  74 =item 8. Bluetooth BtsnoopNet (Lollipop)
  75
  76 =back
  77
  78 Please note that it will work also for FirefoxOS.
  79
  80 NOTE: If one of device require ADB Authentication you need accept or reject that
  81 request. Otherwise no devices will be available.
  82
  83 =head1 OPTIONS
  84
  85 =over 4
  86
  87 =item --help
  88
  89 Print program arguments.
  90
  91 =item --version
  92
  93 Print program version.
  94
  95 =item --extcap-interfaces
  96
  97 List available interfaces.
  98
  99 =item --extcap-interface=E<lt>interfaceE<gt>
 100
 101 Use specified interfaces.
 102
 103 =item --extcap-dlts
 104
 105 List DLTs of specified interface.
 106
 107 =item --extcap-config
 108
 109 List configuration options of specified interface.
 110
 111 =item --capture
 112
 113 Start capturing from specified interface save saved it in place specified by --fifo.
 114
 115 =item --fifo=E<lt>path to file or pipeE<gt>
 116
 117 Save captured packet to file or send it through pipe.
 118
 119 =item --adb-server-ip=E<lt>IP addressE<gt>
 120
 121 Use other then default (127.0.0.1) ADB daemon's IP address.
 122
 123 =item --adb-server-tcp-port=E<lt>TCP portE<gt>
 124
 125 Use other then default (5037) ADB daemon's TCP port.
 126
 127 =item --logcat-text=E<lt>TRUE or FALSEE<gt>
 128
 129 If TRUE then use text logcat rather then binary. This option has effect only on
 130 Logcat interfaces. This have no effect from Lollipop where is no binary Logcat
 131 available.
 132
 133 Defaults to FALSE.
 134
 135 =item --bt-server-tcp-port=E<lt>TCP portE<gt>
 136
 137 Use other then default Bluetooth server TCP port on Android side.
 138 On Lollipop defaults is 8872, earlier 4330.
 139
 140 =item --bt-forward-socket=E<lt>TRUE or FALSEE<gt>
 141
 142 If TRUE then socket from Android side is forwarded to host side.
 143
 144 Defaults to FALSE.
 145
 146 =item --bt-local-ip=E<lt>IP addressE<gt>
 147
 148 Use other then default (127.0.0.1) IP address on host side for forwarded socket.
 149
 150 =item --bt-local-tcp-port=E<lt>TCP portE<gt>
 151
 152 Specify port to be used on host side for forwarded socket.
 153
 154 =back
 155
 156 =head1 EXAMPLES
 157
 158 To see program arguments:
 159
 160     androiddump --help
 161
 162 To see program version:
 163
 164     androiddump --version
 165
 166 To see interfaces:
 167
 168     androiddump --extcap-interfaces
 169
 170   Example output:
 171     interface {display=Android Logcat Main}{value=android-logcat-main-MSM7627A}
 172     interface {display=Android Logcat System}{value=android-logcat-system-MSM7627A}
 173     interface {display=Android Logcat Radio}{value=android-logcat-radio-MSM7627A}
 174     interface {display=Android Logcat Events}{value=android-logcat-events-MSM7627A}
 175     interface {display=Android Bluetooth Hcidump}{value=android-bluetooth-hcidump-MSM7627A}
 176
 177 To see interface DLTs:
 178
 179     androiddump --extcap-interface=android-bluetooth-hcidump-MSM7627A --extcap-dlts
 180
 181   Example output:
 182     dlt {number=99}{name=BluetoothH4}{display=Bluetooth HCI UART transport layer plus pseudo-header}
 183
 184
 185 To see interface configuration options:
 186
 187     androiddump --extcap-interface=android-bluetooth-hcidump-MSM7627A --extcap-dlts
 188
 189   Example output:
 190     arg {number=0}{call=--adb-server-ip}{display=ADB Server IP Address}{type=string}{default=127.0.0.1}
 191     arg {number=1}{call=--adb-server-tcp-port}{display=ADB Server TCP Port}{type=integer}{range=0,65535}{default=5037}
 192
 193
 194 To capture:
 195
 196     androiddump --extcap-interface=android-bluetooth-hcidump-MSM7627A --fifo=/tmp/bluetooth.pcapng --capture
 197
 198 NOTE: To stop capturing CTRL+C/kill/terminate application.
 199
 200 =head1 SEE ALSO
 201
 202 wireshark(1), tshark(1), dumpcap(1), extcap(4)
 203
 204 =head1 NOTES
 205
 206 B<Androiddump> is part of the B<Wireshark> distribution.  The latest version
 207 of B<Wireshark> can be found at L<https://www.wireshark.org>.
 208
 209 HTML versions of the Wireshark project man pages are available at:
 210 L<https://www.wireshark.org/docs/man-pages>.
 211
 212 =head1 AUTHORS
 213
 214   Original Author
 215   -------- ------
 216   Michal Labedzki             <michal.labedzki[AT]tieto.com>
 217
 218
 219   Contributors
 220   ------------
 221   Roland Knall              <rknall[AT]gmail.com>