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}"
280 cli_headline
2 "Features"
282 cli_print_fmt1
2 "DFS" \
283 "$(phy_supports_dfs "${phy}" && print "Supported
" ||Â print "Not Supported
")"
290 cli_device_discover
() {
294 # This can only be executed for ethernet (or compatible) devices
295 if ! device_is_ethernet_compatible
"${device}"; then
301 while [ $# -gt 0 ]; do
311 device_is_up
${device} && up
=1
312 device_set_up
${device}
314 enabled raw ||
echo "${device}"
319 for hook
in $
(hook_zone_get_all
); do
320 out
=$
(hook_zone_exec
${hook} discover
${device})
323 [ ${ret} -eq ${DISCOVER_NOT_SUPPORTED} ] && continue
331 echo "${hook}: ${line}"
336 echo "${hook}: FAILED"
342 echo " ${hook} was successful."
350 echo " ${hook} failed."
358 [ "${up}" = "1" ] || device_set_down
${device}
361 cli_device_serial_unlock
() {
362 if cli_help_requested
"$@"; then
363 cli_show_man network-device
370 if ! device_is_serial
${device}; then
371 error
"${device} is not a serial device."
372 error
"Unlocking is only supported for serial devices."
376 # Read the current state of the SIM card.
377 modem_sim_status
${device} &>/dev
/null
378 local sim_status_code
=$?
380 # If the SIM card is already unlocked, we don't need to do anything.
381 if [ ${sim_status_code} -eq ${EXIT_SIM_READY} ]; then
382 print
"The SIM card is already unlocked."
385 # If the SIM card is in an unknown state, we cannot do anything.
386 elif [ ${sim_status_code} -eq ${EXIT_SIM_UNKNOWN} ]; then
387 error
"The SIM card is in an unknown state."
393 local require_new_pin
="false"
396 while ! isinteger code
; do
398 case "${sim_status_code}" in
400 message
="Please enter PIN:"
403 message
="Please enter PUK:"
404 require_new_pin
="true"
409 echo -n "${message} "
411 echo # Print newline.
413 if enabled require_new_pin
; then
418 message
="Please enter a new PIN code:"
421 message
="Please confirm the new PIN code:"
425 echo -n "${message} "
427 echo # Print newline.
429 if [ -n "${new_pin}" ]; then
430 if [ "${new_pin}" != "${new_pin2}" ]; then
431 error
"The entered PIN codes did not match."
441 # Trying to unlock the SIM card.
442 modem_sim_unlock
${device} ${code} ${new_pin}
447 cli_device_send_ussd_command
() {
455 while [ $# -gt 0 ]; do
458 timeout
="$(cli_get_val "${1}")"
461 if isset
command; then
462 warning
"Unrecognized argument: ${1}"
471 assert device_is_serial
"${device}"
474 if isset timeout
; then
475 args
="${args} --timeout=${timeout}"
478 modem_ussd_send_command
"${device}" "${command}" ${args}
482 cli_device_monitor() {
486 if ! device_is_wireless "${device}"; then
487 error "This action only works with wireless devices. Exiting.
"
491 wireless_monitor "${device}"
497 for device in $(device_list); do
498 cli_device_status "${device}"
505 if cli_help_requested "$@
"; then
512 if [ -n "${hostname}" ]; then
513 config_hostname ${hostname}
514 log INFO "Hostname was
set to
'${hostname}'.
"
515 log INFO "Changes
do only take affect after reboot.
"
519 echo "$
(config_hostname
)"
524 if cli_help_requested "$@
"; then
525 cli_show_man network-port
532 if port_exists ${1}; then
538 edit|create|remove|up|down|status|identify)
539 port_${action} "${port}" "$@
"
542 color_cli "port
" "${port}" "$@
"
545 description_cli "port
" "${port}" "$@
"
548 error "Unrecognized argument
: ${action}"
561 error "Unrecognized argument
: ${action}"
569 if cli_help_requested "$@
"; then
570 cli_show_man network-zone
577 if zone_exists ${1}; then
597 cli_zone_port "${zone}" "$@
"
600 cli_zone_rename "${zone}" "$@
"
602 config|disable|down|edit|enable|identify|status|up)
603 zone_${action} ${zone} "$@
"
606 color_cli "zone
" "${zone}" "$@
"
609 description_cli "zone
" ${zone} "$@
"
612 error "Unrecognized argument
: ${action}"
613 cli_show_man network-zone
626 cli_zone_destroy "$@
"
629 if [ -n "${action}" ]; then
630 error "Unrecognized argument
: '${action}'"
634 cli_show_man network-zone
642 if cli_help_requested "$@
" || [ $# -lt 2 ]; then
643 cli_show_man network-zone-new
650 # Removes a zone either immediately, if it is currently down,
651 # or adds a tag that the removal will be done when the zone
652 # is brought down the next time.
654 if cli_help_requested "$@
"; then
655 cli_show_man network-zone
661 # Check if the zone exists
662 if ! zone_exists "${zone}"; then
663 error "Zone
'${zone}' does not exist
"
667 echo "Removing zone
'${zone}'...
"
668 zone_destroy "${zone}" || exit $?
672 if cli_help_requested "$@
"; then
673 cli_show_man network-zone-port
678 assert zone_exists "${zone}"
680 if port_exists "${2}"; then
687 zone_port_edit "${zone}" "${port}" "$@
"
690 error "Unrecognised argument
: ${action}"
700 zone_port_attach "${zone}" "$@
"
703 zone_port_detach "${zone}" "$@
"
706 error "Unrecognised argument
: ${action}"
716 if cli_help_requested "$@
"; then
717 cli_show_man network-zone
725 if ! isset name; then
726 error "You need to pass a new name
"
730 if ! zone_name_is_valid "${name}"; then
731 error "Invalid new zone name
: ${name}"
735 # Check if the zone exists
736 if ! zone_exists "${zone}"; then
737 error "Zone
${zone} does not exist
"
741 # Check if a zone with the new name already exists
742 if zone_exists "${name}"; then
743 error "Zone
${name} already exists
"
748 if ! zone_rename "${zone}" "${name}"; then
749 error "Could not rename zone
${zone} to
${name}"
760 if cli_help_requested "$@
"; then
761 cli_show_man network-zone
765 local hook_dir=$(hook_dir ${type})
768 for hook in ${hook_dir}/*; do
769 hook=$(basename ${hook})
770 if hook_exists ${type} ${hook}; then
780 if cli_help_requested "$@
"; then
781 cli_show_man network-dhcp
790 dhcpd_edit ${proto} "$@
"
795 # Make this permanent
796 dhcpd_enable ${proto}
801 # Make this permanent
802 dhcpd_disable ${proto}
805 dhcpd_reload ${proto}
808 cli_dhcpd_subnet ${proto} "$@
"
811 cli_dhcpd_show ${proto} "$@
"
814 error "Unrecognized action
: ${action}"
815 cli_run_help network dhcpvN
828 local settings=$(dhcpd_settings ${proto})
829 assert isset settings
832 dhcpd_global_settings_read ${proto}
834 cli_headline 1 "Dynamic Host Configuration Protocol Daemon
for ${proto/ip/IP}"
838 cli_headline 2 "Lease
times"
839 if isinteger VALID_LIFETIME; then
840 cli_print_fmt1 2 "Valid lifetime
" "$
(format_time
${VALID_LIFETIME})"
843 if isinteger PREFERRED_LIFETIME; then
844 cli_print_fmt1 2 "Preferred lifetime
" "$
(format_time
${PREFERRED_LIFETIME})"
850 cli_print_fmt1 1 "Authoritative
" $(cli_print_enabled AUTHORITATIVE)
853 cli_headline 2 "Lease
times"
854 cli_print_fmt1 2 "Default lease
time" "$
(format_time
${DEFAULT_LEASE_TIME})"
855 cli_print_fmt1 2 "Max. lease
time" "$
(format_time
${MAX_LEASE_TIME})"
857 if isset MIN_LEASE_TIME; then
858 cli_print_fmt1 2 "Min. lease
time" "$
(format_time
${MIN_LEASE_TIME})"
867 dhcpd_global_options_read ${proto}
869 # Print the options if any.
870 if [ ${#options[*]} -gt 0 ]; then
871 cli_headline 2 "Options
"
874 for option in $(dhcpd_options ${proto}); do
875 [ -n "${options[${option}]}" ] || continue
878 "${option}" "${options[${option}]}"
884 local subnets=$(dhcpd_subnet_list ${proto})
885 if [ -n "${subnets}" ]; then
886 cli_headline 2 "Subnets
"
888 for subnet in ${subnets}; do
889 cli_dhcpd_subnet_show ${proto} ${subnet} 2
900 if cli_help_requested "$@
"; then
901 cli_show_man network-dhcp-subnet
910 dhcpd_subnet_new ${proto} "$@
"
913 dhcpd_subnet_remove ${proto} "$@
"
916 local subnet=${action}
918 if ! dhcpd_subnet_exists ${proto} ${subnet}; then
919 error "Subnet
${subnet} does not exist
"
929 dhcpd_subnet_edit ${proto} ${subnet} "$@
"
932 if [ ${ret} -eq ${EXIT_OK} ]; then
933 dhcpd_reload ${proto}
938 cli_dhcpd_subnet_range ${proto} ${subnet} "$@
"
942 cli_dhcpd_subnet_show ${proto} ${subnet} "$@
"
946 cli_dhcpd_subnet_options ${proto} ${subnet} "$@
"
950 error "Unrecognized action
: ${action}"
951 cli_run_help network dhcpvN subnet
958 for subnet in $(dhcpd_subnet_list ${proto}); do
959 cli_dhcpd_subnet_show ${proto} ${subnet}
963 error "Unrecognized action
: ${action}"
964 cli_run_help network dhcpvN subnet
973 cli_dhcpd_subnet_range() {
983 dhcpd_subnet_range_new ${proto} ${subnet} "$@" || exit ${EXIT_ERROR}
986 dhcpd_subnet_range_remove ${proto} ${subnet} "$@" || exit ${EXIT_ERROR}
989 error "Unrecognized action
: ${action}"
990 cli_run_help network dhcpvN subnet range
995 dhcpd_reload ${proto}
999 cli_dhcpd_subnet_show() {
1000 assert [ $# -ge 2 -a $# -le 3 ]
1006 isset level || level=0
1008 local $(dhcpd_subnet_settings ${proto})
1010 # Read in configuration settings.
1011 dhcpd_subnet_read ${proto} ${subnet}
1013 cli_headline $(( ${level} + 1 )) "DHCP Subnet Declaration
"
1014 cli_print_fmt1 $(( ${level} + 1 )) \
1015 "Subnet
" "${ADDRESS}/${PREFIX}"
1020 dhcpd_subnet_options_read "${proto}" "${subnet}"
1022 # Print the options if any.
1023 if [ ${#options[*]} -gt 0 ]; then
1024 cli_headline $(( ${level} + 2 )) "Options
"
1027 for option in $(dhcpd_subnet_options_list ${proto}); do
1028 [ -n "${options[${option}]}" ] || continue
1030 cli_print_fmt1 $(( ${level} + 2 )) \
1031 "${option}" "${options[${option}]}"
1037 cli_headline $(( ${level} + 2 )) "Ranges
"
1039 local ranges=$(dhcpd_subnet_range_list ${proto} ${subnet})
1040 if isset ranges; then
1041 local range $(dhcpd_subnet_range_settings ${proto})
1042 for range in ${ranges}; do
1043 dhcpd_subnet_range_read ${proto} ${subnet} ${range}
1045 cli_print $(( ${level} + 2 )) "%s - %s" ${START} ${END}
1048 cli_print $(( ${level} + 2 )) "No ranges have been defined.
"
1054 cli_dhcpd_subnet_options() {
1061 while [ $# -gt 0 ]; do
1064 key=$(cli_get_key ${1})
1065 val=$(cli_get_val "${1}")
1067 dhcpd_subnet_option_set ${proto} ${subnet} ${key} ${val}
1074 if cli_help_requested "$@
"; then
1075 cli_show_man network
1079 local zones=$(zones_get "$@
")
1082 for zone in ${zones}; do
1083 zone_start ${zone} &
1086 wait # until everything is settled
1090 if cli_help_requested "$@
"; then
1091 cli_show_man network
1095 local zones=$(zones_get "$@
")
1098 for zone in ${zones}; do
1102 wait # until everything is settled
1106 if cli_help_requested "$@
"; then
1107 cli_show_man network
1113 # Give the system some time to calm down
1114 sleep ${TIMEOUT_RESTART}
1120 if cli_help_requested "$@
"; then
1121 cli_show_man network
1125 # When dumping status information, the debug
1126 # mode clutters the console which is not what we want.
1127 # Logging on the console is disabled for a short time.
1128 local log_disable_stdout=${LOG_DISABLE_STDOUT}
1129 LOG_DISABLE_STDOUT="true
"
1131 local arguments=( $@ )
1133 # Show all zones when no arguments are given
1134 if ! isset arguments; then
1136 for zone in $(zones_get_all); do
1137 zone_status "${zone}"
1144 for arg in ${arguments[@]}; do
1146 if zone_exists "${arg}"; then
1147 zone_status "${arg}"
1150 elif port_exists "${arg}"; then
1151 port_status "${arg}"
1154 elif phy_exists "${arg}"; then
1155 cli_device_status "${arg}"
1158 elif device_exists "${arg}"; then
1159 cli_device_status "${arg}"
1163 error "Unknown argument
: ${arg}"
1168 LOG_DISABLE_STDOUT=${log_disable_stdout}
1172 if cli_help_requested "$@
"; then
1173 cli_show_man network
1177 warning_log "Will
reset the whole network configuration
!!!"
1178 # Force mode is disabled by default
1181 while [ $# -gt 0 ]; do
1190 # If we are not running in force mode, we ask the user if he does know
1192 if ! enabled force; then
1193 if ! cli_yesno "Do you really want to
reset the whole network configuration?
"; then
1198 # Destroy all IPsec VPN connections
1200 for connection in $(ipsec_list_connections); do
1201 ipsec_connection_destroy "${connection}"
1205 for pool in $(ipsec_list_pools); do
1206 ipsec_pool_destroy "${pool}"
1210 ipsec_strongswan_autostart
1212 # Destroy all user-defined security policies
1214 for secpol in $(vpn_security_policies_list_user); do
1215 vpn_security_policies_destroy "${secpol}"
1219 for zone in $(zones_get_all); do
1220 zone_destroy "${zone}"
1224 for port in $(ports_get_all); do
1225 port_destroy "${port}"
1228 # Flush all DNS servers.
1231 # Trigger udev to re-add all physical network devices
1232 cmd_quiet udevadm trigger --action=add --subsystem-match=net
1237 # Help function: will show the default man page to the user.
1238 # Optionally, there are two arguments taken, the type of hook
1239 # and which hook should be shown.
1249 # List all hooks if requested
1250 if [ "${hook}" = "list-hooks
" ]; then
1251 cli_list_hooks ${type}
1255 if ! hook_exists ${type} ${hook}; then
1256 error "No hook with name
'${hook}' could be found
"
1257 exit "${EXIT_ERROR}"
1260 hook_exec ${type} ${hook} help
1263 # In all other cases show the default man page
1265 cli_show_man network
1270 return ${EXIT_ERROR}
1274 if cli_help_requested "$@
"; then
1275 cli_show_man network-dns-server
1280 local cmd=${1}; shift
1281 if [ -z "${cmd}" ]; then
1282 cli_show_man network-dns-server
1286 # Get the new server to process (if any).
1296 if dns_server_exists ${server}; then
1297 error "DNS server
'${server}' already exists
!"
1301 log INFO "Adding new DNS server
: ${server}"
1302 dns_server_add ${server} ${priority}
1305 if ! dns_server_exists ${server}; then
1306 error "DNS server
'${server}' does not exist
!"
1310 log INFO "Removing DNS server
: ${server}"
1311 dns_server_remove ${server} ${priority}
1314 # Just run the update afterwards.
1317 error "No such
command: ${cmd}"
1321 # Update the local DNS configuration after changes have been made.
1336 device-get-by-mac-address)
1337 device_get_by_mac_address "$@
"
1339 ipsec-connection-exists)
1340 ipsec_connection_exists "$@
"
1345 list-dhcpd-ranges-of-subnet)
1346 dhcpd_subnet_range_list "$@
"
1348 list-dhcpd-settings)
1349 dhcpd_global_settings_list "$@
"
1352 dhcpd_subnet_list "$@
"
1354 list-dhcpd-subnet-options)
1355 dhcpd_subnet_options_list "$@
"
1366 list-ipsec-connections)
1367 ipsec_list_connections
1375 list-vpn-security-policies-all)
1376 vpn_security_policies_list_all
1379 network_settings_list
1384 list-next-free-zones)
1387 list-zone-config-ids)
1388 zone_config_list_ids "$@
"
1390 list-zone-config-hids)
1391 zone_config_list_hids "$@
"
1393 vpn-security-policy-exists)
1394 vpn_security_policy_exists "$@
"
1397 zone_name_is_valid "$@
"
1399 zone-config-id-is-valid)
1400 zone_config_id_is_valid "$@
"
1402 zone-config-hid-is-valid)
1403 zone_config_hid_is_valid "$@
"
1406 error "No such
command: ${cmd}"
1414 # Process the given action
1417 # Update resolv.conf(5) when initializing the network
1418 dns_generate_resolvconf
1420 # Update bird configuration
1421 bird_generate_config
1423 # Also execute all triggers
1424 triggers_execute_all "init
"
1427 settings|hostname|port|device|zone|start|stop|restart|status|reset|route|vpn|wireless)
1431 # DHCP server configuration (automatically detects which protocol to use).
1433 cli_dhcpd ${action/dhcp/ip} "$@
"
1436 # DNS server configuration.
1450 error "Invalid
command given
: ${action}"
1451 cli_usage "network
help"
1452 exit ${EXIT_CONF_ERROR}