f02601fc43ea8d95b8ff961ba46293ad32497df7
[gnupg.git] / g10 / misc.c
1 /* misc.c - miscellaneous functions
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
3  *               2005, 2006, 2007 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <unistd.h>
26 #include <errno.h>
27 #if defined(__linux__) && defined(__alpha__) && __GLIBC__ < 2
28 #include <asm/sysinfo.h>
29 #include <asm/unistd.h>
30 #endif
31 #ifdef HAVE_SETRLIMIT
32 #include <time.h>
33 #include <sys/time.h>
34 #include <sys/resource.h>
35 #endif
36 #ifdef ENABLE_SELINUX_HACKS
37 #include <sys/stat.h>
38 #endif
39
40 #ifdef HAVE_W32_SYSTEM
41 #include <time.h>
42 #include <process.h>
43 #include <windows.h> 
44 #include <shlobj.h>
45 #ifndef CSIDL_APPDATA
46 #define CSIDL_APPDATA 0x001a
47 #endif
48 #ifndef CSIDL_LOCAL_APPDATA
49 #define CSIDL_LOCAL_APPDATA 0x001c
50 #endif
51 #ifndef CSIDL_FLAG_CREATE
52 #define CSIDL_FLAG_CREATE 0x8000
53 #endif
54 #endif /*HAVE_W32_SYSTEM*/
55
56 #include "gpg.h"
57 #ifdef HAVE_W32_SYSTEM
58 # include "status.h"
59 #endif /*HAVE_W32_SYSTEM*/
60 #include "util.h"
61 #include "main.h"
62 #include "photoid.h"
63 #include "options.h"
64 #include "call-agent.h"
65 #include "i18n.h"
66
67
68 static int
69 string_count_chr (const char *string, int c)
70 {
71   int count;
72
73   for (count=0; *string; string++ )
74     if ( *string == c )
75       count++;
76   return count;
77 }
78
79
80
81 #ifdef ENABLE_SELINUX_HACKS
82 /* A object and a global variable to keep track of files marked as
83    secured. */
84 struct secured_file_item 
85 {
86   struct secured_file_item *next;
87   ino_t ino;
88   dev_t dev;
89 };
90 static struct secured_file_item *secured_files;
91 #endif /*ENABLE_SELINUX_HACKS*/
92
93
94
95
96 /* For the sake of SELinux we want to restrict access through gpg to
97    certain files we keep under our own control.  This function
98    registers such a file and is_secured_file may then be used to
99    check whether a file has ben registered as secured. */
100 void
101 register_secured_file (const char *fname)
102 {
103 #ifdef ENABLE_SELINUX_HACKS
104   struct stat buf;
105   struct secured_file_item *sf;
106
107   /* Note that we stop immediatley if something goes wrong here. */
108   if (stat (fname, &buf))
109     log_fatal (_("fstat of `%s' failed in %s: %s\n"), fname, 
110                "register_secured_file", strerror (errno));
111 /*   log_debug ("registering `%s' i=%lu.%lu\n", fname, */
112 /*              (unsigned long)buf.st_dev, (unsigned long)buf.st_ino); */
113   for (sf=secured_files; sf; sf = sf->next)
114     {
115       if (sf->ino == buf.st_ino && sf->dev == buf.st_dev)
116         return; /* Already registered.  */
117     }
118
119   sf = xmalloc (sizeof *sf);
120   sf->ino = buf.st_ino;
121   sf->dev = buf.st_dev;
122   sf->next = secured_files;
123   secured_files = sf;
124 #endif /*ENABLE_SELINUX_HACKS*/
125 }
126
127 /* Remove a file registered as secure. */
128 void
129 unregister_secured_file (const char *fname)
130 {
131 #ifdef ENABLE_SELINUX_HACKS
132   struct stat buf;
133   struct secured_file_item *sf, *sfprev;
134
135   if (stat (fname, &buf))
136     {
137       log_error (_("fstat of `%s' failed in %s: %s\n"), fname,
138                  "unregister_secured_file", strerror (errno));
139       return;
140     }
141 /*   log_debug ("unregistering `%s' i=%lu.%lu\n", fname,  */
142 /*              (unsigned long)buf.st_dev, (unsigned long)buf.st_ino); */
143   for (sfprev=NULL,sf=secured_files; sf; sfprev=sf, sf = sf->next)
144     {
145       if (sf->ino == buf.st_ino && sf->dev == buf.st_dev)
146         {
147           if (sfprev)
148             sfprev->next = sf->next;
149           else
150             secured_files = sf->next;
151           xfree (sf);
152           return;
153         }
154     }
155 #endif /*ENABLE_SELINUX_HACKS*/
156 }
157
158 /* Return true if FD is corresponds to a secured file.  Using -1 for
159    FS is allowed and will return false. */ 
160 int 
161 is_secured_file (int fd)
162 {
163 #ifdef ENABLE_SELINUX_HACKS
164   struct stat buf;
165   struct secured_file_item *sf;
166
167   if (fd == -1)
168     return 0; /* No file descriptor so it can't be secured either.  */
169
170   /* Note that we print out a error here and claim that a file is
171      secure if something went wrong. */
172   if (fstat (fd, &buf))
173     {
174       log_error (_("fstat(%d) failed in %s: %s\n"), fd, 
175                  "is_secured_file", strerror (errno));
176       return 1;
177     }
178 /*   log_debug ("is_secured_file (%d) i=%lu.%lu\n", fd, */
179 /*              (unsigned long)buf.st_dev, (unsigned long)buf.st_ino); */
180   for (sf=secured_files; sf; sf = sf->next)
181     {
182       if (sf->ino == buf.st_ino && sf->dev == buf.st_dev)
183         return 1; /* Yes.  */
184     }
185 #endif /*ENABLE_SELINUX_HACKS*/
186   return 0; /* No. */
187 }
188
189 /* Return true if FNAME is corresponds to a secured file.  Using NULL,
190    "" or "-" for FS is allowed and will return false. This function is
191    used before creating a file, thus it won't fail if the file does
192    not exist. */ 
193 int 
194 is_secured_filename (const char *fname)
195 {
196 #ifdef ENABLE_SELINUX_HACKS
197   struct stat buf;
198   struct secured_file_item *sf;
199
200   if (iobuf_is_pipe_filename (fname) || !*fname)
201     return 0; 
202
203   /* Note that we print out a error here and claim that a file is
204      secure if something went wrong. */
205   if (stat (fname, &buf))
206     {
207       if (errno == ENOENT || errno == EPERM || errno == EACCES)
208         return 0;
209       log_error (_("fstat of `%s' failed in %s: %s\n"), fname,
210                  "is_secured_filename", strerror (errno));
211       return 1;
212     }
213 /*   log_debug ("is_secured_filename (%s) i=%lu.%lu\n", fname, */
214 /*              (unsigned long)buf.st_dev, (unsigned long)buf.st_ino); */
215   for (sf=secured_files; sf; sf = sf->next)
216     {
217       if (sf->ino == buf.st_ino && sf->dev == buf.st_dev)
218         return 1; /* Yes.  */
219     }
220 #endif /*ENABLE_SELINUX_HACKS*/
221   return 0; /* No. */
222 }
223
224
225
226 u16
227 checksum_u16( unsigned n )
228 {
229     u16 a;
230
231     a  = (n >> 8) & 0xff;
232     a += n & 0xff;
233     return a;
234 }
235
236
237 u16
238 checksum( byte *p, unsigned n )
239 {
240     u16 a;
241
242     for(a=0; n; n-- )
243         a += *p++;
244     return a;
245 }
246
247 u16
248 checksum_mpi (gcry_mpi_t a)
249 {
250   u16 csum;
251   byte *buffer;
252   size_t nbytes;
253
254   if ( gcry_mpi_print (GCRYMPI_FMT_PGP, NULL, 0, &nbytes, a) )
255     BUG ();
256   /* Fixme: For numbers not in secure memory we should use a stack
257    * based buffer and only allocate a larger one if mpi_print returns
258    * an error. */
259   buffer = (gcry_is_secure(a)?
260             gcry_xmalloc_secure (nbytes) : gcry_xmalloc (nbytes));
261   if ( gcry_mpi_print (GCRYMPI_FMT_PGP, buffer, nbytes, NULL, a) )
262     BUG ();
263   csum = checksum (buffer, nbytes);
264   xfree (buffer);
265   return csum;
266 }
267
268 u32
269 buffer_to_u32( const byte *buffer )
270 {
271     unsigned long a;
272     a =  *buffer << 24;
273     a |= buffer[1] << 16;
274     a |= buffer[2] << 8;
275     a |= buffer[3];
276     return a;
277 }
278
279 void
280 print_pubkey_algo_note( int algo )
281 {
282   if(algo >= 100 && algo <= 110)
283     {
284       static int warn=0;
285       if(!warn)
286         {
287           warn=1;
288           log_info (_("WARNING: using experimental public key algorithm %s\n"),
289                     gcry_pk_algo_name (algo));
290         }
291     }
292 }
293
294 void
295 print_cipher_algo_note( int algo )
296 {
297   if(algo >= 100 && algo <= 110)
298     {
299       static int warn=0;
300       if(!warn)
301         {
302           warn=1;
303           log_info (_("WARNING: using experimental cipher algorithm %s\n"),
304                     gcry_cipher_algo_name (algo));
305         }
306     }
307 }
308
309 void
310 print_digest_algo_note( int algo )
311 {
312   if(algo >= 100 && algo <= 110)
313     {
314       static int warn=0;
315       if(!warn)
316         {
317           warn=1;
318           log_info (_("WARNING: using experimental digest algorithm %s\n"),
319                     gcry_md_algo_name (algo));
320         }
321     }
322   else if(algo==DIGEST_ALGO_MD5)
323     log_info (_("WARNING: digest algorithm %s is deprecated\n"),
324               gcry_md_algo_name (algo));
325 }
326
327 /****************
328  * Wrapper around the libgcrypt function with additonal checks on
329  * the OpenPGP contraints for the algo ID.
330  */
331 int
332 openpgp_cipher_test_algo( int algo )
333 {
334   /* 5 and 6 are marked reserved by rfc2440bis.  */
335   if ( algo < 0 || algo > 110 || algo == 5 || algo == 6 )
336     return gpg_error (GPG_ERR_CIPHER_ALGO);
337   return gcry_cipher_test_algo (algo);
338 }
339
340 int
341 openpgp_pk_test_algo( int algo )
342 {
343   if (algo == GCRY_PK_ELG_E)
344     algo = GCRY_PK_ELG;
345
346   if (algo < 0 || algo > 110)
347     return gpg_error (GPG_ERR_PUBKEY_ALGO);
348   return gcry_pk_test_algo (algo);
349 }
350
351 int
352 openpgp_pk_test_algo2( int algo, unsigned int use )
353 {
354   size_t use_buf = use;
355
356   if (algo == GCRY_PK_ELG_E)
357     algo = GCRY_PK_ELG;
358
359   if (algo < 0 || algo > 110)
360     return gpg_error (GPG_ERR_PUBKEY_ALGO);
361
362   return gcry_pk_algo_info (algo, GCRYCTL_TEST_ALGO, NULL, &use_buf);
363 }
364
365 int 
366 openpgp_pk_algo_usage ( int algo )
367 {
368     int use = 0; 
369     
370     /* They are hardwired in gpg 1.0. */
371     switch ( algo ) {    
372       case PUBKEY_ALGO_RSA:
373           use = (PUBKEY_USAGE_CERT | PUBKEY_USAGE_SIG
374                  | PUBKEY_USAGE_ENC | PUBKEY_USAGE_AUTH);
375           break;
376       case PUBKEY_ALGO_RSA_E:
377           use = PUBKEY_USAGE_ENC;
378           break;
379       case PUBKEY_ALGO_RSA_S:
380           use = PUBKEY_USAGE_CERT | PUBKEY_USAGE_SIG;
381           break;
382       case PUBKEY_ALGO_ELGAMAL_E:
383           use = PUBKEY_USAGE_ENC;
384           break;
385       case PUBKEY_ALGO_DSA:  
386           use = PUBKEY_USAGE_CERT | PUBKEY_USAGE_SIG | PUBKEY_USAGE_AUTH;
387           break;
388       default:
389           break;
390     }
391     return use;
392 }
393
394 int
395 openpgp_md_test_algo( int algo )
396 {
397   /* Note: If the list of actual supported OpenPGP algorithms changes,
398      make sure that our hard coded values at
399      print_status_begin_signing() gets updated. */
400   /* 4, 5, 6, 7 are defined by rfc2440 but will be removed from the
401      next revision of the standard.  */
402   if (algo < 0 || algo > 110 || (algo >= 4 && algo <= 7))
403     return gpg_error (GPG_ERR_DIGEST_ALGO);
404   return gcry_md_test_algo (algo);
405 }
406
407 #ifdef USE_IDEA
408 /* Special warning for the IDEA cipher */
409 void
410 idea_cipher_warn(int show)
411 {
412   static int warned=0;
413
414   if(!warned || show)
415     {
416       log_info(_("the IDEA cipher plugin is not present\n"));
417       log_info(_("please see %s for more information\n"),
418                "http://www.gnupg.org/faq/why-not-idea.html");
419       warned=1;
420     }
421 }
422 #endif
423
424
425 static unsigned long 
426 get_signature_count (PKT_secret_key *sk)
427 {
428 #ifdef ENABLE_CARD_SUPPORT
429   if(sk && sk->is_protected && sk->protect.s2k.mode==1002)
430     {
431       struct agent_card_info_s info;
432       if(agent_scd_getattr("SIG-COUNTER",&info)==0)
433         return info.sig_counter;
434     }  
435 #endif
436
437   /* How to do this without a card? */
438
439   return 0;
440 }
441
442 /* Expand %-strings.  Returns a string which must be xfreed.  Returns
443    NULL if the string cannot be expanded (too large). */
444 char *
445 pct_expando(const char *string,struct expando_args *args)
446 {
447   const char *ch=string;
448   int idx=0,maxlen=0,done=0;
449   u32 pk_keyid[2]={0,0},sk_keyid[2]={0,0};
450   char *ret=NULL;
451
452   if(args->pk)
453     keyid_from_pk(args->pk,pk_keyid);
454
455   if(args->sk)
456     keyid_from_sk(args->sk,sk_keyid);
457
458   /* This is used so that %k works in photoid command strings in
459      --list-secret-keys (which of course has a sk, but no pk). */
460   if(!args->pk && args->sk)
461     keyid_from_sk(args->sk,pk_keyid);
462
463   while(*ch!='\0')
464     {
465       char *str=NULL;
466
467       if(!done)
468         {
469           /* 8192 is way bigger than we'll need here */
470           if(maxlen>=8192)
471             goto fail;
472
473           maxlen+=1024;
474           ret=xrealloc(ret,maxlen);
475         }
476
477       done=0;
478
479       if(*ch=='%')
480         {
481           switch(*(ch+1))
482             {
483             case 's': /* short key id */
484               if(idx+8<maxlen)
485                 {
486                   sprintf(&ret[idx],"%08lX",(ulong)sk_keyid[1]);
487                   idx+=8;
488                   done=1;
489                 }
490               break;
491
492             case 'S': /* long key id */
493               if(idx+16<maxlen)
494                 {
495                   sprintf(&ret[idx],"%08lX%08lX",
496                           (ulong)sk_keyid[0],(ulong)sk_keyid[1]);
497                   idx+=16;
498                   done=1;
499                 }
500               break;
501
502             case 'k': /* short key id */
503               if(idx+8<maxlen)
504                 {
505                   sprintf(&ret[idx],"%08lX",(ulong)pk_keyid[1]);
506                   idx+=8;
507                   done=1;
508                 }
509               break;
510
511             case 'K': /* long key id */
512               if(idx+16<maxlen)
513                 {
514                   sprintf(&ret[idx],"%08lX%08lX",
515                           (ulong)pk_keyid[0],(ulong)pk_keyid[1]);
516                   idx+=16;
517                   done=1;
518                 }
519               break;
520
521             case 'c': /* signature count from card, if any. */
522               if(idx+10<maxlen)
523                 {
524                   sprintf(&ret[idx],"%lu",get_signature_count(args->sk));
525                   idx+=strlen(&ret[idx]);
526                   done=1;
527                 }             
528               break;
529
530             case 'p': /* primary pk fingerprint of a sk */
531             case 'f': /* pk fingerprint */
532             case 'g': /* sk fingerprint */
533               {
534                 byte array[MAX_FINGERPRINT_LEN];
535                 size_t len;
536                 int i;
537
538                 if((*(ch+1))=='p' && args->sk)
539                   {
540                     if(args->sk->is_primary)
541                       fingerprint_from_sk(args->sk,array,&len);
542                     else if(args->sk->main_keyid[0] || args->sk->main_keyid[1])
543                       {
544                         PKT_public_key *pk=
545                           xmalloc_clear(sizeof(PKT_public_key));
546
547                         if(get_pubkey_fast(pk,args->sk->main_keyid)==0)
548                           fingerprint_from_pk(pk,array,&len);
549                         else
550                           memset(array,0,(len=MAX_FINGERPRINT_LEN));
551                         free_public_key(pk);
552                       }
553                     else
554                       memset(array,0,(len=MAX_FINGERPRINT_LEN));
555                   }
556                 else if((*(ch+1))=='f' && args->pk)
557                   fingerprint_from_pk(args->pk,array,&len);
558                 else if((*(ch+1))=='g' && args->sk)
559                   fingerprint_from_sk(args->sk,array,&len);
560                 else
561                   memset(array,0,(len=MAX_FINGERPRINT_LEN));
562
563                 if(idx+(len*2)<maxlen)
564                   {
565                     for(i=0;i<len;i++)
566                       {
567                         sprintf(&ret[idx],"%02X",array[i]);
568                         idx+=2;
569                       }
570                     done=1;
571                   }
572               }
573               break;
574
575             case 't': /* e.g. "jpg" */
576               str=image_type_to_string(args->imagetype,0);
577               /* fall through */
578
579             case 'T': /* e.g. "image/jpeg" */
580               if(str==NULL)
581                 str=image_type_to_string(args->imagetype,2);
582
583               if(idx+strlen(str)<maxlen)
584                 {
585                   strcpy(&ret[idx],str);
586                   idx+=strlen(str);
587                   done=1;
588                 }
589               break;
590
591             case '%':
592               if(idx+1<maxlen)
593                 {
594                   ret[idx++]='%';
595                   ret[idx]='\0';
596                   done=1;
597                 }
598               break;
599
600               /* Any unknown %-keys (like %i, %o, %I, and %O) are
601                  passed through for later expansion.  Note this also
602                  handles the case where the last character in the
603                  string is a '%' - the terminating \0 will end up here
604                  and properly terminate the string. */
605             default:
606               if(idx+2<maxlen)
607                 {
608                   ret[idx++]='%';
609                   ret[idx++]=*(ch+1);
610                   ret[idx]='\0';
611                   done=1;
612                 }
613               break;
614               }
615
616           if(done)
617             ch++;
618         }
619       else
620         {
621           if(idx+1<maxlen)
622             {
623               ret[idx++]=*ch;
624               ret[idx]='\0';
625               done=1;
626             }
627         }
628
629       if(done)
630         ch++;
631     }
632
633   return ret;
634
635  fail:
636   xfree(ret);
637   return NULL;
638 }
639
640 void
641 deprecated_warning(const char *configname,unsigned int configlineno,
642                    const char *option,const char *repl1,const char *repl2)
643 {
644   if(configname)
645     {
646       if(strncmp("--",option,2)==0)
647         option+=2;
648
649       if(strncmp("--",repl1,2)==0)
650         repl1+=2;
651
652       log_info(_("%s:%d: deprecated option \"%s\"\n"),
653                configname,configlineno,option);
654     }
655   else
656     log_info(_("WARNING: \"%s\" is a deprecated option\n"),option);
657
658   log_info(_("please use \"%s%s\" instead\n"),repl1,repl2);
659 }
660
661
662 void
663 deprecated_command (const char *name)
664 {
665   log_info(_("WARNING: \"%s\" is a deprecated command - do not use it\n"),
666            name);
667 }
668
669
670 void
671 obsolete_option (const char *configname, unsigned int configlineno, 
672                  const char *name)
673 {
674   if(configname)
675     log_info (_("%s:%u: obsolete option \"%s\" - it has no effect\n"),
676               configname, configlineno, name);
677   else
678     log_info (_("WARNING: \"%s\" is an obsolete option - it has no effect\n"),
679               name);
680 }
681
682
683 /*
684  * Wrapper around gcry_cipher_map_name to provide a fallback using the
685  * "Sn" syntax as used by the preference strings.
686  */
687 int 
688 string_to_cipher_algo (const char *string) 
689
690   int val;
691
692   val = gcry_cipher_map_name (string);
693   if (!val && string && (string[0]=='S' || string[0]=='s'))
694     {
695       char *endptr;
696
697       string++;
698       val = strtol (string, &endptr, 10);
699       if (!*string || *endptr || openpgp_cipher_test_algo (val))
700         val = 0;
701     }
702
703   return val;
704 }
705
706 /*
707  * Wrapper around gcry_md_map_name to provide a fallback using the
708  * "Hn" syntax as used by the preference strings.
709  */
710 int 
711 string_to_digest_algo (const char *string) 
712
713   int val;
714
715   val = gcry_md_map_name (string);
716   if (!val && string && (string[0]=='H' || string[0]=='h'))
717     {
718       char *endptr;
719
720       string++;
721       val = strtol (string, &endptr, 10);
722       if (!*string || *endptr || openpgp_md_test_algo (val))
723         val = 0;
724     }
725
726   return val;
727 }
728
729
730
731 const char *
732 compress_algo_to_string(int algo)
733 {
734   const char *s=NULL;
735
736   switch(algo)
737     {
738     case COMPRESS_ALGO_NONE:
739       s=_("Uncompressed");
740       break;
741
742     case COMPRESS_ALGO_ZIP:
743       s="ZIP";
744       break;
745
746     case COMPRESS_ALGO_ZLIB:
747       s="ZLIB";
748       break;
749
750 #ifdef HAVE_BZIP2
751     case COMPRESS_ALGO_BZIP2:
752       s="BZIP2";
753       break;
754 #endif
755     }
756
757   return s;
758 }
759
760 int
761 string_to_compress_algo(const char *string)
762 {
763   /* TRANSLATORS: See doc/TRANSLATE about this string. */
764   if(match_multistr(_("uncompressed|none"),string))
765     return 0;
766   else if(ascii_strcasecmp(string,"uncompressed")==0)
767     return 0;
768   else if(ascii_strcasecmp(string,"none")==0)
769     return 0;
770   else if(ascii_strcasecmp(string,"zip")==0)
771     return 1;
772   else if(ascii_strcasecmp(string,"zlib")==0)
773     return 2;
774 #ifdef HAVE_BZIP2
775   else if(ascii_strcasecmp(string,"bzip2")==0)
776     return 3;
777 #endif
778   else if(ascii_strcasecmp(string,"z0")==0)
779     return 0;
780   else if(ascii_strcasecmp(string,"z1")==0)
781     return 1;
782   else if(ascii_strcasecmp(string,"z2")==0)
783     return 2;
784 #ifdef HAVE_BZIP2
785   else if(ascii_strcasecmp(string,"z3")==0)
786     return 3;
787 #endif
788   else
789     return -1;
790 }
791
792 int
793 check_compress_algo(int algo)
794 {
795 #ifdef HAVE_BZIP2
796   if(algo>=0 && algo<=3)
797     return 0;
798 #else
799   if(algo>=0 && algo<=2)
800     return 0;
801 #endif
802
803   return G10ERR_COMPR_ALGO;
804 }
805
806 int
807 default_cipher_algo(void)
808 {
809   if(opt.def_cipher_algo)
810     return opt.def_cipher_algo;
811   else if(opt.personal_cipher_prefs)
812     return opt.personal_cipher_prefs[0].value;
813   else
814     return opt.s2k_cipher_algo;
815 }
816
817 /* There is no default_digest_algo function, but see
818    sign.c:hash_for() */
819
820 int
821 default_compress_algo(void)
822 {
823   if(opt.compress_algo!=-1)
824     return opt.compress_algo;
825   else if(opt.personal_compress_prefs)
826     return opt.personal_compress_prefs[0].value;
827   else
828     return DEFAULT_COMPRESS_ALGO;
829 }
830
831 const char *
832 compliance_option_string(void)
833 {
834   char *ver="???";
835
836   switch(opt.compliance)
837     {
838     case CO_GNUPG:   return "--gnupg";
839     case CO_RFC4880: return "--openpgp";
840     case CO_RFC2440: return "--rfc2440";
841     case CO_RFC1991: return "--rfc1991";
842     case CO_PGP2:    return "--pgp2";
843     case CO_PGP6:    return "--pgp6";
844     case CO_PGP7:    return "--pgp7";
845     case CO_PGP8:    return "--pgp8";
846     }
847
848   return ver;
849 }
850
851 void
852 compliance_failure(void)
853 {
854   char *ver="???";
855
856   switch(opt.compliance)
857     {
858     case CO_GNUPG:
859       ver="GnuPG";
860       break;
861
862     case CO_RFC4880:
863       ver="OpenPGP";
864       break;
865
866     case CO_RFC2440:
867       ver="OpenPGP (older)";
868       break;
869
870     case CO_RFC1991:
871       ver="old PGP";
872       break;
873
874     case CO_PGP2:
875       ver="PGP 2.x";
876       break;
877
878     case CO_PGP6:
879       ver="PGP 6.x";
880       break;
881
882     case CO_PGP7:
883       ver="PGP 7.x";
884       break;
885
886     case CO_PGP8:
887       ver="PGP 8.x";
888       break;
889     }
890
891   log_info(_("this message may not be usable by %s\n"),ver);
892   opt.compliance=CO_GNUPG;
893 }
894
895 /* Break a string into successive option pieces.  Accepts single word
896    options and key=value argument options. */
897 char *
898 optsep(char **stringp)
899 {
900   char *tok,*end;
901
902   tok=*stringp;
903   if(tok)
904     {
905       end=strpbrk(tok," ,=");
906       if(end)
907         {
908           int sawequals=0;
909           char *ptr=end;
910
911           /* what we need to do now is scan along starting with *end,
912              If the next character we see (ignoring spaces) is an =
913              sign, then there is an argument. */
914
915           while(*ptr)
916             {
917               if(*ptr=='=')
918                 sawequals=1;
919               else if(*ptr!=' ')
920                 break;
921               ptr++;
922             }
923
924           /* There is an argument, so grab that too.  At this point,
925              ptr points to the first character of the argument. */
926           if(sawequals)
927             {
928               /* Is it a quoted argument? */
929               if(*ptr=='"')
930                 {
931                   ptr++;
932                   end=strchr(ptr,'"');
933                   if(end)
934                     end++;
935                 }
936               else
937                 end=strpbrk(ptr," ,");
938             }
939
940           if(end && *end)
941             {
942               *end='\0';
943               *stringp=end+1;
944             }
945           else
946             *stringp=NULL;
947         }
948       else
949         *stringp=NULL;
950     }
951
952   return tok;
953 }
954
955 /* Breaks an option value into key and value.  Returns NULL if there
956    is no value.  Note that "string" is modified to remove the =value
957    part. */
958 char *
959 argsplit(char *string)
960 {
961   char *equals,*arg=NULL;
962
963   equals=strchr(string,'=');
964   if(equals)
965     {
966       char *quote,*space;
967
968       *equals='\0';
969       arg=equals+1;
970
971       /* Quoted arg? */
972       quote=strchr(arg,'"');
973       if(quote)
974         {
975           arg=quote+1;
976
977           quote=strchr(arg,'"');
978           if(quote)
979             *quote='\0';
980         }
981       else
982         {
983           size_t spaces;
984
985           /* Trim leading spaces off of the arg */
986           spaces=strspn(arg," ");
987           arg+=spaces;
988         }
989
990       /* Trim tailing spaces off of the tag */
991       space=strchr(string,' ');
992       if(space)
993         *space='\0';
994     }
995
996   return arg;
997 }
998
999 /* Return the length of the initial token, leaving off any
1000    argument. */
1001 static size_t
1002 optlen(const char *s)
1003 {
1004   char *end=strpbrk(s," =");
1005
1006   if(end)
1007     return end-s;
1008   else
1009     return strlen(s);
1010 }
1011
1012 int
1013 parse_options(char *str,unsigned int *options,
1014               struct parse_options *opts,int noisy)
1015 {
1016   char *tok;
1017
1018   if (str && !strcmp (str, "help"))
1019     {
1020       int i,maxlen=0;
1021
1022       /* Figure out the longest option name so we can line these up
1023          neatly. */
1024       for(i=0;opts[i].name;i++)
1025         if(opts[i].help && maxlen<strlen(opts[i].name))
1026           maxlen=strlen(opts[i].name);
1027
1028       for(i=0;opts[i].name;i++)
1029         if(opts[i].help)
1030           printf("%s%*s%s\n",opts[i].name,
1031                  maxlen+2-(int)strlen(opts[i].name),"",_(opts[i].help));
1032
1033       g10_exit(0);
1034     }
1035
1036   while((tok=optsep(&str)))
1037     {
1038       int i,rev=0;
1039       char *otok=tok;
1040
1041       if(tok[0]=='\0')
1042         continue;
1043
1044       if(ascii_strncasecmp("no-",tok,3)==0)
1045         {
1046           rev=1;
1047           tok+=3;
1048         }
1049
1050       for(i=0;opts[i].name;i++)
1051         {
1052           size_t toklen=optlen(tok);
1053
1054           if(ascii_strncasecmp(opts[i].name,tok,toklen)==0)
1055             {
1056               /* We have a match, but it might be incomplete */
1057               if(toklen!=strlen(opts[i].name))
1058                 {
1059                   int j;
1060
1061                   for(j=i+1;opts[j].name;j++)
1062                     {
1063                       if(ascii_strncasecmp(opts[j].name,tok,toklen)==0)
1064                         {
1065                           if(noisy)
1066                             log_info(_("ambiguous option `%s'\n"),otok);
1067                           return 0;
1068                         }
1069                     }
1070                 }
1071
1072               if(rev)
1073                 {
1074                   *options&=~opts[i].bit;
1075                   if(opts[i].value)
1076                     *opts[i].value=NULL;
1077                 }
1078               else
1079                 {
1080                   *options|=opts[i].bit;
1081                   if(opts[i].value)
1082                     *opts[i].value=argsplit(tok);
1083                 }
1084               break;
1085             }
1086         }
1087
1088       if(!opts[i].name)
1089         {
1090           if(noisy)
1091             log_info(_("unknown option `%s'\n"),otok);
1092           return 0;
1093         }
1094     }
1095
1096   return 1;
1097 }
1098
1099
1100 /* Return a new malloced string by unescaping the string S.  Escaping
1101    is percent escaping and '+'/space mapping.  A binary nul will
1102    silently be replaced by a 0xFF. */
1103 char *
1104 unescape_percent_string (const unsigned char *s)
1105 {
1106   char *buffer, *d;
1107
1108   buffer = d = xmalloc (strlen (s)+1);
1109   while (*s)
1110     {
1111       if (*s == '%' && s[1] && s[2])
1112         { 
1113           s++;
1114           *d = xtoi_2 (s);
1115           if (!*d)
1116             *d = '\xff';
1117           d++;
1118           s += 2;
1119         }
1120       else if (*s == '+')
1121         {
1122           *d++ = ' ';
1123           s++;
1124         }
1125       else
1126         *d++ = *s++;
1127     }
1128   *d = 0; 
1129   return buffer;
1130 }
1131
1132
1133 int
1134 has_invalid_email_chars (const char *s)
1135 {
1136   int at_seen=0;
1137   const char *valid_chars=
1138     "01234567890_-.abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
1139
1140   for ( ; *s; s++ ) 
1141     {
1142       if ( *s & 0x80 )
1143         return 1;
1144       if ( *s == '@' )
1145         at_seen=1;
1146       else if ( !at_seen && !( !!strchr( valid_chars, *s ) || *s == '+' ) )
1147         return 1;
1148       else if ( at_seen && !strchr( valid_chars, *s ) )
1149         return 1;
1150     }
1151   return 0;
1152 }
1153
1154
1155 /* Check whether NAME represents a valid mailbox according to
1156    RFC822. Returns true if so. */
1157 int
1158 is_valid_mailbox (const char *name)
1159 {
1160   return !( !name
1161             || !*name
1162             || has_invalid_email_chars (name)
1163             || string_count_chr (name,'@') != 1
1164             || *name == '@'
1165             || name[strlen(name)-1] == '@'
1166             || name[strlen(name)-1] == '.'
1167             || strstr (name, "..") );
1168 }
1169
1170
1171 /* Similar to access(2), but uses PATH to find the file. */
1172 int
1173 path_access(const char *file,int mode)
1174 {
1175   char *envpath;
1176   int ret=-1;
1177
1178   envpath=getenv("PATH");
1179
1180   if(!envpath
1181 #ifdef HAVE_DRIVE_LETTERS
1182      || (((file[0]>='A' && file[0]<='Z')
1183           || (file[0]>='a' && file[0]<='z'))
1184          && file[1]==':')
1185 #else
1186      || file[0]=='/'
1187 #endif
1188      )
1189     return access(file,mode);
1190   else
1191     {
1192       /* At least as large as, but most often larger than we need. */
1193       char *buffer=xmalloc(strlen(envpath)+1+strlen(file)+1);
1194       char *split,*item,*path=xstrdup(envpath);
1195
1196       split=path;
1197
1198       while((item=strsep(&split,PATHSEP_S)))
1199         {
1200           strcpy(buffer,item);
1201           strcat(buffer,"/");
1202           strcat(buffer,file);
1203           ret=access(buffer,mode);
1204           if(ret==0)
1205             break;
1206         }
1207
1208       xfree(path);
1209       xfree(buffer);
1210     }
1211
1212   return ret;
1213 }
1214
1215
1216 \f
1217 /* Temporary helper. */
1218 int
1219 pubkey_get_npkey( int algo )
1220 {
1221   size_t n;
1222
1223   if (algo == GCRY_PK_ELG_E)
1224     algo = GCRY_PK_ELG;
1225   if (gcry_pk_algo_info( algo, GCRYCTL_GET_ALGO_NPKEY, NULL, &n))
1226     n = 0;
1227   return n;
1228 }
1229
1230 /* Temporary helper. */
1231 int
1232 pubkey_get_nskey( int algo )
1233 {
1234   size_t n;
1235
1236   if (algo == GCRY_PK_ELG_E)
1237     algo = GCRY_PK_ELG;
1238   if (gcry_pk_algo_info( algo, GCRYCTL_GET_ALGO_NSKEY, NULL, &n ))
1239     n = 0;
1240   return n;
1241 }
1242
1243 /* Temporary helper. */
1244 int
1245 pubkey_get_nsig( int algo )
1246 {
1247   size_t n;
1248
1249   if (algo == GCRY_PK_ELG_E)
1250     algo = GCRY_PK_ELG;
1251   if (gcry_pk_algo_info( algo, GCRYCTL_GET_ALGO_NSIGN, NULL, &n))
1252     n = 0;
1253   return n;
1254 }
1255
1256 /* Temporary helper. */
1257 int
1258 pubkey_get_nenc( int algo )
1259 {
1260   size_t n;
1261   
1262   if (algo == GCRY_PK_ELG_E)
1263     algo = GCRY_PK_ELG;
1264   if (gcry_pk_algo_info( algo, GCRYCTL_GET_ALGO_NENCR, NULL, &n ))
1265     n = 0;
1266   return n;
1267 }
1268
1269
1270 /* Temporary helper. */
1271 unsigned int
1272 pubkey_nbits( int algo, gcry_mpi_t *key )
1273 {
1274     int rc, nbits;
1275     gcry_sexp_t sexp;
1276
1277     if( algo == GCRY_PK_DSA ) {
1278         rc = gcry_sexp_build ( &sexp, NULL,
1279                               "(public-key(dsa(p%m)(q%m)(g%m)(y%m)))",
1280                                   key[0], key[1], key[2], key[3] );
1281     }
1282     else if( algo == GCRY_PK_ELG || algo == GCRY_PK_ELG_E ) {
1283         rc = gcry_sexp_build ( &sexp, NULL,
1284                               "(public-key(elg(p%m)(g%m)(y%m)))",
1285                                   key[0], key[1], key[2] );
1286     }
1287     else if( algo == GCRY_PK_RSA ) {
1288         rc = gcry_sexp_build ( &sexp, NULL,
1289                               "(public-key(rsa(n%m)(e%m)))",
1290                                   key[0], key[1] );
1291     }
1292     else
1293         return 0;
1294
1295     if ( rc )
1296         BUG ();
1297
1298     nbits = gcry_pk_get_nbits( sexp );
1299     gcry_sexp_release( sexp );
1300     return nbits;
1301 }
1302
1303
1304
1305 /* FIXME: Use gcry_mpi_print directly. */
1306 int
1307 mpi_print( FILE *fp, gcry_mpi_t a, int mode )
1308 {
1309     int n=0;
1310
1311     if( !a )
1312         return fprintf(fp, "[MPI_NULL]");
1313     if( !mode ) {
1314         unsigned int n1;
1315         n1 = gcry_mpi_get_nbits(a);
1316         n += fprintf(fp, "[%u bits]", n1);
1317     }
1318     else {
1319         unsigned char *buffer;
1320
1321         if (gcry_mpi_aprint (GCRYMPI_FMT_HEX, &buffer, NULL, a))
1322           BUG ();
1323         fputs( buffer, fp );
1324         n += strlen(buffer);
1325         gcry_free( buffer );
1326     }
1327     return n;
1328 }
1329