Some bug fixes of the last release
[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_SYMKEY_ENC     =3, /* session key packet (OpenPGP)*/
35         PKT_ONEPASS_SIG    =4, /* one pass sig packet (OpenPGP)*/
36         PKT_SECRET_KEY     =5, /* secret key */
37         PKT_PUBLIC_KEY     =6, /* public key */
38         PKT_SECRET_SUBKEY  =7, /* secret subkey (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_PUBLIC_SUBKEY =14, /* public subkey (OpenPGP) */
46         PKT_OLD_COMMENT   =16, /* comment packet from an OpenPGP draft */
47         PKT_COMMENT       =61  /* new comment packet (private) */
48 } pkttype_t;
49
50 typedef struct packet_struct PACKET;
51
52 typedef struct {
53     byte mode;
54     byte hash_algo;
55     byte salt[8];
56     u32  count;
57 } STRING2KEY;
58
59 typedef struct {
60     byte version;
61     byte cipher_algo;    /* cipher algorithm used */
62     STRING2KEY s2k;
63     byte seskeylen;   /* keylength in byte or 0 for no seskey */
64     byte seskey[1];
65 } PKT_symkey_enc;
66
67 typedef struct {
68     u32     keyid[2];       /* 64 bit keyid */
69     byte    version;
70     byte    pubkey_algo;    /* algorithm used for public key scheme */
71     byte    throw_keyid;
72     MPI     data[PUBKEY_MAX_NENC];
73 } PKT_pubkey_enc;
74
75
76 typedef struct {
77     u32     keyid[2];       /* 64 bit keyid */
78     byte    sig_class;      /* sig classification */
79     byte    digest_algo;    /* algorithm used for digest */
80     byte    pubkey_algo;    /* algorithm used for public key scheme */
81     byte    last;           /* a stupid flag */
82 } PKT_onepass_sig;
83
84
85 typedef struct {
86     ulong   local_id;       /* internal use, valid if > 0 */
87     struct {
88         unsigned checked:1; /* signature has been checked */
89         unsigned valid:1;   /* signature is good (if checked is set) */
90         unsigned unknown_critical:1;
91     } flags;
92     u32     keyid[2];       /* 64 bit keyid */
93     u32     timestamp;      /* signature made */
94     byte    version;
95     byte    sig_class;      /* sig classification, append for MD calculation*/
96     byte    pubkey_algo;    /* algorithm used for public key scheme */
97                             /* (PUBKEY_ALGO_xxx) */
98     byte digest_algo;       /* algorithm used for digest (DIGEST_ALGO_xxxx) */
99     byte *hashed_data;      /* all subpackets with hashed  data (v4 only) */
100     byte *unhashed_data;    /* ditto for unhashed data */
101     byte digest_start[2];   /* first 2 bytes of the digest */
102     MPI  data[PUBKEY_MAX_NSIG];
103 } PKT_signature;
104
105
106 /****************
107  * Note about the pkey/skey elements:  We assume that the secret keys
108  * has the same elemts as the public key at the begin of the array, so
109  * that npkey < nskey and it is possible to compare the secret and
110  * public keys by comparing the first npkey elements of pkey againts skey.
111  */
112 typedef struct {
113     u32     timestamp;      /* key made */
114     u32     expiredate;     /* expires at this date or 0 if not at all */
115     byte    hdrbytes;       /* number of header bytes */
116     byte    version;
117     byte    pubkey_algo;    /* algorithm used for public key scheme */
118     byte    pubkey_usage;   /* for now only used to pass it to getkey() */
119     ulong   local_id;       /* internal use, valid if > 0 */
120     u32     keyid[2];       /* calculated by keyid_from_pk() */
121     byte    *namehash;      /* if != NULL: found by this name */
122     MPI     pkey[PUBKEY_MAX_NPKEY];
123 } PKT_public_key;
124
125 typedef struct {
126     u32     timestamp;      /* key made */
127     u32     expiredate;     /* expires at this date or 0 if not at all */
128     byte    hdrbytes;       /* number of header bytes */
129     byte    version;
130     byte    pubkey_algo;    /* algorithm used for public key scheme */
131     byte    pubkey_usage;
132     byte is_protected;  /* The secret info is protected and must */
133                         /* be decrypted before use, the protected */
134                         /* MPIs are simply (void*) pointers to memory */
135                         /* and should never be passed to a mpi_xxx() */
136     struct {
137         byte algo;  /* cipher used to protect the secret information*/
138         STRING2KEY s2k;
139         byte iv[8]; /* initialization vector for CFB mode */
140     } protect;
141     MPI skey[PUBKEY_MAX_NSKEY];
142     u16 csum;           /* checksum */
143 } PKT_secret_key;
144
145
146 typedef struct {
147     int  len;             /* length of data */
148     char data[1];
149 } PKT_comment;
150
151 typedef struct {
152     int  len;             /* length of the name */
153     char name[1];
154 } PKT_user_id;
155
156 typedef struct {
157     u32  len;             /* reserved */
158     byte  new_ctb;
159     byte  algorithm;
160     IOBUF buf;            /* IOBUF reference */
161 } PKT_compressed;
162
163 typedef struct {
164     u32  len;             /* length of encrypted data */
165     byte  new_ctb;
166     IOBUF buf;            /* IOBUF reference */
167 } PKT_encrypted;
168
169 typedef struct {
170     u32  len;             /* length of encrypted data */
171     IOBUF buf;            /* IOBUF reference */
172     byte new_ctb;
173     int mode;
174     u32 timestamp;
175     int  namelen;
176     char name[1];
177 } PKT_plaintext;
178
179 /* combine all packets into a union */
180 struct packet_struct {
181     pkttype_t pkttype;
182     union {
183         void *generic;
184         PKT_symkey_enc  *symkey_enc;    /* PKT_SYMKEY_ENC */
185         PKT_pubkey_enc  *pubkey_enc;    /* PKT_PUBKEY_ENC */
186         PKT_onepass_sig *onepass_sig;   /* PKT_ONEPASS_SIG */
187         PKT_signature   *signature;     /* PKT_SIGNATURE */
188         PKT_public_key  *public_key;    /* PKT_PUBLIC_[SUB)KEY */
189         PKT_secret_key  *secret_key;    /* PKT_SECRET_[SUB]KEY */
190         PKT_comment     *comment;       /* PKT_COMMENT */
191         PKT_user_id     *user_id;       /* PKT_USER_ID */
192         PKT_compressed  *compressed;    /* PKT_COMPRESSED */
193         PKT_encrypted   *encrypted;     /* PKT_ENCRYPTED */
194         PKT_plaintext   *plaintext;     /* PKT_PLAINTEXT */
195     } pkt;
196 };
197
198 #define init_packet(a) do { (a)->pkttype = 0;           \
199                             (a)->pkt.generic = NULL;    \
200                        } while(0)
201
202 typedef enum {
203     SIGSUBPKT_LIST_UNHASHED=-2,
204     SIGSUBPKT_LIST_HASHED  =-1,
205     SIGSUBPKT_NONE         = 0,
206     SIGSUBPKT_SIG_CREATED  = 2, /* signature creation time */
207     SIGSUBPKT_SIG_EXPIRE   = 3, /* signature expiration time */
208     SIGSUBPKT_EXPORTABLE   = 4, /* exportable */
209     SIGSUBPKT_TRUST        = 5, /* trust signature */
210     SIGSUBPKT_REGEXP       = 6, /* regular expression */
211     SIGSUBPKT_REVOCABLE    = 7, /* revocable */
212     SIGSUBPKT_KEY_EXPIRE   = 9, /* key expiration time */
213     SIGSUBPKT_ARR          =10, /* additional recipient request */
214     SIGSUBPKT_PREF_SYM     =11, /* preferred symmetric algorithms */
215     SIGSUBPKT_REV_KEY      =12, /* revocation key */
216     SIGSUBPKT_ISSUER       =16, /* issuer key ID */
217     SIGSUBPKT_NOTATION     =20, /* notation data */
218     SIGSUBPKT_PREF_HASH    =21, /* preferred hash algorithms */
219     SIGSUBPKT_PREF_COMPR   =22, /* preferred compression algorithms */
220     SIGSUBPKT_KS_FLAGS     =23, /* key server preferences */
221     SIGSUBPKT_PREF_KS      =24, /* preferred key server */
222     SIGSUBPKT_PRIMARY_UID  =25, /* primary user id */
223     SIGSUBPKT_POLICY       =26, /* policy URL */
224     SIGSUBPKT_KEY_FLAGS    =27, /* key flags */
225     SIGSUBPKT_SIGNERS_UID  =28, /* signer's user id */
226     SIGSUBPKT_PRIV_ADD_SIG =101 /* signatur is also valid for this uid */
227 } sigsubpkttype_t;
228
229
230 /*-- mainproc.c --*/
231 int proc_packets( IOBUF a );
232 int proc_signature_packets( IOBUF a, STRLIST signedfiles, const char *sigfile );
233 int proc_encryption_packets( IOBUF a );
234 int list_packets( IOBUF a );
235
236 /*-- parse-packet.c --*/
237 int set_packet_list_mode( int mode );
238 int search_packet( IOBUF inp, PACKET *pkt, int pkttype, ulong *retpos );
239 int parse_packet( IOBUF inp, PACKET *ret_pkt);
240 int copy_all_packets( IOBUF inp, IOBUF out );
241 int copy_some_packets( IOBUF inp, IOBUF out, ulong stopoff );
242 int skip_some_packets( IOBUF inp, unsigned n );
243 const byte *parse_sig_subpkt( const byte *buffer,
244                               sigsubpkttype_t reqtype, size_t *ret_n );
245 const byte *parse_sig_subpkt2( PKT_signature *sig,
246                                sigsubpkttype_t reqtype, size_t *ret_n );
247
248 /*-- build-packet.c --*/
249 int build_packet( IOBUF inp, PACKET *pkt );
250 u32 calc_packet_length( PACKET *pkt );
251 void hash_public_key( MD_HANDLE md, PKT_public_key *pk );
252 void build_sig_subpkt( PKT_signature *sig, sigsubpkttype_t type,
253                         const byte *buffer, size_t buflen );
254 void build_sig_subpkt_from_sig( PKT_signature *sig );
255
256 /*-- free-packet.c --*/
257 void free_symkey_enc( PKT_symkey_enc *enc );
258 void free_pubkey_enc( PKT_pubkey_enc *enc );
259 void free_seckey_enc( PKT_signature *enc );
260 int  digest_algo_from_sig( PKT_signature *sig );
261 void release_public_key_parts( PKT_public_key *pk );
262 void free_public_key( PKT_public_key *key );
263 void release_secret_key_parts( PKT_secret_key *sk );
264 void free_secret_key( PKT_secret_key *sk );
265 void free_user_id( PKT_user_id *uid );
266 void free_comment( PKT_comment *rem );
267 void free_packet( PACKET *pkt );
268 PKT_public_key *copy_public_key( PKT_public_key *d, PKT_public_key *s );
269 PKT_public_key *copy_public_key_new_namehash( PKT_public_key *d,
270                                               PKT_public_key *s,
271                                               const byte *namehash );
272 PKT_secret_key *copy_secret_key( PKT_secret_key *d, PKT_secret_key *s );
273 PKT_signature *copy_signature( PKT_signature *d, PKT_signature *s );
274 PKT_user_id *copy_user_id( PKT_user_id *d, PKT_user_id *s );
275 int cmp_public_keys( PKT_public_key *d, PKT_public_key *s );
276 int cmp_signatures( PKT_signature *a, PKT_signature *b );
277 int cmp_public_secret_key( PKT_public_key *pk, PKT_secret_key *sk );
278 int cmp_user_ids( PKT_user_id *a, PKT_user_id *b );
279
280
281 /*-- sig-check.c --*/
282 int signature_check( PKT_signature *sig, MD_HANDLE digest );
283
284 /*-- seckey-cert.c --*/
285 int is_secret_key_protected( PKT_secret_key *sk );
286 int check_secret_key( PKT_secret_key *sk, int retries );
287 int protect_secret_key( PKT_secret_key *sk, DEK *dek );
288
289 /*-- pubkey-enc.c --*/
290 int get_session_key( PKT_pubkey_enc *k, DEK *dek );
291
292 /*-- compress.c --*/
293 int handle_compressed( PKT_compressed *cd,
294                        int (*callback)(IOBUF, void *), void *passthru );
295
296 /*-- encr-data.c --*/
297 int decrypt_data( PKT_encrypted *ed, DEK *dek );
298 int encrypt_data( PKT_encrypted *ed, DEK *dek );
299
300 /*-- plaintext.c --*/
301 int handle_plaintext( PKT_plaintext *pt, md_filter_context_t *mfx,
302                                         int nooutput, int clearsig );
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_key *pk,
310                         PKT_user_id *uid, PKT_public_key *subpk,
311                         PKT_secret_key *sk,
312                         int sigclass, int digest_algo,
313                         int (*mksubpkt)(PKT_signature *, void *),
314                         void *opaque  );
315
316 /*-- keygen.c --*/
317 PKT_user_id *generate_user_id(void);
318
319 #endif /*G10_PACKET_H*/