2 ###############################################################################
4 # IPFire.org - A linux based firewall #
5 # Copyright (C) 2010 Michael Tremer & Christian Schmidt #
7 # This program is free software: you can redistribute it and/or modify #
8 # it under the terms of the GNU General Public License as published by #
9 # the Free Software Foundation, either version 3 of the License, or #
10 # (at your option) any later version. #
12 # This program is distributed in the hope that it will be useful, #
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of #
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
15 # GNU General Public License for more details. #
17 # You should have received a copy of the GNU General Public License #
18 # along with this program. If not, see <http://www.gnu.org/licenses/>. #
20 ###############################################################################
22 # Parse the command line
23 while [ $# -gt 0 ]; do
33 [ -n "${action}" ] && break
36 .
/usr
/lib
/network
/functions
38 function cli_config
() {
39 if cli_help_requested $@
; then
40 cli_show_man network-config
44 if [ -n "${1}" ]; then
52 function cli_device
() {
53 if cli_help_requested $@
; then
54 cli_show_man network-device
62 if ! isset device
; then
63 cli_show_man network-device
67 assert device_exists
${device}
71 cli_device_discover
${device} $@
74 cli_device_status
${device}
77 cli_device_serial_unlock
${device} $@
80 cli_show_man network-device
87 function cli_device_status
() {
89 assert device_exists
${device}
91 # Disable debugging output here.
92 local log_disable_stdout
=${LOG_DISABLE_STDOUT}
93 LOG_DISABLE_STDOUT
="true"
95 # Save the type of the device for later.
96 local type=$
(device_get_type
${device})
98 cli_headline
1 "Device status: ${device}"
99 cli_print_fmt1
1 "Name" "${device}"
101 # Handle serial devices.
102 if [ "${type}" = "serial" ]; then
103 cli_device_status_serial
${device}
107 # Print the device status.
108 device_is_up
${device} &>/dev
/null
113 status
="${COLOUR_GREEN}UP${COLOUR_NORMAL}"
116 status
="${COLOUR_RED}DOWN${COLOUR_NORMAL}"
120 cli_print_fmt1
1 "Status" "${status}"
121 cli_print_fmt1
1 "Type" "${type}"
122 cli_print_fmt1
1 "Address" "$(device_get_address ${device})"
125 # Print the link speed for ethernet devices.
128 cli_print_fmt1
1 "Link" \
129 "$(device_get_speed ${device}) MBit/s $(device_get_duplex ${device}) duplex"
133 cli_print_fmt1
1 "MTU" "$(device_get_mtu ${device})"
136 # Print device statistics.
137 cli_device_stats
2 ${device}
139 # Print some more information.
140 device_has_carrier
${device} &>/dev
/null
141 cli_print_fmt1
1 "Has carrier?" "$(cli_print_bool $?)"
143 device_is_promisc
${device} &>/dev
/null
144 cli_print_fmt1
1 "Promisc" "$(cli_print_bool $?)"
147 # Print all virtual devices.
148 local virtuals
=$
(device_get_virtuals
${device})
149 if [ -n "${virtuals}" ]; then
150 cli_headline
2 "Virtual devices"
153 for virtual
in ${virtuals}; do
154 cli_print
2 "* %-6s - %s" "${virtual}" "$(device_get_address ${virtual})"
159 # Reset the logging level.
160 LOG_DISABLE_STDOUT
=${log_disable_stdout}
163 function cli_device_status_serial
() {
165 assert device_is_serial
${device}
167 serial_is_locked
${device} &>/dev
/null
170 cli_print_fmt1
1 "Locked" "$(cli_print_bool ${locked})"
173 # Cannot go on when the device is locked.
174 [ ${locked} -eq ${EXIT_TRUE} ] && return ${EXIT_OK}
176 cli_print_fmt1
1 "Manufacturer" \
177 "$(modem_get_manufacturer ${device})"
178 cli_print_fmt1
1 "Model" \
179 "$(modem_get_model ${device})"
180 cli_print_fmt1
1 "Software version" \
181 "$(modem_get_software_version ${device})"
183 if modem_is_mobile
${device}; then
184 cli_print_fmt1
1 "IMEI" \
185 "$(modem_get_device_imei ${device})"
188 cli_headline
2 "Network status"
189 modem_sim_status
${device} &>/dev
/null
190 local sim_status_code
=$?
192 local sim_status
="unknown"
193 case "${sim_status_code}" in
195 sim_status
="SIM ready"
198 sim_status
="PIN locked"
201 sim_status
="PUK locked"
204 cli_print_fmt1
2 "SIM status" "${sim_status}"
206 if [ ${sim_status_code} -eq ${EXIT_SIM_READY} ]; then
207 cli_print_fmt1
2 "IMSI" \
208 "$(modem_get_sim_imsi ${device})"
209 cli_print_fmt1
2 "Operator" \
210 "$(modem_get_network_operator ${device})"
211 cli_print_fmt1
2 "Mode" \
212 "$(modem_get_network_mode ${device})"
213 cli_print_fmt1
2 "Signal quality" \
214 "$(modem_get_signal_quality ${device}) dBm"
216 local ber
=$
(modem_get_bit_error_rate
${device})
217 isset ber || ber
="unknown"
218 cli_print_fmt1
2 "Bit Error Rate" "${ber}"
224 function cli_device_discover
() {
228 local device_type
=$
(device_get_type
${device})
229 if [ "${device_type}" != "real" ]; then
235 while [ $# -gt 0 ]; do
245 device_is_up
${device} && up
=1
246 device_set_up
${device}
248 enabled raw ||
echo "${device}"
253 for hook
in $
(hook_zone_get_all
); do
254 out
=$
(hook_zone_exec
${hook} discover
${device})
257 [ ${ret} -eq ${DISCOVER_NOT_SUPPORTED} ] && continue
265 echo "${hook}: ${line}"
270 echo "${hook}: FAILED"
276 echo " ${hook} was successful."
284 echo " ${hook} failed."
292 [ "${up}" = "1" ] || device_set_down
${device}
295 function cli_device_serial_unlock
() {
296 if cli_help_requested $@
; then
297 cli_show_man network-device
304 if ! device_is_serial
${device}; then
305 error
"${device} is not a serial device."
306 error
"Unlocking is only supported for serial devices."
310 # Read the current state of the SIM card.
311 modem_sim_status
${device} &>/dev
/null
312 local sim_status_code
=$?
314 # If the SIM card is already unlocked, we don't need to do anything.
315 if [ ${sim_status_code} -eq ${EXIT_SIM_READY} ]; then
316 print
"The SIM card is already unlocked."
319 # If the SIM card is in an unknown state, we cannot do anything.
320 elif [ ${sim_status_code} -eq ${EXIT_SIM_UNKNOWN} ]; then
321 error
"The SIM card is in an unknown state."
327 local require_new_pin
="false"
330 while ! isinteger code
; do
332 case "${sim_status_code}" in
334 message
="Please enter PIN:"
337 message
="Please enter PUK:"
338 require_new_pin
="true"
343 echo -n "${message} "
345 echo # Print newline.
347 if enabled require_new_pin
; then
352 message
="Please enter a new PIN code:"
355 message
="Please confirm the new PIN code:"
359 echo -n "${message} "
361 echo # Print newline.
363 if [ -n "${new_pin}" ]; then
364 if [ "${new_pin}" != "${new_pin2}" ]; then
365 error
"The entered PIN codes did not match."
375 # Trying to unlock the SIM card.
376 modem_sim_unlock
${device} ${code} ${new_pin}
381 function cli_hostname
() {
382 if cli_help_requested $@
; then
389 if [ -n "${hostname}" ]; then
390 config_hostname
${hostname}
391 log INFO
"Hostname was set to '${hostname}'."
392 log INFO
"Changes do only take affect after reboot."
396 echo "$(config_hostname)"
400 function cli_port
() {
401 if cli_help_requested $@
; then
402 cli_show_man network-port
409 if port_exists
${1}; then
429 port_
${action} ${port} $@
432 error
"Unrecognized argument: ${action}"
445 error
"Unrecognized argument: ${action}"
452 function cli_zone
() {
453 if cli_help_requested $@
; then
454 cli_show_man network-zone
461 if zone_name_is_valid
${1}; then
480 config|down|edit|port|status|up
)
481 zone_
${action} ${zone} $@
484 error
"Unrecognized argument: ${action}"
485 cli_show_man network-zone
501 cli_list_hooks zone $@
504 if [ -n "${action}" ]; then
505 error
"Unrecognized argument: '${action}'"
509 cli_show_man network-zone
516 # Removes a zone either immediately, if it is currently down,
517 # or adds a tag that the removal will be done when the zone
518 # is brought down the next time.
519 function cli_zone_remove
() {
520 if cli_help_requested $@
; then
521 cli_show_man network-zone
526 assert zone_exists
${zone}
528 if zone_is_up
${zone}; then
529 echo "Zone '${zone}' is up and will be removed when it goes down the next time."
532 echo "Removing zone '${zone}' now..."
533 zone_remove_now
${zone}
539 function cli_list_hooks
() {
543 if cli_help_requested $@
; then
544 cli_show_man network-zone
548 local hook_dir
=$
(hook_dir
${type})
551 for hook
in ${hook_dir}/*; do
552 hook
=$
(basename ${hook})
553 if hook_exists
${type} ${hook}; then
559 function cli_start
() {
560 if cli_help_requested $@
; then
565 local zones
=$
(zones_get $@
)
568 for zone
in ${zones}; do
572 wait # until everything is settled
575 function cli_stop
() {
576 if cli_help_requested $@
; then
581 local zones
=$
(zones_get $@
)
584 for zone
in ${zones}; do
588 wait # until everything is settled
591 function cli_restart
() {
592 if cli_help_requested $@
; then
599 # Give the system some time to calm down
600 sleep ${TIMEOUT_RESTART}
605 function cli_status
() {
606 if cli_help_requested $@
; then
611 # When dumping status information, the debug
612 # mode clutters the console which is not what we want.
613 # Logging on the console is disabled for a short time.
614 local log_disable_stdout
=${LOG_DISABLE_STDOUT}
615 LOG_DISABLE_STDOUT
="true"
617 local zones
=$
(zones_get $@
)
620 for zone
in ${zones}; do
625 LOG_DISABLE_STDOUT
=${log_disable_stdout}
628 function cli_reset
() {
629 if cli_help_requested $@
; then
634 warning_log
"Will reset the whole network configuration!!!"
636 # Force mode is disabled by default
639 while [ $# -gt 0 ]; do
648 # If we are not running in force mode, we ask the user if he does know
650 if ! enabled force
; then
651 if ! cli_yesno
"Do you really want to reset the whole network configuration?"; then
657 for zone
in $
(zones_get
--all); do
662 for port
in $
(ports_get
--all); do
666 # Flush all DNS servers.
669 # Re-run the initialization functions
675 # Help function: will show the default man page to the user.
676 # Optionally, there are two arguments taken, the type of hook
677 # and which hook should be shown.
678 function cli_help
() {
682 # Remove unknown types.
683 if ! listmatch
${type} zone port config
; then
687 # If no arguments were given, we will show the default page.
688 if [ -z "${type}" ]; then
693 if ! hook_exists
${type} ${what}; then
694 error
"Hook of type '${type}' and name '${what}' could not be found."
698 hook_exec
${type} ${what} help
702 if cli_help_requested $@
; then
703 cli_show_man network-dns
708 local cmd
=${1}; shift
709 if [ -z "${cmd}" ]; then
710 cli_show_man network-dns
714 # Get the new server to process (if any).
720 __dns_server_println
"SERVER" "PRIORITY"
725 log INFO
"Adding new DNS server: ${server}"
726 dns_server_add
${server} ${priority}
729 log INFO
"Removing DNS server: ${server}"
730 dns_server_remove
${server} ${priority}
733 # Just run the update afterwards.
736 error
"No such command: ${cmd}"
740 # Update the local DNS configuration after changes have been made.
741 dns_generate_resolvconf
747 # Process the given action
753 config|hostname|port|device|zone|start|stop|restart|status|
reset|dns
)
762 error
"Invalid command given: ${action}"
763 cli_usage
"network help"
764 exit ${EXIT_CONF_ERROR}