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