]>
Commit | Line | Data |
---|---|---|
7c673cae FG |
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 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**: To build the PMD as a shared library, the libsso_kasumi | |
74 | library must be built as follows:: | |
75 | ||
76 | make KASUMI_CFLAGS=-DKASUMI_C | |
77 | ||
78 | ||
79 | Initialization | |
80 | -------------- | |
81 | ||
82 | In order to enable this virtual crypto PMD, user must: | |
83 | ||
84 | * Export the environmental variable LIBSSO_KASUMI_PATH with the path where | |
85 | the library was extracted (kasumi folder). | |
86 | ||
87 | * Build the LIBSSO library (explained in Installation section). | |
88 | ||
89 | * Set CONFIG_RTE_LIBRTE_PMD_KASUMI=y in config/common_base. | |
90 | ||
91 | To use the PMD in an application, user must: | |
92 | ||
93 | * Call rte_eal_vdev_init("crypto_kasumi") within the application. | |
94 | ||
95 | * Use --vdev="crypto_kasumi" in the EAL options, which will call rte_eal_vdev_init() internally. | |
96 | ||
97 | The following parameters (all optional) can be provided in the previous two calls: | |
98 | ||
99 | * socket_id: Specify the socket where the memory for the device is going to be allocated | |
100 | (by default, socket_id will be the socket where the core that is creating the PMD is running on). | |
101 | ||
102 | * max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default). | |
103 | ||
104 | * max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default). | |
105 | ||
106 | Example: | |
107 | ||
108 | .. code-block:: console | |
109 | ||
110 | ./l2fwd-crypto -c 40 -n 4 --vdev="crypto_kasumi,socket_id=1,max_nb_sessions=128" |