Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Commit #1: The Gate One beta is about to go public.

  • Loading branch information...
commit 04f2eabdda56315b7723fe8db400167c9d89fa61 0 parents
@liftoff liftoff authored
Showing with 23,274 additions and 0 deletions.
  1. +661 −0 AGPLv3.txt
  2. +18 −0 LICENSE.txt
  3. +40 −0 README
  4. +216 −0 gateone/auth.py
  5. +130 −0 gateone/docs/Makefile
  6. BIN  gateone/docs/build/doctrees/About/index.doctree
  7. BIN  gateone/docs/build/doctrees/Developer/auth.doctree
  8. BIN  gateone/docs/build/doctrees/Developer/gateone.doctree
  9. BIN  gateone/docs/build/doctrees/Developer/index.doctree
  10. BIN  gateone/docs/build/doctrees/Developer/js_gateone.doctree
  11. BIN  gateone/docs/build/doctrees/Developer/js_go_process.doctree
  12. BIN  gateone/docs/build/doctrees/Developer/logviewer.doctree
  13. BIN  gateone/docs/build/doctrees/Developer/plugin_bookmarks.doctree
  14. BIN  gateone/docs/build/doctrees/Developer/plugin_help.doctree
  15. BIN  gateone/docs/build/doctrees/Developer/plugin_logging.doctree
  16. BIN  gateone/docs/build/doctrees/Developer/plugin_playback.doctree
  17. BIN  gateone/docs/build/doctrees/Developer/plugin_ssh.doctree
  18. BIN  gateone/docs/build/doctrees/Developer/sso.doctree
  19. BIN  gateone/docs/build/doctrees/Developer/terminal.doctree
  20. BIN  gateone/docs/build/doctrees/Developer/termio.doctree
  21. BIN  gateone/docs/build/doctrees/Developer/utils.doctree
  22. BIN  gateone/docs/build/doctrees/UserGuide/index.doctree
  23. BIN  gateone/docs/build/doctrees/environment.pickle
  24. BIN  gateone/docs/build/doctrees/index.doctree
  25. +4 −0 gateone/docs/build/html/.buildinfo
  26. +723 −0 gateone/docs/build/html/About/index.html
  27. +261 −0 gateone/docs/build/html/Developer/auth.html
  28. +431 −0 gateone/docs/build/html/Developer/gateone.html
  29. +263 −0 gateone/docs/build/html/Developer/index.html
  30. +2,676 −0 gateone/docs/build/html/Developer/js_gateone.html
  31. +119 −0 gateone/docs/build/html/Developer/js_go_process.html
  32. +236 −0 gateone/docs/build/html/Developer/logviewer.html
  33. +119 −0 gateone/docs/build/html/Developer/plugin_bookmarks.html
  34. +119 −0 gateone/docs/build/html/Developer/plugin_help.html
  35. +119 −0 gateone/docs/build/html/Developer/plugin_logging.html
  36. +119 −0 gateone/docs/build/html/Developer/plugin_playback.html
  37. +109 −0 gateone/docs/build/html/Developer/plugin_ssh.html
  38. +255 −0 gateone/docs/build/html/Developer/sso.html
  39. +661 −0 gateone/docs/build/html/Developer/terminal.html
  40. +304 −0 gateone/docs/build/html/Developer/termio.html
  41. +416 −0 gateone/docs/build/html/Developer/utils.html
  42. +382 −0 gateone/docs/build/html/UserGuide/index.html
  43. BIN  gateone/docs/build/html/_images/gateone_bellaction.png
  44. BIN  gateone/docs/build/html/_images/gateone_bookmarks_empty.png
  45. BIN  gateone/docs/build/html/_images/gateone_displaymessage.png
  46. BIN  gateone/docs/build/html/_images/gateone_displayterminfo.png
  47. BIN  gateone/docs/build/html/_images/gateone_grid_view.png
  48. BIN  gateone/docs/build/html/_images/gateone_infopanel.png
  49. BIN  gateone/docs/build/html/_images/gateone_login.png
  50. BIN  gateone/docs/build/html/_images/gateone_login_explained.png
  51. BIN  gateone/docs/build/html/_images/gateone_new_bookmark1.png
  52. BIN  gateone/docs/build/html/_images/gateone_new_bookmark2.png
  53. BIN  gateone/docs/build/html/_images/gateone_new_bookmark3.png
  54. BIN  gateone/docs/build/html/_images/gateone_new_bookmark4.png
  55. BIN  gateone/docs/build/html/_images/gateone_opened_via_bookmark.png
  56. BIN  gateone/docs/build/html/_images/gateone_second_session_no_password.png
  57. BIN  gateone/docs/build/html/_images/gateone_settingspanel.png
  58. +307 −0 gateone/docs/build/html/_modules/auth.html
  59. +1,289 −0 gateone/docs/build/html/_modules/gateone.html
  60. +96 −0 gateone/docs/build/html/_modules/index.html
  61. +387 −0 gateone/docs/build/html/_modules/logviewer.html
  62. +298 −0 gateone/docs/build/html/_modules/sso.html
  63. +1,899 −0 gateone/docs/build/html/_modules/terminal.html
  64. +599 −0 gateone/docs/build/html/_modules/termio.html
  65. +627 −0 gateone/docs/build/html/_modules/utils.html
  66. +466 −0 gateone/docs/build/html/_sources/About/index.txt
  67. +7 −0 gateone/docs/build/html/_sources/Developer/auth.txt
  68. +7 −0 gateone/docs/build/html/_sources/Developer/gateone.txt
  69. +45 −0 gateone/docs/build/html/_sources/Developer/index.txt
  70. +1,765 −0 gateone/docs/build/html/_sources/Developer/js_gateone.txt
  71. +2 −0  gateone/docs/build/html/_sources/Developer/js_go_process.txt
  72. +7 −0 gateone/docs/build/html/_sources/Developer/logviewer.txt
  73. +2 −0  gateone/docs/build/html/_sources/Developer/plugin_bookmarks.txt
  74. +2 −0  gateone/docs/build/html/_sources/Developer/plugin_help.txt
  75. +2 −0  gateone/docs/build/html/_sources/Developer/plugin_logging.txt
  76. +2 −0  gateone/docs/build/html/_sources/Developer/plugin_playback.txt
  77. +2 −0  gateone/docs/build/html/_sources/Developer/plugin_ssh.txt
  78. +7 −0 gateone/docs/build/html/_sources/Developer/sso.txt
  79. +7 −0 gateone/docs/build/html/_sources/Developer/terminal.txt
  80. +7 −0 gateone/docs/build/html/_sources/Developer/termio.txt
  81. +7 −0 gateone/docs/build/html/_sources/Developer/utils.txt
  82. +208 −0 gateone/docs/build/html/_sources/UserGuide/index.txt
  83. +15 −0 gateone/docs/build/html/_sources/index.txt
  84. +74 −0 gateone/docs/build/html/_static/ansi.css
  85. +535 −0 gateone/docs/build/html/_static/basic.css
  86. +288 −0 gateone/docs/build/html/_static/default.css
  87. +247 −0 gateone/docs/build/html/_static/doctools.js
  88. BIN  gateone/docs/build/html/_static/file.png
  89. +154 −0 gateone/docs/build/html/_static/jquery.js
  90. BIN  gateone/docs/build/html/_static/minus.png
  91. BIN  gateone/docs/build/html/_static/plus.png
  92. +62 −0 gateone/docs/build/html/_static/pygments.css
  93. +521 −0 gateone/docs/build/html/_static/searchtools.js
  94. +148 −0 gateone/docs/build/html/_static/sidebar.js
  95. +16 −0 gateone/docs/build/html/_static/underscore.js
  96. +641 −0 gateone/docs/build/html/genindex.html
  97. +145 −0 gateone/docs/build/html/index.html
  98. BIN  gateone/docs/build/html/objects.inv
  99. +162 −0 gateone/docs/build/html/py-modindex.html
  100. +103 −0 gateone/docs/build/html/search.html
  101. +1 −0  gateone/docs/build/html/searchindex.js
  102. +1 −0  gateone/docs/html
  103. +466 −0 gateone/docs/source/About/index.rst
  104. +7 −0 gateone/docs/source/Developer/auth.rst
  105. +7 −0 gateone/docs/source/Developer/gateone.rst
  106. +45 −0 gateone/docs/source/Developer/index.rst
  107. +1,765 −0 gateone/docs/source/Developer/js_gateone.rst
  108. +2 −0  gateone/docs/source/Developer/js_go_process.rst
  109. +7 −0 gateone/docs/source/Developer/logviewer.rst
  110. +2 −0  gateone/docs/source/Developer/plugin_bookmarks.rst
  111. +2 −0  gateone/docs/source/Developer/plugin_help.rst
  112. +2 −0  gateone/docs/source/Developer/plugin_logging.rst
  113. +2 −0  gateone/docs/source/Developer/plugin_playback.rst
  114. +2 −0  gateone/docs/source/Developer/plugin_ssh.rst
  115. BIN  gateone/docs/source/Developer/screenshots/gateone_bellaction.png
  116. BIN  gateone/docs/source/Developer/screenshots/gateone_displaymessage.png
  117. BIN  gateone/docs/source/Developer/screenshots/gateone_displayterminfo.png
  118. +7 −0 gateone/docs/source/Developer/sso.rst
  119. +7 −0 gateone/docs/source/Developer/terminal.rst
  120. +7 −0 gateone/docs/source/Developer/termio.rst
  121. +7 −0 gateone/docs/source/Developer/utils.rst
  122. +208 −0 gateone/docs/source/UserGuide/index.rst
  123. BIN  gateone/docs/source/UserGuide/screenshots/gateone_bookmarks_empty.png
  124. BIN  gateone/docs/source/UserGuide/screenshots/gateone_grid_view.png
  125. BIN  gateone/docs/source/UserGuide/screenshots/gateone_infopanel.png
  126. BIN  gateone/docs/source/UserGuide/screenshots/gateone_login.png
  127. BIN  gateone/docs/source/UserGuide/screenshots/gateone_login_explained.png
  128. BIN  gateone/docs/source/UserGuide/screenshots/gateone_new_bookmark1.png
  129. BIN  gateone/docs/source/UserGuide/screenshots/gateone_new_bookmark2.png
  130. BIN  gateone/docs/source/UserGuide/screenshots/gateone_new_bookmark3.png
  131. BIN  gateone/docs/source/UserGuide/screenshots/gateone_new_bookmark4.png
  132. BIN  gateone/docs/source/UserGuide/screenshots/gateone_opened_via_bookmark.png
  133. BIN  gateone/docs/source/UserGuide/screenshots/gateone_second_session_no_password.png
  134. BIN  gateone/docs/source/UserGuide/screenshots/gateone_settingspanel.png
  135. +74 −0 gateone/docs/source/_static/ansi.css
  136. +535 −0 gateone/docs/source/_static/basic.css
  137. +288 −0 gateone/docs/source/_static/default.css
  138. +276 −0 gateone/docs/source/conf.py
  139. +15 −0 gateone/docs/source/index.rst
