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 BOOL winbind_env_set( void );
28 BOOL winbind_off( void );
29 BOOL winbind_on( void );
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 free_response(struct winbindd_response *response)
40 /* Free any allocated extra_data */
43 SAFE_FREE(response->extra_data.data);
46 /* Initialise a request structure */
48 void init_request(struct winbindd_request *request, int request_type)
50 request->length = sizeof(struct winbindd_request);
52 request->cmd = (enum winbindd_cmd)request_type;
53 request->pid = getpid();
57 /* Initialise a response structure */
59 static void init_response(struct winbindd_response *response)
61 /* Initialise return value */
63 response->result = WINBINDD_ERROR;
66 /* Close established socket */
70 if (winbindd_fd != -1) {
76 #define CONNECT_TIMEOUT 30
78 /* Make sure socket handle isn't stdin, stdout or stderr */
79 #define RECURSION_LIMIT 3
81 static int make_nonstd_fd_internals(int fd, int limit /* Recursion limiter */)
84 if (fd >= 0 && fd <= 2) {
86 if ((new_fd = fcntl(fd, F_DUPFD, 3)) == -1) {
104 /* use the program stack to hold our list of FDs to close */
105 new_fd = make_nonstd_fd_internals(new_fd, limit - 1);
113 /****************************************************************************
114 Set a fd into blocking/nonblocking mode. Uses POSIX O_NONBLOCK if available,
118 Set close on exec also.
119 ****************************************************************************/
121 static int make_safe_fd(int fd)
124 int new_fd = make_nonstd_fd_internals(fd, RECURSION_LIMIT);
130 /* Socket should be nonblocking. */
132 #define FLAG_TO_SET O_NONBLOCK
135 #define FLAG_TO_SET O_NDELAY
137 #define FLAG_TO_SET FNDELAY
141 if ((flags = fcntl(new_fd, F_GETFL)) == -1) {
146 flags |= FLAG_TO_SET;
147 if (fcntl(new_fd, F_SETFL, flags) == -1) {
154 /* Socket should be closed on exec() */
156 result = flags = fcntl(new_fd, F_GETFD, 0);
159 result = fcntl( new_fd, F_SETFD, flags );
169 /* Connect to winbindd socket */
171 static int winbind_named_pipe_sock(const char *dir)
173 struct sockaddr_un sunaddr;
180 /* Check permissions on unix socket directory */
182 if (lstat(dir, &st) == -1) {
186 if (!S_ISDIR(st.st_mode) ||
187 (st.st_uid != 0 && st.st_uid != geteuid())) {
191 /* Connect to socket */
193 strncpy(path, dir, sizeof(path) - 1);
194 path[sizeof(path) - 1] = '\0';
196 strncat(path, "/", sizeof(path) - 1 - strlen(path));
197 path[sizeof(path) - 1] = '\0';
199 strncat(path, WINBINDD_SOCKET_NAME, sizeof(path) - 1 - strlen(path));
200 path[sizeof(path) - 1] = '\0';
202 ZERO_STRUCT(sunaddr);
203 sunaddr.sun_family = AF_UNIX;
204 strncpy(sunaddr.sun_path, path, sizeof(sunaddr.sun_path) - 1);
206 /* If socket file doesn't exist, don't bother trying to connect
207 with retry. This is an attempt to make the system usable when
208 the winbindd daemon is not running. */
210 if (lstat(path, &st) == -1) {
214 /* Check permissions on unix socket file */
216 if (!S_ISSOCK(st.st_mode) ||
217 (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)
248 tv.tv_sec = CONNECT_TIMEOUT - wait_time;
251 ret = select(fd + 1, NULL, &w_fds, NULL, &tv);
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 /* Connect to winbindd socket */
289 static int winbind_open_pipe_sock(int recursing, int need_priv)
291 #ifdef HAVE_UNIXSOCKET
292 static pid_t our_pid;
293 struct winbindd_request request;
294 struct winbindd_response response;
295 ZERO_STRUCT(request);
296 ZERO_STRUCT(response);
298 if (our_pid != getpid()) {
303 if ((need_priv != 0) && (is_privileged == 0)) {
307 if (winbindd_fd != -1) {
315 if ((winbindd_fd = winbind_named_pipe_sock(WINBINDD_SOCKET_DIR)) == -1) {
321 /* version-check the socket */
323 request.flags = WBFLAG_RECURSE;
324 if ((winbindd_request_response(WINBINDD_INTERFACE_VERSION, &request, &response) != NSS_STATUS_SUCCESS) || (response.data.interface_version != WINBIND_INTERFACE_VERSION)) {
329 /* try and get priv pipe */
331 request.flags = WBFLAG_RECURSE;
332 if (winbindd_request_response(WINBINDD_PRIV_PIPE_DIR, &request, &response) == NSS_STATUS_SUCCESS) {
334 if ((fd = winbind_named_pipe_sock((char *)response.extra_data.data)) != -1) {
341 if ((need_priv != 0) && (is_privileged == 0)) {
345 SAFE_FREE(response.extra_data.data);
350 #endif /* HAVE_UNIXSOCKET */
353 /* Write data to winbindd socket */
355 int write_sock(void *buffer, int count, int recursing, int need_priv)
357 int result, nwritten;
359 /* Open connection to winbind daemon */
363 if (winbind_open_pipe_sock(recursing, need_priv) == -1) {
367 /* Write data to socket */
371 while(nwritten < count) {
375 /* Catch pipe close on other end by checking if a read()
376 call would not block by calling select(). */
379 FD_SET(winbindd_fd, &r_fds);
382 if (select(winbindd_fd + 1, &r_fds, NULL, NULL, &tv) == -1) {
384 return -1; /* Select error */
387 /* Write should be OK if fd not available for reading */
389 if (!FD_ISSET(winbindd_fd, &r_fds)) {
393 result = write(winbindd_fd,
394 (char *)buffer + nwritten,
397 if ((result == -1) || (result == 0)) {
409 /* Pipe has closed on remote end */
419 /* Read data from winbindd socket */
421 static int read_sock(void *buffer, int count)
424 int total_time = 0, selret;
426 if (winbindd_fd == -1) {
430 /* Read data from socket */
431 while(nread < count) {
435 /* Catch pipe close on other end by checking if a read()
436 call would not block by calling select(). */
439 FD_SET(winbindd_fd, &r_fds);
441 /* Wait for 5 seconds for a reply. May need to parameterise this... */
444 if ((selret = select(winbindd_fd + 1, &r_fds, NULL, NULL, &tv)) == -1) {
446 return -1; /* Select error */
450 /* Not ready for read yet... */
451 if (total_time >= 30) {
460 if (FD_ISSET(winbindd_fd, &r_fds)) {
464 int result = read(winbindd_fd, (char *)buffer + nread,
467 if ((result == -1) || (result == 0)) {
469 /* Read failed. I think the only useful thing we
470 can do here is just return -1 and fail since the
471 transaction has failed half way through. */
487 int read_reply(struct winbindd_response *response)
489 int result1, result2 = 0;
495 /* Read fixed length response */
497 if ((result1 = read_sock(response, sizeof(struct winbindd_response)))
503 /* We actually send the pointer value of the extra_data field from
504 the server. This has no meaning in the client's address space
505 so we clear it out. */
507 response->extra_data.data = NULL;
509 /* Read variable length response */
511 if (response->length > sizeof(struct winbindd_response)) {
512 int extra_data_len = response->length -
513 sizeof(struct winbindd_response);
515 /* Mallocate memory for extra data */
517 if (!(response->extra_data.data = malloc(extra_data_len))) {
521 if ((result2 = read_sock(response->extra_data.data, extra_data_len))
523 free_response(response);
528 /* Return total amount of data read */
530 return result1 + result2;
533 BOOL winbind_env_set( void )
537 if ((env=getenv(WINBINDD_DONT_ENV)) != NULL) {
538 if(strcmp(env, "1") == 0) {
546 * send simple types of requests
549 NSS_STATUS winbindd_send_request(int req_type, int need_priv,
550 struct winbindd_request *request)
552 struct winbindd_request lrequest;
554 /* Check for our tricky environment variable */
556 if (winbind_env_set()) {
557 return NSS_STATUS_NOTFOUND;
561 ZERO_STRUCT(lrequest);
565 /* Fill in request and send down pipe */
567 init_request(request, req_type);
569 if (write_sock(request, sizeof(*request),
570 request->flags & WBFLAG_RECURSE, need_priv) == -1) {
571 return NSS_STATUS_UNAVAIL;
574 if ((request->extra_len != 0) &&
575 (write_sock(request->extra_data.data, request->extra_len,
576 request->flags & WBFLAG_RECURSE, need_priv) == -1)) {
577 return NSS_STATUS_UNAVAIL;
580 return NSS_STATUS_SUCCESS;
584 * Get results from winbindd request
587 NSS_STATUS winbindd_get_response(struct winbindd_response *response)
589 struct winbindd_response lresponse;
592 ZERO_STRUCT(lresponse);
593 response = &lresponse;
596 init_response(response);
599 if (read_reply(response) == -1) {
600 return NSS_STATUS_UNAVAIL;
603 /* Throw away extra data if client didn't request it */
604 if (response == &lresponse) {
605 free_response(response);
608 /* Copy reply data from socket */
609 if (response->result != WINBINDD_OK) {
610 return NSS_STATUS_NOTFOUND;
613 return NSS_STATUS_SUCCESS;
616 /* Handle simple types of requests */
618 NSS_STATUS winbindd_request_response(int req_type,
619 struct winbindd_request *request,
620 struct winbindd_response *response)
622 NSS_STATUS status = NSS_STATUS_UNAVAIL;
625 while ((status == NSS_STATUS_UNAVAIL) && (count < 10)) {
626 status = winbindd_send_request(req_type, 0, request);
627 if (status != NSS_STATUS_SUCCESS)
629 status = winbindd_get_response(response);
636 NSS_STATUS winbindd_priv_request_response(int req_type,
637 struct winbindd_request *request,
638 struct winbindd_response *response)
640 NSS_STATUS status = NSS_STATUS_UNAVAIL;
643 while ((status == NSS_STATUS_UNAVAIL) && (count < 10)) {
644 status = winbindd_send_request(req_type, 1, request);
645 if (status != NSS_STATUS_SUCCESS)
647 status = winbindd_get_response(response);
654 /*************************************************************************
655 A couple of simple functions to disable winbindd lookups and re-
657 ************************************************************************/
659 /* Use putenv() instead of setenv() in these functions as not all
660 environments have the latter. */
662 BOOL winbind_off( void )
664 static char *s = CONST_DISCARD(char *, WINBINDD_DONT_ENV "=1");
666 return putenv(s) != -1;
669 BOOL winbind_on( void )
671 static char *s = CONST_DISCARD(char *, WINBINDD_DONT_ENV "=0");
673 return putenv(s) != -1;
676 /*************************************************************************
677 ************************************************************************/
679 const char *nss_err_str(NSS_STATUS ret)
682 case NSS_STATUS_TRYAGAIN:
683 return "NSS_STATUS_TRYAGAIN";
684 case NSS_STATUS_SUCCESS:
685 return "NSS_STATUS_SUCCESS";
686 case NSS_STATUS_NOTFOUND:
687 return "NSS_STATUS_NOTFOUND";
688 case NSS_STATUS_UNAVAIL:
689 return "NSS_STATUS_UNAVAIL";
690 #ifdef NSS_STATUS_RETURN
691 case NSS_STATUS_RETURN:
692 return "NSS_STATUS_RETURN";
695 return "UNKNOWN RETURN CODE!!!!!!!";