Config used by libncrypt. More...

#include "config.h"
#include <stddef.h>
#include <config/lib.h>
#include <stdbool.h>
#include "private.h"
#include "lib.h"
#include "init.h"

Include dependency graph for config.c:

Go to the source code of this file.

Functions
bool	config_init_ncrypt (struct ConfigSet *cs)
	Register ncrypt config variables - Implements module_init_config_t. More...

Variables
const struct Mapping	SortKeyMethods []
	Sort methods for encryption keys. More...

bool	C_CryptUsePka
	Config: Use GPGME to use PKA (lookup PGP keys using DNS) More...

bool	C_CryptConfirmhook
	Config: Prompt the user to confirm keys before use. More...

bool	C_CryptOpportunisticEncrypt
	Config: Enable encryption when the recipient's key is available. More...

bool	C_CryptOpportunisticEncryptStrongKeys
	Config: Enable encryption only when strong a key is available. More...

bool	C_CryptProtectedHeadersRead
	Config: Display protected headers (Memory Hole) in the pager. More...

bool	C_CryptProtectedHeadersSave
	Config: Save the cleartext Subject with the headers. More...

bool	C_CryptProtectedHeadersWrite
	Config: Generate protected header (Memory Hole) for signed and encrypted emails. More...

bool	C_SmimeIsDefault
	Config: Use SMIME rather than PGP by default. More...

bool	C_PgpIgnoreSubkeys
	Config: Only use the principal PGP key. More...

bool	C_PgpLongIds
	Config: Display long PGP key IDs to the user. More...

bool	C_PgpShowUnusable
	Config: Show non-usable keys in the key selection. More...

bool	C_PgpAutoinline
	Config: Use old-style inline PGP messages (not recommended) More...

char *	C_PgpDefaultKey
	Config: Default key to use for PGP operations. More...

char *	C_PgpSignAs
	Config: Use this alternative key for signing messages. More...

char *	C_PgpEntryFormat
	Config: printf-like format string for the PGP key selection menu. More...

char *	C_SmimeDefaultKey
	Config: Default key for SMIME operations. More...

char *	C_SmimeSignAs
	Config: Use this alternative key for signing messages. More...

char *	C_SmimeEncryptWith
	Config: Algorithm for encryption. More...

char *	C_CryptProtectedHeadersSubject
	Config: Use this as the subject for encrypted emails. More...

struct Address *	C_EnvelopeFromAddress
	Config: Manually set the sender for outgoing messages. More...

bool	C_CryptTimestamp
	Config: Add a timestamp to PGP or SMIME output to prevent spoofing. More...

unsigned char	C_PgpEncryptSelf

unsigned char	C_PgpMimeAuto
	Config: Prompt the user to use MIME if inline PGP fails. More...

bool	C_PgpRetainableSigs
	Config: Create nested multipart/signed or encrypted messages. More...

bool	C_PgpSelfEncrypt
	Config: Encrypted messages will also be encrypted to `$pgp_default_key` too. More...

