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