net.sf.hermesftp.cmd.impl
Class FtpCmdProt

java.lang.Object
  net.sf.hermesftp.cmd.AbstractFtpCmd
      net.sf.hermesftp.cmd.impl.FtpCmdProt

All Implemented Interfaces:

java.lang.Cloneable, FtpCmd, FtpConstants

public class FtpCmdProt
extends AbstractFtpCmd

DATA CHANNEL PROTECTION LEVEL (PROT)

The argument is a single Telnet character code specifying the data channel protection level.

This command indicates to the server what type of data channel protection the client and server will be using. The following codes are assigned:

• C - Clear
• S - Safe
• E - Confidential
• P - Private

The default protection level if no other level is specified is Clear. The Clear protection level indicates that the data channel will carry the raw data of the file transfer, with no security applied. The Safe protection level indicates that the data will be integrity protected. The Confidential protection level indicates that the data will be confidentiality protected. The Private protection level indicates that the data will be integrity and confidentiality protected.

It is reasonable for a security mechanism not to provide all data channel protection levels. It is also reasonable for a mechanism to provide more protection at a level than is required (for instance, a mechanism might provide Confidential protection, but include integrity-protection in that encoding, due to API or other considerations).

The PROT command must be preceded by a successful protection buffer size negotiation.

If the server does not understand the specified protection level, it should respond with reply code 504.

If the current security mechanism does not support the specified protection level, the server should respond with reply code 536.

If the server has not completed a protection buffer size negotiation with the client, it should respond with a 503 reply code.

The PROT command will be rejected and the server should reply 503 if no previous PBSZ command was issued.

If the server is not willing to accept the specified protection level, it should respond with reply code 534.

If the server is not able to accept the specified protection level, such as if a required resource is unavailable, it should respond with reply code 431. Otherwise, the server must reply with a 200 reply code to indicate that the specified protection level is accepted. *

[Excerpt from RFC-2228, Horowitz and Lunt]

Author:

Lars Behnke

Field Summary

Fields inherited from interface net.sf.hermesftp.common.FtpConstants

ATTR_CLIENT_NAME, ATTR_DATA_PROT, ATTR_FILE_OFFSET, ATTR_FORCE_UTF8, ATTR_GROUP_DATA, ATTR_LOGIN_TIME, ATTR_RENAME_FILE, ATTR_RESTART_MARKERS, ATTR_SSL, ATTR_USER_DATA, BYTE_LENGTH, BYTE_MASK, DEFAULT_BEAN_RES, DEFAULT_KEYSTORE, DEFAULT_KEYSTORE_PASS, DT_ASCII, DT_BINARY, DT_EBCDIC, HERMES_HOME, MILLI, MODE_BLOCK, MODE_COMPRESS, MODE_STREAM, MODE_ZIP, MSG_GOODBYE, MSG150, MSG200, MSG200_NOTED, MSG200_PBSZ, MSG200_SIZE, MSG200_TYPE, MSG202, MSG211_FEAT_ENTRY, MSG211_FEAT_FOOTER, MSG211_FEAT_HEADER, MSG211_STAT, MSG213_SIZE, MSG213_TIME, MSG214, MSG220, MSG220_WEL, MSG226, MSG227, MSG229, MSG230, MSG234, MSG250, MSG257, MSG331, MSG350, MSG350_REST, MSG421, MSG425, MSG426, MSG431, MSG450, MSG451, MSG500, MSG500_CMD, MSG501, MSG501_PATH, MSG501_SIZE, MSG503, MSG503_USR, MSG504, MSG522, MSG530, MSG530_AUTH, MSG534, MSG536, MSG550, MSG550_COMM, MSG550_EXISTS, MSG550_MSG, MSG550_NOTEMPTY, MSG550_PERM, MSG553, OPT_ALLOWED_PASSIVE_PORTS, OPT_BUFFER_SIZE, OPT_CHARSET_ASCII, OPT_CHARSET_EBCDIC, OPT_EMULATE_UNIX, OPT_FTP_PORT, OPT_IPV4_BLACK_LIST, OPT_IPV6_BLACK_LIST, OPT_MAX_CONNECTIONS, OPT_MAX_DOWNLOAD_RATE, OPT_MAX_IDLE_SECONDS, OPT_MAX_UPLOAD_RATE, OPT_MSG_GOODBYE, OPT_MSG_WELCOME, OPT_REMOTE_DIR, OPT_SSL_ALLOW_EXPLICIT, OPT_SSL_ALLOW_IMPLICIT, OPT_SSL_CIPHER_SUITES, OPT_SSL_FORCE, OPT_SSL_KEYSTORE_FILE, OPT_SSL_KEYSTORE_PASS, OPT_SSL_PORT_IMPLICIT, PRIV_NONE, PRIV_READ, PRIV_READ_WRITE, PRIV_WRITE, PWD, SEPARATOR, SERVER_STATUS_HALTED, SERVER_STATUS_INIT, SERVER_STATUS_READY, SERVER_STATUS_UNDEF, SPACE, STAT_BYTES_DOWNLOADED, STAT_BYTES_UPLOADED, STAT_DOWNLOAD_RATE, STAT_FILES_DOWNLOADED, STAT_FILES_UPLOADED, STAT_UPLOAD_RATE, STRUCT_FILE, STRUCT_RECORD, TYPE_NAMES, WILDCARD

Constructor Summary

FtpCmdProt()

Method Summary

void	execute() Executes the command.
java.lang.String	getHelp() Returns a short help text for the command.
boolean	isAuthenticationRequired() Returns whether authentication is needed or not.

Methods inherited from class net.sf.hermesftp.cmd.AbstractFtpCmd

getAbsPath, getAndResetFileOffset, getArguments, getCtx, getPathArg, getPermission, getToken, handleAsyncCmd, isResponded, msg, msg, msg, msgOut, msgOut, msgOut, out, setArguments, setCtx, setToken

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FtpCmdProt

public FtpCmdProt()

Method Detail

execute

public void execute()
             throws FtpCmdException

Executes the command.

Throws:

FtpCmdException - Thrown on any exception occuring while the command is executed.

getHelp

public java.lang.String getHelp()

Returns a short help text for the command.

Returns:

The help text.

isAuthenticationRequired

public boolean isAuthenticationRequired()

Returns whether authentication is needed or not.

Returns:

True, if the command requires authentication.