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