common: Provide a function for mapping packet types to strings.
[gnupg.git] / common / simple-pwquery.h
1 /* simple-pwquery.c - A simple password query cleint for gpg-agent
2  *      Copyright (C) 2002 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 SIMPLE_PWQUERY_H
21 #define SIMPLE_PWQUERY_H
22
23 #ifdef SIMPLE_PWQUERY_IMPLEMENTATION /* Begin configuration stuff. */
24
25 /* Include whatever files you need.  */
26 #include <gcrypt.h>
27 #include "../common/logging.h"
28
29 /* Try to write error message using the standard gnupg log mechanism.  */
30 #define SPWQ_USE_LOGGING  1
31
32 /* Memory allocation functions used by the implementation.  Note, that
33    the returned value is expected to be freed with
34    spwq_secure_free. */
35 #define spwq_malloc(a)         gcry_malloc (a)
36 #define spwq_free(a)           gcry_free (a)
37 #define spwq_secure_malloc(a)  gcry_malloc_secure (a)
38 #define spwq_secure_free(a)    gcry_free (a)
39
40 #endif /*SIMPLE_PWQUERY_IMPLEMENTATION*/ /* End configuration stuff. */
41
42
43 /* Ask the gpg-agent for a passphrase and present the user with a
44    DESCRIPTION, a PROMPT and optiaonlly with a TRYAGAIN extra text.
45    If a CACHEID is not NULL it is used to locate the passphrase in in
46    the cache and store it under this ID.  If OPT_CHECK is true
47    gpg-agent is asked to apply some checks on the passphrase security.
48    If ERRORCODE is not NULL it should point a variable receiving an
49    errorcode; this errocode might be 0 if the user canceled the
50    operation.  The function returns NULL to indicate an error. */
51 char *simple_pwquery (const char *cacheid,
52                       const char *tryagain,
53                       const char *prompt,
54                       const char *description,
55                       int opt_check,
56                       int *errorcode);
57
58 /* Ask the gpg-agent to clear the passphrase for the cache ID CACHEID.  */
59 int simple_pwclear (const char *cacheid);
60
61 /* Perform the simple query QUERY (which must be new-line and 0
62    terminated) and return the error code.  */
63 int simple_query (const char *query);
64
65 /* Set the name of the standard socket to be used if GPG_AGENT_INFO is
66    not defined.  The use of this function is optional but if it needs
67    to be called before any other function.  Returns 0 on success.  */
68 int simple_pw_set_socket (const char *name);
69
70 #define SPWQ_OUT_OF_CORE 1
71 #define SPWQ_IO_ERROR 2
72 #define SPWQ_PROTOCOL_ERROR 3
73 #define SPWQ_ERR_RESPONSE 4
74 #define SPWQ_NO_AGENT 5
75 #define SPWQ_SYS_ERROR 6
76 #define SPWQ_GENERAL_ERROR 7
77 #define SPWQ_NO_PIN_ENTRY 8
78
79
80 /* We often need to map error codes to gpg-error style error codes.
81    To have a consistent mapping this macro may be used to implemt the
82    mapping function.  */
83 #define MAP_SPWQ_ERROR_IMPL                                 \
84        static gpg_error_t                                   \
85        map_spwq_error (int err)                             \
86        {                                                    \
87          switch (err)                                       \
88            {                                                \
89            case 0:                                          \
90              return 0;                                      \
91            case SPWQ_OUT_OF_CORE:                           \
92              return gpg_error_from_errno (ENOMEM);          \
93            case SPWQ_IO_ERROR:                              \
94              return gpg_error_from_errno (EIO);             \
95            case SPWQ_PROTOCOL_ERROR:                        \
96              return gpg_error (GPG_ERR_PROTOCOL_VIOLATION); \
97            case SPWQ_ERR_RESPONSE:                          \
98              return gpg_error (GPG_ERR_INV_RESPONSE);       \
99            case SPWQ_NO_AGENT:                              \
100              return gpg_error (GPG_ERR_NO_AGENT);           \
101            case SPWQ_SYS_ERROR:                             \
102              return gpg_error_from_syserror ();             \
103            case SPWQ_NO_PIN_ENTRY:                          \
104              return gpg_error (GPG_ERR_NO_PIN_ENTRY);       \
105            case SPWQ_GENERAL_ERROR:                         \
106            default:                                         \
107              return gpg_error (GPG_ERR_GENERAL);            \
108            }                                                \
109        }
110 /* End of MAP_SPWQ_ERROR_IMPL.  */
111
112
113 #endif /*SIMPLE_PWQUERY_H*/