freebsd-dev/sbin/fsirand/fsirand.8

.\" Copyright (c) 1997 Todd C. Miller <Todd.Miller@courtesan.com>
.\" 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.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgment:
.\"	This product includes software developed by Todd C. Miller.
.\" 4. The name of the author may not be used to endorse or promote products
.\"    derived from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED ``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 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.
.\"
.\"	$OpenBSD: fsirand.8,v 1.6 1997/02/23 03:58:26 millert Exp $
.\"
.Dd January 25, 1997
.Dt FSIRAND 8
.Os
.Sh NAME
.Nm fsirand
.Nd randomize inode generation numbers
.Sh SYNOPSIS
.Nm
.Op Fl b
.Op Fl f
.Op Fl p
.Ar special
.Op Ar "special ..."
.Sh DESCRIPTION
The
.Nm
utility installs random generation numbers on all the inodes for
each file system specified on the command line by
.Ar special .
This increases the security of NFS-exported file systems by making
it difficult to ``guess'' filehandles.
.Pp
.Em Note :
.Xr newfs 8
now does the equivalent of
.Nm
itself so it is no longer necessary to
run
.Nm
by hand on a new file system.
It is only used to
re-randomize or report on an existing file system.
.Pp
The
.Nm
utility should only be used on an unmounted file system that
has been checked with
.Xr fsck 8
or a file system that is mounted read-only.
The
.Nm
utility may be used on the root file system in single-user mode
but the system should be rebooted via ``reboot -n'' afterwards.
.Sh OPTIONS
The available options are as follows:
.Bl -tag -width indent
.It Fl b
Use the default block size (usually 512 bytes) instead
of the value gleaned from the disklabel.
.It Fl f
Force
.Nm
to run even if the file system on
.Ar special
is not marked as clean.
.It Fl p
Print the current generation numbers for all inodes instead of
generating new ones.
.El
.Sh SEE ALSO
.Xr fs 5 ,
.Xr fsck 8 ,
.Xr newfs 8
.Sh HISTORY
The
.Nm
utility appeared in SunOS 3.x.
.Pp
This version of
.Nm
first appeared in
.Ox 2.1 .
.Pp
A
.Fx
version first appeared in
.Fx 2.2.5 .
.Sh AUTHORS
.An Todd C. Miller Aq Mt Todd.Miller@courtesan.com
.Sh CAVEATS
Since
.Nm
allocates enough memory to hold all the inodes in
a given cylinder group it may use a large amount
of memory for large disks with few cylinder groups.
Add generation number randomization. Newly created filesystems wil now automatically have random generation numbers. The kenel way of handling those also changed. Further it is advised to run fsirand on all your nfs exported filesystems. the code is mostly copied from OpenBSD, with the randomization chanegd to use /dev/urandom Reviewed by: Garrett Obtained from: OpenBSD 1997-03-23 20:08:22 +00:00			`.\" Copyright (c) 1997 Todd C. Miller <Todd.Miller@courtesan.com>`
			`.\" 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.`
			`.\" 3. All advertising materials mentioning features or use of this software`
Do not dot terminate SEE ALSO list. Add rcsid, remove unused #includes. Err(3) messages should start with a lowercase letter. 1998-06-30 06:18:44 +00:00			`.\" must display the following acknowledgment:`
Add generation number randomization. Newly created filesystems wil now automatically have random generation numbers. The kenel way of handling those also changed. Further it is advised to run fsirand on all your nfs exported filesystems. the code is mostly copied from OpenBSD, with the randomization chanegd to use /dev/urandom Reviewed by: Garrett Obtained from: OpenBSD 1997-03-23 20:08:22 +00:00			`.\" This product includes software developed by Todd C. Miller.`
			`.\" 4. The name of the author may not be used to endorse or promote products`
			`.\" derived from this software without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED ``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 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.`
			`.\"`
			`.\" $OpenBSD: fsirand.8,v 1.6 1997/02/23 03:58:26 millert Exp $`
			`.\"`
			`.Dd January 25, 1997`
			`.Dt FSIRAND 8`
			`.Os`
			`.Sh NAME`
			`.Nm fsirand`
			`.Nd randomize inode generation numbers`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 16:52:27 +00:00			`.Nm`
Add generation number randomization. Newly created filesystems wil now automatically have random generation numbers. The kenel way of handling those also changed. Further it is advised to run fsirand on all your nfs exported filesystems. the code is mostly copied from OpenBSD, with the randomization chanegd to use /dev/urandom Reviewed by: Garrett Obtained from: OpenBSD 1997-03-23 20:08:22 +00:00			`.Op Fl b`
			`.Op Fl f`
			`.Op Fl p`
			`.Ar special`
			`.Op Ar "special ..."`
			`.Sh DESCRIPTION`
			`The`
