chiark / gitweb /
server/admin.c: Remove spurious `ping' in usage message.
[tripe] / server / admin.c
index 58230baf80cf3183f5125db2eb3f495e88616eb0..221b249e5e1490b121fc1d2512516048bd2ec20f 100644 (file)
@@ -68,7 +68,7 @@ static const trace_opt w_opts[] = {
 static admin *admins;
 static admin *a_dead;
 static sel_file sock;
-static const char *sockname;
+static const char *sockname = 0;
 static sym_table a_svcs;
 static unsigned flags = 0;
 static admin *a_stdin = 0;
@@ -260,7 +260,9 @@ static void a_flush(int fd, unsigned mode, void *v)
  *
  *               * "?PEER" PEER -- peer's name
  *
- *               * "?ERRNO" ERRNO -- system error code
+ *               * "?ERR" CODE -- system error code
+ *
+ *               * "?ERRNO" -- system error code from @errno@
  *
  *               * "[!]..." ... -- @dstr_putf@-like string as single token
  */
@@ -303,7 +305,11 @@ void a_vformat(dstr *d, const char *fmt, va_list *ap)
        while (*av) u_quotify(d, *av++);
       } else if (strcmp(fmt, "?PEER") == 0)
        u_quotify(d, p_name(va_arg(*ap, peer *)));
-      else if (strcmp(fmt, "?ERRNO") == 0) {
+      else if (strcmp(fmt, "?ERR") == 0) {
+       int e = va_arg(*ap, int);
+       dstr_putf(d, " E%d", e);
+       u_quotify(d, strerror(e));
+      } else if (strcmp(fmt, "?ERRNO") == 0) {
        dstr_putf(d, " E%d", errno);
        u_quotify(d, strerror(errno));
       } else
@@ -547,24 +553,6 @@ void a_notify(const char *fmt, ...)
   va_end(ap);
 }
 
-/* --- @a_quit@ --- *
- *
- * Arguments:  ---
- *
- * Returns:    ---
- *
- * Use:                Shuts things down nicely.
- */
-
-void a_quit(void)
-{
-  close(sock.fd);
-  unlink(sockname);
-  FOREACH_PEER(p, { p_destroy(p); });
-  ps_quit();
-  exit(0);
-}
-
 /* --- @a_sigdie@ --- *
  *
  * Arguments:  @int sig@ = signal number
@@ -589,7 +577,7 @@ static void a_sigdie(int sig, void *v)
       break;
   }
   a_warn("SERVER", "quit", "signal", "%s", p, A_END);
-  a_quit();
+  lp_end();
 }
 
 /* --- @a_sighup@ --- *
@@ -902,7 +890,7 @@ static void a_jobdestroy(admin_svcop *svc)
   IF_TRACING(T_ADMIN, {
     trace(T_ADMIN, "admin: destroying job %s (%u)", a_jobidencode(svc), i);
   })
-  assert(j->v[i].u.op = svc);
+  assert(j->v[i].u.op == svc);
   j->v[i].u.next = j->free;
   j->v[i].seq++;
   j->free = i;
@@ -1233,7 +1221,10 @@ static void a_resolve(admin *a, admin_resop *r, const char *tag,
     { fam = "ANY"; af = AF_UNSPEC; i++; }
   else for (j = 0; j < NADDRFAM; j++) {
     if (mystrieq(av[i], aftab[j].name)) {
-      assert(udpsock[j].fd >= 0);
+      if (udpsock[j].sf.fd < 0) {
+       a_fail(a, "disabled-address-family", "%s", aftab[j].name, A_END);
+       goto fail;
+      }
       fam = aftab[j].name;
       af = aftab[j].af;
       i++;
@@ -1275,25 +1266,15 @@ static void a_resolve(admin *a, admin_resop *r, const char *tag,
   T( trace(T_ADMIN, "admin: %u, resop %s, hostname `%s', family `%s'",
           a->seq, BGTAG(r), r->addr, fam); )
 
