some cleanups
[gnupg.git] / g10 / packet.h
1 /* packet.h - packet read/write stuff
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
21 #ifndef G10_PACKET_H
22 #define G10_PACKET_H
23
24 #include "types.h"
25 #include "iobuf.h"
26 #include "mpi.h"
27 #include "cipher.h"
28 #include "filter.h"
29
30 typedef enum {
31         PKT_NONE           =0,
32         PKT_PUBKEY_ENC     =1, /* public key encrypted packet */
33         PKT_SIGNATURE      =2, /* secret key encrypted packet */
34         PKT_SESSION_KEY    =3, /* session key packet (OpenPGP)*/
35         PKT_ONEPASS_SIG    =4, /* one pass sig packet (OpenPGP)*/
36         PKT_SECRET_CERT    =5, /* secret key certificate */
37         PKT_PUBLIC_CERT    =6, /* public key certificate */
38         PKT_SECKEY_SUBCERT =7, /* secret subkey certificate (OpenPGP) */
39         PKT_COMPRESSED     =8, /* compressed data packet */
40         PKT_ENCRYPTED      =9, /* conventional encrypted data */
41         PKT_MARKER        =10, /* marker packet (OpenPGP) */
42         PKT_PLAINTEXT     =11, /* plaintext data with filename and mode */
43         PKT_RING_TRUST    =12, /* keyring trust packet */
44         PKT_USER_ID       =13, /* user id packet */
45         PKT_PUBKEY_SUBCERT=14, /* subkey certificate (OpenPGP) */
46         PKT_COMMENT       =16  /* new comment packet (OpenPGP) */
47 } pkttype_t;
48
49 typedef struct packet_struct PACKET;
50
51 typedef struct {
52     u32     keyid[2];       /* 64 bit keyid */
53     byte    version;
54     byte    pubkey_algo;    /* algorithm used for public key scheme */
55     union {
56       struct {
57         MPI  a, b;          /* integers with the encrypteded DEK */
58       } elg;
59       struct {
60         MPI  rsa_integer;   /* integer containing the DEK */
61       } rsa;
62     } d;
63 } PKT_pubkey_enc;
64
65
66 typedef struct {
67     u32     keyid[2];       /* 64 bit keyid */
68     byte    sig_class;      /* sig classification */
69     byte    digest_algo;    /* algorithm used for digest */
70     byte    pubkey_algo;    /* algorithm used for public key scheme */
71     byte    last;           /* a stupid flag */
72 } PKT_onepass_sig;
73
74
75 typedef struct {
76     u32     keyid[2];       /* 64 bit keyid */
77     ulong   local_id;       /* internal use, valid if > 0 */
78     u32     timestamp;      /* signature made */
79     byte    version;
80     byte    sig_class;      /* sig classification, append for MD calculation*/
81     byte    pubkey_algo;    /* algorithm used for public key scheme */
82                             /* (PUBKEY_ALGO_xxx) */
83     byte digest_algo;       /* algorithm used for digest (DIGEST_ALGO_xxxx) */
84     byte *hashed_data;      /* all subpackets with hashed  data (v4 only) */
85     byte *unhashed_data;    /* ditto for unhashed data */
86     byte digest_start[2];   /* first 2 bytes of the digest */
87     union {
88       struct {
89         MPI  a, b;            /* integers with the digest */
90       } elg;
91       struct {
92         MPI  r, s;            /* integers with the digest */
93       } dsa;
94       struct {
95         MPI  rsa_integer;     /* the encrypted digest */
96       } rsa;
97     } d;
98 } PKT_signature;
99
100
101 typedef struct {
102     u32     timestamp;      /* certificate made */
103     u16     valid_days;     /* valid for this number of days */
104     byte    hdrbytes;       /* number of header bytes */
105     byte    version;
106     byte    pubkey_algo;    /* algorithm used for public key scheme */
107     ulong   local_id;       /* internal use, valid if > 0 */
108     union {
109       struct {
110         MPI p;              /* prime */
111         MPI g;              /* group generator */
112         MPI y;              /* g^x mod p */
113       } elg;
114       struct {
115         MPI p;              /* prime */
116         MPI q;              /* group order */
117         MPI g;              /* group generator */
118         MPI y;              /* g^x mod p */
119       } dsa;
120       struct {
121         MPI rsa_n;          /* public modulus */
122         MPI rsa_e;          /* public exponent */
123       } rsa;
124     } d;
125 } PKT_public_cert;
126
127 typedef struct {
128     u32     timestamp;      /* certificate made */
129     u16     valid_days;     /* valid for this number of days */
130     byte    hdrbytes;       /* number of header bytes */
131     byte    version;
132     byte    pubkey_algo;    /* algorithm used for public key scheme */
133     union {
134       struct {
135         MPI p;              /* prime */
136         MPI g;              /* group generator */
137         MPI y;              /* g^x mod p */
138         MPI x;              /* secret exponent */
139         u16 csum;           /* checksum */
140         byte is_protected;  /* The above infos are protected and must */
141                             /* be decrypteded before use. */
142         struct {
143             byte algo;  /* cipher used to protect the secret informations*/
144             byte s2k;
145             byte hash;
146             byte salt[8];
147             byte count;
148             byte iv[8]; /* initialization vector for CFB mode */
149         } protect;          /* when protected, the MPIs above are pointers
150                              * to plain storage */
151       } elg;
152       struct {
153         MPI p;              /* prime */
154         MPI q;              /* group order */
155         MPI g;              /* group generator */
156         MPI y;              /* g^x mod p */
157         MPI x;              /* secret exponent */
158         u16 csum;           /* checksum */
159         byte is_protected;  /* The above infos are protected and must */
160                             /* be decrypteded before use. */
161         struct {
162             byte algo;  /* cipher used to protect the secret informations*/
163             byte s2k;
164             byte hash;
165             byte salt[8];
166             byte count;
167             byte iv[8]; /* initialization vector for CFB mode */
168         } protect;          /* when protected, the MPIs above are pointers
169                              * to plain storage */
170       } dsa;
171       struct {
172         MPI rsa_n;          /* public modulus */
173         MPI rsa_e;          /* public exponent */
174         MPI rsa_d;          /* secret descryption exponent */
175         MPI rsa_p;          /* secret first prime number */
176         MPI rsa_q;          /* secret second prime number */
177         MPI rsa_u;          /* secret multiplicative inverse */
178         u16 csum;           /* checksum */
179         byte is_protected;  /* The above infos are protected and must */
180                             /* be decrypteded before use */
181         byte protect_algo;  /* cipher used to protect the secret informations*/
182         union {             /* information for the protection */
183           struct {
184             byte iv[8];     /* initialization vector for CFB mode */
185                             /* when protected, the MPIs above are pointers
186                              * to plain storage */
187           } blowfish;
188         } protect;
189       } rsa;
190     } d;
191 } PKT_secret_cert;
192
193
194 typedef struct {
195     int  len;             /* length of data */
196     char data[1];
197 } PKT_comment;
198
199 typedef struct {
200     int  len;             /* length of the name */
201     char name[1];
202 } PKT_user_id;
203
204 typedef struct {
205     u32  len;             /* reserved */
206     byte  algorithm;
207     IOBUF buf;            /* IOBUF reference */
208 } PKT_compressed;
209
210 typedef struct {
211     u32  len;             /* length of encrypted data */
212     IOBUF buf;            /* IOBUF reference */
213 } PKT_encrypted;
214
215 typedef struct {
216     u32  len;             /* length of encrypted data */
217     IOBUF buf;            /* IOBUF reference */
218     int mode;
219     u32 timestamp;
220     int  namelen;
221     char name[1];
222 } PKT_plaintext;
223
224 /* combine all packets into a union */
225 struct packet_struct {
226     pkttype_t pkttype;
227     union {
228         void *generic;
229         PKT_pubkey_enc  *pubkey_enc;    /* PKT_PUBKEY_ENC */
230         PKT_onepass_sig *onepass_sig;   /* PKT_ONEPASS_SIG */
231         PKT_signature   *signature;     /* PKT_SIGNATURE */
232         PKT_public_cert *public_cert;   /* PKT_PUBLIC_CERT */
233         PKT_secret_cert *secret_cert;   /* PKT_SECRET_CERT */
234         PKT_comment     *comment;       /* PKT_COMMENT */
235         PKT_user_id     *user_id;       /* PKT_USER_ID */
236         PKT_compressed  *compressed;    /* PKT_COMPRESSED */
237         PKT_encrypted   *encrypted;     /* PKT_ENCRYPTED */
238         PKT_plaintext   *plaintext;     /* PKT_PLAINTEXT */
239     } pkt;
240 };
241
242 #define init_packet(a) do { (a)->pkttype = 0;           \
243                             (a)->pkt.generic = NULL;    \
244                        } while(0)
245
246 /*-- mainproc.c --*/
247 int proc_packets( IOBUF a );
248 int proc_signature_packets( IOBUF a, STRLIST signedfiles );
249 int proc_encryption_packets( IOBUF a );
250 int list_packets( IOBUF a );
251
252 /*-- parse-packet.c --*/
253 int set_packet_list_mode( int mode );
254 int search_packet( IOBUF inp, PACKET *pkt, int pkttype, ulong *retpos );
255 int parse_packet( IOBUF inp, PACKET *ret_pkt);
256 int copy_all_packets( IOBUF inp, IOBUF out );
257 int copy_some_packets( IOBUF inp, IOBUF out, ulong stopoff );
258 int skip_some_packets( IOBUF inp, unsigned n );
259
260 /*-- build-packet.c --*/
261 int build_packet( IOBUF inp, PACKET *pkt );
262 u32 calc_packet_length( PACKET *pkt );
263 void hash_public_cert( MD_HANDLE md, PKT_public_cert *pkc );
264
265 /*-- free-packet.c --*/
266 void free_pubkey_enc( PKT_pubkey_enc *enc );
267 void free_seckey_enc( PKT_signature *enc );
268 int  digest_algo_from_sig( PKT_signature *sig );
269 void release_public_cert_parts( PKT_public_cert *cert );
270 void free_public_cert( PKT_public_cert *cert );
271 void release_secret_cert_parts( PKT_secret_cert *cert );
272 void free_secret_cert( PKT_secret_cert *cert );
273 void free_user_id( PKT_user_id *uid );
274 void free_comment( PKT_comment *rem );
275 void free_packet( PACKET *pkt );
276 PKT_public_cert *copy_public_cert( PKT_public_cert *d, PKT_public_cert *s );
277 PKT_secret_cert *copy_secret_cert( PKT_secret_cert *d, PKT_secret_cert *s );
278 int cmp_public_certs( PKT_public_cert *a, PKT_public_cert *b );
279 int cmp_public_secret_cert( PKT_public_cert *pkc, PKT_secret_cert *skc );
280 int cmp_user_ids( PKT_user_id *a, PKT_user_id *b );
281
282
283 /*-- sig-check.c --*/
284 int signature_check( PKT_signature *sig, MD_HANDLE digest );
285
286 /*-- seckey-cert.c --*/
287 int is_secret_key_protected( PKT_secret_cert *cert );
288 int check_secret_key( PKT_secret_cert *cert );
289 int protect_secret_key( PKT_secret_cert *cert, DEK *dek );
290
291 /*-- pubkey-enc.c --*/
292 int get_session_key( PKT_pubkey_enc *k, DEK *dek );
293
294 /*-- compress.c --*/
295 int handle_compressed( PKT_compressed *cd,
296                        int (*callback)(IOBUF, void *), void *passthru );
297
298 /*-- encr-data.c --*/
299 int decrypt_data( PKT_encrypted *ed, DEK *dek );
300 int encrypt_data( PKT_encrypted *ed, DEK *dek );
301
302 /*-- plaintext.c --*/
303 int handle_plaintext( PKT_plaintext *pt, md_filter_context_t *mfx );
304 int ask_for_detached_datafile( md_filter_context_t *mfx, const char *inname );
305
306 /*-- comment.c --*/
307 int write_comment( IOBUF out, const char *s );
308
309 /*-- sign.c --*/
310 int make_keysig_packet( PKT_signature **ret_sig, PKT_public_cert *pkc,
311                         PKT_user_id *uid, PKT_secret_cert *skc,
312                         int sigclass, int digest_algo );
313
314 #endif /*G10_PACKET_H*/