1 .\" Copyright (c) 1995 David Nugent <davidn@blaze.net.au>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, is permitted provided that the following conditions
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
17 .\" 5. Modifications may be freely made to this file providing the above
18 .\" conditions are met.
27 .Nm setclassenvironment ,
28 .Nm setclassresources ,
30 .Nd "functions for using the login class capabilities database"
37 .Fn setclasscontext "const char *classname" "unsigned int flags"
39 .Fn setusercontext "login_cap_t *lc" "const struct passwd *pwd" "uid_t uid" "unsigned int flags"
41 .Fn setclassresources "login_cap_t *lc"
43 .Fn setclassenvironment "login_cap_t *lc" "const struct passwd *pwd" "int paths"
45 These functions provide a higher level interface to the login class
46 database than those documented in
48 These functions are used to set resource limits, environment and
49 accounting settings for users on logging into the system and when
50 selecting an appropriate set of environment and resource settings
51 for system daemons based on login classes.
52 These functions may only be called if the current process is
53 running with root privileges.
54 If the LOGIN_SETLOGIN flag is used this function calls
56 and due care must be taken as detailed in the manpage for that
57 function and this affects all processes running in the same session
58 and not just the current process.
62 function sets various class context values (resource limits, umask and
63 process priorities) based on values for a specific named class.
67 function sets class context values based on a given login_cap_t
68 object and a specific passwd record (if login_cap_t is NULL),
69 the current session's login, and the current process
70 user and group ownership.
71 Each of these actions is selectable via bit-flags passed
74 parameter, which is comprised of one or more of the following:
75 .Bl -tag -width LOGIN_SETRESOURCES
77 Set the login associated with the current session to the user
78 specified in the passwd structure using
82 parameter must not be NULL if this option is used.
84 Set ownership of the current process to the uid specified in the
89 Set group ownership of the current process to the group id
90 specified in the passwd structure using
94 to set up the group access list for the current process.
97 parameter must not be NULL if this option is used.
98 .It LOGIN_SETRESOURCES
99 Set resource limits for the current process based on values
100 specified in the system login class database.
101 Class capability tags used, with and without -cur (soft limit)
102 or -max (hard limit) suffixes and the corresponding resource
106 filesize RLIMIT_FSIZE
108 stacksize RLIMIT_STACK
109 coredumpsize RLIMIT_CORE
111 memorylocked RLIMIT_MEMLOCK
113 openfiles RLIMIT_NOFILE
115 vmemoryuse RLIMIT_VMEM
117 .It LOGIN_SETPRIORITY
118 Set the scheduling priority for the current process based on the
119 value specified in the system login class database.
120 Class capability tags used:
125 Set the umask for the current process to a value in the user or
126 system login class database.
127 Class capability tags used:
132 Set the "path" and "manpath" environment variables based on values
133 in the user or system login class database.
134 Class capability tags used with the corresponding environment
141 Set various environment variables based on values in the user or
142 system login class database.
143 Class capability tags used with the corresponding environment
152 Additional environment variables may be set using the list type
153 capability "setenv=var1 val1,var2 val2..,varN valN".
155 Set the MAC label for the current process to the label specified
156 in system login class database.
161 and set the cpu affinity to the specified mask.
162 The string may contain a comma separated list of numbers and/or number
163 ranges as handled by the
165 utility or the case-insensitive string
169 no action will be taken.
171 Enables all of the above settings.
174 Note that when setting environment variables and a valid passwd
175 pointer is provided in the
177 parameter, the characters
181 are substituted for the user's home directory and login name
185 .Fn setclassresources
187 .Fn setclassenvironment
188 functions are subsets of the setcontext functions above, but may
189 be useful in isolation.
195 functions return -1 if an error occurred, or 0 on success.
196 If an error occurs when attempting to set the user, login, group
197 or resources, a message is reported to
199 with LOG_ERR priority and directed to the currently active facility.