4b1cd5b86a16a8d16c20f0d533b912928e2a6bc4
[gpgme.git] / src / gpgme-json.c
1 /* gpgme-json.c - JSON based interface to gpgme (server)
2  * Copyright (C) 2018 g10 Code GmbH
3  *
4  * This file is part of GPGME.
5  *
6  * GPGME is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU Lesser General Public License as
8  * published by the Free Software Foundation; either version 2.1 of
9  * the License, or (at your option) any later version.
10  *
11  * GPGME is distributed in the hope that it will be useful, but
12  * WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this program; if not, see <http://www.gnu.org/licenses/>.
18  * SPDX-License-Identifier: LGPL-2.1+
19  */
20
21 /* This is tool implements the Native Messaging protocol of web
22  * browsers and provides the server part of it.  A Javascript based
23  * client can be found in lang/javascript.  The used data format is
24  * similar to the API of openpgpjs.
25  */
26
27 #include <config.h>
28 #include <stdio.h>
29 #include <stdlib.h>
30 #include <string.h>
31 #include <stdarg.h>
32 #ifdef HAVE_LOCALE_H
33 #include <locale.h>
34 #endif
35 #include <stdint.h>
36
37 #define GPGRT_ENABLE_ES_MACROS 1
38 #define GPGRT_ENABLE_LOG_MACROS 1
39 #define GPGRT_ENABLE_ARGPARSE_MACROS 1
40 #include "gpgme.h"
41 #include "cJSON.h"
42
43
44 #if GPGRT_VERSION_NUMBER < 0x011c00 /* 1.28 */
45 int main (void){fputs ("Build with Libgpg-error >= 1.28!\n", stderr);return 1;}
46 #else /* libgpg-error >= 1.28 */
47
48 /* We don't allow a request with more than 64 MiB.  */
49 #define MAX_REQUEST_SIZE (64 * 1024 * 1024)
50
51
52 static void xoutofcore (const char *type) GPGRT_ATTR_NORETURN;
53 static cjson_t error_object_v (cjson_t json, const char *message,
54                               va_list arg_ptr) GPGRT_ATTR_PRINTF(2,0);
55 static cjson_t error_object (cjson_t json, const char *message,
56                             ...) GPGRT_ATTR_PRINTF(2,3);
57 static char *error_object_string (const char *message,
58                                   ...) GPGRT_ATTR_PRINTF(1,2);
59
60
61 /* True if interactive mode is active.  */
62 static int opt_interactive;
63 /* True is debug mode is active.  */
64 static int opt_debug;
65
66
67 /*
68  * Helper functions and macros
69  */
70
71 #define xtrymalloc(a)  gpgrt_malloc ((a))
72 #define xtrystrdup(a)  gpgrt_strdup ((a))
73 #define xmalloc(a) ({                           \
74       void *_r = gpgrt_malloc ((a));            \
75       if (!_r)                                  \
76         xoutofcore ("malloc");                  \
77       _r; })
78 #define xcalloc(a,b) ({                         \
79       void *_r = gpgrt_calloc ((a), (b));       \
80       if (!_r)                                  \
81         xoutofcore ("calloc");                  \
82       _r; })
83 #define xstrdup(a) ({                           \
84       char *_r = gpgrt_strdup ((a));            \
85       if (!_r)                                  \
86         xoutofcore ("strdup");                  \
87       _r; })
88 #define xstrconcat(a, ...) ({                           \
89       char *_r = gpgrt_strconcat ((a), __VA_ARGS__);    \
90       if (!_r)                                          \
91         xoutofcore ("strconcat");                       \
92       _r; })
93 #define xfree(a) gpgrt_free ((a))
94
95 #define spacep(p)   (*(p) == ' ' || *(p) == '\t')
96
97
98 static void
99 xoutofcore (const char *type)
100 {
101   gpg_error_t err = gpg_error_from_syserror ();
102   log_error ("%s failed: %s\n", type, gpg_strerror (err));
103   exit (2);
104 }
105
106
107 /* Call cJSON_CreateObject but terminate in case of an error.  */
108 static cjson_t
109 xjson_CreateObject (void)
110 {
111   cjson_t json = cJSON_CreateObject ();
112   if (!json)
113     xoutofcore ("cJSON_CreateObject");
114   return json;
115 }
116
117
118 /* Wrapper around cJSON_AddStringToObject which returns an gpg-error
119  * code instead of the NULL or the new object.  */
120 static gpg_error_t
121 cjson_AddStringToObject (cjson_t object, const char *name, const char *string)
122 {
123   if (!cJSON_AddStringToObject (object, name, string))
124     return gpg_error_from_syserror ();
125   return 0;
126 }
127
128
129 /* Same as cjson_AddStringToObject but prints an error message and
130  * terminates the process.  */
131 static void
132 xjson_AddStringToObject (cjson_t object, const char *name, const char *string)
133 {
134   if (!cJSON_AddStringToObject (object, name, string))
135     xoutofcore ("cJSON_AddStringToObject");
136 }
137
138
139 /* Wrapper around cJSON_AddBoolToObject which terminates the process
140  * in case of an error.  */
141 static void
142 xjson_AddBoolToObject (cjson_t object, const char *name, int abool)
143 {
144   if (!cJSON_AddBoolToObject (object, name, abool))
145     xoutofcore ("cJSON_AddStringToObject");
146   return ;
147 }
148
149 /* This is similar to cJSON_AddStringToObject but takes a gpgme DATA
150  * object and adds it under NAME as a base 64 encoded string to
151  * OBJECT.  Ownership of DATA is transferred to this function.  */
152 static gpg_error_t
153 add_base64_to_object (cjson_t object, const char *name, gpgme_data_t data)
154 {
155 #if GPGRT_VERSION_NUMBER < 0x011d00 /* 1.29 */
156   return gpg_error (GPG_ERR_NOT_SUPPORTED);
157 #else
158   gpg_err_code_t err;
159   estream_t fp = NULL;
160   gpgrt_b64state_t state = NULL;
161   cjson_t j_str = NULL;
162   void *buffer = NULL;
163   size_t buflen;
164
165   fp = es_fopenmem (0, "rwb");
166   if (!fp)
167     {
168       err = gpg_err_code_from_syserror ();
169       goto leave;
170     }
171   state = gpgrt_b64enc_start (fp, "");
172   if (!state)
173     {
174       err = gpg_err_code_from_syserror ();
175       goto leave;
176     }
177
178   gpgme_data_write (data, "", 1); /* Make sure we have  a string.  */
179   buffer = gpgme_data_release_and_get_mem (data, &buflen);
180   data = NULL;
181   if (!buffer)
182     {
183       err = gpg_error_from_syserror ();
184       goto leave;
185     }
186
187   err = gpgrt_b64enc_write (state, buffer, buflen);
188   if (err)
189     goto leave;
190   xfree (buffer);
191   buffer = NULL;
192
193   err = gpgrt_b64enc_finish (state);
194   state = NULL;
195   if (err)
196     return err;
197
198   es_fputc (0, fp);
199   if (es_fclose_snatch (fp, &buffer, NULL))
200     {
201       fp = NULL;
202       err = gpg_error_from_syserror ();
203       goto leave;
204     }
205   fp = NULL;
206
207   j_str = cJSON_CreateStringConvey (buffer);
208   if (!j_str)
209     {
210       err = gpg_error_from_syserror ();
211       goto leave;
212     }
213   buffer = NULL;
214
215   if (!cJSON_AddItemToObject (object, name, j_str))
216     {
217       err = gpg_error_from_syserror ();
218       cJSON_Delete (j_str);
219       j_str = NULL;
220       goto leave;
221     }
222   j_str = NULL;
223
224  leave:
225   xfree (buffer);
226   cJSON_Delete (j_str);
227   gpgrt_b64enc_finish (state);
228   es_fclose (fp);
229   gpgme_data_release (data);
230   return err;
231 #endif
232 }
233
234
235 /* Create a JSON error object.  If JSON is not NULL the error message
236  * is appended to that object.  An existing "type" item will be replaced. */
237 static cjson_t
238 error_object_v (cjson_t json, const char *message, va_list arg_ptr)
239 {
240   cjson_t response, j_tmp;
241   char *msg;
242
243   msg = gpgrt_vbsprintf (message, arg_ptr);
244   if (!msg)
245     xoutofcore ("error_object");
246
247   response = json? json : xjson_CreateObject ();
248
249   if (!(j_tmp = cJSON_GetObjectItem (response, "type")))
250     xjson_AddStringToObject (response, "type", "error");
251   else /* Replace existing "type".  */
252     {
253       j_tmp = cJSON_CreateString ("error");
254       if (!j_tmp)
255         xoutofcore ("cJSON_CreateString");
256       cJSON_ReplaceItemInObject (response, "type", j_tmp);
257      }
258   xjson_AddStringToObject (response, "msg", msg);
259
260   xfree (msg);
261   return response;
262 }
263
264
265 /* Call cJSON_Print but terminate in case of an error.  */
266 static char *
267 xjson_Print (cjson_t object)
268 {
269   char *buf;
270   buf = cJSON_Print (object);
271   if (!buf)
272     xoutofcore ("cJSON_Print");
273   return buf;
274 }
275
276
277 static cjson_t
278 error_object (cjson_t json, const char *message, ...)
279 {
280   cjson_t response;
281   va_list arg_ptr;
282
283   va_start (arg_ptr, message);
284   response = error_object_v (json, message, arg_ptr);
285   va_end (arg_ptr);
286   return response;
287 }
288
289
290 static char *
291 error_object_string (const char *message, ...)
292 {
293   cjson_t response;
294   va_list arg_ptr;
295   char *msg;
296
297   va_start (arg_ptr, message);
298   response = error_object_v (NULL, message, arg_ptr);
299   va_end (arg_ptr);
300
301   msg = xjson_Print (response);
302   cJSON_Delete (response);
303   return msg;
304 }
305
306
307 /* Get the boolean property NAME from the JSON object and store true
308  * or valse at R_VALUE.  If the name is unknown the value of DEF_VALUE
309  * is returned.  If the type of the value is not boolean,
310  * GPG_ERR_INV_VALUE is returned and R_VALUE set to DEF_VALUE.  */
311 static gpg_error_t
312 get_boolean_flag (cjson_t json, const char *name, int def_value, int *r_value)
313 {
314   cjson_t j_item;
315
316   j_item = cJSON_GetObjectItem (json, name);
317   if (!j_item)
318     *r_value = def_value;
319   else if (cjson_is_true (j_item))
320     *r_value = 1;
321   else if (cjson_is_false (j_item))
322     *r_value = 0;
323   else
324     {
325       *r_value = def_value;
326       return gpg_error (GPG_ERR_INV_VALUE);
327     }
328
329   return 0;
330 }
331
332
333 /* Get the boolean property PROTOCOL from the JSON object and store
334  * its value at R_PROTOCOL.  The default is OpenPGP.  */
335 static gpg_error_t
336 get_protocol (cjson_t json, gpgme_protocol_t *r_protocol)
337 {
338   cjson_t j_item;
339
340   *r_protocol = GPGME_PROTOCOL_OpenPGP;
341   j_item = cJSON_GetObjectItem (json, "protocol");
342   if (!j_item)
343     ;
344   else if (!cjson_is_string (j_item))
345     return gpg_error (GPG_ERR_INV_VALUE);
346   else if (!strcmp(j_item->valuestring, "openpgp"))
347     ;
348   else if (!strcmp(j_item->valuestring, "cms"))
349     *r_protocol = GPGME_PROTOCOL_CMS;
350   else
351     return gpg_error (GPG_ERR_UNSUPPORTED_PROTOCOL);
352
353   return 0;
354 }
355
356
357 /* Extract the keys from the "keys" array in the JSON object.  On
358  * success a string with the keys identifiers is stored at R_KEYS.
359  * The keys in that string are LF delimited.  On failure an error code
360  * is returned.  */
361 static gpg_error_t
362 get_keys (cjson_t json, char **r_keystring)
363 {
364   cjson_t j_keys, j_item;
365   int i, nkeys;
366   char *p;
367   size_t length;
368
369   *r_keystring = NULL;
370
371   j_keys = cJSON_GetObjectItem (json, "keys");
372   if (!j_keys)
373     return gpg_error (GPG_ERR_NO_KEY);
374   if (!cjson_is_array (j_keys) && !cjson_is_string (j_keys))
375     return gpg_error (GPG_ERR_INV_VALUE);
376
377   /* Fixme: We should better use a membuf like thing.  */
378   length = 1; /* For the EOS.  */
379   if (cjson_is_string (j_keys))
380     {
381       nkeys = 1;
382       length += strlen (j_keys->valuestring);
383       if (strchr (j_keys->valuestring, '\n'))
384         return gpg_error (GPG_ERR_INV_USER_ID);
385     }
386   else
387     {
388       nkeys = cJSON_GetArraySize (j_keys);
389       if (!nkeys)
390         return gpg_error (GPG_ERR_NO_KEY);
391       for (i=0; i < nkeys; i++)
392         {
393           j_item = cJSON_GetArrayItem (j_keys, i);
394           if (!j_item || !cjson_is_string (j_item))
395             return gpg_error (GPG_ERR_INV_VALUE);
396           if (i)
397             length++; /* Space for delimiter. */
398           length += strlen (j_item->valuestring);
399           if (strchr (j_item->valuestring, '\n'))
400             return gpg_error (GPG_ERR_INV_USER_ID);
401         }
402     }
403
404   p = *r_keystring = xtrymalloc (length);
405   if (!p)
406     return gpg_error_from_syserror ();
407
408   if (cjson_is_string (j_keys))
409     {
410       strcpy (p, j_keys->valuestring);
411     }
412   else
413     {
414       for (i=0; i < nkeys; i++)
415         {
416           j_item = cJSON_GetArrayItem (j_keys, i);
417           if (i)
418             *p++ = '\n'; /* Add delimiter.  */
419           p = stpcpy (p, j_item->valuestring);
420         }
421     }
422   return 0;
423 }
424
425
426
427 \f
428 /*
429  *  GPGME support functions.
430  */
431
432 /* Helper for get_context.  */
433 static gpgme_ctx_t
434 _create_new_context (gpgme_protocol_t proto)
435 {
436   gpg_error_t err;
437   gpgme_ctx_t ctx;
438
439   err = gpgme_new (&ctx);
440   if (err)
441     log_fatal ("error creating GPGME context: %s\n", gpg_strerror (err));
442   gpgme_set_protocol (ctx, proto);
443   gpgme_set_ctx_flag (ctx, "request-origin", "browser");
444   return ctx;
445 }
446
447
448 /* Return a context object for protocol PROTO.  This is currently a
449  * statuically allocated context initialized for PROTO.  Termnates
450  * process on failure.  */
451 static gpgme_ctx_t
452 get_context (gpgme_protocol_t proto)
453 {
454   static gpgme_ctx_t ctx_openpgp, ctx_cms;
455
456   if (proto == GPGME_PROTOCOL_OpenPGP)
457     {
458       if (!ctx_openpgp)
459         ctx_openpgp = _create_new_context (proto);
460       return ctx_openpgp;
461     }
462   else if (proto == GPGME_PROTOCOL_CMS)
463     {
464       if (!ctx_cms)
465         ctx_cms = _create_new_context (proto);
466       return ctx_cms;
467     }
468   else
469     log_bug ("invalid protocol %d requested\n", proto);
470 }
471
472
473
474 /* Free context object retrieved by get_context.  */
475 static void
476 release_context (gpgme_ctx_t ctx)
477 {
478   /* Nothing to do right now.  */
479   (void)ctx;
480 }
481
482
483
484 /* Given a Base-64 encoded string object in JSON return a gpgme data
485  * object at R_DATA.  */
486 static gpg_error_t
487 data_from_base64_string (gpgme_data_t *r_data, cjson_t json)
488 {
489 #if GPGRT_VERSION_NUMBER < 0x011d00 /* 1.29 */
490   *r_data = NULL;
491   return gpg_error (GPG_ERR_NOT_SUPPORTED);
492 #else
493   gpg_error_t err;
494   size_t len;
495   char *buf = NULL;
496   gpgrt_b64state_t state = NULL;
497   gpgme_data_t data = NULL;
498
499   *r_data = NULL;
500
501   /* A quick check on the JSON.  */
502   if (!cjson_is_string (json))
503     {
504       err = gpg_error (GPG_ERR_INV_VALUE);
505       goto leave;
506     }
507
508   state = gpgrt_b64dec_start (NULL);
509   if (!state)
510     {
511       err = gpg_err_code_from_syserror ();
512       goto leave;
513     }
514
515   /* Fixme: Data duplication - we should see how to snatch the memory
516    * from the json object.  */
517   len = strlen (json->valuestring);
518   buf = xtrystrdup (json->valuestring);
519   if (!buf)
520     {
521       err = gpg_error_from_syserror ();
522       goto leave;
523     }
524
525   err = gpgrt_b64dec_proc (state, buf, len, &len);
526   if (err)
527     goto leave;
528
529   err = gpgrt_b64dec_finish (state);
530   state = NULL;
531   if (err)
532     goto leave;
533
534   err = gpgme_data_new_from_mem (&data, buf, len, 1);
535   if (err)
536     goto leave;
537   *r_data = data;
538   data = NULL;
539
540  leave:
541   xfree (data);
542   xfree (buf);
543   gpgrt_b64dec_finish (state);
544   return err;
545 #endif
546 }
547
548
549 \f
550 /*
551  * Implementaion of the commands.
552  */
553
554
555 static const char hlp_encrypt[] =
556   "op:     \"encrypt\"\n"
557   "keys:   Array of strings with the fingerprints or user-ids\n"
558   "        of the keys to encrypt the data.  For a single key\n"
559   "        a String may be used instead of an array.\n"
560   "data:   Input data. \n"
561   "\n"
562   "Optional parameters:\n"
563   "protocol:      Either \"openpgp\" (default) or \"cms\".\n"
564   "\n"
565   "Optional boolean flags (default is false):\n"
566   "base64:        Input data is base64 encoded.\n"
567   "armor:         Request output in armored format.\n"
568   "always-trust:  Request --always-trust option.\n"
569   "no-encrypt-to: Do not use a default recipient.\n"
570   "no-compress:   Do not compress the plaintext first.\n"
571   "throw-keyids:  Request the --throw-keyids option.\n"
572   "wrap:          Assume the input is an OpenPGP message.\n"
573   "\n"
574   "Response on success:\n"
575   "type:   \"ciphertext\"\n"
576   "data:   Unless armor mode is used a Base64 encoded binary\n"
577   "        ciphertext.  In armor mode a string with an armored\n"
578   "        OpenPGP or a PEM message.\n"
579   "base64: Boolean indicating whether data is base64 encoded.";
580 static gpg_error_t
581 op_encrypt (cjson_t request, cjson_t result)
582 {
583   gpg_error_t err;
584   gpgme_ctx_t ctx = NULL;
585   gpgme_protocol_t protocol;
586   int opt_base64;
587   char *keystring = NULL;
588   cjson_t j_input;
589   gpgme_data_t input = NULL;
590   gpgme_data_t output = NULL;
591   int abool;
592   gpgme_encrypt_flags_t encrypt_flags = 0;
593
594   if ((err = get_protocol (request, &protocol)))
595     goto leave;
596   ctx = get_context (protocol);
597
598   if ((err = get_boolean_flag (request, "base64", 0, &opt_base64)))
599     goto leave;
600
601   if ((err = get_boolean_flag (request, "armor", 0, &abool)))
602     goto leave;
603   gpgme_set_armor (ctx, abool);
604   if ((err = get_boolean_flag (request, "always-trust", 0, &abool)))
605     goto leave;
606   if (abool)
607     encrypt_flags |= GPGME_ENCRYPT_ALWAYS_TRUST;
608   if ((err = get_boolean_flag (request, "no-encrypt-to", 0,&abool)))
609     goto leave;
610   if (abool)
611     encrypt_flags |= GPGME_ENCRYPT_NO_ENCRYPT_TO;
612   if ((err = get_boolean_flag (request, "no-compress", 0, &abool)))
613     goto leave;
614   if (abool)
615     encrypt_flags |= GPGME_ENCRYPT_NO_COMPRESS;
616   if ((err = get_boolean_flag (request, "throw-keyids", 0, &abool)))
617     goto leave;
618   if (abool)
619     encrypt_flags |= GPGME_ENCRYPT_THROW_KEYIDS;
620   if ((err = get_boolean_flag (request, "wrap", 0, &abool)))
621     goto leave;
622   if (abool)
623     encrypt_flags |= GPGME_ENCRYPT_WRAP;
624
625
626   /* Get the keys.  */
627   err = get_keys (request, &keystring);
628   if (err)
629     {
630       /* Provide a custom error response.  */
631       error_object (result, "Error getting keys: %s", gpg_strerror (err));
632       goto leave;
633     }
634
635   /* Get the data.  Note that INPUT is a shallow data object with the
636    * storage hold in REQUEST.  */
637   j_input = cJSON_GetObjectItem (request, "data");
638   if (!j_input)
639     {
640       err = gpg_error (GPG_ERR_NO_DATA);
641       goto leave;
642     }
643   if (!cjson_is_string (j_input))
644     {
645       err = gpg_error (GPG_ERR_INV_VALUE);
646       goto leave;
647     }
648   if (opt_base64)
649     {
650       err = data_from_base64_string (&input, j_input);
651       if (err)
652         {
653           error_object (result, "Error decoding Base-64 encoded 'data': %s",
654                         gpg_strerror (err));
655           goto leave;
656         }
657     }
658   else
659     {
660       err = gpgme_data_new_from_mem (&input, j_input->valuestring,
661                                      strlen (j_input->valuestring), 0);
662       if (err)
663         {
664           error_object (result, "Error getting 'data': %s", gpg_strerror (err));
665           goto leave;
666         }
667     }
668
669   /* Create an output data object.  */
670   err = gpgme_data_new (&output);
671   if (err)
672     {
673       error_object (result, "Error creating output data object: %s",
674                     gpg_strerror (err));
675       goto leave;
676     }
677
678   /* Encrypt.  */
679   err = gpgme_op_encrypt_ext (ctx, NULL, keystring, encrypt_flags,
680                               input, output);
681   /* encrypt_result = gpgme_op_encrypt_result (ctx); */
682   if (err)
683     {
684       error_object (result, "Encryption failed: %s", gpg_strerror (err));
685       goto leave;
686     }
687   gpgme_data_release (input);
688   input = NULL;
689
690   xjson_AddStringToObject (result, "type", "ciphertext");
691   /* If armoring is used we do not need to base64 the output.  */
692   xjson_AddBoolToObject (result, "base64", !gpgme_get_armor (ctx));
693   if (gpgme_get_armor (ctx))
694     {
695       char *buffer;
696
697       /* Make sure that we really have a string.  */
698       gpgme_data_write (output, "", 1);
699       buffer = gpgme_data_release_and_get_mem (output, NULL);
700       if (!buffer)
701         {
702           err = gpg_error_from_syserror ();
703           goto leave;
704         }
705       err = cjson_AddStringToObject (result, "data", buffer);
706       gpgme_free (buffer);
707       if (err)
708         goto leave;
709     }
710   else
711     {
712       err = add_base64_to_object (result, "data", output);
713       output = NULL;
714       if (err)
715         goto leave;
716     }
717
718  leave:
719   xfree (keystring);
720   release_context (ctx);
721   gpgme_data_release (input);
722   return err;
723 }
724
725
726
727 static const char hlp_help[] =
728   "The tool expects a JSON object with the request and responds with\n"
729   "another JSON object.  Even on error a JSON object is returned.  The\n"
730   "property \"op\" is mandatory and its string value selects the\n"
731   "operation; if the property \"help\" with the value \"true\" exists, the\n"
732   "operation is not performned but a string with the documentation\n"
733   "returned.  To list all operations it is allowed to leave out \"op\" in\n"
734   "help mode.  Supported values for \"op\" are:\n\n"
735   "  encrypt     Encrypt data.\n"
736   "  help        Help overview.";
737 static gpg_error_t
738 op_help (cjson_t request, cjson_t result)
739 {
740   cjson_t j_tmp;
741   char *buffer = NULL;
742   const char *msg;
743
744   j_tmp = cJSON_GetObjectItem (request, "interactive_help");
745   if (opt_interactive && j_tmp && cjson_is_string (j_tmp))
746     msg = buffer = xstrconcat (hlp_help, "\n", j_tmp->valuestring, NULL);
747   else
748     msg = hlp_help;
749
750   xjson_AddStringToObject (result, "type", "help");
751   xjson_AddStringToObject (result, "msg", msg);
752
753   xfree (buffer);
754   return 0;
755 }
756
757
758
759 /* Process a request and return the response.  The response is a newly
760  * allocated string or NULL in case of an error.  */
761 static char *
762 process_request (const char *request)
763 {
764   static struct {
765     const char *op;
766     gpg_error_t (*handler)(cjson_t request, cjson_t result);
767     const char * const helpstr;
768   } optbl[] = {
769     { "encrypt", op_encrypt, hlp_encrypt },
770
771
772     { "help",    op_help,    hlp_help },
773     { NULL }
774   };
775   size_t erroff;
776   cjson_t json;
777   cjson_t j_tmp, j_op;
778   cjson_t response;
779   int helpmode;
780   const char *op;
781   char *res;
782   int idx;
783
784   response = xjson_CreateObject ();
785
786   json = cJSON_Parse (request, &erroff);
787   if (!json)
788     {
789       log_string (GPGRT_LOGLVL_INFO, request);
790       log_info ("invalid JSON object at offset %zu\n", erroff);
791       error_object (response, "invalid JSON object at offset %zu\n", erroff);
792       goto leave;
793     }
794
795   j_tmp = cJSON_GetObjectItem (json, "help");
796   helpmode = (j_tmp && cjson_is_true (j_tmp));
797
798   j_op = cJSON_GetObjectItem (json, "op");
799   if (!j_op || !cjson_is_string (j_op))
800     {
801       if (!helpmode)
802         {
803           error_object (response, "Property \"op\" missing");
804           goto leave;
805         }
806       op = "help";  /* Help summary.  */
807     }
808   else
809     op = j_op->valuestring;
810
811   for (idx=0; optbl[idx].op; idx++)
812     if (!strcmp (op, optbl[idx].op))
813       break;
814   if (optbl[idx].op)
815     {
816       if (helpmode && strcmp (op, "help"))
817         {
818           xjson_AddStringToObject (response, "type", "help");
819           xjson_AddStringToObject (response, "op", op);
820           xjson_AddStringToObject (response, "msg", optbl[idx].helpstr);
821         }
822       else
823         {
824           gpg_error_t err;
825
826           err = optbl[idx].handler (json, response);
827           if (err)
828             {
829               if (!(j_tmp = cJSON_GetObjectItem (response, "type"))
830                   || !cjson_is_string (j_tmp)
831                   || strcmp (j_tmp->valuestring, "error"))
832                 {
833                   /* No error type response - provide a generic one.  */
834                   error_object (response, "Operation failed: %s",
835                                 gpg_strerror (err));
836                 }
837
838               xjson_AddStringToObject (response, "op", op);
839             }
840
841         }
842     }
843   else  /* Operation not supported.  */
844     {
845       error_object (response, "Unknown operation '%s'", op);
846       xjson_AddStringToObject (response, "op", op);
847     }
848
849  leave:
850   cJSON_Delete (json);
851   if (opt_interactive)
852     res = cJSON_Print (response);
853   else
854     res = cJSON_PrintUnformatted (response);
855   if (!res)
856     log_error ("Printing JSON data failed\n");
857   cJSON_Delete (response);
858   return res;
859 }
860
861
862 \f
863 /*
864  *  Driver code
865  */
866
867 /* Return a malloced line or NULL on EOF.  Terminate on read
868  * error.  */
869 static char *
870 get_line (void)
871 {
872   char *line = NULL;
873   size_t linesize = 0;
874   gpg_error_t err;
875   size_t maxlength = 2048;
876   int n;
877   const char *s;
878   char *p;
879
880  again:
881   n = es_read_line (es_stdin, &line, &linesize, &maxlength);
882   if (n < 0)
883     {
884       err = gpg_error_from_syserror ();
885       log_error ("error reading line: %s\n", gpg_strerror (err));
886       exit (1);
887     }
888   if (!n)
889     {
890       xfree (line);
891       line = NULL;
892       return NULL;  /* EOF */
893     }
894   if (!maxlength)
895     {
896       log_info ("line too long - skipped\n");
897       goto again;
898     }
899   if (memchr (line, 0, n))
900     log_info ("warning: line shortened due to embedded Nul character\n");
901
902   if (line[n-1] == '\n')
903     line[n-1] = 0;
904
905   /* Trim leading spaces.  */
906   for (s=line; spacep (s); s++)
907     ;
908   if (s != line)
909     {
910       for (p=line; *s;)
911         *p++ = *s++;
912       *p = 0;
913       n = p - line;
914     }
915
916   return line;
917 }
918
919
920 /* Process meta commands used with the standard REPL.  */
921 static char *
922 process_meta_commands (const char *request)
923 {
924   char *result = NULL;
925
926   while (spacep (request))
927     request++;
928
929   if (!strncmp (request, "help", 4) && (spacep (request+4) || !request[4]))
930     result = process_request ("{ \"op\": \"help\","
931                               " \"interactive_help\": "
932                               "\"\\nMeta commands:\\n"
933                               "  ,help       This help\\n"
934                               "  ,quit       Terminate process\""
935                               "}");
936   else if (!strncmp (request, "quit", 4) && (spacep (request+4) || !request[4]))
937     exit (0);
938   else
939     log_info ("invalid meta command\n");
940
941   return result;
942 }
943
944
945 /* If STRING has a help response, return the MSG property in a human
946  * readable format.  */
947 static char *
948 get_help_msg (const char *string)
949 {
950   cjson_t json, j_type, j_msg;
951   const char *msg;
952   char *buffer = NULL;
953   char *p;
954
955   json = cJSON_Parse (string, NULL);
956   if (json)
957     {
958       j_type = cJSON_GetObjectItem (json, "type");
959       if (j_type && cjson_is_string (j_type)
960           && !strcmp (j_type->valuestring, "help"))
961         {
962           j_msg = cJSON_GetObjectItem (json, "msg");
963           if (j_msg || cjson_is_string (j_msg))
964             {
965               msg = j_msg->valuestring;
966               buffer = malloc (strlen (msg)+1);
967               if (buffer)
968                 {
969                   for (p=buffer; *msg; msg++)
970                     {
971                       if (*msg == '\\' && msg[1] == '\n')
972                         *p++ = '\n';
973                       else
974                         *p++ = *msg;
975                     }
976                   *p = 0;
977                 }
978             }
979         }
980       cJSON_Delete (json);
981     }
982   return buffer;
983 }
984
985
986 /* An interactive standard REPL.  */
987 static void
988 interactive_repl (void)
989 {
990   char *line = NULL;
991   char *request = NULL;
992   char *response = NULL;
993   char *p;
994   int first;
995
996   es_setvbuf (es_stdin, NULL, _IONBF, 0);
997 #if GPGRT_VERSION_NUMBER >= 0x011d00 /* 1.29 */
998   es_fprintf (es_stderr, "%s %s ready (enter \",help\" for help)\n",
999               gpgrt_strusage (11), gpgrt_strusage (13));
1000 #endif
1001   do
1002     {
1003       es_fputs ("> ", es_stderr);
1004       es_fflush (es_stderr);
1005       es_fflush (es_stdout);
1006       xfree (line);
1007       line = get_line ();
1008       es_fflush (es_stderr);
1009       es_fflush (es_stdout);
1010
1011       first = !request;
1012       if (line && *line)
1013         {
1014           if (!request)
1015             request = xstrdup (line);
1016           else
1017             request = xstrconcat (request, "\n", line, NULL);
1018         }
1019
1020       if (!line)
1021         es_fputs ("\n", es_stderr);
1022
1023       if (!line || !*line || (first && *request == ','))
1024         {
1025           /* Process the input.  */
1026           xfree (response);
1027           response = NULL;
1028           if (request && *request == ',')
1029             {
1030               response = process_meta_commands (request+1);
1031             }
1032           else if (request)
1033             {
1034               response = process_request (request);
1035             }
1036           xfree (request);
1037           request = NULL;
1038
1039           if (response)
1040             {
1041               if (opt_interactive)
1042                 {
1043                   char *msg = get_help_msg (response);
1044                   if (msg)
1045                     {
1046                       xfree (response);
1047                       response = msg;
1048                     }
1049                 }
1050
1051               es_fputs ("===> ", es_stderr);
1052               es_fflush (es_stderr);
1053               for (p=response; *p; p++)
1054                 {
1055                   if (*p == '\n')
1056                     {
1057                       es_fflush (es_stdout);
1058                       es_fputs ("\n===> ", es_stderr);
1059                       es_fflush (es_stderr);
1060                     }
1061                   else
1062                     es_putc (*p, es_stdout);
1063                 }
1064               es_fflush (es_stdout);
1065               es_fputs ("\n", es_stderr);
1066             }
1067         }
1068     }
1069   while (line);
1070
1071   xfree (request);
1072   xfree (response);
1073   xfree (line);
1074 }
1075
1076
1077 /* Read and process a single request.  */
1078 static void
1079 read_and_process_single_request (void)
1080 {
1081   char *line = NULL;
1082   char *request = NULL;
1083   char *response = NULL;
1084   size_t n;
1085
1086   for (;;)
1087     {
1088       xfree (line);
1089       line = get_line ();
1090       if (line && *line)
1091         request = (request? xstrconcat (request, "\n", line, NULL)
1092                    /**/   : xstrdup (line));
1093       if (!line)
1094         {
1095           if (request)
1096             {
1097               xfree (response);
1098               response = process_request (request);
1099               if (response)
1100                 {
1101                   es_fputs (response, es_stdout);
1102                   if ((n = strlen (response)) && response[n-1] != '\n')
1103                     es_fputc ('\n', es_stdout);
1104                 }
1105               es_fflush (es_stdout);
1106             }
1107           break;
1108         }
1109     }
1110
1111   xfree (response);
1112   xfree (request);
1113   xfree (line);
1114 }
1115
1116
1117 /* The Native Messaging processing loop.  */
1118 static void
1119 native_messaging_repl (void)
1120 {
1121   gpg_error_t err;
1122   uint32_t nrequest, nresponse;
1123   char *request = NULL;
1124   char *response = NULL;
1125   size_t n;
1126
1127   /* Due to the length octets we need to switch the I/O stream into
1128    * binary mode.  */
1129   es_set_binary (es_stdin);
1130   es_set_binary (es_stdout);
1131   es_setbuf (es_stdin, NULL);  /* stdin needs to be unbuffered! */
1132
1133   for (;;)
1134     {
1135       /* Read length.  Note that the protocol uses native endianess.
1136        * Is it allowed to call such a thing a well thought out
1137        * protocol?  */
1138       if (es_read (es_stdin, &nrequest, sizeof nrequest, &n))
1139         {
1140           err = gpg_error_from_syserror ();
1141           log_error ("error reading request header: %s\n", gpg_strerror (err));
1142           break;
1143         }
1144       if (!n)
1145         break;  /* EOF */
1146       if (n != sizeof nrequest)
1147         {
1148           log_error ("error reading request header: short read\n");
1149           break;
1150         }
1151       if (nrequest > MAX_REQUEST_SIZE)
1152         {
1153           log_error ("error reading request: request too long (%zu MiB)\n",
1154                      (size_t)nrequest / (1024*1024));
1155           /* Fixme: Shall we read the request to the bit bucket and
1156            * return an error reponse or just return an error reponse
1157            * and terminate?  Needs some testing.  */
1158           break;
1159         }
1160
1161       /* Read request.  */
1162       request = xtrymalloc (nrequest);
1163       if (!request)
1164         {
1165           err = gpg_error_from_syserror ();
1166           log_error ("error reading request: Not enough memory for %zu MiB)\n",
1167                      (size_t)nrequest / (1024*1024));
1168           /* FIXME: See comment above.  */
1169           break;
1170         }
1171       if (es_read (es_stdin, request, nrequest, &n))
1172         {
1173           err = gpg_error_from_syserror ();
1174           log_error ("error reading request: %s\n", gpg_strerror (err));
1175           break;
1176         }
1177       if (n != nrequest)
1178         {
1179           /* That is a protocol violation.  */
1180           xfree (response);
1181           response = error_object_string ("Invalid request:"
1182                                           " short read (%zu of %zu bytes)\n",
1183                                           n, (size_t)nrequest);
1184         }
1185       else /* Process request  */
1186         {
1187           if (opt_debug)
1188             log_debug ("request='%s'\n", request);
1189           xfree (response);
1190           response = process_request (request);
1191           if (opt_debug)
1192             log_debug ("response='%s'\n", response);
1193         }
1194       nresponse = strlen (response);
1195
1196       /* Write response */
1197       if (es_write (es_stdout, &nresponse, sizeof nresponse, &n))
1198         {
1199           err = gpg_error_from_syserror ();
1200           log_error ("error writing request header: %s\n", gpg_strerror (err));
1201           break;
1202         }
1203       if (n != sizeof nrequest)
1204         {
1205           log_error ("error writing request header: short write\n");
1206           break;
1207         }
1208       if (es_write (es_stdout, response, nresponse, &n))
1209         {
1210           err = gpg_error_from_syserror ();
1211           log_error ("error writing request: %s\n", gpg_strerror (err));
1212           break;
1213         }
1214       if (n != nresponse)
1215         {
1216           log_error ("error writing request: short write\n");
1217           break;
1218         }
1219       if (es_fflush (es_stdout) || es_ferror (es_stdout))
1220         {
1221           err = gpg_error_from_syserror ();
1222           log_error ("error writing request: %s\n", gpg_strerror (err));
1223           break;
1224         }
1225     }
1226
1227   xfree (response);
1228   xfree (request);
1229 }
1230
1231
1232 \f
1233 static const char *
1234 my_strusage( int level )
1235 {
1236   const char *p;
1237
1238   switch (level)
1239     {
1240     case  9: p = "LGPL-2.1-or-later"; break;
1241     case 11: p = "gpgme-json"; break;
1242     case 13: p = PACKAGE_VERSION; break;
1243     case 14: p = "Copyright (C) 2018 g10 Code GmbH"; break;
1244     case 19: p = "Please report bugs to <" PACKAGE_BUGREPORT ">.\n"; break;
1245     case 1:
1246     case 40:
1247       p = "Usage: gpgme-json [OPTIONS]";
1248       break;
1249     case 41:
1250       p = "Native messaging based GPGME operations.\n";
1251       break;
1252     case 42:
1253       p = "1"; /* Flag print 40 as part of 41. */
1254       break;
1255     default: p = NULL; break;
1256     }
1257   return p;
1258 }
1259
1260 int
1261 main (int argc, char *argv[])
1262 {
1263 #if GPGRT_VERSION_NUMBER < 0x011d00 /* 1.29 */
1264
1265   fprintf (stderr, "WARNING: Old libgpg-error - using limited mode\n");
1266   native_messaging_repl ();
1267
1268 #else /* This is a modern libgp-error.  */
1269
1270   enum { CMD_DEFAULT     = 0,
1271          CMD_INTERACTIVE = 'i',
1272          CMD_SINGLE      = 's',
1273          CMD_LIBVERSION  = 501,
1274   } cmd = CMD_DEFAULT;
1275   enum {
1276     OPT_DEBUG = 600
1277   };
1278
1279   static gpgrt_opt_t opts[] = {
1280     ARGPARSE_c  (CMD_INTERACTIVE, "interactive", "Interactive REPL"),
1281     ARGPARSE_c  (CMD_SINGLE,      "single",      "Single request mode"),
1282     ARGPARSE_c  (CMD_LIBVERSION,  "lib-version", "Show library version"),
1283     ARGPARSE_s_n(OPT_DEBUG,       "debug",       "Flyswatter"),
1284
1285     ARGPARSE_end()
1286   };
1287   gpgrt_argparse_t pargs = { &argc, &argv};
1288
1289   gpgrt_set_strusage (my_strusage);
1290
1291 #ifdef HAVE_SETLOCALE
1292   setlocale (LC_ALL, "");
1293 #endif
1294   gpgme_check_version (NULL);
1295 #ifdef LC_CTYPE
1296   gpgme_set_locale (NULL, LC_CTYPE, setlocale (LC_CTYPE, NULL));
1297 #endif
1298 #ifdef LC_MESSAGES
1299   gpgme_set_locale (NULL, LC_MESSAGES, setlocale (LC_MESSAGES, NULL));
1300 #endif
1301
1302   while (gpgrt_argparse (NULL, &pargs, opts))
1303     {
1304       switch (pargs.r_opt)
1305         {
1306         case CMD_INTERACTIVE:
1307           opt_interactive = 1;
1308           /* Fall trough.  */
1309         case CMD_SINGLE:
1310         case CMD_LIBVERSION:
1311           cmd = pargs.r_opt;
1312           break;
1313
1314         case OPT_DEBUG: opt_debug = 1; break;
1315
1316         default:
1317           pargs.err = ARGPARSE_PRINT_WARNING;
1318           break;
1319         }
1320     }
1321   gpgrt_argparse (NULL, &pargs, NULL);
1322
1323   if (!opt_debug)
1324     {
1325       const char *s = getenv ("GPGME_JSON_DEBUG");
1326       if (s && atoi (s) > 0)
1327         opt_debug = 1;
1328     }
1329
1330   if (opt_debug)
1331     {
1332       const char *home = getenv ("HOME");
1333       char *file = xstrconcat ("socket://",
1334                                home? home:"/tmp",
1335                                "/.gnupg/S.gpgme-json.log", NULL);
1336       log_set_file (file);
1337       xfree (file);
1338     }
1339
1340   if (opt_debug)
1341     { int i;
1342       for (i=0; argv[i]; i++)
1343         log_debug ("argv[%d]='%s'\n", i, argv[i]);
1344     }
1345
1346   switch (cmd)
1347     {
1348     case CMD_DEFAULT:
1349       native_messaging_repl ();
1350       break;
1351
1352     case CMD_SINGLE:
1353       read_and_process_single_request ();
1354       break;
1355
1356     case CMD_INTERACTIVE:
1357       interactive_repl ();
1358       break;
1359
1360     case CMD_LIBVERSION:
1361       printf ("Version from header: %s (0x%06x)\n",
1362               GPGME_VERSION, GPGME_VERSION_NUMBER);
1363       printf ("Version from binary: %s\n", gpgme_check_version (NULL));
1364       printf ("Copyright blurb ...:%s\n", gpgme_check_version ("\x01\x01"));
1365       break;
1366     }
1367
1368   if (opt_debug)
1369     log_debug ("ready");
1370
1371 #endif /* This is a modern libgp-error.  */
1372   return 0;
1373 }
1374 #endif /* libgpg-error >= 1.28 */