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