2002-04-23 Marcus Brinkmann <marcus@g10code.de>
[pinentry.git] / pinentry / pinentry.h
1 /* pinentry.h - The interface for the PIN entry support library.
2    Copyright (C) 2002 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 struct pinentry
22 {
23   /* The description to display, or NULL.  */
24   char *description;
25   /* The error message to display, or NULL.  */
26   char *error;
27   /* The prompt to display, or NULL.  */
28   char *prompt;
29   /* The buffer to store the secret into.  */
30   char *pin;
31   /* The length of the buffer.  */
32   int pin_len;
33
34   /* The name of the X display to use if X is available and supported.  */
35   char *display;
36   /* The name of the terminal node to open if X not available or supported.  */
37   char *ttyname;
38   /* The type of the terminal.  */
39   char *ttytype;
40   /* The LC_CTYPE value for the terminal.  */
41   char *lc_ctype;
42   /* The LC_MESSAGES value for the terminal.  */
43   char *lc_messages;
44
45   /* True if debug mode is requested.  */
46   int debug;
47   /* True if enhanced mode is requested.  */
48   int enhanced;
49   /* True if caller should grab the keyboard.  */
50   int grab;
51
52   /* The user should set this to -1 if the user canceled the request,
53      and to the length of the PIN stored in pin otherwise.  */
54   int result;
55 };
56 typedef struct pinentry *pinentry_t;
57
58 \f
59 /* The pinentry command handler type processes the pinentry request
60    PIN.  If PIN->pin is zero, request a confirmation, otherwise a PIN
61    entry.  On confirmation, the function should return TRUE if
62    confirmed, and FALSE otherwise.  On PIN entry, the function should
63    return -1 if cancelled and the length of the secret otherwise.  */
64 typedef int (*pinentry_cmd_handler_t) (pinentry_t pin);
65
66 /* Start the pinentry event loop.  The program will start to process
67    Assuan commands until it is finished or an error occurs.  If an
68    error occurs, -1 is returned and errno indicates the type of an
69    error.  Otherwise, 0 is returned.  */
70 int pinentry_loop (void);
71
72 /* Try to make room for at least LEN bytes for the pin in the pinentry
73    PIN.  Returns new buffer on success and 0 on failure.  */
74 char *pinentry_setbufferlen (pinentry_t pin, int len);
75
76 \f
77 /* The caller must define this variable to process assuan commands.  */
78 extern pinentry_cmd_handler_t pinentry_cmd_handler;