Oberon || Library || Module Index || Search Engine || Definition || Module

Ulm's Oberon Library:
FTPSessions

NAME

FTPSessions - framework for the inner core of a FTP server

SYNOPSIS

TYPE Message = POINTER TO MessageRec;
TYPE MessageRec =
      RECORD
         (Messages.MessageRec)
         request: FTPRequests.Request;
         response: FTPResponses.Response;
         markEventType: Events.EventType;
      END;



TYPE Session = POINTER TO SessionRec;
TYPE SessionRec =
      RECORD
         (Services.ObjectRec)
         authorized: BOOLEAN;
         finished: BOOLEAN;
      END;



PROCEDURE Create(VAR session: Session);
PROCEDURE ProcessRequest(session: Session;
                         request: FTPRequests.Request;
                         markEventType: Events.EventType;
                         VAR response: FTPResponses.Response);

DESCRIPTION

FTPSessions provides a framework for the inner core of a FTP server that processes FTP requests without access to the network connection.

During the initialization phase of a FTP session for a new network connection,

a new session object is to be created using Create,
an arbitrary number of message handlers may be installed for it using Messages, and
the initial state is to be set, if necessary.

State is maintained by various handlers that were installed by Messages.InstallHandler on base of disciplines, and some public session components:

authorized: indicates whether FTP commands beyond FTPCommands.user, FTPCommands.pass, and FTPCommands.acct are to be accepted (initially FALSE).
finished: is initially FALSE, and set to TRUE on encountering the FTPCommands.quit command.

ProcessRequest checks whether request is acceptable at the current state (in dependence of authorized), processes some simple commands itself, and converts all other requests into messages (of type Message) and sends them to session, using Messages.Send. Following commands are implemented by ProcessRequest:

FTPCommands.quit: sets the public component finished to TRUE, and returns a 221 return code.
FTPCommands.noop: is answered by a 200 return code.

Attempts to re-authorize when authorized is already TRUE are answered with a response code of 230. All commands beyond authorization commands are rejected with 530 as long authorized remains FALSE.

If, after processing of Messages.Send, the response field of the message remains NIL, an error code is returned: either 450 (as indication for temporary failures) if error events were found, or 502 (as indication for an unknown or unsupported command).

Some commands of the FTP protocol request some intermediate responses, called marks, on the command channel as the transfer on the separate channel begins or ends. Marks are to be delivered by raising events of type FTPResponses.Event using markEventType as event type.

Ulm's Oberon Library: FTPSessions

NAME

SYNOPSIS

DESCRIPTION

SEE ALSO

Ulm's Oberon Library:
FTPSessions