Introduce userland utilities to set and get extended attributes. These

utilities do not present the world's greatest interface, and will
undoubtably change soon.  However, they do let people experiment with
extended attributes, and provide samples of how to use the syscalls.

Obtained from:	TrustedBSD
This commit is contained in:
Robert Watson 2000-04-16 20:55:50 +00:00
parent 300451c472
commit 166eb62fe2
4 changed files with 342 additions and 0 deletions

View File

@ -0,0 +1,88 @@
.\"-
.\" 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 GETEXTATTR 8
.Os FreeBSD 5.0
.Sh NAME
.Nm getextattr
.Nd retrieve a named extended attribute
.Sh SYNOPSIS
.Nm getextattr
.Op Fl s
.Op Ar attrname
.Op Ar filename ...
.Sh DESCRIPTION
.Nm
is a user tool to retrieve a named extended attribute on a file or
directory. The
.Ar attrname
argument should be the name of the attribute, and
.Ar filename
a list of files and directories from which to retrieve attribute data.
If the
.Op Fl s
flag is specified,
.Nm
will attempt to display the attribute data as a string, although the
results may not look pretty if the data is binary data.
The
.Xr strvisx 3
function is used to generate the string, so control sequences should
be safely escaped.
Otherwise, the attribute data will be represented as a series of two-digit
hex numbers.
In order for
.Nm
to succeed, the attribute service must be available on the file system,
and the attribute must of defined for the file queried.
.Sh EXAMPLES
.Pp
.Bd -literal -offset indent
# getextattr md5 /kernel
/kernel:
61 61 33 62 39 39 66 65 31 35 35 32 31 62 65 32
62 36 38 36 62 31 66 39 63 64 33 39 35 36 36 31
# getextattr -s md5 /kernel
/kernel: "aa3b99fe15521be2b686b1f9cd395661"
.Ed
.Pp
Retrieve the ``md5'' extended attribute for the file /kernel.
.Sh SEE ALSO
.Xr extattrctl 8 ,
.Xr setextattr 8 ,
.Xr extattr 9
.Sh HISTORY
Extended attribute support was developed as part of the TrustedBSD Project,
and introduced in FreeBSD 5.0.
It was developed to support security extensions requiring additional labels
to be associated with each file or directory.
.Sh AUTHORS
Robert N M Watson
.Sh BUGS
Only the first 2048 bytes of the extended attribute value are displayed
due to a hard-coded buffer limit.

View File

@ -0,0 +1,115 @@
/*-
* Copyright (c) 1999, 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$
*/
/*
* TrustedBSD Project - extended attribute support
*/
#include <sys/types.h>
#include <sys/uio.h>
#include <sys/extattr.h>
#include <stdio.h>
#include <unistd.h>
#include <vis.h>
void
usage(void)
{
fprintf(stderr, "getextattr [-s] [attrname] [filename ...]\n");
exit(-1);
}
extern char *optarg;
extern int optind;
#define BUFSIZE 2048
int
main(int argc, char *argv[])
{
struct iovec iov_buf;
char *attrname;
char buf[BUFSIZE];
char visbuf[BUFSIZE*4];
int error, i, arg_counter;
int ch;
int flag_as_string = 0;
while ((ch = getopt(argc, argv, "s")) != -1) {
switch (ch) {
case 's':
flag_as_string = 1;
break;
case '?':
default:
usage();
}
}
argc -= optind;
argv += optind;
if (argc <= 1)
usage();
attrname = argv[0];
argc--;
argv++;
iov_buf.iov_base = buf;
iov_buf.iov_len = BUFSIZE;
for (arg_counter = 0; arg_counter < argc; arg_counter++) {
error = extattr_get_file(argv[arg_counter], attrname,
&iov_buf, 1);
if (error == -1)
perror(argv[arg_counter]);
else {
printf("%s:", argv[arg_counter]);
if (flag_as_string) {
strvisx(visbuf, buf, error, VIS_SAFE
| VIS_WHITE);
printf(" \"%s\"\n", visbuf);
} else {
for (i = 0; i < error; i++)
if (i % 16 == 0)
printf("\n %02x ", buf[i]);
else if (i % 8 == 0)
printf(" %02x ", buf[i]);
else
printf("%02x ", buf[i]);
printf("\n");
}
}
}
return (0);
}

View File

@ -0,0 +1,75 @@
.\"-
.\" 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 SETEXTATTR 8
.Os FreeBSD 5.0
.Sh NAME
.Nm setextattr
.Nd set a named extended attribute
.Sh SYNOPSIS
.Nm setextattr
.Ar attrname
.Ar filename
.Ar attrvalue
.Sh DESCRIPTION
.Nm
is a user tool to set a named extended attribute on a file or directory to
the provided string.
The
.Ar attrname
argument should be the name of the attribute,
.Ar filename
the name of the file or directory to set the attribute for, and
.Ar attrvalue
a string to store in the attribute.
.Nm
will store the string in the file's attribute.
In order for
.Nm
to succeed, the attribute service must be available on the file system,
and appropriate privilege may be required.
.Sh EXAMPLES
.Pp
.Dl # setextattr md5 /kernel `md5 -q /kernel`
.Pp
Set the ``md5'' extended attribute on the file /kernel to the string
containing the output of ``md5 -q /kernel''.
.Sh SEE ALSO
.Xr extattrctl 8 ,
.Xr getextattr 8 ,
.Xr extattr 9
.Sh HISTORY
Extended attribute support was developed as part of the TrustedBSD Project,
and introduced in FreeBSD 5.0.
It was developed to support security extensions requiring additional labels
to be associated with each file or directory.
.Sh AUTHORS
Robert N M Watson
.Sh BUGS
.Nm
can only be used to set attributes to strings.

View File

@ -0,0 +1,64 @@
/*-
* Copyright (c) 1999, 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$
*/
/*
* TrustedBSD Project - extended attribute support for UFS-like file systems
*/
#include <sys/types.h>
#include <sys/uio.h>
#include <sys/extattr.h>
#include <stdio.h>
void
usage(void)
{
fprintf(stderr, "setextattr [attrname] [filename] [attrvalue]\n");
exit(-1);
}
int
main(int argc, char *argv[])
{
struct iovec iov_buf;
int error;
if (argc != 4)
usage();
iov_buf.iov_base = argv[3];
iov_buf.iov_len = strlen(argv[3]);
error = extattr_set_file(argv[2], argv[1], &iov_buf, 1);
if (error == -1) {
perror("extattr_set_file");
return (-1);
}
return (0);
}