* photoid.h, photoid.c (generate_photo_id): Allow passing in a
[gnupg.git] / g10 / photoid.c
1 /* photoid.c - photo ID handling code
2  * Copyright (C) 2001, 2002, 2005 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
19  * USA.
20  */
21
22 #include <config.h>
23 #include <errno.h>
24 #include <stdio.h>
25 #include <string.h>
26 #ifdef _WIN32 
27 # include <windows.h>
28 # ifndef VER_PLATFORM_WIN32_WINDOWS
29 #  define VER_PLATFORM_WIN32_WINDOWS 1
30 # endif
31 #endif
32 #include "packet.h"
33 #include "status.h"
34 #include "exec.h"
35 #include "keydb.h"
36 #include "util.h"
37 #include "i18n.h"
38 #include "iobuf.h"
39 #include "memory.h"
40 #include "options.h"
41 #include "main.h"
42 #include "photoid.h"
43 #include "ttyio.h"
44
45 /* Generate a new photo id packet, or return NULL if canceled */
46 PKT_user_id *
47 generate_photo_id(PKT_public_key *pk,const char *photo_name)
48 {
49   PKT_user_id *uid;
50   int error=1,i;
51   unsigned int len;
52   char *filename;
53   byte *photo=NULL;
54   byte header[16];
55   IOBUF file;
56
57   header[0]=0x10; /* little side of photo header length */
58   header[1]=0;    /* big side of photo header length */
59   header[2]=1;    /* 1 == version of photo header */
60   header[3]=1;    /* 1 == JPEG */
61
62   for(i=4;i<16;i++) /* The reserved bytes */
63     header[i]=0;
64
65 #define EXTRA_UID_NAME_SPACE 71
66   uid=xmalloc_clear(sizeof(*uid)+71);
67
68   if(photo_name && *photo_name)
69     filename=make_filename(photo_name,(void *)NULL);
70   else
71     {
72       tty_printf(_("\nPick an image to use for your photo ID."
73                    "  The image must be a JPEG file.\n"
74                    "Remember that the image is stored within your public key."
75                    "  If you use a\n"
76                    "very large picture, your key will become very large"
77                    " as well!\n"
78                    "Keeping the image close to 240x288 is a good size"
79                    " to use.\n"));
80       filename=NULL;
81     }
82
83   while(photo==NULL)
84     {
85       if(filename==NULL)
86         {
87           char *tempname;
88
89           tty_printf("\n");
90
91           tty_enable_completion(NULL);
92
93           tempname=cpr_get("photoid.jpeg.add",
94                            _("Enter JPEG filename for photo ID: "));
95
96           tty_disable_completion();
97
98           filename=make_filename(tempname,(void *)NULL);
99
100           xfree(tempname);
101
102           if(strlen(filename)==0)
103             goto scram;
104         }
105
106       file=iobuf_open(filename);
107       if (file && is_secured_file (iobuf_get_fd (file)))
108         {
109           iobuf_close (file);
110           file = NULL;
111           errno = EPERM;
112         }
113       if(!file)
114         {
115           log_error(_("unable to open JPEG file `%s': %s\n"),
116                     filename,strerror(errno));
117           xfree(filename);
118           filename=NULL;
119           continue;
120         }
121
122       len=iobuf_get_filelength(file);
123       if(len>6144)
124         {
125           tty_printf( _("This JPEG is really large (%d bytes) !\n"),len);
126           if(!cpr_get_answer_is_yes("photoid.jpeg.size",
127                             _("Are you sure you want to use it? (y/N) ")))
128           {
129             iobuf_close(file);
130             xfree(filename);
131             filename=NULL;
132             continue;
133           }
134         }
135
136       photo=xmalloc(len);
137       iobuf_read(file,photo,len);
138       iobuf_close(file);
139
140       /* Is it a JPEG? */
141       if(photo[0]!=0xFF || photo[1]!=0xD8 ||
142          photo[6]!='J' || photo[7]!='F' || photo[8]!='I' || photo[9]!='F')
143         {
144           log_error(_("`%s' is not a JPEG file\n"),filename);
145           xfree(photo);
146           photo=NULL;
147           xfree(filename);
148           filename=NULL;
149           continue;
150         }
151
152       /* Build the packet */
153       build_attribute_subpkt(uid,1,photo,len,header,16);
154       parse_attribute_subpkts(uid);
155       make_attribute_uidname(uid, EXTRA_UID_NAME_SPACE);
156
157       /* Showing the photo is not safe when noninteractive since the
158          "user" may not be able to dismiss a viewer window! */
159       if(opt.command_fd==-1)
160         {
161           show_photos(uid->attribs,uid->numattribs,pk,NULL);
162           switch(cpr_get_answer_yes_no_quit("photoid.jpeg.okay",
163                                          _("Is this photo correct (y/N/q)? ")))
164             {
165             case -1:
166               goto scram;
167             case 0:
168               free_attributes(uid);
169               xfree(photo);
170               photo=NULL;
171               xfree(filename);
172               filename=NULL;
173               continue;
174             }
175         }
176     }
177
178   error=0;
179   uid->ref=1;
180
181  scram:
182   xfree(filename);
183   xfree(photo);
184
185   if(error)
186     {
187       free_attributes(uid);
188       xfree(uid);
189       return NULL;
190     }
191
192   return uid;
193 }
194
195 /* Returns 0 for error, 1 for valid */
196 int parse_image_header(const struct user_attribute *attr,byte *type,u32 *len)
197 {
198   u16 headerlen;
199
200   if(attr->len<3)
201     return 0;
202
203   /* For historical reasons (i.e. "oops!"), the header length is
204      little endian. */
205   headerlen=(attr->data[1]<<8) | attr->data[0];
206
207   if(headerlen>attr->len)
208     return 0;
209
210   if(type && attr->len>=4)
211     {
212       if(attr->data[2]==1) /* header version 1 */
213         *type=attr->data[3];
214       else
215         *type=0;
216     }
217
218   *len=attr->len-headerlen;
219
220   if(*len==0)
221     return 0;
222
223   return 1;
224 }
225
226 /* style==0 for extension, 1 for name, 2 for MIME type.  Remember that
227    the "name" style string could be used in a user ID name field, so
228    make sure it is not too big (see parse-packet.c:parse_attribute).
229    Extensions should be 3 characters long for the best cross-platform
230    compatibility. */
231 char *image_type_to_string(byte type,int style)
232 {
233   char *string;
234
235   switch(type)
236     {
237     case 1: /* jpeg */
238       if(style==0)
239         string="jpg";
240       else if(style==1)
241         string="jpeg";
242       else
243         string="image/jpeg";
244       break;
245
246     default:
247       if(style==0)
248         string="bin";
249       else if(style==1)
250         string="unknown";
251       else
252         string="image/x-unknown";
253       break;
254     }
255
256   return string;
257 }
258
259 #if !defined(FIXED_PHOTO_VIEWER) && !defined(DISABLE_PHOTO_VIEWER)
260 static const char *get_default_photo_command(void)
261 {
262 #if defined(_WIN32)
263   OSVERSIONINFO osvi;
264
265   memset(&osvi,0,sizeof(osvi));
266   osvi.dwOSVersionInfoSize=sizeof(osvi);
267   GetVersionEx(&osvi);
268
269   if(osvi.dwPlatformId==VER_PLATFORM_WIN32_WINDOWS)
270     return "start /w %i";
271   else
272     return "cmd /c start /w %i";
273 #elif defined(__APPLE__)
274   /* OS X.  This really needs more than just __APPLE__. */
275   return "open %I";
276 #elif defined(__riscos__)
277   return "Filer_Run %I";
278 #else
279   return "xloadimage -fork -quiet -title 'KeyID 0x%k' stdin";
280 #endif
281 }
282 #endif
283
284 void show_photos(const struct user_attribute *attrs,
285                  int count,PKT_public_key *pk,PKT_secret_key *sk)
286 {
287 #ifndef DISABLE_PHOTO_VIEWER
288   int i;
289   struct expando_args args;
290   u32 len;
291   u32 kid[2]={0,0};
292
293   memset(&args,0,sizeof(args));
294   args.pk=pk;
295   args.sk=sk;
296
297   if(pk)
298     keyid_from_pk(pk,kid);
299   else if(sk)
300     keyid_from_sk(sk,kid);
301
302   for(i=0;i<count;i++)
303     if(attrs[i].type==ATTRIB_IMAGE &&
304        parse_image_header(&attrs[i],&args.imagetype,&len))
305       {
306         char *command,*name;
307         struct exec_info *spawn;
308         int offset=attrs[i].len-len;
309
310 #ifdef FIXED_PHOTO_VIEWER
311         opt.photo_viewer=FIXED_PHOTO_VIEWER;
312 #else
313         if(!opt.photo_viewer)
314           opt.photo_viewer=get_default_photo_command();
315 #endif
316
317         /* make command grow */
318         command=pct_expando(opt.photo_viewer,&args);
319         if(!command)
320           goto fail;
321
322         name=xmalloc(16+strlen(EXTSEP_S)+
323                      strlen(image_type_to_string(args.imagetype,0))+1);
324
325         /* Make the filename.  Notice we are not using the image
326            encoding type for more than cosmetics.  Most external image
327            viewers can handle a multitude of types, and even if one
328            cannot understand a particular type, we have no way to know
329            which.  The spec permits this, by the way. -dms */
330
331 #ifdef USE_ONLY_8DOT3
332         sprintf(name,"%08lX" EXTSEP_S "%s",(ulong)kid[1],
333                 image_type_to_string(args.imagetype,0));
334 #else
335         sprintf(name,"%08lX%08lX" EXTSEP_S "%s",(ulong)kid[0],(ulong)kid[1],
336                 image_type_to_string(args.imagetype,0));
337 #endif
338
339         if(exec_write(&spawn,NULL,command,name,1,1)!=0)
340           {
341             xfree(name);
342             goto fail;
343           }
344
345 #ifdef __riscos__
346         riscos_set_filetype_by_mimetype(spawn->tempfile_in,
347                                         image_type_to_string(args.imagetype,2));
348 #endif
349
350         xfree(name);
351
352         fwrite(&attrs[i].data[offset],attrs[i].len-offset,1,spawn->tochild);
353
354         if(exec_read(spawn)!=0)
355           {
356             exec_finish(spawn);
357             goto fail;
358           }
359
360         if(exec_finish(spawn)!=0)
361           goto fail;
362       }
363
364   return;
365
366  fail:
367   log_error(_("unable to display photo ID!\n"));
368 #endif
369 }