Install input{,-event-types}.h to /usr/include/compat/linux too.
[dragonfly.git] / lib / libutil / login_ok.3
blob8e24c2fa21f63539cb6b0f2c06f7486be2a724be
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 .\" $FreeBSD: head/lib/libutil/login_ok.3 206622 2010-04-14 19:08:06Z uqs $
21 .\"
22 .Dd January 2, 1997
23 .Dt LOGIN_OK 3
24 .Os
25 .Sh NAME
26 .Nm auth_ttyok ,
27 .Nm auth_hostok ,
28 .Nm auth_timeok
29 .Nd functions for checking login class based login restrictions
30 .Sh LIBRARY
31 .Lb libutil
32 .Sh SYNOPSIS
33 .In sys/types.h
34 .In time.h
35 .In login_cap.h
36 .Ft int
37 .Fn auth_ttyok "login_cap_t *lc" "const char *tty"
38 .Ft int
39 .Fn auth_hostok "login_cap_t *lc" "const char *host" "char const *ip"
40 .Ft int
41 .Fn auth_timeok "login_cap_t *lc" "time_t t"
42 .Sh DESCRIPTION
43 This set of functions checks to see if login is allowed based on login
44 class capability entries in the login database,
45 .Xr login.conf 5 .
46 .Pp
47 The
48 .Fn auth_ttyok
49 function checks to see if the named tty is available to users of a specific
50 class, and is either in the
51 .Em ttys.allow
52 access list, and not in
53 the
54 .Em ttys.deny
55 access list.
56 An empty
57 .Em ttys.allow
58 list (or if no such capability exists for
59 the given login class) logins via any tty device are allowed unless
60 the
61 .Em ttys.deny
62 list exists and is non-empty, and the device or its
63 tty group (see
64 .Xr ttys 5 )
65 is not in the list.
66 Access to ttys may be allowed or restricted specifically by tty device
67 name, a device name which includes a wildcard (e.g.\& ttyD* or cuaD*),
68 or may name a ttygroup, when group=<name> tags have been assigned in
69 .Pa /etc/ttys .
70 Matching of ttys and ttygroups is case sensitive.
71 Passing a
72 .Dv NULL
73 or empty string as the
74 .Ar tty
75 parameter causes the function to return a non-zero value.
76 .Pp
77 The
78 .Fn auth_hostok
79 function checks for any host restrictions for remote logins.
80 The function checks on both a host name and IP address (given in its
81 text form, typically n.n.n.n) against the
82 .Em host.allow
83 and
84 .Em host.deny
85 login class capabilities.
86 As with ttys and their groups, wildcards and character classes may be
87 used in the host allow and deny capability records.
88 The
89 .Xr fnmatch 3
90 function is used for matching, and the matching on hostnames is case
91 insensitive.
92 Note that this function expects that the hostname is fully expanded
93 (i.e., the local domain name added if necessary) and the IP address
94 is in its canonical form.
95 No hostname or address lookups are attempted.
96 .Pp
97 It is possible to call this function with either the hostname or
98 the IP address missing (i.e.\&
99 .Dv NULL )
100 and matching will be performed
101 only on the basis of the parameter given.
102 Passing
103 .Dv NULL
104 or empty strings in both parameters will result in
105 a non-zero return value.
108 .Fn auth_timeok
109 function checks to see that a given time value is within the
110 .Em times.allow
111 login class capability and not within the
112 .Em times.deny
113 access lists.
114 An empty or non-existent
115 .Em times.allow
116 list allows access at any
117 time, except if a given time is falls within a period in the
118 .Em times.deny
119 list.
120 The format of time period records contained in both
121 .Em times.allow
123 .Em times.deny
124 capability fields is explained in detail in the
125 .Xr login_times 3
126 manual page.
127 .Sh RETURN VALUES
128 A non-zero return value from any of these functions indicates that
129 login access is granted.
130 A zero return value means either that the item being tested is not
131 in the
132 .Em allow
133 access list, or is within the
134 .Em deny
135 access list.
136 .Sh SEE ALSO
137 .Xr getcap 3 ,
138 .Xr login_cap 3 ,
139 .Xr login_class 3 ,
140 .Xr login_times 3 ,
141 .Xr login.conf 5 ,
142 .Xr termcap 5