net.h@ 45115

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

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

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

Download in other formats: