Update Japanese comments

This commit is contained in:
TakayukiMatsuo 2023-04-17 07:49:42 +09:00
parent c4233e7aec
commit ead8d9784b
3 changed files with 99 additions and 10 deletions

View File

@ -610,7 +610,7 @@ int wc_AesXtsFree(XtsAes* aes);
/*! /*!
\ingroup AES \ingroup AES
\brief AES構造を初期化しますASYNCハードウェアで使用するためのヒープヒントとIDを設定する \brief Aes構造体を初期化しますASYNCハードウェアを使用する場合のIDも設定しますAes構造体の使用が終了した際にwc_AesFreeを呼び出すのはユーザーに任されています
\return 0 \return 0
\param aes AES構造 \param aes AES構造
\param heap malloc / freeに使用するヒントヒント \param heap malloc / freeに使用するヒントヒント
@ -622,13 +622,33 @@ int wc_AesXtsFree(XtsAes* aes);
//heap hint could be set here if used //heap hint could be set here if used
wc_AesInit(&aes, hint, devId); wc_AesInit(&enc, hint, devId);
\endcode \endcode
\sa wc_AesSetKey \sa wc_AesSetKey
\sa wc_AesSetIV \sa wc_AesSetIV
*/ */
int wc_AesInit(Aes* aes, void* heap, int devId); int wc_AesInit(Aes* aes, void* heap, int devId);
/*!
\ingroup AES
\brief Aes構造体に関連つけられたリソースを可能なら解放する
\return
\param aes FreeすべきAes構造体へのポインター
_Example_
\code
Aes enc;
void* hint = NULL;
int devId = INVALID_DEVID; //if not using async INVALID_DEVID is default
//heap hint could be set here if used
wc_AesInit(&enc, hint, devId);
// ... do some interesting things ...
wc_AesFree(&enc);
\endcode
\sa wc_AesInit
*/
int wc_AesFree(Aes* aes);
/*! /*!
\ingroup AES \ingroup AES
\brief CFBモードを持つAES \brief CFBモードを持つAES

View File

@ -436,7 +436,7 @@ int wc_ed25519_import_public(const byte* in, word32 inLen, ed25519_key* key);
\ingroup ED25519 \ingroup ED25519
\brief ed25519秘密鍵をバッファからのみインポートします \brief ed25519秘密鍵をバッファからのみインポートします
\return 0 ED25519キーのインポートに成功しました \return 0 ED25519キーのインポートに成功しました
\return BAD_FUNC_ARG INまたはKEYがNULLに評価された場合PRIVSZがED25519_KEY_SIZEよりも小さい場合に返されます \return BAD_FUNC_ARG privまたはkeyがNULLに評価された場合privSzがED25519_KEY_SIZEと異なる場合に返されます
\param [in] PRIVポインタ \param [in] PRIVポインタ
\param [in] Privsz長さ \param [in] Privsz長さ
\param [in] Pubポインタ \param [in] Pubポインタ
@ -465,7 +465,7 @@ int wc_ed25519_import_private_only(const byte* priv, word32 privSz,
\ingroup ED25519 \ingroup ED25519
\brief /ED25519キーペアをインポートします \brief /ED25519キーペアをインポートします
\return 0 ED25519_KEYのインポートに成功しました \return 0 ED25519_KEYのインポートに成功しました
\return BAD_FUNC_ARG INまたはKEYがNULLに評価された場合PROVSZがED25519_SEY_SIZEまたはPUBSZよりも小さい場合はED25519_PUB_KEY_SIZEよりも小さい場合に返されます \return BAD_FUNC_ARG privまたはkeyがNULLに評価された場合privSzがED25519_KEY_SIZEと異なるあるいはED25519_PRV_KEY_SIZEとも異なる場合pubSzがED25519_PUB_KEY_SIZEよりも小さい場合に返されます
\param [in] PRIVポインタ \param [in] PRIVポインタ
\param [in] Privsz長さ \param [in] Privsz長さ
\param [in] Pubポインタ \param [in] Pubポインタ
@ -492,6 +492,40 @@ int wc_ed25519_import_private_only(const byte* priv, word32 privSz,
int wc_ed25519_import_private_key(const byte* priv, word32 privSz, int wc_ed25519_import_private_key(const byte* priv, word32 privSz,
const byte* pub, word32 pubSz, ed25519_key* key); const byte* pub, word32 pubSz, ed25519_key* key);
/*!
\ingroup ED25519
\brief Ed25519公開鍵/trusted引数により信頼されていないとされた場合には秘密鍵に対して検証されます
\return 0 ed25519_keyのインポートに成功しました
\return BAD_FUNC_ARG Returned if privあるいはkeyがNULLに評価された場合privSzがED25519_KEY_SIZEともED25519_PRV_KEY_SIZEとも異なる場合pubSzがED25519_PUB_KEY_SIZEより小さい場合に返されます
\param [in] priv
\param [in] privSz
\param [in] pub
\param [in] pubSz
\param [in,out] key /ed25519_keyオブジェクトへのポインター
\param [in] trusted
_Example_
\code
int ret;
byte priv[] = { initialize with 32 byte private key };
byte pub[] = { initialize with the corresponding public key };
ed25519_key key;
wc_ed25519_init_key(&key);
ret = wc_ed25519_import_private_key(priv, sizeof(priv), pub, sizeof(pub),
&key, 1);
if (ret != 0) {
// error importing key
}
\endcode
\sa wc_ed25519_import_public
\sa wc_ed25519_import_public_ex
\sa wc_ed25519_import_private_only
\sa wc_ed25519_import_private_key
\sa wc_ed25519_export_private
*/
int wc_ed25519_import_private_key_ex(const byte* priv, word32 privSz,
const byte* pub, word32 pubSz, ed25519_key* key, int trusted);
/*! /*!
\ingroup ED25519 \ingroup ED25519
\brief ED25519_Key構造体からエクスポートしますounterenでこのバッファに書き込まれたバイトを設定します \brief ED25519_Key構造体からエクスポートしますounterenでこのバッファに書き込まれたバイトを設定します
@ -524,7 +558,7 @@ int wc_ed25519_export_public(ed25519_key* key, byte* out, word32* outLen);
\ingroup ED25519 \ingroup ED25519
\brief ED25519_Key構造体からの秘密鍵のみをエクスポートしますoutlenにこのバッファに書き込まれたバイトを設定します \brief ED25519_Key構造体からの秘密鍵のみをエクスポートしますoutlenにこのバッファに書き込まれたバイトを設定します
\return 0 \return 0
\return ECC_BAD_ARG_E NULLに評価された場合に返されます \return BAD_FUNC_ARG NULLに評価された場合に返されます
\return BUFFER_E \return BUFFER_E
\param [in] ED25519_Key構造体へのキーポインタ \param [in] ED25519_Key構造体へのキーポインタ
\param [out] \param [out]
@ -551,7 +585,7 @@ int wc_ed25519_export_private_only(ed25519_key* key, byte* out, word32* outLen);
\ingroup ED25519 \ingroup ED25519
\brief ED25519_Key構造体からキーペアをエクスポートしますOUTに格納しounterenでこのバッファに書き込まれたバイトを設定します \brief ED25519_Key構造体からキーペアをエクスポートしますOUTに格納しounterenでこのバッファに書き込まれたバイトを設定します
\return 0 \return 0
\return ECC_BAD_ARG_E NULLに評価された場合に返されます \return BAD_FUNC_ARG NULLに評価された場合に返されます
\return BUFFER_E \return BUFFER_E
\param [in] ED25519_Key構造体へのキーポインタ \param [in] ED25519_Key構造体へのキーポインタ
\param [out] \param [out]
@ -582,7 +616,7 @@ int wc_ed25519_export_private(ed25519_key* key, byte* out, word32* outLen);
\ingroup ED25519 \ingroup ED25519
\brief ED25519_KEY構造体とは別にプライベートキーと公開鍵をエクスポートしますPrivに格納しPRIVSZでこのバッファに書き込まれたバイトを設定しますPUBに格納しPubszでこのバッファに書き込まれたバイトを設定します \brief ED25519_KEY構造体とは別にプライベートキーと公開鍵をエクスポートしますPrivに格納しPRIVSZでこのバッファに書き込まれたバイトを設定しますPUBに格納しPubszでこのバッファに書き込まれたバイトを設定します
\return 0 \return 0
\return ECC_BAD_ARG_E NULLに評価された場合に返されます \return BAD_FUNC_ARG NULLに評価された場合に返されます
\return BUFFER_E \return BUFFER_E
\param [in] ED25519_Key構造体へのキーポインタ \param [in] ED25519_Key構造体へのキーポインタ
\param [out] PRIVポインタ \param [out] PRIVポインタ
@ -616,7 +650,8 @@ int wc_ed25519_export_key(ed25519_key* key,
\ingroup ED25519 \ingroup ED25519
\brief ED25519_KEY構造体の公開鍵をチェックします \brief ED25519_KEY構造体の公開鍵をチェックします
\return 0 \return 0
\return BAD_FUNC_ARGS NULLの場合に返されます \return BAD_FUNC_ARG NULLの場合に返されます
\return PUBLIC_KEY_E
_Example_ _Example_
\code \code
int ret; int ret;
@ -640,7 +675,7 @@ int wc_ed25519_check_key(ed25519_key* key);
\ingroup ED25519 \ingroup ED25519
\brief ED25519 - 32 \brief ED25519 - 32
\return ED25519_KEY_SIZE 32 \return ED25519_KEY_SIZE 32
\return BAD_FUNC_ARGS NULLの場合に返されます \return BAD_FUNC_ARG NULLの場合に返されます
_Example_ _Example_
\code \code
int keySz; int keySz;

View File

@ -1054,6 +1054,37 @@ WOLFSSL* wolfSSL_new(WOLFSSL_CTX*);
*/ */
int wolfSSL_set_fd (WOLFSSL* ssl, int fd); int wolfSSL_set_fd (WOLFSSL* ssl, int fd);
/*!
\ingroup Setup
\brief (fd)SSLコネクションの入出力手段として設定します
DTLS専用のAPIであり
fdに対するrecvfromとsendto呼び出しでのaddrとaddr_lenはNULLに設定されます
\return SSL_SUCCESS
\return Bad_FUNC_ARG
\param ssl wolfSSL_new()SSLセッションへのポインタ
\param fd SSL/TLSコネクションに使用するファイルディスクリプタ
_Example_
\code
int sockfd;
WOLFSSL* ssl = 0;
...
if (connect(sockfd, peer_addr, peer_addr_len) != 0) {
// handle connect error
}
...
ret = wolfSSL_set_dtls_fd_connected(ssl, sockfd);
if (ret != SSL_SUCCESS) {
// failed to set SSL file descriptor
}
\endcode
\sa wolfSSL_CTX_SetIOSend
\sa wolfSSL_CTX_SetIORecv
\sa wolfSSL_SetIOReadCtx
\sa wolfSSL_SetIOWriteCtx
\sa wolfDTLS_SetChGoodCb
*/
int wolfSSL_set_dtls_fd_connected(WOLFSSL* ssl, int fd);
/*! /*!
\ingroup IO \ingroup IO
\brief \brief
@ -4006,8 +4037,11 @@ unsigned char* wolfSSL_get_chain_cert(WOLFSSL_X509_CHAIN* chain, int idx);
/*! /*!
\ingroup CertsKeys \ingroup CertsKeys
\brief wolfssl_x509_209_CertificateをインデックスIDX \brief wolfssl_x509_209_CertificateをインデックスIDX
\return pointer wolfssl_x509構造へのポインタを返します \return pointer WOLFSSL_X509構造体へのポインタを返します
\param chain session_cacheの場合に使用されるWOLFSSL_X509_CHAINへのポインタ \param chain session_cacheの場合に使用されるWOLFSSL_X509_CHAINへのポインタ
wolfSSL_FreeX509()
_Example_ _Example_
\code \code
WOLFSSL_X509_CHAIN* chain = &session->chain; WOLFSSL_X509_CHAIN* chain = &session->chain;