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