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$ 21.\" 22.Dd October 20, 2008 23.Dt LOGIN_CLASS 3 24.Os 25.Sh NAME 26.Nm setclasscontext , 27.Nm setclasscpumask , 28.Nm setclassenvironment , 29.Nm setclassresources , 30.Nm setusercontext 31.Nd "functions for using the login class capabilities database" 32.Sh LIBRARY 33.Lb libutil 34.Sh SYNOPSIS 35.In sys/types.h 36.In login_cap.h 37.Ft int 38.Fn setclasscontext "const char *classname" "unsigned int flags" 39.Ft void 40.Fn setclasscpumask "login_cap_t *lc" 41.Ft void 42.Fn setclassenvironment "login_cap_t *lc" "const struct passwd *pwd" "int paths" 43.Ft void 44.Fn setclassresources "login_cap_t *lc" 45.Ft int 46.Fn setusercontext "login_cap_t *lc" "const struct passwd *pwd" "uid_t uid" "unsigned int flags" 47.Sh DESCRIPTION 48These functions provide a higher level interface to the login class 49database than those documented in 50.Xr login_cap 3 . 51These functions are used to set resource limits, environment and 52accounting settings for users on logging into the system and when 53selecting an appropriate set of environment and resource settings 54for system daemons based on login classes. 55These functions may only be called if the current process is 56running with root privileges. 57If the LOGIN_SETLOGIN flag is used this function calls 58.Xr setlogin 2 , 59and due care must be taken as detailed in the manpage for that 60function and this affects all processes running in the same session 61and not just the current process. 62.Pp 63The 64.Fn setclasscontext 65function sets various class context values (resource limits, umask and 66process priorities) based on values for a specific named class. 67.Pp 68The 69.Fn setusercontext 70function sets class context values based on a given login_cap_t 71object and a specific passwd record (if login_cap_t is NULL), 72the current session's login, and the current process 73user and group ownership. 74Each of these actions is selectable via bit-flags passed 75in the 76.Ar flags 77parameter, which is comprised of one or more of the following: 78.Bl -tag -width LOGIN_SETRESOURCES 79.It LOGIN_SETLOGIN 80Set the login associated with the current session to the user 81specified in the passwd structure using 82.Xr setlogin 2 . 83The 84.Ar pwd 85parameter must not be NULL if this option is used. 86.It LOGIN_SETUSER 87Set ownership of the current process to the uid specified in the 88.Ar uid 89parameter using 90.Xr setuid 2 . 91.It LOGIN_SETGROUP 92Set group ownership of the current process to the group id 93specified in the passwd structure using 94.Xr setgid 2 , 95and calls 96.Xr initgroups 3 97to set up the group access list for the current process. 98The 99.Ar pwd 100parameter must not be NULL if this option is used. 101.It LOGIN_SETRESOURCES 102Set resource limits for the current process based on values 103specified in the system login class database. 104Class capability tags used, with and without -cur (soft limit) 105or -max (hard limit) suffixes and the corresponding resource 106setting: 107.Bd -literal 108cputime RLIMIT_CPU 109filesize RLIMIT_FSIZE 110datasize RLIMIT_DATA 111stacksize RLIMIT_STACK 112coredumpsize RLIMIT_CORE 113memoryuse RLIMIT_RSS 114memorylocked RLIMIT_MEMLOCK 115maxproc RLIMIT_NPROC 116openfiles RLIMIT_NOFILE 117sbsize RLIMIT_SBSIZE 118vmemoryuse RLIMIT_VMEM 119.Ed 120.It LOGIN_SETPRIORITY 121Set the scheduling priority for the current process based on the 122value specified in the system login class database. 123Class capability tags used: 124.Bd -literal 125priority 126.Ed 127.It LOGIN_SETUMASK 128Set the umask for the current process to a value in the user or 129system login class database. 130Class capability tags used: 131.Bd -literal 132umask 133.Ed 134.It LOGIN_SETPATH 135Set the "path" and "manpath" environment variables based on values 136in the user or system login class database. 137Class capability tags used with the corresponding environment 138variables set: 139.Bd -literal 140path PATH 141manpath MANPATH 142.Ed 143.It LOGIN_SETENV 144Set various environment variables based on values in the user or 145system login class database. 146Class capability tags used with the corresponding environment 147variables set: 148.Bd -literal 149lang LANG 150charset MM_CHARSET 151timezone TZ 152term TERM 153.Ed 154.Pp 155Additional environment variables may be set using the list type 156capability "setenv=var1 val1,var2 val2..,varN valN". 157.It LOGIN_SETMAC 158Set the MAC label for the current process to the label specified 159in system login class database. 160.Pp 161.It LOGIN_SETCPUMASK 162Create a new 163.Xr cpuset 2 164and set the cpu affinity to the specified mask. 165The string may contain a comma separated list of numbers and/or number 166ranges as handled by the 167.Xr cpuset 1 168utility or the case-insensitive string 169.Ql default . 170If the string is 171.Ql default 172no action will be taken. 173.It LOGIN_SETALL 174Enables all of the above settings. 175.El 176.Pp 177Note that when setting environment variables and a valid passwd 178pointer is provided in the 179.Ar pwd 180parameter, the characters 181.Ql \&~ 182and 183.Ql \&$ 184are substituted for the user's home directory and login name 185respectively. 186.Pp 187The 188.Fn setclasscpumask , 189.Fn setclassresources 190and 191.Fn setclassenvironment 192functions are subsets of the setcontext functions above, but may 193be useful in isolation. 194.Sh RETURN VALUES 195The 196.Fn setclasscontext 197and 198.Fn setusercontext 199functions return -1 if an error occurred, or 0 on success. 200If an error occurs when attempting to set the user, login, group 201or resources, a message is reported to 202.Xr syslog 3 , 203with LOG_ERR priority and directed to the currently active facility. 204.Sh SEE ALSO 205.Xr cpuset 1 , 206.Xr cpuset 2 , 207.Xr setgid 2 , 208.Xr setlogin 2 , 209.Xr setuid 2 , 210.Xr getcap 3 , 211.Xr initgroups 3 , 212.Xr login_cap 3 , 213.Xr mac_set_proc 3 , 214.Xr login.conf 5 , 215.Xr termcap 5 216