Merge pull request #6665 from TakayukiMatsuo/jp6472

Update Japanese API comments

doc/dox_comments/header_files-ja/rsa.h

@@ -1,6 +1,6 @@
 /*!
     \ingroup RSA
-    \brief  この関数は提供されたRSAKEY構造体を初期化します。また、ユーザー定義メモリオーバーライドで使用するためのヒープ識別子も取ります（XMALLOC、XFREE、XREALLOCを参照）。wc_rsa_blindingが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。
+    \brief  この関数は提供されたRsaKey構造体を初期化します。また、ユーザー定義メモリオーバーライドで使用するためのヒープ識別子も取ります（XMALLOC、XFREE、XREALLOCを参照）。wc_rsa_blindingが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。
     \return 0  暗号化と復号化で使用するためのRSA構造の初期化に成功したときに返されます。
     \return BAD_FUNC_ARGS  RSAキーポインタがNULLに評価された場合に返されます
     \param key  初期化するRSAKEY構造へのポインタ
@@ -21,11 +21,11 @@ int  wc_InitRsaKey(RsaKey* key, void* heap);
 
 /*!
     \ingroup RSA
-    \brief  この関数は提供されたRSAKEY構造体を初期化します。IDとLENは、DEVIDがデバイスを識別している間にデバイス上のキーを識別するために使用されます。また、ユーザー定義メモリオーバーライドで使用するためのヒープ識別子も取ります（XMALLOC、XFREE、XREALLOCを参照）。wc_rsa_blindingが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。
+    \brief  この関数は提供されたRsaKey構造体を初期化します。IDとLENは、DEVIDがデバイスを識別している間にデバイス上のキーを識別するために使用されます。また、ユーザー定義メモリオーバーライドで使用するためのヒープ識別子も取ります（XMALLOC、XFREE、XREALLOCを参照）。wc_rsa_blindingが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。
     \return 0  暗号化と復号化で使用するためのRSA構造の初期化に成功したときに返されます。
     \return BAD_FUNC_ARGS  RSAキーポインタがNULLに評価された場合に返されます
     \return BUFFER_E  LENがRSA_MAX_ID_LENよりも小さい場合、または大きい場合は返されます。
-    \param key  初期化するRSAKEY構造へのポインタ
+    \param key  初期化するRsaKey構造体へのポインタ
     \param id  デバイス上のキーの識別子
     \param len  バイト数の識別子の長さ
     \param heap  メモリオーバーライドで使用するためのヒープ識別子へのポインタ。メモリ割り当てのカスタム処理を可能にします。このヒープは、このRSAオブジェクトで使用するためにメモリを割り当てるときに使用されるデフォルトになります。
@@ -59,7 +59,7 @@ int  wc_InitRsaKey_Id(RsaKey* key, unsigned char* id, int len,
     \brief  この関数はRNGをキーに関連付けます。WC_RSA_BLINDINGが有効になっている場合は必要です。
     \return 0  成功に戻った
     \return BAD_FUNC_ARGS  RSAキーの場合、RNGポインタがNULLに評価された場合
-    \param key  関連付けられるRSAKEY構造へのポインタ
+    \param key  関連付けられるRsaKey構造体へのポインタ
     _Example_
     \code
     ret = wc_InitRsaKey(&key, NULL);
@@ -76,7 +76,7 @@ int wc_RsaSetRNG(RsaKey* key, WC_RNG* rng);
 
 /*!
     \ingroup RSA
-    \brief  この関数は、MP_Clearを使用して提供されたRSAKEY構造体を解放します。
+    \brief  この関数は、MP_Clearを使用して提供されたRsaKey構造体を解放します。
     \return 0  キーの解放に成功したら返品されます
     _Example_
     \code
@@ -113,7 +113,7 @@ int  wc_FreeRsaKey(RsaKey* key);
     \param inLen  暗号化するメッセージの長さ
     \param out  出力暗号文を保存するバッファへのポインタ
     \param outLen  出力バッファの長さ
-    \param key  暗号化に使用する公開鍵を含むRSAKEY構造体へのポインタ
+    \param key  暗号化に使用する公開鍵を含むRsaKey構造体へのポインタ
     _Example_
     \code
     RsaKey pub;
@@ -311,13 +311,14 @@ int  wc_RsaPSS_Sign(const byte* in, word32 inLen, byte* out,
 
 /*!
     \ingroup RSA
-    \brief  入力署名を復号化して、メッセージがキーによって署名されたことを確認します。wc_rsa_blindingが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。
-    \return Success  エラーのないテキストの長さ。
+    \brief  入力署名を復号して、メッセージが鍵によって署名されたことを確認します。WC_RSA_BLINDINGが有効な場合、鍵はwc_RsaSetRNGによってRNGに関連付けられなければなりません。
+    \return Success  エラーのない場合はテキストの長さを返します
     \return MEMORY_E  メモリ例外
-    \param in  復号化されるバイト配列。
-    \param inLen  の長さ
-    \param out  格納する復号化データのバイト配列。
-    \param outLen  の長さ
+    \return MP_EXPTMOD_E - fastmathを使用する様に構成されている場合にFP_MAX_BITSが鍵サイズの少なくとも2倍に設定されていない(例えば4096-bit長の鍵を使用する場合にはFP_MAX_BITSは8192以上に設定すること)。
+    \param in  復号される署名データが格納されているバッファ
+    \param inLen  署名データの長さ
+    \param out  復号データの出力先バッファ
+    \param outLen  出力先バッファサイズ
     \param hash  メッセージに入るハッシュ型
     \param mgf  マスク生成機能識別子
     _Example_
@@ -357,7 +358,7 @@ int  wc_RsaPSS_Verify(byte* in, word32 inLen, byte* out,
 
 /*!
     \ingroup RSA
-    \brief  入力署名を復号化して、メッセージがRSAキーによって署名されたことを確認します。出力は入力と同じバイト配列を使用します。wc_rsa_blindingが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。
+    \brief  入力署名を復号化して、メッセージがRSAキーによって署名されたことを確認します。出力は入力と同じバイト配列を使用します。WC_RSA_BLINDINGが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。
     \return >0  テキストの長さ
     \return <0  エラーが発生しました。
     \param in  復号化されるバイト配列。
@@ -407,7 +408,7 @@ int  wc_RsaPSS_VerifyInline(byte* in, word32 inLen, byte** out,
                                         RsaKey* key);
 /*!
     \ingroup RSA
-    \brief  RSA-PSSで署名されたメッセージを確認してください。塩の長さはハッシュ長に等しい。wc_rsa_blindingが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。
+    \brief  RSA-PSSで署名されたメッセージを確認してください。塩の長さはハッシュ長に等しい。WC_RSA_BLINDINGが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。
     \return the  PSSデータの長さが成功し、負に障害が発生します。
     \return MEMORY_E  メモリ例外
     \param in  復号化されるバイト配列。
@@ -469,7 +470,7 @@ int  wc_RsaPSS_VerifyCheck(byte* in, word32 inLen,
                                RsaKey* key);
 /*!
     \ingroup RSA
-    \brief  RSA-PSSで署名されたメッセージを確認してください。wc_rsa_blindingが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。
+    \brief  RSA-PSSで署名されたメッセージを確認してください。WC_RSA_BLINDINGが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。
     \return the  PSSデータの長さが成功し、負に障害が発生します。
     \return MEMORY_E  メモリ例外
     \param in  復号化されるバイト配列。
@@ -532,7 +533,7 @@ int  wc_RsaPSS_VerifyCheck_ex(byte* in, word32 inLen,
 
 /*!
     \ingroup RSA
-    \brief  RSA-PSSで署名されたメッセージを確認してください。入力バッファは出力バッファに再利用されます。塩の長さはハッシュ長に等しい。wc_rsa_blindingが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。
+    \brief  RSA-PSSで署名されたメッセージを確認してください。入力バッファは出力バッファに再利用されます。塩の長さはハッシュ長に等しい。WC_RSA_BLINDINGが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。
     \return the  PSSデータの長さが成功し、負に障害が発生します。
     \param in  復号化されるバイト配列。
     \param inLen  の長さ
@@ -590,7 +591,7 @@ int  wc_RsaPSS_VerifyCheckInline(byte* in, word32 inLen, byte** out,
                                RsaKey* key);
 /*!
     \ingroup RSA
-    \brief  RSA-PSSで署名されたメッセージを確認してください。入力バッファは出力バッファに再利用されます。wc_rsa_blindingが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。
+    \brief  RSA-PSSで署名されたメッセージを確認してください。入力バッファは出力バッファに再利用されます。WC_RSA_BLINDINGが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。
     \return the  PSSデータの長さが成功し、負に障害が発生します。
     \param in  復号化されるバイト配列。
     \param inLen  の長さ
@@ -650,7 +651,7 @@ int  wc_RsaPSS_VerifyCheckInline_ex(byte* in, word32 inLen, byte** out,
 
 /*!
     \ingroup RSA
-    \brief  PSSデータを確認して、署名が一致するようにします。塩の長さはハッシュ長に等しい。wc_rsa_blindingが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。
+    \brief  PSSデータを確認して、署名が一致するようにします。塩の長さはハッシュ長に等しい。WC_RSA_BLINDINGが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。
     \return BAD_PADDING_E  PSSデータが無効な場合、NULLがINまたはSIGまたはINSZに渡されると、BAD_FUNC_ARGはハッシュアルゴリズムの長さと同じではありません。
     \return MEMORY_E  メモリ例外
     \param in  検証中のデータのハッシュ。
@@ -798,7 +799,7 @@ int  wc_RsaPrivateKeyDecode(const byte* input, word32* inOutIdx,
 
 /*!
     \ingroup RSA
-    \brief  この関数はDerフォーマットのRSA公開鍵を解析し、公開鍵を抽出し、それを指定されたResakey構造に格納します。IDXに解析された距離も設定します。
+    \brief  この関数はDerフォーマットのRSA公開鍵を解析し、公開鍵を抽出し、それを指定されたRsaKey構造体に格納します。IDXに解析された距離も設定します。
     \return 0  DERエンコード入力から公開鍵の解析に成功したときに返された
     \return ASN_PARSE_E  入力バッファから公開鍵を解析したエラーがある場合に返されます。これは、入力公開鍵がASN.1規格に従って正しくフォーマットされていない場合に発生する可能性があります。
     \return ASN_OBJECT_ID_E  ASN.1オブジェクトIDがRSA公開鍵のそれと一致しない場合に返されます。
@@ -807,7 +808,7 @@ int  wc_RsaPrivateKeyDecode(const byte* input, word32* inOutIdx,
     \return ASN_RSA_KEY_E  RSAキー入力の公開鍵要素を読み取るエラーがある場合
     \param input  復号する入力DERエンコードRSA公開鍵を含むバッファへのポインタ
     \param inOutIdx  キーが始まるバッファ内のインデックスへのポインタ（通常は0）。この関数の副作用として、InoutIDXは入力バッファを介して解析された距離を記憶します
-    \param key  デコードされた公開鍵を保存するRSAKEY構造体へのポインタ
+    \param key  デコードされた公開鍵を保存するRsaKey構造体へのポインタ
     _Example_
     \code
     RsaKey pub;
@@ -828,8 +829,8 @@ int  wc_RsaPublicKeyDecode(const byte* input, word32* inOutIdx,
 
 /*!
     \ingroup RSA
-    \brief  この関数は、公開弾性率（n）と指数（e）を撮影して、RSA公開鍵の生の要素を復号します。これらの生の要素を提供されたRSAKEY構造体に格納し、暗号化/復号化プロセスで使用することができます。
-    \return 0  公開鍵の生の要素をRSAKEY構造に復号したときに返された
+    \brief  この関数は、公開弾性率（n）と指数（e）を撮影して、RSA公開鍵の生の要素を復号します。これらの生の要素を提供されたRsaKey構造体に格納し、暗号化/復号化プロセスで使用することができます。
+    \return 0  公開鍵の生の要素をRsaKey構造体に復号したときに返された
     \return BAD_FUNC_ARG  いずれかの入力引数がNULLに評価された場合に返されます。
     \return MP_INIT_E  複数の精密整数（MP_INT）ライブラリで使用するための整数の初期化中にエラーがある場合
     \return ASN_GETINT_E  提供されたRSAキー要素、nまたはeのいずれかを読むエラーがある場合に返されます
@@ -861,7 +862,7 @@ int  wc_RsaPublicKeyDecodeRaw(const byte* n, word32 nSz,
     \return 0  成功
     \return BAD_FUNC_ARG  キーまたは出力がNULLの場合、またはキー - >タイプがRSA_PRIVATEでない場合、またはINLENが出力バッファに十分な大きさでない場合は返されます。
     \return MEMORY_E  メモリの割り当て中にエラーが発生した場合に返されます。
-    \param key  初期化されたRSAKEY構造
+    \param key  初期化されたRsaKey構造体
     \param output  出力バッファへのポインタ。
     _Example_
     \code
@@ -896,7 +897,7 @@ int wc_RsaKeyToDer(RsaKey* key, byte* output, word32 inLen);
     \param inLen  暗号化するバッファの長さ
     \param out  暗号化されたMSGが作成されました
     \param outLen  暗号化されたMSGを保持するために利用可能なバッファの長さ
-    \param key  初期化RSAキー構造体
+    \param key  初期化ずみRsaKey構造体
     \param rng  初期化されたWC_RNG構造体
     \param type  使用するパディングの種類（WC_RSA_OAEP_PADまたはWC_RSA_PKCSV15_PAD）
     \param hash  使用するハッシュの種類（選択はhash.hにあります）
@@ -934,7 +935,7 @@ int  wc_RsaPublicEncrypt_ex(const byte* in, word32 inLen, byte* out,
     \param inLen  復号化するバッファの長さ
     \param out  復号化されたMSGが作成されました
     \param outLen  復号化されたMSGを保持するために利用可能なバッファの長さ
-    \param key  初期化RSAキー構造体
+    \param key  初期化ずみRsaKey構造体
     \param type  使用するパディングの種類（WC_RSA_OAEP_PADまたはWC_RSA_PKCSV15_PAD）
     \param hash  使用するハッシュの種類（選択はhash.hにあります）
     \param mgf  使用するマスク生成機能の種類
@@ -978,7 +979,7 @@ int  wc_RsaPrivateDecrypt_ex(const byte* in, word32 inLen,
     \param in  復号化のためのバッファへのポインタ
     \param inLen  復号化するバッファの長さ
     \param out  "in"バッファの復号化されたメッセージの位置へのポインタ
-    \param key  初期化RSAキー構造体
+    \param key  初期化ずみRsaKey構造体
     \param type  使用するパディングの種類（WC_RSA_OAEP_PADまたはWC_RSA_PKCSV15_PAD）
     \param hash  使用するハッシュの種類（選択はhash.hにあります）
     \param mgf  使用するマスク生成機能の種類
@@ -1014,7 +1015,7 @@ int  wc_RsaPrivateDecryptInline_ex(byte* in, word32 inLen,
 
 /*!
     \ingroup RSA
-    \brief  RSAアルゴリズムに使用される個々の要素（E、N）にRSAKEY構造体を平らにします。
+    \brief  RSAアルゴリズムに使用されるRsaKey構造体の個々の要素（E、N）をバッファに取り出します。
     \return 0  関数が正常に実行された場合は、エラーなしで返されます。
     \return BAD_FUNC_ARG:  いずれかのパラメータがNULL値で渡された場合に返されます。
     \return RSA_BUFFER_E:  渡されたeまたはnバッファが正しいサイズではない場合に返されます。
@@ -1052,7 +1053,7 @@ int  wc_RsaFlattenPublicKey(RsaKey* key, byte* e, word32* eSz, byte* n,
     \return BAD_FUNC_ARG  キーまたは出力がNULLの場合に返されます。
     \return MEMORY_E  エラー割り当てメモリが発生したときに返されます。
     \return <0  エラー
-    \param key  変換するRSAキー構造。
+    \param key  変換するRsaKey構造体。
     \param output  保留された出力バッファー。（NULLが長さのみを返す場合）
     _Example_
     \code
@@ -1080,7 +1081,7 @@ int wc_RsaKeyToPublicDer(RsaKey* key, byte* output, word32 inLen);
     \return BAD_FUNC_ARG  キーまたは出力がNULLの場合に返されます。
     \return MEMORY_E  エラー割り当てメモリが発生したときに返されます。
     \return <0  エラー
-    \param key  変換するRSAキー構造。
+    \param key  変換するRsaKey構造体。
     \param output  保留された出力バッファー。（NULLが長さのみを返す場合）
     _Example_
     \code
@@ -1104,7 +1105,7 @@ int wc_RsaKeyToPublicDer_ex(RsaKey* key, byte* output, word32 inLen,
 
 /*!
     \ingroup RSA
-    \brief  この関数は、長さサイズ（ビット単位）のRSA秘密鍵を生成し、指数（e）を指定します。次に、このキーを提供されたRSAKEY構造体に格納するため、暗号化/復号化に使用できます。Eに使用するセキュア番号は65537です。サイズは、RSA_MIN_SIZEよりも大きく、RSA_MAX_SIZEよりも大きくなる必要があります。この機能が利用可能であるため、コンパイル時にオプションwolfssl_key_genを有効にする必要があります。これは、 - を使用してください./configureを使用する場合は、-enable-keygenで実現できます。
+    \brief  この関数は、長さサイズ（ビット単位）のRSA秘密鍵を生成し、指数（e）を指定します。次に、このキーを提供されたRsaKey構造体に格納するため、暗号化/復号化に使用できます。Eに使用するセキュア番号は65537です。サイズは、RSA_MIN_SIZEよりも大きく、RSA_MAX_SIZEよりも大きくなる必要があります。この機能が利用可能であるため、コンパイル時にオプションwolfssl_key_genを有効にする必要があります。これは、 - を使用してください./configureを使用する場合は、-enable-keygenで実現できます。
     \return 0  RSA秘密鍵の生成に成功したら返されました
     \return BAD_FUNC_ARG  入力引数のいずれかがNULLの場合、サイズパラメータは必要な範囲外にあるか、eが誤って選択されている場合
     \return RNG_FAILURE_E  提供されたRNG構造体を使用してランダムブロックを生成するエラーがある場合
@@ -1183,7 +1184,7 @@ int wc_RsaSetNonBlock(RsaKey* key, RsaNb* nb);
     \brief  この関数は最大ブロック時間の最大ブロック時間をマイクロ秒単位で設定します。それは、メガヘルツのCPU速度と共に事前計算されたテーブル（TFM.cexptModnbinstを参照）を使用して、提供された最大ブロック時間内に次の動作を完了できるかどうかを判断します。wc_rsa_nonblock_timeが定義されているときに有効になります。
     \return 0  成功
     \return BAD_FUNC_ARG  キーがNULLの場合、またはWC_RSASETNONBLOCKが以前に呼び出され、キー - > NBはNULLの場合に返されます。
-    \param key  RSAキー構造
+    \param key  RsaKey構造体
     \param maxBlockUs  マイクロ秒をブロックする最大時間。
     _Example_
     \code