nhyatt/putty-source
1
0
Fork 0
mirror of https://git.tartarus.org/simon/putty.git synced 2025-06-30 19:12:48 -05:00
Code Issues Projects Releases Wiki Activity

Split seat_banner from seat_output.

Browse Source 
Previously, SSH authentication banners were displayed by calling the
ordinary seat_output function, and passing it a special value in the
SeatOutputType enumeration indicating an auth banner.

The awkwardness of this was already showing a little in SshProxy's
implementation of seat_output, where it had to check for that special
value and do totally different things for SEAT_OUTPUT_AUTH_BANNER and
everything else. Further work in that area is going to make it more
and more awkward if I keep the two output systems unified.

So let's split them up. Now, Seat has separate output() and banner()
methods, which each implementation can override differently if it
wants to.

All the 'end user' Seat implementations use the centralised
implementation function nullseat_banner_to_stderr(), which turns
banner text straight back into SEAT_OUTPUT_STDERR and passes it on to
seat_output. So I didn't have to tediously implement a boring version
of this function in GTK, Windows GUI, consoles, file transfer etc.
This commit is contained in:
Simon Tatham
2021-10-30 17:06:00 +01:00
parent 971c70e603
commit 74a0be9c56
12 changed files with 53 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
putty.h
View File

@ -925,7 +925,7 @@ typedef enum SeatInteractionContext {
} SeatInteractionContext;
typedef enum SeatOutputType {
SEAT_OUTPUT_STDOUT, SEAT_OUTPUT_STDERR, SEAT_OUTPUT_AUTH_BANNER
SEAT_OUTPUT_STDOUT, SEAT_OUTPUT_STDERR
} SeatOutputType;
/*
@ -941,11 +941,10 @@ struct Seat {
struct SeatVtable {
/*
* Provide output from the remote session. 'type' indicates the
* type of the output (stdout, stderr or SSH auth banner), which
* can be used to split the output into separate message channels,
* if the seat wants to handle them differently. But combining the
* channels into one is OK too; that's what terminal-window based
* seats do.
* type of the output (stdout or stderr), which can be used to
* split the output into separate message channels, if the seat
* wants to handle them differently. But combining the channels
* into one is OK too; that's what terminal-window based seats do.
*
* The return value is the current size of the output backlog.
*/
@ -971,6 +970,14 @@ struct SeatVtable {
*/
void (*sent)(Seat *seat, size_t new_sendbuffer);
/*
* Provide authentication-banner output from the session setup.
* End-user Seats can treat this as very similar to 'output', but
* intermediate Seats in complex proxying situations will want to
* implement this and 'output' differently.
*/
size_t (*banner)(Seat *seat, const void *data, size_t len);
/*
* Try to get answers from a set of interactive login prompts. The
* prompts are provided in 'p'.
@ -1227,6 +1234,8 @@ static inline bool seat_eof(Seat *seat)
{ return seat->vt->eof(seat); }
static inline void seat_sent(Seat *seat, size_t bufsize)
{ seat->vt->sent(seat, bufsize); }
static inline size_t seat_banner(Seat *seat, const void *data, size_t len)
{ return seat->vt->banner(seat, data, len); }
static inline int seat_get_userpass_input(Seat *seat, prompts_t *p)
{ return seat->vt->get_userpass_input(seat, p); }
static inline void seat_notify_session_started(Seat *seat)
@ -1293,10 +1302,10 @@ static inline size_t seat_stderr(Seat *seat, const void *data, size_t len)
{ return seat_output(seat, SEAT_OUTPUT_STDERR, data, len); }
static inline size_t seat_stderr_pl(Seat *seat, ptrlen data)
{ return seat_output(seat, SEAT_OUTPUT_STDERR, data.ptr, data.len); }
static inline size_t seat_banner(Seat *seat, const void *data, size_t len)
{ return seat_output(seat, SEAT_OUTPUT_AUTH_BANNER, data, len); }
/* Alternative API for seat_banner taking a ptrlen */
static inline size_t seat_banner_pl(Seat *seat, ptrlen data)
{ return seat_output(seat, SEAT_OUTPUT_AUTH_BANNER, data.ptr, data.len); }
{ return seat->vt->banner(seat, data.ptr, data.len); }
/* In the utils subdir: print a message to the Seat which can't be
* spoofed by server-supplied auth-time output such as SSH banners */
@ -1313,6 +1322,8 @@ size_t nullseat_output(
Seat *seat, SeatOutputType type, const void *data, size_t len);
bool nullseat_eof(Seat *seat);
void nullseat_sent(Seat *seat, size_t bufsize);
size_t nullseat_banner(Seat *seat, const void *data, size_t len);
size_t nullseat_banner_to_stderr(Seat *seat, const void *data, size_t len);
int nullseat_get_userpass_input(Seat *seat, prompts_t *p);
void nullseat_notify_session_started(Seat *seat);
void nullseat_notify_remote_exit(Seat *seat);