Do not dot terminate SEE ALSO list. Add rcsid, remove unused #includes. Err(3) messages should start with a lowercase letter. 1998-06-30 06:18:44 +00:00			`.Nm`
The .Nm utility 2002-07-06 19:34:18 +00:00			`utility installs random generation numbers on all the inodes for`
s/filesystem/file system/g as discussed on -developers 2002-08-21 18:11:48 +00:00			`each file system specified on the command line by`
Add generation number randomization. Newly created filesystems wil now automatically have random generation numbers. The kenel way of handling those also changed. Further it is advised to run fsirand on all your nfs exported filesystems. the code is mostly copied from OpenBSD, with the randomization chanegd to use /dev/urandom Reviewed by: Garrett Obtained from: OpenBSD 1997-03-23 20:08:22 +00:00			`.Ar special .`
s/filesystem/file system/g as discussed on -developers 2002-08-21 18:11:48 +00:00			`This increases the security of NFS-exported file systems by making`
Add generation number randomization. Newly created filesystems wil now automatically have random generation numbers. The kenel way of handling those also changed. Further it is advised to run fsirand on all your nfs exported filesystems. the code is mostly copied from OpenBSD, with the randomization chanegd to use /dev/urandom Reviewed by: Garrett Obtained from: OpenBSD 1997-03-23 20:08:22 +00:00			it difficult to ``guess'' filehandles.
			`.Pp`
mdoc(7) police: Removed redundant .Ns calls. 2002-08-13 16:07:28 +00:00			`.Em Note :`
Add generation number randomization. Newly created filesystems wil now automatically have random generation numbers. The kenel way of handling those also changed. Further it is advised to run fsirand on all your nfs exported filesystems. the code is mostly copied from OpenBSD, with the randomization chanegd to use /dev/urandom Reviewed by: Garrett Obtained from: OpenBSD 1997-03-23 20:08:22 +00:00			`.Xr newfs 8`
			`now does the equivalent of`
			`.Nm`
Typo fix (now how did that one get by me :-). Submitted by: Philippe Charnier 1997-03-27 00:27:50 +00:00			`itself so it is no longer necessary to`
Add generation number randomization. Newly created filesystems wil now automatically have random generation numbers. The kenel way of handling those also changed. Further it is advised to run fsirand on all your nfs exported filesystems. the code is mostly copied from OpenBSD, with the randomization chanegd to use /dev/urandom Reviewed by: Garrett Obtained from: OpenBSD 1997-03-23 20:08:22 +00:00			`run`
			`.Nm`
Mechanically kill hard sentence breaks. 2004-07-02 21:45:06 +00:00			`by hand on a new file system.`
			`It is only used to`
s/filesystem/file system/g as discussed on -developers 2002-08-21 18:11:48 +00:00			`re-randomize or report on an existing file system.`
Add generation number randomization. Newly created filesystems wil now automatically have random generation numbers. The kenel way of handling those also changed. Further it is advised to run fsirand on all your nfs exported filesystems. the code is mostly copied from OpenBSD, with the randomization chanegd to use /dev/urandom Reviewed by: Garrett Obtained from: OpenBSD 1997-03-23 20:08:22 +00:00			`.Pp`
The .Nm utility 2002-07-06 19:34:18 +00:00			`The`
			`.Nm`
s/filesystem/file system/g as discussed on -developers 2002-08-21 18:11:48 +00:00			`utility should only be used on an unmounted file system that`
Add generation number randomization. Newly created filesystems wil now automatically have random generation numbers. The kenel way of handling those also changed. Further it is advised to run fsirand on all your nfs exported filesystems. the code is mostly copied from OpenBSD, with the randomization chanegd to use /dev/urandom Reviewed by: Garrett Obtained from: OpenBSD 1997-03-23 20:08:22 +00:00			`has been checked with`
			`.Xr fsck 8`
s/filesystem/file system/g as discussed on -developers 2002-08-21 18:11:48 +00:00			`or a file system that is mounted read-only.`
The .Nm utility 2002-07-06 19:34:18 +00:00			`The`
			`.Nm`
s/filesystem/file system/g as discussed on -developers 2002-08-21 18:11:48 +00:00			`utility may be used on the root file system in single-user mode`
Add generation number randomization. Newly created filesystems wil now automatically have random generation numbers. The kenel way of handling those also changed. Further it is advised to run fsirand on all your nfs exported filesystems. the code is mostly copied from OpenBSD, with the randomization chanegd to use /dev/urandom Reviewed by: Garrett Obtained from: OpenBSD 1997-03-23 20:08:22 +00:00			but the system should be rebooted via ``reboot -n'' afterwards.
			`.Sh OPTIONS`
			`The available options are as follows:`
mdoc: make pages render with mandoc It's a bit more pedantic regarding .Bl list elements. This has an added benefit of unbreaking the ipfw(8) manpage, where groff was silently skipping one list element. 2010-10-21 12:27:13 +00:00			`.Bl -tag -width indent`
Add generation number randomization. Newly created filesystems wil now automatically have random generation numbers. The kenel way of handling those also changed. Further it is advised to run fsirand on all your nfs exported filesystems. the code is mostly copied from OpenBSD, with the randomization chanegd to use /dev/urandom Reviewed by: Garrett Obtained from: OpenBSD 1997-03-23 20:08:22 +00:00			`.It Fl b`
Typo police. Also update HISTORY to reflect when this first appeared in FreeBSD. 1997-03-24 20:50:57 +00:00			`Use the default block size (usually 512 bytes) instead`
Add generation number randomization. Newly created filesystems wil now automatically have random generation numbers. The kenel way of handling those also changed. Further it is advised to run fsirand on all your nfs exported filesystems. the code is mostly copied from OpenBSD, with the randomization chanegd to use /dev/urandom Reviewed by: Garrett Obtained from: OpenBSD 1997-03-23 20:08:22 +00:00			`of the value gleaned from the disklabel.`
			`.It Fl f`
			`Force`
			`.Nm`