bool	C_PgpStrictEnc
	Config: Encode PGP signed messages with quoted-printable (don't unset) More...

unsigned char	C_SmimeEncryptSelf

bool	C_SmimeSelfEncrypt
	Config: Encrypted messages will also be encrypt to `$smime_default_key` too. More...

bool	C_CryptUseGpgme
	Config: Use GPGME crypto backend. More...

bool	C_PgpCheckExit
	Config: Check the exit code of PGP subprocess. More...

bool	C_PgpCheckGpgDecryptStatusFd
	Config: File descriptor used for status info. More...

struct Regex *	C_PgpDecryptionOkay
	Config: Text indicating a successful decryption. More...

struct Regex *	C_PgpGoodSign
	Config: Text indicating a good signature. More...

long	C_PgpTimeout
	Config: Time in seconds to cache a passphrase. More...

bool	C_PgpUseGpgAgent
	Config: Use a PGP agent for caching passwords. More...

char *	C_PgpClearsignCommand
	Config: (pgp) External command to inline-sign a message. More...

char *	C_PgpDecodeCommand
	Config: (pgp) External command to decode a PGP attachment. More...

char *	C_PgpDecryptCommand
	Config: (pgp) External command to decrypt a PGP message. More...

char *	C_PgpEncryptOnlyCommand
	Config: (pgp) External command to encrypt, but not sign a message. More...

char *	C_PgpEncryptSignCommand
	Config: (pgp) External command to encrypt and sign a message. More...

char *	C_PgpExportCommand
	Config: (pgp) External command to export a public key from the user's keyring. More...

char *	C_PgpGetkeysCommand
	Config: (pgp) External command to download a key for an email address. More...

char *	C_PgpImportCommand
	Config: (pgp) External command to import a key into the user's keyring. More...

char *	C_PgpListPubringCommand
	Config: (pgp) External command to list the public keys in a user's keyring. More...

char *	C_PgpListSecringCommand
	Config: (pgp) External command to list the private keys in a user's keyring. More...

char *	C_PgpSignCommand
	Config: (pgp) External command to create a detached PGP signature. More...

char *	C_PgpVerifyCommand
	Config: (pgp) External command to verify PGP signatures. More...

char *	C_PgpVerifyKeyCommand
	Config: (pgp) External command to verify key information. More...

short	C_PgpSortKeys
	Config: Sort order for PGP keys. More...

bool	C_SmimeAskCertLabel
	Config: Prompt the user for a label for SMIME certificates. More...

char *	C_SmimeCaLocation
	Config: File containing trusted certificates. More...

char *	C_SmimeCertificates
	Config: File containing user's public certificates. More...

char *	C_SmimeDecryptCommand
	Config: (smime) External command to decrypt an SMIME message. More...

bool	C_SmimeDecryptUseDefaultKey
	Config: Use the default key for decryption. More...

char *	C_SmimeEncryptCommand
	Config: (smime) External command to encrypt a message. More...

char *	C_SmimeGetCertCommand
	Config: (smime) External command to extract a certificate from a message. More...

char *	C_SmimeGetCertEmailCommand
	Config: (smime) External command to get a certificate for an email. More...

char *	C_SmimeGetSignerCertCommand
	Config: (smime) External command to extract a certificate from an email. More...

char *	C_SmimeImportCertCommand
	Config: (smime) External command to import a certificate. More...

char *	C_SmimeKeys
	Config: File containing user's private certificates. More...

char *	C_SmimePk7outCommand
	Config: (smime) External command to extract a public certificate. More...

char *	C_SmimeSignCommand
	Config: (smime) External command to sign a message. More...

char *	C_SmimeSignDigestAlg
	Config: Digest algorithm. More...

long	C_SmimeTimeout
	Config: Time in seconds to cache a passphrase. More...

char *	C_SmimeVerifyCommand
	Config: (smime) External command to verify a signed message. More...

char *	C_SmimeVerifyOpaqueCommand
	Config: (smime) External command to verify a signature. More...

bool	C_PgpAutoDecode
	Config: Automatically decrypt PGP messages. More...

unsigned char	C_CryptVerifySig
	Config: Verify PGP or SMIME signatures. More...

struct ConfigDef	NcryptVars []

Detailed Description

Config used by libncrypt.

Authors

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 config.c.

Function Documentation

◆ config_init_ncrypt()

bool config_init_ncrypt ( struct ConfigSet * cs )

Register ncrypt config variables - Implements module_init_config_t.

Definition at line 366 of file config.c.

 {
   return cs_register_variables(cs, NcryptVars, 0);
 }

Here is the call graph for this function:

Variable Documentation

◆ SortKeyMethods

const struct Mapping SortKeyMethods[]

Initial value:

= {
  { "address", SORT_ADDRESS },
  { "date",    SORT_DATE },
  { "keyid",   SORT_KEYID },
  { "trust",   SORT_TRUST },
  { NULL,      0 },
}

Sort methods for encryption keys.

Definition at line 44 of file config.c.

◆ C_CryptUsePka

bool C_CryptUsePka

Config: Use GPGME to use PKA (lookup PGP keys using DNS)

Definition at line 53 of file config.c.

◆ C_CryptConfirmhook

bool C_CryptConfirmhook

Config: Prompt the user to confirm keys before use.

Definition at line 55 of file config.c.

◆ C_CryptOpportunisticEncrypt

bool C_CryptOpportunisticEncrypt

Config: Enable encryption when the recipient's key is available.

Definition at line 56 of file config.c.

◆ C_CryptOpportunisticEncryptStrongKeys

bool C_CryptOpportunisticEncryptStrongKeys

Config: Enable encryption only when strong a key is available.

Definition at line 57 of file config.c.

◆ C_CryptProtectedHeadersRead

bool C_CryptProtectedHeadersRead

Config: Display protected headers (Memory Hole) in the pager.

Definition at line 58 of file config.c.

◆ C_CryptProtectedHeadersSave

bool C_CryptProtectedHeadersSave

Config: Save the cleartext Subject with the headers.

Definition at line 59 of file config.c.

◆ C_CryptProtectedHeadersWrite

bool C_CryptProtectedHeadersWrite

Config: Generate protected header (Memory Hole) for signed and encrypted emails.

Definition at line 60 of file config.c.

◆ C_SmimeIsDefault

bool C_SmimeIsDefault

Config: Use SMIME rather than PGP by default.

Definition at line 61 of file config.c.

◆ C_PgpIgnoreSubkeys

bool C_PgpIgnoreSubkeys

Config: Only use the principal PGP key.

Definition at line 62 of file config.c.

◆ C_PgpLongIds

bool C_PgpLongIds

Config: Display long PGP key IDs to the user.

Definition at line 63 of file config.c.

◆ C_PgpShowUnusable

bool C_PgpShowUnusable

Config: Show non-usable keys in the key selection.

Definition at line 64 of file config.c.

◆ C_PgpAutoinline

bool C_PgpAutoinline

Config: Use old-style inline PGP messages (not recommended)

Definition at line 65 of file config.c.

◆ C_PgpDefaultKey

char* C_PgpDefaultKey

Config: Default key to use for PGP operations.

Definition at line 66 of file config.c.

◆ C_PgpSignAs

char* C_PgpSignAs

Config: Use this alternative key for signing messages.

Definition at line 67 of file config.c.

◆ C_PgpEntryFormat

char* C_PgpEntryFormat

Config: printf-like format string for the PGP key selection menu.

Definition at line 68 of file config.c.

◆ C_SmimeDefaultKey

char* C_SmimeDefaultKey

Config: Default key for SMIME operations.

Definition at line 69 of file config.c.

◆ C_SmimeSignAs

char* C_SmimeSignAs

Config: Use this alternative key for signing messages.

Definition at line 70 of file config.c.

◆ C_SmimeEncryptWith

char* C_SmimeEncryptWith

Config: Algorithm for encryption.

Definition at line 71 of file config.c.

◆ C_CryptProtectedHeadersSubject

char* C_CryptProtectedHeadersSubject

Config: Use this as the subject for encrypted emails.

Definition at line 72 of file config.c.

◆ C_EnvelopeFromAddress

struct Address* C_EnvelopeFromAddress

Config: Manually set the sender for outgoing messages.

Definition at line 73 of file config.c.

◆ C_CryptTimestamp

bool C_CryptTimestamp

Config: Add a timestamp to PGP or SMIME output to prevent spoofing.

Definition at line 74 of file config.c.

◆ C_PgpEncryptSelf

unsigned char C_PgpEncryptSelf

Definition at line 75 of file config.c.

◆ C_PgpMimeAuto

unsigned char C_PgpMimeAuto

Config: Prompt the user to use MIME if inline PGP fails.

Definition at line 76 of file config.c.

◆ C_PgpRetainableSigs

bool C_PgpRetainableSigs

Config: Create nested multipart/signed or encrypted messages.

Definition at line 77 of file config.c.

◆ C_PgpSelfEncrypt

bool C_PgpSelfEncrypt

Config: Encrypted messages will also be encrypted to $pgp_default_key too.

Definition at line 78 of file config.c.

◆ C_PgpStrictEnc

bool C_PgpStrictEnc

Config: Encode PGP signed messages with quoted-printable (don't unset)

Definition at line 79 of file config.c.

◆ C_SmimeEncryptSelf

unsigned char C_SmimeEncryptSelf

Definition at line 80 of file config.c.

◆ C_SmimeSelfEncrypt

bool C_SmimeSelfEncrypt

Config: Encrypted messages will also be encrypt to $smime_default_key too.

Definition at line 81 of file config.c.

◆ C_CryptUseGpgme

bool C_CryptUseGpgme

Config: Use GPGME crypto backend.

Definition at line 83 of file config.c.

◆ C_PgpCheckExit

bool C_PgpCheckExit

Config: Check the exit code of PGP subprocess.

Definition at line 85 of file config.c.

◆ C_PgpCheckGpgDecryptStatusFd

bool C_PgpCheckGpgDecryptStatusFd

Config: File descriptor used for status info.

Definition at line 86 of file config.c.

◆ C_PgpDecryptionOkay

struct Regex* C_PgpDecryptionOkay

Config: Text indicating a successful decryption.

Definition at line 87 of file config.c.

◆ C_PgpGoodSign

struct Regex* C_PgpGoodSign

Config: Text indicating a good signature.

Definition at line 88 of file config.c.

◆ C_PgpTimeout

long C_PgpTimeout

Config: Time in seconds to cache a passphrase.

Definition at line 89 of file config.c.

◆ C_PgpUseGpgAgent

bool C_PgpUseGpgAgent

Config: Use a PGP agent for caching passwords.

Definition at line 90 of file config.c.

◆ C_PgpClearsignCommand

char* C_PgpClearsignCommand

Config: (pgp) External command to inline-sign a message.

Definition at line 91 of file config.c.

◆ C_PgpDecodeCommand

char* C_PgpDecodeCommand

Config: (pgp) External command to decode a PGP attachment.

Definition at line 92 of file config.c.

◆ C_PgpDecryptCommand

char* C_PgpDecryptCommand

Config: (pgp) External command to decrypt a PGP message.

Definition at line 93 of file config.c.

◆ C_PgpEncryptOnlyCommand

char* C_PgpEncryptOnlyCommand

Config: (pgp) External command to encrypt, but not sign a message.

Definition at line 94 of file config.c.

◆ C_PgpEncryptSignCommand

char* C_PgpEncryptSignCommand

Config: (pgp) External command to encrypt and sign a message.

Definition at line 95 of file config.c.

◆ C_PgpExportCommand

char* C_PgpExportCommand

Config: (pgp) External command to export a public key from the user's keyring.

Definition at line 96 of file config.c.

◆ C_PgpGetkeysCommand

char* C_PgpGetkeysCommand

Config: (pgp) External command to download a key for an email address.

Definition at line 97 of file config.c.

◆ C_PgpImportCommand

char* C_PgpImportCommand

Config: (pgp) External command to import a key into the user's keyring.

Definition at line 98 of file config.c.

◆ C_PgpListPubringCommand

char* C_PgpListPubringCommand

Config: (pgp) External command to list the public keys in a user's keyring.

Definition at line 99 of file config.c.

◆ C_PgpListSecringCommand

char* C_PgpListSecringCommand

Config: (pgp) External command to list the private keys in a user's keyring.

Definition at line 100 of file config.c.

◆ C_PgpSignCommand

char* C_PgpSignCommand

Config: (pgp) External command to create a detached PGP signature.

Definition at line 101 of file config.c.

◆ C_PgpVerifyCommand

char* C_PgpVerifyCommand

Config: (pgp) External command to verify PGP signatures.

Definition at line 102 of file config.c.

◆ C_PgpVerifyKeyCommand

char* C_PgpVerifyKeyCommand

Config: (pgp) External command to verify key information.

Definition at line 103 of file config.c.

◆ C_PgpSortKeys

short C_PgpSortKeys

Config: Sort order for PGP keys.

Definition at line 104 of file config.c.

◆ C_SmimeAskCertLabel

bool C_SmimeAskCertLabel

Config: Prompt the user for a label for SMIME certificates.

Definition at line 105 of file config.c.

◆ C_SmimeCaLocation

char* C_SmimeCaLocation

Config: File containing trusted certificates.

Definition at line 106 of file config.c.

◆ C_SmimeCertificates

char* C_SmimeCertificates

Config: File containing user's public certificates.

Definition at line 107 of file config.c.

◆ C_SmimeDecryptCommand

char* C_SmimeDecryptCommand

Config: (smime) External command to decrypt an SMIME message.

Definition at line 108 of file config.c.

◆ C_SmimeDecryptUseDefaultKey

bool C_SmimeDecryptUseDefaultKey

Config: Use the default key for decryption.

Definition at line 109 of file config.c.

◆ C_SmimeEncryptCommand

char* C_SmimeEncryptCommand

Config: (smime) External command to encrypt a message.

Definition at line 110 of file config.c.

◆ C_SmimeGetCertCommand

char* C_SmimeGetCertCommand

Config: (smime) External command to extract a certificate from a message.

Definition at line 111 of file config.c.

◆ C_SmimeGetCertEmailCommand

char* C_SmimeGetCertEmailCommand

Config: (smime) External command to get a certificate for an email.

Definition at line 112 of file config.c.

◆ C_SmimeGetSignerCertCommand

char* C_SmimeGetSignerCertCommand

Config: (smime) External command to extract a certificate from an email.

Definition at line 113 of file config.c.

◆ C_SmimeImportCertCommand

char* C_SmimeImportCertCommand

Config: (smime) External command to import a certificate.

Definition at line 114 of file config.c.

◆ C_SmimeKeys

char* C_SmimeKeys

Config: File containing user's private certificates.

Definition at line 115 of file config.c.

◆ C_SmimePk7outCommand

char* C_SmimePk7outCommand

Config: (smime) External command to extract a public certificate.

Definition at line 116 of file config.c.

◆ C_SmimeSignCommand

char* C_SmimeSignCommand

Config: (smime) External command to sign a message.

Definition at line 117 of file config.c.

◆ C_SmimeSignDigestAlg

char* C_SmimeSignDigestAlg

Config: Digest algorithm.

Definition at line 118 of file config.c.

◆ C_SmimeTimeout

long C_SmimeTimeout

Config: Time in seconds to cache a passphrase.

Definition at line 119 of file config.c.

◆ C_SmimeVerifyCommand

char* C_SmimeVerifyCommand

Config: (smime) External command to verify a signed message.

Definition at line 120 of file config.c.

◆ C_SmimeVerifyOpaqueCommand

char* C_SmimeVerifyOpaqueCommand

Config: (smime) External command to verify a signature.

Definition at line 121 of file config.c.

◆ C_PgpAutoDecode

bool C_PgpAutoDecode

Config: Automatically decrypt PGP messages.

Definition at line 122 of file config.c.

◆ C_CryptVerifySig

unsigned char C_CryptVerifySig

Config: Verify PGP or SMIME signatures.

Definition at line 123 of file config.c.

◆ NcryptVars

struct ConfigDef NcryptVars[]

Definition at line 126 of file config.c.

Functions

Variables

Detailed Description

Function Documentation

◆ config_init_ncrypt()

Variable Documentation

◆ SortKeyMethods

◆ C_CryptUsePka

◆ C_CryptConfirmhook

◆ C_CryptOpportunisticEncrypt

◆ C_CryptOpportunisticEncryptStrongKeys

◆ C_CryptProtectedHeadersRead

◆ C_CryptProtectedHeadersSave

◆ C_CryptProtectedHeadersWrite

◆ C_SmimeIsDefault

◆ C_PgpIgnoreSubkeys

◆ C_PgpLongIds

◆ C_PgpShowUnusable

◆ C_PgpAutoinline

◆ C_PgpDefaultKey

◆ C_PgpSignAs

◆ C_PgpEntryFormat

◆ C_SmimeDefaultKey

◆ C_SmimeSignAs

◆ C_SmimeEncryptWith

◆ C_CryptProtectedHeadersSubject

◆ C_EnvelopeFromAddress

◆ C_CryptTimestamp

◆ C_PgpEncryptSelf

◆ C_PgpMimeAuto

◆ C_PgpRetainableSigs

◆ C_PgpSelfEncrypt

◆ C_PgpStrictEnc

◆ C_SmimeEncryptSelf

◆ C_SmimeSelfEncrypt

◆ C_CryptUseGpgme

◆ C_PgpCheckExit

◆ C_PgpCheckGpgDecryptStatusFd

◆ C_PgpDecryptionOkay

◆ C_PgpGoodSign

◆ C_PgpTimeout

◆ C_PgpUseGpgAgent

◆ C_PgpClearsignCommand

◆ C_PgpDecodeCommand

◆ C_PgpDecryptCommand

◆ C_PgpEncryptOnlyCommand

◆ C_PgpEncryptSignCommand

◆ C_PgpExportCommand

◆ C_PgpGetkeysCommand

◆ C_PgpImportCommand

◆ C_PgpListPubringCommand

◆ C_PgpListSecringCommand

◆ C_PgpSignCommand

◆ C_PgpVerifyCommand

◆ C_PgpVerifyKeyCommand

◆ C_PgpSortKeys

◆ C_SmimeAskCertLabel

◆ C_SmimeCaLocation

◆ C_SmimeCertificates

◆ C_SmimeDecryptCommand

◆ C_SmimeDecryptUseDefaultKey

◆ C_SmimeEncryptCommand

◆ C_SmimeGetCertCommand

◆ C_SmimeGetCertEmailCommand

◆ C_SmimeGetSignerCertCommand

◆ C_SmimeImportCertCommand

◆ C_SmimeKeys

◆ C_SmimePk7outCommand

◆ C_SmimeSignCommand

◆ C_SmimeSignDigestAlg

◆ C_SmimeTimeout

◆ C_SmimeVerifyCommand

◆ C_SmimeVerifyOpaqueCommand

◆ C_PgpAutoDecode

◆ C_CryptVerifySig

◆ NcryptVars