portfwd.c 37 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210
  1. /*
  2. * SSH port forwarding.
  3. */
  4. #include <assert.h>
  5. #include <stdio.h>
  6. #include <stdlib.h>
  7. #include "putty.h"
  8. #include "ssh.h"
  9. #include "sshchan.h"
  10. /*
  11. * Enumeration of values that live in the 'socks_state' field of
  12. * struct PortForwarding.
  13. */
  14. typedef enum {
  15. SOCKS_NONE, /* direct connection (no SOCKS, or SOCKS already done) */
  16. SOCKS_INITIAL, /* don't know if we're SOCKS 4 or 5 yet */
  17. SOCKS_4, /* expect a SOCKS 4 (or 4A) connection message */
  18. SOCKS_5_INITIAL, /* expect a SOCKS 5 preliminary message */
  19. SOCKS_5_CONNECT /* expect a SOCKS 5 connection message */
  20. } SocksState;
  21. typedef struct PortForwarding {
  22. SshChannel *c; /* channel structure held by SSH connection layer */
  23. ConnectionLayer *cl; /* the connection layer itself */
  24. /* Note that ssh need not be filled in if c is non-NULL */
  25. Socket *s;
  26. bool input_wanted;
  27. bool ready;
  28. SocksState socks_state;
  29. /*
  30. * `hostname' and `port' are the real hostname and port, once
  31. * we know what we're connecting to.
  32. */
  33. char *hostname;
  34. int port;
  35. /*
  36. * `socksbuf' is the buffer we use to accumulate the initial SOCKS
  37. * segment of the incoming data, plus anything after that that we
  38. * receive before we're ready to send data to the SSH server.
  39. */
  40. strbuf *socksbuf;
  41. size_t socksbuf_consumed;
  42. Plug plug;
  43. Channel chan;
  44. } PortForwarding;
  45. struct PortListener {
  46. ConnectionLayer *cl;
  47. Socket *s;
  48. bool is_dynamic;
  49. /*
  50. * `hostname' and `port' are the real hostname and port, for
  51. * ordinary forwardings.
  52. */
  53. char *hostname;
  54. int port;
  55. Plug plug;
  56. };
  57. static struct PortForwarding *new_portfwd_state(void)
  58. {
  59. struct PortForwarding *pf = snew(struct PortForwarding);
  60. pf->hostname = NULL;
  61. pf->socksbuf = NULL;
  62. return pf;
  63. }
  64. static void free_portfwd_state(struct PortForwarding *pf)
  65. {
  66. if (!pf)
  67. return;
  68. sfree(pf->hostname);
  69. if (pf->socksbuf)
  70. strbuf_free(pf->socksbuf);
  71. sfree(pf);
  72. }
  73. static struct PortListener *new_portlistener_state(void)
  74. {
  75. struct PortListener *pl = snew(struct PortListener);
  76. pl->hostname = NULL;
  77. return pl;
  78. }
  79. static void free_portlistener_state(struct PortListener *pl)
  80. {
  81. if (!pl)
  82. return;
  83. sfree(pl->hostname);
  84. sfree(pl);
  85. }
  86. static void pfd_log(Plug *plug, int type, SockAddr *addr, int port,
  87. const char *error_msg, int error_code)
  88. {
  89. /* we have to dump these since we have no interface to logging.c */
  90. }
  91. static void pfl_log(Plug *plug, int type, SockAddr *addr, int port,
  92. const char *error_msg, int error_code)
  93. {
  94. /* we have to dump these since we have no interface to logging.c */
  95. }
  96. static void pfd_close(struct PortForwarding *pf);
  97. static void pfd_closing(Plug *plug, const char *error_msg, int error_code,
  98. bool calling_back)
  99. {
  100. struct PortForwarding *pf =
  101. container_of(plug, struct PortForwarding, plug);
  102. if (error_msg) {
  103. /*
  104. * Socket error. Slam the connection instantly shut.
  105. */
  106. if (pf->c) {
  107. sshfwd_initiate_close(pf->c, error_msg);
  108. } else {
  109. /*
  110. * We might not have an SSH channel, if a socket error
  111. * occurred during SOCKS negotiation. If not, we must
  112. * clean ourself up without sshfwd_initiate_close's call
  113. * back to pfd_close.
  114. */
  115. pfd_close(pf);
  116. }
  117. } else {
  118. /*
  119. * Ordinary EOF received on socket. Send an EOF on the SSH
  120. * channel.
  121. */
  122. if (pf->c)
  123. sshfwd_write_eof(pf->c);
  124. }
  125. }
  126. static void pfl_terminate(struct PortListener *pl);
  127. static void pfl_closing(Plug *plug, const char *error_msg, int error_code,
  128. bool calling_back)
  129. {
  130. struct PortListener *pl = (struct PortListener *) plug;
  131. pfl_terminate(pl);
  132. }
  133. static SshChannel *wrap_lportfwd_open(
  134. ConnectionLayer *cl, const char *hostname, int port,
  135. Socket *s, Channel *chan)
  136. {
  137. SocketPeerInfo *pi;
  138. char *description;
  139. SshChannel *toret;
  140. pi = sk_peer_info(s);
  141. if (pi && pi->log_text) {
  142. description = dupprintf("forwarding from %s", pi->log_text);
  143. } else {
  144. description = dupstr("forwarding");
  145. }
  146. toret = ssh_lportfwd_open(cl, hostname, port, description, pi, chan);
  147. sk_free_peer_info(pi);
  148. sfree(description);
  149. return toret;
  150. }
  151. static char *ipv4_to_string(unsigned ipv4)
  152. {
  153. return dupprintf("%u.%u.%u.%u",
  154. (ipv4 >> 24) & 0xFF, (ipv4 >> 16) & 0xFF,
  155. (ipv4 >> 8) & 0xFF, (ipv4 ) & 0xFF);
  156. }
  157. static char *ipv6_to_string(ptrlen ipv6)
  158. {
  159. const unsigned char *addr = ipv6.ptr;
  160. assert(ipv6.len == 16);
  161. return dupprintf("%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x",
  162. (unsigned)GET_16BIT_MSB_FIRST(addr + 0),
  163. (unsigned)GET_16BIT_MSB_FIRST(addr + 2),
  164. (unsigned)GET_16BIT_MSB_FIRST(addr + 4),
  165. (unsigned)GET_16BIT_MSB_FIRST(addr + 6),
  166. (unsigned)GET_16BIT_MSB_FIRST(addr + 8),
  167. (unsigned)GET_16BIT_MSB_FIRST(addr + 10),
  168. (unsigned)GET_16BIT_MSB_FIRST(addr + 12),
  169. (unsigned)GET_16BIT_MSB_FIRST(addr + 14));
  170. }
  171. static void pfd_receive(Plug *plug, int urgent, char *data, int len)
  172. {
  173. struct PortForwarding *pf =
  174. container_of(plug, struct PortForwarding, plug);
  175. if (len == 0)
  176. return;
  177. if (pf->socks_state != SOCKS_NONE) {
  178. BinarySource src[1];
  179. /*
  180. * Store all the data we've got in socksbuf.
  181. */
  182. put_data(pf->socksbuf, data, len);
  183. /*
  184. * Check the start of socksbuf to see if it's a valid and
  185. * complete message in the SOCKS exchange.
  186. */
  187. if (pf->socks_state == SOCKS_INITIAL) {
  188. /* Preliminary: check the first byte of the data (which we
  189. * _must_ have by now) to find out which SOCKS major
  190. * version we're speaking. */
  191. switch (pf->socksbuf->u[0]) {
  192. case 4:
  193. pf->socks_state = SOCKS_4;
  194. break;
  195. case 5:
  196. pf->socks_state = SOCKS_5_INITIAL;
  197. break;
  198. default:
  199. pfd_close(pf); /* unrecognised version */
  200. return;
  201. }
  202. }
  203. BinarySource_BARE_INIT(src, pf->socksbuf->u, pf->socksbuf->len);
  204. get_data(src, pf->socksbuf_consumed);
  205. while (pf->socks_state != SOCKS_NONE) {
  206. unsigned socks_version, message_type, reserved_byte;
  207. unsigned reply_code, port, ipv4, method;
  208. ptrlen methods;
  209. const char *socks4_hostname;
  210. strbuf *output;
  211. switch (pf->socks_state) {
  212. case SOCKS_INITIAL:
  213. case SOCKS_NONE:
  214. unreachable("These case values cannot appear");
  215. case SOCKS_4:
  216. /* SOCKS 4/4A connect message */
  217. socks_version = get_byte(src);
  218. message_type = get_byte(src);
  219. if (get_err(src) == BSE_OUT_OF_DATA)
  220. return;
  221. if (socks_version == 4 && message_type == 1) {
  222. /* CONNECT message */
  223. bool name_based = false;
  224. port = get_uint16(src);
  225. ipv4 = get_uint32(src);
  226. if (ipv4 > 0x00000000 && ipv4 < 0x00000100) {
  227. /*
  228. * Addresses in this range indicate the SOCKS 4A
  229. * extension to specify a hostname, which comes
  230. * after the username.
  231. */
  232. name_based = true;
  233. }
  234. get_asciz(src); /* skip username */
  235. socks4_hostname = name_based ? get_asciz(src) : NULL;
  236. if (get_err(src) == BSE_OUT_OF_DATA)
  237. return;
  238. if (get_err(src))
  239. goto socks4_reject;
  240. pf->port = port;
  241. if (name_based) {
  242. pf->hostname = dupstr(socks4_hostname);
  243. } else {
  244. pf->hostname = ipv4_to_string(ipv4);
  245. }
  246. output = strbuf_new();
  247. put_byte(output, 0); /* reply version */
  248. put_byte(output, 90); /* SOCKS 4 'request granted' */
  249. put_uint16(output, 0); /* null port field */
  250. put_uint32(output, 0); /* null address field */
  251. sk_write(pf->s, output->u, output->len);
  252. strbuf_free(output);
  253. pf->socks_state = SOCKS_NONE;
  254. pf->socksbuf_consumed = src->pos;
  255. break;
  256. }
  257. socks4_reject:
  258. output = strbuf_new();
  259. put_byte(output, 0); /* reply version */
  260. put_byte(output, 91); /* SOCKS 4 'request rejected' */
  261. put_uint16(output, 0); /* null port field */
  262. put_uint32(output, 0); /* null address field */
  263. sk_write(pf->s, output->u, output->len);
  264. strbuf_free(output);
  265. pfd_close(pf);
  266. return;
  267. case SOCKS_5_INITIAL:
  268. /* SOCKS 5 initial method list */
  269. socks_version = get_byte(src);
  270. methods = get_pstring(src);
  271. method = 0xFF; /* means 'no usable method found' */
  272. {
  273. int i;
  274. for (i = 0; i < methods.len; i++) {
  275. if (((const unsigned char *)methods.ptr)[i] == 0 ) {
  276. method = 0; /* no auth */
  277. break;
  278. }
  279. }
  280. }
  281. if (get_err(src) == BSE_OUT_OF_DATA)
  282. return;
  283. if (get_err(src))
  284. method = 0xFF;
  285. output = strbuf_new();
  286. put_byte(output, 5); /* SOCKS version */
  287. put_byte(output, method); /* selected auth method */
  288. sk_write(pf->s, output->u, output->len);
  289. strbuf_free(output);
  290. if (method == 0xFF) {
  291. pfd_close(pf);
  292. return;
  293. }
  294. pf->socks_state = SOCKS_5_CONNECT;
  295. pf->socksbuf_consumed = src->pos;
  296. break;
  297. case SOCKS_5_CONNECT:
  298. /* SOCKS 5 connect message */
  299. socks_version = get_byte(src);
  300. message_type = get_byte(src);
  301. reserved_byte = get_byte(src);
  302. if (socks_version == 5 && message_type == 1 &&
  303. reserved_byte == 0) {
  304. reply_code = 0; /* success */
  305. switch (get_byte(src)) {
  306. case 1: /* IPv4 */
  307. pf->hostname = ipv4_to_string(get_uint32(src));
  308. break;
  309. case 4: /* IPv6 */
  310. pf->hostname = ipv6_to_string(get_data(src, 16));
  311. break;
  312. case 3: /* unresolved domain name */
  313. pf->hostname = mkstr(get_pstring(src));
  314. break;
  315. default:
  316. pf->hostname = NULL;
  317. reply_code = 8; /* address type not supported */
  318. break;
  319. }
  320. pf->port = get_uint16(src);
  321. } else {
  322. reply_code = 7; /* command not supported */
  323. }
  324. if (get_err(src) == BSE_OUT_OF_DATA)
  325. return;
  326. if (get_err(src))
  327. reply_code = 1; /* general server failure */
  328. output = strbuf_new();
  329. put_byte(output, 5); /* SOCKS version */
  330. put_byte(output, reply_code);
  331. put_byte(output, 0); /* reserved */
  332. put_byte(output, 1); /* IPv4 address follows */
  333. put_uint32(output, 0); /* bound IPv4 address (unused) */
  334. put_uint16(output, 0); /* bound port number (unused) */
  335. sk_write(pf->s, output->u, output->len);
  336. strbuf_free(output);
  337. if (reply_code != 0) {
  338. pfd_close(pf);
  339. return;
  340. }
  341. pf->socks_state = SOCKS_NONE;
  342. pf->socksbuf_consumed = src->pos;
  343. break;
  344. }
  345. }
  346. /*
  347. * We come here when we're ready to make an actual
  348. * connection.
  349. */
  350. /*
  351. * Freeze the socket until the SSH server confirms the
  352. * connection.
  353. */
  354. sk_set_frozen(pf->s, 1);
  355. pf->c = wrap_lportfwd_open(pf->cl, pf->hostname, pf->port, pf->s,
  356. &pf->chan);
  357. }
  358. if (pf->ready)
  359. sshfwd_write(pf->c, data, len);
  360. }
  361. static void pfd_sent(Plug *plug, int bufsize)
  362. {
  363. struct PortForwarding *pf =
  364. container_of(plug, struct PortForwarding, plug);
  365. if (pf->c)
  366. sshfwd_unthrottle(pf->c, bufsize);
  367. }
  368. static const PlugVtable PortForwarding_plugvt = {
  369. pfd_log,
  370. pfd_closing,
  371. pfd_receive,
  372. pfd_sent,
  373. NULL
  374. };
  375. static void pfd_chan_free(Channel *chan);
  376. static void pfd_open_confirmation(Channel *chan);
  377. static void pfd_open_failure(Channel *chan, const char *errtext);
  378. static int pfd_send(Channel *chan, bool is_stderr, const void *data, int len);
  379. static void pfd_send_eof(Channel *chan);
  380. static void pfd_set_input_wanted(Channel *chan, bool wanted);
  381. static char *pfd_log_close_msg(Channel *chan);
  382. static const struct ChannelVtable PortForwarding_channelvt = {
  383. pfd_chan_free,
  384. pfd_open_confirmation,
  385. pfd_open_failure,
  386. pfd_send,
  387. pfd_send_eof,
  388. pfd_set_input_wanted,
  389. pfd_log_close_msg,
  390. chan_default_want_close,
  391. chan_no_exit_status,
  392. chan_no_exit_signal,
  393. chan_no_exit_signal_numeric,
  394. chan_no_run_shell,
  395. chan_no_run_command,
  396. chan_no_run_subsystem,
  397. chan_no_enable_x11_forwarding,
  398. chan_no_enable_agent_forwarding,
  399. chan_no_allocate_pty,
  400. chan_no_set_env,
  401. chan_no_send_break,
  402. chan_no_send_signal,
  403. chan_no_change_window_size,
  404. chan_no_request_response,
  405. };
  406. Channel *portfwd_raw_new(ConnectionLayer *cl, Plug **plug)
  407. {
  408. struct PortForwarding *pf;
  409. pf = new_portfwd_state();
  410. pf->plug.vt = &PortForwarding_plugvt;
  411. pf->chan.initial_fixed_window_size = 0;
  412. pf->chan.vt = &PortForwarding_channelvt;
  413. pf->input_wanted = true;
  414. pf->c = NULL;
  415. pf->cl = cl;
  416. pf->input_wanted = true;
  417. pf->ready = false;
  418. pf->socks_state = SOCKS_NONE;
  419. pf->hostname = NULL;
  420. pf->port = 0;
  421. *plug = &pf->plug;
  422. return &pf->chan;
  423. }
  424. void portfwd_raw_free(Channel *pfchan)
  425. {
  426. struct PortForwarding *pf;
  427. assert(pfchan->vt == &PortForwarding_channelvt);
  428. pf = container_of(pfchan, struct PortForwarding, chan);
  429. free_portfwd_state(pf);
  430. }
  431. void portfwd_raw_setup(Channel *pfchan, Socket *s, SshChannel *sc)
  432. {
  433. struct PortForwarding *pf;
  434. assert(pfchan->vt == &PortForwarding_channelvt);
  435. pf = container_of(pfchan, struct PortForwarding, chan);
  436. pf->s = s;
  437. pf->c = sc;
  438. }
  439. /*
  440. called when someone connects to the local port
  441. */
  442. static int pfl_accepting(Plug *p, accept_fn_t constructor, accept_ctx_t ctx)
  443. {
  444. struct PortListener *pl = container_of(p, struct PortListener, plug);
  445. struct PortForwarding *pf;
  446. Channel *chan;
  447. Plug *plug;
  448. Socket *s;
  449. const char *err;
  450. chan = portfwd_raw_new(pl->cl, &plug);
  451. s = constructor(ctx, plug);
  452. if ((err = sk_socket_error(s)) != NULL) {
  453. portfwd_raw_free(chan);
  454. return 1;
  455. }
  456. pf = container_of(chan, struct PortForwarding, chan);
  457. if (pl->is_dynamic) {
  458. pf->s = s;
  459. pf->socks_state = SOCKS_INITIAL;
  460. pf->socksbuf = strbuf_new();
  461. pf->socksbuf_consumed = 0;
  462. pf->port = 0; /* "hostname" buffer is so far empty */
  463. sk_set_frozen(s, 0); /* we want to receive SOCKS _now_! */
  464. } else {
  465. pf->hostname = dupstr(pl->hostname);
  466. pf->port = pl->port;
  467. portfwd_raw_setup(
  468. chan, s,
  469. wrap_lportfwd_open(pl->cl, pf->hostname, pf->port, s, &pf->chan));
  470. }
  471. return 0;
  472. }
  473. static const PlugVtable PortListener_plugvt = {
  474. pfl_log,
  475. pfl_closing,
  476. NULL, /* recv */
  477. NULL, /* send */
  478. pfl_accepting
  479. };
  480. /*
  481. * Add a new port-forwarding listener from srcaddr:port -> desthost:destport.
  482. *
  483. * desthost == NULL indicates dynamic SOCKS port forwarding.
  484. *
  485. * On success, returns NULL and fills in *pl_ret. On error, returns a
  486. * dynamically allocated error message string.
  487. */
  488. static char *pfl_listen(const char *desthost, int destport,
  489. const char *srcaddr, int port,
  490. ConnectionLayer *cl, Conf *conf,
  491. struct PortListener **pl_ret, int address_family)
  492. {
  493. const char *err;
  494. struct PortListener *pl;
  495. /*
  496. * Open socket.
  497. */
  498. pl = *pl_ret = new_portlistener_state();
  499. pl->plug.vt = &PortListener_plugvt;
  500. if (desthost) {
  501. pl->hostname = dupstr(desthost);
  502. pl->port = destport;
  503. pl->is_dynamic = false;
  504. } else
  505. pl->is_dynamic = true;
  506. pl->cl = cl;
  507. pl->s = new_listener(srcaddr, port, &pl->plug,
  508. !conf_get_bool(conf, CONF_lport_acceptall),
  509. conf, address_family);
  510. if ((err = sk_socket_error(pl->s)) != NULL) {
  511. char *err_ret = dupstr(err);
  512. sk_close(pl->s);
  513. free_portlistener_state(pl);
  514. *pl_ret = NULL;
  515. return err_ret;
  516. }
  517. return NULL;
  518. }
  519. static char *pfd_log_close_msg(Channel *chan)
  520. {
  521. return dupstr("Forwarded port closed");
  522. }
  523. static void pfd_close(struct PortForwarding *pf)
  524. {
  525. if (!pf)
  526. return;
  527. sk_close(pf->s);
  528. free_portfwd_state(pf);
  529. }
  530. /*
  531. * Terminate a listener.
  532. */
  533. static void pfl_terminate(struct PortListener *pl)
  534. {
  535. if (!pl)
  536. return;
  537. sk_close(pl->s);
  538. free_portlistener_state(pl);
  539. }
  540. static void pfd_set_input_wanted(Channel *chan, bool wanted)
  541. {
  542. pinitassert(chan->vt == &PortForwarding_channelvt);
  543. PortForwarding *pf = container_of(chan, PortForwarding, chan);
  544. pf->input_wanted = wanted;
  545. sk_set_frozen(pf->s, !pf->input_wanted);
  546. }
  547. static void pfd_chan_free(Channel *chan)
  548. {
  549. pinitassert(chan->vt == &PortForwarding_channelvt);
  550. PortForwarding *pf = container_of(chan, PortForwarding, chan);
  551. pfd_close(pf);
  552. }
  553. /*
  554. * Called to send data down the raw connection.
  555. */
  556. static int pfd_send(Channel *chan, bool is_stderr, const void *data, int len)
  557. {
  558. pinitassert(chan->vt == &PortForwarding_channelvt);
  559. PortForwarding *pf = container_of(chan, PortForwarding, chan);
  560. return sk_write(pf->s, data, len);
  561. }
  562. static void pfd_send_eof(Channel *chan)
  563. {
  564. pinitassert(chan->vt == &PortForwarding_channelvt);
  565. PortForwarding *pf = container_of(chan, PortForwarding, chan);
  566. sk_write_eof(pf->s);
  567. }
  568. static void pfd_open_confirmation(Channel *chan)
  569. {
  570. pinitassert(chan->vt == &PortForwarding_channelvt);
  571. PortForwarding *pf = container_of(chan, PortForwarding, chan);
  572. pf->ready = true;
  573. sk_set_frozen(pf->s, 0);
  574. sk_write(pf->s, NULL, 0);
  575. if (pf->socksbuf) {
  576. sshfwd_write(pf->c, pf->socksbuf->u + pf->socksbuf_consumed,
  577. pf->socksbuf->len - pf->socksbuf_consumed);
  578. strbuf_free(pf->socksbuf);
  579. pf->socksbuf = NULL;
  580. }
  581. }
  582. static void pfd_open_failure(Channel *chan, const char *errtext)
  583. {
  584. pinitassert(chan->vt == &PortForwarding_channelvt);
  585. PortForwarding *pf = container_of(chan, PortForwarding, chan);
  586. logeventf(pf->cl->logctx,
  587. "Forwarded connection refused by remote%s%s",
  588. errtext ? ": " : "", errtext ? errtext : "");
  589. }
  590. /* ----------------------------------------------------------------------
  591. * Code to manage the complete set of currently active port
  592. * forwardings, and update it from Conf.
  593. */
  594. struct PortFwdRecord {
  595. enum { DESTROY, KEEP, CREATE } status;
  596. int type;
  597. unsigned sport, dport;
  598. char *saddr, *daddr;
  599. char *sserv, *dserv;
  600. struct ssh_rportfwd *remote;
  601. int addressfamily;
  602. struct PortListener *local;
  603. };
  604. static int pfr_cmp(void *av, void *bv)
  605. {
  606. PortFwdRecord *a = (PortFwdRecord *) av;
  607. PortFwdRecord *b = (PortFwdRecord *) bv;
  608. int i;
  609. if (a->type > b->type)
  610. return +1;
  611. if (a->type < b->type)
  612. return -1;
  613. if (a->addressfamily > b->addressfamily)
  614. return +1;
  615. if (a->addressfamily < b->addressfamily)
  616. return -1;
  617. if ( (i = nullstrcmp(a->saddr, b->saddr)) != 0)
  618. return i < 0 ? -1 : +1;
  619. if (a->sport > b->sport)
  620. return +1;
  621. if (a->sport < b->sport)
  622. return -1;
  623. if (a->type != 'D') {
  624. if ( (i = nullstrcmp(a->daddr, b->daddr)) != 0)
  625. return i < 0 ? -1 : +1;
  626. if (a->dport > b->dport)
  627. return +1;
  628. if (a->dport < b->dport)
  629. return -1;
  630. }
  631. return 0;
  632. }
  633. void pfr_free(PortFwdRecord *pfr)
  634. {
  635. /* Dispose of any listening socket. */
  636. if (pfr->local)
  637. pfl_terminate(pfr->local);
  638. sfree(pfr->saddr);
  639. sfree(pfr->daddr);
  640. sfree(pfr->sserv);
  641. sfree(pfr->dserv);
  642. sfree(pfr);
  643. }
  644. struct PortFwdManager {
  645. ConnectionLayer *cl;
  646. Conf *conf;
  647. tree234 *forwardings;
  648. };
  649. PortFwdManager *portfwdmgr_new(ConnectionLayer *cl)
  650. {
  651. PortFwdManager *mgr = snew(PortFwdManager);
  652. mgr->cl = cl;
  653. mgr->conf = NULL;
  654. mgr->forwardings = newtree234(pfr_cmp);
  655. return mgr;
  656. }
  657. void portfwdmgr_close(PortFwdManager *mgr, PortFwdRecord *pfr)
  658. {
  659. PortFwdRecord *realpfr = del234(mgr->forwardings, pfr);
  660. if (realpfr == pfr)
  661. pfr_free(pfr);
  662. }
  663. void portfwdmgr_close_all(PortFwdManager *mgr)
  664. {
  665. PortFwdRecord *pfr;
  666. while ((pfr = delpos234(mgr->forwardings, 0)) != NULL)
  667. pfr_free(pfr);
  668. }
  669. void portfwdmgr_free(PortFwdManager *mgr)
  670. {
  671. portfwdmgr_close_all(mgr);
  672. freetree234(mgr->forwardings);
  673. if (mgr->conf)
  674. conf_free(mgr->conf);
  675. sfree(mgr);
  676. }
  677. void portfwdmgr_config(PortFwdManager *mgr, Conf *conf)
  678. {
  679. PortFwdRecord *pfr;
  680. int i;
  681. char *key, *val;
  682. if (mgr->conf)
  683. conf_free(mgr->conf);
  684. mgr->conf = conf_copy(conf);
  685. /*
  686. * Go through the existing port forwardings and tag them
  687. * with status==DESTROY. Any that we want to keep will be
  688. * re-enabled (status==KEEP) as we go through the
  689. * configuration and find out which bits are the same as
  690. * they were before.
  691. */
  692. for (i = 0; (pfr = index234(mgr->forwardings, i)) != NULL; i++)
  693. pfr->status = DESTROY;
  694. for (val = conf_get_str_strs(conf, CONF_portfwd, NULL, &key);
  695. val != NULL;
  696. val = conf_get_str_strs(conf, CONF_portfwd, key, &key)) {
  697. char *kp, *kp2, *vp, *vp2;
  698. char address_family, type;
  699. int sport, dport, sserv, dserv;
  700. char *sports, *dports, *saddr, *host;
  701. kp = key;
  702. address_family = 'A';
  703. type = 'L';
  704. if (*kp == 'A' || *kp == '4' || *kp == '6')
  705. address_family = *kp++;
  706. if (*kp == 'L' || *kp == 'R')
  707. type = *kp++;
  708. if ((kp2 = host_strchr(kp, ':')) != NULL) {
  709. /*
  710. * There's a colon in the middle of the source port
  711. * string, which means that the part before it is
  712. * actually a source address.
  713. */
  714. char *saddr_tmp = dupprintf("%.*s", (int)(kp2 - kp), kp);
  715. saddr = host_strduptrim(saddr_tmp);
  716. sfree(saddr_tmp);
  717. sports = kp2+1;
  718. } else {
  719. saddr = NULL;
  720. sports = kp;
  721. }
  722. sport = atoi(sports);
  723. sserv = 0;
  724. if (sport == 0) {
  725. sserv = 1;
  726. sport = net_service_lookup(sports);
  727. if (!sport) {
  728. logeventf(mgr->cl->logctx, "Service lookup failed for source"
  729. " port \"%s\"", sports);
  730. }
  731. }
  732. if (type == 'L' && !strcmp(val, "D")) {
  733. /* dynamic forwarding */
  734. host = NULL;
  735. dports = NULL;
  736. dport = -1;
  737. dserv = 0;
  738. type = 'D';
  739. } else {
  740. /* ordinary forwarding */
  741. vp = val;
  742. vp2 = vp + host_strcspn(vp, ":");
  743. host = dupprintf("%.*s", (int)(vp2 - vp), vp);
  744. if (*vp2)
  745. vp2++;
  746. dports = vp2;
  747. dport = atoi(dports);
  748. dserv = 0;
  749. if (dport == 0) {
  750. dserv = 1;
  751. dport = net_service_lookup(dports);
  752. if (!dport) {
  753. logeventf(mgr->cl->logctx,
  754. "Service lookup failed for destination"
  755. " port \"%s\"", dports);
  756. }
  757. }
  758. }
  759. if (sport && dport) {
  760. /* Set up a description of the source port. */
  761. pfr = snew(PortFwdRecord);
  762. pfr->type = type;
  763. pfr->saddr = saddr;
  764. pfr->sserv = sserv ? dupstr(sports) : NULL;
  765. pfr->sport = sport;
  766. pfr->daddr = host;
  767. pfr->dserv = dserv ? dupstr(dports) : NULL;
  768. pfr->dport = dport;
  769. pfr->local = NULL;
  770. pfr->remote = NULL;
  771. pfr->addressfamily = (address_family == '4' ? ADDRTYPE_IPV4 :
  772. address_family == '6' ? ADDRTYPE_IPV6 :
  773. ADDRTYPE_UNSPEC);
  774. { // WINSCP
  775. PortFwdRecord *existing = add234(mgr->forwardings, pfr);
  776. if (existing != pfr) {
  777. if (existing->status == DESTROY) {
  778. /*
  779. * We already have a port forwarding up and running
  780. * with precisely these parameters. Hence, no need
  781. * to do anything; simply re-tag the existing one
  782. * as KEEP.
  783. */
  784. existing->status = KEEP;
  785. }
  786. /*
  787. * Anything else indicates that there was a duplicate
  788. * in our input, which we'll silently ignore.
  789. */
  790. pfr_free(pfr);
  791. } else {
  792. pfr->status = CREATE;
  793. }
  794. } // WINSCP
  795. } else {
  796. sfree(saddr);
  797. sfree(host);
  798. }
  799. }
  800. /*
  801. * Now go through and destroy any port forwardings which were
  802. * not re-enabled.
  803. */
  804. for (i = 0; (pfr = index234(mgr->forwardings, i)) != NULL; i++) {
  805. if (pfr->status == DESTROY) {
  806. char *message;
  807. message = dupprintf("%s port forwarding from %s%s%d",
  808. pfr->type == 'L' ? "local" :
  809. pfr->type == 'R' ? "remote" : "dynamic",
  810. pfr->saddr ? pfr->saddr : "",
  811. pfr->saddr ? ":" : "",
  812. pfr->sport);
  813. if (pfr->type != 'D') {
  814. char *msg2 = dupprintf("%s to %s:%d", message,
  815. pfr->daddr, pfr->dport);
  816. sfree(message);
  817. message = msg2;
  818. }
  819. logeventf(mgr->cl->logctx, "Cancelling %s", message);
  820. sfree(message);
  821. /* pfr->remote or pfr->local may be NULL if setting up a
  822. * forwarding failed. */
  823. if (pfr->remote) {
  824. /*
  825. * Cancel the port forwarding at the server
  826. * end.
  827. *
  828. * Actually closing the listening port on the server
  829. * side may fail - because in SSH-1 there's no message
  830. * in the protocol to request it!
  831. *
  832. * Instead, we simply remove the record of the
  833. * forwarding from our local end, so that any
  834. * connections the server tries to make on it are
  835. * rejected.
  836. */
  837. ssh_rportfwd_remove(mgr->cl, pfr->remote);
  838. } else if (pfr->local) {
  839. pfl_terminate(pfr->local);
  840. }
  841. delpos234(mgr->forwardings, i);
  842. pfr_free(pfr);
  843. i--; /* so we don't skip one in the list */
  844. }
  845. }
  846. /*
  847. * And finally, set up any new port forwardings (status==CREATE).
  848. */
  849. for (i = 0; (pfr = index234(mgr->forwardings, i)) != NULL; i++) {
  850. if (pfr->status == CREATE) {
  851. char *sportdesc, *dportdesc;
  852. sportdesc = dupprintf("%s%s%s%s%d%s",
  853. pfr->saddr ? pfr->saddr : "",
  854. pfr->saddr ? ":" : "",
  855. pfr->sserv ? pfr->sserv : "",
  856. pfr->sserv ? "(" : "",
  857. pfr->sport,
  858. pfr->sserv ? ")" : "");
  859. if (pfr->type == 'D') {
  860. dportdesc = NULL;
  861. } else {
  862. dportdesc = dupprintf("%s:%s%s%d%s",
  863. pfr->daddr,
  864. pfr->dserv ? pfr->dserv : "",
  865. pfr->dserv ? "(" : "",
  866. pfr->dport,
  867. pfr->dserv ? ")" : "");
  868. }
  869. if (pfr->type == 'L') {
  870. char *err = pfl_listen(pfr->daddr, pfr->dport,
  871. pfr->saddr, pfr->sport,
  872. mgr->cl, conf, &pfr->local,
  873. pfr->addressfamily);
  874. logeventf(mgr->cl->logctx,
  875. "Local %sport %s forwarding to %s%s%s",
  876. pfr->addressfamily == ADDRTYPE_IPV4 ? "IPv4 " :
  877. pfr->addressfamily == ADDRTYPE_IPV6 ? "IPv6 " : "",
  878. sportdesc, dportdesc,
  879. err ? " failed: " : "", err ? err : "");
  880. if (err)
  881. sfree(err);
  882. } else if (pfr->type == 'D') {
  883. char *err = pfl_listen(NULL, -1, pfr->saddr, pfr->sport,
  884. mgr->cl, conf, &pfr->local,
  885. pfr->addressfamily);
  886. logeventf(mgr->cl->logctx,
  887. "Local %sport %s SOCKS dynamic forwarding%s%s",
  888. pfr->addressfamily == ADDRTYPE_IPV4 ? "IPv4 " :
  889. pfr->addressfamily == ADDRTYPE_IPV6 ? "IPv6 " : "",
  890. sportdesc,
  891. err ? " failed: " : "", err ? err : "");
  892. if (err)
  893. sfree(err);
  894. } else {
  895. const char *shost;
  896. if (pfr->saddr) {
  897. shost = pfr->saddr;
  898. } else if (conf_get_bool(conf, CONF_rport_acceptall)) {
  899. shost = "";
  900. } else {
  901. shost = "localhost";
  902. }
  903. pfr->remote = ssh_rportfwd_alloc(
  904. mgr->cl, shost, pfr->sport, pfr->daddr, pfr->dport,
  905. pfr->addressfamily, sportdesc, pfr, NULL);
  906. if (!pfr->remote) {
  907. logeventf(mgr->cl->logctx,
  908. "Duplicate remote port forwarding to %s:%d",
  909. pfr->daddr, pfr->dport);
  910. pfr_free(pfr);
  911. } else {
  912. logeventf(mgr->cl->logctx, "Requesting remote port %s"
  913. " forward to %s", sportdesc, dportdesc);
  914. }
  915. }
  916. sfree(sportdesc);
  917. sfree(dportdesc);
  918. }
  919. }
  920. }
  921. bool portfwdmgr_listen(PortFwdManager *mgr, const char *host, int port,
  922. const char *keyhost, int keyport, Conf *conf)
  923. {
  924. PortFwdRecord *pfr;
  925. pfr = snew(PortFwdRecord);
  926. pfr->type = 'L';
  927. pfr->saddr = host ? dupstr(host) : NULL;
  928. pfr->daddr = keyhost ? dupstr(keyhost) : NULL;
  929. pfr->sserv = pfr->dserv = NULL;
  930. pfr->sport = port;
  931. pfr->dport = keyport;
  932. pfr->local = NULL;
  933. pfr->remote = NULL;
  934. pfr->addressfamily = ADDRTYPE_UNSPEC;
  935. { // WINSCP
  936. PortFwdRecord *existing = add234(mgr->forwardings, pfr);
  937. if (existing != pfr) {
  938. /*
  939. * We had this record already. Return failure.
  940. */
  941. pfr_free(pfr);
  942. return false;
  943. }
  944. } // WINSCP
  945. { // WINSCP
  946. char *err = pfl_listen(keyhost, keyport, host, port,
  947. mgr->cl, conf, &pfr->local, pfr->addressfamily);
  948. logeventf(mgr->cl->logctx,
  949. "%s on port %s:%d to forward to client%s%s",
  950. err ? "Failed to listen" : "Listening", host, port,
  951. err ? ": " : "", err ? err : "");
  952. if (err) {
  953. sfree(err);
  954. del234(mgr->forwardings, pfr);
  955. pfr_free(pfr);
  956. return false;
  957. }
  958. } // WINSCP
  959. return true;
  960. }
  961. bool portfwdmgr_unlisten(PortFwdManager *mgr, const char *host, int port)
  962. {
  963. PortFwdRecord pfr_key;
  964. pfr_key.type = 'L';
  965. /* Safe to cast the const away here, because it will only be used
  966. * by pfr_cmp, which won't write to the string */
  967. pfr_key.saddr = pfr_key.daddr = (char *)host;
  968. pfr_key.sserv = pfr_key.dserv = NULL;
  969. pfr_key.sport = pfr_key.dport = port;
  970. pfr_key.local = NULL;
  971. pfr_key.remote = NULL;
  972. pfr_key.addressfamily = ADDRTYPE_UNSPEC;
  973. { // WINSCP
  974. PortFwdRecord *pfr = del234(mgr->forwardings, &pfr_key);
  975. if (!pfr)
  976. return false;
  977. logeventf(mgr->cl->logctx, "Closing listening port %s:%d", host, port);
  978. pfr_free(pfr);
  979. } // WINSCP
  980. return true;
  981. }
  982. /*
  983. * Called when receiving a PORT OPEN from the server to make a
  984. * connection to a destination host.
  985. *
  986. * On success, returns NULL and fills in *pf_ret. On error, returns a
  987. * dynamically allocated error message string.
  988. */
  989. char *portfwdmgr_connect(PortFwdManager *mgr, Channel **chan_ret,
  990. char *hostname, int port, SshChannel *c,
  991. int addressfamily)
  992. {
  993. SockAddr *addr;
  994. const char *err;
  995. char *dummy_realhost = NULL;
  996. struct PortForwarding *pf;
  997. /*
  998. * Try to find host.
  999. */
  1000. addr = name_lookup(hostname, port, &dummy_realhost, mgr->conf,
  1001. addressfamily, NULL, NULL);
  1002. if ((err = sk_addr_error(addr)) != NULL) {
  1003. char *err_ret = dupstr(err);
  1004. sk_addr_free(addr);
  1005. sfree(dummy_realhost);
  1006. return err_ret;
  1007. }
  1008. /*
  1009. * Open socket.
  1010. */
  1011. pf = new_portfwd_state();
  1012. *chan_ret = &pf->chan;
  1013. pf->plug.vt = &PortForwarding_plugvt;
  1014. pf->chan.initial_fixed_window_size = 0;
  1015. pf->chan.vt = &PortForwarding_channelvt;
  1016. pf->input_wanted = true;
  1017. pf->ready = true;
  1018. pf->c = c;
  1019. pf->cl = mgr->cl;
  1020. pf->socks_state = SOCKS_NONE;
  1021. pf->s = new_connection(addr, dummy_realhost, port,
  1022. false, true, false, false, &pf->plug, mgr->conf);
  1023. sfree(dummy_realhost);
  1024. if ((err = sk_socket_error(pf->s)) != NULL) {
  1025. char *err_ret = dupstr(err);
  1026. sk_close(pf->s);
  1027. free_portfwd_state(pf);
  1028. *chan_ret = NULL;
  1029. return err_ret;
  1030. }
  1031. return NULL;
  1032. }
  1033. #ifdef MPEXT
  1034. #include "puttyexp.h"
  1035. int is_pfwd(Plug * plug)
  1036. {
  1037. return
  1038. (plug->vt->closing == pfd_closing) ||
  1039. (plug->vt->closing == pfl_closing);
  1040. }
  1041. Seat * get_pfwd_seat(Plug * plug)
  1042. {
  1043. LogContext * logctx;
  1044. if (plug->vt->closing == pfl_closing)
  1045. {
  1046. struct PortListener *pl = container_of(plug, struct PortListener, plug);
  1047. logctx = pl->cl->logctx;
  1048. }
  1049. else if (plug->vt->closing == pfd_closing)
  1050. {
  1051. struct PortForwarding *pf = container_of(plug, struct PortForwarding, plug);
  1052. logctx = pf->cl->logctx;
  1053. }
  1054. return get_log_seat(logctx);
  1055. }
  1056. #endif