chiark / gitweb /
+ * Treat 8-bit characters in email addrs as RFC822 `special' (=> quote).
[adns.git] / src / adns.h
index a1e0877c1327251d8a722d706cd99a456026c89d..ffd82743c28ca31f14da1f1f2795351d0f12d80b 100644 (file)
@@ -5,11 +5,11 @@
 /*
  *
  *  This file is
- *    Copyright (C) 1997-1999 Ian Jackson <ian@davenant.greenend.org.uk>
+ *    Copyright (C) 1997-2000 Ian Jackson <ian@davenant.greenend.org.uk>
  *
  *  It is part of adns, which is
- *    Copyright (C) 1997-1999 Ian Jackson <ian@davenant.greenend.org.uk>
- *    Copyright (C) 1999 Tony Finch <dot@dotat.at>
+ *    Copyright (C) 1997-2000 Ian Jackson <ian@davenant.greenend.org.uk>
+ *    Copyright (C) 1999-2000 Tony Finch <dot@dotat.at>
  *  
  *  This program is free software; you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
  *  GNU General Public License for more details.
  *
  * 
- *  For the benefit of certain LGPL'd `omnibus' software which provides
- *  a uniform interface to various things including adns, I make the
- *  following additional licence.  I do this because the GPL would
- *  otherwise force either the omnibus software to be GPL'd or for the
- *  adns-using part to be distributed separately.
+ *  For the benefit of certain LGPL'd `omnibus' software which
+ *  provides a uniform interface to various things including adns, I
+ *  make the following additional licence.  I do this because the GPL
+ *  would otherwise force either the omnibus software to be GPL'd or
+ *  the adns-using part to be distributed separately.
  *  
