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