gpg: Avoid endless loop in a tofu error case.
[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  * Copyright (C) 2015 g10 Code GmbH
5  *
6  * This file is part of GnuPG.
7  *
8  * GnuPG is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * GnuPG is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, see <http://www.gnu.org/licenses/>.
20  */
21
22 #ifndef G10_PACKET_H
23 #define G10_PACKET_H
24
25 #include "types.h"
26 #include "../common/iobuf.h"
27 #include "../common/strlist.h"
28 #include "dek.h"
29 #include "filter.h"
30 #include "../common/openpgpdefs.h"
31 #include "../common/userids.h"
32 #include "util.h"
33
34 #define DEBUG_PARSE_PACKET 1
35
36
37 /* Constants to allocate static MPI arrays. */
38 #define PUBKEY_MAX_NPKEY  5
39 #define PUBKEY_MAX_NSKEY  7
40 #define PUBKEY_MAX_NSIG   2
41 #define PUBKEY_MAX_NENC   2
42
43 /* Usage flags */
44 #define PUBKEY_USAGE_SIG     GCRY_PK_USAGE_SIGN  /* Good for signatures. */
45 #define PUBKEY_USAGE_ENC     GCRY_PK_USAGE_ENCR  /* Good for encryption. */
46 #define PUBKEY_USAGE_CERT    GCRY_PK_USAGE_CERT  /* Also good to certify keys.*/
47 #define PUBKEY_USAGE_AUTH    GCRY_PK_USAGE_AUTH  /* Good for authentication. */
48 #define PUBKEY_USAGE_UNKNOWN GCRY_PK_USAGE_UNKN  /* Unknown usage flag. */
49 #define PUBKEY_USAGE_NONE    256                 /* No usage given. */
50 #if  (GCRY_PK_USAGE_SIGN | GCRY_PK_USAGE_ENCR | GCRY_PK_USAGE_CERT \
51       | GCRY_PK_USAGE_AUTH | GCRY_PK_USAGE_UNKN) >= 256
52 # error Please choose another value for PUBKEY_USAGE_NONE
53 #endif
54
55 /* Helper macros.  */
56 #define is_RSA(a)     ((a)==PUBKEY_ALGO_RSA || (a)==PUBKEY_ALGO_RSA_E \
57                        || (a)==PUBKEY_ALGO_RSA_S )
58 #define is_ELGAMAL(a) ((a)==PUBKEY_ALGO_ELGAMAL_E)
59 #define is_DSA(a)     ((a)==PUBKEY_ALGO_DSA)
60
61 /* A pointer to the packet object.  */
62 typedef struct packet_struct PACKET;
63
64 /* PKT_GPG_CONTROL types */
65 typedef enum {
66     CTRLPKT_CLEARSIGN_START = 1,
67     CTRLPKT_PIPEMODE = 2,
68     CTRLPKT_PLAINTEXT_MARK =3
69 } ctrlpkttype_t;
70
71 typedef enum {
72     PREFTYPE_NONE = 0,
73     PREFTYPE_SYM = 1,
74     PREFTYPE_HASH = 2,
75     PREFTYPE_ZIP = 3
76 } preftype_t;
77
78 typedef struct {
79     byte type;
80     byte value;
81 } prefitem_t;
82
83 /* A string-to-key specifier as defined in RFC 4880, Section 3.7.  */
84 typedef struct
85 {
86   int  mode;      /* Must be an integer due to the GNU modes 1001 et al.  */
87   byte hash_algo;
88   byte salt[8];
89   /* The *coded* (i.e., the serialized version) iteration count.  */
90   u32  count;
91 } STRING2KEY;
92
93 /* A symmetric-key encrypted session key packet as defined in RFC
94    4880, Section 5.3.  All fields are serialized.  */
95 typedef struct {
96   /* RFC 4880: this must be 4.  */
97   byte version;
98   /* The cipher algorithm used.  */
99   byte cipher_algo;
100   /* The string-to-key specifier.  */
101   STRING2KEY s2k;
102   /* The length of SESKEY in bytes or 0 if this packet does not
103      encrypt a session key.  (In the latter case, the results of the
104      S2K function on the password is the session key. See RFC 4880,
105      Section 5.3.)  */
106   byte seskeylen;
107   /* The session key as encrypted by the S2K specifier.  */
108   byte seskey[1];
109 } PKT_symkey_enc;
110
111 /* A public-key encrypted session key packet as defined in RFC 4880,
112    Section 5.1.  All fields are serialized.  */
113 typedef struct {
114   /* The 64-bit keyid.  */
115   u32     keyid[2];
116   /* The packet's version.  Currently, only version 3 is defined.  */
117   byte    version;
118   /* The algorithm used for the public key encryption scheme.  */
119   byte    pubkey_algo;
120   /* Whether to hide the key id.  This value is not directly
121      serialized.  */
122   byte    throw_keyid;
123   /* The session key.  */
124   gcry_mpi_t     data[PUBKEY_MAX_NENC];
125 } PKT_pubkey_enc;
126
127
128 /* A one-pass signature packet as defined in RFC 4880, Section
129    5.4.  All fields are serialized.  */
130 typedef struct {
131     u32     keyid[2];       /* The 64-bit keyid */
132     /* The signature's classification (RFC 4880, Section 5.2.1).  */
133     byte    sig_class;
134     byte    digest_algo;    /* algorithm used for digest */
135     byte    pubkey_algo;    /* algorithm used for public key scheme */
136     /* A message can be signed by multiple keys.  In this case, there
137        are n one-pass signature packets before the message to sign and
138        n signatures packets after the message.  It is conceivable that
139        someone wants to not only sign the message, but all of the
140        signatures.  Now we need to distinguish between signing the
141        message and signing the message plus the surrounding
142        signatures.  This is the point of this flag.  If set, it means:
143        I sign all of the data starting at the next packet.  */
144     byte    last;
145 } PKT_onepass_sig;
146
147
148 /* A v4 OpenPGP signature has a hashed and unhashed area containing
149    co-called signature subpackets (RFC 4880, Section 5.2.3).  These
150    areas are described by this data structure.  Use enum_sig_subpkt to
151    parse this area.  */
152 typedef struct {
153     size_t size;  /* allocated */
154     size_t len;   /* used (serialized) */
155     byte data[1]; /* the serialized subpackes (serialized) */
156 } subpktarea_t;
157
158 /* The in-memory representation of a designated revoker signature
159    subpacket (RFC 4880, Section 5.2.3.15).  */
160 struct revocation_key {
161   /* A bit field.  0x80 must be set.  0x40 means this information is
162      sensitive (and should not be uploaded to a keyserver by
163      default).  */
164   byte class;
165   /* The public-key algorithm ID.  */
166   byte algid;
167   /* The fingerprint of the authorized key.  */
168   byte fpr[MAX_FINGERPRINT_LEN];
169 };
170
171
172 /* Object to keep information about a PKA DNS record. */
173 typedef struct
174 {
175   int valid;    /* An actual PKA record exists for EMAIL. */
176   int checked;  /* Set to true if the FPR has been checked against the
177                    actual key. */
178   char *uri;    /* Malloced string with the URI. NULL if the URI is
179                    not available.*/
180   unsigned char fpr[20]; /* The fingerprint as stored in the PKA RR. */
181   char email[1];/* The email address from the notation data. */
182 } pka_info_t;
183
184
185 /* A signature packet (RFC 4880, Section 5.2).  Only a subset of these
186    fields are directly serialized (these are marked as such); the rest
187    are read from the subpackets, which are not synthesized when
188    serializing this data structure (i.e., when using build_packet()).
189    Instead, the subpackets must be created by hand.  */
190 typedef struct
191 {
192   struct
193   {
194     unsigned checked:1;         /* Signature has been checked. */
195     unsigned valid:1;           /* Signature is good (if checked is set). */
196     unsigned chosen_selfsig:1;  /* A selfsig that is the chosen one. */
197     unsigned unknown_critical:1;
198     unsigned exportable:1;
199     unsigned revocable:1;
200     unsigned policy_url:1;  /* At least one policy URL is present */
201     unsigned notation:1;    /* At least one notation is present */
202     unsigned pref_ks:1;     /* At least one preferred keyserver is present */
203     unsigned expired:1;
204     unsigned pka_tried:1;   /* Set if we tried to retrieve the PKA record. */
205   } flags;
206   /* The key that allegedly generated this signature.  (Directly
207      serialized in v3 sigs; for v4 sigs, this must be explicitly added
208      as an issuer subpacket (5.2.3.5.)  */
209   u32     keyid[2];
210   /* When the signature was made (seconds since the Epoch).  (Directly
211      serialized in v3 sigs; for v4 sigs, this must be explicitly added
212      as a signature creation time subpacket (5.2.3.4).)  */
213   u32     timestamp;
214   u32     expiredate;     /* Expires at this date or 0 if not at all. */
215   /* The serialization format used / to use.  If 0, then defaults to
216      version 3.  (Serialized.)  */
217   byte    version;
218   /* The signature type. (See RFC 4880, Section 5.2.1.)  */
219   byte    sig_class;
220   /* Algorithm used for public key scheme (e.g., PUBKEY_ALGO_RSA).
221      (Serialized.)  */
222   byte    pubkey_algo;
223   /* Algorithm used for digest (e.g., DIGEST_ALGO_SHA1).
224      (Serialized.)  */
225   byte    digest_algo;
226   byte    trust_depth;
227   byte    trust_value;
228   const byte *trust_regexp;
229   struct revocation_key *revkey;
230   int numrevkeys;
231   pka_info_t *pka_info;      /* Malloced PKA data or NULL if not
232                                 available.  See also flags.pka_tried. */
233   char *signers_uid;         /* Malloced value of the SIGNERS_UID
234                               * subpacket.  */
235   subpktarea_t *hashed;      /* All subpackets with hashed data (v4 only). */
236   subpktarea_t *unhashed;    /* Ditto for unhashed data. */
237   /* First 2 bytes of the digest.  (Serialized.  Note: this is not
238      automatically filled in when serializing a signature!)  */
239   byte digest_start[2];
240   /* The signature.  (Serialized.)  */
241   gcry_mpi_t  data[PUBKEY_MAX_NSIG];
242   /* The message digest and its length (in bytes).  Note the maximum
243      digest length is 512 bits (64 bytes).  If DIGEST_LEN is 0, then
244      the digest's value has not been saved here.  */
245   byte digest[512 / 8];
246   int digest_len;
247 } PKT_signature;
248
249 #define ATTRIB_IMAGE 1
250
251 /* This is the cooked form of attributes.  */
252 struct user_attribute {
253   byte type;
254   const byte *data;
255   u32 len;
256 };
257
258
259 /* A user id (RFC 4880, Section 5.11) or a user attribute packet (RFC
260    4880, Section 5.12).  Only a subset of these fields are directly
261    serialized (these are marked as such); the rest are read from the
262    self-signatures in merge_keys_and_selfsig()).  */
263 typedef struct
264 {
265   int ref;              /* reference counter */
266   /* The length of NAME.  */
267   int len;
268   struct user_attribute *attribs;
269   int numattribs;
270   /* If this is not NULL, the packet is a user attribute rather than a
271      user id.  (Serialized.)  */
272   byte *attrib_data;
273   /* The length of ATTRIB_DATA.  */
274   unsigned long attrib_len;
275   byte *namehash;
276   int help_key_usage;
277   u32 help_key_expire;
278   int help_full_count;
279   int help_marginal_count;
280   int is_primary;       /* 2 if set via the primary flag, 1 if calculated */
281   int is_revoked;
282   int is_expired;
283   u32 expiredate;       /* expires at this date or 0 if not at all */
284   prefitem_t *prefs;    /* list of preferences (may be NULL)*/
285   u32 created;          /* according to the self-signature */
286   byte selfsigversion;
287   struct
288   {
289     /* TODO: Move more flags here */
290     unsigned int mdc:1;
291     unsigned int ks_modify:1;
292     unsigned int compacted:1;
293   } flags;
294   /* The text contained in the user id packet, which is normally the
295      name and email address of the key holder (See RFC 4880 5.11).
296      (Serialized.)  */
297   char name[1];
298 } PKT_user_id;
299
300
301
302 struct revoke_info
303 {
304   /* revoked at this date */
305   u32 date;
306   /* the keyid of the revoking key (selfsig or designated revoker) */
307   u32 keyid[2];
308   /* the algo of the revoking key */
309   byte algo;
310 };
311
312
313 /* Information pertaining to secret keys. */
314 struct seckey_info
315 {
316   int is_protected:1;   /* The secret info is protected and must */
317                         /* be decrypted before use, the protected */
318                         /* MPIs are simply (void*) pointers to memory */
319                         /* and should never be passed to a mpi_xxx() */
320   int sha1chk:1;        /* SHA1 is used instead of a 16 bit checksum */
321   u16 csum;             /* Checksum for old protection modes.  */
322   byte algo;            /* Cipher used to protect the secret information. */
323   STRING2KEY s2k;       /* S2K parameter.  */
324   byte ivlen;           /* Used length of the IV.  */
325   byte iv[16];          /* Initialization vector for CFB mode.  */
326 };
327
328
329 /****************
330  * The in-memory representation of a public key (RFC 4880, Section
331  * 5.5).  Note: this structure contains significantly more information
332  * than is contained in an OpenPGP public key packet.  This
333  * information is derived from the self-signed signatures (by
334  * merge_keys_and_selfsig()) and is ignored when serializing the
335  * packet.  The fields that are actually written out when serializing
336  * this packet are marked as accordingly.
337  *
338  * We assume that secret keys have the same number of parameters as
339  * the public key and that the public parameters are the first items
340  * in the PKEY array.  Thus NPKEY is always less than NSKEY and it is
341  * possible to compare the secret and public keys by comparing the
342  * first NPKEY elements of the PKEY array.  Note that since GnuPG 2.1
343  * we don't use secret keys anymore directly because they are managed
344  * by gpg-agent.  However for parsing OpenPGP key files we need a way
345  * to temporary store those secret keys.  We do this by putting them
346  * into the public key structure and extending the PKEY field to NSKEY
347  * elements; the extra secret key information are stored in the
348  * SECKEY_INFO field.
349  */
350 typedef struct
351 {
352   /* When the key was created.  (Serialized.)  */
353   u32     timestamp;
354   u32     expiredate;     /* expires at this date or 0 if not at all */
355   u32     max_expiredate; /* must not expire past this date */
356   struct revoke_info revoked;
357   /* An OpenPGP packet consists of a header and a body.  This is the
358      size of the header.  If this is 0, an appropriate size is
359      automatically chosen based on the size of the body.
360      (Serialized.)  */
361   byte    hdrbytes;
362   /* The serialization format.  If 0, the default version (4) is used
363      when serializing.  (Serialized.)  */
364   byte    version;
365   byte    selfsigversion; /* highest version of all of the self-sigs */
366   /* The public key algorithm.  (Serialized.)  */
367   byte    pubkey_algo;
368   byte    pubkey_usage;   /* for now only used to pass it to getkey() */
369   byte    req_usage;      /* hack to pass a request to getkey() */
370   u32     has_expired;    /* set to the expiration date if expired */
371   /* keyid of the primary key.  Never access this value directly.
372      Instead, use pk_main_keyid().  */
373   u32     main_keyid[2];
374   /* keyid of this key.  Never access this value directly!  Instead,
375      use pk_keyid().  */
376   u32     keyid[2];
377   prefitem_t *prefs;      /* list of preferences (may be NULL) */
378   struct
379   {
380     unsigned int mdc:1;           /* MDC feature set.  */
381     unsigned int disabled_valid:1;/* The next flag is valid.  */
382     unsigned int disabled:1;      /* The key has been disabled.  */
383     unsigned int primary:1;       /* This is a primary key.  */
384     unsigned int revoked:2;       /* Key has been revoked.
385                                      1 = revoked by the owner
386                                      2 = revoked by designated revoker.  */
387     unsigned int maybe_revoked:1; /* A designated revocation is
388                                      present, but without the key to
389                                      check it.  */
390     unsigned int valid:1;         /* Key (especially subkey) is valid.  */
391     unsigned int dont_cache:1;    /* Do not cache this key.  */
392     unsigned int backsig:2;       /* 0=none, 1=bad, 2=good.  */
393     unsigned int serialno_valid:1;/* SERIALNO below is valid.  */
394     unsigned int exact:1;         /* Found via exact (!) search.  */
395   } flags;
396   PKT_user_id *user_id;   /* If != NULL: found by that uid. */
397   struct revocation_key *revkey;
398   int     numrevkeys;
399   u32     trust_timestamp;
400   byte    trust_depth;
401   byte    trust_value;
402   const byte *trust_regexp;
403   char    *serialno;      /* Malloced hex string or NULL if it is
404                              likely not on a card.  See also
405                              flags.serialno_valid.  */
406   /* If not NULL this malloced structure describes a secret key.
407      (Serialized.)  */
408   struct seckey_info *seckey_info;
409   /* The public key.  Contains pubkey_get_npkey (pubkey_algo) +
410      pubkey_get_nskey (pubkey_algo) MPIs.  (If pubkey_get_npkey
411      returns 0, then the algorithm is not understood and the PKEY
412      contains a single opaque MPI.)  (Serialized.)  */
413   gcry_mpi_t  pkey[PUBKEY_MAX_NSKEY]; /* Right, NSKEY elements.  */
414 } PKT_public_key;
415
416 /* Evaluates as true if the pk is disabled, and false if it isn't.  If
417    there is no disable value cached, fill one in. */
418 #define pk_is_disabled(a)                                       \
419   (((a)->flags.disabled_valid)?                                 \
420    ((a)->flags.disabled):(cache_disabled_value((a))))
421
422
423 typedef struct {
424     int  len;             /* length of data */
425     char data[1];
426 } PKT_comment;
427
428 /* A compression packet (RFC 4880, Section 5.6).  */
429 typedef struct {
430   /* Not used.  */
431   u32 len;
432   /* Whether the serialized version of the packet used / should use
433      the new format.  */
434   byte  new_ctb;
435   /* The compression algorithm.  */
436   byte  algorithm;
437   /* An iobuf holding the data to be decompressed.  (This is not used
438      for compression!)  */
439   iobuf_t buf;
440 } PKT_compressed;
441
442 /* A symmetrically encrypted data packet (RFC 4880, Section 5.7) or a
443    symmetrically encrypted integrity protected data packet (Section
444    5.13) */
445 typedef struct {
446   /* Remaining length of encrypted data. */
447   u32  len;
448   /* When encrypting, the first block size bytes of data are random
449      data and the following 2 bytes are copies of the last two bytes
450      of the random data (RFC 4880, Section 5.7).  This provides a
451      simple check that the key is correct.  extralen is the size of
452      this extra data.  This is used by build_packet when writing out
453      the packet's header. */
454   int  extralen;
455   /* Whether the serialized version of the packet used / should use
456      the new format.  */
457   byte new_ctb;
458   /* Whether the packet has an indeterminate length (old format) or
459      was encoded using partial body length headers (new format).
460      Note: this is ignored when encrypting.  */
461   byte is_partial;
462   /* If 0, MDC is disabled.  Otherwise, the MDC method that was used
463      (currently, only DIGEST_ALGO_SHA1 is supported).  */
464   byte mdc_method;
465   /* An iobuf holding the data to be decrypted.  (This is not used for
466      encryption!)  */
467   iobuf_t buf;
468 } PKT_encrypted;
469
470 typedef struct {
471     byte hash[20];
472 } PKT_mdc;
473
474 typedef struct {
475     unsigned int trustval;
476     unsigned int sigcache;
477 } PKT_ring_trust;
478
479 /* A plaintext packet (see RFC 4880, 5.9).  */
480 typedef struct {
481   /* The length of data in BUF or 0 if unknown.  */
482   u32  len;
483   /* A buffer containing the data stored in the packet's body.  */
484   iobuf_t buf;
485   byte new_ctb;
486   byte is_partial;      /* partial length encoded */
487   /* The data's formatting.  This is either 'b', 't', 'u', 'l' or '1'
488      (however, the last two are deprecated).  */
489   int mode;
490   u32 timestamp;
491   /* The name of the file.  This can be at most 255 characters long,
492      since namelen is just a byte in the serialized format.  */
493   int  namelen;
494   char name[1];
495 } PKT_plaintext;
496
497 typedef struct {
498     int  control;
499     size_t datalen;
500     char data[1];
501 } PKT_gpg_control;
502
503 /* combine all packets into a union */
504 struct packet_struct {
505     pkttype_t pkttype;
506     union {
507         void *generic;
508         PKT_symkey_enc  *symkey_enc;    /* PKT_SYMKEY_ENC */
509         PKT_pubkey_enc  *pubkey_enc;    /* PKT_PUBKEY_ENC */
510         PKT_onepass_sig *onepass_sig;   /* PKT_ONEPASS_SIG */
511         PKT_signature   *signature;     /* PKT_SIGNATURE */
512         PKT_public_key  *public_key;    /* PKT_PUBLIC_[SUB]KEY */
513         PKT_public_key  *secret_key;    /* PKT_SECRET_[SUB]KEY */
514         PKT_comment     *comment;       /* PKT_COMMENT */
515         PKT_user_id     *user_id;       /* PKT_USER_ID */
516         PKT_compressed  *compressed;    /* PKT_COMPRESSED */
517         PKT_encrypted   *encrypted;     /* PKT_ENCRYPTED[_MDC] */
518         PKT_mdc         *mdc;           /* PKT_MDC */
519         PKT_ring_trust  *ring_trust;    /* PKT_RING_TRUST */
520         PKT_plaintext   *plaintext;     /* PKT_PLAINTEXT */
521         PKT_gpg_control *gpg_control;   /* PKT_GPG_CONTROL */
522     } pkt;
523 };
524
525 #define init_packet(a) do { (a)->pkttype = 0;           \
526                             (a)->pkt.generic = NULL;    \
527                        } while(0)
528
529
530 /* A notation.  See RFC 4880, Section 5.2.3.16.  */
531 struct notation
532 {
533   /* The notation's name.  */
534   char *name;
535   /* If the notation is human readable, then the value is stored here
536      as a NUL-terminated string.  If it is not human readable a human
537      readable approximation of the binary value _may_ be stored
538      here.  */
539   char *value;
540   /* Sometimes we want to %-expand the value.  In these cases, we save
541      that transformed value here.  */
542   char *altvalue;
543   /* If the notation is not human readable, then the value is stored
544      here.  */
545   unsigned char *bdat;
546   /* The amount of data stored in BDAT.
547
548      Note: if this is 0 and BDAT is NULL, this does not necessarily
549      mean that the value is human readable.  It could be that we have
550      a 0-length value.  To determine whether the notation is human
551      readable, always check if VALUE is not NULL.  This works, because
552      if a human-readable value has a length of 0, we will still
553      allocate space for the NUL byte.  */
554   size_t blen;
555   struct
556   {
557     /* The notation is critical.  */
558     unsigned int critical:1;
559     /* The notation is human readable.  */
560     unsigned int human:1;
561     /* The notation should be deleted.  */
562     unsigned int ignore:1;
563   } flags;
564
565   /* A field to facilitate creating a list of notations.  */
566   struct notation *next;
567 };
568 typedef struct notation *notation_t;
569
570 /*-- mainproc.c --*/
571 void reset_literals_seen(void);
572 int proc_packets (ctrl_t ctrl, void *ctx, iobuf_t a );
573 int proc_signature_packets (ctrl_t ctrl, void *ctx, iobuf_t a,
574                             strlist_t signedfiles, const char *sigfile );
575 int proc_signature_packets_by_fd (ctrl_t ctrl,
576                                   void *anchor, IOBUF a, int signed_data_fd );
577 int proc_encryption_packets (ctrl_t ctrl, void *ctx, iobuf_t a);
578 int list_packets( iobuf_t a );
579
580 /*-- parse-packet.c --*/
581
582 /* Sets the packet list mode to MODE (i.e., whether we are dumping a
583    packet or not).  Returns the current mode.  This allows for
584    temporarily suspending dumping by doing the following:
585
586      int saved_mode = set_packet_list_mode (0);
587      ...
588      set_packet_list_mode (saved_mode);
589 */
590 int set_packet_list_mode( int mode );
591
592 #if DEBUG_PARSE_PACKET
593 /* There are debug functions and should not be used directly.  */
594 int dbg_search_packet( iobuf_t inp, PACKET *pkt, off_t *retpos, int with_uid,
595                        const char* file, int lineno  );
596 int dbg_parse_packet( iobuf_t inp, PACKET *ret_pkt,
597                       const char* file, int lineno );
598 int dbg_copy_all_packets( iobuf_t inp, iobuf_t out,
599                           const char* file, int lineno  );
600 int dbg_copy_some_packets( iobuf_t inp, iobuf_t out, off_t stopoff,
601                            const char* file, int lineno  );
602 int dbg_skip_some_packets( iobuf_t inp, unsigned n,
603                            const char* file, int lineno );
604 #define search_packet( a,b,c,d )   \
605              dbg_search_packet( (a), (b), (c), (d), __FILE__, __LINE__ )
606 #define parse_packet( a, b )  \
607              dbg_parse_packet( (a), (b), __FILE__, __LINE__ )
608 #define copy_all_packets( a,b )  \
609              dbg_copy_all_packets((a),(b), __FILE__, __LINE__ )
610 #define copy_some_packets( a,b,c ) \
611              dbg_copy_some_packets((a),(b),(c), __FILE__, __LINE__ )
612 #define skip_some_packets( a,b ) \
613              dbg_skip_some_packets((a),(b), __FILE__, __LINE__ )
614 #else
615 /* Return the next valid OpenPGP packet in *PKT.  (This function will
616    skip any packets whose type is 0.)
617
618    Returns 0 on success, -1 if EOF is reached, and an error code
619    otherwise.  In the case of an error, the packet in *PKT may be
620    partially constructed.  As such, even if there is an error, it is
621    necessary to free *PKT to avoid a resource leak.  To detect what
622    has been allocated, clear *PKT before calling this function.  */
623 int parse_packet( iobuf_t inp, PACKET *pkt);
624
625 /* Return the first OpenPGP packet in *PKT that contains a key (either
626    a public subkey, a public key, a secret subkey or a secret key) or,
627    if WITH_UID is set, a user id.
628
629    Saves the position in the pipeline of the start of the returned
630    packet (according to iobuf_tell) in RETPOS, if it is not NULL.
631
632    The return semantics are the same as parse_packet.  */
633 int search_packet( iobuf_t inp, PACKET *pkt, off_t *retpos, int with_uid );
634
635 /* Copy all packets (except invalid packets, i.e., those with a type
636    of 0) from INP to OUT until either an error occurs or EOF is
637    reached.
638
639    Returns -1 when end of file is reached or an error code, if an
640    error occurred.  (Note: this function never returns 0, because it
641    effectively keeps going until it gets an EOF.)  */
642 int copy_all_packets( iobuf_t inp, iobuf_t out );
643
644 /* Like copy_all_packets, but stops at the first packet that starts at
645    or after STOPOFF (as indicated by iobuf_tell).
646
647    Example: if STOPOFF is 100, the first packet in INP goes from 0 to
648    110 and the next packet starts at offset 111, then the packet
649    starting at offset 0 will be completely processed (even though it
650    extends beyond STOPOFF) and the packet starting at offset 111 will
651    not be processed at all.  */
652 int copy_some_packets( iobuf_t inp, iobuf_t out, off_t stopoff );
653
654 /* Skips the next N packets from INP.
655
656    If parsing a packet returns an error code, then the function stops
657    immediately and returns the error code.  Note: in the case of an
658    error, this function does not indicate how many packets were
659    successfully processed.  */
660 int skip_some_packets( iobuf_t inp, unsigned n );
661 #endif
662
663 /* Parse a signature packet and store it in *SIG.
664
665    The signature packet is read from INP.  The OpenPGP header (the tag
666    and the packet's length) have already been read; the next byte read
667    from INP should be the first byte of the packet's contents.  The
668    packet's type (as extract from the tag) must be passed as PKTTYPE
669    and the packet's length must be passed as PKTLEN.  This is used as
670    the upper bound on the amount of data read from INP.  If the packet
671    is shorter than PKTLEN, the data at the end will be silently
672    skipped.  If an error occurs, an error code will be returned.  -1
673    means the EOF was encountered.  0 means parsing was successful.  */
674 int parse_signature( iobuf_t inp, int pkttype, unsigned long pktlen,
675                      PKT_signature *sig );
676
677 /* Given a subpacket area (typically either PKT_signature.hashed or
678    PKT_signature.unhashed), either:
679
680      - test whether there are any subpackets with the critical bit set
681        that we don't understand,
682
683      - list the subpackets, or,
684
685      - find a subpacket with a specific type.
686
687    REQTYPE indicates the type of operation.
688
689    If REQTYPE is SIGSUBPKT_TEST_CRITICAL, then this function checks
690    whether there are any subpackets that have the critical bit and
691    which GnuPG cannot handle.  If GnuPG understands all subpackets
692    whose critical bit is set, then this function returns simply
693    returns SUBPKTS.  If there is a subpacket whose critical bit is set
694    and which GnuPG does not understand, then this function returns
695    NULL and, if START is not NULL, sets *START to the 1-based index of
696    the subpacket that violates the constraint.
697
698    If REQTYPE is SIGSUBPKT_LIST_HASHED or SIGSUBPKT_LIST_UNHASHED, the
699    packets are dumped.  Note: if REQTYPE is SIGSUBPKT_LIST_HASHED,
700    this function does not check whether the hash is correct; this is
701    merely an indication of the section that the subpackets came from.
702
703    If REQTYPE is anything else, then this function interprets the
704    values as a subpacket type and looks for the first subpacket with
705    that type.  If such a packet is found, *CRITICAL (if not NULL) is
706    set if the critical bit was set, *RET_N is set to the offset of the
707    subpacket's content within the SUBPKTS buffer, *START is set to the
708    1-based index of the subpacket within the buffer, and returns
709    &SUBPKTS[*RET_N].
710
711    *START is the number of initial subpackets to not consider.  Thus,
712    if *START is 2, then the first 2 subpackets are ignored.  */
713 const byte *enum_sig_subpkt ( const subpktarea_t *subpkts,
714                               sigsubpkttype_t reqtype,
715                               size_t *ret_n, int *start, int *critical );
716
717 /* Shorthand for:
718
719      enum_sig_subpkt (buffer, reqtype, ret_n, NULL, NULL); */
720 const byte *parse_sig_subpkt ( const subpktarea_t *buffer,
721                                sigsubpkttype_t reqtype,
722                                size_t *ret_n );
723
724 /* This calls parse_sig_subpkt first on the hashed signature area in
725    SIG and then, if that returns NULL, calls parse_sig_subpkt on the
726    unhashed subpacket area in SIG.  */
727 const byte *parse_sig_subpkt2 ( PKT_signature *sig,
728                                 sigsubpkttype_t reqtype);
729
730 /* Returns whether the N byte large buffer BUFFER is sufficient to
731    hold a subpacket of type TYPE.  Note: the buffer refers to the
732    contents of the subpacket (not the header) and it must already be
733    initialized: for some subpackets, it checks some internal
734    constraints.
735
736    Returns 0 if the size is acceptable.  Returns -2 if the buffer is
737    definitely too short.  To check for an error, check whether the
738    return value is less than 0.  */
739 int parse_one_sig_subpkt( const byte *buffer, size_t n, int type );
740
741 /* Looks for revocation key subpackets (see RFC 4880 5.2.3.15) in the
742    hashed area of the signature packet.  Any that are found are added
743    to SIG->REVKEY and SIG->NUMREVKEYS is updated appropriately.  */
744 void parse_revkeys(PKT_signature *sig);
745
746 /* Extract the attributes from the buffer at UID->ATTRIB_DATA and
747    update UID->ATTRIBS and UID->NUMATTRIBS accordingly.  */
748 int parse_attribute_subpkts(PKT_user_id *uid);
749
750 /* Set the UID->NAME field according to the attributes.  MAX_NAMELEN
751    must be at least 71.  */
752 void make_attribute_uidname(PKT_user_id *uid, size_t max_namelen);
753
754 /* Allocate and initialize a new GPG control packet.  DATA is the data
755    to save in the packet.  */
756 PACKET *create_gpg_control ( ctrlpkttype_t type,
757                              const byte *data,
758                              size_t datalen );
759
760 /*-- build-packet.c --*/
761 int build_packet( iobuf_t inp, PACKET *pkt );
762 gpg_error_t gpg_mpi_write (iobuf_t out, gcry_mpi_t a);
763 gpg_error_t gpg_mpi_write_nohdr (iobuf_t out, gcry_mpi_t a);
764 u32 calc_packet_length( PACKET *pkt );
765 void build_sig_subpkt( PKT_signature *sig, sigsubpkttype_t type,
766                         const byte *buffer, size_t buflen );
767 void build_sig_subpkt_from_sig( PKT_signature *sig );
768 int  delete_sig_subpkt(subpktarea_t *buffer, sigsubpkttype_t type );
769 void build_attribute_subpkt(PKT_user_id *uid,byte type,
770                             const void *buf,u32 buflen,
771                             const void *header,u32 headerlen);
772 struct notation *string_to_notation(const char *string,int is_utf8);
773 struct notation *blob_to_notation(const char *name,
774                                   const char *data, size_t len);
775 struct notation *sig_to_notation(PKT_signature *sig);
776 void free_notation(struct notation *notation);
777
778 /*-- free-packet.c --*/
779 void free_symkey_enc( PKT_symkey_enc *enc );
780 void free_pubkey_enc( PKT_pubkey_enc *enc );
781 void free_seckey_enc( PKT_signature *enc );
782 void release_public_key_parts( PKT_public_key *pk );
783 void free_public_key( PKT_public_key *key );
784 void free_attributes(PKT_user_id *uid);
785 void free_user_id( PKT_user_id *uid );
786 void free_comment( PKT_comment *rem );
787 void free_packet( PACKET *pkt );
788 prefitem_t *copy_prefs (const prefitem_t *prefs);
789 PKT_public_key *copy_public_key( PKT_public_key *d, PKT_public_key *s );
790 PKT_signature *copy_signature( PKT_signature *d, PKT_signature *s );
791 PKT_user_id *scopy_user_id (PKT_user_id *sd );
792 int cmp_public_keys( PKT_public_key *a, PKT_public_key *b );
793 int cmp_signatures( PKT_signature *a, PKT_signature *b );
794 int cmp_user_ids( PKT_user_id *a, PKT_user_id *b );
795
796
797 /*-- sig-check.c --*/
798 /* Check a signature.  This is shorthand for check_signature2 with
799    the unnamed arguments passed as NULL.  */
800 int check_signature (PKT_signature *sig, gcry_md_hd_t digest);
801
802 /* Check a signature.  Looks up the public key from the key db.  (If
803    RET_PK is not NULL, it is returned in *RET_PK.)  DIGEST contains a
804    valid hash context that already includes the signed data.  This
805    function adds the relevant meta-data to the hash before finalizing
806    it and verifying the signature.  */
807 int check_signature2 (PKT_signature *sig, gcry_md_hd_t digest,
808                       u32 *r_expiredate, int *r_expired, int *r_revoked,
809                       PKT_public_key *ret_pk);
810
811
812 /*-- pubkey-enc.c --*/
813 gpg_error_t get_session_key (ctrl_t ctrl, PKT_pubkey_enc *k, DEK *dek);
814 gpg_error_t get_override_session_key (DEK *dek, const char *string);
815
816 /*-- compress.c --*/
817 int handle_compressed (ctrl_t ctrl, void *ctx, PKT_compressed *cd,
818                        int (*callback)(iobuf_t, void *), void *passthru );
819
820 /*-- encr-data.c --*/
821 int decrypt_data (ctrl_t ctrl, void *ctx, PKT_encrypted *ed, DEK *dek );
822
823 /*-- plaintext.c --*/
824 gpg_error_t get_output_file (const byte *embedded_name, int embedded_namelen,
825                              iobuf_t data, char **fnamep, estream_t *fpp);
826 int handle_plaintext( PKT_plaintext *pt, md_filter_context_t *mfx,
827                                         int nooutput, int clearsig );
828 int ask_for_detached_datafile( gcry_md_hd_t md, gcry_md_hd_t md2,
829                                const char *inname, int textmode );
830
831 /*-- sign.c --*/
832 int make_keysig_packet( PKT_signature **ret_sig, PKT_public_key *pk,
833                         PKT_user_id *uid, PKT_public_key *subpk,
834                         PKT_public_key *pksk, int sigclass, int digest_algo,
835                         u32 timestamp, u32 duration,
836                         int (*mksubpkt)(PKT_signature *, void *),
837                         void *opaque,
838                         const char *cache_nonce);
839 gpg_error_t update_keysig_packet (PKT_signature **ret_sig,
840                       PKT_signature *orig_sig,
841                       PKT_public_key *pk,
842                       PKT_user_id *uid,
843                       PKT_public_key *subpk,
844                       PKT_public_key *pksk,
845                       int (*mksubpkt)(PKT_signature *, void *),
846                       void *opaque   );
847
848 /*-- keygen.c --*/
849 PKT_user_id *generate_user_id (kbnode_t keyblock, const char *uidstr);
850
851 #endif /*G10_PACKET_H*/