ロギング

wolfEngine は、情報提供とデバッグを目的としたログメッセージの出力をサポートしています。デバッグロギングを有効にするには、最初にデバッグサポートを有効にして wolfEngine をコンパイルする必要があります。 Autoconf を使用している場合、これは ./configure に --enable-debug オプションを使用して行われます：

./configure --enable-debug

Autoconf/configure を使用しない場合は、wolfEngine ライブラリをコンパイルするときに WOLFENGINE_DEBUG を定義します。

デバッグログの有効化/無効化

デバッグサポートがライブラリにコンパイルされたら、セクション 5 で指定された wolfEngine コントロールコマンドを使用して実行時にデバッグを有効にする必要があります。 0" を指定すると、ロギングが無効になります。 ENGINE_ctrl_cmd() API を使用してロギングを有効にするには:

int ret = 0;
ret = ENGINE_ctrl_cmd(e, “enable_debug”, 1, NULL, NULL, 0);
if (ret != 1) {
    printf(“Failed to enable debug logging\n”);
}

wolfEngine がデバッグサポートを有効にしてコンパイルされていない場合、ENGINE_ctrl_cmd() で enable_debug を設定しようとすると失敗 (0) が返されます。

ロギングレベルの制御

wolfEngine は以下のロギングレベルをサポートします。これらは、"include/wolfengine/we_logging.h"ヘッダーファイルで、wolfEngine_LogType enum の一部として定義されています:

ロギングレベル	意味	レベル値
WE_LOG_ERROR	エラーをロギングする	0x0001
WE_LOG_ENTER	関数に入った際にロギングする	0x0002
WE_LOG_LEAVE	関数を抜ける際にロギングする	0x0004
WE_LOG_INFO	情報提供のメッセージをロギングする	0x0008
WE_LOG_VERBOSE	暗号化/復号のデータを含めた詳細ログ	0x0010
WE_LOG_LEVEL_DEFAULT	デフォルトのログレベル（VERBOS以外を全て含む）	WE_LOG_ERROR \| WE_LOG_ENTER \| WE_LOG_LEAVE \| WE_LOG_INFO
WE_LOG_LEVEL_ALL WE_LOG_ERROR	全ログレベルが有効	WE_LOG_ENTER \| WE_LOG_LEAVE \| WE_LOG_INFO \| WE_LOG_VERBOSE

デフォルトの wolfEngine ロギングレベルには、"WE_LOG_ERROR"、"WE_LOG_ENTER"、"WE_LOG_LEAVE"、および"WE_LOG_INFO"が含まれます。これには、詳細ログ (WE_LOG_VERBOSE) を除くすべてのログレベルが含まれます。

ログレベルは、ENGINE_ctrl_cmd() API または OpenSSL 構成ファイル設定のいずれかを介して、実行時に"log_level"エンジン制御コマンドを使用して制御できます。たとえば、"log_level"制御コマンドを使用してエラーログと情報ログのみを有効にするには、アプリケーションで次のように呼び出します:

#include <wolfengine/we_logging.h>

ret = ENGINE_ctrl_cmd(e, “log_level”, WE_LOG_ERROR | WE_LOG_INFO,
NULL, NULL, 0);
if (ret != 1) {
    printf(“Failed to set logging level\n”);
}

コンポーネント単位のロギングの制御

wolfEngine では、コンポーネントごとにログを記録できます。コンポーネントは include/wolfengine/we_logging.h の wolfEngine_LogComponents 列挙で定義されます:

ログ対象コンポーネント	意味	コンポーネントを示す値
WE_LOG_RNG	ランダム数生成コンポーネント	0x0001
WE_LOG_DIGEST	ダイジェストコンポーネント (SHA-1/2/3)	0x0002
WE_LOG_MAC	MAC機能コンポーネント (HMAC, CMAC)	0x0004
WE_LOG_CIPHER	暗号化コンポーネント(AES, 3DES)	0x0008
WE_LOG_PK	公開鍵コンポーネント (RSA, ECC)	0x0010
WE_LOG_KE	鍵合意コンポーネント (DH, ECDH)	0x0020
WE_LOG_ENGINE	エンジン特有	0x0040
WE_LOG_COMPONENTS_ALL	全コンポーネント	WE_LOG_RNG \| WE_LOG_DIGEST \| WE_LOG_MAC \| WE_LOG_CIPHER \| WE_LOG_PK \| WE_LOG_KE \| WE_LOG_ENGINE
WE_LOG_COMPONENTS_DEFAULT	デフォルトコンポーネント (all).	WE_LOG_COMPONENTS_ALL

デフォルトの wolfEngine ロギング構成は、すべてのコンポーネントをログに記録します (WE_LOG_COMPONENTS_DEFAULT)。

ログに記録されたコンポーネントは、ENGINE_ctrl_cmd() API または OpenSSL 構成ファイル設定のいずれかを介して、実行時に"log_components"エンジン制御コマンドを使用して制御できます。たとえば、Digest および Cipher アルゴリズムのロギングのみをオンにするには、次のようにします：

#include <wolfengine/we_logging.h>

ret = ENGINE_ctrl_cmd(e, “log_components”, WE_LOG_DIGEST | WE_LOG_CIPHER,
NULL, NULL, 0);
if (ret != 1) {
    printf(“Failed to set log components\n”);
}

カスタムロギングコールバックの設定

デフォルトでは、wolfEngine は fprintf() を使用してデバッグログメッセージを stderr に出力します。

ログメッセージの出力方法や出力場所をより詳細に制御したいアプリケーションは、カスタムロギングコールバックを記述して wolfEngine に登録できます。ロギングコールバックは、include/wolfengine/we_logging.h の wolfEngine_Logging_cb のプロトタイプと一致する必要があります:

/**
* wolfEngine logging callback.
* logLevel - [IN] - Log level of message
* component - [IN] - Component that log message is coming from
* logMessage - [IN] - Log message
*/
typedef void (*wolfEngine_Logging_cb)(const int logLevel, const int component, const char *const logMessage);

その後、"set_logging_cb"エンジン制御コマンドを使用して、コールバックを wolfEngine に登録できます。たとえば、ENGINE_ctrl_cmd() API を使用してカスタムロギングコールバックを設定するには、次のようにします:

void customLogCallback(const int logLevel, const int component,
const char* const logMessage)
{
    (void)logLevel;
    (void)component;
    fprintf(stderr, “wolfEngine log message: %d\n”, logMessage);
}

int **main** (void)
{
    int ret;
    ENGINE* e;
...
    ret = ENGINE_ctrl_cmd(e, “set_logging_cb”, 0, NULL, (void(*)(void))my_Logging_cb, 0);
    if (ret != 1) {
        /* failed to set logging callback */
    }
...
}