dirmngr: Support https for KS_FETCH.
[gnupg.git] / common / init.c
1 /* init.c - Various initializations
2  *      Copyright (C) 2007 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * This file is free software; you can redistribute it and/or modify
7  * it under the terms of either
8  *
9  *   - the GNU Lesser General Public License as published by the Free
10  *     Software Foundation; either version 3 of the License, or (at
11  *     your option) any later version.
12  *
13  * or
14  *
15  *   - the GNU General Public License as published by the Free
16  *     Software Foundation; either version 2 of the License, or (at
17  *     your option) any later version.
18  *
19  * or both in parallel, as here.
20  *
21  * This file is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24  * GNU General Public License for more details.
25  *
26  * You should have received a copy of the GNU General Public License
27  * along with this program; if not, see <http://www.gnu.org/licenses/>.
28  */
29
30 #include <config.h>
31
32 #ifdef WITHOUT_NPTH /* Give the Makefile a chance to build without Pth.  */
33 #undef HAVE_NPTH
34 #undef USE_NPTH
35 #endif
36
37 #ifdef HAVE_W32_SYSTEM
38 # ifdef HAVE_WINSOCK2_H
39 #  include <winsock2.h>
40 # endif
41 # include <windows.h>
42 #endif
43 #ifdef HAVE_NPTH
44 # include <npth.h>
45 #endif
46 #ifdef HAVE_W32CE_SYSTEM
47 # include <assuan.h> /* For _assuan_w32ce_finish_pipe. */
48 #endif
49
50 #include "util.h"
51
52 /* This object is used to register memory cleanup functions.
53    Technically they are not needed but they can avoid frequent
54    questions about un-released memory.  Note that we use the system
55    malloc and not any wrappers.  */
56 struct mem_cleanup_item_s;
57 typedef struct mem_cleanup_item_s *mem_cleanup_item_t;
58
59 struct mem_cleanup_item_s
60 {
61   mem_cleanup_item_t next;
62   void (*func) (void);
63 };
64
65 static mem_cleanup_item_t mem_cleanup_list;
66
67
68 /* The default error source of the application.  This is different
69    from GPG_ERR_SOURCE_DEFAULT in that it does not depend on the
70    source file and thus is usable in code shared by applications.  */
71 gpg_err_source_t default_errsource;
72
73
74 #ifdef HAVE_W32CE_SYSTEM
75 static void parse_std_file_handles (int *argcp, char ***argvp);
76 static void
77 sleep_on_exit (void)
78 {
79   /* The sshd on CE swallows some of the command output.  Sleeping a
80      while usually helps.  */
81   Sleep (400);
82 }
83 #endif /*HAVE_W32CE_SYSTEM*/
84
85
86 static void
87 run_mem_cleanup (void)
88 {
89   mem_cleanup_item_t next;
90
91   while (mem_cleanup_list)
92     {
93       next = mem_cleanup_list->next;
94       mem_cleanup_list->func ();
95       free (mem_cleanup_list);
96       mem_cleanup_list = next;
97     }
98 }
99
100
101 void
102 register_mem_cleanup_func (void (*func)(void))
103 {
104   mem_cleanup_item_t item;
105
106   item = malloc (sizeof *item);
107   if (item)
108     {
109       item->func = func;
110       item->next = mem_cleanup_list;
111       mem_cleanup_list = item;
112     }
113 }
114
115
116 /* If STRING is not NULL write string to es_stdout or es_stderr.  MODE
117    must be 1 or 2.  If STRING is NULL flush the respective stream.  */
118 static int
119 writestring_via_estream (int mode, const char *string)
120 {
121   if (mode == 1 || mode == 2)
122     {
123       if (string)
124         return es_fputs (string, mode == 1? es_stdout : es_stderr);
125       else
126         return es_fflush (mode == 1? es_stdout : es_stderr);
127     }
128   else
129     return -1;
130 }
131
132
133 /* This function is to be used early at program startup to make sure
134    that some subsystems are initialized.  This is in particular
135    important for W32 to initialize the sockets so that our socket
136    emulation code used directly as well as in libassuan may be used.
137    It should best be called before any I/O is done so that setup
138    required for logging is ready.  ARGCP and ARGVP are the addresses
139    of the parameters given to main.  This function may modify them.
140
141    This function should be called only via the macro
142    init_common_subsystems.
143
144    CAUTION: This might be called while running suid(root).  */
145 void
146 _init_common_subsystems (gpg_err_source_t errsource, int *argcp, char ***argvp)
147 {
148   /* Store the error source in a gloabl variable. */
149   default_errsource = errsource;
150
151   atexit (run_mem_cleanup);
152
153   /* Try to auto set the character set.  */
154   set_native_charset (NULL);
155
156 #ifdef HAVE_W32_SYSTEM
157   /* For W32 we need to initialize the socket layer.  This is because
158      we use recv and send in libassuan as well as at some other
159      places.  */
160   {
161     WSADATA wsadat;
162
163     WSAStartup (0x202, &wsadat);
164   }
165 #endif
166
167 #ifdef HAVE_W32CE_SYSTEM
168   /* Register the sleep exit function before the estream init so that
169      the sleep will be called after the estream registered atexit
170      function which flushes the left open estream streams and in
171      particular es_stdout.  */
172   atexit (sleep_on_exit);
173 #endif
174
175   /* Initialize the Estream library. */
176   gpgrt_init ();
177   gpgrt_set_alloc_func (gcry_realloc);
178 #ifdef USE_NPTH
179   gpgrt_set_syscall_clamp (npth_unprotect, npth_protect);
180 #endif
181
182   /* Special hack for Windows CE: We extract some options from arg
183      to setup the standard handles.  */
184 #ifdef HAVE_W32CE_SYSTEM
185   parse_std_file_handles (argcp, argvp);
186 #else
187   (void)argcp;
188   (void)argvp;
189 #endif
190
191   /* Access the standard estreams as early as possible.  If we don't
192      do this the original stdio streams may have been closed when
193      _es_get_std_stream is first use and in turn it would connect to
194      the bit bucket.  */
195   {
196     int i;
197     for (i=0; i < 3; i++)
198       (void)_gpgrt_get_std_stream (i);
199   }
200
201   /* --version et al shall use estream as well.  */
202   argparse_register_outfnc (writestring_via_estream);
203 }
204
205
206
207 /* WindowsCE uses a very strange way of handling the standard streams.
208    There is a function SetStdioPath to associate a standard stream
209    with a file or a device but what we really want is to use pipes as
210    standard streams.  Despite that we implement pipes using a device,
211    we would have some limitations on the number of open pipes due to
212    the 3 character limit of device file name.  Thus we don't take this
213    path.  Another option would be to install a file system driver with
214    support for pipes; this would allow us to get rid of the device
215    name length limitation.  However, with GnuPG we can get away be
216    redefining the standard streams and passing the handles to be used
217    on the command line.  This has also the advantage that it makes
218    creating a process much easier and does not require the
219    SetStdioPath set and restore game.  The caller needs to pass the
220    rendezvous ids using up to three options:
221
222      -&S0=<rvid> -&S1=<rvid> -&S2=<rvid>
223
224    They are all optional but they must be the first arguments on the
225    command line.  Parsing stops as soon as an invalid option is found.
226    These rendezvous ids are then used to finish the pipe creation.*/
227 #ifdef HAVE_W32CE_SYSTEM
228 static void
229 parse_std_file_handles (int *argcp, char ***argvp)
230 {
231   int argc = *argcp;
232   char **argv = *argvp;
233   const char *s;
234   assuan_fd_t fd;
235   int i;
236   int fixup = 0;
237
238   if (!argc)
239     return;
240
241   for (argc--, argv++; argc; argc--, argv++)
242     {
243       s = *argv;
244       if (*s == '-' && s[1] == '&' && s[2] == 'S'
245           && (s[3] == '0' || s[3] == '1' || s[3] == '2')
246           && s[4] == '='
247           && (strchr ("-01234567890", s[5]) || !strcmp (s+5, "null")))
248         {
249           if (s[5] == 'n')
250             fd = ASSUAN_INVALID_FD;
251           else
252             fd = _assuan_w32ce_finish_pipe (atoi (s+5), s[3] != '0');
253           _es_set_std_fd (s[3] - '0', (int)fd);
254           fixup++;
255         }
256       else
257         break;
258     }
259
260   if (fixup)
261     {
262       argc = *argcp;
263       argc -= fixup;
264       *argcp = argc;
265
266       argv = *argvp;
267       for (i=1; i < argc; i++)
268         argv[i] = argv[i + fixup];
269       for (; i < argc + fixup; i++)
270         argv[i] = NULL;
271     }
272
273
274 }
275 #endif /*HAVE_W32CE_SYSTEM*/