3 * Copyright 1998-2000 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
49 #include "ldap_defaults.h"
53 * Used with change_base() to indicate which base we are changing.
58 #define iscom(x) (!strncasecmp((x), cmd, strlen(cmd)))
60 static char *server = NULL;
61 static char *config_file = UD_CONFIG_FILE;
62 static char *filter_file = FILTERFILE;
63 static int ldap_port = 0;
64 static int dereference = TRUE;
66 char *default_bind_object = NULL;
68 char *bound_dn; /* bound user's Distinguished Name */
69 char *group_base; /* place in LDAP tree where groups are */
70 char *search_base; /* place in LDAP tree where searches start */
72 static jmp_buf env; /* spot to jump to on an interrupt */
74 int lpp; /* lines per page */
75 int verbose; /* 1 if verbose mode on */
76 int col_size; /* characters across on the screen */
77 int bind_status; /* user's bind status */
79 LDAP *ld; /* LDAP descriptor */
80 LDAPFiltDesc *lfdp; /* LDAP filter descriptor */
83 int debug; /* debug flag */
85 int ldebug; /* library debug flag */
87 #ifndef HAVE_MKVERSION
88 char Version[] = OPENLDAP_PACKAGE " " OPENLDAP_VERSION " UserDirectory (ud)";
92 main( int argc, char **argv )
94 register int c; /* for parsing argv */
95 register char *cp; /* for parsing Version */
99 /* handle argument list */
100 while ((c = getopt(argc, argv, "c:d:Df:l:p:s:u:vV")) != -1) {
103 ldebug |= (int) strtol(optarg, (char **) NULL, 0);
107 debug |= (int) strtol(optarg, (char **) NULL, 0);
111 server = strdup(optarg);
114 filter_file = strdup(optarg);
117 config_file = optarg;
120 ldap_port = atoi(optarg);
123 default_bind_object = strdup(optarg);
126 verbose = 1; /* this is the default anyways... */
132 printf("\n\n Debug flag values\n\n");
133 printf(" 1 function trace\n");
134 printf(" 2 find() information\n");
135 printf(" 4 group information\n");
136 printf(" 8 mod() information\n");
137 printf(" 16 parsing information\n");
138 printf(" 32 output information\n");
139 printf(" 64 authentication information\n");
140 printf(" 128 initialization information\n\n");
141 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);
142 exit( EXIT_SUCCESS );
144 fprintf(stderr, "Usage: %s [-c filter-config-file] [-d debug-level] [-l ldap-debug-level] [-s server] [-p port] [-V]\n", argv[0]);
150 /* just print the first line of Version[] */
151 cp = strchr(Version, '\t');
158 (void) SIGNAL (SIGPIPE, SIG_IGN);
162 initialize_attribute_strings();
164 /* now tackle the user's commands */
174 LDAPMessage *mp; /* returned by find() */
175 register char *cp; /* misc char pointer */
176 register char *ap; /* misc char pointer */
177 static char cmd[MED_BUF_SIZE]; /* holds the command */
178 static char input[MED_BUF_SIZE]; /* buffer for input */
182 printf("->do_commands()\n");
185 printf("\n Enter a command. If you need help, type 'h' or '?' and hit RETURN.\n\n");
186 /* jump here on an interrupt */
192 /* Temporary kludge - if cp is null, dumps core under Solaris */
195 fetch_buffer(input, sizeof(input), stdin);
196 if (*input == '\0') {
200 while (isspace((unsigned char)*cp))
203 if (memset(cmd, '\0', sizeof(cmd)) == NULL)
205 while (!isspace((unsigned char)*cp) && (*cp != '\0'))
209 else if (iscom("stop") || iscom("quit"))
211 else if (iscom("cb") || iscom("cd") || iscom("moveto")) {
212 while (isspace((unsigned char)*cp) && (*cp != '\0'))
214 if (!strncasecmp(cp, "base", 4))
216 change_base(BASE_SEARCH, &search_base, nextstr(cp));
218 else if (iscom("memberships"))
219 (void) list_memberships(nextstr(cp));
220 else if (iscom("list"))
221 (void) list_groups(nextstr(cp));
222 else if (iscom("groupbase"))
223 change_base(BASE_GROUPS, &group_base, nextstr(cp));
224 else if (iscom("find") || iscom("display") || iscom("show")) {
226 if ((mp = find(cp, FALSE)) != NULL) {
232 printf(" Could not find \"%s\".\n", cp);
235 else if (iscom("vedit") && isatty( 1 )) {
237 else if (iscom("vedit")) {
239 (void) edit(nextstr(cp));
241 else if (iscom("modify") || iscom("change") || iscom("alter"))
242 (void) modify(nextstr(cp));
243 else if (iscom("bind") || iscom("iam"))
244 (void) auth(nextstr(cp), 0);
245 else if ((cmd[0] == '?') || iscom("help"))
246 print_help(nextstr(cp));
247 else if (iscom("join") || iscom("subscribe"))
248 (void) x_group(G_JOIN, nextstr(cp));
249 else if (iscom("resign") || iscom("unsubscribe"))
250 (void) x_group(G_RESIGN, nextstr(cp));
251 else if (!strncasecmp("create", cmd, strlen(cmd)))
252 add_group(nextstr(cp));
253 else if (!strncasecmp("remove", cmd, strlen(cmd)))
254 remove_group(nextstr(cp));
255 else if (!strncasecmp("purge", cmd, strlen(cmd)))
256 purge_group(nextstr(cp));
257 else if (!strncasecmp("verbose", cmd, strlen(cmd))) {
258 verbose = 1 - verbose;
260 printf(" Verbose mode has been turned on.\n");
262 else if (!strncasecmp("dereference", cmd, strlen(cmd))) {
264 dereference = 1 - dereference;
265 if (dereference == 1) {
266 deref = LDAP_DEREF_ALWAYS;
268 deref = LDAP_DEREF_NEVER;
270 ldap_set_option(ld, LDAP_OPT_DEREF, (void *) &deref);
272 else if (!strncasecmp("tidy", cmd, strlen(cmd)))
274 else if (cmd[0] == '\0')
277 printf(" Invalid command. Type \"help commands.\"\n");
279 printf(" Thank you!\n");
282 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
285 exit( EXIT_SUCCESS );
292 register char **rdns;
296 printf("->status()\n");
298 printf(" Current server is %s", server != NULL ? server : "<default>" );
302 ldap_get_option(ld, LDAP_OPT_HOST_NAME, &host);
305 ( server == NULL || strcasecmp( host, server ) != 0 ) )
307 printf( " (%s)", host );
311 printbase(" Search base is ", search_base);
312 printbase(" Group base is ", group_base);
313 if ( bound_dn != NULL ) {
314 rdns = ldap_explode_dn(bound_dn, TRUE);
315 printf(" Bound as \"%s\"\n", *rdns);
316 ldap_value_free(rdns);
318 printf(" Bound as Nobody\n" );
320 printf( " Verbose mode is %sabled\n", ( verbose ? "en" : "dis" ));
322 int deref = LDAP_DEREF_NEVER;
323 ldap_get_option(ld, LDAP_OPT_DEREF, &deref);
324 printf( " Aliases are %sbeing dereferenced\n",
325 ( deref == LDAP_DEREF_ALWAYS ) ? "" : "not" );
330 change_base( int type, char **base, char *s )
332 register char *cp; /* utility pointers */
333 char **rdns; /* for parsing */
334 char *output_string = NULL; /* for nice output */
335 int num_picked; /* # of selected base */
336 int j; /* used with num_picked */
337 int i = 1; /* index into choices array */
338 int matches; /* # of matches found */
339 int rest = 1; /* # left to display */
340 char tmp[MED_BUF_SIZE]; /* temporary buffer */
341 static char *choices[MED_BUF_SIZE]; /* bases from which to choose */
342 static char resp[SMALL_BUF_SIZE]; /* for prompting user */
343 static char buf[MED_BUF_SIZE];
344 static char *attrs[] = { "objectClass", NULL };
345 LDAPMessage *mp; /* results from a search */
346 LDAPMessage *ep; /* for going thru bases */
350 printf("->change_base(%s, %s)\n", s, s);
353 * If s is NULL we need to prompt the user for an argument.
357 printf(" You need to specify how the base is to be changed. Valid choices are:\n");
358 printf(" ? - list the choices immediately below this level\n");
359 printf(" .. - move up one level in the Directory tree\n");
360 printf(" root - move to the root of the Directory tree\n");
361 printf(" default - move to the default level built into this program\n");
362 printf(" <entry> - move to the entry specified\n");
364 printf(" Change base to? ");
366 fetch_buffer(buf, sizeof(buf), stdin);
367 if ((buf != NULL) && (buf[0] != '\0'))
373 /* set the output string */
374 if (type == BASE_SEARCH)
375 output_string = " Search base is now ";
376 else if (type == BASE_GROUPS)
377 output_string = " Group base is now ";
379 if (!strcasecmp(s, "root")) {
380 StrFreeDup(base, NULL);
381 printbase(" Search base is ", *base);
386 * User wants to ascend one level in the LDAP tree.
387 * Easy: Just strip off the first element of the
388 * current search base, unless it's the root, in
389 * which case we just do nothing.
391 if (!strcasecmp(s, "..")) {
393 printf(" You are already at the root\n");
396 cp = strchr(*base, '=');
399 * If there isn't a second "=" in the base, then this was
400 * a one element base, and so now it should be NULL.
402 if ((cp = strchr(cp, '=')) == NULL)
403 StrFreeDup(base, NULL);
406 * Back up to the start of this
410 * sequence now that 'cp' is pointing to the '='.
412 while(!isspace((unsigned char)*cp))
416 * Goofy, but need to do it this way since both *base
417 * and cp point into the same chunk of memory, and
418 * we want to free *base, but keep part of it around.
421 StrFreeDup(base, cp);
424 printbase(output_string, *base);
428 /* user wants to see what is directly below this level */
431 * Fetch the list of entries directly below this level.
432 * Once we have the list, we will print it for the user, one
433 * screenful at a time. At the end of each screen, we ask
434 * the user if they want to see more. They can also just
435 * type a number at that point too.
437 if (ldap_search_s(ld, *base, LDAP_SCOPE_ONELEVEL, NULL, attrs, FALSE, &mp) != LDAP_SUCCESS) {
439 ldap_get_option(ld, LDAP_OPT_ERROR_NUMBER, &ld_errno);
440 if ((ld_errno == LDAP_TIMELIMIT_EXCEEDED) ||
441 (ld_errno == LDAP_SIZELIMIT_EXCEEDED)) {
443 printf(" Your query was too general and a limit was exceeded. The results listed\n");
444 printf(" are not complete. You may want to try again with a more refined query.\n\n");
447 printf(" Time or size limit exceeded. Partial results follow.\n\n");
449 ldap_perror(ld, "ldap_search_s");
453 if ((matches = ldap_count_entries(ld, mp)) < 1) {
454 printf(" There is nothing below this level.\n");
455 (void) ldap_msgfree(mp);
459 printf(" There are %d choices:\n", matches);
460 for (ep = ldap_first_entry(ld, mp); ep != NULL; ep = ldap_next_entry(ld, ep)) {
462 * Put the last component of the DN into 'lastDN'.
463 * If we are at the root level, convert any country
464 * codes to recognizable names for printing.
466 choices[i] = ldap_get_dn(ld, ep);
467 rdns = ldap_explode_dn(choices[i], TRUE);
468 printf(" %2d. %s\n", i, friendly_name(*rdns));
469 (void) ldap_value_free(rdns);
471 if ((rest++ > (lpp - 3)) && (i < matches)) {
474 fetch_buffer(resp, sizeof(resp), stdin);
475 if ((resp[0] == 'n') || (resp[0] == 'N'))
477 else if (((num_picked = atoi(resp)) != 0) && (num_picked < i))
483 if (num_picked != 0) {
488 printf(" Which number? ");
490 fetch_buffer(resp, sizeof(resp), stdin);
494 (void) ldap_msgfree(mp);
495 for (i = 0; i < matches; i++)
496 ldap_memfree(choices[i]);
499 if ((j < 1) || (j >= i))
500 printf(" Invalid number\n");
502 StrFreeDup(base, choices[j]);
503 printbase(output_string, *base);
504 (void) ldap_msgfree(mp);
505 for (i = 0; choices[i] != NULL; i++)
506 ldap_memfree(choices[i]);
511 /* set the search base back to the original default value */
512 else if (!strcasecmp(s, "default")) {
513 if (type == BASE_SEARCH)
514 StrFreeDup(base, NULL);
515 else if (type == BASE_GROUPS)
516 StrFreeDup(base, UD_WHERE_GROUPS_ARE_CREATED);
517 printbase(output_string, *base);
519 /* they typed in something -- see if it is legit */
521 /* user cannot do something like 'cb 33' */
523 printf(" \"%s\" is not a valid search base\n", s);
524 printf(" Base unchanged.\n");
525 printf(" Try using 'cb ?'\n");
528 /* was it a fully-specified DN? */
531 printbase(output_string, *base);
534 /* was it a RDN relative to the current base? */
535 sprintf(tmp, "ou=%s, %s", s, *base);
537 StrFreeDup(base, tmp);
538 printbase(output_string, *base);
541 printf(" \"%s\" is not a valid base\n Base unchanged.\n", s);
546 initialize_client( void )
548 FILE *fp; /* for config file */
549 static char buffer[MED_BUF_SIZE]; /* for input */
551 struct passwd *pw; /* for getting the home dir */
553 register char *cp; /* for fiddling with buffer */
554 char *config; /* config file to use */
555 static char bp[1024]; /* for tty set-up */
559 printf("->initialize_client()\n");
563 ber_set_option( NULL, LBER_OPT_DEBUG_LEVEL, &ldebug );
564 ldap_set_option( NULL, LDAP_OPT_DEBUG_LEVEL, &ldebug );
568 * A per-user config file has precedence over any system-wide
569 * config file, if one exists.
572 if ((pw = getpwuid((uid_t) geteuid())) == (struct passwd *) NULL)
573 config = config_file;
575 if (pw->pw_dir == NULL)
576 config = config_file;
578 sprintf(buffer, "%s/%s", pw->pw_dir,
579 UD_USER_CONFIG_FILE);
580 if (access(buffer, R_OK) == 0)
583 config = config_file;
587 config = config_file;
588 #endif /* getpwduid() */
590 if (debug & D_INITIALIZE)
591 printf("Using config file %s\n", config);
595 * If there is a config file, read it.
597 * Could have lines that look like this:
599 * server <ip-address or domain-name>
600 * base <default search base>
601 * groupbase <default place where groups are created>
604 if ((fp = fopen(config, "r")) != NULL) {
605 while (fgets(buffer, sizeof(buffer), fp) != NULL) {
606 buffer[strlen(buffer) - 1] = '\0';
607 if (!strncasecmp(buffer, "server", 6)) {
611 while (isspace((unsigned char)*cp))
613 if ((*cp == '\0') || (*cp == '\n'))
617 else if (!strncasecmp(buffer, "host", 4)) {
621 while (isspace((unsigned char)*cp))
623 if ((*cp == '\0') || (*cp == '\n'))
627 else if (!strncasecmp(buffer, "base", 4)) {
629 while (isspace((unsigned char)*cp))
631 if ((*cp == '\0') || (*cp == '\n'))
633 search_base = strdup(cp);
635 else if (!strncasecmp(buffer, "groupbase", 9)) {
637 while (isspace((unsigned char)*cp))
639 if ((*cp == '\0') || (*cp == '\n'))
641 group_base = strdup(cp);
644 fprintf(stderr, "?? -> %s\n", buffer);
647 if (group_base == NULL)
648 group_base = strdup(UD_WHERE_GROUPS_ARE_CREATED);
651 * Set up our LDAP connection. The values of retry and timeout
652 * are meaningless since we will immediately be doing a null bind
653 * because we want to be sure to use TCP, not UDP.
655 if ((ld = ldap_init(server, ldap_port)) == NULL) {
656 fprintf(stderr, " Initialization of LDAP session failed.\n");
657 exit( EXIT_FAILURE );
660 if (ldap_bind_s(ld, (char *) default_bind_object, NULL,
661 LDAP_AUTH_SIMPLE) != LDAP_SUCCESS) {
662 ldap_perror(ld, " ldap_bind_s");
663 exit( EXIT_FAILURE );
667 int deref = LDAP_DEREF_ALWAYS;
668 ldap_set_option(ld, LDAP_OPT_DEREF, (void *) &deref);
670 bind_status = UD_NOT_BOUND;
671 if ( default_bind_object != NULL ) {
672 bound_dn = strdup(default_bind_object);
677 /* enabled local caching of ldap results, 15 minute lifetime */
678 ldap_enable_cache( ld, 60 * 15, 0 ); /* no memory limit */
680 /* initialize the search filters */
681 if ((lfdp = ldap_init_getfilter(filter_file)) == NULL) {
682 fprintf(stderr, " Problem with ldap_init_getfilter\n");
687 /* terminal initialization stuff goes here */
688 lpp = DEFAULT_TTY_HEIGHT;
689 col_size = DEFAULT_TTY_WIDTH;
691 (void) SIGNAL (SIGINT, attn);
697 if (((term = getenv("TERM")) == NULL) || (tgetent(bp, term) <= 0))
701 struct winsize win; /* for tty set-up */
702 if (ioctl(fileno(stdout), TIOCGWINSZ, &win) >= 0) {
703 if ((lpp = win.ws_row) == 0)
705 if ((col_size = win.ws_col) == 0)
706 col_size = tgetnum("co");
707 if ((lpp <= 0) || tgetflag("hc"))
708 lpp = DEFAULT_TTY_HEIGHT;
709 if ((col_size <= 0) || tgetflag("hc"))
710 col_size = DEFAULT_TTY_WIDTH;
711 (void) SIGNAL (SIGWINCH, chwinsz);
716 col_size = tgetnum("co");
728 printf("\n\n INTERRUPTED!\n");
730 (void) SIGNAL_REINSTALL (SIGINT, attn);
735 #if !defined(NO_TERMCAP) && defined(TIOCGWINSZ)
741 (void) SIGNAL (SIGWINCH, SIG_IGN);
742 if (ioctl(fileno(stdout), TIOCGWINSZ, &win) != -1) {
746 col_size = win.ws_col;
749 (void) SIGNAL_REINSTALL (SIGWINCH, chwinsz);