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