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