* ksutil.h, ksutil.c (classify_ks_search): Add KS_SEARCH_KEYID_SHORT
[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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
19  * USA.
20  */
21
22 #ifndef _KSUTIL_H_
23 #define _KSUTIL_H_
24
25 #ifdef HAVE_LIBCURL
26 #include <curl/curl.h>
27 #else
28 #ifdef FAKE_CURL
29 #include "curl-shim.h"
30 #endif
31 #endif
32
33 /* MAX_LINE must be at least 1 larger than the largest item we expect
34    to receive, including the name tag ("COMMAND", "PORT", etc) and
35    space between.  In practice, that means it should be
36    strlen("OPAQUE")+1+sizeof_opaque+1 */
37 #define MAX_LINE       (6+1+1024+1)
38
39 #define MAX_COMMAND    7
40 #define MAX_OPTION   256
41 #define MAX_SCHEME    20
42 #define MAX_OPAQUE  1024
43 #define MAX_AUTH     128
44 #define MAX_HOST      80
45 #define MAX_PORT      10
46 #define URLMAX_PATH 1024
47 #define MAX_PROXY    128
48 #define MAX_URL     (MAX_SCHEME+1+3+MAX_AUTH+1+1+MAX_HOST+1+1 \
49                      +MAX_PORT+1+1+URLMAX_PATH+1+50)
50
51 #define STRINGIFY(x) #x
52 #define MKSTRING(x) STRINGIFY(x)
53
54 #define BEGIN "-----BEGIN PGP PUBLIC KEY BLOCK-----"
55 #define END   "-----END PGP PUBLIC KEY BLOCK-----"
56
57 #ifdef __riscos__
58 #define HTTP_PROXY_ENV           "GnuPG$HttpProxy"
59 #else
60 #define HTTP_PROXY_ENV           "http_proxy"
61 #endif
62
63 struct keylist
64 {
65   char str[MAX_LINE];
66   struct keylist *next;
67 };
68
69 /* 2 minutes seems reasonable */
70 #define DEFAULT_KEYSERVER_TIMEOUT 120
71
72 unsigned int set_timeout(unsigned int seconds);
73 int register_timeout(void);
74
75 enum ks_action {KS_UNKNOWN=0,KS_GET,KS_GETNAME,KS_SEND,KS_SEARCH};
76
77 enum ks_search_type {KS_SEARCH_SUBSTR,KS_SEARCH_EXACT,
78                      KS_SEARCH_MAIL,KS_SEARCH_MAILSUB,
79                      KS_SEARCH_KEYID_LONG,KS_SEARCH_KEYID_SHORT};
80
81 struct ks_options
82 {
83   enum ks_action action;
84   char *host;
85   char *port;
86   char *scheme;
87   char *auth;
88   char *path;
89   char *opaque;
90   struct
91   {
92     unsigned int include_disabled:1;
93     unsigned int include_revoked:1;
94     unsigned int include_subkeys:1;
95     unsigned int check_cert:1;
96   } flags;
97   unsigned int verbose;
98   unsigned int debug;
99   unsigned int timeout;
100   char *ca_cert_file;
101 };
102
103 struct ks_options *init_ks_options(void);
104 void free_ks_options(struct ks_options *opt);
105 int parse_ks_options(char *line,struct ks_options *opt);
106 const char *ks_action_to_string(enum ks_action action);
107 void print_nocr(FILE *stream,const char *str);
108 enum ks_search_type classify_ks_search(const char **search);
109
110 #if defined (HAVE_LIBCURL) || defined (FAKE_CURL)
111 int curl_err_to_gpg_err(CURLcode error);
112
113 struct curl_writer_ctx
114 {
115   struct
116   {
117     unsigned int initialized:1;
118     unsigned int begun:1;
119     unsigned int done:1;
120     unsigned int armor:1;
121   } flags;
122
123   int armor_remaining;
124   unsigned char armor_ctx[3];
125   int markeridx,linelen;
126   const char *marker;
127   FILE *stream;
128 };
129
130 size_t curl_writer(const void *ptr,size_t size,size_t nmemb,void *cw_ctx);
131 void curl_writer_finalize(struct curl_writer_ctx *ctx);
132
133 #endif
134
135 #endif /* !_KSUTIL_H_ */