Blame src/encrypt.c

Packit d7e8d0
/* encrypt.c - Encrypt function.
Packit Service 30b792
 * Copyright (C) 2000 Werner Koch (dd9jn)
Packit Service 30b792
 * Copyright (C) 2001, 2002, 2003, 2004 g10 Code GmbH
Packit Service 30b792
 *
Packit Service 30b792
 * This file is part of GPGME.
Packit Service 30b792
 *
Packit Service 30b792
 * GPGME is free software; you can redistribute it and/or modify it
Packit Service 30b792
 * under the terms of the GNU Lesser General Public License as
Packit Service 30b792
 * published by the Free Software Foundation; either version 2.1 of
Packit Service 30b792
 * the License, or (at your option) any later version.
Packit Service 30b792
 *
Packit Service 30b792
 * GPGME is distributed in the hope that it will be useful, but
Packit Service 30b792
 * WITHOUT ANY WARRANTY; without even the implied warranty of
Packit Service 30b792
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit Service 30b792
 * Lesser General Public License for more details.
Packit Service 30b792
 *
Packit Service 30b792
 * You should have received a copy of the GNU Lesser General Public
Packit Service 30b792
 * License along with this program; if not, see <https://gnu.org/licenses/>.
Packit Service 30b792
 * SPDX-License-Identifier: LGPL-2.1-or-later
Packit Service 30b792
 */
Packit d7e8d0
Packit d7e8d0
#if HAVE_CONFIG_H
Packit d7e8d0
#include <config.h>
Packit d7e8d0
#endif
Packit d7e8d0
#include <stdlib.h>
Packit d7e8d0
#include <string.h>
Packit d7e8d0
#include <errno.h>
Packit d7e8d0
Packit d7e8d0
#include "gpgme.h"
Packit d7e8d0
#include "debug.h"
Packit d7e8d0
#include "context.h"
Packit d7e8d0
#include "ops.h"
Packit d7e8d0
Packit d7e8d0

Packit d7e8d0
typedef struct
Packit d7e8d0
{
Packit d7e8d0
  struct _gpgme_op_encrypt_result result;
Packit d7e8d0
Packit d7e8d0
  /* The error code from a FAILURE status line or 0.  */
Packit d7e8d0
  gpg_error_t failure_code;
Packit d7e8d0
Packit d7e8d0
  /* The fingerprint from the last KEY_CONSIDERED status line.  */
Packit d7e8d0
  char *kc_fpr;
Packit d7e8d0
Packit d7e8d0
  /* The flags from the last KEY_CONSIDERED status line.  */
Packit d7e8d0
  unsigned int kc_flags;
Packit d7e8d0
Packit d7e8d0
  /* A pointer to the next pointer of the last invalid recipient in
Packit d7e8d0
     the list.  This makes appending new invalid recipients painless
Packit d7e8d0
     while preserving the order.  */
Packit d7e8d0
  gpgme_invalid_key_t *lastp;
Packit d7e8d0
} *op_data_t;
Packit d7e8d0
Packit d7e8d0
Packit d7e8d0
static void
Packit d7e8d0
release_op_data (void *hook)
Packit d7e8d0
{
Packit d7e8d0
  op_data_t opd = (op_data_t) hook;
Packit d7e8d0
  gpgme_invalid_key_t invalid_recipient = opd->result.invalid_recipients;
Packit d7e8d0
Packit d7e8d0
  while (invalid_recipient)
Packit d7e8d0
    {
Packit d7e8d0
      gpgme_invalid_key_t next = invalid_recipient->next;
Packit d7e8d0
      if (invalid_recipient->fpr)
Packit d7e8d0
	free (invalid_recipient->fpr);
Packit d7e8d0
      free (invalid_recipient);
Packit d7e8d0
      invalid_recipient = next;
Packit d7e8d0
    }
Packit d7e8d0
Packit d7e8d0
  free (opd->kc_fpr);
Packit d7e8d0
}
Packit d7e8d0
Packit d7e8d0
Packit d7e8d0
gpgme_encrypt_result_t
Packit d7e8d0
gpgme_op_encrypt_result (gpgme_ctx_t ctx)
Packit d7e8d0
{
Packit d7e8d0
  void *hook;
Packit d7e8d0
  op_data_t opd;
Packit d7e8d0
  gpgme_error_t err;
Packit d7e8d0
Packit Service 30b792
  TRACE_BEG (DEBUG_CTX, "gpgme_op_encrypt_result", ctx, "");
Packit d7e8d0
Packit d7e8d0
  err = _gpgme_op_data_lookup (ctx, OPDATA_ENCRYPT, &hook, -1, NULL);
Packit d7e8d0
  opd = hook;
Packit d7e8d0
Packit d7e8d0
  if (err || !opd)
Packit d7e8d0
    {
Packit Service 30b792
      TRACE_SUC ("result=(null)");
Packit d7e8d0
      return NULL;
Packit d7e8d0
    }
Packit d7e8d0
Packit d7e8d0
  if (_gpgme_debug_trace ())
Packit d7e8d0
    {
Packit d7e8d0
      gpgme_invalid_key_t invkeys = opd->result.invalid_recipients;
Packit d7e8d0
      int i = 0;
Packit d7e8d0
Packit d7e8d0
      while (invkeys)
Packit d7e8d0
	{
Packit Service 30b792
	  TRACE_LOG  ("invalid_recipients[%i] = %s (%s)",
Packit d7e8d0
		      i, invkeys->fpr ? invkeys->fpr : "(null)",
Packit d7e8d0
		      gpg_strerror (invkeys->reason));
Packit d7e8d0
	  invkeys = invkeys->next;
Packit d7e8d0
	  i++;
Packit d7e8d0
	}
Packit d7e8d0
    }
Packit d7e8d0
Packit Service 30b792
  TRACE_SUC ("result=%p", &opd->result);
Packit d7e8d0
  return &opd->result;
Packit d7e8d0
}
Packit d7e8d0
Packit d7e8d0

