2 * Copyright (c) 2000-2020 Apple Inc. All rights reserved.
4 * @APPLE_LICENSE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
21 * @APPLE_LICENSE_HEADER_END@
25 * Modification History
27 * June 13, 2005 Allan Nathanson <ajn@apple.com>
28 * - added SCPreferences support
30 * August 4, 2004 Allan Nathanson <ajn@apple.com>
31 * - added network configuration (prefs) support
33 * September 25, 2002 Allan Nathanson <ajn@apple.com>
34 * - added command line history & editing
36 * July 9, 2001 Allan Nathanson <ajn@apple.com>
37 * - added "-r" option for checking network reachability
38 * - added "-w" option to check/wait for the presence of a
41 * June 1, 2001 Allan Nathanson <ajn@apple.com>
42 * - public API conversion
44 * November 9, 2000 Allan Nathanson <ajn@apple.com>
48 #include <TargetConditionals.h>
59 #include <mach/mach.h>
60 #include <mach/mach_error.h>
65 #include "dictionary.h"
72 #define LINE_LENGTH 2048
74 __private_extern__ AuthorizationRef authorization
= NULL
;
75 __private_extern__ InputRef currentInput
= NULL
;
76 __private_extern__ Boolean doDispatch
= FALSE
;
77 __private_extern__
int nesting
= 0;
78 __private_extern__ SCPreferencesRef ni_prefs
= NULL
;
79 __private_extern__ CFRunLoopRef notifyRl
= NULL
;
80 __private_extern__ CFRunLoopSourceRef notifyRls
= NULL
;
81 __private_extern__ SCPreferencesRef prefs
= NULL
;
82 __private_extern__
char *prefsPath
= NULL
;
83 __private_extern__ SCDynamicStoreRef store
= NULL
;
84 __private_extern__ CFPropertyListRef value
= NULL
;
85 __private_extern__ CFMutableArrayRef watchedKeys
= NULL
;
86 __private_extern__ CFMutableArrayRef watchedPatterns
= NULL
;
88 static const struct option longopts
[] = {
89 // { "debug", no_argument, NULL, 'd' },
90 // { "dispatch", no_argument, NULL, 'D' },
91 // { "verbose", no_argument, NULL, 'v' },
92 // { "SPI", no_argument, NULL, 'p' },
93 // { "check-reachability", required_argument, NULL, 'r' },
94 // { "timeout", required_argument, NULL, 't' },
95 // { "wait-key", required_argument, NULL, 'w' },
96 // { "watch-reachability", no_argument, NULL, 'W' },
97 { "dns", no_argument
, NULL
, 0 },
98 { "get", required_argument
, NULL
, 0 },
99 { "error", required_argument
, NULL
, 0 },
100 { "help", no_argument
, NULL
, '?' },
101 { "nc", required_argument
, NULL
, 0 },
102 { "net", no_argument
, NULL
, 0 },
103 { "nwi", no_argument
, NULL
, 0 },
104 { "prefs", no_argument
, NULL
, 0 },
105 { "proxy", no_argument
, NULL
, 0 },
106 { "renew", required_argument
, NULL
, 0 },
107 { "set", required_argument
, NULL
, 0 },
108 { "snapshot", no_argument
, NULL
, 0 },
109 { "user", required_argument
, NULL
, 0 },
110 { "password", required_argument
, NULL
, 0 },
111 { "secret", required_argument
, NULL
, 0 },
112 { "log", required_argument
, NULL
, 0 },
113 { "advisory", required_argument
, NULL
, 0 },
114 #if !TARGET_OS_IPHONE
115 { "allow-new-interfaces", no_argument
, NULL
, 0 },
116 #endif // !TARGET_OS_IPHONE
117 { "disable-until-needed", no_argument
, NULL
, 0 },
124 _copyStringFromSTDIN(CFStringRef prompt
, CFStringRef defaultValue
)
128 Boolean is_user_prompt
= (prompt
!= NULL
&& isatty(STDIN_FILENO
) && isatty(STDOUT_FILENO
));
134 /* Print out a prompt to user that entry is desired */
135 if (is_user_prompt
) {
136 if (defaultValue
!= NULL
) {
137 SCPrint(TRUE
, stdout
, CFSTR("%@ [%@]: "), prompt
, defaultValue
);
139 SCPrint(TRUE
, stdout
, CFSTR("%@: "), prompt
);
144 if (fgets(buf
, sizeof(buf
), stdin
) == NULL
) {
148 /* Prepare for trim */
149 len
= (int)strlen(buf
);
154 if ((modlen
> 0) && (modbuf
[modlen
- 1] == '\n')) {
155 modbuf
[modlen
- 1] = '\0';
159 /* If nothing was entered at the user prompt, set default */
160 if (is_user_prompt
&& defaultValue
!= NULL
&& modlen
== 0) {
161 CFRetain(defaultValue
);
165 /* Trim spaces from front */
166 while (modlen
> 0 && isspace(modbuf
[0])) {
171 /* Trim spaces from back */
172 for (i
= modlen
- 1; i
>= 0; i
--) {
173 if (isspace(buf
[i
])) {
181 utf8
= CFStringCreateWithBytes(NULL
, (UInt8
*)modbuf
, modlen
, kCFStringEncodingUTF8
, TRUE
);
186 getLine(char *buf
, int len
, InputRef src
)
194 line
= el_gets(src
->el
, &count
);
198 strlcpy(buf
, line
, len
);
200 if (fgets(buf
, len
, src
->fp
) == NULL
)
204 n
= (int)strlen(buf
);
205 if (buf
[n
-1] == '\n') {
206 /* the entire line fit in the buffer, remove the newline */
208 } else if (!src
->el
) {
209 /* eat the remainder of the line */
212 } while ((n
!= '\n') && (n
!= EOF
));
215 if (src
->h
&& (buf
[0] != '\0')) {
218 history(src
->h
, &ev
, H_ENTER
, buf
);
226 getString(char **line
)
228 char *s
, *e
, c
, *string
;
229 int i
, isQuoted
= 0, escaped
= 0;
231 if (*line
== NULL
) return NULL
;
232 if (**line
== '\0') return NULL
;
234 /* Skip leading white space */
235 while (isspace(**line
)) *line
+= 1;
237 /* Grab the next string */
240 return NULL
; /* no string available */
241 } else if (*s
== '"') {
242 isQuoted
= 1; /* it's a quoted string */
246 for (e
= s
; (c
= *e
) != '\0'; e
++) {
247 if (isQuoted
&& (c
== '"'))
248 break; /* end of quoted string */
252 break; /* if premature end-of-string */
253 if ((*e
== '"') || isspace(*e
))
254 escaped
++; /* if escaped quote or white space */
256 if (!isQuoted
&& isspace(c
))
257 break; /* end of non-quoted string */
260 string
= malloc(e
- s
- escaped
+ 1);
262 for (i
= 0; s
< e
; s
++) {
264 if (!((s
[0] == '\\') && ((s
[1] == '"') || isspace(s
[1])))) i
++;
269 e
++; /* move past end of quoted string */
278 process_line(InputRef src
)
284 char line
[LINE_LENGTH
];
287 // if end-of-file, exit
288 if (getLine(line
, sizeof(line
), src
) == NULL
)
292 SCPrint(TRUE
, stdout
, CFSTR("%d> %s\n"), nesting
, line
);
295 // break up the input line
296 while ((arg
= getString(&s
)) != NULL
) {
298 argv
= (char **)malloc(2 * sizeof(char *));
300 argv
= (char **)reallocf(argv
, ((argc
+ 2) * sizeof(char *)));
305 return TRUE
; // if no arguments
308 /* process the command */
309 if (*argv
[0] != '#') {
310 argv
[argc
] = NULL
; // just in case...
312 do_command(argc
, argv
);
315 /* free the arguments */
316 for (i
= 0; i
< argc
; i
++) {
321 return !termRequested
;
326 usage(const char *command
)
328 SCPrint(TRUE
, stderr
, CFSTR("usage: %s\n"), command
);
329 SCPrint(TRUE
, stderr
, CFSTR("\tinteractive access to the dynamic store.\n"));
330 SCPrint(TRUE
, stderr
, CFSTR("\n"));
331 SCPrint(TRUE
, stderr
, CFSTR(" or: %s --prefs [preference-file]\n"), command
);
332 SCPrint(TRUE
, stderr
, CFSTR("\tinteractive access to the [raw] stored preferences.\n"));
333 SCPrint(TRUE
, stderr
, CFSTR("\n"));
334 SCPrint(TRUE
, stderr
, CFSTR(" or: %s [-W] -r nodename\n"), command
);
335 SCPrint(TRUE
, stderr
, CFSTR(" or: %s [-W] -r address\n"), command
);
336 SCPrint(TRUE
, stderr
, CFSTR(" or: %s [-W] -r local-address remote-address\n"), command
);
337 SCPrint(TRUE
, stderr
, CFSTR("\tcheck reachability of node, address, or address pair (-W to \"watch\").\n"));
338 SCPrint(TRUE
, stderr
, CFSTR("\n"));
339 SCPrint(TRUE
, stderr
, CFSTR(" or: %s -w dynamic-store-key [ -t timeout ]\n"), command
);
340 SCPrint(TRUE
, stderr
, CFSTR("\t-w\twait for presense of dynamic store key\n"));
341 SCPrint(TRUE
, stderr
, CFSTR("\t-t\ttime to wait for key\n"));
342 SCPrint(TRUE
, stderr
, CFSTR("\n"));
343 SCPrint(TRUE
, stderr
, CFSTR(" or: %s --get pref\n"), command
);
344 SCPrint(TRUE
, stderr
, CFSTR(" or: %s --set pref [newval]\n"), command
);
345 SCPrint(TRUE
, stderr
, CFSTR(" or: %s --get filename path key \n"), command
);
346 SCPrint(TRUE
, stderr
, CFSTR("\tpref\tdisplay (or set) the specified preference. Valid preferences\n"));
347 SCPrint(TRUE
, stderr
, CFSTR("\t\tinclude:\n"));
348 SCPrint(TRUE
, stderr
, CFSTR("\t\t\tComputerName, LocalHostName, HostName\n"));
349 SCPrint(TRUE
, stderr
, CFSTR("\tnewval\tNew preference value to be set. If not specified,\n"));
350 SCPrint(TRUE
, stderr
, CFSTR("\t\tthe new value will be read from standard input.\n"));
351 SCPrint(TRUE
, stderr
, CFSTR("\n"));
352 SCPrint(TRUE
, stderr
, CFSTR(" or: %s --dns\n"), command
);
353 SCPrint(TRUE
, stderr
, CFSTR("\tshow DNS configuration.\n"));
354 SCPrint(TRUE
, stderr
, CFSTR("\n"));
355 SCPrint(TRUE
, stderr
, CFSTR(" or: %s --proxy\n"), command
);
356 SCPrint(TRUE
, stderr
, CFSTR("\tshow \"proxy\" configuration.\n"));
357 SCPrint(TRUE
, stderr
, CFSTR("\n"));
358 SCPrint(TRUE
, stderr
, CFSTR(" or: %s --nwi\n"), command
);
359 SCPrint(TRUE
, stderr
, CFSTR("\tshow network information\n"));
360 SCPrint(TRUE
, stderr
, CFSTR("\n"));
361 SCPrint(TRUE
, stderr
, CFSTR(" or: %s --nc\n"), command
);
362 SCPrint(TRUE
, stderr
, CFSTR("\tshow VPN network configuration information. Use --nc help for full command list\n"));
365 SCPrint(TRUE
, stderr
, CFSTR("\n"));
366 SCPrint(TRUE
, stderr
, CFSTR(" or: %s --log IPMonitor [off|on]\n"), command
);
367 SCPrint(TRUE
, stderr
, CFSTR("\tmanage logging.\n"));
369 SCPrint(TRUE
, stderr
, CFSTR("\n"));
370 SCPrint(TRUE
, stderr
, CFSTR(" or: %s --disable-until-needed <interfaceName> [on|off ]\n"), command
);
371 SCPrint(TRUE
, stderr
, CFSTR("\tmanage secondary interface demand.\n"));
374 #if !TARGET_OS_IPHONE
375 SCPrint(TRUE
, stderr
, CFSTR("\n"));
376 SCPrint(TRUE
, stderr
, CFSTR(" or: %s --allow-new-interfaces [off|on]\n"), command
);
377 SCPrint(TRUE
, stderr
, CFSTR("\tmanage new interface creation with screen locked.\n"));
378 #endif // !TARGET_OS_IPHONE
380 if (getenv("ENABLE_EXPERIMENTAL_SCUTIL_COMMANDS")) {
381 SCPrint(TRUE
, stderr
, CFSTR("\n"));
382 SCPrint(TRUE
, stderr
, CFSTR(" or: %s --net\n"), command
);
383 SCPrint(TRUE
, stderr
, CFSTR("\tmanage network configuration.\n"));
386 SCPrint(TRUE
, stderr
, CFSTR("\n"));
387 SCPrint(TRUE
, stderr
, CFSTR(" or: %s --error err#\n"), command
);
388 SCPrint(TRUE
, stderr
, CFSTR("\tdisplay a descriptive message for the given error code\n"));
398 #if !TARGET_OS_SIMULATOR
400 #else // !TARGET_OS_SIMULATOR
402 #endif // !TARGET_OS_SIMULATOR
407 main(int argc
, char * const argv
[])
409 #if !TARGET_OS_IPHONE
410 Boolean allowNewInterfaces
= FALSE
;
411 #endif // !TARGET_OS_IPHONE
412 Boolean disableUntilNeeded
= FALSE
;
413 const char * advisoryInterface
= NULL
;
414 Boolean doAdvisory
= FALSE
;
415 Boolean doDNS
= FALSE
;
416 Boolean doNet
= FALSE
;
417 Boolean doNWI
= FALSE
;
418 Boolean doPrefs
= FALSE
;
419 Boolean doProxy
= FALSE
;
420 Boolean doReach
= FALSE
;
421 Boolean doSnap
= FALSE
;
428 const char *prog
= argv
[0];
433 int timeout
= 15; /* default timeout (in seconds) */
435 Boolean watch
= FALSE
;
436 int xStore
= 0; /* non dynamic store command line options */
438 /* process any arguments */
440 while ((opt
= getopt_long(argc
, argv
, "dDvprt:w:W", longopts
, &opti
)) != -1) {
444 _sc_log
= kSCLogDestinationFile
; /* enable framework logging */
451 _sc_log
= kSCLogDestinationFile
; /* enable framework logging */
454 enablePrivateAPI
= TRUE
;
461 timeout
= atoi(optarg
);
471 if (strcmp(longopts
[opti
].name
, "dns") == 0) {
474 } else if (strcmp(longopts
[opti
].name
, "error") == 0) {
477 } else if (strcmp(longopts
[opti
].name
, "get") == 0) {
480 } else if (strcmp(longopts
[opti
].name
, "nc") == 0) {
483 } else if (strcmp(longopts
[opti
].name
, "net") == 0) {
486 } else if (strcmp(longopts
[opti
].name
, "nwi") == 0) {
489 } else if (strcmp(longopts
[opti
].name
, "prefs") == 0) {
492 } else if (strcmp(longopts
[opti
].name
, "proxy") == 0) {
495 } else if (strcmp(longopts
[opti
].name
, "renew") == 0) {
498 } else if (strcmp(longopts
[opti
].name
, "set") == 0) {
501 } else if (strcmp(longopts
[opti
].name
, "snapshot") == 0) {
504 } else if (strcmp(longopts
[opti
].name
, "log") == 0) {
507 #if !TARGET_OS_IPHONE
508 } else if (strcmp(longopts
[opti
].name
, "allow-new-interfaces") == 0) {
509 allowNewInterfaces
= TRUE
;
511 #endif // !TARGET_OS_IPHONE
512 } else if (strcmp(longopts
[opti
].name
, "disable-until-needed") == 0) {
513 disableUntilNeeded
= TRUE
;
515 } else if (strcmp(longopts
[opti
].name
, "user") == 0) {
516 username
= CFStringCreateWithCString(NULL
, optarg
, kCFStringEncodingUTF8
);
517 } else if (strcmp(longopts
[opti
].name
, "password") == 0) {
518 password
= CFStringCreateWithCString(NULL
, optarg
, kCFStringEncodingUTF8
);
519 } else if (strcmp(longopts
[opti
].name
, "secret") == 0) {
520 sharedsecret
= CFStringCreateWithCString(NULL
, optarg
, kCFStringEncodingUTF8
);
521 } else if (strcmp(longopts
[opti
].name
, "advisory") == 0) {
523 advisoryInterface
= optarg
;
537 // if we are attempting to process more than one type of request
541 /* are we checking (or watching) the reachability of a host/address */
547 do_watchReachability(argc
, (char **)argv
);
549 do_checkReachability(argc
, (char **)argv
);
554 /* are we waiting on the presense of a dynamic store key */
556 do_wait(wait
, timeout
);
560 /* are we looking up the DNS configuration */
563 do_watchDNSConfiguration(argc
, (char **)argv
);
565 do_showDNSConfiguration(argc
, (char **)argv
);
572 do_watchNWI(argc
, (char**)argv
);
574 do_showNWI(argc
, (char**)argv
);
580 if (!enablePrivateAPI
) {
584 do_open(0, NULL
); /* open the dynamic store */
585 do_snapshot(argc
, (char**)argv
);
590 do_advisory(advisoryInterface
, watch
, argc
, (char**)argv
);
594 /* are we translating error #'s to descriptive text */
596 int sc_status
= atoi(error
);
598 SCPrint(TRUE
, stdout
, CFSTR("Error: 0x%08x %d %s\n"),
601 SCErrorString(sc_status
));
605 /* are we looking up a preference value */
608 if (findPref(get
) < 0) {
611 } else if (argc
== 2) {
614 * i.e. scutil --get <filename> <prefs path> <key>
616 * need to go back one argument to re-use the 1st "--get"
617 * argument as the prefs path name
625 do_getPref(get
, argc
, (char **)argv
);
629 /* are we looking up the proxy configuration */
631 do_showProxyConfiguration(argc
, (char **)argv
);
635 /* are we changing a preference value */
637 if (findPref(set
) < 0) {
640 do_setPref(set
, argc
, (char **)argv
);
646 if (strcasecmp(log
, "IPMonitor")) {
649 do_log(log
, argc
, (char * *)argv
);
653 #if !TARGET_OS_IPHONE
654 /* allowNewInterfaces */
655 if (allowNewInterfaces
) {
656 do_ifnamer("allow-new-interfaces", argc
, (char * *)argv
);
659 #endif // !TARGET_OS_IPHONE
661 /* disableUntilNeeded */
662 if (disableUntilNeeded
) {
663 do_disable_until_needed(argc
, (char * *)argv
);
667 /* network connection commands */
669 if (find_nc_cmd(nc_cmd
) < 0) {
672 do_nc_cmd(nc_cmd
, argc
, (char **)argv
, watch
);
677 /* if we are going to be managing the network configuration */
678 commands
= (cmdInfo
*)commands_net
;
679 nCommands
= nCommands_net
;
681 if (!getenv("ENABLE_EXPERIMENTAL_SCUTIL_COMMANDS")) {
685 do_net_init(); /* initialization */
686 do_net_open(argc
, (char **)argv
); /* open prefs */
687 } else if (doPrefs
) {
688 /* if we are going to be managing the network configuration */
689 commands
= (cmdInfo
*)commands_prefs
;
690 nCommands
= nCommands_prefs
;
692 do_dictInit(0, NULL
); /* start with an empty dictionary */
693 do_prefs_init(); /* initialization */
694 do_prefs_open(argc
, (char **)argv
); /* open prefs */
696 /* if we are going to be managing the dynamic store */
697 commands
= (cmdInfo
*)commands_store
;
698 nCommands
= nCommands_store
;
700 do_dictInit(0, NULL
); /* start with an empty dictionary */
701 do_open(0, NULL
); /* open the dynamic store */
704 /* are we trying to renew a DHCP lease */
710 /* allocate command input stream */
711 src
= (InputRef
)CFAllocatorAllocate(NULL
, sizeof(Input
), 0);
716 if (isatty(fileno(src
->fp
))) {
721 if (tcgetattr(fileno(src
->fp
), &t
) != -1) {
722 if ((t
.c_lflag
& ECHO
) == 0) {
726 src
->el
= el_init(prog
, src
->fp
, stdout
, stderr
);
727 src
->h
= history_init();
729 (void)history(src
->h
, &ev
, H_SETSIZE
, INT_MAX
);
730 el_set(src
->el
, EL_HIST
, history
, src
->h
);
733 el_set(src
->el
, EL_EDITMODE
, 0);
736 el_set(src
->el
, EL_EDITOR
, "emacs");
737 el_set(src
->el
, EL_PROMPT
, prompt
);
739 el_source(src
->el
, NULL
);
741 if ((el_get(src
->el
, EL_EDITMODE
, &editmode
) != -1) && editmode
!= 0) {
742 el_set(src
->el
, EL_SIGNAL
, 1);
754 ok
= process_line(src
);
760 /* close the socket, free resources */
761 if (src
->h
) history_end(src
->h
);
762 if (src
->el
) el_end(src
->el
);
763 (void)fclose(src
->fp
);
764 CFAllocatorDeallocate(NULL
, src
);
766 exit (EX_OK
); // insure the process exit status is 0
767 return 0; // ...and make main fit the ANSI spec.