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_discover
() {
258 # This can only be executed for ethernet (or compatible) devices
259 if ! device_is_ethernet_compatible
"${device}"; then
265 while [ $# -gt 0 ]; do
275 device_is_up
${device} && up
=1
276 device_set_up
${device}
278 enabled raw ||
echo "${device}"
283 for hook
in $
(hook_zone_get_all
); do
284 out
=$
(hook_zone_exec
${hook} discover
${device})
287 [ ${ret} -eq ${DISCOVER_NOT_SUPPORTED} ] && continue
295 echo "${hook}: ${line}"
300 echo "${hook}: FAILED"
306 echo " ${hook} was successful."
314 echo " ${hook} failed."
322 [ "${up}" = "1" ] || device_set_down
${device}
325 cli_device_serial_unlock
() {
326 if cli_help_requested
"$@"; then
327 cli_show_man network-device
334 if ! device_is_serial
${device}; then
335 error
"${device} is not a serial device."
336 error
"Unlocking is only supported for serial devices."
340 # Read the current state of the SIM card.
341 modem_sim_status
${device} &>/dev
/null
342 local sim_status_code
=$?
344 # If the SIM card is already unlocked, we don't need to do anything.
345 if [ ${sim_status_code} -eq ${EXIT_SIM_READY} ]; then
346 print
"The SIM card is already unlocked."
349 # If the SIM card is in an unknown state, we cannot do anything.
350 elif [ ${sim_status_code} -eq ${EXIT_SIM_UNKNOWN} ]; then
351 error
"The SIM card is in an unknown state."
357 local require_new_pin
="false"
360 while ! isinteger code
; do
362 case "${sim_status_code}" in
364 message
="Please enter PIN:"
367 message
="Please enter PUK:"
368 require_new_pin
="true"
373 echo -n "${message} "
375 echo # Print newline.
377 if enabled require_new_pin
; then
382 message
="Please enter a new PIN code:"
385 message
="Please confirm the new PIN code:"
389 echo -n "${message} "
391 echo # Print newline.
393 if [ -n "${new_pin}" ]; then
394 if [ "${new_pin}" != "${new_pin2}" ]; then
395 error
"The entered PIN codes did not match."
405 # Trying to unlock the SIM card.
406 modem_sim_unlock
${device} ${code} ${new_pin}
411 cli_device_send_ussd_command
() {
419 while [ $# -gt 0 ]; do
422 timeout
="$(cli_get_val "${1}")"
425 if isset
command; then
426 warning
"Unrecognized argument: ${1}"
435 assert device_is_serial
"${device}"
438 if isset timeout
; then
439 args
="${args} --timeout=${timeout}"
442 modem_ussd_send_command
"${device}" "${command}" ${args}
446 cli_device_monitor() {
450 if ! device_is_wireless "${device}"; then
451 error "This action only works with wireless devices. Exiting.
"
455 wireless_monitor "${device}"
461 for device in $(device_list); do
462 cli_device_status "${device}"
469 if cli_help_requested "$@
"; then
476 if [ -n "${hostname}" ]; then
477 config_hostname ${hostname}
478 log INFO "Hostname was
set to
'${hostname}'.
"
479 log INFO "Changes
do only take affect after reboot.
"
483 echo "$
(config_hostname
)"
488 if cli_help_requested "$@
"; then
489 cli_show_man network-port
496 if port_exists ${1}; then
502 edit|create|remove|up|down|status|identify)
503 port_${action} "${port}" "$@
"
506 color_cli "port
" "${port}" "$@
"
509 description_cli "port
" "${port}" "$@
"
512 error "Unrecognized argument
: ${action}"
525 error "Unrecognized argument
: ${action}"
533 if cli_help_requested "$@
"; then
534 cli_show_man network-zone
541 if zone_exists ${1}; then
561 cli_zone_port "${zone}" "$@
"
564 cli_zone_rename "${zone}" "$@
"
566 config|disable|down|edit|enable|identify|status|up)
567 zone_${action} ${zone} "$@
"
570 color_cli "zone
" "${zone}" "$@
"
573 description_cli "zone
" ${zone} "$@
"
576 error "Unrecognized argument
: ${action}"
577 cli_show_man network-zone
590 cli_zone_destroy "$@
"
593 if [ -n "${action}" ]; then
594 error "Unrecognized argument
: '${action}'"
598 cli_show_man network-zone
606 if cli_help_requested "$@
" || [ $# -lt 2 ]; then
607 cli_show_man network-zone-new
614 # Removes a zone either immediately, if it is currently down,
615 # or adds a tag that the removal will be done when the zone
616 # is brought down the next time.
618 if cli_help_requested "$@
"; then
619 cli_show_man network-zone
625 # Check if the zone exists
626 if ! zone_exists "${zone}"; then
627 error "Zone
'${zone}' does not exist
"
631 echo "Removing zone
'${zone}'...
"
632 zone_destroy "${zone}" || exit $?
636 if cli_help_requested "$@
"; then
637 cli_show_man network-zone-port
642 assert zone_exists "${zone}"
644 if port_exists "${2}"; then
651 zone_port_edit "${zone}" "${port}" "$@
"
654 error "Unrecognised argument
: ${action}"
664 zone_port_attach "${zone}" "$@
"
667 zone_port_detach "${zone}" "$@
"
670 error "Unrecognised argument
: ${action}"
680 if cli_help_requested "$@
"; then
681 cli_show_man network-zone
689 if ! isset name; then
690 error "You need to pass a new name
"
694 if ! zone_name_is_valid "${name}"; then
695 error "Invalid new zone name
: ${name}"
699 # Check if the zone exists
700 if ! zone_exists "${zone}"; then
701 error "Zone
${zone} does not exist
"
705 # Check if a zone with the new name already exists
706 if zone_exists "${name}"; then
707 error "Zone
${name} already exists
"
712 if ! zone_rename "${zone}" "${name}"; then
713 error "Could not rename zone
${zone} to
${name}"
724 if cli_help_requested "$@
"; then
725 cli_show_man network-zone
729 local hook_dir=$(hook_dir ${type})
732 for hook in ${hook_dir}/*; do
733 hook=$(basename ${hook})
734 if hook_exists ${type} ${hook}; then
744 if cli_help_requested "$@
"; then
745 cli_show_man network-dhcp
754 dhcpd_edit ${proto} "$@
"
759 # Make this permanent
760 dhcpd_enable ${proto}
765 # Make this permanent
766 dhcpd_disable ${proto}
769 dhcpd_reload ${proto}
772 cli_dhcpd_subnet ${proto} "$@
"
775 cli_dhcpd_show ${proto} "$@
"
778 error "Unrecognized action
: ${action}"
779 cli_run_help network dhcpvN
792 local settings=$(dhcpd_settings ${proto})
793 assert isset settings
796 dhcpd_global_settings_read ${proto}
798 cli_headline 1 "Dynamic Host Configuration Protocol Daemon
for ${proto/ip/IP}"
802 cli_headline 2 "Lease
times"
803 if isinteger VALID_LIFETIME; then
804 cli_print_fmt1 2 "Valid lifetime
" "$
(format_time
${VALID_LIFETIME})"
807 if isinteger PREFERRED_LIFETIME; then
808 cli_print_fmt1 2 "Preferred lifetime
" "$
(format_time
${PREFERRED_LIFETIME})"
814 cli_print_fmt1 1 "Authoritative
" $(cli_print_enabled AUTHORITATIVE)
817 cli_headline 2 "Lease
times"
818 cli_print_fmt1 2 "Default lease
time" "$
(format_time
${DEFAULT_LEASE_TIME})"
819 cli_print_fmt1 2 "Max. lease
time" "$
(format_time
${MAX_LEASE_TIME})"
821 if isset MIN_LEASE_TIME; then
822 cli_print_fmt1 2 "Min. lease
time" "$
(format_time
${MIN_LEASE_TIME})"
831 dhcpd_global_options_read ${proto}
833 # Print the options if any.
834 if [ ${#options[*]} -gt 0 ]; then
835 cli_headline 2 "Options
"
838 for option in $(dhcpd_options ${proto}); do
839 [ -n "${options[${option}]}" ] || continue
842 "${option}" "${options[${option}]}"
848 local subnets=$(dhcpd_subnet_list ${proto})
849 if [ -n "${subnets}" ]; then
850 cli_headline 2 "Subnets
"
852 for subnet in ${subnets}; do
853 cli_dhcpd_subnet_show ${proto} ${subnet} 2
864 if cli_help_requested "$@
"; then
865 cli_show_man network-dhcp-subnet
874 dhcpd_subnet_new ${proto} "$@
"
877 dhcpd_subnet_remove ${proto} "$@
"
880 local subnet=${action}
882 if ! dhcpd_subnet_exists ${proto} ${subnet}; then
883 error "Subnet
${subnet} does not exist
"
893 dhcpd_subnet_edit ${proto} ${subnet} "$@
"
896 if [ ${ret} -eq ${EXIT_OK} ]; then
897 dhcpd_reload ${proto}
902 cli_dhcpd_subnet_range ${proto} ${subnet} "$@
"
906 cli_dhcpd_subnet_show ${proto} ${subnet} "$@
"
910 cli_dhcpd_subnet_options ${proto} ${subnet} "$@
"
914 error "Unrecognized action
: ${action}"
915 cli_run_help network dhcpvN subnet
922 for subnet in $(dhcpd_subnet_list ${proto}); do
923 cli_dhcpd_subnet_show ${proto} ${subnet}
927 error "Unrecognized action
: ${action}"
928 cli_run_help network dhcpvN subnet
937 cli_dhcpd_subnet_range() {
947 dhcpd_subnet_range_new ${proto} ${subnet} "$@" || exit ${EXIT_ERROR}
950 dhcpd_subnet_range_remove ${proto} ${subnet} "$@" || exit ${EXIT_ERROR}
953 error "Unrecognized action
: ${action}"
954 cli_run_help network dhcpvN subnet range
959 dhcpd_reload ${proto}
963 cli_dhcpd_subnet_show() {
964 assert [ $# -ge 2 -a $# -le 3 ]
970 isset level || level=0
972 local $(dhcpd_subnet_settings ${proto})
974 # Read in configuration settings.
975 dhcpd_subnet_read ${proto} ${subnet}
977 cli_headline $(( ${level} + 1 )) "DHCP Subnet Declaration
"
978 cli_print_fmt1 $(( ${level} + 1 )) \
979 "Subnet
" "${ADDRESS}/${PREFIX}"
984 dhcpd_subnet_options_read "${proto}" "${subnet}"
986 # Print the options if any.
987 if [ ${#options[*]} -gt 0 ]; then
988 cli_headline $(( ${level} + 2 )) "Options
"
991 for option in $(dhcpd_subnet_options_list ${proto}); do
992 [ -n "${options[${option}]}" ] || continue
994 cli_print_fmt1 $(( ${level} + 2 )) \
995 "${option}" "${options[${option}]}"
1001 cli_headline $(( ${level} + 2 )) "Ranges
"
1003 local ranges=$(dhcpd_subnet_range_list ${proto} ${subnet})
1004 if isset ranges; then
1005 local range $(dhcpd_subnet_range_settings ${proto})
1006 for range in ${ranges}; do
1007 dhcpd_subnet_range_read ${proto} ${subnet} ${range}
1009 cli_print $(( ${level} + 2 )) "%s - %s" ${START} ${END}
1012 cli_print $(( ${level} + 2 )) "No ranges have been defined.
"
1018 cli_dhcpd_subnet_options() {
1025 while [ $# -gt 0 ]; do
1028 key=$(cli_get_key ${1})
1029 val=$(cli_get_val "${1}")
1031 dhcpd_subnet_option_set ${proto} ${subnet} ${key} ${val}
1038 if cli_help_requested "$@
"; then
1039 cli_show_man network
1043 local zones=$(zones_get "$@
")
1046 for zone in ${zones}; do
1047 zone_start ${zone} &
1050 wait # until everything is settled
1054 if cli_help_requested "$@
"; then
1055 cli_show_man network
1059 local zones=$(zones_get "$@
")
1062 for zone in ${zones}; do
1066 wait # until everything is settled
1070 if cli_help_requested "$@
"; then
1071 cli_show_man network
1077 # Give the system some time to calm down
1078 sleep ${TIMEOUT_RESTART}
1084 if cli_help_requested "$@
"; then
1085 cli_show_man network
1089 # When dumping status information, the debug
1090 # mode clutters the console which is not what we want.
1091 # Logging on the console is disabled for a short time.
1092 local log_disable_stdout=${LOG_DISABLE_STDOUT}
1093 LOG_DISABLE_STDOUT="true
"
1095 local arguments=( $@ )
1097 # Show all zones when no arguments are given
1098 if ! isset arguments; then
1100 for zone in $(zones_get_all); do
1101 zone_status "${zone}"
1108 for arg in ${arguments[@]}; do
1110 if zone_exists "${arg}"; then
1111 zone_status "${arg}"
1114 elif port_exists "${arg}"; then
1115 port_status "${arg}"
1118 elif phy_exists "${arg}"; then
1119 cli_device_status "${arg}"
1122 elif device_exists "${arg}"; then
1123 cli_device_status "${arg}"
1127 error "Unknown argument
: ${arg}"
1132 LOG_DISABLE_STDOUT=${log_disable_stdout}
1136 if cli_help_requested "$@
"; then
1137 cli_show_man network
1141 warning_log "Will
reset the whole network configuration
!!!"
1142 # Force mode is disabled by default
1145 while [ $# -gt 0 ]; do
1154 # If we are not running in force mode, we ask the user if he does know
1156 if ! enabled force; then
1157 if ! cli_yesno "Do you really want to
reset the whole network configuration?
"; then
1162 # Destroy all IPsec VPN connections
1164 for connection in $(ipsec_list_connections); do
1165 ipsec_connection_destroy "${connection}"
1169 for pool in $(ipsec_list_pools); do
1170 ipsec_pool_destroy "${pool}"
1174 ipsec_strongswan_autostart
1176 # Destroy all user-defined security policies
1178 for secpol in $(vpn_security_policies_list_user); do
1179 vpn_security_policies_destroy "${secpol}"
1183 for zone in $(zones_get_all); do
1184 zone_destroy "${zone}"
1188 for port in $(ports_get_all); do
1189 port_destroy "${port}"
1192 # Flush all DNS servers.
1195 # Trigger udev to re-add all physical network devices
1196 cmd_quiet udevadm trigger --action=add --subsystem-match=net
1201 # Help function: will show the default man page to the user.
1202 # Optionally, there are two arguments taken, the type of hook
1203 # and which hook should be shown.
1213 # List all hooks if requested
1214 if [ "${hook}" = "list-hooks
" ]; then
1215 cli_list_hooks ${type}
1219 if ! hook_exists ${type} ${hook}; then
1220 error "No hook with name
'${hook}' could be found
"
1221 exit "${EXIT_ERROR}"
1224 hook_exec ${type} ${hook} help
1227 # In all other cases show the default man page
1229 cli_show_man network
1234 return ${EXIT_ERROR}
1238 if cli_help_requested "$@
"; then
1239 cli_show_man network-dns-server
1244 local cmd=${1}; shift
1245 if [ -z "${cmd}" ]; then
1246 cli_show_man network-dns-server
1250 # Get the new server to process (if any).
1260 if dns_server_exists ${server}; then
1261 error "DNS server
'${server}' already exists
!"
1265 log INFO "Adding new DNS server
: ${server}"
1266 dns_server_add ${server} ${priority}
1269 if ! dns_server_exists ${server}; then
1270 error "DNS server
'${server}' does not exist
!"
1274 log INFO "Removing DNS server
: ${server}"
1275 dns_server_remove ${server} ${priority}
1278 # Just run the update afterwards.
1281 error "No such
command: ${cmd}"
1285 # Update the local DNS configuration after changes have been made.
1300 device-get-by-mac-address)
1301 device_get_by_mac_address "$@
"
1303 ipsec-connection-exists)
1304 ipsec_connection_exists "$@
"
1309 list-dhcpd-ranges-of-subnet)
1310 dhcpd_subnet_range_list "$@
"
1312 list-dhcpd-settings)
1313 dhcpd_global_settings_list "$@
"
1316 dhcpd_subnet_list "$@
"
1318 list-dhcpd-subnet-options)
1319 dhcpd_subnet_options_list "$@
"
1330 list-ipsec-connections)
1331 ipsec_list_connections
1339 list-vpn-security-policies-all)
1340 vpn_security_policies_list_all
1343 network_settings_list
1348 list-next-free-zones)
1351 list-zone-config-ids)
1352 zone_config_list_ids "$@
"
1354 list-zone-config-hids)
1355 zone_config_list_hids "$@
"
1357 vpn-security-policy-exists)
1358 vpn_security_policy_exists "$@
"
1361 zone_name_is_valid "$@
"
1363 zone-config-id-is-valid)
1364 zone_config_id_is_valid "$@
"
1366 zone-config-hid-is-valid)
1367 zone_config_hid_is_valid "$@
"
1370 error "No such
command: ${cmd}"
1378 # Process the given action
1381 # Update resolv.conf(5) when initializing the network
1382 dns_generate_resolvconf
1384 # Update bird configuration
1385 bird_generate_config
1387 # Also execute all triggers
1388 triggers_execute_all "init
"
1391 settings|hostname|port|device|zone|start|stop|restart|status|reset|route|vpn|wireless)
1395 # DHCP server configuration (automatically detects which protocol to use).
1397 cli_dhcpd ${action/dhcp/ip} "$@
"
1400 # DNS server configuration.
1414 error "Invalid
command given
: ${action}"
1415 cli_usage "network
help"
1416 exit ${EXIT_CONF_ERROR}