KTp/Setting up KAccounts

From KDE Community Wiki
< KTp

Setting up accounts-sso

Accounts-SSO is the framework we are using to store secrets (tokens, passwords) and for storing Accounts (small pieces of information containing a name, a provider, etc).



You still need to build and install ktp-accounts-kcm

First of all set up your paths, that allows to easily just copy-paste the rest from below. This is needed for the set-up only, not for the runtime. However, it uses D-BUS activation, so make sure the path you set for ACCOUNTS_PREFIX allows for D-BUS autostarting (ie. $ACCOUNTS_PREFIX/share/dbus-1/services is loaded by D-BUS).

export ACCOUNTS_PREFIX=your path here
export ACCOUNTS_LIBDIR=your lib dir here

An example:

export ACCOUNTS_PREFIX=/opt/kde
export ACCOUNTS_LIBDIR=/opt/kde/lib


This is a fairly simply yet powerful framework, it stores all information into a sqlite database and then propagates the modifications using dbus so all applications using libaccounts will be aware of the modifications.


The first thing to compile is libaccounts-glib, which is the code implementing all the Read/Write/Notification of Accounts:

    git clone https://gitlab.com/accounts-sso/libaccounts-glib.git
    cd libaccounts-glib
    HAVE_GCOV_FALSE='#' ./autogen.sh --prefix=$ACCOUNTS_PREFIX --enable-debug
    make install


This is the Qt bindings for libaccounts-glib, it uses qmake :/

    git clone https://gitlab.com/accounts-sso/libaccounts-qt.git
    cd libaccounts-qt
    make install

Note that at this very day libaccounts-qt qmake does **NOT** support compiling the library outside the source directory, this means that the command qmake must be executed within the root of libaccounts-qt and not for example in a build directory.


Single Sign On is the part of the framework responsable for storing and obtaining credentials. It stores the credentials in a secure way (in case of KDE within KWallet) and has a plugin system to do authentication in most common cases such oauth/2 or simple user and password.

An interface can be plugged into SSO, at this moment we are using ubuntu's implementation signon-ui.


This includes a daemon that will be dbus activated and will offer a set of dbus api to access to credentials and to authenticate to services (google/facebook oauth or owncloud user/password). Within this same repo there is a Qt library that we'll use in our applications to talk to the daemon.

    git clone https://gitlab.com/accounts-sso/signond.git
    cd signond
    make install

Note: Since signond is *dbus* activated be sure that the file `com.google.code.AccountsSSO.SingleSignOn.service` is in a location where dbus can find it (usually /usr/share/dbus-1/services)

Wallet support

In order for sigond to talk to KWallet we need a plugin for it, otherwise it will store secrets (tokens and passwords) in plain text

    git clone kde:signon-kwallet-extension
    mkdir signon-kwallet-extension/build
    cd signon-kwallet-extension/build
    make install

oauth2 plugin

This plugin makes signond able to deal with oauth2 authentication

    git clone https://gitlab.com/accounts-sso/signon-plugin-oauth2.git
    mkdir signon-plugin-oauth2/build
    cd signon-plugin-oauth2/build
    make install


At the moment we are u sing Ubuntu's UI which is under CLA and hosted in Launchpad.

    bzr branch lp:signon-ui
    cd signon-ui
    make install

Note that this project does **NOT** support out of tree builds

Mission Control plugin

To give Telepathy access to your accounts in KAccounts, you need to build this plugin, but it requires signon-glib first:

    git clone https://gitlab.com/accounts-sso/libsignon-glib.git
    cd libsignon-glib
    HAVE_GCOV_FALSE='#' ./autogen.sh --prefix=$ACCOUNTS_PREFIX --enable-debug
    make install

And now the plugin itself

    git clone https://gitlab.com/accounts-sso/telepathy-accounts-signon.git
    mkdir telepathy-accounts-signon/build
    cd telepathy-accounts-signon/build
    make install

KAccounts integration

This is a support library, a kcm module and a daemon running in the background.

    git clone kde:kaccounts-integration
    mkdir kaccounts-integration/build
    cd kaccounts-integration/build
    make install

KAccounts providers

This are the providers and services that at this very moment we provide support for. For example in Facebook we support Chat, Contacts Calendar... for what we need a facebook.provider and chat/contacts/calendar.service files. This is basically a bunch of icons and .xml files

    git clone kde:kaccounts-providers
    mkdir kaccounts-providers/build
    cd kaccounts-providers/build
    make install


Now you still need to build and install ktp-accounts-kcm (this is important!)