Packit d7e8d0
gpgme_error_t
Packit d7e8d0
_gpgme_encrypt_status_handler (void *priv, gpgme_status_code_t code,
Packit d7e8d0
			       char *args)
Packit d7e8d0
{
Packit d7e8d0
  gpgme_ctx_t ctx = (gpgme_ctx_t) priv;
Packit d7e8d0
  gpgme_error_t err;
Packit d7e8d0
  void *hook;
Packit d7e8d0
  op_data_t opd;
Packit d7e8d0
Packit d7e8d0
  err = _gpgme_op_data_lookup (ctx, OPDATA_ENCRYPT, &hook, -1, NULL);
Packit d7e8d0
  opd = hook;
Packit d7e8d0
  if (err)
Packit d7e8d0
    return err;
Packit d7e8d0
Packit d7e8d0
  switch (code)
Packit d7e8d0
    {
Packit d7e8d0
    case GPGME_STATUS_FAILURE:
Packit d7e8d0
      opd->failure_code = _gpgme_parse_failure (args);
Packit d7e8d0
      break;
Packit d7e8d0
Packit d7e8d0
    case GPGME_STATUS_EOF:
Packit d7e8d0
      if (opd->result.invalid_recipients)
Packit d7e8d0
	return gpg_error (GPG_ERR_UNUSABLE_PUBKEY);
Packit d7e8d0
      if (opd->failure_code)
Packit d7e8d0
        return opd->failure_code;
Packit d7e8d0
      break;
Packit d7e8d0
Packit d7e8d0
    case GPGME_STATUS_KEY_CONSIDERED:
Packit d7e8d0
      /* This is emitted during gpg's key lookup to give information
Packit d7e8d0
       * about the lookup results.  We store the last one so it can be
Packit d7e8d0
       * used in connection with INV_RECP.  */
Packit d7e8d0
      free (opd->kc_fpr);
Packit d7e8d0
      opd->kc_fpr = NULL;
Packit d7e8d0
      err = _gpgme_parse_key_considered (args, &opd->kc_fpr, &opd->kc_flags);
Packit d7e8d0
      if (err)
Packit d7e8d0
        return err;
Packit d7e8d0
      break;
Packit d7e8d0
Packit d7e8d0
    case GPGME_STATUS_INV_RECP:
Packit d7e8d0
      err = _gpgme_parse_inv_recp (args, 0, opd->kc_fpr, opd->kc_flags,
Packit d7e8d0
                                   opd->lastp);
Packit d7e8d0
      if (err)
Packit d7e8d0
        return err;
Packit d7e8d0
Packit d7e8d0
      opd->lastp = &(*opd->lastp)->next;
Packit d7e8d0
      free (opd->kc_fpr);
Packit d7e8d0
      opd->kc_fpr = NULL;
Packit d7e8d0
      break;
Packit d7e8d0
Packit d7e8d0
    case GPGME_STATUS_NO_RECP:
Packit d7e8d0
      /* Should not happen, because we require at least one recipient.  */
Packit d7e8d0
      return gpg_error (GPG_ERR_GENERAL);
Packit d7e8d0
Packit d7e8d0
    default:
Packit d7e8d0
      break;
Packit d7e8d0
    }
Packit d7e8d0
  return 0;
Packit d7e8d0
}
Packit d7e8d0
Packit d7e8d0
Packit d7e8d0
static gpgme_error_t
Packit d7e8d0
encrypt_sym_status_handler (void *priv, gpgme_status_code_t code, char *args)
Packit d7e8d0
{
Packit d7e8d0
  gpgme_error_t err;
Packit d7e8d0
Packit d7e8d0
  err = _gpgme_progress_status_handler (priv, code, args);
Packit d7e8d0
  if (!err)
Packit d7e8d0
    err = _gpgme_passphrase_status_handler (priv, code, args);
Packit d7e8d0
  return err;
Packit d7e8d0
}
Packit d7e8d0
Packit d7e8d0
Packit d7e8d0
static gpgme_error_t
Packit d7e8d0
encrypt_status_handler (void *priv, gpgme_status_code_t code, char *args)
Packit d7e8d0
{
Packit d7e8d0
  gpgme_error_t err;
Packit d7e8d0
Packit d7e8d0
  err = _gpgme_progress_status_handler (priv, code, args);
Packit d7e8d0
  if (!err)
Packit d7e8d0
    err = _gpgme_encrypt_status_handler (priv, code, args);
Packit d7e8d0
Packit d7e8d0
  return err;
Packit d7e8d0
}
Packit d7e8d0
Packit d7e8d0
Packit d7e8d0
gpgme_error_t
Packit d7e8d0
_gpgme_op_encrypt_init_result (gpgme_ctx_t ctx)
Packit d7e8d0
{
Packit d7e8d0
  gpgme_error_t err;
Packit d7e8d0
  void *hook;
Packit d7e8d0
  op_data_t opd;
Packit d7e8d0
Packit d7e8d0
  err = _gpgme_op_data_lookup (ctx, OPDATA_ENCRYPT, &hook, sizeof (*opd),
Packit d7e8d0
			       release_op_data);
Packit d7e8d0
  opd = hook;
Packit d7e8d0
  if (err)
Packit d7e8d0
    return err;
Packit d7e8d0
Packit d7e8d0
  opd->lastp = &opd->result.invalid_recipients;
Packit d7e8d0
  return 0;
Packit d7e8d0
}
Packit d7e8d0
Packit d7e8d0
Packit d7e8d0
static gpgme_error_t
Packit d7e8d0
encrypt_start (gpgme_ctx_t ctx, int synchronous, gpgme_key_t recp[],
Packit Service 30b792
               const char *recpstring,
Packit d7e8d0
	       gpgme_encrypt_flags_t flags,
Packit d7e8d0
	       gpgme_data_t plain, gpgme_data_t cipher)
