Fix a build_sources problem
[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 g10 Code GmbH
4  *
5  * This file is part of DirMngr.
6  *
7  * DirMngr is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * DirMngr is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #ifndef DIRMNGR_H
22 #define DIRMNGR_H
23
24 #include "./dirmngr-err.h"
25 #define map_assuan_err(a) \
26         map_assuan_err_with_source (GPG_ERR_SOURCE_DEFAULT, (a))
27 #include <errno.h>
28 #include <gcrypt.h>
29 #include <ksba.h>
30
31 #include "../common/util.h"
32 #include "../common/membuf.h"
33 #include "../common/sysutils.h" /* (gnupg_fd_t) */
34 #include "../common/i18n.h"
35
36
37 /* This objects keeps information about a particular LDAP server and
38    is used as item of a single linked list of servers. */
39 struct ldap_server_s 
40 {
41   struct ldap_server_s* next;
42   
43   char *host;
44   int   port;
45   char *user;
46   char *pass;
47   char *base;
48 };
49 typedef struct ldap_server_s *ldap_server_t;
50
51
52 /* A list of fingerprints.  */
53 struct fingerprint_list_s;
54 typedef struct fingerprint_list_s *fingerprint_list_t;
55 struct fingerprint_list_s
56 {
57   fingerprint_list_t next;
58   char hexfpr[20+20+1];
59 };
60
61
62 /* A large struct named "opt" to keep global flags.  */
63 struct 
64 {
65   unsigned int debug; /* debug flags (DBG_foo_VALUE) */
66   int verbose;        /* verbosity level */
67   int quiet;          /* be as quiet as possible */
68   int dry_run;        /* don't change any persistent data */
69   int batch;          /* batch mode */
70   const char *homedir;      /* Configuration directory name */
71   const char *homedir_data; /* Ditto for data files (/usr/share/dirmngr).  */
72   const char *homedir_cache; /* Ditto for cache files (/var/cache/dirmngr).  */
73
74   char *config_filename;     /* Name of a config file, which will be
75                                 reread on a HUP if it is not NULL. */
76
77   char *ldap_wrapper_program; /* Override value for the LDAP wrapper
78                                  program.  */
79   char *http_wrapper_program; /* Override value for the HTTP wrapper
80                                  program.  */
81
82   int system_service;   /* We are running as W32 service (implies daemon).  */
83   int system_daemon;    /* We are running in system daemon mode.  */
84   int running_detached; /* We are running in detached mode.  */
85
86   int force;          /* Force loading outdated CRLs. */
87
88   int disable_http;       /* Do not use HTTP at all.  */
89   int disable_ldap;       /* Do not use LDAP at all.  */
90   int honor_http_proxy;   /* Honor the http_proxy env variable. */
91   const char *http_proxy; /* Use given HTTP proxy.  */
92   const char *ldap_proxy; /* Use given LDAP proxy.  */
93   int only_ldap_proxy;    /* Only use the LDAP proxy; no fallback.  */
94   int ignore_http_dp;     /* Ignore HTTP CRL distribution points.  */
95   int ignore_ldap_dp;     /* Ignore LDAP CRL distribution points.  */
96   int ignore_ocsp_service_url; /* Ignore OCSP service URLs as given in
97                                   the certificate.  */
98
99   /* A list of certificate extension OIDs which are ignored so that
100      one can claim that a critical extension has been handled.  One
101      OID per string.  */
102   strlist_t ignored_cert_extensions;
103
104   int allow_ocsp;     /* Allow using OCSP. */
105
106   int max_replies;
107   unsigned int ldaptimeout;
108   
109   ldap_server_t ldapservers;
110   int add_new_ldapservers;
111
112   const char *ocsp_responder;     /* Standard OCSP responder's URL. */
113   fingerprint_list_t ocsp_signer; /* The list of fingerprints with allowed
114                                      standard OCSP signer certificates.  */
115   
116   unsigned int ocsp_max_clock_skew; /* Allowed seconds of clocks skew. */
117   unsigned int ocsp_max_period;     /* Seconds a response is at maximum
118                                        considered valid after thisUpdate. */
119   unsigned int ocsp_current_period; /* Seconds a response is considered 
120                                        current after nextUpdate. */
121 } opt;
122
123
124 #define DBG_X509_VALUE    1     /* debug x.509 parsing */
125 #define DBG_LOOKUP_VALUE  2     /* debug lookup details */
126 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
127 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
128 #define DBG_CACHE_VALUE   64    /* debug the caching */
129 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
130 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
131 #define DBG_ASSUAN_VALUE  1024  /* debug assuan communication */
132
133 #define DBG_X509    (opt.debug & DBG_X509_VALUE)
134 #define DBG_LOOKUP  (opt.debug & DBG_LOOKUP_VALUE)
135 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
136 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
137 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
138 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
139 #define DBG_ASSUAN   (opt.debug & DBG_ASSUAN_VALUE)
140
141 /* A simple list of certificate references. */
142 struct cert_ref_s
143 {
144   struct cert_ref_s *next;
145   unsigned char fpr[20];
146 };
147 typedef struct cert_ref_s *cert_ref_t;
148
149 /* Forward references; access only through server.c.  */
150 struct server_local_s;
151
152 /* Connection control structure.  */
153 struct server_control_s
154 {
155   int refcount;      /* Count additional references to this object.  */
156   int no_server;     /* We are not running under server control. */
157   int status_fd;     /* Only for non-server mode. */
158   struct server_local_s *server_local;
159   int force_crl_refresh; /* Always load a fresh CRL. */
160   
161   int check_revocations_nest_level; /* Internal to check_revovations.  */
162   cert_ref_t ocsp_certs; /* Certificates from the current OCSP
163                             response. */
164
165   int audit_events;  /* Send audit events to client.  */
166 };
167
168
169 /*-- dirmngr.c --*/
170 void dirmngr_exit( int );  /* Wrapper for exit() */
171 void dirmngr_init_default_ctrl (ctrl_t ctrl);
172 void dirmngr_sighup_action (void);
173
174 /*-- server.c --*/
175 ldap_server_t get_ldapservers_from_ctrl (ctrl_t ctrl);
176 ksba_cert_t get_cert_local (ctrl_t ctrl, const char *issuer);
177 ksba_cert_t get_issuing_cert_local (ctrl_t ctrl, const char *issuer);
178 ksba_cert_t get_cert_local_ski (ctrl_t ctrl,
179                                 const char *name, ksba_sexp_t keyid);
180 gpg_error_t get_istrusted_from_client (ctrl_t ctrl, const char *hexfpr);
181 void start_command_handler (gnupg_fd_t fd);
182 gpg_error_t dirmngr_status (ctrl_t ctrl, const char *keyword, ...);
183 gpg_error_t dirmngr_tick (ctrl_t ctrl);
184
185
186 #endif /*DIRMNGR_H*/