Community hub
0 subscribers7 pages, 0 posts
Recent from talks
Be the first to start a discussion here.
Be the first to start a discussion here.
Be the first to start a discussion here.
Be the first to start a discussion here.
Contribute something
Welcome to the community hub built to collect knowledge and have discussions related to Libgcrypt.
Nothing was collected or created yet.
Libgcrypt
View on Wikipediafrom Wikipedia
| Libgcrypt | |||||
|---|---|---|---|---|---|
| Original author | Werner Koch | ||||
| Developer | GnuPG community[1] | ||||
| Stable release(s) [±] | |||||
| |||||
| Repository | |||||
| Written in | C | ||||
| Operating system | Cross-platform | ||||
| Type | Cryptographic library | ||||
| License | GNU Lesser General Public License (LGPLv2.1+) / GNU General Public License (GPLv2+)[4] | ||||
| Website | gnupg | ||||
Libgcrypt is a cryptography library developed as a separated module of GnuPG.[5] It can also be used independently of GnuPG, but depends on its error-reporting library Libgpg-error.[6]
It provides functions for all fundamental cryptographic building blocks:
Libgcrypt features its own multiple precision arithmetic implementation, with assembler implementations for a variety of processors, including Alpha, AMD64, HP PA-RISC, i386, i586, M68K, MIPS 3, PowerPC, and SPARC. It also features an entropy gathering utility, coming in different versions for Unix-like and Windows machines.
Usually multiple, stable branches of Libgcrypt are maintained in parallel; since 2022-03-28 this is the Libgrypt 1.10 branch as stable branch, plus the 1.8 branch as LTS ("long-term support") branch, which will be maintained at least until 2024-12-31.[17]
See also
[edit]
References
[edit]- ^ "AUTHORS". Retrieved 2021-02-09.
- ^ "Libgcrypt 1.12.0 released". gnupg.org. 29 January 2026. Retrieved 29 January 2026.
- ^ "Libgcrypt 1.8.11 released". dev.gnupg.org. 2023-11-16. Retrieved 2023-11-16.
- ^ "Copying". Libgcrypt. 2021-02-04. Retrieved 2021-02-09.
- ^ Koch, Werner (1998-12-04). "libgcrypt" (Mailing list). gnupg-devel. Retrieved 2017-08-30.
- ^ "Libgpg-error". GnuPG software. 2017-03-22. Retrieved 2017-12-13.
- ^ "src/cipher.h". 2017-06-16. Retrieved 2017-08-30.
- ^ "Available ciphers". The Libgcrypt Reference Manual. 2017-08-27. Retrieved 2017-08-30.
- ^ "Available cipher modes". The Libgcrypt Reference Manual. 2017-08-27. Retrieved 2017-08-30.
- ^ "Available algorithms". The Libgcrypt Reference Manual. 2017-08-27. Retrieved 2017-08-30.
- ^ "Cryptographic Functions". The Libgcrypt Reference Manual. 2017-08-27. Retrieved 2017-08-30.
- ^ "Available hash algorithms". The Libgcrypt Reference Manual. 2017-08-27. Retrieved 2017-08-30.
- ^ Shen, Sean; Lee, Xiaodong; Tse, Ronald Henry; Kit, Wong Wai; Yang, Paul (2018-01-08). "The SM3 Cryptographic Hash Function". Internet Engineering Task Force. Retrieved 2023-11-16.
- ^ "Available MAC algorithms". The Libgcrypt Reference Manual. 2017-08-27. Retrieved 2017-08-30.
- ^ "Key Derivation". The Libgcrypt Reference Manual. 2017-08-27. Retrieved 2017-08-30.
- ^ Shen, Sean; Lee, Xiaodong (2014-02-14). "SM2 Digital Signature Algorithm". Internet Engineering Task Force. Retrieved 2023-11-16.
- ^ "End-of-life dates for GnuPG and Libgcrypt". GnuPG software. 2021-02-04. Retrieved 2021-02-07.
Libgcrypt
View on Grokipediafrom Grokipedia
Libgcrypt is a free software cryptographic library developed by the GNU Project as a general-purpose collection of building blocks for implementing secure encryption, hashing, and authentication in applications. Originally derived from the code used in GnuPG, it provides portable, efficient implementations of symmetric ciphers such as AES, ChaCha20, and Twofish; hash algorithms including SHA-2, SHA-3, and Whirlpool; message authentication codes like HMAC and CMAC; and public-key cryptography support for algorithms such as RSA, ECDSA, and EdDSA.[1]
The library emphasizes security and compliance with modern cryptographic standards, offering modes of operation for ciphers (e.g., GCM, OCB) and additional utilities for random number generation, large integer arithmetic, and key derivation functions, making it suitable for both low-level and high-level cryptographic needs across POSIX systems and Microsoft Windows.[1] It depends on the companion library libgpg-error for error handling and maintains API/ABI compatibility since version 1.2 to ensure seamless integration in software projects.[1] Licensed under the GNU Lesser General Public License version 2.1 or later (LGPLv2.1+), Libgcrypt allows linking with proprietary software while requiring source code availability for modifications.[1]
Development of Libgcrypt began as a modular extraction from GnuPG to promote reusability, with the project hosted under the GnuPG umbrella and distributed via the official GnuPG servers due to historical U.S. export restrictions on cryptography.[1] The current stable release is version 1.11.2, issued on August 4, 2025, following a series of updates that include long-term support for version 1.8 and end-of-life designations for earlier branches like 1.7 in 2019.[1] Source code and documentation are maintained in a public Git repository, encouraging community contributions while adhering to GNU's free software principles.[1]
Failure to call this function early can lead to undefined behavior, such as warnings about missing initialization in logs.[4]
Configuration of Libgcrypt occurs primarily through the
Introduction
Overview
Libgcrypt is a general-purpose cryptographic library that provides essential building blocks for implementing secure applications, including symmetric ciphers, hash algorithms, message authentication codes (MACs), public-key algorithms, key derivation functions, and random number generation.[1] Originally derived from the code used in GnuPG, it serves as a modular component that can operate independently while sharing foundational elements with the GNU Privacy Guard ecosystem.[2] The library's primary use cases include performing standalone cryptographic operations in software applications, integrating with GnuPG tools for enhanced security features, and supporting broader needs such as secure communications protocols and data protection mechanisms.[1] Libgcrypt requires the companion libgpg-error library for standardized error handling across GnuPG-related components.[3] As of November 2025, the current stable version is 1.11.2, released on August 4, 2025.[1] It offers cross-platform compatibility, running natively on most POSIX-compliant systems and pre-POSIX environments, with support for Windows through cross-compilation, and architectures such as x86 and ARM.[1]Design Principles
Libgcrypt emphasizes modularity by providing a collection of low-level cryptographic primitives, such as symmetric ciphers, hash functions, message authentication codes, public-key algorithms, multi-precision integer operations, and random number generation, without implementing higher-level protocols like OpenPGP or S/MIME.[1][4] This design allows developers to integrate these building blocks flexibly into custom applications or larger systems, avoiding the constraints of protocol-specific libraries.[5] Originally extracted as a modular component from the GnuPG codebase, Libgcrypt enables reuse across the GNU ecosystem while maintaining independence.[1] A security-first approach guides Libgcrypt's development, prioritizing robust protections against common threats. The library includes deprecated or insecure algorithms for compatibility but deprecates them and favors modern standards such as AES and SHA-256 over weak options like MD5 or SHA-1.[4] Recent versions include various constant-time operation improvements, with ongoing development for critical functions such as RSA decryption and modular exponentiation using techniques like Barrett or Montgomery reduction where applicable.[6][7][8] Version 1.11.0 introduced support for quantum-resistant algorithms like Kyber and Classic McEliece, along with new APIs for Key Encapsulation Mechanisms (KEMs), enhancing preparedness for post-quantum cryptography.[8] For randomness, Libgcrypt employs a cryptographically secure pseudorandom number generator (CSPRNG) with dedicated entropy gathering modules that collect high-quality entropy from sources like /dev/random, getentropy(), or hardware, ensuring sufficient mixing before output and including fork detection for process isolation.[9][10] Portability and efficiency are core to Libgcrypt's implementation, written in ANSI C to ensure compatibility across POSIX systems, Windows, and other platforms without reliance on non-standard features.[4] To optimize performance, the library includes hand-optimized assembler code for specific architectures, such as AMD64 for x86-64 processors, ARM for embedded and mobile devices, and PowerPC, accelerating operations like AES encryption and elliptic curve computations where hardware support allows.[1] This balance enables broad deployment while delivering efficient execution suitable for both resource-constrained environments and high-performance servers.[4] Libgcrypt maintains API stability through backward compatibility since version 1.2.0, preserving the application binary interface (ABI) and ensuring that applications built against earlier stable releases continue to function without modification across subsequent updates.[1] As part of the GNU Project, it is developed under the GNU Lesser General Public License (LGPLv2.1+), promoting open-source principles that facilitate code auditability, security reviews by the community, and collaborative contributions via public Git repositories.[1] This ethos supports ongoing scrutiny and improvement, aligning with GNU guidelines for free software accessibility and trustworthiness.[4]History
Origins and Development
Libgcrypt originated as the cryptographic component within GnuPG (GNU Privacy Guard), an open-source implementation of the OpenPGP standard developed by Werner Koch and first released on September 7, 1999. The library's code was initially embedded in GnuPG to handle symmetric and asymmetric encryption, hashing, and other primitives, but it was extracted into a standalone module around 2000–2001 to facilitate reuse in other software projects independent of GnuPG.[1] This separation was motivated by the need for a modular, general-purpose cryptographic backend, particularly in the context of U.S. export controls on cryptographic software during the late 1990s and early 2000s, allowing distribution through GNU servers without the full GnuPG package.[11] The initial standalone release, version 1.1.0, arrived in April 2001, representing the first distinct version detached from GnuPG's monolithic architecture and designated as alpha quality.[12] Subsequent alpha releases, such as 1.1.3 in June 2001, refined the library while emphasizing its experimental status.[13] Libgcrypt is maintained by the GnuPG Project under the GNU Project umbrella, with development coordinated through community contributions from security researchers and distributed via GNU's infrastructure.[1] Version control transitioned to Git in the mid-2000s, enabling collaborative enhancements while preserving backward compatibility.[14] Key early milestones include the integration with libgpg-error in the early 2000s, which standardized error reporting across GnuPG-related libraries. Around 2017, the project adopted a multi-branch strategy for long-term support, exemplified by the 1.8 series as an LTS branch, alongside shorter development cycles to balance stability and innovation.[15]Major Releases
Libgcrypt's development follows a branching strategy that includes stable branches for ongoing maintenance, long-term support (LTS) branches for extended enterprise use, and end-of-life (EOL) designations for older series. The 1.8 series serves as an LTS branch, receiving security and stability updates.[1] The current stable branch, 1.11, began with version 1.11.0 in June 2024 and remains ABI-stable, with patch releases like 1.11.2 in August 2025 addressing bug fixes.[8][16] Earlier series, such as 1.6 and 1.7, reached EOL on June 30, 2017, and June 30, 2019, respectively, after which no further updates were provided.[1] Major releases occur approximately every 1-2 years, with patch releases issued more frequently for security and stability enhancements. The 1.2.0 release on April 16, 2004, marked the first stable version with full API and ABI compatibility, establishing a foundation for subsequent development while transitioning to LGPL licensing.[17][1] Version 1.4.0, released on December 10, 2007, introduced experimental elliptic curve support including ECDSA and enhanced FIPS 140-2 compliance options for enterprise environments, while maintaining upward compatibility with the 1.2 series.[18][19] The 1.5.0 release on June 29, 2011, focused on performance and security improvements, incorporating Intel AES-NI instructions for side-channel mitigations and adding support for ECDH, OAEP, and PSS padding schemes.[20] In December 2013, version 1.6.0 added Ed25519 support and mitigations against the Yarom/Falkner side-channel attack (CVE-2013-4242), alongside performance boosts for ciphers and hashes.[21] The 1.7.0 release on April 15, 2016, expanded algorithm support with SHA-3 variants, OCB mode, and additional ECC curves like Curve25519 and secp256k1.[22] Version 1.8.0, released on July 18, 2017, introduced XTS mode and Blake-2 hashing as part of its LTS designation, emphasizing long-term stability for production systems.[23] The 1.9.0 release on January 19, 2021, added Ed448 and X448 curves along with EAX mode, though it was quickly superseded by 1.9.1 due to a critical bug.[24][25] In March 2022, 1.10.1 launched the 1.10 stable branch, incorporating Argon2 and Balloon KDF modes while preparing infrastructure for post-quantum cryptography through new control codes for algorithm validation.[26][27] The most recent major release, 1.11.0 on June 19, 2024, advanced post-quantum readiness with a new KEM API and support for algorithms like NTRU Prime sntrup761, Kyber (FIPS 203), and Classic McEliece, alongside aliases for Brainpool curves (bp256, bp384, bp512).[8] This version maintains full API/ABI compatibility with prior series, ensuring seamless upgrades.[8]Technical Features
Supported Algorithms
Libgcrypt provides a comprehensive set of cryptographic primitives, including symmetric and asymmetric algorithms, hash functions, message authentication codes, and key derivation functions, all implemented to support secure applications within the GNU ecosystem.[28]Symmetric Ciphers
Libgcrypt supports a variety of symmetric block and stream ciphers, enabling encryption and decryption operations for data protection. The library includes AES in all standard variants (128, 192, and 256-bit keys), which operates on 128-bit blocks and is widely used for its efficiency and security.[29] Other block ciphers encompass Blowfish (key sizes from 8 to 576 bits in 8-bit increments, 64-bit blocks), Camellia (128, 192, and 256-bit keys, 128-bit blocks), CAST5 (128-bit keys, 64-bit blocks), DES and 3DES (56-bit effective key for DES, 168-bit for 3DES, 64-bit blocks), Twofish (128 and 256-bit keys, 128-bit blocks), Serpent (128, 192, and 256-bit keys, 128-bit blocks), SEED (128-bit keys, 128-bit blocks), and Arcfour (RC4 stream cipher with variable key sizes up to 256 bits).[29] Stream ciphers like ChaCha20 (256-bit keys, stream cipher) are also available for high-speed applications.[29] These ciphers can be operated in multiple modes to suit different security requirements, including ECB (Electronic Codebook), CBC (Cipher Block Chaining), CFB (Cipher Feedback), OFB (Output Feedback), CTR (Counter), GCM (Galois/Counter Mode for authenticated encryption), CCM (Counter with CBC-MAC), OCB (Offset Codebook Mode), and XTS (XEX-based Tweaked Codebook for disk encryption).[30] Advanced AEAD (Authenticated Encryption with Associated Data) modes such as EAX, SIV, GCM-SIV, and Poly1305 are likewise supported, providing integrity alongside confidentiality.[30]Hash Functions
The library implements a broad range of hash algorithms for data integrity and digital signatures, covering legacy, standard, and modern variants. Supported hashes include the SHA family: SHA-1 (160-bit output), SHA-224/256/384/512 (224 to 512-bit outputs), SHA-512/224 and SHA-512/256 (truncated variants), and SHA3-224/256/384/512 (Keccak-based, 224 to 512-bit outputs).[31] Additionally, SHAKE128 and SHAKE256 (extendable-output functions with 128- and 256-bit security levels) enable variable-length outputs. The MD family features MD2, MD4, and MD5 (128-bit outputs, though MD2 is reserved without implementation). Other hashes comprise RIPEMD-160 (160-bit), Tiger and its variants (Tiger1, Tiger2, 192-bit), Whirlpool (512-bit), and newer additions like Blake2b (160 to 512-bit variants) and Blake2s (128 to 256-bit variants), along with SM3 (256-bit) and Stribog (256/512-bit).[31]Message Authentication
Libgcrypt facilitates message authentication through several mechanisms to verify data integrity and authenticity. HMAC (Hash-based Message Authentication Code) is supported with all aforementioned hash functions, such as HMAC-SHA256 and HMAC-Whirlpool, allowing flexible construction based on the underlying hash's properties.[32] CMAC (Cipher-based MAC) is available for block ciphers including AES, 3DES, Camellia, CAST5, Blowfish, Twofish, Serpent, SEED, and SM4, providing a standards-compliant alternative to HMAC. Poly1305, a high-speed authenticator, operates in standalone mode or combined with ciphers like AES (as in Poly1305-AES), Camellia, Twofish, Serpent, and SEED, adhering to RFC 8439 for AEAD constructions.[32] Further options include GMAC with AES, Camellia, Twofish, Serpent, and SEED, as well as GOST28147_IMIT for legacy compatibility.[32]Public-Key Algorithms
Public-key cryptography in Libgcrypt supports key generation, encryption, and signing for secure communication and authentication. RSA is implemented with key sizes up to 8192 bits, suitable for both encryption and signatures. DSA (Digital Signature Algorithm) and ElGamal are provided for signing and encryption, respectively, with standard parameter sets. Elliptic Curve Cryptography (ECC) is extensively supported, including ECDSA (Elliptic Curve DSA) and EdDSA (Edwards-curve DSA) for signatures, as well as ECDH for key agreement. Specific curves include NIST standards (P-192, P-224, P-256, P-384, P-521), Brainpool curves (P256r1, P384r1, P512r1), Curve25519 and ed25519 (per RFC 7748 and RFC 8032), and secp256k1 for broader compatibility.[33][34]Key Derivation
To derive keys from passphrases or other inputs, Libgcrypt includes robust key derivation functions (KDFs) resistant to brute-force attacks. PBKDF2 (PKCS#5 v2.0) supports iterations and salting with underlying hashes like SHA-256. Scrypt provides memory-hard derivation with parameters for cost (N), parallelization (p), and salt size. Argon2 variants—Argon2i (data-independent), Argon2d (data-dependent), and Argon2id (hybrid)—offer advanced memory-hard protection, configurable with memory, time, and parallelism costs, as added in version 1.11.0. OpenPGP S2K modes (simple, salted, and iterated+salted) are also available for legacy compatibility.[35][36]Other Primitives
Beyond core algorithms, Libgcrypt incorporates a Multi-Precision Integer (MPI) library for arbitrary-precision arithmetic, essential for public-key operations and modular exponentiation. This enables efficient handling of large integers in cryptographic computations. Elliptic curve operations are integrated via the ECC framework, leveraging the aforementioned curves for optimized performance in constrained environments.[28]Random Number Generation
Libgcrypt employs a multi-layered random number generation system designed to provide cryptographically secure randomness for various applications, including key generation and nonce creation. The library supports multiple pseudorandom number generator (PRNG) types to balance security, performance, and compliance requirements. The standard DRNG, based on Peter Gutmann's continuous seeding PRNG using SHA-1, serves as the default mechanism and is continuously reseeded with fresh entropy to maintain unpredictability. For FIPS 140-2 compliance, Libgcrypt implements a deterministic random number generator (DRNG) adhering to NIST SP 800-90A, utilizing AES in X9.31 mode, which undergoes power-up self-tests and restricts operations to approved algorithms. Additionally, a system-dependent secure random option wraps native operating system interfaces, such as /dev/urandom on Unix-like systems, while a weak random variant is available for non-cryptographic purposes, often mapping to the strong random pool or using nonce generation techniques to avoid depleting high-quality entropy.[37][38] Entropy collection in Libgcrypt draws from diverse sources to ensure a robust pool of unpredictable bits, mitigating risks from single-point failures. Primary sources include system calls like getrandom() or /dev/urandom on Unix systems, which provide kernel-generated entropy based on hardware events and interrupts. Hardware random number generators (RNGs), such as Intel's RDRAND instruction on x86 processors or VIA Padlock engines, are integrated when available to inject high-entropy bits directly from physical noise sources like thermal variations. In legacy modes, particularly on older Unix systems, entropy can be gathered via the Entropy Gathering Daemon (EGD) or Unix-specific collectors that poll process timings and system statistics, historically including inputs from devices like keyboards and mice for additional variability, though modern implementations prioritize more reliable kernel and hardware methods. These sources are modular, allowing configuration to disable or prioritize certain collectors for environmental adaptability.[37][38] Initialization of the random number subsystem occurs automatically upon library startup, but users can accelerate it using gcry_control(GCRYCTL_ENABLE_QUICK_RANDOM), which permits faster access to the strong random pool by relaxing initial entropy requirements, though this is disabled in FIPS mode to enforce strict compliance. Automatic reseeding happens periodically through entropy polling, ensuring the PRNG remains resistant to state exhaustion or prediction. In FIPS mode, the deterministic DRNG requires explicit derivation functions and reseeds only after a fixed number of outputs (e.g., 1000 blocks), preventing reliance on continuous external entropy while maintaining forward security.[37] To address security threats like prediction attacks, Libgcrypt implements periodic entropy polling from configured sources, continuously refreshing the internal pool to exceed the entropy needed for the requested security level and thwarting attempts to infer future outputs from observed ones. The FIPS-mode DRNG further enhances this by operating deterministically post-seed, avoiding backtracking vulnerabilities inherent in some continuous-seeding designs. Configuration is handled via the gcry_random_level_t enumeration, offering levels such as GCRY_WEAK_RANDOM for low-security needs (e.g., nonces), GCRY_STRONG_RANDOM (or normal) for general cryptographic use like session keys, GCRY_VERY_STRONG_RANDOM for high-stakes operations like long-term keys, and secure variants that allocate output in tamper-resistant memory to prevent side-channel leaks. These levels allow applications to tailor randomness quality without altering the underlying PRNG architecture.[37][38]Architecture
Core Components
Libgcrypt's architecture centers on a core engine that handles algorithm dispatching and state management through dedicated subsystems for symmetric encryption, hashing, public-key operations, and more. This engine provides a unified interface for selecting and invoking cryptographic primitives, routing requests to the appropriate implementation based on the chosen algorithm and mode. Context handles, such asgcry_cipher_hd_t for symmetric ciphers and gcry_hash_hd_t for message digests, encapsulate the operational state, including keys, initialization vectors, and partial computations, ensuring that operations like encryption or hashing maintain continuity across multiple calls without global state pollution. These handles are created via functions like gcry_cipher_open or gcry_hash_open, used for processing data, and released with gcry_cipher_close or gcry_hash_close, forming an open-use-close paradigm that interconnects the subsystems efficiently.[39]
Error handling in Libgcrypt is tightly integrated with the libgpg-error library, which standardizes error codes across GnuPG components for consistent reporting. All library functions return gcry_error_t values, which combine an error source (e.g., GCRYERR_SOURCE) and a code (e.g., GPG_ERR_NO_ERROR for success or GPG_ERR_INV_VALUE for invalid arguments), allowing precise diagnosis without information loss during propagation from internal engines to the application. This integration ensures that errors from algorithm dispatching or context operations are uniformly managed, with aliases provided for libgpg-error functions to maintain namespace consistency within Libgcrypt.[3]
The library employs a reentrant design to support multi-threading, relying on user-registered callbacks to synchronize access across POSIX threads (pthreads) or GNU Pth. Thread safety is enabled by calling gcry_control(GCRYCTL_SET_THREAD_CBS, &gcry_threads_pthread) during initialization, which installs mutex operations like gcry_pthread_mutex_lock and gcry_pthread_mutex_unlock to protect shared resources such as random number pools and context handles. This callback mechanism allows the core engine to wrap blocking calls and coordinate with the application's threading model, ensuring that algorithm dispatching and state management remain safe in concurrent environments while avoiding inherent non-thread-safe operations like certain in-place modifications.[40]
Memory management emphasizes security through dedicated allocation functions that interconnect with the core engine and context handles. The gcry_malloc_secure function allocates memory from a protected pool designed for sensitive data, such as keys and intermediates, using constant-time wiping via gcry_free to mitigate timing attacks by preventing residual data leakage even if the operating system swaps or reuses pages. Standard allocations via gcry_malloc suffice for non-sensitive buffers, but secure memory integrates seamlessly with handles—e.g., cipher keys passed to gcry_cipher_setkey are copied into secure space if allocated accordingly—enhancing overall resistance to side-channel exploits during dispatching and processing. Applications can override these allocators via gcry_control for custom secure handling.[41]
Platform adaptations are facilitated by an Autoconf-based build system that detects and enables CPU-specific accelerations during configuration, optimizing the core engine's dispatching to hardware features like Intel AES-NI for faster symmetric operations. The ./configure script probes for instructions such as intel-aesni, arm-aes, or ppc-altivec, compiling assembly-optimized implementations accordingly and exposing them through runtime checks via gcry_control(GCRYCTL_GET_HWFEATURES). This ensures context handles leverage native accelerations transparently, with options to disable features post-build (e.g., via /etc/gcrypt/hwf.deny) for compatibility or security policies, interconnecting hardware awareness across error handling, threading, and memory subsystems without altering the API.[42]
Multi-Precision Arithmetic
Libgcrypt's multi-precision integer (MPI) library provides the foundational arithmetic capabilities required for asymmetric cryptography, enabling operations on arbitrarily large integers through thegcry_mpi_t data type. This type represents multi-precision integers as opaque handles, internally structured as arrays of limbs—machine-word-sized units, typically 32 bits on 32-bit systems or 64 bits on 64-bit architectures—to facilitate efficient storage and computation. The library supports integers of arbitrary size, constrained primarily by available memory.[37]
The MPI library offers a comprehensive set of operations, including basic arithmetic such as addition via gcry_mpi_add, which computes the sum of two MPIs and stores the result in a third; multiplication through gcry_mpi_mul; and subtraction with gcry_mpi_sub. For cryptographic needs, it includes modular exponentiation with gcry_mpi_powm, essential for algorithms like RSA and DSA, where the result is reduced modulo a specified base; and modular inverse computation using gcry_mpi_invm, which finds the multiplicative inverse under a modulus. Primality testing is supported by gcry_prime_check, a probabilistic function using the Miller-Rabin algorithm that returns 0 if the MPI is likely prime and GPG_ERR_NO_PRIME otherwise. Allocation and deallocation are handled by gcry_mpi_new (or its secure-memory variant gcry_mpi_snew) for creating new MPIs with an optional initial bit length, and gcry_mpi_release for cleanup.[43][44]
The implementation consists of portable C code derived from an early version of the GNU Multi-Precision Library (GMP), extensively modified for security and reduced footprint, with assembler accelerations to enhance performance on specific architectures. For instance, x86-64 benefits from optimized assembly for operations like Karatsuba multiplication, while ARM processors utilize tailored code for Montgomery reduction, enabling faster modular arithmetic critical for exponentiation. These low-level optimizations are selectively enabled at runtime based on CPU detection, balancing portability with speed gains of up to several times over pure C implementations.[37]
Internally, the MPI library integrates seamlessly with higher-level cryptographic primitives, such as elliptic curve cryptography (ECC) point arithmetic—using structures like gcry_mpi_point_t built on MPIs for point addition and scalar multiplication—and key generation routines that rely on primality testing and modular operations to produce secure parameters. This backend ensures consistent, side-channel-resistant arithmetic across Libgcrypt's public-key algorithms.[43][37]
Usage
Initialization and Configuration
To use Libgcrypt in an application, the library must first be loaded and initialized by calling the functiongcry_check_version, which verifies the library version against a required minimum and performs initial subsystem setup, including synchronization for multi-threaded access.[4] This function must be invoked as the first Libgcrypt operation, before any cryptographic functions, and it returns a string with the actual version (e.g., "1.10.2") or NULL if the version is incompatible.[4] For example, the following code checks for a minimum version:
c
#include <gcrypt.h>
if (!gcry_check_version (GCRYPT_VERSION)) {
fputs ("libgcrypt is too old (need " GCRYPT_VERSION ")\n", stderr);
exit (2);
}
#include <gcrypt.h>
if (!gcry_check_version (GCRYPT_VERSION)) {
fputs ("libgcrypt is too old (need " GCRYPT_VERSION ")\n", stderr);
exit (2);
}
gcry_control function, which allows fine-tuning of library behavior before full operational use.[4] To enable FIPS 140-2 mode, which restricts the library to approved algorithms and enforces stricter security checks, invoke gcry_control(GCRYCTL_FORCE_FIPS_MODE, 1) prior to gcry_check_version; this mode can also be triggered via the environment variable LIBGCRYPT_FORCE_FIPS_MODE=1 or system files like /etc/gcrypt/fips_enabled.[4] For multi-threaded applications, thread safety is handled automatically since version 1.6, but older setups may require gcry_control(GCRYCTL_SET_THREAD_CBS, &callbacks) to register custom thread callbacks, though this is now obsolete.[4] Hardware acceleration features, such as Intel RDRAND or VIA Padlock, can be disabled with gcry_control(GCRYCTL_DISABLE_HWF, "feature_name", NULL) before initialization to ensure portability or compliance; these features are detected via system interfaces like /proc/cpuinfo on Linux.[4] After configuration, signal the end of setup with gcry_control(GCRYCTL_INITIALIZATION_FINISHED, 0) to notify the library that no further changes are expected.[4]
Error handling during initialization involves checking return values from these functions, which are of type gcry_error_t; a value of GPG_ERR_NO_ERROR (0) indicates success, while GPG_ERR_GENERAL (1) or other codes like GPG_ERR_ENOMEM signal failures such as version mismatches or memory allocation issues.[4] Applications should use gcry_strerror(err) to obtain human-readable descriptions for logging or user feedback.[4] Secure memory, used for sensitive data like keys, must be allocated early via gcry_control(GCRYCTL_INIT_SECMEM, size, 0) (e.g., 16384 bytes), potentially requiring elevated privileges on some systems, and can be disabled with GCRYCTL_DISABLE_SECMEM if not needed.[4]
For long-running applications, resource cleanup is recommended at shutdown by calling gcry_control(GCRYCTL_TERM_SECMEM, 0) to zeroize and release secure memory, ensuring sensitive data is securely wiped; this operation is safe in signal handlers or exit routines but not thread-safe.[4] Environment variables like GCRY_DEBUG can enable debug output during setup for troubleshooting, while HOME influences default paths for configuration files such as /etc/gcrypt/.[4] To promote locale-independent behavior, especially for error messages and string handling, applications should set LC_ALL=C before loading the library.
Programming Interfaces
Libgcrypt provides a C-based application programming interface (API) for cryptographic operations, designed for ease of use while maintaining security through secure memory allocation and error reporting. The API follows a handle-based model where contexts are created for specific operations, configured, used, and then closed to ensure proper resource management and data wiping. This interface assumes that the library has been initialized via functions likegcry_check_version and gcry_control, as detailed in prior configuration steps.[45]
Cipher API
The symmetric cipher API enables encryption and decryption using block and stream ciphers such as AES. To perform operations, a handle is first allocated withgcry_cipher_open, which takes the algorithm ID (e.g., GCRY_CIPHER_AES), mode (e.g., GCRY_CIPHER_MODE_CBC), and flags (e.g., GCRY_CIPHER_SECURE for secure memory). The function returns a gcry_error_t; success yields 0 and populates the handle pointer, while errors include invalid algorithm (GPG_ERR_INV_ALGO) or memory failure.[46]
Next, gcry_cipher_setkey configures the key by providing the handle, a key buffer, and its length in bytes; it returns an error if the length mismatches the algorithm's requirements, such as 128–256 bits for AES. For modes requiring an initialization vector (IV), gcry_cipher_setiv sets it similarly, ensuring the length matches the block size (e.g., 16 bytes for AES). Encryption proceeds with gcry_cipher_encrypt, which processes input data into an output buffer (or in-place if output is null), requiring input lengths to be multiples of the block size in certain modes; it returns 0 on success or errors like buffer overlap (GPG_ERR_INV_ARG). Decryption uses gcry_cipher_decrypt analogously. Finally, gcry_cipher_close releases the handle, zeroizing sensitive data without return value.[46]
A basic AES-256-CBC encryption pseudocode snippet illustrates the flow:
gcry_cipher_hd_t hd;
gcry_error_t err = gcry_cipher_open(&hd, GCRY_CIPHER_AES256, GCRY_CIPHER_MODE_CBC, 0);
if (err) { /* [handle](/page/Handle) error */ }
err = gcry_cipher_setkey(hd, key, 32);
err = gcry_cipher_setiv(hd, iv, 16);
err = gcry_cipher_encrypt(hd, outbuf, outlen, inbuf, inlen);
gcry_cipher_close(hd);
gcry_cipher_hd_t hd;
gcry_error_t err = gcry_cipher_open(&hd, GCRY_CIPHER_AES256, GCRY_CIPHER_MODE_CBC, 0);
if (err) { /* [handle](/page/Handle) error */ }
err = gcry_cipher_setkey(hd, key, 32);
err = gcry_cipher_setiv(hd, iv, 16);
err = gcry_cipher_encrypt(hd, outbuf, outlen, inbuf, inlen);
gcry_cipher_close(hd);
Hash API
Hashing operations compute message digests using algorithms like SHA-256 via a multi-step process.gcry_md_open creates a handle for the specified algorithm ID (e.g., GCRY_MD_SHA256) and flags, returning an error for unsupported algorithms or allocation issues; it allows multiple algorithms in one handle via subsequent gcry_md_enable calls. Data is fed incrementally with gcry_md_write, which appends a buffer of given length to the digest context without return value, supporting efficient streaming for large inputs.[47]
To retrieve the digest, gcry_md_read extracts the result for a specific algorithm (or the primary if unspecified), returning a pointer to the fixed-size output (e.g., 32 bytes for SHA-256) valid until the handle changes; it returns NULL if the algorithm was not enabled. The handle is freed with gcry_md_close, which zeroizes internals and ignores null inputs. This API also supports HMAC by setting the GCRY_MD_FLAG_HMAC flag and a key via gcry_md_setkey.[47]
Public-Key API
Public-key cryptography in Libgcrypt uses S-expressions (gcry_sexp_t) to represent keys, data, and parameters, providing a structured, human-readable format for asymmetric operations like RSA. Key generation occurs with gcry_pk_genkey, which takes a parameter S-expression (e.g., (genkey (rsa (nbits 2048)))) and outputs the keypair S-expression; it returns 0 on success or errors for invalid parameters or insufficient randomness. Encryption employs gcry_pk_encrypt, passing data as an S-expression (e.g., (data (flags pkcs1)(value %m))), the public key S-expression, and receiving the ciphertext S-expression; errors include invalid key format (GPG_ERR_INV_OBJ). Decryption mirrors this with gcry_pk_decrypt using the private key, yielding the plaintext S-expression. These functions ensure padding schemes like PKCS#1 are applied correctly.[48]
A simple RSA signing pseudocode (using gcry_pk_sign analogously to encrypt) might look like:
gcry_sexp_t keypair, data_sexp, sig_sexp;
gcry_pk_genkey(&keypair, parm_sexp); // parm_sexp defines RSA params
gcry_sexp_build(&data_sexp, NULL, "(data (flags raw)(value %s))", hash_data);
gcry_pk_sign(&sig_sexp, data_sexp, keypair); // Uses private key component
gcry_sexp_release(keypair); gcry_sexp_release(data_sexp); gcry_sexp_release(sig_sexp);
gcry_sexp_t keypair, data_sexp, sig_sexp;
gcry_pk_genkey(&keypair, parm_sexp); // parm_sexp defines RSA params
gcry_sexp_build(&data_sexp, NULL, "(data (flags raw)(value %s))", hash_data);
gcry_pk_sign(&sig_sexp, data_sexp, keypair); // Uses private key component
gcry_sexp_release(keypair); gcry_sexp_release(data_sexp); gcry_sexp_release(sig_sexp);
MAC and KDF
Message authentication codes (MACs) such as HMAC and CMAC are handled through a dedicated API.gcry_mac_open allocates a handle for an algorithm ID (e.g., GCRY_MAC_HMAC_SHA256 or GCRY_MAC_CMAC_AES), with flags for secure memory, returning an error for unsupported algorithms; the key is set via gcry_mac_setkey with no length restrictions for HMAC but block-cipher aligned for CMAC. Data is processed with gcry_mac_write (similar to hashing), and the tag retrieved via gcry_mac_read; the handle closes with gcry_mac_close.[49]
For key derivation, gcry_pbkdf2 (via the general gcry_kdf_derive with GCRY_KDF_PBKDF2) derives keys from passphrases, taking the passphrase, hash sub-algorithm (e.g., SHA-256), salt, iteration count, and desired key size, outputting to a buffer; it enforces high iterations (e.g., 100,000+) for resistance to brute-force attacks and returns errors for invalid parameters like zero iterations.[35]
Error Handling
All API functions return agcry_error_t, a composite of source and code, checked via macros like gcry_err_code(err) for values such as GPG_ERR_NO_ERROR (0) or GPG_ERR_INV_VALUE for out-of-range parameters (e.g., invalid key lengths). Common issues include GPG_ERR_INV_ARG for buffer overlaps or GPG_ERR_INV_OPHR for unsupported operations on handles; descriptive strings are obtainable via gcry_strerror. Developers must verify returns immediately to prevent undefined behavior, with the library using libgpg-error for standardized codes across GnuPG components.[50]
Security Considerations
Known Vulnerabilities
Libgcrypt has experienced several notable security vulnerabilities, primarily involving side-channel attacks, buffer overflows, and implementation flaws in cryptographic primitives. A heap buffer overflow vulnerability was discovered in 2021, stemming from an incorrect assumption in the block buffer management code during decryption operations, which could lead to arbitrary code execution. This issue, designated CVE-2021-3345, affected Libgcrypt version 1.9.0 and was fixed in version 1.9.1.[25][51] In 2019, the C implementation of AES in Libgcrypt was found vulnerable to a flush-and-reload side-channel attack, as physical addresses were accessible to other processes, potentially leaking the cipher key. Known as CVE-2019-12904, this flaw impacted versions up to 1.8.4, with assembler implementations unaffected.[52][53] A cache-timing side-channel attack on RSA key operations was identified in 2017, enabling recovery of 1024-bit RSA private keys through monitoring of cache behavior during left-to-right exponentiation. This vulnerability, CVE-2017-7526, was mitigated in Libgcrypt 1.7.8 by adopting a right-to-left sliding-window exponentiation method.[54] In 2024, a timing-based side-channel vulnerability in the RSA implementation was discovered, allowing a Bleichenbacher-style padding oracle attack to recover plaintext from PKCS#1 v1.5 encrypted ciphertexts. Designated CVE-2024-2236, this affects Libgcrypt versions before 1.10.2, 1.9.1, and 1.8.8, and was fixed in those releases.[55] These vulnerabilities were most exploitable in remote scenarios within GnuPG-based applications, such as email encryption, though no widespread breaches have been reported; they nonetheless triggered prompt security patches.[56][51] Vulnerability disclosures for Libgcrypt are coordinated through the GnuPG project, with fixes developed upstream and backported to long-term support branches for broader compatibility.[25][54]Audits and Best Practices
Libgcrypt has been subject to ongoing security reviews through integration with automated testing frameworks and formal validation processes. In 2019, the library was integrated into Google's OSS-Fuzz project, enabling continuous fuzzing to identify potential vulnerabilities in its cryptographic primitives and interfaces. This integration supports differential fuzzing for algorithms, helping to detect implementation flaws early in development. Community-driven audits and code reviews continue via the project's Git repository, where contributors submit patches and security analyses.[57][14] The library achieves partial compliance with FIPS 140-2 standards in versions 1.4 and later, with validated configurations listed in the NIST Cryptographic Module Validation Program (CMVP) database, such as certificate #2657 for version 1.6.3. These validations cover core cryptographic functions but do not constitute full module certification, allowing Libgcrypt to be used within FIPS-certified systems like those in Red Hat Enterprise Linux. More recent versions support FIPS 140-3 mode, enforcing NIST-approved algorithms and self-tests, though enabling this mode does not automatically confer approval as a standalone module. Users should verify current certification status via the NIST database before deployment in regulated environments.[58][59][4] To maximize security, enable FIPS mode explicitly for compliance-sensitive applications using runtime controls likeGCRYCTL_FORCE_FIPS_MODE or environment variables such as LIBGCRYPT_FORCE_FIPS_MODE; this restricts operations to approved algorithms and requires successful self-tests on initialization. Avoid deprecated or weak algorithms, such as SHA-1 for hashing and DES for symmetric encryption, opting instead for stronger alternatives like SHA-256 and AES to prevent known cryptographic weaknesses. Implementations in Libgcrypt incorporate constant-time operations where possible, particularly for RSA decryption and ECC primitives, to resist timing-based side-channel attacks—developers should verify and enable these modes via configuration flags. Always validate inputs to cryptographic functions, such as key sizes and parameters, to mitigate padding oracle attacks and invalid data exploitation.[4][4][6][60]
For production deployments, update to the latest long-term support version in the 1.8 series, which includes security enhancements and bug fixes; the 1.7 series reached end-of-life in 2019. When building higher-level protocols, integrate Libgcrypt with libraries like GnuTLS for TLS/SSL handling, ensuring consistent cryptographic backends across components. In virtualized environments, explicitly test random number generator (RNG) entropy sources, as VMs may exhibit reduced hardware randomness—use gcry_random_bytes_secure and monitor pool quality with tools like rngd to maintain sufficient entropy for key generation. Regularly monitor GnuPG project announcements for patches addressing newly discovered issues in Libgcrypt.[1][61][62][63]
Licensing and Distribution
License Terms
Libgcrypt, the core cryptographic library, is released under the GNU Lesser General Public License version 2.1 or later (LGPLv2.1+), a permissive copyleft license that explicitly allows developers to link the library into proprietary or closed-source applications without obligating the release of the application's source code, provided the library itself remains dynamically linked.[1] This licensing choice facilitates broad integration into diverse software ecosystems, including commercial products, while ensuring the library's source remains freely available for modification and redistribution. In contrast, the accompanying helper programs—such as tools for testing and configuration—and the associated documentation are distributed under the stricter GNU General Public License version 2 or later (GPLv2+), which imposes copyleft requirements on any derivative works, mandating the distribution of source code for modifications.[1] Key implications of the LGPLv2.1+ for users include the rights to freely redistribute the unmodified library, modify it for personal or internal use, and incorporate it into commercial offerings; however, if the library is modified and redistributed (e.g., as part of a larger software package), the modified source code must be made available under the same license, typically via a mechanism that allows relinking with the original or updated library. Dynamic linking preserves proprietary integrity by avoiding the need to disclose application source, whereas static linking would trigger full GPL-like obligations. As with all GNU software, no warranty is provided, and users assume all risk of use.[1] This dual-licensing approach, with LGPL for the library to avoid stronger copyleft restrictions, was adopted to mirror the model of the GnuPG project—from which Libgcrypt's codebase was originally derived—while promoting wider adoption by enabling reuse in non-free software without compromising the GNU project's free software principles.[64][1]Availability and Ports
Libgcrypt source distributions are available from the official GnuPG FTP archive at gnupg.org/ftp/gcrypt/libgcrypt/, with the current stable release being version 1.11.2, issued on August 4, 2025, as the tarball libgcrypt-1.11.2.tar.bz2.[16] Each release includes a corresponding .sig file containing a GnuPG signature, enabling users to verify the integrity and authenticity of the download using public keys from the GnuPG project.[1][65] The library is widely packaged for major Linux distributions, including Debian's libgcrypt20-dev for development files, Fedora's libgcrypt-devel package, and Alpine Linux's libgcrypt-dev, all providing version 1.11.2 in their repositories by late 2025.[66][67] Libgcrypt compiles natively on Linux and BSD platforms and supports cross-compilation for other environments, such as Windows via the MSYS2 MinGW-w64 toolchain, Android using the Native Development Kit (NDK), embedded systems including OpenWrt, and macOS through Homebrew; iOS builds are feasible via similar cross-compilation methods adapted from macOS toolchains.[68][69][70] Developers can access the source code via the official Git repository at dev.gnupg.org/libgcrypt.git, with a web interface available for browsing, and report issues through the project's bug tracker hosted at dev.gnupg.org.[1][71] Historically, Libgcrypt distributions have been hosted on GnuPG-specific mirrors rather than standard GNU archives, a practice stemming from former U.S. export controls on cryptographic software, which were lifted in 2000.[1]References
- https://www.wikidata.org/wiki/Q3237868