Set DISPLAY environment variable if --display option
[pinentry-qt.git] / assuan.h
1 /* assuan.c - Definitions for the Assuna protocol
2  *      Copyright (C) 2001, 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #ifndef ASSUAN_H
22 #define ASSUAN_H
23
24 #include <stdio.h>
25 #ifdef HAVE_W32_SYSTEM
26 typedef int pid_t;
27 #else
28 # include <sys/types.h>
29 #endif
30
31 #ifdef __cplusplus
32 extern "C" { 
33 #if 0
34  }
35 #endif
36 #endif
37
38 /* 5 is pinentry.  */
39 #define ASSUAN_ERROR(code) ((5 << 24)  | code)
40
41 typedef enum {
42   ASSUAN_No_Error = 0,
43   ASSUAN_General_Error = ASSUAN_ERROR (257),
44   ASSUAN_Out_Of_Core = ASSUAN_ERROR (86 | (1 << 15)),
45   ASSUAN_Invalid_Value = ASSUAN_ERROR (261),
46   ASSUAN_Timeout = ASSUAN_ERROR (62),
47   ASSUAN_Read_Error = ASSUAN_ERROR (270),  /* Not 100%, but sufficient here. */
48   ASSUAN_Write_Error = ASSUAN_ERROR (271), /* Not 100%, but sufficient here. */
49   ASSUAN_Problem_Starting_Server = ASSUAN_ERROR (269),
50   ASSUAN_Not_A_Server = ASSUAN_ERROR (267),
51   ASSUAN_Not_A_Client = ASSUAN_ERROR (268),
52   ASSUAN_Nested_Commands = ASSUAN_ERROR (264),
53   ASSUAN_Invalid_Response = ASSUAN_ERROR (260),
54   ASSUAN_No_Data_Callback = ASSUAN_ERROR (265),
55   ASSUAN_No_Inquire_Callback = ASSUAN_ERROR (266),
56   ASSUAN_Connect_Failed = ASSUAN_ERROR (259),
57   ASSUAN_Accept_Failed = ASSUAN_ERROR (258),
58
59   /* error codes above 99 are meant as status codes */
60   ASSUAN_Not_Implemented = ASSUAN_ERROR (69),
61   ASSUAN_Server_Fault    = ASSUAN_ERROR (80),
62   ASSUAN_Unknown_Command = ASSUAN_ERROR (275),
63   ASSUAN_Syntax_Error    = ASSUAN_ERROR (276),
64   ASSUAN_Parameter_Conflict = ASSUAN_ERROR (280),
65   ASSUAN_Line_Too_Long = ASSUAN_ERROR (263),
66   ASSUAN_Line_Not_Terminated = ASSUAN_ERROR (262),
67   ASSUAN_Canceled = ASSUAN_ERROR (99),
68   ASSUAN_Invalid_Option = ASSUAN_ERROR (174), /* GPG_ERR_UNKNOWN_OPTION */
69   ASSUAN_Locale_Problem = ASSUAN_ERROR (166),
70   ASSUAN_Not_Confirmed = ASSUAN_ERROR (114),
71
72 } assuan_error_t;
73
74 #define ASSUAN_Parameter_Error ASSUAN_Parameter_Conflict
75
76
77 typedef assuan_error_t AssuanError; /* Deprecated. */
78
79 /* This is a list of pre-registered ASSUAN commands */
80 typedef enum {
81   ASSUAN_CMD_NOP = 0,
82   ASSUAN_CMD_CANCEL,    /* cancel the current request */
83   ASSUAN_CMD_BYE,
84   ASSUAN_CMD_AUTH,
85   ASSUAN_CMD_RESET,
86   ASSUAN_CMD_OPTION,
87   ASSUAN_CMD_DATA,
88   ASSUAN_CMD_END,
89   ASSUAN_CMD_INPUT,
90   ASSUAN_CMD_OUTPUT,
91
92   ASSUAN_CMD_USER = 256  /* Other commands should be used with this offset*/
93 } AssuanCommand;
94
95 #define ASSUAN_LINELENGTH 1002 /* 1000 + [CR,]LF */
96
97 struct assuan_context_s;
98 typedef struct assuan_context_s *assuan_context_t; 
99 typedef struct assuan_context_s *ASSUAN_CONTEXT; /* Deprecated.  */
100
101 /*-- assuan-handler.c --*/
102 int assuan_register_command (ASSUAN_CONTEXT ctx,
103                              int cmd_id, const char *cmd_string,
104                              int (*handler)(ASSUAN_CONTEXT, char *));
105 int assuan_register_bye_notify (ASSUAN_CONTEXT ctx,
106                                 void (*fnc)(ASSUAN_CONTEXT));
107 int assuan_register_reset_notify (ASSUAN_CONTEXT ctx,
108                                   void (*fnc)(ASSUAN_CONTEXT));
109 int assuan_register_cancel_notify (ASSUAN_CONTEXT ctx,
110                                    void (*fnc)(ASSUAN_CONTEXT));
111 int assuan_register_input_notify (ASSUAN_CONTEXT ctx,
112                                   void (*fnc)(ASSUAN_CONTEXT, const char *));
113 int assuan_register_output_notify (ASSUAN_CONTEXT ctx,
114                                   void (*fnc)(ASSUAN_CONTEXT, const char *));
115
116 int assuan_register_option_handler (ASSUAN_CONTEXT ctx,
117                                     int (*fnc)(ASSUAN_CONTEXT,
118                                                const char*, const char*));
119
120 int assuan_process (ASSUAN_CONTEXT ctx);
121 int assuan_process_next (ASSUAN_CONTEXT ctx);
122 int assuan_get_active_fds (ASSUAN_CONTEXT ctx, int what,
123                            int *fdarray, int fdarraysize);
124
125
126 AssuanError assuan_set_okay_line (ASSUAN_CONTEXT ctx, const char *line);
127 void assuan_write_status (ASSUAN_CONTEXT ctx,
128                           const char *keyword, const char *text);
129
130
131 /*-- assuan-listen.c --*/
132 AssuanError assuan_set_hello_line (ASSUAN_CONTEXT ctx, const char *line);
133 AssuanError assuan_accept (ASSUAN_CONTEXT ctx);
134 int assuan_get_input_fd (ASSUAN_CONTEXT ctx);
135 int assuan_get_output_fd (ASSUAN_CONTEXT ctx);
136 AssuanError assuan_close_input_fd (ASSUAN_CONTEXT ctx);
137 AssuanError assuan_close_output_fd (ASSUAN_CONTEXT ctx);
138
139
140 /*-- assuan-pipe-server.c --*/
141 int assuan_init_pipe_server (ASSUAN_CONTEXT *r_ctx, int filedes[2]);
142 void assuan_deinit_server (ASSUAN_CONTEXT ctx);
143
144 /*-- assuan-socket-server.c --*/
145 int assuan_init_socket_server (ASSUAN_CONTEXT *r_ctx, int listen_fd);
146
147
148 /*-- assuan-pipe-connect.c --*/
149 AssuanError assuan_pipe_connect (ASSUAN_CONTEXT *ctx, const char *name,
150                                  char *const argv[], int *fd_child_list);
151 /*-- assuan-socket-connect.c --*/
152 AssuanError assuan_socket_connect (ASSUAN_CONTEXT *ctx, const char *name,
153                                    pid_t server_pid);
154
155 /*-- assuan-connect.c --*/
156 void assuan_disconnect (ASSUAN_CONTEXT ctx);
157 pid_t assuan_get_pid (ASSUAN_CONTEXT ctx);
158
159 /*-- assuan-client.c --*/
160 AssuanError 
161 assuan_transact (ASSUAN_CONTEXT ctx,
162                  const char *command,
163                  AssuanError (*data_cb)(void *, const void *, size_t),
164                  void *data_cb_arg,
165                  AssuanError (*inquire_cb)(void*, const char *),
166                  void *inquire_cb_arg,
167                  AssuanError (*status_cb)(void*, const char *),
168                  void *status_cb_arg);
169
170
171 /*-- assuan-inquire.c --*/
172 AssuanError assuan_inquire (ASSUAN_CONTEXT ctx, const char *keyword,
173                             char **r_buffer, size_t *r_length, size_t maxlen);
174
175 /*-- assuan-buffer.c --*/
176 AssuanError assuan_read_line (ASSUAN_CONTEXT ctx,
177                               char **line, size_t *linelen);
178 int assuan_pending_line (ASSUAN_CONTEXT ctx);
179 AssuanError assuan_write_line (ASSUAN_CONTEXT ctx, const char *line );
180 AssuanError assuan_send_data (ASSUAN_CONTEXT ctx,
181                               const void *buffer, size_t length);
182
183
184 /*-- assuan-util.c --*/
185 void assuan_set_malloc_hooks ( void *(*new_alloc_func)(size_t n),
186                                void *(*new_realloc_func)(void *p, size_t n),
187                                void (*new_free_func)(void*) );
188 void assuan_set_log_stream (ASSUAN_CONTEXT ctx, FILE *fp);
189 int assuan_set_error (ASSUAN_CONTEXT ctx, int err, const char *text);
190 void assuan_set_pointer (ASSUAN_CONTEXT ctx, void *pointer);
191 void *assuan_get_pointer (ASSUAN_CONTEXT ctx);
192
193 void assuan_begin_confidential (ASSUAN_CONTEXT ctx);
194 void assuan_end_confidential (ASSUAN_CONTEXT ctx);
195
196 /*-- assuan-errors.c (built) --*/
197 const char *assuan_strerror (AssuanError err);
198
199
200 #ifdef __cplusplus
201 }
202 #endif
203 #endif /*ASSUAN_H*/