[qemu.git] / slirp / ip6_icmp.h

/*
 * Copyright (c) 2013
 * Guillaume Subiron, Yann Bordenave, Serigne Modou Wagne.
 */

#ifndef SLIRP_IP6_ICMP_H
#define SLIRP_IP6_ICMP_H

/*
 * Interface Control Message Protocol version 6 Definitions.
 * Per RFC 4443, March 2006.
 *
 * Network Discover Protocol Definitions.
 * Per RFC 4861, September 2007.
 */

struct icmp6_echo { /* Echo Messages */
    uint16_t id;
    uint16_t seq_num;
};

union icmp6_error_body {
    uint32_t unused;
    uint32_t pointer;
    uint32_t mtu;
};

/*
 * NDP Messages
 */
struct ndp_rs {     /* Router Solicitation Message */
    uint32_t reserved;
};

struct ndp_ra {     /* Router Advertisement Message */
    uint8_t chl;    /* Cur Hop Limit */
#ifdef HOST_WORDS_BIGENDIAN
    uint8_t
        M:1,
        O:1,
        reserved:6;
#else
    uint8_t
        reserved:6,
        O:1,
        M:1;
#endif
    uint16_t lifetime;      /* Router Lifetime */
    uint32_t reach_time;    /* Reachable Time */
    uint32_t retrans_time;  /* Retrans Timer */
} QEMU_PACKED;

struct ndp_ns {     /* Neighbor Solicitation Message */
    uint32_t reserved;
    struct in6_addr target; /* Target Address */
} QEMU_PACKED;

struct ndp_na {     /* Neighbor Advertisement Message */
#ifdef HOST_WORDS_BIGENDIAN
    uint32_t
        R:1,                /* Router Flag */
        S:1,                /* Solicited Flag */
        O:1,                /* Override Flag */
        reserved_hi:5,
        reserved_lo:24;
#else
    uint32_t
        reserved_hi:5,
        O:1,
        S:1,
        R:1,
        reserved_lo:24;
#endif
    struct in6_addr target; /* Target Address */
} QEMU_PACKED;

struct ndp_redirect {
    uint32_t reserved;
    struct in6_addr target; /* Target Address */
    struct in6_addr dest;   /* Destination Address */
} QEMU_PACKED;

/*
 * Structure of an icmpv6 header.
 */
struct icmp6 {
    uint8_t     icmp6_type;         /* type of message, see below */
    uint8_t     icmp6_code;         /* type sub code */
    uint16_t    icmp6_cksum;        /* ones complement cksum of struct */
    union {
        union icmp6_error_body error_body;
        struct icmp6_echo echo;
        struct ndp_rs ndp_rs;
        struct ndp_ra ndp_ra;
        struct ndp_ns ndp_ns;
        struct ndp_na ndp_na;
        struct ndp_redirect ndp_redirect;
    } icmp6_body;
#define icmp6_err icmp6_body.error_body
#define icmp6_echo icmp6_body.echo
#define icmp6_nrs icmp6_body.ndp_rs
#define icmp6_nra icmp6_body.ndp_ra
#define icmp6_nns icmp6_body.ndp_ns
#define icmp6_nna icmp6_body.ndp_na
#define icmp6_redirect icmp6_body.ndp_redirect
} QEMU_PACKED;

#define ICMP6_MINLEN    4
#define ICMP6_ERROR_MINLEN  8
#define ICMP6_ECHO_MINLEN   8
#define ICMP6_NDP_RS_MINLEN 8
#define ICMP6_NDP_RA_MINLEN 16
#define ICMP6_NDP_NS_MINLEN 24
#define ICMP6_NDP_NA_MINLEN 24
#define ICMP6_NDP_REDIRECT_MINLEN 40

/*
 * NDP Options
 */
