r3323: more warning reductions
[bbaumbach/samba-autobuild/.git] / source4 / nsswitch / wb_common.c
1 /* 
2    Unix SMB/CIFS implementation.
3
4    winbind client common code
5
6    Copyright (C) Tim Potter 2000
7    Copyright (C) Andrew Tridgell 2000
8    Copyright (C) Andrew Bartlett 2002
9    
10    
11    This library is free software; you can redistribute it and/or
12    modify it under the terms of the GNU Library General Public
13    License as published by the Free Software Foundation; either
14    version 2 of the License, or (at your option) any later version.
15    
16    This library is distributed in the hope that it will be useful,
17    but WITHOUT ANY WARRANTY; without even the implied warranty of
18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19    Library General Public License for more details.
20    
21    You should have received a copy of the GNU Library General Public
22    License along with this library; if not, write to the
23    Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24    Boston, MA  02111-1307, USA.   
25 */
26
27 #include "includes.h"
28
29 /* Global variables.  These are effectively the client state information */
30
31 int winbindd_fd = -1;           /* fd for winbindd socket */
32
33 /* Free a response structure */
34
35 void free_response(struct winbindd_response *response)
36 {
37         /* Free any allocated extra_data */
38
39         if (response)
40                 SAFE_FREE(response->extra_data);
41 }
42
43 /* Initialise a request structure */
44
45 void init_request(struct winbindd_request *request, int request_type)
46 {
47         request->length = sizeof(struct winbindd_request);
48
49         request->cmd = (enum winbindd_cmd)request_type;
50         request->pid = getpid();
51
52 }
53
54 /* Initialise a response structure */
55
56 void init_response(struct winbindd_response *response)
57 {
58         /* Initialise return value */
59
60         response->result = WINBINDD_ERROR;
61 }
62
63 /* Close established socket */
64
65 void close_sock(void)
66 {
67         if (winbindd_fd != -1) {
68                 close(winbindd_fd);
69                 winbindd_fd = -1;
70         }
71 }
72
73 #define CONNECT_TIMEOUT 30
74 #define WRITE_TIMEOUT CONNECT_TIMEOUT
75 #define READ_TIMEOUT CONNECT_TIMEOUT
76
77 /* Make sure socket handle isn't stdin, stdout or stderr */
78 #define RECURSION_LIMIT 3
79
80 static int make_nonstd_fd_internals(int fd, int limit /* Recursion limiter */) 
81 {
82         int new_fd;
83         if (fd >= 0 && fd <= 2) {
84 #ifdef F_DUPFD 
85                 if ((new_fd = fcntl(fd, F_DUPFD, 3)) == -1) {
86                         return -1;
87                 }
88                 /* Paranoia */
89                 if (new_fd < 3) {
90                         close(new_fd);
91                         return -1;
92                 }
93                 close(fd);
94                 return new_fd;
95 #else
96                 if (limit <= 0)
97                         return -1;
98                 
99                 new_fd = dup(fd);
100                 if (new_fd == -1) 
101                         return -1;
102
103                 /* use the program stack to hold our list of FDs to close */
104                 new_fd = make_nonstd_fd_internals(new_fd, limit - 1);
105                 close(fd);
106                 return new_fd;
107 #endif
108         }
109         return fd;
110 }
111
112 /****************************************************************************
113  Set a fd into blocking/nonblocking mode. Uses POSIX O_NONBLOCK if available,
114  else
115  if SYSV use O_NDELAY
116  if BSD use FNDELAY
117  Set close on exec also.
118 ****************************************************************************/
119
120 static int make_safe_fd(int fd) 
121 {
122         int result, flags;
123         int new_fd = make_nonstd_fd_internals(fd, RECURSION_LIMIT);
124         if (new_fd == -1) {
125                 close(fd);
126                 return -1;
127         }
128
129         /* Socket should be nonblocking. */
130 #ifdef O_NONBLOCK
131 #define FLAG_TO_SET O_NONBLOCK
132 #else
133 #ifdef SYSV
134 #define FLAG_TO_SET O_NDELAY
135 #else /* BSD */
136 #define FLAG_TO_SET FNDELAY
137 #endif
138 #endif
139
140         if ((flags = fcntl(new_fd, F_GETFL)) == -1) {
141                 close(new_fd);
142                 return -1;
143         }
144
145         flags |= FLAG_TO_SET;
146         if (fcntl(new_fd, F_SETFL, flags) == -1) {
147                 close(new_fd);
148                 return -1;
149         }
150
151 #undef FLAG_TO_SET
152
153         /* Socket should be closed on exec() */
154 #ifdef FD_CLOEXEC
155         result = flags = fcntl(new_fd, F_GETFD, 0);
156         if (flags >= 0) {
157                 flags |= FD_CLOEXEC;
158                 result = fcntl( new_fd, F_SETFD, flags );
159         }
160         if (result < 0) {
161                 close(new_fd);
162                 return -1;
163         }
164 #endif
165         return new_fd;
166 }
167
168 /* Connect to winbindd socket */
169
170 static int winbind_named_pipe_sock(const char *dir)
171 {
172         struct sockaddr_un sunaddr;
173         struct stat st;
174         pstring path;
175         int fd;
176         int wait_time;
177         int slept;
178         
179         /* Check permissions on unix socket directory */
180         
181         if (lstat(dir, &st) == -1) {
182                 return -1;
183         }
184         
185         if (!S_ISDIR(st.st_mode) || 
186             (st.st_uid != 0 && st.st_uid != geteuid())) {
187                 return -1;
188         }
189         
190         /* Connect to socket */
191
192         snprintf(path, sizeof(path), "%s%s", dir, "/" WINBINDD_SOCKET_NAME);
193         
194         ZERO_STRUCT(sunaddr);
195         sunaddr.sun_family = AF_UNIX;
196         strncpy(sunaddr.sun_path, path, sizeof(sunaddr.sun_path) - 1);
197         
198         /* If socket file doesn't exist, don't bother trying to connect
199            with retry.  This is an attempt to make the system usable when
200            the winbindd daemon is not running. */
201
202         if (lstat(path, &st) == -1) {
203                 return -1;
204         }
205         
206         /* Check permissions on unix socket file */
207         
208         if (!S_ISSOCK(st.st_mode) || 
209             (st.st_uid != 0 && st.st_uid != geteuid())) {
210                 return -1;
211         }
212         
213         /* Connect to socket */
214         
215         if ((fd = socket(AF_UNIX, SOCK_STREAM, 0)) == -1) {
216                 return -1;
217         }
218
219         /* Set socket non-blocking and close on exec. */
220
221         if ((fd = make_safe_fd( fd)) == -1) {
222                 return fd;
223         }
224
225         for (wait_time = 0; connect(fd, (struct sockaddr *)&sunaddr, sizeof(sunaddr)) == -1;
226                         wait_time += slept) {
227                 struct timeval tv;
228                 fd_set w_fds;
229                 int ret;
230                 int connect_errno = 0, errnosize;
231
232                 if (wait_time >= CONNECT_TIMEOUT)
233                         goto error_out;
234
235                 switch (errno) {
236                         case EINPROGRESS:
237                                 FD_ZERO(&w_fds);
238                                 FD_SET(fd, &w_fds);
239                                 tv.tv_sec = CONNECT_TIMEOUT - wait_time;
240                                 tv.tv_usec = 0;
241
242                                 ret = select(fd + 1, NULL, &w_fds, NULL, &tv);
243
244                                 if (ret > 0) {
245                                         errnosize = sizeof(connect_errno);
246
247                                         ret = getsockopt(fd, SOL_SOCKET,
248                                                         SO_ERROR, &connect_errno, &errnosize);
249
250                                         if (ret >= 0 && connect_errno == 0) {
251                                                 /* Connect succeed */
252                                                 goto out;
253                                         }
254                                 }
255
256                                 slept = CONNECT_TIMEOUT;
257                                 break;
258                         case EAGAIN:
259                                 slept = rand() % 3 + 1;
260                                 sleep(slept);
261                                 break;
262                         default:
263                                 goto error_out;
264                 }
265
266         }
267
268   out:
269
270         return fd;
271
272   error_out:
273
274         close(fd);
275         return -1;
276
277         if (connect(fd, (struct sockaddr *)&sunaddr, 
278                     sizeof(sunaddr)) == -1) {
279                 close(fd);
280                 return -1;
281         }
282         
283         return fd;
284 }
285
286 /* Connect to winbindd socket */
287
288 int winbind_open_pipe_sock(void)
289 {
290 #ifdef HAVE_UNIXSOCKET
291         static pid_t our_pid;
292         struct winbindd_request request;
293         struct winbindd_response response;
294         ZERO_STRUCT(request);
295         ZERO_STRUCT(response);
296
297         if (our_pid != getpid()) {
298                 close_sock();
299                 our_pid = getpid();
300         }
301         
302         if (winbindd_fd != -1) {
303                 return winbindd_fd;
304         }
305
306         if ((winbindd_fd = winbind_named_pipe_sock(WINBINDD_SOCKET_DIR)) == -1) {
307                 return -1;
308         }
309
310         /* version-check the socket */
311
312         if ((winbindd_request(WINBINDD_INTERFACE_VERSION, &request, &response) != NSS_STATUS_SUCCESS) || (response.data.interface_version != WINBIND_INTERFACE_VERSION)) {
313                 close_sock();
314                 return -1;
315         }
316
317         /* try and get priv pipe */
318
319         if (winbindd_request(WINBINDD_PRIV_PIPE_DIR, &request, &response) == NSS_STATUS_SUCCESS) {
320                 int fd;
321                 if ((fd = winbind_named_pipe_sock(response.extra_data)) != -1) {
322                         close(winbindd_fd);
323                         winbindd_fd = fd;
324                 }
325         }
326
327         SAFE_FREE(response.extra_data);
328
329         return winbindd_fd;
330 #else
331         return -1;
332 #endif /* HAVE_UNIXSOCKET */
333 }
334
335 /* Write data to winbindd socket */
336
337 int write_sock(void *buffer, int count)
338 {
339         int result, nwritten;
340         
341         /* Open connection to winbind daemon */
342         
343  restart:
344         
345         if (winbind_open_pipe_sock() == -1) {
346                 return -1;
347         }
348         
349         /* Write data to socket */
350         
351         nwritten = 0;
352         
353         while(nwritten < count) {
354                 struct timeval tv;
355                 fd_set r_fds;
356                 
357                 /* Catch pipe close on other end by checking if a read()
358                    call would not block by calling select(). */
359
360                 FD_ZERO(&r_fds);
361                 FD_SET(winbindd_fd, &r_fds);
362                 ZERO_STRUCT(tv);
363                 
364                 if (select(winbindd_fd + 1, &r_fds, NULL, NULL, &tv) == -1) {
365                         close_sock();
366                         return -1;                   /* Select error */
367                 }
368                 
369                 /* Write should be OK if fd not available for reading */
370                 
371                 if (!FD_ISSET(winbindd_fd, &r_fds)) {
372                         
373                         /* Do the write */
374                         
375                         result = write(winbindd_fd,
376                                        (char *)buffer + nwritten, 
377                                        count - nwritten);
378                         
379                         if ((result == -1) || (result == 0)) {
380                                 
381                                 /* Write failed */
382                                 
383                                 close_sock();
384                                 return -1;
385                         }
386                         
387                         nwritten += result;
388                         
389                 } else {
390                         
391                         /* Pipe has closed on remote end */
392                         
393                         close_sock();
394                         goto restart;
395                 }
396         }
397         
398         return nwritten;
399 }
400
401 /* Read data from winbindd socket */
402
403 static int read_sock(void *buffer, int count)
404 {
405         int result = 0, nread = 0;
406         int total_time = 0, selret;
407
408         /* Read data from socket */
409         while(nread < count) {
410                 struct timeval tv;
411                 fd_set r_fds;
412                 
413                 /* Catch pipe close on other end by checking if a read()
414                    call would not block by calling select(). */
415
416                 FD_ZERO(&r_fds);
417                 FD_SET(winbindd_fd, &r_fds);
418                 ZERO_STRUCT(tv);
419                 /* Wait for 5 seconds for a reply. May need to parameterise this... */
420                 tv.tv_sec = 5;
421
422                 if ((selret = select(winbindd_fd + 1, &r_fds, NULL, NULL, &tv)) == -1) {
423                         close_sock();
424                         return -1;                   /* Select error */
425                 }
426                 
427                 if (selret == 0) {
428                         /* Not ready for read yet... */
429                         if (total_time >= 30) {
430                                 /* Timeout */
431                                 close_sock();
432                                 return -1;
433                         }
434                         total_time += 5;
435                         continue;
436                 }
437
438                 if (FD_ISSET(winbindd_fd, &r_fds)) {
439                         
440                         /* Do the Read */
441                         
442                         result = read(winbindd_fd, (char *)buffer + nread, 
443                               count - nread);
444                         
445                         if ((result == -1) || (result == 0)) {
446                                 
447                                 /* Read failed.  I think the only useful thing we
448                                    can do here is just return -1 and fail since the
449                                    transaction has failed half way through. */
450                         
451                                 close_sock();
452                                 return -1;
453                         }
454                         
455                         nread += result;
456                         
457                 }
458         }
459         
460         return result;
461 }
462
463 /* Read reply */
464
465 int read_reply(struct winbindd_response *response)
466 {
467         int result1, result2 = 0;
468
469         if (!response) {
470                 return -1;
471         }
472         
473         /* Read fixed length response */
474         
475         if ((result1 = read_sock(response, sizeof(struct winbindd_response)))
476             == -1) {
477                 
478                 return -1;
479         }
480         
481         /* We actually send the pointer value of the extra_data field from
482            the server.  This has no meaning in the client's address space
483            so we clear it out. */
484
485         response->extra_data = NULL;
486
487         /* Read variable length response */
488         
489         if (response->length > sizeof(struct winbindd_response)) {
490                 int extra_data_len = response->length - 
491                         sizeof(struct winbindd_response);
492                 
493                 /* Mallocate memory for extra data */
494                 
495                 if (!(response->extra_data = malloc(extra_data_len))) {
496                         return -1;
497                 }
498                 
499                 if ((result2 = read_sock(response->extra_data, extra_data_len))
500                     == -1) {
501                         free_response(response);
502                         return -1;
503                 }
504         }
505         
506         /* Return total amount of data read */
507         
508         return result1 + result2;
509 }
510
511 /* 
512  * send simple types of requests 
513  */
514
515 NSS_STATUS winbindd_send_request(int req_type, struct winbindd_request *request)
516 {
517         struct winbindd_request lrequest;
518         char *env;
519         int  value;
520         
521         /* Check for our tricky environment variable */
522
523         if ( (env = getenv(WINBINDD_DONT_ENV)) != NULL ) {
524                 value = atoi(env);
525                 if ( value == 1 )
526                         return NSS_STATUS_NOTFOUND;
527         }
528
529         if (!request) {
530                 ZERO_STRUCT(lrequest);
531                 request = &lrequest;
532         }
533         
534         /* Fill in request and send down pipe */
535
536         init_request(request, req_type);
537         
538         if (write_sock(request, sizeof(*request)) == -1) {
539                 return NSS_STATUS_UNAVAIL;
540         }
541         
542         return NSS_STATUS_SUCCESS;
543 }
544
545 /*
546  * Get results from winbindd request
547  */
548
549 NSS_STATUS winbindd_get_response(struct winbindd_response *response)
550 {
551         struct winbindd_response lresponse;
552
553         if (!response) {
554                 ZERO_STRUCT(lresponse);
555                 response = &lresponse;
556         }
557
558         init_response(response);
559
560         /* Wait for reply */
561         if (read_reply(response) == -1) {
562                 return NSS_STATUS_UNAVAIL;
563         }
564
565         /* Throw away extra data if client didn't request it */
566         if (response == &lresponse) {
567                 free_response(response);
568         }
569
570         /* Copy reply data from socket */
571         if (response->result != WINBINDD_OK) {
572                 return NSS_STATUS_NOTFOUND;
573         }
574         
575         return NSS_STATUS_SUCCESS;
576 }
577
578 /* Handle simple types of requests */
579
580 NSS_STATUS winbindd_request(int req_type, 
581                             struct winbindd_request *request,
582                             struct winbindd_response *response)
583 {
584         NSS_STATUS status;
585
586         status = winbindd_send_request(req_type, request);
587         if (status != NSS_STATUS_SUCCESS) 
588                 return(status);
589         return winbindd_get_response(response);
590 }
591
592 /*************************************************************************
593  A couple of simple functions to disable winbindd lookups and re-
594  enable them
595  ************************************************************************/
596  
597 /* Use putenv() instead of setenv() in these functions as not all
598    environments have the latter. */
599
600 BOOL winbind_off( void )
601 {
602 #if HAVE_SETENV
603         setenv(WINBINDD_DONT_ENV, "1", 1);
604         return True;
605 #else
606         static const char *s = WINBINDD_DONT_ENV "=1";
607         return putenv(s) != -1;
608 #endif
609 }
610
611 BOOL winbind_on( void )
612 {
613 #if HAVE_SETENV
614         setenv(WINBINDD_DONT_ENV, "0", 1);
615         return True;
616 #else
617         static const char *s = WINBINDD_DONT_ENV "=0";
618         return putenv(s) != -1;
619 #endif
620 }