2003-09-22 Timo Schulz <twoaday@freakmail.de>
[gnupg.git] / g10 / card-util.c
1 /* card-util.c - Utility functions for the OpenPGP card.
2  *      Copyright (C) 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 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 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <errno.h>
26 #include <assert.h>
27
28 #include "gpg.h"
29 #include "util.h"
30 #include "i18n.h"
31 #include "ttyio.h"
32 #include "status.h"
33 #include "options.h"
34 #include "main.h"
35 #include "call-agent.h"
36
37 #define CONTROL_D ('D' - 'A' + 1)
38
39
40 /* Change the PIN of a an OpenPGP card.  This is an interactive
41    function. */
42 void
43 change_pin (int chvno)
44 {
45   struct agent_card_info_s info;
46   int rc;
47   int reset_mode = 0;
48
49   rc = agent_learn (&info);
50   if (rc)
51     {
52       log_error (_("OpenPGP card not available: %s\n"),
53                   gpg_strerror (rc));
54       return;
55     }
56   
57   log_info (_("OpenPGP card no. %s detected\n"),
58               info.serialno? info.serialno : "[none]");
59
60   agent_release_card_info (&info);
61
62   if (opt.batch)
63     {
64       log_error (_("sorry, can't do this in batch mode\n"));
65       return;
66     }
67
68   for (;;)
69     {
70       char *answer;
71
72       tty_printf ("\n");
73       tty_printf ("1 - change signature PIN\n"
74                   "2 - change decryption and authentication PIN\n"
75                   "3 - change Admin's PIN\n"
76                   "R - toggle reset retry counter mode\n"
77                   "Q - quit\n");
78       tty_printf ("\n");
79       if (reset_mode)
80         {
81           tty_printf ("Reset Retry Counter mode active\n");
82           tty_printf ("\n");
83         }
84
85       answer = cpr_get("cardutil.change_pin.menu",_("Your selection? "));
86       cpr_kill_prompt();
87       if (strlen (answer) != 1)
88         continue;
89
90       rc = 0;
91       if (reset_mode && *answer == '3')
92         {
93           tty_printf ("Sorry, reset of the Admin PIN's retry counter "
94                       "is not possible.\n");
95         }
96       else if (*answer == '1'  || *answer == '2' || *answer == '3')
97         {
98           rc = agent_scd_change_pin (*answer - '0' + (reset_mode?100:0));
99           if (rc)
100             tty_printf ("Error changing/resetting the PIN: %s\n",
101                         gpg_strerror (rc));
102           else
103             tty_printf ("New PIN successfully set.\n");
104         }
105       else if (*answer == 'r' || *answer == 'R')
106         {
107           reset_mode = !reset_mode;
108         }
109       else if (*answer == 'q' || *answer == 'Q')
110         {
111           break;
112         }
113     }
114
115 }
116
117 static const char *
118 get_manufacturer (unsigned int no)
119 {
120   switch (no)
121     {
122     case 0:
123     case 0xffff: return "test card";
124     case 0x0001: return "PPC Card Systems";
125     default: return "unknown";
126     }
127 }
128
129
130 static void
131 print_sha1_fpr (FILE *fp, const unsigned char *fpr)
132 {
133   int i;
134
135   if (fpr)
136     {
137       for (i=0; i < 20 ; i+=2, fpr += 2 )
138         {
139           if (i == 10 )
140             tty_fprintf (fp, " ");
141           tty_fprintf (fp, " %02X%02X", *fpr, fpr[1]);
142         }
143     }
144   else
145     tty_fprintf (fp, " [none]");
146   tty_fprintf (fp, "\n");
147 }
148
149
150 static void
151 print_name (FILE *fp, const char *text, const char *name)
152 {
153   tty_fprintf (fp, text);
154
155
156   /* FIXME: tty_printf_utf8_string2 east everything after and
157      including an @ - e.g. when printing an url. */
158   if (name && *name)
159     {
160       if (fp)
161         print_utf8_string2 (fp, name, strlen (name), '\n');
162       else
163         tty_print_utf8_string2 (name, strlen (name), '\n');
164     }
165   else
166     tty_fprintf (fp, _("[not set]"));
167   tty_fprintf (fp, "\n");
168 }
169
170 static void
171 print_isoname (FILE *fp, const char *text, const char *name)
172 {
173   tty_fprintf (fp, text);
174
175   if (name && *name)
176     {
177       char *p, *given, *buf = xstrdup (name);
178
179       given = strstr (buf, "<<");
180       for (p=buf; *p; p++)
181         if (*p == '<')
182           *p = ' ';
183       if (given && given[2])
184         {
185           *given = 0;
186           given += 2;
187           if (fp)
188             print_utf8_string2 (fp, given, strlen (given), '\n');
189           else
190             tty_print_utf8_string2 (given, strlen (given), '\n');
191           if (*buf)
192             tty_fprintf (fp, " ");
193         }
194       if (fp)
195         print_utf8_string2 (fp, buf, strlen (buf), '\n');
196       else
197         tty_print_utf8_string2 (buf, strlen (buf), '\n');
198       xfree (buf);
199     }
200   else
201     tty_fprintf (fp, _("[not set]"));
202   tty_fprintf (fp, "\n");
203 }
204
205
206 /* Print all available information about the current card. */
207 void
208 card_status (FILE *fp)
209 {
210   struct agent_card_info_s info;
211   PKT_public_key *pk = xcalloc (1, sizeof *pk);
212   int rc;
213
214   rc = agent_learn (&info);
215   if (rc)
216     {
217       log_error (_("OpenPGP card not available: %s\n"),
218                   gpg_strerror (rc));
219       xfree (pk);
220       return;
221     }
222   
223   tty_fprintf (fp, "Application ID ...: %s\n",
224                info.serialno? info.serialno : "[none]");
225   if (!info.serialno || strncmp (info.serialno, "D27600012401", 12) 
226       || strlen (info.serialno) != 32 )
227     {
228       log_info ("not an OpenPGP card\n");
229       agent_release_card_info (&info);
230       xfree (pk);
231       return;
232     }
233   tty_fprintf (fp, "Version ..........: %.1s%c.%.1s%c\n",
234                info.serialno[12] == '0'?"":info.serialno+12,
235                info.serialno[13],
236                info.serialno[14] == '0'?"":info.serialno+14,
237                info.serialno[15]);
238   tty_fprintf (fp, "Manufacturer .....: %s\n", 
239                get_manufacturer (xtoi_2(info.serialno+16)*256
240                                  + xtoi_2 (info.serialno+18)));
241   tty_fprintf (fp, "Serial number ....: %.8s\n", info.serialno+20);
242   
243   print_isoname (fp, "Name of cardholder: ", info.disp_name);
244   print_name (fp, "Language prefs ...: ", info.disp_lang);
245   tty_fprintf (fp,    "Sex ..............: %s\n",
246                info.disp_sex == 1? _("male"):
247                info.disp_sex == 2? _("female") : _("unspecified"));
248   print_name (fp, "URL of public key : ", info.pubkey_url);
249   print_name (fp, "Login data .......: ", info.login_data);
250   tty_fprintf (fp,    "Signature PIN ....: %s\n",
251                info.chv1_cached? _("cached"): _("not cached"));
252   tty_fprintf (fp,    "Max. PIN lengths .: %d %d %d\n",
253                info.chvmaxlen[0], info.chvmaxlen[1], info.chvmaxlen[2]);
254   tty_fprintf (fp,    "PIN retry counter : %d %d %d\n",
255                info.chvretry[0], info.chvretry[1], info.chvretry[2]);
256   tty_fprintf (fp, "Signature key ....:");
257   print_sha1_fpr (fp, info.fpr1valid? info.fpr1:NULL);
258   tty_fprintf (fp, "Encryption key....:");
259   print_sha1_fpr (fp, info.fpr2valid? info.fpr2:NULL);
260   tty_fprintf (fp, "Authentication key:");
261   print_sha1_fpr (fp, info.fpr3valid? info.fpr3:NULL);
262   tty_fprintf (fp, "General key info..: "); 
263   if (info.fpr1valid && !get_pubkey_byfprint (pk, info.fpr1, 20))
264     print_pubkey_info (fp, pk);
265   else
266     fputs ("[none]\n", fp);
267   tty_fprintf (fp,    "Signature counter : %lu\n", info.sig_counter);
268   
269   free_public_key (pk);
270   agent_release_card_info (&info);
271 }
272
273
274 static char *
275 get_one_name (const char *prompt1, const char *prompt2)
276 {
277   char *name;
278   int i;
279
280   for (;;)
281     {
282       name = cpr_get (prompt1, prompt2);
283       if (!name)
284         return NULL;
285       trim_spaces (name);
286       cpr_kill_prompt ();
287       for (i=0; name[i] && name[i] >= ' ' && name[i] <= 126; i++)
288         ;
289
290       /* The name must be in Latin-1 and not UTF-8 - lacking the code
291          to ensure this we restrict it to ASCII. */
292       if (name[i])
293         tty_printf (_("Error: Only plain ASCII is currently allowed.\n"));
294       else if (strchr (name, '<'))
295         tty_printf (_("Error: The \"<\" character may not be used.\n"));
296       else if (strstr (name, "  "))
297         tty_printf (_("Error: Double spaces are not allowed.\n"));    
298       else
299         return name;
300       xfree (name);
301     }
302 }
303
304
305
306 static int
307 change_name (void)
308 {
309   char *surname = NULL, *givenname = NULL;
310   char *isoname, *p;
311   int rc;
312
313   surname = get_one_name ("keygen.smartcard.surname",
314                                     _("Cardholder's surname: "));
315   givenname = get_one_name ("keygen.smartcard.givenname",
316                                        _("Cardholder's given name: "));
317   if (!surname || !givenname || (!*surname && !*givenname))
318     {
319       xfree (surname);
320       xfree (givenname);
321       return -1; /*canceled*/
322     }
323
324   isoname = xmalloc ( strlen (surname) + 2 + strlen (givenname) + 1);
325   strcpy (stpcpy (stpcpy (isoname, surname), "<<"), givenname);
326   xfree (surname);
327   xfree (givenname);
328   for (p=isoname; *p; p++)
329     if (*p == ' ')
330       *p = '<';
331
332   log_debug ("setting Name to `%s'\n", isoname);
333   rc = agent_scd_setattr ("DISP-NAME", isoname, strlen (isoname) );
334   if (rc)
335     log_error ("error setting Name: %s\n", gpg_strerror (rc));
336
337   xfree (isoname);
338   return rc;
339 }
340
341
342 static int
343 change_url (void)
344 {
345   char *url;
346   int rc;
347
348   url = cpr_get ("cardedit.change_url", _("URL to retrieve public key: "));
349   if (!url)
350     return -1;
351   trim_spaces (url);
352   cpr_kill_prompt ();
353
354   rc = agent_scd_setattr ("PUBKEY-URL", url, strlen (url) );
355   if (rc)
356     log_error ("error setting URL: %s\n", gpg_strerror (rc));
357   xfree (url);
358   return rc;
359 }
360
361 static int
362 change_login (void)
363 {
364   char *data;
365   int rc;
366
367   data = cpr_get ("cardedit.change_login",
368                   _("Login data (account name): "));
369   if (!data)
370     return -1;
371   trim_spaces (data);
372   cpr_kill_prompt ();
373
374   rc = agent_scd_setattr ("LOGIN-DATA", data, strlen (data) );
375   if (rc)
376     log_error ("error setting login data: %s\n", gpg_strerror (rc));
377   xfree (data);
378   return rc;
379 }
380
381 static int
382 change_lang (void)
383 {
384   char *data, *p;
385   int rc;
386
387   data = cpr_get ("cardedit.change_lang",
388                   _("Language preferences: "));
389   if (!data)
390     return -1;
391   trim_spaces (data);
392   cpr_kill_prompt ();
393
394   if (strlen (data) > 8 || (strlen (data) & 1))
395     {
396       tty_printf (_("Error: invalid length of preference string.\n"));
397       xfree (data);
398       return -1;
399     }
400
401   for (p=data; *p && *p >= 'a' && *p <= 'z'; p++)
402     ;
403   if (*p)
404     {
405       tty_printf (_("Error: invalid characters in preference string.\n"));
406       xfree (data);
407       return -1;
408     }
409
410   rc = agent_scd_setattr ("DISP-LANG", data, strlen (data) );
411   if (rc)
412     log_error ("error setting lang: %s\n", gpg_strerror (rc));
413   xfree (data);
414   return rc;
415 }
416
417
418 static int
419 change_sex (void)
420 {
421   char *data;
422   const char *str;
423   int rc;
424
425   data = cpr_get ("cardedit.change_sex",
426                   _("Sex ((M)ale, (F)emale or space): "));
427   if (!data)
428     return -1;
429   trim_spaces (data);
430   cpr_kill_prompt ();
431
432   if (!*data)
433     str = "9";
434   else if ((*data == 'M' || *data == 'm') && !data[1])
435     str = "1";
436   else if ((*data == 'F' || *data == 'f') && !data[1])
437     str = "2";
438   else 
439     {
440       tty_printf (_("Error: invalid response.\n"));
441       xfree (data);
442       return -1;
443     }
444      
445   rc = agent_scd_setattr ("DISP-SEX", str, 1 );
446   if (rc)
447     log_error ("error setting sex: %s\n", gpg_strerror (rc));
448   xfree (data);
449   return rc;
450 }
451
452
453 /* Menu to edit all user changeable values on an OpenPGP card.  Only
454    Key creation is not handled here. */
455 void
456 card_edit (STRLIST commands)
457 {
458   enum cmdids {
459     cmdNOP = 0,
460     cmdQUIT, cmdHELP, cmdLIST, cmdDEBUG,
461     cmdNAME, cmdURL, cmdLOGIN, cmdLANG, cmdSEX,
462
463     cmdINVCMD
464   };
465
466   static struct {
467     const char *name;
468     enum cmdids id;
469     const char *desc;
470   } cmds[] = {
471     { N_("quit")  , cmdQUIT  , N_("quit this menu") },
472     { N_("q")     , cmdQUIT  , NULL   },
473     { N_("help")  , cmdHELP  , N_("show this help") },
474     {    "?"      , cmdHELP  , NULL   },
475     { N_("list")  , cmdLIST  , N_("list all available data") },
476     { N_("l")     , cmdLIST  , NULL   },
477     { N_("debug") , cmdDEBUG , NULL },
478     { N_("name")  , cmdNAME  , N_("change card holder's name") },
479     { N_("url")   , cmdURL   , N_("change URL to retrieve key") },
480     { N_("login") , cmdLOGIN , N_("change the login name") },
481     { N_("lang")  , cmdLANG  , N_("change the language preferences") },
482     { N_("sex")   , cmdSEX   , N_("change card holder's sex") },
483     { NULL, cmdINVCMD } 
484   };
485
486   enum cmdids cmd = cmdNOP;
487   int have_commands = !!commands;
488   int redisplay = 1;
489   char *answer = NULL;
490
491   if (opt.command_fd != -1)
492     ;
493   else if (opt.batch && !have_commands)
494     {
495       log_error(_("can't do that in batchmode\n"));
496       goto leave;
497     }
498
499   for (;;)
500     {
501       int arg_number;
502       const char *arg_string = "";
503       char *p;
504       int i;
505
506       tty_printf("\n");
507       if (redisplay )
508         {
509           card_status (NULL);
510           tty_printf("\n");
511           redisplay = 0;
512         }
513
514       do
515         {
516           xfree (answer);
517           if (have_commands)
518             {
519               if (commands)
520                 {
521                   answer = xstrdup (commands->d);
522                   commands = commands->next;
523                 }
524               else if (opt.batch)
525                 {
526                   answer = xstrdup ("quit");
527                 }
528               else
529                 have_commands = 0;
530             }
531
532             if (!have_commands)
533               {
534                 answer = cpr_get_no_help("cardedit.prompt", _("Command> "));
535                 cpr_kill_prompt();
536             }
537             trim_spaces(answer);
538         }
539       while( *answer == '#' );
540
541       arg_number = 0; /* Yes, here is the init which egcc complains about */
542       if (!*answer)
543         cmd = cmdLIST; /* Default to the list command */
544       else if (*answer == CONTROL_D)
545         cmd = cmdQUIT;
546       else {
547         if ((p=strchr (answer,' ')))
548           {
549             *p++ = 0;
550             trim_spaces (answer);
551             trim_spaces (p);
552             arg_number = atoi(p);
553             arg_string = p;
554           }
555
556         for (i=0; cmds[i].name; i++ )
557           if (!ascii_strcasecmp (answer, cmds[i].name ))
558             break;
559
560         cmd = cmds[i].id;
561       }
562
563       switch (cmd)
564         {
565         case cmdHELP:
566           for (i=0; cmds[i].name; i++ )
567             if (cmds[i].desc)
568               tty_printf("%-10s %s\n", cmds[i].name, _(cmds[i].desc) );
569           break;
570
571         case cmdLIST:
572           redisplay = 1;
573           break;
574
575         case cmdNAME:
576           change_name ();
577           break;
578
579         case cmdURL:
580           change_url ();
581           break;
582
583         case cmdLOGIN:
584           change_login ();
585           break;
586
587         case cmdLANG:
588           change_lang ();
589           break;
590
591         case cmdSEX:
592           change_sex ();
593           break;
594
595         case cmdQUIT:
596           goto leave;
597
598         case cmdNOP:
599           break;
600
601         case cmdINVCMD:
602         default:
603           tty_printf ("\n");
604           tty_printf (_("Invalid command  (try \"help\")\n"));
605           break;
606         } /* End command switch. */
607     } /* End of main menu loop. */
608
609  leave:
610   xfree (answer);
611 }
612