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