s/filesystem/file system/g as discussed on -developers 2002-08-21 18:11:48 +00:00			`to run even if the file system on`
Add generation number randomization. Newly created filesystems wil now automatically have random generation numbers. The kenel way of handling those also changed. Further it is advised to run fsirand on all your nfs exported filesystems. the code is mostly copied from OpenBSD, with the randomization chanegd to use /dev/urandom Reviewed by: Garrett Obtained from: OpenBSD 1997-03-23 20:08:22 +00:00			`.Ar special`
			`is not marked as clean.`
			`.It Fl p`
			`Print the current generation numbers for all inodes instead of`
			`generating new ones.`
Prepare for mdoc(7)NG. 2000-12-18 15:16:24 +00:00			`.El`
Add generation number randomization. Newly created filesystems wil now automatically have random generation numbers. The kenel way of handling those also changed. Further it is advised to run fsirand on all your nfs exported filesystems. the code is mostly copied from OpenBSD, with the randomization chanegd to use /dev/urandom Reviewed by: Garrett Obtained from: OpenBSD 1997-03-23 20:08:22 +00:00			`.Sh SEE ALSO`
			`.Xr fs 5 ,`
			`.Xr fsck 8 ,`
Do not dot terminate SEE ALSO list. Add rcsid, remove unused #includes. Err(3) messages should start with a lowercase letter. 1998-06-30 06:18:44 +00:00			`.Xr newfs 8`
Add generation number randomization. Newly created filesystems wil now automatically have random generation numbers. The kenel way of handling those also changed. Further it is advised to run fsirand on all your nfs exported filesystems. the code is mostly copied from OpenBSD, with the randomization chanegd to use /dev/urandom Reviewed by: Garrett Obtained from: OpenBSD 1997-03-23 20:08:22 +00:00			`.Sh HISTORY`
			`The`
			`.Nm`
The .Nm utility 2002-07-06 19:34:18 +00:00			`utility appeared in SunOS 3.x.`
Avoid use of direct troff requests in mdoc(7) manual pages. 2000-11-10 17:46:15 +00:00			`.Pp`
Add generation number randomization. Newly created filesystems wil now automatically have random generation numbers. The kenel way of handling those also changed. Further it is advised to run fsirand on all your nfs exported filesystems. the code is mostly copied from OpenBSD, with the randomization chanegd to use /dev/urandom Reviewed by: Garrett Obtained from: OpenBSD 1997-03-23 20:08:22 +00:00			`This version of`
			`.Nm`
			`first appeared in`
Typo police. Also update HISTORY to reflect when this first appeared in FreeBSD. 1997-03-24 20:50:57 +00:00			`.Ox 2.1 .`
Avoid use of direct troff requests in mdoc(7) manual pages. 2000-11-10 17:46:15 +00:00			`.Pp`
Typo police. Also update HISTORY to reflect when this first appeared in FreeBSD. 1997-03-24 20:50:57 +00:00			`A`
Fix various man pages to stop abusing the .Bx macro to generate the strings "FreeBSD" and "NetBSD". Use the .Fx or .Nx macro instead. 2000-01-23 01:30:05 +00:00			`.Fx`
Typo police. Also update HISTORY to reflect when this first appeared in FreeBSD. 1997-03-24 20:50:57 +00:00			`version first appeared in`
Update HISTORY to reflect that this will first appear in 2.2.5. 1997-03-27 18:47:05 +00:00			`.Fx 2.2.5 .`
.Sh AUTHOR -> .Sh AUTHORS. Use .An/.Aq. 1998-03-19 07:46:04 +00:00			`.Sh AUTHORS`
use .Mt to mark up email addresses consistently (part1) PR: 191174 Submitted by: Franco Fichtner <franco@lastsummer.de> 2014-06-20 09:40:43 +00:00			`.An Todd C. Miller Aq Mt Todd.Miller@courtesan.com`
mdoc: move CAVEATS, BUGS and SECURITY CONSIDERATIONS sections to the bottom of the manpages and order them consistently. GNU groff doesn't care about the ordering, and doesn't even mention CAVEATS and SECURITY CONSIDERATIONS as common sections and where to put them. Found by: mdocml lint run Reviewed by: ru 2010-05-13 12:07:55 +00:00			`.Sh CAVEATS`
			`Since`
			`.Nm`
			`allocates enough memory to hold all the inodes in`
			`a given cylinder group it may use a large amount`
			`of memory for large disks with few cylinder groups.`