src/hooks/zones/bridge

   1 #!/bin/bash
   2 ###############################################################################
   3 #                                                                             #
   4 # IPFire.org - A linux based firewall                                         #
   5 # Copyright (C) 2010  Michael Tremer & Christian Schmidt                      #
   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
  22 . /usr/lib/network/header-zone
  23
  24 HOOK_MANPAGE="network-zone-bridge"
  25
  26 HOOK_SETTINGS="HOOK STP STP_FORWARD_DELAY STP_HELLO STP_MAXAGE STP_MODE"
  27 HOOK_SETTINGS="${HOOK_SETTINGS} STP_PRIORITY MAC MTU"
  28
  29 HOOK_PORT_SETTINGS="COST PRIORITY"
  30
  31 # Default values
  32 MAC=$(mac_generate)
  33 MTU=1500
  34 STP="on"
  35 STP_MODE="rstp"
  36 STP_FORWARD_DELAY=0
  37 STP_HELLO=2
  38 STP_MAXAGE=20
  39 STP_PRIORITY=512
  40
  41 function hook_check() {
  42         assert ismac MAC
  43         assert isbool STP
  44         assert isoneof STP_MODE stp rstp
  45         assert isinteger STP_HELLO
  46         assert isinteger STP_FORWARD_DELAY
  47         assert isinteger STP_PRIORITY
  48         assert isinteger MTU
  49 }
  50
  51 function hook_parse_cmdline() {
  52         while [ $# -gt 0 ]; do
  53                 case "${1}" in
  54                         --stp=*)
  55                                 STP=${1#--stp=}
  56                                 ;;
  57                         --stp-mode=*)
  58                                 STP_MODE=${1#--stp-mode=}
  59                                 ;;
  60                         --stp-hello=*)
  61                                 STP_HELLO=${1#--stp-hello=}
  62                                 ;;
  63                         --stp-forward-delay=*)
  64                                 STP_FORWARD_DELAY=${1#--stp-forward-delay=}
  65                                 ;;
  66                         --stp-priority=*)
  67                                 STP_PRIORITY=${1#--stp-priority=}
  68                                 ;;
  69                         --mtu=*)
  70                                 MTU=${1#--mtu=}
  71                                 ;;
  72                         --mac=*)
  73                                 MAC=${1#--mac=}
  74                                 ;;
  75                         *)
  76                                 warning "Ignoring unknown option '${1}'"
  77                                 ;;
  78                 esac
  79                 shift
  80         done
  81 }
  82
  83 function hook_up() {
  84         local zone=${1}
  85         assert isset zone
  86
  87         zone_settings_read "${zone}" ${HOOK_SETTINGS}
  88
  89         # Create the bridge if it does not already exist.
  90         if ! device_exists "${zone}"; then
  91                 bridge_create "${zone}" \
  92                         --address="${MAC}" \
  93                         --mtu="${MTU}"
  94         fi
  95
  96         # Enable STP
  97         if enabled STP; then
  98                 stp_enable "${zone}"
  99
 100                 if isset STP_FORWARD_DELAY; then
 101                         stp_bridge_set_forward_delay "${zone}" "${STP_FORWARD_DELAY}"
 102                 fi
 103
 104                 if isset STP_HELLO; then
 105                         stp_bridge_set_hello_time "${zone}" "${STP_HELLO}"
 106                 fi
 107
 108                 if isset STP_MAXAGE; then
 109                         stp_bridge_set_max_age "${zone}" "${STP_MAXAGE}"
 110                 fi
 111
 112                 if isset STP_PRIORITY; then
 113                         stp_bridge_set_priority "${zone}" "${STP_PRIORITY}"
 114                 fi
 115         else
 116                 stp_disable "${zone}"
 117         fi
 118
 119         device_set_up "${zone}"
 120
 121         # XXX Currently, there is a bug (in the linux kernel?) that we need to
 122         # set our bridges to promisc mode.
 123         device_set_promisc "${zone}" on
 124
 125         # Bring up all ports
 126         zone_ports_up "${zone}"
 127
 128         # Bring up all configurations
 129         zone_configs_up "${zone}"
 130
 131         exit ${EXIT_OK}
 132 }
 133
 134 function hook_hotplug() {
 135         local zone="${1}"
 136         assert isset zone
 137
 138         case "$(hotplug_action)" in
 139                 add)
 140                         # Handle ports of this zone that have just been added
 141                         if hotplug_event_interface_is_port_of_zone "${zone}"; then
 142                                 # Bring up the zone if it is enabled but not active, yet.
 143                                 if zone_is_enabled "${zone}" && ! zone_is_active "${zone}"; then
 144                                         zone_start "${zone}"
 145                                 fi
 146
 147                                 hook_port_up "${zone}" "${INTERFACE}"
 148                         fi
 149                         ;;
 150                 remove)
 151                         # Handle ports of this zone that have just been removed
 152                         if hotplug_event_interface_is_port_of_zone "${zone}"; then
 153                                 hook_port_down "${zone}" "${INTERFACE}"
 154                         fi
 155                         ;;
 156                 *)
 157                         exit ${EXIT_NOT_HANDLED}
 158                         ;;
 159         esac
 160
 161         exit ${EXIT_OK}
 162 }
 163
 164 function hook_down() {
 165         local zone="${1}"
 166         assert isset zone
 167
 168         if ! device_is_up "${zone}"; then
 169                 warning "Zone '${zone}' is not up"
 170                 exit ${EXIT_OK}
 171         fi
 172
 173         # Stop all the configs.
 174         zone_configs_down "${zone}"
 175
 176         # Bring down all the ports.
 177         zone_ports_down "${zone}"
 178
 179         # Remove the bridge.
 180         device_set_down "${zone}"
 181         bridge_delete "${zone}"
 182
 183         exit ${EXIT_OK}
 184 }
 185
 186 function hook_status() {
 187         local zone="${1}"
 188         assert isset zone
 189
 190         # Print the default header.
 191         cli_device_headline "${zone}"
 192
 193         # Exit if zone is down
 194         if ! zone_is_up "${zone}"; then
 195                 echo # Empty line
 196                 exit ${EXIT_ERROR}
 197         fi
 198
 199         cli_headline 2 "Spanning Tree Protocol information"
 200         if stp_is_enabled "${zone}"; then
 201                 local proto=$(stp_bridge_get_protocol ${zone})
 202
 203                 cli_print_fmt1 2 "Version"      "$(stp_get_name ${proto})"
 204                 cli_print_fmt1 2 "ID"           "$(stp_bridge_get_id ${zone})"
 205                 cli_print_fmt1 2 "Priority"     "$(stp_bridge_get_priority ${zone})"
 206
 207                 if stp_bridge_is_root ${zone}; then
 208                         cli_print 2 "This bridge is root."
 209                 else
 210                         cli_print_fmt1 2 "Designated root" \
 211                                 "$(stp_bridge_get_designated_root ${zone})"
 212                         cli_print_fmt1 2 "Root path cost" \
 213                                 "$(stp_bridge_get_root_path_cost ${zone})"
 214                 fi
 215                 cli_space
 216
 217                 # Topology information
 218                 cli_print_fmt1 2 "Topology changing" \
 219                         "$(stp_bridge_get_topology_change_detected ${zone})"
 220                 cli_print_fmt1 2 "Topology change time" \
 221                         "$(beautify_time $(stp_bridge_get_topology_change_timer ${zone}))"
 222                 cli_print_fmt1 2 "Topology change count" \
 223                         "$(stp_bridge_get_topology_change_count ${zone})"
 224                 cli_space
 225         else
 226                 cli_print 2 "Disabled"
 227                 cli_space
 228         fi
 229
 230         cli_headline 2 "Ports"
 231         zone_ports_status "${zone}"
 232         cli_space
 233
 234         cli_headline 2 "Configurations"
 235         zone_configs_cmd status "${zone}"
 236         cli_space
 237
 238         exit ${EXIT_OK}
 239 }
 240
 241 function __parse_cmdline_args() {
 242         while [ $# -gt 0 ]; do
 243                 case "${1}" in
 244                         --priority=*)
 245                                 PRIORITY="$(cli_get_val ${1})"
 246                                 ;;
 247                         --cost=*)
 248                                 COST="$(cli_get_val ${1})"
 249                                 ;;
 250                 esac
 251                 shift
 252         done
 253
 254         return ${EXIT_OK}
 255 }
 256
 257 function hook_port_add() {
 258         # Excepting at least two arguments here
 259         assert [ $# -ge 2 ]
 260
 261         local zone="${1}"
 262         local port="${2}"
 263         shift 2
 264
 265         __parse_cmdline_args "$@"
 266         [ $? -eq ${EXIT_OK} ] || return ${EXIT_ERROR}
 267
 268         zone_port_settings_write "${zone}" "${port}" ${HOOK_PORT_SETTINGS}
 269
 270         log INFO "Port '${port}' has been added to zone '${zone}'"
 271
 272         exit ${EXIT_OK}
 273 }
 274
 275 function hook_port_edit() {
 276         assert [ $# -ge 2 ]
 277
 278         local zone="${1}"
 279         local port="${2}"
 280         shift 2
 281
 282         zone_port_settings_read "${zone}" "${port}" ${HOOK_PORT_SETTINGS}
 283
 284         __parse_cmdline_args "$@"
 285         [ $? -eq ${EXIT_OK} ] || return ${EXIT_ERROR}
 286
 287         zone_port_settings_write "${zone}" "${port}" ${HOOK_PORT_SETTINGS}
 288
 289         log INFO "Port '${port}' (member of zone '${zone}') has been edited"
 290
 291         exit ${EXIT_OK}
 292 }
 293
 294 function hook_port_remove() {
 295         assert [ $# -eq 2 ]
 296
 297         local zone="${1}"
 298         local port="${2}"
 299
 300         # Shut down the port (if possible)
 301         port_down "${port}"
 302
 303         log INFO "Port '${port}' has been removed from zone '${zone}'"
 304         zone_port_settings_remove "${zone}" "${port}"
 305
 306         exit ${EXIT_OK}
 307 }
 308
 309 function hook_port_up() {
 310         assert [ $# -eq 2 ]
 311
 312         local zone="${1}"
 313         local port="${2}"
 314
 315         # Try bringing up the port if it has not been
 316         # brought up before.
 317         # We will get here as soon as the port device has
 318         # been created and will then connect it with the bridge.
 319         if ! device_exists "${port}"; then
 320                 port_up "${port}"
 321
 322                 exit ${EXIT_OK}
 323         fi
 324
 325         # Read configuration values
 326         zone_port_settings_read "${zone}" "${port}" ${HOOK_PORT_SETTINGS}
 327
 328         # Attach the port to the bridge
 329         bridge_attach_device "${zone}" "${port}"
 330
 331         # Set STP configuration
 332         if isset COST; then
 333                 stp_port_set_cost "${zone}" "${port}" "${COST}"
 334         fi
 335
 336         # TODO Apply priority (#10609)
 337
 338         # Make sure that the port is up
 339         device_set_up "${port}"
 340
 341         exit ${EXIT_OK}
 342 }
 343
 344 function hook_port_down() {
 345         assert [ $# -eq 2 ]
 346
 347         local zone="${1}"
 348         local port="${2}"
 349
 350         if device_exists "${port}"; then
 351                 bridge_detach_device "${zone}" "${port}"
 352
 353                 port_down "${port}"
 354         fi
 355
 356         exit ${EXIT_OK}
 357 }
 358
 359 function hook_port_status() {
 360         assert [ $# -eq 2 ]
 361
 362         local zone="${1}"
 363         local port="${2}"
 364
 365         # Do nothing for devices which are not up and running.
 366         device_exists "${port}" || exit ${EXIT_OK}
 367
 368         local status
 369
 370         # Check if the device is down.
 371         if ! device_is_up "${port}"; then
 372                 status="${MSG_DEVICE_STATUS_DOWN}"
 373
 374         # Check if the device has no carrier.
 375         elif ! device_has_carrier "${port}"; then
 376                 status="${MSG_DEVICE_STATUS_NOCARRIER}"
 377
 378         # Check for STP information.
 379         elif stp_is_enabled "${zone}"; then
 380                 local state="$(stp_port_get_state "${zone}" "${port}")"
 381                 state="MSG_STP_${state}"
 382                 status="${!state}"
 383
 384                 status="${status} - DSR: $(stp_port_get_designated_root "${zone}" "${port}")"
 385                 status="${status} - Cost: $(stp_port_get_cost "${zone}" "${port}")"
 386         else
 387                 status="${MSG_DEVICE_STATUS_UP}"
 388         fi
 389         cli_statusline 3 "${port}" "${status}"
 390
 391         exit ${EXIT_OK}
 392 }