More renaming
This commit is contained in:
commit
91c4ef665a
1
libguac/AUTHORS
Normal file
1
libguac/AUTHORS
Normal file
@ -0,0 +1 @@
|
||||
Michael Jumper <zhangmaike@users.sourceforge.net>
|
661
libguac/COPYING
Normal file
661
libguac/COPYING
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/>.
|
0
libguac/ChangeLog
Normal file
0
libguac/ChangeLog
Normal file
1551
libguac/Doxyfile
Normal file
1551
libguac/Doxyfile
Normal file
File diff suppressed because it is too large
Load Diff
0
libguac/INSTALL
Normal file
0
libguac/INSTALL
Normal file
14
libguac/Makefile.am
Normal file
14
libguac/Makefile.am
Normal file
@ -0,0 +1,14 @@
|
||||
AUTOMAKE_OPTIONS = gnu
|
||||
|
||||
ACLOCAL_AMFLAGS = -I m4
|
||||
AM_CFLAGS = -Werror -Wall -Iinclude
|
||||
|
||||
libguacincdir = $(includedir)/guacamole
|
||||
libguacinc_HEADERS = include/client.h include/guacio.h include/protocol.h
|
||||
|
||||
lib_LTLIBRARIES = libguac.la
|
||||
|
||||
libguac_la_SOURCES = src/client.c src/guacio.c src/protocol.c
|
||||
|
||||
libguac_la_LDFLAGS = -version-info 0:0:0
|
||||
|
0
libguac/NEWS
Normal file
0
libguac/NEWS
Normal file
0
libguac/README
Normal file
0
libguac/README
Normal file
29
libguac/configure.in
Normal file
29
libguac/configure.in
Normal file
@ -0,0 +1,29 @@
|
||||
# -*- Autoconf -*-
|
||||
# Process this file with autoconf to produce a configure script.
|
||||
|
||||
AC_INIT(src/client.c)
|
||||
AM_INIT_AUTOMAKE(libguac, 0.0.1)
|
||||
AC_CONFIG_MACRO_DIR([m4])
|
||||
|
||||
# Checks for programs.
|
||||
AC_PROG_CC
|
||||
AC_PROG_LIBTOOL
|
||||
|
||||
# Checks for libraries.
|
||||
AC_CHECK_LIB([dl], [dlopen],, AC_MSG_ERROR("libdl is required for loading client plugins"))
|
||||
AC_CHECK_LIB([png], [png_write_png])
|
||||
|
||||
# Checks for header files.
|
||||
AC_CHECK_HEADERS([fcntl.h stdlib.h string.h sys/socket.h sys/time.h syslog.h unistd.h])
|
||||
|
||||
# Checks for typedefs, structures, and compiler characteristics.
|
||||
AC_TYPE_SIZE_T
|
||||
AC_TYPE_SSIZE_T
|
||||
|
||||
# Checks for library functions.
|
||||
AC_FUNC_MALLOC
|
||||
AC_FUNC_REALLOC
|
||||
AC_CHECK_FUNCS([gettimeofday memmove memset select strdup])
|
||||
|
||||
AC_CONFIG_FILES([Makefile])
|
||||
AC_OUTPUT
|
242
libguac/include/client.h
Normal file
242
libguac/include/client.h
Normal file
@ -0,0 +1,242 @@
|
||||
|
||||
/*
|
||||
* Guacamole - Clientless Remote Desktop
|
||||
* Copyright (C) 2010 Michael Jumper
|
||||
*
|
||||
* 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/>.
|
||||
*/
|
||||
|
||||
#ifndef _CLIENT_H
|
||||
#define _CLIENT_H
|
||||
|
||||
#include <png.h>
|
||||
|
||||
#include "guacio.h"
|
||||
|
||||
/**
|
||||
* Provides functions and structures required for defining (and handling) a proxy client.
|
||||
*
|
||||
* @file client.h
|
||||
*/
|
||||
|
||||
typedef struct guac_client guac_client;
|
||||
|
||||
/**
|
||||
* Handler for server messages (where "server" refers to the server that
|
||||
* the proxy client is connected to).
|
||||
*/
|
||||
typedef int guac_client_handle_messages(guac_client* client);
|
||||
|
||||
/**
|
||||
* Handler for Guacamole mouse events.
|
||||
*/
|
||||
typedef int guac_client_mouse_handler(guac_client* client, int x, int y, int button_mask);
|
||||
|
||||
/**
|
||||
* Handler for Guacamole key events.
|
||||
*/
|
||||
typedef int guac_client_key_handler(guac_client* client, int keysym, int pressed);
|
||||
|
||||
/**
|
||||
* Handler for Guacamole clipboard events.
|
||||
*/
|
||||
typedef int guac_client_clipboard_handler(guac_client* client, char* copied);
|
||||
|
||||
/**
|
||||
* Handler for freeing up any extra data allocated by the client
|
||||
* implementation.
|
||||
*/
|
||||
typedef int guac_client_free_handler(void* client);
|
||||
|
||||
/**
|
||||
* Guacamole proxy client.
|
||||
*
|
||||
* Represents a Guacamole proxy client (the client which communicates to
|
||||
* a server on behalf of Guacamole, on behalf of the web-client).
|
||||
*/
|
||||
struct guac_client {
|
||||
|
||||
/**
|
||||
* The GUACIO structure to be used to communicate with the web-client. It is
|
||||
* expected that the implementor of any Guacamole proxy client will provide
|
||||
* their own mechanism of I/O for their protocol. The GUACIO structure is
|
||||
* used only to communicate conveniently with the Guacamole web-client.
|
||||
*/
|
||||
GUACIO* io;
|
||||
|
||||
/**
|
||||
* Reference to dlopen'd client plugin.
|
||||
*/
|
||||
void* client_plugin_handle;
|
||||
|
||||
/**
|
||||
* Arbitrary reference to proxy client-specific data. Implementors of a
|
||||
* Guacamole proxy client can store any data they want here, which can then
|
||||
* be retrieved as necessary in the message handlers.
|
||||
*/
|
||||
void* data;
|
||||
|
||||
/**
|
||||
* Handler for server messages. If set, this function will be called
|
||||
* occasionally by the Guacamole proxy to give the client a chance to
|
||||
* handle messages from whichever server it is connected to.
|
||||
*
|
||||
* Example:
|
||||
* @code
|
||||
* void handle_messages(guac_client* client);
|
||||
*
|
||||
* int guac_client_init(guac_client* client, int argc, char** argv) {
|
||||
* client->handle_messages = handle_messages;
|
||||
* }
|
||||
* @endcode
|
||||
*/
|
||||
guac_client_handle_messages* handle_messages;
|
||||
|
||||
/**
|
||||
* Handler for mouse events sent by the Gaucamole web-client.
|
||||
*
|
||||
* The handler takes the integer mouse X and Y coordinates, as well as
|
||||
* a button mask containing the bitwise OR of all button values currently
|
||||
* being pressed. Those values are:
|
||||
*
|
||||
* <table>
|
||||
* <tr><th>Button</th> <th>Value</th></tr>
|
||||
* <tr><td>Left</td> <td>1</td></tr>
|
||||
* <tr><td>Middle</td> <td>2</td></tr>
|
||||
* <tr><td>Right</td> <td>4</td></tr>
|
||||
* <tr><td>Scrollwheel Up</td> <td>8</td></tr>
|
||||
* <tr><td>Scrollwheel Down</td><td>16</td></tr>
|
||||
* </table>
|
||||
|
||||
* Example:
|
||||
* @code
|
||||
* void mouse_handler(guac_client* client, int x, int y, int button_mask);
|
||||
*
|
||||
* int guac_client_init(guac_client* client, int argc, char** argv) {
|
||||
* client->mouse_handler = mouse_handler;
|
||||
* }
|
||||
* @endcode
|
||||
*/
|
||||
guac_client_mouse_handler* mouse_handler;
|
||||
|
||||
/**
|
||||
* Handler for key events sent by the Guacamole web-client.
|
||||
*
|
||||
* The handler takes the integer X11 keysym associated with the key
|
||||
* being pressed/released, and an integer representing whether the key
|
||||
* is being pressed (1) or released (0).
|
||||
*
|
||||
* Example:
|
||||
* @code
|
||||
* void key_handler(guac_client* client, int keysym, int pressed);
|
||||
*
|
||||
* int guac_client_init(guac_client* client, int argc, char** argv) {
|
||||
* client->key_handler = key_handler;
|
||||
* }
|
||||
* @endcode
|
||||
*/
|
||||
guac_client_key_handler* key_handler;
|
||||
|
||||
/**
|
||||
* Handler for clipboard events sent by the Guacamole web-client. This
|
||||
* handler will be called whenever the web-client sets the data of the
|
||||
* clipboard.
|
||||
*
|
||||
* This handler takes a single string which contains the text which
|
||||
* has been set in the clipboard. This text is already unescaped from
|
||||
* the Guacamole escaped version sent within the clipboard message
|
||||
* in the protocol.
|
||||
*
|
||||
* Example:
|
||||
* @code
|
||||
* void clipboard_handler(guac_client* client, char* copied);
|
||||
*
|
||||
* int guac_client_init(guac_client* client, int argc, char** argv) {
|
||||
* client->clipboard_handler = clipboard_handler;
|
||||
* }
|
||||
* @endcode
|
||||
*/
|
||||
guac_client_clipboard_handler* clipboard_handler;
|
||||
|
||||
/**
|
||||
* Handler for freeing data when the client is being unloaded.
|
||||
*
|
||||
* This handler will be called when the client needs to be unloaded
|
||||
* by the proxy, and any data allocated by the proxy client should be
|
||||
* freed.
|
||||
*
|
||||
* Implement this handler if you store data inside the client.
|
||||
*
|
||||
* Example:
|
||||
* @code
|
||||
* void free_handler(guac_client* client);
|
||||
*
|
||||
* int guac_client_init(guac_client* client, int argc, char** argv) {
|
||||
* client->free_handler = free_handler;
|
||||
* }
|
||||
* @endcode
|
||||
*/
|
||||
guac_client_free_handler* free_handler;
|
||||
|
||||
};
|
||||
|
||||
/**
|
||||
* Handler which should initialize the given guac_client.
|
||||
*/
|
||||
typedef int guac_client_init_handler(guac_client* client, int argc, char** argv);
|
||||
|
||||
/**
|
||||
* Initialize and return a new guac_client. The pluggable client will be chosen based on
|
||||
* the first connect message received on the given file descriptor.
|
||||
*
|
||||
* @param client_fd The file descriptor associated with the socket associated with the connection to the
|
||||
* web-client tunnel.
|
||||
* @return A pointer to the newly initialized client.
|
||||
*/
|
||||
guac_client* guac_get_client(int client_fd);
|
||||
|
||||
/**
|
||||
* Enter the main network message handling loop for the given client.
|
||||
*
|
||||
* @param client The proxy client to start handling messages of/for.
|
||||
*/
|
||||
void guac_start_client(guac_client* client);
|
||||
|
||||
/**
|
||||
* Free all resources associated with the given client.
|
||||
*
|
||||
* @param client The proxy client to free all reasources of.
|
||||
*/
|
||||
void guac_free_client(guac_client* client);
|
||||
|
||||
/**
|
||||
* Allocate a libpng-compatible buffer to hold raw image data.
|
||||
*
|
||||
* @param w The width of the buffer to allocate, in pixels.
|
||||
* @param h The height of the buffer to allocate, in pixels.
|
||||
* @param bpp The number of bytes per pixel (3 for RGB images, 4 for RGBA).
|
||||
* @return A pointer to the newly allocated buffer.
|
||||
*/
|
||||
png_byte** guac_alloc_png_buffer(int w, int h, int bpp);
|
||||
|
||||
/**
|
||||
* Free all memory associated with the given libpng-compatible buffer
|
||||
* as allocated by guac_alloc_png_buffer.
|
||||
*
|
||||
* @param png_buffer The buffer to free.
|
||||
* @param h The height of the buffer to free.
|
||||
*/
|
||||
void guac_free_png_buffer(png_byte** png_buffer, int h);
|
||||
|
||||
#endif
|
179
libguac/include/guacio.h
Normal file
179
libguac/include/guacio.h
Normal file
@ -0,0 +1,179 @@
|
||||
|
||||
/*
|
||||
* Guacamole - Clientless Remote Desktop
|
||||
* Copyright (C) 2010 Michael Jumper
|
||||
*
|
||||
* 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/>.
|
||||
*/
|
||||
|
||||
#ifndef _GUACIO_H
|
||||
#define _GUACIO_H
|
||||
|
||||
#include <unistd.h>
|
||||
|
||||
/**
|
||||
* Defines the GUACIO object and functionss for using and manipulating it.
|
||||
*
|
||||
* @file guacio.h
|
||||
*/
|
||||
|
||||
|
||||
/**
|
||||
* The core I/O object of Guacamole. GUACIO provides buffered input and output
|
||||
* as well as convenience methods for efficiently writing base64 data.
|
||||
*/
|
||||
typedef struct GUACIO {
|
||||
|
||||
/**
|
||||
* The file descriptor to be read from / written to.
|
||||
*/
|
||||
int fd;
|
||||
|
||||
/**
|
||||
* The number of bytes present in the base64 "ready" buffer.
|
||||
*/
|
||||
int ready;
|
||||
|
||||
/**
|
||||
* The base64 "ready" buffer. Once this buffer is filled, base64 data is
|
||||
* flushed to the main write buffer.
|
||||
*/
|
||||
int ready_buf[3];
|
||||
|
||||
/**
|
||||
* The number of bytes currently in the main write buffer.
|
||||
*/
|
||||
int written;
|
||||
|
||||
/**
|
||||
* The main write buffer. Bytes written go here before being flushed
|
||||
* to the open file descriptor.
|
||||
*/
|
||||
char out_buf[8192];
|
||||
|
||||
/**
|
||||
* The current size of the instruction buffer.
|
||||
*/
|
||||
int instructionbuf_size;
|
||||
|
||||
/**
|
||||
* The number of bytes currently in the instruction buffer.
|
||||
*/
|
||||
int instructionbuf_used_length;
|
||||
|
||||
/**
|
||||
* The instruction buffer. This is essentially the input buffer,
|
||||
* provided as a convenience to be used to buffer instructions until
|
||||
* those instructions are complete and ready to be parsed.
|
||||
*/
|
||||
char* instructionbuf;
|
||||
|
||||
/**
|
||||
* The transfer limit, in kilobytes per second. If 0, there is no
|
||||
* transfer limit. If non-zero, sleep calls are used at the end of
|
||||
* a write to ensure output never exceeds the specified limit.
|
||||
*/
|
||||
unsigned int transfer_limit; /* KB/sec */
|
||||
|
||||
} GUACIO;
|
||||
|
||||
/**
|
||||
* Allocates and initializes a new GUACIO object with the given open
|
||||
* file descriptor.
|
||||
*
|
||||
* @param fd An open file descriptor that this GUACIO object should manage.
|
||||
* @return A newly allocated GUACIO object associated with the given
|
||||
* file descriptor.
|
||||
*/
|
||||
GUACIO* guac_open(int fd);
|
||||
|
||||
/**
|
||||
* Writes the given unsigned int to the given GUACIO object. The data
|
||||
* written may be buffered until the buffer is flushed automatically or
|
||||
* manually.
|
||||
*
|
||||
* @param io The GUACIO object to write to.
|
||||
* @param i The unsigned int to write.
|
||||
* @return Zero on success, or non-zero if an error occurs while writing.
|
||||
*/
|
||||
ssize_t guac_write_int(GUACIO* io, unsigned int i);
|
||||
|
||||
/**
|
||||
* Writes the given string to the given GUACIO object. The data
|
||||
* written may be buffered until the buffer is flushed automatically or
|
||||
* manually. Note that if the string can contain characters used
|
||||
* internally by the Guacamole protocol (commas, semicolons, or
|
||||
* backslashes) it will need to be escaped.
|
||||
*
|
||||
* @param io The GUACIO object to write to.
|
||||
* @param str The string to write.
|
||||
* @return Zero on success, or non-zero if an error occurs while writing.
|
||||
*/
|
||||
ssize_t guac_write_string(GUACIO* io, const char* str);
|
||||
|
||||
/**
|
||||
* Writes the given binary data to the given GUACIO object as base64-encoded
|
||||
* data. The data written may be buffered until the buffer is flushed
|
||||
* automatically or manually. Beware that because base64 data is buffered
|
||||
* on top of the write buffer already used, a call to guac_flush_base64() must
|
||||
* be made before non-base64 writes (or writes of an independent block of
|
||||
* base64 data) can be made.
|
||||
*
|
||||
* @param io The GUACIO object to write to.
|
||||
* @param buf A buffer containing the data to write.
|
||||
* @param count The number of bytes to write.
|
||||
* @return Zero on success, or non-zero if an error occurs while writing.
|
||||
*/
|
||||
ssize_t guac_write_base64(GUACIO* io, const void* buf, size_t count);
|
||||
|
||||
/**
|
||||
* Flushes the base64 buffer, writing padding characters as necessary.
|
||||
*
|
||||
* @param io The GUACIO object to flush
|
||||
* @return Zero on success, or non-zero if an error occurs during flush.
|
||||
*/
|
||||
ssize_t guac_flush_base64(GUACIO* io);
|
||||
|
||||
/**
|
||||
* Flushes the write buffer.
|
||||
*
|
||||
* @param io The GUACIO object to flush
|
||||
* @return Zero on success, or non-zero if an error occurs during flush.
|
||||
*/
|
||||
ssize_t guac_flush(GUACIO* io);
|
||||
|
||||
|
||||
/**
|
||||
* Waits for input to be available on the given GUACIO object until the
|
||||
* specified timeout elapses.
|
||||
*
|
||||
* @param io The GUACIO object to wait for.
|
||||
* @param usec_timeout The maximum number of microseconds to wait for data, or
|
||||
* -1 to potentially wait forever.
|
||||
* @return Positive on success, zero if the timeout elapsed and no data is
|
||||
* available, negative on error.
|
||||
*/
|
||||
int guac_select(GUACIO* io, int usec_timeout);
|
||||
|
||||
/**
|
||||
* Frees resources allocated to the given GUACIO object. Note that this
|
||||
* implicitly flush all buffers, but will NOT close the associated file
|
||||
* descriptor.
|
||||
*
|
||||
* @param io The GUACIO object to close.
|
||||
*/
|
||||
void guac_close(GUACIO* io);
|
||||
|
||||
#endif
|
||||
|
203
libguac/include/protocol.h
Normal file
203
libguac/include/protocol.h
Normal file
@ -0,0 +1,203 @@
|
||||
|
||||
/*
|
||||
* Guacamole - Clientless Remote Desktop
|
||||
* Copyright (C) 2010 Michael Jumper
|
||||
*
|
||||
* 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/>.
|
||||
*/
|
||||
|
||||
#ifndef __PROTOCOL_H
|
||||
#define __PROTOCOL_H
|
||||
|
||||
#include <png.h>
|
||||
|
||||
#include "guacio.h"
|
||||
|
||||
/**
|
||||
* Provides functions and structures required for communicating using the
|
||||
* Guacamole protocol over a GUACIO connection, such as that provided by
|
||||
* guac_client objects.
|
||||
*
|
||||
* @file protocol.h
|
||||
*/
|
||||
|
||||
|
||||
/**
|
||||
* Represents a single instruction within the Guacamole protocol.
|
||||
*/
|
||||
typedef struct guac_instruction {
|
||||
|
||||
/**
|
||||
* The opcode of the instruction.
|
||||
*/
|
||||
char* opcode;
|
||||
|
||||
/**
|
||||
* The number of arguments passed to this instruction.
|
||||
*/
|
||||
int argc;
|
||||
|
||||
/**
|
||||
* Array of all arguments passed to this instruction. Strings
|
||||
* are not already unescaped.
|
||||
*/
|
||||
char** argv;
|
||||
|
||||
} guac_instruction;
|
||||
|
||||
|
||||
/**
|
||||
* Frees all memory allocated to the given instruction opcode
|
||||
* and arguments. The instruction structure itself will not
|
||||
* be freed.
|
||||
*
|
||||
* @param instruction The instruction to free.
|
||||
*/
|
||||
void guac_free_instruction_data(guac_instruction* instruction);
|
||||
|
||||
|
||||
/**
|
||||
* Frees all memory allocated to the given instruction. This
|
||||
* includes freeing memory allocated for the structure
|
||||
* itself.
|
||||
*
|
||||
* @param instruction The instruction to free.
|
||||
*/
|
||||
void guac_free_instruction(guac_instruction* instruction);
|
||||
|
||||
/**
|
||||
* Escapes the given string as necessary to be passed within
|
||||
* a Guacamole instruction. The returned string must later be
|
||||
* released with a call to free().
|
||||
*
|
||||
* @param str The string to escape.
|
||||
* @return A new escaped string, which must be freed with free().
|
||||
*/
|
||||
char* guac_escape_string(const char* str);
|
||||
|
||||
/**
|
||||
* Unescapes the given string in-place, as an unescaped string
|
||||
* is always the same length or shorter than the original.
|
||||
*
|
||||
* @param str The string to unescape.
|
||||
* @return A pointer to the original string, which is now unescaped.
|
||||
*/
|
||||
char* guac_unescape_string_inplace(char* str);
|
||||
|
||||
/**
|
||||
* Sends a name instruction over the given GUACIO connection. The
|
||||
* name given will be automatically escaped for transmission.
|
||||
*
|
||||
* @param io The GUACIO connection to use.
|
||||
* @param name The name to send within the name instruction.
|
||||
*/
|
||||
void guac_send_name(GUACIO* io, const char* name);
|
||||
|
||||
/**
|
||||
* Sends an error instruction over the given GUACIO connection. The
|
||||
* error description given will be automatically escaped for
|
||||
* transmission.
|
||||
*
|
||||
* @param io The GUACIO connection to use.
|
||||
* @param error The description associated with the error.
|
||||
*/
|
||||
void guac_send_error(GUACIO* io, const char* error);
|
||||
|
||||
/**
|
||||
* Sends a clipboard instruction over the given GUACIO connection. The
|
||||
* clipboard data given will be automatically escaped for transmission.
|
||||
*
|
||||
* @param io The GUACIO connection to use.
|
||||
* @param data The clipboard data to send.
|
||||
*/
|
||||
void guac_send_clipboard(GUACIO* io, const char* data);
|
||||
|
||||
/**
|
||||
* Sends a size instruction over the given GUACIO connection.
|
||||
*
|
||||
* @param io The GUACIO connection to use.
|
||||
* @param w The width of the display.
|
||||
* @param h The height of the display.
|
||||
*/
|
||||
void guac_send_size(GUACIO* io, int w, int h);
|
||||
|
||||
/**
|
||||
* Sends a copy instruction over the given GUACIO connection.
|
||||
*
|
||||
* @param io The GUACIO connection to use.
|
||||
* @param srcx The X coordinate of the source rectangle.
|
||||
* @param srcy The Y coordinate of the source rectangle.
|
||||
* @param w The width of the source rectangle.
|
||||
* @param h The height of the source rectangle.
|
||||
* @param dstx The X coordinate of the destination, where the source rectangle
|
||||
* should be copied.
|
||||
* @param dsty The Y coordinate of the destination, where the source rectangle
|
||||
* should be copied.
|
||||
*/
|
||||
void guac_send_copy(GUACIO* io, int srcx, int srcy, int w, int h, int dstx, int dsty);
|
||||
|
||||
/**
|
||||
* Sends a png instruction over the given GUACIO connection. The PNG image data
|
||||
* given will be automatically base64-encoded for transmission.
|
||||
*
|
||||
* @param io The GUACIO connection to use.
|
||||
* @param x The destination X coordinate.
|
||||
* @param y The destination Y coordinate.
|
||||
* @param png_rows A libpng-compatible PNG image buffer containing the image
|
||||
* data to send.
|
||||
* @param w The width of the image in the image buffer.
|
||||
* @param h The height of the image in the image buffer.
|
||||
*/
|
||||
void guac_send_png(GUACIO* io, int x, int y, png_byte** png_rows, int w, int h);
|
||||
|
||||
/**
|
||||
* Sends a cursor instruction over the given GUACIO connection. The PNG image
|
||||
* data given will be automatically base64-encoded for transmission.
|
||||
*
|
||||
* @param io The GUACIO connection to use.
|
||||
* @param x The destination X coordinate.
|
||||
* @param y The destination Y coordinate.
|
||||
* @param png_rows A libpng-compatible PNG image buffer containing the image
|
||||
* data to send.
|
||||
* @param w The width of the image in the image buffer.
|
||||
* @param h The height of the image in the image buffer.
|
||||
*/
|
||||
void guac_send_cursor(GUACIO* io, int x, int y, png_byte** png_rows, int w, int h);
|
||||
|
||||
/**
|
||||
* Returns whether new instruction data is available on the given GUACIO
|
||||
* connection for parsing.
|
||||
*
|
||||
* @param io The GUACIO connection to use.
|
||||
* @return A positive value if data is available, negative on error, or
|
||||
* zero if no data is currently available.
|
||||
*/
|
||||
int guac_instructions_waiting(GUACIO* io);
|
||||
|
||||
/**
|
||||
* Reads a single instruction from the given GUACIO connection.
|
||||
*
|
||||
* @param io The GUACIO connection to use.
|
||||
* @param parsed_instruction A pointer to a guac_instruction structure which
|
||||
* will be populated with data read from the given
|
||||
* GUACIO connection.
|
||||
* @return A positive value if data was successfully read, negative on
|
||||
* error, or zero if the instrucion could not be read completely,
|
||||
* in which case, subsequent calls to guac_read_instruction() will
|
||||
* return the parsed instruction once enough data is available.
|
||||
*/
|
||||
int guac_read_instruction(GUACIO* io, guac_instruction* parsed_instruction);
|
||||
|
||||
#endif
|
||||
|
296
libguac/src/client.c
Normal file
296
libguac/src/client.c
Normal file
@ -0,0 +1,296 @@
|
||||
|
||||
/*
|
||||
* Guacamole - Clientless Remote Desktop
|
||||
* Copyright (C) 2010 Michael Jumper
|
||||
*
|
||||
* 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/>.
|
||||
*/
|
||||
|
||||
#include <stdlib.h>
|
||||
#include <stdio.h>
|
||||
#include <string.h>
|
||||
|
||||
#include <syslog.h>
|
||||
|
||||
#include <dlfcn.h>
|
||||
|
||||
#include "guacio.h"
|
||||
#include "protocol.h"
|
||||
#include "client.h"
|
||||
|
||||
|
||||
png_byte** guac_alloc_png_buffer(int w, int h, int bpp) {
|
||||
|
||||
png_byte** png_buffer;
|
||||
png_byte* row;
|
||||
int y;
|
||||
|
||||
/* Allocate rows for PNG */
|
||||
png_buffer = (png_byte**) malloc(h * sizeof(png_byte*));
|
||||
for (y=0; y<h; y++) {
|
||||
row = (png_byte*) malloc(sizeof(png_byte) * bpp * w);
|
||||
png_buffer[y] = row;
|
||||
}
|
||||
|
||||
return png_buffer;
|
||||
}
|
||||
|
||||
void guac_free_png_buffer(png_byte** png_buffer, int h) {
|
||||
|
||||
int y;
|
||||
|
||||
/* Free PNG data */
|
||||
for (y = 0; y<h; y++)
|
||||
free(png_buffer[y]);
|
||||
free(png_buffer);
|
||||
|
||||
}
|
||||
|
||||
guac_client* __guac_alloc_client(GUACIO* io) {
|
||||
|
||||
/* Allocate new client (not handoff) */
|
||||
guac_client* client = malloc(sizeof(guac_client));
|
||||
memset(client, 0, sizeof(guac_client));
|
||||
|
||||
/* Init new client */
|
||||
client->io = io;
|
||||
|
||||
return client;
|
||||
}
|
||||
|
||||
|
||||
guac_client* guac_get_client(int client_fd) {
|
||||
|
||||
guac_client* client;
|
||||
GUACIO* io = guac_open(client_fd);
|
||||
|
||||
/* Pluggable client */
|
||||
char protocol_lib[256] = "libguac_client_";
|
||||
|
||||
union {
|
||||
guac_client_init_handler* client_init;
|
||||
void* obj;
|
||||
} alias;
|
||||
|
||||
char* error;
|
||||
|
||||
/* Client arguments */
|
||||
int argc;
|
||||
char** argv;
|
||||
|
||||
/* Connect instruction */
|
||||
guac_instruction instruction;
|
||||
|
||||
/* Wait for connect instruction */
|
||||
for (;;) {
|
||||
|
||||
int result = guac_read_instruction(io, &instruction);
|
||||
if (result < 0) {
|
||||
syslog(LOG_ERR, "Error reading instruction while waiting for connect");
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/* Connect instruction read */
|
||||
if (result > 0) {
|
||||
|
||||
if (strcmp(instruction.opcode, "connect") == 0) {
|
||||
|
||||
/* Get protocol from message */
|
||||
char* protocol = instruction.argv[0];
|
||||
|
||||
strcat(protocol_lib, protocol);
|
||||
strcat(protocol_lib, ".so");
|
||||
|
||||
/* Create new client */
|
||||
client = __guac_alloc_client(io);
|
||||
|
||||
/* Load client plugin */
|
||||
client->client_plugin_handle = dlopen(protocol_lib, RTLD_LAZY);
|
||||
if (!(client->client_plugin_handle)) {
|
||||
syslog(LOG_ERR, "Could not open client plugin for protocol \"%s\": %s\n", protocol, dlerror());
|
||||
guac_send_error(io, "Could not load server-side client plugin.");
|
||||
guac_flush(io);
|
||||
guac_free_instruction_data(&instruction);
|
||||
return NULL;
|
||||
}
|
||||
|
||||
dlerror(); /* Clear errors */
|
||||
|
||||
/* Get init function */
|
||||
alias.obj = dlsym(client->client_plugin_handle, "guac_client_init");
|
||||
|
||||
if ((error = dlerror()) != NULL) {
|
||||
syslog(LOG_ERR, "Could not get guac_client_init in plugin: %s\n", error);
|
||||
guac_send_error(io, "Invalid server-side client plugin.");
|
||||
guac_flush(io);
|
||||
guac_free_instruction_data(&instruction);
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/* Initialize client arguments */
|
||||
argc = instruction.argc;
|
||||
argv = instruction.argv;
|
||||
|
||||
if (alias.client_init(client, argc, argv) != 0) {
|
||||
/* NOTE: On error, proxy client will send appropriate error message */
|
||||
guac_free_instruction_data(&instruction);
|
||||
return NULL;
|
||||
}
|
||||
|
||||
guac_free_instruction_data(&instruction);
|
||||
return client;
|
||||
|
||||
} /* end if connect */
|
||||
|
||||
guac_free_instruction_data(&instruction);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
void guac_free_client(guac_client* client) {
|
||||
|
||||
if (client->free_handler) {
|
||||
if (client->free_handler(client))
|
||||
syslog(LOG_ERR, "Error calling client free handler");
|
||||
}
|
||||
|
||||
guac_close(client->io);
|
||||
|
||||
/* Unload client plugin */
|
||||
if (dlclose(client->client_plugin_handle)) {
|
||||
syslog(LOG_ERR, "Could not close client plugin while unloading client: %s", dlerror());
|
||||
}
|
||||
|
||||
free(client);
|
||||
}
|
||||
|
||||
|
||||
void guac_start_client(guac_client* client) {
|
||||
|
||||
GUACIO* io = client->io;
|
||||
guac_instruction instruction;
|
||||
int wait_result;
|
||||
|
||||
/* VNC Client Loop */
|
||||
for (;;) {
|
||||
|
||||
/* Handle server messages */
|
||||
if (client->handle_messages) {
|
||||
|
||||
int retval = client->handle_messages(client);
|
||||
if (retval) {
|
||||
syslog(LOG_ERR, "Error handling server messages");
|
||||
return;
|
||||
}
|
||||
|
||||
guac_flush(io);
|
||||
}
|
||||
|
||||
wait_result = guac_instructions_waiting(io);
|
||||
if (wait_result > 0) {
|
||||
|
||||
int retval;
|
||||
retval = guac_read_instruction(io, &instruction); /* 0 if no instructions finished yet, <0 if error or EOF */
|
||||
|
||||
if (retval > 0) {
|
||||
|
||||
do {
|
||||
|
||||
if (strcmp(instruction.opcode, "mouse") == 0) {
|
||||
if (client->mouse_handler)
|
||||
if (
|
||||
client->mouse_handler(
|
||||
client,
|
||||
atoi(instruction.argv[0]), /* x */
|
||||
atoi(instruction.argv[1]), /* y */
|
||||
atoi(instruction.argv[2]) /* mask */
|
||||
)
|
||||
) {
|
||||
|
||||
syslog(LOG_ERR, "Error handling mouse instruction");
|
||||
guac_free_instruction_data(&instruction);
|
||||
return;
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
else if (strcmp(instruction.opcode, "key") == 0) {
|
||||
if (client->key_handler)
|
||||
if (
|
||||
client->key_handler(
|
||||
client,
|
||||
atoi(instruction.argv[0]), /* keysym */
|
||||
atoi(instruction.argv[1]) /* pressed */
|
||||
)
|
||||
) {
|
||||
|
||||
syslog(LOG_ERR, "Error handling key instruction");
|
||||
guac_free_instruction_data(&instruction);
|
||||
return;
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
else if (strcmp(instruction.opcode, "clipboard") == 0) {
|
||||
if (client->clipboard_handler)
|
||||
if (
|
||||
client->clipboard_handler(
|
||||
client,
|
||||
guac_unescape_string_inplace(instruction.argv[0]) /* data */
|
||||
)
|
||||
) {
|
||||
|
||||
syslog(LOG_ERR, "Error handling clipboard instruction");
|
||||
guac_free_instruction_data(&instruction);
|
||||
return;
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
else if (strcmp(instruction.opcode, "disconnect") == 0) {
|
||||
syslog(LOG_INFO, "Client requested disconnect");
|
||||
guac_free_instruction_data(&instruction);
|
||||
return;
|
||||
}
|
||||
|
||||
guac_free_instruction_data(&instruction);
|
||||
|
||||
} while ((retval = guac_read_instruction(io, &instruction)) > 0);
|
||||
|
||||
if (retval < 0) {
|
||||
syslog(LOG_ERR, "Error reading instruction from stream");
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
if (retval < 0) {
|
||||
syslog(LOG_ERR, "Error or end of stream");
|
||||
return; /* EOF or error */
|
||||
}
|
||||
|
||||
/* Otherwise, retval == 0 implies unfinished instruction */
|
||||
|
||||
}
|
||||
else if (wait_result < 0) {
|
||||
syslog(LOG_ERR, "Error waiting for next instruction");
|
||||
return;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
297
libguac/src/guacio.c
Normal file
297
libguac/src/guacio.c
Normal file
@ -0,0 +1,297 @@
|
||||
|
||||
/*
|
||||
* Guacamole - Clientless Remote Desktop
|
||||
* Copyright (C) 2010 Michael Jumper
|
||||
*
|
||||
* 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/>.
|
||||
*/
|
||||
|
||||
#include <stdlib.h>
|
||||
#include <string.h>
|
||||
#include <unistd.h>
|
||||
#include <fcntl.h>
|
||||
#include <stdio.h>
|
||||
|
||||
#include <time.h>
|
||||
#include <sys/select.h>
|
||||
#include <sys/time.h>
|
||||
|
||||
#include "guacio.h"
|
||||
|
||||
char __GUACIO_BASE64_CHARACTERS[64] = {
|
||||
'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P',
|
||||
'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', 'a', 'b', 'c', 'd', 'e', 'f',
|
||||
'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v',
|
||||
'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '+', '/',
|
||||
};
|
||||
|
||||
GUACIO* guac_open(int fd) {
|
||||
|
||||
GUACIO* io = malloc(sizeof(GUACIO));
|
||||
io->ready = 0;
|
||||
io->written = 0;
|
||||
io->fd = fd;
|
||||
|
||||
/* Allocate instruction buffer */
|
||||
io->instructionbuf_size = 1024;
|
||||
io->instructionbuf = malloc(io->instructionbuf_size);
|
||||
io->instructionbuf_used_length = 0;
|
||||
|
||||
/* Set limit */
|
||||
io->transfer_limit = 0;
|
||||
|
||||
return io;
|
||||
|
||||
}
|
||||
|
||||
void guac_close(GUACIO* io) {
|
||||
guac_flush(io);
|
||||
free(io);
|
||||
}
|
||||
|
||||
/* Write bytes, limit rate */
|
||||
ssize_t __guac_write(GUACIO* io, const char* buf, int count) {
|
||||
|
||||
struct timeval start, end;
|
||||
int retval;
|
||||
|
||||
/* Write and time how long the write takes (microseconds) */
|
||||
gettimeofday(&start, NULL);
|
||||
retval = write(io->fd, buf, count);
|
||||
gettimeofday(&end, NULL);
|
||||
|
||||
if (retval < 0)
|
||||
return retval;
|
||||
|
||||
if (io->transfer_limit > 0) {
|
||||
|
||||
suseconds_t elapsed;
|
||||
suseconds_t required_usecs;
|
||||
|
||||
/* Get elapsed time */
|
||||
elapsed = (end.tv_sec - start.tv_sec) * 1000000 + end.tv_usec - start.tv_usec;
|
||||
|
||||
/* Calculate how much time we must sleep */
|
||||
required_usecs = retval * 1000 / io->transfer_limit - elapsed; /* useconds at transfer_limit KB/s*/
|
||||
|
||||
/* Sleep as necessary */
|
||||
if (required_usecs > 0) {
|
||||
|
||||
struct timespec required_sleep;
|
||||
|
||||
required_sleep.tv_sec = required_usecs / 1000000;
|
||||
required_sleep.tv_nsec = (required_usecs % 1000000) * 1000;
|
||||
|
||||
nanosleep(&required_sleep, NULL);
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
return retval;
|
||||
}
|
||||
|
||||
ssize_t guac_write_int(GUACIO* io, unsigned int i) {
|
||||
|
||||
char buffer[128];
|
||||
char* ptr = &(buffer[127]);
|
||||
|
||||
*ptr = 0;
|
||||
|
||||
do {
|
||||
|
||||
ptr--;
|
||||
*ptr = '0' + (i % 10);
|
||||
|
||||
i /= 10;
|
||||
|
||||
} while (i > 0 && ptr >= buffer);
|
||||
|
||||
return guac_write_string(io, ptr);
|
||||
|
||||
}
|
||||
|
||||
ssize_t guac_write_string(GUACIO* io, const char* str) {
|
||||
|
||||
char* out_buf = io->out_buf;
|
||||
|
||||
int retval;
|
||||
|
||||
for (; *str != '\0'; str++) {
|
||||
|
||||
out_buf[io->written++] = *str;
|
||||
|
||||
/* Flush when necessary, return on error */
|
||||
if (io->written > 8188 /* sizeof(out_buf) - 4 */) {
|
||||
|
||||
struct timeval start, end;
|
||||
suseconds_t elapsed;
|
||||
|
||||
gettimeofday(&start, NULL);
|
||||
retval = __guac_write(io, out_buf, io->written);
|
||||
gettimeofday(&end, NULL);
|
||||
|
||||
if (retval < 0)
|
||||
return retval;
|
||||
|
||||
/* Get elapsed time */
|
||||
elapsed = (end.tv_sec - start.tv_sec) * 1000000 + end.tv_usec - start.tv_usec;
|
||||
|
||||
io->written = 0;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
return 0;
|
||||
|
||||
}
|
||||
|
||||
ssize_t __guac_write_base64_triplet(GUACIO* io, int a, int b, int c) {
|
||||
|
||||
char* out_buf = io->out_buf;
|
||||
|
||||
int retval;
|
||||
|
||||
/* Byte 1 */
|
||||
out_buf[io->written++] = __GUACIO_BASE64_CHARACTERS[(a & 0xFC) >> 2]; /* [AAAAAA]AABBBB BBBBCC CCCCCC */
|
||||
|
||||
if (b >= 0) {
|
||||
out_buf[io->written++] = __GUACIO_BASE64_CHARACTERS[((a & 0x03) << 4) | ((b & 0xF0) >> 4)]; /* AAAAAA[AABBBB]BBBBCC CCCCCC */
|
||||
|
||||
if (c >= 0) {
|
||||
out_buf[io->written++] = __GUACIO_BASE64_CHARACTERS[((b & 0x0F) << 2) | ((c & 0xC0) >> 6)]; /* AAAAAA AABBBB[BBBBCC]CCCCCC */
|
||||
out_buf[io->written++] = __GUACIO_BASE64_CHARACTERS[c & 0x3F]; /* AAAAAA AABBBB BBBBCC[CCCCCC] */
|
||||
}
|
||||
else {
|
||||
out_buf[io->written++] = __GUACIO_BASE64_CHARACTERS[((b & 0x0F) << 2)]; /* AAAAAA AABBBB[BBBB--]------ */
|
||||
out_buf[io->written++] = '='; /* AAAAAA AABBBB BBBB--[------] */
|
||||
}
|
||||
}
|
||||
else {
|
||||
out_buf[io->written++] = __GUACIO_BASE64_CHARACTERS[((a & 0x03) << 4)]; /* AAAAAA[AA----]------ ------ */
|
||||
out_buf[io->written++] = '='; /* AAAAAA AA----[------]------ */
|
||||
out_buf[io->written++] = '='; /* AAAAAA AA---- ------[------] */
|
||||
}
|
||||
|
||||
/* At this point, 4 bytes have been io->written */
|
||||
|
||||
/* Flush when necessary, return on error */
|
||||
if (io->written > 8188 /* sizeof(out_buf) - 4 */) {
|
||||
retval = __guac_write(io, out_buf, io->written);
|
||||
if (retval < 0)
|
||||
return retval;
|
||||
|
||||
io->written = 0;
|
||||
}
|
||||
|
||||
if (b < 0)
|
||||
return 1;
|
||||
|
||||
if (c < 0)
|
||||
return 2;
|
||||
|
||||
return 3;
|
||||
|
||||
}
|
||||
|
||||
ssize_t __guac_write_base64_byte(GUACIO* io, char buf) {
|
||||
|
||||
int* ready_buf = io->ready_buf;
|
||||
|
||||
int retval;
|
||||
|
||||
ready_buf[io->ready++] = buf & 0xFF;
|
||||
|
||||
/* Flush triplet */
|
||||
if (io->ready == 3) {
|
||||
retval = __guac_write_base64_triplet(io, ready_buf[0], ready_buf[1], ready_buf[2]);
|
||||
if (retval < 0)
|
||||
return retval;
|
||||
|
||||
io->ready = 0;
|
||||
}
|
||||
|
||||
return 1;
|
||||
}
|
||||
|
||||
ssize_t guac_write_base64(GUACIO* io, const void* buf, size_t count) {
|
||||
|
||||
int retval;
|
||||
|
||||
const char* char_buf = (const char*) buf;
|
||||
const char* end = char_buf + count;
|
||||
|
||||
while (char_buf < end) {
|
||||
|
||||
retval = __guac_write_base64_byte(io, *(char_buf++));
|
||||
if (retval < 0)
|
||||
return retval;
|
||||
|
||||
}
|
||||
|
||||
return count;
|
||||
|
||||
}
|
||||
|
||||
ssize_t guac_flush(GUACIO* io) {
|
||||
|
||||
int retval;
|
||||
|
||||
/* Flush remaining bytes in buffer */
|
||||
if (io->written > 0) {
|
||||
retval = __guac_write(io, io->out_buf, io->written);
|
||||
if (retval < 0)
|
||||
return retval;
|
||||
|
||||
io->written = 0;
|
||||
}
|
||||
|
||||
return 0;
|
||||
|
||||
}
|
||||
|
||||
ssize_t guac_flush_base64(GUACIO* io) {
|
||||
|
||||
int retval;
|
||||
|
||||
/* Flush triplet to output buffer */
|
||||
while (io->ready > 0) {
|
||||
retval = __guac_write_base64_byte(io, -1);
|
||||
if (retval < 0)
|
||||
return retval;
|
||||
}
|
||||
|
||||
return 0;
|
||||
|
||||
}
|
||||
|
||||
|
||||
int guac_select(GUACIO* io, int usec_timeout) {
|
||||
|
||||
fd_set fds;
|
||||
struct timeval timeout;
|
||||
|
||||
if (usec_timeout < 0)
|
||||
return select(io->fd + 1, &fds, NULL, NULL, NULL);
|
||||
|
||||
timeout.tv_sec = usec_timeout/1000000;
|
||||
timeout.tv_usec = usec_timeout%1000000;
|
||||
|
||||
FD_ZERO(&fds);
|
||||
FD_SET(io->fd, &fds);
|
||||
|
||||
return select(io->fd + 1, &fds, NULL, NULL, &timeout);
|
||||
|
||||
}
|
||||
|
464
libguac/src/protocol.c
Normal file
464
libguac/src/protocol.c
Normal file
@ -0,0 +1,464 @@
|
||||
|
||||
/*
|
||||
* Guacamole - Clientless Remote Desktop
|
||||
* Copyright (C) 2010 Michael Jumper
|
||||
*
|
||||
* 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/>.
|
||||
*/
|
||||
|
||||
#include <stdlib.h>
|
||||
#include <stdio.h>
|
||||
#include <string.h>
|
||||
#include <errno.h>
|
||||
#include <png.h>
|
||||
|
||||
#include <sys/types.h>
|
||||
#include <sys/socket.h>
|
||||
|
||||
#include "guacio.h"
|
||||
#include "protocol.h"
|
||||
|
||||
char* guac_escape_string(const char* str) {
|
||||
|
||||
char* escaped;
|
||||
char* current;
|
||||
|
||||
int i;
|
||||
int length = 0;
|
||||
|
||||
/* Determine length */
|
||||
for (i=0; str[i] != '\0'; i++) {
|
||||
switch (str[i]) {
|
||||
|
||||
case ';':
|
||||
case ',':
|
||||
case '\\':
|
||||
length += 2;
|
||||
break;
|
||||
|
||||
default:
|
||||
length++;
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
/* Allocate new */
|
||||
escaped = malloc(length+1);
|
||||
|
||||
current = escaped;
|
||||
for (i=0; str[i] != '\0'; i++) {
|
||||
switch (str[i]) {
|
||||
|
||||
case ';':
|
||||
*(current++) = '\\';
|
||||
*(current++) = 's';
|
||||
break;
|
||||
|
||||
case ',':
|
||||
*(current++) = '\\';
|
||||
*(current++) = 'c';
|
||||
break;
|
||||
|
||||
case '\\':
|
||||
*(current++) = '\\';
|
||||
*(current++) = '\\';
|
||||
break;
|
||||
|
||||
default:
|
||||
*(current++) = str[i];
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
*current = '\0';
|
||||
|
||||
return escaped;
|
||||
|
||||
}
|
||||
|
||||
char* guac_unescape_string_inplace(char* str) {
|
||||
|
||||
char* from;
|
||||
char* to;
|
||||
|
||||
from = to = str;
|
||||
for (;;) {
|
||||
|
||||
char c = *(from++);
|
||||
|
||||
if (c == '\\') {
|
||||
|
||||
c = *(from++);
|
||||
if (c == 's')
|
||||
*(to++) = ';';
|
||||
|
||||
else if (c == 'c')
|
||||
*(to++) = ',';
|
||||
|
||||
else if (c == '\\')
|
||||
*(to++) = '\\';
|
||||
|
||||
else if (c == '\0') {
|
||||
*(to++) = '\\';
|
||||
break;
|
||||
}
|
||||
|
||||
else {
|
||||
*(to++) = '\\';
|
||||
*(to++) = c;
|
||||
}
|
||||
}
|
||||
|
||||
else if (c == '\0')
|
||||
break;
|
||||
|
||||
else
|
||||
*(to++) = c;
|
||||
|
||||
}
|
||||
|
||||
*to = '\0';
|
||||
|
||||
return str;
|
||||
|
||||
}
|
||||
|
||||
void guac_send_name(GUACIO* io, const char* name) {
|
||||
|
||||
char* escaped = guac_escape_string(name);
|
||||
|
||||
guac_write_string(io, "name:");
|
||||
guac_write_string(io, escaped);
|
||||
guac_write_string(io, ";");
|
||||
|
||||
free(escaped);
|
||||
|
||||
}
|
||||
|
||||
void guac_send_size(GUACIO* io, int w, int h) {
|
||||
guac_write_string(io, "size:");
|
||||
guac_write_int(io, w);
|
||||
guac_write_string(io, ",");
|
||||
guac_write_int(io, h);
|
||||
guac_write_string(io, ";");
|
||||
}
|
||||
|
||||
void guac_send_clipboard(GUACIO* io, const char* data) {
|
||||
|
||||
char* escaped = guac_escape_string(data);
|
||||
|
||||
guac_write_string(io, "clipboard:");
|
||||
guac_write_string(io, escaped);
|
||||
guac_write_string(io, ";");
|
||||
|
||||
free(escaped);
|
||||
|
||||
}
|
||||
|
||||
void guac_send_error(GUACIO* io, const char* error) {
|
||||
|
||||
char* escaped = guac_escape_string(error);
|
||||
|
||||
guac_write_string(io, "error:");
|
||||
guac_write_string(io, escaped);
|
||||
guac_write_string(io, ";");
|
||||
|
||||
free(escaped);
|
||||
|
||||
}
|
||||
|
||||
void guac_send_copy(GUACIO* io, int srcx, int srcy, int w, int h, int dstx, int dsty) {
|
||||
guac_write_string(io, "copy:");
|
||||
guac_write_int(io, srcx);
|
||||
guac_write_string(io, ",");
|
||||
guac_write_int(io, srcy);
|
||||
guac_write_string(io, ",");
|
||||
guac_write_int(io, w);
|
||||
guac_write_string(io, ",");
|
||||
guac_write_int(io, h);
|
||||
guac_write_string(io, ",");
|
||||
guac_write_int(io, dstx);
|
||||
guac_write_string(io, ",");
|
||||
guac_write_int(io, dsty);
|
||||
guac_write_string(io, ";");
|
||||
}
|
||||
|
||||
void __guac_write_png(png_structp png, png_bytep data, png_size_t length) {
|
||||
|
||||
if (guac_write_base64((GUACIO*) png->io_ptr, data, length) < 0) {
|
||||
perror("Error writing PNG");
|
||||
png_error(png, "Error writing PNG");
|
||||
return;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
void __guac_write_flush(png_structp png) {
|
||||
}
|
||||
|
||||
void guac_send_png(GUACIO* io, int x, int y, png_byte** png_rows, int w, int h) {
|
||||
|
||||
png_structp png;
|
||||
png_infop png_info;
|
||||
|
||||
/* Write image */
|
||||
|
||||
/* Set up PNG writer */
|
||||
png = png_create_write_struct(PNG_LIBPNG_VER_STRING, NULL, NULL, NULL);
|
||||
if (!png) {
|
||||
perror("Error initializing libpng write structure");
|
||||
return;
|
||||
}
|
||||
|
||||
png_info = png_create_info_struct(png);
|
||||
if (!png_info) {
|
||||
perror("Error initializing libpng info structure");
|
||||
png_destroy_write_struct(&png, NULL);
|
||||
return;
|
||||
}
|
||||
|
||||
/* Set error handler */
|
||||
if (setjmp(png_jmpbuf(png))) {
|
||||
perror("Error setting handler");
|
||||
png_destroy_write_struct(&png, &png_info);
|
||||
return;
|
||||
}
|
||||
|
||||
png_set_write_fn(png, io, __guac_write_png, __guac_write_flush);
|
||||
|
||||
/* Set PNG IHDR */
|
||||
png_set_IHDR(
|
||||
png,
|
||||
png_info,
|
||||
w,
|
||||
h,
|
||||
8,
|
||||
PNG_COLOR_TYPE_RGB,
|
||||
PNG_INTERLACE_NONE,
|
||||
PNG_COMPRESSION_TYPE_DEFAULT,
|
||||
PNG_FILTER_TYPE_DEFAULT
|
||||
);
|
||||
|
||||
guac_write_string(io, "png:");
|
||||
guac_write_int(io, x);
|
||||
guac_write_string(io, ",");
|
||||
guac_write_int(io, y);
|
||||
guac_write_string(io, ",");
|
||||
png_set_rows(png, png_info, png_rows);
|
||||
png_write_png(png, png_info, PNG_TRANSFORM_IDENTITY, NULL);
|
||||
|
||||
if (guac_flush_base64(io) < 0) {
|
||||
perror("Error flushing PNG");
|
||||
png_error(png, "Error flushing PNG");
|
||||
return;
|
||||
}
|
||||
|
||||
png_destroy_write_struct(&png, &png_info);
|
||||
|
||||
guac_write_string(io, ";");
|
||||
|
||||
}
|
||||
|
||||
|
||||
void guac_send_cursor(GUACIO* io, int x, int y, png_byte** png_rows, int w, int h) {
|
||||
|
||||
png_structp png;
|
||||
png_infop png_info;
|
||||
|
||||
/* Write image */
|
||||
|
||||
/* Set up PNG writer */
|
||||
png = png_create_write_struct(PNG_LIBPNG_VER_STRING, NULL, NULL, NULL);
|
||||
if (!png) {
|
||||
perror("Error initializing libpng write structure");
|
||||
return;
|
||||
}
|
||||
|
||||
png_info = png_create_info_struct(png);
|
||||
if (!png_info) {
|
||||
perror("Error initializing libpng info structure");
|
||||
png_destroy_write_struct(&png, NULL);
|
||||
return;
|
||||
}
|
||||
|
||||
/* Set error handler */
|
||||
if (setjmp(png_jmpbuf(png))) {
|
||||
perror("Error setting handler");
|
||||
png_destroy_write_struct(&png, &png_info);
|
||||
return;
|
||||
}
|
||||
|
||||
png_set_write_fn(png, io, __guac_write_png, __guac_write_flush);
|
||||
|
||||
/* Set PNG IHDR */
|
||||
png_set_IHDR(
|
||||
png,
|
||||
png_info,
|
||||
w,
|
||||
h,
|
||||
8,
|
||||
PNG_COLOR_TYPE_RGBA,
|
||||
PNG_INTERLACE_NONE,
|
||||
PNG_COMPRESSION_TYPE_DEFAULT,
|
||||
PNG_FILTER_TYPE_DEFAULT
|
||||
);
|
||||
|
||||
guac_write_string(io, "cursor:");
|
||||
guac_write_int(io, x);
|
||||
guac_write_string(io, ",");
|
||||
guac_write_int(io, y);
|
||||
guac_write_string(io, ",");
|
||||
png_set_rows(png, png_info, png_rows);
|
||||
png_write_png(png, png_info, PNG_TRANSFORM_IDENTITY, NULL);
|
||||
|
||||
if (guac_flush_base64(io) < 0) {
|
||||
perror("Error flushing PNG");
|
||||
png_error(png, "Error flushing PNG");
|
||||
return;
|
||||
}
|
||||
|
||||
png_destroy_write_struct(&png, &png_info);
|
||||
|
||||
guac_write_string(io, ";");
|
||||
|
||||
}
|
||||
|
||||
|
||||
int __guac_fill_instructionbuf(GUACIO* io) {
|
||||
|
||||
int retval;
|
||||
|
||||
/* Attempt to fill buffer */
|
||||
retval = recv(
|
||||
io->fd,
|
||||
io->instructionbuf + io->instructionbuf_used_length,
|
||||
io->instructionbuf_size - io->instructionbuf_used_length,
|
||||
0
|
||||
);
|
||||
|
||||
if (retval < 0)
|
||||
return retval;
|
||||
|
||||
io->instructionbuf_used_length += retval;
|
||||
|
||||
/* Expand buffer if necessary */
|
||||
if (io->instructionbuf_used_length > io->instructionbuf_size / 2) {
|
||||
io->instructionbuf_size *= 2;
|
||||
io->instructionbuf = realloc(io->instructionbuf, io->instructionbuf_size);
|
||||
}
|
||||
|
||||
return retval;
|
||||
|
||||
}
|
||||
|
||||
/* Returns new instruction if one exists, or NULL if no more instructions. */
|
||||
int guac_read_instruction(GUACIO* io, guac_instruction* parsed_instruction) {
|
||||
|
||||
int retval;
|
||||
int i = 0;
|
||||
int argcount = 0;
|
||||
int j;
|
||||
int current_arg = 0;
|
||||
|
||||
/* Loop until a instruction is read */
|
||||
for (;;) {
|
||||
|
||||
/* Search for end of instruction */
|
||||
for (; i < io->instructionbuf_used_length; i++) {
|
||||
|
||||
/* Count arguments as we look for the end */
|
||||
if (io->instructionbuf[i] == ',')
|
||||
argcount++;
|
||||
else if (io->instructionbuf[i] == ':' && argcount == 0)
|
||||
argcount++;
|
||||
|
||||
/* End found ... */
|
||||
else if (io->instructionbuf[i] == ';') {
|
||||
|
||||
/* Parse new instruction */
|
||||
char* instruction = malloc(i+1);
|
||||
memcpy(instruction, io->instructionbuf, i+1);
|
||||
instruction[i] = '\0'; /* Replace semicolon with null terminator. */
|
||||
|
||||
parsed_instruction->opcode = NULL;
|
||||
|
||||
parsed_instruction->argc = argcount;
|
||||
parsed_instruction->argv = malloc(sizeof(char*) * argcount);
|
||||
|
||||
for (j=0; j<i; j++) {
|
||||
|
||||
/* If encountered a colon, and no opcode parsed yet, set opcode and following argument */
|
||||
if (instruction[j] == ':' && parsed_instruction->opcode == NULL) {
|
||||
instruction[j] = '\0';
|
||||
parsed_instruction->argv[current_arg++] = &(instruction[j+1]);
|
||||
parsed_instruction->opcode = instruction;
|
||||
}
|
||||
|
||||
/* If encountered a comma, set following argument */
|
||||
else if (instruction[j] == ',') {
|
||||
instruction[j] = '\0';
|
||||
parsed_instruction->argv[current_arg++] = &(instruction[j+1]);
|
||||
}
|
||||
}
|
||||
|
||||
/* If no arguments, set opcode to entire instruction */
|
||||
if (parsed_instruction->opcode == NULL)
|
||||
parsed_instruction->opcode = instruction;
|
||||
|
||||
/* Found. Reset buffer */
|
||||
memmove(io->instructionbuf, io->instructionbuf + i + 1, io->instructionbuf_used_length - i - 1);
|
||||
io->instructionbuf_used_length -= i + 1;
|
||||
|
||||
/* Done */
|
||||
return 1;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/* No instruction yet? Get more data ... */
|
||||
retval = guac_select(io, 1000);
|
||||
if (retval <= 0)
|
||||
return retval;
|
||||
|
||||
retval = __guac_fill_instructionbuf(io);
|
||||
if (retval < 0)
|
||||
return retval;
|
||||
|
||||
if (retval == 0)
|
||||
return -1; /* EOF */
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
void guac_free_instruction_data(guac_instruction* instruction) {
|
||||
free(instruction->opcode);
|
||||
|
||||
if (instruction->argv)
|
||||
free(instruction->argv);
|
||||
}
|
||||
|
||||
void guac_free_instruction(guac_instruction* instruction) {
|
||||
guac_free_instruction_data(instruction);
|
||||
free(instruction);
|
||||
}
|
||||
|
||||
|
||||
int guac_instructions_waiting(GUACIO* io) {
|
||||
|
||||
if (io->instructionbuf_used_length > 0)
|
||||
return 1;
|
||||
|
||||
return guac_select(io, 1000);
|
||||
}
|
||||
|
Loading…
Reference in New Issue
Block a user