sys/netinet/tcp_syncache.c

   1 /*-
   2  * Copyright (c) 2001 McAfee, Inc.
   3  * Copyright (c) 2006,2013 Andre Oppermann, Internet Business Solutions AG
   4  * All rights reserved.
   5  *
   6  * This software was developed for the FreeBSD Project by Jonathan Lemon
   7  * and McAfee Research, the Security Research Division of McAfee, Inc. under
   8  * DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
   9  * DARPA CHATS research program. [2001 McAfee, Inc.]
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  */
  32
  33 #include <sys/cdefs.h>
  34 __FBSDID("$FreeBSD$");
  35
  36 #include "opt_inet.h"
  37 #include "opt_inet6.h"
  38 #include "opt_ipsec.h"
  39 #include "opt_pcbgroup.h"
  40
  41 #include <sys/param.h>
  42 #include <sys/systm.h>
  43 #include <sys/kernel.h>
  44 #include <sys/sysctl.h>
  45 #include <sys/limits.h>
  46 #include <sys/lock.h>
  47 #include <sys/mutex.h>
  48 #include <sys/malloc.h>
  49 #include <sys/mbuf.h>
  50 #include <sys/proc.h>           /* for proc0 declaration */
  51 #include <sys/random.h>
  52 #include <sys/socket.h>
  53 #include <sys/socketvar.h>
  54 #include <sys/syslog.h>
  55 #include <sys/ucred.h>
  56
  57 #include <sys/md5.h>
  58 #include <crypto/siphash/siphash.h>
  59
  60 #include <vm/uma.h>
  61
  62 #include <net/if.h>
  63 #include <net/route.h>
  64 #include <net/vnet.h>
  65
  66 #include <netinet/in.h>
  67 #include <netinet/in_systm.h>
  68 #include <netinet/ip.h>
  69 #include <netinet/in_var.h>
  70 #include <netinet/in_pcb.h>
  71 #include <netinet/ip_var.h>
  72 #include <netinet/ip_options.h>
  73 #ifdef INET6
  74 #include <netinet/ip6.h>
  75 #include <netinet/icmp6.h>
  76 #include <netinet6/nd6.h>
  77 #include <netinet6/ip6_var.h>
  78 #include <netinet6/in6_pcb.h>
  79 #endif
  80 #include <netinet/tcp.h>
  81 #include <netinet/tcp_fsm.h>
  82 #include <netinet/tcp_seq.h>
  83 #include <netinet/tcp_timer.h>
  84 #include <netinet/tcp_var.h>
  85 #include <netinet/tcp_syncache.h>
  86 #ifdef INET6
  87 #include <netinet6/tcp6_var.h>
  88 #endif
  89 #ifdef TCP_OFFLOAD
  90 #include <netinet/toecore.h>
  91 #endif
  92
  93 #ifdef IPSEC
  94 #include <netipsec/ipsec.h>
  95 #ifdef INET6
  96 #include <netipsec/ipsec6.h>
  97 #endif
  98 #include <netipsec/key.h>
  99 #endif /*IPSEC*/
 100
 101 #include <machine/in_cksum.h>
 102
 103 #include <security/mac/mac_framework.h>
 104
 105 static VNET_DEFINE(int, tcp_syncookies) = 1;
 106 #define V_tcp_syncookies                VNET(tcp_syncookies)
 107 SYSCTL_VNET_INT(_net_inet_tcp, OID_AUTO, syncookies, CTLFLAG_RW,
 108     &VNET_NAME(tcp_syncookies), 0,
 109     "Use TCP SYN cookies if the syncache overflows");
 110
 111 static VNET_DEFINE(int, tcp_syncookiesonly) = 0;
 112 #define V_tcp_syncookiesonly            VNET(tcp_syncookiesonly)
 113 SYSCTL_VNET_INT(_net_inet_tcp, OID_AUTO, syncookies_only, CTLFLAG_RW,
 114     &VNET_NAME(tcp_syncookiesonly), 0,
 115     "Use only TCP SYN cookies");
 116
 117 #ifdef TCP_OFFLOAD
 118 #define ADDED_BY_TOE(sc) ((sc)->sc_tod != NULL)
 119 #endif
 120
 121 static void      syncache_drop(struct syncache *, struct syncache_head *);
 122 static void      syncache_free(struct syncache *);
 123 static void      syncache_insert(struct syncache *, struct syncache_head *);
 124 struct syncache *syncache_lookup(struct in_conninfo *, struct syncache_head **);
 125 static int       syncache_respond(struct syncache *);
 126 static struct    socket *syncache_socket(struct syncache *, struct socket *,
 127                     struct mbuf *m);
 128 static int       syncache_sysctl_count(SYSCTL_HANDLER_ARGS);
 129 static void      syncache_timeout(struct syncache *sc, struct syncache_head *sch,
 130                     int docallout);
 131 static void      syncache_timer(void *);
 132
 133 static uint32_t  syncookie_mac(struct in_conninfo *, tcp_seq, uint8_t,
 134                     uint8_t *, uintptr_t);
 135 static tcp_seq   syncookie_generate(struct syncache_head *, struct syncache *);
 136 static struct syncache
 137                 *syncookie_lookup(struct in_conninfo *, struct syncache_head *,
 138                     struct syncache *, struct tcphdr *, struct tcpopt *,
 139                     struct socket *);
 140 static void      syncookie_reseed(void *);
 141 #ifdef INVARIANTS
 142 static int       syncookie_cmp(struct in_conninfo *inc, struct syncache_head *sch,
 143                     struct syncache *sc, struct tcphdr *th, struct tcpopt *to,
 144                     struct socket *lso);
 145 #endif
 146
 147 /*
 148  * Transmit the SYN,ACK fewer times than TCP_MAXRXTSHIFT specifies.
 149  * 3 retransmits corresponds to a timeout of 3 * (1 + 2 + 4 + 8) == 45 seconds,
 150  * the odds are that the user has given up attempting to connect by then.
 151  */
 152 #define SYNCACHE_MAXREXMTS              3
 153
 154 /* Arbitrary values */
 155 #define TCP_SYNCACHE_HASHSIZE           512
 156 #define TCP_SYNCACHE_BUCKETLIMIT        30
 157
 158 static VNET_DEFINE(struct tcp_syncache, tcp_syncache);
 159 #define V_tcp_syncache                  VNET(tcp_syncache)
 160
 161 static SYSCTL_NODE(_net_inet_tcp, OID_AUTO, syncache, CTLFLAG_RW, 0,
 162     "TCP SYN cache");
 163
 164 SYSCTL_VNET_UINT(_net_inet_tcp_syncache, OID_AUTO, bucketlimit, CTLFLAG_RDTUN,
 165     &VNET_NAME(tcp_syncache.bucket_limit), 0,
 166     "Per-bucket hash limit for syncache");
 167
 168 SYSCTL_VNET_UINT(_net_inet_tcp_syncache, OID_AUTO, cachelimit, CTLFLAG_RDTUN,
 169     &VNET_NAME(tcp_syncache.cache_limit), 0,
 170     "Overall entry limit for syncache");
 171
 172 SYSCTL_VNET_PROC(_net_inet_tcp_syncache, OID_AUTO, count, (CTLTYPE_UINT|CTLFLAG_RD),
 173     NULL, 0, &syncache_sysctl_count, "IU",
 174     "Current number of entries in syncache");
 175
 176 SYSCTL_VNET_UINT(_net_inet_tcp_syncache, OID_AUTO, hashsize, CTLFLAG_RDTUN,
 177     &VNET_NAME(tcp_syncache.hashsize), 0,
 178     "Size of TCP syncache hashtable");
 179
 180 SYSCTL_VNET_UINT(_net_inet_tcp_syncache, OID_AUTO, rexmtlimit, CTLFLAG_RW,
 181     &VNET_NAME(tcp_syncache.rexmt_limit), 0,
 182     "Limit on SYN/ACK retransmissions");
 183
 184 VNET_DEFINE(int, tcp_sc_rst_sock_fail) = 1;
 185 SYSCTL_VNET_INT(_net_inet_tcp_syncache, OID_AUTO, rst_on_sock_fail,
 186     CTLFLAG_RW, &VNET_NAME(tcp_sc_rst_sock_fail), 0,
 187     "Send reset on socket allocation failure");
 188
 189 static MALLOC_DEFINE(M_SYNCACHE, "syncache", "TCP syncache");
 190
 191 #define SYNCACHE_HASH(inc, mask)                                        \
 192         ((V_tcp_syncache.hash_secret ^                                  \
 193           (inc)->inc_faddr.s_addr ^                                     \
 194           ((inc)->inc_faddr.s_addr >> 16) ^                             \
 195           (inc)->inc_fport ^ (inc)->inc_lport) & mask)
 196
 197 #define SYNCACHE_HASH6(inc, mask)                                       \
 198         ((V_tcp_syncache.hash_secret ^                                  \
 199           (inc)->inc6_faddr.s6_addr32[0] ^                              \
 200           (inc)->inc6_faddr.s6_addr32[3] ^                              \
 201           (inc)->inc_fport ^ (inc)->inc_lport) & mask)
 202
 203 #define ENDPTS_EQ(a, b) (                                               \
 204         (a)->ie_fport == (b)->ie_fport &&                               \
 205         (a)->ie_lport == (b)->ie_lport &&                               \
 206         (a)->ie_faddr.s_addr == (b)->ie_faddr.s_addr &&                 \
 207         (a)->ie_laddr.s_addr == (b)->ie_laddr.s_addr                    \
 208 )
 209
 210 #define ENDPTS6_EQ(a, b) (memcmp(a, b, sizeof(*a)) == 0)
 211
 212 #define SCH_LOCK(sch)           mtx_lock(&(sch)->sch_mtx)
 213 #define SCH_UNLOCK(sch)         mtx_unlock(&(sch)->sch_mtx)
 214 #define SCH_LOCK_ASSERT(sch)    mtx_assert(&(sch)->sch_mtx, MA_OWNED)
 215
 216 /*
 217  * Requires the syncache entry to be already removed from the bucket list.
 218  */
 219 static void
 220 syncache_free(struct syncache *sc)
 221 {
 222
 223         if (sc->sc_ipopts)
 224                 (void) m_free(sc->sc_ipopts);
 225         if (sc->sc_cred)
 226                 crfree(sc->sc_cred);
 227 #ifdef MAC
 228         mac_syncache_destroy(&sc->sc_label);
 229 #endif
 230
 231         uma_zfree(V_tcp_syncache.zone, sc);
 232 }
 233
 234 void
 235 syncache_init(void)
 236 {
 237         int i;
 238
 239         V_tcp_syncache.hashsize = TCP_SYNCACHE_HASHSIZE;
 240         V_tcp_syncache.bucket_limit = TCP_SYNCACHE_BUCKETLIMIT;
 241         V_tcp_syncache.rexmt_limit = SYNCACHE_MAXREXMTS;
 242         V_tcp_syncache.hash_secret = arc4random();
 243
 244         TUNABLE_INT_FETCH("net.inet.tcp.syncache.hashsize",
 245             &V_tcp_syncache.hashsize);
 246         TUNABLE_INT_FETCH("net.inet.tcp.syncache.bucketlimit",
 247             &V_tcp_syncache.bucket_limit);
 248         if (!powerof2(V_tcp_syncache.hashsize) ||
 249             V_tcp_syncache.hashsize == 0) {
 250                 printf("WARNING: syncache hash size is not a power of 2.\n");
 251                 V_tcp_syncache.hashsize = TCP_SYNCACHE_HASHSIZE;
 252         }
 253         V_tcp_syncache.hashmask = V_tcp_syncache.hashsize - 1;
 254
 255         /* Set limits. */
 256         V_tcp_syncache.cache_limit =
 257             V_tcp_syncache.hashsize * V_tcp_syncache.bucket_limit;
 258         TUNABLE_INT_FETCH("net.inet.tcp.syncache.cachelimit",
 259             &V_tcp_syncache.cache_limit);
 260
 261         /* Allocate the hash table. */
 262         V_tcp_syncache.hashbase = malloc(V_tcp_syncache.hashsize *
 263             sizeof(struct syncache_head), M_SYNCACHE, M_WAITOK | M_ZERO);
 264
 265 #ifdef VIMAGE
 266         V_tcp_syncache.vnet = curvnet;
 267 #endif
 268
 269         /* Initialize the hash buckets. */
 270         for (i = 0; i < V_tcp_syncache.hashsize; i++) {
 271                 TAILQ_INIT(&V_tcp_syncache.hashbase[i].sch_bucket);
 272                 mtx_init(&V_tcp_syncache.hashbase[i].sch_mtx, "tcp_sc_head",
 273                          NULL, MTX_DEF);
 274                 callout_init_mtx(&V_tcp_syncache.hashbase[i].sch_timer,
 275                          &V_tcp_syncache.hashbase[i].sch_mtx, 0);
 276                 V_tcp_syncache.hashbase[i].sch_length = 0;
 277                 V_tcp_syncache.hashbase[i].sch_sc = &V_tcp_syncache;
 278         }
 279
 280         /* Create the syncache entry zone. */
 281         V_tcp_syncache.zone = uma_zcreate("syncache", sizeof(struct syncache),
 282             NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, 0);
 283         V_tcp_syncache.cache_limit = uma_zone_set_max(V_tcp_syncache.zone,
 284             V_tcp_syncache.cache_limit);
 285
 286         /* Start the SYN cookie reseeder callout. */
 287         callout_init(&V_tcp_syncache.secret.reseed, 1);
 288         arc4rand(V_tcp_syncache.secret.key[0], SYNCOOKIE_SECRET_SIZE, 0);
 289         arc4rand(V_tcp_syncache.secret.key[1], SYNCOOKIE_SECRET_SIZE, 0);
 290         callout_reset(&V_tcp_syncache.secret.reseed, SYNCOOKIE_LIFETIME * hz,
 291             syncookie_reseed, &V_tcp_syncache);
 292 }
 293
 294 #ifdef VIMAGE
 295 void
 296 syncache_destroy(void)
 297 {
 298         struct syncache_head *sch;
 299         struct syncache *sc, *nsc;
 300         int i;
 301
 302         /* Cleanup hash buckets: stop timers, free entries, destroy locks. */
 303         for (i = 0; i < V_tcp_syncache.hashsize; i++) {
 304
 305                 sch = &V_tcp_syncache.hashbase[i];
 306                 callout_drain(&sch->sch_timer);
 307
 308                 SCH_LOCK(sch);
 309                 TAILQ_FOREACH_SAFE(sc, &sch->sch_bucket, sc_hash, nsc)
 310                         syncache_drop(sc, sch);
 311                 SCH_UNLOCK(sch);
 312                 KASSERT(TAILQ_EMPTY(&sch->sch_bucket),
 313                     ("%s: sch->sch_bucket not empty", __func__));
 314                 KASSERT(sch->sch_length == 0, ("%s: sch->sch_length %d not 0",
 315                     __func__, sch->sch_length));
 316                 mtx_destroy(&sch->sch_mtx);
 317         }
 318
 319         KASSERT(uma_zone_get_cur(V_tcp_syncache.zone) == 0,
 320             ("%s: cache_count not 0", __func__));
 321
 322         /* Free the allocated global resources. */
 323         uma_zdestroy(V_tcp_syncache.zone);
 324         free(V_tcp_syncache.hashbase, M_SYNCACHE);
 325
 326         callout_drain(&V_tcp_syncache.secret.reseed);
 327 }
 328 #endif
 329
 330 static int
 331 syncache_sysctl_count(SYSCTL_HANDLER_ARGS)
 332 {
 333         int count;
 334
 335         count = uma_zone_get_cur(V_tcp_syncache.zone);
 336         return (sysctl_handle_int(oidp, &count, 0, req));
 337 }
 338
 339 /*
 340  * Inserts a syncache entry into the specified bucket row.
 341  * Locks and unlocks the syncache_head autonomously.
 342  */
 343 static void
 344 syncache_insert(struct syncache *sc, struct syncache_head *sch)
 345 {
 346         struct syncache *sc2;
 347
 348         SCH_LOCK(sch);
 349
 350         /*
 351          * Make sure that we don't overflow the per-bucket limit.
 352          * If the bucket is full, toss the oldest element.
 353          */
 354         if (sch->sch_length >= V_tcp_syncache.bucket_limit) {
 355                 KASSERT(!TAILQ_EMPTY(&sch->sch_bucket),
 356                         ("sch->sch_length incorrect"));
 357                 sc2 = TAILQ_LAST(&sch->sch_bucket, sch_head);
 358                 syncache_drop(sc2, sch);
 359                 TCPSTAT_INC(tcps_sc_bucketoverflow);
 360         }
 361
 362         /* Put it into the bucket. */
 363         TAILQ_INSERT_HEAD(&sch->sch_bucket, sc, sc_hash);
 364         sch->sch_length++;
 365
 366 #ifdef TCP_OFFLOAD
 367         if (ADDED_BY_TOE(sc)) {
 368                 struct toedev *tod = sc->sc_tod;
 369
 370                 tod->tod_syncache_added(tod, sc->sc_todctx);
 371         }
 372 #endif
 373
 374         /* Reinitialize the bucket row's timer. */
 375         if (sch->sch_length == 1)
 376                 sch->sch_nextc = ticks + INT_MAX;
 377         syncache_timeout(sc, sch, 1);
 378
 379         SCH_UNLOCK(sch);
 380
 381         TCPSTAT_INC(tcps_sc_added);
 382 }
 383
 384 /*
 385  * Remove and free entry from syncache bucket row.
 386  * Expects locked syncache head.
 387  */
 388 static void
 389 syncache_drop(struct syncache *sc, struct syncache_head *sch)
 390 {
 391
 392         SCH_LOCK_ASSERT(sch);
 393
 394         TAILQ_REMOVE(&sch->sch_bucket, sc, sc_hash);
 395         sch->sch_length--;
 396
 397 #ifdef TCP_OFFLOAD
 398         if (ADDED_BY_TOE(sc)) {
 399                 struct toedev *tod = sc->sc_tod;
 400
 401                 tod->tod_syncache_removed(tod, sc->sc_todctx);
 402         }
 403 #endif
 404
 405         syncache_free(sc);
 406 }
 407
 408 /*
 409  * Engage/reengage time on bucket row.
 410  */
 411 static void
 412 syncache_timeout(struct syncache *sc, struct syncache_head *sch, int docallout)
 413 {
 414         sc->sc_rxttime = ticks +
 415                 TCPTV_RTOBASE * (tcp_syn_backoff[sc->sc_rxmits]);
 416         sc->sc_rxmits++;
 417         if (TSTMP_LT(sc->sc_rxttime, sch->sch_nextc)) {
 418                 sch->sch_nextc = sc->sc_rxttime;
 419                 if (docallout)
 420                         callout_reset(&sch->sch_timer, sch->sch_nextc - ticks,
 421                             syncache_timer, (void *)sch);
 422         }
 423 }
 424
 425 /*
 426  * Walk the timer queues, looking for SYN,ACKs that need to be retransmitted.
 427  * If we have retransmitted an entry the maximum number of times, expire it.
 428  * One separate timer for each bucket row.
 429  */
 430 static void
 431 syncache_timer(void *xsch)
 432 {
 433         struct syncache_head *sch = (struct syncache_head *)xsch;
 434         struct syncache *sc, *nsc;
 435         int tick = ticks;
 436         char *s;
 437
 438         CURVNET_SET(sch->sch_sc->vnet);
 439
 440         /* NB: syncache_head has already been locked by the callout. */
 441         SCH_LOCK_ASSERT(sch);
 442
 443         /*
 444          * In the following cycle we may remove some entries and/or
 445          * advance some timeouts, so re-initialize the bucket timer.
 446          */
 447         sch->sch_nextc = tick + INT_MAX;
 448
 449         TAILQ_FOREACH_SAFE(sc, &sch->sch_bucket, sc_hash, nsc) {
 450                 /*
 451                  * We do not check if the listen socket still exists
 452                  * and accept the case where the listen socket may be
 453                  * gone by the time we resend the SYN/ACK.  We do
 454                  * not expect this to happens often. If it does,
 455                  * then the RST will be sent by the time the remote
 456                  * host does the SYN/ACK->ACK.
 457                  */
 458                 if (TSTMP_GT(sc->sc_rxttime, tick)) {
 459                         if (TSTMP_LT(sc->sc_rxttime, sch->sch_nextc))
 460                                 sch->sch_nextc = sc->sc_rxttime;
 461                         continue;
 462                 }
 463                 if (sc->sc_rxmits > V_tcp_syncache.rexmt_limit) {
 464                         if ((s = tcp_log_addrs(&sc->sc_inc, NULL, NULL, NULL))) {
 465                                 log(LOG_DEBUG, "%s; %s: Retransmits exhausted, "
 466                                     "giving up and removing syncache entry\n",
 467                                     s, __func__);
 468                                 free(s, M_TCPLOG);
 469                         }
 470                         syncache_drop(sc, sch);
 471                         TCPSTAT_INC(tcps_sc_stale);
 472                         continue;
 473                 }
 474                 if ((s = tcp_log_addrs(&sc->sc_inc, NULL, NULL, NULL))) {
 475                         log(LOG_DEBUG, "%s; %s: Response timeout, "
 476                             "retransmitting (%u) SYN|ACK\n",
 477                             s, __func__, sc->sc_rxmits);
 478                         free(s, M_TCPLOG);
 479                 }
 480
 481                 (void) syncache_respond(sc);
 482                 TCPSTAT_INC(tcps_sc_retransmitted);
 483                 syncache_timeout(sc, sch, 0);
 484         }
 485         if (!TAILQ_EMPTY(&(sch)->sch_bucket))
 486                 callout_reset(&(sch)->sch_timer, (sch)->sch_nextc - tick,
 487                         syncache_timer, (void *)(sch));
 488         CURVNET_RESTORE();
 489 }
 490
 491 /*
 492  * Find an entry in the syncache.
 493  * Returns always with locked syncache_head plus a matching entry or NULL.
 494  */
 495 struct syncache *
 496 syncache_lookup(struct in_conninfo *inc, struct syncache_head **schp)
 497 {
 498         struct syncache *sc;
 499         struct syncache_head *sch;
 500
 501 #ifdef INET6
 502         if (inc->inc_flags & INC_ISIPV6) {
 503                 sch = &V_tcp_syncache.hashbase[
 504                     SYNCACHE_HASH6(inc, V_tcp_syncache.hashmask)];
 505                 *schp = sch;
 506
 507                 SCH_LOCK(sch);
 508
 509                 /* Circle through bucket row to find matching entry. */
 510                 TAILQ_FOREACH(sc, &sch->sch_bucket, sc_hash) {
 511                         if (ENDPTS6_EQ(&inc->inc_ie, &sc->sc_inc.inc_ie))
 512                                 return (sc);
 513                 }
 514         } else
 515 #endif
 516         {
 517                 sch = &V_tcp_syncache.hashbase[
 518                     SYNCACHE_HASH(inc, V_tcp_syncache.hashmask)];
 519                 *schp = sch;
 520
 521                 SCH_LOCK(sch);
 522
 523                 /* Circle through bucket row to find matching entry. */
 524                 TAILQ_FOREACH(sc, &sch->sch_bucket, sc_hash) {
 525 #ifdef INET6
 526                         if (sc->sc_inc.inc_flags & INC_ISIPV6)
 527                                 continue;
 528 #endif
 529                         if (ENDPTS_EQ(&inc->inc_ie, &sc->sc_inc.inc_ie))
 530                                 return (sc);
 531                 }
 532         }
 533         SCH_LOCK_ASSERT(*schp);
 534         return (NULL);                  /* always returns with locked sch */
 535 }
 536
 537 /*
 538  * This function is called when we get a RST for a
 539  * non-existent connection, so that we can see if the
 540  * connection is in the syn cache.  If it is, zap it.
 541  */
 542 void
 543 syncache_chkrst(struct in_conninfo *inc, struct tcphdr *th)
 544 {
 545         struct syncache *sc;
 546         struct syncache_head *sch;
 547         char *s = NULL;
 548
 549         sc = syncache_lookup(inc, &sch);        /* returns locked sch */
 550         SCH_LOCK_ASSERT(sch);
 551
 552         /*
 553          * Any RST to our SYN|ACK must not carry ACK, SYN or FIN flags.
 554          * See RFC 793 page 65, section SEGMENT ARRIVES.
 555          */
 556         if (th->th_flags & (TH_ACK|TH_SYN|TH_FIN)) {
 557                 if ((s = tcp_log_addrs(inc, th, NULL, NULL)))
 558                         log(LOG_DEBUG, "%s; %s: Spurious RST with ACK, SYN or "
 559                             "FIN flag set, segment ignored\n", s, __func__);
 560                 TCPSTAT_INC(tcps_badrst);
 561                 goto done;
 562         }
 563
 564         /*
 565          * No corresponding connection was found in syncache.
 566          * If syncookies are enabled and possibly exclusively
 567          * used, or we are under memory pressure, a valid RST
 568          * may not find a syncache entry.  In that case we're
 569          * done and no SYN|ACK retransmissions will happen.
 570          * Otherwise the RST was misdirected or spoofed.
 571          */
 572         if (sc == NULL) {
 573                 if ((s = tcp_log_addrs(inc, th, NULL, NULL)))
 574                         log(LOG_DEBUG, "%s; %s: Spurious RST without matching "
 575                             "syncache entry (possibly syncookie only), "
 576                             "segment ignored\n", s, __func__);
 577                 TCPSTAT_INC(tcps_badrst);
 578                 goto done;
 579         }
 580
 581         /*
 582          * If the RST bit is set, check the sequence number to see
 583          * if this is a valid reset segment.
 584          * RFC 793 page 37:
 585          *   In all states except SYN-SENT, all reset (RST) segments
 586          *   are validated by checking their SEQ-fields.  A reset is
 587          *   valid if its sequence number is in the window.
 588          *
 589          *   The sequence number in the reset segment is normally an
 590          *   echo of our outgoing acknowlegement numbers, but some hosts
 591          *   send a reset with the sequence number at the rightmost edge
 592          *   of our receive window, and we have to handle this case.
 593          */
 594         if (SEQ_GEQ(th->th_seq, sc->sc_irs) &&
 595             SEQ_LEQ(th->th_seq, sc->sc_irs + sc->sc_wnd)) {
 596                 syncache_drop(sc, sch);
 597                 if ((s = tcp_log_addrs(inc, th, NULL, NULL)))
 598                         log(LOG_DEBUG, "%s; %s: Our SYN|ACK was rejected, "
 599                             "connection attempt aborted by remote endpoint\n",
 600                             s, __func__);
 601                 TCPSTAT_INC(tcps_sc_reset);
 602         } else {
 603                 if ((s = tcp_log_addrs(inc, th, NULL, NULL)))
 604                         log(LOG_DEBUG, "%s; %s: RST with invalid SEQ %u != "
 605                             "IRS %u (+WND %u), segment ignored\n",
 606                             s, __func__, th->th_seq, sc->sc_irs, sc->sc_wnd);
 607                 TCPSTAT_INC(tcps_badrst);
 608         }
 609
 610 done:
 611         if (s != NULL)
 612                 free(s, M_TCPLOG);
 613         SCH_UNLOCK(sch);
 614 }
 615
 616 void
 617 syncache_badack(struct in_conninfo *inc)
 618 {
 619         struct syncache *sc;
 620         struct syncache_head *sch;
 621
 622         sc = syncache_lookup(inc, &sch);        /* returns locked sch */
 623         SCH_LOCK_ASSERT(sch);
 624         if (sc != NULL) {
 625                 syncache_drop(sc, sch);
 626                 TCPSTAT_INC(tcps_sc_badack);
 627         }
 628         SCH_UNLOCK(sch);
 629 }
 630
 631 void
 632 syncache_unreach(struct in_conninfo *inc, struct tcphdr *th)
 633 {
 634         struct syncache *sc;
 635         struct syncache_head *sch;
 636
 637         sc = syncache_lookup(inc, &sch);        /* returns locked sch */
 638         SCH_LOCK_ASSERT(sch);
 639         if (sc == NULL)
 640                 goto done;
 641
 642         /* If the sequence number != sc_iss, then it's a bogus ICMP msg */
 643         if (ntohl(th->th_seq) != sc->sc_iss)
 644                 goto done;
 645
 646         /*
 647          * If we've rertransmitted 3 times and this is our second error,
 648          * we remove the entry.  Otherwise, we allow it to continue on.
 649          * This prevents us from incorrectly nuking an entry during a
 650          * spurious network outage.
 651          *
 652          * See tcp_notify().
 653          */
 654         if ((sc->sc_flags & SCF_UNREACH) == 0 || sc->sc_rxmits < 3 + 1) {
 655                 sc->sc_flags |= SCF_UNREACH;
 656                 goto done;
 657         }
 658         syncache_drop(sc, sch);
 659         TCPSTAT_INC(tcps_sc_unreach);
 660 done:
 661         SCH_UNLOCK(sch);
 662 }
 663
 664 /*
 665  * Build a new TCP socket structure from a syncache entry.
 666  */
 667 static struct socket *
 668 syncache_socket(struct syncache *sc, struct socket *lso, struct mbuf *m)
 669 {
 670         struct inpcb *inp = NULL;
 671         struct socket *so;
 672         struct tcpcb *tp;
 673         int error;
 674         char *s;
 675
 676         INP_INFO_WLOCK_ASSERT(&V_tcbinfo);
 677
 678         /*
 679          * Ok, create the full blown connection, and set things up
 680          * as they would have been set up if we had created the
 681          * connection when the SYN arrived.  If we can't create
 682          * the connection, abort it.
 683          */
 684         so = sonewconn(lso, SS_ISCONNECTED);
 685         if (so == NULL) {
 686                 /*
 687                  * Drop the connection; we will either send a RST or
 688                  * have the peer retransmit its SYN again after its
 689                  * RTO and try again.
 690                  */
 691                 TCPSTAT_INC(tcps_listendrop);
 692                 if ((s = tcp_log_addrs(&sc->sc_inc, NULL, NULL, NULL))) {
 693                         log(LOG_DEBUG, "%s; %s: Socket create failed "
 694                             "due to limits or memory shortage\n",
 695                             s, __func__);
 696                         free(s, M_TCPLOG);
 697                 }
 698                 goto abort2;
 699         }
 700 #ifdef MAC
 701         mac_socketpeer_set_from_mbuf(m, so);
 702 #endif
 703
 704         inp = sotoinpcb(so);
 705         inp->inp_inc.inc_fibnum = so->so_fibnum;
 706         INP_WLOCK(inp);
 707         INP_HASH_WLOCK(&V_tcbinfo);
 708
 709         /* Insert new socket into PCB hash list. */
 710         inp->inp_inc.inc_flags = sc->sc_inc.inc_flags;
 711 #ifdef INET6
 712         if (sc->sc_inc.inc_flags & INC_ISIPV6) {
 713                 inp->in6p_laddr = sc->sc_inc.inc6_laddr;
 714         } else {
 715                 inp->inp_vflag &= ~INP_IPV6;
 716                 inp->inp_vflag |= INP_IPV4;
 717 #endif
 718                 inp->inp_laddr = sc->sc_inc.inc_laddr;
 719 #ifdef INET6
 720         }
 721 #endif
 722
 723         /*
 724          * If there's an mbuf and it has a flowid, then let's initialise the
 725          * inp with that particular flowid.
 726          */
 727         if (m != NULL && m->m_flags & M_FLOWID) {
 728                 inp->inp_flags |= INP_HW_FLOWID;
 729                 inp->inp_flags &= ~INP_SW_FLOWID;
 730                 inp->inp_flowid = m->m_pkthdr.flowid;
 731         }
 732
 733         /*
 734          * Install in the reservation hash table for now, but don't yet
 735          * install a connection group since the full 4-tuple isn't yet
 736          * configured.
 737          */
 738         inp->inp_lport = sc->sc_inc.inc_lport;
 739         if ((error = in_pcbinshash_nopcbgroup(inp)) != 0) {
 740                 /*
 741                  * Undo the assignments above if we failed to
 742                  * put the PCB on the hash lists.
 743                  */
 744 #ifdef INET6
 745                 if (sc->sc_inc.inc_flags & INC_ISIPV6)
 746                         inp->in6p_laddr = in6addr_any;
 747                 else
 748 #endif
 749                         inp->inp_laddr.s_addr = INADDR_ANY;
 750                 inp->inp_lport = 0;
 751                 if ((s = tcp_log_addrs(&sc->sc_inc, NULL, NULL, NULL))) {
 752                         log(LOG_DEBUG, "%s; %s: in_pcbinshash failed "
 753                             "with error %i\n",
 754                             s, __func__, error);
 755                         free(s, M_TCPLOG);
 756                 }
 757                 INP_HASH_WUNLOCK(&V_tcbinfo);
 758                 goto abort;
 759         }
 760 #ifdef IPSEC
 761         /* Copy old policy into new socket's. */
 762         if (ipsec_copy_policy(sotoinpcb(lso)->inp_sp, inp->inp_sp))
 763                 printf("syncache_socket: could not copy policy\n");
 764 #endif
 765 #ifdef INET6
 766         if (sc->sc_inc.inc_flags & INC_ISIPV6) {
 767                 struct inpcb *oinp = sotoinpcb(lso);
 768                 struct in6_addr laddr6;
 769                 struct sockaddr_in6 sin6;
 770                 /*
 771                  * Inherit socket options from the listening socket.
 772                  * Note that in6p_inputopts are not (and should not be)
 773                  * copied, since it stores previously received options and is
 774                  * used to detect if each new option is different than the
 775                  * previous one and hence should be passed to a user.
 776                  * If we copied in6p_inputopts, a user would not be able to
 777                  * receive options just after calling the accept system call.
 778                  */
 779                 inp->inp_flags |= oinp->inp_flags & INP_CONTROLOPTS;
 780                 if (oinp->in6p_outputopts)
 781                         inp->in6p_outputopts =
 782                             ip6_copypktopts(oinp->in6p_outputopts, M_NOWAIT);
 783
 784                 sin6.sin6_family = AF_INET6;
 785                 sin6.sin6_len = sizeof(sin6);
 786                 sin6.sin6_addr = sc->sc_inc.inc6_faddr;
 787                 sin6.sin6_port = sc->sc_inc.inc_fport;
 788                 sin6.sin6_flowinfo = sin6.sin6_scope_id = 0;
 789                 laddr6 = inp->in6p_laddr;
 790                 if (IN6_IS_ADDR_UNSPECIFIED(&inp->in6p_laddr))
 791                         inp->in6p_laddr = sc->sc_inc.inc6_laddr;
 792                 if ((error = in6_pcbconnect_mbuf(inp, (struct sockaddr *)&sin6,
 793                     thread0.td_ucred, m)) != 0) {
 794                         inp->in6p_laddr = laddr6;
 795                         if ((s = tcp_log_addrs(&sc->sc_inc, NULL, NULL, NULL))) {
 796                                 log(LOG_DEBUG, "%s; %s: in6_pcbconnect failed "
 797                                     "with error %i\n",
 798                                     s, __func__, error);
 799                                 free(s, M_TCPLOG);
 800                         }
 801                         INP_HASH_WUNLOCK(&V_tcbinfo);
 802                         goto abort;
 803                 }
 804                 /* Override flowlabel from in6_pcbconnect. */
 805                 inp->inp_flow &= ~IPV6_FLOWLABEL_MASK;
 806                 inp->inp_flow |= sc->sc_flowlabel;
 807         }
 808 #endif /* INET6 */
 809 #if defined(INET) && defined(INET6)
 810         else
 811 #endif
 812 #ifdef INET
 813         {
 814                 struct in_addr laddr;
 815                 struct sockaddr_in sin;
 816
 817                 inp->inp_options = (m) ? ip_srcroute(m) : NULL;
 818
 819                 if (inp->inp_options == NULL) {
 820                         inp->inp_options = sc->sc_ipopts;
 821                         sc->sc_ipopts = NULL;
 822                 }
 823
 824                 sin.sin_family = AF_INET;
 825                 sin.sin_len = sizeof(sin);
 826                 sin.sin_addr = sc->sc_inc.inc_faddr;
 827                 sin.sin_port = sc->sc_inc.inc_fport;
 828                 bzero((caddr_t)sin.sin_zero, sizeof(sin.sin_zero));
 829                 laddr = inp->inp_laddr;
 830                 if (inp->inp_laddr.s_addr == INADDR_ANY)
 831                         inp->inp_laddr = sc->sc_inc.inc_laddr;
 832                 if ((error = in_pcbconnect_mbuf(inp, (struct sockaddr *)&sin,
 833                     thread0.td_ucred, m)) != 0) {
 834                         inp->inp_laddr = laddr;
 835                         if ((s = tcp_log_addrs(&sc->sc_inc, NULL, NULL, NULL))) {
 836                                 log(LOG_DEBUG, "%s; %s: in_pcbconnect failed "
 837                                     "with error %i\n",
 838                                     s, __func__, error);
 839                                 free(s, M_TCPLOG);
 840                         }
 841                         INP_HASH_WUNLOCK(&V_tcbinfo);
 842                         goto abort;
 843                 }
 844         }
 845 #endif /* INET */
 846         INP_HASH_WUNLOCK(&V_tcbinfo);
 847         tp = intotcpcb(inp);
 848         tcp_state_change(tp, TCPS_SYN_RECEIVED);
 849         tp->iss = sc->sc_iss;
 850         tp->irs = sc->sc_irs;
 851         tcp_rcvseqinit(tp);
 852         tcp_sendseqinit(tp);
 853         tp->snd_wl1 = sc->sc_irs;
 854         tp->snd_max = tp->iss + 1;
 855         tp->snd_nxt = tp->iss + 1;
 856         tp->rcv_up = sc->sc_irs + 1;
 857         tp->rcv_wnd = sc->sc_wnd;
 858         tp->rcv_adv += tp->rcv_wnd;
 859         tp->last_ack_sent = tp->rcv_nxt;
 860
 861         tp->t_flags = sototcpcb(lso)->t_flags & (TF_NOPUSH|TF_NODELAY);
 862         if (sc->sc_flags & SCF_NOOPT)
 863                 tp->t_flags |= TF_NOOPT;
 864         else {
 865                 if (sc->sc_flags & SCF_WINSCALE) {
 866                         tp->t_flags |= TF_REQ_SCALE|TF_RCVD_SCALE;
 867                         tp->snd_scale = sc->sc_requested_s_scale;
 868                         tp->request_r_scale = sc->sc_requested_r_scale;
 869                 }
 870                 if (sc->sc_flags & SCF_TIMESTAMP) {
 871                         tp->t_flags |= TF_REQ_TSTMP|TF_RCVD_TSTMP;
 872                         tp->ts_recent = sc->sc_tsreflect;
 873                         tp->ts_recent_age = tcp_ts_getticks();
 874                         tp->ts_offset = sc->sc_tsoff;
 875                 }
 876 #ifdef TCP_SIGNATURE
 877                 if (sc->sc_flags & SCF_SIGNATURE)
 878                         tp->t_flags |= TF_SIGNATURE;
 879 #endif
 880                 if (sc->sc_flags & SCF_SACK)
 881                         tp->t_flags |= TF_SACK_PERMIT;
 882         }
 883
 884         if (sc->sc_flags & SCF_ECN)
 885                 tp->t_flags |= TF_ECN_PERMIT;
 886
 887         /*
 888          * Set up MSS and get cached values from tcp_hostcache.
 889          * This might overwrite some of the defaults we just set.
 890          */
 891         tcp_mss(tp, sc->sc_peer_mss);
 892
 893         /*
 894          * If the SYN,ACK was retransmitted, indicate that CWND to be
 895          * limited to one segment in cc_conn_init().
 896          * NB: sc_rxmits counts all SYN,ACK transmits, not just retransmits.
 897          */
 898         if (sc->sc_rxmits > 1)
 899                 tp->snd_cwnd = 1;
 900
 901 #ifdef TCP_OFFLOAD
 902         /*
 903          * Allow a TOE driver to install its hooks.  Note that we hold the
 904          * pcbinfo lock too and that prevents tcp_usr_accept from accepting a
 905          * new connection before the TOE driver has done its thing.
 906          */
 907         if (ADDED_BY_TOE(sc)) {
 908                 struct toedev *tod = sc->sc_tod;
 909
 910                 tod->tod_offload_socket(tod, sc->sc_todctx, so);
 911         }
 912 #endif
 913         /*
 914          * Copy and activate timers.
 915          */
 916         tp->t_keepinit = sototcpcb(lso)->t_keepinit;
 917         tp->t_keepidle = sototcpcb(lso)->t_keepidle;
 918         tp->t_keepintvl = sototcpcb(lso)->t_keepintvl;
 919         tp->t_keepcnt = sototcpcb(lso)->t_keepcnt;
 920         tcp_timer_activate(tp, TT_KEEP, TP_KEEPINIT(tp));
 921
 922         INP_WUNLOCK(inp);
 923
 924         TCPSTAT_INC(tcps_accepts);
 925         return (so);
 926
 927 abort:
 928         INP_WUNLOCK(inp);
 929 abort2:
 930         if (so != NULL)
 931                 soabort(so);
 932         return (NULL);
 933 }
 934
 935 /*
 936  * This function gets called when we receive an ACK for a
 937  * socket in the LISTEN state.  We look up the connection
 938  * in the syncache, and if its there, we pull it out of
 939  * the cache and turn it into a full-blown connection in
 940  * the SYN-RECEIVED state.
 941  */
 942 int
 943 syncache_expand(struct in_conninfo *inc, struct tcpopt *to, struct tcphdr *th,
 944     struct socket **lsop, struct mbuf *m)
 945 {
 946         struct syncache *sc;
 947         struct syncache_head *sch;
 948         struct syncache scs;
 949         char *s;
 950
 951         /*
 952          * Global TCP locks are held because we manipulate the PCB lists
 953          * and create a new socket.
 954          */
 955         INP_INFO_WLOCK_ASSERT(&V_tcbinfo);
 956         KASSERT((th->th_flags & (TH_RST|TH_ACK|TH_SYN)) == TH_ACK,
 957             ("%s: can handle only ACK", __func__));
 958
 959         sc = syncache_lookup(inc, &sch);        /* returns locked sch */
 960         SCH_LOCK_ASSERT(sch);
 961
 962 #ifdef INVARIANTS
 963         /*
 964          * Test code for syncookies comparing the syncache stored
 965          * values with the reconstructed values from the cookie.
 966          */
 967         if (sc != NULL)
 968                 syncookie_cmp(inc, sch, sc, th, to, *lsop);
 969 #endif
 970
 971         if (sc == NULL) {
 972                 /*
 973                  * There is no syncache entry, so see if this ACK is
 974                  * a returning syncookie.  To do this, first:
 975                  *  A. See if this socket has had a syncache entry dropped in
 976                  *     the past.  We don't want to accept a bogus syncookie
 977                  *     if we've never received a SYN.
 978                  *  B. check that the syncookie is valid.  If it is, then
 979                  *     cobble up a fake syncache entry, and return.
 980                  */
 981                 if (!V_tcp_syncookies) {
 982                         SCH_UNLOCK(sch);
 983                         if ((s = tcp_log_addrs(inc, th, NULL, NULL)))
 984                                 log(LOG_DEBUG, "%s; %s: Spurious ACK, "
 985                                     "segment rejected (syncookies disabled)\n",
 986                                     s, __func__);
 987                         goto failed;
 988                 }
 989                 bzero(&scs, sizeof(scs));
 990                 sc = syncookie_lookup(inc, sch, &scs, th, to, *lsop);
 991                 SCH_UNLOCK(sch);
 992                 if (sc == NULL) {
 993                         if ((s = tcp_log_addrs(inc, th, NULL, NULL)))
 994                                 log(LOG_DEBUG, "%s; %s: Segment failed "
 995                                     "SYNCOOKIE authentication, segment rejected "
 996                                     "(probably spoofed)\n", s, __func__);
 997                         goto failed;
 998                 }
 999         } else {
1000                 /* Pull out the entry to unlock the bucket row. */
1001                 TAILQ_REMOVE(&sch->sch_bucket, sc, sc_hash);
1002                 sch->sch_length--;
1003 #ifdef TCP_OFFLOAD
1004                 if (ADDED_BY_TOE(sc)) {
1005                         struct toedev *tod = sc->sc_tod;
1006
1007                         tod->tod_syncache_removed(tod, sc->sc_todctx);
1008                 }
1009 #endif
1010                 SCH_UNLOCK(sch);
1011         }
1012
1013         /*
1014          * Segment validation:
1015          * ACK must match our initial sequence number + 1 (the SYN|ACK).
1016          */
1017         if (th->th_ack != sc->sc_iss + 1) {
1018                 if ((s = tcp_log_addrs(inc, th, NULL, NULL)))
1019                         log(LOG_DEBUG, "%s; %s: ACK %u != ISS+1 %u, segment "
1020                             "rejected\n", s, __func__, th->th_ack, sc->sc_iss);
1021                 goto failed;
1022         }
1023
1024         /*
1025          * The SEQ must fall in the window starting at the received
1026          * initial receive sequence number + 1 (the SYN).
1027          */
1028         if (SEQ_LEQ(th->th_seq, sc->sc_irs) ||
1029             SEQ_GT(th->th_seq, sc->sc_irs + sc->sc_wnd)) {
1030                 if ((s = tcp_log_addrs(inc, th, NULL, NULL)))
1031                         log(LOG_DEBUG, "%s; %s: SEQ %u != IRS+1 %u, segment "
1032                             "rejected\n", s, __func__, th->th_seq, sc->sc_irs);
1033                 goto failed;
1034         }
1035
1036         /*
1037          * If timestamps were not negotiated during SYN/ACK they
1038          * must not appear on any segment during this session.
1039          */
1040         if (!(sc->sc_flags & SCF_TIMESTAMP) && (to->to_flags & TOF_TS)) {
1041                 if ((s = tcp_log_addrs(inc, th, NULL, NULL)))
1042                         log(LOG_DEBUG, "%s; %s: Timestamp not expected, "
1043                             "segment rejected\n", s, __func__);
1044                 goto failed;
1045         }
1046
1047         /*
1048          * If timestamps were negotiated during SYN/ACK they should
1049          * appear on every segment during this session.
1050          * XXXAO: This is only informal as there have been unverified
1051          * reports of non-compliants stacks.
1052          */
1053         if ((sc->sc_flags & SCF_TIMESTAMP) && !(to->to_flags & TOF_TS)) {
1054                 if ((s = tcp_log_addrs(inc, th, NULL, NULL))) {
1055                         log(LOG_DEBUG, "%s; %s: Timestamp missing, "
1056                             "no action\n", s, __func__);
1057                         free(s, M_TCPLOG);
1058                         s = NULL;
1059                 }
1060         }
1061
1062         /*
1063          * If timestamps were negotiated the reflected timestamp
1064          * must be equal to what we actually sent in the SYN|ACK.
1065          */
1066         if ((to->to_flags & TOF_TS) && to->to_tsecr != sc->sc_ts) {
1067                 if ((s = tcp_log_addrs(inc, th, NULL, NULL)))
1068                         log(LOG_DEBUG, "%s; %s: TSECR %u != TS %u, "
1069                             "segment rejected\n",
1070                             s, __func__, to->to_tsecr, sc->sc_ts);
1071                 goto failed;
1072         }
1073
1074         *lsop = syncache_socket(sc, *lsop, m);
1075
1076         if (*lsop == NULL)
1077                 TCPSTAT_INC(tcps_sc_aborted);
1078         else
1079                 TCPSTAT_INC(tcps_sc_completed);
1080
1081 /* how do we find the inp for the new socket? */
1082         if (sc != &scs)
1083                 syncache_free(sc);
1084         return (1);
1085 failed:
1086         if (sc != NULL && sc != &scs)
1087                 syncache_free(sc);
1088         if (s != NULL)
1089                 free(s, M_TCPLOG);
1090         *lsop = NULL;
1091         return (0);
1092 }
1093
1094 /*
1095  * Given a LISTEN socket and an inbound SYN request, add
1096  * this to the syn cache, and send back a segment:
1097  *      <SEQ=ISS><ACK=RCV_NXT><CTL=SYN,ACK>
1098  * to the source.
1099  *
1100  * IMPORTANT NOTE: We do _NOT_ ACK data that might accompany the SYN.
1101  * Doing so would require that we hold onto the data and deliver it
1102  * to the application.  However, if we are the target of a SYN-flood
1103  * DoS attack, an attacker could send data which would eventually
1104  * consume all available buffer space if it were ACKed.  By not ACKing
1105  * the data, we avoid this DoS scenario.
1106  */
1107 void
1108 syncache_add(struct in_conninfo *inc, struct tcpopt *to, struct tcphdr *th,
1109     struct inpcb *inp, struct socket **lsop, struct mbuf *m, void *tod,
1110     void *todctx)
1111 {
1112         struct tcpcb *tp;
1113         struct socket *so;
1114         struct syncache *sc = NULL;
1115         struct syncache_head *sch;
1116         struct mbuf *ipopts = NULL;
1117         u_int ltflags;
1118         int win, sb_hiwat, ip_ttl, ip_tos;
1119         char *s;
1120 #ifdef INET6
1121         int autoflowlabel = 0;
1122 #endif
1123 #ifdef MAC
1124         struct label *maclabel;
1125 #endif
1126         struct syncache scs;
1127         struct ucred *cred;
1128
1129         INP_INFO_WLOCK_ASSERT(&V_tcbinfo);
1130         INP_WLOCK_ASSERT(inp);                  /* listen socket */
1131         KASSERT((th->th_flags & (TH_RST|TH_ACK|TH_SYN)) == TH_SYN,
1132             ("%s: unexpected tcp flags", __func__));
1133
1134         /*
1135          * Combine all so/tp operations very early to drop the INP lock as
1136          * soon as possible.
1137          */
1138         so = *lsop;
1139         tp = sototcpcb(so);
1140         cred = crhold(so->so_cred);
1141
1142 #ifdef INET6
1143         if ((inc->inc_flags & INC_ISIPV6) &&
1144             (inp->inp_flags & IN6P_AUTOFLOWLABEL))
1145                 autoflowlabel = 1;
1146 #endif
1147         ip_ttl = inp->inp_ip_ttl;
1148         ip_tos = inp->inp_ip_tos;
1149         win = sbspace(&so->so_rcv);
1150         sb_hiwat = so->so_rcv.sb_hiwat;
1151         ltflags = (tp->t_flags & (TF_NOOPT | TF_SIGNATURE));
1152
1153         /* By the time we drop the lock these should no longer be used. */
1154         so = NULL;
1155         tp = NULL;
1156
1157 #ifdef MAC
1158         if (mac_syncache_init(&maclabel) != 0) {
1159                 INP_WUNLOCK(inp);
1160                 INP_INFO_WUNLOCK(&V_tcbinfo);
1161                 goto done;
1162         } else
1163                 mac_syncache_create(maclabel, inp);
1164 #endif
1165         INP_WUNLOCK(inp);
1166         INP_INFO_WUNLOCK(&V_tcbinfo);
1167
1168         /*
1169          * Remember the IP options, if any.
1170          */
1171 #ifdef INET6
1172         if (!(inc->inc_flags & INC_ISIPV6))
1173 #endif
1174 #ifdef INET
1175                 ipopts = (m) ? ip_srcroute(m) : NULL;
1176 #else
1177                 ipopts = NULL;
1178 #endif
1179
1180         /*
1181          * See if we already have an entry for this connection.
1182          * If we do, resend the SYN,ACK, and reset the retransmit timer.
1183          *
1184          * XXX: should the syncache be re-initialized with the contents
1185          * of the new SYN here (which may have different options?)
1186          *
1187          * XXX: We do not check the sequence number to see if this is a
1188          * real retransmit or a new connection attempt.  The question is
1189          * how to handle such a case; either ignore it as spoofed, or
1190          * drop the current entry and create a new one?
1191          */
1192         sc = syncache_lookup(inc, &sch);        /* returns locked entry */
1193         SCH_LOCK_ASSERT(sch);
1194         if (sc != NULL) {
1195                 TCPSTAT_INC(tcps_sc_dupsyn);
1196                 if (ipopts) {
1197                         /*
1198                          * If we were remembering a previous source route,
1199                          * forget it and use the new one we've been given.
1200                          */
1201                         if (sc->sc_ipopts)
1202                                 (void) m_free(sc->sc_ipopts);
1203                         sc->sc_ipopts = ipopts;
1204                 }
1205                 /*
1206                  * Update timestamp if present.
1207                  */
1208                 if ((sc->sc_flags & SCF_TIMESTAMP) && (to->to_flags & TOF_TS))
1209                         sc->sc_tsreflect = to->to_tsval;
1210                 else
1211                         sc->sc_flags &= ~SCF_TIMESTAMP;
1212 #ifdef MAC
1213                 /*
1214                  * Since we have already unconditionally allocated label
1215                  * storage, free it up.  The syncache entry will already
1216                  * have an initialized label we can use.
1217                  */
1218                 mac_syncache_destroy(&maclabel);
1219 #endif
1220                 /* Retransmit SYN|ACK and reset retransmit count. */
1221                 if ((s = tcp_log_addrs(&sc->sc_inc, th, NULL, NULL))) {
1222                         log(LOG_DEBUG, "%s; %s: Received duplicate SYN, "
1223                             "resetting timer and retransmitting SYN|ACK\n",
1224                             s, __func__);
1225                         free(s, M_TCPLOG);
1226                 }
1227                 if (syncache_respond(sc) == 0) {
1228                         sc->sc_rxmits = 0;
1229                         syncache_timeout(sc, sch, 1);
1230                         TCPSTAT_INC(tcps_sndacks);
1231                         TCPSTAT_INC(tcps_sndtotal);
1232                 }
1233                 SCH_UNLOCK(sch);
1234                 goto done;
1235         }
1236
1237         sc = uma_zalloc(V_tcp_syncache.zone, M_NOWAIT | M_ZERO);
1238         if (sc == NULL) {
1239                 /*
1240                  * The zone allocator couldn't provide more entries.
1241                  * Treat this as if the cache was full; drop the oldest
1242                  * entry and insert the new one.
1243                  */
1244                 TCPSTAT_INC(tcps_sc_zonefail);
1245                 if ((sc = TAILQ_LAST(&sch->sch_bucket, sch_head)) != NULL)
1246                         syncache_drop(sc, sch);
1247                 sc = uma_zalloc(V_tcp_syncache.zone, M_NOWAIT | M_ZERO);
1248                 if (sc == NULL) {
1249                         if (V_tcp_syncookies) {
1250                                 bzero(&scs, sizeof(scs));
1251                                 sc = &scs;
1252                         } else {
1253                                 SCH_UNLOCK(sch);
1254                                 if (ipopts)
1255                                         (void) m_free(ipopts);
1256                                 goto done;
1257                         }
1258                 }
1259         }
1260
1261         /*
1262          * Fill in the syncache values.
1263          */
1264 #ifdef MAC
1265         sc->sc_label = maclabel;
1266 #endif
1267         sc->sc_cred = cred;
1268         cred = NULL;
1269         sc->sc_ipopts = ipopts;
1270         bcopy(inc, &sc->sc_inc, sizeof(struct in_conninfo));
1271 #ifdef INET6
1272         if (!(inc->inc_flags & INC_ISIPV6))
1273 #endif
1274         {
1275                 sc->sc_ip_tos = ip_tos;
1276                 sc->sc_ip_ttl = ip_ttl;
1277         }
1278 #ifdef TCP_OFFLOAD
1279         sc->sc_tod = tod;
1280         sc->sc_todctx = todctx;
1281 #endif
1282         sc->sc_irs = th->th_seq;
1283         sc->sc_iss = arc4random();
1284         sc->sc_flags = 0;
1285         sc->sc_flowlabel = 0;
1286
1287         /*
1288          * Initial receive window: clip sbspace to [0 .. TCP_MAXWIN].
1289          * win was derived from socket earlier in the function.
1290          */
1291         win = imax(win, 0);
1292         win = imin(win, TCP_MAXWIN);
1293         sc->sc_wnd = win;
1294
1295         if (V_tcp_do_rfc1323) {
1296                 /*
1297                  * A timestamp received in a SYN makes
1298                  * it ok to send timestamp requests and replies.
1299                  */
1300                 if (to->to_flags & TOF_TS) {
1301                         sc->sc_tsreflect = to->to_tsval;
1302                         sc->sc_ts = tcp_ts_getticks();
1303                         sc->sc_flags |= SCF_TIMESTAMP;
1304                 }
1305                 if (to->to_flags & TOF_SCALE) {
1306                         int wscale = 0;
1307
1308                         /*
1309                          * Pick the smallest possible scaling factor that
1310                          * will still allow us to scale up to sb_max, aka
1311                          * kern.ipc.maxsockbuf.
1312                          *
1313                          * We do this because there are broken firewalls that
1314                          * will corrupt the window scale option, leading to
1315                          * the other endpoint believing that our advertised
1316                          * window is unscaled.  At scale factors larger than
1317                          * 5 the unscaled window will drop below 1500 bytes,
1318                          * leading to serious problems when traversing these
1319                          * broken firewalls.
1320                          *
1321                          * With the default maxsockbuf of 256K, a scale factor
1322                          * of 3 will be chosen by this algorithm.  Those who
1323                          * choose a larger maxsockbuf should watch out
1324                          * for the compatiblity problems mentioned above.
1325                          *
1326                          * RFC1323: The Window field in a SYN (i.e., a <SYN>
1327                          * or <SYN,ACK>) segment itself is never scaled.
1328                          */
1329                         while (wscale < TCP_MAX_WINSHIFT &&
1330                             (TCP_MAXWIN << wscale) < sb_max)
1331                                 wscale++;
1332                         sc->sc_requested_r_scale = wscale;
1333                         sc->sc_requested_s_scale = to->to_wscale;
1334                         sc->sc_flags |= SCF_WINSCALE;
1335                 }
1336         }
1337 #ifdef TCP_SIGNATURE
1338         /*
1339          * If listening socket requested TCP digests, and received SYN
1340          * contains the option, flag this in the syncache so that
1341          * syncache_respond() will do the right thing with the SYN+ACK.
1342          * XXX: Currently we always record the option by default and will
1343          * attempt to use it in syncache_respond().
1344          */
1345         if (to->to_flags & TOF_SIGNATURE || ltflags & TF_SIGNATURE)
1346                 sc->sc_flags |= SCF_SIGNATURE;
1347 #endif
1348         if (to->to_flags & TOF_SACKPERM)
1349                 sc->sc_flags |= SCF_SACK;
1350         if (to->to_flags & TOF_MSS)
1351                 sc->sc_peer_mss = to->to_mss;   /* peer mss may be zero */
1352         if (ltflags & TF_NOOPT)
1353                 sc->sc_flags |= SCF_NOOPT;
1354         if ((th->th_flags & (TH_ECE|TH_CWR)) && V_tcp_do_ecn)
1355                 sc->sc_flags |= SCF_ECN;
1356
1357         if (V_tcp_syncookies)
1358                 sc->sc_iss = syncookie_generate(sch, sc);
1359 #ifdef INET6
1360         if (autoflowlabel) {
1361                 if (V_tcp_syncookies)
1362                         sc->sc_flowlabel = sc->sc_iss;
1363                 else
1364                         sc->sc_flowlabel = ip6_randomflowlabel();
1365                 sc->sc_flowlabel = htonl(sc->sc_flowlabel) & IPV6_FLOWLABEL_MASK;
1366         }
1367 #endif
1368         SCH_UNLOCK(sch);
1369
1370         /*
1371          * Do a standard 3-way handshake.
1372          */
1373         if (syncache_respond(sc) == 0) {
1374                 if (V_tcp_syncookies && V_tcp_syncookiesonly && sc != &scs)
1375                         syncache_free(sc);
1376                 else if (sc != &scs)
1377                         syncache_insert(sc, sch);   /* locks and unlocks sch */
1378                 TCPSTAT_INC(tcps_sndacks);
1379                 TCPSTAT_INC(tcps_sndtotal);
1380         } else {
1381                 if (sc != &scs)
1382                         syncache_free(sc);
1383                 TCPSTAT_INC(tcps_sc_dropped);
1384         }
1385
1386 done:
1387         if (cred != NULL)
1388                 crfree(cred);
1389 #ifdef MAC
1390         if (sc == &scs)
1391                 mac_syncache_destroy(&maclabel);
1392 #endif
1393         if (m) {
1394
1395                 *lsop = NULL;
1396                 m_freem(m);
1397         }
1398 }
1399
1400 static int
1401 syncache_respond(struct syncache *sc)
1402 {
1403         struct ip *ip = NULL;
1404         struct mbuf *m;
1405         struct tcphdr *th = NULL;
1406         int optlen, error = 0;  /* Make compiler happy */
1407         u_int16_t hlen, tlen, mssopt;
1408         struct tcpopt to;
1409 #ifdef INET6
1410         struct ip6_hdr *ip6 = NULL;
1411 #endif
1412
1413         hlen =
1414 #ifdef INET6
1415                (sc->sc_inc.inc_flags & INC_ISIPV6) ? sizeof(struct ip6_hdr) :
1416 #endif
1417                 sizeof(struct ip);
1418         tlen = hlen + sizeof(struct tcphdr);
1419
1420         /* Determine MSS we advertize to other end of connection. */
1421         mssopt = tcp_mssopt(&sc->sc_inc);
1422         if (sc->sc_peer_mss)
1423                 mssopt = max( min(sc->sc_peer_mss, mssopt), V_tcp_minmss);
1424
1425         /* XXX: Assume that the entire packet will fit in a header mbuf. */
1426         KASSERT(max_linkhdr + tlen + TCP_MAXOLEN <= MHLEN,
1427             ("syncache: mbuf too small"));
1428
1429         /* Create the IP+TCP header from scratch. */
1430         m = m_gethdr(M_NOWAIT, MT_DATA);
1431         if (m == NULL)
1432                 return (ENOBUFS);
1433 #ifdef MAC
1434         mac_syncache_create_mbuf(sc->sc_label, m);
1435 #endif
1436         m->m_data += max_linkhdr;
1437         m->m_len = tlen;
1438         m->m_pkthdr.len = tlen;
1439         m->m_pkthdr.rcvif = NULL;
1440
1441 #ifdef INET6
1442         if (sc->sc_inc.inc_flags & INC_ISIPV6) {
1443                 ip6 = mtod(m, struct ip6_hdr *);
1444                 ip6->ip6_vfc = IPV6_VERSION;
1445                 ip6->ip6_nxt = IPPROTO_TCP;
1446                 ip6->ip6_src = sc->sc_inc.inc6_laddr;
1447                 ip6->ip6_dst = sc->sc_inc.inc6_faddr;
1448                 ip6->ip6_plen = htons(tlen - hlen);
1449                 /* ip6_hlim is set after checksum */
1450                 ip6->ip6_flow &= ~IPV6_FLOWLABEL_MASK;
1451                 ip6->ip6_flow |= sc->sc_flowlabel;
1452
1453                 th = (struct tcphdr *)(ip6 + 1);
1454         }
1455 #endif
1456 #if defined(INET6) && defined(INET)
1457         else
1458 #endif
1459 #ifdef INET
1460         {
1461                 ip = mtod(m, struct ip *);
1462                 ip->ip_v = IPVERSION;
1463                 ip->ip_hl = sizeof(struct ip) >> 2;
1464                 ip->ip_len = htons(tlen);
1465                 ip->ip_id = 0;
1466                 ip->ip_off = 0;
1467                 ip->ip_sum = 0;
1468                 ip->ip_p = IPPROTO_TCP;
1469                 ip->ip_src = sc->sc_inc.inc_laddr;
1470                 ip->ip_dst = sc->sc_inc.inc_faddr;
1471                 ip->ip_ttl = sc->sc_ip_ttl;
1472                 ip->ip_tos = sc->sc_ip_tos;
1473
1474                 /*
1475                  * See if we should do MTU discovery.  Route lookups are
1476                  * expensive, so we will only unset the DF bit if:
1477                  *
1478                  *      1) path_mtu_discovery is disabled
1479                  *      2) the SCF_UNREACH flag has been set
1480                  */
1481                 if (V_path_mtu_discovery && ((sc->sc_flags & SCF_UNREACH) == 0))
1482                        ip->ip_off |= htons(IP_DF);
1483
1484                 th = (struct tcphdr *)(ip + 1);
1485         }
1486 #endif /* INET */
1487         th->th_sport = sc->sc_inc.inc_lport;
1488         th->th_dport = sc->sc_inc.inc_fport;
1489
1490         th->th_seq = htonl(sc->sc_iss);
1491         th->th_ack = htonl(sc->sc_irs + 1);
1492         th->th_off = sizeof(struct tcphdr) >> 2;
1493         th->th_x2 = 0;
1494         th->th_flags = TH_SYN|TH_ACK;
1495         th->th_win = htons(sc->sc_wnd);
1496         th->th_urp = 0;
1497
1498         if (sc->sc_flags & SCF_ECN) {
1499                 th->th_flags |= TH_ECE;
1500                 TCPSTAT_INC(tcps_ecn_shs);
1501         }
1502
1503         /* Tack on the TCP options. */
1504         if ((sc->sc_flags & SCF_NOOPT) == 0) {
1505                 to.to_flags = 0;
1506
1507                 to.to_mss = mssopt;
1508                 to.to_flags = TOF_MSS;
1509                 if (sc->sc_flags & SCF_WINSCALE) {
1510                         to.to_wscale = sc->sc_requested_r_scale;
1511                         to.to_flags |= TOF_SCALE;
1512                 }
1513                 if (sc->sc_flags & SCF_TIMESTAMP) {
1514                         /* Virgin timestamp or TCP cookie enhanced one. */
1515                         to.to_tsval = sc->sc_ts;
1516                         to.to_tsecr = sc->sc_tsreflect;
1517                         to.to_flags |= TOF_TS;
1518                 }
1519                 if (sc->sc_flags & SCF_SACK)
1520                         to.to_flags |= TOF_SACKPERM;
1521 #ifdef TCP_SIGNATURE
1522                 if (sc->sc_flags & SCF_SIGNATURE)
1523                         to.to_flags |= TOF_SIGNATURE;
1524 #endif
1525                 optlen = tcp_addoptions(&to, (u_char *)(th + 1));
1526
1527                 /* Adjust headers by option size. */
1528                 th->th_off = (sizeof(struct tcphdr) + optlen) >> 2;
1529                 m->m_len += optlen;
1530                 m->m_pkthdr.len += optlen;
1531
1532 #ifdef TCP_SIGNATURE
1533                 if (sc->sc_flags & SCF_SIGNATURE)
1534                         tcp_signature_compute(m, 0, 0, optlen,
1535                             to.to_signature, IPSEC_DIR_OUTBOUND);
1536 #endif
1537 #ifdef INET6
1538                 if (sc->sc_inc.inc_flags & INC_ISIPV6)
1539                         ip6->ip6_plen = htons(ntohs(ip6->ip6_plen) + optlen);
1540                 else
1541 #endif
1542                         ip->ip_len = htons(ntohs(ip->ip_len) + optlen);
1543         } else
1544                 optlen = 0;
1545
1546         M_SETFIB(m, sc->sc_inc.inc_fibnum);
1547         m->m_pkthdr.csum_data = offsetof(struct tcphdr, th_sum);
1548 #ifdef INET6
1549         if (sc->sc_inc.inc_flags & INC_ISIPV6) {
1550                 m->m_pkthdr.csum_flags = CSUM_TCP_IPV6;
1551                 th->th_sum = in6_cksum_pseudo(ip6, tlen + optlen - hlen,
1552                     IPPROTO_TCP, 0);
1553                 ip6->ip6_hlim = in6_selecthlim(NULL, NULL);
1554 #ifdef TCP_OFFLOAD
1555                 if (ADDED_BY_TOE(sc)) {
1556                         struct toedev *tod = sc->sc_tod;
1557
1558                         error = tod->tod_syncache_respond(tod, sc->sc_todctx, m);
1559
1560                         return (error);
1561                 }
1562 #endif
1563                 error = ip6_output(m, NULL, NULL, 0, NULL, NULL, NULL);
1564         }
1565 #endif
1566 #if defined(INET6) && defined(INET)
1567         else
1568 #endif
1569 #ifdef INET
1570         {
1571                 m->m_pkthdr.csum_flags = CSUM_TCP;
1572                 th->th_sum = in_pseudo(ip->ip_src.s_addr, ip->ip_dst.s_addr,
1573                     htons(tlen + optlen - hlen + IPPROTO_TCP));
1574 #ifdef TCP_OFFLOAD
1575                 if (ADDED_BY_TOE(sc)) {
1576                         struct toedev *tod = sc->sc_tod;
1577
1578                         error = tod->tod_syncache_respond(tod, sc->sc_todctx, m);
1579
1580                         return (error);
1581                 }
1582 #endif
1583                 error = ip_output(m, sc->sc_ipopts, NULL, 0, NULL, NULL);
1584         }
1585 #endif
1586         return (error);
1587 }
1588
1589 /*
1590  * The purpose of syncookies is to handle spoofed SYN flooding DoS attacks
1591  * that exceed the capacity of the syncache by avoiding the storage of any
1592  * of the SYNs we receive.  Syncookies defend against blind SYN flooding
1593  * attacks where the attacker does not have access to our responses.
1594  *
1595  * Syncookies encode and include all necessary information about the
1596  * connection setup within the SYN|ACK that we send back.  That way we
1597  * can avoid keeping any local state until the ACK to our SYN|ACK returns
1598  * (if ever).  Normally the syncache and syncookies are running in parallel
1599  * with the latter taking over when the former is exhausted.  When matching
1600  * syncache entry is found the syncookie is ignored.
1601  *
1602  * The only reliable information persisting the 3WHS is our inital sequence
1603  * number ISS of 32 bits.  Syncookies embed a cryptographically sufficient
1604  * strong hash (MAC) value and a few bits of TCP SYN options in the ISS
1605  * of our SYN|ACK.  The MAC can be recomputed when the ACK to our SYN|ACK
1606  * returns and signifies a legitimate connection if it matches the ACK.
1607  *
1608  * The available space of 32 bits to store the hash and to encode the SYN
1609  * option information is very tight and we should have at least 24 bits for
1610  * the MAC to keep the number of guesses by blind spoofing reasonably high.
1611  *
1612  * SYN option information we have to encode to fully restore a connection:
1613  * MSS: is imporant to chose an optimal segment size to avoid IP level
1614  *   fragmentation along the path.  The common MSS values can be encoded
1615  *   in a 3-bit table.  Uncommon values are captured by the next lower value
1616  *   in the table leading to a slight increase in packetization overhead.
1617  * WSCALE: is necessary to allow large windows to be used for high delay-
1618  *   bandwidth product links.  Not scaling the window when it was initially
1619  *   negotiated is bad for performance as lack of scaling further decreases
1620  *   the apparent available send window.  We only need to encode the WSCALE
1621  *   we received from the remote end.  Our end can be recalculated at any
1622  *   time.  The common WSCALE values can be encoded in a 3-bit table.
1623  *   Uncommon values are captured by the next lower value in the table
1624  *   making us under-estimate the available window size halving our
1625  *   theoretically possible maximum throughput for that connection.
1626  * SACK: Greatly assists in packet loss recovery and requires 1 bit.
1627  * TIMESTAMP and SIGNATURE is not encoded because they are permanent options
1628  *   that are included in all segments on a connection.  We enable them when
1629  *   the ACK has them.
1630  *
1631  * Security of syncookies and attack vectors:
1632  *
1633  * The MAC is computed over (faddr||laddr||fport||lport||irs||flags||secmod)
1634  * together with the gloabl secret to make it unique per connection attempt.
1635  * Thus any change of any of those parameters results in a different MAC output
1636  * in an unpredictable way unless a collision is encountered.  24 bits of the
1637  * MAC are embedded into the ISS.
1638  *
1639  * To prevent replay attacks two rotating global secrets are updated with a
1640  * new random value every 15 seconds.  The life-time of a syncookie is thus
1641  * 15-30 seconds.
1642  *
1643  * Vector 1: Attacking the secret.  This requires finding a weakness in the
1644  * MAC itself or the way it is used here.  The attacker can do a chosen plain
1645  * text attack by varying and testing the all parameters under his control.
1646  * The strength depends on the size and randomness of the secret, and the
1647  * cryptographic security of the MAC function.  Due to the constant updating
1648  * of the secret the attacker has at most 29.999 seconds to find the secret
1649  * and launch spoofed connections.  After that he has to start all over again.
1650  *
1651  * Vector 2: Collision attack on the MAC of a single ACK.  With a 24 bit MAC
1652  * size an average of 4,823 attempts are required for a 50% chance of success
1653  * to spoof a single syncookie (birthday collision paradox).  However the
1654  * attacker is blind and doesn't know if one of his attempts succeeded unless
1655  * he has a side channel to interfere success from.  A single connection setup
1656  * success average of 90% requires 8,790 packets, 99.99% requires 17,578 packets.
1657  * This many attempts are required for each one blind spoofed connection.  For
1658  * every additional spoofed connection he has to launch another N attempts.
1659  * Thus for a sustained rate 100 spoofed connections per second approximately
1660  * 1,800,000 packets per second would have to be sent.
1661  *
1662  * NB: The MAC function should be fast so that it doesn't become a CPU
1663  * exhaustion attack vector itself.
1664  *
1665  * References:
1666  *  RFC4987 TCP SYN Flooding Attacks and Common Mitigations
1667  *  SYN cookies were first proposed by cryptographer Dan J. Bernstein in 1996
1668  *   http://cr.yp.to/syncookies.html    (overview)
1669  *   http://cr.yp.to/syncookies/archive (details)
1670  *
1671  *
1672  * Schematic construction of a syncookie enabled Initial Sequence Number:
1673  *  0        1         2         3
1674  *  12345678901234567890123456789012
1675  * |xxxxxxxxxxxxxxxxxxxxxxxxWWWMMMSP|
1676  *
1677  *  x 24 MAC (truncated)
1678  *  W  3 Send Window Scale index
1679  *  M  3 MSS index
1680  *  S  1 SACK permitted
1681  *  P  1 Odd/even secret
1682  */
1683
1684 /*
1685  * Distribution and probability of certain MSS values.  Those in between are
1686  * rounded down to the next lower one.
1687  * [An Analysis of TCP Maximum Segment Sizes, S. Alcock and R. Nelson, 2011]
1688  *                            .2%  .3%   5%    7%    7%    20%   15%   45%
1689  */
1690 static int tcp_sc_msstab[] = { 216, 536, 1200, 1360, 1400, 1440, 1452, 1460 };
1691
1692 /*
1693  * Distribution and probability of certain WSCALE values.  We have to map the
1694  * (send) window scale (shift) option with a range of 0-14 from 4 bits into 3
1695  * bits based on prevalence of certain values.  Where we don't have an exact
1696  * match for are rounded down to the next lower one letting us under-estimate
1697  * the true available window.  At the moment this would happen only for the
1698  * very uncommon values 3, 5 and those above 8 (more than 16MB socket buffer
1699  * and window size).  The absence of the WSCALE option (no scaling in either
1700  * direction) is encoded with index zero.
1701  * [WSCALE values histograms, Allman, 2012]
1702  *                            X 10 10 35  5  6 14 10%   by host
1703  *                            X 11  4  5  5 18 49  3%   by connections
1704  */
1705 static int tcp_sc_wstab[] = { 0, 0, 1, 2, 4, 6, 7, 8 };
1706
1707 /*
1708  * Compute the MAC for the SYN cookie.  SIPHASH-2-4 is chosen for its speed
1709  * and good cryptographic properties.
1710  */
1711 static uint32_t
1712 syncookie_mac(struct in_conninfo *inc, tcp_seq irs, uint8_t flags,
1713     uint8_t *secbits, uintptr_t secmod)
1714 {
1715         SIPHASH_CTX ctx;
1716         uint32_t siphash[2];
1717
1718         SipHash24_Init(&ctx);
1719         SipHash_SetKey(&ctx, secbits);
1720         switch (inc->inc_flags & INC_ISIPV6) {
1721 #ifdef INET
1722         case 0:
1723                 SipHash_Update(&ctx, &inc->inc_faddr, sizeof(inc->inc_faddr));
1724                 SipHash_Update(&ctx, &inc->inc_laddr, sizeof(inc->inc_laddr));
1725                 break;
1726 #endif
1727 #ifdef INET6
1728         case INC_ISIPV6:
1729                 SipHash_Update(&ctx, &inc->inc6_faddr, sizeof(inc->inc6_faddr));
1730                 SipHash_Update(&ctx, &inc->inc6_laddr, sizeof(inc->inc6_laddr));
1731                 break;
1732 #endif
1733         }
1734         SipHash_Update(&ctx, &inc->inc_fport, sizeof(inc->inc_fport));
1735         SipHash_Update(&ctx, &inc->inc_lport, sizeof(inc->inc_lport));
1736         SipHash_Update(&ctx, &flags, sizeof(flags));
1737         SipHash_Update(&ctx, &secmod, sizeof(secmod));
1738         SipHash_Final((u_int8_t *)&siphash, &ctx);
1739
1740         return (siphash[0] ^ siphash[1]);
1741 }
1742
1743 static tcp_seq
1744 syncookie_generate(struct syncache_head *sch, struct syncache *sc)
1745 {
1746         u_int i, mss, secbit, wscale;
1747         uint32_t iss, hash;
1748         uint8_t *secbits;
1749         union syncookie cookie;
1750
1751         SCH_LOCK_ASSERT(sch);
1752
1753         cookie.cookie = 0;
1754
1755         /* Map our computed MSS into the 3-bit index. */
1756         mss = min(tcp_mssopt(&sc->sc_inc), max(sc->sc_peer_mss, V_tcp_minmss));
1757         for (i = sizeof(tcp_sc_msstab) / sizeof(*tcp_sc_msstab) - 1;
1758              tcp_sc_msstab[i] > mss && i > 0;
1759              i--)
1760                 ;
1761         cookie.flags.mss_idx = i;
1762
1763         /*
1764          * Map the send window scale into the 3-bit index but only if
1765          * the wscale option was received.
1766          */
1767         if (sc->sc_flags & SCF_WINSCALE) {
1768                 wscale = sc->sc_requested_s_scale;
1769                 for (i = sizeof(tcp_sc_wstab) / sizeof(*tcp_sc_wstab) - 1;
1770                      tcp_sc_wstab[i] > wscale && i > 0;
1771                      i--)
1772                         ;
1773                 cookie.flags.wscale_idx = i;
1774         }
1775
1776         /* Can we do SACK? */
1777         if (sc->sc_flags & SCF_SACK)
1778                 cookie.flags.sack_ok = 1;
1779
1780         /* Which of the two secrets to use. */
1781         secbit = sch->sch_sc->secret.oddeven & 0x1;
1782         cookie.flags.odd_even = secbit;
1783
1784         secbits = sch->sch_sc->secret.key[secbit];
1785         hash = syncookie_mac(&sc->sc_inc, sc->sc_irs, cookie.cookie, secbits,
1786             (uintptr_t)sch);
1787
1788         /*
1789          * Put the flags into the hash and XOR them to get better ISS number
1790          * variance.  This doesn't enhance the cryptographic strength and is
1791          * done to prevent the 8 cookie bits from showing up directly on the
1792          * wire.
1793          */
1794         iss = hash & ~0xff;
1795         iss |= cookie.cookie ^ (hash >> 24);
1796
1797         /* Randomize the timestamp. */
1798         if (sc->sc_flags & SCF_TIMESTAMP) {
1799                 sc->sc_ts = arc4random();
1800                 sc->sc_tsoff = sc->sc_ts - tcp_ts_getticks();
1801         }
1802
1803         TCPSTAT_INC(tcps_sc_sendcookie);
1804         return (iss);
1805 }
1806
1807 static struct syncache *
1808 syncookie_lookup(struct in_conninfo *inc, struct syncache_head *sch,
1809     struct syncache *sc, struct tcphdr *th, struct tcpopt *to,
1810     struct socket *lso)
1811 {
1812         uint32_t hash;
1813         uint8_t *secbits;
1814         tcp_seq ack, seq;
1815         int wnd, wscale = 0;
1816         union syncookie cookie;
1817
1818         SCH_LOCK_ASSERT(sch);
1819
1820         /*
1821          * Pull information out of SYN-ACK/ACK and revert sequence number
1822          * advances.
1823          */
1824         ack = th->th_ack - 1;
1825         seq = th->th_seq - 1;
1826
1827         /*
1828          * Unpack the flags containing enough information to restore the
1829          * connection.
1830          */
1831         cookie.cookie = (ack & 0xff) ^ (ack >> 24);
1832
1833         /* Which of the two secrets to use. */
1834         secbits = sch->sch_sc->secret.key[cookie.flags.odd_even];
1835
1836         hash = syncookie_mac(inc, seq, cookie.cookie, secbits, (uintptr_t)sch);
1837
1838         /* The recomputed hash matches the ACK if this was a genuine cookie. */
1839         if ((ack & ~0xff) != (hash & ~0xff))
1840                 return (NULL);
1841
1842         /* Fill in the syncache values. */
1843         sc->sc_flags = 0;
1844         bcopy(inc, &sc->sc_inc, sizeof(struct in_conninfo));
1845         sc->sc_ipopts = NULL;
1846
1847         sc->sc_irs = seq;
1848         sc->sc_iss = ack;
1849
1850         switch (inc->inc_flags & INC_ISIPV6) {
1851 #ifdef INET
1852         case 0:
1853                 sc->sc_ip_ttl = sotoinpcb(lso)->inp_ip_ttl;
1854                 sc->sc_ip_tos = sotoinpcb(lso)->inp_ip_tos;
1855                 break;
1856 #endif
1857 #ifdef INET6
1858         case INC_ISIPV6:
1859                 if (sotoinpcb(lso)->inp_flags & IN6P_AUTOFLOWLABEL)
1860                         sc->sc_flowlabel = sc->sc_iss & IPV6_FLOWLABEL_MASK;
1861                 break;
1862 #endif
1863         }
1864
1865         sc->sc_peer_mss = tcp_sc_msstab[cookie.flags.mss_idx];
1866
1867         /* We can simply recompute receive window scale we sent earlier. */
1868         while (wscale < TCP_MAX_WINSHIFT && (TCP_MAXWIN << wscale) < sb_max)
1869                 wscale++;
1870
1871         /* Only use wscale if it was enabled in the orignal SYN. */
1872         if (cookie.flags.wscale_idx > 0) {
1873                 sc->sc_requested_r_scale = wscale;
1874                 sc->sc_requested_s_scale = tcp_sc_wstab[cookie.flags.wscale_idx];
1875                 sc->sc_flags |= SCF_WINSCALE;
1876         }
1877
1878         wnd = sbspace(&lso->so_rcv);
1879         wnd = imax(wnd, 0);
1880         wnd = imin(wnd, TCP_MAXWIN);
1881         sc->sc_wnd = wnd;
1882
1883         if (cookie.flags.sack_ok)
1884                 sc->sc_flags |= SCF_SACK;
1885
1886         if (to->to_flags & TOF_TS) {
1887                 sc->sc_flags |= SCF_TIMESTAMP;
1888                 sc->sc_tsreflect = to->to_tsval;
1889                 sc->sc_ts = to->to_tsecr;
1890                 sc->sc_tsoff = to->to_tsecr - tcp_ts_getticks();
1891         }
1892
1893         if (to->to_flags & TOF_SIGNATURE)
1894                 sc->sc_flags |= SCF_SIGNATURE;
1895
1896         sc->sc_rxmits = 0;
1897
1898         TCPSTAT_INC(tcps_sc_recvcookie);
1899         return (sc);
1900 }
1901
1902 #ifdef INVARIANTS
1903 static int
1904 syncookie_cmp(struct in_conninfo *inc, struct syncache_head *sch,
1905     struct syncache *sc, struct tcphdr *th, struct tcpopt *to,
1906     struct socket *lso)
1907 {
1908         struct syncache scs, *scx;
1909         char *s;
1910
1911         bzero(&scs, sizeof(scs));
1912         scx = syncookie_lookup(inc, sch, &scs, th, to, lso);
1913
1914         if ((s = tcp_log_addrs(inc, th, NULL, NULL)) == NULL)
1915                 return (0);
1916
1917         if (scx != NULL) {
1918                 if (sc->sc_peer_mss != scx->sc_peer_mss)
1919                         log(LOG_DEBUG, "%s; %s: mss different %i vs %i\n",
1920                             s, __func__, sc->sc_peer_mss, scx->sc_peer_mss);
1921
1922                 if (sc->sc_requested_r_scale != scx->sc_requested_r_scale)
1923                         log(LOG_DEBUG, "%s; %s: rwscale different %i vs %i\n",
1924                             s, __func__, sc->sc_requested_r_scale,
1925                             scx->sc_requested_r_scale);
1926
1927                 if (sc->sc_requested_s_scale != scx->sc_requested_s_scale)
1928                         log(LOG_DEBUG, "%s; %s: swscale different %i vs %i\n",
1929                             s, __func__, sc->sc_requested_s_scale,
1930                             scx->sc_requested_s_scale);
1931
1932                 if ((sc->sc_flags & SCF_SACK) != (scx->sc_flags & SCF_SACK))
1933                         log(LOG_DEBUG, "%s; %s: SACK different\n", s, __func__);
1934         }
1935
1936         if (s != NULL)
1937                 free(s, M_TCPLOG);
1938         return (0);
1939 }
1940 #endif /* INVARIANTS */
1941
1942 static void
1943 syncookie_reseed(void *arg)
1944 {
1945         struct tcp_syncache *sc = arg;
1946         uint8_t *secbits;
1947         int secbit;
1948
1949         /*
1950          * Reseeding the secret doesn't have to be protected by a lock.
1951          * It only must be ensured that the new random values are visible
1952          * to all CPUs in a SMP environment.  The atomic with release
1953          * semantics ensures that.
1954          */
1955         secbit = (sc->secret.oddeven & 0x1) ? 0 : 1;
1956         secbits = sc->secret.key[secbit];
1957         arc4rand(secbits, SYNCOOKIE_SECRET_SIZE, 0);
1958         atomic_add_rel_int(&sc->secret.oddeven, 1);
1959
1960         /* Reschedule ourself. */
1961         callout_schedule(&sc->secret.reseed, SYNCOOKIE_LIFETIME * hz);
1962 }
1963
1964 /*
1965  * Returns the current number of syncache entries.  This number
1966  * will probably change before you get around to calling
1967  * syncache_pcblist.
1968  */
1969 int
1970 syncache_pcbcount(void)
1971 {
1972         struct syncache_head *sch;
1973         int count, i;
1974
1975         for (count = 0, i = 0; i < V_tcp_syncache.hashsize; i++) {
1976                 /* No need to lock for a read. */
1977                 sch = &V_tcp_syncache.hashbase[i];
1978                 count += sch->sch_length;
1979         }
1980         return count;
1981 }
1982
1983 /*
1984  * Exports the syncache entries to userland so that netstat can display
1985  * them alongside the other sockets.  This function is intended to be
1986  * called only from tcp_pcblist.
1987  *
1988  * Due to concurrency on an active system, the number of pcbs exported
1989  * may have no relation to max_pcbs.  max_pcbs merely indicates the
1990  * amount of space the caller allocated for this function to use.
1991  */
1992 int
1993 syncache_pcblist(struct sysctl_req *req, int max_pcbs, int *pcbs_exported)
1994 {
1995         struct xtcpcb xt;
1996         struct syncache *sc;
1997         struct syncache_head *sch;
1998         int count, error, i;
1999
2000         for (count = 0, error = 0, i = 0; i < V_tcp_syncache.hashsize; i++) {
2001                 sch = &V_tcp_syncache.hashbase[i];
2002                 SCH_LOCK(sch);
2003                 TAILQ_FOREACH(sc, &sch->sch_bucket, sc_hash) {
2004                         if (count >= max_pcbs) {
2005                                 SCH_UNLOCK(sch);
2006                                 goto exit;
2007                         }
2008                         if (cr_cansee(req->td->td_ucred, sc->sc_cred) != 0)
2009                                 continue;
2010                         bzero(&xt, sizeof(xt));
2011                         xt.xt_len = sizeof(xt);
2012                         if (sc->sc_inc.inc_flags & INC_ISIPV6)
2013                                 xt.xt_inp.inp_vflag = INP_IPV6;
2014                         else
2015                                 xt.xt_inp.inp_vflag = INP_IPV4;
2016                         bcopy(&sc->sc_inc, &xt.xt_inp.inp_inc, sizeof (struct in_conninfo));
2017                         xt.xt_tp.t_inpcb = &xt.xt_inp;
2018                         xt.xt_tp.t_state = TCPS_SYN_RECEIVED;
2019                         xt.xt_socket.xso_protocol = IPPROTO_TCP;
2020                         xt.xt_socket.xso_len = sizeof (struct xsocket);
2021                         xt.xt_socket.so_type = SOCK_STREAM;
2022                         xt.xt_socket.so_state = SS_ISCONNECTING;
2023                         error = SYSCTL_OUT(req, &xt, sizeof xt);
2024                         if (error) {
2025                                 SCH_UNLOCK(sch);
2026                                 goto exit;
2027                         }
2028                         count++;
2029                 }
2030                 SCH_UNLOCK(sch);
2031         }
2032 exit:
2033         *pcbs_exported = count;
2034         return error;
2035 }