json: Build only a dummy if libgpg-error is < 1.28
[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.  CTX is a
358  * GPGME context object.  On success an array with the keys is stored
359  * at R_KEYS.  In failure an error code is returned.  */
360 static gpg_error_t
361 get_keys (gpgme_ctx_t ctx, cjson_t json, gpgme_key_t **r_keys)
362 {
363   gpg_error_t err;
364   cjson_t j_keys, j_item;
365   int i, nkeys;
366   gpgme_key_t *keys;
367
368   *r_keys = NULL;
369
370   j_keys = cJSON_GetObjectItem (json, "keys");
371   if (!j_keys)
372     return gpg_error (GPG_ERR_NO_KEY);
373   if (!cjson_is_array (j_keys) && !cjson_is_string (j_keys))
374     return gpg_error (GPG_ERR_INV_VALUE);
375
376   if (cjson_is_string (j_keys))
377     nkeys = 1;
378   else
379     {
380       nkeys = cJSON_GetArraySize (j_keys);
381       if (!nkeys)
382         return gpg_error (GPG_ERR_NO_KEY);
383       for (i=0; i < nkeys; i++)
384         {
385           j_item = cJSON_GetArrayItem (j_keys, i);
386           if (!j_item || !cjson_is_string (j_item))
387             return gpg_error (GPG_ERR_INV_VALUE);
388         }
389     }
390
391   /* Now allocate an array to store the gpgme key objects.  */
392   keys = xcalloc (nkeys + 1, sizeof *keys);
393
394   if (cjson_is_string (j_keys))
395     {
396       err = gpgme_get_key (ctx, j_keys->valuestring, &keys[0], 0);
397       if (err)
398         goto leave;
399     }
400   else
401     {
402       for (i=0; i < nkeys; i++)
403         {
404           j_item = cJSON_GetArrayItem (j_keys, i);
405           err = gpgme_get_key (ctx, j_item->valuestring, &keys[i], 0);
406           if (err)
407             goto leave;
408         }
409     }
410   err = 0;
411   *r_keys = keys;
412   keys = NULL;
413
414  leave:
415   if (keys)
416     {
417       for (i=0; keys[i]; i++)
418         gpgme_key_unref (keys[i]);
419       xfree (keys);
420     }
421   return err;
422 }
423
424
425 \f
426 /*
427  *  GPGME support functions.
428  */
429
430 /* Helper for get_context.  */
431 static gpgme_ctx_t
432 _create_new_context (gpgme_protocol_t proto)
433 {
434   gpg_error_t err;
435   gpgme_ctx_t ctx;
436
437   err = gpgme_new (&ctx);
438   if (err)
439     log_fatal ("error creating GPGME context: %s\n", gpg_strerror (err));
440   gpgme_set_protocol (ctx, proto);
441   gpgme_set_ctx_flag (ctx, "request-origin", "browser");
442   return ctx;
443 }
444
445
446 /* Return a context object for protocol PROTO.  This is currently a
447  * statuically allocated context initialized for PROTO.  Termnates
448  * process on failure.  */
449 static gpgme_ctx_t
450 get_context (gpgme_protocol_t proto)
451 {
452   static gpgme_ctx_t ctx_openpgp, ctx_cms;
453
454   if (proto == GPGME_PROTOCOL_OpenPGP)
455     {
456       if (!ctx_openpgp)
457         ctx_openpgp = _create_new_context (proto);
458       return ctx_openpgp;
459     }
460   else if (proto == GPGME_PROTOCOL_CMS)
461     {
462       if (!ctx_cms)
463         ctx_cms = _create_new_context (proto);
464       return ctx_cms;
465     }
466   else
467     log_bug ("invalid protocol %d requested\n", proto);
468 }
469
470
471
472 /* Free context object retrieved by get_context.  */
473 static void
474 release_context (gpgme_ctx_t ctx)
475 {
476   /* Nothing to do right now.  */
477   (void)ctx;
478 }
479
480
481
482 /* Given a Base-64 encoded string object in JSON return a gpgme data
483  * object at R_DATA.  */
484 static gpg_error_t
485 data_from_base64_string (gpgme_data_t *r_data, cjson_t json)
486 {
487 #if GPGRT_VERSION_NUMBER < 0x011d00 /* 1.29 */
488   *r_data = NULL;
489   return gpg_error (GPG_ERR_NOT_SUPPORTED);
490 #else
491   gpg_error_t err;
492   size_t len;
493   char *buf = NULL;
494   gpgrt_b64state_t state = NULL;
495   gpgme_data_t data = NULL;
496
497   *r_data = NULL;
498
499   /* A quick check on the JSON.  */
500   if (!cjson_is_string (json))
501     {
502       err = gpg_error (GPG_ERR_INV_VALUE);
503       goto leave;
504     }
505
506   state = gpgrt_b64dec_start (NULL);
507   if (!state)
508     {
509       err = gpg_err_code_from_syserror ();
510       goto leave;
511     }
512
513   /* Fixme: Data duplication - we should see how to snatch the memory
514    * from the json object.  */
515   len = strlen (json->valuestring);
516   buf = xtrystrdup (json->valuestring);
517   if (!buf)
518     {
519       err = gpg_error_from_syserror ();
520       goto leave;
521     }
522
523   err = gpgrt_b64dec_proc (state, buf, len, &len);
524   if (err)
525     goto leave;
526
527   err = gpgrt_b64dec_finish (state);
528   state = NULL;
529   if (err)
530     goto leave;
531
532   err = gpgme_data_new_from_mem (&data, buf, len, 1);
533   if (err)
534     goto leave;
535   *r_data = data;
536   data = NULL;
537
538  leave:
539   xfree (data);
540   xfree (buf);
541   gpgrt_b64dec_finish (state);
542   return err;
543 #endif
544 }
545
546
547 \f
548 /*
549  * Implementaion of the commands.
550  */
551
552
553 static const char hlp_encrypt[] =
554   "op:     \"encrypt\"\n"
555   "keys:   Array of strings with the fingerprints or user-ids\n"
556   "        of the keys to encrypt the data.  For a single key\n"
557   "        a String may be used instead of an array.\n"
558   "data:   Input data. \n"
559   "\n"
560   "Optional parameters:\n"
561   "protocol:      Either \"openpgp\" (default) or \"cms\".\n"
562   "\n"
563   "Optional boolean flags (default is false):\n"
564   "base64:        Input data is base64 encoded.\n"
565   "armor:         Request output in armored format.\n"
566   "always-trust:  Request --always-trust option.\n"
567   "no-encrypt-to: Do not use a default recipient.\n"
568   "no-compress:   Do not compress the plaintext first.\n"
569   "throw-keyids:  Request the --throw-keyids option.\n"
570   "wrap:          Assume the input is an OpenPGP message.\n"
571   "\n"
572   "Response on success:\n"
573   "type:   \"ciphertext\"\n"
574   "data:   Unless armor mode is used a Base64 encoded binary\n"
575   "        ciphertext.  In armor mode a string with an armored\n"
576   "        OpenPGP or a PEM message.\n"
577   "base64: Boolean indicating whether data is base64 encoded.";
578 static gpg_error_t
579 op_encrypt (cjson_t request, cjson_t result)
580 {
581   gpg_error_t err;
582   gpgme_ctx_t ctx = NULL;
583   gpgme_protocol_t protocol;
584   int opt_base64;
585   gpgme_key_t *keys = NULL;
586   cjson_t j_input;
587   gpgme_data_t input = NULL;
588   gpgme_data_t output = NULL;
589   int abool, i;
590   gpgme_encrypt_flags_t encrypt_flags = 0;
591
592   if ((err = get_protocol (request, &protocol)))
593     goto leave;
594   ctx = get_context (protocol);
595
596   if ((err = get_boolean_flag (request, "base64", 0, &opt_base64)))
597     goto leave;
598
599   if ((err = get_boolean_flag (request, "armor", 0, &abool)))
600     goto leave;
601   gpgme_set_armor (ctx, abool);
602   if ((err = get_boolean_flag (request, "always-trust", 0, &abool)))
603     goto leave;
604   if (abool)
605     encrypt_flags |= GPGME_ENCRYPT_ALWAYS_TRUST;
606   if ((err = get_boolean_flag (request, "no-encrypt-to", 0,&abool)))
607     goto leave;
608   if (abool)
609     encrypt_flags |= GPGME_ENCRYPT_NO_ENCRYPT_TO;
610   if ((err = get_boolean_flag (request, "no-compress", 0, &abool)))
611     goto leave;
612   if (abool)
613     encrypt_flags |= GPGME_ENCRYPT_NO_COMPRESS;
614   if ((err = get_boolean_flag (request, "throw-keyids", 0, &abool)))
615     goto leave;
616   if (abool)
617     encrypt_flags |= GPGME_ENCRYPT_THROW_KEYIDS;
618   if ((err = get_boolean_flag (request, "wrap", 0, &abool)))
619     goto leave;
620   if (abool)
621     encrypt_flags |= GPGME_ENCRYPT_WRAP;
622
623
624   /* Get the keys.  */
625   err = get_keys (ctx, request, &keys);
626   if (err)
627     {
628       /* Provide a custom error response.  */
629       error_object (result, "Error getting keys: %s", gpg_strerror (err));
630       goto leave;
631     }
632
633   /* Get the data.  Note that INPUT is a shallow data object with the
634    * storage hold in REQUEST.  */
635   j_input = cJSON_GetObjectItem (request, "data");
636   if (!j_input)
637     {
638       err = gpg_error (GPG_ERR_NO_DATA);
639       goto leave;
640     }
641   if (!cjson_is_string (j_input))
642     {
643       err = gpg_error (GPG_ERR_INV_VALUE);
644       goto leave;
645     }
646   if (opt_base64)
647     {
648       err = data_from_base64_string (&input, j_input);
649       if (err)
650         {
651           error_object (result, "Error decoding Base-64 encoded 'data': %s",
652                         gpg_strerror (err));
653           goto leave;
654         }
655     }
656   else
657     {
658       err = gpgme_data_new_from_mem (&input, j_input->valuestring,
659                                      strlen (j_input->valuestring), 0);
660       if (err)
661         {
662           error_object (result, "Error getting 'data': %s", gpg_strerror (err));
663           goto leave;
664         }
665     }
666
667   /* Create an output data object.  */
668   err = gpgme_data_new (&output);
669   if (err)
670     {
671       error_object (result, "Error creating output data object: %s",
672                     gpg_strerror (err));
673       goto leave;
674     }
675
676   /* Encrypt.  */
677   err = gpgme_op_encrypt (ctx, keys, encrypt_flags, input, output);
678   /* encrypt_result = gpgme_op_encrypt_result (ctx); */
679   if (err)
680     {
681       error_object (result, "Encryption failed: %s", gpg_strerror (err));
682       goto leave;
683     }
684   gpgme_data_release (input);
685   input = NULL;
686
687   xjson_AddStringToObject (result, "type", "ciphertext");
688   /* If armoring is used we do not need to base64 the output.  */
689   xjson_AddBoolToObject (result, "base64", !gpgme_get_armor (ctx));
690   if (gpgme_get_armor (ctx))
691     {
692       char *buffer;
693
694       /* Make sure that we really have a string.  */
695       gpgme_data_write (output, "", 1);
696       buffer = gpgme_data_release_and_get_mem (output, NULL);
697       if (!buffer)
698         {
699           err = gpg_error_from_syserror ();
700           goto leave;
701         }
702       err = cjson_AddStringToObject (result, "data", buffer);
703       gpgme_free (buffer);
704       if (err)
705         goto leave;
706     }
707   else
708     {
709       err = add_base64_to_object (result, "data", output);
710       output = NULL;
711       if (err)
712         goto leave;
713     }
714
715  leave:
716   if (keys)
717     {
718       for (i=0; keys[i]; i++)
719         gpgme_key_unref (keys[i]);
720       xfree (keys);
721     }
722   release_context (ctx);
723   gpgme_data_release (input);
724   return err;
725 }
726
727
728
729 static const char hlp_help[] =
730   "The tool expects a JSON object with the request and responds with\n"
731   "another JSON object.  Even on error a JSON object is returned.  The\n"
732   "property \"op\" is mandatory and its string value selects the\n"
733   "operation; if the property \"help\" with the value \"true\" exists, the\n"
734   "operation is not performned but a string with the documentation\n"
735   "returned.  To list all operations it is allowed to leave out \"op\" in\n"
736   "help mode.  Supported values for \"op\" are:\n\n"
737   "  encrypt     Encrypt data.\n"
738   "  help        Help overview.";
739 static gpg_error_t
740 op_help (cjson_t request, cjson_t result)
741 {
742   cjson_t j_tmp;
743   char *buffer = NULL;
744   const char *msg;
745
746   j_tmp = cJSON_GetObjectItem (request, "interactive_help");
747   if (opt_interactive && j_tmp && cjson_is_string (j_tmp))
748     msg = buffer = xstrconcat (hlp_help, "\n", j_tmp->valuestring, NULL);
749   else
750     msg = hlp_help;
751
752   xjson_AddStringToObject (result, "type", "help");
753   xjson_AddStringToObject (result, "msg", msg);
754
755   xfree (buffer);
756   return 0;
757 }
758
759
760
761 /* Process a request and return the response.  The response is a newly
762  * allocated string or NULL in case of an error.  */
763 static char *
764 process_request (const char *request)
765 {
766   static struct {
767     const char *op;
768     gpg_error_t (*handler)(cjson_t request, cjson_t result);
769     const char * const helpstr;
770   } optbl[] = {
771     { "encrypt", op_encrypt, hlp_encrypt },
772
773
774     { "help",    op_help,    hlp_help },
775     { NULL }
776   };
777   size_t erroff;
778   cjson_t json;
779   cjson_t j_tmp, j_op;
780   cjson_t response;
781   int helpmode;
782   const char *op;
783   char *res;
784   int idx;
785
786   response = xjson_CreateObject ();
787
788   json = cJSON_Parse (request, &erroff);
789   if (!json)
790     {
791       log_string (GPGRT_LOGLVL_INFO, request);
792       log_info ("invalid JSON object at offset %zu\n", erroff);
793       error_object (response, "invalid JSON object at offset %zu\n", erroff);
794       goto leave;
795     }
796
797   j_tmp = cJSON_GetObjectItem (json, "help");
798   helpmode = (j_tmp && cjson_is_true (j_tmp));
799
800   j_op = cJSON_GetObjectItem (json, "op");
801   if (!j_op || !cjson_is_string (j_op))
802     {
803       if (!helpmode)
804         {
805           error_object (response, "Property \"op\" missing");
806           goto leave;
807         }
808       op = "help";  /* Help summary.  */
809     }
810   else
811     op = j_op->valuestring;
812
813   for (idx=0; optbl[idx].op; idx++)
814     if (!strcmp (op, optbl[idx].op))
815       break;
816   if (optbl[idx].op)
817     {
818       if (helpmode && strcmp (op, "help"))
819         {
820           xjson_AddStringToObject (response, "type", "help");
821           xjson_AddStringToObject (response, "op", op);
822           xjson_AddStringToObject (response, "msg", optbl[idx].helpstr);
823         }
824       else
825         {
826           gpg_error_t err;
827
828           err = optbl[idx].handler (json, response);
829           if (err)
830             {
831               if (!(j_tmp = cJSON_GetObjectItem (response, "type"))
832                   || !cjson_is_string (j_tmp)
833                   || strcmp (j_tmp->valuestring, "error"))
834                 {
835                   /* No error type response - provide a generic one.  */
836                   error_object (response, "Operation failed: %s",
837                                 gpg_strerror (err));
838                 }
839
840               xjson_AddStringToObject (response, "op", op);
841             }
842
843         }
844     }
845   else  /* Operation not supported.  */
846     {
847       error_object (response, "Unknown operation '%s'", op);
848       xjson_AddStringToObject (response, "op", op);
849     }
850
851  leave:
852   cJSON_Delete (json);
853   if (opt_interactive)
854     res = cJSON_Print (response);
855   else
856     res = cJSON_PrintUnformatted (response);
857   if (!res)
858     log_error ("Printing JSON data failed\n");
859   cJSON_Delete (response);
860   return res;
861 }
862
863
864 \f
865 /*
866  *  Driver code
867  */
868
869 /* Return a malloced line or NULL on EOF.  Terminate on read
870  * error.  */
871 static char *
872 get_line (void)
873 {
874   char *line = NULL;
875   size_t linesize = 0;
876   gpg_error_t err;
877   size_t maxlength = 2048;
878   int n;
879   const char *s;
880   char *p;
881
882  again:
883   n = es_read_line (es_stdin, &line, &linesize, &maxlength);
884   if (n < 0)
885     {
886       err = gpg_error_from_syserror ();
887       log_error ("error reading line: %s\n", gpg_strerror (err));
888       exit (1);
889     }
890   if (!n)
891     {
892       xfree (line);
893       line = NULL;
894       return NULL;  /* EOF */
895     }
896   if (!maxlength)
897     {
898       log_info ("line too long - skipped\n");
899       goto again;
900     }
901   if (memchr (line, 0, n))
902     log_info ("warning: line shortened due to embedded Nul character\n");
903
904   if (line[n-1] == '\n')
905     line[n-1] = 0;
906
907   /* Trim leading spaces.  */
908   for (s=line; spacep (s); s++)
909     ;
910   if (s != line)
911     {
912       for (p=line; *s;)
913         *p++ = *s++;
914       *p = 0;
915       n = p - line;
916     }
917
918   return line;
919 }
920
921
922 /* Process meta commands used with the standard REPL.  */
923 static char *
924 process_meta_commands (const char *request)
925 {
926   char *result = NULL;
927
928   while (spacep (request))
929     request++;
930
931   if (!strncmp (request, "help", 4) && (spacep (request+4) || !request[4]))
932     result = process_request ("{ \"op\": \"help\","
933                               " \"interactive_help\": "
934                               "\"\\nMeta commands:\\n"
935                               "  ,help       This help\\n"
936                               "  ,quit       Terminate process\""
937                               "}");
938   else if (!strncmp (request, "quit", 4) && (spacep (request+4) || !request[4]))
939     exit (0);
940   else
941     log_info ("invalid meta command\n");
942
943   return result;
944 }
945
946
947 /* If STRING has a help response, return the MSG property in a human
948  * readable format.  */
949 static char *
950 get_help_msg (const char *string)
951 {
952   cjson_t json, j_type, j_msg;
953   const char *msg;
954   char *buffer = NULL;
955   char *p;
956
957   json = cJSON_Parse (string, NULL);
958   if (json)
959     {
960       j_type = cJSON_GetObjectItem (json, "type");
961       if (j_type && cjson_is_string (j_type)
962           && !strcmp (j_type->valuestring, "help"))
963         {
964           j_msg = cJSON_GetObjectItem (json, "msg");
965           if (j_msg || cjson_is_string (j_msg))
966             {
967               msg = j_msg->valuestring;
968               buffer = malloc (strlen (msg)+1);
969               if (buffer)
970                 {
971                   for (p=buffer; *msg; msg++)
972                     {
973                       if (*msg == '\\' && msg[1] == '\n')
974                         *p++ = '\n';
975                       else
976                         *p++ = *msg;
977                     }
978                   *p = 0;
979                 }
980             }
981         }
982       cJSON_Delete (json);
983     }
984   return buffer;
985 }
986
987
988 /* An interactive standard REPL.  */
989 static void
990 interactive_repl (void)
991 {
992   char *line = NULL;
993   char *request = NULL;
994   char *response = NULL;
995   char *p;
996   int first;
997
998   es_setvbuf (es_stdin, NULL, _IONBF, 0);
999 #if GPGRT_VERSION_NUMBER >= 0x011d00 /* 1.29 */
1000   es_fprintf (es_stderr, "%s %s ready (enter \",help\" for help)\n",
1001               gpgrt_strusage (11), gpgrt_strusage (13));
1002 #endif
1003   do
1004     {
1005       es_fputs ("> ", es_stderr);
1006       es_fflush (es_stderr);
1007       es_fflush (es_stdout);
1008       xfree (line);
1009       line = get_line ();
1010       es_fflush (es_stderr);
1011       es_fflush (es_stdout);
1012
1013       first = !request;
1014       if (line && *line)
1015         {
1016           if (!request)
1017             request = xstrdup (line);
1018           else
1019             request = xstrconcat (request, "\n", line, NULL);
1020         }
1021
1022       if (!line)
1023         es_fputs ("\n", es_stderr);
1024
1025       if (!line || !*line || (first && *request == ','))
1026         {
1027           /* Process the input.  */
1028           xfree (response);
1029           response = NULL;
1030           if (request && *request == ',')
1031             {
1032               response = process_meta_commands (request+1);
1033             }
1034           else if (request)
1035             {
1036               response = process_request (request);
1037             }
1038           xfree (request);
1039           request = NULL;
1040
1041           if (response)
1042             {
1043               if (opt_interactive)
1044                 {
1045                   char *msg = get_help_msg (response);
1046                   if (msg)
1047                     {
1048                       xfree (response);
1049                       response = msg;
1050                     }
1051                 }
1052
1053               es_fputs ("===> ", es_stderr);
1054               es_fflush (es_stderr);
1055               for (p=response; *p; p++)
1056                 {
1057                   if (*p == '\n')
1058                     {
1059                       es_fflush (es_stdout);
1060                       es_fputs ("\n===> ", es_stderr);
1061                       es_fflush (es_stderr);
1062                     }
1063                   else
1064                     es_putc (*p, es_stdout);
1065                 }
1066               es_fflush (es_stdout);
1067               es_fputs ("\n", es_stderr);
1068             }
1069         }
1070     }
1071   while (line);
1072
1073   xfree (request);
1074   xfree (response);
1075   xfree (line);
1076 }
1077
1078
1079 /* Read and process a single request.  */
1080 static void
1081 read_and_process_single_request (void)
1082 {
1083   char *line = NULL;
1084   char *request = NULL;
1085   char *response = NULL;
1086   size_t n;
1087
1088   for (;;)
1089     {
1090       xfree (line);
1091       line = get_line ();
1092       if (line && *line)
1093         request = (request? xstrconcat (request, "\n", line, NULL)
1094                    /**/   : xstrdup (line));
1095       if (!line)
1096         {
1097           if (request)
1098             {
1099               xfree (response);
1100               response = process_request (request);
1101               if (response)
1102                 {
1103                   es_fputs (response, es_stdout);
1104                   if ((n = strlen (response)) && response[n-1] != '\n')
1105                     es_fputc ('\n', es_stdout);
1106                 }
1107               es_fflush (es_stdout);
1108             }
1109           break;
1110         }
1111     }
1112
1113   xfree (response);
1114   xfree (request);
1115   xfree (line);
1116 }
1117
1118
1119 /* The Native Messaging processing loop.  */
1120 static void
1121 native_messaging_repl (void)
1122 {
1123   gpg_error_t err;
1124   uint32_t nrequest, nresponse;
1125   char *request = NULL;
1126   char *response = NULL;
1127   size_t n;
1128
1129   /* Due to the length octets we need to switch the I/O stream into
1130    * binary mode.  */
1131   es_set_binary (es_stdin);
1132   es_set_binary (es_stdout);
1133   es_setbuf (es_stdin, NULL);  /* stdin needs to be unbuffered! */
1134
1135   for (;;)
1136     {
1137       /* Read length.  Note that the protocol uses native endianess.
1138        * Is it allowed to call such a thing a well thought out
1139        * protocol?  */
1140       if (es_read (es_stdin, &nrequest, sizeof nrequest, &n))
1141         {
1142           err = gpg_error_from_syserror ();
1143           log_error ("error reading request header: %s\n", gpg_strerror (err));
1144           break;
1145         }
1146       if (!n)
1147         break;  /* EOF */
1148       if (n != sizeof nrequest)
1149         {
1150           log_error ("error reading request header: short read\n");
1151           break;
1152         }
1153       if (nrequest > MAX_REQUEST_SIZE)
1154         {
1155           log_error ("error reading request: request too long (%zu MiB)\n",
1156                      (size_t)nrequest / (1024*1024));
1157           /* Fixme: Shall we read the request to the bit bucket and
1158            * return an error reponse or just return an error reponse
1159            * and terminate?  Needs some testing.  */
1160           break;
1161         }
1162
1163       /* Read request.  */
1164       request = xtrymalloc (nrequest);
1165       if (!request)
1166         {
1167           err = gpg_error_from_syserror ();
1168           log_error ("error reading request: Not enough memory for %zu MiB)\n",
1169                      (size_t)nrequest / (1024*1024));
1170           /* FIXME: See comment above.  */
1171           break;
1172         }
1173       if (es_read (es_stdin, request, nrequest, &n))
1174         {
1175           err = gpg_error_from_syserror ();
1176           log_error ("error reading request: %s\n", gpg_strerror (err));
1177           break;
1178         }
1179       if (n != nrequest)
1180         {
1181           /* That is a protocol violation.  */
1182           xfree (response);
1183           response = error_object_string ("Invalid request:"
1184                                           " short read (%zu of %zu bytes)\n",
1185                                           n, (size_t)nrequest);
1186         }
1187       else /* Process request  */
1188         {
1189           if (opt_debug)
1190             log_debug ("request='%s'\n", request);
1191           xfree (response);
1192           response = process_request (request);
1193           if (opt_debug)
1194             log_debug ("response='%s'\n", response);
1195         }
1196       nresponse = strlen (response);
1197
1198       /* Write response */
1199       if (es_write (es_stdout, &nresponse, sizeof nresponse, &n))
1200         {
1201           err = gpg_error_from_syserror ();
1202           log_error ("error writing request header: %s\n", gpg_strerror (err));
1203           break;
1204         }
1205       if (n != sizeof nrequest)
1206         {
1207           log_error ("error writing request header: short write\n");
1208           break;
1209         }
1210       if (es_write (es_stdout, response, nresponse, &n))
1211         {
1212           err = gpg_error_from_syserror ();
1213           log_error ("error writing request: %s\n", gpg_strerror (err));
1214           break;
1215         }
1216       if (n != nresponse)
1217         {
1218           log_error ("error writing request: short write\n");
1219           break;
1220         }
1221       if (es_fflush (es_stdout) || es_ferror (es_stdout))
1222         {
1223           err = gpg_error_from_syserror ();
1224           log_error ("error writing request: %s\n", gpg_strerror (err));
1225           break;
1226         }
1227     }
1228
1229   xfree (response);
1230   xfree (request);
1231 }
1232
1233
1234 \f
1235 static const char *
1236 my_strusage( int level )
1237 {
1238   const char *p;
1239
1240   switch (level)
1241     {
1242     case  9: p = "LGPL-2.1-or-later"; break;
1243     case 11: p = "gpgme-json"; break;
1244     case 13: p = PACKAGE_VERSION; break;
1245     case 14: p = "Copyright (C) 2018 g10 Code GmbH"; break;
1246     case 19: p = "Please report bugs to <" PACKAGE_BUGREPORT ">.\n"; break;
1247     case 1:
1248     case 40:
1249       p = "Usage: gpgme-json [OPTIONS]";
1250       break;
1251     case 41:
1252       p = "Native messaging based GPGME operations.\n";
1253       break;
1254     case 42:
1255       p = "1"; /* Flag print 40 as part of 41. */
1256       break;
1257     default: p = NULL; break;
1258     }
1259   return p;
1260 }
1261
1262 int
1263 main (int argc, char *argv[])
1264 {
1265 #if GPGRT_VERSION_NUMBER < 0x011d00 /* 1.29 */
1266
1267   fprintf (stderr, "WARNING: Old libgpg-error - using limited mode\n");
1268   native_messaging_repl ();
1269
1270 #else /* This is a modern libgp-error.  */
1271
1272   enum { CMD_DEFAULT     = 0,
1273          CMD_INTERACTIVE = 'i',
1274          CMD_SINGLE      = 's',
1275          CMD_LIBVERSION  = 501,
1276   } cmd = CMD_DEFAULT;
1277   enum {
1278     OPT_DEBUG = 600
1279   };
1280
1281   static gpgrt_opt_t opts[] = {
1282     ARGPARSE_c  (CMD_INTERACTIVE, "interactive", "Interactive REPL"),
1283     ARGPARSE_c  (CMD_SINGLE,      "single",      "Single request mode"),
1284     ARGPARSE_c  (CMD_LIBVERSION,  "lib-version", "Show library version"),
1285     ARGPARSE_s_n(OPT_DEBUG,       "debug",       "Flyswatter"),
1286
1287     ARGPARSE_end()
1288   };
1289   gpgrt_argparse_t pargs = { &argc, &argv};
1290
1291   gpgrt_set_strusage (my_strusage);
1292
1293 #ifdef HAVE_SETLOCALE
1294   setlocale (LC_ALL, "");
1295 #endif
1296   gpgme_check_version (NULL);
1297 #ifdef LC_CTYPE
1298   gpgme_set_locale (NULL, LC_CTYPE, setlocale (LC_CTYPE, NULL));
1299 #endif
1300 #ifdef LC_MESSAGES
1301   gpgme_set_locale (NULL, LC_MESSAGES, setlocale (LC_MESSAGES, NULL));
1302 #endif
1303
1304   while (gpgrt_argparse (NULL, &pargs, opts))
1305     {
1306       switch (pargs.r_opt)
1307         {
1308         case CMD_INTERACTIVE:
1309           opt_interactive = 1;
1310           /* Fall trough.  */
1311         case CMD_SINGLE:
1312         case CMD_LIBVERSION:
1313           cmd = pargs.r_opt;
1314           break;
1315
1316         case OPT_DEBUG: opt_debug = 1; break;
1317
1318         default:
1319           pargs.err = ARGPARSE_PRINT_WARNING;
1320           break;
1321         }
1322     }
1323   gpgrt_argparse (NULL, &pargs, NULL);
1324
1325   if (!opt_debug)
1326     {
1327       const char *s = getenv ("GPGME_JSON_DEBUG");
1328       if (s && atoi (s) > 0)
1329         opt_debug = 1;
1330     }
1331
1332   if (opt_debug)
1333     {
1334       const char *home = getenv ("HOME");
1335       char *file = xstrconcat ("socket://",
1336                                home? home:"/tmp",
1337                                "/.gnupg/S.gpgme-json.log", NULL);
1338       log_set_file (file);
1339       xfree (file);
1340     }
1341
1342   if (opt_debug)
1343     { int i;
1344       for (i=0; argv[i]; i++)
1345         log_debug ("argv[%d]='%s'\n", i, argv[i]);
1346     }
1347
1348   switch (cmd)
1349     {
1350     case CMD_DEFAULT:
1351       native_messaging_repl ();
1352       break;
1353
1354     case CMD_SINGLE:
1355       read_and_process_single_request ();
1356       break;
1357
1358     case CMD_INTERACTIVE:
1359       interactive_repl ();
1360       break;
1361
1362     case CMD_LIBVERSION:
1363       printf ("Version from header: %s (0x%06x)\n",
1364               GPGME_VERSION, GPGME_VERSION_NUMBER);
1365       printf ("Version from binary: %s\n", gpgme_check_version (NULL));
1366       printf ("Copyright blurb ...:%s\n", gpgme_check_version ("\x01\x01"));
1367       break;
1368     }
1369
1370   if (opt_debug)
1371     log_debug ("ready");
1372
1373 #endif /* This is a modern libgp-error.  */
1374   return 0;
1375 }
1376 #endif /* libgpg-error >= 1.28 */