kbx: Unify blob reading functions.
[gnupg.git] / kbx / keybox-file.c
1 /* keybox-file.c - File operations
2  *      Copyright (C) 2001, 2003 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 3 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, see <https://www.gnu.org/licenses/>.
18  */
19
20 #include <config.h>
21 #include <stdlib.h>
22 #include <stdio.h>
23 #include <string.h>
24 #include <errno.h>
25 #include <time.h>
26
27 #include "keybox-defs.h"
28
29
30 #define IMAGELEN_LIMIT (5*1024*1024)
31
32
33 #if !defined(HAVE_FTELLO) && !defined(ftello)
34 static off_t
35 ftello (FILE *stream)
36 {
37   long int off;
38
39   off = ftell (stream);
40   if (off == -1)
41     return (off_t)-1;
42   return off;
43 }
44 #endif /* !defined(HAVE_FTELLO) && !defined(ftello) */
45
46
47
48 /* Read a block at the current position and return it in R_BLOB.
49    R_BLOB may be NULL to simply skip the current block.  */
50 int
51 _keybox_read_blob (KEYBOXBLOB *r_blob, FILE *fp, int *skipped_deleted)
52 {
53   unsigned char *image;
54   size_t imagelen = 0;
55   int c1, c2, c3, c4, type;
56   int rc;
57   off_t off;
58
59   if (skipped_deleted)
60     *skipped_deleted = 0;
61  again:
62   if (r_blob)
63     *r_blob = NULL;
64   off = ftello (fp);
65   if (off == (off_t)-1)
66     return gpg_error_from_syserror ();
67
68   if ((c1 = getc (fp)) == EOF
69       || (c2 = getc (fp)) == EOF
70       || (c3 = getc (fp)) == EOF
71       || (c4 = getc (fp)) == EOF
72       || (type = getc (fp)) == EOF)
73     {
74       if ( c1 == EOF && !ferror (fp) )
75         return -1; /* eof */
76       if (!ferror (fp))
77         return gpg_error (GPG_ERR_TOO_SHORT);
78       return gpg_error_from_syserror ();
79     }
80
81   imagelen = ((unsigned int) c1 << 24) | (c2 << 16) | (c3 << 8 ) | c4;
82   if (imagelen < 5)
83     return gpg_error (GPG_ERR_TOO_SHORT);
84
85   if (!type)
86     {
87       /* Special treatment for empty blobs. */
88       if (fseek (fp, imagelen-5, SEEK_CUR))
89         return gpg_error_from_syserror ();
90       if (skipped_deleted)
91         *skipped_deleted = 1;
92       goto again;
93     }
94
95   if (imagelen > IMAGELEN_LIMIT) /* Sanity check. */
96     {
97       /* Seek forward so that the caller may choose to ignore this
98          record.  */
99       if (fseek (fp, imagelen-5, SEEK_CUR))
100         return gpg_error_from_syserror ();
101       return gpg_error (GPG_ERR_TOO_LARGE);
102     }
103
104   if (!r_blob)
105     {
106       /* This blob shall be skipped.  */
107       if (fseek (fp, imagelen-5, SEEK_CUR))
108         return gpg_error_from_syserror ();
109       return 0;
110     }
111
112   image = xtrymalloc (imagelen);
113   if (!image)
114     return gpg_error_from_syserror ();
115
116   image[0] = c1; image[1] = c2; image[2] = c3; image[3] = c4; image[4] = type;
117   if (fread (image+5, imagelen-5, 1, fp) != 1)
118     {
119       gpg_error_t tmperr = gpg_error_from_syserror ();
120       xfree (image);
121       return tmperr;
122     }
123
124   rc = _keybox_new_blob (r_blob, image, imagelen, off);
125   if (rc)
126     xfree (image);
127   return rc;
128 }
129
130
131 /* Write the block to the current file position */
132 int
133 _keybox_write_blob (KEYBOXBLOB blob, FILE *fp)
134 {
135   const unsigned char *image;
136   size_t length;
137
138   image = _keybox_get_blob_image (blob, &length);
139
140   if (length > IMAGELEN_LIMIT)
141     return gpg_error (GPG_ERR_TOO_LARGE);
142
143   if (fwrite (image, length, 1, fp) != 1)
144     return gpg_error_from_syserror ();
145   return 0;
146 }
147
148
149 /* Write a fresh header type blob. */
150 int
151 _keybox_write_header_blob (FILE *fp, int for_openpgp)
152 {
153   unsigned char image[32];
154   u32 val;
155
156   memset (image, 0, sizeof image);
157   /* Length of this blob. */
158   image[3] = 32;
159
160   image[4] = KEYBOX_BLOBTYPE_HEADER;
161   image[5] = 1; /* Version */
162   if (for_openpgp)
163     image[7] = 0x02; /* OpenPGP data may be available.  */
164
165   memcpy (image+8, "KBXf", 4);
166   val = time (NULL);
167   /* created_at and last maintenance run. */
168   image[16]   = (val >> 24);
169   image[16+1] = (val >> 16);
170   image[16+2] = (val >>  8);
171   image[16+3] = (val      );
172   image[20]   = (val >> 24);
173   image[20+1] = (val >> 16);
174   image[20+2] = (val >>  8);
175   image[20+3] = (val      );
176
177   if (fwrite (image, 32, 1, fp) != 1)
178     return gpg_error_from_syserror ();
179   return 0;
180 }