4cf80a4a18e5e857ff7380daa2793274c5a70e32
[gnupg.git] / g10 / free-packet.c
1 /* free-packet.c - cleanup stuff for packets
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003,
3  *               2005, 2010  Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <https://www.gnu.org/licenses/>.
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25
26 #include "gpg.h"
27 #include "../common/util.h"
28 #include "packet.h"
29 #include "../common/iobuf.h"
30 #include "options.h"
31
32
33 /* This is mpi_copy with a fix for opaque MPIs which store a NULL
34    pointer.  This will also be fixed in Libggcrypt 1.7.0.  */
35 static gcry_mpi_t
36 my_mpi_copy (gcry_mpi_t a)
37 {
38   if (a
39       && gcry_mpi_get_flag (a, GCRYMPI_FLAG_OPAQUE)
40       && !gcry_mpi_get_opaque (a, NULL))
41     return NULL;
42
43   return gcry_mpi_copy (a);
44 }
45
46
47 void
48 free_symkey_enc( PKT_symkey_enc *enc )
49 {
50     xfree(enc);
51 }
52
53 void
54 free_pubkey_enc( PKT_pubkey_enc *enc )
55 {
56     int n, i;
57     n = pubkey_get_nenc( enc->pubkey_algo );
58     if( !n )
59         mpi_release(enc->data[0]);
60     for(i=0; i < n; i++ )
61         mpi_release( enc->data[i] );
62     xfree(enc);
63 }
64
65 void
66 free_seckey_enc( PKT_signature *sig )
67 {
68   int n, i;
69
70   n = pubkey_get_nsig( sig->pubkey_algo );
71   if( !n )
72     mpi_release(sig->data[0]);
73   for(i=0; i < n; i++ )
74     mpi_release( sig->data[i] );
75
76   xfree(sig->revkey);
77   xfree(sig->hashed);
78   xfree(sig->unhashed);
79
80   if (sig->pka_info)
81     {
82       xfree (sig->pka_info->uri);
83       xfree (sig->pka_info);
84     }
85   xfree (sig->signers_uid);
86
87   xfree(sig);
88 }
89
90
91 void
92 release_public_key_parts (PKT_public_key *pk)
93 {
94   int n, i;
95
96   if (pk->seckey_info)
97     n = pubkey_get_nskey (pk->pubkey_algo);
98   else
99     n = pubkey_get_npkey (pk->pubkey_algo);
100   if (!n)
101     mpi_release (pk->pkey[0]);
102   for (i=0; i < n; i++ )
103     {
104       mpi_release (pk->pkey[i]);
105       pk->pkey[i] = NULL;
106     }
107   if (pk->seckey_info)
108     {
109       xfree (pk->seckey_info);
110       pk->seckey_info = NULL;
111     }
112   if (pk->prefs)
113     {
114       xfree (pk->prefs);
115       pk->prefs = NULL;
116     }
117   free_user_id (pk->user_id);
118   pk->user_id = NULL;
119   if (pk->revkey)
120     {
121       xfree(pk->revkey);
122       pk->revkey=NULL;
123       pk->numrevkeys=0;
124     }
125   if (pk->serialno)
126     {
127       xfree (pk->serialno);
128       pk->serialno = NULL;
129     }
130 }
131
132
133 /* Free an allocated public key structure including all parts.
134    Passing NULL is allowed.  */
135 void
136 free_public_key (PKT_public_key *pk)
137 {
138   if (pk)
139     {
140       release_public_key_parts (pk);
141       xfree(pk);
142     }
143 }
144
145
146 static subpktarea_t *
147 cp_subpktarea (subpktarea_t *s )
148 {
149     subpktarea_t *d;
150
151     if( !s )
152         return NULL;
153     d = xmalloc (sizeof (*d) + s->size - 1 );
154     d->size = s->size;
155     d->len = s->len;
156     memcpy (d->data, s->data, s->len);
157     return d;
158 }
159
160 /*
161  * Return a copy of the preferences
162  */
163 prefitem_t *
164 copy_prefs (const prefitem_t *prefs)
165 {
166     size_t n;
167     prefitem_t *new;
168
169     if (!prefs)
170         return NULL;
171
172     for (n=0; prefs[n].type; n++)
173         ;
174     new = xmalloc ( sizeof (*new) * (n+1));
175     for (n=0; prefs[n].type; n++) {
176         new[n].type = prefs[n].type;
177         new[n].value = prefs[n].value;
178     }
179     new[n].type = PREFTYPE_NONE;
180     new[n].value = 0;
181
182     return new;
183 }
184
185
186 /* Copy the public key S to D.  If D is NULL allocate a new public key
187    structure.  If S has seckret key infos, only the public stuff is
188    copied.  */
189 PKT_public_key *
190 copy_public_key (PKT_public_key *d, PKT_public_key *s)
191 {
192   int n, i;
193
194   if (!d)
195     d = xmalloc (sizeof *d);
196   memcpy (d, s, sizeof *d);
197   d->seckey_info = NULL;
198   d->user_id = scopy_user_id (s->user_id);
199   d->prefs = copy_prefs (s->prefs);
200
201   n = pubkey_get_npkey (s->pubkey_algo);
202   i = 0;
203   if (!n)
204     d->pkey[i++] = my_mpi_copy (s->pkey[0]);
205   else
206     {
207       for (; i < n; i++ )
208         d->pkey[i] = my_mpi_copy (s->pkey[i]);
209     }
210   for (; i < PUBKEY_MAX_NSKEY; i++)
211     d->pkey[i] = NULL;
212
213   if (!s->revkey && s->numrevkeys)
214     BUG();
215   if (s->numrevkeys)
216     {
217       d->revkey = xmalloc(sizeof(struct revocation_key)*s->numrevkeys);
218       memcpy(d->revkey,s->revkey,sizeof(struct revocation_key)*s->numrevkeys);
219     }
220   else
221     d->revkey = NULL;
222   return d;
223 }
224
225
226
227 static pka_info_t *
228 cp_pka_info (const pka_info_t *s)
229 {
230   pka_info_t *d = xmalloc (sizeof *s + strlen (s->email));
231
232   d->valid = s->valid;
233   d->checked = s->checked;
234   d->uri = s->uri? xstrdup (s->uri):NULL;
235   memcpy (d->fpr, s->fpr, sizeof s->fpr);
236   strcpy (d->email, s->email);
237   return d;
238 }
239
240
241 PKT_signature *
242 copy_signature( PKT_signature *d, PKT_signature *s )
243 {
244     int n, i;
245
246     if( !d )
247         d = xmalloc(sizeof *d);
248     memcpy( d, s, sizeof *d );
249     n = pubkey_get_nsig( s->pubkey_algo );
250     if( !n )
251         d->data[0] = my_mpi_copy(s->data[0]);
252     else {
253         for(i=0; i < n; i++ )
254             d->data[i] = my_mpi_copy( s->data[i] );
255     }
256     d->pka_info = s->pka_info? cp_pka_info (s->pka_info) : NULL;
257     d->hashed = cp_subpktarea (s->hashed);
258     d->unhashed = cp_subpktarea (s->unhashed);
259     if (s->signers_uid)
260       d->signers_uid = xstrdup (s->signers_uid);
261     if(s->numrevkeys)
262       {
263         d->revkey=NULL;
264         d->numrevkeys=0;
265         parse_revkeys(d);
266       }
267     return d;
268 }
269
270
271 /*
272  * shallow copy of the user ID
273  */
274 PKT_user_id *
275 scopy_user_id (PKT_user_id *s)
276 {
277     if (s)
278         s->ref++;
279     return s;
280 }
281
282
283
284 void
285 free_comment( PKT_comment *rem )
286 {
287     xfree(rem);
288 }
289
290 void
291 free_attributes(PKT_user_id *uid)
292 {
293   if (!uid)
294     return;
295
296   xfree(uid->attribs);
297   xfree(uid->attrib_data);
298
299   uid->attribs=NULL;
300   uid->attrib_data=NULL;
301   uid->attrib_len=0;
302 }
303
304 void
305 free_user_id (PKT_user_id *uid)
306 {
307   if (!uid)
308     return;
309
310   log_assert (uid->ref > 0);
311   if (--uid->ref)
312     return;
313
314   free_attributes(uid);
315   xfree (uid->prefs);
316   xfree (uid->namehash);
317   xfree (uid->mbox);
318   xfree (uid);
319 }
320
321 void
322 free_compressed( PKT_compressed *zd )
323 {
324   if (!zd)
325     return;
326
327   if (zd->buf)
328     {
329       /* We need to skip some bytes.  Because don't have any
330        * information about the length, so we assume this is the last
331        * packet */
332       while (iobuf_read( zd->buf, NULL, 1<<30 ) != -1)
333         ;
334     }
335   xfree(zd);
336 }
337
338 void
339 free_encrypted( PKT_encrypted *ed )
340 {
341   if (!ed)
342     return;
343
344   if (ed->buf)
345     {
346       /* We need to skip some bytes. */
347       if (ed->is_partial)
348         {
349           while (iobuf_read( ed->buf, NULL, 1<<30 ) != -1)
350             ;
351         }
352       else
353         {
354           while (ed->len)
355             {
356               /* Skip the packet. */
357               int n = iobuf_read( ed->buf, NULL, ed->len );
358               if (n == -1)
359                 ed->len = 0;
360               else
361                 ed->len -= n;
362             }
363         }
364     }
365   xfree (ed);
366 }
367
368
369 void
370 free_plaintext( PKT_plaintext *pt )
371 {
372   if (!pt)
373     return;
374
375   if (pt->buf)
376     { /* We need to skip some bytes.  */
377       if (pt->is_partial)
378         {
379           while (iobuf_read( pt->buf, NULL, 1<<30 ) != -1)
380             ;
381         }
382       else
383         {
384           while( pt->len )
385             { /* Skip the packet.  */
386               int n = iobuf_read( pt->buf, NULL, pt->len );
387               if (n == -1)
388                 pt->len = 0;
389               else
390                 pt->len -= n;
391             }
392         }
393     }
394   xfree (pt);
395 }
396
397 /****************
398  * Free the packet in PKT.
399  */
400 void
401 free_packet (PACKET *pkt)
402 {
403   if (!pkt || !pkt->pkt.generic)
404     return;
405
406   if (DBG_MEMORY)
407     log_debug ("free_packet() type=%d\n", pkt->pkttype);
408
409   switch (pkt->pkttype)
410     {
411     case PKT_SIGNATURE:
412       free_seckey_enc (pkt->pkt.signature);
413       break;
414     case PKT_PUBKEY_ENC:
415       free_pubkey_enc (pkt->pkt.pubkey_enc);
416       break;
417     case PKT_SYMKEY_ENC:
418       free_symkey_enc (pkt->pkt.symkey_enc);
419       break;
420     case PKT_PUBLIC_KEY:
421     case PKT_PUBLIC_SUBKEY:
422     case PKT_SECRET_KEY:
423     case PKT_SECRET_SUBKEY:
424       free_public_key (pkt->pkt.public_key);
425       break;
426     case PKT_COMMENT:
427       free_comment (pkt->pkt.comment);
428       break;
429     case PKT_USER_ID:
430       free_user_id (pkt->pkt.user_id);
431       break;
432     case PKT_COMPRESSED:
433       free_compressed (pkt->pkt.compressed);
434       break;
435     case PKT_ENCRYPTED:
436     case PKT_ENCRYPTED_MDC:
437       free_encrypted (pkt->pkt.encrypted);
438       break;
439     case PKT_PLAINTEXT:
440       free_plaintext (pkt->pkt.plaintext);
441       break;
442     default:
443       xfree (pkt->pkt.generic);
444       break;
445     }
446
447   pkt->pkt.generic = NULL;
448 }
449
450
451 /****************
452  * returns 0 if they match.
453  */
454 int
455 cmp_public_keys( PKT_public_key *a, PKT_public_key *b )
456 {
457     int n, i;
458
459     if( a->timestamp != b->timestamp )
460         return -1;
461     if( a->version < 4 && a->expiredate != b->expiredate )
462         return -1;
463     if( a->pubkey_algo != b->pubkey_algo )
464         return -1;
465
466     n = pubkey_get_npkey( b->pubkey_algo );
467     if( !n ) { /* unknown algorithm, rest is in opaque MPI */
468         if( mpi_cmp( a->pkey[0], b->pkey[0] ) )
469             return -1; /* can't compare due to unknown algorithm */
470     } else {
471         for(i=0; i < n; i++ ) {
472             if( mpi_cmp( a->pkey[i], b->pkey[i] ) )
473                 return -1;
474         }
475     }
476
477     return 0;
478 }
479
480
481
482 int
483 cmp_signatures( PKT_signature *a, PKT_signature *b )
484 {
485     int n, i;
486
487     if( a->keyid[0] != b->keyid[0] )
488         return -1;
489     if( a->keyid[1] != b->keyid[1] )
490         return -1;
491     if( a->pubkey_algo != b->pubkey_algo )
492         return -1;
493
494     n = pubkey_get_nsig( a->pubkey_algo );
495     if( !n )
496         return -1; /* can't compare due to unknown algorithm */
497     for(i=0; i < n; i++ ) {
498         if( mpi_cmp( a->data[i] , b->data[i] ) )
499             return -1;
500     }
501     return 0;
502 }
503
504
505 /****************
506  * Returns: true if the user ids do not match
507  */
508 int
509 cmp_user_ids( PKT_user_id *a, PKT_user_id *b )
510 {
511     int res=1;
512
513     if( a == b )
514         return 0;
515
516     if( a->attrib_data && b->attrib_data )
517       {
518         res = a->attrib_len - b->attrib_len;
519         if( !res )
520           res = memcmp( a->attrib_data, b->attrib_data, a->attrib_len );
521       }
522     else if( !a->attrib_data && !b->attrib_data )
523       {
524         res = a->len - b->len;
525         if( !res )
526           res = memcmp( a->name, b->name, a->len );
527       }
528
529     return res;
530 }