b5d4228a1bd6f9d7a58d69533e53c357bf4ccf5d
[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 #endif
27
28 struct pinentry
29 {
30   /* The description to display, or NULL.  */
31   char *description;
32   /* The error message to display, or NULL.  */
33   char *error;
34   /* The prompt to display, or NULL.  */
35   char *prompt;
36   /* The OK button text to display, or NULL.  */
37   char *ok;
38   /* The Cancel button text to display, or NULL.  */
39   char *cancel;
40   /* The buffer to store the secret into.  */
41   char *pin;
42   /* The length of the buffer.  */
43   int pin_len;
44
45   /* The name of the X display to use if X is available and supported.  */
46   char *display;
47   /* The name of the terminal node to open if X not available or supported.  */
48   char *ttyname;
49   /* The type of the terminal.  */
50   char *ttytype;
51   /* The LC_CTYPE value for the terminal.  */
52   char *lc_ctype;
53   /* The LC_MESSAGES value for the terminal.  */
54   char *lc_messages;
55
56   /* True if debug mode is requested.  */
57   int debug;
58   /* True if enhanced mode is requested.  */
59   int enhanced;
60   /* True if caller should grab the keyboard.  */
61   int grab;
62   /* The window ID of the parent window over which the pinentry window
63      should be displayed.  */
64   int parent_wid;
65
66   /* The user should set this to -1 if the user canceled the request,
67      and to the length of the PIN stored in pin otherwise.  */
68   int result;
69
70   /* The user should set this to true if an error with the local
71      conversion occured. */
72   int locale_err;
73
74 };
75 typedef struct pinentry *pinentry_t;
76
77 \f
78 /* The pinentry command handler type processes the pinentry request
79    PIN.  If PIN->pin is zero, request a confirmation, otherwise a PIN
80    entry.  On confirmation, the function should return TRUE if
81    confirmed, and FALSE otherwise.  On PIN entry, the function should
82    return -1 if cancelled and the length of the secret otherwise.  */
83 typedef int (*pinentry_cmd_handler_t) (pinentry_t pin);
84
85 /* Start the pinentry event loop.  The program will start to process
86    Assuan commands until it is finished or an error occurs.  If an
87    error occurs, -1 is returned and errno indicates the type of an
88    error.  Otherwise, 0 is returned.  */
89 int pinentry_loop (void);
90
91
92 /* Convert the UTF-8 encoded string TEXT to the encoding given in
93    LC_CTYPE.  Return NULL on error. */
94 char *pinentry_utf8_to_local (char *lc_ctype, char *text);
95
96 /* Convert TEXT whcih is encoded according to LC_CTYPE to UTF-8.  With
97    SECURE set to true, use secure memory for the returned buffer.
98    Return NULL on error. */
99 char *pinentry_local_to_utf8 (char *lc_ctype, char *text, int secure);
100
101 /* Try to make room for at least LEN bytes for the pin in the pinentry
102    PIN.  Returns new buffer on success and 0 on failure.  */
103 char *pinentry_setbufferlen (pinentry_t pin, int len);
104
105 /* Initialize the secure memory subsystem, drop privileges and
106    return.  Must be called early.  */
107 void pinentry_init (const char *pgmname);
108
109 /* Return true if either DISPLAY is set or ARGV contains the string
110    "--display". */
111 int pinentry_have_display (int argc, char **argv);
112
113 /* Parse the command line options.  Returns 1 if user should print
114    version and exit.  Can exit the program if only help output is
115    requested.  */
116 int pinentry_parse_opts (int argc, char *argv[]);
117
118 \f
119 /* The caller must define this variable to process assuan commands.  */
120 extern pinentry_cmd_handler_t pinentry_cmd_handler;
121
122 #ifdef __cplusplus
123 }
124 #endif
125
126 #endif  /* PINENTRY_H */
127
128