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);
79 char *make_dn(char *dn, int relative);
80 char *skip_to_char(register char *s, register int c);
81 char *skip_to_whitespace(register char *s);
82 char *skip_whitespace(register char *s);
83 FILE *user_tailor(void);
85 static char *binary_attrs[] = { "audio", "jpegPhoto", "personalSignature", "photo" };
87 CMDTABLE cmdtable[] = {
88 "help" , cmd_help , "[command]",
89 "list" , cmd_list , "[RDN-or-DN] [-absolute]",
90 "moveto", cmd_moveto, "[RDN-or-DN] [-absolute]",
91 "quit" , cmd_quit , "",
92 "search", cmd_search, "<filter> [-object RDN-or-DN] [-absolute]\n\t\t[-scope base|onelevel|subtree]",
93 "set" , cmd_set , "[-aliasderef never|search|find|always] [-sizelimit N] [-timelimit seconds]",
94 "show" , cmd_show , "[RDN-or-DN] [-absolute]"
100 if (ldap_simple_bind_s(ld, username, credentials) != LDAP_SUCCESS) {
101 ldap_perror(ld, progname);
105 printf("Bound to ldap server as `%s' (%s authentication)\n", username,
106 credentials ? "simple" : "no");
108 puts("Bound anonymously to ldap server");
113 int cmd_help(char **cmdargv, int cmdargc)
118 for (i = 0; i < sizeof(cmdtable) / sizeof(cmdtable[0]); i++)
119 if (strncasecmp(cmdargv[1], cmdtable[i].cmd, strlen(cmdargv[1])) == 0) {
123 cmdargc = 1; /* Command not found - make it display the list of commands */
127 puts("\nType 'help <command>' for help on a particular command.\n\n"
128 "Supported commands are:");
129 for (i = 0; i < sizeof(cmdtable) / sizeof(cmdtable[0]); i++)
130 printf(" %s\n", cmdtable[i].cmd);
131 puts("\nArguments to commands are separated by whitespace. Single (')\n"
132 "or double (\") quotes must be used around arguments that contain\n"
133 "embedded whitespace characters.\n");
135 show_syntax(CMD_HELP);
140 int cmd_list(char **cmdargv, int cmdargc)
145 static char *opts[] = { "absolute" };
149 for (i = 1; i < cmdargc; i++) {
150 if (cmdargv[i][0] == '-') {
151 switch (table_lookup(cmdargv[i] + 1, opts, sizeof(opts) / sizeof(opts[0]))) {
167 show_syntax(CMD_LIST);
171 if (ldap_search(ld, make_dn(dn, relative), LDAP_SCOPE_ONELEVEL,
172 true_filter, attrs_null, 1) == -1) {
173 ldap_perror(ld, progname);
177 if (ldap_result(ld, LDAP_RES_ANY, 1, (struct timeval *)0, &result) == -1) {
178 ldap_perror(ld, progname);
182 display_search_results(result);
187 int cmd_moveto(char **cmdargv, int cmdargc)
193 static char *opts[] = { "absolute" };
196 for (i = 1; i < cmdargc; i++) {
197 if (cmdargv[i][0] == '-') {
198 switch (table_lookup(cmdargv[i] + 1, opts, sizeof(opts) / sizeof(opts[0]))) {
214 show_syntax(CMD_MOVETO);
219 if (is_whitespace(dn))
222 if (strcmp(dn, "..") == 0) {
223 /* Move up one level */
224 if (exploded_dn = ldap_explode_dn(default_dn, 0)) {
225 if (exploded_dn[0]) {
229 for (rdn = exploded_dn + 1; *rdn; rdn++) {
231 strcat(default_dn, ", ");
232 strcat(default_dn, *rdn);
235 ldap_value_free(exploded_dn);
238 /* Use ldap_explode_dn() to parse the string & test its syntax */
239 if (exploded_dn = ldap_explode_dn(dn, 1)) {
240 if (relative && !is_whitespace(default_dn)) {
243 strcpy(default_dn, strcat(strcat(strcpy(buf, dn), ", "), default_dn));
245 strcpy(default_dn, dn);
246 ldap_value_free(exploded_dn);
248 puts("Invalid distinguished name.");
253 printf("Distinguished name suffix is `%s'\n", default_dn);
258 int cmd_quit(char **cmdargv, int cmdargc)
263 int cmd_search(char **cmdargv, int cmdargc)
269 static char *opts[] = { "absolute", "object", "scope" };
272 static char *scope_opts[] = { "base", "onelevel", "subtree" };
273 static int scope_vals[] = { LDAP_SCOPE_BASE, LDAP_SCOPE_ONELEVEL, LDAP_SCOPE_SUBTREE };
274 static int search_scope = LDAP_SCOPE_ONELEVEL;
276 for (i = 1; i < cmdargc; i++) {
277 if (cmdargv[i][0] == '-') {
278 switch (table_lookup(cmdargv[i] + 1, opts, sizeof(opts) / sizeof(opts[0]))) {
289 if ((++i < cmdargc) &&
290 (j = table_lookup(cmdargv[i], scope_opts, sizeof(scope_opts) / sizeof(scope_opts[0]))) >= 0)
291 search_scope = scope_vals[j];
306 if (errflag || !filter) {
307 show_syntax(CMD_SEARCH);
311 if (ldap_search(ld, make_dn(dn, relative), search_scope, filter, attrs_null, 0) == -1) {
312 ldap_perror(ld, progname);
316 if (ldap_result(ld, LDAP_RES_ANY, 1, (struct timeval *)0, &result) == -1) {
317 ldap_perror(ld, progname);
321 display_search_results(result);
326 int cmd_set(char **cmdargv, int cmdargc)
328 static char *alias_opts[] = { "never", "search", "find", "always" };
331 static char *opts[] = { "aliasderef", "sizelimit", "timelimit" };
333 for (i = 1; i < cmdargc; i++) {
334 if (cmdargv[i][0] == '-') {
335 switch (table_lookup(cmdargv[i] + 1, opts, sizeof(opts) / sizeof(opts[0]))) {
337 if ((++i < cmdargc) &&
338 (j = table_lookup(cmdargv[i], alias_opts, sizeof(alias_opts) / sizeof(alias_opts[0]))) >= 0)
339 ldap_set_option(ld, LDAP_OPT_DEREF, &j);
345 j = atoi(cmdargv[i]);
346 ldap_set_option(ld, LDAP_OPT_SIZELIMIT, &j);
352 j = atoi(cmdargv[i]);
353 ldap_set_option(ld, LDAP_OPT_TIMELIMIT, &j);
365 show_syntax(CMD_SET);
367 int opt_a, opt_s, opt_t;
368 ldap_get_option(ld, LDAP_OPT_DEREF, &opt_a);
369 ldap_get_option(ld, LDAP_OPT_SIZELIMIT, &opt_s);
370 ldap_get_option(ld, LDAP_OPT_TIMELIMIT, &opt_t);
371 printf("Alias dereferencing is %s, Sizelimit is %d entr%s, Timelimit is %d second%s.\n",
373 opt_s, opt_s == 1 ? "y" : "ies",
374 opt_t, opt_t == 1 ? "" : "s");
380 int cmd_show(char **cmdargv, int cmdargc)
386 static char *opts[] = { "absolute" };
390 for (i = 1; i < cmdargc; i++) {
391 if (cmdargv[i][0] == '-') {
392 switch (table_lookup(cmdargv[i] + 1, opts, sizeof(opts) / sizeof(opts[0]))) {
408 show_syntax(CMD_SHOW);
412 if (ldap_search(ld, make_dn(dn, relative), LDAP_SCOPE_BASE, true_filter, NULL, 0) == -1) {
413 ldap_perror(ld, progname);
417 if (ldap_result(ld, LDAP_RES_ANY, 1, (struct timeval *)0, &result) == -1) {
418 ldap_perror(ld, progname);
422 display_search_results(result);
427 display_search_results(LDAPMessage *result)
435 for (entry = ldap_first_entry(ld, result); entry; entry = ldap_next_entry(ld, entry)) {
436 if (s = ldap_get_dn(ld, entry)) {
441 /* Make one pass to calculate the length of the longest attribute name */
443 for (s = ldap_first_attribute(ld, entry, &cookie); s; s = ldap_next_attribute(ld, entry, cookie))
444 if ((i = strlen(s)) > maxname)
447 /* Now print the attributes and values */
448 for (s = ldap_first_attribute(ld, entry, &cookie); s; s = ldap_next_attribute(ld, entry, cookie)) {
451 if (table_lookup(s, binary_attrs, sizeof(binary_attrs) / sizeof(binary_attrs[0])) >= 0)
452 continue; /* Skip this attribute - it's binary */
454 printf(" %-*s - ", maxname, s);
456 /* Now print each of the values for the given attribute */
457 if (values = ldap_get_values(ld, entry, s)) {
460 for (val = values; *val; ) {
464 /* Watch out for values that have embedded \n characters */
465 while (nl = strchr(v, '\n')) {
470 printf(" %*s", maxname + 3, "");
475 printf(" %*s", maxname + 3, "");
477 ldap_value_free(values);
483 if (ldap_result2error(ld, result, 0))
484 ldap_perror(ld, progname);
487 int do_command(char *cmd)
493 /* Tokenize the input command, allowing for quoting */
495 cmd = skip_whitespace(cmd);
497 break; /* end of input */
499 cmdargv[cmdargc++] = cmd;
500 if (*cmd == '\'' || *cmd == '"') {
501 cmdargv[cmdargc - 1]++; /* Skip over the opening quote */
502 cmd = skip_to_char(cmd + 1, *cmd);
504 puts("Command is missing a trailing quote");
509 cmd = skip_to_whitespace(cmd);
516 printf("cmdargc = %d\n", cmdargc);
517 for (i = 0; i < cmdargc; i++)
521 if (cmdargv[0][0] == '?')
522 return cmd_help(cmdargv, cmdargc);
524 for (i = 0; i < sizeof(cmdtable) / sizeof(cmdtable[0]); i++)
525 if (strncasecmp(cmdargv[0], cmdtable[i].cmd, strlen(cmdargv[0])) == 0)
526 return (*cmdtable[i].func)(cmdargv, cmdargc);
528 if (!is_whitespace(cmdargv[0])) {
529 printf("Unrecognized command - %s\n", cmdargv[0]);
530 cmd_help(cmdargv, 1);
536 void do_commands(FILE *file)
538 char cmd_buf[BUFSIZ];
539 int tty = isatty(fileno(file));
547 sprintf(prompt, (strlen(default_dn) < 18
549 : "saucer dn=%.15s..> "), default_dn);
550 #ifndef HAVE_READLINE
551 fputs (prompt, stdout);
553 buf = readline (prompt);
563 if (!fgets(cmd_buf, sizeof(cmd_buf), file))
567 status = do_command(buf);
577 int is_whitespace(register char *s)
582 while (*s && isspace((unsigned char) *s))
588 int main(int argc, char **argv)
595 while ((option = getopt(argc, argv, "h:p:u:c:d:")) != EOF)
598 credentials = optarg;
603 lber_set_option(NULL, LBER_OPT_DEBUG_LEVEL, &tmp);
604 ldap_set_option(NULL, LDAP_OPT_DEBUG_LEVEL, &tmp);
611 portnum = atoi(optarg);
621 fprintf(stderr, "usage: %s [-h host] [-p portnumber] [-u X500UserName]\n\t[-c credentials] [-d debug-level]\n",
628 if (!(ld = ldap_open(hostname, portnum))) {
629 fprintf(stderr, "%s: unable to connect to server at host `%s' on port %d\n",
630 progname, hostname, portnum);
648 char *make_dn(char *dn, int relative)
650 static char dn_buf[DN_MAXLEN];
656 if (!default_dn[0] || !relative)
662 return strcat(strcat(strcpy(dn_buf, dn), ", "), default_dn);
665 show_syntax(int cmdnum)
667 printf("Syntax: %s %s\n", cmdtable[cmdnum].cmd, cmdtable[cmdnum].help_msg);
670 char *skip_to_char(register char *s, register int c)
675 while (*s && *s != c)
681 char *skip_to_whitespace(register char *s)
686 while (*s && !isspace((unsigned char) *s))
692 char *skip_whitespace(register char *s)
697 while (*s && isspace((unsigned char) *s))
703 int table_lookup(char *word, char **table, int table_count)
711 wordlen = strlen(word);
713 for (i = 0; i < table_count; i++)
714 if (strncasecmp(word, table[i], wordlen) == 0)
719 FILE *user_tailor(void)
728 struct passwd *pwent;
730 if (pwent = getpwuid(getuid()))
731 strcat(strcpy(rcfile, pwent->pw_dir), "/");
732 strcat(rcfile, ".saucerrc");
735 strcpy(rcfile, "saucer.rc");
738 return fopen(rcfile, "r");