зеркало из https://github.com/github/ruby.git
RD -> RDoc by William Webber
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@4371 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
gsinclair
Родитель
09590a73fa
Коммит
8eb6b7328e
|
|
@ -1,164 +1,71 @@
|
||||||
=begin
|
# = net/telnet.rb - simple telnet client library
|
||||||
|
#
|
||||||
== NAME
|
# Wakou Aoyama <wakou@ruby-lang.org>
|
||||||
|
#
|
||||||
net/telnet.rb - simple telnet client library
|
# == Overview
|
||||||
|
#
|
||||||
Wakou Aoyama <wakou@ruby-lang.org>
|
# This file holds the class Net::Telnet, which provides client-side
|
||||||
|
# telnet functionality.
|
||||||
|
#
|
||||||
=== MAKE NEW TELNET OBJECT
|
# The telnet protocol allows a client to login remotely to a user
|
||||||
|
# account on a server and execute commands via a shell. The equivalent
|
||||||
host = Net::Telnet::new({
|
# is done by creating a Net::Telnet class with the Host option
|
||||||
"Binmode" => false, # default: false
|
# set to your host, calling #login() with your user and password,
|
||||||
"Host" => "localhost", # default: "localhost"
|
# issuing one or more #cmd() calls, and then calling #close()
|
||||||
"Output_log" => "output_log", # default: nil (no output)
|
# to end the session. The #waitfor(), #print(), #puts(), and
|
||||||
"Dump_log" => "dump_log", # default: nil (no output)
|
# #write() methods, which #cmd() is implemented on top of, are
|
||||||
"Port" => 23, # default: 23
|
# only needed if you are doing something more complicated.
|
||||||
"Prompt" => /[$%#>] \z/n, # default: /[$%#>] \z/n
|
#
|
||||||
"Telnetmode" => true, # default: true
|
# A Net::Telnet object can also be used to connect to non-telnet
|
||||||
"Timeout" => 10, # default: 10
|
# services, such as SMTP or HTTP. In this case, you normally
|
||||||
# if ignore timeout then set "Timeout" to false.
|
# want to provide the Port option to specify the port to
|
||||||
"Waittime" => 0, # default: 0
|
# connect to, and set the Telnetmode option to false to prevent
|
||||||
"Proxy" => proxy # default: nil
|
# the client from attempting to interpret telnet command sequences.
|
||||||
# proxy is Net::Telnet or IO object
|
# Generally, #login() will not work with other protocols, and you
|
||||||
})
|
# have to handle authentication yourself.
|
||||||
|
# For some protocols, it will be possible to specify the Prompt
|
||||||
Telnet object has socket class methods.
|
# option once when you create the Telnet object and use #cmd() calls;
|
||||||
|
# for others, you will have to specify the response sequence to
|
||||||
if set "Telnetmode" option to false. not telnet command interpretation.
|
# look for as the Match option to every #cmd() call, or call
|
||||||
"Waittime" is time to confirm "Prompt". There is a possibility that
|
# #puts() and #waitfor() directly; for yet others, you will have
|
||||||
the same character as "Prompt" is included in the data, and, when
|
# to use #sysread() instead of #waitfor() and parse server
|
||||||
the network or the host is very heavy, the value is enlarged.
|
# responses yourself.
|
||||||
|
#
|
||||||
|
# It is worth noting that when you create a new Net::Telnet object,
|
||||||
=== STATUS OUTPUT
|
# you can supply a proxy IO channel via the Proxy option. This
|
||||||
|
# can be used to attach the Telnet object to other Telnet objects,
|
||||||
host = Net::Telnet::new({"Host" => "localhost"}){|c| print c }
|
# to already open sockets, or to any read-write IO object. This
|
||||||
|
# can be useful, for instance, for setting up a test fixture for
|
||||||
connection status output.
|
# unit testing.
|
||||||
|
#
|
||||||
example:
|
# == Examples of use.
|
||||||
|
#
|
||||||
Trying localhost...
|
# === Log in and send a command, echoing all output to stdout.
|
||||||
Connected to localhost.
|
#
|
||||||
|
# localhost = Net::Telnet::new({"Host" => "localhost",
|
||||||
|
# "Timeout" => 10,
|
||||||
=== WAIT FOR MATCH
|
# "Prompt" => /[$%#>] \z/n})
|
||||||
|
# localhost.login("username", "password"){|c| print c }
|
||||||
line = host.waitfor(/match/)
|
# localhost.cmd("command"){|c| print c }
|
||||||
line = host.waitfor({"Match" => /match/,
|
# localhost.close
|
||||||
"String" => "string",
|
#
|
||||||
"Timeout" => secs})
|
#
|
||||||
# if ignore timeout then set "Timeout" to false.
|
# === Check a POP server to see if you have mail.
|
||||||
|
#
|
||||||
if set "String" option, then Match == Regexp.new(quote("string"))
|
# pop = Net::Telnet::new({"Host" => "your_destination_host_here",
|
||||||
|
# "Port" => 110,
|
||||||
|
# "Telnetmode" => false,
|
||||||
==== REALTIME OUTPUT
|
# "Prompt" => /^\+OK/n})
|
||||||
|
# pop.cmd("user " + "your_username_here"){|c| print c}
|
||||||
host.waitfor(/match/){|c| print c }
|
# pop.cmd("pass " + "your_password_here"){|c| print c}
|
||||||
host.waitfor({"Match" => /match/,
|
# pop.cmd("list"){|c| print c}
|
||||||
"String" => "string",
|
#
|
||||||
"Timeout" => secs}){|c| print c}
|
# == References.
|
||||||
|
#
|
||||||
of cource, set sync=true or flush is necessary.
|
# There are a large number of RFCs relevant to the Telnet protocol.
|
||||||
|
# RFCs 854-861 define the base protocol. For a complete listing
|
||||||
|
# of relevant RFCs, see
|
||||||
=== SEND STRING AND WAIT PROMPT
|
# http://www.omnifarious.org/~hopper/technical/telnet-rfc.html
|
||||||
|
|
||||||
line = host.cmd("string")
|
|
||||||
line = host.cmd({"String" => "string",
|
|
||||||
"Match" => /[$%#>] \z/n,
|
|
||||||
"Timeout" => 10})
|
|
||||||
|
|
||||||
|
|
||||||
==== REALTIME OUTPUT
|
|
||||||
|
|
||||||
host.cmd("string"){|c| print c }
|
|
||||||
host.cmd({"String" => "string",
|
|
||||||
"Match" => /[$%#>] \z/n,
|
|
||||||
"Timeout" => 10}){|c| print c }
|
|
||||||
|
|
||||||
of cource, set sync=true or flush is necessary.
|
|
||||||
|
|
||||||
|
|
||||||
=== SEND STRING
|
|
||||||
|
|
||||||
host.print("string")
|
|
||||||
host.puts("string")
|
|
||||||
|
|
||||||
Telnet#puts() adds "\n" to the last of "string".
|
|
||||||
|
|
||||||
CAUTION: Telnet#print() NOT adds "\n" to the last of "string".
|
|
||||||
|
|
||||||
If "Telnetmode" option is true, then escape IAC code ("\xFF"). If
|
|
||||||
"Binmode" option is false, then convert "\n" to EOL(end of line) code.
|
|
||||||
|
|
||||||
If "WILL SGA" and "DO BIN", then EOL is CR. If "WILL SGA", then EOL is
|
|
||||||
CR + NULL. If the other cases, EOL is CR + LF.
|
|
||||||
|
|
||||||
|
|
||||||
=== TOGGLE TELNET COMMAND INTERPRETATION
|
|
||||||
|
|
||||||
host.telnetmode # return the current status (true or false)
|
|
||||||
host.telnetmode = true # do telnet command interpretation (default)
|
|
||||||
host.telnetmode = false # don't telnet command interpretation
|
|
||||||
|
|
||||||
|
|
||||||
=== TOGGLE NEWLINE TRANSLATION
|
|
||||||
|
|
||||||
host.binmode # return the current status (true or false)
|
|
||||||
host.binmode = true # no translate newline
|
|
||||||
host.binmode = false # translate newline (default)
|
|
||||||
|
|
||||||
|
|
||||||
=== LOGIN
|
|
||||||
|
|
||||||
host.login("username", "password")
|
|
||||||
host.login({"Name" => "username",
|
|
||||||
"Password" => "password"})
|
|
||||||
|
|
||||||
if no password prompt:
|
|
||||||
|
|
||||||
host.login("username")
|
|
||||||
host.login({"Name" => "username"})
|
|
||||||
|
|
||||||
|
|
||||||
==== REALTIME OUTPUT
|
|
||||||
|
|
||||||
host.login("username", "password"){|c| print c }
|
|
||||||
host.login({"Name" => "username",
|
|
||||||
"Password" => "password"}){|c| print c }
|
|
||||||
|
|
||||||
of cource, set sync=true or flush is necessary.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
== EXAMPLE
|
|
||||||
|
|
||||||
=== LOGIN AND SEND COMMAND
|
|
||||||
|
|
||||||
localhost = Net::Telnet::new({"Host" => "localhost",
|
|
||||||
"Timeout" => 10,
|
|
||||||
"Prompt" => /[$%#>] \z/n})
|
|
||||||
localhost.login("username", "password"){|c| print c }
|
|
||||||
localhost.cmd("command"){|c| print c }
|
|
||||||
localhost.close
|
|
||||||
|
|
||||||
|
|
||||||
=== CHECKS A POP SERVER TO SEE IF YOU HAVE MAIL
|
|
||||||
|
|
||||||
pop = Net::Telnet::new({"Host" => "your_destination_host_here",
|
|
||||||
"Port" => 110,
|
|
||||||
"Telnetmode" => false,
|
|
||||||
"Prompt" => /^\+OK/n})
|
|
||||||
pop.cmd("user " + "your_username_here"){|c| print c}
|
|
||||||
pop.cmd("pass " + "your_password_here"){|c| print c}
|
|
||||||
pop.cmd("list"){|c| print c}
|
|
||||||
|
|
||||||
|
|
||||||
=end
|
|
||||||
|
|
||||||
|
|
||||||
require "socket"
|
require "socket"
|
||||||
|
|
@ -166,80 +73,200 @@ require "delegate"
|
||||||
require "timeout"
|
require "timeout"
|
||||||
require "English"
|
require "English"
|
||||||
|
|
||||||
module Net
|
module Net # :nodoc:
|
||||||
|
|
||||||
|
# Provides telnet client functionality.
|
||||||
|
#
|
||||||
|
# This class also has, through delegation, all the methods of
|
||||||
|
# a socket object (by default, a TCPSocket, but can be set
|
||||||
|
# by the Proxy option to new()). This provides methods
|
||||||
|
# such as #close() to end the session and #sysread() to
|
||||||
|
# read data directly from the host, instead of via the
|
||||||
|
# #waitfor() mechanism. Note that if you do use #sysread()
|
||||||
|
# directly when in telnet mode, you should probably pass
|
||||||
|
# the output through #preprocess() to extract telnet command
|
||||||
|
# sequences.
|
||||||
|
#
|
||||||
|
# See the documentation to the telnet.rb file for an overview
|
||||||
|
# and examples of usage.
|
||||||
class Telnet < SimpleDelegator
|
class Telnet < SimpleDelegator
|
||||||
|
|
||||||
IAC = 255.chr # "\377" # "\xff" # interpret as command:
|
# :stopdoc:
|
||||||
DONT = 254.chr # "\376" # "\xfe" # you are not to use option
|
IAC = 255.chr # "\377" # "\xff" # interpret as command
|
||||||
DO = 253.chr # "\375" # "\xfd" # please, you use option
|
DONT = 254.chr # "\376" # "\xfe" # you are not to use option
|
||||||
WONT = 252.chr # "\374" # "\xfc" # I won't use option
|
DO = 253.chr # "\375" # "\xfd" # please, you use option
|
||||||
WILL = 251.chr # "\373" # "\xfb" # I will use option
|
WONT = 252.chr # "\374" # "\xfc" # I won't use option
|
||||||
SB = 250.chr # "\372" # "\xfa" # interpret as subnegotiation
|
WILL = 251.chr # "\373" # "\xfb" # I will use option
|
||||||
GA = 249.chr # "\371" # "\xf9" # you may reverse the line
|
SB = 250.chr # "\372" # "\xfa" # interpret as subnegotiation
|
||||||
EL = 248.chr # "\370" # "\xf8" # erase the current line
|
GA = 249.chr # "\371" # "\xf9" # you may reverse the line
|
||||||
EC = 247.chr # "\367" # "\xf7" # erase the current character
|
EL = 248.chr # "\370" # "\xf8" # erase the current line
|
||||||
AYT = 246.chr # "\366" # "\xf6" # are you there
|
EC = 247.chr # "\367" # "\xf7" # erase the current character
|
||||||
AO = 245.chr # "\365" # "\xf5" # abort output--but let prog finish
|
AYT = 246.chr # "\366" # "\xf6" # are you there
|
||||||
IP = 244.chr # "\364" # "\xf4" # interrupt process--permanently
|
AO = 245.chr # "\365" # "\xf5" # abort output--but let prog finish
|
||||||
BREAK = 243.chr # "\363" # "\xf3" # break
|
IP = 244.chr # "\364" # "\xf4" # interrupt process--permanently
|
||||||
DM = 242.chr # "\362" # "\xf2" # data mark--for connect. cleaning
|
BREAK = 243.chr # "\363" # "\xf3" # break
|
||||||
NOP = 241.chr # "\361" # "\xf1" # nop
|
DM = 242.chr # "\362" # "\xf2" # data mark--for connect. cleaning
|
||||||
SE = 240.chr # "\360" # "\xf0" # end sub negotiation
|
NOP = 241.chr # "\361" # "\xf1" # nop
|
||||||
EOR = 239.chr # "\357" # "\xef" # end of record (transparent mode)
|
SE = 240.chr # "\360" # "\xf0" # end sub negotiation
|
||||||
ABORT = 238.chr # "\356" # "\xee" # Abort process
|
EOR = 239.chr # "\357" # "\xef" # end of record (transparent mode)
|
||||||
SUSP = 237.chr # "\355" # "\xed" # Suspend process
|
ABORT = 238.chr # "\356" # "\xee" # Abort process
|
||||||
EOF = 236.chr # "\354" # "\xec" # End of file
|
SUSP = 237.chr # "\355" # "\xed" # Suspend process
|
||||||
SYNCH = 242.chr # "\362" # "\xf2" # for telfunc calls
|
EOF = 236.chr # "\354" # "\xec" # End of file
|
||||||
|
SYNCH = 242.chr # "\362" # "\xf2" # for telfunc calls
|
||||||
|
|
||||||
OPT_BINARY = 0.chr # "\000" # "\x00" # Binary Transmission
|
OPT_BINARY = 0.chr # "\000" # "\x00" # Binary Transmission
|
||||||
OPT_ECHO = 1.chr # "\001" # "\x01" # Echo
|
OPT_ECHO = 1.chr # "\001" # "\x01" # Echo
|
||||||
OPT_RCP = 2.chr # "\002" # "\x02" # Reconnection
|
OPT_RCP = 2.chr # "\002" # "\x02" # Reconnection
|
||||||
OPT_SGA = 3.chr # "\003" # "\x03" # Suppress Go Ahead
|
OPT_SGA = 3.chr # "\003" # "\x03" # Suppress Go Ahead
|
||||||
OPT_NAMS = 4.chr # "\004" # "\x04" # Approx Message Size Negotiation
|
OPT_NAMS = 4.chr # "\004" # "\x04" # Approx Message Size Negotiation
|
||||||
OPT_STATUS = 5.chr # "\005" # "\x05" # Status
|
OPT_STATUS = 5.chr # "\005" # "\x05" # Status
|
||||||
OPT_TM = 6.chr # "\006" # "\x06" # Timing Mark
|
OPT_TM = 6.chr # "\006" # "\x06" # Timing Mark
|
||||||
OPT_RCTE = 7.chr # "\a" # "\x07" # Remote Controlled Trans and Echo
|
OPT_RCTE = 7.chr # "\a" # "\x07" # Remote Controlled Trans and Echo
|
||||||
OPT_NAOL = 8.chr # "\010" # "\x08" # Output Line Width
|
OPT_NAOL = 8.chr # "\010" # "\x08" # Output Line Width
|
||||||
OPT_NAOP = 9.chr # "\t" # "\x09" # Output Page Size
|
OPT_NAOP = 9.chr # "\t" # "\x09" # Output Page Size
|
||||||
OPT_NAOCRD = 10.chr # "\n" # "\x0a" # Output Carriage-Return Disposition
|
OPT_NAOCRD = 10.chr # "\n" # "\x0a" # Output Carriage-Return Disposition
|
||||||
OPT_NAOHTS = 11.chr # "\v" # "\x0b" # Output Horizontal Tab Stops
|
OPT_NAOHTS = 11.chr # "\v" # "\x0b" # Output Horizontal Tab Stops
|
||||||
OPT_NAOHTD = 12.chr # "\f" # "\x0c" # Output Horizontal Tab Disposition
|
OPT_NAOHTD = 12.chr # "\f" # "\x0c" # Output Horizontal Tab Disposition
|
||||||
OPT_NAOFFD = 13.chr # "\r" # "\x0d" # Output Formfeed Disposition
|
OPT_NAOFFD = 13.chr # "\r" # "\x0d" # Output Formfeed Disposition
|
||||||
OPT_NAOVTS = 14.chr # "\016" # "\x0e" # Output Vertical Tabstops
|
OPT_NAOVTS = 14.chr # "\016" # "\x0e" # Output Vertical Tabstops
|
||||||
OPT_NAOVTD = 15.chr # "\017" # "\x0f" # Output Vertical Tab Disposition
|
OPT_NAOVTD = 15.chr # "\017" # "\x0f" # Output Vertical Tab Disposition
|
||||||
OPT_NAOLFD = 16.chr # "\020" # "\x10" # Output Linefeed Disposition
|
OPT_NAOLFD = 16.chr # "\020" # "\x10" # Output Linefeed Disposition
|
||||||
OPT_XASCII = 17.chr # "\021" # "\x11" # Extended ASCII
|
OPT_XASCII = 17.chr # "\021" # "\x11" # Extended ASCII
|
||||||
OPT_LOGOUT = 18.chr # "\022" # "\x12" # Logout
|
OPT_LOGOUT = 18.chr # "\022" # "\x12" # Logout
|
||||||
OPT_BM = 19.chr # "\023" # "\x13" # Byte Macro
|
OPT_BM = 19.chr # "\023" # "\x13" # Byte Macro
|
||||||
OPT_DET = 20.chr # "\024" # "\x14" # Data Entry Terminal
|
OPT_DET = 20.chr # "\024" # "\x14" # Data Entry Terminal
|
||||||
OPT_SUPDUP = 21.chr # "\025" # "\x15" # SUPDUP
|
OPT_SUPDUP = 21.chr # "\025" # "\x15" # SUPDUP
|
||||||
OPT_SUPDUPOUTPUT = 22.chr # "\026" # "\x16" # SUPDUP Output
|
OPT_SUPDUPOUTPUT = 22.chr # "\026" # "\x16" # SUPDUP Output
|
||||||
OPT_SNDLOC = 23.chr # "\027" # "\x17" # Send Location
|
OPT_SNDLOC = 23.chr # "\027" # "\x17" # Send Location
|
||||||
OPT_TTYPE = 24.chr # "\030" # "\x18" # Terminal Type
|
OPT_TTYPE = 24.chr # "\030" # "\x18" # Terminal Type
|
||||||
OPT_EOR = 25.chr # "\031" # "\x19" # End of Record
|
OPT_EOR = 25.chr # "\031" # "\x19" # End of Record
|
||||||
OPT_TUID = 26.chr # "\032" # "\x1a" # TACACS User Identification
|
OPT_TUID = 26.chr # "\032" # "\x1a" # TACACS User Identification
|
||||||
OPT_OUTMRK = 27.chr # "\e" # "\x1b" # Output Marking
|
OPT_OUTMRK = 27.chr # "\e" # "\x1b" # Output Marking
|
||||||
OPT_TTYLOC = 28.chr # "\034" # "\x1c" # Terminal Location Number
|
OPT_TTYLOC = 28.chr # "\034" # "\x1c" # Terminal Location Number
|
||||||
OPT_3270REGIME = 29.chr # "\035" # "\x1d" # Telnet 3270 Regime
|
OPT_3270REGIME = 29.chr # "\035" # "\x1d" # Telnet 3270 Regime
|
||||||
OPT_X3PAD = 30.chr # "\036" # "\x1e" # X.3 PAD
|
OPT_X3PAD = 30.chr # "\036" # "\x1e" # X.3 PAD
|
||||||
OPT_NAWS = 31.chr # "\037" # "\x1f" # Negotiate About Window Size
|
OPT_NAWS = 31.chr # "\037" # "\x1f" # Negotiate About Window Size
|
||||||
OPT_TSPEED = 32.chr # " " # "\x20" # Terminal Speed
|
OPT_TSPEED = 32.chr # " " # "\x20" # Terminal Speed
|
||||||
OPT_LFLOW = 33.chr # "!" # "\x21" # Remote Flow Control
|
OPT_LFLOW = 33.chr # "!" # "\x21" # Remote Flow Control
|
||||||
OPT_LINEMODE = 34.chr # "\"" # "\x22" # Linemode
|
OPT_LINEMODE = 34.chr # "\"" # "\x22" # Linemode
|
||||||
OPT_XDISPLOC = 35.chr # "#" # "\x23" # X Display Location
|
OPT_XDISPLOC = 35.chr # "#" # "\x23" # X Display Location
|
||||||
OPT_OLD_ENVIRON = 36.chr # "$" # "\x24" # Environment Option
|
OPT_OLD_ENVIRON = 36.chr # "$" # "\x24" # Environment Option
|
||||||
OPT_AUTHENTICATION = 37.chr # "%" # "\x25" # Authentication Option
|
OPT_AUTHENTICATION = 37.chr # "%" # "\x25" # Authentication Option
|
||||||
OPT_ENCRYPT = 38.chr # "&" # "\x26" # Encryption Option
|
OPT_ENCRYPT = 38.chr # "&" # "\x26" # Encryption Option
|
||||||
OPT_NEW_ENVIRON = 39.chr # "'" # "\x27" # New Environment Option
|
OPT_NEW_ENVIRON = 39.chr # "'" # "\x27" # New Environment Option
|
||||||
OPT_EXOPL = 255.chr # "\377" # "\xff" # Extended-Options-List
|
OPT_EXOPL = 255.chr # "\377" # "\xff" # Extended-Options-List
|
||||||
|
|
||||||
NULL = "\000"
|
NULL = "\000"
|
||||||
CR = "\015"
|
CR = "\015"
|
||||||
LF = "\012"
|
LF = "\012"
|
||||||
EOL = CR + LF
|
EOL = CR + LF
|
||||||
REVISION = '$Id$'
|
REVISION = '$Id$'
|
||||||
|
# :startdoc:
|
||||||
|
|
||||||
def initialize(options)
|
# Creates a new Net::Telnet object.
|
||||||
|
#
|
||||||
|
# Attempts to connect to the host (unless the Proxy option is
|
||||||
|
# provided: see below). If a block is provided, it is yielded
|
||||||
|
# status messages on the attempt to connect to the server, of
|
||||||
|
# the form:
|
||||||
|
#
|
||||||
|
# Trying localhost...
|
||||||
|
# Connected to localhost.
|
||||||
|
#
|
||||||
|
# +options+ is a hash of options. The following example lists
|
||||||
|
# all options and their default values.
|
||||||
|
#
|
||||||
|
# host = Net::Telnet::new({
|
||||||
|
# "Host" => "localhost", # default: "localhost"
|
||||||
|
# "Port" => 23, # default: 23
|
||||||
|
# "Binmode" => false, # default: false
|
||||||
|
# "Output_log" => "output_log", # default: nil (no output)
|
||||||
|
# "Dump_log" => "dump_log", # default: nil (no output)
|
||||||
|
# "Prompt" => /[$%#>] \z/n, # default: /[$%#>] \z/n
|
||||||
|
# "Telnetmode" => true, # default: true
|
||||||
|
# "Timeout" => 10, # default: 10
|
||||||
|
# # if ignore timeout then set "Timeout" to false.
|
||||||
|
# "Waittime" => 0, # default: 0
|
||||||
|
# "Proxy" => proxy # default: nil
|
||||||
|
# # proxy is Net::Telnet or IO object
|
||||||
|
# })
|
||||||
|
#
|
||||||
|
# The options have the following meanings:
|
||||||
|
#
|
||||||
|
# Host:: the hostname or IP address of the host to connect to, as a String.
|
||||||
|
# Defaults to "localhost".
|
||||||
|
#
|
||||||
|
# Port:: the port to connect to. Defaults to 23.
|
||||||
|
#
|
||||||
|
# Binmode:: if false (the default), newline substitution is performed.
|
||||||
|
# Outgoing LF is
|
||||||
|
# converted to CRLF, and incoming CRLF is converted to LF. If
|
||||||
|
# true, this substitution is not performed. This value can
|
||||||
|
# also be set with the #binmode() method. The
|
||||||
|
# outgoing conversion only applies to the #puts() and #print()
|
||||||
|
# methods, not the #write() method. The precise nature of
|
||||||
|
# the newline conversion is also affected by the telnet options
|
||||||
|
# SGA and BIN.
|
||||||
|
#
|
||||||
|
# Output_log:: the name of the file to write connection status messages
|
||||||
|
# and all received traffic to. In the case of a proper
|
||||||
|
# Telnet session, this will include the client input as
|
||||||
|
# echoed by the host; otherwise, it only includes server
|
||||||
|
# responses. Output is appended verbatim to this file.
|
||||||
|
# By default, no output log is kept.
|
||||||
|
#
|
||||||
|
# Dump_log:: as for Output_log, except that output is written in hexdump
|
||||||
|
# format (16 bytes per line as hex pairs, followed by their
|
||||||
|
# printable equivalent), with connection status messages
|
||||||
|
# preceded by '#', sent traffic preceded by '>', and
|
||||||
|
# received traffic preceded by '<'. By default, not dump log
|
||||||
|
# is kept.
|
||||||
|
#
|
||||||
|
# Prompt:: a regular expression matching the host's command-line prompt
|
||||||
|
# sequence. This is needed by the Telnet class to determine
|
||||||
|
# when the output from a command has finished and the host is
|
||||||
|
# ready to receive a new command. By default, this regular
|
||||||
|
# expression is /[$%#>] \z/n.
|
||||||
|
#
|
||||||
|
# Telnetmode:: a boolean value, true by default. In telnet mode,
|
||||||
|
# traffic received from the host is parsed for special
|
||||||
|
# command sequences, and these sequences are escaped
|
||||||
|
# in outgoing traffic sent using #puts() or #print()
|
||||||
|
# (but not #write()). If you are using the Net::Telnet
|
||||||
|
# object to connect to a non-telnet service (such as
|
||||||
|
# SMTP or POP), this should be set to "false" to prevent
|
||||||
|
# undesired data corruption. This value can also be set
|
||||||
|
# by the #telnetmode() method.
|
||||||
|
#
|
||||||
|
# Timeout:: the number of seconds to wait before timing out both the
|
||||||
|
# initial attempt to connect to host (in this constructor),
|
||||||
|
# and all attempts to read data from the host (in #waitfor(),
|
||||||
|
# #cmd(), and #login()). Exceding this timeout causes a
|
||||||
|
# TimeoutError to be raised. The default value is 10 seconds.
|
||||||
|
# You can disable the timeout by setting this value to false.
|
||||||
|
# In this case, the connect attempt will eventually timeout
|
||||||
|
# on the underlying connect(2) socket call with an
|
||||||
|
# Errno::ETIMEDOUT error (but generally only after a few
|
||||||
|
# minutes), but other attempts to read data from the host
|
||||||
|
# will hand indefinitely if no data is forthcoming.
|
||||||
|
#
|
||||||
|
# Waittime:: the amount of time to wait after seeing what looks like a
|
||||||
|
# prompt (that is, received data that matches the Prompt
|
||||||
|
# option regular expression) to see if more data arrives.
|
||||||
|
# If more data does arrive in this time, Net::Telnet assumes
|
||||||
|
# that what it saw was not really a prompt. This is to try to
|
||||||
|
# avoid false matches, but it can also lead to missing real
|
||||||
|
# prompts (if, for instance, a background process writes to
|
||||||
|
# the terminal soon after the prompt is displayed). By
|
||||||
|
# default, set to 0, meaning not to wait for more data.
|
||||||
|
#
|
||||||
|
# Proxy:: a proxy object to used instead of opening a direct connection
|
||||||
|
# to the host. Must be either another Net::Telnet object or
|
||||||
|
# an IO object. If it is another Net::Telnet object, this
|
||||||
|
# instance will use that one's socket for communication. If an
|
||||||
|
# IO object, it is used directly for communication. Any other
|
||||||
|
# kind of object will cause an error to be raised.
|
||||||
|
def initialize(options) # :yield: mesg
|
||||||
@options = options
|
@options = options
|
||||||
@options["Host"] = "localhost" unless @options.has_key?("Host")
|
@options["Host"] = "localhost" unless @options.has_key?("Host")
|
||||||
@options["Port"] = 23 unless @options.has_key?("Port")
|
@options["Port"] = 23 unless @options.has_key?("Port")
|
||||||
|
|
@ -274,7 +301,7 @@ module Net
|
||||||
@dumplog = File.open(@options["Dump_log"], 'a+')
|
@dumplog = File.open(@options["Dump_log"], 'a+')
|
||||||
@dumplog.sync = true
|
@dumplog.sync = true
|
||||||
@dumplog.binmode
|
@dumplog.binmode
|
||||||
def @dumplog.log_dump(dir, x)
|
def @dumplog.log_dump(dir, x) # :nodoc:
|
||||||
len = x.length
|
len = x.length
|
||||||
addr = 0
|
addr = 0
|
||||||
offset = 0
|
offset = 0
|
||||||
|
|
@ -338,8 +365,16 @@ module Net
|
||||||
super(@sock)
|
super(@sock)
|
||||||
end # initialize
|
end # initialize
|
||||||
|
|
||||||
attr :sock
|
# The socket the Telnet object is using. Note that this object becomes
|
||||||
|
# a delegate of the Telnet object, so normally you invoke its methods
|
||||||
|
# directly on the Telnet object.
|
||||||
|
attr :sock
|
||||||
|
|
||||||
|
# Set telnet command interpretation on (+mode+ == true) or off
|
||||||
|
# (+mode+ == false), or return the current value (+mode+ not
|
||||||
|
# provided). It should be on for true telnet sessions, off if
|
||||||
|
# using Net::Telnet to connect to a non-telnet service such
|
||||||
|
# as SMTP.
|
||||||
def telnetmode(mode = nil)
|
def telnetmode(mode = nil)
|
||||||
case mode
|
case mode
|
||||||
when nil
|
when nil
|
||||||
|
|
@ -351,6 +386,9 @@ module Net
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Turn telnet command interpretation on (true) or off (false). It
|
||||||
|
# should be on for true telnet sessions, off if using Net::Telnet
|
||||||
|
# to connect to a non-telnet service such as SMTP.
|
||||||
def telnetmode=(mode)
|
def telnetmode=(mode)
|
||||||
if (true == mode or false == mode)
|
if (true == mode or false == mode)
|
||||||
@options["Telnetmode"] = mode
|
@options["Telnetmode"] = mode
|
||||||
|
|
@ -359,6 +397,8 @@ module Net
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Turn newline conversion on (+mode+ == false) or off (+mode+ == true),
|
||||||
|
# or return the current value (+mode+ is not specified).
|
||||||
def binmode(mode = nil)
|
def binmode(mode = nil)
|
||||||
case mode
|
case mode
|
||||||
when nil
|
when nil
|
||||||
|
|
@ -370,6 +410,7 @@ module Net
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Turn newline conversion on (false) or off (true).
|
||||||
def binmode=(mode)
|
def binmode=(mode)
|
||||||
if (true == mode or false == mode)
|
if (true == mode or false == mode)
|
||||||
@options["Binmode"] = mode
|
@options["Binmode"] = mode
|
||||||
|
|
@ -378,6 +419,12 @@ module Net
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Preprocess received data from the host.
|
||||||
|
#
|
||||||
|
# Performs newline conversion and detects telnet command sequences.
|
||||||
|
# Called automatically by #waitfor(). You should only use this
|
||||||
|
# method yourself if you have read input directly using sysread()
|
||||||
|
# or similar, and even then only if in telnet mode.
|
||||||
def preprocess(string)
|
def preprocess(string)
|
||||||
# combine CR+NULL into CR
|
# combine CR+NULL into CR
|
||||||
string = string.gsub(/#{CR}#{NULL}/no, CR) if @options["Telnetmode"]
|
string = string.gsub(/#{CR}#{NULL}/no, CR) if @options["Telnetmode"]
|
||||||
|
|
@ -435,7 +482,40 @@ module Net
|
||||||
end
|
end
|
||||||
end # preprocess
|
end # preprocess
|
||||||
|
|
||||||
def waitfor(options)
|
# Read data from the host until a certain sequence is matched.
|
||||||
|
#
|
||||||
|
# If a block is given, the received data will be yielded as it
|
||||||
|
# is read in (not necessarily all in one go), or nil if EOF
|
||||||
|
# occurs before any data is received. Whether a block is given
|
||||||
|
# or not, all data read will be returned in a single string, or again
|
||||||
|
# nil if EOF occurs before any data is received. Note that
|
||||||
|
# received data includes the matched sequence we were looking for.
|
||||||
|
#
|
||||||
|
# +options+ can be either a regular expression or a hash of options.
|
||||||
|
# If a regular expression, this specifies the data to wait for.
|
||||||
|
# If a hash, this can specify the following options:
|
||||||
|
#
|
||||||
|
# Match:: a regular expression, specifying the data to wait for.
|
||||||
|
# Prompt:: as for Match; used only if Match is not specified.
|
||||||
|
# String:: as for Match, except a string that will be converted
|
||||||
|
# into a regular expression. Used only if Match and
|
||||||
|
# Prompt are not specified.
|
||||||
|
# Timeout:: the number of seconds to wait for data from the host
|
||||||
|
# before raising a TimeoutError. If set to false,
|
||||||
|
# no timeout will occur. If not specified, the
|
||||||
|
# Timeout option value specified when this instance
|
||||||
|
# was created will be used, or, failing that, the
|
||||||
|
# default value of 10 seconds.
|
||||||
|
# Waittime:: the number of seconds to wait after matching against
|
||||||
|
# the input data to see if more data arrives. If more
|
||||||
|
# data arrives within this time, we will judge ourselves
|
||||||
|
# not to have matched successfully, and will continue
|
||||||
|
# trying to match. If not specified, the Waittime option
|
||||||
|
# value specified when this instance was created will be
|
||||||
|
# used, or, failing that, the default value of 0 seconds,
|
||||||
|
# which means not to wait for more input.
|
||||||
|
#
|
||||||
|
def waitfor(options) # :yield: recvdata
|
||||||
time_out = @options["Timeout"]
|
time_out = @options["Timeout"]
|
||||||
waittime = @options["Waittime"]
|
waittime = @options["Waittime"]
|
||||||
|
|
||||||
|
|
@ -503,6 +583,10 @@ module Net
|
||||||
line
|
line
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Write +string+ to the host.
|
||||||
|
#
|
||||||
|
# Does not perform any conversions on +string+. Will log +string+ to the
|
||||||
|
# dumplog, if the Dump_log option is set.
|
||||||
def write(string)
|
def write(string)
|
||||||
length = string.length
|
length = string.length
|
||||||
while 0 < length
|
while 0 < length
|
||||||
|
|
@ -512,6 +596,12 @@ module Net
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Sends a string to the host.
|
||||||
|
#
|
||||||
|
# This does _not_ automatically append a newline to the string. Embedded
|
||||||
|
# newlines may be converted and telnet command sequences escaped
|
||||||
|
# depending upon the values of telnetmode, binmode, and telnet options
|
||||||
|
# set by the host.
|
||||||
def print(string)
|
def print(string)
|
||||||
string = string.gsub(/#{IAC}/no, IAC + IAC) if @options["Telnetmode"]
|
string = string.gsub(/#{IAC}/no, IAC + IAC) if @options["Telnetmode"]
|
||||||
|
|
||||||
|
|
@ -531,11 +621,41 @@ module Net
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Sends a string to the host.
|
||||||
|
#
|
||||||
|
# Same as #print(), but appends a newline to the string.
|
||||||
def puts(string)
|
def puts(string)
|
||||||
self.print(string + "\n")
|
self.print(string + "\n")
|
||||||
end
|
end
|
||||||
|
|
||||||
def cmd(options)
|
# Send a command to the host.
|
||||||
|
#
|
||||||
|
# More exactly, sends a string to the host, and reads in all received
|
||||||
|
# data until is sees the prompt or other matched sequence.
|
||||||
|
#
|
||||||
|
# If a block is given, the received data will be yielded to it as
|
||||||
|
# it is read in. Whether a block is given or not, the received data
|
||||||
|
# will be return as a string. Note that the received data includes
|
||||||
|
# the prompt and in most cases the host's echo of our command.
|
||||||
|
#
|
||||||
|
# +options+ is either a String, specified the string or command to
|
||||||
|
# send to the host; or it is a hash of options. If a hash, the
|
||||||
|
# following options can be specified:
|
||||||
|
#
|
||||||
|
# String:: the command or other string to send to the host.
|
||||||
|
# Match:: a regular expression, the sequence to look for in
|
||||||
|
# the received data before returning. If not specified,
|
||||||
|
# the Prompt option value specified when this instance
|
||||||
|
# was created will be used, or, failing that, the default
|
||||||
|
# prompt of /[$%#>] \z/n.
|
||||||
|
# Timeout:: the seconds to wait for data from the host before raising
|
||||||
|
# a Timeout error. If not specified, the Timeout option
|
||||||
|
# value specified when this instance was created will be
|
||||||
|
# used, or, failing that, the default value of 10 seconds.
|
||||||
|
#
|
||||||
|
# The command or other string will have the newline sequence appended
|
||||||
|
# to it.
|
||||||
|
def cmd(options) # :yield: recvdata
|
||||||
match = @options["Prompt"]
|
match = @options["Prompt"]
|
||||||
time_out = @options["Timeout"]
|
time_out = @options["Timeout"]
|
||||||
|
|
||||||
|
|
@ -555,7 +675,29 @@ module Net
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def login(options, password = nil)
|
# Login to the host with a given username and password.
|
||||||
|
#
|
||||||
|
# The username and password can either be provided as two string
|
||||||
|
# arguments in that order, or as a hash with keys "Name" and
|
||||||
|
# "Password".
|
||||||
|
#
|
||||||
|
# This method looks for the strings "login" and "Password" from the
|
||||||
|
# host to determine when to send the username and password. If the
|
||||||
|
# login sequence does not follow this pattern (for instance, you
|
||||||
|
# are connecting to a service other than telnet), you will need
|
||||||
|
# to handle login yourself.
|
||||||
|
#
|
||||||
|
# The password can be omitted, either by only
|
||||||
|
# provided one String argument, which will be used as the username,
|
||||||
|
# or by providing a has that has no "Password" key. In this case,
|
||||||
|
# the method will not look for the "Password:" prompt; if it is
|
||||||
|
# sent, it will have to be dealt with by later calls.
|
||||||
|
#
|
||||||
|
# The method returns all data received during the login process from
|
||||||
|
# the host, including the echoed username but not the password (which
|
||||||
|
# the host should not echo). If a block is passed in, this received
|
||||||
|
# data is also yielded to the block as it is received.
|
||||||
|
def login(options, password = nil) # :yield: recvdata
|
||||||
if options.kind_of?(Hash)
|
if options.kind_of?(Hash)
|
||||||
username = options["Name"]
|
username = options["Name"]
|
||||||
password = options["Password"]
|
password = options["Password"]
|
||||||
|
|
@ -585,15 +727,6 @@ module Net
|
||||||
line
|
line
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end # class Telnet
|
||||||
end
|
end # module Net
|
||||||
|
|
||||||
|
|
||||||
=begin
|
|
||||||
|
|
||||||
== HISTORY
|
|
||||||
|
|
||||||
delete. see cvs log.
|
|
||||||
|
|
||||||
|
|
||||||
=end
|
|
||||||
|
|
|
||||||
Загрузка…
Ссылка в новой задаче