8895 libtsol man pages are out of step with reality
[unleashed.git] / usr / src / man / man3lib / libtsol.3lib
blob119e57212efc0dddf99a1de70e65060dd6b4367e
1 '\" te
2 .\" Copyright (c) 2017 Peter Tribble.
3 .\" Copyright (c) 2007, Sun Microsystems, Inc. All rights reserved.
4 .\" 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.
5 .\" 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.
6 .\" 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]
7 .TH LIBTSOL 3LIB "Dec 3, 2017"
8 .SH NAME
9 libtsol \- Solaris Trusted Extensions library
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fBcc\fR [\fIflag\fR...] \fIfile\fR... \fB-ltsol\fR [\fIlibrary\fR...]
14 #include <tsol.h>
15 .fi
17 .SH DESCRIPTION
18 .LP
19 Functions in this library provide programmatic access to Solaris Trusted
20 Extensions features such as labels and Mandatory Access Policy (MAC) on systems
21 that are configured with Trusted Extensions software.
22 .SH INTERFACES
23 .LP
24 The shared object \fBlibtsol.so.2\fR provides the public interfaces that are
25 defined below. See \fBIntro\fR(3) for additional information on shared object
26 interfaces.
27 .SS "Committed Functions"
28 .TS
29 l l
30 l l .
31 \fBbldominates\fR       \fBblequal\fR
32 \fBblstrictdom\fR       \fBfgetlabel\fR
33 \fBgetlabel\fR  \fBgetpathbylabel\fR
34 \fBgetplabel\fR \fBgetdevicerange\fR
35 \fBgetuserrange\fR      \fBgetzoneidbylabel\fR
36 \fBgetzonelabelbyid\fR  \fBgetzonelabelbyname\fR
37 \fBgetzonerootbyid\fR   \fBgetzonerootbylabel\fR
38 \fBgetzonerootbyname\fR \fBlabel_to_str\fR
39 \fBm_label_alloc\fR     \fBm_label_dup\fR
40 \fBm_label_free\fR      \fBsetflabel\fR
41 \fBstr_to_label\fR
42 .TE
44 .SS "Obsolete Functions"
45 .LP
46 The following functions are preserved to aid porting.
47 .sp
49 .sp
50 .TS
51 c c
52 l l .
53 Function        Committed Replacement
54 \fBbcleartoh\fR \fBlabel_to_str\fR
55 \fBbcleartoh_r\fR       \fBlabel_to_str\fR
56 \fBbcleartos\fR \fBlabel_to_str\fR
57 \fBbltocolor\fR \fBlabel_to_str\fR
58 \fBbltocolor_r\fR       \fBlabel_to_str\fR
59 \fBbsltoh\fR    \fBlabel_to_str\fR
60 \fBbsltoh_r\fR  \fBlabel_to_str\fR
61 \fBbsltos\fR    \fBlabel_to_str\fR
62 \fBh_alloc\fR   \fBlabel_to_str\fR
63 \fBh_free\fR    \fBlabel_to_str\fR
64 \fBhtobclear\fR \fBstr_to_label\fR
65 \fBhtobsl\fR    \fBstr_to_label\fR
66 \fBsbcleartos\fR        \fBstr_to_label\fR
67 \fBsbsltos\fR   \fBstr_to_label\fR
68 \fBstobsl\fR    \fBstr_to_label\fR
69 \fBstobclear\fR \fBstr_to_label\fR
70 .TE
72 .SH FILES
73 .ne 2
74 .na
75 \fB\fB/lib/libtsol.so.2\fR\fR
76 .ad
77 .RS 24n
78 shared object
79 .RE
81 .sp
82 .ne 2
83 .na
84 \fB\fB/lib/64/libtsol.so.2\fR\fR
85 .ad
86 .RS 24n
87 64-bit shared object
88 .RE
90 .SH ATTRIBUTES
91 .LP
92 See \fBattributes\fR(5) for descriptions of the following attributes:
93 .sp
95 .sp
96 .TS
97 box;
98 c | c
99 l | l .
100 ATTRIBUTE TYPE  ATTRIBUTE VALUE
102 Interface Stability     T{
103 See the manual pages for the individual functions.
106 MT-Level        Safe
109 .SH SEE ALSO
111 \fBIntro\fR(3), \fBlibtsnet\fR(3LIB), \fBattributes\fR(5)
112 .SH NOTES
114 The functionality described on this manual page is available only if the system
115 has been configured with Trusted Extensions.