telnet.h

Go to the documentation of this file.

/*
 * telnet.h
 *
 * TELNET Socket class.
 *
 * Portable Windows Library
 *
 * Copyright (c) 1993-2002 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Portable Windows Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Contributor(s): ______________________________________.
 *
 * $Log: telnet.h,v $
 * Revision 1.25  2007/09/18 06:20:57  csoutheren
 * Fix spelling mistakes
 *
 * Revision 1.24  2005/11/30 12:47:37  csoutheren
 * Removed tabs, reformatted some code, and changed tags for Doxygen
 *
 * Revision 1.23  2002/11/06 22:47:24  robertj
 * Fixed header comment (copyright etc)
 *
 * Revision 1.22  2002/09/16 01:08:59  robertj
 * Added #define so can select if #pragma interface/implementation is used on
 *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
 *
 * Revision 1.21  1999/03/09 08:01:47  robertj
 * Changed comments for doc++ support (more to come).
 *
 * Revision 1.20  1999/02/16 08:07:10  robertj
 * MSVC 6.0 compatibility changes.
 *
 * Revision 1.19  1998/11/30 02:50:56  robertj
 * New directory structure
 *
 * Revision 1.18  1998/09/23 06:20:04  robertj
 * Added open source copyright license.
 *
 * Revision 1.17  1996/08/08 10:08:54  robertj
 * Directory structure changes for common files.
 *
 * Revision 1.16  1995/06/17 11:13:32  robertj
 * Documentation update.
 *
 * Revision 1.15  1995/06/17 00:47:38  robertj
 * Changed overloaded Open() calls to 3 separate function names.
 * More logical design of port numbers and service names.
 *
 * Revision 1.14  1995/06/04 12:46:26  robertj
 * Slight redesign of port numbers on sockets.
 *
 * Revision 1.13  1995/04/25 11:12:30  robertj
 * Fixed functions hiding ancestor virtuals.
 *
 * Revision 1.12  1995/04/01 08:32:10  robertj
 * Finally got a working TELNET.
 *
 * Revision 1.11  1995/03/18 06:27:50  robertj
 * Rewrite of telnet socket protocol according to RFC1143.
 *
 * Revision 1.10  1995/03/14  12:42:47  robertj
 * Updated documentation to use HTML codes.
 *
 * Revision 1.9  1995/02/21  11:25:33  robertj
 * Further implementation of telnet socket, feature complete now.
 *
 * Revision 1.8  1995/01/03  09:36:23  robertj
 * Documentation.
 *
 * Revision 1.7  1995/01/01  01:07:33  robertj
 * More implementation.
 *
 * Revision 1.6  1994/11/28  12:38:59  robertj
 * Added DONT and WONT states.
 *
 * Revision 1.5  1994/08/23  11:32:52  robertj
 * Oops
 *
 * Revision 1.4  1994/08/22  00:46:48  robertj
 * Added pragma fro GNU C++ compiler.
 *
 * Revision 1.3  1994/08/21  23:43:02  robertj
 * Changed type of socket port number for better portability.
 *
 * Revision 1.2  1994/07/25  03:36:03  robertj
 * Added sockets to common, normalising to same comment standard.
 *
 */

#ifndef _PTELNETSOCKET
#define _PTELNETSOCKET

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <ptlib/sockets.h>


class PTelnetSocket : public PTCPSocket
{
  PCLASSINFO(PTelnetSocket, PTCPSocket)

  public:
    PTelnetSocket();
    // Create an unopened TELNET socket.

    PTelnetSocket(
      const PString & address  
    );
    // Create an opened TELNET socket.


  // Overrides from class PChannel
    BOOL Read(
      void * buf,   
      PINDEX len    
    );

    BOOL Write(
      const void * buf, 
      PINDEX len        
    );


    virtual BOOL Connect(
      const PString & address   
    );


    virtual BOOL Accept(
      PSocket & socket          
    );


    virtual void OnOutOfBand(
      const void * buf,   
      PINDEX len          
    );


  // New functions
    enum Command {
      IAC           = 255,    
      DONT          = 254,    
      DO            = 253,    
      WONT          = 252,    
      WILL          = 251,    
      SB            = 250,    
      GoAhead       = 249,    
      EraseLine     = 248,    
      EraseChar     = 247,    
      AreYouThere   = 246,    
      AbortOutput   = 245,    
      InterruptProcess = 244, 
      Break         = 243,    
      DataMark      = 242,    
      NOP           = 241,    
      SE            = 240,    
      EndOfReccord  = 239,    
      AbortProcess  = 238,    
      SuspendProcess= 237,    
      EndOfFile     = 236     
    };
    // Defined telnet commands codes

    BOOL SendCommand(
      Command cmd,  
      int opt = 0  
    );


