Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mooltipass/moolticute

Mooltipass crossplatform daemon/tools
https://github.com/mooltipass/moolticute

crossplatform daemon libusb mooltipass password-manager

Last synced: 5 days ago
JSON representation

Mooltipass crossplatform daemon/tools

Awesome Lists containing this project

README 

        
Moolticute

==========



[![License](https://img.shields.io/badge/license-GPLv3%2B-blue.svg)](http://www.gnu.org/licenses/gpl.html)



[![Build Status](https://travis-ci.org/mooltipass/moolticute.svg?branch=master)](https://travis-ci.org/mooltipass/moolticute)



This project aims to be an easy to use companion to your [Mooltipass](http://www.themooltipass.com) device and extend

the power of the device to more platform/tools.

With it you can manage your Mooltipass with a cross-platform app, as well as provide a daemon service that

handles all USB communication with the device.



This tool comes with a daemon that runs in background, and a user interface app to control your Mooltipass.

Other clients can also connect and talk to the daemon (it uses a websocket connection and simple JSON messages).



It is completely cross platform, and runs on Linux (using native hidraw API), OS X (native IOKit API), and Windows (native HID API).



### Downloads

Packages are build and available here: https://github.com/mooltipass/moolticute/releases  



### Submodules

When downloading this repository, make sure to download the submodules:

```bash

git clone https://github.com/mooltipass/moolticute.git --recurse-submodules

```



### Dependencies



##### Windows, Linux, OSX

 - Requires Qt 5.6 or higher.

 - These Qt5 modules are required:

   - qt-core

   - qt-gui

   - qt-widgets

   - qt-network

   - qt-websockets



##### Linux

 - Requires the qt-dbus module

 - Requires to install [udev rule](https://github.com/mooltipass/mooltipass-udev) for it

   - Note: For Linux systems without systemd please refer to [dedicated section](#non-systemd-linux)



Moolticute comes in two part on Linux:

  - A daemon that runs in background named moolticuted that proxy

    command between device and GUI

  - A GUI application for user to interact with the device using moolticuted



One way of using Moolticute is allowing systemd to manage the daemon

as a system service and your desktop environment execing the GUI when

you need it. In such setup it is best to disable the option found in

the GUI called "Start Moolticute with the computer"

The default build recipe will drop a systemd system unit

`moolticuted.service`, after build and installation:



```bash

systemctl daemon-reload

systemctl enable --now moolticuted.service

```



At this point the Moolticute daemon should be running. As the build

also drop an `moolticute.desktop` you should be able to launch the GUI

using your environment application launcher and searching for "moolticute".



##### Ubuntu 16.04

```bash

sudo apt install libqt5websockets5-dev qt-sdk qt5-qmake qt5-default libudev-dev

curl https://raw.githubusercontent.com/mooltipass/mooltipass-udev/master/udev/69-mooltipass.rules | sudo tee /etc/udev/rules.d/69-mooltipass.rules

sudo udevadm control --reload-rules

```



##### Arch Linux



There are packages in AUR both for udev rules and for the Moolticute:

  - [udev rules](https://aur.archlinux.org/packages/mooltipass-udev/)

  - [Moolticute](https://aur.archlinux.org/packages/moolticute/)



##### Void Linux



The udev rules are automatically updated as [this

issue](https://github.com/mooltipass/mooltipass-udev/pull/3) describes

```bash

sudo xbps-install -S qt5-websockets-devel qt5-devel qt5-gui qt5-network qt5-widgets qt5-qmake

curl https://raw.githubusercontent.com/mooltipass/mooltipass-udev/master/udev/69-mooltipass.rules | sudo tee /etc/udev/rules.d/69-mooltipass.rules && sudo sed -i 's/TAG+="uaccess"/GROUP="plugdev"/g' /etc/udev/rules.d/69-mooltipass.rules

sudo udevadm control --reload-rules

sudo udevadm trigger

```



##### Fedora Linux

```bash

sudo dnf install gcc-c++ qt5 qt5-qtwebsockets qt5-qtwebsockets-devel qt5-qttools-devel systemd-devel

curl https://raw.githubusercontent.com/mooltipass/mooltipass-udev/master/udev/69-mooltipass.rules | sudo tee /etc/udev/rules.d/69-mooltipass.rules

sudo udevadm control --reload-rules

```



##### Fedora Linux (33 and >)

```bash

sudo dnf install gcc-c++ qt5-qtbase qt5-qtwebsockets qt5-qtwebsockets-devel qt5-qttools-devel systemd-devel

curl https://raw.githubusercontent.com/mooltipass/mooltipass-udev/master/udev/69-mooltipass.rules | sudo tee /etc/udev/rules.d/69-mooltipass.rules

sudo udevadm control --reload-rules

```



##### NixOS

Udev rules are lifted from the package if [this](https://github.com/NixOS/nixpkgs/pull/154355) is merged, otherwise paste them in as `extraRules`.

```

environment.systemPackages = with pkgs; [

  ...

  moolticute

  ];

};



services.udev.packages = [ pkgs.moolticute.udev ]; # if linked PR is merged

services.udev.extraRules = '' # if not slip rules in manually

  

            '';

```



##### Alpine

First you'll need to download and install [QZXing](https://github.com/ftylitak/qzxing) first by doing `qmake`.

The advice in that repo suggests to add the header files to the `Moolticute.pro` however this dosen't work.

```

doas apk add qt5-qtmultimedia-dev qt5-qtsystems-dev qt5-qttools-dev qt5-qtx11extras-dev qt5-qtwayland-dev acpi alpine-conf eudev eudev-doc eudev-rule-generator eudev-openrc linux-firmware cpufreqd pciutils util-linux

doas rc-update add udev

doas rc-update add acpid

doas rc-update add cpufreqd

doas setup-devd udev

doas setup-devd dbus

doas setup-devd elogind

doas setup-devd polkit

curl https://raw.githubusercontent.com/mooltipass/mooltipass-udev/master/udev/69-mooltipass.rules | doas tee /etc/udev/rules.d/69-mooltipass.rules

doas udevadm control --reload-rules

```

Reboot, then make sure to add yourself to plugdev group, once done you may need to reboot again, check via `groups`.



##### Non systemd Linux

The main [udev rules](https://github.com/mooltipass/mooltipass-udev)

relies on integration between systemd, systemd-login and systemd-udevd

to automatically allow any user logged in to access mooltipass devices.

This will not work on Linux ecosystem without systemd, one

workaround is to change the `TAG+="uaccess"` to

`GROUP="plugdev"` and add your interactive user to this group.



Refer to [this

issue](https://github.com/mooltipass/mooltipass-udev/pull/3) for more information.



### How to build



For now, no binary releases are out yet. You will need to build the software by following the next step.



Two method can be used to build, by using QtCreator IDE, or from command line (typically on Linux). After the build succeeded, two executable are created:

 - moolticuted (the daemon process)

 - moolticute (the main GUI app)



##### Using Qt SDK



 - Download and install the Qt SDK from their [website](http://qt.io)

 - Start Qt-Creator

 - Open the main Moolticute.pro project file

    - Note for Windows users: make sure that you select a "kit" that uses the MinGW compiler.

      Moolticute currently won't compile successfully when using the Microsoft Visual C++ compiler.

 - Click on the "play" button to build and run



##### Command line



Qt needs to be installed correctly (see your Linux distribution for that)



```

mkdir build

cd build

qmake ../Moolticute.pro

make

```



Be sure to use the Qt5 qmake. You can check if you are using the correct qmake by using the command

```

➜  ~  qmake --version

QMake version 3.0

Using Qt version 5.5.1 in /usr/lib

```



On Gentoo, a wrapper is created for qmake, so this command should be used:

```

qmake -qt=5 ../Moolticute.pro

```



On Fedora, use this qmake command:

```

qmake-qt5 ../Moolticute.pro

```



### Licensing



Moolticute is free software: you can redistribute it and/or modify it under the terms of the GNU Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

For any question feel free to contact Mathieu Stephan through this repository.