usr/src/man/man3tsol/getzonelabelbyid.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 GETZONELABELBYID 3TSOL "Jul 20, 2007"
   7 .SH NAME
   8 getzonelabelbyid, getzonelabelbyname, getzoneidbylabel \- map between zones and
   9 labels
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [\fIflags\fR...] \fIfile\fR... \fB-ltsol\fR [\fIlibrary\fR...]
  14 .fi
  15
  16 .LP
  17 .nf
  18 #include <tsol/label.h>
  19
  20 \fBm_label_t *\fR\fBgetzonelabelbyid\fR(\fBzoneid_t\fR \fIzoneid\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBm_label_t *\fR\fBgetzonelabelbyname\fR(\fBconst char *\fR\fIzonename\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBzoneid_t *\fR\fBgetzoneidbylabel\fR(\fBconst m_label_t *\fR\fIlabel\fR);
  31 .fi
  32
  33 .SH DESCRIPTION
  34 .sp
  35 .LP
  36 The \fBgetzonelabelbyid()\fR function returns the mandatory access control
  37 (MAC) label of \fIzoneid\fR.
  38 .sp
  39 .LP
  40 The \fBgetzonelabelbyname()\fR function returns the MAC label of the zone whose
  41 name is \fIzonename\fR.
  42 .sp
  43 .LP
  44 The \fBgetzoneidbylabel()\fR function returns the zone ID of the zone whose
  45 label is \fIlabel\fR.
  46 .sp
  47 .LP
  48 All of these functions require that the specified zone's state is at least
  49 \fBZONE_IS_READY\fR. The zone of the calling process must dominate the
  50 specified zone's label, or the calling process must be in the global zone.
  51 .SH RETURN VALUES
  52 .sp
  53 .LP
  54 On successful completion, the \fBgetzonelabelbyid()\fR and
  55 \fBgetzonelabelbyname()\fR functions return a pointer to a sensitivity label
  56 that is allocated within these functions. To free the storage, use
  57 \fBm_label_free\fR(3TSOL). If the zone does not exist, \fBNULL\fR is returned.
  58 .sp
  59 .LP
  60 On successful completion, the \fBgetzoneidbylabel()\fR function returns the
  61 zone ID with the matching label. If there is no matching zone, the function
  62 returns \fB-1\fR.
  63 .SH ERRORS
  64 .sp
  65 .LP
  66 The \fBgetzonelabelbyid()\fR and \fBgetzonelabelbyname()\fR functions will fail
  67 if:
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fBENOENT\fR\fR
  72 .ad
  73 .RS 10n
  74 The specified zone does not exist.
  75 .RE
  76
  77 .sp
  78 .LP
  79 The \fBgetzonelabelbyid()\fR function will fail if:
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBENOENT\fR\fR
  84 .ad
  85 .RS 10n
  86 No zone corresponds to the specified label.
  87 .RE
  88
  89 .SH ATTRIBUTES
  90 .sp
  91 .LP
  92 See \fBattributes\fR(5) for descriptions of the following attributes:
  93 .sp
  94
  95 .sp
  96 .TS
  97 box;
  98 c | c
  99 l | l .
 100 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 101 _
 102 Interface Stability     Committed
 103 _
 104 MT-Level        Safe
 105 .TE
 106
 107 .SH SEE ALSO
 108 .sp
 109 .LP
 110 \fBIntro\fR(2), \fBgetzonenamebyid\fR(3C), \fBgetzoneidbyname\fR(3C),
 111 \fBlibtsol\fR(3LIB), \fBm_label_free\fR(3TSOL), \fBattributes\fR(5),
 112 \fBlabels\fR(5)
 113 .SH NOTES
 114 .sp
 115 .LP
 116 The functionality described on this manual page is available only if the system
 117 is configured with Trusted Extensions.