gpg: Add an exact search flag to the PK struct.
[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
33 #define DEBUG_PARSE_PACKET 1
34
35
36 /* Constants to allocate static MPI arrays. */
37 #define PUBKEY_MAX_NPKEY  5
38 #define PUBKEY_MAX_NSKEY  7
39 #define PUBKEY_MAX_NSIG   2
40 #define PUBKEY_MAX_NENC   2
41
42 /* Usage flags */
43 #define PUBKEY_USAGE_SIG     GCRY_PK_USAGE_SIGN  /* Good for signatures. */
44 #define PUBKEY_USAGE_ENC     GCRY_PK_USAGE_ENCR  /* Good for encryption. */
45 #define PUBKEY_USAGE_CERT    GCRY_PK_USAGE_CERT  /* Also good to certify keys.*/
46 #define PUBKEY_USAGE_AUTH    GCRY_PK_USAGE_AUTH  /* Good for authentication. */
47 #define PUBKEY_USAGE_UNKNOWN GCRY_PK_USAGE_UNKN  /* Unknown usage flag. */
48 #define PUBKEY_USAGE_NONE    256                 /* No usage given. */
49 #if  (GCRY_PK_USAGE_SIGN | GCRY_PK_USAGE_ENCR | GCRY_PK_USAGE_CERT \
50       | GCRY_PK_USAGE_AUTH | GCRY_PK_USAGE_UNKN) >= 256
51 # error Please choose another value for PUBKEY_USAGE_NONE
52 #endif
53
54 /* Helper macros.  */
55 #define is_RSA(a)     ((a)==PUBKEY_ALGO_RSA || (a)==PUBKEY_ALGO_RSA_E \
56                        || (a)==PUBKEY_ALGO_RSA_S )
57 #define is_ELGAMAL(a) ((a)==PUBKEY_ALGO_ELGAMAL_E)
58 #define is_DSA(a)     ((a)==PUBKEY_ALGO_DSA)
59
60 /* A pointer to the packet object.  */
61 typedef struct packet_struct PACKET;
62
63 /* PKT_GPG_CONTROL types */
64 typedef enum {
65     CTRLPKT_CLEARSIGN_START = 1,
66     CTRLPKT_PIPEMODE = 2,
67     CTRLPKT_PLAINTEXT_MARK =3
68 } ctrlpkttype_t;
69
70 typedef enum {
71     PREFTYPE_NONE = 0,
72     PREFTYPE_SYM = 1,
73     PREFTYPE_HASH = 2,
74     PREFTYPE_ZIP = 3
75 } preftype_t;
76
77 typedef struct {
78     byte type;
79     byte value;
80 } prefitem_t;
81
82 typedef struct
83 {
84   int  mode;      /* Must be an integer due to the GNU modes 1001 et al.  */
85   byte hash_algo;
86   byte salt[8];
87   u32  count;
88 } STRING2KEY;
89
90 typedef struct {
91     byte version;
92     byte cipher_algo;    /* cipher algorithm used */
93     STRING2KEY s2k;
94     byte seskeylen;   /* keylength in byte or 0 for no seskey */
95     byte seskey[1];
96 } PKT_symkey_enc;
97
98 typedef struct {
99     u32     keyid[2];       /* 64 bit keyid */
100     byte    version;
101     byte    pubkey_algo;    /* algorithm used for public key scheme */
102     byte    throw_keyid;
103     gcry_mpi_t     data[PUBKEY_MAX_NENC];
104 } PKT_pubkey_enc;
105
106
107 typedef struct {
108     u32     keyid[2];       /* 64 bit keyid */
109     byte    sig_class;      /* sig classification */
110     byte    digest_algo;    /* algorithm used for digest */
111     byte    pubkey_algo;    /* algorithm used for public key scheme */
112     byte    last;           /* a stupid flag */
113 } PKT_onepass_sig;
114
115
116 typedef struct {
117     size_t size;  /* allocated */
118     size_t len;   /* used */
119     byte data[1];
120 } subpktarea_t;
121
122 struct revocation_key {
123   byte class;
124   byte algid;
125   byte fpr[MAX_FINGERPRINT_LEN];
126 };
127
128
129 /* Object to keep information about a PKA DNS record. */
130 typedef struct
131 {
132   int valid;    /* An actual PKA record exists for EMAIL. */
133   int checked;  /* Set to true if the FPR has been checked against the
134                    actual key. */
135   char *uri;    /* Malloced string with the URI. NULL if the URI is
136                    not available.*/
137   unsigned char fpr[20]; /* The fingerprint as stored in the PKA RR. */
138   char email[1];/* The email address from the notation data. */
139 } pka_info_t;
140
141
142 /* Object to keep information pertaining to a signature. */
143 typedef struct
144 {
145   struct
146   {
147     unsigned checked:1;         /* Signature has been checked. */
148     unsigned valid:1;           /* Signature is good (if checked is set). */
149     unsigned chosen_selfsig:1;  /* A selfsig that is the chosen one. */
150     unsigned unknown_critical:1;
151     unsigned exportable:1;
152     unsigned revocable:1;
153     unsigned policy_url:1;  /* At least one policy URL is present */
154     unsigned notation:1;    /* At least one notation is present */
155     unsigned pref_ks:1;     /* At least one preferred keyserver is present */
156     unsigned expired:1;
157     unsigned pka_tried:1;   /* Set if we tried to retrieve the PKA record. */
158   } flags;
159   u32     keyid[2];       /* 64 bit keyid */
160   u32     timestamp;      /* Signature made (seconds since Epoch). */
161   u32     expiredate;     /* Expires at this date or 0 if not at all. */
162   byte    version;
163   byte    sig_class;      /* Sig classification, append for MD calculation. */
164   byte    pubkey_algo;    /* Algorithm used for public key scheme */
165                           /* (PUBKEY_ALGO_xxx) */
166   byte    digest_algo;    /* Algorithm used for digest (DIGEST_ALGO_xxxx). */
167   byte    trust_depth;
168   byte    trust_value;
169   const byte *trust_regexp;
170   struct revocation_key *revkey;
171   int numrevkeys;
172   pka_info_t *pka_info;      /* Malloced PKA data or NULL if not
173                                 available.  See also flags.pka_tried. */
174   subpktarea_t *hashed;      /* All subpackets with hashed data (v4 only). */
175   subpktarea_t *unhashed;    /* Ditto for unhashed data. */
176   byte digest_start[2];      /* First 2 bytes of the digest. */
177   gcry_mpi_t  data[PUBKEY_MAX_NSIG];
178   /* The message digest and its length (in bytes).  Note the maximum
179      digest length is 512 bits (64 bytes).  If DIGEST_LEN is 0, then
180      the digest's value has not been saved here.  */
181   byte digest[512 / 8];
182   int digest_len;
183 } PKT_signature;
184
185 #define ATTRIB_IMAGE 1
186
187 /* This is the cooked form of attributes.  */
188 struct user_attribute {
189   byte type;
190   const byte *data;
191   u32 len;
192 };
193
194
195 /* (See also keybox-search-desc.h) */
196 struct gpg_pkt_user_id_s
197 {
198   int ref;              /* reference counter */
199   int len;              /* length of the name */
200   struct user_attribute *attribs;
201   int numattribs;
202   byte *attrib_data;    /* if this is not NULL, the packet is an attribute */
203   unsigned long attrib_len;
204   byte *namehash;
205   int help_key_usage;
206   u32 help_key_expire;
207   int help_full_count;
208   int help_marginal_count;
209   int is_primary;       /* 2 if set via the primary flag, 1 if calculated */
210   int is_revoked;
211   int is_expired;
212   u32 expiredate;       /* expires at this date or 0 if not at all */
213   prefitem_t *prefs;    /* list of preferences (may be NULL)*/
214   u32 created;          /* according to the self-signature */
215   byte selfsigversion;
216   struct
217   {
218     /* TODO: Move more flags here */
219     unsigned int mdc:1;
220     unsigned int ks_modify:1;
221     unsigned int compacted:1;
222   } flags;
223   char name[1];
224 };
225 typedef struct gpg_pkt_user_id_s PKT_user_id;
226
227
228
229 struct revoke_info
230 {
231   /* revoked at this date */
232   u32 date;
233   /* the keyid of the revoking key (selfsig or designated revoker) */
234   u32 keyid[2];
235   /* the algo of the revoking key */
236   byte algo;
237 };
238
239
240 /* Information pertaining to secret keys. */
241 struct seckey_info
242 {
243   int is_protected:1;   /* The secret info is protected and must */
244                         /* be decrypted before use, the protected */
245                         /* MPIs are simply (void*) pointers to memory */
246                         /* and should never be passed to a mpi_xxx() */
247   int sha1chk:1;        /* SHA1 is used instead of a 16 bit checksum */
248   u16 csum;             /* Checksum for old protection modes.  */
249   byte algo;            /* Cipher used to protect the secret information. */
250   STRING2KEY s2k;       /* S2K parameter.  */
251   byte ivlen;           /* Used length of the IV.  */
252   byte iv[16];          /* Initialization vector for CFB mode.  */
253 };
254
255
256 /****************
257  * We assume that secret keys have the same number of parameters as
258  * the public key and that the public parameters are the first items
259  * in the PKEY array.  Thus NPKEY is always less than NSKEY and it is
260  * possible to compare the secret and public keys by comparing the
261  * first NPKEY elements of the PKEY array.  Note that since GnuPG 2.1
262  * we don't use secret keys anymore directly because they are managed
263  * by gpg-agent.  However for parsing OpenPGP key files we need a way
264  * to temporary store those secret keys.  We do this by putting them
265  * into the public key structure and extending the PKEY field to NSKEY
266  * elements; the extra secret key information are stored in the
267  * SECKEY_INFO field.
268  */
269 typedef struct
270 {
271   u32     timestamp;        /* key made */
272   u32     expiredate;     /* expires at this date or 0 if not at all */
273   u32     max_expiredate; /* must not expire past this date */
274   struct revoke_info revoked;
275   byte    hdrbytes;         /* number of header bytes */
276   byte    version;
277   byte    selfsigversion; /* highest version of all of the self-sigs */
278   byte    pubkey_algo;    /* algorithm used for public key scheme */
279   byte    pubkey_usage;   /* for now only used to pass it to getkey() */
280   byte    req_usage;      /* hack to pass a request to getkey() */
281   u32     has_expired;    /* set to the expiration date if expired */
282   u32     main_keyid[2];  /* keyid of the primary key */
283   u32     keyid[2];         /* calculated by keyid_from_pk() */
284   prefitem_t *prefs;      /* list of preferences (may be NULL) */
285   struct
286   {
287     unsigned int mdc:1;           /* MDC feature set.  */
288     unsigned int disabled_valid:1;/* The next flag is valid.  */
289     unsigned int disabled:1;      /* The key has been disabled.  */
290     unsigned int primary:1;       /* This is a primary key.  */
291     unsigned int revoked:2;       /* Key has been revoked.
292                                      1 = revoked by the owner
293                                      2 = revoked by designated revoker.  */
294     unsigned int maybe_revoked:1; /* A designated revocation is
295                                      present, but without the key to
296                                      check it.  */
297     unsigned int valid:1;         /* Key (especially subkey) is valid.  */
298     unsigned int dont_cache:1;    /* Do not cache this key.  */
299     unsigned int backsig:2;       /* 0=none, 1=bad, 2=good.  */
300     unsigned int serialno_valid:1;/* SERIALNO below is valid.  */
301     unsigned int exact:1;         /* Found via exact (!) search.  */
302   } flags;
303   PKT_user_id *user_id;   /* If != NULL: found by that uid. */
304   struct revocation_key *revkey;
305   int     numrevkeys;
306   u32     trust_timestamp;
307   byte    trust_depth;
308   byte    trust_value;
309   const byte *trust_regexp;
310   char    *serialno;      /* Malloced hex string or NULL if it is
311                              likely not on a card.  See also
312                              flags.serialno_valid.  */
313   struct seckey_info *seckey_info;  /* If not NULL this malloced
314                                        structure describes a secret
315                                        key.  */
316   gcry_mpi_t  pkey[PUBKEY_MAX_NSKEY]; /* Right, NSKEY elements.  */
317 } PKT_public_key;
318
319 /* Evaluates as true if the pk is disabled, and false if it isn't.  If
320    there is no disable value cached, fill one in. */
321 #define pk_is_disabled(a)                                       \
322   (((a)->flags.disabled_valid)?                                 \
323    ((a)->flags.disabled):(cache_disabled_value((a))))
324
325
326 typedef struct {
327     int  len;             /* length of data */
328     char data[1];
329 } PKT_comment;
330
331 typedef struct {
332     u32  len;             /* reserved */
333     byte  new_ctb;
334     byte  algorithm;
335     iobuf_t buf;          /* IOBUF reference */
336 } PKT_compressed;
337
338 typedef struct {
339     u32  len;             /* Remaining length of encrypted data. */
340     int  extralen;        /* This is (blocksize+2).  Used by build_packet. */
341     byte new_ctb;         /* uses a new CTB */
342     byte is_partial;      /* partial length encoded */
343     byte mdc_method;      /* > 0: integrity protected encrypted data packet */
344     iobuf_t buf;          /* IOBUF reference */
345 } PKT_encrypted;
346
347 typedef struct {
348     byte hash[20];
349 } PKT_mdc;
350
351 typedef struct {
352     unsigned int trustval;
353     unsigned int sigcache;
354 } PKT_ring_trust;
355
356 typedef struct {
357     u32  len;             /* length of encrypted data */
358     iobuf_t buf;          /* IOBUF reference */
359     byte new_ctb;
360     byte is_partial;      /* partial length encoded */
361     int mode;
362     u32 timestamp;
363     int  namelen;
364     char name[1];
365 } PKT_plaintext;
366
367 typedef struct {
368     int  control;
369     size_t datalen;
370     char data[1];
371 } PKT_gpg_control;
372
373 /* combine all packets into a union */
374 struct packet_struct {
375     pkttype_t pkttype;
376     union {
377         void *generic;
378         PKT_symkey_enc  *symkey_enc;    /* PKT_SYMKEY_ENC */
379         PKT_pubkey_enc  *pubkey_enc;    /* PKT_PUBKEY_ENC */
380         PKT_onepass_sig *onepass_sig;   /* PKT_ONEPASS_SIG */
381         PKT_signature   *signature;     /* PKT_SIGNATURE */
382         PKT_public_key  *public_key;    /* PKT_PUBLIC_[SUB]KEY */
383         PKT_public_key  *secret_key;    /* PKT_SECRET_[SUB]KEY */
384         PKT_comment     *comment;       /* PKT_COMMENT */
385         PKT_user_id     *user_id;       /* PKT_USER_ID */
386         PKT_compressed  *compressed;    /* PKT_COMPRESSED */
387         PKT_encrypted   *encrypted;     /* PKT_ENCRYPTED[_MDC] */
388         PKT_mdc         *mdc;           /* PKT_MDC */
389         PKT_ring_trust  *ring_trust;    /* PKT_RING_TRUST */
390         PKT_plaintext   *plaintext;     /* PKT_PLAINTEXT */
391         PKT_gpg_control *gpg_control;   /* PKT_GPG_CONTROL */
392     } pkt;
393 };
394
395 #define init_packet(a) do { (a)->pkttype = 0;           \
396                             (a)->pkt.generic = NULL;    \
397                        } while(0)
398
399
400 struct notation
401 {
402   char *name;
403   char *value;
404   char *altvalue;
405   unsigned char *bdat;
406   size_t blen;
407   struct
408   {
409     unsigned int critical:1;
410     unsigned int ignore:1;
411   } flags;
412   struct notation *next;
413 };
414
415 /*-- mainproc.c --*/
416 void reset_literals_seen(void);
417 int proc_packets (ctrl_t ctrl, void *ctx, iobuf_t a );
418 int proc_signature_packets (ctrl_t ctrl, void *ctx, iobuf_t a,
419                             strlist_t signedfiles, const char *sigfile );
420 int proc_signature_packets_by_fd (ctrl_t ctrl,
421                                   void *anchor, IOBUF a, int signed_data_fd );
422 int proc_encryption_packets (ctrl_t ctrl, void *ctx, iobuf_t a);
423 int list_packets( iobuf_t a );
424
425 /*-- parse-packet.c --*/
426
427 /* Sets the packet list mode to MODE (i.e., whether we are dumping a
428    packet or not).  Returns the current mode.  This allows for
429    temporarily suspending dumping by doing the following:
430
431      int saved_mode = set_packet_list_mode (0);
432      ...
433      set_packet_list_mode (saved_mode);
434 */
435 int set_packet_list_mode( int mode );
436
437 #if DEBUG_PARSE_PACKET
438 /* There are debug functions and should not be used directly.  */
439 int dbg_search_packet( iobuf_t inp, PACKET *pkt, off_t *retpos, int with_uid,
440                        const char* file, int lineno  );
441 int dbg_parse_packet( iobuf_t inp, PACKET *ret_pkt,
442                       const char* file, int lineno );
443 int dbg_copy_all_packets( iobuf_t inp, iobuf_t out,
444                           const char* file, int lineno  );
445 int dbg_copy_some_packets( iobuf_t inp, iobuf_t out, off_t stopoff,
446                            const char* file, int lineno  );
447 int dbg_skip_some_packets( iobuf_t inp, unsigned n,
448                            const char* file, int lineno );
449 #define search_packet( a,b,c,d )   \
450              dbg_search_packet( (a), (b), (c), (d), __FILE__, __LINE__ )
451 #define parse_packet( a, b )  \
452              dbg_parse_packet( (a), (b), __FILE__, __LINE__ )
453 #define copy_all_packets( a,b )  \
454              dbg_copy_all_packets((a),(b), __FILE__, __LINE__ )
455 #define copy_some_packets( a,b,c ) \
456              dbg_copy_some_packets((a),(b),(c), __FILE__, __LINE__ )
457 #define skip_some_packets( a,b ) \
458              dbg_skip_some_packets((a),(b), __FILE__, __LINE__ )
459 #else
460 /* Return the next valid OpenPGP packet in *PKT.  (This function will
461    skip any packets whose type is 0.)
462
463    Returns 0 on success, -1 if EOF is reached, and an error code
464    otherwise.  In the case of an error, the packet in *PKT may be
465    partially constructed.  As such, even if there is an error, it is
466    necessary to free *PKT to avoid a resource leak.  To detect what
467    has been allocated, clear *PKT before calling this function.  */
468 int parse_packet( iobuf_t inp, PACKET *pkt);
469
470 /* Return the first OpenPGP packet in *PKT that contains a key (either
471    a public subkey, a public key, a secret subkey or a secret key) or,
472    if WITH_UID is set, a user id.
473
474    Saves the position in the pipeline of the start of the returned
475    packet (according to iobuf_tell) in RETPOS, if it is not NULL.
476
477    The return semantics are the same as parse_packet.  */
478 int search_packet( iobuf_t inp, PACKET *pkt, off_t *retpos, int with_uid );
479
480 /* Copy all packets (except invalid packets, i.e., those with a type
481    of 0) from INP to OUT until either an error occurs or EOF is
482    reached.
483
484    Returns -1 when end of file is reached or an error code, if an
485    error occurred.  (Note: this function never returns 0, because it
486    effectively keeps going until it gets an EOF.)  */
487 int copy_all_packets( iobuf_t inp, iobuf_t out );
488
489 /* Like copy_all_packets, but stops at the first packet that starts at
490    or after STOPOFF (as indicated by iobuf_tell).
491
492    Example: if STOPOFF is 100, the first packet in INP goes from 0 to
493    110 and the next packet starts at offset 111, then the packet
494    starting at offset 0 will be completely processed (even though it
495    extends beyond STOPOFF) and the packet starting at offset 111 will
496    not be processed at all.  */
497 int copy_some_packets( iobuf_t inp, iobuf_t out, off_t stopoff );
498
499 /* Skips the next N packets from INP.
500
501    If parsing a packet returns an error code, then the function stops
502    immediately and returns the error code.  Note: in the case of an
503    error, this function does not indicate how many packets were
504    successfully processed.  */
505 int skip_some_packets( iobuf_t inp, unsigned n );
506 #endif
507
508 /* Parse a signature packet and store it in *SIG.
509
510    The signature packet is read from INP.  The OpenPGP header (the tag
511    and the packet's length) have already been read; the next byte read
512    from INP should be the first byte of the packet's contents.  The
513    packet's type (as extract from the tag) must be passed as PKTTYPE
514    and the packet's length must be passed as PKTLEN.  This is used as
515    the upper bound on the amount of data read from INP.  If the packet
516    is shorter than PKTLEN, the data at the end will be silently
517    skipped.  If an error occurs, an error code will be returned.  -1
518    means the EOF was encountered.  0 means parsing was successful.  */
519 int parse_signature( iobuf_t inp, int pkttype, unsigned long pktlen,
520                      PKT_signature *sig );
521
522 /* Given a subpacket area (typically either PKT_signature.hashed or
523    PKT_signature.unhashed), either:
524
525      - test whether there are any subpackets with the critical bit set
526        that we don't understand,
527
528      - list the subpackets, or,
529
530      - find a subpacket with a specific type.
531
532    REQTYPE indicates the type of operation.
533
534    If REQTYPE is SIGSUBPKT_TEST_CRITICAL, then this function checks
535    whether there are any subpackets that have the critical bit and
536    which GnuPG cannot handle.  If GnuPG understands all subpackets
537    whose critical bit is set, then this function returns simply
538    returns SUBPKTS.  If there is a subpacket whose critical bit is set
539    and which GnuPG does not understand, then this function returns
540    NULL and, if START is not NULL, sets *START to the 1-based index of
541    the subpacket that violates the constraint.
542
543    If REQTYPE is SIGSUBPKT_LIST_HASHED or SIGSUBPKT_LIST_UNHASHED, the
544    packets are dumped.  Note: if REQTYPE is SIGSUBPKT_LIST_HASHED,
545    this function does not check whether the hash is correct; this is
546    merely an indication of the section that the subpackets came from.
547
548    If REQTYPE is anything else, then this function interprets the
549    values as a subpacket type and looks for the first subpacket with
550    that type.  If such a packet is found, *CRITICAL (if not NULL) is
551    set if the critical bit was set, *RET_N is set to the offset of the
552    subpacket's content within the SUBPKTS buffer, *START is set to the
553    1-based index of the subpacket within the buffer, and returns
554    &SUBPKTS[*RET_N].
555
556    *START is the number of initial subpackets to not consider.  Thus,
557    if *START is 2, then the first 2 subpackets are ignored.  */
558 const byte *enum_sig_subpkt ( const subpktarea_t *subpkts,
559                               sigsubpkttype_t reqtype,
560                               size_t *ret_n, int *start, int *critical );
561
562 /* Shorthand for:
563
564      enum_sig_subpkt (buffer, reqtype, ret_n, NULL, NULL); */
565 const byte *parse_sig_subpkt ( const subpktarea_t *buffer,
566                                sigsubpkttype_t reqtype,
567                                size_t *ret_n );
568
569 /* This calls parse_sig_subpkt first on the hashed signature area in
570    SIG and then, if that returns NULL, calls parse_sig_subpkt on the
571    unhashed subpacket area in SIG.  */
572 const byte *parse_sig_subpkt2 ( PKT_signature *sig,
573                                 sigsubpkttype_t reqtype);
574
575 /* Returns whether the N byte large buffer BUFFER is sufficient to
576    hold a subpacket of type TYPE.  Note: the buffer refers to the
577    contents of the subpacket (not the header) and it must already be
578    initialized: for some subpackets, it checks some internal
579    constraints.
580
581    Returns 0 if the size is acceptable.  Returns -2 if the buffer is
582    definitely too short.  To check for an error, check whether the
583    return value is less than 0.  */
584 int parse_one_sig_subpkt( const byte *buffer, size_t n, int type );
585
586 /* Looks for revocation key subpackets (see RFC 4880 5.2.3.15) in the
587    hashed area of the signature packet.  Any that are found are added
588    to SIG->REVKEY and SIG->NUMREVKEYS is updated appropriately.  */
589 void parse_revkeys(PKT_signature *sig);
590
591 /* Extract the attributes from the buffer at UID->ATTRIB_DATA and
592    update UID->ATTRIBS and UID->NUMATTRIBS accordingly.  */
593 int parse_attribute_subpkts(PKT_user_id *uid);
594
595 /* Set the UID->NAME field according to the attributes.  MAX_NAMELEN
596    must be at least 71.  */
597 void make_attribute_uidname(PKT_user_id *uid, size_t max_namelen);
598
599 /* Allocate and initialize a new GPG control packet.  DATA is the data
600    to save in the packet.  */
601 PACKET *create_gpg_control ( ctrlpkttype_t type,
602                              const byte *data,
603                              size_t datalen );
604
605 /*-- build-packet.c --*/
606 int build_packet( iobuf_t inp, PACKET *pkt );
607 gpg_error_t gpg_mpi_write (iobuf_t out, gcry_mpi_t a);
608 gpg_error_t gpg_mpi_write_nohdr (iobuf_t out, gcry_mpi_t a);
609 u32 calc_packet_length( PACKET *pkt );
610 void build_sig_subpkt( PKT_signature *sig, sigsubpkttype_t type,
611                         const byte *buffer, size_t buflen );
612 void build_sig_subpkt_from_sig( PKT_signature *sig );
613 int  delete_sig_subpkt(subpktarea_t *buffer, sigsubpkttype_t type );
614 void build_attribute_subpkt(PKT_user_id *uid,byte type,
615                             const void *buf,u32 buflen,
616                             const void *header,u32 headerlen);
617 struct notation *string_to_notation(const char *string,int is_utf8);
618 struct notation *sig_to_notation(PKT_signature *sig);
619 void free_notation(struct notation *notation);
620
621 /*-- free-packet.c --*/
622 void free_symkey_enc( PKT_symkey_enc *enc );
623 void free_pubkey_enc( PKT_pubkey_enc *enc );
624 void free_seckey_enc( PKT_signature *enc );
625 void release_public_key_parts( PKT_public_key *pk );
626 void free_public_key( PKT_public_key *key );
627 void free_attributes(PKT_user_id *uid);
628 void free_user_id( PKT_user_id *uid );
629 void free_comment( PKT_comment *rem );
630 void free_packet( PACKET *pkt );
631 prefitem_t *copy_prefs (const prefitem_t *prefs);
632 PKT_public_key *copy_public_key( PKT_public_key *d, PKT_public_key *s );
633 PKT_signature *copy_signature( PKT_signature *d, PKT_signature *s );
634 PKT_user_id *scopy_user_id (PKT_user_id *sd );
635 int cmp_public_keys( PKT_public_key *a, PKT_public_key *b );
636 int cmp_signatures( PKT_signature *a, PKT_signature *b );
637 int cmp_user_ids( PKT_user_id *a, PKT_user_id *b );
638
639
640 /*-- sig-check.c --*/
641 /* Check a signature.  This is shorthand for check_signature2 with
642    the unnamed arguments passed as NULL.  */
643 int check_signature (PKT_signature *sig, gcry_md_hd_t digest);
644
645 /* Check a signature.  Looks up the public key from the key db.  (If
646    RET_PK is not NULL, it is returned in *RET_PK.)  DIGEST contains a
647    valid hash context that already includes the signed data.  This
648    function adds the relevant meta-data to the hash before finalizing
649    it and verifying the signature.  */
650 int check_signature2 (PKT_signature *sig, gcry_md_hd_t digest,
651                       u32 *r_expiredate, int *r_expired, int *r_revoked,
652                       PKT_public_key *ret_pk);
653
654
655 /*-- pubkey-enc.c --*/
656 gpg_error_t get_session_key (ctrl_t ctrl, PKT_pubkey_enc *k, DEK *dek);
657 gpg_error_t get_override_session_key (DEK *dek, const char *string);
658
659 /*-- compress.c --*/
660 int handle_compressed (ctrl_t ctrl, void *ctx, PKT_compressed *cd,
661                        int (*callback)(iobuf_t, void *), void *passthru );
662
663 /*-- encr-data.c --*/
664 int decrypt_data (ctrl_t ctrl, void *ctx, PKT_encrypted *ed, DEK *dek );
665
666 /*-- plaintext.c --*/
667 gpg_error_t get_output_file (const byte *embedded_name, int embedded_namelen,
668                              iobuf_t data, char **fnamep, estream_t *fpp);
669 int handle_plaintext( PKT_plaintext *pt, md_filter_context_t *mfx,
670                                         int nooutput, int clearsig );
671 int ask_for_detached_datafile( gcry_md_hd_t md, gcry_md_hd_t md2,
672                                const char *inname, int textmode );
673
674 /*-- sign.c --*/
675 int make_keysig_packet( PKT_signature **ret_sig, PKT_public_key *pk,
676                         PKT_user_id *uid, PKT_public_key *subpk,
677                         PKT_public_key *pksk, int sigclass, int digest_algo,
678                         u32 timestamp, u32 duration,
679                         int (*mksubpkt)(PKT_signature *, void *),
680                         void *opaque,
681                         const char *cache_nonce);
682 gpg_error_t update_keysig_packet (PKT_signature **ret_sig,
683                       PKT_signature *orig_sig,
684                       PKT_public_key *pk,
685                       PKT_user_id *uid,
686                       PKT_public_key *subpk,
687                       PKT_public_key *pksk,
688                       int (*mksubpkt)(PKT_signature *, void *),
689                       void *opaque   );
690
691 /*-- keygen.c --*/
692 PKT_user_id *generate_user_id (kbnode_t keyblock, const char *uidstr);
693
694 #endif /*G10_PACKET_H*/