common/get-passphrase.h

   1 /* get-passphrase.h - Definitions to ask for a passphrase via the agent.
   2  * Copyright (C) 2009 Free Software Foundation, Inc.
   3  *
   4  * This file is part of GnuPG.
   5  *
   6  * GnuPG is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * GnuPG is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef GNUPG_COMMON_GET_PASSPHRASE_H
  21 #define GNUPG_COMMON_GET_PASSPHRASE_H
  22
  23 void gnupg_prepare_get_passphrase (gpg_err_source_t errsource,
  24                                    int verbosity,
  25                                    const char *homedir,
  26                                    const char *agent_program,
  27                                    const char *opt_display,
  28                                    const char *opt_ttyname,
  29                                    const char *opt_ttytype,
  30                                    const char *opt_lc_ctype,
  31                                    const char *opt_lc_messages,
  32                                    const char *opt_xauthority,
  33                                    const char *opt_pinentry_user_data);
  34
  35 gpg_error_t gnupg_get_passphrase (const char *cache_id,
  36                                   const char *err_msg,
  37                                   const char *prompt,
  38                                   const char *desc_msg,
  39                                   int repeat,
  40                                   int check_quality,
  41                                   int use_secmem,
  42                                   char **r_passphrase);
  43
  44 gpg_error_t gnupg_clear_passphrase (const char *cache_id);
  45
  46
  47 #endif /*GNUPG_COMMON_GET_PASSPHRASE_H*/