2 * Unix SMB/CIFS implementation.
3 * RPC Pipe client / server routines
4 * Copyright (C) Andrew Tridgell 1992-1998,
5 * Largely re-written : 2005
6 * Copyright (C) Jeremy Allison 1998 - 2005
7 * Copyright (C) Simo Sorce 2010
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, see <http://www.gnu.org/licenses/>.
24 #include "rpc_client/cli_pipe.h"
25 #include "rpc_server/srv_pipe_internal.h"
27 #include "../libcli/named_pipe_auth/npa_tstream.h"
28 #include "rpc_server/rpc_ncacn_np.h"
29 #include "librpc/gen_ndr/netlogon.h"
30 #include "librpc/gen_ndr/auth.h"
31 #include "../auth/auth_sam_reply.h"
34 #define DBGC_CLASS DBGC_RPC_SRV
36 static int pipes_open;
38 static struct pipes_struct *InternalPipes;
41 * the following prototypes are declared here to avoid
42 * code being moved about too much for a patch to be
43 * disrupted / less obvious.
45 * these functions, and associated functions that they
46 * call, should be moved behind a .so module-loading
47 * system _anyway_. so that's the next step...
50 /****************************************************************************
51 Internal Pipe iterator functions.
52 ****************************************************************************/
54 struct pipes_struct *get_first_internal_pipe(void)
59 struct pipes_struct *get_next_internal_pipe(struct pipes_struct *p)
64 static void free_pipe_rpc_context_internal( PIPE_RPC_FNS *list )
66 PIPE_RPC_FNS *tmp = list;
78 bool check_open_pipes(void)
80 struct pipes_struct *p;
82 for (p = InternalPipes; p != NULL; p = p->next) {
83 if (num_pipe_handles(p) != 0) {
90 /****************************************************************************
92 ****************************************************************************/
94 int close_internal_rpc_pipe_hnd(struct pipes_struct *p)
97 DEBUG(0,("Invalid pipe in close_internal_rpc_pipe_hnd\n"));
101 TALLOC_FREE(p->auth.auth_ctx);
103 free_pipe_rpc_context_internal( p->contexts );
105 /* Free the handles database. */
106 close_policy_by_pipe(p);
108 DLIST_REMOVE(InternalPipes, p);
115 /****************************************************************************
116 Make an internal namedpipes structure
117 ****************************************************************************/
119 struct pipes_struct *make_internal_rpc_pipe_p(TALLOC_CTX *mem_ctx,
120 const struct ndr_syntax_id *syntax,
121 struct client_address *client_id,
122 const struct auth_serversupplied_info *session_info,
123 struct messaging_context *msg_ctx)
125 struct pipes_struct *p;
127 DEBUG(4,("Create pipe requested %s\n",
128 get_pipe_name_from_syntax(talloc_tos(), syntax)));
130 p = TALLOC_ZERO_P(mem_ctx, struct pipes_struct);
133 DEBUG(0,("ERROR! no memory for pipes_struct!\n"));
137 p->mem_ctx = talloc_named(p, 0, "pipe %s %p",
138 get_pipe_name_from_syntax(talloc_tos(),
140 if (p->mem_ctx == NULL) {
141 DEBUG(0,("open_rpc_pipe_p: talloc_init failed.\n"));
146 if (!init_pipe_handles(p, syntax)) {
147 DEBUG(0,("open_rpc_pipe_p: init_pipe_handles failed.\n"));
152 p->session_info = copy_serverinfo(p, session_info);
153 if (p->session_info == NULL) {
154 DEBUG(0, ("open_rpc_pipe_p: copy_serverinfo failed\n"));
155 close_policy_by_pipe(p);
160 p->msg_ctx = msg_ctx;
162 DLIST_ADD(InternalPipes, p);
164 p->client_id = client_id;
166 p->endian = RPC_LITTLE_ENDIAN;
169 p->transport = NCALRPC;
171 DEBUG(4,("Created internal pipe %s (pipes_open=%d)\n",
172 get_pipe_name_from_syntax(talloc_tos(), syntax), pipes_open));
174 talloc_set_destructor(p, close_internal_rpc_pipe_hnd);
179 static NTSTATUS rpcint_dispatch(struct pipes_struct *p,
182 const DATA_BLOB *in_data,
185 uint32_t num_cmds = rpc_srv_get_pipe_num_cmds(&p->syntax);
186 const struct api_struct *cmds = rpc_srv_get_pipe_cmds(&p->syntax);
193 for (i = 0; i < num_cmds; i++) {
194 if (cmds[i].opnum == opnum && cmds[i].fn != NULL) {
200 return NT_STATUS_RPC_PROCNUM_OUT_OF_RANGE;
203 p->in_data.data = *in_data;
204 p->out_data.rdata = data_blob_null;
207 p->in_data.data = data_blob_null;
209 data_blob_free(&p->out_data.rdata);
210 talloc_free_children(p->mem_ctx);
211 return NT_STATUS_RPC_CALL_FAILED;
214 if (p->fault_state) {
215 p->fault_state = false;
216 data_blob_free(&p->out_data.rdata);
217 talloc_free_children(p->mem_ctx);
218 return NT_STATUS_RPC_CALL_FAILED;
221 if (p->bad_handle_fault_state) {
222 p->bad_handle_fault_state = false;
223 data_blob_free(&p->out_data.rdata);
224 talloc_free_children(p->mem_ctx);
225 return NT_STATUS_RPC_SS_CONTEXT_MISMATCH;
228 if (p->rng_fault_state) {
229 p->rng_fault_state = false;
230 data_blob_free(&p->out_data.rdata);
231 talloc_free_children(p->mem_ctx);
232 return NT_STATUS_RPC_PROCNUM_OUT_OF_RANGE;
235 *out_data = p->out_data.rdata;
236 talloc_steal(mem_ctx, out_data->data);
237 p->out_data.rdata = data_blob_null;
239 talloc_free_children(p->mem_ctx);
243 struct rpcint_bh_state {
244 struct pipes_struct *p;
247 static bool rpcint_bh_is_connected(struct dcerpc_binding_handle *h)
249 struct rpcint_bh_state *hs = dcerpc_binding_handle_data(h,
250 struct rpcint_bh_state);
259 static uint32_t rpcint_bh_set_timeout(struct dcerpc_binding_handle *h,
262 /* TODO: implement timeouts */
266 struct rpcint_bh_raw_call_state {
272 static struct tevent_req *rpcint_bh_raw_call_send(TALLOC_CTX *mem_ctx,
273 struct tevent_context *ev,
274 struct dcerpc_binding_handle *h,
275 const struct GUID *object,
278 const uint8_t *in_data,
281 struct rpcint_bh_state *hs =
282 dcerpc_binding_handle_data(h,
283 struct rpcint_bh_state);
284 struct tevent_req *req;
285 struct rpcint_bh_raw_call_state *state;
289 req = tevent_req_create(mem_ctx, &state,
290 struct rpcint_bh_raw_call_state);
294 state->in_data.data = discard_const_p(uint8_t, in_data);
295 state->in_data.length = in_length;
297 ok = rpcint_bh_is_connected(h);
299 tevent_req_nterror(req, NT_STATUS_INVALID_CONNECTION);
300 return tevent_req_post(req, ev);
303 /* TODO: allow async */
304 status = rpcint_dispatch(hs->p, state, opnum,
307 if (!NT_STATUS_IS_OK(status)) {
308 tevent_req_nterror(req, status);
309 return tevent_req_post(req, ev);
312 tevent_req_done(req);
313 return tevent_req_post(req, ev);
316 static NTSTATUS rpcint_bh_raw_call_recv(struct tevent_req *req,
322 struct rpcint_bh_raw_call_state *state =
324 struct rpcint_bh_raw_call_state);
327 if (tevent_req_is_nterror(req, &status)) {
328 tevent_req_received(req);
332 *out_data = talloc_move(mem_ctx, &state->out_data.data);
333 *out_length = state->out_data.length;
335 tevent_req_received(req);
339 struct rpcint_bh_disconnect_state {
343 static struct tevent_req *rpcint_bh_disconnect_send(TALLOC_CTX *mem_ctx,
344 struct tevent_context *ev,
345 struct dcerpc_binding_handle *h)
347 struct rpcint_bh_state *hs = dcerpc_binding_handle_data(h,
348 struct rpcint_bh_state);
349 struct tevent_req *req;
350 struct rpcint_bh_disconnect_state *state;
353 req = tevent_req_create(mem_ctx, &state,
354 struct rpcint_bh_disconnect_state);
359 ok = rpcint_bh_is_connected(h);
361 tevent_req_nterror(req, NT_STATUS_INVALID_CONNECTION);
362 return tevent_req_post(req, ev);
366 * TODO: do a real async disconnect ...
368 * For now the caller needs to free pipes_struct
372 tevent_req_done(req);
373 return tevent_req_post(req, ev);
376 static NTSTATUS rpcint_bh_disconnect_recv(struct tevent_req *req)
380 if (tevent_req_is_nterror(req, &status)) {
381 tevent_req_received(req);
385 tevent_req_received(req);
389 static bool rpcint_bh_ref_alloc(struct dcerpc_binding_handle *h)
394 static void rpcint_bh_do_ndr_print(struct dcerpc_binding_handle *h,
396 const void *_struct_ptr,
397 const struct ndr_interface_call *call)
399 void *struct_ptr = discard_const(_struct_ptr);
401 if (DEBUGLEVEL < 11) {
405 if (ndr_flags & NDR_IN) {
406 ndr_print_function_debug(call->ndr_print,
411 if (ndr_flags & NDR_OUT) {
412 ndr_print_function_debug(call->ndr_print,
419 static const struct dcerpc_binding_handle_ops rpcint_bh_ops = {
421 .is_connected = rpcint_bh_is_connected,
422 .set_timeout = rpcint_bh_set_timeout,
423 .raw_call_send = rpcint_bh_raw_call_send,
424 .raw_call_recv = rpcint_bh_raw_call_recv,
425 .disconnect_send = rpcint_bh_disconnect_send,
426 .disconnect_recv = rpcint_bh_disconnect_recv,
428 .ref_alloc = rpcint_bh_ref_alloc,
429 .do_ndr_print = rpcint_bh_do_ndr_print,
432 static NTSTATUS rpcint_binding_handle_ex(TALLOC_CTX *mem_ctx,
433 const struct ndr_syntax_id *abstract_syntax,
434 const struct ndr_interface_table *ndr_table,
435 struct client_address *client_id,
436 const struct auth_serversupplied_info *session_info,
437 struct messaging_context *msg_ctx,
438 struct dcerpc_binding_handle **binding_handle)
440 struct dcerpc_binding_handle *h;
441 struct rpcint_bh_state *hs;
444 abstract_syntax = &ndr_table->syntax_id;
447 h = dcerpc_binding_handle_create(mem_ctx,
452 struct rpcint_bh_state,
455 return NT_STATUS_NO_MEMORY;
457 hs->p = make_internal_rpc_pipe_p(hs,
464 return NT_STATUS_NO_MEMORY;
471 * @brief Create a new DCERPC Binding Handle which uses a local dispatch function.
473 * @param[in] mem_ctx The memory context to use.
475 * @param[in] ndr_table Normally the ndr_table_<name>.
477 * @param[in] client_id The info about the connected client.
479 * @param[in] serversupplied_info The server supplied authentication function.
481 * @param[in] msg_ctx The messaging context that can be used by the server
483 * @param[out] binding_handle A pointer to store the connected
484 * dcerpc_binding_handle
486 * @return NT_STATUS_OK on success, a corresponding NT status if an
490 * struct dcerpc_binding_handle *winreg_binding;
493 * status = rpcint_binding_handle(tmp_ctx,
501 NTSTATUS rpcint_binding_handle(TALLOC_CTX *mem_ctx,
502 const struct ndr_interface_table *ndr_table,
503 struct client_address *client_id,
504 const struct auth_serversupplied_info *session_info,
505 struct messaging_context *msg_ctx,
506 struct dcerpc_binding_handle **binding_handle)
508 return rpcint_binding_handle_ex(mem_ctx, NULL, ndr_table, client_id,
509 session_info, msg_ctx, binding_handle);
515 * @brief Create a new RPC client context which uses a local transport.
517 * This creates a local transport. It is a shortcut to directly call the server
518 * functions and avoid marschalling.
520 * @param[in] mem_ctx The memory context to use.
522 * @param[in] abstract_syntax Normally the syntax_id of the autogenerated
525 * @param[in] serversupplied_info The server supplied authentication function.
527 * @param[in] client_id The client address information.
529 * @param[in] msg_ctx The messaging context to use.
531 * @param[out] presult A pointer to store the connected rpc client pipe.
533 * @return NT_STATUS_OK on success, a corresponding NT status if an
537 * struct rpc_pipe_client *winreg_pipe;
540 * status = rpc_pipe_open_internal(tmp_ctx,
541 * &ndr_table_winreg.syntax_id,
547 NTSTATUS rpc_pipe_open_internal(TALLOC_CTX *mem_ctx,
548 const struct ndr_syntax_id *abstract_syntax,
549 const struct auth_serversupplied_info *serversupplied_info,
550 struct client_address *client_id,
551 struct messaging_context *msg_ctx,
552 struct rpc_pipe_client **presult)
554 struct rpc_pipe_client *result;
557 result = TALLOC_ZERO_P(mem_ctx, struct rpc_pipe_client);
558 if (result == NULL) {
559 return NT_STATUS_NO_MEMORY;
562 result->abstract_syntax = *abstract_syntax;
563 result->transfer_syntax = ndr_transfer_syntax;
565 if (client_id == NULL) {
566 static struct client_address unknown;
567 strlcpy(unknown.addr, "<UNKNOWN>", sizeof(unknown.addr));
568 unknown.name = "<UNKNOWN>";
569 client_id = &unknown;
572 result->max_xmit_frag = -1;
573 result->max_recv_frag = -1;
575 status = rpcint_binding_handle_ex(result,
581 &result->binding_handle);
582 if (!NT_STATUS_IS_OK(status)) {
591 /****************************************************************************
592 * External pipes functions
593 ***************************************************************************/
596 struct np_proxy_state *make_external_rpc_pipe_p(TALLOC_CTX *mem_ctx,
597 const char *pipe_name,
598 const struct tsocket_address *local_address,
599 const struct tsocket_address *remote_address,
600 const struct auth_serversupplied_info *session_info)
602 struct np_proxy_state *result;
604 const char *socket_dir;
605 struct tevent_context *ev;
606 struct tevent_req *subreq;
607 struct auth_session_info_transport *session_info_t;
608 struct auth_user_info_dc *user_info_dc;
609 union netr_Validation val;
615 result = talloc(mem_ctx, struct np_proxy_state);
616 if (result == NULL) {
617 DEBUG(0, ("talloc failed\n"));
621 result->read_queue = tevent_queue_create(result, "np_read");
622 if (result->read_queue == NULL) {
623 DEBUG(0, ("tevent_queue_create failed\n"));
627 result->write_queue = tevent_queue_create(result, "np_write");
628 if (result->write_queue == NULL) {
629 DEBUG(0, ("tevent_queue_create failed\n"));
633 ev = s3_tevent_context_init(talloc_tos());
635 DEBUG(0, ("s3_tevent_context_init failed\n"));
639 socket_dir = lp_parm_const_string(
640 GLOBAL_SECTION_SNUM, "external_rpc_pipe", "socket_dir",
642 if (socket_dir == NULL) {
643 DEBUG(0, ("externan_rpc_pipe:socket_dir not set\n"));
646 socket_np_dir = talloc_asprintf(talloc_tos(), "%s/np", socket_dir);
647 if (socket_np_dir == NULL) {
648 DEBUG(0, ("talloc_asprintf failed\n"));
652 session_info_t = talloc_zero(talloc_tos(), struct auth_session_info_transport);
653 if (session_info_t == NULL) {
654 DEBUG(0, ("talloc failed\n"));
658 /* Send the named_pipe_auth server the user's full token */
659 session_info_t->security_token = session_info->security_token;
660 session_info_t->session_key = session_info->user_session_key;
662 val.sam3 = session_info->info3;
664 /* Convert into something we can build a struct
665 * auth_session_info_transport from. Most of the work here
666 * will be to convert the SIDS, which we will then ignore, but
667 * this is the easier way to handle it */
668 status = make_user_info_dc_netlogon_validation(talloc_tos(), "", 3, &val, &user_info_dc);
669 if (!NT_STATUS_IS_OK(status)) {
670 DEBUG(0, ("conversion of info3 into user_info_dc failed!\n"));
674 session_info_t->info = talloc_move(session_info_t, &user_info_dc->info);
675 talloc_free(user_info_dc);
678 subreq = tstream_npa_connect_send(talloc_tos(), ev,
681 remote_address, /* client_addr */
682 NULL, /* client_name */
683 local_address, /* server_addr */
684 NULL, /* server_name */
686 if (subreq == NULL) {
688 DEBUG(0, ("tstream_npa_connect_send to %s for pipe %s and "
689 "user %s\\%s failed\n",
690 socket_np_dir, pipe_name, session_info_t->info->domain_name,
691 session_info_t->info->account_name));
694 ok = tevent_req_poll(subreq, ev);
697 DEBUG(0, ("tevent_req_poll to %s for pipe %s and user %s\\%s "
698 "failed for tstream_npa_connect: %s\n",
699 socket_np_dir, pipe_name, session_info_t->info->domain_name,
700 session_info_t->info->account_name,
705 ret = tstream_npa_connect_recv(subreq, &sys_errno,
709 &result->device_state,
710 &result->allocation_size);
713 DEBUG(0, ("tstream_npa_connect_recv to %s for pipe %s and "
714 "user %s\\%s failed: %s\n",
715 socket_np_dir, pipe_name, session_info_t->info->domain_name,
716 session_info_t->info->account_name,
717 strerror(sys_errno)));
728 static NTSTATUS rpc_pipe_open_external(TALLOC_CTX *mem_ctx,
729 const char *pipe_name,
730 const struct ndr_syntax_id *abstract_syntax,
731 const struct auth_serversupplied_info *session_info,
732 struct rpc_pipe_client **_result)
734 struct tsocket_address *local, *remote;
735 struct rpc_pipe_client *result = NULL;
736 struct np_proxy_state *proxy_state = NULL;
737 struct pipe_auth_data *auth;
741 /* this is an internal connection, fake up ip addresses */
742 ret = tsocket_address_inet_from_strings(talloc_tos(), "ip",
745 return NT_STATUS_NO_MEMORY;
747 ret = tsocket_address_inet_from_strings(talloc_tos(), "ip",
750 return NT_STATUS_NO_MEMORY;
753 proxy_state = make_external_rpc_pipe_p(mem_ctx, pipe_name,
754 local, remote, session_info);
756 return NT_STATUS_UNSUCCESSFUL;
759 result = talloc_zero(mem_ctx, struct rpc_pipe_client);
760 if (result == NULL) {
761 status = NT_STATUS_NO_MEMORY;
765 result->abstract_syntax = *abstract_syntax;
766 result->transfer_syntax = ndr_transfer_syntax;
768 result->desthost = get_myname(result);
769 result->srv_name_slash = talloc_asprintf_strupper_m(
770 result, "\\\\%s", result->desthost);
771 if ((result->desthost == NULL) || (result->srv_name_slash == NULL)) {
772 status = NT_STATUS_NO_MEMORY;
776 result->max_xmit_frag = RPC_MAX_PDU_FRAG_LEN;
777 result->max_recv_frag = RPC_MAX_PDU_FRAG_LEN;
779 status = rpc_transport_tstream_init(result,
782 if (!NT_STATUS_IS_OK(status)) {
786 result->binding_handle = rpccli_bh_create(result);
787 if (result->binding_handle == NULL) {
788 status = NT_STATUS_NO_MEMORY;
789 DEBUG(0, ("Failed to create binding handle.\n"));
793 result->auth = talloc_zero(result, struct pipe_auth_data);
795 status = NT_STATUS_NO_MEMORY;
798 result->auth->auth_type = DCERPC_AUTH_TYPE_NONE;
799 result->auth->auth_level = DCERPC_AUTH_LEVEL_NONE;
801 status = rpccli_anon_bind_data(result, &auth);
802 if (!NT_STATUS_IS_OK(status)) {
803 DEBUG(0, ("Failed to initialize anonymous bind.\n"));
807 status = rpc_pipe_bind(result, auth);
808 if (!NT_STATUS_IS_OK(status)) {
809 DEBUG(0, ("Failed to bind external pipe.\n"));
814 if (!NT_STATUS_IS_OK(status)) {
817 TALLOC_FREE(proxy_state);
823 * @brief Create a new RPC client context which uses a local dispatch function.
825 * @param mem_ctx The memory context on which thje pipe will ultimately
827 * @param name The pipe name to connect to.
828 * @param session_info Credentials to use for the connection.
829 * @param pipe [in|out] Checks if a pipe is connected, and connects it
832 * @return NT_STATUS_OK on success, a corresponding NT status if
836 NTSTATUS rpc_pipe_open_interface(TALLOC_CTX *mem_ctx,
837 const struct ndr_syntax_id *syntax,
838 const struct auth_serversupplied_info *session_info,
839 struct client_address *client_id,
840 struct messaging_context *msg_ctx,
841 struct rpc_pipe_client **cli_pipe)
843 struct rpc_pipe_client *cli = NULL;
844 const char *server_type;
845 const char *pipe_name;
849 if (cli_pipe && rpccli_is_connected(*cli_pipe)) {
852 TALLOC_FREE(*cli_pipe);
855 tmp_ctx = talloc_stackframe();
856 if (tmp_ctx == NULL) {
857 return NT_STATUS_NO_MEMORY;
860 pipe_name = get_pipe_name_from_syntax(tmp_ctx, syntax);
861 if (pipe_name == NULL) {
862 status = NT_STATUS_INVALID_PARAMETER;
866 while (pipe_name[0] == '\\') {
870 DEBUG(5, ("Connecting to %s pipe.\n", pipe_name));
872 server_type = lp_parm_const_string(GLOBAL_SECTION_SNUM,
873 "rpc_server", pipe_name,
876 if (StrCaseCmp(server_type, "embedded") == 0) {
877 status = rpc_pipe_open_internal(tmp_ctx,
878 syntax, session_info,
881 if (!NT_STATUS_IS_OK(status)) {
884 } else if (StrCaseCmp(server_type, "daemon") == 0 ||
885 StrCaseCmp(server_type, "external") == 0) {
886 /* It would be nice to just use rpc_pipe_open_ncalrpc() but
887 * for now we need to use the special proxy setup to connect
890 status = rpc_pipe_open_external(tmp_ctx,
894 if (!NT_STATUS_IS_OK(status)) {
898 status = NT_STATUS_NOT_IMPLEMENTED;
899 DEBUG(0, ("Wrong servertype specified in config file: %s",
904 status = NT_STATUS_OK;
906 if (NT_STATUS_IS_OK(status)) {
907 *cli_pipe = talloc_move(mem_ctx, &cli);
909 TALLOC_FREE(tmp_ctx);