gpg: Rename cipher.c to cipher-cfb.c
[gnupg.git] / g10 / filter.h
1 /* filter.h
2  * Copyright (C) 1998, 1999, 2000, 2001, 2003,
3  *               2005 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <https://www.gnu.org/licenses/>.
19  */
20 #ifndef G10_FILTER_H
21 #define G10_FILTER_H
22
23 #include "../common/types.h"
24 #include "dek.h"
25
26 typedef struct {
27     gcry_md_hd_t md;      /* catch all */
28     gcry_md_hd_t md2;     /* if we want to calculate an alternate hash */
29     size_t maxbuf_size;
30 } md_filter_context_t;
31
32 typedef struct {
33     int  refcount;          /* Initialized to 1.  */
34
35     /* these fields may be initialized */
36     int what;               /* what kind of armor headers to write */
37     int only_keyblocks;     /* skip all headers but ".... key block" */
38     const char *hdrlines;   /* write these headerlines */
39
40     /* these fields must be initialized to zero */
41     int no_openpgp_data;    /* output flag: "No valid OpenPGP data found" */
42
43     /* the following fields must be initialized to zero */
44     int inp_checked;        /* set if the input has been checked */
45     int inp_bypass;         /* set if the input is not armored */
46     int in_cleartext;       /* clear text message */
47     int not_dash_escaped;   /* clear text is not dash escaped */
48     int hashes;             /* detected hash algorithms */
49     int faked;              /* we are faking a literal data packet */
50     int truncated;          /* number of truncated lines */
51     int qp_detected;
52     byte eol[3];            /* The end of line characters as a
53                                zero-terminated string.  Defaults
54                                (eol[0]=='\0') to whatever the local
55                                platform uses. */
56
57     byte *buffer;           /* malloced buffer */
58     unsigned buffer_size;   /* and size of this buffer */
59     unsigned buffer_len;    /* used length of the buffer */
60     unsigned buffer_pos;    /* read position */
61
62     byte radbuf[4];
63     int idx, idx2;
64     u32 crc;
65
66     int status;             /* an internal state flag */
67     int cancel;
68     int any_data;           /* any valid armored data seen */
69     int pending_lf;         /* used together with faked */
70 } armor_filter_context_t;
71
72 struct unarmor_pump_s;
73 typedef struct unarmor_pump_s *UnarmorPump;
74
75
76 struct compress_filter_context_s {
77     int status;
78     void *opaque;   /* (used for z_stream) */
79     byte *inbuf;
80     unsigned inbufsize;
81     byte *outbuf;
82     unsigned outbufsize;
83     int algo;    /* compress algo */
84     int algo1hack;
85     int new_ctb;
86     void (*release)(struct compress_filter_context_s*);
87 };
88 typedef struct compress_filter_context_s compress_filter_context_t;
89
90
91 typedef struct
92 {
93   /* Object with the key and algo */
94   DEK *dek;
95
96   /* Length of the data to encrypt if known - 32 bit because OpenPGP
97    * requires partial encoding for a larger data size.  */
98   u32 datalen;
99
100   /* The current cipher handle.  */
101   gcry_cipher_hd_t cipher_hd;
102
103   /* Various processing flags.  */
104   unsigned int wrote_header : 1;
105   unsigned int short_blklen_warn : 1;
106   unsigned long short_blklen_count;
107
108   /* The encoded chunk byte for AEAD.  */
109   byte chunkbyte;
110
111   /* The decoded CHUNKBYTE.  */
112   uint64_t chunksize;
113
114   /* The chunk index for AEAD.  */
115   uint64_t chunkindex;
116
117   /* The number of bytes in the current chunk.  */
118   uint64_t chunklen;
119
120   /* The total count of encrypted plaintext octets.  Note that we
121    * don't care about encrypting more than 16 Exabyte. */
122   uint64_t total;
123
124   /* The hash context and a buffer used for MDC.  */
125   gcry_md_hd_t mdc_hash;
126   byte enchash[20];
127
128   /* The start IV for AEAD encryption.   */
129   byte startiv[16];
130
131   /* Using a large buffer for encryption makes processing easier and
132    * also makes sure the data is well aligned.  */
133   char *buffer;
134   size_t bufsize;  /* Allocated length.  */
135   size_t buflen;   /* Used length.       */
136
137 } cipher_filter_context_t;
138
139
140
141 typedef struct {
142     byte *buffer;           /* malloced buffer */
143     unsigned buffer_size;   /* and size of this buffer */
144     unsigned buffer_len;    /* used length of the buffer */
145     unsigned buffer_pos;    /* read position */
146     int truncated;          /* number of truncated lines */
147     int not_dash_escaped;
148     int escape_from;
149     gcry_md_hd_t md;
150     int pending_lf;
151     int pending_esc;
152 } text_filter_context_t;
153
154
155 typedef struct {
156     char *what;                 /* description */
157     u32 last_time;              /* last time reported */
158     unsigned long last;         /* last amount reported */
159     unsigned long offset;       /* current amount */
160     unsigned long total;        /* total amount */
161     int  refcount;
162 } progress_filter_context_t;
163
164 /* encrypt_filter_context_t defined in main.h */
165
166 /*-- mdfilter.c --*/
167 int md_filter( void *opaque, int control, iobuf_t a, byte *buf, size_t *ret_len);
168 void free_md_filter_context( md_filter_context_t *mfx );
169
170 /*-- armor.c --*/
171 armor_filter_context_t *new_armor_context (void);
172 void release_armor_context (armor_filter_context_t *afx);
173 int push_armor_filter (armor_filter_context_t *afx, iobuf_t iobuf);
174 int use_armor_filter( iobuf_t a );
175 UnarmorPump unarmor_pump_new (void);
176 void        unarmor_pump_release (UnarmorPump x);
177 int         unarmor_pump (UnarmorPump x, int c);
178
179 /*-- compress.c --*/
180 void push_compress_filter(iobuf_t out,compress_filter_context_t *zfx,int algo);
181 void push_compress_filter2(iobuf_t out,compress_filter_context_t *zfx,
182                            int algo,int rel);
183
184 /*-- cipher.c --*/
185 int cipher_filter_cfb (void *opaque, int control,
186                        iobuf_t chain, byte *buf, size_t *ret_len);
187
188 /*-- cipher-aead.c --*/
189 int cipher_filter_aead (void *opaque, int control,
190                         iobuf_t chain, byte *buf, size_t *ret_len);
191
192 /*-- textfilter.c --*/
193 int text_filter( void *opaque, int control,
194                  iobuf_t chain, byte *buf, size_t *ret_len);
195 int copy_clearsig_text (iobuf_t out, iobuf_t inp, gcry_md_hd_t md,
196                         int escape_dash, int escape_from);
197
198 /*-- progress.c --*/
199 progress_filter_context_t *new_progress_context (void);
200 void release_progress_context (progress_filter_context_t *pfx);
201 void handle_progress (progress_filter_context_t *pfx,
202                       iobuf_t inp, const char *name);
203
204 #endif /*G10_FILTER_H*/