openssl.rst revision 6b3e017e
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
30OpenSSL Crypto Poll Mode Driver
31===============================
32
33This code provides the initial implementation of the openssl poll mode
34driver. All cryptography operations are using Openssl library crypto API.
35Each algorithm uses EVP interface from openssl API - which is recommended
36by Openssl maintainers.
37
38For more details about openssl library please visit openssl webpage:
39https://www.openssl.org/
40
41Features
42--------
43
44OpenSSL PMD has support for:
45
46Supported cipher algorithms:
47* ``RTE_CRYPTO_CIPHER_3DES_CBC``
48* ``RTE_CRYPTO_CIPHER_AES_CBC``
49* ``RTE_CRYPTO_CIPHER_AES_CTR``
50* ``RTE_CRYPTO_CIPHER_3DES_CTR``
51* ``RTE_CRYPTO_CIPHER_AES_GCM``
52
53Supported authentication algorithms:
54* ``RTE_CRYPTO_AUTH_AES_GMAC``
55* ``RTE_CRYPTO_AUTH_MD5``
56* ``RTE_CRYPTO_AUTH_SHA1``
57* ``RTE_CRYPTO_AUTH_SHA224``
58* ``RTE_CRYPTO_AUTH_SHA256``
59* ``RTE_CRYPTO_AUTH_SHA384``
60* ``RTE_CRYPTO_AUTH_SHA512``
61* ``RTE_CRYPTO_AUTH_MD5_HMAC``
62* ``RTE_CRYPTO_AUTH_SHA1_HMAC``
63* ``RTE_CRYPTO_AUTH_SHA224_HMAC``
64* ``RTE_CRYPTO_AUTH_SHA256_HMAC``
65* ``RTE_CRYPTO_AUTH_SHA384_HMAC``
66* ``RTE_CRYPTO_AUTH_SHA512_HMAC``
67
68
69Installation
70------------
71
72To compile openssl PMD, it has to be enabled in the config/common_base file
73and appropriate openssl packages have to be installed in the build environment.
74
75The newest openssl library version is supported:
76* 1.0.2h-fips  3 May 2016.
77Older versions that were also verified:
78* 1.0.1f 6 Jan 2014
79* 1.0.1 14 Mar 2012
80
81For Ubuntu 14.04 LTS these packages have to be installed in the build system:
82sudo apt-get install openssl
83sudo apt-get install libc6-dev-i386 (for i686-native-linuxapp-gcc target)
84
85This code was also verified on Fedora 24.
86This code was NOT yet verified on FreeBSD.
87
88Initialization
89--------------
90
91User can use app/test application to check how to use this pmd and to verify
92crypto processing.
93
94Test name is cryptodev_openssl_autotest.
95For performance test cryptodev_openssl_perftest can be used.
96
97To verify real traffic l2fwd-crypto example can be used with this command:
98
99.. code-block:: console
100
101sudo ./build/l2fwd-crypto -c 0x3 -n 4 --vdev "crypto_openssl"
102--vdev "crypto_openssl"-- -p 0x3 --chain CIPHER_HASH
103--cipher_op ENCRYPT --cipher_algo AES_CBC
104--cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f
105--iv 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:ff
106--auth_op GENERATE --auth_algo SHA1_HMAC
107--auth_key 11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
108:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
109:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
110
111Limitations
112-----------
113
114* Maximum number of sessions is 2048.
115* Chained mbufs are not supported.
116* Hash only is not supported for GCM and GMAC.
117* Cipher only is not supported for GCM and GMAC.
118