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 .\" $FreeBSD$
  26 .\"
  27 .Dd July 12, 2016
  28 .Dt GETLOGINCLASS 2
  29 .Os
  30 .Sh NAME
  31 .Nm getloginclass ,
  32 .Nm setloginclass
  33 .Nd get/set login class
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In unistd.h
  38 .Ft int
  39 .Fn getloginclass "char *name" "size_t len"
  40 .Ft int
  41 .Fn setloginclass "const char *name"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn getloginclass
  45 routine returns the login class name associated with the calling process,
  46 as previously set by
  47 .Fn setloginclass .
  48 The caller must provide the buffer
  49 .Fa name
  50 with length
  51 .Fa len
  52 bytes to hold the result.
  53 The buffer should be at least
  54 .Dv MAXLOGNAME
  55 bytes in length.
  56 .Pp
  57 The
  58 .Fn setloginclass
  59 system call sets the login class of the calling process to
  60 .Fa name .
  61 This system call is restricted to the super-user, and is normally used
  62 only when a new session is being created on behalf of the named user
  63 (for example, at login time, or when a remote shell is invoked).
  64 Processes inherit login class from their parents.
  65 .Sh RETURN VALUES
  66 .Rv -std
  67 .Sh ERRORS
  68 The following errors may be returned by these calls:
  69 .Bl -tag -width Er
  70 .It Bq Er EFAULT
  71 The
  72 .Fa name
  73 argument gave an invalid address.
  74 .It Bq Er EINVAL
  75 The
  76 .Fa name
  77 argument pointed to a string that was too long.
  78 Login class names are limited to
  79 .Dv MAXLOGNAME
  80 (from
  81 .In sys/param.h )
  82 characters, currently 33 including null.
  83 .It Bq Er EPERM
  84 The caller tried to set the login class and was not the super-user.
  85 .It Bq Er ENAMETOOLONG
  86 The size of the buffer is smaller than the result to be returned.
  87 .El
  88 .Sh SEE ALSO
  89 .Xr ps 1 ,
  90 .Xr setusercontext 3 ,
  91 .Xr login.conf 5 ,
  92 .Xr rctl 8
  93 .Sh HISTORY
  94 The
  95 .Fn getloginclass
  96 and
  97 .Fn setloginclass
  98 system calls first appeared in
  99 .Fx 9.0 .