pgpinvoke.h File Reference

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

#include <stdbool.h>
#include <stdio.h>
#include <sys/types.h>
#include "lib.h"
#include "pgpkey.h"

Include dependency graph for pgpinvoke.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	pgp_class_invoke_import (const char *fname)
	Import a key from a message into the user's public key ring - Implements CryptModuleSpecs::pgp_invoke_import() -.
void	pgp_class_invoke_getkeys (struct Address *addr)
	Run a command to download a PGP key - Implements CryptModuleSpecs::pgp_invoke_getkeys() -.
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_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_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_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_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.
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_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.
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_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.

Detailed Description

Wrapper around calls to external PGP program.

Authors

• Pietro Cerutti
• Richard Russon

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.h.

Function Documentation

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 133 of file pgpinvoke.c.

{
  const struct Expando *c_pgp_decode_command = cs_subset_expando(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_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 182 of file pgpinvoke.c.

{
  const struct Expando *c_pgp_decrypt_command = cs_subset_expando(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_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 230 of file pgpinvoke.c.

{
  if (sign)
  {
    const struct Expando *c_pgp_encrypt_sign_command = cs_subset_expando(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 struct Expando *c_pgp_encrypt_only_command = cs_subset_expando(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_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 375 of file pgpinvoke.c.

{
  const struct Expando *c_pgp_export_command = cs_subset_expando(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_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 422 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 struct Expando *c_pgp_list_pubring_command = cs_subset_expando(NeoMutt->sub, "pgp_list_pubring_command");
  const struct Expando *c_pgp_list_secring_command = cs_subset_expando(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:

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 205 of file pgpinvoke.c.

{
  const struct Expando *c_pgp_sign_command = cs_subset_expando(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_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 265 of file pgpinvoke.c.

{
  if (flags & SEC_ENCRYPT)
  {
    const struct Expando *c_pgp_encrypt_only_command = cs_subset_expando(NeoMutt->sub, "pgp_encrypt_only_command");
    const struct Expando *c_pgp_encrypt_sign_command = cs_subset_expando(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 struct Expando *c_pgp_clear_sign_command = cs_subset_expando(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_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 158 of file pgpinvoke.c.

{
  const struct Expando *c_pgp_verify_command = cs_subset_expando(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_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 398 of file pgpinvoke.c.

{
  const struct Expando *c_pgp_verify_key_command = cs_subset_expando(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: