Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 85 additions & 12 deletions install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ else
PPA_URL="https://ppa.mysterium.network/mysteriumnetwork/node/ubuntu"
fi

# The official installer uses this single signing-key endpoint for stable,
# snapshot and testnet3 channels. The fingerprint is verified before use.
PPA_KEY_URL="https://ppa.mysterium.network/public-key"
PPA_KEY_FINGERPRINT="BC7F93152681BDE3356F4080A197201433627AB4"
APT_KEYRING_DIR="${APT_KEYRING_DIR:-/etc/apt/keyrings}"
APT_SOURCE_DIR="${APT_SOURCE_DIR:-/etc/apt/sources.list.d}"

get_os() {
local __resultvar=$1
local result
Expand Down Expand Up @@ -75,18 +82,15 @@ get_version_codename() {


install_ubuntu() {
apt update
# Configure the authenticated Mysterium source before the first refresh.
configure_mysterium_repository

# add-apt-repository may not be available in Ubuntu server out of the box
apt install -y software-properties-common
apt update

if [[ "$container" != "docker" ]]; then
apt install -y "linux-headers-$(uname -r)"
fi

# myst
add-apt-repository -y "$PPA"
apt update
apt install -y myst
}

Expand All @@ -96,9 +100,7 @@ install_debian() {
prepare_sources_list

# myst - set up key and repo before any apt update to avoid stale list issues
mkdir -p /etc/apt/keyrings
curl -fsSL https://ppa.mysterium.network/public-key | gpg --dearmor -o /etc/apt/keyrings/mysterium.gpg
echo "deb [signed-by=/etc/apt/keyrings/mysterium.gpg] $PPA_URL focal main" > /etc/apt/sources.list.d/mysterium.list
configure_mysterium_repository

if [[ "$container" != "docker" ]]; then
apt update
Expand All @@ -113,6 +115,76 @@ install_debian() {
apt install -y wireguard myst
}

configure_mysterium_repository() {
local key_temp keyring_temp key_stage source_stage fingerprint suite
key_temp=$(mktemp) || return 1
keyring_temp=$(mktemp) || { rm -f "$key_temp"; return 1; }
trap 'rm -f "${key_temp:-}" "${keyring_temp:-}" "${key_stage:-}" "${source_stage:-}"' RETURN

if ! curl -fsSL --proto '=https' --tlsv1.2 \
"$PPA_KEY_URL" -o "$key_temp"; then
echo "Failed to download the official Mysterium signing key" >&2
return 1
fi
fingerprint=$(gpg --batch --with-colons --import-options show-only \
--import "$key_temp" | awk -F: -v expected="$PPA_KEY_FINGERPRINT" '
$1 == "pub" { primary++; in_primary=1; next }
$1 == "sub" { in_primary=0; next }
$1 == "sec" || $1 == "ssb" { secret++ }
$1 == "fpr" && in_primary && $10 == expected { matched++; in_primary=0 }
END { if (primary != 1 || secret != 0 || matched != 1) exit 1; print expected }
') || {
echo "Failed to inspect the Mysterium signing key" >&2
return 1
}
if [[ "$fingerprint" != "$PPA_KEY_FINGERPRINT" ]]; then
echo "Mysterium signing key fingerprint mismatch" >&2
return 1
fi
if ! gpg --batch --yes --dearmor -o "$keyring_temp" "$key_temp"; then
echo "Failed to convert the Mysterium signing key" >&2
return 1
fi
mkdir -p "$APT_KEYRING_DIR" || return 1
mkdir -p "$APT_SOURCE_DIR" || return 1
key_stage=$(mktemp "$APT_KEYRING_DIR/.mysterium.gpg.XXXXXX") || return 1
source_stage=$(mktemp "$APT_SOURCE_DIR/.mysterium.list.XXXXXX") || return 1
chmod 0644 "$key_stage" "$source_stage"
if ! install -o root -g root -m 0644 "$keyring_temp" "$key_stage"; then
echo "Failed to stage the Mysterium keyring" >&2
return 1
fi
suite=focal
if [[ "${DISTRO:-}" == ubuntu ]]; then
if [[ -z "${VERSION_CODENAME:-}" || ! "$VERSION_CODENAME" =~ ^[a-z][a-z0-9-]*$ ]]; then
echo "Cannot configure Mysterium repository: invalid Ubuntu VERSION_CODENAME" >&2
return 1
fi
suite="$VERSION_CODENAME"
fi
if [[ -e "$APT_SOURCE_DIR/mysterium.list" ]]; then
if [[ ! -f "$APT_SOURCE_DIR/mysterium.list" || ! -r "$APT_SOURCE_DIR/mysterium.list" ]]; then
echo "Cannot safely inspect the existing Mysterium repository definition" >&2
return 1
fi
# Remove only the three official Mysterium channels, including legacy
# Launchpad URLs. Other Launchpad repositories remain untouched.
awk '!/https?:\/\/(ppa\.mysterium\.network|ppa\.launchpad\.net)\/mysteriumnetwork\/node(-dev|-testnet3)?\/ubuntu/ { print }' \
"$APT_SOURCE_DIR/mysterium.list" > "$source_stage" || return 1
fi
printf 'deb [signed-by=%s/mysterium.gpg] %s %s main\n' "$APT_KEYRING_DIR" "$PPA_URL" "$suite" >> "$source_stage" || return 1
# These are separate atomic renames, not a multi-file transaction; a
# process failure between them can leave keyring and source out of sync.
mv -f "$key_stage" "$APT_KEYRING_DIR/mysterium.gpg" || {
echo "Failed to activate the Mysterium keyring; repository was not changed" >&2
return 1
}
mv -f "$source_stage" "$APT_SOURCE_DIR/mysterium.list" || {
echo "Failed to activate the Mysterium repository definition; keyring was updated, retry is required" >&2
return 1
}
}

prepare_sources_list() {
if [[ "$VERSION_CODENAME" == "buster" ]]; then
echo "deb http://deb.debian.org/debian ${VERSION_CODENAME}-backports main" > /etc/apt/sources.list.d/backports.list
Expand All @@ -124,7 +196,7 @@ prepare_sources_list() {
fi
}

install() {
install_node() {
case "$DISTRO" in
ubuntu)
install_ubuntu
Expand All @@ -134,7 +206,7 @@ install() {
esac
}


if [[ "${MYSTERIUM_INSTALLER_LIBRARY:-0}" != "1" ]]; then
echo "### Detecting platform"
get_os OS
get_linux_distribution DISTRO
Expand All @@ -147,7 +219,8 @@ Version codename: $VERSION_CODENAME"
echo "### Detecting platform - done"

echo "### Installing myst & dependencies"
install
install_node
echo "### Installing myst & dependencies - done"

echo "### Installation complete!"
fi
103 changes: 103 additions & 0 deletions tests/test_install.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
#!/usr/bin/env bash
set -euo pipefail
root=$(mktemp -d); trap 'rm -rf "$root"' EXIT
mock="$root/mock-bin"; mkdir -p "$mock"
cat >"$mock/curl" <<'EOF'
#!/usr/bin/env bash
set -e
[[ "${MOCK_CURL_FAIL:-0}" == 1 ]] && exit 1
out=""; while (($#)); do [[ "$1" == "-o" ]] && { out=$2; shift 2; continue; }; shift; done
printf 'mock-public-key\n' >"$out"
EOF
cat >"$mock/gpg" <<'EOF'
#!/usr/bin/env bash
set -e
if [[ "$*" == *"--import "* ]]; then
case "${MOCK_GPG_MODE:-valid}" in
valid) printf 'pub:::::::::\nfpr:::::::::BC7F93152681BDE3356F4080A197201433627AB4:\n' ;;
wrong) printf 'pub:::::::::\nfpr:::::::::AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA:\n' ;;
corrupt|partial) printf 'pub:::::::::\nfpr:::::::::BC7F93152681BDE3356F4080A197201433627AB4:\n'; exit 1 ;;
private) printf 'sec:::::::::\nssb:::::::::\n' ;;
extra) printf 'pub:::::::::\nfpr:::::::::BC7F93152681BDE3356F4080A197201433627AB4:\npub:::::::::\nfpr:::::::::AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA:\n' ;;
*) exit 1;;
esac
else
out=""; while (($#)); do [[ "$1" == "-o" ]] && { out=$2; shift 2; continue; }; shift; done
printf 'dearmored-key\n' >"$out"
fi
EOF
cat >"$mock/install" <<'EOF'
#!/usr/bin/env bash
set -e
[[ "${MOCK_INSTALL_FAIL:-0}" == 1 ]] && exit 1
while (($# > 2)); do shift; done
cp "$1" "$2"; chmod 0644 "$2"
EOF
cat >"$mock/mv" <<'EOF'
#!/usr/bin/env bash
set -e
f=${MOCK_MV_COUNT_FILE:?}; n=0; [[ -f "$f" ]] && n=$(<"$f"); n=$((n+1)); printf '%s\n' "$n" >"$f"
[[ "${MOCK_MV_FAIL_ON:-0}" == "$n" ]] && exit 1
exec /bin/mv "$@"
EOF
cat >"$mock/apt" <<'EOF'
#!/usr/bin/env bash
printf '%s\n' "$*" >>"${MOCK_APT_LOG:?}"; exit 1
EOF
chmod +x "$mock"/*
setup() {
case_dir="$root/$1"; mkdir -p "$case_dir/keyrings" "$case_dir/sources"
export PATH="$mock:$PATH" APT_KEYRING_DIR="$case_dir/keyrings" APT_SOURCE_DIR="$case_dir/sources" MYSTERIUM_INSTALLER_LIBRARY=1
unset DISTRO VERSION_CODENAME
export MOCK_MV_COUNT_FILE="$case_dir/mv-count" MOCK_APT_LOG="$case_dir/apt.log"
export MOCK_CURL_FAIL=0 MOCK_GPG_MODE=valid MOCK_INSTALL_FAIL=0 MOCK_MV_FAIL_ON=0; : >"$MOCK_APT_LOG"
}
run_case() {
setup "$1"; case "$2" in snapshot) SNAPSHOT=true NETWORK=;; testnet3) SNAPSHOT= NETWORK=testnet3;; *) SNAPSHOT= NETWORK=;; esac; export SNAPSHOT NETWORK
source "$PWD/install.sh"; configure_mysterium_repository
[[ -s "$APT_KEYRING_DIR/mysterium.gpg" ]]
grep -Fq "signed-by=$APT_KEYRING_DIR/mysterium.gpg" "$APT_SOURCE_DIR/mysterium.list"
case "$2" in snapshot) grep -Fq node-dev/ubuntu "$APT_SOURCE_DIR/mysterium.list";; testnet3) grep -Fq node-testnet3/ubuntu "$APT_SOURCE_DIR/mysterium.list";; *) grep -Fq mysteriumnetwork/node/ubuntu "$APT_SOURCE_DIR/mysterium.list";; esac
}
run_case stable-valid stable; run_case snapshot-valid snapshot; run_case testnet3-valid testnet3
suite_case() {
setup "suite-$1"; DISTRO="$2" VERSION_CODENAME="$3" SNAPSHOT= NETWORK=; export DISTRO VERSION_CODENAME SNAPSHOT NETWORK
source "$PWD/install.sh"; configure_mysterium_repository
grep -Fq " $4 main" "$APT_SOURCE_DIR/mysterium.list"
}
suite_case ubuntu-jammy ubuntu jammy jammy
suite_case ubuntu-noble ubuntu noble noble
suite_case debian-bookworm debian bookworm focal
suite_case raspbian-bullseye raspbian bullseye focal
setup ubuntu-empty; DISTRO=ubuntu VERSION_CODENAME= SNAPSHOT= NETWORK=; export DISTRO VERSION_CODENAME SNAPSHOT NETWORK; source "$PWD/install.sh"; if configure_mysterium_repository; then exit 1; fi
setup ubuntu-invalid; DISTRO=ubuntu VERSION_CODENAME='not valid' SNAPSHOT= NETWORK=; export DISTRO VERSION_CODENAME SNAPSHOT NETWORK; source "$PWD/install.sh"; if configure_mysterium_repository; then exit 1; fi
for mode in wrong corrupt partial private extra; do
setup "reject-$mode"; export MOCK_GPG_MODE=$mode; source "$PWD/install.sh"
if configure_mysterium_repository; then exit 1; fi
[[ ! -e "$APT_KEYRING_DIR/mysterium.gpg" && ! -e "$APT_SOURCE_DIR/mysterium.list" ]]
done
setup curl-failure; export MOCK_CURL_FAIL=1; source "$PWD/install.sh"; if configure_mysterium_repository; then exit 1; fi
setup install-failure; export MOCK_INSTALL_FAIL=1; source "$PWD/install.sh"; if configure_mysterium_repository; then exit 1; fi
setup first-mv-failure; export MOCK_MV_FAIL_ON=1; source "$PWD/install.sh"; if configure_mysterium_repository; then exit 1; fi
setup second-mv-failure; export MOCK_MV_FAIL_ON=2; source "$PWD/install.sh"; if configure_mysterium_repository; then exit 1; fi
[[ -s "$APT_KEYRING_DIR/mysterium.gpg" && ! -e "$APT_SOURCE_DIR/mysterium.list" ]]
setup foreign-source; printf 'deb https://example.invalid/debian stable main\n' >"$APT_SOURCE_DIR/foreign.list"; source "$PWD/install.sh"; configure_mysterium_repository; grep -Fxq 'deb https://example.invalid/debian stable main' "$APT_SOURCE_DIR/foreign.list"
setup mixed-source; printf 'deb https://example.invalid/debian stable main\ndeb http://ppa.launchpad.net/mysteriumnetwork/node/ubuntu focal main\n' >"$APT_SOURCE_DIR/mysterium.list"; source "$PWD/install.sh"; configure_mysterium_repository; grep -Fxq 'deb https://example.invalid/debian stable main' "$APT_SOURCE_DIR/mysterium.list"; ! grep -Fq 'ppa.launchpad.net' "$APT_SOURCE_DIR/mysterium.list"
channel_switch() {
setup "switch-$1-$2"
printf '%s\n' "$3" >"$APT_SOURCE_DIR/mysterium.list"
case "$2" in snapshot) SNAPSHOT=true NETWORK=;; testnet3) SNAPSHOT= NETWORK=testnet3;; *) SNAPSHOT= NETWORK=;; esac; export SNAPSHOT NETWORK
source "$PWD/install.sh"; configure_mysterium_repository
[[ "$(grep -Eic 'https?://(ppa\.mysterium\.network|ppa\.launchpad\.net)/mysteriumnetwork/node(-dev|-testnet3)?/ubuntu' "$APT_SOURCE_DIR/mysterium.list")" == 1 ]]
grep -Fq "signed-by=$APT_KEYRING_DIR/mysterium.gpg" "$APT_SOURCE_DIR/mysterium.list"
case "$2" in snapshot) grep -Fq node-dev/ubuntu "$APT_SOURCE_DIR/mysterium.list";; testnet3) grep -Fq node-testnet3/ubuntu "$APT_SOURCE_DIR/mysterium.list";; *) grep -Fq 'mysteriumnetwork/node/ubuntu' "$APT_SOURCE_DIR/mysterium.list";; esac
}
channel_switch stable snapshot 'deb https://ppa.mysterium.network/mysteriumnetwork/node/ubuntu focal main'
channel_switch snapshot testnet3 'deb https://ppa.mysterium.network/mysteriumnetwork/node-dev/ubuntu focal main'
channel_switch testnet3 stable 'deb https://ppa.mysterium.network/mysteriumnetwork/node-testnet3/ubuntu focal main'
setup all-channels; printf '%s\n%s\n%s\n' 'deb https://ppa.mysterium.network/mysteriumnetwork/node/ubuntu focal main' 'deb http://ppa.launchpad.net/mysteriumnetwork/node-dev/ubuntu focal main' 'deb https://ppa.mysterium.network/mysteriumnetwork/node-testnet3/ubuntu focal main' >"$APT_SOURCE_DIR/mysterium.list"; SNAPSHOT=true NETWORK=; export SNAPSHOT NETWORK; source "$PWD/install.sh"; configure_mysterium_repository; [[ "$(grep -Eic 'https?://(ppa\.mysterium\.network|ppa\.launchpad\.net)/mysteriumnetwork/node(-dev|-testnet3)?/ubuntu' "$APT_SOURCE_DIR/mysterium.list")" == 1 ]]; grep -Fq node-dev/ubuntu "$APT_SOURCE_DIR/mysterium.list"
setup foreign-launchpad; printf '%s\n%s\n' 'deb https://ppa.launchpad.net/other/project/ubuntu focal main' 'deb https://ppa.mysterium.network/mysteriumnetwork/node/ubuntu focal main' >"$APT_SOURCE_DIR/mysterium.list"; SNAPSHOT= NETWORK=testnet3; export SNAPSHOT NETWORK; source "$PWD/install.sh"; configure_mysterium_repository; grep -Fxq 'deb https://ppa.launchpad.net/other/project/ubuntu focal main' "$APT_SOURCE_DIR/mysterium.list"
setup no-existing-file; SNAPSHOT= NETWORK=; export SNAPSHOT NETWORK; source "$PWD/install.sh"; configure_mysterium_repository; grep -Fq 'mysteriumnetwork/node/ubuntu' "$APT_SOURCE_DIR/mysterium.list"
setup same-channel; printf 'deb https://ppa.mysterium.network/mysteriumnetwork/node/ubuntu focal main\n' >"$APT_SOURCE_DIR/mysterium.list"; SNAPSHOT= NETWORK=; export SNAPSHOT NETWORK; source "$PWD/install.sh"; configure_mysterium_repository; [[ "$(grep -Fc 'mysteriumnetwork/node/ubuntu' "$APT_SOURCE_DIR/mysterium.list")" == 1 ]]
setup no-apt-on-error; export MOCK_GPG_MODE=wrong; source "$PWD/install.sh"; if configure_mysterium_repository; then exit 1; fi; [[ ! -s "$MOCK_APT_LOG" ]]
echo 'install.sh isolated tests passed'
92 changes: 89 additions & 3 deletions updater/deb/updater.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import (
"net/http"
"os"
"os/exec"
"path/filepath"
"strings"
"time"
)
Expand Down Expand Up @@ -61,9 +62,10 @@ func secureEnvironment() []string {

// Updater validates and installs a newer myst package through APT.
type Updater struct {
config Config
runner commandRunner
client *http.Client
config Config
runner commandRunner
client *http.Client
sourcePatterns []string
}

// New constructs a production updater.
Expand Down Expand Up @@ -95,6 +97,15 @@ func (updater *Updater) Run(ctx context.Context) error {
commandContext, cancel := context.WithTimeout(ctx, updater.config.CommandTimeout)
defer cancel()

patterns := updater.sourcePatterns
if patterns == nil {
patterns = legacyRepositoryPatterns
}
if path, legacyURL, found, err := legacyRepositorySourceDetails(patterns); err != nil {
return fmt.Errorf("could not inspect APT repository sources: %w", err)
} else if found {
return fmt.Errorf("legacy Mysterium HTTP repository found in %s: %s; migrate it manually to HTTPS with signed-by before retrying", path, legacyURL)
}
if err := updater.aptGet(commandContext, "update"); err != nil {
return fmt.Errorf("could not refresh authenticated APT metadata: %w", err)
}
Expand Down Expand Up @@ -198,6 +209,81 @@ func (updater *Updater) Run(ctx context.Context) error {
return nil
}

const legacyRepositoryURL = "http://ppa.launchpad.net/mysteriumnetwork/node/ubuntu"

var legacyRepositoryURLs = []string{
legacyRepositoryURL,
"http://ppa.launchpad.net/mysteriumnetwork/node-dev/ubuntu",
"http://ppa.launchpad.net/mysteriumnetwork/node-testnet3/ubuntu",
}

var legacyRepositoryPatterns = []string{
"/etc/apt/sources.list",
"/etc/apt/sources.list.d/*.list",
"/etc/apt/sources.list.d/*.sources",
}

func legacyRepositorySourceFrom(patterns []string) (string, bool, error) {
path, _, found, err := legacyRepositorySourceDetails(patterns)
return path, found, err
}

func legacyRepositorySourceDetails(patterns []string) (string, string, bool, error) {
for _, pattern := range patterns {
paths, err := filepath.Glob(filepath.Clean(pattern))
if err != nil {
return "", "", false, err
}
for _, path := range paths {
data, err := os.ReadFile(path)
if err != nil {
return path, "", false, err
}
stanzas := make([]string, 0, 1)
current := make([]string, 0)
for _, line := range strings.Split(strings.ReplaceAll(string(data), "\r\n", "\n"), "\n") {
if strings.TrimSpace(line) == "" {
stanzas = append(stanzas, strings.Join(current, "\n"))
current = current[:0]
continue
}
current = append(current, line)
}
stanzas = append(stanzas, strings.Join(current, "\n"))
for _, stanza := range stanzas {
enabled := true
legacyURLFound := ""
for _, line := range strings.Split(stanza, "\n") {
trimmed := strings.TrimSpace(line)
if trimmed == "" || strings.HasPrefix(trimmed, "#") {
continue
}
if comment := strings.IndexByte(trimmed, '#'); comment >= 0 {
trimmed = strings.TrimSpace(trimmed[:comment])
if trimmed == "" {
continue
}
}
if strings.HasPrefix(strings.ToLower(trimmed), "enabled:") &&
strings.EqualFold(strings.TrimSpace(strings.TrimPrefix(strings.ToLower(trimmed), "enabled:")), "no") {
enabled = false
}
for _, legacyURL := range legacyRepositoryURLs {
if strings.Contains(trimmed, legacyURL) {
legacyURLFound = legacyURL
break
}
}
}
if enabled && legacyURLFound != "" {
return path, legacyURLFound, true, nil
}
}
}
}
return "", "", false, nil
}

func (updater *Updater) aptGet(ctx context.Context, arguments ...string) error {
args := append([]string{}, aptSecurityOptions...)
args = append(args, arguments...)
Expand Down
Loading