コンテンツにスキップ

wolfSSLのビルド

wolfSSLはポータビリティを念頭に置いて書かれており、一般的にほとんどのシステムでビルドするのは容易です。wolfSSLをビルドするのが難しい場合は、サポートフォーラム(https://www.wolfssl.com/forums)を通してサポートを求めるかあるいはsupport@wolfssl.comに遠慮なく直接お問い合わせください。

この章では、UnixとWindowsでwolfSSLをビルドする方法を説明しますし、加えて非標準環境でwolfSSLをビルドする場合のガイダンスも提供します。第3章に「Getting Start」ガイドと第11章にSSLチュートリアルがあります。

autoconf/automakeシステムを使用してwolfSSLをビルドする場合、単一のMakeFileを使用してwolfSSLライブラリの全てのパーツとサンプルプログラムを一度にビルドします。

wolfSSLソースコードの取得

最新バージョンのwolfSSLは、wolfSSLのWebサイトからZIPファイルとしてダウンロードできます。

https://www.wolfssl.com/download

zipファイルをダウンロードしたら、unzipコマンドを使用してファイルを解凍します。ネイティブの行末文字を使用するには、unzipを使用する際に-aオプションを有効にします。[unzip man page]で、-aオプションが説明されています。

[...] -aオプションでは、zipによってテキストファイル（ZipInfoリストで「b」ではなく「t」ラベルがついているファイル）と識別されると行末文字、ファイル終端文字を変換します。必要に応じて指定してください。[...]

注：wolfSSL 2.0.0RC3のリリースから、wolfSSLのディレクトリ構造と標準のインストールフォルダーが変更されました。これらの変更は、オープンソースプロジェクトがwolfSSLを統合しやすくするために行われました。ヘッダーと構造の変更の詳細については、ライブラリヘッダーおよび構造の使用を参照してください。

*nix上でビルド

Linux、*BSD、OS X、Solaris、またはその他の*nixのようなシステムにwolfSSLをビルドする場合、autoconfシステムを使用します。wolfSSLをビルドするには、wolfSSLルートディレクトリから2つのコマンド./configureおよびmakeを実行するだけです。

./configureスクリプトはビルド環境をセットアップし、任意の数のビルドオプションを./configureに追加します。利用可能なビルドオプションのリストについては、ビルドオプションを参照するか、次のコマンドラインを実行して、./configureに渡すことができるオプションのリストを表示させてください。

./configure --help

./configureが正常に実行されたら、wolfSSLをビルドするためにmakeを実行してください。

make

wolfSSLをインストールするには：

make install

インストールするにはスーパーユーザー特権を必要とする場合もあるかもしれません。その場合は次の様にsudoをコマンドの前に使ってください。

sudo make install

ビルドをテストするには、wolfSSLのルートディレクトリからtestsuiteプログラムを実行します。

./testsuite/testsuite.test

あるいは、autoconfを使用してtestsuiteを実行し、標準のwolfSSL APIおよび暗号テストを実行できます。

make test

testsuiteプログラムの予想される出力に関する詳細はテストスイートセクションにあります。

もし、wolfSSLライブラリのみのビルドが必要で、そのほかのコンポーネント（サンプルプログラム、テストスイート、ベンチマークアプリケーション等）はビルドしたくない場合には、wolfSSLのルートディレクトリで下記コマンドを実行してください：

make src/libwolfssl.la

Windowsの上でのビルド

以下の手順に加えて、Visual Studio ここでもwolfSSLをビルドするための指示とヒントを参照することができます。

VS 2008

インストールのルートディレクトリには、Visual Studio 2008にソリューションが含まれています。Visual Studio 2010以降で使用するために、既存のプロジェクトファイルをインポートプロセス中に変換できるはずです。

ノート： VSの新しいバージョンにインポートする場合、「プロジェクトとそのインポートしたプロパティシートを上書きしたいですか？」と尋ねられます。「いいえ」を選択して、以下を回避できます。一方「はい」を選択した場合には、SAFESEH仕様によりEDITANDCONTINUEが無視されているという警告が表示されます。TestSuite、sslsniffer、server、echoserver、echoclient、clientを個別に修正し、プロパティを変更する必要があります - >構成プロパティ - >リンカー - > Advanced(Advanced Windowの下部までスクロール)。「安全な例外ハンドラーを含むイメージ」を見つけ、右端のドロップダウン矢印をクリックします。前述のそれぞれについて、これをNO(/SAFESEH:NO)に変更します。もう1つのオプションとして、EDITANDCONTINUEを無効にすることも選択可能ですが、デバッグの目的に役立つこの機能を無効化する選択は推奨されません。

VS 2010

更新されたら、wolfSSLソリューションをビルドするために、Service Pack 1をダウンロードする必要があります。VSがリンカーエラーを報告する場合、プロジェクトをクリーンして再ビルドしてリンカーエラーを処理する必要があります。

VS 2013(64ビットソリューション)

更新されたら、wolfSSLソリューションをビルドするために、Service Pack 4をダウンロードする必要があります。VSがリンカーエラーを報告する場合、プロジェクトをクリーンしてからプロジェクトを再ビルドして、リンカーエラーを処理する必要があります。

各ビルドをテストするには、Visual Studioメニューから「すべてのビルド」を選択し、TestSuiteプログラムを実行します。Visual Studioプロジェクトでビルドオプションを編集するには、希望するプロジェクト(wolfSSL、Echoclient、Echoserverなど)を選択し、「プロパティ」パネルを参照します。

注：wolfSSL v3.8.0リリース後、ビルドプリプロセッサマクロはIDE/WIN/user_settings.hにある集中ファイルに移動しました。このファイルはプロジェクトにあります。ECCやCHACHA20/POLY1305などの機能を追加するには、HAVE_ECCまたはHAVE_CHACHA/HAVE_POLY1305などです。

Cygwin

Windows開発マシン上のWindowsでwolfSSLをビルドする場合は、付属のVisual Studioプロジェクトファイルを使用してwolfSSLをビルドすることをお勧めします。しかし、Cygwinが必要な場合は、当社チームがビルドに成功した際のガイダンスをがありますから以下に紹介します。

  1. https://www.cygwin.com/install.htmlに移動し、setup-x86_64.exeをダウンロードしてください

  2. 実行してインストールを行います。「パッケージの選択」ステージに達するまで、インストールメニューをクリックしてください。

  3. 「+」アイコンをクリックして、「すべて」を展開します

  4. 次に、「アーカイブ」セクションに移動し、「unzip」 ドロップダウンを選択し、「スキップ」を6.0-15(または他のバージョン)に変更します。

  5. 「Devel」の下で「autoconf」をクリックして「ドロップダウン」し、「10-1」(または他のバージョン)に「スキップ」を変更します

  6. 「Devel」の下で「automake」をクリックして「ドロップダウン」し、「10-1」(または他のバージョン)に「スキップ」を変更します

  7. 「Devel」で「gcc-core」ドロップダウンをクリックして「Skip」を7.4.0-1に変更します(注：wolfSSLはGCC 9または10をテストしていません。開発のために微調整される少し時間がかかります。

  8. 「Devel」で「git」ドロップダウンをクリックして「スキップ」を2.29.0-1(またはその他のバージョン)に変更します。

  9. 「Devel」の下で「libtool」をクリックして「ドロップダウン」し、「2.4.6-5」(または他のバージョン)に「スキップ」を変更します

  10. 「Devel」で「作る」ドロップダウンをクリックして「スキップ」を4.2.1-1(またはその他のバージョン)に変更します。

  11. 「次」をクリックして、残りのインストールを進めます。

追加のパッケージリストには、次のものが含まれています。

  • unzip

  • autoconf

  • automake

  • gcc-core

  • git

  • libtool.

  • make

インストール後の作業

Cygwinターミナルを開き、wolfSSLをクローンします：

git clone https://github.com/wolfssl/wolfssl.git
cd wolfssl
./autogen.sh
./configure
make
make check

標準以外の環境にビルド

公式にはサポートされていませんが、特に組み込み向けやクロスコンパイルシステムを使用して、非標準環境でwolfSSLをビルドしたいユーザーをできるだけ支援します。以下はそのメモです。

  1. ソースファイルとヘッダファイルは、wolfSSLダウンロードパッケージにあるのと同じディレクトリ構造に存在する必要があります。

  2. 一部のビルドシステムは、wolfSSLヘッダーファイルがどこにあるかを明示的に知っておくように、それを指定する必要があるかもしれません。それらは<wolfssl_root>/wolfsslディレクトリにあります。通常は、INCLUDEパスに<wolfssl_root>ディレクトリを追加してください。

  3. wolfSSLは、構成プロセスがBig Endianを検出しない限り、リトルエンディアンシステムがデフォルトです。非標準環境でビルドするユーザーはConfigureプロセスを使用していないため、Big Endianシステムを使用する場合はBIG_ENDIAN_ORDERを定義する必要があります。

  4. wolfSSLは、64ビットタイプが使用可能であると速度が向上します。構成プロセスは、”long"または"long long"が64ビットであるかどうかを判断し、定義を設定します。そのため、sizeof(long)がシステム上の8バイトである場合は、SIZEOF_LONG 8を定義してください。sizeof(long long)が8バイトの場合は、SIZEOF_LONG_LONG 8を定義してください。

  5. ライブラリをビルドしてみて問題が発生した場合はお知らせください。サポートが必要な場合は、info@wolfssl.comまでお問い合わせください。

  6. ビルドを変更できるいくつかの定義は、以下の次のサブセクションにリストされています。多くのオプションの詳細な説明については、オプションをビルドしますを参照してください。

Yocto Linuxへのビルド

wolfSSLには、Yocto LinuxとOpenEmbededにwolfsSLをビルドするためのレシピも含まれています。これらのレシピは、githubリポジトリとしてMeta-wolfsslレイヤー内で維持されています。Yocto LinuxにWolfsslをビルドするには、GitとBitbakeが必要です。次の手順には、Yocto Linux上にビルドされたwolfSSL製品(レシピが存在する)を入手する方法をリストします。

  1. wolfSSL metaをクローン

次のURLに対してgit cloneコマンドを介して行うことができます。 https://github.com/wolfssl/meta-wolfssl

  1. "Meta-WolfsSl"レイヤーをビルドのbblayers.confに挿入

BBLAYERSセクション内で、Meta-wolfSSLの場所へのパスを追加します クローン化されました。例：

    BBLAYERS ?= "... \
    /path/to/meta-wolfssl/ \
    ..."
  1. wolfSSL製品レシピをビルドする

BitBakeは、次の3つのwolfSSL製品レシピのうちの1つを作成するために使用できます。 * wolfssl 、 wolfssh 、 wolfmqtt *。これらのレシピの1つをBitbakeに渡すだけです コマンド(例：bitbake wolfssl)。これにより、ユーザーは個人的に コンパイルの確認は問題なく成功します。

  1. local.conf を編集する

最後のステップは、ビルドのlocal.confファイルを編集することです。 ビルドされている画像に含まれます。IMAGE_INSTALL_append行を編集します 目的のレシピの名前を含める。この例を以下に示します。

    IMAGE_INSTALL_apped="wolfssl wolfssh wolfmqtt"

イメージがビルドされると、wolfSSLのデフォルトの場所(またはレシピから関連する製品)が/usr/lib/ディレクトリになります。

さらに、オプションをビルドしますにリストされている有効化オプションと無効化オプションを使用してYoctoにビルドする際に、wolfSSLをカスタマイズできます。これには、.bbappendファイルを作成してwolfSSLアプリケーション/レシピレイヤー内に配置する必要があります。このファイルの内容には、EXTRA_OECONF変数に連結するコンテンツを指定する行を含める必要があります。この例を以下に示します。

EXTRA_OECONF += "--enable-tls13"

Yoctoへのビルドに関するさらなるドキュメントは、ここにあるMeta-Wolfssl Readmeにあります。

Atollic TrueSTUSIOを使ってのビルド

wolfSSLのバージョン3.15.5以降には、ARM M4-Cortexデバイス向けにwolfSSLをビルドするために使用されるTrueSTUDIOプロジェクトファイルが含まれています。このプロジェクトファイルはST Microelectronicsの一部であるAtollicによって作成されており自由にダウンロードできます。このプロジェクトファイルによってSTM32デバイス上のビルドプロセスを簡素化できます。TrueSTUDIOでwolfSSL Static Library Projectファイルをビルドするには、TrueSTUDIOを開いた後、ユーザーが次の手順を実行する必要があります。

  1. プロジェクトをワークスペースにインポートする(ファイル>インポート)

  2. プロジェクトをビルド(プロジェクト>ビルドプロジェクト)

ビルドにはuser_settings.h内にある設定が取り込まれます。user_settings.hファイルのデフォルトコンテンツは最小限であり、多くの機能定義は含まれていません。ユーザーは、このファイルを変更し、この章の残りの部分にリストされているオプションを備えた機能を追加または削除できます。

IARを使ってのビルド

<wolfssl_root>/IDE/IAR-EWARMディレクトリには、次のファイルが含まれています。

  1. ワークスペース：wolfssl.eww ワークスペースには、wolfSSL-LibライブラリとwolfCrypt-test、wolfCrypt-benchmark 実行可能プロジェクトが含まれます

  2. wolfSSL-Libプロジェクト：lib/wolfSSL-lib.ewp wolfCryptとwolfSSL関数のフルセットライブラリを生成します

  3. テストスイートプロジェクト：test/wolfCrypt-test.ewp　test.out テストスイート実行ファイルを生成します

  4. ベンチマークプロジェクト：benchmark/wolfCrypt-benchmark.ewp はbenchmark.out benchmark 実行ファイルを生成します

これらのプロジェクトは、一般的なARM Cortex-M MPUに設定されています。特定のターゲットMPUのプロジェクトを生成するには、次の手順を実行します。

  1. デフォルト設定：プロジェクトのデフォルトターゲットは、Cortex-M3シミュレーターに設定されます。user_settings.hには、プロジェクトのデフォルトオプションが含まれています。シミュレータにダウンロードしてください。「ビュー」 - >「端末I/O」、「ターミナルI/O」で「端末入出力」ウィンドウを開き、実行を開始します。

  2. プロジェクトオプション設定：各プロジェクトで、適切な「ターゲット」オプションを選択します。

  3. 実行可能プロジェクトの場合：MPUに "Systeminit"と "startup"を追加し、デバッグ "ドライバ"を選択してください。

  4. ベンチマークプロジェクトの場合：current_time関数のオプションを選択するか、wolfssl_user_currtimeオプションで独自の「current_time」ベンチマークタイマーを作成します。

  5. ビルドとダウンロード：ewarm build and downloadのメニューバーで「Project-> Make」と "Download and debug "に移動します。

OS XとiOS上でビルド

XCODE

<wolfssl_root>/IDE/XCODEディレクトリには、次のファイルが含まれています。

  1. wolfssl.xcworkspace - ライブラリとTestSuiteクライアントを使用したワークスペース

  2. wolfssl_testsuite.xcodeproj -TestSuiteを実行するプロジェクト。

  3. wolfssl.xcodeproj - wolfSSLおよび/またはWolfCrypt用のOS/XおよびIOSライブラリをビルドするためのプロジェクト

  4. wolfssl-FIPS.xcodeproj-利用可能な場合はwolfsslとwolfcrypt-fipsをビルドするプロジェクト

  5. user_settings.h-プロジェクト間で共有されるカスタムライブラリ設定

ライブラリは、ターゲットに応じてlibwolfssl_osx.aまたはlibwolfssl_ios.aとして出力されます。また、wolfssl/wolfcrypt(およびcyassl/ctaocrypt)にあるヘッダーファイルをBuild/Products/DebugまたはBuild/Products/Releaseフォルダにあるincludeディレクトリにコピーします。

ライブラリとテストスイートが正しくリンクできるために、ビルドの場所をワークスペースからの相対パスとして構成する必要があります。

  1. ファイル - >ワークスペースの設定(またはxcode-> feprences-> locations-> locations)

  2. 派生データ - > Advanced

  3. カスタム - >ワークスペース対応

  4. 製品 - >ビルド/製品

これらのXcodeプロジェクトは、WOLFSSL_USER_SETTINGSプリプロセッサを定義して、複数のプロジェクトにマクロを設定するためのuser_settings.hファイルを有効にします。

必要に応じて、Xcode Preprocessorsをこれらの手順で変更できます。

  1. プロジェクトナビゲータのプロジェクトをクリックしてください。

  2. [設定のビルド]タブをクリックします。

  3. 「Apple LLVM 6.0 - 前処理」のセクションまでスクロールします。

  4. 「プリプロセッサマクロ」の開示を開き、「+」を使用して

" - "変更するボタン。デバッグとリリースの両方でこれを行うことを忘れないでください。

このプロジェクトは、デフォルト設定を使用してwolfSSLとWolfCryptをビルドする必要があります。

GCC ARMを使ってのビルド

<wolfssl_root>/IDE/GCC-ARMディレクトリには、Cortex MシリーズのためのwolfSSLプロジェクトの例がありますが、他のアーキテクチャにも流用できます。

  1. gcc-arm-none-eabiがインストールされていることを確認してください。

  2. Makefile.commonを変更します。

  3. ツールチェーンパスTOOLCHAINを設定します。

  4. アーキテクチャをARCHFLAGSに設定します。GCCアームオプション -mcpu=nameを参照してください。

  5. linker.ldのメモリマップがフラッシュ/RAMと一致するか確認します。あるいは、Makefile.commonのSRC_LD=-T./linker.ldをコメントアウトします。

  6. 静的ライブラリ(libwolfssl.a)をビルドするためにmakeを使用します。wolfCryptテスト/ベンチマーク、およびwolfSSL TLSクライアントターゲットは/Buildフォルダに生成されます。

一般的なmakefileを使ったクロスコンパイルによるビルド

例Makefile.common Cortex-A53を搭載したRaspberry Pi向けの変更点：

  1. Makefile.common 内のARCHFLAGSを-mcpu=cortex-a53 -mthumbに変更します。

  2. カスタムメモリマップが適用されないため、SRC_LDをコメントアウトします。

  3. TOOLCHAINをクリアしてデフォルトgccを使用します。"TOOLCHAIN ="　とします。

  4. LDFLAGS += --specs=nano.specsとLDFLAGS += --specs=nosys.specsをコメントアウトしてください。

クロスコンパイル付きの構成を備えたビルド

メインプロジェクトディレクトリの構成スクリプトは、GCC-Arm-None-eabiツールでビルドするようにクロスコンパイルを実行できます。以下の例ではツールへのパスが適切に設定されていると仮定します：

./configure \
  --host=arm-non-eabi \
  CC=arm-none-eabi-gcc \
  AR=arm-none-eabi-ar \
  STRIP=arm-none-eabi-strip \
  RANLIB=arm-none-eabi-ranlib \
  --prefix=/path/to/build/wolfssl-arm \
  CFLAGS="-march=armv8-a --specs=nosys.specs \
      -DHAVE_PK_CALLBACKS -DWOLFSSL_USER_IO -DNO_WRITEV" \
  --disable-filesystem --enable-fastmath \
  --disable-shared
make
make install

32ビットアーキテクチャをビルドしている場合は、-DTIME_T_NOT_64BITをCFLAGSに追加してください。

Keil MDK-ARM 上でのビルド

Keil MDK-ARMにwolfSSLをビルドするための詳細な説明とヒントを見つけることができます。

注：MDK-ARMがデフォルトのインストール場所にインストールされていない場合、プロジェクトファイルの参照パス定義をすべて変更する必要があります。

Cプリプロセッサマクロとして定義されている機能

機能の削除

以下の定義は、wolfSSLから機能を削除するために使用できます。これは、ライブラリのフットプリントサイズ全体を削減したい場合に役立ちます。NO_<機能名>定義を定義することで、ビルドからそれぞれのヘッダーファイルだけではなくソースファイルも削除することができます。

NO_WOLFSSL_CLIENT

クライアントに固有の呼び出しを削除し、サーバーのみのビルド用です。サイズのためにいくつかの呼び出しを削除する場合にのみ、これを使用する必要があります。

NO_WOLFSSL_SERVER

同様に、サーバー側に固有のコールを削除します。

NO_DES3

DES3暗号化の使用を削除します。一部の古いサーバーがそれを使用しているため、DES3はデフォルトで組み込まれており、SSL 3.0では必要です。NO_DHおよびNO_AESは上記2つと同じであるため、広く使用されています。

NO_DSA

DSAの使用を削除します。DSAは、一般的な使用が段階的に廃止されています。

NO_ERROR_STRINGS

エラー文字列を無効にします。エラー文字列は、wolfSSLの場合はsrc/internal.cまたはWolfCryptのwolfcrypt/src/asn.cにあります。

NO_HMAC

ビルドからHMACを削除します。

注意：SSL/TLSはHMACに依存しますが、wolfCrypt IEビルドオプションWOLFCRYPT_ONLYを使用している場合は、この場合、HMACを無効にすることができます。

NO_MD4

ビルドからMD4を削除します。MD4は解読されているため、使用してはなりません。

NO_MD5

ビルドからMD5を削除します。

NO_SHA

ビルドからSHA-1を削除します。

NO_SHA256

ビルドからSHA-256を削除します。

NO_PSK

事前共有キー拡張機能の使用をオフにします。デフォルトでは組み込まれています。

NO_PWDBASED

PKCS＃12からPBKDF1、PBKDF2、PBKDFなどのパスワードベースのキー派生関数を無効にします。

NO_RC4

ビルドからARC4ストリーム暗号の使用を削除します。ARC4は、まだ人気があり、広く使用されているため、デフォルトで組み込まれています。

NO_SESSION_CACHE

セッションキャッシュが不要なときに定義できます。これにより、メモリをほぼ3KBだけ減らせます。

NO_TLS

TLSをオフにします。TLSをオフに設定することはお勧めしません。

SMALL_SESSION_CACHE

wolfSSLで使用されるSSLセッションキャッシュのサイズを制限するように定義できます。これにより、デフォルトのセッションキャッシュが33セッションから6セッションに短縮され、約2.5 KB削減します。

NO_RSA

RSAアルゴリズムのサポートを削除します。

WC_NO_RSA_OAEP

OAEPパディングのコードを削除します。

NO_AES_CBC

AES-CBCアルゴリズムサポートをオフにします。

NO_DEV_URANDOM

/dev/urandomの使用を無効にします。

WOLFSSL_NO_SIGALG

署名アルゴリズムの拡張子を無効にします。

NO_RESUME_SUITE_CHECK

TLS接続を再開するときに暗号スイートのチェックを無効にします。

NO_ASN

ASNフォーマットの証明書処理のサポートをオフにします。

NO_OLD_TLS

SSLV3、TLSV1.0、TLSV1.1のサポートを削除します。

WOLFSSL_AEAD_ONLY

非AEADアルゴリズムのサポートを削除します。AEADは、「認証された暗号化」の略であり、これらのアルゴリズム(AES-GCMなど)がデータを暗号化および復号化するだけでなく、そのデータの機密性と信頼性を保証するアルゴリズムです。

WOLFSSL_SP_NO_2048

RSA/DH 2048ビットシングルプレシジョン(SP)最適化を削除します。

WOLFSSL_SP_NO_3072

RSA/DH 3072ビットシングルプレシジョン(SP)最適化を削除します。

WOLFSSL_SP_NO_256

SECP256R1のECCシングルプレシジョン(SP)最適化を削除します。WOLFSSL_SP_MATHにのみ適用されます。

機能マクロの有効化 (デフォルトでオン)

HAVE_TLS_EXTENSIONS

ほとんどの TLS ビルドに必要な TLS 拡張機能のサポートを有効にします。 ./configure でデフォルトで有効になっていますが、WOLFSSL_USER_SETTINGS でビルドする場合は手動で定義する必要があります。

HAVE_SUPPORTED_CURVES

TLS でサポートされている曲線と、TLS で使用されるキー共有拡張機能を有効にします。 ECC、Curve25519、および Curve448 で必要です。 ./configure でデフォルトで有効になっていますが、WOLFSSL_USER_SETTINGS でビルドする場合は手動で定義する必要があります。

HAVE_EXTENDED_MASTER

TLS v1.2 以前で使用されるセッション キーの計算用に拡張マスター シークレット PRF を有効にします。 PRF 方式はデフォルトでオンになっており、より安全であると考えられています。 ./configure を使用する場合、これはデフォルトでオンになっていますが、WOLFSSL_USER_SETTINGS でビルドする場合は手動で定義する必要があります。

HAVE_ENCRYPT_THEN_MAC

ブロック暗号による暗号化後に mac を実行するための encrypt-then-mac サポートを有効にします。 これがデフォルトで、セキュリティが向上します。 ./configure を使用する場合、これはデフォルトでオンになっていますが、WOLFSSL_USER_SETTINGS でビルドする場合は手動で定義する必要があります。

HAVE_ONE_TIME_AUTH

Poly 認証を設定するために TLS v1.2 で Chacha20/Poly1305 を使用する場合に必要です。 ./configure を使用する場合、これは ChaCha20/Poly1305 でデフォルトで有効になりますが、WOLFSSL_USER_SETTINGS でビルドする場合は手動で定義する必要があります。

デフォルトでは機能を無効にすることができます

WOLFSSL_CERT_GEN

wolfSSLの証明書生成機能をオンにします。詳細については、キーと証明書を参照してください。

WOLFSSL_DER_LOAD

wolfSSL_CTX_der_load_verify_locations()関数を使用して、wolfSSLコンテキスト(WOLFSSL_CTX)へのDERフォーマットされたCA証明書をロードできます。

WOLFSSL_DTLS

DTLS(Datagram TLS)の使用をオンにします。これは広くサポートされていないか、使用されていません。

WOLFSSL_KEY_GEN

wolfSSLのRSA鍵生成機能をオンにします。詳細については、キーと証明書を参照してください。

WOLFSSL_RIPEMD

RIPEMD-160サポートを有効にします。

WOLFSSL_SHA384

SHA-384サポートを有効にします。

WOLFSSL_SHA512

SHA-512サポートを有効にします。

DEBUG_WOLFSSL

デバッグ機能を含めてビルドします。Debugging wolfSSLの詳細については、デバッグを参照してください。

HAVE_AESCCM

AES-CCMサポートを有効にします。

HAVE_AESGCM

AES-GCMサポートを有効にします。

WOLFSSL_AES_XTS

AES-XTSサポートを有効にします。

HAVE_CAMELLIA

Camelliaサポートを有効にします。

HAVE_CHACHA

Chacha20サポートを有効にします。

HAVE_POLY1305

Poly1305サポートを有効にします。

HAVE_CRL

証明書失効リスト(CRL)サポートを有効にします。

HAVE_CRL_IO

CRL URLでインラインHTTPリクエストをブロックできるようにします。CRLをWOLFSSL_CTXにロードし、作成したすべてのwolfSSLオブジェクトに適用します。

HAVE_ECC

楕円曲線暗号化(ECC)サポートを有効にします。

HAVE_LIBZ

接続上のデータの圧縮を可能にする拡張機能です。通常、使用するべきではありません。configure notes libzの下のメモを参照してください。

HAVE_OCSP

オンライン証明書ステータスプロトコル(OCSP)サポートを有効にします。

OPENSSL_EXTRA

ライブラリへOpenSSL互換性を含めてビルドし、wolfSSL OpenSSL互換性レイヤーを可能にします。これにより、OpenSSLで動作するように設計された既存のアプリケーションへの移植を容易にします。デフォルトでオフになっています。

TEST_IPV6

テストアプリケーションでのIPv6のテストをオンにします。wolfSSLはIPニュートラルですが、テストアプリケーションはデフォルトでIPv4を使用しています。

HAVE_CSHARP

C＃ラッパーに必要な構成オプションをオンにします。

HAVE_CURVE25519

Curve25519アルゴリズムの使用をオンにします。

HAVE_ED25519

ED25519アルゴリズムの使用をオンにします。

WOLFSSL_DH_CONST

Diffie Hellman Operationsを実行するときにフローティングポイント値の使用をオフにし、XPOW()およびXLOG()のテーブルを使用します。外部数学ライブラリへの依存関係を削除します。

WOLFSSL_TRUST_PEER_CERT

信頼できるピア証明書の使用をオンにします。これにより、CA証明書を使用するのではなく、ピア証明書に接続することができます。信頼できるピア証明書がPeer Certチェーンよりも一致している場合にオンになっていると、ピアが検証されたと見なされます。CA証明書を使用することが望ましいです。

WOLFSSL_STATIC_MEMORY

静的メモリバッファと機能の使用をオンにします。これにより、動的ではなく静的メモリを使用できます。

WOLFSSL_SESSION_EXPORT

DTLSセッションのエクスポートとインポートの使用をオンにします。これにより、DTLSセッションの現在の状態をシリアル化および送受信することができます。

WOLFSSL_ARMASM

ARMv8ハードウェアアクセラレーションの使用をオンにします。

WC_RSA_NONBLOCK

Fast Math RSAノンブロッキングサポートをオンにして、RSA操作をより小さな仕事の塊に分割して処理します。この機能は、wc_RsaSetNonBlock()を呼び出し、FP_WOULDBLOCK戻りコードをチェックすることにより有効になります。

WOLFSSL_RSA_VERIFY_ONLY

RSA用の小さなビルドをオンにしてください。マクロWOLFSSL_RSA_PUBLIC_ONLY、WOLFSSL_RSA_VERIFY_INLINE、NO_SIG_WRAPPER、およびWOLFCRYPT_ONLYで使用する必要があります。

WOLFSSL_RSA_PUBLIC_ONLY

RSAの公開キーのみの小さなビルドをオンにします。Macro WOLFCRYPT_ONLYで使用する必要があります。

WOLFSSL_SHA3

SHA3使用のビルドをオンにします。これは、SHA3-224、SHA3-256、SHA3-384、SHA3-512のSHA3 Keccakのサポートです。さらに、WOLFSSL_SHA3_SMALLを使用して、リソースの使用のためにパフォーマンスをトレードオフできます。

USE_ECDSA_KEYSZ_HASH_ALGO

エフェメラルECDHE鍵サイズまたは次に使用可能な次の最高値と一致するハッシュアルゴリズムを選択します。この回避策は、SHA512でハッシュされたP-256鍵などのシナリオを正しくサポートしていないいくつかのピアに関する問題を解決します。

WOLFSSL_ALT_CERT_CHAINS

この定義によってCA証明書が通信相手から提示されることを許可しますが、有効なチェーンの一部としては使用しません。デフォルトのwolfSSLの動作は、提示されたすべてのピア証明書の検証を要求することです。これにより、中間CA証明書を信頼できるものとして扱い、Root CA証明書まで至るCAの署名エラーは無視されません。代替の証明書チェーンモードでは、ピア証明書が信頼できるCAに検証する必要があります。

WOLFSSL_CUSTOM_CURVES

標準以外の曲線を許可します。計算では、曲線"a"変数が含まれています。HAVE_ECC_SECPR2、HAVE_ECC_SECPR3、HAVE_ECC_BRAINPOOLおよびHAVE_ECC_KOBLITZを使用して、追加の曲線タイプを有効にできます。

HAVE_COMP_KEY

ECC圧縮鍵サポートを有効にします。

WOLFSSL_EXTRA_ALERTS

TLS接続中に追加のアラートを送信できるようにします。この機能は、--enable-opensslextraを使用すると自動的に有効になります。

WOLFSSL_DEBUG_TLS

TLS接続中に追加のデバッグプリントアウトを有効にします。

HAVE_BLAKE2

Blake2Sアルゴリズムのサポートを有効にします。

HAVE_FALLBACK_SCSV

サーバー側でSignaling Cipher Suite Value(SCSV)をサポートをすることができます。これにより、クライアントから送信されたCipher Suite 0x56 0x00が、TLSバージョンのダウングレードが許可されていないことを通知します。

WOLFSSL_PSK_ONE_ID

TLS 1.3を持つPSK IDを1つだけサポートできます。

SHA256_MANY_REGISTERS

すべてのデータをレジスタに保持し、部分的にループを展開するSHA256の処理を指定します。

WOLFCRYPT_HAVE_SRP

wolfCryptセキュアリモートパスワードサポートを有効にします。

WOLFSSL_MAX_STRENGTH

最強のセキュリティ機能のみを有効にし、弱いまたは廃止予定の機能を無効にします。タイミングベースのサイドチャネル攻撃から保護するためのコンスタント実行により性能が劣化します。

WOLFSSL_STATIC_RSA

静的な鍵を使用する暗号は強く非推奨とされており、避けられない場合以外は決して使用しないでください。ただし、静的暗号スイートのみをサポートするレガシーシステムがまだあります。つまり、静的RSA Cipher Suitesのみをサポートするレガシーピアに接続する必要がある場合もありその場合には、wolfSSLの静的RSAのサポートを有効にします。(WOLFSSL_STATIC_PSKおよびWOLFSSL_STATIC_DHも参照)

WOLFSSL_STATIC_PSK

静的な鍵を使用する暗号は非推奨とされています。WOLFSSL_STATIC_RSAを参照してください

WOLFSSL_STATIC_DH

静的な鍵を使用する暗号は非推奨とされています。WOLFSSL_STATIC_RSAを参照してください。

HAVE_NULL_CIPHER

null暗号のサポートをオンにします。このオプションはセキュリティの観点から非推奨とされていますが、一部にはメモリ、リソースが少なく暗号化/復号操作を実行することができないには小さすぎるシステムが存在します。そのようなシステムでは少なくともメッセージやピアを認証して、メッセージの改ざんを防ぐことだけがができます。

HAVE_ANON

匿名の暗号スイートのサポートをオンにします。(決してお勧めしませんが、閉じたネットワークまたはプライベートネットワークを含むいくつかの有効なユースケースがWebから切り離されています)

HAVE_LIBOQS

OpenQuantumSafeチームのLiboQS統合のサポートをオンにします。詳細については、このドキュメントの「Quantum-Safe Cryptographyの実験」を参照してください。

WOLFSSL_SP_4096

RSA/DH 4096ビットシングルプレシジョン(SP)サポートを有効にします。

WOLFSSL_SP_384

ECC SECP384R1シングルプレシジョン(SP)サポートを有効にします。WOLFSSL_SP_MATHにのみ適用されます。

WOLFSSL_SP_1024

Sakkeペアリングベースのシングルプレシジョン(SP)サポートを有効にします。

wolfsslをカスタマイズまたは移植する

WOLFSSL_USER_SETTINGS

定義されている場合、ユーザー固有の設定ファイルを使用できます。ファイルにはuser_settings.hと名前が付けられ、インクルートパスに存在する必要があります。これは、標準のsettings.hファイルの前に含まれるため、デフォルト設定をオーバーライドできます。

WOLFSSL_CALLBACKS

デバッガがない環境でシグナルを使用するデバック用のコールバックの利用を可能にする拡張機能です。デフォルトではオフです。ブロッキングソケットを使用してタイマーを設定するためにも使用できます。詳しくはコールバックをご覧ください。

WOLF_CRYPTO_CB

暗号コールバックサポートを有効にします。この機能は、--enable-cryptocbを使用すると自動的に有効になります。

WOLFSSL_DYN_CERT

WOLFSSL_NO_MALLOC が設定されていても、証明書を解析するときに subjectCN および publicKey フィールドの割り当てを許可します。 RSA 証明書で WOLFSSL_NO_MALLOC オプションを使用する場合、ピアの証明書で証明書を検証するために、CA の公開鍵を保持する必要があります。 ca->publicKey が NULL であるため、これは ConfirmSignature エラー -173 BAD_FUNC_ARG として表示されます。

WOLFSSL_USER_IO

ユーザーがデフォルトのI/O関数EmbedSend()およびEmbedReceive()の自動設定を削除できます。カスタムI/O抽象化レイヤに使用されます(詳細については抽象化レイヤーを参照)。

NO_FILESYSTEM

stdio(標準入出力関数)が使用できないために、証明書とキーファイルをロードできない場合に使用されます。これにより、ファイルの代わりにバッファを使用することができます。

NO_INLINE

頻繁に使用されるライン数の少ない関数の自動インライン化を無効にします。この定義により、wolfSSLが遅くなり、実際にはこれらが小さな関数であるため、通常は関数呼び出し/ Returnよりもはるかに小さくなります。autoconfを使用していない場合は、コンパイル済みファイルのリストにwolfcrypt/src/misc.cを追加する必要があります。

NO_DEV_RANDOM

デフォルトの/dev/random乱数ジェネレーターの使用を無効にします。定義されている場合、ユーザーはOS固有のGenerateSeed()関数(wolfcrypt/src/random.cで見つかった)を記述する必要があります。

NO_MAIN_DRIVER

通常のビルド環境で使用されて、テストアプリケーションが独自に呼び出されるか、テストスイートドライバーアプリケーションを介して呼び出されます。test.c、client.c、server.c、echoclient.c、echoserver.c、およびtestsuite.cでテストファイルで使用する必要があります。

NO_WRITEV

writev()セマンティクスのシミュレーションを無効にします。

SINGLE_THREADED

ミューテックスの使用をオフにします。wolfSSLは現在、セッションキャッシュの保護にのみ使用しています。wolfSSLの使用が常に単一スレッドからに限定されている場合は、この機能をオンにすることができます。

USER_TICKS

time(0)の使用が可能でない場合、ユーザーは自分のクロックチェック関数を定義できます。カスタム機能には秒単位の正確さが必要ですが、エポックと相関がある必要はありません。wolfssl_int.cの機能を参照してください。

USER_TIME

ユーザーが自身で定義した構造体を使用する(または必要とする)場合のtime.h構造体の使用を無効にします。実装の詳細についてはwolfcrypt/src/asn.cを参照してください。ユーザーはXTIME(),XGMTIME()、およびXVALIDATE_DATE()を定義および/または実装する必要があります。

USE_CERT_BUFFERS_1024

<wolfssl_root>/wolfssl/certs_test.hにある1024ビットのテスト用証明書と鍵バッファを有効にします。ファイルシステムのないエンベデッドシステムに移植するときあるいはテストに役立ちます。

USE_CERT_BUFFERS_2048

<wolfssl_root>/wolfssl/certs_test.hにある2048ビットテスト証明書と鍵バッファを有効にします。ファイルシステムのないエンベデッドシステムに移植するときあるいはテストに役立ちます。

CUSTOM_RAND_GENERATE_SEED

ユーザーがwc_GenerateSeed(byte* output, word32 sz)に相当するカスタム機能を定義できるようにします。

CUSTOM_RAND_GENERATE_BLOCK

ユーザーがカスタム乱数生成機能を定義できるようにします。使用例は以下の通りです。

./configure --disable-hashdrbg
CFLAGS="-DCUSTOM_RAND_GENERATE_BLOCK= custom_rand_generate_block"

または

/* RNG */
/* #define HAVE_HASHDRBG */
extern int custom_rand_generate_block(unsigned char* output, unsigned int sz);

NO_PUBLIC_GCM_SET_IV

独自のカスタムハードウェアポートを作成していて、wc_AesGcmSetIV()の公開実装が提供されていない場合は、これを使用してください

NO_PUBLIC_CCM_SET_NONCE

独自のカスタムハードウェアポートを作成していて、wc_AesGcmSetNonce()の公開実装が提供されていない場合は、これを使用してください

NO_GCM_ENCRYPT_EXTRA

独自のカスタムハードワレポートを行っていて、wc_AesGcmEncrypt_ex()の実装が提供されていない場合は、これを使用してください

WOLFSSL_STM32[F1 | F2 | F4 | F7 | L4]

適切なSTM32デバイス用にビルドするときにこれらの定義のいずれかを使用します。必要に応じて、wolfSSLポーティングガイド(https://www.wolfssl.com/docs/porting-guide/)に関してwolfssl-root/wolfssl/wolfcrypt/settings.hセクションを更新します。

WOLFSSL_STM32_CUBEMX

Cubemxツールを使用してハードウェア抽象化レイヤー(HAL)APIを生成する場合、この設定を使用してwolfSSLに適切なサポートを追加します。

WOLFSSL_CUBEMX_USE_LL

Cubemxツールを使用してAPIを生成する場合、HAL(ハードウェア抽象化層)または低層(LL)の2つのオプションがあります。この定義を使用して、WOLFSSL_STM32[F1/F2/F4/F7/L4]セクションのwolfssl-root/wolfssl/wolfcrypt/settings.hに含まれるヘッダーを制御します。

NO_STM32_CRYPTO

STM32のハードウェア暗号サポートを提供しない場合に定義します。

NO_STM32_HASH

STM32のハードウェアハッシュサポートを提供しない場合に定義します。

NO_STM32_RNG

STM32のハードウェアRNGサポートを提供しない場合のためにに定義します。

XTIME_MS

TLS 1.3を使用するときに使用するための関数をミリ秒単位でマッピングするためのマクロ。例：

extern time_t m2mb_xtime_ms(time_t * timer);
#define XTIME_MS(tl) m2mb_xtime_ms((tl))

メモリまたはコードの使用量の削減

TFM_TIMING_RESISTANT

スタックサイズが小さいシステムでFast Math(USE_FAST_MATH)を使用するときに定義できます。これは大きな静的アレイを取り除きます。

WOLFSSL_SMALL_STACK

スタックサイズが小さいデバイスに使用できます。これにより、wolfcrypt/src/integer.cの動的メモリの使用が増加しますが、パフォーマンスが遅くなる可能性があります。

ALT_ECC_SIZE

Fast MathとRSA/DHを使用する場合は、ECCメモリ消費量を削減するためにこれを定義できます。ECCポイントにスタックを使用する代わりに、ヒープから割り当てます。

ECC_SHAMIR

ECC Mathのバリエーションは、わずかに高速ですが、ヒープの使用量を2倍にします。

RSA_LOW_MEM

定義された場合、CRTは使用されていないため、一部のメモリを保存しますが、RSA操作を遅くします。デフォルトでオフになっています。

WOLFSSL_SHA3_SMALL

SHA3を有効の場合、このマクロはビルドサイズを縮小します。

WOLFSSL_SMALL_CERT_VERIFY

DecodedCertを使用せずに証明書署名を確認します。一部のコードでは2倍になりますが、ピークヒープメモリの使用が小さくなります。WOLFSSL_NONBLOCK_OCSPでは使用できません。

GCM_SMALL

テーブルを使用する代わりに実行時に計算することで、AES GCMコードサイズを減らすオプション。可能なオプションは、GCM_SMALL,GCM_WORD32またはGCM_TABLEです。

CURVED25519_SMALL

CURVE25519_SMALLおよびED25519_SMALLを定義します。

CURVE25519_SMALL

CURVE25519のスモールメモリオプションです。。これはより少ないメモリを使用しますが、遅いです。

ED25519_SMALL

ED25519のスモールメモリオプションです。これはより少ないメモリを使用しますが、遅いです。

USE_SLOW_SHA

ローリングループを使用しないことでコードサイズを縮小します。これにより、SHAのパフォーマンスが低下します。

USE_SLOW_SHA256

ローリングループを使用しないことでコードサイズを縮小します。これにより、SHAのパフォーマンスが低下します。約2k小さくできますが、約25％遅くなります。

USE_SLOW_SHA512

ローリングループを使用しないことでコードサイズを縮小します。これにより、SHAのパフォーマンスが低下します。2倍の小さくできますが、50％が遅くなります。

ECC_USER_CURVES

ユーザーが有効になっているECCカーブサイズを選択できるようにします。デフォルトでは256ビットカーブのみが有効になっています。他の曲線を使用できるようにするには、HAVE_ECC192,HAVE_ECC224などを使用します。

WOLFSSL_SP_NO_MALLOC

SPコードでは、常にStackを使用して、Heap xmalloc()/xrealloc()/xfree()呼び出しは行われません。

WOLFSSL_SP_NO_DYN_STACK

動的スタックアイテムの使用を無効にします。コードサイズが小さく、小さなスタックではなく使用されます。

WOLFSSL_SP_FAST_MODEXP

コードサイズを犠牲にして、より高速なmod_exp実装でコンパイルします。

WC_DISABLE_RADIX_ZERO_PAD

１６進文字列出力で先頭ゼロの印刷を無効にします。たとえば、このマクロが定義されている場合、値8は文字列「0x8」として印刷されますが、定義されていない場合は「0x08」として印刷されます。このマクロを定義すると、コードサイズを削減できます。

パフォーマンスを向上させる

USE_INTEL_SPEEDUP

AES、Chacha20、Poly1305、SHA256、SHA512、ED25519およびCURV25519の加速にINTELのAVX/AVX2命令を使用できます。

WOLFSSL_AESNI

IntelとAMDチップセットに組み込まれているAES加速操作を使用できます。この定義を使用する場合、aes_asm.asm(AT＆T構文を備えたWindows用)またはaes_asm.Sファイルは、Intel AESの新しい命令セット(AESNI)を介して最適化するために使用されます。

HAVE_INTEL_RDSEED

DRBGシードソース用のIntelのRDSEEDを有効にします。

HAVE_INTEL_RDRAND

WolfsSLのランダムソースのIntelのRDRAND命令を有効にします。

FP_ECC

ECC固定点キャッシュを有効にします。これにより、同じ秘密鍵に対する繰り返し操作が高速化されます。FP_ENTRIESおよびFP_LUTを使用してエントリとLUTビットの数を定義して、デフォルトの静的メモリ使用量を削減することもできます。

WOLFSSL_ASYNC_CRYPT

これにより、Intel QuickAssistやMarvell(Cavium)Nitrox Vなどのハードウェアベースのアダプターを使用した非同期暗号化のサポートが可能になります。非同期コードは公開コードに含まれておらず、facts@wolfssl.comでメールで連絡することで評価できます。

WOLFSSL_NO_ASYNC_IO

これにより、非同期 I/O ネットワークが無効になります。 非同期 I/O はデフォルトでオンになっており、ハンドシェーク プロセス中に最大で約 140 バイトかかる場合があります。 ネットワーク インターフェイスが書き込み時に SOCKET_EWOULDBLOCK または SOCKET_EAGAIN (またはカスタム I/O コールバックの場合は WOLFSSL_CBIO_ERR_WANT_WRITE) を返さない場合は、WOLFSSL_NO_ASYNC_IO を定義して、ハンドシェイク メッセージの作成中に wolfSSL が状態を保存しないようにすることができます。

GCMパフォーマンスチューニング

GCMパフォーマンスには4つのバリエーションがあります。

  • GCM_SMALL - 最小のフットプリント、最も低い(FIPS検証済み)

  • GCM_WORD32-中程度(FIPS検証)

  • GCM_TABLE - FAST(FIPS検証済み)

  • GCM_TABLE_4BIT - 最速(まだFIPS検証されていない、FIPS 140-3に含まれます)

WolfsSLの数学ライブラリオプション

wolfsslには3つの数学ライブラリがあります。

  • Big Integer

  • Fast Math

  • Single Precision Math

wolfSSLをビルドするときは、これらの1つだけを使用する必要があります。

Big Integerライブラリは、アセンブリなしでCで書かれているため、最も移植性に富んだオプションです。そのため、特定のアーキテクチャに最適化されていません。すべての数学変数は、ヒープにインスタンス化されています。最小限のスタック使用量。残念ながら、Big Integerライブラリはタイミング攻撃に耐性がありません。

Fast Mathライブラリは良い選択肢です。Cとアセンブリの両方を使用して実装されます。そのため、特定のアーキテクチャの最適化があります。すべての数学変数は、スタックにインスタンス化されています。最小限のヒープ使用。TFM_TIMING_RESISTANTマクロが定義されている場合、タイミングに耐性にすることができます。FIPS 140-2および140-3の認定を取得しました。

単一精度(SP)数学ライブラリが推奨ライブラリです。Cとアセンブリの両方を使用して実装されます。そのため、特定のアーキテクチャの最適化があります。すべての数学変数は、スタックにインスタンス化されています。最小限のヒープ使用。常にタイミング攻撃に耐性があります。通常、コードサイズのコストで速度で最適化されていますが、不要なコードをコンパイルアウトするために高度に構成可能です。DO-178C認定を取得しました。

Big Integer ライブラリ(廃止が予定されています)

このライブラリは2023年末までに使用廃止とwolfSSL/wolfCryptライブラリからの削除が予定されています。使用する場合には、--enable-heapmath　あるいはCFLAGS=-DUSE_INTEGER_HEAP_MATHを指定してビルドしてください。 パブリックドメインLibtommath Libraryからフォークしました。Libtommathの詳細については、https://www.libtom.net/libtommath/を参照してください。フォークは、元のパブリックドメインコードよりもかなりアクティブで安全であることに注意してください。 このライブラリは一般に最もポータビリティがあり、使い始めるのが簡単です。通常のビッグ整数ライブラリの欠点は、すべてのメモリがヒープから割り当てられるため多量のヒープメモリを消費すること、XREALLOC()の実装が必要であること、タイミング耐性がないことです。実装はinteger.cにあります。

Fast Math

USE_FAST_MATH

パブリックドメインlibtomfastmathライブラリからフォーク。libtomfastmathの詳細については、https://www.libtom.net/tomsfastmathを参照してください。フォークは、libtomfastmathの元のパブリックドメインコードよりもかなりアクティブで安全です。パフォーマンス、セキュリティ、コードの品質が向上しました。また、FASTMATHコードをFIPS 140-2および140-3の認定を介して取得しました。

FastMathオプションは、可能であれば、アセンブリを使用する高速Big Integerライブラリに切り替わります。FastMathオプションは、RSA、DH、DSAなどの非対称プライベート/公開鍵操作をスピードアップします。デフォルトでは、wolfSSLの設定スクリプトはx86_64とAARCHアーキテクチャのFastMathライブラリを使用するように設定されています。このオプションは、可能であれば、Big Integerライブラリをアセンブリを使用するより速いものに切り替えます。組み立て包含は、コンパイラとプロセッサの組み合わせに依存します。いくつかの組み合わせは追加の構成フラグを必要とし、いくつかは不可能かもしれません。新しいアセンブリルーチンを使用してFastMathを最適化するのに役立ちます。コンサルティングベースで入手できます。アセンブリコードの使用は、使用されるコンパイラとプロセッサによって異なります。Archetecture固有の最適化を参照してください。

FastMathの場合、すべてのメモリがスタックに割り当てられます。FastMathを使用するときにスタックメモリの使用量が大きくなる可能性があるため、このオプションを使用するときにもTFM_TIMING_RESISTANTを定義することをお勧めします。TFM_TIMING_RSISTANTが定義されている場合、FastMathコードはタイミング耐性があります。これにより、より少ないメモリを使用する一定の時間のために、大きな数学ウィンドウのいくつかが減少します。ショートカットがないため、秘密鍵操作中に分岐が少なくなるため、スタックの使用量が少なくなります。タイミング攻撃は実際の脅威であり、悪意のある第三者に秘密鍵を再現するのに十分な情報を与える可能性があるため、これにより実装がより安全になります。

たとえば、IA32では、すべてのレジスタを利用可能である必要があり、フレームポインタを省略する必要があります。wolfsslは、デバッグ以外のビルドのためにGCCに-O3 -fomit-frame-pointerを追加します。別のコンパイラを使用している場合は、設定中に手動でCFLAGSに追加する必要があります。

OS Xは-mdynamic-no-picをCFLAGSに追加する必要があります。さらに、OS XでIA32の共有モードでビルドする場合は、LDFLAGSにオプションを渡す必要があります。

LDFLAGS="-Wl,-read_only_relocs,warning"

これはエラーの代わりにいくつかのシンボルの警告を与えます。

FastMathは動的およびスタックメモリの使用方法を変更します。通常の数学ライブラリは大きな整数に動的メモリを使用します。 FastMathはデフォルトで4096ビットの整数を保持する固定サイズバッファを使用し、2048ビットで2048ビットの乗算を可能にします。 4096ビット×4096ビット乗算が必要な場合は、wolfssl/wolfcrypt/tfm.hでFP_MAX_BITSを変更した場合、FP_MAX_BITSが増加すると、公開鍵操作で使用されているバッファーが大きくなるため、これもランタイムスタックの使用量を増やします。 FP_MAX_BITS最大キーサイズを2倍にする必要があります。たとえば、最大のキーが2048ビットの場合、FP_MAX_BITSが4096であるべきであり、4096ビットFP_MAX_BITSの場合は8192です。ECCのみを使用する場合は、これを最大ECCキーサイズの2倍に短縮できます。ライブラリ内のいくつかの関数はいくつかの一時的な大きな整数を使用します。つまり、スタックは比較的大きくなる可能性があります。これは組み込みシステムまたはスタックサイズが低い値に設定されているスレッド環境でのみ再生されるべきです。これらの環境での公開鍵操作中にFastMathでスタック破損が発生した場合は、スタックサイズを増やして必要量が許容出来るようにしてください。

autoconfシステムを使用せずにFastMathを有効にしている場合は、USE_FAST_MATHを定義し、integer.cを削除し、tfm.cをwolfSSLビルドに追加する必要があります。

アーキテクチャ固有の最適化

USE_FAST_MATHを使用したアセンブリ最適化に次のマクロを定義できます。

  • TFM_ARM

  • TFM_SSE2

  • TFM_AVR32

  • TFM_PPC32

  • TFM_PPC64

  • TFM_MIPS

  • TFM_X86

  • TFM_X86_64

これらのいずれも定義されていないか、TFM_NO_ASMが定義されていない場合、TFM_ISOが定義され、ISO Cポータブルコードが使用されます。

アルゴリズム固有の最適化

有効にすると、乗算と二乗の最適化された実装がそれぞれのECC曲線に使用されます。

  • TFM_ECC192

  • TFM_ECC224

  • TFM_ECC256

  • TFM_ECC384

  • TFM_ECC521

TFM_SMALL_SET

小さい数の乗算のためのスピード最適化を行います。1-16ワードのコンバ(Comba)乗算と二乗の実装を含みます。ECC操作の性能を向上させるのに役立ちます。

TFM_HUGE_SET

より大きな数の乗算のための速度最適化を行います。20、24、28、32、48、64ワードコンバ(Comba)乗算と、ビットサイズが許す場所での二乗の実装が含まれています。RSA/DH/DSA操作のパフォーマンスの向上に役立ちます。

TFM_SMALL_MONT_SET

Intelアーキテクチャ上の小さな数値のモンゴメリーリダクションのための速度最適化。1〜16ワードモンゴメリーリダクションの実装が含まれています。ECC操作の性能を向上させるのに役立ちます。

独自のシングルプレシジョン(SP)数学ライブラリのサポート

SP数学ライブラリは推奨されるデフォルトのオプションであり、DO-178C認定を受けています。 このライブラリを使用すると、特定の鍵サイズと一般的な曲線に対する公開鍵の操作が高速化されます。 次のような正しいコードファイルが含まれていることを確認してください：

  • sp_c32.c

  • sp_c64.c

  • sp_arm32.c

  • sp_arm64.c

  • sp_armthumb.c

  • sp_cortexm.c

  • sp_int.c

  • sp_x86_64.c

  • sp_x86_64_asm.S

  • sp_x86_64_asm.asm

WOLFSSL_SP

シングルプレシジョン演算ライブラリのサポートを有効にします。

WOLFSSL_SP_MATH

SP数学とアルゴリズムのみを有効にします。通常(integer.c)またはFAST(tfm.c)などの大きな整数演算コードを排除します。鍵サイズと曲線をSPでサポートされているものだけに制限します。

WOLFSSL_SP_MATH_ALL

SP数学とアルゴリズムを有効にします。SPではサポートされていない鍵サイズと曲線のために、通常(integer.c)またはFAST(tfm.c)などの大きな整数数学コードを実装しています。

WOLFSSL_SP_SMALL

SP Mathを使用する場合、これはコードの小さなバージョンを使用し、大きなスタック変数を回避します。

SP_WORD_SIZE

1ワードを1ワードに保存するための32ビットまたは64ビットのデータ型。

WOLFSSL_SP_NONBLOCK

単一の精度数学の「非ブロッキング」モードを有効にします。これにより、長い操作のためにFP_WouldBlockを返し、機能が完了するまで再度呼び出す必要があります。現在、これはECCでのみサポートされており、WC_ECC_NONBLOCKと組み合わせて使用されています。

WOLFSSL_SP_FAST_NCT_EXPTMOD

より速い非一定の時間モジュール式指数の実装を可能にします。公開鍵操作にのみ使用されます。秘密鍵操作ではありません。

WOLFSSL_SP_INT_NEGATIVE

マルチプレシジョン数値を負にすることができます。(暗号化操作には必要ありません。)

WOLFSSL_SP_INT_DIGIT_ALIGN

SP_INT_DIGITポインターへの整理されていないアクセスを有効にすることは許可されていません。

WOLFSSL_HAVE_SP_RSA

2048,3072および4096ビットのためのシングルプレシジョンRSA。

WOLFSSL_HAVE_SP_DH

2048、3072、および4096ビットの単一精度DH。

WOLFSSL_HAVE_SP_ECC

SECP256R1およびSECP384R1用のシングルプレシジョンECC。

WOLFSSL_SP_LARGE_CODE

大きなバイナリーサイズとなりますが、シングルプレシジョン(SP)スピードアップを許可します。一部の組み込みプラットフォームには適していない可能性があります。

WOLFSSL_SP_DIV_WORD_HALF

２倍の長さのワードを使用して除算が利用できないことを示します。たとえば、32ビットCPUで、ライブラリから64ビット除算でコンパイルしたくない場合は、このマクロを定義すると、半分のワードサイズを使用して除算が行われる実装を定義します。

WOLFSSL_SP_DIV_32

32ビット除算が利用できず、wolfSSLが独自のシングルプレシジョン(SP)実装を使用する必要があることを示します。

WOLFSSL_SP_DIV_64

64ビット除算が利用できず、WOLFSSLは独自のシングルプレシジョン(SP)実装を使用する必要があることを示します。

WOLFSSL_SP_ASM

より高速な単一精度(SP)プラットフォーム固有のアセンブリコードの実装を有効にします。プラットフォームが検出されます。

WOLFSSL_SP_X86_64_ASM

単一精度(SP)Intel X64アセンブリの実装を有効にします。

WOLFSSL_SP_ARM32_ASM

シングルプレシジョン(SP)AARCH32アセンブリの実装を有効にします。

WOLFSSL_SP_ARM64_ASM

シングルペシジョン(SP)AARCH64アセンブリの実装を有効にします。

WOLFSSL_SP_ARM_CORTEX_M_ASM

単一精度(SP)cortex-Mファミリー(cortex-M4を含む)アセンブリの実装を有効にします。

WOLFSSL_SP_ARM_THUMB_ASM

シングルプレシジョン(SP)ARM Thumbアセンブリの実装を有効にします(-mthumbと一緒に使用)。

WOLFSSL_SP_X86_64

シングルプレシジョン(SP)Intel X86 64ビットアセンブリスピードアップマクロを有効にします。WOLFSSL_SP_MATH_ALLが定義されている場合にのみ適用されます。sp_int.cを参照してください。

WOLFSSL_SP_X86

シングルプレシジョン(SP)Intel X86アセンブリスピードアップマクロを有効にします。WOLFSSL_SP_MATH_ALLが定義されている場合にのみ適用されます。sp_int.cを参照してください。

WOLFSSL_SP_PPC64

シングルプレシジョン(SP)PPC64アセンブリスピードアップマクロを有効にします。WOLFSSL_SP_MATH_ALLが定義されている場合にのみ適用されます。sp_int.cを参照してください。

WOLFSSL_SP_PPC

シングルプレシジョン(SP)PPCアセンブリスピードアップマクロを有効にします。WOLFSSL_SP_MATH_ALLが定義されている場合にのみ適用されます。sp_int.cを参照してください。

WOLFSSL_SP_MIPS64

シングルプレシジョン(SP)MIPS64アセンブリスピードアップマクロを有効にします。WOLFSSL_SP_MATH_ALLが定義されている場合にのみ適用されます。sp_int.cを参照してください。

WOLFSSL_SP_MIPS

シングルプレシジョン(SP)MIPSアセンブリスピードアップマクロを有効にします。WOLFSSL_SP_MATH_ALLが定義されている場合にのみ適用されます。sp_int.cを参照してください。

WOLFSSL_SP_RISCV64

シングルプレシジョン(SP)RISCV64アセンブリスピードアップマクロを有効にします。WOLFSSL_SP_MATH_ALLが定義されている場合にのみ適用されます。sp_int.cを参照してください。

WOLFSSL_SP_RISCV32

シングルプレシジョン(SP)RISCV32アセンブリスピードアップマクロを有効にします。WOLFSSL_SP_MATH_ALLが定義されている場合にのみ適用されます。sp_int.cを参照してください。

WOLFSSL_SP_S390X

シングルプレシジョン(SP)S390Xアセンブリスピードアップマクロを有効にします。WOLFSSL_SP_MATH_ALLが定義されている場合にのみ適用されます。sp_int.cを参照してください。

スタックまたはチップ固有の定義

wolfSSLは、さまざまなプラットフォームとTCP/IPスタック用にビルドできます。次の定義のほとんどは./wolfssl/wolfcrypt/settings.hにあり、デフォルトでコメントアウトされています。以下を参照する特定のチップまたはスタックのサポートを有効にするために、それぞれを作成できません。

IPHONE

iOSで使用するためにビルドする場合は定義できます。

THREADX

ThreadX RTOS()で使用するためにビルドするときに定義できます。

MICRIUM

MicriumのµC/OS-III RTO(https://www.micrium.com)のサポートを有効にするために、wolfSSLをビルドするときに定義できます。

MBED

MBEDプロトタイピングプラットフォーム用にビルドするときに定義できます(https://www.mbed.org)。

MICROCHIP_PIC32

マイクロチップのPIC32プラットフォーム(https://www.microchip.com)のビルド時に定義できます。

MICROCHIP_TCPIP_V5

マイクロチップTCP/IPスタックのバージョン5を定義できます。

MICROCHIP_TCPIP

マイクロチップTCP/IPスタックバージョン6以降に定義できます。

WOLFSSL_MICROCHIP_PIC32MZ

PIC32MZハードウェア暗号化エンジン用に定義できます。

FREERTOS

Freertos(https://www.freertos.org)のためにビルドするときに定義できます。LWIPを使用している場合は、WOLFSSL_LWIPも定義します。

FREERTOS_WINSIM

Freertos Windows Simulator(https://www.freertos.org)用にビルドするときに定義できます。

EBSNET

EBSNET製品とRTIPを使用するときに定義できます。

WOLFSSL_EMBOS

SEGGER embOS (https://www.segger.com/products/rtos/embos/) のビルド時に定義できます。 emNET を使用する場合は、WOLFSSL_EMNET も定義します。

WOLFSSL_EMNET

SEGGER emNET TCP/IP スタック (https://www.segger.com/products/connectivity/emnet/) のビルド時に定義できます。

WOLFSSL_LWIP

LWIP TCP/IPスタック(https://savannah.nongnu.org/projects/lwip/)でwolfSSLを使用するときに定義できます。

WOLFSSL_ISOTP

通常、CANバスに使用されるISO-TPトランスポートプロトコルでwolfSSLを使用する場合、定義できます。使用例はwolfSSL-例リポジトリにあります。

WOLFSSL_GAME_BUILD

ゲームコンソールのためにwolfSSLをビルドするときに定義できます。

WOLFSSL_LSR

LSR用にビルドする場合は定義できます。

FREESCALE_MQX

Freescale MQX/RTCS/MFS(https://www.freescale.com)用にビルドするときに定義できます。これにより、FREESCALE_K70_RNGAが定義され、Kinetis H/W乱数ジェネレーターアクセラレータのサポートが可能になります

WOLFSSL_STM32F2

STM32F2用のビルド時に定義できます。これは、wolfSSL(https://www.st.com/internet/mcu/subclass/1520.jsp)でSTM32F2ハードウェア暗号化およびハードウェアRNGサポートを可能にします。

COMVERGE

Comverge設定を使用する場合は定義できます。

WOLFSSL_QL

QL SEP設定を使用している場合は定義できます。

WOLFSSL_EROAD

eroadのためにビルドを定義することができます。

WOLFSSL_IAR_ARM

IAR Ewarm用にビルドする場合は定義できます。

WOLFSSL_TIRTOS

TI-RTOS用のビルド時に定義できます。

WOLFSSL_ROWLEY_ARM

Rowley CrossWorksでビルドするときに定義できます。

WOLFSSL_NRF51

Nordic NRF51に移植するときに定義できます。

WOLFSSL_NRF51_AES

NORDIC NRF51に移植するときにENCRYPTをAES 128 ECB Encryptに内蔵AESハードウェアを使用するように定義できます。

WOLFSSL_CONTIKI

Contikiオペレーティングシステムのサポートを有効にするために定義できます。

WOLFSSL_APACHE_MYNEWT

Apache MyNewtポート層を有効にするように定義できます。

WOLFSSL_APACHE_HTTPD

Apache HTTPD Webサーバーのサポートを有効にするために定義できます。

ASIO_USE_WOLFSSL

wolfSSLをASIO互換バージョンとしてビルドするように定義できます。その後、ASIOはBOOST_ASIO_USE_WOLFSSL Preprocessor Defineに依存しています。

WOLFSSL_CRYPTOCELL

ARM Cryptocellを使用できるように定義できます。

WOLFSSL_SIFIVE_RISC_V

RISC-V sifive/hifiveポートを使用して有効にするために定義できます。

WOLFSSL_MDK_ARM

MDKアームのサポートを追加します

WOLFSSL_MDK5

MDK5 ARMのサポートを追加します

OS特有の定義

USE_WINDOWS_API

UNIX/Linux APIに対して、WindowsライブラリAPIの使用を指定します。

WIN32_LEAN_AND_MEAN

Microsoft Win32 LeanとMean Buildのサポートを追加します。

FREERTOS_TCP

Freertos TCPスタックのサポートを追加します

WOLFSSL_SAFERTOS

Safertosのサポートを追加します

ビルドオプション

以下は、wolfSSLライブラリのビルド方法をカスタマイズするために./configureスクリプトに追加される可能性のあるオプションです。

デフォルトでは、wolfSSLは共有ライブラリとしてのみビルドされ、スタティックライブラリとしてのビルドが無効になっています。これにより、ビルド時間が2倍スピードアップされます。どちらのモードも明示的に無効にするか、必要に応じて有効にすることができます。

--enable-debug

wolfSSLデバッグサポートを有効にします。デバッグサポートを有効にすると、デバッグ情報を備え、メッセージをstderrに出力する定数DEBUG_WOLFSSLを定義することで、wolfSSL_Debugging_ON()をオンにします。実行時にデバッグロジングをオフにするには、wolfSSL_Debugging_OFF()を呼び出します。詳細については、デバッグを参照してください。

--enable-distro

wolfSSL Distro Buildを有効にします。

--enable-singlethread

単一のスレッドモード、マルチスレッド保護なしを有効にします。

単一のスレッドモードを有効にすると、セッションキャッシュのマルチスレッド保護がオフになります。アプリケーションがシングルスレッドであるか、アプリケーションがマルチスレッドであり、一度に1つのスレッドのみがライブラリにアクセスすることがわかっている場合にのみ、単一のスレッドモードを有効にします。

--enable-dtls

wolfSSL DTLSのサポートを有効にします

DTLSサポートを有効にすることで、ライブラリのユーザーがTLSおよびSSLに加えてDTLSプロトコルを使用できます。詳細については、DTLSセクションを参照してください。

--disable-rng

RNGのコンパイルと使用を無効にします

--enable-sctp

wolfSSL DTLS-SCTPサポートを有効にします

--enable-openssh

OpenSSH互換性ビルドを有効にします

--enable-apachehttpd

Apache HTTPD互換性のビルドを有効にします

--enable-openvpn

OpenVPN互換性Build.を有効にします

--enable-opensslextra

追加のOpenSSL API互換性を有効にすると、サイズが増加します

OpenSSL Extraを有効にするには、OpenSSL互換性の大規模なセットが含まれています。基本的なビルドは、ほとんどのTLS/SSLニーズに十分な機能を有効にしますが、10～100のOpenSSL関数を使用するアプリケーションを移植する場合、これによりサポートが向上します。wolfSSL openSSL互換性レイヤーは開発継続中です。したがって、必要な機能が欠落している場合は、お問い合わせください。OpenSSL互換性レイヤーの詳細については、OpenSSL互換性を参照してください。

--enable-opensslall

wolfSSL がサポートする openSSL互換性レイヤーのOpenSSL APIをすべて有効にします。

--enable-maxstrength

最大強度ビルドを有効にすると、TSLV1.2-AEAD-PFS暗号のみが可能になります。相互運用性の問題が発生する可能性があるため、これはデフォルトで無効になっています。 また、グリッチ検出も可能です。

--disable-harden

タイミング耐性とRSAブラインドを無効にします。この機能を無効にするとパフォーマンスが向上する可能性があります。

Note:hardenは、サイドチャネル攻撃に対する軽減をもたらします。慎重に検討した後にのみ、この機能を無効にしてください。

--enable-ipv6

IPv6のテストを有効にする、wolfssl適切なのはIPニュートラルです

IPv6を有効にするテストアプリケーションは、IPv4の代わりにIPv6を使用します。wolfSSL適切なIP Neutralでは、どちらのバージョンを使用できますが、現在テストアプリケーションはIPに依存しています。

--enable-bump

SSLバンプビルドを有効にします

--enable-leanpsk

LEAN PSKビルドを有効にします。

PSKを使用して非常に小さなビルドを使用し、ライブラリから多くの機能を排除します。この有効化を備えた組み込みシステム上のwolfSSLのおおよそのビルドサイズは21kbです。

--enable-leantls

無駄のないTLS 1.2クライアントのみ(クライアント認証なし)、ECC256、AES128、およびSHA256を実装します。他のビルドオプションと組み合わせてではなく、現時点ではそれ自体で使用されることを意味していました。

有効化すると、TLS 1.2クライアントのみをサポートする小さなフットプリントTLSクライアント(クライアント認証なし)、ECC256、AES128、SHA256をサポートします。他のビルドオプションと組み合わせてではなく、現時点ではそれ自体で使用されることを意味していました。

--enable-bigcache

ビッグセッションキャッシュを有効にします。

ビッグセッションキャッシュを有効にすると、セッションキャッシュが33セッションから20,027セッションまで増加します。デフォルトのセッションキャッシュサイズ33は、TLSクライアントと組み込みサーバーに適しています。ビッグセッションキャッシュは、基本的に1分あたり200個の新しいセッションを可能にする、重い負荷の下ではないサーバーに適しています。

--enable-hugecache

巨大なセッションキャッシュを有効にします。

巨大なセッションキャッシュを有効にすると、セッションキャッシュサイズが65,791セッションに増加します。このオプションは、重い負荷がかかるサーバー向けで、1分あたり13,000を超える新しいセッションが可能であるか、1秒あたり200を超える新しいセッションが可能です。

--enable-smallcache

小さなセッションキャッシュを有効にします。

小さなセッションキャッシュを有効にすると、wolfSSLは6セッションのみを保存します。これは、3kB近くのデフォルトがRAMが多すぎる埋め込みクライアントまたはシステムに役立つ場合があります。この定義では、500バイト未満のRAMを使用します。

--enable-savesession

永続的なセッションキャッシュを有効にします。

このオプションを有効にすることで、アプリケーションがwolfsslセッションキャッシュをメモリバッファに保持(保存)して復元できます。

--enable-savecert

永続的な証明書キャッシュを有効にします。

このオプションを有効にすることで、アプリケーションが持続(保存)され、wolfSSL証明書キャッシュをメモリバッファーに復元できます。

--enable-atomicuser

アトミックユーザーレコードレイヤを有効にします。

このオプションを有効にすると、ユーザーアトミックレコードレイヤの処理コールバックがオンになります。これにより、アプリケーションは独自のMAC /暗号化および復号化/検証コールバックを登録することができます。

--enable-pkcallbacks

公開鍵コールバックを有効にします

--enable-sniffer

wolfSSL Snifferのサポートを有効にします。

SNIFFER(SSL検査)サポートを有効にすると、SSLトラフィックパケットの収集と、正しいキーファイルでそれらのパケットを復号する機能が有効になります。

現在、スニファーは次のRSA暗号をサポートしています。

CBC暗号：

  • AES-CBC

  • Camellia-CBC

  • 3DES-CBC

ストリーム暗号：

  • RC4

--enable-aesgcm

AES-GCMサポートを有効にします。

このオプションを有効にすると、Public Keyコールバックが有効になり、アプリケーションは独自のECC署名/検証とRSA署名/検証を許可し、コールバックを識別して暗号化/復号することができます。

--enable-aesccm

AES-CCMサポートを有効にします

AES-GCMを有効にすると、これらの暗号スイートがwolfSSLに追加されます。wolfSSLは、AES-GCMのバランス速度とメモリ消費の4つの異なる実装を提供します。利用可能な場合、wolfSSLは64ビットまたは32ビットの数学を使用します。組み込みアプリケーションの場合、64ビットバージョンに匹敵する速度であるRAMベースのルックアップテーブル(セッションあたり8kb)を使用するスピーディーな8ビットバージョンと、追加のRAMを占有しない8ビットバージョンが遅いバージョンがあります。-enable-aesgcm 構成オプションは、オプション=word32、=table、または=small、つまり--enable-aesgcm=tableで変更できます。

--disable-aescbc

AES-CBCをコンパイルアウトするために--disable-aescbcで使用されていました

AES-GCMは、AESの8バイト認証(CCM-8)を備えたCBC-MACモードでカウンターを有効にします。

--enable-aescfb

AES-CFBモードサポートをオンにします

--enable-aesctr

wolfSSL AES-CTRサポートを有効にします

AES-CTRを有効にすると、カウンタモードが可能になります。

--enable-aesni

Wolfssl Intel AES-NIサポートを有効にします

AES-NIサポートの有効化AES-NIサポートチップを使用する場合、AES命令をチップから直接呼び出すことができます。これにより、AES機能の速度が速くなります。AES-NIの詳細については機能を参照してください。

--enable-intelasm

IntelおよびAMDプロセッサのASMスピードアップを有効にします。

wolfSSLのintelasmオプションを有効にすると、AESパフォーマンスを劇的に強化するプロセッサの拡張機能を利用します。configureオプションが有効になっているときに命令セットは、AVX1、AVX2、BMI2、RDRAND、RDSEED、AESNI、およびADXを含む。これらは最初にIntelプロセッサに導入され、AMDプロセッサは近年採用を開始しました。有効にすると、wolfSSLはプロセッサをチェックし、プロセッサがサポートする命令を設定します。

--enable-camellia

Camelliaサポートを有効にします

--enable-md2

MD2サポートを有効にします

--enable-nullcipher

wolfssl null cipherサポートを有効にする(暗号化なし)

--enable-ripemd

wolfssl ripemd-160サポートを有効にします

--enable-blake2

wolfSSL Blake2のサポートを有効にします

--enable-blake2s

wolfSSL Blake2Sサポートを有効にします

--enable-sha3

x86_64およびAarch64では、デフォルトで有効になっています。

wolfSSL SHA3のサポートを有効にします(小型ビルド用=small)

--enable-sha512

x86_64ではデフォルトで有効になっています。

wolfSSL SHA-512サポートを有効にします

--enable-sessioncerts

セッション証明書保存を有効にします

--enable-keygen

鍵生成機能を有効にします

--enable-certgen

証明書生成機能を有効にします

--enable-cert

証明書の拡張機能を有効にします (サポートされている拡張機能については、第 7 章を参照してください)

--enable-certreq

CERTリクエストの生成を有効にします

--enable-sep

SEP拡張機能を有効にします

--enable-hkdf

hkdf(hmac-kdf)を有効にする

--enable-x963kdf

X9.63 KDFサポートを有効にします

--enable-dsa

デジタル署名アルゴリズム(DSA)を有効にします。

FIPS186-4 で定義されている NIST 承認のデジタル署名アルゴリズムと RSA および ECDSA は、Secure Hash Standard (FIPS 180-4) で定義されている承認されたハッシュ関数と組み合わせて使用する場合、デジタル署名の生成と検証に使用されます。

--enable-eccshamir

x86_64ではデフォルトで有効になっています

ECC Shamirを有効にします

--enable-ecc

x86_64ではデフォルトで有効になっています

ECCを有効にします。

このオプションを有効にすると、ECCサポートと暗号スイートがwolfSSLに組み込まれます。

--enable-ecccustcurves

ECCカスタムカーブを有効にする(=allすべてのカーブタイプを有効にする)

--enable-compkey

圧縮鍵のサポートを有効にします

--enable-curve25519

Curve25519を有効にします(またはCurve25519_SMALLの場合は--enable-curve25519=small)。

楕円曲線は128ビットのセキュリティを提供し、ECDH鍵合意と共に使用されます(クロスコンパイル参照)。Curve25519を有効にすると、Curve25519アルゴリズムを使用できます。デフォルトのCurve25519は、より多くのメモリを使用するように設定されていますが、実行時間が速いです。アルゴリズムがより少ないメモリ使用量となるように、オプション--enable-curve25519=smallを使用できます。より少ないメモリ量になりますが、スピードとトレードオフがあります。

--enable-ed25519

ED25519(またはED25519 \ _smallの--enable-ed25519=small)を有効にする

ED25519オプションを有効にすると、ED25519アルゴリズムを使用できます。デフォルトのED25519は、より多くのメモリを使用するように設定されていますが、実行時間が速いです。アルゴリズムがより少ないメモリ使用量となるように、オプション--enable-ed25519=smallを使用できます。curve25519と同様に、この有効化オプションはメモリ使用量が少なくなりますが、スピードとメモリ間のトレードオフです。

--enable-fpecc

固定点キャッシュECCを有効にします

--enable-eccencrypt

ECC暗号化を有効にします

--enable-psk

PSK(事前共有キー)を有効にする

--disable-errorstrings

エラー文字列テーブルを無効にします

--disable-oldtls

古いTLSバージョン<1.2を無効にします

--enable-sslv3

SSLバージョン3.0を有効にします

--enable-stacksize

サンプルプログラムでのスタックサイズ情報を有効にします

--disable-memory

メモリコールバックを無効にします

--disable-rsa

RSAを無効にします

--enable-rsapss

RSA-PSSを有効にします

--disable-dh

DHを無効にします

--enable-anon

匿名を有効にします

--disable-asn

ASNを無効にします

--disable-aes

AESを無効にします

--disable-coding

コーディングベース16/64を無効にする

--enable-base64encode

x86_64ではデフォルトで有効になっています

base64エンコーディングを有効にします

--disable-des3

DES3を無効にします

--enable-arc4

ARC4を有効にします

--disable-md5

MD5を無効にします

--disable-sha

Shaを無効にします

--enable-webserver

Webサーバーを有効にします。

これは、yaSSL内蔵Webサーバーを使用してビルドするための完全な機能を可能にする標準ビルドを介して必要とされる機能をオンにします。

--enable-fips

FIPS 140-2を有効にする(ライセンスを実装する必要があります。)

--enable-sha224

x86_64ではデフォルトで有効になっています

wolfSSL SHA-224サポートを有効にします

--disable-poly1305

wolfSSL Poly1305サポートを無効にします

--disable-chacha

chachaを無効にします

--disable-hashdrbg

ハッシュDRBGサポートを無効にします

--disable-filesystem

ファイルシステムのサポートを無効にします。

これにより、ファイルシステムの使用を無効にすることができます。このオプションはNO_FILESYSTEMを定義します。

--disable-inline

インライン機能を無効にします。

このオプションを無効にすると、wolfSSLにインラインを組み込む機能が無効になります。リンクされていない関数プレースホルダーは、関数インラインが有効になっているときに、コードブロックが関数呼び出しに挿入されます。

--enable-ocsp

オンライン証明書ステータスプロトコル(OCSP)を有効にします。

このオプションを有効にすると、OCSP(Online Certificate Status Protocol)サポートがwolfSSLに追加されます。RFC 6960に記載されているように、X.509証明書の失効状態を取得するために使用されます。

--enable-ocspstapling

OCSPステーリングを有効にします

--enable-ocspstapling2

OCSPステープリングバージョン2を有効にします

--enable-crl

CRL(証明書の取り消しリスト)を有効にします

--enable-crl-monitor

CRLモニターを有効にします。

このオプションを有効にすると、特定のCRL(証明書の取り消しリスト)ディレクトリを積極的に監視する機能が追加されます。

--enable-sni

サーバー名表示を有効にします(SNI)。

このオプションを有効にすると、TLSサーバー名表示(SNI)拡張子がオンになります。

--enable-maxfragment

最大フラグメント長を有効にします。

このオプションを有効にすると、TLSの最大フラグメント長拡張機能がオンになります。

--enable-alpn

アプリケーションレイヤープロトコルネゴシエーション(ALPN)を有効にする

--enable-truncatedhmac

切り捨てられた鍵付きハッシュMac(HMAC)を有効にします。

このオプションを有効にすると、TLS切り捨てられたHMAC拡張機能がオンになります。

--enable-renegotiation-indication

再ネゴシエーションの表示を有効にします。

RFC 5746で説明されているように、この仕様は、再交渉を実行するTLS接続に結び付けることにより、再交渉スプライシングを含むSSL/TLS攻撃を防ぎます。

--enable-secure-renegotiation

安全なRenegotationを有効にします

--enable-supportedcurves

サポートされている楕円曲線を有効にします。

このオプションを有効にすると、TLSサポートされているECC曲線拡張がオンになります。

--enable-session-ticket

セッションチケットを有効にします

--enable-extended-master

拡張マスターシークレットを有効にします

--enable-tlsx

すべてのTLS拡張機能を有効にします。

このオプションを有効にすると、現在wolfSSLでサポートされているすべてのTLS拡張機能がオンになります。

--enable-pkcs7

PKCS＃7サポートを有効にします

--enable-pkcs11

PKCS＃11アクセスを有効にします

--enable-ssh

wolfsshオプションを有効にします

--enable-scep

wolfSCEP(Simple Certificate Enrollment Protocol)を有効にする

インターネットエンジニアリングタスクフォースによって定義されているように、SCEP(Simple Certificate Enrollment Protocol)プロトコルは、PKCS＃7とPKCS＃10を介したPKIです。SCEPは証明書要求を強く認証しないという証明書について説明します。

--enable-srp

安全なリモートパスワードを有効にします

--enable-smallstack

小さなスタックの使用を有効にします

--enable-valgrind

ユニットテストでValgrindを有効にします。

このオプションを有効にすると、wolfSSLユニットテストを実行するときにValgrindがオンになります。これは、開発サイクルの早い段階で問題をキャッチするのに役立ちます。

--enable-testcert

テスト証明書を有効にします。

このオプションが有効になっている場合、通常は公開されていないASN証明書APIの一部を公開します。これは、WolfCryptテストアプリケーション(wolfcrypt/test/test.c)に見られるように、テストの目的に役立ちます。

--enable-iopool

I/Oプールの例を有効にします

--enable-certservice

証明書サービスを有効にする(Windows Server)

--enable-jni

wolfSSL jniを有効にします

--enable-lighty

Lighttpd/Lightyを有効にします

--enable-stunnel

stunnelを有効にします

--enable-md4

MD4を有効にします

--enable-pwdbased

pwdbasedを有効にします

--enable-scrypt

scryptを有効にします

--enable-cryptonly

wolfCryptのみを有効にします

--disable-examples

サンプルプログラムのビルドを無効にします。

サンプルプログラムのビルドを有効にすると、wolfSSLのサンプルアプリケーションがビルドされます(client、server、echoclient、echoserver)。

--disable-crypttests

クリプトベンチ/テストを無効にします

--enable-fast-rsa

Intel IPPを使用してRSAを有効にします。

FAST-RSAの有効化IPPライブラリを使用してRSA操作を高速化します。それはより大きなメモリ消費量を有し、デフォルトのRSAはwolfsslによって設定されています。IPPライブラリが見つからない場合は、設定中にエラーメッセージが表示されます。AUTOCONFが検索する最初の場所は、Directory wolfssl_root/IPPにあります.2番目は、Linuxシステム上の/usr/lib/などのマシン上のライブラリの標準的な場所です。

RSA操作に使用されるライブラリは、ディレクトリwolfssl-X.X.X/IPP/にあり、X.X.Xは現在のwolfSSLバージョン番号です。バンドルされたライブラリからのビルドは、IPPのディレクトリの場所と名前に依存するため、サブディレクトリIPPのファイル構造を変更しないでください。

メモリを割り当てる場合、高速RSA操作にはDYNAMIC_TYPE_USER_CRYPTOのメモリタグがあります。

--enable-staticmemory

静的メモリ使用を有効にします

--enable-mcapi

マイクロチップAPIを有効にします

--enable-asynccrypt

非同期暗号を有効にします

--enable-sessionexport

セッションのエクスポートとインポートを有効にします

--enable-aeskeywrap

AESキーラップサポートを有効にします

--enable-jobserver

値：yes(デフォルト)/ no/#

makeを使用すると、マルチスレッドビルドを使用したWOLFSSLをビルドすると、yes(デフォルト)CPUコアの数を検出し、そのカウントの推奨されるジョブを使用して、正確な数を指定します。これはmake -jオプションと同様に機能します。

--enable-shared[=PKGS]

wolfSSLライブラリを共有ライブラリとしてビルドする[デフォルト=yes]

共有ライブラリビルドを無効にすると、wolfSSL共有ライブラリがビルドされるのを除外します。デフォルトでは、時間とスペースを節約するために共有ライブラリのみがビルドされています。

--enable-static[=PKGS]

wolfSSLライブラリをスタティクリンクライブラリとしてビルド[デフォルト=no]

--with-liboqs=PATH

OpenQuantumsafeインストールへのパス(デフォルト/usr/local)。

これにより、wolfSSLが実験的なTLS 1.3 Quantum-Safe KEMグループ、ハイブリッド量子セーフKEMグループ、LiboqsとのwolfSSL統合を介してFalcon Signature Schemeを使用する機能がオンになります。詳細については、このドキュメントの「Quantum-Safe Cryptographyの実験」を参照してください。

--with-libz=PATH

オプションで、圧縮用のLIBZを含めます。

LIBZを有効にすることで、LIBZライブラリのwolfSSLでの圧縮サポートが可能になります。このオプションを含めてwolfSSL_set_compression()を呼び出して使用することについてよく考えてみてください。送信前にデータを圧縮すると、送受信されるメッセージの実際のサイズが減少しますが、通常、圧縮によって保存されるデータの量は、最も低速なネットワークを除くすべてのネットワークでそのまま送信するよりも、分析に時間がかかります。

--with-cavium

キャビウム/ソフトウェアディレクトリへのパス。

--with-user-crypto

USER_CRYPTO インストールへのパス(デフォルト/usr/local)。

--enable-rsavfy

RSA Verify Onlyサポートを有効にします( Note --enable-cryptonlyを必要とします)。

--enable-rsapub

デフォルト値：有効なRSA公開キーのみサポート( Note --enable-cryptonlyが必要です)

--enable-armasm

ARMV8 ASMサポートを有効にします。

デフォルトの構成は、64か32ビットシステムに基づいてMCPUまたはMFPUを設定します。CPPFLAGSを使用して渡されたMCPUまたはMFPU設定を上書きしません。一部のコンパイラでは、constraiantsのために-mstrict-alignが必要になる場合があり、CPPFLAGSでユーザーがMCPU/MFPUフラグに合格しない限り、-mstrict-alignもデフォルトで設定されます。

--disable-tlsv12

TLS 1.2のサポートを無効にします

--enable-tls13

TLS 1.3サポートを有効にします

このビルドオプションを--disable-tlsv12および--disable-oldtlsと組み合わせて、TLS 1.3のみであるwolfSSLビルドを生成できます。

--enable-all

SSL V3を除くすべてのwolfSSL機能を有効にします

--enable-xts

AES-XTSモードを有効にします

--enable-asio

ASIOを有効にします。

オプション--enable-opensslextraと--enable-opensslallがwolfSSLを設定するときに有効にする必要があります。これら2つのオプションが有効になっていない場合、autoconfツールは自動的にこれらのオプションを有効にして、wolfSSLを設定するときにASIOを有効にします。

--enable-qt

QT 5.12以降のサポートを有効にします。

wolfSSL QTポートと互換性のあるwolfSSLビルド設定を有効にします。QTソースファイルにパッチを当てるには、wolfSSLからパッチファイルが必要です。

--enable-qt-test

QTテスト互換性のビルドを有効にします。

組み込みのQTテストの実行との互換性のために、wolfSSLをビルドするためのサポートを有効にします。

--enable-apache-httpd

Apache httpdサポートを有効にします

--enable-afalg

ハードウェア アクセラレーションに Linux モジュール AF_ALG を使用できるようにします。=xilinx、=xilinx-rsa、=xilinx-aes、=xilinx-sha3 を指定することで追加のザイリンクス使用が可能となります。

Crypto操作をオフロードするためのLinuxカーネルモジュール(AF_ALG)を活用するという点で--enable-devcryptoと似ています。一部のハードウェアでは、モジュールにはLinux Cryptoドライバを介して利用可能なパフォーマンスアクセラレーションがあります。ザイリンクスを使用したPetalinuxの場合、Flag --enable-afalg=xilinxを使用して、AF_ALGのザイリンクスインタフェースを使用するようにwolfSSLに指示できます。

--enable-devcrypto

ハードウェアアクセラレーションにLinux /dev/cryptoを使用できます。

引数を受け取る機能があり、aes(すべてのAESサポート)、hash(すべてのハッシュアルゴリズム)、およびcbc(AES-CBCのみ)の任意の組み合わせを受け取ることができます。オプションが与えられていない場合、allを使用することはデフォルトです。

--enable-mcast

wolfSSL DTLSマルチキャストサポートを有効にします

--disable-pkcs12

PKCS12コードを無効にします

--enable-fallback-scsv

シグナリング暗号スイート値(SCSV)を有効にします。

--enable-psk-one-id

TLS 1.3を使用した単一のPSK IDのサポートを有効にします

--enable-cryptocb

暗号コールバックを有効にします。wc_CryptoCb_RegisterDeviceを使用して暗号コールバックを登録し、wolfssl_CTX_SetDevidを使用して関連付けられているdevidを設定します。

--enable-cryptocbで次の2つの定義を使用して、RSAまたはECCソフトウェアフォールバックをコンパイルして、ソフトウェアRSA/ECCが不要な場合のフットプリント削減のために最適化できます。

  • WOLF_CRYPTO_CB_ONLY_RSA - RSAソフトウェアCrypto fallackをコンパイルアウトします

  • WOLF_CRYPTO_CB_ONLY_ECC - ECCソフトウェアCrypto fallackをコンパイルアウトします

wolf_crypto_cb_only_*オプションの使用には、サンプルプログラムを無効にする必要があります。--disable-examplesを参照してください

--enable-reproducible-build

バイナリジッター(タイムスタンプやその他の非機能メタデータ)を抑制し、同一のハッシュを持つビット単位で同一のバイナリパッケージを生成できるようにします。

特別な数学最適化フラグ

--enable-fastmath

FastMath の実装を有効にします。 シングルプレシジョン (SP) 演算が有効な場合、FastMath と Big Integer ライブラリの両方が無効になります。

use_fast_mathおよびBig Integer Math Libraryセクションを参照してください。

--enable-fasthugemath

Fast Math +巨大なコードを有効にします。

FastHugeMathの有効化にはFastMathライブラリのサポートが含まれており、公開鍵操作中の一般的なキーサイズ場合のループが展開されれうのでコードサイズを大幅に増やします。FastHugeMathを使用して、わずかなスピードアップがコードサイズの増加する価値があるかどうかを確認するために、有効・無効の前後でベンチマークユーティリティを使用してみてください。

--enable-sp-math

制限されたアルゴリズムスイートを使用したシングルプレシジョン(SP)数学実装を有効にします。サポートされていないアルゴリズムは無効になっています。オーバーライド--enable-sp、--enable-sp-math-all、--enable-fastmathおよび--enable-fasthugemath。

整数ライブラリーの実装を sp_int.c の実装に置き換えます。 - 最小限の実装で、sp_int.c の一部を有効にしますが、すべてではありません。 - --enable-sp と組み合わせて、sp_x86_64.c または sp_arm.c など (ターゲット システムに応じて以下のファイルのリスト) のソリューションをオンにして、RSA/ECC/DH 操作を実行できるようにする必要があります。 - --enable-sp-math-all (下記) と組み合わせてはいけません

FILE LIST (プラットフォームに依存、システムの仕様に基づいて構成によって選択されるか、 Makefile/IDE ソリューションを使用する場合は手動で制御できます): - sp_arm32.c - sp_arm64.c - sp_armthumb.c - sp_cortexm.c - sp_dsp32.c - sp_x86_64.c - sp_x86_64_asm.S - sp_x86_64_asm.asm

--enable-sp-math-all

デフォルトで有効。 完全なアルゴリズム スイートでシングルプレシジョン (SP) 数学の実装を有効にします。 サポートされていないアルゴリズムが有効になっていますが、最適化されていません。 --enable-sp、--enable-fastmath、--enable-fasthugemath をオーバーライドします。

  • 数学の実装を sp_int.c の実装に置き換えます
  • 完全な実装であり、 --enable-sp の動作に依存しません
  • --enable-sp と組み合わせて、可能であれば、32 ビットの sp_c32.c または 64 ビットの sp_c64.c で移植可能な c アセンブリ (ハードウェア固有でないアセンブリ) で記述された実装を使用できるようにすることができます。 それ以外(不可能な場合) には、sp_int.c の実装が使用されます。 移植可能な C アセンブリは、ハードウェアの最適化が利用できないターゲットでパフォーマンスを大幅に向上させます。
  • --enable-sp-math (上記) と組み合わせてはいけません

注: 鍵の長さがビット [256, 384, 521, 1024, 2048, 3072, 4096] の非対称暗号を使用している場合は、最大のパフォーマンスを得るために --enable-sp-math オプションの使用を検討する必要があります。 フットプリントのサイズが大きくなります。

--enable-sp-asm

シングルプレシジョン(SP)アセンブリの実装を有効にします。

Intel x86_64およびARMアーキテクチャを使用したアセンブリを通してシングルプレシジョン性能の向上を可能にするために使用できます。

--enable-sp=OPT

RSA、DH、およびECCの単一精度(SP)数学を有効にして、パフォーマンスを改善します。

+OPT には多くの可能な値があります。 以下は、enable-sp を呼び出す方法と、結果として定義される結果のマクロのリストです。 これらはすべて、カンマ区切りのリストで組み合わせることができます。 たとえば、「--enable-sp=ec256,ec384」です。 定義されるマクロの意味は、上記の [wolfSSL 独自のシングルプレシジョン (SP) 数学サポート] セクションで定義されています。

注: 1) "--enable-sp=small --enable-sp-math" は以下より小さくすることができます...

2) "--enable-sp-math-all=small"...

(1) には特定のキー サイズの実装しかありませんが、(2) にはすべてのキー サイズをサポートする実装があります。

注：これはx86_64用で、他の構成フラグはありません。結果は、指定するアーキテクチャやその他の構成フラグによって異なる場合があります。たとえば、Wolfssl_sp_384およびWolfssl_sp_4096は、Intel X86_64に対してのみ有効になります。

--enable-sp=noまたは--disable-sp

新しいマクロは定義されていません。--enable-spを使用しないことに相当します。

--enable-spまたは--enable-sp=yes

  • WOLFSSL_HAVE_SP_RSA

  • WOLFSSL_HAVE_SP_ECC

  • WOLFSSL_HAVE_SP_DH

  • WOLFSSL_SP_384

  • WOLFSSL_SP_4096

  • WOLFSSL_SP_LARGE_CODE

--enable-sp=small

  • WOLFSSL_HAVE_SP_RSA

  • WOLFSSL_HAVE_SP_DH

  • WOLFSSL_HAVE_SP_ECC

  • WOLFSSL_SP_4096

  • WOLFSSL_SP_384

  • WOLFSSL_SP_4096

  • WOLFSSL_SP_SMALL

  • WOLFSSL_SP_LARGE_CODE

  • WOLFSSL_SP_384

--enable-sp=smallfast

  • WOLFSSL_HAVE_SP_RSA

  • WOLFSSL_HAVE_SP_DH

  • WOLFSSL_HAVE_SP_ECC

  • WOLFSSL_SP_4096

  • WOLFSSL_SP_384

  • WOLFSSL_SP_SMALL

  • WOLFSSL_SP_4096

  • WOLFSSL_SP_LARGE_CODE

  • WOLFSSL_SP_FAST_MODEXP

--enable-sp=ec256または--enable-sp=p256または--enable-sp=p256

  • WOLFSSL_HAVE_SP_ECC

--enable-sp=smallec256または--enable-sp=smallp256または--enable-sp=small256

  • WOLFSSL_HAVE_SP_ECC

  • WOLFSSL_SP_SMALL

--enable-sp=ec384または--enable-sp=p384または--enable-sp=384

  • WOLFSSL_HAVE_SP_ECC

  • WOLFSSL_SP_384

  • WOLFSSL_SP_NO_256

--enable-sp=smallec384または--enable-sp=smallp384または--enable-sp=small384

  • WOLFSSL_HAVE_SP_ECC

  • WOLFSSL_SP_384

  • WOLFSSL_SP_NO_256

  • WOLFSSL_SP_SMALL

--enable-sp=ec1024または--enable-sp=p1024または--enable-sp=1024

  • WOLFSSL_HAVE_SP_ECC

  • WOLFSSL_SP_1024

  • WOLFSSL_SP_NO_256

--enable-sp=smallec1024または--enable-sp=smallp1024または--enable-sp=small1024

  • WOLFSSL_HAVE_SP_ECC

  • WOLFSSL_SP_1024

  • WOLFSSL_SP_NO_256

  • WOLFSSL_SP_SMALL

--enable-sp=2048

  • WOLFSSL_HAVE_SP_DH

  • WOLFSSL_HAVE_SP_RSA

  • WOLFSSL_SP_LARGE_CODE

  • WOLFSSL_SP_NO_3072

--enable-sp=small2048

  • WOLFSSL_HAVE_SP_DH

  • WOLFSSL_HAVE_SP_RSA

  • WOLFSSL_SP_LARGE_CODE

  • WOLFSSL_SP_NO_3072

  • WOLFSSL_SP_SMALL

--enable-sp=rsa2048

  • WOLFSSL_HAVE_SP_RSA

  • WOLFSSL_SP_LARGE_CODE

  • WOLFSSL_SP_NO_3072

--enable-sp=smallrsa2048

  • WOLFSSL_HAVE_SP_RSA

  • WOLFSSL_SP_LARGE_CODE

  • WOLFSSL_SP_NO_3072

  • WOLFSSL_SP_SMALL

--enable-sp=3072

  • WOLFSSL_HAVE_SP_DH

  • WOLFSSL_HAVE_SP_RSA

  • WOLFSSL_SP_LARGE_CODE

  • WOLFSSL_SP_NO_2048

--enable-sp=small3072

  • WOLFSSL_HAVE_SP_DH

  • WOLFSSL_HAVE_SP_RSA

  • WOLFSSL_SP_LARGE_CODE

  • WOLFSSL_SP_NO_2048

  • WOLFSSL_SP_SMALL

--enable-sp=rsa3072

  • WOLFSSL_HAVE_SP_RSA

  • WOLFSSL_SP_LARGE_CODE

  • WOLFSSL_SP_NO_2048

--enable-sp=smallrsa3072

  • WOLFSSL_SP_LARGE_CODE

  • WOLFSSL_SP_NO_2048

  • WOLFSSL_SP_SMALL

--enable-sp=4096または--enable-sp=+4096

  • WOLFSSL_HAVE_SP_DH

  • WOLFSSL_HAVE_SP_RSA

  • WOLFSSL_SP_4096

  • WOLFSSL_SP_LARGE_CODE

  • WOLFSSL_SP_NO_2048

  • WOLFSSL_SP_NO_3072

--enable-sp=small4096

  • WOLFSSL_HAVE_SP_DH

  • WOLFSSL_HAVE_SP_RSA

  • WOLFSSL_SP_4096

  • WOLFSSL_SP_LARGE_CODE

  • WOLFSSL_SP_NO_2048

  • WOLFSSL_SP_NO_3072

  • WOLFSSL_SP_SMALL

--enable-sp=rsa4096

  • WOLFSSL_HAVE_SP_RSA

  • WOLFSSL_SP_4096

  • WOLFSSL_SP_LARGE_CODE

  • WOLFSSL_SP_NO_2048

  • WOLFSSL_SP_NO_3072

--enable-sp=smallrsa4096

  • WOLFSSL_HAVE_SP_RSA

  • WOLFSSL_SP_4096

  • WOLFSSL_SP_LARGE_CODE

  • WOLFSSL_SP_NO_2048

  • WOLFSSL_SP_NO_3072

  • WOLFSSL_SP_SMALL

--enable-sp=nomalloc

  • WOLFSSL_SP_NO_MALLOC

--enable-sp=nonblock

  • WOLFSSL_SP_NO_MALLOC

  • WOLFSSL_SP_NONBLOCK

  • WOLFSSL_SP_SMALL

asm

他のアルゴリズムオプションと組み合わせて、それらのオプションに対してアセンブリコードがオンになっていることを示します。例えば、--enable-sp=rsa2048,asm。

クロスコンパイル

組み込み機器プラットフォーム上の多くのユーザーは、wolfSSLをクロスコンパイルしています。ライブラリをクロスコンパイルさせる最も簡単な方法は、./configureシステムを使用することです。MakeFileを生成し、wolfSSLをビルドするために使用できます。

クロスコンパイルの場合、次のような./configureにホストを指定する必要があります。

./configure --host=arm-linux

また、使用するコンパイラ、リンカーなどを指定する必要がある場合があります。

./configure --host=arm-linux CC=arm-linux-gcc AR=arm-linux-ar RANLIB=arm-linux

Configure Systemには、Cross Complingとmallocをオーバーライドするユーザーの検出時に表示される可能性があるバグがあります。rpl_mallocおよび/またはrpl_reallocへの未定義参照を取得した場合は、./configure行に次のものを追加してください。

ac_cv_func_malloc_0_nonnull=yes ac_cv_func_realloc_0_nonnull=yes

クロスコンパイルのためにwolfSSLを正しく設定した後は、ライブラリのビルドとインストールのための標準的なautoconfプラクティスに従うことができるはずです。

make
sudo make install

wolfsSLのクロスコンパイルに関する追加のヒントやフィードバックがある場合は、info@wolfssl.comまでお知らせください。

サンプルツールチェーンを使ったクロスコンパイルのコンフィグオプション例

armebv7-eabihf-glibc

./configure --host=armeb-linux \
        CC=armeb-linux-gcc LD=armeb-linux-ld \
        AR=armeb-linux-ar \
        RANLIB=armeb-linux-ranlib \
        CFLAGS="-DWOLFSSL_USER_IO -Os" \
        CPPFLAGS="-I./"

armv5-eabi-glibc

./configure --host=arm-linux \
        CC=arm-linux-gcc LD=arm-linux-ld \
        AR=arm-linux-ar \
        RANLIB=arm-linux-ranlib \
        CFLAGS="-DWOLFSSL_USER_IO -Os" \
        CPPFLAGS="-I./"

armv6-eabihf-glibc

./configure --host=arm-linux \
        CC=arm-linux-gcc LD=arm-linux-ld \
        AR=arm-linux-ar \
        RANLIB=arm-linux-ranlib \
        CFLAGS="-DWOLFSSL_USER_IO -Os" \
        CPPFLAGS="-I./"

armv7-eabihf-glibc

./configure --host=arm-linux \
        CC=arm-linux-gcc LD=arm-linux-ld \
        AR=arm-linux-ar \
        RANLIB=arm-linux-ranlib \
        CFLAGS="-DWOLFSSL_USER_IO -Os" \
        CPPFLAGS="-I./"

armv7m-uclibc

./configure --enable-static --disable-shared \--host=arm-linux CC=arm-linux-gcc \
        LD=arm-linux-ld AR=arm-linux-ar \
        RANLIB=arm-linux-ranlib \
        CFLAGS="-DWOLFSSL_USER_IO -Os" \
        CPPFLAGS="-I./"

arm-none-eabi-gcc

./configure --host=arm-none-eabi \
        CC=arm-none-eabi-gcc LD=arm-none-eabi-ld \
        AR=arm-none-eabi-ar RANLIB=arm-none-eabi-ranlib \
        CFLAGS="-DNO_WOLFSSL_DIR \
        -DWOLFSSL_USER_IO -DNO_WRITEV \
        -mcpu=cortex-m4 -mthumb -Os \
        -specs=rdimon.specs" CPPFLAGS="-I./"

MIPS32 - glibc.

./configure --host=mips-linux \
        CC=mips-linux-gcc LD=mips-linux-ld \
        AR=mips-linux-ar \
        RANLIB=mips-linux-ranlib \
        CFLAGS="-DWOLFSSL_USER_IO -Os" \
        CPPFLAGS="-I./"

PowerPC64LE-POWER8-GLIBC

./configure --host=powerpc64le-buildroot-linux-gnu \
        CC=powerpc64le-buildroot-linux-gnu-gcc \
        LD=powerpc64le-buildroot-linux-gnu-ld \
        AR=powerpc64le-buildroot-linux-gnu-ar \
        RANLIB=powerpc64le-buildroot-linux-gnu-ranlib \
        CFLAGS="-DWOLFSSL_USER_IO -Os" \
        CPPFLAGS="-I./"

x86-64-core-i7-glibc

./configure --host=x86_64-linux \
        CC=x86_64-linux-gcc LD=x86_64-linux-ld \
        AR=x86_64-linux-ar \
        RANLIB=x86_64-linux-ranlib \
        CFLAGS="-DWOLFSSL_USER_IO -Os" \
        CPPFLAGS="-I./"

x86-64-core-i7-musl

./configure --host=x86_64-linux \
        CC=x86_64-linux-gcc LD=x86_64-linux-ld \
        AR=x86_64-linux-ar \
        RANLIB=x86_64-linux-ranlib \
        CFLAGS="-DWOLFSSL_USER_IO -Os" \CPPFLAGS="-I./"

x86-64-core-i7-uclibc

./configure --host=x86_64-linux \
        CC=x86_64-linux-gcc LD=x86_64-linux-ld \
        AR=x86_64-linux-ar \
        RANLIB=x86_64-linux-ranlib \
        CFLAGS="-DWOLFSSL_USER_IO -Os" \
        CPPFLAGS="-I./"

移植向けビルド

wolfSSLは多くの環境やデバイスに移植（ポート）されています。これらのポートの一部とそれらのマニュアルはディレクトリwolfssl-X.X.X/IDEにあります。ここで、x.x.xは現在のwolfSSLバージョン番号です。このディレクトリには、環境用のwolfSSLをビルドするために使用されているIDEの有用な情報とコードも含まれています。

ポートリスト：

  • Arduino

  • LPCXPRESSO

  • Wiced Studio

  • CSBench

  • SGX WindowsとLinux

*これらのディレクトリ(wolfssl/IDE/WIN-SGXおよびwolfssl/IDE/LINUX-SGX)には、Intel SGXプロジェクトで使用されるライブラリとしてwolfSSLをビルドするためのMakefilesおよびVisual Studioソリューションが含まれています。

  • Hexagon

*このディレクトリ(wolfssl/IDE/HEXAGON)には、Hexagonツールチェーンを備えたビルド用のMakeFileが含まれています。ECC検証操作をDSPプロセッサにオフロードするためのwolfSSLをビルドするために使用できます。ディレクトリには、ビルドに必要な手順を支援するReadMeファイルが含まれています。

  • Hexiwear

  • NetBurner M68K

*ディレクトリ(wolfssl/IDE/M68K)には、NetBurner RTOを使用してMCF5441Xデバイス用のwolfSSLをビルドするためのMakeFileがあります。

  • Renesas

*このディレクトリ(wolfssl/IDE/Renesas)は、ルネサスデバイスの異なる複数のビルドを含みます。ハードウェアアクセラレーションを使用して実証するビルド例もあります。

  • XCode

  • Eclipse

  • Espressif

  • IAR-EWARM

  • Kinetis Design Studio(KDS)

  • Rowley Crossworks ARM

  • OpenSTM32

  • RISCV

  • Zephyr

  • mynewt

  • INTIME-RTOS

NXP CAAMのビルド

i.MX8(Linux)

既知の障害

  • HSMセッション(wc_SECO_CloseHSMおよびwolfSSL_CLeanupまたはwolfCrypt_Cleanup)を閉じる前に、開いているHSMキーストアセッションを終了すると、次回NVMを起動したときにセグメンテーションフォールトが発生します。 これを回避するには、電源を入れ直す必要があります。

制限事項

  • 多量の入力（１MByte）を扱うSECOでのAES操作は”シェアードメモリに十分なスペースがありません”とエラーになります。
  • 2つの鍵ストアを生成した後3番目を生成しようとすると失敗します。鍵ストアをリセットするためには　"rm -rf /etc/seco_hsm"を実行し電源を再投入してください。

イントロ

i.MX8デバイスでは、セキュリティ強化のために利用できるSECOハードウェアモジュールがあります。このモジュールは、AES操作とキーストレージ、限定的なECC操作とキーストレージを処理し、RNGを提供します。wolfSSLは、可能な限りSECOを使用できるように拡張しました。一部のアルゴリズムについては、i.MX8のCAAMはサポートしていますが、SECOモジュールはまだサポートしていません。このような場合、wolfSSLは/dev/cryptoを通じて、CAAMのジョブを直接作成するLinux CAAMドライバーへの呼び出しを行います。NXP Linux CAAMドライバーではデフォルトでサポートされるアルゴリズムがいくつかありますが、CAAMがサポートするすべてのアルゴリズムがサポートされるわけではありません。wolfSSLは、Linux CAAMドライバーを拡張して、追加のアルゴリズムのサポートを追加しました。同じアプリケーションからCAAMにアクセスする両方の手段を使用するには、異なるコードパスに関連付けられた「devId」（WOLFSSL_CAAM_DEVID または WOLFSSL_SECO_DEVID）を設定できます。 これらの ID は、構造体を最初に初期化するときに使用され、構造体の存続期間全体にわたってどのコードパスが使用されるかを設定します。ソフトウェアのみを使用する場合は、デフォルトのINVALID_DEVIDを設定する必要があります。例外は、キー ストアを使用しない SECO アイテム：TRNG とハッシュです。

ソフトウエアが使用されるバージョン：

  • imx-seco-libs ブランチ　imx_5.4.24_2.1.0
  • NXP "repo"ツールとYocto ビルド。Yoctoセットアップに関するドキュメントはここにあります。
  • wolfSSL 5.2.0 以降（5.2.0リリース以降に開発されたので）

#### サポートされるアルゴリズム\ サポートされるアルゴリズム、モード、オペレーションは以下を含みます：

  • AES (ECB, CBC, CCM, GCM)
  • AES CMAC
  • SHA256, SHA384
  • ECC 256/384 (keygen, sign, verify, ecdh)
  • RSA 3072 (keygen, sign, verify)
  • HMAC
  • Curve25519
  • TRNG

イメージのビルド

"repo"セットアップ

NXP "repo" コマンドツールのUbuntu 18.04 LTSでのセットアップは

sudo apt-get install gawk wget git-core diffstat unzip texinfo gcc-multilib
sudo apt-get install build-essential chrpath socat cpio python python3 python3-pip
sudo apt-get install python3-pexpect xz-utils debianutils iputils-ping python3-git
sudo apt-get install python3-jinja2 libegl1-mesa libsdl1.2-dev pylint3 xterm curl
sudo apt-get install ca-certificates

mkdir ~/bin
curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
chmod a+x ~/bin/repo
export PATH=~/bin:$PATH

git config --global user.name "Your Git Name"
git config --global user.email "Your Email"

2022年1月11日現在、GitHubは認証されていないGit接続を許可しなくなりました。このドキュメントが作成された時点 (2022年3月) では、NXPのリポジトリツールはこれをまだ考慮していません。この問題を回避するには、次のコマンドを使用してgit://github.com/ を https://github.com/ にリダイレクトしてください。

git config --global url."https://github.com/".insteadOf git://github.com/

ビルド用の所望のディレクトリを作成します：

mkdir imx-yocto-bsp
cd imx-yocto-bsp/

NXPの"repo"コマンドツールをセットアップした後、希望のバージョンのLinuxでディレクトリをsyncします。この場合は、5.4.24_2.1.0.

repo init -u https://source.codeaurora.org/external/imx/imx-manifest -b imx-linux-zeus -m imx-5.4.24-2.1.0.xml
repo sync

DISTRO=fsl-imx-wayland MACHINE=imx8qxpc0mek source imx-setup-release.sh -b build-xwayland
追加のYocto CAAM レイヤー

次にCAAMドライバー拡張レイヤーをダウンロードして、cryptodev-module、cryptodev-linux と　"linux-imx/drivers/crypto/caam/*"ファイルにパッチを適用します。ベースBlobとECDSA（署名/検証/鍵生成）はここ(https://source.codeaurora.org/external/imxsupport/imx_sec_apps/)で取得できます。RSAブラックキー、ECDH、Curve25519などのサポートにさらに拡張するレイヤーがmeta-imx-expand-caamです。これら両ディレクトリを他の既存のmeta-* ディレクトリの隣のsourcesディレクトリに配置します。

#直前のコマンドのbuild-xwayland ディレクトリに居る想定

#クローンするかあるいはzipファイルを解凍
git clone -b caam_expansion https://github.com/JacobBarthelmeh/imx_sec_apps
cp -r imx_sec_apps/meta-imx-ecdsa-sec ../sources/
cp -r imx_sec_apps/meta-imx-expand-caam ../sources/


# あるいは

git clone https://source.codeaurora.org/external/imxsupport/imx_sec_apps.git

#"meta-imx-expand-caam" はwolfSSL由来
unzip meta-imx-expand-caam.zip

cp -r imx_sec_apps/meta-imx-ecdsa-sec ../sources/
mv meta-imx-expand-caam ../sources/

それらレイヤーをビルドに加えます。ecdsaを最初に加え、次にCAAM拡張を加えます：

vim conf/local.conf
EXTRA_IMAGE_FEATURES_append = " dev-pkgs tools-sdk tools-debug ssh-server-openssh "
IMAGE_INSTALL_append = " cryptodev-module cryptodev-linux eckey "

このビルドでは、デバッグツールとSSHサーバーを追加しましたが、サイズを削減する必要がある場合はこれらは必要ありません。追加する重要な項目は"cryptodev-module と cryptodev-linux"です。 "eckey"は、BLOBのカプセル化とカプセル化解除を行うためのNXPのデモツールです。

[オプション] cryptodevモジュールの自動ロードを追加するには、次の行をconf/local.confに追加します:

KERNEL_MODULE_AUTOLOAD += "cryptodev"

それ以外の場合は、電源を入れ直すたびに"modprobe cryptodev"を使用してモジュールをロードする必要があります。

ビルドとデプロイ

イメージのビルドの開始には次のコマンドを使います。そのあとで、もしSDカードを使っているならばカードに書き込みます：

bitbake core-image-base

cd tmp/deploy/images/imx8qxpc0mek/
bzcat core-image-base-imx8qxpc0mek.sdcard.bz2 | sudo dd of=/dev/diskX bs=5m

注: 5mはMac OSの場合に使用し、Linuxの場合は5Mを使用します。diskXはsdcardの場所、つまりMacのdisc2またはLinuxのsdbXに置き換える必要があります。実行する前に、SDカードのディスク番号を確認してください。

後で wolfssl/examples のビルドに使用するために、次のコマンドを使用してインストール ディレクトリをエクスポートします:

export CRYPTODEV_DIR=`pwd`/tmp/sysroots-components/aarch64/cryptodev-linux/usr/include/

クロスコンパイルのためにツールチェーンをインストールするには次のYoctoコマンドを使います：

bitbake meta-toolchain
sudo ./tmp/deploy/sdk/<version>.sh

NXP HSMのビルド

zlibのビルド

いくつかの方法がありますが、ひとつの方法はYoctoビルドに含めてしまう方法があります。また、他の方法としてはbitbakeを使って次のようにビルドする方法も取れます：

cd build-xwayland
bitbake zlib

このコマンドは実行結果をtmp/sysroots-components/aarch64/zlib/usr/ディレクトリに配置します。wolfssl/examples で後に使用するのでインストールディレクトリを次のコマンドでエクスポートします：

export ZLIB_DIR=`pwd`/tmp/sysroots-components/aarch64/zlib/usr/
NXP HSM libのビルド

NXP HSM ライブラリをダウンロードして必要なzlibが見つかるようにMakefileや環境変数を調整します。

git clone https://github.com/NXP/imx-seco-libs.git
cd imx-seco-libs
git checkout imx_5.4.24_2.1.0

vim Makefile


CFLAGS = -O1 -Werror -fPIC -I$(ZLIB_DIR)/include -L$(ZLIB_DIR)/lib

さらに

make
make install

後で wolfssl/examples のビルドに使用するために、次のコマンドを使用してインストール ディレクトリをエクスポートします:

export HSM_DIR=`pwd`/export/usr/

Make install を行うとデフォルトで結果を"export"サブディレクトリに配置します。

wolfSSLのビルド

Autoconfを使ってのビルド

開発ツールを使用してYoctoイメージをセットアップすると、wolfSSLをシステム上に直接構築できます。より最小限のアプローチとして、クロスコンパイルを使用できます。デバッグメッセージは –enable-debug で有効にできます。SECO作業に固有の追加のデバッグメッセージは、マクロ DEBUG_SECOを定義し、/dev/crypto呼び出しのDEBUG_DEVCRYPTOを定義することで有効にできます。どちらの追加のデバッグメッセージもprintfを使用し、stdoutパイプに出力します。 SECOで使用するための重要な有効化オプションがいくつかあります。 --enable-caam=seco、--enable-devcrypto=seco、--with-seco=/hsm-lib/exportなどです。

HSM SECO のみを使用したビルド例 (追加アルゴリズムの devcrypto サポートなし)

source /opt/fsl-imx-wayland/5.4-zeus/environment-setup-aarch64-poky-linux

# wolfSSLのビルドで依存しているコンポーネントをインストール
sudo apt-get install autoconf automake libtool

./autogen.sh
./configure --host=aarch64-poky-linux --with-libz=$ZLIB_DIR --with-seco=$HSM_DIR \ --enable-caam=seco --enable-cmac --enable-aesgcm --enable-aesccm --enable-keygen \
CPPFLAGS="-DHAVE_AES_ECB"
make

HSM SECOと追加のdevcryptoサポートを使ってのビルド例。インクルードパスとしてcrypto/cryptpdev.hを指定する必要があります。

./configure --host=aarch64-poky-linux --with-libz=$ZLIB_DIR --with-seco=$HSM_DIR \
--enable-caam=seco --enable-cmac --enable-aesgcm --enable-aesccm --enable-keygen \
CPPFLAGS="-DHAVE_AES_ECB -I$CRYPTODEV_DIR" --enable-devcrypto=seco \
--enable-curve25519
make

wolfCrypt_Init/wolfSSL_Init関数呼び出しの早い段階でエラーを発生させるフェイルセーフがあります。1つのケースは、cryptodevモジュールがロードされていないか、必要な操作に利用できるサポートがない場合です。もう1つのケースはinitです。NXP HSMをセットアップできない場合、操作は失敗します。アプリケーションの初期化に失敗した場合、wolfSSLビルドに --enable-debug を追加し、wolfSSL の初期化前に関数呼び出し wolfSSL_Debugging_ON()を実行すると、失敗の理由に関する有用なデバッグメッセージが出力されます。

デバッグオプションを有効にしてビルドする例：

./configure --host=aarch64-poky-linux --with-libz=$ZLIB_DIR --with-seco=$HSM_DIR \
--enable-caam=seco --enable-cmac --enable-aesgcm --enable-aesccm --enable-keygen \
CPPFLAGS="-DHAVE_AES_ECB -I$CRYPTODEV_DIR -DDEBUG_SECO -DDEBUG_DEVCRYPTO" \
--enable-devcrypto=seco --enable-curve25519
user_settings.hを使ってのビルド

autotoolsを使用する代わりに有効化できるマクロが各種用意されています。

CAAM - WOLFSSL_CAAM - CAAM サポートを有効にするメインのマクロスイッチ。 - WOLF_CRYPTO_CB - CAAM サポートはcrypto callbacksを使用します。 - WOLFSSL_SECO_CAAM - SECO HSMをCAAMと共に使用することを有効にする(AES-GCMが平文の鍵をHSMにインポートする際に使用される)。 - WOLFSSL_HASH_KEEP - SHA256 などのアルゴリズムを使用してハッシュする場合、メッセージを構築し、Final への呼び出し時にのみハッシュされるように送信します。 - WOLFSSL_CAAM_ECC - CAAM ECCサポートを有効にします。 - WOLFSSL_CAAM_CMAC - CAAM CMACサポートを有効にします。 - WOLFSSL_CAAM_CIPHER - CAAM AESサポートを有効にします。 - WOLFSSL_CAAM_HMAC - CAAM HMACサポートを有効にします。 - WOLFSSL_CAAM_HASH - CAAM hashingサポートを有効にします。 - WOLFSSL_CAAM_CURVE25519 - CAAM Curve25519サポートを有効にします。

cryptodev-linux - WOLFSSL_DEVCRYPTO - cryptodev-linuxサポートを有効にするメインのマクロスイッチ。 - WOLFSSL_DEVCRYPTO_HMAC - HMAC with cryptodev-linuxを使ったHMACサポートを有効にします。 - WOLFSSL_DEVCRYPTO_RSA - cryptodev-linuxを使ったRSAサポートを有効にします。 - WOLFSSL_DEVCRYPTO_CURVE25519 - cryptodev-linuxを使ったCurve25519サポートを有効にします。 - WOLFSSL_DEVCRYPTO_ECDSA - cryptodev-linuxを使ったECDSAサポートを有効にします。 - WOLFSSL_DEVCRYPTO_HASH_KEEP - cryptodev-linuxを使ったハッシュ値の保持サポートを有効にします。

CAAM サポートに必要なコンパイルすべき追加のファイル:

  • wolfssl/wolfcrypt/src/port/caam/wolfcaam_aes.c
  • wolfssl/wolfcrypt/src/port/caam/wolfcaam_cmac.c
  • wolfssl/wolfcrypt/src/port/caam/wolfcaam_rsa.c
  • wolfssl/wolfcrypt/src/port/caam/wolfcaam_ecdsa.c
  • wolfssl/wolfcrypt/src/port/caam/wolfcaam_x25519.c
  • wolfssl/wolfcrypt/src/port/caam/wolfcaam_hash.c
  • wolfssl/wolfcrypt/src/port/caam/wolfcaam_hmac.c
  • wolfssl/wolfcrypt/src/port/caam/wolfcaam_init.c
  • wolfssl/wolfcrypt/src/port/caam/wolfcaam_seco.c
  • wolfssl/wolfcrypt/src/port/devcrypto/devcrypto_ecdsa.c
  • wolfssl/wolfcrypt/src/port/devcrypto/devcrypto_x25519.c
  • wolfssl/wolfcrypt/src/port/devcrypto/devcrypto_rsa.c
  • wolfssl/wolfcrypt/src/port/devcrypto/devcrypto_hmac.c
  • wolfssl/wolfcrypt/src/port/devcrypto/devcrypto_hash.c
  • wolfssl/wolfcrypt/src/port/devcrypto/devcrypto_aes.c
  • wolfssl/wolfcrypt/src/port/devcrypto/wc_devcrypto.c
  • wolfssl/wolfcrypt/src/cryptocb.c

サンプルプログラム

Testwolfcryptの実行

wolfSSLにバンドルされている単体テストは、wolfcrypt/test/test.cにあります。デバイス上でテストを構築して実行する例は次のとおりです。これはWOLFSSL_CAAM_DEVIDを使用するため、NXP HSMライブラリではなくcryptodevモジュールを使用していることに注意してください。

./configure --host=aarch64-poky-linux --with-libz=$ZLIB_DIR \
--with-seco=$HSM_DIR --enable-caam=seco --enable-cmac --enable-aesgcm \
--enable-aesccm --enable-keygen CPPFLAGS="-DHAVE_AES_ECB -I$CRYPTODEV_DIR" \
--enable-devcrypto=seco --enable-curve25519 --enable-sha224 --enable-static \
--disable-shared --disable-filesystem
make

scp wolfcrypt/test/testwolfcrypt root@192.168.0.14:/tmp
ssh root@192.168.0.14
root@imx8qxpc0mek:~# /tmp/testwolfcrypt
------------------------------------------------------------------------------
 wolfSSL version 5.2.0
------------------------------------------------------------------------------
error   test passed!
MEMORY   test passed!
base64   test passed!
asn     test passed!
RANDOM   test passed!
MD5     test passed!
SHA     test passed!
SHA-224  test passed!
SHA-256  test passed!
SHA-384  test passed!
SHA-512  test passed!
SHA-3   test passed!
Hash    test passed!
HMAC-MD5 test passed!
HMAC-SHA test passed!
HMAC-SHA224 test passed!
HMAC-SHA256 test passed!
HMAC-SHA384 test passed!
HMAC-SHA512 test passed!
HMAC-SHA3   test passed!
HMAC-KDF    test passed!
GMAC    test passed!
Chacha   test passed!
POLY1305 test passed!
ChaCha20-Poly1305 AEAD test passed!
AES     test passed!
AES192   test passed!
AES256   test passed!
AES-GCM  test passed!
AES-CCM  test passed!
RSA     test passed!
DH      test passed!
PWDBASED test passed!
ECC     test passed!
ECC buffer test passed!
CURVE25519 test passed!
CMAC    test passed!
COMPRESS test passed!
logging  test passed!
time test passed!
mutex   test passed!
memcb   test passed!
crypto callback test passed!
Test complete
Exiting main with return code: 0
root@imx8qxpc0mek:~#

そのほかのサンプルプログラムをwolfssl-examplesレポジトリのcaam/secoディレクトリ以下に用意しています。

git clone https://github.com/wolfssl/wolfssl-examples
cd wolfssl-examples/caam/seco
make
ソースコードをコンパイル[user_settings.hを使って]

wolfSSLにリンクする単一のソースファイルを構築するには、次のコマンドを使用できます。前のステップの環境変数はまだ設定されています。

source /opt/fsl-imx-xwayland/5.4-zeus/environment-setup-aarch64-poky-linux

$CC -DWOLFSSL_USER_SETTINGS -I /path/to/user_settings.h \
-I $CRYPTODEV_DIR -I $HSM_DIR/include -I ./wolfssl server-dtls.c \
libwolfssl.a $HSM_DIR/lib/hsm_lib.a $HSM_DIR/lib/seco_nvm_manager.a \
$ZLIB_DIR/lib/libz.a -lpthread -lm

API

追加されたAPI

追加APIリスト

  • void wc_SECO_AesSetKeyID(Aes* aes, int keyId);
    この関数はSECOキーIDをAes構造体にセットする際に使用します。Aes構造体が初期化された後で、暗号化/復号操作に使用される前に呼び出される必要があります。
  • int wc_SECO_AesGetKeyID(Aes* aes);
    Aes構造体にセットされているSECOキーIDのゲッター関数です。
  • void wc_SECO_CMACSetKeyID(Cmac* cmac, int keyId);
    wc_SECO_AesSetKeyID関数と似ていますが対象がCmac構造体になっています。
  • int wc_SECO_CMACGetKeyID(Cmac* cmac);
    Cmac構造体にセットされているSECOキーIDのゲッター関数です。
  • int wc_SECO_OpenHSM(word32 keyStoreId, word32 nonce, word16 maxUpdates, byte flag);
    この関数はキーストアが必要となるどの操作（ECCやAES）の前に呼び出される必要があります。最初の引数はキーストアID,"nonce"は特定の32ビットの連番で、キーストアを新規に作成する場合や、既存のキーストアをアンロックするのに使用されます。“maxUpdates”はキーストアが更新できる最大回数を指定します。“flag”はオプショナルフラグで、キーストアが生成されているのかを示すために使用されます。HSMキーストアを生成するためにはflagはCAAM_KEYSTORE_CREATEでなければなりません、CAAM_KEYSTORE_UPDATEは既存のキーストアをオープンし更新します。
  • int wc_SECO_CloseHSM(void);
    この関数は、キーストアの使用が完了したとき、wolfCrypt_Cleanup/wolfSSL_Cleanup を呼び出す前に呼び出す必要があります。現在オープンしているキーストアを閉じます。
  • int wc_SECO_GenerateKey(int flags, int group, byte out, int outSz, int keyType, int keyInfo, unsigned int keyIdOut);
    この関数は、SECOで新しいキーを生成するために使用できます。キー生成の場合、フラグはCAAM_GENERATE_KEYである必要があります。キーを更新する場合、フラグは CAAM_UPDATE_KEYである必要があります。keyIdOut引数は、キーの作成時に設定される入出力引数であり、キーの更新時に入力として設定する必要があります。キーを更新する場合は、一時的なタイプである必要があり、更新のためにグループを0に設定する必要があります。 一時的なタイプは keyInfo 引数として設定されます。keyInfo と KeyTypes の可能なオプションは次のとおりです：
    • CAAM_KEY_TRANSIENT (keyInfo)
    • CAAM_KEY_PERSISTENT (keyInfo)
    • CAAM_KEYTYPE_ECDSA_P256 (keyType)
    • CAAM_KEYTYPE_ECDSA_P384 (keyType)
    • CAAM_KEYTYPE_AES128 (keyType)
  • int wc_SECO_DeleteKey(unsigned int keyId, int group, int keyTypeIn);
    キーストアから鍵を削除するのに使用されます。
CAAM をサポートするネイティブwolfSSL API

これは、このドキュメントで概説されているSECOビルドでCAAMサポートを備えたネイティブwolfSSL APIのリストです。

AES暗号化および復号操作に使う鍵を生成する場合、次のプロセスを使用します。wc_SECO_GenerateKey の使用(CAAM_GENERATE_KEY, groupID, pubOut, 0, CAAM_KEYTPE_AES128, CAAM_KEY_PERSISTENT, &keyIdOut); ここで、groupID は指定されたグループ番号、pubOut は32バイトのバッファーであり、変数 keyIdOut は生成された新しいキーIDに設定されます。生成されたこの新しいキーIDは、wc_SECO_AesSetKeyID(Aes, keyIdOut)を使用してAes構造体に設定できます。キーIDが構造内に設定され、Aes構造がWOLFSSL_SECO_DEVIDタイプとして初期化されると、すべての暗号化および復号操作にそのキーID が使用されます。

AES (ECB/CBC)

AES ECB/CBC鍵を生成する代わりに、Aes構造体が WOLFSSL_SECO_DEVIDで初期化されている場合は、プレーンテキストキーを渡して関数 wc_AesSetKeyを呼び出すことができます。次に、API wc_AesSetKeyは、一意のKEKを使用して鍵を暗号化し、SECO HSMにインポートしようとします。インポートが成功すると、値0が返され、鍵IDがAes構造体に設定されます。

  • CBC暗号化はwc_AesCbcEncryptで行われ,復号はwc_AesCbcDecryptで行われます。
  • ECB暗号化はwc_AesEcbEncryptで行われ,復号はwc_AesEcbDecryptで行われます。

Aes構造体の使用が完了したら、wc_AesFree(Aes)を使用して解放する必要があります。

AES-GCM
  • GCM暗号化はwc_AesGcmEncrypt, 復号はwc_AesGcmDecryptで行われます。

AES-GCM暗号化関数は、Aes構造体、出力バッファ、入力バッファ、入力バッファサイズ、ノンス、ノンスサイズ (12バイト必要)、MACまたはタグとして知られる、タグサイズ (16 バイトが必要)、追加データ、追加データサイズ（4バイト）を引数として取ります。暗号化の場合、入力バッファは暗号化され、タグバッファは作成されたMACで埋められます。

AES-GCM復号の場合、関数は Aes構造体、プレーンテキスト出力バッファ、暗号テキスト入力バッファ、入力バッファ サイズ、ノンス、ノンスサイズ(12バイト)、暗号化呼び出しで以前に作成されたタグ、タグバッファサイズ、追加データ、 追加のデータサイズを引数として取ります。復号化時にタグバッファがチェックされ、メッセージの整合性が検証されます。

Aes構造体の使用が完了したら、wc_AesFree(Aes)を使用して解放する必要があります。

AES-CCM
  • CCM号化はwc_AesCcmEncrypt, 復号はwc_AesCcmDecryptで行われます。

AES-CCM暗号化関数は、Aes構造体、出力バッファ、入力バッファ、入力バッファサイズ、ノンス、ノンスサイズ (12 バイトが必要)、MACまたはタグとして知られる、タグサイズ(16バイト必要)、 追加データ、追加データサイズ（0バイト）。追加のデータバッファは NULLにする必要があり、NXP HSMライブラリではサイズ 0 が必要です。 暗号化の場合、入力バッファは暗号化され、タグ バッファは作成された MACで埋められます。

AES-CCM復号の場合、関数はAes構造体、プレーンテキスト出力バッファ、暗号テキスト入力バッファ、入力バッファサイズ、ノンス、ノンスサイズ(12バイト)、暗号化呼び出しで以前に作成されたタグ、タグバッファサイズ、追加データ、 追加のデータサイズを引数に取ります。 暗号化関数と同様に、追加のデータバッファーは NULLである必要があります。 復号時にタグバッファがチェックされ、メッセージの整合性が検証されます。

Aes構造体の使用が完了したら、wc_AesFree(Aes)を使用して解放する必要があります。

AES CMAC

AES CMAC操作の場合、wc_SECO_GenerateKey(CAAM_GENERATE_KEY, groupID, pubOut, 0, CAAM_KEYTPE_AES128, CAAM_KEY_PERSISTENT, &keyIdOut); を使用してAES鍵を生成できます。ここで、groupIDは指定されたグループ番号、pubOutは32バイトのバッファーであり、変数keyIdOutは生成された新しいキーIDに設定されます。生成されたこの新しいキーID は、wc_SECO_CMACSetKeyID(Cmac, keyIdOut) を使用して Aes構造体に設定できます。キーIDが構造内に設定され、Aes構造体がWOLFSSL_SECO_DEVIDタイプとして初期化されると、すべての暗号化および復号化操作にそのキーIDが使用されます。

SMライブラリはシングル ショットタイプであるため、wc_CmacUpdateを呼び出すたびに入力が内部バッファに保存されます。その後、wc_CmacFinalが呼び出されると、MACを作成するためにバッファ全体がハードウェアに渡されます。

RSA

RSA操作では、cryptodev-linuxモジュールが使用されます。これには、AES-ECBで暗号化された黒の秘密鍵のサポートが含まれます。これは、WOLFSSL_CAAM_DEVIDで初期化された場合のデフォルトです。

cryptodev-linuxモジュールで使用されるネイティブwolfSSL APIの例は次のとおりです：

wc_InitRsaKey_ex(key, heap-hint (can be NULL), WOLFSSL_CAAM_DEVID);
wc_MakeRsaKey(key, 3072, WC_RSA_EXPONENT, &rng);
wc_RsaSSL_Sign or wc_RsaPublicEncrypt
wc_RsaSSL_Verify or wc_RsaPrivateDecrypt
wc_FreeRsaKey(key)
ECC

ECC署名および検証操作では、cryptodev-linuxモジュールまたは NXP HSMライブラリのいずれかを使用できます。共有シークレットを作成するためのECDH操作は、cryptodev-linuxモジュールを使用してのみ実行できます。

SECOで使用する場合 (NXP HSMライブラリを使用)、ecc_key構造体を初期化するときに WOLFSSL_SECO_DEVIDのdev IDフラグを使用する必要があります。cryptodev-linuxモジュールで使用するには、dev IDフラグ WOLFSSL_CAAM_DEVIDを使用する必要があります。関数 wc_ecc_init_ec(key, heap-hint (NULL 可), dev ID) による初期化後、どちらのユースケースも、署名と検証を行うためのネイティブの wolfSSL関数呼び出しの同じ関数に従います。

ecc_key 構造体の初期化後の関数呼び出しの例は次のようになります：

wc_ecc_make_key(&rng, ECC_P256_KEYSIZE, key);
wc_ecc_sign_hash(hash, hashSz, sigOut, sigOutSz, &rng, key);
wc_ecc_verify_hash(sig, sigSz, hash, hashSz, &result, key);

また、cryptodev-linuxモジュール(WOLFSSL_CAAM_DEVID)を使用すると、ECDH関数を使用できます。

wc_ecc_shared_secret(keyA, keyB, sharedSecret, sharedSecretSz);
Hash (Sha256, Sha384, HMAC)

SHA256およびSHA384の操作では、NXP HSMライブラリを使用します。HMAC操作では、cryptodev-linuxモジュールが使用されます。

デフォルトでは、SHA操作は NXP HSMライブラリを利用しようとしますが、明示的にdev IDに設定すると、WOLFSSL_SECO_DEVIDを使用できます。

wc_InitSha256_ex(sha256, heap-hint, WOLFSSL_SECO_DEVID);
wc_InitSha384_ex(sha384, heap-hint, WOLFSSL_SECO_DEVID);

NXP HSMライブラリはハッシュのシングルショット操作をサポートしているため、"update"を呼び出すたびに"final"関数が呼び出されるまでバッファが保存され、その後ハッシュダイジェストを作成するためにバッファ全体がハードウェアに渡されます。 HMACが cryptodev-linuxを使用する場合、Hmac構造体はdev ID WOLFSSL_CAAM_DEVID を使用して初期化する必要があります。

wc_HmacInit(hmac, heap-hint, WOLFSSL_CAAM_DEVID);

その後、通常のネイティブwolfSSL APIと同じように使用できます：

wc_HmacSetKey(hmac, hash-type, key, keySz);
wc_HmacUpdate(hmac, input, inputSz);
wc_HmacFinal(hmac, digestOut);
Curve25519

Curve25519ポイント乗算は、cryptodev-linuxモジュールを使用して行われ、ハードウェアで使用するためにdev ID WOLFSSL_CAAM_DEVIDで初期化する必要があります。

API 呼び出しの例は次のようになります:

wc_curve25519_init_ex(key, heap-hint, WOLFSSL_CAAM_DEVID);
wc_curve25519_make_key(&rng, CURVE25519_KEYSIZE,  key);
wc_curve25519_shared_secret(key, keyB, sharedSecretOut, sharedSecretOutSz);
RNG

wolfSSL HASH-DRBGに乱数シードを与えるために使われるTRNGでは、NXP HSMライブラリを利用します。これは、wolfSSL が --enable-caam=seco でビルドされるときに、wolfcrypt/src/random.c ファイルにコンパイルされます。 wolfSSLのすべてのRNG初期化では、シードにTRNGが使用されます。標準のRNG API呼び出しは次のようになります:

wc_InitRng(rng);
wc_RNG_GenerateBlock(rng, output, outputSz);
wc_FreeRng(rng);

i.MX8 (QNX)

i.MX6 (QNX)

IMXRT1170 (FreeRTOS)

IMXRT1170で使用するIDEセットアップの例は、IDE/MCUEXPRESSO/RT117 ディレクトリにあります。

ビルド手順

  • MCUEXPRESSOを開き、ワークスペースをwolfssl/IDE/MCUEXPRESSO/RT1170に設定します。
  • ファイル -> ファイル システムからプロジェクトを開く... -> ディレクトリ : 参照先を wolfssl/IDE/MCUEXPRESSO/RT1170 ディレクトリに設定し、「ディレクトリの選択」をクリックします。
  • wolfssl_cm7、wolfcrypt_test_cm7、CSR_example、PKCS7_exampleを選択します
  • プロジェクトを右クリック -> SDK 管理 -> SDK コンポーネントを更新し、「はい」をクリックします。
  • FreeRTOSConfig.h の configTOTAL_HEAP_SIZE のサイズを、CSR および PKCS7 の例では 60240、wolfcrypt_test_cm7 では約 100000 に増やします。
  • (ノートボードファイルを再作成する必要があります。これは、同じ設定を持つ新しいプロジェクトを作成し、生成されたboard/*ファイルをコピーすることで実行できます)
  • プロジェクトをビルドする

RT1170 CAAM ドライバーを拡張

ファイルRT1170/fsl_caam_h.patchおよびRT1170/fsl_caam_c.patchには、Blobの作成/オープン、および ECC ブラックキーの生成と使用のための既存のNXP CAAMドライバーへの変更が含まれています。

パッチを適用するには、まずcaamドライバーを含むプロジェクトを作成します。これにより、ドライバーディレクトリにベースとなるfsl_caam.cとfsl_caam.hが生成されます(つまり、PKCS7_example_cm7/drivers/fls_caam.{c,h}) 。 基本ファイルが生成されたら、ドライバー ディレクトリに"cd"してパッチを適用します：

cd PKCS7_example_cm7/drivers/
patch -p1 < ../../fsl_caam_c.patch
patch -p1 < ../../fsl_caam_h.patch

fsl_caam.hのパッチには、ECCとBlobの両方に定義されたマクロがあります。 拡張 (CAAM_ECC_EXPANSION および CAAM_BLOB_EXPANSION)。 wolfSSL コードが見つかったとき これらのマクロが定義されている (パッチが適用されている) ことを確認してから、 拡張されたドライバーを使用してコンパイルします。