import works
[gnupg.git] / g10 / packet.h
1 /* packet.h - packet read/write stuff
2  *      Copyright (c) 1997 by Werner Koch (dd9jn)
3  *
4  * This file is part of G10.
5  *
6  * G10 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  * G10 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_SESSION_KEY    =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_COMMENT       =16  /* new comment packet (OpenPGP) */
47 } pkttype_t;
48
49 typedef struct packet_struct PACKET;
50
51 typedef struct {
52     u32     keyid[2];       /* 64 bit keyid */
53     byte    pubkey_algo;    /* algorithm used for public key scheme */
54     union {
55       struct {
56         MPI  a, b;          /* integers with the encrypteded DEK */
57       } elg;
58       struct {
59         MPI  rsa_integer;   /* integer containing the DEK */
60       } rsa;
61     } d;
62 } PKT_pubkey_enc;
63
64
65 typedef struct {
66     u32     keyid[2];       /* 64 bit keyid */
67     byte    sig_class;      /* sig classification */
68     byte    digest_algo;    /* algorithm used for digest */
69     byte    pubkey_algo;    /* algorithm used for public key scheme */
70     byte    last;           /* a stupid flag */
71 } PKT_onepass_sig;
72
73
74 typedef struct {
75     u32     keyid[2];       /* 64 bit keyid */
76     ulong   local_id;       /* internal use, valid if > 0 */
77     u32     timestamp;      /* signature made */
78     byte    sig_class;      /* sig classification, append for MD calculation*/
79     byte    pubkey_algo;    /* algorithm used for public key scheme */
80                             /* (PUBKEY_ALGO_xxx) */
81     union {
82       struct {
83         byte digest_algo;     /* algorithm used for digest (DIGEST_ALGO_xxxx) */
84         byte digest_start[2]; /* first 2 byte of the digest */
85         MPI  a, b;            /* integers with the digest */
86       } elg;
87       struct {
88         byte digest_algo;     /* algorithm used for digest (DIGEST_ALGO_xxxx) */
89         byte digest_start[2]; /* first 2 byte of the digest */
90         MPI  rsa_integer;     /* the encrypted digest */
91       } rsa;
92     } d;
93 } PKT_signature;
94
95
96 typedef struct {
97     u32     timestamp;      /* certificate made */
98     u16     valid_days;     /* valid for this number of days */
99     byte    hdrbytes;       /* number of header bytes */
100     byte    version;
101     byte    pubkey_algo;    /* algorithm used for public key scheme */
102     md_filter_context_t mfx;
103     ulong   local_id;       /* internal use, valid if > 0 */
104     union {
105       struct {
106         MPI p;              /* prime */
107         MPI g;              /* group generator */
108         MPI y;              /* g^x mod p */
109       } elg;
110       struct {
111         MPI rsa_n;          /* public modulus */
112         MPI rsa_e;          /* public exponent */
113       } rsa;
114     } d;
115 } PKT_public_cert;
116
117 typedef struct {
118     u32     timestamp;      /* certificate made */
119     u16     valid_days;     /* valid for this number of days */
120     byte    hdrbytes;       /* number of header bytes */
121     byte    version;
122     byte    pubkey_algo;    /* algorithm used for public key scheme */
123     union {
124       struct {
125         MPI p;              /* prime */
126         MPI g;              /* group generator */
127         MPI y;              /* g^x mod p */
128         MPI x;              /* secret exponent */
129         u16 csum;           /* checksum */
130         byte is_protected;  /* The above infos are protected and must */
131                             /* be decrypteded before use */
132         byte protect_algo;  /* cipher used to protect the secret informations*/
133         union {             /* information for the protection */
134           struct {
135             byte iv[8];     /* initialization vector for CFB mode */
136                             /* when protected, the MPIs above are pointers
137                              * to plain storage */
138           } blowfish;
139         } protect;
140       } elg;
141       struct {
142         MPI rsa_n;          /* public modulus */
143         MPI rsa_e;          /* public exponent */
144         MPI rsa_d;          /* secret descryption exponent */
145         MPI rsa_p;          /* secret first prime number */
146         MPI rsa_q;          /* secret second prime number */
147         MPI rsa_u;          /* secret multiplicative inverse */
148         u16 csum;           /* checksum */
149         byte is_protected;  /* The above infos are protected and must */
150                             /* be decrypteded before use */
151         byte protect_algo;  /* cipher used to protect the secret informations*/
152         union {             /* information for the protection */
153           struct {
154             byte iv[8];     /* initialization vector for CFB mode */
155                             /* when protected, the MPIs above are pointers
156                              * to plain storage */
157           } blowfish;
158         } protect;
159       } rsa;
160     } d;
161 } PKT_secret_cert;
162
163
164 typedef struct {
165     int  len;             /* length of data */
166     char data[1];
167 } PKT_comment;
168
169 typedef struct {
170     int  len;             /* length of the name */
171     char name[1];
172 } PKT_user_id;
173
174 typedef struct {
175     u32  len;             /* reserved */
176     byte  algorithm;
177     IOBUF buf;            /* IOBUF reference */
178 } PKT_compressed;
179
180 typedef struct {
181     u32  len;             /* length of encrypted data */
182     IOBUF buf;            /* IOBUF reference */
183 } PKT_encrypted;
184
185 typedef struct {
186     u32  len;             /* length of encrypted data */
187     IOBUF buf;            /* IOBUF reference */
188     int mode;
189     u32 timestamp;
190     int  namelen;
191     char name[1];
192 } PKT_plaintext;
193
194 /* combine all packets into a union */
195 struct packet_struct {
196     pkttype_t pkttype;
197     union {
198         void *generic;
199         PKT_pubkey_enc  *pubkey_enc;    /* PKT_PUBKEY_ENC */
200         PKT_onepass_sig *onepass_sig;   /* PKT_ONEPASS_SIG */
201         PKT_signature   *signature;     /* PKT_SIGNATURE */
202         PKT_public_cert *public_cert;   /* PKT_PUBLIC_CERT */
203         PKT_secret_cert *secret_cert;   /* PKT_SECRET_CERT */
204         PKT_comment     *comment;       /* PKT_COMMENT */
205         PKT_user_id     *user_id;       /* PKT_USER_ID */
206         PKT_compressed  *compressed;    /* PKT_COMPRESSED */
207         PKT_encrypted   *encrypted;     /* PKT_ENCRYPTED */
208         PKT_plaintext   *plaintext;     /* PKT_PLAINTEXT */
209     } pkt;
210 };
211
212 #define init_packet(a) do { (a)->pkttype = 0;           \
213                             (a)->pkt.generic = NULL;    \
214                        } while(0)
215
216 /*-- mainproc.c --*/
217 int proc_packets( IOBUF a );
218 int list_packets( IOBUF a );
219
220 /*-- parse-packet.c --*/
221 int set_packet_list_mode( int mode );
222 int search_packet( IOBUF inp, PACKET *pkt, int pkttype, ulong *retpos );
223 int parse_packet( IOBUF inp, PACKET *ret_pkt);
224 int copy_all_packets( IOBUF inp, IOBUF out );
225 int copy_some_packets( IOBUF inp, IOBUF out, ulong stopoff );
226 int skip_some_packets( IOBUF inp, unsigned n );
227
228 /*-- build-packet.c --*/
229 int build_packet( IOBUF inp, PACKET *pkt );
230 u32 calc_packet_length( PACKET *pkt );
231 void hash_public_cert( MD_HANDLE md, PKT_public_cert *pkc );
232
233 /*-- free-packet.c --*/
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 *zd );
264
265 /*-- encr-data.c --*/
266 int decrypt_data( PKT_encrypted *ed, DEK *dek );
267 int encrypt_data( PKT_encrypted *ed, DEK *dek );
268
269 /*-- plaintext.c --*/
270 int handle_plaintext( PKT_plaintext *pt, md_filter_context_t *mfx );
271 int ask_for_detached_datafile( md_filter_context_t *mfx, const char *inname );
272
273 /*-- comment.c --*/
274 int write_comment( IOBUF out, const char *s );
275
276 /*-- sign.c --*/
277 int make_keysig_packet( PKT_signature **ret_sig, PKT_public_cert *pkc,
278                         PKT_user_id *uid, PKT_secret_cert *skc,
279                         int sigclass, int digest_algo );
280
281 #endif /*G10_PACKET_H*/