applied Mathews typo and grammar fixes
[gnupg.git] / g10 / packet.h
1 /* packet.h - packet read/write stuff
2  *      Copyright (C) 1998 Free Software Foundation, Inc.
3  *
4  * This file is part of GNUPG.
5  *
6  * GNUPG 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  * GNUPG 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 #ifndef HAVE_RSA_CIPHER
31 /* although we don't have RSA we need these structures to handle keyrings */
32 typedef struct { MPI e, n;             } RSA_public_key;
33 typedef struct { MPI e, n, p, q, d, u; } RSA_secret_key;
34 #endif
35
36 typedef enum {
37         PKT_NONE           =0,
38         PKT_PUBKEY_ENC     =1, /* public key encrypted packet */
39         PKT_SIGNATURE      =2, /* secret key encrypted packet */
40         PKT_SESSION_KEY    =3, /* session key packet (OpenPGP)*/
41         PKT_ONEPASS_SIG    =4, /* one pass sig packet (OpenPGP)*/
42         PKT_SECRET_CERT    =5, /* secret key certificate */
43         PKT_PUBLIC_CERT    =6, /* public key certificate */
44         PKT_SECKEY_SUBCERT =7, /* secret subkey certificate (OpenPGP) */
45         PKT_COMPRESSED     =8, /* compressed data packet */
46         PKT_ENCRYPTED      =9, /* conventional encrypted data */
47         PKT_MARKER        =10, /* marker packet (OpenPGP) */
48         PKT_PLAINTEXT     =11, /* plaintext data with filename and mode */
49         PKT_RING_TRUST    =12, /* keyring trust packet */
50         PKT_USER_ID       =13, /* user id packet */
51         PKT_PUBKEY_SUBCERT=14, /* subkey certificate (OpenPGP) */
52         PKT_COMMENT       =16  /* new comment packet (OpenPGP) */
53 } pkttype_t;
54
55 typedef struct packet_struct PACKET;
56
57 typedef struct {
58     u32     keyid[2];       /* 64 bit keyid */
59     byte    version;
60     byte    pubkey_algo;    /* algorithm used for public key scheme */
61     union {
62       struct {
63         MPI  a, b;          /* integers with the encrypteded DEK */
64       } elg;
65       struct {
66         MPI  rsa_integer;   /* integer containing the DEK */
67       } rsa;
68     } d;
69 } PKT_pubkey_enc;
70
71
72 typedef struct {
73     u32     keyid[2];       /* 64 bit keyid */
74     byte    sig_class;      /* sig classification */
75     byte    digest_algo;    /* algorithm used for digest */
76     byte    pubkey_algo;    /* algorithm used for public key scheme */
77     byte    last;           /* a stupid flag */
78 } PKT_onepass_sig;
79
80
81 typedef struct {
82     u32     keyid[2];       /* 64 bit keyid */
83     ulong   local_id;       /* internal use, valid if > 0 */
84     u32     timestamp;      /* signature made */
85     byte    version;
86     byte    sig_class;      /* sig classification, append for MD calculation*/
87     byte    pubkey_algo;    /* algorithm used for public key scheme */
88                             /* (PUBKEY_ALGO_xxx) */
89     byte digest_algo;       /* algorithm used for digest (DIGEST_ALGO_xxxx) */
90     byte *hashed_data;      /* all subpackets with hashed  data (v4 only) */
91     byte *unhashed_data;    /* ditto for unhashed data */
92     byte digest_start[2];   /* first 2 bytes of the digest */
93     union {
94       struct {
95         MPI  a, b;            /* integers with the digest */
96       } elg;
97       struct {
98         MPI  r, s;            /* integers with the digest */
99       } dsa;
100       struct {
101         MPI  rsa_integer;     /* the encrypted digest */
102       } rsa;
103     } d;
104 } PKT_signature;
105
106
107 typedef struct {
108     u32     timestamp;      /* certificate made */
109     u16     valid_days;     /* valid for this number of days */
110     byte    hdrbytes;       /* number of header bytes */
111     byte    version;
112     byte    pubkey_algo;    /* algorithm used for public key scheme */
113     ulong   local_id;       /* internal use, valid if > 0 */
114     union {
115         ELG_public_key elg;
116         DSA_public_key dsa;
117         RSA_public_key rsa;
118     } d;
119 } PKT_public_cert;
120
121 typedef struct {
122     u32     timestamp;      /* certificate made */
123     u16     valid_days;     /* valid for this number of days */
124     byte    hdrbytes;       /* number of header bytes */
125     byte    version;
126     byte    pubkey_algo;    /* algorithm used for public key scheme */
127     byte is_protected;  /* The secret info is protected and must */
128                         /* be decrypted before use, the protected */
129                         /* MPIs are simply (void*) pointers to memory */
130                         /* and should never be passed to a mpi_xxx() */
131     struct {
132         byte algo;  /* cipher used to protect the secret information*/
133         byte s2k;
134         byte hash;
135         byte salt[8];
136         byte count;
137         byte iv[8]; /* initialization vector for CFB mode */
138     } protect;
139     union {
140         ELG_secret_key elg;
141         DSA_secret_key dsa;
142         RSA_secret_key rsa;
143     } d;
144     u16 csum;           /* checksum */
145 } PKT_secret_cert;
146
147
148 typedef struct {
149     int  len;             /* length of data */
150     char data[1];
151 } PKT_comment;
152
153 typedef struct {
154     int  len;             /* length of the name */
155     char name[1];
156 } PKT_user_id;
157
158 typedef struct {
159     u32  len;             /* reserved */
160     byte  algorithm;
161     IOBUF buf;            /* IOBUF reference */
162 } PKT_compressed;
163
164 typedef struct {
165     u32  len;             /* length of encrypted data */
166     IOBUF buf;            /* IOBUF reference */
167 } PKT_encrypted;
168
169 typedef struct {
170     u32  len;             /* length of encrypted data */
171     IOBUF buf;            /* IOBUF reference */
172     int mode;
173     u32 timestamp;
174     int  namelen;
175     char name[1];
176 } PKT_plaintext;
177
178 /* combine all packets into a union */
179 struct packet_struct {
180     pkttype_t pkttype;
181     union {
182         void *generic;
183         PKT_pubkey_enc  *pubkey_enc;    /* PKT_PUBKEY_ENC */
184         PKT_onepass_sig *onepass_sig;   /* PKT_ONEPASS_SIG */
185         PKT_signature   *signature;     /* PKT_SIGNATURE */
186         PKT_public_cert *public_cert;   /* PKT_PUBLIC_CERT */
187         PKT_secret_cert *secret_cert;   /* PKT_SECRET_CERT */
188         PKT_comment     *comment;       /* PKT_COMMENT */
189         PKT_user_id     *user_id;       /* PKT_USER_ID */
190         PKT_compressed  *compressed;    /* PKT_COMPRESSED */
191         PKT_encrypted   *encrypted;     /* PKT_ENCRYPTED */
192         PKT_plaintext   *plaintext;     /* PKT_PLAINTEXT */
193     } pkt;
194 };
195
196 #define init_packet(a) do { (a)->pkttype = 0;           \
197                             (a)->pkt.generic = NULL;    \
198                        } while(0)
199
200 /*-- mainproc.c --*/
201 int proc_packets( IOBUF a );
202 int proc_signature_packets( IOBUF a, STRLIST signedfiles );
203 int proc_encryption_packets( IOBUF a );
204 int list_packets( IOBUF a );
205
206 /*-- parse-packet.c --*/
207 int set_packet_list_mode( int mode );
208 int search_packet( IOBUF inp, PACKET *pkt, int pkttype, ulong *retpos );
209 int parse_packet( IOBUF inp, PACKET *ret_pkt);
210 int copy_all_packets( IOBUF inp, IOBUF out );
211 int copy_some_packets( IOBUF inp, IOBUF out, ulong stopoff );
212 int skip_some_packets( IOBUF inp, unsigned n );
213
214 /*-- build-packet.c --*/
215 int build_packet( IOBUF inp, PACKET *pkt );
216 u32 calc_packet_length( PACKET *pkt );
217 void hash_public_cert( MD_HANDLE md, PKT_public_cert *pkc );
218
219 /*-- free-packet.c --*/
220 void free_pubkey_enc( PKT_pubkey_enc *enc );
221 void free_seckey_enc( PKT_signature *enc );
222 int  digest_algo_from_sig( PKT_signature *sig );
223 void release_public_cert_parts( PKT_public_cert *cert );
224 void free_public_cert( PKT_public_cert *cert );
225 void release_secret_cert_parts( PKT_secret_cert *cert );
226 void free_secret_cert( PKT_secret_cert *cert );
227 void free_user_id( PKT_user_id *uid );
228 void free_comment( PKT_comment *rem );
229 void free_packet( PACKET *pkt );
230 PKT_public_cert *copy_public_cert( PKT_public_cert *d, PKT_public_cert *s );
231 PKT_secret_cert *copy_secret_cert( PKT_secret_cert *d, PKT_secret_cert *s );
232 int cmp_public_certs( PKT_public_cert *a, PKT_public_cert *b );
233 int cmp_public_secret_cert( PKT_public_cert *pkc, PKT_secret_cert *skc );
234 int cmp_user_ids( PKT_user_id *a, PKT_user_id *b );
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 *cd,
250                        int (*callback)(IOBUF, void *), void *passthru );
251
252 /*-- encr-data.c --*/
253 int decrypt_data( PKT_encrypted *ed, DEK *dek );
254 int encrypt_data( PKT_encrypted *ed, DEK *dek );
255
256 /*-- plaintext.c --*/
257 int handle_plaintext( PKT_plaintext *pt, md_filter_context_t *mfx );
258 int ask_for_detached_datafile( md_filter_context_t *mfx, const char *inname );
259
260 /*-- comment.c --*/
261 int write_comment( IOBUF out, const char *s );
262
263 /*-- sign.c --*/
264 int make_keysig_packet( PKT_signature **ret_sig, PKT_public_cert *pkc,
265                         PKT_user_id *uid, PKT_secret_cert *skc,
266                         int sigclass, int digest_algo );
267
268 #endif /*G10_PACKET_H*/