summaryrefslogtreecommitdiff
path: root/lib/telnet.rb
blob: 750f8a8d6e2c7862cb2033dfe7b43532fbda178b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
#!/usr/local/bin/ruby
#
# telnet.rb
# ver0.11 1998/04/21
# Wakou Aoyama <wakou@fsinet.or.jp>
#
# == make new Telnet object
# host = Telnet.new({"Binmode" => TRUE,              default: TRUE
#                    "Host" => "localhost",          default: "localhost"
#                    "Output_log"] => "output_log",  default: not output
#                    "Port" => 23,                   default: 23
#                    "Prompt" => /[$%#>] $/,         default: /[$%#>] $/
#                    "Telnetmode"] => TRUE,          default: TRUE
#                    "Timeout"] => 10}               default: 10
#
# if set "Telnetmode" option FALSE. not TELNET command interpretation.
#
# == wait for match
# print host.waitfor(/match/)
# print host.waitfor({"Match"   => /match/,
#                     "String"  => "string",
#                     "Timeout" => secs})
# if set "String" option. Match = Regexp.new(quote(string))
#
# realtime output. of cource, set sync=TRUE or flush is necessary.
# host.waitfor(/match/){|c| print c }
# host.waitfor({"Match"   => /match/,
#               "String"  => "string",
#               "Timeout" => secs}){|c| print c}
#
# == send string and wait prompt
# print host.cmd("string")
# print host.cmd({"String" => "string",
#                 "Prompt" => /[$%#>] $//,
#                 "Timeout" => 10})
#
# realtime output. of cource, set sync=TRUE or flush is necessary.
# host.cmd("string"){|c| print c }
# host.cmd({"String" => "string",
#           "Prompt" => /[$%#>] $//,
#           "Timeout" => 10}){|c| print c }
#
# == login
# host.login("username", "password")
# host.login({"Name" => "username",
#             "Password" => "password",
#             "Prompt" => /[$%#>] $/,
#             "Timeout" => 10})
#
# and Telnet object has socket class methods
#
# == sample
# localhost = Telnet.new({"Host" => "localhost",
#                         "Timeout" => 10,
#                         "Prompt" => /[$%#>] $/})
# localhost.login("username", "password")
# print localhost.cmd("command")
# localhost.close

require "socket"
require "delegate"

class Telnet < SimpleDelegator
  # For those who are curious, here are some of the special characters
  # interpretted by the telnet protocol:
  # Name     Octal    Dec.  Description
    CR    = "\015"
    LF    = "\012"
    EOL   = CR + LF #       /* end of line */
    IAC   = "\377"  # 255   /* interpret as command: */
    DONT  = "\376"  # 254   /* you are not to use option */
    DO    = "\375"  # 253   /* please, you use option */
    WONT  = "\374"  # 252   /* I won't use option */
    WILL  = "\373"  # 251   /* I will use option */
  # SB    = "\372"  # 250   /* interpret as subnegotiation */
  # GA    = "\371"  # 249   /* you may reverse the line */
  # EL    = "\370"  # 248   /* erase the current line */
  # EC    = "\367"  # 247   /* erase the current character */
    AYT   = "\366"  # 246   /* are you there */
  # AO    = "\365"  # 245   /* abort output--but let prog finish */
  # IP    = "\364"  # 244   /* interrupt process--permanently */
  # BREAK = "\363"  # 243   /* break */
  # DM    = "\362"  # 242   /* data mark--for connect. cleaning */
  # NOP   = "\361"  # 241   /* nop */
  # SE    = "\360"  # 240   /* end sub negotiation */
  # EOR   = "\357"  # 239   /* end of record (transparent mode) */

  def initialize(options)
    @options = {}
    @options["Binmode"] = options["Binmode"] || TRUE
    @options["Dump_Log"] = options["Dump_Log"]
    @options["Errmode"] = options["Errmode"]
    @options["Fhopen"] = options["Fhopen"]
    @options["Host"] = options["Host"] || "localhost"
    @options["Input_log"] = options["Input_log"]
    @options["Input_record_separator"] = options["Input_record_separator"]
    @options["Output_log"] = options["Output_log"]
    @options["Output_record_separator"] = options["Output_record_separator"]
    @options["Port"] = options["Port"] || 23
    @options["Prompt"] = options["Prompt"] || /[$%#>] $/
    @options["Telnetmode"] = options["Telnetmode"] || TRUE
    @options["Timeout"] = options["Timeout"] || 10

    if @options.include?("Output_log")
      @log = File.open(@options["Output_log"], 'a+')
      @log.sync = TRUE
      @log.binmode if @options["Binmode"]
    end
    @sock = TCPsocket.open(@options["Host"], @options["Port"])
    @sock.sync = TRUE
    @sock.binmode if @options["Binmode"]
    super(@sock)
  end

  def preprocess(str)
    str.gsub!(/#{EOL}/no, "\n") # combine EOL into "\n"

    # respond to "IAC DO x" or "IAC DON'T x" with "IAC WON'T x"
    str.gsub!(/([^#{IAC}])?#{IAC}[#{DO}#{DONT}](.|\n)/no){
        @sock << IAC << WONT << $2
        $1
    }

    # ignore "IAC WILL x" or "IAC WON'T x"
    str.gsub!(/([^#{IAC}])?#{IAC}[#{WILL}#{WONT}](.|\n)/no, '\1')

    # respond to "IAC AYT" (are you there)
    str.gsub!(/([^#{IAC}])?#{IAC}#{AYT}/no){
        @sock << "nobody here but us pigeons" << CR
        $1
    }

    str.gsub(/#{IAC}#{IAC}/no, IAC) # handle escaped IAC characters
  end

  def waitfor(options)
    prompt = @options["Prompt"]
    timeout = @options["Timeout"]
    if options.kind_of?(Hash)
      prompt = options["Prompt"] if options.include?("Prompt")
      timeout = options["Timeout"] if options.include?("Timeout")
      prompt = Regexp.new( Regexp.quote(options["String"]) ) if
        options.include?("String")
    else
      prompt = options
    end
    line = ''
    while (not prompt === line and not @sock.closed?)
      next if not select([@sock], nil, nil, timeout)
      begin
        buf = if @options["Telnetmode"]
                preprocess( @sock.sysread(1024 * 1024) )
              else
                @sock.sysread(1024 * 1024)
              end
      rescue
        buf = "\nConnection closed by foreign host.\n"
        @sock.close
      end
      @log.print(buf) if @options.include?("Output_log")
      if iterator?
        yield buf
      end
      line += buf
    end
    line
  end

  def cmd(options)
    match = @options["Prompt"]
    timeout = @options["Timeout"]
    if options.kind_of?(Hash)
      string = options["String"]
      match = options["Match"] if options.include?("Match")
      timeout = options["Timeout"] if options.include?("Timeout")
    else
      string = options
    end
    @sock << string.gsub(/\n/, CR) << CR
    if iterator?
      waitfor({"Prompt" => match, "Timeout" => timeout}){|c| yield c }
    else
      waitfor({"Prompt" => match, "Timeout" => timeout})
    end
  end

  def login(options, password = nil)
    if options.kind_of?(Hash)
      username = options["Name"]
      password = options["Password"]
    else
      username = options
    end

    line = waitfor(/login[: ]*$/)
    line += cmd({"String" => username, "Match" => /Password[: ]*$/})
    line += cmd(password)
    line
  end

end