sshdump.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510
  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>sshdump(1)</title>
  9. <link rel="stylesheet" href="./ws.css">
  10. </head>
  11. <body class="manpage">
  12. <div id="header">
  13. <h1>sshdump(1) Manual Page</h1>
  14. <h2 id="_name">NAME</h2>
  15. <div class="sectionbody">
  16. <p>sshdump - Provide interfaces to capture from a remote host through SSH using a remote capture binary.</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>sshdump</strong></span>
  25. <span class="nowrap">[ <strong>--help</strong> ]</span>
  26. <span class="nowrap">[ <strong>--version</strong> ]</span>
  27. <span class="nowrap">[ <strong>--extcap-interfaces</strong> ]</span>
  28. <span class="nowrap">[ <strong>--extcap-dlts</strong> ]</span>
  29. <span class="nowrap">[ <strong>--extcap-interface</strong>=&lt;interface&gt; ]</span>
  30. <span class="nowrap">[ <strong>--extcap-config</strong> ]</span>
  31. <span class="nowrap">[ <strong>--extcap-capture-filter</strong>=&lt;capture filter&gt; ]</span>
  32. <span class="nowrap">[ <strong>--capture</strong> ]</span>
  33. <span class="nowrap">[ <strong>--fifo</strong>=&lt;path to file or pipe&gt; ]</span>
  34. <span class="nowrap">[ <strong>--remote-host</strong>=&lt;IP address&gt; ]</span>
  35. <span class="nowrap">[ <strong>--remote-port</strong>=&lt;TCP port&gt; ]</span>
  36. <span class="nowrap">[ <strong>--remote-username</strong>=&lt;username&gt; ]</span>
  37. <span class="nowrap">[ <strong>--remote-password</strong>=&lt;password&gt; ]</span>
  38. <span class="nowrap">[ <strong>--sshkey</strong>=&lt;public key path&gt; ]</span>
  39. <span class="nowrap">[ <strong>--remote-interface</strong>=&lt;interface&gt; ]</span>
  40. <span class="nowrap">[ <strong>--remote-capture-command-select</strong>=&lt;capture command selection&gt; ]</span>
  41. <span class="nowrap">[ <strong>--remote-capture-command</strong>=&lt;capture command&gt; ]</span>
  42. <span class="nowrap">[ <strong>--remote-sudo</strong> ]</span></p>
  43. </div>
  44. <div class="paragraph">
  45. <p><span class="nowrap"><strong>sshdump</strong></span>
  46. <span class="nowrap"><strong>--extcap-interfaces</strong></span></p>
  47. </div>
  48. <div class="paragraph">
  49. <p><span class="nowrap"><strong>sshdump</strong></span>
  50. <span class="nowrap"><strong>--extcap-interface</strong>=&lt;interface&gt;</span>
  51. <span class="nowrap"><strong>--extcap-dlts</strong></span></p>
  52. </div>
  53. <div class="paragraph">
  54. <p><span class="nowrap"><strong>sshdump</strong></span>
  55. <span class="nowrap"><strong>--extcap-interface</strong>=&lt;interface&gt;</span>
  56. <span class="nowrap"><strong>--extcap-config</strong></span></p>
  57. </div>
  58. <div class="paragraph">
  59. <p><span class="nowrap"><strong>sshdump</strong></span>
  60. <span class="nowrap"><strong>--extcap-interface</strong>=&lt;interface&gt;</span>
  61. <span class="nowrap"><strong>--fifo</strong>=&lt;path to file or pipe&gt;</span>
  62. <span class="nowrap"><strong>--capture</strong></span>
  63. <span class="nowrap"><strong>--remote-host=myremotehost</strong></span>
  64. <span class="nowrap"><strong>--remote-port=22</strong></span>
  65. <span class="nowrap"><strong>--remote-username=user</strong></span>
  66. <span class="nowrap"><strong>--remote-interface=eth2</strong></span>
  67. <span class="nowrap"><strong>--remote-capture-command='tcpdump -U -i eth0 -w-'</strong></span></p>
  68. </div>
  69. </div>
  70. </div>
  71. <div class="sect1">
  72. <h2 id="_description">DESCRIPTION</h2>
  73. <div class="sectionbody">
  74. <div class="paragraph">
  75. <p><strong>Sshdump</strong> is an extcap tool that allows one to run a remote capture
  76. tool over a SSH connection. The requirement is that the capture
  77. executable must have the capabilities to capture from the wanted
  78. interface.</p>
  79. </div>
  80. <div class="paragraph">
  81. <p>The feature is functionally equivalent to run commands like</p>
  82. </div>
  83. <div class="literalblock">
  84. <div class="content">
  85. <pre>$ ssh remoteuser@remotehost -p 22222 'tcpdump -U -i IFACE -w -' &gt; FILE &amp;
  86. $ wireshark FILE</pre>
  87. </div>
  88. </div>
  89. <div class="literalblock">
  90. <div class="content">
  91. <pre>$ ssh remoteuser@remotehost '/sbin/dumpcap -i IFACE -P -w - -f "not port 22"' &gt; FILE &amp;
  92. $ wireshark FILE</pre>
  93. </div>
  94. </div>
  95. <div class="literalblock">
  96. <div class="content">
  97. <pre>$ ssh somehost dumpcap -P -w - -f udp | tshark -i -</pre>
  98. </div>
  99. </div>
  100. <div class="paragraph">
  101. <p>Typically sshdump is not invoked directly. Instead it can be configured through
  102. the Wireshark graphical user interface or its command line. The following will
  103. start Wireshark and start capturing from host <strong>remotehost</strong>:</p>
  104. </div>
  105. <div class="literalblock">
  106. <div class="content">
  107. <pre>$ wireshark '-oextcap.sshdump.remotehost:"remotehost"' -i sshdump -k</pre>
  108. </div>
  109. </div>
  110. <div class="paragraph">
  111. <p>To explicitly control the remote capture command:</p>
  112. </div>
  113. <div class="literalblock">
  114. <div class="content">
  115. <pre>$ wireshark '-oextcap.sshdump.remotehost:"remotehost"' \
  116. '-oextcap.sshdump.remotecapturecommand:"tcpdump -i eth0 -Uw- not port 22"' \
  117. -i sshdump -k</pre>
  118. </div>
  119. </div>
  120. <div class="paragraph">
  121. <p>Supported interfaces:</p>
  122. </div>
  123. <div class="olist arabic">
  124. <ol class="arabic">
  125. <li>
  126. <p>ssh</p>
  127. </li>
  128. </ol>
  129. </div>
  130. </div>
  131. </div>
  132. <div class="sect1">
  133. <h2 id="_options">OPTIONS</h2>
  134. <div class="sectionbody">
  135. <div class="dlist">
  136. <dl>
  137. <dt class="hdlist1">--help</dt>
  138. <dd>
  139. <div class="openblock">
  140. <div class="content">
  141. <div class="paragraph">
  142. <p>Print program arguments.</p>
  143. </div>
  144. </div>
  145. </div>
  146. </dd>
  147. <dt class="hdlist1">--version</dt>
  148. <dd>
  149. <div class="openblock">
  150. <div class="content">
  151. <div class="paragraph">
  152. <p>Print program version.</p>
  153. </div>
  154. </div>
  155. </div>
  156. </dd>
  157. <dt class="hdlist1">--extcap-interfaces</dt>
  158. <dd>
  159. <div class="openblock">
  160. <div class="content">
  161. <div class="paragraph">
  162. <p>List available interfaces.</p>
  163. </div>
  164. </div>
  165. </div>
  166. </dd>
  167. <dt class="hdlist1">--extcap-interface=&lt;interface&gt;</dt>
  168. <dd>
  169. <div class="openblock">
  170. <div class="content">
  171. <div class="paragraph">
  172. <p>Use specified interfaces.</p>
  173. </div>
  174. </div>
  175. </div>
  176. </dd>
  177. <dt class="hdlist1">--extcap-dlts</dt>
  178. <dd>
  179. <div class="openblock">
  180. <div class="content">
  181. <div class="paragraph">
  182. <p>List DLTs of specified interface.</p>
  183. </div>
  184. </div>
  185. </div>
  186. </dd>
  187. <dt class="hdlist1">--extcap-config</dt>
  188. <dd>
  189. <div class="openblock">
  190. <div class="content">
  191. <div class="paragraph">
  192. <p>List configuration options of specified interface.</p>
  193. </div>
  194. </div>
  195. </div>
  196. </dd>
  197. <dt class="hdlist1">--capture</dt>
  198. <dd>
  199. <div class="openblock">
  200. <div class="content">
  201. <div class="paragraph">
  202. <p>Start capturing from specified interface and write raw packet data to the location specified by --fifo.</p>
  203. </div>
  204. </div>
  205. </div>
  206. </dd>
  207. <dt class="hdlist1">--fifo=&lt;path to file or pipe&gt;</dt>
  208. <dd>
  209. <div class="openblock">
  210. <div class="content">
  211. <div class="paragraph">
  212. <p>Save captured packet to file or send it through pipe.</p>
  213. </div>
  214. </div>
  215. </div>
  216. </dd>
  217. <dt class="hdlist1">--remote-host=&lt;remote host&gt;</dt>
  218. <dd>
  219. <div class="openblock">
  220. <div class="content">
  221. <div class="paragraph">
  222. <p>The address of the remote host for capture.</p>
  223. </div>
  224. </div>
  225. </div>
  226. </dd>
  227. <dt class="hdlist1">--remote-port=&lt;remote port&gt;</dt>
  228. <dd>
  229. <div class="openblock">
  230. <div class="content">
  231. <div class="paragraph">
  232. <p>The SSH port of the remote host.</p>
  233. </div>
  234. </div>
  235. </div>
  236. </dd>
  237. <dt class="hdlist1">--remote-username=&lt;username&gt;</dt>
  238. <dd>
  239. <div class="openblock">
  240. <div class="content">
  241. <div class="paragraph">
  242. <p>The username for SSH authentication.</p>
  243. </div>
  244. </div>
  245. </div>
  246. </dd>
  247. <dt class="hdlist1">--remote-password=&lt;password&gt;</dt>
  248. <dd>
  249. <div class="openblock">
  250. <div class="content">
  251. <div class="paragraph">
  252. <p>The password to use (if not ssh-agent and pubkey are used). WARNING: the
  253. passwords are stored in plaintext and visible to all users on this system. It is
  254. recommended to use keyfiles with a SSH agent.</p>
  255. </div>
  256. </div>
  257. </div>
  258. </dd>
  259. <dt class="hdlist1">--sshkey=&lt;SSH private key path&gt;</dt>
  260. <dd>
  261. <div class="openblock">
  262. <div class="content">
  263. <div class="paragraph">
  264. <p>The path to a private key for authentication. NOTE: Only OPENSSH key/value pair format is supported.</p>
  265. </div>
  266. </div>
  267. </div>
  268. </dd>
  269. <dt class="hdlist1">--remote-interface=&lt;remote interface&gt;</dt>
  270. <dd>
  271. <div class="openblock">
  272. <div class="content">
  273. <div class="paragraph">
  274. <p>The remote network interface to capture from.</p>
  275. </div>
  276. </div>
  277. </div>
  278. </dd>
  279. <dt class="hdlist1">--remote-capture-command-select=&lt;capture command-selection&gt;</dt>
  280. <dd>
  281. <div class="openblock">
  282. <div class="content">
  283. <div class="paragraph">
  284. <p>The selection of the build-in support for remote capture commands. Either <strong>dumpcap</strong> for a remote
  285. capture command using dumpcap, <strong>tcpdump</strong> for a remote capture command using tcpdump, or <strong>other</strong>,
  286. where the remote capture command is to be given with the <strong>--remote-capture-command</strong> option.</p>
  287. </div>
  288. <div class="paragraph">
  289. <p>Note that selecting dumpcap allows for specifying multiple capture interfaces as a whitespace
  290. seperated list, while tcpdump does not.</p>
  291. </div>
  292. </div>
  293. </div>
  294. </dd>
  295. <dt class="hdlist1">--remote-capture-command=&lt;capture command&gt;</dt>
  296. <dd>
  297. <div class="openblock">
  298. <div class="content">
  299. <div class="paragraph">
  300. <p>A custom remote capture command that produces the remote stream that is shown in Wireshark.
  301. The command must be able to produce a PCAP stream written to STDOUT. See below for more
  302. examples.</p>
  303. </div>
  304. <div class="paragraph">
  305. <p>If using tcpdump, use the <strong>-w-</strong> option to ensure that packets are written to
  306. standard output (stdout). Include the <strong>-U</strong> option to write packets as soon as
  307. they are received.</p>
  308. </div>
  309. <div class="paragraph">
  310. <p>When specified, this command will be used as is, options such as the capture
  311. filter (<strong>--extcap-capture-filter</strong>) will not be appended.</p>
  312. </div>
  313. </div>
  314. </div>
  315. </dd>
  316. <dt class="hdlist1">--extcap-capture-filter=&lt;capture filter&gt;</dt>
  317. <dd>
  318. <div class="openblock">
  319. <div class="content">
  320. <div class="paragraph">
  321. <p>The capture filter. It corresponds to the value provided via the <strong>tshark -f</strong>
  322. option, and the Capture Filter field next to the interfaces list in the
  323. Wireshark interface.</p>
  324. </div>
  325. </div>
  326. </div>
  327. </dd>
  328. </dl>
  329. </div>
  330. </div>
  331. </div>
  332. <div class="sect1">
  333. <h2 id="_examples">EXAMPLES</h2>
  334. <div class="sectionbody">
  335. <div class="paragraph">
  336. <p>To see program arguments:</p>
  337. </div>
  338. <div class="literalblock">
  339. <div class="content">
  340. <pre>sshdump --help</pre>
  341. </div>
  342. </div>
  343. <div class="paragraph">
  344. <p>To see program version:</p>
  345. </div>
  346. <div class="literalblock">
  347. <div class="content">
  348. <pre>sshdump --version</pre>
  349. </div>
  350. </div>
  351. <div class="paragraph">
  352. <p>To see interfaces:</p>
  353. </div>
  354. <div class="literalblock">
  355. <div class="content">
  356. <pre>sshdump --extcap-interfaces</pre>
  357. </div>
  358. </div>
  359. <div class="paragraph">
  360. <p>Only one interface (sshdump) is supported.</p>
  361. </div>
  362. <div class="literalblock">
  363. <div class="title">Example output</div>
  364. <div class="content">
  365. <pre>interface {value=sshdump}{display=SSH remote capture}</pre>
  366. </div>
  367. </div>
  368. <div class="paragraph">
  369. <p>To see interface DLTs:</p>
  370. </div>
  371. <div class="literalblock">
  372. <div class="content">
  373. <pre>sshdump --extcap-interface=sshdump --extcap-dlts</pre>
  374. </div>
  375. </div>
  376. <div class="literalblock">
  377. <div class="title">Example output</div>
  378. <div class="content">
  379. <pre>dlt {number=147}{name=sshdump}{display=Remote capture dependent DLT}</pre>
  380. </div>
  381. </div>
  382. <div class="paragraph">
  383. <p>To see interface configuration options:</p>
  384. </div>
  385. <div class="literalblock">
  386. <div class="content">
  387. <pre>sshdump --extcap-interface=sshdump --extcap-config</pre>
  388. </div>
  389. </div>
  390. <div class="literalblock">
  391. <div class="title">Example output</div>
  392. <div class="content">
  393. <pre>arg {number=0}{call=--remote-host}{display=Remote SSH server address}{type=string}
  394. {tooltip=The remote SSH host. It can be both an IP address or a hostname}{required=true}{group=Server}
  395. arg {number=1}{call=--remote-port}{display=Remote SSH server port}{type=unsigned}
  396. {tooltip=The remote SSH host port (1-65535)}{range=1,65535}{group=Server}
  397. arg {number=2}{call=--remote-username}{display=Remote SSH server username}{type=string}
  398. {tooltip=The remote SSH username. If not provided, the current user will be used}{group=Authentication}
  399. arg {number=3}{call=--remote-password}{display=Remote SSH server password}{type=password}
  400. {tooltip=The SSH password, used when other methods (SSH agent or key files) are unavailable.}{group=Authentication}
  401. arg {number=4}{call=--sshkey}{display=Path to SSH private key}{type=fileselect}
  402. {tooltip=The path on the local filesystem of the private SSH key (OpenSSH format)}{mustexist=true}{group=Authentication}
  403. arg {number=5}{call=--sshkey-passphrase}{display=SSH key passphrase}{type=password}
  404. {tooltip=Passphrase to unlock the SSH private key}{group=Authentication}
  405. arg {number=6}{call=--proxycommand}{display=ProxyCommand}{type=string}
  406. {tooltip=The command to use as proxy for the SSH connection}{group=Authentication}
  407. arg {number=7}{call=--remote-interface}{display=Remote interface}{type=string}
  408. {tooltip=The remote network interface used for capture}{group=Capture}
  409. arg {number=8}{call=--remote-capture-command-select}{display=Remote capture command selection}{type=radio}
  410. {tooltip=The remote capture command to build a command line for}{group=Capture}
  411. value {arg=8}{value=dumpcap}{display=dumpcap}
  412. value {arg=8}{value=tcpdump}{display=tcpdump}{default=true}
  413. value {arg=8}{value=other}{display=Other:}
  414. arg {number=9}{call=--remote-capture-command}{display=Remote capture command}{type=string}
  415. {tooltip=The remote command used to capture}{group=Capture}
  416. arg {number=10}{call=--remote-sudo}{display=Use sudo on the remote machine}{type=boolflag}
  417. {tooltip=Prepend the capture command with sudo on the remote machine}{group=Capture}
  418. arg {number=11}{call=--remote-noprom}{display=No promiscuous mode}{type=boolflag}
  419. {tooltip=Don't use promiscuous mode on the remote machine}{group=Capture}
  420. arg {number=12}{call=--remote-filter}{display=Remote capture filter}{type=string}
  421. {tooltip=The remote capture filter}{default=not ((host myhost) and port 22)}{group=Capture}
  422. arg {number=13}{call=--remote-count}{display=Packets to capture}{type=unsigned}{default=0}
  423. {tooltip=The number of remote packets to capture. (Default: inf)}{group=Capture}
  424. arg {number=14}{call=--log-level}{display=Set the log level}{type=selector}
  425. {tooltip=Set the log level}{required=false}{group=Debug}
  426. value {arg=14}{value=message}{display=Message}{default=true}
  427. value {arg=14}{value=info}{display=Info}
  428. value {arg=14}{value=debug}{display=Debug}
  429. value {arg=14}{value=noisy}{display=Noisy}
  430. arg {number=15}{call=--log-file}{display=Use a file for logging}{type=fileselect}
  431. {tooltip=Set a file where log messages are written}{required=false}{group=Debug}</pre>
  432. </div>
  433. </div>
  434. <div class="paragraph">
  435. <p>To capture:</p>
  436. </div>
  437. <div class="literalblock">
  438. <div class="content">
  439. <pre>sshdump --extcap-interface=sshdump --fifo=/tmp/ssh.pcap --capture --remote-host 192.168.1.10
  440. --remote-username user --remote-filter "not port 22"</pre>
  441. </div>
  442. </div>
  443. <div class="paragraph">
  444. <p>To use different capture binaries:</p>
  445. </div>
  446. <div class="literalblock">
  447. <div class="content">
  448. <pre>sshdump --extcap-interface=sshdump --fifo=/tmp/ssh.pcap --capture --remote-host 192.168.1.10
  449. --remote-capture-command='dumpcap -i eth0 -P -w -'</pre>
  450. </div>
  451. </div>
  452. <div class="literalblock">
  453. <div class="content">
  454. <pre>sshdump --extcap-interface=sshdump --fifo=/tmp/ssh.pcap --capture --remote-host 192.168.1.10
  455. --remote-capture-command='sudo tcpdump -i eth0 -U -w -'</pre>
  456. </div>
  457. </div>
  458. <div class="admonitionblock note">
  459. <table>
  460. <tr>
  461. <td class="icon">
  462. <div class="title">Note</div>
  463. </td>
  464. <td class="content">
  465. To stop capturing CTRL+C/kill/terminate the application.
  466. </td>
  467. </tr>
  468. </table>
  469. </div>
  470. <div class="paragraph">
  471. <p>The sshdump binary can be renamed to support multiple instances. For instance if we want sshdump
  472. to show up twice in wireshark (for instance to handle multiple profiles), we can copy sshdump to
  473. sshdump-host1 and sshdump-host2. Each binary will show up an interface name same as the executable
  474. name. Those executables not being "sshdump" will show up as "custom version" in the interface description.</p>
  475. </div>
  476. </div>
  477. </div>
  478. <div class="sect1">
  479. <h2 id="_see_also">SEE ALSO</h2>
  480. <div class="sectionbody">
  481. <div class="paragraph">
  482. <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), <a href="https://www.tcpdump.org/manpages/tcpdump.1.html">tcpdump</a>(1)</p>
  483. </div>
  484. </div>
  485. </div>
  486. <div class="sect1">
  487. <h2 id="_notes">NOTES</h2>
  488. <div class="sectionbody">
  489. <div class="paragraph">
  490. <p><strong>Sshdump</strong> is part of the <strong>Wireshark</strong> distribution. The latest version
  491. of <strong>Wireshark</strong> can be found at <a href="https://www.wireshark.org" class="bare">https://www.wireshark.org</a>.</p>
  492. </div>
  493. <div class="paragraph">
  494. <p>HTML versions of the Wireshark project man pages are available at
  495. <a href="https://www.wireshark.org/docs/man-pages" class="bare">https://www.wireshark.org/docs/man-pages</a>.</p>
  496. </div>
  497. </div>
  498. </div>
  499. <div class="sect1">
  500. <h2 id="_authors">AUTHORS</h2>
  501. <div class="sectionbody">
  502. <div class="paragraph">
  503. <div class="title">Original Author</div>
  504. <p>Dario Lombardo &lt;lomato[AT]gmail.com&gt;</p>
  505. </div>
  506. </div>
  507. </div>
  508. </div>
  509. </body>
  510. </html>