00e77fa8d0aa1814a3434b2f1a0b0302006f289f
[pinentry.git] / pinentry / pinentry.h
1 /* pinentry.h - The interface for the PIN entry support library.
2    Copyright (C) 2002, 2003 g10 Code GmbH
3    
4    This file is part of PINENTRY.
5    
6    PINENTRY is free software; you can redistribute it and/or modify it
7    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    PINENTRY is distributed in the hope that it will be useful, but
12    WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    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., 59 Temple Place - Suite 330, Boston, MA
19    02111-1307, USA  */
20
21 #ifndef PINENTRY_H
22 #define PINENTRY_H
23
24 #ifdef __cplusplus
25 extern "C" {
26 #if 0 
27 }
28 #endif
29 #endif
30
31
32 struct pinentry
33 {
34   /* The description to display, or NULL.  */
35   char *description;
36   /* The error message to display, or NULL.  */
37   char *error;
38   /* The prompt to display, or NULL.  */
39   char *prompt;
40   /* The OK button text to display, or NULL.  */
41   char *ok;
42   /* The Cancel button text to display, or NULL.  */
43   char *cancel;
44   /* The buffer to store the secret into.  */
45   char *pin;
46   /* The length of the buffer.  */
47   int pin_len;
48
49   /* The name of the X display to use if X is available and supported.  */
50   char *display;
51   /* The name of the terminal node to open if X not available or supported.  */
52   char *ttyname;
53   /* The type of the terminal.  */
54   char *ttytype;
55   /* The LC_CTYPE value for the terminal.  */
56   char *lc_ctype;
57   /* The LC_MESSAGES value for the terminal.  */
58   char *lc_messages;
59
60   /* True if debug mode is requested.  */
61   int debug;
62   /* True if enhanced mode is requested.  */
63   int enhanced;
64   /* True if caller should grab the keyboard.  */
65   int grab;
66   /* The window ID of the parent window over which the pinentry window
67      should be displayed.  */
68   int parent_wid;
69
70   /* The user should set this to -1 if the user canceled the request,
71      and to the length of the PIN stored in pin otherwise.  */
72   int result;
73
74   /* The user should set this to true if an error with the local
75      conversion occured. */
76   int locale_err;
77
78 };
79 typedef struct pinentry *pinentry_t;
80
81 \f
82 /* The pinentry command handler type processes the pinentry request
83    PIN.  If PIN->pin is zero, request a confirmation, otherwise a PIN
84    entry.  On confirmation, the function should return TRUE if
85    confirmed, and FALSE otherwise.  On PIN entry, the function should
86    return -1 if cancelled and the length of the secret otherwise.  */
87 typedef int (*pinentry_cmd_handler_t) (pinentry_t pin);
88
89 /* Start the pinentry event loop.  The program will start to process
90    Assuan commands until it is finished or an error occurs.  If an
91    error occurs, -1 is returned and errno indicates the type of an
92    error.  Otherwise, 0 is returned.  */
93 int pinentry_loop (void);
94
95
96 /* Convert the UTF-8 encoded string TEXT to the encoding given in
97    LC_CTYPE.  Return NULL on error. */
98 char *pinentry_utf8_to_local (char *lc_ctype, char *text);
99
100 /* Convert TEXT which is encoded according to LC_CTYPE to UTF-8.  With
101    SECURE set to true, use secure memory for the returned buffer.
102    Return NULL on error. */
103 char *pinentry_local_to_utf8 (char *lc_ctype, char *text, int secure);
104
105 /* Try to make room for at least LEN bytes for the pin in the pinentry
106    PIN.  Returns new buffer on success and 0 on failure.  */
107 char *pinentry_setbufferlen (pinentry_t pin, int len);
108
109 /* Initialize the secure memory subsystem, drop privileges and
110    return.  Must be called early.  */
111 void pinentry_init (const char *pgmname);
112
113 /* Return true if either DISPLAY is set or ARGV contains the string
114    "--display". */
115 int pinentry_have_display (int argc, char **argv);
116
117 /* Parse the command line options.  Returns 1 if user should print
118    version and exit.  Can exit the program if only help output is
119    requested.  */
120 int pinentry_parse_opts (int argc, char *argv[]);
121
122 \f
123 /* The caller must define this variable to process assuan commands.  */
124 extern pinentry_cmd_handler_t pinentry_cmd_handler;
125
126
127
128
129 \f
130 #ifdef HAVE_W32_SYSTEM
131 /* Windows declares sleep as obsolete, but provides a definition for
132    _sleep but non for the still existing sleep.  */
133 #define sleep(a) _sleep ((a))
134 #endif /*HAVE_W32_SYSTEM*/
135
136
137
138 #if 0 
139 {
140 #endif
141 #ifdef __cplusplus
142 }
143 #endif
144
145 #endif  /* PINENTRY_H */