crypt_gpgme.h File Reference

Wrapper for PGP/SMIME calls to GPGME. More...

#include <gpgme.h>
#include <stdbool.h>
#include <stdio.h>
#include "mutt/lib.h"
#include "lib.h"

Include dependency graph for crypt_gpgme.h:

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

Go to the source code of this file.

Data Structures
struct	CryptKeyInfo
	A stored PGP key. More...
struct	CryptEntry
	An entry in the Select-Key menu. More...

Enumerations
enum	KeyInfo {   KIP_NAME = 0 , KIP_AKA , KIP_VALID_FROM , KIP_VALID_TO ,   KIP_KEY_TYPE , KIP_KEY_USAGE , KIP_FINGERPRINT , KIP_SERIAL_NO ,   KIP_ISSUED_BY , KIP_SUBKEY , KIP_MAX }
	PGP Key info. More...
enum	KeyCap { KEY_CAP_CAN_ENCRYPT , KEY_CAP_CAN_SIGN , KEY_CAP_CAN_CERTIFY }
	PGP/SMIME Key Capabilities. More...

Functions
	ARRAY_HEAD (CryptKeyInfoArray, struct CryptKeyInfo *)
void	pgp_gpgme_set_sender (const char *sender)
	Set the sender of the email - Implements CryptModuleSpecs::set_sender() -.
int	pgp_gpgme_application_handler (struct Body *b, struct State *state)
	Manage the MIME type "application/pgp" or "application/smime" - Implements CryptModuleSpecs::application_handler() -.
bool	pgp_gpgme_check_traditional (FILE *fp, struct Body *b, bool just_one)
	Look for inline (non-MIME) PGP content - Implements CryptModuleSpecs::pgp_check_traditional() -.
int	pgp_gpgme_decrypt_mime (FILE *fp_in, FILE **fp_out, struct Body *b, struct Body **b_dec)
	Decrypt an encrypted MIME part - Implements CryptModuleSpecs::decrypt_mime() -.
int	pgp_gpgme_encrypted_handler (struct Body *b, struct State *state)
	Manage a PGP or S/MIME encrypted MIME part - Implements CryptModuleSpecs::encrypted_handler() -.
struct Body *	pgp_gpgme_encrypt_message (struct Body *b, char *keylist, bool sign, const struct AddressList *from)
	PGP encrypt an email - Implements CryptModuleSpecs::pgp_encrypt_message() -.
char *	pgp_gpgme_find_keys (const struct AddressList *addrlist, bool oppenc_mode)
	Find the keyids of the recipients of a message - Implements CryptModuleSpecs::find_keys() -.
void	pgp_gpgme_invoke_import (const char *fname)
	Import a key from a message into the user's public key ring - Implements CryptModuleSpecs::pgp_invoke_import() -.
struct Body *	pgp_gpgme_make_key_attachment (void)
	Generate a public key attachment - Implements CryptModuleSpecs::pgp_make_key_attachment() -.
SecurityFlags	pgp_gpgme_send_menu (struct Email *e)
	Ask the user whether to sign and/or encrypt the email - Implements CryptModuleSpecs::send_menu() -.
struct Body *	pgp_gpgme_sign_message (struct Body *b, const struct AddressList *from)
	Cryptographically sign the Body of a message - Implements CryptModuleSpecs::sign_message() -.
int	pgp_gpgme_verify_one (struct Body *b, struct State *state, const char *tempfile)
	Check a signed MIME part against a signature - Implements CryptModuleSpecs::verify_one() -.
int	smime_gpgme_application_handler (struct Body *b, struct State *state)
	Manage the MIME type "application/pgp" or "application/smime" - Implements CryptModuleSpecs::application_handler() -.
struct Body *	smime_gpgme_build_smime_entity (struct Body *b, char *keylist)
	Encrypt the email body to all recipients - Implements CryptModuleSpecs::smime_build_smime_entity() -.
int	smime_gpgme_decrypt_mime (FILE *fp_in, FILE **fp_out, struct Body *b, struct Body **b_dec)
	Decrypt an encrypted MIME part - Implements CryptModuleSpecs::decrypt_mime() -.
char *	smime_gpgme_find_keys (const struct AddressList *addrlist, bool oppenc_mode)
	Find the keyids of the recipients of a message - Implements CryptModuleSpecs::find_keys() -.
void	smime_gpgme_init (void)
	Initialise the crypto module - Implements CryptModuleSpecs::init() -.
SecurityFlags	smime_gpgme_send_menu (struct Email *e)
	Ask the user whether to sign and/or encrypt the email - Implements CryptModuleSpecs::send_menu() -.
struct Body *	smime_gpgme_sign_message (struct Body *b, const struct AddressList *from)
	Cryptographically sign the Body of a message - Implements CryptModuleSpecs::sign_message() -.