-  /* --- Make sure the address family is something we can implement --- */
-
-  if (af != AF_UNSPEC && af != AF_INET) {
-    T( trace(T_ADMIN, "admin: resop %s failed: unsupported address family",
-            BGTAG(r)); )
-    a_bgfail(&r->bg, "resolve-error", "%s", r->addr, A_END);
-    goto fail_release;
-  }
-  assert(udpsock[AFIX_INET].fd >= 0);
-
   /* --- If the name is numeric, do it the easy way --- */
 
-  aihint.ai_family = AF_INET;
+  aihint.ai_family = af;
   aihint.ai_socktype = SOCK_DGRAM;
   aihint.ai_protocol = IPPROTO_UDP;
   aihint.ai_flags = AI_NUMERICHOST;
   if (!getaddrinfo(av[i], 0, &aihint, &ailist)) {
     for (ai = ailist; ai; ai = ai->ai_next) {
-      if ((j = afix(ai->ai_family)) >= 0 && udpsock[j].fd >= 0)
+      if ((j = afix(ai->ai_family)) >= 0 && udpsock[j].sf.fd >= 0)
        break;
     }
     if (!ai) {
@@ -1320,7 +1301,11 @@ static void a_resolve(admin *a, admin_resop *r, const char *tag,
   tv.tv_sec += T_RESOLVE;
   sel_addtimer(&sel, &r->t, &tv, a_restimer, r);
 #ifdef HAVE_LIBADNS
-  qf = adns_qf_search | adns_qf_want_ipv4;
+  qf = adns_qf_search;
+  for (j = 0; j < NADDRFAM; j++) {
+    if ((af == AF_UNSPEC || af == aftab[i].af) && udpsock[j].sf.fd >= 0)
+      qf |= aftab[j].qf;
+  }
   if ((err = adns_submit(ads, r->addr, adns_r_addr, qf, r, &r->q)) != 0) {
     T( trace(T_ADMIN, "admin: resop %s adns_submit failed: %s",
             BGTAG(r), strerror(err)); )
@@ -1328,6 +1313,16 @@ static void a_resolve(admin *a, admin_resop *r, const char *tag,
     goto fail_release;
   }
 #else
+  if (af != AF_UNSPEC && af != AF_INET) {
+    T( trace(T_ADMIN, "admin: resop %s failed: unsupported address family",
+            BGTAG(r)); )
+    a_bgfail(&r->bg, "resolve-error", "%s", r->addr, A_END);
+    goto fail_release;
+  }
+  if (udpsock[AFIX_INET].sf.fd < 0) {
+    a_bgfail(&r->bg, "disabled-address-family", "INET", A_END);
+    goto fail_release;
+  }
   bres_byname(&r->r, r->addr, a_resolved, r);
 #endif
   return;
@@ -1414,6 +1409,7 @@ static void a_doadd(admin_resop *r, int rc)
 
   if (add->peer.tag) xfree(add->peer.tag);
   if (add->peer.privtag) xfree(add->peer.privtag);
+  if (add->peer.knock) xfree(add->peer.knock);
   xfree(add->peer.name);
 }
 
@@ -1432,6 +1428,7 @@ static void acmd_add(admin *a, unsigned ac, char *av[])
 {
   const char *tag = 0;
   admin_addop *add;
+  const tunnel_ops *tops;
 
   /* --- Set stuff up --- */
 
@@ -1439,8 +1436,9 @@ static void acmd_add(admin *a, unsigned ac, char *av[])
   add->peer.name = 0;
   add->peer.tag = 0;
   add->peer.privtag = 0;
+  add->peer.knock = 0;
   add->peer.t_ka = 0;
-  add->peer.tops = tun_default;
+  add->peer.tops = p_dflttun();
   add->peer.f = 0;
 
   /* --- Parse options --- */
@@ -1448,20 +1446,13 @@ static void acmd_add(admin *a, unsigned ac, char *av[])
   OPTIONS(ac, av, {
     OPTARG("-background", arg, { tag = arg; })
     OPTARG("-tunnel", arg, {
-      unsigned i;
-      for (i = 0;; i++) {
-       if (!tunnels[i]) {
-         a_fail(a, "unknown-tunnel", "%s", arg, A_END);
-         goto fail;
-       }
-       if (mystrieq(arg, tunnels[i]->name)) {
-         add->peer.tops = tunnels[i];
-         break;
-       }
-      }
+      if ((tops = p_findtun(arg)) == 0)
+       { a_fail(a, "unknown-tunnel", "%s", arg, A_END); goto fail; }
+      add->peer.tops = tops;
     })
     OPTTIME("-keepalive", t, { add->peer.t_ka = t; })
     OPT("-cork", { add->peer.f |= KXF_CORK; })
+    OPT("-ephemeral", { add->peer.f |= PSF_EPHEM; })
     OPTARG("-key", arg, {
       if (add->peer.tag) xfree(add->peer.tag);
       add->peer.tag = xstrdup(arg);
@@ -1471,6 +1462,10 @@ static void acmd_add(admin *a, unsigned ac, char *av[])
       if (add->peer.privtag) xfree(add->peer.privtag);
       add->peer.privtag = xstrdup(arg);
     })
+    OPTARG("-knock", arg, {
+      if (add->peer.knock) xfree(add->peer.knock);
+      add->peer.knock = xstrdup(arg);
+    })
   });
 
   /* --- Make sure someone's not got there already --- */
@@ -1497,6 +1492,7 @@ fail:
   if (add->peer.name) xfree(add->peer.name);
   if (add->peer.tag) xfree(add->peer.tag);
   if (add->peer.privtag) xfree(add->peer.privtag);
+  if (add->peer.knock) xfree(add->peer.knock);
   xfree(add);
   return;
 }
@@ -1597,7 +1593,7 @@ static void a_ping(admin *a, unsigned ac, char *av[],
   return;
 
 bad_syntax:
-  a_fail(a, "bad-syntax", "%s", cmd, "[OPTIONS] PEER", cmd, A_END);
+  a_fail(a, "bad-syntax", "%s", cmd, "[OPTIONS] PEER", A_END);
 fail:
   if (pg) xfree(pg);
   return;
@@ -1854,16 +1850,16 @@ static void acmd_port(admin *a, unsigned ac, char *av[])
     a_fail(a, "unknown-address-family", "%s", av[0], A_END);
     return;
   found:
-    if (udpsock[i].fd < 0) {
+    if (udpsock[i].sf.fd < 0) {
       a_fail(a, "disabled-address-family", "%s", aftab[i].name, A_END);
       return;
     }
   } else {
     for (i = 0; i < NADDRFAM; i++)
-      if (udpsock[i].fd >= 0) goto found;
+      if (udpsock[i].sf.fd >= 0) goto found;
     abort();
   }
-  a_info(a, "%u", p_port(i), A_END);
+  a_info(a, "%u", udpsock[i].port, A_END);
   a_ok(a);
 }
 
@@ -1975,7 +1971,7 @@ static void acmd_getchal(admin *a, unsigned ac, char *av[])
   buf b;
 
   buf_init(&b, buf_i, PKBUFSZ);
-  c_new(&b);
+  c_new(0, 0, &b);
   a_info(a, "?B64", BBASE(&b), (size_t)BLEN(&b), A_END);
   a_ok(a);
 }
@@ -1992,7 +1988,7 @@ static void acmd_checkchal(admin *a, unsigned ac, char *av[])
     a_fail(a, "bad-base64", "%s", codec_strerror(err), A_END);
   else {
     buf_init(&b, d.buf, d.len);
-    if (c_check(&b) || BBAD(&b) || BLEFT(&b))
+    if (c_check(0, 0, &b) || BBAD(&b) || BLEFT(&b))
       a_fail(a, "invalid-challenge", A_END);
     else
       a_ok(a);
@@ -2042,6 +2038,7 @@ static void acmd_peerinfo(admin *a, unsigned ac, char *av[])
   if ((p = a_findpeer(a, av[0])) != 0) {
     ps = p_spec(p);
     a_info(a, "tunnel=%s", ps->tops->name, A_END);
+    if (ps->knock) a_info(a, "knock=%s", ps->knock, A_END);
     a_info(a, "key=%s", p_tag(p),
           "current-key=%s", p->kx.kpub->tag, A_END);
     if ((ptag = p_privtag(p)) == 0) ptag = "(default)";
@@ -2050,6 +2047,7 @@ static void acmd_peerinfo(admin *a, unsigned ac, char *av[])
     a_info(a, "keepalive=%lu", ps->t_ka, A_END);
     a_info(a, "corked=%s", BOOL(p->kx.f&KXF_CORK),
           "mobile=%s", BOOL(ps->f&PSF_MOBILE),
+          "ephemeral=%s", BOOL(ps->f&PSF_EPHEM),
           A_END);
     a_ok(a);
   }
@@ -2105,7 +2103,7 @@ static void acmd_kill(admin *a, unsigned ac, char *av[])
   peer *p;
 
   if ((p = a_findpeer(a, av[0])) != 0) {
-    p_destroy(p);
+    p_destroy(p, 1);
     a_ok(a);
   }
 }
@@ -2127,7 +2125,7 @@ static void acmd_quit(admin *a, unsigned ac, char *av[])
 {
   a_warn("SERVER", "quit", "admin-request", A_END);
   a_ok(a);
-  a_quit();
+  lp_end();
 }
 
 static void acmd_version(admin *a, unsigned ac, char *av[])
@@ -2138,10 +2136,7 @@ static void acmd_version(admin *a, unsigned ac, char *av[])
 
 static void acmd_tunnels(admin *a, unsigned ac, char *av[])
 {
-  int i;
-
-  for (i = 0; tunnels[i]; i++)
-    a_info(a, "%s", tunnels[i]->name, A_END);
+  FOREACH_TUN(tops, { a_info(a, "%s", tops->name, A_END); });
   a_ok(a);
 }
 
@@ -2255,7 +2250,7 @@ static void a_destroypending(void)
       if (a->f & AF_FOREGROUND) {
        T( trace(T_ADMIN, "admin: foreground client quit: shutting down"); )
        a_warn("SERVER", "quit", "foreground-eof", A_END);
-       a_quit();
+       lp_end();
       }
 
       /* --- Abort any background jobs in progress --- */
@@ -2386,7 +2381,10 @@ static void a_line(char *p, size_t len, void *vp)
  *
  * Returns:    ---
  *
- * Use:                Creates a new admin connection.
+ * Use:                Creates a new admin connection.  It's safe to call this
+ *             before @a_init@ -- and, indeed, this makes sense if you also
+ *             call @a_switcherr@ to report initialization errors through
+ *             the administration machinery.
  */
 
 void a_create(int fd_in, int fd_out, unsigned f)
@@ -2464,39 +2462,33 @@ void a_preselect(void) { if (a_dead) a_destroypending(); }
 
 void a_daemon(void) { flags |= F_DAEMON; }
 
-/* --- @a_init@ --- *
+/* --- @a_listen@ --- *
  *
  * Arguments:  @const char *name@ = socket name to create
  *             @uid_t u@ = user to own the socket
  *             @gid_t g@ = group to own the socket
  *             @mode_t m@ = permissions to set on the socket
  *
- * Returns:    ---
+ * Returns:    Zero on success, @-1@ on failure.
  *
  * Use:                Creates the admin listening socket.
  */
 
-void a_init(const char *name, uid_t u, gid_t g, mode_t m)
+int a_listen(const char *name, uid_t u, gid_t g, mode_t m)
 {
   int fd;
   int n = 5;
   struct sockaddr_un sun;
-  struct sigaction sa;
   size_t sz;
   mode_t omask;
-#ifdef HAVE_LIBADNS
-  int err;
-#endif
-
-  /* --- Create services table --- */
-
-  sym_create(&a_svcs);
 
   /* --- Set up the socket address --- */
 
   sz = strlen(name) + 1;
-  if (sz > sizeof(sun.sun_path))
-    die(EXIT_FAILURE, "socket name `%s' too long", name);
+  if (sz > sizeof(sun.sun_path)) {
+    a_warn("ADMIN", "admin-socket", "%s", name, "name-too-long", A_END);
+    goto fail_0;
+  }
   BURN(sun);
   sun.sun_family = AF_UNIX;
   memcpy(sun.sun_path, name, sz);
@@ -2506,75 +2498,187 @@ void a_init(const char *name, uid_t u, gid_t g, mode_t m)
 
   omask = umask(0077);
 again:
-  if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0)
-    die(EXIT_FAILURE, "couldn't create socket: %s", strerror(errno));
+  if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0) {
+    a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
+          "create-failed", "?ERRNO", A_END);
+    goto fail_1;
+  }
   if (bind(fd, (struct sockaddr *)&sun, sz) < 0) {
     struct stat st;
     int e = errno;
     if (errno != EADDRINUSE) {
-      die(EXIT_FAILURE, "couldn't bind to address `%s': %s",
-         sun.sun_path, strerror(e));
+      a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
+            "bind-failed", "?ERRNO", A_END);
+      goto fail_2;
+    }
+    if (!n) {
+      a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
+            "too-many-retries", A_END);
+      goto fail_2;
     }
