* configure.ac: Look for res_query so we can use DNS SRV, and add
[gnupg.git] / assuan / assuan-util.c
1 /* assuan-util.c - Utility functions for Assuan 
2  *      Copyright (C) 2001, 2002 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA 
19  */
20
21 #include <config.h>
22 #include <stdlib.h>
23 #include <stdio.h>
24 #include <string.h>
25 #include <ctype.h>
26
27 #include "assuan-defs.h"
28
29 #ifdef HAVE_JNLIB_LOGGING
30 #include "../jnlib/logging.h"
31 #endif
32
33 static void *(*alloc_func)(size_t n) = malloc;
34 static void *(*realloc_func)(void *p, size_t n) = realloc;
35 static void (*free_func)(void*) = free;
36
37 void
38 assuan_set_malloc_hooks ( void *(*new_alloc_func)(size_t n),
39                           void *(*new_realloc_func)(void *p, size_t n),
40                           void (*new_free_func)(void*) )
41 {
42   alloc_func        = new_alloc_func;
43   realloc_func      = new_realloc_func;
44   free_func         = new_free_func;
45 }
46
47 void *
48 _assuan_malloc (size_t n)
49 {
50   return alloc_func (n);
51 }
52
53 void *
54 _assuan_realloc (void *a, size_t n)
55 {
56   return realloc_func (a, n);
57 }
58
59 void *
60 _assuan_calloc (size_t n, size_t m)
61 {
62   void *p = _assuan_malloc (n*m);
63   if (p)
64     memset (p, 0, n* m);
65   return p;
66 }
67
68 void
69 _assuan_free (void *p)
70 {
71   if (p)
72     free_func (p);
73 }
74
75 \f
76 /* Store the error in the context so that the error sending function
77   can take out a descriptive text.  Inside the assuan code, use the
78   macro set_error instead of this function. */
79 int
80 assuan_set_error (ASSUAN_CONTEXT ctx, int err, const char *text)
81 {
82   ctx->err_no = err;
83   ctx->err_str = text;
84   return err;
85 }
86
87 void
88 assuan_set_pointer (ASSUAN_CONTEXT ctx, void *pointer)
89 {
90   if (ctx)
91     ctx->user_pointer = pointer;
92 }
93
94 void *
95 assuan_get_pointer (ASSUAN_CONTEXT ctx)
96 {
97   return ctx? ctx->user_pointer : NULL;
98 }
99
100
101 void
102 assuan_set_log_stream (ASSUAN_CONTEXT ctx, FILE *fp)
103 {
104   if (ctx)
105     {
106       if (ctx->log_fp)
107         fflush (ctx->log_fp);
108       ctx->log_fp = fp;
109     }
110 }
111
112
113 void
114 assuan_begin_confidential (ASSUAN_CONTEXT ctx)
115 {
116   if (ctx)
117     {
118       ctx->confidential = 1;
119     }
120 }
121
122 void
123 assuan_end_confidential (ASSUAN_CONTEXT ctx)
124 {
125   if (ctx)
126     {
127       ctx->confidential = 0;
128     }
129 }
130
131 /* Dump a possibly binary string (used for debugging).  Distinguish
132    ascii text from binary and print it accordingly.  */
133 void
134 _assuan_log_print_buffer (FILE *fp, const void *buffer, size_t length)
135 {
136   const unsigned char *s;
137   int n;
138
139   for (n=length,s=buffer; n; n--, s++)
140     if  (!isascii (*s) || iscntrl (*s) || !isprint (*s))
141       break;
142
143   s = buffer;
144   if (!n && *s != '[')
145     fwrite (buffer, length, 1, fp);
146   else
147     {
148 #ifdef HAVE_FLOCKFILE
149       flockfile (fp);
150 #endif
151       putc_unlocked ('[', fp);
152       for (n=0; n < length; n++, s++)
153           fprintf (fp, " %02x", *s);
154       putc_unlocked (' ', fp);
155       putc_unlocked (']', fp);
156 #ifdef HAVE_FUNLOCKFILE
157       funlockfile (fp);
158 #endif
159     }
160 }
161
162
163 /* Log a user supplied string.  Escapes non-printable before
164    printing.  */
165 void
166 _assuan_log_sanitized_string (const char *string)
167 {
168   const unsigned char *s = string;
169 #ifdef HAVE_JNLIB_LOGGING
170   FILE *fp = log_get_stream ();
171 #else
172   FILE *fp = stderr;
173 #endif
174
175   if (! *s)
176     return;
177
178 #ifdef HAVE_FLOCKFILE
179   flockfile (fp);
180 #endif
181
182   for (; *s; s++)
183     {
184       int c = 0;
185
186       switch (*s)
187         {
188         case '\r':
189           c = 'r';
190           break;
191
192         case '\n':
193           c = 'n';
194           break;
195
196         case '\f':
197           c = 'f';
198           break;
199
200         case '\v':
201           c = 'v';
202           break;
203
204         case '\b':
205           c = 'b';
206           break;
207
208         default:
209           if (isascii (*s) && isprint (*s))
210             putc_unlocked (*s, fp);
211           else
212             {
213               putc_unlocked ('\\', fp);
214               fprintf (fp, "x%02x", *s);
215             }
216         }
217
218       if (c)
219         {
220           putc_unlocked ('\\', fp);
221           putc_unlocked (c, fp);
222         }
223     }
224
225 #ifdef HAVE_FUNLOCKFILE
226   funlockfile (fp);
227 #endif
228 }
229
230