summaryrefslogtreecommitdiff
path: root/lib/libc/gen/auth_subr.3
diff options
context:
space:
mode:
Diffstat (limited to 'lib/libc/gen/auth_subr.3')
-rw-r--r--lib/libc/gen/auth_subr.327
1 files changed, 19 insertions, 8 deletions
diff --git a/lib/libc/gen/auth_subr.3 b/lib/libc/gen/auth_subr.3
index 3bdc69abb08..2b0d9f912ff 100644
--- a/lib/libc/gen/auth_subr.3
+++ b/lib/libc/gen/auth_subr.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: auth_subr.3,v 1.20 2013/06/05 03:39:22 tedu Exp $
+.\" $OpenBSD: auth_subr.3,v 1.21 2013/08/14 08:39:24 jmc Exp $
.\"
.\" Copyright (c) 1997 Berkeley Software Design, Inc. All rights reserved.
.\"
@@ -31,7 +31,7 @@
.\" SUCH DAMAGE.
.\"
.\" BSDI $From: auth_subr.3,v 2.5 2000/03/30 19:11:27 polk Exp $
-.Dd $Mdocdate: June 5 2013 $
+.Dd $Mdocdate: August 14 2013 $
.Dt BSD_AUTH 3
.Os
.Sh NAME
@@ -104,14 +104,19 @@
.Ft void
.Fn auth_setstate "auth_session_t *as" "int state"
.Sh DESCRIPTION
-These functions provide the lower level interface to the BSD
+These functions provide the lower level interface to the
+.Bx
Authentication system.
-They all operate on a BSD Authentication session pointer,
+They all operate on a
+.Bx
+Authentication session pointer,
.Fa as ,
which is returned by
.Fn auth_open .
The session pointer
-must be passed to all other BSD Authentication functions called.
+must be passed to all other
+.Bx
+Authentication functions called.
The
.Fn auth_open
function returns
@@ -173,9 +178,13 @@ is called.
.Pp
The remaining functions are described in alphabetical order.
.Pp
-The fundamental function for doing BSD Authentication is
+The fundamental function for doing
+.Bx
+Authentication is
.Fn auth_call .
-In addition to the pointer to the BSD Authentication session, it takes
+In addition to the pointer to the
+.Bx
+Authentication session, it takes
the following parameters:
.Bl -tag -width indent
.It Ar path
@@ -372,7 +381,9 @@ The latest challenge, if any, set for the session.
The class of the user, as defined by the
.Pa /etc/login.conf
file.
-This value is not directly used by BSD Authentication, rather, it is
+This value is not directly used by
+.Bx
+Authentication, rather, it is
passed to the login scripts for their possible use.
.It Dv AUTH_INTERACTIVE
If set to any value, then the session is tagged as interactive.