Skip to content

Commit

Permalink
8895 libtsol man pages are out of step with reality
Browse files Browse the repository at this point in the history
Reviewed by: Ken Mays <maybird1776@yahoo.com>
Reviewed by: Yuri Pankov <yuripv@gmx.com>
Approved by: Dan McDonald <danmcd@joyent.com>
  • Loading branch information
ptribble authored and Dan McDonald committed Dec 8, 2017
1 parent 68d7704 commit b8e5ecd
Show file tree
Hide file tree
Showing 8 changed files with 22 additions and 739 deletions.
5 changes: 1 addition & 4 deletions usr/src/man/man2/Makefile
Expand Up @@ -14,6 +14,7 @@
# Copyright 2013, OmniTI Computer Consulting, Inc
# Copyright 2013 Nexenta Systems, Inc. All rights reserved.
# Copyright (c) 2015, Joyent, Inc. All rights reserved.
# Copyright 2017 Peter Tribble
#

include $(SRC)/Makefile.master
Expand Down Expand Up @@ -58,7 +59,6 @@ MANFILES= Intro.2 \
getgroups.2 \
getisax.2 \
getitimer.2 \
getlabel.2 \
getmsg.2 \
getpflags.2 \
getpid.2 \
Expand Down Expand Up @@ -188,7 +188,6 @@ MANLINKS= _Exit.2 \
fchown.2 \
fchownat.2 \
fchroot.2 \
fgetlabel.2 \
fork1.2 \
forkall.2 \
forkallx.2 \
Expand Down Expand Up @@ -322,8 +321,6 @@ setgroups.2 := LINKSRC = getgroups.2

setitimer.2 := LINKSRC = getitimer.2

fgetlabel.2 := LINKSRC = getlabel.2

getpmsg.2 := LINKSRC = getmsg.2

setpflags.2 := LINKSRC = getpflags.2
Expand Down
31 changes: 10 additions & 21 deletions usr/src/man/man3lib/libtsol.3lib
@@ -1,9 +1,10 @@
'\" te
.\" Copyright (c) 2017 Peter Tribble.
.\" Copyright (c) 2007, Sun Microsystems, Inc. All rights reserved.
.\" 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.
.\" 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.
.\" 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]
.TH LIBTSOL 3LIB "Jul 20, 2007"
.TH LIBTSOL 3LIB "Dec 3, 2017"
.SH NAME
libtsol \- Solaris Trusted Extensions library
.SH SYNOPSIS
Expand All @@ -14,41 +15,33 @@ libtsol \- Solaris Trusted Extensions library
.fi

.SH DESCRIPTION
.sp
.LP
Functions in this library provide programmatic access to Solaris Trusted
Extensions features such as labels and Mandatory Access Policy (MAC) on systems
that are configured with Trusted Extensions software.
.SH INTERFACES
.sp
.LP
The shared object \fBlibtsol.so.2\fR provides the public interfaces that are
defined below. See \fBIntro\fR(3) for additional information on shared object
interfaces.
.SS "Committed Functions"
.sp

.sp
.TS
l l
l l .
\fBbldominates\fR \fBblequal\fR
\fBblstrictdom\fR \fBgetpathbylabel\fR
\fBblstrictdom\fR \fBfgetlabel\fR
\fBgetlabel\fR \fBgetpathbylabel\fR
\fBgetplabel\fR \fBgetdevicerange\fR
\fBgetuserrange\fR \fBgetzoneidbylabel\fR
\fBgetzonelabelbyid\fR \fBgetzonerootbyid\fR
\fBgetzonerootbylabel\fR \fBgetzonerootbyname\fR
\fBlabel_to_str\fR \fBlabelbuilder\fR
\fBlabelclipping\fR \fBm_label_alloc\fR
\fBm_label_dup\fR \fBm_label_free\fR
\fBsetflabel\fR \fBstr_to_label\fR
\fBtsol_lbuild_create\fR \fBtsol_lbuild_destroy\fR
\fBtsol_lbuild_get\fR \fBtsol_lbuild_set\fR
\fBXbcleartos\fR \fBXbsltos\fR
\fBgetzonelabelbyid\fR \fBgetzonelabelbyname\fR
\fBgetzonerootbyid\fR \fBgetzonerootbylabel\fR
\fBgetzonerootbyname\fR \fBlabel_to_str\fR
\fBm_label_alloc\fR \fBm_label_dup\fR
\fBm_label_free\fR \fBsetflabel\fR
\fBstr_to_label\fR
.TE

.SS "Obsolete Functions"
.sp
.LP
The following functions are preserved to aid porting.
.sp
Expand Down Expand Up @@ -77,7 +70,6 @@ Function Committed Replacement
.TE

.SH FILES
.sp
.ne 2
.na
\fB\fB/lib/libtsol.so.2\fR\fR
Expand All @@ -96,7 +88,6 @@ shared object
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
Expand All @@ -116,11 +107,9 @@ MT-Level Safe
.TE

