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 # Read network settings
42 if cli_help_requested
"$@"; then
43 cli_show_man network-settings
47 if [ -n "${1}" ]; then
48 network_settings_set
"$@"
49 network_settings_write
51 network_settings_print
56 if cli_help_requested
"$@"; then
57 cli_show_man network-device
69 local device
="${action}"
73 if ! isset device
; then
74 cli_show_man network-device
78 assert device_exists
${device}
82 cli_device_discover
${device} "$@"
85 device_identify
"${device}" "$@"
88 cli_device_monitor
"${device}" "$@"
91 cli_device_status
${device}
94 cli_device_serial_unlock
${device} "$@"
97 cli_device_send_ussd_command
"${device}" "$@"
100 cli_show_man network-device
109 cli_device_status
() {
113 # Disable debugging output here.
114 local log_disable_stdout
=${LOG_DISABLE_STDOUT}
115 LOG_DISABLE_STDOUT
="true"
117 # Save the type of the device for later.
118 local type=$
(device_get_type
${device})
120 cli_headline
1 "Device status: ${device}"
121 cli_print_fmt1
1 "Name" "${device}"
123 # Handle special devices
126 cli_device_status_phy
"${device}"
130 cli_device_status_serial
"${device}"
135 # Print the device status.
136 device_is_up
${device} &>/dev
/null
141 status
="${CLR_GREEN_B}UP${CLR_RESET}"
144 status
="${CLR_RED_B}DOWN${CLR_RESET}"
148 cli_print_fmt1
1 "Status" "${status}"
149 cli_print_fmt1
1 "Type" "${type}"
151 # Print the driver name
152 local driver
="$(device_get_driver "${device}")"
153 if isset driver
; then
154 cli_print_fmt1
1 "Driver" "${driver}"
157 # Ethernet-compatible?
158 device_is_ethernet_compatible
"${device}" &>/dev
/null
159 cli_print_fmt1
1 "Ethernet-compatible" "$(cli_print_bool $?)"
161 cli_print_fmt1
1 "Address" "$(device_get_address ${device})"
164 # Print the link speed for ethernet devices.
165 if device_is_up
${device} &>/dev
/null
; then
166 local link
="$(device_get_link_string "${device}")"
168 cli_print_fmt1
1 "Link" "${link}"
172 cli_print_fmt1
1 "MTU" "$(device_get_mtu ${device})"
175 # Print device statistics.
176 cli_device_stats
2 ${device}
178 # Print some more information.
179 device_has_carrier
${device} &>/dev
/null
180 cli_print_fmt1
1 "Has carrier?" "$(cli_print_bool $?)"
182 device_is_promisc
${device} &>/dev
/null
183 cli_print_fmt1
1 "Promisc" "$(cli_print_bool $?)"
185 # Supports multiqueue?
186 if device_supports_multiqueue
${device}; then
187 cli_print_fmt1
1 "Multiqueue" "Supported"
191 cli_device_show_queues
2 ${device}
193 # Print all vlan devices.
194 local vlans
=$
(device_get_vlans
${device})
195 if [ -n "${vlans}" ]; then
196 cli_headline
2 "VLAN devices"
199 for vlan
in ${vlans}; do
200 cli_print
2 "* %-6s - %s" "${vlan}" "$(device_get_address ${vlan})"
207 local phy
="$(device_get_phy "${device}")"
210 cli_print_fmt1
2 "Name" "${phy}"
211 cli_print_fmt1
2 "Address" "$(phy_get_address "${phy}")"
217 # Reset the logging level.
218 LOG_DISABLE_STDOUT
=${log_disable_stdout}
221 cli_device_status_serial
() {
223 assert device_is_serial
${device}
225 serial_is_locked
${device} &>/dev
/null
228 cli_print_fmt1
1 "Locked" "$(cli_print_bool ${locked})"
231 # Cannot go on when the device is locked.
232 [ ${locked} -eq ${EXIT_TRUE} ] && return ${EXIT_OK}
234 cli_print_fmt1
1 "Manufacturer" \
235 "$(modem_get_manufacturer ${device})"
236 cli_print_fmt1
1 "Model" \
237 "$(modem_get_model ${device})"
238 cli_print_fmt1
1 "Software version" \
239 "$(modem_get_software_version ${device})"
242 if modem_is_mobile
"${device}"; then
243 cli_print_fmt1
1 "IMEI" \
244 "$(modem_get_device_imei ${device})"
248 if modem_is_mobile
"${device}"; then
249 modem_mobile_network_status
"${device}" 2
254 cli_device_status_phy
() {
256 assert phy_exists
"${phy}"
258 local address
="$(phy_get_address "${phy}")"
259 cli_print_fmt1
1 "Address" "${address}"
262 local driver
="$(phy_get_driver "${phy}")"
263 if isset driver
; then
264 cli_print_fmt1
1 "Driver" "${driver}"
269 local devices
="$(phy_get_devices "${phy}")"
270 if isset devices
; then
271 cli_headline
2 "Soft interfaces"
274 for device
in ${devices}; do
275 cli_print
2 "* %s" "${device}"
283 cli_device_discover
() {
287 # This can only be executed for ethernet (or compatible) devices
288 if ! device_is_ethernet_compatible
"${device}"; then
294 while [ $# -gt 0 ]; do
304 device_is_up
${device} && up
=1
305 device_set_up
${device}
307 enabled raw ||
echo "${device}"
312 for hook
in $
(hook_zone_get_all
); do
313 out
=$
(hook_zone_exec
${hook} discover
${device})
316 [ ${ret} -eq ${DISCOVER_NOT_SUPPORTED} ] && continue
324 echo "${hook}: ${line}"
329 echo "${hook}: FAILED"
335 echo " ${hook} was successful."
343 echo " ${hook} failed."
351 [ "${up}" = "1" ] || device_set_down
${device}
354 cli_device_serial_unlock
() {
355 if cli_help_requested
"$@"; then
356 cli_show_man network-device
363 if ! device_is_serial
${device}; then
364 error
"${device} is not a serial device."
365 error
"Unlocking is only supported for serial devices."
369 # Read the current state of the SIM card.
370 modem_sim_status
${device} &>/dev
/null
371 local sim_status_code
=$?
373 # If the SIM card is already unlocked, we don't need to do anything.
374 if [ ${sim_status_code} -eq ${EXIT_SIM_READY} ]; then
375 print
"The SIM card is already unlocked."
378 # If the SIM card is in an unknown state, we cannot do anything.
379 elif [ ${sim_status_code} -eq ${EXIT_SIM_UNKNOWN} ]; then
380 error
"The SIM card is in an unknown state."
386 local require_new_pin
="false"
389 while ! isinteger code
; do
391 case "${sim_status_code}" in
393 message
="Please enter PIN:"
396 message
="Please enter PUK:"
397 require_new_pin
="true"
402 echo -n "${message} "
404 echo # Print newline.
406 if enabled require_new_pin
; then
411 message
="Please enter a new PIN code:"
414 message
="Please confirm the new PIN code:"
418 echo -n "${message} "
420 echo # Print newline.
422 if [ -n "${new_pin}" ]; then
423 if [ "${new_pin}" != "${new_pin2}" ]; then
424 error
"The entered PIN codes did not match."
434 # Trying to unlock the SIM card.
435 modem_sim_unlock
${device} ${code} ${new_pin}
440 cli_device_send_ussd_command
() {
448 while [ $# -gt 0 ]; do
451 timeout
="$(cli_get_val "${1}")"
454 if isset
command; then
455 warning
"Unrecognized argument: ${1}"
464 assert device_is_serial
"${device}"
467 if isset timeout
; then
468 args
="${args} --timeout=${timeout}"
471 modem_ussd_send_command
"${device}" "${command}" ${args}
475 cli_device_monitor() {
479 if ! device_is_wireless "${device}"; then
480 error "This action only works with wireless devices. Exiting.
"
484 wireless_monitor "${device}"
490 for device in $(device_list); do
491 cli_device_status "${device}"
498 if cli_help_requested "$@
"; then
505 if [ -n "${hostname}" ]; then
506 config_hostname ${hostname}
507 log INFO "Hostname was
set to
'${hostname}'.
"
508 log INFO "Changes
do only take affect after reboot.
"
512 echo "$
(config_hostname
)"
517 if cli_help_requested "$@
"; then
518 cli_show_man network-port
525 if port_exists ${1}; then
531 edit|create|remove|up|down|status|identify)
532 port_${action} "${port}" "$@
"
535 color_cli "port
" "${port}" "$@
"
538 description_cli "port
" "${port}" "$@
"
541 error "Unrecognized argument
: ${action}"
554 error "Unrecognized argument
: ${action}"
562 if cli_help_requested "$@
"; then
563 cli_show_man network-zone
570 if zone_exists ${1}; then
590 cli_zone_port "${zone}" "$@
"
593 cli_zone_rename "${zone}" "$@
"
595 config|disable|down|edit|enable|identify|status|up)
596 zone_${action} ${zone} "$@
"
599 color_cli "zone
" "${zone}" "$@
"
602 description_cli "zone
" ${zone} "$@
"
605 error "Unrecognized argument
: ${action}"
606 cli_show_man network-zone
619 cli_zone_destroy "$@
"
622 if [ -n "${action}" ]; then
623 error "Unrecognized argument
: '${action}'"
627 cli_show_man network-zone
635 if cli_help_requested "$@
" || [ $# -lt 2 ]; then
636 cli_show_man network-zone-new
643 # Removes a zone either immediately, if it is currently down,
644 # or adds a tag that the removal will be done when the zone
645 # is brought down the next time.
647 if cli_help_requested "$@
"; then
648 cli_show_man network-zone
654 # Check if the zone exists
655 if ! zone_exists "${zone}"; then
656 error "Zone
'${zone}' does not exist
"
660 echo "Removing zone
'${zone}'...
"
661 zone_destroy "${zone}" || exit $?
665 if cli_help_requested "$@
"; then
666 cli_show_man network-zone-port
671 assert zone_exists "${zone}"
673 if port_exists "${2}"; then
680 zone_port_edit "${zone}" "${port}" "$@
"
683 error "Unrecognised argument
: ${action}"
693 zone_port_attach "${zone}" "$@
"
696 zone_port_detach "${zone}" "$@
"
699 error "Unrecognised argument
: ${action}"
709 if cli_help_requested "$@
"; then
710 cli_show_man network-zone
718 if ! isset name; then
719 error "You need to pass a new name
"
723 if ! zone_name_is_valid "${name}"; then
724 error "Invalid new zone name
: ${name}"
728 # Check if the zone exists
729 if ! zone_exists "${zone}"; then
730 error "Zone
${zone} does not exist
"
734 # Check if a zone with the new name already exists
735 if zone_exists "${name}"; then
736 error "Zone
${name} already exists
"
741 if ! zone_rename "${zone}" "${name}"; then
742 error "Could not rename zone
${zone} to
${name}"
753 if cli_help_requested "$@
"; then
754 cli_show_man network-zone
758 local hook_dir=$(hook_dir ${type})
761 for hook in ${hook_dir}/*; do
762 hook=$(basename ${hook})
763 if hook_exists ${type} ${hook}; then
773 if cli_help_requested "$@
"; then
774 cli_show_man network-dhcp
783 dhcpd_edit ${proto} "$@
"
788 # Make this permanent
789 dhcpd_enable ${proto}
794 # Make this permanent
795 dhcpd_disable ${proto}
798 dhcpd_reload ${proto}
801 cli_dhcpd_subnet ${proto} "$@
"
804 cli_dhcpd_show ${proto} "$@
"
807 error "Unrecognized action
: ${action}"
808 cli_run_help network dhcpvN
821 local settings=$(dhcpd_settings ${proto})
822 assert isset settings
825 dhcpd_global_settings_read ${proto}
827 cli_headline 1 "Dynamic Host Configuration Protocol Daemon
for ${proto/ip/IP}"
831 cli_headline 2 "Lease
times"
832 if isinteger VALID_LIFETIME; then
833 cli_print_fmt1 2 "Valid lifetime
" "$
(format_time
${VALID_LIFETIME})"
836 if isinteger PREFERRED_LIFETIME; then
837 cli_print_fmt1 2 "Preferred lifetime
" "$
(format_time
${PREFERRED_LIFETIME})"
843 cli_print_fmt1 1 "Authoritative
" $(cli_print_enabled AUTHORITATIVE)
846 cli_headline 2 "Lease
times"
847 cli_print_fmt1 2 "Default lease
time" "$
(format_time
${DEFAULT_LEASE_TIME})"
848 cli_print_fmt1 2 "Max. lease
time" "$
(format_time
${MAX_LEASE_TIME})"
850 if isset MIN_LEASE_TIME; then
851 cli_print_fmt1 2 "Min. lease
time" "$
(format_time
${MIN_LEASE_TIME})"
860 dhcpd_global_options_read ${proto}
862 # Print the options if any.
863 if [ ${#options[*]} -gt 0 ]; then
864 cli_headline 2 "Options
"
867 for option in $(dhcpd_options ${proto}); do
868 [ -n "${options[${option}]}" ] || continue
871 "${option}" "${options[${option}]}"
877 local subnets=$(dhcpd_subnet_list ${proto})
878 if [ -n "${subnets}" ]; then
879 cli_headline 2 "Subnets
"
881 for subnet in ${subnets}; do
882 cli_dhcpd_subnet_show ${proto} ${subnet} 2
893 if cli_help_requested "$@
"; then
894 cli_show_man network-dhcp-subnet
903 dhcpd_subnet_new ${proto} "$@
"
906 dhcpd_subnet_remove ${proto} "$@
"
909 local subnet=${action}
911 if ! dhcpd_subnet_exists ${proto} ${subnet}; then
912 error "Subnet
${subnet} does not exist
"
922 dhcpd_subnet_edit ${proto} ${subnet} "$@
"
925 if [ ${ret} -eq ${EXIT_OK} ]; then
926 dhcpd_reload ${proto}
931 cli_dhcpd_subnet_range ${proto} ${subnet} "$@
"
935 cli_dhcpd_subnet_show ${proto} ${subnet} "$@
"
939 cli_dhcpd_subnet_options ${proto} ${subnet} "$@
"
943 error "Unrecognized action
: ${action}"
944 cli_run_help network dhcpvN subnet
951 for subnet in $(dhcpd_subnet_list ${proto}); do
952 cli_dhcpd_subnet_show ${proto} ${subnet}
956 error "Unrecognized action
: ${action}"
957 cli_run_help network dhcpvN subnet
966 cli_dhcpd_subnet_range() {
976 dhcpd_subnet_range_new ${proto} ${subnet} "$@" || exit ${EXIT_ERROR}
979 dhcpd_subnet_range_remove ${proto} ${subnet} "$@" || exit ${EXIT_ERROR}
982 error "Unrecognized action
: ${action}"
983 cli_run_help network dhcpvN subnet range
988 dhcpd_reload ${proto}
992 cli_dhcpd_subnet_show() {
993 assert [ $# -ge 2 -a $# -le 3 ]
999 isset level || level=0
1001 local $(dhcpd_subnet_settings ${proto})
1003 # Read in configuration settings.
1004 dhcpd_subnet_read ${proto} ${subnet}
1006 cli_headline $(( ${level} + 1 )) "DHCP Subnet Declaration
"
1007 cli_print_fmt1 $(( ${level} + 1 )) \
1008 "Subnet
" "${ADDRESS}/${PREFIX}"
1013 dhcpd_subnet_options_read "${proto}" "${subnet}"
1015 # Print the options if any.
1016 if [ ${#options[*]} -gt 0 ]; then
1017 cli_headline $(( ${level} + 2 )) "Options
"
1020 for option in $(dhcpd_subnet_options_list ${proto}); do
1021 [ -n "${options[${option}]}" ] || continue
1023 cli_print_fmt1 $(( ${level} + 2 )) \
1024 "${option}" "${options[${option}]}"
1030 cli_headline $(( ${level} + 2 )) "Ranges
"
1032 local ranges=$(dhcpd_subnet_range_list ${proto} ${subnet})
1033 if isset ranges; then
1034 local range $(dhcpd_subnet_range_settings ${proto})
1035 for range in ${ranges}; do
1036 dhcpd_subnet_range_read ${proto} ${subnet} ${range}
1038 cli_print $(( ${level} + 2 )) "%s - %s" ${START} ${END}
1041 cli_print $(( ${level} + 2 )) "No ranges have been defined.
"
1047 cli_dhcpd_subnet_options() {
1054 while [ $# -gt 0 ]; do
1057 key=$(cli_get_key ${1})
1058 val=$(cli_get_val "${1}")
1060 dhcpd_subnet_option_set ${proto} ${subnet} ${key} ${val}
1067 if cli_help_requested "$@
"; then
1068 cli_show_man network
1072 local zones=$(zones_get "$@
")
1075 for zone in ${zones}; do
1076 zone_start ${zone} &
1079 wait # until everything is settled
1083 if cli_help_requested "$@
"; then
1084 cli_show_man network
1088 local zones=$(zones_get "$@
")
1091 for zone in ${zones}; do
1095 wait # until everything is settled
1099 if cli_help_requested "$@
"; then
1100 cli_show_man network
1106 # Give the system some time to calm down
1107 sleep ${TIMEOUT_RESTART}
1113 if cli_help_requested "$@
"; then
1114 cli_show_man network
1118 # When dumping status information, the debug
1119 # mode clutters the console which is not what we want.
1120 # Logging on the console is disabled for a short time.
1121 local log_disable_stdout=${LOG_DISABLE_STDOUT}
1122 LOG_DISABLE_STDOUT="true
"
1124 local arguments=( $@ )
1126 # Show all zones when no arguments are given
1127 if ! isset arguments; then
1129 for zone in $(zones_get_all); do
1130 zone_status "${zone}"
1137 for arg in ${arguments[@]}; do
1139 if zone_exists "${arg}"; then
1140 zone_status "${arg}"
1143 elif port_exists "${arg}"; then
1144 port_status "${arg}"
1147 elif phy_exists "${arg}"; then
1148 cli_device_status "${arg}"
1151 elif device_exists "${arg}"; then
1152 cli_device_status "${arg}"
1156 error "Unknown argument
: ${arg}"
1161 LOG_DISABLE_STDOUT=${log_disable_stdout}
1165 if cli_help_requested "$@
"; then
1166 cli_show_man network
1170 warning_log "Will
reset the whole network configuration
!!!"
1171 # Force mode is disabled by default
1174 while [ $# -gt 0 ]; do
1183 # If we are not running in force mode, we ask the user if he does know
1185 if ! enabled force; then
1186 if ! cli_yesno "Do you really want to
reset the whole network configuration?
"; then
1191 # Destroy all IPsec VPN connections
1193 for connection in $(ipsec_list_connections); do
1194 ipsec_connection_destroy "${connection}"
1198 for pool in $(ipsec_list_pools); do
1199 ipsec_pool_destroy "${pool}"
1203 ipsec_strongswan_autostart
1205 # Destroy all user-defined security policies
1207 for secpol in $(vpn_security_policies_list_user); do
1208 vpn_security_policies_destroy "${secpol}"
1212 for zone in $(zones_get_all); do
1213 zone_destroy "${zone}"
1217 for port in $(ports_get_all); do
1218 port_destroy "${port}"
1221 # Flush all DNS servers.
1224 # Trigger udev to re-add all physical network devices
1225 cmd_quiet udevadm trigger --action=add --subsystem-match=net
1230 # Help function: will show the default man page to the user.
1231 # Optionally, there are two arguments taken, the type of hook
1232 # and which hook should be shown.
1242 # List all hooks if requested
1243 if [ "${hook}" = "list-hooks
" ]; then
1244 cli_list_hooks ${type}
1248 if ! hook_exists ${type} ${hook}; then
1249 error "No hook with name
'${hook}' could be found
"
1250 exit "${EXIT_ERROR}"
1253 hook_exec ${type} ${hook} help
1256 # In all other cases show the default man page
1258 cli_show_man network
1263 return ${EXIT_ERROR}
1267 if cli_help_requested "$@
"; then
1268 cli_show_man network-dns-server
1273 local cmd=${1}; shift
1274 if [ -z "${cmd}" ]; then
1275 cli_show_man network-dns-server
1279 # Get the new server to process (if any).
1289 if dns_server_exists ${server}; then
1290 error "DNS server
'${server}' already exists
!"
1294 log INFO "Adding new DNS server
: ${server}"
1295 dns_server_add ${server} ${priority}
1298 if ! dns_server_exists ${server}; then
1299 error "DNS server
'${server}' does not exist
!"
1303 log INFO "Removing DNS server
: ${server}"
1304 dns_server_remove ${server} ${priority}
1307 # Just run the update afterwards.
1310 error "No such
command: ${cmd}"
1314 # Update the local DNS configuration after changes have been made.
1329 device-get-by-mac-address)
1330 device_get_by_mac_address "$@
"
1332 ipsec-connection-exists)
1333 ipsec_connection_exists "$@
"
1338 list-dhcpd-ranges-of-subnet)
1339 dhcpd_subnet_range_list "$@
"
1341 list-dhcpd-settings)
1342 dhcpd_global_settings_list "$@
"
1345 dhcpd_subnet_list "$@
"
1347 list-dhcpd-subnet-options)
1348 dhcpd_subnet_options_list "$@
"
1359 list-ipsec-connections)
1360 ipsec_list_connections
1368 list-vpn-security-policies-all)
1369 vpn_security_policies_list_all
1372 network_settings_list
1377 list-next-free-zones)
1380 list-zone-config-ids)
1381 zone_config_list_ids "$@
"
1383 list-zone-config-hids)
1384 zone_config_list_hids "$@
"
1386 vpn-security-policy-exists)
1387 vpn_security_policy_exists "$@
"
1390 zone_name_is_valid "$@
"
1392 zone-config-id-is-valid)
1393 zone_config_id_is_valid "$@
"
1395 zone-config-hid-is-valid)
1396 zone_config_hid_is_valid "$@
"
1399 error "No such
command: ${cmd}"
1407 # Process the given action
1410 # Update resolv.conf(5) when initializing the network
1411 dns_generate_resolvconf
1413 # Update bird configuration
1414 bird_generate_config
1416 # Also execute all triggers
1417 triggers_execute_all "init
"
1420 settings|hostname|port|device|zone|start|stop|restart|status|reset|route|vpn|wireless)
1424 # DHCP server configuration (automatically detects which protocol to use).
1426 cli_dhcpd ${action/dhcp/ip} "$@
"
1429 # DNS server configuration.
1443 error "Invalid
command given
: ${action}"
1444 cli_usage "network
help"
1445 exit ${EXIT_CONF_ERROR}