diff --git a/0repo.py b/0repo.py new file mode 100644 index 0000000..fe9457b --- /dev/null +++ b/0repo.py @@ -0,0 +1,13 @@ +# Copyright (C) 2013, Thomas Leonard +# See the README file for details, or visit http://0install.net. +import sys +from repo import cmd +from zeroinstall import SafeException + +version = '0.1' + +try: + cmd.main(sys.argv) +except SafeException as ex: + print(ex) + sys.exit(1) diff --git a/0repo.xml b/0repo.xml new file mode 100644 index 0000000..9d69ae4 --- /dev/null +++ b/0repo.xml @@ -0,0 +1,45 @@ + + + 0repo + manage a repository of 0install feeds + + 0repo allows a group of developers to publish a set of feeds. It can be + used by a single developer, generating a set of static files to publish on + a web-server, or as a service which accepts signed updates from a group + of developers. + + http://0install.net/0repo.html + + + + sed -i "s/^version = '.*'$/version = '$RELEASE_VERSION'/" 0repo.py + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..cf9b6b9 --- /dev/null +++ b/COPYING @@ -0,0 +1,510 @@ + + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations +below. + + When we speak of free software, we are referring to freedom of use, +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 this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. +^L + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it +becomes a de-facto standard. To achieve this, non-free programs must +be allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. +^L + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control +compilation and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. +^L + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. +^L + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at least + three years, to give the same user the materials specified in + Subsection 6a, above, for a charge no more than the cost of + performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. +^L + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. +^L + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +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 +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply, and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License +may add an explicit geographical distribution limitation excluding those +countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser 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 Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. +^L + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "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 +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY 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 +LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS +^L + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms +of the ordinary General Public License). + + To apply these terms, attach the following notices to the library. +It is safest to attach them to the start of each source file to most +effectively convey 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 library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library 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 + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or +your school, if any, to sign a "copyright disclaimer" for the library, +if necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James + Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! + + diff --git a/README.md b/README.md new file mode 100644 index 0000000..0d0eba0 --- /dev/null +++ b/README.md @@ -0,0 +1,203 @@ +0repo +===== + +Copyright Thomas Leonard, 2013 + + +WARNING: much of this isn't implemented yet! + + +Introduction +------------ + +The 0repo software provides an easy and reliable way to maintain a repository +of 0install software for others to use. It can be run interactively by a single +developer on their laptop to maintain a repository of their own programs, or +installed as a service to allow a group of people to manage a set of programs +together. + +Developers place new software releases in an "incoming" directory. 0repo +performs various checks on the new release and, if it's OK, adds it to the +repository. 0repo signs the published feeds with its GPG key. + +The generated files may be rsync'd to a plain web host, without the need for +special software on the hosting platform. + +Features: + +- Can be run automatically as part of a scripted release process (for + single-developer use). + +- Can run as a service to accept contributions from multiple developers. + +- Keeps feeds under version control. + +- Repositories are always consistent (no missing keys, missing stylesheets, + invalid URIs, etc). + +- Files can be hosted on a standard web host (e.g. Apache). + +- Provides a catalogue file listing all published feeds, which can be polled + automatically by mirror sites (e.g. 0mirror). + +- Supports both archives hosted within the repository and archives hosted + externally. + + +Setup +----- + +Run "0repo create DIR" to create a new repository (directory DIR will be +created to hold the files and will be populated with an initial configuration). + + $ 0repo create ~/repo + $ cd ~/repo + +Within this directory you will find: + +- 0repo-config.py - configuration settings +- feeds - directory of (unsigned) feeds, initially empty +- feeds/.git - version control Git repository for the feeds +- public - output directory (to be rsync'd to hosting provider) + +Edit 0repo-config.py and set the required parameters: + +These are required: + +- The base URL for the feeds +- The base URL for the archives +- GPG key to use for signing feeds + +These are optional: + +- Command to upload feeds to web hosting +- Command to upload archives to archive hosting +- GPG keys of trusted contributors + + +Adding a release +---------------- + +0repo is designed to be called by other tools, such as 0release, 0template, +0downstream, etc. However, this section explains how the process can be +performed manually instead. + +Place the XML of your new release in the "incoming" directory. For testing, +you could add this file as repo/incoming/GNU-Hello-1.3.xml: + + + + GNU Hello + produces a familiar, friendly greeting + The GNU Hello program produces a familiar, friendly greeting. + http://www.gnu.org/software/hello/ + + + + + + + + + + + + + + + + +Replace the ``'s `{REPO_BASE}` with the URL of the directory where +you will publish. + +Note that, in this example, the archive is hosted outside of the repository. To +store the release in the repository, use a relative href on the `` +element and place the archive in the incoming directory too. e.g. + + + +When you are ready, run 0repo inside the "repo" directory. If your new version +is accepted, a new unsigned feed file be created as repo/feeds/GNU-Hello.xml +and committed to Git. A signed version of this feed will appear as +repo/public/GNU-Hello.xml. If you specified a relative URL for the archive, the +signed version will have an absolute URL and the archive will be copied to your +configured archives directory. On success, the files are deleted from the +incoming directory. + +You will also have a public/catalog.xml file listing the new program. + +When 0repo generates the signed feeds it will also: + +- check that each feed's URI is correct for its location +- add the stylesheet declaration +- for each relative 's href, check that the archive exists + locally and make the URL absolute + +The results go in a separate 'public' directory, which can then be +transferred to the hosting provider (e.g. using rsync). This directory +also contains a generated `catalog.xml` file, which 0mirror can poll. + + +Editing feeds +------------- + +You can edit the unsigned feeds under repo/feeds whenever you want. Running +0repo again will regenerate the signed feeds in repo/public (if the source feed +has changed). You should commit your changes with `git commit`. + +To remove a feed, `git rm repo/feeds/FEED.xml` and run `0repo` again. + + +Running a shared repository +--------------------------- + +For a shared repository: the release tool generates the archives and +the XML for the new version, signs the XML with the developer's key, +and uploads to a queue (could be e.g. FTP). 0repo downloads the +contents of the queue to its incoming directory, checks the signature +and merges the new XML into the feed. If there's a problem, it emails +the user. + +For other edits (e.g. adding a or adding a missing +dependency to an already-released version), the contributor sends a Git pull +request. The repository owner merges the pull request and runs +0repo. + + +Auditing +-------- + +When 0repo adds a new release, the Git commit message includes the XML, +including the signature, if any. This makes it possible to tell whether a +malicious update was caused by a compromised 0repo (commit is invalid) or by a +compromised contributor (the malicious XML is correctly signed by that +contributor). + +Commits made by 0repo are signed with its GPG key. You can check these +signatures using `git log --show-signature` in the `feeds` directory. + + +Conditions +---------- + +This library is free software; you can redistribute it and/or +modify it under the terms of the GNU Lesser General Public +License as published by the Free Software Foundation; either +version 2.1 of the License, or (at your option) any later version. + +This library 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 +Lesser General Public License for more details. + +You should have received a copy of the GNU Lesser General Public +License along with this library; if not, write to the Free Software +Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + +Bug Reports +----------- + +Please report any bugs to [the 0install mailing list](http://0install.net/support.html). diff --git a/repo/__init__.py b/repo/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/repo/build.py b/repo/build.py new file mode 100644 index 0000000..a23da87 --- /dev/null +++ b/repo/build.py @@ -0,0 +1,90 @@ +# Copyright (C) 2013, Thomas Leonard +# See the README file for details, or visit http://0install.net. + +from __future__ import print_function + +import os, subprocess, sys +from os.path import join, dirname, relpath +from xml.dom import minidom +import base64 + +from zeroinstall.support import xmltools +from zeroinstall import SafeException + +from repo import paths + +feed_header = """ + +""" + +def sign_xml(config, source_xml): + child = subprocess.Popen(['gpg', '--detach-sign', '--default-key', config.GPG_SIGNING_KEY, '--use-agent', '--output', '-', '-'], + stdin = subprocess.PIPE, + stdout = subprocess.PIPE, + stderr = subprocess.PIPE) + stdout, stderr = child.communicate(source_xml) + exit_status = child.wait() + if exit_status: + raise SafeException("Error signing feed: %s" % stderr) + if stderr: + print(stderr, file=sys.stderr) + + encoded = base64.encodestring(stdout) + sig = "\n\n" + return source_xml + sig + +def generate_public_xml(config, source_xml_path): + """Load source_xml_path and expand any relative URLs.""" + with open(source_xml_path, 'rb') as stream: + doc = minidom.parse(stream) + + root = doc.documentElement + declared_iface = root.getAttribute('uri') + if not declared_iface: + raise SafeException("Feed '{path}' missing 'uri' attribute on root".format(path = source_xml_path)) + + if not declared_iface.startswith(config.REPOSITORY_BASE_URL): + raise SafeException("Feed '{path}' declares uri='{uri}', which is not under REPOSITORY_BASE_URL ({base})".format( + path = source_xml_path, + uri = declared_iface, + base = config.REPOSITORY_BASE_URL)) + rel_uri = declared_iface[len(config.REPOSITORY_BASE_URL):] + + expected_path = join('feeds', config.get_feeds_rel_path(rel_uri)) + if expected_path != source_xml_path: + raise SafeException("Feed '{path}' with uri='{uri}' should be located at '{expected_path}'".format( + path = source_xml_path, + uri = declared_iface, + expected_path = expected_path)) + + return doc + +def build_public_feeds(config): + feeds = [] + for dirpath, dirnames, filenames in os.walk('feeds'): + for f in filenames: + if f.endswith('.xml') and not f.startswith('.'): + source_path = join(dirpath, f) + target_path = join("public", paths.get_public_rel_path(config, relpath(source_path, 'feeds'))) + new_doc = generate_public_xml(config, source_path) + if os.path.exists(target_path): + with open(target_path, 'rb') as stream: + old_doc = minidom.parse(stream) + if xmltools.nodes_equal(old_doc.documentElement, new_doc.documentElement): + print("%s unchanged" % source_path) + continue + feeds.append((target_path, new_doc)) + + for target_path, new_doc in feeds: + new_xml = feed_header + new_doc.documentElement.toxml('utf-8') + + signed_xml = sign_xml(config, new_xml) + + target_dir = dirname(target_path) + if not os.path.isdir(target_dir): + os.makedirs(target_dir) + + with open(target_path + '.new', 'wb') as stream: + stream.write(signed_xml) + os.rename(target_path + '.new', target_path) + print("Updated", target_path) diff --git a/repo/cmd/__init__.py b/repo/cmd/__init__.py new file mode 100644 index 0000000..6c527a5 --- /dev/null +++ b/repo/cmd/__init__.py @@ -0,0 +1,52 @@ +# Copyright (C) 2013, Thomas Leonard +# See the README file for details, or visit http://0install.net. + +from __future__ import print_function + +import argparse +import os +import sys +from os.path import join, dirname, abspath + +from zeroinstall import SafeException + +def main(argv): + parser = argparse.ArgumentParser(description='Manage a 0install repository.') + subparsers = parser.add_subparsers(dest='subcommand') + + parser_create = subparsers.add_parser('create', help='create a new repository') + parser_create.add_argument('path', metavar='DIR', + help='the directory to create to hold the new repository') + + subparsers.add_parser('update', help='process "incoming" and generate output files') + + if len(argv) == 1: + argv = argv + ['update'] + + args = parser.parse_args(argv[1:]) + + if args.subcommand == 'create': + from repo.cmd import create + create.handle(args) + else: + # Walk up the directory tree to find the root of the repository + while not os.path.isfile('0repo-config.py'): + if os.path.samefile('.', '..'): + raise SafeException('0repo must be run from a repository directory (a directory that contains\n' + 'a "0repo-config.py" file). To create a new repository, use:\n\n' + '0repo create DIR') + os.chdir('..') + + import importlib + sys.path.insert(0, '.') + config = importlib.import_module('0repo-config') + del sys.path[0] + + config.default_resources = join(dirname(dirname(dirname(abspath(__file__)))), 'resources') + for setting in ['REPOSITORY_BASE_URL', 'ARCHIVES_BASE_URL', 'LOCAL_ARCHIVES_DIR']: + value = getattr(config, setting) + if not value.endswith('/'): + setattr(config, value + '/') + + cmd = __import__('repo.cmd.' + args.subcommand, globals(), locals(), [args.subcommand], 0) + cmd.handle(config, args) diff --git a/repo/cmd/create.py b/repo/cmd/create.py new file mode 100644 index 0000000..36af917 --- /dev/null +++ b/repo/cmd/create.py @@ -0,0 +1,19 @@ +# Copyright (C) 2013, Thomas Leonard +# See the README file for details, or visit http://0install.net. + +from __future__ import print_function + +import os, subprocess, shutil +from os.path import join, dirname, abspath + +topdir = dirname(dirname(dirname(abspath(__file__)))) + +def handle(args): + os.mkdir(args.path) + os.chdir(args.path) + os.mkdir('incoming') + os.mkdir('feeds') + os.mkdir('public') + subprocess.check_call(['git', 'init', '-q', 'feeds']) + subprocess.check_call(['git', 'commit', '-q', '--allow-empty', '-m', 'Create new repository'], cwd = 'feeds') + shutil.copyfile(join(topdir, 'resources', '0repo-config.py.template'), '0repo-config.py') diff --git a/repo/cmd/update.py b/repo/cmd/update.py new file mode 100644 index 0000000..32e330f --- /dev/null +++ b/repo/cmd/update.py @@ -0,0 +1,36 @@ +# Copyright (C) 2013, Thomas Leonard +# See the README file for details, or visit http://0install.net. + +from __future__ import print_function + +import os, shutil +from os.path import join + +from repo import incoming, build + +catalog_header = ''' + + +''' + +def handle(config, args): + # Step 1. Process any new files in the incoming directory + incoming.process_incoming_dir(config) + + # Step 2. Regenerate the signed feeds + build.build_public_feeds(config) + + # Step 3. Generate catalog + catalog_stylesheet = join('public', 'catalog.xsl') + if not os.path.exists(catalog_stylesheet): + shutil.copyfile(join(config.default_resources, 'catalog.xsl'), catalog_stylesheet) + + catalog_css = join('public', 'catalog.css') + if not os.path.exists(catalog_css): + shutil.copyfile(join(config.default_resources, 'catalog.css'), catalog_css) + + catalog_file = join('public', 'catalog.xml') + with open(catalog_file + '.new', 'wt') as stream: + stream.write(catalog_header) + stream.write('') + os.rename(catalog_file + '.new', catalog_file) diff --git a/repo/incoming.py b/repo/incoming.py new file mode 100644 index 0000000..e866d30 --- /dev/null +++ b/repo/incoming.py @@ -0,0 +1,78 @@ +# Copyright (C) 2013, Thomas Leonard +# See the README file for details, or visit http://0install.net. + +from __future__ import print_function + +import os, subprocess +from os.path import join, dirname, basename, relpath + +from zeroinstall.injector import qdom, model +from zeroinstall import SafeException + +from repo import paths + +def process(config, xml_file): + with open(xml_file, 'rb') as stream: + xml_text = stream.read() + stream.seek(0) + feed = model.ZeroInstallFeed(qdom.parse(stream), local_path = xml_file) + if not feed.feed_for: + raise SafeException("Missing in " + basename(xml_file)) + if len(feed.feed_for) != 1: + raise SafeException("Multiple s in " + basename(xml_file)) + + # TODO: This actually gives us the interface. We currently assume we're adding to the + # default feed for the intrface, which is wrong. If there is a 'feed' attribute on the + # , we should use that instead. This will also require updating 0publish. + master, = feed.feed_for + + feeds_rel_path = paths.get_feeds_rel_path(config, master) + feed_path = join("feeds", feeds_rel_path) + feed_dir = dirname(feed_path) + if not os.path.isdir(feed_dir): + os.makedirs(feed_dir) + + new_file = not os.path.exists(feed_path) + git_path = relpath(feed_path, 'feeds') + did_git_add = False + + try: + # Merge into feed + subprocess.check_call([os.environ['ZEROPUBLISH'], "--add-from", xml_file, feed_path]) + + # Commit + if new_file: + subprocess.check_call(['git', 'add', git_path], cwd = 'feeds') + did_git_add = True + + # (this must be last in the try block) + commit_msg = 'Merged %s\n\n%s' % (basename(xml_file), xml_text.encode('utf-8')) + subprocess.check_call(['git', 'commit', '-q', '-m', commit_msg, '-S' + config.GPG_SIGNING_KEY, '--', git_path], cwd = 'feeds') + except Exception as ex: + # Roll-back (we didn't commit to Git yet) + print(ex) + print("Error updating feed {feed}; rolling-back...".format(feed = xml_file)) + if new_file: + os.unlink(feed_path) + if did_git_add: + subprocess.check_call(['git', 'rm', '--', git_path], cwd = 'feeds') + else: + subprocess.check_call(['git', 'checkout', 'HEAD', '--', git_path], cwd = 'feeds') + else: + # Delete XML from incoming directory + os.unlink(xml_file) + +def process_incoming_dir(config): + """Current directory contains 'incoming'.""" + incoming_files = os.listdir('incoming') + new_xml = [] + for i in incoming_files: + if i.endswith('.xml'): + new_xml.append(i) + + if new_xml: + for xml in new_xml: + print("Processing", xml) + process(config, os.path.join('incoming', xml)) + else: + print('No .xml files in "incoming" directory (nothing to process)') diff --git a/repo/paths.py b/repo/paths.py new file mode 100644 index 0000000..d2c6b6c --- /dev/null +++ b/repo/paths.py @@ -0,0 +1,33 @@ +# Copyright (C) 2013, Thomas Leonard +# See the README file for details, or visit http://0install.net. + +from os.path import isabs + +from zeroinstall import SafeException + +def ensure_safe(rel_path): + """Ensure path is relative and doesn't contain '.', '..' or other hidden components.""" + if isabs(rel_path): + raise SafeException("Feed path {path} not relative".format(path = rel_path)) + if rel_path.startswith(".") or "/." in rel_path: + raise SafeException("Feed path {path} contains a dot-file component".format(path = rel_path)) + return rel_path + +def get_feeds_rel_path(config, url): + """Return the relative path under "feeds" where we should store the feed with the given URL. + @raise SafeException: url is not within this repository, or is otherwise malformed.""" + + if not url.startswith(config.REPOSITORY_BASE_URL): + raise SafeException("Feed URL '{url}' does not start with {base}".format( + url = url, + base = config.REPOSITORY_BASE_URL)) + + uri_rel_path = url[len(config.REPOSITORY_BASE_URL):] + feeds_rel_path = config.get_feeds_rel_path(uri_rel_path) + if not feeds_rel_path.endswith('.xml'): + raise SafeException("Feed relative path {path} must end in '.xml'".format(path = feeds_rel_path)) + return ensure_safe(feeds_rel_path) + +def get_public_rel_path(config, feeds_rel_path): + public_rel_path = config.get_public_rel_path(feeds_rel_path) + return ensure_safe(public_rel_path) diff --git a/resources/0repo-config.py.template b/resources/0repo-config.py.template new file mode 100644 index 0000000..1622f56 --- /dev/null +++ b/resources/0repo-config.py.template @@ -0,0 +1,60 @@ +# The URL of the directory which will host the repository (feeds, keys, stylesheets and catalogue). +REPOSITORY_BASE_URL = "http://example.com/myrepo/" + +# The URL of the directory containing the archives (which will not be under REPOSITORY_BASE_URL if +# you are hosting archives on a different server). Note that uploaders can choose whether to store +# archives within 0repo or externally. This setting does not affect external archives, only archives +# managed by 0repo. +ARCHIVES_BASE_URL = REPOSITORY_BASE_URL + "/archives/" + +# The GPG secret key which 0repo should use to sign the generated feeds and any +# Git commits it makes. The fingerprint preceeded by "0x" is the most precise +# way to identity a key (see "HOW TO SPECIFY A USER ID" in the gpg(1) man-page +# for other options). +GPG_SIGNING_KEY = "0xDA9825AECAD089757CDABD8E07133F96CA74D8BA" + +# The local directory in which to store accepted archives. +# This corresponds to ARCHIVES_BASE_URL. +LOCAL_ARCHIVES_DIR = "public/archives/" + +# Command to sync the public directory to the web hosting. +# If None, you must sync manually after running 0repo. +SYNC_PUBLIC_COMMAND = None + +# Command to upload archives to your archive hosting. +# If the archives are under "public" (the default) then this should be set to None, +# since SYNC_PUBLIC_COMMAND will upload the archives along with the feeds. +UPLOAD_ARCHIVES_COMMAND = None + +# If set, XML feeds in the "incoming" directory and any Git pull requests must be signed by one of +# these keys, otherwise they will be rejected. For local use, this can be set to None so that the +# files don't need to be signed. +CONTRIBUTOR_GPG_KEYS = None + +# False : no license checking +# True : all implementations must specify a license +# A set : all implementations must specify a license from the given set +REQUIRE_LICENSE = True +#REQUIRE_LICENSE = {"OSI Approved :: GNU Lesser General Public License (LGPL)"} + + +#### Advanced configuration #### + +# uri_rel_path is the part of the feed's URL following REPOSITORY_BASE_URL. +# Where should it be placed within "feeds"? By default, these are the same. +# You might want to change this if you have a strange naming scheme (e.g. feed +# URLs ending in "/" or without an extension). The result must end in '.xml'. +def get_feeds_rel_path(uri_rel_path): + return uri_rel_path + +# A source feed "feeds/games/my-game.xml" has a relative path of +# "games/my-game.xml". Where should the corresponding generated (signed) feed +# be placed under "public"? The default (and recommended) setting is to keep it +# the same, so we would generate "public/games/my-game.xml" in this case. +# +# When migrating an existing repository with a different scheme, you might need to +# change this function. For example, some repositories save the generated feed +# as "public/games/my-game/feed.xml" and configure Apache to make it appear as +# "http://example.com/games/my-game". +def get_public_rel_path(feeds_rel_path): + return feeds_rel_path diff --git a/resources/catalog.css b/resources/catalog.css new file mode 100644 index 0000000..947bbd6 --- /dev/null +++ b/resources/catalog.css @@ -0,0 +1,62 @@ +h1 { text-align: center; border-bottom: 2px solid #d0d0ff; padding-bottom: .5em; } +div.main { padding: 1em; background: white; -moz-border-radius: 1em 1em 1em 1em; max-width: 60em; margin-left: auto; margin-right: auto; margin-top: 1em; margin-bottom: 1em; } +dt { font-weight: bold; text-transform:capitalize; } +dd { padding-bottom: 1em; } +dl.group { margin: 0.5em; padding: 0.5em; border: 1px dashed #888;} +dl.impl { padding: 0.2em 1em 0.2em 1em; margin: 0.5em; border: 1px solid black; background: white;} +pre { background: #ddd; color: black; padding: 0.2cm; } +table { width: 100% } + +span.count { + color: #888; + padding-left: 1em; +} + +td.image { + text-align: center; + vertical-align: top; +} + +.summary { + margin: 0; + padding: 0 0 1em 0; + font-style: italic; + color: #666; +} + +tr.d0 td { + background: #eee; +} + +td.keyinfo { + width: 10em; + vertical-align: top; +} + +td.keyinfo a { + font-family: sans-serif; + font-weight: bold; + text-decoration: none; +} + +td.keyinfo span.summary { + font-size: smaller; + font-style: italic; + color: #333; +} + +td.teaser { + vertical-align: top; + color: #666; +} + +td.teaser:hover { + color: #000; +} + +td.teaser a { + display: block; + text-align: right; + float: right; + color: #66f; +} diff --git a/resources/catalog.xsl b/resources/catalog.xsl new file mode 100644 index 0000000..b5b333f --- /dev/null +++ b/resources/catalog.xsl @@ -0,0 +1,55 @@ + + + + + + + + + + + +Software in this repository + + + + +
+

