-
-
Notifications
You must be signed in to change notification settings - Fork 899
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.
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
Add functionality to write to a temp file through url arguments #747
base: main
Are you sure you want to change the base?
Changes from 5 commits
ed9511a
cde0982
25f91ea
53565c7
5a3ad2f
4be5009
a487955
092dc3d
b9b962b
c01676c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||
---|---|---|---|---|
|
@@ -102,9 +102,34 @@ static bool spawn_process(struct pss_tty *pss, uint16_t columns, uint16_t rows) | |||
for (i = 0; i < server->argc; i++) { | ||||
argv[n++] = server->argv[i]; | ||||
} | ||||
for (i = 0; i < pss->argc; i++) { | ||||
argv[n++] = pss->args[i]; | ||||
if (server->url_arg) { | ||||
for (i = 0; i < pss->argc; i++) { | ||||
argv[n++] = pss->args[i]; | ||||
} | ||||
} | ||||
else if (server->arg_file != NULL) { | ||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: typical code style
as opposed to
consistent with ttyd : Line 65 in 5a3ad2f
|
||||
int fd = -1; | ||||
// mkstemp requires the file path to have suffix XXXXXX (len 7) | ||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. XXXXXX is len 6. no? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. (subjective opinion)
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yeah There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I was using |
||||
int file_path_len = strlen(server->arg_file) + 7; | ||||
char *filePath = xmalloc(file_path_len); | ||||
snprintf(filePath, file_path_len, "%sXXXXXX", server->arg_file); | ||||
|
||||
if ((fd = mkstemp(filePath)) == -1) { | ||||
lwsl_err("Creation of temp file failed with error: %d (%s)\n", errno, strerror(errno)); | ||||
return false; | ||||
} | ||||
|
||||
for (i = 0; i < pss->argc; i++) { | ||||
if (dprintf(fd, "%s\n", pss->args[i]) < 0) { | ||||
lwsl_err("Write to temp file failed with error: %d (%s)\n", errno, strerror(errno)); | ||||
return false; | ||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this will leak fd too. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. fixed |
||||
} | ||||
} | ||||
|
||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. need to close the file |
||||
argv[n++] = filePath; | ||||
close(fd); | ||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. you might want to
|
||||
} | ||||
|
||||
argv[n] = NULL; | ||||
|
||||
pty_process *process = process_init((void *) pss, server->loop, argv); | ||||
|
@@ -178,7 +203,7 @@ int callback_tty(struct lws *wsi, enum lws_callback_reasons reason, void *user, | |||
pss->wsi = wsi; | ||||
pss->lws_close_status = LWS_CLOSE_STATUS_NOSTATUS; | ||||
|
||||
if (server->url_arg) { | ||||
if (server->url_arg || server->arg_file != NULL) { | ||||
while (lws_hdr_copy_fragment(wsi, buf, sizeof(buf), WSI_TOKEN_HTTP_URI_ARGS, n++) > 0) { | ||||
if (strncmp(buf, "arg=", 4) == 0) { | ||||
pss->args = xrealloc(pss->args, (pss->argc + 1) * sizeof(char *)); | ||||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -73,6 +73,7 @@ static const struct option options[] = { | |
{"ssl-key", required_argument, NULL, 'K'}, | ||
{"ssl-ca", required_argument, NULL, 'A'}, | ||
{"url-arg", no_argument, NULL, 'a'}, | ||
{"arg-file", required_argument, NULL, 'f'}, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. why is this required argument? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I believe an optional argument must be passed in without a space ( If this isn't an issue, I can change the argument to be optional. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. TLDR: We can hold off discussion on this until ttyd maintainers respond as i feel this is a matter of taste mostly and we should please the reviewer 😛 skimmed through https://man7.org/linux/man-pages/man3/getopt.3.html. It seems the for optional arguments
In either case, optional might be the right thing to do. But if its an optional argument is there a way to distinguish between the the user running IMO Ideally (you might have different thoughts, which is reasonable)
overall this i feel this is quite opinionated! There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. also as @kahing was saying in another comment, not supporting the following is quite reasonable
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I agree with the cases you have listed there. I've tried making this argument optional but it seems like only cases Running If this behaviour isn't too confusing, I can make the argument optional. Alternatively, we could do something like |
||
{"readonly", no_argument, NULL, 'R'}, | ||
{"terminal-type", required_argument, NULL, 'T'}, | ||
{"client-option", required_argument, NULL, 't'}, | ||
|
@@ -86,10 +87,10 @@ static const struct option options[] = { | |
{NULL, 0, 0, 0}}; | ||
|
||
#if LWS_LIBRARY_VERSION_NUMBER < 4000000 | ||
static const char *opt_string = "p:i:c:u:g:s:I:b:6aSC:K:A:Rt:T:Om:oBd:vh"; | ||
static const char *opt_string = "p:i:c:u:g:s:I:b:6af:SC:K:A:Rt:T:Om:oBd:vh"; | ||
#endif | ||
#if LWS_LIBRARY_VERSION_NUMBER >= 4000000 | ||
static const char *opt_string = "p:i:c:u:g:s:I:b:P:6aSC:K:A:Rt:T:Om:oBd:vh"; | ||
static const char *opt_string = "p:i:c:u:g:s:I:b:P:6af:SC:K:A:Rt:T:Om:oBd:vh"; | ||
#endif | ||
|
||
static void print_help() { | ||
|
@@ -107,6 +108,7 @@ static void print_help() { | |
" -g, --gid Group id to run with\n" | ||
" -s, --signal Signal to send to the command when exit it (default: 1, SIGHUP)\n" | ||
" -a, --url-arg Allow client to send command line arguments in URL (eg: http://localhost:7681?arg=foo&arg=bar)\n" | ||
" -f, --arg-file File prefix for a unique generated temp file that URL arguments are written to (ex. /tmp/prefix); the generated file's full path is then passed in as a command line argument (ex. /tmp/prefix{unique string})\n" | ||
" -R, --readonly Do not allow clients to write to the TTY\n" | ||
" -t, --client-option Send option to client (format: key=value), repeat to add more options\n" | ||
" -T, --terminal-type Terminal type to report, default: xterm-256color\n" | ||
|
@@ -182,6 +184,7 @@ static struct server *server_new(int argc, char **argv, int start) { | |
|
||
static void server_free(struct server *ts) { | ||
if (ts == NULL) return; | ||
if (ts->arg_file != NULL) free(ts->arg_file); | ||
if (ts->credential != NULL) free(ts->credential); | ||
if (ts->index != NULL) free(ts->index); | ||
free(ts->command); | ||
|
@@ -321,6 +324,11 @@ int main(int argc, char **argv) { | |
break; | ||
case 'a': | ||
server->url_arg = true; | ||
server->arg_file = NULL; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. i think we might want to add a comment in help text, documentation that if both are set, behaviour is non deterministic. Alternatively we can make a choice that if both are set url_arg will win (or vice versa) Based on that you want to structure your There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The behaviour shouldn't be non deterministic here; the last specified argument of |
||
break; | ||
case 'f': | ||
server->arg_file = strdup(optarg); | ||
server->url_arg = false; | ||
break; | ||
case 'R': | ||
server->readonly = true; | ||
|
@@ -537,7 +545,8 @@ int main(int argc, char **argv) { | |
lwsl_notice(" websocket: %s\n", endpoints.ws); | ||
} | ||
if (server->check_origin) lwsl_notice(" check origin: true\n"); | ||
if (server->url_arg) lwsl_notice(" allow url arg: true\n"); | ||
if (server->url_arg) lwsl_notice(" allow url arg to cli arg: true\n"); | ||
if (server->arg_file != NULL) lwsl_notice(" temp file name prefix: %s\n", server->arg_file); | ||
if (server->readonly) lwsl_notice(" readonly: true\n"); | ||
if (server->max_clients > 0) | ||
lwsl_notice(" max clients: %d\n", server->max_clients); | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure if this would make it clear that the argument file prefix needs to first be passed in and that the contents would be the URL arguments
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should also say that the child process can do whatever it wants with the file (including deleting it)
(how you say it is a matter of taste and given that im not a maintainer of this repo, i will not give my suggestion :p )
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with @dotslash. and we need to tell user that the temp file will not be deleted by ttyd, or add some logic to delete it automatically on websocket closing?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
added a note to the end