unsafe-browser 10.1 KB
Newer Older
1
#!/bin/sh
2

3
4
set -e

Tails developers's avatar
Tails developers committed
5
CMD=$(basename ${0})
6
LOCK=/var/lock/${CMD}
Tails developers's avatar
Tails developers committed
7
8

. gettext.sh
9
TEXTDOMAIN="tails"
Tails developers's avatar
Tails developers committed
10
11
export TEXTDOMAIN

12
ROFS=/lib/live/mount/rootfs/filesystem.squashfs
13
14
15
CONF_DIR=/var/lib/unsafe-browser
COW=${CONF_DIR}/cow
CHROOT=${CONF_DIR}/chroot
16
CLEARNET_USER=clearnet
17
18
19

# Import tor_is_working()
. /usr/local/lib/tails-shell-library/tor.sh
20

21
22
23
# Import the TBB_INSTALL, TBB_EXT and TBB_PROFILE variables, and
# exec_firefox(), configure_xulrunner_app_locale() and
# guess_best_tor_browser_locale()
24
25
. /usr/local/lib/tails-shell-library/tor-browser.sh

26
27
28
29
30
31
32
33
WARNING_PAGE='/usr/share/doc/tails/website/misc/unsafe_browser_warning'
LANG_CODE="$(echo ${LANG} | head -c 2)"
if [ -r "${WARNING_PAGE}.${LANG_CODE}.html" ]; then
   START_PAGE="${WARNING_PAGE}.${LANG_CODE}.html"
else
   START_PAGE="${WARNING_PAGE}.en.html"
fi

34
35
36
37
if [ -e /var/lib/gdm3/tails.camouflage ]; then
    CAMOUFLAGE=yes
fi

38
cleanup () {
39
40
41
    # Break down the chroot and kill all of its processes
    local counter=0
    local ret=0
42
    while [ "${counter}" -le 10 ] && \
Tails developers's avatar
Tails developers committed
43
        pgrep -u ${CLEARNET_USER} 1>/dev/null 2>&1; do
44
        pkill -u ${CLEARNET_USER} 1>/dev/null 2>&1
45
        ret=${?}
46
        sleep 1
47
        counter=$((${counter}+1))
48
    done
49
    [ ${ret} -eq 0 ] || pkill -9 -u ${CLEARNET_USER} 1>/dev/null 2>&1
50
    for mnt in ${CHROOT}/dev ${CHROOT}/proc ${CHROOT} ${COW}; do
51
        counter=0
52
53
        while [ "${counter}" -le 10 ] && mountpoint -q ${mnt} 2>/dev/null; do
            umount ${mnt} 2>/dev/null
54
            sleep 1
55
            counter=$((${counter}+1))
56
57
        done
    done
58
    rmdir ${COW} ${CHROOT} 2>/dev/null
59
60
61
}

error () {
62
63
    local cli_text="${CMD}: `gettext \"error:\"` ${@}"
    local dialog_text="<b><big>`gettext \"Error\"`</big></b>
64

65
${@}"
66
    echo "${cli_text}" >&2
67
    sudo -u ${SUDO_USER} zenity --error --title "" --text "${dialog_text}"
68
69
70
    exit 1
}

71
72
verify_start () {
    # Make sure the user really wants to start the browser
73
    local dialog_msg="<b><big>`gettext \"Do you really want to launch the Unsafe Browser?\"`</big></b>
74

Tails developers's avatar
Tails developers committed
75
`gettext \"Network activity within the Unsafe Browser is <b>not anonymous</b>. Only use the Unsafe Browser if necessary, for example if you have to login or register to activate your Internet connection.\"`"
76
77
78
79
80
81
    local launch="`gettext \"_Launch\"`"
    local exit="`gettext \"_Exit\"`"
    # Since zenity can't set the default button to cancel, we switch the
    # labels and interpret the return value as its negation.
    if sudo -u ${SUDO_USER} zenity --question --title "" --ok-label "${exit}" \
       --cancel-label "${launch}" --text "${dialog_msg}"; then
82
83
84
        exit 0
    fi
}
85

86
87
88
show_start_notification () {
    local title="`gettext \"Starting the Unsafe Browser...\"`"
    local body="`gettext \"This may take a while, so please be patient.\"`"
89
    tails-notify-user "${title}" "${body}" 10000
90
91
}

92
93
94
95
setup_chroot () {
    # Setup a chroot on an aufs "fork" of the filesystem.
    # FIXME: When LXC matures to the point where it becomes a viable option
    # for creating isolated jails, the chroot can be used as its rootfs.
96
97
    echo "* Setting up chroot"

98
99
100
    trap cleanup INT
    trap cleanup EXIT

101
    mkdir -p ${COW} ${CHROOT} && \
102
103
104
    mount -t tmpfs tmpfs ${COW} && \
    mount -t aufs -o noatime,noxino,dirs=${COW}=rw:${ROFS}=rr+wh aufs ${CHROOT} && \
    mount -t proc proc ${CHROOT}/proc && \
Tails developers's avatar
Tails developers committed
105
106
    mount --bind /dev ${CHROOT}/dev || \
    error "`gettext \"Failed to setup chroot.\"`"
107
108
109

    # Workaround for todo/buggy_aufs_vs_unsafe-browser
    chmod -t ${COW}
110
111
}

