s3:lib/events: make use of samba_tevent_set_debug()
[Samba/gebeck_regimport.git] / nsswitch / wb_common.c
blobc56a76f82612b1017853b2734261636e67cadf94
1 /*
2 Unix SMB/CIFS implementation.
4 winbind client common code
6 Copyright (C) Tim Potter 2000
7 Copyright (C) Andrew Tridgell 2000
8 Copyright (C) Andrew Bartlett 2002
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.
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.
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/>.
25 #define UID_WRAPPER_NOT_REPLACE
27 #include "replace.h"
28 #include "system/select.h"
29 #include "winbind_client.h"
31 /* Global variables. These are effectively the client state information */
33 int winbindd_fd = -1; /* fd for winbindd socket */
34 static int is_privileged = 0;
36 /* Free a response structure */
38 void winbindd_free_response(struct winbindd_response *response)
40 /* Free any allocated extra_data */
42 if (response)
43 SAFE_FREE(response->extra_data.data);
46 /* Initialise a request structure */
48 static void winbindd_init_request(struct winbindd_request *request,
49 int request_type)
51 request->length = sizeof(struct winbindd_request);
53 request->cmd = (enum winbindd_cmd)request_type;
54 request->pid = getpid();
58 /* Initialise a response structure */
60 static void init_response(struct winbindd_response *response)
62 /* Initialise return value */
64 response->result = WINBINDD_ERROR;
67 /* Close established socket */
69 #if HAVE_FUNCTION_ATTRIBUTE_DESTRUCTOR
70 __attribute__((destructor))
71 #endif
72 static void winbind_close_sock(void)
74 if (winbindd_fd != -1) {
75 close(winbindd_fd);
76 winbindd_fd = -1;
80 #define CONNECT_TIMEOUT 30
82 /* Make sure socket handle isn't stdin, stdout or stderr */
83 #define RECURSION_LIMIT 3
85 static int make_nonstd_fd_internals(int fd, int limit /* Recursion limiter */)
87 int new_fd;
88 if (fd >= 0 && fd <= 2) {
89 #ifdef F_DUPFD
90 if ((new_fd = fcntl(fd, F_DUPFD, 3)) == -1) {
91 return -1;
93 /* Paranoia */
94 if (new_fd < 3) {
95 close(new_fd);
96 return -1;
98 close(fd);
99 return new_fd;
100 #else
101 if (limit <= 0)
102 return -1;
104 new_fd = dup(fd);
105 if (new_fd == -1)
106 return -1;
108 /* use the program stack to hold our list of FDs to close */
109 new_fd = make_nonstd_fd_internals(new_fd, limit - 1);
110 close(fd);
111 return new_fd;
112 #endif
114 return fd;
117 /****************************************************************************
118 Set a fd into blocking/nonblocking mode. Uses POSIX O_NONBLOCK if available,
119 else
120 if SYSV use O_NDELAY
121 if BSD use FNDELAY
122 Set close on exec also.
123 ****************************************************************************/
125 static int make_safe_fd(int fd)
127 int result, flags;
128 int new_fd = make_nonstd_fd_internals(fd, RECURSION_LIMIT);
129 if (new_fd == -1) {
130 close(fd);
131 return -1;
134 /* Socket should be nonblocking. */
135 #ifdef O_NONBLOCK
136 #define FLAG_TO_SET O_NONBLOCK
137 #else
138 #ifdef SYSV
139 #define FLAG_TO_SET O_NDELAY
140 #else /* BSD */
141 #define FLAG_TO_SET FNDELAY
142 #endif
143 #endif
145 if ((flags = fcntl(new_fd, F_GETFL)) == -1) {
146 close(new_fd);
147 return -1;
150 flags |= FLAG_TO_SET;
151 if (fcntl(new_fd, F_SETFL, flags) == -1) {
152 close(new_fd);
153 return -1;
156 #undef FLAG_TO_SET
158 /* Socket should be closed on exec() */
159 #ifdef FD_CLOEXEC
160 result = flags = fcntl(new_fd, F_GETFD, 0);
161 if (flags >= 0) {
162 flags |= FD_CLOEXEC;
163 result = fcntl( new_fd, F_SETFD, flags );
165 if (result < 0) {
166 close(new_fd);
167 return -1;
169 #endif
170 return new_fd;
173 /* Connect to winbindd socket */
175 static int winbind_named_pipe_sock(const char *dir)
177 struct sockaddr_un sunaddr;
178 struct stat st;
179 char *path = NULL;
180 int fd;
181 int wait_time;
182 int slept;
184 /* Check permissions on unix socket directory */
186 if (lstat(dir, &st) == -1) {
187 errno = ENOENT;
188 return -1;
191 if (!S_ISDIR(st.st_mode) ||
192 (st.st_uid != 0 && st.st_uid != geteuid())) {
193 errno = ENOENT;
194 return -1;
197 /* Connect to socket */
199 if (asprintf(&path, "%s/%s", dir, WINBINDD_SOCKET_NAME) < 0) {
200 return -1;
203 ZERO_STRUCT(sunaddr);
204 sunaddr.sun_family = AF_UNIX;
205 strncpy(sunaddr.sun_path, path, sizeof(sunaddr.sun_path) - 1);
207 /* If socket file doesn't exist, don't bother trying to connect
208 with retry. This is an attempt to make the system usable when
209 the winbindd daemon is not running. */
211 if (lstat(path, &st) == -1) {
212 errno = ENOENT;
213 SAFE_FREE(path);
214 return -1;
217 SAFE_FREE(path);
218 /* Check permissions on unix socket file */
220 if (!S_ISSOCK(st.st_mode) ||
221 (st.st_uid != 0 && st.st_uid != geteuid())) {
222 errno = ENOENT;
223 return -1;
226 /* Connect to socket */
228 if ((fd = socket(AF_UNIX, SOCK_STREAM, 0)) == -1) {
229 return -1;
232 /* Set socket non-blocking and close on exec. */
234 if ((fd = make_safe_fd( fd)) == -1) {
235 return fd;
238 for (wait_time = 0; connect(fd, (struct sockaddr *)&sunaddr, sizeof(sunaddr)) == -1;
239 wait_time += slept) {
240 struct pollfd pfd;
241 int ret;
242 int connect_errno = 0;
243 socklen_t errnosize;
245 if (wait_time >= CONNECT_TIMEOUT)
246 goto error_out;
248 switch (errno) {
249 case EINPROGRESS:
250 pfd.fd = fd;
251 pfd.events = POLLOUT;
253 ret = poll(&pfd, 1, (CONNECT_TIMEOUT - wait_time) * 1000);
255 if (ret > 0) {
256 errnosize = sizeof(connect_errno);
258 ret = getsockopt(fd, SOL_SOCKET,
259 SO_ERROR, &connect_errno, &errnosize);
261 if (ret >= 0 && connect_errno == 0) {
262 /* Connect succeed */
263 goto out;
267 slept = CONNECT_TIMEOUT;
268 break;
269 case EAGAIN:
270 slept = rand() % 3 + 1;
271 sleep(slept);
272 break;
273 default:
274 goto error_out;
279 out:
281 return fd;
283 error_out:
285 close(fd);
286 return -1;
289 static const char *winbindd_socket_dir(void)
291 #ifdef SOCKET_WRAPPER
292 const char *env_dir;
294 env_dir = getenv(WINBINDD_SOCKET_DIR_ENVVAR);
295 if (env_dir) {
296 return env_dir;
298 #endif
300 return WINBINDD_SOCKET_DIR;
303 /* Connect to winbindd socket */
305 static int winbind_open_pipe_sock(int recursing, int need_priv)
307 #ifdef HAVE_UNIXSOCKET
308 static pid_t our_pid;
309 struct winbindd_request request;
310 struct winbindd_response response;
311 ZERO_STRUCT(request);
312 ZERO_STRUCT(response);
314 if (our_pid != getpid()) {
315 winbind_close_sock();
316 our_pid = getpid();
319 if ((need_priv != 0) && (is_privileged == 0)) {
320 winbind_close_sock();
323 if (winbindd_fd != -1) {
324 return winbindd_fd;
327 if (recursing) {
328 return -1;
331 if ((winbindd_fd = winbind_named_pipe_sock(winbindd_socket_dir())) == -1) {
332 return -1;
335 is_privileged = 0;
337 /* version-check the socket */
339 request.wb_flags = WBFLAG_RECURSE;
340 if ((winbindd_request_response(WINBINDD_INTERFACE_VERSION, &request, &response) != NSS_STATUS_SUCCESS) || (response.data.interface_version != WINBIND_INTERFACE_VERSION)) {
341 winbind_close_sock();
342 return -1;
345 /* try and get priv pipe */
347 request.wb_flags = WBFLAG_RECURSE;
348 if (winbindd_request_response(WINBINDD_PRIV_PIPE_DIR, &request, &response) == NSS_STATUS_SUCCESS) {
349 int fd;
350 if ((fd = winbind_named_pipe_sock((char *)response.extra_data.data)) != -1) {
351 close(winbindd_fd);
352 winbindd_fd = fd;
353 is_privileged = 1;
357 if ((need_priv != 0) && (is_privileged == 0)) {
358 return -1;
361 SAFE_FREE(response.extra_data.data);
363 return winbindd_fd;
364 #else
365 return -1;
366 #endif /* HAVE_UNIXSOCKET */
369 /* Write data to winbindd socket */
371 static int winbind_write_sock(void *buffer, int count, int recursing,
372 int need_priv)
374 int fd, result, nwritten;
376 /* Open connection to winbind daemon */
378 restart:
380 fd = winbind_open_pipe_sock(recursing, need_priv);
381 if (fd == -1) {
382 errno = ENOENT;
383 return -1;
386 /* Write data to socket */
388 nwritten = 0;
390 while(nwritten < count) {
391 struct pollfd pfd;
392 int ret;
394 /* Catch pipe close on other end by checking if a read()
395 call would not block by calling poll(). */
397 pfd.fd = fd;
398 pfd.events = POLLIN|POLLHUP;
400 ret = poll(&pfd, 1, 0);
401 if (ret == -1) {
402 winbind_close_sock();
403 return -1; /* poll error */
406 /* Write should be OK if fd not available for reading */
408 if ((ret == 1) && (pfd.revents & (POLLIN|POLLHUP|POLLERR))) {
410 /* Pipe has closed on remote end */
412 winbind_close_sock();
413 goto restart;
416 /* Do the write */
418 result = write(fd, (char *)buffer + nwritten,
419 count - nwritten);
421 if ((result == -1) || (result == 0)) {
423 /* Write failed */
425 winbind_close_sock();
426 return -1;
429 nwritten += result;
432 return nwritten;
435 /* Read data from winbindd socket */
437 static int winbind_read_sock(void *buffer, int count)
439 int fd;
440 int nread = 0;
441 int total_time = 0;
443 fd = winbind_open_pipe_sock(false, false);
444 if (fd == -1) {
445 return -1;
448 /* Read data from socket */
449 while(nread < count) {
450 struct pollfd pfd;
451 int ret;
453 /* Catch pipe close on other end by checking if a read()
454 call would not block by calling poll(). */
456 pfd.fd = fd;
457 pfd.events = POLLIN|POLLHUP;
459 /* Wait for 5 seconds for a reply. May need to parameterise this... */
461 ret = poll(&pfd, 1, 5000);
462 if (ret == -1) {
463 winbind_close_sock();
464 return -1; /* poll error */
467 if (ret == 0) {
468 /* Not ready for read yet... */
469 if (total_time >= 30) {
470 /* Timeout */
471 winbind_close_sock();
472 return -1;
474 total_time += 5;
475 continue;
478 if ((ret == 1) && (pfd.revents & (POLLIN|POLLHUP|POLLERR))) {
480 /* Do the Read */
482 int result = read(fd, (char *)buffer + nread,
483 count - nread);
485 if ((result == -1) || (result == 0)) {
487 /* Read failed. I think the only useful thing we
488 can do here is just return -1 and fail since the
489 transaction has failed half way through. */
491 winbind_close_sock();
492 return -1;
495 nread += result;
500 return nread;
503 /* Read reply */
505 static int winbindd_read_reply(struct winbindd_response *response)
507 int result1, result2 = 0;
509 if (!response) {
510 return -1;
513 /* Read fixed length response */
515 result1 = winbind_read_sock(response,
516 sizeof(struct winbindd_response));
517 if (result1 == -1) {
518 return -1;
521 if (response->length < sizeof(struct winbindd_response)) {
522 return -1;
525 /* We actually send the pointer value of the extra_data field from
526 the server. This has no meaning in the client's address space
527 so we clear it out. */
529 response->extra_data.data = NULL;
531 /* Read variable length response */
533 if (response->length > sizeof(struct winbindd_response)) {
534 int extra_data_len = response->length -
535 sizeof(struct winbindd_response);
537 /* Mallocate memory for extra data */
539 if (!(response->extra_data.data = malloc(extra_data_len))) {
540 return -1;
543 result2 = winbind_read_sock(response->extra_data.data,
544 extra_data_len);
545 if (result2 == -1) {
546 winbindd_free_response(response);
547 return -1;
551 /* Return total amount of data read */
553 return result1 + result2;
557 * send simple types of requests
560 NSS_STATUS winbindd_send_request(int req_type, int need_priv,
561 struct winbindd_request *request)
563 struct winbindd_request lrequest;
565 /* Check for our tricky environment variable */
567 if (winbind_env_set()) {
568 return NSS_STATUS_NOTFOUND;
571 if (!request) {
572 ZERO_STRUCT(lrequest);
573 request = &lrequest;
576 /* Fill in request and send down pipe */
578 winbindd_init_request(request, req_type);
580 if (winbind_write_sock(request, sizeof(*request),
581 request->wb_flags & WBFLAG_RECURSE,
582 need_priv) == -1)
584 /* Set ENOENT for consistency. Required by some apps */
585 errno = ENOENT;
587 return NSS_STATUS_UNAVAIL;
590 if ((request->extra_len != 0) &&
591 (winbind_write_sock(request->extra_data.data,
592 request->extra_len,
593 request->wb_flags & WBFLAG_RECURSE,
594 need_priv) == -1))
596 /* Set ENOENT for consistency. Required by some apps */
597 errno = ENOENT;
599 return NSS_STATUS_UNAVAIL;
602 return NSS_STATUS_SUCCESS;
606 * Get results from winbindd request
609 NSS_STATUS winbindd_get_response(struct winbindd_response *response)
611 struct winbindd_response lresponse;
613 if (!response) {
614 ZERO_STRUCT(lresponse);
615 response = &lresponse;
618 init_response(response);
620 /* Wait for reply */
621 if (winbindd_read_reply(response) == -1) {
622 /* Set ENOENT for consistency. Required by some apps */
623 errno = ENOENT;
625 return NSS_STATUS_UNAVAIL;
628 /* Throw away extra data if client didn't request it */
629 if (response == &lresponse) {
630 winbindd_free_response(response);
633 /* Copy reply data from socket */
634 if (response->result != WINBINDD_OK) {
635 return NSS_STATUS_NOTFOUND;
638 return NSS_STATUS_SUCCESS;
641 /* Handle simple types of requests */
643 NSS_STATUS winbindd_request_response(int req_type,
644 struct winbindd_request *request,
645 struct winbindd_response *response)
647 NSS_STATUS status = NSS_STATUS_UNAVAIL;
648 int count = 0;
650 while ((status == NSS_STATUS_UNAVAIL) && (count < 10)) {
651 status = winbindd_send_request(req_type, 0, request);
652 if (status != NSS_STATUS_SUCCESS)
653 return(status);
654 status = winbindd_get_response(response);
655 count += 1;
658 return status;
661 NSS_STATUS winbindd_priv_request_response(int req_type,
662 struct winbindd_request *request,
663 struct winbindd_response *response)
665 NSS_STATUS status = NSS_STATUS_UNAVAIL;
666 int count = 0;
668 while ((status == NSS_STATUS_UNAVAIL) && (count < 10)) {
669 status = winbindd_send_request(req_type, 1, request);
670 if (status != NSS_STATUS_SUCCESS)
671 return(status);
672 status = winbindd_get_response(response);
673 count += 1;
676 return status;