2 * Copyright (c) 1991, 1992, 1993
3 * Regents of the University of Michigan. All rights reserved.
5 * Redistribution and use in source and binary forms are permitted
6 * provided that this notice is preserved and that due credit is given
7 * to the University of Michigan at Ann Arbor. The name of the University
8 * may not be used to endorse or promote products derived from this
9 * software without specific prior written permission. This software
10 * is provided ``as is'' without express or implied warranty.
12 * The University of Michigan would like to thank the following people for
13 * their contributions to this piece of software:
15 * Robert Urquhart <robert@sfu.ca>
16 * Simon Fraser University, Academic Computing Services
26 #include <ac/signal.h>
27 #include <ac/string.h>
28 #include <ac/termios.h>
30 #include <ac/unistd.h>
32 #ifdef HAVE_SYS_FILE_H
39 #include <ldapconfig.h>
44 "@(#) Copyright (c) 1991, 1992, 1993 Regents of the University of Michigan.\nAll rights reserved.\n";
48 * Used with change_base() to indicate which base we are changing.
53 #define iscom(x) (!strncasecmp(x, cmd, strlen(cmd)))
55 static char *server = NULL;
56 static char *config_file = UD_CONFIG_FILE;
57 static char *filter_file = FILTERFILE;
58 static int ldap_port = LDAP_PORT;
59 static int dereference = TRUE;
61 char *default_bind_object = NULL;
63 char *bound_dn; /* bound user's Distinguished Name */
64 char *group_base; /* place in LDAP tree where groups are */
65 char *search_base; /* place in LDAP tree where searches start */
67 static jmp_buf env; /* spot to jump to on an interrupt */
69 int lpp; /* lines per page */
70 int verbose; /* 1 if verbose mode on */
71 int col_size; /* characters across on the screen */
72 int bind_status; /* user's bind status */
74 LDAP *ld; /* LDAP descriptor */
75 LDAPFiltDesc *lfdp; /* LDAP filter descriptor */
78 int debug; /* debug flag */
81 extern void initialize_client();
82 extern void initialize_attribute_strings();
88 extern char Version[]; /* version number */
89 extern char *optarg; /* for parsing argv */
90 register int c; /* for parsing argv */
91 register char *cp; /* for parsing Version */
95 /* handle argument list */
96 while ((c = getopt(argc, argv, "c:d:Df:l:p:s:u:vV")) != -1) {
100 ldap_debug = (int) strtol(optarg, (char **) NULL, 0);
101 lber_debug = ldap_debug;
106 debug = (int) strtol(optarg, (char **) NULL, 0);
110 server = strdup(optarg);
113 filter_file = strdup(optarg);
116 config_file = optarg;
119 ldap_port = atoi(optarg);
122 default_bind_object = strdup(optarg);
125 verbose = 1; /* this is the default anyways... */
131 printf("\n\n Debug flag values\n\n");
132 printf(" 1 function trace\n");
133 printf(" 2 find() information\n");
134 printf(" 4 group information\n");
135 printf(" 8 mod() information\n");
136 printf(" 16 parsing information\n");
137 printf(" 32 output information\n");
138 printf(" 64 authentication information\n");
139 printf(" 128 initialization information\n\n");
140 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 fprintf(stderr, "Usage: %s [-c filter-config-file] [-d debug-level] [-l ldap-debug-level] [-s server] [-p port] [-V]\n", argv[0]);
149 /* just print the first line of Version[] */
150 cp = strchr(Version, '\t');
157 initialize_attribute_strings();
159 /* now tackle the user's commands */
166 LDAPMessage *mp; /* returned by find() */
167 register char *cp; /* misc char pointer */
168 register char *ap; /* misc char pointer */
169 static char buf[MED_BUF_SIZE]; /* for prompting */
170 static char cmd[MED_BUF_SIZE]; /* holds the command */
171 static char input[MED_BUF_SIZE]; /* buffer for input */
172 extern LDAPMessage *find();
173 extern void purge_group(), add_group(), remove_group(), x_group(),
174 tidy_up(), list_groups(), list_memberships(), edit();
175 extern char *nextstr();
179 printf("->do_commands()\n");
182 printf("\n Enter a command. If you need help, type 'h' or '?' and hit RETURN.\n\n");
183 /* jump here on an interrupt */
189 /* Temporary kludge - if cp is null, dumps core under Solaris */
192 fetch_buffer(input, sizeof(input), stdin);
193 if (*input == '\0') {
200 if (memset(cmd, '\0', sizeof(cmd)) == NULL)
202 while (!isspace(*cp) && (*cp != '\0'))
206 else if (iscom("stop") || iscom("quit"))
208 else if (iscom("cb") || iscom("cd") || iscom("moveto")) {
209 while (isspace(*cp) && (*cp != '\0'))
211 if (!strncasecmp(cp, "base", 4))
213 change_base(BASE_SEARCH, &search_base, nextstr(cp));
215 else if (iscom("memberships"))
216 (void) list_memberships(nextstr(cp));
217 else if (iscom("list"))
218 (void) list_groups(nextstr(cp));
219 else if (iscom("groupbase"))
220 change_base(BASE_GROUPS, &group_base, nextstr(cp));
221 else if (iscom("find") || iscom("display") || iscom("show")) {
223 if ((mp = find(cp, FALSE)) != NULL) {
229 printf(" Could not find \"%s\".\n", cp);
232 else if (iscom("vedit") && isatty( 1 )) {
234 else if (iscom("vedit")) {
236 (void) edit(nextstr(cp));
238 else if (iscom("modify") || iscom("change") || iscom("alter"))
239 (void) modify(nextstr(cp));
240 else if (iscom("bind") || iscom("iam"))
241 (void) auth(nextstr(cp), 0);
242 else if ((cmd[0] == '?') || iscom("help"))
243 print_help(nextstr(cp));
244 else if (iscom("join") || iscom("subscribe"))
245 (void) x_group(G_JOIN, nextstr(cp));
246 else if (iscom("resign") || iscom("unsubscribe"))
247 (void) x_group(G_RESIGN, nextstr(cp));
248 else if (!strncasecmp("create", cmd, strlen(cmd)))
249 add_group(nextstr(cp));
250 else if (!strncasecmp("remove", cmd, strlen(cmd)))
251 remove_group(nextstr(cp));
252 else if (!strncasecmp("purge", cmd, strlen(cmd)))
253 purge_group(nextstr(cp));
254 else if (!strncasecmp("verbose", cmd, strlen(cmd))) {
255 verbose = 1 - verbose;
257 printf(" Verbose mode has been turned on.\n");
259 else if (!strncasecmp("dereference", cmd, strlen(cmd))) {
261 dereference = 1 - dereference;
262 if (dereference == 1) {
263 deref = LDAP_DEREF_ALWAYS;
265 deref = LDAP_DEREF_NEVER;
267 ldap_set_option(ld, LDAP_OPT_DEREF, (void *) &deref);
269 else if (!strncasecmp("tidy", cmd, strlen(cmd)))
271 else if (cmd[0] == '\0')
274 printf(" Invalid command. Type \"help commands.\"\n");
276 printf(" Thank you!\n");
289 register char **rdns;
294 printf("->status()\n");
296 printf(" Current server is %s", server);
300 ldap_get_option(ld, LDAP_OPT_HOST_NAME, &host);
302 if (( host != NULL ) && (strcasecmp( host, server ) != 0 )) {
303 printf( " (%s)", host );
307 printbase(" Search base is ", search_base);
308 printbase(" Group base is ", group_base);
309 if ( bound_dn != NULL ) {
310 rdns = ldap_explode_dn(bound_dn, TRUE);
311 printf(" Bound as \"%s\"\n", *rdns);
312 ldap_value_free(rdns);
314 printf(" Bound as Nobody\n" );
316 printf( " Verbose mode is %sabled\n", ( verbose ? "en" : "dis" ));
318 int deref = LDAP_DEREF_NEVER;
319 ldap_get_option(ld, LDAP_OPT_DEREF, &deref);
320 printf( " Aliases are %sbeing dereferenced\n",
321 ( deref == LDAP_DEREF_ALWAYS ) ? "" : "not" );
325 change_base(type, base, s)
329 register char *cp; /* utility pointers */
330 char **rdns; /* for parsing */
331 char *output_string; /* for nice output */
332 int num_picked; /* # of selected base */
333 int j; /* used with num_picked */
334 int i = 1; /* index into choices array */
335 int matches; /* # of matches found */
336 int rest = 1; /* # left to display */
337 char tmp[MED_BUF_SIZE]; /* temporary buffer */
338 static char *choices[MED_BUF_SIZE]; /* bases from which to choose */
339 static char resp[SMALL_BUF_SIZE]; /* for prompting user */
340 static char buf[MED_BUF_SIZE];
342 static char *attrs[] = { "objectClass", NULL };
343 LDAPMessage *mp; /* results from a search */
344 LDAPMessage *ep; /* for going thru bases */
345 extern char * friendly_name();
346 extern void StrFreeDup();
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 '='.
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++)
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++)
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);
544 void initialize_client()
546 FILE *fp; /* for config file */
547 static char buffer[MED_BUF_SIZE]; /* for input */
548 struct passwd *pw; /* for getting the home dir */
549 register char *cp; /* for fiddling with buffer */
550 char *term; /* for tty set-up */
551 char *config; /* config file to use */
552 static char bp[1024]; /* for tty set-up */
553 extern RETSIGTYPE attn(); /* ^C signal handler */
554 extern char *getenv();
559 printf("->initialize_client()\n");
562 * A per-user config file has precedence over any system-wide
563 * config file, if one exists.
565 if ((pw = getpwuid((uid_t) geteuid())) == (struct passwd *) NULL)
566 config = config_file;
568 if (pw->pw_dir == NULL)
569 config = config_file;
571 sprintf(buffer, "%s/%s", pw->pw_dir,
572 UD_USER_CONFIG_FILE);
573 if (access(buffer, R_OK) == 0)
576 config = config_file;
580 if (debug & D_INITIALIZE)
581 printf("Using config file %s\n", config);
585 * If there is a config file, read it.
587 * Could have lines that look like this:
589 * server <ip-address or domain-name>
590 * base <default search base>
591 * groupbase <default place where groups are created>
594 if ((fp = fopen(config, "r")) != NULL) {
595 while (fgets(buffer, sizeof(buffer), fp) != NULL) {
596 buffer[strlen(buffer) - 1] = '\0';
597 if (!strncasecmp(buffer, "server", 6)) {
603 if ((*cp == '\0') || (*cp == '\n'))
607 else if (!strncasecmp(buffer, "host", 4)) {
613 if ((*cp == '\0') || (*cp == '\n'))
617 else if (!strncasecmp(buffer, "base", 4)) {
621 if ((*cp == '\0') || (*cp == '\n'))
623 search_base = strdup(cp);
625 else if (!strncasecmp(buffer, "groupbase", 9)) {
629 if ((*cp == '\0') || (*cp == '\n'))
631 group_base = strdup(cp);
634 fprintf(stderr, "?? -> %s\n", buffer);
637 if (group_base == NULL)
638 group_base = strdup(UD_WHERE_GROUPS_ARE_CREATED);
641 * Set up our LDAP connection. The values of retry and timeout
642 * are meaningless since we will immediately be doing a null bind
643 * because we want to be sure to use TCP, not UDP.
645 if ((ld = ldap_open(server, ldap_port)) == NULL) {
646 fprintf(stderr, " The LDAP Directory is temporarily unavailable. Please try again later.\n");
650 if (ldap_bind_s(ld, (char *) default_bind_object, NULL,
651 LDAP_AUTH_SIMPLE) != LDAP_SUCCESS) {
653 ldap_get_option(ld, LDAP_OPT_ERROR_NUMBER, &ld_errno);
655 fprintf(stderr, " The LDAP Directory is temporarily unavailable. Please try again later.\n");
656 if (ld_errno != LDAP_UNAVAILABLE)
657 ldap_perror(ld, " ldap_bind_s");
662 int deref = LDAP_DEREF_ALWAYS;
663 ldap_set_option(ld, LDAP_OPT_DEREF, (void *) &deref);
665 bind_status = UD_NOT_BOUND;
666 if ( default_bind_object != NULL ) {
667 bound_dn = strdup(default_bind_object);
672 /* enabled local caching of ldap results, 15 minute lifetime */
674 ldap_enable_cache( ld, 60 * 15, 100 * 1024 ); /* 100k max memory */
676 ldap_enable_cache( ld, 60 * 15, 0 ); /* no memory limit */
679 /* initialize the search filters */
680 if ((lfdp = ldap_init_getfilter(filter_file)) == NULL) {
681 fprintf(stderr, " Problem with ldap_init_getfilter\n");
686 /* terminal initialization stuff goes here */
687 lpp = DEFAULT_TTY_HEIGHT;
688 col_size = DEFAULT_TTY_WIDTH;
690 (void) SIGNAL (SIGINT, attn);
694 struct winsize win; /* for tty set-up */
695 extern RETSIGTYPE chwinsz(); /* WINSZ signal handler */
697 if (((term = getenv("TERM")) == NULL) || (tgetent(bp, term) <= 0))
701 if (ioctl(fileno(stdout), TIOCGWINSZ, &win) < 0) {
703 col_size = tgetnum("co");
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;
717 (void) SIGNAL (SIGWINCH, chwinsz);
727 printf("\n\n INTERRUPTED!\n");
729 (void) SIGNAL (SIGINT, attn);
739 (void) SIGNAL (SIGWINCH, SIG_IGN);
740 if (ioctl(fileno(stdout), TIOCGWINSZ, &win) != -1) {
744 col_size = win.ws_col;
747 (void) SIGNAL (SIGWINCH, chwinsz);