1 /* vim:tw=78:ts=8:sw=4:set ft=c: */
3 Copyright (C) 2006-2009 Ben Kibbey <bjk@luxsci.net>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program 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 this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02110-1301 USA
26 #include <sys/socket.h>
35 #include <sys/types.h>
37 #include <sys/select.h>
60 static gpg_error_t
send_pinentry_options(pwm_t
*pwm
);
61 static gpg_error_t
_pwmd_process(pwm_t
*pwm
);
62 static gpg_error_t
set_pinentry_retry(pwm_t
*pwm
);
63 static gpg_error_t
get_custom_passphrase(pwm_t
*pwm
, char **result
);
65 static const char *_pwmd_strerror(gpg_error_t e
)
67 gpg_err_code_t code
= gpg_err_code(e
);
69 if (code
>= GPG_ERR_USER_1
&& code
< gpg_err_code(EPWMD_MAX
)) {
72 return N_("No file is open");
74 return N_("General LibXML error");
76 return N_("File modified");
78 return N_("Unknown error");
85 const char *pwmd_strerror(gpg_error_t code
)
87 const char *p
= _pwmd_strerror(code
);
89 return p
? p
: gpg_strerror(code
);
92 int pwmd_strerror_r(gpg_error_t code
, char *buf
, size_t size
)
94 const char *p
= _pwmd_strerror(code
);
97 snprintf(buf
, size
, "%s", p
);
105 return gpg_strerror_r(code
, buf
, size
);
108 gpg_error_t
pwmd_init()
110 static int initialized
;
119 bindtextdomain("libpwmd", LOCALEDIR
);
122 assuan_set_malloc_hooks(pwmd_malloc
, pwmd_realloc
, pwmd_free
);
123 assuan_set_assuan_err_source(GPG_ERR_SOURCE_DEFAULT
);
128 gpg_error_t
_connect_finalize(pwm_t
*pwm
)
131 int n
= assuan_get_active_fds(pwm
->ctx
, 0, active
, N_ARRAY(active
));
135 return GPG_ERR_EBADFD
;
141 assuan_set_pointer(pwm
->ctx
, pwm
);
144 // Until X11 forwarding is supported, disable the remote pwmd pinentry.
146 pwm
->tcp_conn
->state
= SSH_NONE
;
147 rc
= pwmd_command(pwm
, NULL
, "SET ENABLE_PINENTRY=0");
155 rc
= pwmd_command(pwm
, NULL
, "SET NAME=%s", pwm
->name
);
164 static gpg_error_t
_pwmd_connect_url(pwm_t
*pwm
, const char *url
, int async
)
166 char *p
= (char *)url
;
170 return GPG_ERR_INV_ARG
;
172 if (!p
|| !strncmp(p
, "file://", 7) || !strncmp(p
, "local://", 8)) {
174 if (!strncmp(p
, "file://", 7))
182 else if (!strncmp(p
, "ssh://", 6) || !strncmp(p
, "ssh6://", 7) ||
183 !strncmp(p
, "ssh4://", 7)) {
185 return GPG_ERR_NOT_IMPLEMENTED
;
189 char *identity
= NULL
;
190 char *known_hosts
= NULL
;
191 char *username
= NULL
;
193 if (!strncmp(p
, "ssh6://", 7)) {
194 rc
= pwmd_setopt(pwm
, PWMD_OPTION_IP_VERSION
, PWMD_IPV6
);
197 else if (!strncmp(p
, "ssh4://", 7)) {
198 rc
= pwmd_setopt(pwm
, PWMD_OPTION_IP_VERSION
, PWMD_IPV4
);
202 rc
= pwmd_setopt(pwm
, PWMD_OPTION_IP_VERSION
, PWMD_IP_ANY
);
209 rc
= _parse_ssh_url(p
, &host
, &port
, &username
, &identity
,
216 rc
= pwmd_ssh_connect_async(pwm
, host
, port
, identity
, username
,
219 rc
= pwmd_ssh_connect(pwm
, host
, port
, identity
, username
,
233 pwmd_free(known_hosts
);
240 rc
= pwmd_connect(pwm
, p
);
241 pwm
->state
= ASYNC_DONE
;
245 gpg_error_t
pwmd_connect_url(pwm_t
*pwm
, const char *url
)
247 return _pwmd_connect_url(pwm
, url
, 0);
250 gpg_error_t
pwmd_connect_url_async(pwm_t
*pwm
, const char *url
)
252 return _pwmd_connect_url(pwm
, url
, 1);
255 gpg_error_t
pwmd_connect(pwm_t
*pwm
, const char *path
)
257 char *socketpath
= NULL
;
258 assuan_context_t ctx
;
264 return GPG_ERR_INV_ARG
;
266 pwbuf
= _getpwuid(&pw
);
269 return gpg_error_from_errno(errno
);
272 socketpath
= pwmd_strdup_printf("%s/.pwmd/socket", pw
.pw_dir
);
274 socketpath
= _expand_homedir((char *)path
, &pw
);
279 return gpg_error_from_errno(ENOMEM
);
281 rc
= assuan_socket_connect_ext(&ctx
, socketpath
, -1, 0);
282 pwmd_free(socketpath
);
285 return gpg_err_code(rc
);
288 return _connect_finalize(pwm
);
291 static void disconnect(pwm_t
*pwm
)
293 if (!pwm
|| !pwm
->ctx
)
296 assuan_disconnect(pwm
->ctx
);
301 void pwmd_close(pwm_t
*pwm
)
309 pwmd_free(pwm
->password
);
312 pwmd_free(pwm
->title
);
315 pwmd_free(pwm
->desc
);
318 pwmd_free(pwm
->prompt
);
320 if (pwm
->pinentry_tty
)
321 pwmd_free(pwm
->pinentry_tty
);
323 if (pwm
->pinentry_display
)
324 pwmd_free(pwm
->pinentry_display
);
326 if (pwm
->pinentry_term
)
327 pwmd_free(pwm
->pinentry_term
);
330 pwmd_free(pwm
->lcctype
);
333 pwmd_free(pwm
->lcmessages
);
336 pwmd_free(pwm
->filename
);
339 pwmd_free(pwm
->name
);
343 _free_ssh_conn(pwm
->tcp_conn
);
348 _pinentry_disconnect(pwm
);
354 static gpg_error_t
do_async_command(pwm_t
*pwm
, char **result
)
360 s
= pwmd_process(pwm
, &rc
, result
);
362 if (s
!= ASYNC_DONE
) {
369 } while (s
!= ASYNC_DONE
);
374 gpg_error_t
pwmd_ssh_connect_async(pwm_t
*pwm
, const char *host
, int port
,
375 const char *identity
, const char *user
, const char *known_hosts
)
378 return GPG_ERR_NOT_IMPLEMENTED
;
380 return _do_pwmd_ssh_connect_async(pwm
, host
, port
, identity
, user
,
381 known_hosts
, ASYNC_CMD_CONNECT
);
385 gpg_error_t
pwmd_ssh_connect(pwm_t
*pwm
, const char *host
, int port
,
386 const char *identity
, const char *user
, const char *known_hosts
)
389 return GPG_ERR_NOT_IMPLEMENTED
;
393 rc
= _do_pwmd_ssh_connect_async(pwm
, host
, port
, identity
, user
,
394 known_hosts
, ASYNC_CMD_CONNECT
);
395 return rc
|| do_async_command(pwm
, NULL
);
399 gpg_error_t
pwmd_get_hostkey(pwm_t
*pwm
, const char *host
, int port
,
403 return GPG_ERR_NOT_IMPLEMENTED
;
407 rc
= _do_pwmd_ssh_connect_async(pwm
, host
, port
, NULL
, NULL
, NULL
,
410 return rc
|| do_async_command(pwm
, result
);
414 gpg_error_t
pwmd_get_hostkey_async(pwm_t
*pwm
, const char *host
, int port
)
417 return GPG_ERR_NOT_IMPLEMENTED
;
419 return _do_pwmd_ssh_connect_async(pwm
, host
, port
, NULL
, NULL
, NULL
,
424 static int inquire_realloc_cb(void *data
, const void *buffer
, size_t len
)
426 membuf_t
*mem
= (membuf_t
*)data
;
432 if ((p
= pwmd_realloc(mem
->buf
, mem
->len
+ len
)) == NULL
)
433 return gpg_error_from_errno(ENOMEM
);
436 memcpy((char *)mem
->buf
+ mem
->len
, buffer
, len
);
441 static int inquire_cb(void *data
, const char *keyword
)
443 pwm_t
*pwm
= (pwm_t
*)data
;
446 /* Shouldn't get this far without a callback. */
447 if (!pwm
->inquire_func
)
448 return GPG_ERR_INV_ARG
;
455 rc
= pwm
->inquire_func(pwm
->inquire_data
, keyword
, rc
, &result
, &len
);
456 rc
= gpg_err_code(rc
);
458 if (rc
== GPG_ERR_EOF
|| !rc
) {
459 if (len
<= 0 || !result
) {
464 arc
= assuan_send_data(pwm
->ctx
, result
, len
);
465 arc
= gpg_err_code(arc
);
467 if (rc
== GPG_ERR_EOF
) {
478 pwm
->inquire_sent
+= len
;
480 if (pwm
->status_func
) {
481 char buf
[ASSUAN_LINELENGTH
];
483 snprintf(buf
, sizeof(buf
), "XFER %u %u", pwm
->inquire_sent
,
485 rc
= pwm
->status_func(pwm
->status_data
, buf
);
491 rc
= _pwmd_process(pwm
);
493 if (rc
== GPG_ERR_EAGAIN
)
498 return gpg_err_code(rc
);
501 static gpg_error_t
do_nb_command(pwm_t
*pwm
, const char *cmd
, ...)
508 if (pwm
->state
== ASYNC_DONE
)
509 pwm
->state
= ASYNC_INIT
;
511 if (pwm
->state
!= ASYNC_INIT
)
512 return GPG_ERR_INV_STATE
;
514 buf
= pwmd_malloc(ASSUAN_LINELENGTH
+1);
517 return gpg_error_from_errno(ENOMEM
);
520 len
= vsnprintf(buf
, ASSUAN_LINELENGTH
+1, cmd
, ap
);
523 if (len
>= ASSUAN_LINELENGTH
+1) {
525 return GPG_ERR_LINE_TOO_LONG
;
528 rc
= assuan_write_line(pwm
->ctx
, buf
);
532 pwm
->state
= ASYNC_PROCESS
;
534 return gpg_err_code(rc
);
537 gpg_error_t
pwmd_open_async(pwm_t
*pwm
, const char *filename
)
540 const char *f
= NULL
;
543 if (!pwm
|| !filename
)
544 return GPG_ERR_INV_ARG
;
547 return GPG_ERR_INV_STATE
;
549 if (pwm
->cmd
!= ASYNC_CMD_NONE
)
550 return GPG_ERR_ASS_NESTED_COMMANDS
;
552 if (pwm
->lastcmd
== ASYNC_CMD_NONE
) {
556 pwmd_free(pwm
->filename
);
558 pwm
->filename
= pwmd_strdup(filename
);
561 return gpg_error_from_errno(ENOMEM
);
563 gpg_error_t rc
= send_pinentry_options(pwm
);
568 rc
= get_custom_passphrase(pwm
, &p
);
570 if (rc
&& rc
!= GPG_ERR_NO_DATA
)
576 else if (pwm
->lastcmd
== ASYNC_CMD_OPEN2
) {
581 else if (pwm
->lastcmd
== ASYNC_CMD_OPEN
) {
582 rc
= set_pinentry_retry(pwm
);
591 return GPG_ERR_INV_STATE
;
593 pwm
->cmd
= ASYNC_CMD_OPEN
;
594 return do_nb_command(pwm
, "OPEN %s %s", f
, p
? p
: "");
597 gpg_error_t
pwmd_save_async(pwm_t
*pwm
)
602 return GPG_ERR_INV_ARG
;
605 return GPG_ERR_INV_STATE
;
607 if (pwm
->cmd
!= ASYNC_CMD_NONE
)
608 return GPG_ERR_ASS_NESTED_COMMANDS
;
610 if (pwm
->lastcmd
!= ASYNC_CMD_SAVE2
) {
611 gpg_error_t rc
= send_pinentry_options(pwm
);
616 rc
= get_custom_passphrase(pwm
, &p
);
618 if (rc
&& rc
!= GPG_ERR_NO_DATA
)
626 pwm
->cmd
= ASYNC_CMD_SAVE
;
627 return do_nb_command(pwm
, "SAVE %s", p
? p
: "");
630 static gpg_error_t
parse_assuan_line(pwm_t
*pwm
)
636 rc
= assuan_read_line(pwm
->ctx
, &line
, &len
);
639 if (line
[0] == 'O' && line
[1] == 'K' &&
640 (line
[2] == 0 || line
[2] == ' ')) {
641 pwm
->state
= ASYNC_DONE
;
643 else if (line
[0] == '#') {
645 else if (line
[0] == 'S' && (line
[1] == 0 || line
[1] == ' ')) {
646 if (pwm
->status_func
) {
647 rc
= pwm
->status_func(pwm
->status_data
,
648 line
[1] == 0 ? line
+1 : line
+2);
651 else if (line
[0] == 'E' && line
[1] == 'R' && line
[2] == 'R' &&
652 (line
[3] == 0 || line
[3] == ' ')) {
655 pwm
->state
= ASYNC_DONE
;
659 return gpg_err_code(rc
);
662 gpg_error_t
pwmd_pending_line(pwm_t
*pwm
)
665 return GPG_ERR_INV_ARG
;
668 return GPG_ERR_INV_STATE
;
670 return assuan_pending_line(pwm
->ctx
) ? 0 : GPG_ERR_NO_DATA
;
673 static pwmd_async_t
reset_async(pwm_t
*pwm
, int done
)
675 pwm
->state
= ASYNC_INIT
;
676 pwm
->cmd
= pwm
->lastcmd
= ASYNC_CMD_NONE
;
679 if (pwm
->nb_fd
!= -1) {
684 if (pwm
->_password
) {
685 pwmd_free(pwm
->_password
);
686 pwm
->_password
= NULL
;
691 pwm
->tcp_conn
->rc
= 0;
693 if (done
&& pwm
->tcp_conn
) {
694 _free_ssh_conn(pwm
->tcp_conn
);
695 pwm
->tcp_conn
= NULL
;
703 * Used for processing status messages when not in an async command and for
704 * waiting for the result from pwmd_open_async() and pwmd_save_async().
706 static gpg_error_t
_pwmd_process(pwm_t
*pwm
)
710 struct timeval tv
= {0, 0};
714 FD_SET(pwm
->fd
, &fds
);
716 n
= pth_select(pwm
->fd
+1, &fds
, NULL
, NULL
, &tv
);
718 n
= select(pwm
->fd
+1, &fds
, NULL
, NULL
, &tv
);
722 return gpg_error_from_syserror();
725 if (FD_ISSET(pwm
->fd
, &fds
))
726 rc
= parse_assuan_line(pwm
);
729 while (!rc
&& assuan_pending_line(pwm
->ctx
))
730 rc
= parse_assuan_line(pwm
);
732 return gpg_err_code(rc
);
735 static void reset_handle(pwm_t
*h
)
740 _pinentry_disconnect(h
);
748 gpg_error_t
pwmd_disconnect(pwm_t
*pwm
)
751 return GPG_ERR_INV_ARG
;
754 if (pwm
->fd
== -1 && pwm
->tcp_conn
&& pwm
->tcp_conn
->fd
== -1)
758 return GPG_ERR_INV_STATE
;
764 _ssh_disconnect(pwm
);
771 pwmd_async_t
pwmd_process(pwm_t
*pwm
, gpg_error_t
*rc
, char **result
)
773 #if defined(WITH_PINENTRY) || defined(WITH_TCP)
776 struct timeval tv
= {0, 0};
783 return GPG_ERR_INV_ARG
;
788 *rc
= GPG_ERR_INV_ARG
;
791 else if (!pwm
->ctx
) {
794 *rc
= GPG_ERR_INV_STATE
;
798 case ASYNC_CMD_CONNECT
:
799 case ASYNC_CMD_HOSTKEY
:
805 /* When not in a command, this will let libassuan process status messages
806 * by calling PWMD_OPTION_STATUS_FUNC. The client can poll the file
807 * descriptor returned by pwmd_get_fd() to determine when this should be
808 * called or call pwmd_pending_line() to determine whether a buffered line
809 * needs to be processed. */
810 if (pwm
->cmd
== ASYNC_CMD_NONE
) {
811 *rc
= _pwmd_process(pwm
);
815 /* Fixes pwmd_open/save_async2() when there is a cached or new file. */
816 if (pwm
->state
== ASYNC_DONE
) {
817 *rc
= _pwmd_process(pwm
);
818 return reset_async(pwm
, 0);
821 if (pwm
->state
!= ASYNC_PROCESS
) {
822 *rc
= GPG_ERR_INV_STATE
;
827 if (pwm
->cmd
== ASYNC_CMD_DNS
) {
830 if (pwm
->tcp_conn
->rc
) {
831 *rc
= pwm
->tcp_conn
->rc
;
832 return reset_async(pwm
, 1);
837 n
= ares_fds(pwm
->tcp_conn
->chan
, &rfds
, &wfds
);
839 /* Shouldn't happen. */
844 n
= pth_select(n
, &rfds
, &wfds
, NULL
, &tv
);
846 n
= select(n
, &rfds
, &wfds
, NULL
, &tv
);
850 *rc
= gpg_error_from_syserror();
851 return reset_async(pwm
, 1);
855 ares_process(pwm
->tcp_conn
->chan
, &rfds
, &wfds
);
859 else if (pwm
->cmd
== ASYNC_CMD_CONNECT
) {
860 if (pwm
->tcp_conn
->rc
== GPG_ERR_EINPROGRESS
) {
862 socklen_t len
= sizeof(int);
865 FD_SET(pwm
->tcp_conn
->fd
, &fds
);
867 n
= pth_select(pwm
->tcp_conn
->fd
+1, NULL
, &fds
, NULL
, &tv
);
869 n
= select(pwm
->tcp_conn
->fd
+1, NULL
, &fds
, NULL
, &tv
);
872 if (!n
|| !FD_ISSET(pwm
->tcp_conn
->fd
, &fds
))
875 *rc
= gpg_error_from_syserror();
876 return reset_async(pwm
, 1);
879 ret
= getsockopt(pwm
->tcp_conn
->fd
, SOL_SOCKET
, SO_ERROR
, &n
, &len
);
882 *rc
= ret
? gpg_error_from_syserror() : gpg_error_from_errno(n
);
883 return reset_async(pwm
, 1);
886 pwm
->tcp_conn
->state
= SSH_NONE
;
887 pwm
->tcp_conn
->rc
= 0;
888 *rc
= _setup_ssh_session(pwm
);
890 if (*rc
&& *rc
!= GPG_ERR_EAGAIN
)
891 return reset_async(pwm
, 1);
893 else if (pwm
->tcp_conn
->rc
) {
894 *rc
= pwm
->tcp_conn
->rc
;
895 return reset_async(pwm
, 1);
898 switch (pwm
->tcp_conn
->state
) {
900 *rc
= _setup_ssh_init(pwm
);
903 *rc
= _setup_ssh_authlist(pwm
);
906 *rc
= _setup_ssh_auth(pwm
);
909 *rc
= _setup_ssh_channel(pwm
);
912 *rc
= _setup_ssh_shell(pwm
);
918 if (*rc
== GPG_ERR_EAGAIN
) {
920 return ASYNC_PROCESS
;
924 switch (pwm
->tcp_conn
->cmd
) {
925 case ASYNC_CMD_HOSTKEY
:
926 *result
= pwmd_strdup(pwm
->tcp_conn
->hostkey
);
929 *rc
= GPG_ERR_ENOMEM
;
936 return reset_async(pwm
, *rc
? 1 : 0);
941 if (pwm
->cmd
== ASYNC_CMD_OPEN2
|| pwm
->cmd
== ASYNC_CMD_SAVE2
) {
944 if (pwm
->nb_fd
== -1) {
945 *rc
= GPG_ERR_INV_STATE
;
946 return reset_async(pwm
, 0);
950 FD_SET(pwm
->nb_fd
, &fds
);
951 FD_SET(pwm
->fd
, &fds
);
953 n
= pth_select(pwm
->nb_fd
+1, &fds
, NULL
, NULL
, &tv
);
955 n
= select(pwm
->nb_fd
+1, &fds
, NULL
, NULL
, &tv
);
958 *rc
= gpg_error_from_syserror();
959 return reset_async(pwm
, 0);
962 if (n
> 0 && FD_ISSET(pwm
->nb_fd
, &fds
)) {
965 size_t len
= pth_read(pwm
->nb_fd
, &nb
, sizeof(nb
));
967 size_t len
= read(pwm
->nb_fd
, &nb
, sizeof(nb
));
969 waitpid(pwm
->nb_pid
, &status
, WNOHANG
);
971 if (len
!= sizeof(nb
)) {
972 memset(&nb
, 0, sizeof(pwmd_nb_status_t
));
973 *rc
= gpg_error_from_syserror();
974 return reset_async(pwm
, 0);
980 return reset_async(pwm
, 0);
982 /* Since the non-blocking pinentry returned a success, do a
983 * non-blocking OPEN or SAVE. */
984 pwmd_async_cmd_t c
= pwm
->cmd
;
986 pwm
->_password
= pwmd_strdup(nb
.password
);
987 memset(&nb
, 0, sizeof(pwmd_nb_status_t
));
990 if (!pwm
->_password
) {
991 *rc
= gpg_error_from_errno(ENOMEM
);
992 return reset_async(pwm
, 0);
995 if (c
== ASYNC_CMD_SAVE2
)
996 *rc
= pwmd_save_async(pwm
);
998 *rc
= pwmd_open_async(pwm
, pwm
->filename
);
1001 reset_async(pwm
, 0);
1005 return ASYNC_PROCESS
;
1008 /* Fall through so status messages can be processed during the
1014 *rc
= GPG_ERR_INV_STATE
;
1015 return reset_async(pwm
, 0);
1018 /* This is for pwmd_open_async() and pwmd_save_async(). For pinentry
1020 *rc
= _pwmd_process(pwm
);
1022 if (*rc
&& *rc
!= GPG_ERR_INV_PASSPHRASE
)
1023 return reset_async(pwm
, 0);
1025 if (pwm
->cmd
== ASYNC_CMD_OPEN
&&
1026 *rc
== GPG_ERR_INV_PASSPHRASE
&&
1028 (!pwm
->tcp_conn
|| (pwm
->tcp_conn
&& pwm
->lastcmd
== ASYNC_CMD_OPEN2
)) &&
1030 ++pwm
->pin_try
< pwm
->pinentry_tries
) {
1031 if (!get_custom_passphrase(pwm
, NULL
))
1034 #ifdef WITH_PINENTRY
1035 if (pwm
->_password
) {
1036 reset_async(pwm
, 0);
1037 pwm
->lastcmd
= ASYNC_CMD_OPEN2
;
1038 *rc
= pwmd_open_async2(pwm
, pwm
->filename
);
1042 reset_async(pwm
, 0);
1043 pwm
->lastcmd
= ASYNC_CMD_OPEN
;
1044 *rc
= pwmd_open_async(pwm
, pwm
->filename
);
1045 #ifdef WITH_PINENTRY
1051 if (*rc
|| pwm
->state
== ASYNC_DONE
)
1052 return reset_async(pwm
, 0);
1057 gpg_error_t
_assuan_command(pwm_t
*pwm
, assuan_context_t ctx
,
1058 char **result
, const char *cmd
)
1064 return GPG_ERR_INV_ARG
;
1066 if (strlen(cmd
) >= ASSUAN_LINELENGTH
+1)
1067 return GPG_ERR_LINE_TOO_LONG
;
1071 rc
= assuan_transact(ctx
, cmd
, inquire_realloc_cb
, &data
,
1073 pwm
->pctx
== ctx
? pwm
->_inquire_func
: inquire_cb
,
1074 pwm
->pctx
== ctx
? pwm
->_inquire_data
: pwm
,
1078 pwm
->status_func
, pwm
->status_data
);
1082 pwmd_free(data
.buf
);
1088 inquire_realloc_cb(&data
, "", 1);
1091 pwmd_free(data
.buf
);
1092 rc
= GPG_ERR_INV_ARG
;
1095 *result
= (char *)data
.buf
;
1099 return gpg_err_code(rc
);
1102 gpg_error_t
pwmd_inquire(pwm_t
*pwm
, const char *cmd
, pwmd_inquire_cb_t fn
,
1105 if (!pwm
|| !cmd
|| !fn
)
1106 return GPG_ERR_INV_ARG
;
1109 return GPG_ERR_INV_STATE
;
1111 pwm
->inquire_func
= fn
;
1112 pwm
->inquire_data
= data
;
1113 pwm
->inquire_sent
= 0;
1114 return _assuan_command(pwm
, pwm
->ctx
, NULL
, cmd
);
1117 gpg_error_t
pwmd_command_ap(pwm_t
*pwm
, char **result
, const char *cmd
,
1125 return GPG_ERR_INV_ARG
;
1128 return GPG_ERR_INV_STATE
;
1131 * C99 allows the dst pointer to be null which will calculate the length
1132 * of the would-be result and return it.
1135 len
= vsnprintf(NULL
, 0, cmd
, ap
)+1;
1136 buf
= (char *)pwmd_malloc(len
);
1140 return gpg_error_from_errno(ENOMEM
);
1143 len
= vsnprintf(buf
, len
, cmd
, ap2
);
1146 if (buf
[strlen(buf
)-1] == '\n')
1147 buf
[strlen(buf
)-1] = 0;
1149 if (buf
[strlen(buf
)-1] == '\r')
1150 buf
[strlen(buf
)-1] = 0;
1152 gpg_error_t rc
= _assuan_command(pwm
, pwm
->ctx
, result
, buf
);
1157 gpg_error_t
pwmd_command(pwm_t
*pwm
, char **result
, const char *cmd
, ...)
1162 return GPG_ERR_INV_ARG
;
1165 return GPG_ERR_INV_STATE
;
1171 gpg_error_t rc
= pwmd_command_ap(pwm
, result
, cmd
, ap
);
1176 static gpg_error_t
send_pinentry_options(pwm_t
*pwm
)
1180 if (pwm
->pinentry_path
) {
1181 rc
= pwmd_command(pwm
, NULL
, "SET PINENTRY_PATH=%s",
1182 pwm
->pinentry_path
);
1188 if (pwm
->pinentry_tty
) {
1189 rc
= pwmd_command(pwm
, NULL
, "SET TTYNAME=%s", pwm
->pinentry_tty
);
1195 if (pwm
->pinentry_term
) {
1196 rc
= pwmd_command(pwm
, NULL
, "SET TTYTYPE=%s", pwm
->pinentry_term
);
1202 if (pwm
->pinentry_display
) {
1203 rc
= pwmd_command(pwm
, NULL
, "SET DISPLAY=%s",
1204 pwm
->pinentry_display
);
1211 rc
= pwmd_command(pwm
, NULL
, "SET TITLE=%s", pwm
->title
);
1218 rc
= pwmd_command(pwm
, NULL
, "SET DESC=%s", pwm
->desc
);
1225 rc
= pwmd_command(pwm
, NULL
, "SET PROMPT=%s", pwm
->prompt
);
1232 rc
= pwmd_command(pwm
, NULL
, "SET LC_CTYPE=%s", pwm
->lcctype
);
1238 if (pwm
->lcmessages
) {
1239 rc
= pwmd_command(pwm
, NULL
, "SET LC_MESSAGES=%s", pwm
->lcmessages
);
1245 if (pwm
->pinentry_timeout
>= 0 && !pwm
->pin_try
) {
1246 rc
= pwmd_command(pwm
, NULL
, "SET PINENTRY_TIMEOUT=%i",
1247 pwm
->pinentry_timeout
);
1256 gpg_error_t
pwmd_socket_type(pwm_t
*pwm
, pwmd_socket_t
*result
)
1258 if (!pwm
|| !result
)
1259 return GPG_ERR_INV_ARG
;
1262 if ((pwm
->fd
== -1 && !pwm
->tcp_conn
) ||
1263 (pwm
->fd
== -1 && pwm
->tcp_conn
&& pwm
->tcp_conn
->fd
== -1))
1267 return GPG_ERR_INV_STATE
;
1270 *result
= pwm
->tcp_conn
? PWMD_SOCKET_SSH
: PWMD_SOCKET_LOCAL
;
1272 *result
= PWMD_SOCKET_LOCAL
;
1277 static gpg_error_t
set_pinentry_retry(pwm_t
*pwm
)
1281 if (pwm
->pin_try
== 1) {
1282 rc
= pwmd_command(pwm
, NULL
, "SET TITLE=%s",
1283 N_("Invalid passphrase, please try again."));
1288 rc
= pwmd_command(pwm
, NULL
, "SET PINENTRY_TIMEOUT=0");
1294 static gpg_error_t
get_custom_passphrase(pwm_t
*pwm
, char **result
)
1296 gpg_error_t rc
= GPG_ERR_NO_DATA
;
1301 if (pwm
->password
|| pwm
->passfunc
)
1305 if (pwm
->password
) {
1307 *result
= pwm
->password
;
1309 else if (pwm
->passfunc
)
1310 rc
= pwm
->passfunc(pwm
->passdata
, result
);
1315 static gpg_error_t
do_pwmd_open(pwm_t
*pwm
, const char *filename
, int nb
,
1318 char *result
= NULL
;
1319 char *password
= NULL
;
1322 if (pwm
->lastcmd
!= ASYNC_CMD_OPEN2
)
1325 if (!pwm
|| !filename
|| !*filename
)
1326 return GPG_ERR_INV_ARG
;
1329 return GPG_ERR_INV_STATE
;
1332 * Avoid calling pinentry if the password is cached on the server or if
1333 * this is a new file.
1335 rc
= pwmd_command(pwm
, &result
, "ISCACHED %s", filename
);
1337 if (rc
== GPG_ERR_ENOENT
)
1340 if (rc
&& rc
!= GPG_ERR_NOT_FOUND
)
1343 if (rc
== GPG_ERR_NOT_FOUND
) {
1344 rc
= get_custom_passphrase(pwm
, &password
);
1346 if (rc
&& rc
!= GPG_ERR_NO_DATA
)
1348 else if (rc
== GPG_ERR_NO_DATA
)
1349 rc
= GPG_ERR_NOT_FOUND
;
1354 #ifdef WITH_PINENTRY
1355 if (rc
== GPG_ERR_NOT_FOUND
&& local_pinentry
) {
1356 /* Prevent pwmd from using it's pinentry if the passphrase fails. */
1357 if (!pwm
->pin_try
) {
1358 rc
= pwmd_command(pwm
, NULL
, "SET ENABLE_PINENTRY=0");
1364 rc
= _pinentry_open(pwm
, filename
, &password
, nb
);
1366 /* pwmd_process() should be called if using a non-blocking local
1368 if (rc
|| (!rc
&& nb
))
1374 reset_async(pwm
, 0);
1377 if (!local_pinentry
&& !pwm
->tcp_conn
&& !pwm
->pin_try
) {
1379 if (!local_pinentry
&& !pwm
->pin_try
) {
1381 rc
= send_pinentry_options(pwm
);
1387 rc
= pwmd_command(pwm
, NULL
, "OPEN %s %s", filename
,
1388 password
? password
: "");
1391 * Keep the user defined password set with pwmd_setopt(). The password may
1392 * be needed later (pwmd_save()) depending on the pwmd file cache settings.
1394 if (!pwm
->passfunc
&& password
&& password
!= pwm
->password
)
1395 pwmd_free(password
);
1397 if (rc
== GPG_ERR_INV_PASSPHRASE
) {
1398 if (++pwm
->pin_try
< pwm
->pinentry_tries
) {
1399 if (!get_custom_passphrase(pwm
, NULL
))
1402 #ifdef WITH_PINENTRY
1404 if (pwm
->tcp_conn
&& !local_pinentry
)
1406 else if (local_pinentry
)
1407 rc
= _getpin(pwm
, &password
, PWMD_PINENTRY_OPEN_FAILED
);
1411 rc
= _getpin(pwm
, &password
, PWMD_PINENTRY_OPEN_FAILED
);
1421 rc
= set_pinentry_retry(pwm
);
1428 #ifdef WITH_PINENTRY
1429 else if (local_pinentry
)
1430 _pinentry_disconnect(pwm
);
1436 #ifdef WITH_PINENTRY
1437 else if (rc
&& local_pinentry
)
1438 _pinentry_disconnect(pwm
);
1443 pwmd_free(pwm
->filename
);
1445 pwm
->filename
= pwmd_strdup(filename
);
1451 gpg_error_t
pwmd_open2(pwm_t
*pwm
, const char *filename
)
1453 #ifndef WITH_PINENTRY
1454 return GPG_ERR_NOT_IMPLEMENTED
;
1456 return do_pwmd_open(pwm
, filename
, 0, 1);
1460 gpg_error_t
pwmd_open(pwm_t
*pwm
, const char *filename
)
1462 return do_pwmd_open(pwm
, filename
, 0, 0);
1465 gpg_error_t
pwmd_open_async2(pwm_t
*pwm
, const char *filename
)
1467 #ifndef WITH_PINENTRY
1468 return GPG_ERR_NOT_IMPLEMENTED
;
1470 if (!pwm
|| !filename
)
1471 return GPG_ERR_INV_ARG
;
1474 return GPG_ERR_INV_STATE
;
1476 if (pwm
->cmd
!= ASYNC_CMD_NONE
)
1477 return GPG_ERR_ASS_NESTED_COMMANDS
;
1479 /* Initialize a new command since this is not a pinentry retry. */
1480 if (pwm
->lastcmd
!= ASYNC_CMD_OPEN2
)
1483 pwm
->cmd
= ASYNC_CMD_OPEN2
;
1484 pwm
->state
= ASYNC_PROCESS
;
1485 gpg_error_t rc
= do_pwmd_open(pwm
, filename
, 1, 1);
1488 reset_async(pwm
, 0);
1494 static gpg_error_t
do_pwmd_save(pwm_t
*pwm
, int nb
, int local_pinentry
)
1496 char *result
= NULL
;
1497 char *password
= NULL
;
1501 return GPG_ERR_INV_ARG
;
1504 return GPG_ERR_INV_STATE
;
1506 rc
= pwmd_command(pwm
, &result
, "ISCACHED %s", pwm
->filename
);
1508 if (rc
== GPG_ERR_ENOENT
)
1509 rc
= GPG_ERR_NOT_FOUND
;
1511 if (rc
&& rc
!= GPG_ERR_NOT_FOUND
)
1514 if (rc
== GPG_ERR_NOT_FOUND
) {
1515 rc
= get_custom_passphrase(pwm
, &password
);
1517 if (rc
&& rc
!= GPG_ERR_NO_DATA
)
1519 else if (rc
== GPG_ERR_NO_DATA
)
1520 rc
= GPG_ERR_NOT_FOUND
;
1525 if (rc
== GPG_ERR_NOT_FOUND
&& local_pinentry
) {
1526 #ifdef WITH_PINENTRY
1527 /* Get the password using the LOCAL pinentry. */
1531 pwmd_nb_status_t pw
;
1534 return gpg_error_from_syserror();
1547 pw
.error
= _do_save_getpin(pwm
, &password
);
1550 snprintf(pw
.password
, sizeof(pw
.password
), "%s",
1552 pwmd_free(password
);
1555 pth_write(p
[1], &pw
, sizeof(pw
));
1557 write(p
[1], &pw
, sizeof(pw
));
1559 memset(&pw
, 0, sizeof(pw
));
1564 rc
= gpg_error_from_syserror();
1578 rc
= _do_save_getpin(pwm
, &password
);
1585 pwm
->state
= ASYNC_DONE
;
1588 reset_async(pwm
, 0);
1591 if (!local_pinentry
&& !pwm
->tcp_conn
) {
1593 if (!local_pinentry
) {
1595 rc
= send_pinentry_options(pwm
);
1601 rc
= pwmd_command(pwm
, NULL
, "SAVE %s", password
? password
: "");
1603 if (!pwm
->passfunc
&& password
&& password
!= pwm
->password
)
1604 pwmd_free(password
);
1609 gpg_error_t
pwmd_save_async2(pwm_t
*pwm
)
1611 #ifndef WITH_PINENTRY
1612 return GPG_ERR_NOT_IMPLEMENTED
;
1615 return GPG_ERR_INV_ARG
;
1618 return GPG_ERR_INV_STATE
;
1620 if (pwm
->cmd
!= ASYNC_CMD_NONE
)
1621 return GPG_ERR_ASS_NESTED_COMMANDS
;
1623 pwm
->cmd
= ASYNC_CMD_SAVE2
;
1624 pwm
->state
= ASYNC_PROCESS
;
1625 gpg_error_t rc
= do_pwmd_save(pwm
, 1, 1);
1628 reset_async(pwm
, 0);
1634 gpg_error_t
pwmd_save2(pwm_t
*pwm
)
1636 #ifndef WITH_PINENTRY
1637 return GPG_ERR_NOT_IMPLEMENTED
;
1639 return do_pwmd_save(pwm
, 0, 1);
1643 gpg_error_t
pwmd_save(pwm_t
*pwm
)
1645 return do_pwmd_save(pwm
, 0, 0);
1648 gpg_error_t
pwmd_setopt(pwm_t
*pwm
, pwmd_option_t opt
, ...)
1651 int n
= va_arg(ap
, int);
1656 return GPG_ERR_INV_ARG
;
1661 case PWMD_OPTION_INQUIRE_TOTAL
:
1662 n
= va_arg(ap
, size_t);
1663 pwm
->inquire_total
= n
;
1665 case PWMD_OPTION_STATUS_CB
:
1666 pwm
->status_func
= va_arg(ap
, pwmd_status_cb_t
);
1668 case PWMD_OPTION_STATUS_DATA
:
1669 pwm
->status_data
= va_arg(ap
, void *);
1671 case PWMD_OPTION_PASSPHRASE_CB
:
1672 pwm
->passfunc
= va_arg(ap
, pwmd_passphrase_cb_t
);
1674 case PWMD_OPTION_PASSPHRASE_DATA
:
1675 pwm
->passdata
= va_arg(ap
, void *);
1677 case PWMD_OPTION_PASSPHRASE
:
1678 arg1
= va_arg(ap
, char *);
1681 pwmd_free(pwm
->password
);
1683 pwm
->password
= arg1
? pwmd_strdup(arg1
) : NULL
;
1685 case PWMD_OPTION_PINENTRY_TRIES
:
1686 n
= va_arg(ap
, int);
1690 rc
= GPG_ERR_INV_VALUE
;
1693 pwm
->pinentry_tries
= n
;
1695 case PWMD_OPTION_PINENTRY_TIMEOUT
:
1696 n
= va_arg(ap
, int);
1700 rc
= GPG_ERR_INV_VALUE
;
1703 pwm
->pinentry_timeout
= n
;
1705 case PWMD_OPTION_PINENTRY_PATH
:
1706 if (pwm
->pinentry_path
)
1707 pwmd_free(pwm
->pinentry_path
);
1709 pwm
->pinentry_path
= _expand_homedir(va_arg(ap
, char *), NULL
);
1711 case PWMD_OPTION_PINENTRY_TTY
:
1712 arg1
= va_arg(ap
, char *);
1714 if (pwm
->pinentry_tty
)
1715 pwmd_free(pwm
->pinentry_tty
);
1717 pwm
->pinentry_tty
= arg1
? pwmd_strdup(arg1
) : NULL
;
1719 case PWMD_OPTION_PINENTRY_DISPLAY
:
1720 if (pwm
->pinentry_display
)
1721 pwmd_free(pwm
->pinentry_display
);
1723 pwm
->pinentry_display
= pwmd_strdup(va_arg(ap
, char *));
1725 case PWMD_OPTION_PINENTRY_TERM
:
1726 arg1
= va_arg(ap
, char *);
1728 if (pwm
->pinentry_term
)
1729 pwmd_free(pwm
->pinentry_term
);
1731 pwm
->pinentry_term
= arg1
? pwmd_strdup(arg1
) : NULL
;
1733 case PWMD_OPTION_PINENTRY_TITLE
:
1735 pwmd_free(pwm
->title
);
1737 pwm
->title
= _percent_escape(va_arg(ap
, char *));
1739 case PWMD_OPTION_PINENTRY_PROMPT
:
1741 pwmd_free(pwm
->prompt
);
1743 pwm
->prompt
= _percent_escape(va_arg(ap
, char *));
1745 case PWMD_OPTION_PINENTRY_DESC
:
1747 pwmd_free(pwm
->desc
);
1749 pwm
->desc
= _percent_escape(va_arg(ap
, char *));
1751 case PWMD_OPTION_PINENTRY_LC_CTYPE
:
1752 arg1
= va_arg(ap
, char *);
1755 pwmd_free(pwm
->lcctype
);
1757 pwm
->lcctype
= arg1
? pwmd_strdup(arg1
) : NULL
;
1759 case PWMD_OPTION_PINENTRY_LC_MESSAGES
:
1760 arg1
= va_arg(ap
, char *);
1762 if (pwm
->lcmessages
)
1763 pwmd_free(pwm
->lcmessages
);
1765 pwm
->lcmessages
= arg1
? pwmd_strdup(arg1
) : NULL
;
1767 case PWMD_OPTION_IP_VERSION
:
1769 n
= va_arg(ap
, int);
1778 rc
= GPG_ERR_INV_VALUE
;
1784 rc
= GPG_ERR_NOT_IMPLEMENTED
;
1787 case PWMD_OPTION_KNOWNHOST_CB
:
1789 pwm
->kh_cb
= va_arg(ap
, pwmd_knownhost_cb_t
);
1791 rc
= GPG_ERR_NOT_IMPLEMENTED
;
1794 case PWMD_OPTION_KNOWNHOST_DATA
:
1796 pwm
->kh_data
= va_arg(ap
, void *);
1798 rc
= GPG_ERR_NOT_IMPLEMENTED
;
1802 rc
= GPG_ERR_UNKNOWN_OPTION
;
1810 gpg_error_t
pwmd_get_fds(pwm_t
*pwm
, pwmd_fd_t
*fds
, int *n_fds
)
1815 int afds
[ARES_GETSOCK_MAXNUM
];
1820 if (!pwm
|| !fds
|| !n_fds
|| *n_fds
<= 0)
1821 return GPG_ERR_INV_ARG
;
1825 memset(afds
, 0, sizeof(int)*ARES_GETSOCK_MAXNUM
);
1827 memset(fds
, 0, sizeof(pwmd_fd_t
)*in_total
);
1832 case ASYNC_CMD_NONE
:
1833 case ASYNC_CMD_OPEN
:
1834 case ASYNC_CMD_SAVE
:
1835 #ifdef WITH_PINENTRY
1839 return GPG_ERR_INV_STATE
;
1842 fds
[fd
].fd
= pwm
->fd
;
1843 fds
[fd
++].flags
= PWMD_FD_READABLE
;
1845 #ifdef WITH_PINENTRY
1846 case ASYNC_CMD_OPEN2
:
1847 case ASYNC_CMD_SAVE2
:
1848 /* The command has already completed (cached or new). */
1849 if (pwm
->state
== ASYNC_DONE
)
1852 if (pwm
->nb_fd
== -1)
1853 return GPG_ERR_INV_STATE
;
1856 fds
[fd
].fd
= pwm
->nb_fd
;
1857 fds
[fd
++].flags
= PWMD_FD_READABLE
;
1862 if (!pwm
->tcp_conn
|| !pwm
->tcp_conn
->chan
)
1863 return GPG_ERR_INV_STATE
;
1865 n
= ares_getsock(pwm
->tcp_conn
->chan
, afds
, ARES_GETSOCK_MAXNUM
);
1867 for (i
= 0; i
< ARES_GETSOCK_MAXNUM
; i
++) {
1870 if (fd
> in_total
) {
1872 return GPG_ERR_ERANGE
;
1875 if (ARES_GETSOCK_READABLE(n
, i
)) {
1877 fds
[fd
].flags
|= PWMD_FD_READABLE
;
1880 if (ARES_GETSOCK_WRITABLE(n
, i
)) {
1882 fds
[fd
].flags
|= PWMD_FD_WRITABLE
;
1886 fds
[fd
++].fd
= afds
[i
];
1891 case ASYNC_CMD_CONNECT
:
1892 case ASYNC_CMD_HOSTKEY
:
1893 if (!pwm
->tcp_conn
|| pwm
->tcp_conn
->fd
== -1)
1894 return GPG_ERR_INV_STATE
;
1897 fds
[fd
].fd
= pwm
->tcp_conn
->fd
;
1898 fds
[fd
++].flags
= PWMD_FD_READABLE
;
1903 return GPG_ERR_INV_STATE
;
1906 pwm_t
*pwmd_new(const char *name
)
1908 pwm_t
*h
= pwmd_calloc(1, sizeof(pwm_t
));
1914 h
->name
= pwmd_strdup(name
);
1923 h
->pinentry_timeout
= -30;
1924 h
->pinentry_tries
= 3;
1926 h
->prot
= PWMD_IP_ANY
;
1929 if (ttyname(STDOUT_FILENO
)) {
1932 ttyname_r(STDOUT_FILENO
, buf
, sizeof(buf
));
1933 h
->pinentry_tty
= pwmd_strdup(buf
);
1935 if (!h
->pinentry_tty
)
1939 if (getenv("TERM") && h
->pinentry_tty
) {
1940 h
->pinentry_term
= pwmd_strdup(getenv("TERM"));
1942 if (!h
->pinentry_term
)
1946 if (getenv("DISPLAY")) {
1947 h
->pinentry_display
= pwmd_strdup(getenv("DISPLAY"));
1949 if (!h
->pinentry_display
)
1960 void pwmd_free(void *ptr
)
1965 void *pwmd_malloc(size_t size
)
1967 return _xmalloc(size
);
1970 void *pwmd_calloc(size_t nmemb
, size_t size
)
1972 return _xcalloc(nmemb
, size
);
1975 void *pwmd_realloc(void *ptr
, size_t size
)
1977 return _xrealloc(ptr
, size
);
1980 char *pwmd_strdup(const char *str
)
1982 return _xstrdup(str
);
1985 char *pwmd_strdup_printf(const char *fmt
, ...)
1996 len
= vsnprintf(NULL
, 0, fmt
, ap
);
1998 buf
= pwmd_malloc(++len
);
2001 vsnprintf(buf
, len
, fmt
, ap2
);
2007 gpg_error_t
pwmd_getpin(pwm_t
*pwm
, const char *filename
, char **result
,
2008 pwmd_pinentry_t which
)
2010 #ifndef WITH_PINENTRY
2011 return GPG_ERR_NOT_IMPLEMENTED
;
2013 return _pwmd_getpin(pwm
, filename
, result
, which
);