* options.h, g10.c (main), keyserver.c (keyserver_refresh): Maintain and
[gnupg.git] / g10 / filter.h
1 /* filter.h
2  * Copyright (C) 1998, 1999, 2000, 2001 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 #ifndef G10_FILTER_H
21 #define G10_FILTER_H
22
23 #include "types.h"
24 #include "cipher.h"
25
26 typedef struct {
27     MD_HANDLE md;      /* catch all */
28     MD_HANDLE md2;     /* if we want to calculate an alternate hash */
29     size_t maxbuf_size;
30 } md_filter_context_t;
31
32 typedef struct {
33     /* these fields may be initialized */
34     int what;               /* what kind of armor headers to write */
35     int only_keyblocks;     /* skip all headers but ".... key block" */
36     const char *hdrlines;   /* write these headerlines */
37
38     /* these fileds must be initialized to zero */
39     int no_openpgp_data;    /* output flag: "No valid OpenPGP data found" */
40
41     /* the following fields must be initialized to zero */
42     int inp_checked;        /* set if the input has been checked */
43     int inp_bypass;         /* set if the input is not armored */
44     int in_cleartext;       /* clear text message */
45     int not_dash_escaped;   /* clear text is not dash escaped */
46     int hashes;             /* detected hash algorithms */
47     int faked;              /* we are faking a literal data packet */
48     int truncated;          /* number of truncated lines */
49     int qp_detected;
50     int pgp2mode;
51
52     byte *buffer;           /* malloced buffer */
53     unsigned buffer_size;   /* and size of this buffer */
54     unsigned buffer_len;    /* used length of the buffer */
55     unsigned buffer_pos;    /* read position */
56
57     byte radbuf[4];
58     int idx, idx2;
59     u32 crc;
60
61     int status;             /* an internal state flag */
62     int cancel;
63     int any_data;           /* any valid armored data seen */
64     int pending_lf;         /* used together with faked */
65 } armor_filter_context_t;
66
67 struct unarmor_pump_s;
68 typedef struct unarmor_pump_s *UnarmorPump;
69
70
71 struct compress_filter_context_s {
72     int status;
73     void *opaque;   /* (used for z_stream) */
74     byte *inbuf;
75     unsigned inbufsize;
76     byte *outbuf;
77     unsigned outbufsize;
78     int algo;    /* compress algo */
79     int algo1hack;
80     void (*release)(struct compress_filter_context_s*);
81 };
82 typedef struct compress_filter_context_s compress_filter_context_t;
83
84
85 typedef struct {
86     DEK *dek;
87     u32 datalen;
88     CIPHER_HANDLE cipher_hd;
89     int header;
90     MD_HANDLE mdc_hash;
91     byte enchash[20];
92     int create_mdc; /* flag will be set by the cipher filter */
93 } cipher_filter_context_t;
94
95
96
97 typedef struct {
98     byte *buffer;           /* malloced buffer */
99     unsigned buffer_size;   /* and size of this buffer */
100     unsigned buffer_len;    /* used length of the buffer */
101     unsigned buffer_pos;    /* read position */
102     int truncated;          /* number of truncated lines */
103     int not_dash_escaped;
104     int escape_from;
105     MD_HANDLE md;
106     int pending_lf;
107     int pending_esc;
108 } text_filter_context_t;
109
110
111 /* encrypt_filter_context_t defined in main.h */
112
113 /*-- mdfilter.c --*/
114 int md_filter( void *opaque, int control, IOBUF a, byte *buf, size_t *ret_len);
115 void free_md_filter_context( md_filter_context_t *mfx );
116
117 /*-- armor.c --*/
118 int use_armor_filter( IOBUF a );
119 int armor_filter( void *opaque, int control,
120                   IOBUF chain, byte *buf, size_t *ret_len);
121 UnarmorPump unarmor_pump_new (void);
122 void        unarmor_pump_release (UnarmorPump x);
123 int         unarmor_pump (UnarmorPump x, int c);
124
125 /*-- compress.c --*/
126 int compress_filter( void *opaque, int control,
127                      IOBUF chain, byte *buf, size_t *ret_len);
128
129 /*-- cipher.c --*/
130 int cipher_filter( void *opaque, int control,
131                    IOBUF chain, byte *buf, size_t *ret_len);
132
133 /*-- textfilter.c --*/
134 int text_filter( void *opaque, int control,
135                  IOBUF chain, byte *buf, size_t *ret_len);
136 int copy_clearsig_text( IOBUF out, IOBUF inp, MD_HANDLE md,
137                           int escape_dash, int escape_from, int pgp2mode );
138
139
140
141 #endif /*G10_FILTER_H*/