libtelnet.h

Go to the documentation of this file.

#if !defined(LIBTELNET_INCLUDE)
#define LIBTELNET_INCLUDE 1

/* standard C headers necessary for the libtelnet API */
#include <stdarg.h>
#include <stddef.h>

/* C++ support */
#if defined(__cplusplus)
extern "C" {
#endif

/* printf type checking feature in GCC and some other compilers */
#if __GNUC__
# define TELNET_GNU_PRINTF(f,a) __attribute__((format(printf, f, a))) 
# define TELNET_GNU_SENTINEL __attribute__((sentinel)) 
#else
# define TELNET_GNU_PRINTF(f,a) 
# define TELNET_GNU_SENTINEL 
#endif

/* Disable environ macro for Visual C++ 2015. */
#undef environ

typedef struct telnet_t telnet_t;

typedef union telnet_event_t telnet_event_t;

typedef struct telnet_telopt_t telnet_telopt_t;

#define TELNET_IAC 255
#define TELNET_DONT 254
#define TELNET_DO 253
#define TELNET_WONT 252
#define TELNET_WILL 251
#define TELNET_SB 250
#define TELNET_GA 249
#define TELNET_EL 248
#define TELNET_EC 247
#define TELNET_AYT 246
#define TELNET_AO 245
#define TELNET_IP 244
#define TELNET_BREAK 243
#define TELNET_DM 242
#define TELNET_NOP 241
#define TELNET_SE 240
#define TELNET_EOR 239
#define TELNET_ABORT 238
#define TELNET_SUSP 237
#define TELNET_EOF 236

#define TELNET_TELOPT_BINARY 0
#define TELNET_TELOPT_ECHO 1
#define TELNET_TELOPT_RCP 2
#define TELNET_TELOPT_SGA 3
#define TELNET_TELOPT_NAMS 4
#define TELNET_TELOPT_STATUS 5
#define TELNET_TELOPT_TM 6
#define TELNET_TELOPT_RCTE 7
#define TELNET_TELOPT_NAOL 8
#define TELNET_TELOPT_NAOP 9
#define TELNET_TELOPT_NAOCRD 10
#define TELNET_TELOPT_NAOHTS 11
#define TELNET_TELOPT_NAOHTD 12
#define TELNET_TELOPT_NAOFFD 13
#define TELNET_TELOPT_NAOVTS 14
#define TELNET_TELOPT_NAOVTD 15
#define TELNET_TELOPT_NAOLFD 16
#define TELNET_TELOPT_XASCII 17
#define TELNET_TELOPT_LOGOUT 18
#define TELNET_TELOPT_BM 19
#define TELNET_TELOPT_DET 20
#define TELNET_TELOPT_SUPDUP 21
#define TELNET_TELOPT_SUPDUPOUTPUT 22
#define TELNET_TELOPT_SNDLOC 23
#define TELNET_TELOPT_TTYPE 24
#define TELNET_TELOPT_EOR 25
#define TELNET_TELOPT_TUID 26
#define TELNET_TELOPT_OUTMRK 27
#define TELNET_TELOPT_TTYLOC 28
#define TELNET_TELOPT_3270REGIME 29
#define TELNET_TELOPT_X3PAD 30
#define TELNET_TELOPT_NAWS 31
#define TELNET_TELOPT_TSPEED 32
#define TELNET_TELOPT_LFLOW 33
#define TELNET_TELOPT_LINEMODE 34
#define TELNET_TELOPT_XDISPLOC 35
#define TELNET_TELOPT_ENVIRON 36
#define TELNET_TELOPT_AUTHENTICATION 37
#define TELNET_TELOPT_ENCRYPT 38
#define TELNET_TELOPT_NEW_ENVIRON 39
#define TELNET_TELOPT_MSSP 70
#define TELNET_TELOPT_COMPRESS 85
#define TELNET_TELOPT_COMPRESS2 86
#define TELNET_TELOPT_ZMP 93
#define TELNET_TELOPT_EXOPL 255

#define TELNET_TELOPT_MCCP2 86

#define TELNET_TTYPE_IS 0
#define TELNET_TTYPE_SEND 1

#define TELNET_ENVIRON_IS 0
#define TELNET_ENVIRON_SEND 1
#define TELNET_ENVIRON_INFO 2
#define TELNET_ENVIRON_VAR 0
#define TELNET_ENVIRON_VALUE 1
#define TELNET_ENVIRON_ESC 2
#define TELNET_ENVIRON_USERVAR 3

#define TELNET_MSSP_VAR 1
#define TELNET_MSSP_VAL 2

#define TELNET_FLAG_PROXY (1<<0)
#define TELNET_FLAG_NVT_EOL (1<<1)

/* Internal-only bits in option flags */
#define TELNET_FLAG_TRANSMIT_BINARY (1<<5)
#define TELNET_FLAG_RECEIVE_BINARY (1<<6)
#define TELNET_PFLAG_DEFLATE (1<<7)

enum telnet_error_t {
    TELNET_EOK = 0,   
    TELNET_EBADVAL,   
    TELNET_ENOMEM,    
    TELNET_EOVERFLOW, 
    TELNET_EPROTOCOL, 
    TELNET_ECOMPRESS  
};
typedef enum telnet_error_t telnet_error_t; 
enum telnet_event_type_t {
    TELNET_EV_DATA = 0,        
    TELNET_EV_SEND,            
    TELNET_EV_IAC,             
    TELNET_EV_WILL,            
    TELNET_EV_WONT,            
    TELNET_EV_DO,              
    TELNET_EV_DONT,            
    TELNET_EV_SUBNEGOTIATION,  
    TELNET_EV_COMPRESS,        
    TELNET_EV_ZMP,             
    TELNET_EV_TTYPE,           
    TELNET_EV_ENVIRON,         
    TELNET_EV_MSSP,            
    TELNET_EV_WARNING,         
    TELNET_EV_ERROR            
};
typedef enum telnet_event_type_t telnet_event_type_t; 
struct telnet_environ_t {
    unsigned char type; 
    char *var;          
    char *value;        
};

union telnet_event_t {
    enum telnet_event_type_t type;

    struct data_t {
        enum telnet_event_type_t _type; 
        const char *buffer;             
        size_t size;                    
    } data;

    struct error_t {
        enum telnet_event_type_t _type; 
        const char *file;               
        const char *func;               
        const char *msg;                
        int line;                       
        telnet_error_t errcode;         
    } error;

    struct iac_t {
        enum telnet_event_type_t _type; 
        unsigned char cmd;              
    } iac;

    struct negotiate_t {
        enum telnet_event_type_t _type; 
        unsigned char telopt;           
    } neg;

    struct subnegotiate_t {
        enum telnet_event_type_t _type; 
        const char *buffer;             
        size_t size;                    
        unsigned char telopt;           
    } sub;

    struct zmp_t {
        enum telnet_event_type_t _type; 
        const char **argv;              
        size_t argc;                    
    } zmp;

    struct ttype_t {
        enum telnet_event_type_t _type; 
        unsigned char cmd;              
        const char* name;               
    } ttype;

    struct compress_t {
        enum telnet_event_type_t _type; 
        unsigned char state;            
    } compress;

    struct environ_t {
        enum telnet_event_type_t _type;        
        const struct telnet_environ_t *values; 
        size_t size;                           
        unsigned char cmd;                     
    } environ;
    
    struct mssp_t {
        enum telnet_event_type_t _type;        
        const struct telnet_environ_t *values; 
        size_t size;                           
    } mssp;
};

typedef void (*telnet_event_handler_t)(telnet_t *telnet,
        telnet_event_t *event, void *user_data);

struct telnet_telopt_t {
    short telopt;      
    unsigned char us;  
    unsigned char him; 
};

struct telnet_t;

extern telnet_t* telnet_init(const telnet_telopt_t *telopts,
        telnet_event_handler_t eh, unsigned char flags, void *user_data);

extern void telnet_free(telnet_t *telnet);

extern void telnet_recv(telnet_t *telnet, const char *buffer,
        size_t size);

extern void telnet_iac(telnet_t *telnet, unsigned char cmd);

extern void telnet_negotiate(telnet_t *telnet, unsigned char cmd,
        unsigned char opt);

extern void telnet_send(telnet_t *telnet,
        const char *buffer, size_t size);

extern void telnet_send_text(telnet_t *telnet,
        const char *buffer, size_t size);

extern void telnet_begin_sb(telnet_t *telnet,
        unsigned char telopt);

#define telnet_finish_sb(telnet) telnet_iac((telnet), TELNET_SE)

extern void telnet_subnegotiation(telnet_t *telnet, unsigned char telopt,
        const char *buffer, size_t size);

extern void telnet_begin_compress2(telnet_t *telnet);

extern int telnet_printf(telnet_t *telnet, const char *fmt, ...)
        TELNET_GNU_PRINTF(2, 3);

extern int telnet_vprintf(telnet_t *telnet, const char *fmt, va_list va);

extern int telnet_raw_printf(telnet_t *telnet, const char *fmt, ...)
        TELNET_GNU_PRINTF(2, 3);

extern int telnet_raw_vprintf(telnet_t *telnet, const char *fmt, va_list va);

extern void telnet_begin_newenviron(telnet_t *telnet, unsigned char type);

extern void telnet_newenviron_value(telnet_t* telnet, unsigned char type,
        const char *string);

#define telnet_finish_newenviron(telnet) telnet_finish_sb((telnet))

extern void telnet_ttype_send(telnet_t *telnet);

extern void telnet_ttype_is(telnet_t *telnet, const char* ttype);

extern void telnet_send_zmp(telnet_t *telnet, size_t argc, const char **argv);

extern void telnet_send_zmpv(telnet_t *telnet, ...) TELNET_GNU_SENTINEL;

extern void telnet_send_vzmpv(telnet_t *telnet, va_list va);

extern void telnet_begin_zmp(telnet_t *telnet, const char *cmd);

extern void telnet_zmp_arg(telnet_t *telnet, const char *arg);

#define telnet_finish_zmp(telnet) telnet_finish_sb((telnet))

/* C++ support */
#if defined(__cplusplus)
} /* extern "C" */
#endif

#endif /* !defined(LIBTELNET_INCLUDE) */