src/hooks/zones/modem

   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 . /lib/network/header-zone
  23
  24 # Modems support all authentication methods, that pppd does support.
  25 MODEM_ALLOWED_AUTH_METHODS="${PPP_ALLOWED_AUTH_METHODS}"
  26
  27 HOOK_SETTINGS="HOOK"
  28
  29 # Access Point Name.
  30 APN=
  31 HOOK_SETTINGS="${HOOK_SETTINGS} APN"
  32
  33 # Sets the authentication algortihm that must be used.
  34 AUTH=
  35 HOOK_SETTINGS="${HOOK_SETTINGS} AUTH"
  36
  37 # Baudrate.
  38 BAUDRATE=921600
  39 HOOK_SETTINGS="${HOOK_SETTINGS} BAUDRATE"
  40
  41 # The device name of the serial device.
  42 # XXX how can we make sure that this does not change all the time?
  43 DEVICE=
  44 HOOK_SETTINGS="${HOOK_SETTINGS} DEVICE"
  45
  46 # A monitor device.
  47 # Send AT commands to this device, when the primary device is
  48 # connected.
  49 MONITOR_DEVICE=
  50 HOOK_SETTINGS="${HOOK_SETTINGS} MONITOR_DEVICE"
  51
  52 # Maximum transmission unit.
  53 MTU=1492
  54 HOOK_SETTINGS="${HOOK_SETTINGS} MTU"
  55
  56 # User credentials.
  57 USERNAME=
  58 PASSWORD=
  59 HOOK_SETTINGS="${HOOK_SETTINGS} USERNAME PASSWORD"
  60
  61 # PIN code.
  62 PIN=
  63 HOOK_SETTINGS="${HOOK_SETTINGS} PIN"
  64
  65 # Phone number.
  66 PHONE_NUMBER=
  67 HOOK_SETTINGS="${HOOK_SETTINGS} PHONE_NUMBER"
  68
  69 # IMSI
  70 IMSI=
  71 HOOK_SETTINGS="${HOOK_SETTINGS} IMSI"
  72
  73 function hook_check_settings() {
  74         assert isset DEVICE
  75         assert isset PHONE_NUMBER
  76
  77         # Make sure the PIN code is an integer, when set.
  78         if isset PIN; then
  79                 assert isinteger PIN
  80                 assert [ ${#PIN} -ge 4 ]
  81                 assert [ ${#PIN} -le 8 ]
  82         fi
  83
  84         assert isoneof BAUDRATE ${SERIAL_BAUDRATES}
  85
  86         isset AUTH && assert isoneof AUTH ${MODEM_ALLOWED_AUTH_METHODS}
  87 }
  88
  89 function hook_parse_cmdline() {
  90         local value
  91
  92         while [ $# -gt 0 ]; do
  93                 case "${1}" in
  94                         --apn=*)
  95                                 APN=$(cli_get_val ${1})
  96                                 ;;
  97                         --auth=*)
  98                                 AUTH=$(cli_get_val ${1})
  99                                 ;;
 100                         --baudrate=*)
 101                                 BAUDRATE=$(cli_get_val ${1})
 102                                 assert isoneif "${BAUDRATE}" ${SERIAL_BAUDRATES}
 103                                 ;;
 104                         --device=*)
 105                                 DEVICE=$(cli_get_val ${1})
 106                                 ;;
 107                         --imsi=*)
 108                                 IMSI="$(cli_get_val "${1}")"
 109                                 ;;
 110                         --monitor-device=*)
 111                                 MONITOR_DEVICE=$(cli_get_val ${1})
 112                                 ;;
 113                         --mtu=*)
 114                                 MTU=$(cli_get_val ${1})
 115                                 assert isinteger ${MTU}
 116                                 ;;
 117                         --password=*)
 118                                 PASSWORD=$(cli_get_val ${1})
 119                                 ;;
 120                         --phone-number=*)
 121                                 PHONE_NUMBER=$(cli_get_val ${1})
 122                                 ;;
 123                         --pin=*)
 124                                 PIN=$(cli_get_val ${1})
 125                                 ;;
 126                         --username=*)
 127                                 USERNAME=$(cli_get_val ${1})
 128                                 ;;
 129                         *)
 130                                 echo "Unknown argument: ${1}" >&2
 131                                 exit ${EXIT_ERROR}
 132                                 ;;
 133                 esac
 134                 shift
 135         done
 136 }
 137
 138 function hook_up() {
 139         local zone=${1}
 140         assert isset zone
 141
 142         # Load configuration file.
 143         zone_settings_read "${zone}"
 144
 145         # If we have got a PIN, we try to unlock the device first.
 146         if isset PIN; then
 147                 if ! modem_sim_auto_unlock "${DEVICE}" "${PIN}"; then
 148                         # Reset the PIN setting.
 149                         PIN=""
 150                         zone_settings_write "${zone}"
 151                         error "Could not unlock the SIM card. Removing PIN from settings."
 152                 fi
 153
 154         # For mobile devices, check if a PIN is required although none is set.
 155         elif modem_is_mobile ${DEVICE} && modem_sim_locked ${DEVICE}; then
 156                 error "The SIM card is locked. Please configure the PIN code."
 157                 exit ${EXIT_ERROR}
 158         fi
 159
 160         # Start the PPP daemon.
 161         pppd_start ${zone}
 162
 163         exit ${EXIT_OK}
 164 }
 165
 166 function hook_down() {
 167         local zone=${1}
 168         assert isset zone
 169
 170         # Stop the PPP daemon.
 171         pppd_stop ${zone}
 172
 173         exit ${EXIT_OK}
 174 }
 175
 176 function hook_status() {
 177         local zone=${1}
 178         assert isset zone
 179
 180         cli_device_headline ${zone}
 181
 182         zone_settings_read "${zone}"
 183
 184         cli_headline 2 "Configuration"
 185         cli_print_fmt1 2 "Username" "${USERNAME}"
 186         cli_print_fmt1 2 "Password" "<hidden>"
 187         cli_space
 188
 189         cli_headline 2 "Device settings"
 190         cli_print_fmt1 2 "Device" "${DEVICE}"
 191         if isset MONITOR_DEVICE; then
 192                 cli_print_fmt1 2 "Monitor device" "${MONITOR_DEVICE}"
 193         fi
 194         cli_print_fmt1 2 "Baudrate" "${BAUDRATE}"
 195         cli_print_fmt1 2 "MTU/MRU" "${MTU}"
 196         cli_space
 197
 198         # Exit if zone is down
 199         if ! zone_is_up ${zone}; then
 200                 echo # Empty line
 201                 exit ${EXIT_ERROR}
 202         fi
 203
 204         cli_headline 2 "Carrier network"
 205
 206         # If the device and the monitor device are both locked,
 207         # we cannot show any carrier information.
 208         local device dev
 209         for dev in ${DEVICE} ${MONITOR_DEVICE}; do
 210                 if ! serial_exists ${dev}; then
 211                         continue
 212                 fi
 213                 if serial_is_locked ${dev}; then
 214                         continue
 215                 fi
 216
 217                 device=${dev}
 218         done
 219
 220         if isset device; then
 221                 cli_print_fmt1 2 "Operator" \
 222                         "$(modem_get_network_operator ${device})"
 223                 cli_print_fmt1 2 "SIM IMSI" \
 224                         "$(modem_get_sim_imsi ${device})"
 225                 cli_print_fmt1 2 "Mode" \
 226                         "$(modem_get_network_mode ${device})"
 227                 cli_print_fmt1 2 "Signal strength" \
 228                         "$(modem_get_signal_quality ${device}) dBm"
 229                 local ber=$(modem_get_bit_error_rate ${device})
 230                 isset ber || ber="unknown"
 231                 cli_print_fmt1 2 "Bit error rate" "${ber}"
 232         else
 233                 cli_print 2 "Device is locked."
 234         fi
 235         cli_space
 236
 237         # XXX display time since connection started
 238
 239         cli_headline 2 "Point-to-Point-over-Ethernet protocol"
 240         local proto
 241         for proto in ${IP_SUPPORTED_PROTOCOLS}; do
 242                 routing_db_exists ${zone} ${proto} || continue
 243
 244                 local headline
 245                 case "${proto}" in
 246                         ipv6)
 247                                 headline="Internet Protocol Version 6"
 248                                 ;;
 249                         ipv4)
 250                                 headline="Internet Protocol Version 4"
 251                                 ;;
 252                         *)
 253                                 headline="Unkown protocol"
 254                                 ;;
 255                 esac
 256                 cli_headline 3 "${headline}"
 257
 258                 cli_print_fmt1 3 "IP address"  "$(routing_db_get ${zone} ${proto} local-ip-address)"
 259                 cli_print_fmt1 3 "Gateway"     "$(routing_db_get ${zone} ${proto} remote-ip-address)"
 260                 cli_print_fmt1 3 "DNS servers" "$(routing_db_get ${zone} ${proto} dns)"
 261                 cli_space
 262         done
 263
 264         exit ${EXIT_OK}
 265 }
 266
 267 function hook_ppp_write_config() {
 268         local zone=${1}
 269         assert isset zone
 270
 271         local file=${2}
 272         assert isset file
 273
 274         # Read in the configuration files.
 275         zone_settings_read "${zone}"
 276
 277         pppd_write_config ${file} \
 278                 --interface="${zone}" \
 279                 --username="${USERNAME}" \
 280                 --password="${PASSWORD}" \
 281                 --mtu="${MTU}" \
 282                 --auth="${AUTH}" \
 283                 \
 284                 --serial="true" \
 285                 --serial-device="${DEVICE}" \
 286                 --baudrate="${BAUDRATE}" \
 287                 --connect-command="/usr/lib/network/dialer ${zone}"
 288
 289         exit ${EXIT_OK}
 290 }