2 Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014
3 Ben Kibbey <bjk@luxsci.net>
5 This file is part of pwmd.
7 Pwmd is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 2 of the License, or
10 (at your option) any later version.
12 Pwmd is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with Pwmd. If not, see <http://www.gnu.org/licenses/>.
29 #include <sys/types.h>
41 #include "pwmd-error.h"
46 #include "util-misc.h"
55 /* Flags needed to be retained for a client across commands. */
56 #define FLAG_NEW 0x0001
57 #define FLAG_HAS_LOCK 0x0002
58 #define FLAG_LOCK_CMD 0x0004
59 #define FLAG_NO_PINENTRY 0x0008
60 #define FLAG_OPEN 0x0010
61 #define FLAG_KEEP_LOCK 0x0020
63 /* These are command option flags. */
64 #define OPT_INQUIRE 0x0001
65 #define OPT_NO_PASSPHRASE 0x0002
66 #define OPT_RESET 0x0004
67 #define OPT_LIST_RECURSE 0x0008
68 #define OPT_LIST_VERBOSE 0x0010
69 #define OPT_LOCK 0x0020
70 #define OPT_LOCK_ON_OPEN 0x0040
71 #define OPT_SIGN 0x0080
72 #define OPT_LIST_ALL 0x0100
73 #define OPT_LIST_WITH_TARGET 0x0200
74 #define OPT_DATA 0x0400
75 #define OPT_NO_AGENT 0x0800
78 /* The GETCONFIG command, for example, may fail because pwmd lost the
79 * gpg-agent connection. Update the recovered agent ctx. */
80 #define UPDATE_AGENT_CTX(client, crypto) do { \
81 if (crypto && crypto->agent && crypto->agent->did_restart \
82 && client->crypto && client->crypto->agent \
83 && client->crypto->agent->ctx && \
84 crypto->agent->ctx != client->crypto->agent->ctx) \
86 client->crypto->agent->ctx = crypto->agent->ctx; \
87 crypto->agent->ctx = NULL; \
91 #define UPDATE_AGENT_CTX(client, crypto)
94 struct command_table_s
97 gpg_error_t (*handler
) (assuan_context_t
, char *line
);
100 int unlock
; // unlock the file mutex after validating the checksum
103 static struct command_table_s
**command_table
;
105 static gpg_error_t
do_lock (struct client_s
*client
, int add
);
106 static gpg_error_t
validate_checksum (struct client_s
*,
107 struct cache_data_s
*);
108 static gpg_error_t
update_checksum (struct client_s
*client
);
111 unlock_file_mutex (struct client_s
*client
, int remove
)
115 // OPEN: keep the lock for the same file being reopened.
116 if (client
->flags
& FLAG_KEEP_LOCK
&& client
->flags
& FLAG_HAS_LOCK
)
119 if (!(client
->flags
& FLAG_HAS_LOCK
))
120 return GPG_ERR_NOT_LOCKED
;
122 rc
= cache_unlock_mutex (client
->md5file
, remove
);
124 rc
= GPG_ERR_INV_STATE
;
126 client
->flags
&= ~(FLAG_HAS_LOCK
| FLAG_LOCK_CMD
);
132 lock_file_mutex (struct client_s
*client
, int add
)
135 int timeout
= config_get_integer (client
->filename
, "cache_timeout");
137 if (client
->flags
& FLAG_HAS_LOCK
)
140 rc
= cache_lock_mutex (client
->ctx
, client
->md5file
,
141 client
->lock_timeout
, add
, timeout
);
143 client
->flags
|= FLAG_HAS_LOCK
;
149 file_modified (struct client_s
*client
, struct command_table_s
*cmd
)
153 if (!(client
->flags
& FLAG_OPEN
))
154 return GPG_ERR_INV_STATE
;
156 rc
= lock_file_mutex (client
, 0);
157 if (!rc
|| rc
== GPG_ERR_NO_DATA
)
159 rc
= validate_checksum (client
, NULL
);
160 if (gpg_err_code (rc
) == GPG_ERR_ENOENT
&& (client
->flags
& FLAG_NEW
))
163 log_write ("%s: %s", client
->filename
, pwmd_strerror (rc
));
166 if ((cmd
->unlock
&& !(client
->flags
& FLAG_HAS_LOCK
)) || rc
)
167 unlock_file_mutex (client
, 0);
173 parse_xml (assuan_context_t ctx
, int new)
175 struct client_s
*client
= assuan_get_pointer (ctx
);
176 int cached
= client
->doc
!= NULL
;
181 client
->doc
= new_document ();
187 xmlDocDumpFormatMemory (client
->doc
, &result
, &len
, 0);
188 client
->crypto
->plaintext
= result
;
189 client
->crypto
->plaintext_len
= len
;
190 if (!client
->crypto
->plaintext
)
192 xmlFreeDoc (client
->doc
);
198 rc
= parse_doc ((char *) client
->crypto
->plaintext
,
199 client
->crypto
->plaintext_len
, (xmlDocPtr
*)&client
->doc
);
205 free_client (struct client_s
*client
)
208 xmlFreeDoc (client
->doc
);
211 xfree (client
->filename
);
212 xfree (client
->last_error
);
216 cleanup_crypto_stage2 (client
->crypto
);
217 if (client
->crypto
->pkey_sexp
)
218 gcry_sexp_release (client
->crypto
->pkey_sexp
);
220 client
->crypto
->pkey_sexp
= NULL
;
221 memset (client
->crypto
->sign_grip
, 0,
222 sizeof (client
->crypto
->sign_grip
));
223 memset (client
->crypto
->grip
, 0, sizeof(client
->crypto
->grip
));
228 cleanup_client (struct client_s
*client
)
230 assuan_context_t ctx
= client
->ctx
;
231 struct client_thread_s
*thd
= client
->thd
;
232 struct crypto_s
*crypto
= client
->crypto
;
233 long lock_timeout
= client
->lock_timeout
;
234 int no_pinentry
= (client
->flags
& FLAG_NO_PINENTRY
);
235 struct pinentry_option_s pin_opts
;
236 xmlErrorPtr xml_error
= client
->xml_error
;
238 struct pinentry_option_s agent_pin_opts
;
240 if (crypto
&& crypto
->agent
)
241 memcpy (&agent_pin_opts
, &crypto
->agent
->pinentry_opts
,
242 sizeof(struct pinentry_option_s
));
245 memcpy (&pin_opts
, &client
->pinentry_opts
, sizeof(struct pinentry_option_s
));
246 unlock_file_mutex (client
, client
->flags
& FLAG_NEW
);
247 free_client (client
);
248 memset (client
, 0, sizeof (struct client_s
));
249 client
->xml_error
= xml_error
;
250 client
->crypto
= crypto
;
253 client
->lock_timeout
= lock_timeout
;
254 memcpy (&client
->pinentry_opts
, &pin_opts
, sizeof(struct pinentry_option_s
));
255 client
->flags
|= no_pinentry
? FLAG_NO_PINENTRY
: 0;
257 if (crypto
&& crypto
->agent
)
258 memcpy (&crypto
->agent
->pinentry_opts
, &agent_pin_opts
,
259 sizeof(struct pinentry_option_s
));
264 open_finalize (assuan_context_t ctx
, char *key
, size_t keylen
)
266 struct client_s
*client
= assuan_get_pointer (ctx
);
268 struct cache_data_s
*cdata
= cache_get_data (client
->md5file
);
269 int cached
= 0, keyarg
= key
? 1 : 0;
271 unsigned char *salted_key
= NULL
;
275 char *pin_title
= client
->pinentry_opts
.title
;
277 client
->crypto
->filename
= str_dup (client
->filename
);
278 if (cdata
|| client
->flags
& FLAG_NEW
)
280 if (cdata
&& !(client
->flags
& FLAG_NEW
))
282 rc
= decrypt_cache (client
->crypto
, cdata
->doc
, cdata
->doclen
);
287 cached
= cdata
!= NULL
;
291 if (!key
&& !IS_PKI (client
->crypto
)
292 && !(client
->crypto
->hdr
.flags
& PWMD_FLAG_NO_PASSPHRASE
))
294 if (client
->flags
& FLAG_NO_PINENTRY
)
296 rc
= inquire_passphrase (ctx
, "PASSPHRASE", (unsigned char **)&key
,
303 client
->pinentry_opts
.timeout
= config_get_integer (client
->filename
,
306 rc
= getpin_common (client
->ctx
, client
->filename
, PINENTRY_OPEN
,
313 if (!IS_PKI (client
->crypto
))
315 if (client
->crypto
->hdr
.flags
& PWMD_FLAG_NO_PASSPHRASE
)
318 key
= gcry_malloc (keylen
);
319 memset (key
, 0, keylen
);
322 algo
= cipher_to_gcrypt (client
->crypto
->hdr
.flags
);
323 rc
= hash_key (algo
, client
->crypto
->hdr
.salt
,
324 sizeof(client
->crypto
->hdr
.salt
), key
, keylen
,
325 (void **)&salted_key
, &keysize
);
331 rc
= decrypt_data (client
->ctx
, client
->crypto
, salted_key
, keysize
);
332 if (gpg_err_code (rc
) == GPG_ERR_BAD_PASSPHRASE
333 && ++pin_try
<= pin_tries
&& !(client
->flags
& FLAG_NO_PINENTRY
))
335 gcry_free (salted_key
);
339 client
->pinentry_opts
.title
= str_asprintf (_ ("Bad passphrase (try %i of %i)"), pin_try
, pin_tries
);
344 if (client
->pinentry_opts
.title
!= pin_title
)
345 xfree (client
->pinentry_opts
.title
);
347 client
->pinentry_opts
.title
= pin_title
;
350 gcry_free (salted_key
);
354 cdata
= xcalloc (1, sizeof (struct cache_data_s
));
357 gcry_free (salted_key
);
358 return GPG_ERR_ENOMEM
;
361 cdata
->key
= salted_key
;
362 cdata
->keylen
= keysize
;
365 rc
= decrypt_data (client
->ctx
, client
->crypto
, NULL
, 0);
370 rc
= parse_xml (ctx
, client
->flags
& FLAG_NEW
);
372 free_cache_data_once (cdata
);
376 int timeout
= config_get_integer (client
->filename
,
382 cdata
= xcalloc (1, sizeof (struct cache_data_s
));
384 rc
= encrypt_xml (NULL
, cache_key
, cache_keysize
,
385 GCRY_CIPHER_AES
, client
->crypto
->plaintext
,
386 client
->crypto
->plaintext_len
, &cdata
->doc
,
387 &cdata
->doclen
, &cache_iv
, &cache_blocksize
,
389 if (!rc
&& !(client
->flags
& FLAG_NEW
) && IS_PKI (client
->crypto
))
391 rc
= gcry_sexp_build ((gcry_sexp_t
*) & cdata
->pubkey
, NULL
,
392 "%S", client
->crypto
->pkey_sexp
);
397 gcry_sexp_release (cdata
->sigkey
);
399 cdata
->sigkey
= NULL
;
400 if (!rc
&& IS_PKI (client
->crypto
))
401 rc
= gcry_sexp_build ((gcry_sexp_t
*) &cdata
->sigkey
, NULL
,
402 "%S", client
->crypto
->sigpkey_sexp
);
404 if (!rc
&& !cache_add_file (client
->md5file
,
405 (client
->flags
& FLAG_NEW
)
407 : client
->crypto
->grip
, cdata
, timeout
))
411 free_cache_data_once (cdata
);
412 xmlFreeDoc (client
->doc
);
419 client
->flags
|= FLAG_OPEN
;
424 update_checksum (client
);
426 if (!rc
&& (client
->opts
& OPT_LOCK_ON_OPEN
))
427 rc
= do_lock (client
, 0);
433 req_cleanup (void *arg
)
438 strv_free ((char **) arg
);
442 parse_open_opt_lock (void *data
, void *value
)
444 struct client_s
*client
= data
;
446 client
->opts
|= OPT_LOCK_ON_OPEN
;
451 parse_opt_inquire (void *data
, void *value
)
453 struct client_s
*client
= data
;
456 client
->opts
|= OPT_INQUIRE
;
461 update_checksum (struct client_s
*client
)
465 struct cache_data_s
*cdata
;
466 gpg_error_t rc
= get_checksum (client
->filename
, &crc
, &len
);
473 cdata
= cache_get_data (client
->md5file
);
477 cdata
->crc
= xmalloc (len
);
478 memcpy (cdata
->crc
, crc
, len
);
485 validate_checksum (struct client_s
*client
, struct cache_data_s
*cdata
)
492 if (cdata
&& !cdata
->crc
)
493 return GPG_ERR_CHECKSUM
;
495 rc
= get_checksum (client
->filename
, &crc
, &len
);
500 n
= memcmp (cdata
->crc
, crc
, len
);
501 else if (client
->crc
)
502 n
= memcmp (client
->crc
, crc
, len
);
505 return n
? GPG_ERR_CHECKSUM
: 0;
509 do_open (assuan_context_t ctx
, const char *filename
, const char *password
)
511 struct client_s
*client
= assuan_get_pointer (ctx
);
512 struct cache_data_s
*cdata
;
516 if (!valid_filename (filename
))
517 return GPG_ERR_INV_VALUE
;
519 gcry_md_hash_buffer (GCRY_MD_MD5
, client
->md5file
, filename
,
521 client
->filename
= str_dup (filename
);
522 if (!client
->filename
)
523 return GPG_ERR_ENOMEM
;
526 cdata
= cache_get_data (client
->md5file
);
527 if (cdata
&& cdata
->doc
)
531 /* This will check that the key is cached in the agent which needs to
532 * be determined for files that share a keygrip. */
535 rc
= cache_iscached (client
->filename
, &defer
);
536 if ((!rc
|| rc
== GPG_ERR_ENOENT
) && defer
)
537 rc
= GPG_ERR_KEY_EXPIRED
;
540 if (!rc
&& !(client
->flags
& FLAG_NEW
))
541 rc
= validate_checksum (client
, cdata
);
544 if (!rc
&& client
->thd
->remote
545 && config_get_boolean (client
->filename
, "tcp_require_key"))
546 rc
= GPG_ERR_KEY_EXPIRED
;
549 if (!rc
&& !password
)
551 rc
= read_data_header (client
->filename
, &client
->crypto
->hdr
,
555 if (IS_PKI (client
->crypto
))
557 gcry_sexp_build (&client
->crypto
->pkey_sexp
, NULL
, "%S",
559 gcry_pk_get_keygrip (client
->crypto
->pkey_sexp
,
560 client
->crypto
->grip
);
561 gcry_sexp_build (&client
->crypto
->sigpkey_sexp
, NULL
, "%S",
563 gcry_pk_get_keygrip (client
->crypto
->sigpkey_sexp
,
564 client
->crypto
->sign_grip
);
569 rc
= open_finalize (ctx
, NULL
, 0);
575 /* There was an error accessing the file so clear the cache entry. The
576 * real error will be returned from read_data_file() since the file
577 * may have only disappeared. */
580 log_write ("%s: %s", filename
, pwmd_strerror (rc
));
581 rc
= cache_clear (client
->md5file
);
582 send_status_all (STATUS_CACHE
, NULL
);
589 rc
= read_data_file (client
->filename
, client
->crypto
);
592 if (gpg_err_source (rc
) != GPG_ERR_SOURCE_DEFAULT
||
593 gpg_err_code (rc
) != GPG_ERR_ENOENT
)
595 log_write ("%s: %s", client
->filename
, pwmd_strerror (rc
));
599 client
->flags
|= FLAG_NEW
;
600 memset (client
->crypto
->grip
, 0, sizeof (client
->crypto
->grip
));
601 memset (client
->crypto
->sign_grip
, 0,
602 sizeof (client
->crypto
->sign_grip
));
603 rc
= open_finalize (ctx
, NULL
, 0);
607 if (password
&& IS_PKI (client
->crypto
))
610 rc
= set_agent_passphrase (client
->crypto
, password
, strlen (password
));
616 rc
= open_finalize (ctx
, (char *)password
, password
? strlen (password
) : 0);
621 open_command (assuan_context_t ctx
, char *line
)
624 struct client_s
*client
= assuan_get_pointer (ctx
);
625 char **req
, *filename
;
626 unsigned char md5file
[16];
628 assuan_peercred_t peer
;
629 struct argv_s
*args
[] = {
630 &(struct argv_s
) {"lock", OPTION_TYPE_NOARG
, parse_open_opt_lock
},
634 rc
= parse_options (&line
, args
, client
);
636 return send_error (ctx
, rc
);
638 req
= str_split (line
, " ", 2);
640 return send_error (ctx
, GPG_ERR_SYNTAX
);
642 rc
= do_validate_peer (ctx
, req
[0], &peer
);
646 return send_error (ctx
, rc
);
649 pthread_cleanup_push (req_cleanup
, req
);
651 gcry_md_hash_buffer (GCRY_MD_MD5
, md5file
, filename
, strlen (filename
));
652 /* This client may have locked a different file with ISCACHED --lock than
653 * the current filename. This will remove that lock. */
654 same_file
= !memcmp (md5file
, client
->md5file
, 16) ? 1 : 0;
655 if (client
->flags
& FLAG_OPEN
||
656 (client
->flags
& FLAG_HAS_LOCK
&& !same_file
))
658 typeof (client
->opts
) opts
= client
->opts
;
659 typeof (client
->flags
) flags
= client
->flags
;
662 client
->flags
|= FLAG_KEEP_LOCK
;
664 cleanup_client (client
);
666 client
->flags
|= flags
;
667 client
->flags
&= ~(FLAG_LOCK_CMD
);
669 client
->flags
&= ~(FLAG_HAS_LOCK
| FLAG_NEW
);
672 /* Need to lock the mutex here because file_modified() cannot without
673 * knowing the filename. */
674 memcpy (client
->md5file
, md5file
, 16);
675 rc
= lock_file_mutex (client
, 1);
678 char *password
= req
[1] && *req
[1] ? req
[1] : NULL
;
681 if (IS_PKI (client
->crypto
))
682 rc
= set_pinentry_mode (client
->crypto
->agent
,
683 (client
->flags
& FLAG_NO_PINENTRY
) ? "loopback"
688 rc
= do_open (ctx
, filename
, password
);
690 cleanup_client (client
);
692 cleanup_crypto_stage1 (client
->crypto
);
696 pthread_cleanup_pop (1);
698 if (!rc
&& client
->flags
& FLAG_NEW
)
699 rc
= send_status (ctx
, STATUS_NEWFILE
, NULL
);
702 (void) kill_scd (client
->crypto
->agent
);
704 return send_error (ctx
, rc
);
708 parse_opt_no_passphrase (void *data
, void *value
)
710 struct client_s
*client
= data
;
713 client
->opts
|= OPT_NO_PASSPHRASE
;
718 parse_save_opt_no_agent (void *data
, void *value
)
720 struct client_s
*client
= data
;
722 client
->opts
|= OPT_NO_AGENT
;
727 parse_save_opt_cipher (void *data
, void *value
)
729 struct client_s
*client
= data
;
730 int algo
= cipher_string_to_gcrypt ((char *) value
);
731 file_header_t
*hdr
= &client
->crypto
->save
.hdr
;
734 return GPG_ERR_INV_VALUE
;
736 hdr
->flags
= set_cipher_flag (hdr
->flags
, algo
);
741 parse_save_opt_keygrip (void *data
, void *value
)
743 struct client_s
*client
= data
;
745 if (!IS_PKI (client
->crypto
))
746 return GPG_ERR_INV_ARG
;
749 if (client
->crypto
->save
.pkey
)
750 gcry_sexp_release (client
->crypto
->save
.pkey
);
752 client
->crypto
->save
.pkey
= NULL
;
753 return get_pubkey (client
->crypto
, value
, &client
->crypto
->save
.pkey
);
755 return GPG_ERR_INV_ARG
;
760 parse_save_opt_sign_keygrip (void *data
, void *value
)
762 struct client_s
*client
= data
;
764 if (!IS_PKI (client
->crypto
))
765 return GPG_ERR_INV_ARG
;
768 if (client
->crypto
->save
.sigpkey
)
769 gcry_sexp_release (client
->crypto
->save
.sigpkey
);
771 client
->crypto
->save
.sigpkey
= NULL
;
772 return get_pubkey (client
->crypto
, value
, &client
->crypto
->save
.sigpkey
);
774 return GPG_ERR_INV_ARG
;
779 parse_opt_s2k_count (void *data
, void *value
)
781 struct client_s
*client
= data
;
785 return GPG_ERR_INV_VALUE
;
787 client
->crypto
->save
.s2k_count
= strtoul (v
, NULL
, 10);
792 parse_save_opt_iterations (void *data
, void *value
)
794 struct client_s
*client
= data
;
799 return GPG_ERR_INV_VALUE
;
802 n
= strtoull (v
, &p
, 10);
803 if (n
== UINT64_MAX
&& errno
)
804 return gpg_error_from_errno (errno
);
806 return GPG_ERR_INV_VALUE
;
808 client
->crypto
->save
.hdr
.iterations
= n
;
813 save_finalize (assuan_context_t ctx
)
815 struct client_s
*client
= assuan_get_pointer (ctx
);
817 xmlChar
*xmlbuf
= NULL
;
822 xmlDocDumpFormatMemory (client
->doc
, &xmlbuf
, &xmlbuflen
, 0);
824 return GPG_ERR_ENOMEM
;
826 pthread_cleanup_push (xmlFree
, xmlbuf
);
828 if (!use_agent
|| ((client
->flags
& FLAG_NEW
)
829 && (client
->opts
& OPT_NO_AGENT
))
830 || !(client
->crypto
->hdr
.flags
& PWMD_FLAG_PKI
))
832 rc
= export_common (ctx
, client
->flags
& FLAG_NO_PINENTRY
,
833 client
->crypto
, xmlbuf
, xmlbuflen
, client
->filename
,
834 NULL
, &key
, &keylen
, 1, 1,
835 (client
->opts
& OPT_NO_PASSPHRASE
));
840 gcry_sexp_t pubkey
= client
->crypto
->save
.pkey
;
841 gcry_sexp_t sigkey
= client
->crypto
->save
.sigpkey
;
844 pubkey
= client
->crypto
->pkey_sexp
;
848 sigkey
= client
->crypto
->sigpkey_sexp
;
851 gcry_sexp_build (&client
->crypto
->save
.sigpkey
, 0, "%S", pubkey
);
852 sigkey
= client
->crypto
->save
.sigpkey
;
856 rc
= encrypt_data_file (client
->ctx
, client
->crypto
, pubkey
, sigkey
,
857 client
->filename
, xmlbuf
, xmlbuflen
);
858 if (pubkey
== client
->crypto
->save
.pkey
)
862 gcry_sexp_release (client
->crypto
->pkey_sexp
);
863 client
->crypto
->pkey_sexp
= client
->crypto
->save
.pkey
;
864 gcry_pk_get_keygrip (client
->crypto
->pkey_sexp
,
865 client
->crypto
->grip
);
868 gcry_sexp_release (pubkey
);
870 client
->crypto
->save
.pkey
= NULL
;
874 gcry_pk_get_keygrip (sigkey
, client
->crypto
->sign_grip
);
876 if (sigkey
== client
->crypto
->save
.sigpkey
)
880 if (client
->crypto
->sigpkey_sexp
)
881 gcry_sexp_release (client
->crypto
->sigpkey_sexp
);
883 client
->crypto
->sigpkey_sexp
= client
->crypto
->save
.sigpkey
;
884 gcry_pk_get_keygrip (client
->crypto
->sigpkey_sexp
,
885 client
->crypto
->sign_grip
);
888 gcry_sexp_release (sigkey
);
890 client
->crypto
->save
.sigpkey
= NULL
;
899 rc
= save_common (client
->filename
, client
->crypto
, xmlbuf
, xmlbuflen
,
900 key
, keylen
, &cached
, client
->opts
& OPT_NO_AGENT
);
904 if (!rc
&& (!cached
|| (client
->flags
& FLAG_NEW
)))
905 send_status_all (STATUS_CACHE
, NULL
);
909 rc
= update_checksum (client
);
910 client
->flags
&= ~(FLAG_NEW
);
914 pthread_cleanup_pop (1); // xmlFree
919 parse_opt_reset (void *data
, void *value
)
921 struct client_s
*client
= data
;
924 client
->opts
|= OPT_RESET
;
929 save_command (assuan_context_t ctx
, char *line
)
931 struct client_s
*client
= assuan_get_pointer (ctx
);
934 struct argv_s
*args
[] = {
935 &(struct argv_s
) {"no-passphrase", OPTION_TYPE_NOARG
,
936 parse_opt_no_passphrase
},
937 &(struct argv_s
) {"cipher", OPTION_TYPE_ARG
, parse_save_opt_cipher
},
938 &(struct argv_s
) {"inquire-keyparam", OPTION_TYPE_NOARG
,
940 &(struct argv_s
) {"keygrip", OPTION_TYPE_ARG
, parse_save_opt_keygrip
},
941 &(struct argv_s
) {"sign-keygrip", OPTION_TYPE_ARG
,
942 parse_save_opt_sign_keygrip
},
943 &(struct argv_s
) {"s2k-count", OPTION_TYPE_ARG
, parse_opt_s2k_count
},
944 &(struct argv_s
) {"reset", OPTION_TYPE_NOARG
, parse_opt_reset
},
945 &(struct argv_s
) {"cipher-iterations", OPTION_TYPE_ARG
,
946 parse_save_opt_iterations
},
947 &(struct argv_s
) {"no-agent", OPTION_TYPE_NOARG
,
948 parse_save_opt_no_agent
},
952 cleanup_save (&client
->crypto
->save
);
953 memcpy (&client
->crypto
->save
.hdr
, &client
->crypto
->hdr
,
954 sizeof (file_header_t
));
955 client
->crypto
->save
.s2k_count
=
956 config_get_ulong (client
->filename
, "s2k_count");
958 if (client
->flags
& FLAG_NEW
)
959 client
->crypto
->save
.hdr
.iterations
=
960 config_get_ulonglong (client
->filename
, "cipher_iterations");
962 rc
= parse_options (&line
, args
, client
);
964 return send_error (ctx
, rc
);
966 if (!(client
->flags
& FLAG_NEW
))
967 client
->opts
&= ~OPT_NO_AGENT
;
968 else if (client
->opts
& OPT_NO_AGENT
)
970 client
->crypto
->save
.hdr
.flags
&= ~PWMD_FLAG_PKI
;
971 client
->crypto
->hdr
.flags
&= ~PWMD_FLAG_PKI
;
974 if ((client
->opts
& OPT_NO_PASSPHRASE
) && !(client
->flags
& FLAG_NEW
)
975 && !(client
->opts
& OPT_INQUIRE
))
976 return send_error (ctx
, GPG_ERR_WRONG_KEY_USAGE
);
978 if (lstat (client
->filename
, &st
) == -1 && errno
!= ENOENT
)
979 return send_error (ctx
, gpg_error_from_errno (errno
));
981 if (errno
!= ENOENT
&& !S_ISREG (st
.st_mode
))
983 log_write ("%s: %s", client
->filename
, pwmd_strerror (GPG_ERR_ENOANO
));
984 return send_error (ctx
, GPG_ERR_ENOANO
);
988 rc
= cache_iscached (client
->filename
, &defer
);
989 if (gpg_err_code (rc
) == GPG_ERR_ENOENT
&& client
->flags
& FLAG_NEW
)
991 else if (gpg_err_code (rc
) == GPG_ERR_NO_DATA
)
994 if ((!rc
&& defer
) || config_get_boolean ("global", "require_save_key"))
995 client
->opts
|= OPT_RESET
;
997 if (!rc
&& (client
->opts
& OPT_RESET
))
999 rc
= cache_clear (client
->md5file
);
1001 return send_error (ctx
, rc
);
1003 log_write ("%s: %s", client
->filename
,
1004 pwmd_strerror (GPG_ERR_KEY_EXPIRED
));
1005 send_status_all (STATUS_CACHE
, NULL
);
1009 rc
= update_element_mtime (xmlDocGetRootElement (client
->doc
));
1012 return send_error (ctx
, rc
);
1015 if (!rc
&& use_agent
&& !client
->crypto
->save
.pkey
&&
1016 (client
->flags
& FLAG_NEW
|| client
->opts
& OPT_INQUIRE
)
1017 && !(client
->opts
& OPT_NO_AGENT
))
1019 rc
= set_pinentry_mode (client
->crypto
->agent
,
1020 (client
->flags
& FLAG_NO_PINENTRY
) ? "loopback"
1023 if (!(client
->flags
& FLAG_NEW
))
1025 struct crypto_s
*crypto
;
1029 /* Wanting to generate a new key. Require the key to open the
1030 current file before proceeding reguardless of the
1031 require_save_key configuration parameter. */
1032 rc
= cache_clear (client
->md5file
);
1035 rc
= init_client_crypto (&crypto
);
1037 crypto
->client_ctx
= client
->ctx
;
1041 rc
= decrypt_common (client
->ctx
, client
->opts
&OPT_INQUIRE
, crypto
,
1042 client
->filename
, &key
, &keylen
);
1045 cleanup_crypto (&crypto
);
1049 rc
= send_status (client
->ctx
, STATUS_GENKEY
, NULL
);
1053 struct inquire_data_s idata
= { 0 };
1054 char *params
= client
->opts
& OPT_INQUIRE
1055 ? NULL
: default_key_params (client
->crypto
);
1057 pthread_cleanup_push (xfree
, params
);
1058 idata
.crypto
= client
->crypto
;
1062 idata
.line
= params
;
1063 idata
.len
= strlen (params
);
1068 client
->crypto
->agent
->inquire_data
= &idata
;
1069 client
->crypto
->agent
->inquire_cb
= NULL
;
1070 rc
= generate_key (client
->crypto
, params
,
1071 (client
->opts
& OPT_NO_PASSPHRASE
), 1);
1072 pthread_cleanup_pop (1);
1078 rc
= save_finalize (ctx
);
1080 cleanup_crypto_stage1 (client
->crypto
);
1082 (void) kill_scd (client
->crypto
->agent
);
1084 return send_error (ctx
, rc
);
1088 do_delete (assuan_context_t ctx
, char *line
)
1090 struct client_s
*client
= assuan_get_pointer (ctx
);
1095 if (strchr (line
, '\t'))
1096 req
= str_split (line
, "\t", 0);
1098 req
= str_split (line
, " ", 0);
1101 return GPG_ERR_SYNTAX
;
1103 n
= find_root_element (client
, client
->doc
, &req
, &rc
, NULL
, 0, 0);
1111 * No sub-node defined. Remove the entire node (root element).
1117 rc
= unlink_node (n
);
1126 find_elements (client
, client
->doc
, n
->children
, req
+ 1, &rc
, NULL
, NULL
, NULL
,
1134 rc
= unlink_node (n
);
1142 delete_command (assuan_context_t ctx
, char *line
)
1144 struct client_s
*client
= assuan_get_pointer (ctx
);
1146 struct argv_s
*args
[] = {
1147 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
1151 rc
= parse_options (&line
, args
, client
);
1153 return send_error (ctx
, rc
);
1155 if (client
->opts
& OPT_INQUIRE
)
1157 unsigned char *result
;
1160 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
1162 return send_error (ctx
, rc
);
1164 line
= (char *) result
;
1167 rc
= do_delete (ctx
, line
);
1169 if (client
->opts
& OPT_INQUIRE
)
1172 return send_error (ctx
, rc
);
1176 store_command (assuan_context_t ctx
, char *line
)
1178 struct client_s
*client
= assuan_get_pointer (ctx
);
1181 unsigned char *result
;
1183 xmlNodePtr n
, parent
;
1185 char *content
= NULL
;
1187 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
1189 return send_error (ctx
, rc
);
1191 req
= str_split ((char *) result
, "\t", 0);
1195 return send_error (ctx
, GPG_ERR_SYNTAX
);
1197 len
= strv_length (req
);
1198 has_content
= line
[strlen (line
) - 1] != '\t' && len
> 1;
1199 if (*(req
+ 1) && !valid_element_path (req
, has_content
))
1202 return send_error (ctx
, GPG_ERR_INV_VALUE
);
1205 if (has_content
|| !*req
[len
- 1])
1208 content
= req
[len
- 1];
1209 req
[len
- 1] = NULL
;
1213 n
= find_root_element (client
, client
->doc
, &req
, &rc
, NULL
, 0, 0);
1214 if (rc
&& rc
== GPG_ERR_ELEMENT_NOT_FOUND
)
1216 rc
= new_root_element (client
, client
->doc
, *req
);
1220 return send_error (ctx
, rc
);
1229 return send_error (ctx
, rc
);
1234 if (req
[1] && *req
[1])
1237 parent
= create_elements_cb (client
, n
, req
+ 1, &rc
, NULL
);
1239 parent
= find_elements (client
, client
->doc
, n
->children
, req
+ 1, &rc
,
1240 NULL
, NULL
, create_elements_cb
, 0, 0, NULL
,
1246 n
= find_text_node (parent
->children
);
1248 xmlNodeSetContent (n
, (xmlChar
*) content
);
1250 xmlNodeAddContent (parent
, (xmlChar
*) content
);
1252 update_element_mtime (parent
);
1257 return send_error (ctx
, rc
);
1261 xfer_data (assuan_context_t ctx
, const char *line
, int total
)
1266 int progress
= config_get_integer ("global", "xfer_progress");
1270 progress
> 0 ? (progress
/ ASSUAN_LINELENGTH
) * ASSUAN_LINELENGTH
: 0;
1271 to_send
= total
< ASSUAN_LINELENGTH
? total
: ASSUAN_LINELENGTH
;
1272 rc
= send_status (ctx
, STATUS_XFER
, "%li %li", sent
, total
);
1280 if (sent
+ to_send
> total
)
1281 to_send
= total
- sent
;
1283 rc
= assuan_send_data (ctx
, flush
? NULL
: (char *) line
+ sent
,
1284 flush
? 0 : to_send
);
1287 sent
+= flush
? 0 : to_send
;
1289 if ((progress
&& !(sent
% progress
) && sent
!= total
) ||
1290 (sent
== total
&& flush
))
1291 rc
= send_status (ctx
, STATUS_XFER
, "%li %li", sent
, total
);
1293 if (!flush
&& !rc
&& sent
== total
)
1300 while (!rc
&& sent
< total
);
1306 do_get (assuan_context_t ctx
, char *line
)
1308 struct client_s
*client
= assuan_get_pointer (ctx
);
1313 req
= str_split (line
, "\t", 0);
1318 return GPG_ERR_SYNTAX
;
1321 n
= find_root_element (client
, client
->doc
, &req
, &rc
, NULL
, 0, 0);
1330 find_elements (client
, client
->doc
, n
->children
, req
+ 1, &rc
, NULL
, NULL
, NULL
,
1337 if (!n
|| !n
->children
)
1338 return GPG_ERR_NO_DATA
;
1340 n
= find_text_node (n
->children
);
1341 if (!n
|| !n
->content
|| !*n
->content
)
1342 return GPG_ERR_NO_DATA
;
1344 rc
= xfer_data (ctx
, (char *) n
->content
, xmlStrlen (n
->content
));
1349 get_command (assuan_context_t ctx
, char *line
)
1351 struct client_s
*client
= assuan_get_pointer (ctx
);
1353 struct argv_s
*args
[] = {
1354 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
1358 rc
= parse_options (&line
, args
, client
);
1360 return send_error (ctx
, rc
);
1362 if (client
->opts
& OPT_INQUIRE
)
1364 unsigned char *result
;
1367 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
1369 return send_error (ctx
, rc
);
1371 line
= (char *) result
;
1374 rc
= do_get (ctx
, line
);
1376 if (client
->opts
& OPT_INQUIRE
)
1379 return send_error (ctx
, rc
);
1382 static void list_command_cleanup1 (void *arg
);
1384 realpath_command (assuan_context_t ctx
, char *line
)
1386 struct string_s
*string
= NULL
;
1388 struct client_s
*client
= assuan_get_pointer (ctx
);
1389 struct argv_s
*args
[] = {
1390 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
1394 rc
= parse_options (&line
, args
, client
);
1396 return send_error (ctx
, rc
);
1398 if (client
->opts
& OPT_INQUIRE
)
1400 unsigned char *result
;
1403 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
1405 return send_error (ctx
, rc
);
1407 line
= (char *) result
;
1410 rc
= build_realpath (client
, client
->doc
, line
, &string
);
1413 pthread_cleanup_push (list_command_cleanup1
, string
);
1414 rc
= xfer_data (ctx
, string
->str
, string
->len
);
1415 pthread_cleanup_pop (1);
1418 if (client
->opts
& OPT_INQUIRE
)
1421 return send_error (ctx
, rc
);
1425 list_command_cleanup1 (void *arg
)
1428 string_free ((struct string_s
*) arg
, 1);
1432 list_command_cleanup2 (void *arg
)
1434 struct element_list_s
*elements
= arg
;
1440 int total
= slist_length (elements
->list
);
1443 for (i
= 0; i
< total
; i
++)
1445 char *tmp
= slist_nth_data (elements
->list
, i
);
1449 slist_free (elements
->list
);
1452 if (elements
->prefix
)
1453 xfree (elements
->prefix
);
1456 strv_free (elements
->req
);
1463 parse_list_opt_norecurse (void *data
, void *value
)
1465 struct client_s
*client
= data
;
1467 client
->opts
&= ~(OPT_LIST_RECURSE
);
1472 parse_list_opt_verbose (void *data
, void *value
)
1474 struct client_s
*client
= data
;
1476 client
->opts
|= OPT_LIST_VERBOSE
;
1481 parse_list_opt_target (void *data
, void *value
)
1483 struct client_s
*client
= data
;
1485 client
->opts
|= OPT_LIST_WITH_TARGET
;
1490 parse_list_opt_all (void *data
, void *value
)
1492 struct client_s
*client
= data
;
1494 client
->opts
|= OPT_LIST_ALL
;
1499 list_path_once (struct client_s
*client
, char *line
,
1500 struct element_list_s
*elements
, struct string_s
*result
)
1504 elements
->req
= str_split (line
, " ", 0);
1506 strv_printf (&elements
->req
, "%s", line
);
1508 rc
= create_path_list (client
, client
->doc
, elements
, *elements
->req
);
1509 if (rc
== GPG_ERR_ELOOP
&& elements
->verbose
)
1514 int total
= slist_length (elements
->list
);
1517 rc
= GPG_ERR_NO_DATA
;
1525 for (i
= 0; i
< total
; i
++)
1527 char *tmp
= slist_nth_data (elements
->list
, i
);
1529 string_append_printf (result
, "%s%s", tmp
,
1530 i
+ 1 == total
? "" : "\n");
1535 rc
= GPG_ERR_NO_DATA
;
1542 has_list_flag (char *path
, char *flags
)
1546 while (*p
&& *++p
!= ' ');
1555 for (f
= flags
; *f
&& *f
!= ' '; f
++)
1566 do_list (assuan_context_t ctx
, char *line
)
1568 struct client_s
*client
= assuan_get_pointer (ctx
);
1570 struct element_list_s
*elements
= NULL
;
1572 elements
= xcalloc (1, sizeof (struct element_list_s
));
1574 return GPG_ERR_ENOMEM
;
1576 elements
->recurse
= client
->opts
& OPT_LIST_RECURSE
;
1578 (client
->opts
& OPT_LIST_VERBOSE
) | (client
->opts
& OPT_LIST_WITH_TARGET
);
1579 elements
->with_target
= client
->opts
& OPT_LIST_WITH_TARGET
;
1581 if (!line
|| !*line
)
1583 struct string_s
*str
= NULL
;
1585 pthread_cleanup_push (list_command_cleanup2
, elements
);
1586 rc
= list_root_elements (client
, client
->doc
, &str
, elements
->verbose
,
1587 elements
->with_target
);
1588 pthread_cleanup_pop (1);
1589 pthread_cleanup_push (list_command_cleanup1
, str
);
1593 if (client
->opts
& OPT_LIST_ALL
)
1595 char **roots
= str_split (str
->str
, "\n", 0);
1598 pthread_cleanup_push (req_cleanup
, roots
);
1599 string_truncate (str
, 0);
1601 for (p
= roots
; *p
; p
++)
1603 if (strchr (*p
, ' '))
1605 if (has_list_flag (*p
, "EO"))
1607 string_append_printf (str
, "%s%s", *p
,
1608 *(p
+ 1) ? "\n" : "");
1613 elements
= xcalloc (1, sizeof (struct element_list_s
));
1616 rc
= GPG_ERR_ENOMEM
;
1620 elements
->recurse
= client
->opts
& OPT_LIST_RECURSE
;
1622 (client
->opts
& OPT_LIST_VERBOSE
) | (client
->opts
&
1623 OPT_LIST_WITH_TARGET
);
1624 elements
->with_target
= client
->opts
& OPT_LIST_WITH_TARGET
;
1625 pthread_cleanup_push (list_command_cleanup2
, elements
);
1626 rc
= list_path_once (client
, *p
, elements
, str
);
1627 pthread_cleanup_pop (1);
1632 string_append (str
, "\n");
1635 pthread_cleanup_pop (1);
1639 rc
= xfer_data (ctx
, str
->str
, str
->len
);
1642 pthread_cleanup_pop (1);
1646 pthread_cleanup_push (list_command_cleanup2
, elements
);
1647 struct string_s
*str
= string_new (NULL
);
1648 pthread_cleanup_push (list_command_cleanup1
, str
);
1649 rc
= list_path_once (client
, line
, elements
, str
);
1651 rc
= xfer_data (ctx
, str
->str
, str
->len
);
1653 pthread_cleanup_pop (1);
1654 pthread_cleanup_pop (1);
1659 list_command (assuan_context_t ctx
, char *line
)
1661 struct client_s
*client
= assuan_get_pointer (ctx
);
1663 struct argv_s
*args
[] = {
1664 &(struct argv_s
) {"no-recurse", OPTION_TYPE_NOARG
,
1665 parse_list_opt_norecurse
},
1666 &(struct argv_s
) {"verbose", OPTION_TYPE_NOARG
, parse_list_opt_verbose
},
1667 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
1668 &(struct argv_s
) {"with-target", OPTION_TYPE_NOARG
,
1669 parse_list_opt_target
},
1670 &(struct argv_s
) {"all", OPTION_TYPE_NOARG
, parse_list_opt_all
},
1674 if (disable_list_and_dump
== 1)
1675 return send_error (ctx
, GPG_ERR_NOT_IMPLEMENTED
);
1677 client
->opts
|= OPT_LIST_RECURSE
;
1678 rc
= parse_options (&line
, args
, client
);
1680 return send_error (ctx
, rc
);
1682 if (client
->opts
& OPT_LIST_ALL
)
1683 client
->opts
|= OPT_LIST_RECURSE
| OPT_LIST_VERBOSE
;
1685 if (client
->opts
& OPT_INQUIRE
)
1687 unsigned char *result
;
1690 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
1692 return send_error (ctx
, rc
);
1694 line
= (char *) result
;
1697 rc
= do_list (ctx
, line
);
1699 if (client
->opts
& OPT_INQUIRE
)
1702 return send_error (ctx
, rc
);
1706 * req[0] - element path
1709 attribute_list (assuan_context_t ctx
, char **req
)
1711 struct client_s
*client
= assuan_get_pointer (ctx
);
1712 char **attrlist
= NULL
;
1720 if (!req
|| !req
[0])
1721 return GPG_ERR_SYNTAX
;
1723 if ((path
= str_split (req
[0], "\t", 0)) == NULL
)
1726 * The first argument may be only a root element.
1728 if ((path
= str_split (req
[0], " ", 0)) == NULL
)
1729 return GPG_ERR_SYNTAX
;
1732 n
= find_root_element (client
, client
->doc
, &path
, &rc
, NULL
, 0, 0);
1742 n
= find_elements (client
, client
->doc
, n
->children
, path
+ 1, &rc
,
1743 NULL
, NULL
, NULL
, 0, 0, NULL
, 0);
1754 for (a
= n
->properties
; a
; a
= a
->next
)
1758 if ((pa
= xrealloc (attrlist
, (i
+ 2) * sizeof (char *))) == NULL
)
1761 strv_free (attrlist
);
1763 log_write ("%s(%i): %s", __FILE__
, __LINE__
,
1764 pwmd_strerror (GPG_ERR_ENOMEM
));
1765 return GPG_ERR_ENOMEM
;
1770 attrlist
[i
] = str_asprintf ("%s %s", (char *) a
->name
,
1772 && an
->content
? (char *) an
->content
: "");
1776 strv_free (attrlist
);
1777 log_write ("%s(%i): %s", __FILE__
, __LINE__
,
1778 pwmd_strerror (GPG_ERR_ENOMEM
));
1779 return GPG_ERR_ENOMEM
;
1782 attrlist
[++i
] = NULL
;
1786 return GPG_ERR_NO_DATA
;
1788 line
= strv_join ("\n", attrlist
);
1792 log_write ("%s(%i): %s", __FILE__
, __LINE__
,
1793 pwmd_strerror (GPG_ERR_ENOMEM
));
1794 strv_free (attrlist
);
1795 return GPG_ERR_ENOMEM
;
1798 pthread_cleanup_push (xfree
, line
);
1799 pthread_cleanup_push (req_cleanup
, attrlist
);
1800 rc
= xfer_data (ctx
, line
, strlen (line
));
1801 pthread_cleanup_pop (1);
1802 pthread_cleanup_pop (1);
1807 * req[0] - attribute
1808 * req[1] - element path
1811 attribute_delete (struct client_s
*client
, char **req
)
1817 if (!req
|| !req
[0] || !req
[1])
1818 return GPG_ERR_SYNTAX
;
1820 if (!strcmp (req
[0], "_name"))
1821 return GPG_ERR_INV_ATTR
;
1823 if ((path
= str_split (req
[1], "\t", 0)) == NULL
)
1826 * The first argument may be only a root element.
1828 if ((path
= str_split (req
[1], " ", 0)) == NULL
)
1829 return GPG_ERR_SYNTAX
;
1832 n
= find_root_element (client
, client
->doc
, &path
, &rc
, NULL
, 0, 0);
1838 n
= find_elements (client
, client
->doc
, n
->children
, path
+ 1, &rc
,
1839 NULL
, NULL
, NULL
, 0, 0, NULL
, 0);
1844 rc
= delete_attribute (n
, (xmlChar
*) req
[0]);
1852 create_element_path (struct client_s
*client
,
1853 char ***elements
, gpg_error_t
* rc
, xmlNodePtr parent
)
1855 char **req
= *elements
;
1856 char **req_orig
= strv_dup (req
);
1857 xmlNodePtr n
= NULL
;
1863 *rc
= GPG_ERR_ENOMEM
;
1864 log_write ("%s(%i): %s", __FILE__
, __LINE__
,
1865 pwmd_strerror (GPG_ERR_ENOMEM
));
1870 n
= find_root_element (client
, client
->doc
, &req
, rc
, NULL
, 0, 0);
1873 if (*rc
!= GPG_ERR_ELEMENT_NOT_FOUND
)
1876 *rc
= new_root_element (client
, client
->doc
, req
[0]);
1882 else if (n
== parent
)
1884 *rc
= GPG_ERR_CONFLICT
;
1891 n
= create_target_elements_cb (client
, n
, req
+ 1, rc
, NULL
);
1893 n
= find_elements (client
, client
->doc
, n
->children
, req
+ 1, rc
,
1894 NULL
, NULL
, create_target_elements_cb
, 0, 0,
1901 * Reset the position of the element tree now that the elements
1902 * have been created.
1907 n
= find_root_element (client
, client
->doc
, &req
, rc
, NULL
, 0, 0);
1911 n
= find_elements (client
, client
->doc
, n
->children
, req
+ 1, rc
,
1912 NULL
, NULL
, NULL
, 0, 0, NULL
, 0);
1919 strv_free (req_orig
);
1926 * Creates a "target" attribute. When other commands encounter an element with
1927 * this attribute, the element path is modified to the target value. If the
1928 * source element path doesn't exist when using 'ATTR SET target', it is
1929 * created, but the destination element path must exist.
1931 * req[0] - source element path
1932 * req[1] - destination element path
1935 target_attribute (struct client_s
*client
, char **req
)
1937 char **src
, **dst
, *line
= NULL
, **odst
= NULL
;
1941 if (!req
|| !req
[0] || !req
[1])
1942 return GPG_ERR_SYNTAX
;
1944 if ((src
= str_split (req
[0], "\t", 0)) == NULL
)
1947 * The first argument may be only a root element.
1949 if ((src
= str_split (req
[0], " ", 0)) == NULL
)
1950 return GPG_ERR_SYNTAX
;
1953 if (!valid_element_path (src
, 0))
1954 return GPG_ERR_INV_VALUE
;
1956 if ((dst
= str_split (req
[1], "\t", 0)) == NULL
)
1959 * The first argument may be only a root element.
1961 if ((dst
= str_split (req
[1], " ", 0)) == NULL
)
1963 rc
= GPG_ERR_SYNTAX
;
1968 odst
= strv_dup (dst
);
1971 rc
= GPG_ERR_ENOMEM
;
1975 n
= find_root_element (client
, client
->doc
, &dst
, &rc
, NULL
, 0, 0);
1977 * Make sure the destination element path exists.
1984 n
= find_elements (client
, client
->doc
, n
->children
, dst
+ 1, &rc
,
1985 NULL
, NULL
, NULL
, 0, 0, NULL
, 0);
1990 rc
= validate_target_attribute (client
, client
->doc
, req
[0], n
);
1991 if (rc
&& rc
!= GPG_ERR_ELEMENT_NOT_FOUND
)
1994 n
= create_element_path (client
, &src
, &rc
, NULL
);
1998 line
= strv_join ("\t", odst
);
2001 rc
= GPG_ERR_ENOMEM
;
2005 rc
= add_attribute (n
, "target", line
);
2016 * req[0] - attribute
2017 * req[1] - element path
2020 attribute_get (assuan_context_t ctx
, char **req
)
2022 struct client_s
*client
= assuan_get_pointer (ctx
);
2028 if (!req
|| !req
[0] || !req
[1])
2029 return GPG_ERR_SYNTAX
;
2031 if (strchr (req
[1], '\t'))
2033 if ((path
= str_split (req
[1], "\t", 0)) == NULL
)
2034 return GPG_ERR_SYNTAX
;
2038 if ((path
= str_split (req
[1], " ", 0)) == NULL
)
2039 return GPG_ERR_SYNTAX
;
2042 n
= find_root_element (client
, client
->doc
, &path
, &rc
, NULL
, 0, 0);
2049 n
= find_elements (client
, client
->doc
, n
->children
, path
+ 1, &rc
,
2050 NULL
, NULL
, NULL
, 0, 0, NULL
, 0);
2058 if ((a
= xmlGetProp (n
, (xmlChar
*) req
[0])) == NULL
)
2059 return GPG_ERR_NOT_FOUND
;
2061 pthread_cleanup_push (xmlFree
, a
);
2064 rc
= xfer_data (ctx
, (char *) a
, xmlStrlen (a
));
2066 rc
= GPG_ERR_NO_DATA
;
2068 pthread_cleanup_pop (1);
2077 * req[0] - attribute
2078 * req[1] - element path
2082 attribute_set (struct client_s
*client
, char **req
)
2088 if (!req
|| !req
[0] || !req
[1])
2089 return GPG_ERR_SYNTAX
;
2092 * Reserved attribute names.
2094 if (!strcmp (req
[0], "_name"))
2095 return GPG_ERR_INV_ATTR
;
2096 else if (!strcmp (req
[0], "target"))
2097 return target_attribute (client
, req
+ 1);
2098 else if (!valid_xml_attribute (req
[0]))
2099 return GPG_ERR_INV_VALUE
;
2101 if ((path
= str_split (req
[1], "\t", 0)) == NULL
)
2104 * The first argument may be only a root element.
2106 if ((path
= str_split (req
[1], " ", 0)) == NULL
)
2107 return GPG_ERR_SYNTAX
;
2110 n
= find_root_element (client
, client
->doc
, &path
, &rc
, NULL
, 0, 0);
2117 n
= find_elements (client
, client
->doc
, n
->children
, path
+ 1, &rc
,
2118 NULL
, NULL
, NULL
, 0, 0, NULL
, 0);
2124 rc
= add_attribute (n
, req
[0], req
[2]);
2133 * req[1] - attribute name or element path if command is LIST
2134 * req[2] - element path
2135 * req[2] - element path or value
2139 do_attr (assuan_context_t ctx
, char *line
)
2141 struct client_s
*client
= assuan_get_pointer (ctx
);
2145 req
= str_split (line
, " ", 4);
2146 if (!req
|| !req
[0] || !req
[1])
2149 return GPG_ERR_SYNTAX
;
2152 pthread_cleanup_push (req_cleanup
, req
);
2154 if (strcasecmp (req
[0], "SET") == 0)
2155 rc
= attribute_set (client
, req
+ 1);
2156 else if (strcasecmp (req
[0], "GET") == 0)
2157 rc
= attribute_get (ctx
, req
+ 1);
2158 else if (strcasecmp (req
[0], "DELETE") == 0)
2159 rc
= attribute_delete (client
, req
+ 1);
2160 else if (strcasecmp (req
[0], "LIST") == 0)
2161 rc
= attribute_list (ctx
, req
+ 1);
2163 rc
= GPG_ERR_SYNTAX
;
2165 pthread_cleanup_pop (1);
2170 attr_command (assuan_context_t ctx
, char *line
)
2172 struct client_s
*client
= assuan_get_pointer (ctx
);
2174 struct argv_s
*args
[] = {
2175 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
2179 rc
= parse_options (&line
, args
, client
);
2181 return send_error (ctx
, rc
);
2183 if (client
->opts
& OPT_INQUIRE
)
2185 unsigned char *result
;
2188 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
2190 return send_error (ctx
, rc
);
2192 line
= (char *) result
;
2195 rc
= do_attr (ctx
, line
);
2197 if (client
->opts
& OPT_INQUIRE
)
2200 return send_error (ctx
, rc
);
2204 parse_iscached_opt_lock (void *data
, void *value
)
2206 struct client_s
*client
= data
;
2209 client
->opts
|= OPT_LOCK
;
2214 iscached_command (assuan_context_t ctx
, char *line
)
2216 struct client_s
*client
= assuan_get_pointer (ctx
);
2218 struct argv_s
*args
[] = {
2219 &(struct argv_s
) {"lock", OPTION_TYPE_NOARG
, parse_iscached_opt_lock
},
2223 if (!line
|| !*line
)
2224 return send_error (ctx
, GPG_ERR_SYNTAX
);
2226 rc
= parse_options (&line
, args
, client
);
2228 return send_error (ctx
, rc
);
2229 else if (!valid_filename (line
))
2230 return send_error (ctx
, GPG_ERR_INV_VALUE
);
2232 rc
= cache_iscached (line
, NULL
);
2233 if (client
->opts
& OPT_LOCK
2234 && (!rc
|| gpg_err_code (rc
) == GPG_ERR_NO_DATA
))
2236 unsigned char md5file
[16];
2237 gpg_error_t trc
= rc
;
2239 gcry_md_hash_buffer (GCRY_MD_MD5
, md5file
, line
, strlen (line
));
2240 if (memcmp (md5file
, client
->md5file
, 16))
2241 cleanup_client (client
);
2243 memcpy (client
->md5file
, md5file
, 16);
2244 rc
= do_lock (client
, 1);
2249 return send_error (ctx
, rc
);
2253 clearcache_command (assuan_context_t ctx
, char *line
)
2255 gpg_error_t rc
= 0, all_rc
= 0;
2256 unsigned char md5file
[16];
2260 struct client_thread_s
*once
= NULL
;
2263 MUTEX_LOCK (&cn_mutex
);
2264 pthread_cleanup_push (cleanup_mutex_cb
, &cn_mutex
);
2266 if (!line
|| !*line
)
2269 t
= slist_length (cn_thread_list
);
2271 for (i
= 0; i
< t
; i
++)
2273 struct client_thread_s
*thd
= slist_nth_data (cn_thread_list
, i
);
2274 assuan_peercred_t peer
;
2279 /* Lock each connected clients' file mutex to prevent any other client
2280 * from accessing the cache entry (the file mutex is locked upon
2281 * command startup). The cache for the entry is not cleared if the
2282 * file mutex is locked by another client to prevent this function
2287 if (thd
->cl
->filename
)
2289 rc
= do_validate_peer (ctx
, thd
->cl
->filename
, &peer
);
2290 all_rc
= !all_rc
? rc
: all_rc
;
2298 rc
= cache_lock_mutex (thd
->cl
->ctx
, thd
->cl
->md5file
, -1, 0, -1);
2299 if (gpg_err_code (rc
) == GPG_ERR_LOCKED
)
2301 if (pthread_equal (pthread_self (), thd
->tid
))
2305 if (!thd
->cl
->filename
||
2306 cache_iscached (thd
->cl
->filename
,
2307 NULL
) == GPG_ERR_NO_DATA
)
2313 cache_defer_clear (thd
->cl
->md5file
);
2316 else if (gpg_err_code (rc
) == GPG_ERR_NO_DATA
)
2324 rc
= cache_clear (thd
->cl
->md5file
);
2325 cache_unlock_mutex (thd
->cl
->md5file
, 0);
2333 /* A single data filename was specified. Lock only this data file
2334 * mutex and free the cache entry. */
2337 gcry_md_hash_buffer (GCRY_MD_MD5
, md5file
, line
, strlen (line
));
2338 rc
= do_validate_peer (ctx
, line
, &peer
);
2340 if (!rc
&& !memcmp (thd
->cl
->md5file
, md5file
, sizeof (md5file
)))
2342 rc
= cache_lock_mutex (thd
->cl
->ctx
, thd
->cl
->md5file
, -1, 0,
2344 if (gpg_err_code (rc
) == GPG_ERR_LOCKED
)
2346 if (pthread_equal (pthread_self (), thd
->tid
))
2353 rc
= cache_clear (thd
->cl
->md5file
);
2354 cache_unlock_mutex (thd
->cl
->md5file
, 0);
2358 cache_defer_clear (thd
->cl
->md5file
);
2366 /* Only connected clients' cache entries have been cleared. Now clear any
2367 * remaining cache entries without clients but only if there wasn't an
2368 * error from above since this would defeat the locking check of the
2369 * remaining entries. */
2375 /* No clients are using the specified file. */
2376 else if (!all_rc
&& !rc
&& !once
)
2378 gcry_md_hash_buffer (GCRY_MD_MD5
, md5file
, line
, strlen (line
));
2379 rc
= cache_clear (md5file
);
2382 /* Release the connection mutex. */
2383 pthread_cleanup_pop (1);
2387 send_status_all (STATUS_CACHE
, NULL
);
2389 /* One or more files were locked while clearing all cache entries. */
2393 return send_error (ctx
, rc
);
2397 cachetimeout_command (assuan_context_t ctx
, char *line
)
2400 char **req
= str_split (line
, " ", 0);
2403 assuan_peercred_t peer
;
2405 if (!req
|| !*req
|| !req
[1])
2408 return send_error (ctx
, GPG_ERR_SYNTAX
);
2412 timeout
= (int) strtol (req
[1], &p
, 10);
2413 if (errno
!= 0 || *p
|| timeout
< -1)
2416 return send_error (ctx
, GPG_ERR_SYNTAX
);
2419 rc
= do_validate_peer (ctx
, req
[0], &peer
);
2422 unsigned char md5file
[16];
2424 gcry_md_hash_buffer (GCRY_MD_MD5
, md5file
, req
[0], strlen (req
[0]));
2425 rc
= cache_set_timeout (md5file
, timeout
);
2426 if (!rc
|| gpg_err_code (rc
) == GPG_ERR_NOT_FOUND
)
2429 MUTEX_LOCK (&rcfile_mutex
);
2430 config_set_int_param (&global_config
, req
[0], "cache_timeout",
2432 MUTEX_UNLOCK (&rcfile_mutex
);
2437 return send_error (ctx
, rc
);
2441 dump_command (assuan_context_t ctx
, char *line
)
2445 struct client_s
*client
= assuan_get_pointer (ctx
);
2448 if (disable_list_and_dump
== 1)
2449 return send_error (ctx
, GPG_ERR_NOT_IMPLEMENTED
);
2451 rc
= peer_is_self(client
);
2453 return send_error (ctx
, rc
);
2455 xmlDocDumpFormatMemory (client
->doc
, &xml
, &len
, 1);
2459 log_write ("%s(%i): %s", __FILE__
, __LINE__
,
2460 pwmd_strerror (GPG_ERR_ENOMEM
));
2461 return send_error (ctx
, GPG_ERR_ENOMEM
);
2464 pthread_cleanup_push (xmlFree
, xml
);
2465 rc
= xfer_data (ctx
, (char *) xml
, len
);
2466 pthread_cleanup_pop (1);
2467 return send_error (ctx
, rc
);
2471 getconfig_command (assuan_context_t ctx
, char *line
)
2473 struct client_s
*client
= assuan_get_pointer (ctx
);
2475 char filename
[255] = { 0 }, param
[747] = { 0 };
2476 char *p
, *tmp
= NULL
, *fp
= client
->filename
, *paramp
= line
;
2478 if (!line
|| !*line
)
2479 return send_error (ctx
, GPG_ERR_SYNTAX
);
2481 if (strchr (line
, ' '))
2483 sscanf (line
, " %254[^ ] %746c", filename
, param
);
2488 if (fp
&& !valid_filename (fp
))
2489 return send_error (ctx
, GPG_ERR_INV_VALUE
);
2491 paramp
= str_down (paramp
);
2492 if (!strcmp (paramp
, "cipher") && fp
)
2494 struct crypto_s
*crypto
= NULL
;
2496 rc
= init_client_crypto (&crypto
);
2499 rc
= read_data_header (fp
, &crypto
->hdr
, NULL
, NULL
);
2503 gcry_cipher_algo_name (cipher_to_gcrypt (crypto
->hdr
.flags
));
2513 UPDATE_AGENT_CTX (client
, crypto
);
2514 cleanup_crypto (&crypto
);
2515 if (rc
&& gpg_err_code (rc
) != GPG_ERR_ENOENT
)
2516 return send_error (ctx
, rc
);
2521 else if (!strcmp (paramp
, "cipher_iterations") && fp
)
2523 struct crypto_s
*crypto
= NULL
;
2525 rc
= init_client_crypto (&crypto
);
2528 rc
= read_data_header (fp
, &crypto
->hdr
, NULL
, NULL
);
2531 tmp
= str_asprintf ("%llu",
2532 (unsigned long long) crypto
->hdr
.
2535 rc
= GPG_ERR_ENOMEM
;
2539 UPDATE_AGENT_CTX (client
, crypto
);
2540 cleanup_crypto (&crypto
);
2541 if (rc
&& gpg_err_code (rc
) != GPG_ERR_ENOENT
)
2542 return send_error (ctx
, rc
);
2547 else if (!strcmp (paramp
, "passphrase"))
2548 return send_error (ctx
, GPG_ERR_UNKNOWN_OPTION
);
2550 p
= config_get_value (fp
? fp
: "global", paramp
);
2552 return send_error (ctx
, GPG_ERR_UNKNOWN_OPTION
);
2554 tmp
= expand_homedir (p
);
2558 log_write ("%s(%i): %s", __FILE__
, __LINE__
,
2559 pwmd_strerror (GPG_ERR_ENOMEM
));
2560 return send_error (ctx
, GPG_ERR_ENOMEM
);
2565 pthread_cleanup_push (xfree
, p
);
2566 rc
= xfer_data (ctx
, p
, strlen (p
));
2567 pthread_cleanup_pop (1);
2568 return send_error (ctx
, rc
);
2573 xmlXPathContextPtr xp
;
2574 xmlXPathObjectPtr result
;
2580 xpath_command_cleanup (void *arg
)
2582 struct xpath_s
*xpath
= arg
;
2587 req_cleanup (xpath
->req
);
2590 xmlBufferFree (xpath
->buf
);
2593 xmlXPathFreeObject (xpath
->result
);
2596 xmlXPathFreeContext (xpath
->xp
);
2600 do_xpath (assuan_context_t ctx
, char *line
)
2603 struct client_s
*client
= assuan_get_pointer (ctx
);
2604 struct xpath_s _x
= { 0 };
2605 struct xpath_s
*xpath
= &_x
;
2607 if ((xpath
->req
= str_split (line
, "\t", 2)) == NULL
)
2609 if (strv_printf (&xpath
->req
, "%s", line
) == 0)
2610 return GPG_ERR_ENOMEM
;
2613 xpath
->xp
= xmlXPathNewContext (client
->doc
);
2616 rc
= GPG_ERR_BAD_DATA
;
2621 xmlXPathEvalExpression ((xmlChar
*) xpath
->req
[0], xpath
->xp
);
2624 rc
= GPG_ERR_BAD_DATA
;
2628 if (xmlXPathNodeSetIsEmpty (xpath
->result
->nodesetval
))
2630 rc
= GPG_ERR_ELEMENT_NOT_FOUND
;
2634 rc
= recurse_xpath_nodeset (client
->doc
, xpath
->result
->nodesetval
,
2635 (xmlChar
*) xpath
->req
[1], &xpath
->buf
, 0,
2639 else if (!xpath
->req
[1] && !xmlBufferLength (xpath
->buf
))
2641 rc
= GPG_ERR_NO_DATA
;
2644 else if (xpath
->req
[1])
2650 pthread_cleanup_push (xpath_command_cleanup
, &xpath
);
2651 rc
= xfer_data (ctx
, (char *) xmlBufferContent (xpath
->buf
),
2652 xmlBufferLength (xpath
->buf
));
2653 pthread_cleanup_pop (0);
2655 xpath_command_cleanup (xpath
);
2660 xpath_command (assuan_context_t ctx
, char *line
)
2662 struct client_s
*client
= assuan_get_pointer (ctx
);
2664 struct argv_s
*args
[] = {
2665 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
2669 if (disable_list_and_dump
== 1)
2670 return send_error (ctx
, GPG_ERR_NOT_IMPLEMENTED
);
2672 rc
= peer_is_self(client
);
2674 return send_error (ctx
, rc
);
2676 rc
= parse_options (&line
, args
, client
);
2678 return send_error (ctx
, rc
);
2680 if (client
->opts
& OPT_INQUIRE
)
2682 unsigned char *result
;
2685 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
2687 return send_error (ctx
, rc
);
2689 line
= (char *) result
;
2692 if (!line
|| !*line
)
2693 rc
= GPG_ERR_SYNTAX
;
2696 rc
= do_xpath (ctx
, line
);
2698 if (client
->opts
& OPT_INQUIRE
)
2701 return send_error (ctx
, rc
);
2705 do_xpathattr (assuan_context_t ctx
, char *line
)
2707 struct client_s
*client
= assuan_get_pointer (ctx
);
2711 struct xpath_s _x
= { 0 };
2712 struct xpath_s
*xpath
= &_x
;
2714 if ((req
= str_split (line
, " ", 3)) == NULL
)
2715 return GPG_ERR_ENOMEM
;
2719 rc
= GPG_ERR_SYNTAX
;
2723 if (!strcasecmp (req
[0], "SET"))
2725 else if (!strcasecmp (req
[0], "DELETE"))
2729 rc
= GPG_ERR_SYNTAX
;
2733 if (!req
[1] || !req
[2])
2735 rc
= GPG_ERR_SYNTAX
;
2739 if ((xpath
->req
= str_split (req
[2], "\t", 3)) == NULL
)
2741 rc
= GPG_ERR_ENOMEM
;
2745 if (!xpath
->req
[0] || (!xpath
->req
[1] && !cmd
) || (xpath
->req
[1] && cmd
))
2747 rc
= GPG_ERR_SYNTAX
;
2751 xpath
->xp
= xmlXPathNewContext (client
->doc
);
2754 rc
= GPG_ERR_BAD_DATA
;
2758 xpath
->result
= xmlXPathEvalExpression ((xmlChar
*) xpath
->req
[0], xpath
->xp
);
2761 rc
= GPG_ERR_BAD_DATA
;
2765 if (xmlXPathNodeSetIsEmpty (xpath
->result
->nodesetval
))
2767 rc
= GPG_ERR_ELEMENT_NOT_FOUND
;
2771 rc
= recurse_xpath_nodeset (client
->doc
, xpath
->result
->nodesetval
,
2772 (xmlChar
*) xpath
->req
[1], &xpath
->buf
, cmd
,
2773 (xmlChar
*) req
[1]);
2776 xpath_command_cleanup (xpath
);
2781 /* XPATHATTR SET|DELETE <name> <expression>[<TAB>[value]] */
2783 xpathattr_command (assuan_context_t ctx
, char *line
)
2785 struct client_s
*client
= assuan_get_pointer (ctx
);
2787 struct argv_s
*args
[] = {
2788 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
2792 if (disable_list_and_dump
== 1)
2793 return send_error (ctx
, GPG_ERR_NOT_IMPLEMENTED
);
2795 rc
= peer_is_self(client
);
2797 return send_error (ctx
, rc
);
2799 rc
= parse_options (&line
, args
, client
);
2801 return send_error (ctx
, rc
);
2803 if (client
->opts
& OPT_INQUIRE
)
2805 unsigned char *result
;
2808 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
2810 return send_error (ctx
, rc
);
2812 line
= (char *) result
;
2815 if (!line
|| !*line
)
2816 rc
= GPG_ERR_SYNTAX
;
2819 rc
= do_xpathattr (ctx
, line
);
2821 if (client
->opts
& OPT_INQUIRE
)
2824 return send_error (ctx
, rc
);
2828 do_import (struct client_s
*client
, const char *root_element
,
2829 unsigned char *content
)
2831 char **dst_path
= NULL
;
2832 xmlDocPtr doc
= NULL
;
2833 xmlNodePtr n
, root
, copy
;
2836 if (!content
|| !*content
)
2839 return GPG_ERR_SYNTAX
;
2843 dst_path
= str_split (root_element
, "\t", 0);
2845 if (dst_path
&& !valid_element_path (dst_path
, 0))
2848 strv_free (dst_path
);
2850 return GPG_ERR_INV_VALUE
;
2853 struct string_s
*str
= string_new_content ((char *)content
);
2854 str
= string_prepend (str
, "<pwmd>");
2855 str
= string_append (str
, "</pwmd>");
2856 doc
= xmlReadDoc ((xmlChar
*) str
->str
, NULL
, "UTF-8", XML_PARSE_NOBLANKS
);
2857 string_free (str
, 1);
2860 rc
= GPG_ERR_BAD_DATA
;
2864 root
= xmlDocGetRootElement (doc
);
2865 xmlNodePtr root_orig
= root
->children
;
2866 root
= root
->children
;
2867 rc
= validate_import (root
);
2876 char **path
= strv_dup (dst_path
);
2879 log_write ("%s(%i): %s", __FILE__
, __LINE__
,
2880 pwmd_strerror (GPG_ERR_ENOMEM
));
2881 rc
= GPG_ERR_ENOMEM
;
2885 xmlChar
*a
= xmlGetProp (root
, (xmlChar
*) "_name");
2889 rc
= GPG_ERR_INV_VALUE
;
2893 if (strv_printf (&path
, "%s", (char *) a
) == 0)
2896 rc
= GPG_ERR_ENOMEM
;
2901 n
= find_root_element (client
, client
->doc
, &path
, &rc
, NULL
, 0, 0);
2902 if (rc
&& rc
!= GPG_ERR_ELEMENT_NOT_FOUND
)
2910 n
= find_elements (client
, client
->doc
, n
->children
, path
+ 1, &rc
,
2911 NULL
, NULL
, NULL
, 0, 0, NULL
, 1);
2912 if (rc
&& rc
!= GPG_ERR_ELEMENT_NOT_FOUND
)
2927 if (rc
== GPG_ERR_ELEMENT_NOT_FOUND
)
2929 n
= create_element_path (client
, &path
, &rc
, NULL
);
2936 copy
= xmlCopyNodeList (root
->children
);
2937 n
= xmlAddChildList (n
, copy
);
2939 rc
= GPG_ERR_ENOMEM
;
2948 /* Check if the content root element can create a DTD root element. */
2949 if (!xmlStrEqual ((xmlChar
*) "element", root
->name
))
2951 rc
= GPG_ERR_SYNTAX
;
2957 if ((a
= xmlGetProp (root
, (xmlChar
*) "_name")) == NULL
)
2959 rc
= GPG_ERR_SYNTAX
;
2963 char *tmp
= str_dup ((char *) a
);
2965 int literal
= is_literal_element (&tmp
);
2967 if (!valid_xml_element ((xmlChar
*) tmp
) || literal
)
2970 rc
= GPG_ERR_INV_VALUE
;
2974 if (strv_printf (&path
, "%s", tmp
) == 0)
2977 rc
= GPG_ERR_ENOMEM
;
2982 n
= find_root_element (client
, client
->doc
, &path
, &rc
, NULL
, 0, 1);
2983 if (rc
&& rc
!= GPG_ERR_ELEMENT_NOT_FOUND
)
2985 rc
= GPG_ERR_BAD_DATA
;
2989 /* Overwriting the existing tree. */
2993 xmlFreeNodeList (n
);
2997 xmlSetProp (root
, (xmlChar
*) "_name", (xmlChar
*) path
[0]);
2998 n
= xmlCopyNode (root
, 1);
2999 n
= xmlAddChildList (xmlDocGetRootElement (client
->doc
), n
);
3004 rc
= update_element_mtime (n
->parent
);
3006 for (root
= root_orig
->next
; root
; root
= root
->next
)
3008 if (root
->type
== XML_ELEMENT_NODE
)
3021 strv_free (dst_path
);
3027 parse_import_opt_root (void *data
, void *value
)
3029 struct client_s
*client
= data
;
3031 client
->import_root
= str_dup (value
);
3032 return client
->import_root
? 0 : GPG_ERR_ENOMEM
;
3036 import_command (assuan_context_t ctx
, char *line
)
3039 struct client_s
*client
= assuan_get_pointer (ctx
);
3040 unsigned char *result
;
3042 struct argv_s
*args
[] = {
3043 &(struct argv_s
) {"root", OPTION_TYPE_ARG
, parse_import_opt_root
},
3047 xfree (client
->import_root
);
3048 client
->import_root
= NULL
;
3049 rc
= parse_options (&line
, args
, client
);
3051 return send_error (ctx
, rc
);
3053 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
3056 xfree (client
->import_root
);
3057 client
->import_root
= NULL
;
3058 return send_error (ctx
, rc
);
3061 rc
= do_import (client
, client
->import_root
, result
);
3062 xfree (client
->import_root
);
3063 client
->import_root
= NULL
;
3064 return send_error (ctx
, rc
);
3068 do_lock (struct client_s
*client
, int add
)
3070 gpg_error_t rc
= lock_file_mutex (client
, add
);
3073 client
->flags
|= FLAG_LOCK_CMD
;
3079 lock_command (assuan_context_t ctx
, char *line
)
3081 struct client_s
*client
= assuan_get_pointer (ctx
);
3082 gpg_error_t rc
= do_lock (client
, 0);
3084 return send_error (ctx
, rc
);
3088 unlock_command (assuan_context_t ctx
, char *line
)
3090 struct client_s
*client
= assuan_get_pointer (ctx
);
3093 rc
= unlock_file_mutex (client
, 0);
3094 return send_error (ctx
, rc
);
3098 option_command (assuan_context_t ctx
, char *line
)
3100 struct client_s
*client
= assuan_get_pointer (ctx
);
3102 struct pinentry_option_s
*pin_opts
= &client
->pinentry_opts
;
3104 struct agent_s
*agent
= client
->crypto
->agent
;
3106 char namebuf
[255] = { 0 };
3107 char *name
= namebuf
;
3108 char *value
= NULL
, *p
;
3110 p
= strchr (line
, '=');
3112 strncpy (namebuf
, line
, sizeof(namebuf
));
3115 strncpy (namebuf
, line
, strlen (line
)-strlen (p
));
3119 log_write1 ("OPTION name='%s' value='%s'", name
, value
);
3121 if (strcasecmp (name
, (char *) "log_level") == 0)
3127 l
= strtol (value
, NULL
, 10);
3130 return send_error (ctx
, GPG_ERR_INV_VALUE
);
3133 MUTEX_LOCK (&rcfile_mutex
);
3134 config_set_int_param (&global_config
, "global", "log_level", value
);
3135 MUTEX_UNLOCK (&rcfile_mutex
);
3138 else if (strcasecmp (name
, (char *) "lock-timeout") == 0)
3145 n
= strtol (value
, &p
, 10);
3147 return send_error (ctx
, GPG_ERR_INV_VALUE
);
3150 client
->lock_timeout
= n
;
3153 else if (strcasecmp (name
, (char *) "NAME") == 0)
3155 char *tmp
= pthread_getspecific (thread_name_key
);
3160 if (!value
|| !*value
)
3162 pthread_setspecific (thread_name_key
, str_dup (""));
3166 pthread_setspecific (thread_name_key
, str_dup (value
));
3169 else if (strcasecmp (name
, (char *) "lc-messages") == 0)
3171 xfree (pin_opts
->lc_messages
);
3172 pin_opts
->lc_messages
= NULL
;
3173 if (value
&& *value
)
3174 pin_opts
->lc_messages
= str_dup (value
);
3177 rc
= set_agent_option (client
->crypto
->agent
, "lc-messages", value
);
3180 else if (strcasecmp (name
, (char *) "lc-ctype") == 0)
3182 xfree (pin_opts
->lc_ctype
);
3183 pin_opts
->lc_ctype
= NULL
;
3184 if (value
&& *value
)
3185 pin_opts
->lc_ctype
= str_dup (value
);
3188 rc
= set_agent_option (client
->crypto
->agent
, "lc-ctype", value
);
3191 else if (strcasecmp (name
, (char *) "ttyname") == 0)
3193 xfree (pin_opts
->ttyname
);
3194 pin_opts
->ttyname
= NULL
;
3195 if (value
&& *value
)
3196 pin_opts
->ttyname
= str_dup (value
);
3199 rc
= set_agent_option (client
->crypto
->agent
, "ttyname", value
);
3202 else if (strcasecmp (name
, (char *) "ttytype") == 0)
3204 xfree (pin_opts
->ttytype
);
3205 pin_opts
->ttytype
= NULL
;
3206 if (value
&& *value
)
3207 pin_opts
->ttytype
= str_dup (value
);
3210 rc
= set_agent_option (client
->crypto
->agent
, "ttytype", value
);
3213 else if (strcasecmp (name
, (char *) "display") == 0)
3215 xfree (pin_opts
->display
);
3216 pin_opts
->display
= NULL
;
3217 if (value
&& *value
)
3218 pin_opts
->display
= str_dup (value
);
3221 rc
= set_agent_option (client
->crypto
->agent
, "display", value
);
3224 else if (strcasecmp (name
, (char *) "pinentry-desc") == 0)
3226 xfree (pin_opts
->desc
);
3227 pin_opts
->desc
= NULL
;
3228 if (value
&& *value
)
3229 pin_opts
->desc
= str_dup (value
);
3231 else if (strcasecmp (name
, (char *) "pinentry-title") == 0)
3233 xfree (pin_opts
->title
);
3234 pin_opts
->title
= NULL
;
3235 if (value
&& *value
)
3236 pin_opts
->title
= str_dup (value
);
3238 else if (strcasecmp (name
, (char *) "pinentry-prompt") == 0)
3240 xfree (pin_opts
->prompt
);
3241 pin_opts
->prompt
= NULL
;
3242 if (value
&& *value
)
3243 pin_opts
->prompt
= str_dup (value
);
3246 else if (strcasecmp (name
, "pinentry-timeout") == 0)
3254 n
= (int) strtol (value
, &p
, 10);
3257 return send_error (ctx
, GPG_ERR_INV_VALUE
);
3259 pin_opts
->timeout
= n
;
3260 MUTEX_LOCK (&rcfile_mutex
);
3261 config_set_int_param (&global_config
,
3262 client
->filename
? client
->filename
: "global",
3263 "pinentry_timeout", value
);
3264 MUTEX_UNLOCK (&rcfile_mutex
);
3267 else if (strcasecmp (name
, "disable-pinentry") == 0)
3272 if (value
&& *value
)
3274 n
= (int) strtol (value
, &p
, 10);
3275 if (*p
|| n
< 0 || n
> 1)
3276 return send_error (ctx
, GPG_ERR_INV_VALUE
);
3280 client
->flags
|= FLAG_NO_PINENTRY
;
3282 client
->flags
&= ~FLAG_NO_PINENTRY
;
3287 if (client
->flags
& FLAG_NO_PINENTRY
)
3288 rc
= set_agent_option (client
->crypto
->agent
, "pinentry-mode",
3291 rc
= set_agent_option (client
->crypto
->agent
, "pinentry-mode",
3295 return send_error (ctx
, rc
);
3300 return send_error (ctx
, GPG_ERR_UNKNOWN_OPTION
);
3304 if (!rc
&& use_agent
&& agent
)
3306 rc
= pinentry_merge_options (&client
->crypto
->agent
->pinentry_opts
,
3311 return send_error (ctx
, rc
);
3315 do_rename (assuan_context_t ctx
, char *line
)
3317 struct client_s
*client
= assuan_get_pointer (ctx
);
3319 char **req
, **src
, *dst
;
3322 req
= str_split (line
, " ", 0);
3324 if (!req
|| !req
[0] || !req
[1])
3327 return GPG_ERR_SYNTAX
;
3331 is_literal_element (&dst
);
3333 if (!valid_xml_element ((xmlChar
*) dst
))
3336 return GPG_ERR_INV_VALUE
;
3339 if (strchr (req
[0], '\t'))
3340 src
= str_split (req
[0], "\t", 0);
3342 src
= str_split (req
[0], " ", 0);
3346 rc
= GPG_ERR_SYNTAX
;
3350 n
= find_root_element (client
, client
->doc
, &src
, &rc
, NULL
, 0, 0);
3352 n
= find_elements (client
, client
->doc
, n
->children
, src
+ 1, &rc
, NULL
, NULL
,
3353 NULL
, 0, 0, NULL
, 0);
3358 xmlChar
*a
= xmlGetProp (n
, (xmlChar
*) "_name");
3361 rc
= GPG_ERR_ENOMEM
;
3365 /* To prevent unwanted effects:
3367 * <root name="a"><b/></root>
3371 if (xmlStrEqual (a
, (xmlChar
*) dst
))
3374 rc
= GPG_ERR_AMBIGUOUS_NAME
;
3384 for (p
= src
; *p
; p
++)
3388 strv_printf (&tmp
, "%s", *p
);
3392 strv_printf (&tmp
, "!%s", dst
);
3393 ndst
= find_root_element (client
, client
->doc
, &tmp
, &rc
, NULL
, 0, 0);
3394 if (!ndst
&& rc
&& rc
!= GPG_ERR_ELEMENT_NOT_FOUND
)
3401 ndst
= find_elements (client
, client
->doc
, ndst
->children
, tmp
+ 1, &rc
, NULL
,
3402 NULL
, NULL
, 0, 0, NULL
, 0);
3405 if (!ndst
&& rc
&& rc
!= GPG_ERR_ELEMENT_NOT_FOUND
)
3410 /* Target may exist:
3413 * <root name="b" target="a"/>
3422 rc
= GPG_ERR_AMBIGUOUS_NAME
;
3429 xmlFreeNodeList (ndst
);
3432 rc
= add_attribute (n
, "_name", dst
);
3441 rename_command (assuan_context_t ctx
, char *line
)
3443 struct client_s
*client
= assuan_get_pointer (ctx
);
3445 struct argv_s
*args
[] = {
3446 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
3450 rc
= parse_options (&line
, args
, client
);
3452 return send_error (ctx
, rc
);
3454 if (client
->opts
& OPT_INQUIRE
)
3456 unsigned char *result
;
3459 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
3461 return send_error (ctx
, rc
);
3463 line
= (char *) result
;
3466 rc
= do_rename (ctx
, line
);
3468 if (client
->opts
& OPT_INQUIRE
)
3471 return send_error (ctx
, rc
);
3475 do_copy (assuan_context_t ctx
, char *line
)
3477 struct client_s
*client
= assuan_get_pointer (ctx
);
3479 char **req
, **src
= NULL
, **dst
= NULL
;
3480 xmlNodePtr nsrc
, ndst
, new = NULL
;
3482 req
= str_split (line
, " ", 0);
3483 if (!req
|| !req
[0] || !req
[1])
3486 return GPG_ERR_SYNTAX
;
3489 if (strchr (req
[0], '\t'))
3490 src
= str_split (req
[0], "\t", 0);
3492 src
= str_split (req
[0], " ", 0);
3496 rc
= GPG_ERR_SYNTAX
;
3500 if (strchr (req
[1], '\t'))
3501 dst
= str_split (req
[1], "\t", 0);
3503 dst
= str_split (req
[1], " ", 0);
3507 rc
= GPG_ERR_SYNTAX
;
3511 if (!valid_element_path (dst
, 0))
3513 rc
= GPG_ERR_INV_VALUE
;
3517 nsrc
= find_root_element (client
, client
->doc
, &src
, &rc
, NULL
, 0, 0);
3519 nsrc
= find_elements (client
, client
->doc
, nsrc
->children
, src
+ 1, &rc
, NULL
,
3520 NULL
, NULL
, 0, 0, NULL
, 0);
3525 new = xmlCopyNodeList (nsrc
);
3528 rc
= GPG_ERR_ENOMEM
;
3533 ndst
= find_root_element (client
, client
->doc
, &dst
, &rc
, NULL
, 0, 0);
3537 ndst
= find_elements (client
, client
->doc
, ndst
->children
, dst
+ 1, &rc
, NULL
,
3538 NULL
, create_target_elements_cb
, 0, 0, NULL
, 0);
3545 if (!ndst
&& rc
!= GPG_ERR_ELEMENT_NOT_FOUND
)
3547 else if (!ndst
|| create
)
3549 ndst
= create_element_path (client
, &dst
, &rc
, NULL
);
3554 /* Merge any attributes from the src node to the initial dst node. */
3555 for (xmlAttrPtr attr
= new->properties
; attr
; attr
= attr
->next
)
3557 if (xmlStrEqual (attr
->name
, (xmlChar
*) "_name"))
3560 xmlAttrPtr a
= xmlHasProp (ndst
, attr
->name
);
3564 xmlChar
*tmp
= xmlNodeGetContent (attr
->children
);
3565 xmlNewProp (ndst
, attr
->name
, tmp
);
3567 rc
= add_attribute (ndst
, NULL
, NULL
);
3570 xmlNodePtr n
= ndst
->children
;
3572 xmlFreeNodeList (n
);
3573 ndst
->children
= NULL
;
3577 n
= xmlCopyNodeList (new->children
);
3580 rc
= GPG_ERR_ENOMEM
;
3584 n
= xmlAddChildList (ndst
, n
);
3587 rc
= GPG_ERR_ENOMEM
;
3591 rc
= update_element_mtime (xmlDocGetRootElement (client
->doc
) ==
3592 ndst
->parent
? ndst
: ndst
->parent
);
3598 xmlUnlinkNode (new);
3599 xmlFreeNodeList (new);
3615 copy_command (assuan_context_t ctx
, char *line
)
3617 struct client_s
*client
= assuan_get_pointer (ctx
);
3619 struct argv_s
*args
[] = {
3620 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
3624 rc
= parse_options (&line
, args
, client
);
3626 return send_error (ctx
, rc
);
3628 if (client
->opts
& OPT_INQUIRE
)
3630 unsigned char *result
;
3633 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
3635 return send_error (ctx
, rc
);
3637 line
= (char *) result
;
3640 rc
= do_copy (ctx
, line
);
3642 if (client
->opts
& OPT_INQUIRE
)
3645 return send_error (ctx
, rc
);
3649 do_move (assuan_context_t ctx
, char *line
)
3651 struct client_s
*client
= assuan_get_pointer (ctx
);
3653 char **req
, **src
= NULL
, **dst
= NULL
;
3654 xmlNodePtr nsrc
, ndst
= NULL
;
3656 req
= str_split (line
, " ", 0);
3658 if (!req
|| !req
[0] || !req
[1])
3661 return GPG_ERR_SYNTAX
;
3664 if (strchr (req
[0], '\t'))
3665 src
= str_split (req
[0], "\t", 0);
3667 src
= str_split (req
[0], " ", 0);
3671 rc
= GPG_ERR_SYNTAX
;
3675 if (strchr (req
[1], '\t'))
3676 dst
= str_split (req
[1], "\t", 0);
3678 dst
= str_split (req
[1], " ", 0);
3680 nsrc
= find_root_element (client
, client
->doc
, &src
, &rc
, NULL
, 0, 0);
3682 nsrc
= find_elements (client
, client
->doc
, nsrc
->children
, src
+ 1, &rc
, NULL
,
3683 NULL
, NULL
, 0, 0, NULL
, 0);
3690 if (!valid_element_path (dst
, 0))
3692 rc
= GPG_ERR_INV_VALUE
;
3696 ndst
= find_root_element (client
, client
->doc
, &dst
, &rc
, NULL
, 0, 0);
3698 ndst
= find_elements (client
, client
->doc
, ndst
->children
, dst
+ 1, &rc
, NULL
,
3699 NULL
, NULL
, 0, 0, NULL
, 0);
3702 ndst
= xmlDocGetRootElement (client
->doc
);
3704 for (xmlNodePtr n
= ndst
; n
; n
= n
->parent
)
3708 rc
= GPG_ERR_CONFLICT
;
3713 if (rc
&& rc
!= GPG_ERR_ELEMENT_NOT_FOUND
)
3720 xmlChar
*a
= node_has_attribute (nsrc
, (xmlChar
*) "_name");
3722 xmlNodePtr dup
= find_element (client
, ndst
->children
, (char *) a
,
3734 if (ndst
== xmlDocGetRootElement (client
->doc
))
3736 xmlNodePtr n
= nsrc
;
3739 while (n
->parent
&& n
->parent
!= ndst
)
3742 xmlChar
*a
= node_has_attribute (n
, (xmlChar
*) "_name");
3743 xmlChar
*b
= node_has_attribute (nsrc
, (xmlChar
*) "_name");
3745 if (xmlStrEqual (a
, b
))
3748 xmlUnlinkNode (nsrc
);
3750 xmlFreeNodeList (n
);
3758 xmlUnlinkNode (dup
);
3759 xmlFreeNodeList (dup
);
3763 xmlUnlinkNode (dup
);
3769 xmlChar
*name
= node_has_attribute (nsrc
, (xmlChar
*) "_name");
3771 if (nsrc
->parent
== xmlDocGetRootElement (client
->doc
)
3772 && !strcmp ((char *) name
, *dst
))
3775 rc
= GPG_ERR_CONFLICT
;
3780 ndst
= create_element_path (client
, &dst
, &rc
, nsrc
);
3786 update_element_mtime (nsrc
->parent
);
3787 xmlUnlinkNode (nsrc
);
3788 ndst
= xmlAddChildList (ndst
, nsrc
);
3791 rc
= GPG_ERR_ENOMEM
;
3793 update_element_mtime (ndst
->parent
);
3809 move_command (assuan_context_t ctx
, char *line
)
3811 struct client_s
*client
= assuan_get_pointer (ctx
);
3813 struct argv_s
*args
[] = {
3814 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
3818 rc
= parse_options (&line
, args
, client
);
3820 return send_error (ctx
, rc
);
3822 if (client
->opts
& OPT_INQUIRE
)
3824 unsigned char *result
;
3827 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
3829 return send_error (ctx
, rc
);
3831 line
= (char *) result
;
3834 rc
= do_move (ctx
, line
);
3836 if (client
->opts
& OPT_INQUIRE
)
3839 return send_error (ctx
, rc
);
3843 ls_command (assuan_context_t ctx
, char *line
)
3846 char *tmp
= str_asprintf ("%s/data", homedir
);
3847 char *dir
= expand_homedir (tmp
);
3848 DIR *d
= opendir (dir
);
3850 rc
= gpg_error_from_errno (errno
);
3856 return send_error (ctx
, rc
);
3860 offsetof (struct dirent
, d_name
) +pathconf (dir
, _PC_NAME_MAX
) + 1;
3861 struct dirent
*p
= xmalloc (len
), *cur
= NULL
;
3867 while (!readdir_r (d
, p
, &cur
) && cur
)
3869 if (cur
->d_name
[0] == '.' && cur
->d_name
[1] == '\0')
3871 else if (cur
->d_name
[0] == '.' && cur
->d_name
[1] == '.'
3872 && cur
->d_name
[2] == '\0')
3875 tmp
= str_asprintf ("%s%s\n", list
? list
: "", cur
->d_name
);
3882 rc
= GPG_ERR_ENOMEM
;
3894 return send_error (ctx
, rc
);
3897 return send_error (ctx
, GPG_ERR_NO_DATA
);
3899 list
[strlen (list
) - 1] = 0;
3900 rc
= xfer_data (ctx
, list
, strlen (list
));
3902 return send_error (ctx
, rc
);
3906 bye_notify (assuan_context_t ctx
, char *line
)
3908 struct client_s
*cl
= assuan_get_pointer (ctx
);
3911 if (cl
->thd
->remote
)
3917 struct timeval tv
= { 0, 50000 };
3919 rc
= gnutls_bye (cl
->thd
->tls
->ses
, GNUTLS_SHUT_RDWR
);
3920 if (rc
== GNUTLS_E_AGAIN
)
3921 select (0, NULL
, NULL
, NULL
, &tv
);
3923 while (rc
== GNUTLS_E_AGAIN
);
3927 /* This will let assuan_process_next() return. */
3928 fcntl (cl
->thd
->fd
, F_SETFL
, O_NONBLOCK
);
3929 cl
->last_rc
= 0; // BYE command result
3934 reset_notify (assuan_context_t ctx
, char *line
)
3936 struct client_s
*client
= assuan_get_pointer (ctx
);
3939 cleanup_client (client
);
3945 * This is called before every Assuan command.
3948 command_startup (assuan_context_t ctx
, const char *name
)
3950 struct client_s
*client
= assuan_get_pointer (ctx
);
3952 struct command_table_s
*cmd
= NULL
;
3954 log_write1 ("command='%s'", name
);
3955 client
->last_rc
= client
->opts
= 0;
3957 for (int i
= 0; command_table
[i
]; i
++)
3959 if (!strcasecmp (name
, command_table
[i
]->name
))
3961 if (command_table
[i
]->ignore_startup
)
3963 cmd
= command_table
[i
];
3968 client
->last_rc
= rc
= gpg_error (file_modified (client
, cmd
));
3973 * This is called after every Assuan command.
3976 command_finalize (assuan_context_t ctx
, gpg_error_t rc
)
3978 struct client_s
*client
= assuan_get_pointer (ctx
);
3980 if (!(client
->flags
& FLAG_LOCK_CMD
))
3981 unlock_file_mutex (client
, 0);
3983 log_write1 (_("command completed: rc=%u"), client
->last_rc
);
3984 client
->last_rc
= gpg_error (GPG_ERR_UNKNOWN_COMMAND
);
3986 client
->thd
->buffer_timeout
= client
->thd
->last_buffer_size
= 0;
3991 help_command (assuan_context_t ctx
, char *line
)
3996 if (!line
|| !*line
)
3999 char *help
= str_dup (_("Usage: HELP [<COMMAND>]\n"
4000 "For commands that take an element path as an argument, each element is "
4001 "separated with an ASCII @key{TAB} character (ASCII 0x09)."
4004 for (i
= 0; command_table
[i
]; i
++)
4006 if (!command_table
[i
]->help
)
4009 tmp
= str_asprintf ("%s %s", help
, command_table
[i
]->name
);
4014 tmp
= strip_texi_and_wrap (help
);
4016 rc
= xfer_data (ctx
, tmp
, strlen (tmp
));
4018 return send_error (ctx
, rc
);
4021 for (i
= 0; command_table
[i
]; i
++)
4023 if (!strcasecmp (line
, command_table
[i
]->name
))
4027 if (!command_table
[i
]->help
)
4030 help
= strip_texi_and_wrap (command_table
[i
]->help
);
4031 tmp
= str_asprintf (_("Usage: %s"), help
);
4033 rc
= xfer_data (ctx
, tmp
, strlen (tmp
));
4035 return send_error (ctx
, rc
);
4039 return send_error (ctx
, GPG_ERR_INV_NAME
);
4043 new_command (const char *name
, int ignore
, int unlock
,
4044 gpg_error_t (*handler
) (assuan_context_t
, char *),
4050 for (i
= 0; command_table
[i
]; i
++);
4053 xrealloc (command_table
, (i
+ 2) * sizeof (struct command_table_s
*));
4054 command_table
[i
] = xcalloc (1, sizeof (struct command_table_s
));
4055 command_table
[i
]->name
= name
;
4056 command_table
[i
]->handler
= handler
;
4057 command_table
[i
]->ignore_startup
= ignore
;
4058 command_table
[i
]->unlock
= unlock
;
4059 command_table
[i
++]->help
= help
;
4060 command_table
[i
] = NULL
;
4068 for (i
= 0; command_table
[i
]; i
++)
4069 xfree (command_table
[i
]);
4071 xfree (command_table
);
4075 sort_commands (const void *arg1
, const void *arg2
)
4077 struct command_table_s
*const *a
= arg1
;
4078 struct command_table_s
*const *b
= arg2
;
4087 return strcmp ((*a
)->name
, (*b
)->name
);
4091 passwd_command (assuan_context_t ctx
, char *line
)
4093 struct client_s
*client
= assuan_get_pointer (ctx
);
4095 struct argv_s
*args
[] = {
4096 &(struct argv_s
) {"reset", OPTION_TYPE_NOARG
, parse_opt_reset
},
4097 &(struct argv_s
) {"s2k-count", OPTION_TYPE_ARG
, parse_opt_s2k_count
},
4098 &(struct argv_s
) {"no-passphrase", OPTION_TYPE_NOARG
, parse_opt_no_passphrase
},
4102 if (client
->flags
& FLAG_NEW
)
4103 return send_error (ctx
, GPG_ERR_INV_STATE
);
4105 client
->crypto
->save
.s2k_count
=
4106 config_get_ulong (client
->filename
, "s2k_count");
4107 rc
= parse_options (&line
, args
, client
);
4109 return send_error (ctx
, rc
);
4111 if (!rc
&& client
->opts
& OPT_RESET
)
4113 rc
= cache_clear (client
->md5file
);
4115 send_status_all (STATUS_CACHE
, NULL
);
4120 if (!IS_PKI (client
->crypto
))
4122 struct crypto_s
*crypto
;
4124 xfree (client
->crypto
->filename
);
4125 client
->crypto
->filename
= str_dup (client
->filename
);
4126 rc
= change_passwd (ctx
, client
->filename
,
4127 client
->flags
& FLAG_NO_PINENTRY
, &crypto
,
4128 (client
->opts
& OPT_NO_PASSPHRASE
));
4131 cleanup_crypto (&client
->crypto
);
4132 client
->crypto
= crypto
;
4133 update_checksum (client
);
4134 cleanup_crypto_stage1 (client
->crypto
);
4140 if (client
->crypto
->save
.s2k_count
)
4141 rc
= send_to_agent (client
->crypto
->agent
, NULL
, NULL
,
4142 "OPTION s2k-count=%lu",
4143 client
->crypto
->save
.s2k_count
);
4146 rc
= agent_passwd (client
->crypto
);
4151 return send_error (ctx
, rc
);
4155 parse_keygrip_opt_sign (void *data
, void *value
)
4157 struct client_s
*client
= data
;
4160 client
->opts
|= OPT_SIGN
;
4165 keygrip_command (assuan_context_t ctx
, char *line
)
4167 struct client_s
*client
= assuan_get_pointer (ctx
);
4169 struct crypto_s
*crypto
= NULL
;
4170 struct argv_s
*args
[] = {
4171 &(struct argv_s
) {"sign", OPTION_TYPE_NOARG
, parse_keygrip_opt_sign
},
4175 if (!line
|| !*line
)
4176 return send_error (ctx
, GPG_ERR_SYNTAX
);
4178 rc
= parse_options (&line
, args
, client
);
4180 return send_error (ctx
, rc
);
4182 if (!valid_filename (line
))
4183 return send_error (ctx
, GPG_ERR_INV_VALUE
);
4185 rc
= init_client_crypto (&crypto
);
4187 return send_error (ctx
, rc
);
4189 rc
= read_data_file (line
, crypto
);
4192 char *hexgrip
= NULL
;
4194 if (!IS_PKI (crypto
))
4196 cleanup_crypto (&crypto
);
4197 return send_error (ctx
, GPG_ERR_NOT_SUPPORTED
);
4200 if (client
->opts
& OPT_SIGN
)
4202 if (valid_keygrip (crypto
->sign_grip
, sizeof (crypto
->sign_grip
)))
4203 hexgrip
= bin2hex (crypto
->sign_grip
, sizeof (crypto
->sign_grip
));
4207 hexgrip
= bin2hex (crypto
->grip
, sizeof (crypto
->grip
));
4210 rc
= GPG_ERR_ENOMEM
;
4212 rc
= xfer_data (ctx
, hexgrip
, strlen (hexgrip
));
4217 UPDATE_AGENT_CTX (client
, crypto
);
4218 cleanup_crypto (&crypto
);
4219 return send_error (ctx
, rc
);
4223 parse_opt_data (void *data
, void *value
)
4225 struct client_s
*client
= data
;
4228 client
->opts
|= OPT_DATA
;
4233 getinfo_command (assuan_context_t ctx
, char *line
)
4235 struct client_s
*client
= assuan_get_pointer (ctx
);
4237 char buf
[ASSUAN_LINELENGTH
];
4238 struct argv_s
*args
[] = {
4239 &(struct argv_s
) {"data", OPTION_TYPE_NOARG
, parse_opt_data
},
4243 rc
= parse_options (&line
, args
, client
);
4245 return send_error (ctx
, rc
);
4247 if (!strcasecmp (line
, "clients"))
4249 if (client
->opts
& OPT_DATA
)
4251 MUTEX_LOCK (&cn_mutex
);
4252 snprintf (buf
, sizeof (buf
), "%i", slist_length (cn_thread_list
));
4253 MUTEX_UNLOCK (&cn_mutex
);
4254 rc
= xfer_data (ctx
, buf
, strlen (buf
));
4257 rc
= send_status (ctx
, STATUS_CLIENTS
, NULL
);
4259 else if (!strcasecmp (line
, "cache"))
4261 if (client
->opts
& OPT_DATA
)
4263 snprintf (buf
, sizeof (buf
), "%u", cache_file_count ());
4264 rc
= xfer_data (ctx
, buf
, strlen (buf
));
4267 rc
= send_status (ctx
, STATUS_CACHE
, NULL
);
4269 else if (!strcasecmp (line
, "pid"))
4272 pid_t pid
= getpid ();
4274 snprintf (buf
, sizeof (buf
), "%i", pid
);
4275 rc
= xfer_data (ctx
, buf
, strlen (buf
));
4277 else if (!strcasecmp (line
, "version"))
4279 char *buf
= str_asprintf ("0x%06x %s%s", VERSION_HEX
,
4289 "", use_agent
? "AGENT" : "");
4290 rc
= xfer_data (ctx
, buf
, strlen (buf
));
4293 else if (!strcasecmp (line
, "last_error"))
4295 if (client
->last_error
)
4296 rc
= xfer_data (ctx
, client
->last_error
, strlen (client
->last_error
));
4298 rc
= GPG_ERR_NO_DATA
;
4301 rc
= gpg_error (GPG_ERR_SYNTAX
);
4303 return send_error (ctx
, rc
);
4308 send_data_cb (void *user
, const void *buf
, size_t len
)
4310 assuan_context_t ctx
= user
;
4312 return assuan_send_data (ctx
, buf
, len
);
4316 send_status_cb (void *user
, const char *line
)
4318 assuan_context_t ctx
= user
;
4319 char keyword
[200], *k
;
4322 for (p
= line
, k
= keyword
; *p
; p
++)
4334 while (isspace (*p
))
4337 return assuan_write_status (ctx
, keyword
, *p
? p
: NULL
);
4342 agent_command (assuan_context_t ctx
, char *line
)
4347 return send_error (ctx
, GPG_ERR_NOT_IMPLEMENTED
);
4350 struct client_s
*client
= assuan_get_pointer (ctx
);
4352 if (!line
|| !*line
)
4353 return send_error (ctx
, GPG_ERR_SYNTAX
);
4355 assuan_set_flag (client
->crypto
->agent
->ctx
, ASSUAN_CONVEY_COMMENTS
, 1);
4356 rc
= assuan_transact (client
->crypto
->agent
->ctx
, line
, send_data_cb
,
4357 client
->ctx
, agent_loopback_cb
, client
->crypto
,
4358 send_status_cb
, client
->ctx
);
4359 if (gpg_err_code (rc
) == GPG_ERR_ASS_CANCELED
)
4364 rc
= assuan_write_line (client
->crypto
->agent
->ctx
, "CAN");
4367 rc
= assuan_read_line (client
->crypto
->agent
->ctx
, &line
, &len
);
4369 rc
= gpg_error (GPG_ERR_ASS_CANCELED
);
4373 assuan_set_flag (client
->crypto
->agent
->ctx
, ASSUAN_CONVEY_COMMENTS
, 0);
4375 return send_error (ctx
, rc
);
4381 /* !BEGIN-HELP-TEXT!
4383 * This comment is used as a marker to generate the offline documentation
4384 * found in doc/pwmd.info. The indentation needs to be kept for the awk
4385 * script to determine where commands begin and end.
4387 new_command("HELP", 1, 1, help_command
, _(
4388 "HELP [<COMMAND>]\n"
4389 "Show available commands or command specific help text."
4392 new_command("AGENT", 1, 1, agent_command
, _(
4394 "Send a @command{gpg-agent} protocol @var{command} directly to the "
4395 "@command{gpg-agent}."
4398 new_command("GETINFO", 1, 1, getinfo_command
, _(
4399 "GETINFO [--data] CACHE | CLIENTS | PID | LAST_ERROR | VERSION\n"
4400 "Get server and other information: @var{cache} returns the number of cached "
4401 "documents via a status message. @var{clients} returns the number of "
4402 "connected clients via a status message. @var{pid} returns the process ID "
4403 "number of the server via a data response. @var{VERSION} returns the server "
4404 "version number and compile-time features with a data response with each "
4405 "being space delimited. @var{LAST_ERROR} returns a detailed description of "
4406 "the last failed command when available. @xref{Status Messages}. "
4408 "When the @option{--data} option is specified then the result will be sent "
4409 "via a data response rather than a status message."
4412 new_command("PASSWD", 0, 0, passwd_command
, _(
4413 "PASSWD [--reset] [--s2k-count=N] [--no-passphrase]\n"
4414 "Changes the passphrase of the secret key required to open the current "
4415 "file or the passphrase of a symmetrically encrypted data file. When the "
4416 "@option{--reset} option is passed then the cache entry for the current "
4417 "file will be reset and the passphrase, if any, will be required during the "
4418 "next @code{OPEN} (@pxref{OPEN})."
4420 "The @option{--s2k-count} option sets or changes (@pxref{SAVE}) the number "
4421 "of hash iterations for a passphrase and must be either @code{0} to use "
4422 "the calibrated count of the machine (the default), or a value greater than "
4423 "or equal to @code{65536}. This option has no effect for symmetrically "
4424 "encrypted data files."
4426 "The @option{--no-passphrase} option will prevent requiring a passphrase for "
4427 "the data file, although a passphrase may be required when changing it."
4430 new_command("KEYGRIP", 1, 1, keygrip_command
, _(
4431 "KEYGRIP [--sign] <filename>\n"
4432 "Returns the hex encoded keygrip of the specified @var{filename} with a "
4435 "When the @option{--sign} option is specified then the key used for signing "
4436 "of the specified @var{filename} will be returned."
4438 "For symmetrically encrypted data files this command returns the error "
4439 "GPG_ERR_NOT_SUPPORTED."
4442 new_command("OPEN", 1, 1, open_command
, _(
4443 "OPEN [--lock] <filename> [<passphrase>]\n"
4444 "Opens @var{filename} using @var{passphrase}. When the filename is not "
4445 "found on the file-system then a new document will be created. If the file "
4446 "is found, it is looked for in the file cache. If cached and no "
4447 "@var{passphrase} was specified then the cached document is opened. When not "
4448 "cached, @cite{pinentry(1)} will be used to retrieve the passphrase to use "
4449 "for decryption unless @option{disable-pinentry} (@pxref{OPTION}) was "
4452 "When the @option{--lock} option is passed then the file mutex will be "
4453 "locked as if the @code{LOCK} command (@pxref{LOCK}) had been sent after the "
4454 "file has been opened."
4457 new_command("SAVE", 0, 0, save_command
, _(
4458 "SAVE [--no-passphrase] [--reset] [--no-agent] [--s2k-count=N] [--cipher=<algo>] [--cipher-iterations=N] [--inquire-keyparam] [--keygrip=hexstring] [--sign-keygrip=hexstring]\n"
4459 "Writes the @abbr{XML} document to disk. The file written to is the file that "
4460 "was opened using the @code{OPEN} command (@pxref{OPEN}). If the file is a "
4461 "new one or the option @option{--inquire-keyparam} was passed, then a new "
4462 "keypair will be generated and a pinentry will be used to prompt for the "
4463 "passphrase to encrypt with unless the @option{--no-passphrase} option was "
4464 "passed in which case the data file will not be passphrase protected. "
4466 "The @option{--no-agent} option disables use of @command{gpg-agent} for "
4467 "passphrase retrieval and caching of new files when @command{gpg-agent} "
4468 "use is enabled. The datafile will be symmetrically encrypted and will not "
4469 "use or generate any keypair."
4471 "The @option{--reset} option will clear the cache entry for the current file "
4472 "and require a passphrase, if needed, before saving."
4474 "The @option{--cipher} option can be used to encrypt the @abbr{XML} data to "
4475 "an alternate cipher. The default is @code{aes256}. See the Configuration "
4476 "(@pxref{Configuration}) for available ciphers."
4478 "The @option{--cipher-iterations} option specifies the number of times to "
4479 "encrypt the XML data. The default is 0 although 1 iteration is still done."
4481 "The @option{--inquire-keyparam} option will send a server @emph{INQUIRE} to "
4482 "the client to obtain the key paramaters to use when generating a new "
4483 "keypair. The inquired data is expected to be an S-expression. If not "
4484 "specified then an @samp{RSA} key of @samp{2048} bits will be generated "
4485 "unless otherwise set in the configuration file (@pxref{Configuration}). Note "
4486 "that when this option is specified a new keypair will be generated "
4487 "reguardless if the file is a new one and that if the data file is protected "
4488 "the passphrase to open it will be required before generating the new keypair."
4490 "You can encrypt the data file to a public key other than the one that it "
4491 "was originally encrypted with by passing the @option{--keygrip} option with "
4492 "the hex encoded keygrip of the public key as its argument. The keygrip may "
4493 "be of any key that @command{gpg-agent} knows about. The "
4494 "@option{--sign-keygrip} option may also be used to sign with an alternate "
4495 "secret key. Use the @code{KEYGRIP} (@pxref{KEYGRIP}) command to obtain the "
4496 "keygrip of an existing data file. This option may be needed when using a "
4497 "smartcard. This option has no effect with symmetrically encrypted data files."
4499 "The @option{--s2k-count} option sets number of hash iterations for a "
4500 "passphrase. A value less-than @code{65536} will use the machine calibrated "
4501 "value and is the default. This setting only affects new files. To change "
4502 "the setting use the @code{PASSWD} command (@pxref{PASSWD}). This option "
4503 "has no effect with symmetrically encrypted data files."
4506 new_command("ISCACHED", 1, 0, iscached_command
, _(
4507 "ISCACHED [--lock] <filename>\n"
4508 "An @emph{OK} response is returned if the specified @var{filename} is found "
4509 "in the file cache. If not found in the cache but exists on the filesystem "
4510 "then @var{GPG_ERR_NO_DATA} is returned. Otherwise a filesystem error is "
4513 "The @option{lock} option will lock the file mutex of @var{filename} when the "
4514 "file exists; it does not need to be opened nor cached. The lock will be "
4515 "released when the client exits or sends the @code{UNLOCK} (@pxref{UNLOCK}) "
4519 new_command("CLEARCACHE", 1, 1, clearcache_command
, _(
4520 "CLEARCACHE [<filename>]\n"
4521 "Clears a file cache entry for all or the specified @var{filename}."
4524 new_command("CACHETIMEOUT", 1, 1, cachetimeout_command
, _(
4525 "CACHETIMEOUT <filename> <seconds>\n"
4526 "The time in @var{seconds} until @var{filename} will be removed from the "
4527 "cache. @code{-1} will keep the cache entry forever, @code{0} will require "
4528 "the passphrase for each @code{OPEN} or @code{SAVE} command (@pxref{OPEN}, "
4529 "@pxref{SAVE}). @xref{Configuration}, and the @code{cache_timeout} "
4533 new_command("LIST", 0, 1, list_command
, _(
4534 "LIST [--inquire] [--no-recurse] [--verbose] [--with-target] [--all] [[!]element[<TAB>[!]child[..]]]\n"
4535 "If no element path is given then a newline separated list of root elements "
4536 "is returned with a data response. If given, then all reachable elements "
4537 "of the specified element path are returned unless the @option{--no-recurse} "
4538 "option is specified. If specified, only the child elements of the element "
4539 "path are returned without recursing into grandchildren. Each resulting "
4540 "element is prefixed with the literal @code{!} character when the element "
4541 "contains no @code{target} attribute. @xref{Target Attribute}, for details."
4543 "When the @option{--verbose} option is passed then each element path "
4544 "returned will have zero or more flags appened to it. These flags are "
4545 "delimited from the element path by a single space character. A flag itself "
4546 "is a single character. Flag @code{+} indicates that there are child nodes of "
4547 "the current element path. Flag @code{E} indicates that an element of an "
4548 "element path contained in a @var{target} attribute could not be found. Flag "
4549 "@code{O} indicates that a @var{target} attribute recursion limit was reached "
4550 "(@pxref{Configuration}). Flag @code{T} will append the resolved element path "
4551 "of the @var{target} attribute contained in the current element (see below)."
4553 "The @option{--with-target} option implies @option{--verbose} and will append "
4554 "an additional flag @code{T} followed by a single space then an element path. "
4555 "The appended element path is the resolved path (@pxref{REALPATH}) of the "
4556 "current element when it contains a @var{target} attribute. When no "
4557 "@var{target} attribute is found then no flag will be appended."
4559 "The @option{--no-recurse} option limits the amount of data returned to only "
4560 "the listing of children of the specified element path and not any "
4563 "The @option{--all} option lists the entire element tree for each root "
4564 "element. This option also implies option @option{--verbose}."
4566 "When the @option{--inquire} option is passed then all remaining non-option "
4567 "arguments are retrieved via a server @emph{INQUIRE}."
4570 new_command("REALPATH", 0, 1, realpath_command
, _(
4571 "REALPATH [--inquire] [!]element[<TAB>[!]child[..]]\n"
4572 "Resolves all @code{target} attributes of the specified element path and "
4573 "returns the result with a data response. @xref{Target Attribute}, for details."
4575 "When the @option{--inquire} option is passed then all remaining non-option "
4576 "arguments are retrieved via a server @emph{INQUIRE}."
4579 new_command("STORE", 0, 1, store_command
, _(
4580 "STORE [!]element[<TAB>[!]child[..]]<TAB>[content]\n"
4581 "This command uses a server @emph{INQUIRE} to retrieve data from the client."
4583 "Creates a new element path or modifies the @var{content} of an existing "
4584 "element. If only a single element is specified then a new root element is "
4585 "created. Otherwise, elements are @key{TAB} delimited and the content will be "
4586 "set to the final @key{TAB} delimited element. If no @var{content} is "
4587 "specified after the final @key{TAB}, then the content of an existing "
4588 "element will be removed; or empty when creating a new element."
4590 "The only restriction of an element name is that it not contain whitespace "
4591 "or begin with the literal element character @code{!} unless specifying a "
4592 "literal element (@pxref{Target Attribute}). There is no whitespace between "
4593 "the @key{TAB} delimited elements. It is recommended that the content of an "
4594 "element be base64 encoded when it contains control or @key{TAB} characters "
4595 "to prevent @abbr{XML} parsing and @command{pwmd} syntax errors."
4598 new_command("RENAME", 0, 1, rename_command
, _(
4599 "RENAME [--inquire] [!]element[<TAB>[!]child[..]] <value>\n"
4600 "Renames the specified @var{element} to the new @var{value}. If an element of "
4601 "the same name as the @var{value} already exists it will be overwritten."
4603 "When the @option{--inquire} option is passed then all remaining non-option "
4604 "arguments are retrieved via a server @emph{INQUIRE}."
4607 new_command("COPY", 0, 1, copy_command
, _(
4608 "COPY [--inquire] [!]source[<TAB>[!]child[..]] [!]dest[<TAB>[!]child[..]]\n"
4609 "Copies the entire element tree starting from the child node of the source "
4610 "element, to the destination element path. If the destination element path "
4611 "does not exist then it will be created; otherwise it is overwritten."
4613 "Note that attributes from the source element are merged into the "
4614 "destination element when the destination element path exists. When an "
4615 "attribute of the same name exists in both the source and destination "
4616 "elements then the destination attribute will be updated to the source "
4619 "When the @option{--inquire} option is passed then all remaining non-option "
4620 "arguments are retrieved via a server @emph{INQUIRE}."
4623 new_command("MOVE", 0, 1, move_command
, _(
4624 "MOVE [--inquire] [!]source[<TAB>[!]child[..]] [[!]dest[<TAB>[!]child[..]]]\n"
4625 "Moves the source element path to the destination element path. If the "
4626 "destination is not specified then it will be moved to the root node of the "
4627 "document. If the destination is specified and exists then it will be "
4628 "overwritten; otherwise non-existing elements of the destination element "
4629 "path will be created."
4631 "When the @option{--inquire} option is passed then all remaining non-option "
4632 "arguments are retrieved via a server @emph{INQUIRE}."
4635 new_command("DELETE", 0, 1, delete_command
, _(
4636 "DELETE [--inquire] [!]element[<TAB>[!]child[..]]\n"
4637 "Removes the specified element path and all of its children. This may break "
4638 "an element with a @code{target} attribute (@pxref{Target Attribute}) that "
4639 "refers to this element or any of its children."
4641 "When the @option{--inquire} option is passed then all remaining non-option "
4642 "arguments are retrieved via a server @emph{INQUIRE}."
4645 new_command("GET", 0, 1, get_command
, _(
4646 "GET [--inquire] [!]element[<TAB>[!]child[..]]\n"
4647 "Retrieves the content of the specified element. The content is returned "
4648 "with a data response."
4650 "When the @option{--inquire} option is passed then all remaining non-option "
4651 "arguments are retrieved via a server @emph{INQUIRE}."
4654 new_command("ATTR", 0, 1, attr_command
, _(
4655 "ATTR [--inquire] SET|GET|DELETE|LIST [<attribute>] [!]element[<TAB>[!]child[..]] ..\n"
4657 "@item ATTR SET attribute [!]element[<TAB>[!]child[..]] [value]\n"
4659 " Stores or updates an @var{attribute} name and optional @var{value} of an "
4660 "element. When no @var{value} is specified any existing value will be removed."
4662 "@item ATTR DELETE attribute [!]element[<TAB>[!]child[..]]\n"
4664 " Removes an @var{attribute} from an element."
4666 "@item ATTR LIST [!]element[<TAB>[!]child[..]]\n"
4668 " Retrieves a newline separated list of attributes names and values "
4669 "from the specified element. Each attribute name and value is space delimited."
4671 "@item ATTR GET attribute [!]element[<TAB>[!]child[..]]\n"
4673 " Retrieves the value of an @var{attribute} from an element."
4676 "The @code{_name} attribute (case sensitive) cannot be removed nor modified. "
4677 "Use the @code{DELETE} (@pxref{DELETE}) or @code{RENAME} (@pxref{RENAME}) "
4680 "The @code{_mtime} attribute is updated each time an element is modified by "
4681 "either storing content, editing attributes or by deleting a child element. "
4682 "The @code{_ctime} attribute is created for each new element in an element "
4685 "When the @option{--inquire} option is passed then all remaining non-option "
4686 "arguments are retrieved via a server @emph{INQUIRE}."
4688 "@xref{Target Attribute}, for details about this special attribute."
4691 new_command("XPATH", 0, 1, xpath_command
, _(
4692 "XPATH [--inquire] <expression>[<TAB>[value]]\n"
4693 "Evaluates an XPath @var{expression}. If no @var{value} argument is "
4694 "specified it is assumed the expression is a request to return a result. "
4695 "Otherwise, the result is set to the @var{value} argument and the document is "
4696 "updated. If there is no @var{value} after the @key{TAB} character, the value "
4697 "is assumed to be empty and the document is updated. For example:"
4700 "XPATH //element[@@_name='password']@key{TAB}\n"
4703 "would clear the content of all @code{password} elements in the data file "
4704 "while leaving off the trailing @key{TAB} would return all @code{password} "
4705 "elements in @abbr{XML} format."
4707 "When the @option{--inquire} option is passed then all remaining non-option "
4708 "arguments are retrieved via a server @emph{INQUIRE}."
4710 "See @url{http://www.w3schools.com/xpath/xpath_syntax.asp} for @abbr{XPATH} "
4711 "expression syntax."
4714 new_command("XPATHATTR", 0, 1, xpathattr_command
, _(
4715 "XPATHATTR [--inquire] SET|DELETE <name> <expression>[<TAB>[<value>]]\n"
4716 "Like the @code{XPATH} command (@pxref{XPATH}) but operates on element "
4717 "attributes and does not return a result. For the @var{SET} operation the "
4718 "@var{value} is optional but the field is required. If not specified then "
4719 "the attribute value will be empty. For example:"
4722 "XPATHATTR SET password //element[@@_name='password']@key{TAB}\n"
4725 "would create an @code{password} attribute for each @code{password} element "
4726 "found in the document. The attribute value will be empty but still exist."
4728 "When the @option{--inquire} option is passed then all remaining non-option "
4729 "arguments are retrieved via a server @emph{INQUIRE}."
4731 "See @url{http://www.w3schools.com/xpath/xpath_syntax.asp} for @abbr{XPATH} "
4732 "expression syntax."
4735 new_command("IMPORT", 0, 1, import_command
, _(
4736 "IMPORT [--root [!]element[<TAB>[!]child[..]]] <content>\n"
4737 "This command uses a server @emph{INQUIRE} to retrieve data from the client."
4739 "Like the @code{STORE} command (@pxref{STORE}), but the @var{content} "
4740 "argument is raw @abbr{XML} data. The content is created as a child of "
4741 "the element path specified with the @option{--root} option or at the "
4742 "document root when not specified. Existing elements of the same name will "
4745 "The content must begin with an @abbr{XML} element node. @xref{Introduction}, "
4749 new_command("DUMP", 0, 1, dump_command
, _(
4751 "Shows the in memory @abbr{XML} document with indenting. @xref{XPATH}, for "
4752 "dumping a specific node."
4755 new_command("LOCK", 0, 0, lock_command
, _(
4757 "Locks the mutex associated with the opened file. This prevents other clients "
4758 "from sending commands to the same opened file until the client "
4759 "that sent this command either disconnects or sends the @code{UNLOCK} "
4760 "command. @xref{UNLOCK}."
4763 new_command("UNLOCK", 1, 0, unlock_command
, _(
4765 "Unlocks the file mutex which was locked with the @code{LOCK} command or "
4766 "a commands' @option{--lock} option (@pxref{LOCK}, @pxref{OPEN}, "
4767 "@pxref{ISCACHED})."
4770 new_command("GETCONFIG", 1, 1, getconfig_command
, _(
4771 "GETCONFIG [filename] <parameter>\n"
4772 "Returns the value of a @command{pwmd} configuration @var{parameter} with a "
4773 "data response. If no file has been opened then the value for @var{filename} "
4774 "or the default from the @samp{global} section will be returned. If a file "
4775 "has been opened and no @var{filename} is specified, a value previously "
4776 "set with the @code{OPTION} command (@pxref{OPTION}) will be returned."
4779 new_command("OPTION", 1, 1, option_command
, _(
4780 "OPTION <NAME>=<VALUE>\n"
4781 "Sets a client option @var{name} to @var{value}. The value for an option is "
4782 "kept for the duration of the connection."
4785 "@item DISABLE-PINENTRY\n"
4786 "Disable use of @command{pinentry} for passphrase retrieval. When set, a "
4787 "server inquire is sent to the client to obtain the passphrase. This option "
4788 "may be set as needed before the @code{OPEN} (@pxref{OPEN}), @code{PASSWD} "
4789 "(@pxref{PASSWD}) and @code{SAVE} (@pxref{SAVE}) commands."
4791 "@item PINENTRY-TIMEOUT\n"
4792 "Sets the number of seconds before a pinentry prompt will return an error "
4793 "while waiting for user input."
4796 "Passed to the @command{gpg-agent} and used for the @command{pinentry} dialog."
4799 "Passed to the @command{gpg-agent} and used for the @command{pinentry} dialog."
4802 "Passed to the @command{gpg-agent} and used for the @command{pinentry} dialog."
4804 "@item PINENTRY-DESC\n"
4805 "Sets the description string of the @command{gpg-agent} and @command{pinentry} dialog."
4807 "@item PINENTRY-TITLE\n"
4808 "Sets the title string of the @command{gpg-agent} and @command{pinentry} dialog."
4810 "@item PINENTRY-PROMPT\n"
4811 "Sets the prompt string of the @command{gpg-agent} and @command{pinentry} dialog."
4814 "Passed to the @command{gpg-agent} and used for the @command{pinentry} dialog."
4816 "@item LC-MESSAGES\n"
4817 "Passed to the @command{gpg-agent} and used for the @command{pinentry} dialog."
4820 "Associates the thread ID of the connection with the specified textual "
4821 "representation. Useful for debugging log messages."
4823 "@item LOCK-TIMEOUT\n"
4824 "When not @code{0}, the duration in tenths of a second to wait for the file "
4825 "mutex which has been locked by another thread to be released before returning "
4826 "an error. When @code{-1}, then an error will be returned immediately."
4829 "An integer specifiying the logging level."
4833 new_command("LS", 1, 1, ls_command
, _(
4835 "Lists the available data files stored in the data directory "
4836 "(@file{~/.pwmd/data}). The result is a newline separated list of filenames."
4839 new_command("RESET", 1, 1, NULL
, _(
4841 "Closes the currently opened file but keeps any previously set client options."
4844 new_command("NOP", 1, 1, NULL
, _(
4846 "Does nothing. Always returns successfully."
4849 /* !END-HELP-TEXT! */
4850 new_command ("CANCEL", 1, 1, NULL
, NULL
);
4851 new_command ("END", 1, 1, NULL
, NULL
);
4852 new_command ("BYE", 1, 1, NULL
, NULL
);
4855 for (i
= 0; command_table
[i
]; i
++);
4856 qsort (command_table
, i
- 1, sizeof (struct command_table_s
*),
4861 register_commands (assuan_context_t ctx
)
4865 for (; command_table
[i
]; i
++)
4867 if (!command_table
[i
]->handler
)
4870 rc
= assuan_register_command (ctx
, command_table
[i
]->name
,
4871 command_table
[i
]->handler
,
4872 command_table
[i
]->help
);
4877 rc
= assuan_register_bye_notify (ctx
, bye_notify
);
4881 rc
= assuan_register_reset_notify (ctx
, reset_notify
);
4885 rc
= assuan_register_pre_cmd_notify (ctx
, command_startup
);
4889 return assuan_register_post_cmd_notify (ctx
, command_finalize
);