net/virtio: fix incorrect cast of void *
[dpdk.git] / cryptodevs / kasumi.rst
1 ..  BSD LICENSE
2         Copyright(c) 2016 Intel Corporation. All rights reserved.
3
4     Redistribution and use in source and binary forms, with or without
5     modification, are permitted provided that the following conditions
6     are met:
7
8     * Redistributions of source code must retain the above copyright
9     notice, this list of conditions and the following disclaimer.
10     * Redistributions in binary form must reproduce the above copyright
11     notice, this list of conditions and the following disclaimer in
12     the documentation and/or other materials provided with the
13     distribution.
14     * Neither the name of Intel Corporation nor the names of its
15     contributors may be used to endorse or promote products derived
16     from this software without specific prior written permission.
17
18     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21     A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22     OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26     THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30 KASUMI Crypto Poll Mode Driver
31 ===============================
32
33 The KASUMI PMD (**librte_pmd_kasumi**) provides poll mode crypto driver
34 support for utilizing Intel Libsso library, which implements F8 and F9 functions
35 for KASUMI UEA1 cipher and UIA1 hash algorithms.
36
37 Features
38 --------
39
40 KASUMI PMD has support for:
41
42 Cipher algorithm:
43
44 * RTE_CRYPTO_CIPHER_KASUMI_F8
45
46 Authentication algorithm:
47
48 * RTE_CRYPTO_AUTH_KASUMI_F9
49
50 Limitations
51 -----------
52
53 * Chained mbufs are not supported.
54 * KASUMI(F9) supported only if hash offset and length field is byte-aligned.
55 * In-place bit-level operations for KASUMI(F8) are not supported
56   (if length and/or offset of data to be ciphered is not byte-aligned).
57
58
59 Installation
60 ------------
61
62 To build DPDK with the KASUMI_PMD the user is required to download
63 the export controlled ``libsso_kasumi`` library, by requesting it from
64 `<https://networkbuilders.intel.com/network-technologies/dpdk>`_.
65 Once approval has been granted, the user needs to log in
66 `<https://networkbuilders.intel.com/dpdklogin>`_
67 and click on "Kasumi Bit Stream crypto library" link, to download the library.
68 After downloading the library, the user needs to unpack and compile it
69 on their system before building DPDK::
70
71    make
72
73 **Note**: When encrypting with KASUMI F8, by default the library
74 encrypts full blocks of 8 bytes, regardless the number of bytes to
75 be encrypted provided (which leads to a possible buffer overflow).
76 To avoid this situation, it is necessary not to pass
77 3GPP_SAFE_BUFFERS as a compilation flag.
78 Also, this is required when using chained operations
79 (cipher-then-auth/auth-then-cipher).
80 For this, in the Makefile of the library, make sure that this flag
81 is commented out::
82
83   #EXTRA_CFLAGS  += -D_3GPP_SAFE_BUFFERS
84
85 **Note**: To build the PMD as a shared library, the libsso_kasumi
86 library must be built as follows::
87
88   make KASUMI_CFLAGS=-DKASUMI_C
89
90
91 Initialization
92 --------------
93
94 In order to enable this virtual crypto PMD, user must:
95
96 * Export the environmental variable LIBSSO_KASUMI_PATH with the path where
97   the library was extracted (kasumi folder).
98
99 * Build the LIBSSO library (explained in Installation section).
100
101 * Set CONFIG_RTE_LIBRTE_PMD_KASUMI=y in config/common_base.
102
103 To use the PMD in an application, user must:
104
105 * Call rte_vdev_init("crypto_kasumi") within the application.
106
107 * Use --vdev="crypto_kasumi" in the EAL options, which will call rte_vdev_init() internally.
108
109 The following parameters (all optional) can be provided in the previous two calls:
110
111 * socket_id: Specify the socket where the memory for the device is going to be allocated
112   (by default, socket_id will be the socket where the core that is creating the PMD is running on).
113
114 * max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default).
115
116 * max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default).
117
118 Example:
119
120 .. code-block:: console
121
122     ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_kasumi,socket_id=0,max_nb_sessions=128" \
123     -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "kasumi-f8"
124
125 Extra notes on KASUMI F9
126 ------------------------
127
128 When using KASUMI F9 authentication algorithm, the input buffer must be
129 constructed according to the 3GPP KASUMI specifications (section 4.4, page 13):
130 `<http://cryptome.org/3gpp/35201-900.pdf>`_.
131 Input buffer has to have COUNT (4 bytes), FRESH (4 bytes), MESSAGE and DIRECTION (1 bit)
132 concatenated. After the DIRECTION bit, a single '1' bit is appended, followed by
133 between 0 and 7 '0' bits, so that the total length of the buffer is multiple of 8 bits.
134 Note that the actual message can be any length, specified in bits.
135
136 Once this buffer is passed this way, when creating the crypto operation,
137 length of data to authenticate (op.sym.auth.data.length) must be the length
138 of all the items described above, including the padding at the end.
139 Also, offset of data to authenticate (op.sym.auth.data.offset)
140 must be such that points at the start of the COUNT bytes.