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