Copyright 2004 Fourthought, Inc. (USA). Detailed license and copyright information: http://4suite.org/COPYRIGHT Project home, documentation, distributions: http://4suite.org/
Classes:
|
Functions:
|
A password file maps a username to a password hash, hostname, and port. The location of the file is determined by the FTSS_PASSWORD_FILE environment variable. If not set, then the location is determined from the following: - $HOME/.4Suite/<basename>_pass (POSIX systems) - %APPDATA%\4Suite\<basename>_pass.conf (Windows 2K/XP/2K3) - %USERPROFILE%\4Suite\<basename>_pass.conf (Windows NT) - %WINDIR%\4Suite\<basename>_pass.conf (Windows 9x) If none of the variables are set, an exception is raised. If the password file does not exist, it will be created when the first entry is stored. The location must be writable, of course.
Username sources normally checked are, in order: 1. the options dictionary; 2. the agent referenced in the FTSS_AGENT environment variable; 3. the FTSS_USERNAME environment variable; 4. a prompt for user input. Password sources normally checked are, in order: 1. the password file referenced in environment var. FTSS_PASSWORD_FILE; 2. the password file $HOME/.4ss.passwd or %WINDIR%\.4ss.passwd; 3. the password file referenced in the deprecated environment variable FTSERVER_PASSWORD_FILE; 4. a prompt for user input. Optional arguments: options - a dictionary of options parsed from the command line (see FancyGetOpt). The key 'anonymous' is taken to indicate that no authentication is necessary and (None, None) should be returned. If the key 'username' is present, the associated value is returned as the username and no other potential sources for username are checked. prompt - if the user is to be prompted for their username, this is the string that indicates the type of user to be mentioned in the prompt. It is 'User' or 'Manager', typically. promptOnly - if set, this flag forces the username and password to be obtained by prompting the user; other sources are not checked.