TCPL0100 exit point format

Parameter	Description	Input or output	Type and length
1	Application identifier	Input	Binary(4)
2	User identifier	Input	Char(*)
3	Length of user identifier	Input	Binary(4)
4	Authentication string	Input	Char(*)
5	Length of authentication string	Input	Binary(4)
6	Client IP address	Input	Char(*)
7	Length of client IP address	Input	Binary(4)
8	Return code	Output	Binary(4)
9	User profile	Output	Char(10)
10	Password	Output	Char(10)
11	Initial current library	Output	Char(10)

 

Parameter descriptions

Application identifier

INPUT; BINARY(4) Identifies the requested application server. The valid values are:

1

FTP server program

2

REXEC server program

User identifier

INPUT; CHAR(*) The user identification supplied by the client program. For the FTP server, this parameter contains the data field from the USER subcommand.

Length of user identifier

INPUT; BINARY(4) The length (in bytes) of the user identifier string.

Authentication string

INPUT; CHAR(*) The string (such as a password) supplied by the client program.

For the FTP server, this parameter contains the data field from the PASS (password) subcommand. Beginning with V5R1, if the user is authenticated by a client certificate, no data is provided for this parameter.

Length of authentication string

INPUT; BINARY(4) The length (in bytes) of the authentication string.

For the FTP server: When the user is authenticated by a client certificate, this parameter is set to 0.

Client IP address

INPUT; CHAR(*) The Internet Protocol (IP) address from which the session originates. This string is in dotted decimal format, left justified.

Length of client IP address

INPUT; BINARY(4) Indicates the length (in bytes) of the client IP address.

Return code

OUTPUT; BINARY(4) Indicates whether to accept or reject the logon operation, to perform password authentication, and whether or not to override the initial current library. The valid values are:

0

Reject the logon operation. Ignore the user profile, password, and initial current library output parameters.

1

Continue the logon operation with the specified user identifier and authentication string, and the user-specified the initial current library. The user identifier becomes the user profile, and the authentication string becomes the password. The program ignores the user profile, password, and initial current library output parameters.

For the logon to succeed, the authentication string must match the user profile-specified password.

2

Continue the logon operation with the specified user identifier and authentication string, and override the initial current library with the one specified by the initial current library parameter. The user identifier is the user profile. The authentication string is the password. Provide the initial current library output parameter. The program ignores the user profile and password output parameters.

For the logon to succeed, the authentication string must match the user profile-specified password.

3

Continue the logon operation. Override the user profile and password with those values you received from the output parameters of this exit program. Use the user profile-specified initial current library that the exit program returns. The program ignores the initial current library output parameter.

For the logon to succeed, the password output parameter must match the user profile-specified password.

Attention! IBM strongly recommends that you never code passwords directly in an exit program. Encryption, for example, allows algorithmic password determination.

4

Continue the logon operation, which will override the user profile, password, and initial current library with output parameters of this exit program.

For the logon to succeed, the password output parameter must match the user profile-specified password.

Attention! IBM strongly recommends that you never code passwords directly in an exit program. Encryption, for example, allows algorithmic password determination.

5

Accept the logon operation. Override the user profile is returned in the user profile output parameter of this exit program. Use the initial current library specified by the user profile, returned by this exit program. The program ignores the output parameters for the initial current library and password.

Specifying this value overrides normal i5/OS^® password processing. It is the only password authentication.

6

Accept the logon operation. Override the user profile and initial current library with those that are returned in the output parameters of this exit program. Ignore the output parameter for password.

Specifying this value overrides normal i5/OS password processing. It is the only password authentication.

User profile

OUTPUT; CHAR(10) The user profile to use for this session. This parameter must be left justified and padded with blanks.

Password

OUTPUT; CHAR(10) The password to use for this session. This parameter must be left justified and padded with blanks.

Initial current library

OUTPUT; CHAR(10) The initial current library to be established for this session. This parameter must be left justified and padded with blanks.

• TCPL0100 format usage notes
  TCPL0100 is one of the exit point formats that is used for both the File Transfer Protocol (FTP) Server Logon exit point and the Remote Execution Protocol (REXEC) Server Logon Validation exit point.

 

Parent topic:

FTP server logon exit point