Packit d7e8d0
{
Packit d7e8d0
  gpgme_error_t err;
Packit d7e8d0
  int symmetric = 0;
Packit d7e8d0
Packit d7e8d0
  err = _gpgme_op_reset (ctx, synchronous);
Packit d7e8d0
  if (err)
Packit d7e8d0
    return err;
Packit d7e8d0
Packit d7e8d0
  err = _gpgme_op_encrypt_init_result (ctx);
Packit d7e8d0
  if (err)
Packit d7e8d0
    return err;
Packit d7e8d0
Packit Service 30b792
  symmetric = (!recp && !recpstring) || (flags & GPGME_ENCRYPT_SYMMETRIC);
Packit d7e8d0
Packit d7e8d0
  if (!plain)
Packit d7e8d0
    return gpg_error (GPG_ERR_NO_DATA);
Packit d7e8d0
  if (!cipher)
Packit d7e8d0
    return gpg_error (GPG_ERR_INV_VALUE);
Packit Service 30b792
  if (recp && !*recp)
Packit d7e8d0
    return gpg_error (GPG_ERR_INV_VALUE);
Packit d7e8d0
Packit d7e8d0
  if (symmetric && ctx->passphrase_cb)
Packit d7e8d0
    {
Packit d7e8d0
      /* Symmetric encryption requires a passphrase.  */
Packit d7e8d0
      err = _gpgme_engine_set_command_handler
Packit Service 30b792
	(ctx->engine, _gpgme_passphrase_command_handler, ctx);
Packit d7e8d0
      if (err)
Packit d7e8d0
	return err;
Packit d7e8d0
    }
Packit d7e8d0
Packit d7e8d0
  _gpgme_engine_set_status_handler (ctx->engine,
Packit d7e8d0
				    symmetric
Packit d7e8d0
				    ? encrypt_sym_status_handler
Packit d7e8d0
				    : encrypt_status_handler,
Packit d7e8d0
				    ctx);
Packit d7e8d0
Packit Service 30b792
  return _gpgme_engine_op_encrypt (ctx->engine, recp, recpstring,
Packit Service 30b792
                                   flags, plain, cipher, ctx->use_armor);
Packit Service 30b792
}
Packit Service 30b792
Packit Service 30b792
Packit Service 30b792
/* Old version of gpgme_op_encrypt_ext without RECPSTRING.  */
Packit Service 30b792
gpgme_error_t
Packit Service 30b792
gpgme_op_encrypt (gpgme_ctx_t ctx, gpgme_key_t recp[],
Packit Service 30b792
		  gpgme_encrypt_flags_t flags,
Packit Service 30b792
		  gpgme_data_t plain, gpgme_data_t cipher)
