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