1 /* server.c - LDAP and Keyserver access server
2 * Copyright (C) 2002 Klarälvdalens Datakonsult AB
3 * Copyright (C) 2003, 2004, 2005, 2007, 2008, 2009, 2011, 2015 g10 Code GmbH
4 * Copyright (C) 2014, 2015, 2016 Werner Koch
6 * This file is part of GnuPG.
8 * GnuPG is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
13 * GnuPG is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, see <https://www.gnu.org/licenses/>.
28 #include <sys/types.h>
39 # include "ldapserver.h"
42 #include "certcache.h"
46 # include "ldap-wrapper.h"
48 #include "ks-action.h"
49 #include "ks-engine.h" /* (ks_hkp_print_hosttable) */
51 # include "ldap-parse-uri.h"
53 #include "dns-stuff.h"
54 #include "mbox-util.h"
56 #include "server-help.h"
58 /* To avoid DoS attacks we limit the size of a certificate to
59 something reasonable. The DoS was actually only an issue back when
60 Dirmngr was a system service and not a user service. */
61 #define MAX_CERT_LENGTH (16*1024)
63 /* The same goes for OpenPGP keyblocks, but here we need to allow for
64 much longer blocks; a 200k keyblock is not too unusual for keys
65 with a lot of signatures (e.g. 0x5b0358a2). 9C31503C6D866396 even
66 has 770 KiB as of 2015-08-23. To avoid adding a runtime option we
67 now use 20MiB which should really be enough. Well, a key with
68 several pictures could be larger (the parser as a 18MiB limit for
69 attribute packets) but it won't be nice to the keyservers to send
70 them such large blobs. */
71 #define MAX_KEYBLOCK_LENGTH (20*1024*1024)
74 #define PARM_ERROR(t) assuan_set_error (ctx, \
75 gpg_error (GPG_ERR_ASS_PARAMETER), (t))
76 #define set_error(e,t) assuan_set_error (ctx, gpg_error (e), (t))
80 /* Control structure per connection. */
83 /* Data used to associate an Assuan context with local server data */
84 assuan_context_t assuan_ctx;
86 /* Per-session LDAP servers. */
87 ldap_server_t ldapservers;
89 /* Per-session list of keyservers. */
90 uri_item_t keyservers;
92 /* If this flag is set to true this dirmngr process will be
93 terminated after the end of this session. */
96 /* State variable private to is_tor_running. */
99 /* If the first both flags are set the assuan logging of data lines
100 * is suppressed. The count variable is used to show the number of
101 * non-logged bytes. */
102 size_t inhibit_data_logging_count;
103 unsigned int inhibit_data_logging : 1;
104 unsigned int inhibit_data_logging_now : 1;
108 /* Cookie definition for assuan data line output. */
109 static gpgrt_ssize_t data_line_cookie_write (void *cookie,
110 const void *buffer, size_t size);
111 static int data_line_cookie_close (void *cookie);
112 static es_cookie_io_functions_t data_line_cookie_functions =
115 data_line_cookie_write,
117 data_line_cookie_close
124 /* Accessor for the local ldapservers variable. */
126 get_ldapservers_from_ctrl (ctrl_t ctrl)
128 if (ctrl && ctrl->server_local)
129 return ctrl->server_local->ldapservers;
134 /* Release an uri_item_t list. */
136 release_uri_item_list (uri_item_t list)
140 uri_item_t tmp = list->next;
141 http_release_parsed_uri (list->parsed_uri);
147 /* Release all configured keyserver info from CTRL. */
149 release_ctrl_keyservers (ctrl_t ctrl)
151 if (! ctrl->server_local)
154 release_uri_item_list (ctrl->server_local->keyservers);
155 ctrl->server_local->keyservers = NULL;
160 /* Helper to print a message while leaving a command. */
162 leave_cmd (assuan_context_t ctx, gpg_error_t err)
166 const char *name = assuan_get_command_name (ctx);
169 if (gpg_err_source (err) == GPG_ERR_SOURCE_DEFAULT)
170 log_error ("command '%s' failed: %s\n", name,
173 log_error ("command '%s' failed: %s <%s>\n", name,
174 gpg_strerror (err), gpg_strsource (err));
180 /* This is a wrapper around assuan_send_data which makes debugging the
181 output in verbose mode easier. */
183 data_line_write (assuan_context_t ctx, const void *buffer_arg, size_t size)
185 ctrl_t ctrl = assuan_get_pointer (ctx);
186 const char *buffer = buffer_arg;
189 /* If we do not want logging, enable it it here. */
190 if (ctrl && ctrl->server_local && ctrl->server_local->inhibit_data_logging)
191 ctrl->server_local->inhibit_data_logging_now = 1;
193 if (opt.verbose && buffer && size)
195 /* Ease reading of output by sending a physical line at each LF. */
202 p = memchr (buffer, '\n', nbytes);
203 n = p ? (p - buffer) + 1 : nbytes;
204 err = assuan_send_data (ctx, buffer, n);
207 gpg_err_set_errno (EIO);
212 if (nbytes && (err=assuan_send_data (ctx, NULL, 0))) /* Flush line. */
214 gpg_err_set_errno (EIO);
222 err = assuan_send_data (ctx, buffer, size);
225 gpg_err_set_errno (EIO); /* For use by data_line_cookie_write. */
231 if (ctrl && ctrl->server_local && ctrl->server_local->inhibit_data_logging)
233 ctrl->server_local->inhibit_data_logging_now = 0;
234 ctrl->server_local->inhibit_data_logging_count += size;
241 /* A write handler used by es_fopencookie to write assuan data
244 data_line_cookie_write (void *cookie, const void *buffer, size_t size)
246 assuan_context_t ctx = cookie;
248 if (data_line_write (ctx, buffer, size))
250 return (gpgrt_ssize_t)size;
255 data_line_cookie_close (void *cookie)
257 assuan_context_t ctx = cookie;
261 ctrl_t ctrl = assuan_get_pointer (ctx);
263 if (ctrl && ctrl->server_local
264 && ctrl->server_local->inhibit_data_logging
265 && ctrl->server_local->inhibit_data_logging_count)
266 log_debug ("(%zu bytes sent via D lines not shown)\n",
267 ctrl->server_local->inhibit_data_logging_count);
269 if (assuan_send_data (ctx, NULL, 0))
271 gpg_err_set_errno (EIO);
279 /* Copy the % and + escaped string S into the buffer D and replace the
280 escape sequences. Note, that it is sufficient to allocate the
281 target string D as long as the source string S, i.e.: strlen(s)+1.
282 Note further that if S contains an escaped binary Nul the resulting
283 string D will contain the 0 as well as all other characters but it
284 will be impossible to know whether this is the original EOS or a
287 strcpy_escaped_plus (char *d, const unsigned char *s)
291 if (*s == '%' && s[1] && s[2])
306 /* This function returns true if a Tor server is running. The sattus
307 is cached for the current connection. */
309 is_tor_running (ctrl_t ctrl)
311 /* Check whether we can connect to the proxy. */
313 if (!ctrl || !ctrl->server_local)
314 return 0; /* Ooops. */
316 if (!ctrl->server_local->tor_state)
320 sock = assuan_sock_connect_byname (NULL, 0, 0, NULL, ASSUAN_SOCK_TOR);
321 if (sock == ASSUAN_INVALID_FD)
322 ctrl->server_local->tor_state = -1; /* Not running. */
325 assuan_sock_close (sock);
326 ctrl->server_local->tor_state = 1; /* Running. */
329 return (ctrl->server_local->tor_state > 0);
333 /* Return an error if the assuan context does not belong to the owner
334 of the process or to root. On error FAILTEXT is set as Assuan
337 check_owner_permission (assuan_context_t ctx, const char *failtext)
339 #ifdef HAVE_W32_SYSTEM
340 /* Under Windows the dirmngr is always run under the control of the
346 assuan_peercred_t cred;
348 ec = gpg_err_code (assuan_get_peercred (ctx, &cred));
349 if (!ec && cred->uid && cred->uid != getuid ())
352 return set_error (ec, failtext);
359 /* Common code for get_cert_local and get_issuer_cert_local. */
361 do_get_cert_local (ctrl_t ctrl, const char *name, const char *command)
363 unsigned char *value;
371 buf = xmalloc ( strlen (command) + 1 + strlen(name) + 1);
372 strcpy (stpcpy (stpcpy (buf, command), " "), name);
375 buf = xstrdup (command);
377 rc = assuan_inquire (ctrl->server_local->assuan_ctx, buf,
378 &value, &valuelen, MAX_CERT_LENGTH);
382 log_error (_("assuan_inquire(%s) failed: %s\n"),
383 command, gpg_strerror (rc));
393 rc = ksba_cert_new (&cert);
396 rc = ksba_cert_init_from_mem (cert, value, valuelen);
399 ksba_cert_release (cert);
409 /* Ask back to return a certificate for name, given as a regular
410 gpgsm certificate indentificates (e.g. fingerprint or one of the
411 other methods). Alternatively, NULL may be used for NAME to
412 return the current target certificate. Either return the certificate
413 in a KSBA object or NULL if it is not available.
416 get_cert_local (ctrl_t ctrl, const char *name)
418 if (!ctrl || !ctrl->server_local || !ctrl->server_local->assuan_ctx)
421 log_debug ("get_cert_local called w/o context\n");
424 return do_get_cert_local (ctrl, name, "SENDCERT");
428 /* Ask back to return the issuing certificate for name, given as a
429 regular gpgsm certificate indentificates (e.g. fingerprint or one
430 of the other methods). Alternatively, NULL may be used for NAME to
431 return thecurrent target certificate. Either return the certificate
432 in a KSBA object or NULL if it is not available.
436 get_issuing_cert_local (ctrl_t ctrl, const char *name)
438 if (!ctrl || !ctrl->server_local || !ctrl->server_local->assuan_ctx)
441 log_debug ("get_issuing_cert_local called w/o context\n");
444 return do_get_cert_local (ctrl, name, "SENDISSUERCERT");
447 /* Ask back to return a certificate with subject NAME and a
448 subjectKeyIdentifier of KEYID. */
450 get_cert_local_ski (ctrl_t ctrl, const char *name, ksba_sexp_t keyid)
452 unsigned char *value;
459 if (!ctrl || !ctrl->server_local || !ctrl->server_local->assuan_ctx)
462 log_debug ("get_cert_local_ski called w/o context\n");
467 log_debug ("get_cert_local_ski called with insufficient arguments\n");
471 hexkeyid = serial_hex (keyid);
474 log_debug ("serial_hex() failed\n");
478 buf = xtrymalloc (15 + strlen (hexkeyid) + 2 + strlen(name) + 1);
482 log_error ("can't allocate enough memory: %s\n", strerror (errno));
486 strcpy (stpcpy (stpcpy (stpcpy (buf, "SENDCERT_SKI "), hexkeyid)," /"),name);
489 rc = assuan_inquire (ctrl->server_local->assuan_ctx, buf,
490 &value, &valuelen, MAX_CERT_LENGTH);
494 log_error (_("assuan_inquire(%s) failed: %s\n"), "SENDCERT_SKI",
505 rc = ksba_cert_new (&cert);
508 rc = ksba_cert_init_from_mem (cert, value, valuelen);
511 ksba_cert_release (cert);
520 /* Ask the client via an inquiry to check the istrusted status of the
521 certificate specified by the hexified fingerprint HEXFPR. Returns
522 0 if the certificate is trusted by the client or an error code. */
524 get_istrusted_from_client (ctrl_t ctrl, const char *hexfpr)
526 unsigned char *value;
531 if (!ctrl || !ctrl->server_local || !ctrl->server_local->assuan_ctx
533 return gpg_error (GPG_ERR_INV_ARG);
535 snprintf (request, sizeof request, "ISTRUSTED %s", hexfpr);
536 rc = assuan_inquire (ctrl->server_local->assuan_ctx, request,
537 &value, &valuelen, 100);
540 log_error (_("assuan_inquire(%s) failed: %s\n"),
541 request, gpg_strerror (rc));
544 /* The expected data is: "1" or "1 cruft" (not a C-string). */
545 if (valuelen && *value == '1' && (valuelen == 1 || spacep (value+1)))
548 rc = gpg_error (GPG_ERR_NOT_TRUSTED);
556 /* Ask the client to return the certificate associated with the
557 current command. This is sometimes needed because the client usually
558 sends us just the cert ID, assuming that the request can be
559 satisfied from the cache, where the cert ID is used as key. */
561 inquire_cert_and_load_crl (assuan_context_t ctx)
563 ctrl_t ctrl = assuan_get_pointer (ctx);
565 unsigned char *value = NULL;
567 ksba_cert_t cert = NULL;
569 err = assuan_inquire( ctx, "SENDCERT", &value, &valuelen, 0);
574 /* FILE *fp = fopen ("foo.der", "r"); */
575 /* value = xmalloc (2000); */
576 /* valuelen = fread (value, 1, 2000, fp); */
580 if (!valuelen) /* No data returned; return a comprehensible error. */
581 return gpg_error (GPG_ERR_MISSING_CERT);
583 err = ksba_cert_new (&cert);
586 err = ksba_cert_init_from_mem (cert, value, valuelen);
589 xfree (value); value = NULL;
591 err = crl_cache_reload_crl (ctrl, cert);
594 ksba_cert_release (cert);
600 /* Handle OPTION commands. */
602 option_handler (assuan_context_t ctx, const char *key, const char *value)
604 ctrl_t ctrl = assuan_get_pointer (ctx);
607 if (!strcmp (key, "force-crl-refresh"))
609 int i = *value? atoi (value) : 0;
610 ctrl->force_crl_refresh = i;
612 else if (!strcmp (key, "audit-events"))
614 int i = *value? atoi (value) : 0;
615 ctrl->audit_events = i;
617 else if (!strcmp (key, "http-proxy"))
619 xfree (ctrl->http_proxy);
620 if (!*value || !strcmp (value, "none"))
621 ctrl->http_proxy = NULL;
622 else if (!(ctrl->http_proxy = xtrystrdup (value)))
623 err = gpg_error_from_syserror ();
625 else if (!strcmp (key, "honor-keyserver-url-used"))
627 /* Return an error if we are running in Tor mode. */
629 err = gpg_error (GPG_ERR_FORBIDDEN);
632 err = gpg_error (GPG_ERR_UNKNOWN_OPTION);
639 static const char hlp_dns_cert[] =
640 "DNS_CERT <subtype> <name>\n"
641 "DNS_CERT --pka <user_id>\n"
642 "DNS_CERT --dane <user_id>\n"
644 "Return the CERT record for <name>. <subtype> is one of\n"
645 " * Return the first record of any supported subtype\n"
646 " PGP Return the first record of subtype PGP (3)\n"
647 " IPGP Return the first record of subtype IPGP (6)\n"
648 "If the content of a certificate is available (PGP) it is returned\n"
649 "by data lines. Fingerprints and URLs are returned via status lines.\n"
650 "In --pka mode the fingerprint and if available an URL is returned.\n"
651 "In --dane mode the key is returned from RR type 61";
653 cmd_dns_cert (assuan_context_t ctx, char *line)
655 /* ctrl_t ctrl = assuan_get_pointer (ctx); */
657 int pka_mode, dane_mode;
659 char *namebuf = NULL;
660 char *encodedhash = NULL;
666 unsigned char *fpr = NULL;
670 pka_mode = has_option (line, "--pka");
671 dane_mode = has_option (line, "--dane");
672 line = skip_options (line);
674 if (pka_mode && dane_mode)
676 err = PARM_ERROR ("either --pka or --dane may be given");
680 if (pka_mode || dane_mode)
681 ; /* No need to parse here - we do this later. */
684 p = strchr (line, ' ');
687 err = PARM_ERROR ("missing arguments");
691 if (!strcmp (line, "*"))
692 certtype = DNS_CERTTYPE_ANY;
693 else if (!strcmp (line, "IPGP"))
694 certtype = DNS_CERTTYPE_IPGP;
695 else if (!strcmp (line, "PGP"))
696 certtype = DNS_CERTTYPE_PGP;
699 err = PARM_ERROR ("unknown subtype");
707 err = PARM_ERROR ("name missing");
712 if (pka_mode || dane_mode)
714 char *domain; /* Points to mbox. */
715 char hashbuf[32]; /* For SHA-1 and SHA-256. */
717 /* We lowercase ascii characters but the DANE I-D does not allow
718 this. FIXME: Check after the release of the RFC whether to
720 mbox = mailbox_from_userid (line);
721 if (!mbox || !(domain = strchr (mbox, '@')))
723 err = set_error (GPG_ERR_INV_USER_ID, "no mailbox in user id");
730 gcry_md_hash_buffer (GCRY_MD_SHA1, hashbuf, mbox, strlen (mbox));
731 encodedhash = zb32_encode (hashbuf, 8*20);
734 err = gpg_error_from_syserror ();
737 namebuf = strconcat (encodedhash, "._pka.", domain, NULL);
740 err = gpg_error_from_syserror ();
744 certtype = DNS_CERTTYPE_IPGP;
748 /* Note: The hash is truncated to 28 bytes and we lowercase
749 the result only for aesthetic reasons. */
750 gcry_md_hash_buffer (GCRY_MD_SHA256, hashbuf, mbox, strlen (mbox));
751 encodedhash = bin2hex (hashbuf, 28, NULL);
754 err = gpg_error_from_syserror ();
757 ascii_strlwr (encodedhash);
758 namebuf = strconcat (encodedhash, "._openpgpkey.", domain, NULL);
761 err = gpg_error_from_syserror ();
765 certtype = DNS_CERTTYPE_RR61;
771 err = get_dns_cert (name, certtype, &key, &keylen, &fpr, &fprlen, &url);
777 err = data_line_write (ctx, key, keylen);
786 tmpstr = bin2hex (fpr, fprlen, NULL);
788 err = gpg_error_from_syserror ();
791 err = assuan_write_status (ctx, "FPR", tmpstr);
800 err = assuan_write_status (ctx, "URL", url);
813 return leave_cmd (ctx, err);
818 static const char hlp_wkd_get[] =
819 "WKD_GET [--submission-address|--policy-flags] <user_id>\n"
821 "Return the key or other info for <user_id>\n"
822 "from the Web Key Directory.";
824 cmd_wkd_get (assuan_context_t ctx, char *line)
826 ctrl_t ctrl = assuan_get_pointer (ctx);
829 char *domain; /* Points to mbox. */
832 char *encodedhash = NULL;
833 int opt_submission_addr;
834 int opt_policy_flags;
837 opt_submission_addr = has_option (line, "--submission-address");
838 opt_policy_flags = has_option (line, "--policy-flags");
839 line = skip_options (line);
841 mbox = mailbox_from_userid (line);
842 if (!mbox || !(domain = strchr (mbox, '@')))
844 err = set_error (GPG_ERR_INV_USER_ID, "no mailbox in user id");
849 gcry_md_hash_buffer (GCRY_MD_SHA1, sha1buf, mbox, strlen (mbox));
850 encodedhash = zb32_encode (sha1buf, 8*20);
853 err = gpg_error_from_syserror ();
857 if (opt_submission_addr)
859 uri = strconcat ("https://",
861 "/.well-known/openpgpkey/submission-address",
864 else if (opt_policy_flags)
866 uri = strconcat ("https://",
868 "/.well-known/openpgpkey/policy",
873 uri = strconcat ("https://",
875 "/.well-known/openpgpkey/hu/",
882 err = gpg_error_from_syserror ();
886 /* Setup an output stream and perform the get. */
890 outfp = es_fopencookie (ctx, "w", data_line_cookie_functions);
892 err = set_error (GPG_ERR_ASS_GENERAL,
893 "error setting up a data stream");
897 ctrl->server_local->inhibit_data_logging = 1;
898 ctrl->server_local->inhibit_data_logging_now = 0;
899 ctrl->server_local->inhibit_data_logging_count = 0;
900 err = ks_action_fetch (ctrl, uri, outfp);
902 ctrl->server_local->inhibit_data_logging = 0;
910 return leave_cmd (ctx, err);
915 static const char hlp_ldapserver[] =
916 "LDAPSERVER <data>\n"
918 "Add a new LDAP server to the list of configured LDAP servers.\n"
919 "DATA is in the same format as expected in the configure file.";
921 cmd_ldapserver (assuan_context_t ctx, char *line)
924 ctrl_t ctrl = assuan_get_pointer (ctx);
925 ldap_server_t server;
926 ldap_server_t *last_next_p;
928 while (spacep (line))
931 return leave_cmd (ctx, PARM_ERROR (_("ldapserver missing")));
933 server = ldapserver_parse_one (line, "", 0);
935 return leave_cmd (ctx, gpg_error (GPG_ERR_INV_ARG));
937 last_next_p = &ctrl->server_local->ldapservers;
939 last_next_p = &(*last_next_p)->next;
940 *last_next_p = server;
941 return leave_cmd (ctx, 0);
944 return leave_cmd (ctx, gpg_error (GPG_ERR_NOT_IMPLEMENTED));
949 static const char hlp_isvalid[] =
950 "ISVALID [--only-ocsp] [--force-default-responder]"
951 " <certificate_id>|<certificate_fpr>\n"
953 "This command checks whether the certificate identified by the\n"
954 "certificate_id is valid. This is done by consulting CRLs or\n"
955 "whatever has been configured. Note, that the returned error codes\n"
956 "are from gpg-error.h. The command may callback using the inquire\n"
957 "function. See the manual for details.\n"
959 "The CERTIFICATE_ID is a hex encoded string consisting of two parts,\n"
960 "delimited by a single dot. The first part is the SHA-1 hash of the\n"
961 "issuer name and the second part the serial number.\n"
963 "Alternatively the certificate's fingerprint may be given in which\n"
964 "case an OCSP request is done before consulting the CRL.\n"
966 "If the option --only-ocsp is given, no fallback to a CRL check will\n"
969 "If the option --force-default-responder is given, only the default\n"
970 "OCSP responder will be used and any other methods of obtaining an\n"
971 "OCSP responder URL won't be used.";
973 cmd_isvalid (assuan_context_t ctx, char *line)
975 ctrl_t ctrl = assuan_get_pointer (ctx);
976 char *issuerhash, *serialno;
981 int force_default_responder;
983 only_ocsp = has_option (line, "--only-ocsp");
984 force_default_responder = has_option (line, "--force-default-responder");
985 line = skip_options (line);
987 issuerhash = xstrdup (line); /* We need to work on a copy of the
988 line because that same Assuan
989 context may be used for an inquiry.
990 That is because Assuan reuses its
994 serialno = strchr (issuerhash, '.');
999 char *endp = strchr (issuerhash, ' ');
1002 if (strlen (issuerhash) != 40)
1005 return leave_cmd (ctx, PARM_ERROR (_("serialno missing in cert ID")));
1014 /* Note, that we ignore the given issuer hash and instead rely
1015 on the current certificate semantics used with this
1017 if (!opt.allow_ocsp)
1018 err = gpg_error (GPG_ERR_NOT_SUPPORTED);
1020 err = ocsp_isvalid (ctrl, NULL, NULL, force_default_responder);
1021 /* Fixme: If we got no ocsp response and --only-ocsp is not used
1022 we should fall back to CRL mode. Thus we need to clear
1023 OCSP_MODE, get the issuerhash and the serialno from the
1024 current certificate and jump to again. */
1027 err = gpg_error (GPG_ERR_NO_CRL_KNOWN);
1030 switch (crl_cache_isvalid (ctrl,
1031 issuerhash, serialno,
1032 ctrl->force_crl_refresh))
1034 case CRL_CACHE_VALID:
1037 case CRL_CACHE_INVALID:
1038 err = gpg_error (GPG_ERR_CERT_REVOKED);
1040 case CRL_CACHE_DONTKNOW:
1042 err = gpg_error (GPG_ERR_NO_CRL_KNOWN);
1043 else if (!(err = inquire_cert_and_load_crl (ctx)))
1049 case CRL_CACHE_CANTUSE:
1050 err = gpg_error (GPG_ERR_NO_CRL_KNOWN);
1053 log_fatal ("crl_cache_isvalid returned invalid code\n");
1058 return leave_cmd (ctx, err);
1062 /* If the line contains a SHA-1 fingerprint as the first argument,
1063 return the FPR vuffer on success. The function checks that the
1064 fingerprint consists of valid characters and prints and error
1065 message if it does not and returns NULL. Fingerprints are
1066 considered optional and thus no explicit error is returned. NULL is
1067 also returned if there is no fingerprint at all available.
1068 FPR must be a caller provided buffer of at least 20 bytes.
1070 Note that colons within the fingerprint are allowed to separate 2
1071 hex digits; this allows for easier cutting and pasting using the
1072 usual fingerprint rendering.
1074 static unsigned char *
1075 get_fingerprint_from_line (const char *line, unsigned char *fpr)
1080 for (s=line, i=0; *s && *s != ' '; s++ )
1082 if ( hexdigitp (s) && hexdigitp (s+1) )
1085 return NULL; /* Fingerprint too long. */
1086 fpr[i++] = xtoi_2 (s);
1089 else if ( *s != ':' )
1090 return NULL; /* Invalid. */
1093 return NULL; /* Fingerprint to short. */
1099 static const char hlp_checkcrl[] =
1100 "CHECKCRL [<fingerprint>]\n"
1102 "Check whether the certificate with FINGERPRINT (SHA-1 hash of the\n"
1103 "entire X.509 certificate blob) is valid or not by consulting the\n"
1104 "CRL responsible for this certificate. If the fingerprint has not\n"
1105 "been given or the certificate is not known, the function \n"
1106 "inquires the certificate using an\n"
1108 " INQUIRE TARGETCERT\n"
1110 "and the caller is expected to return the certificate for the\n"
1111 "request (which should match FINGERPRINT) as a binary blob.\n"
1112 "Processing then takes place without further interaction; in\n"
1113 "particular dirmngr tries to locate other required certificate by\n"
1114 "its own mechanism which includes a local certificate store as well\n"
1115 "as a list of trusted root certificates.\n"
1117 "The return value is the usual gpg-error code or 0 for ducesss;\n"
1118 "i.e. the certificate validity has been confirmed by a valid CRL.";
1120 cmd_checkcrl (assuan_context_t ctx, char *line)
1122 ctrl_t ctrl = assuan_get_pointer (ctx);
1124 unsigned char fprbuffer[20], *fpr;
1127 fpr = get_fingerprint_from_line (line, fprbuffer);
1128 cert = fpr? get_cert_byfpr (fpr) : NULL;
1132 /* We do not have this certificate yet or the fingerprint has
1133 not been given. Inquire it from the client. */
1134 unsigned char *value = NULL;
1137 err = assuan_inquire (ctrl->server_local->assuan_ctx, "TARGETCERT",
1138 &value, &valuelen, MAX_CERT_LENGTH);
1141 log_error (_("assuan_inquire failed: %s\n"), gpg_strerror (err));
1145 if (!valuelen) /* No data returned; return a comprehensible error. */
1146 err = gpg_error (GPG_ERR_MISSING_CERT);
1149 err = ksba_cert_new (&cert);
1151 err = ksba_cert_init_from_mem (cert, value, valuelen);
1160 err = crl_cache_cert_isvalid (ctrl, cert, ctrl->force_crl_refresh);
1161 if (gpg_err_code (err) == GPG_ERR_NO_CRL_KNOWN)
1163 err = crl_cache_reload_crl (ctrl, cert);
1165 err = crl_cache_cert_isvalid (ctrl, cert, 0);
1169 ksba_cert_release (cert);
1170 return leave_cmd (ctx, err);
1174 static const char hlp_checkocsp[] =
1175 "CHECKOCSP [--force-default-responder] [<fingerprint>]\n"
1177 "Check whether the certificate with FINGERPRINT (SHA-1 hash of the\n"
1178 "entire X.509 certificate blob) is valid or not by asking an OCSP\n"
1179 "responder responsible for this certificate. The optional\n"
1180 "fingerprint may be used for a quick check in case an OCSP check has\n"
1181 "been done for this certificate recently (we always cache OCSP\n"
1182 "responses for a couple of minutes). If the fingerprint has not been\n"
1183 "given or there is no cached result, the function inquires the\n"
1184 "certificate using an\n"
1186 " INQUIRE TARGETCERT\n"
1188 "and the caller is expected to return the certificate for the\n"
1189 "request (which should match FINGERPRINT) as a binary blob.\n"
1190 "Processing then takes place without further interaction; in\n"
1191 "particular dirmngr tries to locate other required certificates by\n"
1192 "its own mechanism which includes a local certificate store as well\n"
1193 "as a list of trusted root certificates.\n"
1195 "If the option --force-default-responder is given, only the default\n"
1196 "OCSP responder will be used and any other methods of obtaining an\n"
1197 "OCSP responder URL won't be used.\n"
1199 "The return value is the usual gpg-error code or 0 for ducesss;\n"
1200 "i.e. the certificate validity has been confirmed by a valid CRL.";
1202 cmd_checkocsp (assuan_context_t ctx, char *line)
1204 ctrl_t ctrl = assuan_get_pointer (ctx);
1206 unsigned char fprbuffer[20], *fpr;
1208 int force_default_responder;
1210 force_default_responder = has_option (line, "--force-default-responder");
1211 line = skip_options (line);
1213 fpr = get_fingerprint_from_line (line, fprbuffer);
1214 cert = fpr? get_cert_byfpr (fpr) : NULL;
1218 /* We do not have this certificate yet or the fingerprint has
1219 not been given. Inquire it from the client. */
1220 unsigned char *value = NULL;
1223 err = assuan_inquire (ctrl->server_local->assuan_ctx, "TARGETCERT",
1224 &value, &valuelen, MAX_CERT_LENGTH);
1227 log_error (_("assuan_inquire failed: %s\n"), gpg_strerror (err));
1231 if (!valuelen) /* No data returned; return a comprehensible error. */
1232 err = gpg_error (GPG_ERR_MISSING_CERT);
1235 err = ksba_cert_new (&cert);
1237 err = ksba_cert_init_from_mem (cert, value, valuelen);
1246 if (!opt.allow_ocsp)
1247 err = gpg_error (GPG_ERR_NOT_SUPPORTED);
1249 err = ocsp_isvalid (ctrl, cert, NULL, force_default_responder);
1252 ksba_cert_release (cert);
1253 return leave_cmd (ctx, err);
1259 lookup_cert_by_url (assuan_context_t ctx, const char *url)
1261 ctrl_t ctrl = assuan_get_pointer (ctx);
1262 gpg_error_t err = 0;
1263 unsigned char *value = NULL;
1266 /* Fetch single certificate given it's URL. */
1267 err = fetch_cert_by_url (ctrl, url, &value, &valuelen);
1270 log_error (_("fetch_cert_by_url failed: %s\n"), gpg_strerror (err));
1274 /* Send the data, flush the buffer and then send an END. */
1275 err = assuan_send_data (ctx, value, valuelen);
1277 err = assuan_send_data (ctx, NULL, 0);
1279 err = assuan_write_line (ctx, "END");
1282 log_error (_("error sending data: %s\n"), gpg_strerror (err));
1292 /* Send the certificate, flush the buffer and then send an END. */
1294 return_one_cert (void *opaque, ksba_cert_t cert)
1296 assuan_context_t ctx = opaque;
1298 const unsigned char *der;
1301 der = ksba_cert_get_image (cert, &derlen);
1303 err = gpg_error (GPG_ERR_INV_CERT_OBJ);
1306 err = assuan_send_data (ctx, der, derlen);
1308 err = assuan_send_data (ctx, NULL, 0);
1310 err = assuan_write_line (ctx, "END");
1313 log_error (_("error sending data: %s\n"), gpg_strerror (err));
1318 /* Lookup certificates from the internal cache or using the ldap
1321 lookup_cert_by_pattern (assuan_context_t ctx, char *line,
1322 int single, int cache_only)
1324 gpg_error_t err = 0;
1326 strlist_t sl, list = NULL;
1327 int truncated = 0, truncation_forced = 0;
1329 int local_count = 0;
1331 ctrl_t ctrl = assuan_get_pointer (ctx);
1332 unsigned char *value = NULL;
1334 struct ldapserver_iter ldapserver_iter;
1335 cert_fetch_context_t fetch_context;
1337 int any_no_data = 0;
1339 /* Break the line down into an STRLIST */
1340 for (p=line; *p; line = p)
1342 while (*p && *p != ' ')
1349 sl = xtrymalloc (sizeof *sl + strlen (line));
1352 err = gpg_error_from_errno (errno);
1355 memset (sl, 0, sizeof *sl);
1356 strcpy_escaped_plus (sl->d, line);
1362 /* First look through the internal cache. The certifcates returned
1363 here are not counted towards the truncation limit. */
1364 if (single && !cache_only)
1365 ; /* Do not read from the local cache in this case. */
1368 for (sl=list; sl; sl = sl->next)
1370 err = get_certs_bypattern (sl->d, return_one_cert, ctx);
1376 if (gpg_err_code (err) == GPG_ERR_NO_DATA)
1382 else if (gpg_err_code (err) == GPG_ERR_INV_NAME && !cache_only)
1384 /* No real fault because the internal pattern lookup
1385 can't yet cope with all types of pattern. */
1393 /* Loop over all configured servers unless we want only the
1394 certificates from the cache. */
1396 for (ldapserver_iter_begin (&ldapserver_iter, ctrl);
1397 !cache_only && !ldapserver_iter_end_p (&ldapserver_iter)
1398 && ldapserver_iter.server->host && !truncation_forced;
1399 ldapserver_iter_next (&ldapserver_iter))
1401 ldap_server_t ldapserver = ldapserver_iter.server;
1404 log_debug ("cmd_lookup: trying %s:%d base=%s\n",
1405 ldapserver->host, ldapserver->port,
1406 ldapserver->base?ldapserver->base : "[default]");
1408 /* Fetch certificates matching pattern */
1409 err = start_cert_fetch (ctrl, &fetch_context, list, ldapserver);
1410 if ( gpg_err_code (err) == GPG_ERR_NO_DATA )
1413 log_debug ("cmd_lookup: no data\n");
1420 log_error (_("start_cert_fetch failed: %s\n"), gpg_strerror (err));
1424 /* Fetch the certificates for this query. */
1425 while (!truncation_forced)
1427 xfree (value); value = NULL;
1428 err = fetch_next_cert (fetch_context, &value, &valuelen);
1429 if (gpg_err_code (err) == GPG_ERR_NO_DATA )
1435 if (gpg_err_code (err) == GPG_ERR_TRUNCATED)
1441 if (gpg_err_code (err) == GPG_ERR_EOF)
1448 err = gpg_error (GPG_ERR_BUG);
1453 log_error (_("fetch_next_cert failed: %s\n"),
1454 gpg_strerror (err));
1455 end_cert_fetch (fetch_context);
1460 log_debug ("cmd_lookup: returning one cert%s\n",
1461 truncated? " (truncated)":"");
1463 /* Send the data, flush the buffer and then send an END line
1464 as a certificate delimiter. */
1465 err = assuan_send_data (ctx, value, valuelen);
1467 err = assuan_send_data (ctx, NULL, 0);
1469 err = assuan_write_line (ctx, "END");
1472 log_error (_("error sending data: %s\n"), gpg_strerror (err));
1473 end_cert_fetch (fetch_context);
1477 if (++count >= opt.max_replies )
1479 truncation_forced = 1;
1480 log_info (_("max_replies %d exceeded\n"), opt.max_replies );
1486 end_cert_fetch (fetch_context);
1491 if (truncated || truncation_forced)
1495 sprintf (str, "%d", count);
1496 assuan_write_status (ctx, "TRUNCATED", str);
1499 if (!err && !count && !local_count && any_no_data)
1500 err = gpg_error (GPG_ERR_NO_DATA);
1503 free_strlist (list);
1508 static const char hlp_lookup[] =
1509 "LOOKUP [--url] [--single] [--cache-only] <pattern>\n"
1511 "Lookup certificates matching PATTERN. With --url the pattern is\n"
1512 "expected to be one URL.\n"
1514 "If --url is not given: To allow for multiple patterns (which are ORed)\n"
1515 "quoting is required: Spaces are translated to \"+\" or \"%20\";\n"
1516 "obviously this requires that the usual escape quoting rules are applied.\n"
1518 "If --url is given no special escaping is required because URLs are\n"
1519 "already escaped this way.\n"
1521 "If --single is given the first and only the first match will be\n"
1522 "returned. If --cache-only is _not_ given, no local query will be\n"
1525 "If --cache-only is given no external lookup is done so that only\n"
1526 "certificates from the cache may get returned.";
1528 cmd_lookup (assuan_context_t ctx, char *line)
1531 int lookup_url, single, cache_only;
1533 lookup_url = has_leading_option (line, "--url");
1534 single = has_leading_option (line, "--single");
1535 cache_only = has_leading_option (line, "--cache-only");
1536 line = skip_options (line);
1538 if (lookup_url && cache_only)
1539 err = gpg_error (GPG_ERR_NOT_FOUND);
1540 else if (lookup_url && single)
1541 err = gpg_error (GPG_ERR_NOT_IMPLEMENTED);
1542 else if (lookup_url)
1543 err = lookup_cert_by_url (ctx, line);
1545 err = lookup_cert_by_pattern (ctx, line, single, cache_only);
1547 return leave_cmd (ctx, err);
1551 static const char hlp_loadcrl[] =
1552 "LOADCRL [--url] <filename|url>\n"
1554 "Load the CRL in the file with name FILENAME into our cache. Note\n"
1555 "that FILENAME should be given with an absolute path because\n"
1556 "Dirmngrs cwd is not known. With --url the CRL is directly loaded\n"
1557 "from the given URL.\n"
1559 "This command is usually used by gpgsm using the invocation \"gpgsm\n"
1560 "--call-dirmngr loadcrl <filename>\". A direct invocation of Dirmngr\n"
1561 "is not useful because gpgsm might need to callback gpgsm to ask for\n"
1562 "the CA's certificate.";
1564 cmd_loadcrl (assuan_context_t ctx, char *line)
1566 ctrl_t ctrl = assuan_get_pointer (ctx);
1567 gpg_error_t err = 0;
1568 int use_url = has_leading_option (line, "--url");
1570 line = skip_options (line);
1574 ksba_reader_t reader;
1576 err = crl_fetch (ctrl, line, &reader);
1578 log_error (_("fetching CRL from '%s' failed: %s\n"),
1579 line, gpg_strerror (err));
1582 err = crl_cache_insert (ctrl, line, reader);
1584 log_error (_("processing CRL from '%s' failed: %s\n"),
1585 line, gpg_strerror (err));
1586 crl_close_reader (reader);
1593 buf = xtrymalloc (strlen (line)+1);
1595 err = gpg_error_from_syserror ();
1598 strcpy_escaped_plus (buf, line);
1599 err = crl_cache_load (ctrl, buf);
1604 return leave_cmd (ctx, err);
1608 static const char hlp_listcrls[] =
1611 "List the content of all CRLs in a readable format. This command is\n"
1612 "usually used by gpgsm using the invocation \"gpgsm --call-dirmngr\n"
1613 "listcrls\". It may also be used directly using \"dirmngr\n"
1616 cmd_listcrls (assuan_context_t ctx, char *line)
1623 fp = es_fopencookie (ctx, "w", data_line_cookie_functions);
1625 err = set_error (GPG_ERR_ASS_GENERAL, "error setting up a data stream");
1628 err = crl_cache_list (fp);
1631 return leave_cmd (ctx, err);
1635 static const char hlp_cachecert[] =
1638 "Put a certificate into the internal cache. This command might be\n"
1639 "useful if a client knows in advance certificates required for a\n"
1640 "test and wants to make sure they get added to the internal cache.\n"
1641 "It is also helpful for debugging. To get the actual certificate,\n"
1642 "this command immediately inquires it using\n"
1644 " INQUIRE TARGETCERT\n"
1646 "and the caller is expected to return the certificate for the\n"
1647 "request as a binary blob.";
1649 cmd_cachecert (assuan_context_t ctx, char *line)
1651 ctrl_t ctrl = assuan_get_pointer (ctx);
1653 ksba_cert_t cert = NULL;
1654 unsigned char *value = NULL;
1659 err = assuan_inquire (ctrl->server_local->assuan_ctx, "TARGETCERT",
1660 &value, &valuelen, MAX_CERT_LENGTH);
1663 log_error (_("assuan_inquire failed: %s\n"), gpg_strerror (err));
1667 if (!valuelen) /* No data returned; return a comprehensible error. */
1668 err = gpg_error (GPG_ERR_MISSING_CERT);
1671 err = ksba_cert_new (&cert);
1673 err = ksba_cert_init_from_mem (cert, value, valuelen);
1679 err = cache_cert (cert);
1682 ksba_cert_release (cert);
1683 return leave_cmd (ctx, err);
1687 static const char hlp_validate[] =
1690 "Validate a certificate using the certificate validation function\n"
1691 "used internally by dirmngr. This command is only useful for\n"
1692 "debugging. To get the actual certificate, this command immediately\n"
1693 "inquires it using\n"
1695 " INQUIRE TARGETCERT\n"
1697 "and the caller is expected to return the certificate for the\n"
1698 "request as a binary blob.";
1700 cmd_validate (assuan_context_t ctx, char *line)
1702 ctrl_t ctrl = assuan_get_pointer (ctx);
1704 ksba_cert_t cert = NULL;
1705 unsigned char *value = NULL;
1710 err = assuan_inquire (ctrl->server_local->assuan_ctx, "TARGETCERT",
1711 &value, &valuelen, MAX_CERT_LENGTH);
1714 log_error (_("assuan_inquire failed: %s\n"), gpg_strerror (err));
1718 if (!valuelen) /* No data returned; return a comprehensible error. */
1719 err = gpg_error (GPG_ERR_MISSING_CERT);
1722 err = ksba_cert_new (&cert);
1724 err = ksba_cert_init_from_mem (cert, value, valuelen);
1730 /* If we have this certificate already in our cache, use the cached
1731 version for validation because this will take care of any cached
1734 unsigned char fpr[20];
1735 ksba_cert_t tmpcert;
1737 cert_compute_fpr (cert, fpr);
1738 tmpcert = get_cert_byfpr (fpr);
1741 ksba_cert_release (cert);
1746 err = validate_cert_chain (ctrl, cert, NULL, VALIDATE_MODE_CERT, NULL);
1749 ksba_cert_release (cert);
1750 return leave_cmd (ctx, err);
1755 /* Parse an keyserver URI and store it in a new uri item which is
1756 returned at R_ITEM. On error return an error code. */
1758 make_keyserver_item (const char *uri, uri_item_t *r_item)
1764 item = xtrymalloc (sizeof *item + strlen (uri));
1766 return gpg_error_from_syserror ();
1769 item->parsed_uri = NULL;
1770 strcpy (item->uri, uri);
1773 if (ldap_uri_p (item->uri))
1774 err = ldap_parse_uri (&item->parsed_uri, uri);
1778 err = http_parse_uri (&item->parsed_uri, uri, 1);
1789 /* If no keyserver is stored in CTRL but a global keyserver has been
1790 set, put that global keyserver into CTRL. We need use this
1791 function to help migrate from the old gpg based keyserver
1792 configuration to the new dirmngr based configuration. */
1794 ensure_keyserver (ctrl_t ctrl)
1798 uri_item_t onion_items = NULL;
1799 uri_item_t plain_items = NULL;
1803 if (ctrl->server_local->keyservers)
1804 return 0; /* Already set for this session. */
1807 /* No global option set. Fall back to default: */
1808 return make_keyserver_item (DIRMNGR_DEFAULT_KEYSERVER,
1809 &ctrl->server_local->keyservers);
1812 for (sl = opt.keyserver; sl; sl = sl->next)
1814 err = make_keyserver_item (sl->d, &item);
1817 if (item->parsed_uri->onion)
1819 item->next = onion_items;
1824 item->next = plain_items;
1829 /* Decide which to use. Note that the sesssion has no keyservers
1831 if (onion_items && !onion_items->next && plain_items && !plain_items->next)
1833 /* If there is just one onion and one plain keyserver given, we take
1834 only one depending on whether Tor is running or not. */
1835 if (is_tor_running (ctrl))
1837 ctrl->server_local->keyservers = onion_items;
1842 ctrl->server_local->keyservers = plain_items;
1846 else if (!is_tor_running (ctrl))
1848 /* Tor is not running. It does not make sense to add Onion
1850 ctrl->server_local->keyservers = plain_items;
1855 /* In all other cases add all keyservers. */
1856 ctrl->server_local->keyservers = onion_items;
1858 for (ui = ctrl->server_local->keyservers; ui && ui->next; ui = ui->next)
1861 ui->next = plain_items;
1863 ctrl->server_local->keyservers = plain_items;
1868 release_uri_item_list (onion_items);
1869 release_uri_item_list (plain_items);
1875 static const char hlp_keyserver[] =
1876 "KEYSERVER [<options>] [<uri>|<host>]\n"
1879 " --clear Remove all configured keyservers\n"
1880 " --resolve Resolve HKP host names and rotate\n"
1881 " --hosttable Print table of known hosts and pools\n"
1882 " --dead Mark <host> as dead\n"
1883 " --alive Mark <host> as alive\n"
1885 "If called without arguments list all configured keyserver URLs.\n"
1886 "If called with an URI add this as keyserver. Note that keyservers\n"
1887 "are configured on a per-session base. A default keyserver may already be\n"
1888 "present, thus the \"--clear\" option must be used to get full control.\n"
1889 "If \"--clear\" and an URI are used together the clear command is\n"
1890 "obviously executed first. A RESET command does not change the list\n"
1891 "of configured keyservers.";
1893 cmd_keyserver (assuan_context_t ctx, char *line)
1895 ctrl_t ctrl = assuan_get_pointer (ctx);
1896 gpg_error_t err = 0;
1897 int clear_flag, add_flag, help_flag, host_flag, resolve_flag;
1898 int dead_flag, alive_flag;
1899 uri_item_t item = NULL; /* gcc 4.4.5 is not able to detect that it
1900 is always initialized. */
1902 clear_flag = has_option (line, "--clear");
1903 help_flag = has_option (line, "--help");
1904 resolve_flag = has_option (line, "--resolve");
1905 host_flag = has_option (line, "--hosttable");
1906 dead_flag = has_option (line, "--dead");
1907 alive_flag = has_option (line, "--alive");
1908 line = skip_options (line);
1913 err = ks_action_help (ctrl, line);
1919 err = ensure_keyserver (ctrl);
1921 err = ks_action_resolve (ctrl, ctrl->server_local->keyservers);
1926 if (alive_flag && dead_flag)
1928 err = set_error (GPG_ERR_ASS_PARAMETER, "no support for zombies");
1933 err = check_owner_permission (ctx, "no permission to use --dead");
1937 if (alive_flag || dead_flag)
1941 err = set_error (GPG_ERR_ASS_PARAMETER, "name of host missing");
1945 err = ks_hkp_mark_host (ctrl, line, alive_flag);
1952 err = ks_hkp_print_hosttable (ctrl);
1956 if (resolve_flag || host_flag || alive_flag || dead_flag)
1961 err = make_keyserver_item (line, &item);
1966 release_ctrl_keyservers (ctrl);
1969 item->next = ctrl->server_local->keyservers;
1970 ctrl->server_local->keyservers = item;
1973 if (!add_flag && !clear_flag && !help_flag)
1975 /* List configured keyservers. However, we first add a global
1979 err = ensure_keyserver (ctrl);
1982 assuan_set_error (ctx, err,
1983 "Bad keyserver configuration in dirmngr.conf");
1987 for (u=ctrl->server_local->keyservers; u; u = u->next)
1988 dirmngr_status (ctrl, "KEYSERVER", u->uri, NULL);
1993 return leave_cmd (ctx, err);
1998 static const char hlp_ks_search[] =
1999 "KS_SEARCH {<pattern>}\n"
2001 "Search the configured OpenPGP keyservers (see command KEYSERVER)\n"
2002 "for keys matching PATTERN";
2004 cmd_ks_search (assuan_context_t ctx, char *line)
2006 ctrl_t ctrl = assuan_get_pointer (ctx);
2012 /* No options for now. */
2013 line = skip_options (line);
2015 /* Break the line down into an strlist. Each pattern is
2016 percent-plus escaped. */
2018 for (p=line; *p; line = p)
2020 while (*p && *p != ' ')
2026 sl = xtrymalloc (sizeof *sl + strlen (line));
2029 err = gpg_error_from_syserror ();
2033 strcpy_escaped_plus (sl->d, line);
2039 err = ensure_keyserver (ctrl);
2043 /* Setup an output stream and perform the search. */
2044 outfp = es_fopencookie (ctx, "w", data_line_cookie_functions);
2046 err = set_error (GPG_ERR_ASS_GENERAL, "error setting up a data stream");
2049 err = ks_action_search (ctrl, ctrl->server_local->keyservers,
2055 free_strlist (list);
2056 return leave_cmd (ctx, err);
2061 static const char hlp_ks_get[] =
2062 "KS_GET {<pattern>}\n"
2064 "Get the keys matching PATTERN from the configured OpenPGP keyservers\n"
2065 "(see command KEYSERVER). Each pattern should be a keyid, a fingerprint,\n"
2066 "or an exact name indicated by the '=' prefix.";
2068 cmd_ks_get (assuan_context_t ctx, char *line)
2070 ctrl_t ctrl = assuan_get_pointer (ctx);
2076 /* No options for now. */
2077 line = skip_options (line);
2079 /* Break the line into a strlist. Each pattern is by
2080 definition percent-plus escaped. However we only support keyids
2081 and fingerprints and thus the client has no need to apply the
2084 for (p=line; *p; line = p)
2086 while (*p && *p != ' ')
2092 sl = xtrymalloc (sizeof *sl + strlen (line));
2095 err = gpg_error_from_syserror ();
2099 strcpy_escaped_plus (sl->d, line);
2105 err = ensure_keyserver (ctrl);
2109 /* Setup an output stream and perform the get. */
2110 outfp = es_fopencookie (ctx, "w", data_line_cookie_functions);
2112 err = set_error (GPG_ERR_ASS_GENERAL, "error setting up a data stream");
2115 ctrl->server_local->inhibit_data_logging = 1;
2116 ctrl->server_local->inhibit_data_logging_now = 0;
2117 ctrl->server_local->inhibit_data_logging_count = 0;
2118 err = ks_action_get (ctrl, ctrl->server_local->keyservers, list, outfp);
2120 ctrl->server_local->inhibit_data_logging = 0;
2124 free_strlist (list);
2125 return leave_cmd (ctx, err);
2129 static const char hlp_ks_fetch[] =
2132 "Get the key(s) from URL.";
2134 cmd_ks_fetch (assuan_context_t ctx, char *line)
2136 ctrl_t ctrl = assuan_get_pointer (ctx);
2140 /* No options for now. */
2141 line = skip_options (line);
2143 err = ensure_keyserver (ctrl); /* FIXME: Why do we needs this here? */
2147 /* Setup an output stream and perform the get. */
2148 outfp = es_fopencookie (ctx, "w", data_line_cookie_functions);
2150 err = set_error (GPG_ERR_ASS_GENERAL, "error setting up a data stream");
2153 ctrl->server_local->inhibit_data_logging = 1;
2154 ctrl->server_local->inhibit_data_logging_now = 0;
2155 ctrl->server_local->inhibit_data_logging_count = 0;
2156 err = ks_action_fetch (ctrl, line, outfp);
2158 ctrl->server_local->inhibit_data_logging = 0;
2162 return leave_cmd (ctx, err);
2167 static const char hlp_ks_put[] =
2170 "Send a key to the configured OpenPGP keyservers. The actual key material\n"
2171 "is then requested by Dirmngr using\n"
2173 " INQUIRE KEYBLOCK\n"
2175 "The client shall respond with a binary version of the keyblock (e.g.,\n"
2176 "the output of `gpg --export KEYID'). For LDAP\n"
2177 "keyservers Dirmngr may ask for meta information of the provided keyblock\n"
2180 " INQUIRE KEYBLOCK_INFO\n"
2182 "The client shall respond with a colon delimited info lines (the output\n"
2183 "of 'for x in keys sigs; do gpg --list-$x --with-colons KEYID; done').\n";
2185 cmd_ks_put (assuan_context_t ctx, char *line)
2187 ctrl_t ctrl = assuan_get_pointer (ctx);
2189 unsigned char *value = NULL;
2191 unsigned char *info = NULL;
2194 /* No options for now. */
2195 line = skip_options (line);
2197 err = ensure_keyserver (ctrl);
2201 /* Ask for the key material. */
2202 err = assuan_inquire (ctx, "KEYBLOCK",
2203 &value, &valuelen, MAX_KEYBLOCK_LENGTH);
2206 log_error (_("assuan_inquire failed: %s\n"), gpg_strerror (err));
2210 if (!valuelen) /* No data returned; return a comprehensible error. */
2212 err = gpg_error (GPG_ERR_MISSING_CERT);
2216 /* Ask for the key meta data. Not actually needed for HKP servers
2217 but we do it anyway to test the client implementaion. */
2218 err = assuan_inquire (ctx, "KEYBLOCK_INFO",
2219 &info, &infolen, MAX_KEYBLOCK_LENGTH);
2222 log_error (_("assuan_inquire failed: %s\n"), gpg_strerror (err));
2227 err = ks_action_put (ctrl, ctrl->server_local->keyservers,
2228 value, valuelen, info, infolen);
2233 return leave_cmd (ctx, err);
2238 static const char hlp_loadswdb[] =
2239 "LOADSWDB [--force]\n"
2241 "Load and verify the swdb.lst from the Net.";
2243 cmd_loadswdb (assuan_context_t ctx, char *line)
2245 ctrl_t ctrl = assuan_get_pointer (ctx);
2248 err = dirmngr_load_swdb (ctrl, has_option (line, "--force"));
2250 return leave_cmd (ctx, err);
2255 static const char hlp_getinfo[] =
2258 "Multi purpose command to return certain information. \n"
2259 "Supported values of WHAT are:\n"
2261 "version - Return the version of the program.\n"
2262 "pid - Return the process id of the server.\n"
2263 "tor - Return OK if running in Tor mode\n"
2264 "dnsinfo - Return info about the DNS resolver\n"
2265 "socket_name - Return the name of the socket.\n";
2267 cmd_getinfo (assuan_context_t ctx, char *line)
2269 ctrl_t ctrl = assuan_get_pointer (ctx);
2272 if (!strcmp (line, "version"))
2274 const char *s = VERSION;
2275 err = assuan_send_data (ctx, s, strlen (s));
2277 else if (!strcmp (line, "pid"))
2281 snprintf (numbuf, sizeof numbuf, "%lu", (unsigned long)getpid ());
2282 err = assuan_send_data (ctx, numbuf, strlen (numbuf));
2284 else if (!strcmp (line, "socket_name"))
2286 const char *s = dirmngr_get_current_socket_name ();
2287 err = assuan_send_data (ctx, s, strlen (s));
2289 else if (!strcmp (line, "tor"))
2293 if (!is_tor_running (ctrl))
2294 err = assuan_write_status (ctx, "NO_TOR", "Tor not running");
2298 assuan_set_okay_line (ctx, "- Tor mode is enabled");
2301 err = set_error (GPG_ERR_FALSE, "Tor mode is NOT enabled");
2303 else if (!strcmp (line, "dnsinfo"))
2305 if (standard_resolver_p ())
2306 assuan_set_okay_line
2307 (ctx, "- Forced use of System resolver (w/o Tor support)");
2311 assuan_set_okay_line (ctx, (recursive_resolver_p ()
2312 ? "- Libdns recursive resolver"
2313 : "- Libdns stub resolver"));
2315 assuan_set_okay_line (ctx, "- System resolver (w/o Tor support)");
2321 err = set_error (GPG_ERR_ASS_PARAMETER, "unknown value for WHAT");
2323 return leave_cmd (ctx, err);
2328 static const char hlp_killdirmngr[] =
2331 "This command allows a user - given sufficient permissions -\n"
2332 "to kill this dirmngr process.\n";
2334 cmd_killdirmngr (assuan_context_t ctx, char *line)
2336 ctrl_t ctrl = assuan_get_pointer (ctx);
2340 ctrl->server_local->stopme = 1;
2341 assuan_set_flag (ctx, ASSUAN_FORCE_CLOSE, 1);
2342 return gpg_error (GPG_ERR_EOF);
2346 static const char hlp_reloaddirmngr[] =
2349 "This command is an alternative to SIGHUP\n"
2350 "to reload the configuration.";
2352 cmd_reloaddirmngr (assuan_context_t ctx, char *line)
2357 dirmngr_sighup_action ();
2363 /* Tell the assuan library about our commands. */
2365 register_commands (assuan_context_t ctx)
2369 assuan_handler_t handler;
2370 const char * const help;
2372 { "DNS_CERT", cmd_dns_cert, hlp_dns_cert },
2373 { "WKD_GET", cmd_wkd_get, hlp_wkd_get },
2374 { "LDAPSERVER", cmd_ldapserver, hlp_ldapserver },
2375 { "ISVALID", cmd_isvalid, hlp_isvalid },
2376 { "CHECKCRL", cmd_checkcrl, hlp_checkcrl },
2377 { "CHECKOCSP", cmd_checkocsp, hlp_checkocsp },
2378 { "LOOKUP", cmd_lookup, hlp_lookup },
2379 { "LOADCRL", cmd_loadcrl, hlp_loadcrl },
2380 { "LISTCRLS", cmd_listcrls, hlp_listcrls },
2381 { "CACHECERT", cmd_cachecert, hlp_cachecert },
2382 { "VALIDATE", cmd_validate, hlp_validate },
2383 { "KEYSERVER", cmd_keyserver, hlp_keyserver },
2384 { "KS_SEARCH", cmd_ks_search, hlp_ks_search },
2385 { "KS_GET", cmd_ks_get, hlp_ks_get },
2386 { "KS_FETCH", cmd_ks_fetch, hlp_ks_fetch },
2387 { "KS_PUT", cmd_ks_put, hlp_ks_put },
2388 { "GETINFO", cmd_getinfo, hlp_getinfo },
2389 { "LOADSWDB", cmd_loadswdb, hlp_loadswdb },
2390 { "KILLDIRMNGR",cmd_killdirmngr,hlp_killdirmngr },
2391 { "RELOADDIRMNGR",cmd_reloaddirmngr,hlp_reloaddirmngr },
2396 for (i=j=0; table[i].name; i++)
2398 rc = assuan_register_command (ctx, table[i].name, table[i].handler,
2407 /* Note that we do not reset the list of configured keyservers. */
2409 reset_notify (assuan_context_t ctx, char *line)
2411 ctrl_t ctrl = assuan_get_pointer (ctx);
2415 ldapserver_list_free (ctrl->server_local->ldapservers);
2417 ctrl->server_local->ldapservers = NULL;
2422 /* This function is called by our assuan log handler to test whether a
2423 * log message shall really be printed. The function must return
2424 * false to inhibit the logging of MSG. CAT gives the requested log
2425 * category. MSG might be NULL. */
2427 dirmngr_assuan_log_monitor (assuan_context_t ctx, unsigned int cat,
2430 ctrl_t ctrl = assuan_get_pointer (ctx);
2435 if (!ctrl || !ctrl->server_local)
2436 return 1; /* Can't decide - allow logging. */
2438 if (!ctrl->server_local->inhibit_data_logging)
2439 return 1; /* Not requested - allow logging. */
2441 /* Disallow logging if *_now is true. */
2442 return !ctrl->server_local->inhibit_data_logging_now;
2446 /* Startup the server and run the main command loop. With FD = -1,
2447 use stdin/stdout. */
2449 start_command_handler (assuan_fd_t fd)
2451 static const char hello[] = "Dirmngr " VERSION " at your service";
2452 static char *hello_line;
2454 assuan_context_t ctx;
2457 ctrl = xtrycalloc (1, sizeof *ctrl);
2459 ctrl->server_local = xtrycalloc (1, sizeof *ctrl->server_local);
2460 if (!ctrl || !ctrl->server_local)
2462 log_error (_("can't allocate control structure: %s\n"),
2468 dirmngr_init_default_ctrl (ctrl);
2470 rc = assuan_new (&ctx);
2473 log_error (_("failed to allocate assuan context: %s\n"),
2478 if (fd == ASSUAN_INVALID_FD)
2480 assuan_fd_t filedes[2];
2482 filedes[0] = assuan_fdopen (0);
2483 filedes[1] = assuan_fdopen (1);
2484 rc = assuan_init_pipe_server (ctx, filedes);
2488 rc = assuan_init_socket_server (ctx, fd, ASSUAN_SOCKET_SERVER_ACCEPTED);
2493 assuan_release (ctx);
2494 log_error (_("failed to initialize the server: %s\n"),
2499 rc = register_commands (ctx);
2502 log_error (_("failed to the register commands with Assuan: %s\n"),
2510 hello_line = xtryasprintf
2515 opt.config_filename? opt.config_filename : "[none]",
2519 ctrl->server_local->assuan_ctx = ctx;
2520 assuan_set_pointer (ctx, ctrl);
2522 assuan_set_hello_line (ctx, hello_line);
2523 assuan_register_option_handler (ctx, option_handler);
2524 assuan_register_reset_notify (ctx, reset_notify);
2528 rc = assuan_accept (ctx);
2533 log_info (_("Assuan accept problem: %s\n"), gpg_strerror (rc));
2537 #ifndef HAVE_W32_SYSTEM
2540 assuan_peercred_t peercred;
2542 if (!assuan_get_peercred (ctx, &peercred))
2543 log_info ("connection from process %ld (%ld:%ld)\n",
2544 (long)peercred->pid, (long)peercred->uid,
2545 (long)peercred->gid);
2549 rc = assuan_process (ctx);
2552 log_info (_("Assuan processing failed: %s\n"), gpg_strerror (rc));
2559 ldap_wrapper_connection_cleanup (ctrl);
2561 ldapserver_list_free (ctrl->server_local->ldapservers);
2563 ctrl->server_local->ldapservers = NULL;
2565 release_ctrl_keyservers (ctrl);
2567 ctrl->server_local->assuan_ctx = NULL;
2568 assuan_release (ctx);
2570 if (ctrl->server_local->stopme)
2574 log_error ("oops: connection control structure still referenced (%d)\n",
2578 release_ctrl_ocsp_certs (ctrl);
2579 xfree (ctrl->server_local);
2580 dirmngr_deinit_default_ctrl (ctrl);
2586 /* Send a status line back to the client. KEYWORD is the status
2587 keyword, the optional string arguments are blank separated added to
2588 the line, the last argument must be a NULL. */
2590 dirmngr_status (ctrl_t ctrl, const char *keyword, ...)
2592 gpg_error_t err = 0;
2596 va_start (arg_ptr, keyword);
2598 if (ctrl->server_local)
2600 assuan_context_t ctx = ctrl->server_local->assuan_ctx;
2606 while ( (text = va_arg (arg_ptr, const char *)) )
2613 for ( ; *text && n < DIM (buf)-2; n++)
2617 err = assuan_write_status (ctx, keyword, buf);
2625 /* Print a help status line. TEXTLEN gives the length of the text
2626 from TEXT to be printed. The function splits text at LFs. */
2628 dirmngr_status_help (ctrl_t ctrl, const char *text)
2630 gpg_error_t err = 0;
2632 if (ctrl->server_local)
2634 assuan_context_t ctx = ctrl->server_local->assuan_ctx;
2642 for ( ; *text && *text != '\n' && n < DIM (buf)-2; n++)
2647 err = assuan_write_status (ctx, "#", buf);
2649 while (!err && *text);
2655 /* Send a tick progress indicator back. Fixme: This is only done for
2656 the currently active channel. */
2658 dirmngr_tick (ctrl_t ctrl)
2660 static time_t next_tick = 0;
2661 gpg_error_t err = 0;
2662 time_t now = time (NULL);
2666 next_tick = now + 1;
2668 else if ( now > next_tick )
2672 err = dirmngr_status (ctrl, "PROGRESS", "tick", "? 0 0", NULL);
2675 /* Take this as in indication for a cancel request. */
2676 err = gpg_error (GPG_ERR_CANCELED);
2681 next_tick = now + 1;