build: Update config.{guess,sub} to {2016-05-15,2016-06-20}.
[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   char *mbox;   /* NULL or the result of mailbox_from_userid.  */
295   /* The text contained in the user id packet, which is normally the
296      name and email address of the key holder (See RFC 4880 5.11).
297      (Serialized.). For convenience an extra Nul is always appended.  */
298   char name[1];
299 } PKT_user_id;
300
301
302
303 struct revoke_info
304 {
305   /* revoked at this date */
306   u32 date;
307   /* the keyid of the revoking key (selfsig or designated revoker) */
308   u32 keyid[2];
309   /* the algo of the revoking key */
310   byte algo;
311 };
312
313
314 /* Information pertaining to secret keys. */
315 struct seckey_info
316 {
317   int is_protected:1;   /* The secret info is protected and must */
318                         /* be decrypted before use, the protected */
319                         /* MPIs are simply (void*) pointers to memory */
320                         /* and should never be passed to a mpi_xxx() */
321   int sha1chk:1;        /* SHA1 is used instead of a 16 bit checksum */
322   u16 csum;             /* Checksum for old protection modes.  */
323   byte algo;            /* Cipher used to protect the secret information. */
324   STRING2KEY s2k;       /* S2K parameter.  */
325   byte ivlen;           /* Used length of the IV.  */
326   byte iv[16];          /* Initialization vector for CFB mode.  */
327 };
328
329
330 /****************
331  * The in-memory representation of a public key (RFC 4880, Section
332  * 5.5).  Note: this structure contains significantly more information
333  * than is contained in an OpenPGP public key packet.  This
334  * information is derived from the self-signed signatures (by
335  * merge_keys_and_selfsig()) and is ignored when serializing the
336  * packet.  The fields that are actually written out when serializing
337  * this packet are marked as accordingly.
338  *
339  * We assume that secret keys have the same number of parameters as
340  * the public key and that the public parameters are the first items
341  * in the PKEY array.  Thus NPKEY is always less than NSKEY and it is
342  * possible to compare the secret and public keys by comparing the
343  * first NPKEY elements of the PKEY array.  Note that since GnuPG 2.1
344  * we don't use secret keys anymore directly because they are managed
345  * by gpg-agent.  However for parsing OpenPGP key files we need a way
346  * to temporary store those secret keys.  We do this by putting them
347  * into the public key structure and extending the PKEY field to NSKEY
348  * elements; the extra secret key information are stored in the
349  * SECKEY_INFO field.
350  */
351 typedef struct
352 {
353   /* When the key was created.  (Serialized.)  */
354   u32     timestamp;
355   u32     expiredate;     /* expires at this date or 0 if not at all */
356   u32     max_expiredate; /* must not expire past this date */
357   struct revoke_info revoked;
358   /* An OpenPGP packet consists of a header and a body.  This is the
359      size of the header.  If this is 0, an appropriate size is
360      automatically chosen based on the size of the body.
361      (Serialized.)  */
362   byte    hdrbytes;
363   /* The serialization format.  If 0, the default version (4) is used
364      when serializing.  (Serialized.)  */
365   byte    version;
366   byte    selfsigversion; /* highest version of all of the self-sigs */
367   /* The public key algorithm.  (Serialized.)  */
368   byte    pubkey_algo;
369   byte    pubkey_usage;   /* for now only used to pass it to getkey() */
370   byte    req_usage;      /* hack to pass a request to getkey() */
371   u32     has_expired;    /* set to the expiration date if expired */
372   /* keyid of the primary key.  Never access this value directly.
373      Instead, use pk_main_keyid().  */
374   u32     main_keyid[2];
375   /* keyid of this key.  Never access this value directly!  Instead,
376      use pk_keyid().  */
377   u32     keyid[2];
378   prefitem_t *prefs;      /* list of preferences (may be NULL) */
379   struct
380   {
381     unsigned int mdc:1;           /* MDC feature set.  */
382     unsigned int disabled_valid:1;/* The next flag is valid.  */
383     unsigned int disabled:1;      /* The key has been disabled.  */
384     unsigned int primary:1;       /* This is a primary key.  */
385     unsigned int revoked:2;       /* Key has been revoked.
386                                      1 = revoked by the owner
387                                      2 = revoked by designated revoker.  */
388     unsigned int maybe_revoked:1; /* A designated revocation is
389                                      present, but without the key to
390                                      check it.  */
391     unsigned int valid:1;         /* Key (especially subkey) is valid.  */
392     unsigned int dont_cache:1;    /* Do not cache this key.  */
393     unsigned int backsig:2;       /* 0=none, 1=bad, 2=good.  */
394     unsigned int serialno_valid:1;/* SERIALNO below is valid.  */
395     unsigned int exact:1;         /* Found via exact (!) search.  */
396   } flags;
397   PKT_user_id *user_id;   /* If != NULL: found by that uid. */
398   struct revocation_key *revkey;
399   int     numrevkeys;
400   u32     trust_timestamp;
401   byte    trust_depth;
402   byte    trust_value;
403   const byte *trust_regexp;
404   char    *serialno;      /* Malloced hex string or NULL if it is
405                              likely not on a card.  See also
406                              flags.serialno_valid.  */
407   /* If not NULL this malloced structure describes a secret key.
408      (Serialized.)  */
409   struct seckey_info *seckey_info;
410   /* The public key.  Contains pubkey_get_npkey (pubkey_algo) +
411      pubkey_get_nskey (pubkey_algo) MPIs.  (If pubkey_get_npkey
412      returns 0, then the algorithm is not understood and the PKEY
413      contains a single opaque MPI.)  (Serialized.)  */
414   gcry_mpi_t  pkey[PUBKEY_MAX_NSKEY]; /* Right, NSKEY elements.  */
415 } PKT_public_key;
416
417 /* Evaluates as true if the pk is disabled, and false if it isn't.  If
418    there is no disable value cached, fill one in. */
419 #define pk_is_disabled(a)                                       \
420   (((a)->flags.disabled_valid)?                                 \
421    ((a)->flags.disabled):(cache_disabled_value((a))))
422
423
424 typedef struct {
425     int  len;             /* length of data */
426     char data[1];
427 } PKT_comment;
428
429 /* A compression packet (RFC 4880, Section 5.6).  */
430 typedef struct {
431   /* Not used.  */
432   u32 len;
433   /* Whether the serialized version of the packet used / should use
434      the new format.  */
435   byte  new_ctb;
436   /* The compression algorithm.  */
437   byte  algorithm;
438   /* An iobuf holding the data to be decompressed.  (This is not used
439      for compression!)  */
440   iobuf_t buf;
441 } PKT_compressed;
442
443 /* A symmetrically encrypted data packet (RFC 4880, Section 5.7) or a
444    symmetrically encrypted integrity protected data packet (Section
445    5.13) */
446 typedef struct {
447   /* Remaining length of encrypted data. */
448   u32  len;
449   /* When encrypting, the first block size bytes of data are random
450      data and the following 2 bytes are copies of the last two bytes
451      of the random data (RFC 4880, Section 5.7).  This provides a
452      simple check that the key is correct.  extralen is the size of
453      this extra data.  This is used by build_packet when writing out
454      the packet's header. */
455   int  extralen;
456   /* Whether the serialized version of the packet used / should use
457      the new format.  */
458   byte new_ctb;
459   /* Whether the packet has an indeterminate length (old format) or
460      was encoded using partial body length headers (new format).
461      Note: this is ignored when encrypting.  */
462   byte is_partial;
463   /* If 0, MDC is disabled.  Otherwise, the MDC method that was used
464      (currently, only DIGEST_ALGO_SHA1 is supported).  */
465   byte mdc_method;
466   /* An iobuf holding the data to be decrypted.  (This is not used for
467      encryption!)  */
468   iobuf_t buf;
469 } PKT_encrypted;
470
471 typedef struct {
472     byte hash[20];
473 } PKT_mdc;
474
475 typedef struct {
476     unsigned int trustval;
477     unsigned int sigcache;
478 } PKT_ring_trust;
479
480 /* A plaintext packet (see RFC 4880, 5.9).  */
481 typedef struct {
482   /* The length of data in BUF or 0 if unknown.  */
483   u32  len;
484   /* A buffer containing the data stored in the packet's body.  */
485   iobuf_t buf;
486   byte new_ctb;
487   byte is_partial;      /* partial length encoded */
488   /* The data's formatting.  This is either 'b', 't', 'u', 'l' or '1'
489      (however, the last two are deprecated).  */
490   int mode;
491   u32 timestamp;
492   /* The name of the file.  This can be at most 255 characters long,
493      since namelen is just a byte in the serialized format.  */
494   int  namelen;
495   char name[1];
496 } PKT_plaintext;
497
498 typedef struct {
499     int  control;
500     size_t datalen;
501     char data[1];
502 } PKT_gpg_control;
503
504 /* combine all packets into a union */
505 struct packet_struct {
506     pkttype_t pkttype;
507     union {
508         void *generic;
509         PKT_symkey_enc  *symkey_enc;    /* PKT_SYMKEY_ENC */
510         PKT_pubkey_enc  *pubkey_enc;    /* PKT_PUBKEY_ENC */
511         PKT_onepass_sig *onepass_sig;   /* PKT_ONEPASS_SIG */
512         PKT_signature   *signature;     /* PKT_SIGNATURE */
513         PKT_public_key  *public_key;    /* PKT_PUBLIC_[SUB]KEY */
514         PKT_public_key  *secret_key;    /* PKT_SECRET_[SUB]KEY */
515         PKT_comment     *comment;       /* PKT_COMMENT */
516         PKT_user_id     *user_id;       /* PKT_USER_ID */
517         PKT_compressed  *compressed;    /* PKT_COMPRESSED */
518         PKT_encrypted   *encrypted;     /* PKT_ENCRYPTED[_MDC] */
519         PKT_mdc         *mdc;           /* PKT_MDC */
520         PKT_ring_trust  *ring_trust;    /* PKT_RING_TRUST */
521         PKT_plaintext   *plaintext;     /* PKT_PLAINTEXT */
522         PKT_gpg_control *gpg_control;   /* PKT_GPG_CONTROL */
523     } pkt;
524 };
525
526 #define init_packet(a) do { (a)->pkttype = 0;           \
527                             (a)->pkt.generic = NULL;    \
528                        } while(0)
529
530
531 /* A notation.  See RFC 4880, Section 5.2.3.16.  */
532 struct notation
533 {
534   /* The notation's name.  */
535   char *name;
536   /* If the notation is human readable, then the value is stored here
537      as a NUL-terminated string.  If it is not human readable a human
538      readable approximation of the binary value _may_ be stored
539      here.  */
540   char *value;
541   /* Sometimes we want to %-expand the value.  In these cases, we save
542      that transformed value here.  */
543   char *altvalue;
544   /* If the notation is not human readable, then the value is stored
545      here.  */
546   unsigned char *bdat;
547   /* The amount of data stored in BDAT.
548
549      Note: if this is 0 and BDAT is NULL, this does not necessarily
550      mean that the value is human readable.  It could be that we have
551      a 0-length value.  To determine whether the notation is human
552      readable, always check if VALUE is not NULL.  This works, because
553      if a human-readable value has a length of 0, we will still
554      allocate space for the NUL byte.  */
555   size_t blen;
556   struct
557   {
558     /* The notation is critical.  */
559     unsigned int critical:1;
560     /* The notation is human readable.  */
561     unsigned int human:1;
562     /* The notation should be deleted.  */
563     unsigned int ignore:1;
564   } flags;
565
566   /* A field to facilitate creating a list of notations.  */
567   struct notation *next;
568 };
569 typedef struct notation *notation_t;
570
571 /*-- mainproc.c --*/
572 void reset_literals_seen(void);
573 int proc_packets (ctrl_t ctrl, void *ctx, iobuf_t a );
574 int proc_signature_packets (ctrl_t ctrl, void *ctx, iobuf_t a,
575                             strlist_t signedfiles, const char *sigfile );
576 int proc_signature_packets_by_fd (ctrl_t ctrl,
577                                   void *anchor, IOBUF a, int signed_data_fd );
578 int proc_encryption_packets (ctrl_t ctrl, void *ctx, iobuf_t a);
579 int list_packets( iobuf_t a );
580
581 /*-- parse-packet.c --*/
582
583 /* Sets the packet list mode to MODE (i.e., whether we are dumping a
584    packet or not).  Returns the current mode.  This allows for
585    temporarily suspending dumping by doing the following:
586
587      int saved_mode = set_packet_list_mode (0);
588      ...
589      set_packet_list_mode (saved_mode);
590 */
591 int set_packet_list_mode( int mode );
592
593 #if DEBUG_PARSE_PACKET
594 /* There are debug functions and should not be used directly.  */
595 int dbg_search_packet( iobuf_t inp, PACKET *pkt, off_t *retpos, int with_uid,
596                        const char* file, int lineno  );
597 int dbg_parse_packet( iobuf_t inp, PACKET *ret_pkt,
598                       const char* file, int lineno );
599 int dbg_copy_all_packets( iobuf_t inp, iobuf_t out,
600                           const char* file, int lineno  );
601 int dbg_copy_some_packets( iobuf_t inp, iobuf_t out, off_t stopoff,
602                            const char* file, int lineno  );
603 int dbg_skip_some_packets( iobuf_t inp, unsigned n,
604                            const char* file, int lineno );
605 #define search_packet( a,b,c,d )   \
606              dbg_search_packet( (a), (b), (c), (d), __FILE__, __LINE__ )
607 #define parse_packet( a, b )  \
608              dbg_parse_packet( (a), (b), __FILE__, __LINE__ )
609 #define copy_all_packets( a,b )  \
610              dbg_copy_all_packets((a),(b), __FILE__, __LINE__ )
611 #define copy_some_packets( a,b,c ) \
612              dbg_copy_some_packets((a),(b),(c), __FILE__, __LINE__ )
613 #define skip_some_packets( a,b ) \
614              dbg_skip_some_packets((a),(b), __FILE__, __LINE__ )
615 #else
616 /* Return the next valid OpenPGP packet in *PKT.  (This function will
617    skip any packets whose type is 0.)
618
619    Returns 0 on success, -1 if EOF is reached, and an error code
620    otherwise.  In the case of an error, the packet in *PKT may be
621    partially constructed.  As such, even if there is an error, it is
622    necessary to free *PKT to avoid a resource leak.  To detect what
623    has been allocated, clear *PKT before calling this function.  */
624 int parse_packet( iobuf_t inp, PACKET *pkt);
625
626 /* Return the first OpenPGP packet in *PKT that contains a key (either
627    a public subkey, a public key, a secret subkey or a secret key) or,
628    if WITH_UID is set, a user id.
629
630    Saves the position in the pipeline of the start of the returned
631    packet (according to iobuf_tell) in RETPOS, if it is not NULL.
632
633    The return semantics are the same as parse_packet.  */
634 int search_packet( iobuf_t inp, PACKET *pkt, off_t *retpos, int with_uid );
635
636 /* Copy all packets (except invalid packets, i.e., those with a type
637    of 0) from INP to OUT until either an error occurs or EOF is
638    reached.
639
640    Returns -1 when end of file is reached or an error code, if an
641    error occurred.  (Note: this function never returns 0, because it
642    effectively keeps going until it gets an EOF.)  */
643 int copy_all_packets( iobuf_t inp, iobuf_t out );
644
645 /* Like copy_all_packets, but stops at the first packet that starts at
646    or after STOPOFF (as indicated by iobuf_tell).
647
648    Example: if STOPOFF is 100, the first packet in INP goes from 0 to
649    110 and the next packet starts at offset 111, then the packet
650    starting at offset 0 will be completely processed (even though it
651    extends beyond STOPOFF) and the packet starting at offset 111 will
652    not be processed at all.  */
653 int copy_some_packets( iobuf_t inp, iobuf_t out, off_t stopoff );
654
655 /* Skips the next N packets from INP.
656
657    If parsing a packet returns an error code, then the function stops
658    immediately and returns the error code.  Note: in the case of an
659    error, this function does not indicate how many packets were
660    successfully processed.  */
661 int skip_some_packets( iobuf_t inp, unsigned n );
662 #endif
663
664 /* Parse a signature packet and store it in *SIG.
665
666    The signature packet is read from INP.  The OpenPGP header (the tag
667    and the packet's length) have already been read; the next byte read
668    from INP should be the first byte of the packet's contents.  The
669    packet's type (as extract from the tag) must be passed as PKTTYPE
670    and the packet's length must be passed as PKTLEN.  This is used as
671    the upper bound on the amount of data read from INP.  If the packet
672    is shorter than PKTLEN, the data at the end will be silently
673    skipped.  If an error occurs, an error code will be returned.  -1
674    means the EOF was encountered.  0 means parsing was successful.  */
675 int parse_signature( iobuf_t inp, int pkttype, unsigned long pktlen,
676                      PKT_signature *sig );
677
678 /* Given a subpacket area (typically either PKT_signature.hashed or
679    PKT_signature.unhashed), either:
680
681      - test whether there are any subpackets with the critical bit set
682        that we don't understand,
683
684      - list the subpackets, or,
685
686      - find a subpacket with a specific type.
687
688    REQTYPE indicates the type of operation.
689
690    If REQTYPE is SIGSUBPKT_TEST_CRITICAL, then this function checks
691    whether there are any subpackets that have the critical bit and
692    which GnuPG cannot handle.  If GnuPG understands all subpackets
693    whose critical bit is set, then this function returns simply
694    returns SUBPKTS.  If there is a subpacket whose critical bit is set
695    and which GnuPG does not understand, then this function returns
696    NULL and, if START is not NULL, sets *START to the 1-based index of
697    the subpacket that violates the constraint.
698
699    If REQTYPE is SIGSUBPKT_LIST_HASHED or SIGSUBPKT_LIST_UNHASHED, the
700    packets are dumped.  Note: if REQTYPE is SIGSUBPKT_LIST_HASHED,
701    this function does not check whether the hash is correct; this is
702    merely an indication of the section that the subpackets came from.
703
704    If REQTYPE is anything else, then this function interprets the
705    values as a subpacket type and looks for the first subpacket with
706    that type.  If such a packet is found, *CRITICAL (if not NULL) is
707    set if the critical bit was set, *RET_N is set to the offset of the
708    subpacket's content within the SUBPKTS buffer, *START is set to the
709    1-based index of the subpacket within the buffer, and returns
710    &SUBPKTS[*RET_N].
711
712    *START is the number of initial subpackets to not consider.  Thus,
713    if *START is 2, then the first 2 subpackets are ignored.  */
714 const byte *enum_sig_subpkt ( const subpktarea_t *subpkts,
715                               sigsubpkttype_t reqtype,
716                               size_t *ret_n, int *start, int *critical );
717
718 /* Shorthand for:
719
720      enum_sig_subpkt (buffer, reqtype, ret_n, NULL, NULL); */
721 const byte *parse_sig_subpkt ( const subpktarea_t *buffer,
722                                sigsubpkttype_t reqtype,
723                                size_t *ret_n );
724
725 /* This calls parse_sig_subpkt first on the hashed signature area in
726    SIG and then, if that returns NULL, calls parse_sig_subpkt on the
727    unhashed subpacket area in SIG.  */
728 const byte *parse_sig_subpkt2 ( PKT_signature *sig,
729                                 sigsubpkttype_t reqtype);
730
731 /* Returns whether the N byte large buffer BUFFER is sufficient to
732    hold a subpacket of type TYPE.  Note: the buffer refers to the
733    contents of the subpacket (not the header) and it must already be
734    initialized: for some subpackets, it checks some internal
735    constraints.
736
737    Returns 0 if the size is acceptable.  Returns -2 if the buffer is
738    definitely too short.  To check for an error, check whether the
739    return value is less than 0.  */
740 int parse_one_sig_subpkt( const byte *buffer, size_t n, int type );
741
742 /* Looks for revocation key subpackets (see RFC 4880 5.2.3.15) in the
743    hashed area of the signature packet.  Any that are found are added
744    to SIG->REVKEY and SIG->NUMREVKEYS is updated appropriately.  */
745 void parse_revkeys(PKT_signature *sig);
746
747 /* Extract the attributes from the buffer at UID->ATTRIB_DATA and
748    update UID->ATTRIBS and UID->NUMATTRIBS accordingly.  */
749 int parse_attribute_subpkts(PKT_user_id *uid);
750
751 /* Set the UID->NAME field according to the attributes.  MAX_NAMELEN
752    must be at least 71.  */
753 void make_attribute_uidname(PKT_user_id *uid, size_t max_namelen);
754
755 /* Allocate and initialize a new GPG control packet.  DATA is the data
756    to save in the packet.  */
757 PACKET *create_gpg_control ( ctrlpkttype_t type,
758                              const byte *data,
759                              size_t datalen );
760
761 /*-- build-packet.c --*/
762 int build_packet( iobuf_t inp, PACKET *pkt );
763 gpg_error_t gpg_mpi_write (iobuf_t out, gcry_mpi_t a);
764 gpg_error_t gpg_mpi_write_nohdr (iobuf_t out, gcry_mpi_t a);
765 u32 calc_packet_length( PACKET *pkt );
766 void build_sig_subpkt( PKT_signature *sig, sigsubpkttype_t type,
767                         const byte *buffer, size_t buflen );
768 void build_sig_subpkt_from_sig (PKT_signature *sig, PKT_public_key *pksk);
769 int  delete_sig_subpkt(subpktarea_t *buffer, sigsubpkttype_t type );
770 void build_attribute_subpkt(PKT_user_id *uid,byte type,
771                             const void *buf,u32 buflen,
772                             const void *header,u32 headerlen);
773 struct notation *string_to_notation(const char *string,int is_utf8);
774 struct notation *blob_to_notation(const char *name,
775                                   const char *data, size_t len);
776 struct notation *sig_to_notation(PKT_signature *sig);
777 void free_notation(struct notation *notation);
778
779 /*-- free-packet.c --*/
780 void free_symkey_enc( PKT_symkey_enc *enc );
781 void free_pubkey_enc( PKT_pubkey_enc *enc );
782 void free_seckey_enc( PKT_signature *enc );
783 void release_public_key_parts( PKT_public_key *pk );
784 void free_public_key( PKT_public_key *key );
785 void free_attributes(PKT_user_id *uid);
786 void free_user_id( PKT_user_id *uid );
787 void free_comment( PKT_comment *rem );
788 void free_packet( PACKET *pkt );
789 prefitem_t *copy_prefs (const prefitem_t *prefs);
790 PKT_public_key *copy_public_key( PKT_public_key *d, PKT_public_key *s );
791 PKT_signature *copy_signature( PKT_signature *d, PKT_signature *s );
792 PKT_user_id *scopy_user_id (PKT_user_id *sd );
793 int cmp_public_keys( PKT_public_key *a, PKT_public_key *b );
794 int cmp_signatures( PKT_signature *a, PKT_signature *b );
795 int cmp_user_ids( PKT_user_id *a, PKT_user_id *b );
796
797
798 /*-- sig-check.c --*/
799 /* Check a signature.  This is shorthand for check_signature2 with
800    the unnamed arguments passed as NULL.  */
801 int check_signature (PKT_signature *sig, gcry_md_hd_t digest);
802
803 /* Check a signature.  Looks up the public key from the key db.  (If
804    RET_PK is not NULL, it is returned in *RET_PK.)  DIGEST contains a
805    valid hash context that already includes the signed data.  This
806    function adds the relevant meta-data to the hash before finalizing
807    it and verifying the signature.  */
808 int check_signature2 (PKT_signature *sig, gcry_md_hd_t digest,
809                       u32 *r_expiredate, int *r_expired, int *r_revoked,
810                       PKT_public_key *ret_pk);
811
812
813 /*-- pubkey-enc.c --*/
814 gpg_error_t get_session_key (ctrl_t ctrl, PKT_pubkey_enc *k, DEK *dek);
815 gpg_error_t get_override_session_key (DEK *dek, const char *string);
816
817 /*-- compress.c --*/
818 int handle_compressed (ctrl_t ctrl, void *ctx, PKT_compressed *cd,
819                        int (*callback)(iobuf_t, void *), void *passthru );
820
821 /*-- encr-data.c --*/
822 int decrypt_data (ctrl_t ctrl, void *ctx, PKT_encrypted *ed, DEK *dek );
823
824 /*-- plaintext.c --*/
825 gpg_error_t get_output_file (const byte *embedded_name, int embedded_namelen,
826                              iobuf_t data, char **fnamep, estream_t *fpp);
827 int handle_plaintext( PKT_plaintext *pt, md_filter_context_t *mfx,
828                                         int nooutput, int clearsig );
829 int ask_for_detached_datafile( gcry_md_hd_t md, gcry_md_hd_t md2,
830                                const char *inname, int textmode );
831
832 /*-- sign.c --*/
833 int make_keysig_packet( PKT_signature **ret_sig, PKT_public_key *pk,
834                         PKT_user_id *uid, PKT_public_key *subpk,
835                         PKT_public_key *pksk, int sigclass, int digest_algo,
836                         u32 timestamp, u32 duration,
837                         int (*mksubpkt)(PKT_signature *, void *),
838                         void *opaque,
839                         const char *cache_nonce);
840 gpg_error_t update_keysig_packet (PKT_signature **ret_sig,
841                       PKT_signature *orig_sig,
842                       PKT_public_key *pk,
843                       PKT_user_id *uid,
844                       PKT_public_key *subpk,
845                       PKT_public_key *pksk,
846                       int (*mksubpkt)(PKT_signature *, void *),
847                       void *opaque   );
848
849 /*-- keygen.c --*/
850 PKT_user_id *generate_user_id (kbnode_t keyblock, const char *uidstr);
851
852 #endif /*G10_PACKET_H*/