93336bcb4c6a542db6e32177c7a4ab845cecc9d2
[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
31 #define PKT_PUBKEY_ENC   1  /* public key encrypted packet */
32 #define PKT_SIGNATURE    2  /* secret key encrypted packet */
33 #define PKT_SECKEY_CERT  5  /* secret key certificate */
34 #define PKT_PUBKEY_CERT  6  /* public key certificate */
35 #define PKT_COMPR_DATA   8  /* compressed data packet */
36 #define PKT_ENCR_DATA    9  /* conventional encrypted data */
37 #define PKT_PLAINTEXT   11  /* plaintext data with filename and mode */
38 #define PKT_RING_TRUST  12  /* keyring trust packet */
39 #define PKT_USER_ID     13  /* user id packet */
40 #define PKT_COMMENT     14  /* comment packet */
41
42 typedef struct packet_struct PACKET;
43
44 typedef struct {
45     u32     keyid[2];       /* 64 bit keyid */
46     byte    pubkey_algo;    /* algorithm used for public key scheme */
47     union {
48       struct {
49         MPI  rsa_integer;   /* integer containing the DEK */
50       } rsa;
51     } d;
52 } PKT_pubkey_enc;
53
54
55 typedef struct {
56     u32     keyid[2];       /* 64 bit keyid */
57     u32     timestamp;      /* signature made */
58     byte    sig_class;      /* sig classification, append for MD calculation*/
59     byte    pubkey_algo;    /* algorithm used for public key scheme */
60                             /* (PUBKEY_ALGO_xxx) */
61     union {
62       struct {
63         byte digest_algo;   /* algorithm used for digest (DIGEST_ALGO_xxxx) */
64         byte digest_start[2]; /* first 2 byte of the digest */
65         MPI  rsa_integer;   /* the encrypted digest */
66       } rsa;
67     } d;
68 } PKT_signature;
69
70
71 typedef struct {
72     u32     timestamp;      /* certificate made */
73     u16     valid_days;     /* valid for this number of days */
74     byte    pubkey_algo;    /* algorithm used for public key scheme */
75     md_filter_context_t mfx;
76     union {
77       struct {
78         MPI rsa_n;          /* public modulus */
79         MPI rsa_e;          /* public exponent */
80       } rsa;
81     } d;
82 } PKT_pubkey_cert;
83
84 typedef struct {
85     u32     timestamp;      /* certificate made */
86     u16     valid_days;     /* valid for this number of days */
87     byte    pubkey_algo;    /* algorithm used for public key scheme */
88     union {
89       struct {
90         MPI rsa_n;          /* public modulus */
91         MPI rsa_e;          /* public exponent */
92         MPI rsa_d;          /* secret descryption exponent */
93         MPI rsa_p;          /* secret first prime number */
94         MPI rsa_q;          /* secret second prime number */
95         MPI rsa_u;          /* secret multiplicative inverse */
96         u16 csum;           /* checksum */
97         u16 calc_csum;      /* and a place to store the calculated csum */
98         byte is_protected;  /* The above infos are protected and must */
99                             /* be deciphered before use */
100         byte protect_algo;  /* cipher used to protect the secret informations*/
101         union {             /* information for the protection */
102           struct {
103             byte iv[8];     /* initialization vector for CFB mode */
104                             /* when protected, the MPIs above are pointers
105                              * to plain storage */
106           } idea;
107           struct {
108             byte iv[8];
109           } blowfish;
110         } protect;
111       } rsa;
112     } d;
113 } PKT_seckey_cert;
114
115
116 typedef struct {
117     int  len;             /* length of data */
118     char data[1];
119 } PKT_comment;
120
121 typedef struct {
122     int  len;             /* length of the name */
123     char name[1];
124 } PKT_user_id;
125
126 typedef struct {
127     u32  len;             /* reserved */
128     byte  algorithm;
129     IOBUF buf;            /* IOBUF reference */
130 } PKT_compressed;
131
132 typedef struct {
133     u32  len;             /* length of encrypted data */
134     IOBUF buf;            /* IOBUF reference */
135 } PKT_encr_data;
136
137 typedef struct {
138     u32  len;             /* length of encrypted data */
139     IOBUF buf;            /* IOBUF reference */
140     int mode;
141     u32 timestamp;
142     int  namelen;
143     char name[1];
144 } PKT_plaintext;
145
146 /* combine all packets into a union */
147 struct packet_struct {
148     int pkttype;
149     PKT_pubkey_cert *pkc_parent;     /* the pubkey to which it belongs */
150     PKT_seckey_cert *skc_parent;      /* the seckey to which it belongs */
151     PKT_user_id     *user_parent;     /* the user_id to which it belongs */
152     union {
153         void *generic;
154         PKT_pubkey_enc *pubkey_enc;     /* PKT_PUBKEY_ENC */
155         PKT_signature *signature;       /* PKT_SIGNATURE */
156         PKT_pubkey_cert *pubkey_cert;   /* PKT_PUBKEY_CERT */
157         PKT_seckey_cert *seckey_cert;   /* PKT_SECKEY_CERT */
158         PKT_comment     *comment;       /* PKT_COMMENT */
159         PKT_user_id     *user_id;       /* PKT_USER_ID */
160         PKT_compressed  *compressed;    /* PKT_COMPRESSED */
161         PKT_encr_data   *encr_data;     /* PKT_ENCR_DATA */
162         PKT_plaintext   *plaintext;     /* PKT_PLAINTEXT */
163     } pkt;
164 };
165
166 #define init_packet(a) do { (a)->pkttype = 0;           \
167                             (a)->pkc_parent = NULL;     \
168                             (a)->skc_parent = NULL;     \
169                             (a)->user_parent = NULL;    \
170                             (a)->pkt.generic = NULL;    \
171                        } while(0)
172
173 /*-- mainproc.c --*/
174 int proc_packets( IOBUF a );
175
176 /*-- parse-packet.c --*/
177 int set_packet_list_mode( int mode );
178 int parse_packet( IOBUF inp, PACKET *ret_pkt);
179
180 /*-- build-packet.c --*/
181 int build_packet( IOBUF inp, PACKET *pkt );
182 u32 calc_packet_length( PACKET *pkt );
183
184 /*-- free-packet.c --*/
185 void free_pubkey_enc( PKT_pubkey_enc *enc );
186 void free_seckey_enc( PKT_signature *enc );
187 void free_pubkey_cert( PKT_pubkey_cert *cert );
188 void free_seckey_cert( PKT_seckey_cert *cert );
189 void free_user_id( PKT_user_id *uid );
190 void free_comment( PKT_comment *rem );
191 void free_packet( PACKET *pkt );
192 PKT_pubkey_cert *copy_pubkey_cert( PKT_pubkey_cert *d, PKT_pubkey_cert *s );
193
194
195 /*-- sig-check.c --*/
196 int signature_check( PKT_signature *sig, MD_HANDLE digest );
197
198 /*-- seckey-cert.c --*/
199 int check_secret_key( PKT_seckey_cert *cert );
200
201 /*-- pubkey-enc.c --*/
202 int get_session_key( PKT_pubkey_enc *k, DEK *dek );
203
204 /*-- compress.c --*/
205 int handle_compressed( PKT_compressed *zd );
206
207 /*-- encr-data.c --*/
208 int decrypt_data( PKT_encr_data *ed, DEK *dek );
209 int encrypt_data( PKT_encr_data *ed, DEK *dek );
210
211 /*-- plaintext.c --*/
212 int handle_plaintext( PKT_plaintext *pt );
213
214 #endif /*G10_PACKET_H*/