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