login_krb5/login_krb5.8

   1 .\" $OpenBSD: login_krb5.8,v 1.18 2012/06/01 01:43:19 dlg Exp $
   2 .\"
   3 .\" Copyright (c) 2000 Todd C. Miller <Todd.Miller@courtesan.com>
   4 .\"
   5 .\" Permission to use, copy, modify, and distribute this software for any
   6 .\" purpose with or without fee is hereby granted, provided that the above
   7 .\" copyright notice and this permission notice appear in all copies.
   8 .\"
   9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16 .\"
  17 .Dd $Mdocdate: June 1 2012 $
  18 .Dt LOGIN_KRB5 8
  19 .Os
  20 .Sh NAME
  21 .Nm login_krb5
  22 .Nd provide KerberosV authentication type
  23 .Sh SYNOPSIS
  24 .Nm login_krb5
  25 .Bk -words
  26 .Op Fl s Ar service
  27 .Op Fl v Ar login Ns = Ns Li yes Ns | Ns Li no
  28 .Op Fl v Ar notickets Ns = Ns Li yes Ns | Ns Li no
  29 .Op Fl v Ar invokinguser Ns = Ns Ar user
  30 .Ar user
  31 .Op Ar class
  32 .Ek
  33 .Sh DESCRIPTION
  34 The
  35 .Nm
  36 utility implements the KerberosV authentication mechanism.
  37 It is called by
  38 .Xr login 1 ,
  39 .Xr su 1 ,
  40 .Xr ftpd 8 ,
  41 and others to authenticate the
  42 .Ar user
  43 with KerberosV.
  44 .Pp
  45 The
  46 .Ar user
  47 argument is the user's name to be authenticated.
  48 .Pp
  49 The
  50 .Ar service
  51 argument specifies which protocol to use with the
  52 invoking program.
  53 The allowed protocols are
  54 .Em login ,
  55 .Em challenge ,
  56 and
  57 .Em response .
  58 (The
  59 .Em challenge
  60 protocol is silently ignored but will report success as KerberosV
  61 authentication is not challenge-response based).
  62 .Pp
  63 If
  64 .Ar invokinguser
  65 is set and the
  66 .Ar user
  67 argument is root, the principal
  68 invokinguser/root will be used for authentication.
  69 .Pp
  70 If the
  71 .Ar notickets
  72 argument is equal to
  73 .Dq no ,
  74 the default value, and the
  75 .Ar login
  76 argument is equal to
  77 .Dq yes ,
  78 then the ticket will be saved in a credentials cache.
  79 .Pp
  80 The
  81 .Ar class
  82 argument is ignored for compatibility with other login scripts.
  83 .Pp
  84 .Nm
  85 will prompt the user for a password and report back to the
  86 invoking program whether or not the authentication was
  87 successful.
  88 .Pp
  89 As documented in
  90 .Xr login.conf 5 ,
  91 .Nm
  92 being a locally added authentication style, the authentication helper and style
  93 needs to start with a dash:
  94 .Em login_-krb5, -krb5 .
  95 .Sh LOGIN.CONF VARIABLES
  96 The
  97 .Nm
  98 utility uses the following krb5-specific
  99 .Pa /etc/login.conf
 100 variables:
 101 .Bl -column "krb5-noverify" "bool" "Description"
 102 .It Sy Name Ta Sy Type Ta Sy Description
 103 .It krb5-noverify Ta bool Ta
 104 Failure to verify credentials against a local key is not considered a fatal
 105 error.
 106 .El
 107 .Sh FILES
 108 .Bl -tag -compact -width xetcxloginxconfxx
 109 .It Pa /etc/login.conf
 110 login configuration database
 111 .El
 112 .Sh SEE ALSO
 113 .Xr login 1 ,
 114 .Xr passwd 1 ,
 115 .Xr su 1 ,
 116 .Xr login.conf 5 ,
 117 .Xr ftpd 8 ,
 118 .Xr kerberos 8 ,
 119 .Xr login_krb5-or-pwd 8