Skip to content
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

Jump to bottom

[ADDED] Support %-encoded username/password in server URLs #765

Merged
merged 8 commits into from
Jun 13, 2024
Merged

[ADDED] Support %-encoded username/password in server URLs #765

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
022963c
[FIXED] Support %-encoding in username, password when parsing connect…
levb Jun 12, 2024
aa8def0
better test
levb Jun 12, 2024
8bdde70
[TEST ONLY] Fixed Test_JetStreamSubscribeIdleHeartbeat
levb Jun 13, 2024
20b1fee
Nit: removed an irrelevant format change
levb Jun 13, 2024
6c147f4
Merge branch 'lev-fix-JetStreamSubscribeIdleHeartbeat' into lev-url-e…
levb Jun 13, 2024
92b9c7d
PR feedback: typo
levb Jun 13, 2024
b3d247e
PR feedback: include %00 in the test
levb Jun 13, 2024
a1533fc
Merge branch 'lev-fix-JetStreamSubscribeIdleHeartbeat' into lev-url-e…
levb Jun 13, 2024
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
41 changes: 39 additions & 2 deletions src/url.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
#include "util.h"

#include <string.h>
#include <ctype.h>

#include "mem.h"

Expand Down Expand Up @@ -46,6 +47,42 @@
return s;
}

static natsStatus _decodeAndDup(char **decoded, const char *encoded)
{
size_t len = strlen(encoded);
const char *p = encoded;
const char *e = encoded + len;
char *d;

*decoded = NATS_MALLOC(len + 1);
if (*decoded == NULL)
{
return nats_setDefaultError(NATS_NO_MEMORY);

Check warning on line 60 in src/url.c

View check run for this annotation

Codecov / codecov/patch

src/url.c#L60 

Added line #L60 was not covered by tests
}
d = *decoded;
for (; p < e; p++)
{
if (*p != '%')
{
*d++ = *p;
continue;
}

if (e - p < 3 || (!isxdigit(*(p + 1)) || !isxdigit(*(p + 2))))
{
NATS_FREE(*decoded);
*decoded = NULL;
return nats_setError(NATS_ERR, "invalid percent encoding in URL: %s", encoded);
}

char buf[3] = {p[1], p[2], '\0'};
*d++ = (char)strtol(buf, NULL, 16);
p += 2;
}
*d = '\0';
return NATS_OK;
}

