| openpam_subst.3 (228692) | openpam_subst.3 (236109) |
|---|---|
| 1.\"- 2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc. 3.\" Copyright (c) 2004-2011 Dag-Erling Sm��rgrav 4.\" All rights reserved. 5.\" 6.\" This software was developed for the FreeBSD Project by ThinkSec AS and 7.\" Network Associates Laboratories, the Security Research Division of 8.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 --- 20 unchanged lines hidden (view full) --- 29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33.\" SUCH DAMAGE. 34.\" 35.\" $Id$ 36.\" | 1.\"- 2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc. 3.\" Copyright (c) 2004-2011 Dag-Erling Sm��rgrav 4.\" All rights reserved. 5.\" 6.\" This software was developed for the FreeBSD Project by ThinkSec AS and 7.\" Network Associates Laboratories, the Security Research Division of 8.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 --- 20 unchanged lines hidden (view full) --- 29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33.\" SUCH DAMAGE. 34.\" 35.\" $Id$ 36.\" |
| 37.Dd December 18, 2011 | 37.Dd May 26, 2012 |
| 38.Dt OPENPAM_SUBST 3 39.Os 40.Sh NAME 41.Nm openpam_subst 42.Nd substitute PAM item values in a string 43.Sh LIBRARY 44.Lb libpam 45.Sh SYNOPSIS 46.In sys/types.h 47.In security/pam_appl.h 48.In security/openpam.h 49.Ft "int" 50.Fn openpam_subst "const pam_handle_t *pamh" "char *buf" "size_t *bufsize" "const char *template" 51.Sh DESCRIPTION 52The | 38.Dt OPENPAM_SUBST 3 39.Os 40.Sh NAME 41.Nm openpam_subst 42.Nd substitute PAM item values in a string 43.Sh LIBRARY 44.Lb libpam 45.Sh SYNOPSIS 46.In sys/types.h 47.In security/pam_appl.h 48.In security/openpam.h 49.Ft "int" 50.Fn openpam_subst "const pam_handle_t *pamh" "char *buf" "size_t *bufsize" "const char *template" 51.Sh DESCRIPTION 52The |
| 53.Nm | 53.Fn openpam_subst |
| 54function expands a string, substituting PAM item 55values for all occurrences of specific substitution codes. 56The 57.Fa template 58argument points to the initial string. 59The result is stored in the buffer pointed to by the 60.Fa buf 61argument; the --- 6 unchanged lines hidden (view full) --- 68.Pp 69If 70.Fa buf 71is NULL, or if the buffer is too small to hold the expanded 72string, 73.Fa bufsize 74is updated to reflect the amount of space required to 75hold the entire string, and | 54function expands a string, substituting PAM item 55values for all occurrences of specific substitution codes. 56The 57.Fa template 58argument points to the initial string. 59The result is stored in the buffer pointed to by the 60.Fa buf 61argument; the --- 6 unchanged lines hidden (view full) --- 68.Pp 69If 70.Fa buf 71is NULL, or if the buffer is too small to hold the expanded 72string, 73.Fa bufsize 74is updated to reflect the amount of space required to 75hold the entire string, and |
| 76.Nm | 76.Fn openpam_subst |
| 77returns 78.Dv PAM_TRY_AGAIN . 79.Pp 80If | 77returns 78.Dv PAM_TRY_AGAIN . 79.Pp 80If |
| 81.Nm | 81.Fn openpam_subst |
| 82fails for any other reason, the 83.Fa bufsize 84argument is 85untouched, but part of the buffer may still have been overwritten. 86.Pp 87Substitution codes are introduced by a percent character and correspond 88to PAM items: 89.Bl -tag -width 18n --- 17 unchanged lines hidden (view full) --- 107Replaced by the current value of the 108.Dv PAM_RUSER 109item. 110.It \&%u 111Replaced by the current value of the 112.Dv PAM_USER 113item. 114.El | 82fails for any other reason, the 83.Fa bufsize 84argument is 85untouched, but part of the buffer may still have been overwritten. 86.Pp 87Substitution codes are introduced by a percent character and correspond 88to PAM items: 89.Bl -tag -width 18n --- 17 unchanged lines hidden (view full) --- 107Replaced by the current value of the 108.Dv PAM_RUSER 109item. 110.It \&%u 111Replaced by the current value of the 112.Dv PAM_USER 113item. 114.El |
| 115.Pp | |
| 116.Sh RETURN VALUES 117The | 115.Sh RETURN VALUES 116The |
| 118.Nm | 117.Fn openpam_subst |
| 119function returns one of the following values: 120.Bl -tag -width 18n 121.It Bq Er PAM_SYSTEM_ERR 122System error. 123.It Bq Er PAM_TRY_AGAIN 124Try again. 125.El 126.Sh SEE ALSO 127.Xr pam 3 , 128.Xr pam_get_authtok 3 , 129.Xr pam_get_item 3 , 130.Xr pam_get_user 3 , 131.Xr pam_strerror 3 132.Sh STANDARDS 133The | 118function returns one of the following values: 119.Bl -tag -width 18n 120.It Bq Er PAM_SYSTEM_ERR 121System error. 122.It Bq Er PAM_TRY_AGAIN 123Try again. 124.El 125.Sh SEE ALSO 126.Xr pam 3 , 127.Xr pam_get_authtok 3 , 128.Xr pam_get_item 3 , 129.Xr pam_get_user 3 , 130.Xr pam_strerror 3 131.Sh STANDARDS 132The |
| 134.Nm | 133.Fn openpam_subst |
| 135function is an OpenPAM extension. 136.Sh AUTHORS 137The | 134function is an OpenPAM extension. 135.Sh AUTHORS 136The |
| 138.Nm 139function and this manual page were developed for the 140.Fx 141Project by 142.An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org . | 137.Fn openpam_subst 138function and this manual page were 139developed by 140.An Dag-Erling Sm\(/orgrav Aq des@des.no . |