The ‘GnuPG Made Easy’ Reference Manual

Short Table of Contents

Table of Contents

Next: , Up: (dir)   [Contents][Index]

Main Menu

This is Edition 1.18.0, last updated 27 April 2022, of The ‘GnuPG Made Easy’ Reference Manual, for Version 1.18.0 of the GPGME library.

• Introduction:  How to use this manual.
• Preparation:  What you should do before using the library.
• Protocols and Engines:  Supported crypto protocols.
• Algorithms:  Supported algorithms.
• Error Handling:  Error numbers and their meanings.
• Exchanging Data:  Passing data to and from GPGME.
• Contexts:  Handling GPGME contexts. 

Appendices
• UI Server Protocol:  The GnuPG UI Server Protocol.
• Debugging:  How to solve problems.
• Deprecated Functions:  Documentation of deprecated functions.
• Library Copying:  The GNU Lesser General Public License says how you can copy and share ‘GnuPG Made Easy’.
• Copying:  The GNU General Public License says how you can copy and share this manual. 

Indices
• Concept Index:  Index of concepts and programs.
• Function and Data Index:  Index of functions, variables and data types. 


 — The Detailed Node Listing —

Introduction
• Getting Started:  Purpose of the manual, and how to use it.
• Features:  Reasons to install and use GPGME.
• Overview:  Basic architecture of the GPGME library. 

Preparation
• Header:  What header file you need to include.
• Building the Source:  Compiler options to be used.
• Largefile Support (LFS):  How to use GPGME with LFS.
• Using Automake:  Compiler options to be used the easy way.
• Using Libtool:  Avoiding compiler options entirely.
• Library Version Check:  Getting and verifying the library version.
• Signal Handling:  How GPGME affects signal handling.
• Multi-Threading:  How GPGME can be used in an MT environment. 

Protocols and Engines
• Engine Version Check:  Verifying the engine version.
• Engine Information:  Obtaining more information about the engines.
• Engine Configuration:  Changing the engine configuration.
• OpenPGP:  Support for the OpenPGP protocol.
• Cryptographic Message Syntax:  Support for the CMS. 

Algorithms
• Public Key Algorithms:  A list of all public key algorithms.
• Hash Algorithms:  A list of all hash algorithms. 

Error Handling
• Error Values:  The error value and what it means.
• Error Codes:  A list of important error codes.
• Error Sources:  A list of important error sources.
• Error Strings:  How to get a descriptive string from a value. 

Exchanging Data
• Creating Data Buffers:  Creating new data buffers.
• Destroying Data Buffers:  Releasing data buffers.
• Manipulating Data Buffers:  Operations on data buffers. 

Creating Data Buffers
• Memory Based Data Buffers:  Creating memory based data buffers.
• File Based Data Buffers:  Creating file based data buffers.
• Callback Based Data Buffers:  Creating callback based data buffers. 

Manipulating Data Buffers
• Data Buffer I/O Operations:  I/O operations on data buffers.
• Data Buffer Meta-Data:  Meta-data manipulation of data buffers.
• Data Buffer Convenience:  Convenience function for data buffers. 

Contexts
• Creating Contexts:  Creating new GPGME contexts.
• Destroying Contexts:  Releasing GPGME contexts.
• Result Management:  Managing the result of crypto operations.
• Context Attributes:  Setting properties of a context.
• Key Management:  Managing keys with GPGME.
• Crypto Operations:  Using a context for cryptography.
• Miscellaneous:  Miscellaneous operations.
• Run Control:  Controlling how operations are run. 

Context Attributes
• Protocol Selection:  Selecting the protocol used by a context.
• Crypto Engine:  Configuring the crypto engine.
• Setting the Sender:  How to tell the engine the sender.
• ASCII Armor:  Requesting ASCII armored output.
• Text Mode:  Choosing canonical text mode.
• Offline Mode:  Choosing offline mode.
• Included Certificates:  Including a number of certificates.
• Key Listing Mode:  Selecting key listing mode.
• Passphrase Callback:  Getting the passphrase from the user.
• Progress Meter Callback:  Being informed about the progress.
• Status Message Callback:  Status messages received from gpg.
• Locale:  Setting the locale of a context. 

Key Management
• Key objects:  Description of the key structures.
• Listing Keys:  Browsing the list of available keys.
• Information About Keys:  Requesting detailed information about keys.
• Manipulating Keys:  Operations on keys.
• Generating Keys:  Creating new key pairs.
• Signing Keys:  Adding key signatures to public keys.
• Exporting Keys:  Retrieving key data from the key ring.
• Importing Keys:  Adding keys to the key ring.
• Deleting Keys:  Removing keys from the key ring.
• Changing Passphrases:  Change the passphrase of a key.
• Changing TOFU Data:  Changing data pertaining to TOFU.
• Advanced Key Editing:  Advanced key edit operation. 

Crypto Operations
• Decrypt:  Decrypting a ciphertext.
• Verify:  Verifying a signature.
• Decrypt and Verify:  Decrypting a signed ciphertext.
• Sign:  Creating a signature.
• Encrypt:  Encrypting a plaintext. 

Sign
• Selecting Signers:  How to choose the keys to sign with.
• Creating a Signature:  How to create a signature.
• Signature Notation Data:  How to add notation data to a signature. 

Encrypt
• Encrypting a Plaintext:  How to encrypt a plaintext. 

Miscellaneous
• Running other Programs:  Running other Programs.
• Using the Assuan protocol:  Using the Assuan protocol.
• Checking for updates:  How to check for software updates. 

Run Control
• Waiting For Completion:  Waiting until an operation is completed.
• Using External Event Loops:  Advanced control over what happens when.
• Cancellation:  How to end pending operations prematurely. 

Using External Event Loops
• I/O Callback Interface:  How I/O callbacks are registered.
• Registering I/O Callbacks:  How to use I/O callbacks for a context.
• I/O Callback Example:  An example how to use I/O callbacks.
• I/O Callback Example GTK+:  How to integrate GPGME in GTK+.
• I/O Callback Example GDK:  How to integrate GPGME in GDK.
• I/O Callback Example Qt:  How to integrate GPGME in Qt.

Next: , Up: (dir)   [Contents][Index]