luna - wolfssl/doc/dox_comments/header

   1/*!
   2    \ingroup ECC
   3
   4    \brief この関数は新しいecc_keyを生成し、keyに格納します。
   5
   6    \return 0 成功時に返されます。
   7    \return ECC_BAD_ARG_E rngまたはkeyがNULLと評価された場合に返されます
   8    \return BAD_FUNC_ARG 指定されたキーサイズがサポートされているキーの正しい範囲内にない場合に返されます
   9    \return MEMORY_E eccキーの計算中にメモリ割り当てエラーがある場合に返されます
  10    \return MP_INIT_E eccキーの計算中にエラーがある場合に返される可能性があります
  11    \return MP_READ_E eccキーの計算中にエラーがある場合に返される可能性があります
  12    \return MP_CMP_E eccキーの計算中にエラーがある場合に返される可能性があります
  13    \return MP_INVMOD_E eccキーの計算中にエラーがある場合に返される可能性があります
  14    \return MP_EXPTMOD_E eccキーの計算中にエラーがある場合に返される可能性があります
  15    \return MP_MOD_E eccキーの計算中にエラーがある場合に返される可能性があります
  16    \return MP_MUL_E eccキーの計算中にエラーがある場合に返される可能性があります
  17    \return MP_ADD_E eccキーの計算中にエラーがある場合に返される可能性があります
  18    \return MP_MULMOD_E eccキーの計算中にエラーがある場合に返される可能性があります
  19    \return MP_TO_E eccキーの計算中にエラーがある場合に返される可能性があります
  20    \return MP_MEM eccキーの計算中にエラーがある場合に返される可能性があります
  21
  22    \param rng キーの生成に使用する初期化されたRNGオブジェクトへのポインタ
  23    \param keysize ecc_keyの希望する長さ
  24    \param key キーを生成するecc_keyへのポインタ
  25
  26    _Example_
  27    \code
  28    ecc_key key;
  29    wc_ecc_init(&key);
  30    WC_RNG rng;
  31    wc_InitRng(&rng);
  32    wc_ecc_make_key(&rng, 32, &key); // 32バイトのeccキーを初期化
  33    \endcode
  34
  35    \sa wc_ecc_init
  36    \sa wc_ecc_shared_secret
  37*/
  38
  39int wc_ecc_make_key(WC_RNG* rng, int keysize, ecc_key* key);
  40
  41/*!
  42    \ingroup ECC
  43
  44    \brief この関数は新しいecc_keyを生成し、keyに格納します。
  45
  46    \return 0 成功時に返されます。
  47    \return ECC_BAD_ARG_E rngまたはkeyがNULLと評価された場合に返されます
  48    \return BAD_FUNC_ARG 指定されたキーサイズがサポートされているキーの正しい範囲内にない場合に返されます
  49    \return MEMORY_E eccキーの計算中にメモリ割り当てエラーがある場合に返されます
  50    \return MP_INIT_E eccキーの計算中にエラーがある場合に返される可能性があります
  51    \return MP_READ_E eccキーの計算中にエラーがある場合に返される可能性があります
  52    \return MP_CMP_E eccキーの計算中にエラーがある場合に返される可能性があります
  53    \return MP_INVMOD_E eccキーの計算中にエラーがある場合に返される可能性があります
  54    \return MP_EXPTMOD_E eccキーの計算中にエラーがある場合に返される可能性があります
  55    \return MP_MOD_E eccキーの計算中にエラーがある場合に返される可能性があります
  56    \return MP_MUL_E eccキーの計算中にエラーがある場合に返される可能性があります
  57    \return MP_ADD_E eccキーの計算中にエラーがある場合に返される可能性があります
  58    \return MP_MULMOD_E eccキーの計算中にエラーがある場合に返される可能性があります
  59    \return MP_TO_E eccキーの計算中にエラーがある場合に返される可能性があります
  60    \return MP_MEM eccキーの計算中にエラーがある場合に返される可能性があります
  61
  62    \param key 作成されたキーを格納するポインタ。
  63    \param keysize 作成されるキーのサイズ（バイト単位）、curveIdに基づいて設定
  64    \param rng キー作成で使用されるRng
  65    \param curve_id キーに使用するカーブ
  66
  67    _Example_
  68    \code
  69    ecc_key key;
  70    int ret;
  71    WC_RNG rng;
  72    wc_ecc_init(&key);
  73    wc_InitRng(&rng);
  74    int curveId = ECC_SECP521R1;
  75    int keySize = wc_ecc_get_curve_size_from_id(curveId);
  76    ret = wc_ecc_make_key_ex(&rng, keySize, &key, curveId);
  77    if (ret != MP_OKAY) {
  78        // エラー処理
  79    }
  80
  81    \endcode
  82
  83    \sa wc_ecc_make_key
  84    \sa wc_ecc_get_curve_size_from_id
  85*/
  86
  87int wc_ecc_make_key_ex(WC_RNG* rng, int keysize, ecc_key* key, int curve_id);
  88
  89/*!
  90    \ingroup ECC
  91
  92    \brief wc_ecc_make_pubは、既存の秘密成分を持つecc_keyから公開成分を計算します。pubOutが提供されている場合、計算された公開鍵はそこに格納されます。そうでない場合は、提供されたecc_keyの公開成分スロットに格納されます。
  93
  94    \return 0 成功時に返されます。
  95    \return ECC_BAD_ARG_E keyがNULLの場合に返されます
  96    \return BAD_FUNC_ARG 提供されたキーが有効なecc_keyでない場合に返されます。
  97    \return MEMORY_E 公開鍵の計算中にメモリ割り当てエラーがある場合に返されます
  98    \return MP_INIT_E 公開鍵の計算中にエラーがある場合に返される可能性があります
  99    \return MP_READ_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 100    \return MP_CMP_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 101    \return MP_INVMOD_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 102    \return MP_EXPTMOD_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 103    \return MP_MOD_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 104    \return MP_MUL_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 105    \return MP_ADD_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 106    \return MP_MULMOD_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 107    \return MP_TO_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 108    \return MP_MEM 公開鍵の計算中にエラーがある場合に返される可能性があります
 109    \return ECC_OUT_OF_RANGE_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 110    \return ECC_PRIV_KEY_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 111    \return ECC_INF_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 112
 113    \param key 有効な秘密成分を含むecc_keyへのポインタ
 114    \param pubOut 計算された公開鍵を格納するecc_point構造体へのオプションのポインタ
 115
 116    \sa wc_ecc_make_pub_ex
 117    \sa wc_ecc_make_key
 118*/
 119
 120int wc_ecc_make_pub(ecc_key* key, ecc_point* pubOut);
 121
 122/*!
 123    \ingroup ECC
 124
 125    \brief wc_ecc_make_pub_exは、既存の秘密成分を持つecc_keyから公開成分を計算します。pubOutが提供されている場合、計算された公開鍵はそこに格納されます。そうでない場合は、提供されたecc_keyの公開成分スロットに格納されます。提供されたrngがnon-NULLの場合、計算で使用される秘密鍵値をブラインドするために使用されます。
 126
 127    \return 0 成功時に返されます。
 128    \return ECC_BAD_ARG_E keyがNULLの場合に返されます
 129    \return BAD_FUNC_ARG 提供されたキーが有効なecc_keyでない場合に返されます。
 130    \return MEMORY_E 公開鍵の計算中にメモリ割り当てエラーがある場合に返されます
 131    \return MP_INIT_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 132    \return MP_READ_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 133    \return MP_CMP_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 134    \return MP_INVMOD_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 135    \return MP_EXPTMOD_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 136    \return MP_MOD_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 137    \return MP_MUL_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 138    \return MP_ADD_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 139    \return MP_MULMOD_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 140    \return MP_TO_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 141    \return MP_MEM 公開鍵の計算中にエラーがある場合に返される可能性があります
 142    \return ECC_OUT_OF_RANGE_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 143    \return ECC_PRIV_KEY_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 144    \return ECC_INF_E 公開鍵の計算中にエラーがある場合に返される可能性があります
 145
 146    \param key 有効な秘密成分を含むecc_keyへのポインタ
 147    \param pubOut 計算された公開鍵を格納するecc_point構造体へのオプションのポインタ
 148    \param rng 公開鍵の計算で使用されるRng
 149
 150    \sa wc_ecc_make_pub
 151    \sa wc_ecc_make_key
 152    \sa wc_InitRng
 153*/
 154
 155int wc_ecc_make_pub_ex(ecc_key* key, ecc_point* pubOut, WC_RNG* rng);
 156
 157/*!
 158    \ingroup ECC
 159
 160    \brief eccキーの有効性に関する健全性チェックを実行します。
 161
 162    \return MP_OKAY 成功、キーは正常です。
 163    \return BAD_FUNC_ARG keyがNULLの場合に返されます。
 164    \return ECC_INF_E wc_ecc_point_is_at_infinityが1を返す場合に返されます。
 165
 166    \param key チェックするキーへのポインタ。
 167
 168    _Example_
 169    \code
 170    ecc_key key;
 171    WC_RNG rng;
 172    int check_result;
 173    wc_ecc_init(&key);
 174    wc_InitRng(&rng);
 175    wc_ecc_make_key(&rng, 32, &key);
 176    check_result = wc_ecc_check_key(&key);
 177
 178    if (check_result == MP_OKAY)
 179    {
 180        // キーチェック成功
 181    }
 182    else
 183    {
 184        // キーチェック失敗
 185    }
 186    \endcode
 187
 188    \sa wc_ecc_point_is_at_infinity
 189*/
 190
 191int wc_ecc_check_key(ecc_key* key);
 192
 193/*!
 194    \ingroup ECC
 195
 196    \brief この関数は、使用後にecc_keyキーを解放します。
 197
 198
 199    \param key 解放するecc_key構造体へのポインタ
 200
 201    _Example_
 202    \code
 203    // キーを初期化してECC操作を実行
 204    ...
 205    wc_ecc_key_free(&key);
 206    \endcode
 207
 208    \sa wc_ecc_key_new
 209    \sa wc_ecc_init_ex
 210*/
 211
 212void wc_ecc_key_free(ecc_key* key);
 213
 214/*!
 215    \ingroup ECC
 216
 217    \brief この関数は、ローカル秘密鍵と受信した公開鍵を使用して新しい共有秘密鍵を生成します。この共有秘密鍵をバッファoutに格納し、outlenを更新して出力バッファに書き込まれたバイト数を保持します。
 218
 219    \return 0 共有秘密鍵の生成に成功した場合に返されます
 220    \return BAD_FUNC_ARG いずれかの入力パラメータがNULLと評価された場合に返されます
 221    \return ECC_BAD_ARG_E 引数として与えられた秘密鍵private_keyのタイプがECC_PRIVATEKEYでない場合、または公開鍵と秘密鍵のタイプ（ecc->dpで指定）が同等でない場合に返されます
 222    \return MEMORY_E 新しいeccポイントの生成中にエラーがある場合に返されます
 223    \return BUFFER_E 生成された共有秘密鍵が提供されたバッファに格納するには長すぎる場合に返されます
 224    \return MP_INIT_E 共有鍵の計算中にエラーがある場合に返される可能性があります
 225    \return MP_READ_E 共有鍵の計算中にエラーがある場合に返される可能性があります
 226    \return MP_CMP_E 共有鍵の計算中にエラーがある場合に返される可能性があります
 227    \return MP_INVMOD_E 共有鍵の計算中にエラーがある場合に返される可能性があります
 228    \return MP_EXPTMOD_E 共有鍵の計算中にエラーがある場合に返される可能性があります
 229    \return MP_MOD_E 共有鍵の計算中にエラーがある場合に返される可能性があります
 230    \return MP_MUL_E 共有鍵の計算中にエラーがある場合に返される可能性があります
 231    \return MP_ADD_E 共有鍵の計算中にエラーがある場合に返される可能性があります
 232    \return MP_MULMOD_E 共有鍵の計算中にエラーがある場合に返される可能性があります
 233    \return MP_TO_E 共有鍵の計算中にエラーがある場合に返される可能性があります
 234    \return MP_MEM 共有鍵の計算中にエラーがある場合に返される可能性があります
 235
 236    \param private_key ローカル秘密鍵を含むecc_key構造体へのポインタ
 237    \param public_key 受信した公開鍵を含むecc_key構造体へのポインタ
 238    \param out 生成された共有秘密鍵を格納する出力バッファへのポインタ
 239    \param outlen 出力バッファの長さを含むword32オブジェクトへのポインタ。共有秘密鍵の生成に成功すると、出力バッファに書き込まれた長さで上書きされます
 240
 241    _Example_
 242    \code
 243    ecc_key priv, pub;
 244    WC_RNG rng;
 245    byte secret[1024]; // 1024バイトの共有秘密鍵を保持可能
 246    word32 secretSz = sizeof(secret);
 247    int ret;
 248
 249    wc_InitRng(&rng); // rngを初期化
 250    wc_ecc_init(&priv); // キーを初期化
 251    wc_ecc_make_key(&rng, 32, &priv); // 公開/秘密鍵ペアを作成
 252    // 公開鍵を受信し、pubに初期化
 253    ret = wc_ecc_shared_secret(&priv, &pub, secret, &secretSz);
 254    // 共有秘密鍵を生成
 255    if ( ret != 0 ) {
 256    	// 共有秘密鍵の生成エラー
 257    }
 258    \endcode
 259
 260    \sa wc_ecc_init
 261    \sa wc_ecc_make_key
 262*/
 263
 264int wc_ecc_shared_secret(ecc_key* private_key, ecc_key* public_key, byte* out,
 265                      word32* outlen);
 266
 267/*!
 268    \ingroup ECC
 269
 270    \brief 秘密鍵と公開ポイント間でECC共有秘密を作成します。
 271
 272    \return MP_OKAY 成功を示します。
 273    \return BAD_FUNC_ARG いずれかの引数がnullの場合に返されるエラー。
 274    \return ECC_BAD_ARG_E private_key->typeがECC_PRIVATEKEYでない場合、またはprivate_key->idxの検証に失敗した場合に返されるエラー。
 275    \return BUFFER_E outlenが小さすぎる場合のエラー。
 276    \return MEMORY_E 新しいポイントを作成する際のエラー。
 277    \return MP_VAL 初期化失敗が発生した場合に返される可能性があります。
 278    \return MP_MEM 初期化失敗が発生した場合に返される可能性があります。
 279
 280    \param private_key 秘密ECCキー。
 281    \param point 使用するポイント（公開鍵）。
 282    \param out 共有秘密の出力先。ANSI X9.63のEC-DHに準拠。
 283    \param outlen 最大サイズを入力し、共有秘密の結果サイズを出力。
 284
 285    _Example_
 286    \code
 287    ecc_key key;
 288    ecc_point* point;
 289    byte shared_secret[];
 290    int secret_size;
 291    int result;
 292
 293    point = wc_ecc_new_point();
 294
 295    result = wc_ecc_shared_secret_ex(&key, point,
 296    &shared_secret, &secret_size);
 297
 298    if (result != MP_OKAY)
 299    {
 300        // エラーを処理
 301    }
 302    \endcode
 303
 304    \sa wc_ecc_verify_hash_ex
 305*/
 306
 307int wc_ecc_shared_secret_ex(ecc_key* private_key, ecc_point* point,
 308                             byte* out, word32 *outlen);
 309
 310/*!
 311    \ingroup ECC
 312
 313    \brief この関数は、ecc_keyオブジェクトを使用してメッセージダイジェストに署名し、真正性を保証します。
 314
 315    \return 0 メッセージダイジェストの署名を正常に生成した場合に返されます
 316    \return BAD_FUNC_ARG いずれかの入力パラメータがNULLと評価された場合、または出力バッファが生成された署名を格納するには小さすぎる場合に返されます
 317    \return ECC_BAD_ARG_E 入力キーが秘密鍵でない場合、またはECC OIDが無効な場合に返されます
 318    \return RNG_FAILURE_E rngが満足のいくキーを正常に生成できない場合に返されます
 319    \return MP_INIT_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 320    \return MP_READ_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 321    \return MP_CMP_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 322    \return MP_INVMOD_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 323    \return MP_EXPTMOD_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 324    \return MP_MOD_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 325    \return MP_MUL_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 326    \return MP_ADD_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 327    \return MP_MULMOD_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 328    \return MP_TO_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 329    \return MP_MEM メッセージ署名の計算中にエラーがある場合に返される可能性があります
 330
 331    \param in 署名するメッセージハッシュを含むバッファへのポインタ
 332    \param inlen 署名するメッセージハッシュの長さ
 333    \param out 生成された署名を格納するバッファ
 334    \param outlen 出力バッファの最大長。メッセージ署名の生成に成功すると、outに書き込まれたバイト数を格納します
 335    \param key 署名を生成するために使用する秘密ECCキーへのポインタ
 336
 337    _Example_
 338    \code
 339    ecc_key key;
 340    WC_RNG rng;
 341    int ret, sigSz;
 342
 343    byte sig[512]; // 生成された署名を保持
 344    sigSz = sizeof(sig);
 345    byte digest[] = { // メッセージハッシュで初期化 };
 346    wc_InitRng(&rng); // rngを初期化
 347    wc_ecc_init(&key); // キーを初期化
 348    wc_ecc_make_key(&rng, 32, &key); // 公開/秘密鍵ペアを作成
 349    ret = wc_ecc_sign_hash(digest, sizeof(digest), sig, &sigSz, &key);
 350    if ( ret != 0 ) {
 351	    // メッセージ署名の生成エラー
 352    }
 353    \endcode
 354
 355    \sa wc_ecc_verify_hash
 356*/
 357
 358int wc_ecc_sign_hash(const byte* in, word32 inlen, byte* out, word32 *outlen,
 359                     WC_RNG* rng, ecc_key* key);
 360
 361/*!
 362    \ingroup ECC
 363
 364    \brief メッセージダイジェストに署名します。
 365
 366    \return MP_OKAY メッセージダイジェストの署名を正常に生成した場合に返されます
 367    \return ECC_BAD_ARG_E 入力キーが秘密鍵でない場合、またはECC IDXが無効な場合、またはいずれかの入力パラメータがNULLと評価された場合、または出力バッファが生成された署名を格納するには小さすぎる場合に返されます
 368    \return RNG_FAILURE_E rngが満足のいくキーを正常に生成できない場合に返されます
 369    \return MP_INIT_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 370    \return MP_READ_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 371    \return MP_CMP_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 372    \return MP_INVMOD_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 373    \return MP_EXPTMOD_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 374    \return MP_MOD_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 375    \return MP_MUL_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 376    \return MP_ADD_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 377    \return MP_MULMOD_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 378    \return MP_TO_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 379    \return MP_MEM メッセージ署名の計算中にエラーがある場合に返される可能性があります
 380
 381    \param in 署名するメッセージダイジェスト。
 382    \param inlen ダイジェストの長さ。
 383    \param rng WC_RNG構造体へのポインタ。
 384    \param key 秘密ECCキー。
 385    \param r 署名のr成分の出力先。
 386    \param s 署名のs成分の出力先。
 387
 388    _Example_
 389    \code
 390    ecc_key key;
 391    WC_RNG rng;
 392    int ret, sigSz;
 393    mp_int r; // 署名のr成分の出力先。
 394    mp_int s; // 署名のs成分の出力先。
 395
 396    byte sig[512]; // 生成された署名を保持
 397    sigSz = sizeof(sig);
 398    byte digest[] = { メッセージハッシュで初期化 };
 399    wc_InitRng(&rng); // rngを初期化
 400    wc_ecc_init(&key); // キーを初期化
 401    mp_init(&r); // r成分を初期化
 402    mp_init(&s); // s成分を初期化
 403    wc_ecc_make_key(&rng, 32, &key); // 公開/秘密鍵ペアを作成
 404    ret = wc_ecc_sign_hash_ex(digest, sizeof(digest), &rng, &key, &r, &s);
 405
 406    if ( ret != MP_OKAY ) {
 407    	// メッセージ署名の生成エラー
 408    }
 409    \endcode
 410
 411    \sa wc_ecc_verify_hash_ex
 412*/
 413
 414int wc_ecc_sign_hash_ex(const byte* in, word32 inlen, WC_RNG* rng,
 415                        ecc_key* key, mp_int *r, mp_int *s);
 416
 417/*!
 418    \ingroup ECC
 419
 420    \brief この関数は、真正性を確保するためにハッシュのECC署名を検証します。statを通じて答えを返し、1は有効な署名に対応し、0は無効な署名に対応します。
 421
 422    \return 0 署名検証の実行に成功した場合に返されます。注：これは署名が検証されたことを意味するものではありません。真正性情報は代わりにstatに格納されます
 423    \return BAD_FUNC_ARG いずれかの入力パラメータがNULLと評価された場合に返されます
 424    \return MEMORY_E メモリ割り当てエラーがある場合に返されます
 425    \return MP_INIT_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 426    \return MP_READ_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 427    \return MP_CMP_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 428    \return MP_INVMOD_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 429    \return MP_EXPTMOD_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 430    \return MP_MOD_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 431    \return MP_MUL_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 432    \return MP_ADD_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 433    \return MP_MULMOD_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 434    \return MP_TO_E メッセージ署名の計算中にエラーがある場合に返される可能性があります
 435    \return MP_MEM メッセージ署名の計算中にエラーがある場合に返される可能性があります
 436
 437    \param sig 検証する署名を含むバッファへのポインタ
 438    \param siglen 検証する署名の長さ
 439    \param hash 検証されたメッセージのハッシュを含むバッファへのポインタ
 440    \param hashlen 検証されたメッセージのハッシュの長さ
 441    \param stat 検証結果へのポインタ。1はメッセージが正常に検証されたことを示します
 442    \param key 署名を検証するために使用する公開ECCキーへのポインタ
 443
 444    _Example_
 445    \code
 446    ecc_key key;
 447    int ret, verified = 0;
 448
 449    byte sig[1024] { 受信した署名で初期化 };
 450    byte digest[] = { メッセージハッシュで初期化 };
 451    // 受信した公開鍵でキーを初期化
 452    ret = wc_ecc_verify_hash(sig, sizeof(sig), digest,sizeof(digest),
 453    &verified, &key);
 454    if ( ret != 0 ) {
 455	    // 検証実行エラー
 456    } else if ( verified == 0 ) {
 457	    // 署名が無効
 458    }
 459    \endcode
 460
 461    \sa wc_ecc_sign_hash
 462    \sa wc_ecc_verify_hash_ex
 463*/
 464
 465int wc_ecc_verify_hash(const byte* sig, word32 siglen, const byte* hash,
 466                    word32 hashlen, int* stat, ecc_key* key);
 467
 468/*!
 469    \ingroup ECC
 470
 471    \brief ECC署名を検証します。結果はstatに書き込まれます。1は有効、0は無効です。注：有効性のテストに戻り値を使用しないでください。statのみを使用してください。
 472
 473    \return MP_OKAY 成功した場合（署名が有効でない場合でも）
 474    \return ECC_BAD_ARG_E 引数がnullの場合、またはkey-idxが無効な場合に返されます。
 475    \return MEMORY_E 整数またはポイントの割り当てエラー。
 476
 477    \param r 検証する署名のR成分
 478    \param s 検証する署名のS成分
 479    \param hash 署名されたハッシュ（メッセージダイジェスト）
 480    \param hashlen ハッシュの長さ（オクテット）
 481    \param stat 署名の結果、1==有効、0==無効
 482    \param key 対応する公開ECCキー
 483
 484    _Example_
 485    \code
 486    mp_int r;
 487    mp_int s;
 488    int stat;
 489    byte hash[] = { いくつかのハッシュ }
 490    ecc_key key;
 491
 492    if(wc_ecc_verify_hash_ex(&r, &s, hash, hashlen, &stat, &key) == MP_OKAY)
 493    {
 494        // statをチェック
 495    }
 496    \endcode
 497
 498    \sa wc_ecc_verify_hash
 499*/
 500
 501int wc_ecc_verify_hash_ex(mp_int *r, mp_int *s, const byte* hash,
 502                          word32 hashlen, int* stat, ecc_key* key);
 503
 504/*!
 505    \ingroup ECC
 506
 507    \brief この関数は、メッセージ検証または鍵交換で将来使用するためにecc_keyオブジェクトを初期化します。
 508
 509    \return 0 ecc_keyオブジェクトの初期化に成功した場合に返されます
 510    \return MEMORY_E メモリ割り当てエラーがある場合に返されます
 511
 512    \param key 初期化するecc_keyオブジェクトへのポインタ
 513
 514    _Example_
 515    \code
 516    ecc_key key;
 517    wc_ecc_init(&key);
 518    \endcode
 519
 520    \sa wc_ecc_make_key
 521    \sa wc_ecc_free
 522*/
 523
 524int wc_ecc_init(ecc_key* key);
 525
 526/*!
 527    \ingroup ECC
 528
 529    \brief この関数は、メッセージ検証または鍵交換で将来使用するためにecc_keyオブジェクトを初期化します。
 530
 531    \return 0 ecc_keyオブジェクトの初期化に成功した場合に返されます
 532    \return MEMORY_E メモリ割り当てエラーがある場合に返されます
 533
 534    \param key 初期化するecc_keyオブジェクトへのポインタ
 535    \param heap ヒープ識別子へのポインタ
 536    \param devId 暗号コールバックまたは非同期ハードウェアで使用するID。使用しない場合はINVALID_DEVID（-2）に設定
 537
 538    _Example_
 539    \code
 540    ecc_key key;
 541    wc_ecc_init_ex(&key, heap, devId);
 542    \endcode
 543
 544    \sa wc_ecc_make_key
 545    \sa wc_ecc_free
 546    \sa wc_ecc_init
 547*/
 548
 549int wc_ecc_init_ex(ecc_key* key, void* heap, int devId);
 550
 551/*!
 552    \ingroup ECC
 553
 554    \brief この関数は、ユーザー定義のヒープを使用し、キー構造体用のスペースを割り当てます。
 555
 556    \return 0 ecc_keyオブジェクトの初期化に成功した場合に返されます
 557    \return MEMORY_E メモリ割り当てエラーがある場合に返されます
 558
 559
 560    _Example_
 561    \code
 562    wc_ecc_key_new(&heap);
 563    \endcode
 564
 565    \sa wc_ecc_make_key
 566    \sa wc_ecc_key_free
 567    \sa wc_ecc_init
 568*/
 569
 570ecc_key* wc_ecc_key_new(void* heap);
 571
 572/*!
 573    \ingroup ECC
 574
 575    \brief この関数は、使用後にecc_keyオブジェクトを解放します。
 576
 577    \return int wolfSSLのエラーまたは成功ステータスを示す整数が返されます。
 578
 579    \param key 解放するecc_keyオブジェクトへのポインタ
 580
 581    _Example_
 582    \code
 583    // キーを初期化して安全な交換を実行
 584    ...
 585    wc_ecc_free(&key);
 586    \endcode
 587
 588    \sa wc_ecc_init
 589*/
 590
 591int wc_ecc_free(ecc_key* key);
 592
 593/*!
 594    \ingroup ECC
 595
 596    \brief この関数は、固定小数点キャッシュを解放します。これは計算時間を高速化するためにeccで使用できます。この機能を使用するには、FP_ECC（固定小数点ecc）を定義する必要があります。スレッド化されたアプリケーションは、スレッドを終了する前にこの関数を呼び出す必要があります。
 597
 598    \return none 返り値なし。
 599
 600    \param none パラメータなし。
 601
 602    _Example_
 603    \code
 604    ecc_key key;
 605    // キーを初期化して安全な交換を実行
 606    ...
 607
 608    wc_ecc_fp_free();
 609    \endcode
 610
 611    \sa wc_ecc_free
 612*/
 613
 614void wc_ecc_fp_free(void);
 615
 616/*!
 617    \ingroup ECC
 618
 619    \brief ECC idxが有効かどうかをチェックします。
 620
 621    \return 1 有効な場合に返されます。
 622    \return 0 有効でない場合に返されます。
 623
 624    \param n チェックするidx番号。
 625
 626    _Example_
 627    \code
 628    ecc_key key;
 629    WC_RNG rng;
 630    int is_valid;
 631    wc_ecc_init(&key);
 632    wc_InitRng(&rng);
 633    wc_ecc_make_key(&rng, 32, &key);
 634    is_valid = wc_ecc_is_valid_idx(key.idx);
 635    if (is_valid == 1)
 636    {
 637        // idxは有効
 638    }
 639    else if (is_valid == 0)
 640    {
 641        // idxは無効
 642    }
 643    \endcode
 644
 645    \sa なし
 646*/
 647
 648int wc_ecc_is_valid_idx(int n);
 649/*!
 650    \ingroup ECC
 651
 652    \brief 新しいECCポイントを割り当てます。
 653
 654    \return p 新しく割り当てられたポイント。
 655    \return NULL エラー時にNULLを返します。
 656
 657    \param none パラメータなし。
 658
 659    _Example_
 660    \code
 661    ecc_point* point;
 662    point = wc_ecc_new_point();
 663    if (point == NULL)
 664    {
 665        // ポイント作成エラーを処理
 666    }
 667    // ポイントで何かを行う
 668    \endcode
 669
 670    \sa wc_ecc_del_point
 671    \sa wc_ecc_cmp_point
 672    \sa wc_ecc_copy_point
 673*/
 674
 675ecc_point* wc_ecc_new_point(void);
 676
 677/*!
 678    \ingroup ECC
 679
 680    \brief メモリからECCポイントを解放します。
 681
 682    \return none 返り値なし。
 683
 684    \param p 解放するポイント。
 685
 686    _Example_
 687    \code
 688    ecc_point* point;
 689    point = wc_ecc_new_point();
 690    if (point == NULL)
 691    {
 692        // ポイント作成エラーを処理
 693    }
 694    // ポイントで何かを行う
 695    wc_ecc_del_point(point);
 696    \endcode
 697
 698    \sa wc_ecc_new_point
 699    \sa wc_ecc_cmp_point
 700    \sa wc_ecc_copy_point
 701*/
 702
 703void wc_ecc_del_point(ecc_point* p);
 704
 705/*!
 706    \ingroup ECC
 707
 708    \brief あるポイントの値を別のポイントにコピーします。
 709
 710    \return ECC_BAD_ARG_E pまたはrがnullの場合にスローされるエラー。
 711    \return MP_OKAY ポイントが正常にコピーされました
 712    \return ret 内部関数からのエラー。次のような可能性があります...
 713
 714    \param p コピーするポイント。
 715    \param r 作成されたポイント。
 716
 717    _Example_
 718    \code
 719    ecc_point* point;
 720    ecc_point* copied_point;
 721    int copy_return;
 722
 723    point = wc_ecc_new_point();
 724    copy_return = wc_ecc_copy_point(point, copied_point);
 725    if (copy_return != MP_OKAY)
 726    {
 727        // エラーを処理
 728    }
 729    \endcode
 730
 731    \sa wc_ecc_new_point
 732    \sa wc_ecc_cmp_point
 733    \sa wc_ecc_del_point
 734*/
 735
 736int wc_ecc_copy_point(const ecc_point* p, ecc_point *r);
 737
 738/*!
 739    \ingroup ECC
 740
 741    \brief ポイントの値を別のポイントと比較します。
 742
 743    \return BAD_FUNC_ARG 一方または両方の引数がNULL。
 744    \return MP_EQ ポイントが等しい。
 745    \return ret MP_LTまたはMP_GTのいずれかで、ポイントが等しくないことを示します。
 746
 747    \param a 比較する最初のポイント。
 748    \param b 比較する2番目のポイント。
 749
 750    _Example_
 751    \code
 752    ecc_point* point;
 753    ecc_point* point_to_compare;
 754    int cmp_result;
 755
 756    point = wc_ecc_new_point();
 757    point_to_compare = wc_ecc_new_point();
 758    cmp_result = wc_ecc_cmp_point(point, point_to_compare);
 759    if (cmp_result == BAD_FUNC_ARG)
 760    {
 761        // 引数が無効
 762    }
 763    else if (cmp_result == MP_EQ)
 764    {
 765        // ポイントが等しい
 766    }
 767    else
 768    {
 769        // ポイントが等しくない
 770    }
 771    \endcode
 772
 773    \sa wc_ecc_new_point
 774    \sa wc_ecc_del_point
 775    \sa wc_ecc_copy_point
 776*/
 777
 778int wc_ecc_cmp_point(ecc_point* a, ecc_point *b);
 779
 780/*!
 781    \ingroup ECC
 782
 783    \brief ポイントが無限遠点にあるかどうかをチェックします。ポイントが無限遠点にある場合は1を返し、そうでない場合は0を返し、エラーの場合は<0を返します
 784
 785    \return 1 pが無限遠点にある。
 786    \return 0 pが無限遠点にない。
 787    \return <0 エラー。
 788
 789    \param p チェックするポイント。
 790
 791    _Example_
 792    \code
 793    ecc_point* point;
 794    int is_infinity;
 795    point = wc_ecc_new_point();
 796
 797    is_infinity = wc_ecc_point_is_at_infinity(point);
 798    if (is_infinity < 0)
 799    {
 800        // エラーを処理
 801    }
 802    else if (is_infinity == 0)
 803    {
 804        // ポイントは無限遠点にない
 805    }
 806    else if (is_infinity == 1)
 807    {
 808        // ポイントは無限遠点にある
 809    }
 810    \endcode
 811
 812    \sa wc_ecc_new_point
 813    \sa wc_ecc_del_point
 814    \sa wc_ecc_cmp_point
 815    \sa wc_ecc_copy_point
 816*/
 817
 818int wc_ecc_point_is_at_infinity(ecc_point *p);
 819
 820/*!
 821    \ingroup ECC
 822
 823    \brief ECC固定点乗算を実行します。
 824
 825    \return MP_OKAY 操作が成功した場合に返されます。
 826    \return MP_INIT_E 多精度整数（mp_int）ライブラリで使用するために整数を初期化する際にエラーがある場合に返されます。
 827
 828    \param k 被乗数。
 829    \param G 乗算する基点。
 830    \param R 積の出力先。
 831    \param modulus カーブのモジュラス。
 832    \param map ゼロでない場合、ポイントをアフィン座標に戻してマップします。そうでない場合は、ヤコビ・モンゴメリー形式のままです。
 833
 834    _Example_
 835    \code
 836    ecc_point* base;
 837    ecc_point* destination;
 838    // ポイントを初期化
 839    base = wc_ecc_new_point();
 840    destination = wc_ecc_new_point();
 841    // 他の引数を設定
 842    mp_int multiplicand;
 843    mp_int modulus;
 844    int map;
 845    \endcode
 846
 847    \sa なし
 848*/
 849
 850int wc_ecc_mulmod(const mp_int* k, ecc_point *G, ecc_point *R,
 851                  mp_int* a, mp_int* modulus, int map);
 852
 853/*!
 854    \ingroup ECC
 855
 856    \brief この関数は、ecc_key構造体からECCキーをエクスポートし、結果をoutに格納します。キーはANSI X9.63形式で格納されます。出力バッファに書き込まれたバイト数をoutLenに格納します。
 857
 858    \return 0 ecc_keyのエクスポートに成功した場合に返されます
 859    \return LENGTH_ONLY_E 出力バッファがNULLと評価されるが、他の2つの入力パラメータが有効な場合に返されます。関数がキーを格納するために必要な長さのみを返していることを示します
 860    \return ECC_BAD_ARG_E いずれかの入力パラメータがNULLの場合、またはキーがサポートされていない（無効なインデックスを持つ）場合に返されます
 861    \return BUFFER_E 出力バッファがeccキーを格納するには小さすぎる場合に返されます。出力バッファが小さすぎる場合、必要なサイズがoutLenで返されます
 862    \return MEMORY_E XMALLOCでメモリを割り当てる際にエラーがある場合に返されます
 863    \return MP_INIT_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 864    \return MP_READ_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 865    \return MP_CMP_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 866    \return MP_INVMOD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 867    \return MP_EXPTMOD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 868    \return MP_MOD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 869    \return MP_MUL_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 870    \return MP_ADD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 871    \return MP_MULMOD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 872    \return MP_TO_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 873    \return MP_MEM ecc_keyの処理中にエラーがある場合に返される可能性があります
 874
 875    \param key エクスポートするecc_keyオブジェクトへのポインタ
 876    \param out ANSI X9.63形式のキーを格納するバッファへのポインタ
 877    \param outLen 出力バッファのサイズ。キーの格納に成功すると、出力バッファに書き込まれたバイト数を保持します
 878
 879    _Example_
 880    \code
 881    int ret;
 882    byte buff[1024];
 883    word32 buffSz = sizeof(buff);
 884
 885    ecc_key key;
 886    // キーを初期化し、キーを作成
 887    ret = wc_ecc_export_x963(&key, buff, &buffSz);
 888    if ( ret != 0) {
 889    	// キーのエクスポートエラー
 890    }
 891    \endcode
 892
 893    \sa wc_ecc_export_x963_ex
 894    \sa wc_ecc_import_x963
 895    \sa wc_ecc_make_pub
 896*/
 897
 898int wc_ecc_export_x963(ecc_key* key, byte* out, word32* outLen);
 899
 900/*!
 901    \ingroup ECC
 902
 903    \brief この関数は、ecc_key構造体から公開鍵をエクスポートし、結果をoutに格納します。キーはANSI X9.63形式で格納されます。出力バッファに書き込まれたバイト数をoutLenに格納します。この関数は、compressedパラメータを通じて証明書を圧縮する追加オプションを提供します。このパラメータがtrueの場合、キーはANSI X9.63圧縮形式で格納されます。
 904
 905    \return 0 ecc_key公開成分のエクスポートに成功した場合に返されます
 906    \return ECC_PRIVATEKEY_ONLY ecc_key公開成分が欠落している場合に返されます
 907    \return NOT_COMPILED_IN コンパイル時にHAVE_COMP_KEYが有効になっていないが、キーが圧縮形式で要求された場合に返されます
 908    \return LENGTH_ONLY_E 出力バッファがNULLと評価されるが、他の2つの入力パラメータが有効な場合に返されます。関数が公開鍵を格納するために必要な長さのみを返していることを示します
 909    \return ECC_BAD_ARG_E いずれかの入力パラメータがNULLの場合、またはキーがサポートされていない（無効なインデックスを持つ）場合に返されます
 910    \return BUFFER_E 出力バッファが公開鍵を格納するには小さすぎる場合に返されます。出力バッファが小さすぎる場合、必要なサイズがoutLenで返されます
 911    \return MEMORY_E XMALLOCでメモリを割り当てる際にエラーがある場合に返されます
 912    \return MP_INIT_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 913    \return MP_READ_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 914    \return MP_CMP_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 915    \return MP_INVMOD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 916    \return MP_EXPTMOD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 917    \return MP_MOD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 918    \return MP_MUL_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 919    \return MP_ADD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 920    \return MP_MULMOD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 921    \return MP_TO_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 922    \return MP_MEM ecc_keyの処理中にエラーがある場合に返される可能性があります
 923
 924    \param key エクスポートするecc_keyオブジェクトへのポインタ
 925    \param out ANSI X9.63形式の公開鍵を格納するバッファへのポインタ
 926    \param outLen 出力バッファのサイズ。公開鍵の格納に成功すると、出力バッファに書き込まれたバイト数を保持します
 927    \param compressed キーを圧縮形式で格納するかどうかの指標。1==圧縮、0==非圧縮
 928
 929    _Example_
 930    \code
 931    int ret;
 932    byte buff[1024];
 933    word32 buffSz = sizeof(buff);
 934    ecc_key key;
 935    // キーを初期化し、キーを作成
 936    ret = wc_ecc_export_x963_ex(&key, buff, &buffSz, 1);
 937    if ( ret != 0) {
 938	    // キーのエクスポートエラー
 939    }
 940    \endcode
 941
 942    \sa wc_ecc_export_x963
 943    \sa wc_ecc_import_x963
 944    \sa wc_ecc_make_pub
 945*/
 946
 947int wc_ecc_export_x963_ex(ecc_key* key, byte* out, word32* outLen, int compressed);
 948
 949/*!
 950    \ingroup ECC
 951
 952    \brief この関数は、ANSI X9.63形式で格納されたキーを含むバッファから公開ECCキーをインポートします。この関数は、コンパイル時にHAVE_COMP_KEYオプションを通じて圧縮キーが有効になっている限り、圧縮キーと非圧縮キーの両方を処理します。
 953
 954    \return 0 ecc_keyのインポートに成功した場合に返されます
 955    \return NOT_COMPILED_IN コンパイル時にHAVE_COMP_KEYが有効になっていないが、キーが圧縮形式で格納されている場合に返されます
 956    \return ECC_BAD_ARG_E inまたはkeyがNULLと評価される場合、またはinLenが偶数の場合に返されます（x9.63標準によると、キーは奇数でなければなりません）
 957    \return MEMORY_E メモリの割り当てエラーがある場合に返されます
 958    \return ASN_PARSE_E ECCキーの解析エラーがある場合に返されます。ECCキーが有効なANSI X9.63形式で格納されていないことを示す可能性があります
 959    \return IS_POINT_E エクスポートされた公開鍵がECC曲線上のポイントでない場合に返されます
 960    \return MP_INIT_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 961    \return MP_READ_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 962    \return MP_CMP_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 963    \return MP_INVMOD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 964    \return MP_EXPTMOD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 965    \return MP_MOD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 966    \return MP_MUL_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 967    \return MP_ADD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 968    \return MP_MULMOD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 969    \return MP_TO_E ecc_keyの処理中にエラーがある場合に返される可能性があります
 970    \return MP_MEM ecc_keyの処理中にエラーがある場合に返される可能性があります
 971
 972    \param in ANSI x9.63形式のECCキーを含むバッファへのポインタ
 973    \param inLen 入力バッファの長さ
 974    \param key インポートされたキーを格納するecc_keyオブジェクトへのポインタ
 975
 976    _Example_
 977    \code
 978    int ret;
 979    byte buff[] = { ANSI X9.63形式のキーで初期化 };
 980
 981    ecc_key pubKey;
 982    wc_ecc_init(&pubKey);
 983
 984    ret = wc_ecc_import_x963(buff, sizeof(buff), &pubKey);
 985    if ( ret != 0) {
 986    	// キーのインポートエラー
 987    }
 988    \endcode
 989
 990    \sa wc_ecc_export_x963
 991    \sa wc_ecc_import_private_key
 992*/
 993
 994int wc_ecc_import_x963(const byte* in, word32 inLen, ecc_key* key);
 995
 996/*!
 997    \ingroup ECC
 998
 999    \brief この関数は、生の秘密鍵を含むバッファとANSI X9.63形式の公開鍵を含む2番目のバッファから公開/秘密ECCキーペアをインポートします。この関数は、コンパイル時にHAVE_COMP_KEYオプションを通じて圧縮キーが有効になっている限り、圧縮キーと非圧縮キーの両方を処理します。
1000
1001    \return 0 ecc_keyのインポートに成功した場合に返されます
1002    NOT_COMPILED_IN コンパイル時にHAVE_COMP_KEYが有効になっていないが、キーが圧縮形式で格納されている場合に返されます
1003    \return ECC_BAD_ARG_E inまたはkeyがNULLと評価される場合、またはinLenが偶数の場合に返されます（x9.63標準によると、キーは奇数でなければなりません）
1004    \return MEMORY_E メモリの割り当てエラーがある場合に返されます
1005    \return ASN_PARSE_E ECCキーの解析エラーがある場合に返されます。ECCキーが有効なANSI X9.63形式で格納されていないことを示す可能性があります
1006    \return IS_POINT_E エクスポートされた公開鍵がECC曲線上のポイントでない場合に返されます
1007    \return MP_INIT_E ecc_keyの処理中にエラーがある場合に返される可能性があります
1008    \return MP_READ_E ecc_keyの処理中にエラーがある場合に返される可能性があります
1009    \return MP_CMP_E ecc_keyの処理中にエラーがある場合に返される可能性があります
1010    \return MP_INVMOD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
1011    \return MP_EXPTMOD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
1012    \return MP_MOD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
1013    \return MP_MUL_E ecc_keyの処理中にエラーがある場合に返される可能性があります
1014    \return MP_ADD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
1015    \return MP_MULMOD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
1016    \return MP_TO_E ecc_keyの処理中にエラーがある場合に返される可能性があります
1017    \return MP_MEM ecc_keyの処理中にエラーがある場合に返される可能性があります
1018
1019    \param priv 生の秘密鍵を含むバッファへのポインタ
1020    \param privSz 秘密鍵バッファのサイズ
1021    \param pub ANSI x9.63形式のECC公開鍵を含むバッファへのポインタ
1022    \param pubSz 公開鍵入力バッファの長さ
1023    \param key インポートされた秘密/公開鍵ペアを格納するecc_keyオブジェクトへのポインタ
1024
1025    _Example_
1026    \code
1027    int ret;
1028    byte pub[] = { ANSI X9.63形式のキーで初期化 };
1029    byte priv[] = { 生の秘密鍵で初期化 };
1030
1031    ecc_key key;
1032    wc_ecc_init(&key);
1033    ret = wc_ecc_import_private_key(priv, sizeof(priv), pub, sizeof(pub),
1034    &key);
1035    if ( ret != 0) {
1036    	// キーのインポートエラー
1037    }
1038    \endcode
1039
1040    \sa wc_ecc_export_x963
1041    \sa wc_ecc_import_private_key
1042*/
1043
1044int wc_ecc_import_private_key(const byte* priv, word32 privSz, const byte* pub,
1045                           word32 pubSz, ecc_key* key);
1046
1047/*!
1048    \ingroup ECC
1049
1050    \brief この関数は、ECC署名のRとS部分をDERエンコードされたECDSA署名に変換します。この関数は、出力バッファoutに書き込まれた長さもoutlenに格納します。
1051
1052    \return 0 署名の変換に成功した場合に返されます
1053    \return ECC_BAD_ARG_E いずれかの入力パラメータがNULLと評価される場合、または入力バッファがDERエンコードされたECDSA署名を保持するのに十分な大きさでない場合に返されます
1054    \return MP_INIT_E ecc_keyの処理中にエラーがある場合に返される可能性があります
1055    \return MP_READ_E ecc_keyの処理中にエラーがある場合に返される可能性があります
1056    \return MP_CMP_E ecc_keyの処理中にエラーがある場合に返される可能性があります
1057    \return MP_INVMOD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
1058    \return MP_EXPTMOD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
1059    \return MP_MOD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
1060    \return MP_MUL_E ecc_keyの処理中にエラーがある場合に返される可能性があります
1061    \return MP_ADD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
1062    \return MP_MULMOD_E ecc_keyの処理中にエラーがある場合に返される可能性があります
1063    \return MP_TO_E ecc_keyの処理中にエラーがある場合に返される可能性があります
1064    \return MP_MEM ecc_keyの処理中にエラーがある場合に返される可能性があります
1065
1066    \param r 文字列として署名のR部分を含むバッファへのポインタ
1067    \param s 文字列として署名のS部分を含むバッファへのポインタ
1068    \param out DERエンコードされたECDSA署名を格納するバッファへのポインタ
1069    \param outlen 利用可能な出力バッファの長さ。署名をECDSA形式に正常に変換した後、バッファに書き込まれたバイト数を格納します
1070
1071    _Example_
1072    \code
1073    int ret;
1074    ecc_key key;
1075    // キーを初期化し、RとSを生成
1076
1077    char r[] = { Rで初期化 };
1078    char s[] = { Sで初期化 };
1079    byte sig[wc_ecc_sig_size(key)];
1080    // 署名サイズは2 * ECCキーサイズ + ASN.1オーバーヘッド用の約10バイトになります
1081    word32 sigSz = sizeof(sig);
1082    ret = wc_ecc_rs_to_sig(r, s, sig, &sigSz);
1083    if ( ret != 0) {
1084    	// パラメータから署名への変換エラー
1085    }
1086    \endcode
1087
1088    \sa wc_ecc_sign_hash
1089    \sa wc_ecc_sig_size
1090*/
1091
1092int wc_ecc_rs_to_sig(const char* r, const char* s, byte* out, word32* outlen);
1093
1094/*!
1095    \ingroup ECC
1096
1097    \brief この関数は、ECC署名の生の成分でecc_key構造体を埋めます。
1098
1099    \return 0 ecc_key構造体へのインポートに成功した場合に返されます
1100    \return ECC_BAD_ARG_E いずれかの入力値がNULLと評価された場合に返されます
1101    \return MEMORY_E ecc_keyのパラメータを格納するためのスペースを初期化する際にエラーがある場合に返されます
1102    \return ASN_PARSE_E 入力curveNameがecc_setsで定義されていない場合に返されます
1103    \return MP_INIT_E 入力パラメータの処理中にエラーがある場合に返される可能性があります
1104    \return MP_READ_E 入力パラメータの処理中にエラーがある場合に返される可能性があります
1105    \return MP_CMP_E 入力パラメータの処理中にエラーがある場合に返される可能性があります
1106    \return MP_INVMOD_E 入力パラメータの処理中にエラーがある場合に返される可能性があります
1107    \return MP_EXPTMOD_E 入力パラメータの処理中にエラーがある場合に返される可能性があります
1108    \return MP_MOD_E 入力パラメータの処理中にエラーがある場合に返される可能性があります
1109    \return MP_MUL_E 入力パラメータの処理中にエラーがある場合に返される可能性があります
1110    \return MP_ADD_E 入力パラメータの処理中にエラーがある場合に返される可能性があります
1111    \return MP_MULMOD_E 入力パラメータの処理中にエラーがある場合に返される可能性があります
1112    \return MP_TO_E 入力パラメータの処理中にエラーがある場合に返される可能性があります
1113    \return MP_MEM 入力パラメータの処理中にエラーがある場合に返される可能性があります
1114
1115    \param key 埋めるecc_key構造体へのポインタ
1116    \param qx ASCII 16進文字列として基点のx成分を含むバッファへのポインタ
1117    \param qy ASCII 16進文字列として基点のy成分を含むバッファへのポインタ
1118    \param d ASCII 16進文字列として秘密鍵を含むバッファへのポインタ
1119    \param curveName ecc_setsにあるECC曲線名を含む文字列へのポインタ
1120
1121    _Example_
1122    \code
1123    int ret;
1124    ecc_key key;
1125    wc_ecc_init(&key);
1126
1127    char qx[] = { 基点のx成分で初期化 };
1128    char qy[] = { 基点のy成分で初期化 };
1129    char d[]  = { 秘密鍵で初期化 };
1130    ret = wc_ecc_import_raw(&key,qx, qy, d, "ECC-256");
1131    if ( ret != 0) {
1132    	// 指定された入力でキーを初期化する際のエラー
1133    }
1134    \endcode
1135
1136    \sa wc_ecc_import_private_key
1137*/
1138
1139int wc_ecc_import_raw(ecc_key* key, const char* qx, const char* qy,
1140                   const char* d, const char* curveName);
1141
1142/*!
1143    \ingroup ECC
1144
1145    \brief この関数は、ecc_key構造体から秘密鍵のみをエクスポートします。秘密鍵をバッファoutに格納し、このバッファに書き込まれたバイト数をoutLenに設定します。
1146
1147    \return 0 秘密鍵のエクスポートに成功した場合に返されます
1148    \return ECC_BAD_ARG_E いずれかの入力値がNULLと評価された場合に返されます
1149    \return MEMORY_E ecc_keyのパラメータを格納するためのスペースを初期化する際にエラーがある場合に返されます
1150    \return ASN_PARSE_E 入力curveNameがecc_setsで定義されていない場合に返されます
1151    \return MP_INIT_E 入力パラメータの処理中にエラーがある場合に返される可能性があります
1152    \return MP_READ_E 入力パラメータの処理中にエラーがある場合に返される可能性があります
1153    \return MP_CMP_E 入力パラメータの処理中にエラーがある場合に返される可能性があります
1154    \return MP_INVMOD_E 入力パラメータの処理中にエラーがある場合に返される可能性があります
1155    \return MP_EXPTMOD_E 入力パラメータの処理中にエラーがある場合に返される可能性があります
1156    \return MP_MOD_E 入力パラメータの処理中にエラーがある場合に返される可能性があります
1157    \return MP_MUL_E 入力パラメータの処理中にエラーがある場合に返される可能性があります
1158    \return MP_ADD_E 入力パラメータの処理中にエラーがある場合に返される可能性があります
1159    \return MP_MULMOD_E 入力パラメータの処理中にエラーがある場合に返される可能性があります
1160    \return MP_TO_E 入力パラメータの処理中にエラーがある場合に返される可能性があります
1161    \return MP_MEM 入力パラメータの処理中にエラーがある場合に返される可能性があります
1162
1163    \param key 秘密鍵をエクスポートするecc_key構造体へのポインタ
1164    \param out 秘密鍵を格納するバッファへのポインタ
1165    \param outLen outで利用可能なサイズを持つword32オブジェクトへのポインタ。秘密鍵のエクスポートに成功した後、outに書き込まれたバイト数で設定されます
1166
1167    _Example_
1168    \code
1169    int ret;
1170    ecc_key key;
1171    // キーを初期化し、キーを作成
1172
1173    char priv[ECC_KEY_SIZE];
1174    word32 privSz = sizeof(priv);
1175    ret = wc_ecc_export_private_only(&key, priv, &privSz);
1176    if ( ret != 0) {
1177    	// 秘密鍵のエクスポートエラー
1178    }
1179    \endcode
1180
1181    \sa wc_ecc_import_private_key
1182*/
1183
1184int wc_ecc_export_private_only(ecc_key* key, byte* out, word32* outLen);
1185
1186/*!
1187    \ingroup ECC
1188
1189    \brief ポイントをder形式にエクスポートします。
1190
1191    \return 0 成功時に返されます。
1192    \return ECC_BAD_ARG_E curve_idxが0未満または無効な場合に返されます。また、次の場合にも返されます
1193    \return LENGTH_ONLY_E outLenが設定されているが他は何もない。
1194    \return BUFFER_E outLenが1 + 2 * カーブサイズ未満の場合に返されます。
1195    \return MEMORY_E メモリの割り当てに問題がある場合に返されます。
1196
1197    \param curve_idx ecc_setsから使用されるカーブのインデックス。
1198    \param point derにエクスポートするポイント。
1199    \param out 出力の出力先。
1200    \param outLen 出力に許可される最大サイズ、出力の最終サイズの出力先
1201
1202    _Example_
1203    \code
1204    int curve_idx;
1205    ecc_point* point;
1206    byte out[];
1207    word32 outLen;
1208    wc_ecc_export_point_der(curve_idx, point, out, &outLen);
1209    \endcode
1210
1211    \sa wc_ecc_import_point_der
1212*/
1213
1214int wc_ecc_export_point_der(const int curve_idx, ecc_point* point,
1215                            byte* out, word32* outLen);
1216
1217/*!
1218    \ingroup ECC
1219
1220    \brief der形式からポイントをインポートします。
1221
1222    \return ECC_BAD_ARG_E いずれかの引数がnullの場合、またはinLenが偶数の場合に返されます。
1223    \return MEMORY_E 初期化中にエラーがある場合に返されます
1224    \return NOT_COMPILED_IN HAVE_COMP_KEYがtrueでなく、inが圧縮証明書の場合に返されます
1225    \return MP_OKAY 操作が成功しました。
1226
1227    \param in ポイントをインポートするderバッファ。
1228    \param inLen derバッファの長さ。
1229    \param curve_idx カーブのインデックス。
1230    \param point ポイントの出力先。
1231
1232    _Example_
1233    \code
1234    byte in[];
1235    word32 inLen;
1236    int curve_idx;
1237    ecc_point* point;
1238    wc_ecc_import_point_der(in, inLen, curve_idx, point);
1239    \endcode
1240
1241    \sa wc_ecc_export_point_der
1242*/
1243
1244int wc_ecc_import_point_der(const byte* in, word32 inLen, const int curve_idx,
1245                            ecc_point* point);
1246
1247/*!
1248    \ingroup ECC
1249
1250    \brief この関数は、ecc_key構造体のキーサイズをオクテット単位で返します。
1251
1252    \return Given a valid key, 有効なキーが与えられた場合、キーサイズをオクテット単位で返します
1253    \return 0 指定されたキーがNULLの場合に返されます
1254
1255    \param key キーサイズを取得するecc_key構造体へのポインタ
1256
1257    _Example_
1258    \code
1259    int keySz;
1260    ecc_key key;
1261    // キーを初期化し、キーを作成
1262    keySz = wc_ecc_size(&key);
1263    if ( keySz == 0) {
1264    	// キーサイズの判定エラー
1265    }
1266    \endcode
1267
1268    \sa wc_ecc_make_key
1269*/
1270
1271int wc_ecc_size(ecc_key* key);
1272
1273/*!
1274    \ingroup ECC
1275
1276    \brief この関数は、ECC署名の最悪の場合のサイズを返します。これは（keySz * 2）+ SIG_HEADER_SZ + ECC_MAX_PAD_SZで与えられます。実際の署名サイズは、wc_ecc_sign_hashで計算できます。
1277
1278    \return returns 最大署名サイズをオクテット単位で返します
1279
1280    \param key size キーサイズ
1281
1282    _Example_
1283    \code
1284    int sigSz = wc_ecc_sig_size_calc(32);
1285    if ( sigSz == 0) {
1286    	// 署名サイズの判定エラー
1287    }
1288    \endcode
1289
1290    \sa wc_ecc_sign_hash
1291    \sa wc_ecc_sig_size
1292*/
1293
1294int wc_ecc_sig_size_calc(int sz);
1295
1296
1297/*!
1298    \ingroup ECC
1299
1300    \brief この関数は、ECC署名の最悪の場合のサイズを返します。これは（keySz * 2）+ SIG_HEADER_SZ + ECC_MAX_PAD_SZで与えられます。実際の署名サイズは、wc_ecc_sign_hashで計算できます。
1301    \return Success 有効なキーが与えられた場合、最大署名サイズをオクテット単位で返します
1302    \return 0 指定されたキーがNULLの場合に返されます
1303
1304    \param key 署名サイズを取得するecc_key構造体へのポインタ
1305
1306    _Example_
1307    \code
1308    int sigSz;
1309    ecc_key key;
1310    // キーを初期化し、キーを作成
1311
1312    sigSz = wc_ecc_sig_size(&key);
1313    if ( sigSz == 0) {
1314        // 署名サイズの判定エラー
1315    }
1316    \endcode
1317
1318    \sa wc_ecc_sign_hash
1319    \sa wc_ecc_sig_size_calc
1320*/
1321
1322int wc_ecc_sig_size(const ecc_key* key);
1323
1324
1325/*!
1326    \ingroup ECC
1327
1328    \brief この関数は、ECCを使用した安全なメッセージ交換を可能にするために、新しいECCコンテキストオブジェクト用のスペースを割り当てて初期化します。
1329
1330    \return Success 新しいecEncCtxオブジェクトの生成に成功すると、そのオブジェクトへのポインタを返します
1331    \return NULL 関数が新しいecEncCtxオブジェクトの生成に失敗した場合に返されます
1332
1333    \param flags これがサーバーコンテキストかクライアントコンテキストかを示します
1334    オプションは：REQ_RESP_CLIENTおよびREQ_RESP_SERVER
1335    \param rng ソルトを生成するために使用するRNGオブジェクトへのポインタ
1336
1337    _Example_
1338    \code
1339    ecEncCtx* ctx;
1340    WC_RNG rng;
1341    wc_InitRng(&rng);
1342    ctx = wc_ecc_ctx_new(REQ_RESP_CLIENT, &rng);
1343    if(ctx == NULL) {
1344        // 新しいecEncCtxオブジェクトの生成エラー
1345    }
1346    \endcode
1347
1348    \sa wc_ecc_encrypt
1349    \sa wc_ecc_encrypt_ex
1350    \sa wc_ecc_decrypt
1351*/
1352
1353ecEncCtx* wc_ecc_ctx_new(int flags, WC_RNG* rng);
1354
1355/*!
1356    \ingroup ECC
1357
1358    \brief この関数は、メッセージの暗号化と復号に使用されるecEncCtxオブジェクトを解放します。
1359
1360    \return none 返り値なし。
1361
1362    \param ctx 解放するecEncCtxオブジェクトへのポインタ
1363
1364    _Example_
1365    \code
1366    ecEncCtx* ctx;
1367    WC_RNG rng;
1368    wc_InitRng(&rng);
1369    ctx = wc_ecc_ctx_new(REQ_RESP_CLIENT, &rng);
1370    // 安全な通信を行う
1371    ...
1372    wc_ecc_ctx_free(&ctx);
1373    \endcode
1374
1375    \sa wc_ecc_ctx_new
1376*/
1377
1378void wc_ecc_ctx_free(ecEncCtx* ctx);
1379
1380/*!
1381    \ingroup ECC
1382
1383    \brief この関数は、新しいコンテキストオブジェクトを解放して割り当てる必要がないように、ecEncCtx構造体をリセットします。
1384
1385    \return 0 ecEncCtx構造体が正常にリセットされた場合に返されます
1386    \return BAD_FUNC_ARG rngまたはctxのいずれかがNULLの場合に返されます
1387    \return RNG_FAILURE_E ECCオブジェクト用の新しいソルトを生成する際にエラーがある場合に返されます
1388
1389    \param ctx リセットするecEncCtxオブジェクトへのポインタ
1390    \param rng 新しいソルトを生成するために使用するRNGオブジェクトへのポインタ
1391
1392    _Example_
1393    \code
1394    ecEncCtx* ctx;
1395    WC_RNG rng;
1396    wc_InitRng(&rng);
1397    ctx = wc_ecc_ctx_new(REQ_RESP_CLIENT, &rng);
1398    // 安全な通信を行う
1399    ...
1400    wc_ecc_ctx_reset(&ctx, &rng);
1401    // さらに安全な通信を行う
1402    \endcode
1403
1404    \sa wc_ecc_ctx_new
1405*/
1406
1407int wc_ecc_ctx_reset(ecEncCtx* ctx, WC_RNG* rng);  /* 割り当て/解放なしで再使用のためにリセット */
1408
1409/*!
1410    \ingroup ECC
1411
1412    \brief この関数は、wc_ecc_ctx_newの後にオプションで呼び出すことができます。ecEncCtxオブジェクトに暗号化、KDF、およびMACアルゴリズムを設定します。
1413
1414    \return 0 ecEncCtxオブジェクトの情報を正常に設定した場合に返されます。
1415    \return BAD_FUNC_ARG 指定されたecEncCtxオブジェクトがNULLの場合に返されます。
1416
1417    \param ctx 情報を設定するecEncCtxへのポインタ
1418    \param encAlgo 使用する暗号化アルゴリズム。
1419    \param kdfAlgo 使用するKDFアルゴリズム。
1420    \param macAlgo 使用するMACアルゴリズム。
1421
1422    _Example_
1423    \code
1424    ecEncCtx* ctx;
1425    // ctxを初期化
1426    if(wc_ecc_ctx_set_algo(&ctx, ecAES_128_CTR, ecHKDF_SHA256, ecHMAC_SHA256))) {
1427	    // 情報設定エラー
1428    }
1429    \endcode
1430
1431    \sa wc_ecc_ctx_new
1432*/
1433
1434int wc_ecc_ctx_set_algo(ecEncCtx* ctx, byte encAlgo, byte kdfAlgo,
1435    byte macAlgo);
1436
1437/*!
1438    \ingroup ECC
1439
1440    \brief この関数は、ecEncCtxオブジェクトのソルトを返します。この関数は、ecEncCtxの状態がecSRV_INITまたはecCLI_INITの場合にのみ呼び出す必要があります。
1441
1442    \return Success 成功時に、ecEncCtxソルトを返します
1443    \return NULL ecEncCtxオブジェクトがNULLの場合、またはecEncCtxの状態がecSRV_INITまたはecCLI_INITでない場合に返されます。後者の2つのケースでは、この関数はecEncCtxの状態をそれぞれecSRV_BAD_STATEまたはecCLI_BAD_STATEに設定します
1444
1445    \param ctx ソルトを取得するecEncCtxオブジェクトへのポインタ
1446
1447    _Example_
1448    \code
1449    ecEncCtx* ctx;
1450    WC_RNG rng;
1451    const byte* salt;
1452    wc_InitRng(&rng);
1453    ctx = wc_ecc_ctx_new(REQ_RESP_CLIENT, &rng);
1454    salt = wc_ecc_ctx_get_own_salt(&ctx);
1455    if(salt == NULL) {
1456    	// ソルト取得エラー
1457    }
1458    \endcode
1459
1460    \sa wc_ecc_ctx_new
1461    \sa wc_ecc_ctx_set_peer_salt
1462    \sa wc_ecc_ctx_set_kdf_salt
1463*/
1464
1465const byte* wc_ecc_ctx_get_own_salt(ecEncCtx*);
1466
1467/*!
1468    \ingroup ECC
1469
1470    \brief この関数は、ecEncCtxオブジェクトのピアソルトを設定します。
1471
1472    \return 0 ecEncCtxオブジェクトのピアソルトを正常に設定した場合に返されます。
1473    \return BAD_FUNC_ARG 指定されたecEncCtxオブジェクトがNULLまたは無効なプロトコルを持つ場合、または指定されたソルトがNULLの場合に返されます
1474    \return BAD_ENC_STATE_E ecEncCtxの状態がecSRV_SALT_GETまたはecCLI_SALT_GETの場合に返されます。後者の2つのケースでは、この関数はecEncCtxの状態をそれぞれecSRV_BAD_STATEまたはecCLI_BAD_STATEに設定します
1475
1476    \param ctx ソルトを設定するecEncCtxへのポインタ
1477    \param salt ピアのソルトへのポインタ
1478
1479    _Example_
1480    \code
1481    ecEncCtx* cliCtx, srvCtx;
1482    WC_RNG rng;
1483    const byte* cliSalt, srvSalt;
1484    int ret;
1485
1486    wc_InitRng(&rng);
1487    cliCtx = wc_ecc_ctx_new(REQ_RESP_CLIENT, &rng);
1488    srvCtx = wc_ecc_ctx_new(REQ_RESP_SERVER, &rng);
1489
1490    cliSalt = wc_ecc_ctx_get_own_salt(&cliCtx);
1491    srvSalt = wc_ecc_ctx_get_own_salt(&srvCtx);
1492    ret = wc_ecc_ctx_set_peer_salt(&cliCtx, srvSalt);
1493    \endcode
1494
1495    \sa wc_ecc_ctx_get_own_salt
1496    \sa wc_ecc_ctx_set_kdf_salt
1497*/
1498
1499int wc_ecc_ctx_set_peer_salt(ecEncCtx* ctx, const byte* salt);
1500
1501/*!
1502    \ingroup ECC
1503
1504    \brief この関数は、KDFで使用するソルトポインタと長さをecEncCtxオブジェクトに設定します。
1505
1506    \return 0 ecEncCtxオブジェクトのソルトを正常に設定した場合に返されます。
1507    \return BAD_FUNC_ARG 指定されたecEncCtxオブジェクトがNULLの場合、または指定されたソルトがNULLで長さがNULLでない場合に返されます。
1508
1509    \param ctx ソルトを設定するecEncCtxへのポインタ
1510    \param salt ソルトバッファへのポインタ
1511    \param sz ソルトの長さ（バイト単位）
1512
1513    _Example_
1514    \code
1515    ecEncCtx* srvCtx;
1516    WC_RNG rng;
1517    byte cliSalt[] = { 固定ソルトデータ };
1518    word32 cliSaltLen = (word32)sizeof(cliSalt);
1519    int ret;
1520
1521    wc_InitRng(&rng);
1522    cliCtx = wc_ecc_ctx_new(REQ_RESP_SERVER, &rng);
1523
1524    ret = wc_ecc_ctx_set_kdf_salt(&cliCtx, cliSalt, cliSaltLen);
1525    \endcode
1526
1527    \sa wc_ecc_ctx_get_own_salt
1528    \sa wc_ecc_ctx_get_peer_salt
1529*/
1530
1531int wc_ecc_ctx_set_kdf_salt(ecEncCtx* ctx, const byte* salt, word32 sz);
1532
1533/*!
1534    \ingroup ECC
1535
1536    \brief この関数は、wc_ecc_ctx_set_peer_saltの前または後にオプションで呼び出すことができます。ecEncCtxオブジェクトのオプション情報を設定します。
1537
1538    \return 0 ecEncCtxオブジェクトの情報を正常に設定した場合に返されます。
1539    \return BAD_FUNC_ARG 指定されたecEncCtxオブジェクトがNULLの場合、入力infoがNULLの場合、またはそのサイズが無効な場合に返されます
1540
1541    \param ctx 情報を設定するecEncCtxへのポインタ
1542    \param info 設定する情報を含むバッファへのポインタ
1543    \param sz infoバッファのサイズ
1544
1545    _Example_
1546    \code
1547    ecEncCtx* ctx;
1548    byte info[] = { 情報で初期化 };
1549    // ctxを初期化、ソルトを取得、
1550    if(wc_ecc_ctx_set_info(&ctx, info, sizeof(info))) {
1551	    // 情報設定エラー
1552    }
1553    \endcode
1554
1555    \sa wc_ecc_ctx_new
1556*/
1557
1558int wc_ecc_ctx_set_info(ecEncCtx* ctx, const byte* info, int sz);
1559
1560/*!
1561    \ingroup ECC
1562
1563    \brief この関数は、msgからoutへ指定された入力メッセージを暗号化します。この関数は、オプションのctxオブジェクトをパラメータとして受け取ります。提供された場合、暗号化はecEncCtxのencAlgo、kdfAlgo、およびmacAlgoに基づいて進行します。ctxが提供されない場合、デフォルトのアルゴリズムecAES_128_CBC、ecHKDF_SHA256、およびecHMAC_SHA256で処理が完了します。この関数では、ctxで指定された暗号化タイプに応じてメッセージがパディングされている必要があります。
1564
1565    \return 0 入力メッセージの暗号化に成功した場合に返されます
1566    \return BAD_FUNC_ARG privKey、pubKey、msg、msgSz、out、またはoutSzがNULLの場合、またはctxオブジェクトがサポートされていない暗号化タイプを指定している場合に返されます
1567    \return BAD_ENC_STATE_E 指定されたctxオブジェクトが暗号化に適していない状態にある場合に返されます
1568    \return BUFFER_E 提供された出力バッファが暗号化された暗号文を格納するには小さすぎる場合に返されます
1569    \return MEMORY_E 共有秘密鍵用のメモリを割り当てる際にエラーがある場合に返されます
1570
1571    \param privKey 暗号化に使用する秘密鍵を含むecc_keyオブジェクトへのポインタ
1572    \param pubKey 通信したいピアの公開鍵を含むecc_keyオブジェクトへのポインタ
1573    \param msg 暗号化するメッセージを保持するバッファへのポインタ
1574    \param msgSz 暗号化するバッファのサイズ
1575    \param out 暗号化された暗号文を格納するバッファへのポインタ
1576    \param outSz outバッファで利用可能なサイズを含むword32オブジェクトへのポインタ。メッセージの暗号化に成功すると、出力バッファに書き込まれたバイト数を保持します
1577    \param ctx オプション：使用する異なる暗号化アルゴリズムを指定するecEncCtxオブジェクトへのポインタ
1578
1579    _Example_
1580    \code
1581    byte msg[] = { 暗号化するメッセージで初期化。ブロックサイズにパディングされていることを確認 };
1582    byte out[sizeof(msg)];
1583    word32 outSz = sizeof(out);
1584    int ret;
1585    ecc_key cli, serv;
1586    // cliを秘密鍵で初期化
1587    // servを受信した公開鍵で初期化
1588
1589    ecEncCtx* cliCtx, servCtx;
1590    // cliCtxとservCtxを初期化
1591    // ソルトを交換
1592    ret = wc_ecc_encrypt(&cli, &serv, msg, sizeof(msg), out, &outSz, cliCtx);
1593    if(ret != 0) {
1594    	// メッセージの暗号化エラー
1595    }
1596    \endcode
1597
1598    \sa wc_ecc_encrypt_ex
1599    \sa wc_ecc_decrypt
1600*/
1601
1602int wc_ecc_encrypt(ecc_key* privKey, ecc_key* pubKey, const byte* msg,
1603                word32 msgSz, byte* out, word32* outSz, ecEncCtx* ctx);
1604
1605/*!
1606    \ingroup ECC
1607
1608    \brief この関数は、msgからoutへ指定された入力メッセージを暗号化します。この関数は、オプションのctxオブジェクトをパラメータとして受け取ります。提供された場合、暗号化はecEncCtxのencAlgo、kdfAlgo、およびmacAlgoに基づいて進行します。ctxが提供されない場合、デフォルトのアルゴリズムecAES_128_CBC、ecHKDF_SHA256、およびecHMAC_SHA256で処理が完了します。この関数では、ctxで指定された暗号化タイプに応じてメッセージがパディングされている必要があります。
1609
1610    \return 0 入力メッセージの暗号化に成功した場合に返されます
1611    \return BAD_FUNC_ARG privKey、pubKey、msg、msgSz、out、またはoutSzがNULLの場合、またはctxオブジェクトがサポートされていない暗号化タイプを指定している場合に返されます
1612    \return BAD_ENC_STATE_E 指定されたctxオブジェクトが暗号化に適していない状態にある場合に返されます
1613    \return BUFFER_E 提供された出力バッファが暗号化された暗号文を格納するには小さすぎる場合に返されます
1614    \return MEMORY_E 共有秘密鍵用のメモリを割り当てる際にエラーがある場合に返されます
1615
1616    \param privKey 暗号化に使用する秘密鍵を含むecc_keyオブジェクトへのポインタ
1617    \param pubKey 通信したいピアの公開鍵を含むecc_keyオブジェクトへのポインタ
1618    \param msg 暗号化するメッセージを保持するバッファへのポインタ
1619    \param msgSz 暗号化するバッファのサイズ
1620    \param out 暗号化された暗号文を格納するバッファへのポインタ
1621    \param outSz outバッファで利用可能なサイズを含むword32オブジェクトへのポインタ。メッセージの暗号化に成功すると、出力バッファに書き込まれたバイト数を保持します
1622    \param ctx オプション：使用する異なる暗号化アルゴリズムを指定するecEncCtxオブジェクトへのポインタ
1623    \param compressed 公開鍵フィールドを圧縮形式で出力する。
1624
1625    _Example_
1626    \code
1627    byte msg[] = { 暗号化するメッセージで初期化。ブロックサイズにパディングされていることを確認 };
1628    byte out[sizeof(msg)];
1629    word32 outSz = sizeof(out);
1630    int ret;
1631    ecc_key cli, serv;
1632    // cliを秘密鍵で初期化
1633    // servを受信した公開鍵で初期化
1634
1635    ecEncCtx* cliCtx, servCtx;
1636    // cliCtxとservCtxを初期化
1637    // ソルトを交換
1638    ret = wc_ecc_encrypt_ex(&cli, &serv, msg, sizeof(msg), out, &outSz, cliCtx,
1639        1);
1640    if(ret != 0) {
1641    	// メッセージの暗号化エラー
1642    }
1643    \endcode
1644
1645    \sa wc_ecc_encrypt
1646    \sa wc_ecc_decrypt
1647*/
1648
1649int wc_ecc_encrypt_ex(ecc_key* privKey, ecc_key* pubKey, const byte* msg,
1650    word32 msgSz, byte* out, word32* outSz, ecEncCtx* ctx, int compressed);
1651
1652/*!
1653    \ingroup ECC
1654
1655    \brief この関数は、msgからoutへ暗号文を復号します。この関数は、オプションのctxオブジェクトをパラメータとして受け取ります。提供された場合、暗号化はecEncCtxのencAlgo、kdfAlgo、およびmacAlgoに基づいて進行します。ctxが提供されない場合、デフォルトのアルゴリズムecAES_128_CBC、ecHKDF_SHA256、およびecHMAC_SHA256で処理が完了します。この関数では、ctxで指定された暗号化タイプに応じてメッセージがパディングされている必要があります。
1656
1657    \return 0 入力メッセージの復号に成功した場合に返されます
1658    \return BAD_FUNC_ARG privKey、pubKey、msg、msgSz、out、またはoutSzがNULLの場合、またはctxオブジェクトがサポートされていない暗号化タイプを指定している場合に返されます
1659    \return BAD_ENC_STATE_E 指定されたctxオブジェクトが復号に適していない状態にある場合に返されます
1660    \return BUFFER_E 提供された出力バッファが復号された平文を格納するには小さすぎる場合に返されます
1661    \return MEMORY_E 共有秘密鍵用のメモリを割り当てる際にエラーがある場合に返されます
1662
1663    \param privKey 復号に使用する秘密鍵を含むecc_keyオブジェクトへのポインタ
1664    \param pubKey 通信したいピアの公開鍵を含むecc_keyオブジェクトへのポインタ
1665    \param msg 復号する暗号文を保持するバッファへのポインタ
1666    \param msgSz 復号するバッファのサイズ
1667    \param out 復号された平文を格納するバッファへのポインタ
1668    \param outSz outバッファで利用可能なサイズを含むword32オブジェクトへのポインタ。暗号文の復号に成功すると、出力バッファに書き込まれたバイト数を保持します
1669    \param ctx オプション：使用する異なる復号アルゴリズムを指定するecEncCtxオブジェクトへのポインタ
1670
1671    _Example_
1672    \code
1673    byte cipher[] = { 復号する暗号文で初期化。ブロックサイズにパディングされていることを確認 };
1674    byte plain[sizeof(cipher)];
1675    word32 plainSz = sizeof(plain);
1676    int ret;
1677    ecc_key cli, serv;
1678    // cliを秘密鍵で初期化
1679    // servを受信した公開鍵で初期化
1680    ecEncCtx* cliCtx, servCtx;
1681    // cliCtxとservCtxを初期化
1682    // ソルトを交換
1683    ret = wc_ecc_decrypt(&cli, &serv, cipher, sizeof(cipher),
1684    plain, &plainSz, cliCtx);
1685
1686    if(ret != 0) {
1687    	// メッセージの復号エラー
1688    }
1689    \endcode
1690
1691    \sa wc_ecc_encrypt
1692    \sa wc_ecc_encrypt_ex
1693*/
1694
1695int wc_ecc_decrypt(ecc_key* privKey, ecc_key* pubKey, const byte* msg,
1696                word32 msgSz, byte* out, word32* outSz, ecEncCtx* ctx);
1697
1698
1699/*!
1700    \ingroup ECC
1701
1702    \brief ノンブロッキング操作のためのECCサポートを有効にします。次のビルドオプションでSingle Precision（SP）数学でサポートされています：
1703            WOLFSSL_SP_NONBLOCK
1704            WOLFSSL_SP_SMALL
1705            WOLFSSL_SP_NO_MALLOC
1706            WC_ECC_NONBLOCK
1707
1708    \return 0 入力メッセージのコールバックコンテキストの設定に成功した場合に返されます
1709
1710    \param key ecc_keyオブジェクトへのポインタ
1711    \param ctx SP用のスタックデータキャッシュを持つecc_nb_ctx_t構造体へのポインタ
1712
1713    _Example_
1714    \code
1715    int ret;
1716    ecc_key ecc;
1717    ecc_nb_ctx_t nb_ctx;
1718
1719    ret = wc_ecc_init(&ecc);
1720    if (ret == 0) {
1721        ret = wc_ecc_set_nonblock(&ecc, &nb_ctx);
1722        if (ret == 0) {
1723            do {
1724                ret = wc_ecc_verify_hash_ex(
1725                    &r, &s,       // mp_intとしてのr/s
1726                    hash, hashSz, // 計算されたハッシュダイジェスト
1727                    &verify_res,  // 検証結果 1=成功
1728                    &key
1729                );
1730
1731                // TODO: リアルタイム作業をここで呼び出すことができます
1732            } while (ret == FP_WOULDBLOCK);
1733        }
1734        wc_ecc_free(&key);
1735    }
1736    \endcode
1737*/
1738int wc_ecc_set_nonblock(ecc_key *key, ecc_nb_ctx_t* ctx);
1739
1740/*!
1741    \ingroup ECC
1742
1743    \brief 指定されたサイズより大きいキーを持つカーブまたはカーブIDに一致するカーブを比較し、より小さいキーサイズを持つカーブをキーに設定します。
1744
1745    \return 0 キーの設定に成功した場合に返されます
1746
1747    \param keysize キーサイズ（バイト単位）
1748    \param curve_id カーブID
1749
1750                                                                                                        _Example_
1751    \code int ret;
1752    ecc_key ecc;
1753
1754    ret = wc_ecc_init(&ecc);
1755    if (ret != 0)
1756        return ret;
1757        ret = wc_ecc_set_curve(&ecc, 32, ECC_SECP256R1));
1758        if (ret != 0)
1759            return ret;
1760
1761    \endcode
1762*/
1763int wc_ecc_set_curve(ecc_key *key, int keysize, int curve_id);