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