pgpinvoke.c File Reference

Wrapper around calls to external PGP program. More...

#include "config.h"
#include <fcntl.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <unistd.h>
#include "mutt/lib.h"
#include "address/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "pgpinvoke.h"
#include "lib.h"
#include "format_flags.h"
#include "globals.h"
#include "mutt_logging.h"
#include "muttlib.h"
#include "pgpkey.h"
#include "protos.h"
#include "pgp.h"

Include dependency graph for pgpinvoke.c:

Go to the source code of this file.

Data Structures
struct	PgpCommandContext
	Data for a PGP command. More...

Functions
static const char *	pgp_command_format_str (char *buf, size_t buflen, size_t col, int cols, char op, const char *src, const char *prec, const char *if_str, const char *else_str, intptr_t data, MuttFormatFlags flags)
	Format a PGP command string - Implements format_t -.
static void	mutt_pgp_command (char *buf, size_t buflen, struct PgpCommandContext *cctx, const char *fmt)
	Prepare a PGP Command.
static pid_t	pgp_invoke (FILE **fp_pgp_in, FILE **fp_pgp_out, FILE **fp_pgp_err, int fd_pgp_in, int fd_pgp_out, int fd_pgp_err, bool need_passphrase, const char *fname, const char *sig_fname, const char *ids, const char *format)
	Run a PGP command.
pid_t	pgp_invoke_decode (FILE **fp_pgp_in, FILE **fp_pgp_out, FILE **fp_pgp_err, int fd_pgp_in, int fd_pgp_out, int fd_pgp_err, const char *fname, bool need_passphrase)
	Use PGP to decode a message.
pid_t	pgp_invoke_verify (FILE **fp_pgp_in, FILE **fp_pgp_out, FILE **fp_pgp_err, int fd_pgp_in, int fd_pgp_out, int fd_pgp_err, const char *fname, const char *sig_fname)
	Use PGP to verify a message.
pid_t	pgp_invoke_decrypt (FILE **fp_pgp_in, FILE **fp_pgp_out, FILE **fp_pgp_err, int fd_pgp_in, int fd_pgp_out, int fd_pgp_err, const char *fname)
	Use PGP to decrypt a file.
pid_t	pgp_invoke_sign (FILE **fp_pgp_in, FILE **fp_pgp_out, FILE **fp_pgp_err, int fd_pgp_in, int fd_pgp_out, int fd_pgp_err, const char *fname)
	Use PGP to sign a file.
pid_t	pgp_invoke_encrypt (FILE **fp_pgp_in, FILE **fp_pgp_out, FILE **fp_pgp_err, int fd_pgp_in, int fd_pgp_out, int fd_pgp_err, const char *fname, const char *uids, bool sign)
	Use PGP to encrypt a file.
pid_t	pgp_invoke_traditional (FILE **fp_pgp_in, FILE **fp_pgp_out, FILE **fp_pgp_err, int fd_pgp_in, int fd_pgp_out, int fd_pgp_err, const char *fname, const char *uids, SecurityFlags flags)
	Use PGP to create in inline-signed message.
void	pgp_class_invoke_import (const char *fname)
	Implements CryptModuleSpecs::pgp_invoke_import() -.
void	pgp_class_invoke_getkeys (struct Address *addr)
	Implements CryptModuleSpecs::pgp_invoke_getkeys() -.
pid_t	pgp_invoke_export (FILE **fp_pgp_in, FILE **fp_pgp_out, FILE **fp_pgp_err, int fd_pgp_in, int fd_pgp_out, int fd_pgp_err, const char *uids)
	Use PGP to export a key from the user's keyring.
pid_t	pgp_invoke_verify_key (FILE **fp_pgp_in, FILE **fp_pgp_out, FILE **fp_pgp_err, int fd_pgp_in, int fd_pgp_out, int fd_pgp_err, const char *uids)
	Use PGP to verify a key.
pid_t	pgp_invoke_list_keys (FILE **fp_pgp_in, FILE **fp_pgp_out, FILE **fp_pgp_err, int fd_pgp_in, int fd_pgp_out, int fd_pgp_err, enum PgpRing keyring, struct ListHead *hints)
	Find matching PGP Keys.

