b1d9f3ef01f49ee6cc8e868f2a03a31743821dbd
[gpgme.git] / assuan / assuan-defs.h
1 /* assuan-defs.c - Internal definitions to Assuan
2  *      Copyright (C) 2001, 2002, 2004, 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_DEFS_H
23 #define ASSUAN_DEFS_H
24
25 #include <sys/types.h>
26 #ifndef HAVE_W32_SYSTEM
27 #include <sys/socket.h>
28 #include <sys/un.h>
29 #else
30 #include <windows.h>
31 #endif
32 #include <unistd.h>
33
34 #include "assuan.h"
35
36 #ifndef HAVE_W32_SYSTEM
37 #define DIRSEP_C '/'
38 #else
39 #define DIRSEP_C '\\'
40 #endif
41
42 #ifdef HAVE_W32_SYSTEM
43 #define AF_LOCAL AF_UNIX
44 /* We need to prefix the structure with a sockaddr_in header so we can
45    use it later for sendto and recvfrom. */
46 struct sockaddr_un
47 {
48   short          sun_family;
49   unsigned short sun_port;
50   struct         in_addr sun_addr;
51   char           sun_path[108-2-4]; /* Path name.  */
52 };
53
54 /* Not needed anymore because the current mingw32 defines this in
55    sys/types.h */
56 /* typedef int ssize_t; */
57
58 /* Missing W32 functions */
59 int putc_unlocked (int c, FILE *stream);
60 void * memrchr (const void *block, int c, size_t size);
61 char * stpcpy (char *dest, const char *src);
62 #endif
63
64 #define LINELENGTH ASSUAN_LINELENGTH
65
66
67 struct cmdtbl_s
68 {
69   const char *name;
70   int (*handler)(assuan_context_t, char *line);
71 };
72
73
74 /* A structure to dispatch I/O functions.  All these functions need to
75    return 0 on success and set ERRNO on failure.  */
76 struct assuan_io
77 {
78   /* Routine to read from input_fd.  */
79   ssize_t (*readfnc) (assuan_context_t, void *, size_t);
80   /* Routine to write to output_fd.  */
81   ssize_t (*writefnc) (assuan_context_t, const void *, size_t);
82   /* Send a file descriptor.  */
83   assuan_error_t (*sendfd) (assuan_context_t, int);
84   /* Receive a file descriptor.  */
85   assuan_error_t (*receivefd) (assuan_context_t, int *);
86 };
87
88
89 /* The context we use with most functions. */
90 struct assuan_context_s
91 {
92   assuan_error_t err_no;
93   const char *err_str;
94   int os_errno;       /* Last system error number used with certain
95                          error codes. */
96
97   /* Context specific flags (cf. assuan_flag_t). */
98   struct
99   {
100     unsigned int no_waitpid:1; /* See ASSUAN_NO_WAITPID. */
101   } flags;
102
103   int confidential;
104   int is_server;      /* Set if this is context belongs to a server */
105   int in_inquire;
106   char *hello_line;
107   char *okay_line;    /* See assuan_set_okay_line() */
108
109   void *user_pointer;  /* For assuan_get_pointer and assuan_set_pointer (). */
110
111   FILE *log_fp;
112
113   struct {
114     int fd;
115     int eof;
116     char line[LINELENGTH];
117     int linelen;  /* w/o CR, LF - might not be the same as
118                      strlen(line) due to embedded nuls. However a nul
119                      is always written at this pos. */
120     struct {
121       char line[LINELENGTH];
122       int linelen ;
123       int pending; /* i.e. at least one line is available in the attic */
124     } attic;
125   } inbound;
126
127   struct {
128     int fd;
129     struct {
130       FILE *fp;
131       char line[LINELENGTH];
132       int linelen;
133       int error;
134     } data;
135   } outbound;
136
137   int pipe_mode;  /* We are in pipe mode, i.e. we can handle just one
138                      connection and must terminate then. */
139   pid_t pid;      /* The pid of the peer. */
140   int listen_fd;  /* The fd we are listening on (used by socket servers) */
141   int connected_fd; /* helper */
142
143   struct {
144     int valid;   /* Whether this structure has valid information. */
145 #ifdef HAVE_SO_PEERCRED
146     pid_t pid;     /* The pid of the peer. */
147     uid_t uid;     /* The uid of the peer. */
148     gid_t gid;     /* The gid of the peer. */
149 #endif /* HAVE_SO_PEERCRED */
150   } peercred;
151
152   /* Used for Unix domain sockets.  */
153   struct sockaddr_un myaddr;
154   struct sockaddr_un serveraddr;
155
156   /* Structure used for unix domain socket buffering.  FIXME: We don't
157      use datagrams anymore thus we could get away with a simpler
158      buffering approach. */
159   struct {
160     void *buffer;         /* Malloced buffer. */
161     int bufferallocated;  /* Memory allocated.  */
162     int bufferoffset;     /* Offset of start of buffer.  */
163     int buffersize;       /* Bytes buffered.  */
164     
165     int pendingfds[5];    /* Array to save received descriptors.  */
166     int pendingfdscount;  /* Number of received descriptors. */
167   } uds;
168
169   void (*deinit_handler)(assuan_context_t);
170   int (*accept_handler)(assuan_context_t);
171   int (*finish_handler)(assuan_context_t);
172
173   struct cmdtbl_s *cmdtbl;
174   size_t cmdtbl_used; /* used entries */
175   size_t cmdtbl_size; /* allocated size of table */
176
177   void (*bye_notify_fnc)(assuan_context_t);
178   void (*reset_notify_fnc)(assuan_context_t);
179   void (*cancel_notify_fnc)(assuan_context_t);
180   int  (*option_handler_fnc)(assuan_context_t,const char*, const char*);
181   void (*input_notify_fnc)(assuan_context_t, const char *);
182   void (*output_notify_fnc)(assuan_context_t, const char *);
183
184   /* This function is called right after a command has been processed.
185      It may be used to command related cleanup.  */
186   void (*post_cmd_notify_fnc)(assuan_context_t, int);
187
188   /* If set, this is called right before logging an I/O line.  With
189      DIRECTION set to 1 it is called for an output oeration; 0 means
190      an input operation. If bit 0 is set in the return value, the
191      logging of the will be suppressed.  With bit 1 set, the entire
192      line will be ignored. */
193   unsigned int (*io_monitor)(assuan_context_t ctx,
194                              int direction,
195                              const char *line,
196                              size_t linelen);
197
198   int input_fd;   /* set by INPUT command */
199   int output_fd;  /* set by OUTPUT command */
200
201   /* io routines.  */
202   struct assuan_io *io;
203 };
204
205 /*-- assuan-pipe-server.c --*/
206 int _assuan_new_context (assuan_context_t *r_ctx);
207 void _assuan_release_context (assuan_context_t ctx);
208
209 /*-- assuan-uds.c --*/
210 void _assuan_uds_close_fds (assuan_context_t ctx);
211 void _assuan_uds_deinit (assuan_context_t ctx);
212 void _assuan_init_uds_io (assuan_context_t ctx);
213
214
215 /*-- assuan-handler.c --*/
216 int _assuan_register_std_commands (assuan_context_t ctx);
217
218 /*-- assuan-buffer.c --*/
219 assuan_error_t _assuan_read_line (assuan_context_t ctx);
220 int _assuan_cookie_write_data (void *cookie, const char *buffer, size_t size);
221 int _assuan_cookie_write_flush (void *cookie);
222 assuan_error_t _assuan_write_line (assuan_context_t ctx, const char *prefix,
223                                    const char *line, size_t len);
224
225 /*-- assuan-client.c --*/
226 assuan_error_t _assuan_read_from_server (assuan_context_t ctx,
227                                          int *okay, int *off);
228
229 /*-- assuan-error.c --*/
230
231
232 /* Map error codes as used in this implementaion to the libgpg-error
233    codes. */
234 assuan_error_t _assuan_error (int oldcode);
235
236 /* Extrac the erro code from A.  This works for both the old and the
237    new style error codes. This needs to be whenever an error code is
238    compared. */
239 #define err_code(a) ((a) & 0x00ffffff)
240
241 /* Check whether A is the erro code for EOF.  We allow forold and new
242    style EOF error codes here.  */
243 #define err_is_eof(a) ((a) == (-1) || err_code (a) == 16383)
244
245
246
247 /*-- assuan-util.c --*/
248 void *_assuan_malloc (size_t n);
249 void *_assuan_calloc (size_t n, size_t m);
250 void *_assuan_realloc (void *p, size_t n);
251 void  _assuan_free (void *p);
252
253 #define xtrymalloc(a)    _assuan_malloc ((a))
254 #define xtrycalloc(a,b)  _assuan_calloc ((a),(b))
255 #define xtryrealloc(a,b) _assuan_realloc((a),(b))
256 #define xfree(a)         _assuan_free ((a))
257
258 #define set_error(c,e,t) \
259         assuan_set_error ((c), _assuan_error (ASSUAN_ ## e), (t))
260
261 #ifdef HAVE_W32_SYSTEM
262 const char *_assuan_w32_strerror (int ec);
263 #define w32_strerror(e) _assuan_w32_strerror ((e))
264 int _assuan_gpg_strerror_r (unsigned int err, char *buf, size_t buflen);
265 const char *_assuan_gpg_strsource (unsigned int err);
266 #endif /*HAVE_W32_SYSTEM*/
267
268
269 /*-- assuan-logging.c --*/
270 void _assuan_set_default_log_stream (FILE *fp);
271
272 void _assuan_log_printf (const char *format, ...)
273 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
274  __attribute__ ((format (printf,1,2)))
275 #endif
276      ;
277 void _assuan_log_print_buffer (FILE *fp, const void *buffer, size_t  length);
278 void _assuan_log_sanitized_string (const char *string);
279
280
281 /*-- assuan-io.c --*/
282 pid_t _assuan_waitpid (pid_t pid, int *status, int options);
283
284 ssize_t _assuan_simple_read (assuan_context_t ctx, void *buffer, size_t size);
285 ssize_t _assuan_simple_write (assuan_context_t ctx, const void *buffer,
286                               size_t size);
287 #ifdef HAVE_W32_SYSTEM
288 int _assuan_simple_sendmsg (assuan_context_t ctx, void *msg);
289 int _assuan_simple_recvmsg (assuan_context_t ctx, void *msg);
290 #else
291 ssize_t _assuan_simple_sendmsg (assuan_context_t ctx, struct msghdr *msg);
292 ssize_t _assuan_simple_recvmsg (assuan_context_t ctx, struct msghdr *msg);
293 #endif
294
295 /*-- assuan-socket.c --*/
296 int _assuan_close (int fd);
297 int _assuan_sock_new (int domain, int type, int proto);
298 int _assuan_sock_bind (int sockfd, struct sockaddr *addr, int addrlen);
299 int _assuan_sock_connect (int sockfd, struct sockaddr *addr, int addrlen);
300
301 #ifdef HAVE_FOPENCOOKIE
302 /* We have to implement funopen in terms of glibc's fopencookie. */
303 FILE *_assuan_funopen(void *cookie,
304                       cookie_read_function_t *readfn,
305                       cookie_write_function_t *writefn,
306                       cookie_seek_function_t *seekfn,
307                       cookie_close_function_t *closefn);
308 #define funopen(a,r,w,s,c) _assuan_funopen ((a), (r), (w), (s), (c))
309 #endif /*HAVE_FOPENCOOKIE*/
310
311 /* Prototypes for replacement functions.  */
312 #ifndef HAVE_MEMRCHR
313 void *memrchr (const void *block, int c, size_t size);
314 #endif
315 #ifndef HAVE_STPCPY
316 char *stpcpy (char *dest, const char *src);
317 #endif
318 #ifndef HAVE_SETENV
319 #define setenv _assuan_setenv
320 #define unsetenv _assuan_unsetenv
321 #define clearenv _assuan_clearenv
322 int setenv (const char *name, const char *value, int replace);
323 #endif
324 #ifndef HAVE_PUTC_UNLOCKED
325 int putc_unlocked (int c, FILE *stream);
326 #endif
327
328 #define DIM(v)               (sizeof(v)/sizeof((v)[0]))
329 #define DIMof(type,member)   DIM(((type *)0)->member)
330
331
332 #endif /*ASSUAN_DEFS_H*/