2 ###############################################################################
4 # IPFire.org - A linux based firewall #
5 # Copyright (C) 2010 Michael Tremer & Christian Schmidt #
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. #
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. #
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/>. #
20 ###############################################################################
22 .
/lib
/network
/header-zone
24 # Modems support all authentication methods, that pppd does support.
25 MODEM_ALLOWED_AUTH_METHODS
="${PPP_ALLOWED_AUTH_METHODS}"
31 HOOK_SETTINGS
="${HOOK_SETTINGS} APN"
33 # Sets the authentication algortihm that must be used.
35 HOOK_SETTINGS
="${HOOK_SETTINGS} AUTH"
39 HOOK_SETTINGS
="${HOOK_SETTINGS} BAUDRATE"
41 # The device name of the serial device.
42 # XXX how can we make sure that this does not change all the time?
44 HOOK_SETTINGS
="${HOOK_SETTINGS} DEVICE"
47 # Send AT commands to this device, when the primary device is
50 HOOK_SETTINGS
="${HOOK_SETTINGS} MONITOR_DEVICE"
52 # Maximum transmission unit.
54 HOOK_SETTINGS
="${HOOK_SETTINGS} MTU"
59 HOOK_SETTINGS
="${HOOK_SETTINGS} USERNAME PASSWORD"
63 HOOK_SETTINGS
="${HOOK_SETTINGS} PIN"
67 HOOK_SETTINGS
="${HOOK_SETTINGS} PHONE_NUMBER"
71 HOOK_SETTINGS
="${HOOK_SETTINGS} IMSI"
73 function hook_check_settings
() {
75 assert isset PHONE_NUMBER
77 # Make sure the PIN code is an integer, when set.
80 assert
[ ${#PIN} -ge 4 ]
81 assert
[ ${#PIN} -le 8 ]
84 assert isoneof BAUDRATE
${SERIAL_BAUDRATES}
86 isset AUTH
&& assert isoneof AUTH
${MODEM_ALLOWED_AUTH_METHODS}
89 function hook_parse_cmdline
() {
92 while [ $# -gt 0 ]; do
95 APN
=$
(cli_get_val
${1})
98 AUTH
=$
(cli_get_val
${1})
101 BAUDRATE
=$
(cli_get_val
${1})
102 assert isoneif
"${BAUDRATE}" ${SERIAL_BAUDRATES}
105 DEVICE
=$
(cli_get_val
${1})
108 IMSI
="$(cli_get_val "${1}")"
111 MONITOR_DEVICE
=$
(cli_get_val
${1})
114 MTU
=$
(cli_get_val
${1})
115 assert isinteger
${MTU}
118 PASSWORD
=$
(cli_get_val
${1})
121 PHONE_NUMBER
=$
(cli_get_val
${1})
124 PIN
=$
(cli_get_val
${1})
127 USERNAME
=$
(cli_get_val
${1})
130 echo "Unknown argument: ${1}" >&2
142 # Load configuration file.
143 zone_settings_read
"${zone}"
145 # If we have got a PIN, we try to unlock the device first.
147 if ! modem_sim_auto_unlock
"${DEVICE}" "${PIN}"; then
148 # Reset the PIN setting.
150 zone_settings_write
"${zone}"
151 error
"Could not unlock the SIM card. Removing PIN from settings."
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."
160 # Start the PPP daemon.
166 function hook_down
() {
170 # Stop the PPP daemon.
176 function hook_status
() {
180 cli_device_headline
${zone}
182 zone_settings_read
"${zone}"
184 cli_headline
2 "Configuration"
185 cli_print_fmt1
2 "Username" "${USERNAME}"
186 cli_print_fmt1
2 "Password" "<hidden>"
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}"
194 cli_print_fmt1
2 "Baudrate" "${BAUDRATE}"
195 cli_print_fmt1
2 "MTU/MRU" "${MTU}"
198 # Exit if zone is down
199 if ! zone_is_up
${zone}; then
204 cli_headline
2 "Carrier network"
206 # If the device and the monitor device are both locked,
207 # we cannot show any carrier information.
209 for dev
in ${DEVICE} ${MONITOR_DEVICE}; do
210 if ! serial_exists
${dev}; then
213 if serial_is_locked
${dev}; then
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}"
233 cli_print
2 "Device is locked."
237 # XXX display time since connection started
239 cli_headline
2 "Point-to-Point-over-Ethernet protocol"
241 for proto
in ${IP_SUPPORTED_PROTOCOLS}; do
242 routing_db_exists
${zone} ${proto} ||
continue
247 headline
="Internet Protocol Version 6"
250 headline
="Internet Protocol Version 4"
253 headline
="Unkown protocol"
256 cli_headline
3 "${headline}"
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)"
267 function hook_ppp_write_config
() {
274 # Read in the configuration files.
275 zone_settings_read
"${zone}"
277 pppd_write_config
${file} \
278 --interface="${zone}" \
279 --username="${USERNAME}" \
280 --password="${PASSWORD}" \
285 --serial-device="${DEVICE}" \
286 --baudrate="${BAUDRATE}" \
287 --connect-command="/usr/lib/network/dialer ${zone}"