Document sudoedit_checkdir

diff --git a/doc/sudo_plugin.cat b/doc/sudo_plugin.cat
index d04e4171d01ef3e2c98d6d010a1cbd99fd4b513f..c20fae1524852822548c3f6eac1f33b229b3ebec 100644 (file)
--- a/doc/sudo_plugin.cat
+++ b/doc/sudo_plugin.cat
@@ -611,6 +611,19 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
                        substitution and transparently enable _\bs_\bu_\bd_\bo_\be_\bd_\bi_\bt when the
                        user attempts to run an editor.
 
+                 sudoedit_checkdir=bool
+                       Set to false to disable directory writability checks in
+                       s\bsu\bud\bdo\boe\bed\bdi\bit\bt.  By default, s\bsu\bud\bdo\boe\bed\bdi\bit\bt 1.8.16 and higher will
+                       check all directory components of the path to be edited
+                       for writability by the invoking user.  Symbolic links
+                       will not be followed in writable directories and
+                       s\bsu\bud\bdo\boe\bed\bdi\bit\bt will refuse to edit a file located in a
+                       writable directory.  These restrictions are not
+                       enforced when s\bsu\bud\bdo\boe\bed\bdi\bit\bt is run by root.  The
+                       _\bs_\bu_\bd_\bo_\be_\bd_\bi_\bt_\b__\bf_\bo_\bl_\bl_\bo_\bw option can be set to false to disable
+                       this check.  Only available starting with API version
+                       1.8.
+
                  sudoedit_follow=bool
                        Set to true to allow s\bsu\bud\bdo\boe\bed\bdi\bit\bt to edit files that are
                        symbolic links.  By default, s\bsu\bud\bdo\boe\bed\bdi\bit\bt 1.8.15 and higher
@@ -1502,7 +1515,9 @@ P\bPL\bLU\bUG\bGI\bIN\bN A\bAP\bPI\bI C\bCH\bHA\bAN\bNG\bGE\bEL\bLO\bOG\bG
            Debug lines in the sudo.conf(4) file.
 
      Version 1.8 (sudo 1.8.15)
-           The _\bs_\bu_\bd_\bo_\be_\bd_\bi_\bt_\b__\bf_\bo_\bl_\bl_\bo_\bw entry was added to the command_info list.
+           The _\bs_\bu_\bd_\bo_\be_\bd_\bi_\bt_\b__\bc_\bh_\be_\bc_\bk_\bd_\bi_\br and _\bs_\bu_\bd_\bo_\be_\bd_\bi_\bt_\b__\bf_\bo_\bl_\bl_\bo_\bw entries were added to the
+           command_info list.  The default value of _\bs_\bu_\bd_\bo_\be_\bd_\bi_\bt_\b__\bc_\bh_\be_\bc_\bk_\bd_\bi_\br was
+           changed to true in sudo 1.8.16.
 
            The sudo _\bc_\bo_\bn_\bv_\be_\br_\bs_\ba_\bt_\bi_\bo_\bn function now takes a pointer to a struct
            sudo_conv_callback as its fourth argument.  The sudo_conv_t
@@ -1542,4 +1557,4 @@ D\bDI\bIS\bSC\bCL\bLA\bAI\bIM\bME\bER\bR
      file distributed with s\bsu\bud\bdo\bo or https://www.sudo.ws/license.html for
      complete details.
 
-Sudo 1.8.16                     January 4, 2016                    Sudo 1.8.16
+Sudo 1.8.16                    January 20, 2016                    Sudo 1.8.16

diff --git a/doc/sudo_plugin.man.in b/doc/sudo_plugin.man.in
index bf14f56f113e700b8cec45aae84383c1b760e48b..67e5c16dae91c1c393ae69d6c8e4b9af6a1fe19a 100644 (file)
--- a/doc/sudo_plugin.man.in
+++ b/doc/sudo_plugin.man.in
@@ -16,7 +16,7 @@
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.TH "SUDO_PLUGIN" "5" "January 4, 2016" "Sudo @PACKAGE_VERSION@" "File Formats Manual"
+.TH "SUDO_PLUGIN" "5" "January 20, 2016" "Sudo @PACKAGE_VERSION@" "File Formats Manual"
 .nh
 .if n .ad l
 .SH "NAME"
@@ -1010,6 +1010,24 @@ enable
 \fIsudoedit\fR
 when the user attempts to run an editor.
 .TP 6n
+sudoedit_checkdir=bool
+Set to false to disable directory writability checks in
+\fBsudoedit\fR.
+By default,
+\fBsudoedit\fR
+1.8.16 and higher will check all directory components of the path to be
+edited for writability by the invoking user.
+Symbolic links will not be followed in writable directories and
+\fBsudoedit\fR
+will refuse to edit a file located in a writable directory.
+These restrictions are not enforced when
+\fBsudoedit\fR
+is run by root.
+The
+\fIsudoedit_follow\fR
+option can be set to false to disable this check.
+Only available starting with API version 1.8.
+.TP 6n
 sudoedit_follow=bool
 Set to true to allow
 \fBsudoedit\fR
@@ -2699,10 +2717,15 @@ sudo.conf(@mansectform@) file.
 .TP 6n
 Version 1.8 (sudo 1.8.15)
 The
+\fIsudoedit_checkdir\fR
+and
 \fIsudoedit_follow\fR
-entry was added to the
+entries were added to the
 \fRcommand_info\fR
 list.
+The default value of
+\fIsudoedit_checkdir\fR
+was changed to true in sudo 1.8.16.
 .sp
 The sudo
 \fIconversation\fR

diff --git a/doc/sudo_plugin.mdoc.in b/doc/sudo_plugin.mdoc.in
index 9f9250d0cd42704f2914c03869e98ae6dda96117..87c933324b456878ee255efdc5639c39352fd2e8 100644 (file)
--- a/doc/sudo_plugin.mdoc.in
+++ b/doc/sudo_plugin.mdoc.in
@@ -14,7 +14,7 @@
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd January 4, 2016
+.Dd January 20, 2016
 .Dt SUDO_PLUGIN @mansectform@
 .Os Sudo @PACKAGE_VERSION@
 .Sh NAME
@@ -891,6 +891,23 @@ This allows the plugin to perform command substitution and transparently
 enable
 .Em sudoedit
 when the user attempts to run an editor.
+.It sudoedit_checkdir=bool
+Set to false to disable directory writability checks in
+.Nm sudoedit .
+By default,
+.Nm sudoedit
+1.8.16 and higher will check all directory components of the path to be
+edited for writability by the invoking user.
+Symbolic links will not be followed in writable directories and
+.Nm sudoedit
+will refuse to edit a file located in a writable directory.
+These restrictions are not enforced when
+.Nm sudoedit
+is run by root.
+The
+.Em sudoedit_follow
+option can be set to false to disable this check.
+Only available starting with API version 1.8.
 .It sudoedit_follow=bool
 Set to true to allow
 .Nm sudoedit
@@ -2362,10 +2379,15 @@ times if there are multiple plugin-specific Debug lines in the
 .Xr sudo.conf @mansectform@ file.
 .It Version 1.8 (sudo 1.8.15)
 The
+.Em sudoedit_checkdir
+and
 .Em sudoedit_follow
-entry was added to the
+entries were added to the
 .Li command_info
 list.
+The default value of
+.Em sudoedit_checkdir
+was changed to true in sudo 1.8.16.
 .Pp
 The sudo
 .Em conversation