s3: client: Add new utility function client_clean_name().
[Samba.git] / source3 / utils / smbcquotas.c
blob031862f52a11f24b6357df33584ec38caf33b330
1 /*
2 Unix SMB/CIFS implementation.
3 QUOTA get/set utility
5 Copyright (C) Andrew Tridgell 2000
6 Copyright (C) Tim Potter 2000
7 Copyright (C) Jeremy Allison 2000
8 Copyright (C) Stefan (metze) Metzmacher 2003
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
24 #include "includes.h"
25 #include "popt_common.h"
26 #include "rpc_client/cli_pipe.h"
27 #include "../librpc/gen_ndr/ndr_lsa.h"
28 #include "rpc_client/cli_lsarpc.h"
29 #include "fake_file.h"
30 #include "../libcli/security/security.h"
31 #include "libsmb/libsmb.h"
33 static char *server;
35 /* numeric is set when the user wants numeric SIDs and ACEs rather
36 than going via LSA calls to resolve them */
37 static bool numeric;
38 static bool verbose;
40 enum todo_values {NOOP_QUOTA=0,FS_QUOTA,USER_QUOTA,LIST_QUOTA,SET_QUOTA};
41 enum exit_values {EXIT_OK, EXIT_FAILED, EXIT_PARSE_ERROR};
43 static struct cli_state *cli_ipc;
44 static struct rpc_pipe_client *global_pipe_hnd;
45 static struct policy_handle pol;
46 static bool got_policy_hnd;
48 static struct cli_state *connect_one(const char *share);
50 /* Open cli connection and policy handle */
52 static bool cli_open_policy_hnd(void)
54 /* Initialise cli LSA connection */
56 if (!cli_ipc) {
57 NTSTATUS ret;
58 cli_ipc = connect_one("IPC$");
59 ret = cli_rpc_pipe_open_noauth(cli_ipc,
60 &ndr_table_lsarpc,
61 &global_pipe_hnd);
62 if (!NT_STATUS_IS_OK(ret)) {
63 return False;
67 /* Open policy handle */
69 if (!got_policy_hnd) {
71 /* Some systems don't support SEC_FLAG_MAXIMUM_ALLOWED,
72 but NT sends 0x2000000 so we might as well do it too. */
74 if (!NT_STATUS_IS_OK(rpccli_lsa_open_policy(global_pipe_hnd, talloc_tos(), True,
75 GENERIC_EXECUTE_ACCESS, &pol))) {
76 return False;
79 got_policy_hnd = True;
82 return True;
85 /* convert a SID to a string, either numeric or username/group */
86 static void SidToString(fstring str, struct dom_sid *sid, bool _numeric)
88 char **domains = NULL;
89 char **names = NULL;
90 enum lsa_SidType *types = NULL;
92 sid_to_fstring(str, sid);
94 if (_numeric) return;
96 /* Ask LSA to convert the sid to a name */
98 if (!cli_open_policy_hnd() ||
99 !NT_STATUS_IS_OK(rpccli_lsa_lookup_sids(global_pipe_hnd, talloc_tos(),
100 &pol, 1, sid, &domains,
101 &names, &types)) ||
102 !domains || !domains[0] || !names || !names[0]) {
103 return;
106 /* Converted OK */
108 slprintf(str, sizeof(fstring) - 1, "%s%s%s",
109 domains[0], lp_winbind_separator(),
110 names[0]);
113 /* convert a string to a SID, either numeric or username/group */
114 static bool StringToSid(struct dom_sid *sid, const char *str)
116 enum lsa_SidType *types = NULL;
117 struct dom_sid *sids = NULL;
118 bool result = True;
120 if (string_to_sid(sid, str)) {
121 return true;
124 if (!cli_open_policy_hnd() ||
125 !NT_STATUS_IS_OK(rpccli_lsa_lookup_names(global_pipe_hnd, talloc_tos(),
126 &pol, 1, &str, NULL, 1, &sids,
127 &types))) {
128 result = False;
129 goto done;
132 sid_copy(sid, &sids[0]);
133 done:
135 return result;
138 #define QUOTA_GET 1
139 #define QUOTA_SETLIM 2
140 #define QUOTA_SETFLAGS 3
141 #define QUOTA_LIST 4
143 enum {PARSE_FLAGS,PARSE_LIM};
145 static int parse_quota_set(TALLOC_CTX *ctx,
146 char *set_str,
147 char **pp_username_str,
148 enum SMB_QUOTA_TYPE *qtype,
149 int *cmd,
150 SMB_NTQUOTA_STRUCT *pqt)
152 char *p = set_str,*p2;
153 int todo;
154 bool stop = False;
155 bool enable = False;
156 bool deny = False;
158 *pp_username_str = NULL;
159 if (strnequal(set_str,"UQLIM:",6)) {
160 p += 6;
161 *qtype = SMB_USER_QUOTA_TYPE;
162 *cmd = QUOTA_SETLIM;
163 todo = PARSE_LIM;
164 if ((p2=strstr(p,":"))==NULL) {
165 return -1;
168 *p2 = '\0';
169 p2++;
171 *pp_username_str = talloc_strdup(ctx, p);
172 p = p2;
173 } else if (strnequal(set_str,"FSQLIM:",7)) {
174 p +=7;
175 *qtype = SMB_USER_FS_QUOTA_TYPE;
176 *cmd = QUOTA_SETLIM;
177 todo = PARSE_LIM;
178 } else if (strnequal(set_str,"FSQFLAGS:",9)) {
179 p +=9;
180 todo = PARSE_FLAGS;
181 *qtype = SMB_USER_FS_QUOTA_TYPE;
182 *cmd = QUOTA_SETFLAGS;
183 } else {
184 return -1;
187 switch (todo) {
188 case PARSE_LIM:
189 if (sscanf(p,"%"SCNu64"/%"SCNu64,&pqt->softlim,
190 &pqt->hardlim) != 2)
192 return -1;
195 break;
196 case PARSE_FLAGS:
197 while (!stop) {
199 if ((p2=strstr(p,"/"))==NULL) {
200 stop = True;
201 } else {
202 *p2 = '\0';
203 p2++;
206 if (strnequal(p,"QUOTA_ENABLED",13)) {
207 enable = True;
208 } else if (strnequal(p,"DENY_DISK",9)) {
209 deny = True;
210 } else if (strnequal(p,"LOG_SOFTLIMIT",13)) {
211 pqt->qflags |= QUOTAS_LOG_THRESHOLD;
212 } else if (strnequal(p,"LOG_HARDLIMIT",13)) {
213 pqt->qflags |= QUOTAS_LOG_LIMIT;
214 } else {
215 return -1;
218 p=p2;
221 if (deny) {
222 pqt->qflags |= QUOTAS_DENY_DISK;
223 } else if (enable) {
224 pqt->qflags |= QUOTAS_ENABLED;
227 break;
230 return 0;
234 static const char *quota_str_static(uint64_t val, bool special, bool _numeric)
236 const char *result;
238 if (!_numeric && special && val == 0) {
239 return "NO LIMIT";
241 result = talloc_asprintf(talloc_tos(), "%"PRIu64, val);
242 SMB_ASSERT(result != NULL);
243 return result;
246 static void dump_ntquota(SMB_NTQUOTA_STRUCT *qt, bool _verbose,
247 bool _numeric,
248 void (*_sidtostring)(fstring str,
249 struct dom_sid *sid,
250 bool _numeric))
252 TALLOC_CTX *frame = talloc_stackframe();
254 if (!qt) {
255 smb_panic("dump_ntquota() called with NULL pointer");
258 switch (qt->qtype) {
259 case SMB_USER_FS_QUOTA_TYPE:
261 d_printf("File System QUOTAS:\n");
262 d_printf("Limits:\n");
263 d_printf(" Default Soft Limit: %15s\n",
264 quota_str_static(qt->softlim,True,_numeric));
265 d_printf(" Default Hard Limit: %15s\n",
266 quota_str_static(qt->hardlim,True,_numeric));
267 d_printf("Quota Flags:\n");
268 d_printf(" Quotas Enabled: %s\n",
269 ((qt->qflags&QUOTAS_ENABLED)
270 ||(qt->qflags&QUOTAS_DENY_DISK))?"On":"Off");
271 d_printf(" Deny Disk: %s\n",
272 (qt->qflags&QUOTAS_DENY_DISK)?"On":"Off");
273 d_printf(" Log Soft Limit: %s\n",
274 (qt->qflags&QUOTAS_LOG_THRESHOLD)?"On":"Off");
275 d_printf(" Log Hard Limit: %s\n",
276 (qt->qflags&QUOTAS_LOG_LIMIT)?"On":"Off");
278 break;
279 case SMB_USER_QUOTA_TYPE:
281 fstring username_str = {0};
283 if (_sidtostring) {
284 _sidtostring(username_str,&qt->sid,_numeric);
285 } else {
286 sid_to_fstring(username_str, &qt->sid);
289 if (_verbose) {
290 d_printf("Quotas for User: %s\n",username_str);
291 d_printf("Used Space: %15s\n",
292 quota_str_static(qt->usedspace,False,
293 _numeric));
294 d_printf("Soft Limit: %15s\n",
295 quota_str_static(qt->softlim,True,
296 _numeric));
297 d_printf("Hard Limit: %15s\n",
298 quota_str_static(qt->hardlim,True,_numeric));
299 } else {
300 d_printf("%-30s: ",username_str);
301 d_printf("%15s/",quota_str_static(
302 qt->usedspace,False,_numeric));
303 d_printf("%15s/",quota_str_static(
304 qt->softlim,True,_numeric));
305 d_printf("%15s\n",quota_str_static(
306 qt->hardlim,True,_numeric));
309 break;
310 default:
311 d_printf("dump_ntquota() invalid qtype(%d)\n",qt->qtype);
313 TALLOC_FREE(frame);
314 return;
317 static void dump_ntquota_list(SMB_NTQUOTA_LIST **qtl, bool _verbose,
318 bool _numeric,
319 void (*_sidtostring)(fstring str,
320 struct dom_sid *sid,
321 bool _numeric))
323 SMB_NTQUOTA_LIST *cur;
325 for (cur = *qtl;cur;cur = cur->next) {
326 if (cur->quotas)
327 dump_ntquota(cur->quotas,_verbose,_numeric,
328 _sidtostring);
332 static int do_quota(struct cli_state *cli,
333 enum SMB_QUOTA_TYPE qtype,
334 uint16_t cmd,
335 const char *username_str,
336 SMB_NTQUOTA_STRUCT *pqt)
338 uint32_t fs_attrs = 0;
339 uint16_t quota_fnum = 0;
340 SMB_NTQUOTA_LIST *qtl = NULL;
341 TALLOC_CTX *qtl_ctx = NULL;
342 SMB_NTQUOTA_STRUCT qt;
343 NTSTATUS status;
345 ZERO_STRUCT(qt);
347 status = cli_get_fs_attr_info(cli, &fs_attrs);
348 if (!NT_STATUS_IS_OK(status)) {
349 d_printf("Failed to get the filesystem attributes %s.\n",
350 nt_errstr(status));
351 return -1;
354 if (!(fs_attrs & FILE_VOLUME_QUOTAS)) {
355 d_printf("Quotas are not supported by the server.\n");
356 return 0;
359 status = cli_get_quota_handle(cli, &quota_fnum);
360 if (!NT_STATUS_IS_OK(status)) {
361 d_printf("Quotas are not enabled on this share.\n");
362 d_printf("Failed to open %s %s.\n",
363 FAKE_FILE_NAME_QUOTA_WIN32,
364 nt_errstr(status));
365 return -1;
368 switch(qtype) {
369 case SMB_USER_QUOTA_TYPE:
370 if (!StringToSid(&qt.sid, username_str)) {
371 d_printf("StringToSid() failed for [%s]\n",username_str);
372 return -1;
375 switch(cmd) {
376 case QUOTA_GET:
377 status = cli_get_user_quota(
378 cli, quota_fnum, &qt);
379 if (!NT_STATUS_IS_OK(status)) {
380 d_printf("%s cli_get_user_quota %s\n",
381 nt_errstr(status),
382 username_str);
383 return -1;
385 dump_ntquota(&qt,verbose,numeric,SidToString);
386 break;
387 case QUOTA_SETLIM:
388 pqt->sid = qt.sid;
389 if ((qtl_ctx = talloc_init(
390 "SMB_USER_QUOTA_SET")) ==
391 NULL) {
392 return -1;
395 if (!add_record_to_ntquota_list(
396 qtl_ctx, pqt, &qtl)) {
397 TALLOC_FREE(qtl_ctx);
398 return -1;
401 status = cli_set_user_quota(
402 cli, quota_fnum, qtl);
403 free_ntquota_list(&qtl);
404 if (!NT_STATUS_IS_OK(status)) {
405 d_printf("%s cli_set_user_quota %s\n",
406 nt_errstr(status),
407 username_str);
408 return -1;
410 status = cli_get_user_quota(
411 cli, quota_fnum, &qt);
412 if (!NT_STATUS_IS_OK(status)) {
413 d_printf("%s cli_get_user_quota %s\n",
414 nt_errstr(status),
415 username_str);
416 return -1;
418 dump_ntquota(&qt,verbose,numeric,SidToString);
419 break;
420 case QUOTA_LIST:
421 status = cli_list_user_quota(
422 cli, quota_fnum, &qtl);
423 if (!NT_STATUS_IS_OK(status)) {
424 d_printf(
425 "%s cli_list_user_quota\n",
426 nt_errstr(status));
427 return -1;
429 dump_ntquota_list(&qtl,verbose,numeric,SidToString);
430 free_ntquota_list(&qtl);
431 break;
432 default:
433 d_printf("Unknown Error\n");
434 return -1;
436 break;
437 case SMB_USER_FS_QUOTA_TYPE:
438 switch(cmd) {
439 case QUOTA_GET:
440 status = cli_get_fs_quota_info(
441 cli, quota_fnum, &qt);
442 if (!NT_STATUS_IS_OK(status)) {
443 d_printf("%s cli_get_fs_quota_info\n",
444 nt_errstr(status));
445 return -1;
447 dump_ntquota(&qt,True,numeric,NULL);
448 break;
449 case QUOTA_SETLIM:
450 status = cli_get_fs_quota_info(
451 cli, quota_fnum, &qt);
452 if (!NT_STATUS_IS_OK(status)) {
453 d_printf("%s cli_get_fs_quota_info\n",
454 nt_errstr(status));
455 return -1;
457 qt.softlim = pqt->softlim;
458 qt.hardlim = pqt->hardlim;
459 status = cli_set_fs_quota_info(
460 cli, quota_fnum, &qt);
461 if (!NT_STATUS_IS_OK(status)) {
462 d_printf("%s cli_set_fs_quota_info\n",
463 nt_errstr(status));
464 return -1;
466 status = cli_get_fs_quota_info(
467 cli, quota_fnum, &qt);
468 if (!NT_STATUS_IS_OK(status)) {
469 d_printf("%s cli_get_fs_quota_info\n",
470 nt_errstr(status));
471 return -1;
473 dump_ntquota(&qt,True,numeric,NULL);
474 break;
475 case QUOTA_SETFLAGS:
476 status = cli_get_fs_quota_info(
477 cli, quota_fnum, &qt);
478 if (!NT_STATUS_IS_OK(status)) {
479 d_printf("%s cli_get_fs_quota_info\n",
480 nt_errstr(status));
481 return -1;
483 qt.qflags = pqt->qflags;
484 status = cli_set_fs_quota_info(
485 cli, quota_fnum, &qt);
486 if (!NT_STATUS_IS_OK(status)) {
487 d_printf("%s cli_set_fs_quota_info\n",
488 nt_errstr(status));
489 return -1;
491 status = cli_get_fs_quota_info(
492 cli, quota_fnum, &qt);
493 if (!NT_STATUS_IS_OK(status)) {
494 d_printf("%s cli_get_fs_quota_info\n",
495 nt_errstr(status));
496 return -1;
498 dump_ntquota(&qt,True,numeric,NULL);
499 break;
500 default:
501 d_printf("Unknown Error\n");
502 return -1;
504 break;
505 default:
506 d_printf("Unknown Error\n");
507 return -1;
510 cli_close(cli, quota_fnum);
512 return 0;
515 /*****************************************************
516 Return a connection to a server.
517 *******************************************************/
519 static struct cli_state *connect_one(const char *share)
521 struct cli_state *c;
522 NTSTATUS nt_status;
523 uint32_t flags = 0;
525 if (get_cmdline_auth_info_use_kerberos(popt_get_cmdline_auth_info())) {
526 flags |= CLI_FULL_CONNECTION_USE_KERBEROS |
527 CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS;
531 nt_status = cli_full_connection(&c, lp_netbios_name(), server,
532 NULL, 0,
533 share, "?????",
534 get_cmdline_auth_info_username(
535 popt_get_cmdline_auth_info()),
536 lp_workgroup(),
537 get_cmdline_auth_info_password(
538 popt_get_cmdline_auth_info()),
539 flags,
540 get_cmdline_auth_info_signing_state(
541 popt_get_cmdline_auth_info()));
542 if (!NT_STATUS_IS_OK(nt_status)) {
543 DEBUG(0,("cli_full_connection failed! (%s)\n", nt_errstr(nt_status)));
544 return NULL;
547 if (get_cmdline_auth_info_smb_encrypt(popt_get_cmdline_auth_info())) {
548 nt_status = cli_cm_force_encryption(c,
549 get_cmdline_auth_info_username(
550 popt_get_cmdline_auth_info()),
551 get_cmdline_auth_info_password(
552 popt_get_cmdline_auth_info()),
553 lp_workgroup(),
554 share);
555 if (!NT_STATUS_IS_OK(nt_status)) {
556 cli_shutdown(c);
557 return NULL;
561 return c;
564 /****************************************************************************
565 main program
566 ****************************************************************************/
567 int main(int argc, char *argv[])
569 const char **argv_const = discard_const_p(const char *, argv);
570 char *share;
571 int opt;
572 int result;
573 int todo = 0;
574 char *username_str = NULL;
575 char *path = NULL;
576 char *set_str = NULL;
577 enum SMB_QUOTA_TYPE qtype = SMB_INVALID_QUOTA_TYPE;
578 int cmd = 0;
579 static bool test_args = False;
580 struct cli_state *cli;
581 bool fix_user = False;
582 SMB_NTQUOTA_STRUCT qt;
583 TALLOC_CTX *frame = talloc_stackframe();
584 poptContext pc;
585 struct poptOption long_options[] = {
586 POPT_AUTOHELP
587 { "user", 'u', POPT_ARG_STRING, NULL, 'u', "Show quotas for user", "user" },
588 { "list", 'L', POPT_ARG_NONE, NULL, 'L', "List user quotas" },
589 { "fs", 'F', POPT_ARG_NONE, NULL, 'F', "Show filesystem quotas" },
590 { "set", 'S', POPT_ARG_STRING, NULL, 'S', "Set acls\n\
591 SETSTRING:\n\
592 UQLIM:<username>/<softlimit>/<hardlimit> for user quotas\n\
593 FSQLIM:<softlimit>/<hardlimit> for filesystem defaults\n\
594 FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT", "SETSTRING" },
595 { "numeric", 'n', POPT_ARG_NONE, NULL, 'n', "Don't resolve sids or limits to names" },
596 { "verbose", 'v', POPT_ARG_NONE, NULL, 'v', "be verbose" },
597 { "test-args", 't', POPT_ARG_NONE, NULL, 't', "Test arguments"},
598 {"max-protocol", 'm', POPT_ARG_STRING, NULL, 'm',
599 "Set the max protocol level", "LEVEL"},
600 POPT_COMMON_SAMBA
601 POPT_COMMON_CREDENTIALS
602 { NULL }
605 smb_init_locale();
607 ZERO_STRUCT(qt);
609 /* set default debug level to 1 regardless of what smb.conf sets */
610 setup_logging( "smbcquotas", DEBUG_STDERR);
611 lp_set_cmdline("log level", "1");
613 setlinebuf(stdout);
615 fault_setup();
617 pc = poptGetContext("smbcquotas", argc, argv_const, long_options, 0);
619 poptSetOtherOptionHelp(pc, "//server1/share1");
621 while ((opt = poptGetNextOpt(pc)) != -1) {
622 switch (opt) {
623 case 'n':
624 numeric = true;
625 break;
626 case 'v':
627 verbose = true;
628 break;
629 case 't':
630 test_args = true;
631 break;
632 case 'L':
633 if (todo != 0) {
634 d_printf("Please specify only one option of <-L|-F|-S|-u>\n");
635 exit(EXIT_PARSE_ERROR);
637 todo = LIST_QUOTA;
638 break;
640 case 'F':
641 if (todo != 0) {
642 d_printf("Please specify only one option of <-L|-F|-S|-u>\n");
643 exit(EXIT_PARSE_ERROR);
645 todo = FS_QUOTA;
646 break;
648 case 'u':
649 if (todo != 0) {
650 d_printf("Please specify only one option of <-L|-F|-S|-u>\n");
651 exit(EXIT_PARSE_ERROR);
653 username_str = talloc_strdup(frame, poptGetOptArg(pc));
654 if (!username_str) {
655 exit(EXIT_PARSE_ERROR);
657 todo = USER_QUOTA;
658 fix_user = True;
659 break;
661 case 'S':
662 if (todo != 0) {
663 d_printf("Please specify only one option of <-L|-F|-S|-u>\n");
664 exit(EXIT_PARSE_ERROR);
666 set_str = talloc_strdup(frame, poptGetOptArg(pc));
667 if (!set_str) {
668 exit(EXIT_PARSE_ERROR);
670 todo = SET_QUOTA;
671 break;
672 case 'm':
673 lp_set_cmdline("client max protocol",
674 poptGetOptArg(pc));
675 break;
679 if (todo == 0)
680 todo = USER_QUOTA;
682 if (!fix_user) {
683 username_str = talloc_strdup(
684 frame, get_cmdline_auth_info_username(
685 popt_get_cmdline_auth_info()));
686 if (!username_str) {
687 exit(EXIT_PARSE_ERROR);
691 /* Make connection to server */
692 if(!poptPeekArg(pc)) {
693 poptPrintUsage(pc, stderr, 0);
694 exit(EXIT_PARSE_ERROR);
697 path = talloc_strdup(frame, poptGetArg(pc));
698 if (!path) {
699 printf("Out of memory\n");
700 exit(EXIT_PARSE_ERROR);
703 poptFreeContext(pc);
704 popt_burn_cmdline_password(argc, argv);
706 string_replace(path, '/', '\\');
708 server = SMB_STRDUP(path+2);
709 if (!server) {
710 printf("Out of memory\n");
711 exit(EXIT_PARSE_ERROR);
713 share = strchr_m(server,'\\');
714 if (!share) {
715 printf("Invalid argument: %s\n", share);
716 exit(EXIT_PARSE_ERROR);
719 *share = 0;
720 share++;
722 if (todo == SET_QUOTA) {
723 if (parse_quota_set(talloc_tos(), set_str, &username_str, &qtype, &cmd, &qt)) {
724 printf("Invalid argument: -S %s\n", set_str);
725 exit(EXIT_PARSE_ERROR);
729 if (!test_args) {
730 cli = connect_one(share);
731 if (!cli) {
732 exit(EXIT_FAILED);
734 } else {
735 popt_free_cmdline_auth_info();
736 exit(EXIT_OK);
740 /* Perform requested action */
742 switch (todo) {
743 case FS_QUOTA:
744 result = do_quota(cli,SMB_USER_FS_QUOTA_TYPE, QUOTA_GET, username_str, NULL);
745 break;
746 case LIST_QUOTA:
747 result = do_quota(cli,SMB_USER_QUOTA_TYPE, QUOTA_LIST, username_str, NULL);
748 break;
749 case USER_QUOTA:
750 result = do_quota(cli,SMB_USER_QUOTA_TYPE, QUOTA_GET, username_str, NULL);
751 break;
752 case SET_QUOTA:
753 result = do_quota(cli, qtype, cmd, username_str, &qt);
754 break;
755 default:
756 result = EXIT_FAILED;
757 break;
760 popt_free_cmdline_auth_info();
761 talloc_free(frame);
763 return result;