463cf53f2fead7d888911ff0eec90fa560e14bd5
[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 #ifndef HAVE_RSA_CIPHER
31 /* although we don't have RSA we need these structures to handle keyrings */
32 typedef struct { MPI e, n;             } RSA_public_key;
33 typedef struct { MPI e, n, p, q, d, u; } RSA_secret_key;
34 #endif
35
36 typedef enum {
37         PKT_NONE           =0,
38         PKT_PUBKEY_ENC     =1, /* public key encrypted packet */
39         PKT_SIGNATURE      =2, /* secret key encrypted packet */
40         PKT_SYMKEY_ENC     =3, /* session key packet (OpenPGP)*/
41         PKT_ONEPASS_SIG    =4, /* one pass sig packet (OpenPGP)*/
42         PKT_SECRET_CERT    =5, /* secret key certificate */
43         PKT_PUBLIC_CERT    =6, /* public key certificate */
44         PKT_SECKEY_SUBCERT =7, /* secret subkey certificate (OpenPGP) */
45         PKT_COMPRESSED     =8, /* compressed data packet */
46         PKT_ENCRYPTED      =9, /* conventional encrypted data */
47         PKT_MARKER        =10, /* marker packet (OpenPGP) */
48         PKT_PLAINTEXT     =11, /* plaintext data with filename and mode */
49         PKT_RING_TRUST    =12, /* keyring trust packet */
50         PKT_USER_ID       =13, /* user id packet */
51         PKT_PUBKEY_SUBCERT=14, /* subkey certificate (OpenPGP) */
52         PKT_OLD_COMMENT   =16, /* comment packet from an OpenPGP draft */
53         PKT_COMMENT       =61  /* new comment packet (private) */
54 } pkttype_t;
55
56 typedef struct packet_struct PACKET;
57
58 typedef struct {
59     byte mode;
60     byte hash_algo;
61     byte salt[8];
62     u32  count;
63 } STRING2KEY;
64
65 typedef struct {
66     byte version;
67     byte cipher_algo;    /* cipher algorithm used */
68     STRING2KEY s2k;
69     byte seskeylen;   /* keylength in byte or 0 for no seskey */
70     byte seskey[1];
71 } PKT_symkey_enc;
72
73 typedef struct {
74     u32     keyid[2];       /* 64 bit keyid */
75     byte    version;
76     byte    pubkey_algo;    /* algorithm used for public key scheme */
77     union {
78       struct {
79         MPI  a, b;          /* integers with the encrypteded DEK */
80       } elg;
81       struct {
82         MPI  rsa_integer;   /* integer containing the DEK */
83       } rsa;
84     } d;
85 } PKT_pubkey_enc;
86
87
88 typedef struct {
89     u32     keyid[2];       /* 64 bit keyid */
90     byte    sig_class;      /* sig classification */
91     byte    digest_algo;    /* algorithm used for digest */
92     byte    pubkey_algo;    /* algorithm used for public key scheme */
93     byte    last;           /* a stupid flag */
94 } PKT_onepass_sig;
95
96
97 typedef struct {
98     u32     keyid[2];       /* 64 bit keyid */
99     ulong   local_id;       /* internal use, valid if > 0 */
100     u32     timestamp;      /* signature made */
101     byte    version;
102     byte    sig_class;      /* sig classification, append for MD calculation*/
103     byte    pubkey_algo;    /* algorithm used for public key scheme */
104                             /* (PUBKEY_ALGO_xxx) */
105     byte digest_algo;       /* algorithm used for digest (DIGEST_ALGO_xxxx) */
106     byte *hashed_data;      /* all subpackets with hashed  data (v4 only) */
107     byte *unhashed_data;    /* ditto for unhashed data */
108     byte digest_start[2];   /* first 2 bytes of the digest */
109     union {
110       struct {
111         MPI  a, b;            /* integers with the digest */
112       } elg;
113       struct {
114         MPI  r, s;            /* integers with the digest */
115       } dsa;
116       struct {
117         MPI  rsa_integer;     /* the encrypted digest */
118       } rsa;
119     } d;
120 } PKT_signature;
121
122
123 typedef struct {
124     u32     timestamp;      /* certificate made */
125     u16     valid_days;     /* valid for this number of days */
126     byte    hdrbytes;       /* number of header bytes */
127     byte    version;
128     byte    pubkey_algo;    /* algorithm used for public key scheme */
129     ulong   local_id;       /* internal use, valid if > 0 */
130     union {
131         ELG_public_key elg;
132         DSA_public_key dsa;
133         RSA_public_key rsa;
134     } d;
135 } PKT_public_cert;
136
137 typedef struct {
138     u32     timestamp;      /* certificate made */
139     u16     valid_days;     /* valid for this number of days */
140     byte    hdrbytes;       /* number of header bytes */
141     byte    version;
142     byte    pubkey_algo;    /* algorithm used for public key scheme */
143     byte is_protected;  /* The secret info is protected and must */
144                         /* be decrypted before use, the protected */
145                         /* MPIs are simply (void*) pointers to memory */
146                         /* and should never be passed to a mpi_xxx() */
147     struct {
148         byte algo;  /* cipher used to protect the secret information*/
149         STRING2KEY s2k;
150         byte iv[8]; /* initialization vector for CFB mode */
151     } protect;
152     union {
153         ELG_secret_key elg;
154         DSA_secret_key dsa;
155         RSA_secret_key rsa;
156     } d;
157     u16 csum;           /* checksum */
158 } PKT_secret_cert;
159
160
161 typedef struct {
162     int  len;             /* length of data */
163     char data[1];
164 } PKT_comment;
165
166 typedef struct {
167     int  len;             /* length of the name */
168     char name[1];
169 } PKT_user_id;
170
171 typedef struct {
172     u32  len;             /* reserved */
173     byte  algorithm;
174     IOBUF buf;            /* IOBUF reference */
175 } PKT_compressed;
176
177 typedef struct {
178     u32  len;             /* length of encrypted data */
179     IOBUF buf;            /* IOBUF reference */
180 } PKT_encrypted;
181
182 typedef struct {
183     u32  len;             /* length of encrypted data */
184     IOBUF buf;            /* IOBUF reference */
185     int mode;
186     u32 timestamp;
187     int  namelen;
188     char name[1];
189 } PKT_plaintext;
190
191 /* combine all packets into a union */
192 struct packet_struct {
193     pkttype_t pkttype;
194     union {
195         void *generic;
196         PKT_symkey_enc  *symkey_enc;    /* PKT_SYMKEY_ENC */
197         PKT_pubkey_enc  *pubkey_enc;    /* PKT_PUBKEY_ENC */
198         PKT_onepass_sig *onepass_sig;   /* PKT_ONEPASS_SIG */
199         PKT_signature   *signature;     /* PKT_SIGNATURE */
200         PKT_public_cert *public_cert;   /* PKT_PUBLIC_CERT */
201         PKT_secret_cert *secret_cert;   /* PKT_SECRET_CERT */
202         PKT_comment     *comment;       /* PKT_COMMENT */
203         PKT_user_id     *user_id;       /* PKT_USER_ID */
204         PKT_compressed  *compressed;    /* PKT_COMPRESSED */
205         PKT_encrypted   *encrypted;     /* PKT_ENCRYPTED */
206         PKT_plaintext   *plaintext;     /* PKT_PLAINTEXT */
207     } pkt;
208 };
209
210 #define init_packet(a) do { (a)->pkttype = 0;           \
211                             (a)->pkt.generic = NULL;    \
212                        } while(0)
213
214 typedef enum {
215     SIGSUBPKT_LIST_UNHASHED=-2,
216     SIGSUBPKT_LIST_HASHED  =-1,
217     SIGSUBPKT_NONE         = 0,
218     SIGSUBPKT_SIG_CREATED  = 2, /* signature creation time */
219     SIGSUBPKT_SIG_EXPIRE   = 3, /* signature expiration time */
220     SIGSUBPKT_EXPORTABLE   = 4, /* exportable */
221     SIGSUBPKT_TRUST        = 5, /* trust signature */
222     SIGSUBPKT_REGEXP       = 6, /* regular expression */
223     SIGSUBPKT_REVOCABLE    = 7, /* revocable */
224     SIGSUBPKT_KEY_EXPIRE   = 9, /* key expiration time */
225     SIGSUBPKT_ARR          =10, /* additional recipient request */
226     SIGSUBPKT_PREF_SYM     =11, /* preferred symmetric algorithms */
227     SIGSUBPKT_REV_KEY      =12, /* revocation key */
228     SIGSUBPKT_ISSUER       =16, /* issuer key ID */
229     SIGSUBPKT_NOTATION     =20, /* notation data */
230     SIGSUBPKT_PREF_HASH    =21, /* preferred hash algorithms */
231     SIGSUBPKT_PREF_COMPR   =22, /* preferred compression algorithms */
232     SIGSUBPKT_KS_FLAGS     =23, /* key server preferences */
233     SIGSUBPKT_PREF_KS      =24, /* preferred key server */
234     SIGSUBPKT_PRIMARY_UID  =25, /* primary user id */
235     SIGSUBPKT_POLICY       =26, /* policy URL */
236     SIGSUBPKT_KEY_FLAGS    =27, /* key flags */
237     SIGSUBPKT_SIGNERS_UID  =28  /* signer's user id */
238 } sigsubpkttype_t;
239
240
241 /*-- mainproc.c --*/
242 int proc_packets( IOBUF a );
243 int proc_signature_packets( IOBUF a, STRLIST signedfiles );
244 int proc_encryption_packets( IOBUF a );
245 int list_packets( IOBUF a );
246
247 /*-- parse-packet.c --*/
248 int set_packet_list_mode( int mode );
249 int search_packet( IOBUF inp, PACKET *pkt, int pkttype, ulong *retpos );
250 int parse_packet( IOBUF inp, PACKET *ret_pkt);
251 int copy_all_packets( IOBUF inp, IOBUF out );
252 int copy_some_packets( IOBUF inp, IOBUF out, ulong stopoff );
253 int skip_some_packets( IOBUF inp, unsigned n );
254 const byte *parse_sig_subpkt( const byte *buffer, int reqtype, size_t *ret_n );
255
256 /*-- build-packet.c --*/
257 int build_packet( IOBUF inp, PACKET *pkt );
258 u32 calc_packet_length( PACKET *pkt );
259 void hash_public_cert( MD_HANDLE md, PKT_public_cert *pkc );
260 void build_sig_subpkt( PKT_signature *sig, sigsubpkttype_t type,
261                         const byte *buffer, size_t buflen );
262 void build_sig_subpkt_from_sig( PKT_signature *sig );
263
264 /*-- free-packet.c --*/
265 void free_symkey_enc( PKT_symkey_enc *enc );
266 void free_pubkey_enc( PKT_pubkey_enc *enc );
267 void free_seckey_enc( PKT_signature *enc );
268 int  digest_algo_from_sig( PKT_signature *sig );
269 void release_public_cert_parts( PKT_public_cert *cert );
270 void free_public_cert( PKT_public_cert *cert );
271 void release_secret_cert_parts( PKT_secret_cert *cert );
272 void free_secret_cert( PKT_secret_cert *cert );
273 void free_user_id( PKT_user_id *uid );
274 void free_comment( PKT_comment *rem );
275 void free_packet( PACKET *pkt );
276 PKT_public_cert *copy_public_cert( PKT_public_cert *d, PKT_public_cert *s );
277 PKT_secret_cert *copy_secret_cert( PKT_secret_cert *d, PKT_secret_cert *s );
278 int cmp_public_certs( PKT_public_cert *a, PKT_public_cert *b );
279 int cmp_public_secret_cert( PKT_public_cert *pkc, PKT_secret_cert *skc );
280 int cmp_user_ids( PKT_user_id *a, PKT_user_id *b );
281
282
283 /*-- sig-check.c --*/
284 int signature_check( PKT_signature *sig, MD_HANDLE digest );
285
286 /*-- seckey-cert.c --*/
287 int is_secret_key_protected( PKT_secret_cert *cert );
288 int check_secret_key( PKT_secret_cert *cert );
289 int protect_secret_key( PKT_secret_cert *cert, DEK *dek );
290
291 /*-- pubkey-enc.c --*/
292 int get_session_key( PKT_pubkey_enc *k, DEK *dek );
293
294 /*-- compress.c --*/
295 int handle_compressed( PKT_compressed *cd,
296                        int (*callback)(IOBUF, void *), void *passthru );
297
298 /*-- encr-data.c --*/
299 int decrypt_data( PKT_encrypted *ed, DEK *dek );
300 int encrypt_data( PKT_encrypted *ed, DEK *dek );
301
302 /*-- plaintext.c --*/
303 int handle_plaintext( PKT_plaintext *pt, md_filter_context_t *mfx );
304 int ask_for_detached_datafile( md_filter_context_t *mfx, const char *inname );
305
306 /*-- comment.c --*/
307 int write_comment( IOBUF out, const char *s );
308
309 /*-- sign.c --*/
310 int make_keysig_packet( PKT_signature **ret_sig, PKT_public_cert *pkc,
311                         PKT_user_id *uid, PKT_secret_cert *skc,
312                         int sigclass, int digest_algo );
313
314 #endif /*G10_PACKET_H*/