Detailed Description

Wrapper around calls to external PGP program.

Authors

• Thomas Roessler
• Pietro Cerutti

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file pgpinvoke.c.

Function Documentation

mutt_pgp_command()

static void mutt_pgp_command ( char *  buf, size_t  buflen, struct PgpCommandContext *  cctx, const char *  fmt  )

static

Prepare a PGP Command.

Parameters

buf	Buffer for the result
buflen	Length of buffer
cctx	Data to pass to the formatter
fmt	printf-like formatting string

See also

pgp_command_format_str()

Definition at line 187 of file pgpinvoke.c.

{
  mutt_expando_format(buf, buflen, 0, buflen, NONULL(fmt), pgp_command_format_str,
                      (intptr_t) cctx, MUTT_FORMAT_NO_FLAGS);
  mutt_debug(LL_DEBUG2, "%s\n", buf);
}

Here is the call graph for this function:

Here is the caller graph for this function:

pgp_invoke()

static pid_t pgp_invoke ( FILE **  fp_pgp_in, FILE **  fp_pgp_out, FILE **  fp_pgp_err, int  fd_pgp_in, int  fd_pgp_out, int  fd_pgp_err, bool  need_passphrase, const char *  fname, const char *  sig_fname, const char *  ids, const char *  format  )

static

Run a PGP command.

Parameters

[out]	fp_pgp_in	stdin for the command, or NULL (OPTIONAL)
[out]	fp_pgp_out	stdout for the command, or NULL (OPTIONAL)
[out]	fp_pgp_err	stderr for the command, or NULL (OPTIONAL)
[in]	fd_pgp_in	stdin for the command, or -1 (OPTIONAL)
[in]	fd_pgp_out	stdout for the command, or -1 (OPTIONAL)
[in]	fd_pgp_err	stderr for the command, or -1 (OPTIONAL)
[in]	need_passphrase	Is a passphrase needed?
[in]	fname	Filename to pass to the command
[in]	sig_fname	Signature filename to pass to the command
[in]	ids	List of IDs/fingerprints, space separated
[in]	format	printf-like format string

Return values

num	PID of the created process
-1	Error creating pipes or forking

Note

fp_pgp_in has priority over fd_pgp_in. Likewise fp_pgp_out and fp_pgp_err.

Definition at line 214 of file pgpinvoke.c.

{
  struct PgpCommandContext cctx = { 0 };
  char cmd[STR_COMMAND] = { 0 };
 
  if (!format || (*format == '\0'))
    return (pid_t) -1;
 
  cctx.need_passphrase = need_passphrase;
  cctx.fname = fname;
  cctx.sig_fname = sig_fname;
  const char *const c_pgp_sign_as = cs_subset_string(NeoMutt->sub, "pgp_sign_as");
  const char *const c_pgp_default_key = cs_subset_string(NeoMutt->sub, "pgp_default_key");
  if (c_pgp_sign_as)
    cctx.signas = c_pgp_sign_as;
  else
    cctx.signas = c_pgp_default_key;
  cctx.ids = ids;
 
  mutt_pgp_command(cmd, sizeof(cmd), &cctx, format);
 
  return filter_create_fd(cmd, fp_pgp_in, fp_pgp_out, fp_pgp_err, fd_pgp_in,
                          fd_pgp_out, fd_pgp_err, EnvList);
}

Here is the call graph for this function:

Here is the caller graph for this function:

pgp_invoke_decode()

pid_t pgp_invoke_decode	(	FILE **	fp_pgp_in,
		FILE **	fp_pgp_out,
		FILE **	fp_pgp_err,
		int	fd_pgp_in,
		int	fd_pgp_out,
		int	fd_pgp_err,
		const char *	fname,
		bool	need_passphrase
	)

Use PGP to decode a message.

Parameters

