isa/sudo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Substitute python plugin file name in sudo_plugin_python documentation.

Browse Source 
Also use prefix for group plugin fallback path section in sudoers manual.
This commit is contained in:
Todd C. Miller
2022-12-30 13:38:40 -07:00
parent ad55f8ccee
commit 4b0dc2eecb
6 changed files with 71 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
docs/sudo_plugin_python.man.in
View File

@@ -151,7 +151,7 @@ Running the Python interpreter and bridging between C and Python is
handled by the
\fBsudo\fR
plugin
\fIpython_plugin.so\fR.
\fI@python_plugin@\fR.
This shared object can be loaded like any other dynamic
\fBsudo\fR
plugin and should receive the path and the class name of the Python
@@ -162,10 +162,10 @@ sudo.conf(@mansectform@):
.nf
.sp
.RS 4n
Plugin python_policy python_plugin.so ModulePath=<path> ClassName=<class>
Plugin python_io python_plugin.so ModulePath=<path> ClassName=<class>
Plugin python_audit python_plugin.so ModulePath=<path> ClassName=<class>
Plugin python_approval python_plugin.so ModulePath=<path> ClassName=<class>
Plugin python_policy @python_plugin@ ModulePath=<path> ClassName=<class>
Plugin python_io @python_plugin@ ModulePath=<path> ClassName=<class>
Plugin python_audit @python_plugin@ ModulePath=<path> ClassName=<class>
Plugin python_approval @python_plugin@ ModulePath=<path> ClassName=<class>
.RE
.fi
.PP
@@ -175,7 +175,7 @@ file:
.nf
.sp
.RS 4n
Defaults group_plugin="python_plugin.so ModulePath=<path> ClassName=<class>"
Defaults group_plugin="@python_plugin@ ModulePath=<path> ClassName=<class>"
.RE
.fi
.PP
@@ -210,7 +210,7 @@ For example:
.nf
.sp
.RS 4n
Plugin python_policy python_plugin.so ModulePath=<path> ClassName=<class>
Plugin python_policy @python_plugin@ ModulePath=<path> ClassName=<class>
.RE
.fi
.PP
@@ -568,7 +568,7 @@ To try it, register it by adding the following lines to
.nf
.sp
.RS 0n
Plugin python_policy python_plugin.so \e
Plugin python_policy @python_plugin@ \e
ModulePath=@EXAMPLES@/example_policy_plugin.py \e
ClassName=SudoPolicyPlugin
.RE
@@ -586,7 +586,7 @@ For example:
.nf
.sp
.RS 4n
Plugin python_io python_plugin.so ModulePath=<path> ClassName=<class>
Plugin python_io @python_plugin@ ModulePath=<path> ClassName=<class>
.RE
.fi
.PP
@@ -868,7 +868,7 @@ To try it, register it by adding the following lines to
.nf
.sp
.RS 4n
Plugin python_io python_plugin.so \e
Plugin python_io @python_plugin@ \e
ModulePath=@EXAMPLES@/example_io_plugin.py \e
ClassName=SudoIOPlugin
.RE
@@ -880,7 +880,7 @@ For example:
.nf
.sp
.RS 4n
Plugin python_audit python_plugin.so ModulePath=<path> ClassName=<class>
Plugin python_audit @python_plugin@ ModulePath=<path> ClassName=<class>
.RE
.fi
.PP
@@ -1188,7 +1188,7 @@ To try it, register it by adding the following lines to
.nf
.sp
.RS 4n
Plugin python_audit python_plugin.so \e
Plugin python_audit @python_plugin@ \e
ModulePath=@EXAMPLES@/example_audit_plugin.py \e
ClassName=SudoAuditPlugin
.RE
@@ -1202,7 +1202,7 @@ For example:
.nf
.sp
.RS 4n
Plugin python_approval python_plugin.so ModulePath=<path> ClassName=<class>
Plugin python_approval @python_plugin@ ModulePath=<path> ClassName=<class>
.RE
.fi
.PP
@@ -1332,7 +1332,7 @@ To try it, register it by adding the following lines to
.nf
.sp
.RS 4n
Plugin python_approval python_plugin.so \e
Plugin python_approval @python_plugin@ \e
ModulePath=@EXAMPLES@/example_approval_plugin.py \e
ClassName=BusinessHoursApprovalPlugin
.RE
@@ -1348,7 +1348,7 @@ For example:
.nf
.sp
.RS 4n
Defaults group_plugin="python_plugin.so ModulePath=<path> ClassName=<class>"
Defaults group_plugin="@python_plugin@ ModulePath=<path> ClassName=<class>"
.RE
.fi
.PP
@@ -1429,7 +1429,7 @@ file by adding the following lines:
.nf
.sp
.RS 4n
Defaults group_plugin="python_plugin.so \e
Defaults group_plugin="@python_plugin@ \e
ModulePath=@EXAMPLES@/example_group_plugin.py \e
ClassName=SudoGroupPlugin"
.RE
@@ -1590,7 +1590,7 @@ To try it, register it by adding the following lines to
.nf
.sp
.RS 4n
Plugin python_io python_plugin.so \e
Plugin python_io @python_plugin@ \e
ModulePath=@EXAMPLES@/example_conversation.py \e
ClassName=ReasonLoggerIOPlugin
.RE
@@ -1644,14 +1644,14 @@ To enable debug messages, add a
line to
sudo.conf(@mansectform@)
with the program set to
\fIpython_plugin.so\fR.
\fI@python_plugin@\fR.
For example, to store debug output in
\fI@log_dir@/sudo_python_debug\fR,
use a line like the following:
.nf
.sp
.RS 4n
Debug python_plugin.so @log_dir@/sudo_python_debug \e
Debug @python_plugin@ @log_dir@/sudo_python_debug \e
plugin@trace,c_calls@trace
.RE
.fi
@@ -1666,7 +1666,7 @@ calls, use:
.nf
.sp
.RS 4n
Debug python_plugin.so @log_dir@/sudo_python_debug plugin@trace
Debug @python_plugin@ @log_dir@/sudo_python_debug plugin@trace
.RE
.fi
.PP
@@ -1769,11 +1769,11 @@ To try it, register it by adding the following lines to
.nf
.sp
.RS 4n
Plugin python_io python_plugin.so \e
Plugin python_io @python_plugin@ \e
ModulePath=@EXAMPLES@/example_debugging.py \e
ClassName=DebugDemoPlugin
Debug python_plugin.so \e
Debug @python_plugin@ \e
@log_dir@/sudo_python_debug plugin@trace,c_calls@trace
.RE
.fi
@@ -1872,7 +1872,7 @@ If you believe you have found a bug in
you can submit a bug report at https://bugzilla.sudo.ws/
.SH "SECURITY CONSIDERATIONS"
All Python plugin handling is implemented inside the
\fIpython_plugin.so\fR
\fI@python_plugin@\fR
dynamic plugin.
Therefore, if no Python plugin is registered in
sudo.conf(@mansectform@)