See ChangeLog: Tue Jul 25 17:44:15 CEST 2000 Werner Koch
[gnupg.git] / g10 / packet.h
1 /* packet.h - packet read/write stuff
2  *      Copyright (C) 1998, 1999, 2000 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #ifndef GPG_PACKET_H
22 #define GPG_PACKET_H
23
24 #include "types.h"
25 #include "iobuf.h"
26 #include "filter.h"
27
28 #ifndef DID_MPI_TYPEDEF
29   typedef struct gcry_mpi *MPI;
30   #define DID_MPI_TYPEDEF
31 #endif
32
33 #define GNUPG_MAX_NPKEY  4
34 #define GNUPG_MAX_NSKEY  6
35 #define GNUPG_MAX_NSIG   2
36 #define GNUPG_MAX_NENC   2
37
38 #define DEBUG_PARSE_PACKET 1
39
40 typedef enum {
41         PKT_NONE           =0,
42         PKT_PUBKEY_ENC     =1, /* public key encrypted packet */
43         PKT_SIGNATURE      =2, /* secret key encrypted packet */
44         PKT_SYMKEY_ENC     =3, /* session key packet (OpenPGP)*/
45         PKT_ONEPASS_SIG    =4, /* one pass sig packet (OpenPGP)*/
46         PKT_SECRET_KEY     =5, /* secret key */
47         PKT_PUBLIC_KEY     =6, /* public key */
48         PKT_SECRET_SUBKEY  =7, /* secret subkey (OpenPGP) */
49         PKT_COMPRESSED     =8, /* compressed data packet */
50         PKT_ENCRYPTED      =9, /* conventional encrypted data */
51         PKT_MARKER        =10, /* marker packet (OpenPGP) */
52         PKT_PLAINTEXT     =11, /* plaintext data with filename and mode */
53         PKT_RING_TRUST    =12, /* keyring trust packet */
54         PKT_USER_ID       =13, /* user id packet */
55         PKT_PUBLIC_SUBKEY =14, /* public subkey (OpenPGP) */
56         PKT_OLD_COMMENT   =16, /* comment packet from an OpenPGP draft */
57         PKT_PHOTO_ID      =17, /* PGP's photo ID */
58         PKT_ENCRYPTED_MDC =18, /* integrity protected encrypted data */
59         PKT_MDC           =19, /* manipulaion detection code packet */
60         PKT_COMMENT       =61, /* new comment packet (private) */
61 } pkttype_t;
62
63 typedef struct packet_struct PACKET;
64
65 typedef struct {
66     int  mode;
67     byte hash_algo;
68     byte salt[8];
69     u32  count;
70 } STRING2KEY;
71
72 typedef struct {
73     byte version;
74     byte cipher_algo;    /* cipher algorithm used */
75     STRING2KEY s2k;
76     byte seskeylen;   /* keylength in byte or 0 for no seskey */
77     byte seskey[1];
78 } PKT_symkey_enc;
79
80 typedef struct {
81     u32     keyid[2];       /* 64 bit keyid */
82     byte    version;
83     byte    pubkey_algo;    /* algorithm used for public key scheme */
84     byte    throw_keyid;
85     MPI     data[GNUPG_MAX_NENC];
86 } PKT_pubkey_enc;
87
88
89 typedef struct {
90     u32     keyid[2];       /* 64 bit keyid */
91     byte    sig_class;      /* sig classification */
92     byte    digest_algo;    /* algorithm used for digest */
93     byte    pubkey_algo;    /* algorithm used for public key scheme */
94     byte    last;           /* a stupid flag */
95 } PKT_onepass_sig;
96
97
98 typedef struct {
99     ulong   local_id;       /* internal use, valid if > 0 */
100     struct {
101         unsigned checked:1; /* signature has been checked */
102         unsigned valid:1;   /* signature is good (if checked is set) */
103         unsigned unknown_critical:1;
104     } flags;
105     u32     keyid[2];       /* 64 bit keyid */
106     u32     timestamp;      /* signature made */
107     byte    version;
108     byte    sig_class;      /* sig classification, append for MD calculation*/
109     byte    pubkey_algo;    /* algorithm used for public key scheme */
110                             /* (GCRY_PK_xxx) */
111     byte digest_algo;       /* algorithm used for digest (DIGEST_ALGO_xxxx) */
112     byte *hashed_data;      /* all subpackets with hashed  data (v4 only) */
113     byte *unhashed_data;    /* ditto for unhashed data */
114     byte digest_start[2];   /* first 2 bytes of the digest */
115     MPI  data[GNUPG_MAX_NSIG];
116 } PKT_signature;
117
118
119 /****************
120  * Note about the pkey/skey elements:  We assume that the secret keys
121  * has the same elemts as the public key at the begin of the array, so
122  * that npkey < nskey and it is possible to compare the secret and
123  * public keys by comparing the first npkey elements of pkey againts skey.
124  */
125 typedef struct {
126     u32     timestamp;      /* key made */
127     u32     expiredate;     /* expires at this date or 0 if not at all */
128     byte    hdrbytes;       /* number of header bytes */
129     byte    version;
130     byte    pubkey_algo;    /* algorithm used for public key scheme */
131     byte    pubkey_usage;   /* for now only used to pass it to getkey() */
132     ulong   local_id;       /* internal use, valid if > 0 */
133     u32     keyid[2];       /* calculated by keyid_from_pk() */
134     byte    *namehash;      /* if != NULL: found by this name */
135     MPI     pkey[GNUPG_MAX_NPKEY];
136 } PKT_public_key;
137
138 typedef struct {
139     u32     timestamp;      /* key made */
140     u32     expiredate;     /* expires at this date or 0 if not at all */
141     byte    hdrbytes;       /* number of header bytes */
142     byte    version;
143     byte    pubkey_algo;    /* algorithm used for public key scheme */
144     byte    pubkey_usage;
145     byte is_primary;
146     byte is_protected;  /* The secret info is protected and must */
147                         /* be decrypted before use, the protected */
148                         /* MPIs are simply (void*) pointers to memory */
149                         /* and should never be passed to a mpi_xxx() */
150     struct {
151         byte algo;  /* cipher used to protect the secret information*/
152         STRING2KEY s2k;
153         byte ivlen;  /* used length of the iv */
154         byte iv[16]; /* initialization vector for CFB mode */
155     } protect;
156     MPI skey[GNUPG_MAX_NSKEY];
157     u16 csum;           /* checksum */
158 } PKT_secret_key;
159
160
161 typedef struct {
162     int  len;             /* length of data */
163     char data[1];
164 } PKT_comment;
165
166 typedef struct {
167     ulong stored_at;      /* the stream offset where it was stored
168                            * by build-packet */
169     int  len;             /* length of the name */
170     char *photo;          /* if this is not NULL, the packet is a photo ID */
171     int photolen;         /* and the length of the photo */
172     char name[1];
173 } PKT_user_id;
174
175 typedef struct {
176     u32  len;             /* reserved */
177     byte  new_ctb;
178     byte  algorithm;
179     IOBUF buf;            /* IOBUF reference */
180 } PKT_compressed;
181
182 typedef struct {
183     u32  len;             /* length of encrypted data */
184     byte new_ctb;         /* uses a new CTB */
185     byte mdc_method;      /* > 0: integrity protected encrypted data packet */
186     IOBUF buf;            /* IOBUF reference */
187 } PKT_encrypted;
188
189 typedef struct {
190     byte hash[20];
191 } PKT_mdc;
192
193 typedef struct {
194     unsigned int trustval;
195 } PKT_ring_trust;
196
197 typedef struct {
198     u32  len;             /* length of encrypted data */
199     IOBUF buf;            /* IOBUF reference */
200     byte new_ctb;
201     int mode;
202     u32 timestamp;
203     int  namelen;
204     char name[1];
205 } PKT_plaintext;
206
207
208 /* combine all packets into a union */
209 struct packet_struct {
210     pkttype_t pkttype;
211     union {
212         void *generic;
213         PKT_symkey_enc  *symkey_enc;    /* PKT_SYMKEY_ENC */
214         PKT_pubkey_enc  *pubkey_enc;    /* PKT_PUBKEY_ENC */
215         PKT_onepass_sig *onepass_sig;   /* PKT_ONEPASS_SIG */
216         PKT_signature   *signature;     /* PKT_SIGNATURE */
217         PKT_public_key  *public_key;    /* PKT_PUBLIC_[SUB)KEY */
218         PKT_secret_key  *secret_key;    /* PKT_SECRET_[SUB]KEY */
219         PKT_comment     *comment;       /* PKT_COMMENT */
220         PKT_user_id     *user_id;       /* PKT_USER_ID */
221         PKT_compressed  *compressed;    /* PKT_COMPRESSED */
222         PKT_encrypted   *encrypted;     /* PKT_ENCRYPTED[_MDC] */
223         PKT_mdc         *mdc;           /* PKT_MDC */
224         PKT_ring_trust  *ring_trust;    /* PKT_RING_TRUST */
225         PKT_plaintext   *plaintext;     /* PKT_PLAINTEXT */
226     } pkt;
227 };
228
229 #define init_packet(a) do { (a)->pkttype = 0;           \
230                             (a)->pkt.generic = NULL;    \
231                        } while(0)
232
233 typedef enum {
234     SIGSUBPKT_TEST_CRITICAL=-3,
235     SIGSUBPKT_LIST_UNHASHED=-2,
236     SIGSUBPKT_LIST_HASHED  =-1,
237     SIGSUBPKT_NONE         = 0,
238     SIGSUBPKT_SIG_CREATED  = 2, /* signature creation time */
239     SIGSUBPKT_SIG_EXPIRE   = 3, /* signature expiration time */
240     SIGSUBPKT_EXPORTABLE   = 4, /* exportable */
241     SIGSUBPKT_TRUST        = 5, /* trust signature */
242     SIGSUBPKT_REGEXP       = 6, /* regular expression */
243     SIGSUBPKT_REVOCABLE    = 7, /* revocable */
244     SIGSUBPKT_KEY_EXPIRE   = 9, /* key expiration time */
245     SIGSUBPKT_ARR          =10, /* additional recipient request */
246     SIGSUBPKT_PREF_SYM     =11, /* preferred symmetric algorithms */
247     SIGSUBPKT_REV_KEY      =12, /* revocation key */
248     SIGSUBPKT_ISSUER       =16, /* issuer key ID */
249     SIGSUBPKT_NOTATION     =20, /* notation data */
250     SIGSUBPKT_PREF_HASH    =21, /* preferred hash algorithms */
251     SIGSUBPKT_PREF_COMPR   =22, /* preferred compression algorithms */
252     SIGSUBPKT_KS_FLAGS     =23, /* key server preferences */
253     SIGSUBPKT_PREF_KS      =24, /* preferred key server */
254     SIGSUBPKT_PRIMARY_UID  =25, /* primary user id */
255     SIGSUBPKT_POLICY       =26, /* policy URL */
256     SIGSUBPKT_KEY_FLAGS    =27, /* key flags */
257     SIGSUBPKT_SIGNERS_UID  =28, /* signer's user id */
258     SIGSUBPKT_REVOC_REASON =29, /* reason for revocation */
259     SIGSUBPKT_PRIV_ADD_SIG =101,/* signatur is also valid for this uid */
260
261     SIGSUBPKT_FLAG_CRITICAL=128
262 } sigsubpkttype_t;
263
264
265 /*-- mainproc.c --*/
266 int proc_packets( void *ctx, IOBUF a );
267 int proc_signature_packets( void *ctx, IOBUF a,
268                             STRLIST signedfiles, const char *sigfile );
269 int proc_encryption_packets( void *ctx, IOBUF a );
270 int list_packets( IOBUF a );
271
272 /*-- parse-packet.c --*/
273 int set_packet_list_mode( int mode );
274
275 #if DEBUG_PARSE_PACKET
276 int dbg_search_packet( IOBUF inp, PACKET *pkt, int pkttype, ulong *retpos, const char* file, int lineno  );
277 int dbg_parse_packet( IOBUF inp, PACKET *ret_pkt, const char* file, int lineno );
278 int dbg_copy_all_packets( IOBUF inp, IOBUF out, const char* file, int lineno  );
279 int dbg_copy_some_packets( IOBUF inp, IOBUF out, ulong stopoff, const char* file, int lineno  );
280 int dbg_skip_some_packets( IOBUF inp, unsigned n, const char* file, int lineno  );
281 #define search_packet( a,b,c,d )   dbg_search_packet( (a), (b), (c), (d), __FILE__, __LINE__ )
282 #define parse_packet( a, b )       dbg_parse_packet( (a), (b), __FILE__, __LINE__ )
283 #define copy_all_packets( a,b )    dbg_copy_all_packets((a),(b), __FILE__, __LINE__ )
284 #define copy_some_packets( a,b,c ) dbg_copy_some_packets((a),(b),(c), __FILE__, __LINE__ )
285 #define skip_some_packets( a,b )   dbg_skip_some_packets((a),(b), __FILE__, __LINE__ )
286 #else
287 int search_packet( IOBUF inp, PACKET *pkt, int pkttype, ulong *retpos );
288 int parse_packet( IOBUF inp, PACKET *ret_pkt);
289 int copy_all_packets( IOBUF inp, IOBUF out );
290 int copy_some_packets( IOBUF inp, IOBUF out, ulong stopoff );
291 int skip_some_packets( IOBUF inp, unsigned n );
292 #endif
293
294 const byte *enum_sig_subpkt( const byte *buffer, sigsubpkttype_t reqtype,
295                                               size_t *ret_n, int *start );
296 const byte *parse_sig_subpkt( const byte *buffer, sigsubpkttype_t reqtype,
297                                        size_t *ret_n );
298 const byte *parse_sig_subpkt2( PKT_signature *sig,
299                                sigsubpkttype_t reqtype, size_t *ret_n );
300
301 /*-- build-packet.c --*/
302 int build_packet( IOBUF inp, PACKET *pkt );
303 u32 calc_packet_length( PACKET *pkt );
304 void hash_public_key( GCRY_MD_HD md, PKT_public_key *pk );
305 void build_sig_subpkt( PKT_signature *sig, sigsubpkttype_t type,
306                         const byte *buffer, size_t buflen );
307 void build_sig_subpkt_from_sig( PKT_signature *sig );
308
309 /*-- free-packet.c --*/
310 void free_symkey_enc( PKT_symkey_enc *enc );
311 void free_pubkey_enc( PKT_pubkey_enc *enc );
312 void free_seckey_enc( PKT_signature *enc );
313 int  digest_algo_from_sig( PKT_signature *sig );
314 void release_public_key_parts( PKT_public_key *pk );
315 void free_public_key( PKT_public_key *key );
316 void release_secret_key_parts( PKT_secret_key *sk );
317 void free_secret_key( PKT_secret_key *sk );
318 void free_user_id( PKT_user_id *uid );
319 void free_comment( PKT_comment *rem );
320 void free_packet( PACKET *pkt );
321 PKT_public_key *copy_public_key( PKT_public_key *d, PKT_public_key *s );
322 PKT_public_key *copy_public_key_new_namehash( PKT_public_key *d,
323                                               PKT_public_key *s,
324                                               const byte *namehash );
325 PKT_secret_key *copy_secret_key( PKT_secret_key *d, PKT_secret_key *s );
326 PKT_signature *copy_signature( PKT_signature *d, PKT_signature *s );
327 PKT_user_id *copy_user_id( PKT_user_id *d, PKT_user_id *s );
328 int cmp_public_keys( PKT_public_key *a, PKT_public_key *b );
329 int cmp_secret_keys( PKT_secret_key *a, PKT_secret_key *b );
330 int cmp_signatures( PKT_signature *a, PKT_signature *b );
331 int cmp_public_secret_key( PKT_public_key *pk, PKT_secret_key *sk );
332 int cmp_user_ids( PKT_user_id *a, PKT_user_id *b );
333
334
335 /*-- sig-check.c --*/
336 int signature_check( PKT_signature *sig, GCRY_MD_HD digest );
337
338 /*-- seckey-cert.c --*/
339 int is_secret_key_protected( PKT_secret_key *sk );
340 int check_secret_key( PKT_secret_key *sk, int retries );
341 int protect_secret_key( PKT_secret_key *sk, DEK *dek );
342
343 /*-- pubkey-enc.c --*/
344 int get_session_key( PKT_pubkey_enc *k, DEK *dek );
345
346 /*-- compress.c --*/
347 int handle_compressed( void *ctx, PKT_compressed *cd,
348                        int (*callback)(IOBUF, void *), void *passthru );
349
350 /*-- encr-data.c --*/
351 int decrypt_data( void *ctx, PKT_encrypted *ed, DEK *dek );
352
353 /*-- plaintext.c --*/
354 int handle_plaintext( PKT_plaintext *pt, md_filter_context_t *mfx,
355                                         int nooutput, int clearsig );
356 int ask_for_detached_datafile( GCRY_MD_HD md, GCRY_MD_HD md2,
357                                const char *inname, int textmode );
358
359 /*-- comment.c --*/
360 int write_comment( IOBUF out, const char *s );
361
362 /*-- sign.c --*/
363 int make_keysig_packet( PKT_signature **ret_sig, PKT_public_key *pk,
364                         PKT_user_id *uid, PKT_public_key *subpk,
365                         PKT_secret_key *sk,
366                         int sigclass, int digest_algo,
367                         int (*mksubpkt)(PKT_signature *, void *),
368                         void *opaque  );
369
370 /*-- keygen.c --*/
371 PKT_user_id *generate_user_id(void);
372
373 #endif /*GPG_PACKET_H*/