ipv{6,4}: Simplify some functions and introduce new ones.
[people/stevee/network.git] / network
CommitLineData
5b20e43a
MT
1#!/bin/bash
2###############################################################################
3# #
4# IPFire.org - A linux based firewall #
1848564d 5# Copyright (C) 2010 Michael Tremer & Christian Schmidt #
5b20e43a
MT
6# #
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. #
11# #
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. #
16# #
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/>. #
19# #
20###############################################################################
21
1848564d
MT
22# Parse the command line
23while [ $# -gt 0 ]; do
24 case "${1}" in
25 -d|--debug)
26 DEBUG=1
5b20e43a 27 ;;
1848564d
MT
28 *)
29 action=${1}
5b20e43a 30 ;;
5b20e43a 31 esac
5b20e43a 32 shift
1848564d 33 [ -n "${action}" ] && break
5b20e43a
MT
34done
35
3647b19f
MT
36. /usr/lib/network/functions
37
9111eb72
MT
38function cli_config() {
39 if cli_help_requested $@; then
40 cli_show_man network-config
41 exit ${EXIT_OK}
42 fi
43
44 if [ -n "${1}" ]; then
45 config_set $@
46 network_config_write
47 else
48 network_config_print
49 fi
50}
51
52function cli_device() {
6c74a64c
MT
53 if cli_help_requested $@; then
54 cli_show_man network-device
55 exit ${EXIT_OK}
56 fi
57
9111eb72
MT
58 local device=${1}
59 local action=${2}
60 shift 2
61
ec63256a
MT
62 if ! isset device; then
63 cli_show_man network-device
9111eb72
MT
64 return ${EXIT_ERROR}
65 fi
66
ec63256a
MT
67 assert device_exists ${device}
68
9111eb72
MT
69 case "${action}" in
70 discover)
9111eb72
MT
71 cli_device_discover ${device} $@
72 ;;
ec63256a
MT
73 status)
74 cli_device_status ${device}
9111eb72 75 ;;
6c74a64c
MT
76 unlock)
77 cli_device_serial_unlock ${device} $@
78 ;;
9111eb72
MT
79 *)
80 cli_show_man network-device
81 ;;
82 esac
ec63256a
MT
83
84 return ${EXIT_OK}
85}
86
87function cli_device_status() {
88 local device=${1}
89 assert device_exists ${device}
90
6c74a64c
MT
91 # Disable debugging output here.
92 local log_disable_stdout=${LOG_DISABLE_STDOUT}
93 LOG_DISABLE_STDOUT="true"
94
ec63256a
MT
95 # Save the type of the device for later.
96 local type=$(device_get_type ${device})
97
98 cli_headline 1 "Device status: ${device}"
99 cli_print_fmt1 1 "Name" "${device}"
100
6c74a64c
MT
101 # Handle serial devices.
102 if [ "${type}" = "serial" ]; then
103 cli_device_status_serial ${device}
104 return $?
105 fi
106
ec63256a
MT
107 # Print the device status.
108 device_is_up ${device} &>/dev/null
109 local status=$?
110
111 case "${status}" in
112 ${EXIT_TRUE})
113 status="${COLOUR_GREEN}UP${COLOUR_NORMAL}"
114 ;;
115 ${EXIT_FALSE})
116 status="${COLOUR_RED}DOWN${COLOUR_NORMAL}"
117 ;;
118 esac
119
120 cli_print_fmt1 1 "Status" "${status}"
121 cli_print_fmt1 1 "Type" "${type}"
122 cli_print_fmt1 1 "Address" "$(device_get_address ${device})"
123 cli_space
124
125 # Print the link speed for ethernet devices.
245dffc9
MT
126 if device_is_up ${device} &>/dev/null; then
127 case "${type}" in
128 ethernet)
129 cli_print_fmt1 1 "Link" \
130 "$(device_get_speed ${device}) MBit/s $(device_get_duplex ${device}) duplex"
131 ;;
132 esac
133 fi
ec63256a
MT
134
135 cli_print_fmt1 1 "MTU" "$(device_get_mtu ${device})"
136 cli_space
137
3cb2fc42
MT
138 # Print device statistics.
139 cli_device_stats 2 ${device}
ec63256a
MT
140
141 # Print some more information.
142 device_has_carrier ${device} &>/dev/null
143 cli_print_fmt1 1 "Has carrier?" "$(cli_print_bool $?)"
144
145 device_is_promisc ${device} &>/dev/null
146 cli_print_fmt1 1 "Promisc" "$(cli_print_bool $?)"
147 cli_space
148
149 # Print all virtual devices.
150 local virtuals=$(device_get_virtuals ${device})
151 if [ -n "${virtuals}" ]; then
152 cli_headline 2 "Virtual devices"
153
154 local virtual
155 for virtual in ${virtuals}; do
156 cli_print 2 "* %-6s - %s" "${virtual}" "$(device_get_address ${virtual})"
157 done
158 cli_space
159 fi
160
6c74a64c
MT
161 # Reset the logging level.
162 LOG_DISABLE_STDOUT=${log_disable_stdout}
163}
164
165function cli_device_status_serial() {
166 local device=${1}
167 assert device_is_serial ${device}
168
169 serial_is_locked ${device} &>/dev/null
170 local locked=$?
171
172 cli_print_fmt1 1 "Locked" "$(cli_print_bool ${locked})"
173 cli_space
174
175 # Cannot go on when the device is locked.
176 [ ${locked} -eq ${EXIT_TRUE} ] && return ${EXIT_OK}
177
178 cli_print_fmt1 1 "Manufacturer" \
179 "$(modem_get_manufacturer ${device})"
180 cli_print_fmt1 1 "Model" \
181 "$(modem_get_model ${device})"
182 cli_print_fmt1 1 "Software version" \
183 "$(modem_get_software_version ${device})"
184
185 if modem_is_mobile ${device}; then
186 cli_print_fmt1 1 "IMEI" \
187 "$(modem_get_device_imei ${device})"
188 cli_space
189
190 cli_headline 2 "Network status"
191 modem_sim_status ${device} &>/dev/null
192 local sim_status_code=$?
193
194 local sim_status="unknown"
195 case "${sim_status_code}" in
196 ${EXIT_SIM_READY})
197 sim_status="SIM ready"
198 ;;
199 ${EXIT_SIM_PIN})
200 sim_status="PIN locked"
201 ;;
202 ${EXIT_SIM_PUK})
203 sim_status="PUK locked"
204 ;;
205 esac
206 cli_print_fmt1 2 "SIM status" "${sim_status}"
207
208 if [ ${sim_status_code} -eq ${EXIT_SIM_READY} ]; then
209 cli_print_fmt1 2 "IMSI" \
210 "$(modem_get_sim_imsi ${device})"
211 cli_print_fmt1 2 "Operator" \
212 "$(modem_get_network_operator ${device})"
213 cli_print_fmt1 2 "Mode" \
214 "$(modem_get_network_mode ${device})"
215 cli_print_fmt1 2 "Signal quality" \
216 "$(modem_get_signal_quality ${device}) dBm"
217
218 local ber=$(modem_get_bit_error_rate ${device})
219 isset ber || ber="unknown"
220 cli_print_fmt1 2 "Bit Error Rate" "${ber}"
221 fi
222 fi
223 cli_space
9111eb72
MT
224}
225
226function cli_device_discover() {
227 local device=${1}
228 shift
229
230 local device_type=$(device_get_type ${device})
231 if [ "${device_type}" != "real" ]; then
232 return ${EXIT_OK}
233 fi
234
235 local raw
236
237 while [ $# -gt 0 ]; do
238 case "${1}" in
239 --raw)
240 raw=1
241 ;;
242 esac
243 shift
244 done
245
246 local up
247 device_is_up ${device} && up=1
248 device_set_up ${device}
249
250 enabled raw || echo "${device}"
251
252 local hook
253 local out
254 local ret
255 for hook in $(hook_zone_get_all); do
256 out=$(hook_zone_exec ${hook} discover ${device})
257 ret=$?
258
259 [ ${ret} -eq ${DISCOVER_NOT_SUPPORTED} ] && continue
260
261 if enabled raw; then
262 case "${ret}" in
263 ${DISCOVER_OK})
264 echo "${hook}: OK"
265 local line
266 while read line; do
267 echo "${hook}: ${line}"
268 done <<<"${out}"
269 ;;
270
271 ${DISCOVER_ERROR})
272 echo "${hook}: FAILED"
273 ;;
274 esac
275 else
276 case "${ret}" in
277 ${DISCOVER_OK})
278 echo " ${hook} was successful."
279 local line
280 while read line; do
281 echo " ${line}"
282 done <<<"${out}"
283 ;;
284
285 ${DISCOVER_ERROR})
286 echo " ${hook} failed."
287 ;;
288 esac
289 fi
290 done
291
292 echo # New line
293
294 [ "${up}" = "1" ] || device_set_down ${device}
295}
296
6c74a64c
MT
297function cli_device_serial_unlock() {
298 if cli_help_requested $@; then
299 cli_show_man network-device
300 exit ${EXIT_OK}
301 fi
302
303 local device=${1}
304 assert isset device
305
306 if ! device_is_serial ${device}; then
307 error "${device} is not a serial device."
308 error "Unlocking is only supported for serial devices."
309 exit ${EXIT_ERROR}
310 fi
311
312 # Read the current state of the SIM card.
313 modem_sim_status ${device} &>/dev/null
314 local sim_status_code=$?
315
316 # If the SIM card is already unlocked, we don't need to do anything.
317 if [ ${sim_status_code} -eq ${EXIT_SIM_READY} ]; then
318 print "The SIM card is already unlocked."
319 exit ${EXIT_OK}
320
321 # If the SIM card is in an unknown state, we cannot do anything.
322 elif [ ${sim_status_code} -eq ${EXIT_SIM_UNKNOWN} ]; then
323 error "The SIM card is in an unknown state."
324 exit ${EXIT_ERROR}
325 fi
326
327 # Ask for the code.
328 local code=${2}
329 local require_new_pin="false"
330 local new_pin
331
332 while ! isinteger code; do
333 local message
334 case "${sim_status_code}" in
335 ${EXIT_SIM_PIN})
336 message="Please enter PIN:"
337 ;;
338 ${EXIT_SIM_PUK})
339 message="Please enter PUK:"
340 require_new_pin="true"
341 ;;
342 esac
343 assert isset message
344
345 echo -n "${message} "
346 read -s code
347 echo # Print newline.
348
349 if enabled require_new_pin; then
350 local i new_pin2
351 for i in 0 1; do
352 case "${i}" in
353 0)
354 message="Please enter a new PIN code:"
355 ;;
356 1)
357 message="Please confirm the new PIN code:"
358 ;;
359 esac
360
361 echo -n "${message} "
362 read -s new_pin2
363 echo # Print newline.
364
365 if [ -n "${new_pin}" ]; then
366 if [ "${new_pin}" != "${new_pin2}" ]; then
367 error "The entered PIN codes did not match."
368 exit ${EXIT_ERROR}
369 fi
370 else
371 new_pin=${new_pin2}
372 fi
373 done
374 fi
375 done
376
377 # Trying to unlock the SIM card.
378 modem_sim_unlock ${device} ${code} ${new_pin}
379
380 exit $?
381}
382
9111eb72
MT
383function cli_hostname() {
384 if cli_help_requested $@; then
385 cli_show_man network
386 exit ${EXIT_OK}
387 fi
388
389 local hostname=${1}
390
391 if [ -n "${hostname}" ]; then
392 config_hostname ${hostname}
393 log INFO "Hostname was set to '${hostname}'."
394 log INFO "Changes do only take affect after reboot."
395 exit ${EXIT_OK}
396 fi
397
398 echo "$(config_hostname)"
399 exit ${EXIT_OK}
400}
401
402function cli_port() {
403 if cli_help_requested $@; then
404 cli_show_man network-port
405 exit ${EXIT_OK}
406 fi
407
408 local action
409 local port
410
411 if port_exists ${1}; then
412 port=${1}
413 action=${2}
414 shift 2
415
416 # Action aliases
417 case "${action}" in
418 start)
419 action="up"
420 ;;
421 stop)
422 action="down"
423 ;;
424 show)
425 action="status"
426 ;;
427 esac
428
429 case "${action}" in
430 edit|up|down|status)
431 port_${action} ${port} $@
432 ;;
433 *)
434 error "Unrecognized argument: ${action}"
435 exit ${EXIT_ERROR}
436 ;;
437 esac
438 else
439 action=${1}
440 shift
441
442 case "${action}" in
443 create|destroy)
444 port_${action} $@
445 ;;
446 *)
447 error "Unrecognized argument: ${action}"
448 exit ${EXIT_ERROR}
449 ;;
450 esac
451 fi
452}
453
454function cli_zone() {
455 if cli_help_requested $@; then
456 cli_show_man network-zone
457 exit ${EXIT_OK}
458 fi
459
460 local action
461 local zone
462
463 if zone_name_is_valid ${1}; then
464 zone=${1}
465 action=${2}
466 shift 2
467
468 # Action aliases
469 case "${action}" in
470 start)
471 action="up"
472 ;;
473 stop)
474 action="down"
475 ;;
476 show)
477 action="status"
478 ;;
479 esac
480
481 case "${action}" in
482 config|down|edit|port|status|up)
483 zone_${action} ${zone} $@
484 ;;
485 *)
486 error "Unrecognized argument: ${action}"
487 cli_show_man network-zone
488 exit ${EXIT_ERROR}
489 ;;
490 esac
491 else
492 action=${1}
493 shift
494
495 case "${action}" in
496 create)
497 zone_${action} $@
498 ;;
499 remove)
500 cli_zone_remove $@
501 ;;
502 list-hooks)
503 cli_list_hooks zone $@
504 ;;
505 ""|*)
506 if [ -n "${action}" ]; then
507 error "Unrecognized argument: '${action}'"
508 echo
509 fi
510
511 cli_show_man network-zone
512 exit ${EXIT_ERROR}
513 ;;
514 esac
515 fi
516}
517
518# Removes a zone either immediately, if it is currently down,
519# or adds a tag that the removal will be done when the zone
520# is brought down the next time.
521function cli_zone_remove() {
522 if cli_help_requested $@; then
523 cli_show_man network-zone
524 exit ${EXIT_OK}
525 fi
526
527 local zone=${1}
528 assert zone_exists ${zone}
529
530 if zone_is_up ${zone}; then
531 echo "Zone '${zone}' is up and will be removed when it goes down the next time."
532 zone_remove ${zone}
533 else
534 echo "Removing zone '${zone}' now..."
535 zone_remove_now ${zone}
536 fi
537
538 exit ${EXIT_OK}
539}
540
541function cli_list_hooks() {
542 local type=${1}
543 shift
544
545 if cli_help_requested $@; then
546 cli_show_man network-zone
547 exit ${EXIT_OK}
548 fi
549
550 local hook_dir=$(hook_dir ${type})
551 local hook
552
553 for hook in ${hook_dir}/*; do
554 hook=$(basename ${hook})
555 if hook_exists ${type} ${hook}; then
556 echo "${hook}"
557 fi
558 done | sort -u
559}
560
cb965348
MT
561function cli_route() {
562 if cli_help_requested $@; then
563 cli_show_man network-route
564 exit ${EXIT_OK}
565 fi
566
567 local action=${1}
568 shift
569
570 case "${action}" in
571 # Add a new route.
572 add)
573 route_add $@
574 ;;
575 # Remove an existing route.
576 remove)
577 route_remove $@
578 ;;
579 # List all routes.
580 list)
581 route_list $@
d2021e87 582 return ${EXIT_OK}
cb965348
MT
583 ;;
584 *)
585 error "Unrecognized action: ${action}"
586 cli_run_help network route
587
588 exit ${EXIT_ERROR}
589 ;;
590 esac
591
d2021e87
MT
592 # Applying all routes.
593 route_apply
594
cb965348
MT
595 exit ${EXIT_OK}
596}
597
9111eb72
MT
598function cli_start() {
599 if cli_help_requested $@; then
600 cli_show_man network
601 exit ${EXIT_OK}
602 fi
603
604 local zones=$(zones_get $@)
605
606 local zone
607 for zone in ${zones}; do
608 zone_start ${zone} &
609 done
610
611 wait # until everything is settled
612}
613
614function cli_stop() {
615 if cli_help_requested $@; then
616 cli_show_man network
617 exit ${EXIT_OK}
618 fi
619
620 local zones=$(zones_get $@)
621
622 local zone
623 for zone in ${zones}; do
624 zone_stop ${zone} &
625 done
626
627 wait # until everything is settled
628}
629
630function cli_restart() {
631 if cli_help_requested $@; then
632 cli_show_man network
633 exit ${EXIT_OK}
634 fi
635
636 cli_stop $@
637
638 # Give the system some time to calm down
639 sleep ${TIMEOUT_RESTART}
640
641 cli_start $@
642}
643
644function cli_status() {
645 if cli_help_requested $@; then
646 cli_show_man network
647 exit ${EXIT_OK}
648 fi
649
650 # When dumping status information, the debug
651 # mode clutters the console which is not what we want.
652 # Logging on the console is disabled for a short time.
653 local log_disable_stdout=${LOG_DISABLE_STDOUT}
654 LOG_DISABLE_STDOUT="true"
655
656 local zones=$(zones_get $@)
657
658 local zone
659 for zone in ${zones}; do
660 zone_status ${zone}
661 done
662
663 # Reset logging.
664 LOG_DISABLE_STDOUT=${log_disable_stdout}
665}
666
667function cli_reset() {
668 if cli_help_requested $@; then
669 cli_show_man network
670 exit ${EXIT_OK}
671 fi
672
673 warning_log "Will reset the whole network configuration!!!"
674
675 # Force mode is disabled by default
676 local force=0
677
678 while [ $# -gt 0 ]; do
679 case "${1}" in
680 --force|-f)
681 force=1
682 ;;
683 esac
684 shift
685 done
686
687 # If we are not running in force mode, we ask the user if he does know
688 # what he is doing.
689 if ! enabled force; then
690 if ! cli_yesno "Do you really want to reset the whole network configuration?"; then
691 exit ${EXIT_ERROR}
692 fi
693 fi
694
695 local zone
696 for zone in $(zones_get --all); do
697 zone_remove ${zone}
698 done
699
700 local port
701 for port in $(ports_get --all); do
702 port_remove ${port}
703 done
704
acc9efd5
MT
705 # Flush all DNS servers.
706 dns_server_flush
707
9111eb72
MT
708 # Re-run the initialization functions
709 init_run
710
711 exit ${EXIT_OK}
712}
713
85afd775
MT
714# Help function: will show the default man page to the user.
715# Optionally, there are two arguments taken, the type of hook
716# and which hook should be shown.
717function cli_help() {
718 local type=${1}
719 local what=${2}
720
721 # Remove unknown types.
722 if ! listmatch ${type} zone port config; then
723 type=""
724 fi
725
726 # If no arguments were given, we will show the default page.
727 if [ -z "${type}" ]; then
728 cli_show_man network
729 return ${EXIT_OK}
730 fi
731
732 if ! hook_exists ${type} ${what}; then
733 error "Hook of type '${type}' and name '${what}' could not be found."
734 exit "${EXIT_ERROR}"
735 fi
736
737 hook_exec ${type} ${what} help
738}
739
acc9efd5
MT
740function cli_dns() {
741 if cli_help_requested $@; then
742 cli_show_man network-dns
743 exit ${EXIT_OK}
744 fi
745
746 # Get the command.
747 local cmd=${1}; shift
748 if [ -z "${cmd}" ]; then
749 cli_show_man network-dns
750 exit ${EXIT_ERROR}
751 fi
752
6f923dac
MT
753 # Get the new server to process (if any).
754 local server=${1}
755 local priority=${2}
756
acc9efd5
MT
757 case "${cmd}" in
758 list)
759 __dns_server_println "SERVER" "PRIORITY"
760 dns_server_list
e5efaa6b 761 exit ${EXIT_OK}
acc9efd5
MT
762 ;;
763 add)
6f923dac
MT
764 log INFO "Adding new DNS server: ${server}"
765 dns_server_add ${server} ${priority}
acc9efd5
MT
766 ;;
767 remove)
6f923dac
MT
768 log INFO "Removing DNS server: ${server}"
769 dns_server_remove ${server} ${priority}
acc9efd5
MT
770 ;;
771 update)
772 # Just run the update afterwards.
773 ;;
774 *)
775 error "No such command: ${cmd}"
776 exit ${EXIT_ERROR}
777 esac
778
779 # Update the local DNS configuration after changes have been made.
780 dns_generate_resolvconf
6f923dac 781 radvd_update
acc9efd5
MT
782
783 exit ${EXIT_OK}
784}
785
1848564d
MT
786# Process the given action
787case "${action}" in
b8357295
MT
788 init)
789 init_run
790 ;;
791
cb965348 792 config|hostname|port|device|zone|start|stop|restart|status|reset|dns|route)
0a79ea02 793 cli_${action} $@
1848564d
MT
794 ;;
795
fe4555b5 796 ""|help|--help|-h)
85afd775 797 cli_help $@
1848564d 798 ;;
fe4555b5 799
1848564d 800 *)
fe4555b5 801 error "Invalid command given: ${action}"
de28a630 802 cli_usage "network help"
1848564d 803 exit ${EXIT_CONF_ERROR}
fe4555b5 804 ;;
1848564d 805esac
85afd775
MT
806
807exit ${EXIT_OK}