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