Initial commit
This commit is contained in:
66
node_modules/telnet-stream/CHANGELOG.md
generated
vendored
Normal file
66
node_modules/telnet-stream/CHANGELOG.md
generated
vendored
Normal file
@@ -0,0 +1,66 @@
|
||||
# Changelog
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
|
||||
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [Unreleased]
|
||||
### Added
|
||||
- for new features
|
||||
### Changed
|
||||
- for changes in existing functionality
|
||||
### Deprecated
|
||||
- for soon-to-be removed features
|
||||
### Removed
|
||||
- for now removed features
|
||||
### Fixed
|
||||
- for any bug fixes
|
||||
### Security
|
||||
- in case of vulnerabilities
|
||||
|
||||
## [1.0.5] - 2021-01-17
|
||||
### Added
|
||||
- Contributor Voakie provided TypeScript definitions for telnet-stream
|
||||
### Changed
|
||||
- Modified check task to use Promises for dependency version checks
|
||||
- Modified coverage task to use nyc library instead of istanbul
|
||||
- Modified deprecated Buffer allocations in two test classes
|
||||
- Updated dev dependencies to latest versions in package.json
|
||||
|
||||
## [1.0.4] - 2017-11-25
|
||||
### Added
|
||||
- Example source code to ensure examples function properly
|
||||
### Changed
|
||||
- Examples in README.md to make them functional
|
||||
|
||||
## [1.0.3] - 2017-11-25
|
||||
### Changed
|
||||
- Minor clean up of package.json
|
||||
|
||||
## [1.0.2] - 2017-11-25
|
||||
### Added
|
||||
- CHANGELOG.md added to npm published files in package.json
|
||||
|
||||
## [1.0.1] - 2017-11-25
|
||||
### Changed
|
||||
- Minor clean up of TelnetOutput
|
||||
|
||||
## 1.0.0 - 2017-11-25
|
||||
### Added
|
||||
- TelnetSocket to decorate a net.Socket
|
||||
- Options object to specify subnegotiation buffer size and error policy
|
||||
- Emit error events on subnegotiation errors
|
||||
- Test coverage reporting with istanbul
|
||||
- LICENSE and README.md files to npm published archive
|
||||
- CHANGELOG.md to track project changes
|
||||
|
||||
### Changed
|
||||
- Default behavior for subnegotiation errors; bytes are kept not discarded
|
||||
- Location of test sources
|
||||
|
||||
[Unreleased]: https://github.com/blinkdog/telnet-stream/compare/v1.0.5...HEAD
|
||||
[1.0.5]: https://github.com/blinkdog/telnet-stream/compare/v1.0.4...v1.0.5
|
||||
[1.0.4]: https://github.com/blinkdog/telnet-stream/compare/v1.0.3...v1.0.4
|
||||
[1.0.3]: https://github.com/blinkdog/telnet-stream/compare/v1.0.2...v1.0.3
|
||||
[1.0.2]: https://github.com/blinkdog/telnet-stream/compare/v1.0.1...v1.0.2
|
||||
[1.0.1]: https://github.com/blinkdog/telnet-stream/compare/v1.0.0...v1.0.1
|
||||
661
node_modules/telnet-stream/LICENSE
generated
vendored
Normal file
661
node_modules/telnet-stream/LICENSE
generated
vendored
Normal file
@@ -0,0 +1,661 @@
|
||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
our General Public Licenses are intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU Affero General Public License from time to time. Such new versions
|
||||
will be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU Affero General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU Affero General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU Affero General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Affero General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If your software can interact with users remotely through a computer
|
||||
network, you should also make sure that it provides a way for users to
|
||||
get its source. For example, if your program is a web application, its
|
||||
interface could display a "Source" link that leads users to an archive
|
||||
of the code. There are many ways you could offer source, and different
|
||||
solutions will be better for different programs; see section 13 for the
|
||||
specific requirements.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
571
node_modules/telnet-stream/README.md
generated
vendored
Normal file
571
node_modules/telnet-stream/README.md
generated
vendored
Normal file
@@ -0,0 +1,571 @@
|
||||
# telnet-stream
|
||||
Transform streams that emit TELNET negotiations as events
|
||||
|
||||
## Motivation
|
||||
Although venerable, the [TELNET](https://en.wikipedia.org/wiki/Telnet)
|
||||
protocol is still in use by some services and expected by some clients.
|
||||
If you need to connect to something that "speaks TELNET", this module
|
||||
offers some simple objects for that purpose.
|
||||
|
||||
## Example 0: A Simple Solution
|
||||
If you need to connect to something that speaks TELNET, but you don't
|
||||
care about options or negotiations, then simply use TelnetSocket to
|
||||
decorate a regular socket. It will filter out all the "TELNET stuff"
|
||||
and pass the remaining data on to you.
|
||||
|
||||
// get references to the required stuff
|
||||
var TelnetSocket, net, socket, tSocket;
|
||||
|
||||
net = require("net");
|
||||
|
||||
({TelnetSocket} = require("telnet-stream"));
|
||||
|
||||
// create a Socket connection
|
||||
socket = net.createConnection(3000, "godwars2.org");
|
||||
|
||||
// decorate the Socket connection as a TelnetSocket
|
||||
tSocket = new TelnetSocket(socket);
|
||||
|
||||
// if the socket closes, terminate the program
|
||||
tSocket.on("close", function() {
|
||||
return process.exit();
|
||||
});
|
||||
|
||||
// if we get any data, display it to stdout
|
||||
tSocket.on("data", function(buffer) {
|
||||
return process.stdout.write(buffer.toString("utf8"));
|
||||
});
|
||||
|
||||
// if the user types anything, send it to the socket
|
||||
process.stdin.on("data", function(buffer) {
|
||||
return tSocket.write(buffer.toString("utf8"));
|
||||
});
|
||||
|
||||
## Usage
|
||||
Maybe you have more complex needs. Perhaps you need certain options
|
||||
to be turned on or off, or have important information to pull from
|
||||
a subnegotiation. This is pretty easy to do with TelnetSocket.
|
||||
|
||||
### TelnetSocket input
|
||||
TelnetSocket is a decorator for a [net.Socket](https://nodejs.org/api/net.html)
|
||||
object. Incoming TELNET commands, options, and negotiations are emitted as
|
||||
events. Non-TELNET data is passed through without changes.
|
||||
|
||||
#### Event: 'command'
|
||||
When the remote system issues a TELNET command that is not option
|
||||
negotiation, TelnetSocket will emit a 'command' event.
|
||||
|
||||
var tSocket = new TelnetSocket(socket);
|
||||
tSocket.on('command', function(command) {
|
||||
// Received: IAC <command> - See RFC 854
|
||||
});
|
||||
|
||||
#### Event: 'do'
|
||||
When the remote system wants to request that the local system
|
||||
perform some function or obey some protocol, TelnetSocket will
|
||||
emit a 'do' event:
|
||||
|
||||
var tSocket = new TelnetSocket(socket);
|
||||
tSocket.on('do', function(option) {
|
||||
// Received: IAC DO <option> - See RFC 854
|
||||
});
|
||||
|
||||
#### Event: 'dont'
|
||||
When the remote system wants to request that the local system
|
||||
NOT perform some function or NOT obey some protocol, TelnetSocket
|
||||
will emit a 'dont' event:
|
||||
|
||||
var tSocket = new TelnetSocket(socket);
|
||||
tSocket.on('dont', function(option) {
|
||||
// Received: IAC DONT <option> - See RFC 854
|
||||
});
|
||||
|
||||
#### Event: 'sub'
|
||||
After negotiating an option, either the local or remote system
|
||||
may engage in a more complex subnegotiation. For example, the
|
||||
server and client may agree to use encryption, and then use
|
||||
subnegotiation to agree on the parameters of that encryption.
|
||||
|
||||
var tSocket = new TelnetSocket(socket);
|
||||
tSocket.on('sub', function(option, buffer) {
|
||||
// Received: IAC SB <option> <buffer> IAC SE - See RFC 855
|
||||
});
|
||||
|
||||
#### Event: 'will'
|
||||
When the remote system wants to offer that it will perform some
|
||||
function or obey some protocol for the local system, TelnetSocket
|
||||
will emit a 'will' event:
|
||||
|
||||
var tSocket = new TelnetSocket(socket);
|
||||
tSocket.on('will', function(option) {
|
||||
// Received: IAC WILL <option> - See RFC 854
|
||||
});
|
||||
|
||||
#### Event: 'wont'
|
||||
When the remote system wants to refuse to perform some function
|
||||
or obey some protocol for the local system, TelnetSocket will
|
||||
emit a 'wont' event:
|
||||
|
||||
var tSocket = new TelnetSocket(socket);
|
||||
tSocket.on('wont', function(option) {
|
||||
// Received: IAC WONT <option> - See RFC 854
|
||||
});
|
||||
|
||||
### TelnetSocket output
|
||||
TelnetSocket is a decorator for a [net.Socket](https://nodejs.org/api/net.html)
|
||||
object. Outgoing data is properly escaped where it might be confused
|
||||
for a TELNET command. There are also support functions to allow sending
|
||||
TELNET commands, options, and negotiations as well.
|
||||
|
||||
#### IAC escape
|
||||
TELNET commands start with the Interpret as Command (IAC) byte.
|
||||
In order to send a literal IAC byte (one that is intended as data,
|
||||
not as a TELNET command), it must be sent as IAC IAC. TelnetSocket
|
||||
takes care of this transformation automatically.
|
||||
|
||||
#### writeCommand(command)
|
||||
* command - The command byte to send
|
||||
|
||||
Call this method to send a TELNET command to the remote system.
|
||||
|
||||
var NOP = 241; // No operation. -- See RFC 854
|
||||
var tSocket = new TelnetSocket(socket);
|
||||
// Sends: IAC NOP
|
||||
tSocket.writeCommand(NOP);
|
||||
|
||||
#### writeDo(option)
|
||||
* option - The option byte to request of the remote system
|
||||
|
||||
Call this method to send a TELNET DO option negotiation to the remote
|
||||
system. A DO request is sent when the local system wants the remote
|
||||
system to perform some function or obey some protocol.
|
||||
|
||||
var NAWS = 31; // Negotiate About Window Size -- See RFC 1073
|
||||
var tSocket = new TelnetSocket(socket);
|
||||
// Sends: IAC DO NAWS
|
||||
tSocket.writeDo(NAWS);
|
||||
|
||||
#### writeDont(option)
|
||||
* option - The option byte to request of the remote system
|
||||
|
||||
Call this method to send a TELNET DONT option negotiation to the remote
|
||||
system. A DONT request is sent when the local system wants the remote
|
||||
system to NOT perform some function or NOT obey some protocol.
|
||||
|
||||
var NAWS = 31; // Negotiate About Window Size -- See RFC 1073
|
||||
var tSocket = new TelnetSocket(socket);
|
||||
// Sends: IAC DONT NAWS
|
||||
tSocket.writeDont(NAWS);
|
||||
|
||||
#### writeSub(option, buffer)
|
||||
* option - The option byte; identifies what the subnegotiation is about
|
||||
* buffer - The buffer containing the subnegotiation data to send
|
||||
|
||||
Call this method to send a TELNET subnegotiation to the remote system.
|
||||
After the local and remote system have negotiated and agreed to use
|
||||
an option, then subnegotiation information can be sent.
|
||||
|
||||
See Example #2: Negotiate About Window Size (NAWS) below.
|
||||
|
||||
#### writeWill(option)
|
||||
* option - The option byte to offer to the remote system
|
||||
|
||||
Call this method to send a TELNET WILL option negotiation to the remote
|
||||
system. A WILL offer is sent when the local system wants to inform the
|
||||
remote system that it will perform some function or obey some protocol.
|
||||
|
||||
var NAWS = 31; // Negotiate About Window Size -- See RFC 1073
|
||||
var tSocket = new TelnetSocket(socket);
|
||||
// Sends: IAC WILL NAWS
|
||||
tSocket.writeWill(NAWS);
|
||||
|
||||
#### writeWont(option)
|
||||
* option - The option byte to refuse to the remote system
|
||||
|
||||
Call this method to send a TELNET WONT option negotiation to the remote
|
||||
system. A WONT refusal is sent when the remote system has requested that
|
||||
the local system perform some function or obey some protocol, and the
|
||||
local system is refusing to do so.
|
||||
|
||||
var NAWS = 31; // Negotiate About Window Size -- See RFC 1073
|
||||
var tSocket = new TelnetSocket(socket);
|
||||
// Sends: IAC WONT NAWS
|
||||
tSocket.writeWont(NAWS);
|
||||
|
||||
### Example 1: Options Actively Refused
|
||||
The simple example above provided a simple TELNET client.
|
||||
However, all TELNET commands were filtered and ignored.
|
||||
A service might think one was using a very dumb client,
|
||||
because it refuses to acknowledge TELNET negotiations.
|
||||
|
||||
This example does the same thing, but actively refuses
|
||||
all TELNET options. If the remote service offers something,
|
||||
we decline to take advantage of it. If the remote service
|
||||
requests that we do something, we refuse to do it.
|
||||
|
||||
// get references to the required stuff
|
||||
var TelnetSocket, net, socket, tSocket;
|
||||
|
||||
net = require("net");
|
||||
|
||||
({TelnetSocket} = require("telnet-stream"));
|
||||
|
||||
// create a Socket connection
|
||||
socket = net.createConnection(3000, "godwars2.org");
|
||||
|
||||
// decorate the Socket connection as a TelnetSocket
|
||||
tSocket = new TelnetSocket(socket);
|
||||
|
||||
// if the socket closes, terminate the program
|
||||
tSocket.on("close", function() {
|
||||
return process.exit();
|
||||
});
|
||||
|
||||
// if we get any data, display it to stdout
|
||||
tSocket.on("data", function(buffer) {
|
||||
return process.stdout.write(buffer.toString("utf8"));
|
||||
});
|
||||
|
||||
// tell remote we WONT do anything we're asked to DO
|
||||
tSocket.on("do", function(option) {
|
||||
return tSocket.writeWont(option);
|
||||
});
|
||||
|
||||
// tell the remote DONT do whatever they WILL offer
|
||||
tSocket.on("will", function(option) {
|
||||
return tSocket.writeDont(option);
|
||||
});
|
||||
|
||||
// if the user types anything, send it to the socket
|
||||
process.stdin.on("data", function(buffer) {
|
||||
return tSocket.write(buffer.toString("utf8"));
|
||||
});
|
||||
|
||||
This code is mostly the same as Example 0 except that we respond
|
||||
to incoming 'do' and 'will' events sent by the remote side.
|
||||
|
||||
Note that incoming 'dont' and 'wont' events are ignored.
|
||||
This is OK because they are the expected state. TELNET
|
||||
negotiations involve changes to the current state. As a
|
||||
rule, we don't acknowledge things that we already expect.
|
||||
|
||||
### Example 2: Negotiate About Window Size (NAWS)
|
||||
There is a TELNET option called "Negotiate About Window Size" (NAWS)
|
||||
that allows the server to learn the dimensions of the client's output
|
||||
window. This is useful is some cases, as the server can wrap text
|
||||
output at an appropriate boundary, implement a text windowing system,
|
||||
or other things that depend on client metrics.
|
||||
|
||||
#### Server Side
|
||||
This code implements a simple TELNET server that listens for
|
||||
NAWS subnegotiations and reports the client's window size
|
||||
to the console.
|
||||
|
||||
// some variables that we'll use
|
||||
var NAWS, TelnetSocket, net, server;
|
||||
|
||||
// Negotiate About Window Size -- See RFC 1073
|
||||
NAWS = 31;
|
||||
|
||||
// get references to the required stuff
|
||||
net = require("net");
|
||||
|
||||
({TelnetSocket} = require("telnet-stream"));
|
||||
|
||||
// create a service to listen for incoming connections
|
||||
server = net.createServer(function(socket) {
|
||||
var tSocket;
|
||||
// wrap the socket as a TelnetSocket
|
||||
tSocket = new TelnetSocket(socket);
|
||||
// if we get any data, display it to the console
|
||||
tSocket.on("data", function(buffer) {
|
||||
return process.stdout.write(buffer.toString("utf8"));
|
||||
});
|
||||
// if they send us a subnegotiation
|
||||
tSocket.on("sub", function(option, buffer) {
|
||||
var height, width;
|
||||
// if they are telling us their window size
|
||||
if (option === NAWS) {
|
||||
// display it to the console
|
||||
width = buffer.readInt16BE(0);
|
||||
height = buffer.readInt16BE(2);
|
||||
return process.stdout.write(`Client window: ${width}x${height}\n`);
|
||||
}
|
||||
});
|
||||
// tell the client to send window size subnegotiations
|
||||
return tSocket.writeDo(NAWS);
|
||||
});
|
||||
|
||||
// start our server listening on port 3000
|
||||
server.listen(3000);
|
||||
|
||||
#### Client Side
|
||||
This code implements a simple TELNET client that sends NAWS
|
||||
subnegotiations when the output window is resized. Note that
|
||||
it only sends NAWS subnegotiations after it has confirmed
|
||||
that the server supports and wants to hear about them.
|
||||
|
||||
// some variables that we'll use
|
||||
var NAWS, TelnetSocket, net, sendWindowSize, serverNawsOk, socket, tSocket;
|
||||
|
||||
// Negotiate About Window Size -- See RFC 1073
|
||||
NAWS = 31;
|
||||
|
||||
// get references to the required stuff
|
||||
net = require("net");
|
||||
|
||||
({TelnetSocket} = require("telnet-stream"));
|
||||
|
||||
// create a Socket connection
|
||||
socket = net.createConnection(3000);
|
||||
|
||||
// decorate the Socket connection as a TelnetSocket
|
||||
tSocket = new TelnetSocket(socket);
|
||||
|
||||
// flag to indicate if its OK to send window size subnegotiations to the server
|
||||
serverNawsOk = false;
|
||||
|
||||
// function: send window size to the server
|
||||
sendWindowSize = function() {
|
||||
var nawsBuffer;
|
||||
// create a buffer
|
||||
nawsBuffer = Buffer.alloc(4);
|
||||
// fill the buffer up with our window dimensions
|
||||
nawsBuffer.writeInt16BE(process.stdout.columns, 0);
|
||||
nawsBuffer.writeInt16BE(process.stdout.rows, 2);
|
||||
// send that buffer as a subnegotiation to the server
|
||||
return tSocket.writeSub(NAWS, nawsBuffer);
|
||||
};
|
||||
|
||||
// if the socket closes, terminate the program
|
||||
tSocket.on("close", function() {
|
||||
return process.exit();
|
||||
});
|
||||
|
||||
// if we get any data, display it to stdout
|
||||
tSocket.on("data", function(buffer) {
|
||||
return process.stdout.write(buffer.toString("utf8"));
|
||||
});
|
||||
|
||||
// if the server sends us a DO negotiation
|
||||
tSocket.on("do", function(option) {
|
||||
// if that negotiation is about window size
|
||||
if (option === NAWS) {
|
||||
// set the flag indicating that the server has
|
||||
// told us it's OK to send our window size
|
||||
serverNawsOk = true;
|
||||
// tell the server that we WILL send window size
|
||||
tSocket.writeWill(NAWS);
|
||||
// send our current window size to the server
|
||||
return sendWindowSize();
|
||||
}
|
||||
});
|
||||
|
||||
// if the user types anything, send it to the socket
|
||||
process.stdin.on("data", function(buffer) {
|
||||
return tSocket.write(buffer.toString("utf8"));
|
||||
});
|
||||
|
||||
// if the terminal window is resized
|
||||
process.stdout.on("resize", function() {
|
||||
// if we're OK to send our window size to the server
|
||||
if (serverNawsOk) {
|
||||
// send the new window size to the server
|
||||
return sendWindowSize();
|
||||
}
|
||||
});
|
||||
|
||||
Run this program and it should immediately send the current
|
||||
size of the terminal window to the server. After that, you
|
||||
can resize your terminal window in order to make the client
|
||||
program to send the new window size to the server.
|
||||
|
||||
## Advanced Use Cases
|
||||
This section covers advanced use-cases. If you need to use the
|
||||
TELNET protocol outside of a Socket context, or if you need to
|
||||
modify some aspects of the protocol handling, this is the
|
||||
section for you.
|
||||
|
||||
### TelnetSocket options
|
||||
The TelnetSocket constructor takes an optional `options` parameter:
|
||||
|
||||
`new TelnetSocket(socket, [options])`
|
||||
* `socket` - Required: net.Socket to be decorated as a TELNET socket
|
||||
* `options` - Optional: Options configuration
|
||||
* `bufferSize` - The size of the subnegotiation buffer
|
||||
* `errorPolicy` - How to handle subnegotiation command errors
|
||||
|
||||
#### bufferSize
|
||||
After a TELNET option is negotiated between local and remote,
|
||||
either side may send subnegotiation data to the other. The
|
||||
TELNET protocol itself specifies no limit to this data.
|
||||
|
||||
Practical considerations dictate placing a reasonable limit
|
||||
on the amount of data buffered. Most services should NOT buffer
|
||||
an unlimited amount of data. Malicious clients may be able to
|
||||
cause a Denial of Service attack by forcing the server to
|
||||
allocate too much memory in response their requests.
|
||||
|
||||
By default, TelnetSocket will buffer to up 8192 (8K = 8 * 1024)
|
||||
bytes of subnegotiation data. After this, it will emit an `error`
|
||||
event to indicate an overflow in the subnegotiation buffer. These
|
||||
additional bytes will be discarded.
|
||||
|
||||
In order to modify the size of the buffer, one can specify an
|
||||
options object with the `bufferSize` option:
|
||||
|
||||
// this TelnetSocket can handle 16K subnegotiations!
|
||||
var tSocket = new TelnetSocket(socket, { bufferSize: 16384 });
|
||||
|
||||
The default of 8K should be sufficient for most use-cases.
|
||||
|
||||
#### errorPolicy
|
||||
During a subnegotiation, there are two valid sequences that begin with
|
||||
IAC. One is to escape another IAC intended as a literal data byte:
|
||||
|
||||
IAC IAC // this is a literal IAC [Hex 0xFF, Dec 255] byte
|
||||
|
||||
The other is to end the ongoing subnegotiation:
|
||||
|
||||
IAC SE // this signals the end of the subnegotiation
|
||||
|
||||
No other sequence is specified in the RFC. No mention is made of
|
||||
the state of the protocol after receiving an unknown sequence.
|
||||
|
||||
If an unknown sequence is detected; IAC followed by something
|
||||
that isn't IAC or SE, then an `error` event will be emitted.
|
||||
The `errorPolicy` option can set a policy for what will happen
|
||||
to the two erroneous bytes.
|
||||
|
||||
##### "keepBoth"
|
||||
By default, it is assumed that a faulty sequence starting with
|
||||
IAC is a failure to properly escape a data IAC byte as IAC IAC.
|
||||
TelnetSocket will keep both bytes (the IAC and the following
|
||||
data byte) and continue the subnegotiation.
|
||||
|
||||
##### "keepData"
|
||||
If you want TelnetSocket to keep the data byte (the byte
|
||||
following the IAC), but discard the IAC, the error policy
|
||||
`keepData` will do this. The data byte will be added to the
|
||||
subnegotiation and the subnegotiation will continue.
|
||||
|
||||
// filter out erroneous IAC bytes
|
||||
var tSocket = new TelnetSocket(socket, { errorPolicy: "keepData" });
|
||||
|
||||
##### "discardBoth"
|
||||
If you want TelnetSocket to discard both the IAC and the
|
||||
data byte that follows it, the error policy "discardBoth"
|
||||
will do this. The subnegotiation will continue, containing
|
||||
neither of the two erroneous bytes.
|
||||
|
||||
// filter out erroneous IAC <data> bytes
|
||||
var tSocket = new TelnetSocket(socket, { errorPolicy: "discardBoth" });
|
||||
|
||||
### Network Virtual Terminal (NVT)
|
||||
In addition to TELNET negotiation, RFC 854 specifies a Network Virtual
|
||||
Terminal (NVT). Among other things in the NVT specification,
|
||||
a Carriage Return (CR) [Hex 0x0C, Dec 13] byte must be followed by
|
||||
either a Line Feed (LF) [Hex 0x0A, Dec 10] byte or a Null (NUL) [Hex 0x00,
|
||||
Dec 0] byte. It says "the CR character must be avoided in other contexts".
|
||||
|
||||
Furthermore, it goes on to specify: "Even though it may be known in some
|
||||
situations that characters are not being sent to an actual printer,
|
||||
nonetheless, for the sake of consistency, the protocol requires that a NUL
|
||||
be inserted following a CR not followed by a LF in the data stream."
|
||||
|
||||
telnet-stream DOES NOT respect this part of the specification. The
|
||||
character following a CR in the data stream is never modified in any
|
||||
way. If you want or need this behavior, please open an issue on GitHub.
|
||||
The author would be very curious to discover a use-case where this
|
||||
behavior is both expected and necessary.
|
||||
|
||||
### TelnetInput and TelnetOutput
|
||||
TelnetSocket is built on lower level Transform streams. These
|
||||
transform streams do the real work of managing the TELNET protocol,
|
||||
where TelnetSocket is simply a convenience wrapper over a Socket.
|
||||
|
||||
If you need TELNET handling outside of a Socket context; for example
|
||||
filtering TELNET codes from a raw log, you may be interested in these
|
||||
transform stream components.
|
||||
|
||||
Because TelnetInput and TelnetOutput are Node.js Transform streams,
|
||||
they support all the same operations that regular streams do. See the
|
||||
[Node.js Stream API](http://nodejs.org/api/stream.html) for more details.
|
||||
|
||||
#### TelnetInput
|
||||
TelnetInput is a Transform stream for the input side of TELNET.
|
||||
TELNET commands, options, and negotiations are emitted as events.
|
||||
Non-TELNET data is passed transparently as input data.
|
||||
|
||||
See: Event handlers ('command', 'do', 'dont', 'sub', 'will', 'wont')
|
||||
|
||||
Like TelnetSocket, the TelnetInput constructor takes an optional
|
||||
`options` object supporting options `bufferSize` and `errorPolicy`.
|
||||
|
||||
`new TelnetInput([options])`
|
||||
* `options` - Optional: Options configuration
|
||||
* `bufferSize` - The size of the subnegotiation buffer
|
||||
* `errorPolicy` - How to handle subnegotiation command errors
|
||||
|
||||
#### TelnetOutput
|
||||
TelnetOutput is a Transform stream for the output side of TELNET.
|
||||
Data written to TelnetOutput is properly escaped to ensure that it
|
||||
isn't interpreted as a TELNET command. It also has methods for sending
|
||||
TELNET option negotiations and subnegotiations.
|
||||
|
||||
See: Helper functions (`writeCommand`, `writeDo`, `writeDont`,
|
||||
`writeSub`, `writeWill`, `writeWont`)
|
||||
|
||||
#### Example 0 rewritten with transform streams
|
||||
This code is equivalent to Example 0, but instead of using TelnetSocket
|
||||
to decorate the provided Socket, the readable and writable sides
|
||||
are handled individually by Transform stream objects.
|
||||
|
||||
var net = require('net');
|
||||
var TelnetInput = require('telnet-stream').TelnetInput;
|
||||
var TelnetOutput = require('telnet-stream').TelnetOutput;
|
||||
|
||||
var socket = net.createConnection(3000, 'godwars2.org', function() {
|
||||
var telnetInput = new TelnetInput();
|
||||
var telnetOutput = new TelnetOutput();
|
||||
|
||||
socket.pipe(telnetInput).pipe(process.stdout);
|
||||
process.stdin.pipe(telnetOutput).pipe(socket);
|
||||
});
|
||||
|
||||
## Development
|
||||
In order to make modifications to telnet-stream, you'll need to
|
||||
establish a development environment:
|
||||
|
||||
git clone https://github.com/blinkdog/telnet-stream.git
|
||||
cd telnet-stream
|
||||
npm install
|
||||
node_modules/.bin/cake rebuild
|
||||
|
||||
The source files are located in `src/main/coffee`.
|
||||
The test source files are located in `src/test/coffee`.
|
||||
|
||||
You can see a coverage report by invoking the `coverage` target:
|
||||
|
||||
node_modules/.bin/cake coverage
|
||||
|
||||
## Acknowledgments
|
||||
* TypeScript defintions were kindly provided by contributor
|
||||
[Voakie](https://github.com/Voakie)
|
||||
|
||||
## License
|
||||
telnet-stream
|
||||
Copyright 2013-2021 Patrick Meade.
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Affero General Public License as
|
||||
published by the Free Software Foundation, either version 3 of the
|
||||
License, or (at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
1
node_modules/telnet-stream/index.js
generated
vendored
Normal file
1
node_modules/telnet-stream/index.js
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
module.exports = require("./lib/telnetStream");
|
||||
178
node_modules/telnet-stream/lib/telnetInput.js
generated
vendored
Normal file
178
node_modules/telnet-stream/lib/telnetInput.js
generated
vendored
Normal file
@@ -0,0 +1,178 @@
|
||||
// Generated by CoffeeScript 2.6.1
|
||||
(function() {
|
||||
// telnetInput.coffee
|
||||
// Copyright 2017 Patrick Meade.
|
||||
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU Affero General Public License as
|
||||
// published by the Free Software Foundation, either version 3 of the
|
||||
// License, or (at your option) any later version.
|
||||
|
||||
// This program is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU Affero General Public License for more details.
|
||||
|
||||
// You should have received a copy of the GNU Affero General Public License
|
||||
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
//----------------------------------------------------------------------------
|
||||
var DEFAULT_SUBNEGOTIATION_BUFFER_SIZE, DEFAULT_SUBNEGOTIATION_ERROR_POLICY, TELNET_COMMAND, TELNET_DATA, TELNET_DO, TELNET_DONT, TELNET_IAC, TELNET_OPTION, TELNET_SUBNEG, TELNET_SUBNEG_COMMAND, TELNET_SUB_BEGIN, TELNET_SUB_END, TELNET_WILL, TELNET_WONT, TelnetInput, Transform;
|
||||
|
||||
DEFAULT_SUBNEGOTIATION_BUFFER_SIZE = 8192;
|
||||
|
||||
DEFAULT_SUBNEGOTIATION_ERROR_POLICY = "keepBoth";
|
||||
|
||||
TELNET_COMMAND = "TELNET_COMMAND";
|
||||
|
||||
TELNET_DATA = "TELNET_DATA";
|
||||
|
||||
TELNET_OPTION = "TELNET_OPTION";
|
||||
|
||||
TELNET_SUBNEG = "TELNET_SUBNEG";
|
||||
|
||||
TELNET_SUBNEG_COMMAND = "TELNET_SUBNEG_COMMAND";
|
||||
|
||||
TELNET_DO = 253;
|
||||
|
||||
TELNET_DONT = 254;
|
||||
|
||||
TELNET_IAC = 255;
|
||||
|
||||
TELNET_SUB_BEGIN = 250;
|
||||
|
||||
TELNET_SUB_END = 240;
|
||||
|
||||
TELNET_WILL = 251;
|
||||
|
||||
TELNET_WONT = 252;
|
||||
|
||||
({Transform} = require("stream"));
|
||||
|
||||
TelnetInput = class TelnetInput extends Transform {
|
||||
constructor(opt) {
|
||||
var options;
|
||||
options = opt || {};
|
||||
super(options);
|
||||
this.state = TELNET_DATA;
|
||||
this.subBufSize = options.bufferSize || DEFAULT_SUBNEGOTIATION_BUFFER_SIZE;
|
||||
this.subBuf = Buffer.alloc(this.subBufSize);
|
||||
this.errorPolicy = options.errorPolicy || DEFAULT_SUBNEGOTIATION_ERROR_POLICY;
|
||||
}
|
||||
|
||||
_transform(chunk, encoding, callback) {
|
||||
var byte, i, len;
|
||||
this.dataBuf = Buffer.alloc(chunk.length * 2);
|
||||
this.dataBufIndex = 0;
|
||||
for (i = 0, len = chunk.length; i < len; i++) {
|
||||
byte = chunk[i];
|
||||
this._handle(byte);
|
||||
}
|
||||
if (this.dataBufIndex > 0) {
|
||||
this.push(this.dataBuf.slice(0, this.dataBufIndex));
|
||||
}
|
||||
return callback();
|
||||
}
|
||||
|
||||
_handle(chunkData) {
|
||||
switch (this.state) {
|
||||
case TELNET_DATA:
|
||||
switch (chunkData) {
|
||||
case TELNET_IAC:
|
||||
return this.state = TELNET_COMMAND;
|
||||
default:
|
||||
this.dataBuf[this.dataBufIndex] = chunkData;
|
||||
return this.dataBufIndex++;
|
||||
}
|
||||
break;
|
||||
case TELNET_COMMAND:
|
||||
switch (chunkData) {
|
||||
case TELNET_IAC:
|
||||
this.state = TELNET_DATA;
|
||||
this.dataBuf[this.dataBufIndex] = TELNET_IAC;
|
||||
return this.dataBufIndex++;
|
||||
case TELNET_DO:
|
||||
case TELNET_DONT:
|
||||
case TELNET_WILL:
|
||||
case TELNET_WONT:
|
||||
case TELNET_SUB_BEGIN:
|
||||
this.state = TELNET_OPTION;
|
||||
return this.command = chunkData;
|
||||
default:
|
||||
this.state = TELNET_DATA;
|
||||
return this.emit("command", chunkData);
|
||||
}
|
||||
break;
|
||||
case TELNET_OPTION:
|
||||
switch (this.command) {
|
||||
case TELNET_DO:
|
||||
this.state = TELNET_DATA;
|
||||
return this.emit("do", chunkData);
|
||||
case TELNET_DONT:
|
||||
this.state = TELNET_DATA;
|
||||
return this.emit("dont", chunkData);
|
||||
case TELNET_WILL:
|
||||
this.state = TELNET_DATA;
|
||||
return this.emit("will", chunkData);
|
||||
case TELNET_WONT:
|
||||
this.state = TELNET_DATA;
|
||||
return this.emit("wont", chunkData);
|
||||
case TELNET_SUB_BEGIN:
|
||||
this.state = TELNET_SUBNEG;
|
||||
this.option = chunkData;
|
||||
this.subBufIndex = 0;
|
||||
return this.subOverflowEmit = false;
|
||||
}
|
||||
break;
|
||||
case TELNET_SUBNEG:
|
||||
switch (chunkData) {
|
||||
case TELNET_IAC:
|
||||
return this.state = TELNET_SUBNEG_COMMAND;
|
||||
default:
|
||||
return this._handleSub(chunkData);
|
||||
}
|
||||
break;
|
||||
case TELNET_SUBNEG_COMMAND:
|
||||
switch (chunkData) {
|
||||
case TELNET_IAC:
|
||||
this.state = TELNET_SUBNEG;
|
||||
return this._handleSub(TELNET_IAC);
|
||||
case TELNET_SUB_END:
|
||||
this.state = TELNET_DATA;
|
||||
return this.emit("sub", this.option, this.subBuf.slice(0, this.subBufIndex));
|
||||
default:
|
||||
this.state = TELNET_SUBNEG;
|
||||
this.emit("error", new Error("expected IAC or SE"));
|
||||
switch (this.errorPolicy) {
|
||||
case "discardBoth":
|
||||
break;
|
||||
case "keepData":
|
||||
return this._handleSub(chunkData);
|
||||
default:
|
||||
// "keepBoth"
|
||||
this._handleSub(TELNET_IAC);
|
||||
return this._handleSub(chunkData);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
_handleSub(subByte) {
|
||||
if (this.subBufIndex >= this.subBufSize) {
|
||||
if (!this.subOverflowEmit) {
|
||||
this.subOverflowEmit = true;
|
||||
this.emit("error", new Error("subnegotiation buffer overflow"));
|
||||
}
|
||||
return;
|
||||
}
|
||||
this.subBuf[this.subBufIndex] = subByte;
|
||||
return this.subBufIndex++;
|
||||
}
|
||||
|
||||
};
|
||||
|
||||
exports.TelnetInput = TelnetInput;
|
||||
|
||||
//----------------------------------------------------------------------------
|
||||
// end of telnetInput.coffee
|
||||
|
||||
}).call(this);
|
||||
117
node_modules/telnet-stream/lib/telnetOutput.js
generated
vendored
Normal file
117
node_modules/telnet-stream/lib/telnetOutput.js
generated
vendored
Normal file
@@ -0,0 +1,117 @@
|
||||
// Generated by CoffeeScript 2.6.1
|
||||
(function() {
|
||||
// telnetOutput.coffee
|
||||
// Copyright 2017 Patrick Meade.
|
||||
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU Affero General Public License as
|
||||
// published by the Free Software Foundation, either version 3 of the
|
||||
// License, or (at your option) any later version.
|
||||
|
||||
// This program is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU Affero General Public License for more details.
|
||||
|
||||
// You should have received a copy of the GNU Affero General Public License
|
||||
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
//----------------------------------------------------------------------------
|
||||
var TELNET_DO, TELNET_DONT, TELNET_IAC, TELNET_SUB_BEGIN, TELNET_SUB_END, TELNET_WILL, TELNET_WONT, TelnetOutput, Transform;
|
||||
|
||||
TELNET_DO = 253;
|
||||
|
||||
TELNET_DONT = 254;
|
||||
|
||||
TELNET_IAC = 255;
|
||||
|
||||
TELNET_SUB_BEGIN = 250;
|
||||
|
||||
TELNET_SUB_END = 240;
|
||||
|
||||
TELNET_WILL = 251;
|
||||
|
||||
TELNET_WONT = 252;
|
||||
|
||||
({Transform} = require("stream"));
|
||||
|
||||
TelnetOutput = class TelnetOutput extends Transform {
|
||||
constructor(options) {
|
||||
super(options);
|
||||
}
|
||||
|
||||
_transform(chunk, encoding, done) {
|
||||
this.push(this._duplicateIAC(chunk));
|
||||
return done();
|
||||
}
|
||||
|
||||
_duplicateIAC(buffer) {
|
||||
var byte, i, len, xlateBuf, xlateIndex;
|
||||
xlateIndex = 0;
|
||||
xlateBuf = Buffer.alloc(buffer.length * 2);
|
||||
for (i = 0, len = buffer.length; i < len; i++) {
|
||||
byte = buffer[i];
|
||||
xlateBuf[xlateIndex] = byte;
|
||||
xlateIndex++;
|
||||
if (byte === TELNET_IAC) {
|
||||
xlateBuf[xlateIndex] = byte;
|
||||
xlateIndex++;
|
||||
}
|
||||
}
|
||||
return xlateBuf.slice(0, xlateIndex);
|
||||
}
|
||||
|
||||
_writeOption(command, option) {
|
||||
var cmdBuf;
|
||||
cmdBuf = Buffer.alloc(3);
|
||||
cmdBuf[0] = TELNET_IAC;
|
||||
cmdBuf[1] = command;
|
||||
cmdBuf[2] = option;
|
||||
return this.push(cmdBuf);
|
||||
}
|
||||
|
||||
writeCommand(command) {
|
||||
var cmdBuf;
|
||||
cmdBuf = Buffer.alloc(2);
|
||||
cmdBuf[0] = TELNET_IAC;
|
||||
cmdBuf[1] = command;
|
||||
return this.push(cmdBuf);
|
||||
}
|
||||
|
||||
writeDo(option) {
|
||||
return this._writeOption(TELNET_DO, option);
|
||||
}
|
||||
|
||||
writeDont(option) {
|
||||
return this._writeOption(TELNET_DONT, option);
|
||||
}
|
||||
|
||||
writeSub(option, buffer) {
|
||||
var negBuf, subBegin, subBuf, subEnd;
|
||||
negBuf = this._duplicateIAC(buffer);
|
||||
subBegin = Buffer.alloc(3);
|
||||
subBegin[0] = TELNET_IAC;
|
||||
subBegin[1] = TELNET_SUB_BEGIN;
|
||||
subBegin[2] = option;
|
||||
subEnd = Buffer.alloc(2);
|
||||
subEnd[0] = TELNET_IAC;
|
||||
subEnd[1] = TELNET_SUB_END;
|
||||
subBuf = Buffer.concat([subBegin, negBuf, subEnd], negBuf.length + 5);
|
||||
return this.push(subBuf);
|
||||
}
|
||||
|
||||
writeWill(option) {
|
||||
return this._writeOption(TELNET_WILL, option);
|
||||
}
|
||||
|
||||
writeWont(option) {
|
||||
return this._writeOption(TELNET_WONT, option);
|
||||
}
|
||||
|
||||
};
|
||||
|
||||
exports.TelnetOutput = TelnetOutput;
|
||||
|
||||
//----------------------------------------------------------------------------
|
||||
// end of telnetOutput.coffee
|
||||
|
||||
}).call(this);
|
||||
137
node_modules/telnet-stream/lib/telnetSocket.js
generated
vendored
Normal file
137
node_modules/telnet-stream/lib/telnetSocket.js
generated
vendored
Normal file
@@ -0,0 +1,137 @@
|
||||
// Generated by CoffeeScript 2.6.1
|
||||
(function() {
|
||||
// telnetSocket.coffee
|
||||
// Copyright 2017 Patrick Meade.
|
||||
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU Affero General Public License as
|
||||
// published by the Free Software Foundation, either version 3 of the
|
||||
// License, or (at your option) any later version.
|
||||
|
||||
// This program is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU Affero General Public License for more details.
|
||||
|
||||
// You should have received a copy of the GNU Affero General Public License
|
||||
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
//----------------------------------------------------------------------------
|
||||
var Socket, TelnetInput, TelnetOutput, TelnetSocket;
|
||||
|
||||
({Socket} = require("net"));
|
||||
|
||||
({TelnetInput, TelnetOutput} = require("./telnetStream"));
|
||||
|
||||
TelnetSocket = class TelnetSocket {
|
||||
constructor(_socket, opt) {
|
||||
var options;
|
||||
this._socket = _socket;
|
||||
if (!(this._socket instanceof Socket)) {
|
||||
throw new Error("required: net.Socket");
|
||||
}
|
||||
options = opt || {};
|
||||
this._in = new TelnetInput(options);
|
||||
this._out = new TelnetOutput(options);
|
||||
this._socket.pipe(this._in);
|
||||
this._out.pipe(this._socket);
|
||||
}
|
||||
|
||||
address() {
|
||||
return this._socket.address.apply(this._socket, arguments);
|
||||
}
|
||||
|
||||
connect() {
|
||||
return this._socket.connect.apply(this._socket, arguments);
|
||||
}
|
||||
|
||||
destroy() {
|
||||
return this._socket.destroy.apply(this._socket, arguments);
|
||||
}
|
||||
|
||||
end() {
|
||||
return this._socket.end.apply(this._socket, arguments);
|
||||
}
|
||||
|
||||
on(name, callback) {
|
||||
switch (name) {
|
||||
case "command":
|
||||
case "data":
|
||||
case "do":
|
||||
case "dont":
|
||||
case "sub":
|
||||
case "will":
|
||||
case "wont":
|
||||
return this._in.on(name, callback);
|
||||
default:
|
||||
return this._socket.on(name, callback);
|
||||
}
|
||||
}
|
||||
|
||||
pause() {
|
||||
return this._socket.pause.apply(this._socket, arguments);
|
||||
}
|
||||
|
||||
ref() {
|
||||
return this._socket.ref.apply(this._socket, arguments);
|
||||
}
|
||||
|
||||
resume() {
|
||||
return this._socket.resume.apply(this._socket, arguments);
|
||||
}
|
||||
|
||||
setEncoding() {
|
||||
return this._socket.setEncoding.apply(this._socket, arguments);
|
||||
}
|
||||
|
||||
setKeepAlive() {
|
||||
return this._socket.setKeepAlive.apply(this._socket, arguments);
|
||||
}
|
||||
|
||||
setNoDelay() {
|
||||
return this._socket.setNoDelay.apply(this._socket, arguments);
|
||||
}
|
||||
|
||||
setTimeout() {
|
||||
return this._socket.setTimeout.apply(this._socket, arguments);
|
||||
}
|
||||
|
||||
unref() {
|
||||
return this._socket.unref.apply(this._socket, arguments);
|
||||
}
|
||||
|
||||
write() {
|
||||
return this._out.write.apply(this._out, arguments);
|
||||
}
|
||||
|
||||
writeCommand(command) {
|
||||
return this._out.writeCommand(command);
|
||||
}
|
||||
|
||||
writeDo(option) {
|
||||
return this._out.writeDo(option);
|
||||
}
|
||||
|
||||
writeDont(option) {
|
||||
return this._out.writeDont(option);
|
||||
}
|
||||
|
||||
writeSub(option, buffer) {
|
||||
return this._out.writeSub(option, buffer);
|
||||
}
|
||||
|
||||
writeWill(option) {
|
||||
return this._out.writeWill(option);
|
||||
}
|
||||
|
||||
writeWont(option) {
|
||||
return this._out.writeWont(option);
|
||||
}
|
||||
|
||||
};
|
||||
|
||||
exports.TelnetSocket = TelnetSocket;
|
||||
|
||||
//----------------------------------------------------------------------------
|
||||
// end of telnetSocket.coffee
|
||||
|
||||
}).call(this);
|
||||
28
node_modules/telnet-stream/lib/telnetStream.js
generated
vendored
Normal file
28
node_modules/telnet-stream/lib/telnetStream.js
generated
vendored
Normal file
@@ -0,0 +1,28 @@
|
||||
// Generated by CoffeeScript 2.6.1
|
||||
(function() {
|
||||
// telnetStream.coffee
|
||||
// Copyright 2017 Patrick Meade.
|
||||
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU Affero General Public License as
|
||||
// published by the Free Software Foundation, either version 3 of the
|
||||
// License, or (at your option) any later version.
|
||||
|
||||
// This program is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU Affero General Public License for more details.
|
||||
|
||||
// You should have received a copy of the GNU Affero General Public License
|
||||
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
//----------------------------------------------------------------------------
|
||||
exports.TelnetInput = require("./telnetInput").TelnetInput;
|
||||
|
||||
exports.TelnetOutput = require("./telnetOutput").TelnetOutput;
|
||||
|
||||
exports.TelnetSocket = require("./telnetSocket").TelnetSocket;
|
||||
|
||||
//----------------------------------------------------------------------------
|
||||
// end of telnetStream.coffee
|
||||
|
||||
}).call(this);
|
||||
50
node_modules/telnet-stream/package.json
generated
vendored
Normal file
50
node_modules/telnet-stream/package.json
generated
vendored
Normal file
@@ -0,0 +1,50 @@
|
||||
{
|
||||
"name": "telnet-stream",
|
||||
"version": "1.1.0",
|
||||
"description": "TELNET protocol support library",
|
||||
"keywords": [
|
||||
"do",
|
||||
"dont",
|
||||
"event",
|
||||
"MUD",
|
||||
"MOO",
|
||||
"MUSH",
|
||||
"MUX",
|
||||
"subnegotiation",
|
||||
"protocol",
|
||||
"rfc854",
|
||||
"rfc855",
|
||||
"socket",
|
||||
"stream",
|
||||
"TELNET",
|
||||
"Transform",
|
||||
"will",
|
||||
"wont"
|
||||
],
|
||||
"homepage": "https://github.com/blinkdog/telnet-stream",
|
||||
"bugs": "https://github.com/blinkdog/telnet-stream/issues",
|
||||
"license": "AGPL-3.0",
|
||||
"author": "Patrick Meade <blinkdog@protonmail.com>",
|
||||
"files": [
|
||||
"CHANGELOG.md",
|
||||
"index.js",
|
||||
"lib",
|
||||
"LICENSE",
|
||||
"package.json",
|
||||
"README.md",
|
||||
"telnet-stream.d.ts"
|
||||
],
|
||||
"main": "index.js",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/blinkdog/telnet-stream.git"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "17.0.4",
|
||||
"coffeescript": "2.6.1",
|
||||
"mocha": "9.1.3",
|
||||
"nyc": "15.1.0",
|
||||
"should": "13.2.3"
|
||||
},
|
||||
"types": "./telnet-stream.d.ts"
|
||||
}
|
||||
334
node_modules/telnet-stream/telnet-stream.d.ts
generated
vendored
Normal file
334
node_modules/telnet-stream/telnet-stream.d.ts
generated
vendored
Normal file
@@ -0,0 +1,334 @@
|
||||
/**
|
||||
* Type definitions for telnet-stream 1.0.5
|
||||
* Author: Voakie <contact@voakie.com>
|
||||
*/
|
||||
|
||||
declare module "telnet-stream" {
|
||||
import { Socket, SocketConnectOpts, AddressInfo } from "net";
|
||||
import { Transform, TransformOptions } from "stream";
|
||||
|
||||
export interface TelnetSocketOptions {
|
||||
bufferSize?: number;
|
||||
errorPolicy?: "keepBoth" | "keepData" | "discardBoth";
|
||||
}
|
||||
|
||||
export interface TelnetInputOptions
|
||||
extends TransformOptions,
|
||||
TelnetSocketOptions {}
|
||||
|
||||
/**
|
||||
* TelnetSocket is a decorator for a net.Socket object. Incoming TELNET commands, options, and negotiations are emitted as events. Non-TELNET data is passed through without changes.
|
||||
*/
|
||||
export class TelnetSocket {
|
||||
constructor(socket: Socket, options?: TelnetSocketOptions);
|
||||
|
||||
/**
|
||||
* When the remote system issues a TELNET command that is not option
|
||||
* negotiation, TelnetSocket will emit a 'command' event.
|
||||
*
|
||||
* ```js
|
||||
* var tSocket = new TelnetSocket(socket);
|
||||
* tSocket.on('command', function(command) {
|
||||
* // Received: IAC <command> - See RFC 854
|
||||
* });
|
||||
* ```
|
||||
*/
|
||||
on(name: "command", callback: (command: number) => void): void;
|
||||
/**
|
||||
* When the remote system wants to request that the local system
|
||||
* perform some function or obey some protocol, TelnetSocket will
|
||||
* emit a 'do' event:
|
||||
*
|
||||
* ```js
|
||||
* var tSocket = new TelnetSocket(socket);
|
||||
* tSocket.on('do', function(option) {
|
||||
* // Received: IAC DO <option> - See RFC 854
|
||||
* });
|
||||
* ```
|
||||
*/
|
||||
on(name: "do", callback: (option: number) => void): void;
|
||||
/**
|
||||
* When the remote system wants to request that the local system
|
||||
* NOT perform some function or NOT obey some protocol, TelnetSocket
|
||||
* will emit a 'dont' event:
|
||||
*
|
||||
* ```js
|
||||
* var tSocket = new TelnetSocket(socket);
|
||||
* tSocket.on('dont', function(option) {
|
||||
* // Received: IAC DONT <option> - See RFC 854
|
||||
* });
|
||||
* ```
|
||||
*/
|
||||
on(name: "dont", callback: (option: number) => void): void;
|
||||
/**
|
||||
* After negotiating an option, either the local or remote system
|
||||
* may engage in a more complex subnegotiation. For example, the
|
||||
* server and client may agree to use encryption, and then use
|
||||
* subnegotiation to agree on the parameters of that encryption.
|
||||
*
|
||||
* ```js
|
||||
* var tSocket = new TelnetSocket(socket);
|
||||
* tSocket.on('sub', function(option, buffer) {
|
||||
* // Received: IAC SB <option> <buffer> IAC SE - See RFC 855
|
||||
* });
|
||||
* ```
|
||||
*/
|
||||
on(name: "sub", callback: (option: number, buffer: Buffer) => void): void;
|
||||
/**
|
||||
* When the remote system wants to offer that it will perform some
|
||||
* function or obey some protocol for the local system, TelnetSocket
|
||||
* will emit a 'will' event:
|
||||
*
|
||||
* ```js
|
||||
* var tSocket = new TelnetSocket(socket);
|
||||
* tSocket.on('will', function(option) {
|
||||
* // Received: IAC WILL <option> - See RFC 854
|
||||
* });
|
||||
* ```
|
||||
*/
|
||||
on(name: "will", callback: (option: number) => void): void;
|
||||
/**
|
||||
* When the remote system wants to refuse to perform some function
|
||||
* or obey some protocol for the local system, TelnetSocket will
|
||||
* emit a 'wont' event:
|
||||
*
|
||||
* ```js
|
||||
* var tSocket = new TelnetSocket(socket);
|
||||
* tSocket.on('wont', function(option) {
|
||||
* // Received: IAC WONT <option> - See RFC 854
|
||||
* });
|
||||
* ```
|
||||
*/
|
||||
on(name: "wont", callback: (option: number) => void): void;
|
||||
/**
|
||||
* Call this method to send a TELNET command to the remote system.
|
||||
*
|
||||
* ```js
|
||||
* var NOP = 241; // No operation. -- See RFC 854
|
||||
* var tSocket = new TelnetSocket(socket);
|
||||
* // Sends: IAC NOP
|
||||
* tSocket.writeCommand(NOP);
|
||||
* ```
|
||||
*
|
||||
* @param command The command byte to send
|
||||
*/
|
||||
writeCommand(command: number): void;
|
||||
/**
|
||||
* Call this method to send a TELNET DO option negotiation to the remote
|
||||
* system. A DO request is sent when the local system wants the remote
|
||||
* system to perform some function or obey some protocol.
|
||||
*
|
||||
* ```js
|
||||
* var NAWS = 31; // Negotiate About Window Size -- See RFC 1073
|
||||
* var tSocket = new TelnetSocket(socket);
|
||||
* // Sends: IAC DO NAWS
|
||||
* tSocket.writeDo(NAWS);
|
||||
* ```
|
||||
*
|
||||
* @param option The option byte to request of the remote system
|
||||
*/
|
||||
writeDo(option: number): void;
|
||||
/**
|
||||
* Call this method to send a TELNET DONT option negotiation to the remote
|
||||
* system. A DONT request is sent when the local system wants the remote
|
||||
* system to NOT perform some function or NOT obey some protocol.
|
||||
*
|
||||
* ```js
|
||||
* var NAWS = 31; // Negotiate About Window Size -- See RFC 1073
|
||||
* var tSocket = new TelnetSocket(socket);
|
||||
* // Sends: IAC DONT NAWS
|
||||
* tSocket.writeDont(NAWS);
|
||||
* ```
|
||||
*
|
||||
* @param option The option byte to request of the remote system
|
||||
*/
|
||||
writeDont(option: number): void;
|
||||
/**
|
||||
* Call this method to send a TELNET WILL option negotiation to the remote
|
||||
* system. A WILL offer is sent when the local system wants to inform the
|
||||
* remote system that it will perform some function or obey some protocol.
|
||||
*
|
||||
* ```js
|
||||
* var NAWS = 31; // Negotiate About Window Size -- See RFC 1073
|
||||
* var tSocket = new TelnetSocket(socket);
|
||||
* // Sends: IAC WILL NAWS
|
||||
* tSocket.writeWill(NAWS);
|
||||
* ```
|
||||
*
|
||||
* @param option The option byte to offer to the remote system
|
||||
*/
|
||||
writeWill(option: number): void;
|
||||
/**
|
||||
* Call this method to send a TELNET WONT option negotiation to the remote
|
||||
* system. A WONT refusal is sent when the remote system has requested that
|
||||
* the local system perform some function or obey some protocol, and the
|
||||
* local system is refusing to do so.
|
||||
*
|
||||
* ```js
|
||||
* var NAWS = 31; // Negotiate About Window Size -- See RFC 1073
|
||||
* var tSocket = new TelnetSocket(socket);
|
||||
* // Sends: IAC WONT NAWS
|
||||
* tSocket.writeWont(NAWS);
|
||||
* ```
|
||||
*
|
||||
* @param option The option byte to refuse to the remote system
|
||||
*/
|
||||
writeWont(option: number): void;
|
||||
/**
|
||||
* Call this method to send a TELNET subnegotiation to the remote system.
|
||||
* After the local and remote system have negotiated and agreed to use
|
||||
* an option, then subnegotiation information can be sent.
|
||||
*
|
||||
* See Example #2: Negotiate About Window Size (NAWS) in the README.
|
||||
*
|
||||
* @param option The option byte; identifies what the subnegotiation is about
|
||||
* @param buffer The buffer containing the subnegotiation data to send
|
||||
*/
|
||||
writeSub(option: number, buffer: any): void;
|
||||
|
||||
/** Inherited from `net` */
|
||||
on(name: "close", callback: (hadError: boolean) => void): void;
|
||||
/** Inherited from `net` */
|
||||
on(name: "connect", callback: () => void): void;
|
||||
/** Inherited from `net` */
|
||||
on(name: "data", callback: (data: Buffer | string) => void): void;
|
||||
/** Inherited from `net` */
|
||||
on(name: "drain", callback: () => void): void;
|
||||
/** Inherited from `net` */
|
||||
on(name: "end", callback: () => void): void;
|
||||
/** Inherited from `net` */
|
||||
on(name: "error", callback: (e: Error) => void): void;
|
||||
/** Inherited from `net` */
|
||||
on(name: "lookup", callback: () => void): void;
|
||||
/** Inherited from `net` */
|
||||
on(name: "timeout", callback: () => void): void;
|
||||
/** Inherited from `net` */
|
||||
address(): AddressInfo | string | null;
|
||||
/** Inherited from `net` */
|
||||
connect(opts: SocketConnectOpts, listener?: () => void): Socket;
|
||||
/** Inherited from `net` */
|
||||
connect(path: string, listener?: () => void): Socket;
|
||||
/** Inherited from `net` */
|
||||
connect(port: number, host?: string, listener?: () => void): Socket;
|
||||
/** Inherited from `net` */
|
||||
destroy(error?: Error): Socket;
|
||||
/** Inherited from `net` */
|
||||
end(data?: string, encoding?: string, callback?: () => void): Socket;
|
||||
/** Inherited from `net` */
|
||||
end(data?: Buffer | Uint8Array, callback?: () => void): Socket;
|
||||
/** Inherited from `net` */
|
||||
pause(): Socket;
|
||||
/** Inherited from `net` */
|
||||
ref(): Socket;
|
||||
/** Inherited from `net` */
|
||||
resume(): Socket;
|
||||
/** Inherited from `net` */
|
||||
setEncoding(encoding?: string): Socket;
|
||||
/** Inherited from `net` */
|
||||
setKeepAlive(enable?: boolean, initialDelay?: number): Socket;
|
||||
/** Inherited from `net` */
|
||||
setNoDelay(noDelay?: boolean): Socket;
|
||||
/** Inherited from `net` */
|
||||
setTimeout(timeout: number, callback: () => void): Socket;
|
||||
/** Inherited from `net` */
|
||||
unref(): Socket;
|
||||
/** Inherited from `net` */
|
||||
write(data: string, encoding?: string, callback?: () => void): boolean;
|
||||
/** Inherited from `net` */
|
||||
write(data: Buffer | Uint8Array, callback?: () => void): boolean;
|
||||
}
|
||||
|
||||
export class TelnetInput extends Transform {
|
||||
constructor(options?: TelnetInputOptions);
|
||||
}
|
||||
|
||||
export class TelnetOutput extends Transform {
|
||||
constructor(options?: TransformOptions);
|
||||
|
||||
/**
|
||||
* Call this method to send a TELNET command to the remote system.
|
||||
*
|
||||
* ```js
|
||||
* var NOP = 241; // No operation. -- See RFC 854
|
||||
* var tSocket = new TelnetSocket(socket);
|
||||
* // Sends: IAC NOP
|
||||
* tSocket.writeCommand(NOP);
|
||||
* ```
|
||||
*
|
||||
* @param command The command byte to send
|
||||
*/
|
||||
writeCommand(command: number): void;
|
||||
/**
|
||||
* Call this method to send a TELNET DO option negotiation to the remote
|
||||
* system. A DO request is sent when the local system wants the remote
|
||||
* system to perform some function or obey some protocol.
|
||||
*
|
||||
* ```js
|
||||
* var NAWS = 31; // Negotiate About Window Size -- See RFC 1073
|
||||
* var tSocket = new TelnetSocket(socket);
|
||||
* // Sends: IAC DO NAWS
|
||||
* tSocket.writeDo(NAWS);
|
||||
* ```
|
||||
*
|
||||
* @param option The option byte to request of the remote system
|
||||
*/
|
||||
writeDo(option: number): void;
|
||||
/**
|
||||
* Call this method to send a TELNET DONT option negotiation to the remote
|
||||
* system. A DONT request is sent when the local system wants the remote
|
||||
* system to NOT perform some function or NOT obey some protocol.
|
||||
*
|
||||
* ```js
|
||||
* var NAWS = 31; // Negotiate About Window Size -- See RFC 1073
|
||||
* var tSocket = new TelnetSocket(socket);
|
||||
* // Sends: IAC DONT NAWS
|
||||
* tSocket.writeDont(NAWS);
|
||||
* ```
|
||||
*
|
||||
* @param option The option byte to request of the remote system
|
||||
*/
|
||||
writeDont(option: number): void;
|
||||
/**
|
||||
* Call this method to send a TELNET WILL option negotiation to the remote
|
||||
* system. A WILL offer is sent when the local system wants to inform the
|
||||
* remote system that it will perform some function or obey some protocol.
|
||||
*
|
||||
* ```js
|
||||
* var NAWS = 31; // Negotiate About Window Size -- See RFC 1073
|
||||
* var tSocket = new TelnetSocket(socket);
|
||||
* // Sends: IAC WILL NAWS
|
||||
* tSocket.writeWill(NAWS);
|
||||
* ```
|
||||
*
|
||||
* @param option The option byte to offer to the remote system
|
||||
*/
|
||||
writeWill(option: number): void;
|
||||
/**
|
||||
* Call this method to send a TELNET WONT option negotiation to the remote
|
||||
* system. A WONT refusal is sent when the remote system has requested that
|
||||
* the local system perform some function or obey some protocol, and the
|
||||
* local system is refusing to do so.
|
||||
*
|
||||
* ```js
|
||||
* var NAWS = 31; // Negotiate About Window Size -- See RFC 1073
|
||||
* var tSocket = new TelnetSocket(socket);
|
||||
* // Sends: IAC WONT NAWS
|
||||
* tSocket.writeWont(NAWS);
|
||||
* ```
|
||||
*
|
||||
* @param option The option byte to refuse to the remote system
|
||||
*/
|
||||
writeWont(option: number): void;
|
||||
/**
|
||||
* Call this method to send a TELNET subnegotiation to the remote system.
|
||||
* After the local and remote system have negotiated and agreed to use
|
||||
* an option, then subnegotiation information can be sent.
|
||||
*
|
||||
* See Example #2: Negotiate About Window Size (NAWS) in the README.
|
||||
*
|
||||
* @param option The option byte; identifies what the subnegotiation is about
|
||||
* @param buffer The buffer containing the subnegotiation data to send
|
||||
*/
|
||||
writeSub(option: number, buffer: any): void;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user