TCPL0300 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	CCSID of authentication string	Input	Binary(4)
7	Client IP address	Input	Char(*)
8	Length of client IP address	Input	Binary(4)
9	Allow logon	Output	Binary(4)
10	User profile	Output	Char(10)
11	Password	Output	Char(*)
12	Length of password	Output	Binary(4)
13	CCSID of password	Output	Binary(4)
14	Initial current library	Input/Output	Char(10)
15	Initial home directory	Output	Char(*)
16	Length of initial home directory	Input/Output	Binary(4)
17	CCSID of initial home directory	Input/Output	Binary(4)
18	Application-specific information	Input/Output	Char(*)
19	Length of application-specific information	Input	Binary(4)

 

Parameter descriptions

Application identifier

INPUT; BINARY(4) Identifies the application server from which the request is being made. 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 (unless the user is authenticated by a client certificate, in which case the client certificate is provided for this parameter).

Length of authentication string

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

CCSID of authentication string

INPUT; BINARY(4) The CCSID of the authentication string parameter. For the FTP server: When the user is authenticated by a client certificate, this parameter is set to -2.

Client IP address

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

Length of client IP address

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

Allow logon

OUTPUT; BINARY(4) Indicates whether the logon operation should be accepted or rejected, and how password authentication is performed. The valid values are:

0

Reject the logon operation. Ignores all other output parameters.

1

Continue the logon operation with the specified user identifier and authentication string. The user identifier is the user profile, and the authentication string is the password. The current library and working directory is based on the settings of those output parameters. The application ignores the user profile and password output parameters.

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

2

Continue the logon operation. Override the user profile and password with the returned values in the output parameters of this exit program. The application initializes the current library and working directory based on the settings of those output parameters.

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.

3

Accept the logon operation. Override the user profile with the profile returned in the user profile output parameter of this exit program. The program initializes the current library and working directory based on the settings of the output parameters. It ignores the password output parameter.

If the system is running at a security level of 20 or higher, specifying this value overrides normal i5/OS^® password processing. This is the only password authentication.

User profile

OUTPUT; CHAR(10) The user profile to use for this session. When required, this parameter must be left-aligned and padded with blanks.

Password

OUTPUT; CHAR(*) The password to use for this session. When required, the Length of password and CCSID of password parameters must also be specified, and this parameter must be left-justified. When the QPWDLVL system value is set to 0 or 1, up to 10 characters can be specified; when the QPWDLVL system value is set to 2 or 3, up to 128 characters can be specified.

Length of password

OUTPUT; BINARY(4) The length (in bytes) of the password. When required, the valid range is 1 to 512 bytes.

CCSID of password

OUTPUT; BINARY(4) The CCSID of the password. This parameter must be set by the exit program when the password parameter is specified. The valid values are:

0

The CCSID of the job is used to determine the CCSID of the data to be converted. If the job CCSID is 65535, the CCSID from the default CCSID (DFTCCSID) job attribute is used.

1-65533

A valid CCSID in this range.

Initial current library

OUTPUT; CHAR(10) The initial current library to use for this session. When required, this parameter must be left-aligned and padded with blanks. This parameter is set to the following special value when the exit program is called:*CURLIB- Use the current library that the user profile specifies.

Initial home directory

OUTPUT; CHAR(*) The initial setting of the home directory to use for this session. When specified, this parameter must be a valid absolute path name, and the length of initial home directory and CCSID of initial home directory parameters set to the proper values.

Length of initial home directory

INPUT/OUTPUT; BINARY(4) The length of the initial home directory parameter returned by the exit program. This parameter initializes at zero when the application calls the exit program. If the exit program does not change the value of the parameter, the home directory is initialized to the home directory that the user's profile specifies.

CCSID of initial home directory

OUTPUT; BINARY(4) The CCSID of the initial home directory. This parameter must be set by the exit program when the initial home directory is specified. The valid values are:

0

The CCSID of the job is used to determine the CCSID of the data to be converted. If the job CCSID is 65535, the CCSID from the default CCSID (DFTCCSID) job attribute is used.

1-65533

A valid CCSID in this range.

Application-specific information

INPUT/OUTPUT; CHAR(*) Information that is used to communicate application-specific logon settings. For the correct format, see Format of application-specific information parameter.

Length of application-specific information

INPUT; BINARY(4) The length (in bytes) of the application-specific information.

 

Parent topic:

FTP server logon exit point