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/>.
26 #include "system/select.h"
27 #include "winbind_client.h"
29 /* Global variables. These are effectively the client state information */
31 int winbindd_fd = -1; /* fd for winbindd socket */
32 static int is_privileged = 0;
34 /* Free a response structure */
36 void winbindd_free_response(struct winbindd_response *response)
38 /* Free any allocated extra_data */
41 SAFE_FREE(response->extra_data.data);
44 /* Initialise a request structure */
46 static void winbindd_init_request(struct winbindd_request *request,
49 request->length = sizeof(struct winbindd_request);
51 request->cmd = (enum winbindd_cmd)request_type;
52 request->pid = getpid();
56 /* Initialise a response structure */
58 static void init_response(struct winbindd_response *response)
60 /* Initialise return value */
62 response->result = WINBINDD_ERROR;
65 /* Close established socket */
67 #if HAVE_FUNCTION_ATTRIBUTE_DESTRUCTOR
68 __attribute__((destructor))
70 static void winbind_close_sock(void)
72 if (winbindd_fd != -1) {
78 #define CONNECT_TIMEOUT 30
80 /* Make sure socket handle isn't stdin, stdout or stderr */
81 #define RECURSION_LIMIT 3
83 static int make_nonstd_fd_internals(int fd, int limit /* Recursion limiter */)
86 if (fd >= 0 && fd <= 2) {
88 if ((new_fd = fcntl(fd, F_DUPFD, 3)) == -1) {
106 /* use the program stack to hold our list of FDs to close */
107 new_fd = make_nonstd_fd_internals(new_fd, limit - 1);
115 /****************************************************************************
116 Set a fd into blocking/nonblocking mode. Uses POSIX O_NONBLOCK if available,
120 Set close on exec also.
121 ****************************************************************************/
123 static int make_safe_fd(int fd)
126 int new_fd = make_nonstd_fd_internals(fd, RECURSION_LIMIT);
132 /* Socket should be nonblocking. */
134 #define FLAG_TO_SET O_NONBLOCK
137 #define FLAG_TO_SET O_NDELAY
139 #define FLAG_TO_SET FNDELAY
143 if ((flags = fcntl(new_fd, F_GETFL)) == -1) {
148 flags |= FLAG_TO_SET;
149 if (fcntl(new_fd, F_SETFL, flags) == -1) {
156 /* Socket should be closed on exec() */
158 result = flags = fcntl(new_fd, F_GETFD, 0);
161 result = fcntl( new_fd, F_SETFD, flags );
171 /* Connect to winbindd socket */
173 static int winbind_named_pipe_sock(const char *dir)
175 struct sockaddr_un sunaddr;
182 /* Check permissions on unix socket directory */
184 if (lstat(dir, &st) == -1) {
189 if (!S_ISDIR(st.st_mode) ||
190 (st.st_uid != 0 && st.st_uid != geteuid())) {
195 /* Connect to socket */
197 if (asprintf(&path, "%s/%s", dir, WINBINDD_SOCKET_NAME) < 0) {
201 ZERO_STRUCT(sunaddr);
202 sunaddr.sun_family = AF_UNIX;
203 strncpy(sunaddr.sun_path, path, sizeof(sunaddr.sun_path) - 1);
205 /* If socket file doesn't exist, don't bother trying to connect
206 with retry. This is an attempt to make the system usable when
207 the winbindd daemon is not running. */
209 if (lstat(path, &st) == -1) {
216 /* Check permissions on unix socket file */
218 if (!S_ISSOCK(st.st_mode) ||
219 (st.st_uid != 0 && st.st_uid != geteuid())) {
224 /* Connect to socket */
226 if ((fd = socket(AF_UNIX, SOCK_STREAM, 0)) == -1) {
230 /* Set socket non-blocking and close on exec. */
232 if ((fd = make_safe_fd( fd)) == -1) {
236 for (wait_time = 0; connect(fd, (struct sockaddr *)&sunaddr, sizeof(sunaddr)) == -1;
237 wait_time += slept) {
240 int connect_errno = 0;
243 if (wait_time >= CONNECT_TIMEOUT)
249 pfd.events = POLLOUT;
251 ret = poll(&pfd, 1, (CONNECT_TIMEOUT - wait_time) * 1000);
254 errnosize = sizeof(connect_errno);
256 ret = getsockopt(fd, SOL_SOCKET,
257 SO_ERROR, &connect_errno, &errnosize);
259 if (ret >= 0 && connect_errno == 0) {
260 /* Connect succeed */
265 slept = CONNECT_TIMEOUT;
268 slept = rand() % 3 + 1;
287 static const char *winbindd_socket_dir(void)
289 #ifdef SOCKET_WRAPPER
292 env_dir = getenv(WINBINDD_SOCKET_DIR_ENVVAR);
298 return WINBINDD_SOCKET_DIR;
301 /* Connect to winbindd socket */
303 static int winbind_open_pipe_sock(int recursing, int need_priv)
305 #ifdef HAVE_UNIXSOCKET
306 static pid_t our_pid;
307 struct winbindd_request request;
308 struct winbindd_response response;
309 ZERO_STRUCT(request);
310 ZERO_STRUCT(response);
312 if (our_pid != getpid()) {
313 winbind_close_sock();
317 if ((need_priv != 0) && (is_privileged == 0)) {
318 winbind_close_sock();
321 if (winbindd_fd != -1) {
329 if ((winbindd_fd = winbind_named_pipe_sock(winbindd_socket_dir())) == -1) {
335 /* version-check the socket */
337 request.wb_flags = WBFLAG_RECURSE;
338 if ((winbindd_request_response(WINBINDD_INTERFACE_VERSION, &request, &response) != NSS_STATUS_SUCCESS) || (response.data.interface_version != WINBIND_INTERFACE_VERSION)) {
339 winbind_close_sock();
343 /* try and get priv pipe */
345 request.wb_flags = WBFLAG_RECURSE;
346 if (winbindd_request_response(WINBINDD_PRIV_PIPE_DIR, &request, &response) == NSS_STATUS_SUCCESS) {
348 if ((fd = winbind_named_pipe_sock((char *)response.extra_data.data)) != -1) {
355 if ((need_priv != 0) && (is_privileged == 0)) {
359 SAFE_FREE(response.extra_data.data);
364 #endif /* HAVE_UNIXSOCKET */
367 /* Write data to winbindd socket */
369 static int winbind_write_sock(void *buffer, int count, int recursing,
372 int result, nwritten;
374 /* Open connection to winbind daemon */
378 if (winbind_open_pipe_sock(recursing, need_priv) == -1) {
383 /* Write data to socket */
387 while(nwritten < count) {
391 /* Catch pipe close on other end by checking if a read()
392 call would not block by calling poll(). */
394 pfd.fd = winbindd_fd;
395 pfd.events = POLLIN|POLLHUP;
397 ret = poll(&pfd, 1, 0);
399 winbind_close_sock();
400 return -1; /* poll error */
403 /* Write should be OK if fd not available for reading */
405 if ((ret == 1) && (pfd.revents & (POLLIN|POLLHUP|POLLERR))) {
407 /* Pipe has closed on remote end */
409 winbind_close_sock();
415 result = write(winbindd_fd,
416 (char *)buffer + nwritten,
419 if ((result == -1) || (result == 0)) {
423 winbind_close_sock();
433 /* Read data from winbindd socket */
435 static int winbind_read_sock(void *buffer, int count)
440 if (winbindd_fd == -1) {
444 /* Read data from socket */
445 while(nread < count) {
449 /* Catch pipe close on other end by checking if a read()
450 call would not block by calling poll(). */
452 pfd.fd = winbindd_fd;
453 pfd.events = POLLIN|POLLHUP;
455 /* Wait for 5 seconds for a reply. May need to parameterise this... */
457 ret = poll(&pfd, 1, 5000);
459 winbind_close_sock();
460 return -1; /* poll error */
464 /* Not ready for read yet... */
465 if (total_time >= 30) {
467 winbind_close_sock();
474 if ((ret == 1) && (pfd.revents & (POLLIN|POLLHUP|POLLERR))) {
478 int result = read(winbindd_fd, (char *)buffer + nread,
481 if ((result == -1) || (result == 0)) {
483 /* Read failed. I think the only useful thing we
484 can do here is just return -1 and fail since the
485 transaction has failed half way through. */
487 winbind_close_sock();
501 static int winbindd_read_reply(struct winbindd_response *response)
503 int result1, result2 = 0;
509 /* Read fixed length response */
511 result1 = winbind_read_sock(response,
512 sizeof(struct winbindd_response));
517 if (response->length < sizeof(struct winbindd_response)) {
521 /* We actually send the pointer value of the extra_data field from
522 the server. This has no meaning in the client's address space
523 so we clear it out. */
525 response->extra_data.data = NULL;
527 /* Read variable length response */
529 if (response->length > sizeof(struct winbindd_response)) {
530 int extra_data_len = response->length -
531 sizeof(struct winbindd_response);
533 /* Mallocate memory for extra data */
535 if (!(response->extra_data.data = malloc(extra_data_len))) {
539 result2 = winbind_read_sock(response->extra_data.data,
542 winbindd_free_response(response);
547 /* Return total amount of data read */
549 return result1 + result2;
553 * send simple types of requests
556 NSS_STATUS winbindd_send_request(int req_type, int need_priv,
557 struct winbindd_request *request)
559 struct winbindd_request lrequest;
561 /* Check for our tricky environment variable */
563 if (winbind_env_set()) {
564 return NSS_STATUS_NOTFOUND;
568 ZERO_STRUCT(lrequest);
572 /* Fill in request and send down pipe */
574 winbindd_init_request(request, req_type);
576 if (winbind_write_sock(request, sizeof(*request),
577 request->wb_flags & WBFLAG_RECURSE,
580 /* Set ENOENT for consistency. Required by some apps */
583 return NSS_STATUS_UNAVAIL;
586 if ((request->extra_len != 0) &&
587 (winbind_write_sock(request->extra_data.data,
589 request->wb_flags & WBFLAG_RECURSE,
592 /* Set ENOENT for consistency. Required by some apps */
595 return NSS_STATUS_UNAVAIL;
598 return NSS_STATUS_SUCCESS;
602 * Get results from winbindd request
605 NSS_STATUS winbindd_get_response(struct winbindd_response *response)
607 struct winbindd_response lresponse;
610 ZERO_STRUCT(lresponse);
611 response = &lresponse;
614 init_response(response);
617 if (winbindd_read_reply(response) == -1) {
618 /* Set ENOENT for consistency. Required by some apps */
621 return NSS_STATUS_UNAVAIL;
624 /* Throw away extra data if client didn't request it */
625 if (response == &lresponse) {
626 winbindd_free_response(response);
629 /* Copy reply data from socket */
630 if (response->result != WINBINDD_OK) {
631 return NSS_STATUS_NOTFOUND;
634 return NSS_STATUS_SUCCESS;
637 /* Handle simple types of requests */
639 NSS_STATUS winbindd_request_response(int req_type,
640 struct winbindd_request *request,
641 struct winbindd_response *response)
643 NSS_STATUS status = NSS_STATUS_UNAVAIL;
646 while ((status == NSS_STATUS_UNAVAIL) && (count < 10)) {
647 status = winbindd_send_request(req_type, 0, request);
648 if (status != NSS_STATUS_SUCCESS)
650 status = winbindd_get_response(response);
657 NSS_STATUS winbindd_priv_request_response(int req_type,
658 struct winbindd_request *request,
659 struct winbindd_response *response)
661 NSS_STATUS status = NSS_STATUS_UNAVAIL;
664 while ((status == NSS_STATUS_UNAVAIL) && (count < 10)) {
665 status = winbindd_send_request(req_type, 1, request);
666 if (status != NSS_STATUS_SUCCESS)
668 status = winbindd_get_response(response);