agent: --supervised mode improvements.
[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 <http://www.gnu.org/licenses/>.
19  */
20 #ifndef G10_FILTER_H
21 #define G10_FILTER_H
22
23 #include "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     DEK *dek;
93     u32 datalen;
94     gcry_cipher_hd_t cipher_hd;
95     int header;
96     gcry_md_hd_t mdc_hash;
97     byte enchash[20];
98     int create_mdc; /* flag will be set by the cipher filter */
99 } cipher_filter_context_t;
100
101
102
103 typedef struct {
104     byte *buffer;           /* malloced buffer */
105     unsigned buffer_size;   /* and size of this buffer */
106     unsigned buffer_len;    /* used length of the buffer */
107     unsigned buffer_pos;    /* read position */
108     int truncated;          /* number of truncated lines */
109     int not_dash_escaped;
110     int escape_from;
111     gcry_md_hd_t md;
112     int pending_lf;
113     int pending_esc;
114 } text_filter_context_t;
115
116
117 typedef struct {
118     char *what;                 /* description */
119     u32 last_time;              /* last time reported */
120     unsigned long last;         /* last amount reported */
121     unsigned long offset;       /* current amount */
122     unsigned long total;        /* total amount */
123     int  refcount;
124 } progress_filter_context_t;
125
126 /* encrypt_filter_context_t defined in main.h */
127
128 /*-- mdfilter.c --*/
129 int md_filter( void *opaque, int control, iobuf_t a, byte *buf, size_t *ret_len);
130 void free_md_filter_context( md_filter_context_t *mfx );
131
132 /*-- armor.c --*/
133 armor_filter_context_t *new_armor_context (void);
134 void release_armor_context (armor_filter_context_t *afx);
135 int push_armor_filter (armor_filter_context_t *afx, iobuf_t iobuf);
136 int use_armor_filter( iobuf_t a );
137 UnarmorPump unarmor_pump_new (void);
138 void        unarmor_pump_release (UnarmorPump x);
139 int         unarmor_pump (UnarmorPump x, int c);
140
141 /*-- compress.c --*/
142 void push_compress_filter(iobuf_t out,compress_filter_context_t *zfx,int algo);
143 void push_compress_filter2(iobuf_t out,compress_filter_context_t *zfx,
144                            int algo,int rel);
145
146 /*-- cipher.c --*/
147 int cipher_filter( void *opaque, int control,
148                    iobuf_t chain, byte *buf, size_t *ret_len);
149
150 /*-- textfilter.c --*/
151 int text_filter( void *opaque, int control,
152                  iobuf_t chain, byte *buf, size_t *ret_len);
153 int copy_clearsig_text (iobuf_t out, iobuf_t inp, gcry_md_hd_t md,
154                         int escape_dash, int escape_from);
155
156 /*-- progress.c --*/
157 progress_filter_context_t *new_progress_context (void);
158 void release_progress_context (progress_filter_context_t *pfx);
159 void handle_progress (progress_filter_context_t *pfx,
160                       iobuf_t inp, const char *name);
161
162 #endif /*G10_FILTER_H*/