- *  So, you may also redistribute and/or modify adns.h (but only the
+ *  So: you may also redistribute and/or modify adns.h (but only the
  *  public header file adns.h and not any other part of adns) under the
  *  terms of the GNU Library General Public License as published by the
  *  Free Software Foundation; either version 2 of the License, or (at
  *  applications where the whole distribution is not GPL'd, are still
  *  likely to be in violation of the GPL.  Anyone who wants to do this
  *  should contact Ian Jackson.  Please note that to avoid encouraging
- *  people to infringe the GPL as it applies the body of adns, I think
- *  that if you take advantage of the special exception to redistribute
- *  just adns.h under the LGPL, you should retain this paragraph in its
- *  place in the appropriate copyright statements.
+ *  people to infringe the GPL as it applies to the body of adns, Ian
+ *  thinks that if you take advantage of the special exception to
+ *  redistribute just adns.h under the LGPL, you should retain this
+ *  paragraph in its place in the appropriate copyright statements.
  *
  *
  *  You should have received a copy of the GNU General Public License,
@@ -56,9 +56,6 @@
 
 #ifndef ADNS_H_INCLUDED
 #define ADNS_H_INCLUDED
-#ifdef __cplusplus
-extern "C" { /* I really dislike this - iwj. */
-#endif
 
 #include <stdio.h>
 
@@ -68,6 +65,10 @@ extern "C" { /* I really dislike this - iwj. */
 #include <sys/time.h>
 #include <unistd.h>
 
+#ifdef __cplusplus
+extern "C" { /* I really dislike this - iwj. */
+#endif
+
 /* All struct in_addr anywhere in adns are in NETWORK byte order. */
 
 typedef struct adns__state *adns_state;
@@ -150,12 +151,6 @@ typedef enum {
  * names) will be quoted, as \X if it is a printing ASCII character or
  * \DDD otherwise.
  *
- * (The characters which will be unquoted are the printing 7-bit ASCII
- * characters except the punctuation characters " ( ) @ ; $ \
-
- * I.e. unquoted characters are alphanumerics, and the following
- * punctuation characters:  ! # % ^ & * - _ = + [ ] { } 
- *
  * If the query goes via a CNAME then the canonical name (ie, the
  * thing that the CNAME record refers to) is usually allowed to
  * contain any characters, which will be quoted as above.  With
@@ -178,13 +173,26 @@ typedef enum {
  * header field.  The particular format used is that if the mailbox
  * requires quoting according to the rules in RFC822 then the
  * local-part is quoted in double quotes, which end at the next
- * unescaped double quote.  (\ is the escape char, and is doubled, and
- * is used to escape only \ and ".)  Otherwise the local-part is
- * presented as-is.  In any case this is followed by an @ and the
- * domain.  The domain will not contain any characters not legal in
- * hostnames.  adns will protect the application from local parts
- * containing control characters - these appear to be legal according
- * to RFC822 but are clearly a bad idea.
+ * unescaped double quote (\ is the escape char, and is doubled, and
+ * is used to escape only \ and ").  If the local-part is legal
+ * without quoting according to RFC822, it is presented as-is.  In any
+ * case the local-part is followed by an @ and the domain.  The domain
+ * will not contain any characters not legal in hostnames.
+ *
+ * Unquoted local-parts may contain any printing 7-bit ASCII
+ * except the punctuation characters ( ) < > @ , ; : \ " [ ]
+ * I.e. they may contain alphanumerics, and the following
+ * punctuation characters:  ! # % ^ & * - _ = + { } .
+ *
+ * adns will reject local parts containing control characters (byte
+ * values 0-31, 127-159, and 255) - these appear to be legal according
+ * to RFC822 but are clearly a bad idea.  RFC1035 syntax does not make
+ * any distinction between a single RFC822 quoted-string containing
+ * full stops, and a series of quoted-strings separated by full stops;
+ * adns will return anything that isn't all valid atoms as a single
+ * quoted-string.  RFC822 does not allow high-bit-set characters at
+ * all, but adns does allow them in local-parts, treating them as
+ * needing quoting.
  *
  * If you ask for the domain with _raw then _no_ checking is done
  * (even on the host part, regardless of adns_qf_quoteok_anshost), and
@@ -511,6 +519,19 @@ int adns_submit_reverse(adns_state ads,
  * addr->sa_family must be AF_INET or you get ENOSYS.
  */
 
+int adns_submit_reverse_any(adns_state ads,
+                           const struct sockaddr *addr,
+                           const char *rzone,
+                           adns_rrtype type,
+                           adns_queryflags flags,
+                           void *context,
+                           adns_query *query_r);
+/* For RBL-style reverse `zone's; look up
+ *   <reversed-address>.<zone>
+ * Any type is allowed.  _qf_search is ignored.
+ * addr->sa_family must be AF_INET or you get ENOSYS.
+ */
+
 void adns_finish(adns_state ads);
 /* You may call this even if you have queries outstanding;
  * they will be cancelled.
@@ -650,9 +671,10 @@ void adns_beforeselect(adns_state ads, int *maxfd, fd_set *readfds,
  * for adns_firsttimeout.  readfds, writefds, exceptfds and maxfd_io may
  * not be 0.
  *
- * If *now is not 0 then this will never actually do any I/O, or
- * change the fds that adns is using or the timeouts it wants.  In any
- * case it won't block.
+ * If now is not 0 then this will never actually do any I/O, or change
+ * the fds that adns is using or the timeouts it wants.  In any case
+ * it won't block, and it will set the timeout to zero if a query
+ * finishes in _beforeselect.
  */
 
 void adns_afterselect(adns_state ads, int maxfd, const fd_set *readfds,
@@ -797,9 +819,9 @@ adns_status adns_rr_info(adns_rrtype type,
  * hostname, as usual, followed by the adns_status value, as an
  * abbreviation, and then a descriptive string (encoded as if it were
  * a piece of text), for the address lookup, followed by zero or more
- * addresses enclosed in ( and ).  If the result was a permanent
+ * addresses enclosed in ( and ).  If the result was a temporary
  * failure, then a single ?  appears instead of the ( ).  If the
- * result was a temporary failure then an empty pair of parentheses
+ * result was a permanent failure then an empty pair of parentheses
  * appears (which a space in between).  For example, one of the NS
  * records for greenend.org.uk comes out like
  *  ns.chiark.greenend.org.uk ok "OK" ( INET 195.224.76.132 )