net: Split out common help functions.
[Samba.git] / source / utils / net_proto.h
blobd5ca40c9df7daa69db3f3cb86ba11cebc147fb00
1 /*
2 * Unix SMB/CIFS implementation.
3 * collected prototypes header
5 * frozen from "make proto" in May 2008
7 * Copyright (C) Michael Adam 2008
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/>.
23 #ifndef _NET_PROTO_H_
24 #define _NET_PROTO_H_
27 /* The following definitions come from auth/token_util.c */
29 bool nt_token_check_sid ( const DOM_SID *sid, const NT_USER_TOKEN *token );
30 bool nt_token_check_domain_rid( NT_USER_TOKEN *token, uint32 rid );
31 NT_USER_TOKEN *get_root_nt_token( void );
32 NTSTATUS add_aliases(const DOM_SID *domain_sid,
33 struct nt_user_token *token);
34 struct nt_user_token *create_local_nt_token(TALLOC_CTX *mem_ctx,
35 const DOM_SID *user_sid,
36 bool is_guest,
37 int num_groupsids,
38 const DOM_SID *groupsids);
39 void debug_nt_user_token(int dbg_class, int dbg_lev, NT_USER_TOKEN *token);
40 void debug_unix_user_token(int dbg_class, int dbg_lev, uid_t uid, gid_t gid,
41 int n_groups, gid_t *groups);
43 /* The following definitions come from utils/net.c */
45 uint32 get_sec_channel_type(const char *param);
46 int net_run_function(struct net_context *c, int argc, const char **argv,
47 struct functable *table,
48 int (*usage_fn)(struct net_context *c,
49 int argc, const char **argv));
50 int net_run_function2(struct net_context *c, int argc, const char **argv,
51 const char *whoami, struct functable2 *table);
52 NTSTATUS connect_to_service(struct net_context *c,
53 struct cli_state **cli_ctx,
54 struct sockaddr_storage *server_ss,
55 const char *server_name,
56 const char *service_name,
57 const char *service_type);
58 NTSTATUS connect_to_ipc(struct net_context *c,
59 struct cli_state **cli_ctx,
60 struct sockaddr_storage *server_ss,
61 const char *server_name);
62 NTSTATUS connect_to_ipc_anonymous(struct net_context *c,
63 struct cli_state **cli_ctx,
64 struct sockaddr_storage *server_ss,
65 const char *server_name);
66 NTSTATUS connect_to_ipc_krb5(struct net_context *c,
67 struct cli_state **cli_ctx,
68 struct sockaddr_storage *server_ss,
69 const char *server_name);
70 NTSTATUS connect_dst_pipe(struct net_context *c, struct cli_state **cli_dst,
71 struct rpc_pipe_client **pp_pipe_hnd, int pipe_num);
72 int net_use_krb_machine_account(struct net_context *c);
73 int net_use_machine_account(struct net_context *c);
74 bool net_find_server(struct net_context *c,
75 const char *domain,
76 unsigned flags,
77 struct sockaddr_storage *server_ss,
78 char **server_name);
79 bool net_find_pdc(struct sockaddr_storage *server_ss,
80 fstring server_name,
81 const char *domain_name);
82 NTSTATUS net_make_ipc_connection(struct net_context *c, unsigned flags,
83 struct cli_state **pcli);
84 NTSTATUS net_make_ipc_connection_ex(struct net_context *c ,const char *domain,
85 const char *server,
86 struct sockaddr_storage *pss,
87 unsigned flags, struct cli_state **pcli);
88 int net_help_afs(struct net_context *c, int argc, const char **argv);
89 const char *net_prompt_pass(struct net_context *c, const char *user);
91 /* The following definitions come from utils/net_ads.c */
93 int net_ads_usage(struct net_context *c, int argc, const char **argv);
94 ADS_STATUS ads_startup(struct net_context *c, bool only_own_domain, ADS_STRUCT **ads);
95 ADS_STATUS ads_startup_nobind(struct net_context *c, bool only_own_domain, ADS_STRUCT **ads);
96 int net_ads_check_our_domain(struct net_context *c);
97 int net_ads_check(struct net_context *c);
98 int net_ads_user(struct net_context *c, int argc, const char **argv);
99 int net_ads_group(struct net_context *c, int argc, const char **argv);
100 int net_ads_testjoin(struct net_context *c, int argc, const char **argv);
101 int net_ads_join(struct net_context *c, int argc, const char **argv);
102 int net_ads_printer_usage(struct net_context *c, int argc, const char **argv);
103 int net_ads_changetrustpw(struct net_context *c, int argc, const char **argv);
104 int net_ads_keytab(struct net_context *c, int argc, const char **argv);
105 int net_ads_kerberos(struct net_context *c, int argc, const char **argv);
106 int net_ads_help(struct net_context *c, int argc, const char **argv);
107 int net_ads(struct net_context *c, int argc, const char **argv);
108 int net_ads_keytab(struct net_context *c, int argc, const char **argv);
109 int net_ads_kerberos(struct net_context *c, int argc, const char **argv);
110 int net_ads_usage(struct net_context *c, int argc, const char **argv);
111 int net_ads_help(struct net_context *c, int argc, const char **argv);
112 int net_ads_changetrustpw(struct net_context *c, int argc, const char **argv);
113 int net_ads_join(struct net_context *c, int argc, const char **argv);
114 int net_ads_user(struct net_context *c, int argc, const char **argv);
115 int net_ads_group(struct net_context *c, int argc, const char **argv);
116 int net_ads_check(struct net_context *c);
117 int net_ads_check_our_domain(struct net_context *c);
118 int net_ads(struct net_context *c, int argc, const char **argv);
120 /* The following definitions come from utils/net_ads_gpo.c */
122 int net_ads_gpo(struct net_context *c, int argc, const char **argv);
124 /* The following definitions come from utils/net_cache.c */
126 int net_cache(struct net_context *c, int argc, const char **argv);
128 /* The following definitions come from utils/net_conf.c */
130 int net_conf(struct net_context *c, int argc, const char **argv);
132 /* The following definitions come from utils/net_dns.c */
134 int get_my_ip_address( struct sockaddr_storage **pp_ss );
136 /* The following definitions come from utils/net_dom.c */
138 int net_help_dom(struct net_context *c, int argc, const char **argv);
139 int net_dom(struct net_context *c, int argc, const char **argv);
141 /* The following definitions come from utils/net_groupmap.c */
143 int net_help_groupmap(struct net_context *c, int argc, const char **argv);
144 int net_groupmap(struct net_context *c, int argc, const char **argv);
146 /* The following definitions come from utils/net_help.c */
148 int net_help_user(struct net_context *c, int argc, const char **argv);
149 int net_help_group(struct net_context *c, int argc, const char **argv);
150 int net_help_join(struct net_context *c, int argc, const char **argv);
151 int net_help_share(struct net_context *c, int argc, const char **argv);
152 int net_help_file(struct net_context *c, int argc, const char **argv);
153 int net_help_printer(struct net_context *c, int argc, const char **argv);
154 int net_help_status(struct net_context *c, int argc, const char **argv);
155 int net_help(struct net_context *c, int argc, const char **argv);
157 /* The following definitions come from utils/net_idmap.c */
159 bool idmap_store_secret(const char *backend, bool alloc,
160 const char *domain, const char *identity,
161 const char *secret);
162 int net_help_idmap(struct net_context *c, int argc, const char **argv);
163 int net_idmap(struct net_context *c, int argc, const char **argv);
165 /* The following definitions come from utils/net_lookup.c */
167 int net_lookup_usage(struct net_context *c, int argc, const char **argv);
168 int net_lookup(struct net_context *c, int argc, const char **argv);
170 /* The following definitions come from utils/net_rap.c */
172 int net_rap_file_usage(struct net_context *c, int argc, const char **argv);
173 int net_rap_file(struct net_context *c, int argc, const char **argv);
174 int net_rap_share_usage(struct net_context *c, int argc, const char **argv);
175 int net_rap_share(struct net_context *c, int argc, const char **argv);
176 int net_rap_session_usage(struct net_context *c, int argc, const char **argv);
177 int net_rap_session(struct net_context *c, int argc, const char **argv);
178 int net_rap_server_usage(struct net_context *c, int argc, const char **argv);
179 int net_rap_server(struct net_context *c, int argc, const char **argv);
180 int net_rap_domain_usage(struct net_context *c, int argc, const char **argv);
181 int net_rap_domain(struct net_context *c, int argc, const char **argv);
182 int net_rap_printq_usage(struct net_context *c, int argc, const char **argv);
183 int net_rap_printq(struct net_context *c, int argc, const char **argv);
184 int net_rap_user(struct net_context *c, int argc, const char **argv);
185 int net_rap_group_usage(struct net_context *c, int argc, const char **argv);
186 int net_rap_group(struct net_context *c, int argc, const char **argv);
187 int net_rap_groupmember_usage(struct net_context *c, int argc, const char **argv);
188 int net_rap_groupmember(struct net_context *c, int argc, const char **argv);
189 int net_rap_validate_usage(struct net_context *c, int argc, const char **argv);
190 int net_rap_validate(struct net_context *c, int argc, const char **argv);
191 int net_rap_service_usage(struct net_context *c, int argc, const char **argv);
192 int net_rap_service(struct net_context *c, int argc, const char **argv);
193 int net_rap_password_usage(struct net_context *c, int argc, const char **argv);
194 int net_rap_password(struct net_context *c, int argc, const char **argv);
195 int net_rap_admin_usage(struct net_context *c, int argc, const char **argv);
196 int net_rap_admin(struct net_context *c, int argc, const char **argv);
197 int net_rap_usage(struct net_context *c, int argc, const char **argv);
198 int net_rap_help(struct net_context *c, int argc, const char **argv);
199 int net_rap(struct net_context *c, int argc, const char **argv);
201 /* The following definitions come from utils/net_registry.c */
203 int net_registry(struct net_context *c, int argc, const char **argv);
205 /* The following definitions come from utils/net_rpc.c */
207 NTSTATUS net_get_remote_domain_sid(struct cli_state *cli, TALLOC_CTX *mem_ctx,
208 DOM_SID **domain_sid,
209 const char **domain_name);
210 int run_rpc_command(struct net_context *c,
211 struct cli_state *cli_arg,
212 const int pipe_idx,
213 int conn_flags,
214 rpc_command_fn fn,
215 int argc,
216 const char **argv);
217 int net_rpc_changetrustpw(struct net_context *c, int argc, const char **argv);
218 int net_rpc_join(struct net_context *c, int argc, const char **argv);
219 NTSTATUS rpc_info_internals(struct net_context *c,
220 const DOM_SID *domain_sid,
221 const char *domain_name,
222 struct cli_state *cli,
223 struct rpc_pipe_client *pipe_hnd,
224 TALLOC_CTX *mem_ctx,
225 int argc,
226 const char **argv);
227 int net_rpc_info(struct net_context *c, int argc, const char **argv);
228 int net_rpc_getsid(struct net_context *c, int argc, const char **argv);
229 int net_rpc_user(struct net_context *c, int argc, const char **argv);
230 struct rpc_sh_cmd *net_rpc_user_edit_cmds(struct net_context *c,
231 TALLOC_CTX *mem_ctx,
232 struct rpc_sh_ctx *ctx);
233 struct rpc_sh_cmd *net_rpc_user_cmds(struct net_context *c,
234 TALLOC_CTX *mem_ctx,
235 struct rpc_sh_ctx *ctx);
236 int net_rpc_group(struct net_context *c, int argc, const char **argv);
237 bool copy_top_level_perms(struct net_context *c,
238 struct copy_clistate *cp_clistate,
239 const char *sharename);
240 int net_usersidlist(struct net_context *c, int argc, const char **argv);
241 int net_usersidlist_usage(struct net_context *c, int argc, const char **argv);
242 int net_rpc_share(struct net_context *c, int argc, const char **argv);
243 struct rpc_sh_cmd *net_rpc_share_cmds(struct net_context *c, TALLOC_CTX *mem_ctx,
244 struct rpc_sh_ctx *ctx);
245 int net_rpc_file(struct net_context *c, int argc, const char **argv);
246 NTSTATUS rpc_init_shutdown_internals(struct net_context *c,
247 const DOM_SID *domain_sid,
248 const char *domain_name,
249 struct cli_state *cli,
250 struct rpc_pipe_client *pipe_hnd,
251 TALLOC_CTX *mem_ctx,
252 int argc,
253 const char **argv);
254 NTSTATUS rpc_reg_shutdown_internals(struct net_context *c,
255 const DOM_SID *domain_sid,
256 const char *domain_name,
257 struct cli_state *cli,
258 struct rpc_pipe_client *pipe_hnd,
259 TALLOC_CTX *mem_ctx,
260 int argc,
261 const char **argv);
262 bool net_rpc_check(struct net_context *c, unsigned flags);
263 int rpc_printer_migrate(struct net_context *c, int argc, const char **argv);
264 int rpc_printer_usage(struct net_context *c, int argc, const char **argv);
265 int net_rpc_printer(struct net_context *c, int argc, const char **argv);
266 int net_rpc_usage(struct net_context *c, int argc, const char **argv);
267 int net_rpc_help(struct net_context *c, int argc, const char **argv);
268 int net_rpc(struct net_context *c, int argc, const char **argv);
270 /* The following definitions come from utils/net_rpc_audit.c */
272 int net_rpc_audit(struct net_context *c, int argc, const char **argv);
274 /* The following definitions come from utils/net_rpc_join.c */
276 NTSTATUS net_rpc_join_ok(struct net_context *c, const char *domain,
277 const char *server, struct sockaddr_storage *pss);
278 int net_rpc_join_newstyle(struct net_context *c, int argc, const char **argv);
279 int net_rpc_testjoin(struct net_context *c, int argc, const char **argv);
281 /* The following definitions come from utils/net_rpc_printer.c */
283 NTSTATUS net_copy_fileattr(struct net_context *c,
284 TALLOC_CTX *mem_ctx,
285 struct cli_state *cli_share_src,
286 struct cli_state *cli_share_dst,
287 const char *src_name, const char *dst_name,
288 bool copy_acls, bool copy_attrs,
289 bool copy_timestamps, bool is_file);
290 NTSTATUS net_copy_file(struct net_context *c,
291 TALLOC_CTX *mem_ctx,
292 struct cli_state *cli_share_src,
293 struct cli_state *cli_share_dst,
294 const char *src_name, const char *dst_name,
295 bool copy_acls, bool copy_attrs,
296 bool copy_timestamps, bool is_file);
297 NTSTATUS rpc_printer_list_internals(struct net_context *c,
298 const DOM_SID *domain_sid,
299 const char *domain_name,
300 struct cli_state *cli,
301 struct rpc_pipe_client *pipe_hnd,
302 TALLOC_CTX *mem_ctx,
303 int argc,
304 const char **argv);
305 NTSTATUS rpc_printer_driver_list_internals(struct net_context *c,
306 const DOM_SID *domain_sid,
307 const char *domain_name,
308 struct cli_state *cli,
309 struct rpc_pipe_client *pipe_hnd,
310 TALLOC_CTX *mem_ctx,
311 int argc,
312 const char **argv);
313 NTSTATUS rpc_printer_publish_publish_internals(struct net_context *c,
314 const DOM_SID *domain_sid,
315 const char *domain_name,
316 struct cli_state *cli,
317 struct rpc_pipe_client *pipe_hnd,
318 TALLOC_CTX *mem_ctx,
319 int argc,
320 const char **argv);
321 NTSTATUS rpc_printer_publish_unpublish_internals(struct net_context *c,
322 const DOM_SID *domain_sid,
323 const char *domain_name,
324 struct cli_state *cli,
325 struct rpc_pipe_client *pipe_hnd,
326 TALLOC_CTX *mem_ctx,
327 int argc,
328 const char **argv);
329 NTSTATUS rpc_printer_publish_update_internals(struct net_context *c,
330 const DOM_SID *domain_sid,
331 const char *domain_name,
332 struct cli_state *cli,
333 struct rpc_pipe_client *pipe_hnd,
334 TALLOC_CTX *mem_ctx,
335 int argc,
336 const char **argv);
337 NTSTATUS rpc_printer_publish_list_internals(struct net_context *c,
338 const DOM_SID *domain_sid,
339 const char *domain_name,
340 struct cli_state *cli,
341 struct rpc_pipe_client *pipe_hnd,
342 TALLOC_CTX *mem_ctx,
343 int argc,
344 const char **argv);
345 NTSTATUS rpc_printer_migrate_security_internals(struct net_context *c,
346 const DOM_SID *domain_sid,
347 const char *domain_name,
348 struct cli_state *cli,
349 struct rpc_pipe_client *pipe_hnd,
350 TALLOC_CTX *mem_ctx,
351 int argc,
352 const char **argv);
353 NTSTATUS rpc_printer_migrate_forms_internals(struct net_context *c,
354 const DOM_SID *domain_sid,
355 const char *domain_name,
356 struct cli_state *cli,
357 struct rpc_pipe_client *pipe_hnd,
358 TALLOC_CTX *mem_ctx,
359 int argc,
360 const char **argv);
361 NTSTATUS rpc_printer_migrate_drivers_internals(struct net_context *c,
362 const DOM_SID *domain_sid,
363 const char *domain_name,
364 struct cli_state *cli,
365 struct rpc_pipe_client *pipe_hnd,
366 TALLOC_CTX *mem_ctx,
367 int argc,
368 const char **argv);
369 NTSTATUS rpc_printer_migrate_printers_internals(struct net_context *c,
370 const DOM_SID *domain_sid,
371 const char *domain_name,
372 struct cli_state *cli,
373 struct rpc_pipe_client *pipe_hnd,
374 TALLOC_CTX *mem_ctx,
375 int argc,
376 const char **argv);
377 NTSTATUS rpc_printer_migrate_settings_internals(struct net_context *c,
378 const DOM_SID *domain_sid,
379 const char *domain_name,
380 struct cli_state *cli,
381 struct rpc_pipe_client *pipe_hnd,
382 TALLOC_CTX *mem_ctx,
383 int argc,
384 const char **argv);
386 /* The following definitions come from utils/net_rpc_registry.c */
388 int net_rpc_registry(struct net_context *c, int argc, const char **argv);
390 /* The following definitions come from utils/net_rpc_rights.c */
392 int net_rpc_rights(struct net_context *c, int argc, const char **argv);
393 struct rpc_sh_cmd *net_rpc_rights_cmds(struct net_context *c, TALLOC_CTX *mem_ctx,
394 struct rpc_sh_ctx *ctx);
396 /* The following definitions come from utils/net_rpc_samsync.c */
398 NTSTATUS rpc_samdump_internals(struct net_context *c,
399 const DOM_SID *domain_sid,
400 const char *domain_name,
401 struct cli_state *cli,
402 struct rpc_pipe_client *pipe_hnd,
403 TALLOC_CTX *mem_ctx,
404 int argc,
405 const char **argv);
406 int rpc_vampire_usage(struct net_context *c, int argc, const char **argv);
407 NTSTATUS rpc_vampire_internals(struct net_context *c,
408 const DOM_SID *domain_sid,
409 const char *domain_name,
410 struct cli_state *cli,
411 struct rpc_pipe_client *pipe_hnd,
412 TALLOC_CTX *mem_ctx,
413 int argc,
414 const char **argv);
416 /* The following definitions come from utils/net_rpc_service.c */
418 const char *svc_status_string( uint32 state );
419 int net_rpc_service(struct net_context *c, int argc, const char **argv);
421 /* The following definitions come from utils/net_rpc_sh_acct.c */
423 struct rpc_sh_cmd *net_rpc_acct_cmds(struct net_context *c, TALLOC_CTX *mem_ctx,
424 struct rpc_sh_ctx *ctx);
426 /* The following definitions come from utils/net_rpc_shell.c */
428 int net_rpc_shell(struct net_context *c, int argc, const char **argv);
430 /* The following definitions come from utils/net_sam.c */
432 int net_sam(struct net_context *c, int argc, const char **argv);
434 /* The following definitions come from utils/net_status.c */
436 int net_status(struct net_context *c, int argc, const char **argv);
438 /* The following definitions come from utils/net_time.c */
440 int net_time_usage(struct net_context *c, int argc, const char **argv);
441 int net_time(struct net_context *c, int argc, const char **argv);
443 /* The following definitions come from utils/net_usershare.c */
445 int net_usershare_usage(struct net_context *c, int argc, const char **argv);
446 int net_usershare_help(struct net_context *c, int argc, const char **argv);
447 int net_usershare(struct net_context *c, int argc, const char **argv);
449 /* The following definitions come from utils/net_util.c */
451 NTSTATUS net_rpc_lookup_name(struct net_context *c,
452 TALLOC_CTX *mem_ctx, struct cli_state *cli,
453 const char *name, const char **ret_domain,
454 const char **ret_name, DOM_SID *ret_sid,
455 enum lsa_SidType *ret_type);
457 /* The following definitions come from utils/netlookup.c */
459 NTSTATUS net_lookup_name_from_sid(struct net_context *c,
460 TALLOC_CTX *ctx,
461 DOM_SID *psid,
462 const char **ppdomain,
463 const char **ppname);
464 NTSTATUS net_lookup_sid_from_name(struct net_context *c, TALLOC_CTX *ctx,
465 const char *full_name, DOM_SID *pret_sid);
467 /* The following definitions come from utils/passwd_util.c */
469 char *stdin_new_passwd( void);
470 char *get_pass( const char *prompt, bool stdin_get);
472 #endif /* _NET_PROTO_H_ */