src/src/transports/smtp_socks.c

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) The Exim Maintainers 2021 - 2024 */
   6 /* Copyright (c) Jeremy Harris 2015 - 2018 */
   7 /* See the file NOTICE for conditions of use and distribution. */
   8 /* SPDX-License-Identifier: GPL-2.0-or-later */
   9
  10 /* SOCKS version 5 proxy, client-mode */
  11
  12 #include "../exim.h"
  13 #include "smtp.h"
  14
  15 #ifdef SUPPORT_SOCKS /* entire file */
  16
  17 #ifndef nelem
  18 # define nelem(arr) (sizeof(arr)/sizeof(*arr))
  19 #endif
  20
  21
  22 /* Defaults */
  23 #define SOCKS_PORT      1080
  24 #define SOCKS_TIMEOUT   5
  25 #define SOCKS_WEIGHT    1
  26 #define SOCKS_PRIORITY  1
  27
  28 #define AUTH_NONE       0
  29 #define AUTH_NAME       2               /* user/password per RFC 1929 */
  30 #define AUTH_NAME_VER   1
  31
  32 struct socks_err
  33   {
  34   uschar *      reason;
  35   int           errcode;
  36   } socks_errs[] =
  37   {
  38     {NULL, 0},
  39     {US"general SOCKS server failure",          EIO},
  40     {US"connection not allowed by ruleset",     EACCES},
  41     {US"Network unreachable",                   ENETUNREACH},
  42     {US"Host unreachable",                      EHOSTUNREACH},
  43     {US"Connection refused",                    ECONNREFUSED},
  44     {US"TTL expired",                           ECANCELED},
  45     {US"Command not supported",                 EOPNOTSUPP},
  46     {US"Address type not supported",            EAFNOSUPPORT}
  47   };
  48
  49 typedef struct
  50   {
  51   const uschar *        proxy_host;
  52   uschar                auth_type;      /* RFC 1928 encoding */
  53   const uschar *        auth_name;
  54   const uschar *        auth_pwd;
  55   short                 port;
  56   BOOL                  is_failed;
  57   unsigned              timeout;
  58   unsigned              weight;
  59   unsigned              priority;
  60   } socks_opts;
  61
  62 static void
  63 socks_option_defaults(socks_opts * sob)
  64 {
  65 sob->proxy_host = NULL;
  66 sob->auth_type =  AUTH_NONE;
  67 sob->auth_name =  US"";
  68 sob->auth_pwd =   US"";
  69 sob->is_failed =  FALSE;
  70 sob->port =       SOCKS_PORT;
  71 sob->timeout =    SOCKS_TIMEOUT;
  72 sob->weight =     SOCKS_WEIGHT;
  73 sob->priority =   SOCKS_PRIORITY;
  74 }
  75
  76 static void
  77 socks_option(socks_opts * sob, const uschar * opt)
  78 {
  79 if (Ustrncmp(opt, "auth=", 5) == 0)
  80   {
  81   opt += 5;
  82   if (Ustrcmp(opt, "none") == 0)        sob->auth_type = AUTH_NONE;
  83   else if (Ustrcmp(opt, "name") == 0)   sob->auth_type = AUTH_NAME;
  84   }
  85 else if (Ustrncmp(opt, "name=", 5) == 0)
  86   sob->auth_name = opt + 5;
  87 else if (Ustrncmp(opt, "pass=", 5) == 0)
  88   sob->auth_pwd = opt + 5;
  89 else if (Ustrncmp(opt, "port=", 5) == 0)
  90   sob->port = atoi(CCS opt + 5);
  91 else if (Ustrncmp(opt, "tmo=", 4) == 0)
  92   sob->timeout = atoi(CCS opt + 4);
  93 else if (Ustrncmp(opt, "pri=", 4) == 0)
  94   sob->priority = atoi(CCS opt + 4);
  95 else if (Ustrncmp(opt, "weight=", 7) == 0)
  96   sob->weight = atoi(CCS opt + 7);
  97 return;
  98 }
  99
 100 static int
 101 socks_auth(int fd, int method, socks_opts * sob, time_t tmo)
 102 {
 103 uschar * s;
 104 int len, i, j;
 105
 106 switch(method)
 107   {
 108   default:
 109     log_write(0, LOG_MAIN|LOG_PANIC,
 110       "Unrecognised socks auth method %d", method);
 111     return FAIL;
 112   case AUTH_NONE:
 113     return OK;
 114   case AUTH_NAME:
 115     HDEBUG(D_transport|D_acl|D_v) debug_printf_indent("  socks auth NAME '%s' '%s'\n",
 116       sob->auth_name, sob->auth_pwd);
 117     i = Ustrlen(sob->auth_name);
 118     j = Ustrlen(sob->auth_pwd);
 119     s = string_sprintf("%c%c%.255s%c%.255s", AUTH_NAME_VER,
 120       i, sob->auth_name, j, sob->auth_pwd);
 121     len = i + j + 3;
 122     HDEBUG(D_transport|D_acl|D_v)
 123       {
 124       debug_printf_indent("  SOCKS>>");
 125       for (int i = 0; i<len; i++) debug_printf(" %02x", s[i]);
 126       debug_printf("\n");
 127       }
 128     if (send(fd, s, len, 0) < 0)
 129       return FAIL;
 130 #ifdef TCP_QUICKACK
 131     (void) setsockopt(fd, IPPROTO_TCP, TCP_QUICKACK, US &off, sizeof(off));
 132 #endif
 133     if (!fd_ready(fd, tmo) || read(fd, s, 2) != 2)
 134       return FAIL;
 135     HDEBUG(D_transport|D_acl|D_v)
 136       debug_printf_indent("  SOCKS<< %02x %02x\n", s[0], s[1]);
 137     if (s[0] == AUTH_NAME_VER && s[1] == 0)
 138       {
 139       HDEBUG(D_transport|D_acl|D_v) debug_printf_indent("  socks auth OK\n");
 140       return OK;
 141       }
 142
 143     log_write(0, LOG_MAIN|LOG_PANIC, "socks auth failed");
 144     errno = EPROTO;
 145     return FAIL;
 146   }
 147 }
 148
 149
 150
 151 /* Find a suitable proxy to use from the list.
 152 Possible common code with spamd_get_server() ?
 153
 154 Return: index into proxy spec array, or -1
 155 */
 156
 157 static int
 158 socks_get_proxy(socks_opts * proxies, unsigned nproxies)
 159 {
 160 unsigned int i;
 161 socks_opts * sd;
 162 socks_opts * lim = &proxies[nproxies];
 163 long rnd, weights;
 164 unsigned pri;
 165
 166 if (nproxies == 1)              /* shortcut, if we have only 1 server */
 167   return (proxies[0].is_failed ? -1 : 0);
 168
 169 /* scan for highest pri */
 170 for (pri = 0, sd = proxies; sd < lim; sd++)
 171   if (!sd->is_failed && sd->priority > pri)
 172     pri = sd->priority;
 173
 174 /* get sum of weights at this pri */
 175 for (weights = 0, sd = proxies; sd < lim; sd++)
 176   if (!sd->is_failed && sd->priority == pri)
 177     weights += sd->weight;
 178 if (weights == 0)       /* all servers failed */
 179   return -1;
 180
 181 for (rnd = random_number(weights), i = 0; i < nproxies; i++)
 182   {
 183   sd = &proxies[i];
 184   if (!sd->is_failed && sd->priority == pri)
 185     if ((rnd -= sd->weight) < 0)
 186       return i;
 187   }
 188
 189 log_write(0, LOG_MAIN|LOG_PANIC,
 190   "%s unknown error (memory/cpu corruption?)", __FUNCTION__);
 191 return -1;
 192 }
 193
 194
 195
 196 /* Make a connection via a socks proxy
 197
 198 Arguments:
 199  host           smtp target host
 200  host_af        address family
 201  port           remote tcp port number
 202  interface      local interface
 203  tb             transport
 204  timeout        connection timeout (zero for indefinite)
 205
 206 Return value:
 207  0 on success; -1 on failure, with errno set
 208 */
 209
 210 int
 211 socks_sock_connect(host_item * host, int host_af, int port, uschar * interface,
 212   transport_instance * tb, int timeout)
 213 {
 214 smtp_transport_options_block * ob = tb->drinst.options_block;
 215 const uschar * proxy_list, * proxy_spec;
 216 int sep = 0;
 217 int fd;
 218 time_t tmo;
 219 const uschar * state;
 220 uschar buf[24];
 221 socks_opts proxies[32];                 /* max #proxies handled */
 222 unsigned nproxies;
 223 socks_opts * sob = NULL;
 224 unsigned size;
 225 blob early_data;
 226
 227 if (!timeout) timeout = 24*60*60;       /* use 1 day for "indefinite" */
 228 tmo = time(NULL) + timeout;
 229
 230 GET_OPTION("socks_proxy");
 231 if (!(proxy_list = expand_string(ob->socks_proxy)))
 232   {
 233   log_write(0, LOG_MAIN|LOG_PANIC, "Bad expansion for socks_proxy in %s",
 234     tb->drinst.name);
 235   return -1;
 236   }
 237
 238 /* Read proxy list */
 239
 240 for (nproxies = 0;
 241         nproxies < nelem(proxies)
 242      && (proxy_spec = string_nextinlist(&proxy_list, &sep, NULL, 0));
 243      nproxies++)
 244   {
 245   int subsep = -' ';
 246   const uschar * option;
 247
 248   socks_option_defaults(sob = &proxies[nproxies]);
 249
 250   if (!(sob->proxy_host = string_nextinlist(&proxy_spec, &subsep, NULL, 0)))
 251     {
 252     /* paniclog config error */
 253     return -1;
 254     }
 255
 256   /*XXX consider global options eg. "hide socks_password = wibble" on the tpt */
 257   /* extract any further per-proxy options */
 258   while ((option = string_nextinlist(&proxy_spec, &subsep, NULL, 0)))
 259     socks_option(sob, option);
 260   }
 261 if (!sob) return -1;
 262
 263 /* Set up the socks protocol method-selection message,
 264 for sending on connection */
 265
 266 state = US"method select";
 267 buf[0] = 5; buf[1] = 1; buf[2] = sob->auth_type;
 268 early_data.data = buf;
 269 early_data.len = 3;
 270
 271 /* Try proxies until a connection succeeds */
 272
 273 for(;;)
 274   {
 275   int idx;
 276   host_item proxy;
 277   smtp_connect_args sc = {.sock = -1};
 278
 279   if ((idx = socks_get_proxy(proxies, nproxies)) < 0)
 280     {
 281     HDEBUG(D_transport|D_acl|D_v) debug_printf_indent("  no proxies left\n");
 282     errno = EBUSY;
 283     return -1;
 284     }
 285   sob = &proxies[idx];
 286
 287   /* bodge up a host struct for the proxy */
 288   proxy.address = proxy.name = sob->proxy_host;
 289   proxy.port = sob->port;
 290
 291   sc.tblock = tb;
 292   sc.ob = ob;
 293   sc.host = &proxy;
 294   sc.host_af = Ustrchr(sob->proxy_host, ':') ? AF_INET6 : AF_INET;
 295   sc.interface = interface;
 296
 297   /*XXX we trust that the method-select command is idempotent */
 298   if ((fd = smtp_sock_connect(&sc, sob->timeout, &early_data)) >= 0)
 299     {
 300     proxy_local_address = string_copy(proxy.address);
 301     proxy_local_port = sob->port;
 302     break;
 303     }
 304
 305   log_write(0, LOG_MAIN, "%s: %s", __FUNCTION__, strerror(errno));
 306   sob->is_failed = TRUE;
 307   }
 308
 309 /* Do the socks protocol stuff */
 310
 311 HDEBUG(D_transport|D_acl|D_v) debug_printf_indent("  SOCKS>> 05 01 %02x\n", sob->auth_type);
 312
 313 /* expect method response */
 314
 315 #ifdef TCP_QUICKACK
 316 (void) setsockopt(fd, IPPROTO_TCP, TCP_QUICKACK, US &off, sizeof(off));
 317 #endif
 318
 319 if (  !fd_ready(fd, tmo)
 320    || read(fd, buf, 2) != 2
 321    )
 322   goto rcv_err;
 323 HDEBUG(D_transport|D_acl|D_v)
 324   debug_printf_indent("  SOCKS<< %02x %02x\n", buf[0], buf[1]);
 325 if (  buf[0] != 5
 326    || socks_auth(fd, buf[1], sob, tmo) != OK
 327    )
 328   goto proxy_err;
 329
 330  {
 331   union sockaddr_46 sin;
 332   (void) ip_addr(&sin, host_af, host->address, port);
 333
 334   /* send connect (ipver, ipaddr, port) */
 335
 336   buf[0] = 5; buf[1] = 1; buf[2] = 0; buf[3] = host_af == AF_INET6 ? 4 : 1;
 337   #if HAVE_IPV6
 338   if (host_af == AF_INET6)
 339     {
 340     memcpy(buf+4, &sin.v6.sin6_addr,       sizeof(sin.v6.sin6_addr));
 341     memcpy(buf+4+sizeof(sin.v6.sin6_addr),
 342       &sin.v6.sin6_port, sizeof(sin.v6.sin6_port));
 343     size = 4+sizeof(sin.v6.sin6_addr)+sizeof(sin.v6.sin6_port);
 344     }
 345   else
 346   #endif
 347     {
 348     memcpy(buf+4, &sin.v4.sin_addr.s_addr, sizeof(sin.v4.sin_addr.s_addr));
 349     memcpy(buf+4+sizeof(sin.v4.sin_addr.s_addr),
 350       &sin.v4.sin_port, sizeof(sin.v4.sin_port));
 351     size = 4+sizeof(sin.v4.sin_addr.s_addr)+sizeof(sin.v4.sin_port);
 352     }
 353  }
 354
 355 state = US"connect";
 356 HDEBUG(D_transport|D_acl|D_v)
 357   {
 358   debug_printf_indent("  SOCKS>>");
 359   for (int i = 0; i<size; i++) debug_printf(" %02x", buf[i]);
 360   debug_printf("\n");
 361   }
 362 if (send(fd, buf, size, 0) < 0)
 363   goto snd_err;
 364
 365 /* expect conn-reply (success, local(ipver, addr, port))
 366 of same length as conn-request, or non-success fail code */
 367
 368 if (  !fd_ready(fd, tmo)
 369    || (size = read(fd, buf, size)) < 2
 370    )
 371   goto rcv_err;
 372 HDEBUG(D_transport|D_acl|D_v)
 373   {
 374   debug_printf_indent("  SOCKS>>");
 375   for (int i = 0; i<size; i++) debug_printf(" %02x", buf[i]);
 376   debug_printf("\n");
 377   }
 378 if (  buf[0] != 5
 379    || buf[1] != 0
 380    )
 381   goto proxy_err;
 382
 383 proxy_external_address = string_copy(
 384   host_ntoa(buf[3] == 4 ? AF_INET6 : AF_INET, buf+4, NULL, NULL));
 385 proxy_external_port = ntohs(*((uint16_t *)(buf + (buf[3] == 4 ? 20 : 8))));
 386 proxy_session = TRUE;
 387
 388 HDEBUG(D_transport|D_acl|D_v)
 389   debug_printf_indent("  proxy farside: [%s]:%d\n", proxy_external_address, proxy_external_port);
 390
 391 return fd;
 392
 393 snd_err:
 394   HDEBUG(D_transport|D_acl|D_v) debug_printf_indent("  proxy snd_err %s: %s\n", state, strerror(errno));
 395   return -1;
 396
 397 proxy_err:
 398   {
 399   struct socks_err * se =
 400     buf[1] > nelem(socks_errs) ? NULL : socks_errs + buf[1];
 401   HDEBUG(D_transport|D_acl|D_v)
 402     debug_printf_indent("  proxy %s: %s\n", state, se ? se->reason : US"unknown error code received");
 403   errno = se ? se->errcode : EPROTO;
 404   }
 405
 406 rcv_err:
 407   HDEBUG(D_transport|D_acl|D_v) debug_printf_indent("  proxy rcv_err %s: %s\n", state, strerror(errno));
 408   if (!errno) errno = EPROTO;
 409   else if (errno == ENOENT) errno = ECONNABORTED;
 410   return -1;
 411 }
 412
 413 #endif  /* entire file */
 414 /* vi: aw ai sw=2
 415 */