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