2 Copyright (C) 2006-2021 Ben Kibbey <bjk@luxsci.net>
4 This file is part of pwmd.
6 Pwmd is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License version 2 as
8 published by the Free Software Foundation.
10 Pwmd is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with Pwmd. If not, see <http://www.gnu.org/licenses/>.
29 #include <sys/types.h>
43 #include "pwmd-error.h"
48 #include "util-misc.h"
57 /* These are command option flags. */
58 #define OPT_INQUIRE 0x0001
59 #define OPT_NO_PASSPHRASE 0x0002
60 #define OPT_ASK 0x0004
61 #define OPT_LIST_RECURSE 0x0008
62 #define OPT_VERBOSE 0x0010
63 #define OPT_LOCK 0x0020
64 #define OPT_LOCK_ON_OPEN 0x0040
65 #define OPT_SIGN 0x0080
66 #define OPT_LIST_ALL 0x0100
67 #define OPT_DATA 0x0200
68 #define OPT_NO_AGENT 0x0400
69 #define OPT_SECRET 0x0800
70 #define OPT_INQUIRE_KEYID 0x1000
71 #define OPT_SYMMETRIC 0x4000
72 #define OPT_NO_SIGNER 0x8000
73 #define OPT_HTML 0x10000
74 #define OPT_CACHE_AGENT 0x20000
75 #define OPT_CACHE_SIGN 0x40000
76 #define OPT_KEYINFO_LEARN 0x80000
77 #define OPT_SEXP 0x100000
79 #define FLOCK_TYPE_NONE 0
80 #define FLOCK_TYPE_SH 0x0001
81 #define FLOCK_TYPE_EX 0x0002
82 #define FLOCK_TYPE_KEEP 0x0004
84 static char env_display
[256];
85 static char env_gpg_tty
[256];
86 static char env_term
[256];
87 static struct command_table_s
**command_table
;
89 static gpg_error_t
do_lock (struct client_s
*client
, int add
);
90 static gpg_error_t
validate_checksum (struct client_s
*, const char *filename
,
91 struct cache_data_s
*, unsigned char **,
93 static gpg_error_t
update_checksum (struct client_s
*client
,
94 unsigned char *from_crc
, size_t crclen
);
95 static gpg_error_t
command_startup (assuan_context_t ctx
, const char *name
);
96 static void command_finalize (assuan_context_t ctx
, gpg_error_t rc
);
98 /* When 'status' is true the 'self' field of the status line will be false
99 * because we never send the STATE status message to the same client that
102 build_client_info_line (struct client_thread_s
*thd
, int status
)
104 char *uid
, *username
= NULL
;
109 uid
= str_asprintf("#%s", thd
->tls
->fp
);
112 uid
= str_asprintf("%u", thd
->peer
->uid
);
113 username
= get_username (thd
->peer
->uid
);
116 uid
= str_asprintf("%u", thd
->peer
->uid
);
117 username
= get_username (thd
->peer
->uid
);
119 line
= str_asprintf ("%p %s %s %s %u %u %u %s %s %u",
121 thd
->name
? thd
->name
: "-",
122 thd
->cl
&& thd
->cl
->filename
123 && (thd
->cl
->flags
& FLAG_OPEN
)
124 ? thd
->cl
->filename
: "/",
126 thd
->remote
? thd
->peeraddr
: "-",
130 thd
->cl
&& thd
->cl
->flags
& FLAG_HAS_LOCK
? 1 : 0,
131 !status
&& pthread_equal (pthread_self (), thd
->tid
) ? 1 : 0,
134 thd
->remote
? "-" : username
,
147 update_client_state (struct client_s
*client
, unsigned s
)
149 MUTEX_LOCK (&cn_mutex
);
150 if (client
->thd
->state
== s
)
152 MUTEX_UNLOCK (&cn_mutex
);
155 client
->thd
->state
= s
;
156 MUTEX_UNLOCK (&cn_mutex
);
158 if (client
->thd
->state
!= CLIENT_STATE_UNKNOWN
)
160 char *line
= build_client_info_line (client
->thd
, 1);
162 pthread_cleanup_push (xfree
, line
);
164 send_status_all_not_self (STATUS_STATE
, "%s", line
);
165 pthread_cleanup_pop (1);
170 unlock_file_mutex (struct client_s
*client
, int remove
)
174 // OPEN: keep the lock for the same file being reopened.
175 if (client
->flags
& FLAG_KEEP_LOCK
&& client
->flags
& FLAG_HAS_LOCK
)
178 if (!(client
->flags
& FLAG_HAS_LOCK
))
179 return GPG_ERR_NOT_LOCKED
;
181 rc
= cache_unlock_mutex (client
->filename
, remove
);
183 rc
= GPG_ERR_INV_STATE
;
185 client
->flags
&= ~(FLAG_HAS_LOCK
| FLAG_LOCK_CMD
);
191 lock_file_mutex (struct client_s
*client
, int add
)
194 long timeout
= config_get_long (client
->filename
, "cache_timeout");
196 if (client
->flags
& FLAG_HAS_LOCK
)
199 rc
= cache_lock_mutex (client
->ctx
, client
->filename
,
200 client
->lock_timeout
, add
, timeout
);
202 client
->flags
|= FLAG_HAS_LOCK
;
208 file_modified (struct client_s
*client
, struct command_table_s
*cmd
)
211 int type
= !cmd
->flock_type
|| (cmd
->flock_type
& FLOCK_TYPE_SH
)
214 if (!(client
->flags
& FLAG_OPEN
))
215 return GPG_ERR_INV_STATE
;
217 rc
= lock_file_mutex (client
, 0);
218 if (rc
&& rc
!= GPG_ERR_NO_DATA
)
221 rc
= lock_flock (client
->ctx
, client
->filename
, type
, &client
->flock_fd
);
224 rc
= validate_checksum (client
, client
->filename
, NULL
, NULL
, NULL
, 0);
225 if (gpg_err_code (rc
) == GPG_ERR_ENOENT
&& (client
->flags
& FLAG_NEW
))
228 log_write ("%s: %s", client
->filename
, pwmd_strerror (rc
));
230 else if (gpg_err_code (rc
) == GPG_ERR_ENOENT
)
233 /* FLAG_HAS_LOCK may have been set by the LOCK command or OPEN --lock. */
234 if ((cmd
->unlock
&& !(client
->flags
& FLAG_HAS_LOCK
)) || rc
)
235 unlock_file_mutex (client
, 0);
237 if (rc
|| !(cmd
->flock_type
& FLOCK_TYPE_KEEP
))
238 unlock_flock (&client
->flock_fd
);
244 parse_xml (assuan_context_t ctx
, int new)
246 struct client_s
*client
= assuan_get_pointer (ctx
);
247 int cached
= client
->doc
!= NULL
;
252 client
->doc
= xml_new_document ();
258 xmlDocDumpFormatMemory (client
->doc
, &result
, &len
, 0);
259 client
->crypto
->plaintext
= result
;
260 client
->crypto
->plaintext_size
= len
;
261 if (!client
->crypto
->plaintext
)
263 xmlFreeDoc (client
->doc
);
272 rc
= xml_parse_doc ((char *) client
->crypto
->plaintext
,
273 client
->crypto
->plaintext_size
,
274 (xmlDocPtr
*)&client
->doc
);
280 free_client (struct client_s
*client
)
282 cache_plaintext_release (&client
->doc
);
284 xfree (client
->filename
);
285 xfree (client
->last_error
);
286 crypto_free (client
->crypto
);
287 client
->crypto
= NULL
;
291 reset_client (struct client_s
*client
)
293 assuan_context_t ctx
= client
->ctx
;
294 struct client_thread_s
*thd
= client
->thd
;
295 long lock_timeout
= client
->lock_timeout
;
296 xmlErrorPtr xml_error
= client
->xml_error
;
297 int no_pinentry
= (client
->flags
& FLAG_NO_PINENTRY
);
298 int flock_fd
= client
->flock_fd
;
299 struct bulk_cmd_s
*bulk_p
= client
->bulk_p
;
301 unlock_file_mutex (client
, client
->flags
& FLAG_NEW
);
302 free_client (client
);
303 memset (client
, 0, sizeof (struct client_s
));
304 client
->flock_fd
= flock_fd
;
305 client
->xml_error
= xml_error
;
308 client
->lock_timeout
= lock_timeout
;
309 client
->flags
|= no_pinentry
? FLAG_NO_PINENTRY
: 0;
310 client
->bulk_p
= bulk_p
;
319 strv_free ((char **) arg
);
323 parse_open_opt_lock (void *data
, void *value
)
325 struct client_s
*client
= data
;
328 client
->opts
|= OPT_LOCK_ON_OPEN
;
333 parse_opt_inquire (void *data
, void *value
)
335 struct client_s
*client
= data
;
338 client
->opts
|= OPT_INQUIRE
;
343 update_checksum (struct client_s
*client
, unsigned char *from_crc
,
348 struct cache_data_s
*cdata
;
353 rc
= get_checksum (client
->filename
, &crc
, &len
);
364 client
->crc
= xmalloc (len
);
365 memcpy (client
->crc
, crc
, len
);
366 pthread_cleanup_push (xfree
, crc
);
367 cdata
= cache_get_data (client
->filename
, NULL
);
368 pthread_cleanup_pop (0);
372 cdata
->crc
= xmalloc (len
);
373 memcpy (cdata
->crc
, crc
, len
);
382 validate_checksum (struct client_s
*client
, const char *filename
,
383 struct cache_data_s
*cdata
, unsigned char **r_crc
,
384 size_t *r_crclen
, int from_cdata
)
391 if (cdata
&& !cdata
->crc
)
392 return GPG_ERR_CHECKSUM
;
394 rc
= get_checksum (filename
, &crc
, &len
);
399 n
= memcmp (client
->crc
, crc
, len
);
400 else if ((client
->flags
& FLAG_NEW
) && cache_get_data (filename
, NULL
))
403 if ((!n
&& cdata
) || (from_cdata
&& cdata
&& crc
))
404 n
= memcmp (cdata
->crc
, crc
, len
);
414 return n
? GPG_ERR_CHECKSUM
: 0;
418 open_command (assuan_context_t ctx
, char *line
)
421 struct client_s
*client
= assuan_get_pointer (ctx
);
423 assuan_peercred_t peer
;
424 struct cache_data_s
*cdata
= NULL
;
426 unsigned char *crc
= NULL
;
429 struct argv_s
*args
[] = {
430 &(struct argv_s
) {"lock", OPTION_TYPE_NOARG
, parse_open_opt_lock
},
434 rc
= parse_options (&line
, args
, client
, 1);
436 return send_error (ctx
, rc
);
438 rc
= do_validate_peer (ctx
, line
, &peer
, NULL
);
439 if (rc
== GPG_ERR_FORBIDDEN
)
441 rc
= peer_is_invoker (client
);
442 if (rc
== GPG_ERR_EACCES
)
443 rc
= GPG_ERR_FORBIDDEN
;
447 return send_error (ctx
, rc
);
449 if (!valid_filename (line
))
450 return send_error (ctx
, GPG_ERR_INV_VALUE
);
452 /* This client may have locked a different file with ISCACHED --lock than
453 * the current filename. This will remove that lock. */
454 same_file
= client
->filename
&& !strcmp (line
, client
->filename
);
455 if (client
->flags
& FLAG_OPEN
||
456 (client
->flags
& FLAG_HAS_LOCK
&& !same_file
))
458 unsigned opts
= client
->opts
;
459 unsigned flags
= client
->flags
;
462 client
->flags
|= FLAG_KEEP_LOCK
;
464 /* Another client wrote to the same data file as currently opened. */
465 cdata
= cache_get_data (client
->filename
, NULL
);
466 if (cdata
&& cdata
->crc
)
468 /* Remove cache entry for the new file that hadn't been written. */
469 else if (client
->flags
& FLAG_NEW
)
470 cache_clear (NULL
, client
->filename
, 0, 0);
473 reset_client (client
);
475 client
->flags
|= flags
;
476 client
->flags
&= ~(FLAG_LOCK_CMD
);
478 client
->flags
&= ~(FLAG_HAS_LOCK
| FLAG_NEW
);
481 xfree (client
->filename
);
482 client
->filename
= str_dup (line
);
483 if (!client
->filename
)
484 return send_error(ctx
, GPG_ERR_ENOMEM
);
486 /* Need to lock the mutex here because file_modified() cannot without
487 * knowing the filename. */
488 rc
= lock_file_mutex (client
, 1);
490 client
->flags
&= ~FLAG_OPEN
;
494 rc
= lock_flock (ctx
, client
->filename
, LOCK_SH
, &client
->flock_fd
);
495 if (gpg_err_code (rc
) == GPG_ERR_ENOENT
)
501 char *keyfile
= config_get_string (client
->filename
, "passphrase_file");
503 rc
= crypto_init (&client
->crypto
, client
->ctx
, client
->filename
,
504 client
->flags
& FLAG_NO_PINENTRY
, keyfile
);
508 rc
= open_check_file (client
->filename
, NULL
, NULL
, 1);
511 if (!rc
|| gpg_err_code (rc
) == GPG_ERR_ENOENT
)
520 if (config_get_boolean ("global", "strict_open"))
522 rc
= peer_is_invoker (client
);
523 if (rc
== GPG_ERR_EACCES
)
524 rc
= GPG_ERR_FORBIDDEN
;
529 client
->flags
|= FLAG_NEW
;
530 // data file disappeared. clear the cache entry.
531 cache_clear (NULL
, client
->filename
, 1, 1);
538 cdata
= cache_get_data (client
->filename
, &defer
);
540 && !cache_plaintext_get (client
->filename
, &client
->doc
))
542 rc
= validate_checksum (client
, client
->filename
, cdata
, &crc
,
546 log_write ("%s: %s", client
->filename
,
548 cache_plaintext_release (&client
->doc
);
549 if (rc
== GPG_ERR_CHECKSUM
)
551 cache_clear (NULL
, client
->filename
, 1, 1);
558 if (!rc
&& client
->thd
->remote
559 && config_get_boolean (client
->filename
, "tcp_require_key")
560 && !(client
->flags
& FLAG_NEW
))
562 rc
= crypto_try_decrypt (client
,
563 (client
->flags
& FLAG_NO_PINENTRY
));
568 strv_free (client
->crypto
->pubkey
);
569 client
->crypto
->pubkey
= NULL
;
571 client
->crypto
->pubkey
= strv_dup (cdata
->pubkey
);
573 xfree (client
->crypto
->sigkey
);
574 client
->crypto
->sigkey
= NULL
;
576 client
->crypto
->sigkey
= str_dup (cdata
->sigkey
);
582 else if (cdata
&& cdata
->doc
) // cached document
584 if (!rc
&& !(client
->flags
& FLAG_NEW
))
586 rc
= validate_checksum (client
, client
->filename
, cdata
, &crc
,
588 if (rc
== GPG_ERR_CHECKSUM
)
597 rc
= cache_iscached (client
->filename
, &defer
, 0, 0);
598 if ((!rc
|| rc
== GPG_ERR_ENOENT
) && defer
)
608 log_write ("%s: %s", client
->filename
,
609 pwmd_strerror (GPG_ERR_CHECKSUM
));
610 cache_clear (NULL
, client
->filename
, 1, 1);
612 rc
= crypto_decrypt (client
, client
->crypto
);
617 if (client
->thd
->remote
618 && config_get_boolean (client
->filename
, "tcp_require_key")
619 && !(client
->flags
& FLAG_NEW
))
620 rc
= crypto_try_decrypt (client
,
621 (client
->flags
& FLAG_NO_PINENTRY
));
627 client
->crypto
->plaintext
= cdata
->doc
;
628 client
->crypto
->plaintext_size
= cdata
->size
;
629 rc
= cache_decrypt (client
->crypto
);
635 strv_free (client
->crypto
->pubkey
);
636 client
->crypto
->pubkey
= NULL
;
638 client
->crypto
->pubkey
= strv_dup (cdata
->pubkey
);
640 xfree (client
->crypto
->sigkey
);
641 client
->crypto
->sigkey
= NULL
;
643 client
->crypto
->sigkey
= str_dup (cdata
->sigkey
);
649 client
->crypto
->plaintext
= NULL
;
650 client
->crypto
->plaintext_size
= 0;
654 else // existing file
657 cached
= cdata
!= NULL
;
658 rc
= crypto_decrypt (client
, client
->crypto
);
663 if (!rc
&& !plaintext
)
665 rc
= parse_xml (ctx
, client
->flags
& FLAG_NEW
);
668 rc
= cache_encrypt (client
->crypto
);
670 cache_clear (NULL
, client
->filename
, 1, 1);
673 long timeout
= config_get_long (client
->filename
,
676 cache_free_data_once (cdata
);
677 cdata
= xcalloc (1, sizeof (struct cache_data_s
));
678 cdata
->doc
= client
->crypto
->plaintext
;
679 cdata
->size
= client
->crypto
->plaintext_size
;
680 cdata
->pubkey
= strv_dup(client
->crypto
->pubkey
);
681 cdata
->sigkey
= client
->crypto
->sigkey
? str_dup(client
->crypto
->sigkey
) : NULL
;
682 client
->crypto
->plaintext
= NULL
;
683 client
->crypto
->plaintext_size
= 0;
685 if (cached
) // wont increment the refcount
692 cdata
->crc
= xmalloc (crclen
);
693 memcpy (cdata
->crc
, crc
, crclen
);
696 rc
= cache_set_data (client
->filename
, cdata
);
697 /* The cache entry may have been removed and cache_set_data()
698 * already sent STATUS_CACHE. */
699 if (!cache_iscached (client
->filename
, NULL
, 0, 0))
700 rc
= send_status (ctx
, STATUS_CACHE
, NULL
);
703 rc
= cache_add_file (client
->filename
, cdata
, timeout
);
706 cache_plaintext_set (client
->filename
, client
->doc
, 0);
717 client
->crc
= xmalloc (crclen
);
718 memcpy (client
->crc
, crc
, crclen
);
724 if (!rc
&& !(client
->flags
& FLAG_NEW
) && !cached
)
725 rc
= update_checksum (client
, NULL
, 0);
729 client
->flags
|= FLAG_OPEN
;
731 if (client
->flags
& FLAG_NEW
)
732 rc
= send_status (ctx
, STATUS_NEWFILE
, NULL
);
734 if (!rc
&& (client
->opts
& OPT_LOCK_ON_OPEN
))
735 rc
= do_lock (client
, 0);
737 crypto_free_non_keys (client
->crypto
);
741 log_write ("%s: %s", client
->filename
, pwmd_strerror (rc
));
743 if (client
->flags
& FLAG_NEW
)
744 cache_clear (NULL
, client
->filename
, 1, 1);
746 crypto_free (client
->crypto
);
747 client
->crypto
= NULL
;
748 client
->flags
&= ~FLAG_OPEN
;
749 cache_plaintext_release (&client
->doc
);
752 return send_error (ctx
, rc
);
755 /* If not an invoking_user or is an existing file, check that the list of user
756 * supplied key ID's are in the list of current key ID's obtained when
757 * decrypting the data file.
760 permitted_to_save (struct client_s
*client
, const char **keys
,
766 if ((client
->flags
& FLAG_NEW
) || (client
->opts
& OPT_SYMMETRIC
))
769 rc
= peer_is_invoker (client
);
772 else if (rc
== GPG_ERR_EACCES
)
773 rc
= GPG_ERR_FORBIDDEN
;
778 if ((!value
&& !keys
) || ((value
&& !*value
) && (keys
&& !*keys
)))
781 for (v
= value
; v
&& *v
; v
++)
783 const char **k
, *pv
= *v
;
786 if (*pv
== '0' && *(pv
+1) == 'x')
789 for (k
= keys
; k
&& *k
; k
++)
793 if (*pk
== '0' && *(pk
+1) == 'x')
796 rc
= !strcmp (pv
, pk
) ? 0 : GPG_ERR_FORBIDDEN
;
798 rc
= !strcmp (pv
, *k
) ? 0 : GPG_ERR_FORBIDDEN
;
808 return GPG_ERR_FORBIDDEN
;
814 /* Requires that the keyid be a fingerprint in 16 byte form. */
816 parse_save_opt_keyid_common (struct client_s
*client
, const char **list
,
817 const char *value
, char ***dst
)
824 keys
= str_split (value
, ",", 0);
826 return GPG_ERR_ENOMEM
;
829 rc
= crypto_keyid_to_16b (keys
);
831 rc
= permitted_to_save (client
, list
, (const char **)keys
);
842 parse_save_opt_keyid (void *data
, void *value
)
844 struct client_s
*client
= data
;
845 const char *str
= value
;
849 rc
= parse_save_opt_keyid_common (client
,
850 (const char **)client
->crypto
->pubkey
,
855 client
->crypto
->save
.pubkey
= dst
;
860 parse_save_opt_sign_keyid (void *data
, void *value
)
862 struct client_s
*client
= data
;
863 const char *str
= value
;
868 if (client
->crypto
->sigkey
)
870 if (!strv_printf (&tmp
, "%s", client
->crypto
->sigkey
))
871 return GPG_ERR_ENOMEM
;
874 rc
= parse_save_opt_keyid_common (client
, (const char **)tmp
, str
, &dst
);
880 client
->opts
|= OPT_NO_SIGNER
;
882 client
->crypto
->save
.sigkey
= str_dup (*dst
);
889 parse_save_opt_inquire_keyid (void *data
, void *value
)
891 struct client_s
*client
= data
;
895 if (!(client
->flags
& FLAG_NEW
))
897 gpg_error_t rc
= peer_is_invoker (client
);
900 return rc
== GPG_ERR_EACCES
? GPG_ERR_FORBIDDEN
: rc
;
903 client
->opts
|= OPT_INQUIRE_KEYID
;
908 parse_save_opt_symmetric (void *data
, void *value
)
910 struct client_s
*client
= data
;
913 client
->opts
|= OPT_SYMMETRIC
;
918 parse_genkey_opt_userid (void *data
, void *value
)
920 struct client_s
*client
= data
;
922 if (!(client
->flags
& FLAG_NEW
))
924 gpg_error_t rc
= peer_is_invoker (client
);
927 return rc
== GPG_ERR_EACCES
? GPG_ERR_FORBIDDEN
: rc
;
930 client
->crypto
->save
.userid
= str_dup (value
);
931 return client
->crypto
->save
.userid
? 0 : GPG_ERR_ENOMEM
;
935 parse_genkey_opt_algo (void *data
, void *value
)
937 struct client_s
*client
= data
;
939 client
->crypto
->save
.algo
= str_dup (value
);
940 return client
->crypto
->save
.algo
? 0 : GPG_ERR_ENOMEM
;
944 parse_genkey_opt_no_expire (void *data
, void *value
)
946 struct client_s
*client
= data
;
948 client
->crypto
->save
.flags
|= GPGME_CREATE_NOEXPIRE
;
953 parse_genkey_opt_expire (void *data
, void *value
)
955 struct client_s
*client
= data
;
961 t
= strtoul (value
, &p
, 10);
963 if (!errno
&& p
&& *p
)
964 rc
= GPG_ERR_INV_VALUE
;
965 else if (t
== ULONG_MAX
)
966 rc
= GPG_ERR_INV_VALUE
;
968 rc
= gpg_error_from_syserror ();
970 client
->crypto
->save
.expire
= t
;
976 parse_genkey_opt_no_passphrase (void *data
, void *value
)
978 struct client_s
*client
= data
;
981 client
->crypto
->save
.flags
|= GPGME_CREATE_NOPASSWD
;
985 /* Tests that the keys in new_keys are also in old_keys. */
987 compare_keys (char **new_keys
, char **old_keys
)
991 if (!old_keys
|| !*old_keys
)
994 crypto_keyid_to_16b (new_keys
);
996 for (o
= old_keys
; *o
; o
++)
1000 for (n
= new_keys
; *n
; n
++)
1002 if (!strcmp (*n
, *o
))
1007 return GPG_ERR_NOT_FOUND
;
1014 inquire_keyid (struct client_s
*client
)
1017 unsigned char *result
= NULL
;
1019 const char *s
= "KEYID";
1023 orig
= &client
->crypto
->pubkey
;
1024 save
= &client
->crypto
->save
.pubkey
;
1025 rc
= assuan_inquire (client
->ctx
, s
, &result
, &len
, 0);
1030 rc
= parse_save_opt_keyid_common (client
, (const char **)*orig
,
1031 (char *)result
, &dst
);
1041 /* When a key lookup in gpg-agent's cache fails, the agent tries the last
1042 * successful key to be unlocked. This prevents pwmd from successfully
1043 * clearing a signing key since the previous key, which more than likely
1044 * belongs to the same keypair as the encryption/decryption key, will have the
1045 * passphrase cached and therefore the signing key also cached. So we need to
1046 * clear both the signing and encryption keys to get the effect of requiring a
1047 * passphrase when generating a new keypair for an existing data file, or when
1048 * the "require_save_key" configuration parameter is set. This parameter is
1049 * mostly a failsafe of the gpg-agent option --ignore-cache-for-signing since
1050 * some/most/all users may fail to set it.
1053 save_command (assuan_context_t ctx
, char *line
)
1055 struct client_s
*client
= assuan_get_pointer (ctx
);
1056 struct cache_data_s
*cdata
= NULL
;
1058 gpg_error_t rc
= 0, cache_rc
= 0;
1060 struct argv_s
*args
[] = {
1061 &(struct argv_s
) {"keyid", OPTION_TYPE_ARG
, parse_save_opt_keyid
},
1062 &(struct argv_s
) {"inquire-keyid", OPTION_TYPE_NOARG
,
1063 parse_save_opt_inquire_keyid
},
1064 &(struct argv_s
) {"sign-keyid", OPTION_TYPE_OPTARG
,
1065 parse_save_opt_sign_keyid
},
1066 &(struct argv_s
) {"symmetric", OPTION_TYPE_NOARG
,
1067 parse_save_opt_symmetric
},
1071 crypto_free_save (&client
->crypto
->save
);
1072 client
->crypto
->save
.expire
= DEFAULT_EXPIRE
;
1074 rc
= crypto_is_symmetric (client
->filename
);
1075 if (!rc
|| rc
== GPG_ERR_BAD_DATA
|| rc
== GPG_ERR_ENOENT
)
1079 client
->opts
|= OPT_SYMMETRIC
;
1082 else if (rc
== GPG_ERR_ENOENT
&& (client
->flags
& FLAG_NEW
))
1089 return send_error (ctx
, rc
);
1091 rc
= parse_options (&line
, args
, client
, 0);
1093 return send_error (ctx
, rc
);
1095 if (config_get_boolean (client
->filename
, "require_save_key")
1096 || (client
->opts
& OPT_SYMMETRIC
))
1097 client
->opts
|= OPT_ASK
;
1099 rc
= open_check_file (client
->filename
, NULL
, NULL
, 1);
1100 if (rc
&& gpg_err_code (rc
) != GPG_ERR_ENOENT
)
1102 log_write ("%s: %s", client
->filename
, pwmd_strerror (rc
));
1103 return send_error (ctx
, rc
);
1107 cache_rc
= rc
= cache_iscached (client
->filename
, &defer
, 0, 1);
1109 if (gpg_err_code (rc
) == GPG_ERR_ENOENT
&& (client
->flags
& FLAG_NEW
))
1111 else if (gpg_err_code (rc
) == GPG_ERR_NO_DATA
)
1115 return send_error (ctx
, rc
);
1117 /* Specifying both a recipient and symmetric encryption is an error. */
1118 if ((client
->opts
& OPT_INQUIRE_KEYID
) && (client
->opts
& OPT_SYMMETRIC
))
1119 return send_error (ctx
, GPG_ERR_CONFLICT
);
1120 /* Existing file with a recipient and wanting symmetric is an error. */
1121 else if ((client
->opts
& OPT_SYMMETRIC
) && client
->crypto
->save
.pubkey
)
1122 return send_error (ctx
, GPG_ERR_CONFLICT
);
1123 else if (client
->crypto
->save
.pubkey
&& (client
->opts
& OPT_INQUIRE_KEYID
))
1124 return send_error (ctx
, GPG_ERR_CONFLICT
);
1125 else if (!sym
&& (client
->opts
& OPT_SYMMETRIC
) && !(client
->flags
& FLAG_NEW
))
1126 return send_error (ctx
, GPG_ERR_CONFLICT
);
1127 /* New file that is not symmetric without either a recipient or signer. */
1128 else if ((client
->flags
& FLAG_NEW
) && !(client
->opts
& OPT_SYMMETRIC
)
1129 && (!client
->crypto
->save
.pubkey
|| !client
->crypto
->save
.sigkey
))
1130 return send_error (ctx
, GPG_ERR_SYNTAX
);
1131 else if (client
->opts
& OPT_INQUIRE_KEYID
)
1132 rc
= inquire_keyid (client
);
1136 client
->crypto
->keyfile
= config_get_string (client
->filename
,
1138 rc
= crypto_init_ctx (client
->crypto
, (client
->flags
& FLAG_NO_PINENTRY
),
1139 client
->crypto
->keyfile
);
1142 if (!rc
&& (client
->flags
& FLAG_NEW
))
1144 /* Require --keyid when --sign-keyid exists to keep KEYINFO
1146 if (!client
->crypto
->save
.pubkey
&& client
->crypto
->save
.sigkey
1147 && !(client
->opts
& OPT_SYMMETRIC
))
1148 rc
= GPG_ERR_NO_PUBKEY
;
1152 cdata
= cache_get_data (client
->filename
, NULL
);
1155 if (client
->crypto
->save
.pubkey
)
1156 rc
= compare_keys (client
->crypto
->save
.pubkey
, cdata
->pubkey
);
1158 /* Always allow a signer for symmetric data files. */
1159 if (!rc
&& client
->crypto
->save
.sigkey
1160 && !(client
->opts
& OPT_SYMMETRIC
))
1161 rc
= !strcmp (client
->crypto
->save
.sigkey
, cdata
->sigkey
)
1162 ? 0 : GPG_ERR_NOT_FOUND
;
1164 /* Prevent saving to a recipient who is not in the original recipient
1165 * list without a passphrase. */
1166 if (rc
|| (client
->crypto
->sigkey
&& (client
->opts
& OPT_NO_SIGNER
)))
1167 client
->opts
|= OPT_ASK
;
1169 if (rc
== GPG_ERR_NOT_FOUND
)
1171 rc
= peer_is_invoker (client
);
1172 if (rc
== GPG_ERR_EACCES
)
1173 rc
= GPG_ERR_FORBIDDEN
;
1176 if (!client
->crypto
->save
.pubkey
1177 && !(client
->opts
& OPT_SYMMETRIC
))
1178 client
->crypto
->save
.pubkey
= strv_dup (cdata
->pubkey
);
1180 if (!rc
&& !client
->crypto
->save
.sigkey
&& cdata
->sigkey
1181 && !(client
->opts
& OPT_NO_SIGNER
))
1182 client
->crypto
->save
.sigkey
= str_dup (cdata
->sigkey
);
1183 else if (!rc
&& !client
->crypto
->save
.sigkey
1184 && (client
->opts
& OPT_NO_SIGNER
)
1185 && !(client
->opts
& OPT_SYMMETRIC
))
1186 rc
= GPG_ERR_NO_SIGNATURE_SCHEME
;
1190 client
->crypto
->save
.pubkey
= strv_dup (client
->crypto
->pubkey
);
1191 client
->crypto
->save
.sigkey
= str_dup (client
->crypto
->sigkey
);
1195 if (!rc
&& !(client
->flags
& FLAG_NEW
))
1197 /* Fixes {NEW_,SIGN_}PASSPHRASE inquire keywords. See passphrase_cb(). */
1198 if (client
->opts
& OPT_SYMMETRIC
)
1199 client
->crypto
->flags
|= CRYPTO_FLAG_PASSWD
;
1201 if (client
->opts
& OPT_ASK
)
1203 rc
= cache_clear_agent_keys (client
->filename
, 1, 1);
1205 rc
= crypto_try_decrypt (client
, client
->flags
& FLAG_NO_PINENTRY
);
1209 if (!rc
&& client
->opts
& OPT_SYMMETRIC
)
1210 client
->crypto
->flags
|= CRYPTO_FLAG_PASSWD_NEW
;
1213 rc
= xml_update_element_mtime (client
, xmlDocGetRootElement (client
->doc
));
1217 xmlNodePtr root
= xmlDocGetRootElement (client
->doc
);
1219 rc
= xml_add_attribute (client
, root
, "_version", PACKAGE_VERSION
);
1226 xmlDocDumpFormatMemory (client
->doc
, &client
->crypto
->plaintext
, &size
,
1229 client
->crypto
->plaintext_size
= (size_t) size
;
1231 rc
= GPG_ERR_ENOMEM
;
1235 client
->crypto
->flags
|= (client
->opts
& OPT_SYMMETRIC
) ? CRYPTO_FLAG_SYMMETRIC
: 0;
1236 client
->crypto
->flags
|= (client
->flags
& FLAG_NEW
) ? CRYPTO_FLAG_NEWFILE
: 0;
1237 client
->crypto
->flags
|= !(client
->opts
& OPT_SYMMETRIC
) ? CRYPTO_FLAG_PASSWD_SIGN
: 0;
1238 rc
= crypto_encrypt (client
, client
->crypto
);
1239 client
->crypto
->flags
&= ~CRYPTO_FLAG_SYMMETRIC
;
1244 unsigned char *crc
= NULL
;
1247 rc
= crypto_write_file (client
->crypto
, &crc
, &crclen
);
1248 pthread_cleanup_push ((void *)xfree
, crc
);
1252 cdata
= cache_get_data (client
->filename
, NULL
);
1254 cdata
= xcalloc (1, sizeof (struct cache_data_s
));
1259 rc
= cache_encrypt (client
->crypto
);
1262 cache_clear (NULL
, client
->filename
, 1, 1);
1263 client
->flags
&= ~(FLAG_NEW
);
1265 strv_free (client
->crypto
->pubkey
);
1266 client
->crypto
->pubkey
= NULL
;
1267 if (client
->crypto
->save
.pubkey
)
1268 client
->crypto
->pubkey
= strv_dup (client
->crypto
->save
.pubkey
);
1270 xfree (client
->crypto
->sigkey
);
1271 client
->crypto
->sigkey
= NULL
;
1272 if (client
->crypto
->save
.sigkey
)
1273 client
->crypto
->sigkey
= str_dup (client
->crypto
->save
.sigkey
);
1279 long timeout
= config_get_long (client
->filename
, "cache_timeout");
1280 xmlDocPtr doc
= xmlCopyDoc (client
->doc
, 1);
1283 rc
= GPG_ERR_ENOMEM
;
1287 cache_plaintext_release (&client
->doc
);
1288 strv_free (cdata
->pubkey
);
1289 cdata
->pubkey
= client
->crypto
->save
.pubkey
;
1290 client
->crypto
->save
.pubkey
= NULL
;
1292 xfree (cdata
->sigkey
);
1293 cdata
->sigkey
= client
->crypto
->save
.sigkey
;
1294 client
->crypto
->save
.sigkey
= NULL
;
1299 /* cache_encrypt() does in-place encryption */
1301 cdata
->doc
= client
->crypto
->plaintext
;
1302 client
->crypto
->plaintext
= NULL
;
1303 cdata
->size
= client
->crypto
->plaintext_size
;
1304 client
->crypto
->plaintext_size
= 0;
1307 cache_plaintext_set (client
->filename
, client
->doc
, 0);
1309 /* Update in case the cache entry expires the next SAVE may
1310 * not have any known keys. */
1311 strv_free (client
->crypto
->pubkey
);
1312 client
->crypto
->pubkey
= NULL
;
1314 client
->crypto
->pubkey
= strv_dup (cdata
->pubkey
);
1316 xfree (client
->crypto
->sigkey
);
1317 client
->crypto
->sigkey
= NULL
;
1319 client
->crypto
->sigkey
= str_dup (cdata
->sigkey
);
1321 if (!cache_rc
) // wont increment refcount
1322 rc
= cache_set_data (client
->filename
, cdata
);
1324 rc
= cache_add_file (client
->filename
, cdata
, timeout
);
1327 if (!rc
&& (cache_rc
|| (client
->flags
& FLAG_NEW
)))
1328 send_status_all (STATUS_CACHE
, NULL
);
1332 rc
= update_checksum (client
, crc
, crclen
);
1333 client
->flags
&= ~(FLAG_NEW
);
1337 pthread_cleanup_pop (1);
1339 client
->did_cow
= 0;
1343 crypto_free_non_keys (client
->crypto
);
1344 return send_error (ctx
, rc
);
1348 parse_genkey_opt_usage (void *data
, void *v
)
1350 struct client_s
*client
= data
;
1353 if (!value
|| !*value
)
1354 return GPG_ERR_INV_VALUE
;
1355 else if (!strcmp (value
, "sign"))
1356 client
->crypto
->save
.flags
|= GPGME_CREATE_SIGN
;
1357 else if (!strcmp (value
, "encrypt"))
1358 client
->crypto
->save
.flags
|= GPGME_CREATE_ENCR
;
1359 else if (!strcmp (value
, "default"))
1360 client
->crypto
->save
.flags
&= ~(GPGME_CREATE_ENCR
|GPGME_CREATE_SIGN
);
1362 return GPG_ERR_INV_VALUE
;
1368 parse_genkey_opt_subkey_of (void *data
, void *v
)
1371 struct client_s
*client
= data
;
1373 char *tmp
[] = { value
, NULL
};
1374 gpgme_key_t
*keys
= NULL
;
1376 rc
= peer_is_invoker (client
);
1378 return rc
== GPG_ERR_EACCES
? GPG_ERR_FORBIDDEN
: rc
;
1380 if (!value
|| !*value
)
1381 return GPG_ERR_INV_VALUE
;
1383 rc
= crypto_list_keys (client
->crypto
, tmp
, 1, &keys
);
1387 if (!keys
|| !*keys
)
1389 crypto_free_key_list (keys
);
1390 return GPG_ERR_NO_SECKEY
;
1393 client
->crypto
->save
.mainkey
= keys
;
1398 genkey_command (assuan_context_t ctx
, char *line
)
1400 struct client_s
*client
= assuan_get_pointer (ctx
);
1401 struct crypto_s
*crypto
, *orig
;
1403 struct argv_s
*args
[] = {
1404 &(struct argv_s
) {"userid", OPTION_TYPE_ARG
,
1405 parse_genkey_opt_userid
},
1406 &(struct argv_s
) {"expire", OPTION_TYPE_ARG
,
1407 parse_genkey_opt_expire
},
1408 &(struct argv_s
) {"no-expire", OPTION_TYPE_NOARG
,
1409 parse_genkey_opt_no_expire
},
1410 &(struct argv_s
) {"algo", OPTION_TYPE_ARG
,
1411 parse_genkey_opt_algo
},
1412 &(struct argv_s
) {"no-passphrase", OPTION_TYPE_NOARG
,
1413 parse_genkey_opt_no_passphrase
},
1414 &(struct argv_s
) {"usage", OPTION_TYPE_ARG
,
1415 parse_genkey_opt_usage
},
1416 &(struct argv_s
) {"subkey-of", OPTION_TYPE_ARG
,
1417 parse_genkey_opt_subkey_of
},
1421 if (!(client
->flags
& FLAG_OPEN
))
1422 return send_error (ctx
, GPG_ERR_INV_STATE
);
1424 rc
= crypto_init (&crypto
, ctx
, client
->filename
,
1425 client
->flags
& FLAG_NO_PINENTRY
, NULL
);
1427 return send_error (ctx
, rc
);
1429 pthread_cleanup_push ((void *)crypto_free
, client
->crypto
);
1430 orig
= client
->crypto
;
1431 client
->crypto
= crypto
;
1432 rc
= parse_options (&line
, args
, client
, 0);
1435 if (!client
->crypto
->save
.userid
&& !client
->crypto
->save
.mainkey
)
1436 rc
= GPG_ERR_SYNTAX
;
1439 client
->crypto
->flags
|= CRYPTO_FLAG_NEWFILE
;
1440 rc
= crypto_genkey (client
, client
->crypto
);
1444 pthread_cleanup_pop (0);
1445 crypto_free (crypto
);
1446 client
->crypto
= orig
;
1447 return send_error (ctx
, rc
);
1451 do_delete (assuan_context_t ctx
, char *line
)
1453 struct client_s
*client
= assuan_get_pointer (ctx
);
1454 struct xml_request_s
*req
;
1458 if (!line
|| !*line
)
1459 return GPG_ERR_SYNTAX
;
1461 rc
= xml_new_request (client
, line
, XML_CMD_DELETE
, &req
);
1465 n
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
1466 xml_free_request (req
);
1470 rc
= xml_is_element_owner (client
, n
, 0);
1472 rc
= xml_unlink_node (client
, n
);
1477 /* Won't update cdata->plaintext. Other clients are working on the original or
1478 * copy of the same document. The first client to SAVE wins and requires others
1479 * to reopen the data file due to a checksum error. */
1481 copy_on_write (struct client_s
*client
)
1483 struct cache_data_s
*cdata
;
1485 if (client
->did_cow
)
1488 cdata
= cache_get_data (client
->filename
, NULL
);
1492 xmlDocPtr doc
= xmlCopyDoc (client
->doc
, 1);
1495 return GPG_ERR_ENOMEM
;
1497 rc
= cache_plaintext_set (client
->filename
, doc
, 1);
1504 (void)cache_plaintext_release (&client
->doc
);
1506 client
->did_cow
= 1;
1510 return GPG_ERR_NO_DATA
;
1514 delete_command (assuan_context_t ctx
, char *line
)
1516 struct client_s
*client
= assuan_get_pointer (ctx
);
1518 struct argv_s
*args
[] = {
1519 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
1523 rc
= parse_options (&line
, args
, client
, 1);
1524 if (!rc
&& (client
->opts
& OPT_INQUIRE
) && line
&& *line
)
1525 rc
= GPG_ERR_SYNTAX
;
1527 return send_error (ctx
, rc
);
1529 rc
= copy_on_write (client
);
1531 return send_error (ctx
, rc
);
1533 if (client
->opts
& OPT_INQUIRE
)
1535 unsigned char *result
;
1538 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
1540 return send_error (ctx
, rc
);
1542 pthread_cleanup_push ((void *)xfree
, result
);
1543 rc
= do_delete (ctx
, (char *)result
);
1544 pthread_cleanup_pop (1);
1547 rc
= do_delete (ctx
, line
);
1549 return send_error (ctx
, rc
);
1553 update_element_expirey (struct client_s
*client
, xmlNodePtr n
)
1556 xmlChar
*expire
, *incr
;
1558 time_t e
, e_orig
, i
;
1559 time_t now
= time (NULL
);
1561 expire
= xml_attribute_value (n
, (xmlChar
*)"_expire");
1566 e
= strtoul ((char *)expire
, &p
, 10);
1567 if (errno
|| *p
|| e
== ULONG_MAX
|| *expire
== '-')
1570 rc
= GPG_ERR_ERANGE
;
1575 incr
= xml_attribute_value (n
, (xmlChar
*)"_age");
1579 i
= strtoul ((char *)incr
, &p
, 10);
1580 if (errno
|| *p
|| i
== ULONG_MAX
|| *incr
== '-')
1583 rc
= GPG_ERR_ERANGE
;
1590 p
= str_asprintf ("%lu", e
);
1593 rc
= GPG_ERR_ENOMEM
;
1597 rc
= xml_add_attribute (client
, n
, "_expire", p
);
1600 rc
= send_status (client
->ctx
, STATUS_EXPIRE
, "%lu %lu", e_orig
, e
);
1607 parse_opt_store_no_acl_inherit (void *data
, void *value
)
1609 struct client_s
*client
= data
;
1612 client
->flags
|= FLAG_NO_INHERIT_ACL
;
1617 store_command (assuan_context_t ctx
, char *line
)
1619 struct client_s
*client
= assuan_get_pointer (ctx
);
1622 unsigned char *result
;
1623 xmlNodePtr n
, parent
;
1625 char *content
= NULL
;
1626 struct xml_request_s
*req
;
1627 struct argv_s
*args
[] = {
1628 &(struct argv_s
) {"no-inherit-acl", OPTION_TYPE_NOARG
,
1629 parse_opt_store_no_acl_inherit
},
1633 rc
= parse_options (&line
, args
, client
, 1);
1635 return send_error (ctx
, rc
);
1637 if (!client
->bulk_p
&& line
&& *line
)
1638 return send_error (ctx
, GPG_ERR_SYNTAX
);
1640 rc
= copy_on_write (client
);
1642 return send_error (ctx
, rc
);
1644 if (!client
->bulk_p
)
1646 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
1648 return send_error (ctx
, rc
);
1649 rc
= xml_new_request (client
, (char *)result
, XML_CMD_STORE
, &req
);
1650 if (!result
|| !*result
)
1653 return send_error (ctx
, GPG_ERR_SYNTAX
);
1656 len
= strv_length (req
->args
);
1657 has_content
= result
[strlen ((char *)result
) - 1] != '\t' && len
> 1;
1662 rc
= xml_new_request (client
, line
, XML_CMD_STORE
, &req
);
1663 len
= strv_length (req
->args
);
1664 has_content
= line
&& line
[strlen (line
) - 1] != '\t' && len
> 1;
1668 return send_error (ctx
, rc
);
1670 /* Prevent passing the element content around to save some memory
1672 if (*(req
->args
+1) && !xml_valid_element_path (req
->args
, has_content
))
1674 xml_free_request (req
);
1675 return send_error (ctx
, GPG_ERR_INV_VALUE
);
1678 if (has_content
|| !*req
->args
[len
-1])
1680 content
= req
->args
[len
-1];
1681 req
->args
[len
-1] = NULL
;
1684 if (strv_length (req
->args
) > 1)
1686 rc
= xml_check_recursion (client
, req
);
1687 if (rc
&& rc
!= GPG_ERR_ELEMENT_NOT_FOUND
)
1691 parent
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
1695 rc
= xml_is_element_owner (client
, parent
, 0);
1698 n
= xml_find_text_node (parent
->children
);
1700 xmlNodeSetContent (n
, (xmlChar
*) content
);
1702 xmlNodeAddContent (parent
, (xmlChar
*) content
);
1704 (void)xml_update_element_mtime (client
, parent
);
1705 (void)update_element_expirey (client
, parent
);
1711 xml_free_request (req
);
1712 return send_error (ctx
, rc
);
1716 xfer_data (assuan_context_t ctx
, const char *line
, int total
)
1718 struct client_s
*client
= assuan_get_pointer (ctx
);
1719 int to_send
= total
< ASSUAN_LINELENGTH
? total
: ASSUAN_LINELENGTH
;
1723 if (!(client
->flags
& FLAG_LOCK_CMD
))
1724 rc
= unlock_file_mutex (client
, 0);
1725 if (rc
&& rc
!= GPG_ERR_NOT_LOCKED
)
1730 client
->bulk_p
->result
= xmalloc (total
+1);
1731 if (!client
->bulk_p
->result
)
1732 return GPG_ERR_ENOMEM
;
1733 memcpy (client
->bulk_p
->result
, line
, total
);
1734 client
->bulk_p
->result
[total
] = 0;
1735 client
->bulk_p
->result_len
= total
;
1739 rc
= send_status (ctx
, STATUS_XFER
, "%li %li", sent
, total
);
1745 if (sent
+ to_send
> total
)
1746 to_send
= total
- sent
;
1748 rc
= assuan_send_data (ctx
, (char *) line
+ sent
, to_send
);
1752 while (!rc
&& sent
< total
);
1758 do_get (assuan_context_t ctx
, char *line
)
1760 struct client_s
*client
= assuan_get_pointer (ctx
);
1762 struct xml_request_s
*req
;
1765 if (!line
|| !*line
)
1766 return GPG_ERR_SYNTAX
;
1768 rc
= xml_new_request (client
, line
, XML_CMD_NONE
, &req
);
1772 n
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
1775 if (n
&& n
->children
)
1779 n
= xml_find_text_node (n
->children
);
1780 if (!n
|| !n
->content
|| !*n
->content
)
1781 rc
= GPG_ERR_NO_DATA
;
1784 rc
= xfer_data (ctx
, (char *) n
->content
, xmlStrlen (n
->content
));
1787 xmlChar
*expire
= xml_attribute_value (tmp
,
1788 (xmlChar
*)"_expire");
1791 time_t now
= time (NULL
);
1796 e
= strtoul ((char *)expire
, &p
, 10);
1797 if (errno
|| *p
|| e
== ULONG_MAX
|| *expire
== '-')
1798 log_write (_("invalid expire attribute value: %s"),
1802 pthread_cleanup_push (xmlFree
, expire
);
1803 rc
= send_status (ctx
, STATUS_EXPIRE
, "%lu 0", e
);
1804 pthread_cleanup_pop (0);
1813 rc
= GPG_ERR_NO_DATA
;
1816 xml_free_request (req
);
1821 get_command (assuan_context_t ctx
, char *line
)
1823 struct client_s
*client
= assuan_get_pointer (ctx
);
1825 struct argv_s
*args
[] = {
1826 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
1830 rc
= parse_options (&line
, args
, client
, 1);
1831 if (!rc
&& (client
->opts
& OPT_INQUIRE
) && line
&& *line
)
1832 rc
= GPG_ERR_SYNTAX
;
1834 return send_error (ctx
, rc
);
1836 if (client
->opts
& OPT_INQUIRE
)
1838 unsigned char *result
;
1841 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
1843 return send_error (ctx
, rc
);
1845 pthread_cleanup_push ((void *)xfree
, result
);
1846 rc
= do_get (ctx
, (char *)result
);
1847 pthread_cleanup_pop (1);
1850 rc
= do_get (ctx
, line
);
1852 return send_error (ctx
, rc
);
1855 static void list_command_free1 (void *arg
);
1857 realpath_command (assuan_context_t ctx
, char *line
)
1860 char **realpath
= NULL
;
1861 struct client_s
*client
= assuan_get_pointer (ctx
);
1862 struct argv_s
*args
[] = {
1863 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
1867 rc
= parse_options (&line
, args
, client
, 1);
1868 if (!rc
&& (client
->opts
& OPT_INQUIRE
) && line
&& *line
)
1869 rc
= GPG_ERR_SYNTAX
;
1871 return send_error (ctx
, rc
);
1873 if (client
->opts
& OPT_INQUIRE
)
1875 unsigned char *result
;
1878 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
1880 return send_error (ctx
, rc
);
1882 pthread_cleanup_push ((void *)xfree
, result
);
1883 (void)xml_resolve_path (client
, client
->doc
, result
, &realpath
, &rc
);
1884 pthread_cleanup_pop (1);
1887 (void)xml_resolve_path (client
, client
->doc
, (unsigned char *)line
,
1892 char *tmp
= strv_join ((char *)"\t", realpath
);
1894 strv_free (realpath
);
1896 return send_error (ctx
, GPG_ERR_ENOMEM
);
1898 pthread_cleanup_push ((void *)xfree
, tmp
);
1899 rc
= xfer_data (ctx
, tmp
, strlen (tmp
));
1900 pthread_cleanup_pop (1);
1903 return send_error (ctx
, rc
);
1907 list_command_free1 (void *arg
)
1910 string_free ((struct string_s
*) arg
, 1);
1914 parse_list_opt_recurse (void *data
, void *value
)
1916 struct client_s
*client
= data
;
1919 client
->opts
|= OPT_LIST_RECURSE
;
1924 parse_opt_verbose (void *data
, void *value
)
1926 struct client_s
*client
= data
;
1929 client
->opts
|= OPT_VERBOSE
;
1934 parse_opt_sexp (void *data
, void *value
)
1936 struct client_s
*client
= data
;
1939 client
->opts
|= OPT_SEXP
;
1944 list_path_once (struct client_s
*client
, char *line
,
1945 struct element_list_s
*elements
, struct string_s
*result
)
1949 rc
= xml_create_path_list (client
, client
->doc
, NULL
, elements
, line
, 0);
1950 if (rc
== GPG_ERR_ELOOP
|| rc
== GPG_ERR_EACCES
)
1955 int total
= slist_length (elements
->list
);
1961 for (i
= 0; i
< total
; i
++)
1963 char *tmp
= slist_nth_data (elements
->list
, i
);
1965 string_append_printf (result
, "%s%s", tmp
,
1966 i
+ 1 == total
? "" : "\n");
1970 rc
= GPG_ERR_NO_DATA
;
1976 #define RESUMABLE_ERROR(rc) (rc == GPG_ERR_ELOOP || rc == GPG_ERR_EACCES \
1977 || rc == GPG_ERR_ELEMENT_NOT_FOUND || !rc)
1979 attribute_list_common (struct client_s
*client
, const char *path
,
1982 char **attrlist
= NULL
;
1986 xmlNodePtr n
, an
, r
;
1988 struct xml_request_s
*req
;
1990 rc
= xml_new_request (client
, path
, XML_CMD_ATTR_LIST
, &req
);
1994 n
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
1995 xml_free_request (req
);
1999 gpg_error_t acl_rc
= 0;
2001 acl_rc
= xml_acl_check (client
, n
);
2002 for (a
= n
->properties
; a
; a
= a
->next
)
2005 int reserved
= xml_reserved_attribute ((char *)a
->name
);
2007 if (acl_rc
== GPG_ERR_EACCES
&& !reserved
)
2009 else if (acl_rc
&& acl_rc
!= GPG_ERR_EACCES
)
2015 if (reserved
&& target
)
2018 pa
= xrealloc (attrlist
, (i
+ 2) * sizeof (char *));
2021 log_write ("%s(%i): %s", __FILE__
, __LINE__
,
2022 pwmd_strerror (GPG_ERR_ENOMEM
));
2023 rc
= GPG_ERR_ENOMEM
;
2029 attrlist
[i
] = str_asprintf ("%s %s", (char *) a
->name
, an
&& an
->content
2030 ? (char *)an
->content
: "");
2034 log_write ("%s(%i): %s", __FILE__
, __LINE__
,
2035 pwmd_strerror (GPG_ERR_ENOMEM
));
2036 rc
= GPG_ERR_ENOMEM
;
2040 attrlist
[++i
] = NULL
;
2043 if (!rc
&& !attrlist
)
2044 return GPG_ERR_NO_DATA
;
2048 r
= xml_resolve_path (client
, client
->doc
, (xmlChar
*)path
, NULL
, &rc
);
2049 if (RESUMABLE_ERROR (rc
))
2064 strv_free (attrlist
);
2070 create_list_sexp (struct client_s
*client
, struct string_s
*string
,
2071 struct string_s
**r_string
)
2073 struct string_s
*str
= string
;
2075 struct string_s
*result
= string_new ("(11:list-result");
2076 char **strv
= str_split (str
->str
, "\n", 0);
2077 int t
= strv_length (strv
);
2080 string_large (result
);
2082 for (i
= 0; i
< t
; i
++)
2084 char **tmpv
= str_split (strv
[i
], " ", 0);
2085 char **attrlist
= NULL
;
2087 result
= string_append_printf (result
, "(4:path%i:%s", strlen (tmpv
[0]),
2090 result
= string_append_printf (result
, "5:flags%i:%s", strlen (tmpv
[1]),
2093 result
= string_append (result
, "5:flags0:");
2095 rc
= attribute_list_common (client
, tmpv
[0], &attrlist
);
2099 int at
= strv_length (attrlist
);
2101 result
= string_append (result
, "(5:attrs");
2103 for (ai
= 0; ai
< at
; ai
++)
2105 char **attrv
= str_split (attrlist
[ai
], " ", 0);
2106 char *value
= strv_join (" ", attrv
+1);
2108 result
= string_append_printf (result
, "%i:%s%i:%s",
2109 strlen (attrv
[0]), attrv
[0],
2110 strlen (value
), value
);
2115 result
= string_append (result
, ")");
2118 result
= string_append (result
, ")");
2119 strv_free (attrlist
);
2124 result
= string_append (result
, ")");
2132 do_list (assuan_context_t ctx
, char *line
)
2134 struct client_s
*client
= assuan_get_pointer (ctx
);
2135 gpg_error_t rc
= GPG_ERR_NO_DATA
;
2136 struct element_list_s
*elements
= NULL
;
2137 struct string_s
*result
= NULL
;
2139 if (!line
|| !*line
)
2141 struct string_s
*str
= string_new (NULL
);
2145 return GPG_ERR_ENOMEM
;
2148 pthread_cleanup_push ((void *)list_command_free1
, str
);
2149 n
= xmlDocGetRootElement (client
->doc
);
2150 for (n
= n
->children
; n
; n
= n
->next
)
2154 if (n
->type
!= XML_ELEMENT_NODE
)
2157 name
= xmlGetProp (n
, (xmlChar
*)"_name");
2160 rc
= GPG_ERR_ENOMEM
;
2164 elements
= xcalloc (1, sizeof (struct element_list_s
));
2168 rc
= GPG_ERR_ENOMEM
;
2172 elements
->prefix
= string_new (NULL
);
2173 if (!elements
->prefix
)
2176 xml_free_element_list (elements
);
2177 rc
= GPG_ERR_ENOMEM
;
2181 elements
->recurse
= client
->opts
& OPT_LIST_RECURSE
;
2182 elements
->root_only
= !elements
->recurse
;
2183 pthread_cleanup_push ((void *)xml_free_element_list
, elements
);
2184 rc
= list_path_once (client
, (char *)name
, elements
, str
);
2186 pthread_cleanup_pop (1);
2191 string_append (str
, "\n");
2196 if (client
->opts
& OPT_SEXP
)
2198 rc
= create_list_sexp (client
, str
, &result
);
2201 pthread_cleanup_push ((void *)list_command_free1
, result
);
2202 rc
= xfer_data (ctx
, result
->str
, result
->len
);
2203 pthread_cleanup_pop (1);
2207 rc
= xfer_data (ctx
, str
->str
, str
->len
);
2210 pthread_cleanup_pop (1);
2214 elements
= xcalloc (1, sizeof (struct element_list_s
));
2216 return GPG_ERR_ENOMEM
;
2218 elements
->prefix
= string_new (NULL
);
2219 if (!elements
->prefix
)
2221 xml_free_element_list (elements
);
2222 return GPG_ERR_ENOMEM
;
2225 elements
->recurse
= client
->opts
& OPT_LIST_RECURSE
;
2226 pthread_cleanup_push ((void *)xml_free_element_list
, elements
);
2227 struct string_s
*str
= string_new (NULL
);
2229 pthread_cleanup_push ((void *)list_command_free1
, str
);
2230 rc
= list_path_once (client
, line
, elements
, str
);
2233 if (client
->opts
& OPT_SEXP
)
2235 rc
= create_list_sexp (client
, str
, &result
);
2238 pthread_cleanup_push ((void *)list_command_free1
, result
);
2239 rc
= xfer_data (ctx
, result
->str
, result
->len
);
2240 pthread_cleanup_pop (1);
2244 rc
= xfer_data (ctx
, str
->str
, str
->len
);
2247 pthread_cleanup_pop (1);
2248 pthread_cleanup_pop (1);
2253 list_command (assuan_context_t ctx
, char *line
)
2255 struct client_s
*client
= assuan_get_pointer (ctx
);
2257 struct argv_s
*args
[] = {
2258 &(struct argv_s
) {"recurse", OPTION_TYPE_NOARG
, parse_list_opt_recurse
},
2259 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
2260 /* These are deprecated but kept for backward compatibility with older
2262 &(struct argv_s
) {"verbose", OPTION_TYPE_NOARG
, NULL
},
2263 &(struct argv_s
) {"with-target", OPTION_TYPE_NOARG
, NULL
},
2264 &(struct argv_s
) {"all", OPTION_TYPE_NOARG
, parse_list_opt_recurse
},
2265 &(struct argv_s
) {"no-recurse", OPTION_TYPE_NOARG
, NULL
},
2266 &(struct argv_s
) {"sexp", OPTION_TYPE_NOARG
, parse_opt_sexp
},
2270 if (disable_list_and_dump
== 1)
2271 return send_error (ctx
, GPG_ERR_NOT_IMPLEMENTED
);
2273 rc
= parse_options (&line
, args
, client
, 1);
2274 if (!rc
&& (client
->opts
& OPT_INQUIRE
) && line
&& *line
)
2275 rc
= GPG_ERR_SYNTAX
;
2277 return send_error (ctx
, rc
);
2279 if (client
->opts
& OPT_INQUIRE
)
2281 unsigned char *result
;
2284 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
2286 return send_error (ctx
, rc
);
2288 pthread_cleanup_push ((void *)xfree
, result
);
2289 rc
= do_list (ctx
, (char *)result
);
2290 pthread_cleanup_pop (1);
2293 rc
= do_list (ctx
, line
);
2295 return send_error (ctx
, rc
);
2299 * args[0] - element path
2302 attribute_list (assuan_context_t ctx
, char **args
)
2304 struct client_s
*client
= assuan_get_pointer (ctx
);
2305 char **attrlist
= NULL
;
2309 if (!args
|| !args
[0] || !*args
[0])
2310 return GPG_ERR_SYNTAX
;
2312 rc
= attribute_list_common (client
, args
[0], &attrlist
);
2313 pthread_cleanup_push ((void *)req_free
, attrlist
);
2317 line
= strv_join ("\n", attrlist
);
2320 pthread_cleanup_push ((void *)xfree
, line
);
2321 rc
= xfer_data (ctx
, line
, strlen (line
));
2322 pthread_cleanup_pop (1);
2326 log_write ("%s(%i): %s", __FILE__
, __LINE__
,
2327 pwmd_strerror (GPG_ERR_ENOMEM
));
2328 rc
= GPG_ERR_ENOMEM
;
2332 pthread_cleanup_pop (1);
2337 * args[0] - attribute
2338 * args[1] - element path
2341 attribute_delete (struct client_s
*client
, char **args
)
2346 if (!args
|| !args
[0] || !*args
[0] || !args
[1] || !*args
[1])
2347 return GPG_ERR_SYNTAX
;
2349 rc
= xml_protected_attr (args
[0]);
2350 if (rc
|| !strcmp (args
[0], "_target"))
2351 return rc
? rc
: GPG_ERR_EPERM
;
2353 rc
= copy_on_write (client
);
2357 if (!xml_reserved_attribute (args
[0]))
2358 n
= xml_resolve_path (client
, client
->doc
, (xmlChar
*)args
[1], NULL
, &rc
);
2361 struct xml_request_s
*req
;
2363 rc
= xml_new_request (client
, args
[1], XML_CMD_ATTR
, &req
);
2367 n
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
2368 xml_free_request (req
);
2372 rc
= xml_is_element_owner (client
, n
, 0);
2375 rc
= xml_delete_attribute (client
, n
, (xmlChar
*) args
[0]);
2381 * Creates the "_target" attribute. When other commands encounter an element
2382 * with this attribute they follow the "_target" after appending remaining
2383 * elements from the original element path to the target. The exception is the
2384 * ATTR command that operates on the element itself (for reserved attribute
2385 * names) and not the target.
2387 * If the source element path doesn't exist when using 'ATTR SET target', it is
2388 * created, but the destination element path must exist. This is similar to the
2389 * ls(1) command: ln -s src dst.
2391 * args[0] - source element path
2392 * args[1] - destination element path
2395 set_target_attribute (struct client_s
*client
, char **args
)
2397 struct xml_request_s
*req
= NULL
;
2402 if (!args
|| !args
[0] || !args
[1])
2403 return GPG_ERR_SYNTAX
;
2405 src
= str_split (args
[0], "\t", 0);
2407 return GPG_ERR_SYNTAX
;
2409 if (!xml_valid_element_path (src
, 0))
2412 return GPG_ERR_INV_VALUE
;
2415 dst
= str_split (args
[1], "\t", 0);
2419 return GPG_ERR_SYNTAX
;
2422 rc
= copy_on_write (client
);
2426 // Be sure the destination element path exists. */
2427 rc
= xml_new_request (client
, args
[1], XML_CMD_NONE
, &req
);
2431 (void)xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
2432 if (rc
&& rc
!= GPG_ERR_EACCES
)
2435 xml_free_request (req
);
2438 if (!strcmp (args
[0], args
[1]))
2440 rc
= GPG_ERR_EEXIST
;
2444 rc
= xml_new_request (client
, args
[0], XML_CMD_ATTR_TARGET
, &req
);
2448 n
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
2449 if (rc
&& rc
!= GPG_ERR_EACCES
)
2454 rc
= xml_add_attribute (client
, n
, "_target", args
[1]);
2457 rc
= xml_remove_user_attributes (client
, n
);
2459 rc
= xml_unlink_node (client
, n
->children
);
2466 xml_free_request (req
);
2471 * args[0] - attribute
2472 * args[1] - element path
2475 attribute_get (assuan_context_t ctx
, char **args
)
2477 struct client_s
*client
= assuan_get_pointer (ctx
);
2481 struct xml_request_s
*req
;
2483 if (!args
|| !args
[0] || !*args
[0] || !args
[1] || !*args
[1])
2484 return GPG_ERR_SYNTAX
;
2486 if (!xml_reserved_attribute (args
[0]))
2487 n
= xml_resolve_path (client
, client
->doc
, (xmlChar
*)args
[1], NULL
, &rc
);
2490 rc
= xml_new_request (client
, args
[1], XML_CMD_ATTR
, &req
);
2494 n
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
2495 xml_free_request (req
);
2501 a
= xmlGetProp (n
, (xmlChar
*) args
[0]);
2503 return GPG_ERR_NOT_FOUND
;
2505 pthread_cleanup_push ((void *)xmlFree
, a
);
2508 rc
= xfer_data (ctx
, (char *) a
, xmlStrlen (a
));
2510 rc
= GPG_ERR_NO_DATA
;
2512 pthread_cleanup_pop (1);
2517 * args[0] - attribute
2518 * args[1] - element path
2522 attribute_set (struct client_s
*client
, char **args
)
2524 struct xml_request_s
*req
;
2528 if (!args
|| !args
[0] || !args
[1])
2529 return GPG_ERR_SYNTAX
;
2532 * Reserved attribute names.
2534 if ((rc
= xml_protected_attr (args
[0])))
2536 else if (!strcmp (args
[0], "_target"))
2537 return set_target_attribute (client
, args
+ 1);
2538 else if (!strcmp (args
[0], "_acl"))
2539 rc
= xml_valid_username (args
[2]);
2540 else if (!xml_valid_attribute (args
[0]))
2541 return GPG_ERR_INV_VALUE
;
2546 if (!xml_valid_attribute_value (args
[2]))
2547 return GPG_ERR_INV_VALUE
;
2549 rc
= copy_on_write (client
);
2553 if (!xml_reserved_attribute (args
[0]))
2555 n
= xml_resolve_path (client
, client
->doc
, (xmlChar
*)args
[1], NULL
, &rc
);
2558 rc
= xml_new_request (client
, args
[1], XML_CMD_NONE
, &req
);
2561 rc
= xml_check_recursion (client
, req
);
2562 xml_free_request (req
);
2568 rc
= xml_new_request (client
, args
[1], XML_CMD_ATTR
, &req
);
2572 n
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
2573 xml_free_request (req
);
2577 rc
= xml_is_element_owner (client
, n
, 0);
2580 rc
= xml_add_attribute (client
, n
, args
[0], args
[2]);
2587 * req[1] - attribute name or element path if command is LIST
2588 * req[2] - element path
2589 * req[2] - element path or value
2593 do_attr (assuan_context_t ctx
, char *line
)
2595 struct client_s
*client
= assuan_get_pointer (ctx
);
2599 if (!line
|| !*line
)
2600 return GPG_ERR_SYNTAX
;
2602 req
= str_split (line
, " ", 4);
2603 if (!req
|| !req
[0] || !req
[1])
2606 return GPG_ERR_SYNTAX
;
2609 pthread_cleanup_push ((void *)req_free
, req
);
2611 if (strcasecmp (req
[0], "SET") == 0)
2612 rc
= attribute_set (client
, req
+ 1);
2613 else if (strcasecmp (req
[0], "GET") == 0)
2614 rc
= attribute_get (ctx
, req
+ 1);
2615 else if (strcasecmp (req
[0], "DELETE") == 0)
2616 rc
= attribute_delete (client
, req
+ 1);
2617 else if (strcasecmp (req
[0], "LIST") == 0)
2618 rc
= attribute_list (ctx
, req
+ 1);
2620 rc
= GPG_ERR_SYNTAX
;
2622 client
->flags
&= ~(FLAG_ACL_IGNORE
|FLAG_ACL_ERROR
);
2623 pthread_cleanup_pop (1);
2628 attr_command (assuan_context_t ctx
, char *line
)
2630 struct client_s
*client
= assuan_get_pointer (ctx
);
2632 struct argv_s
*args
[] = {
2633 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
2637 rc
= parse_options (&line
, args
, client
, 1);
2638 if (!rc
&& (client
->opts
& OPT_INQUIRE
) && line
&& *line
)
2639 rc
= GPG_ERR_SYNTAX
;
2641 return send_error (ctx
, rc
);
2643 if (client
->opts
& OPT_INQUIRE
)
2645 unsigned char *result
;
2648 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
2650 return send_error (ctx
, rc
);
2652 pthread_cleanup_push ((void *)xfree
, result
);
2653 rc
= do_attr (ctx
, (char *)result
);
2654 pthread_cleanup_pop (1);
2657 rc
= do_attr (ctx
, line
);
2659 return send_error (ctx
, rc
);
2663 parse_iscached_opt_lock (void *data
, void *value
)
2665 struct client_s
*client
= data
;
2668 client
->opts
|= OPT_LOCK
;
2673 parse_iscached_opt_agent (void *data
, void *value
)
2675 struct client_s
*client
= data
;
2678 client
->opts
|= OPT_CACHE_AGENT
;
2683 parse_iscached_opt_sign (void *data
, void *value
)
2685 struct client_s
*client
= data
;
2688 client
->opts
|= OPT_CACHE_SIGN
;
2693 iscached_command (assuan_context_t ctx
, char *line
)
2695 struct client_s
*client
= assuan_get_pointer (ctx
);
2698 struct argv_s
*args
[] = {
2699 &(struct argv_s
) {"lock", OPTION_TYPE_NOARG
, parse_iscached_opt_lock
},
2700 &(struct argv_s
) {"agent", OPTION_TYPE_NOARG
, parse_iscached_opt_agent
},
2701 &(struct argv_s
) {"sign", OPTION_TYPE_NOARG
, parse_iscached_opt_sign
},
2705 if (!line
|| !*line
)
2706 return send_error (ctx
, GPG_ERR_SYNTAX
);
2708 rc
= parse_options (&line
, args
, client
, 1);
2710 return send_error (ctx
, rc
);
2711 else if (!valid_filename (line
))
2712 return send_error (ctx
, GPG_ERR_INV_VALUE
);
2714 if (!(client
->flags
& FLAG_OPEN
)
2715 && ((client
->opts
& OPT_CACHE_AGENT
) || (client
->opts
& OPT_CACHE_SIGN
)))
2716 return send_error (ctx
, GPG_ERR_INV_STATE
);
2718 rc
= cache_iscached (line
, &defer
, (client
->opts
& OPT_CACHE_AGENT
),
2719 (client
->opts
& OPT_CACHE_SIGN
));
2721 rc
= GPG_ERR_NO_DATA
;
2725 struct cache_data_s
*cdata
= cache_get_data (line
, NULL
);
2729 rc
= validate_checksum (client
, line
, cdata
, NULL
, NULL
, 1);
2730 if (rc
== GPG_ERR_CHECKSUM
)
2731 rc
= GPG_ERR_NO_DATA
;
2735 if (client
->opts
& OPT_LOCK
2736 && (!rc
|| gpg_err_code (rc
) == GPG_ERR_NO_DATA
2737 || gpg_err_code (rc
) == GPG_ERR_ENOENT
))
2739 gpg_error_t trc
= rc
;
2741 if (client
->filename
&& strcmp (line
, client
->filename
))
2742 reset_client (client
);
2744 xfree (client
->filename
);
2745 client
->filename
= str_dup (line
);
2746 rc
= do_lock (client
, 1);
2751 return send_error (ctx
, rc
);
2755 clearcache_command (assuan_context_t ctx
, char *line
)
2757 struct client_s
*client
= assuan_get_pointer (ctx
);
2758 gpg_error_t rc
= 0, all_rc
= 0;
2762 struct client_thread_s
*once
= NULL
;
2766 pthread_cleanup_push (cache_release_mutex
, NULL
);
2767 count
= cache_file_count ();
2768 MUTEX_LOCK (&cn_mutex
);
2769 pthread_cleanup_push ((void *)release_mutex_cb
, &cn_mutex
);
2771 if (!line
|| !*line
)
2774 t
= slist_length (cn_thread_list
);
2776 for (i
= 0; i
< t
; i
++)
2778 struct client_thread_s
*thd
= slist_nth_data (cn_thread_list
, i
);
2779 assuan_peercred_t peer
;
2784 /* Lock each connected clients' file mutex to prevent any other client
2785 * from accessing the cache entry (the file mutex is locked upon
2786 * command startup). The cache for the entry is not cleared if the
2787 * file mutex is locked by another client to prevent this function
2788 * from blocking. Rather, it returns an error.
2792 if (thd
->cl
->filename
)
2794 rc
= do_validate_peer (ctx
, thd
->cl
->filename
, &peer
, NULL
);
2795 /* The current client doesn't have permission to open the other
2796 * filename do to "access" configuration parameter in a filename
2797 * section. Since we are clearning all cache entries the error
2798 * will be returned later during cache_clear(). */
2805 else // Idle client without opened file?
2808 rc
= cache_lock_mutex (thd
->cl
->ctx
, thd
->cl
->filename
, -1, 0, -1);
2809 if (gpg_err_code (rc
) == GPG_ERR_LOCKED
)
2811 /* The current client owns the lock. */
2812 if (pthread_equal (pthread_self (), thd
->tid
))
2816 if (cache_iscached (thd
->cl
->filename
, NULL
, 0, 0)
2823 /* The cache entry will be cleared when the other client
2824 * disconnects and cache_timer_thread() does its thing. */
2825 cache_defer_clear (thd
->cl
->filename
);
2828 else if (gpg_err_code (rc
) == GPG_ERR_NO_DATA
)
2836 rc
= cache_clear (NULL
, thd
->cl
->filename
, 1, 0);
2837 cache_unlock_mutex (thd
->cl
->filename
, 0);
2847 /* A single data filename was specified. Lock only this data file
2848 * mutex and free the cache entry. */
2849 rc
= do_validate_peer (ctx
, line
, &peer
, NULL
);
2850 if (rc
== GPG_ERR_FORBIDDEN
)
2851 rc
= peer_is_invoker (client
);
2853 if (rc
== GPG_ERR_EACCES
)
2854 rc
= GPG_ERR_FORBIDDEN
;
2856 if (!rc
&& thd
->cl
->filename
&& !strcmp (thd
->cl
->filename
, line
))
2858 rc
= cache_lock_mutex (thd
->cl
->ctx
, thd
->cl
->filename
, -1, 0, -1);
2859 if (gpg_err_code (rc
) == GPG_ERR_LOCKED
)
2861 /* The current client owns the lock. */
2862 if (pthread_equal (pthread_self (), thd
->tid
))
2869 rc
= cache_clear (NULL
, thd
->cl
->filename
, 1, 0);
2870 cache_unlock_mutex (thd
->cl
->filename
, 0);
2873 cache_defer_clear (thd
->cl
->filename
);
2875 /* Found a client with the opened file. The cache entry has been
2876 * either cleared (self) or deferred to be cleared. */
2882 /* Only connected clients' cache entries have been cleared. Now clear any
2883 * remaining cache entries without clients but only if there wasn't an
2884 * error from above since this would defeat the locking check of the
2885 * remaining entries. */
2886 if (all
&& !all_rc
&& cache_file_count ())
2888 rc
= cache_clear (client
, NULL
, 1, 0);
2889 if (rc
== GPG_ERR_EACCES
)
2890 rc
= GPG_ERR_FORBIDDEN
;
2893 /* No clients are using the specified file. */
2894 else if (!all_rc
&& !rc
&& !once
)
2895 rc
= cache_clear (NULL
, line
, 1, 0);
2897 /* Release the connection mutex. */
2898 pthread_cleanup_pop (1);
2900 if (!rc
|| (cache_file_count () && count
!= cache_file_count ()))
2901 send_status_all (STATUS_CACHE
, NULL
);
2903 /* Release the cache mutex. */
2904 pthread_cleanup_pop (1);
2906 /* One or more files were locked while clearing all cache entries. */
2910 return send_error (ctx
, rc
);
2914 cachetimeout_command (assuan_context_t ctx
, char *line
)
2916 struct client_s
*client
= assuan_get_pointer (ctx
);
2918 char **req
= str_split (line
, " ", 0);
2922 if (!(client
->flags
& FLAG_OPEN
))
2923 return send_error (ctx
, GPG_ERR_INV_STATE
);
2925 if (!req
|| !*req
|| strv_length (req
) > 1)
2928 return send_error (ctx
, GPG_ERR_SYNTAX
);
2932 timeout
= strtol (req
[0], &p
, 10);
2933 if (errno
!= 0 || *p
|| timeout
< (long)-1)
2934 rc
= GPG_ERR_SYNTAX
;
2938 rc
= cache_set_timeout (client
->filename
, timeout
);
2939 if (!rc
|| gpg_err_code (rc
) == GPG_ERR_NOT_FOUND
)
2942 MUTEX_LOCK (&rcfile_mutex
);
2943 config_set_long_param (&global_config
, client
->filename
,
2944 "cache_timeout", req
[0]);
2945 MUTEX_UNLOCK (&rcfile_mutex
);
2950 return send_error (ctx
, rc
);
2954 dump_command (assuan_context_t ctx
, char *line
)
2958 struct client_s
*client
= assuan_get_pointer (ctx
);
2961 if (disable_list_and_dump
== 1)
2962 return send_error (ctx
, GPG_ERR_NOT_IMPLEMENTED
);
2965 return send_error (ctx
, GPG_ERR_SYNTAX
);
2967 rc
= peer_is_invoker(client
);
2969 return send_error (ctx
, (rc
== GPG_ERR_EACCES
? GPG_ERR_FORBIDDEN
: rc
));
2971 xmlDocDumpFormatMemory (client
->doc
, &xml
, &len
, 1);
2975 log_write ("%s(%i): %s", __FILE__
, __LINE__
,
2976 pwmd_strerror (GPG_ERR_ENOMEM
));
2977 return send_error (ctx
, GPG_ERR_ENOMEM
);
2980 pthread_cleanup_push ((void *)xmlFree
, xml
);
2981 rc
= xfer_data (ctx
, (char *) xml
, len
);
2982 pthread_cleanup_pop (1);
2983 return send_error (ctx
, rc
);
2987 getconfig_command (assuan_context_t ctx
, char *line
)
2989 struct client_s
*client
= assuan_get_pointer (ctx
);
2991 char filename
[255] = { 0 }, param
[747] = { 0 };
2992 char *p
, *tmp
= NULL
, *fp
= client
->filename
, *paramp
= line
;
2994 if (!line
|| !*line
)
2995 return send_error (ctx
, GPG_ERR_SYNTAX
);
2997 if (strchr (line
, ' '))
2999 int ret
= sscanf (line
, " %254[^ ] %746c", filename
, param
);
3002 return send_error (ctx
, gpg_error_from_syserror());
3007 if (fp
&& !valid_filename (fp
))
3008 return send_error (ctx
, GPG_ERR_INV_VALUE
);
3010 paramp
= str_down (paramp
);
3011 p
= config_get_value (fp
? fp
: "global", paramp
);
3013 return send_error (ctx
, GPG_ERR_UNKNOWN_OPTION
);
3015 tmp
= expand_homedir (p
);
3019 log_write ("%s(%i): %s", __FILE__
, __LINE__
,
3020 pwmd_strerror (GPG_ERR_ENOMEM
));
3021 return send_error (ctx
, GPG_ERR_ENOMEM
);
3025 pthread_cleanup_push ((void *)xfree
, p
);
3026 rc
= xfer_data (ctx
, p
, strlen (p
));
3027 pthread_cleanup_pop (1);
3028 return send_error (ctx
, rc
);
3033 xmlXPathContextPtr xp
;
3034 xmlXPathObjectPtr result
;
3040 xpath_command_free (void *arg
)
3042 struct xpath_s
*xpath
= arg
;
3047 req_free (xpath
->req
);
3050 xmlBufferFree (xpath
->buf
);
3053 xmlXPathFreeObject (xpath
->result
);
3056 xmlXPathFreeContext (xpath
->xp
);
3060 do_xpath (assuan_context_t ctx
, char *line
)
3063 struct client_s
*client
= assuan_get_pointer (ctx
);
3064 struct xpath_s _x
= { 0 };
3065 struct xpath_s
*xpath
= &_x
;
3067 if (!line
|| !*line
)
3068 return GPG_ERR_SYNTAX
;
3070 if ((xpath
->req
= str_split (line
, "\t", 2)) == NULL
)
3072 if (strv_printf (&xpath
->req
, "%s", line
) == 0)
3073 return GPG_ERR_ENOMEM
;
3078 rc
= copy_on_write (client
);
3083 xpath
->xp
= xmlXPathNewContext (client
->doc
);
3086 rc
= GPG_ERR_BAD_DATA
;
3091 xmlXPathEvalExpression ((xmlChar
*) xpath
->req
[0], xpath
->xp
);
3094 rc
= GPG_ERR_BAD_DATA
;
3098 if (xmlXPathNodeSetIsEmpty (xpath
->result
->nodesetval
))
3100 rc
= GPG_ERR_ELEMENT_NOT_FOUND
;
3104 rc
= xml_recurse_xpath_nodeset (client
, client
->doc
,
3105 xpath
->result
->nodesetval
,
3106 (xmlChar
*) xpath
->req
[1], &xpath
->buf
, 0,
3110 else if (!xpath
->req
[1] && !xmlBufferLength (xpath
->buf
))
3112 rc
= GPG_ERR_NO_DATA
;
3115 else if (xpath
->req
[1])
3121 pthread_cleanup_push ((void *)xpath_command_free
, &xpath
);
3122 rc
= xfer_data (ctx
, (char *) xmlBufferContent (xpath
->buf
),
3123 xmlBufferLength (xpath
->buf
));
3124 pthread_cleanup_pop (0);
3126 xpath_command_free (xpath
);
3131 xpath_command (assuan_context_t ctx
, char *line
)
3133 struct client_s
*client
= assuan_get_pointer (ctx
);
3135 struct argv_s
*args
[] = {
3136 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
3140 if (disable_list_and_dump
== 1)
3141 return send_error (ctx
, GPG_ERR_NOT_IMPLEMENTED
);
3143 rc
= peer_is_invoker(client
);
3145 return send_error (ctx
, (rc
== GPG_ERR_EACCES
? GPG_ERR_FORBIDDEN
: rc
));
3147 rc
= parse_options (&line
, args
, client
, 1);
3148 if (!rc
&& (client
->opts
& OPT_INQUIRE
) && line
&& *line
)
3149 rc
= GPG_ERR_SYNTAX
;
3151 return send_error (ctx
, rc
);
3153 if (client
->opts
& OPT_INQUIRE
)
3155 unsigned char *result
;
3158 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
3160 return send_error (ctx
, rc
);
3162 pthread_cleanup_push ((void *)xfree
, result
);
3163 rc
= do_xpath (ctx
, (char *)result
);
3164 pthread_cleanup_pop (1);
3167 rc
= do_xpath (ctx
, line
);
3169 return send_error (ctx
, rc
);
3173 do_xpathattr (assuan_context_t ctx
, char *line
)
3175 struct client_s
*client
= assuan_get_pointer (ctx
);
3179 struct xpath_s _x
= { 0 };
3180 struct xpath_s
*xpath
= &_x
;
3182 if (!line
|| !*line
)
3183 return GPG_ERR_SYNTAX
;
3185 if ((req
= str_split (line
, " ", 3)) == NULL
)
3186 return GPG_ERR_ENOMEM
;
3190 rc
= GPG_ERR_SYNTAX
;
3194 if (!strcasecmp (req
[0], "SET"))
3196 else if (!strcasecmp (req
[0], "DELETE"))
3200 rc
= GPG_ERR_SYNTAX
;
3204 if (!req
[1] || !req
[2])
3206 rc
= GPG_ERR_SYNTAX
;
3210 if ((xpath
->req
= str_split (req
[2], "\t", 3)) == NULL
)
3212 rc
= GPG_ERR_ENOMEM
;
3216 if (!xpath
->req
[0] || (!xpath
->req
[1] && !cmd
) || (xpath
->req
[1] && cmd
))
3218 rc
= GPG_ERR_SYNTAX
;
3222 rc
= copy_on_write (client
);
3226 xpath
->xp
= xmlXPathNewContext (client
->doc
);
3229 rc
= GPG_ERR_BAD_DATA
;
3233 xpath
->result
= xmlXPathEvalExpression ((xmlChar
*) xpath
->req
[0], xpath
->xp
);
3236 rc
= GPG_ERR_BAD_DATA
;
3240 if (xmlXPathNodeSetIsEmpty (xpath
->result
->nodesetval
))
3242 rc
= GPG_ERR_ELEMENT_NOT_FOUND
;
3246 rc
= xml_recurse_xpath_nodeset (client
, client
->doc
,
3247 xpath
->result
->nodesetval
,
3248 (xmlChar
*) xpath
->req
[1], &xpath
->buf
, cmd
,
3249 (xmlChar
*) req
[1]);
3252 xpath_command_free (xpath
);
3257 /* XPATHATTR SET|DELETE <name> <expression>[<TAB>[value]] */
3259 xpathattr_command (assuan_context_t ctx
, char *line
)
3261 struct client_s
*client
= assuan_get_pointer (ctx
);
3263 struct argv_s
*args
[] = {
3264 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
3268 if (disable_list_and_dump
== 1)
3269 return send_error (ctx
, GPG_ERR_NOT_IMPLEMENTED
);
3271 rc
= peer_is_invoker(client
);
3273 return send_error (ctx
, (rc
== GPG_ERR_EACCES
? GPG_ERR_FORBIDDEN
: rc
));
3275 rc
= parse_options (&line
, args
, client
, 1);
3276 if (!rc
&& (client
->opts
& OPT_INQUIRE
) && line
&& *line
)
3277 rc
= GPG_ERR_SYNTAX
;
3279 return send_error (ctx
, rc
);
3281 if (client
->opts
& OPT_INQUIRE
)
3283 unsigned char *result
;
3286 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
3288 return send_error (ctx
, rc
);
3290 pthread_cleanup_push ((void *)xfree
, result
);
3291 rc
= do_xpathattr (ctx
, (char *)result
);
3292 pthread_cleanup_pop (1);
3295 rc
= do_xpathattr (ctx
, line
);
3297 return send_error (ctx
, rc
);
3301 do_import (struct client_s
*client
, const char *root_element
,
3302 unsigned char *content
)
3304 xmlDocPtr doc
= NULL
;
3305 xmlNodePtr n
= NULL
, root
;
3307 struct string_s
*str
= NULL
, *tstr
= NULL
;
3308 struct xml_request_s
*req
= NULL
;
3310 if (!content
|| !*content
)
3311 return GPG_ERR_SYNTAX
;
3315 rc
= xml_new_request (client
, root_element
, XML_CMD_STORE
, &req
);
3322 if (!xml_valid_element_path (req
->args
, 0))
3324 xml_free_request (req
);
3326 return GPG_ERR_INV_VALUE
;
3330 str
= string_new_content ((char *)content
);
3331 tstr
= string_prepend (str
, "<pwmd>");
3335 tstr
= string_append (str
, "</pwmd>");
3337 rc
= GPG_ERR_ENOMEM
;
3342 rc
= GPG_ERR_ENOMEM
;
3347 doc
= xmlReadDoc ((xmlChar
*) str
->str
, NULL
, "UTF-8", XML_PARSE_NOBLANKS
);
3348 string_free (str
, 1);
3351 rc
= GPG_ERR_BAD_DATA
;
3355 root
= xmlDocGetRootElement (doc
);
3356 root
= root
->children
;
3357 if (!root
|| root
->type
!= XML_ELEMENT_NODE
)
3359 rc
= GPG_ERR_BAD_DATA
;
3363 rc
= xml_validate_import (client
, root
);
3369 /* Create the new specified root element path, if needed. */
3370 n
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
),
3375 /* Overwrite the children of the specified root element path. */
3376 (void)xml_unlink_node (client
, n
->children
);
3380 n
= xmlDocGetRootElement (client
->doc
);
3385 xmlChar
*name
= xml_attribute_value (root
, (xmlChar
*)"_name");
3388 rc
= GPG_ERR_BAD_DATA
;
3390 rc
= xml_is_element_owner (client
, n
, 0);
3394 /* No --root argument passed. Overwrite the current documents' root
3395 * element matching the root element of the imported data. */
3396 xml_free_request (req
);
3398 rc
= xml_new_request (client
, (char *)name
, XML_CMD_DELETE
, &req
);
3404 tmp
= xml_find_elements (client
, req
,
3405 xmlDocGetRootElement (req
->doc
), &rc
);
3406 if (rc
&& rc
!= GPG_ERR_ELEMENT_NOT_FOUND
)
3411 rc
= xml_is_element_owner (client
, tmp
, 0);
3416 (void)xml_unlink_node (client
, tmp
);
3423 copy
= xmlCopyNodeList (root
);
3425 rc
= GPG_ERR_ENOMEM
;
3428 n
= xmlAddChildList (n
, copy
);
3430 rc
= GPG_ERR_ENOMEM
;
3435 if (!rc
&& n
&& n
->parent
)
3436 rc
= xml_update_element_mtime (client
, n
->parent
);
3439 xml_free_request (req
);
3448 parse_import_opt_root (void *data
, void *value
)
3450 struct client_s
*client
= data
;
3452 client
->import_root
= str_dup (value
);
3453 return client
->import_root
? 0 : GPG_ERR_ENOMEM
;
3457 import_command (assuan_context_t ctx
, char *line
)
3460 struct client_s
*client
= assuan_get_pointer (ctx
);
3461 unsigned char *result
;
3463 struct argv_s
*args
[] = {
3465 "root", OPTION_TYPE_ARG
, parse_import_opt_root
3470 xfree (client
->import_root
);
3471 client
->import_root
= NULL
;
3472 rc
= parse_options (&line
, args
, client
, client
->bulk_p
? 1 : 0);
3474 return send_error (ctx
, rc
);
3476 rc
= copy_on_write (client
);
3478 return send_error (ctx
, rc
);
3480 if (!client
->bulk_p
)
3482 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
3485 xfree (client
->import_root
);
3486 client
->import_root
= NULL
;
3487 return send_error (ctx
, rc
);
3489 rc
= do_import (client
, client
->import_root
, result
);
3493 char *p
= str_dup (line
);
3496 rc
= GPG_ERR_ENOMEM
;
3498 rc
= do_import (client
, client
->import_root
, (unsigned char *)p
);
3501 xfree (client
->import_root
);
3502 client
->import_root
= NULL
;
3503 return send_error (ctx
, rc
);
3507 do_lock (struct client_s
*client
, int add
)
3509 gpg_error_t rc
= lock_file_mutex (client
, add
);
3512 client
->flags
|= FLAG_LOCK_CMD
;
3518 lock_command (assuan_context_t ctx
, char *line
)
3520 struct client_s
*client
= assuan_get_pointer (ctx
);
3524 return send_error (ctx
, GPG_ERR_SYNTAX
);
3526 rc
= do_lock (client
, 0);
3527 return send_error (ctx
, rc
);
3531 unlock_command (assuan_context_t ctx
, char *line
)
3533 struct client_s
*client
= assuan_get_pointer (ctx
);
3537 return send_error (ctx
, GPG_ERR_SYNTAX
);
3539 rc
= unlock_file_mutex (client
, 0);
3540 return send_error (ctx
, rc
);
3544 set_env (const char *name
, char *buf
, size_t size
, const char *value
)
3546 MUTEX_LOCK (&rcfile_mutex
);
3547 if (!value
|| !*value
)
3552 else if (!buf
[0] || strcmp (buf
, value
))
3554 snprintf (buf
, size
, "%s=%s", name
, value
);
3558 MUTEX_UNLOCK (&rcfile_mutex
);
3562 option_command (assuan_context_t ctx
, char *line
)
3564 struct client_s
*client
= assuan_get_pointer (ctx
);
3566 char namebuf
[255] = { 0 };
3567 char *name
= namebuf
;
3568 char *value
= NULL
, *p
, *tmp
= NULL
;
3570 p
= strchr (line
, '=');
3573 strncpy (namebuf
, line
, sizeof(namebuf
));
3574 namebuf
[sizeof(namebuf
)-1] = 0;
3578 tmp
= str_dup (line
);
3580 return send_error (ctx
, GPG_ERR_ENOMEM
);
3582 tmp
[strlen (line
) - strlen (p
)] = 0;
3583 strncpy (namebuf
, tmp
, sizeof (namebuf
));
3584 namebuf
[sizeof(namebuf
)-1] = 0;
3590 log_write2 ("OPTION name='%s' value='%s'", name
, value
);
3592 if (strcasecmp (name
, (char *) "lock-timeout") == 0)
3598 n
= strtol (value
, &tmp
, 10);
3600 return send_error (ctx
, GPG_ERR_INV_VALUE
);
3603 client
->lock_timeout
= n
;
3605 else if (strcasecmp (name
, (char *) "client-state") == 0)
3609 MUTEX_LOCK (&client
->thd
->status_mutex
);
3612 n
= strtol (value
, &tmp
, 10);
3613 if ((tmp
&& *tmp
) || (n
< 0 || n
> 1))
3615 MUTEX_UNLOCK (&client
->thd
->status_mutex
);
3616 return send_error (ctx
, GPG_ERR_INV_VALUE
);
3618 client
->client_state
= n
;
3621 client
->client_state
= 0;
3622 MUTEX_UNLOCK (&client
->thd
->status_mutex
);
3624 else if (strcasecmp (name
, (char *) "NAME") == 0)
3626 if (value
&& strchr (value
, ' '))
3627 rc
= GPG_ERR_INV_VALUE
;
3630 MUTEX_LOCK (&cn_mutex
);
3631 tmp
= pthread_getspecific (thread_name_key
);
3632 pthread_setspecific (thread_name_key
, NULL
);
3634 xfree (client
->thd
->name
);
3635 client
->thd
->name
= NULL
;
3636 if (value
&& *value
)
3638 pthread_setspecific (thread_name_key
, str_dup (value
));
3639 client
->thd
->name
= str_dup (value
);
3641 MUTEX_UNLOCK (&cn_mutex
);
3644 else if (strcasecmp (name
, "disable-pinentry") == 0)
3648 if (value
&& *value
)
3650 n
= (int) strtol (value
, &tmp
, 10);
3651 if (*tmp
|| n
< 0 || n
> 1)
3652 return send_error (ctx
, GPG_ERR_INV_VALUE
);
3656 client
->flags
|= FLAG_NO_PINENTRY
;
3658 client
->flags
&= ~FLAG_NO_PINENTRY
;
3660 else if (strcasecmp (name
, "ttyname") == 0)
3661 set_env ("GPG_TTY", env_gpg_tty
, sizeof (env_gpg_tty
), value
);
3662 else if (strcasecmp (name
, "ttytype") == 0)
3663 set_env ("TERM", env_term
, sizeof (env_term
), value
);
3664 else if (strcasecmp (name
, "display") == 0)
3665 set_env ("DISPLAY", env_display
, sizeof (env_display
), value
);
3666 else if (strcasecmp (name
, "lc_messages") == 0)
3669 else if (strcasecmp (name
, "lc_ctype") == 0)
3672 else if (strcasecmp (name
, "desc") == 0)
3675 else if (strcasecmp (name
, "pinentry-timeout") == 0)
3679 rc
= GPG_ERR_UNKNOWN_OPTION
;
3681 return send_error (ctx
, rc
);
3685 do_rename (assuan_context_t ctx
, char *line
)
3687 struct client_s
*client
= assuan_get_pointer (ctx
);
3689 xmlNodePtr src
, dst
;
3690 struct string_s
*str
= NULL
, *tstr
;
3691 struct xml_request_s
*req
;
3694 if (!line
|| !*line
)
3695 return GPG_ERR_SYNTAX
;
3697 args
= str_split (line
, " ", 0);
3698 if (!args
|| strv_length (args
) != 2)
3701 return GPG_ERR_SYNTAX
;
3704 if (!xml_valid_element ((xmlChar
*) args
[1]))
3707 return GPG_ERR_INV_VALUE
;
3710 rc
= xml_new_request (client
, args
[0], XML_CMD_RENAME
, &req
);
3717 src
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
3721 rc
= xml_is_element_owner (client
, src
, 0);
3725 xmlChar
*a
= xmlGetProp (src
, (xmlChar
*) "_name");
3728 rc
= GPG_ERR_ENOMEM
;
3732 /* To prevent unwanted effects:
3734 * <element _name="a"><element _name="b"/></element>
3738 if (xmlStrEqual (a
, (xmlChar
*) args
[1]))
3741 rc
= GPG_ERR_EEXIST
;
3746 str
= string_new (args
[0]);
3749 rc
= GPG_ERR_ENOMEM
;
3753 p
= strrchr (str
->str
, '\t');
3755 tstr
= string_truncate (str
, strlen (str
->str
)-strlen (p
));
3757 tstr
= string_truncate (str
, 0);
3761 string_free (str
, 1);
3762 rc
= GPG_ERR_ENOMEM
;
3767 tstr
= string_append_printf (str
, "%s%s", str
->len
? "\t" : "", args
[1]);
3770 string_free (str
, 1);
3771 rc
= GPG_ERR_ENOMEM
;
3776 xml_free_request (req
);
3777 rc
= xml_new_request (client
, str
->str
, XML_CMD_RENAME
, &req
);
3778 string_free (str
, 1);
3785 dst
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
3786 if (rc
&& rc
!= GPG_ERR_ELEMENT_NOT_FOUND
)
3791 /* Target may exist:
3793 * <element _name="a"/>
3794 * <element _name="b" target="a"/>
3800 rc
= GPG_ERR_EEXIST
;
3806 rc
= xml_is_element_owner (client
, dst
, 0);
3810 rc
= xml_add_attribute (client
, src
, "_name", args
[1]);
3812 xml_unlink_node (client
, dst
);
3815 rc
= xml_add_attribute (client
, src
, "_name", args
[1]);
3818 xml_free_request (req
);
3824 rename_command (assuan_context_t ctx
, char *line
)
3826 struct client_s
*client
= assuan_get_pointer (ctx
);
3828 struct argv_s
*args
[] = {
3829 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
3833 rc
= parse_options (&line
, args
, client
, 1);
3834 if (!rc
&& (client
->opts
& OPT_INQUIRE
) && line
&& *line
)
3835 rc
= GPG_ERR_SYNTAX
;
3837 return send_error (ctx
, rc
);
3839 rc
= copy_on_write (client
);
3841 return send_error (ctx
, rc
);
3843 if (client
->opts
& OPT_INQUIRE
)
3845 unsigned char *result
;
3848 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
3850 return send_error (ctx
, rc
);
3852 pthread_cleanup_push ((void *)xfree
, result
);
3853 rc
= do_rename (ctx
, (char *)result
);
3854 pthread_cleanup_pop (1);
3857 rc
= do_rename (ctx
, line
);
3859 return send_error (ctx
, rc
);
3863 do_copy (assuan_context_t ctx
, char *line
)
3865 struct client_s
*client
= assuan_get_pointer (ctx
);
3866 char **args
, **targs
;
3867 xmlNodePtr src
, dst
, tree
= NULL
;
3868 struct xml_request_s
*req
;
3871 if (!line
|| !*line
)
3872 return GPG_ERR_SYNTAX
;
3874 args
= str_split (line
, " ", 0);
3875 if (!args
|| strv_length (args
) != 2)
3878 return GPG_ERR_SYNTAX
;
3881 targs
= str_split (args
[1], "\t", 0);
3885 return GPG_ERR_SYNTAX
;
3888 if (!xml_valid_element_path (targs
, 0))
3892 return GPG_ERR_INV_VALUE
;
3896 rc
= xml_new_request (client
, args
[0], XML_CMD_NONE
, &req
);
3903 src
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
3907 tree
= xmlCopyNodeList (src
);
3910 rc
= GPG_ERR_ENOMEM
;
3914 xml_free_request (req
);
3915 /* Create the destination element path if it does not exist. */
3916 rc
= xml_new_request (client
, args
[1], XML_CMD_STORE
, &req
);
3923 dst
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
3927 rc
= xml_is_element_owner (client
, dst
, 0);
3931 if (!(req
->flags
& XML_REQUEST_FLAG_CREATED
))
3933 rc
= xml_validate_target (client
, req
->doc
, args
[1], src
);
3934 if (rc
|| src
== dst
)
3936 rc
= rc
? rc
: GPG_ERR_EEXIST
;
3941 /* Merge any attributes from the src node to the initial dst node. */
3942 for (xmlAttrPtr attr
= tree
->properties
; attr
; attr
= attr
->next
)
3944 if (xmlStrEqual (attr
->name
, (xmlChar
*) "_name"))
3947 xmlAttrPtr a
= xmlHasProp (dst
, attr
->name
);
3951 xmlChar
*tmp
= xmlNodeGetContent (attr
->children
);
3952 xmlNewProp (dst
, attr
->name
, tmp
);
3954 /* Create the default attributes. */
3955 rc
= xml_add_attribute (client
, dst
, NULL
, NULL
);
3958 xmlNodePtr n
= dst
->children
;
3959 (void)xml_unlink_node (client
, n
);
3960 dst
->children
= NULL
;
3964 n
= xmlCopyNodeList (tree
->children
);
3967 rc
= GPG_ERR_ENOMEM
;
3971 n
= xmlAddChildList (dst
, n
);
3974 rc
= GPG_ERR_ENOMEM
;
3978 rc
= xml_update_element_mtime (client
, xmlDocGetRootElement (client
->doc
)
3979 == dst
->parent
? dst
: dst
->parent
);
3984 (void)xml_unlink_node (client
, tree
);
3986 xml_free_request (req
);
3992 copy_command (assuan_context_t ctx
, char *line
)
3994 struct client_s
*client
= assuan_get_pointer (ctx
);
3996 struct argv_s
*args
[] = {
3997 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
4001 rc
= parse_options (&line
, args
, client
, 1);
4002 if (!rc
&& (client
->opts
& OPT_INQUIRE
) && line
&& *line
)
4003 rc
= GPG_ERR_SYNTAX
;
4005 return send_error (ctx
, rc
);
4007 rc
= copy_on_write (client
);
4009 return send_error (ctx
, rc
);
4011 if (client
->opts
& OPT_INQUIRE
)
4013 unsigned char *result
;
4016 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
4018 return send_error (ctx
, rc
);
4020 pthread_cleanup_push ((void *)xfree
, result
);
4021 rc
= do_copy (ctx
, (char *)result
);
4022 pthread_cleanup_pop (1);
4025 rc
= do_copy (ctx
, line
);
4027 return send_error (ctx
, rc
);
4031 do_move (assuan_context_t ctx
, char *line
)
4033 struct client_s
*client
= assuan_get_pointer (ctx
);
4035 xmlNodePtr src
, dst
;
4036 struct xml_request_s
*req
;
4039 if (!line
|| !*line
)
4040 return GPG_ERR_SYNTAX
;
4042 args
= str_split (line
, " ", 0);
4043 if (!args
|| strv_length (args
) != 2)
4046 return GPG_ERR_SYNTAX
;
4051 char **targs
= str_split (args
[1], "\t", 0);
4055 return GPG_ERR_ENOMEM
;
4058 if (!xml_valid_element_path (targs
, 0))
4062 return GPG_ERR_INV_VALUE
;
4068 rc
= xml_new_request (client
, args
[0], XML_CMD_MOVE
, &req
);
4075 src
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
), &rc
);
4079 rc
= xml_is_element_owner (client
, src
, 0);
4083 xml_free_request (req
);
4087 rc
= xml_new_request (client
, args
[1], XML_CMD_NONE
, &req
);
4091 dst
= xml_find_elements (client
, req
, xmlDocGetRootElement (req
->doc
),
4095 dst
= xmlDocGetRootElement (client
->doc
);
4097 if (rc
&& rc
!= GPG_ERR_ELEMENT_NOT_FOUND
)
4102 for (xmlNodePtr n
= dst
; n
; n
= n
->parent
)
4106 rc
= GPG_ERR_EEXIST
;
4113 xmlChar
*a
= xml_attribute_value (src
, (xmlChar
*) "_name");
4114 xmlNodePtr dup
= xml_find_element (client
, dst
->children
, (char *) a
, &rc
);
4117 if (rc
&& rc
!= GPG_ERR_ELEMENT_NOT_FOUND
)
4126 rc
= GPG_ERR_EEXIST
;
4130 if (dst
== xmlDocGetRootElement (client
->doc
))
4135 while (n
->parent
&& n
->parent
!= dst
)
4138 a
= xml_attribute_value (n
, (xmlChar
*) "_name");
4139 xmlChar
*b
= xml_attribute_value (src
, (xmlChar
*) "_name");
4141 if (xmlStrEqual (a
, b
))
4144 xmlUnlinkNode (src
);
4145 (void)xml_unlink_node (client
, n
);
4152 (void)xml_unlink_node (client
, dup
);
4155 xmlUnlinkNode (dup
);
4159 if (!dst
&& req
&& req
->args
&& *req
->args
)
4161 struct xml_request_s
*nreq
= NULL
;
4162 xmlChar
*name
= xml_attribute_value (src
, (xmlChar
*) "_name");
4164 if (src
->parent
== xmlDocGetRootElement (client
->doc
)
4165 && !strcmp ((char *) name
, *req
->args
))
4168 rc
= GPG_ERR_EEXIST
;
4173 rc
= xml_new_request (client
, args
[1], XML_CMD_STORE
, &nreq
);
4176 dst
= xml_find_elements (client
, nreq
,
4177 xmlDocGetRootElement (nreq
->doc
), &rc
);
4178 xml_free_request (nreq
);
4185 xml_update_element_mtime (client
, src
->parent
);
4186 xmlUnlinkNode (src
);
4188 dst
= xmlAddChildList (dst
, src
);
4190 rc
= GPG_ERR_ENOMEM
;
4192 xml_update_element_mtime (client
, dst
->parent
);
4195 xml_free_request (req
);
4201 move_command (assuan_context_t ctx
, char *line
)
4203 struct client_s
*client
= assuan_get_pointer (ctx
);
4205 struct argv_s
*args
[] = {
4206 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
4210 rc
= parse_options (&line
, args
, client
, 1);
4211 if (!rc
&& (client
->opts
& OPT_INQUIRE
) && line
&& *line
)
4212 rc
= GPG_ERR_SYNTAX
;
4214 return send_error (ctx
, rc
);
4216 rc
= copy_on_write (client
);
4218 return send_error (ctx
, rc
);
4220 if (client
->opts
& OPT_INQUIRE
)
4222 unsigned char *result
;
4225 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
4227 return send_error (ctx
, rc
);
4229 pthread_cleanup_push ((void *)xfree
, result
);
4230 rc
= do_move (ctx
, (char *)result
);
4231 pthread_cleanup_pop (1);
4234 rc
= do_move (ctx
, line
);
4236 return send_error (ctx
, rc
);
4240 sort_files (const void *arg1
, const void *arg2
)
4242 char *const *a
= arg1
;
4243 char *const *b
= arg2
;
4245 return strcmp (*a
, *b
);
4249 ls_command (assuan_context_t ctx
, char *line
)
4251 struct client_s
*client
= assuan_get_pointer (ctx
);
4258 struct dirent
*cur
= NULL
;
4259 struct argv_s
*args
[] = {
4260 &(struct argv_s
) {"verbose", OPTION_TYPE_NOARG
, parse_opt_verbose
},
4264 rc
= parse_options (&line
, args
, client
, 0);
4266 return send_error (ctx
, rc
);
4268 tmp
= str_asprintf ("%s/data", homedir
);
4269 dir
= expand_homedir (tmp
);
4272 return send_error (ctx
, GPG_ERR_ENOMEM
);
4275 rc
= gpg_error_from_errno (errno
);
4280 return send_error (ctx
, rc
);
4283 pthread_cleanup_push ((void *)closedir
, d
);
4287 while ((cur
= readdir (d
)))
4292 rc
= open_check_file (cur
->d_name
, NULL
, &st
, 1);
4296 if (client
->opts
& OPT_VERBOSE
)
4297 tmp
= str_asprintf ("%s %lu.%lu %lu.%lu %lu.%lu", cur
->d_name
,
4298 st
.st_atim
.tv_sec
, st
.st_atim
.tv_nsec
,
4299 st
.st_mtim
.tv_sec
, st
.st_mtim
.tv_nsec
,
4300 st
.st_ctim
.tv_sec
, st
.st_ctim
.tv_nsec
);
4302 tmp
= str_dup (cur
->d_name
);
4306 rc
= GPG_ERR_ENOMEM
;
4310 vtmp
= strv_cat (v
, tmp
);
4314 rc
= GPG_ERR_ENOMEM
;
4321 pthread_cleanup_pop (1); // closedir (d)
4323 if (rc
&& rc
!= GPG_ERR_ENODEV
)
4326 return send_error (ctx
, rc
);
4332 unsigned n
, t
= strv_length (v
);
4334 qsort (v
, t
, sizeof (char **), sort_files
);
4336 for (n
= 0; n
< t
; n
++)
4338 tmp
= str_asprintf ("%s%s\n", list
? list
: "", v
[n
]);
4342 rc
= GPG_ERR_ENOMEM
;
4353 return send_error (ctx
, rc
? rc
: GPG_ERR_NO_DATA
);
4355 list
[strlen (list
) - 1] = 0;
4356 pthread_cleanup_push (xfree
, list
);
4357 rc
= xfer_data (ctx
, list
, strlen (list
));
4358 pthread_cleanup_pop (1);
4359 return send_error (ctx
, rc
);
4362 /* Run all commands in the command list 'head'. The return code isn't
4363 * considered at all for a command. It is stored in the list and later sent to
4366 dispatch_bulk_commands (struct client_s
*client
, struct sexp_s
**list
)
4372 for (i
= 0; list
&& list
[i
];)
4374 struct bulk_cmd_s
*cur
= list
[i
]->user
;
4376 if (!strcmp (list
[i
]->tag
, "command"))
4381 else if (!strcmp (list
[i
]->tag
, "id"))
4387 if ((client
->flags
& FLAG_NO_PINENTRY
) && cur
->cmd
->inquire
)
4389 rc
= send_status (client
->ctx
, STATUS_BULK
, "BEGIN %s",
4395 client
->bulk_p
= cur
;
4398 cur
->rc
= command_startup (client
->ctx
, cur
->cmd
->name
);
4400 cur
->rc
= cur
->cmd
->handler (client
->ctx
, list
[i
]->data
);
4402 if ((client
->flags
& FLAG_NO_PINENTRY
) && cur
->cmd
->inquire
)
4404 (void)send_status (client
->ctx
, STATUS_BULK
, "END %s",
4407 command_finalize (client
->ctx
, cur
->rc
);
4408 cur
->rc
= cur
->rc
? cur
->rc
: client
->last_rc
;
4411 if (list
[i
+1] && !strcmp (list
[i
+1]->tag
, "rc"))
4413 gpg_error_t erc
= 0;
4416 if (list
[i
+1]->data
)
4418 char **rcs
= str_split (list
[i
+1]->data
, "|", 0);
4421 for (p
= rcs
; p
&& *p
; p
++)
4423 erc
= strtoul (*p
, NULL
, 10);
4440 rc
= dispatch_bulk_commands (client
, list
[++i
]->next
);
4454 bulk_command (assuan_context_t ctx
, char *line
)
4456 struct client_s
*client
= assuan_get_pointer (ctx
);
4458 unsigned char *result
, *p
;
4460 struct sexp_s
**sexp
= NULL
;
4461 struct argv_s
*args
[] = {
4462 &(struct argv_s
) {"inquire", OPTION_TYPE_NOARG
, parse_opt_inquire
},
4466 rc
= parse_options (&line
, args
, client
, 1);
4468 return send_error (ctx
, rc
);
4470 if ((client
->opts
& OPT_INQUIRE
) && line
&& *line
)
4471 rc
= GPG_ERR_SYNTAX
;
4472 else if (!(client
->opts
& OPT_INQUIRE
) && (!line
|| !*line
))
4473 rc
= GPG_ERR_SYNTAX
;
4476 return send_error (ctx
, rc
);
4478 if (client
->opts
& OPT_INQUIRE
)
4480 rc
= assuan_inquire (ctx
, "DATA", &result
, &len
, 0);
4482 return send_error (ctx
, rc
);
4487 p
= (unsigned char *)line
;
4488 len
= line
&& *line
? strlen (line
) : 0;
4492 return send_error (ctx
, GPG_ERR_SYNTAX
);
4494 rc
= bulk_parse_commands (&sexp
, (const char *)p
, command_table
);
4495 if (client
->opts
& OPT_INQUIRE
)
4499 return send_error (ctx
, rc
);
4501 pthread_cleanup_push ((void *)bulk_free_list
, sexp
);
4502 rc
= dispatch_bulk_commands (client
, sexp
);
4503 pthread_cleanup_pop (0);
4505 rc
= bulk_build_result (sexp
, (char **)&result
);
4507 bulk_free_list (sexp
);
4511 pthread_cleanup_push ((void *)xfree
, result
);
4512 rc
= xfer_data (ctx
, (char *)result
, strlen ((char *)result
));
4513 pthread_cleanup_pop (1);
4516 return send_error (ctx
, rc
);
4520 nop_command (assuan_context_t ctx
, char *line
)
4522 return send_error (ctx
, 0);
4526 bye_notify (assuan_context_t ctx
, char *line
)
4528 struct client_s
*cl
= assuan_get_pointer (ctx
);
4529 gpg_error_t ret
= 0;
4532 update_client_state (cl
, CLIENT_STATE_DISCON
);
4536 if (cl
->thd
->remote
)
4542 struct timeval tv
= { 0, 50000 };
4544 rc
= gnutls_bye (cl
->thd
->tls
->ses
, GNUTLS_SHUT_WR
);
4545 if (rc
== GNUTLS_E_AGAIN
)
4546 select (0, NULL
, NULL
, NULL
, &tv
);
4548 while (rc
== GNUTLS_E_AGAIN
);
4552 /* This will let assuan_process_next() return. */
4553 if (fcntl (cl
->thd
->fd
, F_SETFL
, O_NONBLOCK
) == -1)
4555 cl
->last_rc
= gpg_error_from_errno (errno
);
4559 cl
->last_rc
= 0; // BYE command result
4564 reset_notify (assuan_context_t ctx
, char *line
)
4566 struct client_s
*client
= assuan_get_pointer (ctx
);
4570 reset_client (client
);
4576 * This is called before every Assuan command.
4579 command_startup (assuan_context_t ctx
, const char *name
)
4581 struct client_s
*client
= assuan_get_pointer (ctx
);
4583 struct command_table_s
*cmd
= NULL
;
4585 log_write2 ("command='%s'", name
);
4586 client
->last_rc
= client
->opts
= 0;
4588 for (int i
= 0; command_table
[i
]; i
++)
4590 if (!strcasecmp (name
, command_table
[i
]->name
))
4592 if (command_table
[i
]->ignore_startup
)
4595 cmd
= command_table
[i
];
4601 return GPG_ERR_UNKNOWN_COMMAND
;
4603 client
->last_rc
= rc
= gpg_error (file_modified (client
, cmd
));
4606 if (!client
->bulk_p
&& !rc
)
4607 update_client_state (client
, CLIENT_STATE_COMMAND
);
4613 * This is called after every Assuan command.
4616 command_finalize (assuan_context_t ctx
, gpg_error_t rc
)
4618 struct client_s
*client
= assuan_get_pointer (ctx
);
4620 // Needed for the STORE command. Really should be an OPT_.
4621 client
->flags
&= ~(FLAG_NO_INHERIT_ACL
);
4623 if (!(client
->flags
& FLAG_LOCK_CMD
))
4624 unlock_file_mutex (client
, 0);
4626 unlock_flock (&client
->flock_fd
);
4627 log_write2 (_("command completed: rc=%u"), rc
? rc
: client
->last_rc
);
4630 client
->thd
->buffer_timeout
= client
->thd
->last_buffer_size
= 0;
4633 if (!client
->bulk_p
&& client
->thd
->state
!= CLIENT_STATE_DISCON
)
4634 update_client_state (client
, CLIENT_STATE_IDLE
);
4636 client
->bulk_p
= NULL
;
4640 parse_help_opt_html (void *data
, void *value
)
4642 struct client_s
*client
= data
;
4645 client
->opts
|= OPT_HTML
;
4650 help_command (assuan_context_t ctx
, char *line
)
4654 struct client_s
*client
= assuan_get_pointer (ctx
);
4655 struct argv_s
*args
[] = {
4656 &(struct argv_s
) {"html", OPTION_TYPE_NOARG
, parse_help_opt_html
},
4660 rc
= parse_options (&line
, args
, client
, 1);
4662 return send_error (ctx
, rc
);
4664 if (!line
|| !*line
)
4667 char *help
= str_dup (_("Usage: HELP [--html] [<COMMAND>]\n"
4668 "For commands that take an element path as an argument, each element is "
4669 "separated with an ASCII @key{TAB} character (ASCII 0x09). Not all help text is available here. For complete documentation refer to the texinfo or HTML manual."
4672 for (i
= 0; command_table
[i
]; i
++)
4674 if (!command_table
[i
]->help
)
4677 /* @npxref{} won't put a "See " or "see " in front of the command.
4678 * It's not a texinfo command but needed for --html. */
4679 tmp
= str_asprintf ("%s %s%s%s", help
,
4680 client
->opts
& OPT_HTML
? "@npxref{" : "",
4681 command_table
[i
]->name
,
4682 client
->opts
& OPT_HTML
? "}" : "");
4687 tmp
= strip_texi_and_wrap (help
, client
->opts
& OPT_HTML
);
4689 pthread_cleanup_push ((void *)xfree
, tmp
);
4690 rc
= xfer_data (ctx
, tmp
, strlen (tmp
));
4691 pthread_cleanup_pop (1);
4692 return send_error (ctx
, rc
);
4695 for (i
= 0; command_table
[i
]; i
++)
4697 if (!strcasecmp (line
, command_table
[i
]->name
))
4701 if (!command_table
[i
]->help
)
4704 help
= strip_texi_and_wrap (command_table
[i
]->help
,
4705 client
->opts
& OPT_HTML
);
4706 tmp
= str_asprintf ("%s%s",
4707 (client
->opts
& OPT_HTML
) ? "" : _("Usage: "),
4710 pthread_cleanup_push ((void *)xfree
, tmp
);
4711 rc
= xfer_data (ctx
, tmp
, strlen (tmp
));
4712 pthread_cleanup_pop (1);
4713 return send_error (ctx
, rc
);
4717 return send_error (ctx
, GPG_ERR_INV_NAME
);
4721 new_command (const char *name
, int inquire
, int ignore
, int unlock
,
4722 int flock_type
, gpg_error_t (*handler
) (assuan_context_t
, char *),
4726 struct command_table_s
**tmp
;
4729 for (i
= 0; command_table
[i
]; i
++);
4731 tmp
= xrealloc (command_table
, (i
+ 2) * sizeof (struct command_table_s
*));
4733 command_table
= tmp
;
4734 command_table
[i
] = xcalloc (1, sizeof (struct command_table_s
));
4735 command_table
[i
]->name
= name
;
4736 command_table
[i
]->inquire
= inquire
;
4737 command_table
[i
]->handler
= handler
;
4738 command_table
[i
]->ignore_startup
= ignore
;
4739 command_table
[i
]->unlock
= unlock
;
4740 command_table
[i
]->flock_type
= flock_type
;
4741 command_table
[i
++]->help
= help
;
4742 command_table
[i
] = NULL
;
4750 for (i
= 0; command_table
[i
]; i
++)
4751 xfree (command_table
[i
]);
4753 xfree (command_table
);
4757 sort_commands (const void *arg1
, const void *arg2
)
4759 struct command_table_s
*const *a
= arg1
;
4760 struct command_table_s
*const *b
= arg2
;
4769 return strcmp ((*a
)->name
, (*b
)->name
);
4773 passwd_command (assuan_context_t ctx
, char *line
)
4775 struct client_s
*client
= assuan_get_pointer (ctx
);
4779 rc
= peer_is_invoker (client
);
4781 return send_error (ctx
, (rc
== GPG_ERR_EACCES
? GPG_ERR_FORBIDDEN
: rc
));
4783 if (client
->flags
& FLAG_NEW
)
4784 return send_error (ctx
, GPG_ERR_INV_STATE
);
4786 client
->crypto
->keyfile
= config_get_string (client
->filename
,
4788 rc
= crypto_init_ctx (client
->crypto
, client
->flags
& FLAG_NO_PINENTRY
,
4789 client
->crypto
->keyfile
);
4791 rc
= crypto_passwd (client
, client
->crypto
);
4793 crypto_free_non_keys (client
->crypto
);
4794 return send_error (ctx
, rc
);
4798 parse_opt_data (void *data
, void *value
)
4800 struct client_s
*client
= data
;
4803 client
->opts
|= OPT_DATA
;
4808 send_client_list (assuan_context_t ctx
)
4810 struct client_s
*client
= assuan_get_pointer (ctx
);
4813 if (client
->opts
& OPT_VERBOSE
)
4819 MUTEX_LOCK (&cn_mutex
);
4820 pthread_cleanup_push ((void *)release_mutex_cb
, &cn_mutex
);
4821 t
= slist_length (cn_thread_list
);
4823 for (i
= 0; i
< t
; i
++)
4825 struct client_thread_s
*thd
= slist_nth_data (cn_thread_list
, i
);
4828 if (thd
->state
== CLIENT_STATE_UNKNOWN
)
4831 tmp
= build_client_info_line (thd
, 0);
4834 char **l
= strv_cat (list
, tmp
);
4836 rc
= GPG_ERR_ENOMEM
;
4841 rc
= GPG_ERR_ENOMEM
;
4850 pthread_cleanup_pop (1);
4854 line
= strv_join ("\n", list
);
4856 pthread_cleanup_push ((void *)xfree
, line
);
4857 rc
= xfer_data (ctx
, line
, strlen (line
));
4858 pthread_cleanup_pop (1);
4862 if (client
->opts
& OPT_DATA
)
4864 char buf
[ASSUAN_LINELENGTH
];
4866 MUTEX_LOCK (&cn_mutex
);
4867 snprintf (buf
, sizeof (buf
), "%u", slist_length (cn_thread_list
));
4868 MUTEX_UNLOCK (&cn_mutex
);
4869 rc
= xfer_data (ctx
, buf
, strlen (buf
));
4872 rc
= send_status (ctx
, STATUS_CLIENTS
, NULL
);
4878 getinfo_command (assuan_context_t ctx
, char *line
)
4880 struct client_s
*client
= assuan_get_pointer (ctx
);
4882 char buf
[ASSUAN_LINELENGTH
];
4883 struct argv_s
*args
[] = {
4884 &(struct argv_s
) {"data", OPTION_TYPE_NOARG
, parse_opt_data
},
4885 &(struct argv_s
) {"verbose", OPTION_TYPE_NOARG
, parse_opt_verbose
},
4889 rc
= parse_options (&line
, args
, client
, 1);
4891 return send_error (ctx
, rc
);
4893 if (!line
|| !*line
)
4894 return send_error (ctx
, GPG_ERR_SYNTAX
);
4896 if (!strcasecmp (line
, "clients"))
4898 rc
= send_client_list (ctx
);
4900 else if (!strcasecmp (line
, "cache"))
4902 if (client
->opts
& OPT_DATA
)
4904 snprintf (buf
, sizeof (buf
), "%u", cache_file_count ());
4905 rc
= xfer_data (ctx
, buf
, strlen (buf
));
4908 rc
= send_status (ctx
, STATUS_CACHE
, NULL
);
4910 else if (!strcasecmp (line
, "pid"))
4912 long pid
= getpid ();
4914 snprintf (buf
, sizeof (buf
), "%li", pid
);
4915 rc
= xfer_data (ctx
, buf
, strlen (buf
));
4917 else if (!strcasecmp (line
, "version"))
4919 char *tmp
= str_asprintf ("0x%06x %s", VERSION_HEX
,
4927 pthread_cleanup_push (xfree
, tmp
);
4928 rc
= xfer_data (ctx
, tmp
, strlen (tmp
));
4929 pthread_cleanup_pop (1);
4931 else if (!strcasecmp (line
, "last_error"))
4933 if (client
->last_error
)
4934 rc
= xfer_data (ctx
, client
->last_error
, strlen (client
->last_error
));
4936 rc
= GPG_ERR_NO_DATA
;
4938 else if (!strcasecmp (line
, "user"))
4943 if (client
->thd
->remote
)
4944 user
= str_asprintf ("#%s", client
->thd
->tls
->fp
);
4946 user
= get_username (client
->thd
->peer
->uid
);
4948 user
= get_username (client
->thd
->peer
->uid
);
4952 pthread_cleanup_push ((void *)xfree
, user
);
4953 rc
= xfer_data (ctx
, user
, strlen (user
));
4954 pthread_cleanup_pop (1);
4957 rc
= GPG_ERR_NO_DATA
;
4960 rc
= gpg_error (GPG_ERR_SYNTAX
);
4962 return send_error (ctx
, rc
);
4966 parse_opt_secret (void *data
, void *value
)
4968 struct client_s
*client
= data
;
4971 client
->opts
|= OPT_SECRET
;
4976 parse_keyinfo_opt_learn (void *data
, void *value
)
4978 struct client_s
*client
= data
;
4981 client
->opts
|= OPT_KEYINFO_LEARN
;
4986 keyinfo_command (assuan_context_t ctx
, char *line
)
4988 struct client_s
*client
= assuan_get_pointer (ctx
);
4990 char **keys
= NULL
, **p
= NULL
;
4992 struct argv_s
*args
[] = {
4993 &(struct argv_s
) {"learn", OPTION_TYPE_NOARG
, parse_keyinfo_opt_learn
},
4997 rc
= parse_options (&line
, args
, client
, 0);
4999 return send_error (ctx
, rc
);
5002 return send_error (ctx
, GPG_ERR_SYNTAX
);
5004 if (!(client
->flags
& FLAG_OPEN
))
5005 return send_error (ctx
, GPG_ERR_INV_STATE
);
5007 if (client
->opts
& OPT_KEYINFO_LEARN
)
5009 rc
= cache_agent_command ("LEARN");
5010 return send_error (ctx
, rc
);
5013 if (client
->flags
& FLAG_NEW
)
5014 return send_error (ctx
, GPG_ERR_NO_DATA
);
5016 rc
= lock_flock (ctx
, client
->filename
, FLOCK_TYPE_SH
, &client
->flock_fd
);
5018 return send_error (ctx
, rc
);
5020 rc
= crypto_is_symmetric (client
->filename
);
5021 unlock_flock (&client
->flock_fd
);
5024 else if (rc
!= GPG_ERR_BAD_DATA
)
5025 return send_error (ctx
, rc
);
5030 p
= strv_catv (keys
, client
->crypto
->pubkey
);
5032 rc
= GPG_ERR_ENOMEM
;
5037 if (!rc
&& client
->crypto
->sigkey
)
5039 if (!strv_printf (&keys
, "S%s", client
->crypto
->sigkey
))
5042 return send_error (ctx
, GPG_ERR_ENOMEM
);
5050 line
= strv_join ("\n", keys
);
5052 pthread_cleanup_push ((void *)xfree
, line
);
5054 rc
= xfer_data (ctx
, line
, strlen (line
));
5056 rc
= GPG_ERR_ENOMEM
;
5058 pthread_cleanup_pop (1);
5061 rc
= GPG_ERR_NO_DATA
;
5066 return send_error (ctx
, rc
);
5070 deletekey_command (assuan_context_t ctx
, char *line
)
5073 struct client_s
*client
= assuan_get_pointer (ctx
);
5074 struct crypto_s
*crypto
= NULL
;
5075 char *keys
[] = { NULL
, NULL
};
5076 gpgme_key_t
*result
;
5079 if (!(client
->flags
& FLAG_OPEN
))
5080 return send_error (ctx
, GPG_ERR_INV_STATE
);
5082 rc
= peer_is_invoker (client
);
5084 return send_error (ctx
, (rc
== GPG_ERR_EACCES
? GPG_ERR_FORBIDDEN
: rc
));
5086 if (client
->flags
& FLAG_NO_PINENTRY
)
5087 return send_error (ctx
, GPG_ERR_NOT_IMPLEMENTED
);
5090 return send_error (ctx
, GPG_ERR_SYNTAX
);
5092 rc
= crypto_keyid_to_16b_once (line
);
5094 return send_error (ctx
, rc
);
5096 for (p
= client
->crypto
->pubkey
; p
&& *p
; p
++)
5098 if (!strcmp (*p
, line
))
5104 if (client
->crypto
->sigkey
&& strcmp (client
->crypto
->sigkey
, line
))
5105 return send_error (ctx
, GPG_ERR_FORBIDDEN
);
5106 else if (!client
->crypto
->sigkey
)
5107 return send_error (ctx
, GPG_ERR_NO_SECKEY
);
5110 rc
= crypto_init (&crypto
, client
->ctx
, client
->filename
,
5111 client
->flags
& FLAG_NO_PINENTRY
, NULL
);
5113 return send_error (ctx
, rc
);
5115 pthread_cleanup_push ((void *)crypto_free
, crypto
);
5117 rc
= crypto_list_keys (crypto
, keys
, 1, &result
);
5120 pthread_cleanup_push ((void *)crypto_free_key_list
, result
);
5121 rc
= crypto_delete_key (client
, crypto
, *result
, 1);
5122 pthread_cleanup_pop (1);
5125 pthread_cleanup_pop (1);
5126 return send_error (ctx
, rc
);
5130 kill_command (assuan_context_t ctx
, char *line
)
5132 struct client_s
*client
= assuan_get_pointer (ctx
);
5136 if (!line
|| !*line
)
5137 return send_error (ctx
, GPG_ERR_SYNTAX
);
5139 MUTEX_LOCK (&cn_mutex
);
5140 pthread_cleanup_push ((void *)release_mutex_cb
, &cn_mutex
);
5141 t
= slist_length (cn_thread_list
);
5144 for (i
= 0; i
< t
; i
++)
5146 struct client_thread_s
*thd
= slist_nth_data (cn_thread_list
, i
);
5147 char *tmp
= str_asprintf ("%p", thd
->tid
);
5149 if (strcmp (line
, tmp
))
5156 rc
= peer_is_invoker (client
);
5159 #ifdef HAVE_PTHREAD_CANCEL
5160 pthread_cancel (thd
->tid
);
5162 pthread_kill (thd
->tid
, SIGUSR2
);
5166 else if (rc
== GPG_ERR_EACCES
)
5167 rc
= GPG_ERR_FORBIDDEN
;
5171 if (config_get_boolean ("global", "strict_kill"))
5175 if (client
->thd
->remote
&& thd
->remote
)
5177 if (!thd
->tls
|| !thd
->tls
->fp
)
5179 rc
= GPG_ERR_INV_STATE
;
5182 if (!strcmp (client
->thd
->tls
->fp
, thd
->tls
->fp
))
5184 #ifdef HAVE_PTHREAD_CANCEL
5185 pthread_cancel (thd
->tid
);
5187 pthread_kill (thd
->tid
, SIGUSR2
);
5193 else if (!client
->thd
->remote
&& !thd
->remote
)
5196 if (client
->thd
->peer
->uid
== thd
->peer
->uid
)
5198 #ifdef HAVE_PTHREAD_CANCEL
5199 pthread_cancel (thd
->tid
);
5201 pthread_kill (thd
->tid
, SIGUSR2
);
5209 pthread_cleanup_pop (1);
5210 return send_error (ctx
, rc
);
5214 listkeys_command (assuan_context_t ctx
, char *line
)
5216 struct client_s
*client
= assuan_get_pointer (ctx
);
5217 struct crypto_s
*crypto
= NULL
;
5218 char **pattern
= NULL
;
5219 gpgme_key_t
*keys
= NULL
;
5220 char **result
= NULL
;
5222 struct argv_s
*args
[] = {
5223 &(struct argv_s
) {"secret-only", OPTION_TYPE_NOARG
, parse_opt_secret
},
5227 rc
= parse_options (&line
, args
, client
, 1);
5229 return send_error (ctx
, rc
);
5231 rc
= crypto_init (&crypto
, client
->ctx
, client
->filename
,
5232 client
->flags
& FLAG_NO_PINENTRY
, NULL
);
5234 return send_error (ctx
, rc
);
5236 pthread_cleanup_push ((void *)crypto_free
, crypto
);
5238 pattern
= str_split (line
, ",", 0);
5239 pthread_cleanup_push ((void *)(void *)strv_free
, pattern
);
5240 rc
= crypto_list_keys (crypto
, pattern
, client
->opts
& OPT_SECRET
,
5242 pthread_cleanup_pop (1);
5243 pthread_cleanup_pop (1);
5248 for (i
= 0; keys
[i
]; i
++)
5250 char *p
= crypto_key_info (keys
[i
]);
5255 rc
= GPG_ERR_ENOMEM
;
5259 r
= strv_cat (result
, p
);
5262 rc
= GPG_ERR_ENOMEM
;
5270 rc
= GPG_ERR_NO_DATA
;
5272 crypto_free_key_list (keys
);
5277 line
= strv_join ("\n", result
);
5279 pthread_cleanup_push ((void *)xfree
, line
);
5281 rc
= GPG_ERR_ENOMEM
;
5283 rc
= xfer_data (ctx
, line
, strlen (line
));
5285 pthread_cleanup_pop (1);
5290 if (gpg_err_code (rc
) == GPG_ERR_NO_PUBKEY
5291 || gpg_err_code (rc
) == GPG_ERR_NO_SECKEY
)
5292 rc
= GPG_ERR_NO_DATA
;
5294 return send_error (ctx
, rc
);
5300 /* !BEGIN-HELP-TEXT!
5302 * This comment is used as a marker to generate the offline documentation
5303 * found in doc/pwmd.info. The indentation needs to be kept for the awk
5304 * script to determine where commands begin and end.
5306 new_command("HELP", 0, 1, 1, 0, help_command
, _(
5307 "HELP [--html] [<COMMAND>]\n" /* Showing available commands. */
5308 "Show available commands or command specific help text."
5310 "The @option{--html} option will output the help text in HTML format."
5313 new_command("DELETEKEY", 0, 1, 1, FLOCK_TYPE_SH
|FLOCK_TYPE_KEEP
, deletekey_command
, _(
5314 "DELETEKEY <keyid>\n" /* Deleting a key from the key ring. */
5315 "Deletes the public and secret key associated with key @var{keyid} from the "
5316 "keyring. The @var{keyid} must be one associated with the currently opened "
5318 "Note that no confirmation occurs. Also note that when the key is deleted, "
5319 "the current or other data files using this key will no longer be able to be "
5323 new_command("KILL", 0, 1, 0, 0, kill_command
, _(
5324 "KILL <thread_id>\n" /* Terminating another client. */
5325 "Terminates the client identified by @var{thread_id} and releases any file "
5326 "lock or other resources it has held. See @code{GETINFO} (@pxref{GETINFO}) "
5327 "for details about listing connected clients. An @code{invoking_user} "
5328 "(@pxref{Configuration}) may kill any client while others may only kill "
5329 "clients of the same @code{UID} or @abbr{TLS} fingerprint."
5332 new_command("LISTKEYS", 0, 1, 0, 0, listkeys_command
, _(
5333 "LISTKEYS [--secret-only] [pattern[,<pattern>]]\n" /* Listing keys in the key ring. */
5334 "Returns a new line separated list of key information matching a comma "
5335 "separated list of @var{pattern}'s. When option @option{--secret-only} is "
5336 "specified, only keys matching @var{pattern} that also have a secret key "
5337 "available will be returned."
5340 new_command("KEYINFO", 0, 1, 0, 0, keyinfo_command
, _(
5341 "KEYINFO [--learn]\n" /* Showing keys used for the current data file. */
5342 "Returns a new line separated list of key ID's that the currently opened "
5343 "data file has recipients and signers for. If the key is a signing key it "
5344 "will be prefixed with an @code{S}. If the file is a new one, or has no "
5345 "signers in the case of being symmetrically encrypted, the error code "
5346 "@code{GPG_ERR_NO_DATA} is returned."
5348 "When the @option{--learn} option is passed, keys on a smartcard will be "
5352 new_command("GETINFO", 0, 1, 1, 0, getinfo_command
, _(
5353 "GETINFO [--data] [--verbose] CACHE | CLIENTS | PID | USER | LAST_ERROR | VERSION\n" /* Obtaining server and client information. */
5354 "Get server and other information. The information is returned via a status "
5355 "message (@pxref{Status Messages}) unless otherwise noted or @option{--data} "
5358 "@var{CACHE} returns the number of cached documents."
5360 "@var{CLIENTS} returns the number of "
5361 "connected clients via a status message or a list of connected clients when "
5362 "the @option{--verbose} parameter is used (implies @option{--data}). A "
5363 "verbose line of a client list contains "
5365 "fields: the thread ID, client name, opened file (@code{/} if none opened), "
5366 "IP address if remote, file lock status, whether the current client is self "
5367 "or not, client state (see below), "
5368 "user ID or TLS fingerprint of the connected client, username if the "
5369 "client is a local one else @code{-}, and finally the time stamp of when the "
5372 "Client state @code{0} is an unknown client state, state @code{1} indicates "
5373 "the client has connected but hasn't completed initializing, state @code{2} "
5374 "indicates that the client is idle, state @code{3} means the "
5375 "client is in a command and state @code{4} means the client is disconnecting. "
5377 "@var{PID} returns the process ID number of the server via a data response."
5379 "@var{VERSION} returns the server version number and compile-time features "
5380 "via a data response with each being space delimited."
5382 "@var{LAST_ERROR} returns a detailed description of the last failed command "
5383 "via a data response, when available."
5385 "@var{USER} returns the username or @abbr{TLS} hash of the connected client "
5386 "via a data response."
5389 new_command("PASSWD", 1, 0, 0, FLOCK_TYPE_EX
|FLOCK_TYPE_KEEP
, passwd_command
, _(
5390 "PASSWD\n" /* Changing the passphrase for a key. */
5391 "Changes the passphrase of the secret key required to open the current "
5392 "data file. If the data file is symmetrically encrypted the error "
5393 "@code{GPG_ERR_NOT_SUPPORTED} is returned. When symmetrically encrypted "
5394 "the @code{SAVE} command (@pxref{SAVE}) should be used instead to prevent "
5395 "this command saving any unwanted changes to the @abbr{XML} document."
5397 "Note that when the current data file has been either encrypted or signed "
5398 "with a key stored on a smartcard this command will return an error. In this "
5399 "case you should instead use @command{gpg --card-edit} to change the "
5400 "pin of the smartcard or @command{gpg --edit-key} to change the passphrase "
5401 "of the key used to sign or encrypt the data file."
5403 "This command is not available to non-invoking clients "
5404 "(@pxref{Access Control})."
5407 new_command("OPEN", 1, 1, 1, FLOCK_TYPE_SH
|FLOCK_TYPE_KEEP
, open_command
, _(
5408 "OPEN [--lock] <filename>\n" /* Opening a data file. */
5409 "Opens @var{filename}. When the @var{filename} is not found on the "
5410 "file-system then a new in-memory document will be created. If the file is "
5411 "found, it is looked for in the file cache and when found no passphrase will "
5412 "be required to open it. When not cached, @cite{pinentry(1)} will be used to "
5413 "retrieve the passphrase for decryption unless @option{disable-pinentry} "
5414 "(@pxref{OPTION}) was specified in which case @command{pwmd} will "
5415 "@emph{INQUIRE} the client for the passphrase. Note than when configuration "
5416 "option @option{strict_open} is enabled and the client is not an "
5417 "@option{invoking_user}, an error will be returned when the data file does "
5420 "When the @option{--lock} option is passed then the file mutex will be "
5421 "locked as if the @code{LOCK} command (@pxref{LOCK}) had been sent after the "
5422 "file had been opened."
5425 new_command("GENKEY", 1, 1, 1, 0, genkey_command
, _(
5426 "GENKEY --subkey-of=fpr | --userid=\"str\" [--no-expire | --expire=N] [--algo=\"str\"] [--no-passphrase] [--usage=\"default|sign|encrypt\"]\n" /* Generating a new key. */
5427 "Generates a new key based on option arguments. One of "
5428 "@option{--subkey-of} or @option{--userid} is "
5429 "required. The @option{--subkey-of} option will generate a subkey for the key "
5430 "of the specified fingerprint."
5433 new_command("SAVE", 1, 0, 0, FLOCK_TYPE_EX
|FLOCK_TYPE_KEEP
, save_command
, _(
5434 "SAVE [--sign-keyid=[<fpr>]] [--symmetric | --keyid=<fpr>[,..] | --inquire-keyid]\n" /* Saving document changes to disk. */
5435 "Writes the in-memory @abbr{XML} document to disk. The file written to is the "
5436 "file that was opened when using the @code{OPEN} command (@pxref{OPEN})."
5438 "If the file is a new one one of @option{--symmetric}, @option{--keyid} or"
5439 "@option{--inquire-keyid} is required. When not @option{--symmetric} the "
5440 "option @option{--sign-keyid} is also required but optional otherwise."
5442 "You can encrypt the data file to a recipient other than the one that it "
5443 "was originally encrypted with by passing the @option{--keyid} or "
5444 "@option{--inquire-keyid} option with a comma separated list of "
5445 "public encryption key fingerprints as its argument. Use the "
5446 "@command{LISTKEYS} command (@pxref{LISTKEYS}) to show key information by "
5447 "pattern. The @option{--sign-keyid} option may also be used to sign the data "
5448 "file with an alternate key by specifying the fingerprint of a signing key. "
5449 "Only one signing key is supported unlike the @option{--keyid} option. "
5450 "A passphrase to decrypt the data file "
5451 "will be required when one or more of the original encryption keys or signing "
5452 "key are not found in either of these two options' arguments or when the data "
5453 "file is symmetrically encrypted regardless of the @code{require_save_key} "
5454 "configuration parameter. The original encryption keys and signing key will be "
5455 "used when neither of these options are specified."
5457 "The @option{--keyid} and @option{--sign-keyid} options are not available "
5458 "to non-invoking clients "
5459 "(@pxref{Access Control}) when the recipients or signer do not match those "
5460 "that were used when the file was @code{OPEN}'ed."
5462 "The @option{--symmetric} option specifies that a new data file be "
5463 "conventionally encrypted. These types of data files do not use a recipient "
5464 "public key but may optionally be signed by using the @option{--sign-keyid} "
5465 "option. To remove the signing key from a symmtrically encrypted data file, "
5466 "leave the option value empty."
5468 "Note that you cannot change encryption schemes once a data file has been "
5472 new_command("ISCACHED", 0, 1, 0, 0, iscached_command
, _(
5473 "ISCACHED [--lock] [--agent [--sign]] <filename>\n" /* Testing cache status. */
5474 "Determines the file cache status of the specified @var{filename}. "
5475 "The default is to test whether the filename is cached in memory. Passing "
5476 "option @option{--agent} will test the @command{gpg-agent} cache for at most "
5477 "one cached key used for opening the data file (@pxref{OPEN}). To test if "
5478 "a signing key is cached, pass @option{--sign} along with @option{--agent}. "
5479 "Both the @option{--agent} and @option{--sign} options require an opened data "
5482 "An @emph{OK} response is returned if the specified @var{filename} is found "
5483 "in the cache. If not found in the cache but exists on the filesystem "
5484 "then @code{GPG_ERR_NO_DATA} is returned. Otherwise a filesystem error is "
5487 "The @option{--lock} option will lock the file mutex of @var{filename} when "
5488 "the file exists; it does not need to be opened nor cached. The lock will be "
5489 "released when the client exits or sends the @code{UNLOCK} command "
5490 "(@pxref{UNLOCK}). When this option is passed the current data file is closed."
5493 new_command("CLEARCACHE", 0, 1, 1, 0, clearcache_command
, _(
5494 "CLEARCACHE [<filename>]\n" /* Removing a cache entry. */
5495 "Clears a file cache entry for all or the specified @var{filename}. Note that "
5496 "this will also clear any @command{gpg-agent} cached keys which may cause "
5497 "problems if another data file shares the same keys as @var{filename}."
5499 "When clearing all cache entries a permissions test is done against the "
5500 "current client based on the @var{allowed} configuration parameter in a "
5501 "@var{filename} section. Both a cache entry may be cleared and an error "
5502 "returned depending on cached data files and client permissions."
5505 new_command("CACHETIMEOUT", 0, 1, 1, 0, cachetimeout_command
, _(
5506 "CACHETIMEOUT <seconds>\n" /* Setting the cache timeout. */
5507 "The time in @var{seconds} until the currently opened data file will be "
5508 "removed from the cache. @code{-1} will keep the cache entry forever, "
5509 "@code{0} will require the passphrase for each @code{OPEN} command "
5510 "(@pxref{OPEN}) or @code{SAVE} (@pxref{SAVE}) command. @xref{Configuration}, "
5511 "and the @code{cache_timeout} parameter."
5514 new_command("LIST", 0, 0, 1, 0, list_command
, _(
5515 "LIST [--inquire] [--recurse] [--sexp] [element[<TAB>child[..]]]\n" /* Showing document elements. */
5516 "If no element path is given then a newline separated list of root elements "
5517 "is returned with a data response. If given, then children of the specified "
5518 "element path are returned."
5520 "Each element path "
5521 "returned will have zero or more flags appened to it. These flags are "
5522 "delimited from the element path by a single space character. A flag itself "
5523 "is a single character. Flag @code{P} indicates that access to the element "
5524 "is denied. Flag @code{+} indicates that there are child nodes of "
5525 "the current element path. Flag @code{E} indicates that an element of the "
5526 "element path contained in a @var{target} attribute could not be found. Flag "
5527 "@code{O} indicates that a @var{target} attribute recursion limit was reached "
5528 "(@pxref{Configuration}). Flag @code{T}, followed by a single space character, "
5529 "then an element path, is the element path of the @var{target} attribute "
5530 "contained in the current element."
5532 "When a specified element path contains an error either from the final "
5533 "element in the path or any previous element, the path is still shown but "
5534 "will contain the error flag for the element with the error. Determining "
5535 "the actual element which contains the error is up to the client. This can be "
5536 "done by traversing the final element up to parent elements that contain the "
5539 "The option @option{--recurse} may be used to list the entire element tree "
5540 "for a specified element path or the entire tree for all root elements."
5542 "The option @option{--sexp} outputs the list in an s-expression and also "
5543 "appends an elements' attributes and attribute values. The syntax is:\n"
5547 " (4:path N:<path> 5:flags N:<flags>\n"
5548 " (5:attrs N:<name> N:<value> ...)\n"
5554 "When the @option{--inquire} option is passed then all remaining non-option "
5555 "arguments are retrieved via a server @emph{INQUIRE}."
5558 new_command("REALPATH", 0, 0, 1, 0, realpath_command
, _(
5559 "REALPATH [--inquire] element[<TAB>child[..]]\n" /* Resolving an element. */
5560 "Resolves all @code{target} attributes of the specified element path and "
5561 "returns the result with a data response. @xref{Target Attribute}, for details."
5563 "When the @option{--inquire} option is passed then all remaining non-option "
5564 "arguments are retrieved via a server @emph{INQUIRE}."
5567 new_command("STORE", 0, 0, 1, 0, store_command
, _(
5568 "STORE [--no-inherit-acl] element[<TAB>child[..]]<TAB>[content]\n" /* Modifying the content of an element. */
5569 "This command uses a server @emph{INQUIRE} to retrieve data from the client."
5571 "Creates a new element path or modifies the @var{content} of an existing "
5572 "element. If only a single element is specified then a new root element is "
5573 "created. Otherwise, elements are @key{TAB} delimited and the content will be "
5574 "set to the final @key{TAB} delimited element. If no @var{content} is "
5575 "specified after the final @key{TAB}, then the content of the existing "
5576 "element will be removed; or will be empty if creating a new element."
5578 "The option @option{--no-inherit-acl} prevents a newly created element from "
5579 "inheriting the value of the parent element @code{_acl} attribute. In either "
5580 "case, the current user is made the owner of the newly created element(s)."
5582 "The only restriction of an element name is that it not contain whitespace "
5583 "characters. There is no other whitespace between the @key{TAB} delimited "
5584 "elements. It is recommended that the content of an element be base64 encoded "
5585 "when it contains control or @key{TAB} characters to prevent @abbr{XML} "
5586 "parsing and @command{pwmd} syntax errors."
5589 new_command("RENAME", 0, 0, 1, 0, rename_command
, _(
5590 "RENAME [--inquire] element[<TAB>child[..]] <value>\n" /* Renaming an element. */
5591 "Renames the specified @var{element} to the new @var{value}. If an element of "
5592 "the same name as the @var{value} already exists it will be overwritten."
5594 "When the @option{--inquire} option is passed then all remaining non-option "
5595 "arguments are retrieved via a server @emph{INQUIRE}."
5598 new_command("COPY", 0, 0, 1, 0, copy_command
, _(
5599 "COPY [--inquire] source[<TAB>child[..]] dest[<TAB>child[..]]\n" /* Copying an element. */
5600 "Copies the entire element tree starting from the child node of the source "
5601 "element, to the destination element path. If the destination element path "
5602 "does not exist then it will be created; otherwise it is overwritten."
5604 "Note that attributes from the source element are merged into the "
5605 "destination element when the destination element path exists. When an "
5606 "attribute of the same name exists in both the source and destination "
5607 "elements then the destination attribute will be updated to the source "
5610 "When the @option{--inquire} option is passed then all remaining non-option "
5611 "arguments are retrieved via a server @emph{INQUIRE}."
5614 new_command("MOVE", 0, 0, 1, 0, move_command
, _(
5615 "MOVE [--inquire] source[<TAB>child[..]] [dest[<TAB>child[..]]]\n" /* Moving an element. */
5616 "Moves the source element path to the destination element path. If the "
5617 "destination is not specified then it will be moved to the root node of the "
5618 "document. If the destination is specified and exists then it will be "
5619 "overwritten; otherwise non-existing elements of the destination element "
5620 "path will be created."
5622 "When the @option{--inquire} option is passed then all remaining non-option "
5623 "arguments are retrieved via a server @emph{INQUIRE}."
5626 new_command("DELETE", 0, 0, 1, 0, delete_command
, _(
5627 "DELETE [--inquire] element[<TAB>child[..]]\n" /* Deleting an element. */
5628 "Removes the specified element path and all of its children. This may break "
5629 "an element with a @code{target} attribute (@pxref{Target Attribute}) that "
5630 "refers to this element or any of its children."
5632 "When the @option{--inquire} option is passed then all remaining non-option "
5633 "arguments are retrieved via a server @emph{INQUIRE}."
5636 new_command("GET", 0, 0, 1, 0, get_command
, _(
5637 "GET [--inquire] element[<TAB>child[..]]\n" /* Getting the content of an element. */
5638 "Retrieves the content of the specified element. The content is returned "
5639 "with a data response."
5641 "When the @option{--inquire} option is passed then all remaining non-option "
5642 "arguments are retrieved via a server @emph{INQUIRE}."
5645 new_command("ATTR", 0, 0, 1, 0, attr_command
, _(
5646 "ATTR [--inquire] SET|GET|DELETE|LIST [<attribute>] element[<TAB>child[..]] ..\n" /* Modifying element attributes. */
5648 "@item ATTR SET attribute element[<TAB>child[..]] [value]\n"
5649 " Stores or updates an @var{attribute} name and optional @var{value} of an "
5650 "element. When no @var{value} is specified any existing value will be removed."
5652 "@item ATTR DELETE attribute element[<TAB>child[..]]\n"
5653 " Removes an attribute from an element. If @var{attribute} is @code{_name} "
5654 "or @code{target} an error is returned. Use the @command{DELETE} command "
5655 "(@pxref{DELETE}) instead."
5657 "@item ATTR LIST element[<TAB>child[..]]\n"
5658 " Retrieves a newline separated list of attributes names and values "
5659 "from the specified element. Each attribute name and value is space delimited."
5661 "@item ATTR GET attribute element[<TAB>child[..]]\n"
5662 " Retrieves the value of an @var{attribute} from an element."
5665 "When the @option{--inquire} option is passed then all remaining non-option "
5666 "arguments are retrieved via a server @emph{INQUIRE}."
5668 "@xref{Target Attribute}, for details about this special attribute and also "
5669 "@pxref{Other Attributes} for other attributes that are handled specially "
5670 "by @command{pwmd}."
5673 new_command("XPATH", 0, 0, 1, 0, xpath_command
, _(
5674 "XPATH [--inquire] <expression>[<TAB>[value]]\n" /* Modifying more than one element. */
5675 "Evaluates an XPath @var{expression}. If no @var{value} argument is "
5676 "specified it is assumed the expression is a request to return a result. "
5677 "Otherwise, the result is set to the @var{value} argument and the document is "
5678 "updated. If there is no @var{value} after the @key{TAB} character, the value "
5679 "is assumed to be empty and the document is updated. For example:"
5682 "XPATH //element[@@_name='password']@key{TAB}\n"
5685 "would clear the content of all @var{password} elements in the data file "
5686 "while leaving off the trailing @key{TAB} would return all @var{password} "
5687 "elements in @abbr{XML} format."
5689 "When the @option{--inquire} option is passed then all remaining non-option "
5690 "arguments are retrieved via a server @emph{INQUIRE}."
5692 "See @url{https://www.w3schools.com/xml/xpath_intro.asp} for @abbr{XPATH} "
5693 "expression syntax."
5696 new_command("XPATHATTR", 0, 0, 1, 0, xpathattr_command
, _(
5697 "XPATHATTR [--inquire] SET|DELETE <name> <expression>[<TAB>[<value>]]\n" /* Modifying more than one element's attributes. */
5698 "Like the @code{XPATH} command (@pxref{XPATH}) but operates on element "
5699 "attributes and does not return a result. For the @var{SET} operation the "
5700 "@var{value} is optional but the field is required. If not specified then "
5701 "the attribute value will be empty. For example:"
5704 "XPATHATTR SET password //element[@@_name='password']@key{TAB}\n"
5707 "would create a @var{password} attribute for each @var{password} element "
5708 "found in the document. The attribute value will be empty but still exist."
5710 "When the @option{--inquire} option is passed then all remaining non-option "
5711 "arguments are retrieved via a server @emph{INQUIRE}."
5713 "See @url{https://www.w3schools.com/xml/xpath_intro.asp} for @abbr{XPATH} "
5714 "expression syntax."
5717 new_command("IMPORT", 0, 0, 1, 0, import_command
, _(
5718 "IMPORT [--root=element[<TAB>child[..]]]\n" /* Creating elements from XML. */
5719 "This command uses a server @emph{INQUIRE} to retrieve data from the client."
5721 "Like the @code{STORE} command (@pxref{STORE}), but the @var{content} "
5722 "argument is raw @abbr{XML} data. The content is created as a child of "
5723 "the element path specified with the @option{--root} option or at the "
5724 "document root when not specified. Existing elements of the same name will "
5727 "The content must begin with an @abbr{XML} element node. @xref{Introduction}, "
5731 new_command("DUMP", 0, 1, 1, 0, dump_command
, _(
5732 "DUMP\n" /* Showing the XML document. */
5733 "Shows the in memory @abbr{XML} document with indenting. @xref{XPATH}, for "
5734 "dumping a specific node."
5737 new_command("LOCK", 0, 0, 0, 0, lock_command
, _(
5738 "LOCK\n" /* Locking the current data file. */
5739 "Locks the mutex associated with the opened file. This prevents other clients "
5740 "from sending commands to the same opened file until the client "
5741 "that sent this command either disconnects or sends the @code{UNLOCK} "
5742 "command. @xref{UNLOCK}."
5745 new_command("UNLOCK", 0, 1, 0, 0, unlock_command
, _(
5746 "UNLOCK\n" /* Removing a data file lock. */
5747 "Unlocks the file mutex which was locked with the @code{LOCK} command or "
5748 "a commands' @option{--lock} option (@pxref{LOCK}, @pxref{OPEN}, "
5749 "@pxref{ISCACHED})."
5752 new_command("GETCONFIG", 0, 1, 1, 0, getconfig_command
, _(
5753 "GETCONFIG [filename] <parameter>\n" /* Obtaining a configuration value. */
5754 "Returns the value of a @command{pwmd} configuration @var{parameter} with a "
5755 "data response. If no file has been opened then the value for @var{filename} "
5756 "or the default from the @var{global} section will be returned. If a file "
5757 "has been opened and no @var{filename} is specified, the value previously "
5758 "set with the @code{OPTION} command (@pxref{OPTION}) will be returned."
5761 new_command("OPTION", 0, 1, 1, 0, option_command
, _(
5762 "OPTION <NAME>=[<VALUE>]\n" /* Setting various client parameters. */
5763 "Sets a client option @var{name} to @var{value}. The value for an option is "
5764 "kept for the duration of the connection with the exception of the "
5765 "@command{pinentry} options which are defaults for all future connections "
5766 "(@pxref{Pinentry}). When @var{value} is empty the option is unset."
5769 "@item DISABLE-PINENTRY\n"
5770 "Disable use of @command{pinentry} for passphrase retrieval. When @code{1}, a "
5771 "server inquire is sent to the client to obtain the passphrase. This option "
5772 "may be set as needed before the @code{OPEN} (@pxref{OPEN}), @code{PASSWD} "
5773 "(@pxref{PASSWD}) and @code{SAVE} (@pxref{SAVE}) commands. Set to @code{0} "
5774 "to use a @command{pinentry}."
5777 "Set or unset the X11 display to use when prompting for a passphrase."
5780 "Set the terminal device path to use when prompting for a passphrase."
5783 "Set the terminal type for use with @option{TTYNAME}."
5786 "Associates the thread ID of the connection with the specified textual "
5787 "representation. Useful for debugging log messages. May not contain whitespace."
5789 "@item LOCK-TIMEOUT\n"
5790 "When not @code{0}, the duration in tenths of a second to wait for the file "
5791 "mutex which has been locked by another thread to be released before returning "
5792 "an error. When @code{-1} the error will be returned immediately."
5794 "@item CLIENT-STATE\n"
5795 "When set to @code{1} then client state status messages for other clients are "
5796 "sent to the current client. The default is @code{0}."
5800 new_command("LS", 0, 1, 1, 0, ls_command
, _(
5801 "LS [--verbose]\n" /* Showing available data files. */
5802 "Returns a newline separated list of data files stored in the data directory "
5803 "@file{HOMEDIR/data} (@pxref{Invoking}) with a data response. When the "
5804 "@var{--verbose} option is passed, the space-separated filesystem inode "
5805 "access, modification and change times are appended to the line."
5808 new_command("BULK", 0, 1, 1, 0, bulk_command
, _(
5809 "BULK [--inquire]\n" /* Run a series of commands in sequence. */
5810 "Parses a semi-canonical s-expression representing a series of protocol "
5811 "commands to be run in sequence (@pxref{Bulk Commands}). Returns a canonical "
5812 "s-expression containing each commands id, return value and result data "
5815 "When the @option{--inquire} option is passed then all remaining non-option "
5816 "arguments are retrieved via a server @emph{INQUIRE}."
5819 new_command("RESET", 0, 1, 1, 0, NULL
, _(
5820 "RESET\n" /* Resetting the client state. */
5821 "Closes the currently opened file but keeps any previously set client options "
5825 new_command("NOP", 0, 1, 1, 0, nop_command
, _(
5826 "NOP\n" /* Testing the connection. */
5827 "This command does nothing. It is useful for testing the connection for a "
5828 "timeout condition."
5831 /* !END-HELP-TEXT! */
5832 new_command ("CANCEL", 0, 1, 1, 0, NULL
, NULL
);
5833 new_command ("END", 0, 1, 1, 0, NULL
, NULL
);
5834 new_command ("BYE", 0, 1, 1, 0, NULL
, NULL
);
5837 for (i
= 0; command_table
[i
]; i
++);
5838 qsort (command_table
, i
- 1, sizeof (struct command_table_s
*),
5843 register_commands (assuan_context_t ctx
)
5847 for (; command_table
[i
]; i
++)
5849 if (!command_table
[i
]->handler
)
5852 rc
= assuan_register_command (ctx
, command_table
[i
]->name
,
5853 command_table
[i
]->handler
,
5854 command_table
[i
]->help
);
5859 rc
= assuan_register_bye_notify (ctx
, bye_notify
);
5863 rc
= assuan_register_reset_notify (ctx
, reset_notify
);
5867 rc
= assuan_register_pre_cmd_notify (ctx
, command_startup
);
5871 return assuan_register_post_cmd_notify (ctx
, command_finalize
);