Go to main content

man pages section 4: File Formats

Exit Print View

Updated: July 2017
 
 

warn.conf(4)

Name

warn.conf - Kerberos warning configuration file

Synopsis

/etc/krb5/warn.conf
/var/user/$USER/krb-warn.conf

Description

The ktkt_warnd(1M) configuration files contain configuration information specifying how users will be warned by the ktkt_warnd daemon about ticket expiration. In addition, these files can be used to auto-renew the user's Ticket-Granting Ticket (TGT) instead of warning the user. Credential expiration warnings and auto-renew results are sent, by means of syslog, to auth.notice.

If the user's configuration file, /var/user/$USER/krb-warn.conf, does not exist, /etc/krb5/warn.conf will be used.

If each user does not have a configuration file, each Kerberos client host must have an /etc/krb5/warn.conf file in order for users on that host to get Kerberos warnings from the client. Entries in the configuration files must have the following format:

principal|* [renew:opt1,...optN] syslog|terminal time

or:

principal|* [renew[:opt1,...optN]] mail time &|email address
principal

Specifies the principal name to be warned. The asterisk (*) wildcard can be used to specify groups of principals.

renew

Automatically renew the credentials (TGT) until renewable lifetime expires. This is equivalent to the user running kinit –R.

The renew options include:

log-success

Log the result of the renew attempt on success using the specified method (syslog|terminal|mail).

log-failure

Log the result of the renew attempt on failure using the specified method (syslog|terminal|mail). Some renew failure conditions are: TGT renewable lifetime has expired, the KDCs are unavailable, or the cred cache file has been removed.

log

Same as specifing both log-success and log-failure.


Note - If no log options are given, no logging is done.
syslog

Sends the warnings to the system's syslog. Depending on the /etc/syslog.conf file, syslog entries are written to the /var/adm/messages file and/or displayed on the terminal.

terminal

Sends the warnings to display on the terminal.

mail

Sends the warnings as email to the address specified by email_address.

time

Specifies how much time before the TGT expires when a warning should be sent. The default time value is seconds, but you can specify h (hours) and m (minutes) after the number to specify other time values.

&

Map the principal name to the Unix name and use that as a local mail address to mail the message. The expected default mappings can be changed by means of auth_to_local_names and auth_to_local in krb5.conf(4).

email_address

Specifies the email address at which to send the warnings. This field must be specified only with the mail field.

Examples

Example 1 Specifying Warnings

The following warn.conf entry

* syslog 5m 

specifies that warnings will be sent to the syslog five minutes before the expiration of the TGT for all principals. The form of the message is:

jdb@ACME.COM: your kerberos credentials expire in 5 minutes
Example 2 Specifying Renewal

The following warn.conf entry:

* renew:log terminal 30m

...specifies that renew results will be sent to the user's terminal 30 minutes before the expiration of the TGT for all principals. The form of the message (on renew success) is:

myname@ACME.COM: your kerberos credentials have been renewed
Example 3 Emailing Each User

The following warn.conf entry specifies that each user is emailed 30 minutes before his or her credential expires.

* mail 30m &

Files

/usr/lib/krb5/ktkt_warnd

Kerberos warning daemon

Attributes

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed

See Also

kinit(1), kdestroy(1), gsscred(1M), ktkt_warnd(1M), krb5.conf(4), syslog.conf(4), utmpx(4), attributes(5), kerberos(5), pam_krb5(5)

Notes

The auto-renew of the TGT is attempted only if the user is logged-in, as determined by examining utmpx(4).