bef97a41f13bc59e3c3aaa713ae0a7ffa7ad1638
[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_COMMENT       =14, /* comment packet */
46         PKT_PUBKEY_SUBCERT=14, /* subkey certificate (OpenPGP) */
47         PKT_NEW_COMMENT   =16  /* new comment packet (OpenPGP) */
48 } pkttype_t;
49
50 typedef struct packet_struct PACKET;
51
52 typedef struct {
53     u32     keyid[2];       /* 64 bit keyid */
54     byte    pubkey_algo;    /* algorithm used for public key scheme */
55     union {
56       struct {
57         MPI  rsa_integer;   /* integer containing the DEK */
58       } rsa;
59       struct {
60         MPI  a, b;          /* integers with the encrypteded DEK */
61       } elg;
62     } d;
63 } PKT_pubkey_enc;
64
65
66 typedef struct {
67     u32     keyid[2];       /* 64 bit keyid */
68     u32     timestamp;      /* signature made */
69     byte    sig_class;      /* sig classification, append for MD calculation*/
70     byte    pubkey_algo;    /* algorithm used for public key scheme */
71                             /* (PUBKEY_ALGO_xxx) */
72     union {
73       struct {
74         byte digest_algo;     /* algorithm used for digest (DIGEST_ALGO_xxxx) */
75         byte digest_start[2]; /* first 2 byte of the digest */
76         MPI  rsa_integer;     /* the encrypted digest */
77       } rsa;
78       struct {
79         byte digest_algo;     /* algorithm used for digest (DIGEST_ALGO_xxxx) */
80         byte digest_start[2]; /* first 2 byte of the digest */
81         MPI  a, b;            /* integers with the digest */
82       } elg;
83     } d;
84 } PKT_signature;
85
86
87 typedef struct {
88     u32     timestamp;      /* certificate made */
89     u16     valid_days;     /* valid for this number of days */
90     byte    pubkey_algo;    /* algorithm used for public key scheme */
91     md_filter_context_t mfx;
92     union {
93       struct {
94         MPI rsa_n;          /* public modulus */
95         MPI rsa_e;          /* public exponent */
96       } rsa;
97       struct {
98         MPI p;              /* prime */
99         MPI g;              /* group generator */
100         MPI y;              /* g^x mod p */
101       } elg;
102     } d;
103 } PKT_public_cert;
104
105 typedef struct {
106     u32     timestamp;      /* certificate made */
107     u16     valid_days;     /* valid for this number of days */
108     byte    pubkey_algo;    /* algorithm used for public key scheme */
109     union {
110       struct {
111         MPI rsa_n;          /* public modulus */
112         MPI rsa_e;          /* public exponent */
113         MPI rsa_d;          /* secret descryption exponent */
114         MPI rsa_p;          /* secret first prime number */
115         MPI rsa_q;          /* secret second prime number */
116         MPI rsa_u;          /* secret multiplicative inverse */
117         u16 csum;           /* checksum */
118         u16 calc_csum;      /* and a place to store the calculated csum */
119         byte is_protected;  /* The above infos are protected and must */
120                             /* be decrypteded before use */
121         byte protect_algo;  /* cipher used to protect the secret informations*/
122         union {             /* information for the protection */
123           struct {
124             byte iv[8];     /* initialization vector for CFB mode */
125                             /* when protected, the MPIs above are pointers
126                              * to plain storage */
127           } blowfish;
128         } protect;
129       } rsa;
130       struct {
131         MPI p;              /* prime */
132         MPI g;              /* group generator */
133         MPI y;              /* g^x mod p */
134         MPI x;              /* secret exponent */
135         u16 csum;           /* checksum */
136         u16 calc_csum;      /* and a place to store the calculated csum */
137         byte is_protected;  /* The above infos are protected and must */
138                             /* be decrypteded before use */
139         byte protect_algo;  /* cipher used to protect the secret informations*/
140         union {             /* information for the protection */
141           struct {
142             byte iv[8];     /* initialization vector for CFB mode */
143                             /* when protected, the MPIs above are pointers
144                              * to plain storage */
145           } blowfish;
146         } protect;
147       } elg;
148     } d;
149 } PKT_secret_cert;
150
151
152 typedef struct {
153     int  len;             /* length of data */
154     char data[1];
155 } PKT_comment;
156
157 typedef struct {
158     int  len;             /* length of the name */
159     char name[1];
160 } PKT_user_id;
161
162 typedef struct {
163     u32  len;             /* reserved */
164     byte  algorithm;
165     IOBUF buf;            /* IOBUF reference */
166 } PKT_compressed;
167
168 typedef struct {
169     u32  len;             /* length of encrypted data */
170     IOBUF buf;            /* IOBUF reference */
171 } PKT_encrypted;
172
173 typedef struct {
174     u32  len;             /* length of encrypted data */
175     IOBUF buf;            /* IOBUF reference */
176     int mode;
177     u32 timestamp;
178     int  namelen;
179     char name[1];
180 } PKT_plaintext;
181
182 /* combine all packets into a union */
183 struct packet_struct {
184     pkttype_t pkttype;
185     PKT_public_cert *pkc_parent;     /* the pubkey to which it belongs */
186     PKT_secret_cert *skc_parent;      /* the seckey to which it belongs */
187     PKT_user_id     *user_parent;     /* the user_id to which it belongs */
188     union {
189         void *generic;
190         PKT_pubkey_enc  *pubkey_enc;    /* PKT_PUBKEY_ENC */
191         PKT_signature   *signature;     /* PKT_SIGNATURE */
192         PKT_public_cert *public_cert;   /* PKT_PUBLIC_CERT */
193         PKT_secret_cert *secret_cert;   /* PKT_SECRET_CERT */
194         PKT_comment     *comment;       /* PKT_COMMENT */
195         PKT_user_id     *user_id;       /* PKT_USER_ID */
196         PKT_compressed  *compressed;    /* PKT_COMPRESSED */
197         PKT_encrypted   *encrypted;     /* PKT_ENCRYPTED */
198         PKT_plaintext   *plaintext;     /* PKT_PLAINTEXT */
199     } pkt;
200 };
201
202 #define init_packet(a) do { (a)->pkttype = 0;           \
203                             (a)->pkc_parent = NULL;     \
204                             (a)->skc_parent = NULL;     \
205                             (a)->user_parent = NULL;    \
206                             (a)->pkt.generic = NULL;    \
207                        } while(0)
208
209 /*-- mainproc.c --*/
210 int proc_packets( IOBUF a );
211
212 /*-- parse-packet.c --*/
213 int set_packet_list_mode( int mode );
214 int parse_packet( IOBUF inp, PACKET *ret_pkt);
215
216 /*-- build-packet.c --*/
217 int build_packet( IOBUF inp, PACKET *pkt );
218 u32 calc_packet_length( PACKET *pkt );
219
220 /*-- free-packet.c --*/
221 void free_pubkey_enc( PKT_pubkey_enc *enc );
222 void free_seckey_enc( PKT_signature *enc );
223 void free_public_cert( PKT_public_cert *cert );
224 void free_secret_cert( PKT_secret_cert *cert );
225 void free_user_id( PKT_user_id *uid );
226 void free_comment( PKT_comment *rem );
227 void free_packet( PACKET *pkt );
228 PKT_public_cert *copy_public_cert( PKT_public_cert *d, PKT_public_cert *s );
229 PKT_secret_cert *copy_secret_cert( PKT_secret_cert *d, PKT_secret_cert *s );
230
231
232 /*-- sig-check.c --*/
233 int signature_check( PKT_signature *sig, MD_HANDLE *digest );
234
235 /*-- seckey-cert.c --*/
236 int check_secret_key( PKT_secret_cert *cert );
237
238 /*-- pubkey-enc.c --*/
239 int get_session_key( PKT_pubkey_enc *k, DEK *dek );
240
241 /*-- compress.c --*/
242 int handle_compressed( PKT_compressed *zd );
243
244 /*-- encr-data.c --*/
245 int decrypt_data( PKT_encrypted *ed, DEK *dek );
246 int encrypt_data( PKT_encrypted *ed, DEK *dek );
247
248 /*-- plaintext.c --*/
249 int handle_plaintext( PKT_plaintext *pt, md_filter_context_t *mfx );
250
251 /*-- comment.c --*/
252 int write_comment( IOBUF out, const char *s );
253
254
255 #endif /*G10_PACKET_H*/