sys/netinet/tcp_syncache.c

   1 /*-
   2  * Copyright (c) 2001 McAfee, Inc.
   3  * Copyright (c) 2006 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.
  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
  40 #include <sys/param.h>
  41 #include <sys/systm.h>
  42 #include <sys/kernel.h>
  43 #include <sys/sysctl.h>
  44 #include <sys/limits.h>
  45 #include <sys/lock.h>
  46 #include <sys/mutex.h>
  47 #include <sys/malloc.h>
  48 #include <sys/mbuf.h>
  49 #include <sys/md5.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 #include <sys/vimage.h>
  57
  58 #include <vm/uma.h>
  59
  60 #include <net/if.h>
  61 #include <net/route.h>
  62 #include <net/vnet.h>
  63
  64 #include <netinet/in.h>
  65 #include <netinet/in_systm.h>
  66 #include <netinet/ip.h>
  67 #include <netinet/in_var.h>
  68 #include <netinet/in_pcb.h>
  69 #include <netinet/ip_var.h>
  70 #include <netinet/ip_options.h>
  71 #ifdef INET6
  72 #include <netinet/ip6.h>
  73 #include <netinet/icmp6.h>
  74 #include <netinet6/nd6.h>
  75 #include <netinet6/ip6_var.h>
  76 #include <netinet6/in6_pcb.h>
  77 #endif
  78 #include <netinet/tcp.h>
  79 #include <netinet/tcp_fsm.h>
  80 #include <netinet/tcp_seq.h>
  81 #include <netinet/tcp_timer.h>
  82 #include <netinet/tcp_var.h>
  83 #include <netinet/tcp_syncache.h>
  84 #include <netinet/tcp_offload.h>
  85 #ifdef INET6
  86 #include <netinet6/tcp6_var.h>
  87 #endif
  88
  89 #ifdef IPSEC
  90 #include <netipsec/ipsec.h>
  91 #ifdef INET6
  92 #include <netipsec/ipsec6.h>
  93 #endif
  94 #include <netipsec/key.h>
  95 #endif /*IPSEC*/
  96
  97 #include <machine/in_cksum.h>
  98
  99 #include <security/mac/mac_framework.h>
 100
 101 static VNET_DEFINE(struct tcp_syncache, tcp_syncache);
 102 static VNET_DEFINE(int, tcp_syncookies);
 103 static VNET_DEFINE(int, tcp_syncookiesonly);
 104 VNET_DEFINE(int, tcp_sc_rst_sock_fail);
 105
 106 #define V_tcp_syncache                  VNET(tcp_syncache)
 107 #define V_tcp_syncookies                VNET(tcp_syncookies)
 108 #define V_tcp_syncookiesonly            VNET(tcp_syncookiesonly)
 109
 110 SYSCTL_VNET_INT(_net_inet_tcp, OID_AUTO, syncookies, CTLFLAG_RW,
 111     &VNET_NAME(tcp_syncookies), 0,
 112     "Use TCP SYN cookies if the syncache overflows");
 113
 114 SYSCTL_VNET_INT(_net_inet_tcp, OID_AUTO, syncookies_only, CTLFLAG_RW,
 115     &VNET_NAME(tcp_syncookiesonly), 0,
 116     "Use only TCP SYN cookies");
 117
 118 #ifdef TCP_OFFLOAD_DISABLE
 119 #define TOEPCB_ISSET(sc) (0)
 120 #else
 121 #define TOEPCB_ISSET(sc) ((sc)->sc_toepcb != NULL)
 122 #endif
 123
 124 static void      syncache_drop(struct syncache *, struct syncache_head *);
 125 static void      syncache_free(struct syncache *);
 126 static void      syncache_insert(struct syncache *, struct syncache_head *);
 127 struct syncache *syncache_lookup(struct in_conninfo *, struct syncache_head **);
 128 static int       syncache_respond(struct syncache *);
 129 static struct    socket *syncache_socket(struct syncache *, struct socket *,
 130                     struct mbuf *m);
 131 static void      syncache_timeout(struct syncache *sc, struct syncache_head *sch,
 132                     int docallout);
 133 static void      syncache_timer(void *);
 134 static void      syncookie_generate(struct syncache_head *, struct syncache *,
 135                     u_int32_t *);
 136 static struct syncache
 137                 *syncookie_lookup(struct in_conninfo *, struct syncache_head *,
 138                     struct syncache *, struct tcpopt *, struct tcphdr *,
 139                     struct socket *);
 140
 141 /*
 142  * Transmit the SYN,ACK fewer times than TCP_MAXRXTSHIFT specifies.
 143  * 3 retransmits corresponds to a timeout of 3 * (1 + 2 + 4 + 8) == 45 seconds,
 144  * the odds are that the user has given up attempting to connect by then.
 145  */
 146 #define SYNCACHE_MAXREXMTS              3
 147
 148 /* Arbitrary values */
 149 #define TCP_SYNCACHE_HASHSIZE           512
 150 #define TCP_SYNCACHE_BUCKETLIMIT        30
 151
 152 SYSCTL_NODE(_net_inet_tcp, OID_AUTO, syncache, CTLFLAG_RW, 0, "TCP SYN cache");
 153
 154 SYSCTL_VNET_INT(_net_inet_tcp_syncache, OID_AUTO, bucketlimit, CTLFLAG_RDTUN,
 155     &VNET_NAME(tcp_syncache.bucket_limit), 0,
 156     "Per-bucket hash limit for syncache");
 157
 158 SYSCTL_VNET_INT(_net_inet_tcp_syncache, OID_AUTO, cachelimit, CTLFLAG_RDTUN,
 159     &VNET_NAME(tcp_syncache.cache_limit), 0,
 160     "Overall entry limit for syncache");
 161
 162 SYSCTL_VNET_INT(_net_inet_tcp_syncache, OID_AUTO, count, CTLFLAG_RD,
 163     &VNET_NAME(tcp_syncache.cache_count), 0,
 164     "Current number of entries in syncache");
 165
 166 SYSCTL_VNET_INT(_net_inet_tcp_syncache, OID_AUTO, hashsize, CTLFLAG_RDTUN,
 167     &VNET_NAME(tcp_syncache.hashsize), 0,
 168     "Size of TCP syncache hashtable");
 169
 170 SYSCTL_VNET_INT(_net_inet_tcp_syncache, OID_AUTO, rexmtlimit, CTLFLAG_RW,
 171     &VNET_NAME(tcp_syncache.rexmt_limit), 0,
 172     "Limit on SYN/ACK retransmissions");
 173
 174 SYSCTL_VNET_INT(_net_inet_tcp_syncache, OID_AUTO, rst_on_sock_fail,
 175     CTLFLAG_RW, &VNET_NAME(tcp_sc_rst_sock_fail), 0,
 176     "Send reset on socket allocation failure");
 177
 178 static MALLOC_DEFINE(M_SYNCACHE, "syncache", "TCP syncache");
 179
 180 #define SYNCACHE_HASH(inc, mask)                                        \
 181         ((V_tcp_syncache.hash_secret ^                                  \
 182           (inc)->inc_faddr.s_addr ^                                     \
 183           ((inc)->inc_faddr.s_addr >> 16) ^                             \
 184           (inc)->inc_fport ^ (inc)->inc_lport) & mask)
 185
 186 #define SYNCACHE_HASH6(inc, mask)                                       \
 187         ((V_tcp_syncache.hash_secret ^                                  \
 188           (inc)->inc6_faddr.s6_addr32[0] ^                              \
 189           (inc)->inc6_faddr.s6_addr32[3] ^                              \
 190           (inc)->inc_fport ^ (inc)->inc_lport) & mask)
 191
 192 #define ENDPTS_EQ(a, b) (                                               \
 193         (a)->ie_fport == (b)->ie_fport &&                               \
 194         (a)->ie_lport == (b)->ie_lport &&                               \
 195         (a)->ie_faddr.s_addr == (b)->ie_faddr.s_addr &&                 \
 196         (a)->ie_laddr.s_addr == (b)->ie_laddr.s_addr                    \
 197 )
 198
 199 #define ENDPTS6_EQ(a, b) (memcmp(a, b, sizeof(*a)) == 0)
 200
 201 #define SCH_LOCK(sch)           mtx_lock(&(sch)->sch_mtx)
 202 #define SCH_UNLOCK(sch)         mtx_unlock(&(sch)->sch_mtx)
 203 #define SCH_LOCK_ASSERT(sch)    mtx_assert(&(sch)->sch_mtx, MA_OWNED)
 204
 205 /*
 206  * Requires the syncache entry to be already removed from the bucket list.
 207  */
 208 static void
 209 syncache_free(struct syncache *sc)
 210 {
 211
 212         if (sc->sc_ipopts)
 213                 (void) m_free(sc->sc_ipopts);
 214         if (sc->sc_cred)
 215                 crfree(sc->sc_cred);
 216 #ifdef MAC
 217         mac_syncache_destroy(&sc->sc_label);
 218 #endif
 219
 220         uma_zfree(V_tcp_syncache.zone, sc);
 221 }
 222
 223 void
 224 syncache_init(void)
 225 {
 226         int i;
 227
 228         V_tcp_syncookies = 1;
 229         V_tcp_syncookiesonly = 0;
 230         V_tcp_sc_rst_sock_fail = 1;
 231
 232         V_tcp_syncache.cache_count = 0;
 233         V_tcp_syncache.hashsize = TCP_SYNCACHE_HASHSIZE;
 234         V_tcp_syncache.bucket_limit = TCP_SYNCACHE_BUCKETLIMIT;
 235         V_tcp_syncache.rexmt_limit = SYNCACHE_MAXREXMTS;
 236         V_tcp_syncache.hash_secret = arc4random();
 237
 238         TUNABLE_INT_FETCH("net.inet.tcp.syncache.hashsize",
 239             &V_tcp_syncache.hashsize);
 240         TUNABLE_INT_FETCH("net.inet.tcp.syncache.bucketlimit",
 241             &V_tcp_syncache.bucket_limit);
 242         if (!powerof2(V_tcp_syncache.hashsize) ||
 243             V_tcp_syncache.hashsize == 0) {
 244                 printf("WARNING: syncache hash size is not a power of 2.\n");
 245                 V_tcp_syncache.hashsize = TCP_SYNCACHE_HASHSIZE;
 246         }
 247         V_tcp_syncache.hashmask = V_tcp_syncache.hashsize - 1;
 248
 249         /* Set limits. */
 250         V_tcp_syncache.cache_limit =
 251             V_tcp_syncache.hashsize * V_tcp_syncache.bucket_limit;
 252         TUNABLE_INT_FETCH("net.inet.tcp.syncache.cachelimit",
 253             &V_tcp_syncache.cache_limit);
 254
 255         /* Allocate the hash table. */
 256         V_tcp_syncache.hashbase = malloc(V_tcp_syncache.hashsize *
 257             sizeof(struct syncache_head), M_SYNCACHE, M_WAITOK | M_ZERO);
 258
 259         /* Initialize the hash buckets. */
 260         for (i = 0; i < V_tcp_syncache.hashsize; i++) {
 261 #ifdef VIMAGE
 262                 V_tcp_syncache.hashbase[i].sch_vnet = curvnet;
 263 #endif
 264                 TAILQ_INIT(&V_tcp_syncache.hashbase[i].sch_bucket);
 265                 mtx_init(&V_tcp_syncache.hashbase[i].sch_mtx, "tcp_sc_head",
 266                          NULL, MTX_DEF);
 267                 callout_init_mtx(&V_tcp_syncache.hashbase[i].sch_timer,
 268                          &V_tcp_syncache.hashbase[i].sch_mtx, 0);
 269                 V_tcp_syncache.hashbase[i].sch_length = 0;
 270         }
 271
 272         /* Create the syncache entry zone. */
 273         V_tcp_syncache.zone = uma_zcreate("syncache", sizeof(struct syncache),
 274             NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, 0);
 275         uma_zone_set_max(V_tcp_syncache.zone, V_tcp_syncache.cache_limit);
 276 }
 277
 278 #ifdef VIMAGE
 279 void
 280 syncache_destroy(void)
 281 {
 282
 283         /* XXX walk the cache, free remaining objects, stop timers */
 284
 285         uma_zdestroy(V_tcp_syncache.zone);
 286         FREE(V_tcp_syncache.hashbase, M_SYNCACHE);
 287 }
 288 #endif
 289
 290 /*
 291  * Inserts a syncache entry into the specified bucket row.
 292  * Locks and unlocks the syncache_head autonomously.
 293  */
 294 static void
 295 syncache_insert(struct syncache *sc, struct syncache_head *sch)
 296 {
 297         struct syncache *sc2;
 298
 299         SCH_LOCK(sch);
 300
 301         /*
 302          * Make sure that we don't overflow the per-bucket limit.
 303          * If the bucket is full, toss the oldest element.
 304          */
 305         if (sch->sch_length >= V_tcp_syncache.bucket_limit) {
 306                 KASSERT(!TAILQ_EMPTY(&sch->sch_bucket),
 307                         ("sch->sch_length incorrect"));
 308                 sc2 = TAILQ_LAST(&sch->sch_bucket, sch_head);
 309                 syncache_drop(sc2, sch);
 310                 TCPSTAT_INC(tcps_sc_bucketoverflow);
 311         }
 312
 313         /* Put it into the bucket. */
 314         TAILQ_INSERT_HEAD(&sch->sch_bucket, sc, sc_hash);
 315         sch->sch_length++;
 316
 317         /* Reinitialize the bucket row's timer. */
 318         if (sch->sch_length == 1)
 319                 sch->sch_nextc = ticks + INT_MAX;
 320         syncache_timeout(sc, sch, 1);
 321
 322         SCH_UNLOCK(sch);
 323
 324         V_tcp_syncache.cache_count++;
 325         TCPSTAT_INC(tcps_sc_added);
 326 }
 327
 328 /*
 329  * Remove and free entry from syncache bucket row.
 330  * Expects locked syncache head.
 331  */
 332 static void
 333 syncache_drop(struct syncache *sc, struct syncache_head *sch)
 334 {
 335
 336         SCH_LOCK_ASSERT(sch);
 337
 338         TAILQ_REMOVE(&sch->sch_bucket, sc, sc_hash);
 339         sch->sch_length--;
 340
 341 #ifndef TCP_OFFLOAD_DISABLE
 342         if (sc->sc_tu)
 343                 sc->sc_tu->tu_syncache_event(TOE_SC_DROP, sc->sc_toepcb);
 344 #endif
 345         syncache_free(sc);
 346         V_tcp_syncache.cache_count--;
 347 }
 348
 349 /*
 350  * Engage/reengage time on bucket row.
 351  */
 352 static void
 353 syncache_timeout(struct syncache *sc, struct syncache_head *sch, int docallout)
 354 {
 355         sc->sc_rxttime = ticks +
 356                 TCPTV_RTOBASE * (tcp_backoff[sc->sc_rxmits]);
 357         sc->sc_rxmits++;
 358         if (TSTMP_LT(sc->sc_rxttime, sch->sch_nextc)) {
 359                 sch->sch_nextc = sc->sc_rxttime;
 360                 if (docallout)
 361                         callout_reset(&sch->sch_timer, sch->sch_nextc - ticks,
 362                             syncache_timer, (void *)sch);
 363         }
 364 }
 365
 366 /*
 367  * Walk the timer queues, looking for SYN,ACKs that need to be retransmitted.
 368  * If we have retransmitted an entry the maximum number of times, expire it.
 369  * One separate timer for each bucket row.
 370  */
 371 static void
 372 syncache_timer(void *xsch)
 373 {
 374         struct syncache_head *sch = (struct syncache_head *)xsch;
 375         struct syncache *sc, *nsc;
 376         int tick = ticks;
 377         char *s;
 378
 379         CURVNET_SET(sch->sch_vnet);
 380
 381         /* NB: syncache_head has already been locked by the callout. */
 382         SCH_LOCK_ASSERT(sch);
 383
 384         /*
 385          * In the following cycle we may remove some entries and/or
 386          * advance some timeouts, so re-initialize the bucket timer.
 387          */
 388         sch->sch_nextc = tick + INT_MAX;
 389
 390         TAILQ_FOREACH_SAFE(sc, &sch->sch_bucket, sc_hash, nsc) {
 391                 /*
 392                  * We do not check if the listen socket still exists
 393                  * and accept the case where the listen socket may be
 394                  * gone by the time we resend the SYN/ACK.  We do
 395                  * not expect this to happens often. If it does,
 396                  * then the RST will be sent by the time the remote
 397                  * host does the SYN/ACK->ACK.
 398                  */
 399                 if (TSTMP_GT(sc->sc_rxttime, tick)) {
 400                         if (TSTMP_LT(sc->sc_rxttime, sch->sch_nextc))
 401                                 sch->sch_nextc = sc->sc_rxttime;
 402                         continue;
 403                 }
 404                 if (sc->sc_rxmits > V_tcp_syncache.rexmt_limit) {
 405                         if ((s = tcp_log_addrs(&sc->sc_inc, NULL, NULL, NULL))) {
 406                                 log(LOG_DEBUG, "%s; %s: Retransmits exhausted, "
 407                                     "giving up and removing syncache entry\n",
 408                                     s, __func__);
 409                                 free(s, M_TCPLOG);
 410                         }
 411                         syncache_drop(sc, sch);
 412                         TCPSTAT_INC(tcps_sc_stale);
 413                         continue;
 414                 }
 415                 if ((s = tcp_log_addrs(&sc->sc_inc, NULL, NULL, NULL))) {
 416                         log(LOG_DEBUG, "%s; %s: Response timeout, "
 417                             "retransmitting (%u) SYN|ACK\n",
 418                             s, __func__, sc->sc_rxmits);
 419                         free(s, M_TCPLOG);
 420                 }
 421
 422                 (void) syncache_respond(sc);
 423                 TCPSTAT_INC(tcps_sc_retransmitted);
 424                 syncache_timeout(sc, sch, 0);
 425         }
 426         if (!TAILQ_EMPTY(&(sch)->sch_bucket))
 427                 callout_reset(&(sch)->sch_timer, (sch)->sch_nextc - tick,
 428                         syncache_timer, (void *)(sch));
 429         CURVNET_RESTORE();
 430 }
 431
 432 /*
 433  * Find an entry in the syncache.
 434  * Returns always with locked syncache_head plus a matching entry or NULL.
 435  */
 436 struct syncache *
 437 syncache_lookup(struct in_conninfo *inc, struct syncache_head **schp)
 438 {
 439         struct syncache *sc;
 440         struct syncache_head *sch;
 441
 442 #ifdef INET6
 443         if (inc->inc_flags & INC_ISIPV6) {
 444                 sch = &V_tcp_syncache.hashbase[
 445                     SYNCACHE_HASH6(inc, V_tcp_syncache.hashmask)];
 446                 *schp = sch;
 447
 448                 SCH_LOCK(sch);
 449
 450                 /* Circle through bucket row to find matching entry. */
 451                 TAILQ_FOREACH(sc, &sch->sch_bucket, sc_hash) {
 452                         if (ENDPTS6_EQ(&inc->inc_ie, &sc->sc_inc.inc_ie))
 453                                 return (sc);
 454                 }
 455         } else
 456 #endif
 457         {
 458                 sch = &V_tcp_syncache.hashbase[
 459                     SYNCACHE_HASH(inc, V_tcp_syncache.hashmask)];
 460                 *schp = sch;
 461
 462                 SCH_LOCK(sch);
 463
 464                 /* Circle through bucket row to find matching entry. */
 465                 TAILQ_FOREACH(sc, &sch->sch_bucket, sc_hash) {
 466 #ifdef INET6
 467                         if (sc->sc_inc.inc_flags & INC_ISIPV6)
 468                                 continue;
 469 #endif
 470                         if (ENDPTS_EQ(&inc->inc_ie, &sc->sc_inc.inc_ie))
 471                                 return (sc);
 472                 }
 473         }
 474         SCH_LOCK_ASSERT(*schp);
 475         return (NULL);                  /* always returns with locked sch */
 476 }
 477
 478 /*
 479  * This function is called when we get a RST for a
 480  * non-existent connection, so that we can see if the
 481  * connection is in the syn cache.  If it is, zap it.
 482  */
 483 void
 484 syncache_chkrst(struct in_conninfo *inc, struct tcphdr *th)
 485 {
 486         struct syncache *sc;
 487         struct syncache_head *sch;
 488         char *s = NULL;
 489
 490         sc = syncache_lookup(inc, &sch);        /* returns locked sch */
 491         SCH_LOCK_ASSERT(sch);
 492
 493         /*
 494          * Any RST to our SYN|ACK must not carry ACK, SYN or FIN flags.
 495          * See RFC 793 page 65, section SEGMENT ARRIVES.
 496          */
 497         if (th->th_flags & (TH_ACK|TH_SYN|TH_FIN)) {
 498                 if ((s = tcp_log_addrs(inc, th, NULL, NULL)))
 499                         log(LOG_DEBUG, "%s; %s: Spurious RST with ACK, SYN or "
 500                             "FIN flag set, segment ignored\n", s, __func__);
 501                 TCPSTAT_INC(tcps_badrst);
 502                 goto done;
 503         }
 504
 505         /*
 506          * No corresponding connection was found in syncache.
 507          * If syncookies are enabled and possibly exclusively
 508          * used, or we are under memory pressure, a valid RST
 509          * may not find a syncache entry.  In that case we're
 510          * done and no SYN|ACK retransmissions will happen.
 511          * Otherwise the the RST was misdirected or spoofed.
 512          */
 513         if (sc == NULL) {
 514                 if ((s = tcp_log_addrs(inc, th, NULL, NULL)))
 515                         log(LOG_DEBUG, "%s; %s: Spurious RST without matching "
 516                             "syncache entry (possibly syncookie only), "
 517                             "segment ignored\n", s, __func__);
 518                 TCPSTAT_INC(tcps_badrst);
 519                 goto done;
 520         }
 521
 522         /*
 523          * If the RST bit is set, check the sequence number to see
 524          * if this is a valid reset segment.
 525          * RFC 793 page 37:
 526          *   In all states except SYN-SENT, all reset (RST) segments
 527          *   are validated by checking their SEQ-fields.  A reset is
 528          *   valid if its sequence number is in the window.
 529          *
 530          *   The sequence number in the reset segment is normally an
 531          *   echo of our outgoing acknowlegement numbers, but some hosts
 532          *   send a reset with the sequence number at the rightmost edge
 533          *   of our receive window, and we have to handle this case.
 534          */
 535         if (SEQ_GEQ(th->th_seq, sc->sc_irs) &&
 536             SEQ_LEQ(th->th_seq, sc->sc_irs + sc->sc_wnd)) {
 537                 syncache_drop(sc, sch);
 538                 if ((s = tcp_log_addrs(inc, th, NULL, NULL)))
 539                         log(LOG_DEBUG, "%s; %s: Our SYN|ACK was rejected, "
 540                             "connection attempt aborted by remote endpoint\n",
 541                             s, __func__);
 542                 TCPSTAT_INC(tcps_sc_reset);
 543         } else {
 544                 if ((s = tcp_log_addrs(inc, th, NULL, NULL)))
 545                         log(LOG_DEBUG, "%s; %s: RST with invalid SEQ %u != "
 546                             "IRS %u (+WND %u), segment ignored\n",
 547                             s, __func__, th->th_seq, sc->sc_irs, sc->sc_wnd);
 548                 TCPSTAT_INC(tcps_badrst);
 549         }
 550
 551 done:
 552         if (s != NULL)
 553                 free(s, M_TCPLOG);
 554         SCH_UNLOCK(sch);
 555 }
 556
 557 void
 558 syncache_badack(struct in_conninfo *inc)
 559 {
 560         struct syncache *sc;
 561         struct syncache_head *sch;
 562
 563         sc = syncache_lookup(inc, &sch);        /* returns locked sch */
 564         SCH_LOCK_ASSERT(sch);
 565         if (sc != NULL) {
 566                 syncache_drop(sc, sch);
 567                 TCPSTAT_INC(tcps_sc_badack);
 568         }
 569         SCH_UNLOCK(sch);
 570 }
 571
 572 void
 573 syncache_unreach(struct in_conninfo *inc, struct tcphdr *th)
 574 {
 575         struct syncache *sc;
 576         struct syncache_head *sch;
 577
 578         sc = syncache_lookup(inc, &sch);        /* returns locked sch */
 579         SCH_LOCK_ASSERT(sch);
 580         if (sc == NULL)
 581                 goto done;
 582
 583         /* If the sequence number != sc_iss, then it's a bogus ICMP msg */
 584         if (ntohl(th->th_seq) != sc->sc_iss)
 585                 goto done;
 586
 587         /*
 588          * If we've rertransmitted 3 times and this is our second error,
 589          * we remove the entry.  Otherwise, we allow it to continue on.
 590          * This prevents us from incorrectly nuking an entry during a
 591          * spurious network outage.
 592          *
 593          * See tcp_notify().
 594          */
 595         if ((sc->sc_flags & SCF_UNREACH) == 0 || sc->sc_rxmits < 3 + 1) {
 596                 sc->sc_flags |= SCF_UNREACH;
 597                 goto done;
 598         }
 599         syncache_drop(sc, sch);
 600         TCPSTAT_INC(tcps_sc_unreach);
 601 done:
 602         SCH_UNLOCK(sch);
 603 }
 604
 605 /*
 606  * Build a new TCP socket structure from a syncache entry.
 607  */
 608 static struct socket *
 609 syncache_socket(struct syncache *sc, struct socket *lso, struct mbuf *m)
 610 {
 611         struct inpcb *inp = NULL;
 612         struct socket *so;
 613         struct tcpcb *tp;
 614         char *s;
 615
 616         INP_INFO_WLOCK_ASSERT(&V_tcbinfo);
 617
 618         /*
 619          * Ok, create the full blown connection, and set things up
 620          * as they would have been set up if we had created the
 621          * connection when the SYN arrived.  If we can't create
 622          * the connection, abort it.
 623          */
 624         so = sonewconn(lso, SS_ISCONNECTED);
 625         if (so == NULL) {
 626                 /*
 627                  * Drop the connection; we will either send a RST or
 628                  * have the peer retransmit its SYN again after its
 629                  * RTO and try again.
 630                  */
 631                 TCPSTAT_INC(tcps_listendrop);
 632                 if ((s = tcp_log_addrs(&sc->sc_inc, NULL, NULL, NULL))) {
 633                         log(LOG_DEBUG, "%s; %s: Socket create failed "
 634                             "due to limits or memory shortage\n",
 635                             s, __func__);
 636                         free(s, M_TCPLOG);
 637                 }
 638                 goto abort2;
 639         }
 640 #ifdef MAC
 641         mac_socketpeer_set_from_mbuf(m, so);
 642 #endif
 643
 644         inp = sotoinpcb(so);
 645         inp->inp_inc.inc_fibnum = sc->sc_inc.inc_fibnum;
 646         so->so_fibnum = sc->sc_inc.inc_fibnum;
 647         INP_WLOCK(inp);
 648
 649         /* Insert new socket into PCB hash list. */
 650         inp->inp_inc.inc_flags = sc->sc_inc.inc_flags;
 651 #ifdef INET6
 652         if (sc->sc_inc.inc_flags & INC_ISIPV6) {
 653                 inp->in6p_laddr = sc->sc_inc.inc6_laddr;
 654         } else {
 655                 inp->inp_vflag &= ~INP_IPV6;
 656                 inp->inp_vflag |= INP_IPV4;
 657 #endif
 658                 inp->inp_laddr = sc->sc_inc.inc_laddr;
 659 #ifdef INET6
 660         }
 661 #endif
 662         inp->inp_lport = sc->sc_inc.inc_lport;
 663         if (in_pcbinshash(inp) != 0) {
 664                 /*
 665                  * Undo the assignments above if we failed to
 666                  * put the PCB on the hash lists.
 667                  */
 668 #ifdef INET6
 669                 if (sc->sc_inc.inc_flags & INC_ISIPV6)
 670                         inp->in6p_laddr = in6addr_any;
 671                 else
 672 #endif
 673                         inp->inp_laddr.s_addr = INADDR_ANY;
 674                 inp->inp_lport = 0;
 675                 goto abort;
 676         }
 677 #ifdef IPSEC
 678         /* Copy old policy into new socket's. */
 679         if (ipsec_copy_policy(sotoinpcb(lso)->inp_sp, inp->inp_sp))
 680                 printf("syncache_socket: could not copy policy\n");
 681 #endif
 682 #ifdef INET6
 683         if (sc->sc_inc.inc_flags & INC_ISIPV6) {
 684                 struct inpcb *oinp = sotoinpcb(lso);
 685                 struct in6_addr laddr6;
 686                 struct sockaddr_in6 sin6;
 687                 /*
 688                  * Inherit socket options from the listening socket.
 689                  * Note that in6p_inputopts are not (and should not be)
 690                  * copied, since it stores previously received options and is
 691                  * used to detect if each new option is different than the
 692                  * previous one and hence should be passed to a user.
 693                  * If we copied in6p_inputopts, a user would not be able to
 694                  * receive options just after calling the accept system call.
 695                  */
 696                 inp->inp_flags |= oinp->inp_flags & INP_CONTROLOPTS;
 697                 if (oinp->in6p_outputopts)
 698                         inp->in6p_outputopts =
 699                             ip6_copypktopts(oinp->in6p_outputopts, M_NOWAIT);
 700
 701                 sin6.sin6_family = AF_INET6;
 702                 sin6.sin6_len = sizeof(sin6);
 703                 sin6.sin6_addr = sc->sc_inc.inc6_faddr;
 704                 sin6.sin6_port = sc->sc_inc.inc_fport;
 705                 sin6.sin6_flowinfo = sin6.sin6_scope_id = 0;
 706                 laddr6 = inp->in6p_laddr;
 707                 if (IN6_IS_ADDR_UNSPECIFIED(&inp->in6p_laddr))
 708                         inp->in6p_laddr = sc->sc_inc.inc6_laddr;
 709                 if (in6_pcbconnect(inp, (struct sockaddr *)&sin6,
 710                     thread0.td_ucred)) {
 711                         inp->in6p_laddr = laddr6;
 712                         goto abort;
 713                 }
 714                 /* Override flowlabel from in6_pcbconnect. */
 715                 inp->inp_flow &= ~IPV6_FLOWLABEL_MASK;
 716                 inp->inp_flow |= sc->sc_flowlabel;
 717         } else
 718 #endif
 719         {
 720                 struct in_addr laddr;
 721                 struct sockaddr_in sin;
 722
 723                 inp->inp_options = (m) ? ip_srcroute(m) : NULL;
 724
 725                 if (inp->inp_options == NULL) {
 726                         inp->inp_options = sc->sc_ipopts;
 727                         sc->sc_ipopts = NULL;
 728                 }
 729
 730                 sin.sin_family = AF_INET;
 731                 sin.sin_len = sizeof(sin);
 732                 sin.sin_addr = sc->sc_inc.inc_faddr;
 733                 sin.sin_port = sc->sc_inc.inc_fport;
 734                 bzero((caddr_t)sin.sin_zero, sizeof(sin.sin_zero));
 735                 laddr = inp->inp_laddr;
 736                 if (inp->inp_laddr.s_addr == INADDR_ANY)
 737                         inp->inp_laddr = sc->sc_inc.inc_laddr;
 738                 if (in_pcbconnect(inp, (struct sockaddr *)&sin,
 739                     thread0.td_ucred)) {
 740                         inp->inp_laddr = laddr;
 741                         goto abort;
 742                 }
 743         }
 744         tp = intotcpcb(inp);
 745         tp->t_state = TCPS_SYN_RECEIVED;
 746         tp->iss = sc->sc_iss;
 747         tp->irs = sc->sc_irs;
 748         tcp_rcvseqinit(tp);
 749         tcp_sendseqinit(tp);
 750         tp->snd_wl1 = sc->sc_irs;
 751         tp->snd_max = tp->iss + 1;
 752         tp->snd_nxt = tp->iss + 1;
 753         tp->rcv_up = sc->sc_irs + 1;
 754         tp->rcv_wnd = sc->sc_wnd;
 755         tp->rcv_adv += tp->rcv_wnd;
 756         tp->last_ack_sent = tp->rcv_nxt;
 757
 758         tp->t_flags = sototcpcb(lso)->t_flags & (TF_NOPUSH|TF_NODELAY);
 759         if (sc->sc_flags & SCF_NOOPT)
 760                 tp->t_flags |= TF_NOOPT;
 761         else {
 762                 if (sc->sc_flags & SCF_WINSCALE) {
 763                         tp->t_flags |= TF_REQ_SCALE|TF_RCVD_SCALE;
 764                         tp->snd_scale = sc->sc_requested_s_scale;
 765                         tp->request_r_scale = sc->sc_requested_r_scale;
 766                 }
 767                 if (sc->sc_flags & SCF_TIMESTAMP) {
 768                         tp->t_flags |= TF_REQ_TSTMP|TF_RCVD_TSTMP;
 769                         tp->ts_recent = sc->sc_tsreflect;
 770                         tp->ts_recent_age = ticks;
 771                         tp->ts_offset = sc->sc_tsoff;
 772                 }
 773 #ifdef TCP_SIGNATURE
 774                 if (sc->sc_flags & SCF_SIGNATURE)
 775                         tp->t_flags |= TF_SIGNATURE;
 776 #endif
 777                 if (sc->sc_flags & SCF_SACK)
 778                         tp->t_flags |= TF_SACK_PERMIT;
 779         }
 780
 781         if (sc->sc_flags & SCF_ECN)
 782                 tp->t_flags |= TF_ECN_PERMIT;
 783
 784         /*
 785          * Set up MSS and get cached values from tcp_hostcache.
 786          * This might overwrite some of the defaults we just set.
 787          */
 788         tcp_mss(tp, sc->sc_peer_mss);
 789
 790         /*
 791          * If the SYN,ACK was retransmitted, reset cwnd to 1 segment.
 792          */
 793         if (sc->sc_rxmits)
 794                 tp->snd_cwnd = tp->t_maxseg;
 795         tcp_timer_activate(tp, TT_KEEP, tcp_keepinit);
 796
 797         INP_WUNLOCK(inp);
 798
 799         TCPSTAT_INC(tcps_accepts);
 800         return (so);
 801
 802 abort:
 803         INP_WUNLOCK(inp);
 804 abort2:
 805         if (so != NULL)
 806                 soabort(so);
 807         return (NULL);
 808 }
 809
 810 /*
 811  * This function gets called when we receive an ACK for a
 812  * socket in the LISTEN state.  We look up the connection
 813  * in the syncache, and if its there, we pull it out of
 814  * the cache and turn it into a full-blown connection in
 815  * the SYN-RECEIVED state.
 816  */
 817 int
 818 syncache_expand(struct in_conninfo *inc, struct tcpopt *to, struct tcphdr *th,
 819     struct socket **lsop, struct mbuf *m)
 820 {
 821         struct syncache *sc;
 822         struct syncache_head *sch;
 823         struct syncache scs;
 824         char *s;
 825
 826         /*
 827          * Global TCP locks are held because we manipulate the PCB lists
 828          * and create a new socket.
 829          */
 830         INP_INFO_WLOCK_ASSERT(&V_tcbinfo);
 831         KASSERT((th->th_flags & (TH_RST|TH_ACK|TH_SYN)) == TH_ACK,
 832             ("%s: can handle only ACK", __func__));
 833
 834         sc = syncache_lookup(inc, &sch);        /* returns locked sch */
 835         SCH_LOCK_ASSERT(sch);
 836         if (sc == NULL) {
 837                 /*
 838                  * There is no syncache entry, so see if this ACK is
 839                  * a returning syncookie.  To do this, first:
 840                  *  A. See if this socket has had a syncache entry dropped in
 841                  *     the past.  We don't want to accept a bogus syncookie
 842                  *     if we've never received a SYN.
 843                  *  B. check that the syncookie is valid.  If it is, then
 844                  *     cobble up a fake syncache entry, and return.
 845                  */
 846                 if (!V_tcp_syncookies) {
 847                         SCH_UNLOCK(sch);
 848                         if ((s = tcp_log_addrs(inc, th, NULL, NULL)))
 849                                 log(LOG_DEBUG, "%s; %s: Spurious ACK, "
 850                                     "segment rejected (syncookies disabled)\n",
 851                                     s, __func__);
 852                         goto failed;
 853                 }
 854                 bzero(&scs, sizeof(scs));
 855                 sc = syncookie_lookup(inc, sch, &scs, to, th, *lsop);
 856                 SCH_UNLOCK(sch);
 857                 if (sc == NULL) {
 858                         if ((s = tcp_log_addrs(inc, th, NULL, NULL)))
 859                                 log(LOG_DEBUG, "%s; %s: Segment failed "
 860                                     "SYNCOOKIE authentication, segment rejected "
 861                                     "(probably spoofed)\n", s, __func__);
 862                         goto failed;
 863                 }
 864         } else {
 865                 /* Pull out the entry to unlock the bucket row. */
 866                 TAILQ_REMOVE(&sch->sch_bucket, sc, sc_hash);
 867                 sch->sch_length--;
 868                 V_tcp_syncache.cache_count--;
 869                 SCH_UNLOCK(sch);
 870         }
 871
 872         /*
 873          * Segment validation:
 874          * ACK must match our initial sequence number + 1 (the SYN|ACK).
 875          */
 876         if (th->th_ack != sc->sc_iss + 1 && !TOEPCB_ISSET(sc)) {
 877                 if ((s = tcp_log_addrs(inc, th, NULL, NULL)))
 878                         log(LOG_DEBUG, "%s; %s: ACK %u != ISS+1 %u, segment "
 879                             "rejected\n", s, __func__, th->th_ack, sc->sc_iss);
 880                 goto failed;
 881         }
 882
 883         /*
 884          * The SEQ must fall in the window starting at the received
 885          * initial receive sequence number + 1 (the SYN).
 886          */
 887         if ((SEQ_LEQ(th->th_seq, sc->sc_irs) ||
 888             SEQ_GT(th->th_seq, sc->sc_irs + sc->sc_wnd)) &&
 889             !TOEPCB_ISSET(sc)) {
 890                 if ((s = tcp_log_addrs(inc, th, NULL, NULL)))
 891                         log(LOG_DEBUG, "%s; %s: SEQ %u != IRS+1 %u, segment "
 892                             "rejected\n", s, __func__, th->th_seq, sc->sc_irs);
 893                 goto failed;
 894         }
 895
 896         if (!(sc->sc_flags & SCF_TIMESTAMP) && (to->to_flags & TOF_TS)) {
 897                 if ((s = tcp_log_addrs(inc, th, NULL, NULL)))
 898                         log(LOG_DEBUG, "%s; %s: Timestamp not expected, "
 899                             "segment rejected\n", s, __func__);
 900                 goto failed;
 901         }
 902         /*
 903          * If timestamps were negotiated the reflected timestamp
 904          * must be equal to what we actually sent in the SYN|ACK.
 905          */
 906         if ((to->to_flags & TOF_TS) && to->to_tsecr != sc->sc_ts &&
 907             !TOEPCB_ISSET(sc)) {
 908                 if ((s = tcp_log_addrs(inc, th, NULL, NULL)))
 909                         log(LOG_DEBUG, "%s; %s: TSECR %u != TS %u, "
 910                             "segment rejected\n",
 911                             s, __func__, to->to_tsecr, sc->sc_ts);
 912                 goto failed;
 913         }
 914
 915         *lsop = syncache_socket(sc, *lsop, m);
 916
 917         if (*lsop == NULL)
 918                 TCPSTAT_INC(tcps_sc_aborted);
 919         else
 920                 TCPSTAT_INC(tcps_sc_completed);
 921
 922 /* how do we find the inp for the new socket? */
 923         if (sc != &scs)
 924                 syncache_free(sc);
 925         return (1);
 926 failed:
 927         if (sc != NULL && sc != &scs)
 928                 syncache_free(sc);
 929         if (s != NULL)
 930                 free(s, M_TCPLOG);
 931         *lsop = NULL;
 932         return (0);
 933 }
 934
 935 int
 936 tcp_offload_syncache_expand(struct in_conninfo *inc, struct toeopt *toeo,
 937     struct tcphdr *th, struct socket **lsop, struct mbuf *m)
 938 {
 939         struct tcpopt to;
 940         int rc;
 941
 942         bzero(&to, sizeof(struct tcpopt));
 943         to.to_mss = toeo->to_mss;
 944         to.to_wscale = toeo->to_wscale;
 945         to.to_flags = toeo->to_flags;
 946
 947         INP_INFO_WLOCK(&V_tcbinfo);
 948         rc = syncache_expand(inc, &to, th, lsop, m);
 949         INP_INFO_WUNLOCK(&V_tcbinfo);
 950
 951         return (rc);
 952 }
 953
 954 /*
 955  * Given a LISTEN socket and an inbound SYN request, add
 956  * this to the syn cache, and send back a segment:
 957  *      <SEQ=ISS><ACK=RCV_NXT><CTL=SYN,ACK>
 958  * to the source.
 959  *
 960  * IMPORTANT NOTE: We do _NOT_ ACK data that might accompany the SYN.
 961  * Doing so would require that we hold onto the data and deliver it
 962  * to the application.  However, if we are the target of a SYN-flood
 963  * DoS attack, an attacker could send data which would eventually
 964  * consume all available buffer space if it were ACKed.  By not ACKing
 965  * the data, we avoid this DoS scenario.
 966  */
 967 static void
 968 _syncache_add(struct in_conninfo *inc, struct tcpopt *to, struct tcphdr *th,
 969     struct inpcb *inp, struct socket **lsop, struct mbuf *m,
 970     struct toe_usrreqs *tu, void *toepcb)
 971 {
 972         struct tcpcb *tp;
 973         struct socket *so;
 974         struct syncache *sc = NULL;
 975         struct syncache_head *sch;
 976         struct mbuf *ipopts = NULL;
 977         u_int32_t flowtmp;
 978         int win, sb_hiwat, ip_ttl, ip_tos, noopt;
 979         char *s;
 980 #ifdef INET6
 981         int autoflowlabel = 0;
 982 #endif
 983 #ifdef MAC
 984         struct label *maclabel;
 985 #endif
 986         struct syncache scs;
 987         struct ucred *cred;
 988
 989         INP_INFO_WLOCK_ASSERT(&V_tcbinfo);
 990         INP_WLOCK_ASSERT(inp);                  /* listen socket */
 991         KASSERT((th->th_flags & (TH_RST|TH_ACK|TH_SYN)) == TH_SYN,
 992             ("%s: unexpected tcp flags", __func__));
 993
 994         /*
 995          * Combine all so/tp operations very early to drop the INP lock as
 996          * soon as possible.
 997          */
 998         so = *lsop;
 999         tp = sototcpcb(so);
1000         cred = crhold(so->so_cred);
1001
1002 #ifdef INET6
1003         if ((inc->inc_flags & INC_ISIPV6) &&
1004             (inp->inp_flags & IN6P_AUTOFLOWLABEL))
1005                 autoflowlabel = 1;
1006 #endif
1007         ip_ttl = inp->inp_ip_ttl;
1008         ip_tos = inp->inp_ip_tos;
1009         win = sbspace(&so->so_rcv);
1010         sb_hiwat = so->so_rcv.sb_hiwat;
1011         noopt = (tp->t_flags & TF_NOOPT);
1012
1013         /* By the time we drop the lock these should no longer be used. */
1014         so = NULL;
1015         tp = NULL;
1016
1017 #ifdef MAC
1018         if (mac_syncache_init(&maclabel) != 0) {
1019                 INP_WUNLOCK(inp);
1020                 INP_INFO_WUNLOCK(&V_tcbinfo);
1021                 goto done;
1022         } else
1023                 mac_syncache_create(maclabel, inp);
1024 #endif
1025         INP_WUNLOCK(inp);
1026         INP_INFO_WUNLOCK(&V_tcbinfo);
1027
1028         /*
1029          * Remember the IP options, if any.
1030          */
1031 #ifdef INET6
1032         if (!(inc->inc_flags & INC_ISIPV6))
1033 #endif
1034                 ipopts = (m) ? ip_srcroute(m) : NULL;
1035
1036         /*
1037          * See if we already have an entry for this connection.
1038          * If we do, resend the SYN,ACK, and reset the retransmit timer.
1039          *
1040          * XXX: should the syncache be re-initialized with the contents
1041          * of the new SYN here (which may have different options?)
1042          *
1043          * XXX: We do not check the sequence number to see if this is a
1044          * real retransmit or a new connection attempt.  The question is
1045          * how to handle such a case; either ignore it as spoofed, or
1046          * drop the current entry and create a new one?
1047          */
1048         sc = syncache_lookup(inc, &sch);        /* returns locked entry */
1049         SCH_LOCK_ASSERT(sch);
1050         if (sc != NULL) {
1051 #ifndef TCP_OFFLOAD_DISABLE
1052                 if (sc->sc_tu)
1053                         sc->sc_tu->tu_syncache_event(TOE_SC_ENTRY_PRESENT,
1054                             sc->sc_toepcb);
1055 #endif
1056                 TCPSTAT_INC(tcps_sc_dupsyn);
1057                 if (ipopts) {
1058                         /*
1059                          * If we were remembering a previous source route,
1060                          * forget it and use the new one we've been given.
1061                          */
1062                         if (sc->sc_ipopts)
1063                                 (void) m_free(sc->sc_ipopts);
1064                         sc->sc_ipopts = ipopts;
1065                 }
1066                 /*
1067                  * Update timestamp if present.
1068                  */
1069                 if ((sc->sc_flags & SCF_TIMESTAMP) && (to->to_flags & TOF_TS))
1070                         sc->sc_tsreflect = to->to_tsval;
1071                 else
1072                         sc->sc_flags &= ~SCF_TIMESTAMP;
1073 #ifdef MAC
1074                 /*
1075                  * Since we have already unconditionally allocated label
1076                  * storage, free it up.  The syncache entry will already
1077                  * have an initialized label we can use.
1078                  */
1079                 mac_syncache_destroy(&maclabel);
1080 #endif
1081                 /* Retransmit SYN|ACK and reset retransmit count. */
1082                 if ((s = tcp_log_addrs(&sc->sc_inc, th, NULL, NULL))) {
1083                         log(LOG_DEBUG, "%s; %s: Received duplicate SYN, "
1084                             "resetting timer and retransmitting SYN|ACK\n",
1085                             s, __func__);
1086                         free(s, M_TCPLOG);
1087                 }
1088                 if (!TOEPCB_ISSET(sc) && syncache_respond(sc) == 0) {
1089                         sc->sc_rxmits = 0;
1090                         syncache_timeout(sc, sch, 1);
1091                         TCPSTAT_INC(tcps_sndacks);
1092                         TCPSTAT_INC(tcps_sndtotal);
1093                 }
1094                 SCH_UNLOCK(sch);
1095                 goto done;
1096         }
1097
1098         sc = uma_zalloc(V_tcp_syncache.zone, M_NOWAIT | M_ZERO);
1099         if (sc == NULL) {
1100                 /*
1101                  * The zone allocator couldn't provide more entries.
1102                  * Treat this as if the cache was full; drop the oldest
1103                  * entry and insert the new one.
1104                  */
1105                 TCPSTAT_INC(tcps_sc_zonefail);
1106                 if ((sc = TAILQ_LAST(&sch->sch_bucket, sch_head)) != NULL)
1107                         syncache_drop(sc, sch);
1108                 sc = uma_zalloc(V_tcp_syncache.zone, M_NOWAIT | M_ZERO);
1109                 if (sc == NULL) {
1110                         if (V_tcp_syncookies) {
1111                                 bzero(&scs, sizeof(scs));
1112                                 sc = &scs;
1113                         } else {
1114                                 SCH_UNLOCK(sch);
1115                                 if (ipopts)
1116                                         (void) m_free(ipopts);
1117                                 goto done;
1118                         }
1119                 }
1120         }
1121
1122         /*
1123          * Fill in the syncache values.
1124          */
1125 #ifdef MAC
1126         sc->sc_label = maclabel;
1127 #endif
1128         sc->sc_cred = cred;
1129         cred = NULL;
1130         sc->sc_ipopts = ipopts;
1131         /* XXX-BZ this fib assignment is just useless. */
1132         sc->sc_inc.inc_fibnum = inp->inp_inc.inc_fibnum;
1133         bcopy(inc, &sc->sc_inc, sizeof(struct in_conninfo));
1134 #ifdef INET6
1135         if (!(inc->inc_flags & INC_ISIPV6))
1136 #endif
1137         {
1138                 sc->sc_ip_tos = ip_tos;
1139                 sc->sc_ip_ttl = ip_ttl;
1140         }
1141 #ifndef TCP_OFFLOAD_DISABLE
1142         sc->sc_tu = tu;
1143         sc->sc_toepcb = toepcb;
1144 #endif
1145         sc->sc_irs = th->th_seq;
1146         sc->sc_iss = arc4random();
1147         sc->sc_flags = 0;
1148         sc->sc_flowlabel = 0;
1149
1150         /*
1151          * Initial receive window: clip sbspace to [0 .. TCP_MAXWIN].
1152          * win was derived from socket earlier in the function.
1153          */
1154         win = imax(win, 0);
1155         win = imin(win, TCP_MAXWIN);
1156         sc->sc_wnd = win;
1157
1158         if (V_tcp_do_rfc1323) {
1159                 /*
1160                  * A timestamp received in a SYN makes
1161                  * it ok to send timestamp requests and replies.
1162                  */
1163                 if (to->to_flags & TOF_TS) {
1164                         sc->sc_tsreflect = to->to_tsval;
1165                         sc->sc_ts = ticks;
1166                         sc->sc_flags |= SCF_TIMESTAMP;
1167                 }
1168                 if (to->to_flags & TOF_SCALE) {
1169                         int wscale = 0;
1170
1171                         /*
1172                          * Pick the smallest possible scaling factor that
1173                          * will still allow us to scale up to sb_max, aka
1174                          * kern.ipc.maxsockbuf.
1175                          *
1176                          * We do this because there are broken firewalls that
1177                          * will corrupt the window scale option, leading to
1178                          * the other endpoint believing that our advertised
1179                          * window is unscaled.  At scale factors larger than
1180                          * 5 the unscaled window will drop below 1500 bytes,
1181                          * leading to serious problems when traversing these
1182                          * broken firewalls.
1183                          *
1184                          * With the default maxsockbuf of 256K, a scale factor
1185                          * of 3 will be chosen by this algorithm.  Those who
1186                          * choose a larger maxsockbuf should watch out
1187                          * for the compatiblity problems mentioned above.
1188                          *
1189                          * RFC1323: The Window field in a SYN (i.e., a <SYN>
1190                          * or <SYN,ACK>) segment itself is never scaled.
1191                          */
1192                         while (wscale < TCP_MAX_WINSHIFT &&
1193                             (TCP_MAXWIN << wscale) < sb_max)
1194                                 wscale++;
1195                         sc->sc_requested_r_scale = wscale;
1196                         sc->sc_requested_s_scale = to->to_wscale;
1197                         sc->sc_flags |= SCF_WINSCALE;
1198                 }
1199         }
1200 #ifdef TCP_SIGNATURE
1201         /*
1202          * If listening socket requested TCP digests, and received SYN
1203          * contains the option, flag this in the syncache so that
1204          * syncache_respond() will do the right thing with the SYN+ACK.
1205          * XXX: Currently we always record the option by default and will
1206          * attempt to use it in syncache_respond().
1207          */
1208         if (to->to_flags & TOF_SIGNATURE)
1209                 sc->sc_flags |= SCF_SIGNATURE;
1210 #endif
1211         if (to->to_flags & TOF_SACKPERM)
1212                 sc->sc_flags |= SCF_SACK;
1213         if (to->to_flags & TOF_MSS)
1214                 sc->sc_peer_mss = to->to_mss;   /* peer mss may be zero */
1215         if (noopt)
1216                 sc->sc_flags |= SCF_NOOPT;
1217         if ((th->th_flags & (TH_ECE|TH_CWR)) && V_tcp_do_ecn)
1218                 sc->sc_flags |= SCF_ECN;
1219
1220         if (V_tcp_syncookies) {
1221                 syncookie_generate(sch, sc, &flowtmp);
1222 #ifdef INET6
1223                 if (autoflowlabel)
1224                         sc->sc_flowlabel = flowtmp;
1225 #endif
1226         } else {
1227 #ifdef INET6
1228                 if (autoflowlabel)
1229                         sc->sc_flowlabel =
1230                             (htonl(ip6_randomflowlabel()) & IPV6_FLOWLABEL_MASK);
1231 #endif
1232         }
1233         SCH_UNLOCK(sch);
1234
1235         /*
1236          * Do a standard 3-way handshake.
1237          */
1238         if (TOEPCB_ISSET(sc) || syncache_respond(sc) == 0) {
1239                 if (V_tcp_syncookies && V_tcp_syncookiesonly && sc != &scs)
1240                         syncache_free(sc);
1241                 else if (sc != &scs)
1242                         syncache_insert(sc, sch);   /* locks and unlocks sch */
1243                 TCPSTAT_INC(tcps_sndacks);
1244                 TCPSTAT_INC(tcps_sndtotal);
1245         } else {
1246                 if (sc != &scs)
1247                         syncache_free(sc);
1248                 TCPSTAT_INC(tcps_sc_dropped);
1249         }
1250
1251 done:
1252         if (cred != NULL)
1253                 crfree(cred);
1254 #ifdef MAC
1255         if (sc == &scs)
1256                 mac_syncache_destroy(&maclabel);
1257 #endif
1258         if (m) {
1259
1260                 *lsop = NULL;
1261                 m_freem(m);
1262         }
1263 }
1264
1265 static int
1266 syncache_respond(struct syncache *sc)
1267 {
1268         struct ip *ip = NULL;
1269         struct mbuf *m;
1270         struct tcphdr *th;
1271         int optlen, error;
1272         u_int16_t hlen, tlen, mssopt;
1273         struct tcpopt to;
1274 #ifdef INET6
1275         struct ip6_hdr *ip6 = NULL;
1276 #endif
1277
1278         hlen =
1279 #ifdef INET6
1280                (sc->sc_inc.inc_flags & INC_ISIPV6) ? sizeof(struct ip6_hdr) :
1281 #endif
1282                 sizeof(struct ip);
1283         tlen = hlen + sizeof(struct tcphdr);
1284
1285         /* Determine MSS we advertize to other end of connection. */
1286         mssopt = tcp_mssopt(&sc->sc_inc);
1287         if (sc->sc_peer_mss)
1288                 mssopt = max( min(sc->sc_peer_mss, mssopt), V_tcp_minmss);
1289
1290         /* XXX: Assume that the entire packet will fit in a header mbuf. */
1291         KASSERT(max_linkhdr + tlen + TCP_MAXOLEN <= MHLEN,
1292             ("syncache: mbuf too small"));
1293
1294         /* Create the IP+TCP header from scratch. */
1295         m = m_gethdr(M_DONTWAIT, MT_DATA);
1296         if (m == NULL)
1297                 return (ENOBUFS);
1298 #ifdef MAC
1299         mac_syncache_create_mbuf(sc->sc_label, m);
1300 #endif
1301         m->m_data += max_linkhdr;
1302         m->m_len = tlen;
1303         m->m_pkthdr.len = tlen;
1304         m->m_pkthdr.rcvif = NULL;
1305
1306 #ifdef INET6
1307         if (sc->sc_inc.inc_flags & INC_ISIPV6) {
1308                 ip6 = mtod(m, struct ip6_hdr *);
1309                 ip6->ip6_vfc = IPV6_VERSION;
1310                 ip6->ip6_nxt = IPPROTO_TCP;
1311                 ip6->ip6_src = sc->sc_inc.inc6_laddr;
1312                 ip6->ip6_dst = sc->sc_inc.inc6_faddr;
1313                 ip6->ip6_plen = htons(tlen - hlen);
1314                 /* ip6_hlim is set after checksum */
1315                 ip6->ip6_flow &= ~IPV6_FLOWLABEL_MASK;
1316                 ip6->ip6_flow |= sc->sc_flowlabel;
1317
1318                 th = (struct tcphdr *)(ip6 + 1);
1319         } else
1320 #endif
1321         {
1322                 ip = mtod(m, struct ip *);
1323                 ip->ip_v = IPVERSION;
1324                 ip->ip_hl = sizeof(struct ip) >> 2;
1325                 ip->ip_len = tlen;
1326                 ip->ip_id = 0;
1327                 ip->ip_off = 0;
1328                 ip->ip_sum = 0;
1329                 ip->ip_p = IPPROTO_TCP;
1330                 ip->ip_src = sc->sc_inc.inc_laddr;
1331                 ip->ip_dst = sc->sc_inc.inc_faddr;
1332                 ip->ip_ttl = sc->sc_ip_ttl;
1333                 ip->ip_tos = sc->sc_ip_tos;
1334
1335                 /*
1336                  * See if we should do MTU discovery.  Route lookups are
1337                  * expensive, so we will only unset the DF bit if:
1338                  *
1339                  *      1) path_mtu_discovery is disabled
1340                  *      2) the SCF_UNREACH flag has been set
1341                  */
1342                 if (V_path_mtu_discovery && ((sc->sc_flags & SCF_UNREACH) == 0))
1343                        ip->ip_off |= IP_DF;
1344
1345                 th = (struct tcphdr *)(ip + 1);
1346         }
1347         th->th_sport = sc->sc_inc.inc_lport;
1348         th->th_dport = sc->sc_inc.inc_fport;
1349
1350         th->th_seq = htonl(sc->sc_iss);
1351         th->th_ack = htonl(sc->sc_irs + 1);
1352         th->th_off = sizeof(struct tcphdr) >> 2;
1353         th->th_x2 = 0;
1354         th->th_flags = TH_SYN|TH_ACK;
1355         th->th_win = htons(sc->sc_wnd);
1356         th->th_urp = 0;
1357
1358         if (sc->sc_flags & SCF_ECN) {
1359                 th->th_flags |= TH_ECE;
1360                 TCPSTAT_INC(tcps_ecn_shs);
1361         }
1362
1363         /* Tack on the TCP options. */
1364         if ((sc->sc_flags & SCF_NOOPT) == 0) {
1365                 to.to_flags = 0;
1366
1367                 to.to_mss = mssopt;
1368                 to.to_flags = TOF_MSS;
1369                 if (sc->sc_flags & SCF_WINSCALE) {
1370                         to.to_wscale = sc->sc_requested_r_scale;
1371                         to.to_flags |= TOF_SCALE;
1372                 }
1373                 if (sc->sc_flags & SCF_TIMESTAMP) {
1374                         /* Virgin timestamp or TCP cookie enhanced one. */
1375                         to.to_tsval = sc->sc_ts;
1376                         to.to_tsecr = sc->sc_tsreflect;
1377                         to.to_flags |= TOF_TS;
1378                 }
1379                 if (sc->sc_flags & SCF_SACK)
1380                         to.to_flags |= TOF_SACKPERM;
1381 #ifdef TCP_SIGNATURE
1382                 if (sc->sc_flags & SCF_SIGNATURE)
1383                         to.to_flags |= TOF_SIGNATURE;
1384 #endif
1385                 optlen = tcp_addoptions(&to, (u_char *)(th + 1));
1386
1387                 /* Adjust headers by option size. */
1388                 th->th_off = (sizeof(struct tcphdr) + optlen) >> 2;
1389                 m->m_len += optlen;
1390                 m->m_pkthdr.len += optlen;
1391
1392 #ifdef TCP_SIGNATURE
1393                 if (sc->sc_flags & SCF_SIGNATURE)
1394                         tcp_signature_compute(m, 0, 0, optlen,
1395                             to.to_signature, IPSEC_DIR_OUTBOUND);
1396 #endif
1397 #ifdef INET6
1398                 if (sc->sc_inc.inc_flags & INC_ISIPV6)
1399                         ip6->ip6_plen = htons(ntohs(ip6->ip6_plen) + optlen);
1400                 else
1401 #endif
1402                         ip->ip_len += optlen;
1403         } else
1404                 optlen = 0;
1405
1406 #ifdef INET6
1407         if (sc->sc_inc.inc_flags & INC_ISIPV6) {
1408                 th->th_sum = 0;
1409                 th->th_sum = in6_cksum(m, IPPROTO_TCP, hlen,
1410                                        tlen + optlen - hlen);
1411                 ip6->ip6_hlim = in6_selecthlim(NULL, NULL);
1412                 error = ip6_output(m, NULL, NULL, 0, NULL, NULL, NULL);
1413         } else
1414 #endif
1415         {
1416                 th->th_sum = in_pseudo(ip->ip_src.s_addr, ip->ip_dst.s_addr,
1417                     htons(tlen + optlen - hlen + IPPROTO_TCP));
1418                 m->m_pkthdr.csum_flags = CSUM_TCP;
1419                 m->m_pkthdr.csum_data = offsetof(struct tcphdr, th_sum);
1420                 error = ip_output(m, sc->sc_ipopts, NULL, 0, NULL, NULL);
1421         }
1422         return (error);
1423 }
1424
1425 void
1426 syncache_add(struct in_conninfo *inc, struct tcpopt *to, struct tcphdr *th,
1427     struct inpcb *inp, struct socket **lsop, struct mbuf *m)
1428 {
1429         _syncache_add(inc, to, th, inp, lsop, m, NULL, NULL);
1430 }
1431
1432 void
1433 tcp_offload_syncache_add(struct in_conninfo *inc, struct toeopt *toeo,
1434     struct tcphdr *th, struct inpcb *inp, struct socket **lsop,
1435     struct toe_usrreqs *tu, void *toepcb)
1436 {
1437         struct tcpopt to;
1438
1439         bzero(&to, sizeof(struct tcpopt));
1440         to.to_mss = toeo->to_mss;
1441         to.to_wscale = toeo->to_wscale;
1442         to.to_flags = toeo->to_flags;
1443
1444         INP_INFO_WLOCK(&V_tcbinfo);
1445         INP_WLOCK(inp);
1446
1447         _syncache_add(inc, &to, th, inp, lsop, NULL, tu, toepcb);
1448 }
1449
1450 /*
1451  * The purpose of SYN cookies is to avoid keeping track of all SYN's we
1452  * receive and to be able to handle SYN floods from bogus source addresses
1453  * (where we will never receive any reply).  SYN floods try to exhaust all
1454  * our memory and available slots in the SYN cache table to cause a denial
1455  * of service to legitimate users of the local host.
1456  *
1457  * The idea of SYN cookies is to encode and include all necessary information
1458  * about the connection setup state within the SYN-ACK we send back and thus
1459  * to get along without keeping any local state until the ACK to the SYN-ACK
1460  * arrives (if ever).  Everything we need to know should be available from
1461  * the information we encoded in the SYN-ACK.
1462  *
1463  * More information about the theory behind SYN cookies and its first
1464  * discussion and specification can be found at:
1465  *  http://cr.yp.to/syncookies.html    (overview)
1466  *  http://cr.yp.to/syncookies/archive (gory details)
1467  *
1468  * This implementation extends the orginal idea and first implementation
1469  * of FreeBSD by using not only the initial sequence number field to store
1470  * information but also the timestamp field if present.  This way we can
1471  * keep track of the entire state we need to know to recreate the session in
1472  * its original form.  Almost all TCP speakers implement RFC1323 timestamps
1473  * these days.  For those that do not we still have to live with the known
1474  * shortcomings of the ISN only SYN cookies.
1475  *
1476  * Cookie layers:
1477  *
1478  * Initial sequence number we send:
1479  * 31|................................|0
1480  *    DDDDDDDDDDDDDDDDDDDDDDDDDMMMRRRP
1481  *    D = MD5 Digest (first dword)
1482  *    M = MSS index
1483  *    R = Rotation of secret
1484  *    P = Odd or Even secret
1485  *
1486  * The MD5 Digest is computed with over following parameters:
1487  *  a) randomly rotated secret
1488  *  b) struct in_conninfo containing the remote/local ip/port (IPv4&IPv6)
1489  *  c) the received initial sequence number from remote host
1490  *  d) the rotation offset and odd/even bit
1491  *
1492  * Timestamp we send:
1493  * 31|................................|0
1494  *    DDDDDDDDDDDDDDDDDDDDDDSSSSRRRRA5
1495  *    D = MD5 Digest (third dword) (only as filler)
1496  *    S = Requested send window scale
1497  *    R = Requested receive window scale
1498  *    A = SACK allowed
1499  *    5 = TCP-MD5 enabled (not implemented yet)
1500  *    XORed with MD5 Digest (forth dword)
1501  *
1502  * The timestamp isn't cryptographically secure and doesn't need to be.
1503  * The double use of the MD5 digest dwords ties it to a specific remote/
1504  * local host/port, remote initial sequence number and our local time
1505  * limited secret.  A received timestamp is reverted (XORed) and then
1506  * the contained MD5 dword is compared to the computed one to ensure the
1507  * timestamp belongs to the SYN-ACK we sent.  The other parameters may
1508  * have been tampered with but this isn't different from supplying bogus
1509  * values in the SYN in the first place.
1510  *
1511  * Some problems with SYN cookies remain however:
1512  * Consider the problem of a recreated (and retransmitted) cookie.  If the
1513  * original SYN was accepted, the connection is established.  The second
1514  * SYN is inflight, and if it arrives with an ISN that falls within the
1515  * receive window, the connection is killed.
1516  *
1517  * Notes:
1518  * A heuristic to determine when to accept syn cookies is not necessary.
1519  * An ACK flood would cause the syncookie verification to be attempted,
1520  * but a SYN flood causes syncookies to be generated.  Both are of equal
1521  * cost, so there's no point in trying to optimize the ACK flood case.
1522  * Also, if you don't process certain ACKs for some reason, then all someone
1523  * would have to do is launch a SYN and ACK flood at the same time, which
1524  * would stop cookie verification and defeat the entire purpose of syncookies.
1525  */
1526 static int tcp_sc_msstab[] = { 0, 256, 468, 536, 996, 1452, 1460, 8960 };
1527
1528 static void
1529 syncookie_generate(struct syncache_head *sch, struct syncache *sc,
1530     u_int32_t *flowlabel)
1531 {
1532         MD5_CTX ctx;
1533         u_int32_t md5_buffer[MD5_DIGEST_LENGTH / sizeof(u_int32_t)];
1534         u_int32_t data;
1535         u_int32_t *secbits;
1536         u_int off, pmss, mss;
1537         int i;
1538
1539         SCH_LOCK_ASSERT(sch);
1540
1541         /* Which of the two secrets to use. */
1542         secbits = sch->sch_oddeven ?
1543                         sch->sch_secbits_odd : sch->sch_secbits_even;
1544
1545         /* Reseed secret if too old. */
1546         if (sch->sch_reseed < time_uptime) {
1547                 sch->sch_oddeven = sch->sch_oddeven ? 0 : 1;    /* toggle */
1548                 secbits = sch->sch_oddeven ?
1549                                 sch->sch_secbits_odd : sch->sch_secbits_even;
1550                 for (i = 0; i < SYNCOOKIE_SECRET_SIZE; i++)
1551                         secbits[i] = arc4random();
1552                 sch->sch_reseed = time_uptime + SYNCOOKIE_LIFETIME;
1553         }
1554
1555         /* Secret rotation offset. */
1556         off = sc->sc_iss & 0x7;                 /* iss was randomized before */
1557
1558         /* Maximum segment size calculation. */
1559         pmss =
1560             max( min(sc->sc_peer_mss, tcp_mssopt(&sc->sc_inc)), V_tcp_minmss);
1561         for (mss = sizeof(tcp_sc_msstab) / sizeof(int) - 1; mss > 0; mss--)
1562                 if (tcp_sc_msstab[mss] <= pmss)
1563                         break;
1564
1565         /* Fold parameters and MD5 digest into the ISN we will send. */
1566         data = sch->sch_oddeven;/* odd or even secret, 1 bit */
1567         data |= off << 1;       /* secret offset, derived from iss, 3 bits */
1568         data |= mss << 4;       /* mss, 3 bits */
1569
1570         MD5Init(&ctx);
1571         MD5Update(&ctx, ((u_int8_t *)secbits) + off,
1572             SYNCOOKIE_SECRET_SIZE * sizeof(*secbits) - off);
1573         MD5Update(&ctx, secbits, off);
1574         MD5Update(&ctx, &sc->sc_inc, sizeof(sc->sc_inc));
1575         MD5Update(&ctx, &sc->sc_irs, sizeof(sc->sc_irs));
1576         MD5Update(&ctx, &data, sizeof(data));
1577         MD5Final((u_int8_t *)&md5_buffer, &ctx);
1578
1579         data |= (md5_buffer[0] << 7);
1580         sc->sc_iss = data;
1581
1582 #ifdef INET6
1583         *flowlabel = md5_buffer[1] & IPV6_FLOWLABEL_MASK;
1584 #endif
1585
1586         /* Additional parameters are stored in the timestamp if present. */
1587         if (sc->sc_flags & SCF_TIMESTAMP) {
1588                 data =  ((sc->sc_flags & SCF_SIGNATURE) ? 1 : 0); /* TCP-MD5, 1 bit */
1589                 data |= ((sc->sc_flags & SCF_SACK) ? 1 : 0) << 1; /* SACK, 1 bit */
1590                 data |= sc->sc_requested_s_scale << 2;  /* SWIN scale, 4 bits */
1591                 data |= sc->sc_requested_r_scale << 6;  /* RWIN scale, 4 bits */
1592                 data |= md5_buffer[2] << 10;            /* more digest bits */
1593                 data ^= md5_buffer[3];
1594                 sc->sc_ts = data;
1595                 sc->sc_tsoff = data - ticks;            /* after XOR */
1596         }
1597
1598         TCPSTAT_INC(tcps_sc_sendcookie);
1599 }
1600
1601 static struct syncache *
1602 syncookie_lookup(struct in_conninfo *inc, struct syncache_head *sch,
1603     struct syncache *sc, struct tcpopt *to, struct tcphdr *th,
1604     struct socket *so)
1605 {
1606         MD5_CTX ctx;
1607         u_int32_t md5_buffer[MD5_DIGEST_LENGTH / sizeof(u_int32_t)];
1608         u_int32_t data = 0;
1609         u_int32_t *secbits;
1610         tcp_seq ack, seq;
1611         int off, mss, wnd, flags;
1612
1613         SCH_LOCK_ASSERT(sch);
1614
1615         /*
1616          * Pull information out of SYN-ACK/ACK and
1617          * revert sequence number advances.
1618          */
1619         ack = th->th_ack - 1;
1620         seq = th->th_seq - 1;
1621         off = (ack >> 1) & 0x7;
1622         mss = (ack >> 4) & 0x7;
1623         flags = ack & 0x7f;
1624
1625         /* Which of the two secrets to use. */
1626         secbits = (flags & 0x1) ? sch->sch_secbits_odd : sch->sch_secbits_even;
1627
1628         /*
1629          * The secret wasn't updated for the lifetime of a syncookie,
1630          * so this SYN-ACK/ACK is either too old (replay) or totally bogus.
1631          */
1632         if (sch->sch_reseed + SYNCOOKIE_LIFETIME < time_uptime) {
1633                 return (NULL);
1634         }
1635
1636         /* Recompute the digest so we can compare it. */
1637         MD5Init(&ctx);
1638         MD5Update(&ctx, ((u_int8_t *)secbits) + off,
1639             SYNCOOKIE_SECRET_SIZE * sizeof(*secbits) - off);
1640         MD5Update(&ctx, secbits, off);
1641         MD5Update(&ctx, inc, sizeof(*inc));
1642         MD5Update(&ctx, &seq, sizeof(seq));
1643         MD5Update(&ctx, &flags, sizeof(flags));
1644         MD5Final((u_int8_t *)&md5_buffer, &ctx);
1645
1646         /* Does the digest part of or ACK'ed ISS match? */
1647         if ((ack & (~0x7f)) != (md5_buffer[0] << 7))
1648                 return (NULL);
1649
1650         /* Does the digest part of our reflected timestamp match? */
1651         if (to->to_flags & TOF_TS) {
1652                 data = md5_buffer[3] ^ to->to_tsecr;
1653                 if ((data & (~0x3ff)) != (md5_buffer[2] << 10))
1654                         return (NULL);
1655         }
1656
1657         /* Fill in the syncache values. */
1658         bcopy(inc, &sc->sc_inc, sizeof(struct in_conninfo));
1659         sc->sc_ipopts = NULL;
1660
1661         sc->sc_irs = seq;
1662         sc->sc_iss = ack;
1663
1664 #ifdef INET6
1665         if (inc->inc_flags & INC_ISIPV6) {
1666                 if (sotoinpcb(so)->inp_flags & IN6P_AUTOFLOWLABEL)
1667                         sc->sc_flowlabel = md5_buffer[1] & IPV6_FLOWLABEL_MASK;
1668         } else
1669 #endif
1670         {
1671                 sc->sc_ip_ttl = sotoinpcb(so)->inp_ip_ttl;
1672                 sc->sc_ip_tos = sotoinpcb(so)->inp_ip_tos;
1673         }
1674
1675         /* Additional parameters that were encoded in the timestamp. */
1676         if (data) {
1677                 sc->sc_flags |= SCF_TIMESTAMP;
1678                 sc->sc_tsreflect = to->to_tsval;
1679                 sc->sc_ts = to->to_tsecr;
1680                 sc->sc_tsoff = to->to_tsecr - ticks;
1681                 sc->sc_flags |= (data & 0x1) ? SCF_SIGNATURE : 0;
1682                 sc->sc_flags |= ((data >> 1) & 0x1) ? SCF_SACK : 0;
1683                 sc->sc_requested_s_scale = min((data >> 2) & 0xf,
1684                     TCP_MAX_WINSHIFT);
1685                 sc->sc_requested_r_scale = min((data >> 6) & 0xf,
1686                     TCP_MAX_WINSHIFT);
1687                 if (sc->sc_requested_s_scale || sc->sc_requested_r_scale)
1688                         sc->sc_flags |= SCF_WINSCALE;
1689         } else
1690                 sc->sc_flags |= SCF_NOOPT;
1691
1692         wnd = sbspace(&so->so_rcv);
1693         wnd = imax(wnd, 0);
1694         wnd = imin(wnd, TCP_MAXWIN);
1695         sc->sc_wnd = wnd;
1696
1697         sc->sc_rxmits = 0;
1698         sc->sc_peer_mss = tcp_sc_msstab[mss];
1699
1700         TCPSTAT_INC(tcps_sc_recvcookie);
1701         return (sc);
1702 }
1703
1704 /*
1705  * Returns the current number of syncache entries.  This number
1706  * will probably change before you get around to calling
1707  * syncache_pcblist.
1708  */
1709
1710 int
1711 syncache_pcbcount(void)
1712 {
1713         struct syncache_head *sch;
1714         int count, i;
1715
1716         for (count = 0, i = 0; i < V_tcp_syncache.hashsize; i++) {
1717                 /* No need to lock for a read. */
1718                 sch = &V_tcp_syncache.hashbase[i];
1719                 count += sch->sch_length;
1720         }
1721         return count;
1722 }
1723
1724 /*
1725  * Exports the syncache entries to userland so that netstat can display
1726  * them alongside the other sockets.  This function is intended to be
1727  * called only from tcp_pcblist.
1728  *
1729  * Due to concurrency on an active system, the number of pcbs exported
1730  * may have no relation to max_pcbs.  max_pcbs merely indicates the
1731  * amount of space the caller allocated for this function to use.
1732  */
1733 int
1734 syncache_pcblist(struct sysctl_req *req, int max_pcbs, int *pcbs_exported)
1735 {
1736         struct xtcpcb xt;
1737         struct syncache *sc;
1738         struct syncache_head *sch;
1739         int count, error, i;
1740
1741         for (count = 0, error = 0, i = 0; i < V_tcp_syncache.hashsize; i++) {
1742                 sch = &V_tcp_syncache.hashbase[i];
1743                 SCH_LOCK(sch);
1744                 TAILQ_FOREACH(sc, &sch->sch_bucket, sc_hash) {
1745                         if (count >= max_pcbs) {
1746                                 SCH_UNLOCK(sch);
1747                                 goto exit;
1748                         }
1749                         if (cr_cansee(req->td->td_ucred, sc->sc_cred) != 0)
1750                                 continue;
1751                         bzero(&xt, sizeof(xt));
1752                         xt.xt_len = sizeof(xt);
1753                         if (sc->sc_inc.inc_flags & INC_ISIPV6)
1754                                 xt.xt_inp.inp_vflag = INP_IPV6;
1755                         else
1756                                 xt.xt_inp.inp_vflag = INP_IPV4;
1757                         bcopy(&sc->sc_inc, &xt.xt_inp.inp_inc, sizeof (struct in_conninfo));
1758                         xt.xt_tp.t_inpcb = &xt.xt_inp;
1759                         xt.xt_tp.t_state = TCPS_SYN_RECEIVED;
1760                         xt.xt_socket.xso_protocol = IPPROTO_TCP;
1761                         xt.xt_socket.xso_len = sizeof (struct xsocket);
1762                         xt.xt_socket.so_type = SOCK_STREAM;
1763                         xt.xt_socket.so_state = SS_ISCONNECTING;
1764                         error = SYSCTL_OUT(req, &xt, sizeof xt);
1765                         if (error) {
1766                                 SCH_UNLOCK(sch);
1767                                 goto exit;
1768                         }
1769                         count++;
1770                 }
1771                 SCH_UNLOCK(sch);
1772         }
1773 exit:
1774         *pcbs_exported = count;
1775         return error;
1776 }