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