struct ndpopt {
    uint8_t     ndpopt_type;                    /* Option type */
    uint8_t     ndpopt_len;                     /* /!\ In units of 8 octets */
    union {
        unsigned char   linklayer_addr[6];      /* Source/Target Link-layer */
#define ndpopt_linklayer ndpopt_body.linklayer_addr
        struct prefixinfo {                     /* Prefix Information */
            uint8_t     prefix_length;
#ifdef HOST_WORDS_BIGENDIAN
            uint8_t     L:1, A:1, reserved1:6;
#else
            uint8_t     reserved1:6, A:1, L:1;
#endif
            uint32_t    valid_lt;               /* Valid Lifetime */
            uint32_t    pref_lt;                /* Preferred Lifetime */
            uint32_t    reserved2;
            struct in6_addr prefix;
        } QEMU_PACKED prefixinfo;
#define ndpopt_prefixinfo ndpopt_body.prefixinfo
        struct rdnss {
            uint16_t reserved;
            uint32_t lifetime;
            struct in6_addr addr;
        } QEMU_PACKED rdnss;
#define ndpopt_rdnss ndpopt_body.rdnss
    } ndpopt_body;
} QEMU_PACKED;

/* NDP options type */
#define NDPOPT_LINKLAYER_SOURCE     1   /* Source Link-Layer Address */
#define NDPOPT_LINKLAYER_TARGET     2   /* Target Link-Layer Address */
#define NDPOPT_PREFIX_INFO          3   /* Prefix Information */
#define NDPOPT_RDNSS                25  /* Recursive DNS Server Address */

/* NDP options size, in octets. */
#define NDPOPT_LINKLAYER_LEN    8
#define NDPOPT_PREFIXINFO_LEN   32
#define NDPOPT_RDNSS_LEN        24

/*
 * Definition of type and code field values.
 * Per https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xml
 * Last Updated 2012-11-12
 */

/* Errors */
#define ICMP6_UNREACH   1   /* Destination Unreachable */
#define     ICMP6_UNREACH_NO_ROUTE      0   /* no route to dest */
#define     ICMP6_UNREACH_DEST_PROHIB   1   /* com with dest prohibited */
#define     ICMP6_UNREACH_SCOPE         2   /* beyond scope of src addr */
#define     ICMP6_UNREACH_ADDRESS       3   /* address unreachable */
#define     ICMP6_UNREACH_PORT          4   /* port unreachable */
#define     ICMP6_UNREACH_SRC_FAIL      5   /* src addr failed */
#define     ICMP6_UNREACH_REJECT_ROUTE  6   /* reject route to dest */
#define     ICMP6_UNREACH_SRC_HDR_ERROR 7   /* error in src routing header */
#define ICMP6_TOOBIG    2   /* Packet Too Big */
#define ICMP6_TIMXCEED  3   /* Time Exceeded */
#define     ICMP6_TIMXCEED_INTRANS      0   /* hop limit exceeded in transit */
#define     ICMP6_TIMXCEED_REASS        1   /* ttl=0 in reass */
#define ICMP6_PARAMPROB 4   /* Parameter Problem */
#define     ICMP6_PARAMPROB_HDR_FIELD   0   /* err header field */
#define     ICMP6_PARAMPROB_NXTHDR_TYPE 1   /* unrecognized Next Header type */
#define     ICMP6_PARAMPROB_IPV6_OPT    2   /* unrecognized IPv6 option */

/* Informational Messages */
#define ICMP6_ECHO_REQUEST      128 /* Echo Request */
#define ICMP6_ECHO_REPLY        129 /* Echo Reply */
#define ICMP6_NDP_RS            133 /* Router Solicitation (NDP) */
#define ICMP6_NDP_RA            134 /* Router Advertisement (NDP) */
#define ICMP6_NDP_NS            135 /* Neighbor Solicitation (NDP) */
#define ICMP6_NDP_NA            136 /* Neighbor Advertisement (NDP) */
#define ICMP6_NDP_REDIRECT      137 /* Redirect Message (NDP) */

/*
 * Router Configuration Variables (rfc4861#section-6)
 */
