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