src/hooks/zones/6to4-tunnel

   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_SETTINGS="HOOK SERVER_ADDRESS LOCAL_ADDRESS LOCAL_ADDRESS6 TUNNEL_ID"
  25 HOOK_SETTINGS="${HOOK_SETTINGS} AUTO_UPDATE_ENDPOINT USERNAME PASSWORD"
  26
  27 # The IPv4 address of the tunnel endpoint where to connect to.
  28 SERVER_ADDRESS=
  29
  30 # The local IPv4 address of the tunnel endpoint.
  31 LOCAL_ADDRESS=
  32
  33 # The address that is assigned to the tunnel device (with prefix).
  34 LOCAL_ADDRESS6=
  35
  36 # True if the endpoint IP address should be automatically
  37 # updated each time the tunnel connects.
  38 AUTO_UPDATE_ENDPOINT="false"
  39
  40 # The ID of the tunnel.
  41 TUNNEL_ID=
  42
  43 # Credentials for the tunnelbroker.net service.
  44 USERNAME=
  45 PASSWORD=
  46
  47 hook_check_settings() {
  48         assert isset SERVER_ADDRESS
  49         assert isset LOCAL_ADDRESS
  50         assert isset LOCAL_ADDRESS6
  51         # LOCAL_ADDRESS6 needs to have a prefix
  52         assert ipv6_net_is_valid LOCAL_ADDRESS6
  53
  54         if enabled AUTO_UPDATE_ENDPOINT; then
  55                 assert isset TUNNEL_ID
  56                 assert isset USERNAME
  57                 assert isset PASSWORD
  58         fi
  59 }
  60
  61 hook_parse_cmdline() {
  62         local value
  63
  64         while [ $# -gt 0 ]; do
  65                 case "${1}" in
  66                         --server-address=*)
  67                                 SERVER_ADDRESS=$(cli_get_val ${1})
  68                                 ;;
  69                         --local-ipv4-address=*)
  70                                 LOCAL_ADDRESS=$(cli_get_val ${1})
  71                                 ;;
  72                         --local-ipv6-address=*)
  73                                 LOCAL_ADDRESS6=$(cli_get_val ${1})
  74                                 ;;
  75                         --auto-update-endpoint=*)
  76                                 local val="$(cli_get_val ${1})"
  77
  78                                 if enabled val; then
  79                                         AUTO_UPDATE_ENDPOINT="true"
  80                                 else
  81                                         AUTO_UPADTE_ENDPOINT="false"
  82                                 fi
  83                                 ;;
  84                         --tunnel-id=*)
  85                                 TUNNEL_ID="$(cli_get_val ${1})"
  86                                 ;;
  87                         --username=*)
  88                                 USERNAME="$(cli_get_val ${1})"
  89                                 ;;
  90                         --password=*)
  91                                 PASSWORD="$(cli_get_val ${1})"
  92                                 ;;
  93                         *)
  94                                 echo "Unknown option: ${1}" >&2
  95                                 exit ${EXIT_ERROR}
  96                                 ;;
  97                 esac
  98                 shift
  99         done
 100 }
 101
 102 hook_up() {
 103         local zone=${1}
 104         assert isset zone
 105
 106         # Read configuration options.
 107         zone_settings_read "${zone}"
 108
 109         if enabled AUTO_UPDATE_ENDPOINT; then
 110                 log DEBUG "Updating tunnel endpoint"
 111
 112                 he_tunnelbroker_endpoint_update \
 113                         --username="${USERNAME}" \
 114                         --password="${PASSWORD}" \
 115                         --tunnel-id="${TUNNEL_ID}"
 116         fi
 117
 118         ip_tunnel_add ${zone} --ttl=255 \
 119                 --remote-address="${SERVER_ADDRESS}" \
 120                 --local-address="${LOCAL_ADDRESS}"
 121
 122         # Bring up the device.
 123         device_set_up ${zone}
 124
 125         # Assign IPv6 address.
 126         ip_address_add ${zone} ${LOCAL_ADDRESS6}
 127
 128         # Update routing information.
 129         db_set "${zone}/ipv6/type" "${HOOK}"
 130         db_set "${zone}/ipv6/local-ip-address" "${LOCAL_ADDRESS6}"
 131         db_set "${zone}/ipv6/active" 1
 132
 133         # Update the routing database.
 134         routing_update ${zone} ipv6
 135         routing_default_update
 136
 137         exit ${EXIT_OK}
 138 }
 139
 140 hook_down() {
 141         local zone=${1}
 142         assert isset zone
 143
 144         # Remove everything from the routing db.
 145         db_delete "${zone}/ipv6"
 146
 147         routing_update ${zone} ipv6
 148         routing_default_update
 149
 150         # Remove the tunnel device.
 151         ip_tunnel_del ${zone}
 152
 153         exit ${EXIT_OK}
 154 }
 155
 156 hook_status() {
 157         local zone=${1}
 158         assert isset zone
 159
 160         cli_device_headline ${zone}
 161
 162         zone_settings_read "${zone}"
 163
 164         local server_line="${SERVER_ADDRESS}"
 165         local server_hostname=$(dns_get_hostname ${SERVER_ADDRESS})
 166         if [ -n "${server_hostname}" ]; then
 167                 server_line="${server_line} (Hostname: ${server_hostname})"
 168         fi
 169
 170         cli_headline 2 "Configuration"
 171         cli_print_fmt1 2 "Server" "${server_line}"
 172         cli_print_fmt1 2 "Endpoint IPv4 address" "${LOCAL_ADDRESS}"
 173         cli_print_fmt1 2 "Endpoint IPv6 address" "${LOCAL_ADDRESS6}"
 174         cli_space
 175
 176         exit ${EXIT_OK}
 177 }