#define NDP_IsRouter                1
#define NDP_AdvSendAdvertisements   1
#define NDP_MaxRtrAdvInterval       600000
#define NDP_MinRtrAdvInterval       ((NDP_MaxRtrAdvInterval >= 9) ? \
                                        NDP_MaxRtrAdvInterval / 3 : \
                                        NDP_MaxRtrAdvInterval)
#define NDP_AdvManagedFlag          0
#define NDP_AdvOtherConfigFlag      0
#define NDP_AdvLinkMTU              0
#define NDP_AdvReachableTime        0
#define NDP_AdvRetransTime          0
#define NDP_AdvCurHopLimit          64
#define NDP_AdvDefaultLifetime      ((3 * NDP_MaxRtrAdvInterval) / 1000)
#define NDP_AdvValidLifetime        86400
#define NDP_AdvOnLinkFlag           1
#define NDP_AdvPrefLifetime         14400
#define NDP_AdvAutonomousFlag       1

void icmp6_init(Slirp *slirp);
void icmp6_cleanup(Slirp *slirp);
void icmp6_input(struct mbuf *);
void icmp6_send_error(struct mbuf *m, uint8_t type, uint8_t code);
void ndp_send_ra(Slirp *slirp);
void ndp_send_ns(Slirp *slirp, struct in6_addr addr);

#endif
Commit	Line	Data
0d6ff71a GS	1	/*
	2	* Copyright (c) 2013
	3	* Guillaume Subiron, Yann Bordenave, Serigne Modou Wagne.
	4	*/
	5
121d0712 MA	6	#ifndef SLIRP_IP6_ICMP_H
121d0712 MA	7	#define SLIRP_IP6_ICMP_H
0d6ff71a GS	8
	9	/*
	10	* Interface Control Message Protocol version 6 Definitions.
	11	* Per RFC 4443, March 2006.
	12	*
	13	* Network Discover Protocol Definitions.
	14	* Per RFC 4861, September 2007.
	15	*/
	16
	17	struct icmp6_echo { /* Echo Messages */
	18	uint16_t id;
	19	uint16_t seq_num;
	20	};
	21
fc6c9257 YB	22	union icmp6_error_body {
	23	uint32_t unused;
	24	uint32_t pointer;
	25	uint32_t mtu;
	26	};
	27
0d6ff71a GS	28	/*
	29	* NDP Messages
	30	*/
	31	struct ndp_rs { /* Router Solicitation Message */
	32	uint32_t reserved;
	33	};
	34
	35	struct ndp_ra { /* Router Advertisement Message */
	36	uint8_t chl; /* Cur Hop Limit */
	37	#ifdef HOST_WORDS_BIGENDIAN
	38	uint8_t
	39	M:1,
	40	O:1,
	41	reserved:6;
	42	#else
	43	uint8_t
	44	reserved:6,
	45	O:1,
	46	M:1;
	47	#endif
	48	uint16_t lifetime; /* Router Lifetime */
	49	uint32_t reach_time; /* Reachable Time */
	50	uint32_t retrans_time; /* Retrans Timer */
	51	} QEMU_PACKED;
	52
	53	struct ndp_ns { /* Neighbor Solicitation Message */
	54	uint32_t reserved;
	55	struct in6_addr target; /* Target Address */
	56	} QEMU_PACKED;
	57
	58	struct ndp_na { /* Neighbor Advertisement Message */
	59	#ifdef HOST_WORDS_BIGENDIAN
	60	uint32_t
	61	R:1, /* Router Flag */
	62	S:1, /* Solicited Flag */
	63	O:1, /* Override Flag */
	64	reserved_hi:5,
	65	reserved_lo:24;
	66	#else
	67	uint32_t
	68	reserved_hi:5,
	69	O:1,
	70	S:1,
	71	R:1,
	72	reserved_lo:24;
	73	#endif
	74	struct in6_addr target; /* Target Address */
	75	} QEMU_PACKED;
	76
	77	struct ndp_redirect {
	78	uint32_t reserved;
	79	struct in6_addr target; /* Target Address */
	80	struct in6_addr dest; /* Destination Address */
	81	} QEMU_PACKED;
	82
	83	/*
	84	* Structure of an icmpv6 header.
	85	*/
	86	struct icmp6 {
	87	uint8_t icmp6_type; /* type of message, see below */
	88	uint8_t icmp6_code; /* type sub code */
	89	uint16_t icmp6_cksum; /* ones complement cksum of struct */
	90	union {
fc6c9257	91	union icmp6_error_body error_body;
0d6ff71a GS	92	struct icmp6_echo echo;
	93	struct ndp_rs ndp_rs;
	94	struct ndp_ra ndp_ra;
	95	struct ndp_ns ndp_ns;
	96	struct ndp_na ndp_na;
	97	struct ndp_redirect ndp_redirect;
	98	} icmp6_body;
fc6c9257	99	#define icmp6_err icmp6_body.error_body
0d6ff71a GS	100	#define icmp6_echo icmp6_body.echo
	101	#define icmp6_nrs icmp6_body.ndp_rs
	102	#define icmp6_nra icmp6_body.ndp_ra
	103	#define icmp6_nns icmp6_body.ndp_ns
	104	#define icmp6_nna icmp6_body.ndp_na
	105	#define icmp6_redirect icmp6_body.ndp_redirect
	106	} QEMU_PACKED;
	107
	108	#define ICMP6_MINLEN 4
