2 * Windows support module which deals with being a named-pipe server.
8 #define DEFINE_PLUG_METHOD_MACROS
15 #if !defined NO_SECURITY
19 Socket make_handle_socket(HANDLE send_H, HANDLE recv_H, Plug plug,
22 typedef struct Socket_named_pipe_server_tag *Named_Pipe_Server_Socket;
23 struct Socket_named_pipe_server_tag {
24 const struct socket_function_table *fn;
25 /* the above variable absolutely *must* be the first in this structure */
27 /* Parameters for (repeated) creation of named pipe objects */
28 PSECURITY_DESCRIPTOR psd;
32 /* The current named pipe object + attempt to connect to it */
34 OVERLAPPED connect_ovl;
35 struct handle *callback_handle; /* winhandl.c's reference */
37 /* PuTTY Socket machinery */
42 static Plug sk_namedpipeserver_plug(Socket s, Plug p)
44 Named_Pipe_Server_Socket ps = (Named_Pipe_Server_Socket) s;
51 static void sk_namedpipeserver_close(Socket s)
53 Named_Pipe_Server_Socket ps = (Named_Pipe_Server_Socket) s;
55 if (ps->callback_handle)
56 handle_free(ps->callback_handle);
57 CloseHandle(ps->pipehandle);
58 CloseHandle(ps->connect_ovl.hEvent);
68 static const char *sk_namedpipeserver_socket_error(Socket s)
70 Named_Pipe_Server_Socket ps = (Named_Pipe_Server_Socket) s;
74 static int create_named_pipe(Named_Pipe_Server_Socket ps, int first_instance)
76 SECURITY_ATTRIBUTES sa;
78 memset(&sa, 0, sizeof(sa));
79 sa.nLength = sizeof(sa);
80 sa.lpSecurityDescriptor = ps->psd;
81 sa.bInheritHandle = FALSE;
83 ps->pipehandle = CreateNamedPipe
89 FILE_FLAG_OVERLAPPED |
90 (first_instance ? FILE_FLAG_FIRST_PIPE_INSTANCE : 0),
93 PIPE_TYPE_BYTE | PIPE_READMODE_BYTE | PIPE_WAIT
94 #ifdef PIPE_REJECT_REMOTE_CLIENTS
95 | PIPE_REJECT_REMOTE_CLIENTS
100 PIPE_UNLIMITED_INSTANCES,
102 /* nOutBufferSize, nInBufferSize */
103 4096, 4096, /* FIXME: think harder about buffer sizes? */
105 /* nDefaultTimeOut */
106 0 /* default timeout */,
108 /* lpSecurityAttributes */
111 return ps->pipehandle != INVALID_HANDLE_VALUE;
114 static Socket named_pipe_accept(accept_ctx_t ctx, Plug plug)
116 HANDLE conn = (HANDLE)ctx.p;
118 return make_handle_socket(conn, conn, plug, TRUE);
122 * Dummy SockAddr type which just holds a named pipe address. Only
123 * used for calling plug_log from named_pipe_accept_loop() here.
125 SockAddr sk_namedpipe_addr(const char *pipename);
127 static void named_pipe_accept_loop(Named_Pipe_Server_Socket ps,
134 if (got_one_already) {
135 /* If we were called with a connection already waiting,
137 got_one_already = FALSE;
141 * Call ConnectNamedPipe, which might succeed or might
142 * tell us that an overlapped operation is in progress and
143 * we should wait for our event object.
145 if (ConnectNamedPipe(ps->pipehandle, &ps->connect_ovl))
148 error = GetLastError();
150 if (error == ERROR_IO_PENDING)
154 if (error == 0 || error == ERROR_PIPE_CONNECTED) {
156 * We've successfully retrieved an incoming connection, so
157 * ps->pipehandle now refers to that connection. So
158 * convert that handle into a separate connection-type
159 * Socket, and create a fresh one to be the new listening
162 HANDLE conn = ps->pipehandle;
165 actx.p = (void *)conn;
166 if (plug_accepting(ps->plug, named_pipe_accept, actx)) {
168 * If the plug didn't want the connection, might as
169 * well close this handle.
174 if (!create_named_pipe(ps, FALSE)) {
175 error = GetLastError();
178 * Go round again to see if more connections can be
179 * got, or to begin waiting on the event object.
185 errmsg = dupprintf("Error while listening to named pipe: %s",
186 win_strerror(error));
187 plug_log(ps->plug, 1, sk_namedpipe_addr(ps->pipename), 0,
194 static void named_pipe_connect_callback(void *vps)
196 Named_Pipe_Server_Socket ps = (Named_Pipe_Server_Socket)vps;
197 named_pipe_accept_loop(ps, TRUE);
200 Socket new_named_pipe_listener(const char *pipename, Plug plug)
203 * This socket type is only used for listening, so it should never
204 * be asked to write or flush or set_frozen.
206 static const struct socket_function_table socket_fn_table = {
207 sk_namedpipeserver_plug,
208 sk_namedpipeserver_close,
210 NULL /* write_oob */,
211 NULL /* write_eof */,
213 NULL /* set_frozen */,
214 sk_namedpipeserver_socket_error
217 Named_Pipe_Server_Socket ret;
219 ret = snew(struct Socket_named_pipe_server_tag);
220 ret->fn = &socket_fn_table;
224 ret->pipename = dupstr(pipename);
226 ret->callback_handle = NULL;
228 assert(strncmp(pipename, "\\\\.\\pipe\\", 9) == 0);
229 assert(strchr(pipename + 9, '\\') == NULL);
231 if (!make_private_security_descriptor(GENERIC_READ | GENERIC_WRITE,
232 &ret->psd, &ret->acl, &ret->error)) {
236 if (!create_named_pipe(ret, TRUE)) {
237 ret->error = dupprintf("unable to create named pipe '%s': %s",
238 pipename, win_strerror(GetLastError()));
242 memset(&ret->connect_ovl, 0, sizeof(ret->connect_ovl));
243 ret->connect_ovl.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
244 ret->callback_handle =
245 handle_add_foreign_event(ret->connect_ovl.hEvent,
246 named_pipe_connect_callback, ret);
247 named_pipe_accept_loop(ret, FALSE);
253 #endif /* !defined NO_SECURITY */