Getting started with Kerberos in xDI Designer

This page contains information to help you get started with Kerberos in Semarchy xDI.


This page describes how to create Kerberos Metadata to store Kerberos information, such as the various principals and keytabs, in a central location. This information is then used in other components that support Kerberos authentication.

Create the Metadata

To create a Kerberos Metadata, launch the Metadata creation wizard, select the Kerberos Metadata in the list and follow the wizard.

Then, configure the server and principals properties.

Server properties

The server node is the root node of the Metadata.

It represents the global Kerberos properties shared with all the principals.

Below, an example of a server node:

getting started kerberos server node overview

The following server properties are available.

Property Description Example

Kerberos Configuration File Path

Path to the Kerberos configuration file.
This is a file usually named krb5.conf and which contains the location of the Kerberos server and necessary information to perform the Kerberos connection.

This property is mandatory.

This is used to define a property that is global and unique on the running Java Virtual Machine. You can only use one Configuration file at a time and changing it requires to restart the Designer / Runtime.


Enable Kerberos Debug

Optional debug property that allows to print more information in the Designer and Runtime consoles when performing Kerberos connections.

This can help to debug connection issues, as Kerberos will return more details and logs about the connection operations.

As a reminder, to launch the Designer console, start the Designer through a command prompt with the -console option.

Java Security Debug Properties

Optional comma separated list of debug values that should be returned by Java.

This specifies the Java property, which defines the debug logs that should be returned.

When you are debugging Kerberos connection issues, we advise to set it to the example value to get precise log information.


Principal properties

Under Kerberos, an account in called a 'principal'.

In the Kerberos Metadata, you can add as many principals as required, representing your different services, organizations, …​

To add a new Principal:

  1. right click on the server node

  2. choose new > Kerberos Principal

Below, an example of a principal node:

getting started kerberos principal node overview

The following properties are available:

Property Description Example


Logical label (alias) to identify the Principal.
This property is mandatory.


Kerberos Principal

Kerberos Principal name. The Kerberos Principal must meet the standard Kerberos Principal syntax, that is the following:


This property is mandatory.


Kerberos Local Keytab File Path

Local Path to the Keytab file associated to the Principal.

It must be reachable by the Designer / Runtime.

This property is mandatory.


Kerberos Remote Keytab File Path

Optional remote Path to the Keytab file associated to the Principal.

Templates and tools that are launching commands over SSH on servers secured with Kerberos requires to perform a Kerberos connection on the server, before operating.

This property specifies the path of the Keytab on the remote server.