Merge pull request #6665 from TakayukiMatsuo/jp6472

Update Japanese API comments
This commit is contained in:
Hideki Miyazaki
2023-08-04 14:37:33 +09:00
committed by GitHub

View File

@ -1,6 +1,6 @@
/*! /*!
\ingroup RSA \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 0 暗号化と復号化で使用するためのRSA構造の初期化に成功したときに返されます。
\return BAD_FUNC_ARGS RSAキーポインタがNULLに評価された場合に返されます \return BAD_FUNC_ARGS RSAキーポインタがNULLに評価された場合に返されます
\param key 初期化するRSAKEY構造へのポインタ \param key 初期化するRSAKEY構造へのポインタ
@ -20,12 +20,12 @@
int wc_InitRsaKey(RsaKey* key, void* heap); int wc_InitRsaKey(RsaKey* key, void* heap);
/*! /*!
\ingroup RSA \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 0 暗号化と復号化で使用するためのRSA構造の初期化に成功したときに返されます。
\return BAD_FUNC_ARGS RSAキーポインタがNULLに評価された場合に返されます \return BAD_FUNC_ARGS RSAキーポインタがNULLに評価された場合に返されます
\return BUFFER_E LENがRSA_MAX_ID_LENよりも小さい場合、または大きい場合は返されます。 \return BUFFER_E LENがRSA_MAX_ID_LENよりも小さい場合、または大きい場合は返されます。
\param key 初期化するRSAKEY構造へのポインタ \param key 初期化するRsaKey構造へのポインタ
\param id デバイス上のキーの識別子 \param id デバイス上のキーの識別子
\param len バイト数の識別子の長さ \param len バイト数の識別子の長さ
\param heap メモリオーバーライドで使用するためのヒープ識別子へのポインタ。メモリ割り当てのカスタム処理を可能にします。このヒープは、このRSAオブジェクトで使用するためにメモリを割り当てるときに使用されるデフォルトになります。 \param heap メモリオーバーライドで使用するためのヒープ識別子へのポインタ。メモリ割り当てのカスタム処理を可能にします。このヒープは、このRSAオブジェクトで使用するためにメモリを割り当てるときに使用されるデフォルトになります。
@ -55,11 +55,11 @@ int wc_InitRsaKey_Id(RsaKey* key, unsigned char* id, int len,
void* heap, int devId); void* heap, int devId);
/*! /*!
\ingroup RSA \ingroup RSA
\brief この関数はRNGをキーに関連付けます。WC_RSA_BLINDINGが有効になっている場合は必要です。 \brief この関数はRNGをキーに関連付けます。WC_RSA_BLINDINGが有効になっている場合は必要です。
\return 0 成功に戻った \return 0 成功に戻った
\return BAD_FUNC_ARGS RSAキーの場合、RNGポインタがNULLに評価された場合 \return BAD_FUNC_ARGS RSAキーの場合、RNGポインタがNULLに評価された場合
\param key 関連付けられるRSAKEY構造へのポインタ \param key 関連付けられるRsaKey構造へのポインタ
_Example_ _Example_
\code \code
ret = wc_InitRsaKey(&key, NULL); ret = wc_InitRsaKey(&key, NULL);
@ -75,8 +75,8 @@ int wc_InitRsaKey_Id(RsaKey* key, unsigned char* id, int len,
int wc_RsaSetRNG(RsaKey* key, WC_RNG* rng); int wc_RsaSetRNG(RsaKey* key, WC_RNG* rng);
/*! /*!
\ingroup RSA \ingroup RSA
\brief この関数は、MP_Clearを使用して提供されたRSAKEY構造体を解放します。 \brief この関数は、MP_Clearを使用して提供されたRsaKey構造体を解放します。
\return 0 キーの解放に成功したら返品されます \return 0 キーの解放に成功したら返品されます
_Example_ _Example_
\code \code
@ -91,7 +91,7 @@ int wc_RsaSetRNG(RsaKey* key, WC_RNG* rng);
int wc_FreeRsaKey(RsaKey* key); int wc_FreeRsaKey(RsaKey* key);
/*! /*!
\ingroup RSA \ingroup RSA
\brief この関数はメッセージをINから暗号化し、その結果を格納します。初期化された公開鍵と乱数発生器が必要です。副作用として、この関数はounlenの中で書き込まれたバイトを返します。 \brief この関数はメッセージをINから暗号化し、その結果を格納します。初期化された公開鍵と乱数発生器が必要です。副作用として、この関数はounlenの中で書き込まれたバイトを返します。
\return Success 入力メッセージの暗号化に成功したら、成功の場合は0を返し、障害の場合はゼロ未満です。また、outlenの値を格納することによって、OUTに書き込まれた数のバイト数を返します。 \return Success 入力メッセージの暗号化に成功したら、成功の場合は0を返し、障害の場合はゼロ未満です。また、outlenの値を格納することによって、OUTに書き込まれた数のバイト数を返します。
\return BAD_FUNC_ARG 入力パラメータのいずれかが無効な場合に返されます \return BAD_FUNC_ARG 入力パラメータのいずれかが無効な場合に返されます
@ -113,7 +113,7 @@ int wc_FreeRsaKey(RsaKey* key);
\param inLen 暗号化するメッセージの長さ \param inLen 暗号化するメッセージの長さ
\param out 出力暗号文を保存するバッファへのポインタ \param out 出力暗号文を保存するバッファへのポインタ
\param outLen 出力バッファの長さ \param outLen 出力バッファの長さ
\param key 暗号化に使用する公開鍵を含むRSAKEY構造体へのポインタ \param key 暗号化に使用する公開鍵を含むRsaKey構造体へのポインタ
_Example_ _Example_
\code \code
RsaKey pub; RsaKey pub;
@ -138,7 +138,7 @@ int wc_RsaPublicEncrypt(const byte* in, word32 inLen, byte* out,
word32 outLen, RsaKey* key, WC_RNG* rng); word32 outLen, RsaKey* key, WC_RNG* rng);
/*! /*!
\ingroup RSA \ingroup RSA
\brief この関数は復号化のためにWC_RSAPrivateCrypt関数によって利用されます。 \brief この関数は復号化のためにWC_RSAPrivateCrypt関数によって利用されます。
\return Success 復号化データの長さ \return Success 復号化データの長さ
\return RSA_PAD_E RSAUNPADエラー、フォーマットの悪いフォーマット \return RSA_PAD_E RSAUNPADエラー、フォーマットの悪いフォーマット
@ -155,7 +155,7 @@ int wc_RsaPrivateDecryptInline(byte* in, word32 inLen, byte** out,
RsaKey* key); RsaKey* key);
/*! /*!
\ingroup RSA \ingroup RSA
\brief この関数は秘密のRSA復号化を提供します。 \brief この関数は秘密のRSA復号化を提供します。
\return Success 復号化データの長さ \return Success 復号化データの長さ
\return MEMORY_E -125、メモリエラーが発生しました \return MEMORY_E -125、メモリエラーが発生しました
@ -183,7 +183,7 @@ int wc_RsaPrivateDecrypt(const byte* in, word32 inLen, byte* out,
word32 outLen, RsaKey* key); word32 outLen, RsaKey* key);
/*! /*!
\ingroup RSA \ingroup RSA
\brief 提供された配列に秘密鍵と署名します。 \brief 提供された配列に秘密鍵と署名します。
\return RSA_BUFFER_E: -131、RSAバッファエラー、出力が小さすぎたり入力が大きすぎたりする \return RSA_BUFFER_E: -131、RSAバッファエラー、出力が小さすぎたり入力が大きすぎたりする
\param in 暗号化されるバイト配列。 \param in 暗号化されるバイト配列。
@ -209,7 +209,7 @@ int wc_RsaSSL_Sign(const byte* in, word32 inLen, byte* out,
word32 outLen, RsaKey* key, WC_RNG* rng); word32 outLen, RsaKey* key, WC_RNG* rng);
/*! /*!
\ingroup RSA \ingroup RSA
\brief メッセージがRSAキーによって署名されたことを確認するために使用されます。出力は入力と同じバイト配列を使用します。 \brief メッセージがRSAキーによって署名されたことを確認するために使用されます。出力は入力と同じバイト配列を使用します。
\return >0 テキストの長さ \return >0 テキストの長さ
\return <0 エラーが発生しました。 \return <0 エラーが発生しました。
@ -240,7 +240,7 @@ int wc_RsaSSL_VerifyInline(byte* in, word32 inLen, byte** out,
RsaKey* key); RsaKey* key);
/*! /*!
\ingroup RSA \ingroup RSA
\brief メッセージがキーによって署名されたことを確認するために使用されます。 \brief メッセージがキーによって署名されたことを確認するために使用されます。
\return Success エラーのないテキストの長さ。 \return Success エラーのないテキストの長さ。
\return MEMORY_E メモリ例外 \return MEMORY_E メモリ例外
@ -266,7 +266,7 @@ int wc_RsaSSL_Verify(const byte* in, word32 inLen, byte* out,
word32 outLen, RsaKey* key); word32 outLen, RsaKey* key);
/*! /*!
\ingroup RSA \ingroup RSA
\brief 提供された配列に秘密鍵と署名します。 \brief 提供された配列に秘密鍵と署名します。
\return RSA_BUFFER_E: -131、RSAバッファエラー、出力が小さすぎたり入力が大きすぎたりする \return RSA_BUFFER_E: -131、RSAバッファエラー、出力が小さすぎたり入力が大きすぎたりする
\param in 暗号化されるバイト配列。 \param in 暗号化されるバイト配列。
@ -310,14 +310,15 @@ int wc_RsaPSS_Sign(const byte* in, word32 inLen, byte* out,
RsaKey* key, WC_RNG* rng); RsaKey* key, WC_RNG* rng);
/*! /*!
\ingroup RSA \ingroup RSA
\brief 入力署名を復号して、メッセージがキーによって署名されたことを確認します。wc_rsa_blindingが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。 \brief 入力署名を復号して、メッセージがによって署名されたことを確認します。WC_RSA_BLINDINGが有効な場合、鍵はwc_RsaSetRNGによってRNGに関連付けられなければなりません。
\return Success エラーのないテキストの長さ \return Success エラーのない場合はテキストの長さを返します
\return MEMORY_E メモリ例外 \return MEMORY_E メモリ例外
\param in 復号化されるバイト配列 \return MP_EXPTMOD_E - fastmathを使用する様に構成されている場合にFP_MAX_BITSが鍵サイズの少なくとも2倍に設定されていない(例えば4096-bit長の鍵を使用する場合にはFP_MAX_BITSは8192以上に設定すること)
\param inLen の長さ \param in 復号される署名データが格納されているバッファ
\param out 格納する復号化データのバイト配列。 \param inLen 署名データの長さ
\param outLen の長さ \param out 復号データの出力先バッファ
\param outLen 出力先バッファサイズ
\param hash メッセージに入るハッシュ型 \param hash メッセージに入るハッシュ型
\param mgf マスク生成機能識別子 \param mgf マスク生成機能識別子
_Example_ _Example_
@ -356,8 +357,8 @@ int wc_RsaPSS_Verify(byte* in, word32 inLen, byte* out,
RsaKey* key); RsaKey* key);
/*! /*!
\ingroup RSA \ingroup RSA
\brief 入力署名を復号化して、メッセージがRSAキーによって署名されたことを確認します。出力は入力と同じバイト配列を使用します。wc_rsa_blindingが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。 \brief 入力署名を復号化して、メッセージがRSAキーによって署名されたことを確認します。出力は入力と同じバイト配列を使用します。WC_RSA_BLINDINGが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。
\return >0 テキストの長さ \return >0 テキストの長さ
\return <0 エラーが発生しました。 \return <0 エラーが発生しました。
\param in 復号化されるバイト配列。 \param in 復号化されるバイト配列。
@ -406,8 +407,8 @@ int wc_RsaPSS_VerifyInline(byte* in, word32 inLen, byte** out,
enum wc_HashType hash, int mgf, enum wc_HashType hash, int mgf,
RsaKey* key); RsaKey* key);
/*! /*!
\ingroup RSA \ingroup RSA
\brief RSA-PSSで署名されたメッセージを確認してください。塩の長さはハッシュ長に等しい。wc_rsa_blindingが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。 \brief RSA-PSSで署名されたメッセージを確認してください。塩の長さはハッシュ長に等しい。WC_RSA_BLINDINGが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。
\return the PSSデータの長さが成功し、負に障害が発生します。 \return the PSSデータの長さが成功し、負に障害が発生します。
\return MEMORY_E メモリ例外 \return MEMORY_E メモリ例外
\param in 復号化されるバイト配列。 \param in 復号化されるバイト配列。
@ -468,8 +469,8 @@ int wc_RsaPSS_VerifyCheck(byte* in, word32 inLen,
enum wc_HashType hash, int mgf, enum wc_HashType hash, int mgf,
RsaKey* key); RsaKey* key);
/*! /*!
\ingroup RSA \ingroup RSA
\brief RSA-PSSで署名されたメッセージを確認してください。wc_rsa_blindingが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。 \brief RSA-PSSで署名されたメッセージを確認してください。WC_RSA_BLINDINGが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。
\return the PSSデータの長さが成功し、負に障害が発生します。 \return the PSSデータの長さが成功し、負に障害が発生します。
\return MEMORY_E メモリ例外 \return MEMORY_E メモリ例外
\param in 復号化されるバイト配列。 \param in 復号化されるバイト配列。
@ -531,8 +532,8 @@ int wc_RsaPSS_VerifyCheck_ex(byte* in, word32 inLen,
RsaKey* key); RsaKey* key);
/*! /*!
\ingroup RSA \ingroup RSA
\brief RSA-PSSで署名されたメッセージを確認してください。入力バッファは出力バッファに再利用されます。塩の長さはハッシュ長に等しい。wc_rsa_blindingが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。 \brief RSA-PSSで署名されたメッセージを確認してください。入力バッファは出力バッファに再利用されます。塩の長さはハッシュ長に等しい。WC_RSA_BLINDINGが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。
\return the PSSデータの長さが成功し、負に障害が発生します。 \return the PSSデータの長さが成功し、負に障害が発生します。
\param in 復号化されるバイト配列。 \param in 復号化されるバイト配列。
\param inLen の長さ \param inLen の長さ
@ -589,8 +590,8 @@ int wc_RsaPSS_VerifyCheckInline(byte* in, word32 inLen, byte** out,
enum wc_HashType hash, int mgf, enum wc_HashType hash, int mgf,
RsaKey* key); RsaKey* key);
/*! /*!
\ingroup RSA \ingroup RSA
\brief RSA-PSSで署名されたメッセージを確認してください。入力バッファは出力バッファに再利用されます。wc_rsa_blindingが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。 \brief RSA-PSSで署名されたメッセージを確認してください。入力バッファは出力バッファに再利用されます。WC_RSA_BLINDINGが有効な場合、キーはWC_RSASETRNGによってRNGに関連付けられなければなりません。
\return the PSSデータの長さが成功し、負に障害が発生します。 \return the PSSデータの長さが成功し、負に障害が発生します。
\param in 復号化されるバイト配列。 \param in 復号化されるバイト配列。
\param inLen の長さ \param inLen の長さ
@ -649,8 +650,8 @@ int wc_RsaPSS_VerifyCheckInline_ex(byte* in, word32 inLen, byte** out,
RsaKey* key); RsaKey* key);
/*! /*!
\ingroup RSA \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 BAD_PADDING_E PSSデータが無効な場合、NULLがINまたはSIGまたはINSZに渡されると、BAD_FUNC_ARGはハッシュアルゴリズムの長さと同じではありません。
\return MEMORY_E メモリ例外 \return MEMORY_E メモリ例外
\param in 検証中のデータのハッシュ。 \param in 検証中のデータのハッシュ。
@ -702,7 +703,7 @@ int wc_RsaPSS_CheckPadding(const byte* in, word32 inLen, byte* sig,
word32 sigSz, word32 sigSz,
enum wc_HashType hashType); enum wc_HashType hashType);
/*! /*!
\ingroup RSA \ingroup RSA
\brief PSSデータを確認して、署名が一致するようにします。塩の長さはハッシュ長に等しい。 \brief PSSデータを確認して、署名が一致するようにします。塩の長さはハッシュ長に等しい。
\return BAD_PADDING_E PSSデータが無効な場合、NULLがINまたはSIGまたはINSZに渡されると、BAD_FUNC_ARGはハッシュアルゴリズムの長さと同じではありません。 \return BAD_PADDING_E PSSデータが無効な場合、NULLがINまたはSIGまたはINSZに渡されると、BAD_FUNC_ARGはハッシュアルゴリズムの長さと同じではありません。
\return MEMORY_E メモリ例外 \return MEMORY_E メモリ例外
@ -755,7 +756,7 @@ int wc_RsaPSS_CheckPadding(const byte* in, word32 inLen, byte* sig,
int wc_RsaPSS_CheckPadding_ex(const byte* in, word32 inLen, byte* sig, int wc_RsaPSS_CheckPadding_ex(const byte* in, word32 inLen, byte* sig,
word32 sigSz, enum wc_HashType hashType, int saltLen, int bits); word32 sigSz, enum wc_HashType hashType, int saltLen, int bits);
/*! /*!
\ingroup RSA \ingroup RSA
\brief 提供されたキー構造の暗号化サイズを返します。 \brief 提供されたキー構造の暗号化サイズを返します。
\return Success 提供されたキー構造の暗号化サイズ。 \return Success 提供されたキー構造の暗号化サイズ。
_Example_ _Example_
@ -769,7 +770,7 @@ int wc_RsaPSS_CheckPadding_ex(const byte* in, word32 inLen, byte* sig,
int wc_RsaEncryptSize(RsaKey* key); int wc_RsaEncryptSize(RsaKey* key);
/*! /*!
\ingroup RSA \ingroup RSA
\brief この関数はDerフォーマットされたRSA秘密鍵を解析し、秘密鍵を抽出し、それを与えられたResakey構造に格納します。IDXに解析された距離も設定します。 \brief この関数はDerフォーマットされたRSA秘密鍵を解析し、秘密鍵を抽出し、それを与えられたResakey構造に格納します。IDXに解析された距離も設定します。
\return 0 DERエンコード入力から秘密鍵の解析に成功したときに返されます \return 0 DERエンコード入力から秘密鍵の解析に成功したときに返されます
\return ASN_PARSE_E 入力バッファから秘密鍵を解析するエラーがある場合に返されます。これは、入力秘密鍵がASN.1規格に従って正しくフォーマットされていない場合に発生する可能性があります。 \return ASN_PARSE_E 入力バッファから秘密鍵を解析するエラーがある場合に返されます。これは、入力秘密鍵がASN.1規格に従って正しくフォーマットされていない場合に発生する可能性があります。
@ -797,8 +798,8 @@ int wc_RsaPrivateKeyDecode(const byte* input, word32* inOutIdx,
RsaKey* key, word32 inSz); RsaKey* key, word32 inSz);
/*! /*!
\ingroup RSA \ingroup RSA
\brief この関数はDerフォーマットのRSA公開鍵を解析し、公開鍵を抽出し、それを指定されたResakey構造に格納します。IDXに解析された距離も設定します。 \brief この関数はDerフォーマットのRSA公開鍵を解析し、公開鍵を抽出し、それを指定されたRsaKey構造に格納します。IDXに解析された距離も設定します。
\return 0 DERエンコード入力から公開鍵の解析に成功したときに返された \return 0 DERエンコード入力から公開鍵の解析に成功したときに返された
\return ASN_PARSE_E 入力バッファから公開鍵を解析したエラーがある場合に返されます。これは、入力公開鍵がASN.1規格に従って正しくフォーマットされていない場合に発生する可能性があります。 \return ASN_PARSE_E 入力バッファから公開鍵を解析したエラーがある場合に返されます。これは、入力公開鍵がASN.1規格に従って正しくフォーマットされていない場合に発生する可能性があります。
\return ASN_OBJECT_ID_E ASN.1オブジェクトIDがRSA公開鍵のそれと一致しない場合に返されます。 \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キー入力の公開鍵要素を読み取るエラーがある場合 \return ASN_RSA_KEY_E RSAキー入力の公開鍵要素を読み取るエラーがある場合
\param input 復号する入力DERエンコードRSA公開鍵を含むバッファへのポインタ \param input 復号する入力DERエンコードRSA公開鍵を含むバッファへのポインタ
\param inOutIdx キーが始まるバッファ内のインデックスへのポインタ通常は0。この関数の副作用として、InoutIDXは入力バッファを介して解析された距離を記憶します \param inOutIdx キーが始まるバッファ内のインデックスへのポインタ通常は0。この関数の副作用として、InoutIDXは入力バッファを介して解析された距離を記憶します
\param key デコードされた公開鍵を保存するRSAKEY構造体へのポインタ \param key デコードされた公開鍵を保存するRsaKey構造体へのポインタ
_Example_ _Example_
\code \code
RsaKey pub; RsaKey pub;
@ -827,9 +828,9 @@ int wc_RsaPublicKeyDecode(const byte* input, word32* inOutIdx,
RsaKey* key, word32 inSz); RsaKey* key, word32 inSz);
/*! /*!
\ingroup RSA \ingroup RSA
\brief この関数は、公開弾性率nと指数eを撮影して、RSA公開鍵の生の要素を復号します。これらの生の要素を提供されたRSAKEY構造体に格納し、暗号化/復号化プロセスで使用することができます。 \brief この関数は、公開弾性率nと指数eを撮影して、RSA公開鍵の生の要素を復号します。これらの生の要素を提供されたRsaKey構造体に格納し、暗号化/復号化プロセスで使用することができます。
\return 0 公開鍵の生の要素をRSAKEY構造に復号したときに返された \return 0 公開鍵の生の要素をRsaKey構造に復号したときに返された
\return BAD_FUNC_ARG いずれかの入力引数がNULLに評価された場合に返されます。 \return BAD_FUNC_ARG いずれかの入力引数がNULLに評価された場合に返されます。
\return MP_INIT_E 複数の精密整数MP_INTライブラリで使用するための整数の初期化中にエラーがある場合 \return MP_INIT_E 複数の精密整数MP_INTライブラリで使用するための整数の初期化中にエラーがある場合
\return ASN_GETINT_E 提供されたRSAキー要素、nまたはeのいずれかを読むエラーがある場合に返されます \return ASN_GETINT_E 提供されたRSAキー要素、nまたはeのいずれかを読むエラーがある場合に返されます
@ -856,12 +857,12 @@ int wc_RsaPublicKeyDecodeRaw(const byte* n, word32 nSz,
const byte* e, word32 eSz, RsaKey* key); const byte* e, word32 eSz, RsaKey* key);
/*! /*!
\ingroup RSA \ingroup RSA
\brief この機能はRSAKEYキーをDERフォーマットに変換します。結果は出力に書き込まれ、書き込まれたバイト数を返します。 \brief この機能はRSAKEYキーをDERフォーマットに変換します。結果は出力に書き込まれ、書き込まれたバイト数を返します。
\return 0 成功 \return 0 成功
\return BAD_FUNC_ARG キーまたは出力がNULLの場合、またはキー - >タイプがRSA_PRIVATEでない場合、またはINLENが出力バッファに十分な大きさでない場合は返されます。 \return BAD_FUNC_ARG キーまたは出力がNULLの場合、またはキー - >タイプがRSA_PRIVATEでない場合、またはINLENが出力バッファに十分な大きさでない場合は返されます。
\return MEMORY_E メモリの割り当て中にエラーが発生した場合に返されます。 \return MEMORY_E メモリの割り当て中にエラーが発生した場合に返されます。
\param key 初期化されたRSAKEY構造 \param key 初期化されたRsaKey構造
\param output 出力バッファへのポインタ。 \param output 出力バッファへのポインタ。
_Example_ _Example_
\code \code
@ -888,7 +889,7 @@ int wc_RsaPublicKeyDecodeRaw(const byte* n, word32 nSz,
int wc_RsaKeyToDer(RsaKey* key, byte* output, word32 inLen); int wc_RsaKeyToDer(RsaKey* key, byte* output, word32 inLen);
/*! /*!
\ingroup RSA \ingroup RSA
\brief この機能は、どのパディングを使用するかを選択しながらRSA暗号化を実行します。 \brief この機能は、どのパディングを使用するかを選択しながらRSA暗号化を実行します。
\return size 正常に暗号化されていると、暗号化されたバッファのサイズが返されます \return size 正常に暗号化されていると、暗号化されたバッファのサイズが返されます
\return RSA_BUFFER_E RSAバッファエラー、出力が小さすぎたり入力が大きすぎたりする \return RSA_BUFFER_E RSAバッファエラー、出力が小さすぎたり入力が大きすぎたりする
@ -896,7 +897,7 @@ int wc_RsaKeyToDer(RsaKey* key, byte* output, word32 inLen);
\param inLen 暗号化するバッファの長さ \param inLen 暗号化するバッファの長さ
\param out 暗号化されたMSGが作成されました \param out 暗号化されたMSGが作成されました
\param outLen 暗号化されたMSGを保持するために利用可能なバッファの長さ \param outLen 暗号化されたMSGを保持するために利用可能なバッファの長さ
\param key 初期化RSAキー構造体 \param key 初期化ずみRsaKey構造体
\param rng 初期化されたWC_RNG構造体 \param rng 初期化されたWC_RNG構造体
\param type 使用するパディングの種類WC_RSA_OAEP_PADまたはWC_RSA_PKCSV15_PAD \param type 使用するパディングの種類WC_RSA_OAEP_PADまたはWC_RSA_PKCSV15_PAD
\param hash 使用するハッシュの種類選択はhash.hにあります \param hash 使用するハッシュの種類選択はhash.hにあります
@ -925,7 +926,7 @@ int wc_RsaPublicEncrypt_ex(const byte* in, word32 inLen, byte* out,
enum wc_HashType hash, int mgf, byte* label, word32 labelSz); enum wc_HashType hash, int mgf, byte* label, word32 labelSz);
/*! /*!
\ingroup RSA \ingroup RSA
\brief この関数はRSAを使用してメッセージを復号化し、どのパディングタイプのオプションを指定します。 \brief この関数はRSAを使用してメッセージを復号化し、どのパディングタイプのオプションを指定します。
\return size 復号化が成功すると、復号化されたメッセージのサイズが返されます。 \return size 復号化が成功すると、復号化されたメッセージのサイズが返されます。
\return MEMORY_E 必要な配列をMallocにMallocにするのに十分なメモリがない場合は返されます。 \return MEMORY_E 必要な配列をMallocにMallocにするのに十分なメモリがない場合は返されます。
@ -934,7 +935,7 @@ int wc_RsaPublicEncrypt_ex(const byte* in, word32 inLen, byte* out,
\param inLen 復号化するバッファの長さ \param inLen 復号化するバッファの長さ
\param out 復号化されたMSGが作成されました \param out 復号化されたMSGが作成されました
\param outLen 復号化されたMSGを保持するために利用可能なバッファの長さ \param outLen 復号化されたMSGを保持するために利用可能なバッファの長さ
\param key 初期化RSAキー構造体 \param key 初期化ずみRsaKey構造体
\param type 使用するパディングの種類WC_RSA_OAEP_PADまたはWC_RSA_PKCSV15_PAD \param type 使用するパディングの種類WC_RSA_OAEP_PADまたはWC_RSA_PKCSV15_PAD
\param hash 使用するハッシュの種類選択はhash.hにあります \param hash 使用するハッシュの種類選択はhash.hにあります
\param mgf 使用するマスク生成機能の種類 \param mgf 使用するマスク生成機能の種類
@ -968,7 +969,7 @@ int wc_RsaPrivateDecrypt_ex(const byte* in, word32 inLen,
enum wc_HashType hash, int mgf, byte* label, word32 labelSz); enum wc_HashType hash, int mgf, byte* label, word32 labelSz);
/*! /*!
\ingroup RSA \ingroup RSA
\brief この関数はRSAを使用してメッセージをインラインで復号化し、どのパディングタイプのオプションを示します。INバッファには、呼び出された後に復号化されたメッセージが含まれ、アウトバイトポインタはプレーンテキストがある「IN」バッファ内の場所を指します。 \brief この関数はRSAを使用してメッセージをインラインで復号化し、どのパディングタイプのオプションを示します。INバッファには、呼び出された後に復号化されたメッセージが含まれ、アウトバイトポインタはプレーンテキストがある「IN」バッファ内の場所を指します。
\return size 復号化が成功すると、復号化されたメッセージのサイズが返されます。 \return size 復号化が成功すると、復号化されたメッセージのサイズが返されます。
\return MEMORY_E: 必要な配列をMallocにMallocにするのに十分なメモリがない場合は返されます。 \return MEMORY_E: 必要な配列をMallocにMallocにするのに十分なメモリがない場合は返されます。
@ -978,7 +979,7 @@ int wc_RsaPrivateDecrypt_ex(const byte* in, word32 inLen,
\param in 復号化のためのバッファへのポインタ \param in 復号化のためのバッファへのポインタ
\param inLen 復号化するバッファの長さ \param inLen 復号化するバッファの長さ
\param out "in"バッファの復号化されたメッセージの位置へのポインタ \param out "in"バッファの復号化されたメッセージの位置へのポインタ
\param key 初期化RSAキー構造体 \param key 初期化ずみRsaKey構造体
\param type 使用するパディングの種類WC_RSA_OAEP_PADまたはWC_RSA_PKCSV15_PAD \param type 使用するパディングの種類WC_RSA_OAEP_PADまたはWC_RSA_PKCSV15_PAD
\param hash 使用するハッシュの種類選択はhash.hにあります \param hash 使用するハッシュの種類選択はhash.hにあります
\param mgf 使用するマスク生成機能の種類 \param mgf 使用するマスク生成機能の種類
@ -1013,8 +1014,8 @@ int wc_RsaPrivateDecryptInline_ex(byte* in, word32 inLen,
int mgf, byte* label, word32 labelSz); int mgf, byte* label, word32 labelSz);
/*! /*!
\ingroup RSA \ingroup RSA
\brief RSAアルゴリズムに使用される個々の要素E、NにRSAKEY構造体を平らにします。 \brief RSAアルゴリズムに使用されるRsaKey構造体の個々の要素E、Nをバッファに取り出します。
\return 0 関数が正常に実行された場合は、エラーなしで返されます。 \return 0 関数が正常に実行された場合は、エラーなしで返されます。
\return BAD_FUNC_ARG: いずれかのパラメータがNULL値で渡された場合に返されます。 \return BAD_FUNC_ARG: いずれかのパラメータがNULL値で渡された場合に返されます。
\return RSA_BUFFER_E: 渡されたeまたはnバッファが正しいサイズではない場合に返されます。 \return RSA_BUFFER_E: 渡されたeまたはnバッファが正しいサイズではない場合に返されます。
@ -1046,13 +1047,13 @@ int wc_RsaFlattenPublicKey(RsaKey* key, byte* e, word32* eSz, byte* n,
word32* nSz); word32* nSz);
/*! /*!
\ingroup RSA \ingroup RSA
\brief RSA公開鍵をDERフォーマットに変換します。出力に書き込み、書き込まれたバイト数を返します。 \brief RSA公開鍵をDERフォーマットに変換します。出力に書き込み、書き込まれたバイト数を返します。
\return >0 成功、書かれたバイト数。 \return >0 成功、書かれたバイト数。
\return BAD_FUNC_ARG キーまたは出力がNULLの場合に返されます。 \return BAD_FUNC_ARG キーまたは出力がNULLの場合に返されます。
\return MEMORY_E エラー割り当てメモリが発生したときに返されます。 \return MEMORY_E エラー割り当てメモリが発生したときに返されます。
\return <0 エラー \return <0 エラー
\param key 変換するRSAキー構造。 \param key 変換するRsaKey構造
\param output 保留された出力バッファー。NULLが長さのみを返す場合 \param output 保留された出力バッファー。NULLが長さのみを返す場合
_Example_ _Example_
\code \code
@ -1074,13 +1075,13 @@ int wc_RsaFlattenPublicKey(RsaKey* key, byte* e, word32* eSz, byte* n,
int wc_RsaKeyToPublicDer(RsaKey* key, byte* output, word32 inLen); int wc_RsaKeyToPublicDer(RsaKey* key, byte* output, word32 inLen);
/*! /*!
\ingroup RSA \ingroup RSA
\brief RSA公開鍵をDERフォーマットに変換します。出力に書き込み、書き込まれたバイト数を返します。with_headerが0の場合seq + n + eだけがASN.1 Derフォーマットで返され、ヘッダーを除外します。 \brief RSA公開鍵をDERフォーマットに変換します。出力に書き込み、書き込まれたバイト数を返します。with_headerが0の場合seq + n + eだけがASN.1 Derフォーマットで返され、ヘッダーを除外します。
\return >0 成功、書かれたバイト数。 \return >0 成功、書かれたバイト数。
\return BAD_FUNC_ARG キーまたは出力がNULLの場合に返されます。 \return BAD_FUNC_ARG キーまたは出力がNULLの場合に返されます。
\return MEMORY_E エラー割り当てメモリが発生したときに返されます。 \return MEMORY_E エラー割り当てメモリが発生したときに返されます。
\return <0 エラー \return <0 エラー
\param key 変換するRSAキー構造。 \param key 変換するRsaKey構造
\param output 保留された出力バッファー。NULLが長さのみを返す場合 \param output 保留された出力バッファー。NULLが長さのみを返す場合
_Example_ _Example_
\code \code
@ -1103,12 +1104,12 @@ int wc_RsaKeyToPublicDer_ex(RsaKey* key, byte* output, word32 inLen,
int with_header); int with_header);
/*! /*!
\ingroup RSA \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 0 RSA秘密鍵の生成に成功したら返されました
\return BAD_FUNC_ARG 入力引数のいずれかがNULLの場合、サイズパラメータは必要な範囲外にあるか、eが誤って選択されている場合 \return BAD_FUNC_ARG 入力引数のいずれかがNULLの場合、サイズパラメータは必要な範囲外にあるか、eが誤って選択されている場合
\return RNG_FAILURE_E 提供されたRNG構造体を使用してランダムブロックを生成するエラーがある場合 \return RNG_FAILURE_E 提供されたRNG構造体を使用してランダムブロックを生成するエラーがある場合
\return MP_INIT_E \return MP_INIT_E
\return MP_READ_E RSAキーの生成中に使用された数学ライブラリにエラーがある場合に返されたRSAキーの生成中に使用された数学ライブラリにエラーがある場合に返される可能性があります。 \return MP_READ_E RSAキーの生成中に使用された数学ライブラリにエラーがある場合に返されたRSAキーの生成中に使用された数学ライブラリにエラーがある場合に返される可能性があります。
\return MP_CMP_E RSAキーの生成中に使用されている数学ライブラリにエラーがある場合は返される可能性があります。 \return MP_CMP_E RSAキーの生成中に使用されている数学ライブラリにエラーがある場合は返される可能性があります。
\return MP_INVMOD_E RSAキーの生成中に使用されている数学ライブラリにエラーがある場合は返される可能性があります。 \return MP_INVMOD_E RSAキーの生成中に使用されている数学ライブラリにエラーがある場合は返される可能性があります。
@ -1143,7 +1144,7 @@ int wc_RsaKeyToPublicDer_ex(RsaKey* key, byte* output, word32 inLen,
int wc_MakeRsaKey(RsaKey* key, int size, long e, WC_RNG* rng); int wc_MakeRsaKey(RsaKey* key, int size, long e, WC_RNG* rng);
/*! /*!
\ingroup RSA \ingroup RSA
\brief この関数は、ブロックされていないRSAコンテキストを設定します。RSANBコンテキストが設定されている場合、RSA関数を多くの小さな操作に分割する高速数学ベースの非ブロッキングEXPTMODが可能になります。wc_rsa_nonblockが定義されているときに有効になっています。 \brief この関数は、ブロックされていないRSAコンテキストを設定します。RSANBコンテキストが設定されている場合、RSA関数を多くの小さな操作に分割する高速数学ベースの非ブロッキングEXPTMODが可能になります。wc_rsa_nonblockが定義されているときに有効になっています。
\return 0 成功 \return 0 成功
\return BAD_FUNC_ARG キーまたはNBがNULLの場合に返されます。 \return BAD_FUNC_ARG キーまたはNBがNULLの場合に返されます。
@ -1179,11 +1180,11 @@ int wc_MakeRsaKey(RsaKey* key, int size, long e, WC_RNG* rng);
int wc_RsaSetNonBlock(RsaKey* key, RsaNb* nb); int wc_RsaSetNonBlock(RsaKey* key, RsaNb* nb);
/*! /*!
\ingroup RSA \ingroup RSA
\brief この関数は最大ブロック時間の最大ブロック時間をマイクロ秒単位で設定します。それは、メガヘルツのCPU速度と共に事前計算されたテーブルTFM.cexptModnbinstを参照を使用して、提供された最大ブロック時間内に次の動作を完了できるかどうかを判断します。wc_rsa_nonblock_timeが定義されているときに有効になります。 \brief この関数は最大ブロック時間の最大ブロック時間をマイクロ秒単位で設定します。それは、メガヘルツのCPU速度と共に事前計算されたテーブルTFM.cexptModnbinstを参照を使用して、提供された最大ブロック時間内に次の動作を完了できるかどうかを判断します。wc_rsa_nonblock_timeが定義されているときに有効になります。
\return 0 成功 \return 0 成功
\return BAD_FUNC_ARG キーがNULLの場合、またはWC_RSASETNONBLOCKが以前に呼び出され、キー - > NBはNULLの場合に返されます。 \return BAD_FUNC_ARG キーがNULLの場合、またはWC_RSASETNONBLOCKが以前に呼び出され、キー - > NBはNULLの場合に返されます。
\param key RSAキー構造 \param key RsaKey構造
\param maxBlockUs マイクロ秒をブロックする最大時間。 \param maxBlockUs マイクロ秒をブロックする最大時間。
_Example_ _Example_
\code \code