[out]	fp_pgp_in	stdin for the command, or NULL (OPTIONAL)
[out]	fp_pgp_out	stdout for the command, or NULL (OPTIONAL)
[out]	fp_pgp_err	stderr for the command, or NULL (OPTIONAL)
[in]	fd_pgp_in	stdin for the command, or -1 (OPTIONAL)
[in]	fd_pgp_out	stdout for the command, or -1 (OPTIONAL)
[in]	fd_pgp_err	stderr for the command, or -1 (OPTIONAL)
[in]	fname	Filename to pass to the command
[in]	need_passphrase	Is a passphrase needed?

Return values

num	PID of the created process
-1	Error creating pipes or forking

Note

fp_pgp_in has priority over fd_pgp_in. Likewise fp_pgp_out and fp_pgp_err.

Definition at line 264 of file pgpinvoke.c.

{
  const char *const c_pgp_decode_command = cs_subset_string(NeoMutt->sub, "pgp_decode_command");
  return pgp_invoke(fp_pgp_in, fp_pgp_out, fp_pgp_err, fd_pgp_in, fd_pgp_out, fd_pgp_err,
                    need_passphrase, fname, NULL, NULL, c_pgp_decode_command);
}

Here is the call graph for this function:

Here is the caller graph for this function:

pgp_invoke_verify()

pid_t pgp_invoke_verify	(	FILE **	fp_pgp_in,
		FILE **	fp_pgp_out,
		FILE **	fp_pgp_err,
		int	fd_pgp_in,
		int	fd_pgp_out,
		int	fd_pgp_err,
		const char *	fname,
		const char *	sig_fname
	)

Use PGP to verify a message.

Parameters

[out]	fp_pgp_in	stdin for the command, or NULL (OPTIONAL)
[out]	fp_pgp_out	stdout for the command, or NULL (OPTIONAL)
[out]	fp_pgp_err	stderr for the command, or NULL (OPTIONAL)
[in]	fd_pgp_in	stdin for the command, or -1 (OPTIONAL)
[in]	fd_pgp_out	stdout for the command, or -1 (OPTIONAL)
[in]	fd_pgp_err	stderr for the command, or -1 (OPTIONAL)
[in]	fname	Filename to pass to the command
[in]	sig_fname	Signature filename to pass to the command

Return values

num	PID of the created process
-1	Error creating pipes or forking

Note

fp_pgp_in has priority over fd_pgp_in. Likewise fp_pgp_out and fp_pgp_err.

Definition at line 289 of file pgpinvoke.c.

{
  const char *const c_pgp_verify_command = cs_subset_string(NeoMutt->sub, "pgp_verify_command");
  return pgp_invoke(fp_pgp_in, fp_pgp_out, fp_pgp_err, fd_pgp_in, fd_pgp_out,
                    fd_pgp_err, false, fname, sig_fname, NULL, c_pgp_verify_command);
}

Here is the call graph for this function:

Here is the caller graph for this function:

pgp_invoke_decrypt()

pid_t pgp_invoke_decrypt	(	FILE **	fp_pgp_in,
		FILE **	fp_pgp_out,
		FILE **	fp_pgp_err,
		int	fd_pgp_in,
		int	fd_pgp_out,
		int	fd_pgp_err,
		const char *	fname
	)

Use PGP to decrypt a file.

Parameters

[out]	fp_pgp_in	stdin for the command, or NULL (OPTIONAL)
[out]	fp_pgp_out	stdout for the command, or NULL (OPTIONAL)
[out]	fp_pgp_err	stderr for the command, or NULL (OPTIONAL)
[in]	fd_pgp_in	stdin for the command, or -1 (OPTIONAL)
[in]	fd_pgp_out	stdout for the command, or -1 (OPTIONAL)
[in]	fd_pgp_err	stderr for the command, or -1 (OPTIONAL)
[in]	fname	Filename to pass to the command

Return values

num	PID of the created process
-1	Error creating pipes or forking

Note

fp_pgp_in has priority over fd_pgp_in. Likewise fp_pgp_out and fp_pgp_err.

Definition at line 313 of file pgpinvoke.c.

