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=
  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 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         if isset AUTH; then
  87                 assert isoneof AUTH ${MODEM_ALLOWED_AUTH_METHODS}
  88         fi
  89 }
  90
  91 hook_parse_cmdline() {
  92         local value
  93
  94         while [ $# -gt 0 ]; do
  95                 case "${1}" in
  96                         --apn=*)
  97                                 APN=$(cli_get_val ${1})
  98                                 ;;
  99                         --auth=*)
 100                                 AUTH=$(cli_get_val ${1})
 101                                 ;;
 102                         --baudrate=*)
 103                                 BAUDRATE=$(cli_get_val ${1})
 104                                 assert isoneif "${BAUDRATE}" ${SERIAL_BAUDRATES}
 105                                 ;;
 106                         --device=*)
 107                                 DEVICE=$(cli_get_val ${1})
 108                                 ;;
 109                         --imsi=*)
 110                                 IMSI="$(cli_get_val "${1}")"
 111                                 ;;
 112                         --monitor-device=*)
 113                                 MONITOR_DEVICE=$(cli_get_val ${1})
 114                                 ;;
 115                         --mtu=*)
 116                                 MTU=$(cli_get_val ${1})
 117                                 assert isinteger ${MTU}
 118                                 ;;
 119                         --password=*)
 120                                 PASSWORD=$(cli_get_val ${1})
 121                                 ;;
 122                         --phone-number=*)
 123                                 PHONE_NUMBER=$(cli_get_val ${1})
 124                                 ;;
 125                         --pin=*)
 126                                 PIN=$(cli_get_val ${1})
 127                                 ;;
 128                         --username=*)
 129                                 USERNAME=$(cli_get_val ${1})
 130                                 ;;
 131                         *)
 132                                 echo "Unknown argument: ${1}" >&2
 133                                 exit ${EXIT_ERROR}
 134                                 ;;
 135                 esac
 136                 shift
 137         done
 138 }
 139
 140 hook_up() {
 141         local zone=${1}
 142         assert isset zone
 143
 144         # Load configuration file.
 145         zone_settings_read "${zone}"
 146
 147         # If we have got a PIN, we try to unlock the device first.
 148         if isset PIN; then
 149                 if ! modem_sim_auto_unlock "${DEVICE}" "${PIN}"; then
 150                         # Reset the PIN setting.
 151                         PIN=""
 152                         zone_settings_write "${zone}"
 153                         error "Could not unlock the SIM card. Removing PIN from settings."
 154                 fi
 155
 156         # For mobile devices, check if a PIN is required although none is set.
 157         elif modem_is_mobile ${DEVICE} && modem_sim_locked ${DEVICE}; then
 158                 error "The SIM card is locked. Please configure the PIN code."
 159                 exit ${EXIT_ERROR}
 160         fi
 161
 162         # Start the PPP daemon.
 163         pppd_start ${zone}
 164
 165         exit ${EXIT_OK}
 166 }
 167
 168 hook_down() {
 169         local zone=${1}
 170         assert isset zone
 171
 172         # Stop the PPP daemon.
 173         pppd_stop ${zone}
 174
 175         exit ${EXIT_OK}
 176 }
 177
 178 hook_status() {
 179         local zone=${1}
 180         assert isset zone
 181
 182         cli_device_headline ${zone}
 183
 184         zone_settings_read "${zone}"
 185
 186         cli_headline 2 "Configuration"
 187         cli_print_fmt1 2 "Username" "${USERNAME}"
 188         cli_print_fmt1 2 "Password" "<hidden>"
 189         cli_space
 190
 191         cli_headline 2 "Device settings"
 192         cli_print_fmt1 2 "Device" "${DEVICE}"
 193         if isset MONITOR_DEVICE; then
 194                 cli_print_fmt1 2 "Monitor device" "${MONITOR_DEVICE}"
 195         fi
 196         cli_print_fmt1 2 "Baudrate" "${BAUDRATE}"
 197         cli_print_fmt1 2 "MTU/MRU" "${MTU}"
 198         cli_space
 199
 200         cli_headline 2 "Carrier network"
 201
 202         # If the device and the monitor device are both locked,
 203         # we cannot show any carrier information.
 204         local device dev
 205         for dev in ${DEVICE} ${MONITOR_DEVICE}; do
 206                 if ! serial_exists ${dev}; then
 207                         continue
 208                 fi
 209
 210                 if serial_is_locked ${dev}; then
 211                         continue
 212                 fi
 213
 214                 device=${dev}
 215         done
 216
 217         if isset device && modem_is_mobile "${device}"; then
 218                 cli_print_fmt1 2 "Network Registration" \
 219                         "$(modem_get_network_registration ${device})"
 220                 cli_print_fmt1 2 "Operator" \
 221                         "$(modem_get_network_operator ${device})"
 222                 cli_print_fmt1 2 "SIM IMSI" \
 223                         "$(modem_get_sim_imsi ${device})"
 224                 cli_print_fmt1 2 "Mode" \
 225                         "$(modem_get_network_mode ${device})"
 226                 cli_print_fmt1 2 "Signal strength" \
 227                         "$(modem_get_signal_quality ${device}) dBm"
 228                 local ber=$(modem_get_bit_error_rate ${device})
 229                 isset ber || ber="unknown"
 230                 cli_print_fmt1 2 "Bit error rate" "${ber}"
 231         else
 232                 cli_print 2 "Device is locked."
 233         fi
 234         cli_space
 235
 236         # Exit if zone is down
 237         if ! zone_is_up ${zone}; then
 238                 echo # Empty line
 239                 exit ${EXIT_ERROR}
 240         fi
 241
 242         # XXX display time since connection started
 243
 244         cli_headline 2 "Point-to-Point-over-Ethernet protocol"
 245         local proto
 246         for proto in ${IP_SUPPORTED_PROTOCOLS}; do
 247                 db_exists "${zone}/${proto}" || continue
 248
 249                 local headline
 250                 case "${proto}" in
 251                         ipv6)
 252                                 headline="Internet Protocol Version 6"
 253                                 ;;
 254                         ipv4)
 255                                 headline="Internet Protocol Version 4"
 256                                 ;;
 257                         *)
 258                                 headline="Unkown protocol"
 259                                 ;;
 260                 esac
 261                 cli_headline 3 "${headline}"
 262
 263                 cli_print_fmt1 3 "IP address"  "$(db_get "${zone}/${proto}/local-ip-address")"
 264                 cli_print_fmt1 3 "Gateway"     "$(db_get "${zone}/${proto}/remote-ip-address")"
 265                 cli_print_fmt1 3 "DNS servers" "$(db_get "${zone}/${proto}/domain-name-servers")"
 266                 cli_space
 267         done
 268
 269         exit ${EXIT_OK}
 270 }
 271
 272 hook_ppp_write_config() {
 273         local zone=${1}
 274         assert isset zone
 275
 276         local file=${2}
 277         assert isset file
 278
 279         # Read in the configuration files.
 280         zone_settings_read "${zone}"
 281
 282         pppd_write_config ${file} \
 283                 --interface="${zone}" \
 284                 --username="${USERNAME}" \
 285                 --password="${PASSWORD}" \
 286                 --mtu="${MTU}" \
 287                 --auth="${AUTH}" \
 288                 \
 289                 --serial="true" \
 290                 --serial-device="${DEVICE}" \
 291                 --baudrate="${BAUDRATE}" \
 292                 --connect-command="/usr/lib/network/dialer ${zone}"
 293
 294         exit ${EXIT_OK}
 295 }