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