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