2006-12-17 Marcus Brinkmann <marcus@g10code.de>
[gpgme.git] / assuan / assuan.h
1 /* assuan.c - Definitions for the Assuan IPC library
2  * Copyright (C) 2001, 2002, 2003, 2005 Free Software Foundation, Inc.
3  *
4  * This file is part of Assuan.
5  *
6  * Assuan is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU Lesser General Public License as
8  * published by the Free Software Foundation; either version 2.1 of
9  * the License, or (at your option) any later version.
10  *
11  * Assuan 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  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
19  * USA. 
20  */
21
22 #ifndef ASSUAN_H
23 #define ASSUAN_H
24
25 #include <stdio.h>
26 #include <sys/types.h>
27 #include <unistd.h>
28
29
30 /* To use this file with libraries the following macros are useful:
31
32      #define _ASSUAN_EXT_SYM_PREFIX _foo_
33    
34      This prefixes all external symbols with "_foo_".
35
36      #define _ASSUAN_ONLY_GPG_ERRORS
37
38      If this is defined all old-style Assuan error codes are made
39      inactive as well as other dereacted stuff.
40
41    The follwing macros are used internally in the implementation of
42    libassuan:
43
44      #define _ASSUAN_NO_PTH 
45
46        This avoids inclusion of special GNU Pth hacks.
47
48      #define _ASSUAN_NO_FIXED_SIGNALS 
49
50        This disables changing of certain signal handler; i.e. SIGPIPE.
51
52      #define _ASSUAN_USE_DOUBLE_FORK
53
54        Use a double fork approach when connecting to a server through
55        a pipe.
56  */
57 /**** Begin GPGME specific modifications. ******/
58 #define _ASSUAN_EXT_SYM_PREFIX _gpgme_
59 #define _ASSUAN_NO_PTH 
60 #define _ASSUAN_NO_FIXED_SIGNALS 
61 #define _ASSUAN_USE_DOUBLE_FORK
62
63 #ifdef _ASSUAN_IN_GPGME_BUILD_ASSUAN
64 int _gpgme_io_read (int fd, void *buffer, size_t count);
65 int _gpgme_io_write (int fd, const void *buffer, size_t count);
66 ssize_t _gpgme_ath_waitpid (pid_t pid, int *status, int options);
67 #ifdef HAVE_W32_SYSTEM
68 int _gpgme_ath_accept (int s, void *addr, int *length_ptr);
69 #else /*!HAVE_W32_SYSTEM*/
70 struct sockaddr;
71 struct msghdr;
72 ssize_t _gpgme_ath_select (int nfd, fd_set *rset, fd_set *wset, fd_set *eset,
73                            struct timeval *timeout);
74 int _gpgme_ath_accept (int s, struct sockaddr *addr, socklen_t *length_ptr);
75 int _gpgme_ath_connect (int s, struct sockaddr *addr, socklen_t length);
76 int _gpgme_ath_sendmsg (int s, const struct msghdr *msg, int flags);
77 int _gpgme_ath_recvmsg (int s, struct msghdr *msg, int flags);
78 int _gpgme_io_sendmsg (int sock, const struct msghdr *msg, int flags);
79 int _gpgme_io_recvmsg (int sock, struct msghdr *msg, int flags);
80 #endif /*!HAVE_W32_SYSTEM*/
81
82 #define read          _gpgme_io_read
83 #define write         _gpgme_io_write
84 #define waitpid       _gpgme_ath_waitpid
85 #define select        _gpgme_ath_select
86 #define accept        _gpgme_ath_accept
87 #define connect       _gpgme_ath_connect
88 #define sendmsg       _gpgme_io_sendmsg
89 #define recvmsg       _gpgme_io_recvmsg
90 #endif /*_ASSUAN_IN_GPGME_BUILD_ASSUAN*/
91 /**** End GPGME specific modifications. ******/
92
93
94 #ifdef _ASSUAN_EXT_SYM_PREFIX
95 #define _ASSUAN_PREFIX1(x,y) x ## y
96 #define _ASSUAN_PREFIX2(x,y) _ASSUAN_PREFIX1(x,y)
97 #define _ASSUAN_PREFIX(x) _ASSUAN_PREFIX2(_ASSUAN_EXT_SYM_PREFIX,x)
98 #define assuan_ _ASSUAN_PREFIX(assuan_)
99 #define assuan_register_command _ASSUAN_PREFIX(assuan_register_command)
100 #define assuan_register_post_cmd_notify \
101   _ASSUAN_PREFIX(assuan_register_post_cmd_notify)
102 #define assuan_register_bye_notify _ASSUAN_PREFIX(assuan_register_bye_notify)
103 #define assuan_register_reset_notify \
104   _ASSUAN_PREFIX(assuan_register_reset_notify)
105 #define assuan_register_cancel_notify \
106   _ASSUAN_PREFIX(assuan_register_cancel_notify)
107 #define assuan_register_input_notify \
108   _ASSUAN_PREFIX(assuan_register_input_notify)
109 #define assuan_register_output_notify \
110   _ASSUAN_PREFIX(assuan_register_output_notify)
111 #define assuan_register_option_handler \
112   _ASSUAN_PREFIX(assuan_register_option_handler)
113 #define assuan_process _ASSUAN_PREFIX(assuan_process)
114 #define assuan_process_next _ASSUAN_PREFIX(assuan_process_next)
115 #define assuan_get_active_fds _ASSUAN_PREFIX(assuan_get_active_fds)
116 #define assuan_get_data_fp _ASSUAN_PREFIX(assuan_get_data_fp)
117 #define assuan_set_okay_line _ASSUAN_PREFIX(assuan_set_okay_line)
118 #define assuan_write_status _ASSUAN_PREFIX(assuan_write_status)
119 #define assuan_command_parse_fd _ASSUAN_PREFIX(assuan_command_parse_fd)
120 #define assuan_set_hello_line _ASSUAN_PREFIX(assuan_set_hello_line)
121 #define assuan_accept _ASSUAN_PREFIX(assuan_accept)
122 #define assuan_get_input_fd _ASSUAN_PREFIX(assuan_get_input_fd)
123 #define assuan_get_output_fd _ASSUAN_PREFIX(assuan_get_output_fd)
124 #define assuan_close_input_fd _ASSUAN_PREFIX(assuan_close_input_fd)
125 #define assuan_close_output_fd _ASSUAN_PREFIX(assuan_close_output_fd)
126 #define assuan_init_pipe_server _ASSUAN_PREFIX(assuan_init_pipe_server)
127 #define assuan_deinit_server _ASSUAN_PREFIX(assuan_deinit_server)
128 #define assuan_init_socket_server _ASSUAN_PREFIX(assuan_init_socket_server)
129 #define assuan_init_connected_socket_server \
130   _ASSUAN_PREFIX(assuan_init_connected_socket_server)
131 #define assuan_init_socket_server_ext \
132   _ASSUAN_PREFIX(assuan_init_socket_server_ext)
133 #define assuan_pipe_connect _ASSUAN_PREFIX(assuan_pipe_connect)
134 #define assuan_pipe_connect_ext _ASSUAN_PREFIX(assuan_pipe_connect_ext)
135 #define assuan_socket_connect _ASSUAN_PREFIX(assuan_socket_connect)
136 #define assuan_socket_connect_ext _ASSUAN_PREFIX(assuan_socket_connect_ext)
137 #define assuan_disconnect _ASSUAN_PREFIX(assuan_disconnect)
138 #define assuan_get_pid _ASSUAN_PREFIX(assuan_get_pid)
139 #define assuan_get_peercred _ASSUAN_PREFIX(assuan_get_peercred)
140 #define assuan_transact _ASSUAN_PREFIX(assuan_transact)
141 #define assuan_inquire _ASSUAN_PREFIX(assuan_inquire)
142 #define assuan_read_line _ASSUAN_PREFIX(assuan_read_line)
143 #define assuan_pending_line _ASSUAN_PREFIX(assuan_pending_line)
144 #define assuan_write_line _ASSUAN_PREFIX(assuan_write_line)
145 #define assuan_send_data _ASSUAN_PREFIX(assuan_send_data)
146 #define assuan_sendfd _ASSUAN_PREFIX(assuan_sendfd)
147 #define assuan_receivefd _ASSUAN_PREFIX(assuan_receivefd)
148 #define assuan_set_malloc_hooks _ASSUAN_PREFIX(assuan_set_malloc_hooks)
149 #define assuan_set_log_stream _ASSUAN_PREFIX(assuan_set_log_stream)
150 #define assuan_set_error _ASSUAN_PREFIX(assuan_set_error)
151 #define assuan_set_pointer _ASSUAN_PREFIX(assuan_set_pointer)
152 #define assuan_get_pointer _ASSUAN_PREFIX(assuan_get_pointer)
153 #define assuan_set_io_monitor _ASSUAN_PREFIX(assuan_set_io_monitor)
154 #define assuan_begin_confidential _ASSUAN_PREFIX(assuan_begin_confidential)
155 #define assuan_end_confidential _ASSUAN_PREFIX(assuan_end_confidential)
156 #define assuan_strerror _ASSUAN_PREFIX(assuan_strerror)
157 #define assuan_set_assuan_err_source \
158   _ASSUAN_PREFIX(assuan_set_assuan_err_source)
159 #define assuan_set_assuan_log_stream \
160   _ASSUAN_PREFIX(assuan_set_assuan_log_stream)
161 #define assuan_get_assuan_log_stream \
162   _ASSUAN_PREFIX(assuan_get_assuan_log_stream)
163 #define assuan_get_assuan_log_prefix \
164   _ASSUAN_PREFIX(assuan_get_assuan_log_prefix)
165 #define assuan_set_flag _ASSUAN_PREFIX(assuan_set_flag)
166 #define assuan_get_flag _ASSUAN_PREFIX(assuan_get_flag)
167
168 /* And now the internal functions, argh...  */
169 #define _assuan_read_line _ASSUAN_PREFIX(_assuan_read_line)
170 #define _assuan_cookie_write_data _ASSUAN_PREFIX(_assuan_cookie_write_data)
171 #define _assuan_cookie_write_flush _ASSUAN_PREFIX(_assuan_cookie_write_flush)
172 #define _assuan_read_from_server _ASSUAN_PREFIX(_assuan_read_from_server)
173 #define _assuan_domain_init _ASSUAN_PREFIX(_assuan_domain_init)
174 #define _assuan_register_std_commands \
175   _ASSUAN_PREFIX(_assuan_register_std_commands)
176 #define _assuan_simple_read _ASSUAN_PREFIX(_assuan_simple_read)
177 #define _assuan_simple_write _ASSUAN_PREFIX(_assuan_simple_write)
178 #define _assuan_simple_read _ASSUAN_PREFIX(_assuan_simple_read)
179 #define _assuan_simple_write _ASSUAN_PREFIX(_assuan_simple_write)
180 #define _assuan_new_context _ASSUAN_PREFIX(_assuan_new_context)
181 #define _assuan_release_context _ASSUAN_PREFIX(_assuan_release_context)
182 #define _assuan_malloc _ASSUAN_PREFIX(_assuan_malloc)
183 #define _assuan_realloc _ASSUAN_PREFIX(_assuan_realloc)
184 #define _assuan_calloc _ASSUAN_PREFIX(_assuan_calloc)
185 #define _assuan_free _ASSUAN_PREFIX(_assuan_free)
186 #define _assuan_log_print_buffer _ASSUAN_PREFIX(_assuan_log_print_buffer)
187 #define _assuan_log_sanitized_string \
188   _ASSUAN_PREFIX(_assuan_log_sanitized_string)
189 #define _assuan_log_printf _ASSUAN_PREFIX(_assuan_log_printf)
190 #define _assuan_set_default_log_stream \
191   _ASSUAN_PREFIX(_assuan_set_default_log_stream)
192 #define _assuan_w32_strerror _ASSUAN_PREFIX(_assuan_w32_strerror)
193 #define _assuan_write_line _ASSUAN_PREFIX(_assuan_write_line)
194 #define _assuan_close _ASSUAN_PREFIX(_assuan_close)   
195 #define _assuan_sock_new _ASSUAN_PREFIX(_assuan_sock_new)  
196 #define _assuan_sock_bind _ASSUAN_PREFIX(_assuan_sock_bind)
197 #define _assuan_sock_connect _ASSUAN_PREFIX(_assuan_sock_connect)
198
199 #endif /*_ASSUAN_EXT_SYM_PREFIX*/
200
201
202 #ifdef __cplusplus
203 extern "C"
204 {
205 #if 0
206 }
207 #endif
208 #endif
209
210
211 /* Check for compiler features.  */
212 #if __GNUC__
213 #define _ASSUAN_GCC_VERSION (__GNUC__ * 10000 \
214                             + __GNUC_MINOR__ * 100 \
215                             + __GNUC_PATCHLEVEL__)
216
217 #if _ASSUAN_GCC_VERSION > 30100
218 #define _ASSUAN_DEPRECATED  __attribute__ ((__deprecated__))
219 #endif
220 #endif
221 #ifndef _ASSUAN_DEPRECATED
222 #define _ASSUAN_DEPRECATED
223 #endif
224
225
226 /* Assuan error codes.  These are only used by old applications or
227    those applications which won't make use of libgpg-error. */
228 #ifndef _ASSUAN_ONLY_GPG_ERRORS
229 #ifndef _ASSUAN_IN_LIBASSUAN
230 #define  ASSUAN_No_Error 0
231 #endif
232 #define  ASSUAN_General_Error 1
233 #define  ASSUAN_Out_Of_Core 2
234 #define  ASSUAN_Invalid_Value 3
235 #ifndef _ASSUAN_IN_LIBASSUAN
236 #define  ASSUAN_Timeout 4
237 #endif
238 #define  ASSUAN_Read_Error 5
239 #define  ASSUAN_Write_Error 6
240 #define  ASSUAN_Problem_Starting_Server 7
241 #define  ASSUAN_Not_A_Server 8
242 #ifndef _ASSUAN_IN_LIBASSUAN
243 #define  ASSUAN_Not_A_Client 9
244 #endif
245 #define  ASSUAN_Nested_Commands 10
246 #define  ASSUAN_Invalid_Response 11
247 #define  ASSUAN_No_Data_Callback 12
248 #define  ASSUAN_No_Inquire_Callback 13
249 #define  ASSUAN_Connect_Failed 14
250 #define  ASSUAN_Accept_Failed 15
251
252   /* Error codes above 99 are meant as status codes */
253 #define  ASSUAN_Not_Implemented 100
254 #define  ASSUAN_Server_Fault    101
255 #ifndef _ASSUAN_IN_LIBASSUAN
256 #define  ASSUAN_Invalid_Command 102
257 #endif
258 #define  ASSUAN_Unknown_Command 103
259 #define  ASSUAN_Syntax_Error    104
260 #ifndef _ASSUAN_IN_LIBASSUAN
261 #define  ASSUAN_Parameter_Error 105
262 #endif
263 #define  ASSUAN_Parameter_Conflict 106
264 #define  ASSUAN_Line_Too_Long 107
265 #define  ASSUAN_Line_Not_Terminated 108
266 #ifndef _ASSUAN_IN_LIBASSUAN
267 #define  ASSUAN_No_Input 109
268 #define  ASSUAN_No_Output 110
269 #endif
270 #define  ASSUAN_Canceled 111
271 #ifndef _ASSUAN_IN_LIBASSUAN
272 #define  ASSUAN_Unsupported_Algorithm 112
273 #define  ASSUAN_Server_Resource_Problem 113
274 #define  ASSUAN_Server_IO_Error 114
275 #define  ASSUAN_Server_Bug 115
276 #define  ASSUAN_No_Data_Available 116
277 #define  ASSUAN_Invalid_Data 117
278 #endif
279 #define  ASSUAN_Unexpected_Command 118
280 #define  ASSUAN_Too_Much_Data 119
281 #ifndef _ASSUAN_IN_LIBASSUAN
282 #define  ASSUAN_Inquire_Unknown 120
283 #define  ASSUAN_Inquire_Error 121
284 #define  ASSUAN_Invalid_Option 122
285 #define  ASSUAN_Invalid_Index 123
286 #define  ASSUAN_Unexpected_Status 124
287 #define  ASSUAN_Unexpected_Data 125
288 #define  ASSUAN_Invalid_Status 126
289 #define  ASSUAN_Locale_Problem 127
290 #endif
291 #define  ASSUAN_Not_Confirmed 128
292
293   /* Warning: Don't use the Error codes, below they are deprecated. */
294 #ifndef _ASSUAN_IN_LIBASSUAN
295 #define  ASSUAN_Bad_Certificate 201
296 #define  ASSUAN_Bad_Certificate_Chain 202
297 #define  ASSUAN_Missing_Certificate 203
298 #define  ASSUAN_Bad_Signature 204
299 #define  ASSUAN_No_Agent 205
300 #define  ASSUAN_Agent_Error 206
301 #define  ASSUAN_No_Public_Key 207
302 #define  ASSUAN_No_Secret_Key 208
303 #define  ASSUAN_Invalid_Name 209
304
305 #define  ASSUAN_Cert_Revoked 301
306 #define  ASSUAN_No_CRL_For_Cert 302
307 #define  ASSUAN_CRL_Too_Old 303
308 #define  ASSUAN_Not_Trusted 304
309
310 #define  ASSUAN_Card_Error 401
311 #define  ASSUAN_Invalid_Card 402
312 #define  ASSUAN_No_PKCS15_App 403
313 #define  ASSUAN_Card_Not_Present 404
314 #define  ASSUAN_Invalid_Id 405
315
316   /* Error codes in the range 1000 to 9999 may be used by applications
317      at their own discretion. */
318 #define  ASSUAN_USER_ERROR_FIRST 1000
319 #define  ASSUAN_USER_ERROR_LAST 9999
320 #endif
321
322 typedef int assuan_error_t;
323
324 typedef assuan_error_t AssuanError _ASSUAN_DEPRECATED; 
325
326 /* This is a list of pre-registered ASSUAN commands */
327 /* Note, these command IDs are now deprectated and solely exists for
328    compatibility reasons. */
329 typedef enum
330 {
331   ASSUAN_CMD_NOP = 0,
332   ASSUAN_CMD_CANCEL,    /* cancel the current request */
333   ASSUAN_CMD_BYE,
334   ASSUAN_CMD_AUTH,
335   ASSUAN_CMD_RESET,
336   ASSUAN_CMD_OPTION,
337   ASSUAN_CMD_DATA,
338   ASSUAN_CMD_END,
339   ASSUAN_CMD_INPUT,
340   ASSUAN_CMD_OUTPUT,
341
342   ASSUAN_CMD_USER = 256  /* Other commands should be used with this offset*/
343 } AssuanCommand;
344
345
346 #else  /*!_ASSUAN_ONLY_GPG_ERRORS*/
347
348 typedef int assuan_error_t;
349
350 #endif /*!_ASSUAN_ONLY_GPG_ERRORS*/
351
352
353 /* Definitions of flags for assuan_set_flag(). */
354 typedef enum
355   {
356     /* When using a pipe server, by default Assuan will wait for the
357        forked process to die in assuan_disconnect.  In certain cases
358        this is not desirable.  By setting this flag, the waitpid will
359        be skipped and the caller is responsible to cleanup a forked
360        process. */
361     ASSUAN_NO_WAITPID = 1
362   } 
363 assuan_flag_t;
364
365 #define ASSUAN_LINELENGTH 1002 /* 1000 + [CR,]LF */
366
367 struct assuan_context_s;
368 typedef struct assuan_context_s *assuan_context_t;
369 #ifndef _ASSUAN_ONLY_GPG_ERRORS
370 typedef struct assuan_context_s *ASSUAN_CONTEXT _ASSUAN_DEPRECATED;
371 #endif /*_ASSUAN_ONLY_GPG_ERRORS*/
372
373 /*-- assuan-handler.c --*/
374 int assuan_register_command (assuan_context_t ctx,
375                              const char *cmd_string,
376                              int (*handler)(assuan_context_t, char *));
377 int assuan_register_post_cmd_notify (assuan_context_t ctx,
378                                      void (*fnc)(assuan_context_t, int));
379 int assuan_register_bye_notify (assuan_context_t ctx,
380                                 void (*fnc)(assuan_context_t));
381 int assuan_register_reset_notify (assuan_context_t ctx,
382                                   void (*fnc)(assuan_context_t));
383 int assuan_register_cancel_notify (assuan_context_t ctx,
384                                    void (*fnc)(assuan_context_t));
385 int assuan_register_input_notify (assuan_context_t ctx,
386                                   void (*fnc)(assuan_context_t, const char *));
387 int assuan_register_output_notify (assuan_context_t ctx,
388                                   void (*fnc)(assuan_context_t, const char *));
389
390 int assuan_register_option_handler (assuan_context_t ctx,
391                                     int (*fnc)(assuan_context_t,
392                                                const char*, const char*));
393
394 int assuan_process (assuan_context_t ctx);
395 int assuan_process_next (assuan_context_t ctx);
396 int assuan_get_active_fds (assuan_context_t ctx, int what,
397                            int *fdarray, int fdarraysize);
398
399
400 FILE *assuan_get_data_fp (assuan_context_t ctx);
401 assuan_error_t assuan_set_okay_line (assuan_context_t ctx, const char *line);
402 assuan_error_t assuan_write_status (assuan_context_t ctx,
403                                     const char *keyword, const char *text);
404
405 /* Negotiate a file descriptor.  If LINE contains "FD=N", returns N
406    assuming a local file descriptor.  If LINE contains "FD" reads a
407    file descriptor via CTX and stores it in *RDF (the CTX must be
408    capable of passing file descriptors).  */
409 assuan_error_t assuan_command_parse_fd (assuan_context_t ctx, char *line,
410                                         int *rfd);
411
412 /*-- assuan-listen.c --*/
413 assuan_error_t assuan_set_hello_line (assuan_context_t ctx, const char *line);
414 assuan_error_t assuan_accept (assuan_context_t ctx);
415 int assuan_get_input_fd (assuan_context_t ctx);
416 int assuan_get_output_fd (assuan_context_t ctx);
417 assuan_error_t assuan_close_input_fd (assuan_context_t ctx);
418 assuan_error_t assuan_close_output_fd (assuan_context_t ctx);
419
420
421 /*-- assuan-pipe-server.c --*/
422 int assuan_init_pipe_server (assuan_context_t *r_ctx, int filedes[2]);
423 void assuan_deinit_server (assuan_context_t ctx);
424
425 /*-- assuan-socket-server.c --*/
426 int assuan_init_socket_server (assuan_context_t *r_ctx, int listen_fd);
427 int assuan_init_connected_socket_server (assuan_context_t *r_ctx, 
428                                          int fd) _ASSUAN_DEPRECATED;
429 int assuan_init_socket_server_ext (assuan_context_t *r_ctx, int fd,
430                                    unsigned int flags);
431
432 /*-- assuan-pipe-connect.c --*/
433 assuan_error_t assuan_pipe_connect (assuan_context_t *ctx,
434                                     const char *name,
435                                     const char *const argv[],
436                                     int *fd_child_list);
437 assuan_error_t assuan_pipe_connect2 (assuan_context_t *ctx,
438                                      const char *name,
439                                      const char *const argv[],
440                                      int *fd_child_list,
441                                      void (*atfork) (void*, int),
442                                      void *atforkvalue) _ASSUAN_DEPRECATED;
443 assuan_error_t assuan_pipe_connect_ext (assuan_context_t *ctx, 
444                                         const char *name,
445                                         const char *const argv[],
446                                         int *fd_child_list,
447                                         void (*atfork) (void *, int),
448                                         void *atforkvalue,
449                                         unsigned int flags);
450
451 /*-- assuan-socket-connect.c --*/
452 assuan_error_t assuan_socket_connect (assuan_context_t *ctx, 
453                                       const char *name,
454                                       pid_t server_pid);
455 assuan_error_t assuan_socket_connect_ext (assuan_context_t *ctx,
456                                           const char *name,
457                                           pid_t server_pid,
458                                           unsigned int flags);
459
460 /*-- assuan-connect.c --*/
461 void assuan_disconnect (assuan_context_t ctx);
462 pid_t assuan_get_pid (assuan_context_t ctx);
463 assuan_error_t assuan_get_peercred (assuan_context_t ctx,
464                                     pid_t *pid, uid_t *uid, gid_t *gid);
465
466 /*-- assuan-client.c --*/
467 assuan_error_t 
468 assuan_transact (assuan_context_t ctx,
469                  const char *command,
470                  int (*data_cb)(void *, const void *, size_t),
471                  void *data_cb_arg,
472                  int (*inquire_cb)(void*, const char *),
473                  void *inquire_cb_arg,
474                  int (*status_cb)(void*, const char *),
475                  void *status_cb_arg);
476
477
478 /*-- assuan-inquire.c --*/
479 assuan_error_t assuan_inquire (assuan_context_t ctx, const char *keyword,
480                                unsigned char **r_buffer, size_t *r_length,
481                                size_t maxlen);
482
483 /*-- assuan-buffer.c --*/
484 assuan_error_t assuan_read_line (assuan_context_t ctx,
485                               char **line, size_t *linelen);
486 int assuan_pending_line (assuan_context_t ctx);
487 assuan_error_t assuan_write_line (assuan_context_t ctx, const char *line );
488 assuan_error_t assuan_send_data (assuan_context_t ctx,
489                               const void *buffer, size_t length);
490
491 /* The file descriptor must be pending before assuan_receivefd is
492    called.  This means that assuan_sendfd should be called *before* the
493    trigger is sent (normally via assuan_write_line ("INPUT FD")).  */
494 assuan_error_t assuan_sendfd (assuan_context_t ctx, int fd);
495 assuan_error_t assuan_receivefd (assuan_context_t ctx, int *fd);
496
497 /*-- assuan-util.c --*/
498 void assuan_set_malloc_hooks ( void *(*new_alloc_func)(size_t n),
499                                void *(*new_realloc_func)(void *p, size_t n),
500                                void (*new_free_func)(void*) );
501 void assuan_set_log_stream (assuan_context_t ctx, FILE *fp);
502 int assuan_set_error (assuan_context_t ctx, int err, const char *text);
503 void assuan_set_pointer (assuan_context_t ctx, void *pointer);
504 void *assuan_get_pointer (assuan_context_t ctx);
505
506 void assuan_begin_confidential (assuan_context_t ctx);
507 void assuan_end_confidential (assuan_context_t ctx);
508
509 void assuan_set_io_monitor (assuan_context_t ctx,
510                             unsigned int (*monitor)(assuan_context_t ctx,
511                                                     int direction,
512                                                     const char *line,
513                                                     size_t linelen));
514
515 /* For context CTX, set the flag FLAG to VALUE.  Values for flags
516    are usually 1 or 0 but certain flags might allow for other values;
517    see the description of the type assuan_flag_t for details. */
518 void assuan_set_flag (assuan_context_t ctx, assuan_flag_t flag, int value);
519
520 /* Return the VALUE of FLAG in context CTX. */ 
521 int  assuan_get_flag (assuan_context_t ctx, assuan_flag_t flag);
522
523
524 /*-- assuan-errors.c --*/
525
526 #ifndef _ASSUAN_ONLY_GPG_ERRORS
527 /* Return a string describing the assuan error.  The use of this
528    function is deprecated; it is better to call
529    assuan_set_assuan_err_source once and then make use libgpg-error. */
530 const char *assuan_strerror (assuan_error_t err);
531 #endif /*_ASSUAN_ONLY_GPG_ERRORS*/
532
533 /* Enable gpg-error style error codes.  ERRSOURCE is one of gpg-error
534    sources.  Note, that this function is not thread-safe and should be
535    used right at startup. Switching back to the old style mode is not
536    supported. */
537 void assuan_set_assuan_err_source (int errsource);
538
539 /*-- assuan-logging.c --*/
540
541 /* Set the stream to which assuan should log message not associated
542    with a context.  By default, this is stderr.  The default value
543    will be changed when the first log stream is associated with a
544    context.  Note, that this function is not thread-safe and should
545    in general be used right at startup. */
546 extern void assuan_set_assuan_log_stream (FILE *fp);
547
548 /* Return the stream which is currently being using for global logging.  */
549 extern FILE *assuan_get_assuan_log_stream (void);
550
551 /* Set the prefix to be used at the start of a line emitted by assuan
552    on the log stream.  The default is the empty string.  Note, that
553    this function is not thread-safe and should in general be used
554    right at startup. */
555 void assuan_set_assuan_log_prefix (const char *text);
556
557 /* Return a prefix to be used at the start of a line emitted by assuan
558    on the log stream.  The default implementation returns the empty
559    string, i.e. ""  */
560 const char *assuan_get_assuan_log_prefix (void);
561
562 #ifdef __cplusplus
563 }
564 #endif
565 #endif /* ASSUAN_H */