See ChangeLog: Fri Oct 6 14:29:16 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;   /* the actual allowed usage as set by getkey() */
132     u32     created;        /* according to the self-signature */
133     byte    req_usage;      /* hack to pass a request to getkey() */
134     byte    req_algo;       /* Ditto */
135     u32     has_expired;    /* set to the expiration date if expired */ 
136     int     is_revoked;     /* key has been revoked */
137     int     is_valid;       /* key (especially subkey) is valid */
138     ulong   local_id;       /* internal use, valid if > 0 */
139     u32     main_keyid[2];  /* keyid of the primary key */
140     u32     keyid[2];       /* calculated by keyid_from_pk() */
141     byte    *namehash;      /* if != NULL: found by this name */
142     MPI     pkey[GNUPG_MAX_NPKEY];
143 } PKT_public_key;
144
145 typedef struct {
146     u32     timestamp;      /* key made */
147     u32     expiredate;     /* expires at this date or 0 if not at all */
148     byte    hdrbytes;       /* number of header bytes */
149     byte    version;
150     byte    pubkey_algo;    /* algorithm used for public key scheme */
151     byte    pubkey_usage;
152     u32     created;        /* according to the self-signature */
153     byte    req_usage;
154     byte    req_algo;
155     u32     has_expired;    /* set to the expiration date if expired */ 
156     int     is_revoked;     /* key has been revoked */
157     int     is_valid;       /* key (especially subkey) is valid */
158     u32     main_keyid[2];  /* keyid of the primary key */
159     u32     keyid[2];   
160     byte is_primary;
161     byte is_protected;  /* The secret info is protected and must */
162                         /* be decrypted before use, the protected */
163                         /* MPIs are simply (void*) pointers to memory */
164                         /* and should never be passed to a mpi_xxx() */
165     struct {
166         byte algo;  /* cipher used to protect the secret information*/
167         STRING2KEY s2k;
168         byte ivlen;  /* used length of the iv */
169         byte iv[16]; /* initialization vector for CFB mode */
170     } protect;
171     MPI skey[GNUPG_MAX_NSKEY];
172     u16 csum;           /* checksum */
173 } PKT_secret_key;
174
175
176 typedef struct {
177     int  len;             /* length of data */
178     char data[1];
179 } PKT_comment;
180
181 typedef struct {
182     ulong stored_at;      /* the stream offset where it was stored
183                            * by build-packet */
184     int  len;             /* length of the name */
185     char *photo;          /* if this is not NULL, the packet is a photo ID */
186     int photolen;         /* and the length of the photo */
187     int help_key_usage;
188     u32 help_key_expire;
189     int is_primary;
190     u32 created;          /* according to the self-signature */
191     char name[1];
192 } PKT_user_id;
193
194 typedef struct {
195     u32  len;             /* reserved */
196     byte  new_ctb;
197     byte  algorithm;
198     IOBUF buf;            /* IOBUF reference */
199 } PKT_compressed;
200
201 typedef struct {
202     u32  len;             /* length of encrypted data */
203     byte new_ctb;         /* uses a new CTB */
204     byte mdc_method;      /* > 0: integrity protected encrypted data packet */
205     IOBUF buf;            /* IOBUF reference */
206 } PKT_encrypted;
207
208 typedef struct {
209     byte hash[20];
210 } PKT_mdc;
211
212 typedef struct {
213     unsigned int trustval;
214 } PKT_ring_trust;
215
216 typedef struct {
217     u32  len;             /* length of encrypted data */
218     IOBUF buf;            /* IOBUF reference */
219     byte new_ctb;
220     int mode;
221     u32 timestamp;
222     int  namelen;
223     char name[1];
224 } PKT_plaintext;
225
226
227 /* combine all packets into a union */
228 struct packet_struct {
229     pkttype_t pkttype;
230     union {
231         void *generic;
232         PKT_symkey_enc  *symkey_enc;    /* PKT_SYMKEY_ENC */
233         PKT_pubkey_enc  *pubkey_enc;    /* PKT_PUBKEY_ENC */
234         PKT_onepass_sig *onepass_sig;   /* PKT_ONEPASS_SIG */
235         PKT_signature   *signature;     /* PKT_SIGNATURE */
236         PKT_public_key  *public_key;    /* PKT_PUBLIC_[SUB)KEY */
237         PKT_secret_key  *secret_key;    /* PKT_SECRET_[SUB]KEY */
238         PKT_comment     *comment;       /* PKT_COMMENT */
239         PKT_user_id     *user_id;       /* PKT_USER_ID */
240         PKT_compressed  *compressed;    /* PKT_COMPRESSED */
241         PKT_encrypted   *encrypted;     /* PKT_ENCRYPTED[_MDC] */
242         PKT_mdc         *mdc;           /* PKT_MDC */
243         PKT_ring_trust  *ring_trust;    /* PKT_RING_TRUST */
244         PKT_plaintext   *plaintext;     /* PKT_PLAINTEXT */
245     } pkt;
246 };
247
248 #define init_packet(a) do { (a)->pkttype = 0;           \
249                             (a)->pkt.generic = NULL;    \
250                        } while(0)
251
252 typedef enum {
253     SIGSUBPKT_TEST_CRITICAL=-3,
254     SIGSUBPKT_LIST_UNHASHED=-2,
255     SIGSUBPKT_LIST_HASHED  =-1,
256     SIGSUBPKT_NONE         = 0,
257     SIGSUBPKT_SIG_CREATED  = 2, /* signature creation time */
258     SIGSUBPKT_SIG_EXPIRE   = 3, /* signature expiration time */
259     SIGSUBPKT_EXPORTABLE   = 4, /* exportable */
260     SIGSUBPKT_TRUST        = 5, /* trust signature */
261     SIGSUBPKT_REGEXP       = 6, /* regular expression */
262     SIGSUBPKT_REVOCABLE    = 7, /* revocable */
263     SIGSUBPKT_KEY_EXPIRE   = 9, /* key expiration time */
264     SIGSUBPKT_ARR          =10, /* additional recipient request */
265     SIGSUBPKT_PREF_SYM     =11, /* preferred symmetric algorithms */
266     SIGSUBPKT_REV_KEY      =12, /* revocation key */
267     SIGSUBPKT_ISSUER       =16, /* issuer key ID */
268     SIGSUBPKT_NOTATION     =20, /* notation data */
269     SIGSUBPKT_PREF_HASH    =21, /* preferred hash algorithms */
270     SIGSUBPKT_PREF_COMPR   =22, /* preferred compression algorithms */
271     SIGSUBPKT_KS_FLAGS     =23, /* key server preferences */
272     SIGSUBPKT_PREF_KS      =24, /* preferred key server */
273     SIGSUBPKT_PRIMARY_UID  =25, /* primary user id */
274     SIGSUBPKT_POLICY       =26, /* policy URL */
275     SIGSUBPKT_KEY_FLAGS    =27, /* key flags */
276     SIGSUBPKT_SIGNERS_UID  =28, /* signer's user id */
277     SIGSUBPKT_REVOC_REASON =29, /* reason for revocation */
278     SIGSUBPKT_PRIV_ADD_SIG =101,/* signatur is also valid for this uid */
279
280     SIGSUBPKT_FLAG_CRITICAL=128
281 } sigsubpkttype_t;
282
283
284 /*-- mainproc.c --*/
285 int proc_packets( void *ctx, IOBUF a );
286 int proc_signature_packets( void *ctx, IOBUF a,
287                             STRLIST signedfiles, const char *sigfile );
288 int proc_encryption_packets( void *ctx, IOBUF a );
289 int list_packets( IOBUF a );
290
291 /*-- parse-packet.c --*/
292 int set_packet_list_mode( int mode );
293
294 #if DEBUG_PARSE_PACKET
295 int dbg_search_packet( IOBUF inp, PACKET *pkt, int pkttype, ulong *retpos, const char* file, int lineno  );
296 int dbg_parse_packet( IOBUF inp, PACKET *ret_pkt, ulong *pos,
297                       const char* file, int lineno );
298 int dbg_copy_all_packets( IOBUF inp, IOBUF out, const char* file, int lineno  );
299 int dbg_copy_some_packets( IOBUF inp, IOBUF out, ulong stopoff, const char* file, int lineno  );
300 int dbg_skip_some_packets( IOBUF inp, unsigned n, const char* file, int lineno  );
301 #define search_packet( a,b,c,d )   dbg_search_packet( (a), (b), (c), (d), __FILE__, __LINE__ )
302 #define parse_packet( a, b, c )    dbg_parse_packet( (a), (b), (c), __FILE__, __LINE__ )
303 #define copy_all_packets( a,b )    dbg_copy_all_packets((a),(b), __FILE__, __LINE__ )
304 #define copy_some_packets( a,b,c ) dbg_copy_some_packets((a),(b),(c), __FILE__, __LINE__ )
305 #define skip_some_packets( a,b )   dbg_skip_some_packets((a),(b), __FILE__, __LINE__ )
306 #else
307 int search_packet( IOBUF inp, PACKET *pkt, int pkttype, ulong *retpos );
308 int parse_packet( IOBUF inp, PACKET *ret_pkt, ulong *retpos);
309 int copy_all_packets( IOBUF inp, IOBUF out );
310 int copy_some_packets( IOBUF inp, IOBUF out, ulong stopoff );
311 int skip_some_packets( IOBUF inp, unsigned n );
312 #endif
313
314 const byte *enum_sig_subpkt( const byte *buffer, sigsubpkttype_t reqtype,
315                                               size_t *ret_n, int *start );
316 const byte *parse_sig_subpkt( const byte *buffer, sigsubpkttype_t reqtype,
317                                        size_t *ret_n );
318 const byte *parse_sig_subpkt2( PKT_signature *sig,
319                                sigsubpkttype_t reqtype, size_t *ret_n );
320
321 /*-- build-packet.c --*/
322 int build_packet( IOBUF inp, PACKET *pkt );
323 u32 calc_packet_length( PACKET *pkt );
324 void hash_public_key( GCRY_MD_HD md, PKT_public_key *pk );
325 void build_sig_subpkt( PKT_signature *sig, sigsubpkttype_t type,
326                         const byte *buffer, size_t buflen );
327 void build_sig_subpkt_from_sig( PKT_signature *sig );
328
329 /*-- free-packet.c --*/
330 void free_symkey_enc( PKT_symkey_enc *enc );
331 void free_pubkey_enc( PKT_pubkey_enc *enc );
332 void free_seckey_enc( PKT_signature *enc );
333 int  digest_algo_from_sig( PKT_signature *sig );
334 void release_public_key_parts( PKT_public_key *pk );
335 void free_public_key( PKT_public_key *key );
336 void release_secret_key_parts( PKT_secret_key *sk );
337 void free_secret_key( PKT_secret_key *sk );
338 void free_user_id( PKT_user_id *uid );
339 void free_comment( PKT_comment *rem );
340 void free_packet( PACKET *pkt );
341 PKT_public_key *copy_public_key( PKT_public_key *d, PKT_public_key *s );
342 PKT_public_key *copy_public_key_new_namehash( PKT_public_key *d,
343                                               PKT_public_key *s,
344                                               const byte *namehash );
345 void copy_public_parts_to_secret_key( PKT_public_key *pk,
346                                       PKT_secret_key *sk );
347 PKT_secret_key *copy_secret_key( PKT_secret_key *d, PKT_secret_key *s );
348 PKT_signature *copy_signature( PKT_signature *d, PKT_signature *s );
349 PKT_user_id *copy_user_id( PKT_user_id *d, PKT_user_id *s );
350 int cmp_public_keys( PKT_public_key *a, PKT_public_key *b );
351 int cmp_secret_keys( PKT_secret_key *a, PKT_secret_key *b );
352 int cmp_signatures( PKT_signature *a, PKT_signature *b );
353 int cmp_public_secret_key( PKT_public_key *pk, PKT_secret_key *sk );
354 int cmp_user_ids( PKT_user_id *a, PKT_user_id *b );
355
356
357 /*-- sig-check.c --*/
358 int signature_check( PKT_signature *sig, GCRY_MD_HD digest );
359
360 /*-- seckey-cert.c --*/
361 int is_secret_key_protected( PKT_secret_key *sk );
362 int check_secret_key( PKT_secret_key *sk, int retries );
363 int protect_secret_key( PKT_secret_key *sk, DEK *dek );
364
365 /*-- pubkey-enc.c --*/
366 int get_session_key( PKT_pubkey_enc *k, DEK *dek );
367
368 /*-- compress.c --*/
369 int handle_compressed( void *ctx, PKT_compressed *cd,
370                        int (*callback)(IOBUF, void *), void *passthru );
371
372 /*-- encr-data.c --*/
373 int decrypt_data( void *ctx, PKT_encrypted *ed, DEK *dek );
374
375 /*-- plaintext.c --*/
376 int handle_plaintext( PKT_plaintext *pt, md_filter_context_t *mfx,
377                                         int nooutput, int clearsig );
378 int ask_for_detached_datafile( GCRY_MD_HD md, GCRY_MD_HD md2,
379                                const char *inname, int textmode );
380
381 /*-- comment.c --*/
382 int write_comment( IOBUF out, const char *s );
383
384 /*-- sign.c --*/
385 int make_keysig_packet( PKT_signature **ret_sig, PKT_public_key *pk,
386                         PKT_user_id *uid, PKT_public_key *subpk,
387                         PKT_secret_key *sk,
388                         int sigclass, int digest_algo,
389                         int (*mksubpkt)(PKT_signature *, void *),
390                         void *opaque  );
391
392 /*-- keygen.c --*/
393 PKT_user_id *generate_user_id(void);
394
395 #endif /*GPG_PACKET_H*/