fc6c9257	109	#define ICMP6_ERROR_MINLEN 8
0d6ff71a GS	110	#define ICMP6_ECHO_MINLEN 8
	111	#define ICMP6_NDP_RS_MINLEN 8
	112	#define ICMP6_NDP_RA_MINLEN 16
	113	#define ICMP6_NDP_NS_MINLEN 24
	114	#define ICMP6_NDP_NA_MINLEN 24
	115	#define ICMP6_NDP_REDIRECT_MINLEN 40
	116
	117	/*
	118	* NDP Options
	119	*/
	120	struct ndpopt {
	121	uint8_t ndpopt_type; /* Option type */
	122	uint8_t ndpopt_len; /* /!\ In units of 8 octets */
	123	union {
	124	unsigned char linklayer_addr[6]; /* Source/Target Link-layer */
f7725df3	125	#define ndpopt_linklayer ndpopt_body.linklayer_addr
0d6ff71a GS	126	struct prefixinfo { /* Prefix Information */
	127	uint8_t prefix_length;
	128	#ifdef HOST_WORDS_BIGENDIAN
	129	uint8_t L:1, A:1, reserved1:6;
	130	#else
	131	uint8_t reserved1:6, A:1, L:1;
	132	#endif
	133	uint32_t valid_lt; /* Valid Lifetime */
	134	uint32_t pref_lt; /* Preferred Lifetime */
	135	uint32_t reserved2;
	136	struct in6_addr prefix;
	137	} QEMU_PACKED prefixinfo;
0d6ff71a	138	#define ndpopt_prefixinfo ndpopt_body.prefixinfo
f7725df3 ST	139	struct rdnss {
	140	uint16_t reserved;
	141	uint32_t lifetime;
	142	struct in6_addr addr;
	143	} QEMU_PACKED rdnss;
	144	#define ndpopt_rdnss ndpopt_body.rdnss
	145	} ndpopt_body;
0d6ff71a GS	146	} QEMU_PACKED;
	147
	148	/* NDP options type */
	149	#define NDPOPT_LINKLAYER_SOURCE 1 /* Source Link-Layer Address */
	150	#define NDPOPT_LINKLAYER_TARGET 2 /* Target Link-Layer Address */
	151	#define NDPOPT_PREFIX_INFO 3 /* Prefix Information */
f7725df3	152	#define NDPOPT_RDNSS 25 /* Recursive DNS Server Address */
0d6ff71a GS	153
	154	/* NDP options size, in octets. */
	155	#define NDPOPT_LINKLAYER_LEN 8
	156	#define NDPOPT_PREFIXINFO_LEN 32
