net.h@ 45485

Last change on this file since 45485 was 45120, checked in by vboxsync, 12 years ago
inserted the blank lines I asked for and a todo.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 24.6 KB

Line
1	/** @file
2	* IPRT - Network Protocols.
3	*/
4
5	/*
6	* Copyright (C) 2008-2013 Oracle Corporation
7	*
8	* This file is part of VirtualBox Open Source Edition (OSE), as
9	* available from http://www.virtualbox.org. This file is free software;
10	* you can redistribute it and/or modify it under the terms of the GNU
11	* General Public License (GPL) as published by the Free Software
12	* Foundation, in version 2 as it comes in the "COPYING" file of the
13	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15	*
16	* The contents of this file may alternatively be used under the terms
17	* of the Common Development and Distribution License Version 1.0
18	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19	* VirtualBox OSE distribution, in which case the provisions of the
20	* CDDL are applicable instead of those of the GPL.
21	*
22	* You may elect to license modified versions of this file under the
23	* terms and conditions of either the GPL or the CDDL or both.
24	*/
25
26	#ifndef ___iprt_net_h
27	#define ___iprt_net_h
28
29	#include <iprt/cdefs.h>
30	#include <iprt/types.h>
31	#include <iprt/assert.h>
32
33
34	RT_C_DECLS_BEGIN
35
36	/** @defgroup grp_rt_net RTNet - Network Protocols
37	* @ingroup grp_rt
38	* @{
39	*/
40
41	/**
42	* IPv4 address.
43	*/
44	typedef RTUINT32U RTNETADDRIPV4;
45	AssertCompileSize(RTNETADDRIPV4, 4);
46	/** Pointer to a IPv4 address. */
47	typedef RTNETADDRIPV4 *PRTNETADDRIPV4;
48	/** Pointer to a const IPv4 address. */
49	typedef RTNETADDRIPV4 const *PCRTNETADDRIPV4;
50
51	/**
52	* Tests if the given string is an IPv4 address.
53	*
54	* @returns boolean.
55	* @param pszAddress String which may be an IPv4 address.
56	*/
57	RTDECL(bool) RTNetIsIPv4AddrStr(const char *pszAddress);
58
59	/**
60	* Converts an stringified IPv4 address into the RTNETADDRIPV4 representation.
61	*
62	* @returns VINF_SUCCESS on success, VERR_INVALID_PARAMETER on
63	* failure.
64	*
65	* @param pszAddr The value to convert.
66	* @param pAddr Where to store the result.
67	*/
68	RTDECL(int) RTNetStrToIPv4Addr(const char *pszAddr, PRTNETADDRIPV4 pAddr);
69
70
71	/**
72	* IPv6 address.
73	*/
74	typedef RTUINT128U RTNETADDRIPV6;
75	AssertCompileSize(RTNETADDRIPV6, 16);
76	/** Pointer to a IPv6 address. */
77	typedef RTNETADDRIPV6 *PRTNETADDRIPV6;
78	/** Pointer to a const IPv6 address. */
79	typedef RTNETADDRIPV6 const *PCRTNETADDRIPV6;
80
81	/**
82	* Tests if the given string is a valid IPv6 address.
83	*
84	* @returns @c true if it is, @c false if not.
85	* @param pszAddress String which may be an IPv6 address.
86	*/
87	RTDECL(bool) RTNetIsIPv6AddrStr(const char *pszAddress);
88
89
90	/**
91	* IPX address.
92	*/
93	#pragma pack(1)
94	typedef struct RTNETADDRIPX
95	{
96	/** The network ID. */
97	uint32_t Network;
98	/** The node ID. (Defaults to the MAC address apparently.) */
99	RTMAC Node;
100	} RTNETADDRIPX;
101	#pragma pack()
102	AssertCompileSize(RTNETADDRIPX, 4+6);
103	/** Pointer to an IPX address. */
104	typedef RTNETADDRIPX *PRTNETADDRIPX;
105	/** Pointer to a const IPX address. */
106	typedef RTNETADDRIPX const *PCRTNETADDRIPX;
107
108	/**
109	* Network address union.
110	*
111	* @remarks The size of this structure may change in the future.
112	*/
113	typedef union RTNETADDRU
114	{
115	/** 64-bit view. */
116	uint64_t au64[2];
117	/** 32-bit view. */
118	uint32_t au32[4];
119	/** 16-bit view. */
120	uint16_t au16[8];
121	/** 8-bit view. */
122	uint8_t au8[16];
123	/** IPv4 view. */
124	RTNETADDRIPV4 IPv4;
125	#ifndef IPv6 /* Work around X11 and RDP defining IPv6 to 1. */
126	/** IPv6 view. */
127	RTNETADDRIPV6 IPv6;
128	#endif
129	/** IPX view. */
130	RTNETADDRIPX Ipx;
131	/** MAC address view. */
132	RTMAC Mac;
133	} RTNETADDRU;
134	AssertCompileSize(RTNETADDRU, 16);
135	/** Pointer to an address union. */
136	typedef RTNETADDRU *PRTNETADDRU;
137	/** Pointer to a const address union. */
138	typedef RTNETADDRU const *PCRTNETADDRU;
139
140	/**
141	* Network address type.
142	*
143	* @remarks The value assignments may change in the future.
144	*/
145	typedef enum RTNETADDRTYPE
146	{
147	/** The invalid 0 entry. */
148	RTNETADDRTYPE_INVALID = 0,
149	/** IP version 4. */
150	RTNETADDRTYPE_IPV4,
151	/** IP version 6. */
152	RTNETADDRTYPE_IPV6,
153	/** IPX. */
154	RTNETADDRTYPE_IPX,
155	/** MAC address. */
156	RTNETADDRTYPE_MAC,
157	/** The end of the valid values. */
158	RTNETADDRTYPE_END,
159	/** The usual 32-bit hack. */
160	RTNETADDRTYPE_32_BIT_HACK = 0x7fffffff
161	} RTNETADDRTYPE;
162	/** Pointer to a network address type. */
163	typedef RTNETADDRTYPE *PRTNETADDRTYPE;
164	/** Pointer to a const network address type. */
165	typedef RTNETADDRTYPE const *PCRTNETADDRTYPE;
166
167	/**
168	* Network address.
169	*
170	* @remarks The size and type values may change.
171	*/
172	typedef struct RTNETADDR
173	{
174	/** The address union. */
175	RTNETADDRU uAddr;
176	/** Indicates which view of @a u that is valid. */
177	RTNETADDRTYPE enmType;
178	/** The port number for IPv4 and IPv6 addresses. This is set to
179	* RTNETADDR_NA_PORT if not applicable. */
180	uint32_t uPort;
181	} RTNETADDR;
182	/** Pointer to a network address. */
183	typedef RTNETADDR *PRTNETADDR;
184	/** Pointer to a const network address. */
185	typedef RTNETADDR const *PCRTNETADDR;
186
187	/** The not applicable value of RTNETADDR::uPort value use to inid. */
188	#define RTNETADDR_PORT_NA UINT32_MAX
189
190	/**
191	* Ethernet header.
192	*/
193	#pragma pack(1)
194	typedef struct RTNETETHERHDR
195	{
196	RTMAC DstMac;
197	RTMAC SrcMac;
198	/** Ethernet frame type or frame size, depending on the kind of ethernet.
199	* This is big endian on the wire. */
200	uint16_t EtherType;
201	} RTNETETHERHDR;
202	#pragma pack()
203	AssertCompileSize(RTNETETHERHDR, 14);
204	/** Pointer to an ethernet header. */
205	typedef RTNETETHERHDR *PRTNETETHERHDR;
206	/** Pointer to a const ethernet header. */
207	typedef RTNETETHERHDR const *PCRTNETETHERHDR;
208
209	/** @name EtherType (RTNETETHERHDR::EtherType)
210	* @{ */
211	#define RTNET_ETHERTYPE_IPV4 UINT16_C(0x0800)
212	#define RTNET_ETHERTYPE_ARP UINT16_C(0x0806)
213	#define RTNET_ETHERTYPE_IPV6 UINT16_C(0x86dd)
214	#define RTNET_ETHERTYPE_VLAN UINT16_C(0x8100)
215	#define RTNET_ETHERTYPE_IPX_1 UINT16_C(0x8037)
216	#define RTNET_ETHERTYPE_IPX_2 UINT16_C(0x8137)
217	#define RTNET_ETHERTYPE_IPX_3 UINT16_C(0x8138)
218	/** @} */
219
220
221	/**
222	* IPv4 header.
223	* All is bigendian on the wire.
224	*/
225	#pragma pack(1)
226	typedef struct RTNETIPV4
227	{
228	#ifdef RT_BIG_ENDIAN
229	unsigned int ip_v : 4;
230	unsigned int ip_hl : 4;
231	unsigned int ip_tos : 8;
232	unsigned int ip_len : 16;
233	#else
234	/** 00:0 - Header length given as a 32-bit word count. */
235	unsigned int ip_hl : 4;
236	/** 00:4 - Header version. */
237	unsigned int ip_v : 4;
238	/** 01 - Type of service. */
239	unsigned int ip_tos : 8;
240	/** 02 - Total length (header + data). */
241	unsigned int ip_len : 16;
242	#endif
243	/** 04 - Packet idenficiation. */
244	uint16_t ip_id;
245	/** 06 - Offset if fragmented. */
246	uint16_t ip_off;
247	/** 08 - Time to live. */
248	uint8_t ip_ttl;
249	/** 09 - Protocol. */
250	uint8_t ip_p;
251	/** 0a - Header check sum. */
252	uint16_t ip_sum;
253	/** 0c - Source address. */
254	RTNETADDRIPV4 ip_src;
255	/** 10 - Destination address. */
256	RTNETADDRIPV4 ip_dst;
257	/** 14 - Options (optional). */
258	uint32_t ip_options[1];
259	} RTNETIPV4;
260	#pragma pack()
261	AssertCompileSize(RTNETIPV4, 6 * 4);
262	/** Pointer to a IPv4 header. */
263	typedef RTNETIPV4 *PRTNETIPV4;
264	/** Pointer to a const IPv4 header. */
265	typedef RTNETIPV4 const *PCRTNETIPV4;
266
267	/** The minimum IPv4 header length (in bytes).
268	* Up to and including RTNETIPV4::ip_dst. */
269	#define RTNETIPV4_MIN_LEN (20)
270
271
272	/** @name IPv4 Protocol Numbers
273	* @{ */
274	/** IPv4: ICMP */
275	#define RTNETIPV4_PROT_ICMP (1)
276	/** IPv4: TCP */
277	#define RTNETIPV4_PROT_TCP (6)
278	/** IPv4: UDP */
279	#define RTNETIPV4_PROT_UDP (17)
280	/** @} */
281
282	/** @name Common IPv4 Port Assignments
283	* @{
284	*/
285	/** Boostrap Protocol / DHCP) Server. */
286	#define RTNETIPV4_PORT_BOOTPS (67)
287	/** Boostrap Protocol / DHCP) Client. */
288	#define RTNETIPV4_PORT_BOOTPC (68)
289	/** @} */
290
291	/** @name IPv4 Flags
292	* @{ */
293	/** IPv4: Don't fragment */
294	#define RTNETIPV4_FLAGS_DF (0x4000)
295	/** IPv4: More fragments */
296	#define RTNETIPV4_FLAGS_MF (0x2000)
297	/** @} */
298
299	RTDECL(uint16_t) RTNetIPv4HdrChecksum(PCRTNETIPV4 pIpHdr);
300	RTDECL(bool) RTNetIPv4IsHdrValid(PCRTNETIPV4 pIpHdr, size_t cbHdrMax, size_t cbPktMax, bool fChecksum);
301	RTDECL(uint32_t) RTNetIPv4PseudoChecksum(PCRTNETIPV4 pIpHdr);
302	RTDECL(uint32_t) RTNetIPv4PseudoChecksumBits(RTNETADDRIPV4 SrcAddr, RTNETADDRIPV4 DstAddr, uint8_t bProtocol, uint16_t cbPkt);
303	RTDECL(uint32_t) RTNetIPv4AddDataChecksum(void const pvData, size_t cbData, uint32_t u32Sum, bool pfOdd);
304	RTDECL(uint16_t) RTNetIPv4FinalizeChecksum(uint32_t u32Sum);
305
306
307	/**
308	* IPv6 header.
309	* All is bigendian on the wire.
310	*/
311	#pragma pack(1)
312	typedef struct RTNETIPV6
313	{
314	/** Version (4 bits), Traffic Class (8 bits) and Flow Lable (20 bits).
315	* @todo this is probably mislabeled - ip6_flow vs. ip6_vfc, fix later. */
316	uint32_t ip6_vfc;
317	/** 04 - Payload length, including extension headers. */
318	uint16_t ip6_plen;
319	/** 06 - Next header type (RTNETIPV4_PROT_XXX). */
320	uint8_t ip6_nxt;
321	/** 07 - Hop limit. */
322	uint8_t ip6_hlim;
323	/** xx - Source address. */
324	RTNETADDRIPV6 ip6_src;
325	/** xx - Destination address. */
326	RTNETADDRIPV6 ip6_dst;
327	} RTNETIPV6;
328	#pragma pack()
329	AssertCompileSize(RTNETIPV6, 8 + 16 + 16);
330	/** Pointer to a IPv6 header. */
331	typedef RTNETIPV6 *PRTNETIPV6;
332	/** Pointer to a const IPv6 header. */
333	typedef RTNETIPV6 const *PCRTNETIPV6;
334
335	/** The minimum IPv6 header length (in bytes).
336	* Up to and including RTNETIPV6::ip6_dst. */
337	#define RTNETIPV6_MIN_LEN (40)
338
339	RTDECL(uint32_t) RTNetIPv6PseudoChecksum(PCRTNETIPV6 pIpHdr);
340	RTDECL(uint32_t) RTNetIPv6PseudoChecksumEx(PCRTNETIPV6 pIpHdr, uint8_t bProtocol, uint16_t cbPkt);
341	RTDECL(uint32_t) RTNetIPv6PseudoChecksumBits(PCRTNETADDRIPV6 pSrcAddr, PCRTNETADDRIPV6 pDstAddr,
342	uint8_t bProtocol, uint16_t cbPkt);
343
344
345	/**
346	* UDP header.
347	*/
348	#pragma pack(1)
349	typedef struct RTNETUDP
350	{
351	/** The source port. */
352	uint16_t uh_sport;
353	/** The destination port. */
354	uint16_t uh_dport;
355	/** The length of the UDP header and associated data. */
356	uint16_t uh_ulen;
357	/** The checksum of the pseudo header, the UDP header and the data. */
358	uint16_t uh_sum;
359	} RTNETUDP;
360	#pragma pack()
361	AssertCompileSize(RTNETUDP, 8);
362	/** Pointer to an UDP header. */
363	typedef RTNETUDP *PRTNETUDP;
364	/** Pointer to a const UDP header. */
365	typedef RTNETUDP const *PCRTNETUDP;
366
367	/** The minimum UDP packet length (in bytes). (RTNETUDP::uh_ulen) */
368	#define RTNETUDP_MIN_LEN (8)
369
370	RTDECL(uint16_t) RTNetUDPChecksum(uint32_t u32Sum, PCRTNETUDP pUdpHdr);
371	RTDECL(uint32_t) RTNetIPv4AddUDPChecksum(PCRTNETUDP pUdpHdr, uint32_t u32Sum);
372	RTDECL(uint16_t) RTNetIPv4UDPChecksum(PCRTNETIPV4 pIpHdr, PCRTNETUDP pUdpHdr, void const *pvData);
373	RTDECL(bool) RTNetIPv4IsUDPSizeValid(PCRTNETIPV4 pIpHdr, PCRTNETUDP pUdpHdr, size_t cbPktMax);
374	RTDECL(bool) RTNetIPv4IsUDPValid(PCRTNETIPV4 pIpHdr, PCRTNETUDP pUdpHdr, void const *pvData, size_t cbPktMax, bool fChecksum);
375
376
377	/**
378	* IPv4 BOOTP / DHCP packet.
379	*/
380	#pragma pack(1)
381	typedef struct RTNETBOOTP
382	{
383	/** 00 - The packet opcode (RTNETBOOTP_OP_). /
384	uint8_t bp_op;
385	/** 01 - Hardware address type. Same as RTNETARPHDR::ar_htype. */
386	uint8_t bp_htype;
387	/** 02 - Hardware address length. */
388	uint8_t bp_hlen;
389	/** 03 - Gateway hops. */
390	uint8_t bp_hops;
391	/** 04 - Transaction ID. */
392	uint32_t bp_xid;
393	/** 08 - Seconds since boot started. */
394	uint16_t bp_secs;
395	/** 0a - Unused (BOOTP) / Flags (DHCP) (RTNET_DHCP_FLAGS_). /
396	uint16_t bp_flags;
397	/** 0c - Client IPv4 address. */
398	RTNETADDRIPV4 bp_ciaddr;
399	/** 10 - Your IPv4 address. */
400	RTNETADDRIPV4 bp_yiaddr;
401	/** 14 - Server IPv4 address. */
402	RTNETADDRIPV4 bp_siaddr;
403	/** 18 - Gateway IPv4 address. */
404	RTNETADDRIPV4 bp_giaddr;
405	/** 1c - Client hardware address. */
406	union
407	{
408	uint8_t au8[16];
409	RTMAC Mac;
410	} bp_chaddr;
411	/** 2c - Server name. */
412	uint8_t bp_sname[64];
413	/** 6c - File name / more DHCP options. */
414	uint8_t bp_file[128];
415	/** ec - Vendor specific area (BOOTP) / Options (DHCP).
416	* @remark This is really 312 bytes in the DHCP version. */
417	union
418	{
419	uint8_t au8[128];
420	struct DHCP
421	{
422	/** ec - The DHCP cookie (RTNET_DHCP_COOKIE). */
423	uint32_t dhcp_cookie;
424	/** f0 - The DHCP options. */
425	uint8_t dhcp_opts[124];
426	} Dhcp;
427	} bp_vend;
428
429	} RTNETBOOTP;
430	#pragma pack()
431	AssertCompileSize(RTNETBOOTP, 0xec + 128);
432	/** Pointer to a BOOTP / DHCP packet. */
433	typedef RTNETBOOTP *PRTNETBOOTP;
434	/** Pointer to a const BOOTP / DHCP packet. */
435	typedef RTNETBOOTP const *PCRTNETBOOTP;
436
437	/** Minimum BOOTP packet length. For quick validation, no standard thing really. */
438	#define RTNETBOOTP_MIN_LEN 0xec
439	/** Minimum DHCP packet length. For quick validation, no standard thing really. */
440	#define RTNETBOOTP_DHCP_MIN_LEN 0xf1
441
442	/** The normal size of the a DHCP packet (i.e. a RTNETBOOTP).
443	* Same as RTNET_DHCP_OPT_SIZE, just expressed differently. */
444	#define RTNET_DHCP_NORMAL_SIZE (0xec + 4 + RTNET_DHCP_OPT_SIZE)
445	/** The normal size of RTNETBOOTP::bp_vend::Dhcp::dhcp_opts. */
446	#define RTNET_DHCP_OPT_SIZE (312 - 4)
447
448	/** @name BOOTP packet opcode values
449	* @{ */
450	#define RTNETBOOTP_OP_REQUEST 1
451	#define RTNETBOOTP_OP_REPLY 2
452	/** @} */
453
454	/** @name DHCP flags (RTNETBOOTP::bp_flags)
455	* @{ */
456	#define RTNET_DHCP_FLAGS_NO_BROADCAST UINT16_C(0x8000) /** @todo check test!!! */
457	/** @} */
458
459	/** The DHCP cookie (network endian). */
460	#define RTNET_DHCP_COOKIE UINT32_C(0x63825363)
461
462	/**
463	* An IPv4 DHCP option header.
464	*/
465	typedef struct RTNETDHCPOPT
466	{
467	/** 00 - The DHCP option. */
468	uint8_t dhcp_opt;
469	/** 01 - The data length (excluding this header). */
470	uint8_t dhcp_len;
471	/* 02 - The option data follows here, optional and of variable length. */
472	} RTNETDHCPOPT;
473	AssertCompileSize(RTNETDHCPOPT, 2);
474	/** Pointer to a DHCP option header. */
475	typedef RTNETDHCPOPT *PRTNETDHCPOPT;
476	/** Pointer to a const DHCP option header. */
477	typedef RTNETDHCPOPT const *PCRTNETDHCPOPT;
478
479	/** @name DHCP options
480	* @{ */
481	/** 1 byte padding, this has no dhcp_len field. */
482	#define RTNET_DHCP_OPT_PAD 0
483
484	/** The subnet mask. */
485	#define RTNET_DHCP_OPT_SUBNET_MASK 1
486	/** The time offset. */
487	#define RTNET_DHCP_OPT_TIME_OFFSET 2
488	/** The routers for the subnet. */
489	#define RTNET_DHCP_OPT_ROUTERS 3
490	/** Domain Name Server. */
491	#define RTNET_DHCP_OPT_DNS 6
492	/** Host name. */
493	#define RTNET_DHCP_OPT_HOST_NAME 12
494	/** Domain name. */
495	#define RTNET_DHCP_OPT_DOMAIN_NAME 15
496
497	/** The requested address. */
498	#define RTNET_DHCP_OPT_REQ_ADDR 50
499	/** The lease time in seconds. */
500	#define RTNET_DHCP_OPT_LEASE_TIME 51
501	/** Option overload.
502	* Indicates that the bp_file and/or bp_sname holds contains DHCP options. */
503	#define RTNET_DHCP_OPT_OPTION_OVERLOAD 52
504	/** Have a 8-bit message type value as data, see RTNET_DHCP_MT_. /
505	#define RTNET_DHCP_OPT_MSG_TYPE 53
506	/** Server ID. */
507	#define RTNET_DHCP_OPT_SERVER_ID 54
508	/** Parameter request list. */
509	#define RTNET_DHCP_OPT_PARAM_REQ_LIST 55
510	/** The maximum DHCP message size a client is willing to accept. */
511	#define RTNET_DHCP_OPT_MAX_DHCP_MSG_SIZE 57
512	/** Client ID. */
513	#define RTNET_DHCP_OPT_CLIENT_ID 61
514	/** TFTP server name. */
515	#define RTNET_DHCP_OPT_TFTP_SERVER_NAME 66
516	/** Bootfile name. */
517	#define RTNET_DHCP_OPT_BOOTFILE_NAME 67
518
519	/** Marks the end of the DHCP options, this has no dhcp_len field. */
520	#define RTNET_DHCP_OPT_END 255
521	/** @} */
522
523	/** @name DHCP Message Types (option 53)
524	* @{ */
525	#define RTNET_DHCP_MT_DISCOVER 1
526	#define RTNET_DHCP_MT_OFFER 2
527	#define RTNET_DHCP_MT_REQUEST 3
528	#define RTNET_DHCP_MT_DECLINE 4
529	#define RTNET_DHCP_MT_ACK 5
530	#define RTNET_DHCP_MT_NAC 6
531	#define RTNET_DHCP_MT_RELEASE 7
532	#define RTNET_DHCP_MT_INFORM 8
533	/** @} */
534
535	/** @name DHCP Flags
536	* @{ */
537	#define RTNET_DHCP_FLAG_BROADCAST 0x8000
538	/** @} */
539
540	RTDECL(bool) RTNetIPv4IsDHCPValid(PCRTNETUDP pUdpHdr, PCRTNETBOOTP pDhcp, size_t cbDhcp, uint8_t *pMsgType);
541
542
543	/**
544	* IPv4 DHCP packet.
545	* @deprecated Use RTNETBOOTP.
546	*/
547	#pragma pack(1)
548	typedef struct RTNETDHCP
549	{
550	/** 00 - The packet opcode. */
551	uint8_t Op;
552	/** Hardware address type. */
553	uint8_t HType;
554	/** Hardware address length. */
555	uint8_t HLen;
556	uint8_t Hops;
557	uint32_t XID;
558	uint16_t Secs;
559	uint16_t Flags;
560	/** Client IPv4 address. */
561	RTNETADDRIPV4 CIAddr;
562	/** Your IPv4 address. */
563	RTNETADDRIPV4 YIAddr;
564	/** Server IPv4 address. */
565	RTNETADDRIPV4 SIAddr;
566	/** Gateway IPv4 address. */
567	RTNETADDRIPV4 GIAddr;
568	/** Client hardware address. */
569	uint8_t CHAddr[16];
570	/** Server name. */
571	uint8_t SName[64];
572	uint8_t File[128];
573	uint8_t abMagic[4];
574	uint8_t DhcpOpt;
575	uint8_t DhcpLen; /* 1 */
576	uint8_t DhcpReq;
577	uint8_t abOptions[57];
578	} RTNETDHCP;
579	#pragma pack()
580	/** @todo AssertCompileSize(RTNETDHCP, ); */
581	/** Pointer to a DHCP packet. */
582	typedef RTNETDHCP *PRTNETDHCP;
583	/** Pointer to a const DHCP packet. */
584	typedef RTNETDHCP const *PCRTNETDHCP;
585
586
587	/**
588	* TCP packet.
589	*/
590	#pragma pack(1)
591	typedef struct RTNETTCP
592	{
593	/** 00 - The source port. */
594	uint16_t th_sport;
595	/** 02 - The destination port. */
596	uint16_t th_dport;
597	/** 04 - The sequence number. */
598	uint32_t th_seq;
599	/** 08 - The acknowledgement number. */
600	uint32_t th_ack;
601	#ifdef RT_BIG_ENDIAN
602	unsigned int th_win : 16;
603	unsigned int th_flags : 8;
604	unsigned int th_off : 4;
605	unsigned int th_x2 : 4;
606	#else
607	/** 0c:0 - Reserved. */
608	unsigned int th_x2 : 4;
609	/** 0c:4 - The data offset given as a dword count from the start of this header. */
610	unsigned int th_off : 4;
611	/** 0d - flags. */
612	unsigned int th_flags : 8;
613	/** 0e - The window. */
614	unsigned int th_win : 16;
615	#endif
616	/** 10 - The checksum of the pseudo header, the TCP header and the data. */
617	uint16_t th_sum;
618	/** 12 - The urgent pointer. */
619	uint16_t th_urp;
620	/* (options follows here and then the data (aka text).) */
621	} RTNETTCP;
622	#pragma pack()
623	AssertCompileSize(RTNETTCP, 20);
624	/** Pointer to a TCP packet. */
625	typedef RTNETTCP *PRTNETTCP;
626	/** Pointer to a const TCP packet. */
627	typedef RTNETTCP const *PCRTNETTCP;
628
629	/** The minimum TCP header length (in bytes). (RTNETTCP::th_off * 4) */
630	#define RTNETTCP_MIN_LEN (20)
631
632	/** @name TCP flags (RTNETTCP::th_flags)
633	* @{ */
634	#define RTNETTCP_F_FIN 0x01
635	#define RTNETTCP_F_SYN 0x02
636	#define RTNETTCP_F_RST 0x04
637	#define RTNETTCP_F_PSH 0x08
638	#define RTNETTCP_F_ACK 0x10
639	#define RTNETTCP_F_URG 0x20
640	#define RTNETTCP_F_ECE 0x40
641	#define RTNETTCP_F_CWR 0x80
642	/** @} */
643
644	RTDECL(uint16_t) RTNetTCPChecksum(uint32_t u32Sum, PCRTNETTCP pTcpHdr, void const *pvData, size_t cbData);
645	RTDECL(uint32_t) RTNetIPv4AddTCPChecksum(PCRTNETTCP pTcpHdr, uint32_t u32Sum);
646	RTDECL(uint16_t) RTNetIPv4TCPChecksum(PCRTNETIPV4 pIpHdr, PCRTNETTCP pTcpHdr, void const *pvData);
647	RTDECL(bool) RTNetIPv4IsTCPSizeValid(PCRTNETIPV4 pIpHdr, PCRTNETTCP pTcpHdr, size_t cbHdrMax, size_t cbPktMax);
648	RTDECL(bool) RTNetIPv4IsTCPValid(PCRTNETIPV4 pIpHdr, PCRTNETTCP pTcpHdr, size_t cbHdrMax, void const *pvData,
649	size_t cbPktMax, bool fChecksum);
650
651
652	/**
653	* IPv4 ICMP packet header.
654	*/
655	#pragma pack(1)
656	typedef struct RTNETICMPV4HDR
657	{
658	/** 00 - The ICMP message type. */
659	uint8_t icmp_type;
660	/** 01 - Type specific code that further qualifies the message. */
661	uint8_t icmp_code;
662	/** 02 - Checksum of the ICMP message. */
663	uint16_t icmp_cksum;
664	} RTNETICMPV4HDR;
665	#pragma pack()
666	AssertCompileSize(RTNETICMPV4HDR, 4);
667	/** Pointer to an ICMP packet header. */
668	typedef RTNETICMPV4HDR *PRTNETICMPV4HDR;
669	/** Pointer to a const ICMP packet header. */
670	typedef RTNETICMPV4HDR const *PCRTNETICMPV4HDR;
671
672	/** @name ICMP (v4) message types.
673	* @{ */
674	#define RTNETICMPV4_TYPE_ECHO_REPLY 0
675	#define RTNETICMPV4_TYPE_ECHO_REQUEST 8
676	#define RTNETICMPV4_TYPE_TRACEROUTE 30
677	/** @} */
678
679	/**
680	* IPv4 ICMP ECHO Reply & Request packet.
681	*/
682	#pragma pack(1)
683	typedef struct RTNETICMPV4ECHO
684	{
685	/** 00 - The ICMP header. */
686	RTNETICMPV4HDR Hdr;
687	/** 04 - The identifier to help the requestor match up the reply.
688	* Can be 0. Typically fixed value. */
689	uint16_t icmp_id;
690	/** 06 - The sequence number to help the requestor match up the reply.
691	* Can be 0. Typically incrementing between requests. */
692	uint16_t icmp_seq;
693	/** 08 - Variable length data that is to be returned unmodified in the reply. */
694	uint8_t icmp_data[1];
695	} RTNETICMPV4ECHO;
696	#pragma pack()
697	AssertCompileSize(RTNETICMPV4ECHO, 9);
698	/** Pointer to an ICMP ECHO packet. */
699	typedef RTNETICMPV4ECHO *PRTNETICMPV4ECHO;
700	/** Pointer to a const ICMP ECHO packet. */
701	typedef RTNETICMPV4ECHO const *PCRTNETICMPV4ECHO;
702
703	/**
704	* IPv4 ICMP TRACEROUTE packet.
705	* This is an reply to an IP packet with the traceroute option set.
706	*/
707	#pragma pack(1)
708	typedef struct RTNETICMPV4TRACEROUTE
709	{
710	/** 00 - The ICMP header. */
711	RTNETICMPV4HDR Hdr;
712	/** 04 - Identifier copied from the traceroute option's ID number. */
713	uint16_t icmp_id;
714	/** 06 - Unused. (Possibly an icmp_seq?) */
715	uint16_t icmp_void;
716	/** 08 - Outbound hop count. From the IP packet causing this message. */
717	uint16_t icmp_ohc;
718	/** 0a - Return hop count. From the IP packet causing this message. */
719	uint16_t icmp_rhc;
720	/** 0c - Output link speed, 0 if not known. */
721	uint32_t icmp_speed;
722	/** 10 - Output link MTU, 0 if not known. */
723	uint32_t icmp_mtu;
724	} RTNETICMPV4TRACEROUTE;
725	#pragma pack()
726	AssertCompileSize(RTNETICMPV4TRACEROUTE, 20);
727	/** Pointer to an ICMP TRACEROUTE packet. */
728	typedef RTNETICMPV4TRACEROUTE *PRTNETICMPV4TRACEROUTE;
729	/** Pointer to a const ICMP TRACEROUTE packet. */
730	typedef RTNETICMPV4TRACEROUTE const *PCRTNETICMPV4TRACEROUTE;
731
732	/** @todo add more ICMPv4 as needed. */
733
734	/**
735	* IPv4 ICMP union packet.
736	*/
737	typedef union RTNETICMPV4
738	{
739	RTNETICMPV4HDR Hdr;
740	RTNETICMPV4ECHO Echo;
741	RTNETICMPV4TRACEROUTE Traceroute;
742	} RTNETICMPV4;
743	/** Pointer to an ICMP union packet. */
744	typedef RTNETICMPV4 *PRTNETICMPV4;
745	/** Pointer to a const ICMP union packet. */
746	typedef RTNETICMPV4 const *PCRTNETICMPV4;
747
748
749	/** @todo add ICMPv6 when needed. */
750
751
752	/**
753	* Ethernet ARP header.
754	*/
755	#pragma pack(1)
756	typedef struct RTNETARPHDR
757	{
758	/** The hardware type. */
759	uint16_t ar_htype;
760	/** The protocol type (ethertype). */
761	uint16_t ar_ptype;
762	/** The hardware address length. */
763	uint8_t ar_hlen;
764	/** The protocol address length. */
765	uint8_t ar_plen;
766	/** The operation. */
767	uint16_t ar_oper;
768	} RTNETARPHDR;
769	#pragma pack()
770	AssertCompileSize(RTNETARPHDR, 8);
771	/** Pointer to an ethernet ARP header. */
772	typedef RTNETARPHDR *PRTNETARPHDR;
773	/** Pointer to a const ethernet ARP header. */
774	typedef RTNETARPHDR const *PCRTNETARPHDR;
775
776	/** ARP hardware type - ethernet. */
777	#define RTNET_ARP_ETHER UINT16_C(1)
778
779	/** @name ARP operations
780	* @{ */
781	#define RTNET_ARPOP_REQUEST UINT16_C(1) /*< Request hardware address given a protocol address (ARP). /
782	#define RTNET_ARPOP_REPLY UINT16_C(2)
783	#define RTNET_ARPOP_REVREQUEST UINT16_C(3) /*< Request protocol address given a hardware address (RARP). /
784	#define RTNET_ARPOP_REVREPLY UINT16_C(4)
785	#define RTNET_ARPOP_INVREQUEST UINT16_C(8) /*< Inverse ARP. /
786	#define RTNET_ARPOP_INVREPLY UINT16_C(9)
787	/** Check if an ARP operation is a request or not. */
788	#define RTNET_ARPOP_IS_REQUEST(Op) ((Op) & 1)
789	/** Check if an ARP operation is a reply or not. */
790	#define RTNET_ARPOP_IS_REPLY(Op) (!RTNET_ARPOP_IS_REQUEST(Op))
791	/** @} */
792
793
794	/**
795	* Ethernet IPv4 + 6-byte MAC ARP request packet.
796	*/
797	#pragma pack(1)
798	typedef struct RTNETARPIPV4
799	{
800	/** ARP header. */
801	RTNETARPHDR Hdr;
802	/** The sender hardware address. */
803	RTMAC ar_sha;
804	/** The sender protocol address. */
805	RTNETADDRIPV4 ar_spa;
806	/** The target hardware address. */
807	RTMAC ar_tha;
808	/** The arget protocol address. */
809	RTNETADDRIPV4 ar_tpa;
810	} RTNETARPIPV4;
811	#pragma pack()
812	AssertCompileSize(RTNETARPIPV4, 8+6+4+6+4);
813	/** Pointer to an ethernet IPv4+MAC ARP request packet. */
814	typedef RTNETARPIPV4 *PRTNETARPIPV4;
815	/** Pointer to a const ethernet IPv4+MAC ARP request packet. */
816	typedef RTNETARPIPV4 const *PCRTNETARPIPV4;
817
818
819	/** @todo RTNETNDP (IPv6)*/
820
821
822	/** @} */
823
824	RT_C_DECLS_END
825
826	#endif
827

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/include/iprt/net.h@ 45485

Download in other formats: