assuan/
[gpgme.git] / assuan / assuan.h
1 /* assuan.h - Definitions for the Assuan IPC library
2  * Copyright (C) 2001, 2002, 2003, 2005, 2007, 
3  *               2008 Free Software Foundation, Inc.
4  *
5  * This file is part of Assuan.
6  *
7  * Assuan is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU Lesser General Public License as
9  * published by the Free Software Foundation; either version 2.1 of
10  * the License, or (at your option) any later version.
11  *
12  * Assuan is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #ifndef ASSUAN_H
22 #define ASSUAN_H
23
24 #include <stdio.h>
25 #include <sys/types.h>
26 #include <unistd.h>
27 #ifndef _ASSUAN_NO_SOCKET_WRAPPER
28 #ifdef _WIN32
29 #include <ws2tcpip.h> 
30 #else
31 #include <sys/socket.h>
32 #endif
33 #endif /*!_ASSUAN_NO_SOCKET_WRAPPER*/
34
35 /* To use this file with libraries the following macros are useful:
36
37      #define _ASSUAN_EXT_SYM_PREFIX _foo_
38    
39        This prefixes all external symbols with "_foo_".
40
41      #define _ASSUAN_ONLY_GPG_ERRORS
42
43        If this is defined all old-style Assuan error codes are made
44        inactive as well as other deprecated stuff.
45
46      #define _ASSUAN_NO_SOCKET_WRAPPER
47
48        Do not include the definitions for the socket wrapper feature.
49
50    The follwing macros are used internally in the implementation of
51    libassuan:
52
53      #define _ASSUAN_NO_PTH 
54
55        This avoids inclusion of special GNU Pth hacks.
56
57      #define _ASSUAN_NO_FIXED_SIGNALS 
58
59        This disables changing of certain signal handler; i.e. SIGPIPE.
60
61      #define _ASSUAN_USE_DOUBLE_FORK
62
63        Use a double fork approach when connecting to a server through
64        a pipe.
65  */
66 /**** Begin GPGME specific modifications. ******/
67 #define _ASSUAN_EXT_SYM_PREFIX _gpgme_
68 #define _ASSUAN_NO_PTH 
69 #define _ASSUAN_NO_FIXED_SIGNALS 
70 #define _ASSUAN_USE_DOUBLE_FORK
71
72 #ifdef _ASSUAN_IN_GPGME_BUILD_ASSUAN
73 #include <ath.h>
74
75 int _gpgme_io_close (int fd);
76 int _gpgme_io_read (int fd, void *buffer, size_t count);
77 int _gpgme_io_write (int fd, const void *buffer, size_t count);
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
81 #define _assuan_funopen _gpgme_funopen
82
83 #define close         _gpgme_io_close
84 #define read          _gpgme_io_read
85 #define write         _gpgme_io_write
86 #define waitpid       _gpgme_ath_waitpid
87 #define select        _gpgme_ath_select
88 #define accept        _gpgme_ath_accept
89 #define connect       _gpgme_ath_connect
90 #define sendmsg       _gpgme_io_sendmsg
91 #define recvmsg       _gpgme_io_recvmsg
92 #endif /*_ASSUAN_IN_GPGME_BUILD_ASSUAN*/
93 /**** End GPGME specific modifications. ******/
94
95
96 #ifdef _ASSUAN_EXT_SYM_PREFIX
97 #define _ASSUAN_PREFIX1(x,y) x ## y
98 #define _ASSUAN_PREFIX2(x,y) _ASSUAN_PREFIX1(x,y)
99 #define _ASSUAN_PREFIX(x) _ASSUAN_PREFIX2(_ASSUAN_EXT_SYM_PREFIX,x)
100 #define assuan_ _ASSUAN_PREFIX(assuan_)
101 #define assuan_register_command _ASSUAN_PREFIX(assuan_register_command)
102 #define assuan_register_post_cmd_notify \
103   _ASSUAN_PREFIX(assuan_register_post_cmd_notify)
104 #define assuan_register_bye_notify _ASSUAN_PREFIX(assuan_register_bye_notify)
105 #define assuan_register_reset_notify \
106   _ASSUAN_PREFIX(assuan_register_reset_notify)
107 #define assuan_register_cancel_notify \
108   _ASSUAN_PREFIX(assuan_register_cancel_notify)
109 #define assuan_register_input_notify \
110   _ASSUAN_PREFIX(assuan_register_input_notify)
111 #define assuan_register_output_notify \
112   _ASSUAN_PREFIX(assuan_register_output_notify)
113 #define assuan_register_option_handler \
114   _ASSUAN_PREFIX(assuan_register_option_handler)
115 #define assuan_process _ASSUAN_PREFIX(assuan_process)
116 #define assuan_process_next _ASSUAN_PREFIX(assuan_process_next)
117 #define assuan_process_done _ASSUAN_PREFIX(assuan_process_done)
118 #define assuan_get_active_fds _ASSUAN_PREFIX(assuan_get_active_fds)
119 #define assuan_get_data_fp _ASSUAN_PREFIX(assuan_get_data_fp)
120 #define assuan_set_okay_line _ASSUAN_PREFIX(assuan_set_okay_line)
121 #define assuan_write_status _ASSUAN_PREFIX(assuan_write_status)
122 #define assuan_command_parse_fd _ASSUAN_PREFIX(assuan_command_parse_fd)
123 #define assuan_set_hello_line _ASSUAN_PREFIX(assuan_set_hello_line)
124 #define assuan_accept _ASSUAN_PREFIX(assuan_accept)
125 #define assuan_get_input_fd _ASSUAN_PREFIX(assuan_get_input_fd)
126 #define assuan_get_output_fd _ASSUAN_PREFIX(assuan_get_output_fd)
127 #define assuan_close_input_fd _ASSUAN_PREFIX(assuan_close_input_fd)
128 #define assuan_close_output_fd _ASSUAN_PREFIX(assuan_close_output_fd)
129 #define assuan_init_pipe_server _ASSUAN_PREFIX(assuan_init_pipe_server)
130 #define assuan_deinit_server _ASSUAN_PREFIX(assuan_deinit_server)
131 #define assuan_init_socket_server _ASSUAN_PREFIX(assuan_init_socket_server)
132 #define assuan_init_connected_socket_server \
133   _ASSUAN_PREFIX(assuan_init_connected_socket_server)
134 #define assuan_init_socket_server_ext \
135   _ASSUAN_PREFIX(assuan_init_socket_server_ext)
136 #define assuan_pipe_connect _ASSUAN_PREFIX(assuan_pipe_connect)
137 #define assuan_pipe_connect_ext _ASSUAN_PREFIX(assuan_pipe_connect_ext)
138 #define assuan_socket_connect _ASSUAN_PREFIX(assuan_socket_connect)
139 #define assuan_socket_connect_ext _ASSUAN_PREFIX(assuan_socket_connect_ext)
140 #define assuan_disconnect _ASSUAN_PREFIX(assuan_disconnect)
141 #define assuan_get_pid _ASSUAN_PREFIX(assuan_get_pid)
142 #define assuan_get_peercred _ASSUAN_PREFIX(assuan_get_peercred)
143 #define assuan_transact _ASSUAN_PREFIX(assuan_transact)
144 #define assuan_inquire _ASSUAN_PREFIX(assuan_inquire)
145 #define assuan_inquire_ext _ASSUAN_PREFIX(assuan_inquire_ext)
146 #define assuan_read_line _ASSUAN_PREFIX(assuan_read_line)
147 #define assuan_pending_line _ASSUAN_PREFIX(assuan_pending_line)
148 #define assuan_write_line _ASSUAN_PREFIX(assuan_write_line)
149 #define assuan_send_data _ASSUAN_PREFIX(assuan_send_data)
150 #define assuan_sendfd _ASSUAN_PREFIX(assuan_sendfd)
151 #define assuan_receivefd _ASSUAN_PREFIX(assuan_receivefd)
152 #define assuan_set_malloc_hooks _ASSUAN_PREFIX(assuan_set_malloc_hooks)
153 #define assuan_set_io_hooks _ASSUAN_PREFIX(assuan_set_io_hooks)
154 #define assuan_set_log_stream _ASSUAN_PREFIX(assuan_set_log_stream)
155 #define assuan_set_error _ASSUAN_PREFIX(assuan_set_error)
156 #define assuan_set_pointer _ASSUAN_PREFIX(assuan_set_pointer)
157 #define assuan_get_pointer _ASSUAN_PREFIX(assuan_get_pointer)
158 #define assuan_set_io_monitor _ASSUAN_PREFIX(assuan_set_io_monitor)
159 #define assuan_begin_confidential _ASSUAN_PREFIX(assuan_begin_confidential)
160 #define assuan_end_confidential _ASSUAN_PREFIX(assuan_end_confidential)
161 #define assuan_strerror _ASSUAN_PREFIX(assuan_strerror)
162 #define assuan_set_assuan_err_source \
163   _ASSUAN_PREFIX(assuan_set_assuan_err_source)
164 #define assuan_set_assuan_log_stream \
165   _ASSUAN_PREFIX(assuan_set_assuan_log_stream)
166 #define assuan_get_assuan_log_stream \
167   _ASSUAN_PREFIX(assuan_get_assuan_log_stream)
168 #define assuan_get_assuan_log_prefix \
169   _ASSUAN_PREFIX(assuan_get_assuan_log_prefix)
170 #define assuan_set_flag _ASSUAN_PREFIX(assuan_set_flag)
171 #define assuan_get_flag _ASSUAN_PREFIX(assuan_get_flag)
172 #define assuan_pipe_connect2 _ASSUAN_PREFIX(assuan_pipe_connect2)
173 #define assuan_set_assuan_log_prefix \
174   _ASSUAN_PREFIX(assuan_set_assuan_log_prefix)
175 #define assuan_sock_close       _ASSUAN_PREFIX(assuan_sock_close)      
176 #define assuan_sock_new         _ASSUAN_PREFIX(assuan_sock_new)        
177 #define assuan_sock_connect     _ASSUAN_PREFIX(assuan_sock_connect)    
178 #define assuan_sock_bind        _ASSUAN_PREFIX(assuan_sock_bind)       
179 #define assuan_sock_get_nonce   _ASSUAN_PREFIX(assuan_sock_get_nonce)
180 #define assuan_sock_check_nonce _ASSUAN_PREFIX(assuan_sock_check_nonce)
181
182
183 /* And now the internal functions, argh...  */
184 #define _assuan_read_line _ASSUAN_PREFIX(_assuan_read_line)
185 #define _assuan_cookie_write_data _ASSUAN_PREFIX(_assuan_cookie_write_data)
186 #define _assuan_cookie_write_flush _ASSUAN_PREFIX(_assuan_cookie_write_flush)
187 #define _assuan_read_from_server _ASSUAN_PREFIX(_assuan_read_from_server)
188 #define _assuan_domain_init _ASSUAN_PREFIX(_assuan_domain_init)
189 #define _assuan_register_std_commands \
190   _ASSUAN_PREFIX(_assuan_register_std_commands)
191 #define _assuan_simple_read _ASSUAN_PREFIX(_assuan_simple_read)
192 #define _assuan_simple_write _ASSUAN_PREFIX(_assuan_simple_write)
193 #define _assuan_io_read _ASSUAN_PREFIX(_assuan_io_read)
194 #define _assuan_io_write _ASSUAN_PREFIX(_assuan_io_write)
195 #define _assuan_io_hooks _ASSUAN_PREFIX(_assuan_io_hooks)
196 #define _assuan_new_context _ASSUAN_PREFIX(_assuan_new_context)
197 #define _assuan_release_context _ASSUAN_PREFIX(_assuan_release_context)
198 #define _assuan_malloc _ASSUAN_PREFIX(_assuan_malloc)
199 #define _assuan_realloc _ASSUAN_PREFIX(_assuan_realloc)
200 #define _assuan_calloc _ASSUAN_PREFIX(_assuan_calloc)
201 #define _assuan_free _ASSUAN_PREFIX(_assuan_free)
202 #define _assuan_log_print_buffer _ASSUAN_PREFIX(_assuan_log_print_buffer)
203 #define _assuan_log_sanitized_string \
204   _ASSUAN_PREFIX(_assuan_log_sanitized_string)
205 #define _assuan_log_printf _ASSUAN_PREFIX(_assuan_log_printf)
206 #define _assuan_set_default_log_stream \
207   _ASSUAN_PREFIX(_assuan_set_default_log_stream)
208 #define _assuan_w32_strerror _ASSUAN_PREFIX(_assuan_w32_strerror)
209 #define _assuan_gpg_strerror_r _ASSUAN_PREFIX(_assuan_gpg_strerror_r)
210 #define _assuan_gpg_strsource  _ASSUAN_PREFIX(_assuan_gpg_strsource)
211 #define _assuan_write_line _ASSUAN_PREFIX(_assuan_write_line)
212 #define _assuan_error _ASSUAN_PREFIX(_assuan_error)
213 #define _assuan_error_is_eagain   _ASSUAN_PREFIX(_assuan_error_is_eagain)
214 #define _assuan_init_uds_io _ASSUAN_PREFIX(_assuan_init_uds_io)
215 #define _assuan_uds_close_fds _ASSUAN_PREFIX(_assuan_uds_close_fds)
216 #define _assuan_uds_deinit _ASSUAN_PREFIX(_assuan_uds_deinit)
217 #define _assuan_simple_recvmsg _ASSUAN_PREFIX(_assuan_simple_recvmsg)
218 #define _assuan_simple_sendmsg _ASSUAN_PREFIX(_assuan_simple_sendmsg)
219 #define _assuan_waitpid _ASSUAN_PREFIX(_assuan_waitpid)
220 #define _assuan_sock_wsa2errno   _ASSUAN_PREFIX(_assuan_sock_wsa2errno)
221 #define _assuan_sock_close       _ASSUAN_PREFIX(_assuan_sock_close)      
222 #define _assuan_sock_new         _ASSUAN_PREFIX(_assuan_sock_new)        
223 #define _assuan_sock_connect     _ASSUAN_PREFIX(_assuan_sock_connect)    
224 #define _assuan_sock_bind        _ASSUAN_PREFIX(_assuan_sock_bind)       
225 #define _assuan_sock_get_nonce   _ASSUAN_PREFIX(_assuan_sock_get_nonce)
226 #define _assuan_sock_check_nonce _ASSUAN_PREFIX(_assuan_sock_check_nonce)
227
228 #endif /*_ASSUAN_EXT_SYM_PREFIX*/
229
230
231 #ifdef __cplusplus
232 extern "C"
233 {
234 #if 0
235 }
236 #endif
237 #endif
238
239
240 /* Check for compiler features.  */
241 #if __GNUC__
242 #define _ASSUAN_GCC_VERSION (__GNUC__ * 10000 \
243                             + __GNUC_MINOR__ * 100 \
244                             + __GNUC_PATCHLEVEL__)
245
246 #if _ASSUAN_GCC_VERSION > 30100
247 #define _ASSUAN_DEPRECATED  __attribute__ ((__deprecated__))
248 #endif
249 #endif
250 #ifndef _ASSUAN_DEPRECATED
251 #define _ASSUAN_DEPRECATED
252 #endif
253
254
255 /* Assuan error codes.  These are only used by old applications or
256    those applications which won't make use of libgpg-error. */
257 #ifndef _ASSUAN_ONLY_GPG_ERRORS
258 #ifndef _ASSUAN_IN_LIBASSUAN
259 #define  ASSUAN_No_Error 0
260 #endif
261 #define  ASSUAN_General_Error 1
262 #define  ASSUAN_Out_Of_Core 2
263 #define  ASSUAN_Invalid_Value 3
264 #ifndef _ASSUAN_IN_LIBASSUAN
265 #define  ASSUAN_Timeout 4
266 #endif
267 #define  ASSUAN_Read_Error 5
268 #define  ASSUAN_Write_Error 6
269 #define  ASSUAN_Problem_Starting_Server 7
270 #define  ASSUAN_Not_A_Server 8
271 #ifndef _ASSUAN_IN_LIBASSUAN
272 #define  ASSUAN_Not_A_Client 9
273 #endif
274 #define  ASSUAN_Nested_Commands 10
275 #define  ASSUAN_Invalid_Response 11
276 #define  ASSUAN_No_Data_Callback 12
277 #define  ASSUAN_No_Inquire_Callback 13
278 #define  ASSUAN_Connect_Failed 14
279 #define  ASSUAN_Accept_Failed 15
280
281   /* Error codes above 99 are meant as status codes */
282 #define  ASSUAN_Not_Implemented 100
283 #define  ASSUAN_Server_Fault    101
284 #ifndef _ASSUAN_IN_LIBASSUAN
285 #define  ASSUAN_Invalid_Command 102
286 #endif
287 #define  ASSUAN_Unknown_Command 103
288 #define  ASSUAN_Syntax_Error    104
289 #ifndef _ASSUAN_IN_LIBASSUAN
290 #define  ASSUAN_Parameter_Error 105
291 #endif
292 #define  ASSUAN_Parameter_Conflict 106
293 #define  ASSUAN_Line_Too_Long 107
294 #define  ASSUAN_Line_Not_Terminated 108
295 #ifndef _ASSUAN_IN_LIBASSUAN
296 #define  ASSUAN_No_Input 109
297 #define  ASSUAN_No_Output 110
298 #endif
299 #define  ASSUAN_Canceled 111
300 #ifndef _ASSUAN_IN_LIBASSUAN
301 #define  ASSUAN_Unsupported_Algorithm 112
302 #define  ASSUAN_Server_Resource_Problem 113
303 #define  ASSUAN_Server_IO_Error 114
304 #define  ASSUAN_Server_Bug 115
305 #define  ASSUAN_No_Data_Available 116
306 #define  ASSUAN_Invalid_Data 117
307 #endif
308 #define  ASSUAN_Unexpected_Command 118
309 #define  ASSUAN_Too_Much_Data 119
310 #ifndef _ASSUAN_IN_LIBASSUAN
311 #define  ASSUAN_Inquire_Unknown 120
312 #define  ASSUAN_Inquire_Error 121
313 #define  ASSUAN_Invalid_Option 122
314 #define  ASSUAN_Invalid_Index 123
315 #define  ASSUAN_Unexpected_Status 124
316 #define  ASSUAN_Unexpected_Data 125
317 #define  ASSUAN_Invalid_Status 126
318 #define  ASSUAN_Locale_Problem 127
319 #endif
320 #define  ASSUAN_Not_Confirmed 128
321
322   /* Warning: Don't use the Error codes, below they are deprecated. */
323 #ifndef _ASSUAN_IN_LIBASSUAN
324 #define  ASSUAN_Bad_Certificate 201
325 #define  ASSUAN_Bad_Certificate_Chain 202
326 #define  ASSUAN_Missing_Certificate 203
327 #define  ASSUAN_Bad_Signature 204
328 #define  ASSUAN_No_Agent 205
329 #define  ASSUAN_Agent_Error 206
330 #define  ASSUAN_No_Public_Key 207
331 #define  ASSUAN_No_Secret_Key 208
332 #define  ASSUAN_Invalid_Name 209
333
334 #define  ASSUAN_Cert_Revoked 301
335 #define  ASSUAN_No_CRL_For_Cert 302
336 #define  ASSUAN_CRL_Too_Old 303
337 #define  ASSUAN_Not_Trusted 304
338
339 #define  ASSUAN_Card_Error 401
340 #define  ASSUAN_Invalid_Card 402
341 #define  ASSUAN_No_PKCS15_App 403
342 #define  ASSUAN_Card_Not_Present 404
343 #define  ASSUAN_Invalid_Id 405
344
345   /* Error codes in the range 1000 to 9999 may be used by applications
346      at their own discretion. */
347 #define  ASSUAN_USER_ERROR_FIRST 1000
348 #define  ASSUAN_USER_ERROR_LAST 9999
349 #endif
350
351 typedef int assuan_error_t;
352
353 typedef assuan_error_t AssuanError _ASSUAN_DEPRECATED; 
354
355 /* This is a list of pre-registered ASSUAN commands */
356 /* Note, these command IDs are now deprectated and solely exists for
357    compatibility reasons. */
358 typedef enum
359 {
360   ASSUAN_CMD_NOP = 0,
361   ASSUAN_CMD_CANCEL,    /* cancel the current request */
362   ASSUAN_CMD_BYE,
363   ASSUAN_CMD_AUTH,
364   ASSUAN_CMD_RESET,
365   ASSUAN_CMD_OPTION,
366   ASSUAN_CMD_DATA,
367   ASSUAN_CMD_END,
368   ASSUAN_CMD_INPUT,
369   ASSUAN_CMD_OUTPUT,
370
371   ASSUAN_CMD_USER = 256  /* Other commands should be used with this offset*/
372 } AssuanCommand;
373
374
375 #else  /*!_ASSUAN_ONLY_GPG_ERRORS*/
376
377 /* Choose a type compatible with gpg_error_t.  */
378 typedef unsigned int assuan_error_t;
379
380 #endif /*!_ASSUAN_ONLY_GPG_ERRORS*/
381
382
383 /* Definitions of flags for assuan_set_flag(). */
384 typedef enum
385   {
386     /* When using a pipe server, by default Assuan will wait for the
387        forked process to die in assuan_disconnect.  In certain cases
388        this is not desirable.  By setting this flag, the waitpid will
389        be skipped and the caller is responsible to cleanup a forked
390        process. */
391     ASSUAN_NO_WAITPID = 1,
392     /* This flag indicates whether Assuan logging is in confidential
393        mode. Use assuan_{begin,end}_condidential to change the
394        mode.  */
395     ASSUAN_CONFIDENTIAL = 2
396   } 
397 assuan_flag_t;
398
399 #define ASSUAN_LINELENGTH 1002 /* 1000 + [CR,]LF */
400
401 struct assuan_context_s;
402 typedef struct assuan_context_s *assuan_context_t;
403 #ifndef _ASSUAN_ONLY_GPG_ERRORS
404 typedef struct assuan_context_s *ASSUAN_CONTEXT _ASSUAN_DEPRECATED;
405 #endif /*_ASSUAN_ONLY_GPG_ERRORS*/
406
407 /* Because we use system handles and not libc low level file
408    descriptors on W32, we need to declare them as HANDLE (which
409    actually is a plain pointer).  This is required to eventually
410    support 64 bit Windows systems.  */
411 #ifdef _WIN32
412 typedef void *assuan_fd_t;
413 #define ASSUAN_INVALID_FD ((void*)(-1))
414 #define ASSUAN_INT2FD(s)  ((void *)(s))
415 #define ASSUAN_FD2INT(h)  ((unsigned int)(h))
416 #else
417 typedef int assuan_fd_t;
418 #define ASSUAN_INVALID_FD (-1)
419 #define ASSUAN_INT2FD(s)  ((s))
420 #define ASSUAN_FD2INT(h)  ((h))
421 #endif
422
423
424 /* Assuan features an emulation of Unix domain sockets based on a
425    local TCP connections.  To implement access permissions based on
426    file permissions a nonce is used which is expected by th server as
427    the first bytes received.  This structure is used by the server to
428    save the nonce created initially by bind.  On POSIX systems this is
429    a dummy operation. */  
430 struct assuan_sock_nonce_s
431 {
432   size_t length;
433 #ifdef _WIN32
434   char nonce[16];
435 #endif
436 };
437 typedef struct assuan_sock_nonce_s assuan_sock_nonce_t;
438
439 /* Define the Unix domain socket structure for Windows.  */
440 #if defined(_WIN32) && !defined(_ASSUAN_NO_SOCKET_WRAPPER)
441 #ifndef AF_LOCAL
442 #define AF_LOCAL AF_UNIX
443 #endif
444 #define EADDRINUSE WSAEADDRINUSE
445 struct sockaddr_un
446 {
447   short          sun_family;
448   unsigned short sun_port;
449   struct         in_addr sun_addr;
450   char           sun_path[108-2-4]; 
451 };
452 #endif
453
454
455 /* Definition of hook functions used to conditionally replace the
456    default I/O functions. */
457 struct assuan_io_hooks
458 {
459   int (*read_hook)(assuan_context_t, assuan_fd_t, void *, size_t, ssize_t *);
460   int (*write_hook)(assuan_context_t, assuan_fd_t fd,
461                     const void *, size_t, ssize_t *);
462 };
463 typedef struct assuan_io_hooks *assuan_io_hooks_t;
464
465
466
467 /*-- assuan-handler.c --*/
468 int assuan_register_command (assuan_context_t ctx,
469                              const char *cmd_string,
470                              int (*handler)(assuan_context_t, char *));
471 int assuan_register_post_cmd_notify (assuan_context_t ctx,
472                                      void (*fnc)(assuan_context_t, int));
473 int assuan_register_bye_notify (assuan_context_t ctx,
474                                 void (*fnc)(assuan_context_t));
475 int assuan_register_reset_notify (assuan_context_t ctx,
476                                   void (*fnc)(assuan_context_t));
477 int assuan_register_cancel_notify (assuan_context_t ctx,
478                                    void (*fnc)(assuan_context_t));
479 int assuan_register_input_notify (assuan_context_t ctx,
480                                   void (*fnc)(assuan_context_t, const char *));
481 int assuan_register_output_notify (assuan_context_t ctx,
482                                   void (*fnc)(assuan_context_t, const char *));
483
484 int assuan_register_option_handler (assuan_context_t ctx,
485                                     int (*fnc)(assuan_context_t,
486                                                const char*, const char*));
487
488 int assuan_process (assuan_context_t ctx);
489 int assuan_process_next (assuan_context_t ctx);
490 int assuan_process_done (assuan_context_t ctx, int rc);
491 int assuan_get_active_fds (assuan_context_t ctx, int what,
492                            assuan_fd_t *fdarray, int fdarraysize);
493
494
495 FILE *assuan_get_data_fp (assuan_context_t ctx);
496 assuan_error_t assuan_set_okay_line (assuan_context_t ctx, const char *line);
497 assuan_error_t assuan_write_status (assuan_context_t ctx,
498                                     const char *keyword, const char *text);
499
500 /* Negotiate a file descriptor.  If LINE contains "FD=N", returns N
501    assuming a local file descriptor.  If LINE contains "FD" reads a
502    file descriptor via CTX and stores it in *RDF (the CTX must be
503    capable of passing file descriptors).  Under W32 the returned FD is
504    a libc-type one.  */
505 assuan_error_t assuan_command_parse_fd (assuan_context_t ctx, char *line,
506                                         assuan_fd_t *rfd);
507
508
509 /*-- assuan-listen.c --*/
510 assuan_error_t assuan_set_hello_line (assuan_context_t ctx, const char *line);
511 assuan_error_t assuan_accept (assuan_context_t ctx);
512 assuan_fd_t assuan_get_input_fd (assuan_context_t ctx);
513 assuan_fd_t assuan_get_output_fd (assuan_context_t ctx);
514 assuan_error_t assuan_close_input_fd (assuan_context_t ctx);
515 assuan_error_t assuan_close_output_fd (assuan_context_t ctx);
516
517
518 /*-- assuan-pipe-server.c --*/
519 int assuan_init_pipe_server (assuan_context_t *r_ctx, int filedes[2]);
520 void assuan_deinit_server (assuan_context_t ctx);
521
522 /*-- assuan-socket-server.c --*/
523 int assuan_init_socket_server (assuan_context_t *r_ctx, assuan_fd_t listen_fd);
524 int assuan_init_connected_socket_server (assuan_context_t *r_ctx, 
525                                          assuan_fd_t fd) _ASSUAN_DEPRECATED;
526 int assuan_init_socket_server_ext (assuan_context_t *r_ctx, assuan_fd_t fd,
527                                    unsigned int flags);
528 void assuan_set_sock_nonce (assuan_context_t ctx, assuan_sock_nonce_t *nonce);
529
530 /*-- assuan-pipe-connect.c --*/
531 assuan_error_t assuan_pipe_connect (assuan_context_t *ctx,
532                                     const char *name,
533                                     const char *const argv[],
534                                     int *fd_child_list);
535 assuan_error_t assuan_pipe_connect2 (assuan_context_t *ctx,
536                                      const char *name,
537                                      const char *const argv[],
538                                      int *fd_child_list,
539                                      void (*atfork) (void*, int),
540                                      void *atforkvalue) _ASSUAN_DEPRECATED;
541 assuan_error_t assuan_pipe_connect_ext (assuan_context_t *ctx, 
542                                         const char *name,
543                                         const char *const argv[],
544                                         int *fd_child_list,
545                                         void (*atfork) (void *, int),
546                                         void *atforkvalue,
547                                         unsigned int flags);
548
549 /*-- assuan-socket-connect.c --*/
550 assuan_error_t assuan_socket_connect (assuan_context_t *ctx, 
551                                       const char *name,
552                                       pid_t server_pid);
553 assuan_error_t assuan_socket_connect_ext (assuan_context_t *ctx,
554                                           const char *name,
555                                           pid_t server_pid,
556                                           unsigned int flags);
557
558 /*-- assuan-connect.c --*/
559 void assuan_disconnect (assuan_context_t ctx);
560 pid_t assuan_get_pid (assuan_context_t ctx);
561 #ifndef _WIN32
562 assuan_error_t assuan_get_peercred (assuan_context_t ctx,
563                                     pid_t *pid, uid_t *uid, gid_t *gid);
564 #endif
565
566 /*-- assuan-client.c --*/
567 assuan_error_t 
568 assuan_transact (assuan_context_t ctx,
569                  const char *command,
570                  assuan_error_t (*data_cb)(void *, const void *, size_t),
571                  void *data_cb_arg,
572                  assuan_error_t (*inquire_cb)(void*, const char *),
573                  void *inquire_cb_arg,
574                  assuan_error_t (*status_cb)(void*, const char *),
575                  void *status_cb_arg);
576
577
578 /*-- assuan-inquire.c --*/
579 assuan_error_t assuan_inquire (assuan_context_t ctx, const char *keyword,
580                                unsigned char **r_buffer, size_t *r_length,
581                                size_t maxlen);
582 assuan_error_t assuan_inquire_ext (assuan_context_t ctx, const char *keyword,
583                                    size_t maxlen,
584                                    int (*cb) (void *cb_data, int rc,
585                                               unsigned char *buf,
586                                               size_t buf_len),
587                                    void *cb_data);
588 /*-- assuan-buffer.c --*/
589 assuan_error_t assuan_read_line (assuan_context_t ctx,
590                               char **line, size_t *linelen);
591 int assuan_pending_line (assuan_context_t ctx);
592 assuan_error_t assuan_write_line (assuan_context_t ctx, const char *line );
593 assuan_error_t assuan_send_data (assuan_context_t ctx,
594                               const void *buffer, size_t length);
595
596 /* The file descriptor must be pending before assuan_receivefd is
597    called.  This means that assuan_sendfd should be called *before* the
598    trigger is sent (normally via assuan_write_line ("INPUT FD")).  */
599 assuan_error_t assuan_sendfd (assuan_context_t ctx, assuan_fd_t fd);
600 assuan_error_t assuan_receivefd (assuan_context_t ctx, assuan_fd_t *fd);
601
602
603 /*-- assuan-util.c --*/
604 void assuan_set_malloc_hooks ( void *(*new_alloc_func)(size_t n),
605                                void *(*new_realloc_func)(void *p, size_t n),
606                                void (*new_free_func)(void*) );
607 void assuan_set_io_hooks (assuan_io_hooks_t io_hooks);
608 void assuan_set_log_stream (assuan_context_t ctx, FILE *fp);
609 int assuan_set_error (assuan_context_t ctx, int err, const char *text);
610 void assuan_set_pointer (assuan_context_t ctx, void *pointer);
611 void *assuan_get_pointer (assuan_context_t ctx);
612
613 void assuan_begin_confidential (assuan_context_t ctx);
614 void assuan_end_confidential (assuan_context_t ctx);
615
616 void assuan_set_io_monitor (assuan_context_t ctx,
617                             unsigned int (*monitor)(assuan_context_t ctx,
618                                                     int direction,
619                                                     const char *line,
620                                                     size_t linelen));
621
622 /* For context CTX, set the flag FLAG to VALUE.  Values for flags
623    are usually 1 or 0 but certain flags might allow for other values;
624    see the description of the type assuan_flag_t for details. */
625 void assuan_set_flag (assuan_context_t ctx, assuan_flag_t flag, int value);
626
627 /* Return the VALUE of FLAG in context CTX. */ 
628 int  assuan_get_flag (assuan_context_t ctx, assuan_flag_t flag);
629
630
631 /*-- assuan-errors.c --*/
632
633 #ifndef _ASSUAN_ONLY_GPG_ERRORS
634 /* Return a string describing the assuan error.  The use of this
635    function is deprecated; it is better to call
636    assuan_set_assuan_err_source once and then make use libgpg-error. */
637 const char *assuan_strerror (assuan_error_t err);
638 #endif /*_ASSUAN_ONLY_GPG_ERRORS*/
639
640 /* Enable gpg-error style error codes.  ERRSOURCE is one of gpg-error
641    sources.  Note, that this function is not thread-safe and should be
642    used right at startup. Switching back to the old style mode is not
643    supported. */
644 void assuan_set_assuan_err_source (int errsource);
645
646 /*-- assuan-logging.c --*/
647
648 /* Set the stream to which assuan should log message not associated
649    with a context.  By default, this is stderr.  The default value
650    will be changed when the first log stream is associated with a
651    context.  Note, that this function is not thread-safe and should
652    in general be used right at startup. */
653 extern void assuan_set_assuan_log_stream (FILE *fp);
654
655 /* Return the stream which is currently being using for global logging.  */
656 extern FILE *assuan_get_assuan_log_stream (void);
657
658 /* Set the prefix to be used at the start of a line emitted by assuan
659    on the log stream.  The default is the empty string.  Note, that
660    this function is not thread-safe and should in general be used
661    right at startup. */
662 void assuan_set_assuan_log_prefix (const char *text);
663
664 /* Return a prefix to be used at the start of a line emitted by assuan
665    on the log stream.  The default implementation returns the empty
666    string, i.e. ""  */
667 const char *assuan_get_assuan_log_prefix (void);
668
669
670 /*-- assuan-socket.c --*/
671
672 /* These are socket wrapper functions to support an emulation of Unix
673    domain sockets on Windows W32.  */
674 int assuan_sock_close (assuan_fd_t fd);
675 assuan_fd_t assuan_sock_new (int domain, int type, int proto);
676 int assuan_sock_connect (assuan_fd_t sockfd, 
677                          struct sockaddr *addr, int addrlen);
678 int assuan_sock_bind (assuan_fd_t sockfd, struct sockaddr *addr, int addrlen);
679 int assuan_sock_get_nonce (struct sockaddr *addr, int addrlen, 
680                            assuan_sock_nonce_t *nonce);
681 int assuan_sock_check_nonce (assuan_fd_t fd, assuan_sock_nonce_t *nonce);
682
683
684 #ifdef __cplusplus
685 }
686 #endif
687 #endif /* ASSUAN_H */