{
  const char *const c_pgp_decrypt_command = cs_subset_string(NeoMutt->sub, "pgp_decrypt_command");
  return pgp_invoke(fp_pgp_in, fp_pgp_out, fp_pgp_err, fd_pgp_in, fd_pgp_out,
                    fd_pgp_err, true, fname, NULL, NULL, c_pgp_decrypt_command);
}

Here is the call graph for this function:

Here is the caller graph for this function:

pgp_invoke_sign()

pid_t pgp_invoke_sign	(	FILE **	fp_pgp_in,
		FILE **	fp_pgp_out,
		FILE **	fp_pgp_err,
		int	fd_pgp_in,
		int	fd_pgp_out,
		int	fd_pgp_err,
		const char *	fname
	)

Use PGP to sign a file.

Parameters

[out]	fp_pgp_in	stdin for the command, or NULL (OPTIONAL)
[out]	fp_pgp_out	stdout for the command, or NULL (OPTIONAL)
[out]	fp_pgp_err	stderr for the command, or NULL (OPTIONAL)
[in]	fd_pgp_in	stdin for the command, or -1 (OPTIONAL)
[in]	fd_pgp_out	stdout for the command, or -1 (OPTIONAL)
[in]	fd_pgp_err	stderr for the command, or -1 (OPTIONAL)
[in]	fname	Filename to pass to the command

Return values

num	PID of the created process
-1	Error creating pipes or forking

Note

fp_pgp_in has priority over fd_pgp_in. Likewise fp_pgp_out and fp_pgp_err.

Definition at line 336 of file pgpinvoke.c.

{
  const char *const c_pgp_sign_command = cs_subset_string(NeoMutt->sub, "pgp_sign_command");
  return pgp_invoke(fp_pgp_in, fp_pgp_out, fp_pgp_err, fd_pgp_in, fd_pgp_out,
                    fd_pgp_err, true, fname, NULL, NULL, c_pgp_sign_command);
}

Here is the call graph for this function:

Here is the caller graph for this function:

pgp_invoke_encrypt()

pid_t pgp_invoke_encrypt	(	FILE **	fp_pgp_in,
		FILE **	fp_pgp_out,
		FILE **	fp_pgp_err,
		int	fd_pgp_in,
		int	fd_pgp_out,
		int	fd_pgp_err,
		const char *	fname,
		const char *	uids,
		bool	sign
	)

Use PGP to encrypt a file.

Parameters

[out]	fp_pgp_in	stdin for the command, or NULL (OPTIONAL)
[out]	fp_pgp_out	stdout for the command, or NULL (OPTIONAL)
[out]	fp_pgp_err	stderr for the command, or NULL (OPTIONAL)
[in]	fd_pgp_in	stdin for the command, or -1 (OPTIONAL)
[in]	fd_pgp_out	stdout for the command, or -1 (OPTIONAL)
[in]	fd_pgp_err	stderr for the command, or -1 (OPTIONAL)
[in]	fname	Filename to pass to the command
[in]	uids	List of IDs/fingerprints, space separated
[in]	sign	If true, also sign the file

Return values

num	PID of the created process
-1	Error creating pipes or forking

Note

fp_pgp_in has priority over fd_pgp_in. Likewise fp_pgp_out and fp_pgp_err.

Definition at line 361 of file pgpinvoke.c.