Software in this repository

+ +

To start one of these programs, drag the program's title from your web-browser to 0install.

+ + + + + + + + + + +
Application icon +
+ +		 +Homepage +
+ +

Number of feeds:

+ +

If you want to make additional programs available this way, see the +Packaging Guide.

+ +
+ + + + + + diff --git a/tests/test-1.xml b/tests/test-1.xml new file mode 100644 index 0000000..5b64992 --- /dev/null +++ b/tests/test-1.xml @@ -0,0 +1,20 @@ + + + test + testing + + + + + + + + + + + + + + + + diff --git a/tests/test-gpghome/pubring.gpg b/tests/test-gpghome/pubring.gpg new file mode 100644 index 0000000..68ab6ac Binary files /dev/null and b/tests/test-gpghome/pubring.gpg differ diff --git a/tests/test-gpghome/secring.gpg b/tests/test-gpghome/secring.gpg new file mode 100644 index 0000000..5424d1a Binary files /dev/null and b/tests/test-gpghome/secring.gpg differ diff --git a/tests/test0repo.py b/tests/test0repo.py new file mode 100644 index 0000000..6916fbd --- /dev/null +++ b/tests/test0repo.py @@ -0,0 +1,72 @@ +import unittest +import tempfile +import shutil +import subprocess +import os, sys +from StringIO import StringIO + +from os.path import join + +os.environ["http_proxy"] = "http://localhost:9999/bug" +mydir = os.path.dirname(os.path.abspath(__file__)) +sys.path.insert(0, os.path.abspath('..')) + +test_gpghome = join(mydir, 'test-gpghome') + +from repo.cmd import main + +def run_repo(args): + old_stdout = sys.stdout + sys.stdout = StringIO() + try: + main(['0repo'] + args) + return sys.stdout.getvalue() + finally: + sys.stdout = old_stdout + +class Test0Repo(unittest.TestCase): + def setUp(self): + self.tmpdir = tempfile.mkdtemp('-0repo') + os.chdir(self.tmpdir) + gpghome = join(self.tmpdir, 'gnupg') + os.mkdir(gpghome) + shutil.copyfile(join(test_gpghome, 'pubring.gpg'), join(gpghome, 'pubring.gpg')) + shutil.copyfile(join(test_gpghome, 'secring.gpg'), join(gpghome, 'secring.gpg')) + os.environ['GNUPGHOME'] = gpghome + os.chmod(gpghome, 0o700) + + def tearDown(self): + os.chdir("/") + shutil.rmtree(self.tmpdir) + + def testSimple(self): + # (do a slow sub-process call here just to check that the top-level + # wrapper works) + subprocess.check_call(['0repo', 'create', 'my-repo']) + os.chdir('my-repo') + + with open('0repo-config.py') as stream: + data = stream.read() + data = data.replace('GPG_SIGNING_KEY = "0xDA9825AECAD089757CDABD8E07133F96CA74D8BA"', + 'GPG_SIGNING_KEY = "0x3F52282D484EB9401EE3A66A6D66BDF4F467A18D"') + with open('0repo-config.py', 'wt') as stream: + stream.write(data) + + # Regenerate + out = run_repo([]) + assert 'No .xml files in "incoming" directory (nothing to process)' in out, out + assert os.path.exists(join('public', 'catalog.xml')) + assert os.path.exists(join('public', 'catalog.xsl')) + assert os.path.exists(join('public', 'catalog.css')) + + # Create a new feed (external archive) + shutil.copyfile(join(mydir, 'test-1.xml'), join('incoming', 'test-1.xml')) + out = run_repo([]) + assert 'Processing test-1.xml' in out, repr(out) + + assert os.path.exists(join('feeds', 'tests', 'test.xml')) + + assert os.path.exists(join('public', 'tests', 'test.xml')) + +if __name__ == '__main__': + unittest.main()