int	smime_gpgme_verify_one (struct Body *b, struct State *state, const char *tempfile)
	Check a signed MIME part against a signature - Implements CryptModuleSpecs::verify_one() -.
int	smime_gpgme_verify_sender (struct Email *e, struct Message *msg)
	Does the sender match the certificate? - Implements CryptModuleSpecs::smime_verify_sender() -.
gpgme_ctx_t	create_gpgme_context (bool for_smime)
	Create a new GPGME context.
struct CryptKeyInfo *	crypt_copy_key (struct CryptKeyInfo *key)
	Return a copy of KEY.
const char *	crypt_fpr_or_lkeyid (struct CryptKeyInfo *k)
	Find the fingerprint of a key.
bool	crypt_id_is_strong (struct CryptKeyInfo *key)
	Is the key strong.
int	crypt_id_is_valid (struct CryptKeyInfo *key)
	Is key ID valid.
const char *	crypt_keyid (struct CryptKeyInfo *k)
	Find the ID for the key.
int	digit (const char *s)
unsigned int	key_check_cap (gpgme_key_t key, enum KeyCap cap)
	Check the capabilities of a key.

Detailed Description

Wrapper for PGP/SMIME calls to GPGME.

Authors

• Richard Russon
• 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 crypt_gpgme.h.

Enumeration Type Documentation

KeyInfo

enum KeyInfo

PGP Key info.

Enumerator
KIP_NAME	PGP Key field: Name.
KIP_AKA	PGP Key field: aka (Also Known As)
KIP_VALID_FROM	PGP Key field: Valid From date.
KIP_VALID_TO	PGP Key field: Valid To date.
KIP_KEY_TYPE	PGP Key field: Key Type.
KIP_KEY_USAGE	PGP Key field: Key Usage.
KIP_FINGERPRINT	PGP Key field: Fingerprint.
KIP_SERIAL_NO	PGP Key field: Serial number.
KIP_ISSUED_BY	PGP Key field: Issued By.
KIP_SUBKEY	PGP Key field: Subkey.
KIP_MAX

Definition at line 58 of file crypt_gpgme.h.

{
  KIP_NAME = 0,    
  KIP_AKA,         
  KIP_VALID_FROM,  
  KIP_VALID_TO,    
  KIP_KEY_TYPE,    
  KIP_KEY_USAGE,   
  KIP_FINGERPRINT, 
  KIP_SERIAL_NO,   
  KIP_ISSUED_BY,   
  KIP_SUBKEY,      
  KIP_MAX,
};

KeyCap

enum KeyCap

PGP/SMIME Key Capabilities.

Enumerator
KEY_CAP_CAN_ENCRYPT	Key can be used for encryption.
KEY_CAP_CAN_SIGN	Key can be used for signing.
KEY_CAP_CAN_CERTIFY	Key can be used to certify.

Definition at line 76 of file crypt_gpgme.h.

{
  KEY_CAP_CAN_ENCRYPT, 
  KEY_CAP_CAN_SIGN,    
  KEY_CAP_CAN_CERTIFY, 
};

Function Documentation

ARRAY_HEAD()

ARRAY_HEAD	(	CryptKeyInfoArray	,
		struct CryptKeyInfo *
	)

create_gpgme_context()

gpgme_ctx_t create_gpgme_context

(

bool

for_smime

)

Create a new GPGME context.

Parameters

for_smime

If true, protocol of the context is set to CMS

Return values

ptr	New GPGME context

Definition at line 361 of file crypt_gpgme.c.

{
  gpgme_ctx_t ctx = NULL;
 
  gpgme_error_t err = gpgme_new(&ctx);
 
#ifdef USE_AUTOCRYPT
  const char *const c_autocrypt_dir = cs_subset_path(NeoMutt->sub, "autocrypt_dir");
  if ((err == GPG_ERR_NO_ERROR) && OptAutocryptGpgme)
    err = gpgme_ctx_set_engine_info(ctx, GPGME_PROTOCOL_OpenPGP, NULL, c_autocrypt_dir);
#endif
 
  if (err != GPG_ERR_NO_ERROR)
  {
    mutt_error(_("error creating GPGME context: %s"), gpgme_strerror(err));
    mutt_exit(1);
  }
 
  if (for_smime)
  {
    err = gpgme_set_protocol(ctx, GPGME_PROTOCOL_CMS);
    if (err != GPG_ERR_NO_ERROR)
    {
      mutt_error(_("error enabling CMS protocol: %s"), gpgme_strerror(err));
      mutt_exit(1);
    }
  }
 
  return ctx;
}

Here is the call graph for this function:

Here is the caller graph for this function:

crypt_copy_key()

struct CryptKeyInfo * crypt_copy_key

(

struct CryptKeyInfo *

key

)

Return a copy of KEY.

Parameters

key	Key to copy