-    if (!n)
-      die(EXIT_FAILURE, "too many retries; giving up");
     n--;
     if (!connect(fd, (struct sockaddr *)&sun, sz)) {
-      die(EXIT_FAILURE, "server already listening on admin socket `%s'",
-         sun.sun_path);
+      a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
+            "already-in-use", A_END);
+      goto fail_2;
+    }
+    if (errno != ECONNREFUSED) {
+      a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
+            "bind-failed", "?ERR", e, A_END);
+      goto fail_2;
     }
-    if (errno != ECONNREFUSED)
-      die(EXIT_FAILURE, "couldn't bind to address: %s", strerror(e));
     if (stat(sun.sun_path, &st)) {
-      die(EXIT_FAILURE, "couldn't stat `%s': %s",
-         sun.sun_path, strerror(errno));
+      if (errno == ENOENT) { close(fd); goto again; }
+      a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
+            "stat-failed", "?ERRNO", A_END);
+      goto fail_2;
+    }
+    if (!S_ISSOCK(st.st_mode)) {
+      a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
+            "not-a-socket", A_END);
+      goto fail_2;
     }
-    if (!S_ISSOCK(st.st_mode))
-      die(EXIT_FAILURE, "object `%s' isn't a socket", sun.sun_path);
     T( trace(T_ADMIN, "admin: stale socket found; removing it"); )
     unlink(sun.sun_path);
     close(fd);
     goto again;
   }
   if (chown(sun.sun_path, u, g)) {
-    die(EXIT_FAILURE, "failed to set socket owner: %s",
-       strerror(errno));
+    a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
+          "chown-failed", "?ERRNO", A_END);
+    goto fail_3;
   }
   if (chmod(sun.sun_path, m)) {
-    die(EXIT_FAILURE, "failed to set socket permissions: %s",
-       strerror(errno));
+    a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
+          "chmod-failed", "?ERRNO", A_END);
+    goto fail_3;
   }
-  umask(omask);
   fdflags(fd, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
-  if (listen(fd, 5))
-    die(EXIT_FAILURE, "couldn't listen on socket: %s", strerror(errno));
+  if (listen(fd, 5)) {
+    a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
+          "listen-failed", "?ERRNO", A_END);
+    goto fail_3;
+  }
+  umask(omask);
 
   /* --- Listen to the socket --- */
 
   sel_initfile(&sel, &sock, fd, SEL_READ, a_accept, 0);
   sel_addfile(&sock);
   sockname = name;
+
+  return (0);
+
+  /* --- Clean up if things go sideways --- */
+
+fail_3:
+  unlink(sun.sun_path);
+fail_2:
+  close(fd);
+fail_1:
+  umask(omask);
+fail_0:
+  return (-1);
+}
+
+/* --- @a_unlisten@ --- *
+ *
+ * Arguments:  ---
+ *
+ * Returns:    ---
+ *
+ * Use:                Stops listening to the administration socket and removes it.
+ */
+
+void a_unlisten(void)
+{
+  if (!sockname) return;
+  sel_rmfile(&sock);
+  unlink(sockname);
+  close(sock.fd);
+}
+
+/* --- @a_switcherr@ --- *
+ *
+ * Arguments:  ---
+ *
+ * Returns:    ---
+ *
+ * Use:                Arrange to report warnings, trace messages, etc. to
+ *             administration clients rather than the standard-error stream.
+ *
+ *             Obviously this makes no sense unless there is at least one
+ *             client established.  Calling @a_listen@ won't help with this,
+ *             because the earliest a new client can connect is during the
+ *             first select-loop iteration, which is too late: some initial
+ *             client must have been added manually using @a_create@.
+ */
+
+void a_switcherr(void)
+{
+  T( trace_custom(a_trace, 0);
+     trace(T_ADMIN, "admin: enabled custom tracing"); )
+  flags |= F_INIT;
+}
+
+/* --- @a_signals@ --- *
+ *
+ * Arguments:  ---
+ *
+ * Returns:    ---
+ *
+ * Use:                Establishes handlers for the obvious signals.
+ */
+
+void a_signals(void)
+{
+  struct sigaction sa;
+
+  sig_add(&s_term, SIGTERM, a_sigdie, 0);
+  sig_add(&s_hup, SIGHUP, a_sighup, 0);
+  sigaction(SIGINT, 0, &sa);
+  if (sa.sa_handler != SIG_IGN)
+    sig_add(&s_int, SIGINT, a_sigdie, 0);
+}
+
+/* --- @a_init@ --- *
+ *
+ * Arguments:  ---
+ *
+ * Returns:    Zero on success, @-1@ on failure.
+ *
+ * Use:                Creates the admin listening socket.
+ */
+
+int a_init(void)
+{
+#ifdef HAVE_LIBADNS
+  int err;
+#endif
+
+  /* --- Prepare the background name resolver --- */
+
 #ifdef HAVE_LIBADNS
   if ((err = adns_init(&ads,
                       (adns_if_permit_ipv4 | adns_if_permit_ipv6 |
                        adns_if_noserverwarn | adns_if_nosigpipe |
                        adns_if_noautosys),
-                      0)) != 0)
-    die(EXIT_FAILURE, "failed to initialize ADNS: %s", strerror(errno));
+                      0)) != 0) {
+    a_warn("ADMIN", "adns-init-failed", "?ERRNO", A_END);
+    return (-1);
+  }
   sel_addhook(&sel, &hook, before_select, after_select, 0);
 #else
   bres_init(&sel);
 #endif
-  T( trace_custom(a_trace, 0);
-     trace(T_ADMIN, "admin: enabled custom tracing"); )
-  flags |= F_INIT;
 
-  /* --- Set up signal handlers --- */
+  /* --- Create services table --- */
 
-  sig_add(&s_term, SIGTERM, a_sigdie, 0);
-  sig_add(&s_hup, SIGHUP, a_sighup, 0);
-  sigaction(SIGINT, 0, &sa);
-  if (sa.sa_handler != SIG_IGN)
-    sig_add(&s_int, SIGINT, a_sigdie, 0);
+  sym_create(&a_svcs);
+
+  /* --- All done --- */
+
+  return (0);
 }
 
 /*----- That's all, folks -------------------------------------------------*/