natsStatus
natsUrl_Create(natsUrl **newUrl, const char *urlStr)
{
Expand Down Expand Up @@ -166,9 +203,9 @@
DUP_STRING(s, url->host, host);

if (user != NULL)
IF_OK_DUP_STRING(s, url->username, user);
IFOK(s, _decodeAndDup(&url->username, user));
if (pwd != NULL)
IF_OK_DUP_STRING(s, url->password, pwd);
IFOK(s, _decodeAndDup(&url->password, pwd));

if ((s == NATS_OK) && nats_asprintf(&url->fullUrl, "%s://%s%s%s%s%s:%d%s%s",
scheme, userval, usep, pwdval, hsep, host, url->port, pathsep, pathval) < 0)
Expand Down
74 changes: 59 additions & 15 deletions test/test.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1764,6 +1764,36 @@ test_natsUrl(void)
natsUrl_Destroy(u);
u = NULL;

test("'tcp://%4C%65v%00ignored:p%77d%00ignoredalso@localhost':");
s = natsUrl_Create(&u, "tcp://%4C%65v%00ignored:p%77d%00ignoredalso@localhost");
testCond((s == NATS_OK)
&& (u != NULL)
&& (u->host != NULL)
&& (strcmp(u->host, "localhost") == 0)
&& (u->username != NULL)
&& (strcmp(u->username, "Lev") == 0)
&& (u->password != NULL)
&& (strcmp(u->password, "pwd") == 0)
&& (u->port == 4222));
natsUrl_Destroy(u);
u = NULL;

test("'tcp://%4C%65v:p%77d@localhost':");
s = natsUrl_Create(&u, "tcp://%4C%65v:p%77d@localhost");
testCond((s == NATS_OK) && (u != NULL) && (u->host != NULL) && (strcmp(u->host, "localhost") == 0) && (u->username != NULL) && (strcmp(u->username, "Lev") == 0) && (u->password != NULL) && (strcmp(u->password, "pwd") == 0) && (u->port == 4222));
natsUrl_Destroy(u);
u = NULL;

test("'tcp://%4c%65v:p%@localhost':");
s = natsUrl_Create(&u, "tcp://%4c%65v:p%@localhost");
testCond((s == NATS_ERR) && (u == NULL) && (strstr(nats_GetLastError(NULL), "invalid percent encoding in URL: p%") != NULL));
nats_clearLastError();
levb marked this conversation as resolved.
Show resolved Hide resolved

test("'tcp://%4H%65v:p%@localhost':");
s = natsUrl_Create(&u, "tcp://%4H%65v:p%@localhost");
testCond((s == NATS_ERR) && (u == NULL) && (strstr(nats_GetLastError(NULL), "invalid percent encoding in URL: %4H%65v") != NULL));
nats_clearLastError();

test("'tcp://localhost: 4222':");
s = natsUrl_Create(&u, "tcp://localhost: 4222");
testCond((s == NATS_INVALID_ARG)
Expand Down Expand Up @@ -27951,18 +27981,35 @@ test_JetStreamSubscribeIdleHearbeat(void)
s = js_Publish(NULL, js, "foo", "msg2", 4, NULL, &jerr);
testCond((s == NATS_OK) && (jerr == 0));

// Cheat by pretending that the server sends message seq 3, while client
// received only seq 1. Disable auto-ack for this message, or we mess up the
// server state.
#define PUBLISH_FAKE_JS_MSG_WITH_SEQ(_reply, _msg) \
{ \
natsSub_Lock(sub); \
inbox = sub->subject; \
sub->jsi->ackNone = true; \
natsSub_Unlock(sub); \
\
natsConn_setFilterWithClosure(nc, _setMsgReply, (void *)(_reply)); \
s = natsConnection_PublishString(nc, inbox, (_msg)); \
}

#define PUBLISH_FAKE_RESET() \
{ \
natsSub_Lock(sub); \
sub->jsi->ackNone = false; \
natsSub_Unlock(sub); \
}

test("Check seq mismatch: ");
natsSub_Lock(sub);
inbox = sub->subject;
natsSub_Unlock(sub);
// Cheat by pretending that the server sends message seq 3, while client received only seq 1.
natsConn_setFilterWithClosure(nc, _setMsgReply, (void*) "$JS.ACK.TEST.dur1.1.3.3.1624472520000000000.0");
s = natsConnection_PublishString(nc, inbox, "msg3");
PUBLISH_FAKE_JS_MSG_WITH_SEQ("$JS.ACK.TEST.dur1.1.3.3.1624472520000000000.0", "msg3 fake");
// Wait for past the next HB and we should get an async error
natsMutex_Lock(args.m);
while ((s != NATS_TIMEOUT) && !args.done)
s = natsCondition_TimedWait(args.c, args.m, 300);
natsMutex_Unlock(args.m);
PUBLISH_FAKE_RESET();
testCond(s == NATS_OK);

test("Check that notification is sent only once: ");
Expand Down Expand Up @@ -27996,15 +28043,15 @@ test_JetStreamSubscribeIdleHearbeat(void)
testCond(s == NATS_OK);

test("Skip again: ");
natsConn_setFilterWithClosure(nc, _setMsgReply, (void*) "$JS.ACK.TEST.dur1.1.4.4.1624482520000000000.0");
s = natsConnection_PublishString(nc, inbox, "msg4");
PUBLISH_FAKE_JS_MSG_WITH_SEQ("$JS.ACK.TEST.dur1.1.4.4.1624482520000000000.0", "msg4 fake");
testCond(s == NATS_OK);

test("Check async cb invoked: ");
natsMutex_Lock(args.m);
while ((s != NATS_TIMEOUT) && !args.done)
s = natsCondition_TimedWait(args.c, args.m, 1000);
natsMutex_Unlock(args.m);
PUBLISH_FAKE_RESET();
testCond(s == NATS_OK);

test("Check HB timer reports missed HB: ");
Expand Down Expand Up @@ -28059,11 +28106,7 @@ test_JetStreamSubscribeIdleHearbeat(void)
nats_clearLastError();

test("Skip: ");
natsSub_Lock(sub);
inbox = sub->subject;
natsSub_Unlock(sub);
natsConn_setFilterWithClosure(nc, _setMsgReply, (void*) "$JS.ACK.TEST.dur2.1.4.4.1624482520000000000.0");
s = natsConnection_PublishString(nc, inbox, "msg4");
PUBLISH_FAKE_JS_MSG_WITH_SEQ("$JS.ACK.TEST.dur2.1.4.4.1624482520000000000.0", "msg4 fake");
testCond(s == NATS_OK);

// For sync subs, we should not get async error
Expand All @@ -28074,6 +28117,7 @@ test_JetStreamSubscribeIdleHearbeat(void)
natsMutex_Unlock(args.m);
testCond(s == NATS_TIMEOUT);
nats_clearLastError();
PUBLISH_FAKE_RESET();

test("NextMsg reports error: ");
s = natsSubscription_NextMsg(&msg, sub, 1000);
Expand Down Expand Up @@ -28103,15 +28147,15 @@ test_JetStreamSubscribeIdleHearbeat(void)
testCond(s == NATS_OK);

test("Skip again: ");
natsConn_setFilterWithClosure(nc, _setMsgReply, (void*) "$JS.ACK.TEST.dur1.1.5.5.1624492520000000000.0");
s = natsConnection_PublishString(nc, inbox, "msg5");
PUBLISH_FAKE_JS_MSG_WITH_SEQ("$JS.ACK.TEST.dur1.1.5.5.1624492520000000000.0", "msg5 fake");
testCond(s == NATS_OK);

test("NextMsg reports error: ");
nats_Sleep(300);
s = natsSubscription_NextMsg(&msg, sub, 1000);
testCond((s == NATS_MISMATCH) && (msg == NULL));
nats_clearLastError();
PUBLISH_FAKE_RESET();

test("Check HB timer reports missed HB: ");
s = NATS_OK;
Expand Down