From 6caa43088478ff9e6c8839e30b1c4ad863260662 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dag-Erling=20Sm=C3=B8rgrav?= Date: Mon, 27 May 2002 18:23:03 +0000 Subject: [PATCH] Revamp the man page generation process. Delete the generated man pages as they are now regenerated automatically by the distribution script. Sponsored by: DARPA, NAI Labs git-svn-id: svn+ssh://svn.openpam.org/svn/openpam/trunk@152 185d5e19-27fe-0310-9dcf-9bff6b9f3609 --- MANIFEST | 4 +- dist.sh | 8 +- doc/man/Makefile | 100 ++++++++------ doc/man/openpam_borrow_cred.3 | 90 ------------- doc/man/openpam_free_data.3 | 73 ---------- doc/man/openpam_get_option.3 | 75 ----------- doc/man/openpam_log.3 | 64 --------- doc/man/openpam_nullconv.3 | 97 -------------- doc/man/openpam_restore_cred.3 | 83 ------------ doc/man/openpam_set_option.3 | 78 ----------- doc/man/openpam_ttyconv.3 | 92 ------------- doc/man/pam.3 | 237 --------------------------------- doc/man/pam_acct_mgmt.3 | 110 --------------- doc/man/pam_authenticate.3 | 123 ----------------- doc/man/pam_chauthtok.3 | 115 ---------------- doc/man/pam_close_session.3 | 105 --------------- doc/man/pam_end.3 | 83 ------------ doc/man/pam_error.3 | 83 ------------ doc/man/pam_get_authtok.3 | 128 ------------------ doc/man/pam_get_data.3 | 92 ------------- doc/man/pam_get_item.3 | 124 ----------------- doc/man/pam_get_user.3 | 105 --------------- doc/man/pam_getenv.3 | 81 ----------- doc/man/pam_getenvlist.3 | 102 -------------- doc/man/pam_info.3 | 83 ------------ doc/man/pam_open_session.3 | 105 --------------- doc/man/pam_prompt.3 | 95 ------------- doc/man/pam_putenv.3 | 86 ------------ doc/man/pam_set_data.3 | 97 -------------- doc/man/pam_set_item.3 | 90 ------------- doc/man/pam_setcred.3 | 118 ---------------- doc/man/pam_setenv.3 | 85 ------------ doc/man/pam_sm_acct_mgmt.3 | 100 -------------- doc/man/pam_sm_authenticate.3 | 102 -------------- doc/man/pam_sm_chauthtok.3 | 102 -------------- doc/man/pam_sm_close_session.3 | 94 ------------- doc/man/pam_sm_open_session.3 | 94 ------------- doc/man/pam_sm_setcred.3 | 100 -------------- doc/man/pam_start.3 | 111 --------------- doc/man/pam_strerror.3 | 77 ----------- doc/man/pam_verror.3 | 87 ------------ doc/man/pam_vinfo.3 | 87 ------------ doc/man/pam_vprompt.3 | 123 ----------------- misc/gendoc.pl | 159 +++++++++++++++++----- 44 files changed, 186 insertions(+), 4061 deletions(-) delete mode 100644 doc/man/openpam_borrow_cred.3 delete mode 100644 doc/man/openpam_free_data.3 delete mode 100644 doc/man/openpam_get_option.3 delete mode 100644 doc/man/openpam_log.3 delete mode 100644 doc/man/openpam_nullconv.3 delete mode 100644 doc/man/openpam_restore_cred.3 delete mode 100644 doc/man/openpam_set_option.3 delete mode 100644 doc/man/openpam_ttyconv.3 delete mode 100644 doc/man/pam.3 delete mode 100644 doc/man/pam_acct_mgmt.3 delete mode 100644 doc/man/pam_authenticate.3 delete mode 100644 doc/man/pam_chauthtok.3 delete mode 100644 doc/man/pam_close_session.3 delete mode 100644 doc/man/pam_end.3 delete mode 100644 doc/man/pam_error.3 delete mode 100644 doc/man/pam_get_authtok.3 delete mode 100644 doc/man/pam_get_data.3 delete mode 100644 doc/man/pam_get_item.3 delete mode 100644 doc/man/pam_get_user.3 delete mode 100644 doc/man/pam_getenv.3 delete mode 100644 doc/man/pam_getenvlist.3 delete mode 100644 doc/man/pam_info.3 delete mode 100644 doc/man/pam_open_session.3 delete mode 100644 doc/man/pam_prompt.3 delete mode 100644 doc/man/pam_putenv.3 delete mode 100644 doc/man/pam_set_data.3 delete mode 100644 doc/man/pam_set_item.3 delete mode 100644 doc/man/pam_setcred.3 delete mode 100644 doc/man/pam_setenv.3 delete mode 100644 doc/man/pam_sm_acct_mgmt.3 delete mode 100644 doc/man/pam_sm_authenticate.3 delete mode 100644 doc/man/pam_sm_chauthtok.3 delete mode 100644 doc/man/pam_sm_close_session.3 delete mode 100644 doc/man/pam_sm_open_session.3 delete mode 100644 doc/man/pam_sm_setcred.3 delete mode 100644 doc/man/pam_start.3 delete mode 100644 doc/man/pam_strerror.3 delete mode 100644 doc/man/pam_verror.3 delete mode 100644 doc/man/pam_vinfo.3 delete mode 100644 doc/man/pam_vprompt.3 diff --git a/MANIFEST b/MANIFEST index bdbff5a..54f2846 100644 --- a/MANIFEST +++ b/MANIFEST @@ -1,5 +1,5 @@ # -# $P4: //depot/projects/openpam/MANIFEST#9 $ +# $P4: //depot/projects/openpam/MANIFEST#10 $ # CREDITS HISTORY @@ -14,6 +14,7 @@ bin/su/Makefile bin/su/su.c doc/Makefile doc/man/Makefile +doc/man/openpam.3 doc/man/openpam_borrow_cred.3 doc/man/openpam_free_data.3 doc/man/openpam_get_option.3 @@ -22,7 +23,6 @@ doc/man/openpam_nullconv.3 doc/man/openpam_restore_cred.3 doc/man/openpam_set_option.3 doc/man/openpam_ttyconv.3 -doc/man/pam.3 doc/man/pam_acct_mgmt.3 doc/man/pam_authenticate.3 doc/man/pam_chauthtok.3 diff --git a/dist.sh b/dist.sh index 441bc0e..9701985 100644 --- a/dist.sh +++ b/dist.sh @@ -1,6 +1,6 @@ #!/bin/sh # -# $P4: //depot/projects/openpam/dist.sh#3 $ +# $P4: //depot/projects/openpam/dist.sh#4 $ # set -e @@ -8,10 +8,14 @@ set -e release=$(date '+%Y%m%d') distname="openpam-${release}" +make cleandir +make cleandir +(cd doc/man && make openpam.3) install -d -m 0755 "${distname}" grep -v '^#' MANIFEST | while read file; do install -d -m 0755 "${distname}/$(dirname ${file})" install -c -m 0644 "${file}" "${distname}/${file}" done -tar zcf "/tmp/${distname}.tar.gz" "${distname}" +tar zcf "${distname}.tar.gz" "${distname}" rm -rf "${distname}" +make cleandir diff --git a/doc/man/Makefile b/doc/man/Makefile index d2384b3..e9f254a 100644 --- a/doc/man/Makefile +++ b/doc/man/Makefile @@ -31,52 +31,64 @@ # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF # SUCH DAMAGE. # -# $P4: //depot/projects/openpam/doc/man/Makefile#8 $ +# $P4: //depot/projects/openpam/doc/man/Makefile#9 $ # -MAN = -MAN += openpam_borrow_cred.3 -MAN += openpam_free_data.3 -MAN += openpam_get_option.3 -MAN += openpam_log.3 -MAN += openpam_nullconv.3 -MAN += openpam_restore_cred.3 -MAN += openpam_set_option.3 -MAN += openpam_ttyconv.3 -MAN += pam.3 -MAN += pam_acct_mgmt.3 -MAN += pam_authenticate.3 -MAN += pam_chauthtok.3 -MAN += pam_close_session.3 -MAN += pam_end.3 -MAN += pam_error.3 -MAN += pam_get_authtok.3 -MAN += pam_get_data.3 -MAN += pam_get_item.3 -MAN += pam_get_user.3 -MAN += pam_getenv.3 -MAN += pam_getenvlist.3 -MAN += pam_info.3 -MAN += pam_open_session.3 -MAN += pam_prompt.3 -MAN += pam_putenv.3 -MAN += pam_set_data.3 -MAN += pam_set_item.3 -MAN += pam_setcred.3 -MAN += pam_setenv.3 -MAN += pam_sm_acct_mgmt.3 -MAN += pam_sm_authenticate.3 -MAN += pam_sm_chauthtok.3 -MAN += pam_sm_close_session.3 -MAN += pam_sm_open_session.3 -MAN += pam_sm_setcred.3 -MAN += pam_start.3 -MAN += pam_strerror.3 -MAN += pam_verror.3 -MAN += pam_vinfo.3 -MAN += pam_vprompt.3 +GENDOC = ${.CURDIR}/../../misc/gendoc.pl -generate: - (cd ${.CURDIR} && perl -w ../../misc/gendoc.pl ../../lib/*.c >pam.3) +CMAN = +CMAN += openpam_borrow_cred.3 +CMAN += openpam_free_data.3 +CMAN += openpam_get_option.3 +CMAN += openpam_log.3 +CMAN += openpam_nullconv.3 +CMAN += openpam_restore_cred.3 +CMAN += openpam_set_option.3 +CMAN += openpam_ttyconv.3 +CMAN += pam_acct_mgmt.3 +CMAN += pam_authenticate.3 +CMAN += pam_chauthtok.3 +CMAN += pam_close_session.3 +CMAN += pam_end.3 +CMAN += pam_error.3 +CMAN += pam_get_authtok.3 +CMAN += pam_get_data.3 +CMAN += pam_get_item.3 +CMAN += pam_get_user.3 +CMAN += pam_getenv.3 +CMAN += pam_getenvlist.3 +CMAN += pam_info.3 +CMAN += pam_open_session.3 +CMAN += pam_prompt.3 +CMAN += pam_putenv.3 +CMAN += pam_set_data.3 +CMAN += pam_set_item.3 +CMAN += pam_setcred.3 +CMAN += pam_setenv.3 +CMAN += pam_sm_acct_mgmt.3 +CMAN += pam_sm_authenticate.3 +CMAN += pam_sm_chauthtok.3 +CMAN += pam_sm_close_session.3 +CMAN += pam_sm_open_session.3 +CMAN += pam_sm_setcred.3 +CMAN += pam_start.3 +CMAN += pam_strerror.3 +CMAN += pam_verror.3 +CMAN += pam_vinfo.3 +CMAN += pam_vprompt.3 + +MAN = ${CMAN} +MAN += openpam.3 +MLINKS = openpam.3 pam.3 + +CLEANFILES += ${CMAN} openpam.3 + +.for man in ${CMAN} +${man}: ${.CURDIR}/../../lib/${man:R}.c ${GENDOC} + perl -w ${GENDOC} ${.CURDIR}/../../lib/${man:R}.c +.endfor + +openpam.3: ${CMAN} ${GENDOC} + perl -w ${GENDOC} -s ${CMAN} .include diff --git a/doc/man/openpam_borrow_cred.3 b/doc/man/openpam_borrow_cred.3 deleted file mode 100644 index c7e429c..0000000 --- a/doc/man/openpam_borrow_cred.3 +++ /dev/null @@ -1,90 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/openpam_borrow_cred.3#5 $ -.\" -.Dd May 24, 2002 -.Dt OPENPAM_BORROW_CRED 3 -.Os -.Sh NAME -.Nm openpam_borrow_cred -.Nd temporarily borrow user credentials -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.In security/openpam.h -.Ft int -.Fn openpam_borrow_cred "pam_handle_t *pamh" "const struct passwd *pwd" -.Sh DESCRIPTION -The -.Nm -function saves the current credentials and -switches to those of the user specified by its -.Va pwd -argument. The -affected credentials are the effective UID, the effective GID, and the -group access list. The original credentials can be restored using -.Xr openpam_restore_cred 3 . -.Pp -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_PERM_DENIED -Permission denied. -.It Bq Er PAM_SYSTEM_ERR -System error. -.El -.Sh SEE ALSO -.Xr openpam_restore_cred 3 , -.Xr pam 3 , -.Xr pam_strerror 3 , -.Xr setegid 3 , -.Xr seteuid 3 , -.Xr setgroups 3 -.Sh STANDARDS -The -.Nm -function is an OpenPAM extension. -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/openpam_free_data.3 b/doc/man/openpam_free_data.3 deleted file mode 100644 index d87b06c..0000000 --- a/doc/man/openpam_free_data.3 +++ /dev/null @@ -1,73 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/openpam_free_data.3#5 $ -.\" -.Dd May 24, 2002 -.Dt OPENPAM_FREE_DATA 3 -.Os -.Sh NAME -.Nm openpam_free_data -.Nd generic cleanup function -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.In security/openpam.h -.Ft void -.Fn openpam_free_data "pam_handle_t *pamh" "void *data" "int status" -.Sh DESCRIPTION -The -.Nm -is a cleanup function suitable for passing to -.Xr pam_set_data 3 . -It simply releases the data by passing its -.Va data -argument to -.Xr free 3 . -.Sh SEE ALSO -.Xr free 3 , -.Xr pam 3 , -.Xr pam_set_data 3 -.Sh STANDARDS -The -.Nm -function is an OpenPAM extension. -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/openpam_get_option.3 b/doc/man/openpam_get_option.3 deleted file mode 100644 index 6fd205a..0000000 --- a/doc/man/openpam_get_option.3 +++ /dev/null @@ -1,75 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/openpam_get_option.3#9 $ -.\" -.Dd May 24, 2002 -.Dt OPENPAM_GET_OPTION 3 -.Os -.Sh NAME -.Nm openpam_get_option -.Nd returns the value of a module option -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.In security/openpam.h -.Ft const char * -.Fn openpam_get_option "pam_handle_t *pamh" "const char *option" -.Sh DESCRIPTION -The -.Nm -function returns the value of the specified -option in the context of the currently executing service module, or -.Dv NULL -if the option is not set or no module is currently executing. -.Sh RETURN VALUES -The -.Nm -function returns -.Dv NULL -on failure. -.Sh SEE ALSO -.Xr pam 3 -.Sh STANDARDS -The -.Nm -function is an OpenPAM extension. -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/openpam_log.3 b/doc/man/openpam_log.3 deleted file mode 100644 index 5a13827..0000000 --- a/doc/man/openpam_log.3 +++ /dev/null @@ -1,64 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/openpam_log.3#10 $ -.\" -.Dd May 24, 2002 -.Dt OPENPAM_LOG 3 -.Os -.Sh NAME -.Nm openpam_log -.Nd it). Do the next best thing -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.In security/openpam.h -.Ft void -.Fn openpam_log "int level" "const char *fmt" "..." -.Sh DESCRIPTION -No description available. -.Sh SEE ALSO -.Xr pam 3 -.Sh STANDARDS -The -.Nm -function is an OpenPAM extension. -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/openpam_nullconv.3 b/doc/man/openpam_nullconv.3 deleted file mode 100644 index 85a9259..0000000 --- a/doc/man/openpam_nullconv.3 +++ /dev/null @@ -1,97 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/openpam_nullconv.3#2 $ -.\" -.Dd May 24, 2002 -.Dt OPENPAM_NULLCONV 3 -.Os -.Sh NAME -.Nm openpam_nullconv -.Nd null conversation function -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.In security/openpam.h -.Ft int -.Fn openpam_nullconv "int n" "const struct pam_message **msg" "struct pam_response **resp" "void *data" -.Sh DESCRIPTION -The -.Nm -function is a null conversation function suitable -for applications that want to use PAM but don't support interactive -dialog with the user. Such applications should set -.Dv PAM_AUTHTOK -to -whatever authentication token they've obtained on their own before -calling -.Xr pam_authenticate 3 -and / or -.Xr pam_chauthtok 3 , -and their PAM -configuration should specify the -.Dv use_first_pass -option for all modules -that require access to the authentication token, to make sure they use -.Dv PAM_AUTHTOK -rather than try to query the user. -.Pp -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_CONV_ERR -Conversation failure. -.El -.Sh SEE ALSO -.Xr openpam_ttyconv 3 , -.Xr pam 3 , -.Xr pam_chauthtok 3 , -.Xr pam_prompt 3 , -.Xr pam_set_item 3 , -.Xr pam_strerror 3 , -.Xr pam_vprompt 3 -.Sh STANDARDS -The -.Nm -function is an OpenPAM extension. -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/openpam_restore_cred.3 b/doc/man/openpam_restore_cred.3 deleted file mode 100644 index 2e11820..0000000 --- a/doc/man/openpam_restore_cred.3 +++ /dev/null @@ -1,83 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/openpam_restore_cred.3#5 $ -.\" -.Dd May 24, 2002 -.Dt OPENPAM_RESTORE_CRED 3 -.Os -.Sh NAME -.Nm openpam_restore_cred -.Nd restore credentials -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.In security/openpam.h -.Ft int -.Fn openpam_restore_cred "pam_handle_t *pamh" -.Sh DESCRIPTION -The -.Nm -function restores the credentials saved by -.Xr openpam_borrow_cred 3 . -.Pp -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_NO_MODULE_DATA -Module data not found. -.It Bq Er PAM_SYSTEM_ERR -System error. -.El -.Sh SEE ALSO -.Xr openpam_borrow_cred 3 , -.Xr pam 3 , -.Xr pam_strerror 3 , -.Xr setegid 3 , -.Xr seteuid 3 , -.Xr setgroups 3 -.Sh STANDARDS -The -.Nm -function is an OpenPAM extension. -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/openpam_set_option.3 b/doc/man/openpam_set_option.3 deleted file mode 100644 index 4f3dd21..0000000 --- a/doc/man/openpam_set_option.3 +++ /dev/null @@ -1,78 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/openpam_set_option.3#9 $ -.\" -.Dd May 24, 2002 -.Dt OPENPAM_SET_OPTION 3 -.Os -.Sh NAME -.Nm openpam_set_option -.Nd sets the value of a module option -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.In security/openpam.h -.Ft int -.Fn openpam_set_option "pam_handle_t *pamh" "const char *option" "const char *value" -.Sh DESCRIPTION -The -.Nm -function sets the specified option in the -context of the currently executing service module. -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_SYSTEM_ERR -System error. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_strerror 3 -.Sh STANDARDS -The -.Nm -function is an OpenPAM extension. -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/openpam_ttyconv.3 b/doc/man/openpam_ttyconv.3 deleted file mode 100644 index 993ad46..0000000 --- a/doc/man/openpam_ttyconv.3 +++ /dev/null @@ -1,92 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/openpam_ttyconv.3#10 $ -.\" -.Dd May 24, 2002 -.Dt OPENPAM_TTYCONV 3 -.Os -.Sh NAME -.Nm openpam_ttyconv -.Nd simple tty-based conversation function -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.In security/openpam.h -.Ft int -.Fn openpam_ttyconv "int n" "const struct pam_message **msg" "struct pam_response **resp" "void *data" -.Sh DESCRIPTION -The -.Nm -function is a standard conversation function -suitable for use on TTY devices. It should be adequate for the needs -of most text-based interactive programs. -.Pp -The -.Nm -function allows the application to specify a -timeout for user input by setting the global variable -.Va openpam_ttyconv_timeout -to the length of the timeout in seconds. -.Pp -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_CONV_ERR -Conversation failure. -.It Bq Er PAM_SYSTEM_ERR -System error. -.El -.Sh SEE ALSO -.Xr openpam_nullconv 3 , -.Xr pam 3 , -.Xr pam_prompt 3 , -.Xr pam_strerror 3 , -.Xr pam_vprompt 3 -.Sh STANDARDS -The -.Nm -function is an OpenPAM extension. -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam.3 b/doc/man/pam.3 deleted file mode 100644 index 14a8441..0000000 --- a/doc/man/pam.3 +++ /dev/null @@ -1,237 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam.3#15 $ -.\" -.Dd May 24, 2002 -.Dt PAM 3 -.Os -.Sh NAME -.Nm openpam_borrow_cred , -.Nm openpam_free_data , -.Nm openpam_restore_cred , -.Nm pam_acct_mgmt , -.Nm pam_authenticate , -.Nm pam_chauthtok , -.Nm pam_close_session , -.Nm pam_end , -.Nm pam_error , -.Nm pam_get_authtok , -.Nm pam_get_data , -.Nm pam_get_item , -.Nm pam_get_user , -.Nm pam_getenv , -.Nm pam_getenvlist , -.Nm pam_info , -.Nm pam_open_session , -.Nm pam_prompt , -.Nm pam_putenv , -.Nm pam_set_data , -.Nm pam_set_item , -.Nm pam_setcred , -.Nm pam_setenv , -.Nm pam_start , -.Nm pam_strerror , -.Nm pam_verror , -.Nm pam_vinfo , -.Nm pam_vprompt -.Nd Pluggable Authentication Modules Library -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft int -.Fn openpam_borrow_cred "pam_handle_t *pamh" "const struct passwd *pwd" -.Ft void -.Fn openpam_free_data "pam_handle_t *pamh" "void *data" "int status" -.Ft int -.Fn openpam_restore_cred "pam_handle_t *pamh" -.Ft int -.Fn pam_acct_mgmt "pam_handle_t *pamh" "int flags" -.Ft int -.Fn pam_authenticate "pam_handle_t *pamh" "int flags" -.Ft int -.Fn pam_chauthtok "pam_handle_t *pamh" "int flags" -.Ft int -.Fn pam_close_session "pam_handle_t *pamh" "int flags" -.Ft int -.Fn pam_end "pam_handle_t *pamh" "int status" -.Ft int -.Fn pam_error "pam_handle_t *pamh" "const char *fmt" "..." -.Ft int -.Fn pam_get_authtok "pam_handle_t *pamh" "int item" "const char **authtok" "const char *prompt" -.Ft int -.Fn pam_get_data "pam_handle_t *pamh" "const char *module_data_name" "const void **data" -.Ft int -.Fn pam_get_item "pam_handle_t *pamh" "int item_type" "const void **item" -.Ft int -.Fn pam_get_user "pam_handle_t *pamh" "const char **user" "const char *prompt" -.Ft char * -.Fn pam_getenv "pam_handle_t *pamh" "const char *name" -.Ft char ** -.Fn pam_getenvlist "pam_handle_t *pamh" -.Ft int -.Fn pam_info "pam_handle_t *pamh" "const char *fmt" "..." -.Ft int -.Fn pam_open_session "pam_handle_t *pamh" "int flags" -.Ft int -.Fn pam_prompt "pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "..." -.Ft int -.Fn pam_putenv "pam_handle_t *pamh" "const char *namevalue" -.Ft int -.Fn pam_set_data "pam_handle_t *pamh" "const char *module_data_name" "void *data" "void (*cleanup)(pam_handle_t *pamh, void *data, int pam_end_status)" -.Ft int -.Fn pam_set_item "pam_handle_t *pamh" "int item_type" "const void *item" -.Ft int -.Fn pam_setcred "pam_handle_t *pamh" "int flags" -.Ft int -.Fn pam_setenv "pam_handle_t *pamh" "const char *name" "const char *value" "int overwrite" -.Ft int -.Fn pam_start "const char *service" "const char *user" "const struct pam_conv *pam_conv" "pam_handle_t **pamh" -.Ft const char * -.Fn pam_strerror "pam_handle_t *pamh" "int error_number" -.Ft int -.Fn pam_verror "pam_handle_t *pamh" "const char *fmt" "va_list ap" -.Ft int -.Fn pam_vinfo "pam_handle_t *pamh" "const char *fmt" "va_list ap" -.Ft int -.Fn pam_vprompt "pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "va_list ap" -.Sh DESCRIPTION -.Sh RETURN VALUES -The following return codes are defined in the -.In security/pam_constants.h -header: -.Bl -tag -width 18n -.It Bq Er PAM_ABORT -General failure. -.It Bq Er PAM_ACCT_EXPIRED -User accound has expired. -.It Bq Er PAM_AUTHINFO_UNAVAIL -Authentication information is unavailable. -.It Bq Er PAM_AUTHTOK_DISABLE_AGING -Authentication token aging disabled. -.It Bq Er PAM_AUTHTOK_ERR -Authentication token failure. -.It Bq Er PAM_AUTHTOK_EXPIRED -Password has expired. -.It Bq Er PAM_AUTHTOK_LOCK_BUSY -Authentication token lock busy. -.It Bq Er PAM_AUTHTOK_RECOVERY_ERR -Failed to recover old authentication token. -.It Bq Er PAM_AUTH_ERR -Authentication error. -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_CONV_ERR -Conversation failure. -.It Bq Er PAM_CRED_ERR -Failed to set user credentials. -.It Bq Er PAM_CRED_EXPIRED -User credentials have expired. -.It Bq Er PAM_CRED_INSUFFICIENT -Insufficient credentials. -.It Bq Er PAM_CRED_UNAVAIL -Failed to retrieve user credentials. -.It Bq Er PAM_DOMAIN_UNKNOWN -Unknown authentication domain. -.It Bq Er PAM_IGNORE -Ignore this module. -.It Bq Er PAM_MAXTRIES -Maximum number of tries exceeded. -.It Bq Er PAM_MODULE_UNKNOWN -Unknown module type. -.It Bq Er PAM_NEW_AUTHTOK_REQD -New authentication token required. -.It Bq Er PAM_NO_MODULE_DATA -Module data not found. -.It Bq Er PAM_OPEN_ERR -Failed to load module. -.It Bq Er PAM_PERM_DENIED -Permission denied. -.It Bq Er PAM_SERVICE_ERR -Error in service module. -.It Bq Er PAM_SESSION_ERR -Session failure. -.It Bq Er PAM_SUCCESS -Success. -.It Bq Er PAM_SYMBOL_ERR -Invalid symbol. -.It Bq Er PAM_SYSTEM_ERR -System error. -.It Bq Er PAM_TRY_AGAIN -Try again. -.It Bq Er PAM_USER_UNKNOWN -Unknown user. -.El -.Sh SEE ALSO -.Xr openpam_borrow_cred 3 , -.Xr openpam_free_data 3 , -.Xr openpam_restore_cred 3 , -.Xr pam_acct_mgmt 3 , -.Xr pam_authenticate 3 , -.Xr pam_chauthtok 3 , -.Xr pam_close_session 3 , -.Xr pam_end 3 , -.Xr pam_error 3 , -.Xr pam_get_authtok 3 , -.Xr pam_get_data 3 , -.Xr pam_get_item 3 , -.Xr pam_get_user 3 , -.Xr pam_getenv 3 , -.Xr pam_getenvlist 3 , -.Xr pam_info 3 , -.Xr pam_open_session 3 , -.Xr pam_prompt 3 , -.Xr pam_putenv 3 , -.Xr pam_set_data 3 , -.Xr pam_set_item 3 , -.Xr pam_setcred 3 , -.Xr pam_setenv 3 , -.Xr pam_start 3 , -.Xr pam_strerror 3 , -.Xr pam_verror 3 , -.Xr pam_vinfo 3 , -.Xr pam_vprompt 3 , -.Xr pam.conf 5 -.Sh STANDARDS -.Rs -.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" -.%D "June 1997" -.Re -.Sh AUTHORS -The OpenPAM library and this manual page were developed for the -FreeBSD Project by ThinkSec AS and NAI Labs, the Security Research -Division of Network Associates, Inc. under DARPA/SPAWAR contract -N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_acct_mgmt.3 b/doc/man/pam_acct_mgmt.3 deleted file mode 100644 index 574a514..0000000 --- a/doc/man/pam_acct_mgmt.3 +++ /dev/null @@ -1,110 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_acct_mgmt.3#13 $ -.\" -.Dd May 24, 2002 -.Dt PAM_ACCT_MGMT 3 -.Os -.Sh NAME -.Nm pam_acct_mgmt -.Nd perform PAM account validation procedures -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft int -.Fn pam_acct_mgmt "pam_handle_t *pamh" "int flags" -.Sh DESCRIPTION -The -.Nm -function verifies and enforces account restrictions -after the user has been authenticated. -.Pp -The -.Va flags -argument is the binary or of zero or more of the following -values: -.Bl -tag -width 18n -.It Dv PAM_SILENT -Do not emit any messages. -.It Dv PAM_DISALLOW_NULL_AUTHTOK -Fail if the user's authentication token is null. -.El -If any other bits are set, -.Xr pam_authenticate 3 -will return -.Dv PAM_SYMBOL_ERR . -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_ABORT -General failure. -.It Bq Er PAM_ACCT_EXPIRED -User accound has expired. -.It Bq Er PAM_AUTH_ERR -Authentication error. -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_CONV_ERR -Conversation failure. -.It Bq Er PAM_NEW_AUTHTOK_REQD -New authentication token required. -.It Bq Er PAM_PERM_DENIED -Permission denied. -.It Bq Er PAM_SERVICE_ERR -Error in service module. -.It Bq Er PAM_SYSTEM_ERR -System error. -.It Bq Er PAM_USER_UNKNOWN -Unknown user. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_authenticate 3 , -.Xr pam_strerror 3 -.Sh STANDARDS -.Rs -.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" -.%D "June 1997" -.Re -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_authenticate.3 b/doc/man/pam_authenticate.3 deleted file mode 100644 index a314a9a..0000000 --- a/doc/man/pam_authenticate.3 +++ /dev/null @@ -1,123 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_authenticate.3#13 $ -.\" -.Dd May 24, 2002 -.Dt PAM_AUTHENTICATE 3 -.Os -.Sh NAME -.Nm pam_authenticate -.Nd perform authentication within the PAM framework -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft int -.Fn pam_authenticate "pam_handle_t *pamh" "int flags" -.Sh DESCRIPTION -The -.Nm -function attempts to authenticate the user -associated with the pam context specified by the -.Va pamh -argument. -.Pp -The application is free to call -.Nm -as many times as it -wishes, but some modules may maintain an internal retry counter and -return -.Dv PAM_MAXTRIES -when it exceeds some preset or hardcoded limit. -.Pp -The -.Va flags -argument is the binary or of zero or more of the following -values: -.Bl -tag -width 18n -.It Dv PAM_SILENT -Do not emit any messages. -.It Dv PAM_DISALLOW_NULL_AUTHTOK -Fail if the user's authentication token is null. -.El -If any other bits are set, -.Nm -will return -.Dv PAM_SYMBOL_ERR . -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_ABORT -General failure. -.It Bq Er PAM_AUTHINFO_UNAVAIL -Authentication information is unavailable. -.It Bq Er PAM_AUTH_ERR -Authentication error. -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_CONV_ERR -Conversation failure. -.It Bq Er PAM_CRED_INSUFFICIENT -Insufficient credentials. -.It Bq Er PAM_MAXTRIES -Maximum number of tries exceeded. -.It Bq Er PAM_PERM_DENIED -Permission denied. -.It Bq Er PAM_SERVICE_ERR -Error in service module. -.It Bq Er PAM_SYMBOL_ERR -Invalid symbol. -.It Bq Er PAM_SYSTEM_ERR -System error. -.It Bq Er PAM_USER_UNKNOWN -Unknown user. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_strerror 3 -.Sh STANDARDS -.Rs -.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" -.%D "June 1997" -.Re -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_chauthtok.3 b/doc/man/pam_chauthtok.3 deleted file mode 100644 index e2372dd..0000000 --- a/doc/man/pam_chauthtok.3 +++ /dev/null @@ -1,115 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_chauthtok.3#13 $ -.\" -.Dd May 24, 2002 -.Dt PAM_CHAUTHTOK 3 -.Os -.Sh NAME -.Nm pam_chauthtok -.Nd perform password related functions within the PAM framework -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft int -.Fn pam_chauthtok "pam_handle_t *pamh" "int flags" -.Sh DESCRIPTION -The -.Nm -function attempts to change the authentication token -for the user associated with the pam context specified by the -.Va pamh -argument. -.Pp -The -.Va flags -argument is the binary or of zero or more of the following -values: -.Bl -tag -width 18n -.It Dv PAM_SILENT -Do not emit any messages. -.It Dv PAM_CHANGE_EXPIRED_AUTHTOK -Change only those authentication tokens that have expired. -.El -If any other bits are set, -.Nm -will return -.Dv PAM_SYMBOL_ERR . -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_ABORT -General failure. -.It Bq Er PAM_AUTHTOK_DISABLE_AGING -Authentication token aging disabled. -.It Bq Er PAM_AUTHTOK_ERR -Authentication token failure. -.It Bq Er PAM_AUTHTOK_LOCK_BUSY -Authentication token lock busy. -.It Bq Er PAM_AUTHTOK_RECOVERY_ERR -Failed to recover old authentication token. -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_CONV_ERR -Conversation failure. -.It Bq Er PAM_PERM_DENIED -Permission denied. -.It Bq Er PAM_SERVICE_ERR -Error in service module. -.It Bq Er PAM_SYMBOL_ERR -Invalid symbol. -.It Bq Er PAM_SYSTEM_ERR -System error. -.It Bq Er PAM_TRY_AGAIN -Try again. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_strerror 3 -.Sh STANDARDS -.Rs -.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" -.%D "June 1997" -.Re -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_close_session.3 b/doc/man/pam_close_session.3 deleted file mode 100644 index eae011b..0000000 --- a/doc/man/pam_close_session.3 +++ /dev/null @@ -1,105 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_close_session.3#13 $ -.\" -.Dd May 24, 2002 -.Dt PAM_CLOSE_SESSION 3 -.Os -.Sh NAME -.Nm pam_close_session -.Nd close an existing user session -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft int -.Fn pam_close_session "pam_handle_t *pamh" "int flags" -.Sh DESCRIPTION -The -.Nm -function tears down the user session previously -set up by -.Xr pam_open_session 3 . -.Pp -The -.Va flags -argument is the binary or of zero or more of the following -values: -.Bl -tag -width 18n -.It Dv PAM_SILENT -Do not emit any messages. -.El -If any other bits are set, -.Nm -will return -.Dv PAM_SYMBOL_ERR . -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_ABORT -General failure. -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_CONV_ERR -Conversation failure. -.It Bq Er PAM_PERM_DENIED -Permission denied. -.It Bq Er PAM_SERVICE_ERR -Error in service module. -.It Bq Er PAM_SESSION_ERR -Session failure. -.It Bq Er PAM_SYMBOL_ERR -Invalid symbol. -.It Bq Er PAM_SYSTEM_ERR -System error. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_open_session 3 , -.Xr pam_strerror 3 -.Sh STANDARDS -.Rs -.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" -.%D "June 1997" -.Re -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_end.3 b/doc/man/pam_end.3 deleted file mode 100644 index 0f766e6..0000000 --- a/doc/man/pam_end.3 +++ /dev/null @@ -1,83 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_end.3#13 $ -.\" -.Dd May 24, 2002 -.Dt PAM_END 3 -.Os -.Sh NAME -.Nm pam_end -.Nd terminate the PAM transaction -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft int -.Fn pam_end "pam_handle_t *pamh" "int status" -.Sh DESCRIPTION -The -.Nm -function terminates a PAM transaction and destroys the -corresponding PAM context, releasing all resources allocated to it. -.Pp -The -.Va status -argument should be set to the error code returned by the -last API call before the call to -.Nm -. -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_SYSTEM_ERR -System error. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_strerror 3 -.Sh STANDARDS -.Rs -.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" -.%D "June 1997" -.Re -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_error.3 b/doc/man/pam_error.3 deleted file mode 100644 index cfa9c84..0000000 --- a/doc/man/pam_error.3 +++ /dev/null @@ -1,83 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_error.3#13 $ -.\" -.Dd May 24, 2002 -.Dt PAM_ERROR 3 -.Os -.Sh NAME -.Nm pam_error -.Nd display an error message -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft int -.Fn pam_error "pam_handle_t *pamh" "const char *fmt" "..." -.Sh DESCRIPTION -The -.Xr pam_info 3 -function displays an error message through the -intermediary of the given PAM context's conversation function. -.Pp -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_CONV_ERR -Conversation failure. -.It Bq Er PAM_SYSTEM_ERR -System error. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_info 3 , -.Xr pam_prompt 3 , -.Xr pam_strerror 3 , -.Xr pam_verror 3 -.Sh STANDARDS -The -.Nm -function is an OpenPAM extension. -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_get_authtok.3 b/doc/man/pam_get_authtok.3 deleted file mode 100644 index 446cc07..0000000 --- a/doc/man/pam_get_authtok.3 +++ /dev/null @@ -1,128 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_get_authtok.3#15 $ -.\" -.Dd May 24, 2002 -.Dt PAM_GET_AUTHTOK 3 -.Os -.Sh NAME -.Nm pam_get_authtok -.Nd retrieve authentication token -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft int -.Fn pam_get_authtok "pam_handle_t *pamh" "int item" "const char **authtok" "const char *prompt" -.Sh DESCRIPTION -The -.Nm -function returns the cached authentication token, -or prompts the user if no token is currently cached. Either way, a -pointer to the authentication token is stored in the location pointed -to by the -.Va authtok -argument. -.Pp -The -.Va item -argument must have one of the following values: -.Bl -tag -width 18n -.It Dv PAM_AUTHTOK -Returns the current authentication token, or the new token -when changing authentication tokens. -.It Dv PAM_OLDAUTHTOK -Returns the previous authentication token when changing -authentication tokens. -.El -The -.Va prompt -argument specifies a prompt to use if no token is cached. -If it is -.Dv NULL , -the -.Dv PAM_AUTHTOK_PROMPT -or -.Dv PAM_OLDAUTHTOK_PROMPT -item, -as appropriate, will be used. If that item is also -.Dv NULL , -a hardcoded -default prompt will be used. -.Pp -If -.Va item -is set to -.Dv PAM_AUTHTOK -and there is a non-null -.Dv PAM_OLDAUTHTOK -item, -.Nm -will ask the user to confirm the new token by -retyping it. If there is a mismatch, -.Nm -will return -.Dv PAM_TRY_AGAIN . -.Pp -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_CONV_ERR -Conversation failure. -.It Bq Er PAM_SYSTEM_ERR -System error. -.It Bq Er PAM_TRY_AGAIN -Try again. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_get_item 3 , -.Xr pam_get_user 3 , -.Xr pam_strerror 3 -.Sh STANDARDS -The -.Nm -function is an OpenPAM extension. -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_get_data.3 b/doc/man/pam_get_data.3 deleted file mode 100644 index c159695..0000000 --- a/doc/man/pam_get_data.3 +++ /dev/null @@ -1,92 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_get_data.3#13 $ -.\" -.Dd May 24, 2002 -.Dt PAM_GET_DATA 3 -.Os -.Sh NAME -.Nm pam_get_data -.Nd get module information -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft int -.Fn pam_get_data "pam_handle_t *pamh" "const char *module_data_name" "const void **data" -.Sh DESCRIPTION -The -.Nm -function looks up the opaque object associated with -the string specified by the -.Va module_data_name -argument, in the PAM -context specified by the -.Va pamh -argument. -A pointer to the object is stored in the location pointed to by the -.Va data -argument. -.Pp -This function and its counterpart -.Xr pam_set_data 3 -are useful for managing -data that are meaningful only to a particular service module. -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_NO_MODULE_DATA -Module data not found. -.It Bq Er PAM_SYSTEM_ERR -System error. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_set_data 3 , -.Xr pam_strerror 3 -.Sh STANDARDS -.Rs -.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" -.%D "June 1997" -.Re -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_get_item.3 b/doc/man/pam_get_item.3 deleted file mode 100644 index 71926e5..0000000 --- a/doc/man/pam_get_item.3 +++ /dev/null @@ -1,124 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_get_item.3#14 $ -.\" -.Dd May 24, 2002 -.Dt PAM_GET_ITEM 3 -.Os -.Sh NAME -.Nm pam_get_item -.Nd get PAM information -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft int -.Fn pam_get_item "pam_handle_t *pamh" "int item_type" "const void **item" -.Sh DESCRIPTION -The -.Nm -function stores a pointer to the item specified by -the -.Va item_type -argument in the location specified by the -.Va item -argument. -The item is retrieved from the PAM context specified by the -.Va pamh -argument. -The following item types are recognized: -.Bl -tag -width 18n -.It Dv PAM_SERVICE -The name of the requesting service. -.It Dv PAM_USER -The name of the user the application is trying to -authenticate. -.It Dv PAM_TTY -The name of the current terminal. -.It Dv PAM_RHOST -The name of the applicant's host. -.It Dv PAM_CONV -A -.Vt struct pam_conv -describing the current conversation -function. -.It Dv PAM_AUTHTOK -The current authentication token. -.It Dv PAM_OLDAUTHTOK -The expired authentication token. -.It Dv PAM_RUSER -The name of the applicant. -.It Dv PAM_USER_PROMPT -The prompt to use when asking the applicant for a user -name to authenticate as. -.It Dv PAM_AUTHTOK_PROMPT -The prompt to use when asking the applicant for an -authentication token. -.It Dv PAM_OLDAUTHTOK_PROMPT -The prompt to use when asking the applicant for an -expired authentication token prior to changing it. -.El -See -.Xr pam_start 3 -for a description of -.Vt struct pam_conv . -.Pp -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_SYMBOL_ERR -Invalid symbol. -.It Bq Er PAM_SYSTEM_ERR -System error. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_set_item 3 , -.Xr pam_start 3 , -.Xr pam_strerror 3 -.Sh STANDARDS -.Rs -.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" -.%D "June 1997" -.Re -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_get_user.3 b/doc/man/pam_get_user.3 deleted file mode 100644 index e41464b..0000000 --- a/doc/man/pam_get_user.3 +++ /dev/null @@ -1,105 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_get_user.3#14 $ -.\" -.Dd May 24, 2002 -.Dt PAM_GET_USER 3 -.Os -.Sh NAME -.Nm pam_get_user -.Nd retrieve user name -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft int -.Fn pam_get_user "pam_handle_t *pamh" "const char **user" "const char *prompt" -.Sh DESCRIPTION -The -.Nm -function returns the name of the target user, as -specified to -.Xr pam_start 3 . -If no user was specified, nor set using -.Xr pam_set_item 3 , -.Nm -will prompt for a user name. Either way, -a pointer to the user name is stored in the location pointed to by the -.Va user -argument. -.Pp -The -.Va prompt -argument specifies a prompt to use if no user name is -cached. If it is -.Dv NULL , -the -.Dv PAM_USER_PROMPT -will be used. If that -item is also -.Dv NULL , -a hardcoded default prompt will be used. -.Pp -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_CONV_ERR -Conversation failure. -.It Bq Er PAM_SYSTEM_ERR -System error. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_get_authtok 3 , -.Xr pam_get_item 3 , -.Xr pam_set_item 3 , -.Xr pam_start 3 , -.Xr pam_strerror 3 -.Sh STANDARDS -.Rs -.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" -.%D "June 1997" -.Re -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_getenv.3 b/doc/man/pam_getenv.3 deleted file mode 100644 index 8324f9f..0000000 --- a/doc/man/pam_getenv.3 +++ /dev/null @@ -1,81 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_getenv.3#13 $ -.\" -.Dd May 24, 2002 -.Dt PAM_GETENV 3 -.Os -.Sh NAME -.Nm pam_getenv -.Nd retrieve the value of a PAM environment variable -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft char * -.Fn pam_getenv "pam_handle_t *pamh" "const char *name" -.Sh DESCRIPTION -The -.Nm -function returns the value of an environment variable. -Its semantics are similar to those of -.Xr getenv 3 , -but it accesses the PAM -context's environment list instead of the application's. -.Pp -.Sh RETURN VALUES -The -.Nm -function returns -.Dv NULL -on failure. -.Sh SEE ALSO -.Xr getenv 3 , -.Xr pam 3 , -.Xr pam_getenvlist 3 , -.Xr pam_putenv 3 , -.Xr pam_setenv 3 -.Sh STANDARDS -.Rs -.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" -.%D "June 1997" -.Re -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_getenvlist.3 b/doc/man/pam_getenvlist.3 deleted file mode 100644 index f9ec82c..0000000 --- a/doc/man/pam_getenvlist.3 +++ /dev/null @@ -1,102 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_getenvlist.3#14 $ -.\" -.Dd May 24, 2002 -.Dt PAM_GETENVLIST 3 -.Os -.Sh NAME -.Nm pam_getenvlist -.Nd returns a list of all the PAM environment variables -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft char ** -.Fn pam_getenvlist "pam_handle_t *pamh" -.Sh DESCRIPTION -The -.Nm -function returns a copy of the given PAM context's -environment list as a pointer to an array of strings. -The last element in the array is -.Dv NULL . -The pointer is suitable for assignment to -.Va environ . -.Pp -The array and the strings it lists are allocated using -.Xr malloc 3 , -and -should be released using -.Xr free 3 -after use: -.Pp -.Bd -literal - char **envlist, **env; - - envlist = environ; - environ = pam_getenvlist(pamh); - /* do something nifty */ - for (env = environ; *env != NULL; env++) - free(*env); - free(environ); - environ = envlist; -.Ed -.Sh RETURN VALUES -The -.Nm -function returns -.Dv NULL -on failure. -.Sh SEE ALSO -.Xr environ 7 , -.Xr free 3 , -.Xr malloc 3 , -.Xr pam 3 , -.Xr pam_getenv 3 , -.Xr pam_putenv 3 , -.Xr pam_setenv 3 -.Sh STANDARDS -.Rs -.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" -.%D "June 1997" -.Re -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_info.3 b/doc/man/pam_info.3 deleted file mode 100644 index bf20ca4..0000000 --- a/doc/man/pam_info.3 +++ /dev/null @@ -1,83 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_info.3#13 $ -.\" -.Dd May 24, 2002 -.Dt PAM_INFO 3 -.Os -.Sh NAME -.Nm pam_info -.Nd display an information message -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft int -.Fn pam_info "pam_handle_t *pamh" "const char *fmt" "..." -.Sh DESCRIPTION -The -.Nm -function displays an informational message through the -intermediary of the given PAM context's conversation function. -.Pp -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_CONV_ERR -Conversation failure. -.It Bq Er PAM_SYSTEM_ERR -System error. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_error 3 , -.Xr pam_prompt 3 , -.Xr pam_strerror 3 , -.Xr pam_vinfo 3 -.Sh STANDARDS -The -.Nm -function is an OpenPAM extension. -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_open_session.3 b/doc/man/pam_open_session.3 deleted file mode 100644 index 4275b3d..0000000 --- a/doc/man/pam_open_session.3 +++ /dev/null @@ -1,105 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_open_session.3#13 $ -.\" -.Dd May 24, 2002 -.Dt PAM_OPEN_SESSION 3 -.Os -.Sh NAME -.Nm pam_open_session -.Nd open a user session -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft int -.Fn pam_open_session "pam_handle_t *pamh" "int flags" -.Sh DESCRIPTION -The -.Nm -sets up a user session for a previously -authenticated user. The session should later be torn down by a call to -.Xr pam_close_session 3 . -.Pp -The -.Va flags -argument is the binary or of zero or more of the following -values: -.Bl -tag -width 18n -.It Dv PAM_SILENT -Do not emit any messages. -.El -If any other bits are set, -.Nm -will return -.Dv PAM_SYMBOL_ERR . -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_ABORT -General failure. -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_CONV_ERR -Conversation failure. -.It Bq Er PAM_PERM_DENIED -Permission denied. -.It Bq Er PAM_SERVICE_ERR -Error in service module. -.It Bq Er PAM_SESSION_ERR -Session failure. -.It Bq Er PAM_SYMBOL_ERR -Invalid symbol. -.It Bq Er PAM_SYSTEM_ERR -System error. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_close_session 3 , -.Xr pam_strerror 3 -.Sh STANDARDS -.Rs -.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" -.%D "June 1997" -.Re -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_prompt.3 b/doc/man/pam_prompt.3 deleted file mode 100644 index 0e12a50..0000000 --- a/doc/man/pam_prompt.3 +++ /dev/null @@ -1,95 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_prompt.3#14 $ -.\" -.Dd May 24, 2002 -.Dt PAM_PROMPT 3 -.Os -.Sh NAME -.Nm pam_prompt -.Nd call the conversation function -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft int -.Fn pam_prompt "pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "..." -.Sh DESCRIPTION -The -.Nm -function constructs a message from the specified format -string and arguments and passes it to the given PAM context's -conversation function. -.Pp -A pointer to the response, or -.Dv NULL -if the conversation function did -not return one, is stored in the location pointed to by the -.Va resp -argument. -.Pp -See -.Xr pam_vprompt 3 -for further details. -.Pp -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_CONV_ERR -Conversation failure. -.It Bq Er PAM_SYSTEM_ERR -System error. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_error 3 , -.Xr pam_info 3 , -.Xr pam_strerror 3 , -.Xr pam_vprompt 3 -.Sh STANDARDS -The -.Nm -function is an OpenPAM extension. -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_putenv.3 b/doc/man/pam_putenv.3 deleted file mode 100644 index 5092e03..0000000 --- a/doc/man/pam_putenv.3 +++ /dev/null @@ -1,86 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_putenv.3#13 $ -.\" -.Dd May 24, 2002 -.Dt PAM_PUTENV 3 -.Os -.Sh NAME -.Nm pam_putenv -.Nd set the value of an environment variable -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft int -.Fn pam_putenv "pam_handle_t *pamh" "const char *namevalue" -.Sh DESCRIPTION -The -.Nm -function sets a environment variable. -Its semantics are similar to those of -.Xr putenv 3 , -but it modifies the PAM -context's environment list instead of the application's. -.Pp -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_SYSTEM_ERR -System error. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_getenv 3 , -.Xr pam_getenvlist 3 , -.Xr pam_setenv 3 , -.Xr pam_strerror 3 , -.Xr putenv 3 -.Sh STANDARDS -.Rs -.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" -.%D "June 1997" -.Re -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_set_data.3 b/doc/man/pam_set_data.3 deleted file mode 100644 index 11cd179..0000000 --- a/doc/man/pam_set_data.3 +++ /dev/null @@ -1,97 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_set_data.3#13 $ -.\" -.Dd May 24, 2002 -.Dt PAM_SET_DATA 3 -.Os -.Sh NAME -.Nm pam_set_data -.Nd set module information -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft int -.Fn pam_set_data "pam_handle_t *pamh" "const char *module_data_name" "void *data" "void (*cleanup)(pam_handle_t *pamh, void *data, int pam_end_status)" -.Sh DESCRIPTION -The -.Nm -function associates a pointer to an opaque object -with an arbitrary string specified by the -.Va module_data_name -argument, -in the PAM context specified by the -.Va pamh -argument. -.Pp -If not -.Dv NULL , -the -.Xr cleanup 3 -argument should point to a function -responsible for releasing the resources associated with the object. -.Pp -This function and its counterpart -.Xr pam_get_data 3 -are useful for managing -data that are meaningful only to a particular service module. -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_SYSTEM_ERR -System error. -.El -.Sh SEE ALSO -.Xr cleanup 3 , -.Xr pam 3 , -.Xr pam_get_data 3 , -.Xr pam_strerror 3 -.Sh STANDARDS -.Rs -.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" -.%D "June 1997" -.Re -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_set_item.3 b/doc/man/pam_set_item.3 deleted file mode 100644 index 23de994..0000000 --- a/doc/man/pam_set_item.3 +++ /dev/null @@ -1,90 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_set_item.3#13 $ -.\" -.Dd May 24, 2002 -.Dt PAM_SET_ITEM 3 -.Os -.Sh NAME -.Nm pam_set_item -.Nd set authentication information -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft int -.Fn pam_set_item "pam_handle_t *pamh" "int item_type" "const void *item" -.Sh DESCRIPTION -The -.Nm -function sets the item specified by the -.Va item_type -argument to a copy of the object pointed to by the -.Va item -argument. -The item is stored in the PAM context specified by the -.Va pamh -argument. -See -.Xr pam_get_item 3 -for a list of recognized item types. -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_SYMBOL_ERR -Invalid symbol. -.It Bq Er PAM_SYSTEM_ERR -System error. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_get_item 3 , -.Xr pam_strerror 3 -.Sh STANDARDS -.Rs -.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" -.%D "June 1997" -.Re -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_setcred.3 b/doc/man/pam_setcred.3 deleted file mode 100644 index e5b3937..0000000 --- a/doc/man/pam_setcred.3 +++ /dev/null @@ -1,118 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_setcred.3#14 $ -.\" -.Dd May 24, 2002 -.Dt PAM_SETCRED 3 -.Os -.Sh NAME -.Nm pam_setcred -.Nd modify / delete user credentials for an authentication service -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft int -.Fn pam_setcred "pam_handle_t *pamh" "int flags" -.Sh DESCRIPTION -The -.Nm -function manages the application's credentials. -.Pp -The -.Va flags -argument is the binary or of zero or more of the following -values: -.Bl -tag -width 18n -.It Dv PAM_SILENT -Do not emit any messages. -.It Dv PAM_ESTABLISH_CRED -Establish the credentials of the target user. -.It Dv PAM_DELETE_CRED -Revoke all established credentials. -.It Dv PAM_REINITIALIZE_CRED -Fully reinitialise credentials. -.It Dv PAM_REFRESH_CRED -Refresh credentials. -.El -The latter four are mutually exclusive. -.Pp -If any other bits are set, -.Nm -will return -.Dv PAM_SYMBOL_ERR . -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_ABORT -General failure. -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_CONV_ERR -Conversation failure. -.It Bq Er PAM_CRED_ERR -Failed to set user credentials. -.It Bq Er PAM_CRED_EXPIRED -User credentials have expired. -.It Bq Er PAM_CRED_UNAVAIL -Failed to retrieve user credentials. -.It Bq Er PAM_PERM_DENIED -Permission denied. -.It Bq Er PAM_SERVICE_ERR -Error in service module. -.It Bq Er PAM_SYMBOL_ERR -Invalid symbol. -.It Bq Er PAM_SYSTEM_ERR -System error. -.It Bq Er PAM_USER_UNKNOWN -Unknown user. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_strerror 3 -.Sh STANDARDS -.Rs -.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" -.%D "June 1997" -.Re -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_setenv.3 b/doc/man/pam_setenv.3 deleted file mode 100644 index 5948513..0000000 --- a/doc/man/pam_setenv.3 +++ /dev/null @@ -1,85 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_setenv.3#13 $ -.\" -.Dd May 24, 2002 -.Dt PAM_SETENV 3 -.Os -.Sh NAME -.Nm pam_setenv -.Nd mirrors setenv(3) -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft int -.Fn pam_setenv "pam_handle_t *pamh" "const char *name" "const char *value" "int overwrite" -.Sh DESCRIPTION -The -.Nm -function sets a environment variable. -Its semantics are similar to those of -.Xr setenv 3 , -but it modifies the PAM -context's environment list instead of the application's. -.Pp -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_SYSTEM_ERR -System error. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_getenv 3 , -.Xr pam_getenvlist 3 , -.Xr pam_putenv 3 , -.Xr pam_strerror 3 , -.Xr setenv 3 -.Sh STANDARDS -The -.Nm -function is an OpenPAM extension. -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_sm_acct_mgmt.3 b/doc/man/pam_sm_acct_mgmt.3 deleted file mode 100644 index e0ee659..0000000 --- a/doc/man/pam_sm_acct_mgmt.3 +++ /dev/null @@ -1,100 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_sm_acct_mgmt.3#9 $ -.\" -.Dd May 24, 2002 -.Dt PAM_SM_ACCT_MGMT 3 -.Os -.Sh NAME -.Nm pam_sm_acct_mgmt -.Nd service module implementation for pam_acct_mgmt -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.In security/pam_modules.h -.Ft int -.Fn pam_sm_acct_mgmt "pam_handle_t *pamh" "int flags" "int argc" "const char **argv" -.Sh DESCRIPTION -The -.Nm -function is the service module's implementation -of the -.Xr pam_acct_mgmt 3 -API function. -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_ABORT -General failure. -.It Bq Er PAM_ACCT_EXPIRED -User accound has expired. -.It Bq Er PAM_AUTH_ERR -Authentication error. -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_CONV_ERR -Conversation failure. -.It Bq Er PAM_IGNORE -Ignore this module. -.It Bq Er PAM_NEW_AUTHTOK_REQD -New authentication token required. -.It Bq Er PAM_PERM_DENIED -Permission denied. -.It Bq Er PAM_SERVICE_ERR -Error in service module. -.It Bq Er PAM_SYSTEM_ERR -System error. -.It Bq Er PAM_USER_UNKNOWN -Unknown user. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_acct_mgmt 3 , -.Xr pam_strerror 3 -.Sh STANDARDS -.Rs -.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" -.%D "June 1997" -.Re -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_sm_authenticate.3 b/doc/man/pam_sm_authenticate.3 deleted file mode 100644 index 6d9ebaa..0000000 --- a/doc/man/pam_sm_authenticate.3 +++ /dev/null @@ -1,102 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_sm_authenticate.3#9 $ -.\" -.Dd May 24, 2002 -.Dt PAM_SM_AUTHENTICATE 3 -.Os -.Sh NAME -.Nm pam_sm_authenticate -.Nd service module implementation for pam_authenticate -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.In security/pam_modules.h -.Ft int -.Fn pam_sm_authenticate "pam_handle_t *pamh" "int flags" "int argc" "const char **argv" -.Sh DESCRIPTION -The -.Nm -function is the service module's -implementation of the -.Xr pam_authenticate 3 -API function. -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_ABORT -General failure. -.It Bq Er PAM_AUTHINFO_UNAVAIL -Authentication information is unavailable. -.It Bq Er PAM_AUTH_ERR -Authentication error. -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_CONV_ERR -Conversation failure. -.It Bq Er PAM_CRED_INSUFFICIENT -Insufficient credentials. -.It Bq Er PAM_IGNORE -Ignore this module. -.It Bq Er PAM_MAXTRIES -Maximum number of tries exceeded. -.It Bq Er PAM_PERM_DENIED -Permission denied. -.It Bq Er PAM_SERVICE_ERR -Error in service module. -.It Bq Er PAM_SYSTEM_ERR -System error. -.It Bq Er PAM_USER_UNKNOWN -Unknown user. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_authenticate 3 , -.Xr pam_strerror 3 -.Sh STANDARDS -.Rs -.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" -.%D "June 1997" -.Re -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_sm_chauthtok.3 b/doc/man/pam_sm_chauthtok.3 deleted file mode 100644 index 5a3d68c..0000000 --- a/doc/man/pam_sm_chauthtok.3 +++ /dev/null @@ -1,102 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_sm_chauthtok.3#9 $ -.\" -.Dd May 24, 2002 -.Dt PAM_SM_CHAUTHTOK 3 -.Os -.Sh NAME -.Nm pam_sm_chauthtok -.Nd service module implementation for pam_chauthtok -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.In security/pam_modules.h -.Ft int -.Fn pam_sm_chauthtok "pam_handle_t *pamh" "int flags" "int argc" "const char **argv" -.Sh DESCRIPTION -The -.Nm -function is the service module's implementation -of the -.Xr pam_chauthtok 3 -API function. -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_ABORT -General failure. -.It Bq Er PAM_AUTHTOK_DISABLE_AGING -Authentication token aging disabled. -.It Bq Er PAM_AUTHTOK_ERR -Authentication token failure. -.It Bq Er PAM_AUTHTOK_LOCK_BUSY -Authentication token lock busy. -.It Bq Er PAM_AUTHTOK_RECOVERY_ERR -Failed to recover old authentication token. -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_CONV_ERR -Conversation failure. -.It Bq Er PAM_IGNORE -Ignore this module. -.It Bq Er PAM_PERM_DENIED -Permission denied. -.It Bq Er PAM_SERVICE_ERR -Error in service module. -.It Bq Er PAM_SYSTEM_ERR -System error. -.It Bq Er PAM_TRY_AGAIN -Try again. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_chauthtok 3 , -.Xr pam_strerror 3 -.Sh STANDARDS -.Rs -.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" -.%D "June 1997" -.Re -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_sm_close_session.3 b/doc/man/pam_sm_close_session.3 deleted file mode 100644 index 9c95ff4..0000000 --- a/doc/man/pam_sm_close_session.3 +++ /dev/null @@ -1,94 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_sm_close_session.3#9 $ -.\" -.Dd May 24, 2002 -.Dt PAM_SM_CLOSE_SESSION 3 -.Os -.Sh NAME -.Nm pam_sm_close_session -.Nd service module implementation for pam_close_session -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.In security/pam_modules.h -.Ft int -.Fn pam_sm_close_session "pam_handle_t *pamh" "int flags" "int args" "const char **argv" -.Sh DESCRIPTION -The -.Nm -function is the service module's -implementation of the -.Xr pam_close_session 3 -API function. -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_ABORT -General failure. -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_CONV_ERR -Conversation failure. -.It Bq Er PAM_IGNORE -Ignore this module. -.It Bq Er PAM_PERM_DENIED -Permission denied. -.It Bq Er PAM_SERVICE_ERR -Error in service module. -.It Bq Er PAM_SESSION_ERR -Session failure. -.It Bq Er PAM_SYSTEM_ERR -System error. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_close_session 3 , -.Xr pam_strerror 3 -.Sh STANDARDS -.Rs -.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" -.%D "June 1997" -.Re -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_sm_open_session.3 b/doc/man/pam_sm_open_session.3 deleted file mode 100644 index 4f9a82a..0000000 --- a/doc/man/pam_sm_open_session.3 +++ /dev/null @@ -1,94 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_sm_open_session.3#9 $ -.\" -.Dd May 24, 2002 -.Dt PAM_SM_OPEN_SESSION 3 -.Os -.Sh NAME -.Nm pam_sm_open_session -.Nd service module implementation for pam_open_session -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.In security/pam_modules.h -.Ft int -.Fn pam_sm_open_session "pam_handle_t *pamh" "int flags" "int argc" "const char **argv" -.Sh DESCRIPTION -The -.Nm -function is the service module's -implementation of the -.Xr pam_open_session 3 -API function. -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_ABORT -General failure. -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_CONV_ERR -Conversation failure. -.It Bq Er PAM_IGNORE -Ignore this module. -.It Bq Er PAM_PERM_DENIED -Permission denied. -.It Bq Er PAM_SERVICE_ERR -Error in service module. -.It Bq Er PAM_SESSION_ERR -Session failure. -.It Bq Er PAM_SYSTEM_ERR -System error. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_open_session 3 , -.Xr pam_strerror 3 -.Sh STANDARDS -.Rs -.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" -.%D "June 1997" -.Re -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_sm_setcred.3 b/doc/man/pam_sm_setcred.3 deleted file mode 100644 index a03cc04..0000000 --- a/doc/man/pam_sm_setcred.3 +++ /dev/null @@ -1,100 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_sm_setcred.3#9 $ -.\" -.Dd May 24, 2002 -.Dt PAM_SM_SETCRED 3 -.Os -.Sh NAME -.Nm pam_sm_setcred -.Nd service module implementation for pam_setcred -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.In security/pam_modules.h -.Ft int -.Fn pam_sm_setcred "pam_handle_t *pamh" "int flags" "int argc" "const char **argv" -.Sh DESCRIPTION -The -.Nm -function is the service module's implementation of -the -.Xr pam_setcred 3 -API function. -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_ABORT -General failure. -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_CONV_ERR -Conversation failure. -.It Bq Er PAM_CRED_ERR -Failed to set user credentials. -.It Bq Er PAM_CRED_EXPIRED -User credentials have expired. -.It Bq Er PAM_CRED_UNAVAIL -Failed to retrieve user credentials. -.It Bq Er PAM_IGNORE -Ignore this module. -.It Bq Er PAM_PERM_DENIED -Permission denied. -.It Bq Er PAM_SERVICE_ERR -Error in service module. -.It Bq Er PAM_SYSTEM_ERR -System error. -.It Bq Er PAM_USER_UNKNOWN -Unknown user. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_setcred 3 , -.Xr pam_strerror 3 -.Sh STANDARDS -.Rs -.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" -.%D "June 1997" -.Re -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_start.3 b/doc/man/pam_start.3 deleted file mode 100644 index 2de4985..0000000 --- a/doc/man/pam_start.3 +++ /dev/null @@ -1,111 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_start.3#14 $ -.\" -.Dd May 24, 2002 -.Dt PAM_START 3 -.Os -.Sh NAME -.Nm pam_start -.Nd initiate a PAM transaction -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft int -.Fn pam_start "const char *service" "const char *user" "const struct pam_conv *pam_conv" "pam_handle_t **pamh" -.Sh DESCRIPTION -The -.Nm -function creates and initializes a PAM context. -.Pp -The -.Va service -argument specifies the name of the policy to apply, and is -stored in the -.Dv PAM_SERVICE -item in the created context. -.Pp -The -.Va user -argument specifies the name of the target user - the user the -created context will serve to authenticate. -It is stored in the -.Dv PAM_USER -item in the created context. -.Pp -The -.Va pam_conv -argument points to a -.Vt struct pam_conv -describing the -conversation function to use. -This structure is defined as follows: -.Pp -.Bd -literal - struct pam_conv { - int (*conv)(int, const struct pam_message **, - struct pam_response **, void *); - void *appdata_ptr; - }; -.Ed -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_SYSTEM_ERR -System error. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_end 3 , -.Xr pam_get_item 3 , -.Xr pam_set_item 3 , -.Xr pam_strerror 3 -.Sh STANDARDS -.Rs -.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" -.%D "June 1997" -.Re -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_strerror.3 b/doc/man/pam_strerror.3 deleted file mode 100644 index 9f31f28..0000000 --- a/doc/man/pam_strerror.3 +++ /dev/null @@ -1,77 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_strerror.3#13 $ -.\" -.Dd May 24, 2002 -.Dt PAM_STRERROR 3 -.Os -.Sh NAME -.Nm pam_strerror -.Nd get PAM standard error message string -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft const char * -.Fn pam_strerror "pam_handle_t *pamh" "int error_number" -.Sh DESCRIPTION -The -.Nm -function returns a pointer to a string containing a -textual description of the error indicated by the -.Va error_number -argument, in the context of the PAM transaction described by the -.Va pamh -argument. -.Sh RETURN VALUES -The -.Nm -function returns -.Dv NULL -on failure. -.Sh SEE ALSO -.Xr pam 3 -.Sh STANDARDS -.Rs -.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" -.%D "June 1997" -.Re -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_verror.3 b/doc/man/pam_verror.3 deleted file mode 100644 index 851b0be..0000000 --- a/doc/man/pam_verror.3 +++ /dev/null @@ -1,87 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_verror.3#11 $ -.\" -.Dd May 24, 2002 -.Dt PAM_VERROR 3 -.Os -.Sh NAME -.Nm pam_verror -.Nd display an error message -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft int -.Fn pam_verror "pam_handle_t *pamh" "const char *fmt" "va_list ap" -.Sh DESCRIPTION -The -.Nm -function passes its arguments to -.Xr pam_vprompt 3 -with a -style argument of -.Dv PAM_ERROR_MSG , -and discards the response. -.Pp -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_CONV_ERR -Conversation failure. -.It Bq Er PAM_SYSTEM_ERR -System error. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_error 3 , -.Xr pam_strerror 3 , -.Xr pam_vinfo 3 , -.Xr pam_vprompt 3 -.Sh STANDARDS -The -.Nm -function is an OpenPAM extension. -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_vinfo.3 b/doc/man/pam_vinfo.3 deleted file mode 100644 index 0e43f77..0000000 --- a/doc/man/pam_vinfo.3 +++ /dev/null @@ -1,87 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_vinfo.3#11 $ -.\" -.Dd May 24, 2002 -.Dt PAM_VINFO 3 -.Os -.Sh NAME -.Nm pam_vinfo -.Nd display an information message -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft int -.Fn pam_vinfo "pam_handle_t *pamh" "const char *fmt" "va_list ap" -.Sh DESCRIPTION -The -.Nm -function passes its arguments to -.Xr pam_vprompt 3 -with a -style argument of -.Dv PAM_TEXT_INFO , -and discards the response. -.Pp -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_CONV_ERR -Conversation failure. -.It Bq Er PAM_SYSTEM_ERR -System error. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_info 3 , -.Xr pam_strerror 3 , -.Xr pam_verror 3 , -.Xr pam_vprompt 3 -.Sh STANDARDS -The -.Nm -function is an OpenPAM extension. -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/doc/man/pam_vprompt.3 b/doc/man/pam_vprompt.3 deleted file mode 100644 index 848cf90..0000000 --- a/doc/man/pam_vprompt.3 +++ /dev/null @@ -1,123 +0,0 @@ -.\"- -.\" Copyright (c) 2002 Networks Associates Technology, Inc. -.\" All rights reserved. -.\" -.\" This software was developed for the FreeBSD Project by ThinkSec AS and -.\" NAI Labs, the Security Research Division of Network Associates, Inc. -.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the -.\" DARPA CHATS research program. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. The name of the author may not be used to endorse or promote -.\" products derived from this software without specific prior written -.\" permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $P4: //depot/projects/openpam/doc/man/pam_vprompt.3#11 $ -.\" -.Dd May 24, 2002 -.Dt PAM_VPROMPT 3 -.Os -.Sh NAME -.Nm pam_vprompt -.Nd call the conversation function -.Sh LIBRARY -.Lb libpam -.Sh SYNOPSIS -.In security/pam_appl.h -.Ft int -.Fn pam_vprompt "pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "va_list ap" -.Sh DESCRIPTION -The -.Nm -function constructs a string from the -.Va fmt -and -.Va ap -arguments using -.Xr vsnprintf 3 , -and passes it to the given PAM context's -conversation function. -.Pp -The -.Va style -argument specifies the type of interaction requested, and -must be one of the following: -.Bl -tag -width 18n -.It Dv PAM_PROMPT_ECHO_OFF -Display the message and obtain the user's response without -displaying it. -.It Dv PAM_PROMPT_ECHO_ON -Display the message and obtain the user's response. -.It Dv PAM_ERROR_MSG -Display the message as an error message, and do not wait -for a response. -.It Dv PAM_TEXT_INFO -Display the message as an informational message, and do -not wait for a response. -.El -A pointer to the response, or -.Dv NULL -if the conversation function did -not return one, is stored in the location pointed to by the -.Va resp -argument. -.Pp -The message and response should not exceed -.Dv PAM_MAX_MSG_SIZE -or -.Dv PAM_MAX_RESP_SIZE , -respectively. -If they do, they may be truncated. -.Pp -.Sh RETURN VALUES -The -.Nm -function returns one of the following values: -.Bl -tag -width 18n -.It Bq Er PAM_BUF_ERR -Memory buffer error. -.It Bq Er PAM_CONV_ERR -Conversation failure. -.It Bq Er PAM_SYSTEM_ERR -System error. -.El -.Sh SEE ALSO -.Xr pam 3 , -.Xr pam_error 3 , -.Xr pam_info 3 , -.Xr pam_prompt 3 , -.Xr pam_strerror 3 , -.Xr pam_verror 3 , -.Xr pam_vinfo 3 , -.Xr vsnprintf 3 -.Sh STANDARDS -The -.Nm -function is an OpenPAM extension. -.Sh AUTHORS -The -.Nm -function and this manual page were developed for the FreeBSD Project -by ThinkSec AS and NAI Labs, the Security Research Division of Network -Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 -.Pq Dq CBOSS , -as part of the DARPA CHATS research program. diff --git a/misc/gendoc.pl b/misc/gendoc.pl index cb4c69d..97e546d 100644 --- a/misc/gendoc.pl +++ b/misc/gendoc.pl @@ -32,14 +32,51 @@ # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF # SUCH DAMAGE. # -# $P4: //depot/projects/openpam/misc/gendoc.pl#14 $ +# $P4: //depot/projects/openpam/misc/gendoc.pl#15 $ # use strict; use Fcntl; +use Getopt::Std; use POSIX qw(strftime); use vars qw($COPYRIGHT $TODAY %FUNCTIONS %PAMERR); +$COPYRIGHT = ".\\\"- +.\\\" Copyright (c) 2002 Networks Associates Technology, Inc. +.\\\" All rights reserved. +.\\\" +.\\\" This software was developed for the FreeBSD Project by ThinkSec AS and +.\\\" NAI Labs, the Security Research Division of Network Associates, Inc. +.\\\" under DARPA/SPAWAR contract N66001-01-C-8035 (\"CBOSS\"), as part of the +.\\\" DARPA CHATS research program. +.\\\" +.\\\" Redistribution and use in source and binary forms, with or without +.\\\" modification, are permitted provided that the following conditions +.\\\" are met: +.\\\" 1. Redistributions of source code must retain the above copyright +.\\\" notice, this list of conditions and the following disclaimer. +.\\\" 2. Redistributions in binary form must reproduce the above copyright +.\\\" notice, this list of conditions and the following disclaimer in the +.\\\" documentation and/or other materials provided with the distribution. +.\\\" 3. The name of the author may not be used to endorse or promote +.\\\" products derived from this software without specific prior written +.\\\" permission. +.\\\" +.\\\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\\\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\\\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\\\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\\\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\\\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\\\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\\\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\\\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\\\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\\\" SUCH DAMAGE. +.\\\" +.\\\" \$" . "P4" . "\$ +.\\\""; + %PAMERR = ( PAM_SUCCESS => "Success", PAM_OPEN_ERR => "Failed to load module", @@ -91,7 +128,7 @@ sub parse_source($) { if ($fn !~ m,\.c$,) { warn("$fn: not C source, ignoring\n"); - return; + return undef; } sysopen(FILE, $fn, O_RDONLY) @@ -99,19 +136,14 @@ sub parse_source($) { $source = join('', ); close(FILE); - return if ($source =~ m/^ \* NOPARSE\s*$/m); + return undef + if ($source =~ m/^ \* NOPARSE\s*$/m); - if (!defined($COPYRIGHT) && $source =~ m,^(/\*-\n.*?)\s*\*/,s) { - $COPYRIGHT = $1; - $COPYRIGHT =~ s,^.\*,.\\\",gm; - $COPYRIGHT =~ s,(\$(?:)P4).*?\$,$1\$,; - $COPYRIGHT .= "\n.\\\""; - } $func = $fn; $func =~ s,^(?:.*/)?([^/]+)\.c$,$1,; if ($source !~ m,\n \* ([\S ]+)\n \*/\n\n([\S ]+)\n$func\((.*?)\)\n\{,s) { warn("$fn: can't find $func\n"); - return; + return undef; } ($descr, $type, $args) = ($1, $2, $3); $descr =~ s,^([A-Z][a-z]),lc($1),e; @@ -231,6 +263,7 @@ sub parse_source($) { } $FUNCTIONS{$func} = { + 'source' => $fn, 'name' => $func, 'descr' => $descr, 'type' => $type, @@ -249,6 +282,8 @@ sub parse_source($) { if ($source !~ m/^ \* XSSO \d/m) { $FUNCTIONS{$func}->{'openpam'} = 1; } + expand_errors($FUNCTIONS{$func}); + return $FUNCTIONS{$func}; } sub expand_errors($); @@ -256,6 +291,8 @@ sub expand_errors($) { my $func = shift; # Ref to function hash my %errors; + my $ref; + my $fn; if (defined($func->{'recursed'})) { warn("$func->{'name'}(): loop in error spec\n"); @@ -273,11 +310,17 @@ sub expand_errors($) { } elsif (m/^!(PAM_[A-Z_]+)$/) { # treat negations separately } elsif (m/^=([a-z_]+)$/) { - if (!defined($FUNCTIONS{$1})) { - warn("$func->{'name'}(): reference to unknown $1()\n"); + $ref = $1; + if (!defined($FUNCTIONS{$ref})) { + $fn = $func->{'source'}; + $fn =~ s/$func->{'name'}/$ref/; + parse_source($fn); + } + if (!defined($FUNCTIONS{$ref})) { + warn("$func->{'name'}(): reference to unknown $ref()\n"); next; } - foreach (expand_errors($FUNCTIONS{$1})) { + foreach (@{$FUNCTIONS{$ref}->{'errors'}}) { $errors{$_} = 1; } } else { @@ -290,7 +333,7 @@ sub expand_errors($) { } } delete($func->{'recursed'}); - return (sort(keys(%errors))); + $func->{'errors'} = [ sort(keys(%errors)) ]; } sub gendoc($) { @@ -332,7 +375,7 @@ The function returns one of the following values: .Bl -tag -width 18n "; - my @errors = expand_errors($func); + my @errors = @{$func->{'errors'}}; warn("$func->{'name'}(): no error specification\n") unless(@errors); foreach (@errors) { @@ -387,33 +430,59 @@ as part of the DARPA CHATS research program. } } +sub readproto($) { + my $fn = shift; # File name + + local *FILE; + my %func; + + sysopen(FILE, $fn, O_RDONLY) + or die("$fn: open(): $!\n"); + while () { + if (m/^\.Nm ((?:open)?pam_.*?)\s*$/) { + $func{'Nm'} = $func{'Nm'} || $1; + } elsif (m/^\.Ft (\S.*?)\s*$/) { + $func{'Ft'} = $func{'Ft'} || $1; + } elsif (m/^\.Fn (\S.*?)\s*$/) { + $func{'Fn'} = $func{'Fn'} || $1; + } + } + close(FILE); + if ($func{'Nm'}) { + $FUNCTIONS{$func{'Nm'}} = \%func; + } else { + warn("No function found\n"); + } +} + sub gensummary() { + local *FILE; my $func; - print "$COPYRIGHT + sysopen(FILE, "openpam.3", O_RDWR|O_CREAT|O_TRUNC) + or die("openpam.3: $!\n"); + + print FILE "$COPYRIGHT .Dd $TODAY .Dt PAM 3 .Os .Sh NAME "; - my @funcs = sort(keys(%FUNCTIONS)); - while ($func = shift(@funcs)) { - next if (defined($FUNCTIONS{$func}->{'nolist'})); - print ".Nm $func". (@funcs ? " ,\n" : "\n"); + foreach $func (sort(keys(%FUNCTIONS))) { + print FILE ".Nm $FUNCTIONS{$func}->{'Nm'}\n"; } - print ".Nd Pluggable Authentication Modules Library + print FILE ".Nd Pluggable Authentication Modules Library .Sh LIBRARY .Lb libpam .Sh SYNOPSIS .In security/pam_appl.h "; foreach $func (sort(keys(%FUNCTIONS))) { - next if (defined($FUNCTIONS{$func}->{'nolist'})); - print ".Ft $FUNCTIONS{$func}->{'type'}\n"; - print ".Fn $func $FUNCTIONS{$func}->{'args'}\n"; + print FILE ".Ft $FUNCTIONS{$func}->{'Ft'}\n"; + print FILE ".Fn $FUNCTIONS{$func}->{'Fn'}\n"; } - print ".Sh DESCRIPTION + print FILE ".Sh DESCRIPTION .Sh RETURN VALUES The following return codes are defined in the .In security/pam_constants.h @@ -421,16 +490,15 @@ header: .Bl -tag -width 18n "; foreach (sort(keys(%PAMERR))) { - print ".It Bq Er $_\n$PAMERR{$_}.\n"; + print FILE ".It Bq Er $_\n$PAMERR{$_}.\n"; } - print ".El + print FILE ".El .Sh SEE ALSO "; foreach $func (sort(keys(%FUNCTIONS))) { - next if (defined($FUNCTIONS{$func}->{'nolist'})); - print ".Xr $func 3 ,\n"; + print FILE ".Xr $func 3 ,\n"; } - print ".Xr pam.conf 5 + print FILE ".Xr pam.conf 5 .Sh STANDARDS .Rs .%T \"X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules\" @@ -443,17 +511,34 @@ Division of Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 .Pq Dq CBOSS , as part of the DARPA CHATS research program. -" +"; + close(FILE); +} + +sub usage() { + + print(STDERR "usage: gendoc [-s] source [...]\n"); + exit(1); } MAIN:{ + my %opts; + + usage() + unless (@ARGV && getopts("s", \%opts)); $TODAY = strftime("%B %e, %Y", localtime(time())); $TODAY =~ s,\s+, ,g; - foreach my $fn (@ARGV) { - parse_source($fn); + if ($opts{'s'}) { + foreach my $fn (@ARGV) { + readproto($fn); + } + gensummary(); + } else { + foreach my $fn (@ARGV) { + my $func = parse_source($fn); + gendoc($func) + if (defined($func)); + } } - foreach my $func (values(%FUNCTIONS)) { - gendoc($func); - } - gensummary(); + exit(0); }