    enum Options {
      TransmitBinary      = 0,    
      EchoOption          = 1,    
      ReconnectOption     = 2,    
      SuppressGoAhead     = 3,    
      MessageSizeOption   = 4,    
      StatusOption        = 5,    
      TimingMark          = 6,    
      RCTEOption          = 7,    
      OutputLineWidth     = 8,    
      OutputPageSize      = 9,    
      CRDisposition       = 10,   
      HorizontalTabsStops = 11,   
      HorizTabDisposition = 12,   
      FormFeedDisposition = 13,   
      VerticalTabStops    = 14,   
      VertTabDisposition  = 15,   
      LineFeedDisposition = 16,   
      ExtendedASCII       = 17,   
      ForceLogout         = 18,   
      ByteMacroOption     = 19,   
      DataEntryTerminal   = 20,   
      SupDupProtocol      = 21,   
      SupDupOutput        = 22,   
      SendLocation        = 23,   
      TerminalType        = 24,   
      EndOfRecordOption   = 25,   
      TACACSUID           = 26,   
      OutputMark          = 27,   
      TerminalLocation    = 28,   
      Use3270RegimeOption = 29,   
      UseX3PADOption      = 30,   
      WindowSize          = 31,   
      TerminalSpeed       = 32,   
      FlowControl         = 33,   
      LineModeOption      = 34,   
      XDisplayLocation    = 35,   
      EnvironmentOption   = 36,   
      AuthenticateOption  = 37,   
      EncriptionOption    = 38,   
      EncryptionOption    = 38,   
      ExtendedOptionsList = 255,  
      MaxOptions
    };
    // Defined TELNET options.


    virtual BOOL SendDo(
      BYTE option    
    );

    virtual BOOL SendDont(
      BYTE option    
    );

    virtual BOOL SendWill(
      BYTE option    
    );

    virtual BOOL SendWont(
      BYTE option    
    );

    enum SubOptionCodes {
      SubOptionIs       = 0,  
      SubOptionSend     = 1,  
    };
    // Codes for sub option negotiation.

    BOOL SendSubOption(
      BYTE code,          
      const BYTE * info,  
      PINDEX len,         
      int subCode = -1    
    );

    void SetOurOption(
      BYTE code,          
      BOOL state = TRUE   
    ) { option[code].weCan = state; }

    void SetTheirOption(
      BYTE code,          
      BOOL state = TRUE  
    ) { option[code].theyShould = state; }

    BOOL IsOurOption(
      BYTE code    
    ) const { return option[code].ourState == OptionInfo::IsYes; }

    BOOL IsTheirOption(
      BYTE code    
    ) const { return option[code].theirState == OptionInfo::IsYes; }

    void SetTerminalType(
      const PString & newType   
    );
    // Set the terminal type description string for TELNET protocol.

    const PString & GetTerminalType() const { return terminalType; }
    // Get the terminal type description string for TELNET protocol.

    void SetWindowSize(
      WORD width,   
      WORD height   
    );
    // Set the width and height of the Network Virtual Terminal window.

    void GetWindowSize(
      WORD & width,   
      WORD & height   
    ) const;
    // Get the width and height of the Network Virtual Terminal window.


  protected:
    void Construct();
    // Common construct code for TELNET socket channel.

    virtual void OnDo(
      BYTE option   
    );

    virtual void OnDont(
      BYTE option   
    );

    virtual void OnWill(
      BYTE option   
    );

    virtual void OnWont(
      BYTE option   
    );

    virtual void OnSubOption(
      BYTE code,          
      const BYTE * info,  
      PINDEX len          
    );


    virtual BOOL OnCommand(
      BYTE code  
    );


  // Member variables.
    struct OptionInfo {
      enum {
        IsNo, IsYes, WantNo, WantNoQueued, WantYes, WantYesQueued
      };
      unsigned weCan:1;      // We can do the option if they want us to do.
      unsigned ourState:3;
      unsigned theyShould:1; // They should if they will.
      unsigned theirState:3;
    };
    
    OptionInfo option[MaxOptions];
    // Information on protocol options.

    PString terminalType;
    // Type of terminal connected to telnet socket, defaults to "UNKNOWN"

    WORD windowWidth, windowHeight;
    // Size of the "window" used by the NVT.

    BOOL debug;
    // Debug socket, output messages to PError stream.


  private:
    enum State {
      StateNormal,
      StateCarriageReturn,
      StateIAC,
      StateDo,
      StateDont,
      StateWill,
      StateWont,
      StateSubNegotiations,
      StateEndNegotiations
    };
    // Internal states for the TELNET decoder

    State state;
    // Current state of incoming characters.

    PBYTEArray subOption;
    // Storage for sub-negotiated options

    unsigned synchronising;

    BOOL StartSend(const char * which, BYTE code);
};


#endif


// End Of File ///////////////////////////////////////////////////////////////

---