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
19 /*! \headerfile libpwmd.h
21 * libpwmd is a library making it easy for applications to use the pwmd
25 /*! \section ssh SSH Details
27 * A remote connection to a pwmd server is possible by using an SSH channel
28 * which spawns a shell and executes a proxy server that connects to the pwmd
29 * local unix domain socket. Authenication is done by using SSH public key
30 * (see \ref ssh-keygen(1)) authentication and verifying the host key against
31 * a local file containing SHA1 hashes of known hosts. It's alot like how the
32 * standard OpenSSH does things only the known_hosts file is in a different
35 * The server hash can be had by using \ref pwmd_get_hostkey() and storing the
36 * result in a file. This file is then used as the \a known_hosts argument to
37 * the SSH connection functions.
39 * Here's an example \ref authorized_keys(5) entry. The hash portion should be
40 * the same as the contents of the \a identity.pub file which is passed as a
41 * parameter to the SSH connection functions:
44 * command="socat gopen:$HOME/.pwmd/socket -" <hash> ...
47 * \todo X11 port forwarding so a remote pinentry can use the local display.
50 /*! \section pinentry Pinentry Details
52 * \ref pinentry(1) is a program that prompts the user for input which is
53 * normally a passphrase or a confirmation. libpwmd can use this program
54 * either locally (the connection is to a remote server not on this host) or
55 * have the pwmd server use it's pinentry to retrieve a passphrase when
58 * There are a few options that tell pinentry how and where to prompt for a
59 * passphrase. See the \ref pwmd_option_t section for details. These options
60 * are not sent (when using pwmd's pinentry) until the pinentry is needed.
62 * If using a local pinentry by calling \ref pwmd_open2(), \ref pwmd_save2(),
63 * \ref pwmd_open_async2() or pwmd_save_async2(), libpwmd will send the
64 * command "OPTION PINENTRY=0" to the server. This is needed for pinentry
65 * retries (passphrase or confirmation failure). So if you need to change
66 * pinentry methods, then set this option as needed.
68 * Some pinentry options can also be specified in a local configuration file
69 * \a "~/.pwmd/pinentry.conf". These options are initial values for each
70 * invokation and may be changed by setting the appropriate \ref
71 * pwmd_option_t. Each option and value is separated with a '=' on a single
72 * line. Unrecognized options are ignored. Here are the recognized options:
74 * \param PATH The full path to the location of the pinentry binary.
75 * \param DISPLAY The X11 display to use.
76 * \param TTYNAME The full path to the tty that pinentry should prompt on.
77 * \param TTYTYPE The terminal type of the tty which is required if DISPLAY is
83 /*! \section example Example Client
85 * The following example will list the element tree of the data file specified
86 * in the first command line argument.
90 * #include <libpwmd.h>
94 * pwm_t *pwm = pwmd_new(NULL);
95 * gpg_error_t rc = pwmd_connect(pwm, NULL);
99 * rc = pwmd_open(pwm, argv[1]);
102 * rc = pwmd_command(pwm, &result, "%s", "LIST");
105 * printf("%s", result);
114 * fprintf(stderr, "ERR: %s\n", pwmd_strerror(rc));
125 #include <gpg-error.h>
132 /*! \def LIBPWMD_VERSION
135 * The version of this library.
137 #define LIBPWMD_VERSION 0x@VER_MAJOR@@VER_COMPAT@@VER_PATCH@
143 * When a handle is mentioned in this documentation it is a pointer of this
144 * type. A new handle is created with \ref pwmd_new().
146 typedef struct pwm_s pwm_t
;
149 /*! \typedef pwmd_async_t
151 * The return code of \ref pwmd_process() which is used for all asynchronous
158 /*! \ref pwmd_process() should be called again. */
161 /*! The command has completed. The result code should be checked for an
167 /*! \typedef pwmd_ip_version_t
169 * The value of the option \ref PWMD_OPTION_IP_VERSION which is set with \ref
173 /*! Try both IPv6 and IPv4 addresses. Note that IPv6 is tried first. */
176 /*! Only try IPv4. */
179 /*! Only try IPv6. */
184 /*! \def PWMD_FD_READABLE
187 * Set when the file descriptor is readable.
189 #define PWMD_FD_READABLE 0x01
192 /*! \def PWMD_FD_WRITABLE
195 * Set when the file descriptor is writable.
197 #define PWMD_FD_WRITABLE 0x02
200 /*! \typedef pwmd_fd_t
202 * For use with \ref pwmd_get_fds().
205 /*! The file descriptor. */
208 /*! A bitmask of \ref PWMD_FD_READABLE and \ref PWMD_FD_WRITABLE. */
213 /*! \typedef pwmd_passphrase_cb_t
215 * The value of the option \ref PWMD_OPTION_PASSPHRASE_CB which is set with
216 * \ref pwmd_setopt().
218 * \param user A user data pointer which is set with \ref
219 * PWMD_OPTION_PASSPHRASE_DATA.
220 * \param[out] passphrase The passphrase which may be an empty string or NULL.
221 * \return 0 on success or an error code which will cause a command to fail.
223 typedef gpg_error_t (*pwmd_passphrase_cb_t
)(void *user
, char **passphrase
);
226 /*! \typedef pwmd_status_cb_t
228 * The value of the option \ref PWMD_OPTION_STATUS_CB which is set with \ref
231 * \param user A user data pointer which is set with \ref
232 * PWMD_OPTION_STATUS_DATA.
233 * \param line The status message line.
234 * \return 0 on success or an error code which will cause a command to fail.
236 typedef int (*pwmd_status_cb_t
)(void *user
, const char *line
);
239 /*! \typedef pwmd_inquire_cb_t
241 * This is a callback function that gets passed to \ref pwmd_inquire(). It is
242 * used for sending data to the server for commands that return an INQUIRE
243 * response (STORE and IMPORT). The reason for this callback is to let the
244 * client send as many bytes as it wants rather than the entire chunk at once.
245 * It gets called during \ref assuan_transact() from an internal inquire
246 * callback function which in turn calls this function by looping over its
249 * \param user The user data pointer passed to \ref pwmd_inquire().
250 * \param cmd The same as the \a cmd argument to \ref pwmd_inquire().
251 * \param rc The result of the last internal call to \ref assuan_send_data()
252 * which did the sending of the data to the pwmd server. On the first call to
253 * this callback it will always be 0 because no data has been sent yet.
254 * \param[out] data The next chunk of data to send or NULL.
255 * \param[out] len The length of \a data or 0.
257 * \retval 0 There is more data to be sent.
258 * \retval GPG_ERR_EOF No need to call this function again, the current
259 * \a line is the last to send.
260 * \retval code Any other error code which will terminate the INQUIRE.
262 * \note The sent data is processed line-per-line. The line is either newline
263 * terminated or is buffered until ASSUAN_LINELENGTH bytes have been
264 * allocated. Any remaining bytes are sent after the INQUIRE has finished.
266 typedef gpg_error_t (*pwmd_inquire_cb_t
)(void *user
, const char *cmd
,
267 gpg_error_t rc
, char **data
, size_t *len
);
270 /*! \enum pwmd_option_t
272 * libpwmd options which are set with \ref pwmd_setopt().
275 /*! A custom passphrase retrieval function which, when set, will be used
276 * instead of \ref pinentry(1). This function will not be used when the
277 * passphrase is cached on the server or the file is a new one. The value
278 * of this option should be a \ref pwmd_passphrase_cb_t function pointer.
280 PWMD_OPTION_PASSPHRASE_CB
,
282 /*! User supplied data which is passed to the custom password function. */
283 PWMD_OPTION_PASSPHRASE_DATA
,
285 /*! A string to use as the passphrase when doing an open or save. When not
286 * NULL, this option has precedence over \ref PWMD_OPTION_PASSPHRASE_CB.
288 PWMD_OPTION_PASSPHRASE
,
290 /*! An integer value that specifies the specified the number of tries
291 * before \ref pinentry(1) will give up when opening a file with the wrong
292 * supplied passphrase. The default is 3.
294 * \note This option has no effect when trying to save a file. The user
295 * must either cancel the pinentry causing the save to fail or enter the
296 * correct passphrase during passphrase confirmation.
298 PWMD_OPTION_PINENTRY_TRIES
,
300 /*! A character string value which specifies the full path of the \ref
301 * pinentry(1) binary. For the local \ref pinentry(1) method, the default
302 * is specified at compile time.
306 PWMD_OPTION_PINENTRY_PATH
,
308 /*! A value which specifies the full path to the tty that \ref pinentry(1)
309 * will use. When set and no DISPLAY is available, \ref
310 * PWMD_OPTION_PINENTRY_TERM must also be set.
314 PWMD_OPTION_PINENTRY_TTY
,
316 /*! A value which specifies the terminal type (e.g., vt100) that \ref
317 * pinentry(1) will use when no X11 display is available.
321 PWMD_OPTION_PINENTRY_TERM
,
323 /*! A value which specifies the X11 display that \ref pinentry(1) will
328 PWMD_OPTION_PINENTRY_DISPLAY
,
330 /*! A character string that \ref pinentry(1) will use in it's dialog
333 PWMD_OPTION_PINENTRY_TITLE
,
335 /*! \copydoc PWMD_OPTION_PINENTRY_TITLE */
336 PWMD_OPTION_PINENTRY_PROMPT
,
338 /*! \copydoc PWMD_OPTION_PINENTRY_TITLE */
339 PWMD_OPTION_PINENTRY_DESC
,
341 /*! For \ref pinentry(1) localization. */
342 PWMD_OPTION_PINENTRY_LC_CTYPE
,
344 /*! \copydoc PWMD_OPTION_PINENTRY_LC_CTYPE */
345 PWMD_OPTION_PINENTRY_LC_MESSAGES
,
347 /*! An integer value that specifies the number of seconds \ref pinentry(1)
348 * will wait for input before timing out and aborting the current command.
349 * If 0, then no timeout will be used. The default is 30.
351 PWMD_OPTION_PINENTRY_TIMEOUT
,
353 /*! A function pointer of type \ref pwmd_status_cb_t that will process
354 * status messages received from the pwmd server.
356 PWMD_OPTION_STATUS_CB
,
358 /*! A user data pointer which is passed to the status message function. */
359 PWMD_OPTION_STATUS_DATA
,
361 /*! The IP version of type \ref pwmd_ip_version_t that \ref
362 * pwmd_ssh_connect() and \ref pwmd_ssh_connect_async() will use when
363 * connecting to the remote pwmd server.
367 PWMD_OPTION_IP_VERSION
,
371 /*! \brief Initialize the library.
373 * This function must be the first function called in the library before any
374 * others. It sets up internationalization among other things.
378 gpg_error_t
pwmd_init(void);
381 /*! \brief Creates a new handle.
383 * Creates a new handle for use with the other functions.
385 * \param name If not NULL, the name of the application. The application name
386 * is sent to the pwmd server after successfully connecting.
388 * \param name The application name or NULL.
389 * \return a new handle or NULL if there was not enough memory.
391 pwm_t
*pwmd_new(const char *name
)
392 __attribute__ ((warn_unused_result
));
395 /*! \brief Connect to a local pwmd server.
397 * Connects to a local unix domain socket.
399 * \param pwm A handle.
400 * \param path The socket path to connect to. If NULL, then a default of
401 * \a "~/.pwmd/socket" will be used.
402 * \return 0 on success or an error code.
403 * \see pwmd_ssh_connect(), pwmd_ssh_connect_async()
405 gpg_error_t
pwmd_connect(pwm_t
*pwm
, const char *path
)
406 __attribute__ ((warn_unused_result
));
409 /*! \brief Establish a remote connection to a pwmd server.
411 * Connects to a pwmd server over an SSH channel.
413 * \param pwm A handle.
414 * \param host The hostname to connect to.
415 * \param port The port or -1 for the default.
416 * \param identity The SSH identity file to use for authentication. This
417 * should specify the private key. The public key is assumed to be \a
419 * \param user The username on the SSH server to login as. If NULL then
420 * invoking user will be used.
421 * \param known_hosts A file containing the public SSH server key hash in SHA1
423 * \return 0 on success or an error code.
424 * \see pwmd_ssh_connect_async(), pwmd_process(), \ref ssh
426 gpg_error_t
pwmd_ssh_connect(pwm_t
*pwm
, const char *host
, int port
,
427 const char *identity
, const char *user
, const char *known_hosts
)
428 __attribute__ ((warn_unused_result
));
431 /*! \brief Establish a remote connection to a pwmd server asynchronously.
433 * This is a variant of \ref pwmd_ssh_connect() that will not block while doing
434 * DNS lookups or while connecting.
438 * \param pwm A handle.
439 * \param host The hostname to connect to.
440 * \param port The port or -1 for the default.
441 * \param identity The SSH identity file to use for authentication. This
442 * should specify the private key. The public key is assumed to be \a
444 * \param user The username on the SSH server to login as. If NULL, the
445 * invoking username will be used.
446 * \param known_hosts A file containing the public SSH server key hash in SHA1
448 * \return 0 on success or an error code.
449 * \see pwmd_process(), \ref ssh
451 gpg_error_t
pwmd_ssh_connect_async(pwm_t
*pwm
, const char *host
, int port
,
452 const char *identity
, const char *user
, const char *known_hosts
)
453 __attribute__ ((warn_unused_result
));
456 /*! \brief Retrieve a remote SSH host key.
458 * This key is needed for host verification of the remote pwmd server.
460 * \param pwm A handle.
461 * \param host The hostname to connect to.
462 * \param port The port.
463 * \param[out] result The server host key which must be freed with \ref
465 * \return 0 on success or an error code.
466 * \see pwmd_get_hostkey_async(), \ref ssh
468 gpg_error_t
pwmd_get_hostkey(pwm_t
*pwm
, const char *host
, int port
,
470 __attribute__ ((warn_unused_result
));
473 /*! \brief Retrieve a remote SSH host key asynchronously.
475 * This key is needed for host verification of the remote pwmd server.
479 * \param pwm A handle.
480 * \param host The hostname to connect to.
481 * \param port The port or a default if set to -1.
482 * \return 0 on success or an error code.
483 * \see pwmd_get_hostkey(), \ref pwmd_process(), \ref ssh
485 gpg_error_t
pwmd_get_hostkey_async(pwm_t
*pwm
, const char *host
, int port
)
486 __attribute__ ((warn_unused_result
));
489 /*! \brief Get the associated file descriptor(s) for a handle.
491 * This function lets the application poll the available file descriptors for
492 * the specified handle. It should be called after each asynchronous function
493 * and after each call to \ref pwmd_process() since the polled file
494 * descriptors may have been closed since the last call. It should also be
495 * called periodically to determine when to call \ref pwmd_process() to parse
496 * any pending status messages.
498 * After returning, \a n_fds is set to the number of available file
499 * descriptors which are stored in \a fds. The .flags member of \ref pwmd_fd_t
500 * specifies what can be monitored and is a bitmask of \ref PWMD_FD_READABLE
501 * and \ref PWMD_FD_WRITABLE. When ready, \ref pwmd_process() should be
504 * \param pwm A handle.
505 * \param[out] fds Set to the file descriptor(s) of the associated handle.
506 * \param[out] n_fds Initially the size of \a fds then updated to the number
507 * of available file descriptors which are stored in \a fds.
508 * \retval 0 on success or an error code.
509 * \retval GPG_ERR_ERANGE There are more file descriptors than the amount
510 * specified in \a n_fds. \a fds and \a n_fds are still usable though.
511 * \see pwmd_process()
513 gpg_error_t
pwmd_get_fds(pwm_t
*pwm
, pwmd_fd_t
*fds
, int *n_fds
)
514 __attribute__ ((warn_unused_result
));
517 /*! \brief Check for a unparsed buffered line.
519 * A buffered line is a line that was read from the server but was not
520 * processed. This function determines if there is such a line.
522 * \param pwm A handle.
523 * \retval 0 if there is pending data.
524 * \retval GPG_ERR_NO_DATA if there is no pending data.
525 * \see pwmd_process()
527 gpg_error_t
pwmd_pending_line(pwm_t
*pwm
)
528 __attribute__ ((warn_unused_result
));
531 /*! \brief Set library options.
533 * See \ref pwmd_option_t for option specific details.
535 * \param pwm A handle.
536 * \param opt The option.
537 * \param ... The option value.
538 * \return 0 on success or an error code.
540 gpg_error_t
pwmd_setopt(pwm_t
*pwm
, pwmd_option_t opt
, ...)
541 __attribute__ ((warn_unused_result
));
544 /*! \brief Open a file on the pwmd server.
546 * This will send the OPEN command to the server.
548 * \param pwm A handle.
549 * \param filename The filename to open.
550 * \return 0 on success or an error code.
553 gpg_error_t
pwmd_open(pwm_t
*pwm
, const char *filename
)
554 __attribute__ ((warn_unused_result
));
556 /*! \brief Open a file on the pwmd server using a local pinentry.
558 * This will send the OPEN command to the server like \ref pwmd_open() but
559 * will use the local pinentry and not pwmd's pinentry.
563 * \param pwm A handle.
564 * \param filename The filename to open.
565 * \return 0 on success or an error code.
568 gpg_error_t
pwmd_open2(pwm_t
*pwm
, const char *filename
)
569 __attribute__ ((warn_unused_result
));
572 /*! \brief Open a file on the pwmd server asynchronously (fork method).
574 * This will send the OPEN command to the pwmd server. The difference from
575 * \ref pwmd_open() is that it will not block if a pinentry is needed for
578 * The difference from \ref pwmd_open_async() is that libpwmd will \ref fork()
579 * a pinentry process rather than have pwmd use it's pinentry method. This may
580 * be useful if the passphrase isn't cached on a remote pwmd server and a
581 * remote \ref pinentry(1) is not possible.
587 * \param pwm A handle.
588 * \param filename The filename to open.
589 * \return 0 on success or an error code.
590 * \see pwmd_process(), \ref pinentry
592 gpg_error_t
pwmd_open_async2(pwm_t
*pwm
, const char *filename
)
593 __attribute__ ((warn_unused_result
));
596 /*! \brief Open a file on the pwmd server asynchronously.
598 * This will send the OPEN command to the pwmd server. The difference from
599 * \ref pwmd_open() is that it will not block if a pinentry is needed for
604 * \param pwm A handle.
605 * \param filename The filename to open.
606 * \return 0 on success or an error code.
607 * \see pwmd_process(), \ref pinentry
609 gpg_error_t
pwmd_open_async(pwm_t
*pwm
, const char *filename
)
610 __attribute__ ((warn_unused_result
));
613 /*! \brief Process an asynchronous function.
615 * After an asynchronous function has been called and has returned
616 * successfully, this function must be called to process the command to
617 * retrieve the result or return value.
619 * This function may also be called when not in a command to check for pending
620 * status messages sent from the server or to process a pending line.
622 * \param pwm A handle.
623 * \param rc Set to the return code of the command after ASYNC_DONE is
624 * returned. This value must be checked to determine if the command succeeded.
625 * \param[out] result Set to the result of the command when \a rc is 0. Note
626 * that not all commands return a result.
627 * \retval ASYNC_DONE The command has completed. \a rc should be checked to
628 * determine if the command was successful or not.
629 * \retval ASYNC_PROCESS The command is still running and this function should
631 * \see pwmd_get_fds(), pwmd_pending_line()
633 pwmd_async_t
pwmd_process(pwm_t
*pwm
, gpg_error_t
*rc
, char **result
)
634 __attribute__ ((warn_unused_result
));
637 /*! \brief Save a file on the pwmd server.
639 * This will send the SAVE command.
641 * \param pwm A handle.
642 * \return 0 on success or an error code.
645 gpg_error_t
pwmd_save(pwm_t
*pwm
)
646 __attribute__ ((warn_unused_result
));
649 /*! \brief Save a file on the pwmd server using the local pinentry.
651 * This will send the SAVE command like \ref pwmd_save() but will use a local
652 * pinentry and not pwmd's pinentry.
654 * \param pwm A handle.
655 * \return 0 on success or an error code.
658 gpg_error_t
pwmd_save2(pwm_t
*pwm
)
659 __attribute__ ((warn_unused_result
));
662 /*! \brief Save a file on the pwmd server asynchronously (fork method).
664 * This will send the SAVE command to the pwmd server. The difference from
665 * \ref pwmd_save() is that it will not block if a pinentry is needed for
668 * The difference from \ref pwmd_save_async() is that libpwmd will \ref fork()
669 * a pinentry process rather than have pwmd use it's pinentry method. This may
670 * be useful if the passphrase isn't cached on a remote pwmd server and a
671 * remote \ref pinentry(1) is not possible.
675 * \param pwm A handle.
676 * \return 0 on success or an error code.
677 * \see pwmd_process(), \ref pinentry
679 gpg_error_t
pwmd_save_async2(pwm_t
*pwm
)
680 __attribute__ ((warn_unused_result
));
683 /*! \brief Save changes to a file on the pwmd server asynchronously.
685 * This will send the SAVE command to the pwmd server. The difference from
686 * \ref pwmd_save() is that it will not block if a pinentry is needed for
691 * \param pwm A handle.
692 * \return 0 on success or an error code.
693 * \see pwmd_process(), \ref pinentry
695 gpg_error_t
pwmd_save_async(pwm_t
*pwm
)
696 __attribute__ ((warn_unused_result
));
699 /*! \brief Send a command to the pwmd server.
701 * Sends a command to the pwmd server. You should avoid sending the BYE
702 * command here because the assuan context will be freed and bad things will
703 * happen. Use \ref pwmd_close() instead. For commands that use an INQUIRE to
704 * send data to the server (STORE and IMPORT), \ref pwmd_inquire() should be
705 * used and not this function.
707 * \param pwm A handle.
708 * \param[out] result The result of the command when successful and which must
709 * be freed with \ref pwmd_free(). Note that not all commands return a result.
710 * \param cmd The command to send.
711 * \param ... The arguments to \a cmd.
712 * \return 0 on success or an error code.
714 gpg_error_t
pwmd_command(pwm_t
*pwm
, char **result
, const char *cmd
, ...)
715 __attribute__ ((warn_unused_result
));
718 /*! \brief Send a command to the pwmd server.
720 * Like \ref pwmd_command() but uses an argument pointer instead.
722 * \param pwm A handle.
723 * \param[out] result The result of the command when successful which must be
724 * freed with \ref pwmd_free(). Note that not all commands return a result.
725 * \param cmd The command to send.
726 * \param ap The arguments to \a cmd.
727 * \return 0 on success or an error code.
729 gpg_error_t
pwmd_command_ap(pwm_t
*pwm
, char **result
, const char *cmd
,
731 __attribute__ ((warn_unused_result
));
734 /*! \brief Send data to a pwmd server.
736 * This lets commands that use an INQUIRE (STORE and IMPORT) send the data
737 * to the server. Use this function rather than \ref pwmd_command() for these
740 * \param pwm A handle.
741 * \param cmd The command to send that uses an INQUIRE.
742 * \param func A callback function which sets the data to be sent.
743 * \param user A user data pointer passed to the callback function \a func.
744 * \return 0 on success or an error code.
746 * \see pwmd_inquire_cb_t
748 gpg_error_t
pwmd_inquire(pwm_t
*pwm
, const char *cmd
, pwmd_inquire_cb_t func
,
750 __attribute__ ((warn_unused_result
));
753 /*! \brief Close a handle.
755 * This will close the connection to a pwmd server and free any resources
756 * associated with it.
758 * \param pwm A handle.
761 void pwmd_close(pwm_t
*pwm
);
764 /*! \brief Free a previously allocated pointer.
766 * Use this function to free resources allocated by the other libpwmd memory
767 * functions. Do not use it to free your own allocations.
769 * The difference between the standard free() and this function is that
770 * this one will zero out the contents of the pointer before freeing it.
772 * \param ptr The pointer to deallocate.
774 * \see pwmd_malloc(), pwmd_calloc(), pwmd_realloc(), pwmd_strdup(),
775 * pwmd_process(), pwmd_command()
777 void pwmd_free(void *ptr
);
780 /*! \brief A wrapper around malloc.
782 * Like malloc(), but lets libpwmd keep track of the pointer.
784 * \param size The number of bytes to allocate.
785 * \return A newly allocated pointer or NULL if there wasn't enough memory.
786 * \see malloc(3), pwmd_free()
788 void *pwmd_malloc(size_t size
)
789 __attribute__ ((warn_unused_result
));
792 /*! \brief A wrapper around calloc().
794 * Like calloc(), but lets libpwmd keep track of the pointer.
796 * \param nmemb The number of bytes to allocate.
797 * \param size The number of bytes to allocate.
798 * \return A newly allocated pointer or NULL if there wasn't enough memory.
799 * \see calloc(3), pwmd_free()
801 void *pwmd_calloc(size_t nmemb
, size_t size
)
802 __attribute__ ((warn_unused_result
));
805 /*! \brief A wrapper around realloc().
807 * Like realloc(), but lets libpwmd keep track of the pointer. Note that this
808 * function will try and allocate the entire \a size before freeing the
809 * original pointer and returning the new one.
811 * \param ptr The pointer to reallocate.
812 * \param size The new number of bytes to allocate.
813 * \return A newly allocated pointer or NULL if there wasn't enough memory.
814 * \see realloc(3), pwmd_free()
816 void *pwmd_realloc(void *ptr
, size_t size
)
817 __attribute__ ((warn_unused_result
));
820 /*! \brief A wrapper around strdup().
822 * Like strdup(), but lets libpwmd keep track of the pointer.
824 * \param str The string to duplicate.
825 * \return A newly allocated character pointer or NULL if there wasn't
827 * \see strdup(3), pwmd_free()
829 char *pwmd_strdup(const char *str
)
830 __attribute__ ((warn_unused_result
));
832 /*! \brief Duplicate a formatted string.
834 * Like sprintf() but returns an allocated string.
836 * \param fmt The formatted string.
837 * \param ... Any format arguments to the string.
838 * \return A newly allocated character pointer or NULL if there wasn't
842 char *pwmd_strdup_printf(const char *fmt
, ...)
843 __attribute__ ((warn_unused_result
));
848 * A general pwmd error with no suitable description.
850 #define EPWMD_ERROR GPG_ERR_USER_1
853 /*! \def EPWMD_MAX_SLOTS
856 * The maximum number of cache slots has been reached. There is no available
857 * slot for a new file.
859 #define EPWMD_MAX_SLOTS GPG_ERR_USER_2
865 * A recursion loop was detected while processing a "target" attribute.
867 #define EPWMD_LOOP GPG_ERR_USER_3
870 /*! \def EPWMD_NO_FILE
873 * A command required an open file, but no file has yet been opened.
875 #define EPWMD_NO_FILE GPG_ERR_USER_4
878 /*! \def EPWMD_LIBXML_ERROR
881 * An XML parse or other libxml2 error occurred.
883 #define EPWMD_LIBXML_ERROR GPG_ERR_USER_5
886 /*! \def EPWMD_FILE_MODIFIED
889 * The data file was modified either externally or by another another client
890 * while trying to process a command.
892 #define EPWMD_FILE_MODIFIED GPG_ERR_USER_6
900 #define EPWMD_MAX GPG_ERR_USER_7
903 /*! \brief Return a description of an error code.
905 * \param code The error code to describe.
906 * \return A character description of the error code.
907 * \see pwmd_strerror_r()
909 const char *pwmd_strerror(gpg_error_t code
)
910 __attribute__ ((warn_unused_result
));
913 /*! \brief Return a description of an error code (thread-safe).
915 * This is a thread-safe version of \ref pwmd_strerror().
917 * \param code The error code to describe.
918 * \param[out] buf An allocated buffer to hold the error description.
919 * \param size The size of the allocated buffer \a buf.
922 * \retval ERANGE \a size was not large enough to hold the entire description
923 * and \a buf is set to the truncated error string.
925 int pwmd_strerror_r(gpg_error_t code
, char *buf
, size_t size
);