112
113
set_chroot_browser_name () {
    NAME="${1}"
Tails developers's avatar
Tails developers committed
114
    LONG=$(echo ${LANG} | grep -o "^[a-zA-Z_]*")
115
    SHORT=${LONG%%_*}
116
    EXT_DIR=${CHROOT}/"${TBB_EXT}"
117
    BRANDING=branding/brand.dtd
118
119
    if [ -e "${EXT_DIR}/langpack-${LONG}@firefox.mozilla.org.xpi" ]; then
        PACK="${EXT_DIR}/langpack-${LONG}@firefox.mozilla.org.xpi"
120
        TOP=browser/chrome
121
        REST=${LONG}/locale
122
123
    elif [ -e "${EXT_DIR}/langpack-${SHORT}@firefox.mozilla.org.xpi" ]; then
        PACK="${EXT_DIR}/langpack-${SHORT}@firefox.mozilla.org.xpi"
124
        TOP=browser/chrome
125
        REST=${SHORT}/locale
126
    else
127
        PACK="${CHROOT}/${TBB_INSTALL}/browser/omni.ja"
128
129
        TOP=chrome
        REST=en-US/locale
130
131
    fi
    TMP=$(mktemp -d)
132
133
134
    # Non-zero exit code due to non-standard ZIP archive.
    # The following steps will fail soon if the extraction failed anyway.
    unzip -d "${TMP}" "${PACK}" || true
135
    sed -i "s/<"'!'"ENTITY\s\+brand\(Full\|Short\)Name.*$/<"'!'"ENTITY brand\1Name \"${NAME}\">/" "${TMP}/${TOP}/${REST}/${BRANDING}"
136
137
    rm "${PACK}"
    (cd $TMP ; 7z a -tzip "${PACK}" .)
138
139
140
141
    chmod a+r "${PACK}"
    rm -Rf "${TMP}"
}

142
configure_chroot () {
143
144
    echo "* Configuring chroot"

145
146
    # Set the chroot's DNS servers to those obtained through DHCP
    rm -f ${CHROOT}/etc/resolv.conf
147
    for NS in ${IP4_NAMESERVERS}; do
148
149
150
151
        echo "nameserver ${NS}" >> ${CHROOT}/etc/resolv.conf
    done
    chmod a+r ${CHROOT}/etc/resolv.conf

152
    # Remove all addons: some adds proxying, which we don't
153
    # want; some may change the fingerprint compared to a standard
154
    # Firefox install. Note: We cannot use apt-get since we don't ship its
155
156
157
    # lists (#6531). Too bad, APT supports globbing, while dkpg does not.
    dpkg -l 'xul-ext-*' | /bin/grep '^ii' | awk '{print $2}' | \
        xargs chroot ${CHROOT} dpkg --remove
158

159
    # Create a fresh browser profile for the clearnet user
160
161
162
163
    CLEARNET_PROFILE="${CHROOT}"/home/clearnet/.tor-browser/profile.default

    CLEARNET_EXT="${CLEARNET_PROFILE}"/extensions
    mkdir -p "${CLEARNET_EXT}"
164
    cp -Pr "${TBB_PROFILE}"/extensions/langpack-*.xpi "${CLEARNET_EXT}"
165
166
167
168
169

    CLEARNET_PREFS="${CLEARNET_PROFILE}"/preferences/prefs.js
    mkdir -p "$(dirname "${CLEARNET_PREFS}")"

    # Localization
170
171
    BEST_LOCALE="$(guess_best_tor_browser_locale)"
    configure_xulrunner_app_locale "${CLEARNET_PROFILE}" "${BEST_LOCALE}"
172

173
    # Disable proxying in the chroot
174
175
    echo 'pref("network.proxy.type", 0);' >> "${CLEARNET_PREFS}"
    echo 'pref("network.proxy.socks_remote_dns", false);' >>  "${CLEARNET_PREFS}"
176

177
178
179
180
    # Prevent File -> Print or CTRL+P from causing the browser to hang
    # for several minutes while trying to communicate with CUPS, since
    # access to port 631 isn't allowed through.
    echo 'pref("print.postscript.cups.enabled", false);' >> "${CLEARNET_PREFS}"
181
182
    # Hide "Get Addons" in Add-ons manager
    echo 'user_pref("extensions.getAddons.showPane", false);' >> "${CLEARNET_PREFS}"
183

184
185
186
    # Set the name (e.g. window title) of the browser
    set_chroot_browser_name "`gettext \"Unsafe Browser\"`"

187
188
    # Set start page to something that explains what's going on
    echo 'user_pref("browser.startup.homepage", "'${START_PAGE}'");' >> \
189
        "${CLEARNET_PREFS}"
190
191
192
193
194
195
196
197
198
199
200
201
202
    BROWSER_CHROME="${CLEARNET_PROFILE}/chrome/userChrome.css"
    mkdir -p "$(dirname "${BROWSER_CHROME}")"
    cat > ${BROWSER_CHROME} << EOF
/* Required, do not remove */
@namespace url("http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul");

/* Hide TorBrowser Health Report and its configuration option */
#appmenu_healthReport,
#dataChoicesTab,
#healthReport

{display: none !important}
EOF
203
204

    # Remove all bookmarks
205
    rm -f ${CHROOT}/"${TBB_PROFILE}"/bookmarks.html
206
207
    rm -f ${CLEARNET_PROFILE}/bookmarks.html
    rm -f ${CLEARNET_PROFILE}/places.sqlite
208
209

    chown -R clearnet:clearnet ${CHROOT}/home/clearnet/.tor-browser
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225

    # Set a scary theme (except if we're using Windows
    # camouflage). Note that the tails-activate-win8-theme script that
    # we may run below requires that the browser profile is writable
    # by the user running the script (i.e. clearnet).
    if [ -z "${CAMOUFLAGE}" ]; then
        cat >> "${CLEARNET_PREFS}" <<EOF
pref("lightweightThemes.isThemeSelected", true);
pref("lightweightThemes.usedThemes", "[{\"id\":\"1\",\"name\":\"Unsafe Browser\",\"headerURL\":\"file:///usr/share/pixmaps/red_dot.png\",\"footerURL\":\"file:///usr/share/pixmaps/red_dot.png\",\"textcolor\":\"#FFFFFF\",\"accentcolor\":\"#CC0000\",\"updateDate\":0,\"installDate\":0}]");
EOF
    else
        # The camouflage activation script requires a dbus server for
        # properly configuring GNOME, so we start one in the chroot
        chroot ${CHROOT} sudo -H -u clearnet sh -c 'eval `dbus-launch --auto-syntax`; tails-activate-win8-theme' || :
    fi

226
227
}

