X-Git-Url: https://git.decadent.org.uk/gitweb/?p=nfs-utils.git;a=blobdiff_plain;f=utils%2Fstatd%2Fsm-notify.8;h=dd03b8dabbc15507316882136ab167694c96e312;hp=314e2c454ceff9623e0838173c723fd99d705bf2;hb=7ed3ed034b9cda6c51ee7b506b7f845b6effb861;hpb=a6970289026e18fcb51f1305df96d868d94dae78

diff --git a/utils/statd/sm-notify.8 b/utils/statd/sm-notify.8
index 314e2c4..dd03b8d 100644
--- a/utils/statd/sm-notify.8
+++ b/utils/statd/sm-notify.8
@@ -6,7 +6,7 @@
 .SH NAME
 sm-notify \- Send out NSM reboot notifications
 .SH SYNOPSIS
-.BI "/sbin/sm-notify [-d] [-q] [-m " time "] [-p " port "] [-P " path "] [-v " my_name " ]
+.BI "/sbin/sm-notify [-dfq] [-m " time "] [-p " port "] [-P " path "] [-v " my_name " ]
 .SH DESCRIPTION
 File locking over NFS (v2 and v3) requires a facility to notify peers in
 case of a reboot, so that clients can reclaim locks after
@@ -50,6 +50,22 @@ in
 .BR /var/lib/nfs/state ,
 and updated by
 .BR sm-notify .
+.SS Security
+.B sm-notify
+has little need for root privileges and so drops them as soon as
+possible.
+It continues to need to make changes to the
+.B sm
+and
+.B sm.bak
+directories so to be able to drop privileges, these must be writable
+by a non-privileged user.  If these directories are owned by a
+non-root user,
+.B sm-notify
+will drop privilege to match that user once it has created sockets for
+sending out request (for which it needs privileged) but before it
+processes any reply (which is the most likely source of possible
+privilege abuse).
 .SH OPTIONS
 .TP
 .BI -m " failtime
@@ -101,8 +117,31 @@ and the file
 .B state
 must exist in that directory with the standard names.
 .TP
+.B -f
+If the state path has not been reset with
+.BR -P ,
+.B sm-notify
+will normally create a file in
+.B /var/run
+to indicate that it has been
+run.  If this file is found when
+.B sm-notify
+starts, it will not run again (as it is normally only needed once per
+reboot).
+If
+.B -f
+(for
+.BR force )
+is given,
+.B sm-notify
+will run even if the file in
+.B /var/run
+is present.
+.TP
 .B -n
-Do not update the NSM state. This is for testing only.
+Do not update the NSM state. This is for testing only.  Setting this
+flag implies
+.BR -f .
 .TP
 .B -d
 Enables debugging.
@@ -117,6 +156,8 @@ list of hosts from
 .BR /var/lib/nfs/sm/*
 .br
 .BR /var/lib/nfs/sm.bak/*
+.br
+.BR /var/run/sm-notify.pid
 .SH SEE ALSO
 .BR rpc.nfsd(8),
 .BR portmap(8)