Allow snap builds to use keepassxc-proxy

* Updated browser extension settings for snap usage * Support Snap 3.0 Changes * Add missing stage packages * Correct proxy communication with snaps
2025-04-03 20:47:37 +03:00 · 2019-03-19 08:31:05 -04:00 · 2019-03-19 08:31:05 -04:00 · 306bf0f292
commit 306bf0f292
parent fb5746e4f7
4 changed files with 197 additions and 8 deletions
--- a/utils/keepassxc-snap-helper.sh
+++ b/utils/keepassxc-snap-helper.sh
@ -0,0 +1,142 @@
+#!/usr/bin/env bash
+#
+# KeePassXC Browser Extension Native Messaging Installer Tool
+# Copyright (C) 2017 KeePassXC team <https://keepassxc.org/>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 or (at your option)
+# version 3 of the License.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+set -e
+
+DEBUG=false
+
+JSON_BASE=$(cat << EOF
+{
+    "name": "org.keepassxc.keepassxc_browser",
+    "description": "KeePassXC integration with native messaging support",
+    "path": "/snap/bin/keepassxc.proxy",
+    "type": "stdio",
+    __EXT__
+}
+EOF
+)
+
+JSON_FIREFOX=$(cat << EOF
+"allowed_extensions": [
+        "keepassxc-browser@keepassxc.org"
+    ]
+EOF
+)
+
+JSON_CHROME=$(cat << EOF
+"allowed_origins": [
+        "chrome-extension://iopaggbpplllidnfmcghoonnokmjoicf/",
+        "chrome-extension://oboonakemofpalcgghocfoadofidjkkk/"
+    ]
+EOF
+)
+
+JSON_OUT=""
+BASE_DIR="."
+INSTALL_DIR=""
+INSTALL_FILE="org.keepassxc.keepassxc_browser.json"
+
+buildJson() {
+    if [[ ! -z $1 ]]; then
+        # Insert Firefox data
+        JSON_OUT="${JSON_BASE/__EXT__/$JSON_FIREFOX}"
+    else
+        # Insert Chrome data
+        JSON_OUT="${JSON_BASE/__EXT__/$JSON_CHROME}"
+    fi
+}
+
+askBrowserSnap() {
+    if (whiptail --title "Snap Choice" --defaultno \
+            --yesno "Is this browser installed as a snap (usually NO)?" 8 60); then
+        # BASE_DIR="$1"
+        whiptail --title "Snap Choice" --msgbox "Sorry, browsers installed as snaps are not supported at this time" 8 50
+        exit 0
+    fi
+}
+
+setupFirefox() {
+    askBrowserSnap "./snap/firefox/common"
+    buildJson "firefox"
+    INSTALL_DIR="${BASE_DIR}/.mozilla/native-messaging-hosts"
+}
+
+setupChrome() {
+    buildJson
+    INSTALL_DIR="${BASE_DIR}/.config/google-chrome/NativeMessagingHosts"
+}
+
+setupChromium() {
+    askBrowserSnap "./snap/chromium/current"
+    buildJson
+    INSTALL_DIR="${BASE_DIR}/.config/chromium/NativeMessagingHosts"
+}
+
+setupVivaldi() {
+    buildJson
+    INSTALL_DIR="${BASE_DIR}/.config/vivaldi/NativeMessagingHosts"
+}
+
+setupTorBrowser() {
+    buildJson "firefox"
+    INSTALL_DIR="${BASE_DIR}/.tor-browser/app/Browser/TorBrowser/Data/Browser/.mozilla/native-messaging-hosts"
+}
+
+# --------------------------------
+# Start of script
+# --------------------------------
+
+BROWSER=$(whiptail \
+            --title "Browser Selection" \
+            --menu "Choose a browser to integrate with KeePassXC:" \
+            15 60 5 \
+            "1" "Firefox" \
+            "2" "Chrome" \
+            "3" "Chromium" \
+            "4" "Vivaldi" \
+            "5" "Tor Browser" \
+            3>&1 1>&2 2>&3)
+            
+clear
+
+exitstatus=$?
+if [ $exitstatus = 0 ]; then
+    # Configure settings for the chosen browser
+    case "$BROWSER" in
+        1) setupFirefox ;;
+        2) setupChrome ;;
+        3) setupChromium ;;
+        4) setupVivaldi ;;
+        5) setupTorBrowser ;;
+    esac
+
+    # Install the JSON file
+    cd ~
+    mkdir -p "$INSTALL_DIR"
+    echo "$JSON_OUT" > ${INSTALL_DIR}/${INSTALL_FILE}
+    
+    $DEBUG && echo "Installed to: ${INSTALL_DIR}/${INSTALL_FILE}"
+ 
+    whiptail \
+        --title "Installation Complete" \
+        --msgbox "You will need to restart your browser in order to connect to KeePassXC" \
+        8 50
+else
+    whiptail --title "Installation Canceled" --msgbox "No changes were made to your system" 8 50
+fi
+