Skip to content

Commit 8368a32

Browse files
committed
clarify description
1 parent 00e4215 commit 8368a32

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

doc/dox_comments/header_files-ja/hmac.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
\brief この関数はHMACオブジェクトを初期化し、その暗号化タイプ、キー、およびHMACの長さを設定します。
44
\return 0 HMACオブジェクトの初期化に成功しました
55
\return BAD_FUNC_ARG 入力タイプが無効な場合は返されます。有効なオプションは次のとおりです.MD5、SHA、SHA256、SHA384、SHA3-224、SHA3-256、SHA3-384、SHA3-512
6-
\return MEMORY_E ハッシュに使用する構造体の割り当てメモリの割り当てがある場合
7-
\return HMAC_MIN_KEYLEN_E FIPS実装を使用するときに返されることがあり、指定されたキー長は最小許容FIPS規格よりも短いです。
6+
\return MEMORY_E ハッシュに使用する構造体の割り当てメモリの割り当てエラーがある場合
7+
\return HMAC_MIN_KEYLEN_E FIPS実装を使用するときに、指定されたキーがFIPS規格の最小許容(14バイト)よりも短い
88
\param hmac 初期化するHMACオブジェクトへのポインタ
99
\param type HMACオブジェクトを使用する暗号化方式を指定します。有効なオプションは次のとおりです.MD5、SHA、SHA256、SHA384、SHA3-224、SHA3-256、SHA3-384、SHA3-512
1010
\param key HMACオブジェクトを初期化するキーを含むバッファへのポインタ
@@ -13,7 +13,7 @@
1313
Hmac hmac;
1414
byte key[] = { // initialize with key to use for encryption };
1515
if (wc_HmacSetKey(&hmac, MD5, key, sizeof(key)) != 0) {
16-
// error initializing Hmac object
16+
// error initializing Hmac object
1717
}
1818
\endcode
1919
\sa wc_HmacUpdate
@@ -25,7 +25,7 @@ int wc_HmacSetKey(Hmac* hmac, int type, const byte* key, word32 keySz);
2525
\ingroup HMAC
2626
\brief この関数は、HMACを使用して認証するメッセージを更新します。HMACオブジェクトがWC_HMACSETKEYで初期化された後に呼び出されるべきです。この関数は、ハッシュへのメッセージを更新するために複数回呼び出されることがあります。必要に応じてwc_hmacupdateを呼び出した後、最終認証済みメッセージタグを取得するためにwc_hmacfinalを呼び出す必要があります。
2727
\return 0 認証するメッセージの更新に成功しました
28-
\return MEMORY_E ハッシュアルゴリズムで使用するためにメモリを割り当てるエラーがある場合
28+
\return MEMORY_E ハッシュアルゴリズムで使用するためのメモリ割り当てエラーがある場合
2929
\param hmac メッセージを更新するHMACオブジェクトへのポインタ
3030
\param msg 追加するメッセージを含むバッファへのポインタ
3131
_Example_

doc/dox_comments/header_files/hmac.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
\return BAD_FUNC_ARG Returned if the input type is invalid (see type param)
99
\return MEMORY_E Returned if there is an error allocating memory for the
1010
structure to use for hashing
11-
\return HMAC_MIN_KEYLEN_E May be returned when using a FIPS implementation
11+
\return HMAC_MIN_KEYLEN_E Returned when using a FIPS implementation
1212
and the key length specified is shorter than the minimum acceptable
13-
FIPS standard
13+
FIPS standard of 14 bytes
1414
1515
\param hmac pointer to the Hmac object to initialize
1616
\param type type specifying which encryption method the Hmac object

0 commit comments

Comments
 (0)