wks: Make sure that the draft 2 request is correctly detected.
[gnupg.git] / tools / gpg-wks.h
1 /* gpg-wks.h - Common definitions for wks server and client.
2  * Copyright (C) 2016 g10 Code GmbH
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 3 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, see <https://www.gnu.org/licenses/>.
18  */
19
20 #ifndef GNUPG_GPG_WKS_H
21 #define GNUPG_GPG_WKS_H
22
23 #include "../common/util.h"
24 #include "../common/strlist.h"
25 #include "mime-maker.h"
26
27 /* The draft version we implement.  */
28 #define WKS_DRAFT_VERSION 3
29
30
31 /* We keep all global options in the structure OPT.  */
32 struct
33 {
34   int verbose;
35   unsigned int debug;
36   int quiet;
37   int use_sendmail;
38   const char *output;
39   const char *gpg_program;
40   const char *directory;
41   const char *default_from;
42   strlist_t extra_headers;
43 } opt;
44
45 /* Debug values and macros.  */
46 #define DBG_MIME_VALUE        1 /* Debug the MIME structure.  */
47 #define DBG_PARSER_VALUE      2 /* Debug the Mail parser.  */
48 #define DBG_CRYPTO_VALUE      4 /* Debug low level crypto.  */
49 #define DBG_MEMORY_VALUE     32 /* Debug memory allocation stuff.  */
50 #define DBG_MEMSTAT_VALUE   128 /* Show memory statistics.  */
51 #define DBG_IPC_VALUE      1024 /* Debug assuan communication.  */
52 #define DBG_EXTPROG_VALUE 16384 /* debug external program calls */
53
54 #define DBG_MIME     (opt.debug & DBG_MIME_VALUE)
55 #define DBG_PARSER   (opt.debug & DBG_PARSER_VALUE)
56 #define DBG_CRYPTO   (opt.debug & DBG_CRYPTO_VALUE)
57
58
59 /* The parsed policy flags. */
60 struct policy_flags_s
61 {
62   unsigned int mailbox_only : 1;
63   unsigned int dane_only : 1;
64   unsigned int auth_submit : 1;
65   unsigned int max_pending;      /* Seconds to wait for a confirmation.  */
66 };
67 typedef struct policy_flags_s *policy_flags_t;
68
69
70
71 /*-- wks-util.c --*/
72 void wks_set_status_fd (int fd);
73 void wks_write_status (int no, const char *format, ...) GPGRT_ATTR_PRINTF(2,3);
74 gpg_error_t wks_list_key (estream_t key, char **r_fpr, strlist_t *r_mboxes);
75 gpg_error_t wks_send_mime (mime_maker_t mime);
76 gpg_error_t wks_parse_policy (policy_flags_t flags, estream_t stream,
77                               int ignore_unknown);
78
79 /*-- wks-receive.c --*/
80
81 /* Flag values for the receive callback.  */
82 #define WKS_RECEIVE_DRAFT2 1
83
84 gpg_error_t wks_receive (estream_t fp,
85                          gpg_error_t (*result_cb)(void *opaque,
86                                                   const char *mediatype,
87                                                   estream_t data,
88                                                   unsigned int flags),
89                          void *cb_data);
90
91
92
93 #endif /*GNUPG_GPG_WKS_H*/