Crypto API

Author:

Stephan Mueller

Author:

Marek Vasut

This documentation outlines the Linux kernel crypto API with its concepts, details about developing cipher implementations, employment of the API for cryptographic use cases, as well as programming examples.

Table of contents

• Kernel Crypto API Interface Specification
  • Introduction
  • Terminology
• Scatterlist Cryptographic API
  • Introduction
  • Details
  • Developer Notes
  • Adding New Algorithms
  • Bugs
  • Further Information
  • Authors
  • Credits
• Kernel Crypto API Architecture
  • Cipher algorithm types
  • Ciphers And Templates
  • Synchronous And Asynchronous Operation
  • Crypto API Cipher References And Priority
  • Key Sizes
  • Cipher Allocation Type And Masks
  • Internal Structure of Kernel Crypto API
• Asynchronous Transfers/Transforms API
  • 1. Introduction
  • 2.Genealogy
  • 3. Usage
  • 4. Driver Development Notes
• Asymmetric / Public-key Cryptography Key Type
  • Overview
  • Key Identification
  • Accessing Asymmetric Keys
  • Asymmetric Key Subtypes
  • Instantiation Data Parsers
  • Keyring Link Restrictions
• Developing Cipher Algorithms
  • Registering And Unregistering Transformation
  • Single-Block Symmetric Ciphers [CIPHER]
  • Multi-Block Ciphers
  • Hashing [HASH]
• User Space Interface
  • Introduction
  • User Space API General Remarks
  • In-place Cipher operation
  • Message Digest API
  • Symmetric Cipher API
  • AEAD Cipher API
  • Random Number Generator API
  • Zero-Copy Interface
  • Setsockopt Interface
  • User space API example
• Crypto Engine
  • Overview
  • Requirement
  • Order of operations
• Programming Interface
  • Block Cipher Algorithm Definitions
  • Symmetric Key Cipher API
  • Symmetric Key Cipher Request Handle
  • Single Block Cipher API
  • Authenticated Encryption With Associated Data (AEAD) Algorithm Definitions
  • Authenticated Encryption With Associated Data (AEAD) Cipher API
  • Asynchronous AEAD Request Handle
  • Message Digest Algorithm Definitions
  • Asynchronous Message Digest API
  • Asynchronous Hash Request Handle
  • Synchronous Message Digest API
  • Random Number Algorithm Definitions
  • Crypto API Random Number API
  • Asymmetric Cipher Algorithm Definitions
  • Asymmetric Cipher API
  • Asymmetric Cipher Request Handle
  • Key-agreement Protocol Primitives (KPP) Cipher Algorithm Definitions
  • Key-agreement Protocol Primitives (KPP) Cipher API
  • Key-agreement Protocol Primitives (KPP) Cipher Request Handle
  • ECDH Helper Functions
  • DH Helper Functions
• Code Examples
  • Code Example For Symmetric Key Cipher Operation
  • Code Example For Use of Operational State Memory With SHASH
  • Code Example For Random Number Generator Usage
• Fast & Portable DES encryption & decryption
  • motivation and history
  • porting notes
  • OPTIONAL performance optimizations
  • coding notes
  • special efficient data format
  • Getting it to compile on your machine
  • Speeding up kerberos (and/or its des library)
  • Other uses
• Hardware Device Driver Specific Documentation
  • octeontx2 devlink support