2 * Copyright (c) 1994, Strata Software Limited, Ottawa, Ontario, Canada.
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 Eric Rosenquist and Strata Software Limited. The SSL name
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.
13 * 'saucer' LDAP command-line client source code.
15 * Author: Eric Rosenquist, 1994.
17 * 07-Mar-1999 readline support added: O. Steffensen (oddbjorn@tricknology.org)
26 # include <readline/readline.h>
27 # ifdef HAVE_READLINE_HISTORY_H
28 # include <readline/history.h>
33 #include <ac/string.h>
34 #include <ac/unistd.h>
40 #define DN_MAXLEN 4096
44 int (*func) (char **, int);
58 char *attrs_null[] = { "0.10", NULL };
60 char default_dn[DN_MAXLEN];
61 char *hostname = "127.0.0.1";
67 int portnum = LDAP_PORT;
69 char true_filter[] = "objectClass=*"; /* Always succeeds */
72 int cmd_help(char **cmdargv, int cmdargc);
73 int cmd_list(char **cmdargv, int cmdargc);
74 int cmd_moveto(char **cmdargv, int cmdargc);
75 int cmd_quit(char **cmdargv, int cmdargc);
76 int cmd_search(char **cmdargv, int cmdargc);
77 int cmd_set(char **cmdargv, int cmdargc);
78 int cmd_show(char **cmdargv, int cmdargc);
81 void display_search_results(LDAPMessage *result);
82 int do_command(char *cmd);
83 void do_commands(FILE *file);
84 int is_whitespace(register char *s);
85 char *make_dn(char *dn, int relative);
86 void show_syntax(unsigned int cmdnum);
87 char *skip_to_char(register char *s, register int c);
88 char *skip_to_whitespace(register char *s);
89 char *skip_whitespace(register char *s);
90 int table_lookup(const char *, const char *const *, int);
91 FILE *user_tailor(void);
93 static const char *const binary_attrs[] = {
94 "audio", "jpegPhoto", "personalSignature", "photo"
97 const CMDTABLE cmdtable[] = {
98 "help" , cmd_help , "[command]",
99 "list" , cmd_list , "[RDN-or-DN] [-absolute]",
100 "moveto", cmd_moveto, "[RDN-or-DN] [-absolute]",
101 "quit" , cmd_quit , "",
102 "search", cmd_search, "<filter> [-object RDN-or-DN] [-absolute]\n\t\t[-scope base|onelevel|subtree]",
103 "set" , cmd_set , "[-aliasderef never|search|find|always] [-sizelimit N] [-timelimit seconds]",
104 "show" , cmd_show , "[RDN-or-DN] [-absolute]"
110 if (ldap_simple_bind_s(ld, username, credentials) != LDAP_SUCCESS) {
111 ldap_perror(ld, progname);
115 printf("Bound to ldap server as `%s' (%s authentication)\n", username,
116 credentials ? "simple" : "no");
118 puts("Bound anonymously to ldap server");
123 int cmd_help(char **cmdargv, int cmdargc)
128 for (i = 0; i < sizeof(cmdtable) / sizeof(cmdtable[0]); i++)
129 if (strncasecmp(cmdargv[1], cmdtable[i].cmd, strlen(cmdargv[1])) == 0) {
133 cmdargc = 1; /* Command not found - make it display the list of commands */
137 puts("\nType 'help <command>' for help on a particular command.\n\n"
138 "Supported commands are:");
139 for (i = 0; i < sizeof(cmdtable) / sizeof(cmdtable[0]); i++)
140 printf(" %s\n", cmdtable[i].cmd);
141 puts("\nArguments to commands are separated by whitespace. Single (')\n"
142 "or double (\") quotes must be used around arguments that contain\n"
143 "embedded whitespace characters.\n");
145 show_syntax(CMD_HELP);
150 int cmd_list(char **cmdargv, int cmdargc)
155 static const char *const opts[] = { "absolute" };
159 for (i = 1; i < cmdargc; i++) {
160 if (cmdargv[i][0] == '-') {
161 switch (table_lookup(cmdargv[i] + 1, opts, sizeof(opts) / sizeof(opts[0]))) {
177 show_syntax(CMD_LIST);
181 if (ldap_search(ld, make_dn(dn, relative), LDAP_SCOPE_ONELEVEL,
182 true_filter, attrs_null, 1) == -1) {
183 ldap_perror(ld, progname);
187 if (ldap_result(ld, LDAP_RES_ANY, 1, (struct timeval *)0, &result) == -1) {
188 ldap_perror(ld, progname);
192 display_search_results(result);
197 int cmd_moveto(char **cmdargv, int cmdargc)
203 static const char *const opts[] = { "absolute" };
206 for (i = 1; i < cmdargc; i++) {
207 if (cmdargv[i][0] == '-') {
208 switch (table_lookup(cmdargv[i] + 1, opts, sizeof(opts) / sizeof(opts[0]))) {
224 show_syntax(CMD_MOVETO);
229 if (is_whitespace(dn))
232 if (strcmp(dn, "..") == 0) {
233 /* Move up one level */
234 if (exploded_dn = ldap_explode_dn(default_dn, 0)) {
235 if (exploded_dn[0]) {
239 for (rdn = exploded_dn + 1; *rdn; rdn++) {
241 strcat(default_dn, ", ");
242 strcat(default_dn, *rdn);
245 ldap_value_free(exploded_dn);
248 /* Use ldap_explode_dn() to parse the string & test its syntax */
249 if (exploded_dn = ldap_explode_dn(dn, 1)) {
250 if (relative && !is_whitespace(default_dn)) {
253 strcpy(default_dn, strcat(strcat(strcpy(buf, dn), ", "), default_dn));
255 strcpy(default_dn, dn);
256 ldap_value_free(exploded_dn);
258 puts("Invalid distinguished name.");
263 printf("Distinguished name suffix is `%s'\n", default_dn);
268 int cmd_quit(char **cmdargv, int cmdargc)
273 int cmd_search(char **cmdargv, int cmdargc)
279 static const char *const opts[] = { "absolute", "object", "scope" };
282 static const char *const scope_opts[]= { "base","onelevel","subtree" };
283 static const int scope_vals[] = { LDAP_SCOPE_BASE, LDAP_SCOPE_ONELEVEL, LDAP_SCOPE_SUBTREE };
284 static int search_scope = LDAP_SCOPE_ONELEVEL;
286 for (i = 1; i < cmdargc; i++) {
287 if (cmdargv[i][0] == '-') {
288 switch (table_lookup(cmdargv[i] + 1, opts, sizeof(opts) / sizeof(opts[0]))) {
299 if ((++i < cmdargc) &&
300 (j = table_lookup(cmdargv[i], scope_opts, sizeof(scope_opts) / sizeof(scope_opts[0]))) >= 0)
301 search_scope = scope_vals[j];
316 if (errflag || !filter) {
317 show_syntax(CMD_SEARCH);
321 if (ldap_search(ld, make_dn(dn, relative), search_scope, filter, attrs_null, 0) == -1) {
322 ldap_perror(ld, progname);
326 if (ldap_result(ld, LDAP_RES_ANY, 1, (struct timeval *)0, &result) == -1) {
327 ldap_perror(ld, progname);
331 display_search_results(result);
336 int cmd_set(char **cmdargv, int cmdargc)
338 static const char *const alias_opts[] = {
339 "never", "search", "find", "always"
343 static const char *const opts[] = {
344 "aliasderef", "sizelimit", "timelimit"
347 for (i = 1; i < cmdargc; i++) {
348 if (cmdargv[i][0] == '-') {
349 switch (table_lookup(cmdargv[i] + 1, opts, sizeof(opts) / sizeof(opts[0]))) {
351 if ((++i < cmdargc) &&
352 (j = table_lookup(cmdargv[i], alias_opts, sizeof(alias_opts) / sizeof(alias_opts[0]))) >= 0)
353 ldap_set_option(ld, LDAP_OPT_DEREF, &j);
359 j = atoi(cmdargv[i]);
360 ldap_set_option(ld, LDAP_OPT_SIZELIMIT, &j);
366 j = atoi(cmdargv[i]);
367 ldap_set_option(ld, LDAP_OPT_TIMELIMIT, &j);
379 show_syntax(CMD_SET);
381 int opt_a, opt_s, opt_t;
382 ldap_get_option(ld, LDAP_OPT_DEREF, &opt_a);
383 ldap_get_option(ld, LDAP_OPT_SIZELIMIT, &opt_s);
384 ldap_get_option(ld, LDAP_OPT_TIMELIMIT, &opt_t);
385 printf("Alias dereferencing is %s, Sizelimit is %d entr%s, Timelimit is %d second%s.\n",
387 opt_s, opt_s == 1 ? "y" : "ies",
388 opt_t, opt_t == 1 ? "" : "s");
394 int cmd_show(char **cmdargv, int cmdargc)
399 static const char *const opts[] = { "absolute" };
403 for (i = 1; i < cmdargc; i++) {
404 if (cmdargv[i][0] == '-') {
405 switch (table_lookup(cmdargv[i] + 1, opts, sizeof(opts) / sizeof(opts[0]))) {
421 show_syntax(CMD_SHOW);
425 if (ldap_search(ld, make_dn(dn, relative), LDAP_SCOPE_BASE, true_filter, NULL, 0) == -1) {
426 ldap_perror(ld, progname);
430 if (ldap_result(ld, LDAP_RES_ANY, 1, (struct timeval *)0, &result) == -1) {
431 ldap_perror(ld, progname);
435 display_search_results(result);
440 void display_search_results(LDAPMessage *result)
448 for (entry = ldap_first_entry(ld, result); entry; entry = ldap_next_entry(ld, entry)) {
449 if (s = ldap_get_dn(ld, entry)) {
454 /* Make one pass to calculate the length of the longest attribute name */
456 for (s = ldap_first_attribute(ld, entry, &cookie); s; s = ldap_next_attribute(ld, entry, cookie))
457 if ((i = strlen(s)) > maxname)
460 /* Now print the attributes and values */
461 for (s = ldap_first_attribute(ld, entry, &cookie); s; s = ldap_next_attribute(ld, entry, cookie)) {
464 if (table_lookup(s, binary_attrs, sizeof(binary_attrs) / sizeof(binary_attrs[0])) >= 0)
465 continue; /* Skip this attribute - it's binary */
467 printf(" %-*s - ", maxname, s);
469 /* Now print each of the values for the given attribute */
470 if (values = ldap_get_values(ld, entry, s)) {
473 for (val = values; *val; ) {
477 /* Watch out for values that have embedded \n characters */
478 while (nl = strchr(v, '\n')) {
483 printf(" %*s", maxname + 3, "");
488 printf(" %*s", maxname + 3, "");
490 ldap_value_free(values);
496 if (ldap_result2error(ld, result, 0))
497 ldap_perror(ld, progname);
500 int do_command(char *cmd)
506 /* Tokenize the input command, allowing for quoting */
508 cmd = skip_whitespace(cmd);
510 break; /* end of input */
512 cmdargv[cmdargc++] = cmd;
513 if (*cmd == '\'' || *cmd == '"') {
514 cmdargv[cmdargc - 1]++; /* Skip over the opening quote */
515 cmd = skip_to_char(cmd + 1, *cmd);
517 puts("Command is missing a trailing quote");
522 cmd = skip_to_whitespace(cmd);
529 printf("cmdargc = %d\n", cmdargc);
530 for (i = 0; i < cmdargc; i++)
534 if (cmdargv[0][0] == '?')
535 return cmd_help(cmdargv, cmdargc);
537 for (i = 0; i < sizeof(cmdtable) / sizeof(cmdtable[0]); i++)
538 if (strncasecmp(cmdargv[0], cmdtable[i].cmd, strlen(cmdargv[0])) == 0)
539 return (*cmdtable[i].func)(cmdargv, cmdargc);
541 if (!is_whitespace(cmdargv[0])) {
542 printf("Unrecognized command - %s\n", cmdargv[0]);
543 cmd_help(cmdargv, 1);
549 void do_commands(FILE *file)
551 char cmd_buf[BUFSIZ];
552 int tty = isatty(fileno(file));
560 sprintf(prompt, (strlen(default_dn) < 18
562 : "saucer dn=%.15s..> "), default_dn);
563 #ifndef HAVE_READLINE
564 fputs (prompt, stdout);
566 buf = readline (prompt);
576 if (!fgets(cmd_buf, sizeof(cmd_buf), file))
580 status = do_command(buf);
590 int is_whitespace(register char *s)
595 while (*s && isspace((unsigned char) *s))
601 int main(int argc, char **argv)
608 while ((option = getopt(argc, argv, "h:p:u:c:d:")) != EOF)
611 credentials = optarg;
616 lber_set_option(NULL, LBER_OPT_DEBUG_LEVEL, &tmp);
617 ldap_set_option(NULL, LDAP_OPT_DEBUG_LEVEL, &tmp);
624 portnum = atoi(optarg);
634 fprintf(stderr, "usage: %s [-h host] [-p portnumber] [-u X500UserName]\n\t[-c credentials] [-d debug-level]\n",
641 if (!(ld = ldap_open(hostname, portnum))) {
642 fprintf(stderr, "%s: unable to connect to server at host `%s' on port %d\n",
643 progname, hostname, portnum);
661 char *make_dn(char *dn, int relative)
663 static char dn_buf[DN_MAXLEN];
668 if (!default_dn[0] || !relative)
674 return strcat(strcat(strcpy(dn_buf, dn), ", "), default_dn);
677 void show_syntax(unsigned int cmdnum)
679 printf("Syntax: %s %s\n", cmdtable[cmdnum].cmd, cmdtable[cmdnum].help_msg);
682 char *skip_to_char(register char *s, register int c)
687 while (*s && *s != c)
693 char *skip_to_whitespace(register char *s)
698 while (*s && !isspace((unsigned char) *s))
704 char *skip_whitespace(register char *s)
709 while (*s && isspace((unsigned char) *s))
715 int table_lookup(const char *word, const char *const *table, int table_count)
723 wordlen = strlen(word);
725 for (i = 0; i < table_count; i++)
726 if (strncasecmp(word, table[i], wordlen) == 0)
731 FILE *user_tailor(void)
740 struct passwd *pwent;
742 if (pwent = getpwuid(getuid()))
743 strcat(strcpy(rcfile, pwent->pw_dir), "/");
744 strcat(rcfile, ".saucerrc");
747 strcpy(rcfile, "saucer.rc");
750 return fopen(rcfile, "r");