Collapse gd_astpending and gd_reqpri together into gd_reqflags. gd_reqflags
[dragonfly.git] / lib / libposix1e / posix1e.3
1 .\"-
2 .\" Copyright (c) 2000 Robert N. M. Watson
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\"
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 .\" SUCH DAMAGE.
25 .\"
26 .\" $FreeBSD: src/lib/libposix1e/posix1e.3,v 1.3.2.6 2001/12/20 16:27:06 ru Exp $
27 .\" $DragonFly: src/lib/libposix1e/posix1e.3,v 1.2 2003/06/17 04:26:51 dillon Exp $
28 .\"
29 .Dd January 17, 2000
30 .Dt POSIX1E 3
31 .Os
32 .Sh NAME
33 .Nm posix1e
34 .Nd introduction to the POSIX.1e security API
35 .Sh LIBRARY
36 .Lb libposix1e
37 .Sh SYNOPSIS
38 .In sys/types.h
39 .In sys/acl.h
40 .In sys/audit.h
41 .In sys/capability.h
42 .In sys/mac.h
43 .Sh DESCRIPTION
44 The IEEE POSIX.1e specification never left draft form, but the interfaces
45 it describes are now widely used despite inherent limitations.  Currently,
46 only a few of the interfaces and features are implemented in
47 .Fx ,
48 although efforts are underway to complete the integration at this time.
49 .Pp
50 POSIX.1e describes five security extensions to the base POSIX.1 API:
51 Access Control Lists (ACLs), Auditing, Capabilities, Mandatory Access
52 Control, and Information Flow Labels.  Of these, the ACL interfaces are
53 currently included with
54 .Fx ,
55 Auditing, Capabilities, and Mandatory
56 Access Control are in the wings, and Information Flow Labels are not on
57 the calendar.
58 .Pp
59 POSIX.1e defines both syntax and semantics for these features, but fairly
60 substantial changes are required to implement these features in the
61 operating system.  As shipped,
62 .Fx 4.0
63 permits file systems to export
64 Access Control Lists via the VFS, and provides a library for userland
65 access to and manipulation of these ACLs, but support for ACLs is not
66 provided by any file systems shipped in the base operating system.
67 Available API calls relating to ACLs are described in detail in
68 .Xr acl 3 .
69 .Pp
70 The patches supporting other POSIX.1e features are not available in the
71 base operating system at this time--however, more information on them
72 may be found on the FreeBSD POSIX.1e implementation web page:
73 .Pp
74 http://www.watson.org/fbsd-hardening/posix1e/
75 .Sh IMPLEMENTATION NOTES
76 .Fx Ns 's
77 support for POSIX.1e interfaces and features is still under
78 development at this time.
79 .Sh ENVIRONMENT
80 POSIX.1e assigns security labels to all objects, extending the security
81 functionality described in POSIX.1.  These additional labels provide
82 fine-grained discretionary access control, fine-grained capabilities,
83 and labels necessary for mandatory access control.  POSIX.2c describes
84 a set of userland utilities for manipulating these labels.  These userland
85 utilities are not bundled with
86 .Fx 4.0
87 so as to discourage their
88 use in the short term.
89 .Sh FILES
90 .Sh SEE ALSO
91 .Xr acl 3 ,
92 .Xr acl 9 ,
93 .Xr extattr 9
94 .Sh STANDARDS
95 POSIX.1e is described in IEEE POSIX.1e draft 17.  Discussion
96 of the draft continues on the cross-platform POSIX.1e implementation
97 mailing list.  To join this list, see the
98 .Fx
99 POSIX.1e implementation
100 page for more information.
101 .Sh HISTORY
102 POSIX.1e support was introduced in
103 .Fx 4.0 ,
104 and development continues.
105 .Sh AUTHORS
106 .An Robert N M Watson ,
107 .An Ilmar S Habibulin
108 .Sh BUGS
109 These features are not yet fully implemented.  In particular, the shipped
110 version of UFS/FFS does not support storage of additional security labels,
111 and so is unable to (easily) provide support for most of these features.