The FTCHKPWD user exit (for the FTP server)

The FTCHKPWD user exit is called immediately after the user enters the password, password phrase, or email address while logging in to the FTP server. The following information is passed to the exit:
  • The user ID
  • The user password

    This field will be set to an asterisk (*) if an email address is entered instead of a password.

    This field will be set to the first eight characters of the password phrase if the user provides a password phrase instead of a password. The entire password phrase is passed to this exit as another parameter.

  • A userdata buffer

    If an email address is entered to log in, the userdata buffer contains the email address.

  • The number of incorrect passwords or password phrases entered during this session
  • The socket address structure of the client's control connection
  • The socket address structure of the server's control connection
  • Session instance identifier
  • The user password or password phrase used to log in to the FTP server

The exit can be used to restrict access to a site based on user ID, password or password phrase, number of bad passwords or password phrases entered, or anything in the socket address information for the client or server. If the login is denied by the user exit, the following reply is sent to the user:

530 PASS command failed
Result: If you coded ACCESSERRORMSGS TRUE in FTP.DATA, an additional 530 reply with information about why the PASS command failed might precede the reply above.