xref: /freebsd/lib/libutil/login_auth.3 (revision 315ee00f)
1.\" Copyright (c) 1995 David Nugent <davidn@blaze.net.au>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, is permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice immediately at the beginning of the file, without modification,
9.\"    this list of conditions, and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\" 3. This work was done expressly for inclusion into FreeBSD.  Other use
14.\"    is permitted provided this notation is included.
15.\" 4. Absolutely no warranty of function or purpose is made by the author
16.\"    David Nugent.
17.\" 5. Modifications may be freely made to this file providing the above
18.\"    conditions are met.
19.\"
20.Dd May 10, 2020
21.Dt LOGIN_AUTH 3
22.Os
23.Sh NAME
24.\" .Nm authenticate
25.\" .Nm auth_script
26.\" .Nm auth_env
27.\" .Nm auth_scan
28.\" .Nm auth_rmfiles
29.Nm auth_checknologin ,
30.Nm auth_cat
31.\" .Nm auth_ttyok
32.\" .Nm auth_hostok
33.\" .Nm auth_timesok
34.Nd "authentication style support library for login class capabilities database"
35.Sh LIBRARY
36.Lb libutil
37.Sh SYNOPSIS
38.In sys/types.h
39.In login_cap.h
40.\" .Ft int
41.\". Fn authenticate "const char *name" "const char *classname" "const char *style" "const char *service"
42.\" .Ft int
43.\" .Fn auth_script "const char * path" ...
44.\" .Ft void
45.\" .Fn auth_env "void"
46.\" .Ft int
47.\" .Fn auth_scan "int ok"
48.\" .Ft void
49.\" .Fn auth_rmfiles "void"
50.Ft void
51.Fn auth_checknologin "login_cap_t *lc"
52.Ft int
53.Fn auth_cat "const char *file"
54.\" .Ft int
55.\" .Fn auth_ttyok "login_cap_t *lc" "const char *tty"
56.\" .Ft int
57.\" .Fn auth_hostok "login_cap_t *lc" "const char *hostname" "char const *ip"
58.\" .Ft int
59.\" .Fn auth_timesok "login_cap_t *lc" "time_t now"
60.Sh DESCRIPTION
61This set of functions support the login class authorisation style interface provided
62by
63.Xr login.conf 5 .
64.\" .Sh RETURN VALUES
65.Sh SEE ALSO
66.Xr getcap 3 ,
67.Xr login_cap 3 ,
68.Xr login_class 3 ,
69.Xr login.conf 5 ,
70.Xr termcap 5
71.Sh HISTORY
72The functions
73.Fn auth_checknologin
74and
75.Fn auth_cat
76first appeared in
77.Fx 2.1.5 .
78