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