* packet.h, tdbio.h, tdbio.c (tdbio_read_record, tdbio_write_record),
[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, /* manipulation 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     byte    trust_depth;
144     byte    trust_value;
145     const byte *trust_regexp;
146     struct revocation_key **revkey;
147     int numrevkeys;
148     subpktarea_t *hashed;    /* all subpackets with hashed  data (v4 only) */
149     subpktarea_t *unhashed;  /* ditto for unhashed data */
150     byte digest_start[2];   /* first 2 bytes of the digest */
151     MPI  data[PUBKEY_MAX_NSIG];
152 } PKT_signature;
153
154 #define ATTRIB_IMAGE 1
155
156 /* This is the cooked form of attributes */
157 struct user_attribute {
158   byte type;
159   const byte *data;
160   u32 len;
161 };
162
163 typedef struct {
164     int ref;              /* reference counter */
165     int len;              /* length of the name */
166     struct user_attribute *attribs;
167     int numattribs;
168     byte *attrib_data;    /* if this is not NULL, the packet is an attribute */
169     unsigned long attrib_len;
170     int help_key_usage;
171     u32 help_key_expire;
172     int help_full_count;
173     int help_marginal_count;
174     int is_primary;
175     int is_revoked;
176     int is_expired;
177     u32 expiredate;       /* expires at this date or 0 if not at all */
178     prefitem_t *prefs;    /* list of preferences (may be NULL)*/
179     int mdc_feature;
180     u32 created;          /* according to the self-signature */
181     byte selfsigversion;
182     char name[1];
183 } PKT_user_id;
184
185
186 /****************
187  * Note about the pkey/skey elements:  We assume that the secret keys
188  * has the same elemts as the public key at the begin of the array, so
189  * that npkey < nskey and it is possible to compare the secret and
190  * public keys by comparing the first npkey elements of pkey againts skey.
191  */
192 typedef struct {
193     u32     timestamp;      /* key made */
194     u32     expiredate;     /* expires at this date or 0 if not at all */
195     u32     max_expiredate; /* must not expire past this date */
196     byte    hdrbytes;       /* number of header bytes */
197     byte    version;
198     byte    selfsigversion; /* highest version of all of the self-sigs */
199     byte    pubkey_algo;    /* algorithm used for public key scheme */
200     byte    pubkey_usage;   /* for now only used to pass it to getkey() */
201     byte    req_usage;      /* hack to pass a request to getkey() */
202     byte    req_algo;       /* Ditto */
203     u32     has_expired;    /* set to the expiration date if expired */ 
204     int     is_revoked;     /* key has been revoked */
205     int     is_valid;       /* key (especially subkey) is valid */
206     int     dont_cache;     /* do not cache this */
207     ulong   local_id;       /* internal use, valid if > 0 */
208     u32     main_keyid[2];  /* keyid of the primary key */
209     u32     keyid[2];       /* calculated by keyid_from_pk() */
210     byte    is_primary;
211     prefitem_t *prefs;      /* list of preferences (may be NULL) */
212     int     mdc_feature;    /* mdc feature set */
213     byte    *namehash;      /* if != NULL: found by this name */
214     PKT_user_id *user_id;   /* if != NULL: found by that uid */
215     struct revocation_key *revkey;
216     int     numrevkeys;
217     u32     trust_timestamp;
218     byte    trust_depth;
219     byte    trust_value;
220     const byte *trust_regexp;
221     MPI     pkey[PUBKEY_MAX_NPKEY];
222 } PKT_public_key;
223
224 typedef struct {
225     u32     timestamp;      /* key made */
226     u32     expiredate;     /* expires at this date or 0 if not at all */
227     u32     max_expiredate; /* must not expire past this date */
228     byte    hdrbytes;       /* number of header bytes */
229     byte    version;
230     byte    pubkey_algo;    /* algorithm used for public key scheme */
231     byte    pubkey_usage;
232     byte    req_usage;
233     byte    req_algo;
234     u32     has_expired;    /* set to the expiration date if expired */ 
235     int     is_revoked;     /* key has been revoked */
236     int     is_valid;       /* key (especially subkey) is valid */
237     u32     main_keyid[2];  /* keyid of the primary key */
238     u32     keyid[2];   
239     byte is_primary;
240     byte is_protected;  /* The secret info is protected and must */
241                         /* be decrypted before use, the protected */
242                         /* MPIs are simply (void*) pointers to memory */
243                         /* and should never be passed to a mpi_xxx() */
244     struct {
245         byte algo;  /* cipher used to protect the secret information*/
246         byte sha1chk;  /* SHA1 is used instead of a 16 bit checksum */ 
247         STRING2KEY s2k;
248         byte ivlen;  /* used length of the iv */
249         byte iv[16]; /* initialization vector for CFB mode */
250     } protect;
251     MPI skey[PUBKEY_MAX_NSKEY];
252     u16 csum;           /* checksum */
253 } PKT_secret_key;
254
255
256 typedef struct {
257     int  len;             /* length of data */
258     char data[1];
259 } PKT_comment;
260
261 typedef struct {
262     u32  len;             /* reserved */
263     byte  new_ctb;
264     byte  algorithm;
265     IOBUF buf;            /* IOBUF reference */
266 } PKT_compressed;
267
268 typedef struct {
269     u32  len;             /* length of encrypted data */
270     int  extralen;        /* this is (blocksize+2) */
271     byte new_ctb;         /* uses a new CTB */
272     byte mdc_method;      /* > 0: integrity protected encrypted data packet */
273     IOBUF buf;            /* IOBUF reference */
274 } PKT_encrypted;
275
276 typedef struct {
277     byte hash[20];
278 } PKT_mdc;
279
280 typedef struct {
281     unsigned int trustval;
282     unsigned int sigcache;
283 } PKT_ring_trust;
284
285 typedef struct {
286     u32  len;             /* length of encrypted data */
287     IOBUF buf;            /* IOBUF reference */
288     byte new_ctb;
289     byte is_partial;      /* partial length encoded */
290     int mode;
291     u32 timestamp;
292     int  namelen;
293     char name[1];
294 } PKT_plaintext;
295
296 typedef struct {
297     int  control;
298     size_t datalen;
299     char data[1];
300 } PKT_gpg_control;
301
302 /* combine all packets into a union */
303 struct packet_struct {
304     pkttype_t pkttype;
305     union {
306         void *generic;
307         PKT_symkey_enc  *symkey_enc;    /* PKT_SYMKEY_ENC */
308         PKT_pubkey_enc  *pubkey_enc;    /* PKT_PUBKEY_ENC */
309         PKT_onepass_sig *onepass_sig;   /* PKT_ONEPASS_SIG */
310         PKT_signature   *signature;     /* PKT_SIGNATURE */
311         PKT_public_key  *public_key;    /* PKT_PUBLIC_[SUB)KEY */
312         PKT_secret_key  *secret_key;    /* PKT_SECRET_[SUB]KEY */
313         PKT_comment     *comment;       /* PKT_COMMENT */
314         PKT_user_id     *user_id;       /* PKT_USER_ID */
315         PKT_compressed  *compressed;    /* PKT_COMPRESSED */
316         PKT_encrypted   *encrypted;     /* PKT_ENCRYPTED[_MDC] */
317         PKT_mdc         *mdc;           /* PKT_MDC */
318         PKT_ring_trust  *ring_trust;    /* PKT_RING_TRUST */
319         PKT_plaintext   *plaintext;     /* PKT_PLAINTEXT */
320         PKT_gpg_control *gpg_control;   /* PKT_GPG_CONTROL */
321     } pkt;
322 };
323
324 #define init_packet(a) do { (a)->pkttype = 0;           \
325                             (a)->pkt.generic = NULL;    \
326                        } while(0)
327
328 typedef enum {
329     SIGSUBPKT_TEST_CRITICAL=-3,
330     SIGSUBPKT_LIST_UNHASHED=-2,
331     SIGSUBPKT_LIST_HASHED  =-1,
332     SIGSUBPKT_NONE         = 0,
333     SIGSUBPKT_SIG_CREATED  = 2, /* signature creation time */
334     SIGSUBPKT_SIG_EXPIRE   = 3, /* signature expiration time */
335     SIGSUBPKT_EXPORTABLE   = 4, /* exportable */
336     SIGSUBPKT_TRUST        = 5, /* trust signature */
337     SIGSUBPKT_REGEXP       = 6, /* regular expression */
338     SIGSUBPKT_REVOCABLE    = 7, /* revocable */
339     SIGSUBPKT_KEY_EXPIRE   = 9, /* key expiration time */
340     SIGSUBPKT_ARR          =10, /* additional recipient request */
341     SIGSUBPKT_PREF_SYM     =11, /* preferred symmetric algorithms */
342     SIGSUBPKT_REV_KEY      =12, /* revocation key */
343     SIGSUBPKT_ISSUER       =16, /* issuer key ID */
344     SIGSUBPKT_NOTATION     =20, /* notation data */
345     SIGSUBPKT_PREF_HASH    =21, /* preferred hash algorithms */
346     SIGSUBPKT_PREF_COMPR   =22, /* preferred compression algorithms */
347     SIGSUBPKT_KS_FLAGS     =23, /* key server preferences */
348     SIGSUBPKT_PREF_KS      =24, /* preferred key server */
349     SIGSUBPKT_PRIMARY_UID  =25, /* primary user id */
350     SIGSUBPKT_POLICY       =26, /* policy URL */
351     SIGSUBPKT_KEY_FLAGS    =27, /* key flags */
352     SIGSUBPKT_SIGNERS_UID  =28, /* signer's user id */
353     SIGSUBPKT_REVOC_REASON =29, /* reason for revocation */
354     SIGSUBPKT_FEATURES     =30, /* feature flags */
355     SIGSUBPKT_PRIV_VERIFY_CACHE =101, /* cache verification result (obsolete)*/
356
357     SIGSUBPKT_FLAG_CRITICAL=128
358 } sigsubpkttype_t;
359
360
361 /*-- mainproc.c --*/
362 int proc_packets( void *ctx, IOBUF a );
363 int proc_signature_packets( void *ctx, IOBUF a,
364                             STRLIST signedfiles, const char *sigfile );
365 int proc_encryption_packets( void *ctx, IOBUF a );
366 int list_packets( IOBUF a );
367
368 /*-- parse-packet.c --*/
369 int set_packet_list_mode( int mode );
370
371 #if DEBUG_PARSE_PACKET
372 int dbg_search_packet( IOBUF inp, PACKET *pkt, off_t *retpos, int with_uid,
373                        const char* file, int lineno  );
374 int dbg_parse_packet( IOBUF inp, PACKET *ret_pkt,
375                       const char* file, int lineno );
376 int dbg_copy_all_packets( IOBUF inp, IOBUF out,
377                           const char* file, int lineno  );
378 int dbg_copy_some_packets( IOBUF inp, IOBUF out, off_t stopoff,
379                            const char* file, int lineno  );
380 int dbg_skip_some_packets( IOBUF inp, unsigned n,
381                            const char* file, int lineno );
382 #define search_packet( a,b,c,d )   \
383              dbg_search_packet( (a), (b), (c), (d), __FILE__, __LINE__ )
384 #define parse_packet( a, b )  \
385              dbg_parse_packet( (a), (b), __FILE__, __LINE__ )
386 #define copy_all_packets( a,b )  \
387              dbg_copy_all_packets((a),(b), __FILE__, __LINE__ )
388 #define copy_some_packets( a,b,c ) \
389              dbg_copy_some_packets((a),(b),(c), __FILE__, __LINE__ )
390 #define skip_some_packets( a,b ) \
391              dbg_skip_some_packets((a),(b), __FILE__, __LINE__ )
392 #else
393 int search_packet( IOBUF inp, PACKET *pkt, off_t *retpos, int with_uid );
394 int parse_packet( IOBUF inp, PACKET *ret_pkt);
395 int copy_all_packets( IOBUF inp, IOBUF out );
396 int copy_some_packets( IOBUF inp, IOBUF out, off_t stopoff );
397 int skip_some_packets( IOBUF inp, unsigned n );
398 #endif
399
400 const byte *enum_sig_subpkt ( const subpktarea_t *subpkts,
401                               sigsubpkttype_t reqtype,
402                               size_t *ret_n, int *start, int *critical );
403 const byte *parse_sig_subpkt ( const subpktarea_t *buffer,
404                                sigsubpkttype_t reqtype,
405                                size_t *ret_n );
406 const byte *parse_sig_subpkt2 ( PKT_signature *sig,
407                                 sigsubpkttype_t reqtype,
408                                 size_t *ret_n );
409 int parse_one_sig_subpkt( const byte *buffer, size_t n, int type );
410 void parse_revkeys(PKT_signature *sig);
411 int parse_attribute_subpkts(PKT_user_id *uid);
412 void make_attribute_uidname(PKT_user_id *uid, size_t max_namelen);
413 PACKET *create_gpg_control ( ctrlpkttype_t type,
414                              const byte *data,
415                              size_t datalen );
416
417 /*-- build-packet.c --*/
418 int build_packet( IOBUF inp, PACKET *pkt );
419 u32 calc_packet_length( PACKET *pkt );
420 void hash_public_key( MD_HANDLE md, PKT_public_key *pk );
421 void build_sig_subpkt( PKT_signature *sig, sigsubpkttype_t type,
422                         const byte *buffer, size_t buflen );
423 void build_sig_subpkt_from_sig( PKT_signature *sig );
424 int  delete_sig_subpkt(subpktarea_t *buffer, sigsubpkttype_t type );
425 void build_attribute_subpkt(PKT_user_id *uid,byte type,
426                             const void *buf,u32 buflen,
427                             const void *header,u32 headerlen);
428
429 /*-- free-packet.c --*/
430 void free_symkey_enc( PKT_symkey_enc *enc );
431 void free_pubkey_enc( PKT_pubkey_enc *enc );
432 void free_seckey_enc( PKT_signature *enc );
433 int  digest_algo_from_sig( PKT_signature *sig );
434 void release_public_key_parts( PKT_public_key *pk );
435 void free_public_key( PKT_public_key *key );
436 void release_secret_key_parts( PKT_secret_key *sk );
437 void free_secret_key( PKT_secret_key *sk );
438 void free_attributes(PKT_user_id *uid);
439 void free_user_id( PKT_user_id *uid );
440 void free_comment( PKT_comment *rem );
441 void free_packet( PACKET *pkt );
442 prefitem_t *copy_prefs (const prefitem_t *prefs);
443 PKT_public_key *copy_public_key( PKT_public_key *d, PKT_public_key *s );
444 void copy_public_parts_to_secret_key( PKT_public_key *pk, PKT_secret_key *sk );
445 PKT_secret_key *copy_secret_key( PKT_secret_key *d, PKT_secret_key *s );
446 PKT_signature *copy_signature( PKT_signature *d, PKT_signature *s );
447 PKT_user_id *scopy_user_id (PKT_user_id *sd );
448 int cmp_public_keys( PKT_public_key *a, PKT_public_key *b );
449 int cmp_secret_keys( PKT_secret_key *a, PKT_secret_key *b );
450 int cmp_signatures( PKT_signature *a, PKT_signature *b );
451 int cmp_public_secret_key( PKT_public_key *pk, PKT_secret_key *sk );
452 int cmp_user_ids( PKT_user_id *a, PKT_user_id *b );
453
454
455 /*-- sig-check.c --*/
456 int signature_check( PKT_signature *sig, MD_HANDLE digest );
457 int signature_check2( PKT_signature *sig, MD_HANDLE digest,
458                       u32 *r_expiredate, int *r_expired );
459
460 /*-- seckey-cert.c --*/
461 int is_secret_key_protected( PKT_secret_key *sk );
462 int check_secret_key( PKT_secret_key *sk, int retries );
463 int protect_secret_key( PKT_secret_key *sk, DEK *dek );
464
465 /*-- pubkey-enc.c --*/
466 int get_session_key( PKT_pubkey_enc *k, DEK *dek );
467 int get_override_session_key( DEK *dek, const char *string );
468
469 /*-- compress.c --*/
470 int handle_compressed( void *ctx, PKT_compressed *cd,
471                        int (*callback)(IOBUF, void *), void *passthru );
472
473 /*-- encr-data.c --*/
474 int decrypt_data( void *ctx, PKT_encrypted *ed, DEK *dek );
475
476 /*-- plaintext.c --*/
477 int handle_plaintext( PKT_plaintext *pt, md_filter_context_t *mfx,
478                                         int nooutput, int clearsig );
479 int ask_for_detached_datafile( MD_HANDLE md, MD_HANDLE md2,
480                                const char *inname, int textmode );
481
482 /*-- comment.c --*/
483 int write_comment( IOBUF out, const char *s );
484
485 /*-- sign.c --*/
486 int make_keysig_packet( PKT_signature **ret_sig, PKT_public_key *pk,
487                         PKT_user_id *uid, PKT_public_key *subpk,
488                         PKT_secret_key *sk, int sigclass, int digest_algo,
489                         int sigversion, u32 timestamp, u32 duration,
490                         int (*mksubpkt)(PKT_signature *, void *),
491                         void *opaque  );
492 int update_keysig_packet( PKT_signature **ret_sig,
493                       PKT_signature *orig_sig,
494                       PKT_public_key *pk,
495                       PKT_user_id *uid,
496                       PKT_public_key *subpk,
497                       PKT_secret_key *sk,
498                       int (*mksubpkt)(PKT_signature *, void *),
499                       void *opaque   );
500
501 /*-- keygen.c --*/
502 PKT_user_id *generate_user_id(void);
503
504 #endif /*G10_PACKET_H*/