Use <stdlib.h> instead of the deprecated and non-portable <malloc.h>.
[wine] / dlls / icmp / icmp_main.c
1 /*
2  * ICMP
3  *
4  * Francois Gouget, 1999, based on the work of
5  *   RW Hall, 1999, based on public domain code PING.C by Mike Muus (1983) 
6  *   and later works (c) 1989 Regents of Univ. of California - see copyright 
7  *   notice at end of source-code.
8  */
9
10 /* Future work:
11  * - Systems like FreeBSD don't seem to support the IP_TTL option and maybe others.
12  *   But using IP_HDRINCL and building the IP header by hand might work.
13  * - Not all IP options are supported.
14  * - Are ICMP handles real handles, i.e. inheritable and all? There might be some 
15  *   more work to do here, including server side stuff with synchronization.
16  * - Is it correct to use malloc for the internal buffer, for allocating the 
17  *   handle's structure?
18  * - This API should probably be thread safe. Is it really?
19  * - Using the winsock functions has not been tested.
20  */
21
22 #include "config.h"
23
24 #include <sys/types.h>
25 #ifdef HAVE_SYS_SOCKET_H
26 # include <sys/socket.h>
27 #endif
28 #include <netdb.h>
29 #include <netinet/in_systm.h>
30 #ifdef HAVE_NETINET_IN_H
31 # include <netinet/in.h>
32 #endif
33
34 #include <sys/time.h>
35 #include <stdlib.h>
36 #include <string.h>
37 #include <errno.h>
38 #include <unistd.h>
39 #ifdef HAVE_ARPA_INET_H
40 # include <arpa/inet.h>
41 #endif
42
43 #include "windef.h"
44 #include "winbase.h"
45 #ifdef ICMP_WIN
46 #include "winsock.h"
47 #endif
48
49 #include "winerror.h"
50 #include "wine/ipexport.h"
51 #include "wine/icmpapi.h"
52 #include "debugtools.h"
53
54 /* Set up endiannes macros for the ip and ip_icmp BSD headers */
55 #ifndef BIG_ENDIAN
56 #define BIG_ENDIAN       4321
57 #endif
58 #ifndef LITTLE_ENDIAN
59 #define LITTLE_ENDIAN    1234
60 #endif
61 #ifndef BYTE_ORDER
62 #ifdef WORDS_BIGENDIAN
63 #define BYTE_ORDER       BIG_ENDIAN
64 #else
65 #define BYTE_ORDER       LITTLE_ENDIAN
66 #endif
67 #endif /* BYTE_ORDER */
68
69 #define u_int16_t  WORD
70 #define u_int32_t  DWORD
71
72 /* These are BSD headers. We use these here because they are needed on 
73  * libc5 Linux systems. On other platforms they are usually simply more 
74  * complete than the native stuff, and cause less portability problems 
75  * so we use them anyway.
76  */
77 #include "ip.h"
78 #include "ip_icmp.h"
79
80
81 DEFAULT_DEBUG_CHANNEL(icmp)
82
83 /* Define the following macro to use the winsock functions */
84 /*#define ICMP_WIN*/
85
86 #ifdef ICMP_WIN
87 /* FIXME: should we include winsock.h ???*/
88 SOCKET WINAPI WINSOCK_socket(INT af, INT type, INT protocol);
89 INT WINAPI WINSOCK_sendto(SOCKET s, char *buf, INT len, INT flags, struct sockaddr *to, INT tolen);
90 INT WINAPI WINSOCK_recvfrom(SOCKET s, char *buf,INT len, INT flags, struct sockaddr *from, INT *fromlen32);
91 INT WINAPI WINSOCK_shutdown(SOCKET s, INT how);
92 #endif
93
94
95 #ifdef ICMP_WIN
96 #define ISOCK_SOCKET                SOCKET
97 #define ISOCK_ISVALID(a)            ((a)!=INVALID_SOCKET)
98 #define ISOCK_getsockopt(a,b,c,d,e) WINSOCK_getsockopt(a,b,c,d,e)
99 #define ISOCK_recvfrom(a,b,c,d,e,f) WINSOCK_recvfrom(a,b,c,d,e,f)
100 #define ISOCK_select(a,b,c,d,e)     WINSOCK_select(a,b,c,d,e)
101 #define ISOCK_sendto(a,b,c,d,e,f)   WINSOCK_sendto(a,b,c,d,e,f)
102 #define ISOCK_setsockopt(a,b,c,d,e) WINSOCK_setsockopt(a,b,c,d,e)
103 #define ISOCK_shutdown(a,b)         WINSOCK_shutdown(a,b)
104 #define ISOCK_socket(a,b,c)         WINSOCK_socket(a,b,c)
105 #else
106 #define ISOCK_SOCKET                int
107 #define ISOCK_ISVALID(a)            ((a)>=0)
108 #define ISOCK_getsockopt(a,b,c,d,e) getsockopt(a,b,c,d,e)
109 #define ISOCK_recvfrom(a,b,c,d,e,f) recvfrom(a,b,c,d,e,f)
110 #define ISOCK_select(a,b,c,d,e)     select(a,b,c,d,e)
111 #define ISOCK_setsockopt(a,b,c,d,e) setsockopt(a,b,c,d,e)
112 #define ISOCK_sendto(a,b,c,d,e,f)   sendto(a,b,c,d,e,f)
113 #define ISOCK_shutdown(a,b)         shutdown(a,b)
114 #define ISOCK_socket(a,b,c)         socket(a,b,c)
115 #endif
116
117 typedef struct {
118     ISOCK_SOCKET sid;
119     IP_OPTION_INFORMATION default_opts;
120 } icmp_t;
121
122 #define IP_OPTS_UNKNOWN     0
123 #define IP_OPTS_DEFAULT     1
124 #define IP_OPTS_CUSTOM      2
125
126 /* The sequence number is unique process wide, so that all threads 
127  * have a distinct sequence number.
128  */
129 static LONG icmp_sequence=0;
130
131 static int in_cksum(u_short *addr, int len)
132 {
133     int nleft=len;
134     u_short *w = addr;
135     int sum = 0;
136     u_short answer = 0;
137
138     while (nleft > 1) {
139         sum += *w++;
140         nleft -= 2;
141     }
142
143     if (nleft == 1) {
144         *(u_char *)(&answer) = *(u_char *)w;
145         sum += answer;
146     }
147
148     sum = (sum >> 16) + (sum & 0xffff);
149     sum  += (sum >> 16);
150     answer = ~sum;
151     return(answer);
152 }
153
154
155
156 /*
157  * Exported Routines.
158  */
159
160 /***********************************************************************
161  *              IcmpCreateFile
162  */
163 HANDLE WINAPI IcmpCreateFile(VOID)
164 {
165     icmp_t* icp;
166
167     ISOCK_SOCKET sid=ISOCK_socket(AF_INET,SOCK_RAW,IPPROTO_ICMP);
168     if (!ISOCK_ISVALID(sid)) {
169         MESSAGE("WARNING: Trying to use ICMP will fail unless running as root\n");
170         SetLastError(ERROR_ACCESS_DENIED);
171         return INVALID_HANDLE_VALUE;
172     }
173
174     icp=malloc(sizeof(*icp));
175     if (icp==NULL) {
176         SetLastError(IP_NO_RESOURCES);
177         return INVALID_HANDLE_VALUE;
178     }
179     icp->sid=sid;
180     icp->default_opts.OptionsSize=IP_OPTS_UNKNOWN;
181     return (HANDLE)icp;
182 }
183
184
185 /***********************************************************************
186  *              IcmpCloseHandle
187  */
188 BOOL WINAPI IcmpCloseHandle(HANDLE  IcmpHandle)
189 {
190     icmp_t* icp=(icmp_t*)IcmpHandle;
191     if (IcmpHandle==INVALID_HANDLE_VALUE) {
192         /* FIXME: in fact win98 seems to ignore the handle value !!! */
193         SetLastError(ERROR_INVALID_HANDLE);
194         return FALSE;
195     }
196
197     ISOCK_shutdown(icp->sid,2);
198     free(icp);
199     return TRUE;
200 }
201
202
203 /***********************************************************************
204  *              IcmpSendEcho
205  */
206 DWORD WINAPI IcmpSendEcho(
207     HANDLE                   IcmpHandle,
208     IPAddr                   DestinationAddress,
209     LPVOID                   RequestData,
210     WORD                     RequestSize,
211     PIP_OPTION_INFORMATION   RequestOptions,
212     LPVOID                   ReplyBuffer,
213     DWORD                    ReplySize,
214     DWORD                    Timeout
215     )
216 {
217     icmp_t* icp=(icmp_t*)IcmpHandle;
218     unsigned char* reqbuf;
219     int reqsize;
220
221     struct icmp_echo_reply* ier;
222     struct ip* ip_header;
223     struct icmp* icmp_header;
224     char* endbuf;
225     int ip_header_len;
226     int maxlen;
227     fd_set fdr;
228     struct timeval timeout,send_time,recv_time;
229     struct sockaddr_in addr;
230     int addrlen;
231     unsigned short id,seq,cksum;
232     int res;
233
234     if (IcmpHandle==INVALID_HANDLE_VALUE) {
235         /* FIXME: in fact win98 seems to ignore the handle value !!! */
236         SetLastError(ERROR_INVALID_HANDLE);
237         return 0;
238     }
239
240     if (ReplySize<sizeof(ICMP_ECHO_REPLY)+ICMP_MINLEN) {
241         SetLastError(IP_BUF_TOO_SMALL);
242         return 0;
243     }
244     /* check the request size against SO_MAX_MSG_SIZE using getsockopt */
245
246     /* Prepare the request */
247     id=getpid() & 0xFFFF;
248     seq=InterlockedIncrement(&icmp_sequence) & 0xFFFF;
249
250     reqsize=ICMP_MINLEN+RequestSize;
251     reqbuf=malloc(reqsize);
252     if (reqbuf==NULL) {
253         SetLastError(ERROR_OUTOFMEMORY);
254         return 0;
255     }
256
257     icmp_header=(struct icmp*)reqbuf;
258     icmp_header->icmp_type=ICMP_ECHO;
259     icmp_header->icmp_code=0;
260     icmp_header->icmp_cksum=0;
261     icmp_header->icmp_id=id;
262     icmp_header->icmp_seq=seq;
263     memcpy(reqbuf+ICMP_MINLEN, RequestData, RequestSize);
264     icmp_header->icmp_cksum=cksum=in_cksum((u_short*)reqbuf,reqsize);
265
266     addr.sin_family=AF_INET;
267     addr.sin_addr.s_addr=DestinationAddress;
268     addr.sin_port=0;
269
270     if (RequestOptions!=NULL) {
271         int val;
272         if (icp->default_opts.OptionsSize==IP_OPTS_UNKNOWN) {
273             int len;
274             /* Before we mess with the options, get the default values */
275             len=sizeof(val);
276             ISOCK_getsockopt(icp->sid,IPPROTO_IP,IP_TTL,(char *)&val,&len);
277             icp->default_opts.Ttl=val;
278
279             len=sizeof(val);
280             ISOCK_getsockopt(icp->sid,IPPROTO_IP,IP_TOS,(char *)&val,&len);
281             icp->default_opts.Tos=val;
282             /* FIXME: missing: handling of IP 'flags', and all the other options */
283         }
284
285         val=RequestOptions->Ttl;
286         ISOCK_setsockopt(icp->sid,IPPROTO_IP,IP_TTL,(char *)&val,sizeof(val));
287         val=RequestOptions->Tos;
288         ISOCK_setsockopt(icp->sid,IPPROTO_IP,IP_TOS,(char *)&val,sizeof(val));
289         /* FIXME:  missing: handling of IP 'flags', and all the other options */
290
291         icp->default_opts.OptionsSize=IP_OPTS_CUSTOM;
292     } else if (icp->default_opts.OptionsSize==IP_OPTS_CUSTOM) {
293         int val;
294
295         /* Restore the default options */
296         val=icp->default_opts.Ttl;
297         ISOCK_setsockopt(icp->sid,IPPROTO_IP,IP_TTL,(char *)&val,sizeof(val));
298         val=icp->default_opts.Tos;
299         ISOCK_setsockopt(icp->sid,IPPROTO_IP,IP_TOS,(char *)&val,sizeof(val));
300         /* FIXME: missing: handling of IP 'flags', and all the other options */
301
302         icp->default_opts.OptionsSize=IP_OPTS_DEFAULT;
303     }
304
305     /* Get ready for receiving the reply
306      * Do it before we send the request to minimize the risk of introducing delays
307      */
308     FD_ZERO(&fdr);
309     FD_SET(icp->sid,&fdr);
310     timeout.tv_sec=Timeout/1000;
311     timeout.tv_usec=(Timeout % 1000)*1000;
312     addrlen=sizeof(addr);
313     ier=ReplyBuffer;
314     ip_header=(struct ip *) ((char *) ReplyBuffer+sizeof(ICMP_ECHO_REPLY));
315     endbuf=(char *) ReplyBuffer+ReplySize;
316     maxlen=ReplySize-sizeof(ICMP_ECHO_REPLY);
317
318     /* Send the packet */
319     TRACE("Sending %d bytes (RequestSize=%d) to %s\n", reqsize, RequestSize, inet_ntoa(addr.sin_addr));
320 #if 0
321     if (TRACE_ON(icmp)){
322         unsigned char* buf=(unsigned char*)reqbuf;
323         int i;
324         printf("Output buffer:\n");
325         for (i=0;i<reqsize;i++)
326             printf("%2x,", buf[i]);
327         printf("\n");
328     }
329 #endif
330
331     gettimeofday(&send_time,NULL);
332     res=ISOCK_sendto(icp->sid, reqbuf, reqsize, 0, (struct sockaddr*)&addr, sizeof(addr));
333     free(reqbuf);
334     if (res<0) {
335         if (errno==EMSGSIZE)
336             SetLastError(IP_PACKET_TOO_BIG);
337         else {
338             switch (errno) {
339             case ENETUNREACH:
340                 SetLastError(IP_DEST_NET_UNREACHABLE);
341                 break;
342             case EHOSTUNREACH:
343                 SetLastError(IP_DEST_NET_UNREACHABLE);
344                 break;
345             default:
346                 TRACE("unknown error: errno=%d\n",errno);
347                 SetLastError(ERROR_UNKNOWN);
348             }
349         }
350         return 0;
351     }
352
353     /* Get the reply */
354     ip_header_len=0; /* because gcc was complaining */
355     while ((res=ISOCK_select(icp->sid+1,&fdr,NULL,NULL,&timeout))>0) {
356         gettimeofday(&recv_time,NULL);
357         res=ISOCK_recvfrom(icp->sid, (char*)ip_header, maxlen, 0, (struct sockaddr*)&addr,&addrlen);
358         TRACE("received %d bytes from %s\n",res, inet_ntoa(addr.sin_addr));
359         ier->Status=IP_REQ_TIMED_OUT;
360
361         /* Check whether we should ignore this packet */
362         if ((ip_header->ip_p==IPPROTO_ICMP) && (res>=sizeof(struct ip)+ICMP_MINLEN)) {
363             ip_header_len=ip_header->ip_hl << 2;
364             icmp_header=(struct icmp*)(((char*)ip_header)+ip_header_len);
365             TRACE("received an ICMP packet of type,code=%d,%d\n",icmp_header->icmp_type,icmp_header->icmp_code);
366             if (icmp_header->icmp_type==ICMP_ECHOREPLY) {
367                 if ((icmp_header->icmp_id==id) && (icmp_header->icmp_seq==seq))
368                     ier->Status=IP_SUCCESS;
369             } else {
370                 switch (icmp_header->icmp_type) {
371                 case ICMP_UNREACH:
372                     switch (icmp_header->icmp_code) {
373                     case ICMP_UNREACH_HOST:
374 #ifdef ICMP_UNREACH_HOST_UNKNOWN
375                     case ICMP_UNREACH_HOST_UNKNOWN:
376 #endif
377 #ifdef ICMP_UNREACH_ISOLATED
378                     case ICMP_UNREACH_ISOLATED:
379 #endif
380 #ifdef ICMP_UNREACH_HOST_PROHIB
381                     case ICMP_UNREACH_HOST_PROHIB:
382 #endif
383 #ifdef ICMP_UNREACH_TOSHOST
384                     case ICMP_UNREACH_TOSHOST:
385 #endif
386                         ier->Status=IP_DEST_HOST_UNREACHABLE;
387                         break;
388                     case ICMP_UNREACH_PORT:
389                         ier->Status=IP_DEST_PORT_UNREACHABLE;
390                         break;
391                     case ICMP_UNREACH_PROTOCOL:
392                         ier->Status=IP_DEST_PROT_UNREACHABLE;
393                         break;
394                     case ICMP_UNREACH_SRCFAIL:
395                         ier->Status=IP_BAD_ROUTE;
396                         break;
397                     default:
398                         ier->Status=IP_DEST_NET_UNREACHABLE;
399                     }
400                     break;
401                 case ICMP_TIMXCEED:
402                     if (icmp_header->icmp_code==ICMP_TIMXCEED_REASS)
403                         ier->Status=IP_TTL_EXPIRED_REASSEM;
404                     else
405                         ier->Status=IP_TTL_EXPIRED_TRANSIT;
406                     break;
407                 case ICMP_PARAMPROB:
408                     ier->Status=IP_PARAM_PROBLEM;
409                     break;
410                 case ICMP_SOURCEQUENCH:
411                     ier->Status=IP_SOURCE_QUENCH;
412                     break;
413                 }
414                 if (ier->Status!=IP_REQ_TIMED_OUT) {
415                     struct ip* rep_ip_header;
416                     struct icmp* rep_icmp_header;
417                     /* The ICMP header size of all the packets we accept is the same */
418                     rep_ip_header=(struct ip*)(((char*)icmp_header)+ICMP_MINLEN);
419                     rep_icmp_header=(struct icmp*)(((char*)rep_ip_header)+(rep_ip_header->ip_hl << 2));
420
421                     /* Make sure that this is really a reply to our packet */
422                     if (ip_header_len+ICMP_MINLEN+(rep_ip_header->ip_hl << 2)+ICMP_MINLEN>ip_header->ip_len) {
423                         ier->Status=IP_REQ_TIMED_OUT;
424                     } else if ((rep_icmp_header->icmp_type!=ICMP_ECHO) ||
425                         (rep_icmp_header->icmp_code!=0) ||
426                         (rep_icmp_header->icmp_id!=id) ||
427                         (rep_icmp_header->icmp_seq!=seq) ||
428                         (rep_icmp_header->icmp_cksum!=cksum)) {
429                         /* This was not a reply to one of our packets after all */
430                         TRACE("skipping type,code=%d,%d id,seq=%d,%d cksum=%d\n",
431                             rep_icmp_header->icmp_type,rep_icmp_header->icmp_code,
432                             rep_icmp_header->icmp_id,rep_icmp_header->icmp_seq,
433                             rep_icmp_header->icmp_cksum);
434                         TRACE("expected type,code=8,0 id,seq=%d,%d cksum=%d\n",
435                             id,seq,
436                             cksum);
437                         ier->Status=IP_REQ_TIMED_OUT;
438                     }
439                 }
440             }                
441         }
442
443         if (ier->Status==IP_REQ_TIMED_OUT) {
444             /* This packet was not for us.
445              * Decrease the timeout so that we don't enter an endless loop even
446              * if we get flooded with ICMP packets that are not for us.
447              */
448             timeout.tv_sec=Timeout/1000-(recv_time.tv_sec-send_time.tv_sec);
449             timeout.tv_usec=(Timeout % 1000)*1000+send_time.tv_usec-(recv_time.tv_usec-send_time.tv_usec);
450             if (timeout.tv_usec<0) {
451                 timeout.tv_usec+=1000000;
452                 timeout.tv_sec--;
453             }
454             continue;
455         } else {
456             /* This is a reply to our packet */
457             memcpy(&ier->Address,&ip_header->ip_src,sizeof(IPAddr));
458             /* Status is already set */
459             ier->RoundTripTime=(recv_time.tv_sec-send_time.tv_sec)*1000+(recv_time.tv_usec-send_time.tv_usec)/1000;
460             ier->DataSize=res-ip_header_len-ICMP_MINLEN;
461             ier->Reserved=0;
462             ier->Data=endbuf-ier->DataSize;
463             memmove(ier->Data,((char*)ip_header)+ip_header_len+ICMP_MINLEN,ier->DataSize);
464             ier->Options.Ttl=ip_header->ip_ttl;
465             ier->Options.Tos=ip_header->ip_tos;
466             ier->Options.Flags=ip_header->ip_off >> 13;
467             ier->Options.OptionsSize=ip_header_len-sizeof(struct ip);
468             if (ier->Options.OptionsSize!=0) {
469                 ier->Options.OptionsData=(unsigned char *) ier->Data-ier->Options.OptionsSize;
470                 /* FIXME: We are supposed to rearrange the option's 'source route' data */
471                 memmove(ier->Options.OptionsData,((char*)ip_header)+ip_header_len,ier->Options.OptionsSize);
472                 endbuf=ier->Options.OptionsData;
473             } else {
474                 ier->Options.OptionsData=NULL;
475                 endbuf=ier->Data;
476             }
477
478             /* Prepare for the next packet */
479             ier++;
480             ip_header=(struct ip*)(((char*)ip_header)+sizeof(ICMP_ECHO_REPLY));
481             maxlen=endbuf-(char*)ip_header;
482
483             /* Check out whether there is more but don't wait this time */
484             timeout.tv_sec=0;
485             timeout.tv_usec=0;
486         }
487         FD_ZERO(&fdr);
488         FD_SET(icp->sid,&fdr);
489     }
490     res=ier-(ICMP_ECHO_REPLY*)ReplyBuffer;
491     if (res==0)
492         SetLastError(IP_REQ_TIMED_OUT);
493     TRACE("received %d replies\n",res);
494     return res;
495 }
496
497 /*
498  * Copyright (c) 1989 The Regents of the University of California.
499  * All rights reserved.
500  *
501  * This code is derived from software contributed to Berkeley by
502  * Mike Muuss.
503  *
504  * Redistribution and use in source and binary forms, with or without
505  * modification, are permitted provided that the following conditions
506  * are met:
507  * 1. Redistributions of source code must retain the above copyright
508  *    notice, this list of conditions and the following disclaimer.
509  * 2. Redistributions in binary form must reproduce the above copyright
510  *    notice, this list of conditions and the following disclaimer in the
511  *    documentation and/or other materials provided with the distribution.
512  * 3. All advertising materials mentioning features or use of this software
513  *    must display the following acknowledgement:
514  *      This product includes software developed by the University of
515  *      California, Berkeley and its contributors.
516  * 4. Neither the name of the University nor the names of its contributors
517  *    may be used to endorse or promote products derived from this software
518  *    without specific prior written permission.
519  *
520  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
521  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
522  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
523  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
524  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
525  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
526  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
527  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
528  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
529  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
530  * SUCH DAMAGE.
531  *
532  */