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

Document progname in settings

Browse Source
This commit is contained in:
Todd C. Miller
2010-03-19 07:56:06 -04:00
parent eec5235d19
commit 18cd91d56e
3 changed files with 77 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

138
doc/sudo_plugin.cat
View File

@@ -61,7 +61,7 @@ SSuuddoo PPlluuggiinn AAPPII
1.8.0a1 March 17, 2010 1 1.8.0a1 March 19, 2010 1
@@ -127,7 +127,7 @@ SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
1.8.0a1 March 17, 2010 2 1.8.0a1 March 19, 2010 2
@@ -193,7 +193,7 @@ SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
1.8.0a1 March 17, 2010 3 1.8.0a1 March 19, 2010 3
@@ -210,6 +210,10 @@ SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
Authentication type, if specified by the -a flag, to use on Authentication type, if specified by the -a flag, to use on
systems where BSD authentication is supported. systems where BSD authentication is supported.
progname=string
The command name that sudo was run as, typically "sudo" or
"sudoedit".
Additional settings may be added in the future so the plugin Additional settings may be added in the future so the plugin
should silently ignore settings that it does not recognize. should silently ignore settings that it does not recognize.
@@ -252,14 +256,10 @@ SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
is no terminal device available, a default value of 24 is is no terminal device available, a default value of 24 is
used. used.
cols=int
The number of columns the user's terminal supports. If
there is no terminal device available, a default value of
80 is used.
1.8.0a1 March 17, 2010 4 1.8.0a1 March 19, 2010 4
@@ -268,6 +268,11 @@ SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m) SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
cols=int
The number of columns the user's terminal supports. If
there is no terminal device available, a default value of
80 is used.
user_env user_env
The user's environment in the form of a NULL-terminated vector The user's environment in the form of a NULL-terminated vector
of "name=value" strings. of "name=value" strings.
@@ -317,15 +322,10 @@ SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
SUDO_CONF_ERROR_MSG to present additional error information to the SUDO_CONF_ERROR_MSG to present additional error information to the
user. user.
The function arguments are as follows:
argc
The number of elements in _a_r_g_v, not counting the final NULL
pointer.
1.8.0a1 March 17, 2010 5 1.8.0a1 March 19, 2010 5
@@ -334,6 +334,12 @@ SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m) SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
The function arguments are as follows:
argc
The number of elements in _a_r_g_v, not counting the final NULL
pointer.
argv argv
The argument vector describing the command the user wishes to The argument vector describing the command the user wishes to
run, in the same form as what would be passed to the _e_x_e_c_v_e_(_) run, in the same form as what would be passed to the _e_x_e_c_v_e_(_)
@@ -382,16 +388,10 @@ SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
login_class=login_class login_class=login_class
BSD login class to use when setting resource limits and BSD login class to use when setting resource limits and
nice value (optional). This option is only set on systems
that support login classes.
preserve_groups=bool
If set, ssuuddoo will preserve the user's group vector instead
of initializing the group vector based on runas_user.
1.8.0a1 March 17, 2010 6 1.8.0a1 March 19, 2010 6
@@ -400,6 +400,13 @@ SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m) SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
nice value (optional). This option is only set on systems
that support login classes.
preserve_groups=bool
If set, ssuuddoo will preserve the user's group vector instead
of initializing the group vector based on runas_user.
cwd=string cwd=string
The current working directory to change to when executing The current working directory to change to when executing
the command. the command.
@@ -447,17 +454,10 @@ SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
List available privileges for the invoking user. Returns 1 on List available privileges for the invoking user. Returns 1 on
success, 0 on failure and -1 on error. On error, the plugin may success, 0 on failure and -1 on error. On error, the plugin may
optionally call the conversation function with SUDO_CONF_ERROR_MSG optionally call the conversation function with SUDO_CONF_ERROR_MSG
to present additional error information to the user.
Privileges should be output via the conversation function using
SUDO_CONV_INFO_MSG.
verbose
Flag indicating whether to list in verbose mode or not.
1.8.0a1 March 17, 2010 7 1.8.0a1 March 19, 2010 7
@@ -466,6 +466,14 @@ SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m) SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
to present additional error information to the user.
Privileges should be output via the conversation function using
SUDO_CONV_INFO_MSG.
verbose
Flag indicating whether to list in verbose mode or not.
list_user list_user
The name of a different user to list privileges for if the The name of a different user to list privileges for if the
policy allows it. If NULL, the plugin should list the policy allows it. If NULL, the plugin should list the
@@ -512,18 +520,10 @@ SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
_C_o_n_v_e_r_s_a_t_i_o_n _A_P_I _C_o_n_v_e_r_s_a_t_i_o_n _A_P_I
If the plugin needs to interact with the user or display informational
or error messages, it may do so via the conversation function. A
plugin should not attempt to read directly from the standard input or
the user's tty (neither of which are guaranteed to exist). The caller
must include a trailing newline in msg if they want one to be printed.
1.8.0a1 March 19, 2010 8
1.8.0a1 March 17, 2010 8
@@ -532,6 +532,12 @@ SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m) SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
If the plugin needs to interact with the user or display informational
or error messages, it may do so via the conversation function. A
plugin should not attempt to read directly from the standard input or
the user's tty (neither of which are guaranteed to exist). The caller
must include a trailing newline in msg if they want one to be printed.
struct sudo_conv_message { struct sudo_conv_message {
#define SUDO_CONV_PROMPT_ECHO_OFF 1 #define SUDO_CONV_PROMPT_ECHO_OFF 1
#define SUDO_CONV_PROMPT_ECHO_ON 2 #define SUDO_CONV_PROMPT_ECHO_ON 2
@@ -580,16 +586,10 @@ SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
disabled, such as passwords). The log_output function receives output disabled, such as passwords). The log_output function receives output
from the pseudo-tty that is suitable for replaying the user's session from the pseudo-tty that is suitable for replaying the user's session
at a later time. Either log_input or log_output may be NULL. If the at a later time. Either log_input or log_output may be NULL. If the
open function returns 0, no I/O will be sent to the plugin.
The io_plugin struct has the following fields:
type
The type field should always be set to SUDO_IO_PLUGIN
1.8.0a1 March 17, 2010 9 1.8.0a1 March 19, 2010 9
@@ -598,6 +598,13 @@ SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m) SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
open function returns 0, no I/O will be sent to the plugin.
The io_plugin struct has the following fields:
type
The type field should always be set to SUDO_IO_PLUGIN
version version
The version field should be set to SUDO_API_VERSION. The version field should be set to SUDO_API_VERSION.
@@ -646,16 +653,9 @@ SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
the form of "name=value" strings. The vector is terminated by the form of "name=value" strings. The vector is terminated by
a NULL pointer. a NULL pointer.
When parsing _u_s_e_r___i_n_f_o, the plugin should split on the ffiirrsstt
equal sign ('=') since the _n_a_m_e field will never include one
itself but the _v_a_l_u_e might.
See the "Policy Plugin API" section for a list of all possible
strings.
1.8.0a1 March 19, 2010 10
1.8.0a1 March 17, 2010 10
@@ -664,6 +664,13 @@ SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m) SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
When parsing _u_s_e_r___i_n_f_o, the plugin should split on the ffiirrsstt
equal sign ('=') since the _n_a_m_e field will never include one
itself but the _v_a_l_u_e might.
See the "Policy Plugin API" section for a list of all possible
strings.
user_env user_env
The user's environment in the form of a NULL-terminated vector The user's environment in the form of a NULL-terminated vector
of "name=value" strings. of "name=value" strings.
@@ -711,17 +718,10 @@ SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
The function arguments are as follows: The function arguments are as follows:
buf The buffer containing user input.
len The length of _b_u_f in bytes.
log_output
int (*log_output)(const char *buf, unsigned int len);
1.8.0a1 March 19, 2010 11
1.8.0a1 March 17, 2010 11
@@ -730,6 +730,13 @@ SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m) SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
buf The buffer containing user input.
len The length of _b_u_f in bytes.
log_output
int (*log_output)(const char *buf, unsigned int len);
The _l_o_g___o_u_t_p_u_t function is called whenever data can be read from The _l_o_g___o_u_t_p_u_t function is called whenever data can be read from
the command but before it is written to the user's terminal. This the command but before it is written to the user's terminal. This
allows the plugin to reject data if it chooses to (for instance if allows the plugin to reject data if it chooses to (for instance if
@@ -780,13 +787,6 @@ SUDO_PLUGIN(1m) MAINTENANCE COMMANDS SUDO_PLUGIN(1m)
1.8.0a1 March 19, 2010 12
1.8.0a1 March 17, 2010 12

5
doc/sudo_plugin.man.in
View File

@@ -139,7 +139,7 @@
.\" ======================================================================== .\" ========================================================================
.\" .\"
.IX Title "SUDO_PLUGIN @mansectsu@" .IX Title "SUDO_PLUGIN @mansectsu@"
.TH SUDO_PLUGIN @mansectsu@ "March 17, 2010" "1.8.0a1" "MAINTENANCE COMMANDS" .TH SUDO_PLUGIN @mansectsu@ "March 19, 2010" "1.8.0a1" "MAINTENANCE COMMANDS"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents. .\" way too many mistakes in technical documents.
.if n .ad l .if n .ad l
@@ -321,6 +321,9 @@ the \f(CW\*(C`\-t\*(C'\fR flag.
.IX Item "bsdauth_type=string" .IX Item "bsdauth_type=string"
Authentication type, if specified by the \f(CW\*(C`\-a\*(C'\fR flag, to use on Authentication type, if specified by the \f(CW\*(C`\-a\*(C'\fR flag, to use on
systems where \s-1BSD\s0 authentication is supported. systems where \s-1BSD\s0 authentication is supported.
.IP "progname=string" 4
.IX Item "progname=string"
The command name that sudo was run as, typically \*(L"sudo\*(R" or \*(L"sudoedit\*(R".
.RE .RE
.RS 4 .RS 4
.Sp .Sp

4
doc/sudo_plugin.pod
View File

@@ -212,6 +212,10 @@ the C<-t> flag.
Authentication type, if specified by the C<-a> flag, to use on Authentication type, if specified by the C<-a> flag, to use on
systems where BSD authentication is supported. systems where BSD authentication is supported.
=item progname=string
The command name that sudo was run as, typically "sudo" or "sudoedit".
=back =back
Additional settings may be added in the future so the plugin should Additional settings may be added in the future so the plugin should