{
  if (sign)
  {
    const char *const c_pgp_encrypt_sign_command = cs_subset_string(NeoMutt->sub, "pgp_encrypt_sign_command");
    return pgp_invoke(fp_pgp_in, fp_pgp_out, fp_pgp_err, fd_pgp_in, fd_pgp_out,
                      fd_pgp_err, true, fname, NULL, uids, c_pgp_encrypt_sign_command);
  }
  else
  {
    const char *const c_pgp_encrypt_only_command = cs_subset_string(NeoMutt->sub, "pgp_encrypt_only_command");
    return pgp_invoke(fp_pgp_in, fp_pgp_out, fp_pgp_err, fd_pgp_in, fd_pgp_out,
                      fd_pgp_err, false, fname, NULL, uids, c_pgp_encrypt_only_command);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

pgp_invoke_traditional()

pid_t pgp_invoke_traditional	(	FILE **	fp_pgp_in,
		FILE **	fp_pgp_out,
		FILE **	fp_pgp_err,
		int	fd_pgp_in,
		int	fd_pgp_out,
		int	fd_pgp_err,
		const char *	fname,
		const char *	uids,
		SecurityFlags	flags
	)

Use PGP to create in inline-signed message.

Parameters

[out]	fp_pgp_in	stdin for the command, or NULL (OPTIONAL)
[out]	fp_pgp_out	stdout for the command, or NULL (OPTIONAL)
[out]	fp_pgp_err	stderr for the command, or NULL (OPTIONAL)
[in]	fd_pgp_in	stdin for the command, or -1 (OPTIONAL)
[in]	fd_pgp_out	stdout for the command, or -1 (OPTIONAL)
[in]	fd_pgp_err	stderr for the command, or -1 (OPTIONAL)
[in]	fname	Filename to pass to the command
[in]	uids	List of IDs/fingerprints, space separated
[in]	flags	Flags, see SecurityFlags

Return values

num	PID of the created process
-1	Error creating pipes or forking

Note

fp_pgp_in has priority over fd_pgp_in. Likewise fp_pgp_out and fp_pgp_err.

Definition at line 396 of file pgpinvoke.c.

{
  if (flags & SEC_ENCRYPT)
  {
    const char *const c_pgp_encrypt_only_command = cs_subset_string(NeoMutt->sub, "pgp_encrypt_only_command");
    const char *const c_pgp_encrypt_sign_command = cs_subset_string(NeoMutt->sub, "pgp_encrypt_sign_command");
    return pgp_invoke(fp_pgp_in, fp_pgp_out, fp_pgp_err, fd_pgp_in, fd_pgp_out,
                      fd_pgp_err, (flags & SEC_SIGN), fname, NULL, uids,
                      (flags & SEC_SIGN) ? c_pgp_encrypt_sign_command : c_pgp_encrypt_only_command);
  }
  else
  {
    const char *const c_pgp_clear_sign_command = cs_subset_string(NeoMutt->sub, "pgp_clear_sign_command");
    return pgp_invoke(fp_pgp_in, fp_pgp_out, fp_pgp_err, fd_pgp_in, fd_pgp_out,
                      fd_pgp_err, true, fname, NULL, NULL, c_pgp_clear_sign_command);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

pgp_invoke_export()

pid_t pgp_invoke_export	(	FILE **	fp_pgp_in,
		FILE **	fp_pgp_out,
		FILE **	fp_pgp_err,
		int	fd_pgp_in,
		int	fd_pgp_out,
		int	fd_pgp_err,
		const char *	uids
	)

Use PGP to export a key from the user's keyring.

Parameters

[out]	fp_pgp_in	stdin for the command, or NULL (OPTIONAL)
[out]	fp_pgp_out	stdout for the command, or NULL (OPTIONAL)
[out]	fp_pgp_err	stderr for the command, or NULL (OPTIONAL)
[in]	fd_pgp_in	stdin for the command, or -1 (OPTIONAL)
[in]	fd_pgp_out	stdout for the command, or -1 (OPTIONAL)
[in]	fd_pgp_err	stderr for the command, or -1 (OPTIONAL)
[in]	uids	List of IDs/fingerprints, space separated

Return values

num	PID of the created process
-1	Error creating pipes or forking

Note

fp_pgp_in has priority over fd_pgp_in. Likewise fp_pgp_out and fp_pgp_err.

Definition at line 506 of file pgpinvoke.c.

{
  const char *const c_pgp_export_command = cs_subset_string(NeoMutt->sub, "pgp_export_command");
  return pgp_invoke(fp_pgp_in, fp_pgp_out, fp_pgp_err, fd_pgp_in, fd_pgp_out,
                    fd_pgp_err, false, NULL, NULL, uids, c_pgp_export_command);
}

Here is the call graph for this function:

Here is the caller graph for this function:

pgp_invoke_verify_key()

pid_t pgp_invoke_verify_key	(	FILE **	fp_pgp_in,
		FILE **	fp_pgp_out,
		FILE **	fp_pgp_err,
		int	fd_pgp_in,
		int	fd_pgp_out,
		int	fd_pgp_err,
		const char *	uids
	)

Use PGP to verify a key.

Parameters

[out]	fp_pgp_in	stdin for the command, or NULL (OPTIONAL)
[out]	fp_pgp_out	stdout for the command, or NULL (OPTIONAL)
[out]	fp_pgp_err	stderr for the command, or NULL (OPTIONAL)
[in]	fd_pgp_in	stdin for the command, or -1 (OPTIONAL)
[in]	fd_pgp_out	stdout for the command, or -1 (OPTIONAL)
[in]	fd_pgp_err	stderr for the command, or -1 (OPTIONAL)
[in]	uids	List of IDs/fingerprints, space separated

Return values

num	PID of the created process
-1	Error creating pipes or forking

Note

fp_pgp_in has priority over fd_pgp_in. Likewise fp_pgp_out and fp_pgp_err.

Definition at line 529 of file pgpinvoke.c.

{
  const char *const c_pgp_verify_key_command = cs_subset_string(NeoMutt->sub, "pgp_verify_key_command");
  return pgp_invoke(fp_pgp_in, fp_pgp_out, fp_pgp_err, fd_pgp_in, fd_pgp_out,
                    fd_pgp_err, false, NULL, NULL, uids, c_pgp_verify_key_command);
}

Here is the call graph for this function:

Here is the caller graph for this function:

pgp_invoke_list_keys()

pid_t pgp_invoke_list_keys	(	FILE **	fp_pgp_in,
		FILE **	fp_pgp_out,
		FILE **	fp_pgp_err,
		int	fd_pgp_in,
		int	fd_pgp_out,
		int	fd_pgp_err,
		enum PgpRing	keyring,
		struct ListHead *	hints
	)

Find matching PGP Keys.

Parameters

[out]	fp_pgp_in	stdin for the command, or NULL (OPTIONAL)
[out]	fp_pgp_out	stdout for the command, or NULL (OPTIONAL)
[out]	fp_pgp_err	stderr for the command, or NULL (OPTIONAL)
[in]	fd_pgp_in	stdin for the command, or -1 (OPTIONAL)
[in]	fd_pgp_out	stdout for the command, or -1 (OPTIONAL)
[in]	fd_pgp_err	stderr for the command, or -1 (OPTIONAL)
[in]	keyring	Keyring type, e.g. PGP_SECRING
[in]	hints	Match keys to these strings

Return values

num	PID of the created process
-1	Error creating pipes or forking

Note

fp_pgp_in has priority over fd_pgp_in. Likewise fp_pgp_out and fp_pgp_err.

Definition at line 553 of file pgpinvoke.c.

{
  struct Buffer *uids = buf_pool_get();
  struct Buffer *quoted = buf_pool_get();
 
  struct ListNode *np = NULL;
  STAILQ_FOREACH(np, hints, entries)
  {
    buf_quote_filename(quoted, (char *) np->data, true);
    buf_addstr(uids, buf_string(quoted));
    if (STAILQ_NEXT(np, entries))
      buf_addch(uids, ' ');
  }
 
  const char *const c_pgp_list_pubring_command = cs_subset_string(NeoMutt->sub, "pgp_list_pubring_command");
  const char *const c_pgp_list_secring_command = cs_subset_string(NeoMutt->sub, "pgp_list_secring_command");
  pid_t rc = pgp_invoke(fp_pgp_in, fp_pgp_out, fp_pgp_err, fd_pgp_in,
                        fd_pgp_out, fd_pgp_err, 0, NULL, NULL, buf_string(uids),
                        (keyring == PGP_SECRING) ? c_pgp_list_secring_command :
                                                   c_pgp_list_pubring_command);
 
  buf_pool_release(&uids);
  buf_pool_release(&quoted);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function: