diff --git a/doc/dox_comments/header_files-ja/cmac.h b/doc/dox_comments/header_files-ja/cmac.h index 95612f6c2..6dc1dc9d6 100644 --- a/doc/dox_comments/header_files-ja/cmac.h +++ b/doc/dox_comments/header_files-ja/cmac.h @@ -23,6 +23,8 @@ \sa wc_InitCmac_ex \sa wc_CmacUpdate \sa wc_CmacFinal + \sa wc_CmacFinalNoFree + \sa wc_CmacFree */ int wc_InitCmac(Cmac* cmac, const byte* key、word32 keySz、 @@ -55,6 +57,8 @@ int wc_InitCmac(Cmac* cmac, \sa wc_InitCmac_ex \sa wc_CmacUpdate \sa wc_CmacFinal + \sa wc_CmacFinalNoFree + \sa wc_CmacFree */ int wc_InitCmac_ex(Cmac* cmac, const byte* key, word32 keySz, @@ -75,17 +79,40 @@ int wc_InitCmac_ex(Cmac* cmac, \sa wc_InitCmac \sa wc_CmacFinal + \sa wc_CmacFinalNoFree + \sa wc_CmacFree */ int wc_CmacUpdate(Cmac* cmac, const byte* in, word32 inSz); +/*! + \ingroup CMAC + \brief 暗号ベースのメッセージ認証コードの最終結果を生成します。ただし、使用したコンテキストのクリーンアップは行いません。 + \return 成功したら0を返します + \param cmac Cmac構造体へのポインタ + \param out 結果を格納するバッファへのポインタ + \param outSz 結果出力先バッファのサイズ + + _Example_ + \code + ret = wc_CmacFinalNoFree(cmac, out, &outSz); + (void)wc_CmacFree(cmac); + \endcode + + \sa wc_InitCmac + \sa wc_CmacFinal + \sa wc_CmacFinalNoFree + \sa wc_CmacFree +*/ +int wc_CmacFinalNoFree(Cmac* cmac, + byte* out, word32* outSz); /*! \ingroup CMAC - \brief 暗号ベースのメッセージ認証コードを使用して最終結果を生成します + \brief 暗号ベースのメッセージ認証コードを使用して最終結果を生成します。加えて、内部でwc_CmacFreeを呼び出してコンテキスとをクリーンアップします。 \return 成功したら0を返します \param cmac Cmac構造体へのポインタ - \param out 結果の出力先バッファへのポインタ - \param outSz 結果の出力先バッファサイズ (in/out) + \param out 結果を格納するバッファへのポインタ + \param outSz 結果出力先バッファのサイズ _例_ \code @@ -94,10 +121,31 @@ int wc_CmacUpdate(Cmac* cmac, \sa wc_InitCmac \sa wc_CmacFinal + \sa wc_CmacFinalNoFree + \sa wc_CmacFree */ int wc_CmacFinal(Cmac* cmac, byte* out, word32* outSz); +/*! + \ingroup CMAC + \brief CMAC処理中にCmac構造体内に確保されたオブジェクトを開放します。 + \return 成功したら0を返します + \param cmac Cmac構造体へのポインタ + + _Example_ + \code + ret = wc_CmacFinalNoFree(cmac, out, &outSz); + (void)wc_CmacFree(cmac); + \endcode + + \sa wc_InitCmac + \sa wc_CmacFinalNoFree + \sa wc_CmacFinal + \sa wc_CmacFree +*/ +int wc_CmacFree(Cmac* cmac); + /*! \ingroup CMAC \brief CMACを生成するためのシングルショット関数 diff --git a/doc/dox_comments/header_files-ja/doxygen_groups.h b/doc/dox_comments/header_files-ja/doxygen_groups.h index 0571fedaf..e3009c31f 100644 --- a/doc/dox_comments/header_files-ja/doxygen_groups.h +++ b/doc/dox_comments/header_files-ja/doxygen_groups.h @@ -6,6 +6,7 @@ \defgroup Camellia Algorithms - Camellia \defgroup ChaCha Algorithms - ChaCha \defgroup ChaCha20Poly1305 Algorithms - ChaCha20_Poly1305 +  \defgroup CMAC Algorithm - CMAC \defgroup Crypto Callbacks - CryptoCb \defgroup Curve25519 Algorithms - Curve25519 \defgroup Curve448 Algorithms - Curve448 diff --git a/doc/dox_comments/header_files-ja/doxygen_pages.h b/doc/dox_comments/header_files-ja/doxygen_pages.h index 39065f819..56b9025e0 100644 --- a/doc/dox_comments/header_files-ja/doxygen_pages.h +++ b/doc/dox_comments/header_files-ja/doxygen_pages.h @@ -34,6 +34,7 @@
  • \ref Camellia
  • \ref ChaCha
  • \ref ChaCha20Poly1305
  • +
  • \ref CMAC
  • \ref Crypto Callbacks
  • \ref Curve25519
  • \ref Curve448
  • diff --git a/doc/dox_comments/header_files/cmac.h b/doc/dox_comments/header_files/cmac.h index 58ea35ea4..7f3ebffdc 100644 --- a/doc/dox_comments/header_files/cmac.h +++ b/doc/dox_comments/header_files/cmac.h @@ -126,7 +126,8 @@ int wc_CmacFinalNoFree(Cmac* cmac, \sa wc_CmacFinalNoFree \sa wc_CmacFree */ -int wc_CmacFinalNoFree(Cmac* cmac); +int wc_CmacFinal(Cmac* cmac, + byte* out, word32* outSz); /*! \ingroup CMAC