.SH SEE ALSO
.sp
.LP
\fBIntro\fR(3), \fBlibtsnet\fR(3LIB), \fBattributes\fR(5)
.SH NOTES
.sp
.LP
The functionality described on this manual page is available only if the system
has been configured with Trusted Extensions.
14 changes: 6 additions & 8 deletions usr/src/man/man3tsol/Makefile
Expand Up @@ -12,6 +12,7 @@
#
# Copyright 2011, Richard Lowe
# Copyright 2013 Nexenta Systems, Inc. All rights reserved.
# Copyright 2017 Peter Tribble
#

include $(SRC)/Makefile.master
Expand All @@ -24,25 +25,22 @@ MANFILES= blcompare.3tsol \
bltos.3tsol \
btohex.3tsol \
getdevicerange.3tsol \
getlabel.3tsol \
getpathbylabel.3tsol \
getplabel.3tsol \
getuserrange.3tsol \
getzonelabelbyid.3tsol \
getzonerootbyid.3tsol \
hextob.3tsol \
label_to_str.3tsol \
labelbuilder.3tsol \
labelclipping.3tsol \
m_label.3tsol \
sbltos.3tsol \
setflabel.3tsol \
stobl.3tsol \
str_to_label.3tsol \
tsol_getrhtype.3tsol

MANLINKS= Xbcleartos.3tsol \
Xbsltos.3tsol \
bcleartoh.3tsol \
MANLINKS= bcleartoh.3tsol \
bcleartoh_r.3tsol \
bcleartos.3tsol \
bldominates.3tsol \
Expand All @@ -55,6 +53,7 @@ MANLINKS= Xbcleartos.3tsol \
bsltoh.3tsol \
bsltoh_r.3tsol \
bsltos.3tsol \
fgetlabel.3tsol \
getzoneidbylabel.3tsol \
getzonelabelbyname.3tsol \
getzonerootbylabel.3tsol \
Expand Down Expand Up @@ -91,6 +90,8 @@ bsltoh_r.3tsol := LINKSRC = btohex.3tsol
h_alloc.3tsol := LINKSRC = btohex.3tsol
h_free.3tsol := LINKSRC = btohex.3tsol

fgetlabel.3tsol := LINKSRC = getlabel.3tsol

getzoneidbylabel.3tsol := LINKSRC = getzonelabelbyid.3tsol
getzonelabelbyname.3tsol := LINKSRC = getzonelabelbyid.3tsol

Expand All @@ -100,9 +101,6 @@ getzonerootbyname.3tsol := LINKSRC = getzonerootbyid.3tsol
htobclear.3tsol := LINKSRC = hextob.3tsol
htobsl.3tsol := LINKSRC = hextob.3tsol

Xbcleartos.3tsol := LINKSRC = labelclipping.3tsol
Xbsltos.3tsol := LINKSRC = labelclipping.3tsol

m_label_alloc.3tsol := LINKSRC = m_label.3tsol
m_label_dup.3tsol := LINKSRC = m_label.3tsol
m_label_free.3tsol := LINKSRC = m_label.3tsol
Expand Down
Expand Up @@ -3,7 +3,7 @@
.\" 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.
.\" 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.
.\" 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]
.TH GETLABEL 2 "Jul 20, 2007"
.TH GETLABEL 3TSOL "Dec 3, 2017"
.SH NAME
getlabel, fgetlabel \- get file sensitivity label
.SH SYNOPSIS
Expand All @@ -25,7 +25,6 @@ getlabel, fgetlabel \- get file sensitivity label
.fi

.SH DESCRIPTION
.sp
.LP
The \fBgetlabel()\fR function obtains the sensitivity label of the file that is
named by \fIpath\fR. Discretionary read, write or execute permission to the
Expand All @@ -42,12 +41,10 @@ The \fIlabel_p\fR argument is a pointer to an opaque label structure. The
caller must allocate space for \fIlabel_p\fR by using
\fBm_label_alloc\fR(3TSOL).
.SH RETURN VALUES
.sp
.LP
Upon successful completion, \fBgetlabel()\fR and \fBfgetlabel()\fR return 0.
Otherwise they return \(mi1 and set \fBerrno\fR to indicate the error.
.SH ERRORS
.sp
.LP
The \fBgetlabel()\fR function will fail if:
.sp
Expand Down Expand Up @@ -148,7 +145,6 @@ An \fBI/O\fR error occurred while reading from or writing to the file system.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
Expand All @@ -164,7 +160,6 @@ Interface Stability Committed
.TE

.SH SEE ALSO
.sp
.LP
\fBopen\fR(2), \fBpathconf\fR(2), \fBm_label_alloc\fR(3TSOL),
\fBattributes\fR(5), \fBlabels\fR(5)
Expand All @@ -173,7 +168,6 @@ Interface Stability Committed
\fIObtaining a File Label\fR in \fISolaris Trusted Extensions Developer\&'s
Guide\fR
.SH NOTES
.sp
.LP
The functionality described on this manual page is available only if the system
is configured with Trusted Extensions.

0 comments on commit b8e5ecd

Please sign in to comment.