f7725df3	157	#define NDPOPT_RDNSS_LEN 24
0d6ff71a GS	158
	159	/*
	160	* Definition of type and code field values.
	161	* Per https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xml
	162	* Last Updated 2012-11-12
	163	*/
	164
	165	/* Errors */
	166	#define ICMP6_UNREACH 1 /* Destination Unreachable */
	167	#define ICMP6_UNREACH_NO_ROUTE 0 /* no route to dest */
	168	#define ICMP6_UNREACH_DEST_PROHIB 1 /* com with dest prohibited */
	169	#define ICMP6_UNREACH_SCOPE 2 /* beyond scope of src addr */
	170	#define ICMP6_UNREACH_ADDRESS 3 /* address unreachable */
	171	#define ICMP6_UNREACH_PORT 4 /* port unreachable */
	172	#define ICMP6_UNREACH_SRC_FAIL 5 /* src addr failed */
	173	#define ICMP6_UNREACH_REJECT_ROUTE 6 /* reject route to dest */
	174	#define ICMP6_UNREACH_SRC_HDR_ERROR 7 /* error in src routing header */
	175	#define ICMP6_TOOBIG 2 /* Packet Too Big */
	176	#define ICMP6_TIMXCEED 3 /* Time Exceeded */
	177	#define ICMP6_TIMXCEED_INTRANS 0 /* hop limit exceeded in transit */
	178	#define ICMP6_TIMXCEED_REASS 1 /* ttl=0 in reass */
	179	#define ICMP6_PARAMPROB 4 /* Parameter Problem */
	180	#define ICMP6_PARAMPROB_HDR_FIELD 0 /* err header field */
	181	#define ICMP6_PARAMPROB_NXTHDR_TYPE 1 /* unrecognized Next Header type */
	182	#define ICMP6_PARAMPROB_IPV6_OPT 2 /* unrecognized IPv6 option */
	183
	184	/* Informational Messages */
	185	#define ICMP6_ECHO_REQUEST 128 /* Echo Request */
	186	#define ICMP6_ECHO_REPLY 129 /* Echo Reply */
	187	#define ICMP6_NDP_RS 133 /* Router Solicitation (NDP) */
	188	#define ICMP6_NDP_RA 134 /* Router Advertisement (NDP) */
	189	#define ICMP6_NDP_NS 135 /* Neighbor Solicitation (NDP) */
	190	#define ICMP6_NDP_NA 136 /* Neighbor Advertisement (NDP) */
	191	#define ICMP6_NDP_REDIRECT 137 /* Redirect Message (NDP) */
	192
	193	/*
	194	* Router Configuration Variables (rfc4861#section-6)
	195	*/
	196	#define NDP_IsRouter 1
	197	#define NDP_AdvSendAdvertisements 1
	198	#define NDP_MaxRtrAdvInterval 600000
	199	#define NDP_MinRtrAdvInterval ((NDP_MaxRtrAdvInterval >= 9) ? \
	200	NDP_MaxRtrAdvInterval / 3 : \
	201	NDP_MaxRtrAdvInterval)
	202	#define NDP_AdvManagedFlag 0
	203	#define NDP_AdvOtherConfigFlag 0
	204	#define NDP_AdvLinkMTU 0
	205	#define NDP_AdvReachableTime 0
	206	#define NDP_AdvRetransTime 0
	207	#define NDP_AdvCurHopLimit 64
	208	#define NDP_AdvDefaultLifetime ((3 * NDP_MaxRtrAdvInterval) / 1000)
	209	#define NDP_AdvValidLifetime 86400
	210	#define NDP_AdvOnLinkFlag 1
	211	#define NDP_AdvPrefLifetime 14400
	212	#define NDP_AdvAutonomousFlag 1
	213
	214	void icmp6_init(Slirp *slirp);
	215	void icmp6_cleanup(Slirp *slirp);
	216	void icmp6_input(struct mbuf *);
fc6c9257	217	void icmp6_send_error(struct mbuf *m, uint8_t type, uint8_t code);
0d6ff71a GS	218	void ndp_send_ra(Slirp *slirp);
	219	void ndp_send_ns(Slirp *slirp, struct in6_addr addr);
	220
	221	#endif