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