cereal-0.24/0000755000175000017500000000000011131671000010754 5ustar dkgdkgcereal-0.24/COPYING0000644000175000017500000010550411130702243012017 0ustar dkgdkgCereal is a toolset to simply and robustly manage serial consoles. It is free software, written by Jameson Rollins and Daniel Kahn Gillmor . Cereal 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 General Public License for more details. Cereal Copyright 2007, and are all released under the GPL, version 3 or later. GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is 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. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. 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. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. 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 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. Use with the GNU Affero General Public License. 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 Affero 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 special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU 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 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 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 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. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU 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 General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". 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 GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . cereal-0.24/etc/0000755000175000017500000000000011120212153011525 5ustar dkgdkgcereal-0.24/etc/screenrc0000644000175000017500000000326411120212153013261 0ustar dkgdkg# default screenrc file for cereal screen sessions ############################################################# ### IMPORTANT CEREAL SETTINGS BELOW. MODIFY WITH CAUTION ### # use C-\ as the escape character escape \034\034 # necessary for cereal logging to work properly logfile ./socket logfile flush 1 # unset important key bindings ## prevent external command execution bind : ## prevent opening new windows bind c bind ^c ## prevent ability to turn off logging bind H ## prevent terminal reset bind Z ## unset kill commands, sincepreference is to "detach") ## (should unset "quit" too, or is it useful to have a backup "kill"?) bind ^k bind k bind K bind \ bind \\ bind ^\ ## no lockscreen: bind ^x bind x ## no monitor, prev, next: bind M bind ^@ bind n bind ^N bind ' ' bind ^H bind ^P bind p bind ^? # no number: bind N # no clear: bind C # no displays or dumptermcap: bind * bind . # no window switching: bind - bind 0 bind 1 bind 2 bind 3 bind 4 bind 5 bind 6 bind 7 bind 8 bind 9 ## no window splitting: bind S # no title change bind A # no remove bind X # no windows: bind ^w bind w # no suspend: bind ^z # no focus: bind ^i # no windowlist: bind \" # set default shell to be /bin/false # this is a little redundant with unsetting the create new window keys shell /bin/false # set a nice, informative caption #caption always "%{= bw}%f %{+b w}cereal console %{-b}(\"C-\ d\" to detach) %= %{+b y}%t%{-b w} %= %Y-%m-%d %c" caption always "%{= bw}%f %{+b w}cereal console: %{+b y}%t%{-b w} %= %Y-%m-%d %c %= %{-b}\"C-\ d\" to detach" startup_message off defscrollback 1024 ### IMPORTANT CEREAL SETTINGS ABOVE. MODIFY WITH CAUTOIN ### ############################################################# cereal-0.24/etc/cereal-admin.conf0000644000175000017500000000063711120212153014723 0ustar dkgdkg# /etc/cereal/cereal-admin.conf # If set to 'yes', session supervise directories will be made world # accessbile. This lets all users test the running state of # registered sessions. However, this may be a security vulnerability # on systems that do not respect FIFO file permissions. # If this is set to 'no', users who can't read the status will assume # the session is running. SUPERVISE_WORLD_ACCESSIBLE=yes cereal-0.24/doc/0000755000175000017500000000000011120212152011516 5ustar dkgdkgcereal-0.24/doc/style.howtos.css0000644000175000017500000000133611120212152014715 0ustar dkgdkg/* CSS stylesheet for how-tos */ BODY { color: black; background: #cccccc; } pre.console { background: black; color: #0f0; border: thin solid blue; padding: 0.5em; margin: 0.5em; overflow: auto; } pre.console .prompt { color: #f00; } pre.console .input { color: white; font-weight: bold; } pre.console .input-hidden { color: silver; } DT { font-weight: bold; } pre.file { font-weight: bold; } pre.snippet { background: white; color: black; border: thin dashed blue; padding: 1em; margin: 0.5em; overflow: auto; } pre.snippet .comment { color: green; } img { border: thick solid black; } #input-hidden-example { background: black; color: silver; font-family: monospace; padding: 0.5em; } cereal-0.24/doc/log-limits.txt0000644000175000017500000000124211120212152014336 0ustar dkgdkgLimiting log files in cereal ---------------------------- Cereal is controlled by runit, so the cereal log files are controlled by the svlogd daemon. Limiting the log files for session 'foo' is done by placing a svlogd configuration file in the log directory for session 'foo': /var/lib/cereal/sessions/foo/log/main/config By default, svlogd keeps 10 old logfiles around with 1000000 bytes (1MB) in each. If you wanted to keep 15 logfiles around with 2000000 bytes in each, you would do: scs:0:~# cat > /var/lib/cereal/sessions/foo/log/main/config < Introduction to Cereal - the serial line management tool

Introduction to Cereal - the serial line management tool

Many people view serial ports as antiquated, out-dated connectors taking up space on their computers. However, serial ports still offer one of the best ways to communicate reliably and simply with a machine. For example, a serial port can be configured to act as a full-featured system console. This article describes how you can use cereal to monitor, log, and control access to serial lines connected to the consoles of other computers.

A computer today has several subsystems that should be run over the serial port to make it a full-featured system console:

  • most modern operating systems (including the GNU/Linux utilities favored by Debian), are able to provide login terminals on serial ports,
  • most modern kernels (including Linux) are capable of directing their console I/O to a serial line,
  • most bootloaders (including stalwarts like GRUB, the SYSLINUX family, and LILO) can communicate via serial ports,
  • and many BIOSs, including most modern server BIOSs, can be redirected over the serial port.

Using a null-modem cable, you can connect the primary serial port on one computer to a remote computer's spare serial port. The remote computer can have full access to the first machine's console using only a terminal emulator like GNU screen or minicom. Not only do you not need yet another cumbersome monitor and keyboard, but you get a digital text stream to manipulate directly. You can log, timestamp, copy, paste, diff, etc the entire data stream flowing over the console, including boot-time spew, kernel crash output, etc.

Using serial ports as system consoles is especially useful in high-density computing environments, such as racks in data centers. Clutter like monitors, vga cables, video cards, keyboards, keyboard cables, and kvm switches can all be thrown out in favor of serial cables and a single computer that we will refer to as a serial console server. A serial console server is a machine with many serial ports, each connected to the serial console of another machine. An administrator accesses the serial console server over the network (e.g. via ssh) and from there can connect to the console of any of the connected machines. In all examples below, scs is the hostname of a serial console server.

This is where cereal comes in. cereal is a management framework designed to monitor, log, and control access to serial lines. It is installed on the serial console server, and makes the task of maintaining such a machine simpler. It can also be used in simpler configurations, such as two machines which each monitor the other's console. This article describes how to setup and use cereal. We assume that the computers you are connecting to are already configured to send their consoles over the serial line. If that's not the case yet, read The Remote Serial Console HOWTO and get 'em configured first!

The cereal utility is not yet available in Debian proper, but it is packaged and available from the CMRG APT repository. Once you've added this repository to your sources.list (you may want to update your apt keys if you care to about verifying packages from the repo), you can pull it with apt-get or aptitude: 

scs:0:~# echo deb http://cmrg.fifthhorseman.net/debian unstable cereal >> /etc/apt/sources.list.d/cereal.list
scs:0:~# aptitude update
scs:0:~# aptitude install cereal

Administering cereal sessions: /usr/sbin/cereal-admin

Serial line management with cereal is broken out into sessions. A cereal session is a single runit service controlling a special screen session attached to a single serial line. Creation and control of these sessions is done with the cereal-admin utility: 

scs:0:~# cereal-admin help
Usage: cereal-admin  [options] [args]
Cereal session management program.

subcommands:
  create (c) SESSION TTY BAUD USER LOGGROUP    create cereal session
  start (s) [options] SESSION [SESSION]...     start cereal session(s)
    -a (--all)                                   start all sessions
  stop (k) [options] SESSION [SESSION]...      stop cereal session(s)
    -a (--all)                                   stop all sessions
  restart (r) [options] SESSION [SESSION]...   restart cereal session(s)
    -a (--all)                                   restart all sessions
    -r (--running)                               restart any currently running
                                                  sessions 
  destroy (d) [options] SESSION [SESSION]...   destroy cereal session(s)
    -a (--all)                                   destroy all sessions
  list (l) [SESSION]...                        list session(s)
  help (h,?)                                   this help

scs:0:~#

Creating a cereal session

Let's assume the first computer whose serial console you want to monitor with cereal is called lemur. Let's assume lemur's serial console is configured with baud rate 115200, and is connected to the serial console server on /dev/ttyS1 (/dev/ttyS0 on scs is of course reserved for the serial console server's own serial console!).

