oidc-agent
Search…
Introduction
Quickstart
Installation
Linux
MacOS
Configuration
Usage
MAC OS
Security
API
Powered By GitBook
Linux
This document describes how to install oidc-agent on linux. To install oidc-agent on MacOS refer to the MacOS documentation.

From Package

We provide packages for Debian, Ubuntu and CentOS, Suse, and more. They are available at http://repo.data.kit.edu/ or at GitHub.
Follow the instructions for your distro, then:
  • sudo apt-get update
  • sudo apt-get install oidc-agent

From Source

If you want to build oidc-agent from source you can do so.

Dependencies

Basic Dependencies

To be able to build oidc-agent, you need at least the following dependencies installed on your system:
We note that libsodium-dev might not be available by default on all systems with the required version of at least 1.0.14. It might be included in backports or has to build from source.
Debian/Ubuntu
1
sudo apt-get install \
2
libcurl4-openssl-dev \
3
libsodium-dev \
4
libseccomp-dev \
5
libmicrohttpd-dev \
6
libsecret-1-dev \
7
libqrencode-dev
Copied!
CentOS 7
1
sudo yum install \
2
libcurl-devel \
3
libsodium-devel \
4
libsodium-static \
5
libmicrohttpd-devel \
6
libseccomp-devel \
7
libsecret-devel \
8
libqrencode-devel
Copied!

Additional Build Dependencies

oidc-agent can be installed easiest from package. So even when building from source it is recommended to build the package and install it.
Building the deb/rpm package might have additional dependencies.
  • help2man
  • check
  • debhelper
  • pkg-config
  • perl
  • sed
  • fakeroot
  • devscripts

Optional Runtime Dependencies

Some features require additional dependencies.
  • yad through oidc-agent-prompt (required for password prompting by the agent)
  • qrencode (required for generating an optional QR-Code when using the device flow)

Download oidc-agent

After installing the necessary dependencies, one has to obtain a copy of the source. Possible ways are:

Using git

1
git clone https://github.com/indigo-dc/oidc-agent
2
cd oidc-agent
Copied!

Using curl

1
curl -L https://github.com/indigo-dc/oidc-agent/archive/master.tar.gz -o /tmp/oidc-agent-master.tar.gz
2
tar xzf /tmp/oidc-agent-master.tar.gz
3
cd oidc-agent
Copied!

Build and install oidc-agent

As already mentioned, oidc-agent can be installed easiest by using a debian or rpm package. It is therefore recommend to build such a package.

Building a package

Debian / Ubuntu
To build a debian package and install it run the following commands inside the oidc-agent source directory:
1
make deb
2
sudo dpkg -i ../liboidc-agent4_<version>_amd64.deb
3
sudo dpkg -i ../oidc-agent_<version>_amd64.deb
Copied!
CentOS 7
To build an rpm package and install it run the following commands inside the oidc-agent source directory:
1
make rpm
2
sudo yum install ./rpm/rpmbuild/RPMS/<arch>/oidc-agent-<version>-1.<arch>.rpm
Copied!

Building Binaries

The binaries can be build with make. To build and install run:
1
make
2
sudo make install_lib
3
sudo make install
4
sudo make post_install
Copied!
This will:
  • build the binaries
  • create man pages
  • install the binaries
  • install the man pages
  • install configuration files
  • install bash completion
  • install a custome scheme handler
  • enable a linker to use the newly installed libraries
  • update the desktop database to enable the custome scheme handler
If you want to install any of these files to another location you can pass a different path to make. E.g. sudo make install BIN_PATH=/home/user will install the binaries in /home/user/bin instead of /usr/bin.
One could also run only make and manually copy the necessary files to another location and / or add the binaries' location to PATH. However, this is not recommend, because some files have to be placed at specific locations or additional configuration is needed. But it is also possible to install only a subset of all files, by calling the different make install_ rules. Available targets are:
1
sudo make install_bin
2
sudo make install_man
3
sudo make install_conf
4
sudo make install_bash
5
sudo make install_priv
6
sudo make install_scheme_handler
7
sudo make install_xsession_script
8
sudo make install_lib
9
sudo make install_lib-dev
Copied!
Previous
Installation
Next
MacOS
Last modified 1mo ago
Copy link
Contents
From Package
From Source
Dependencies
Download oidc-agent
Build and install oidc-agent