systemPass(3FTPD)

NAME | SYNOPSIS | API RESTRICTIONS | DESCRIPTION | RETURN VALUES | OK REPLIES | ERROR MESSAGES | NOTES | ATTRIBUTES

NAME

systemPass- Validate the user password

SYNOPSIS

#include <arpa/ftpd/systemAuth.h>

int systemPass(FtpConn *conn);

API RESTRICTIONS

The function or functions documented here may not be used safely in all application contexts with all APIs provided in the ChorusOS 5.0 product.

See API(5FEA) for details.

DESCRIPTION

Using criteria defined by the implementation, this function verifies that the correct user password is used. The user name is conn->name, and the user password is conn->passwd. If the password is accepted, a connection is opened according to user defaults. This might necessitate the following:

• Changing the current directory to the home directory of the user (updating conn->dir in multi-threaded conditions).

• Changing the root directory (if supported by the implementation).

• Changing conn->shell (if shell spawning is supported).

The conn->dir parameter is initialized to "/" and conn->shell is initialized to "". To change the value of conn->dir or conn->shell, the application must free the memory they point to. This is done using free(3STDC). When the session is finished, the FTPD library calls free(3STDC) on conn->dir or conn->shell if their value is not set to NULL.

In a traditional UNIX implementation if conn->guest = 1, the password is not checked.

RETURN VALUES

Returns 0 if the password is correct, -1 otherwise.

OK REPLIES

lreply(conn, 230, "(Comments)")

Optional and only if access granted.

ERROR MESSAGES

reply(conn, 530, "...")

Bad password.

reply(conn, 550, "...")

Problem with the data base file.

NOTES

Parameters conn->dir and conn->shell are only used by the application side; the FTPD library does not interpret them. If the systemBeuser(3FTPD) and systemBesuper(3FTPD) routines are to be used, the necessary information must be provided to the application side.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability	Evolving

ChorusOS 5.0  Last Revised December 2001

NAME | SYNOPSIS | API RESTRICTIONS | DESCRIPTION | RETURN VALUES | OK REPLIES | ERROR MESSAGES | NOTES | ATTRIBUTES