detached signatures are working
[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     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  rsa_integer;     /* the encrypted digest */
86       } rsa;
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  a, b;            /* integers with the digest */
91       } elg;
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 rsa_n;          /* public modulus */
104         MPI rsa_e;          /* public exponent */
105       } rsa;
106       struct {
107         MPI p;              /* prime */
108         MPI g;              /* group generator */
109         MPI y;              /* g^x mod p */
110       } elg;
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 rsa_n;          /* public modulus */
121         MPI rsa_e;          /* public exponent */
122         MPI rsa_d;          /* secret descryption exponent */
123         MPI rsa_p;          /* secret first prime number */
124         MPI rsa_q;          /* secret second prime number */
125         MPI rsa_u;          /* secret multiplicative inverse */
126         u16 csum;           /* checksum */
127         u16 calc_csum;      /* and a place to store the calculated csum */
128         byte is_protected;  /* The above infos are protected and must */
129                             /* be decrypteded before use */
130         byte protect_algo;  /* cipher used to protect the secret informations*/
131         union {             /* information for the protection */
132           struct {
133             byte iv[8];     /* initialization vector for CFB mode */
134                             /* when protected, the MPIs above are pointers
135                              * to plain storage */
136           } blowfish;
137         } protect;
138       } rsa;
139       struct {
140         MPI p;              /* prime */
141         MPI g;              /* group generator */
142         MPI y;              /* g^x mod p */
143         MPI x;              /* secret exponent */
144         u16 csum;           /* checksum */
145         u16 calc_csum;      /* and a place to store the calculated csum */
146         byte is_protected;  /* The above infos are protected and must */
147                             /* be decrypteded before use */
148         byte protect_algo;  /* cipher used to protect the secret informations*/
149         union {             /* information for the protection */
150           struct {
151             byte iv[8];     /* initialization vector for CFB mode */
152                             /* when protected, the MPIs above are pointers
153                              * to plain storage */
154           } blowfish;
155         } protect;
156       } elg;
157     } d;
158 } PKT_secret_cert;
159
160
161 typedef struct {
162     int  len;             /* length of data */
163     char data[1];
164 } PKT_comment;
165
166 typedef struct {
167     int  len;             /* length of the name */
168     char name[1];
169 } PKT_user_id;
170
171 typedef struct {
172     u32  len;             /* reserved */
173     byte  algorithm;
174     IOBUF buf;            /* IOBUF reference */
175 } PKT_compressed;
176
177 typedef struct {
178     u32  len;             /* length of encrypted data */
179     IOBUF buf;            /* IOBUF reference */
180 } PKT_encrypted;
181
182 typedef struct {
183     u32  len;             /* length of encrypted data */
184     IOBUF buf;            /* IOBUF reference */
185     int mode;
186     u32 timestamp;
187     int  namelen;
188     char name[1];
189 } PKT_plaintext;
190
191 /* combine all packets into a union */
192 struct packet_struct {
193     pkttype_t pkttype;
194     union {
195         void *generic;
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
216 /*-- parse-packet.c --*/
217 int set_packet_list_mode( int mode );
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
224 /*-- free-packet.c --*/
225 void free_pubkey_enc( PKT_pubkey_enc *enc );
226 void free_seckey_enc( PKT_signature *enc );
227 void free_public_cert( PKT_public_cert *cert );
228 void free_secret_cert( PKT_secret_cert *cert );
229 void free_user_id( PKT_user_id *uid );
230 void free_comment( PKT_comment *rem );
231 void free_packet( PACKET *pkt );
232 PKT_public_cert *copy_public_cert( PKT_public_cert *d, PKT_public_cert *s );
233 PKT_secret_cert *copy_secret_cert( PKT_secret_cert *d, PKT_secret_cert *s );
234
235
236 /*-- sig-check.c --*/
237 int signature_check( PKT_signature *sig, MD_HANDLE *digest );
238
239 /*-- seckey-cert.c --*/
240 int check_secret_key( PKT_secret_cert *cert );
241
242 /*-- pubkey-enc.c --*/
243 int get_session_key( PKT_pubkey_enc *k, DEK *dek );
244
245 /*-- compress.c --*/
246 int handle_compressed( PKT_compressed *zd );
247
248 /*-- encr-data.c --*/
249 int decrypt_data( PKT_encrypted *ed, DEK *dek );
250 int encrypt_data( PKT_encrypted *ed, DEK *dek );
251
252 /*-- plaintext.c --*/
253 int handle_plaintext( PKT_plaintext *pt, md_filter_context_t *mfx );
254 int ask_for_detached_datafile( md_filter_context_t *mfx );
255
256 /*-- comment.c --*/
257 int write_comment( IOBUF out, const char *s );
258
259
260 #endif /*G10_PACKET_H*/