228
run_browser_in_chroot () {
229
    # Start the browser in the chroot
230
231
    echo "* Starting Unsafe Browser"

232
    sudo -u ${SUDO_USER} xhost +SI:localuser:${CLEARNET_USER} 2>/dev/null
233
234
235
236
    chroot ${CHROOT} sudo -u ${CLEARNET_USER} /bin/sh -c \
        '. /usr/local/lib/tails-shell-library/tor-browser.sh && \
         exec_firefox -DISPLAY=:0.0 \
                      -profile /home/clearnet/.tor-browser/profile.default'
237
    sudo -u ${SUDO_USER} xhost -SI:localuser:${CLEARNET_USER} 2>/dev/null
238
239
}

240
241
242
show_shutdown_notification () {
    local title="`gettext \"Shutting down the Unsafe Browser...\"`"
    local body="`gettext \"This may take a while, and you may not restart the Unsafe Browser until it is properly shut down.\"`"
243
    tails-notify-user "${title}" "${body}" 10000
244
245
}

246
247
248
249
250
maybe_restart_tor () {
    # Restart Tor if it's not working (a captive portal may have prevented
    # Tor from bootstrapping, and a restart is the fastest way to get
    # wheels turning)
    if ! tor_is_working; then
251
        echo "* Restarting Tor"
252
253
        restart-tor
        if ! service tor status >/dev/null; then
254
255
            error "`gettext \"Failed to restart Tor.\"`"
        fi
256
257
    fi
}
258

259
260
261
262
263
264
# Prevent multiple instances of the script.
exec 9>${LOCK}
if ! flock -x -n 9; then
    error "`gettext \"Another Unsafe Browser is currently running, or being cleaned up. Please retry in a while.\"`"
fi

265
# Get the DNS servers that was obtained from NetworkManager, if any...
266
267
268
269
270
271
272
273
NM_ENV=/var/lib/NetworkManager/env
if [ -r "${NM_ENV}" ]; then
    . ${NM_ENV}
fi
# ... otherwise fail.
# FIXME: Or would it make sense to fallback to Google's DNS or OpenDNS?
# Some stupid captive portals may allow DNS to any host, but chances are
# that only the portal's DNS would forward to the login page.
274
if [ -z "${IP4_NAMESERVERS}" ]; then
Tails developers's avatar
Tails developers committed
275
    error "`gettext \"No DNS server was obtained through DHCP or manually configured in NetworkManager.\"`"
276
277
fi

278
verify_start
279
show_start_notification
280
281
setup_chroot
configure_chroot
282
283
run_browser_in_chroot
show_shutdown_notification
284
maybe_restart_tor
285
286

exit 0