5189f93b1c381a84288dd040ffe03e2d98ea3808
[gnupg.git] / dirmngr / dirmngr.h
1 /* dirmngr.h - Common definitions for the dirmngr
2  * Copyright (C) 2002 Klarälvdalens Datakonsult AB
3  * Copyright (C) 2004, 2015 g10 Code GmbH
4  * Copyright (C) 2014 Werner Koch
5  *
6  * This file is part of GnuPG.
7  *
8  * GnuPG is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * GnuPG is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, see <https://www.gnu.org/licenses/>.
20  *
21  * SPDX-License-Identifier: GPL-3.0+
22  */
23
24 #ifndef DIRMNGR_H
25 #define DIRMNGR_H
26
27 #include "./dirmngr-err.h"
28 #define map_assuan_err(a) \
29         map_assuan_err_with_source (GPG_ERR_SOURCE_DEFAULT, (a))
30 #include <errno.h>
31 #include <gcrypt.h>
32 #include <ksba.h>
33
34 #include "../common/util.h"
35 #include "../common/membuf.h"
36 #include "../common/sysutils.h" /* (gnupg_fd_t) */
37 #include "../common/asshelp.h"  /* (assuan_context_t) */
38 #include "../common/i18n.h"
39 #include "http.h"     /* (parsed_uri_t) */
40
41 /* This objects keeps information about a particular LDAP server and
42    is used as item of a single linked list of servers. */
43 struct ldap_server_s
44 {
45   struct ldap_server_s* next;
46
47   char *host;
48   int   port;
49   char *user;
50   char *pass;
51   char *base;
52 };
53 typedef struct ldap_server_s *ldap_server_t;
54
55
56 /* This objects is used to build a list of URI consisting of the
57    original and the parsed URI.  */
58 struct uri_item_s
59 {
60   struct uri_item_s *next;
61   parsed_uri_t parsed_uri;  /* The broken down URI.  */
62   char uri[1];              /* The original URI.  */
63 };
64 typedef struct uri_item_s *uri_item_t;
65
66
67 /* A list of fingerprints.  */
68 struct fingerprint_list_s;
69 typedef struct fingerprint_list_s *fingerprint_list_t;
70 struct fingerprint_list_s
71 {
72   fingerprint_list_t next;
73   char hexfpr[20+20+1];
74 };
75
76
77 /* A large struct named "opt" to keep global flags.  */
78 struct
79 {
80   unsigned int debug; /* debug flags (DBG_foo_VALUE) */
81   int verbose;        /* verbosity level */
82   int quiet;          /* be as quiet as possible */
83   int dry_run;        /* don't change any persistent data */
84   int batch;          /* batch mode */
85   const char *homedir_cache; /* Dir for cache files (/var/cache/dirmngr).  */
86
87   char *config_filename;     /* Name of a config file, which will be
88                                 reread on a HUP if it is not NULL. */
89
90   char *ldap_wrapper_program; /* Override value for the LDAP wrapper
91                                  program.  */
92   char *http_wrapper_program; /* Override value for the HTTP wrapper
93                                  program.  */
94
95   int running_detached; /* We are running in detached mode.  */
96   int allow_version_check; /* --allow-version-check is active.  */
97
98   int force;          /* Force loading outdated CRLs. */
99
100
101   unsigned int connect_timeout;       /* Timeout for connect.  */
102   unsigned int connect_quick_timeout; /* Shorter timeout for connect.  */
103
104   int disable_http;       /* Do not use HTTP at all.  */
105   int disable_ldap;       /* Do not use LDAP at all.  */
106   int disable_ipv4;       /* Do not use legacy IP addresses.  */
107   int disable_ipv6;       /* Do not use standard IP addresses.  */
108   int honor_http_proxy;   /* Honor the http_proxy env variable. */
109   const char *http_proxy; /* The default HTTP proxy.  */
110   const char *ldap_proxy; /* Use given LDAP proxy.  */
111   int only_ldap_proxy;    /* Only use the LDAP proxy; no fallback.  */
112   int ignore_http_dp;     /* Ignore HTTP CRL distribution points.  */
113   int ignore_ldap_dp;     /* Ignore LDAP CRL distribution points.  */
114   int ignore_ocsp_service_url; /* Ignore OCSP service URLs as given in
115                                   the certificate.  */
116
117   /* A list of certificate extension OIDs which are ignored so that
118      one can claim that a critical extension has been handled.  One
119      OID per string.  */
120   strlist_t ignored_cert_extensions;
121
122   int allow_ocsp;     /* Allow using OCSP. */
123
124   int max_replies;
125   unsigned int ldaptimeout;
126
127   ldap_server_t ldapservers;
128   int add_new_ldapservers;
129
130   const char *ocsp_responder;     /* Standard OCSP responder's URL. */
131   fingerprint_list_t ocsp_signer; /* The list of fingerprints with allowed
132                                      standard OCSP signer certificates.  */
133
134   unsigned int ocsp_max_clock_skew; /* Allowed seconds of clocks skew. */
135   unsigned int ocsp_max_period;     /* Seconds a response is at maximum
136                                        considered valid after thisUpdate. */
137   unsigned int ocsp_current_period; /* Seconds a response is considered
138                                        current after nextUpdate. */
139
140   strlist_t keyserver;              /* List of default keyservers.  */
141 } opt;
142
143
144 #define DBG_X509_VALUE    1     /* debug x.509 parsing */
145 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
146 #define DBG_DNS_VALUE     16    /* debug DNS calls.  */
147 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
148 #define DBG_CACHE_VALUE   64    /* debug the caching */
149 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
150 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
151 #define DBG_IPC_VALUE     1024  /* debug assuan communication */
152 #define DBG_NETWORK_VALUE 2048  /* debug network I/O.  */
153 #define DBG_LOOKUP_VALUE  8192  /* debug lookup details */
154 #define DBG_EXTPROG_VALUE 16384 /* debug external program calls */
155
156 #define DBG_X509    (opt.debug & DBG_X509_VALUE)
157 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
158 #define DBG_DNS     (opt.debug & DBG_DNS_VALUE)
159 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
160 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
161 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
162 #define DBG_IPC     (opt.debug & DBG_IPC_VALUE)
163 #define DBG_NETWORK (opt.debug & DBG_NETWORK_VALUE)
164 #define DBG_LOOKUP  (opt.debug & DBG_LOOKUP_VALUE)
165 #define DBG_EXTPROG (opt.debug & DBG_EXTPROG_VALUE)
166
167 /* A simple list of certificate references.  FIXME: Better use
168    certlist_t also for references (Store NULL at .cert) */
169 struct cert_ref_s
170 {
171   struct cert_ref_s *next;
172   unsigned char fpr[20];
173 };
174 typedef struct cert_ref_s *cert_ref_t;
175
176
177 /* Forward references; access only through server.c.  */
178 struct server_local_s;
179
180 #if SIZEOF_UNSIGNED_LONG == 8
181 # define SERVER_CONTROL_MAGIC 0x6469726d6e677220
182 #else
183 # define SERVER_CONTROL_MAGIC 0x6469726d
184 #endif
185
186 /* Connection control structure.  */
187 struct server_control_s
188 {
189   unsigned long magic;/* Always has SERVER_CONTROL_MAGIC.  */
190   int refcount;       /* Count additional references to this object.  */
191   int no_server;      /* We are not running under server control. */
192   int status_fd;      /* Only for non-server mode. */
193   struct server_local_s *server_local;
194   int force_crl_refresh; /* Always load a fresh CRL. */
195
196   int check_revocations_nest_level; /* Internal to check_revovations.  */
197   cert_ref_t ocsp_certs; /* Certificates from the current OCSP
198                             response. */
199
200   int audit_events;  /* Send audit events to client.  */
201   char *http_proxy;  /* The used http_proxy or NULL.  */
202
203   unsigned int timeout; /* Timeout for connect calls in ms.  */
204
205   unsigned int http_no_crl:1;  /* Do not check CRLs for https.  */
206 };
207
208
209 /*-- dirmngr.c --*/
210 void dirmngr_exit( int );  /* Wrapper for exit() */
211 void dirmngr_init_default_ctrl (ctrl_t ctrl);
212 void dirmngr_deinit_default_ctrl (ctrl_t ctrl);
213 void dirmngr_sighup_action (void);
214 const char* dirmngr_get_current_socket_name (void);
215 int dirmngr_use_tor (void);
216
217 /*-- Various housekeeping functions.  --*/
218 void ks_hkp_housekeeping (time_t curtime);
219 void ks_hkp_reload (void);
220
221
222 /*-- server.c --*/
223 ldap_server_t get_ldapservers_from_ctrl (ctrl_t ctrl);
224 ksba_cert_t get_cert_local (ctrl_t ctrl, const char *issuer);
225 ksba_cert_t get_issuing_cert_local (ctrl_t ctrl, const char *issuer);
226 ksba_cert_t get_cert_local_ski (ctrl_t ctrl,
227                                 const char *name, ksba_sexp_t keyid);
228 gpg_error_t get_istrusted_from_client (ctrl_t ctrl, const char *hexfpr);
229 int dirmngr_assuan_log_monitor (assuan_context_t ctx, unsigned int cat,
230                                 const char *msg);
231 void start_command_handler (gnupg_fd_t fd, unsigned int session_id);
232 gpg_error_t dirmngr_status (ctrl_t ctrl, const char *keyword, ...);
233 gpg_error_t dirmngr_status_help (ctrl_t ctrl, const char *text);
234 gpg_error_t dirmngr_status_helpf (ctrl_t ctrl, const char *format,
235                                   ...) GPGRT_ATTR_PRINTF(2,3);
236 gpg_error_t dirmngr_status_printf (ctrl_t ctrl, const char *keyword,
237                                    const char *format,
238                                    ...) GPGRT_ATTR_PRINTF(3,4);
239 gpg_error_t dirmngr_tick (ctrl_t ctrl);
240
241 /*-- http-ntbtls.c --*/
242 /* Note that we don't use a callback for gnutls.  */
243
244 gpg_error_t gnupg_http_tls_verify_cb (void *opaque,
245                                       http_t http,
246                                       http_session_t session,
247                                       unsigned int flags,
248                                       void *tls_context);
249
250
251 /*-- loadswdb.c --*/
252 gpg_error_t dirmngr_load_swdb (ctrl_t ctrl, int force);
253
254
255 /*-- domaininfo.c --*/
256 void domaininfo_print_stats (void);
257 int  domaininfo_is_wkd_not_supported (const char *domain);
258 void domaininfo_set_no_name (const char *domain);
259 void domaininfo_set_wkd_supported (const char *domain);
260 void domaininfo_set_wkd_not_supported (const char *domain);
261 void domaininfo_set_wkd_not_found (const char *domain);
262
263 /*-- workqueue.c --*/
264 typedef const char *(*wqtask_t)(ctrl_t ctrl, const char *args);
265
266 void workqueue_dump_queue (ctrl_t ctrl);
267 gpg_error_t workqueue_add_task (wqtask_t func, const char *args,
268                                 unsigned int session_id, int need_network);
269 void workqueue_run_global_tasks (ctrl_t ctrl, int with_network);
270 void workqueue_run_post_session_tasks (unsigned int session_id);
271
272
273
274 #endif /*DIRMNGR_H*/