321a4ca9e5d4d67d8b42c140500d53210fb7f038
[gnupg.git] / g10 / filter.h
1 /* filter.h
2  *      Copyright (C) 1998 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 <gcrypt.h>
24
25 #include "basicdefs.h"
26
27
28
29 typedef struct {
30     GCRY_MD_HD md;      /* catch all */
31     GCRY_MD_HD md2;     /* if we want to calculate an alternate hash */
32     size_t maxbuf_size;
33 } md_filter_context_t;
34
35 typedef struct {
36     /* these fields may be initialized */
37     int what;               /* what kind of armor headers to write */
38     int only_keyblocks;     /* skip all headers but ".... key block" */
39     const char *hdrlines;   /* write these headerlines */
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 any_data;           /* any valid armored data seen */
63     int pending_lf;         /* used together with faked */
64 } armor_filter_context_t;
65
66
67 typedef struct {
68     int status;
69     void *opaque;   /* (used for z_stream) */
70     byte *inbuf;
71     unsigned inbufsize;
72     byte *outbuf;
73     unsigned outbufsize;
74     int algo;    /* compress algo */
75     int algo1hack;
76 } compress_filter_context_t;
77
78
79 typedef struct {
80     DEK *dek;
81     u32 datalen;
82     GCRY_CIPHER_HD cipher_hd;
83     int header;
84     GCRY_MD_HD mdc_hash;
85 } cipher_filter_context_t;
86
87
88 typedef struct {
89     int header_okay;
90     PK_LIST pk_list;
91     cipher_filter_context_t cfx;
92 } encrypt_filter_context_t;
93
94
95
96 typedef struct {
97     byte *buffer;           /* malloced buffer */
98     unsigned buffer_size;   /* and size of this buffer */
99     unsigned buffer_len;    /* used length of the buffer */
100     unsigned buffer_pos;    /* read position */
101     int truncated;          /* number of truncated lines */
102     int not_dash_escaped;
103     int escape_from;
104     GCRY_MD_HD md;
105     int pending_lf;
106     int pending_esc;
107 } text_filter_context_t;
108
109
110 /* encrypt_filter_context_t defined in main.h */
111
112 /*-- mdfilter.c --*/
113 int md_filter( void *opaque, int control, IOBUF a, byte *buf, size_t *ret_len);
114 void free_md_filter_context( md_filter_context_t *mfx );
115
116 /*-- armor.c --*/
117 int use_armor_filter( IOBUF a );
118 int armor_filter( void *opaque, int control,
119                   IOBUF chain, byte *buf, size_t *ret_len);
120
121 /*-- compress.c --*/
122 int compress_filter( void *opaque, int control,
123                      IOBUF chain, byte *buf, size_t *ret_len);
124
125 /*-- cipher.c --*/
126 int cipher_filter( void *opaque, int control,
127                    IOBUF chain, byte *buf, size_t *ret_len);
128
129 /*-- textfilter.c --*/
130 int text_filter( void *opaque, int control,
131                  IOBUF chain, byte *buf, size_t *ret_len);
132 int copy_clearsig_text( IOBUF out, IOBUF inp, GCRY_MD_HD md,
133                           int escape_dash, int escape_from, int pgp2mode );
134
135
136
137 #endif /*G10_FILTER_H*/