* gpgkeys_curl.c, gpgkeys_finger.c, gpgkeys_ldap.c: Start using
[gnupg.git] / keyserver / ksutil.h
1 /* ksutil.h
2  * Copyright (C) 2004, 2005 Free Software Foundation, Inc.
3  *
4  * This file is part of GNUPG.
5  *
6  * GNUPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GNUPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * 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 #ifndef _KSUTIL_H_
22 #define _KSUTIL_H_
23
24 #define GET    0
25 #define SEND   1
26 #define SEARCH 2
27
28 /* MAX_LINE must be 1 larger than the largest item we expect to
29    receive. */
30 #define MAX_LINE    1080
31
32 #define MAX_COMMAND    6
33 #define MAX_OPTION   256
34 #define MAX_SCHEME    20
35 #define MAX_OPAQUE  1024
36 #define MAX_AUTH     128
37 #define MAX_HOST      80
38 #define MAX_PORT      10
39 #define URLMAX_PATH 1024
40 #define MAX_PROXY    128
41 #define MAX_URL     (MAX_SCHEME+1+3+MAX_AUTH+1+1+MAX_HOST+1+1 \
42                      +MAX_PORT+1+1+URLMAX_PATH+1+50)
43
44 #define STRINGIFY(x) #x
45 #define MKSTRING(x) STRINGIFY(x)
46
47 #define BEGIN "-----BEGIN PGP PUBLIC KEY BLOCK-----"
48 #define END   "-----END PGP PUBLIC KEY BLOCK-----"
49
50 struct keylist
51 {
52   char str[MAX_LINE];
53   struct keylist *next;
54 };
55
56 /* 2 minutes seems reasonable */
57 #define DEFAULT_KEYSERVER_TIMEOUT 120
58
59 unsigned int set_timeout(unsigned int seconds);
60 int register_timeout(void);
61
62 enum ks_action {KS_UNKNOWN=0,KS_GET,KS_SEND,KS_SEARCH};
63
64 struct ks_options
65 {
66   enum ks_action action;
67   char *host;
68   char *port;
69   char *scheme;
70   char *auth;
71   char *path;
72   char *opaque;
73   struct
74   {
75     unsigned int include_disabled:1;
76     unsigned int include_revoked:1;
77     unsigned int include_subkeys:1;
78     unsigned int check_cert:1;
79   } flags;
80   unsigned int verbose;
81   unsigned int debug;
82   unsigned int timeout;
83   char *ca_cert_file;
84 };
85
86 struct ks_options *init_ks_options(void);
87 void free_ks_options(struct ks_options *opt);
88 int parse_ks_options(char *line,struct ks_options *opt);
89 const char *ks_action_to_string(enum ks_action action);
90
91 #endif /* !_KSUTIL_H_ */