lib/libc/sys/getloginclass.2

   1 .\"-
   2 .\" Copyright (c) 2011 Edward Tomasz Napierala
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .Dd July 12, 2016
  26 .Dt GETLOGINCLASS 2
  27 .Os
  28 .Sh NAME
  29 .Nm getloginclass ,
  30 .Nm setloginclass
  31 .Nd get/set login class
  32 .Sh LIBRARY
  33 .Lb libc
  34 .Sh SYNOPSIS
  35 .In unistd.h
  36 .Ft int
  37 .Fn getloginclass "char *name" "size_t len"
  38 .Ft int
  39 .Fn setloginclass "const char *name"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn getloginclass
  43 routine returns the login class name associated with the calling process,
  44 as previously set by
  45 .Fn setloginclass .
  46 The caller must provide the buffer
  47 .Fa name
  48 with length
  49 .Fa len
  50 bytes to hold the result.
  51 The buffer should be at least
  52 .Dv MAXLOGNAME
  53 bytes in length.
  54 .Pp
  55 The
  56 .Fn setloginclass
  57 system call sets the login class of the calling process to
  58 .Fa name .
  59 This system call is restricted to the super-user, and is normally used
  60 only when a new session is being created on behalf of the named user
  61 (for example, at login time, or when a remote shell is invoked).
  62 Processes inherit login class from their parents.
  63 .Sh RETURN VALUES
  64 .Rv -std
  65 .Sh ERRORS
  66 The following errors may be returned by these calls:
  67 .Bl -tag -width Er
  68 .It Bq Er EFAULT
  69 The
  70 .Fa name
  71 argument gave an invalid address.
  72 .It Bq Er EINVAL
  73 The
  74 .Fa name
  75 argument pointed to a string that was too long.
  76 Login class names are limited to
  77 .Dv MAXLOGNAME
  78 (from
  79 .In sys/param.h )
  80 characters, currently 33 including null.
  81 .It Bq Er EPERM
  82 The caller tried to set the login class and was not the super-user.
  83 .It Bq Er ENAMETOOLONG
  84 The size of the buffer is smaller than the result to be returned.
  85 .El
  86 .Sh SEE ALSO
  87 .Xr ps 1 ,
  88 .Xr setusercontext 3 ,
  89 .Xr login.conf 5 ,
  90 .Xr rctl 8
  91 .Sh HISTORY
  92 The
  93 .Fn getloginclass
  94 and
  95 .Fn setloginclass
  96 system calls first appeared in
  97 .Fx 9.0 .