/* $OpenBSD: ip_ipsp.h,v 1.63 2000/03/29 07:09:57 angelos Exp $ */ /* * The authors of this code are John Ioannidis (ji@tla.org), * Angelos D. Keromytis (kermit@csd.uch.gr), * Niels Provos (provos@physnet.uni-hamburg.de) and * Niklas Hallqvist (niklas@appli.se). * * This code was written by John Ioannidis for BSD/OS in Athens, Greece, * in November 1995. * * Ported to OpenBSD and NetBSD, with additional transforms, in December 1996, * by Angelos D. Keromytis. * * Additional transforms and features in 1997 and 1998 by Angelos D. Keromytis * and Niels Provos. * * Additional features in 1999 by Angelos D. Keromytis and Niklas Hallqvist. * * Copyright (c) 1995, 1996, 1997, 1998, 1999 by John Ioannidis, * Angelos D. Keromytis and Niels Provos. * Copyright (c) 1999 Niklas Hallqvist. * * Permission to use, copy, and modify this software without fee * is hereby granted, provided that this entire notice is included in * all copies of any software which is or includes a copy or * modification of this software. * You may use this code under the GNU public license if you so wish. Please * contribute changes back to the authors under this freer than GPL license * so that we may further the use of strong encryption without limitations to * all. * * THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR * IMPLIED WARRANTY. IN PARTICULAR, NONE OF THE AUTHORS MAKES ANY * REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE * MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR * PURPOSE. */ #ifndef _NETINET_IPSP_H_ #define _NETINET_IPSP_H_ /* * IPSP global definitions. */ #include #include #include union sockaddr_union { struct sockaddr sa; struct sockaddr_in sin; struct sockaddr_in6 sin6; }; #define FLOW_EGRESS 0 #define FLOW_INGRESS 1 /* HMAC key sizes */ #define MD5HMAC96_KEYSIZE 16 #define SHA1HMAC96_KEYSIZE 20 #define RIPEMD160HMAC96_KEYSIZE 20 #define AH_HMAC_HASHLEN 12 /* 96 bits of authenticator */ #define AH_HMAC_RPLENGTH 4 /* 32 bits of replay counter */ #define AH_HMAC_INITIAL_RPL 1 /* Replay counter initial value */ /* Authenticator lengths */ #define AH_MD5_ALEN 16 #define AH_SHA1_ALEN 20 #define AH_RMD160_ALEN 20 #define AH_ALEN_MAX 20 /* Keep updated */ /* Reserved SPI numbers */ #define SPI_LOCAL_USE 0 #define SPI_RESERVED_MIN 1 #define SPI_RESERVED_MAX 255 /* sysctl default values */ #define IPSEC_DEFAULT_EMBRYONIC_SA_TIMEOUT 60 /* 1 minute */ #define IPSEC_DEFAULT_PFS 1 #define IPSEC_DEFAULT_SOFT_ALLOCATIONS 0 #define IPSEC_DEFAULT_EXP_ALLOCATIONS 0 #define IPSEC_DEFAULT_SOFT_BYTES 0 #define IPSEC_DEFAULT_EXP_BYTES 0 #define IPSEC_DEFAULT_SOFT_TIMEOUT 80000 #define IPSEC_DEFAULT_EXP_TIMEOUT 86400 #define IPSEC_DEFAULT_SOFT_FIRST_USE 3600 #define IPSEC_DEFAULT_EXP_FIRST_USE 7200 #define IPSEC_DEFAULT_DEF_ENC "3des" #define IPSEC_DEFAULT_DEF_AUTH "hmac-sha1" struct sockaddr_encap { u_int8_t sen_len; /* length */ u_int8_t sen_family; /* PF_KEY */ u_int16_t sen_type; /* see SENT_* */ union { u_int8_t Data[16]; /* other stuff mapped here */ struct /* SENT_IP4 */ { struct in_addr Src; struct in_addr Dst; u_int16_t Sport; u_int16_t Dport; u_int8_t Proto; u_int8_t Filler[3]; } Sip4; struct /* SENT_IP6 */ { struct in6_addr Src; struct in6_addr Dst; u_int16_t Sport; u_int16_t Dport; u_int8_t Proto; u_int8_t Filler[3]; } Sip6; struct /* SENT_IPSP */ { struct in_addr Dst; u_int32_t Spi; u_int8_t Sproto; u_int8_t Filler[7]; } Sipsp; struct /* SENT_IPSP6 */ { struct in6_addr Dst; u_int32_t Spi; u_int8_t Sproto; u_int8_t Filler[7]; } Sipsp6; } Sen; }; #define sen_data Sen.Data #define sen_ip_src Sen.Sip4.Src #define sen_ip_dst Sen.Sip4.Dst #define sen_proto Sen.Sip4.Proto #define sen_sport Sen.Sip4.Sport #define sen_dport Sen.Sip4.Dport #define sen_ip6_src Sen.Sip6.Src #define sen_ip6_dst Sen.Sip6.Dst #define sen_ip6_proto Sen.Sip6.Proto #define sen_ip6_sport Sen.Sip6.Sport #define sen_ip6_dport Sen.Sip6.Dport #define sen_ipsp_dst Sen.Sipsp.Dst #define sen_ipsp_spi Sen.Sipsp.Spi #define sen_ipsp_sproto Sen.Sipsp.Sproto #define sen_ipsp6_dst Sen.Sipsp6.Dst #define sen_ipsp6_spi Sen.Sipsp6.Spi #define sen_ipsp6_sproto Sen.Sipsp6.Sproto /* * The "type" is really part of the address as far as the routing * system is concerned. By using only one bit in the type field * for each type, we sort-of make sure that different types of * encapsulation addresses won't be matched against the wrong type. * */ #define SENT_IP4 0x0001 /* data is two struct in_addr */ #define SENT_IPSP 0x0002 /* data as in IP4/6 plus SPI */ #define SENT_IP6 0x0004 #define SENT_IPSP6 0x0008 /* * SENT_HDRLEN is the length of the "header" * SENT_*_LEN are the lengths of various forms of sen_data * SENT_*_OFF are the offsets in the sen_data array of various fields */ #define SENT_HDRLEN (2 * sizeof(u_int8_t) + sizeof(u_int16_t)) #define SENT_IP4_SRCOFF (0) #define SENT_IP4_DSTOFF (sizeof (struct in_addr)) #define SENT_IP6_SRCOFF (0) #define SENT_IP6_DSTOFF (sizeof (struct in6_addr)) #define SENT_IP4_LEN 20 #define SENT_IPSP_LEN 20 #define SENT_IP6_LEN 44 #define SENT_IPSP6_LEN 32 #define NOTIFY_SOFT_EXPIRE 0 /* Soft expiration of SA */ #define NOTIFY_HARD_EXPIRE 1 /* Hard expiration of SA */ #define NOTIFY_REQUEST_SA 2 /* Establish an SA */ #define NOTIFY_SATYPE_CONF 1 /* SA should do encryption */ #define NOTIFY_SATYPE_AUTH 2 /* SA should do authentication */ #define NOTIFY_SATYPE_TUNNEL 4 /* SA should use tunneling */ /* * For encapsulation routes are possible not only for the destination * address but also for the protocol, source and destination ports * if available */ struct route_enc { struct rtentry *re_rt; struct sockaddr_encap re_dst; }; struct flow { struct flow *flow_next; /* Next in flow chain */ struct flow *flow_prev; /* Previous in flow chain */ struct tdb *flow_sa; /* Pointer to the SA */ union sockaddr_union flow_src; /* Source address */ union sockaddr_union flow_srcmask; /* Source netmask */ union sockaddr_union flow_dst; /* Destination address */ union sockaddr_union flow_dstmask; /* Destination netmask */ u_int8_t flow_proto; /* Transport protocol, if applicable */ u_int8_t foo[3]; /* Alignment */ }; struct tdb /* tunnel descriptor block */ { struct tdb *tdb_hnext; /* Next in hash chain */ struct tdb *tdb_onext; /* Next in output */ struct tdb *tdb_inext; /* Previous in output */ struct xformsw *tdb_xform; /* Transformation to use */ struct enc_xform *tdb_encalgxform; /* Encryption algorithm xform */ struct auth_hash *tdb_authalgxform; /* Authentication algorithm xform */ #define TDBF_UNIQUE 0x00001 /* This should not be used by others */ #define TDBF_TIMER 0x00002 /* Absolute expiration timer in use */ #define TDBF_BYTES 0x00004 /* Check the byte counters */ #define TDBF_ALLOCATIONS 0x00008 /* Check the flows counters */ #define TDBF_INVALID 0x00010 /* This SPI is not valid yet/anymore */ #define TDBF_FIRSTUSE 0x00020 /* Expire after first use */ #define TDBF_HALFIV 0x00040 /* Use half-length IV (ESP old only) */ #define TDBF_SOFT_TIMER 0x00080 /* Soft expiration */ #define TDBF_SOFT_BYTES 0x00100 /* Soft expiration */ #define TDBF_SOFT_ALLOCATIONS 0x00200 /* Soft expiration */ #define TDBF_SOFT_FIRSTUSE 0x00400 /* Soft expiration */ #define TDBF_PFS 0x00800 /* Ask for PFS from Key Mgmt. */ #define TDBF_TUNNELING 0x01000 /* Force IP-IP encapsulation */ #define TDBF_NOREPLAY 0x02000 /* No replay counter present */ #define TDBF_RANDOMPADDING 0x04000 /* Random data in the ESP padding */ u_int32_t tdb_flags; /* Flags related to this TDB */ TAILQ_ENTRY(tdb) tdb_expnext; /* Expiration cluster list link */ TAILQ_ENTRY(tdb) tdb_explink; /* Expiration ordered list link */ u_int32_t tdb_exp_allocations; /* Expire after so many flows */ u_int32_t tdb_soft_allocations; /* Expiration warning */ u_int32_t tdb_cur_allocations; /* Total number of allocations */ u_int64_t tdb_exp_bytes; /* Expire after so many bytes passed */ u_int64_t tdb_soft_bytes; /* Expiration warning */ u_int64_t tdb_cur_bytes; /* Current count of bytes */ u_int64_t tdb_exp_timeout; /* When does the SPI expire */ u_int64_t tdb_soft_timeout; /* Send a soft-expire warning */ u_int64_t tdb_established; /* When was the SPI established */ u_int64_t tdb_timeout; /* Next absolute expiration time. */ u_int64_t tdb_first_use; /* When was it first used */ u_int64_t tdb_soft_first_use; /* Soft warning */ u_int64_t tdb_exp_first_use; /* Expire if tdb_first_use + * tdb_exp_first_use <= curtime */ u_int64_t tdb_cryptoid; /* Crypto session ID */ u_int32_t tdb_ref; /* References */ u_int32_t tdb_spi; /* SPI */ u_int16_t tdb_amxkeylen; /* Raw authentication key length */ u_int16_t tdb_emxkeylen; /* Raw encryption key length */ u_int16_t tdb_ivlen; /* IV length */ u_int8_t tdb_sproto; /* IPsec protocol */ u_int8_t tdb_wnd; /* Replay window */ u_int8_t tdb_satype; /* SA type (RFC2367, PF_KEY) */ union sockaddr_union tdb_dst; /* Destination address for this SA */ union sockaddr_union tdb_src; /* Source address for this SA */ union sockaddr_union tdb_proxy; u_int8_t *tdb_srcid; /* Source ID for this SA */ u_int8_t *tdb_dstid; /* Destination ID for this SA */ u_int8_t *tdb_amxkey; /* Raw authentication key */ u_int8_t *tdb_emxkey; /* Raw encryption key */ u_int32_t tdb_rpl; /* Replay counter */ u_int32_t tdb_bitmap; /* Used for replay sliding window */ u_int32_t tdb_initial; /* Initial replay value */ u_int32_t tdb_epoch; /* Used by the kernfs interface */ u_int16_t tdb_srcid_len; u_int16_t tdb_dstid_len; u_int16_t tdb_srcid_type; u_int16_t tdb_dstid_type; u_int8_t tdb_iv[4]; /* Used for HALF-IV ESP */ caddr_t tdb_interface; struct flow *tdb_flow; /* Which outboind flows use this SA */ struct flow *tdb_access; /* Ingress access control */ struct tdb *tdb_bind_out; /* Outgoing SA to use */ TAILQ_HEAD(tdb_bind_head, tdb) tdb_bind_in; TAILQ_ENTRY(tdb) tdb_bind_in_next; /* Refering Incoming SAs */ TAILQ_HEAD(tdb_inp_head, inpcb) tdb_inp; }; struct tdb_ident { u_int32_t spi; union sockaddr_union dst; u_int8_t proto; }; struct ipsecinit { u_int8_t *ii_enckey; u_int8_t *ii_authkey; u_int16_t ii_enckeylen; u_int16_t ii_authkeylen; u_int8_t ii_encalg; u_int8_t ii_authalg; }; struct xformsw { u_short xf_type; /* Unique ID of xform */ u_short xf_flags; /* flags (see below) */ char *xf_name; /* human-readable name */ int (*xf_attach)(void); /* called at config time */ int (*xf_init)(struct tdb *, struct xformsw *, struct ipsecinit *); int (*xf_zeroize)(struct tdb *); /* termination */ int (*xf_input)(struct mbuf *, struct tdb *, int, int); /* input */ int (*xf_output)(struct mbuf *, struct tdb *, struct mbuf **, int, int); /* output */ }; /* xform IDs */ #define XF_IP4 1 /* IP inside IP */ #define XF_AH 2 /* AH */ #define XF_ESP 3 /* ESP */ #define XF_TCPSIGNATURE 5 /* TCP MD5 Signature option, RFC 2358 */ /* xform attributes */ #define XFT_AUTH 0x0001 #define XFT_CONF 0x0100 #define IPSEC_ZEROES_SIZE 256 /* Larger than an IP6 extension hdr. */ #define IPSEC_KERNFS_BUFSIZE 4096 #if BYTE_ORDER == LITTLE_ENDIAN static __inline u_int64_t htonq(u_int64_t q) { register u_int32_t u, l; u = q >> 32; l = (u_int32_t) q; return htonl(u) | ((u_int64_t)htonl(l) << 32); } #define ntohq(_x) htonq(_x) #elif BYTE_ORDER == BIG_ENDIAN #define htonq(_x) (_x) #define ntohq(_x) htonq(_x) #else #error "Please fix " #endif #ifdef _KERNEL /* * Protects all tdb lists. * Must at least be splsoftnet (note: do not use splsoftclock as it is * special on some architectures, assuming it is always an spl lowering * operation). */ #define spltdb splsoftnet extern int encdebug; extern int ipsec_acl; extern int ipsec_keep_invalid; extern int ipsec_in_use; extern int ipsec_require_pfs; extern int ipsec_soft_allocations; extern int ipsec_exp_allocations; extern int ipsec_soft_bytes; extern int ipsec_exp_bytes; extern int ipsec_soft_timeout; extern int ipsec_exp_timeout; extern int ipsec_soft_first_use; extern int ipsec_exp_first_use; extern char ipsec_def_enc[]; extern char ipsec_def_auth[]; extern struct enc_xform enc_xform_des; extern struct enc_xform enc_xform_3des; extern struct enc_xform enc_xform_blf; extern struct enc_xform enc_xform_cast5; extern struct enc_xform enc_xform_skipjack; extern struct auth_hash auth_hash_hmac_md5_96; extern struct auth_hash auth_hash_hmac_sha1_96; extern struct auth_hash auth_hash_hmac_ripemd_160_96; extern TAILQ_HEAD(expclusterlist_head, tdb) expclusterlist; extern TAILQ_HEAD(explist_head, tdb) explist; extern struct xformsw xformsw[], *xformswNXFORMSW; /* Check if a given tdb has encryption, authentication and/or tunneling */ #define TDB_ATTRIB(x) (((x)->tdb_encalgxform ? NOTIFY_SATYPE_CONF : 0)| \ ((x)->tdb_authalgxform ? NOTIFY_SATYPE_AUTH : 0)) /* Traverse spi chain and get attributes */ #define SPI_CHAIN_ATTRIB(have, TDB_DIR, TDBP) do {\ int s = spltdb(); \ struct tdb *tmptdb = (TDBP); \ \ (have) = 0; \ while (tmptdb && tmptdb->tdb_xform) { \ if (tmptdb == NULL || tmptdb->tdb_flags & TDBF_INVALID) \ break; \ (have) |= TDB_ATTRIB(tmptdb); \ tmptdb = tmptdb->TDB_DIR; \ } \ splx(s); \ } while (0) /* Misc. */ extern char *inet_ntoa4(struct in_addr); #ifdef INET6 extern char *inet6_ntoa4(struct in6_addr); #endif /* INET6 */ extern char *ipsp_address(union sockaddr_union); /* TDB management routines */ extern void tdb_add_inp(struct tdb *tdb, struct inpcb *inp); extern u_int32_t reserve_spi(u_int32_t, u_int32_t, union sockaddr_union *, union sockaddr_union *, u_int8_t, int *); extern struct tdb *gettdb(u_int32_t, union sockaddr_union *, u_int8_t); extern void puttdb(struct tdb *); extern void tdb_delete(struct tdb *, int, int); extern int tdb_init(struct tdb *, u_int16_t, struct ipsecinit *); extern void tdb_expiration(struct tdb *, int); /* Flag values for the last argument of tdb_expiration(). */ #define TDBEXP_EARLY 1 /* The tdb is likely to end up early. */ #define TDBEXP_TIMEOUT 2 /* Maintain expiration timeout. */ extern int tdb_walk(int (*)(struct tdb *, void *), void *); extern void handle_expirations(void *); /* Flow management routines */ extern struct flow *get_flow(void); extern void put_flow(struct flow *, struct tdb *, int); extern void delete_flow(struct flow *, struct tdb *, int); extern struct flow *find_flow(union sockaddr_union *, union sockaddr_union *, union sockaddr_union *, union sockaddr_union *, u_int8_t, struct tdb *, int); extern struct flow *find_global_flow(union sockaddr_union *, union sockaddr_union *, union sockaddr_union *, union sockaddr_union *, u_int8_t); /* XF_IP4 */ extern int ipe4_attach(void); extern int ipe4_init(struct tdb *, struct xformsw *, struct ipsecinit *); extern int ipe4_zeroize(struct tdb *); extern int ipip_output(struct mbuf *, struct tdb *, struct mbuf **, int, int); extern void ipe4_input __P((struct mbuf *, ...)); extern void ipip_input __P((struct mbuf *, int)); #ifdef INET extern void ip4_input __P((struct mbuf *, ...)); #endif /* INET */ #ifdef INET6 extern int ip4_input6 __P((struct mbuf **, int *, int)); #endif /* INET */ /* XF_ETHERIP */ extern int etherip_output(struct mbuf *, struct tdb *, struct mbuf **, int, int); extern void etherip_input __P((struct mbuf *, ...)); /* XF_AH */ extern int ah_attach(void); extern int ah_init(struct tdb *, struct xformsw *, struct ipsecinit *); extern int ah_zeroize(struct tdb *); extern int ah_output(struct mbuf *, struct tdb *, struct mbuf **, int, int); extern int ah_output_cb(void *); extern int ah_input(struct mbuf *, struct tdb *, int, int); extern int ah_input_cb(void *); extern int ah_sysctl(int *, u_int, void *, size_t *, void *, size_t); extern int ah_massage_headers(struct mbuf **, int, int, int, int); #ifdef INET extern void ah4_input __P((struct mbuf *, ...)); extern int ah4_input_cb __P((struct mbuf *, ...)); #endif /* INET */ #ifdef INET6 extern int ah6_input __P((struct mbuf **, int *, int)); extern int ah6_input_cb __P((struct mbuf *, int)); #endif /* INET6 */ /* XF_ESP */ extern int esp_attach(void); extern int esp_init(struct tdb *, struct xformsw *, struct ipsecinit *); extern int esp_zeroize(struct tdb *); extern int esp_output(struct mbuf *, struct tdb *, struct mbuf **, int, int); extern int esp_output_cb(void *); extern int esp_input(struct mbuf *, struct tdb *, int, int); extern int esp_input_cb(void *); extern int esp_sysctl(int *, u_int, void *, size_t *, void *, size_t); #ifdef INET extern void esp4_input __P((struct mbuf *, ...)); extern int esp4_input_cb __P((struct mbuf *, ...)); #endif /* INET */ #ifdef INET6 extern int esp6_input __P((struct mbuf **, int *, int)); extern int esp6_input_cb __P((struct mbuf *, int)); #endif /* INET6 */ /* XF_TCPSIGNATURE */ extern int tcp_signature_tdb_attach __P((void)); extern int tcp_signature_tdb_init __P((struct tdb *, struct xformsw *, struct ipsecinit *)); extern int tcp_signature_tdb_zeroize __P((struct tdb *)); extern int tcp_signature_tdb_input __P((struct mbuf *, struct tdb *, int, int)); extern int tcp_signature_tdb_output __P((struct mbuf *, struct tdb *, struct mbuf **, int, int)); /* Padding */ extern caddr_t m_pad(struct mbuf *, int, int); /* Replay window */ extern int checkreplaywindow32(u_int32_t, u_int32_t, u_int32_t *, u_int32_t, u_int32_t *); extern unsigned char ipseczeroes[]; /* Packet processing */ extern int ipsp_process_packet(struct mbuf *, struct tdb *, int, int); extern int ipsp_process_done(struct mbuf *, struct tdb *); extern int ipsec_common_input_cb(struct mbuf *, struct tdb *, int, int); #endif /* _KERNEL */ #endif /* _NETINET_IPSP_H_ */