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