You can give access to cereal sessions, and the ability to read the session logs, to existing users. However, it is often a good idea to create new users and groups for these purposes. We begin by creating a new group that will be allowed to view ('follow') lemur's serial console logs, followed by creating a new user that will be able to control ('attach' to) lemur's cereal session. 

scs:0:~# addgroup lemurviewers
Adding group `lemurviewers' (GID 1001) ...
Done.

scs:0:~# adduser --ingroup lemurviewers --gecos 'lemur cereal session admin,,,' lemuradmin
Adding user `lemuradmin' ...
Adding new user `lemuradmin' (1001) with group `lemurviewers' ...
Creating home directory `/home/lemuradmin' ...
Copying files from `/etc/skel' ...

scs:0:~#

You are now ready to create lemur's cereal session with cereal-admin: 

scs:0:~# cereal-admin create lemur /dev/ttyS1 115200 lemuradmin lemurviewers
Created session 'lemur':
--f lemur /dev/ttyS1 115200 lemuradmin lemurviewers
scs:0:~#

The first three characters of the session status line are the session flags that indicate the state of the cereal session. In order, they are:

state
The first flag indicates whether the session is running (+) or not (-), or in some unusual state (!).
attach
The second flag indicates whether the user can attach to the session (a) or not (-).
follow
The third flag indicates whether the user can follow the session (f) or not (-).

Once a cereal session is created, you can begin monitoring of it with the cereal-admin start command: 

scs:0:~# cereal-admin list lemur
--f lemur /dev/ttyS1 115200 lemuradmin lemurviewers
scs:0:~# cereal-admin start lemur
Started session 'lemur'.
scs:0:~# cereal-admin list lemur
+-f lemur /dev/ttyS1 115200 lemuradmin lemurviewers
scs:0:~#

Accessing cereal sessions: /usr/bin/cereal

Now that you have a cereal session up and running, you can test the connection. Log into scs as the non-privileged lemuradmin user and use the cereal tool to attach to or follow the session: 

lemuradmin@scs:~$ cereal help
Usage: cereal  [options] [args]
Cereal client program.

subcommands:
  attach (a) SESSION                      attach to session
  follow (f) [options] SESSION            follow session log
    -c (--cat)                              cat log instead of follow
    -p (--path)                             output just log file path
  list (l) [SESSION]...                   list session(s)
  help (h,?)                              this help

lemuradmin@scs:~$ cereal list lemur
+af lemur /dev/ttyS1 115200 lemuradmin lemurviewers
lemuradmin@scs:~$

Attaching to a cereal session

Using the attach function will put the the user into a cereal console, provided by a command-restricted screen session. To detach from an attached session, use "C-\ d". For help on other available commands, use "C-\ ?". 

lemuradmin@scs:~$ cereal attach lemur

Debian GNU/Linux 4.0 lemur ttyS0

lemur login: root
Password: 
Last login: Sat Oct  6 10:16:26 2007 on ttyS0
Linux lemur 2.6.18-5-amd64 #1 SMP Tue Oct 2 20:37:02 UTC 2007 x86_64

