Pth tweaks and improved estream.c
[gnupg.git] / keyserver / ksutil.h
1 /* ksutil.h
2  * Copyright (C) 2004, 2005, 2006 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
19  * USA.
20  *
21  * In addition, as a special exception, the Free Software Foundation
22  * gives permission to link the code of the keyserver helper tools:
23  * gpgkeys_ldap, gpgkeys_curl and gpgkeys_hkp with the OpenSSL
24  * project's "OpenSSL" library (or with modified versions of it that
25  * use the same license as the "OpenSSL" library), and distribute the
26  * linked executables.  You must obey the GNU General Public License
27  * in all respects for all of the code used other than "OpenSSL".  If
28  * you modify this file, you may extend this exception to your version
29  * of the file, but you are not obligated to do so.  If you do not
30  * wish to do so, delete this exception statement from your version.
31  */
32
33 #ifndef _KSUTIL_H_
34 #define _KSUTIL_H_
35
36 #ifdef HAVE_LIBCURL
37 #include <curl/curl.h>
38 #else
39 #include "curl-shim.h"
40 #endif
41
42 /* MAX_LINE must be at least 1 larger than the largest item we expect
43    to receive, including the name tag ("COMMAND", "PORT", etc) and
44    space between.  In practice, that means it should be
45    strlen("OPAQUE")+1+sizeof_opaque+1 */
46 #define MAX_LINE       (6+1+1024+1)
47
48 #define MAX_COMMAND    7
49 #define MAX_OPTION   256
50 #define MAX_SCHEME    20
51 #define MAX_OPAQUE  1024
52 #define MAX_AUTH     128
53 #define MAX_HOST      80
54 #define MAX_PORT      10
55 #define URLMAX_PATH 1024
56 #define MAX_PROXY    128
57 #define MAX_URL     (MAX_SCHEME+1+3+MAX_AUTH+1+1+MAX_HOST+1+1 \
58                      +MAX_PORT+1+1+URLMAX_PATH+1+50)
59
60 #define STRINGIFY(x) #x
61 #define MKSTRING(x) STRINGIFY(x)
62
63 #define BEGIN "-----BEGIN PGP PUBLIC KEY BLOCK-----"
64 #define END   "-----END PGP PUBLIC KEY BLOCK-----"
65
66 #ifdef __riscos__
67 #define HTTP_PROXY_ENV           "GnuPG$HttpProxy"
68 #else
69 #define HTTP_PROXY_ENV           "http_proxy"
70 #endif
71
72 struct keylist
73 {
74   char str[MAX_LINE];
75   struct keylist *next;
76 };
77
78 /* 2 minutes seems reasonable */
79 #define DEFAULT_KEYSERVER_TIMEOUT 120
80
81 unsigned int set_timeout(unsigned int seconds);
82 int register_timeout(void);
83
84 enum ks_action {KS_UNKNOWN=0,KS_GET,KS_GETNAME,KS_SEND,KS_SEARCH};
85
86 enum ks_search_type {KS_SEARCH_SUBSTR,KS_SEARCH_EXACT,
87                      KS_SEARCH_MAIL,KS_SEARCH_MAILSUB,
88                      KS_SEARCH_KEYID_LONG,KS_SEARCH_KEYID_SHORT};
89
90 struct ks_options
91 {
92   enum ks_action action;
93   char *host;
94   char *port;
95   char *scheme;
96   char *auth;
97   char *path;
98   char *opaque;
99   struct
100   {
101     unsigned int include_disabled:1;
102     unsigned int include_revoked:1;
103     unsigned int include_subkeys:1;
104     unsigned int check_cert:1;
105   } flags;
106   unsigned int verbose;
107   unsigned int debug;
108   unsigned int timeout;
109   char *ca_cert_file;
110 };
111
112 struct ks_options *init_ks_options(void);
113 void free_ks_options(struct ks_options *opt);
114 int parse_ks_options(char *line,struct ks_options *opt);
115 const char *ks_action_to_string(enum ks_action action);
116 void print_nocr(FILE *stream,const char *str);
117 enum ks_search_type classify_ks_search(const char **search);
118
119 int curl_err_to_gpg_err(CURLcode error);
120
121 struct curl_writer_ctx
122 {
123   struct
124   {
125     unsigned int initialized:1;
126     unsigned int begun:1;
127     unsigned int done:1;
128     unsigned int armor:1;
129   } flags;
130
131   int armor_remaining;
132   unsigned char armor_ctx[3];
133   int markeridx,linelen;
134   const char *marker;
135   FILE *stream;
136 };
137
138 size_t curl_writer(const void *ptr,size_t size,size_t nmemb,void *cw_ctx);
139 void curl_writer_finalize(struct curl_writer_ctx *ctx);
140
141 int ks_hextobyte (const char *s);
142 int ks_toupper (int c);
143 int ks_strcasecmp (const char *a, const char *b);
144
145
146 #endif /* !_KSUTIL_H_ */