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