d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
445516e4e0
freebsd-dev/usr.sbin/extattrctl/extattrctl.8

161 lines
4.9 KiB
Groff
Raw Normal View History

Introduced /usr/sbin/extattrctl, a utility for managing UFS/FFS extended attributes (recently committed). Using extattrctl, the extended attribute service may be started and stopped for specific file systems; specific attributes may be enabled or disabled, and the backing file for each attribute configured. Also, backing files may be initialized. Reviewed by: adrian, bp, freebsd-fs, the unthanked masses Obtained from: TrustedBSD
2000-04-15 05:14:39 +00:00
.\"-
.\" Copyright (c) 2000 Robert N. M. Watson
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd March 30, 2000
.Dt EXTATTRCTL 8
Minor mdoc markup fixes. Reviewed by: maintainer
2000-05-10 14:50:44 +00:00
.Os
Introduced /usr/sbin/extattrctl, a utility for managing UFS/FFS extended attributes (recently committed). Using extattrctl, the extended attribute service may be started and stopped for specific file systems; specific attributes may be enabled or disabled, and the backing file for each attribute configured. Also, backing files may be initialized. Reviewed by: adrian, bp, freebsd-fs, the unthanked masses Obtained from: TrustedBSD
2000-04-15 05:14:39 +00:00
.Sh NAME
.Nm extattrctl
Minor mdoc markup fixes. Reviewed by: maintainer
2000-05-10 14:50:44 +00:00
.Nd manage FFS extended attributes
Introduced /usr/sbin/extattrctl, a utility for managing UFS/FFS extended attributes (recently committed). Using extattrctl, the extended attribute service may be started and stopped for specific file systems; specific attributes may be enabled or disabled, and the backing file for each attribute configured. Also, backing files may be initialized. Reviewed by: adrian, bp, freebsd-fs, the unthanked masses Obtained from: TrustedBSD
2000-04-15 05:14:39 +00:00
.Sh SYNOPSIS
.Nm extattrctl
.Cm start
.Ar path
.Nm extattrctl
.Cm stop
.Ar path
.Nm extattrctl
.Cm initattr
o What a good idea, ``-o'' should be a ``-f'' like in every other utility that is cautious but sometimes you want to be less cautious. Go figure. Submitted by: sheldonh
2000-09-12 14:35:48 +00:00
.Op Fl f
o Other half of Sheldon's patch to fix initattr arguments, mistakenly forgotten due to minimal sleep. Thanks! Submitted by: sheldonh
2000-07-12 12:04:02 +00:00
.Op Fl p Ar path
Introduced /usr/sbin/extattrctl, a utility for managing UFS/FFS extended attributes (recently committed). Using extattrctl, the extended attribute service may be started and stopped for specific file systems; specific attributes may be enabled or disabled, and the backing file for each attribute configured. Also, backing files may be initialized. Reviewed by: adrian, bp, freebsd-fs, the unthanked masses Obtained from: TrustedBSD
2000-04-15 05:14:39 +00:00
.Ar attrsize
.Ar attrfile
.Nm extattrctl
.Cm enable
.Ar path
.Ar attrname
.Ar attrfile
.Nm extattrctl
.Cm disable
.Ar path
.Ar attrname
.Sh DESCRIPTION
.Nm
is the management utility for extended attributes over the FFS file system.
.Nm
allows the starting and stopping of extended attributes on a file system,
as well as initialization of attribute backing files, and enabling and
disabling of specific extended attributes on a file system.
.Pp
The first argument on the command line indicates the operation to be
Whitespace-only: remove the only hard sentence break in the file.
2000-09-04 08:58:41 +00:00
performed.
Operation must be one of the following:
Introduced /usr/sbin/extattrctl, a utility for managing UFS/FFS extended attributes (recently committed). Using extattrctl, the extended attribute service may be started and stopped for specific file systems; specific attributes may be enabled or disabled, and the backing file for each attribute configured. Also, backing files may be initialized. Reviewed by: adrian, bp, freebsd-fs, the unthanked masses Obtained from: TrustedBSD
2000-04-15 05:14:39 +00:00
.Bl -tag -width indent
.It Cm start Ar path
Start extended attribute support on the file system named using
.Ar path .
The file system must be an FFS file system, and the FFS_EXTATTR kernel
option must have been enabled.
.It Cm stop Ar path
Stop extended attribute support on the file system named using
.Ar path .
Extended attribute support must previously have been started.
o Update extattrctl.8 to reflect new initattr -p, -r, and -w options. o Update extattrctl.c to default new attributes to readable and writable only by the kernel and root user. Previously the default was to allow the file owner to directory view and manipulate the attributes, which is probably an inappropriate default.
2000-04-20 20:32:43 +00:00
.It Xo
.Cm initattr
o What a good idea, ``-o'' should be a ``-f'' like in every other utility that is cautious but sometimes you want to be less cautious. Go figure. Submitted by: sheldonh
2000-09-12 14:35:48 +00:00
.Op Fl f
o Update extattrctl.8 to reflect new initattr -p, -r, and -w options. o Update extattrctl.c to default new attributes to readable and writable only by the kernel and root user. Previously the default was to allow the file owner to directory view and manipulate the attributes, which is probably an inappropriate default.
2000-04-20 20:32:43 +00:00
.Op Fl p Ar path
.Ar attrsize attrfile
.Xc
Introduced /usr/sbin/extattrctl, a utility for managing UFS/FFS extended attributes (recently committed). Using extattrctl, the extended attribute service may be started and stopped for specific file systems; specific attributes may be enabled or disabled, and the backing file for each attribute configured. Also, backing files may be initialized. Reviewed by: adrian, bp, freebsd-fs, the unthanked masses Obtained from: TrustedBSD
2000-04-15 05:14:39 +00:00
Create and initialize a file to use as an attribute backing file.
You must specify a maximum per-inode size for the attribute in bytes in
.Ar attrsize ,
as well as the file where the attribute will be stored, using
.Ar attrfile .
o Update extattrctl.8 to reflect new initattr -p, -r, and -w options. o Update extattrctl.c to default new attributes to readable and writable only by the kernel and root user. Previously the default was to allow the file owner to directory view and manipulate the attributes, which is probably an inappropriate default.
2000-04-20 20:32:43 +00:00
.Pp
The
o What a good idea, ``-o'' should be a ``-f'' like in every other utility that is cautious but sometimes you want to be less cautious. Go figure. Submitted by: sheldonh
2000-09-12 14:35:48 +00:00
.Fl f
o Add a ``-o'' argument to initattr, which causes extattrctl to overwrite the existing attribute file rather than aborting with an error. o Useful if you want to reset the state of attributes on the system without allocating different disk blocks through deletion and recreation, for example, if you're doing benchmarks of extended attribute code. :-) Obtained from: TrustedBSD Project
2000-09-12 04:40:34 +00:00
argument may be used to indicate that it is alright to overwrite an
existing attribute backing file; otherwise, if the target file exists,
an error will be returned.
.Pp
The
o Update extattrctl.8 to reflect new initattr -p, -r, and -w options. o Update extattrctl.c to default new attributes to readable and writable only by the kernel and root user. Previously the default was to allow the file owner to directory view and manipulate the attributes, which is probably an inappropriate default.
2000-04-20 20:32:43 +00:00
.Fl p Ar path
argument may be used to preallocate space for all attributes rather than
relying on sparse files to conserve space.
This has the advantage of guaranteeing that space will be available
for attributes when they are written, preventing low disk space conditions
from denying attribute service.
.Pp
Introduced /usr/sbin/extattrctl, a utility for managing UFS/FFS extended attributes (recently committed). Using extattrctl, the extended attribute service may be started and stopped for specific file systems; specific attributes may be enabled or disabled, and the backing file for each attribute configured. Also, backing files may be initialized. Reviewed by: adrian, bp, freebsd-fs, the unthanked masses Obtained from: TrustedBSD
2000-04-15 05:14:39 +00:00
This file should not exist before running
.Cm initattr.
.It Cm enable Ar path Ar attrname Ar attrfile
Enable an attribute named
.Ar attrname
on the file system identified using
.Ar path ,
and backed by initialized attribute file
.Ar attrfile .
The backing file must have been initialized using
.Cm initattr
before its first use.
Attributes must have been started on the file system prior to the
enabling of any attributes.
.It Cm disable Ar path Ar attrname
Disable the attributed named
.Ar attrname
on the file system identified by
.Ar path .
The file system must have attributes started on it, and the attribute
most have been enabled using
.Cm enable .
.Sh EXAMPLES
.Pp
.Dl extattrctl start /
.Pp
Start extended attributes on the root file system.
.Pp
.Dl extattrctl initattr 17 /.attribute/md5
.Pp
Create an attribute backing file in /.attribute/md5, and set the maximum
Modify extended attribute protection model to authorize based on attribute namespace and DAC protection on file: - Attribute names beginning with '$' are in the system namespace - The attribute name "$" is reserved - System namespace attributes may only be read/set by suser() or by kernel (cred == NULL) - Other attribute names are in the application namespace - The attribute name "" is reserved - Application namespace attributes are protected in the manner of the target file permission o Kernel changes - Add ufs_extattr_valid_attrname() to check whether the requested attribute "set" or "enable" is appropriate (i.e., non-reserved) - Modify ufs_extattr_credcheck() to accept target file vnode, not to take inode uid - Modify ufs_extattr_credcheck() to check namespace, then enforce either kernel/suser for system namespace, or vaccess() for application namespace o EA backing file format changes - Remove permission fields from extended attribute backing file header - Bump extended attribute backing file header version to 3 o Update extattrctl.c and extattrctl.8 - Remove now deprecated -r and -w arguments to initattr, as permissions are now implicit - (unrelated) fix error reporting and unlinking during failed initattr to remove duplicate/inaccurate error messages, and to only unlink if the failure wasn't in the backing file open() Obtained from: TrustedBSD Project
2000-09-02 20:31:26 +00:00
size of each attribute to 17 bytes, with a sparse file used for storing
the attributes.
Introduced /usr/sbin/extattrctl, a utility for managing UFS/FFS extended attributes (recently committed). Using extattrctl, the extended attribute service may be started and stopped for specific file systems; specific attributes may be enabled or disabled, and the backing file for each attribute configured. Also, backing files may be initialized. Reviewed by: adrian, bp, freebsd-fs, the unthanked masses Obtained from: TrustedBSD
2000-04-15 05:14:39 +00:00
.Pp
.Dl extattrctl enable / md5 /.attribute/md5
.Pp
Enable an attribute named md5 on the root file system, backed from the file
/.attribute/md5.
.Pp
.Dl extattrctl disable / md5
.Pp
Disable the attribute named md5 on the root file system.
.Pp
.Dl extattrctl stop /
.Pp
Stop extended attributes on the root file system.
.Sh SEE ALSO
.Xr getextattr 8 ,
.Xr setextattr 8 ,
.Xr extattr 9
.Sh HISTORY
Extended attribute support was developed as part of the TrustedBSD Project,
Change "FreeBSD 5.0" to ".Fx 5.0"
2000-04-16 01:43:11 +00:00
and introduced in
.Fx 5.0 .
Introduced /usr/sbin/extattrctl, a utility for managing UFS/FFS extended attributes (recently committed). Using extattrctl, the extended attribute service may be started and stopped for specific file systems; specific attributes may be enabled or disabled, and the backing file for each attribute configured. Also, backing files may be initialized. Reviewed by: adrian, bp, freebsd-fs, the unthanked masses Obtained from: TrustedBSD
2000-04-15 05:14:39 +00:00
It was developed to support security extensions requiring additional labels
to be associated with each file or directory.
.Sh AUTHORS
Robert N M Watson
Reference in New Issue Copy Permalink