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 #include "winbind_client.h"
27 /* Global variables. These are effectively the client state information */
29 int winbindd_fd = -1; /* fd for winbindd socket */
30 static int is_privileged = 0;
32 /* Free a response structure */
34 void winbindd_free_response(struct winbindd_response *response)
36 /* Free any allocated extra_data */
39 SAFE_FREE(response->extra_data.data);
42 /* Initialise a request structure */
44 void winbindd_init_request(struct winbindd_request *request, int request_type)
46 request->length = sizeof(struct winbindd_request);
48 request->cmd = (enum winbindd_cmd)request_type;
49 request->pid = getpid();
53 /* Initialise a response structure */
55 static void init_response(struct winbindd_response *response)
57 /* Initialise return value */
59 response->result = WINBINDD_ERROR;
62 /* Close established socket */
64 #if HAVE_FUNCTION_ATTRIBUTE_DESTRUCTOR
65 __attribute__((destructor))
67 void winbind_close_sock(void)
69 if (winbindd_fd != -1) {
75 #define CONNECT_TIMEOUT 30
77 /* Make sure socket handle isn't stdin, stdout or stderr */
78 #define RECURSION_LIMIT 3
80 static int make_nonstd_fd_internals(int fd, int limit /* Recursion limiter */)
83 if (fd >= 0 && fd <= 2) {
85 if ((new_fd = fcntl(fd, F_DUPFD, 3)) == -1) {
103 /* use the program stack to hold our list of FDs to close */
104 new_fd = make_nonstd_fd_internals(new_fd, limit - 1);
112 /****************************************************************************
113 Set a fd into blocking/nonblocking mode. Uses POSIX O_NONBLOCK if available,
117 Set close on exec also.
118 ****************************************************************************/
120 static int make_safe_fd(int fd)
123 int new_fd = make_nonstd_fd_internals(fd, RECURSION_LIMIT);
129 /* Socket should be nonblocking. */
131 #define FLAG_TO_SET O_NONBLOCK
134 #define FLAG_TO_SET O_NDELAY
136 #define FLAG_TO_SET FNDELAY
140 if ((flags = fcntl(new_fd, F_GETFL)) == -1) {
145 flags |= FLAG_TO_SET;
146 if (fcntl(new_fd, F_SETFL, flags) == -1) {
153 /* Socket should be closed on exec() */
155 result = flags = fcntl(new_fd, F_GETFD, 0);
158 result = fcntl( new_fd, F_SETFD, flags );
168 /* Connect to winbindd socket */
170 static int winbind_named_pipe_sock(const char *dir)
172 struct sockaddr_un sunaddr;
179 /* Check permissions on unix socket directory */
181 if (lstat(dir, &st) == -1) {
186 if (!S_ISDIR(st.st_mode) ||
187 (st.st_uid != 0 && st.st_uid != geteuid())) {
192 /* Connect to socket */
194 if (asprintf(&path, "%s/%s", dir, WINBINDD_SOCKET_NAME) < 0) {
198 ZERO_STRUCT(sunaddr);
199 sunaddr.sun_family = AF_UNIX;
200 strncpy(sunaddr.sun_path, path, sizeof(sunaddr.sun_path) - 1);
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. */
206 if (lstat(path, &st) == -1) {
213 /* Check permissions on unix socket file */
215 if (!S_ISSOCK(st.st_mode) ||
216 (st.st_uid != 0 && st.st_uid != geteuid())) {
221 /* Connect to socket */
223 if ((fd = socket(AF_UNIX, SOCK_STREAM, 0)) == -1) {
227 /* Set socket non-blocking and close on exec. */
229 if ((fd = make_safe_fd( fd)) == -1) {
233 for (wait_time = 0; connect(fd, (struct sockaddr *)&sunaddr, sizeof(sunaddr)) == -1;
234 wait_time += slept) {
238 int connect_errno = 0;
241 if (wait_time >= CONNECT_TIMEOUT)
247 if (fd < 0 || fd >= FD_SETSIZE) {
252 tv.tv_sec = CONNECT_TIMEOUT - wait_time;
255 ret = select(fd + 1, NULL, &w_fds, NULL, &tv);
258 errnosize = sizeof(connect_errno);
260 ret = getsockopt(fd, SOL_SOCKET,
261 SO_ERROR, &connect_errno, &errnosize);
263 if (ret >= 0 && connect_errno == 0) {
264 /* Connect succeed */
269 slept = CONNECT_TIMEOUT;
272 slept = rand() % 3 + 1;
291 static const char *winbindd_socket_dir(void)
293 #ifdef SOCKET_WRAPPER
296 env_dir = getenv(WINBINDD_SOCKET_DIR_ENVVAR);
302 return WINBINDD_SOCKET_DIR;
305 /* Connect to winbindd socket */
307 static int winbind_open_pipe_sock(int recursing, int need_priv)
309 #ifdef HAVE_UNIXSOCKET
310 static pid_t our_pid;
311 struct winbindd_request request;
312 struct winbindd_response response;
313 ZERO_STRUCT(request);
314 ZERO_STRUCT(response);
316 if (our_pid != getpid()) {
317 winbind_close_sock();
321 if ((need_priv != 0) && (is_privileged == 0)) {
322 winbind_close_sock();
325 if (winbindd_fd != -1) {
333 if ((winbindd_fd = winbind_named_pipe_sock(winbindd_socket_dir())) == -1) {
339 /* version-check the socket */
341 request.wb_flags = WBFLAG_RECURSE;
342 if ((winbindd_request_response(WINBINDD_INTERFACE_VERSION, &request, &response) != NSS_STATUS_SUCCESS) || (response.data.interface_version != WINBIND_INTERFACE_VERSION)) {
343 winbind_close_sock();
347 /* try and get priv pipe */
349 request.wb_flags = WBFLAG_RECURSE;
350 if (winbindd_request_response(WINBINDD_PRIV_PIPE_DIR, &request, &response) == NSS_STATUS_SUCCESS) {
352 if ((fd = winbind_named_pipe_sock((char *)response.extra_data.data)) != -1) {
359 if ((need_priv != 0) && (is_privileged == 0)) {
363 SAFE_FREE(response.extra_data.data);
368 #endif /* HAVE_UNIXSOCKET */
371 /* Write data to winbindd socket */
373 int winbind_write_sock(void *buffer, int count, int recursing, int need_priv)
375 int result, nwritten;
377 /* Open connection to winbind daemon */
381 if (winbind_open_pipe_sock(recursing, need_priv) == -1) {
386 /* Write data to socket */
390 while(nwritten < count) {
394 /* Catch pipe close on other end by checking if a read()
395 call would not block by calling select(). */
398 if (winbindd_fd < 0 || winbindd_fd >= FD_SETSIZE) {
400 winbind_close_sock();
403 FD_SET(winbindd_fd, &r_fds);
406 if (select(winbindd_fd + 1, &r_fds, NULL, NULL, &tv) == -1) {
407 winbind_close_sock();
408 return -1; /* Select error */
411 /* Write should be OK if fd not available for reading */
413 if (!FD_ISSET(winbindd_fd, &r_fds)) {
417 result = write(winbindd_fd,
418 (char *)buffer + nwritten,
421 if ((result == -1) || (result == 0)) {
425 winbind_close_sock();
433 /* Pipe has closed on remote end */
435 winbind_close_sock();
443 /* Read data from winbindd socket */
445 int winbind_read_sock(void *buffer, int count)
448 int total_time = 0, selret;
450 if (winbindd_fd == -1) {
454 /* Read data from socket */
455 while(nread < count) {
459 /* Catch pipe close on other end by checking if a read()
460 call would not block by calling select(). */
463 if (winbindd_fd < 0 || winbindd_fd >= FD_SETSIZE) {
465 winbind_close_sock();
468 FD_SET(winbindd_fd, &r_fds);
470 /* Wait for 5 seconds for a reply. May need to parameterise this... */
473 if ((selret = select(winbindd_fd + 1, &r_fds, NULL, NULL, &tv)) == -1) {
474 winbind_close_sock();
475 return -1; /* Select error */
479 /* Not ready for read yet... */
480 if (total_time >= 30) {
482 winbind_close_sock();
489 if (FD_ISSET(winbindd_fd, &r_fds)) {
493 int result = read(winbindd_fd, (char *)buffer + nread,
496 if ((result == -1) || (result == 0)) {
498 /* Read failed. I think the only useful thing we
499 can do here is just return -1 and fail since the
500 transaction has failed half way through. */
502 winbind_close_sock();
516 int winbindd_read_reply(struct winbindd_response *response)
518 int result1, result2 = 0;
524 /* Read fixed length response */
526 result1 = winbind_read_sock(response,
527 sizeof(struct winbindd_response));
532 /* We actually send the pointer value of the extra_data field from
533 the server. This has no meaning in the client's address space
534 so we clear it out. */
536 response->extra_data.data = NULL;
538 /* Read variable length response */
540 if (response->length > sizeof(struct winbindd_response)) {
541 int extra_data_len = response->length -
542 sizeof(struct winbindd_response);
544 /* Mallocate memory for extra data */
546 if (!(response->extra_data.data = malloc(extra_data_len))) {
550 result2 = winbind_read_sock(response->extra_data.data,
553 winbindd_free_response(response);
558 /* Return total amount of data read */
560 return result1 + result2;
564 * send simple types of requests
567 NSS_STATUS winbindd_send_request(int req_type, int need_priv,
568 struct winbindd_request *request)
570 struct winbindd_request lrequest;
572 /* Check for our tricky environment variable */
574 if (winbind_env_set()) {
575 return NSS_STATUS_NOTFOUND;
579 ZERO_STRUCT(lrequest);
583 /* Fill in request and send down pipe */
585 winbindd_init_request(request, req_type);
587 if (winbind_write_sock(request, sizeof(*request),
588 request->wb_flags & WBFLAG_RECURSE,
591 /* Set ENOENT for consistency. Required by some apps */
594 return NSS_STATUS_UNAVAIL;
597 if ((request->extra_len != 0) &&
598 (winbind_write_sock(request->extra_data.data,
600 request->wb_flags & WBFLAG_RECURSE,
603 /* Set ENOENT for consistency. Required by some apps */
606 return NSS_STATUS_UNAVAIL;
609 return NSS_STATUS_SUCCESS;
613 * Get results from winbindd request
616 NSS_STATUS winbindd_get_response(struct winbindd_response *response)
618 struct winbindd_response lresponse;
621 ZERO_STRUCT(lresponse);
622 response = &lresponse;
625 init_response(response);
628 if (winbindd_read_reply(response) == -1) {
629 /* Set ENOENT for consistency. Required by some apps */
632 return NSS_STATUS_UNAVAIL;
635 /* Throw away extra data if client didn't request it */
636 if (response == &lresponse) {
637 winbindd_free_response(response);
640 /* Copy reply data from socket */
641 if (response->result != WINBINDD_OK) {
642 return NSS_STATUS_NOTFOUND;
645 return NSS_STATUS_SUCCESS;
648 /* Handle simple types of requests */
650 NSS_STATUS winbindd_request_response(int req_type,
651 struct winbindd_request *request,
652 struct winbindd_response *response)
654 NSS_STATUS status = NSS_STATUS_UNAVAIL;
657 while ((status == NSS_STATUS_UNAVAIL) && (count < 10)) {
658 status = winbindd_send_request(req_type, 0, request);
659 if (status != NSS_STATUS_SUCCESS)
661 status = winbindd_get_response(response);
668 NSS_STATUS winbindd_priv_request_response(int req_type,
669 struct winbindd_request *request,
670 struct winbindd_response *response)
672 NSS_STATUS status = NSS_STATUS_UNAVAIL;
675 while ((status == NSS_STATUS_UNAVAIL) && (count < 10)) {
676 status = winbindd_send_request(req_type, 1, request);
677 if (status != NSS_STATUS_SUCCESS)
679 status = winbindd_get_response(response);
686 /*************************************************************************
687 ************************************************************************/
689 const char *nss_err_str(NSS_STATUS ret)
692 case NSS_STATUS_TRYAGAIN:
693 return "NSS_STATUS_TRYAGAIN";
694 case NSS_STATUS_SUCCESS:
695 return "NSS_STATUS_SUCCESS";
696 case NSS_STATUS_NOTFOUND:
697 return "NSS_STATUS_NOTFOUND";
698 case NSS_STATUS_UNAVAIL:
699 return "NSS_STATUS_UNAVAIL";
700 #ifdef NSS_STATUS_RETURN
701 case NSS_STATUS_RETURN:
702 return "NSS_STATUS_RETURN";
705 return "UNKNOWN RETURN CODE!!!!!!!";