Skip to content

Add upper limit of max window size and packet size, Add unit tests #995

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
yosuke-wolfssl wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add upper limit of max window size and packet size, Add unit tests #995

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
4 changes: 4 additions & 0 deletions src/ssh.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2518,8 +2518,12 @@ int wolfSSH_CTX_SetWindowPacketSize(WOLFSSH_CTX* ctx,
if (ctx == NULL)
return WS_BAD_ARGUMENT;

if (windowSz != 0 && windowSz > WINDOW_SZ_UPPER_BOUND)
return WS_BAD_ARGUMENT;
if (windowSz == 0)
windowSz = DEFAULT_WINDOW_SZ;
if (maxPacketSz != 0 && maxPacketSz > MAX_PACKET_SZ)
return WS_BAD_ARGUMENT;
if (maxPacketSz == 0)
maxPacketSz = DEFAULT_MAX_PACKET_SZ;

Expand Down
46 changes: 46 additions & 0 deletions tests/api.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -642,6 +642,51 @@ static void test_wolfSSH_CTX_UsePrivateKey_buffer_pem(void)
}


static void test_wolfSSH_CTX_SetWindowPacketSize(void)
{
WOLFSSH_CTX* ctx = NULL;

/* NULL ctx must be rejected. */
AssertIntEQ(WS_BAD_ARGUMENT,
wolfSSH_CTX_SetWindowPacketSize(NULL, 0, 0));

ctx = wolfSSH_CTX_new(WOLFSSH_ENDPOINT_SERVER, NULL);
AssertNotNull(ctx);

/* Both zero: should default without error. */
AssertIntEQ(WS_SUCCESS,
wolfSSH_CTX_SetWindowPacketSize(ctx, 0, 0));

/* windowSz exactly at upper bound: must succeed and be stored. */
AssertIntEQ(WS_SUCCESS,
wolfSSH_CTX_SetWindowPacketSize(ctx, WINDOW_SZ_UPPER_BOUND, 0));
AssertIntEQ(WINDOW_SZ_UPPER_BOUND, (int)ctx->windowSz);

/* windowSz one above upper bound: must fail. */
AssertIntEQ(WS_BAD_ARGUMENT,
wolfSSH_CTX_SetWindowPacketSize(ctx,
WINDOW_SZ_UPPER_BOUND + 1, 0));

/* maxPacketSz exactly at transport limit: must succeed and be stored. */
AssertIntEQ(WS_SUCCESS,
wolfSSH_CTX_SetWindowPacketSize(ctx, 0, MAX_PACKET_SZ));
AssertIntEQ(MAX_PACKET_SZ, (int)ctx->maxPacketSz);

/* maxPacketSz one above transport limit: must fail. */
AssertIntEQ(WS_BAD_ARGUMENT,
wolfSSH_CTX_SetWindowPacketSize(ctx, 0, MAX_PACKET_SZ + 1));

/* Both valid non-zero values: must succeed and be stored. */
AssertIntEQ(WS_SUCCESS,
wolfSSH_CTX_SetWindowPacketSize(ctx,
DEFAULT_WINDOW_SZ, DEFAULT_MAX_PACKET_SZ));
AssertIntEQ(DEFAULT_WINDOW_SZ, (int)ctx->windowSz);
AssertIntEQ(DEFAULT_MAX_PACKET_SZ, (int)ctx->maxPacketSz);

wolfSSH_CTX_free(ctx);
}


static void test_wolfSSH_CertMan(void)
{
#ifdef WOLFSSH_CERTMAN
Expand Down Expand Up @@ -2139,6 +2184,7 @@ int wolfSSH_ApiTest(int argc, char** argv)
test_wolfSSH_CTX_UsePrivateKey_buffer();
test_wolfSSH_CTX_UseCert_buffer();
test_wolfSSH_CTX_UsePrivateKey_buffer_pem();
test_wolfSSH_CTX_SetWindowPacketSize();
test_wolfSSH_CertMan();
test_wolfSSH_ReadKey();
test_wolfSSH_ReadKey_badPad();
Expand Down
4 changes: 4 additions & 0 deletions wolfssh/internal.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -449,6 +449,10 @@ enum NameIdType {
#ifndef DEFAULT_WINDOW_SZ
#define DEFAULT_WINDOW_SZ (128 * 1024)
#endif
#ifndef WINDOW_SZ_UPPER_BOUND
/* Upper bound accepted by wolfSSH_CTX_SetWindowPacketSize(). */
#define WINDOW_SZ_UPPER_BOUND (256 * 1024)
#endif
#ifndef DEFAULT_MAX_PACKET_SZ
/* This is from RFC 4253 section 6.1. */
#define DEFAULT_MAX_PACKET_SZ 32768
Expand Down
Loading