* import.c (parse_import_options), export.c (parse_export_options): Fix
[gnupg.git] / g10 / packet.h
1 /* packet.h - packet definitions
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002 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 #include "global.h"
30
31 #define DEBUG_PARSE_PACKET 1
32
33 typedef enum {
34         PKT_NONE           =0,
35         PKT_PUBKEY_ENC     =1, /* public key encrypted packet */
36         PKT_SIGNATURE      =2, /* secret key encrypted packet */
37         PKT_SYMKEY_ENC     =3, /* session key packet (OpenPGP)*/
38         PKT_ONEPASS_SIG    =4, /* one pass sig packet (OpenPGP)*/
39         PKT_SECRET_KEY     =5, /* secret key */
40         PKT_PUBLIC_KEY     =6, /* public key */
41         PKT_SECRET_SUBKEY  =7, /* secret subkey (OpenPGP) */
42         PKT_COMPRESSED     =8, /* compressed data packet */
43         PKT_ENCRYPTED      =9, /* conventional encrypted data */
44         PKT_MARKER        =10, /* marker packet (OpenPGP) */
45         PKT_PLAINTEXT     =11, /* plaintext data with filename and mode */
46         PKT_RING_TRUST    =12, /* keyring trust packet */
47         PKT_USER_ID       =13, /* user id packet */
48         PKT_PUBLIC_SUBKEY =14, /* public subkey (OpenPGP) */
49         PKT_OLD_COMMENT   =16, /* comment packet from an OpenPGP draft */
50         PKT_ATTRIBUTE     =17, /* PGP's attribute packet */
51         PKT_ENCRYPTED_MDC =18, /* integrity protected encrypted data */
52         PKT_MDC           =19, /* manipulaion detection code packet */
53         PKT_COMMENT       =61, /* new comment packet (private) */
54         PKT_GPG_CONTROL   =63  /* internal control packet */
55 } pkttype_t;
56
57 typedef struct packet_struct PACKET;
58
59 /* PKT_GPG_CONTROL types */
60 typedef enum {
61     CTRLPKT_CLEARSIGN_START = 1,
62     CTRLPKT_PIPEMODE = 2,
63     CTRLPKT_PLAINTEXT_MARK =3
64 } ctrlpkttype_t;
65
66 typedef enum {
67     PREFTYPE_NONE = 0,
68     PREFTYPE_SYM = 1,
69     PREFTYPE_HASH = 2,
70     PREFTYPE_ZIP = 3
71 } preftype_t;
72
73 typedef struct {
74     byte type; 
75     byte value;
76 } prefitem_t;
77
78 typedef struct {
79     int  mode;
80     byte hash_algo;
81     byte salt[8];
82     u32  count;
83 } STRING2KEY;
84
85 typedef struct {
86     byte version;
87     byte cipher_algo;    /* cipher algorithm used */
88     STRING2KEY s2k;
89     byte seskeylen;   /* keylength in byte or 0 for no seskey */
90     byte seskey[1];
91 } PKT_symkey_enc;
92
93 typedef struct {
94     u32     keyid[2];       /* 64 bit keyid */
95     byte    version;
96     byte    pubkey_algo;    /* algorithm used for public key scheme */
97     byte    throw_keyid;
98     MPI     data[PUBKEY_MAX_NENC];
99 } PKT_pubkey_enc;
100
101
102 typedef struct {
103     u32     keyid[2];       /* 64 bit keyid */
104     byte    sig_class;      /* sig classification */
105     byte    digest_algo;    /* algorithm used for digest */
106     byte    pubkey_algo;    /* algorithm used for public key scheme */
107     byte    last;           /* a stupid flag */
108 } PKT_onepass_sig;
109
110
111 typedef struct {
112     size_t size;  /* allocated */
113     size_t len;   /* used */
114     byte data[1];
115 } subpktarea_t;
116
117 struct revocation_key {
118   byte class;
119   byte algid;
120   byte fpr[MAX_FINGERPRINT_LEN];
121 };
122
123 typedef struct {
124     ulong   local_id;       /* internal use, valid if > 0 */
125     struct {
126         unsigned checked:1; /* signature has been checked */
127         unsigned valid:1;   /* signature is good (if checked is set) */
128         unsigned unknown_critical:1;
129         unsigned exportable:1;
130         unsigned revocable:1;
131         unsigned policy_url:1; /* Policy URL is present */
132         unsigned notation:1; /* At least one notation is present */
133         unsigned expired:1;
134     } flags;
135     u32     keyid[2];       /* 64 bit keyid */
136     u32     timestamp;      /* signature made */
137     u32     expiredate;     /* expires at this date or 0 if not at all */
138     byte    version;
139     byte    sig_class;      /* sig classification, append for MD calculation*/
140     byte    pubkey_algo;    /* algorithm used for public key scheme */
141                             /* (PUBKEY_ALGO_xxx) */
142     byte    digest_algo;    /* algorithm used for digest (DIGEST_ALGO_xxxx) */
143     struct revocation_key **revkey;
144     int numrevkeys;
145     subpktarea_t *hashed;    /* all subpackets with hashed  data (v4 only) */
146     subpktarea_t *unhashed;  /* ditto for unhashed data */
147     byte digest_start[2];   /* first 2 bytes of the digest */
148     MPI  data[PUBKEY_MAX_NSIG];
149 } PKT_signature;
150
151 #define ATTRIB_IMAGE 1
152
153 /* This is the cooked form of attributes */
154 struct user_attribute {
155   byte type;
156   const byte *data;
157   u32 len;
158 };
159
160 typedef struct {
161     int ref;              /* reference counter */
162     int len;              /* length of the name */
163     struct user_attribute *attribs;
164     int numattribs;
165     byte *attrib_data;    /* if this is not NULL, the packet is an attribute */
166     unsigned long attrib_len;
167     int help_key_usage;
168     u32 help_key_expire;
169     int is_primary;
170     int is_revoked;
171     int is_expired;
172     u32 expiredate;       /* expires at this date or 0 if not at all */
173     prefitem_t *prefs;    /* list of preferences (may be NULL)*/
174     int mdc_feature;
175     u32 created;          /* according to the self-signature */
176     byte selfsigversion;
177     char name[1];
178 } PKT_user_id;
179
180
181 /****************
182  * Note about the pkey/skey elements:  We assume that the secret keys
183  * has the same elemts as the public key at the begin of the array, so
184  * that npkey < nskey and it is possible to compare the secret and
185  * public keys by comparing the first npkey elements of pkey againts skey.
186  */
187 typedef struct {
188     u32     timestamp;      /* key made */
189     u32     expiredate;     /* expires at this date or 0 if not at all */
190     u32     max_expiredate; /* must not expire past this date */
191     byte    hdrbytes;       /* number of header bytes */
192     byte    version;
193     byte    selfsigversion; /* highest version of all of the self-sigs */
194     byte    pubkey_algo;    /* algorithm used for public key scheme */
195     byte    pubkey_usage;   /* for now only used to pass it to getkey() */
196     byte    req_usage;      /* hack to pass a request to getkey() */
197     byte    req_algo;       /* Ditto */
198     u32     has_expired;    /* set to the expiration date if expired */ 
199     int     is_revoked;     /* key has been revoked */
200     int     is_valid;       /* key (especially subkey) is valid */
201     int     dont_cache;     /* do not cache this */
202     ulong   local_id;       /* internal use, valid if > 0 */
203     u32     main_keyid[2];  /* keyid of the primary key */
204     u32     keyid[2];       /* calculated by keyid_from_pk() */
205     prefitem_t *prefs;      /* list of preferences (may be NULL) */
206     int     mdc_feature;    /* mdc feature set */
207     byte    *namehash;      /* if != NULL: found by this name */
208     PKT_user_id *user_id;   /* if != NULL: found by that uid */
209     struct revocation_key *revkey;
210     int     numrevkeys;
211     MPI     pkey[PUBKEY_MAX_NPKEY];
212 } PKT_public_key;
213
214 typedef struct {
215     u32     timestamp;      /* key made */
216     u32     expiredate;     /* expires at this date or 0 if not at all */
217     u32     max_expiredate; /* must not expire past this date */
218     byte    hdrbytes;       /* number of header bytes */
219     byte    version;
220     byte    pubkey_algo;    /* algorithm used for public key scheme */
221     byte    pubkey_usage;
222     byte    req_usage;
223     byte    req_algo;
224     u32     has_expired;    /* set to the expiration date if expired */ 
225     int     is_revoked;     /* key has been revoked */
226     int     is_valid;       /* key (especially subkey) is valid */
227     u32     main_keyid[2];  /* keyid of the primary key */
228     u32     keyid[2];   
229     byte is_primary;
230     byte is_protected;  /* The secret info is protected and must */
231                         /* be decrypted before use, the protected */
232                         /* MPIs are simply (void*) pointers to memory */
233                         /* and should never be passed to a mpi_xxx() */
234     struct {
235         byte algo;  /* cipher used to protect the secret information*/
236         byte sha1chk;  /* SHA1 is used instead of a 16 bit checksum */ 
237         STRING2KEY s2k;
238         byte ivlen;  /* used length of the iv */
239         byte iv[16]; /* initialization vector for CFB mode */
240     } protect;
241     MPI skey[PUBKEY_MAX_NSKEY];
242     u16 csum;           /* checksum */
243 } PKT_secret_key;
244
245
246 typedef struct {
247     int  len;             /* length of data */
248     char data[1];
249 } PKT_comment;
250
251 typedef struct {
252     u32  len;             /* reserved */
253     byte  new_ctb;
254     byte  algorithm;
255     IOBUF buf;            /* IOBUF reference */
256 } PKT_compressed;
257
258 typedef struct {
259     u32  len;             /* length of encrypted data */
260     int  extralen;        /* this is (blocksize+2) */
261     byte new_ctb;         /* uses a new CTB */
262     byte mdc_method;      /* > 0: integrity protected encrypted data packet */
263     IOBUF buf;            /* IOBUF reference */
264 } PKT_encrypted;
265
266 typedef struct {
267     byte hash[20];
268 } PKT_mdc;
269
270 typedef struct {
271     unsigned int trustval;
272     unsigned int sigcache;
273 } PKT_ring_trust;
274
275 typedef struct {
276     u32  len;             /* length of encrypted data */
277     IOBUF buf;            /* IOBUF reference */
278     byte new_ctb;
279     byte is_partial;      /* partial length encoded */
280     int mode;
281     u32 timestamp;
282     int  namelen;
283     char name[1];
284 } PKT_plaintext;
285
286 typedef struct {
287     int  control;
288     size_t datalen;
289     char data[1];
290 } PKT_gpg_control;
291
292 /* combine all packets into a union */
293 struct packet_struct {
294     pkttype_t pkttype;
295     union {
296         void *generic;
297         PKT_symkey_enc  *symkey_enc;    /* PKT_SYMKEY_ENC */
298         PKT_pubkey_enc  *pubkey_enc;    /* PKT_PUBKEY_ENC */
299         PKT_onepass_sig *onepass_sig;   /* PKT_ONEPASS_SIG */
300         PKT_signature   *signature;     /* PKT_SIGNATURE */
301         PKT_public_key  *public_key;    /* PKT_PUBLIC_[SUB)KEY */
302         PKT_secret_key  *secret_key;    /* PKT_SECRET_[SUB]KEY */
303         PKT_comment     *comment;       /* PKT_COMMENT */
304         PKT_user_id     *user_id;       /* PKT_USER_ID */
305         PKT_compressed  *compressed;    /* PKT_COMPRESSED */
306         PKT_encrypted   *encrypted;     /* PKT_ENCRYPTED[_MDC] */
307         PKT_mdc         *mdc;           /* PKT_MDC */
308         PKT_ring_trust  *ring_trust;    /* PKT_RING_TRUST */
309         PKT_plaintext   *plaintext;     /* PKT_PLAINTEXT */
310         PKT_gpg_control *gpg_control;   /* PKT_GPG_CONTROL */
311     } pkt;
312 };
313
314 #define init_packet(a) do { (a)->pkttype = 0;           \
315                             (a)->pkt.generic = NULL;    \
316                        } while(0)
317
318 typedef enum {
319     SIGSUBPKT_TEST_CRITICAL=-3,
320     SIGSUBPKT_LIST_UNHASHED=-2,
321     SIGSUBPKT_LIST_HASHED  =-1,
322     SIGSUBPKT_NONE         = 0,
323     SIGSUBPKT_SIG_CREATED  = 2, /* signature creation time */
324     SIGSUBPKT_SIG_EXPIRE   = 3, /* signature expiration time */
325     SIGSUBPKT_EXPORTABLE   = 4, /* exportable */
326     SIGSUBPKT_TRUST        = 5, /* trust signature */
327     SIGSUBPKT_REGEXP       = 6, /* regular expression */
328     SIGSUBPKT_REVOCABLE    = 7, /* revocable */
329     SIGSUBPKT_KEY_EXPIRE   = 9, /* key expiration time */
330     SIGSUBPKT_ARR          =10, /* additional recipient request */
331     SIGSUBPKT_PREF_SYM     =11, /* preferred symmetric algorithms */
332     SIGSUBPKT_REV_KEY      =12, /* revocation key */
333     SIGSUBPKT_ISSUER       =16, /* issuer key ID */
334     SIGSUBPKT_NOTATION     =20, /* notation data */
335     SIGSUBPKT_PREF_HASH    =21, /* preferred hash algorithms */
336     SIGSUBPKT_PREF_COMPR   =22, /* preferred compression algorithms */
337     SIGSUBPKT_KS_FLAGS     =23, /* key server preferences */
338     SIGSUBPKT_PREF_KS      =24, /* preferred key server */
339     SIGSUBPKT_PRIMARY_UID  =25, /* primary user id */
340     SIGSUBPKT_POLICY       =26, /* policy URL */
341     SIGSUBPKT_KEY_FLAGS    =27, /* key flags */
342     SIGSUBPKT_SIGNERS_UID  =28, /* signer's user id */
343     SIGSUBPKT_REVOC_REASON =29, /* reason for revocation */
344     SIGSUBPKT_FEATURES     =30, /* feature flags */
345     SIGSUBPKT_PRIV_VERIFY_CACHE =101, /* cache verification result (obsolete)*/
346
347     SIGSUBPKT_FLAG_CRITICAL=128
348 } sigsubpkttype_t;
349
350
351 /*-- mainproc.c --*/
352 int proc_packets( void *ctx, IOBUF a );
353 int proc_signature_packets( void *ctx, IOBUF a,
354                             STRLIST signedfiles, const char *sigfile );
355 int proc_encryption_packets( void *ctx, IOBUF a );
356 int list_packets( IOBUF a );
357
358 /*-- parse-packet.c --*/
359 int set_packet_list_mode( int mode );
360
361 #if DEBUG_PARSE_PACKET
362 int dbg_search_packet( IOBUF inp, PACKET *pkt, off_t *retpos, int with_uid,
363                        const char* file, int lineno  );
364 int dbg_parse_packet( IOBUF inp, PACKET *ret_pkt,
365                       const char* file, int lineno );
366 int dbg_copy_all_packets( IOBUF inp, IOBUF out,
367                           const char* file, int lineno  );
368 int dbg_copy_some_packets( IOBUF inp, IOBUF out, off_t stopoff,
369                            const char* file, int lineno  );
370 int dbg_skip_some_packets( IOBUF inp, unsigned n,
371                            const char* file, int lineno );
372 #define search_packet( a,b,c,d )   \
373              dbg_search_packet( (a), (b), (c), (d), __FILE__, __LINE__ )
374 #define parse_packet( a, b )  \
375              dbg_parse_packet( (a), (b), __FILE__, __LINE__ )
376 #define copy_all_packets( a,b )  \
377              dbg_copy_all_packets((a),(b), __FILE__, __LINE__ )
378 #define copy_some_packets( a,b,c ) \
379              dbg_copy_some_packets((a),(b),(c), __FILE__, __LINE__ )
380 #define skip_some_packets( a,b ) \
381              dbg_skip_some_packets((a),(b), __FILE__, __LINE__ )
382 #else
383 int search_packet( IOBUF inp, PACKET *pkt, off_t *retpos, int with_uid );
384 int parse_packet( IOBUF inp, PACKET *ret_pkt);
385 int copy_all_packets( IOBUF inp, IOBUF out );
386 int copy_some_packets( IOBUF inp, IOBUF out, off_t stopoff );
387 int skip_some_packets( IOBUF inp, unsigned n );
388 #endif
389
390 const byte *enum_sig_subpkt ( const subpktarea_t *subpkts,
391                               sigsubpkttype_t reqtype,
392                               size_t *ret_n, int *start, int *critical );
393 const byte *parse_sig_subpkt ( const subpktarea_t *buffer,
394                                sigsubpkttype_t reqtype,
395                                size_t *ret_n );
396 const byte *parse_sig_subpkt2 ( PKT_signature *sig,
397                                 sigsubpkttype_t reqtype,
398                                 size_t *ret_n );
399 int parse_one_sig_subpkt( const byte *buffer, size_t n, int type );
400 void parse_revkeys(PKT_signature *sig);
401 int parse_attribute_subpkts(PKT_user_id *uid);
402 void make_attribute_uidname(PKT_user_id *uid);
403 PACKET *create_gpg_control ( ctrlpkttype_t type,
404                              const byte *data,
405                              size_t datalen );
406
407 /*-- build-packet.c --*/
408 int build_packet( IOBUF inp, PACKET *pkt );
409 u32 calc_packet_length( PACKET *pkt );
410 void hash_public_key( MD_HANDLE md, PKT_public_key *pk );
411 void build_sig_subpkt( PKT_signature *sig, sigsubpkttype_t type,
412                         const byte *buffer, size_t buflen );
413 void build_sig_subpkt_from_sig( PKT_signature *sig );
414 int  delete_sig_subpkt(subpktarea_t *buffer, sigsubpkttype_t type );
415 void build_attribute_subpkt(PKT_user_id *uid,byte type,
416                             const void *buf,u32 buflen,
417                             const void *header,u32 headerlen);
418
419 /*-- free-packet.c --*/
420 void free_symkey_enc( PKT_symkey_enc *enc );
421 void free_pubkey_enc( PKT_pubkey_enc *enc );
422 void free_seckey_enc( PKT_signature *enc );
423 int  digest_algo_from_sig( PKT_signature *sig );
424 void release_public_key_parts( PKT_public_key *pk );
425 void free_public_key( PKT_public_key *key );
426 void release_secret_key_parts( PKT_secret_key *sk );
427 void free_secret_key( PKT_secret_key *sk );
428 void free_attributes(PKT_user_id *uid);
429 void free_user_id( PKT_user_id *uid );
430 void free_comment( PKT_comment *rem );
431 void free_packet( PACKET *pkt );
432 prefitem_t *copy_prefs (const prefitem_t *prefs);
433 PKT_public_key *copy_public_key( PKT_public_key *d, PKT_public_key *s );
434 void copy_public_parts_to_secret_key( PKT_public_key *pk, PKT_secret_key *sk );
435 PKT_secret_key *copy_secret_key( PKT_secret_key *d, PKT_secret_key *s );
436 PKT_signature *copy_signature( PKT_signature *d, PKT_signature *s );
437 PKT_user_id *scopy_user_id (PKT_user_id *sd );
438 int cmp_public_keys( PKT_public_key *a, PKT_public_key *b );
439 int cmp_secret_keys( PKT_secret_key *a, PKT_secret_key *b );
440 int cmp_signatures( PKT_signature *a, PKT_signature *b );
441 int cmp_public_secret_key( PKT_public_key *pk, PKT_secret_key *sk );
442 int cmp_user_ids( PKT_user_id *a, PKT_user_id *b );
443
444
445 /*-- sig-check.c --*/
446 int signature_check( PKT_signature *sig, MD_HANDLE digest );
447 int signature_check2( PKT_signature *sig, MD_HANDLE digest,
448                       u32 *r_expiredate, int *r_expired );
449
450 /*-- seckey-cert.c --*/
451 int is_secret_key_protected( PKT_secret_key *sk );
452 int check_secret_key( PKT_secret_key *sk, int retries );
453 int protect_secret_key( PKT_secret_key *sk, DEK *dek );
454
455 /*-- pubkey-enc.c --*/
456 int get_session_key( PKT_pubkey_enc *k, DEK *dek );
457 int get_override_session_key( DEK *dek, const char *string );
458
459 /*-- compress.c --*/
460 int handle_compressed( void *ctx, PKT_compressed *cd,
461                        int (*callback)(IOBUF, void *), void *passthru );
462
463 /*-- encr-data.c --*/
464 int decrypt_data( void *ctx, PKT_encrypted *ed, DEK *dek );
465
466 /*-- plaintext.c --*/
467 int handle_plaintext( PKT_plaintext *pt, md_filter_context_t *mfx,
468                                         int nooutput, int clearsig );
469 int ask_for_detached_datafile( MD_HANDLE md, MD_HANDLE md2,
470                                const char *inname, int textmode );
471
472 /*-- comment.c --*/
473 int write_comment( IOBUF out, const char *s );
474
475 /*-- sign.c --*/
476 int make_keysig_packet( PKT_signature **ret_sig, PKT_public_key *pk,
477                         PKT_user_id *uid, PKT_public_key *subpk,
478                         PKT_secret_key *sk, int sigclass, int digest_algo,
479                         int sigversion, u32 timestamp, u32 duration,
480                         int (*mksubpkt)(PKT_signature *, void *),
481                         void *opaque  );
482 int update_keysig_packet( PKT_signature **ret_sig,
483                       PKT_signature *orig_sig,
484                       PKT_public_key *pk,
485                       PKT_user_id *uid, 
486                       PKT_secret_key *sk,
487                       int (*mksubpkt)(PKT_signature *, void *),
488                       void *opaque   );
489
490 /*-- keygen.c --*/
491 PKT_user_id *generate_user_id(void);
492
493 #endif /*G10_PACKET_H*/