From ec7767978f34d2f1507beadaf93f4b489ce4b10d Mon Sep 17 00:00:00 2001 From: "Todd C. Miller" Date: Fri, 16 Mar 2012 14:39:12 -0400 Subject: [PATCH] Document what changed in each plugin API revision --- doc/sudo_plugin.cat | 24 +++++++++++++++++++++++- doc/sudo_plugin.man.in | 24 +++++++++++++++++++++++- doc/sudo_plugin.pod | 31 +++++++++++++++++++++++++++++++ 3 files changed, 77 insertions(+), 2 deletions(-) diff --git a/doc/sudo_plugin.cat b/doc/sudo_plugin.cat index 6ceba0f2f..5ca98e1c9 100644 --- a/doc/sudo_plugin.cat +++ b/doc/sudo_plugin.cat @@ -1282,6 +1282,28 @@ DDEESSCCRRIIPPTTIIOONN *(vp) = (*(vp) & 0xffff0000) | (n); \ } while(0) +PPLLUUGGIINN AAPPII CCHHAANNGGEELLOOGG + The following revisions have been made to the Sudo Plugin API. + + Version 1.0 + Initial API version. + + Version 1.1 + The I/O logging plugin's open function was modified to take the + command_info list as an argument. + + Version 1.2 + The Policy and I/O logging plugins' open functions are now passed a + list of plugin options if any are specified in _/_e_t_c_/_s_u_d_o_._c_o_n_f. + + A simple hooks API has been introduced to allow plugins to hook in + to the system's environment handling functions. + + The init_session Policy plugin function is now passed a pointer to + the user environment which can be updated as needed. This can be + used to merge in environment variables stored in the PAM handle + before a command is run. + SSEEEE AALLSSOO _s_u_d_o_e_r_s(4), _s_u_d_o(1m) @@ -1303,4 +1325,4 @@ DDIISSCCLLAAIIMMEERR -1.8.5 March 15, 2012 SUDO_PLUGIN(1m) +1.8.5b2 March 16, 2012 SUDO_PLUGIN(1m) diff --git a/doc/sudo_plugin.man.in b/doc/sudo_plugin.man.in index 2565f5319..af2ac6177 100644 --- a/doc/sudo_plugin.man.in +++ b/doc/sudo_plugin.man.in @@ -139,7 +139,7 @@ .\" ======================================================================== .\" .IX Title "SUDO_PLUGIN @mansectsu@" -.TH SUDO_PLUGIN @mansectsu@ "March 15, 2012" "1.8.5" "MAINTENANCE COMMANDS" +.TH SUDO_PLUGIN @mansectsu@ "March 16, 2012" "1.8.5b2" "MAINTENANCE COMMANDS" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -1563,6 +1563,28 @@ present in the password database, \fIpwd\fR will be \f(CW\*(C`NULL\*(C'\fR. \& *(vp) = (*(vp) & 0xffff0000) | (n); \e \& } while(0) .Ve +.SH "PLUGIN API CHANGELOG" +.IX Header "PLUGIN API CHANGELOG" +The following revisions have been made to the Sudo Plugin \s-1API\s0. +.IP "Version 1.0" 4 +.IX Item "Version 1.0" +Initial \s-1API\s0 version. +.IP "Version 1.1" 4 +.IX Item "Version 1.1" +The I/O logging plugin's \f(CW\*(C`open\*(C'\fR function was modified to take the +\&\f(CW\*(C`command_info\*(C'\fR list as an argument. +.IP "Version 1.2" 4 +.IX Item "Version 1.2" +The Policy and I/O logging plugins' \f(CW\*(C`open\*(C'\fR functions are now passed +a list of plugin options if any are specified in \fI@sysconfdir@/sudo.conf\fR. +.Sp +A simple hooks \s-1API\s0 has been introduced to allow plugins to hook in to the +system's environment handling functions. +.Sp +The \f(CW\*(C`init_session\*(C'\fR Policy plugin function is now passed a pointer +to the user environment which can be updated as needed. This can +be used to merge in environment variables stored in the \s-1PAM\s0 handle +before a command is run. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fIsudoers\fR\|(@mansectform@), \fIsudo\fR\|(@mansectsu@) diff --git a/doc/sudo_plugin.pod b/doc/sudo_plugin.pod index 642ad9b6e..e4ac03d06 100644 --- a/doc/sudo_plugin.pod +++ b/doc/sudo_plugin.pod @@ -1524,6 +1524,37 @@ present in the password database, I will be C. *(vp) = (*(vp) & 0xffff0000) | (n); \ } while(0) +=head1 PLUGIN API CHANGELOG + +The following revisions have been made to the Sudo Plugin API. + +=over 4 + +=item Version 1.0 + +Initial API version. + +=item Version 1.1 + +The I/O logging plugin's C function was modified to take the +C list as an argument. + +=item Version 1.2 + +The Policy and I/O logging plugins' C functions are now passed +a list of plugin options if any are specified in F<@sysconfdir@/sudo.conf>. + +A simple hooks API has been introduced to allow plugins to hook in to the +system's environment handling functions. + +The C Policy plugin function is now passed a pointer +to the user environment which can be updated as needed. This can +be used to merge in environment variables stored in the PAM handle +before a command is run. + +=back + + =head1 SEE ALSO L, L -- 2.50.1