sys/netinet/ip_ipsec.c

   1 /*-
   2  * Copyright (c) 1982, 1986, 1988, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 4. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 #include <sys/cdefs.h>
  31 __FBSDID("$FreeBSD$");
  32
  33 #include "opt_ipsec.h"
  34 #include "opt_sctp.h"
  35
  36 #include <sys/param.h>
  37 #include <sys/systm.h>
  38 #include <sys/errno.h>
  39 #include <sys/kernel.h>
  40 #include <sys/malloc.h>
  41 #include <sys/mbuf.h>
  42 #include <sys/protosw.h>
  43 #include <sys/socket.h>
  44 #include <sys/socketvar.h>
  45 #include <sys/sysctl.h>
  46
  47 #include <net/if.h>
  48 #include <net/if_var.h>
  49 #include <net/vnet.h>
  50
  51 #include <netinet/in.h>
  52 #include <netinet/in_systm.h>
  53 #include <netinet/in_var.h>
  54 #include <netinet/ip.h>
  55 #include <netinet/in_pcb.h>
  56 #include <netinet/ip_var.h>
  57 #include <netinet/ip_options.h>
  58 #include <netinet/ip_ipsec.h>
  59 #ifdef SCTP
  60 #include <netinet/sctp_crc32.h>
  61 #endif
  62
  63 #include <machine/in_cksum.h>
  64
  65 #include <netipsec/ipsec.h>
  66 #include <netipsec/xform.h>
  67 #include <netipsec/key.h>
  68
  69 extern  struct protosw inetsw[];
  70
  71 #ifdef IPSEC_FILTERTUNNEL
  72 static VNET_DEFINE(int, ip4_ipsec_filtertunnel) = 1;
  73 #else
  74 static VNET_DEFINE(int, ip4_ipsec_filtertunnel) = 0;
  75 #endif
  76 #define V_ip4_ipsec_filtertunnel VNET(ip4_ipsec_filtertunnel)
  77
  78 SYSCTL_DECL(_net_inet_ipsec);
  79 SYSCTL_INT(_net_inet_ipsec, OID_AUTO, filtertunnel,
  80         CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ip4_ipsec_filtertunnel), 0,
  81         "If set filter packets from an IPsec tunnel.");
  82
  83 /*
  84  * Check if we have to jump over firewall processing for this packet.
  85  * Called from ip_input().
  86  * 1 = jump over firewall, 0 = packet goes through firewall.
  87  */
  88 int
  89 ip_ipsec_filtertunnel(struct mbuf *m)
  90 {
  91
  92         /*
  93          * Bypass packet filtering for packets previously handled by IPsec.
  94          */
  95         if (!V_ip4_ipsec_filtertunnel &&
  96             m_tag_find(m, PACKET_TAG_IPSEC_IN_DONE, NULL) != NULL)
  97                 return 1;
  98         return 0;
  99 }
 100
 101 /*
 102  * Check if this packet has an active SA and needs to be dropped instead
 103  * of forwarded.
 104  * Called from ip_forward().
 105  * 1 = drop packet, 0 = forward packet.
 106  */
 107 int
 108 ip_ipsec_fwd(struct mbuf *m)
 109 {
 110         struct secpolicy *sp;
 111         int error;
 112
 113         sp = ipsec_getpolicybyaddr(m, IPSEC_DIR_INBOUND,
 114             IP_FORWARDING, &error);
 115         if (sp != NULL) {
 116                 /*
 117                  * Check security policy against packet attributes.
 118                  */
 119                 error = ipsec_in_reject(sp, m);
 120                 KEY_FREESP(&sp);
 121         }
 122         if (error != 0)
 123                 return (1);
 124         return (0);
 125 }
 126
 127 /*
 128  * Check if protocol type doesn't have a further header and do IPSEC
 129  * decryption or reject right now.  Protocols with further headers get
 130  * their IPSEC treatment within the protocol specific processing.
 131  * Called from ip_input().
 132  * 1 = drop packet, 0 = continue processing packet.
 133  */
 134 int
 135 ip_ipsec_input(struct mbuf *m, int nxt)
 136 {
 137         struct secpolicy *sp;
 138         int error;
 139         /*
 140          * enforce IPsec policy checking if we are seeing last header.
 141          * note that we do not visit this with protocols with pcb layer
 142          * code - like udp/tcp/raw ip.
 143          */
 144         if ((inetsw[ip_protox[nxt]].pr_flags & PR_LASTHDR) != 0) {
 145                 sp = ipsec_getpolicybyaddr(m, IPSEC_DIR_INBOUND,
 146                     IP_FORWARDING, &error);
 147                 if (sp != NULL) {
 148                         /*
 149                          * Check security policy against packet attributes.
 150                          */
 151                         error = ipsec_in_reject(sp, m);
 152                         KEY_FREESP(&sp);
 153                 } else {
 154                         /* XXX error stat??? */
 155                         error = EINVAL;
 156                         DPRINTF(("ip_input: no SP, packet discarded\n"));/*XXX*/
 157                 }
 158                 if (error != 0)
 159                         return (1);
 160         }
 161         return (0);
 162 }
 163
 164 /*
 165  * Compute the MTU for a forwarded packet that gets IPSEC encapsulated.
 166  * Called from ip_forward().
 167  * Returns MTU suggestion for ICMP needfrag reply.
 168  */
 169 int
 170 ip_ipsec_mtu(struct mbuf *m, int mtu)
 171 {
 172         /*
 173          * If the packet is routed over IPsec tunnel, tell the
 174          * originator the tunnel MTU.
 175          *      tunnel MTU = if MTU - sizeof(IP) - ESP/AH hdrsiz
 176          * XXX quickhack!!!
 177          */
 178         return (mtu - ipsec_hdrsiz(m, IPSEC_DIR_OUTBOUND, NULL));
 179 }
 180
 181 /*
 182  *
 183  * Called from ip_output().
 184  * 1 = drop packet, 0 = continue processing packet,
 185  * -1 = packet was reinjected and stop processing packet
 186  */
 187 int
 188 ip_ipsec_output(struct mbuf **m, struct inpcb *inp, int *flags, int *error)
 189 {
 190         struct secpolicy *sp;
 191         /*
 192          * Check the security policy (SP) for the packet and, if
 193          * required, do IPsec-related processing.  There are two
 194          * cases here; the first time a packet is sent through
 195          * it will be untagged and handled by ipsec4_checkpolicy.
 196          * If the packet is resubmitted to ip_output (e.g. after
 197          * AH, ESP, etc. processing), there will be a tag to bypass
 198          * the lookup and related policy checking.
 199          */
 200         if (m_tag_find(*m, PACKET_TAG_IPSEC_OUT_DONE, NULL) != NULL) {
 201                 *error = 0;
 202                 return (0);
 203         }
 204         sp = ipsec4_checkpolicy(*m, IPSEC_DIR_OUTBOUND, *flags, error, inp);
 205         /*
 206          * There are four return cases:
 207          *    sp != NULL                    apply IPsec policy
 208          *    sp == NULL, error == 0        no IPsec handling needed
 209          *    sp == NULL, error == -EINVAL  discard packet w/o error
 210          *    sp == NULL, error != 0        discard packet, report error
 211          */
 212         if (sp != NULL) {
 213                 /*
 214                  * Do delayed checksums now because we send before
 215                  * this is done in the normal processing path.
 216                  */
 217                 if ((*m)->m_pkthdr.csum_flags & CSUM_DELAY_DATA) {
 218                         in_delayed_cksum(*m);
 219                         (*m)->m_pkthdr.csum_flags &= ~CSUM_DELAY_DATA;
 220                 }
 221 #ifdef SCTP
 222                 if ((*m)->m_pkthdr.csum_flags & CSUM_SCTP) {
 223                         struct ip *ip = mtod(*m, struct ip *);
 224
 225                         sctp_delayed_cksum(*m, (uint32_t)(ip->ip_hl << 2));
 226                         (*m)->m_pkthdr.csum_flags &= ~CSUM_SCTP;
 227                 }
 228 #endif
 229
 230                 /* NB: callee frees mbuf */
 231                 *error = ipsec4_process_packet(*m, sp->req, *flags, 0);
 232                 if (*error == EJUSTRETURN) {
 233                         /*
 234                          * We had a SP with a level of 'use' and no SA. We
 235                          * will just continue to process the packet without
 236                          * IPsec processing and return without error.
 237                          */
 238                         *error = 0;
 239                         goto done;
 240                 }
 241                 /*
 242                  * Preserve KAME behaviour: ENOENT can be returned
 243                  * when an SA acquire is in progress.  Don't propagate
 244                  * this to user-level; it confuses applications.
 245                  *
 246                  * XXX this will go away when the SADB is redone.
 247                  */
 248                 if (*error == ENOENT)
 249                         *error = 0;
 250                 goto reinjected;
 251         } else {        /* sp == NULL */
 252
 253                 if (*error != 0) {
 254                         /*
 255                          * Hack: -EINVAL is used to signal that a packet
 256                          * should be silently discarded.  This is typically
 257                          * because we asked key management for an SA and
 258                          * it was delayed (e.g. kicked up to IKE).
 259                          */
 260                         if (*error == -EINVAL)
 261                                 *error = 0;
 262                         goto bad;
 263                 }
 264                 /* No IPsec processing for this packet. */
 265         }
 266 done:
 267         if (sp != NULL)
 268                 KEY_FREESP(&sp);
 269         return 0;
 270 reinjected:
 271         if (sp != NULL)
 272                 KEY_FREESP(&sp);
 273         return -1;
 274 bad:
 275         if (sp != NULL)
 276                 KEY_FREESP(&sp);
 277         return 1;
 278 }