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