Kerberos Module

The krb5 module enables the use of Kerberos 5 for authentication.

This default config presumes you have the MIT Kerberos 5 distribution.

Configuration Settings

krb5 { … }
keytab: Containing the key used by rlm_krb5.
service_principal: Principal that is used by rlm_krb5.
pool { … }: Pool of krb5 contexts.

This allows us to make the module multithreaded and to avoid expensive operations like resolving and opening keytabs on every request. It may also allow TCP connections to the KDC to be cached if that is supported by the version of libkrb5 used.

The context pool is only used if the underlying libkrb5 reported that it was thread safe at compile time.

start: Connections to create during module instantiation.

If the server cannot create specified number of connections during instantiation it will exit. Set to 0 to allow the server to start without the external service being available.

min: Minimum number of connections to keep open.
max: Maximum number of connections.

If these connections are all in use and a new one is requested, the request will NOT get a connection.

Setting max to LESS than the number of threads means that some threads may starve, and you will see errors like No connections available and at max connection limit.

Setting max to MORE than the number of threads means that there are more connections than necessary.

If max is not specified, then it defaults to the number of workers configured.

spare: Spare connections to be left idle.

Idle connections WILL be closed if idle_timeout is set. This should be less than or equal to max above.

uses: Number of uses before the connection is closed.

A setting of 0 means infinite (no limit).

lifetime: The lifetime (in seconds) of the connection.

A setting of 0 means infinite (no limit).

idle_timeout: The idle timeout (in seconds). A connection which is unused for this length of time will be closed.

A setting of 0 means infinite (no timeout).

All configuration settings are enforced. If a connection is closed because of idle_timeout, uses, or lifetime, then the total number of connections MAY fall below min. When that happens, it will open a new connection. It will also log a WARNING message.

The solution is to either lower the min connections, or increase lifetime/idle_timeout.

Sample

You can configure the module with the following parameters:

krb5 {
# Keytab containing the key used by rlm_krb5
keytab = /path/to/keytab

# Principal that is used by rlm_krb5
service_principal = radius/some.host.com
}

Make sure the keytab is readable by the user that is used to run radiusd and that your authorization configuration really uses krb5 to do the authentication. You will need to add the following to the authenticate section of your radiusd.conf file:

Auth-Type Kerberos {
krb5
}
----

Default Configuration

krb5 {
	keytab = /path/to/keytab
	service_principal = name_of_principle
	pool {
		start = 0
		min = 0
#		max =
		spare = 1
		uses = 0
		lifetime = 0
		idle_timeout = 0
	}
}