See ChangeLog: Thu May 20 14:04:08 CEST 1999 Werner Koch
[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 "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     /* the following fields must be initialized to zero */
39     int inp_checked;        /* set if the input has been checked */
40     int inp_bypass;         /* set if the input is not armored */
41     int in_cleartext;       /* clear text message */
42     int not_dash_escaped;   /* clear text is not dash escaped */
43     int hashes;             /* detected hash algorithms */
44     int faked;              /* we are faking a literal data packet */
45     int truncated;          /* number of truncated lines */
46     int qp_detected;
47     int pgp2mode;
48
49     byte *buffer;           /* malloced buffer */
50     unsigned buffer_size;   /* and size of this buffer */
51     unsigned buffer_len;    /* used length of the buffer */
52     unsigned buffer_pos;    /* read position */
53
54     byte radbuf[4];
55     int idx, idx2;
56     u32 crc;
57
58     int status;             /* an internal state flag */
59     int any_data;           /* any valid armored data seen */
60     int pending_lf;         /* used together with faked */
61 } armor_filter_context_t;
62
63
64 typedef struct {
65     int status;
66     void *opaque;   /* (used for z_stream) */
67     byte *inbuf;
68     unsigned inbufsize;
69     byte *outbuf;
70     unsigned outbufsize;
71     int algo;    /* compress algo */
72     int algo1hack;
73 } compress_filter_context_t;
74
75
76 typedef struct {
77     DEK *dek;
78     u32 datalen;
79     CIPHER_HANDLE cipher_hd;
80     int header;
81     MD_HANDLE mdc_hash;
82 } cipher_filter_context_t;
83
84
85
86 typedef struct {
87     byte *buffer;           /* malloced buffer */
88     unsigned buffer_size;   /* and size of this buffer */
89     unsigned buffer_len;    /* used length of the buffer */
90     unsigned buffer_pos;    /* read position */
91     int truncated;          /* number of truncated lines */
92     int not_dash_escaped;
93     int escape_from;
94     MD_HANDLE md;
95     int pending_lf;
96     int pending_esc;
97 } text_filter_context_t;
98
99
100 /* encrypt_filter_context_t defined in main.h */
101
102 /*-- mdfilter.c --*/
103 int md_filter( void *opaque, int control, IOBUF a, byte *buf, size_t *ret_len);
104 void free_md_filter_context( md_filter_context_t *mfx );
105
106 /*-- armor.c --*/
107 int use_armor_filter( IOBUF a );
108 int armor_filter( void *opaque, int control,
109                   IOBUF chain, byte *buf, size_t *ret_len);
110
111 /*-- compress.c --*/
112 int compress_filter( void *opaque, int control,
113                      IOBUF chain, byte *buf, size_t *ret_len);
114
115 /*-- cipher.c --*/
116 int cipher_filter( void *opaque, int control,
117                    IOBUF chain, byte *buf, size_t *ret_len);
118
119 /*-- textfilter.c --*/
120 int text_filter( void *opaque, int control,
121                  IOBUF chain, byte *buf, size_t *ret_len);
122 int copy_clearsig_text( IOBUF out, IOBUF inp, MD_HANDLE md,
123                           int escape_dash, int escape_from, int pgp2mode );
124
125
126
127 #endif /*G10_FILTER_H*/