2 Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015,
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/>.
30 #include <sys/types.h>
40 #include "pwmd-error.h"
45 #include "util-misc.h"
54 /* These are command option flags. */
55 #define OPT_INQUIRE 0x0001
56 #define OPT_NO_PASSPHRASE 0x0002
57 #define OPT_ASK 0x0004
58 #define OPT_LIST_RECURSE 0x0008
59 #define OPT_VERBOSE 0x0010
60 #define OPT_LOCK 0x0020
61 #define OPT_LOCK_ON_OPEN 0x0040
62 #define OPT_SIGN 0x0080
63 #define OPT_LIST_ALL 0x0100
64 #define OPT_DATA 0x0200
65 #define OPT_NO_AGENT 0x0400
66 #define OPT_SECRET_ONLY 0x0800
67 #define OPT_INQUIRE_KEYID 0x1000
68 #define OPT_INQUIRE_SIGN_KEYID 0x2000
69 #define OPT_SYMMETRIC 0x4000
70 #define OPT_NO_SIGNER 0x8000
71 #define OPT_HTML 0x10000
72 #define OPT_CACHE_AGENT 0x20000
73 #define OPT_CACHE_SIGN 0x40000
75 #define FLOCK_TYPE_NONE 0
76 #define FLOCK_TYPE_SH 0x0001
77 #define FLOCK_TYPE_EX 0x0002
78 #define FLOCK_TYPE_KEEP 0x0004
80 struct command_table_s
83 gpg_error_t (*handler
) (assuan_context_t
, char *line
);
86 int unlock
; // unlock the file mutex after validating the checksum
90 static struct command_table_s
**command_table
;
92 static gpg_error_t
do_lock (struct client_s
*client
, int add
);
93 static gpg_error_t
validate_checksum (struct client_s
*, const char *filename
,
94 struct cache_data_s
*, unsigned char **,
96 static gpg_error_t
update_checksum (struct client_s
*client
);
98 /* When 'status' is true the 'self' field of the status line will be false
99 * because we never send the STATE status message to the same client that
102 build_client_info_line (struct client_thread_s
*thd
, int status
)
104 char *uid
, *username
= NULL
;
106 char *name
= pthread_getspecific (thread_name_key
);
110 uid
= str_asprintf("#%s", thd
->tls
->fp
);
113 uid
= str_asprintf("%u", thd
->peer
->uid
);
114 username
= get_username (thd
->peer
->uid
);
117 uid
= str_asprintf("%u", thd
->peer
->uid
);
118 username
= get_username (thd
->peer
->uid
);
120 line
= str_asprintf ("%p %s %s %s %u %u %u %s %s %u",
123 thd
->cl
&& thd
->cl
->filename
124 && (thd
->cl
->flags
& FLAG_OPEN
)
125 ? thd
->cl
->filename
: "/",
127 thd
->remote
? thd
->peeraddr
: "-",
131 thd
->cl
&& thd
->cl
->flags
& FLAG_HAS_LOCK
? 1 : 0,
132 !status
&& pthread_equal (pthread_self (), thd
->tid
) ? 1 : 0,
135 thd
->remote
? "-" : username
,
148 update_client_state (struct client_s
*client
, unsigned s
)
150 MUTEX_LOCK (&cn_mutex
);
151 client
->thd
->state
= s
;
152 MUTEX_UNLOCK (&cn_mutex
);
154 if (client
->thd
->state
!= CLIENT_STATE_UNKNOWN
)
156 char *line
= build_client_info_line (client
->thd
, 1);
158 pthread_cleanup_push (xfree
, line
);
160 send_status_all_not_self (STATUS_STATE
, "%s", line
);
161 pthread_cleanup_pop (1);
166 unlock_file_mutex (struct client_s
*client
, int remove
)
170 // OPEN: keep the lock for the same file being reopened.
171 if (client
->flags
& FLAG_KEEP_LOCK
&& client
->flags
& FLAG_HAS_LOCK
)
174 if (!(client
->flags
& FLAG_HAS_LOCK
))
175 return GPG_ERR_NOT_LOCKED
;
177 rc
= cache_unlock_mutex (client
->filename
, remove
);
179 rc
= GPG_ERR_INV_STATE
;
181 client
->flags
&= ~(FLAG_HAS_LOCK
| FLAG_LOCK_CMD
);
187 lock_file_mutex (struct client_s
*client
, int add
)
190 int timeout
= config_get_integer (client
->filename
, "cache_timeout");
192 if (client
->flags
& FLAG_HAS_LOCK
)
195 rc
= cache_lock_mutex (client
->ctx
, client
->filename
,
196 client
->lock_timeout
, add
, timeout
);
198 client
->flags
|= FLAG_HAS_LOCK
;
204 file_modified (struct client_s
*client
, struct command_table_s
*cmd
)
207 int type
= !cmd
->flock_type
|| (cmd
->flock_type
& FLOCK_TYPE_SH
)
210 if (!(client
->flags
& FLAG_OPEN
))
211 return GPG_ERR_INV_STATE
;
213 rc
= lock_file_mutex (client
, 0);
214 if (rc
&& rc
!= GPG_ERR_NO_DATA
)
217 rc
= lock_flock (client
->ctx
, client
->filename
, type
, &client
->flock_fd
);
220 rc
= validate_checksum (client
, client
->filename
, NULL
, NULL
, NULL
);
221 if (gpg_err_code (rc
) == GPG_ERR_ENOENT
&& (client
->flags
& FLAG_NEW
))
224 log_write ("%s: %s", client
->filename
, pwmd_strerror (rc
));
226 else if (gpg_err_code (rc
) == GPG_ERR_ENOENT
)
229 /* FLAG_HAS_LOCK may have been set by the LOCK command or OPEN --lock. */
230 if ((cmd
->unlock
&& !(client
->flags
& FLAG_HAS_LOCK
)) || rc
)
231 unlock_file_mutex (client
, 0);
233 if (rc
|| !(cmd
->flock_type
& FLOCK_TYPE_KEEP
))
234 unlock_flock (&client
->flock_fd
);
240 parse_xml (assuan_context_t ctx
, int new)
242 struct client_s
*client
= assuan_get_pointer (ctx
);
243 int cached
= client
->doc
!= NULL
;
248 client
->doc
= xml_new_document ();
254 xmlDocDumpFormatMemory (client
->doc
, &result
, &len
, 0);
255 client
->crypto
->plaintext
= result
;
256 client
->crypto
->plaintext_size
= len
;
257 if (!client
->crypto
->plaintext
)
259 xmlFreeDoc (client
->doc
);
268 rc
= xml_parse_doc ((char *) client
->crypto
->plaintext
,
269 client
->crypto
->plaintext_size
,
270 (xmlDocPtr
*)&client
->doc
);
276 free_client (struct client_s
*client
)
279 xmlFreeDoc (client
->doc
);
282 xfree (client
->filename
);
283 xfree (client
->last_error
);
284 crypto_free (client
->crypto
);
285 client
->crypto
= NULL
;
289 reset_client (struct client_s
*client
)
291 assuan_context_t ctx
= client
->ctx
;
292 struct client_thread_s
*thd
= client
->thd
;
293 long lock_timeout
= client
->lock_timeout
;
294 xmlErrorPtr xml_error
= client
->xml_error
;
295 int no_pinentry
= (client
->flags
& FLAG_NO_PINENTRY
);
296 int flock_fd
= client
->flock_fd
;
298 unlock_file_mutex (client
, client
->flags
& FLAG_NEW
);
299 free_client (client
);
300 memset (client
, 0, sizeof (struct client_s
));
301 client
->flock_fd
= flock_fd
;
302 client
->xml_error
= xml_error
;
305 client
->lock_timeout
= lock_timeout
;
306 client
->flags
|= no_pinentry
? FLAG_NO_PINENTRY
: 0;
315 strv_free ((char **) arg
);
319 parse_open_opt_lock (void *data
, void *value
)
321 struct client_s
*client
= data
;
323 client
->opts
|= OPT_LOCK_ON_OPEN
;
328 parse_opt_inquire (void *data
, void *value
)
330 struct client_s
*client
= data
;
333 client
->opts
|= OPT_INQUIRE
;
338 update_checksum (struct client_s
*client
)
342 struct cache_data_s
*cdata
;
343 gpg_error_t rc
= get_checksum (client
->filename
, &crc
, &len
);
350 cdata
= cache_get_data (client
->filename
);
354 cdata
->crc
= xmalloc (len
);
355 memcpy (cdata
->crc
, crc
, len
);
362 validate_checksum (struct client_s
*client
, const char *filename
,
363 struct cache_data_s
*cdata
, unsigned char **r_crc
,
371 if (cdata
&& !cdata
->crc
)
372 return GPG_ERR_CHECKSUM
;
374 rc
= get_checksum (filename
, &crc
, &len
);
379 n
= memcmp (cdata
->crc
, crc
, len
);
380 else if (client
->crc
)
381 n
= memcmp (client
->crc
, crc
, len
);
391 return n
? GPG_ERR_CHECKSUM
: 0;
395 open_command (assuan_context_t ctx
, char *line
)
398 struct client_s
*client
= assuan_get_pointer (ctx
);
399 char **req
, *filename
;
401 assuan_peercred_t peer
;
402 struct cache_data_s
*cdata
= NULL
;
404 unsigned char *crc
= NULL
;
406 struct argv_s
*args
[] = {
407 &(struct argv_s
) {"lock", OPTION_TYPE_NOARG
, parse_open_opt_lock
},
411 rc
= parse_options (&line
, args
, client
, 1);
413 return send_error (ctx
, rc
);
415 req
= str_split (line
, " ", 2);
417 return send_error (ctx
, GPG_ERR_SYNTAX
);
419 rc
= do_validate_peer (ctx
, req
[0], &peer
);
420 if (rc
== GPG_ERR_FORBIDDEN
)
421 rc
= peer_is_invoker (client
);
426 return send_error (ctx
, rc
);
430 if (!valid_filename (filename
))
433 return send_error (ctx
, GPG_ERR_INV_VALUE
);
436 pthread_cleanup_push ((void *)req_free
, req
);
437 /* This client may have locked a different file with ISCACHED --lock than
438 * the current filename. This will remove that lock. */
439 same_file
= client
->filename
&& !strcmp (filename
, client
->filename
);
440 if (client
->flags
& FLAG_OPEN
||
441 (client
->flags
& FLAG_HAS_LOCK
&& !same_file
))
443 uint32_t opts
= client
->opts
;
444 uint32_t flags
= client
->flags
;
447 client
->flags
|= FLAG_KEEP_LOCK
;
448 else if (client
->flags
& FLAG_NEW
)
449 cache_clear (NULL
, client
->filename
, 0);
451 reset_client (client
);
453 client
->flags
|= flags
;
454 client
->flags
&= ~(FLAG_LOCK_CMD
);
456 client
->flags
&= ~(FLAG_HAS_LOCK
| FLAG_NEW
);
459 client
->filename
= str_dup (filename
);
460 if (!client
->filename
)
463 return send_error(ctx
, GPG_ERR_ENOMEM
);
466 /* Need to lock the mutex here because file_modified() cannot without
467 * knowing the filename. */
468 rc
= lock_file_mutex (client
, 1);
470 client
->flags
&= ~FLAG_OPEN
;
474 rc
= lock_flock (ctx
, filename
, LOCK_SH
, &client
->flock_fd
);
475 if (gpg_err_code (rc
) == GPG_ERR_ENOENT
)
482 char *keyfile
= config_get_string (client
->filename
, "passphrase_file");
484 rc
= crypto_init (&client
->crypto
, client
->ctx
, client
->filename
,
485 client
->flags
& FLAG_NO_PINENTRY
, keyfile
);
489 if (!rc
&& stat (client
->filename
, &st
) == -1)
490 rc
= gpg_error_from_errno (errno
);
491 else if (!rc
&& !S_ISREG (st
.st_mode
)) // to match LS output
492 rc
= gpg_error_from_errno (ENODEV
);
495 if (!rc
|| gpg_err_code (rc
) == GPG_ERR_ENOENT
)
497 cdata
= cache_get_data (client
->filename
);
502 client
->flags
|= FLAG_NEW
;
503 // data file disappeared. clear the cache entry.
504 cache_clear (NULL
, client
->filename
, 1);
507 else if (cdata
&& cdata
->doc
) // cached document
512 if (!rc
&& !(client
->flags
& FLAG_NEW
))
514 rc
= validate_checksum (client
, client
->filename
, cdata
, &crc
,
516 if (rc
== GPG_ERR_CHECKSUM
)
525 rc
= cache_iscached (client
->filename
, &defer
, 0, 0);
526 if ((!rc
|| rc
== GPG_ERR_ENOENT
) && defer
)
536 log_write ("%s: %s", client
->filename
,
537 pwmd_strerror (GPG_ERR_CHECKSUM
));
538 cache_clear (NULL
, client
->filename
, 1);
540 rc
= crypto_decrypt (client
, client
->crypto
);
545 if (client
->thd
->remote
546 && config_get_boolean (client
->filename
, "tcp_require_key")
547 && !(client
->flags
& FLAG_NEW
))
548 rc
= crypto_try_decrypt (client
,
549 (client
->flags
& FLAG_NO_PINENTRY
));
555 client
->crypto
->plaintext
= cdata
->doc
;
556 client
->crypto
->plaintext_size
= cdata
->size
;
557 rc
= cache_decrypt (client
->crypto
);
562 strv_free (client
->crypto
->pubkey
);
563 strv_free (client
->crypto
->sigkey
);
564 client
->crypto
->pubkey
= strv_dup (cdata
->pubkey
);
565 client
->crypto
->sigkey
= strv_dup (cdata
->sigkey
);
570 client
->crypto
->plaintext
= NULL
;
571 client
->crypto
->plaintext_size
= 0;
575 else // existing file
577 cached
= cdata
!= NULL
;
578 rc
= crypto_decrypt (client
, client
->crypto
);
584 rc
= parse_xml (ctx
, client
->flags
& FLAG_NEW
);
587 rc
= cache_encrypt (client
->crypto
);
589 cache_clear (NULL
, client
->filename
, 1);
592 int timeout
= config_get_integer (client
->filename
,
595 cache_free_data_once (cdata
);
596 cdata
= xcalloc (1, sizeof (struct cache_data_s
));
597 cdata
->doc
= client
->crypto
->plaintext
;
598 cdata
->size
= client
->crypto
->plaintext_size
;
599 cdata
->pubkey
= strv_dup(client
->crypto
->pubkey
);
600 cdata
->sigkey
= strv_dup(client
->crypto
->sigkey
);
601 client
->crypto
->plaintext
= NULL
;
602 client
->crypto
->plaintext_size
= 0;
604 if (cached
) // wont increment the refcount
606 /* Prevent using another FD to update the checksum for a
607 * cached data file. The validity has already been
610 client
->crc
= xmalloc (crclen
);
611 memcpy (client
->crc
, crc
, crclen
);
613 cdata
->crc
= xmalloc (crclen
);
614 memcpy (cdata
->crc
, crc
, crclen
);
616 rc
= cache_set_data (client
->filename
, cdata
);
617 /* The cache entry may have been removed and cache_set_data()
618 * already sent STATUS_CACHE. */
619 if (!cache_iscached (client
->filename
, NULL
, 0, 0))
620 rc
= send_status (ctx
, STATUS_CACHE
, NULL
);
623 rc
= cache_add_file (client
->filename
, cdata
, timeout
);
628 pthread_cleanup_pop (1);
631 if (!rc
&& !(client
->flags
& FLAG_NEW
) && !cached
)
632 rc
= update_checksum (client
);
636 client
->flags
|= FLAG_OPEN
;
638 if (client
->flags
& FLAG_NEW
)
639 rc
= send_status (ctx
, STATUS_NEWFILE
, NULL
);
641 if (!rc
&& (client
->opts
& OPT_LOCK_ON_OPEN
))
642 rc
= do_lock (client
, 0);
647 log_write ("%s: %s", client
->filename
, pwmd_strerror (rc
));
649 if (client
->flags
& FLAG_NEW
)
650 cache_clear (NULL
, client
->filename
, 1);
652 crypto_free (client
->crypto
);
653 client
->crypto
= NULL
;
654 client
->flags
&= ~FLAG_OPEN
;
657 crypto_free_non_keys (client
->crypto
);
659 return send_error (ctx
, rc
);
662 /* If not the invoking_user or is an existing file, check that the list of user
663 * supplied key ID's are in the list of current key ID's obtained when
664 * decrypting the data file.
667 permitted_to_save (struct client_s
*client
, const char **keys
,
673 if ((client
->flags
& FLAG_NEW
) || (client
->opts
& OPT_SYMMETRIC
))
676 rc
= peer_is_invoker (client
);
681 if ((!value
&& !keys
) || ((value
&& !*value
) && (keys
&& !*keys
)))
684 for (v
= value
; v
&& *v
; v
++)
686 const char **k
, *pv
= *v
;
689 if (*pv
== '0' && *(pv
+1) == 'x')
692 for (k
= keys
; k
&& *k
; k
++)
696 if (*pk
== '0' && *(pk
+1) == 'x')
699 rc
= !strcmp (pv
, pk
) ? 0 : GPG_ERR_FORBIDDEN
;
701 rc
= !strcmp (pv
, *k
) ? 0 : GPG_ERR_FORBIDDEN
;
711 return GPG_ERR_FORBIDDEN
;
717 /* Requires that the keyid be a fingerprint in 16 byte form. */
719 parse_save_opt_keyid_common (struct client_s
*client
, const char **list
,
720 const char *value
, char ***dst
)
727 keys
= str_split (value
, ",", 0);
729 return GPG_ERR_ENOMEM
;
732 rc
= crypto_keyid_to_16b (keys
);
734 rc
= permitted_to_save (client
, list
, (const char **)keys
);
745 parse_save_opt_keyid (void *data
, void *value
)
747 struct client_s
*client
= data
;
748 const char *str
= value
;
752 rc
= parse_save_opt_keyid_common (client
,
753 (const char **)client
->crypto
->pubkey
,
758 client
->crypto
->save
.pubkey
= dst
;
763 parse_save_opt_sign_keyid (void *data
, void *value
)
765 struct client_s
*client
= data
;
766 const char *str
= value
;
770 rc
= parse_save_opt_keyid_common (client
,
771 (const char **)client
->crypto
->sigkey
,
777 client
->opts
|= OPT_NO_SIGNER
;
779 client
->crypto
->save
.sigkey
= dst
;
784 parse_save_opt_inquire (struct client_s
*client
, uint32_t opt
)
786 if (opt
== OPT_INQUIRE
&& !(client
->flags
& FLAG_NEW
))
788 gpg_error_t rc
= peer_is_invoker (client
);
799 parse_save_opt_inquire_keyparam (void *data
, void *value
)
801 return parse_save_opt_inquire (data
, OPT_INQUIRE
);
805 parse_save_opt_inquire_keyid (void *data
, void *value
)
807 return parse_save_opt_inquire (data
, OPT_INQUIRE_KEYID
);
811 parse_save_opt_inquire_sign_keyid (void *data
, void *value
)
813 return parse_save_opt_inquire (data
, OPT_INQUIRE_SIGN_KEYID
);
817 parse_save_opt_symmetric (void *data
, void *value
)
819 struct client_s
*client
= data
;
821 client
->opts
|= OPT_SYMMETRIC
;
825 /* Tests that the keys in new_keys are also in old_keys. */
827 compare_keys (char **new_keys
, char **old_keys
)
831 if (!old_keys
|| !*old_keys
)
834 crypto_keyid_to_16b (new_keys
);
836 for (o
= old_keys
; *o
; o
++)
840 for (n
= new_keys
; *n
; n
++)
842 if (!strcmp (*n
, *o
))
847 return GPG_ERR_NOT_FOUND
;
854 inquire_keyid (struct client_s
*client
, uint32_t opt
)
857 unsigned char *result
= NULL
;
863 if (opt
== OPT_INQUIRE_KEYID
)
866 orig
= &client
->crypto
->pubkey
;
867 save
= &client
->crypto
->save
.pubkey
;
871 s
= "INQUIRE_SIGN_KEYID";
872 orig
= &client
->crypto
->sigkey
;
873 save
= &client
->crypto
->save
.sigkey
;
876 rc
= assuan_inquire (client
->ctx
, s
, &result
, &len
, 0);
881 rc
= parse_save_opt_keyid_common (client
, (const char **)*orig
,
882 (char *)result
, &dst
);
885 if (!dst
&& opt
== OPT_INQUIRE_SIGN_KEYID
886 && client
->opts
& OPT_SYMMETRIC
)
887 client
->opts
|= OPT_NO_SIGNER
;
897 /* The caching test of gpg-agent is both a blessing and a curse. When a key
898 * lookup in its cache fails it tries the last successful key to be unlocked.
899 * This prevents pwmd from successfully clearing a signing key since the
900 * previous key, which more than likely belongs to the same keypair as the
901 * encryption/decryption key, will have the passphrase cached and therefore the
902 * signing key also cached. So we need to clear both the signing and encryption
903 * keys to get the effect of requiring a passphrase when generating a new
904 * keypair for an existing data file, or when the "require_save_key"
905 * configuration parameter is set. The "require_save_key" parameter is mostly a
906 * failsafe of the gpg-agent option --ignore-cache-for-signing since
907 * some/most/all users may fail to set it.
910 save_command (assuan_context_t ctx
, char *line
)
912 struct client_s
*client
= assuan_get_pointer (ctx
);
913 struct cache_data_s
*cdata
= NULL
;
914 gpg_error_t rc
= 0, cached
= 0;
917 struct argv_s
*args
[] = {
918 &(struct argv_s
) {"keyid", OPTION_TYPE_ARG
, parse_save_opt_keyid
},
919 &(struct argv_s
) {"sign-keyid", OPTION_TYPE_OPTARG
,
920 parse_save_opt_sign_keyid
},
921 &(struct argv_s
) {"inquire-keyparam", OPTION_TYPE_NOARG
,
922 parse_save_opt_inquire_keyparam
},
923 &(struct argv_s
) {"inquire-keyid", OPTION_TYPE_NOARG
,
924 parse_save_opt_inquire_keyid
},
925 &(struct argv_s
) {"inquire-sign-keyid", OPTION_TYPE_NOARG
,
926 parse_save_opt_inquire_sign_keyid
},
927 &(struct argv_s
) {"symmetric", OPTION_TYPE_NOARG
,
928 parse_save_opt_symmetric
},
932 crypto_free_save (&client
->crypto
->save
);
934 if (!(client
->flags
& FLAG_NEW
))
936 rc
= crypto_is_symmetric (client
->filename
);
937 if (!rc
|| rc
== GPG_ERR_BAD_DATA
)
940 client
->opts
|= OPT_SYMMETRIC
;
947 return send_error (ctx
, rc
);
949 rc
= parse_options (&line
, args
, client
, 0);
951 return send_error (ctx
, rc
);
953 if (config_get_boolean (client
->filename
, "require_save_key"))
954 client
->opts
|= OPT_ASK
;
956 if (lstat (client
->filename
, &st
) == -1 && errno
!= ENOENT
)
957 return send_error (ctx
, gpg_error_from_errno (errno
));
959 if (errno
!= ENOENT
&& !S_ISREG (st
.st_mode
))
961 log_write ("%s: %s", client
->filename
, pwmd_strerror (GPG_ERR_ENODEV
));
962 return send_error (ctx
, GPG_ERR_ENODEV
);
966 cached
= rc
= cache_iscached (client
->filename
, &defer
, 0, 1);
968 if (gpg_err_code (rc
) == GPG_ERR_ENOENT
&& (client
->flags
& FLAG_NEW
))
970 else if (gpg_err_code (rc
) == GPG_ERR_NO_DATA
)
974 return send_error (ctx
, rc
);
976 /* Specifying both a recipient and symmetric encryption is an error. */
977 if (client
->opts
& OPT_INQUIRE_KEYID
&& client
->opts
& OPT_SYMMETRIC
)
979 return send_error (ctx
, GPG_ERR_CONFLICT
);
981 else if (client
->opts
& OPT_INQUIRE
&& client
->opts
& OPT_SYMMETRIC
)
983 return send_error (ctx
, GPG_ERR_CONFLICT
);
985 /* Existing file with a recipient and wanting symmetric is an error. */
986 else if (client
->opts
& OPT_SYMMETRIC
&& client
->crypto
->save
.pubkey
)
988 return send_error (ctx
, GPG_ERR_CONFLICT
);
990 else if (((client
->opts
& OPT_INQUIRE_KEYID
)
991 || (client
->opts
& OPT_INQUIRE_SIGN_KEYID
)))
993 if (client
->opts
& OPT_INQUIRE
)
994 return send_error (ctx
, GPG_ERR_CONFLICT
);
996 if (client
->opts
& OPT_INQUIRE_KEYID
)
997 rc
= inquire_keyid (client
, OPT_INQUIRE_KEYID
);
999 if (!rc
&& (client
->opts
& OPT_INQUIRE_SIGN_KEYID
))
1000 rc
= inquire_keyid (client
, OPT_INQUIRE_SIGN_KEYID
);
1002 else if ((client
->crypto
->save
.pubkey
|| client
->crypto
->save
.sigkey
)
1003 && client
->opts
& OPT_INQUIRE
)
1004 return send_error (ctx
, GPG_ERR_CONFLICT
);
1008 client
->crypto
->keyfile
= config_get_string (client
->filename
,
1010 rc
= crypto_init_ctx (client
->crypto
, (client
->flags
& FLAG_NO_PINENTRY
),
1011 client
->crypto
->keyfile
);
1014 if (!rc
&& (client
->opts
& OPT_INQUIRE
))
1016 /* Require a passphrase when generating a new key pair for an existing
1019 if (!(client
->flags
& FLAG_NEW
))
1021 rc
= cache_clear_agent_keys (client
->filename
, 1, 1);
1024 rc
= crypto_try_decrypt (client
, client
->flags
& FLAG_NO_PINENTRY
);
1025 client
->opts
&= ~OPT_ASK
;
1031 unsigned char *params
= NULL
;
1034 rc
= assuan_inquire (client
->ctx
, "KEYPARAM", ¶ms
, &len
, 0);
1037 client
->crypto
->flags
|= CRYPTO_FLAG_NEWFILE
;
1038 pthread_cleanup_push ((void *)xfree
, params
);
1039 rc
= crypto_genkey (client
, client
->crypto
, params
);
1040 pthread_cleanup_pop (1);
1044 else if (!rc
&& (client
->flags
& FLAG_NEW
))
1046 if (!client
->crypto
->save
.pubkey
&& !client
->crypto
->save
.sigkey
1047 && !(client
->opts
& OPT_SYMMETRIC
))
1049 char *params
= crypto_default_key_params ();
1052 rc
= GPG_ERR_ENOMEM
;
1056 client
->crypto
->flags
|= CRYPTO_FLAG_NEWFILE
;
1057 pthread_cleanup_push ((void *)xfree
, params
);
1058 rc
= crypto_genkey (client
, client
->crypto
,
1059 (unsigned char *)params
);
1060 pthread_cleanup_pop (1);
1065 if (!client
->crypto
->save
.pubkey
&& client
->crypto
->save
.sigkey
1066 && !(client
->opts
& OPT_SYMMETRIC
))
1067 client
->crypto
->save
.pubkey
= strv_dup (client
->crypto
->save
.sigkey
);
1069 if (client
->crypto
->save
.pubkey
&& !client
->crypto
->save
.sigkey
)
1070 client
->crypto
->save
.sigkey
= strv_dup (client
->crypto
->save
.pubkey
);
1075 cdata
= cache_get_data (client
->filename
);
1078 if (client
->crypto
->save
.pubkey
)
1079 rc
= compare_keys (client
->crypto
->save
.pubkey
, cdata
->pubkey
);
1081 /* Always allow a signer for symmetric data files. */
1082 if (!rc
&& client
->crypto
->save
.sigkey
1083 && !(client
->opts
& OPT_SYMMETRIC
))
1084 rc
= compare_keys (client
->crypto
->save
.sigkey
, cdata
->sigkey
);
1086 /* Prevent saving to a recipient who is not in the original recipient
1087 * list without a passphrase. */
1088 if (rc
|| (client
->crypto
->sigkey
&& client
->opts
& OPT_NO_SIGNER
))
1089 client
->opts
|= OPT_ASK
;
1091 if (rc
== GPG_ERR_NOT_FOUND
)
1093 rc
= peer_is_invoker (client
);
1094 if (rc
== GPG_ERR_EACCES
)
1095 rc
= GPG_ERR_FORBIDDEN
;
1098 if (!client
->crypto
->save
.pubkey
1099 && !(client
->opts
& OPT_SYMMETRIC
))
1100 client
->crypto
->save
.pubkey
= strv_dup (cdata
->pubkey
);
1102 if (!rc
&& !client
->crypto
->save
.sigkey
&& cdata
->sigkey
1103 && !(client
->opts
& OPT_NO_SIGNER
))
1104 client
->crypto
->save
.sigkey
= strv_dup (cdata
->sigkey
);
1105 else if (!rc
&& !client
->crypto
->save
.sigkey
1106 && (client
->opts
& OPT_NO_SIGNER
)
1107 && !(client
->opts
& OPT_SYMMETRIC
))
1108 rc
= GPG_ERR_NO_SIGNATURE_SCHEME
;
1112 client
->crypto
->save
.pubkey
= strv_dup (client
->crypto
->pubkey
);
1113 client
->crypto
->save
.sigkey
= strv_dup (client
->crypto
->sigkey
);
1117 if (!rc
&& !(client
->flags
& FLAG_NEW
))
1119 /* Fixes {NEW_,SIGN_}PASSPHRASE inquire keywords. See passphrase_cb(). */
1120 if (client
->opts
& OPT_SYMMETRIC
)
1121 client
->crypto
->flags
|= CRYPTO_FLAG_PASSWD
;
1123 if (client
->opts
& OPT_ASK
)
1125 rc
= cache_clear_agent_keys (client
->filename
, 1, 1);
1127 rc
= crypto_try_decrypt (client
, client
->flags
& FLAG_NO_PINENTRY
);
1131 if (!rc
&& client
->opts
& OPT_SYMMETRIC
)
1132 client
->crypto
->flags
|= CRYPTO_FLAG_PASSWD_NEW
;
1135 rc
= xml_update_element_mtime (client
, xmlDocGetRootElement (client
->doc
));
1141 xmlDocDumpFormatMemory (client
->doc
, &client
->crypto
->plaintext
, &size
,
1144 client
->crypto
->plaintext_size
= (size_t) size
;
1146 rc
= GPG_ERR_ENOMEM
;
1150 client
->crypto
->flags
|= (client
->opts
& OPT_SYMMETRIC
) ? CRYPTO_FLAG_SYMMETRIC
: 0;
1151 client
->crypto
->flags
|= (client
->flags
& FLAG_NEW
) ? CRYPTO_FLAG_NEWFILE
: 0;
1152 client
->crypto
->flags
|= !(client
->opts
& OPT_SYMMETRIC
) ? CRYPTO_FLAG_PASSWD_SIGN
: 0;
1153 rc
= crypto_encrypt (client
, client
->crypto
);
1154 client
->crypto
->flags
&= ~CRYPTO_FLAG_SYMMETRIC
;
1159 rc
= crypto_write_file (client
->crypto
);
1162 if (!cached
) // no error
1163 cdata
= cache_get_data (client
->filename
);
1168 rc
= cache_encrypt (client
->crypto
);
1171 cache_clear (NULL
, client
->filename
, 1);
1172 strv_free (client
->crypto
->pubkey
);
1173 client
->crypto
->pubkey
= strv_dup (client
->crypto
->save
.pubkey
);
1174 strv_free (client
->crypto
->sigkey
);
1175 client
->crypto
->sigkey
= strv_dup (client
->crypto
->save
.sigkey
);
1176 client
->flags
&= ~(FLAG_NEW
);
1182 int timeout
= config_get_integer (client
->filename
,
1185 cache_free_data_once (cdata
);
1186 cdata
= xcalloc (1, sizeof (struct cache_data_s
));
1187 cdata
->doc
= client
->crypto
->plaintext
;
1188 client
->crypto
->plaintext
= NULL
;
1189 cdata
->size
= client
->crypto
->plaintext_size
;
1190 client
->crypto
->plaintext_size
= 0;
1191 cdata
->pubkey
= client
->crypto
->save
.pubkey
;
1192 client
->crypto
->save
.pubkey
= NULL
;
1193 cdata
->sigkey
= client
->crypto
->save
.sigkey
;
1194 client
->crypto
->save
.sigkey
= NULL
;
1196 /* Update in case the cache entry expires the next SAVE may not
1197 * have any known keys. */
1198 strv_free (client
->crypto
->pubkey
);
1199 client
->crypto
->pubkey
= strv_dup (cdata
->pubkey
);
1200 strv_free (client
->crypto
->sigkey
);
1201 client
->crypto
->sigkey
= strv_dup (cdata
->sigkey
);
1203 if (!cached
) // no error and wont increment refcount
1204 rc
= cache_set_data (client
->filename
, cdata
);
1206 rc
= cache_add_file (client
->filename
, cdata
, timeout
);
1208 if (!rc
&& (cached
|| (client
->flags
& FLAG_NEW
)))
1209 send_status_all (STATUS_CACHE
, NULL
);
1213 rc
= update_checksum (client
);
1214 client
->flags
&= ~(FLAG_NEW
);
1220 crypto_free_non_keys (client
->crypto
);
1221 return send_error (ctx
, rc
);
1225 do_delete (assuan_context_t ctx
, char *line
)
1227 struct client_s
*client
= assuan_get_pointer (ctx
);
1228 struct xml_request_s
*req
;
1232 rc
= xml_new_request (client
, line
, XML_CMD_DELETE
, &req
);
1236 n
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
1237 xml_free_request (req
);
1241 rc
= xml_is_element_owner (client
, n
);
1243 rc
= xml_unlink_node (client
, n
);
1249 delete_command (assuan_context_t ctx
, char *line
)
1251 struct client_s
*client
= assuan_get_pointer (ctx
);
1253 struct argv_s
*args
[] = {
1254 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
1258 rc
= parse_options (&line
, args
, client
, 1);
1259 if (!rc
&& (client
->opts
& OPT_INQUIRE
) && line
&& *line
)
1260 rc
= GPG_ERR_SYNTAX
;
1262 return send_error (ctx
, rc
);
1264 if (client
->opts
& OPT_INQUIRE
)
1266 unsigned char *result
;
1269 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
1271 return send_error (ctx
, rc
);
1273 pthread_cleanup_push ((void *)xfree
, result
);
1274 rc
= do_delete (ctx
, (char *)result
);
1275 pthread_cleanup_pop (1);
1278 rc
= do_delete (ctx
, line
);
1280 return send_error (ctx
, rc
);
1284 update_element_expirey (struct client_s
*client
, xmlNodePtr n
)
1287 xmlChar
*expire
, *incr
;
1289 time_t e
, e_orig
, i
;
1290 time_t now
= time (NULL
);
1292 expire
= xml_attribute_value (n
, (xmlChar
*)"expire");
1297 e
= strtoul ((char *)expire
, &p
, 10);
1298 if (errno
|| *p
|| e
== ULONG_MAX
|| *expire
== '-')
1301 rc
= GPG_ERR_ERANGE
;
1306 incr
= xml_attribute_value (n
, (xmlChar
*)"expire_increment");
1310 i
= strtoul ((char *)incr
, &p
, 10);
1311 if (errno
|| *p
|| i
== ULONG_MAX
|| *incr
== '-')
1314 rc
= GPG_ERR_ERANGE
;
1321 p
= str_asprintf ("%lu", e
);
1324 rc
= GPG_ERR_ENOMEM
;
1328 rc
= xml_add_attribute (client
, n
, "expire", p
);
1331 rc
= send_status (client
->ctx
, STATUS_EXPIRE
, "%lu %lu", e_orig
, e
);
1338 store_command (assuan_context_t ctx
, char *line
)
1340 struct client_s
*client
= assuan_get_pointer (ctx
);
1343 unsigned char *result
;
1344 xmlNodePtr n
, parent
;
1346 char *content
= NULL
;
1347 struct xml_request_s
*req
;
1350 return send_error (ctx
, GPG_ERR_SYNTAX
);
1352 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
1354 return send_error (ctx
, rc
);
1356 rc
= xml_new_request (client
, (char *)result
, XML_CMD_STORE
, &req
);
1359 return send_error (ctx
, rc
);
1361 /* Prevent passing the element content around to save some memory. */
1362 len
= strv_length (req
->args
);
1363 has_content
= line
[strlen (line
) - 1] != '\t' && len
> 1;
1364 if (*(req
->args
+1) && !xml_valid_element_path (req
->args
, has_content
))
1366 xml_free_request (req
);
1367 return send_error (ctx
, GPG_ERR_INV_VALUE
);
1370 if (has_content
|| !*req
->args
[len
-1])
1373 content
= req
->args
[len
-1];
1374 req
->args
[len
-1] = NULL
;
1377 if (strv_length (req
->args
) > 1)
1379 rc
= xml_check_recursion (client
, req
);
1380 if (rc
&& rc
!= GPG_ERR_ELEMENT_NOT_FOUND
)
1384 parent
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
1388 rc
= xml_is_element_owner (client
, parent
);
1391 n
= xml_find_text_node (parent
->children
);
1393 xmlNodeSetContent (n
, (xmlChar
*) content
);
1395 xmlNodeAddContent (parent
, (xmlChar
*) content
);
1397 (void)xml_update_element_mtime (client
, parent
);
1398 (void)update_element_expirey (client
, parent
);
1404 xml_free_request (req
);
1405 return send_error (ctx
, rc
);
1409 xfer_data (assuan_context_t ctx
, const char *line
, int total
)
1411 struct client_s
*client
= assuan_get_pointer (ctx
);
1415 int progress
= config_get_integer ("global", "xfer_progress");
1418 if (!(client
->flags
& FLAG_LOCK_CMD
))
1419 rc
= unlock_file_mutex (client
, 0);
1420 if (rc
&& rc
!= GPG_ERR_NOT_LOCKED
)
1424 progress
> 0 ? (progress
/ ASSUAN_LINELENGTH
) * ASSUAN_LINELENGTH
: 0;
1425 to_send
= total
< ASSUAN_LINELENGTH
? total
: ASSUAN_LINELENGTH
;
1426 rc
= send_status (ctx
, STATUS_XFER
, "%li %li", sent
, total
);
1434 if (sent
+ to_send
> total
)
1435 to_send
= total
- sent
;
1437 rc
= assuan_send_data (ctx
, flush
? NULL
: (char *) line
+ sent
,
1438 flush
? 0 : to_send
);
1441 sent
+= flush
? 0 : to_send
;
1443 if ((progress
&& !(sent
% progress
) && sent
!= total
) ||
1444 (sent
== total
&& flush
))
1445 rc
= send_status (ctx
, STATUS_XFER
, "%li %li", sent
, total
);
1447 if (!flush
&& !rc
&& sent
== total
)
1454 while (!rc
&& sent
< total
);
1460 do_get (assuan_context_t ctx
, char *line
)
1462 struct client_s
*client
= assuan_get_pointer (ctx
);
1464 struct xml_request_s
*req
;
1467 rc
= xml_new_request (client
, line
, XML_CMD_NONE
, &req
);
1471 n
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
1474 if (n
&& n
->children
)
1478 n
= xml_find_text_node (n
->children
);
1479 if (!n
|| !n
->content
|| !*n
->content
)
1480 rc
= GPG_ERR_NO_DATA
;
1483 rc
= xfer_data (ctx
, (char *) n
->content
, xmlStrlen (n
->content
));
1486 xmlChar
*expire
= xml_attribute_value (tmp
,
1487 (xmlChar
*)"expire");
1490 time_t now
= time (NULL
);
1495 e
= strtoul ((char *)expire
, &p
, 10);
1496 if (errno
|| *p
|| e
== ULONG_MAX
|| *expire
== '-')
1497 log_write (_("invalid expire attribute value: %s"),
1500 rc
= send_status (ctx
, STATUS_EXPIRE
, "%lu 0", e
);
1508 rc
= GPG_ERR_NO_DATA
;
1511 xml_free_request (req
);
1516 get_command (assuan_context_t ctx
, char *line
)
1518 struct client_s
*client
= assuan_get_pointer (ctx
);
1520 struct argv_s
*args
[] = {
1521 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
1525 rc
= parse_options (&line
, args
, client
, 1);
1526 if (!rc
&& (client
->opts
& OPT_INQUIRE
) && line
&& *line
)
1527 rc
= GPG_ERR_SYNTAX
;
1529 return send_error (ctx
, rc
);
1531 if (client
->opts
& OPT_INQUIRE
)
1533 unsigned char *result
;
1536 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
1538 return send_error (ctx
, rc
);
1540 pthread_cleanup_push ((void *)xfree
, result
);
1541 rc
= do_get (ctx
, (char *)result
);
1542 pthread_cleanup_pop (1);
1545 rc
= do_get (ctx
, line
);
1547 return send_error (ctx
, rc
);
1550 static void list_command_free1 (void *arg
);
1552 realpath_command (assuan_context_t ctx
, char *line
)
1555 char **realpath
= NULL
;
1556 struct client_s
*client
= assuan_get_pointer (ctx
);
1557 struct argv_s
*args
[] = {
1558 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
1562 rc
= parse_options (&line
, args
, client
, 1);
1563 if (!rc
&& (client
->opts
& OPT_INQUIRE
) && line
&& *line
)
1564 rc
= GPG_ERR_SYNTAX
;
1566 return send_error (ctx
, rc
);
1568 if (client
->opts
& OPT_INQUIRE
)
1570 unsigned char *result
;
1573 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
1575 return send_error (ctx
, rc
);
1577 pthread_cleanup_push ((void *)xfree
, result
);
1578 (void)xml_resolve_path (client
, client
->doc
, result
, &realpath
, &rc
);
1579 pthread_cleanup_pop (1);
1582 (void)xml_resolve_path (client
, client
->doc
, (unsigned char *)line
,
1587 char *tmp
= strv_join ("\t", realpath
);
1589 strv_free (realpath
);
1591 return send_error (ctx
, GPG_ERR_ENOMEM
);
1593 pthread_cleanup_push ((void *)xfree
, tmp
);
1594 rc
= xfer_data (ctx
, tmp
, strlen (tmp
));
1595 pthread_cleanup_pop (1);
1598 return send_error (ctx
, rc
);
1602 list_command_free1 (void *arg
)
1605 string_free ((struct string_s
*) arg
, 1);
1609 parse_list_opt_recurse (void *data
, void *value
)
1611 struct client_s
*client
= data
;
1613 client
->opts
|= OPT_LIST_RECURSE
;
1618 parse_opt_verbose (void *data
, void *value
)
1620 struct client_s
*client
= data
;
1622 client
->opts
|= OPT_VERBOSE
;
1627 list_path_once (struct client_s
*client
, char *line
,
1628 struct element_list_s
*elements
, struct string_s
*result
)
1632 rc
= xml_create_path_list (client
, client
->doc
, NULL
, elements
, line
, 0);
1633 if (rc
== GPG_ERR_ELOOP
|| rc
== GPG_ERR_EACCES
)
1638 int total
= slist_length (elements
->list
);
1644 for (i
= 0; i
< total
; i
++)
1646 char *tmp
= slist_nth_data (elements
->list
, i
);
1648 string_append_printf (result
, "%s%s", tmp
,
1649 i
+ 1 == total
? "" : "\n");
1653 rc
= GPG_ERR_NO_DATA
;
1660 do_list (assuan_context_t ctx
, char *line
)
1662 struct client_s
*client
= assuan_get_pointer (ctx
);
1663 gpg_error_t rc
= GPG_ERR_NO_DATA
;
1664 struct element_list_s
*elements
= NULL
;
1666 if (!line
|| !*line
)
1668 struct string_s
*str
= string_new (NULL
);
1672 return GPG_ERR_ENOMEM
;
1674 pthread_cleanup_push ((void *)list_command_free1
, str
);
1675 n
= xmlDocGetRootElement (client
->doc
);
1676 for (n
= n
->children
; n
; n
= n
->next
)
1680 if (n
->type
!= XML_ELEMENT_NODE
)
1683 name
= xmlGetProp (n
, (xmlChar
*)"_name");
1686 rc
= GPG_ERR_ENOMEM
;
1690 elements
= xcalloc (1, sizeof (struct element_list_s
));
1694 rc
= GPG_ERR_ENOMEM
;
1698 elements
->prefix
= string_new (NULL
);
1699 if (!elements
->prefix
)
1702 xml_free_element_list (elements
);
1703 rc
= GPG_ERR_ENOMEM
;
1707 elements
->recurse
= client
->opts
& OPT_LIST_RECURSE
;
1708 elements
->root_only
= !elements
->recurse
;
1709 pthread_cleanup_push ((void *)xml_free_element_list
, elements
);
1710 rc
= list_path_once (client
, (char *)name
, elements
, str
);
1712 pthread_cleanup_pop (1);
1717 string_append (str
, "\n");
1721 rc
= xfer_data (ctx
, str
->str
, str
->len
);
1723 pthread_cleanup_pop (1);
1727 elements
= xcalloc (1, sizeof (struct element_list_s
));
1729 return GPG_ERR_ENOMEM
;
1731 elements
->prefix
= string_new (NULL
);
1732 if (!elements
->prefix
)
1734 xml_free_element_list (elements
);
1735 return GPG_ERR_ENOMEM
;
1738 elements
->recurse
= client
->opts
& OPT_LIST_RECURSE
;
1739 pthread_cleanup_push ((void *)xml_free_element_list
, elements
);
1740 struct string_s
*str
= string_new (NULL
);
1741 pthread_cleanup_push ((void *)list_command_free1
, str
);
1742 rc
= list_path_once (client
, line
, elements
, str
);
1744 rc
= xfer_data (ctx
, str
->str
, str
->len
);
1746 pthread_cleanup_pop (1);
1747 pthread_cleanup_pop (1);
1752 list_command (assuan_context_t ctx
, char *line
)
1754 struct client_s
*client
= assuan_get_pointer (ctx
);
1756 struct argv_s
*args
[] = {
1757 &(struct argv_s
) {"recurse", OPTION_TYPE_NOARG
, parse_list_opt_recurse
},
1758 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
1759 /* These are deprecated but kept for backward compatibility with older
1761 &(struct argv_s
) {"verbose", OPTION_TYPE_NOARG
, NULL
},
1762 &(struct argv_s
) {"with-target", OPTION_TYPE_NOARG
, NULL
},
1763 &(struct argv_s
) {"all", OPTION_TYPE_NOARG
, parse_list_opt_recurse
},
1764 &(struct argv_s
) {"no-recurse", OPTION_TYPE_NOARG
, NULL
},
1768 if (disable_list_and_dump
== 1)
1769 return send_error (ctx
, GPG_ERR_NOT_IMPLEMENTED
);
1771 rc
= parse_options (&line
, args
, client
, 1);
1772 if (!rc
&& (client
->opts
& OPT_INQUIRE
) && line
&& *line
)
1773 rc
= GPG_ERR_SYNTAX
;
1775 return send_error (ctx
, rc
);
1777 if (client
->opts
& OPT_INQUIRE
)
1779 unsigned char *result
;
1782 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
1784 return send_error (ctx
, rc
);
1786 pthread_cleanup_push ((void *)xfree
, result
);
1787 rc
= do_list (ctx
, (char *)result
);
1788 pthread_cleanup_pop (1);
1791 rc
= do_list (ctx
, line
);
1793 return send_error (ctx
, rc
);
1796 #define RESUMABLE_ERROR(rc) (rc == GPG_ERR_ELOOP || rc == GPG_ERR_EACCES \
1797 || rc == GPG_ERR_ELEMENT_NOT_FOUND || !rc)
1799 * args[0] - element path
1802 attribute_list (assuan_context_t ctx
, char **args
)
1804 struct client_s
*client
= assuan_get_pointer (ctx
);
1805 char **attrlist
= NULL
;
1809 xmlNodePtr n
, an
, r
;
1812 struct xml_request_s
*req
;
1814 if (!args
|| !args
[0] || !*args
[0])
1815 return GPG_ERR_SYNTAX
;
1817 rc
= xml_new_request (client
, args
[0], XML_CMD_ATTR_LIST
, &req
);
1821 n
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
1822 xml_free_request (req
);
1827 for (a
= n
->properties
; a
; a
= a
->next
)
1831 if (target
&& xml_reserved_attribute ((char *)a
->name
))
1834 pa
= xrealloc (attrlist
, (i
+ 2) * sizeof (char *));
1838 strv_free (attrlist
);
1840 log_write ("%s(%i): %s", __FILE__
, __LINE__
,
1841 pwmd_strerror (GPG_ERR_ENOMEM
));
1842 return GPG_ERR_ENOMEM
;
1847 attrlist
[i
] = str_asprintf ("%s %s", (char *) a
->name
, an
&& an
->content
1848 ? (char *)an
->content
: "");
1852 strv_free (attrlist
);
1853 log_write ("%s(%i): %s", __FILE__
, __LINE__
,
1854 pwmd_strerror (GPG_ERR_ENOMEM
));
1855 return GPG_ERR_ENOMEM
;
1858 attrlist
[++i
] = NULL
;
1862 return GPG_ERR_NO_DATA
;
1866 r
= xml_resolve_path (client
, client
->doc
, (xmlChar
*)args
[0], NULL
, &rc
);
1867 if (!RESUMABLE_ERROR (rc
))
1869 strv_free (attrlist
);
1872 else if (!rc
&& r
!= n
)
1882 line
= strv_join ("\n", attrlist
);
1885 log_write ("%s(%i): %s", __FILE__
, __LINE__
,
1886 pwmd_strerror (GPG_ERR_ENOMEM
));
1887 strv_free (attrlist
);
1888 return GPG_ERR_ENOMEM
;
1891 pthread_cleanup_push ((void *)xfree
, line
);
1892 pthread_cleanup_push ((void *)req_free
, attrlist
);
1893 rc
= xfer_data (ctx
, line
, strlen (line
));
1894 pthread_cleanup_pop (1);
1895 pthread_cleanup_pop (1);
1900 * args[0] - attribute
1901 * args[1] - element path
1904 attribute_delete (struct client_s
*client
, char **args
)
1909 if (!args
|| !args
[0] || !*args
[0] || !args
[1] || !*args
[1])
1910 return GPG_ERR_SYNTAX
;
1912 if (!strcmp (args
[0], "_name") || !strcmp (args
[0], "target"))
1913 return GPG_ERR_INV_ATTR
;
1915 if (!xml_reserved_attribute (args
[0]))
1916 n
= xml_resolve_path (client
, client
->doc
, (xmlChar
*)args
[1], NULL
, &rc
);
1919 struct xml_request_s
*req
;
1921 rc
= xml_new_request (client
, args
[1], XML_CMD_ATTR
, &req
);
1925 n
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
1926 xml_free_request (req
);
1930 rc
= xml_is_element_owner (client
, n
);
1933 rc
= xml_delete_attribute (client
, n
, (xmlChar
*) args
[0]);
1939 * Creates the "target" attribute. When other commands encounter an element
1940 * with this attribute they follow the "target" after appending remaining
1941 * elements from the original element path to the target. The exception is the
1942 * ATTR command that operates on the element itself (for reserved attribute
1943 * names) and not the target.
1945 * If the source element path doesn't exist when using 'ATTR SET target', it is
1946 * created, but the destination element path must exist. This is simliar to the
1947 * ls(1) command: ln -s src dst.
1949 * args[0] - source element path
1950 * args[1] - destination element path
1953 set_target_attribute (struct client_s
*client
, char **args
)
1955 struct xml_request_s
*req
= NULL
;
1960 if (!args
|| !args
[0] || !args
[1])
1961 return GPG_ERR_SYNTAX
;
1963 src
= str_split (args
[0], "\t", 0);
1965 return GPG_ERR_SYNTAX
;
1967 if (!xml_valid_element_path (src
, 0))
1970 return GPG_ERR_INV_VALUE
;
1973 dst
= str_split (args
[1], "\t", 0);
1977 return GPG_ERR_SYNTAX
;
1980 // Be sure the destination element path exists. */
1981 rc
= xml_new_request (client
, args
[1], XML_CMD_NONE
, &req
);
1985 n
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
1986 if (rc
&& rc
!= GPG_ERR_EACCES
)
1989 xml_free_request (req
);
1992 if (!strcmp (args
[0], args
[1]))
1994 rc
= GPG_ERR_EEXIST
;
1998 rc
= xml_new_request (client
, args
[0], XML_CMD_ATTR_TARGET
, &req
);
2002 n
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
2003 if (rc
&& rc
!= GPG_ERR_EACCES
)
2008 rc
= xml_add_attribute (client
, n
, "target", args
[1]);
2010 rc
= xml_unlink_node (client
, n
->children
);
2016 xml_free_request (req
);
2021 * args[0] - attribute
2022 * args[1] - element path
2025 attribute_get (assuan_context_t ctx
, char **args
)
2027 struct client_s
*client
= assuan_get_pointer (ctx
);
2031 struct xml_request_s
*req
;
2033 if (!args
|| !args
[0] || !*args
[0] || !args
[1] || !*args
[1])
2034 return GPG_ERR_SYNTAX
;
2036 if (!xml_reserved_attribute (args
[0]))
2037 n
= xml_resolve_path (client
, client
->doc
, (xmlChar
*)args
[1], NULL
, &rc
);
2040 rc
= xml_new_request (client
, args
[1], XML_CMD_ATTR
, &req
);
2044 n
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
2045 xml_free_request (req
);
2051 a
= xmlGetProp (n
, (xmlChar
*) args
[0]);
2053 return GPG_ERR_NOT_FOUND
;
2055 pthread_cleanup_push ((void *)xmlFree
, a
);
2058 rc
= xfer_data (ctx
, (char *) a
, xmlStrlen (a
));
2060 rc
= GPG_ERR_NO_DATA
;
2062 pthread_cleanup_pop (1);
2067 * args[0] - attribute
2068 * args[1] - element path
2072 attribute_set (struct client_s
*client
, char **args
)
2074 struct xml_request_s
*req
;
2078 if (!args
|| !args
[0] || !args
[1])
2079 return GPG_ERR_SYNTAX
;
2082 * Reserved attribute names.
2084 if (!strcmp (args
[0], "_name")) // Use the RENAME command instead
2085 return GPG_ERR_INV_ATTR
;
2086 else if (!strcmp (args
[0], "target"))
2087 return set_target_attribute (client
, args
+ 1);
2088 else if (!xml_valid_attribute (args
[0]))
2089 return GPG_ERR_INV_VALUE
;
2091 if (!xml_valid_attribute_value (args
[2]))
2092 return GPG_ERR_INV_VALUE
;
2094 if (!xml_reserved_attribute (args
[0]))
2096 n
= xml_resolve_path (client
, client
->doc
, (xmlChar
*)args
[1], NULL
, &rc
);
2099 rc
= xml_new_request (client
, args
[1], XML_CMD_NONE
, &req
);
2102 rc
= xml_check_recursion (client
, req
);
2103 xml_free_request (req
);
2109 rc
= xml_new_request (client
, args
[1], XML_CMD_ATTR
, &req
);
2113 n
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
2114 xml_free_request (req
);
2118 rc
= xml_is_element_owner (client
, n
);
2121 rc
= xml_add_attribute (client
, n
, args
[0], args
[2]);
2128 * req[1] - attribute name or element path if command is LIST
2129 * req[2] - element path
2130 * req[2] - element path or value
2134 do_attr (assuan_context_t ctx
, char *line
)
2136 struct client_s
*client
= assuan_get_pointer (ctx
);
2140 req
= str_split (line
, " ", 4);
2141 if (!req
|| !req
[0] || !req
[1])
2144 return GPG_ERR_SYNTAX
;
2147 pthread_cleanup_push ((void *)req_free
, req
);
2149 if (strcasecmp (req
[0], "SET") == 0)
2150 rc
= attribute_set (client
, req
+ 1);
2151 else if (strcasecmp (req
[0], "GET") == 0)
2152 rc
= attribute_get (ctx
, req
+ 1);
2153 else if (strcasecmp (req
[0], "DELETE") == 0)
2154 rc
= attribute_delete (client
, req
+ 1);
2155 else if (strcasecmp (req
[0], "LIST") == 0)
2156 rc
= attribute_list (ctx
, req
+ 1);
2158 rc
= GPG_ERR_SYNTAX
;
2160 client
->flags
&= ~(FLAG_ACL_IGNORE
|FLAG_ACL_ERROR
);
2161 pthread_cleanup_pop (1);
2166 attr_command (assuan_context_t ctx
, char *line
)
2168 struct client_s
*client
= assuan_get_pointer (ctx
);
2170 struct argv_s
*args
[] = {
2171 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
2175 rc
= parse_options (&line
, args
, client
, 1);
2176 if (!rc
&& (client
->opts
& OPT_INQUIRE
) && line
&& *line
)
2177 rc
= GPG_ERR_SYNTAX
;
2179 return send_error (ctx
, rc
);
2181 if (client
->opts
& OPT_INQUIRE
)
2183 unsigned char *result
;
2186 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
2188 return send_error (ctx
, rc
);
2190 pthread_cleanup_push ((void *)xfree
, result
);
2191 rc
= do_attr (ctx
, (char *)result
);
2192 pthread_cleanup_pop (1);
2195 rc
= do_attr (ctx
, line
);
2197 return send_error (ctx
, rc
);
2201 parse_iscached_opt_lock (void *data
, void *value
)
2203 struct client_s
*client
= data
;
2206 client
->opts
|= OPT_LOCK
;
2211 parse_iscached_opt_agent (void *data
, void *value
)
2213 struct client_s
*client
= data
;
2216 client
->opts
|= OPT_CACHE_AGENT
;
2221 parse_iscached_opt_sign (void *data
, void *value
)
2223 struct client_s
*client
= data
;
2226 client
->opts
|= OPT_CACHE_SIGN
;
2231 iscached_command (assuan_context_t ctx
, char *line
)
2233 struct client_s
*client
= assuan_get_pointer (ctx
);
2236 struct argv_s
*args
[] = {
2237 &(struct argv_s
) {"lock", OPTION_TYPE_NOARG
, parse_iscached_opt_lock
},
2238 &(struct argv_s
) {"agent", OPTION_TYPE_NOARG
, parse_iscached_opt_agent
},
2239 &(struct argv_s
) {"sign", OPTION_TYPE_NOARG
, parse_iscached_opt_sign
},
2243 if (!line
|| !*line
)
2244 return send_error (ctx
, GPG_ERR_SYNTAX
);
2246 rc
= parse_options (&line
, args
, client
, 1);
2248 return send_error (ctx
, rc
);
2249 else if (!valid_filename (line
))
2250 return send_error (ctx
, GPG_ERR_INV_VALUE
);
2252 if (!(client
->flags
& FLAG_OPEN
)
2253 && ((client
->opts
& OPT_CACHE_AGENT
) || (client
->opts
& OPT_CACHE_SIGN
)))
2254 return send_error (ctx
, GPG_ERR_INV_STATE
);
2256 rc
= cache_iscached (line
, &defer
, (client
->opts
& OPT_CACHE_AGENT
),
2257 (client
->opts
& OPT_CACHE_SIGN
));
2259 rc
= GPG_ERR_NO_DATA
;
2263 struct cache_data_s
*cdata
= cache_get_data (line
);
2267 rc
= validate_checksum (client
, line
, cdata
, NULL
, NULL
);
2268 if (rc
== GPG_ERR_CHECKSUM
)
2269 rc
= GPG_ERR_NO_DATA
;
2273 if (client
->opts
& OPT_LOCK
2274 && (!rc
|| gpg_err_code (rc
) == GPG_ERR_NO_DATA
))
2276 gpg_error_t trc
= rc
;
2278 if (strcmp (line
, client
->filename
))
2279 reset_client (client
);
2281 xfree (client
->filename
);
2282 client
->filename
= str_dup (line
);
2283 rc
= do_lock (client
, 1);
2288 return send_error (ctx
, rc
);
2292 clearcache_command (assuan_context_t ctx
, char *line
)
2294 struct client_s
*client
= assuan_get_pointer (ctx
);
2295 gpg_error_t rc
= 0, all_rc
= 0;
2299 struct client_thread_s
*once
= NULL
;
2303 pthread_cleanup_push (cache_release_mutex
, NULL
);
2304 count
= cache_file_count ();
2305 MUTEX_LOCK (&cn_mutex
);
2306 pthread_cleanup_push ((void *)release_mutex_cb
, &cn_mutex
);
2308 if (!line
|| !*line
)
2311 t
= slist_length (cn_thread_list
);
2313 for (i
= 0; i
< t
; i
++)
2315 struct client_thread_s
*thd
= slist_nth_data (cn_thread_list
, i
);
2316 assuan_peercred_t peer
;
2321 /* Lock each connected clients' file mutex to prevent any other client
2322 * from accessing the cache entry (the file mutex is locked upon
2323 * command startup). The cache for the entry is not cleared if the
2324 * file mutex is locked by another client to prevent this function
2325 * from blocking. Rather, it returns an error.
2329 if (thd
->cl
->filename
)
2331 rc
= do_validate_peer (ctx
, thd
->cl
->filename
, &peer
);
2332 /* The current client doesn't have permission to open the other
2333 * filename do to "access" configuration parameter in a filename
2334 * section. Since we are clearning all cache entries the error
2335 * will be returned later during cache_clear(). */
2342 else // Idle client without opened file?
2345 rc
= cache_lock_mutex (thd
->cl
->ctx
, thd
->cl
->filename
, -1, 0, -1);
2346 if (gpg_err_code (rc
) == GPG_ERR_LOCKED
)
2348 /* The current client owns the lock. */
2349 if (pthread_equal (pthread_self (), thd
->tid
))
2353 if (cache_iscached (thd
->cl
->filename
, NULL
, 0, 0)
2360 /* The cache entry will be cleared when the other client
2361 * disconnects and cache_timer_thread() does its thing. */
2362 cache_defer_clear (thd
->cl
->filename
);
2365 else if (gpg_err_code (rc
) == GPG_ERR_NO_DATA
)
2373 rc
= cache_clear (NULL
, thd
->cl
->filename
, 1);
2374 cache_unlock_mutex (thd
->cl
->filename
, 0);
2384 /* A single data filename was specified. Lock only this data file
2385 * mutex and free the cache entry. */
2386 rc
= do_validate_peer (ctx
, line
, &peer
);
2387 if (rc
== GPG_ERR_FORBIDDEN
)
2388 rc
= peer_is_invoker (client
);
2390 if (rc
== GPG_ERR_EACCES
)
2391 rc
= GPG_ERR_FORBIDDEN
;
2393 if (!rc
&& thd
->cl
->filename
&& !strcmp (thd
->cl
->filename
, line
))
2395 rc
= cache_lock_mutex (thd
->cl
->ctx
, thd
->cl
->filename
, -1, 0, -1);
2396 if (gpg_err_code (rc
) == GPG_ERR_LOCKED
)
2398 /* The current client owns the lock. */
2399 if (pthread_equal (pthread_self (), thd
->tid
))
2406 rc
= cache_clear (NULL
, thd
->cl
->filename
, 1);
2407 cache_unlock_mutex (thd
->cl
->filename
, 0);
2410 cache_defer_clear (thd
->cl
->filename
);
2412 /* Found a client with the opened file. The cache entry has been
2413 * either cleared (self) or defered to be cleared. */
2419 /* Only connected clients' cache entries have been cleared. Now clear any
2420 * remaining cache entries without clients but only if there wasn't an
2421 * error from above since this would defeat the locking check of the
2422 * remaining entries. */
2423 if (all
&& !all_rc
&& cache_file_count ())
2425 rc
= cache_clear (client
, NULL
, 1);
2426 if (rc
== GPG_ERR_EACCES
)
2427 rc
= GPG_ERR_FORBIDDEN
;
2430 /* No clients are using the specified file. */
2431 else if (!all_rc
&& !rc
&& !once
)
2432 rc
= cache_clear (NULL
, line
, 1);
2434 /* Release the connection mutex. */
2435 pthread_cleanup_pop (1);
2437 if (!rc
|| (cache_file_count () && count
!= cache_file_count ()))
2438 send_status_all (STATUS_CACHE
, NULL
);
2440 /* Release the cache mutex. */
2441 pthread_cleanup_pop (1);
2443 /* One or more files were locked while clearing all cache entries. */
2447 return send_error (ctx
, rc
);
2451 cachetimeout_command (assuan_context_t ctx
, char *line
)
2453 struct client_s
*client
= assuan_get_pointer (ctx
);
2455 char **req
= str_split (line
, " ", 0);
2458 assuan_peercred_t peer
;
2460 if (!req
|| !*req
|| !req
[1])
2463 return send_error (ctx
, GPG_ERR_SYNTAX
);
2467 timeout
= (int) strtol (req
[1], &p
, 10);
2468 if (errno
!= 0 || *p
|| timeout
< -1)
2471 return send_error (ctx
, GPG_ERR_SYNTAX
);
2474 rc
= do_validate_peer (ctx
, req
[0], &peer
);
2475 if (rc
== GPG_ERR_FORBIDDEN
)
2477 rc
= peer_is_invoker (client
);
2478 if (rc
== GPG_ERR_EACCES
)
2479 rc
= GPG_ERR_FORBIDDEN
;
2484 rc
= cache_set_timeout (req
[0], timeout
);
2485 if (!rc
|| gpg_err_code (rc
) == GPG_ERR_NOT_FOUND
)
2488 MUTEX_LOCK (&rcfile_mutex
);
2489 config_set_int_param (&global_config
, req
[0], "cache_timeout",
2491 MUTEX_UNLOCK (&rcfile_mutex
);
2496 return send_error (ctx
, rc
);
2500 dump_command (assuan_context_t ctx
, char *line
)
2504 struct client_s
*client
= assuan_get_pointer (ctx
);
2507 if (disable_list_and_dump
== 1)
2508 return send_error (ctx
, GPG_ERR_NOT_IMPLEMENTED
);
2511 return send_error (ctx
, GPG_ERR_SYNTAX
);
2513 rc
= peer_is_invoker(client
);
2515 return send_error (ctx
, rc
);
2517 xmlDocDumpFormatMemory (client
->doc
, &xml
, &len
, 1);
2521 log_write ("%s(%i): %s", __FILE__
, __LINE__
,
2522 pwmd_strerror (GPG_ERR_ENOMEM
));
2523 return send_error (ctx
, GPG_ERR_ENOMEM
);
2526 pthread_cleanup_push ((void *)xmlFree
, xml
);
2527 rc
= xfer_data (ctx
, (char *) xml
, len
);
2528 pthread_cleanup_pop (1);
2529 return send_error (ctx
, rc
);
2533 getconfig_command (assuan_context_t ctx
, char *line
)
2535 struct client_s
*client
= assuan_get_pointer (ctx
);
2537 char filename
[255] = { 0 }, param
[747] = { 0 };
2538 char *p
, *tmp
= NULL
, *fp
= client
->filename
, *paramp
= line
;
2540 if (!line
|| !*line
)
2541 return send_error (ctx
, GPG_ERR_SYNTAX
);
2543 if (strchr (line
, ' '))
2545 sscanf (line
, " %254[^ ] %746c", filename
, param
);
2550 if (fp
&& !valid_filename (fp
))
2551 return send_error (ctx
, GPG_ERR_INV_VALUE
);
2553 paramp
= str_down (paramp
);
2554 if (!strcmp (paramp
, "passphrase"))
2555 return send_error (ctx
, GPG_ERR_UNKNOWN_OPTION
);
2557 p
= config_get_value (fp
? fp
: "global", paramp
);
2559 return send_error (ctx
, GPG_ERR_UNKNOWN_OPTION
);
2561 tmp
= expand_homedir (p
);
2565 log_write ("%s(%i): %s", __FILE__
, __LINE__
,
2566 pwmd_strerror (GPG_ERR_ENOMEM
));
2567 return send_error (ctx
, GPG_ERR_ENOMEM
);
2571 pthread_cleanup_push ((void *)xfree
, p
);
2572 rc
= xfer_data (ctx
, p
, strlen (p
));
2573 pthread_cleanup_pop (1);
2574 return send_error (ctx
, rc
);
2579 xmlXPathContextPtr xp
;
2580 xmlXPathObjectPtr result
;
2586 xpath_command_free (void *arg
)
2588 struct xpath_s
*xpath
= arg
;
2593 req_free (xpath
->req
);
2596 xmlBufferFree (xpath
->buf
);
2599 xmlXPathFreeObject (xpath
->result
);
2602 xmlXPathFreeContext (xpath
->xp
);
2606 do_xpath (assuan_context_t ctx
, char *line
)
2609 struct client_s
*client
= assuan_get_pointer (ctx
);
2610 struct xpath_s _x
= { 0 };
2611 struct xpath_s
*xpath
= &_x
;
2613 if (!line
|| !*line
)
2614 return GPG_ERR_SYNTAX
;
2616 if ((xpath
->req
= str_split (line
, "\t", 2)) == NULL
)
2618 if (strv_printf (&xpath
->req
, "%s", line
) == 0)
2619 return GPG_ERR_ENOMEM
;
2622 xpath
->xp
= xmlXPathNewContext (client
->doc
);
2625 rc
= GPG_ERR_BAD_DATA
;
2630 xmlXPathEvalExpression ((xmlChar
*) xpath
->req
[0], xpath
->xp
);
2633 rc
= GPG_ERR_BAD_DATA
;
2637 if (xmlXPathNodeSetIsEmpty (xpath
->result
->nodesetval
))
2639 rc
= GPG_ERR_ELEMENT_NOT_FOUND
;
2643 rc
= xml_recurse_xpath_nodeset (client
, client
->doc
,
2644 xpath
->result
->nodesetval
,
2645 (xmlChar
*) xpath
->req
[1], &xpath
->buf
, 0,
2649 else if (!xpath
->req
[1] && !xmlBufferLength (xpath
->buf
))
2651 rc
= GPG_ERR_NO_DATA
;
2654 else if (xpath
->req
[1])
2660 pthread_cleanup_push ((void *)xpath_command_free
, &xpath
);
2661 rc
= xfer_data (ctx
, (char *) xmlBufferContent (xpath
->buf
),
2662 xmlBufferLength (xpath
->buf
));
2663 pthread_cleanup_pop (0);
2665 xpath_command_free (xpath
);
2670 xpath_command (assuan_context_t ctx
, char *line
)
2672 struct client_s
*client
= assuan_get_pointer (ctx
);
2674 struct argv_s
*args
[] = {
2675 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
2679 if (disable_list_and_dump
== 1)
2680 return send_error (ctx
, GPG_ERR_NOT_IMPLEMENTED
);
2682 rc
= peer_is_invoker(client
);
2684 return send_error (ctx
, rc
);
2686 rc
= parse_options (&line
, args
, client
, 1);
2687 if (!rc
&& (client
->opts
& OPT_INQUIRE
) && line
&& *line
)
2688 rc
= GPG_ERR_SYNTAX
;
2690 return send_error (ctx
, rc
);
2692 if (client
->opts
& OPT_INQUIRE
)
2694 unsigned char *result
;
2697 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
2699 return send_error (ctx
, rc
);
2701 pthread_cleanup_push ((void *)xfree
, result
);
2702 rc
= do_xpath (ctx
, (char *)result
);
2703 pthread_cleanup_pop (1);
2706 rc
= do_xpath (ctx
, line
);
2708 return send_error (ctx
, rc
);
2712 do_xpathattr (assuan_context_t ctx
, char *line
)
2714 struct client_s
*client
= assuan_get_pointer (ctx
);
2718 struct xpath_s _x
= { 0 };
2719 struct xpath_s
*xpath
= &_x
;
2721 if (!line
|| !*line
)
2722 return GPG_ERR_SYNTAX
;
2724 if ((req
= str_split (line
, " ", 3)) == NULL
)
2725 return GPG_ERR_ENOMEM
;
2729 rc
= GPG_ERR_SYNTAX
;
2733 if (!strcasecmp (req
[0], "SET"))
2735 else if (!strcasecmp (req
[0], "DELETE"))
2739 rc
= GPG_ERR_SYNTAX
;
2743 if (!req
[1] || !req
[2])
2745 rc
= GPG_ERR_SYNTAX
;
2749 if ((xpath
->req
= str_split (req
[2], "\t", 3)) == NULL
)
2751 rc
= GPG_ERR_ENOMEM
;
2755 if (!xpath
->req
[0] || (!xpath
->req
[1] && !cmd
) || (xpath
->req
[1] && cmd
))
2757 rc
= GPG_ERR_SYNTAX
;
2761 xpath
->xp
= xmlXPathNewContext (client
->doc
);
2764 rc
= GPG_ERR_BAD_DATA
;
2768 xpath
->result
= xmlXPathEvalExpression ((xmlChar
*) xpath
->req
[0], xpath
->xp
);
2771 rc
= GPG_ERR_BAD_DATA
;
2775 if (xmlXPathNodeSetIsEmpty (xpath
->result
->nodesetval
))
2777 rc
= GPG_ERR_ELEMENT_NOT_FOUND
;
2781 rc
= xml_recurse_xpath_nodeset (client
, client
->doc
,
2782 xpath
->result
->nodesetval
,
2783 (xmlChar
*) xpath
->req
[1], &xpath
->buf
, cmd
,
2784 (xmlChar
*) req
[1]);
2787 xpath_command_free (xpath
);
2792 /* XPATHATTR SET|DELETE <name> <expression>[<TAB>[value]] */
2794 xpathattr_command (assuan_context_t ctx
, char *line
)
2796 struct client_s
*client
= assuan_get_pointer (ctx
);
2798 struct argv_s
*args
[] = {
2799 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
2803 if (disable_list_and_dump
== 1)
2804 return send_error (ctx
, GPG_ERR_NOT_IMPLEMENTED
);
2806 rc
= peer_is_invoker(client
);
2808 return send_error (ctx
, rc
);
2810 rc
= parse_options (&line
, args
, client
, 1);
2811 if (!rc
&& (client
->opts
& OPT_INQUIRE
) && line
&& *line
)
2812 rc
= GPG_ERR_SYNTAX
;
2814 return send_error (ctx
, rc
);
2816 if (client
->opts
& OPT_INQUIRE
)
2818 unsigned char *result
;
2821 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
2823 return send_error (ctx
, rc
);
2825 pthread_cleanup_push ((void *)xfree
, result
);
2826 rc
= do_xpathattr (ctx
, (char *)result
);
2827 pthread_cleanup_pop (1);
2830 rc
= do_xpathattr (ctx
, line
);
2832 return send_error (ctx
, rc
);
2836 do_import (struct client_s
*client
, const char *root_element
,
2837 unsigned char *content
)
2839 xmlDocPtr doc
= NULL
;
2840 xmlNodePtr n
= NULL
, root
;
2842 struct string_s
*str
= NULL
;
2843 struct xml_request_s
*req
= NULL
;
2845 if (!content
|| !*content
)
2846 return GPG_ERR_SYNTAX
;
2850 rc
= xml_new_request (client
, root_element
, XML_CMD_STORE
, &req
);
2857 if (!xml_valid_element_path (req
->args
, 0))
2859 xml_free_request (req
);
2861 return GPG_ERR_INV_VALUE
;
2865 str
= string_new_content ((char *)content
);
2866 str
= string_prepend (str
, "<pwmd>");
2867 str
= string_append (str
, "</pwmd>");
2868 doc
= xmlReadDoc ((xmlChar
*) str
->str
, NULL
, "UTF-8", XML_PARSE_NOBLANKS
);
2869 string_free (str
, 1);
2872 rc
= GPG_ERR_BAD_DATA
;
2876 root
= xmlDocGetRootElement (doc
);
2877 root
= root
->children
;
2878 if (root
->type
!= XML_ELEMENT_NODE
)
2880 rc
= GPG_ERR_BAD_DATA
;
2884 rc
= xml_validate_import (client
, root
);
2890 /* Create the new specified root element path, if needed. */
2891 n
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
),
2896 /* Overwrite the children of the specified root element path. */
2897 (void)xml_unlink_node (client
, n
->children
);
2901 n
= xmlDocGetRootElement (client
->doc
);
2906 xmlChar
*name
= xml_attribute_value (root
, (xmlChar
*)"_name");
2909 rc
= GPG_ERR_BAD_DATA
;
2912 /* No --root argument passed. Overwrite the current documents' root
2913 * element matching the root element of the imported data. */
2914 xml_free_request (req
);
2916 rc
= xml_new_request (client
, (char *)name
, XML_CMD_DELETE
, &req
);
2922 tmp
= xml_find_elements (client
, req
,
2923 xmlDocGetRootElement (req
->doc
), &rc
);
2924 if (rc
&& rc
!= GPG_ERR_ELEMENT_NOT_FOUND
)
2928 (void)xml_unlink_node (client
, tmp
);
2936 copy
= xmlCopyNodeList (root
);
2938 rc
= GPG_ERR_ENOMEM
;
2941 n
= xmlAddChildList (n
, copy
);
2943 rc
= GPG_ERR_ENOMEM
;
2948 if (!rc
&& n
&& n
->parent
)
2949 rc
= xml_update_element_mtime (client
, n
->parent
);
2952 xml_free_request (req
);
2961 parse_import_opt_root (void *data
, void *value
)
2963 struct client_s
*client
= data
;
2965 client
->import_root
= str_dup (value
);
2966 return client
->import_root
? 0 : GPG_ERR_ENOMEM
;
2970 import_command (assuan_context_t ctx
, char *line
)
2973 struct client_s
*client
= assuan_get_pointer (ctx
);
2974 unsigned char *result
;
2976 struct argv_s
*args
[] = {
2977 &(struct argv_s
) {"root", OPTION_TYPE_ARG
, parse_import_opt_root
},
2981 xfree (client
->import_root
);
2982 client
->import_root
= NULL
;
2983 rc
= parse_options (&line
, args
, client
, 0);
2985 return send_error (ctx
, rc
);
2987 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
2990 xfree (client
->import_root
);
2991 client
->import_root
= NULL
;
2992 return send_error (ctx
, rc
);
2995 rc
= do_import (client
, client
->import_root
, result
);
2996 xfree (client
->import_root
);
2997 client
->import_root
= NULL
;
2998 return send_error (ctx
, rc
);
3002 do_lock (struct client_s
*client
, int add
)
3004 gpg_error_t rc
= lock_file_mutex (client
, add
);
3007 client
->flags
|= FLAG_LOCK_CMD
;
3013 lock_command (assuan_context_t ctx
, char *line
)
3015 struct client_s
*client
= assuan_get_pointer (ctx
);
3019 return send_error (ctx
, GPG_ERR_SYNTAX
);
3021 rc
= do_lock (client
, 0);
3022 return send_error (ctx
, rc
);
3026 unlock_command (assuan_context_t ctx
, char *line
)
3028 struct client_s
*client
= assuan_get_pointer (ctx
);
3032 return send_error (ctx
, GPG_ERR_SYNTAX
);
3034 rc
= unlock_file_mutex (client
, 0);
3035 return send_error (ctx
, rc
);
3039 get_set_env (const char *name
, const char *value
)
3041 if (value
&& *value
)
3042 setenv (name
, value
, 1);
3048 option_command (assuan_context_t ctx
, char *line
)
3050 struct client_s
*client
= assuan_get_pointer (ctx
);
3052 char namebuf
[255] = { 0 };
3053 char *name
= namebuf
;
3054 char *value
= NULL
, *p
, *tmp
= NULL
;
3056 p
= strchr (line
, '=');
3059 strncpy (namebuf
, line
, sizeof(namebuf
));
3060 namebuf
[sizeof(namebuf
)-1] = 0;
3064 strncpy (namebuf
, line
, strlen (line
)-strlen (p
));
3065 namebuf
[sizeof(namebuf
)-1] = 0;
3069 log_write2 ("OPTION name='%s' value='%s'", name
, value
);
3071 if (strcasecmp (name
, (char *) "lock-timeout") == 0)
3077 n
= strtol (value
, &tmp
, 10);
3079 return send_error (ctx
, GPG_ERR_INV_VALUE
);
3082 client
->lock_timeout
= n
;
3084 else if (strcasecmp (name
, (char *) "client-state") == 0)
3090 n
= strtol (value
, &tmp
, 10);
3091 if ((tmp
&& *tmp
) || (n
< 0 || n
> 1))
3092 return send_error (ctx
, GPG_ERR_INV_VALUE
);
3093 client
->client_state
= n
;
3096 client
->client_state
= 0;
3098 else if (strcasecmp (name
, (char *) "NAME") == 0)
3100 if (value
&& strchr (value
, ' '))
3101 rc
= GPG_ERR_INV_VALUE
;
3104 tmp
= pthread_getspecific (thread_name_key
);
3105 pthread_setspecific (thread_name_key
, NULL
);
3107 MUTEX_LOCK (&cn_mutex
);
3109 if (value
&& *value
)
3110 pthread_setspecific (thread_name_key
, str_dup (value
));
3112 MUTEX_UNLOCK (&cn_mutex
);
3115 else if (strcasecmp (name
, "disable-pinentry") == 0)
3119 if (value
&& *value
)
3121 n
= (int) strtol (value
, &tmp
, 10);
3122 if (*tmp
|| n
< 0 || n
> 1)
3123 return send_error (ctx
, GPG_ERR_INV_VALUE
);
3127 client
->flags
|= FLAG_NO_PINENTRY
;
3129 client
->flags
&= ~FLAG_NO_PINENTRY
;
3131 else if (strcasecmp (name
, "ttyname") == 0)
3133 get_set_env ("GPG_TTY", value
);
3135 else if (strcasecmp (name
, "ttytype") == 0)
3137 get_set_env ("TERM", value
);
3139 else if (strcasecmp (name
, "display") == 0)
3141 get_set_env ("DISPLAY", value
);
3143 else if (strcasecmp (name
, "lc_messages") == 0)
3146 else if (strcasecmp (name
, "lc_ctype") == 0)
3149 else if (strcasecmp (name
, "desc") == 0)
3152 else if (strcasecmp (name
, "pinentry-timeout") == 0)
3156 rc
= GPG_ERR_UNKNOWN_OPTION
;
3158 return send_error (ctx
, rc
);
3162 do_rename (assuan_context_t ctx
, char *line
)
3164 struct client_s
*client
= assuan_get_pointer (ctx
);
3166 xmlNodePtr src
, dst
;
3167 struct string_s
*str
= NULL
, *tstr
;
3168 struct xml_request_s
*req
;
3171 args
= str_split (line
, " ", 0);
3172 if (!args
|| strv_length (args
) != 2)
3175 return GPG_ERR_SYNTAX
;
3178 if (!xml_valid_element ((xmlChar
*) args
[1]))
3181 return GPG_ERR_INV_VALUE
;
3184 rc
= xml_new_request (client
, args
[0], XML_CMD_RENAME
, &req
);
3191 src
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
3195 rc
= xml_is_element_owner (client
, src
);
3199 xmlChar
*a
= xmlGetProp (src
, (xmlChar
*) "_name");
3202 rc
= GPG_ERR_ENOMEM
;
3206 /* To prevent unwanted effects:
3208 * <element _name="a"><element _name="b"/></element>
3212 if (xmlStrEqual (a
, (xmlChar
*) args
[1]))
3215 rc
= GPG_ERR_EEXIST
;
3220 str
= string_new (args
[0]);
3223 rc
= GPG_ERR_ENOMEM
;
3227 p
= strrchr (str
->str
, '\t');
3229 tstr
= string_truncate (str
, strlen (str
->str
)-strlen (p
));
3231 tstr
= string_truncate (str
, 0);
3235 string_free (str
, 1);
3236 rc
= GPG_ERR_ENOMEM
;
3241 tstr
= string_append_printf (str
, "%s%s", str
->len
? "\t" : "", args
[1]);
3244 string_free (str
, 1);
3245 rc
= GPG_ERR_ENOMEM
;
3250 xml_free_request (req
);
3251 rc
= xml_new_request (client
, str
->str
, XML_CMD_RENAME
, &req
);
3252 string_free (str
, 1);
3259 dst
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
3260 if (rc
&& rc
!= GPG_ERR_ELEMENT_NOT_FOUND
)
3265 /* Target may exist:
3267 * <element _name="a"/>
3268 * <element _name="b" target="a"/>
3274 rc
= GPG_ERR_EEXIST
;
3280 rc
= xml_is_element_owner (client
, dst
);
3284 rc
= xml_add_attribute (client
, src
, "_name", args
[1]);
3286 xml_unlink_node (client
, dst
);
3289 rc
= xml_add_attribute (client
, src
, "_name", args
[1]);
3292 xml_free_request (req
);
3298 rename_command (assuan_context_t ctx
, char *line
)
3300 struct client_s
*client
= assuan_get_pointer (ctx
);
3302 struct argv_s
*args
[] = {
3303 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
3307 rc
= parse_options (&line
, args
, client
, 1);
3308 if (!rc
&& (client
->opts
& OPT_INQUIRE
) && line
&& *line
)
3309 rc
= GPG_ERR_SYNTAX
;
3311 return send_error (ctx
, rc
);
3313 if (client
->opts
& OPT_INQUIRE
)
3315 unsigned char *result
;
3318 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
3320 return send_error (ctx
, rc
);
3322 pthread_cleanup_push ((void *)xfree
, result
);
3323 rc
= do_rename (ctx
, (char *)result
);
3324 pthread_cleanup_pop (1);
3327 rc
= do_rename (ctx
, line
);
3329 return send_error (ctx
, rc
);
3333 do_copy (assuan_context_t ctx
, char *line
)
3335 struct client_s
*client
= assuan_get_pointer (ctx
);
3336 char **args
, **targs
;
3337 xmlNodePtr src
, dst
, tree
= NULL
;
3338 struct xml_request_s
*req
;
3341 args
= str_split (line
, " ", 0);
3342 if (!args
|| strv_length (args
) != 2)
3345 return GPG_ERR_SYNTAX
;
3348 targs
= str_split (args
[1], "\t", 0);
3352 return GPG_ERR_SYNTAX
;
3355 if (!xml_valid_element_path (targs
, 0))
3359 return GPG_ERR_INV_VALUE
;
3363 rc
= xml_new_request (client
, args
[0], XML_CMD_NONE
, &req
);
3370 src
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
3374 tree
= xmlCopyNodeList (src
);
3377 rc
= GPG_ERR_ENOMEM
;
3381 xml_free_request (req
);
3382 /* Create the destination element path if it does not exist. */
3383 rc
= xml_new_request (client
, args
[1], XML_CMD_STORE
, &req
);
3390 dst
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
3394 rc
= xml_is_element_owner (client
, dst
);
3398 rc
= xml_validate_target (client
, req
->doc
, args
[1], src
);
3399 if (rc
|| src
== dst
)
3401 rc
= rc
? rc
: GPG_ERR_EEXIST
;
3405 /* Merge any attributes from the src node to the initial dst node. */
3406 for (xmlAttrPtr attr
= tree
->properties
; attr
; attr
= attr
->next
)
3408 if (xmlStrEqual (attr
->name
, (xmlChar
*) "_name"))
3411 xmlAttrPtr a
= xmlHasProp (dst
, attr
->name
);
3415 xmlChar
*tmp
= xmlNodeGetContent (attr
->children
);
3416 xmlNewProp (dst
, attr
->name
, tmp
);
3418 /* Create the default attributes. */
3419 rc
= xml_add_attribute (client
, dst
, NULL
, NULL
);
3422 xmlNodePtr n
= dst
->children
;
3423 (void)xml_unlink_node (client
, n
);
3424 dst
->children
= NULL
;
3428 n
= xmlCopyNodeList (tree
->children
);
3431 rc
= GPG_ERR_ENOMEM
;
3435 n
= xmlAddChildList (dst
, n
);
3438 rc
= GPG_ERR_ENOMEM
;
3442 rc
= xml_update_element_mtime (client
, xmlDocGetRootElement (client
->doc
)
3443 == dst
->parent
? dst
: dst
->parent
);
3448 (void)xml_unlink_node (client
, tree
);
3450 xml_free_request (req
);
3456 copy_command (assuan_context_t ctx
, char *line
)
3458 struct client_s
*client
= assuan_get_pointer (ctx
);
3460 struct argv_s
*args
[] = {
3461 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
3465 rc
= parse_options (&line
, args
, client
, 1);
3466 if (!rc
&& (client
->opts
& OPT_INQUIRE
) && line
&& *line
)
3467 rc
= GPG_ERR_SYNTAX
;
3469 return send_error (ctx
, rc
);
3471 if (client
->opts
& OPT_INQUIRE
)
3473 unsigned char *result
;
3476 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
3478 return send_error (ctx
, rc
);
3480 pthread_cleanup_push ((void *)xfree
, result
);
3481 rc
= do_copy (ctx
, (char *)result
);
3482 pthread_cleanup_pop (1);
3485 rc
= do_copy (ctx
, line
);
3487 return send_error (ctx
, rc
);
3491 do_move (assuan_context_t ctx
, char *line
)
3493 struct client_s
*client
= assuan_get_pointer (ctx
);
3495 xmlNodePtr src
, dst
;
3496 struct xml_request_s
*req
;
3499 args
= str_split (line
, " ", 0);
3500 if (!args
|| strv_length (args
) != 2)
3503 return GPG_ERR_SYNTAX
;
3508 char **targs
= str_split (args
[1], "\t", 0);
3512 return GPG_ERR_ENOMEM
;
3515 if (!xml_valid_element_path (targs
, 0))
3519 return GPG_ERR_INV_VALUE
;
3525 rc
= xml_new_request (client
, args
[0], XML_CMD_MOVE
, &req
);
3532 src
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
3536 rc
= xml_is_element_owner (client
, src
);
3540 xml_free_request (req
);
3544 rc
= xml_new_request (client
, args
[1], XML_CMD_NONE
, &req
);
3548 dst
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
),
3552 dst
= xmlDocGetRootElement (client
->doc
);
3554 if (rc
&& rc
!= GPG_ERR_ELEMENT_NOT_FOUND
)
3559 for (xmlNodePtr n
= dst
; n
; n
= n
->parent
)
3563 rc
= GPG_ERR_EEXIST
;
3570 xmlChar
*a
= xml_attribute_value (src
, (xmlChar
*) "_name");
3571 xmlNodePtr dup
= xml_find_element (client
, dst
->children
, (char *) a
, &rc
);
3574 if (rc
&& rc
!= GPG_ERR_ELEMENT_NOT_FOUND
)
3583 rc
= GPG_ERR_EEXIST
;
3587 if (dst
== xmlDocGetRootElement (client
->doc
))
3592 while (n
->parent
&& n
->parent
!= dst
)
3595 xmlChar
*a
= xml_attribute_value (n
, (xmlChar
*) "_name");
3596 xmlChar
*b
= xml_attribute_value (src
, (xmlChar
*) "_name");
3598 if (xmlStrEqual (a
, b
))
3601 xmlUnlinkNode (src
);
3602 (void)xml_unlink_node (client
, n
);
3609 (void)xml_unlink_node (client
, dup
);
3612 xmlUnlinkNode (dup
);
3616 if (!dst
&& *req
->args
)
3618 struct xml_request_s
*nreq
= NULL
;
3619 xmlChar
*name
= xml_attribute_value (src
, (xmlChar
*) "_name");
3621 if (src
->parent
== xmlDocGetRootElement (client
->doc
)
3622 && !strcmp ((char *) name
, *req
->args
))
3625 rc
= GPG_ERR_EEXIST
;
3630 rc
= xml_new_request (client
, args
[1], XML_CMD_STORE
, &nreq
);
3633 dst
= xml_find_elements (client
, nreq
,
3634 xmlDocGetRootElement (nreq
->doc
), &rc
);
3635 xml_free_request (nreq
);
3642 xml_update_element_mtime (client
, src
->parent
);
3643 xmlUnlinkNode (src
);
3645 dst
= xmlAddChildList (dst
, src
);
3647 rc
= GPG_ERR_ENOMEM
;
3649 xml_update_element_mtime (client
, dst
->parent
);
3652 xml_free_request (req
);
3658 move_command (assuan_context_t ctx
, char *line
)
3660 struct client_s
*client
= assuan_get_pointer (ctx
);
3662 struct argv_s
*args
[] = {
3663 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
3667 rc
= parse_options (&line
, args
, client
, 1);
3668 if (!rc
&& (client
->opts
& OPT_INQUIRE
) && line
&& *line
)
3669 rc
= GPG_ERR_SYNTAX
;
3671 return send_error (ctx
, rc
);
3673 if (client
->opts
& OPT_INQUIRE
)
3675 unsigned char *result
;
3678 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
3680 return send_error (ctx
, rc
);
3682 pthread_cleanup_push ((void *)xfree
, result
);
3683 rc
= do_move (ctx
, (char *)result
);
3684 pthread_cleanup_pop (1);
3687 rc
= do_move (ctx
, line
);
3689 return send_error (ctx
, rc
);
3693 ls_command (assuan_context_t ctx
, char *line
)
3701 return send_error (ctx
, GPG_ERR_SYNTAX
);
3703 tmp
= str_asprintf ("%s/data", homedir
);
3704 dir
= expand_homedir (tmp
);
3707 rc
= gpg_error_from_errno (errno
);
3712 return send_error (ctx
, rc
);
3716 offsetof (struct dirent
, d_name
) +pathconf (dir
, _PC_NAME_MAX
) + 1;
3717 struct dirent
*p
= xmalloc (len
), *cur
= NULL
;
3721 pthread_cleanup_push ((void *)xfree
, p
);
3722 pthread_cleanup_push ((void *)(void *)(void *)closedir
, d
);
3725 while (!readdir_r (d
, p
, &cur
) && cur
)
3729 if (stat (cur
->d_name
, &st
) == -1 || !S_ISREG (st
.st_mode
))
3732 tmp
= str_asprintf ("%s%s\n", list
? list
: "", cur
->d_name
);
3739 rc
= GPG_ERR_ENOMEM
;
3747 pthread_cleanup_pop (1); // closedir (d)
3748 pthread_cleanup_pop (1); // xfree (p)
3751 return send_error (ctx
, rc
);
3754 return send_error (ctx
, GPG_ERR_NO_DATA
);
3756 list
[strlen (list
) - 1] = 0;
3757 pthread_cleanup_push ((void *)xfree
, list
);
3758 rc
= xfer_data (ctx
, list
, strlen (list
));
3759 pthread_cleanup_pop (1);
3760 return send_error (ctx
, rc
);
3764 bye_notify (assuan_context_t ctx
, char *line
)
3766 struct client_s
*cl
= assuan_get_pointer (ctx
);
3767 gpg_error_t ret
= 0;
3769 update_client_state (cl
, CLIENT_STATE_DISCON
);
3772 if (cl
->thd
->remote
)
3778 struct timeval tv
= { 0, 50000 };
3780 rc
= gnutls_bye (cl
->thd
->tls
->ses
, GNUTLS_SHUT_RDWR
);
3781 if (rc
== GNUTLS_E_AGAIN
)
3782 select (0, NULL
, NULL
, NULL
, &tv
);
3784 while (rc
== GNUTLS_E_AGAIN
);
3788 /* This will let assuan_process_next() return. */
3789 if (fcntl (cl
->thd
->fd
, F_SETFL
, O_NONBLOCK
) == -1)
3791 cl
->last_rc
= gpg_error_from_errno (errno
);
3795 cl
->last_rc
= 0; // BYE command result
3800 reset_notify (assuan_context_t ctx
, char *line
)
3802 struct client_s
*client
= assuan_get_pointer (ctx
);
3805 reset_client (client
);
3811 * This is called before every Assuan command.
3814 command_startup (assuan_context_t ctx
, const char *name
)
3816 struct client_s
*client
= assuan_get_pointer (ctx
);
3818 struct command_table_s
*cmd
= NULL
;
3820 log_write2 ("command='%s'", name
);
3821 client
->last_rc
= client
->opts
= 0;
3823 for (int i
= 0; command_table
[i
]; i
++)
3825 if (!strcasecmp (name
, command_table
[i
]->name
))
3827 if (command_table
[i
]->ignore_startup
)
3829 cmd
= command_table
[i
];
3835 return GPG_ERR_UNKNOWN_COMMAND
;
3837 client
->last_rc
= rc
= gpg_error (file_modified (client
, cmd
));
3839 update_client_state (client
, CLIENT_STATE_COMMAND
);
3845 * This is called after every Assuan command.
3848 command_finalize (assuan_context_t ctx
, gpg_error_t rc
)
3850 struct client_s
*client
= assuan_get_pointer (ctx
);
3852 if (!(client
->flags
& FLAG_LOCK_CMD
))
3853 unlock_file_mutex (client
, 0);
3855 unlock_flock (&client
->flock_fd
);
3856 log_write2 (_("command completed: rc=%u"), rc
? rc
: client
->last_rc
);
3857 client
->last_rc
= gpg_error (GPG_ERR_UNKNOWN_COMMAND
);
3859 client
->thd
->buffer_timeout
= client
->thd
->last_buffer_size
= 0;
3861 if (client
->thd
->state
!= CLIENT_STATE_DISCON
)
3862 update_client_state (client
, CLIENT_STATE_IDLE
);
3866 parse_help_opt_html (void *data
, void *value
)
3868 struct client_s
*client
= data
;
3871 client
->opts
|= OPT_HTML
;
3876 help_command (assuan_context_t ctx
, char *line
)
3880 struct client_s
*client
= assuan_get_pointer (ctx
);
3881 struct argv_s
*args
[] = {
3882 &(struct argv_s
) {"html", OPTION_TYPE_NOARG
, parse_help_opt_html
},
3886 rc
= parse_options (&line
, args
, client
, 1);
3888 return send_error (ctx
, rc
);
3890 if (!line
|| !*line
)
3893 char *help
= str_dup (_("Usage: HELP [--html] [<COMMAND>]\n"
3894 "For commands that take an element path as an argument, each element is "
3895 "separated with an ASCII @key{TAB} character (ASCII 0x09)."
3898 for (i
= 0; command_table
[i
]; i
++)
3900 if (!command_table
[i
]->help
)
3903 /* @npxref{} won't put a "See " or "see " in front of the command.
3904 * It's not a texinfo command but needed for --html. */
3905 tmp
= str_asprintf ("%s %s%s%s", help
,
3906 client
->opts
& OPT_HTML
? "@npxref{" : "",
3907 command_table
[i
]->name
,
3908 client
->opts
& OPT_HTML
? "}" : "");
3913 tmp
= strip_texi_and_wrap (help
, client
->opts
& OPT_HTML
);
3915 pthread_cleanup_push ((void *)xfree
, tmp
);
3916 rc
= xfer_data (ctx
, tmp
, strlen (tmp
));
3917 pthread_cleanup_pop (1);
3918 return send_error (ctx
, rc
);
3921 for (i
= 0; command_table
[i
]; i
++)
3923 if (!strcasecmp (line
, command_table
[i
]->name
))
3927 if (!command_table
[i
]->help
)
3930 help
= strip_texi_and_wrap (command_table
[i
]->help
,
3931 client
->opts
& OPT_HTML
);
3932 tmp
= str_asprintf ("%s%s",
3933 (client
->opts
& OPT_HTML
) ? "" : _("Usage: "),
3936 pthread_cleanup_push ((void *)xfree
, tmp
);
3937 rc
= xfer_data (ctx
, tmp
, strlen (tmp
));
3938 pthread_cleanup_pop (1);
3939 return send_error (ctx
, rc
);
3943 return send_error (ctx
, GPG_ERR_INV_NAME
);
3947 new_command (const char *name
, int ignore
, int unlock
, int flock_type
,
3948 gpg_error_t (*handler
) (assuan_context_t
, char *),
3952 struct command_table_s
**tmp
;
3955 for (i
= 0; command_table
[i
]; i
++);
3957 tmp
= xrealloc (command_table
, (i
+ 2) * sizeof (struct command_table_s
*));
3959 command_table
= tmp
;
3960 command_table
[i
] = xcalloc (1, sizeof (struct command_table_s
));
3961 command_table
[i
]->name
= name
;
3962 command_table
[i
]->handler
= handler
;
3963 command_table
[i
]->ignore_startup
= ignore
;
3964 command_table
[i
]->unlock
= unlock
;
3965 command_table
[i
]->flock_type
= flock_type
;
3966 command_table
[i
++]->help
= help
;
3967 command_table
[i
] = NULL
;
3975 for (i
= 0; command_table
[i
]; i
++)
3976 xfree (command_table
[i
]);
3978 xfree (command_table
);
3982 sort_commands (const void *arg1
, const void *arg2
)
3984 struct command_table_s
*const *a
= arg1
;
3985 struct command_table_s
*const *b
= arg2
;
3994 return strcmp ((*a
)->name
, (*b
)->name
);
3998 passwd_command (assuan_context_t ctx
, char *line
)
4000 struct client_s
*client
= assuan_get_pointer (ctx
);
4003 rc
= peer_is_invoker (client
);
4004 if (rc
== GPG_ERR_EACCES
)
4005 return send_error (ctx
, GPG_ERR_FORBIDDEN
);
4007 return send_error (ctx
, rc
);
4009 if (client
->flags
& FLAG_NEW
)
4010 return send_error (ctx
, GPG_ERR_INV_STATE
);
4012 client
->crypto
->keyfile
= config_get_string (client
->filename
,
4014 rc
= crypto_init_ctx (client
->crypto
, client
->flags
& FLAG_NO_PINENTRY
,
4015 client
->crypto
->keyfile
);
4017 return send_error (ctx
, rc
);
4020 rc
= crypto_passwd (client
, client
->crypto
);
4022 crypto_free_non_keys (client
->crypto
);
4023 return send_error (ctx
, rc
);
4027 parse_opt_data (void *data
, void *value
)
4029 struct client_s
*client
= data
;
4032 client
->opts
|= OPT_DATA
;
4037 send_client_list (assuan_context_t ctx
)
4039 struct client_s
*client
= assuan_get_pointer (ctx
);
4042 if (client
->opts
& OPT_VERBOSE
)
4048 MUTEX_LOCK (&cn_mutex
);
4049 pthread_cleanup_push ((void *)release_mutex_cb
, &cn_mutex
);
4050 t
= slist_length (cn_thread_list
);
4052 for (i
= 0; i
< t
; i
++)
4054 struct client_thread_s
*thd
= slist_nth_data (cn_thread_list
, i
);
4057 if (thd
->state
== CLIENT_STATE_UNKNOWN
)
4060 tmp
= build_client_info_line (thd
, 0);
4063 char **l
= strv_cat (list
, tmp
);
4065 rc
= GPG_ERR_ENOMEM
;
4070 rc
= GPG_ERR_ENOMEM
;
4079 pthread_cleanup_pop (1);
4083 line
= strv_join ("\n", list
);
4085 pthread_cleanup_push ((void *)xfree
, line
);
4086 rc
= xfer_data (ctx
, line
, strlen (line
));
4087 pthread_cleanup_pop (1);
4091 if (client
->opts
& OPT_DATA
)
4093 char buf
[ASSUAN_LINELENGTH
];
4095 MUTEX_LOCK (&cn_mutex
);
4096 snprintf (buf
, sizeof (buf
), "%u", slist_length (cn_thread_list
));
4097 MUTEX_UNLOCK (&cn_mutex
);
4098 rc
= xfer_data (ctx
, buf
, strlen (buf
));
4101 rc
= send_status (ctx
, STATUS_CLIENTS
, NULL
);
4107 getinfo_command (assuan_context_t ctx
, char *line
)
4109 struct client_s
*client
= assuan_get_pointer (ctx
);
4111 char buf
[ASSUAN_LINELENGTH
];
4112 struct argv_s
*args
[] = {
4113 &(struct argv_s
) {"data", OPTION_TYPE_NOARG
, parse_opt_data
},
4114 &(struct argv_s
) {"verbose", OPTION_TYPE_NOARG
, parse_opt_verbose
},
4118 rc
= parse_options (&line
, args
, client
, 1);
4120 return send_error (ctx
, rc
);
4122 if (!strcasecmp (line
, "clients"))
4124 rc
= send_client_list (ctx
);
4126 else if (!strcasecmp (line
, "cache"))
4128 if (client
->opts
& OPT_DATA
)
4130 snprintf (buf
, sizeof (buf
), "%u", cache_file_count ());
4131 rc
= xfer_data (ctx
, buf
, strlen (buf
));
4134 rc
= send_status (ctx
, STATUS_CACHE
, NULL
);
4136 else if (!strcasecmp (line
, "pid"))
4139 pid_t pid
= getpid ();
4141 snprintf (buf
, sizeof (buf
), "%i", pid
);
4142 rc
= xfer_data (ctx
, buf
, strlen (buf
));
4144 else if (!strcasecmp (line
, "version"))
4146 char *buf
= str_asprintf ("0x%06x %s", VERSION_HEX
,
4154 pthread_cleanup_push (xfree
, buf
);
4155 rc
= xfer_data (ctx
, buf
, strlen (buf
));
4156 pthread_cleanup_pop (1);
4158 else if (!strcasecmp (line
, "last_error"))
4160 if (client
->last_error
)
4161 rc
= xfer_data (ctx
, client
->last_error
, strlen (client
->last_error
));
4163 rc
= GPG_ERR_NO_DATA
;
4165 else if (!strcasecmp (line
, "user"))
4170 if (client
->thd
->remote
)
4171 user
= str_asprintf ("#%s", client
->thd
->tls
->fp
);
4173 user
= get_username (client
->thd
->peer
->uid
);
4175 user
= get_username (client
->thd
->peer
->uid
);
4179 pthread_cleanup_push ((void *)xfree
, user
);
4180 rc
= xfer_data (ctx
, user
, strlen (user
));
4181 pthread_cleanup_pop (1);
4184 rc
= GPG_ERR_NO_DATA
;
4187 rc
= gpg_error (GPG_ERR_SYNTAX
);
4189 return send_error (ctx
, rc
);
4193 parse_listkeys_opt_secret_only (void *data
, void *value
)
4195 struct client_s
*client
= data
;
4198 client
->opts
|= OPT_SECRET_ONLY
;
4203 keyinfo_command (assuan_context_t ctx
, char *line
)
4205 struct client_s
*client
= assuan_get_pointer (ctx
);
4207 char **keys
= NULL
, **p
= NULL
;
4211 return send_error (ctx
, GPG_ERR_SYNTAX
);
4213 if (!(client
->flags
& FLAG_OPEN
))
4214 return send_error (ctx
, GPG_ERR_INV_STATE
);
4216 if (client
->flags
& FLAG_NEW
)
4217 return send_error (ctx
, GPG_ERR_NO_DATA
);
4219 rc
= lock_flock (ctx
, client
->filename
, FLOCK_TYPE_SH
, &client
->flock_fd
);
4221 return send_error (ctx
, rc
);
4223 rc
= crypto_is_symmetric (client
->filename
);
4224 unlock_flock (&client
->flock_fd
);
4227 else if (rc
!= GPG_ERR_BAD_DATA
)
4228 return send_error (ctx
, rc
);
4233 p
= strv_catv(keys
, client
->crypto
->pubkey
);
4235 rc
= GPG_ERR_ENOMEM
;
4241 for (p
= client
->crypto
->sigkey
; p
&& *p
; p
++)
4243 if (!strv_printf(&keys
, "S%s", *p
))
4246 return send_error (ctx
, GPG_ERR_ENOMEM
);
4251 rc
= GPG_ERR_ENOMEM
;
4255 line
= strv_join ("\n", keys
);
4257 pthread_cleanup_push ((void *)xfree
, line
);
4259 rc
= xfer_data (ctx
, line
, strlen (line
));
4261 rc
= GPG_ERR_ENOMEM
;
4263 pthread_cleanup_pop (1);
4266 rc
= GPG_ERR_NO_DATA
;
4270 return send_error (ctx
, rc
);
4274 kill_command (assuan_context_t ctx
, char *line
)
4276 struct client_s
*client
= assuan_get_pointer (ctx
);
4280 if (!line
|| !*line
)
4281 return send_error (ctx
, GPG_ERR_SYNTAX
);
4283 MUTEX_LOCK (&cn_mutex
);
4284 pthread_cleanup_push ((void *)release_mutex_cb
, &cn_mutex
);
4285 t
= slist_length (cn_thread_list
);
4288 for (i
= 0; i
< t
; i
++)
4290 struct client_thread_s
*thd
= slist_nth_data (cn_thread_list
, i
);
4291 char *tmp
= str_asprintf ("%p", thd
->tid
);
4293 if (strcmp (line
, tmp
))
4300 rc
= peer_is_invoker (client
);
4303 #ifdef HAVE_PTHREAD_CANCEL
4304 pthread_cancel (thd
->tid
);
4306 pthread_kill (thd
->tid
, SIGUSR2
);
4310 else if (rc
== GPG_ERR_EACCES
)
4311 rc
= GPG_ERR_FORBIDDEN
;
4315 if (config_get_boolean ("global", "strict_kill"))
4319 if (client
->thd
->remote
&& thd
->remote
)
4321 if (!thd
->tls
|| !thd
->tls
->fp
)
4323 rc
= GPG_ERR_INV_STATE
;
4326 if (!strcmp (client
->thd
->tls
->fp
, thd
->tls
->fp
))
4328 #ifdef HAVE_PTHREAD_CANCEL
4329 pthread_cancel (thd
->tid
);
4331 pthread_kill (thd
->tid
, SIGUSR2
);
4336 else if (!client
->thd
->remote
&& !thd
->remote
)
4339 if (client
->thd
->peer
->uid
== thd
->peer
->uid
)
4341 #ifdef HAVE_PTHREAD_CANCEL
4342 pthread_cancel (thd
->tid
);
4344 pthread_kill (thd
->tid
, SIGUSR2
);
4351 pthread_cleanup_pop (1);
4352 return send_error (ctx
, rc
);
4356 listkeys_command (assuan_context_t ctx
, char *line
)
4358 struct client_s
*client
= assuan_get_pointer (ctx
);
4359 struct crypto_s
*crypto
= NULL
;
4360 char **pattern
= NULL
;
4361 gpgme_key_t
*keys
= NULL
;
4362 char **result
= NULL
;
4364 struct argv_s
*args
[] = {
4365 &(struct argv_s
) {"secret-only", OPTION_TYPE_NOARG
,
4366 parse_listkeys_opt_secret_only
},
4370 rc
= parse_options (&line
, args
, client
, 1);
4372 return send_error (ctx
, rc
);
4374 rc
= crypto_init (&crypto
, client
->ctx
, client
->filename
,
4375 client
->flags
& FLAG_NO_PINENTRY
, NULL
);
4377 return send_error (ctx
, rc
);
4379 pthread_cleanup_push ((void *)crypto_free
, crypto
);
4380 pattern
= str_split (line
, ",", 0);
4381 pthread_cleanup_push ((void *)(void *)strv_free
, pattern
);
4382 rc
= crypto_list_keys (crypto
, pattern
, client
->opts
& OPT_SECRET_ONLY
,
4384 pthread_cleanup_pop (1);
4385 pthread_cleanup_pop (1);
4390 for (i
= 0; keys
[i
]; i
++)
4392 char *p
= crypto_key_info (keys
[i
]);
4397 rc
= GPG_ERR_ENOMEM
;
4401 r
= strv_cat (result
, p
);
4404 rc
= GPG_ERR_ENOMEM
;
4412 rc
= GPG_ERR_NO_DATA
;
4414 crypto_free_key_list (keys
);
4419 line
= strv_join ("\n", result
);
4421 pthread_cleanup_push ((void *)xfree
, line
);
4423 rc
= GPG_ERR_ENOMEM
;
4425 rc
= xfer_data (ctx
, line
, strlen (line
));
4427 pthread_cleanup_pop (1);
4432 return send_error (ctx
, rc
);
4438 /* !BEGIN-HELP-TEXT!
4440 * This comment is used as a marker to generate the offline documentation
4441 * found in doc/pwmd.info. The indentation needs to be kept for the awk
4442 * script to determine where commands begin and end.
4444 new_command("HELP", 1, 1, 0, help_command
, _(
4445 "HELP [--html] [<COMMAND>]\n"
4446 "Show available commands or command specific help text."
4448 "The @option{--html} option will output the help text in HTML format."
4451 new_command("KILL", 1, 0, 0, kill_command
, _(
4452 "KILL <thread_id>\n"
4453 "Terminates the client identified by @var{thread_id} and releases any file "
4454 "lock or other resources it has held. See @code{GETINFO} (@pxref{GETINFO}) "
4455 "for details about listing connected clients. An @code{invoking_user} "
4456 "(@pxref{Configuration}) may kill any client while others may only kill "
4457 "clients of the same @code{UID} or @abbr{TLS} fingerprint."
4460 new_command("LISTKEYS", 0, 0, 0, listkeys_command
, _(
4461 "LISTKEYS [--secret-only] [pattern[,<pattern>]]\n"
4462 "Returns a new line separated list of key information matching a comma "
4463 "separated list of @var{pattern}'s. When option @option{--secret-only} is "
4464 "specified, only keys matching @var{pattern} that also have a secret key "
4465 "available will be returned."
4468 new_command("KEYINFO", 1, 0, 0, keyinfo_command
, _(
4470 "Returns a new line separated list of key ID's that the currently opened "
4471 "data file has recipients and signers for. If the key is a signing key it "
4472 "will be prefixed with an @code{S}. If the file is a new one, or has no "
4473 "signers in the case of being symmetrically encrypted, the error code "
4474 "@code{GPG_ERR_NO_DATA} is returned."
4477 new_command("GETINFO", 1, 1, 0, getinfo_command
, _(
4478 "GETINFO [--data] [--verbose] CACHE | CLIENTS | PID | USER | LAST_ERROR | VERSION\n"
4479 "Get server and other information. The information is returned via a status "
4480 "message (@pxref{Status Messages}) unless otherwise noted or @option{--data} "
4483 "@var{CACHE} returns the number of cached documents."
4485 "@var{CLIENTS} returns the number of "
4486 "connected clients via a status message or a list of connected clients when "
4487 "the @option{--verbose} parameter is used (implies @option{--data}). A "
4488 "verbose line of a client list contains "
4490 "fields: the thread ID, client name, opened file (@code{/} if none opened), "
4491 "IP address if remote, file lock status, whether the current client is self "
4492 "or not, client state (see below), "
4493 "user ID or TLS fingerprint of the connected client, username if the "
4494 "client is a local one else @code{-}, and finally the time stamp of when the "
4497 "Client state @code{0} is an unknown client state, state @code{1} indicates "
4498 "the client has connected but hasn't completed initializing, state @code{2} "
4499 "indicates that the client is idle, state @code{3} means the "
4500 "client is in a command and state @code{4} means the client is disconnecting. "
4502 "@var{PID} returns the process ID number of the server via a data response."
4504 "@var{VERSION} returns the server version number and compile-time features "
4505 "via a data response with each being space delimited."
4507 "@var{LAST_ERROR} returns a detailed description of the last failed command "
4508 "via a data response, when available."
4510 "@var{USER} returns the username or @abbr{TLS} hash of the connected client "
4511 "via a data response."
4514 new_command("PASSWD", 0, 0, FLOCK_TYPE_EX
|FLOCK_TYPE_KEEP
, passwd_command
, _(
4516 "Changes the passphrase of the secret key required to open the current "
4517 "data file. If the data file is symmetrically encrypted, the error "
4518 "@code{GPG_ERR_NOT_SUPPORTED} is returned. When symmetrically encrypted, "
4519 "the @code{SAVE} command (@pxref{SAVE}) should be used instead to prevent "
4520 "this command saving any unwanted changes to the @abbr{XML} document."
4522 "This command is not available to non-invoking clients "
4523 "(@pxref{Access Control})."
4526 new_command("OPEN", 1, 1, FLOCK_TYPE_SH
|FLOCK_TYPE_KEEP
, open_command
, _(
4527 "OPEN [--lock] <filename>\n"
4528 "Opens @var{filename}. When the @var{filename} is not found on the "
4529 "file-system then a new in-memory document will be created. If the file is "
4530 "found, it is looked for in the file cache and when found no passphrase will "
4531 "be required to open it. When not cached, @cite{pinentry(1)} will be used to "
4532 "retrieve the passphrase for decryption unless @option{disable-pinentry} "
4533 "(@pxref{OPTION}) was specified in which case @command{pwmd} will "
4534 "@emph{INQUIRE} the client for the passphrase."
4536 "When the @option{--lock} option is passed then the file mutex will be "
4537 "locked as if the @code{LOCK} command (@pxref{LOCK}) had been sent after the "
4538 "file had been opened."
4541 new_command("SAVE", 0, 0, FLOCK_TYPE_EX
|FLOCK_TYPE_KEEP
, save_command
, _(
4542 "SAVE [--symmetric] [--inquire-keyparam] [--keyid=<fpr>[,..] | [--inquire-keyid]] [--sign-keyid=<fpr>[,..] | [--inquire-sign-keyid]]\n"
4543 "Writes the in-memory @abbr{XML} document to disk. The file written to is the "
4544 "file that was opened using the @code{OPEN} command (@pxref{OPEN}). If the "
4545 "file is a new one or the option @option{--inquire-keyparam} was passed, a "
4546 "new keypair will be generated and @cite{pinentry(1)} will be used to prompt "
4547 "for the passphrase of the secret key used for signing."
4549 "The @option{--inquire-keyparam} option will send an "
4550 "@emph{INQUIRE} to the client to obtain the key parameters to use for "
4551 "generating the new keypair. The inquired data is expected to be in "
4552 "@cite{gnupg} @abbr{XML} format. See the @cite{gnupg} documentation for "
4553 "details. Note that when this option is specified a new keypair will be "
4554 "generated reguardless if the file is a new one and that the passphrase for "
4555 "the current file will be required before generating the new keypair. This "
4556 "option is available to non-invoking clients (@pxref{Access Control}) only "
4557 "when the file is a new one."
4559 "You can encrypt the data file to a recipient other than the one that it "
4560 "was encrypted with by passing the @option{--keyid} or "
4561 "@option{--inquire-keyid} option with "
4562 "the fingerprint of a public encryption key as its argument. Use the "
4563 "@command{LISTKEYS} command (@pxref{LISTKEYS}) to show key information by "
4564 "pattern. The @option{--sign-keyid} or @option{--inquire-sign-keyid} option "
4565 "may also be used to sign the data "
4566 "file with an alternate key by specifying the fingerprint of a secret key. "
4567 "A passphrase to decrypt the data file "
4568 "will be required if one or more of the original encryption or signing keys "
4569 "are not found in either of these two options' arguments. The original "
4570 "encryption or signing keys will be used when either of these options are "
4573 "The @option{--keyid} and @option{--sign-keyid} options are not available "
4574 "for non-invoking clients "
4575 "(@pxref{Access Control}) when the recipients or signers do not match those "
4576 "that were used when the file was @code{OPEN}'ed."
4578 "The @option{--symmetric} option specifies that a new data file be "
4579 "conventionally encrypted. These types of data files do not use a recipient "
4580 "public key but may be signed by using the @option{--sign-keyid} or "
4581 "@option{--inquire-sign-keyid} options. To remove all signers from a "
4582 "symmtrically encrypted data file, leave the option value empty. Note that "
4583 "you cannot change encryption schemes once a data file has been saved."
4586 new_command("ISCACHED", 1, 0, 0, iscached_command
, _(
4587 "ISCACHED [--lock] [--agent [--sign]] <filename>\n"
4588 "Determines the file cache status of the specified @var{filename}. "
4589 "The default is to test whether the filename is cached in memory. Passing "
4590 "option @option{--agent} will test the @command{gpg-agent} cache for at most "
4591 "one cached key used for opening the data file (@pxref{OPEN}). To test if "
4592 "a signing key is cached, pass @option{--sign} along with @option{--agent}. "
4593 "Both the @option{--agent} and @option{--sign} options require an opened data "
4596 "An @emph{OK} response is returned if the specified @var{filename} is found "
4597 "in the cache. If not found in the cache but exists on the filesystem "
4598 "then @code{GPG_ERR_NO_DATA} is returned. Otherwise a filesystem error is "
4601 "The @option{--lock} option will lock the file mutex of @var{filename} when "
4602 "the file exists; it does not need to be opened nor cached. The lock will be "
4603 "released when the client exits or sends the @code{UNLOCK} command "
4604 "(@pxref{UNLOCK}). When this option is passed the current data file is closed."
4607 new_command("CLEARCACHE", 1, 1, 0, clearcache_command
, _(
4608 "CLEARCACHE [<filename>]\n"
4609 "Clears a file cache entry for all or the specified @var{filename}. Note that "
4610 "this will also clear any @command{gpg-agent} cached keys which may cause "
4611 "problems if another data file shares the same keys as @var{filename}."
4613 "When clearing all cache entries a permissions test is done against the "
4614 "current client based on the @var{access} configuration parameter in a "
4615 "@var{filename} section. Both a cache entry may be cleared and an error "
4616 "returned depending on cached data files and client permissions."
4619 new_command("CACHETIMEOUT", 1, 1, 0, cachetimeout_command
, _(
4620 "CACHETIMEOUT <filename> <seconds>\n"
4621 "The time in @var{seconds} until @var{filename} will be removed from the "
4622 "cache. @code{-1} will keep the cache entry forever, @code{0} will require "
4623 "the passphrase for each @code{OPEN} command (@pxref{OPEN}) or @code{SAVE} "
4624 "(@pxref{SAVE}) command. @xref{Configuration}, and the @code{cache_timeout} "
4628 new_command("LIST", 0, 1, 0, list_command
, _(
4629 "LIST [--inquire] [--recurse] [element[<TAB>child[..]]]\n"
4630 "If no element path is given then a newline separated list of root elements "
4631 "is returned with a data response. If given, then children of the specified "
4632 "element path are returned."
4634 "Each element path "
4635 "returned will have zero or more flags appened to it. These flags are "
4636 "delimited from the element path by a single space character. A flag itself "
4637 "is a single character. Flag @code{P} indicates that access to the element "
4638 "is denied. Flag @code{+} indicates that there are child nodes of "
4639 "the current element path. Flag @code{E} indicates that an element of the "
4640 "element path contained in a @var{target} attribute could not be found. Flag "
4641 "@code{O} indicates that a @var{target} attribute recursion limit was reached "
4642 "(@pxref{Configuration}). Flag @code{T}, followed by a single space character, "
4643 "then an element path, is the element path of the @var{target} attribute "
4644 "contained in the current element."
4646 "When a specified element path contains an error, beit from the final "
4647 "element in the path or any previous element, the path is still shown but "
4648 "will contain the error flag for the element with the error. Determining "
4649 "the actual element which contains the error is up to the client. This can be "
4650 "done by traversing the final element up to parent elements that contain the "
4653 "The option @option{--recurse} may be used to list the entire element tree "
4654 "for a specified element path or the entire tree for all root elements."
4656 "When the @option{--inquire} option is passed then all remaining non-option "
4657 "arguments are retrieved via a server @emph{INQUIRE}."
4660 new_command("REALPATH", 0, 1, 0, realpath_command
, _(
4661 "REALPATH [--inquire] element[<TAB>child[..]]\n"
4662 "Resolves all @code{target} attributes of the specified element path and "
4663 "returns the result with a data response. @xref{Target Attribute}, for details."
4665 "When the @option{--inquire} option is passed then all remaining non-option "
4666 "arguments are retrieved via a server @emph{INQUIRE}."
4669 new_command("STORE", 0, 1, 0, store_command
, _(
4670 "STORE element[<TAB>child[..]]<TAB>[content]\n"
4671 "This command uses a server @emph{INQUIRE} to retrieve data from the client."
4673 "Creates a new element path or modifies the @var{content} of an existing "
4674 "element. If only a single element is specified then a new root element is "
4675 "created. Otherwise, elements are @key{TAB} delimited and the content will be "
4676 "set to the final @key{TAB} delimited element. If no @var{content} is "
4677 "specified after the final @key{TAB}, then the content of the existing "
4678 "element will be removed; or will be empty if creating a new element."
4680 "The only restriction of an element name is that it not contain whitespace "
4681 "characters. There is no other whitespace between the @key{TAB} delimited "
4682 "elements. It is recommended that the content of an element be base64 encoded "
4683 "when it contains control or @key{TAB} characters to prevent @abbr{XML} "
4684 "parsing and @command{pwmd} syntax errors."
4687 new_command("RENAME", 0, 1, 0, rename_command
, _(
4688 "RENAME [--inquire] element[<TAB>child[..]] <value>\n"
4689 "Renames the specified @var{element} to the new @var{value}. If an element of "
4690 "the same name as the @var{value} already exists it will be overwritten."
4692 "When the @option{--inquire} option is passed then all remaining non-option "
4693 "arguments are retrieved via a server @emph{INQUIRE}."
4696 new_command("COPY", 0, 1, 0, copy_command
, _(
4697 "COPY [--inquire] source[<TAB>child[..]] dest[<TAB>child[..]]\n"
4698 "Copies the entire element tree starting from the child node of the source "
4699 "element, to the destination element path. If the destination element path "
4700 "does not exist then it will be created; otherwise it is overwritten."
4702 "Note that attributes from the source element are merged into the "
4703 "destination element when the destination element path exists. When an "
4704 "attribute of the same name exists in both the source and destination "
4705 "elements then the destination attribute will be updated to the source "
4708 "When the @option{--inquire} option is passed then all remaining non-option "
4709 "arguments are retrieved via a server @emph{INQUIRE}."
4712 new_command("MOVE", 0, 1, 0, move_command
, _(
4713 "MOVE [--inquire] source[<TAB>child[..]] [dest[<TAB>child[..]]]\n"
4714 "Moves the source element path to the destination element path. If the "
4715 "destination is not specified then it will be moved to the root node of the "
4716 "document. If the destination is specified and exists then it will be "
4717 "overwritten; otherwise non-existing elements of the destination element "
4718 "path will be created."
4720 "When the @option{--inquire} option is passed then all remaining non-option "
4721 "arguments are retrieved via a server @emph{INQUIRE}."
4724 new_command("DELETE", 0, 1, 0, delete_command
, _(
4725 "DELETE [--inquire] element[<TAB>child[..]]\n"
4726 "Removes the specified element path and all of its children. This may break "
4727 "an element with a @code{target} attribute (@pxref{Target Attribute}) that "
4728 "refers to this element or any of its children."
4730 "When the @option{--inquire} option is passed then all remaining non-option "
4731 "arguments are retrieved via a server @emph{INQUIRE}."
4734 new_command("GET", 0, 1, 0, get_command
, _(
4735 "GET [--inquire] element[<TAB>child[..]]\n"
4736 "Retrieves the content of the specified element. The content is returned "
4737 "with a data response."
4739 "When the @option{--inquire} option is passed then all remaining non-option "
4740 "arguments are retrieved via a server @emph{INQUIRE}."
4743 new_command("ATTR", 0, 1, 0, attr_command
, _(
4744 "ATTR [--inquire] SET|GET|DELETE|LIST [<attribute>] element[<TAB>child[..]] ..\n"
4746 "@item ATTR SET attribute element[<TAB>child[..]] [value]\n"
4747 " Stores or updates an @var{attribute} name and optional @var{value} of an "
4748 "element. When no @var{value} is specified any existing value will be removed."
4750 "@item ATTR DELETE attribute element[<TAB>child[..]]\n"
4751 " Removes an attribute from an element. If @var{attribute} is @code{_name} "
4752 "or @code{target} an error is returned. Use the @command{DELETE} command "
4753 "(@pxref{DELETE}) instead."
4755 "@item ATTR LIST element[<TAB>child[..]]\n"
4756 " Retrieves a newline separated list of attributes names and values "
4757 "from the specified element. Each attribute name and value is space delimited."
4759 "@item ATTR GET attribute element[<TAB>child[..]]\n"
4760 " Retrieves the value of an @var{attribute} from an element."
4763 "When the @option{--inquire} option is passed then all remaining non-option "
4764 "arguments are retrieved via a server @emph{INQUIRE}."
4766 "@xref{Target Attribute}, for details about this special attribute and also "
4767 "@pxref{Other Attributes} for other attributes that are handled specially "
4768 "by @command{pwmd}."
4771 new_command("XPATH", 0, 1, 0, xpath_command
, _(
4772 "XPATH [--inquire] <expression>[<TAB>[value]]\n"
4773 "Evaluates an XPath @var{expression}. If no @var{value} argument is "
4774 "specified it is assumed the expression is a request to return a result. "
4775 "Otherwise, the result is set to the @var{value} argument and the document is "
4776 "updated. If there is no @var{value} after the @key{TAB} character, the value "
4777 "is assumed to be empty and the document is updated. For example:"
4780 "XPATH //element[@@_name='password']@key{TAB}\n"
4783 "would clear the content of all @var{password} elements in the data file "
4784 "while leaving off the trailing @key{TAB} would return all @var{password} "
4785 "elements in @abbr{XML} format."
4787 "When the @option{--inquire} option is passed then all remaining non-option "
4788 "arguments are retrieved via a server @emph{INQUIRE}."
4790 "See @url{http://www.w3schools.com/xpath/xpath_syntax.asp} for @abbr{XPATH} "
4791 "expression syntax."
4794 new_command("XPATHATTR", 0, 1, 0, xpathattr_command
, _(
4795 "XPATHATTR [--inquire] SET|DELETE <name> <expression>[<TAB>[<value>]]\n"
4796 "Like the @code{XPATH} command (@pxref{XPATH}) but operates on element "
4797 "attributes and does not return a result. For the @var{SET} operation the "
4798 "@var{value} is optional but the field is required. If not specified then "
4799 "the attribute value will be empty. For example:"
4802 "XPATHATTR SET password //element[@@_name='password']@key{TAB}\n"
4805 "would create a @var{password} attribute for each @var{password} element "
4806 "found in the document. The attribute value will be empty but still exist."
4808 "When the @option{--inquire} option is passed then all remaining non-option "
4809 "arguments are retrieved via a server @emph{INQUIRE}."
4811 "See @url{http://www.w3schools.com/xpath/xpath_syntax.asp} for @abbr{XPATH} "
4812 "expression syntax."
4815 new_command("IMPORT", 0, 1, 0, import_command
, _(
4816 "IMPORT [--root=element[<TAB>child[..]]]\n"
4817 "This command uses a server @emph{INQUIRE} to retrieve data from the client."
4819 "Like the @code{STORE} command (@pxref{STORE}), but the @var{content} "
4820 "argument is raw @abbr{XML} data. The content is created as a child of "
4821 "the element path specified with the @option{--root} option or at the "
4822 "document root when not specified. Existing elements of the same name will "
4825 "The content must begin with an @abbr{XML} element node. @xref{Introduction}, "
4829 new_command("DUMP", 0, 1, 0, dump_command
, _(
4831 "Shows the in memory @abbr{XML} document with indenting. @xref{XPATH}, for "
4832 "dumping a specific node."
4835 new_command("LOCK", 0, 0, 0, lock_command
, _(
4837 "Locks the mutex associated with the opened file. This prevents other clients "
4838 "from sending commands to the same opened file until the client "
4839 "that sent this command either disconnects or sends the @code{UNLOCK} "
4840 "command. @xref{UNLOCK}."
4843 new_command("UNLOCK", 1, 0, 0, unlock_command
, _(
4845 "Unlocks the file mutex which was locked with the @code{LOCK} command or "
4846 "a commands' @option{--lock} option (@pxref{LOCK}, @pxref{OPEN}, "
4847 "@pxref{ISCACHED})."
4850 new_command("GETCONFIG", 1, 1, 0, getconfig_command
, _(
4851 "GETCONFIG [filename] <parameter>\n"
4852 "Returns the value of a @command{pwmd} configuration @var{parameter} with a "
4853 "data response. If no file has been opened then the value for @var{filename} "
4854 "or the default from the @var{global} section will be returned. If a file "
4855 "has been opened and no @var{filename} is specified, the value previously "
4856 "set with the @code{OPTION} command (@pxref{OPTION}) will be returned."
4859 new_command("OPTION", 1, 1, 0, option_command
, _(
4860 "OPTION <NAME>=[<VALUE>]\n"
4861 "Sets a client option @var{name} to @var{value}. The value for an option is "
4862 "kept for the duration of the connection with the exception of the "
4863 "@command{pinentry} options which are defaults for all future connections "
4864 "(@pxref{Pinentry}). When @var{value} is empty the option is unset."
4867 "@item DISABLE-PINENTRY\n"
4868 "Disable use of @command{pinentry} for passphrase retrieval. When @code{1}, a "
4869 "server inquire is sent to the client to obtain the passphrase. This option "
4870 "may be set as needed before the @code{OPEN} (@pxref{OPEN}), @code{PASSWD} "
4871 "(@pxref{PASSWD}) and @code{SAVE} (@pxref{SAVE}) commands. Set to @code{0} "
4872 "to use a @command{pinentry}."
4875 "Set or unset the X11 display to use when prompting for a passphrase."
4878 "Set the terminal device path to use when prompting for a passphrase."
4881 "Set the terminal type for use with @option{TTYNAME}."
4884 "Associates the thread ID of the connection with the specified textual "
4885 "representation. Useful for debugging log messages. May not contain whitespace."
4887 "@item LOCK-TIMEOUT\n"
4888 "When not @code{0}, the duration in tenths of a second to wait for the file "
4889 "mutex which has been locked by another thread to be released before returning "
4890 "an error. When @code{-1} the error will be returned immediately."
4892 "@item CLIENT-STATE\n"
4893 "When set to @code{1} then client state status messages for other clients are "
4894 "sent to the current client. The default is @code{0}."
4898 new_command("LS", 1, 1, 0, ls_command
, _(
4900 "Returns a newline separated list of data files stored in the data directory "
4901 "@file{HOMEDIR/data} (@pxref{Invoking}) with a data response."
4904 new_command("RESET", 1, 1, 0, NULL
, _(
4906 "Closes the currently opened file but keeps any previously set client options "
4910 new_command("NOP", 1, 1, 0, NULL
, _(
4912 "Does nothing. Always returns successfully."
4915 /* !END-HELP-TEXT! */
4916 new_command ("CANCEL", 1, 1, 0, NULL
, NULL
);
4917 new_command ("END", 1, 1, 0, NULL
, NULL
);
4918 new_command ("BYE", 1, 1, 0, NULL
, NULL
);
4921 for (i
= 0; command_table
[i
]; i
++);
4922 qsort (command_table
, i
- 1, sizeof (struct command_table_s
*),
4927 register_commands (assuan_context_t ctx
)
4931 for (; command_table
[i
]; i
++)
4933 if (!command_table
[i
]->handler
)
4936 rc
= assuan_register_command (ctx
, command_table
[i
]->name
,
4937 command_table
[i
]->handler
,
4938 command_table
[i
]->help
);
4943 rc
= assuan_register_bye_notify (ctx
, bye_notify
);
4947 rc
= assuan_register_reset_notify (ctx
, reset_notify
);
4951 rc
= assuan_register_pre_cmd_notify (ctx
, command_startup
);
4955 return assuan_register_post_cmd_notify (ctx
, command_finalize
);