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