The programs included with the Debian GNU/Linux system are free software;
the exact distribution terms for each program are described in the
individual files in /usr/share/doc/*/copyright.

Debian GNU/Linux comes with ABSOLUTELY NO WARRANTY, to the extent
permitted by applicable law.
lemur:0:~# exit




cereal console: lemur              2007-10-06 10:17              "C-\ d" to detach

lemuradmin@scs:~$ cereal attach lemur
[detached]
lemuradmin@scs:~$

Following a cereal session

You can use the follow command to easily view the logs of a cereal session. 

lemuradmin@scs:~$ cereal follow --cat lemur | cat -A
############################################################
### cereal log: lemur
### +af lemur /dev/ttyS1 115200 lemuradmin lemurviewers
### log file: /var/lib/cereal/sessions/lemur/log/main/current
############################################################
2007-10-06_14:39:44.56895 
2007-10-06_14:39:44.56900 cereal: session 'lemur' started.
2007-10-06_14:39:44.56900 starting screen session...
2007-10-06_14:39:58.86707 
2007-10-06_14:39:58.86708 cereal: user 'lemuradmin' attaching to session...
2007-10-06_14:40:02.57346 
2007-10-06_14:40:02.57348 Debian GNU/Linux 4.0 lemur ttyS0
2007-10-06_14:40:02.57348 
2007-10-06_14:40:02.57349 lemur login: root
2007-10-06_14:40:13.58131 Password: 
2007-10-06_14:40:14.58129 Last login: Sat Oct  6 10:16:48 2007 on ttyS0
2007-10-06_14:40:14.58129 Linux lemur 2.6.18-5-amd64 #1 SMP Tue Oct 2 20:37:02 UTC 2007 x86_64
2007-10-06_14:40:14.58130 
2007-10-06_14:40:14.58131 The programs included with the Debian GNU/Linux system are free software;
2007-10-06_14:40:14.58131 the exact distribution terms for each program are described in the
2007-10-06_14:40:14.58132 individual files in /usr/share/doc/*/copyright.
2007-10-06_14:40:14.58132 
2007-10-06_14:40:14.58133 Debian GNU/Linux comes with ABSOLUTELY NO WARRANTY, to the extent
2007-10-06_14:40:14.58134 permitted by applicable law.
2007-10-06_14:40:14.58135 Last was Sat 06 Oct 2007 10:33:15 AM EDT on ttyS0.
2007-10-06_14:40:14.58135 ESC[31;1mlemur:0:~#ESC[0m exit
2007-10-06_14:40:17.58525 logout
2007-10-06_14:40:17.58525 ESC[HESC[J
2007-10-06_14:40:18.58523 Debian GNU/Linux 4.0 lemur ttyS0
2007-10-06_14:40:18.58523 
2007-10-06_14:40:18.58524 lemur login: 
2007-10-06_14:40:19.62101 cereal: user 'lemuradmin' detached from session.
lemuradmin@scs:~$

Conclusion

Now that you've created your first cereal session, you're ready to create serial sessions for all the rest of the attached serial consoles: 

scs:0:~# cereal-admin list
+-f lemur /dev/ttyS1 115200 lemuradmin lemurviewers
+-f chimp /dev/ttyS2 115200 chimpadmin chimpviewers
+-f douc /dev/ttyS3 115200 doucadmin doucviewers
+-f galago /dev/ttyS4 115200 galagoadmin galagoviewers
+-f baboon /dev/ttyS5 115200 baboonadmin baboonviewers
...
scs:0:~#

Cereal is developed and maintained by CMRG. Hopefully the package will be included in Debian soon, at which point bug tracking will be handled in the Debian BTS. Until then, please send all bug reports, questions, and suggestions to cereal AT fifthhorseman.net.

Last modified: Mon Oct 15 13:27:18 EDT 2007 cereal-0.24/doc/example-cereal-setup.txt0000644000175000017500000000262711120212152016310 0ustar dkgdkgUsing Cereal for simple serial console access --------------------------------------------- Here is a common way to set up cereal. The assumption here is that the second serial port on one machine (galago) is connected to the serial console of another host (douc). ## begin by creating on galago a group which can view the logs from douc, but ## can't necessarily attach to douc's serial console: 0 galago:~# addgroup doucviewers Adding group `doucviewers' (GID 1001) ... Done. ## create a separate user account who will control douc (and can attach): 0 galago:~# adduser --ingroup doucviewers --disabled-password --gecos 'douc console controller,,,' doucconsole Adding user `doucconsole' ... Adding new user `doucconsole' (1001) with group `doucviewers' ... Creating home directory `/home/doucconsole' ... Copying files from `/etc/skel' ... ## set up access for that user with ssh keys (here we just use the ## same keypairs that can already connect to root): 0 galago:~# cat ~/.ssh/authorized_keys >> ~doucconsole/.ssh/authorized_keys ## set up the cereal session itself: 0 galago:~# cereal-admin create douc /dev/ttyS1 115200 doucconsole doucviewers Created session 'douc'. 0 galago:~# cereal-admin list douc --f douc /dev/ttyS1 115200 doucconsole doucviewers 0 galago:~# cereal-admin enable douc Enabled session 'douc'. 0 galago:~# cereal-admin list douc +-f douc /dev/ttyS1 115200 doucconsole doucviewers 0 galago:~# cereal-0.24/man/0000755000175000017500000000000011120212153011525 5ustar dkgdkgcereal-0.24/man/man8/0000755000175000017500000000000011120212153012370 5ustar dkgdkgcereal-0.24/man/man8/cereal-admin.80000644000175000017500000001057211120212153015007 0ustar dkgdkg.TH CEREAL-ADMIN "8" "March 2007" "cereal-admin 0.1" "Administration Commands" .SH NAME cereal-admin \- administer cereal sessions .SH SYNOPSIS .B cereal-admin \fIcommand\fP [\fIargs\fP] .SH DESCRIPTION \fBcereal-admin\fP is a program to administer cereal sessions. A cereal session is a special (restricted) screen(1) session attached to a serial terminal. Each cereal session is owned by a particular user (USER) who is allowed to "attach" to the cereal screen session and interact with the specified serial terminal via screen. Each cereal session is also associated with a particular log group (LOGGROUP) whose members are allowed to "follow" the logs of the session. .PP Cereal was designed to monitor serial lines connected to the serial consoles of remote machines. The cereal system is outlined at: .PP http://cmrg.fifthhorseman.net/wiki/cereal .SH SUBCOMMANDS \fBcereal-admin\fP takes various subcommands: .PD .TP .B create SESSION TTY BAUD USER LOGGROUP Create a new session named SESSION on tty TTY, with baud rate BAUD. USER is the user that will own the session, and LOGGROUP is the group that will be able to follow the session non-interactively (ie. read the logs). Once created, the session will be in a "stopped" state. `c' may be used in place of `create'. .TP .B start [options] SESSION [SESSION]... Start session(s). For each session specified, the session directory is registered in the runsvdir directory. The screen session will be attached to the serial terminal and logging of the terminal will begin. `s' may be used in place of `start'. options: -a (--all) to enable all sessions. .TP .B restart [options] SESSION [SESSION]... Restart session(s). This sends running sessions a "restart" signal, and starts session that are not running. This can be used when changes have been made to the screenrc, for instance. `r' may be used in place of `restart'. options: -a (--all) to disable all sessions, -r (--running) to restart just the currently running sessions. .TP .B stop [options] SESSION [SESSION]... Stop session(s). This kills the screen session attached to the serial terminal by sending it an "exit" signal, and then unregistering the session directory from the runsvdir directory. `k' may be used in place of `stop'. options: -a (--all) to disable all sessions. .TP .B destroy [options] SESSION [SESSION]... Destroy session(s) entirely. This will destroy the session directory, including all history of the session and the logs. `d' may be used in place of `destroy'. options: -a (--all) to remove all sessions. .TP .B list [SESSION]... List session(s). With no arguments, will list all sessions. The leading three characters in the list indicate: whether the session is running (+) or not (-) or in some unknown state (?), whether the user can attach to the session (a) or not (-), whether the user can follow the session (f) or not (-). If the session state is unknown (?), it's usually because the user asking for information about the session can't read the session stat file. `l' may be used in place of `list'. .TP .B help Output a brief usage summary. `h' or `?' may be used in place of `help'. .PD .SH LOGS Logs are handled by .BR svlogd. For information on how to control session log handling, please see svlogd(8) and/or log-limits.txt from the documentation of this package. .PD .SH FILES .PD 1 .TP /etc/cereal/screenrc Default cereal screenrc file. .TP /etc/cereal/cereal-admin.conf Configuration file to set parameters for session creation and management. .TP /var/lib/cereal/sessions/$SESSION/screenrc Special screenrc file for session SESSION. The presence of this file overrides the default screenrc file /etc/cereal/screenrc. .PD .SH EXIT STATUS Exit status is 0 if OK, 1 if minor problems, 2 if serious trouble. .PD .SH AUTHOR Written by Jameson Rollins and Daniel Kahn Gillmor. .SH BUGS If the invoking user does not have read and execute access to the cereal session's supervise directory, `cereal-admin list' may not always indicate that session's status accurately. .SH "REPORTING BUGS" Report bugs to . .SH COPYRIGHT Copyright \(co 2007 Jameson Rollins and Daniel Kahn Gillmor .br This is free software. You may redistribute copies of it under the terms of the GNU General Public License . There is NO WARRANTY, to the extent permitted by law. .SH "SEE ALSO" .BR cereal (1), .BR screen (1), .BR runsvdir (8), .BR svlogd (8) cereal-0.24/man/man1/0000755000175000017500000000000011120212153012361 5ustar dkgdkgcereal-0.24/man/man1/cereal.10000644000175000017500000000446511120212153013707 0ustar dkgdkg.TH CEREAL "1" "March 2007" "cereal 0.1" "User Commands" .SH NAME cereal \- client program to attach to cereal session .SH SYNOPSIS .B cereal \fIcommand\fP [\fIargs\fP] .SH DESCRIPTION .PP \fBcereal\fP is the client program to attach to a running cereal session. .SH SUBCOMMANDS \fBcereal\fP takes various subcommands: .PD .TP .B attach SESSION Attach to (take control of) cereal session SESSION. This puts the user into a cereal console, provided by a command-restricted screen session. To detach from an attached session, use "C-\\ d". For help on other available commands, use "C-\\ ?". Cereal uses a limited instance of screen to provide the console. See \fBscreen\fP(1) for more info on the available commands. `a' may be used in place of `attach'. .TP .B follow [options] SESSION Follow (watch, without being able to intervene) a cereal session SESSION. The options are: -c [--cat] to cat log instead of follow; -p [--path] to output just the path to the log file and exit. `f' may be used in place of `follow'. .TP .B list [SESSION]... List session(s). With no arguments, will list all sessions. The leading three characters in the list indicate: whether the session is running (+) or not (-) or in some unknown state (?), whether the user can attach to the session (a) or not (-), whether the user can follow the session (f) or not (-). If the session state is unknown (?), it's usually because the user asking for information about the session can't read the session stat file. `l' may be used in place of `list'. .TP .B help Output a brief usage summary. `h' or `?' may be used in place of `help'. .PD .SH EXIT STATUS Exit status is 0 if OK, 1 if minor problems, 2 if serious trouble. .PD .SH AUTHOR Written by Jameson Rollins and Daniel Kahn Gillmor. .SH BUGS If the invoking user does not have read and execute access to the cereal session's supervise directory, `cereal list' may not always indicate that session's status accurately. .SH "REPORTING BUGS" Report bugs to . .SH COPYRIGHT Copyright \(co 2007 Jameson Rollins and Daniel Kahn Gillmor .br This is free software. You may redistribute copies of it under the terms of the GNU General Public License . There is NO WARRANTY, to the extent permitted by law. .SH "SEE ALSO" .BR screen (1), .BR cereal-admin (8) cereal-0.24/Makefile0000644000175000017500000000360411120212153012415 0ustar dkgdkg#!/usr/bin/make -f # Makefile for cereal # (c) 2007 Jameson Graef Rollins # Licensed under GPL v3 or later VERSION := `head -n1 debian/changelog | sed 's/.*(\([^-]*\)-.*/\1/'` # these defaults are for debian. porters should probably adjust them # before calling make install ETCPREFIX ?= ETCSUFFIX ?= PREFIX ?= /usr MANPREFIX ?= $(PREFIX)/share/man # nothing to do for builds: this is a package of mostly scripts. build: tarball: clean rm -rf cereal-$(VERSION) mkdir -p cereal-$(VERSION) ln -s ../COPYING ../Makefile ../src ../etc ../man ../doc cereal-$(VERSION) tar ch --exclude='*~' --exclude='*.svn*' cereal-$(VERSION) | gzip -n > cereal_$(VERSION).orig.tar.gz rm -rf cereal-$(VERSION) debian-package: tarball tar xzf cereal_$(VERSION).orig.tar.gz tar c --exclude='*~' --exclude='*.svn*' debian | tar x -C cereal-$(VERSION) (cd cereal-$(VERSION) && debuild -us -uc) rm -rf cereal-$(VERSION) install: installman install -d $(DESTDIR)$(PREFIX)/bin $(DESTDIR)$(PREFIX)/sbin $(DESTDIR)$(PREFIX)/share/cereal install -d $(DESTDIR)$(ETCPREFIX)/etc/cereal install -d $(DESTDIR)$(PREFIX)/share/doc/cereal install src/cereal $(DESTDIR)$(PREFIX)/bin install src/cereal-admin $(DESTDIR)$(PREFIX)/sbin install -m 0644 src/common $(DESTDIR)$(PREFIX)/share/cereal install src/mainrun src/logrun src/finish $(DESTDIR)$(PREFIX)/share/cereal install -m 0644 etc/cereal-admin.conf $(DESTDIR)$(ETCPREFIX)/etc/cereal/cereal-admin.conf$(ETCSUFFIX) install -m 0644 etc/screenrc $(DESTDIR)$(ETCPREFIX)/etc/cereal/screenrc$(ETCSUFFIX) install doc/* $(DESTDIR)$(PREFIX)/share/doc/cereal installman: install -d $(DESTDIR)$(MANPREFIX)/man1 $(DESTDIR)$(MANPREFIX)/man8 gzip -n man/*/* install man/man1/* $(DESTDIR)$(MANPREFIX)/man1 install man/man8/* $(DESTDIR)$(MANPREFIX)/man8 gzip -d man/*/* clean: rm -f cereal_* .PHONY: build tarball debian-package install installman clean cereal-0.24/src/0000755000175000017500000000000011130702425011550 5ustar dkgdkgcereal-0.24/src/common0000644000175000017500000001327411130702403012766 0ustar dkgdkg# -*-shell-script-*- # Shared bash functions for cereal # # The cereal scripts were written by # Jameson Graef Rollins # and # Daniel Kahn Gillmor . # # They are Copyright 2007, and are all released under the GPL, version 3 # or later. ################################################## # managed directories ETC="/etc/cereal" export ETC SESSIONDIR="/var/lib/cereal/sessions" export SESSIONDIR ERR=0 export ERR ################################################## error() { echo "$1" >&2 ERR=${2:-'1'} } failure() { echo "$1" >&2 exit ${2:-'2'} } # check if TTY is valid tty # check_is_tty TTY check_tty() { [ -c "$1" ] || failure "'$1' is not a valid tty." } # check is tty is already being used in another session # check_is_session_tty TTY check_session_tty() { local SESSION local TTY TTY="$1" for SESSION in $(ls "$SESSIONDIR") ; do if grep -q "^$TTY$" "$SESSIONDIR/$SESSION/env/TTY" ; then failure "TTY '$TTY' is already being monitored by session '$SESSION'." fi done } # check if USER is valid # check_user USER check_user() { getent passwd "$1" > /dev/null || failure "'$1' is not a valid user." } # check if GROUP is valid # check_group GROUP check_group() { getent group "$1" > /dev/null || failure "'$1' is not a valid group." } # check if the user can read/write to a TTY is_tty_rw() { chpst -u "$1:$2" bash -c "test -r $3 && test -w $3" } # check_tty_rw USER GROUP TTY check_tty_rw() { is_tty_rw "$@" || failure "User '$1' does not have read/write access to tty '$3', tty is not g+rw, or you do not have permission to change user." } # start_check # this is called with "chpst -e" with a session environment start_check() { is_tty_rw "$USER" "$GROUP" "$TTY" } # check if session exists # is_session SESSION is_session() { test -d "$SESSIONDIR/$1" } # is_running SESSION is_running() { local SESSION SESSION="$1" STAT_FILE="$SESSIONDIR/$SESSION/supervise/stat" if [ -r "$SESSIONDIR/$SESSION/supervise" ] ; then if [ -e "$STAT_FILE" ] ; then if [ $(cat "$STAT_FILE") = 'run' ] ; then # return 0 if the service is running return 0 else # return 1 if the service is *not* running return 1 fi else # if the stat file doesn't exist, assume it's not running return 1 fi else # return 2 if we can't read the stat file and don't know the status return 2 fi } # check if sessions tty is locked # is_locked SESSION is_locked() { local TTY TTY=$(cat "$SESSIONDIR/$1/env/TTY") test -e /var/lock/LCK..${TTY##/dev/} } # can_attach SESSION [USER] can_attach() { local USER USER=${2:-"$USER"} [ "$USER" = $(cat "$SESSIONDIR/$1/env/USER") ] } # in_group USER GROUP in_group() { groups "$1" | cut -d ':' -f 2 | tr ' ' '\n' | grep -q "^$2$" } # can_follow SESSION [USER] can_follow() { local LOGUSER local LOGGROUP local USER LOGUSER=$(cat "$SESSIONDIR/$1/env/LOGUSER") LOGGROUP=$(cat "$SESSIONDIR/$1/env/LOGGROUP") USER=${2:-"$USER"} [ "$USER" = "$LOGUSER" ] || in_group "$USER" "$LOGGROUP" || [ $(id -u "$USER") = '0' ] } # write to the log of a session #log_write SESSION STATEMENT log_write() { printf "\ncereal: %s\n" "$2" >> "$SESSIONDIR/$1/socket" } # display_session SESSION [USER] display_session() { local SESSION local SFLAG local AFLAG local FFLAG SESSION="$1" USER=${2:-"$USER"} # set state flag # last flag works only for users that can read supervise/stat is_running "$SESSION" case $? in 0) SFLAG='+' # running ;; 1) SFLAG='-' # stopped ;; 2) SFLAG='?' # unknown ;; esac # set attach flag if can_attach "$SESSION" "$USER" ; then AFLAG='a' else AFLAG='-' fi # set follow flag if can_follow "$SESSION" "$USER" ; then FFLAG='f' else FFLAG='-' fi cd "$SESSIONDIR/$SESSION/env" echo "${SFLAG}${AFLAG}${FFLAG} $SESSION $(cat TTY) $(cat BAUD) $(cat USER) $(cat LOGGROUP)" } # list [-n] SESSION [SESSION...] list() { local SESSION local SESSIONS local DISP DISP=0 # flag to just output session names (otherwise display full info) if [ "$1" = '--names' -o "$1" = '-n' ] ; then unset DISP shift 1 fi # list of session to display if [ "$1" ] ; then SESSIONS="$@" else SESSIONS=$(ls -1 "$SESSIONDIR" 2> /dev/null) [ "$SESSIONS" ] || return 1 fi for SESSION in $SESSIONS ; do if ! is_session "$SESSION" ; then error "Session '$SESSION' not found." 1 elif [ "$DISP" ] ; then display_session "$SESSION" else echo "$SESSION" fi done } # function called by the session service run script to actually start screen # takes no arguments, since it is called with a "chpst -e" mainrun() { check_tty "$TTY" check_user "$USER" check_group "$GROUP" check_group "$LOGGROUP" check_tty_rw "$USER" "$GROUP" "$TTY" chown "$USER:$LOGGROUP" ./socket || failure "Can not properly set ownership of socket." chmod 0640 ./socket || failure "Can not properly set permissions on socket." echo "starting screen session..." LOCKFILE=/var/lock/LCK..${TTY##/dev/} lockfile -r0 "$LOCKFILE" LOCK_EXIT_CODE=$? if [ "$LOCK_EXIT_CODE" != 0 ] ; then exit "$LOCK_EXIT_CODE" fi chmod u+w "$LOCKFILE" printf '%9s\n' $$ >> "$LOCKFILE" exec chpst -u "$USER:$GROUP" /usr/bin/screen -D -m -L -c "$SCREENRC" -s /bin/false -S "cereal:$SESSION" -t "$SESSION" "$TTY" "$BAUD" } # function called by the session service finish script to remove the # serial device lockfile # takes no arguments, since it is called with a "chpst -e" remove_lock() { LOCKFILE=/var/lock/LCK..${TTY##/dev/} rm -r "$LOCKFILE" } cereal-0.24/src/mainrun0000755000175000017500000000146611130702407013156 0ustar dkgdkg#!/bin/sh -e # The cereal scripts were written by # Jameson Graef Rollins # and # Daniel Kahn Gillmor . # # They are Copyright 2007, and are all released under the GPL, version 3 # or later. exec 2>./socket 1>&2 SHAREDIR="/usr/share/cereal" export SHAREDIR . "$SHAREDIR/common" # ensure that the socket is available ( [ -p ./socket ] || (rm -f ./socket; mkfifo ./socket) ) || failure "can not create socket." # find screenrc: if [ -e "./screenrc" ] ; then SCREENRC="./screenrc" elif [ -e "$ETC/screenrc" ] ; then SCREENRC="$ETC/screenrc" else failure "cereal screenrc file not found." fi export SCREENRC # call the mainrun function (defined in $SHAREDIR/common) # that actually runs screen exec chpst -e ./env sh -c ". $SHAREDIR/common && mainrun" cereal-0.24/src/finish0000755000175000017500000000107211130702412012752 0ustar dkgdkg#!/bin/sh -e # The cereal scripts were written by # Jameson Graef Rollins # and # Daniel Kahn Gillmor . # # They are Copyright 2007, and are all released under the GPL, version 3 # or later. exec 2>./socket 1>&2 SHAREDIR="/usr/share/cereal" export SHAREDIR # check the exit code of run, and remove the lock if it's NOT 73 # (which is exit code of lockfile if a lock file already existed). RUN_EXIT_CODE="$1" if [ "$RUN_EXIT_CODE" != 73 ] ; then exec chpst -e ./env sh -c ". $SHAREDIR/common && remove_lock" fi cereal-0.24/src/cereal-admin0000755000175000017500000002125711130702416014026 0ustar dkgdkg#!/bin/sh # cereal-admin: manage cereal sessions (runit service directory structure # and runit run directory). # # The cereal scripts were written by # Jameson Graef Rollins # and # Daniel Kahn Gillmor . # # They are Copyright 2007, and are all released under the GPL, version 3 # or later. ################################################## SHAREDIR=${SHAREDIR:-"/usr/share/cereal"} export SHAREDIR . "$SHAREDIR/common" [ -r "$ETC/cereal-admin.conf" ] && . "$ETC/cereal-admin.conf" ################################################## usage() { cat < [options] [args] Cereal session management program. subcommands: create (c) SESSION TTY BAUD USER LOGGROUP create cereal session start (s) [options] SESSION [SESSION]... start cereal session(s) -a (--all) start all sessions restart (r) [options] SESSION [SESSION]... restart cereal session(s) -a (--all) restart all sessions -r (--running) restart only running sessions stop (k) [options] SESSION [SESSION]... stop cereal session(s) -a (--all) stop all sessions destroy (d) [options] SESSION [SESSION]... destroy cereal session(s) -a (--all) destroy all sessions list (l) [options] [SESSION]... list session(s) -n (--names) list just session names help (h,?) this help EOF } # create session create() { if [ $# -lt 5 ] ; then failure "Not enough input arguments. Type 'cereal-admin help' for more info." fi SESSION="$1" TTY="$2" BAUD="$3" SUSER="$4" SGROUP=$(stat --dereference --printf="%G" "$TTY") LOGUSER='cereal' LOGGROUP="$5" is_session "$SESSION" && failure "A session named '$SESSION' already exists." check_tty "$TTY" check_session_tty "$TTY" check_user "$SUSER" check_group "$SGROUP" check_user "$LOGUSER" check_group "$LOGGROUP" check_tty_rw "$SUSER" "$SGROUP" "$TTY" # create service directory mkdir -p "$SESSIONDIR/$SESSION" ln -s "$SHAREDIR/mainrun" "$SESSIONDIR/$SESSION/run" ln -s "$SHAREDIR/finish" "$SESSIONDIR/$SESSION/finish" touch "$SESSIONDIR/$SESSION/down" # store environment variables mkdir -p "$SESSIONDIR/$SESSION/env" echo "$SESSION" > "$SESSIONDIR/$SESSION/env/SESSION" echo "$TTY" > "$SESSIONDIR/$SESSION/env/TTY" echo "$BAUD" > "$SESSIONDIR/$SESSION/env/BAUD" echo "$SUSER" > "$SESSIONDIR/$SESSION/env/USER" echo "$SGROUP" > "$SESSIONDIR/$SESSION/env/GROUP" echo "$LOGUSER" > "$SESSIONDIR/$SESSION/env/LOGUSER" echo "$LOGGROUP" > "$SESSIONDIR/$SESSION/env/LOGGROUP" # create logging infrastructure mkdir -p -m 0750 "$SESSIONDIR/$SESSION/log/main" ln -s "$SHAREDIR/logrun" "$SESSIONDIR/$SESSION/log/run" touch "$SESSIONDIR/$SESSION/log/main/current" chmod 0640 "$SESSIONDIR/$SESSION/log/main/current" chown -R "$LOGUSER" "$SESSIONDIR/$SESSION/log/main" chgrp -R "$LOGGROUP" "$SESSIONDIR/$SESSION/log" # make supervise directory world accessible if requested if [ "$SUPERVISE_WORLD_ACCESSIBLE" = 'yes' ] ; then mkdir -p -m 0755 "$SESSIONDIR/$SESSION/supervise" mkdir -p -m 0755 "$SESSIONDIR/$SESSION/log/supervise" fi # create socket for screen, since it can't log to stdout mkfifo "$SESSIONDIR/$SESSION/socket" chown "$SUSER:$LOGGROUP" "$SESSIONDIR/$SESSION/socket" chmod 0640 "$SESSIONDIR/$SESSION/socket" echo "Created session '$SESSION':" display_session "$SESSION" update-service --add "$SESSIONDIR/$SESSION" "cereal.$SESSION" } # start_session SESSION start_session() { local SESSION SESSION="$1" chpst -e "$SESSIONDIR/$SESSION/env/" sh -c ". $SHAREDIR/common && start_check" || return 1 sv start "$SESSIONDIR/$SESSION" || return 1 rm -r "$SESSIONDIR/$SESSION/down" log_write "$SESSION" "session '$SESSION' started." } # start session start() { if [ -z "$1" ] ; then failure "Not enough input arguments. Type 'cereal-admin help' for more info." elif [ "$1" = '--all' -o "$1" = '-a' ] ; then SESSIONS=$(list -n) || failure "There are no sessions." 1 else SESSIONS="$@" fi for SESSION in $SESSIONS ; do if ! is_session "$SESSION" ; then error "Session '$SESSION' not found." 1 elif is_running "$SESSION" ; then echo "Session '$SESSION' is already running." elif is_locked "$SESSION" ; then error "Session tty device appears to be locked." elif start_session "$SESSION" ; then echo "Session '$SESSION' started." else error "Session '$SESSION' could not be started." 2 fi done } # restart_session SESSION restart_session(){ local SESSION SESSION="$1" sv restart "$SESSIONDIR/$SESSION" || return 1 log_write "$SESSION" "session '$SESSION' restarted." } # restart session restart() { if [ -z "$1" ] ; then failure "Not enough input arguments. Type 'cereal-admin help' for more info." elif [ "$1" = '--all' -o "$1" = '-a' ] ; then SESSIONS=$(list -n) || failure "There are no sessions." 1 elif [ "$1" = '--running' -o "$1" = '-r' ] ; then SESSIONS=$(list | grep '^+' | cut -d ' ' -f 2) [ "$SESSIONS" ] || failure "There are no running sessions." 0 else SESSIONS="$@" fi for SESSION in $SESSIONS ; do if ! is_session "$SESSION" ; then error "Session '$SESSION' not found." 1 elif ! is_running "$SESSION" ; then if start_session "$SESSION" ; then echo "Session '$SESSION' started." else error "Session '$SESSION' could not be started." 2 fi elif restart_session "$SESSION" ; then echo "Session '$SESSION' restarted." else error "Session could not be restarted." 2 fi done } # stop_session SESSION stop_session() { local SESSION SESSION="$1" sv stop "$SESSIONDIR/$SESSION" || return 1 touch "$SESSIONDIR/$SESSION/down" log_write "$SESSION" "session '$SESSION' stopped." } # stop session stop() { if [ -z "$1" ] ; then failure "Not enough input arguments. Type 'cereal-admin help' for more info." elif [ "$1" = '--all' -o "$1" = '-a' ] ; then SESSIONS=$(list -n) || failure "There are no sessions." 1 else SESSIONS="$@" fi for SESSION in $SESSIONS ; do if ! is_session "$SESSION" ; then error "Session '$SESSION' not found." 1 elif stop_session "$SESSION" ; then echo "Session '$SESSION' stopped." else error "Session '$SESSION' could not be stopped." 2 fi done } # destroy_session SESSION destroy_session() { local SESSION SESSION="$1" update-service --remove "$SESSIONDIR/$SESSION" "cereal.$SESSION" rm -rf "$SESSIONDIR/$SESSION" } # destroy session destroy() { if [ -z "$1" ] ; then failure "Not enough input arguments. Type 'cereal-admin help' for more info." elif [ "$1" = '--all' -o "$1" = '-a' ] ; then SESSIONS=$(list -n) || failure "There are no sessions." 1 else SESSIONS="$@" fi for SESSION in $SESSIONS ; do if ! is_session "$SESSION" ; then error "Session '$SESSION' not found." 1 elif [ ! -w "$SESSIONDIR/$SESSION" ] ; then error "You do not have permission to destroy session '$SESSION'." 2 elif is_running "$SESSION" ; then echo "Session '$SESSION' is currently running." printf "Really stop and destroy session? [Y|n]: " read OK; OK=${OK:=Y} if [ "$OK" = 'y' -o "$OK" = 'Y' ] ; then if stop_session "$SESSION" ; then if destroy_session "$SESSION" ; then echo "Session '$SESSION' stopped and destroyed." else error "Session '$SESSION' could not be destroyed." 2 fi else error "Session '$SESSION' could not be stopped." 2 fi else error "Session '$SESSION' not stopped." 1 fi else printf "Really destroy session '%s'? [Y|n]: " "$SESSION" read OK; OK=${OK:=Y} if [ "$OK" = 'y' -o "$OK" = 'Y' ] ; then if destroy_session "$SESSION" ; then echo "Session '$SESSION' destroyed." else error "Session '$SESSION' could not be destroyed." 2 fi else error "Session '$SESSION' not destroyed." 1 fi fi done } ############################################################### ### MAIN COMMAND="$1" [ "$COMMAND" ] || failure "Type 'cereal-admin help' for usage." shift case $COMMAND in 'create'|'c') create "$@" ;; 'start'|'s') start "$@" ;; 'restart'|'r') restart "$@" ;; 'stop'|'k') stop "$@" ;; 'destroy'|'d') destroy "$@" ;; 'list'|'l') list "$@" || failure "There are no sessions." 1 ;; 'help'|'h'|'?') usage ;; *) failure "Unknown command: '$COMMAND' Type 'cereal-admin help' for usage." ;; esac exit "$ERR" cereal-0.24/src/cereal0000755000175000017500000000715011130702422012731 0ustar dkgdkg#!/bin/sh # cereal: command line interface to cereal screen serial loggers # # The cereal scripts were written by # Jameson Graef Rollins # and # Daniel Kahn Gillmor . # # They are Copyright 2007, and are all released under the GPL, version 3 # or later. ################################################## SHAREDIR=${SHAREDIR:-"/usr/share/cereal"} export SHAREDIR . "$SHAREDIR/common" ################################################## usage() { cat < [options] [args] Cereal client program. subcommands: attach (a) SESSION attach to session follow (f) [options] SESSION follow session log -c (--cat) cat log instead of follow -p (--path) output just log file path list (l) [options] [SESSION]... list session(s) -n (--names) list just session names help (h,?) this help EOF } attach() { SESSION="$1" if [ -z "$SESSION" ] ; then failure "Not enough input arguments. Type 'cereal help' for more info." elif ! is_session "$SESSION" ; then failure "Session '$SESSION' not found. Type 'cereal list' to list sessions." elif ! can_attach "$SESSION" "$USER" ; then failure "You do not have permission to attach to session '$SESSION'." fi is_running "$SESSION" case $? in 0|2) # also attempt to start if session is unknown (return code 2) log_write "$SESSION" "user '$USER' attaching to session from `tty`..." screen -x -S "cereal:$SESSION" || failure "Could not reattach screen." log_write "$SESSION" "user '$USER' on `tty` detached from session." ;; 1) failure "Session '$SESSION' not running." ;; esac } log_follow() { tail -n 100 -F "$LOG" } log_cat() { cat "$LOG" } log_pwd() { echo "$LOG" } follow() { local SESSION local TEMP local OUTPUT OUTPUT="log_follow" TEMP=$(getopt -o cp --long cat,path -n "cereal follow" -- "$@") if [ $? -ne 0 ] ; then failure "Invalid options." fi # Note the quotes around `$TEMP': they are essential! eval set -- "$TEMP" while true ; do case "$1" in -c|--cat) OUTPUT="log_cat" ; shift 1 ;; -p|--path) OUTPUT="log_pwd" ; shift 1 ;; --) shift ;; *) SESSION="$1" break ;; esac done if [ -z "$SESSION" ] ; then failure "Not enough input arguments. Type 'cereal help' for more info." elif ! is_session "$SESSION" ; then failure "Session '$SESSION' not found. Type 'cereal list' to list sessions." elif ! can_follow "$SESSION" "$USER" ; then failure "You do not have permission to follow session '$SESSION'." fi LOG="$SESSIONDIR/$SESSION/log/main/current" if [ "$OUTPUT" = 'log_follow' -o "$OUTPUT" = 'log_cat' ] ; then echo "############################################################" echo "### cereal log: $SESSION" printf "### " list "$SESSION" echo "### log file: $LOG" echo "############################################################" fi $OUTPUT } ############################################################### ### MAIN handle_command() { COMMAND="$1" [ "$COMMAND" ] || failure "Type 'cereal help' for usage." shift case $COMMAND in 'attach'|'a') attach "$@" ;; 'follow'|'f') follow "$@" ;; 'list'|'l') list "$@" || failure "There are no sessions." 1 ;; 'help'|'h'|'?') usage ;; *) failure "Unknown command: '$COMMAND' Type '$CMD help' for usage." ;; esac exit "$ERR" } handle_command "$@" cereal-0.24/src/logrun0000755000175000017500000000077111130702425013011 0ustar dkgdkg#!/bin/sh -e # The cereal scripts were written by # Jameson Graef Rollins # and # Daniel Kahn Gillmor . # # They are Copyright 2007, and are all released under the GPL, version 3 # or later. exec 2>&1 SHAREDIR="/usr/share/cereal" export SHAREDIR . "$SHAREDIR/common" LOGUSER="$(cat ../env/LOGUSER)" LOGGROUP="$(cat ../env/LOGGROUP)" check_user "$LOGUSER" check_group "$LOGGROUP" exec chpst -u "$LOGUSER:$LOGGROUP" svlogd -tt ./main <../socket