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