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