(print_isoname,card_status): Handle opt.with_colons.
[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   /* Note:  Make sure that there is no colon or linefeed in the string. */
121   switch (no)
122     {
123     case 0:
124     case 0xffff: return "test card";
125     case 0x0001: return "PPC Card Systems";
126     default: return "unknown";
127     }
128 }
129
130
131 static void
132 print_sha1_fpr (FILE *fp, const unsigned char *fpr)
133 {
134   int i;
135
136   if (fpr)
137     {
138       for (i=0; i < 20 ; i+=2, fpr += 2 )
139         {
140           if (i == 10 )
141             tty_fprintf (fp, " ");
142           tty_fprintf (fp, " %02X%02X", *fpr, fpr[1]);
143         }
144     }
145   else
146     tty_fprintf (fp, " [none]");
147   tty_fprintf (fp, "\n");
148 }
149
150
151 static void
152 print_sha1_fpr_colon (FILE *fp, const unsigned char *fpr)
153 {
154   int i;
155
156   if (fpr)
157     {
158       for (i=0; i < 20 ; i++, fpr++)
159         fprintf (fp, "%02X", *fpr);
160     }
161   putc (':', fp);
162 }
163
164
165 static void
166 print_name (FILE *fp, const char *text, const char *name)
167 {
168   tty_fprintf (fp, text);
169
170
171   /* FIXME: tty_printf_utf8_string2 eats everything after and
172      including an @ - e.g. when printing an url. */
173   if (name && *name)
174     {
175       if (fp)
176         print_utf8_string2 (fp, name, strlen (name), '\n');
177       else
178         tty_print_utf8_string2 (name, strlen (name), '\n');
179     }
180   else
181     tty_fprintf (fp, _("[not set]"));
182   tty_fprintf (fp, "\n");
183 }
184
185 static void
186 print_isoname (FILE *fp, const char *text, const char *tag, const char *name)
187 {
188   if (opt.with_colons)
189     fprintf (fp, "%s:", tag);
190   else
191     tty_fprintf (fp, text);
192
193   if (name && *name)
194     {
195       char *p, *given, *buf = xstrdup (name);
196
197       given = strstr (buf, "<<");
198       for (p=buf; *p; p++)
199         if (*p == '<')
200           *p = ' ';
201       if (given && given[2])
202         {
203           *given = 0;
204           given += 2;
205           if (opt.with_colons)
206             print_string (fp, given, strlen (given), ':');
207           else if (fp)
208             print_utf8_string2 (fp, given, strlen (given), '\n');
209           else
210             tty_print_utf8_string2 (given, strlen (given), '\n');
211
212           if (opt.with_colons)
213             putc (':', fp);
214           else if (*buf)
215             tty_fprintf (fp, " ");
216         }
217
218       if (opt.with_colons)
219         print_string (fp, buf, strlen (buf), ':');
220       else if (fp)
221         print_utf8_string2 (fp, buf, strlen (buf), '\n');
222       else
223         tty_print_utf8_string2 (buf, strlen (buf), '\n');
224       xfree (buf);
225     }
226   else
227     {
228       if (opt.with_colons)
229         putc (':', fp);
230       else
231         tty_fprintf (fp, _("[not set]"));
232     }
233
234   if (opt.with_colons)
235     fputs (":\n", fp);
236   else
237     tty_fprintf (fp, "\n");
238 }
239
240
241 /* Print all available information about the current card. */
242 void
243 card_status (FILE *fp)
244 {
245   struct agent_card_info_s info;
246   PKT_public_key *pk = xcalloc (1, sizeof *pk);
247   int rc;
248   unsigned int uval;
249
250   rc = agent_learn (&info);
251   if (rc)
252     {
253       if (opt.with_colons)
254         fputs ("AID:::\n", fp);
255       log_error (_("OpenPGP card not available: %s\n"),
256                   gpg_strerror (rc));
257       xfree (pk);
258       return;
259     }
260
261   if (opt.with_colons)
262     fprintf (fp, "AID:%s:", info.serialno? info.serialno : "");
263   else
264     tty_fprintf (fp, "Application ID ...: %s\n",
265                  info.serialno? info.serialno : "[none]");
266   if (!info.serialno || strncmp (info.serialno, "D27600012401", 12) 
267       || strlen (info.serialno) != 32 )
268     {
269       if (opt.with_colons)
270         fputs ("unknown:\n", fp);
271       log_info ("not an OpenPGP card\n");
272       agent_release_card_info (&info);
273       xfree (pk);
274       return;
275     }
276
277   if (opt.with_colons)
278     fputs ("openpgp-card:\n", fp);
279
280
281   if (opt.with_colons)
282     {
283       fprintf (fp, "version:%.4s:\n", info.serialno+12);
284       uval = xtoi_2(info.serialno+16)*256 + xtoi_2 (info.serialno+18);
285       fprintf (fp, "vendor:%04x:%s:\n", uval, get_manufacturer (uval));
286       fprintf (fp, "serial:%.8s:\n", info.serialno+20);
287       
288       print_isoname (fp, "Name of cardholder: ", "name", info.disp_name);
289
290       fputs ("lang:", fp);
291       if (info.disp_lang)
292         print_string (fp, info.disp_lang, strlen (info.disp_lang), ':');
293       fputs (":\n", fp);
294
295       fprintf (fp, "sex:%c:\n", (info.disp_sex == 1? 'm':
296                                  info.disp_sex == 2? 'f' : 'u'));
297
298       fputs ("url:", fp);
299       if (info.pubkey_url)
300         print_string (fp, info.pubkey_url, strlen (info.pubkey_url), ':');
301       fputs (":\n", fp);
302
303       fputs ("login:", fp);
304       if (info.login_data)
305         print_string (fp, info.login_data, strlen (info.login_data), ':');
306       fputs (":\n", fp);
307
308       fprintf (fp, "forcepin:%d:::\n", !info.chv1_cached);
309       fprintf (fp, "maxpinlen:%d:%d:%d:\n",
310                    info.chvmaxlen[0], info.chvmaxlen[1], info.chvmaxlen[2]);
311       fprintf (fp, "pinretry:%d:%d:%d:\n",
312                    info.chvretry[0], info.chvretry[1], info.chvretry[2]);
313       fprintf (fp, "sigcount:%lu:::\n", info.sig_counter);
314
315       fputs ("fpr:", fp);
316       print_sha1_fpr_colon (fp, info.fpr1valid? info.fpr1:NULL);
317       print_sha1_fpr_colon (fp, info.fpr2valid? info.fpr2:NULL);
318       print_sha1_fpr_colon (fp, info.fpr3valid? info.fpr3:NULL);
319       putc ('\n', fp);
320
321     }
322   else 
323     {
324       tty_fprintf (fp, "Version ..........: %.1s%c.%.1s%c\n",
325                    info.serialno[12] == '0'?"":info.serialno+12,
326                    info.serialno[13],
327                    info.serialno[14] == '0'?"":info.serialno+14,
328                    info.serialno[15]);
329       tty_fprintf (fp, "Manufacturer .....: %s\n", 
330                    get_manufacturer (xtoi_2(info.serialno+16)*256
331                                      + xtoi_2 (info.serialno+18)));
332       tty_fprintf (fp, "Serial number ....: %.8s\n", info.serialno+20);
333       
334       print_isoname (fp, "Name of cardholder: ", "name", info.disp_name);
335       print_name (fp, "Language prefs ...: ", info.disp_lang);
336       tty_fprintf (fp,    "Sex ..............: %s\n",
337                    info.disp_sex == 1? _("male"):
338                    info.disp_sex == 2? _("female") : _("unspecified"));
339       print_name (fp, "URL of public key : ", info.pubkey_url);
340       print_name (fp, "Login data .......: ", info.login_data);
341       tty_fprintf (fp,    "Signature PIN ....: %s\n",
342                    info.chv1_cached? _("cached"): _("not cached"));
343       tty_fprintf (fp,    "Max. PIN lengths .: %d %d %d\n",
344                    info.chvmaxlen[0], info.chvmaxlen[1], info.chvmaxlen[2]);
345       tty_fprintf (fp,    "PIN retry counter : %d %d %d\n",
346                    info.chvretry[0], info.chvretry[1], info.chvretry[2]);
347       tty_fprintf (fp,    "Signature counter : %lu\n", info.sig_counter);
348       tty_fprintf (fp, "Signature key ....:");
349       print_sha1_fpr (fp, info.fpr1valid? info.fpr1:NULL);
350       tty_fprintf (fp, "Encryption key....:");
351       print_sha1_fpr (fp, info.fpr2valid? info.fpr2:NULL);
352       tty_fprintf (fp, "Authentication key:");
353       print_sha1_fpr (fp, info.fpr3valid? info.fpr3:NULL);
354       tty_fprintf (fp, "General key info..: "); 
355       if (info.fpr1valid && !get_pubkey_byfprint (pk, info.fpr1, 20))
356         print_pubkey_info (fp, pk);
357       else
358         fputs ("[none]\n", fp);
359     }
360       
361   free_public_key (pk);
362   agent_release_card_info (&info);
363 }
364
365
366 static char *
367 get_one_name (const char *prompt1, const char *prompt2)
368 {
369   char *name;
370   int i;
371
372   for (;;)
373     {
374       name = cpr_get (prompt1, prompt2);
375       if (!name)
376         return NULL;
377       trim_spaces (name);
378       cpr_kill_prompt ();
379       for (i=0; name[i] && name[i] >= ' ' && name[i] <= 126; i++)
380         ;
381
382       /* The name must be in Latin-1 and not UTF-8 - lacking the code
383          to ensure this we restrict it to ASCII. */
384       if (name[i])
385         tty_printf (_("Error: Only plain ASCII is currently allowed.\n"));
386       else if (strchr (name, '<'))
387         tty_printf (_("Error: The \"<\" character may not be used.\n"));
388       else if (strstr (name, "  "))
389         tty_printf (_("Error: Double spaces are not allowed.\n"));    
390       else
391         return name;
392       xfree (name);
393     }
394 }
395
396
397
398 static int
399 change_name (void)
400 {
401   char *surname = NULL, *givenname = NULL;
402   char *isoname, *p;
403   int rc;
404
405   surname = get_one_name ("keygen.smartcard.surname",
406                                     _("Cardholder's surname: "));
407   givenname = get_one_name ("keygen.smartcard.givenname",
408                                        _("Cardholder's given name: "));
409   if (!surname || !givenname || (!*surname && !*givenname))
410     {
411       xfree (surname);
412       xfree (givenname);
413       return -1; /*canceled*/
414     }
415
416   isoname = xmalloc ( strlen (surname) + 2 + strlen (givenname) + 1);
417   strcpy (stpcpy (stpcpy (isoname, surname), "<<"), givenname);
418   xfree (surname);
419   xfree (givenname);
420   for (p=isoname; *p; p++)
421     if (*p == ' ')
422       *p = '<';
423
424   log_debug ("setting Name to `%s'\n", isoname);
425   rc = agent_scd_setattr ("DISP-NAME", isoname, strlen (isoname) );
426   if (rc)
427     log_error ("error setting Name: %s\n", gpg_strerror (rc));
428
429   xfree (isoname);
430   return rc;
431 }
432
433
434 static int
435 change_url (void)
436 {
437   char *url;
438   int rc;
439
440   url = cpr_get ("cardedit.change_url", _("URL to retrieve public key: "));
441   if (!url)
442     return -1;
443   trim_spaces (url);
444   cpr_kill_prompt ();
445
446   rc = agent_scd_setattr ("PUBKEY-URL", url, strlen (url) );
447   if (rc)
448     log_error ("error setting URL: %s\n", gpg_strerror (rc));
449   xfree (url);
450   return rc;
451 }
452
453 static int
454 change_login (void)
455 {
456   char *data;
457   int rc;
458
459   data = cpr_get ("cardedit.change_login",
460                   _("Login data (account name): "));
461   if (!data)
462     return -1;
463   trim_spaces (data);
464   cpr_kill_prompt ();
465
466   rc = agent_scd_setattr ("LOGIN-DATA", data, strlen (data) );
467   if (rc)
468     log_error ("error setting login data: %s\n", gpg_strerror (rc));
469   xfree (data);
470   return rc;
471 }
472
473 static int
474 change_lang (void)
475 {
476   char *data, *p;
477   int rc;
478
479   data = cpr_get ("cardedit.change_lang",
480                   _("Language preferences: "));
481   if (!data)
482     return -1;
483   trim_spaces (data);
484   cpr_kill_prompt ();
485
486   if (strlen (data) > 8 || (strlen (data) & 1))
487     {
488       tty_printf (_("Error: invalid length of preference string.\n"));
489       xfree (data);
490       return -1;
491     }
492
493   for (p=data; *p && *p >= 'a' && *p <= 'z'; p++)
494     ;
495   if (*p)
496     {
497       tty_printf (_("Error: invalid characters in preference string.\n"));
498       xfree (data);
499       return -1;
500     }
501
502   rc = agent_scd_setattr ("DISP-LANG", data, strlen (data) );
503   if (rc)
504     log_error ("error setting lang: %s\n", gpg_strerror (rc));
505   xfree (data);
506   return rc;
507 }
508
509
510 static int
511 change_sex (void)
512 {
513   char *data;
514   const char *str;
515   int rc;
516
517   data = cpr_get ("cardedit.change_sex",
518                   _("Sex ((M)ale, (F)emale or space): "));
519   if (!data)
520     return -1;
521   trim_spaces (data);
522   cpr_kill_prompt ();
523
524   if (!*data)
525     str = "9";
526   else if ((*data == 'M' || *data == 'm') && !data[1])
527     str = "1";
528   else if ((*data == 'F' || *data == 'f') && !data[1])
529     str = "2";
530   else 
531     {
532       tty_printf (_("Error: invalid response.\n"));
533       xfree (data);
534       return -1;
535     }
536      
537   rc = agent_scd_setattr ("DISP-SEX", str, 1 );
538   if (rc)
539     log_error ("error setting sex: %s\n", gpg_strerror (rc));
540   xfree (data);
541   return rc;
542 }
543
544
545 /* Menu to edit all user changeable values on an OpenPGP card.  Only
546    Key creation is not handled here. */
547 void
548 card_edit (STRLIST commands)
549 {
550   enum cmdids {
551     cmdNOP = 0,
552     cmdQUIT, cmdHELP, cmdLIST, cmdDEBUG,
553     cmdNAME, cmdURL, cmdLOGIN, cmdLANG, cmdSEX,
554
555     cmdINVCMD
556   };
557
558   static struct {
559     const char *name;
560     enum cmdids id;
561     const char *desc;
562   } cmds[] = {
563     { N_("quit")  , cmdQUIT  , N_("quit this menu") },
564     { N_("q")     , cmdQUIT  , NULL   },
565     { N_("help")  , cmdHELP  , N_("show this help") },
566     {    "?"      , cmdHELP  , NULL   },
567     { N_("list")  , cmdLIST  , N_("list all available data") },
568     { N_("l")     , cmdLIST  , NULL   },
569     { N_("debug") , cmdDEBUG , NULL },
570     { N_("name")  , cmdNAME  , N_("change card holder's name") },
571     { N_("url")   , cmdURL   , N_("change URL to retrieve key") },
572     { N_("login") , cmdLOGIN , N_("change the login name") },
573     { N_("lang")  , cmdLANG  , N_("change the language preferences") },
574     { N_("sex")   , cmdSEX   , N_("change card holder's sex") },
575     { NULL, cmdINVCMD } 
576   };
577
578   enum cmdids cmd = cmdNOP;
579   int have_commands = !!commands;
580   int redisplay = 1;
581   char *answer = NULL;
582
583   if (opt.command_fd != -1)
584     ;
585   else if (opt.batch && !have_commands)
586     {
587       log_error(_("can't do that in batchmode\n"));
588       goto leave;
589     }
590
591   for (;;)
592     {
593       int arg_number;
594       const char *arg_string = "";
595       char *p;
596       int i;
597
598       tty_printf("\n");
599       if (redisplay )
600         {
601           if (opt.with_colons)
602             {
603               card_status (stdout);
604               fflush (stdout);
605             }
606           else
607             {
608               card_status (NULL);
609               tty_printf("\n");
610             }
611           redisplay = 0;
612         }
613
614       do
615         {
616           xfree (answer);
617           if (have_commands)
618             {
619               if (commands)
620                 {
621                   answer = xstrdup (commands->d);
622                   commands = commands->next;
623                 }
624               else if (opt.batch)
625                 {
626                   answer = xstrdup ("quit");
627                 }
628               else
629                 have_commands = 0;
630             }
631
632             if (!have_commands)
633               {
634                 answer = cpr_get_no_help("cardedit.prompt", _("Command> "));
635                 cpr_kill_prompt();
636             }
637             trim_spaces(answer);
638         }
639       while( *answer == '#' );
640
641       arg_number = 0; /* Yes, here is the init which egcc complains about */
642       if (!*answer)
643         cmd = cmdLIST; /* Default to the list command */
644       else if (*answer == CONTROL_D)
645         cmd = cmdQUIT;
646       else {
647         if ((p=strchr (answer,' ')))
648           {
649             *p++ = 0;
650             trim_spaces (answer);
651             trim_spaces (p);
652             arg_number = atoi(p);
653             arg_string = p;
654           }
655
656         for (i=0; cmds[i].name; i++ )
657           if (!ascii_strcasecmp (answer, cmds[i].name ))
658             break;
659
660         cmd = cmds[i].id;
661       }
662
663       switch (cmd)
664         {
665         case cmdHELP:
666           for (i=0; cmds[i].name; i++ )
667             if (cmds[i].desc)
668               tty_printf("%-10s %s\n", cmds[i].name, _(cmds[i].desc) );
669           break;
670
671         case cmdLIST:
672           redisplay = 1;
673           break;
674
675         case cmdNAME:
676           change_name ();
677           break;
678
679         case cmdURL:
680           change_url ();
681           break;
682
683         case cmdLOGIN:
684           change_login ();
685           break;
686
687         case cmdLANG:
688           change_lang ();
689           break;
690
691         case cmdSEX:
692           change_sex ();
693           break;
694
695         case cmdQUIT:
696           goto leave;
697
698         case cmdNOP:
699           break;
700
701         case cmdINVCMD:
702         default:
703           tty_printf ("\n");
704           tty_printf (_("Invalid command  (try \"help\")\n"));
705           break;
706         } /* End command switch. */
707     } /* End of main menu loop. */
708
709  leave:
710   xfree (answer);
711 }
712