Files
keepassxc-proxy-rust/README.md
T
Eberhard Beilharz 18cd2a109e Update readme
Add instructions for building a binary without dependencies.
2022-06-28 17:57:31 +02:00

54 lines
1.8 KiB
Markdown

# keepassxc-proxy-rust
Application that works as a proxy between Native Messaging browser extension and KeePassXC
This is still under development. Installing the proxy needs manual changes to JSON scripts installed for Native Messaging.
See [this page](https://developer.chrome.com/extensions/nativeMessaging) for further information.
keepassxc-proxy listens stdin from keepassxc-browser extension and transfers the data to Unix domain socket `XDG_RUNTIME_DIR` or `/tmp/org.keepassxc.KeePassXC.BrowserServer` which KeePassXC listens.
With Windows this is a named pipe under `org.keepassxc.KeePassXC.BrowserServer\<username>`.
## Building
The proxy can be built with:
```bash
cargo build --release
```
### Static library
To build a binary without dependencies (which is useful for running
inside of a flatpak), you'll have to install MUSL libc first:
```bash
rustup target add x86_64-unknown-linux-musl
```
Then build with
```bash
RUSTFLAGS='-C link-arg=-s' cargo build --release --target x86_64-unknown-linux-musl
```
(see [Stackoverflow](https://stackoverflow.com/a/59766875/487503))
## Copyright
```
Copyright (C) 2017-2021 Sami Vänttinen <sami.vanttinen@protonmail.com>
Copyright (C) 2017-2018 Andy Brandt <andy@brandt.tech>
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 3 of the License, or
(at your option) any later version.
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/>.
```