Return values

ptr	Copy of key

Definition at line 234 of file crypt_gpgme.c.

{
  struct CryptKeyInfo *k = NULL;
 
  k = MUTT_MEM_CALLOC(1, struct CryptKeyInfo);
  k->kobj = key->kobj;
  gpgme_key_ref(key->kobj);
  k->idx = key->idx;
  k->uid = key->uid;
  k->flags = key->flags;
  k->validity = key->validity;
 
  return k;
}

Here is the caller graph for this function:

crypt_fpr_or_lkeyid()

const char * crypt_fpr_or_lkeyid

(

struct CryptKeyInfo *

k

)

Find the fingerprint of a key.

Parameters

k	Key to examine

Return values

ptr	Fingerprint if available, otherwise the long keyid

Definition at line 214 of file crypt_gpgme.c.

{
  const char *s = "????????????????";
 
  if (k->kobj && k->kobj->subkeys)
  {
    if (k->kobj->subkeys->fpr)
      s = k->kobj->subkeys->fpr;
    else
      s = k->kobj->subkeys->keyid;
  }
 
  return s;
}

Here is the caller graph for this function:

crypt_id_is_strong()

bool crypt_id_is_strong

(

struct CryptKeyInfo *

key

)

Is the key strong.

Parameters

key	Key to test

Return values

true	Validity of key is sufficient

Definition at line 275 of file crypt_gpgme.c.

{
  if (!key)
    return false;
 
  bool is_strong = false;
 
  if ((key->flags & KEYFLAG_ISX509))
    return true;
 
  switch (key->validity)
  {
    case GPGME_VALIDITY_MARGINAL:
    case GPGME_VALIDITY_NEVER:
    case GPGME_VALIDITY_UNDEFINED:
    case GPGME_VALIDITY_UNKNOWN:
      is_strong = false;
      break;
 
    case GPGME_VALIDITY_FULL:
    case GPGME_VALIDITY_ULTIMATE:
      is_strong = true;
      break;
  }
 
  return is_strong;
}

Here is the caller graph for this function:

crypt_id_is_valid()

int crypt_id_is_valid

(

struct CryptKeyInfo *

key

)

Is key ID valid.

Parameters

key	Key to test

Return values

true	Key is valid

When the key is not marked as unusable

Definition at line 310 of file crypt_gpgme.c.

{
  if (!key)
    return 0;
 
  return !(key->flags & KEYFLAG_CANTUSE);
}

Here is the caller graph for this function:

crypt_keyid()

const char * crypt_keyid

(

struct CryptKeyInfo *

k

)

Find the ID for the key.

Parameters

k	Key to use

Return values

ptr	ID string for the key

Return the keyID for the key K. Note that this string is valid as long as K is valid

Definition at line 138 of file crypt_gpgme.c.

{
  const char *s = "????????";
 
  if (k->kobj && k->kobj->subkeys)
  {
    s = k->kobj->subkeys->keyid;
    const bool c_pgp_long_ids = cs_subset_bool(NeoMutt->sub, "pgp_long_ids");
    if ((!c_pgp_long_ids) && (strlen(s) == 16))
    {
      /* Return only the short keyID.  */
      s += 8;
    }
  }
 
  return s;
}

Here is the call graph for this function:

Here is the caller graph for this function:

digit()

int digit

(

const char *

s

)

Here is the caller graph for this function:

key_check_cap()

unsigned int key_check_cap	(	gpgme_key_t	key,
		enum KeyCap	cap
	)

Check the capabilities of a key.

Parameters

key	GPGME key
cap	Flags, e.g. KEY_CAP_CAN_ENCRYPT

Return values

>0	Key has the capabilities

Definition at line 2948 of file crypt_gpgme.c.

{
  unsigned int rc = 0;
 
  switch (cap)
  {
    case KEY_CAP_CAN_ENCRYPT:
      rc = key->can_encrypt;
      if (rc == 0)
      {
        for (gpgme_subkey_t subkey = key->subkeys; subkey; subkey = subkey->next)
        {
          rc = subkey->can_encrypt;
          if (rc != 0)
            break;
        }
      }
      break;
    case KEY_CAP_CAN_SIGN:
      rc = key->can_sign;
      if (rc == 0)
      {
        for (gpgme_subkey_t subkey = key->subkeys; subkey; subkey = subkey->next)
        {
          rc = subkey->can_sign;
          if (rc != 0)
            break;
        }
      }
      break;
    case KEY_CAP_CAN_CERTIFY:
      rc = key->can_certify;
      if (rc == 0)
      {
        for (gpgme_subkey_t subkey = key->subkeys; subkey; subkey = subkey->next)
        {
          rc = subkey->can_certify;
          if (rc != 0)
            break;
        }
      }
      break;
  }
 
  return rc;
}

Here is the caller graph for this function: