From cf2fc5ff7b4a8555fda2a5ebe5f6ab0e45c22996 Mon Sep 17 00:00:00 2001 From: Stefan Schubert Date: Tue, 25 Oct 2022 16:29:41 +0200 Subject: doc: Update PAM documentation from DockBook 4 to DocBook 5 Changed files -------------- Make.xml.rules.in: - Using RNG file instead of DTD file for checking XML files. - Taking the correct stylesheet for README files. doc/sag/Makefile.am, doc/adg/Makefile.am, doc/mwg/Makefile.am: - Using RNG file instead of DTD file for checking XML files. configure.ac: - Adding a new option for selecting RNG check file (-enable-docbook-rng) - Switching stylesheets to docbook 5 - Checking DocBook 5 environment instead of DocBook 4 environment *.xml: Update from DockBook 4 to DocBook 5 --- doc/man/misc_conv.3.xml | 35 +++++++--------- doc/man/pam.3.xml | 40 +++++++++--------- doc/man/pam.8.xml | 85 ++++++++++++++++++-------------------- doc/man/pam.conf-desc.xml | 7 +--- doc/man/pam.conf-dir.xml | 9 ++-- doc/man/pam.conf-syntax.xml | 12 ++---- doc/man/pam.conf.5.xml | 28 +++++-------- doc/man/pam_acct_mgmt.3.xml | 20 ++++----- doc/man/pam_authenticate.3.xml | 20 ++++----- doc/man/pam_chauthtok.3.xml | 20 ++++----- doc/man/pam_close_session.3.xml | 21 ++++------ doc/man/pam_conv.3.xml | 20 ++++----- doc/man/pam_end.3.xml | 21 ++++------ doc/man/pam_error.3.xml | 23 +++++------ doc/man/pam_fail_delay.3.xml | 27 ++++++------ doc/man/pam_get_authtok.3.xml | 33 +++++++-------- doc/man/pam_get_data.3.xml | 21 ++++------ doc/man/pam_get_item.3.xml | 33 +++++---------- doc/man/pam_get_user.3.xml | 21 ++++------ doc/man/pam_getenv.3.xml | 20 ++++----- doc/man/pam_getenvlist.3.xml | 20 ++++----- doc/man/pam_info.3.xml | 23 +++++------ doc/man/pam_item_types_ext.inc.xml | 5 +-- doc/man/pam_item_types_std.inc.xml | 5 +-- doc/man/pam_misc_drop_env.3.xml | 21 ++++------ doc/man/pam_misc_paste_env.3.xml | 21 ++++------ doc/man/pam_misc_setenv.3.xml | 21 ++++------ doc/man/pam_open_session.3.xml | 21 ++++------ doc/man/pam_prompt.3.xml | 23 +++++------ doc/man/pam_putenv.3.xml | 20 ++++----- doc/man/pam_set_data.3.xml | 21 ++++------ doc/man/pam_set_item.3.xml | 33 +++++---------- doc/man/pam_setcred.3.xml | 21 ++++------ doc/man/pam_sm_acct_mgmt.3.xml | 22 +++++----- doc/man/pam_sm_authenticate.3.xml | 22 +++++----- doc/man/pam_sm_chauthtok.3.xml | 30 +++++++------- doc/man/pam_sm_close_session.3.xml | 22 +++++----- doc/man/pam_sm_open_session.3.xml | 22 +++++----- doc/man/pam_sm_setcred.3.xml | 24 +++++------ doc/man/pam_start.3.xml | 21 ++++------ doc/man/pam_strerror.3.xml | 21 ++++------ doc/man/pam_syslog.3.xml | 21 ++++------ doc/man/pam_xauth_data.3.xml | 21 ++++------ 43 files changed, 432 insertions(+), 565 deletions(-) (limited to 'doc/man') diff --git a/doc/man/misc_conv.3.xml b/doc/man/misc_conv.3.xml index d902ba83..92d4acd1 100644 --- a/doc/man/misc_conv.3.xml +++ b/doc/man/misc_conv.3.xml @@ -1,16 +1,13 @@ - - - - + misc_conv 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + misc_conv text based conversation function @@ -18,7 +15,7 @@ - + #include <security/pam_misc.h> int misc_conv @@ -30,7 +27,7 @@ - + DESCRIPTION The misc_conv function is part of @@ -50,7 +47,7 @@ - time_t pam_misc_conv_warn_time; + time_t pam_misc_conv_warn_time; This variable contains the time (as @@ -67,7 +64,7 @@ - const char *pam_misc_conv_warn_line; + const char *pam_misc_conv_warn_line; Used in conjunction with @@ -83,7 +80,7 @@ - time_t pam_misc_conv_die_time; + time_t pam_misc_conv_die_time; This variable contains the time (as @@ -100,7 +97,7 @@ - const char *pam_misc_conv_die_line; + const char *pam_misc_conv_die_line; Used in conjunction with @@ -116,7 +113,7 @@ - int pam_misc_conv_died; + int pam_misc_conv_died; Following a return from the Linux-PAM @@ -136,7 +133,7 @@ - int (*pam_binary_handler_fn)(void *appdata, pamc_bp_t *prompt_p); + int (*pam_binary_handler_fn)(void *appdata, pamc_bp_t *prompt_p); @@ -151,7 +148,7 @@ - int (*pam_binary_handler_free)(void *appdata, pamc_bp_t *delete_me); + int (*pam_binary_handler_free)(void *appdata, pamc_bp_t *delete_me); @@ -164,7 +161,7 @@ - + SEE ALSO @@ -176,7 +173,7 @@ - + STANDARDS The misc_conv function is part of the @@ -185,4 +182,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam.3.xml b/doc/man/pam.3.xml index 0b1efccf..4b828016 100644 --- a/doc/man/pam.3.xml +++ b/doc/man/pam.3.xml @@ -1,20 +1,18 @@ - - - + pam 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam Pluggable Authentication Modules Library - + #include <security/pam_appl.h> #include <security/pam_modules.h> @@ -22,10 +20,10 @@ - + DESCRIPTION - PAM is a system of libraries + PAM is a system of libraries that handle the authentication tasks of applications (services) on the system. The library provides a stable general interface (Application Programming Interface - API) that privilege granting @@ -38,7 +36,7 @@ defer to to perform standard authentication tasks. - + Initialization and Cleanup The @@ -64,7 +62,7 @@ - + Authentication The @@ -85,7 +83,7 @@ - + Account Management The @@ -98,7 +96,7 @@ - + Password Management The @@ -109,7 +107,7 @@ - + Session Management The @@ -124,7 +122,7 @@ - + Conversation The PAM library uses an application-defined callback to allow @@ -141,7 +139,7 @@ - + Data Objects The @@ -176,7 +174,7 @@ - + Environment and Error Management The @@ -202,7 +200,7 @@ - + RETURN VALUES The following return codes are known by PAM: @@ -389,7 +387,7 @@ - SEE ALSO + SEE ALSO pam_acct_mgmt3 @@ -430,10 +428,10 @@ - NOTES + NOTES The libpam interfaces are only thread-safe if each thread within the multithreaded application uses its own PAM handle. - + \ No newline at end of file diff --git a/doc/man/pam.8.xml b/doc/man/pam.8.xml index 8eef665a..20cd19d9 100644 --- a/doc/man/pam.8.xml +++ b/doc/man/pam.8.xml @@ -1,32 +1,29 @@ - - - - + pam 8 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + PAM pam Pluggable Authentication Modules for Linux - + DESCRIPTION This manual is intended to offer a quick introduction to - Linux-PAM. For more information + Linux-PAM. For more information the reader is directed to the - Linux-PAM system administrators' guide. + Linux-PAM system administrators' guide. - Linux-PAM is a system of libraries + Linux-PAM is a system of libraries that handle the authentication tasks of applications (services) on the system. The library provides a stable general interface (Application Programming Interface - API) that privilege granting @@ -43,12 +40,12 @@ system administrator is free to choose how individual service-providing applications will authenticate users. This dynamic configuration is set by the contents of the single - Linux-PAM configuration file + Linux-PAM configuration file /etc/pam.conf. Alternatively, the configuration can be set by individual configuration files located in the /etc/pam.d/ directory. The presence of this - directory will cause Linux-PAM to - ignore /etc/pam.conf. + directory will cause Linux-PAM to + ignore /etc/pam.conf. @@ -64,26 +61,26 @@ From the point of view of the system administrator, for whom this manual is provided, it is not of primary importance to understand the internal behavior of the -Linux-PAM +Linux-PAM library. The important point to recognize is that the configuration file(s) -define +define the connection between applications -(services) +(services) and the pluggable authentication modules -(PAMs) +(PAMs) that perform the actual authentication tasks. -Linux-PAM +Linux-PAM separates the tasks of -authentication +authentication into four independent management groups: -account management; -authentication management; -password management; +account management; +authentication management; +password management; and -session management. +session management. (We highlight the abbreviations used for these groups in the configuration file.) @@ -92,12 +89,12 @@ configuration file.) user's request for a restricted service: -account - +account - provide account verification types of service: has the user's password expired?; is this user permitted access to the requested service? -authentication - +authentication - authenticate a user and set up user credentials. Typically this is via some challenge-response request that the user must satisfy: if you are who you claim to be please enter your password. Not all authentications @@ -105,64 +102,64 @@ are of this type, there exist hardware based authentication schemes (such as the use of smart-cards and biometric devices), with suitable modules, these may be substituted seamlessly for more standard approaches to authentication - such is the flexibility of -Linux-PAM. +Linux-PAM. -password - +password - this group's responsibility is the task of updating authentication mechanisms. Typically, such services are strongly coupled to those of the -auth +auth group. Some authentication mechanisms lend themselves well to being updated with such a function. Standard UN*X password-based access is the obvious example: please enter a replacement password. -session - +session - this group of tasks cover things that should be done prior to a service being given and after it is withdrawn. Such tasks include the maintenance of audit trails and the mounting of the user's home directory. The -session +session management group is important as it provides both an opening and closing hook for modules to affect the services available to a user. - + FILES - /etc/pam.conf + /etc/pam.conf the configuration file - /etc/pam.d + /etc/pam.d - the Linux-PAM configuration + the Linux-PAM configuration directory. Generally, if this directory is present, the /etc/pam.conf file is ignored. - /usr/lib/pam.d + /usr/lib/pam.d - the Linux-PAM vendor configuration + the Linux-PAM vendor configuration directory. Files in /etc/pam.d override files with the same name in this directory. - %vendordir%/pam.d + %vendordir%/pam.d - the Linux-PAM vendor configuration + the Linux-PAM vendor configuration directory. Files in /etc/pam.d and /usr/lib/pam.d override files with the same name in this directory. @@ -172,18 +169,18 @@ closing hook for modules to affect the services available to a user. - + ERRORS Typically errors generated by the - Linux-PAM system of libraries, will + Linux-PAM system of libraries, will be written to syslog3 . - + CONFORMING TO DCE-RFC 86.0, October 1995. @@ -192,7 +189,7 @@ closing hook for modules to affect the services available to a user. - + SEE ALSO @@ -212,4 +209,4 @@ closing hook for modules to affect the services available to a user. - + \ No newline at end of file diff --git a/doc/man/pam.conf-desc.xml b/doc/man/pam.conf-desc.xml index 909dcdbe..5dca89fe 100644 --- a/doc/man/pam.conf-desc.xml +++ b/doc/man/pam.conf-desc.xml @@ -1,7 +1,4 @@ - - -
+
When a PAM aware privilege granting application is started, it activates its attachment to the PAM-API. This @@ -18,4 +15,4 @@ behavior of the PAM-API in the event that individual PAMs fail. -
+
\ No newline at end of file diff --git a/doc/man/pam.conf-dir.xml b/doc/man/pam.conf-dir.xml index 8446cf35..8272337b 100644 --- a/doc/man/pam.conf-dir.xml +++ b/doc/man/pam.conf-dir.xml @@ -1,7 +1,4 @@ - - -
+
More flexible than the single configuration file is it to configure libpam via the contents of the @@ -25,6 +22,6 @@ type control module-path module-arguments The only difference being that the service-name is not present. The service-name is of course the name of the given configuration file. For example, /etc/pam.d/login contains the - configuration for the login service. + configuration for the login service. -
+
\ No newline at end of file diff --git a/doc/man/pam.conf-syntax.xml b/doc/man/pam.conf-syntax.xml index 5112f930..c7d90081 100644 --- a/doc/man/pam.conf-syntax.xml +++ b/doc/man/pam.conf-syntax.xml @@ -1,8 +1,4 @@ - - - -
+
The syntax of the /etc/pam.conf configuration file is as follows. The file is made up of a list @@ -18,7 +14,7 @@ - service type control module-path module-arguments + service type control module-path module-arguments @@ -411,7 +407,7 @@ should use `\]'. In other words: - [..[..\]..] --> ..[..].. + [..[..\]..] --> ..[..].. @@ -424,4 +420,4 @@ . -
+
\ No newline at end of file diff --git a/doc/man/pam.conf.5.xml b/doc/man/pam.conf.5.xml index 68f576af..62a2b410 100644 --- a/doc/man/pam.conf.5.xml +++ b/doc/man/pam.conf.5.xml @@ -1,15 +1,13 @@ - - - + pam.conf 5 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam.conf pam.d PAM configuration files @@ -17,22 +15,16 @@ - + DESCRIPTION - + - + - + - + SEE ALSO @@ -47,4 +39,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_acct_mgmt.3.xml b/doc/man/pam_acct_mgmt.3.xml index 59760d7f..de6a94ab 100644 --- a/doc/man/pam_acct_mgmt.3.xml +++ b/doc/man/pam_acct_mgmt.3.xml @@ -1,14 +1,12 @@ - - - + pam_acct_mgmt 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_acct_mgmt PAM account validation management @@ -16,7 +14,7 @@ - + #include <security/pam_appl.h> int pam_acct_mgmt @@ -27,7 +25,7 @@ - + DESCRIPTION The pam_acct_mgmt function is used to determine @@ -62,7 +60,7 @@ - + RETURN VALUES @@ -122,7 +120,7 @@ - + SEE ALSO @@ -142,4 +140,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_authenticate.3.xml b/doc/man/pam_authenticate.3.xml index c2004eb4..794a5c71 100644 --- a/doc/man/pam_authenticate.3.xml +++ b/doc/man/pam_authenticate.3.xml @@ -1,14 +1,12 @@ - - - + pam_authenticate 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_authenticate account authentication @@ -16,7 +14,7 @@ - + #include <security/pam_appl.h> int pam_authenticate @@ -27,7 +25,7 @@ - + DESCRIPTION The pam_authenticate function is used to @@ -77,7 +75,7 @@ - + RETURN VALUES @@ -146,7 +144,7 @@ - + SEE ALSO @@ -166,4 +164,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_chauthtok.3.xml b/doc/man/pam_chauthtok.3.xml index f42bc68f..e184f45f 100644 --- a/doc/man/pam_chauthtok.3.xml +++ b/doc/man/pam_chauthtok.3.xml @@ -1,14 +1,12 @@ - - - + pam_chauthtok 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_chauthtok updating authentication tokens @@ -16,7 +14,7 @@ - + #include <security/pam_appl.h> int pam_chauthtok @@ -27,7 +25,7 @@ - + DESCRIPTION The pam_chauthtok function is used to change the @@ -64,7 +62,7 @@ - + RETURN VALUES @@ -138,7 +136,7 @@ - + SEE ALSO @@ -161,4 +159,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_close_session.3.xml b/doc/man/pam_close_session.3.xml index db549bda..e1c74ebd 100644 --- a/doc/man/pam_close_session.3.xml +++ b/doc/man/pam_close_session.3.xml @@ -1,16 +1,13 @@ - - - - + pam_close_session 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_close_session terminate PAM session management @@ -18,7 +15,7 @@ - + #include <security/pam_appl.h> int pam_close_session @@ -29,7 +26,7 @@ - + DESCRIPTION The pam_close_session function is used @@ -63,7 +60,7 @@ - + RETURN VALUES @@ -101,7 +98,7 @@ - + SEE ALSO @@ -112,4 +109,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_conv.3.xml b/doc/man/pam_conv.3.xml index 5106ddf7..31834f3c 100644 --- a/doc/man/pam_conv.3.xml +++ b/doc/man/pam_conv.3.xml @@ -1,14 +1,12 @@ - - - + pam_conv 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_conv PAM conversation function @@ -16,7 +14,7 @@ - + #include <security/pam_appl.h> @@ -38,7 +36,7 @@ struct pam_conv { - + DESCRIPTION The PAM library uses an application-defined callback to allow @@ -174,7 +172,7 @@ struct pam_conv { - + RETURN VALUES @@ -205,7 +203,7 @@ struct pam_conv { - + SEE ALSO @@ -225,4 +223,4 @@ struct pam_conv { - + \ No newline at end of file diff --git a/doc/man/pam_end.3.xml b/doc/man/pam_end.3.xml index 5febf85a..b2584e73 100644 --- a/doc/man/pam_end.3.xml +++ b/doc/man/pam_end.3.xml @@ -1,16 +1,13 @@ - - - - + pam_end 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_end termination of PAM transaction @@ -18,7 +15,7 @@ - + #include <security/pam_appl.h> int pam_end @@ -29,7 +26,7 @@ - + DESCRIPTION The pam_end function terminates the PAM @@ -79,7 +76,7 @@ - + RETURN VALUES @@ -102,7 +99,7 @@ - + SEE ALSO @@ -119,4 +116,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_error.3.xml b/doc/man/pam_error.3.xml index de167f2c..0f294c22 100644 --- a/doc/man/pam_error.3.xml +++ b/doc/man/pam_error.3.xml @@ -1,16 +1,13 @@ - - - - + pam_error 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_error pam_verror display error messages to the user @@ -18,7 +15,7 @@ - + #include <security/pam_ext.h> @@ -36,7 +33,7 @@ - + DESCRIPTION The pam_error function prints error messages @@ -51,7 +48,7 @@ variable argument list macros. - + RETURN VALUES @@ -89,7 +86,7 @@ - + SEE ALSO @@ -110,7 +107,7 @@ - + STANDARDS The pam_error and pam_verror @@ -118,4 +115,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_fail_delay.3.xml b/doc/man/pam_fail_delay.3.xml index 53c1f89e..c400736a 100644 --- a/doc/man/pam_fail_delay.3.xml +++ b/doc/man/pam_fail_delay.3.xml @@ -1,16 +1,13 @@ - - - - + pam_fail_delay 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_fail_delay request a delay on failure @@ -18,7 +15,7 @@ - + #include <security/pam_appl.h> int pam_fail_delay @@ -28,7 +25,7 @@ - + DESCRIPTION The pam_fail_delay function provides a @@ -105,7 +102,7 @@ void (*delay_fn)(int retval, unsigned usec_delay, void *appdata_ptr); - + RATIONALE It is often possible to attack an authentication scheme by exploiting @@ -129,7 +126,7 @@ void (*delay_fn)(int retval, unsigned usec_delay, void *appdata_ptr); - + EXAMPLE For example, a login application may require a failure delay of @@ -161,7 +158,7 @@ module #2: pam_fail_delay (pamh, 4000000); - + RETURN VALUES @@ -183,7 +180,7 @@ module #2: pam_fail_delay (pamh, 4000000); - + SEE ALSO @@ -198,7 +195,7 @@ module #2: pam_fail_delay (pamh, 4000000); - + STANDARDS The pam_fail_delay function is an @@ -206,4 +203,4 @@ module #2: pam_fail_delay (pamh, 4000000); - + \ No newline at end of file diff --git a/doc/man/pam_get_authtok.3.xml b/doc/man/pam_get_authtok.3.xml index 5d50b168..ba6d955e 100644 --- a/doc/man/pam_get_authtok.3.xml +++ b/doc/man/pam_get_authtok.3.xml @@ -1,16 +1,13 @@ - - - - + pam_get_authtok 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_get_authtok pam_get_authtok_verify pam_get_authtok_noverify @@ -19,7 +16,7 @@ - + #include <security/pam_ext.h> @@ -44,7 +41,7 @@ - + DESCRIPTION The pam_get_authtok function returns the @@ -119,7 +116,7 @@ - + OPTIONS pam_get_authtok honours the following module @@ -128,7 +125,7 @@ - + try_first_pass @@ -140,7 +137,7 @@ - + use_first_pass @@ -153,7 +150,7 @@ - + use_authtok @@ -166,7 +163,7 @@ - + authtok_type=XXX @@ -182,7 +179,7 @@ - + RETURN VALUES @@ -228,7 +225,7 @@ - + SEE ALSO @@ -237,7 +234,7 @@ - + STANDARDS The pam_get_authtok function is a Linux-PAM @@ -245,4 +242,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_get_data.3.xml b/doc/man/pam_get_data.3.xml index e84e5a4c..1e71cf3b 100644 --- a/doc/man/pam_get_data.3.xml +++ b/doc/man/pam_get_data.3.xml @@ -1,16 +1,13 @@ - - - - + pam_get_data 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_get_data get module internal data @@ -22,7 +19,7 @@ - + #include <security/pam_modules.h> int pam_get_data @@ -35,7 +32,7 @@ - + DESCRIPTION This function together with the @@ -58,7 +55,7 @@ - + RETURN VALUES @@ -90,7 +87,7 @@ - + SEE ALSO @@ -105,4 +102,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_get_item.3.xml b/doc/man/pam_get_item.3.xml index 1145273c..c30a279f 100644 --- a/doc/man/pam_get_item.3.xml +++ b/doc/man/pam_get_item.3.xml @@ -1,22 +1,13 @@ - - - ---> -]> - - + pam_get_item 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_get_item getting PAM information @@ -28,7 +19,7 @@ - + #include <security/pam_modules.h> int pam_get_item @@ -41,7 +32,7 @@ - + DESCRIPTION The pam_get_item function allows applications @@ -55,16 +46,14 @@ item_type: - + The following additional items are specific to Linux-PAM and should not be used in portable applications: - + If a service module wishes to obtain the name of the user, @@ -80,7 +69,7 @@ - + RETURN VALUES @@ -128,7 +117,7 @@ - + SEE ALSO @@ -140,4 +129,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_get_user.3.xml b/doc/man/pam_get_user.3.xml index 8bb176e4..121b3aa7 100644 --- a/doc/man/pam_get_user.3.xml +++ b/doc/man/pam_get_user.3.xml @@ -1,16 +1,13 @@ - - - - + pam_get_user 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_get_user get user name @@ -22,7 +19,7 @@ - + #include <security/pam_modules.h> int pam_get_user @@ -35,7 +32,7 @@ - + DESCRIPTION The pam_get_user function returns the @@ -87,7 +84,7 @@ - + RETURN VALUES @@ -143,7 +140,7 @@ - + SEE ALSO @@ -161,4 +158,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_getenv.3.xml b/doc/man/pam_getenv.3.xml index 7e8db015..df25863b 100644 --- a/doc/man/pam_getenv.3.xml +++ b/doc/man/pam_getenv.3.xml @@ -1,14 +1,12 @@ - - - + pam_getenv 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_getenv get a PAM environment variable @@ -16,7 +14,7 @@ - + #include <security/pam_appl.h> const char *pam_getenv @@ -27,7 +25,7 @@ - + DESCRIPTION The pam_getenv function searches the @@ -39,7 +37,7 @@ - + RETURN VALUES The pam_getenv function returns NULL @@ -47,7 +45,7 @@ - + SEE ALSO @@ -64,4 +62,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_getenvlist.3.xml b/doc/man/pam_getenvlist.3.xml index 1c29b737..54b1f411 100644 --- a/doc/man/pam_getenvlist.3.xml +++ b/doc/man/pam_getenvlist.3.xml @@ -1,14 +1,12 @@ - - - + pam_getenvlist 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_getenvlist getting the PAM environment @@ -16,7 +14,7 @@ - + #include <security/pam_appl.h> char **pam_getenvlist @@ -26,7 +24,7 @@ - + DESCRIPTION The pam_getenvlist function returns a complete @@ -57,7 +55,7 @@ - + RETURN VALUES The pam_getenvlist function returns NULL @@ -65,7 +63,7 @@ - + SEE ALSO @@ -82,4 +80,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_info.3.xml b/doc/man/pam_info.3.xml index 88e671c7..5155d419 100644 --- a/doc/man/pam_info.3.xml +++ b/doc/man/pam_info.3.xml @@ -1,16 +1,13 @@ - - - - + pam_info 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_info pam_vinfo display messages to the user @@ -18,7 +15,7 @@ - + #include <security/pam_ext.h> @@ -36,7 +33,7 @@ - + DESCRIPTION The pam_info function prints messages @@ -51,7 +48,7 @@ variable argument list macros. - + RETURN VALUES @@ -89,7 +86,7 @@ - + SEE ALSO @@ -98,7 +95,7 @@ - + STANDARDS The pam_info and pam_vinfo @@ -106,4 +103,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_item_types_ext.inc.xml b/doc/man/pam_item_types_ext.inc.xml index d36a5bd1..a5fee9c2 100644 --- a/doc/man/pam_item_types_ext.inc.xml +++ b/doc/man/pam_item_types_ext.inc.xml @@ -1,6 +1,5 @@ - - + PAM_FAIL_DELAY @@ -58,4 +57,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_item_types_std.inc.xml b/doc/man/pam_item_types_std.inc.xml index 81f240b0..9b229486 100644 --- a/doc/man/pam_item_types_std.inc.xml +++ b/doc/man/pam_item_types_std.inc.xml @@ -1,6 +1,5 @@ - - + PAM_SERVICE @@ -135,4 +134,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_misc_drop_env.3.xml b/doc/man/pam_misc_drop_env.3.xml index 1941f589..a7f6cc80 100644 --- a/doc/man/pam_misc_drop_env.3.xml +++ b/doc/man/pam_misc_drop_env.3.xml @@ -1,16 +1,13 @@ - - - - + pam_misc_drop_env 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_misc_drop_env liberating a locally saved environment @@ -18,7 +15,7 @@ - + #include <security/pam_misc.h> int pam_misc_drop_env @@ -27,7 +24,7 @@ - + DESCRIPTION This function is defined to complement the @@ -39,7 +36,7 @@ - + SEE ALSO @@ -51,7 +48,7 @@ - + STANDARDS The pam_misc_drop_env function is part of the @@ -60,4 +57,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_misc_paste_env.3.xml b/doc/man/pam_misc_paste_env.3.xml index d9a282c0..06194a9d 100644 --- a/doc/man/pam_misc_paste_env.3.xml +++ b/doc/man/pam_misc_paste_env.3.xml @@ -1,16 +1,13 @@ - - - - + pam_misc_paste_env 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_misc_paste_env transcribing an environment to that of PAM @@ -18,7 +15,7 @@ - + #include <security/pam_misc.h> int pam_misc_paste_env @@ -28,7 +25,7 @@ - + DESCRIPTION This function takes the supplied list of environment pointers and @@ -37,7 +34,7 @@ - + SEE ALSO @@ -49,7 +46,7 @@ - + STANDARDS The pam_misc_paste_env function is part of the @@ -58,4 +55,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_misc_setenv.3.xml b/doc/man/pam_misc_setenv.3.xml index 7e61a8dd..4414d54d 100644 --- a/doc/man/pam_misc_setenv.3.xml +++ b/doc/man/pam_misc_setenv.3.xml @@ -1,15 +1,12 @@ - - - - + pam_misc_setenv 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_misc_setenv BSD like PAM environment variable setting @@ -17,7 +14,7 @@ - + #include <security/pam_misc.h> int pam_misc_setenv @@ -29,7 +26,7 @@ - + DESCRIPTION This function performs a task equivalent to @@ -44,7 +41,7 @@ - + SEE ALSO @@ -56,7 +53,7 @@ - + STANDARDS The pam_misc_setenv function is part of the @@ -65,4 +62,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_open_session.3.xml b/doc/man/pam_open_session.3.xml index eba0bc01..d37b3e59 100644 --- a/doc/man/pam_open_session.3.xml +++ b/doc/man/pam_open_session.3.xml @@ -1,16 +1,13 @@ - - - - + pam_open_session 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_open_session start PAM session management @@ -18,7 +15,7 @@ - + #include <security/pam_appl.h> int pam_open_session @@ -29,7 +26,7 @@ - + DESCRIPTION The pam_open_session function sets up a @@ -63,7 +60,7 @@ - + RETURN VALUES @@ -101,7 +98,7 @@ - + SEE ALSO @@ -112,4 +109,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_prompt.3.xml b/doc/man/pam_prompt.3.xml index bf0c9bf6..c65a0c90 100644 --- a/doc/man/pam_prompt.3.xml +++ b/doc/man/pam_prompt.3.xml @@ -1,16 +1,13 @@ - - - - + pam_prompt 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_prompt pam_vprompt interface to conversation function @@ -18,7 +15,7 @@ - + #include <security/pam_ext.h> @@ -40,7 +37,7 @@ - + DESCRIPTION The pam_prompt function constructs a message @@ -52,7 +49,7 @@ - + RETURN VALUES @@ -91,7 +88,7 @@ - + SEE ALSO @@ -103,7 +100,7 @@ - + STANDARDS The pam_prompt and pam_vprompt @@ -111,4 +108,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_putenv.3.xml b/doc/man/pam_putenv.3.xml index 2d4afbc5..7267046f 100644 --- a/doc/man/pam_putenv.3.xml +++ b/doc/man/pam_putenv.3.xml @@ -1,14 +1,12 @@ - - - + pam_putenv 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_putenv set or change PAM environment variable @@ -16,7 +14,7 @@ - + #include <security/pam_appl.h> int pam_putenv @@ -27,7 +25,7 @@ - + DESCRIPTION The pam_putenv function is used to @@ -83,7 +81,7 @@ - + RETURN VALUES @@ -129,7 +127,7 @@ - + SEE ALSO @@ -149,4 +147,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_set_data.3.xml b/doc/man/pam_set_data.3.xml index c20068c6..2bcfeb0b 100644 --- a/doc/man/pam_set_data.3.xml +++ b/doc/man/pam_set_data.3.xml @@ -1,16 +1,13 @@ - - - - + pam_set_data 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_set_data set module internal data @@ -22,7 +19,7 @@ - + #include <security/pam_modules.h> int pam_set_data @@ -36,7 +33,7 @@ - + DESCRIPTION The pam_set_data function associates a pointer @@ -123,7 +120,7 @@ - + RETURN VALUES @@ -154,7 +151,7 @@ - + SEE ALSO @@ -169,4 +166,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_set_item.3.xml b/doc/man/pam_set_item.3.xml index 30ab92b9..1dbaeebf 100644 --- a/doc/man/pam_set_item.3.xml +++ b/doc/man/pam_set_item.3.xml @@ -1,22 +1,13 @@ - - - ---> -]> - - + pam_set_item 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_set_item set and update PAM information @@ -28,7 +19,7 @@ - + #include <security/pam_modules.h> int pam_set_item @@ -41,7 +32,7 @@ - + DESCRIPTION The pam_set_item function allows applications @@ -52,16 +43,14 @@ supported: - + The following additional items are specific to Linux-PAM and should not be used in portable applications: - + For all item_types, other than PAM_CONV and @@ -81,7 +70,7 @@ - + RETURN VALUES @@ -121,7 +110,7 @@ - + SEE ALSO @@ -133,4 +122,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_setcred.3.xml b/doc/man/pam_setcred.3.xml index 62922482..09fe30d1 100644 --- a/doc/man/pam_setcred.3.xml +++ b/doc/man/pam_setcred.3.xml @@ -1,16 +1,13 @@ - - - - + pam_setcred 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_setcred establish / delete user credentials @@ -19,7 +16,7 @@ - + #include <security/pam_appl.h> int pam_setcred @@ -30,7 +27,7 @@ - + DESCRIPTION The pam_setcred function is used to establish, @@ -95,7 +92,7 @@ - + RETURN VALUES @@ -160,7 +157,7 @@ - + SEE ALSO @@ -177,4 +174,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_sm_acct_mgmt.3.xml b/doc/man/pam_sm_acct_mgmt.3.xml index b37dc306..822a338a 100644 --- a/doc/man/pam_sm_acct_mgmt.3.xml +++ b/doc/man/pam_sm_acct_mgmt.3.xml @@ -1,14 +1,12 @@ - - - + pam_sm_acct_mgmt 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_sm_acct_mgmt PAM service function for account management @@ -16,7 +14,7 @@ - + #include <security/pam_modules.h> int pam_sm_acct_mgmt @@ -29,7 +27,7 @@ - + DESCRIPTION The pam_sm_acct_mgmt function is the service @@ -64,7 +62,7 @@ PAM_DISALLOW_NULL_AUTHTOK - Return PAM_AUTH_ERR if the + Return PAM_AUTH_ERR if the database of authentication tokens for this authentication mechanism has a NULL entry for the user. @@ -73,7 +71,7 @@ - + RETURN VALUES @@ -131,7 +129,7 @@ - + SEE ALSO @@ -151,4 +149,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_sm_authenticate.3.xml b/doc/man/pam_sm_authenticate.3.xml index ef3a8f15..ec3de2fd 100644 --- a/doc/man/pam_sm_authenticate.3.xml +++ b/doc/man/pam_sm_authenticate.3.xml @@ -1,14 +1,12 @@ - - - + pam_sm_authenticate 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_sm_authenticate PAM service function for user authentication @@ -16,7 +14,7 @@ - + #include <security/pam_modules.h> int pam_sm_authenticate @@ -29,7 +27,7 @@ - + DESCRIPTION The pam_sm_authenticate function is the service @@ -58,7 +56,7 @@ PAM_DISALLOW_NULL_AUTHTOK - Return PAM_AUTH_ERR if the + Return PAM_AUTH_ERR if the database of authentication tokens for this authentication mechanism has a NULL entry for the user. Without this flag, such a NULL token @@ -69,7 +67,7 @@ - + RETURN VALUES @@ -128,7 +126,7 @@ - + SEE ALSO @@ -148,4 +146,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_sm_chauthtok.3.xml b/doc/man/pam_sm_chauthtok.3.xml index 25e17d02..692bc620 100644 --- a/doc/man/pam_sm_chauthtok.3.xml +++ b/doc/man/pam_sm_chauthtok.3.xml @@ -1,14 +1,12 @@ - - - + pam_sm_chauthtok 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_sm_chauthtok PAM service function for authentication token management @@ -16,7 +14,7 @@ - + #include <security/pam_modules.h> int pam_sm_chauthtok @@ -29,7 +27,7 @@ - + DESCRIPTION The pam_sm_chauthtok function is the service @@ -77,7 +75,7 @@ some network it should attempt to verify it can connect to this system on receiving this flag. If a module cannot establish it is ready to update the user's authentication token it should - return PAM_TRY_AGAIN, this + return PAM_TRY_AGAIN, this information will be passed back to the application. @@ -93,7 +91,7 @@ This informs the module that this is the call it should change the authorization tokens. If the flag is logically OR'd with - PAM_CHANGE_EXPIRED_AUTHTOK, the + PAM_CHANGE_EXPIRED_AUTHTOK, the token is only changed if it has actually expired. @@ -101,15 +99,15 @@ The PAM library calls this function twice in succession. The first - time with PAM_PRELIM_CHECK and then, + time with PAM_PRELIM_CHECK and then, if the module does not return - PAM_TRY_AGAIN, subsequently with - PAM_UPDATE_AUTHTOK. It is only on + PAM_TRY_AGAIN, subsequently with + PAM_UPDATE_AUTHTOK. It is only on the second call that the authorization token is (possibly) changed. - + RETURN VALUES @@ -181,7 +179,7 @@ - + SEE ALSO @@ -201,4 +199,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_sm_close_session.3.xml b/doc/man/pam_sm_close_session.3.xml index 6d8278ec..e76693fd 100644 --- a/doc/man/pam_sm_close_session.3.xml +++ b/doc/man/pam_sm_close_session.3.xml @@ -1,14 +1,12 @@ - - - + pam_sm_close_session 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_sm_close_session PAM service function to terminate session management @@ -16,7 +14,7 @@ - + #include <security/pam_modules.h> int pam_sm_close_session @@ -29,7 +27,7 @@ - + DESCRIPTION The pam_sm_close_session function is the service @@ -40,7 +38,7 @@ This function is called to terminate a session. The only valid - value for flags is zero or: + value for flags is zero or: @@ -54,7 +52,7 @@ - + RETURN VALUES @@ -76,7 +74,7 @@ - + SEE ALSO @@ -96,4 +94,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_sm_open_session.3.xml b/doc/man/pam_sm_open_session.3.xml index ead7ca77..392225a4 100644 --- a/doc/man/pam_sm_open_session.3.xml +++ b/doc/man/pam_sm_open_session.3.xml @@ -1,14 +1,12 @@ - - - + pam_sm_open_session 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_sm_open_session PAM service function to start session management @@ -16,7 +14,7 @@ - + #include <security/pam_modules.h> int pam_sm_open_session @@ -29,7 +27,7 @@ - + DESCRIPTION The pam_sm_open_session function is the service @@ -40,7 +38,7 @@ This function is called to commence a session. The only valid - value for flags is zero or: + value for flags is zero or: @@ -54,7 +52,7 @@ - + RETURN VALUES @@ -76,7 +74,7 @@ - + SEE ALSO @@ -96,4 +94,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_sm_setcred.3.xml b/doc/man/pam_sm_setcred.3.xml index bb04a2df..93a69e3e 100644 --- a/doc/man/pam_sm_setcred.3.xml +++ b/doc/man/pam_sm_setcred.3.xml @@ -1,14 +1,12 @@ - - - + pam_sm_setcred 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_sm_setcred PAM service function to alter credentials @@ -16,7 +14,7 @@ - + #include <security/pam_modules.h> int pam_sm_setcred @@ -29,7 +27,7 @@ - + DESCRIPTION The pam_sm_setcred function is the service @@ -92,7 +90,7 @@ - The way the auth stack is + The way the auth stack is navigated in order to evaluate the pam_setcred() function call, independent of the pam_sm_setcred() return codes, is exactly the same way that it was navigated when @@ -102,11 +100,11 @@ libpam evaluates the pam_setcred() function call. Otherwise, the return codes from each module specific pam_sm_setcred() call are treated as - required. + required. - + RETURN VALUES @@ -158,7 +156,7 @@ - + SEE ALSO @@ -181,4 +179,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_start.3.xml b/doc/man/pam_start.3.xml index 1d544e64..470c6cec 100644 --- a/doc/man/pam_start.3.xml +++ b/doc/man/pam_start.3.xml @@ -1,16 +1,13 @@ - - - - + pam_start 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_start pam_start_confdir initialization of PAM transaction @@ -19,7 +16,7 @@ - + #include <security/pam_appl.h> int pam_start @@ -40,7 +37,7 @@ - + DESCRIPTION The pam_start function creates the PAM context @@ -108,7 +105,7 @@ - + RETURN VALUES @@ -147,7 +144,7 @@ - + SEE ALSO @@ -164,4 +161,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_strerror.3.xml b/doc/man/pam_strerror.3.xml index 954e131d..b76cbc4d 100644 --- a/doc/man/pam_strerror.3.xml +++ b/doc/man/pam_strerror.3.xml @@ -1,16 +1,13 @@ - - - - + pam_strerror 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_strerror return string describing PAM error code @@ -18,7 +15,7 @@ - + #include <security/pam_appl.h> const char *pam_strerror @@ -29,7 +26,7 @@ - + DESCRIPTION The pam_strerror function returns a pointer to @@ -40,14 +37,14 @@ modify this string. - + RETURN VALUES This function returns always a pointer to a string. - + SEE ALSO @@ -55,4 +52,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_syslog.3.xml b/doc/man/pam_syslog.3.xml index ca28587e..f5be287f 100644 --- a/doc/man/pam_syslog.3.xml +++ b/doc/man/pam_syslog.3.xml @@ -1,16 +1,13 @@ - - - - + pam_syslog 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_syslog pam_vsyslog send messages to the system logger @@ -18,7 +15,7 @@ - + #include <syslog.h> #include <security/pam_ext.h> @@ -39,7 +36,7 @@ - + DESCRIPTION The pam_syslog function logs messages using @@ -62,7 +59,7 @@ - + SEE ALSO @@ -71,7 +68,7 @@ - + STANDARDS The pam_syslog and pam_vsyslog @@ -79,4 +76,4 @@ - + \ No newline at end of file diff --git a/doc/man/pam_xauth_data.3.xml b/doc/man/pam_xauth_data.3.xml index 505985e4..447a9c2d 100644 --- a/doc/man/pam_xauth_data.3.xml +++ b/doc/man/pam_xauth_data.3.xml @@ -1,16 +1,13 @@ - - - - + pam_xauth_data 3 - Linux-PAM Manual + Linux-PAM + Linux-PAM Manual - + pam_xauth_data structure containing X authentication data @@ -18,7 +15,7 @@ - + #include <security/pam_appl.h> @@ -31,7 +28,7 @@ struct pam_xauth_data { - + DESCRIPTION The pam_xauth_data structure contains X @@ -70,7 +67,7 @@ struct pam_xauth_data { - + SEE ALSO @@ -82,7 +79,7 @@ struct pam_xauth_data { - + STANDARDS The pam_xauth_data structure and @@ -91,4 +88,4 @@ struct pam_xauth_data { - + \ No newline at end of file -- cgit v1.2.3