usr/src/man/man3tsol/getuserrange.3tsol

   1 '\" te
   2 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH GETUSERRANGE 3TSOL "Jul 20, 2007"
   7 .SH NAME
   8 getuserrange \- get the label range of a user
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [\fIflags\fR...] \fIfile\fR... \fB-ltsol\fR [\fIlibrary\fR...]
  13 .fi
  14
  15 .LP
  16 .nf
  17 #include <tsol/label.h>
  18
  19 \fBm_range_t *\fR\fBgetuserrange\fR(\fBconst char *\fR\fIusername\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fBgetuserrange()\fR function returns the label range of \fIusername\fR.
  26 The lower bound in the range is used as the initial workspace label when a user
  27 logs into a multilevel desktop. The upper bound, or clearance, is used as an
  28 upper limit to the available labels that a user can assign to labeled
  29 workspaces.
  30 .sp
  31 .LP
  32 The default value for a user's label range is specified in
  33 \fBlabel_encodings\fR(4). Overriding values for individual users are specified
  34 in \fBuser_attr\fR(4).
  35 .SH RETURN VALUES
  36 .sp
  37 .LP
  38 The \fBgetuserrange()\fR function returns \fBNULL\fR if the memory allocation
  39 fails. Otherwise, the function returns a structure which must be freed by the
  40 caller, as follows:
  41 .sp
  42 .in +2
  43 .nf
  44 m_range_t  *range;
  45     ...
  46     m_label_free(range->lower_bound);
  47     m_label_free(range->upper_bound);
  48     free(range);
  49 .fi
  50 .in -2
  51 .sp
  52
  53 .SH ERRORS
  54 .sp
  55 .LP
  56 The \fBgetuserrange()\fR function will fail if:
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fBENOMEM\fR\fR
  61 .ad
  62 .RS 10n
  63 The physical limits of the system are exceeded by size bytes of memory which
  64 cannot be allocated.
  65 .RE
  66
  67 .SH ATTRIBUTES
  68 .sp
  69 .LP
  70 See \fBattributes\fR(5) for descriptions of the following attributes:
  71 .sp
  72
  73 .sp
  74 .TS
  75 box;
  76 c | c
  77 l | l .
  78 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  79 _
  80 Interface Stability     See below.
  81 _
  82 MT-Level        MT-Safe
  83 .TE
  84
  85 .sp
  86 .LP
  87 The \fBgetuserrange()\fR function is Committed for systems that implement the
  88 Defense Intelligence Agency (DIA) MAC policy of \fBlabel_encodings\fR(4). Other
  89 policies might exist in a future release of Trusted Extensions that might make
  90 obsolete or supplement \fBlabel_encodings\fR.
  91 .SH SEE ALSO
  92 .sp
  93 .LP
  94 \fBfree\fR(3C), \fBlibtsol\fR(3LIB), \fBm_label_free\fR(3TSOL),
  95 \fBlabel_encodings\fR(4), \fBuser_attr\fR(4), \fBattributes\fR(5)
  96 .SH NOTES
  97 .sp
  98 .LP
  99 The functionality described on this manual page is available only if the system
 100 is configured with Trusted Extensions.