androiddump.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="UTF-8">
  5. <meta http-equiv="X-UA-Compatible" content="IE=edge">
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <meta name="generator" content="Asciidoctor 2.0.17">
  8. <title>androiddump(1)</title>
  9. <link rel="stylesheet" href="./ws.css">
  10. </head>
  11. <body class="manpage">
  12. <div id="header">
  13. <h1>androiddump(1) Manual Page</h1>
  14. <h2 id="_name">NAME</h2>
  15. <div class="sectionbody">
  16. <p>androiddump - Provide interfaces to capture from Android devices</p>
  17. </div>
  18. </div>
  19. <div id="content">
  20. <div class="sect1">
  21. <h2 id="_synopsis">SYNOPSIS</h2>
  22. <div class="sectionbody">
  23. <div class="paragraph">
  24. <p><span class="nowrap"><strong>androiddump</strong></span>
  25. <span class="nowrap">[ <strong>--help</strong> ]</span>
  26. <span class="nowrap">[ <strong>--version</strong> ]</span>
  27. <span class="nowrap">[ <strong>--extcap-version</strong> ]</span>
  28. <span class="nowrap">[ <strong>--debug</strong> ]</span>
  29. <span class="nowrap">[ <strong>--extcap-interfaces</strong> ]</span>
  30. <span class="nowrap">[ <strong>--extcap-dlts</strong> ]</span>
  31. <span class="nowrap">[ <strong>--extcap-interface</strong>=&lt;interface&gt; ]</span>
  32. <span class="nowrap">[ <strong>--extcap-config</strong> ]</span>
  33. <span class="nowrap">[ <strong>--capture</strong> ]</span>
  34. <span class="nowrap">[ <strong>--fifo</strong>=&lt;path to file or pipe&gt; ]</span>
  35. <span class="nowrap">[ <strong>--adb-server-ip</strong>=&lt;IP address&gt; ]</span>
  36. <span class="nowrap">[ <strong>--adb-server-tcp-port</strong>=&lt;TCP port&gt; ]</span>
  37. <span class="nowrap">[ <strong>--logcat-text</strong>=&lt;TRUE or FALSE&gt; ]</span>
  38. <span class="nowrap">[ <strong>--bt-server-tcp-port</strong>=&lt;TCP port&gt; ]</span>
  39. <span class="nowrap">[ <strong>--bt-forward-socket</strong>=&lt;TRUE or FALSE&gt; ]</span>
  40. <span class="nowrap">[ <strong>--bt-local-ip</strong>=&lt;IP address&gt; ]</span>
  41. <span class="nowrap">[ <strong>--bt-local-tcp-port</strong>=&lt;TCP port&gt; ]</span></p>
  42. </div>
  43. <div class="paragraph">
  44. <p><span class="nowrap"><strong>androiddump</strong></span>
  45. <span class="nowrap"><strong>--extcap-interfaces</strong></span>
  46. <span class="nowrap">[ <strong>--adb-server-ip</strong>=&lt;IP address&gt; ]</span>
  47. <span class="nowrap">[ <strong>--adb-server-tcp-port</strong>=&lt;TCP port&gt; ]</span></p>
  48. </div>
  49. <div class="paragraph">
  50. <p><span class="nowrap"><strong>androiddump</strong></span>
  51. <span class="nowrap"><strong>--extcap-interface</strong>=&lt;interface&gt;</span>
  52. <span class="nowrap">[ <strong>--extcap-dlts</strong> ]</span></p>
  53. </div>
  54. <div class="paragraph">
  55. <p><span class="nowrap"><strong>androiddump</strong></span>
  56. <span class="nowrap"><strong>--extcap-interface</strong>=&lt;interface&gt;</span>
  57. <span class="nowrap">[ <strong>--extcap-config</strong> ]</span></p>
  58. </div>
  59. <div class="paragraph">
  60. <p><span class="nowrap"><strong>androiddump</strong></span>
  61. <span class="nowrap"><strong>--extcap-interface</strong>=&lt;interface&gt;</span>
  62. <span class="nowrap"><strong>--fifo</strong>=&lt;path to file or pipe&gt;</span>
  63. <span class="nowrap"><strong>--capture</strong></span></p>
  64. </div>
  65. </div>
  66. </div>
  67. <div class="sect1">
  68. <h2 id="_description">DESCRIPTION</h2>
  69. <div class="sectionbody">
  70. <div class="paragraph">
  71. <p><strong>Androiddump</strong> is a extcap tool that provide interfaces to capture from
  72. an Android device. There are only two requirements:</p>
  73. </div>
  74. <div class="olist arabic">
  75. <ol class="arabic">
  76. <li>
  77. <p>You must have the Android SDK and add it to your PATH environment variable.
  78. PATH should contain directory with tools like "adb" and "android".
  79. Android SDK for various platform are available on:
  80. <a href="https://developer.android.com/sdk/index.html#Other" class="bare">https://developer.android.com/sdk/index.html#Other</a></p>
  81. </li>
  82. <li>
  83. <p>You must have permission to capture from the Android device.
  84. Some Android devices require on-screen authentication.</p>
  85. </li>
  86. </ol>
  87. </div>
  88. <div class="paragraph">
  89. <p>Supported interfaces:</p>
  90. </div>
  91. <div class="olist arabic">
  92. <ol class="arabic">
  93. <li>
  94. <p>Logcat Main (binary [&lt;=Jelly Bean] or text)</p>
  95. </li>
  96. <li>
  97. <p>Logcat System (binary [&lt;=Jelly Bean] or text)</p>
  98. </li>
  99. <li>
  100. <p>Logcat Events (binary [&lt;=Jelly Bean] or text)</p>
  101. </li>
  102. <li>
  103. <p>Logcat Radio (binary [&lt;=Jelly Bean] or text)</p>
  104. </li>
  105. <li>
  106. <p>Logcat Crash (text; from Lollipop)</p>
  107. </li>
  108. <li>
  109. <p>Bluetooth Hcidump [&lt;=Jelly Bean]</p>
  110. </li>
  111. <li>
  112. <p>Bluetooth Bluedroid External Parser [Kitkat]</p>
  113. </li>
  114. <li>
  115. <p>Bluetooth BtsnoopNet [&gt;=Lollipop]</p>
  116. </li>
  117. <li>
  118. <p>WiFi tcpdump [need tcpdump on phone]</p>
  119. </li>
  120. </ol>
  121. </div>
  122. <div class="paragraph">
  123. <p>Please note that Androiddump will work also for FirefoxOS or other
  124. Android-based operating systems.</p>
  125. </div>
  126. </div>
  127. </div>
  128. <div class="sect1">
  129. <h2 id="_options">OPTIONS</h2>
  130. <div class="sectionbody">
  131. <div class="dlist">
  132. <dl>
  133. <dt class="hdlist1">--help</dt>
  134. <dd>
  135. <div class="openblock">
  136. <div class="content">
  137. <div class="paragraph">
  138. <p>Print program arguments.</p>
  139. </div>
  140. </div>
  141. </div>
  142. </dd>
  143. <dt class="hdlist1">--version</dt>
  144. <dd>
  145. <div class="openblock">
  146. <div class="content">
  147. <div class="paragraph">
  148. <p>Print program version.</p>
  149. </div>
  150. </div>
  151. </div>
  152. </dd>
  153. <dt class="hdlist1">--extcap-version</dt>
  154. <dd>
  155. <div class="openblock">
  156. <div class="content">
  157. <div class="paragraph">
  158. <p>Print extcapized version.</p>
  159. </div>
  160. </div>
  161. </div>
  162. </dd>
  163. <dt class="hdlist1">--debug</dt>
  164. <dd>
  165. <div class="openblock">
  166. <div class="content">
  167. <div class="paragraph">
  168. <p>Print additional messages.</p>
  169. </div>
  170. </div>
  171. </div>
  172. </dd>
  173. <dt class="hdlist1">--extcap-interfaces</dt>
  174. <dd>
  175. <div class="openblock">
  176. <div class="content">
  177. <div class="paragraph">
  178. <p>List available interfaces.</p>
  179. </div>
  180. </div>
  181. </div>
  182. </dd>
  183. <dt class="hdlist1">--extcap-interface=&lt;interface&gt;</dt>
  184. <dd>
  185. <div class="openblock">
  186. <div class="content">
  187. <div class="paragraph">
  188. <p>Use specified interfaces.</p>
  189. </div>
  190. </div>
  191. </div>
  192. </dd>
  193. <dt class="hdlist1">--extcap-dlts</dt>
  194. <dd>
  195. <div class="openblock">
  196. <div class="content">
  197. <div class="paragraph">
  198. <p>List DLTs of specified interface.</p>
  199. </div>
  200. </div>
  201. </div>
  202. </dd>
  203. <dt class="hdlist1">--extcap-config</dt>
  204. <dd>
  205. <div class="openblock">
  206. <div class="content">
  207. <div class="paragraph">
  208. <p>List configuration options of specified interface.</p>
  209. </div>
  210. </div>
  211. </div>
  212. </dd>
  213. <dt class="hdlist1">--capture</dt>
  214. <dd>
  215. <div class="openblock">
  216. <div class="content">
  217. <div class="paragraph">
  218. <p>Start capturing from the specified interface and save it in the location
  219. specified with --fifo.</p>
  220. </div>
  221. </div>
  222. </div>
  223. </dd>
  224. <dt class="hdlist1">--fifo=&lt;path to file or pipe&gt;</dt>
  225. <dd>
  226. <div class="openblock">
  227. <div class="content">
  228. <div class="paragraph">
  229. <p>Save captured packet to file or send it through pipe.</p>
  230. </div>
  231. </div>
  232. </div>
  233. </dd>
  234. <dt class="hdlist1">--adb-server-ip=&lt;IP address&gt;</dt>
  235. <dd>
  236. <div class="openblock">
  237. <div class="content">
  238. <div class="paragraph">
  239. <p>Use other than default (127.0.0.1) ADB daemon&#8217;s IP address.</p>
  240. </div>
  241. </div>
  242. </div>
  243. </dd>
  244. <dt class="hdlist1">--adb-server-tcp-port=&lt;TCP port&gt;</dt>
  245. <dd>
  246. <div class="openblock">
  247. <div class="content">
  248. <div class="paragraph">
  249. <p>Use other than default (5037) ADB daemon&#8217;s TCP port.</p>
  250. </div>
  251. </div>
  252. </div>
  253. </dd>
  254. <dt class="hdlist1">--logcat-text=&lt;TRUE or FALSE&gt;</dt>
  255. <dd>
  256. <div class="openblock">
  257. <div class="content">
  258. <div class="paragraph">
  259. <p>If TRUE then use text logcat rather then binary. This option only has an
  260. effect on
  261. Logcat interfaces. This have no effect from Lollipop where is no binary Logcat
  262. available.</p>
  263. </div>
  264. <div class="paragraph">
  265. <p>Defaults to FALSE.</p>
  266. </div>
  267. </div>
  268. </div>
  269. </dd>
  270. <dt class="hdlist1">--bt-server-tcp-port=&lt;TCP port&gt;</dt>
  271. <dd>
  272. <div class="openblock">
  273. <div class="content">
  274. <div class="paragraph">
  275. <p>Use other than default Bluetooth server TCP port on Android side.
  276. On Lollipop defaults is 8872, earlier 4330.</p>
  277. </div>
  278. </div>
  279. </div>
  280. </dd>
  281. <dt class="hdlist1">--bt-forward-socket=&lt;TRUE or FALSE&gt;</dt>
  282. <dd>
  283. <div class="openblock">
  284. <div class="content">
  285. <div class="paragraph">
  286. <p>If TRUE then socket from Android side is forwarded to host side.</p>
  287. </div>
  288. <div class="paragraph">
  289. <p>Defaults to FALSE.</p>
  290. </div>
  291. </div>
  292. </div>
  293. </dd>
  294. <dt class="hdlist1">--bt-local-ip=&lt;IP address&gt;</dt>
  295. <dd>
  296. <div class="openblock">
  297. <div class="content">
  298. <div class="paragraph">
  299. <p>Use other than default (127.0.0.1) IP address on host side for forwarded socket.</p>
  300. </div>
  301. </div>
  302. </div>
  303. </dd>
  304. <dt class="hdlist1">--bt-local-tcp-port=&lt;TCP port&gt;</dt>
  305. <dd>
  306. <div class="openblock">
  307. <div class="content">
  308. <div class="paragraph">
  309. <p>Specify port to be used on host side for forwarded socket.</p>
  310. </div>
  311. </div>
  312. </div>
  313. </dd>
  314. </dl>
  315. </div>
  316. </div>
  317. </div>
  318. <div class="sect1">
  319. <h2 id="_examples">EXAMPLES</h2>
  320. <div class="sectionbody">
  321. <div class="paragraph">
  322. <p>To see program arguments:</p>
  323. </div>
  324. <div class="literalblock">
  325. <div class="content">
  326. <pre>androiddump --help</pre>
  327. </div>
  328. </div>
  329. <div class="paragraph">
  330. <p>To see program version:</p>
  331. </div>
  332. <div class="literalblock">
  333. <div class="content">
  334. <pre>androiddump --version</pre>
  335. </div>
  336. </div>
  337. <div class="paragraph">
  338. <p>To see interfaces:</p>
  339. </div>
  340. <div class="literalblock">
  341. <div class="content">
  342. <pre>androiddump --extcap-interfaces</pre>
  343. </div>
  344. </div>
  345. <div class="listingblock">
  346. <div class="title">Example output</div>
  347. <div class="content">
  348. <pre>interface {display=Android Logcat Main unknown MSM7627A}{value=android-logcat-main-MSM7627A}
  349. interface {display=Android Logcat System unknown MSM7627A}{value=android-logcat-system-MSM7627A}
  350. interface {display=Android Logcat Radio unknown MSM7627A}{value=android-logcat-radio-MSM7627A}
  351. interface {display=Android Logcat Events unknown MSM7627A}{value=android-logcat-events-MSM7627A}
  352. interface {display=Android Bluetooth Hcidump unknown MSM7627A}{value=android-bluetooth-hcidump-MSM7627A}
  353. Human-readable display name of interfaces contains interface type, one of:
  354. android-logcat-main (Android Logcat Main)
  355. android-logcat-system (Android Logcat System)
  356. android-logcat-radio (Android Logcat Radio)
  357. android-logcat-events (Android Logcat Events)
  358. android-logcat-text-main (Android Logcat Main)
  359. android-logcat-text-system (Android Logcat System)
  360. android-logcat-text-radio (Android Logcat Radio)
  361. android-logcat-text-events (Android Logcat Events)
  362. android-logcat-text-crash (Android Logcat Crash)
  363. android-bluetooth-hcidump (Android Bluetooth Hcidump)
  364. android-bluetooth-external-parser (Android Bluetooth External Parser)
  365. android-bluetooth-btsnoop-net (Android Bluetooth Btsnoop Net)
  366. android-wifi-tcpdump (Android WiFi)
  367. Then Android Device's name if available, otherwise "unknown".
  368. Last part of it is DeviceID - the identificator of the device provided by Android SDK (see "adb devices").
  369. For example:
  370. "Android Logcat Main unknown MSM7627A"
  371. "Android Logcat Main" - user-friendly type of interface
  372. "unknown" - name of Android Device
  373. "MSM7627A" - device ID</pre>
  374. </div>
  375. </div>
  376. <div class="paragraph">
  377. <p>To see interface DLTs:</p>
  378. </div>
  379. <div class="literalblock">
  380. <div class="content">
  381. <pre>androiddump --extcap-interface=android-bluetooth-hcidump-MSM7627A --extcap-dlts</pre>
  382. </div>
  383. </div>
  384. <div class="literalblock">
  385. <div class="title">Example output</div>
  386. <div class="content">
  387. <pre>dlt {number=99}{name=BluetoothH4}{display=Bluetooth HCI UART transport layer plus pseudo-header}</pre>
  388. </div>
  389. </div>
  390. <div class="paragraph">
  391. <p>To see interface configuration options:</p>
  392. </div>
  393. <div class="literalblock">
  394. <div class="content">
  395. <pre>androiddump --extcap-interface=android-bluetooth-hcidump-MSM7627A --extcap-config</pre>
  396. </div>
  397. </div>
  398. <div class="literalblock">
  399. <div class="title">Example output</div>
  400. <div class="content">
  401. <pre>arg {number=0}{call=--adb-server-ip}{display=ADB Server IP Address}{type=string}{default=127.0.0.1}
  402. arg {number=1}{call=--adb-server-tcp-port}{display=ADB Server TCP Port}{type=integer}{range=0,65535}{default=5037}</pre>
  403. </div>
  404. </div>
  405. <div class="paragraph">
  406. <p>To capture:</p>
  407. </div>
  408. <div class="literalblock">
  409. <div class="content">
  410. <pre>androiddump --extcap-interface=android-bluetooth-hcidump-MSM7627A --fifo=/tmp/bluetooth.pcapng --capture</pre>
  411. </div>
  412. </div>
  413. <div class="admonitionblock note">
  414. <table>
  415. <tr>
  416. <td class="icon">
  417. <div class="title">Note</div>
  418. </td>
  419. <td class="content">
  420. To stop capturing CTRL+C/kill/terminate the application.
  421. </td>
  422. </tr>
  423. </table>
  424. </div>
  425. </div>
  426. </div>
  427. <div class="sect1">
  428. <h2 id="_see_also">SEE ALSO</h2>
  429. <div class="sectionbody">
  430. <div class="paragraph">
  431. <p><a href="wireshark.html">wireshark</a>(1), <a href="tshark.html">tshark</a>(1), <a href="dumpcap.html">dumpcap</a>(1), <a href="extcap.html">extcap</a>(4)</p>
  432. </div>
  433. </div>
  434. </div>
  435. <div class="sect1">
  436. <h2 id="_notes">NOTES</h2>
  437. <div class="sectionbody">
  438. <div class="paragraph">
  439. <p><strong>Androiddump</strong> is part of the <strong>Wireshark</strong> distribution. The latest version
  440. of <strong>Wireshark</strong> can be found at <a href="https://www.wireshark.org" class="bare">https://www.wireshark.org</a>.</p>
  441. </div>
  442. <div class="paragraph">
  443. <p>HTML versions of the Wireshark project man pages are available at
  444. <a href="https://www.wireshark.org/docs/man-pages" class="bare">https://www.wireshark.org/docs/man-pages</a>.</p>
  445. </div>
  446. </div>
  447. </div>
  448. <div class="sect1">
  449. <h2 id="_authors">AUTHORS</h2>
  450. <div class="sectionbody">
  451. <div class="paragraph">
  452. <div class="title">Original Author</div>
  453. <p>Michal Labedzki &lt;michal.labedzki[AT]tieto.com&gt;</p>
  454. </div>
  455. <div class="paragraph">
  456. <div class="title">Contributors</div>
  457. <p>Roland Knall &lt;rknall[AT]gmail.com&gt;</p>
  458. </div>
  459. </div>
  460. </div>
  461. </div>
  462. </body>
  463. </html>