The credentials of a session, or its identity, are available via members of
the global session variable. The credentials include user information,
group membership information, and Class information (if used).
These members of session are all set after the PASS command has been
successfully processed:
session.uid: User UID, as supplied by the Auth API.session.user: During authentication, this member is set to the authenticated user name. Note that this user name may be different from the user name originally sent by the client (via theUSERcommand) ifUserAliashas been used. If authentication fails for any reason, this is set toNULL.session.ident_user: Name of the remote user as established using the ident protocol (RFC 1413), once the connection to the server has been made by the client, before any FTP commands are processed. Ifmod_identis not present, or ifIdentLookupsis set to off, this will be the value "UKNOWN".session.anon_user: Only has a value if the login is an anonymous one; otherwise, its value will beNULL. For anonymous logins, this member will contain the "password" (usually an email address) sent by the client. However, ifAnonRequirePasswordis set to on, the value will be the originalUSERsent by client.
In addition to the above session members, there is an additional place in
which user identity information, specifically, the user name originally sent
by the client in the USER command, is stored: in the session notes, and is
retrievable like this:
const char *user;
user = pr_table_get(session.notes, "mod_auth.orig-user", NULL);
if (user != NULL) {
...
}
These members are all set after the PASS command has been successfully
processed:
session.gid: GID of the user's primary group, as supplied by the Auth API.session.group: Name of the user's primary group, as supplied by the Auth API.session.gids: List (array_header) of the GIDs of the supplemental groups to which the user belongs.session.groups: List (array_header) of the names of the supplemental groups to which the user belongs.
Once a client connects, the class of that client is determined. The value
is stored in session:
session.class: If classes have been configured, this member will contain a pointer to theclass_tstruct for the current session. It is set once the client has connected to the server, before any modules' session initialization handlers have been run, and before any FTP commands are processed.