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