Aenderungen in der Eifel
[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_COMMENT       =16  /* new comment packet (OpenPGP) */
53 } pkttype_t;
54
55 typedef struct packet_struct PACKET;
56
57 typedef struct {
58     byte mode;
59     byte hash_algo;
60     byte salt[8];
61     u32  count;
62 } STRING2KEY;
63
64 typedef struct {
65     byte version;
66     byte cipher_algo;    /* cipher algorithm used */
67     STRING2KEY s2k;
68     byte seskeylen;   /* keylength in byte or 0 for no seskey */
69     byte seskey[1];
70 } PKT_symkey_enc;
71
72 typedef struct {
73     u32     keyid[2];       /* 64 bit keyid */
74     byte    version;
75     byte    pubkey_algo;    /* algorithm used for public key scheme */
76     union {
77       struct {
78         MPI  a, b;          /* integers with the encrypteded DEK */
79       } elg;
80       struct {
81         MPI  rsa_integer;   /* integer containing the DEK */
82       } rsa;
83     } d;
84 } PKT_pubkey_enc;
85
86
87 typedef struct {
88     u32     keyid[2];       /* 64 bit keyid */
89     byte    sig_class;      /* sig classification */
90     byte    digest_algo;    /* algorithm used for digest */
91     byte    pubkey_algo;    /* algorithm used for public key scheme */
92     byte    last;           /* a stupid flag */
93 } PKT_onepass_sig;
94
95
96 typedef struct {
97     u32     keyid[2];       /* 64 bit keyid */
98     ulong   local_id;       /* internal use, valid if > 0 */
99     u32     timestamp;      /* signature made */
100     byte    version;
101     byte    sig_class;      /* sig classification, append for MD calculation*/
102     byte    pubkey_algo;    /* algorithm used for public key scheme */
103                             /* (PUBKEY_ALGO_xxx) */
104     byte digest_algo;       /* algorithm used for digest (DIGEST_ALGO_xxxx) */
105     byte *hashed_data;      /* all subpackets with hashed  data (v4 only) */
106     byte *unhashed_data;    /* ditto for unhashed data */
107     byte digest_start[2];   /* first 2 bytes of the digest */
108     union {
109       struct {
110         MPI  a, b;            /* integers with the digest */
111       } elg;
112       struct {
113         MPI  r, s;            /* integers with the digest */
114       } dsa;
115       struct {
116         MPI  rsa_integer;     /* the encrypted digest */
117       } rsa;
118     } d;
119 } PKT_signature;
120
121
122 typedef struct {
123     u32     timestamp;      /* certificate made */
124     u16     valid_days;     /* valid for this number of days */
125     byte    hdrbytes;       /* number of header bytes */
126     byte    version;
127     byte    pubkey_algo;    /* algorithm used for public key scheme */
128     ulong   local_id;       /* internal use, valid if > 0 */
129     union {
130         ELG_public_key elg;
131         DSA_public_key dsa;
132         RSA_public_key rsa;
133     } d;
134 } PKT_public_cert;
135
136 typedef struct {
137     u32     timestamp;      /* certificate made */
138     u16     valid_days;     /* valid for this number of days */
139     byte    hdrbytes;       /* number of header bytes */
140     byte    version;
141     byte    pubkey_algo;    /* algorithm used for public key scheme */
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 iv[8]; /* initialization vector for CFB mode */
150     } protect;
151     union {
152         ELG_secret_key elg;
153         DSA_secret_key dsa;
154         RSA_secret_key rsa;
155     } d;
156     u16 csum;           /* checksum */
157 } PKT_secret_cert;
158
159
160 typedef struct {
161     int  len;             /* length of data */
162     char data[1];
163 } PKT_comment;
164
165 typedef struct {
166     int  len;             /* length of the name */
167     char name[1];
168 } PKT_user_id;
169
170 typedef struct {
171     u32  len;             /* reserved */
172     byte  algorithm;
173     IOBUF buf;            /* IOBUF reference */
174 } PKT_compressed;
175
176 typedef struct {
177     u32  len;             /* length of encrypted data */
178     IOBUF buf;            /* IOBUF reference */
179 } PKT_encrypted;
180
181 typedef struct {
182     u32  len;             /* length of encrypted data */
183     IOBUF buf;            /* IOBUF reference */
184     int mode;
185     u32 timestamp;
186     int  namelen;
187     char name[1];
188 } PKT_plaintext;
189
190 /* combine all packets into a union */
191 struct packet_struct {
192     pkttype_t pkttype;
193     union {
194         void *generic;
195         PKT_symkey_enc  *symkey_enc;    /* PKT_SYMKEY_ENC */
196         PKT_pubkey_enc  *pubkey_enc;    /* PKT_PUBKEY_ENC */
197         PKT_onepass_sig *onepass_sig;   /* PKT_ONEPASS_SIG */
198         PKT_signature   *signature;     /* PKT_SIGNATURE */
199         PKT_public_cert *public_cert;   /* PKT_PUBLIC_CERT */
200         PKT_secret_cert *secret_cert;   /* PKT_SECRET_CERT */
201         PKT_comment     *comment;       /* PKT_COMMENT */
202         PKT_user_id     *user_id;       /* PKT_USER_ID */
203         PKT_compressed  *compressed;    /* PKT_COMPRESSED */
204         PKT_encrypted   *encrypted;     /* PKT_ENCRYPTED */
205         PKT_plaintext   *plaintext;     /* PKT_PLAINTEXT */
206     } pkt;
207 };
208
209 #define init_packet(a) do { (a)->pkttype = 0;           \
210                             (a)->pkt.generic = NULL;    \
211                        } while(0)
212
213 /*-- mainproc.c --*/
214 int proc_packets( IOBUF a );
215 int proc_signature_packets( IOBUF a, STRLIST signedfiles );
216 int proc_encryption_packets( IOBUF a );
217 int list_packets( IOBUF a );
218
219 /*-- parse-packet.c --*/
220 int set_packet_list_mode( int mode );
221 int search_packet( IOBUF inp, PACKET *pkt, int pkttype, ulong *retpos );
222 int parse_packet( IOBUF inp, PACKET *ret_pkt);
223 int copy_all_packets( IOBUF inp, IOBUF out );
224 int copy_some_packets( IOBUF inp, IOBUF out, ulong stopoff );
225 int skip_some_packets( IOBUF inp, unsigned n );
226
227 /*-- build-packet.c --*/
228 int build_packet( IOBUF inp, PACKET *pkt );
229 u32 calc_packet_length( PACKET *pkt );
230 void hash_public_cert( MD_HANDLE md, PKT_public_cert *pkc );
231
232 /*-- free-packet.c --*/
233 void free_symkey_enc( PKT_symkey_enc *enc );
234 void free_pubkey_enc( PKT_pubkey_enc *enc );
235 void free_seckey_enc( PKT_signature *enc );
236 int  digest_algo_from_sig( PKT_signature *sig );
237 void release_public_cert_parts( PKT_public_cert *cert );
238 void free_public_cert( PKT_public_cert *cert );
239 void release_secret_cert_parts( PKT_secret_cert *cert );
240 void free_secret_cert( PKT_secret_cert *cert );
241 void free_user_id( PKT_user_id *uid );
242 void free_comment( PKT_comment *rem );
243 void free_packet( PACKET *pkt );
244 PKT_public_cert *copy_public_cert( PKT_public_cert *d, PKT_public_cert *s );
245 PKT_secret_cert *copy_secret_cert( PKT_secret_cert *d, PKT_secret_cert *s );
246 int cmp_public_certs( PKT_public_cert *a, PKT_public_cert *b );
247 int cmp_public_secret_cert( PKT_public_cert *pkc, PKT_secret_cert *skc );
248 int cmp_user_ids( PKT_user_id *a, PKT_user_id *b );
249
250
251 /*-- sig-check.c --*/
252 int signature_check( PKT_signature *sig, MD_HANDLE digest );
253
254 /*-- seckey-cert.c --*/
255 int is_secret_key_protected( PKT_secret_cert *cert );
256 int check_secret_key( PKT_secret_cert *cert );
257 int protect_secret_key( PKT_secret_cert *cert, DEK *dek );
258
259 /*-- pubkey-enc.c --*/
260 int get_session_key( PKT_pubkey_enc *k, DEK *dek );
261
262 /*-- compress.c --*/
263 int handle_compressed( PKT_compressed *cd,
264                        int (*callback)(IOBUF, void *), void *passthru );
265
266 /*-- encr-data.c --*/
267 int decrypt_data( PKT_encrypted *ed, DEK *dek );
268 int encrypt_data( PKT_encrypted *ed, DEK *dek );
269
270 /*-- plaintext.c --*/
271 int handle_plaintext( PKT_plaintext *pt, md_filter_context_t *mfx );
272 int ask_for_detached_datafile( md_filter_context_t *mfx, const char *inname );
273
274 /*-- comment.c --*/
275 int write_comment( IOBUF out, const char *s );
276
277 /*-- sign.c --*/
278 int make_keysig_packet( PKT_signature **ret_sig, PKT_public_cert *pkc,
279                         PKT_user_id *uid, PKT_secret_cert *skc,
280                         int sigclass, int digest_algo );
281
282 #endif /*G10_PACKET_H*/