3 * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
7 * Copyright (c) 1991, 1992, 1993
8 * Regents of the University of Michigan. All rights reserved.
10 * Redistribution and use in source and binary forms are permitted
11 * provided that this notice is preserved and that due credit is given
12 * to the University of Michigan at Ann Arbor. The name of the University
13 * may not be used to endorse or promote products derived from this
14 * software without specific prior written permission. This software
15 * is provided ``as is'' without express or implied warranty.
17 * The University of Michigan would like to thank the following people for
18 * their contributions to this piece of software:
20 * Robert Urquhart <robert@sfu.ca>
21 * Simon Fraser University, Academic Computing Services
28 #include <ac/stdlib.h>
36 #include <ac/signal.h>
37 #include <ac/string.h>
39 #include <ac/termios.h>
41 #include <ac/unistd.h>
43 #ifdef HAVE_SYS_FILE_H
50 #include "ldap_defaults.h"
54 * Used with change_base() to indicate which base we are changing.
59 #define iscom(x) (!strncasecmp((x), cmd, strlen(cmd)))
61 static char *server = NULL;
62 static char *config_file = UD_CONFIG_FILE;
63 static char *filter_file = FILTERFILE;
64 static int ldap_port = 0;
65 static int dereference = TRUE;
67 char *default_bind_object = NULL;
69 char *bound_dn; /* bound user's Distinguished Name */
70 char *group_base; /* place in LDAP tree where groups are */
71 char *search_base; /* place in LDAP tree where searches start */
73 static jmp_buf env; /* spot to jump to on an interrupt */
75 int lpp; /* lines per page */
76 int verbose; /* 1 if verbose mode on */
77 int col_size; /* characters across on the screen */
78 int bind_status; /* user's bind status */
80 LDAP *ld; /* LDAP descriptor */
81 LDAPFiltDesc *lfdp; /* LDAP filter descriptor */
84 int debug; /* debug flag */
86 int ldebug; /* library debug flag */
88 #ifndef HAVE_MKVERSION
89 char Version[] = OPENLDAP_PACKAGE " " OPENLDAP_VERSION " UserDirectory (ud)";
93 main( int argc, char **argv )
95 register int c; /* for parsing argv */
96 register char *cp; /* for parsing Version */
100 /* handle argument list */
101 while ((c = getopt(argc, argv, "c:d:Df:l:p:s:u:vV")) != -1) {
104 ldebug |= (int) strtol(optarg, (char **) NULL, 0);
108 debug |= (int) strtol(optarg, (char **) NULL, 0);
112 server = strdup(optarg);
115 filter_file = strdup(optarg);
118 config_file = optarg;
121 ldap_port = atoi(optarg);
124 default_bind_object = strdup(optarg);
127 verbose = 1; /* this is the default anyways... */
133 printf("\n\n Debug flag values\n\n");
134 printf(" 1 function trace\n");
135 printf(" 2 find() information\n");
136 printf(" 4 group information\n");
137 printf(" 8 mod() information\n");
138 printf(" 16 parsing information\n");
139 printf(" 32 output information\n");
140 printf(" 64 authentication information\n");
141 printf(" 128 initialization information\n\n");
142 format("These are masks, and may be added to form multiple debug levels. For example, '-d 35' would perform a function trace, print out information about the find() function, and would print out information about the output routines too.", 75, 2);
143 exit( EXIT_SUCCESS );
145 fprintf(stderr, "Usage: %s [-c filter-config-file] [-d debug-level] [-l ldap-debug-level] [-s server] [-p port] [-V]\n", argv[0]);
151 /* just print the first line of Version[] */
152 cp = strchr(Version, '\t');
159 (void) SIGNAL (SIGPIPE, SIG_IGN);
163 initialize_attribute_strings();
165 /* now tackle the user's commands */
175 LDAPMessage *mp; /* returned by find() */
176 register char *cp; /* misc char pointer */
177 register char *ap; /* misc char pointer */
178 static char cmd[MED_BUF_SIZE]; /* holds the command */
179 static char input[MED_BUF_SIZE]; /* buffer for input */
183 printf("->do_commands()\n");
186 printf("\n Enter a command. If you need help, type 'h' or '?' and hit RETURN.\n\n");
187 /* jump here on an interrupt */
193 /* Temporary kludge - if cp is null, dumps core under Solaris */
196 fetch_buffer(input, sizeof(input), stdin);
197 if (*input == '\0') {
201 while (isspace((unsigned char)*cp))
204 if (memset(cmd, '\0', sizeof(cmd)) == NULL)
206 while (!isspace((unsigned char)*cp) && (*cp != '\0'))
210 else if (iscom("stop") || iscom("quit"))
212 else if (iscom("cb") || iscom("cd") || iscom("moveto")) {
213 while (isspace((unsigned char)*cp) && (*cp != '\0'))
215 if (!strncasecmp(cp, "base", 4))
217 change_base(BASE_SEARCH, &search_base, nextstr(cp));
219 else if (iscom("memberships"))
220 (void) list_memberships(nextstr(cp));
221 else if (iscom("list"))
222 (void) list_groups(nextstr(cp));
223 else if (iscom("groupbase"))
224 change_base(BASE_GROUPS, &group_base, nextstr(cp));
225 else if (iscom("find") || iscom("display") || iscom("show")) {
227 if ((mp = find(cp, FALSE)) != NULL) {
233 printf(" Could not find \"%s\".\n", cp);
236 else if (iscom("vedit") && isatty( 1 )) {
238 else if (iscom("vedit")) {
240 (void) edit(nextstr(cp));
242 else if (iscom("modify") || iscom("change") || iscom("alter"))
243 (void) modify(nextstr(cp));
244 else if (iscom("bind") || iscom("iam"))
245 (void) auth(nextstr(cp), 0);
246 else if ((cmd[0] == '?') || iscom("help"))
247 print_help(nextstr(cp));
248 else if (iscom("join") || iscom("subscribe"))
249 (void) x_group(G_JOIN, nextstr(cp));
250 else if (iscom("resign") || iscom("unsubscribe"))
251 (void) x_group(G_RESIGN, nextstr(cp));
252 else if (!strncasecmp("create", cmd, strlen(cmd)))
253 add_group(nextstr(cp));
254 else if (!strncasecmp("remove", cmd, strlen(cmd)))
255 remove_group(nextstr(cp));
256 else if (!strncasecmp("purge", cmd, strlen(cmd)))
257 purge_group(nextstr(cp));
258 else if (!strncasecmp("verbose", cmd, strlen(cmd))) {
259 verbose = 1 - verbose;
261 printf(" Verbose mode has been turned on.\n");
263 else if (!strncasecmp("dereference", cmd, strlen(cmd))) {
265 dereference = 1 - dereference;
266 if (dereference == 1) {
267 deref = LDAP_DEREF_ALWAYS;
269 deref = LDAP_DEREF_NEVER;
271 ldap_set_option(ld, LDAP_OPT_DEREF, (void *) &deref);
273 else if (!strncasecmp("tidy", cmd, strlen(cmd)))
275 else if (cmd[0] == '\0')
278 printf(" Invalid command. Type \"help commands.\"\n");
280 printf(" Thank you!\n");
286 exit( EXIT_SUCCESS );
293 register char **rdns;
297 printf("->status()\n");
299 printf(" Current server is %s", server != NULL ? server : "<default>" );
303 ldap_get_option(ld, LDAP_OPT_HOST_NAME, &host);
306 ( server == NULL || strcasecmp( host, server ) != 0 ) )
308 printf( " (%s)", host );
312 printbase(" Search base is ", search_base);
313 printbase(" Group base is ", group_base);
314 if ( bound_dn != NULL ) {
315 rdns = ldap_explode_dn(bound_dn, TRUE);
316 printf(" Bound as \"%s\"\n", *rdns);
317 ldap_value_free(rdns);
319 printf(" Bound as Nobody\n" );
321 printf( " Verbose mode is %sabled\n", ( verbose ? "en" : "dis" ));
323 int deref = LDAP_DEREF_NEVER;
324 ldap_get_option(ld, LDAP_OPT_DEREF, &deref);
325 printf( " Aliases are %sbeing dereferenced\n",
326 ( deref == LDAP_DEREF_ALWAYS ) ? "" : "not" );
331 change_base( int type, char **base, char *s )
333 register char *cp; /* utility pointers */
334 char **rdns; /* for parsing */
335 char *output_string; /* for nice output */
336 int num_picked; /* # of selected base */
337 int j; /* used with num_picked */
338 int i = 1; /* index into choices array */
339 int matches; /* # of matches found */
340 int rest = 1; /* # left to display */
341 char tmp[MED_BUF_SIZE]; /* temporary buffer */
342 static char *choices[MED_BUF_SIZE]; /* bases from which to choose */
343 static char resp[SMALL_BUF_SIZE]; /* for prompting user */
344 static char buf[MED_BUF_SIZE];
345 static char *attrs[] = { "objectClass", NULL };
346 LDAPMessage *mp; /* results from a search */
347 LDAPMessage *ep; /* for going thru bases */
351 printf("->change_base(%s, %s)\n", s, s);
354 * If s is NULL we need to prompt the user for an argument.
358 printf(" You need to specify how the base is to be changed. Valid choices are:\n");
359 printf(" ? - list the choices immediately below this level\n");
360 printf(" .. - move up one level in the Directory tree\n");
361 printf(" root - move to the root of the Directory tree\n");
362 printf(" default - move to the default level built into this program\n");
363 printf(" <entry> - move to the entry specified\n");
365 printf(" Change base to? ");
367 fetch_buffer(buf, sizeof(buf), stdin);
368 if ((buf != NULL) && (buf[0] != '\0'))
372 /* set the output string */
373 if (type == BASE_SEARCH)
374 output_string = " Search base is now ";
375 else if (type == BASE_GROUPS)
376 output_string = " Group base is now ";
378 if (!strcasecmp(s, "root")) {
379 StrFreeDup(base, NULL);
380 printbase(" Search base is ", *base);
385 * User wants to ascend one level in the LDAP tree.
386 * Easy: Just strip off the first element of the
387 * current search base, unless it's the root, in
388 * which case we just do nothing.
390 if (!strcasecmp(s, "..")) {
392 printf(" You are already at the root\n");
395 cp = strchr(*base, '=');
398 * If there isn't a second "=" in the base, then this was
399 * a one element base, and so now it should be NULL.
401 if ((cp = strchr(cp, '=')) == NULL)
402 StrFreeDup(base, NULL);
405 * Back up to the start of this
409 * sequence now that 'cp' is pointing to the '='.
411 while(!isspace((unsigned char)*cp))
415 * Goofy, but need to do it this way since both *base
416 * and cp point into the same chunk of memory, and
417 * we want to free *base, but keep part of it around.
420 StrFreeDup(base, cp);
423 printbase(output_string, *base);
427 /* user wants to see what is directly below this level */
430 * Fetch the list of entries directly below this level.
431 * Once we have the list, we will print it for the user, one
432 * screenful at a time. At the end of each screen, we ask
433 * the user if they want to see more. They can also just
434 * type a number at that point too.
436 if (ldap_search_s(ld, *base, LDAP_SCOPE_ONELEVEL, "(|(objectClass=quipuNonLeafObject)(objectClass=externalNonLeafObject))", attrs, FALSE, &mp) != LDAP_SUCCESS) {
438 ldap_get_option(ld, LDAP_OPT_ERROR_NUMBER, &ld_errno);
439 if ((ld_errno == LDAP_TIMELIMIT_EXCEEDED) ||
440 (ld_errno == LDAP_SIZELIMIT_EXCEEDED)) {
442 printf(" Your query was too general and a limit was exceeded. The results listed\n");
443 printf(" are not complete. You may want to try again with a more refined query.\n\n");
446 printf(" Time or size limit exceeded. Partial results follow.\n\n");
448 ldap_perror(ld, "ldap_search_s");
452 if ((matches = ldap_count_entries(ld, mp)) < 1) {
453 printf(" There is nothing below this level.\n");
454 (void) ldap_msgfree(mp);
458 printf(" There are %d choices:\n", matches);
459 for (ep = ldap_first_entry(ld, mp); ep != NULL; ep = ldap_next_entry(ld, ep)) {
461 * Put the last component of the DN into 'lastDN'.
462 * If we are at the root level, convert any country
463 * codes to recognizable names for printing.
465 choices[i] = ldap_get_dn(ld, ep);
466 rdns = ldap_explode_dn(choices[i], TRUE);
467 printf(" %2d. %s\n", i, friendly_name(*rdns));
468 (void) ldap_value_free(rdns);
470 if ((rest++ > (lpp - 3)) && (i < matches)) {
473 fetch_buffer(resp, sizeof(resp), stdin);
474 if ((resp[0] == 'n') || (resp[0] == 'N'))
476 else if (((num_picked = atoi(resp)) != 0) && (num_picked < i))
482 if (num_picked != 0) {
487 printf(" Which number? ");
489 fetch_buffer(resp, sizeof(resp), stdin);
493 (void) ldap_msgfree(mp);
494 for (i = 0; i < matches; i++)
495 ldap_memfree(choices[i]);
498 if ((j < 1) || (j >= i))
499 printf(" Invalid number\n");
501 StrFreeDup(base, choices[j]);
502 printbase(output_string, *base);
503 (void) ldap_msgfree(mp);
504 for (i = 0; choices[i] != NULL; i++)
505 ldap_memfree(choices[i]);
510 /* set the search base back to the original default value */
511 else if (!strcasecmp(s, "default")) {
512 if (type == BASE_SEARCH)
513 StrFreeDup(base, NULL);
514 else if (type == BASE_GROUPS)
515 StrFreeDup(base, UD_WHERE_GROUPS_ARE_CREATED);
516 printbase(output_string, *base);
518 /* they typed in something -- see if it is legit */
520 /* user cannot do something like 'cb 33' */
522 printf(" \"%s\" is not a valid search base\n", s);
523 printf(" Base unchanged.\n");
524 printf(" Try using 'cb ?'\n");
527 /* was it a fully-specified DN? */
530 printbase(output_string, *base);
533 /* was it a RDN relative to the current base? */
534 sprintf(tmp, "ou=%s, %s", s, *base);
536 StrFreeDup(base, tmp);
537 printbase(output_string, *base);
540 printf(" \"%s\" is not a valid base\n Base unchanged.\n", s);
545 initialize_client( void )
547 FILE *fp; /* for config file */
548 static char buffer[MED_BUF_SIZE]; /* for input */
550 struct passwd *pw; /* for getting the home dir */
552 register char *cp; /* for fiddling with buffer */
553 char *config; /* config file to use */
554 static char bp[1024]; /* for tty set-up */
558 printf("->initialize_client()\n");
562 ber_set_option( NULL, LBER_OPT_DEBUG_LEVEL, &ldebug );
563 ldap_set_option( NULL, LDAP_OPT_DEBUG_LEVEL, &ldebug );
567 * A per-user config file has precedence over any system-wide
568 * config file, if one exists.
571 if ((pw = getpwuid((uid_t) geteuid())) == (struct passwd *) NULL)
572 config = config_file;
574 if (pw->pw_dir == NULL)
575 config = config_file;
577 sprintf(buffer, "%s/%s", pw->pw_dir,
578 UD_USER_CONFIG_FILE);
579 if (access(buffer, R_OK) == 0)
582 config = config_file;
586 config = config_file;
587 #endif /* getpwduid() */
589 if (debug & D_INITIALIZE)
590 printf("Using config file %s\n", config);
594 * If there is a config file, read it.
596 * Could have lines that look like this:
598 * server <ip-address or domain-name>
599 * base <default search base>
600 * groupbase <default place where groups are created>
603 if ((fp = fopen(config, "r")) != NULL) {
604 while (fgets(buffer, sizeof(buffer), fp) != NULL) {
605 buffer[strlen(buffer) - 1] = '\0';
606 if (!strncasecmp(buffer, "server", 6)) {
610 while (isspace((unsigned char)*cp))
612 if ((*cp == '\0') || (*cp == '\n'))
616 else if (!strncasecmp(buffer, "host", 4)) {
620 while (isspace((unsigned char)*cp))
622 if ((*cp == '\0') || (*cp == '\n'))
626 else if (!strncasecmp(buffer, "base", 4)) {
628 while (isspace((unsigned char)*cp))
630 if ((*cp == '\0') || (*cp == '\n'))
632 search_base = strdup(cp);
634 else if (!strncasecmp(buffer, "groupbase", 9)) {
636 while (isspace((unsigned char)*cp))
638 if ((*cp == '\0') || (*cp == '\n'))
640 group_base = strdup(cp);
643 fprintf(stderr, "?? -> %s\n", buffer);
646 if (group_base == NULL)
647 group_base = strdup(UD_WHERE_GROUPS_ARE_CREATED);
650 * Set up our LDAP connection. The values of retry and timeout
651 * are meaningless since we will immediately be doing a null bind
652 * because we want to be sure to use TCP, not UDP.
654 if ((ld = ldap_init(server, ldap_port)) == NULL) {
655 fprintf(stderr, " Initialization of LDAP session failed.\n");
656 exit( EXIT_FAILURE );
659 if (ldap_bind_s(ld, (char *) default_bind_object, NULL,
660 LDAP_AUTH_SIMPLE) != LDAP_SUCCESS) {
662 ldap_get_option(ld, LDAP_OPT_ERROR_NUMBER, &ld_errno);
664 fprintf(stderr, " The LDAP Directory is temporarily unavailable. Please try again later.\n");
665 if (ld_errno != LDAP_UNAVAILABLE)
666 ldap_perror(ld, " ldap_bind_s");
667 exit( EXIT_FAILURE );
671 int deref = LDAP_DEREF_ALWAYS;
672 ldap_set_option(ld, LDAP_OPT_DEREF, (void *) &deref);
674 bind_status = UD_NOT_BOUND;
675 if ( default_bind_object != NULL ) {
676 bound_dn = strdup(default_bind_object);
681 /* enabled local caching of ldap results, 15 minute lifetime */
682 ldap_enable_cache( ld, 60 * 15, 0 ); /* no memory limit */
684 /* initialize the search filters */
685 if ((lfdp = ldap_init_getfilter(filter_file)) == NULL) {
686 fprintf(stderr, " Problem with ldap_init_getfilter\n");
691 /* terminal initialization stuff goes here */
692 lpp = DEFAULT_TTY_HEIGHT;
693 col_size = DEFAULT_TTY_WIDTH;
695 (void) SIGNAL (SIGINT, attn);
701 if (((term = getenv("TERM")) == NULL) || (tgetent(bp, term) <= 0))
705 struct winsize win; /* for tty set-up */
706 if (ioctl(fileno(stdout), TIOCGWINSZ, &win) >= 0) {
707 if ((lpp = win.ws_row) == 0)
709 if ((col_size = win.ws_col) == 0)
710 col_size = tgetnum("co");
711 if ((lpp <= 0) || tgetflag("hc"))
712 lpp = DEFAULT_TTY_HEIGHT;
713 if ((col_size <= 0) || tgetflag("hc"))
714 col_size = DEFAULT_TTY_WIDTH;
715 (void) SIGNAL (SIGWINCH, chwinsz);
720 col_size = tgetnum("co");
732 printf("\n\n INTERRUPTED!\n");
734 (void) SIGNAL (SIGINT, attn);
739 #if !defined(NO_TERMCAP) && defined(TIOCGWINSZ)
745 (void) SIGNAL (SIGWINCH, SIG_IGN);
746 if (ioctl(fileno(stdout), TIOCGWINSZ, &win) != -1) {
750 col_size = win.ws_col;
753 (void) SIGNAL (SIGWINCH, chwinsz);