Skip to content

Fix wolfSSL_send_hrr_cookie documentation #12030

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SparkiDev wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix wolfSSL_send_hrr_cookie documentation #12030

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/dox_comments/header_files-ja/ssl.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12103,7 +12103,7 @@ int wolfSSL_connect(WOLFSSL* ssl);

\param [in,out] ssl wolfSSL_new()を使用して作成されたWOLFSSL構造体へのポインタ。
\param [in] secret secretを保持するバッファへのポインタ。NULLを渡すと、新しいランダムなsecretを生成することを示します。
\param [in] secretSz secretのサイズ(バイト単位)。0を渡すと、デフォルトサイズを使用することを示します:WC_SHA256_DIGEST_SIZE(SHA-256が利用できない場合はWC_SHA_DIGEST_SIZE)。
\param [in] secretSz secretのサイズ(バイト単位)。0を渡すと、デフォルトサイズを使用することを示します:cookie MACが使用するハッシュのダイジェストサイズで、WC_SHA256_DIGEST_SIZE、SHA-256が利用できない場合はWC_SHA384_DIGEST_SIZE、WC_SHA512_DIGEST_SIZE(WOLFSSL_TLS13_SHA512使用時)、WC_SM3_DIGEST_SIZEの順に選択されます。

\return BAD_FUNC_ARG sslがNULLまたはTLS v1.3を使用していない場合。
\return SIDE_ERROR クライアントで呼び出された場合。
Expand All @@ -12115,9 +12115,9 @@ int wolfSSL_connect(WOLFSSL* ssl);
\code
int ret;
WOLFSSL* ssl;
char secret[32];
unsigned char secret[32];
...
ret = wolfSSL__send_hrr_cookie(ssl, secret, sizeof(secret));
ret = wolfSSL_send_hrr_cookie(ssl, secret, sizeof(secret));
if (ret != WOLFSSL_SUCCESS) {
// Cookieとsecretの使用設定に失敗しました。
}
Expand Down
8 changes: 4 additions & 4 deletions doc/dox_comments/header_files/ssl.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15183,8 +15183,8 @@ int wolfSSL_connect(WOLFSSL* ssl);
\param [in] secretSz Size of the secret in bytes.
Passing 0 indicates to use the default size: the digest size of the hash
the cookie MAC uses, WC_SHA256_DIGEST_SIZE, or when SHA-256 is not
available WC_SHA384_DIGEST_SIZE, WC_SHA512_DIGEST_SIZE or
WC_SM3_DIGEST_SIZE, in that order.
available WC_SHA384_DIGEST_SIZE, WC_SHA512_DIGEST_SIZE (with
WOLFSSL_TLS13_SHA512) or WC_SM3_DIGEST_SIZE, in that order.

\return BAD_FUNC_ARG if ssl is NULL or not using TLS v1.3.
\return SIDE_ERROR if called with a client.
Expand All @@ -15203,9 +15203,9 @@ int wolfSSL_connect(WOLFSSL* ssl);
\code
int ret;
WOLFSSL* ssl;
char secret[32];
unsigned char secret[32];
...
ret = wolfSSL__send_hrr_cookie(ssl, secret, sizeof(secret));
ret = wolfSSL_send_hrr_cookie(ssl, secret, sizeof(secret));
if (ret != WOLFSSL_SUCCESS) {
// failed to set use of Cookie and secret
}
Expand Down
Loading