Packit Service 30b792
{
Packit Service 30b792
  return gpgme_op_encrypt_ext (ctx, recp, NULL, flags, plain, cipher);
Packit d7e8d0
}
Packit d7e8d0
Packit d7e8d0
Packit Service 30b792
/* Old version of gpgme_op_encrypt_ext_start without RECPSTRING.  */
Packit d7e8d0
gpgme_error_t
Packit d7e8d0
gpgme_op_encrypt_start (gpgme_ctx_t ctx, gpgme_key_t recp[],
Packit d7e8d0
			gpgme_encrypt_flags_t flags,
Packit d7e8d0
			gpgme_data_t plain, gpgme_data_t cipher)
Packit d7e8d0
{
Packit Service 30b792
  return gpgme_op_encrypt_ext_start (ctx, recp, NULL, flags, plain, cipher);
Packit Service 30b792
}
Packit Service 30b792
Packit Service 30b792
Packit Service 30b792
/* Encrypt plaintext PLAIN within CTX for the recipients RECP and
Packit Service 30b792
 * store the resulting ciphertext in CIPHER.  RECPSTRING can be used
Packit Service 30b792
 * instead of the RECP array to directly specify recipients as LF
Packit Service 30b792
 * delimited strings; these may be any kind of recipient specification
Packit Service 30b792
 * patterns as supported by the backend.  */
Packit Service 30b792
gpgme_error_t
Packit Service 30b792
gpgme_op_encrypt_ext (gpgme_ctx_t ctx, gpgme_key_t recp[],
Packit Service 30b792
                      const char *recpstring,
Packit Service 30b792
                      gpgme_encrypt_flags_t flags,
Packit Service 30b792
                      gpgme_data_t plain, gpgme_data_t cipher)
