Add missing functions to .h file and make .h files C++ compatible
[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 #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
63   /* The user should set this to -1 if the user canceled the request,
64      and to the length of the PIN stored in pin otherwise.  */
65   int result;
66 };
67 typedef struct pinentry *pinentry_t;
68
69 \f
70 /* The pinentry command handler type processes the pinentry request
71    PIN.  If PIN->pin is zero, request a confirmation, otherwise a PIN
72    entry.  On confirmation, the function should return TRUE if
73    confirmed, and FALSE otherwise.  On PIN entry, the function should
74    return -1 if cancelled and the length of the secret otherwise.  */
75 typedef int (*pinentry_cmd_handler_t) (pinentry_t pin);
76
77 /* Start the pinentry event loop.  The program will start to process
78    Assuan commands until it is finished or an error occurs.  If an
79    error occurs, -1 is returned and errno indicates the type of an
80    error.  Otherwise, 0 is returned.  */
81 int pinentry_loop (void);
82
83 /* Try to make room for at least LEN bytes for the pin in the pinentry
84    PIN.  Returns new buffer on success and 0 on failure.  */
85 char *pinentry_setbufferlen (pinentry_t pin, int len);
86
87 /* Initialize the secure memory subsystem, drop privileges and
88    return.  Must be called early.  */
89 void pinentry_init (void);
90
91 /* Parse the command line options.  Returns 1 if user should print
92    version and exit.  Can exit the program if only help output is
93    requested.  */
94 int pinentry_parse_opts (int argc, char *argv[]);
95
96 \f
97 /* The caller must define this variable to process assuan commands.  */
98 extern pinentry_cmd_handler_t pinentry_cmd_handler;
99
100 #ifdef __cplusplus
101 }
102 #endif
103
104 #endif  /* PINENTRY_H */