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