Crypto API

The Crypto API. More...

Collaboration diagram for Crypto API:

Topics
	init()
	Initialise the crypto module.
	cleanup()
	Clean up the crypt module.
	void_passphrase()
	Forget the cached passphrase.
	valid_passphrase()
	Ensure we have a valid passphrase.
	decrypt_mime()
	Decrypt an encrypted MIME part.
	application_handler()
	Manage the MIME type "application/pgp" or "application/smime".
	encrypted_handler()
	Manage a PGP or S/MIME encrypted MIME part.
	find_keys()
	Find the keyids of the recipients of a message.
	sign_message()
	Cryptographically sign the Body of a message.
	verify_one()
	Check a signed MIME part against a signature.
	send_menu()
	Ask the user whether to sign and/or encrypt the email.
	set_sender()
	Set the sender of the email.
	pgp_encrypt_message()
	PGP encrypt an email.
	pgp_make_key_attachment()
	Generate a public key attachment.
	pgp_check_traditional()
	Look for inline (non-MIME) PGP content.
	pgp_traditional_encryptsign()
	Create an inline PGP encrypted, signed email.
	pgp_invoke_getkeys()
	Run a command to download a PGP key.
	pgp_invoke_import()
	Import a key from a message into the user's public key ring.
	pgp_extract_key_from_attachment()
	Extract PGP key from an attachment.
	smime_getkeys()
	Get the S/MIME keys required to encrypt this email.
	smime_verify_sender()
	Does the sender match the certificate?
	smime_build_smime_entity()
	Encrypt the email body to all recipients.
	smime_invoke_import()
	Add a certificate and update index file (externally)

Variables
const struct CryptModuleSpecs	CryptModPgpClassic
	CLI PGP - Implements CryptModuleSpecs -.
const struct CryptModuleSpecs	CryptModPgpGpgme
	GPGME PGP - Implements CryptModuleSpecs -.
const struct CryptModuleSpecs	CryptModSmimeClassic
	CLI SMIME - Implements CryptModuleSpecs -.
const struct CryptModuleSpecs	CryptModSmimeGpgme
	GPGME SMIME - Implements CryptModuleSpecs -.

Detailed Description

The Crypto API.

A structure to describe a crypto module.

Variable Documentation

CryptModPgpClassic

const struct CryptModuleSpecs CryptModPgpClassic

CLI PGP - Implements CryptModuleSpecs -.

Definition at line 42 of file crypt_mod_pgp_classic.c.

                                                   {
  // clang-format off
  APPLICATION_PGP,
 
  NULL, /* init */
  NULL, /* cleanup */
  pgp_class_void_passphrase,
  pgp_class_valid_passphrase,
  pgp_class_decrypt_mime,
  pgp_class_application_handler,
  pgp_class_encrypted_handler,
  pgp_class_find_keys,
  pgp_class_sign_message,
  pgp_class_verify_one,
  pgp_class_send_menu,
  NULL, /* set_sender */
 
  pgp_class_encrypt_message,
  pgp_class_make_key_attachment,
  pgp_class_check_traditional,
  pgp_class_traditional_encryptsign,
  pgp_class_invoke_getkeys,
  pgp_class_invoke_import,
  pgp_class_extract_key_from_attachment,
 
  NULL, /* smime_getkeys */
  NULL, /* smime_verify_sender */
  NULL, /* smime_build_smime_entity */
  NULL, /* smime_invoke_import */
  // clang-format on
};

CryptModPgpGpgme

const struct CryptModuleSpecs CryptModPgpGpgme

GPGME PGP - Implements CryptModuleSpecs -.

Definition at line 58 of file crypt_mod_pgp_gpgme.c.

                                                 {
  // clang-format off
  APPLICATION_PGP,
 
  pgp_gpgme_init,
  NULL, /* cleanup */
  pgp_gpgme_void_passphrase,
  pgp_gpgme_valid_passphrase,
  pgp_gpgme_decrypt_mime,
  pgp_gpgme_application_handler,
  pgp_gpgme_encrypted_handler,
  pgp_gpgme_find_keys,
  pgp_gpgme_sign_message,
  pgp_gpgme_verify_one,
  pgp_gpgme_send_menu,
  pgp_gpgme_set_sender,
 
  pgp_gpgme_encrypt_message,
  pgp_gpgme_make_key_attachment,
  pgp_gpgme_check_traditional,
  NULL, /* pgp_traditional_encryptsign */
  NULL, /* pgp_invoke_getkeys */
  pgp_gpgme_invoke_import,
  NULL, /* pgp_extract_key_from_attachment */
 
  NULL, /* smime_getkeys */
  NULL, /* smime_verify_sender */
  NULL, /* smime_build_smime_entity */
  NULL, /* smime_invoke_import */
  // clang-format on
};

CryptModSmimeClassic

const struct CryptModuleSpecs CryptModSmimeClassic

CLI SMIME - Implements CryptModuleSpecs -.

Definition at line 56 of file crypt_mod_smime_classic.c.

                                                     {
  // clang-format off
  APPLICATION_SMIME,
 
  smime_class_init,
  smime_class_cleanup,
  smime_class_void_passphrase,
  smime_class_valid_passphrase,
  smime_class_decrypt_mime,
  smime_class_application_handler,
  NULL, /* encrypted_handler */
  smime_class_find_keys,
  smime_class_sign_message,
  smime_class_verify_one,
  smime_class_send_menu,
  NULL, /* set_sender */
 
  NULL, /* pgp_encrypt_message */
  NULL, /* pgp_make_key_attachment */
  NULL, /* pgp_check_traditional */
  NULL, /* pgp_traditional_encryptsign */
  NULL, /* pgp_invoke_getkeys */
  NULL, /* pgp_invoke_import */
  NULL, /* pgp_extract_key_from_attachment */
 
  smime_class_getkeys,
  smime_class_verify_sender,
  smime_class_build_smime_entity,
  smime_class_invoke_import,
  // clang-format on
};

CryptModSmimeGpgme

const struct CryptModuleSpecs CryptModSmimeGpgme

GPGME SMIME - Implements CryptModuleSpecs -.

Definition at line 58 of file crypt_mod_smime_gpgme.c.

                                                   {
  // clang-format off
  APPLICATION_SMIME,
 
  smime_gpgme_init,
  NULL, /* cleanup */
  smime_gpgme_void_passphrase,
  smime_gpgme_valid_passphrase,
  smime_gpgme_decrypt_mime,
  smime_gpgme_application_handler,
  NULL, /* encrypted_handler */
  smime_gpgme_find_keys,
  smime_gpgme_sign_message,
  smime_gpgme_verify_one,
  smime_gpgme_send_menu,
  NULL, /* set_sender */
 
  NULL, /* pgp_encrypt_message */
  NULL, /* pgp_make_key_attachment */
  NULL, /* pgp_check_traditional */
  NULL, /* pgp_traditional_encryptsign */
  NULL, /* pgp_invoke_getkeys */
  NULL, /* pgp_invoke_import */
  NULL, /* pgp_extract_key_from_attachment */
 
  NULL, /* smime_getkeys */
  smime_gpgme_verify_sender,
  smime_gpgme_build_smime_entity,
  NULL, /* smime_invoke_import */
  // clang-format on
};