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(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(char *word, char **table, int table_count);
91 FILE *user_tailor(void);
93 static char *binary_attrs[] = { "audio", "jpegPhoto", "personalSignature", "photo" };
95 CMDTABLE cmdtable[] = {
96 "help" , cmd_help , "[command]",
97 "list" , cmd_list , "[RDN-or-DN] [-absolute]",
98 "moveto", cmd_moveto, "[RDN-or-DN] [-absolute]",
99 "quit" , cmd_quit , "",
100 "search", cmd_search, "<filter> [-object RDN-or-DN] [-absolute]\n\t\t[-scope base|onelevel|subtree]",
101 "set" , cmd_set , "[-aliasderef never|search|find|always] [-sizelimit N] [-timelimit seconds]",
102 "show" , cmd_show , "[RDN-or-DN] [-absolute]"
108 if (ldap_simple_bind_s(ld, username, credentials) != LDAP_SUCCESS) {
109 ldap_perror(ld, progname);
113 printf("Bound to ldap server as `%s' (%s authentication)\n", username,
114 credentials ? "simple" : "no");
116 puts("Bound anonymously to ldap server");
121 int cmd_help(char **cmdargv, int cmdargc)
126 for (i = 0; i < sizeof(cmdtable) / sizeof(cmdtable[0]); i++)
127 if (strncasecmp(cmdargv[1], cmdtable[i].cmd, strlen(cmdargv[1])) == 0) {
131 cmdargc = 1; /* Command not found - make it display the list of commands */
135 puts("\nType 'help <command>' for help on a particular command.\n\n"
136 "Supported commands are:");
137 for (i = 0; i < sizeof(cmdtable) / sizeof(cmdtable[0]); i++)
138 printf(" %s\n", cmdtable[i].cmd);
139 puts("\nArguments to commands are separated by whitespace. Single (')\n"
140 "or double (\") quotes must be used around arguments that contain\n"
141 "embedded whitespace characters.\n");
143 show_syntax(CMD_HELP);
148 int cmd_list(char **cmdargv, int cmdargc)
153 static char *opts[] = { "absolute" };
157 for (i = 1; i < cmdargc; i++) {
158 if (cmdargv[i][0] == '-') {
159 switch (table_lookup(cmdargv[i] + 1, opts, sizeof(opts) / sizeof(opts[0]))) {
175 show_syntax(CMD_LIST);
179 if (ldap_search(ld, make_dn(dn, relative), LDAP_SCOPE_ONELEVEL,
180 true_filter, attrs_null, 1) == -1) {
181 ldap_perror(ld, progname);
185 if (ldap_result(ld, LDAP_RES_ANY, 1, (struct timeval *)0, &result) == -1) {
186 ldap_perror(ld, progname);
190 display_search_results(result);
195 int cmd_moveto(char **cmdargv, int cmdargc)
201 static char *opts[] = { "absolute" };
204 for (i = 1; i < cmdargc; i++) {
205 if (cmdargv[i][0] == '-') {
206 switch (table_lookup(cmdargv[i] + 1, opts, sizeof(opts) / sizeof(opts[0]))) {
222 show_syntax(CMD_MOVETO);
227 if (is_whitespace(dn))
230 if (strcmp(dn, "..") == 0) {
231 /* Move up one level */
232 if (exploded_dn = ldap_explode_dn(default_dn, 0)) {
233 if (exploded_dn[0]) {
237 for (rdn = exploded_dn + 1; *rdn; rdn++) {
239 strcat(default_dn, ", ");
240 strcat(default_dn, *rdn);
243 ldap_value_free(exploded_dn);
246 /* Use ldap_explode_dn() to parse the string & test its syntax */
247 if (exploded_dn = ldap_explode_dn(dn, 1)) {
248 if (relative && !is_whitespace(default_dn)) {
251 strcpy(default_dn, strcat(strcat(strcpy(buf, dn), ", "), default_dn));
253 strcpy(default_dn, dn);
254 ldap_value_free(exploded_dn);
256 puts("Invalid distinguished name.");
261 printf("Distinguished name suffix is `%s'\n", default_dn);
266 int cmd_quit(char **cmdargv, int cmdargc)
271 int cmd_search(char **cmdargv, int cmdargc)
277 static char *opts[] = { "absolute", "object", "scope" };
280 static char *scope_opts[] = { "base", "onelevel", "subtree" };
281 static int scope_vals[] = { LDAP_SCOPE_BASE, LDAP_SCOPE_ONELEVEL, LDAP_SCOPE_SUBTREE };
282 static int search_scope = LDAP_SCOPE_ONELEVEL;
284 for (i = 1; i < cmdargc; i++) {
285 if (cmdargv[i][0] == '-') {
286 switch (table_lookup(cmdargv[i] + 1, opts, sizeof(opts) / sizeof(opts[0]))) {
297 if ((++i < cmdargc) &&
298 (j = table_lookup(cmdargv[i], scope_opts, sizeof(scope_opts) / sizeof(scope_opts[0]))) >= 0)
299 search_scope = scope_vals[j];
314 if (errflag || !filter) {
315 show_syntax(CMD_SEARCH);
319 if (ldap_search(ld, make_dn(dn, relative), search_scope, filter, attrs_null, 0) == -1) {
320 ldap_perror(ld, progname);
324 if (ldap_result(ld, LDAP_RES_ANY, 1, (struct timeval *)0, &result) == -1) {
325 ldap_perror(ld, progname);
329 display_search_results(result);
334 int cmd_set(char **cmdargv, int cmdargc)
336 static char *alias_opts[] = { "never", "search", "find", "always" };
339 static char *opts[] = { "aliasderef", "sizelimit", "timelimit" };
341 for (i = 1; i < cmdargc; i++) {
342 if (cmdargv[i][0] == '-') {
343 switch (table_lookup(cmdargv[i] + 1, opts, sizeof(opts) / sizeof(opts[0]))) {
345 if ((++i < cmdargc) &&
346 (j = table_lookup(cmdargv[i], alias_opts, sizeof(alias_opts) / sizeof(alias_opts[0]))) >= 0)
347 ldap_set_option(ld, LDAP_OPT_DEREF, &j);
353 j = atoi(cmdargv[i]);
354 ldap_set_option(ld, LDAP_OPT_SIZELIMIT, &j);
360 j = atoi(cmdargv[i]);
361 ldap_set_option(ld, LDAP_OPT_TIMELIMIT, &j);
373 show_syntax(CMD_SET);
375 int opt_a, opt_s, opt_t;
376 ldap_get_option(ld, LDAP_OPT_DEREF, &opt_a);
377 ldap_get_option(ld, LDAP_OPT_SIZELIMIT, &opt_s);
378 ldap_get_option(ld, LDAP_OPT_TIMELIMIT, &opt_t);
379 printf("Alias dereferencing is %s, Sizelimit is %d entr%s, Timelimit is %d second%s.\n",
381 opt_s, opt_s == 1 ? "y" : "ies",
382 opt_t, opt_t == 1 ? "" : "s");
388 int cmd_show(char **cmdargv, int cmdargc)
394 static char *opts[] = { "absolute" };
398 for (i = 1; i < cmdargc; i++) {
399 if (cmdargv[i][0] == '-') {
400 switch (table_lookup(cmdargv[i] + 1, opts, sizeof(opts) / sizeof(opts[0]))) {
416 show_syntax(CMD_SHOW);
420 if (ldap_search(ld, make_dn(dn, relative), LDAP_SCOPE_BASE, true_filter, NULL, 0) == -1) {
421 ldap_perror(ld, progname);
425 if (ldap_result(ld, LDAP_RES_ANY, 1, (struct timeval *)0, &result) == -1) {
426 ldap_perror(ld, progname);
430 display_search_results(result);
435 void display_search_results(LDAPMessage *result)
443 for (entry = ldap_first_entry(ld, result); entry; entry = ldap_next_entry(ld, entry)) {
444 if (s = ldap_get_dn(ld, entry)) {
449 /* Make one pass to calculate the length of the longest attribute name */
451 for (s = ldap_first_attribute(ld, entry, &cookie); s; s = ldap_next_attribute(ld, entry, cookie))
452 if ((i = strlen(s)) > maxname)
455 /* Now print the attributes and values */
456 for (s = ldap_first_attribute(ld, entry, &cookie); s; s = ldap_next_attribute(ld, entry, cookie)) {
459 if (table_lookup(s, binary_attrs, sizeof(binary_attrs) / sizeof(binary_attrs[0])) >= 0)
460 continue; /* Skip this attribute - it's binary */
462 printf(" %-*s - ", maxname, s);
464 /* Now print each of the values for the given attribute */
465 if (values = ldap_get_values(ld, entry, s)) {
468 for (val = values; *val; ) {
472 /* Watch out for values that have embedded \n characters */
473 while (nl = strchr(v, '\n')) {
478 printf(" %*s", maxname + 3, "");
483 printf(" %*s", maxname + 3, "");
485 ldap_value_free(values);
491 if (ldap_result2error(ld, result, 0))
492 ldap_perror(ld, progname);
495 int do_command(char *cmd)
501 /* Tokenize the input command, allowing for quoting */
503 cmd = skip_whitespace(cmd);
505 break; /* end of input */
507 cmdargv[cmdargc++] = cmd;
508 if (*cmd == '\'' || *cmd == '"') {
509 cmdargv[cmdargc - 1]++; /* Skip over the opening quote */
510 cmd = skip_to_char(cmd + 1, *cmd);
512 puts("Command is missing a trailing quote");
517 cmd = skip_to_whitespace(cmd);
524 printf("cmdargc = %d\n", cmdargc);
525 for (i = 0; i < cmdargc; i++)
529 if (cmdargv[0][0] == '?')
530 return cmd_help(cmdargv, cmdargc);
532 for (i = 0; i < sizeof(cmdtable) / sizeof(cmdtable[0]); i++)
533 if (strncasecmp(cmdargv[0], cmdtable[i].cmd, strlen(cmdargv[0])) == 0)
534 return (*cmdtable[i].func)(cmdargv, cmdargc);
536 if (!is_whitespace(cmdargv[0])) {
537 printf("Unrecognized command - %s\n", cmdargv[0]);
538 cmd_help(cmdargv, 1);
544 void do_commands(FILE *file)
546 char cmd_buf[BUFSIZ];
547 int tty = isatty(fileno(file));
555 sprintf(prompt, (strlen(default_dn) < 18
557 : "saucer dn=%.15s..> "), default_dn);
558 #ifndef HAVE_READLINE
559 fputs (prompt, stdout);
561 buf = readline (prompt);
571 if (!fgets(cmd_buf, sizeof(cmd_buf), file))
575 status = do_command(buf);
585 int is_whitespace(register char *s)
590 while (*s && isspace((unsigned char) *s))
596 int main(int argc, char **argv)
603 while ((option = getopt(argc, argv, "h:p:u:c:d:")) != EOF)
606 credentials = optarg;
611 lber_set_option(NULL, LBER_OPT_DEBUG_LEVEL, &tmp);
612 ldap_set_option(NULL, LDAP_OPT_DEBUG_LEVEL, &tmp);
619 portnum = atoi(optarg);
629 fprintf(stderr, "usage: %s [-h host] [-p portnumber] [-u X500UserName]\n\t[-c credentials] [-d debug-level]\n",
636 if (!(ld = ldap_open(hostname, portnum))) {
637 fprintf(stderr, "%s: unable to connect to server at host `%s' on port %d\n",
638 progname, hostname, portnum);
656 char *make_dn(char *dn, int relative)
658 static char dn_buf[DN_MAXLEN];
664 if (!default_dn[0] || !relative)
670 return strcat(strcat(strcpy(dn_buf, dn), ", "), default_dn);
673 void show_syntax(int cmdnum)
675 printf("Syntax: %s %s\n", cmdtable[cmdnum].cmd, cmdtable[cmdnum].help_msg);
678 char *skip_to_char(register char *s, register int c)
683 while (*s && *s != c)
689 char *skip_to_whitespace(register char *s)
694 while (*s && !isspace((unsigned char) *s))
700 char *skip_whitespace(register char *s)
705 while (*s && isspace((unsigned char) *s))
711 int table_lookup(char *word, char **table, int table_count)
719 wordlen = strlen(word);
721 for (i = 0; i < table_count; i++)
722 if (strncasecmp(word, table[i], wordlen) == 0)
727 FILE *user_tailor(void)
736 struct passwd *pwent;
738 if (pwent = getpwuid(getuid()))
739 strcat(strcpy(rcfile, pwent->pw_dir), "/");
740 strcat(rcfile, ".saucerrc");
743 strcpy(rcfile, "saucer.rc");
746 return fopen(rcfile, "r");