See ChangeLog: Tue Jul 25 17:44:15 CEST 2000 Werner Koch
[gnupg.git] / g10 / filter.h
1 /* filter.h
2  *      Copyright (C) 1998, 1999, 2000 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 GPG_FILTER_H
21 #define GPG_FILTER_H
22
23 #include <gcrypt.h>
24
25 #include "basicdefs.h"
26 #include "iobuf.h"
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     /* these fileds must be initialized to zero */
42     int no_openpgp_data;    /* output flag: "No valid OpenPGP data found" */
43
44     /* the following fields must be initialized to zero */
45     int inp_checked;        /* set if the input has been checked */
46     int inp_bypass;         /* set if the input is not armored */
47     int in_cleartext;       /* clear text message */
48     int not_dash_escaped;   /* clear text is not dash escaped */
49     int hashes;             /* detected hash algorithms */
50     int faked;              /* we are faking a literal data packet */
51     int truncated;          /* number of truncated lines */
52     int qp_detected;
53     int pgp2mode;
54
55     byte *buffer;           /* malloced buffer */
56     unsigned buffer_size;   /* and size of this buffer */
57     unsigned buffer_len;    /* used length of the buffer */
58     unsigned buffer_pos;    /* read position */
59
60     byte radbuf[4];
61     int idx, idx2;
62     u32 crc;
63
64     int status;             /* an internal state flag */
65     int cancel;
66     int any_data;           /* any valid armored data seen */
67     int pending_lf;         /* used together with faked */
68 } armor_filter_context_t;
69
70
71 typedef struct {
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 } compress_filter_context_t;
81
82
83 typedef struct {
84     DEK *dek;
85     u32 datalen;
86     GCRY_CIPHER_HD cipher_hd;
87     int header;
88     GCRY_MD_HD mdc_hash;
89     byte enchash[20];
90     int create_mdc; /* flag will be set by the cipher filter */
91 } cipher_filter_context_t;
92
93
94 typedef struct {
95     int header_okay;
96     PK_LIST pk_list;
97     cipher_filter_context_t cfx;
98 } encrypt_filter_context_t;
99
100
101 typedef struct {
102     byte *buffer;           /* malloced buffer */
103     unsigned buffer_size;   /* and size of this buffer */
104     unsigned buffer_len;    /* used length of the buffer */
105     unsigned buffer_pos;    /* read position */
106     int truncated;          /* number of truncated lines */
107     int not_dash_escaped;
108     int escape_from;
109     GCRY_MD_HD md;
110     int pending_lf;
111     int pending_esc;
112 } text_filter_context_t;
113
114
115 /*-- mdfilter.c --*/
116 int md_filter( void *opaque, int control, IOBUF a, byte *buf, size_t *ret_len);
117 void free_md_filter_context( md_filter_context_t *mfx );
118
119 /*-- armor.c --*/
120 int use_armor_filter( IOBUF a );
121 int armor_filter( void *opaque, int control,
122                   IOBUF chain, byte *buf, size_t *ret_len);
123
124 /*-- compress.c --*/
125 int compress_filter( void *opaque, int control,
126                      IOBUF chain, byte *buf, size_t *ret_len);
127
128 /*-- cipher.c --*/
129 int cipher_filter( void *opaque, int control,
130                    IOBUF chain, byte *buf, size_t *ret_len);
131
132 /*-- textfilter.c --*/
133 int text_filter( void *opaque, int control,
134                  IOBUF chain, byte *buf, size_t *ret_len);
135 int copy_clearsig_text( IOBUF out, IOBUF inp, GCRY_MD_HD md,
136                           int escape_dash, int escape_from, int pgp2mode );
137
138
139
140 #endif /*GPG_FILTER_H*/