From d48c90b14254794fcad9ccc37873a8c663cce02d Mon Sep 17 00:00:00 2001 From: Thorsten Kukuk Date: Tue, 8 Jan 2008 12:44:15 +0000 Subject: Relevant BUGIDs: Purpose of commit: cleanup Commit summary: --------------- Remove autogenerated documentation from CVS --- modules/pam_filter/README | 78 ----------------------------------------------- 1 file changed, 78 deletions(-) delete mode 100644 modules/pam_filter/README (limited to 'modules/pam_filter/README') diff --git a/modules/pam_filter/README b/modules/pam_filter/README deleted file mode 100644 index 4d4e2194..00000000 --- a/modules/pam_filter/README +++ /dev/null @@ -1,78 +0,0 @@ -pam_filter — PAM filter module - -━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - -DESCRIPTION - -This module is intended to be a platform for providing access to all of the -input/output that passes between the user and the application. It is only -suitable for tty-based and (stdin/stdout) applications. - -To function this module requires filters to be installed on the system. The -single filter provided with the module simply transposes upper and lower case -letters in the input and output streams. (This can be very annoying and is not -kind to termcap based editors). - -Each component of the module has the potential to invoke the desired filter. -The filter is always execv(2) with the privilege of the calling application and -not that of the user. For this reason it cannot usually be killed by the user -without closing their session. - -OPTIONS - -debug - - Print debug information. - -new_term - - The default action of the filter is to set the PAM_TTY item to indicate the - terminal that the user is using to connect to the application. This - argument indicates that the filter should set PAM_TTY to the filtered - pseudo-terminal. - -non_term - - don't try to set the PAM_TTY item. - -runX - - In order that the module can invoke a filter it should know when to invoke - it. This argument is required to tell the filter when to do this. - - Permitted values for X are 1 and 2. These indicate the precise time that - the filter is to be run. To understand this concept it will be useful to - have read the pam(3) manual page. Basically, for each management group - there are up to two ways of calling the module's functions. In the case of - the authentication and session components there are actually two separate - functions. For the case of authentication, these functions are - pam_authenticate(3) and pam_setcred(3), here run1 means run the filter from - the pam_authenticate function and run2 means run the filter from - pam_setcred. In the case of the session modules, run1 implies that the - filter is invoked at the pam_open_session(3) stage, and run2 for - pam_close_session(3). - - For the case of the account component. Either run1 or run2 may be used. - - For the case of the password component, run1 is used to indicate that the - filter is run on the first occasion of pam_chauthtok(3) (the - PAM_PRELIM_CHECK phase) and run2 is used to indicate that the filter is run - on the second occasion (the PAM_UPDATE_AUTHTOK phase). - -filter - - The full pathname of the filter to be run and any command line arguments - that the filter might expect. - -EXAMPLES - -Add the following line to /etc/pam.d/login to see how to configure login to -transpose upper and lower case letters once the user has logged in: - - session required pam_filter.so run1 /lib/security/pam_filter/upperLOWER - - -AUTHOR - -pam_filter was written by Andrew G. Morgan . - -- cgit v1.2.3