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