Remove unused find_sibling_node ().
[libpwmd.git] / src / commands.c
blobe0611c144f357b4306086a92243e9ddbecf1a971
1 /*
2 Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015,
3 2016
4 Ben Kibbey <bjk@luxsci.net>
6 This file is part of pwmd.
8 Pwmd 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 2 of the License, or
11 (at your option) any later version.
13 Pwmd 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 Pwmd. If not, see <http://www.gnu.org/licenses/>.
21 #ifdef HAVE_CONFIG_H
22 #include <config.h>
23 #endif
25 #include <stdio.h>
26 #include <stdlib.h>
27 #include <unistd.h>
28 #include <err.h>
29 #include <errno.h>
30 #include <sys/types.h>
31 #include <sys/stat.h>
32 #include <fcntl.h>
33 #include <ctype.h>
34 #include <dirent.h>
35 #include <pthread.h>
36 #include <stdint.h>
37 #include <assert.h>
39 #include "pwmd-error.h"
40 #include <gcrypt.h>
42 #include "mem.h"
43 #include "xml.h"
44 #include "util-misc.h"
45 #include "common.h"
46 #include "rcfile.h"
47 #include "cache.h"
48 #include "commands.h"
49 #include "mutex.h"
50 #include "crypto.h"
52 /* These are command option flags. */
53 #define OPT_INQUIRE 0x0001
54 #define OPT_NO_PASSPHRASE 0x0002
55 #define OPT_ASK 0x0004
56 #define OPT_LIST_RECURSE 0x0008
57 #define OPT_VERBOSE 0x0010
58 #define OPT_LOCK 0x0020
59 #define OPT_LOCK_ON_OPEN 0x0040
60 #define OPT_SIGN 0x0080
61 #define OPT_LIST_ALL 0x0100
62 #define OPT_DATA 0x0200
63 #define OPT_NO_AGENT 0x0400
64 #define OPT_SECRET_ONLY 0x0800
65 #define OPT_INQUIRE_KEYID 0x1000
66 #define OPT_INQUIRE_SIGN_KEYID 0x2000
67 #define OPT_SYMMETRIC 0x4000
68 #define OPT_NO_SIGNER 0x8000
69 #define OPT_HTML 0x10000
71 #define FLOCK_TYPE_NONE 0
72 #define FLOCK_TYPE_SH 0x0001
73 #define FLOCK_TYPE_EX 0x0002
74 #define FLOCK_TYPE_KEEP 0x0004
76 struct command_table_s
78 const char *name;
79 gpg_error_t (*handler) (assuan_context_t, char *line);
80 const char *help;
81 int ignore_startup;
82 int unlock; // unlock the file mutex after validating the checksum
83 uint32_t flock_type;
86 static struct command_table_s **command_table;
88 static gpg_error_t do_lock (struct client_s *client, int add);
89 static gpg_error_t validate_checksum (struct client_s *,
90 struct cache_data_s *, unsigned char **,
91 size_t *);
92 static gpg_error_t update_checksum (struct client_s *client);
94 /* When 'status' is true the 'self' field of the status line will be false
95 * because we never send the STATE status message to the same client that
96 * initiated it. */
97 static char *
98 build_client_info_line (struct client_thread_s *thd, int status)
100 int with_state = config_get_boolean ("global", "send_state");
101 char *uid, *username = NULL;
102 char *line;
104 #ifdef WITH_GNUTLS
105 if (thd->remote)
106 uid = str_asprintf("#%s", thd->tls->fp);
107 else
109 uid = str_asprintf("%u", thd->peer->uid);
110 username = get_username (thd->peer->uid);
112 #else
113 uid = str_asprintf("%u", thd->peer->uid);
114 username = get_username (thd->peer->uid);
115 #endif
116 line = str_asprintf ("%p %s %s %s %u %u %u %s %s %u",
117 thd->tid,
118 thd->name ? thd->name : "-",
119 thd->cl && thd->cl->filename
120 && (thd->cl->flags & FLAG_OPEN)
121 ? thd->cl->filename : "/",
122 #ifdef WITH_GNUTLS
123 thd->remote ? thd->peeraddr : "-",
124 #else
125 "-",
126 #endif
127 thd->cl && thd->cl->flags & FLAG_HAS_LOCK ? 1 : 0,
128 !status && pthread_equal (pthread_self (), thd->tid) ? 1 : 0,
129 with_state ? thd->state : CLIENT_STATE_UNKNOWN, uid,
130 #ifdef WITH_GNUTLS
131 thd->remote ? "-" : username,
132 #else
133 username,
134 #endif
135 thd->conntime
138 xfree (username);
139 xfree (uid);
140 return line;
143 void
144 update_client_state (struct client_s *client, unsigned s)
146 MUTEX_LOCK (&cn_mutex);
147 client->thd->state = s;
148 MUTEX_UNLOCK (&cn_mutex);
149 int n = config_get_boolean ("global", "send_state");
151 if (n && client->thd->state != CLIENT_STATE_UNKNOWN)
153 char *line = build_client_info_line (client->thd, 1);
155 if (line)
156 send_status_all_not_self (n == 2, STATUS_STATE, "%s", line);
158 xfree (line);
162 static gpg_error_t
163 unlock_file_mutex (struct client_s *client, int remove)
165 gpg_error_t rc = 0;
167 // OPEN: keep the lock for the same file being reopened.
168 if (client->flags & FLAG_KEEP_LOCK && client->flags & FLAG_HAS_LOCK)
169 return 0;
171 if (!(client->flags & FLAG_HAS_LOCK))
172 return GPG_ERR_NOT_LOCKED;
174 rc = cache_unlock_mutex (client->md5file, remove);
175 if (rc)
176 rc = GPG_ERR_INV_STATE;
177 else
178 client->flags &= ~(FLAG_HAS_LOCK | FLAG_LOCK_CMD);
180 return rc;
183 static gpg_error_t
184 lock_file_mutex (struct client_s *client, int add)
186 gpg_error_t rc = 0;
187 int timeout = config_get_integer (client->filename, "cache_timeout");
189 if (client->flags & FLAG_HAS_LOCK)
190 return 0;
192 rc = cache_lock_mutex (client->ctx, client->md5file,
193 client->lock_timeout, add, timeout);
194 if (!rc)
195 client->flags |= FLAG_HAS_LOCK;
197 return rc;
200 static gpg_error_t
201 file_modified (struct client_s *client, struct command_table_s *cmd)
203 gpg_error_t rc = 0;
204 int type = !cmd->flock_type || (cmd->flock_type & FLOCK_TYPE_SH)
205 ? LOCK_SH : LOCK_EX;
207 if (!(client->flags & FLAG_OPEN))
208 return GPG_ERR_INV_STATE;
210 rc = lock_file_mutex (client, 0);
211 if (rc && rc != GPG_ERR_NO_DATA)
212 return rc;
214 rc = lock_flock (client->ctx, client->filename, type, &client->flock_fd);
215 if (!rc)
217 rc = validate_checksum (client, NULL, NULL, NULL);
218 if (gpg_err_code (rc) == GPG_ERR_ENOENT && (client->flags & FLAG_NEW))
219 rc = 0;
220 else if (rc)
221 log_write ("%s: %s", client->filename, pwmd_strerror (rc));
223 else if (gpg_err_code (rc) == GPG_ERR_ENOENT)
224 rc = 0;
226 /* FLAG_HAS_LOCK may have been set by the LOCK command or OPEN --lock. */
227 if ((cmd->unlock && !(client->flags & FLAG_HAS_LOCK)) || rc)
228 unlock_file_mutex (client, 0);
230 if (rc || !(cmd->flock_type & FLOCK_TYPE_KEEP))
231 unlock_flock (&client->flock_fd);
233 return rc;
236 static gpg_error_t
237 parse_xml (assuan_context_t ctx, int new)
239 struct client_s *client = assuan_get_pointer (ctx);
240 int cached = client->doc != NULL;
241 gpg_error_t rc = 0;
243 if (new)
245 client->doc = xml_new_document ();
246 if (client->doc)
248 xmlChar *result;
249 int len;
251 xmlDocDumpFormatMemory (client->doc, &result, &len, 0);
252 client->crypto->plaintext = result;
253 client->crypto->plaintext_size = len;
254 if (!client->crypto->plaintext)
256 xmlFreeDoc (client->doc);
257 client->doc = NULL;
258 rc = GPG_ERR_ENOMEM;
261 else
262 rc = GPG_ERR_ENOMEM;
264 else if (!cached)
265 rc = xml_parse_doc ((char *) client->crypto->plaintext,
266 client->crypto->plaintext_size,
267 (xmlDocPtr *)&client->doc);
269 return rc;
272 static void
273 free_client (struct client_s *client)
275 if (client->doc)
276 xmlFreeDoc (client->doc);
278 xfree (client->crc);
279 xfree (client->filename);
280 xfree (client->last_error);
281 crypto_cleanup (client->crypto);
282 client->crypto = NULL;
285 void
286 cleanup_client (struct client_s *client)
288 assuan_context_t ctx = client->ctx;
289 struct client_thread_s *thd = client->thd;
290 long lock_timeout = client->lock_timeout;
291 xmlErrorPtr xml_error = client->xml_error;
292 int no_pinentry = (client->flags & FLAG_NO_PINENTRY);
293 int flock_fd = client->flock_fd;
295 unlock_file_mutex (client, client->flags & FLAG_NEW);
296 free_client (client);
297 memset (client, 0, sizeof (struct client_s));
298 client->flock_fd = flock_fd;
299 client->xml_error = xml_error;
300 client->ctx = ctx;
301 client->thd = thd;
302 client->lock_timeout = lock_timeout;
303 client->flags |= no_pinentry ? FLAG_NO_PINENTRY : 0;
306 static void
307 req_cleanup (void *arg)
309 if (!arg)
310 return;
312 strv_free ((char **) arg);
315 static gpg_error_t
316 parse_open_opt_lock (void *data, void *value)
318 struct client_s *client = data;
320 client->opts |= OPT_LOCK_ON_OPEN;
321 return 0;
324 static gpg_error_t
325 parse_opt_inquire (void *data, void *value)
327 struct client_s *client = data;
329 (void) value;
330 client->opts |= OPT_INQUIRE;
331 return 0;
334 static gpg_error_t
335 update_checksum (struct client_s *client)
337 unsigned char *crc;
338 size_t len;
339 struct cache_data_s *cdata;
340 gpg_error_t rc = get_checksum (client->filename, &crc, &len);
342 if (rc)
343 return rc;
345 xfree (client->crc);
346 client->crc = crc;
347 cdata = cache_get_data (client->md5file);
348 if (cdata)
350 xfree (cdata->crc);
351 cdata->crc = xmalloc (len);
352 memcpy (cdata->crc, crc, len);
355 return 0;
358 static gpg_error_t
359 validate_checksum (struct client_s *client, struct cache_data_s *cdata,
360 unsigned char **r_crc, size_t *r_crclen)
362 unsigned char *crc;
363 size_t len;
364 gpg_error_t rc;
365 int n = 0;
367 if (cdata && !cdata->crc)
368 return GPG_ERR_CHECKSUM;
370 rc = get_checksum (client->filename, &crc, &len);
371 if (rc)
372 return rc;
374 if (cdata)
375 n = memcmp (cdata->crc, crc, len);
376 else if (client->crc)
377 n = memcmp (client->crc, crc, len);
379 if (!n && r_crc)
381 *r_crc = crc;
382 *r_crclen = len;
384 else
385 xfree (crc);
387 return n ? GPG_ERR_CHECKSUM : 0;
390 static gpg_error_t
391 open_command (assuan_context_t ctx, char *line)
393 gpg_error_t rc;
394 struct client_s *client = assuan_get_pointer (ctx);
395 char **req, *filename;
396 unsigned char md5file[16];
397 int same_file = 0;
398 assuan_peercred_t peer;
399 struct cache_data_s *cdata = NULL;
400 int cached = 0;
401 unsigned char *crc = NULL;
402 size_t crclen = 0;
403 struct argv_s *args[] = {
404 &(struct argv_s) {"lock", OPTION_TYPE_NOARG, parse_open_opt_lock},
405 NULL
408 rc = parse_options (&line, args, client, 1);
409 if (rc)
410 return send_error (ctx, rc);
412 req = str_split (line, " ", 2);
413 if (!req)
414 return send_error (ctx, GPG_ERR_SYNTAX);
416 rc = do_validate_peer (ctx, req[0], &peer);
417 if (rc)
419 strv_free (req);
420 return send_error (ctx, rc);
423 filename = req[0];
424 if (!valid_filename (filename))
426 strv_free (req);
427 return send_error (ctx, GPG_ERR_INV_VALUE);
430 pthread_cleanup_push ((void *)req_cleanup, req);
431 gcry_md_hash_buffer (GCRY_MD_MD5, md5file, filename, strlen (filename));
432 /* This client may have locked a different file with ISCACHED --lock than
433 * the current filename. This will remove that lock. */
434 same_file = !memcmp (md5file, client->md5file, 16) ? 1 : 0;
435 if (client->flags & FLAG_OPEN ||
436 (client->flags & FLAG_HAS_LOCK && !same_file))
438 uint32_t opts = client->opts;
439 uint32_t flags = client->flags;
441 if (same_file)
442 client->flags |= FLAG_KEEP_LOCK;
443 else if (client->flags & FLAG_NEW)
444 cache_clear (client->md5file);
446 cleanup_client (client);
447 client->opts = opts;
448 client->flags |= flags;
449 client->flags &= ~(FLAG_LOCK_CMD);
450 if (!same_file)
451 client->flags &= ~(FLAG_HAS_LOCK | FLAG_NEW);
454 memcpy (client->md5file, md5file, 16);
455 client->filename = str_dup (filename);
456 if (!client->filename)
458 strv_free (req);
459 return send_error(ctx, GPG_ERR_ENOMEM);
462 /* Need to lock the mutex here because file_modified() cannot without
463 * knowing the filename. */
464 rc = lock_file_mutex (client, 1);
465 if (rc)
466 client->flags &= ~FLAG_OPEN;
468 if (!rc)
470 rc = lock_flock (ctx, filename, LOCK_SH, &client->flock_fd);
471 if (gpg_err_code (rc) == GPG_ERR_ENOENT)
472 rc = 0;
475 if (!rc)
477 struct stat st;
479 rc = crypto_init (&client->crypto, client->ctx, client->filename,
480 client->flags & FLAG_NO_PINENTRY);
481 if (!rc && stat (client->filename, &st) == -1)
482 rc = gpg_error_from_errno (errno);
483 else if (!rc && !S_ISREG (st.st_mode)) // to match LS output
484 rc = gpg_error_from_errno (ENOANO);
487 if (!rc || gpg_err_code (rc) == GPG_ERR_ENOENT)
489 cdata = cache_get_data (client->md5file);
491 if (rc) // new file
493 rc = 0;
494 client->flags |= FLAG_NEW;
495 // data file disappeared. clear the cache entry.
496 cache_clear (client->md5file);
497 cdata = NULL;
499 else if (cdata && cdata->doc) // cached document
501 int reload = 0;
502 int defer = 0;
504 if (!rc && !(client->flags & FLAG_NEW))
506 rc = validate_checksum (client, cdata, &crc, &crclen);
507 if (rc == GPG_ERR_CHECKSUM)
509 rc = 0;
510 reload = 1;
514 if (!rc)
516 rc = cache_iscached (client->filename, &defer);
517 if ((!rc || rc == GPG_ERR_ENOENT) && defer)
519 rc = 0;
520 reload = 2;
524 if (!rc && reload)
526 if (reload == 1)
527 log_write ("%s: %s", client->filename,
528 pwmd_strerror (GPG_ERR_CHECKSUM));
529 cache_clear (client->md5file);
530 cdata = NULL;
531 rc = crypto_decrypt (client, client->crypto);
533 #ifdef WITH_GNUTLS
534 else if (!rc)
536 if (client->thd->remote
537 && config_get_boolean (client->filename, "tcp_require_key")
538 && !(client->flags & FLAG_NEW))
539 rc = crypto_try_decrypt (client,
540 (client->flags & FLAG_NO_PINENTRY));
542 #endif
544 if (!rc && cdata)
546 client->crypto->plaintext = cdata->doc;
547 client->crypto->plaintext_size = cdata->size;
548 rc = cache_decrypt (client->crypto);
549 if (!rc)
551 cdata->doc = NULL;
552 cdata->size = 0;
553 strv_free (client->crypto->pubkey);
554 strv_free (client->crypto->sigkey);
555 client->crypto->pubkey = strv_dup (cdata->pubkey);
556 client->crypto->sigkey = strv_dup (cdata->sigkey);
557 cached = 1;
559 else
561 client->crypto->plaintext = NULL;
562 client->crypto->plaintext_size = 0;
566 else // existing file
568 cached = cdata != NULL;
569 rc = crypto_decrypt (client, client->crypto);
573 if (!rc)
575 rc = parse_xml (ctx, client->flags & FLAG_NEW);
576 if (!rc)
578 rc = cache_encrypt (client->crypto);
579 if (rc)
580 cache_clear (client->md5file);
581 else
583 int timeout = config_get_integer (client->filename,
584 "cache_timeout");
586 free_cache_data_once (cdata);
587 cdata = xcalloc (1, sizeof (struct cache_data_s));
588 cdata->doc = client->crypto->plaintext;
589 cdata->size = client->crypto->plaintext_size;
590 cdata->pubkey = strv_dup(client->crypto->pubkey);
591 cdata->sigkey = strv_dup(client->crypto->sigkey);
592 client->crypto->plaintext = NULL;
593 client->crypto->plaintext_size = 0;
595 if (cached) // wont increment the refcount
597 /* Prevent using another FD to update the checksum for a
598 * cached data file. The validity has already been
599 * verified. */
600 xfree (client->crc);
601 client->crc = xmalloc (crclen);
602 memcpy (client->crc, crc, crclen);
603 xfree (cdata->crc);
604 cdata->crc = xmalloc (crclen);
605 memcpy (cdata->crc, crc, crclen);
607 rc = cache_set_data (client->md5file, cdata);
608 /* The cache entry may have been removed and cache_set_data()
609 * already sent STATUS_CACHE. */
610 if (!cache_iscached (client->filename, NULL))
611 rc = send_status (ctx, STATUS_CACHE, NULL);
613 else
614 rc = cache_add_file (client->md5file, cdata, timeout);
619 pthread_cleanup_pop (1);
620 xfree (crc);
622 if (!rc && !(client->flags & FLAG_NEW) && !cached)
623 rc = update_checksum (client);
625 if (!rc)
627 client->flags |= FLAG_OPEN;
629 if (client->flags & FLAG_NEW)
630 rc = send_status (ctx, STATUS_NEWFILE, NULL);
632 if (!rc && (client->opts & OPT_LOCK_ON_OPEN))
633 rc = do_lock (client, 0);
636 if (rc)
638 log_write ("%s: %s", client->filename, pwmd_strerror (rc));
640 if (client->flags & FLAG_NEW)
641 cache_clear (client->md5file);
643 crypto_cleanup (client->crypto);
644 client->crypto = NULL;
645 client->flags &= ~FLAG_OPEN;
648 crypto_cleanup_non_keys (client->crypto);
649 return send_error (ctx, rc);
652 /* If not the invoking_user or is an existing file, check that the list of user
653 * supplied key ID's are in the list of current key ID's obtained when
654 * decrypting the data file. Both short and long form keyid fingerprints are
655 * valid:
657 * 8 byte with optional "0x" prefix
658 * 16 byte
659 * 40 byte
661 * Although, the key ID's are converted to the 8 byte form before calling this
662 * function in parse_save_opt_keyid_common() to keep consistancy with KEYINFO
663 * output.
665 static gpg_error_t
666 permitted_to_save (struct client_s *client, const char **keys,
667 const char **value)
669 gpg_error_t rc = 0;
670 const char **v;
672 if ((client->flags & FLAG_NEW) || (client->opts & OPT_SYMMETRIC))
673 return 0;
675 rc = peer_is_invoker (client);
676 if (!rc)
677 return 0;
679 /* Empty match. */
680 if ((!value && !keys) || ((value && !*value) && (keys && !*keys)))
681 return 0;
683 for (v = value; v && *v; v++)
685 const char **k, *pv = *v;
686 int match = 0;
688 if (*pv == '0' && *(pv+1) == 'x')
689 pv += 2;
691 for (k = keys; k && *k; k++)
693 const char *pk = *k;
695 if (*pk == '0' && *(pk+1) == 'x')
696 pk += 2;
698 rc = !strcmp (pv, pk) ? 0 : GPG_ERR_FORBIDDEN;
699 if (rc)
700 rc = !strcmp (pv, *k) ? 0 : GPG_ERR_FORBIDDEN;
702 if (!rc)
704 match = 1;
705 break;
709 if (!match)
710 return GPG_ERR_FORBIDDEN;
713 return rc;
716 static gpg_error_t
717 parse_save_opt_keyid_common (struct client_s *client, const char **list,
718 const char *value, char ***dst)
720 gpg_error_t rc;
721 char **p = NULL;
723 if (value && *value)
725 p = str_split (value, ",", 0);
726 if (!p)
727 return GPG_ERR_ENOMEM;
730 crypto_keyid_to_8b (p);
731 rc = permitted_to_save (client, list, (const char **)p);
732 if (!rc)
733 *dst = p;
734 else
735 strv_free (*dst);
737 return rc;
740 static gpg_error_t
741 parse_save_opt_keyid (void *data, void *value)
743 struct client_s *client = data;
744 const char *str = value;
745 char **dst = NULL;
746 gpg_error_t rc;
748 rc = parse_save_opt_keyid_common (client,
749 (const char **)client->crypto->pubkey,
750 str, &dst);
751 if (rc)
752 return rc;
754 client->crypto->save.pubkey = dst;
755 return 0;
758 static gpg_error_t
759 parse_save_opt_sign_keyid (void *data, void *value)
761 struct client_s *client = data;
762 const char *str = value;
763 char **dst = NULL;
764 gpg_error_t rc;
766 rc = parse_save_opt_keyid_common (client,
767 (const char **)client->crypto->sigkey,
768 str, &dst);
769 if (rc)
770 return rc;
772 if (!dst)
773 client->opts |= OPT_NO_SIGNER;
775 client->crypto->save.sigkey = dst;
776 return 0;
779 static gpg_error_t
780 parse_save_opt_inquire (struct client_s *client, uint32_t opt)
782 if (opt == OPT_INQUIRE && !(client->flags & FLAG_NEW))
784 gpg_error_t rc = peer_is_invoker (client);
786 if (rc)
787 return rc;
790 client->opts |= opt;
791 return 0;
794 static gpg_error_t
795 parse_save_opt_inquire_keyparam (void *data, void *value)
797 return parse_save_opt_inquire (data, OPT_INQUIRE);
800 static gpg_error_t
801 parse_save_opt_inquire_keyid (void *data, void *value)
803 return parse_save_opt_inquire (data, OPT_INQUIRE_KEYID);
806 static gpg_error_t
807 parse_save_opt_inquire_sign_keyid (void *data, void *value)
809 return parse_save_opt_inquire (data, OPT_INQUIRE_SIGN_KEYID);
812 static gpg_error_t
813 parse_save_opt_symmetric (void *data, void *value)
815 struct client_s *client = data;
817 client->opts |= OPT_SYMMETRIC;
818 return 0;
821 /* Tests that the keys in new_keys are also in old_keys. */
822 static gpg_error_t
823 compare_keys (char **new_keys, char **old_keys)
825 char **o;
827 if (!old_keys || !*old_keys)
828 return 0;
830 crypto_keyid_to_8b (new_keys);
832 for (o = old_keys; *o; o++)
834 char **n;
836 for (n = new_keys; *n; n++)
838 if (!strcmp (*n, *o))
839 break;
842 if (!*n)
843 return GPG_ERR_NOT_FOUND;
846 return 0;
849 static gpg_error_t
850 inquire_keyid (struct client_s *client, uint32_t opt)
852 gpg_error_t rc;
853 unsigned char *result = NULL;
854 size_t len;
855 char *s;
856 char ***orig;
857 char ***save;
859 if (opt == OPT_INQUIRE_KEYID)
861 s = "INQUIRE_KEYID";
862 orig = &client->crypto->pubkey;
863 save = &client->crypto->save.pubkey;
865 else
867 s = "INQUIRE_SIGN_KEYID";
868 orig = &client->crypto->sigkey;
869 save = &client->crypto->save.sigkey;
872 rc = assuan_inquire (client->ctx, s, &result, &len, 0);
873 if (!rc)
875 char **dst = NULL;
877 rc = parse_save_opt_keyid_common (client, (const char **)*orig,
878 (char *)result, &dst);
879 if (!rc)
881 if (!dst && opt == OPT_INQUIRE_SIGN_KEYID
882 && client->opts & OPT_SYMMETRIC)
883 client->opts |= OPT_NO_SIGNER;
885 *save = dst;
889 xfree (result);
890 return rc;
893 static gpg_error_t
894 save_command (assuan_context_t ctx, char *line)
896 struct client_s *client = assuan_get_pointer (ctx);
897 struct cache_data_s *cdata = NULL;
898 gpg_error_t rc = 0, cached = 0;
899 int defer = 0;
900 struct stat st;
901 struct argv_s *args[] = {
902 &(struct argv_s) {"keyid", OPTION_TYPE_ARG, parse_save_opt_keyid},
903 &(struct argv_s) {"sign-keyid", OPTION_TYPE_OPTARG,
904 parse_save_opt_sign_keyid},
905 &(struct argv_s) {"inquire-keyparam", OPTION_TYPE_NOARG,
906 parse_save_opt_inquire_keyparam },
907 &(struct argv_s) {"inquire-keyid", OPTION_TYPE_NOARG,
908 parse_save_opt_inquire_keyid },
909 &(struct argv_s) {"inquire-sign-keyid", OPTION_TYPE_NOARG,
910 parse_save_opt_inquire_sign_keyid },
911 &(struct argv_s) {"symmetric", OPTION_TYPE_NOARG,
912 parse_save_opt_symmetric },
913 NULL
916 crypto_cleanup_save (&client->crypto->save);
918 if (!(client->flags & FLAG_NEW))
920 rc = crypto_is_symmetric (client->filename);
921 if (!rc || rc == GPG_ERR_BAD_DATA)
923 if (!rc)
924 client->opts |= OPT_SYMMETRIC;
926 rc = 0; // PKI
930 if (rc)
931 return send_error (ctx, rc);
933 rc = parse_options (&line, args, client, 0);
934 if (rc)
935 return send_error (ctx, rc);
937 if (config_get_boolean (client->filename, "require_save_key"))
938 client->opts |= OPT_ASK;
940 if (lstat (client->filename, &st) == -1 && errno != ENOENT)
941 return send_error (ctx, gpg_error_from_errno (errno));
943 if (errno != ENOENT && !S_ISREG (st.st_mode))
945 log_write ("%s: %s", client->filename, pwmd_strerror (GPG_ERR_ENOANO));
946 return send_error (ctx, GPG_ERR_ENOANO);
949 if (!rc)
950 cached = rc = cache_iscached (client->filename, &defer);
952 if (gpg_err_code (rc) == GPG_ERR_ENOENT && (client->flags & FLAG_NEW))
953 rc = 0;
954 else if (gpg_err_code (rc) == GPG_ERR_NO_DATA)
955 rc = 0;
957 if (rc)
958 return send_error (ctx, rc);
960 /* Specifying both a recipient and symmetric encryption is an error. */
961 if (client->opts & OPT_INQUIRE_KEYID && client->opts & OPT_SYMMETRIC)
963 return send_error (ctx, GPG_ERR_CONFLICT);
965 else if (client->opts & OPT_INQUIRE && client->opts & OPT_SYMMETRIC)
967 return send_error (ctx, GPG_ERR_CONFLICT);
969 /* Existing file with a recipient and wanting symmetric is an error. */
970 else if (client->opts & OPT_SYMMETRIC && client->crypto->save.pubkey)
972 return send_error (ctx, GPG_ERR_CONFLICT);
974 else if (((client->opts & OPT_INQUIRE_KEYID)
975 || (client->opts & OPT_INQUIRE_SIGN_KEYID)))
977 if (client->opts & OPT_INQUIRE)
978 return send_error (ctx, GPG_ERR_CONFLICT);
980 if (client->opts & OPT_INQUIRE_KEYID)
981 rc = inquire_keyid (client, OPT_INQUIRE_KEYID);
983 if (!rc && (client->opts & OPT_INQUIRE_SIGN_KEYID))
984 rc = inquire_keyid (client, OPT_INQUIRE_SIGN_KEYID);
986 else if ((client->crypto->save.pubkey || client->crypto->save.sigkey)
987 && client->opts & OPT_INQUIRE)
988 return send_error (ctx, GPG_ERR_CONFLICT);
990 if (!rc)
991 rc = crypto_init_ctx (client->crypto, client->flags & FLAG_NO_PINENTRY);
993 if (!rc && (client->opts & OPT_INQUIRE))
995 /* Require a passphrase when generating a new key pair for an existing
996 * file.
998 if (!(client->flags & FLAG_NEW))
1000 rc = crypto_try_decrypt (client, client->flags & FLAG_NO_PINENTRY);
1001 client->opts &= ~OPT_ASK;
1004 if (!rc)
1006 unsigned char *params = NULL;
1007 size_t len;
1009 rc = assuan_inquire (client->ctx, "KEYPARAM", &params, &len, 0);
1010 if (!rc)
1012 client->crypto->flags |= CRYPTO_FLAG_NEWFILE;
1013 pthread_cleanup_push ((void *)xfree, params);
1014 rc = crypto_genkey (client, client->crypto, params);
1015 pthread_cleanup_pop (1);
1019 else if (!rc && (client->flags & FLAG_NEW))
1021 if (!client->crypto->save.pubkey && !client->crypto->save.sigkey
1022 && !(client->opts & OPT_SYMMETRIC))
1024 char *params = crypto_default_key_params ();
1026 if (!params)
1027 rc = GPG_ERR_ENOMEM;
1029 if (!rc)
1031 client->crypto->flags |= CRYPTO_FLAG_NEWFILE;
1032 pthread_cleanup_push ((void *)xfree, params);
1033 rc = crypto_genkey (client, client->crypto,
1034 (unsigned char *)params);
1035 pthread_cleanup_pop (1);
1038 else
1040 if (!client->crypto->save.pubkey && client->crypto->save.sigkey
1041 && !(client->opts & OPT_SYMMETRIC))
1042 client->crypto->save.pubkey = strv_dup (client->crypto->save.sigkey);
1044 if (client->crypto->save.pubkey && !client->crypto->save.sigkey)
1045 client->crypto->save.sigkey = strv_dup (client->crypto->save.pubkey);
1048 else if (!rc)
1050 cdata = cache_get_data (client->md5file);
1051 if (cdata)
1053 if (client->crypto->save.pubkey)
1054 rc = compare_keys (client->crypto->save.pubkey, cdata->pubkey);
1056 /* Always allow a signer for symmetric data files. */
1057 if (!rc && client->crypto->save.sigkey
1058 && !(client->opts & OPT_SYMMETRIC))
1059 rc = compare_keys (client->crypto->save.sigkey, cdata->sigkey);
1061 /* Prevent saving to a recipient who is not in the original recipient
1062 * list without a passphrase. */
1063 if (rc || (client->crypto->sigkey && client->opts & OPT_NO_SIGNER))
1064 client->opts |= OPT_ASK;
1066 if (rc == GPG_ERR_NOT_FOUND)
1068 rc = peer_is_invoker (client);
1069 if (rc == GPG_ERR_EACCES)
1070 rc = GPG_ERR_FORBIDDEN;
1073 if (!client->crypto->save.pubkey
1074 && !(client->opts & OPT_SYMMETRIC))
1075 client->crypto->save.pubkey = strv_dup (cdata->pubkey);
1077 if (!client->crypto->save.sigkey && cdata->sigkey
1078 && !(client->opts & OPT_NO_SIGNER))
1079 client->crypto->save.sigkey = strv_dup (cdata->sigkey);
1080 else if (!client->crypto->save.sigkey
1081 && (client->opts & OPT_NO_SIGNER)
1082 && !(client->opts & OPT_SYMMETRIC))
1083 rc = GPG_ERR_NO_SIGNATURE_SCHEME;
1085 else
1087 client->crypto->save.pubkey = strv_dup (client->crypto->pubkey);
1088 client->crypto->save.sigkey = strv_dup (client->crypto->sigkey);
1092 if (!rc && !(client->flags & FLAG_NEW))
1094 /* Fixes {NEW_,SIGN_}PASSPHRASE inquire keywords. See passphrase_cb(). */
1095 if (client->opts & OPT_SYMMETRIC)
1096 client->crypto->flags |= CRYPTO_FLAG_PASSWD;
1098 if (client->opts & OPT_ASK)
1099 rc = crypto_try_decrypt (client, client->flags & FLAG_NO_PINENTRY);
1102 if (!rc && client->opts & OPT_SYMMETRIC)
1103 client->crypto->flags |= CRYPTO_FLAG_PASSWD_NEW;
1105 if (!rc)
1106 rc = xml_update_element_mtime (client, xmlDocGetRootElement (client->doc));
1108 if (!rc)
1110 int size;
1112 xmlDocDumpFormatMemory (client->doc, &client->crypto->plaintext, &size,
1114 if (size > 0)
1115 client->crypto->plaintext_size = (size_t) size;
1116 else
1117 rc = GPG_ERR_ENOMEM;
1119 if (!rc)
1121 client->crypto->flags |= (client->opts & OPT_SYMMETRIC) ? CRYPTO_FLAG_SYMMETRIC : 0;
1122 client->crypto->flags |= (client->flags & FLAG_NEW) ? CRYPTO_FLAG_NEWFILE : 0;
1123 rc = crypto_encrypt (client, client->crypto);
1124 client->crypto->flags &= ~CRYPTO_FLAG_SYMMETRIC;
1127 if (!rc)
1129 rc = crypto_write_file (client->crypto);
1130 if (!rc)
1132 if (!cached) // no error
1133 cdata = cache_get_data (client->md5file);
1136 if (!rc)
1138 rc = cache_encrypt (client->crypto);
1139 if (rc)
1141 cache_clear (client->md5file);
1142 strv_free (client->crypto->pubkey);
1143 client->crypto->pubkey = strv_dup (client->crypto->save.pubkey);
1144 strv_free (client->crypto->sigkey);
1145 client->crypto->sigkey = strv_dup (client->crypto->save.sigkey);
1146 client->flags &= ~(FLAG_NEW);
1150 if (!rc)
1152 int timeout = config_get_integer (client->filename,
1153 "cache_timeout");
1155 free_cache_data_once (cdata);
1156 cdata = xcalloc (1, sizeof (struct cache_data_s));
1157 cdata->doc = client->crypto->plaintext;
1158 client->crypto->plaintext = NULL;
1159 cdata->size = client->crypto->plaintext_size;
1160 client->crypto->plaintext_size = 0;
1161 cdata->pubkey = client->crypto->save.pubkey;
1162 client->crypto->save.pubkey = NULL;
1163 cdata->sigkey = client->crypto->save.sigkey;
1164 client->crypto->save.sigkey = NULL;
1166 /* Update in case the cache entry expires the next SAVE may not
1167 * have any known keys. */
1168 strv_free (client->crypto->pubkey);
1169 client->crypto->pubkey = strv_dup (cdata->pubkey);
1170 strv_free (client->crypto->sigkey);
1171 client->crypto->sigkey = strv_dup (cdata->sigkey);
1173 if (!cached) // no error and wont increment refcount
1174 rc = cache_set_data (client->md5file, cdata);
1175 else
1176 rc = cache_add_file (client->md5file, cdata, timeout);
1178 if (!rc && (cached || (client->flags & FLAG_NEW)))
1179 send_status_all (STATUS_CACHE, NULL);
1181 if (!rc)
1183 rc = update_checksum (client);
1184 client->flags &= ~(FLAG_NEW);
1190 crypto_cleanup_non_keys (client->crypto);
1191 return send_error (ctx, rc);
1194 static gpg_error_t
1195 do_delete (assuan_context_t ctx, char *line)
1197 struct client_s *client = assuan_get_pointer (ctx);
1198 struct xml_request_s *req;
1199 xmlNodePtr n;
1200 gpg_error_t rc;
1202 rc = xml_new_request (client, line, XML_CMD_DELETE, &req);
1203 if (rc)
1204 return rc;
1206 n = xml_find_elements (client, req, xmlDocGetRootElement (req->doc), &rc);
1207 xml_free_request (req);
1208 if (rc)
1209 return rc;
1211 rc = xml_is_element_owner (client, n);
1212 if (!rc)
1213 rc = xml_unlink_node (client, n);
1215 return rc;
1218 static gpg_error_t
1219 delete_command (assuan_context_t ctx, char *line)
1221 struct client_s *client = assuan_get_pointer (ctx);
1222 gpg_error_t rc;
1223 struct argv_s *args[] = {
1224 &(struct argv_s) {"inquire", OPTION_TYPE_NOARG, parse_opt_inquire},
1225 NULL
1228 rc = parse_options (&line, args, client, 1);
1229 if (!rc && (client->opts & OPT_INQUIRE) && line && *line)
1230 rc = GPG_ERR_SYNTAX;
1231 if (rc)
1232 return send_error (ctx, rc);
1234 if (client->opts & OPT_INQUIRE)
1236 unsigned char *result;
1237 size_t len;
1239 rc = assuan_inquire (ctx, "DATA", &result, &len, 0);
1240 if (rc)
1241 return send_error (ctx, rc);
1243 pthread_cleanup_push ((void *)xfree, result);
1244 rc = do_delete (ctx, (char *)result);
1245 pthread_cleanup_pop (1);
1247 else
1248 rc = do_delete (ctx, line);
1250 return send_error (ctx, rc);
1253 static gpg_error_t
1254 update_element_expirey (struct client_s *client, xmlNodePtr n)
1256 gpg_error_t rc = 0;
1257 xmlChar *expire, *incr;
1258 char *p;
1259 time_t e, e_orig, i;
1260 time_t now = time (NULL);
1262 expire = xml_attribute_value (n, (xmlChar *)"expire");
1263 if (!expire)
1264 return 0;
1266 errno = 0;
1267 e = strtoul ((char *)expire, &p, 10);
1268 if (errno || *p || e == ULONG_MAX || *expire == '-')
1270 xmlFree (expire);
1271 rc = GPG_ERR_ERANGE;
1272 goto fail;
1275 xmlFree (expire);
1276 incr = xml_attribute_value (n, (xmlChar *)"expire_increment");
1277 if (!incr)
1278 return 0;
1280 i = strtoul ((char *)incr, &p, 10);
1281 if (errno || *p || i == ULONG_MAX || *incr == '-')
1283 xmlFree (incr);
1284 rc = GPG_ERR_ERANGE;
1285 goto fail;
1288 xmlFree (incr);
1289 e_orig = e;
1290 e = now + i;
1291 p = str_asprintf ("%lu", e);
1292 if (!p)
1294 rc = GPG_ERR_ENOMEM;
1295 goto fail;
1298 rc = xml_add_attribute (client, n, "expire", p);
1299 xfree (p);
1300 if (!rc)
1301 rc = send_status (client->ctx, STATUS_EXPIRE, "%lu %lu", e_orig, e);
1303 fail:
1304 return rc;
1307 static gpg_error_t
1308 store_command (assuan_context_t ctx, char *line)
1310 struct client_s *client = assuan_get_pointer (ctx);
1311 gpg_error_t rc;
1312 size_t len;
1313 unsigned char *result;
1314 xmlNodePtr n, parent;
1315 int has_content;
1316 char *content = NULL;
1317 struct xml_request_s *req;
1319 if (line && *line)
1320 return send_error (ctx, GPG_ERR_SYNTAX);
1322 rc = assuan_inquire (ctx, "DATA", &result, &len, 0);
1323 if (rc)
1324 return send_error (ctx, rc);
1326 rc = xml_new_request (client, (char *)result, XML_CMD_STORE, &req);
1327 xfree (result);
1328 if (rc)
1329 return send_error (ctx, rc);
1331 /* Prevent passing the element content around to save some memory. */
1332 len = strv_length (req->args);
1333 has_content = line[strlen (line) - 1] != '\t' && len > 1;
1334 if (*(req->args+1) && !xml_valid_element_path (req->args, has_content))
1336 xml_free_request (req);
1337 return send_error (ctx, GPG_ERR_INV_VALUE);
1340 if (has_content || !*req->args[len-1])
1342 has_content = 1;
1343 content = req->args[len-1];
1344 req->args[len-1] = NULL;
1347 if (strv_length (req->args) > 1)
1349 rc = xml_check_recursion (client, req, has_content);
1350 if (rc && rc != GPG_ERR_ELEMENT_NOT_FOUND)
1351 goto fail;
1354 parent = xml_find_elements (client, req, xmlDocGetRootElement (req->doc), &rc);
1356 if (!rc && len > 1)
1358 rc = xml_is_element_owner (client, parent);
1359 if (!rc)
1361 n = xml_find_text_node (parent->children);
1362 if (n)
1363 xmlNodeSetContent (n, (xmlChar *) content);
1364 else
1365 xmlNodeAddContent (parent, (xmlChar *) content);
1367 (void)xml_update_element_mtime (client, parent);
1368 (void)update_element_expirey (client, parent);
1372 fail:
1373 xfree (content);
1374 xml_free_request (req);
1375 return send_error (ctx, rc);
1378 static gpg_error_t
1379 xfer_data (assuan_context_t ctx, const char *line, int total)
1381 struct client_s *client = assuan_get_pointer (ctx);
1382 int to_send;
1383 int sent = 0;
1384 gpg_error_t rc = 0;
1385 int progress = config_get_integer ("global", "xfer_progress");
1386 int flush = 0;
1388 if (!(client->flags & FLAG_LOCK_CMD))
1389 rc = unlock_file_mutex (client, 0);
1390 if (rc && rc != GPG_ERR_NOT_LOCKED)
1391 return rc;
1393 progress =
1394 progress > 0 ? (progress / ASSUAN_LINELENGTH) * ASSUAN_LINELENGTH : 0;
1395 to_send = total < ASSUAN_LINELENGTH ? total : ASSUAN_LINELENGTH;
1396 rc = send_status (ctx, STATUS_XFER, "%li %li", sent, total);
1398 if (rc)
1399 return rc;
1401 again:
1404 if (sent + to_send > total)
1405 to_send = total - sent;
1407 rc = assuan_send_data (ctx, flush ? NULL : (char *) line + sent,
1408 flush ? 0 : to_send);
1409 if (!rc)
1411 sent += flush ? 0 : to_send;
1413 if ((progress && !(sent % progress) && sent != total) ||
1414 (sent == total && flush))
1415 rc = send_status (ctx, STATUS_XFER, "%li %li", sent, total);
1417 if (!flush && !rc && sent == total)
1419 flush = 1;
1420 goto again;
1424 while (!rc && sent < total);
1426 return rc;
1429 static gpg_error_t
1430 do_get (assuan_context_t ctx, char *line)
1432 struct client_s *client = assuan_get_pointer (ctx);
1433 gpg_error_t rc;
1434 struct xml_request_s *req;
1435 xmlNodePtr n;
1437 rc = xml_new_request (client, line, XML_CMD_NONE, &req);
1438 if (rc)
1439 return rc;
1441 n = xml_find_elements (client, req, xmlDocGetRootElement (req->doc), &rc);
1442 if (!rc)
1444 if (n && n->children)
1446 xmlNodePtr tmp = n;
1448 n = xml_find_text_node (n->children);
1449 if (!n || !n->content || !*n->content)
1450 rc = GPG_ERR_NO_DATA;
1451 else
1453 rc = xfer_data (ctx, (char *) n->content, xmlStrlen (n->content));
1454 if (!rc)
1456 xmlChar *expire = xml_attribute_value (tmp,
1457 (xmlChar *)"expire");
1458 if (expire)
1460 time_t now = time (NULL);
1461 time_t e;
1462 char *p;
1464 errno = 0;
1465 e = strtoul ((char *)expire, &p, 10);
1466 if (errno || *p || e == ULONG_MAX || *expire == '-')
1467 log_write (_("invalid expire attribute value: %s"),
1468 expire);
1469 else if (now >= e)
1470 rc = send_status (ctx, STATUS_EXPIRE, "%lu 0", e);
1472 xmlFree (expire);
1477 else
1478 rc = GPG_ERR_NO_DATA;
1481 xml_free_request (req);
1482 return rc;
1485 static gpg_error_t
1486 get_command (assuan_context_t ctx, char *line)
1488 struct client_s *client = assuan_get_pointer (ctx);
1489 gpg_error_t rc;
1490 struct argv_s *args[] = {
1491 &(struct argv_s) {"inquire", OPTION_TYPE_NOARG, parse_opt_inquire},
1492 NULL
1495 rc = parse_options (&line, args, client, 1);
1496 if (!rc && (client->opts & OPT_INQUIRE) && line && *line)
1497 rc = GPG_ERR_SYNTAX;
1498 if (rc)
1499 return send_error (ctx, rc);
1501 if (client->opts & OPT_INQUIRE)
1503 unsigned char *result;
1504 size_t len;
1506 rc = assuan_inquire (ctx, "DATA", &result, &len, 0);
1507 if (rc)
1508 return send_error (ctx, rc);
1510 pthread_cleanup_push ((void *)xfree, result);
1511 rc = do_get (ctx, (char *)result);
1512 pthread_cleanup_pop (1);
1514 else
1515 rc = do_get (ctx, line);
1517 return send_error (ctx, rc);
1520 static void list_command_cleanup1 (void *arg);
1521 static gpg_error_t
1522 realpath_command (assuan_context_t ctx, char *line)
1524 gpg_error_t rc;
1525 char **realpath = NULL;
1526 struct client_s *client = assuan_get_pointer (ctx);
1527 struct argv_s *args[] = {
1528 &(struct argv_s) {"inquire", OPTION_TYPE_NOARG, parse_opt_inquire},
1529 NULL
1532 rc = parse_options (&line, args, client, 1);
1533 if (!rc && (client->opts & OPT_INQUIRE) && line && *line)
1534 rc = GPG_ERR_SYNTAX;
1535 if (rc)
1536 return send_error (ctx, rc);
1538 if (client->opts & OPT_INQUIRE)
1540 unsigned char *result;
1541 size_t len;
1543 rc = assuan_inquire (ctx, "DATA", &result, &len, 0);
1544 if (rc)
1545 return send_error (ctx, rc);
1547 pthread_cleanup_push ((void *)xfree, result);
1548 (void)xml_resolve_path (client, client->doc, result, &realpath, &rc);
1549 pthread_cleanup_pop (1);
1551 else
1552 (void)xml_resolve_path (client, client->doc, (unsigned char *)line,
1553 &realpath, &rc);
1555 if (!rc)
1557 char *tmp = strv_join ("\t", realpath);
1559 strv_free (realpath);
1560 if (!tmp)
1561 return send_error (ctx, GPG_ERR_ENOMEM);
1563 pthread_cleanup_push ((void *)xfree, tmp);
1564 rc = xfer_data (ctx, tmp, strlen (tmp));
1565 pthread_cleanup_pop (1);
1568 return send_error (ctx, rc);
1571 static void
1572 list_command_cleanup1 (void *arg)
1574 if (arg)
1575 string_free ((struct string_s *) arg, 1);
1578 static gpg_error_t
1579 parse_list_opt_recurse (void *data, void *value)
1581 struct client_s *client = data;
1583 client->opts |= OPT_LIST_RECURSE;
1584 return 0;
1587 static gpg_error_t
1588 parse_opt_verbose (void *data, void *value)
1590 struct client_s *client = data;
1592 client->opts |= OPT_VERBOSE;
1593 return 0;
1596 static gpg_error_t
1597 list_path_once (struct client_s *client, char *line,
1598 struct element_list_s *elements, struct string_s *result)
1600 gpg_error_t rc;
1602 rc = xml_create_path_list (client, client->doc, NULL, elements, line, 0);
1603 if (rc == GPG_ERR_ELOOP || rc == GPG_ERR_EACCES)
1604 rc = 0;
1606 if (!rc)
1608 int total = slist_length (elements->list);
1610 if (total)
1612 int i;
1614 for (i = 0; i < total; i++)
1616 char *tmp = slist_nth_data (elements->list, i);
1618 string_append_printf (result, "%s%s", tmp,
1619 i + 1 == total ? "" : "\n");
1622 else
1623 rc = GPG_ERR_NO_DATA;
1626 return rc;
1629 static gpg_error_t
1630 do_list (assuan_context_t ctx, char *line)
1632 struct client_s *client = assuan_get_pointer (ctx);
1633 gpg_error_t rc = GPG_ERR_NO_DATA;
1634 struct element_list_s *elements = NULL;
1636 if (!line || !*line)
1638 struct string_s *str = string_new (NULL);
1639 xmlNodePtr n;
1641 if (!str)
1642 return GPG_ERR_ENOMEM;
1644 pthread_cleanup_push ((void *)list_command_cleanup1, str);
1645 n = xmlDocGetRootElement (client->doc);
1646 for (n = n->children; n; n = n->next)
1648 xmlChar *name;
1650 if (n->type != XML_ELEMENT_NODE)
1651 continue;
1653 name = xmlGetProp (n, (xmlChar *)"_name");
1654 if (!name)
1656 rc = GPG_ERR_ENOMEM;
1657 break;
1660 elements = xcalloc (1, sizeof (struct element_list_s));
1661 if (!elements)
1663 xmlFree (name);
1664 rc = GPG_ERR_ENOMEM;
1665 break;
1668 elements->prefix = string_new (NULL);
1669 if (!elements->prefix)
1671 xmlFree (name);
1672 xml_free_element_list (elements);
1673 rc = GPG_ERR_ENOMEM;
1674 break;
1677 elements->recurse = client->opts & OPT_LIST_RECURSE;
1678 elements->root_only = !elements->recurse;
1679 pthread_cleanup_push ((void *)xml_free_element_list, elements);
1680 rc = list_path_once (client, (char *)name, elements, str);
1681 xmlFree (name);
1682 pthread_cleanup_pop (1);
1683 if (rc)
1684 break;
1686 if (n->next)
1687 string_append (str, "\n");
1690 if (!rc)
1691 rc = xfer_data (ctx, str->str, str->len);
1693 pthread_cleanup_pop (1);
1694 return rc;
1697 elements = xcalloc (1, sizeof (struct element_list_s));
1698 if (!elements)
1699 return GPG_ERR_ENOMEM;
1701 elements->prefix = string_new (NULL);
1702 if (!elements->prefix)
1704 xml_free_element_list (elements);
1705 return GPG_ERR_ENOMEM;
1708 elements->recurse = client->opts & OPT_LIST_RECURSE;
1709 pthread_cleanup_push ((void *)xml_free_element_list, elements);
1710 struct string_s *str = string_new (NULL);
1711 pthread_cleanup_push ((void *)list_command_cleanup1, str);
1712 rc = list_path_once (client, line, elements, str);
1713 if (!rc)
1714 rc = xfer_data (ctx, str->str, str->len);
1716 pthread_cleanup_pop (1);
1717 pthread_cleanup_pop (1);
1718 return rc;
1721 static gpg_error_t
1722 list_command (assuan_context_t ctx, char *line)
1724 struct client_s *client = assuan_get_pointer (ctx);
1725 gpg_error_t rc;
1726 struct argv_s *args[] = {
1727 &(struct argv_s) {"recurse", OPTION_TYPE_NOARG, parse_list_opt_recurse},
1728 &(struct argv_s) {"inquire", OPTION_TYPE_NOARG, parse_opt_inquire},
1729 /* These are deprecated but kept for backward compatibility with older
1730 * clients. */
1731 &(struct argv_s) {"verbose", OPTION_TYPE_NOARG, NULL},
1732 &(struct argv_s) {"with-target", OPTION_TYPE_NOARG, NULL},
1733 &(struct argv_s) {"all", OPTION_TYPE_NOARG, parse_list_opt_recurse},
1734 &(struct argv_s) {"no-recurse", OPTION_TYPE_NOARG, NULL},
1735 NULL
1738 if (disable_list_and_dump == 1)
1739 return send_error (ctx, GPG_ERR_NOT_IMPLEMENTED);
1741 rc = parse_options (&line, args, client, 1);
1742 if (!rc && (client->opts & OPT_INQUIRE) && line && *line)
1743 rc = GPG_ERR_SYNTAX;
1744 if (rc)
1745 return send_error (ctx, rc);
1747 if (client->opts & OPT_INQUIRE)
1749 unsigned char *result;
1750 size_t len;
1752 rc = assuan_inquire (ctx, "DATA", &result, &len, 0);
1753 if (rc)
1754 return send_error (ctx, rc);
1756 pthread_cleanup_push ((void *)xfree, result);
1757 rc = do_list (ctx, (char *)result);
1758 pthread_cleanup_pop (1);
1760 else
1761 rc = do_list (ctx, line);
1763 return send_error (ctx, rc);
1766 #define RESUMABLE_ERROR(rc) (rc == GPG_ERR_ELOOP || rc == GPG_ERR_EACCES \
1767 || rc == GPG_ERR_ELEMENT_NOT_FOUND || !rc)
1769 * args[0] - element path
1771 static gpg_error_t
1772 attribute_list (assuan_context_t ctx, char **args)
1774 struct client_s *client = assuan_get_pointer (ctx);
1775 char **attrlist = NULL;
1776 int i = 0;
1777 int target = 0;
1778 xmlAttrPtr a;
1779 xmlNodePtr n, an, r;
1780 char *line;
1781 gpg_error_t rc;
1782 struct xml_request_s *req;
1784 if (!args || !args[0] || !*args[0])
1785 return GPG_ERR_SYNTAX;
1787 rc = xml_new_request (client, args[0], XML_CMD_ATTR_LIST, &req);
1788 if (rc)
1789 return rc;
1791 n = xml_find_elements (client, req, xmlDocGetRootElement (req->doc), &rc);
1792 xml_free_request (req);
1793 if (rc)
1794 return rc;
1796 again:
1797 for (a = n->properties; a; a = a->next)
1799 char **pa;
1801 if (target && xml_reserved_attribute ((char *)a->name))
1802 continue;
1804 pa = xrealloc (attrlist, (i + 2) * sizeof (char *));
1805 if (!pa)
1807 if (attrlist)
1808 strv_free (attrlist);
1810 log_write ("%s(%i): %s", __FILE__, __LINE__,
1811 pwmd_strerror (GPG_ERR_ENOMEM));
1812 return GPG_ERR_ENOMEM;
1815 attrlist = pa;
1816 an = a->children;
1817 attrlist[i] = str_asprintf ("%s %s", (char *) a->name, an && an->content
1818 ? (char *)an->content : "");
1820 if (!attrlist[i])
1822 strv_free (attrlist);
1823 log_write ("%s(%i): %s", __FILE__, __LINE__,
1824 pwmd_strerror (GPG_ERR_ENOMEM));
1825 return GPG_ERR_ENOMEM;
1828 attrlist[++i] = NULL;
1831 if (!attrlist)
1832 return GPG_ERR_NO_DATA;
1834 if (!target)
1836 r = xml_resolve_path (client, client->doc, (xmlChar *)args[0], NULL, &rc);
1837 if (!RESUMABLE_ERROR (rc))
1839 strv_free (attrlist);
1840 return rc;
1842 else if (!rc && r != n)
1844 target = 1;
1845 n = r;
1846 goto again;
1849 rc = 0;
1852 line = strv_join ("\n", attrlist);
1853 if (!line)
1855 log_write ("%s(%i): %s", __FILE__, __LINE__,
1856 pwmd_strerror (GPG_ERR_ENOMEM));
1857 strv_free (attrlist);
1858 return GPG_ERR_ENOMEM;
1861 pthread_cleanup_push ((void *)xfree, line);
1862 pthread_cleanup_push ((void *)req_cleanup, attrlist);
1863 rc = xfer_data (ctx, line, strlen (line));
1864 pthread_cleanup_pop (1);
1865 pthread_cleanup_pop (1);
1866 return rc;
1870 * args[0] - attribute
1871 * args[1] - element path
1873 static gpg_error_t
1874 attribute_delete (struct client_s *client, char **args)
1876 gpg_error_t rc;
1877 xmlNodePtr n;
1879 if (!args || !args[0] || !*args[0] || !args[1] || !*args[1])
1880 return GPG_ERR_SYNTAX;
1882 if (!strcmp (args[0], "_name") || !strcmp (args[0], "target"))
1883 return GPG_ERR_INV_ATTR;
1885 if (!xml_reserved_attribute (args[0]))
1886 n = xml_resolve_path (client, client->doc, (xmlChar *)args[1], NULL, &rc);
1887 else
1889 struct xml_request_s *req;
1891 rc = xml_new_request (client, args[1], XML_CMD_ATTR, &req);
1892 if (rc)
1893 return rc;
1895 n = xml_find_elements (client, req, xmlDocGetRootElement (req->doc), &rc);
1896 xml_free_request (req);
1899 if (!rc)
1900 rc = xml_is_element_owner (client, n);
1902 if (!rc)
1903 rc = xml_delete_attribute (client, n, (xmlChar *) args[0]);
1905 return rc;
1909 * Creates the "target" attribute. When other commands encounter an element
1910 * with this attribute they follow the "target" after appending remaining
1911 * elements from the original element path to the target. The exception is the
1912 * ATTR command that operates on the element itself (for reserved attribute
1913 * names) and not the target.
1915 * If the source element path doesn't exist when using 'ATTR SET target', it is
1916 * created, but the destination element path must exist. This is simliar to the
1917 * ls(1) command: ln -s src dst.
1919 * args[0] - source element path
1920 * args[1] - destination element path
1922 static gpg_error_t
1923 set_target_attribute (struct client_s *client, char **args)
1925 struct xml_request_s *req = NULL;
1926 char **src, **dst;
1927 gpg_error_t rc;
1928 xmlNodePtr n;
1930 if (!args || !args[0] || !args[1])
1931 return GPG_ERR_SYNTAX;
1933 src = str_split (args[0], "\t", 0);
1934 if (!src)
1935 return GPG_ERR_SYNTAX;
1937 if (!xml_valid_element_path (src, 0))
1939 strv_free (src);
1940 return GPG_ERR_INV_VALUE;
1943 dst = str_split (args[1], "\t", 0);
1944 if (!dst)
1946 strv_free (src);
1947 return GPG_ERR_SYNTAX;
1950 // Be sure the destination element path exists. */
1951 rc = xml_new_request (client, args[1], XML_CMD_NONE, &req);
1952 if (rc)
1953 goto fail;
1955 n = xml_find_elements (client, req, xmlDocGetRootElement (req->doc), &rc);
1956 if (rc && rc != GPG_ERR_EACCES)
1957 goto fail;
1959 xml_free_request (req);
1960 req = NULL;
1962 if (!strcmp (args[0], args[1]))
1964 rc = GPG_ERR_EEXIST;
1965 goto fail;
1968 rc = xml_new_request (client, args[0], XML_CMD_ATTR_TARGET, &req);
1969 if (rc)
1970 goto fail;
1972 n = xml_find_elements (client, req, xmlDocGetRootElement (req->doc), &rc);
1973 if (rc && rc != GPG_ERR_EACCES)
1974 goto fail;
1976 if (!rc)
1978 rc = xml_add_attribute (client, n, "target", args[1]);
1979 if (!rc)
1980 rc = xml_unlink_node (client, n->children);
1983 fail:
1984 strv_free (src);
1985 strv_free (dst);
1986 xml_free_request (req);
1987 return rc;
1991 * args[0] - attribute
1992 * args[1] - element path
1994 static gpg_error_t
1995 attribute_get (assuan_context_t ctx, char **args)
1997 struct client_s *client = assuan_get_pointer (ctx);
1998 xmlNodePtr n;
1999 xmlChar *a;
2000 gpg_error_t rc;
2001 struct xml_request_s *req;
2003 if (!args || !args[0] || !*args[0] || !args[1] || !*args[1])
2004 return GPG_ERR_SYNTAX;
2006 if (!xml_reserved_attribute (args[0]))
2007 n = xml_resolve_path (client, client->doc, (xmlChar *)args[1], NULL, &rc);
2008 else
2010 rc = xml_new_request (client, args[1], XML_CMD_ATTR, &req);
2011 if (rc)
2012 return rc;
2014 n = xml_find_elements (client, req, xmlDocGetRootElement (req->doc), &rc);
2015 xml_free_request (req);
2018 if (rc)
2019 return rc;
2021 a = xmlGetProp (n, (xmlChar *) args[0]);
2022 if (!a)
2023 return GPG_ERR_NOT_FOUND;
2025 pthread_cleanup_push ((void *)xmlFree, a);
2027 if (*a)
2028 rc = xfer_data (ctx, (char *) a, xmlStrlen (a));
2029 else
2030 rc = GPG_ERR_NO_DATA;
2032 pthread_cleanup_pop (1);
2033 return rc;
2037 * args[0] - attribute
2038 * args[1] - element path
2039 * args[2] - value
2041 static gpg_error_t
2042 attribute_set (struct client_s *client, char **args)
2044 struct xml_request_s *req;
2045 gpg_error_t rc;
2046 xmlNodePtr n;
2048 if (!args || !args[0] || !args[1])
2049 return GPG_ERR_SYNTAX;
2052 * Reserved attribute names.
2054 if (!strcmp (args[0], "_name")) // Use the RENAME command instead
2055 return GPG_ERR_INV_ATTR;
2056 else if (!strcmp (args[0], "target"))
2057 return set_target_attribute (client, args + 1);
2058 else if (!xml_valid_attribute (args[0]))
2059 return GPG_ERR_INV_VALUE;
2061 if (!xml_valid_attribute_value (args[2]))
2062 return GPG_ERR_INV_VALUE;
2064 if (!xml_reserved_attribute (args[0]))
2065 n = xml_resolve_path (client, client->doc, (xmlChar *)args[1], NULL, &rc);
2066 else
2068 rc = xml_new_request (client, args[1], XML_CMD_ATTR, &req);
2069 if (rc)
2070 return rc;
2072 n = xml_find_elements (client, req, xmlDocGetRootElement (req->doc), &rc);
2073 xml_free_request (req);
2076 if (!rc)
2077 rc = xml_is_element_owner (client, n);
2079 if (!rc)
2080 rc = xml_add_attribute (client, n, args[0], args[2]);
2082 return rc;
2086 * req[0] - command
2087 * req[1] - attribute name or element path if command is LIST
2088 * req[2] - element path
2089 * req[2] - element path or value
2092 static gpg_error_t
2093 do_attr (assuan_context_t ctx, char *line)
2095 struct client_s *client = assuan_get_pointer (ctx);
2096 gpg_error_t rc = 0;
2097 char **req;
2099 req = str_split (line, " ", 4);
2100 if (!req || !req[0] || !req[1])
2102 strv_free (req);
2103 return GPG_ERR_SYNTAX;
2106 pthread_cleanup_push ((void *)req_cleanup, req);
2108 if (strcasecmp (req[0], "SET") == 0)
2109 rc = attribute_set (client, req + 1);
2110 else if (strcasecmp (req[0], "GET") == 0)
2111 rc = attribute_get (ctx, req + 1);
2112 else if (strcasecmp (req[0], "DELETE") == 0)
2113 rc = attribute_delete (client, req + 1);
2114 else if (strcasecmp (req[0], "LIST") == 0)
2115 rc = attribute_list (ctx, req + 1);
2116 else
2117 rc = GPG_ERR_SYNTAX;
2119 client->flags &= ~(FLAG_ACL_IGNORE|FLAG_ACL_ERROR);
2120 pthread_cleanup_pop (1);
2121 return rc;
2124 static gpg_error_t
2125 attr_command (assuan_context_t ctx, char *line)
2127 struct client_s *client = assuan_get_pointer (ctx);
2128 gpg_error_t rc;
2129 struct argv_s *args[] = {
2130 &(struct argv_s) {"inquire", OPTION_TYPE_NOARG, parse_opt_inquire},
2131 NULL
2134 rc = parse_options (&line, args, client, 1);
2135 if (!rc && (client->opts & OPT_INQUIRE) && line && *line)
2136 rc = GPG_ERR_SYNTAX;
2137 if (rc)
2138 return send_error (ctx, rc);
2140 if (client->opts & OPT_INQUIRE)
2142 unsigned char *result;
2143 size_t len;
2145 rc = assuan_inquire (ctx, "DATA", &result, &len, 0);
2146 if (rc)
2147 return send_error (ctx, rc);
2149 pthread_cleanup_push ((void *)xfree, result);
2150 rc = do_attr (ctx, (char *)result);
2151 pthread_cleanup_pop (1);
2153 else
2154 rc = do_attr (ctx, line);
2156 return send_error (ctx, rc);
2159 static gpg_error_t
2160 parse_iscached_opt_lock (void *data, void *value)
2162 struct client_s *client = data;
2164 (void) value;
2165 client->opts |= OPT_LOCK;
2166 return 0;
2169 static gpg_error_t
2170 iscached_command (assuan_context_t ctx, char *line)
2172 struct client_s *client = assuan_get_pointer (ctx);
2173 gpg_error_t rc;
2174 struct argv_s *args[] = {
2175 &(struct argv_s) {"lock", OPTION_TYPE_NOARG, parse_iscached_opt_lock},
2176 NULL
2179 if (!line || !*line)
2180 return send_error (ctx, GPG_ERR_SYNTAX);
2182 rc = parse_options (&line, args, client, 1);
2183 if (rc)
2184 return send_error (ctx, rc);
2185 else if (!valid_filename (line))
2186 return send_error (ctx, GPG_ERR_INV_VALUE);
2188 rc = cache_iscached (line, NULL);
2189 if (client->opts & OPT_LOCK
2190 && (!rc || gpg_err_code (rc) == GPG_ERR_NO_DATA))
2192 unsigned char md5file[16];
2193 gpg_error_t trc = rc;
2195 gcry_md_hash_buffer (GCRY_MD_MD5, md5file, line, strlen (line));
2196 if (memcmp (md5file, client->md5file, 16))
2197 cleanup_client (client);
2199 memcpy (client->md5file, md5file, 16);
2200 rc = do_lock (client, 1);
2201 if (!rc)
2202 rc = trc;
2205 return send_error (ctx, rc);
2208 static gpg_error_t
2209 clearcache_command (assuan_context_t ctx, char *line)
2211 gpg_error_t rc = 0, all_rc = 0;
2212 unsigned char md5file[16];
2213 int i;
2214 int t;
2215 int all = 0;
2216 struct client_thread_s *once = NULL;
2218 cache_lock ();
2219 MUTEX_LOCK (&cn_mutex);
2220 pthread_cleanup_push ((void *)cleanup_mutex_cb, &cn_mutex);
2222 if (!line || !*line)
2223 all = 1;
2225 t = slist_length (cn_thread_list);
2227 for (i = 0; i < t; i++)
2229 struct client_thread_s *thd = slist_nth_data (cn_thread_list, i);
2230 assuan_peercred_t peer;
2232 if (!thd->cl)
2233 continue;
2235 /* Lock each connected clients' file mutex to prevent any other client
2236 * from accessing the cache entry (the file mutex is locked upon
2237 * command startup). The cache for the entry is not cleared if the
2238 * file mutex is locked by another client to prevent this function
2239 * from blocking.
2241 if (all)
2243 if (thd->cl->filename)
2245 rc = do_validate_peer (ctx, thd->cl->filename, &peer);
2246 all_rc = !all_rc ? rc : all_rc;
2247 if (rc)
2249 rc = 0;
2250 continue;
2254 rc = cache_lock_mutex (thd->cl->ctx, thd->cl->md5file, -1, 0, -1);
2255 if (gpg_err_code (rc) == GPG_ERR_LOCKED)
2257 if (pthread_equal (pthread_self (), thd->tid))
2258 rc = 0;
2259 else
2261 if (!thd->cl->filename ||
2262 cache_iscached (thd->cl->filename,
2263 NULL) == GPG_ERR_NO_DATA)
2265 rc = 0;
2266 continue;
2269 cache_defer_clear (thd->cl->md5file);
2272 else if (gpg_err_code (rc) == GPG_ERR_NO_DATA)
2274 rc = 0;
2275 continue;
2278 if (!rc)
2280 rc = cache_clear (thd->cl->md5file);
2281 cache_unlock_mutex (thd->cl->md5file, 0);
2284 if (rc)
2285 all_rc = rc;
2287 rc = 0;
2289 /* A single data filename was specified. Lock only this data file
2290 * mutex and free the cache entry. */
2291 else
2293 gcry_md_hash_buffer (GCRY_MD_MD5, md5file, line, strlen (line));
2294 rc = do_validate_peer (ctx, line, &peer);
2296 if (!rc && !memcmp (thd->cl->md5file, md5file, sizeof (md5file)))
2298 rc = cache_lock_mutex (thd->cl->ctx, thd->cl->md5file, -1, 0,
2299 -1);
2300 if (gpg_err_code (rc) == GPG_ERR_LOCKED)
2302 if (pthread_equal (pthread_self (), thd->tid))
2303 rc = 0;
2306 if (!rc)
2308 once = thd;
2309 rc = cache_clear (thd->cl->md5file);
2310 cache_unlock_mutex (thd->cl->md5file, 0);
2312 else
2314 cache_defer_clear (thd->cl->md5file);
2317 break;
2322 /* Only connected clients' cache entries have been cleared. Now clear any
2323 * remaining cache entries without clients but only if there wasn't an
2324 * error from above since this would defeat the locking check of the
2325 * remaining entries. */
2326 if (!all_rc && all)
2328 cache_clear (NULL);
2331 /* No clients are using the specified file. */
2332 else if (!all_rc && !rc && !once)
2334 gcry_md_hash_buffer (GCRY_MD_MD5, md5file, line, strlen (line));
2335 rc = cache_clear (md5file);
2338 /* Release the connection mutex. */
2339 pthread_cleanup_pop (1);
2340 cache_unlock ();
2342 if (!rc)
2343 send_status_all (STATUS_CACHE, NULL);
2345 /* One or more files were locked while clearing all cache entries. */
2346 if (all_rc)
2347 rc = all_rc;
2349 return send_error (ctx, rc);
2352 static gpg_error_t
2353 cachetimeout_command (assuan_context_t ctx, char *line)
2355 int timeout;
2356 char **req = str_split (line, " ", 0);
2357 char *p;
2358 gpg_error_t rc = 0;
2359 assuan_peercred_t peer;
2361 if (!req || !*req || !req[1])
2363 strv_free (req);
2364 return send_error (ctx, GPG_ERR_SYNTAX);
2367 errno = 0;
2368 timeout = (int) strtol (req[1], &p, 10);
2369 if (errno != 0 || *p || timeout < -1)
2371 strv_free (req);
2372 return send_error (ctx, GPG_ERR_SYNTAX);
2375 rc = do_validate_peer (ctx, req[0], &peer);
2376 if (!rc)
2378 unsigned char md5file[16];
2380 gcry_md_hash_buffer (GCRY_MD_MD5, md5file, req[0], strlen (req[0]));
2381 rc = cache_set_timeout (md5file, timeout);
2382 if (!rc || gpg_err_code (rc) == GPG_ERR_NOT_FOUND)
2384 rc = 0;
2385 MUTEX_LOCK (&rcfile_mutex);
2386 config_set_int_param (&global_config, req[0], "cache_timeout",
2387 req[1]);
2388 MUTEX_UNLOCK (&rcfile_mutex);
2392 strv_free (req);
2393 return send_error (ctx, rc);
2396 static gpg_error_t
2397 dump_command (assuan_context_t ctx, char *line)
2399 xmlChar *xml;
2400 int len;
2401 struct client_s *client = assuan_get_pointer (ctx);
2402 gpg_error_t rc;
2404 if (disable_list_and_dump == 1)
2405 return send_error (ctx, GPG_ERR_NOT_IMPLEMENTED);
2407 if (line && *line)
2408 return send_error (ctx, GPG_ERR_SYNTAX);
2410 rc = peer_is_invoker(client);
2411 if (rc)
2412 return send_error (ctx, rc);
2414 xmlDocDumpFormatMemory (client->doc, &xml, &len, 1);
2416 if (!xml)
2418 log_write ("%s(%i): %s", __FILE__, __LINE__,
2419 pwmd_strerror (GPG_ERR_ENOMEM));
2420 return send_error (ctx, GPG_ERR_ENOMEM);
2423 pthread_cleanup_push ((void *)xmlFree, xml);
2424 rc = xfer_data (ctx, (char *) xml, len);
2425 pthread_cleanup_pop (1);
2426 return send_error (ctx, rc);
2429 static gpg_error_t
2430 getconfig_command (assuan_context_t ctx, char *line)
2432 struct client_s *client = assuan_get_pointer (ctx);
2433 gpg_error_t rc = 0;
2434 char filename[255] = { 0 }, param[747] = { 0 };
2435 char *p, *tmp = NULL, *fp = client->filename, *paramp = line;
2437 if (!line || !*line)
2438 return send_error (ctx, GPG_ERR_SYNTAX);
2440 if (strchr (line, ' '))
2442 sscanf (line, " %254[^ ] %746c", filename, param);
2443 paramp = param;
2444 fp = filename;
2447 if (fp && !valid_filename (fp))
2448 return send_error (ctx, GPG_ERR_INV_VALUE);
2450 paramp = str_down (paramp);
2451 if (!strcmp (paramp, "passphrase"))
2452 return send_error (ctx, GPG_ERR_UNKNOWN_OPTION);
2454 p = config_get_value (fp ? fp : "global", paramp);
2455 if (!p)
2456 return send_error (ctx, GPG_ERR_UNKNOWN_OPTION);
2458 tmp = expand_homedir (p);
2459 xfree (p);
2460 if (!tmp)
2462 log_write ("%s(%i): %s", __FILE__, __LINE__,
2463 pwmd_strerror (GPG_ERR_ENOMEM));
2464 return send_error (ctx, GPG_ERR_ENOMEM);
2467 p = tmp;
2468 pthread_cleanup_push ((void *)xfree, p);
2469 rc = xfer_data (ctx, p, strlen (p));
2470 pthread_cleanup_pop (1);
2471 return send_error (ctx, rc);
2474 struct xpath_s
2476 xmlXPathContextPtr xp;
2477 xmlXPathObjectPtr result;
2478 xmlBufferPtr buf;
2479 char **req;
2482 static void
2483 xpath_command_cleanup (void *arg)
2485 struct xpath_s *xpath = arg;
2487 if (!xpath)
2488 return;
2490 req_cleanup (xpath->req);
2492 if (xpath->buf)
2493 xmlBufferFree (xpath->buf);
2495 if (xpath->result)
2496 xmlXPathFreeObject (xpath->result);
2498 if (xpath->xp)
2499 xmlXPathFreeContext (xpath->xp);
2502 static gpg_error_t
2503 do_xpath (assuan_context_t ctx, char *line)
2505 gpg_error_t rc;
2506 struct client_s *client = assuan_get_pointer (ctx);
2507 struct xpath_s _x = { 0 };
2508 struct xpath_s *xpath = &_x;
2510 if (!line || !*line)
2511 return GPG_ERR_SYNTAX;
2513 if ((xpath->req = str_split (line, "\t", 2)) == NULL)
2515 if (strv_printf (&xpath->req, "%s", line) == 0)
2516 return GPG_ERR_ENOMEM;
2519 xpath->xp = xmlXPathNewContext (client->doc);
2520 if (!xpath->xp)
2522 rc = GPG_ERR_BAD_DATA;
2523 goto fail;
2526 xpath->result =
2527 xmlXPathEvalExpression ((xmlChar *) xpath->req[0], xpath->xp);
2528 if (!xpath->result)
2530 rc = GPG_ERR_BAD_DATA;
2531 goto fail;
2534 if (xmlXPathNodeSetIsEmpty (xpath->result->nodesetval))
2536 rc = GPG_ERR_ELEMENT_NOT_FOUND;
2537 goto fail;
2540 rc = xml_recurse_xpath_nodeset (client, client->doc,
2541 xpath->result->nodesetval,
2542 (xmlChar *) xpath->req[1], &xpath->buf, 0,
2543 NULL);
2544 if (rc)
2545 goto fail;
2546 else if (!xpath->req[1] && !xmlBufferLength (xpath->buf))
2548 rc = GPG_ERR_NO_DATA;
2549 goto fail;
2551 else if (xpath->req[1])
2553 rc = 0;
2554 goto fail;
2557 pthread_cleanup_push ((void *)xpath_command_cleanup, &xpath);
2558 rc = xfer_data (ctx, (char *) xmlBufferContent (xpath->buf),
2559 xmlBufferLength (xpath->buf));
2560 pthread_cleanup_pop (0);
2561 fail:
2562 xpath_command_cleanup (xpath);
2563 return rc;
2566 static gpg_error_t
2567 xpath_command (assuan_context_t ctx, char *line)
2569 struct client_s *client = assuan_get_pointer (ctx);
2570 gpg_error_t rc;
2571 struct argv_s *args[] = {
2572 &(struct argv_s) {"inquire", OPTION_TYPE_NOARG, parse_opt_inquire},
2573 NULL
2576 if (disable_list_and_dump == 1)
2577 return send_error (ctx, GPG_ERR_NOT_IMPLEMENTED);
2579 rc = peer_is_invoker(client);
2580 if (rc)
2581 return send_error (ctx, rc);
2583 rc = parse_options (&line, args, client, 1);
2584 if (!rc && (client->opts & OPT_INQUIRE) && line && *line)
2585 rc = GPG_ERR_SYNTAX;
2586 if (rc)
2587 return send_error (ctx, rc);
2589 if (client->opts & OPT_INQUIRE)
2591 unsigned char *result;
2592 size_t len;
2594 rc = assuan_inquire (ctx, "DATA", &result, &len, 0);
2595 if (rc)
2596 return send_error (ctx, rc);
2598 pthread_cleanup_push ((void *)xfree, result);
2599 rc = do_xpath (ctx, (char *)result);
2600 pthread_cleanup_pop (1);
2602 else
2603 rc = do_xpath (ctx, line);
2605 return send_error (ctx, rc);
2608 static gpg_error_t
2609 do_xpathattr (assuan_context_t ctx, char *line)
2611 struct client_s *client = assuan_get_pointer (ctx);
2612 gpg_error_t rc;
2613 char **req = NULL;
2614 int cmd = 0; //SET
2615 struct xpath_s _x = { 0 };
2616 struct xpath_s *xpath = &_x;
2618 if (!line || !*line)
2619 return GPG_ERR_SYNTAX;
2621 if ((req = str_split (line, " ", 3)) == NULL)
2622 return GPG_ERR_ENOMEM;
2624 if (!req[0])
2626 rc = GPG_ERR_SYNTAX;
2627 goto fail;
2630 if (!strcasecmp (req[0], "SET"))
2631 cmd = 0;
2632 else if (!strcasecmp (req[0], "DELETE"))
2633 cmd = 1;
2634 else
2636 rc = GPG_ERR_SYNTAX;
2637 goto fail;
2640 if (!req[1] || !req[2])
2642 rc = GPG_ERR_SYNTAX;
2643 goto fail;
2646 if ((xpath->req = str_split (req[2], "\t", 3)) == NULL)
2648 rc = GPG_ERR_ENOMEM;
2649 goto fail;
2652 if (!xpath->req[0] || (!xpath->req[1] && !cmd) || (xpath->req[1] && cmd))
2654 rc = GPG_ERR_SYNTAX;
2655 goto fail;
2658 xpath->xp = xmlXPathNewContext (client->doc);
2659 if (!xpath->xp)
2661 rc = GPG_ERR_BAD_DATA;
2662 goto fail;
2665 xpath->result = xmlXPathEvalExpression ((xmlChar *) xpath->req[0], xpath->xp);
2666 if (!xpath->result)
2668 rc = GPG_ERR_BAD_DATA;
2669 goto fail;
2672 if (xmlXPathNodeSetIsEmpty (xpath->result->nodesetval))
2674 rc = GPG_ERR_ELEMENT_NOT_FOUND;
2675 goto fail;
2678 rc = xml_recurse_xpath_nodeset (client, client->doc,
2679 xpath->result->nodesetval,
2680 (xmlChar *) xpath->req[1], &xpath->buf, cmd,
2681 (xmlChar *) req[1]);
2683 fail:
2684 xpath_command_cleanup (xpath);
2685 strv_free (req);
2686 return rc;
2689 /* XPATHATTR SET|DELETE <name> <expression>[<TAB>[value]] */
2690 static gpg_error_t
2691 xpathattr_command (assuan_context_t ctx, char *line)
2693 struct client_s *client = assuan_get_pointer (ctx);
2694 gpg_error_t rc;
2695 struct argv_s *args[] = {
2696 &(struct argv_s) {"inquire", OPTION_TYPE_NOARG, parse_opt_inquire},
2697 NULL
2700 if (disable_list_and_dump == 1)
2701 return send_error (ctx, GPG_ERR_NOT_IMPLEMENTED);
2703 rc = peer_is_invoker(client);
2704 if (rc)
2705 return send_error (ctx, rc);
2707 rc = parse_options (&line, args, client, 1);
2708 if (!rc && (client->opts & OPT_INQUIRE) && line && *line)
2709 rc = GPG_ERR_SYNTAX;
2710 if (rc)
2711 return send_error (ctx, rc);
2713 if (client->opts & OPT_INQUIRE)
2715 unsigned char *result;
2716 size_t len;
2718 rc = assuan_inquire (ctx, "DATA", &result, &len, 0);
2719 if (rc)
2720 return send_error (ctx, rc);
2722 pthread_cleanup_push ((void *)xfree, result);
2723 rc = do_xpathattr (ctx, (char *)result);
2724 pthread_cleanup_pop (1);
2726 else
2727 rc = do_xpathattr (ctx, line);
2729 return send_error (ctx, rc);
2732 static gpg_error_t
2733 do_import (struct client_s *client, const char *root_element,
2734 unsigned char *content)
2736 xmlDocPtr doc = NULL;
2737 xmlNodePtr n = NULL, root;
2738 gpg_error_t rc;
2739 struct string_s *str = NULL;
2740 struct xml_request_s *req = NULL;
2742 if (!content || !*content)
2743 return GPG_ERR_SYNTAX;
2745 if (root_element)
2747 rc = xml_new_request (client, root_element, XML_CMD_STORE, &req);
2748 if (rc)
2750 xfree (content);
2751 return rc;
2754 if (!xml_valid_element_path (req->args, 0))
2756 xml_free_request (req);
2757 xfree (content);
2758 return GPG_ERR_INV_VALUE;
2762 str = string_new_content ((char *)content);
2763 str = string_prepend (str, "<pwmd>");
2764 str = string_append (str, "</pwmd>");
2765 doc = xmlReadDoc ((xmlChar *) str->str, NULL, "UTF-8", XML_PARSE_NOBLANKS);
2766 string_free (str, 1);
2767 if (!doc)
2769 rc = GPG_ERR_BAD_DATA;
2770 goto fail;
2773 root = xmlDocGetRootElement (doc);
2774 root = root->children;
2775 if (root->type != XML_ELEMENT_NODE)
2777 rc = GPG_ERR_BAD_DATA;
2778 goto fail;
2781 rc = xml_validate_import (client, root);
2782 if (rc)
2783 goto fail;
2785 if (req)
2787 /* Create the new specified root element path, if needed. */
2788 n = xml_find_elements (client, req, xmlDocGetRootElement (req->doc),
2789 &rc);
2790 if (rc)
2791 goto fail;
2793 /* Overwrite the children of the specified root element path. */
2794 xmlUnlinkNode (n->children);
2795 xmlFreeNodeList (n->children);
2796 n->children = NULL;
2798 else
2799 n = xmlDocGetRootElement (client->doc);
2801 if (n)
2803 xmlNodePtr copy;
2804 xmlChar *name = xml_attribute_value (root, (xmlChar *)"_name");
2806 if (!name)
2807 rc = GPG_ERR_BAD_DATA;
2808 else if (!req)
2810 /* No --root argument passed. Overwrite the current documents' root
2811 * element matching the root element of the imported data. */
2812 xml_free_request (req);
2813 req = NULL;
2814 rc = xml_new_request (client, (char *)name, XML_CMD_DELETE, &req);
2815 xmlFree (name);
2816 if (!rc)
2818 xmlNodePtr tmp;
2820 tmp = xml_find_elements (client, req,
2821 xmlDocGetRootElement (req->doc), &rc);
2822 if (rc && rc != GPG_ERR_ELEMENT_NOT_FOUND)
2823 goto fail;
2825 if (!rc)
2827 xmlUnlinkNode (tmp);
2828 xmlFreeNodeList (tmp);
2831 rc = 0;
2835 if (!rc)
2837 copy = xmlCopyNodeList (root);
2838 if (!copy)
2839 rc = GPG_ERR_ENOMEM;
2840 else
2842 n = xmlAddChildList (n, copy);
2843 if (!n)
2844 rc = GPG_ERR_ENOMEM;
2849 if (!rc && n && n->parent)
2850 rc = xml_update_element_mtime (client, n->parent);
2852 fail:
2853 xml_free_request (req);
2855 if (doc)
2856 xmlFreeDoc (doc);
2858 return rc;
2861 static gpg_error_t
2862 parse_import_opt_root (void *data, void *value)
2864 struct client_s *client = data;
2866 client->import_root = str_dup (value);
2867 return client->import_root ? 0 : GPG_ERR_ENOMEM;
2870 static gpg_error_t
2871 import_command (assuan_context_t ctx, char *line)
2873 gpg_error_t rc;
2874 struct client_s *client = assuan_get_pointer (ctx);
2875 unsigned char *result;
2876 size_t len;
2877 struct argv_s *args[] = {
2878 &(struct argv_s) {"root", OPTION_TYPE_ARG, parse_import_opt_root},
2879 NULL
2882 xfree (client->import_root);
2883 client->import_root = NULL;
2884 rc = parse_options (&line, args, client, 0);
2885 if (rc)
2886 return send_error (ctx, rc);
2888 rc = assuan_inquire (ctx, "DATA", &result, &len, 0);
2889 if (rc)
2891 xfree (client->import_root);
2892 client->import_root = NULL;
2893 return send_error (ctx, rc);
2896 rc = do_import (client, client->import_root, result);
2897 xfree (client->import_root);
2898 client->import_root = NULL;
2899 return send_error (ctx, rc);
2902 static gpg_error_t
2903 do_lock (struct client_s *client, int add)
2905 gpg_error_t rc = lock_file_mutex (client, add);
2907 if (!rc)
2908 client->flags |= FLAG_LOCK_CMD;
2910 return rc;
2913 static gpg_error_t
2914 lock_command (assuan_context_t ctx, char *line)
2916 struct client_s *client = assuan_get_pointer (ctx);
2917 gpg_error_t rc;
2919 if (line && *line)
2920 return send_error (ctx, GPG_ERR_SYNTAX);
2922 rc = do_lock (client, 0);
2923 return send_error (ctx, rc);
2926 static gpg_error_t
2927 unlock_command (assuan_context_t ctx, char *line)
2929 struct client_s *client = assuan_get_pointer (ctx);
2930 gpg_error_t rc;
2932 if (line && *line)
2933 return send_error (ctx, GPG_ERR_SYNTAX);
2935 rc = unlock_file_mutex (client, 0);
2936 return send_error (ctx, rc);
2939 static void
2940 get_set_env (const char *name, const char *value)
2942 if (value && *value)
2943 setenv (name, value, 1);
2944 else
2945 unsetenv (name);
2948 static gpg_error_t
2949 option_command (assuan_context_t ctx, char *line)
2951 struct client_s *client = assuan_get_pointer (ctx);
2952 gpg_error_t rc = 0;
2953 char namebuf[255] = { 0 };
2954 char *name = namebuf;
2955 char *value = NULL, *p, *tmp = NULL;
2957 p = strchr (line, '=');
2958 if (!p)
2960 strncpy (namebuf, line, sizeof(namebuf));
2961 namebuf[sizeof(namebuf)-1] = 0;
2963 else
2965 strncpy (namebuf, line, strlen (line)-strlen (p));
2966 namebuf[sizeof(namebuf)-1] = 0;
2967 value = p+1;
2970 log_write2 ("OPTION name='%s' value='%s'", name, value);
2972 if (strcasecmp (name, (char *) "lock-timeout") == 0)
2974 long n = 0;
2976 if (value)
2978 n = strtol (value, &tmp, 10);
2979 if (tmp && *tmp)
2980 return send_error (ctx, GPG_ERR_INV_VALUE);
2983 client->lock_timeout = n;
2985 else if (strcasecmp (name, (char *) "NAME") == 0)
2987 if (value && strchr (value, ' '))
2988 rc = GPG_ERR_INV_VALUE;
2989 else
2991 tmp = pthread_getspecific (thread_name_key);
2992 xfree (tmp);
2993 MUTEX_LOCK (&cn_mutex);
2994 xfree (client->thd->name);
2995 client->thd->name = NULL;
2997 if (!value || !*value)
2998 pthread_setspecific (thread_name_key, str_dup (""));
2999 else
3001 client->thd->name = str_dup (value);
3002 pthread_setspecific (thread_name_key, str_dup (value));
3005 MUTEX_UNLOCK (&cn_mutex);
3008 else if (strcasecmp (name, "disable-pinentry") == 0)
3010 int n = 1;
3012 if (value && *value)
3014 n = (int) strtol (value, &tmp, 10);
3015 if (*tmp || n < 0 || n > 1)
3016 return send_error (ctx, GPG_ERR_INV_VALUE);
3019 if (n)
3020 client->flags |= FLAG_NO_PINENTRY;
3021 else
3022 client->flags &= ~FLAG_NO_PINENTRY;
3024 else if (strcasecmp (name, "ttyname") == 0)
3026 get_set_env ("GPG_TTY", value);
3028 else if (strcasecmp (name, "ttytype") == 0)
3030 get_set_env ("TERM", value);
3032 else if (strcasecmp (name, "display") == 0)
3034 get_set_env ("DISPLAY", value);
3036 else if (strcasecmp (name, "lc_messages") == 0)
3039 else if (strcasecmp (name, "lc_ctype") == 0)
3042 else if (strcasecmp (name, "desc") == 0)
3045 else if (strcasecmp (name, "pinentry-timeout") == 0)
3048 else
3049 rc = GPG_ERR_UNKNOWN_OPTION;
3051 return send_error (ctx, rc);
3054 static gpg_error_t
3055 do_rename (assuan_context_t ctx, char *line)
3057 struct client_s *client = assuan_get_pointer (ctx);
3058 char **args, *p;
3059 xmlNodePtr src, dst;
3060 struct string_s *str = NULL, *tstr;
3061 struct xml_request_s *req;
3062 gpg_error_t rc;
3064 args = str_split (line, " ", 0);
3065 if (!args || strv_length (args) != 2)
3067 strv_free (args);
3068 return GPG_ERR_SYNTAX;
3071 if (!xml_valid_element ((xmlChar *) args[1]))
3073 strv_free (args);
3074 return GPG_ERR_INV_VALUE;
3077 rc = xml_new_request (client, args[0], XML_CMD_RENAME, &req);
3078 if (rc)
3080 strv_free (args);
3081 return rc;
3084 src = xml_find_elements (client, req, xmlDocGetRootElement (req->doc), &rc);
3085 if (rc)
3086 goto fail;
3088 rc = xml_is_element_owner (client, src);
3089 if (rc)
3090 goto fail;
3092 xmlChar *a = xmlGetProp (src, (xmlChar *) "_name");
3093 if (!a)
3095 rc = GPG_ERR_ENOMEM;
3096 goto fail;
3099 /* To prevent unwanted effects:
3101 * <element _name="a"><element _name="b"/></element>
3103 * RENAME a<TAB>b b
3105 if (xmlStrEqual (a, (xmlChar *) args[1]))
3107 xmlFree (a);
3108 rc = GPG_ERR_CONFLICT;
3109 goto fail;
3112 xmlFree (a);
3113 str = string_new (args[0]);
3114 if (!str)
3116 rc = GPG_ERR_ENOMEM;
3117 goto fail;
3120 p = strrchr (str->str, '\t');
3121 if (p)
3122 tstr = string_truncate (str, strlen (str->str)-strlen (p));
3123 else
3124 tstr = string_truncate (str, 0);
3126 if (!tstr)
3128 string_free (str, 1);
3129 rc = GPG_ERR_ENOMEM;
3130 goto fail;
3133 str = tstr;
3134 tstr = string_append_printf (str, "%s%s", str->len ? "\t" : "", args[1]);
3135 if (!tstr)
3137 string_free (str, 1);
3138 rc = GPG_ERR_ENOMEM;
3139 goto fail;
3142 str = tstr;
3143 xml_free_request (req);
3144 rc = xml_new_request (client, str->str, XML_CMD_RENAME, &req);
3145 string_free (str, 1);
3146 if (rc)
3148 req = NULL;
3149 goto fail;
3152 dst = xml_find_elements (client, req, xmlDocGetRootElement (req->doc), &rc);
3153 if (rc && rc != GPG_ERR_ELEMENT_NOT_FOUND)
3154 goto fail;
3156 rc = 0;
3158 /* Target may exist:
3160 * <element _name="a"/>
3161 * <element _name="b" target="a"/>
3163 * RENAME b a
3165 if (src == dst)
3167 rc = GPG_ERR_CONFLICT;
3168 goto fail;
3171 if (dst)
3173 rc = xml_is_element_owner (client, dst);
3174 if (rc)
3175 goto fail;
3177 rc = xml_add_attribute (client, src, "_name", args[1]);
3178 if (!rc)
3179 xml_unlink_node (client, dst);
3181 else
3182 rc = xml_add_attribute (client, src, "_name", args[1]);
3184 fail:
3185 xml_free_request (req);
3186 strv_free (args);
3187 return rc;
3190 static gpg_error_t
3191 rename_command (assuan_context_t ctx, char *line)
3193 struct client_s *client = assuan_get_pointer (ctx);
3194 gpg_error_t rc;
3195 struct argv_s *args[] = {
3196 &(struct argv_s) {"inquire", OPTION_TYPE_NOARG, parse_opt_inquire},
3197 NULL
3200 rc = parse_options (&line, args, client, 1);
3201 if (!rc && (client->opts & OPT_INQUIRE) && line && *line)
3202 rc = GPG_ERR_SYNTAX;
3203 if (rc)
3204 return send_error (ctx, rc);
3206 if (client->opts & OPT_INQUIRE)
3208 unsigned char *result;
3209 size_t len;
3211 rc = assuan_inquire (ctx, "DATA", &result, &len, 0);
3212 if (rc)
3213 return send_error (ctx, rc);
3215 pthread_cleanup_push ((void *)xfree, result);
3216 rc = do_rename (ctx, (char *)result);
3217 pthread_cleanup_pop (1);
3219 else
3220 rc = do_rename (ctx, line);
3222 return send_error (ctx, rc);
3225 static gpg_error_t
3226 do_copy (assuan_context_t ctx, char *line)
3228 struct client_s *client = assuan_get_pointer (ctx);
3229 char **args, **targs;
3230 xmlNodePtr src, dst, tree = NULL;
3231 struct xml_request_s *req;
3232 gpg_error_t rc;
3234 args = str_split (line, " ", 0);
3235 if (!args || strv_length (args) != 2)
3237 strv_free (args);
3238 return GPG_ERR_SYNTAX;
3241 targs = str_split (args[1], "\t", 0);
3242 if (!targs)
3244 strv_free (args);
3245 return GPG_ERR_ENOMEM;
3248 if (!xml_valid_element_path (targs, 0))
3250 strv_free (args);
3251 strv_free (targs);
3252 return GPG_ERR_INV_VALUE;
3254 strv_free (targs);
3256 rc = xml_new_request (client, args[0], XML_CMD_NONE, &req);
3257 if (rc)
3259 strv_free (args);
3260 return rc;
3263 src = xml_find_elements (client, req, xmlDocGetRootElement (req->doc), &rc);
3264 if (rc)
3265 goto fail;
3267 tree = xmlCopyNodeList (src);
3268 if (!tree)
3270 rc = GPG_ERR_ENOMEM;
3271 goto fail;
3274 xml_free_request (req);
3275 /* Create the destination element path if it does not exist. */
3276 rc = xml_new_request (client, args[1], XML_CMD_STORE, &req);
3277 if (rc)
3279 req = NULL;
3280 goto fail;
3283 dst = xml_find_elements (client, req, xmlDocGetRootElement (req->doc), &rc);
3284 if (rc)
3285 goto fail;
3287 rc = xml_is_element_owner (client, dst);
3288 if (rc)
3289 goto fail;
3291 rc = xml_validate_target (client, req->doc, args[1], src);
3292 if (rc || src == dst)
3294 rc = GPG_ERR_CONFLICT;
3295 goto fail;
3298 /* Merge any attributes from the src node to the initial dst node. */
3299 for (xmlAttrPtr attr = tree->properties; attr; attr = attr->next)
3301 if (xmlStrEqual (attr->name, (xmlChar *) "_name"))
3302 continue;
3304 xmlAttrPtr a = xmlHasProp (dst, attr->name);
3305 if (a)
3306 xmlRemoveProp (a);
3308 xmlChar *tmp = xmlNodeGetContent (attr->children);
3309 xmlNewProp (dst, attr->name, tmp);
3310 xmlFree (tmp);
3311 /* Create the default attributes. */
3312 rc = xml_add_attribute (client, dst, NULL, NULL);
3315 xmlNodePtr n = dst->children;
3316 xmlUnlinkNode (n);
3317 xmlFreeNodeList (n);
3318 dst->children = NULL;
3320 if (tree->children)
3322 n = xmlCopyNodeList (tree->children);
3323 if (!n)
3325 rc = GPG_ERR_ENOMEM;
3326 goto fail;
3329 n = xmlAddChildList (dst, n);
3330 if (!n)
3332 rc = GPG_ERR_ENOMEM;
3333 goto fail;
3336 rc = xml_update_element_mtime (client, xmlDocGetRootElement (client->doc)
3337 == dst->parent ? dst : dst->parent);
3340 fail:
3341 if (tree)
3343 xmlUnlinkNode (tree);
3344 xmlFreeNodeList (tree);
3347 xml_free_request (req);
3348 strv_free (args);
3349 return rc;
3352 static gpg_error_t
3353 copy_command (assuan_context_t ctx, char *line)
3355 struct client_s *client = assuan_get_pointer (ctx);
3356 gpg_error_t rc;
3357 struct argv_s *args[] = {
3358 &(struct argv_s) {"inquire", OPTION_TYPE_NOARG, parse_opt_inquire},
3359 NULL
3362 rc = parse_options (&line, args, client, 1);
3363 if (!rc && (client->opts & OPT_INQUIRE) && line && *line)
3364 rc = GPG_ERR_SYNTAX;
3365 if (rc)
3366 return send_error (ctx, rc);
3368 if (client->opts & OPT_INQUIRE)
3370 unsigned char *result;
3371 size_t len;
3373 rc = assuan_inquire (ctx, "DATA", &result, &len, 0);
3374 if (rc)
3375 return send_error (ctx, rc);
3377 pthread_cleanup_push ((void *)xfree, result);
3378 rc = do_copy (ctx, (char *)result);
3379 pthread_cleanup_pop (1);
3381 else
3382 rc = do_copy (ctx, line);
3384 return send_error (ctx, rc);
3387 static gpg_error_t
3388 do_move (assuan_context_t ctx, char *line)
3390 struct client_s *client = assuan_get_pointer (ctx);
3391 char **args;
3392 xmlNodePtr src, dst;
3393 struct xml_request_s *req;
3394 gpg_error_t rc;
3396 args = str_split (line, " ", 0);
3397 if (!args || strv_length (args) != 2)
3399 strv_free (args);
3400 return GPG_ERR_SYNTAX;
3403 if (*args[1])
3405 char **targs = str_split (args[1], "\t", 0);
3406 if (!targs)
3408 strv_free (args);
3409 return GPG_ERR_ENOMEM;
3412 if (!xml_valid_element_path (targs, 0))
3414 strv_free (targs);
3415 strv_free (args);
3416 return GPG_ERR_INV_VALUE;
3419 strv_free (targs);
3422 rc = xml_new_request (client, args[0], XML_CMD_MOVE, &req);
3423 if (rc)
3425 strv_free (args);
3426 return rc;
3429 src = xml_find_elements (client, req, xmlDocGetRootElement (req->doc), &rc);
3430 if (rc)
3431 goto fail;
3433 rc = xml_is_element_owner (client, src);
3434 if (rc)
3435 goto fail;
3437 xml_free_request (req);
3438 req = NULL;
3439 if (*args[1])
3441 rc = xml_new_request (client, args[1], XML_CMD_NONE, &req);
3442 if (rc)
3443 goto fail;
3445 dst = xml_find_elements (client, req, xmlDocGetRootElement (req->doc),
3446 &rc);
3448 else
3449 dst = xmlDocGetRootElement (client->doc);
3451 if (rc && rc != GPG_ERR_ELEMENT_NOT_FOUND)
3452 goto fail;
3454 rc = 0;
3456 for (xmlNodePtr n = dst; n; n = n->parent)
3458 if (n == src)
3460 rc = GPG_ERR_CONFLICT;
3461 goto fail;
3465 if (dst)
3467 xmlChar *a = xml_attribute_value (src, (xmlChar *) "_name");
3468 xmlNodePtr dup = xml_find_element (client, dst->children, (char *) a, &rc);
3470 xmlFree (a);
3471 if (rc && rc != GPG_ERR_ELEMENT_NOT_FOUND)
3472 goto fail;
3474 rc = 0;
3476 if (dup)
3478 if (dup == src)
3480 rc = GPG_ERR_CONFLICT;
3481 goto fail;
3484 if (dst == xmlDocGetRootElement (client->doc))
3486 xmlNodePtr n = src;
3487 int match = 0;
3489 while (n->parent && n->parent != dst)
3490 n = n->parent;
3492 xmlChar *a = xml_attribute_value (n, (xmlChar *) "_name");
3493 xmlChar *b = xml_attribute_value (src, (xmlChar *) "_name");
3495 if (xmlStrEqual (a, b))
3497 match = 1;
3498 xmlUnlinkNode (src);
3499 xmlUnlinkNode (n);
3500 xmlFreeNodeList (n);
3503 xmlFree (a);
3504 xmlFree (b);
3506 if (!match)
3508 xmlUnlinkNode (dup);
3509 xmlFreeNodeList (dup);
3512 else
3513 xmlUnlinkNode (dup);
3517 if (!dst && *req->args)
3519 struct xml_request_s *nreq = NULL;
3520 xmlChar *name = xml_attribute_value (src, (xmlChar *) "_name");
3522 if (src->parent == xmlDocGetRootElement (client->doc)
3523 && !strcmp ((char *) name, *req->args))
3525 xmlFree (name);
3526 rc = GPG_ERR_CONFLICT;
3527 goto fail;
3530 xmlFree (name);
3531 rc = xml_new_request (client, args[1], XML_CMD_STORE, &nreq);
3532 if (!rc)
3534 dst = xml_find_elements (client, nreq,
3535 xmlDocGetRootElement (nreq->doc), &rc);
3536 xml_free_request (nreq);
3539 if (rc)
3540 goto fail;
3543 xml_update_element_mtime (client, src->parent);
3544 xmlUnlinkNode (src);
3546 dst = xmlAddChildList (dst, src);
3547 if (!dst)
3548 rc = GPG_ERR_ENOMEM;
3549 else
3550 xml_update_element_mtime (client, dst->parent);
3552 fail:
3553 xml_free_request (req);
3554 strv_free (args);
3555 return rc;
3558 static gpg_error_t
3559 move_command (assuan_context_t ctx, char *line)
3561 struct client_s *client = assuan_get_pointer (ctx);
3562 gpg_error_t rc;
3563 struct argv_s *args[] = {
3564 &(struct argv_s) {"inquire", OPTION_TYPE_NOARG, parse_opt_inquire},
3565 NULL
3568 rc = parse_options (&line, args, client, 1);
3569 if (!rc && (client->opts & OPT_INQUIRE) && line && *line)
3570 rc = GPG_ERR_SYNTAX;
3571 if (rc)
3572 return send_error (ctx, rc);
3574 if (client->opts & OPT_INQUIRE)
3576 unsigned char *result;
3577 size_t len;
3579 rc = assuan_inquire (ctx, "DATA", &result, &len, 0);
3580 if (rc)
3581 return send_error (ctx, rc);
3583 pthread_cleanup_push ((void *)xfree, result);
3584 rc = do_move (ctx, (char *)result);
3585 pthread_cleanup_pop (1);
3587 else
3588 rc = do_move (ctx, line);
3590 return send_error (ctx, rc);
3593 static gpg_error_t
3594 ls_command (assuan_context_t ctx, char *line)
3596 gpg_error_t rc;
3597 char *tmp;
3598 char *dir;
3599 DIR *d;
3601 if (line && *line)
3602 return send_error (ctx, GPG_ERR_SYNTAX);
3604 tmp = str_asprintf ("%s/data", homedir);
3605 dir = expand_homedir (tmp);
3606 xfree (tmp);
3607 d = opendir (dir);
3608 rc = gpg_error_from_errno (errno);
3610 if (!d)
3612 xfree (dir);
3613 return send_error (ctx, rc);
3616 size_t len =
3617 offsetof (struct dirent, d_name) +pathconf (dir, _PC_NAME_MAX) + 1;
3618 struct dirent *p = xmalloc (len), *cur = NULL;
3619 char *list = NULL;
3621 xfree (dir);
3622 pthread_cleanup_push ((void *)xfree, p);
3623 pthread_cleanup_push ((void *)(void *)(void *)closedir, d);
3624 rc = 0;
3626 while (!readdir_r (d, p, &cur) && cur)
3628 struct stat st;
3630 if (stat (cur->d_name, &st) == -1 || !S_ISREG (st.st_mode))
3631 continue;
3633 tmp = str_asprintf ("%s%s\n", list ? list : "", cur->d_name);
3635 if (!tmp)
3637 if (list)
3638 xfree (list);
3640 rc = GPG_ERR_ENOMEM;
3641 break;
3644 xfree (list);
3645 list = tmp;
3648 pthread_cleanup_pop (1); // closedir (d)
3649 pthread_cleanup_pop (1); // xfree (p)
3651 if (rc)
3652 return send_error (ctx, rc);
3654 if (!list)
3655 return send_error (ctx, GPG_ERR_NO_DATA);
3657 list[strlen (list) - 1] = 0;
3658 pthread_cleanup_push ((void *)xfree, list);
3659 rc = xfer_data (ctx, list, strlen (list));
3660 pthread_cleanup_pop (1);
3661 return send_error (ctx, rc);
3664 static gpg_error_t
3665 bye_notify (assuan_context_t ctx, char *line)
3667 struct client_s *cl = assuan_get_pointer (ctx);
3668 gpg_error_t ret = 0;
3670 update_client_state (cl, CLIENT_STATE_DISCON);
3672 #ifdef WITH_GNUTLS
3673 if (cl->thd->remote)
3675 int rc;
3679 struct timeval tv = { 0, 50000 };
3681 rc = gnutls_bye (cl->thd->tls->ses, GNUTLS_SHUT_RDWR);
3682 if (rc == GNUTLS_E_AGAIN)
3683 select (0, NULL, NULL, NULL, &tv);
3685 while (rc == GNUTLS_E_AGAIN);
3687 #endif
3689 /* This will let assuan_process_next() return. */
3690 if (fcntl (cl->thd->fd, F_SETFL, O_NONBLOCK) == -1)
3692 cl->last_rc = gpg_error_from_errno (errno);
3693 ret = cl->last_rc;
3696 cl->last_rc = 0; // BYE command result
3697 return ret;
3700 static gpg_error_t
3701 reset_notify (assuan_context_t ctx, char *line)
3703 struct client_s *client = assuan_get_pointer (ctx);
3705 if (client)
3706 cleanup_client (client);
3708 return 0;
3712 * This is called before every Assuan command.
3714 static gpg_error_t
3715 command_startup (assuan_context_t ctx, const char *name)
3717 struct client_s *client = assuan_get_pointer (ctx);
3718 gpg_error_t rc;
3719 struct command_table_s *cmd = NULL;
3721 log_write2 ("command='%s'", name);
3722 client->last_rc = client->opts = 0;
3724 for (int i = 0; command_table[i]; i++)
3726 if (!strcasecmp (name, command_table[i]->name))
3728 if (command_table[i]->ignore_startup)
3729 return 0;
3730 cmd = command_table[i];
3731 break;
3735 if (!cmd)
3736 return GPG_ERR_UNKNOWN_COMMAND;
3738 client->last_rc = rc = gpg_error (file_modified (client, cmd));
3739 if (!rc)
3740 update_client_state (client, CLIENT_STATE_COMMAND);
3742 return rc;
3746 * This is called after every Assuan command.
3748 static void
3749 command_finalize (assuan_context_t ctx, gpg_error_t rc)
3751 struct client_s *client = assuan_get_pointer (ctx);
3753 if (!(client->flags & FLAG_LOCK_CMD))
3754 unlock_file_mutex (client, 0);
3756 unlock_flock (&client->flock_fd);
3757 log_write2 (_("command completed: rc=%u"), rc ? rc : client->last_rc);
3758 client->last_rc = gpg_error (GPG_ERR_UNKNOWN_COMMAND);
3759 #ifdef WITH_GNUTLS
3760 client->thd->buffer_timeout = client->thd->last_buffer_size = 0;
3761 #endif
3762 if (client->thd->state != CLIENT_STATE_DISCON)
3763 update_client_state (client, CLIENT_STATE_IDLE);
3766 static gpg_error_t
3767 parse_help_opt_html (void *data, void *value)
3769 struct client_s *client = data;
3771 (void) value;
3772 client->opts |= OPT_HTML;
3773 return 0;
3776 static gpg_error_t
3777 help_command (assuan_context_t ctx, char *line)
3779 gpg_error_t rc;
3780 int i;
3781 struct client_s *client = assuan_get_pointer (ctx);
3782 struct argv_s *args[] = {
3783 &(struct argv_s) {"html", OPTION_TYPE_NOARG, parse_help_opt_html},
3784 NULL
3787 rc = parse_options (&line, args, client, 1);
3788 if (rc)
3789 return send_error (ctx, rc);
3791 if (!line || !*line)
3793 char *tmp;
3794 char *help = str_dup (_("Usage: HELP [--html] [<COMMAND>]\n"
3795 "For commands that take an element path as an argument, each element is "
3796 "separated with an ASCII @key{TAB} character (ASCII 0x09)."
3797 "@*@*COMMANDS:"));
3799 for (i = 0; command_table[i]; i++)
3801 if (!command_table[i]->help)
3802 continue;
3804 /* @npxref{} won't put a "See " or "see " in front of the command.
3805 * It's not a texinfo command but needed for --html. */
3806 tmp = str_asprintf ("%s %s%s%s", help,
3807 client->opts & OPT_HTML ? "@npxref{" : "",
3808 command_table[i]->name,
3809 client->opts & OPT_HTML ? "}" : "");
3810 xfree (help);
3811 help = tmp;
3814 tmp = strip_texi_and_wrap (help, client->opts & OPT_HTML);
3815 xfree (help);
3816 pthread_cleanup_push ((void *)xfree, tmp);
3817 rc = xfer_data (ctx, tmp, strlen (tmp));
3818 pthread_cleanup_pop (1);
3819 return send_error (ctx, rc);
3822 for (i = 0; command_table[i]; i++)
3824 if (!strcasecmp (line, command_table[i]->name))
3826 char *help, *tmp;
3828 if (!command_table[i]->help)
3829 break;
3831 help = strip_texi_and_wrap (command_table[i]->help,
3832 client->opts & OPT_HTML);
3833 tmp = str_asprintf ("%s%s",
3834 (client->opts & OPT_HTML) ? "" : _("Usage: "),
3835 help);
3836 xfree (help);
3837 pthread_cleanup_push ((void *)xfree, tmp);
3838 rc = xfer_data (ctx, tmp, strlen (tmp));
3839 pthread_cleanup_pop (1);
3840 return send_error (ctx, rc);
3844 return send_error (ctx, GPG_ERR_INV_NAME);
3847 static void
3848 new_command (const char *name, int ignore, int unlock, int flock_type,
3849 gpg_error_t (*handler) (assuan_context_t, char *),
3850 const char *help)
3852 int i = 0;
3853 struct command_table_s **tmp;
3855 if (command_table)
3856 for (i = 0; command_table[i]; i++);
3858 tmp = xrealloc (command_table, (i + 2) * sizeof (struct command_table_s *));
3859 assert (tmp);
3860 command_table = tmp;
3861 command_table[i] = xcalloc (1, sizeof (struct command_table_s));
3862 command_table[i]->name = name;
3863 command_table[i]->handler = handler;
3864 command_table[i]->ignore_startup = ignore;
3865 command_table[i]->unlock = unlock;
3866 command_table[i]->flock_type = flock_type;
3867 command_table[i++]->help = help;
3868 command_table[i] = NULL;
3871 void
3872 deinit_commands ()
3874 int i;
3876 for (i = 0; command_table[i]; i++)
3877 xfree (command_table[i]);
3879 xfree (command_table);
3882 static int
3883 sort_commands (const void *arg1, const void *arg2)
3885 struct command_table_s *const *a = arg1;
3886 struct command_table_s *const *b = arg2;
3888 if (!*a || !*b)
3889 return 0;
3890 else if (*a && !*b)
3891 return 1;
3892 else if (!*a && *b)
3893 return -1;
3895 return strcmp ((*a)->name, (*b)->name);
3898 static gpg_error_t
3899 passwd_command (assuan_context_t ctx, char *line)
3901 struct client_s *client = assuan_get_pointer (ctx);
3902 gpg_error_t rc;
3904 rc = peer_is_invoker (client);
3905 if (rc == GPG_ERR_EACCES)
3906 return send_error (ctx, GPG_ERR_FORBIDDEN);
3907 else if (rc)
3908 return send_error (ctx, rc);
3910 if (client->flags & FLAG_NEW)
3911 return send_error (ctx, GPG_ERR_INV_STATE);
3913 rc = crypto_init_ctx (client->crypto, client->flags & FLAG_NO_PINENTRY);
3914 if (rc)
3915 return send_error (ctx, rc);
3917 if (!rc)
3918 rc = crypto_passwd (client, client->crypto);
3920 crypto_cleanup_non_keys (client->crypto);
3921 return send_error (ctx, rc);
3924 static gpg_error_t
3925 parse_opt_data (void *data, void *value)
3927 struct client_s *client = data;
3929 (void) value;
3930 client->opts |= OPT_DATA;
3931 return 0;
3934 static gpg_error_t
3935 send_client_list (assuan_context_t ctx)
3937 struct client_s *client = assuan_get_pointer (ctx);
3938 gpg_error_t rc = 0;
3940 if (client->opts & OPT_VERBOSE)
3942 unsigned i, t;
3943 char **list = NULL;
3944 char *line;
3946 MUTEX_LOCK (&cn_mutex);
3947 pthread_cleanup_push ((void *)cleanup_mutex_cb, &cn_mutex);
3948 t = slist_length (cn_thread_list);
3950 for (i = 0; i < t; i++)
3952 struct client_thread_s *thd = slist_nth_data (cn_thread_list, i);
3953 char *tmp;
3955 if (thd->state == CLIENT_STATE_UNKNOWN)
3956 continue;
3958 tmp = build_client_info_line (thd, 0);
3959 if (tmp)
3961 char **l = strv_cat (list, tmp);
3962 if (!l)
3963 rc = GPG_ERR_ENOMEM;
3964 else
3965 list = l;
3967 else
3968 rc = GPG_ERR_ENOMEM;
3970 if (rc)
3972 strv_free (list);
3973 break;
3977 pthread_cleanup_pop (1);
3978 if (rc)
3979 return rc;
3981 line = strv_join ("\n", list);
3982 strv_free (list);
3983 pthread_cleanup_push ((void *)xfree, line);
3984 rc = xfer_data (ctx, line, strlen (line));
3985 pthread_cleanup_pop (1);
3986 return rc;
3989 if (client->opts & OPT_DATA)
3991 char buf[ASSUAN_LINELENGTH];
3993 MUTEX_LOCK (&cn_mutex);
3994 snprintf (buf, sizeof (buf), "%u", slist_length (cn_thread_list));
3995 MUTEX_UNLOCK (&cn_mutex);
3996 rc = xfer_data (ctx, buf, strlen (buf));
3998 else
3999 rc = send_status (ctx, STATUS_CLIENTS, NULL);
4001 return rc;
4004 static gpg_error_t
4005 getinfo_command (assuan_context_t ctx, char *line)
4007 struct client_s *client = assuan_get_pointer (ctx);
4008 gpg_error_t rc;
4009 char buf[ASSUAN_LINELENGTH];
4010 struct argv_s *args[] = {
4011 &(struct argv_s) {"data", OPTION_TYPE_NOARG, parse_opt_data},
4012 &(struct argv_s) {"verbose", OPTION_TYPE_NOARG, parse_opt_verbose},
4013 NULL
4016 rc = parse_options (&line, args, client, 1);
4017 if (rc)
4018 return send_error (ctx, rc);
4020 if (!strcasecmp (line, "clients"))
4022 rc = send_client_list (ctx);
4024 else if (!strcasecmp (line, "cache"))
4026 if (client->opts & OPT_DATA)
4028 snprintf (buf, sizeof (buf), "%u", cache_file_count ());
4029 rc = xfer_data (ctx, buf, strlen (buf));
4031 else
4032 rc = send_status (ctx, STATUS_CACHE, NULL);
4034 else if (!strcasecmp (line, "pid"))
4036 char buf[32];
4037 pid_t pid = getpid ();
4039 snprintf (buf, sizeof (buf), "%i", pid);
4040 rc = xfer_data (ctx, buf, strlen (buf));
4042 else if (!strcasecmp (line, "version"))
4044 char *buf = str_asprintf ("0x%06x %s", VERSION_HEX,
4045 #ifdef WITH_GNUTLS
4046 "GNUTLS "
4047 #endif
4048 #ifdef WITH_LIBACL
4049 "ACL "
4050 #endif
4051 "");
4052 rc = xfer_data (ctx, buf, strlen (buf));
4053 xfree (buf);
4055 else if (!strcasecmp (line, "last_error"))
4057 if (client->last_error)
4058 rc = xfer_data (ctx, client->last_error, strlen (client->last_error));
4059 else
4060 rc = GPG_ERR_NO_DATA;
4062 else if (!strcasecmp (line, "user"))
4064 char *user = NULL;
4066 #ifdef WITH_GNUTLS
4067 if (client->thd->remote)
4068 user = str_asprintf ("#%s", client->thd->tls->fp);
4069 else
4070 user = get_username (client->thd->peer->uid);
4071 #else
4072 user = get_username (client->thd->peer->uid);
4073 #endif
4074 if (user)
4076 pthread_cleanup_push ((void *)xfree, user);
4077 rc = xfer_data (ctx, user, strlen (user));
4078 pthread_cleanup_pop (1);
4080 else
4081 rc = GPG_ERR_NO_DATA;
4083 else
4084 rc = gpg_error (GPG_ERR_SYNTAX);
4086 return send_error (ctx, rc);
4089 static gpg_error_t
4090 parse_listkeys_opt_secret_only (void *data, void *value)
4092 struct client_s *client = data;
4094 (void) value;
4095 client->opts |= OPT_SECRET_ONLY;
4096 return 0;
4099 static gpg_error_t
4100 keyinfo_command (assuan_context_t ctx, char *line)
4102 struct client_s *client = assuan_get_pointer (ctx);
4103 gpg_error_t rc = 0;
4104 char **keys = NULL, **p = NULL;
4105 int sym = 0;
4107 if (line && *line)
4108 return send_error (ctx, GPG_ERR_SYNTAX);
4110 if (!(client->flags & FLAG_OPEN))
4111 return send_error (ctx, GPG_ERR_INV_STATE);
4113 if (client->flags & FLAG_NEW)
4114 return send_error (ctx, GPG_ERR_NO_DATA);
4116 rc = lock_flock (ctx, client->filename, FLOCK_TYPE_SH, &client->flock_fd);
4117 if (rc)
4118 return send_error (ctx, rc);
4120 rc = crypto_is_symmetric (client->filename);
4121 unlock_flock (&client->flock_fd);
4122 if (!rc)
4123 sym = 1;
4124 else if (rc != GPG_ERR_BAD_DATA)
4125 return send_error (ctx, rc);
4127 rc = 0;
4128 if (!sym)
4130 p = strv_catv(keys, client->crypto->pubkey);
4131 if (!p)
4132 rc = GPG_ERR_ENOMEM;
4135 if (!rc)
4137 keys = p;
4138 for (p = client->crypto->sigkey; p && *p; p++)
4140 if (!strv_printf(&keys, "S%s", *p))
4142 strv_free (keys);
4143 return send_error (ctx, GPG_ERR_ENOMEM);
4147 else
4148 rc = GPG_ERR_ENOMEM;
4150 if (!rc && keys)
4152 line = strv_join ("\n", keys);
4153 strv_free (keys);
4154 pthread_cleanup_push ((void *)xfree, line);
4155 if (line)
4156 rc = xfer_data (ctx, line, strlen (line));
4157 else
4158 rc = GPG_ERR_ENOMEM;
4160 pthread_cleanup_pop (1);
4162 else if (!keys)
4163 rc = GPG_ERR_NO_DATA;
4164 else
4165 strv_free (keys);
4167 return send_error (ctx, rc);
4170 static gpg_error_t
4171 kill_command (assuan_context_t ctx, char *line)
4173 struct client_s *client = assuan_get_pointer (ctx);
4174 gpg_error_t rc;
4175 unsigned i, t;
4177 if (!line || !*line)
4178 return send_error (ctx, GPG_ERR_SYNTAX);
4180 MUTEX_LOCK (&cn_mutex);
4181 pthread_cleanup_push ((void *)cleanup_mutex_cb, &cn_mutex);
4182 t = slist_length (cn_thread_list);
4183 rc = GPG_ERR_ESRCH;
4185 for (i = 0; i < t; i++)
4187 struct client_thread_s *thd = slist_nth_data (cn_thread_list, i);
4188 char *tmp = str_asprintf ("%p", thd->tid);
4190 if (strcmp (line, tmp))
4192 xfree (tmp);
4193 continue;
4196 xfree (tmp);
4197 rc = peer_is_invoker (client);
4198 if (!rc)
4200 #ifdef HAVE_PTHREAD_CANCEL
4201 rc = pthread_cancel (thd->tid);
4202 #else
4203 close (thd->fd);
4204 thd->fd = -1;
4205 #endif
4206 break;
4209 rc = GPG_ERR_FORBIDDEN;
4210 if (config_get_boolean ("global", "strict_kill"))
4211 break;
4213 #ifdef WITH_GNUTLS
4214 if (client->thd->remote && thd->remote)
4216 if (!strcmp (client->thd->tls->fp, thd->tls->fp))
4218 #ifdef HAVE_PTHREAD_CANCEL
4219 rc = pthread_cancel (thd->tid);
4220 #else
4221 close (thd->fd);
4222 thd->fd = -1;
4223 #endif
4224 break;
4227 else if (!client->thd->remote && !thd->remote)
4228 #endif
4230 if (client->thd->peer->uid == thd->peer->uid)
4232 #ifdef HAVE_PTHREAD_CANCEL
4233 rc = pthread_cancel (thd->tid);
4234 #else
4235 close (thd->fd);
4236 thd->fd = -1;
4237 #endif
4240 break;
4243 pthread_cleanup_pop (1);
4244 return send_error (ctx, rc);
4247 static gpg_error_t
4248 listkeys_command (assuan_context_t ctx, char *line)
4250 struct client_s *client = assuan_get_pointer (ctx);
4251 struct crypto_s *crypto = NULL;
4252 char **pattern = NULL;
4253 gpgme_key_t *keys = NULL;
4254 char **result = NULL;
4255 gpg_error_t rc;
4256 struct argv_s *args[] = {
4257 &(struct argv_s) {"secret-only", OPTION_TYPE_NOARG,
4258 parse_listkeys_opt_secret_only },
4259 NULL
4262 rc = parse_options (&line, args, client, 1);
4263 if (rc)
4264 return send_error (ctx, rc);
4266 rc = crypto_init (&crypto, client->ctx, client->filename,
4267 client->flags & FLAG_NO_PINENTRY);
4268 if (rc)
4269 return send_error (ctx, rc);
4271 pthread_cleanup_push ((void *)(void *)crypto_cleanup, crypto);
4272 pattern = str_split (line, ",", 0);
4273 pthread_cleanup_push ((void *)(void *)strv_free, pattern);
4274 rc = crypto_list_keys (crypto, pattern, client->opts & OPT_SECRET_ONLY,
4275 &keys);
4276 pthread_cleanup_pop (1);
4277 pthread_cleanup_pop (1);
4278 if (!rc)
4280 int i;
4282 for (i = 0; keys[i]; i++)
4284 char *p = crypto_key_info (keys[i]);
4285 char **r;
4287 if (!p)
4289 rc = GPG_ERR_ENOMEM;
4290 break;
4293 r = strv_cat (result, p);
4294 if (!r)
4296 rc = GPG_ERR_ENOMEM;
4297 break;
4300 result = r;
4303 if (!i)
4304 rc = GPG_ERR_NO_DATA;
4306 crypto_free_key_list (keys);
4309 if (!rc)
4311 line = strv_join ("\n", result);
4312 strv_free (result);
4313 pthread_cleanup_push ((void *)xfree, line);
4314 if (!line)
4315 rc = GPG_ERR_ENOMEM;
4316 else
4317 rc = xfer_data (ctx, line, strlen (line));
4319 pthread_cleanup_pop (1);
4321 else
4322 strv_free (result);
4324 return send_error (ctx, rc);
4327 void
4328 init_commands ()
4330 /* !BEGIN-HELP-TEXT!
4332 * This comment is used as a marker to generate the offline documentation
4333 * found in doc/pwmd.info. The indentation needs to be kept for the awk
4334 * script to determine where commands begin and end.
4336 new_command("HELP", 1, 1, 0, help_command, _(
4337 "HELP [--html] [<COMMAND>]\n"
4338 "Show available commands or command specific help text."
4339 "@*@*"
4340 "The @option{--html} option will output the help text in HTML format."
4343 new_command("KILL", 1, 0, 0, kill_command, _(
4344 "KILL <thread_id>\n"
4345 "Terminates the client identified by @var{thread_id} and releases any file "
4346 "lock or other resources it has held. See @code{GETINFO} (@pxref{GETINFO}) "
4347 "for details about listing connected clients. An @code{invoking_user} "
4348 "(@pxref{Configuration}) may kill any client while others may only kill "
4349 "clients of the same @code{UID} or @abbr{TLS} fingerprint.\n"
4352 new_command("LISTKEYS", 0, 0, 0, listkeys_command, _(
4353 "LISTKEYS [--secret-only] [pattern[,<pattern>]]\n"
4354 "Returns a new line separated list of key information matching a comma "
4355 "separated list of @var{pattern}'s. When option @option{--secret-only} is "
4356 "specified, only keys matching @var{pattern} that also have a secret key "
4357 "available will be returned."
4360 new_command("KEYINFO", 1, 0, 0, keyinfo_command, _(
4361 "KEYINFO\n"
4362 "Returns a new line separated list of key ID's that the currently opened "
4363 "data file has recipients and signers for. If the key is a signing key it "
4364 "will be prefixed with an @code{S}. If the file is a new one, or has no "
4365 "signers in the case of being symmetrically encrypted, the error code "
4366 "@code{GPG_ERR_NO_DATA} is returned."
4369 new_command("GETINFO", 1, 1, 0, getinfo_command, _(
4370 "GETINFO [--data] [--verbose] CACHE | CLIENTS | PID | USER | LAST_ERROR | VERSION\n"
4371 "Get server and other information. The information is returned via a status "
4372 "message (@pxref{Status Messages}) unless otherwise noted or @option{--data} "
4373 "is specified."
4374 "@*@*"
4375 "@var{CACHE} returns the number of cached documents."
4376 "@*@*"
4377 "@var{CLIENTS} returns the number of "
4378 "connected clients via a status message or a list of connected clients when "
4379 "the @option{--verbose} parameter is used (implies @option{--data}). A "
4380 "verbose line of a client list contains "
4381 "space delimited "
4382 "fields: the thread ID, client name, opened file (@code{/} if none opened), "
4383 "IP address if remote, file lock status, whether the current client is self "
4384 "or not, client state (see below), "
4385 "user ID or TLS fingerprint of the connected client, username if the "
4386 "client is a local one else @code{-}, and finally the time stamp of when the "
4387 "client connected."
4388 "@*@*"
4389 "Client state @code{0} is an unknown client state, state @code{1} indicates "
4390 "the client has connected but hasn't completed initializing, state @code{2} "
4391 "indicates that the client is idle, state @code{3} means the "
4392 "client is in a command and state @code{4} means the client is disconnecting. "
4393 "@*@*"
4394 "@var{PID} returns the process ID number of the server via a data response."
4395 "@*@*"
4396 "@var{VERSION} returns the server version number and compile-time features "
4397 "via a data response with each being space delimited."
4398 "@*@*"
4399 "@var{LAST_ERROR} returns a detailed description of the last failed command "
4400 "via a data response, when available."
4401 "@*@*"
4402 "@var{USER} returns the username or @abbr{TLS} hash of the connected client "
4403 "via a data response."
4406 new_command("PASSWD", 0, 0, FLOCK_TYPE_EX|FLOCK_TYPE_KEEP, passwd_command, _(
4407 "PASSWD\n"
4408 "Changes the passphrase of the secret key required to open the current "
4409 "data file. If the data file is symmetrically encrypted, the error "
4410 "@code{GPG_ERR_NOT_SUPPORTED} is returned. When symmetrically encrypted, "
4411 "the @code{SAVE} command (@pxref{SAVE}) should be used instead to prevent "
4412 "this command saving any unwanted changes to the @abbr{XML} document."
4413 "@*@*"
4414 "This command is not available to non-invoking clients "
4415 "(@pxref{Access Control})."
4418 new_command("OPEN", 1, 1, FLOCK_TYPE_SH|FLOCK_TYPE_KEEP, open_command, _(
4419 "OPEN [--lock] <filename>\n"
4420 "Opens @var{filename}. When the @var{filename} is not found on the "
4421 "file-system then a new in-memory document will be created. If the file is "
4422 "found, it is looked for in the file cache and when found no passphrase will "
4423 "be required to open it. When not cached, @cite{pinentry(1)} will be used to "
4424 "retrieve the passphrase for decryption unless @option{disable-pinentry} "
4425 "(@pxref{OPTION}) was specified in which case @command{pwmd} will "
4426 "@emph{INQUIRE} the client for the passphrase."
4427 "@*@*"
4428 "When the @option{--lock} option is passed then the file mutex will be "
4429 "locked as if the @code{LOCK} command (@pxref{LOCK}) had been sent after the "
4430 "file had been opened."
4433 new_command("SAVE", 0, 0, FLOCK_TYPE_EX|FLOCK_TYPE_KEEP, save_command, _(
4434 "SAVE [--symmetric] [--inquire-keyparam] [--keyid=<keyid>[,..] | [--inquire-keyid]] [--sign-keyid=<fingerprint>[,..] | [--inquire-sign-keyid]]\n"
4435 "Writes the in-memory @abbr{XML} document to disk. The file written to is the "
4436 "file that was opened using the @code{OPEN} command (@pxref{OPEN}). If the "
4437 "file is a new one or the option @option{--inquire-keyparam} was passed, a "
4438 "new keypair will be generated and @cite{pinentry(1)} will be used to prompt "
4439 "for the passphrase of the secret key used for signing."
4440 "@*@*"
4441 "The @option{--inquire-keyparam} option will send an "
4442 "@emph{INQUIRE} to the client to obtain the key parameters to use for "
4443 "generating the new keypair. The inquired data is expected to be in "
4444 "@cite{gnupg} @abbr{XML} format. See the @cite{gnupg} documentation for "
4445 "details. Note that when this option is specified a new keypair will be "
4446 "generated reguardless if the file is a new one and that the passphrase for "
4447 "the current file will be required before generating the new keypair. This "
4448 "option is available to non-invoking clients (@pxref{Access Control}) only "
4449 "when the file is a new one."
4450 "@*@*"
4451 "You can encrypt the data file to a recipient other than the one that it "
4452 "was encrypted with by passing the @option{--keyid} or "
4453 "@option{--inquire-keyid} option with "
4454 "the key ID of a public encryption key as its argument. Use the "
4455 "@command{LISTKEYS} command (@pxref{LISTKEYS}) to show key information by "
4456 "pattern. The @option{--sign-keyid} or @option{--inquire-sign-keyid} option "
4457 "may also be used to sign the data "
4458 "file with an alternate key by specifying the key ID of a secret key. "
4459 "A passphrase to decrypt the data file "
4460 "will be required if one or more of the original encryption or signing keys "
4461 "are not found in either of these two options' arguments. The original "
4462 "encryption or signing keys will be used when either of these options are "
4463 "not specified."
4464 "@*@*"
4465 "The @option{--keyid} and @option{--sign-keyid} options are not available "
4466 "for non-invoking clients "
4467 "(@pxref{Access Control}) when the recipients or signers do not match those "
4468 "that were used when the file was @code{OPEN}'ed."
4469 "@*@*"
4470 "The @option{--symmetric} option specifies that a new data file be "
4471 "conventionally encrypted. These types of data files do not use a recipient "
4472 "public key but may be signed by using the @option{--sign-keyid} or "
4473 "@option{--inquire-sign-keyid} options. To remove all signers from a "
4474 "symmtrically encrypted data file, leave the option value empty. Note that "
4475 "you cannot change encryption schemes once a data file has been saved."
4478 new_command("ISCACHED", 1, 0, 0, iscached_command, _(
4479 "ISCACHED [--lock] <filename>\n"
4480 "An @emph{OK} response is returned if the specified @var{filename} is found "
4481 "in the file cache. If not found in the cache but exists on the filesystem "
4482 "then @code{GPG_ERR_NO_DATA} is returned. Otherwise a filesystem error is "
4483 "returned."
4484 "@*@*"
4485 "The @option{--lock} option will lock the file mutex of @var{filename} when "
4486 "the file exists; it does not need to be opened nor cached. The lock will be "
4487 "released when the client exits or sends the @code{UNLOCK} command "
4488 "(@pxref{UNLOCK})."
4491 new_command("CLEARCACHE", 1, 1, 0, clearcache_command, _(
4492 "CLEARCACHE [<filename>]\n"
4493 "Clears a file cache entry for all or the specified @var{filename}."
4496 new_command("CACHETIMEOUT", 1, 1, 0, cachetimeout_command, _(
4497 "CACHETIMEOUT <filename> <seconds>\n"
4498 "The time in @var{seconds} until @var{filename} will be removed from the "
4499 "cache. @code{-1} will keep the cache entry forever, @code{0} will require "
4500 "the passphrase for each @code{OPEN} command (@pxref{OPEN}) or @code{SAVE} "
4501 "(@pxref{SAVE}) command. @xref{Configuration}, and the @code{cache_timeout} "
4502 "parameter."
4505 new_command("LIST", 0, 1, 0, list_command, _(
4506 "LIST [--inquire] [--recurse] [element[<TAB>child[..]]]\n"
4507 "If no element path is given then a newline separated list of root elements "
4508 "is returned with a data response. If given, then children of the specified "
4509 "element path are returned."
4510 "@*@*"
4511 "Each element path "
4512 "returned will have zero or more flags appened to it. These flags are "
4513 "delimited from the element path by a single space character. A flag itself "
4514 "is a single character. Flag @code{P} indicates that access to the element "
4515 "is denied. Flag @code{+} indicates that there are child nodes of "
4516 "the current element path. Flag @code{E} indicates that an element of the "
4517 "element path contained in a @var{target} attribute could not be found. Flag "
4518 "@code{O} indicates that a @var{target} attribute recursion limit was reached "
4519 "(@pxref{Configuration}). Flag @code{T}, followed by a single space character, "
4520 "then an element path, is the element path of the @var{target} attribute "
4521 "contained in the current element."
4522 "@*@*"
4523 "When a specified element path contains an error, beit from the final "
4524 "element in the path or any previous element, the path is still shown but "
4525 "will contain the error flag for the element with the error. Determining "
4526 "the actual element which contains the error is up to the client. This can be "
4527 "done by traversing the final element up to parent elements that contain the "
4528 "same error flag."
4529 "@*@*"
4530 "The option @option{--recurse} may be used to list the entire element tree "
4531 "for a specified element path or the entire tree for all root elements."
4532 "@*@*"
4533 "When the @option{--inquire} option is passed then all remaining non-option "
4534 "arguments are retrieved via a server @emph{INQUIRE}."
4537 new_command("REALPATH", 0, 1, 0, realpath_command, _(
4538 "REALPATH [--inquire] element[<TAB>child[..]]\n"
4539 "Resolves all @code{target} attributes of the specified element path and "
4540 "returns the result with a data response. @xref{Target Attribute}, for details."
4541 "@*@*"
4542 "When the @option{--inquire} option is passed then all remaining non-option "
4543 "arguments are retrieved via a server @emph{INQUIRE}."
4546 new_command("STORE", 0, 1, 0, store_command, _(
4547 "STORE element[<TAB>child[..]]<TAB>[content]\n"
4548 "This command uses a server @emph{INQUIRE} to retrieve data from the client."
4549 "@*@*"
4550 "Creates a new element path or modifies the @var{content} of an existing "
4551 "element. If only a single element is specified then a new root element is "
4552 "created. Otherwise, elements are @key{TAB} delimited and the content will be "
4553 "set to the final @key{TAB} delimited element. If no @var{content} is "
4554 "specified after the final @key{TAB}, then the content of the existing "
4555 "element will be removed; or will be empty if creating a new element."
4556 "@*@*"
4557 "The only restriction of an element name is that it not contain whitespace "
4558 "characters. There is no other whitespace between the @key{TAB} delimited "
4559 "elements. It is recommended that the content of an element be base64 encoded "
4560 "when it contains control or @key{TAB} characters to prevent @abbr{XML} "
4561 "parsing and @command{pwmd} syntax errors."
4564 new_command("RENAME", 0, 1, 0, rename_command, _(
4565 "RENAME [--inquire] element[<TAB>child[..]] <value>\n"
4566 "Renames the specified @var{element} to the new @var{value}. If an element of "
4567 "the same name as the @var{value} already exists it will be overwritten."
4568 "@*@*"
4569 "When the @option{--inquire} option is passed then all remaining non-option "
4570 "arguments are retrieved via a server @emph{INQUIRE}."
4573 new_command("COPY", 0, 1, 0, copy_command, _(
4574 "COPY [--inquire] source[<TAB>child[..]] dest[<TAB>child[..]]\n"
4575 "Copies the entire element tree starting from the child node of the source "
4576 "element, to the destination element path. If the destination element path "
4577 "does not exist then it will be created; otherwise it is overwritten."
4578 "@*@*"
4579 "Note that attributes from the source element are merged into the "
4580 "destination element when the destination element path exists. When an "
4581 "attribute of the same name exists in both the source and destination "
4582 "elements then the destination attribute will be updated to the source "
4583 "attribute value."
4584 "@*@*"
4585 "When the @option{--inquire} option is passed then all remaining non-option "
4586 "arguments are retrieved via a server @emph{INQUIRE}."
4589 new_command("MOVE", 0, 1, 0, move_command, _(
4590 "MOVE [--inquire] source[<TAB>child[..]] [dest[<TAB>child[..]]]\n"
4591 "Moves the source element path to the destination element path. If the "
4592 "destination is not specified then it will be moved to the root node of the "
4593 "document. If the destination is specified and exists then it will be "
4594 "overwritten; otherwise non-existing elements of the destination element "
4595 "path will be created."
4596 "@*@*"
4597 "When the @option{--inquire} option is passed then all remaining non-option "
4598 "arguments are retrieved via a server @emph{INQUIRE}."
4601 new_command("DELETE", 0, 1, 0, delete_command, _(
4602 "DELETE [--inquire] element[<TAB>child[..]]\n"
4603 "Removes the specified element path and all of its children. This may break "
4604 "an element with a @code{target} attribute (@pxref{Target Attribute}) that "
4605 "refers to this element or any of its children."
4606 "@*@*"
4607 "When the @option{--inquire} option is passed then all remaining non-option "
4608 "arguments are retrieved via a server @emph{INQUIRE}."
4611 new_command("GET", 0, 1, 0, get_command, _(
4612 "GET [--inquire] element[<TAB>child[..]]\n"
4613 "Retrieves the content of the specified element. The content is returned "
4614 "with a data response."
4615 "@*@*"
4616 "When the @option{--inquire} option is passed then all remaining non-option "
4617 "arguments are retrieved via a server @emph{INQUIRE}."
4620 new_command("ATTR", 0, 1, 0, attr_command, _(
4621 "ATTR [--inquire] SET|GET|DELETE|LIST [<attribute>] element[<TAB>child[..]] ..\n"
4622 "@table @asis\n"
4623 "@item ATTR SET attribute element[<TAB>child[..]] [value]\n"
4624 " Stores or updates an @var{attribute} name and optional @var{value} of an "
4625 "element. When no @var{value} is specified any existing value will be removed."
4626 "@*@*"
4627 "@item ATTR DELETE attribute element[<TAB>child[..]]\n"
4628 " Removes an attribute from an element. If @var{attribute} is @code{_name} "
4629 "or @code{target} an error is returned. Use the @command{DELETE} command "
4630 "(@pxref{DELETE}) instead."
4631 "@*@*"
4632 "@item ATTR LIST element[<TAB>child[..]]\n"
4633 " Retrieves a newline separated list of attributes names and values "
4634 "from the specified element. Each attribute name and value is space delimited."
4635 "@*@*"
4636 "@item ATTR GET attribute element[<TAB>child[..]]\n"
4637 " Retrieves the value of an @var{attribute} from an element."
4638 "@end table\n"
4639 "@*@*"
4640 "When the @option{--inquire} option is passed then all remaining non-option "
4641 "arguments are retrieved via a server @emph{INQUIRE}."
4642 "@*@*"
4643 "@xref{Target Attribute}, for details about this special attribute and also "
4644 "@pxref{Other Attributes} for other attributes that are handled specially "
4645 "by @command{pwmd}."
4648 new_command("XPATH", 0, 1, 0, xpath_command, _(
4649 "XPATH [--inquire] <expression>[<TAB>[value]]\n"
4650 "Evaluates an XPath @var{expression}. If no @var{value} argument is "
4651 "specified it is assumed the expression is a request to return a result. "
4652 "Otherwise, the result is set to the @var{value} argument and the document is "
4653 "updated. If there is no @var{value} after the @key{TAB} character, the value "
4654 "is assumed to be empty and the document is updated. For example:"
4655 "@sp 1\n"
4656 "@example\n"
4657 "XPATH //element[@@_name='password']@key{TAB}\n"
4658 "@end example\n"
4659 "@sp 1\n"
4660 "would clear the content of all @var{password} elements in the data file "
4661 "while leaving off the trailing @key{TAB} would return all @var{password} "
4662 "elements in @abbr{XML} format."
4663 "@*@*"
4664 "When the @option{--inquire} option is passed then all remaining non-option "
4665 "arguments are retrieved via a server @emph{INQUIRE}."
4666 "@*@*"
4667 "See @url{http://www.w3schools.com/xpath/xpath_syntax.asp} for @abbr{XPATH} "
4668 "expression syntax."
4671 new_command("XPATHATTR", 0, 1, 0, xpathattr_command, _(
4672 "XPATHATTR [--inquire] SET|DELETE <name> <expression>[<TAB>[<value>]]\n"
4673 "Like the @code{XPATH} command (@pxref{XPATH}) but operates on element "
4674 "attributes and does not return a result. For the @var{SET} operation the "
4675 "@var{value} is optional but the field is required. If not specified then "
4676 "the attribute value will be empty. For example:"
4677 "@sp 1\n"
4678 "@example\n"
4679 "XPATHATTR SET password //element[@@_name='password']@key{TAB}\n"
4680 "@end example\n"
4681 "@sp 1\n"
4682 "would create a @var{password} attribute for each @var{password} element "
4683 "found in the document. The attribute value will be empty but still exist."
4684 "@*@*"
4685 "When the @option{--inquire} option is passed then all remaining non-option "
4686 "arguments are retrieved via a server @emph{INQUIRE}."
4687 "@*@*"
4688 "See @url{http://www.w3schools.com/xpath/xpath_syntax.asp} for @abbr{XPATH} "
4689 "expression syntax."
4692 new_command("IMPORT", 0, 1, 0, import_command, _(
4693 "IMPORT [--root=element[<TAB>child[..]]]\n"
4694 "This command uses a server @emph{INQUIRE} to retrieve data from the client."
4695 "@*@*"
4696 "Like the @code{STORE} command (@pxref{STORE}), but the @var{content} "
4697 "argument is raw @abbr{XML} data. The content is created as a child of "
4698 "the element path specified with the @option{--root} option or at the "
4699 "document root when not specified. Existing elements of the same name will "
4700 "be overwritten."
4701 "@*@*"
4702 "The content must begin with an @abbr{XML} element node. @xref{Introduction}, "
4703 "for details."
4706 new_command("DUMP", 0, 1, 0, dump_command, _(
4707 "DUMP\n"
4708 "Shows the in memory @abbr{XML} document with indenting. @xref{XPATH}, for "
4709 "dumping a specific node."
4712 new_command("LOCK", 0, 0, 0, lock_command, _(
4713 "LOCK\n"
4714 "Locks the mutex associated with the opened file. This prevents other clients "
4715 "from sending commands to the same opened file until the client "
4716 "that sent this command either disconnects or sends the @code{UNLOCK} "
4717 "command. @xref{UNLOCK}."
4720 new_command("UNLOCK", 1, 0, 0, unlock_command, _(
4721 "UNLOCK\n"
4722 "Unlocks the file mutex which was locked with the @code{LOCK} command or "
4723 "a commands' @option{--lock} option (@pxref{LOCK}, @pxref{OPEN}, "
4724 "@pxref{ISCACHED})."
4727 new_command("GETCONFIG", 1, 1, 0, getconfig_command, _(
4728 "GETCONFIG [filename] <parameter>\n"
4729 "Returns the value of a @command{pwmd} configuration @var{parameter} with a "
4730 "data response. If no file has been opened then the value for @var{filename} "
4731 "or the default from the @var{global} section will be returned. If a file "
4732 "has been opened and no @var{filename} is specified, the value previously "
4733 "set with the @code{OPTION} command (@pxref{OPTION}) will be returned."
4736 new_command("OPTION", 1, 1, 0, option_command, _(
4737 "OPTION <NAME>=[<VALUE>]\n"
4738 "Sets a client option @var{name} to @var{value}. The value for an option is "
4739 "kept for the duration of the connection with the exception of the "
4740 "@command{pinentry} options which are defaults for all future connections "
4741 "(@pxref{Pinentry}). When @var{value} is empty the option is unset."
4742 "@*@*"
4743 "@table @asis\n"
4744 "@item DISABLE-PINENTRY\n"
4745 "Disable use of @command{pinentry} for passphrase retrieval. When @code{1}, a "
4746 "server inquire is sent to the client to obtain the passphrase. This option "
4747 "may be set as needed before the @code{OPEN} (@pxref{OPEN}), @code{PASSWD} "
4748 "(@pxref{PASSWD}) and @code{SAVE} (@pxref{SAVE}) commands. Set to @code{0} "
4749 "to use a @command{pinentry}."
4750 "@*@*"
4751 "@item DISPLAY\n"
4752 "Set or unset the X11 display to use when prompting for a passphrase."
4753 "@*@*"
4754 "@item TTYNAME\n"
4755 "Set the terminal device path to use when prompting for a passphrase."
4756 "@*@*"
4757 "@item TTYTYPE\n"
4758 "Set the terminal type for use with @option{TTYNAME}."
4759 "@*@*"
4760 "@item NAME\n"
4761 "Associates the thread ID of the connection with the specified textual "
4762 "representation. Useful for debugging log messages. May not contain whitespace."
4763 "@*@*"
4764 "@item LOCK-TIMEOUT\n"
4765 "When not @code{0}, the duration in tenths of a second to wait for the file "
4766 "mutex which has been locked by another thread to be released before returning "
4767 "an error. When @code{-1} the error will be returned immediately."
4768 "@end table\n"
4771 new_command("LS", 1, 1, 0, ls_command, _(
4772 "LS\n"
4773 "Returns a newline separated list of data files stored in the data directory "
4774 "@file{HOMEDIR/data} (@pxref{Invoking}) with a data response."
4777 new_command("RESET", 1, 1, 0, NULL, _(
4778 "RESET\n"
4779 "Closes the currently opened file but keeps any previously set client options "
4780 "(@pxref{OPTION})."
4783 new_command("NOP", 1, 1, 0, NULL, _(
4784 "NOP\n"
4785 "Does nothing. Always returns successfully."
4788 /* !END-HELP-TEXT! */
4789 new_command ("CANCEL", 1, 1, 0, NULL, NULL);
4790 new_command ("END", 1, 1, 0, NULL, NULL);
4791 new_command ("BYE", 1, 1, 0, NULL, NULL);
4793 int i;
4794 for (i = 0; command_table[i]; i++);
4795 qsort (command_table, i - 1, sizeof (struct command_table_s *),
4796 sort_commands);
4799 gpg_error_t
4800 register_commands (assuan_context_t ctx)
4802 int i = 0, rc;
4804 for (; command_table[i]; i++)
4806 if (!command_table[i]->handler)
4807 continue;
4809 rc = assuan_register_command (ctx, command_table[i]->name,
4810 command_table[i]->handler,
4811 command_table[i]->help);
4812 if (rc)
4813 return rc;
4816 rc = assuan_register_bye_notify (ctx, bye_notify);
4817 if (rc)
4818 return rc;
4820 rc = assuan_register_reset_notify (ctx, reset_notify);
4821 if (rc)
4822 return rc;
4824 rc = assuan_register_pre_cmd_notify (ctx, command_startup);
4825 if (rc)
4826 return rc;
4828 return assuan_register_post_cmd_notify (ctx, command_finalize);