unknown rr types seem to work
[adns] / client / adh-opts.c
1 /*
2 * adh-opts.c
3 * - useful general-purpose resolver client program
4 * option handling tables etc.
5 */
6 /*
7 * This file is
8 * Copyright (C) 1997-2000 Ian Jackson <ian@davenant.greenend.org.uk>
9 *
10 * It is part of adns, which is
11 * Copyright (C) 1997-2000 Ian Jackson <ian@davenant.greenend.org.uk>
12 * Copyright (C) 1999-2000 Tony Finch <dot@dotat.at>
13 *
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2, or (at your option)
17 * any later version.
18 *
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
23 *
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software Foundation,
26 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 */
28
29 #include "adnshost.h"
30
31 int ov_env=1, ov_pipe=0, ov_asynch=0;
32 int ov_verbose= 0;
33 adns_rrtype ov_type= adns_r_none;
34 int ov_search=0, ov_qc_query=0, ov_qc_anshost=0, ov_qc_cname=1;
35 int ov_tcp=0, ov_cname=0, ov_format=fmt_default;
36 char *ov_id= 0;
37 struct perqueryflags_remember ov_pqfr = { 1,1,1, tm_none };
38
39 static const struct optioninfo global_options[]= {
40 { ot_desconly, "global binary options:" },
41 { ot_flag, "Do not look at environment variables at all",
42 "e", "env", &ov_env, 0 },
43 { ot_flag, "Read queries on stdin instead of using args",
44 "f", "pipe", &ov_pipe, 1 },
45 { ot_flag, "Allow answers to be reordered",
46 "a", "asynch", &ov_asynch, 1 },
47
48 { ot_desconly, "answer/error output format and destination (see below):" },
49 { ot_value, "Answers to stdout, errors as messages to stderr (default)",
50 "Fs", "fmt-simple", &ov_format, fmt_simple },
51 { ot_value, "Answers and errors both to stdout in parseable format",
52 "Fi", "fmt-inline", &ov_format, fmt_inline },
53 { ot_value, "Fully-parseable output format (default for --asynch)",
54 "Fa", "fmt-asynch", &ov_format, fmt_asynch },
55
56 { ot_desconly, "global verbosity level:" },
57 { ot_value, "Do not print anything to stderr",
58 "Vq", "quiet", &ov_verbose, adns_if_noerrprint },
59 { ot_value, "Report unexpected kinds of problem only (default)",
60 "Vn", "no-quiet", &ov_verbose, 0 },
61 { ot_value, "Debugging mode",
62 "Vd", "debug", &ov_verbose, adns_if_debug },
63
64 { ot_desconly, "other global options:" },
65 { ot_funcarg, "Configuration to use instead of /etc/resolv.conf",
66 0, "config", 0,0, of_config, "<config-text>" },
67 { ot_func, "Print version number",
68 0, "version", 0,0, of_version },
69 { ot_func, "Print usage information",
70 0, "help", 0,0, of_help },
71
72 { ot_end }
73 };
74
75 static const struct optioninfo perquery_options[]= {
76 { ot_desconly, "per-query options:" },
77 { ot_funcarg, "Query type (see below)",
78 "t", "type", 0,0, &of_type, "type" },
79 { ot_funcarg, "Do reverse query (address -> name lookup)",
80 "i", "ptr", 0,0, &of_ptr, "addr" },
81 { ot_funcarg2, "Lookup in in-addr-like `zone' (eg MAPS RBL)",
82 0, "reverse", 0,0, &of_reverse, "addr","zone" },
83
84 { ot_desconly, "per-query binary options:" },
85 { ot_flag, "Use the search list",
86 "s", "search", &ov_search, 1 },
87 { ot_flag, "Let query domains contain quote-requiring chars",
88 "Qq", "qc-query", &ov_qc_query, 1 },
89 { ot_flag, "Let hostnames in answers contain ...",
90 "Qa", "qc-anshost", &ov_qc_anshost, 1 },
91 { ot_flag, "Prevent CNAME target domains from containing ...",
92 "Qc", "qc-cname", &ov_qc_cname, 0 },
93 { ot_flag, "Force use of a virtual circuit",
94 "u", "tcp", &ov_tcp, 1 },
95 { ot_flag, "Do not display owner name in output",
96 "Do", "show-owner", &ov_pqfr.show_owner, 0 },
97 { ot_flag, "Do not display RR type in output",
98 "Dt", "show-type", &ov_pqfr.show_type, 0 },
99 { ot_flag, "Do not display CNAME target in output",
100 "Dc", "show-cname", &ov_pqfr.show_cname, 0 },
101
102 { ot_desconly, "per-query TTL mode (NB TTL is minimum across all info in reply):" },
103 { ot_value, "Show the TTL as a TTL",
104 "Tt", "ttl-ttl", &ov_pqfr.ttl, tm_rel },
105 { ot_value, "Show the TTL as a time_t when the data might expire",
106 "Ta", "ttl-abs", &ov_pqfr.ttl, tm_abs },
107 { ot_value, "Do not show the TTL (default)",
108 "Tn", "no-ttl", &ov_pqfr.ttl, tm_none },
109
110 { ot_desconly, "per-query CNAME handling mode:" },
111 { ot_value, "Call it an error if a CNAME is found",
112 "Cf", "cname-reject", &ov_cname, adns_qf_cname_forbid },
113 { ot_value, "Allow references to CNAMEs in other RRs",
114 "Cl", "cname-loose", &ov_cname, adns_qf_cname_loose },
115 { ot_value, "CNAME ok for query domain, but not in RRs (default)",
116 "Cs", "cname-ok", &ov_cname, 0 },
117
118 { ot_desconly, "asynchronous/pipe mode options:" },
119 { ot_funcarg, "Set <id>, default is decimal sequence starting 0",
120 0, "asynch-id", 0,0, &of_asynch_id, "id" },
121 { ot_funcarg, "Cancel the query with id <id> (no error if not found)",
122 0, "cancel-id", 0,0, &of_cancel_id, "id" },
123
124 { ot_end }
125 };
126
127 static void printusage(void) {
128 static const struct optioninfo *const all_optiontables[]= {
129 global_options, perquery_options, 0
130 };
131
132 const struct optioninfo *const *oiap, *oip=0;
133 int maxsopt, maxlopt, l;
134
135 maxsopt= maxlopt= 0;
136
137 for (oiap=all_optiontables; *oiap; oiap++) {
138 for (oip=*oiap; oip->type != ot_end; oip++) {
139 if (oip->type == ot_funcarg) continue;
140 if (oip->sopt) { l= strlen(oip->sopt); if (l>maxsopt) maxsopt= l; }
141 if (oip->lopt) {
142 l= strlen(oip->lopt);
143 if (oip->type == ot_flag && !oip->value) l+= 3;
144 if (l>maxlopt) maxlopt= l;
145 }
146 }
147 }
148
149 fputs("usage: adnshost [global-opts] [query-opts] query-domain\n"
150 " [[query-opts] query-domain ...]\n"
151 " adnshost [global-opts] [query-opts] -f|--pipe\n",
152 stdout);
153
154 for (oiap=all_optiontables; *oiap; oiap++) {
155 putchar('\n');
156 for (oip=*oiap; oip->type != ot_end; oip++) {
157 switch (oip->type) {
158 case ot_flag:
159 if (!oip->value) {
160 if (oip->sopt) {
161 printf(" +%-*s --no-%-*s %s\n",
162 maxsopt, oip->sopt,
163 maxlopt-2, oip->lopt,
164 oip->desc);
165 } else {
166 printf(" --no-%-*s %s\n",
167 maxlopt+maxsopt+1, oip->lopt,
168 oip->desc);
169 }
170 break;
171 }
172 case ot_value: case ot_func: /* fall through */
173 if (oip->sopt) {
174 printf(" -%-*s --%-*s %s\n",
175 maxsopt, oip->sopt,
176 maxlopt+1, oip->lopt,
177 oip->desc);
178 } else {
179 printf(" --%-*s %s\n",
180 maxlopt+maxsopt+3, oip->lopt,
181 oip->desc);
182 }
183 break;
184 case ot_funcarg:
185 if (oip->sopt) {
186 l= (maxlopt + maxsopt - 9 -
187 (strlen(oip->sopt) + strlen(oip->lopt) + 2*strlen(oip->argdesc)));
188 printf(" -%s<%s> / --%s <%s>%*s%s\n",
189 oip->sopt, oip->argdesc, oip->lopt, oip->argdesc,
190 l>2 ? l : 2, "",
191 oip->desc);
192 } else {
193 l= (maxlopt + maxsopt + 1 -
194 (strlen(oip->lopt) + strlen(oip->argdesc)));
195 printf(" --%s <%s>%*s%s\n",
196 oip->lopt, oip->argdesc,
197 l>2 ? l : 2, "",
198 oip->desc);
199 }
200 break;
201 case ot_funcarg2:
202 assert(!oip->sopt);
203 l= (maxlopt + maxsopt - 2 -
204 (strlen(oip->lopt) + strlen(oip->argdesc) + strlen(oip->argdesc2)));
205 printf(" --%s <%s> <%s>%*s%s\n",
206 oip->lopt, oip->argdesc, oip->argdesc2,
207 l>2 ? l : 2, "",
208 oip->desc);
209 break;
210 case ot_desconly:
211 printf("%s\n", oip->desc);
212 break;
213 default:
214 abort();
215 }
216 }
217 }
218
219 printf("\nEscaping domains which might start with `-':\n"
220 " - %-*s Next argument is a domain, but more options may follow\n",
221 maxlopt+maxsopt+3, "<domain>");
222
223 fputs("\n"
224 "Query domains should always be quoted according to master file format.\n"
225 "\n"
226 "For binary options, --FOO and --no-FOO are opposites, as are\n"
227 "-X and +X. In each case the default is the one not listed.\n"
228 "Per query options stay set a particular way until they are reset,\n"
229 "whether they appear on the command line or on stdin.\n"
230 "All global options must preceed the first query domain.\n"
231 "\n"
232 "With -f, the input should be lines with either an option, possibly\n"
233 "with a value argument (separated from the option by a space if it's a long\n"
234 "option), or a domain (possibly preceded by a hyphen and a space to\n"
235 "distinguish it from an option).\n"
236 "\n"
237 "Output format is master file format without class or TTL by default:\n"
238 " [<owner>] [<ttl>] [<type>] <data>\n"
239 "or if the <owner> domain refers to a CNAME and --show-cname is on\n"
240 " [<owner>] [<ttl>] CNAME <cname>\n"
241 " [<cname>] [<ttl>] <type> <data>\n"
242 "When a query fails you get an error message to stderr (with --fmt-simple).\n"
243 "Specify --fmt-inline for lines like this (broken here for readability):\n"
244 " ; failed <statustype> <statusnum> <statusabbrev> \\\n"
245 " [<owner>] [<ttl>] [<cname>] \"<status string>\"\n"
246 "If you use --fmt-asynch, which is the default for --asynch,\n"
247 "each answer (success or failure) is preceded by a line\n"
248 " <id> <nrrs> <statustype> <statusnum> <statusabbrev> \\\n"
249 " [<owner>] [<ttl>] [<cname>] \"<status string>\"\n"
250 "where <nrrs> is the number of RRs that follow and <cname> will be `$' or\n"
251 "the CNAME target; the CNAME indirection and error formats above are not used.\n"
252 "\n"
253 "Exit status:\n"
254 " 0 all went well\n"
255 " 1-6 at least one query failed with statustype:\n"
256 " 1 localfail )\n"
257 " 2 remotefail ) temporary errors\n"
258 " 3 tempfail __)_________________\n"
259 " 4 misconfig )\n"
260 " 5 misquery ) permanent errors\n"
261 " 6 permfail )\n"
262 " 10 system trouble\n"
263 " 11 usage problems\n"
264 "\n"
265 "Query types (see adns.h; default is addr):\n"
266 " ns soa ptr mx rp srv addr - enhanced versions\n"
267 " cname hinfo txt - types with only one version\n"
268 " a ns- soa- ptr- mx- rp- srv- - _raw versions\n"
269 " type<number> - `unknown' type, RFC3597\n"
270 "Default is addr, or ptr for -i/--ptr queries\n",
271 stdout);
272 if (ferror(stdout)) sysfail("write usage message",errno);
273 }
274
275 void of_version(const struct optioninfo *oi, const char *arg, const char *arg2) {
276 VERSION_PRINT_QUIT("adnshost");
277 }
278
279 void of_help(const struct optioninfo *oi, const char *arg, const char *arg2) {
280 printusage();
281 if (fclose(stdout)) sysfail("finish writing output",errno);
282 quitnow(0);
283 }
284
285 typedef int comparer_type(const char **optp, const struct optioninfo *entry);
286
287 static int oc_long(const char **optp, const struct optioninfo *entry) {
288 return entry->lopt && !strcmp(*optp,entry->lopt);
289 }
290
291 static int oc_short(const char **optp, const struct optioninfo *entry) {
292 const char *sopt;
293 int l;
294
295 sopt= entry->sopt;
296 if (!sopt) return 0;
297 l= strlen(sopt);
298 if (memcmp(*optp,sopt,l)) return 0;
299 (*optp) += l;
300 return 1;
301 }
302
303 static const struct optioninfo *find1(const char **optp,
304 const struct optioninfo *table,
305 comparer_type *comparer) {
306 for (;;) {
307 if (table->type == ot_end) return 0;
308 if (comparer(optp,table)) return table;
309 table++;
310 }
311 }
312
313 static const struct optioninfo *find(const char **optp,
314 const char *prefix,
315 comparer_type *comparer) {
316 const struct optioninfo *oip;
317 const char *opt;
318
319 opt= *optp;
320 oip= find1(optp,perquery_options,comparer);
321 if (oip) return oip;
322 oip= find1(optp,global_options,comparer);
323 if (!oip) usageerr("unknown option %s%s",prefix,opt);
324 if (ads) usageerr("global option %s%s specified after query domain(s)",prefix,opt);
325 return oip;
326 }
327
328 const struct optioninfo *opt_findl(const char *opt) { return find(&opt,"--",oc_long); }
329 const struct optioninfo *opt_finds(const char **optp) { return find(optp,"-",oc_short); }
330
331 static void noninvert(const struct optioninfo *oip) NONRETURNING;
332 static void noninvert(const struct optioninfo *oip) {
333 usageerr("option %s%s%s%s%s may not be inverted",
334 oip->sopt ? "-" : "", oip->sopt ? oip->sopt : "",
335 oip->lopt && oip->sopt ? " / " : "",
336 oip->lopt ? "--" : "", oip->lopt ? oip->lopt : "");
337 }
338
339 void opt_do(const struct optioninfo *oip, int invert,
340 const char *arg, const char *arg2) {
341 switch (oip->type) {
342 case ot_flag:
343 assert(!arg);
344 *oip->storep= !invert;
345 return;
346 case ot_value:
347 assert(!arg);
348 if (invert) noninvert(oip);
349 *oip->storep= oip->value;
350 return;
351 case ot_func: case ot_funcarg: case ot_funcarg2:
352 if (invert) noninvert(oip);
353 oip->func(oip,arg,arg2);
354 return;
355 default:
356 abort();
357 }
358 }