Sorry, we could not display the entire diff because it was too big.
661 AGPLv3.txt
@@ -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/>.
18 LICENSE.txt
@@ -0,0 +1,18 @@
+COPYRIGHT NOTICE
+================
+Gate One and all bundled original code...
+
+ Copyright 2011 Liftoff Software Corporation
+
+Gate One is dual-licensed: AGPLv3 or Proprietary.
+
+Unless you have been granted a license from Liftoff Software, Gate One and all
+bundled software--except where noted--is licensed under the GNU Affero General
+Public License version 3. A copy of the AGPLv3 license should have been
+included with the Gate One software as AGPLv3.txt. If not, a copy may be
+obtained by visiting:
+
+ http://www.gnu.org/licenses/agpl.html
+
+If the terms of the AGPLv3 license do not suit your needs, a proprietary
+license may be purchased from Liftoff Software: http://liftoffsoftware.com/
40 README
@@ -0,0 +1,40 @@
+Gate One is an HTML5 web-based terminal emulator and SSH client. Top features:
+
+ * No browser plugins required!
+ * Supports multiple simultaneous terminal sessions. As many as your
+ hardware can handle.
+ * Users can re-connect to their running terminals whenever they like from
+ anywhere.
+ * Can be embedded into other applications. Add a terminal--running whatever
+ application(s) you want--to your web app! Would be vastly superior to
+ say, a Java-based serial console applet (hint hint).
+ * Includes powerful plugin system that supports plugins written in Python,
+ JavaScript, and even CSS (yes, you can write a CSS-only plugin).
+ * The Gate One server can be stopped & started without users losing their
+ running terminal applications (even SSH sessions stay connected!). In
+ essence, worry-free upgrades!
+ * The SSH plugin allows users to duplicate sessions without having to
+ re-enter their username and password (it re-uses the existing SSH tunnel).
+ * Provides users with the ability to play back and save/share their terminal
+ sessions via a self-contained HTML playback file.
+ * Similarly, supports server-side logging, recording, and video-like
+ playback of user sessions. It can even log to syslog to support
+ whatever centralized logging system you want.
+ * Keberos-based Single Sign-on support is included. It even works with
+ Active Directory. Other authentication options are available as well.
+
+All documentation is in the "gateone/docs" directory. The HTML documentation is
+pre-built and ready-to-read.
+
+IMPORTANT: Gate One is currently IN BETA. Some things may be incomplete or
+buggy. Feel free to open new tickets in the issue tracker!
+
+FYI: Gate One was developed entirely by one guy in his spare time over the
+course of ~9 months. It turned out pretty good so he's looking to start a
+business out of it. What better way to create jobs than to start by creating
+one for yourself? All feedback, tips, and advice is appreciated:
+
+ daniel.mcdougall@liftoffsoftware.com
+
+NOTE: http://liftoffsoftware.com/ hasn't been built yet so links pointing there
+will be dead for a while.
216 gateone/auth.py
@@ -0,0 +1,216 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2011 Liftoff Software Corporation
+#
+
+# Meta
+__version__ = '0.9'
+__license__ = "AGPLv3 or Proprietary (see LICENSE.txt)"
+__version_info__ = (0, 9)
+__author__ = 'Dan McDougall <daniel.mcdougall@liftoffsoftware.com>'
+
+__doc__ = """\
+Authentication
+==============
+This module contains Gate One's authentication classes. They map to Gate One's
+--auth configuration option like so:
+
+=============== ===================
+--auth=none NullAuthHandler
+--auth=kerberos KerberosAuthHandler
+--auth=google GoogleAuthHandler
+=============== ===================
+
+None or Anonymous
+-----------------
+By default Gate One will not authenticate users. This means that user sessions
+will be tied to their browser cookie and users will not be able to resume their
+sessions from another computer/browser. Most useful for situations where
+session persistence and logging aren't important.
+
+*All* users will show up as %anonymous using this authentication type.
+
+.. note:: The % is there to avoid name conflicts.
+
+Kerberos
+--------
+Kerberos authentication utilizes GSSAPI for Single Sign-on (SSO) but will fall
+back to HTTP Basic authentication if GSSAPI auth fails. This authentication
+type can be integrated into any Kerberos infrastructure including Windows
+Active Directory.
+
+It is great for both transparent authentication and being able to tie sessions
+and logs to specific users within your organization (compliance).
+
+.. note:: The sso.py module itself has extensive documentation on this authentication type.
+
+Google Authentication
+---------------------
+If you want persistent user sessions but don't care to run your own
+authentication infrastructure this authentication type is for you. Assuming,
+of course, that your Gate One server and clients will have access to the
+Internet.
+
+.. note:: This authentication type is perfect if you're using Chromebooks (Chrome OS devices).
+
+Docstrings
+==========
+"""
+
+# Import stdlib stuff
+import os
+import logging
+
+# Import our own stuff
+from utils import mkdir_p, generate_session_id
+
+# 3rd party imports
+import tornado.web
+import tornado.auth
+import tornado.escape
+
+class BaseAuthHandler(tornado.web.RequestHandler):
+ """The base class for all Gate One authentication handlers."""
+ def get_current_user(self):
+ """Tornado standard method--implemented our way."""
+ user_json = self.get_secure_cookie("user")
+ if not user_json: return None
+ return tornado.escape.json_decode(user_json)
+
+ def user_login(self, user):
+ """
+ Called immediately after a user authenticates successfully. Saves
+ session information in the user's directory. Expects *user* to be a
+ string containing the username or userPrincipalName. e.g. 'user@REALM'
+ or just 'someuser'.
+ """
+ # Make a directory to store this user's settings/files/logs/etc
+ user_dir = self.settings['user_dir'] + "/" + user
+ logging.info("Creating user directory: %s" % user_dir)
+ mkdir_p(user_dir)
+ os.chmod(user_dir, 0700)
+ session_file = user_dir + '/session'
+ if os.path.exists(session_file):
+ session_data = open(session_file).read()
+ session_info = tornado.escape.json_decode(session_data)
+ else:
+ with open(session_file, 'w') as f:
+ # Save it so we can keep track across multiple clients
+ session_info = {
+ 'go_upn': user, # FYI: UPN == userPrincipalName
+ 'go_session': generate_session_id()
+ }
+ session_info_json = tornado.escape.json_encode(session_info)
+ f.write(session_info_json)
+ self.set_secure_cookie("user", tornado.escape.json_encode(session_info))
+
+ def user_logout(self, user):
+ """
+ Called immediately after a user logs out. Doesn't actually do
+ anything. Just potential future use at this point.
+ """
+ pass # Nothing here yet but someone might want to override it
+
+class NullAuthHandler(BaseAuthHandler):
+ """
+ A handler for when no authentication method is chosen (i.e. --auth=none).
+ """
+ def get(self):
+ """
+ Sets the 'user' cookie with a new random session ID (*go_session*) and
+ sets *go_upn* to '%anonymous'.
+ """
+ # % is valid on the filesystem but invalid for an actual username.
+ # This ensures we won't have a conflict at some point with an actual
+ # user.
+ user = r'%anonymous'
+ self.user_login(user) # Takes care of the user's settings dir
+ user_cookie = {
+ 'go_upn': user,
+ 'go_session': generate_session_id()
+ }
+ self.set_secure_cookie("user", tornado.escape.json_encode(user_cookie))
+ next_url = self.get_argument("next", None)
+ if next_url:
+ self.redirect(next_url)
+ else:
+ self.redirect("/")
+
+class GoogleAuthHandler(BaseAuthHandler, tornado.auth.GoogleMixin):
+ """
+ Google authentication handler.
+ """
+ @tornado.web.asynchronous
+ def get(self):
+ """
+ Sets the 'user' cookie with an appropriate *go_upn* and *go_session*.
+ """
+ if self.get_argument("openid.mode", None):
+ self.get_authenticated_user(self._on_auth)
+ return
+ self.authenticate_redirect(
+ ax_attrs=["name","email","language","username"])
+
+ def _on_auth(self, user):
+ """
+ Just a continuation of the get() method (the final step where it
+ actually sets the cookie).
+ """
+ if not user:
+ raise tornado.web.HTTPError(500, "Google auth failed")
+ print("GoogleAuthLoginHandler user: %s" % user)
+ # NOTE: Google auth 'user' will be a dict like so:
+ # user: {
+ # 'locale': u'en-us',
+ # 'first_name': u'Dan',
+ # 'last_name': u'McDougall',
+ # 'name': u'Dan McDougall',
+ # 'email': u'riskable@gmail.com'}
+ # Named these 'go_<whatever>' since that is less likely to conflict with
+ # anything in the future (should some auth mechanism start returning
+ # session IDs of some sort).
+ self.user_login(user) # This takes care of the user's settings dir
+ user_cookie = { # Don't need all that other stuff
+ 'go_session': generate_session_id(),
+ 'go_upn': user['email'] # Just an equivalent for standardization
+ }
+ self.set_secure_cookie("user", tornado.escape.json_encode(user_cookie))
+ next_url = self.get_argument("next", None)
+ if next_url:
+ self.redirect(next_url)
+ else:
+ self.redirect("/")
+
+# Add our KerberosAuthHandler if sso is available
+KerberosAuthHandler = None
+try:
+ from sso import KerberosAuthMixin
+ class KerberosAuthHandler(BaseAuthHandler, KerberosAuthMixin):
+ """
+ Handles authenticating users via Kerberos/GSSAPI/SSO.
+ """
+ def get(self):
+ """
+ Checks the user's request header for the proper Authorization data. If
+ it checks out the user will be logged in via _on_auth(). If not, the
+ browser will be redirected to login.
+ """
+ auth_header = self.request.headers.get('Authorization')
+ if auth_header:
+ self.get_authenticated_user(self._on_auth)
+ return
+ self.authenticate_redirect()
+
+ def _on_auth(self, user):
+ if not user:
+ raise tornado.web.HTTPError(500, "Kerberos auth failed")
+ self.user_login(user) # This takes care of the user's settings dir
+ # TODO: Add some LDAP or local DB lookups here to add more detail to user objects
+ logging.debug("KerberosAuthHandler user: %s" % user)
+ next_url = self.get_argument("next", None)
+ if next_url:
+ self.redirect(next_url)
+ else:
+ self.redirect("/")
+except ImportError:
+ pass # No SSO available.
130 gateone/docs/Makefile
@@ -0,0 +1,130 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/GateOne.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/GateOne.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/GateOne"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/GateOne"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
BIN  gateone/docs/build/doctrees/About/index.doctree
Binary file not shown
BIN  gateone/docs/build/doctrees/Developer/auth.doctree
Binary file not shown
BIN  gateone/docs/build/doctrees/Developer/gateone.doctree
Binary file not shown
BIN  gateone/docs/build/doctrees/Developer/index.doctree
Binary file not shown
BIN  gateone/docs/build/doctrees/Developer/js_gateone.doctree
Binary file not shown
BIN  gateone/docs/build/doctrees/Developer/js_go_process.doctree
Binary file not shown
BIN  gateone/docs/build/doctrees/Developer/logviewer.doctree
Binary file not shown
BIN  gateone/docs/build/doctrees/Developer/plugin_bookmarks.doctree
Binary file not shown
BIN  gateone/docs/build/doctrees/Developer/plugin_help.doctree
Binary file not shown
BIN  gateone/docs/build/doctrees/Developer/plugin_logging.doctree
Binary file not shown
BIN  gateone/docs/build/doctrees/Developer/plugin_playback.doctree
Binary file not shown
BIN  gateone/docs/build/doctrees/Developer/plugin_ssh.doctree
Binary file not shown
BIN  gateone/docs/build/doctrees/Developer/sso.doctree
Binary file not shown
BIN  gateone/docs/build/doctrees/Developer/terminal.doctree
Binary file not shown
BIN  gateone/docs/build/doctrees/Developer/termio.doctree
Binary file not shown
BIN  gateone/docs/build/doctrees/Developer/utils.doctree
Binary file not shown
BIN  gateone/docs/build/doctrees/UserGuide/index.doctree
Binary file not shown
BIN  gateone/docs/build/doctrees/environment.pickle
Binary file not shown
BIN  gateone/docs/build/doctrees/index.doctree
Binary file not shown
4 gateone/docs/build/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 975d34928253134b1358b1a67ae47310
+tags: fbb0d17656682115ca4d033fb2f83ba1
723 gateone/docs/build/html/About/index.html
@@ -0,0 +1,723 @@
+
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>About Gate One &mdash; Gate One v0.9 documentation</title>
+ <link rel="stylesheet" href="../_static/default.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/ansi.css" type="text/css" />
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '0.9',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <link rel="top" title="Gate One v0.9 documentation" href="../index.html" />
+ <link rel="next" title="User Guide" href="../UserGuide/index.html" />
+ <link rel="prev" title="Gate One Documentation" href="../index.html" />
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="right" >
+ <a href="../UserGuide/index.html" title="User Guide"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="../index.html" title="Gate One Documentation"
+ accesskey="P">previous</a> |</li>
+ <li><a href="../index.html">Gate One Documentation</a> &raquo;</li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <div class="section" id="about-gate-one">
+<h1>About Gate One<a class="headerlink" href="#about-gate-one" title="Permalink to this headline">¶</a></h1>
+<p>Gate One is an open source, web-based terminal emulator with a powerful plugin system. It comes bundled with a plugin that turns Gate One into an amazing SSH client but Gate One can actually be used to run <em>any</em> terminal application. You can even embed Gate One into other applications to provide an interface into serial consoles, virtual servers, or anything you like. It's a great supplement to any web-based administration interface.</p>
+<p>Gate One works in any browser that supports WebSockets. No browser plugins required!</p>
+<div class="section" id="licensing">
+<h2>Licensing<a class="headerlink" href="#licensing" title="Permalink to this headline">¶</a></h2>
+<p>Gate One is released under a dual-license model. You are free to choose the license that best meets your requirements:</p>
+<blockquote>
+<div><ul class="simple">
+<li>The <a class="reference external" href="http://www.gnu.org/licenses/agpl.html">GNU Affero General Public License version 3 (AGPLv3)</a>.</li>
+<li>Gate One Commercial licensing.</li>
+</ul>
+</div></blockquote>
+<div class="section" id="open-source-license-requirements">
+<h3>Open Source License Requirements<a class="headerlink" href="#open-source-license-requirements" title="Permalink to this headline">¶</a></h3>
+<p>The <abbr title="GNU Affero General Public License version 3">AGPLv3</abbr> is similar to the <abbr title="GNU General Public License version 3">GPLv3</abbr> in that it requires that you publicly release the source code of your application if you distribute binaries that use Gate One. However, it has an additional obligation: You must make your source code available to everyone if your application is provided as Software-as-a-Service (SaaS) or it's part of an Application Service Provider solution.</p>
+<p>For example, if you're running Gate One on your server as part of a SaaS solution you must give away all of your source code.</p>
+<p>Here are some examples where Open Source licensing makes sense:</p>
+<blockquote>
+<div><ul class="simple">
+<li>Pre-installing Gate One as part of an open source Linux distribution.</li>
+<li>Embedding Gate One into an open source application that is licensed under the AGPLv3 <em>or</em> the GPLv3 <a class="footnote-reference" href="#f1" id="id1">[1]</a>.</li>
+<li>Bundling Gate One with an open source appliance.</li>
+<li>Making Gate One available as part of an open source software repository.</li>
+</ul>
+</div></blockquote>
+<p><strong>Considerations:</strong> Unless you want your source code to be freely available to everyone you should opt for Gate One's Commercial License.</p>
+</div>
+<div class="section" id="gate-one-commercial-licensing">
+<h3>Gate One Commercial Licensing<a class="headerlink" href="#gate-one-commercial-licensing" title="Permalink to this headline">¶</a></h3>
+<p>The Commercial License offerings for Gate One are very flexible and afford businesses the flexibility to include Gate One as part of their products and services without any source code obligations. It also provides licensees with a fully-supported solution and assurances.</p>
+<p>Here are some examples where commercial licensing is typically necessary:</p>
+<blockquote>
+<div><ul class="simple">
+<li>Including Gate One in software sold to customers who install it on their own equipment.</li>
+<li>Selling software that requires the installation of Gate One.</li>
+<li>Selling hardware that comes with Gate One pre-installed.</li>
+<li>Bundling with or including Gate One in any product protected by patents whereby you do not wish to indemnify the end-user from all patent obligations related to the purchase or use of the product.</li>
+</ul>
+</div></blockquote>
+<p>If you merely install Gate One for production use in your business you do not need a commercial license. For these situations, Liftoff Software offers a number of commercial support and assurance options.</p>
+<p>For more information on Gate One Commercial Licensing or support please visit our <a class="reference external" href="http://liftoffsoftware.com">website</a> (NOTE: Site may not be live yet).</p>
+</div>
+</div>
+<div class="section" id="requirements">
+<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
+<p>In order to use Gate One you'll need to install the Tornado framework. You'll get additional functionality if you also install pyOpenSSL and the python-kerberos module. All three can usually be taken care of in a single command:</p>
+<pre class="ansi-block literal-block">
+<span class="ansi-bold ansi-blue">user</span>&#64;modern-host<span class="ansi-bold ansi-blue">:~ $</span> sudo pip install tornado pyopenssl kerberos
+</pre>
+<p>...or if you have an older operating system:</p>
+<pre class="ansi-block literal-block">
+<span class="ansi-bold ansi-blue">user</span>&#64;legacy-host<span class="ansi-bold ansi-blue">:~ $</span> sudo easy_install tornado pyopenssl kerberos
+</pre>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">The use of pip is recommended. See <a class="reference external" href="http://www.pip-installer.org/en/latest/installing.html">http://www.pip-installer.org/en/latest/installing.html</a> if you don't have it.</p>
+</div>
+</div>
+<div class="section" id="installation">
+<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
+<p>Gate One can be installed via a number of methods, depending on which package you've got. Assuming you've downloaded the appropriate Gate One package for your operating system to your home directory...</p>
+<div class="section" id="rpm-based-linux-distributions">
+<h3>RPM-based Linux Distributions<a class="headerlink" href="#rpm-based-linux-distributions" title="Permalink to this headline">¶</a></h3>
+<pre class="ansi-block literal-block">
+<span class="ansi-bold ansi-blue">user</span>&#64;redhat<span class="ansi-bold ansi-blue">:~ $</span> sudo rpm -Uvh gateone*.rpm
+</pre>
+</div>
+<div class="section" id="debian-based-linux-distributions">
+<h3>Debian-based Linux Distributions<a class="headerlink" href="#debian-based-linux-distributions" title="Permalink to this headline">¶</a></h3>
+<pre class="ansi-block literal-block">
+<span class="ansi-bold ansi-blue">user</span>&#64;ubuntu<span class="ansi-bold ansi-blue">:~ $</span> sudo dpkg -i gateone*.deb
+</pre>
+</div>
+<div class="section" id="from-source">
+<h3>From Source<a class="headerlink" href="#from-source" title="Permalink to this headline">¶</a></h3>
+<pre class="ansi-block literal-block">
+<span class="ansi-bold ansi-blue">user</span>&#64;whatever<span class="ansi-bold ansi-blue">:~ $</span> tar zxvf gateone*.tar.gz; cd gateone*; sudo python setup.py install
+</pre>
+<p>This translates to: Extract; Change into the gateone* directory; Install.</p>
+</div>
+</div>
+<div class="section" id="configuration">
+<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
+<p>The first time you execute gateone.py it will create a default configuration file as /opt/gateone/server.conf:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">user_dir</span> <span class="o">=</span> <span class="s">&quot;/opt/gateone/users&quot;</span>
+<span class="n">log_file_num_backups</span> <span class="o">=</span> <span class="mi">10</span>
+<span class="n">certificate</span> <span class="o">=</span> <span class="s">&quot;/opt/gateone/certificate.pem&quot;</span>
+<span class="n">sso_service</span> <span class="o">=</span> <span class="s">&quot;HTTP&quot;</span>
+<span class="n">dtach</span> <span class="o">=</span> <span class="bp">True</span>
+<span class="n">embedded</span> <span class="o">=</span> <span class="bp">False</span>
+<span class="n">session_logging</span> <span class="o">=</span> <span class="bp">True</span>
+<span class="n">sso_realm</span> <span class="o">=</span> <span class="s">&quot;EXAMPLE.COM&quot;</span>
+<span class="n">auth</span> <span class="o">=</span> <span class="bp">None</span>
+<span class="n">log_file_prefix</span> <span class="o">=</span> <span class="s">&quot;/var/log/gateone/webserver.log&quot;</span>
+<span class="n">log_file_max_size</span> <span class="o">=</span> <span class="mi">104857600</span>
+<span class="n">session_dir</span> <span class="o">=</span> <span class="s">&quot;/tmp/gateone&quot;</span>
+<span class="n">cookie_secret</span> <span class="o">=</span> <span class="s">&quot;A45CharacterStringGeneratedAtRandom012345678&quot;</span>
+<span class="n">syslog_session_logging</span> <span class="o">=</span> <span class="bp">False</span>
+<span class="n">syslog_facility</span> <span class="o">=</span> <span class="s">&quot;daemon&quot;</span>
+<span class="n">address</span> <span class="o">=</span> <span class="s">&quot;0.0.0.0&quot;</span>
+<span class="n">debug</span> <span class="o">=</span> <span class="bp">False</span>
+<span class="n">command</span> <span class="o">=</span> <span class="s">&quot;/opt/gateone/plugins/ssh/scripts/ssh_connect.py -S &#39;/tmp/gateone/%SESSION%/</span><span class="si">%r</span><span class="s">@%h:%p&#39; -a &#39;-oUserKnownHostsFile=%USERDIR%/%USER%/known_hosts&#39;&quot;</span>
+<span class="n">session_timeout</span> <span class="o">=</span> <span class="s">&quot;5d&quot;</span>
+<span class="n">keyfile</span> <span class="o">=</span> <span class="s">&quot;/opt/gateone/keyfile.pem&quot;</span>
+<span class="n">port</span> <span class="o">=</span> <span class="mi">443</span>
+</pre></div>
+</div>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">The order of these settings does not matter.</p>
+</div>
+<p>These options match up directly with Gate One's command line options which you can view at any time by executing &quot;gateone.py --help&quot;:</p>
+<pre class="ansi-block literal-block">
+<span class="ansi-bold ansi-red">root</span>&#64;host<span class="ansi-bold ansi-blue">:~ $</span> ./gateone.py --help
+Usage: ./gateone.py [OPTIONS]
+
+Options:
+&nbsp;&nbsp;--help show this help information
+&nbsp;&nbsp;--log_file_max_size max size of log files before rollover
+&nbsp;&nbsp;--log_file_num_backups number of log files to keep
+&nbsp;&nbsp;--log_file_prefix=PATH Path prefix for log files. Note that if you are running multiple tornado processes, log_file_prefix must be different for each of them (e.g. include the port number)
+&nbsp;&nbsp;--log_to_stderr Send log output to stderr (colorized if possible). By default use stderr if --log_file_prefix is not set and no other logging is configured.
+&nbsp;&nbsp;--logging=info|warning|error|none Set the Python log level. If 'none', tornado won't touch the logging configuration.
+&nbsp;&nbsp;--address Run on the given address.
+&nbsp;&nbsp;--auth Authentication method to use. Valid options are: none, kerberos, google.
+&nbsp;&nbsp;--certificate Path to the SSL certificate. Will be auto-generated if none is provided.
+&nbsp;&nbsp;--command Run the given command when a user connects (e.g. 'nethack').
+&nbsp;&nbsp;--cookie_secret Use the given 45-character string for cookie encryption.
+&nbsp;&nbsp;--debug Enable debugging features such as auto-restarting when files are modified.
+&nbsp;&nbsp;--disable_ssl If enabled, Gate One will run without SSL (generally not a good idea).
+&nbsp;&nbsp;--dtach Wrap terminals with dtach. Allows sessions to be resumed even if Gate One is stopped and started (which is a sweet feature =).
+&nbsp;&nbsp;--embedded Run Gate One in Embedded Mode (no toolbar, only one terminal allowed, etc. See docs).
+&nbsp;&nbsp;--keyfile Path to the SSL keyfile. Will be auto-generated if none is provided.
+&nbsp;&nbsp;--kill Kill any running Gate One terminal processes including dtach'd processes.
+&nbsp;&nbsp;--port Run on the given port.
+&nbsp;&nbsp;--session_dir Path to the location where session information will be stored.
+&nbsp;&nbsp;--session_logging If enabled, logs of user sessions will be saved in &lt;user_dir&gt;/logs. Default: Enabled
+&nbsp;&nbsp;--session_timeout Amount of time that a session should be kept alive after the client has logged out. Accepts &lt;num&gt;X where X could be one of s, m, h, or d for seconds, minutes, hours, and days. Default is '5d' (5 days).
+&nbsp;&nbsp;--sso_realm Kerberos REALM (aka DOMAIN) to use when authenticating clients. Only relevant if Kerberos authentication is enabled.
+&nbsp;&nbsp;--sso_service Kerberos service (aka application) to use. Defaults to HTTP. Only relevant if Kerberos authentication is enabled.
+&nbsp;&nbsp;--syslog_facility Syslog facility to use when logging to syslog (if syslog_session_logging is enabled). Must be one of: auth, cron, daemon, kern, local0, local1, local2, local3, local4, local5, local6, local7, lpr, mail, news, syslog, user, uucp. Default: daemon
+&nbsp;&nbsp;--syslog_session_logging If enabled, logs of user sessions will be written to syslog.
+&nbsp;&nbsp;--user_dir Path to the location where user files will be stored.
+</pre>
+<p>These options are detailed below in the format of:</p>
+<blockquote>
+<div><div class="line-block">
+<div class="line">Name</div>
+</div>
+<dl class="option">
+<dt id="cmdoption--command_line_option">
+<tt class="descname">--command_line_option</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption--command_line_option" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><pre>Default value as it is defined in server.conf</pre>
+</div>
+<div class="line-block">
+<div class="line">Description</div>
+</div>
+</div></blockquote>
+<div class="section" id="log-file-max-size">
+<h3>log_file_max_size<a class="headerlink" href="#log-file-max-size" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--log_file_max_size">
+<tt class="descname">--log_file_max_size</tt><tt class="descclassname">=bytes</tt><a class="headerlink" href="#cmdoption--log_file_max_size" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="n">log_file_max_size</span> <span class="o">=</span> <span class="mi">104857600</span> <span class="c"># Which is the result of: 100 * 1024 * 1024</span>
+</pre></div>
+</div>
+<p>This defines the maximum size of Gate One's web server log file in bytes before it is automatically rotated.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">Web server log settings don't apply to Gate One's user session logging features.</p>
+</div>
+</div>
+<div class="section" id="log-file-num-backups">
+<h3>log_file_num_backups<a class="headerlink" href="#log-file-num-backups" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--log_file_num_backups">
+<tt class="descname">--log_file_num_backups</tt><tt class="descclassname">=integer</tt><a class="headerlink" href="#cmdoption--log_file_num_backups" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="n">log_file_max_size</span> <span class="o">=</span> <span class="mi">10</span>
+</pre></div>
+</div>
+<p>The maximum number of backups to keep of Gate One's web server logs.</p>
+</div>
+<div class="section" id="log-file-prefix">
+<h3>log_file_prefix<a class="headerlink" href="#log-file-prefix" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--log_file_prefix">
+<tt class="descname">--log_file_prefix</tt><tt class="descclassname">=string (file path)</tt><a class="headerlink" href="#cmdoption--log_file_prefix" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="n">log_file_prefix</span> <span class="o">=</span> <span class="s">&quot;/var/log/gateone/webserver.log&quot;</span>
+</pre></div>
+</div>
+<p>This is the path where Gate One's web server logs will be kept. You'll get an error message if Gate One doesn't have permission to create the parent directory (if it doesn't exist) or if it can't write to files there.</p>
+</div>
+<div class="section" id="log-to-stderr">
+<h3>log_to_stderr<a class="headerlink" href="#log-to-stderr" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--log_to_stderr">
+<tt class="descname">--log_to_stderr</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption--log_to_stderr" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="n">log_file_prefix</span> <span class="o">=</span> <span class="bp">False</span>
+</pre></div>
+</div>
+<p>This option tells Gate One to send web server logs to stderr (instead of to the log file).</p>
+</div>
+<div class="section" id="logging">
+<h3>logging<a class="headerlink" href="#logging" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--logging">
+<tt class="descname">--logging</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption--logging" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="n">logging</span> <span class="o">=</span> <span class="s">&quot;info&quot;</span>
+</pre></div>
+</div>
+<p>Specifies the log level of the web server logs. The default is &quot;info&quot;. Can be one of, &quot;info&quot;, &quot;warning&quot;, &quot;error&quot;, or &quot;none&quot;.</p>
+</div>
+<div class="section" id="address">
+<h3>address<a class="headerlink" href="#address" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--address">
+<tt class="descname">--address</tt><tt class="descclassname">=string (IP address)</tt><a class="headerlink" href="#cmdoption--address" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="n">address</span> <span class="o">=</span> <span class="s">&quot;0.0.0.0&quot;</span>
+</pre></div>
+</div>
+<p>The address that Gate One will listen for connections. Default is &quot;0.0.0.0&quot; (all addresses).</p>
+</div>
+<div class="section" id="auth">
+<h3>auth<a class="headerlink" href="#auth" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--auth">
+<tt class="descname">--auth</tt><tt class="descclassname">=string (none|google|kerberos)</tt><a class="headerlink" href="#cmdoption--auth" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="n">auth</span> <span class="o">=</span> <span class="bp">None</span> <span class="c"># NOTE: &quot;none&quot; (in quotes) also works.</span>
+</pre></div>
+</div>
+<p>Specifies how you want Gate One to authenticate clients. One of, &quot;none&quot;, &quot;google&quot;, or &quot;kerberos&quot;.</p>
+</div>
+<div class="section" id="certificate">
+<h3>certificate<a class="headerlink" href="#certificate" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--certificate">
+<tt class="descname">--certificate</tt><tt class="descclassname">=string (file path)</tt><a class="headerlink" href="#cmdoption--certificate" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="n">certificate</span> <span class="o">=</span> <span class="s">&quot;/opt/gateone/certificate.pem&quot;</span> <span class="c"># NOTE: The actual default is &quot;&lt;path to gateone&gt;/certificate.pem&quot;</span>
+</pre></div>
+</div>
+<p>The path to the SSL certificate Gate One will use in its web server.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">The file must be in PEM format.</p>
+</div>
+</div>
+<div class="section" id="command">
+<h3>command<a class="headerlink" href="#command" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--command">
+<tt class="descname">--command</tt><tt class="descclassname">=string (program path)</tt><a class="headerlink" href="#cmdoption--command" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="n">command</span> <span class="o">=</span> <span class="s">&quot;/opt/gateone/plugins/ssh/scripts/ssh_connect.py -S &#39;/tmp/gateone/%SESSION%/</span><span class="si">%r</span><span class="s">@%h:%p&#39; -a &#39;-oUserKnownHostsFile=%USERDIR%/%USER%/known_hosts&#39;&quot;</span>
+ <span class="c"># NOTE: The actual default is &quot;&lt;path to gateone&gt;/plugins/ssh/scripts/ssh_connect.py ...&quot;</span>
+</pre></div>
+</div>
+<p>This option specifies the command Gate One will run when a user connects or opens a new terminal. The default is for Gate One to run the ssh_connect.py script. Any interactive terminal application should work (e.g. 'nethack').</p>
+</div>
+<div class="section" id="cookie-secret">
+<h3>cookie_secret<a class="headerlink" href="#cookie-secret" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--cookie_secret">
+<tt class="descname">--cookie_secret</tt><tt class="descclassname">=string ([A-Za-z0-9])</tt><a class="headerlink" href="#cmdoption--cookie_secret" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="n">cookie_secret</span> <span class="o">=</span> <span class="s">&quot;A45CharacterStringGeneratedAtRandom012345678&quot;</span> <span class="c"># NOTE: Yours will be different ;)</span>
+</pre></div>
+</div>
+<p>This is a 45-character string that Gate One will use to encrypt the cookie stored at the client. By default Gate One will generate one at random when it runs for the first time. Only change this if you know what you're doing.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">If you change this string in the server.conf you'll need to restart Gate One for the change to take effect.</p>
+</div>
+<p><em>What happens if you change it?</em> All users existing, unexpired sessions will need to be re-authenticated. Not really a big deal since Gate One will restore everything the user was doing after the re-auth. In most cases changing the cookie secret will be completely transparent to the user.</p>
+<div class="admonition tip">
+<p class="first admonition-title">Tip</p>
+<p class="last">You may have to change this key at a regular interval throughout the year depending on your compliance needs. Every few months is probably not a bad idea regardless.</p>
+</div>
+</div>
+<div class="section" id="debug">
+<h3>debug<a class="headerlink" href="#debug" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--debug">
+<tt class="descname">--debug</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption--debug" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="n">debug</span> <span class="o">=</span> <span class="bp">False</span>
+</pre></div>
+</div>
+<p>Turns on debugging: Runs Gate One in the foreground and logs all sorts of extra messages to stdout.</p>
+</div>
+<div class="section" id="disable-ssl">
+<h3>disable_ssl<a class="headerlink" href="#disable-ssl" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--disable_ssl">
+<tt class="descname">--disable_ssl</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption--disable_ssl" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="n">disable_ssl</span> <span class="o">=</span> <span class="bp">False</span>
+</pre></div>
+</div>
+<p>Disables SSL support in Gate One. Generally not a good idea unless you know what you're doing. There's really only two reasons why you'd want to do this:</p>
+<blockquote>
+<div><ul class="simple">
+<li>Gate One will be running behind a proxy server that handles the SSL encryption.</li>
+<li>Gate One will only be connected to via localhost (kiosks, console devices, etc).</li>
+</ul>
+</div></blockquote>
+</div>
+<div class="section" id="dtach">
+<h3>dtach<a class="headerlink" href="#dtach" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--dtach">
+<tt class="descname">--dtach</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption--dtach" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="n">dtach</span> <span class="o">=</span> <span class="bp">True</span>
+</pre></div>
+</div>
+<p>This feature is special: It enables Gate One to be restarted (think: upgraded) without losing user's connected sessions. This option is enabled by default.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">If you ever need to restart Gate One (and dtach support is enabled) users will be shown a message indicating that they have been disconnected and their browsers should automatically reconnect in 5 seconds. A 5-second maintenance window ain't bad!</p>
+</div>
+</div>
+<div class="section" id="embedded">
+<h3>embedded<a class="headerlink" href="#embedded" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--embedded">
+<tt class="descname">--embedded</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption--embedded" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="n">embedded</span> <span class="o">=</span> <span class="bp">False</span>
+</pre></div>
+</div>
+<p>This option tells Gate One to run in embedded mode: No interface icons will be shown to the user and certain features such as opening additional terminal windows will be disabled.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">Doesn't actually do anything yet. Should be available and working in the 1.0 release.</p>
+</div>
+</div>
+<div class="section" id="keyfile">
+<h3>keyfile<a class="headerlink" href="#keyfile" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--keyfile">
+<tt class="descname">--keyfile</tt><tt class="descclassname">=string (file path)</tt><a class="headerlink" href="#cmdoption--keyfile" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="n">keyfile</span> <span class="o">=</span> <span class="s">&quot;/opt/gateone/keyfile.pem&quot;</span> <span class="c"># NOTE: The actual default is &quot;&lt;path to gateone&gt;/keyfile.pem&quot;</span>
+</pre></div>
+</div>
+<p>The path to the SSL key file Gate One will use in its web server.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">The file must be in PEM format.</p>
+</div>
+</div>
+<div class="section" id="kill">
+<h3>kill<a class="headerlink" href="#kill" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--kill">
+<tt class="descname">--kill</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption--kill" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="c"># It would be silly to set this in server.conf--but you could! Gate One wouldn&#39;t start but hey, whatever floats your boat!</span>
+</pre></div>
+</div>
+<p>If running with dtach support, this will kill all user's running terminal applications. Giving everyone a fresh start, as it were.</p>
+</div>
+<div class="section" id="port">
+<h3>port<a class="headerlink" href="#port" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--port">
+<tt class="descname">--port</tt><tt class="descclassname">=integer (1-65535)</tt><a class="headerlink" href="#cmdoption--port" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="n">port</span> <span class="o">=</span> <span class="mi">443</span>
+</pre></div>
+</div>
+<p>The port Gate One should listen for connections.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">Gate One must run as root to utilize ports 1-1024.</p>
+</div>
+</div>
+<div class="section" id="session-dir">
+<h3>session_dir<a class="headerlink" href="#session-dir" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--session_dir">
+<tt class="descname">--session_dir</tt><tt class="descclassname">=string (file path)</tt><a class="headerlink" href="#cmdoption--session_dir" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="n">session_dir</span> <span class="o">=</span> <span class="s">&quot;/tmp/gateone&quot;</span>
+</pre></div>
+</div>
+<p>The path where Gate One should keep temporary user session information. Defaults to /tmp/gateone (will be auto-created if not present).</p>
+</div>
+<div class="section" id="session-logging">
+<h3>session_logging<a class="headerlink" href="#session-logging" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--session_logging">
+<tt class="descname">--session_logging</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption--session_logging" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="n">session_logging</span> <span class="o">=</span> <span class="bp">True</span>
+</pre></div>
+</div>
+<p>This tells Gate One to enable server-side logging of user sessions. These logs can be viewed or played back (like a video) using the <a class="reference internal" href="../Developer/logviewer.html#log-viewer"><em>Log Viewer</em></a> application.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">Gate One stores logs of user sessions in the location specified in the <a class="reference internal" href="#user-dir"><em>user_dir</em></a> option.</p>
+</div>
+</div>
+<div class="section" id="session-timeout">
+<h3>session_timeout<a class="headerlink" href="#session-timeout" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--session_timeout">
+<tt class="descname">--session_timeout</tt><tt class="descclassname">=string (special: [0-9]+[smhd])</tt><a class="headerlink" href="#cmdoption--session_timeout" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="n">session_timeout</span> <span class="o">=</span> <span class="s">&quot;5d&quot;</span>
+</pre></div>
+</div>
+<p>This setting controls how long Gate One will wait before force-killing a user's disconnected session (i.e. where the user hasn't used Gate One in, say, &quot;5d&quot;). It accepts the following &lt;num&gt;&lt;character&gt; types:</p>
+<blockquote>
+<div><table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="20%" />
+<col width="54%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head">Character</th>
+<th class="head">Meaning</th>
+<th class="head">Example</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td>s</td>
+<td>Seconds</td>
+<td>'60s'&nbsp;➡ 60 Seconds</td>
+</tr>
+<tr><td>m</td>
+<td>Minutes</td>
+<td>'5m'&nbsp;&nbsp;➡ 5 Minutes</td>
+</tr>
+<tr><td>h</td>
+<td>Hours</td>
+<td>'24h'&nbsp;➡ 24 Hours</td>
+</tr>
+<tr><td>d</td>
+<td>Days</td>
+<td>'7d'&nbsp;&nbsp;&nbsp;➡ 7 Days</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">Even if you're using --dtach all programs associated with the user's session will be terminated when it times out.</p>
+</div>
+</div>
+<div class="section" id="sso-realm">
+<h3>sso_realm<a class="headerlink" href="#sso-realm" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--sso_realm">
+<tt class="descname">--sso_realm</tt><tt class="descclassname">=string (Kerberos realm or Active Directory domain)</tt><a class="headerlink" href="#cmdoption--sso_realm" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="n">sso_realm</span> <span class="o">=</span> <span class="s">&quot;EXAMPLE.COM&quot;</span>
+</pre></div>
+</div>
+<p>If <tt class="xref py py-obj docutils literal"><span class="pre">auth</span> <span class="pre">=</span> <span class="pre">&quot;kerberos&quot;</span></tt>, tells Gate One which Kerberos realm or Active Directory domain to use when authenticating users. Otherwise this setting will be ignored.</p>
+</div>
+<div class="section" id="sso-service">
+<h3>sso_service<a class="headerlink" href="#sso-service" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--sso_service">
+<tt class="descname">--sso_service</tt><tt class="descclassname">=string (kerberos service name)</tt><a class="headerlink" href="#cmdoption--sso_service" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="n">sso_realm</span> <span class="o">=</span> <span class="s">&quot;HTTP&quot;</span>
+</pre></div>
+</div>
+<p>If <tt class="xref py py-obj docutils literal"><span class="pre">auth</span> <span class="pre">=</span> <span class="pre">&quot;kerberos&quot;</span></tt>, tells Gate One which Kerberos service to use when authenticating clients. This is the 'service/' part of a servicePrincipalName (e.g. <strong>HTTP</strong>/somehost.example.com).</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">Unless you <em>really</em> know what you're doing do not use anything other than HTTP (in all caps).</p>
+</div>
+</div>
+<div class="section" id="syslog-facility">
+<h3>syslog_facility<a class="headerlink" href="#syslog-facility" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--syslog_facility">
+<tt class="descname">--syslog_facility</tt><tt class="descclassname">=string (auth|cron|daemon|kern|local0|local1|local2|local3|local4|local5|local6|local7|lpr|mail|news|syslog|user|uucp)</tt><a class="headerlink" href="#cmdoption--syslog_facility" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="n">syslog_facility</span> <span class="o">=</span> <span class="s">&quot;daemon&quot;</span>
+</pre></div>
+</div>
+<p>if <tt class="xref py py-obj docutils literal"><span class="pre">syslog_session_logging</span> <span class="pre">=</span> <span class="pre">True</span></tt>, specifies the syslog facility that user session logs will use when syslog_session_logging is enabled.</p>
+</div>
+<div class="section" id="syslog-session-logging">
+<h3>syslog_session_logging<a class="headerlink" href="#syslog-session-logging" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--syslog_session_logging">
+<tt class="descname">--syslog_session_logging</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption--syslog_session_logging" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="n">syslog_session_logging</span> <span class="o">=</span> <span class="bp">False</span>
+</pre></div>
+</div>
+<p>This option tells Gate One to send logs of user sessions to the host's syslog daemon. Special characters and escape sequences will be sent as-is so it is up to the syslog daemon as to how to handle them. In most cases you'll wind up with log lines that look like this:</p>
+<div class="highlight-python"><pre>Oct 1 19:18:22 gohost gateone: %anonymous 1: Connecting to: ssh://user@somehost:22
+Oct 1 19:18:22 gohost gateone: %anonymous 1: #033]0;user@somehost#007
+Oct 1 19:18:22 gohost gateone: %anonymous 1: #033]_;ssh|user@somehost:22#007</pre>
+</div>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">This option enables centralized logging if your syslog daemon is configurd to use a remote log host.</p>
+</div>
+</div>
+<div class="section" id="user-dir">
+<span id="id2"></span><h3>user_dir<a class="headerlink" href="#user-dir" title="Permalink to this headline">¶</a></h3>
+<dl class="option">
+<dt id="cmdoption--user_dir">
+<tt class="descname">--user_dir</tt><tt class="descclassname">=string (file path)</tt><a class="headerlink" href="#cmdoption--user_dir" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<div class="highlight-python"><div class="highlight"><pre><span class="n">user_dir</span> <span class="o">=</span> <span class="s">&quot;/opt/gateone/users&quot;</span> <span class="c"># NOTE: The actual default is &quot;&lt;path to gateone&gt;/users&quot;</span>
+</pre></div>
+</div>
+<p>Specifies the location where persistent user files will be kept. Things like session logs, ssh files (known_hosts, keys, etc), and similar are stored here.</p>
+<p class="rubric">Footnotes</p>
+<table class="docutils footnote" frame="void" id="f1" rules="none">
+<colgroup><col class="label" /><col /></colgroup>
+<tbody valign="top">
+<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>The GPLv3 and AGPLv3 each include clauses (in section 13 of each license) that together achieve a form of mutual compatibility. See <a class="reference external" href="http://www.gnu.org/licenses/agpl.html#section13">AGPLv3 Section 13</a> and <a class="reference external" href="http://www.gnu.org/licenses/gpl.html#section13">GPLv3 Section 13</a></td></tr>
+</tbody>
+</table>
+</div>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <h3><a href="../index.html">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">About Gate One</a><ul>
+<li><a class="reference internal" href="#licensing">Licensing</a><ul>
+<li><a class="reference internal" href="#open-source-license-requirements">Open Source License Requirements</a></li>
+<li><a class="reference internal" href="#gate-one-commercial-licensing">Gate One Commercial Licensing</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#requirements">Requirements</a></li>
+<li><a class="reference internal" href="#installation">Installation</a><ul>
+<li><a class="reference internal" href="#rpm-based-linux-distributions">RPM-based Linux Distributions</a></li>
+<li><a class="reference internal" href="#debian-based-linux-distributions">Debian-based Linux Distributions</a></li>
+<li><a class="reference internal" href="#from-source">From Source</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#configuration">Configuration</a><ul>
+<li><a class="reference internal" href="#log-file-max-size">log_file_max_size</a></li>
+<li><a class="reference internal" href="#log-file-num-backups">log_file_num_backups</a></li>
+<li><a class="reference internal" href="#log-file-prefix">log_file_prefix</a></li>
+<li><a class="reference internal" href="#log-to-stderr">log_to_stderr</a></li>
+<li><a class="reference internal" href="#logging">logging</a></li>
+<li><a class="reference internal" href="#address">address</a></li>
+<li><a class="reference internal" href="#auth">auth</a></li>
+<li><a class="reference internal" href="#certificate">certificate</a></li>
+<li><a class="reference internal" href="#command">command</a></li>
+<li><a class="reference internal" href="#cookie-secret">cookie_secret</a></li>
+<li><a class="reference internal" href="#debug">debug</a></li>
+<li><a class="reference internal" href="#disable-ssl">disable_ssl</a></li>
+<li><a class="reference internal" href="#dtach">dtach</a></li>
+<li><a class="reference internal" href="#embedded">embedded</a></li>
+<li><a class="reference internal" href="#keyfile">keyfile</a></li>
+<li><a class="reference internal" href="#kill">kill</a></li>
+<li><a class="reference internal" href="#port">port</a></li>
+<li><a class="reference internal" href="#session-dir">session_dir</a></li>
+<li><a class="reference internal" href="#session-logging">session_logging</a></li>
+<li><a class="reference internal" href="#session-timeout">session_timeout</a></li>
+<li><a class="reference internal" href="#sso-realm">sso_realm</a></li>
+<li><a class="reference internal" href="#sso-service">sso_service</a></li>
+<li><a class="reference internal" href="#syslog-facility">syslog_facility</a></li>
+<li><a class="reference internal" href="#syslog-session-logging">syslog_session_logging</a></li>
+<li><a class="reference internal" href="#user-dir">user_dir</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="../index.html"
+ title="previous chapter">Gate One Documentation</a></p>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="../UserGuide/index.html"
+ title="next chapter">User Guide</a></p>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/About/index.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="right" >
+ <a href="../UserGuide/index.html" title="User Guide"
+ >next</a> |</li>
+ <li class="right" >
+ <a href="../index.html" title="Gate One Documentation"
+ >previous</a> |</li>
+ <li><a href="../index.html">Gate One Documentation</a> &raquo;</li>
+ </ul>
+ </div>
+ <div class="footer">
+ &copy; Copyright 2011, Liftoff Software Corporation.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.
+ </div>
+ </body>
+</html>
261 gateone/docs/build/html/Developer/auth.html
@@ -0,0 +1,261 @@
+
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>auth.py - Authentication Classes &mdash; Gate One v0.9 documentation</title>
+ <link rel="stylesheet" href="../_static/default.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/ansi.css" type="text/css" />
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '0.9',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <link rel="top" title="Gate One v0.9 documentation" href="../index.html" />
+ <link rel="up" title="Developer Documentation" href="index.html" />
+ <link rel="next" title="gateone.py - Gate One&#39;s Main Script" href="gateone.html" />
+ <link rel="prev" title="Developer Documentation" href="index.html" />
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="right" >
+ <a href="gateone.html" title="gateone.py - Gate One&#39;s Main Script"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="index.html" title="Developer Documentation"
+ accesskey="P">previous</a> |</li>
+ <li><a href="../index.html">Gate One Documentation</a> &raquo;</li>
+ <li><a href="index.html" accesskey="U">Developer Documentation</a> &raquo;</li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">