Packit Service 30b792
{
Packit d7e8d0
  gpgme_error_t err;
Packit d7e8d0
Packit Service 30b792
  TRACE_BEG  (DEBUG_CTX, "gpgme_op_encrypt", ctx,
Packit d7e8d0
	      "flags=0x%x, plain=%p, cipher=%p", flags, plain, cipher);
Packit d7e8d0
Packit d7e8d0
  if (!ctx)
Packit d7e8d0
    return TRACE_ERR (gpg_error (GPG_ERR_INV_VALUE));
Packit d7e8d0
Packit Service 30b792
  if (_gpgme_debug_trace () && (recp || recpstring))
Packit d7e8d0
    {
Packit Service 30b792
      if (recp)
Packit Service 30b792
        {
Packit Service 30b792
          int i = 0;
Packit d7e8d0
Packit Service 30b792
          while (recp[i])
Packit Service 30b792
            {
Packit Service 30b792
              TRACE_LOG  ("recipient[%i] = %p (%s)", i, recp[i],
Packit d7e8d0
		      (recp[i]->subkeys && recp[i]->subkeys->fpr) ?
Packit Service 30b792
                          recp[i]->subkeys->fpr : "invalid");
Packit Service 30b792
              i++;
Packit Service 30b792
            }
Packit Service 30b792
        }
Packit Service 30b792
      else
Packit Service 30b792
        {
Packit Service 30b792
          TRACE_LOG  ("recipients = '%s'", recpstring);
Packit Service 30b792
        }
Packit d7e8d0
    }
Packit d7e8d0
Packit Service 30b792
  err = encrypt_start (ctx, 1, recp, recpstring, flags, plain, cipher);
Packit Service 30b792
  if (!err)
Packit Service 30b792
    err = _gpgme_wait_one (ctx);
Packit d7e8d0
  return TRACE_ERR (err);
Packit d7e8d0
}
Packit d7e8d0
Packit d7e8d0
Packit d7e8d0
gpgme_error_t
Packit Service 30b792
gpgme_op_encrypt_ext_start (gpgme_ctx_t ctx, gpgme_key_t recp[],
Packit Service 30b792
                            const char *recpstring,
Packit Service 30b792
                            gpgme_encrypt_flags_t flags,
Packit Service 30b792
                            gpgme_data_t plain, gpgme_data_t cipher)
Packit d7e8d0
{
Packit d7e8d0
  gpgme_error_t err;
Packit d7e8d0
Packit Service 30b792
  TRACE_BEG  (DEBUG_CTX, "gpgme_op_encrypt_start", ctx,
Packit d7e8d0
	      "flags=0x%x, plain=%p, cipher=%p", flags, plain, cipher);
Packit d7e8d0
Packit d7e8d0
  if (!ctx)
Packit d7e8d0
    return TRACE_ERR (gpg_error (GPG_ERR_INV_VALUE));
Packit d7e8d0
Packit Service 30b792
  if (_gpgme_debug_trace () && (recp || recpstring))
Packit d7e8d0
    {
Packit Service 30b792
      if (recp)
Packit Service 30b792
        {
Packit Service 30b792
          int i = 0;
Packit Service 30b792
Packit Service 30b792
          while (recp[i])
Packit Service 30b792
            {
Packit Service 30b792
              TRACE_LOG  ("recipient[%i] = %p (%s)", i, recp[i],
Packit Service 30b792
                          (recp[i]->subkeys && recp[i]->subkeys->fpr) ?
Packit Service 30b792
                          recp[i]->subkeys->fpr : "invalid");
Packit Service 30b792
              i++;
Packit Service 30b792
            }
Packit Service 30b792
        }
Packit Service 30b792
      else
Packit Service 30b792
        {
Packit Service 30b792
          TRACE_LOG  ("recipients = '%s'", recpstring);
Packit Service 30b792
        }
Packit d7e8d0
    }
Packit d7e8d0
Packit Service 30b792
  err = encrypt_start (ctx, 0, recp, recpstring, flags, plain, cipher);
Packit d7e8d0
  return TRACE_ERR (err);
Packit d7e8d0
}