1 Kernel Crypto API Interface Specification
2 =========================================
3
4 Introduction
5 ------------
6
7 The kernel crypto API offers a rich set of cry
8 as other data transformation mechanisms and me
9 This document contains a description of the AP
10 code.
11
12 To understand and properly use the kernel cryp
13 of its structure is given. Based on the archit
14 separated into different components. Following
15 specification, hints to developers of ciphers
16 the API function call documentation are given
17
18 The kernel crypto API refers to all algorithms
19 Therefore, a cipher handle variable usually ha
20 cryptographic operations, the kernel crypto AP
21 transformations and handles them the same way
22
23 The kernel crypto API serves the following ent
24
25 - consumers requesting cryptographic services
26
27 - data transformation implementations (typica
28 called by consumers using the kernel crypto
29
30 This specification is intended for consumers o
31 well as for developers implementing ciphers. T
32 however, does not discuss all API calls availa
33 implementations (i.e. implementations of ciphe
34 transformations (such as CRC or even compressi
35 register with the kernel crypto API).
36
37 Note: The terms "transformation" and cipher al
38 interchangeably.
39
40 Terminology
41 -----------
42
43 The transformation implementation is an actual
44 hardware which implements a certain transforma
45 defined behavior.
46
47 The transformation object (TFM) is an instance
48 implementation. There can be multiple transfor
49 with a single transformation implementation. E
50 transformation objects is held by a crypto API
51 transformation. Transformation object is alloc
52 consumer requests a transformation implementat
53 provided with a structure, which contains a tr
54
55 The structure that contains transformation obj
56 to as a "cipher handle". Such a cipher handle
57 following phases that are reflected in the API
58 a cipher handle:
59
60 1. Initialization of a cipher handle.
61
62 2. Execution of all intended cipher operations
63 where the cipher handle must be furnished t
64
65 3. Destruction of a cipher handle.
66
67 When using the initialization API calls, a cip
68 returned to the consumer. Therefore, please re
69 API calls that refer to the data structure typ
70 to receive and subsequently to use. The initia
71 all the same naming conventions of crypto_allo
72
73 The transformation context is private data ass
74 transformation object.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.